Make IDBCursor::m_request a WeakPtr
[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 <JavaScriptCore/Strong.h>
34 #include <wtf/Variant.h>
35 #include <wtf/WeakPtr.h>
36
37 namespace WebCore {
38
39 class IDBGetResult;
40 class IDBIndex;
41 class IDBObjectStore;
42 class IDBTransaction;
43
44 class IDBCursor : public ScriptWrappable, public RefCounted<IDBCursor> {
45 public:
46     static Ref<IDBCursor> create(IDBObjectStore&, const IDBCursorInfo&);
47     static Ref<IDBCursor> create(IDBIndex&, const IDBCursorInfo&);
48     
49     virtual ~IDBCursor();
50
51     using Source = Variant<RefPtr<IDBObjectStore>, RefPtr<IDBIndex>>;
52
53     const Source& source() const;
54     IDBCursorDirection direction() const;
55     JSC::JSValue key() const;
56     JSC::JSValue primaryKey() const;
57     JSC::JSValue value() const;
58
59     ExceptionOr<Ref<IDBRequest>> update(JSC::ExecState&, JSC::JSValue);
60     ExceptionOr<void> advance(unsigned);
61     ExceptionOr<void> continueFunction(JSC::ExecState&, JSC::JSValue key);
62     ExceptionOr<void> continuePrimaryKey(JSC::ExecState&, JSC::JSValue key, JSC::JSValue primaryKey);
63     ExceptionOr<Ref<IDBRequest>> deleteFunction(JSC::ExecState&);
64
65     ExceptionOr<void> continueFunction(const IDBKeyData&);
66
67     const IDBCursorInfo& info() const { return m_info; }
68
69     void setRequest(IDBRequest& request) { m_request = makeWeakPtr(&request); }
70     void clearRequest() { m_request.clear(); }
71     IDBRequest* request() { return m_request.get(); }
72
73     void setGetResult(IDBRequest&, const IDBGetResult&);
74
75     virtual bool isKeyCursorWithValue() const { return false; }
76
77 protected:
78     IDBCursor(IDBObjectStore&, const IDBCursorInfo&);
79     IDBCursor(IDBIndex&, const IDBCursorInfo&);
80
81 private:
82     bool sourcesDeleted() const;
83     IDBObjectStore& effectiveObjectStore() const;
84     IDBTransaction& transaction() const;
85
86     void uncheckedIterateCursor(const IDBKeyData&, unsigned count);
87     void uncheckedIterateCursor(const IDBKeyData&, const IDBKeyData&);
88
89     IDBCursorInfo m_info;
90     Source m_source;
91     WeakPtr<IDBRequest> m_request;
92
93     bool m_gotValue { false };
94
95     IDBKeyData m_currentKeyData;
96     IDBKeyData m_currentPrimaryKeyData;
97
98     // FIXME: The following uses of JSC::Strong are incorrect and can lead to storage leaks
99     // due to reference cycles; we should use JSValueInWrappedObject instead.
100     JSC::Strong<JSC::Unknown> m_currentKey;
101     JSC::Strong<JSC::Unknown> m_currentPrimaryKey;
102     JSC::Strong<JSC::Unknown> m_currentValue;
103 };
104
105
106 inline const IDBCursor::Source& IDBCursor::source() const
107 {
108     return m_source;
109 }
110
111 inline IDBCursorDirection IDBCursor::direction() const
112 {
113     return m_info.cursorDirection();
114 }
115
116 inline JSC::JSValue IDBCursor::key() const
117 {
118     return m_currentKey.get();
119 }
120
121 inline JSC::JSValue IDBCursor::primaryKey() const
122 {
123     return m_currentPrimaryKey.get();
124 }
125
126 inline JSC::JSValue IDBCursor::value() const
127 {
128     return m_currentValue.get();
129 }
130
131 } // namespace WebCore
132
133 #endif // ENABLE(INDEXED_DATABASE)