src/third_party/WebKit/Source/modules/indexeddb/IDBObjectStore.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 IDBObjectStore_h
  27 #define IDBObjectStore_h
  28
  29 #include "bindings/v8/Dictionary.h"
  30 #include "bindings/v8/ScriptWrappable.h"
  31 #include "bindings/v8/SerializedScriptValue.h"
  32 #include "modules/indexeddb/IDBCursor.h"
  33 #include "modules/indexeddb/IDBIndex.h"
  34 #include "modules/indexeddb/IDBKey.h"
  35 #include "modules/indexeddb/IDBKeyRange.h"
  36 #include "modules/indexeddb/IDBMetadata.h"
  37 #include "modules/indexeddb/IDBRequest.h"
  38 #include "modules/indexeddb/IDBTransaction.h"
  39 #include "public/platform/WebIDBCursor.h"
  40 #include "public/platform/WebIDBDatabase.h"
  41 #include "wtf/PassRefPtr.h"
  42 #include "wtf/RefCounted.h"
  43 #include "wtf/RefPtr.h"
  44 #include "wtf/text/WTFString.h"
  45
  46 namespace WebCore {
  47
  48 class DOMStringList;
  49 class IDBAny;
  50 class ExceptionState;
  51
  52 class IDBObjectStore : public ScriptWrappable, public RefCounted<IDBObjectStore> {
  53 public:
  54     static PassRefPtr<IDBObjectStore> create(const IDBObjectStoreMetadata& metadata, IDBTransaction* transaction)
  55     {
  56         return adoptRef(new IDBObjectStore(metadata, transaction));
  57     }
  58     ~IDBObjectStore() { }
  59
  60     // Implement the IDBObjectStore IDL
  61     int64_t id() const { return m_metadata.id; }
  62     const String& name() const { return m_metadata.name; }
  63     ScriptValue keyPath(ExecutionContext*) const;
  64     PassRefPtr<DOMStringList> indexNames() const;
  65     PassRefPtr<IDBTransaction> transaction() const { return m_transaction; }
  66     bool autoIncrement() const { return m_metadata.autoIncrement; }
  67
  68     PassRefPtr<IDBRequest> openCursor(ExecutionContext*, const ScriptValue& range, const String& direction, ExceptionState&);
  69     PassRefPtr<IDBRequest> openKeyCursor(ExecutionContext*, const ScriptValue& range, const String& direction, ExceptionState&);
  70     PassRefPtr<IDBRequest> get(ExecutionContext*, const ScriptValue& key, ExceptionState&);
  71     PassRefPtr<IDBRequest> add(ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&);
  72     PassRefPtr<IDBRequest> put(ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&);
  73     PassRefPtr<IDBRequest> deleteFunction(ExecutionContext*, const ScriptValue& key, ExceptionState&);
  74     PassRefPtr<IDBRequest> clear(ExecutionContext*, ExceptionState&);
  75
  76     PassRefPtr<IDBIndex> createIndex(ExecutionContext* context, const String& name, const String& keyPath, const Dictionary& options, ExceptionState& exceptionState) { return createIndex(context, name, IDBKeyPath(keyPath), options, exceptionState); }
  77     PassRefPtr<IDBIndex> createIndex(ExecutionContext* context, const String& name, const Vector<String>& keyPath, const Dictionary& options, ExceptionState& exceptionState) { return createIndex(context, name, IDBKeyPath(keyPath), options, exceptionState); }
  78     PassRefPtr<IDBIndex> index(const String& name, ExceptionState&);
  79     void deleteIndex(const String& name, ExceptionState&);
  80
  81     PassRefPtr<IDBRequest> count(ExecutionContext*, const ScriptValue& range, ExceptionState&);
  82
  83     // Used by IDBCursor::update():
  84     PassRefPtr<IDBRequest> put(blink::WebIDBDatabase::PutMode, PassRefPtr<IDBAny> source, ScriptState*, ScriptValue&, PassRefPtr<IDBKey>, ExceptionState&);
  85
  86     // Used internally and by InspectorIndexedDBAgent:
  87     PassRefPtr<IDBRequest> openCursor(ExecutionContext*, PassRefPtr<IDBKeyRange>, blink::WebIDBCursor::Direction, blink::WebIDBDatabase::TaskType = blink::WebIDBDatabase::NormalTask);
  88
  89     void markDeleted() { m_deleted = true; }
  90     bool isDeleted() const { return m_deleted; }
  91     void transactionFinished();
  92
  93     const IDBObjectStoreMetadata& metadata() const { return m_metadata; }
  94     void setMetadata(const IDBObjectStoreMetadata& metadata) { m_metadata = metadata; }
  95
  96     typedef Vector<RefPtr<IDBKey> > IndexKeys;
  97     typedef HashMap<String, IndexKeys> IndexKeyMap;
  98
  99     blink::WebIDBDatabase* backendDB() const;
 100
 101 private:
 102     IDBObjectStore(const IDBObjectStoreMetadata&, IDBTransaction*);
 103
 104     PassRefPtr<IDBIndex> createIndex(ExecutionContext*, const String& name, const IDBKeyPath&, const Dictionary&, ExceptionState&);
 105     PassRefPtr<IDBIndex> createIndex(ExecutionContext*, const String& name, const IDBKeyPath&, bool unique, bool multiEntry, ExceptionState&);
 106     PassRefPtr<IDBRequest> put(blink::WebIDBDatabase::PutMode, PassRefPtr<IDBAny> source, ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&);
 107
 108     int64_t findIndexId(const String& name) const;
 109     bool containsIndex(const String& name) const
 110     {
 111         return findIndexId(name) != IDBIndexMetadata::InvalidId;
 112     }
 113
 114     IDBObjectStoreMetadata m_metadata;
 115     RefPtr<IDBTransaction> m_transaction;
 116     bool m_deleted;
 117
 118     typedef HashMap<String, RefPtr<IDBIndex> > IDBIndexMap;
 119     IDBIndexMap m_indexMap;
 120 };
 121
 122 } // namespace WebCore
 123
 124 #endif // IDBObjectStore_h