2011-02-09 Hans Wennborg <hans@chromium.org>
[WebKit-https.git] / Source / WebCore / storage / IDBCursorBackendImpl.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
27 #ifndef IDBCursorBackendImpl_h
28 #define IDBCursorBackendImpl_h
29
30 #if ENABLE(INDEXED_DATABASE)
31
32 #include "IDBCursor.h"
33 #include "IDBCursorBackendInterface.h"
34 #include <wtf/OwnPtr.h>
35 #include <wtf/PassOwnPtr.h>
36 #include <wtf/RefPtr.h>
37
38 namespace WebCore {
39
40 class IDBDatabaseBackendImpl;
41 class IDBIndexBackendImpl;
42 class IDBKeyRange;
43 class IDBObjectStoreBackendInterface;
44 class IDBSQLiteDatabase;
45 class IDBTransactionBackendInterface;
46 class SQLiteDatabase;
47 class SQLiteStatement;
48 class SerializedScriptValue;
49
50 class IDBCursorBackendImpl : public IDBCursorBackendInterface {
51 public:
52     static PassRefPtr<IDBCursorBackendImpl> create(IDBSQLiteDatabase* database, PassRefPtr<IDBKeyRange> keyRange, IDBCursor::Direction direction, PassOwnPtr<SQLiteStatement> query, bool isSerializedScriptValueCursor, IDBTransactionBackendInterface* transaction, IDBObjectStoreBackendInterface* objectStore)
53     {
54         return adoptRef(new IDBCursorBackendImpl(database, keyRange, direction, query, isSerializedScriptValueCursor, transaction, objectStore));
55     }
56     virtual ~IDBCursorBackendImpl();
57
58     virtual unsigned short direction() const;
59     virtual PassRefPtr<IDBKey> key() const;
60     virtual PassRefPtr<IDBAny> value() const;
61     virtual void update(PassRefPtr<SerializedScriptValue>, PassRefPtr<IDBCallbacks>, ExceptionCode&);
62     virtual void continueFunction(PassRefPtr<IDBKey>, PassRefPtr<IDBCallbacks>, ExceptionCode&);
63     virtual void deleteFunction(PassRefPtr<IDBCallbacks>, ExceptionCode&);
64
65 private:
66     IDBCursorBackendImpl(IDBSQLiteDatabase*, PassRefPtr<IDBKeyRange>, IDBCursor::Direction, PassOwnPtr<SQLiteStatement> query, bool isSerializedScriptValueCursor, IDBTransactionBackendInterface*, IDBObjectStoreBackendInterface*);
67
68     bool currentRowExists();
69     void loadCurrentRow();
70     SQLiteDatabase& database() const;
71
72     static void continueFunctionInternal(ScriptExecutionContext*, PassRefPtr<IDBCursorBackendImpl>, PassRefPtr<IDBKey>, PassRefPtr<IDBCallbacks>);
73
74     static const int64_t InvalidId = -1;
75
76     RefPtr<IDBSQLiteDatabase> m_database;
77
78     RefPtr<IDBKeyRange> m_keyRange;
79     IDBCursor::Direction m_direction;
80     OwnPtr<SQLiteStatement> m_query;
81     bool m_isSerializedScriptValueCursor;
82     int64_t m_currentId;
83
84     // The key in the objectStore or index that this cursor iterates over.
85     RefPtr<IDBKey> m_currentKey;
86
87     // m_isSerializedScriptValueCursor will only be available for object cursors.
88     RefPtr<SerializedScriptValue> m_currentSerializedScriptValue;
89
90     // FIXME: make the primary key available via script for all types of cursors.
91     // For cursors on indices, this is the key in the objectstore that corresponds to the current entry in the index.
92     RefPtr<IDBKey> m_currentIDBKeyValue;
93
94     RefPtr<IDBTransactionBackendInterface> m_transaction;
95     RefPtr<IDBObjectStoreBackendInterface> m_objectStore;
96 };
97
98 } // namespace WebCore
99
100 #endif // ENABLE(INDEXED_DATABASE)
101
102 #endif // IDBCursorBackendImpl_h