initial import
[vuplus_webkit] / Source / WebKit / chromium / src / WebIDBObjectStoreImpl.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebIDBObjectStoreImpl_h
27 #define WebIDBObjectStoreImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "WebCommon.h"
32 #include "WebIDBObjectStore.h"
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/RefPtr.h>
35
36 namespace WebCore { class IDBObjectStoreBackendInterface; }
37
38 namespace WebKit {
39
40 class WebIDBIndex;
41
42 // See comment in WebIndexedObjectStore for a high level overview these classes.
43 class WebIDBObjectStoreImpl : public WebIDBObjectStore {
44 public:
45     WebIDBObjectStoreImpl(WTF::PassRefPtr<WebCore::IDBObjectStoreBackendInterface>);
46     ~WebIDBObjectStoreImpl();
47
48     WebString name() const;
49     WebString keyPath() const;
50     WebDOMStringList indexNames() const;
51
52     void get(const WebIDBKey& key, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&);
53     void put(const WebSerializedScriptValue&, const WebIDBKey&, PutMode, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&);
54     void deleteFunction(const WebIDBKey& key, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&);
55     void clear(WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&);
56
57     WebIDBIndex* createIndex(const WebString& name, const WebString& keyPath, bool unique, const WebIDBTransaction&, WebExceptionCode&);
58     WebIDBIndex* index(const WebString& name, WebExceptionCode&);
59     void deleteIndex(const WebString& name, const WebIDBTransaction&, WebExceptionCode&);
60
61     void openCursor(const WebIDBKeyRange&, unsigned short direction, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&);
62
63  private:
64     WTF::RefPtr<WebCore::IDBObjectStoreBackendInterface> m_objectStore;
65 };
66
67 } // namespace WebKit
68
69 #endif // ENABLE(INDEXED_DATABASE)
70
71 #endif // WebIDBObjectStoreImpl_h