8c428c29f4a539ae96eb751d5c4d267d0ea1861e
[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
35 G_BEGIN_DECLS
36
37 #define WEBKIT_TYPE_WEB_CONTEXT            (webkit_web_context_get_type())
38 #define WEBKIT_WEB_CONTEXT(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContext))
39 #define WEBKIT_WEB_CONTEXT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContextClass))
40 #define WEBKIT_IS_WEB_CONTEXT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_CONTEXT))
41 #define WEBKIT_IS_WEB_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_CONTEXT))
42 #define WEBKIT_WEB_CONTEXT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_CONTEXT, WebKitWebContextClass))
43
44 /**
45  * WebKitCacheModel:
46  * @WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER: Disable the cache completely, which
47  *   substantially reduces memory usage. Useful for applications that only
48  *   access a single local file, with no navigation to other pages. No remote
49  *   resources will be cached.
50  * @WEBKIT_CACHE_MODEL_DOCUMENT_BROWSER: A cache model optimized for viewing
51  *   a series of local files -- for example, a documentation viewer or a website
52  *   designer. WebKit will cache a moderate number of resources.
53  * @WEBKIT_CACHE_MODEL_WEB_BROWSER: Improve document load speed substantially
54  *   by caching a very large number of resources and previously viewed content.
55  *
56  * Enum values used for determining the #WebKitWebContext cache model.
57  */
58 typedef enum {
59     WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER,
60     WEBKIT_CACHE_MODEL_WEB_BROWSER,
61     WEBKIT_CACHE_MODEL_DOCUMENT_BROWSER
62 } WebKitCacheModel;
63
64 /**
65  * WebKitProcessModel:
66  * @WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS: Use a single process to
67  *   perform content rendering. The process is shared among all the
68  *   #WebKitWebView instances created by the application: if the process
69  *   hangs or crashes all the web views in the application will be affected.
70  *   This is the default process model, and it should suffice for most cases.
71  * @WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES: Use one process
72  *   for each #WebKitWebView, while still allowing for some of them to
73  *   share a process in certain situations. The main advantage
74  *   of this process model is that the rendering process for a web view
75  *   can crash while the rest of the views keep working normally. This
76  *   process model is indicated for applications which may use a number
77  *   of web views and the content of in each must not interfere with the
78  *   rest — for example a full-fledged web browser with support for
79  *   multiple tabs.
80  *
81  * Enum values used for determining the #WebKitWebContext process model.
82  *
83  * Since: 2.4
84  */
85 typedef enum {
86     WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS,
87     WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES,
88 } WebKitProcessModel;
89
90 /**
91  * WebKitTLSErrorsPolicy:
92  * @WEBKIT_TLS_ERRORS_POLICY_IGNORE: Ignore TLS errors.
93  * @WEBKIT_TLS_ERRORS_POLICY_FAIL: TLS errors will emit
94  *   #WebKitWebView::load-failed-with-tls-errors and, if the signal is handled,
95  *   finish the load. In case the signal is not handled,
96  *   #WebKitWebView::load-failed is emitted before the load finishes.
97  *
98  * Enum values used to denote the TLS errors policy.
99  */
100 typedef enum {
101     WEBKIT_TLS_ERRORS_POLICY_IGNORE,
102     WEBKIT_TLS_ERRORS_POLICY_FAIL
103 } WebKitTLSErrorsPolicy;
104
105 /**
106  * WebKitURISchemeRequestCallback:
107  * @request: the #WebKitURISchemeRequest
108  * @user_data: user data passed to the callback
109  *
110  * Type definition for a function that will be called back when an URI request is
111  * made for a user registered URI scheme.
112  */
113 typedef void (* WebKitURISchemeRequestCallback) (WebKitURISchemeRequest *request,
114                                                  gpointer                user_data);
115
116 typedef struct _WebKitWebContext        WebKitWebContext;
117 typedef struct _WebKitWebContextClass   WebKitWebContextClass;
118 typedef struct _WebKitWebContextPrivate WebKitWebContextPrivate;
119
120 struct _WebKitWebContext {
121     GObject parent;
122
123     /*< private >*/
124     WebKitWebContextPrivate *priv;
125 };
126
127 struct _WebKitWebContextClass {
128     GObjectClass parent;
129
130     void (* download_started)          (WebKitWebContext *context,
131                                         WebKitDownload   *download);
132     void (* initialize_web_extensions) (WebKitWebContext *context);
133
134     void (*_webkit_reserved0) (void);
135     void (*_webkit_reserved1) (void);
136     void (*_webkit_reserved2) (void);
137     void (*_webkit_reserved3) (void);
138     void (*_webkit_reserved4) (void);
139     void (*_webkit_reserved5) (void);
140 };
141
142 WEBKIT_API GType
143 webkit_web_context_get_type                         (void);
144
145 WEBKIT_API WebKitWebContext *
146 webkit_web_context_get_default                      (void);
147
148 WEBKIT_API WebKitWebContext *
149 webkit_web_context_new                              (void);
150
151 WEBKIT_API void
152 webkit_web_context_set_cache_model                  (WebKitWebContext              *context,
153                                                      WebKitCacheModel               cache_model);
154 WEBKIT_API WebKitCacheModel
155 webkit_web_context_get_cache_model                  (WebKitWebContext              *context);
156
157 WEBKIT_API void
158 webkit_web_context_clear_cache                      (WebKitWebContext              *context);
159
160 WEBKIT_API WebKitDownload *
161 webkit_web_context_download_uri                     (WebKitWebContext              *context,
162                                                      const gchar                   *uri);
163
164 WEBKIT_API WebKitCookieManager *
165 webkit_web_context_get_cookie_manager               (WebKitWebContext              *context);
166
167 WEBKIT_API WebKitFaviconDatabase *
168 webkit_web_context_get_favicon_database             (WebKitWebContext              *context);
169
170 WEBKIT_API void
171 webkit_web_context_set_favicon_database_directory   (WebKitWebContext              *context,
172                                                      const gchar                   *path);
173 WEBKIT_API const gchar *
174 webkit_web_context_get_favicon_database_directory   (WebKitWebContext              *context);
175
176 WEBKIT_API WebKitSecurityManager *
177 webkit_web_context_get_security_manager             (WebKitWebContext              *context);
178
179 WEBKIT_API void
180 webkit_web_context_set_additional_plugins_directory (WebKitWebContext              *context,
181                                                      const gchar                   *directory);
182
183 WEBKIT_API void
184 webkit_web_context_get_plugins                      (WebKitWebContext              *context,
185                                                      GCancellable                  *cancellable,
186                                                      GAsyncReadyCallback            callback,
187                                                      gpointer                       user_data);
188
189 WEBKIT_API GList *
190 webkit_web_context_get_plugins_finish               (WebKitWebContext              *context,
191                                                      GAsyncResult                  *result,
192                                                      GError                       **error);
193 WEBKIT_API void
194 webkit_web_context_register_uri_scheme              (WebKitWebContext              *context,
195                                                      const gchar                   *scheme,
196                                                      WebKitURISchemeRequestCallback callback,
197                                                      gpointer                       user_data,
198                                                      GDestroyNotify                 user_data_destroy_func);
199
200 WEBKIT_API gboolean
201 webkit_web_context_get_spell_checking_enabled       (WebKitWebContext              *context);
202
203 WEBKIT_API void
204 webkit_web_context_set_spell_checking_enabled       (WebKitWebContext              *context,
205                                                      gboolean                       enabled);
206 WEBKIT_API const gchar * const *
207 webkit_web_context_get_spell_checking_languages     (WebKitWebContext              *context);
208
209 WEBKIT_API void
210 webkit_web_context_set_spell_checking_languages     (WebKitWebContext              *context,
211                                                      const gchar * const           *languages);
212
213 WEBKIT_API void
214 webkit_web_context_set_preferred_languages          (WebKitWebContext              *context,
215                                                      const gchar * const           *languages);
216
217 WEBKIT_API void
218 webkit_web_context_set_tls_errors_policy            (WebKitWebContext              *context,
219                                                      WebKitTLSErrorsPolicy          policy);
220
221 WEBKIT_API WebKitTLSErrorsPolicy
222 webkit_web_context_get_tls_errors_policy            (WebKitWebContext              *context);
223
224 WEBKIT_API void
225 webkit_web_context_set_web_extensions_directory     (WebKitWebContext              *context,
226                                                      const gchar                   *directory);
227
228 WEBKIT_API void
229 webkit_web_context_set_web_extensions_initialization_user_data
230                                                     (WebKitWebContext              *context,
231                                                      GVariant                      *user_data);
232
233 WEBKIT_API void
234 webkit_web_context_prefetch_dns                     (WebKitWebContext              *context,
235                                                      const gchar                   *hostname);
236
237 WEBKIT_API void
238 webkit_web_context_set_disk_cache_directory         (WebKitWebContext              *context,
239                                                      const gchar                   *directory);
240
241 WEBKIT_API void
242 webkit_web_context_allow_tls_certificate_for_host   (WebKitWebContext              *context,
243                                                      GTlsCertificate               *certificate,
244                                                      const gchar                   *host);
245
246 WEBKIT_API void
247 webkit_web_context_set_process_model                (WebKitWebContext              *context,
248                                                      WebKitProcessModel             process_model);
249
250 WEBKIT_API WebKitProcessModel
251 webkit_web_context_get_process_model                (WebKitWebContext              *context);
252
253 G_END_DECLS
254
255 #endif