initial import
[vuplus_webkit] / Source / WebCore / storage / IDBTransactionBackendImpl.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 IDBTransactionBackendImpl_h
27 #define IDBTransactionBackendImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "DOMStringList.h"
32 #include "IDBBackingStore.h"
33 #include "IDBTransactionBackendInterface.h"
34 #include "IDBTransactionCallbacks.h"
35 #include "Timer.h"
36 #include <wtf/Deque.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/RefPtr.h>
39
40 namespace WebCore {
41
42 class IDBDatabaseBackendImpl;
43
44 class IDBTransactionBackendImpl : public IDBTransactionBackendInterface {
45 public:
46     static PassRefPtr<IDBTransactionBackendImpl> create(DOMStringList* objectStores, unsigned short mode, IDBDatabaseBackendImpl*);
47     virtual ~IDBTransactionBackendImpl();
48
49     virtual PassRefPtr<IDBObjectStoreBackendInterface> objectStore(const String& name, ExceptionCode&);
50     virtual unsigned short mode() const { return m_mode; }
51     virtual bool scheduleTask(PassOwnPtr<ScriptExecutionContext::Task> task, PassOwnPtr<ScriptExecutionContext::Task> abortTask);
52     virtual void didCompleteTaskEvents();
53     virtual void abort();
54     virtual void setCallbacks(IDBTransactionCallbacks* callbacks) { m_callbacks = callbacks; }
55     virtual void registerOpenCursor(IDBCursorBackendImpl*);
56     virtual void unregisterOpenCursor(IDBCursorBackendImpl*);
57
58     void run();
59
60 private:
61     IDBTransactionBackendImpl(DOMStringList* objectStores, unsigned short mode, IDBDatabaseBackendImpl*);
62
63     enum State {
64         Unused, // Created, but no tasks yet.
65         StartPending, // Enqueued tasks, but SQLite transaction not yet started.
66         Running, // SQLite transaction started but not yet finished.
67         Finished, // Either aborted or committed.
68     };
69
70     void start();
71     void commit();
72
73     void taskTimerFired(Timer<IDBTransactionBackendImpl>*);
74     void taskEventTimerFired(Timer<IDBTransactionBackendImpl>*);
75     void closeOpenCursors();
76
77     RefPtr<DOMStringList> m_objectStoreNames;
78     unsigned short m_mode;
79
80     State m_state;
81     RefPtr<IDBTransactionCallbacks> m_callbacks;
82     RefPtr<IDBDatabaseBackendImpl> m_database;
83
84     typedef Deque<OwnPtr<ScriptExecutionContext::Task> > TaskQueue;
85     TaskQueue m_taskQueue;
86     TaskQueue m_abortTaskQueue;
87
88     RefPtr<IDBBackingStore::Transaction> m_transaction;
89
90     // FIXME: delete the timer once we have threads instead.
91     Timer<IDBTransactionBackendImpl> m_taskTimer;
92     Timer<IDBTransactionBackendImpl> m_taskEventTimer;
93     int m_pendingEvents;
94
95     HashSet<IDBCursorBackendImpl*> m_openCursors;
96 };
97
98 } // namespace WebCore
99
100 #endif // ENABLE(INDEXED_DATABASE)
101
102 #endif // IDBTransactionBackendImpl_h