Home | History | Annotate | Download | only in storage 
      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 "ExceptionCode.h"
     32 #include "IDBKey.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 IDBTransaction;
     44 class ScriptExecutionContext;
     45 class SerializedScriptValue;
     46 
     47 class IDBCursor : public RefCounted<IDBCursor> {
     48 public:
     49     enum Direction {
     50         NEXT = 0,
     51         NEXT_NO_DUPLICATE = 1,
     52         PREV = 2,
     53         PREV_NO_DUPLICATE = 3,
     54     };
     55     static PassRefPtr<IDBCursor> create(PassRefPtr<IDBCursorBackendInterface>, IDBRequest*, IDBAny* source, IDBTransaction*);
     56     virtual ~IDBCursor();
     57 
     58     // FIXME: Try to modify the code generator so this is unneeded.
     59     void continueFunction(ExceptionCode& ec) { continueFunction(0, ec); }
     60 
     61     // Implement the IDL
     62     unsigned short direction() const;
     63     PassRefPtr<IDBKey> key() const;
     64     PassRefPtr<IDBKey> primaryKey() const;
     65     PassRefPtr<SerializedScriptValue> value() const;
     66     IDBAny* source() const;
     67 
     68     PassRefPtr<IDBRequest> update(ScriptExecutionContext*, PassRefPtr<SerializedScriptValue>, ExceptionCode&);
     69     void continueFunction(PassRefPtr<IDBKey>, ExceptionCode&);
     70     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, ExceptionCode&);
     71 
     72 protected:
     73     IDBCursor(PassRefPtr<IDBCursorBackendInterface>, IDBRequest*, IDBAny* source, IDBTransaction*);
     74 
     75 private:
     76     RefPtr<IDBCursorBackendInterface> m_backend;
     77     RefPtr<IDBRequest> m_request;
     78     RefPtr<IDBAny> m_source;
     79     RefPtr<IDBTransaction> m_transaction;
     80 };
     81 
     82 } // namespace WebCore
     83 
     84 #endif
     85 
     86 #endif // IDBCursor_h
     87