8e3f83e9dbe9f7ed0407b0e4933c598fb68e514f
[WebKit-https.git] / Source / WebCore / storage / IDBAny.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 IDBAny_h
27 #define IDBAny_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37 class IDBCursor;
38 class IDBDatabase;
39 class IDBFactory;
40 class IDBIndex;
41 class IDBKey;
42 class IDBObjectStore;
43 class IDBTransaction;
44 class SerializedScriptValue;
45
46 class IDBAny : public RefCounted<IDBAny> {
47 public:
48     static PassRefPtr<IDBAny> createInvalid();
49     static PassRefPtr<IDBAny> createNull();
50     template<typename T>
51     static PassRefPtr<IDBAny> create(T* idbObject)
52     {
53         RefPtr<IDBAny> any = IDBAny::createInvalid();
54         any->set(idbObject);
55         return any.release();
56     }
57     template<typename T>
58     static PassRefPtr<IDBAny> create(PassRefPtr<T> idbObject)
59     {
60         RefPtr<IDBAny> any = IDBAny::createInvalid();
61         any->set(idbObject);
62         return any.release();
63     }
64     ~IDBAny();
65
66     enum Type {
67         UndefinedType = 0,
68         NullType,
69         IDBCursorType,
70         IDBDatabaseType,
71         IDBFactoryType,
72         IDBIndexType,
73         IDBKeyType,
74         IDBObjectStoreType,
75         IDBTransactionType,
76         SerializedScriptValueType
77     };
78
79     Type type() const { return m_type; }
80     // Use type() to figure out which one of these you're allowed to call.
81     PassRefPtr<IDBCursor> idbCursor();
82     PassRefPtr<IDBDatabase> idbDatabase();
83     PassRefPtr<IDBFactory> idbFactory();
84     PassRefPtr<IDBIndex> idbIndex();
85     PassRefPtr<IDBKey> idbKey();
86     PassRefPtr<IDBObjectStore> idbObjectStore();
87     PassRefPtr<IDBTransaction> idbTransaction();
88     PassRefPtr<SerializedScriptValue> serializedScriptValue();
89
90     // Set can only be called once.
91     void setNull();
92     void set(PassRefPtr<IDBCursor>);
93     void set(PassRefPtr<IDBDatabase>);
94     void set(PassRefPtr<IDBFactory>);
95     void set(PassRefPtr<IDBIndex>);
96     void set(PassRefPtr<IDBKey>);
97     void set(PassRefPtr<IDBObjectStore>);
98     void set(PassRefPtr<IDBTransaction>);
99     void set(PassRefPtr<SerializedScriptValue>);
100
101 private:
102     IDBAny();
103
104     Type m_type;
105
106     // Only one of the following should ever be in use at any given time.
107     RefPtr<IDBCursor> m_idbCursor;
108     RefPtr<IDBDatabase> m_idbDatabase;
109     RefPtr<IDBFactory> m_idbFactory;
110     RefPtr<IDBIndex> m_idbIndex;
111     RefPtr<IDBKey> m_idbKey;
112     RefPtr<IDBObjectStore> m_idbObjectStore;
113     RefPtr<IDBTransaction> m_idbTransaction;
114     RefPtr<SerializedScriptValue> m_serializedScriptValue;
115 };
116
117 } // namespace WebCore
118
119 #endif // ENABLE(INDEXED_DATABASE)
120
121 #endif // IDBAny_h