summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebKitClient.h
blob: a63ae3d79ca305265a95845b86c382afa4641649 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * 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 WebKitClient_h
#define WebKitClient_h

#include "WebCommon.h"
#include "WebLocalizedString.h"

#if defined(OS_WIN)
#include <windows.h>
#endif

namespace WebKit {
    class WebClipboard;
    class WebData;
    class WebMimeRegistry;
    class WebPluginListBuilder;
    class WebSandboxSupport;
    class WebStorageNamespace;
    class WebString;
    class WebThemeEngine;
    class WebURL;
    class WebURLLoader;
    struct WebPluginInfo;
    template <typename T> class WebVector;

    class WebKitClient {
    public:
        // Must return non-null.
        virtual WebClipboard* clipboard() = 0;

        // Must return non-null.
        virtual WebMimeRegistry* mimeRegistry() = 0;

        // May return null if sandbox support is not necessary
        virtual WebSandboxSupport* sandboxSupport() = 0;

        // May return null on some platforms.
        virtual WebThemeEngine* themeEngine() = 0;


        // DOM Storage --------------------------------------------------

        // Return a LocalStorage namespace that corresponds to the following
        // path.
        virtual WebStorageNamespace* createLocalStorageNamespace(
            const WebString& path) = 0;

        // Return a new SessionStorage namespace.
        virtual WebStorageNamespace* createSessionStorageNamespace() = 0;


        // File ----------------------------------------------------------------

        virtual bool getFileSize(const WebString& path, long long& result) = 0;


        // History -------------------------------------------------------------

        // Returns the hash for the given canonicalized URL for use in visited
        // link coloring.
        virtual unsigned long long visitedLinkHash(
            const char* canonicalURL, size_t length) = 0;

        // Returns whether the given link hash is in the user's history.  The
        // hash must have been generated by calling VisitedLinkHash().
        virtual bool isLinkVisited(unsigned long long linkHash) = 0;


        // Network -------------------------------------------------------------

        virtual void setCookies(
            const WebURL& url, const WebURL& policyURL, const WebString& cookies) = 0;
        virtual WebString cookies(const WebURL& url, const WebURL& policyURL) = 0;

        // A suggestion to prefetch IP information for the given hostname.
        virtual void prefetchHostName(const WebString&) = 0;

        // Returns a new WebURLLoader instance.
        virtual WebURLLoader* createURLLoader() = 0;


        // Plugins -------------------------------------------------------------

        // If refresh is true, then cached information should not be used to
        // satisfy this call.
        virtual void getPluginList(bool refresh, WebPluginListBuilder*) = 0;


        // Profiling -----------------------------------------------------------

        virtual void decrementStatsCounter(const char* name) = 0;
        virtual void incrementStatsCounter(const char* name) = 0;

        // An event is identified by the pair (name, id).  The extra parameter
        // specifies additional data to log with the event.
        virtual void traceEventBegin(const char* name, void* id, const char* extra) = 0;
        virtual void traceEventEnd(const char* name, void* id, const char* extra) = 0;


        // Resources -----------------------------------------------------------

        // Returns a blob of data corresponding to the named resource.
        virtual WebData loadResource(const char* name) = 0;

        // Returns a localized string resource (with an optional numeric
        // parameter value).
        virtual WebString queryLocalizedString(WebLocalizedString::Name) = 0;
        virtual WebString queryLocalizedString(WebLocalizedString::Name, int numericValue) = 0;


        // Sudden Termination --------------------------------------------------

        // Disable/Enable sudden termination.
        virtual void suddenTerminationChanged(bool enabled) = 0;


        // System --------------------------------------------------------------

        // Returns a value such as "en-US".
        virtual WebString defaultLocale() = 0;

        // Wall clock time in seconds since the epoch.
        virtual double currentTime() = 0;

        // Delayed work is driven by a shared timer.
        virtual void setSharedTimerFiredFunction(void (*func)()) = 0;
        virtual void setSharedTimerFireTime(double fireTime) = 0;
        virtual void stopSharedTimer() = 0;

        // Callable from a background WebKit thread.
        virtual void callOnMainThread(void (*func)()) = 0;

        // HTML5 DB ------------------------------------------------------------

#if defined(OS_WIN)
typedef HANDLE FileType;
#else
typedef int FileType;
#endif

        // Opens a database file
        virtual FileType databaseOpenFile(const WebString& fileName, int desiredFlags) = 0;

        // Deletes a database file and returns the error code
        virtual bool databaseDeleteFile(const WebString& fileName) = 0;

        // Returns the attributes of the given database file
        virtual long databaseGetFileAttributes(const WebString& fileName) = 0;

        // Returns the size of the given database file
        virtual long long databaseGetFileSize(const WebString& fileName) = 0;
    };

} // namespace WebKit

#endif