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 WebIDBCallbacks_h
27#define WebIDBCallbacks_h
28
29#include "WebCommon.h"
30#include "WebVector.h"
31
32namespace WebKit {
33
34class WebData;
35class WebIDBCursor;
36class WebIDBDatabase;
37class WebIDBDatabaseError;
38class WebIDBIndex;
39class WebIDBKey;
40class WebIDBKeyPath;
41class WebString;
42struct WebIDBMetadata;
43
44class WebIDBCallbacks {
45public:
46    virtual ~WebIDBCallbacks() { }
47
48    enum DataLoss {
49        DataLossNone = 0,
50        DataLossTotal = 1
51    };
52
53    // For classes that follow the PImpl pattern, pass a const reference.
54    // For the rest, pass ownership to the callee via a pointer.
55    virtual void onError(const WebIDBDatabaseError&) { WEBKIT_ASSERT_NOT_REACHED(); }
56    virtual void onSuccess(const WebVector<WebString>&) { WEBKIT_ASSERT_NOT_REACHED(); }
57    virtual void onSuccess(WebIDBCursor*, const WebIDBKey& key, const WebIDBKey& primaryKey, const WebData&) { WEBKIT_ASSERT_NOT_REACHED(); }
58    virtual void onSuccess(WebIDBDatabase*) { WEBKIT_ASSERT_NOT_REACHED(); }
59    virtual void onSuccess(WebIDBDatabase*, const WebIDBMetadata&) { WEBKIT_ASSERT_NOT_REACHED(); }
60    virtual void onSuccess(const WebIDBKey&) { WEBKIT_ASSERT_NOT_REACHED(); }
61    virtual void onSuccess(const WebData&) { WEBKIT_ASSERT_NOT_REACHED(); }
62    virtual void onSuccess(const WebData&, const WebIDBKey&, const WebIDBKeyPath&) { WEBKIT_ASSERT_NOT_REACHED(); }
63    virtual void onSuccess(long long) { WEBKIT_ASSERT_NOT_REACHED(); }
64    virtual void onSuccess() { WEBKIT_ASSERT_NOT_REACHED(); }
65    virtual void onSuccess(const WebIDBKey& key, const WebIDBKey& primaryKey, const WebData&) { WEBKIT_ASSERT_NOT_REACHED(); }
66    // FIXME: Remove the following overload once callers are updated:
67    virtual void onBlocked() { WEBKIT_ASSERT_NOT_REACHED(); }
68    virtual void onBlocked(long long oldVersion) { WEBKIT_ASSERT_NOT_REACHED(); }
69    virtual void onUpgradeNeeded(long long oldVersion, WebIDBDatabase* database, const WebIDBMetadata& metadata)
70    {
71        onUpgradeNeeded(oldVersion, database, metadata, DataLossNone);
72    }
73    virtual void onUpgradeNeeded(long long oldVersion, WebIDBDatabase*, const WebIDBMetadata&, DataLoss dataLoss) { WEBKIT_ASSERT_NOT_REACHED(); }
74};
75
76} // namespace WebKit
77
78#endif // WebIDBCallbacks_h
79