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