Home | History | Annotate | Download | only in public 
      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 WebIDBCursor_h
     27 #define WebIDBCursor_h
     28 
     29 #include "WebCommon.h"
     30 #include "WebExceptionCode.h"
     31 #include "WebIDBCallbacks.h"
     32 #include "WebIDBKey.h"
     33 #include "WebSerializedScriptValue.h"
     34 #include "WebString.h"
     35 
     36 namespace WebKit {
     37 
     38 // See comment in WebIDBFactory for a high level overview these classes.
     39 class WebIDBCursor {
     40 public:
     41     virtual ~WebIDBCursor() { }
     42 
     43     virtual unsigned short direction() const
     44     {
     45         WEBKIT_ASSERT_NOT_REACHED();
     46         return 0;
     47     }
     48     virtual WebIDBKey key() const
     49     {
     50         WEBKIT_ASSERT_NOT_REACHED();
     51         return WebIDBKey::createInvalid();
     52     }
     53     virtual WebIDBKey primaryKey() const
     54     {
     55         WEBKIT_ASSERT_NOT_REACHED();
     56         return WebIDBKey::createInvalid();
     57     }
     58     // FIXME: Remove the following 2 methods and uncomment third after roll.
     59     virtual WebSerializedScriptValue value() const
     60     {
     61         WebSerializedScriptValue serializedScriptValue;
     62         WebIDBKey key;
     63         value(serializedScriptValue, key);
     64         return serializedScriptValue;
     65     }
     66     virtual void value(WebSerializedScriptValue& serializedScriptValue, WebIDBKey& key) const
     67     {
     68         serializedScriptValue = value();
     69     }
     70     // virtual WebSerializedScriptValue value() const
     71     // {
     72     //     WEBKIT_ASSERT_NOT_REACHED();
     73     //     return WebSerializedScriptValue();
     74     // }
     75 
     76     virtual void update(const WebSerializedScriptValue&, WebIDBCallbacks*, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     77     virtual void continueFunction(const WebIDBKey&, WebIDBCallbacks*, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     78     // FIXME: Remove after WK roll.
     79     virtual void remove(WebIDBCallbacks* callbacks, WebExceptionCode& ec) { deleteFunction(callbacks, ec); }
     80     virtual void deleteFunction(WebIDBCallbacks* callbacks, WebExceptionCode& ec) { remove(callbacks, ec); }
     81 
     82 protected:
     83     WebIDBCursor() { }
     84 };
     85 
     86 } // namespace WebKit
     87 
     88 #endif // WebIDBCursor_h
     89