f83c1f117d6a099d7370c799a6ecbcd994c33e58
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBIndex.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 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBCursor.h"
31 #include "IDBIndexInfo.h"
32 #include "IDBRequest.h"
33
34 namespace JSC {
35 class CallFrame;
36 using ExecState = CallFrame;
37 }
38
39 namespace WebCore {
40
41 class IDBKeyRange;
42
43 struct IDBKeyRangeData;
44
45 class IDBIndex final : public ActiveDOMObject {
46     WTF_MAKE_NONCOPYABLE(IDBIndex);
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     IDBIndex(ScriptExecutionContext&, const IDBIndexInfo&, IDBObjectStore&);
50
51     virtual ~IDBIndex();
52
53     const String& name() const;
54     ExceptionOr<void> setName(const String&);
55     IDBObjectStore& objectStore();
56     const IDBKeyPath& keyPath() const;
57     bool unique() const;
58     bool multiEntry() const;
59
60     void rollbackInfoForVersionChangeAbort();
61
62     ExceptionOr<Ref<IDBRequest>> openCursor(JSC::ExecState&, RefPtr<IDBKeyRange>&&, IDBCursorDirection);
63     ExceptionOr<Ref<IDBRequest>> openCursor(JSC::ExecState&, JSC::JSValue key, IDBCursorDirection);
64     ExceptionOr<Ref<IDBRequest>> openKeyCursor(JSC::ExecState&, RefPtr<IDBKeyRange>&&, IDBCursorDirection);
65     ExceptionOr<Ref<IDBRequest>> openKeyCursor(JSC::ExecState&, JSC::JSValue key, IDBCursorDirection);
66
67     ExceptionOr<Ref<IDBRequest>> count(JSC::ExecState&, IDBKeyRange*);
68     ExceptionOr<Ref<IDBRequest>> count(JSC::ExecState&, JSC::JSValue key);
69
70     ExceptionOr<Ref<IDBRequest>> get(JSC::ExecState&, IDBKeyRange*);
71     ExceptionOr<Ref<IDBRequest>> get(JSC::ExecState&, JSC::JSValue key);
72     ExceptionOr<Ref<IDBRequest>> getKey(JSC::ExecState&, IDBKeyRange*);
73     ExceptionOr<Ref<IDBRequest>> getKey(JSC::ExecState&, JSC::JSValue key);
74
75     ExceptionOr<Ref<IDBRequest>> getAll(JSC::ExecState&, RefPtr<IDBKeyRange>&&, Optional<uint32_t> count);
76     ExceptionOr<Ref<IDBRequest>> getAll(JSC::ExecState&, JSC::JSValue key, Optional<uint32_t> count);
77     ExceptionOr<Ref<IDBRequest>> getAllKeys(JSC::ExecState&, RefPtr<IDBKeyRange>&&, Optional<uint32_t> count);
78     ExceptionOr<Ref<IDBRequest>> getAllKeys(JSC::ExecState&, JSC::JSValue key, Optional<uint32_t> count);
79
80     const IDBIndexInfo& info() const { return m_info; }
81
82     void markAsDeleted();
83     bool isDeleted() const { return m_deleted; }
84
85     void ref();
86     void deref();
87
88     void* objectStoreAsOpaqueRoot() { return &m_objectStore; }
89
90     bool hasPendingActivity() const final;
91
92 private:
93     ExceptionOr<Ref<IDBRequest>> doCount(JSC::ExecState&, const IDBKeyRangeData&);
94     ExceptionOr<Ref<IDBRequest>> doGet(JSC::ExecState&, ExceptionOr<IDBKeyRangeData>);
95     ExceptionOr<Ref<IDBRequest>> doGetKey(JSC::ExecState&, ExceptionOr<IDBKeyRangeData>);
96     ExceptionOr<Ref<IDBRequest>> doOpenCursor(JSC::ExecState&, IDBCursorDirection, WTF::Function<ExceptionOr<RefPtr<IDBKeyRange>>()> &&);
97     ExceptionOr<Ref<IDBRequest>> doOpenKeyCursor(JSC::ExecState&, IDBCursorDirection, WTF::Function<ExceptionOr<RefPtr<IDBKeyRange>>()> &&);
98     ExceptionOr<Ref<IDBRequest>> doGetAll(JSC::ExecState&, Optional<uint32_t> count, WTF::Function<ExceptionOr<RefPtr<IDBKeyRange>>()> &&);
99     ExceptionOr<Ref<IDBRequest>> doGetAllKeys(JSC::ExecState&, Optional<uint32_t> count, WTF::Function<ExceptionOr<RefPtr<IDBKeyRange>>()> &&);
100
101     const char* activeDOMObjectName() const final;
102     bool canSuspendForDocumentSuspension() const final;
103
104     IDBIndexInfo m_info;
105     IDBIndexInfo m_originalInfo;
106
107     bool m_deleted { false };
108
109     // IDBIndex objects are always owned by their referencing IDBObjectStore.
110     // Indexes will never outlive ObjectStores so its okay to keep a raw C++ reference here.
111     IDBObjectStore& m_objectStore;
112 };
113
114 } // namespace WebCore
115
116 #endif // ENABLE(INDEXED_DATABASE)