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