• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2010 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 IDBIndex_h
27 #define IDBIndex_h
28 
29 #include "IDBCursor.h"
30 #include "IDBIndexBackendInterface.h"
31 #include "IDBKeyRange.h"
32 #include "IDBRequest.h"
33 #include "PlatformString.h"
34 #include <wtf/Forward.h>
35 
36 #if ENABLE(INDEXED_DATABASE)
37 
38 namespace WebCore {
39 
40 class IDBObjectStore;
41 
42 class IDBIndex : public RefCounted<IDBIndex> {
43 public:
create(PassRefPtr<IDBIndexBackendInterface> backend,IDBObjectStore * objectStore,IDBTransaction * transaction)44     static PassRefPtr<IDBIndex> create(PassRefPtr<IDBIndexBackendInterface> backend, IDBObjectStore* objectStore, IDBTransaction* transaction)
45     {
46         return adoptRef(new IDBIndex(backend, objectStore, transaction));
47     }
48     ~IDBIndex();
49 
50     // Implement the IDL
name()51     String name() const { return m_backend->name(); }
objectStore()52     IDBObjectStore* objectStore() const { return m_objectStore.get(); }
keyPath()53     String keyPath() const { return m_backend->keyPath(); }
unique()54     bool unique() const { return m_backend->unique(); }
55 
56     // FIXME: Try to modify the code generator so this is unneeded.
openCursor(ScriptExecutionContext * context,ExceptionCode & ec)57     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, ExceptionCode& ec) { return openCursor(context, 0, ec); }
openCursor(ScriptExecutionContext * context,PassRefPtr<IDBKeyRange> keyRange,ExceptionCode & ec)58     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionCode& ec) { return openCursor(context, keyRange, IDBCursor::NEXT, ec); }
59     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, unsigned short direction, ExceptionCode&);
60 
openKeyCursor(ScriptExecutionContext * context,ExceptionCode & ec)61     PassRefPtr<IDBRequest> openKeyCursor(ScriptExecutionContext* context, ExceptionCode& ec) { return openKeyCursor(context, 0, ec); }
openKeyCursor(ScriptExecutionContext * context,PassRefPtr<IDBKeyRange> keyRange,ExceptionCode & ec)62     PassRefPtr<IDBRequest> openKeyCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionCode& ec) { return openKeyCursor(context, keyRange, IDBCursor::NEXT, ec); }
63     PassRefPtr<IDBRequest> openKeyCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, unsigned short direction, ExceptionCode&);
64 
65     PassRefPtr<IDBRequest> get(ScriptExecutionContext*, PassRefPtr<IDBKey>, ExceptionCode&);
66     PassRefPtr<IDBRequest> getKey(ScriptExecutionContext*, PassRefPtr<IDBKey>, ExceptionCode&);
67 
68 private:
69     IDBIndex(PassRefPtr<IDBIndexBackendInterface>, IDBObjectStore*, IDBTransaction*);
70 
71     RefPtr<IDBIndexBackendInterface> m_backend;
72     RefPtr<IDBObjectStore> m_objectStore;
73     RefPtr<IDBTransaction> m_transaction;
74 };
75 
76 } // namespace WebCore
77 
78 #endif
79 
80 #endif // IDBIndex_h
81