Source/WebCore/storage/IDBBackingStore.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 IDBBackingStore_h
  27 #define IDBBackingStore_h
  28
  29 #if ENABLE(INDEXED_DATABASE)
  30
  31 #include "IDBCursor.h"
  32 #include "IDBFactoryBackendInterface.h"
  33 #include "SQLiteDatabase.h"
  34 #include <wtf/PassRefPtr.h>
  35 #include <wtf/RefCounted.h>
  36 #include <wtf/RefPtr.h>
  37 #include <wtf/Vector.h>
  38
  39 namespace WebCore {
  40
  41 class IDBKey;
  42 class IDBKeyRange;
  43 class SecurityOrigin;
  44
  45 class IDBBackingStore : public RefCounted<IDBBackingStore> {
  46 public:
  47     virtual ~IDBBackingStore() {};
  48
  49     virtual void getDatabaseNames(Vector<String>& foundNames) = 0;
  50     virtual bool getIDBDatabaseMetaData(const String& name, String& foundVersion, int64_t& foundId) = 0;
  51     virtual bool createIDBDatabaseMetaData(const String& name, const String& version, int64_t& rowId) = 0;
  52     virtual bool updateIDBDatabaseMetaData(int64_t rowId, const String& version) = 0;
  53     virtual bool deleteDatabase(const String& name) = 0;
  54
  55     virtual void getObjectStores(int64_t databaseId, Vector<int64_t>& foundIds, Vector<String>& foundNames, Vector<String>& foundKeyPaths, Vector<bool>& foundAutoIncrementFlags) = 0;
  56     virtual bool createObjectStore(int64_t databaseId, const String& name, const String& keyPath, bool autoIncrement, int64_t& assignedObjectStoreId) = 0;
  57     virtual void deleteObjectStore(int64_t databaseId, int64_t objectStoreId) = 0;
  58
  59     class ObjectStoreRecordIdentifier : public RefCounted<ObjectStoreRecordIdentifier> {
  60     public:
  61         virtual bool isValid() const = 0;
  62         virtual ~ObjectStoreRecordIdentifier() {}
  63     };
  64     virtual PassRefPtr<ObjectStoreRecordIdentifier> createInvalidRecordIdentifier() = 0;
  65
  66     virtual String getObjectStoreRecord(int64_t databaseId, int64_t objectStoreId, const IDBKey&) = 0;
  67     virtual bool putObjectStoreRecord(int64_t databaseId, int64_t objectStoreId, const IDBKey&, const String& value, ObjectStoreRecordIdentifier*) = 0;
  68     virtual void clearObjectStore(int64_t databaseId, int64_t objectStoreId) = 0;
  69     virtual void deleteObjectStoreRecord(int64_t databaseId, int64_t objectStoreId, const ObjectStoreRecordIdentifier*) = 0;
  70     virtual double nextAutoIncrementNumber(int64_t databaseId, int64_t objectStoreId) = 0;
  71     virtual bool keyExistsInObjectStore(int64_t databaseId, int64_t objectStoreId, const IDBKey&, ObjectStoreRecordIdentifier* foundRecordIdentifier) = 0;
  72
  73     class ObjectStoreRecordCallback {
  74     public:
  75          virtual bool callback(const ObjectStoreRecordIdentifier*, const String& value) = 0;
  76          virtual ~ObjectStoreRecordCallback() {};
  77     };
  78     virtual bool forEachObjectStoreRecord(int64_t databaseId, int64_t objectStoreId, ObjectStoreRecordCallback&) = 0;
  79
  80     virtual void getIndexes(int64_t databaseId, int64_t objectStoreId, Vector<int64_t>& foundIds, Vector<String>& foundNames, Vector<String>& foundKeyPaths, Vector<bool>& foundUniqueFlags) = 0;
  81     virtual bool createIndex(int64_t databaseId, int64_t objectStoreId, const String& name, const String& keyPath, bool isUnique, int64_t& indexId) = 0;
  82     virtual void deleteIndex(int64_t databaseId, int64_t objectStoreId, int64_t indexId) = 0;
  83     virtual bool putIndexDataForRecord(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&, const ObjectStoreRecordIdentifier*) = 0;
  84     virtual bool deleteIndexDataForRecord(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const ObjectStoreRecordIdentifier*) = 0;
  85     virtual String getObjectViaIndex(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&) = 0;
  86     virtual PassRefPtr<IDBKey> getPrimaryKeyViaIndex(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&) = 0;
  87     virtual bool keyExistsInIndex(int64_t databaseid, int64_t objectStoreId, int64_t indexId, const IDBKey& indexKey, RefPtr<IDBKey>& foundPrimaryKey) = 0;
  88
  89     class Cursor : public RefCounted<Cursor> {
  90     public:
  91         virtual bool continueFunction(const IDBKey* = 0) = 0;
  92         virtual PassRefPtr<IDBKey> key() = 0;
  93         virtual PassRefPtr<IDBKey> primaryKey() = 0;
  94         virtual String value() = 0;
  95         virtual PassRefPtr<ObjectStoreRecordIdentifier> objectStoreRecordIdentifier() = 0;
  96         virtual int64_t indexDataId() = 0;
  97         virtual void close() = 0;
  98         virtual ~Cursor() { };
  99     };
 100
 101     virtual PassRefPtr<Cursor> openObjectStoreCursor(int64_t databaseId, int64_t objectStoreId, const IDBKeyRange*, IDBCursor::Direction) = 0;
 102     virtual PassRefPtr<Cursor> openIndexKeyCursor(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKeyRange*, IDBCursor::Direction) = 0;
 103     virtual PassRefPtr<Cursor> openIndexCursor(int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKeyRange*, IDBCursor::Direction) = 0;
 104
 105     class Transaction : public RefCounted<Transaction> {
 106     public:
 107         virtual ~Transaction() { }
 108         virtual void begin() = 0;
 109         virtual void commit() = 0;
 110         virtual void rollback() = 0;
 111     };
 112     virtual PassRefPtr<Transaction> createTransaction() = 0;
 113 };
 114
 115 } // namespace WebCore
 116
 117 #endif
 118
 119 #endif // IDBBackingStore_h