[CallWith=ScriptState] should pass ExecState to the implementation by reference
[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 #ifndef IDBCursor_h
27 #define IDBCursor_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBKey.h"
32 #include "IDBTransaction.h"
33 #include "IndexedDB.h"
34 #include "ScriptWrappable.h"
35 #include <bindings/ScriptValue.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/RefPtr.h>
39
40 namespace WebCore {
41
42 class DOMRequestState;
43 class IDBAny;
44 class IDBCallbacks;
45 class IDBRequest;
46 class ScriptExecutionContext;
47
48 typedef int ExceptionCode;
49
50 class IDBCursor : public ScriptWrappable, public RefCounted<IDBCursor> {
51 public:
52     static const AtomicString& directionNext();
53     static const AtomicString& directionNextUnique();
54     static const AtomicString& directionPrev();
55     static const AtomicString& directionPrevUnique();
56
57     static IndexedDB::CursorDirection stringToDirection(const String& modeString, ExceptionCode&);
58     static const AtomicString& directionToString(IndexedDB::CursorDirection mode);
59
60     virtual ~IDBCursor() { }
61
62     // Implement the IDL
63     virtual const String& direction() const = 0;
64     virtual const Deprecated::ScriptValue& key() const = 0;
65     virtual const Deprecated::ScriptValue& primaryKey() const = 0;
66     virtual const Deprecated::ScriptValue& value() const = 0;
67     virtual IDBAny* source() const = 0;
68
69     virtual PassRefPtr<IDBRequest> update(JSC::ExecState&, Deprecated::ScriptValue&, ExceptionCode&) = 0;
70     virtual void advance(unsigned long, ExceptionCode&) = 0;
71     // FIXME: Try to modify the code generator so this overload is unneeded.
72     virtual void continueFunction(ScriptExecutionContext*, ExceptionCode&) = 0;
73     virtual void continueFunction(ScriptExecutionContext*, const Deprecated::ScriptValue& key, ExceptionCode&) = 0;
74     virtual PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, ExceptionCode&) = 0;
75
76 protected:
77     IDBCursor();
78
79     virtual bool isKeyCursor() const { return true; }
80 };
81
82 } // namespace WebCore
83
84 #endif
85
86 #endif // IDBCursor_h