179e828830e13858fe6906012315619dcbcec261
[WebKit-https.git] / WebKit / chromium / public / WebDatabase.h
1 /*
2  * Copyright (C) 2009 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebDatabase_h
32 #define WebDatabase_h
33
34 #include "WebCommon.h"
35 #include "WebSecurityOrigin.h"
36
37 #if WEBKIT_IMPLEMENTATION
38 namespace WebCore { class Database; }
39 namespace WTF { template <typename T> class PassRefPtr; }
40 #endif
41
42 namespace WebKit {
43
44 class WebDatabaseObserver;
45 class WebDatabasePrivate;
46 class WebString;
47
48 class WebDatabase {
49 public:
50     WebDatabase() : m_private(0) { }
51     WebDatabase(const WebDatabase& d) : m_private(0) { assign(d); }
52     ~WebDatabase() { reset(); }
53
54     WebDatabase& operator=(const WebDatabase& d)
55     {
56         assign(d);
57         return *this;
58     }
59
60     WEBKIT_API void reset();
61     WEBKIT_API void assign(const WebDatabase&);
62     bool isNull() const { return !m_private; }
63
64     WEBKIT_API WebString name() const;
65     WEBKIT_API WebString displayName() const;
66     WEBKIT_API unsigned long estimatedSize() const;
67     WEBKIT_API WebSecurityOrigin securityOrigin() const;
68
69     WEBKIT_API static void setObserver(WebDatabaseObserver*);
70     WEBKIT_API static WebDatabaseObserver* observer();
71
72     WEBKIT_API static void updateDatabaseSize(
73         const WebString& originIdentifier, const WebString& databaseName,
74         unsigned long long databaseSize, unsigned long long spaceAvailable);
75
76 #if WEBKIT_IMPLEMENTATION
77     WebDatabase(const WTF::PassRefPtr<WebCore::Database>&);
78     WebDatabase& operator=(const WTF::PassRefPtr<WebCore::Database>&);
79     operator WTF::PassRefPtr<WebCore::Database>() const;
80 #endif
81
82 private:
83     void assign(WebDatabasePrivate*);
84
85     WebDatabasePrivate* m_private;
86 };
87
88 } // namespace WebKit
89
90 #endif