src/third_party/WebKit/public/platform/WebIDBDatabase.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 WebIDBDatabase_h
  27 #define WebIDBDatabase_h
  28
  29 #include "WebCommon.h"
  30 #include "WebIDBCursor.h"
  31 #include "WebIDBMetadata.h"
  32
  33 namespace blink {
  34
  35 class WebData;
  36 class WebIDBCallbacks;
  37 class WebIDBDatabaseCallbacks;
  38 class WebIDBDatabaseError;
  39 class WebIDBKey;
  40 class WebIDBKeyPath;
  41 class WebIDBKeyRange;
  42
  43 // See comment in WebIDBFactory for a high level overview of these classes.
  44 class WebIDBDatabase {
  45 public:
  46     virtual ~WebIDBDatabase() { }
  47
  48     enum TransactionMode {
  49         TransactionReadOnly = 0,
  50         TransactionReadWrite,
  51         TransactionVersionChange,
  52     };
  53
  54     virtual void createObjectStore(long long transactionId, long long objectStoreId, const WebString& name, const WebIDBKeyPath&, bool autoIncrement) { BLINK_ASSERT_NOT_REACHED(); }
  55     virtual void deleteObjectStore(long long transactionId, long long objectStoreId) { BLINK_ASSERT_NOT_REACHED(); }
  56     virtual void createTransaction(long long id, WebIDBDatabaseCallbacks*, const WebVector<long long>& scope, TransactionMode) { BLINK_ASSERT_NOT_REACHED(); }
  57     virtual void close() { BLINK_ASSERT_NOT_REACHED(); }
  58     virtual void forceClose() { BLINK_ASSERT_NOT_REACHED(); }
  59
  60     virtual void abort(long long transactionId) { BLINK_ASSERT_NOT_REACHED(); }
  61     virtual void commit(long long transactionId) { BLINK_ASSERT_NOT_REACHED(); }
  62
  63     virtual void createIndex(long long transactionId, long long objectStoreId, long long indexId, const WebString& name, const WebIDBKeyPath&, bool unique, bool multiEntry) { BLINK_ASSERT_NOT_REACHED(); }
  64     virtual void deleteIndex(long long transactionId, long long objectStoreId, long long indexId) { BLINK_ASSERT_NOT_REACHED(); }
  65
  66     enum TaskType {
  67         NormalTask = 0,
  68         PreemptiveTask,
  69         TaskTypeLast = PreemptiveTask
  70     };
  71
  72     enum PutMode {
  73         AddOrUpdate,
  74         AddOnly,
  75         CursorUpdate,
  76         PutModeLast = CursorUpdate
  77     };
  78
  79     static const long long minimumIndexId = 30;
  80
  81     typedef WebVector<WebIDBKey> WebIndexKeys;
  82
  83     virtual void get(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, bool keyOnly, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
  84     // Note that 'value' may be consumed/adopted by this call.
  85     virtual void put(long long transactionId, long long objectStoreId, const WebData& value, const WebIDBKey&, PutMode, WebIDBCallbacks*, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) { BLINK_ASSERT_NOT_REACHED(); }
  86     virtual void setIndexKeys(long long transactionId, long long objectStoreId, const WebIDBKey&, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) { BLINK_ASSERT_NOT_REACHED(); }
  87     virtual void setIndexesReady(long long transactionId, long long objectStoreId, const WebVector<long long>& indexIds) { BLINK_ASSERT_NOT_REACHED(); }
  88     virtual void openCursor(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, WebIDBCursor::Direction, bool keyOnly, TaskType, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
  89     virtual void count(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
  90     virtual void deleteRange(long long transactionId, long long objectStoreId, const WebIDBKeyRange&, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
  91     virtual void clear(long long transactionId, long long objectStoreId, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
  92
  93 protected:
  94     WebIDBDatabase() { }
  95 };
  96
  97 } // namespace blink
  98
  99 #endif // WebIDBDatabase_h