Source/WebCore/storage/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 <wtf/PassRefPtr.h>
  33 #include <wtf/RefCounted.h>
  34 #include <wtf/RefPtr.h>
  35
  36 namespace WebCore {
  37
  38 class IDBAny;
  39 class IDBCallbacks;
  40 class IDBCursorBackendInterface;
  41 class IDBRequest;
  42 class IDBTransaction;
  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 protected:
  74     IDBCursor(PassRefPtr<IDBCursorBackendInterface>, IDBRequest*, IDBAny* source, IDBTransaction*);
  75
  76 private:
  77     RefPtr<IDBCursorBackendInterface> m_backend;
  78     RefPtr<IDBRequest> m_request;
  79     RefPtr<IDBAny> m_source;
  80     RefPtr<IDBTransaction> m_transaction;
  81 };
  82
  83 } // namespace WebCore
  84
  85 #endif
  86
  87 #endif // IDBCursor_h