[GTK] Add initial WebKitWebsiteDataManager API for process configuration options
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / gtk / WebKitWebContext.h
1 /*
2  * Copyright (C) 2011 Igalia S.L.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #if !defined(__WEBKIT2_H_INSIDE__) && !defined(WEBKIT2_COMPILATION)
21 #error "Only <webkit2/webkit2.h> can be included directly."
22 #endif
23
24 #ifndef WebKitWebContext_h
25 #define WebKitWebContext_h
26
27 #include <glib-object.h>
28 #include <webkit2/WebKitCookieManager.h>
29 #include <webkit2/WebKitDefines.h>
30 #include <webkit2/WebKitDownload.h>
31 #include <webkit2/WebKitFaviconDatabase.h>
32 #include <webkit2/WebKitSecurityManager.h>
33 #include <webkit2/WebKitURISchemeRequest.h>
34 #include <webkit2/WebKitWebsiteDataManager.h>
35
36 G_BEGIN_DECLS
37
38 #define WEBKIT_TYPE_WEB_CONTEXT            (webkit_web_context_get_type())
39 #define WEBKIT_WEB_CONTEXT(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContext))
40 #define WEBKIT_WEB_CONTEXT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContextClass))
41 #define WEBKIT_IS_WEB_CONTEXT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_CONTEXT))
42 #define WEBKIT_IS_WEB_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_CONTEXT))
43 #define WEBKIT_WEB_CONTEXT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContextClass))
44
45 /**
46  * WebKitCacheModel:
47  * @WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER: Disable the cache completely, which
48  *   substantially reduces memory usage. Useful for applications that only
49  *   access a single local file, with no navigation to other pages. No remote
50  *   resources will be cached.
51  * @WEBKIT_CACHE_MODEL_DOCUMENT_BROWSER: A cache model optimized for viewing
52  *   a series of local files -- for example, a documentation viewer or a website
53  *   designer. WebKit will cache a moderate number of resources.
54  * @WEBKIT_CACHE_MODEL_WEB_BROWSER: Improve document load speed substantially
55  *   by caching a very large number of resources and previously viewed content.
56  *
57  * Enum values used for determining the #WebKitWebContext cache model.
58  */
59 typedef enum {
60     WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER,
61     WEBKIT_CACHE_MODEL_WEB_BROWSER,
62     WEBKIT_CACHE_MODEL_DOCUMENT_BROWSER
63 } WebKitCacheModel;
64
65 /**
66  * WebKitProcessModel:
67  * @WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS: Use a single process to
68  *   perform content rendering. The process is shared among all the
69  *   #WebKitWebView instances created by the application: if the process
70  *   hangs or crashes all the web views in the application will be affected.
71  *   This is the default process model, and it should suffice for most cases.
72  * @WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES: Use one process
73  *   for each #WebKitWebView, while still allowing for some of them to
74  *   share a process in certain situations. The main advantage
75  *   of this process model is that the rendering process for a web view
76  *   can crash while the rest of the views keep working normally. This
77  *   process model is indicated for applications which may use a number
78  *   of web views and the content of in each must not interfere with the
79  *   rest — for example a full-fledged web browser with support for
80  *   multiple tabs.
81  *
82  * Enum values used for determining the #WebKitWebContext process model.
83  *
84  * Since: 2.4
85  */
86 typedef enum {
87     WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS,
88     WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES,
89 } WebKitProcessModel;
90
91 /**
92  * WebKitTLSErrorsPolicy:
93  * @WEBKIT_TLS_ERRORS_POLICY_IGNORE: Ignore TLS errors.
94  * @WEBKIT_TLS_ERRORS_POLICY_FAIL: TLS errors will emit
95  *   #WebKitWebView::load-failed-with-tls-errors and, if the signal is handled,
96  *   finish the load. In case the signal is not handled,
97  *   #WebKitWebView::load-failed is emitted before the load finishes.
98  *
99  * Enum values used to denote the TLS errors policy.
100  */
101 typedef enum {
102     WEBKIT_TLS_ERRORS_POLICY_IGNORE,
103     WEBKIT_TLS_ERRORS_POLICY_FAIL
104 } WebKitTLSErrorsPolicy;
105
106 /**
107  * WebKitURISchemeRequestCallback:
108  * @request: the #WebKitURISchemeRequest
109  * @user_data: user data passed to the callback
110  *
111  * Type definition for a function that will be called back when an URI request is
112  * made for a user registered URI scheme.
113  */
114 typedef void (* WebKitURISchemeRequestCallback) (WebKitURISchemeRequest *request,
115                                                  gpointer                user_data);
116
117 typedef struct _WebKitWebContext        WebKitWebContext;
118 typedef struct _WebKitWebContextClass   WebKitWebContextClass;
119 typedef struct _WebKitWebContextPrivate WebKitWebContextPrivate;
120
121 struct _WebKitWebContext {
122     GObject parent;
123
124     /*< private >*/
125     WebKitWebContextPrivate *priv;
126 };
127
128 struct _WebKitWebContextClass {
129     GObjectClass parent;
130
131     void (* download_started)          (WebKitWebContext *context,
132                                         WebKitDownload   *download);
133     void (* initialize_web_extensions) (WebKitWebContext *context);
134
135     void (*_webkit_reserved0) (void);
136     void (*_webkit_reserved1) (void);
137     void (*_webkit_reserved2) (void);
138     void (*_webkit_reserved3) (void);
139     void (*_webkit_reserved4) (void);
140     void (*_webkit_reserved5) (void);
141 };
142
143 WEBKIT_API GType
144 webkit_web_context_get_type                         (void);
145
146 WEBKIT_API WebKitWebContext *
147 webkit_web_context_get_default                      (void);
148
149 WEBKIT_API WebKitWebContext *
150 webkit_web_context_new                              (void);
151
152 WEBKIT_API WebKitWebContext *
153 webkit_web_context_new_with_website_data_manager    (WebKitWebsiteDataManager      *manager);
154
155 WEBKIT_API WebKitWebsiteDataManager *
156 webkit_web_context_get_website_data_manager         (WebKitWebContext              *context);
157
158 WEBKIT_API void
159 webkit_web_context_set_cache_model                  (WebKitWebContext              *context,
160                                                      WebKitCacheModel               cache_model);
161 WEBKIT_API WebKitCacheModel
162 webkit_web_context_get_cache_model                  (WebKitWebContext              *context);
163
164 WEBKIT_API void
165 webkit_web_context_clear_cache                      (WebKitWebContext              *context);
166
167 WEBKIT_API WebKitDownload *
168 webkit_web_context_download_uri                     (WebKitWebContext              *context,
169                                                      const gchar                   *uri);
170
171 WEBKIT_API WebKitCookieManager *
172 webkit_web_context_get_cookie_manager               (WebKitWebContext              *context);
173
174 WEBKIT_API WebKitFaviconDatabase *
175 webkit_web_context_get_favicon_database             (WebKitWebContext              *context);
176
177 WEBKIT_API void
178 webkit_web_context_set_favicon_database_directory   (WebKitWebContext              *context,
179                                                      const gchar                   *path);
180 WEBKIT_API const gchar *
181 webkit_web_context_get_favicon_database_directory   (WebKitWebContext              *context);
182
183 WEBKIT_API WebKitSecurityManager *
184 webkit_web_context_get_security_manager             (WebKitWebContext              *context);
185
186 WEBKIT_API void
187 webkit_web_context_set_additional_plugins_directory (WebKitWebContext              *context,
188                                                      const gchar                   *directory);
189
190 WEBKIT_API void
191 webkit_web_context_get_plugins                      (WebKitWebContext              *context,
192                                                      GCancellable                  *cancellable,
193                                                      GAsyncReadyCallback            callback,
194                                                      gpointer                       user_data);
195
196 WEBKIT_API GList *
197 webkit_web_context_get_plugins_finish               (WebKitWebContext              *context,
198                                                      GAsyncResult                  *result,
199                                                      GError                       **error);
200 WEBKIT_API void
201 webkit_web_context_register_uri_scheme              (WebKitWebContext              *context,
202                                                      const gchar                   *scheme,
203                                                      WebKitURISchemeRequestCallback callback,
204                                                      gpointer                       user_data,
205                                                      GDestroyNotify                 user_data_destroy_func);
206
207 WEBKIT_API gboolean
208 webkit_web_context_get_spell_checking_enabled       (WebKitWebContext              *context);
209
210 WEBKIT_API void
211 webkit_web_context_set_spell_checking_enabled       (WebKitWebContext              *context,
212                                                      gboolean                       enabled);
213 WEBKIT_API const gchar * const *
214 webkit_web_context_get_spell_checking_languages     (WebKitWebContext              *context);
215
216 WEBKIT_API void
217 webkit_web_context_set_spell_checking_languages     (WebKitWebContext              *context,
218                                                      const gchar * const           *languages);
219
220 WEBKIT_API void
221 webkit_web_context_set_preferred_languages          (WebKitWebContext              *context,
222                                                      const gchar * const           *languages);
223
224 WEBKIT_API void
225 webkit_web_context_set_tls_errors_policy            (WebKitWebContext              *context,
226                                                      WebKitTLSErrorsPolicy          policy);
227
228 WEBKIT_API WebKitTLSErrorsPolicy
229 webkit_web_context_get_tls_errors_policy            (WebKitWebContext              *context);
230
231 WEBKIT_API void
232 webkit_web_context_set_web_extensions_directory     (WebKitWebContext              *context,
233                                                      const gchar                   *directory);
234
235 WEBKIT_API void
236 webkit_web_context_set_web_extensions_initialization_user_data
237                                                     (WebKitWebContext              *context,
238                                                      GVariant                      *user_data);
239
240 WEBKIT_API void
241 webkit_web_context_prefetch_dns                     (WebKitWebContext              *context,
242                                                      const gchar                   *hostname);
243
244 WEBKIT_DEPRECATED_FOR(webkit_web_context_new_with_website_data_manager) void
245 webkit_web_context_set_disk_cache_directory         (WebKitWebContext              *context,
246                                                      const gchar                   *directory);
247
248 WEBKIT_API void
249 webkit_web_context_allow_tls_certificate_for_host   (WebKitWebContext              *context,
250                                                      GTlsCertificate               *certificate,
251                                                      const gchar                   *host);
252
253 WEBKIT_API void
254 webkit_web_context_set_process_model                (WebKitWebContext              *context,
255                                                      WebKitProcessModel             process_model);
256
257 WEBKIT_API WebKitProcessModel
258 webkit_web_context_get_process_model                (WebKitWebContext              *context);
259
260 G_END_DECLS
261
262 #endif