code.vuplus.com Git - vuplus_webkit/blob - Source/WebCore/storage/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 "IDBCursor.h"
  30 #include "IDBIndex.h"
  31 #include "IDBKey.h"
  32 #include "IDBKeyRange.h"
  33 #include "IDBObjectStoreBackendInterface.h"
  34 #include "IDBRequest.h"
  35 #include "IDBTransaction.h"
  36 #include "OptionsObject.h"
  37 #include "PlatformString.h"
  38 #include "SerializedScriptValue.h"
  39 #include <wtf/PassRefPtr.h>
  40 #include <wtf/RefCounted.h>
  41 #include <wtf/RefPtr.h>
  42
  43 #if ENABLE(INDEXED_DATABASE)
  44
  45 namespace WebCore {
  46
  47 class DOMStringList;
  48 class IDBAny;
  49
  50 class IDBObjectStore : public RefCounted<IDBObjectStore> {
  51 public:
  52     static PassRefPtr<IDBObjectStore> create(PassRefPtr<IDBObjectStoreBackendInterface> idbObjectStore, IDBTransaction* transaction)
  53     {
  54         return adoptRef(new IDBObjectStore(idbObjectStore, transaction));
  55     }
  56     ~IDBObjectStore() { }
  57
  58     String name() const;
  59     String keyPath() const;
  60     PassRefPtr<DOMStringList> indexNames() const;
  61
  62     // FIXME: Try to modify the code generator so this is unneeded.
  63     PassRefPtr<IDBRequest> add(ScriptExecutionContext* context, PassRefPtr<SerializedScriptValue> value, ExceptionCode& ec) { return add(context, value, 0, ec);  }
  64     PassRefPtr<IDBRequest> put(ScriptExecutionContext* context, PassRefPtr<SerializedScriptValue> value, ExceptionCode& ec) { return put(context, value, 0, ec);  }
  65     PassRefPtr<IDBIndex> createIndex(const String& name, const String& keyPath, ExceptionCode& ec) { return createIndex(name, keyPath, OptionsObject(), ec); }
  66     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, ExceptionCode& ec) { return openCursor(context, 0, ec); }
  67     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionCode& ec) { return openCursor(context, keyRange, IDBCursor::NEXT, ec); }
  68
  69     PassRefPtr<IDBRequest> get(ScriptExecutionContext*, PassRefPtr<IDBKey>, ExceptionCode&);
  70     PassRefPtr<IDBRequest> add(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, ExceptionCode&);
  71     PassRefPtr<IDBRequest> put(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBKey>, ExceptionCode&);
  72     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, PassRefPtr<IDBKey> key, ExceptionCode&);
  73     PassRefPtr<IDBRequest> clear(ScriptExecutionContext*, ExceptionCode&);
  74
  75     PassRefPtr<IDBIndex> createIndex(const String& name, const String& keyPath, const OptionsObject&, ExceptionCode&);
  76     PassRefPtr<IDBIndex> index(const String& name, ExceptionCode&);
  77     void deleteIndex(const String& name, ExceptionCode&);
  78
  79     PassRefPtr<IDBRequest> openCursor(ScriptExecutionContext*, PassRefPtr<IDBKeyRange>, unsigned short direction, ExceptionCode&);
  80
  81 private:
  82     IDBObjectStore(PassRefPtr<IDBObjectStoreBackendInterface>, IDBTransaction*);
  83     void removeTransactionFromPendingList();
  84
  85     RefPtr<IDBObjectStoreBackendInterface> m_objectStore;
  86     RefPtr<IDBTransaction> m_transaction;
  87 };
  88
  89 } // namespace WebCore
  90
  91 #endif
  92
  93 #endif // IDBObjectStore_h
  94