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 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef IDBCallbacks_h
30#define IDBCallbacks_h
31
32#include "IDBDatabaseError.h"
33#include "IDBKey.h"
34#include "IDBKeyPath.h"
35#include "SharedBuffer.h"
36#include <wtf/RefCounted.h>
37
38#if ENABLE(INDEXED_DATABASE)
39
40namespace WebCore {
41class DOMStringList;
42class IDBCursorBackend;
43class IDBDatabaseBackend;
44
45struct IDBDatabaseMetadata;
46
47class IDBCallbacks : public RefCounted<IDBCallbacks> {
48public:
49    virtual ~IDBCallbacks() { }
50
51    virtual void onError(PassRefPtr<IDBDatabaseError>) = 0;
52    // From IDBFactory.webkitGetDatabaseNames()
53    virtual void onSuccess(PassRefPtr<DOMStringList>) = 0;
54    // From IDBObjectStore/IDBIndex.openCursor(), IDBIndex.openKeyCursor()
55    virtual void onSuccess(PassRefPtr<IDBCursorBackend>) = 0;
56    // From IDBObjectStore.add()/put(), IDBIndex.getKey()
57    virtual void onSuccess(PassRefPtr<IDBKey>) = 0;
58    // From IDBObjectStore/IDBIndex.get()/count(), and various methods that yield null/undefined.
59    virtual void onSuccess(PassRefPtr<SharedBuffer>) = 0;
60    // From IDBObjectStore/IDBIndex.get() (with key injection)
61    virtual void onSuccess(PassRefPtr<SharedBuffer>, PassRefPtr<IDBKey>, const IDBKeyPath&) = 0;
62    // From IDBObjectStore/IDBIndex.count()
63    virtual void onSuccess(int64_t value) = 0;
64
65    // From IDBFactor.deleteDatabase(), IDBObjectStore/IDBIndex.get(), IDBObjectStore.delete(), IDBObjectStore.clear()
66    virtual void onSuccess() = 0;
67
68    // From IDBCursor.advance()/continue()
69    virtual void onSuccess(PassRefPtr<IDBKey>, PassRefPtr<IDBKey> primaryKey, PassRefPtr<SharedBuffer>) = 0;
70
71    // From IDBFactory.open()/deleteDatabase()
72    virtual void onBlocked(uint64_t /* existingVersion */) { ASSERT_NOT_REACHED(); }
73    // From IDBFactory.open()
74    virtual void onUpgradeNeeded(uint64_t /* oldVersion */, PassRefPtr<IDBDatabaseBackend>, const IDBDatabaseMetadata&) { ASSERT_NOT_REACHED(); }
75    virtual void onSuccess(PassRefPtr<IDBDatabaseBackend>, const IDBDatabaseMetadata&) { ASSERT_NOT_REACHED(); }
76};
77
78} // namespace WebCore
79
80#endif
81
82#endif // IDBCallbacks_h
83