Source/WebCore/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 "Dictionary.h"
  30 #include "IDBCursor.h"
  31 #include "IDBIndex.h"
  32 #include "IDBKey.h"
  33 #include "IDBKeyRange.h"
  34 #include "IDBMetadata.h"
  35 #include "IDBObjectStoreBackendInterface.h"
  36 #include "IDBRequest.h"
  37 #include "IDBTransaction.h"
  38 #include "PlatformString.h"
  39 #include "SerializedScriptValue.h"
  40 #include <wtf/PassRefPtr.h>
  41 #include <wtf/RefCounted.h>
  42 #include <wtf/RefPtr.h>
  43
  44 #if ENABLE(INDEXED_DATABASE)
  45
  46 namespace WebCore {
  47
  48 class DOMStringList;
  49 class IDBAny;
  50
  51 class IDBObjectStore : public RefCounted<IDBObjectStore> {
  52 public:
  53     static PassRefPtr<IDBObjectStore> create(const IDBObjectStoreMetadata& metadata, PassRefPtr<IDBObjectStoreBackendInterface> backend, IDBTransaction* transaction)
  54     {
  55         return adoptRef(new IDBObjectStore(metadata, backend, transaction));
  56     }
  57     ~IDBObjectStore() { }
  58
  59     // Implement the IDBObjectStore IDL
  60     const String name() const { return m_metadata.name; }
  61     PassRefPtr<IDBAny> keyPath() const { return m_metadata.keyPath; }
  62     PassRefPtr<DOMStringList> indexNames() const;
  63     PassRefPtr<IDBTransaction> transaction() const { return m_transaction; }
  64     bool autoIncrement() const { return m_metadata.autoIncrement; }
  65
  66     PassRefPtr<IDBRequest> add(ScriptExecutionContext* context, PassRefPtr<SerializedScriptValue> value, ExceptionCode& ec) { return add(context, value, 0, ec);  }
  67     PassRefPtr<IDBRequest> put(ScriptExecutionContext* context, PassRefPtr<SerializedScriptValue> value, ExceptionCode& ec) { return put(context, value, 0, ec);  }
  68     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, ExceptionCode& ec) { return openCursor(context, static_cast<IDBKeyRange*>(0), ec); }
  69     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionCode& ec) { return openCursor(context, keyRange, IDBCursor::directionNext(), ec); }
  70     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, PassRefPtr<IDBKey> key, ExceptionCode& ec) { return openCursor(context, key, IDBCursor::directionNext(), ec); }
  71
  72     PassRefPtr<IDBRequest> get(ScriptExecutionContext*, PassRefPtr<IDBKey>, ExceptionCode&);
  73     PassRefPtr<IDBRequest> get(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionCode&);
  74     PassRefPtr<IDBRequest> add(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, ExceptionCode&);
  75     PassRefPtr<IDBRequest> put(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, ExceptionCode&);
  76     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionCode&);
  77     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, PassRefPtr<IDBKey> key, ExceptionCode&);
  78     PassRefPtr<IDBRequest> clear(ScriptExecutionContext*, ExceptionCode&);
  79
  80     // FIXME: Try to modify the code generator so this duplication is unneeded.
  81     PassRefPtr<IDBIndex> createIndex(const String& name, const String& keyPath, const Dictionary&, ExceptionCode&);
  82     PassRefPtr<IDBIndex> createIndex(const String& name, const String& keyPath, ExceptionCode& ec) { return createIndex(name, keyPath, Dictionary(), ec); }
  83     PassRefPtr<IDBIndex> createIndex(const String& name, PassRefPtr<DOMStringList> keyPath, const Dictionary&, ExceptionCode&);
  84     PassRefPtr<IDBIndex> createIndex(const String& name, PassRefPtr<DOMStringList> keyPath, ExceptionCode& ec) { return createIndex(name, keyPath, Dictionary(), ec); }
  85     PassRefPtr<IDBIndex> createIndex(const String&, const IDBKeyPath&, const Dictionary&, ExceptionCode&);
  86
  87     PassRefPtr<IDBIndex> index(const String& name, ExceptionCode&);
  88     void deleteIndex(const String& name, ExceptionCode&);
  89
  90     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, const String& direction, ExceptionCode&);
  91     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKey>, const String& direction, ExceptionCode&);
  92     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, unsigned short direction, ExceptionCode&);
  93     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKey>, unsigned short direction, ExceptionCode&);
  94     PassRefPtr<IDBRequest> count(ScriptExecutionContext* context, ExceptionCode& ec) { return count(context, static_cast<IDBKeyRange*>(0), ec); }
  95     PassRefPtr<IDBRequest> count(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, ExceptionCode&);
  96     PassRefPtr<IDBRequest> count(ScriptExecutionContext*, PassRefPtr<IDBKey>, ExceptionCode&);
  97
  98     void markDeleted() { m_deleted = true; }
  99     void transactionFinished();
 100
 101     IDBObjectStoreMetadata metadata() const { return m_metadata; }
 102     void setMetadata(const IDBObjectStoreMetadata& metadata) { m_metadata = metadata; }
 103
 104 private:
 105     IDBObjectStore(const IDBObjectStoreMetadata&, PassRefPtr<IDBObjectStoreBackendInterface>, IDBTransaction*);
 106     void removeTransactionFromPendingList();
 107
 108     IDBObjectStoreMetadata m_metadata;
 109     RefPtr<IDBObjectStoreBackendInterface> m_backend;
 110     RefPtr<IDBTransaction> m_transaction;
 111     bool m_deleted;
 112
 113     typedef HashMap<String, RefPtr<IDBIndex> > IDBIndexMap;
 114     IDBIndexMap m_indexMap;
 115 };
 116
 117 } // namespace WebCore
 118
 119 #endif
 120
 121 #endif // IDBObjectStore_h