IndexedDB tests leak documents
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBCursor.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 "ExceptionOr.h"
31 #include "IDBCursorDirection.h"
32 #include "IDBCursorInfo.h"
33 #include "IDBValue.h"
34 #include "JSValueInWrappedObject.h"
35 #include <JavaScriptCore/Strong.h>
36 #include <wtf/Variant.h>
37 #include <wtf/WeakPtr.h>
38
39 namespace WebCore {
40
41 class IDBGetResult;
42 class IDBIndex;
43 class IDBObjectStore;
44 class IDBTransaction;
45
46 class IDBCursor : public ScriptWrappable, public RefCounted<IDBCursor> {
47 public:
48     static Ref<IDBCursor> create(IDBObjectStore&, const IDBCursorInfo&);
49     static Ref<IDBCursor> create(IDBIndex&, const IDBCursorInfo&);
50     
51     virtual ~IDBCursor();
52
53     using Source = Variant<RefPtr<IDBObjectStore>, RefPtr<IDBIndex>>;
54
55     const Source& source() const;
56     IDBCursorDirection direction() const;
57
58     IDBKey* key() { return m_key.get(); };
59     IDBKey* primaryKey() { return m_primaryKey.get(); };
60     IDBValue value() { return m_value; };
61     JSValueInWrappedObject& keyWrapper() { return m_keyWrapper; }
62     JSValueInWrappedObject& primaryKeyWrapper() { return m_primaryKeyWrapper; }
63     JSValueInWrappedObject& valueWrapper() { return m_valueWrapper; }
64
65     ExceptionOr<Ref<IDBRequest>> update(JSC::ExecState&, JSC::JSValue);
66     ExceptionOr<void> advance(unsigned);
67     ExceptionOr<void> continueFunction(JSC::ExecState&, JSC::JSValue key);
68     ExceptionOr<void> continuePrimaryKey(JSC::ExecState&, JSC::JSValue key, JSC::JSValue primaryKey);
69     ExceptionOr<Ref<IDBRequest>> deleteFunction(JSC::ExecState&);
70
71     ExceptionOr<void> continueFunction(const IDBKeyData&);
72
73     const IDBCursorInfo& info() const { return m_info; }
74
75     void setRequest(IDBRequest& request) { m_request = makeWeakPtr(&request); }
76     void clearRequest() { m_request.clear(); }
77     IDBRequest* request() { return m_request.get(); }
78
79     void setGetResult(IDBRequest&, const IDBGetResult&);
80
81     virtual bool isKeyCursorWithValue() const { return false; }
82
83 protected:
84     IDBCursor(IDBObjectStore&, const IDBCursorInfo&);
85     IDBCursor(IDBIndex&, const IDBCursorInfo&);
86
87 private:
88     bool sourcesDeleted() const;
89     IDBObjectStore& effectiveObjectStore() const;
90     IDBTransaction& transaction() const;
91
92     void uncheckedIterateCursor(const IDBKeyData&, unsigned count);
93     void uncheckedIterateCursor(const IDBKeyData&, const IDBKeyData&);
94
95     IDBCursorInfo m_info;
96     Source m_source;
97     WeakPtr<IDBRequest> m_request;
98
99     bool m_gotValue { false };
100
101     RefPtr<IDBKey> m_key;
102     RefPtr<IDBKey> m_primaryKey;
103     IDBKeyData m_keyData;
104     IDBKeyData m_primaryKeyData;
105     IDBValue m_value;
106
107     JSValueInWrappedObject m_keyWrapper;
108     JSValueInWrappedObject m_primaryKeyWrapper;
109     JSValueInWrappedObject m_valueWrapper;
110 };
111
112
113 inline const IDBCursor::Source& IDBCursor::source() const
114 {
115     return m_source;
116 }
117
118 inline IDBCursorDirection IDBCursor::direction() const
119 {
120     return m_info.cursorDirection();
121 }
122
123 } // namespace WebCore
124
125 #endif // ENABLE(INDEXED_DATABASE)