Rename current concrete IDB implementation to "Legacy".
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabase.h
1 /*
2  * Copyright (C) 2015 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBDatabase_h
27 #define IDBDatabase_h
28
29 #include "ActiveDOMObject.h"
30 #include "DOMStringList.h"
31 #include "Dictionary.h"
32 #include "Event.h"
33 #include "EventTarget.h"
34 #include "IDBDatabaseMetadata.h"
35 #include "IDBObjectStore.h"
36 #include "IDBTransaction.h"
37 #include "IndexedDB.h"
38 #include "ScriptWrappable.h"
39 #include <wtf/PassRefPtr.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42
43 #if ENABLE(INDEXED_DATABASE)
44
45 namespace WebCore {
46
47 class ScriptExecutionContext;
48
49 typedef int ExceptionCode;
50
51 class IDBDatabase : public RefCounted<IDBDatabase>, public ScriptWrappable, public EventTargetWithInlineData, public ActiveDOMObject {
52 public:
53     virtual ~IDBDatabase() { }
54
55     // Implement the IDL
56     virtual const String name() const = 0;
57     virtual uint64_t version() const = 0;
58     virtual PassRefPtr<DOMStringList> objectStoreNames() const = 0;
59
60     virtual PassRefPtr<IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionCode&) = 0;
61     virtual PassRefPtr<IDBObjectStore> createObjectStore(const String& name, const IDBKeyPath&, bool autoIncrement, ExceptionCode&) = 0;
62     virtual PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const Vector<String>&, const String& mode, ExceptionCode&) = 0;
63     virtual PassRefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const String&, const String& mode, ExceptionCode&) = 0;
64     virtual void deleteObjectStore(const String& name, ExceptionCode&) = 0;
65     virtual void close() = 0;
66
67     virtual const IDBDatabaseMetadata metadata() const = 0;
68
69     using RefCounted<IDBDatabase>::ref;
70     using RefCounted<IDBDatabase>::deref;
71
72 protected:
73     IDBDatabase(ScriptExecutionContext*);
74 };
75
76 } // namespace WebCore
77
78 #endif
79
80 #endif // IDBDatabase_h