summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebStorageNamespace.h
blob: 1253cecc07ff9d76e74e686e9c4ed8393781970d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebStorageNamespace_h
#define WebStorageNamespace_h

#include "WebCommon.h"

namespace WebKit {
    class WebStorageArea;
    class WebString;

    // WebStorageNamespace represents a collection of StorageAreas. Typically, you'll have
    // multiple StorageNamespaces to represent the SessionStorage for each tab and a single
    // StorageNamespace to represent LocalStorage for the entire browser.
    class WebStorageNamespace {
    public:
        // Create a new WebStorageNamespace. LocalStorageNamespaces require a path to specify
        // where the SQLite databases that make LocalStorage data persistent are located.
        // If path is empty, data will not persist. You should call delete on the returned
        // object when you're finished.
        WEBKIT_API static WebStorageNamespace* createLocalStorageNamespace(const WebString& backingDirectoryPath, unsigned quota);
        WEBKIT_API static WebStorageNamespace* createSessionStorageNamespace();

        static const unsigned noQuota = UINT_MAX;

        virtual ~WebStorageNamespace() { }

        // Create a new WebStorageArea object. Two subsequent calls with the same origin
        // will return two different WebStorageArea objects that share the same backing store.
        // You should call delete on the returned object when you're finished.
        virtual WebStorageArea* createStorageArea(const WebString& origin) = 0;

        // Copy a StorageNamespace. This only makes sense in the case of SessionStorage.
        virtual WebStorageNamespace* copy() = 0;

        // Shutdown the StorageNamespace. Write all StorageArea's to disk and disallow new
        // write activity.
        virtual void close() = 0;
    };

} // namespace WebKit

#endif // WebStorageNamespace_h