b84d076a8d4d472d48da5d56ea70f3c4f4205884
[WebKit-https.git] / WebCore / storage / DatabaseTask.h
1 /*
2  * Copyright (C) 2007, 2008 Apple 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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef DatabaseTask_h
29 #define DatabaseTask_h
30
31 #include "ExceptionCode.h"
32 #include "PlatformString.h"
33 #include "Threading.h"
34 #include <wtf/OwnPtr.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40 class Database;
41 class DatabaseThread;
42 class SQLValue;
43 class SQLCallback;
44 class SQLTransaction;
45 class VersionChangeCallback;
46
47 class DatabaseTask : public ThreadSafeShared<DatabaseTask>
48 {
49     friend class Database;
50 public:
51     virtual ~DatabaseTask();
52
53     void performTask();
54
55     Database* database() const { return m_database; }
56     bool isComplete() const { return m_complete; }
57
58 protected:
59     DatabaseTask(Database*);
60
61 private:
62     virtual void doPerformTask() = 0;
63 #ifndef NDEBUG
64     virtual const char* debugTaskName() const = 0;
65 #endif
66
67     void lockForSynchronousScheduling();
68     void waitForSynchronousCompletion();
69
70     Database* m_database;
71
72     bool m_complete;
73
74     OwnPtr<Mutex> m_synchronousMutex;
75     OwnPtr<ThreadCondition> m_synchronousCondition;
76 };
77
78 class DatabaseOpenTask : public DatabaseTask
79 {
80 public:
81     DatabaseOpenTask(Database*);
82
83     ExceptionCode exceptionCode() const { return m_code; }
84     bool openSuccessful() const { return m_success; }
85
86 private:
87     virtual void doPerformTask();
88 #ifndef NDEBUG
89     virtual const char* debugTaskName() const;
90 #endif
91
92     ExceptionCode m_code;
93     bool m_success;
94 };
95
96 class DatabaseTransactionTask : public DatabaseTask
97 {
98 public:
99     DatabaseTransactionTask(PassRefPtr<SQLTransaction>);
100     SQLTransaction* transaction() const { return m_transaction.get(); }
101
102     virtual ~DatabaseTransactionTask();
103 private:
104     virtual void doPerformTask();
105 #ifndef NDEBUG
106     virtual const char* debugTaskName() const;
107 #endif
108
109     RefPtr<SQLTransaction> m_transaction;
110 };
111
112 class DatabaseTableNamesTask : public DatabaseTask
113 {
114 public:
115     DatabaseTableNamesTask(Database*);
116
117     Vector<String>& tableNames() { return m_tableNames; }
118
119 private:
120     virtual void doPerformTask();
121 #ifndef NDEBUG
122     virtual const char* debugTaskName() const;
123 #endif
124
125     Vector<String> m_tableNames;
126 };
127
128 } // namespace WebCore
129
130 #endif // DatabaseTask_h