src/third_party/WebKit/Source/modules/indexeddb/IDBIndex.h

   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/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 "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 RefCountedWillBeGarbageCollectedFinalized<IDBIndex>, public ScriptWrappable {
  46 public:
  47     static PassRefPtrWillBeRawPtr<IDBIndex> create(const IDBIndexMetadata& metadata, IDBObjectStore* objectStore, IDBTransaction* transaction)
  48     {
  49         return adoptRefWillBeNoop(new IDBIndex(metadata, objectStore, transaction));
  50     }
  51     ~IDBIndex();
  52     void trace(Visitor*);
  53
  54     // Implement the IDL
  55     const String& name() const { return m_metadata.name; }
  56     IDBObjectStore* objectStore() const { return m_objectStore.get(); }
  57     ScriptValue keyPath(ScriptState*) const;
  58     bool unique() const { return m_metadata.unique; }
  59     bool multiEntry() const { return m_metadata.multiEntry; }
  60
  61     PassRefPtrWillBeRawPtr<IDBRequest> openCursor(ExecutionContext*, const ScriptValue& key, const String& direction, ExceptionState&);
  62     PassRefPtrWillBeRawPtr<IDBRequest> openKeyCursor(ExecutionContext*, const ScriptValue& range, const String& direction, ExceptionState&);
  63     PassRefPtrWillBeRawPtr<IDBRequest> count(ExecutionContext*, const ScriptValue& range, ExceptionState&);
  64     PassRefPtrWillBeRawPtr<IDBRequest> get(ExecutionContext*, const ScriptValue& key, ExceptionState&);
  65     PassRefPtrWillBeRawPtr<IDBRequest> getKey(ExecutionContext*, const ScriptValue& key, ExceptionState&);
  66
  67     void markDeleted() { m_deleted = true; }
  68     bool isDeleted() const;
  69
  70     // Used internally and by InspectorIndexedDBAgent:
  71     PassRefPtrWillBeRawPtr<IDBRequest> openCursor(ExecutionContext*, PassRefPtrWillBeRawPtr<IDBKeyRange>, blink::WebIDBCursor::Direction);
  72
  73     blink::WebIDBDatabase* backendDB() const;
  74
  75 private:
  76     IDBIndex(const IDBIndexMetadata&, IDBObjectStore*, IDBTransaction*);
  77
  78     PassRefPtrWillBeRawPtr<IDBRequest> getInternal(ExecutionContext*, const ScriptValue& key, ExceptionState&, bool keyOnly);
  79
  80     IDBIndexMetadata m_metadata;
  81     RefPtrWillBeMember<IDBObjectStore> m_objectStore;
  82     RefPtrWillBeMember<IDBTransaction> m_transaction;
  83     bool m_deleted;
  84 };
  85
  86 } // namespace WebCore
  87
  88 #endif // IDBIndex_h