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 "bindings/v8/ScriptWrappable.h" 30 #include "modules/indexeddb/IDBCursor.h" 31 #include "modules/indexeddb/IDBDatabase.h" 32 #include "modules/indexeddb/IDBKeyPath.h" 33 #include "modules/indexeddb/IDBKeyRange.h" 34 #include "modules/indexeddb/IDBMetadata.h" 35 #include "modules/indexeddb/IDBObjectStore.h" 36 #include "modules/indexeddb/IDBRequest.h" 37 #include "wtf/Forward.h" 38 #include "wtf/text/WTFString.h" 39 40 namespace WebCore { 41 42 class ExceptionState; 43 class IDBObjectStore; 44 45 class IDBIndex : public ScriptWrappable, public RefCounted<IDBIndex> { 46 public: 47 static PassRefPtr<IDBIndex> create(const IDBIndexMetadata& metadata, IDBObjectStore* objectStore, IDBTransaction* transaction) 48 { 49 return adoptRef(new IDBIndex(metadata, objectStore, transaction)); 50 } 51 ~IDBIndex(); 52 53 // Implement the IDL 54 const String name() const { return m_metadata.name; } 55 PassRefPtr<IDBObjectStore> objectStore() const { return m_objectStore; } 56 PassRefPtr<IDBAny> keyPathAny() const { return IDBAny::create(m_metadata.keyPath); } 57 const IDBKeyPath keyPath() const { return m_metadata.keyPath; } 58 bool unique() const { return m_metadata.unique; } 59 bool multiEntry() const { return m_metadata.multiEntry; } 60 int64_t id() const { return m_metadata.id; } 61 62 PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, const String& direction, ExceptionState&); 63 PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, const ScriptValue& key, const String& direction, ExceptionState&); 64 PassRefPtr<IDBRequest> count(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionState&); 65 PassRefPtr<IDBRequest> count(ScriptExecutionContext*, const ScriptValue& key, ExceptionState&); 66 PassRefPtr<IDBRequest> openKeyCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, const String& direction, ExceptionState&); 67 PassRefPtr<IDBRequest> openKeyCursor(ScriptExecutionContext*, const ScriptValue& key, const String& direction, ExceptionState&); 68 PassRefPtr<IDBRequest> get(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionState&); 69 PassRefPtr<IDBRequest> get(ScriptExecutionContext*, const ScriptValue& key, ExceptionState&); 70 PassRefPtr<IDBRequest> getKey(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionState&); 71 PassRefPtr<IDBRequest> getKey(ScriptExecutionContext*, const ScriptValue& key, ExceptionState&); 72 73 void markDeleted() { m_deleted = true; } 74 bool isDeleted() const; 75 76 IDBDatabaseBackendInterface* backendDB() const; 77 78 private: 79 IDBIndex(const IDBIndexMetadata&, IDBObjectStore*, IDBTransaction*); 80 81 IDBIndexMetadata m_metadata; 82 RefPtr<IDBObjectStore> m_objectStore; 83 RefPtr<IDBTransaction> m_transaction; 84 bool m_deleted; 85 }; 86 87 } // namespace WebCore 88 89 #endif // IDBIndex_h 90
