content/browser/in_process_webkit/indexed_db_callbacks.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_IN_PROCESS_WEBKIT_INDEXED_DB_CALLBACKS_H_
   6 #define CONTENT_BROWSER_IN_PROCESS_WEBKIT_INDEXED_DB_CALLBACKS_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "content/browser/in_process_webkit/indexed_db_dispatcher_host.h"
  11 #include "googleurl/src/gurl.h"
  12 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBCallbacks.h"
  13 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBCursor.h"
  14 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBDatabase.h"
  15 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBDatabaseError.h"
  16 #include "third_party/WebKit/Source/WebKit/chromium/public/WebIDBTransaction.h"
  17 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
  18
  19 namespace content {
  20
  21 class IndexedDBCallbacksBase : public WebKit::WebIDBCallbacks {
  22  public:
  23   virtual ~IndexedDBCallbacksBase();
  24
  25   virtual void onError(const WebKit::WebIDBDatabaseError& error);
  26   virtual void onBlocked();
  27   virtual void onBlocked(long long old_version);
  28
  29  protected:
  30   IndexedDBCallbacksBase(IndexedDBDispatcherHost* dispatcher_host,
  31                          int32 ipc_thread_id,
  32                          int32 ipc_response_id);
  33   IndexedDBDispatcherHost* dispatcher_host() const {
  34     return dispatcher_host_.get();
  35   }
  36   int32 ipc_thread_id() const { return ipc_thread_id_; }
  37   int32 ipc_response_id() const { return ipc_response_id_; }
  38
  39  private:
  40   scoped_refptr<IndexedDBDispatcherHost> dispatcher_host_;
  41   int32 ipc_response_id_;
  42   int32 ipc_thread_id_;
  43
  44   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacksBase);
  45 };
  46
  47 // TODO(dgrogan): Remove this class and change the remaining specializations
  48 // into subclasses of IndexedDBCallbacksBase.
  49 template <class WebObjectType>
  50 class IndexedDBCallbacks : public IndexedDBCallbacksBase {
  51   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacks);
  52 };
  53
  54 class IndexedDBCallbacksDatabase : public IndexedDBCallbacksBase {
  55  public:
  56   IndexedDBCallbacksDatabase(
  57       IndexedDBDispatcherHost* dispatcher_host,
  58       int32 ipc_thread_id,
  59       int32 ipc_response_id,
  60       const GURL& origin_url);
  61
  62   virtual void onSuccess(WebKit::WebIDBDatabase* idb_object);
  63   virtual void onUpgradeNeeded(
  64       long long old_version,
  65       WebKit::WebIDBTransaction* transaction,
  66       WebKit::WebIDBDatabase* database);
  67
  68  private:
  69   GURL origin_url_;
  70   int32 ipc_database_id_;
  71   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacksDatabase);
  72 };
  73
  74 // WebIDBCursor uses:
  75 // * onSuccess(WebIDBCursor*, WebIDBKey, WebIDBKey, SerializedScriptValue)
  76 //   when an openCursor()/openKeyCursor() call has succeeded,
  77 // * onSuccess(WebIDBKey, WebIDBKey, SerializedScriptValue)
  78 //   when an advance()/continue() call has succeeded, or
  79 // * onSuccess(SerializedScriptValue::nullValue())
  80 //   to indicate it does not contain any data, i.e., there is no key within
  81 //   the key range, or it has reached the end.
  82 template <>
  83 class IndexedDBCallbacks<WebKit::WebIDBCursor>
  84     : public IndexedDBCallbacksBase {
  85  public:
  86   IndexedDBCallbacks(
  87       IndexedDBDispatcherHost* dispatcher_host,
  88       int32 ipc_thread_id,
  89       int32 ipc_response_id,
  90       int32 ipc_cursor_id)
  91       : IndexedDBCallbacksBase(dispatcher_host, ipc_thread_id, ipc_response_id),
  92         ipc_cursor_id_(ipc_cursor_id) { }
  93
  94   virtual void onSuccess(WebKit::WebIDBCursor* idb_object,
  95                          const WebKit::WebIDBKey& key,
  96                          const WebKit::WebIDBKey& primaryKey,
  97                          const WebKit::WebSerializedScriptValue& value);
  98   virtual void onSuccess(const WebKit::WebIDBKey& key,
  99                          const WebKit::WebIDBKey& primaryKey,
 100                          const WebKit::WebSerializedScriptValue& value);
 101   virtual void onSuccess(const WebKit::WebSerializedScriptValue& value);
 102   virtual void onSuccessWithPrefetch(
 103       const WebKit::WebVector<WebKit::WebIDBKey>& keys,
 104       const WebKit::WebVector<WebKit::WebIDBKey>& primaryKeys,
 105       const WebKit::WebVector<WebKit::WebSerializedScriptValue>& values);
 106
 107  private:
 108   // The id of the cursor this callback concerns, or -1 if the cursor
 109   // does not exist yet.
 110   int32 ipc_cursor_id_;
 111
 112   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacks);
 113 };
 114
 115 // WebIDBKey is implemented in WebKit as opposed to being an interface Chromium
 116 // implements.  Thus we pass a const ___& version and thus we need this
 117 // specialization.
 118 template <>
 119 class IndexedDBCallbacks<WebKit::WebIDBKey>
 120     : public IndexedDBCallbacksBase {
 121  public:
 122   IndexedDBCallbacks(IndexedDBDispatcherHost* dispatcher_host,
 123                      int32 ipc_thread_id,
 124                      int32 ipc_response_id)
 125       : IndexedDBCallbacksBase(dispatcher_host, ipc_thread_id,
 126                                ipc_response_id) { }
 127
 128   virtual void onSuccess(const WebKit::WebIDBKey& value);
 129
 130  private:
 131   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacks);
 132 };
 133
 134 // WebDOMStringList is implemented in WebKit as opposed to being an
 135 // interface Chromium implements.  Thus we pass a const ___& version and thus
 136 // we need this specialization.
 137 template <>
 138 class IndexedDBCallbacks<WebKit::WebDOMStringList>
 139     : public IndexedDBCallbacksBase {
 140  public:
 141   IndexedDBCallbacks(
 142       IndexedDBDispatcherHost* dispatcher_host,
 143       int32 ipc_thread_id,
 144       int32 ipc_response_id)
 145       : IndexedDBCallbacksBase(dispatcher_host, ipc_thread_id,
 146                                ipc_response_id) { }
 147
 148   virtual void onSuccess(const WebKit::WebDOMStringList& value);
 149
 150  private:
 151   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacks);
 152 };
 153
 154 // WebSerializedScriptValue is implemented in WebKit as opposed to being an
 155 // interface Chromium implements.  Thus we pass a const ___& version and thus
 156 // we need this specialization.
 157 template <>
 158 class IndexedDBCallbacks<WebKit::WebSerializedScriptValue>
 159     : public IndexedDBCallbacksBase {
 160  public:
 161   IndexedDBCallbacks(IndexedDBDispatcherHost* dispatcher_host,
 162                      int32 ipc_thread_id,
 163                      int32 ipc_response_id)
 164       : IndexedDBCallbacksBase(dispatcher_host, ipc_thread_id,
 165                                ipc_response_id) { }
 166
 167   virtual void onSuccess(const WebKit::WebSerializedScriptValue& value);
 168   virtual void onSuccess(const WebKit::WebSerializedScriptValue& value,
 169                          const WebKit::WebIDBKey& key,
 170                          const WebKit::WebIDBKeyPath& keyPath);
 171   virtual void onSuccess(long long value);
 172   virtual void onSuccess();
 173
 174  private:
 175   DISALLOW_IMPLICIT_CONSTRUCTORS(IndexedDBCallbacks);
 176 };
 177
 178 }  // namespace content
 179
 180 #endif  // CONTENT_BROWSER_IN_PROCESS_WEBKIT_INDEXED_DB_CALLBACKS_H_