Source/WebCore/Modules/indexeddb/IDBObjectStoreBackendImpl.h

   1 /*
   2  * Copyright (C) 2011 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 IDBObjectStoreBackendImpl_h
  27 #define IDBObjectStoreBackendImpl_h
  28
  29 #include "IDBDatabaseBackendImpl.h"
  30 #include "IDBKeyPath.h"
  31 #include "IDBObjectStoreBackendInterface.h"
  32 #include <wtf/HashMap.h>
  33 #include <wtf/text/StringHash.h>
  34
  35 #if ENABLE(INDEXED_DATABASE)
  36
  37 namespace WebCore {
  38
  39 class IDBDatabaseBackendImpl;
  40 class IDBIndexBackendImpl;
  41 class IDBTransactionBackendInterface;
  42 class ScriptExecutionContext;
  43
  44 class IDBObjectStoreBackendImpl : public IDBObjectStoreBackendInterface {
  45 public:
  46     static PassRefPtr<IDBObjectStoreBackendImpl> create(const IDBDatabaseBackendImpl* database, int64_t id, const String& name, const IDBKeyPath& keyPath, bool autoIncrement)
  47     {
  48         return adoptRef(new IDBObjectStoreBackendImpl(database, id, name, keyPath, autoIncrement));
  49     }
  50     static PassRefPtr<IDBObjectStoreBackendImpl> create(const IDBDatabaseBackendImpl* database, const String& name, const IDBKeyPath& keyPath, bool autoIncrement)
  51     {
  52         return adoptRef(new IDBObjectStoreBackendImpl(database, name, keyPath, autoIncrement));
  53     }
  54     virtual ~IDBObjectStoreBackendImpl();
  55
  56     static const int64_t InvalidId = 0;
  57     int64_t id() const
  58     {
  59         ASSERT(m_id != InvalidId);
  60         return m_id;
  61     }
  62     void setId(int64_t id) { m_id = id; }
  63
  64     virtual String name() const { return m_name; }
  65     virtual IDBKeyPath keyPath() const { return m_keyPath; }
  66     virtual PassRefPtr<DOMStringList> indexNames() const;
  67     virtual bool autoIncrement() const { return m_autoIncrement; }
  68
  69     virtual void get(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  70     virtual void put(PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, PutMode, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  71     virtual void deleteFunction(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  72     virtual void clear(PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  73
  74     virtual PassRefPtr<IDBIndexBackendInterface> createIndex(const String& name, const IDBKeyPath&, bool unique, bool multiEntry, IDBTransactionBackendInterface*, ExceptionCode&);
  75     virtual PassRefPtr<IDBIndexBackendInterface> index(const String& name, ExceptionCode&);
  76     virtual void deleteIndex(const String& name, IDBTransactionBackendInterface*, ExceptionCode&);
  77
  78     virtual void openCursor(PassRefPtr<IDBKeyRange> range, unsigned short direction, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  79     virtual void count(PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, IDBTransactionBackendInterface*, ExceptionCode&);
  80
  81     static bool populateIndex(IDBBackingStore&, int64_t databaseId, int64_t objectStoreId, PassRefPtr<IDBIndexBackendImpl>);
  82
  83 private:
  84     IDBObjectStoreBackendImpl(const IDBDatabaseBackendImpl*, int64_t databaseId, const String& name, const IDBKeyPath&, bool autoIncrement);
  85     IDBObjectStoreBackendImpl(const IDBDatabaseBackendImpl*, const String& name, const IDBKeyPath&, bool autoIncrement);
  86
  87     void loadIndexes();
  88     PassRefPtr<IDBKey> genAutoIncrementKey();
  89     void resetAutoIncrementKeyCache() { m_autoIncrementNumber = -1; }
  90
  91     static void getInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>);
  92     static void putInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, PutMode, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
  93     static void deleteInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>);
  94     static void clearInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBCallbacks>);
  95     static void createIndexInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>, PassRefPtr<IDBTransactionBackendInterface>);
  96     static void deleteIndexInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>, PassRefPtr<IDBTransactionBackendInterface>);
  97     static void openCursorInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange> range, unsigned short direction, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
  98     static void countInternal(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBTransactionBackendInterface>);
  99
 100     // These are used as setVersion transaction abort tasks.
 101     static void removeIndexFromMap(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>);
 102     static void addIndexToMap(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>, PassRefPtr<IDBIndexBackendImpl>);
 103     static void revertAutoIncrementKeyCache(ScriptExecutionContext*, PassRefPtr<IDBObjectStoreBackendImpl>);
 104
 105     PassRefPtr<IDBBackingStore> backingStore() const { return m_database->backingStore(); }
 106     int64_t databaseId() const { return m_database->id(); }
 107
 108     const IDBDatabaseBackendImpl* m_database;
 109     int64_t m_id;
 110     String m_name;
 111     IDBKeyPath m_keyPath;
 112     bool m_autoIncrement;
 113
 114     typedef HashMap<String, RefPtr<IDBIndexBackendImpl> > IndexMap;
 115     IndexMap m_indexes;
 116     int64_t m_autoIncrementNumber;
 117 };
 118
 119 } // namespace WebCore
 120
 121 #endif
 122
 123 #endif // IDBObjectStoreBackendImpl_h