• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 "WebBlobInfo.h"
30 #include "WebCommon.h"
31 #include "WebIDBCursor.h"
32 #include "WebIDBMetadata.h"
33 #include "public/platform/WebIDBTypes.h"
34 
35 namespace blink {
36 
37 class WebData;
38 class WebIDBCallbacks;
39 class WebIDBDatabaseCallbacks;
40 class WebIDBDatabaseError;
41 class WebIDBKey;
42 class WebIDBKeyPath;
43 class WebIDBKeyRange;
44 
45 // See comment in WebIDBFactory for a high level overview of these classes.
46 class WebIDBDatabase {
47 public:
~WebIDBDatabase()48     virtual ~WebIDBDatabase() { }
49 
50     // FIXME: Remove once Chromium is updated to use the new enums.
51     typedef WebIDBTransactionMode TransactionMode;
52     static const WebIDBTransactionMode TransactionReadOnly = WebIDBTransactionModeReadOnly;
53     static const WebIDBTransactionMode TransactionReadWrite = WebIDBTransactionModeReadWrite;
54     static const WebIDBTransactionMode TransactionVersionChange = WebIDBTransactionModeVersionChange;
55 
createObjectStore(long long transactionId,long long objectStoreId,const WebString & name,const WebIDBKeyPath &,bool autoIncrement)56     virtual void createObjectStore(long long transactionId, long long objectStoreId, const WebString& name, const WebIDBKeyPath&, bool autoIncrement) { BLINK_ASSERT_NOT_REACHED(); }
deleteObjectStore(long long transactionId,long long objectStoreId)57     virtual void deleteObjectStore(long long transactionId, long long objectStoreId) { BLINK_ASSERT_NOT_REACHED(); }
createTransaction(long long id,WebIDBDatabaseCallbacks *,const WebVector<long long> & scope,blink::WebIDBTransactionMode)58     virtual void createTransaction(long long id, WebIDBDatabaseCallbacks*, const WebVector<long long>& scope, blink::WebIDBTransactionMode) { BLINK_ASSERT_NOT_REACHED(); }
close()59     virtual void close() { BLINK_ASSERT_NOT_REACHED(); }
forceClose()60     virtual void forceClose() { BLINK_ASSERT_NOT_REACHED(); }
61 
abort(long long transactionId)62     virtual void abort(long long transactionId) { BLINK_ASSERT_NOT_REACHED(); }
commit(long long transactionId)63     virtual void commit(long long transactionId) { BLINK_ASSERT_NOT_REACHED(); }
64 
createIndex(long long transactionId,long long objectStoreId,long long indexId,const WebString & name,const WebIDBKeyPath &,bool unique,bool multiEntry)65     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(); }
deleteIndex(long long transactionId,long long objectStoreId,long long indexId)66     virtual void deleteIndex(long long transactionId, long long objectStoreId, long long indexId) { BLINK_ASSERT_NOT_REACHED(); }
67 
68     // FIXME: Remove once Chromium is updated to use the new enums.
69     typedef WebIDBTaskType TaskType;
70     static const WebIDBTaskType NormalTask = WebIDBTaskTypeNormal;
71     static const WebIDBTaskType PreemptiveTask = WebIDBTaskTypePreemptive;
72     static const WebIDBTaskType TaskTypeLast = WebIDBTaskTypeLast;
73 
74     // FIXME: Remove once Chromium is updated to use the new enums.
75     typedef WebIDBPutMode PutMode;
76     static const WebIDBPutMode AddOrUpdate = WebIDBPutModeAddOrUpdate;
77     static const WebIDBPutMode AddOnly = WebIDBPutModeAddOnly;
78     static const WebIDBPutMode CursorUpdate = WebIDBPutModeCursorUpdate;
79     static const WebIDBPutMode PutModeLast = WebIDBPutModeLast;
80 
81     static const long long minimumIndexId = 30;
82 
83     typedef WebVector<WebIDBKey> WebIndexKeys;
84 
get(long long transactionId,long long objectStoreId,long long indexId,const WebIDBKeyRange &,bool keyOnly,WebIDBCallbacks *)85     virtual void get(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, bool keyOnly, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
put(long long transactionId,long long objectStoreId,const WebData & value,const WebVector<WebBlobInfo> &,const WebIDBKey &,blink::WebIDBPutMode,WebIDBCallbacks *,const WebVector<long long> & indexIds,const WebVector<WebIndexKeys> &)86     virtual void put(long long transactionId, long long objectStoreId, const WebData& value, const WebVector<WebBlobInfo>&, const WebIDBKey&, blink::WebIDBPutMode, WebIDBCallbacks*, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) { BLINK_ASSERT_NOT_REACHED(); }
setIndexKeys(long long transactionId,long long objectStoreId,const WebIDBKey &,const WebVector<long long> & indexIds,const WebVector<WebIndexKeys> &)87     virtual void setIndexKeys(long long transactionId, long long objectStoreId, const WebIDBKey&, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) { BLINK_ASSERT_NOT_REACHED(); }
setIndexesReady(long long transactionId,long long objectStoreId,const WebVector<long long> & indexIds)88     virtual void setIndexesReady(long long transactionId, long long objectStoreId, const WebVector<long long>& indexIds) { BLINK_ASSERT_NOT_REACHED(); }
openCursor(long long transactionId,long long objectStoreId,long long indexId,const WebIDBKeyRange &,blink::WebIDBCursorDirection,bool keyOnly,blink::WebIDBTaskType,WebIDBCallbacks *)89     virtual void openCursor(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, blink::WebIDBCursorDirection, bool keyOnly, blink::WebIDBTaskType, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
count(long long transactionId,long long objectStoreId,long long indexId,const WebIDBKeyRange &,WebIDBCallbacks *)90     virtual void count(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
deleteRange(long long transactionId,long long objectStoreId,const WebIDBKeyRange &,WebIDBCallbacks *)91     virtual void deleteRange(long long transactionId, long long objectStoreId, const WebIDBKeyRange&, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
clear(long long transactionId,long long objectStoreId,WebIDBCallbacks *)92     virtual void clear(long long transactionId, long long objectStoreId, WebIDBCallbacks*) { BLINK_ASSERT_NOT_REACHED(); }
ackReceivedBlobs(const WebVector<WebString> & uuids)93     virtual void ackReceivedBlobs(const WebVector<WebString>& uuids) { BLINK_ASSERT_NOT_REACHED(); }
94 
95 protected:
WebIDBDatabase()96     WebIDBDatabase() { }
97 };
98 
99 } // namespace blink
100 
101 #endif // WebIDBDatabase_h
102