1588e23c1e8276e450defed9188acf621c7338b6
[WebKit-https.git] / WebKit / chromium / public / WebIDBDatabase.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 WebIDBDatabase_h
27 #define WebIDBDatabase_h
28
29 #include "WebCommon.h"
30 #include "WebDOMStringList.h"
31 #include "WebExceptionCode.h"
32
33 namespace WebKit {
34
35 class WebFrame;
36 class WebIDBCallbacks;
37 class WebIDBObjectStore;
38 class WebIDBTransaction;
39
40 // See comment in WebIDBFactory for a high level overview of these classes.
41 class WebIDBDatabase {
42 public:
43     virtual ~WebIDBDatabase() { }
44
45     virtual WebString name() const
46     {
47         WEBKIT_ASSERT_NOT_REACHED();
48         return WebString();
49     }
50     // FIXME: remove after roll.
51     virtual WebString description() const
52     {
53         return WebString();
54     }
55     virtual WebString version() const
56     {
57         WEBKIT_ASSERT_NOT_REACHED();
58         return WebString();
59     }
60     virtual WebDOMStringList objectStores() const { return objectStoreNames(); } // FIXME: Remove after roll.
61     virtual WebDOMStringList objectStoreNames() const { return objectStores(); } // FIXME: Assert not reached after roll.
62     virtual WebIDBObjectStore* createObjectStore(const WebString& name, const WebString& keyPath, bool autoIncrement, const WebIDBTransaction&, WebExceptionCode&)
63     { 
64         WEBKIT_ASSERT_NOT_REACHED();
65         return 0;
66     }
67     virtual void deleteObjectStore(const WebString& name, const WebIDBTransaction& transaction, WebExceptionCode& ec) { removeObjectStore(name, transaction, ec); }
68     // FIXME: remove after roll.
69     virtual void removeObjectStore(const WebString& name, const WebIDBTransaction& transaction, WebExceptionCode& ec) { deleteObjectStore(name, transaction, ec); }
70     virtual void setVersion(const WebString& version, WebIDBCallbacks* callbacks, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
71     // Transfers ownership of the WebIDBTransaction to the caller.
72     virtual WebIDBTransaction* transaction(const WebDOMStringList& names, unsigned short mode, unsigned long timeout, WebExceptionCode&)
73     {
74         WEBKIT_ASSERT_NOT_REACHED();
75         return 0;
76     }
77     virtual void close() { WEBKIT_ASSERT_NOT_REACHED(); }
78
79 protected:
80     WebIDBDatabase() { }
81 };
82
83 } // namespace WebKit
84
85 #endif // WebIDBDatabase_h