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#ifndef IDBFactory_h
29#define IDBFactory_h
30
31#include "IDBOpenDBRequest.h"
32#include "ScriptWrappable.h"
33#include <wtf/PassRefPtr.h>
34#include <wtf/RefCounted.h>
35#include <wtf/RefPtr.h>
36#include <wtf/text/WTFString.h>
37
38#if ENABLE(INDEXED_DATABASE)
39
40namespace WebCore {
41
42class IDBKey;
43class IDBKeyRange;
44class IDBFactoryBackendInterface;
45class ScriptExecutionContext;
46
47typedef int ExceptionCode;
48
49class IDBFactory : public ScriptWrappable, public RefCounted<IDBFactory> {
50public:
51    static PassRefPtr<IDBFactory> create(IDBFactoryBackendInterface* factory)
52    {
53        // FIXME: While the feature is under development we'll handle a null factory backend here,
54        // returning null, so javascript can't try to use the feature.
55        // Once the feature is fully functional we should remove the null factory backend.
56        return factory ? adoptRef(new IDBFactory(factory)) : nullptr;
57    }
58    ~IDBFactory();
59
60    // FIXME: getDatabaseNames is no longer a web-facing API, and should be removed from IDBFactory.
61    // The Web Inspector currently uses this to enumerate the list of databases, but is more complicated as a result.
62    // We should provide a simpler API to the Web Inspector then remove getDatabaseNames.
63    PassRefPtr<IDBRequest> getDatabaseNames(ScriptExecutionContext*, ExceptionCode&);
64
65    PassRefPtr<IDBOpenDBRequest> open(ScriptExecutionContext*, const String& name, ExceptionCode&);
66    PassRefPtr<IDBOpenDBRequest> open(ScriptExecutionContext*, const String& name, unsigned long long version, ExceptionCode&);
67    PassRefPtr<IDBOpenDBRequest> deleteDatabase(ScriptExecutionContext*, const String& name, ExceptionCode&);
68
69    short cmp(ScriptExecutionContext*, const Deprecated::ScriptValue& first, const Deprecated::ScriptValue& second, ExceptionCode&);
70
71private:
72    IDBFactory(IDBFactoryBackendInterface*);
73
74    PassRefPtr<IDBOpenDBRequest> openInternal(ScriptExecutionContext*, const String& name, uint64_t version, IndexedDB::VersionNullness, ExceptionCode&);
75
76    RefPtr<IDBFactoryBackendInterface> m_backend;
77};
78
79} // namespace WebCore
80
81#endif
82
83#endif // IDBFactory_h
84