309acfbe859393a32cf2c01b376c074d87dd2f35
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / SQLTransactionSync.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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef SQLTransactionSync_h
32 #define SQLTransactionSync_h
33
34 #if ENABLE(SQL_DATABASE)
35
36 #include "PlatformString.h"
37 #include <wtf/Forward.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/Vector.h>
40
41 namespace WebCore {
42
43 class DatabaseSync;
44 class SQLResultSet;
45 class SQLTransactionClient;
46 class SQLTransactionSyncCallback;
47 class SQLValue;
48 class SQLiteTransaction;
49
50 typedef int ExceptionCode;
51
52 // Instances of this class should be created and used only on the worker's context thread.
53 class SQLTransactionSync : public RefCounted<SQLTransactionSync> {
54 public:
55     static PassRefPtr<SQLTransactionSync> create(DatabaseSync*, PassRefPtr<SQLTransactionSyncCallback>, bool readOnly = false);
56
57     ~SQLTransactionSync();
58
59     PassRefPtr<SQLResultSet> executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments, ExceptionCode&);
60
61     DatabaseSync* database() { return m_database.get(); }
62     bool isReadOnly() const { return m_readOnly; }
63
64     ExceptionCode begin();
65     ExceptionCode execute();
66     ExceptionCode commit();
67     void rollback();
68
69 private:
70     SQLTransactionSync(DatabaseSync*, PassRefPtr<SQLTransactionSyncCallback>, bool readOnly);
71
72     RefPtr<DatabaseSync> m_database;
73     RefPtr<SQLTransactionSyncCallback> m_callback;
74     bool m_readOnly;
75     bool m_hasVersionMismatch;
76
77     bool m_modifiedDatabase;
78     OwnPtr<SQLTransactionClient> m_transactionClient;
79     OwnPtr<SQLiteTransaction> m_sqliteTransaction;
80 };
81
82 } // namespace WebCore
83
84 #endif
85
86 #endif // SQLTransactionSync_h