IndexedDB: Attributes for a cursor "run past the end" should be undefined.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBCursor.h
1 /*
2  * Copyright (C) 2010 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF 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 <wtf/PassRefPtr.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36
37 namespace WebCore {
38
39 class IDBAny;
40 class IDBCallbacks;
41 class IDBCursorBackendInterface;
42 class IDBRequest;
43 class ScriptExecutionContext;
44 class SerializedScriptValue;
45
46 typedef int ExceptionCode;
47
48 class IDBCursor : public RefCounted<IDBCursor> {
49 public:
50     enum Direction {
51         NEXT = 0,
52         NEXT_NO_DUPLICATE = 1,
53         PREV = 2,
54         PREV_NO_DUPLICATE = 3,
55     };
56     static PassRefPtr<IDBCursor> create(PassRefPtr<IDBCursorBackendInterface>, IDBRequest*, IDBAny* source, IDBTransaction*);
57     virtual ~IDBCursor();
58
59     // FIXME: Try to modify the code generator so this is unneeded.
60     void continueFunction(ExceptionCode& ec) { continueFunction(0, ec); }
61
62     // Implement the IDL
63     unsigned short direction() const;
64     PassRefPtr<IDBKey> key() const;
65     PassRefPtr<IDBKey> primaryKey() const;
66     PassRefPtr<IDBAny> value() const;
67     IDBAny* source() const;
68
69     PassRefPtr<IDBRequest> update(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, ExceptionCode&);
70     void continueFunction(PassRefPtr<IDBKey>, ExceptionCode&);
71     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, ExceptionCode&);
72
73     void postSuccessHandlerCallback();
74     void close();
75     void setValueReady();
76
77 protected:
78     IDBCursor(PassRefPtr<IDBCursorBackendInterface>, IDBRequest*, IDBAny* source, IDBTransaction*);
79
80 private:
81     RefPtr<IDBCursorBackendInterface> m_backend;
82     RefPtr<IDBRequest> m_request;
83     RefPtr<IDBAny> m_source;
84     RefPtr<IDBTransaction> m_transaction;
85     IDBTransaction::OpenCursorNotifier m_transactionNotifier;
86     bool m_gotValue;
87     // These values are held because m_backend may advance while they
88     // are still valid for the current success handlers.
89     RefPtr<IDBKey> m_currentKey;
90     RefPtr<IDBKey> m_currentPrimaryKey;
91     RefPtr<IDBAny> m_currentValue;
92 };
93
94 } // namespace WebCore
95
96 #endif
97
98 #endif // IDBCursor_h