44ffc1eda6d5f983d320fa562f54b51a6565b74d
[WebKit-https.git] / WebKit / gtk / webkit / webkitprivate.h
1 /*
2  * Copyright (C) 2007, 2008, 2009 Holger Hans Peter Freyther
3  * Copyright (C) 2008 Jan Michael C. Alonzo
4  * Copyright (C) 2008 Collabora Ltd.
5  * Copyright (C) 2010 Igalia S.L.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef webkitprivate_h
24 #define webkitprivate_h
25
26 /*
27  * This file knows the shared secret of WebKitWebView, WebKitWebFrame,
28  * and WebKitNetworkRequest.
29  * They are using WebCore which musn't be exposed to the outer world.
30  */
31
32 #include <webkit/webkitdefines.h>
33 #include <webkit/webkitdownload.h>
34 #include <webkit/webkithittestresult.h>
35 #include <webkit/webkitnetworkrequest.h>
36 #include <webkit/webkitwebview.h>
37 #include <webkit/webkitwebdatasource.h>
38 #include <webkit/webkitwebframe.h>
39 #include <webkit/webkitwebpolicydecision.h>
40 #include <webkit/webkitwebnavigationaction.h>
41 #include <webkit/webkitwebresource.h>
42 #include <webkit/webkitwebsettings.h>
43 #include <webkit/webkitwebwindowfeatures.h>
44 #include <webkit/webkitwebbackforwardlist.h>
45 #include <webkit/webkitnetworkrequest.h>
46 #include <webkit/webkitsecurityorigin.h>
47
48 #include "ArchiveResource.h"
49 #include "BackForwardList.h"
50 #include "DataObjectGtk.h"
51 #include <enchant.h>
52 #include "GOwnPtr.h"
53 #include "Geolocation.h"
54 #include "HistoryItem.h"
55 #include "Settings.h"
56 #include "Page.h"
57 #include "Frame.h"
58 #include "InspectorClientGtk.h"
59 #include "FrameLoaderClient.h"
60 #include "ResourceHandle.h"
61 #include "ResourceRequest.h"
62 #include "ResourceResponse.h"
63 #include "WindowFeatures.h"
64 #include "SecurityOrigin.h"
65 #include <wtf/text/CString.h>
66
67 #include <atk/atk.h>
68 #include <glib.h>
69 #include <libsoup/soup.h>
70
71 class DownloadClient;
72
73 namespace WebKit {
74
75     class DocumentLoader;
76     class PasteboardHelperGtk;
77
78     WebKitWebView* getViewFromFrame(WebKitWebFrame*);
79
80     WebCore::Frame* core(WebKitWebFrame*);
81     WebKitWebFrame* kit(WebCore::Frame*);
82
83     WebCore::Page* core(WebKitWebView*);
84     WebKitWebView* kit(WebCore::Page*);
85
86     WebCore::HistoryItem* core(WebKitWebHistoryItem*);
87     WebKitWebHistoryItem* kit(PassRefPtr<WebCore::HistoryItem>);
88
89     WebCore::BackForwardList* core(WebKitWebBackForwardList*);
90
91     WebKitWebNavigationReason kit(WebCore::NavigationType type);
92     WebCore::NavigationType core(WebKitWebNavigationReason reason);
93
94     WebCore::ResourceRequest core(WebKitNetworkRequest* request);
95
96     WebCore::ResourceResponse core(WebKitNetworkResponse* response);
97
98     WebCore::EditingBehaviorType core(WebKitEditingBehavior type);
99
100     WebKitSecurityOrigin* kit(WebCore::SecurityOrigin*);
101     WebCore::SecurityOrigin* core(WebKitSecurityOrigin*);
102
103     WebKitHitTestResult* kit(const WebCore::HitTestResult&);
104
105     WebKit::PasteboardHelperGtk* pasteboardHelperInstance();
106 }
107
108 extern "C" {
109     void webkit_init();
110
111 #define WEBKIT_PARAM_READABLE ((GParamFlags)(G_PARAM_READABLE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB))
112 #define WEBKIT_PARAM_READWRITE ((GParamFlags)(G_PARAM_READWRITE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB))
113
114     #define WEBKIT_WEB_VIEW_GET_PRIVATE(obj)    (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebViewPrivate))
115     typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
116     struct _WebKitWebViewPrivate {
117         WebCore::Page* corePage;
118         WebKitWebSettings* webSettings;
119         WebKitWebInspector* webInspector;
120         WebKitWebWindowFeatures* webWindowFeatures;
121
122         WebKitWebFrame* mainFrame;
123         WebKitWebBackForwardList* backForwardList;
124
125         GtkMenu* currentMenu;
126         gint lastPopupXPosition;
127         gint lastPopupYPosition;
128
129         HashSet<GtkWidget*> children;
130         bool editable;
131         GtkIMContext* imContext;
132
133         gboolean transparent;
134
135         GtkAdjustment* horizontalAdjustment;
136         GtkAdjustment* verticalAdjustment;
137
138         gboolean zoomFullContent;
139         WebKitLoadStatus loadStatus;
140         char* encoding;
141         char* customEncoding;
142
143         char* iconURI;
144
145         gboolean disposing;
146         gboolean usePrimaryForPaste;
147
148         // These are hosted here because the DataSource object is
149         // created too late in the frame loading process.
150         WebKitWebResource* mainResource;
151         char* mainResourceIdentifier;
152         GHashTable* subResources;
153         char* tooltipText;
154
155         HashMap<GdkDragContext*, RefPtr<WebCore::DataObjectGtk> > draggingDataObjects;
156     };
157
158     #define WEBKIT_WEB_FRAME_GET_PRIVATE(obj)    (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_FRAME, WebKitWebFramePrivate))
159     typedef struct _WebKitWebFramePrivate WebKitWebFramePrivate;
160     struct _WebKitWebFramePrivate {
161         WebCore::Frame* coreFrame;
162         WebKitWebView* webView;
163
164         gchar* name;
165         gchar* title;
166         gchar* uri;
167         WebKitLoadStatus loadStatus;
168         WebKitSecurityOrigin* origin;
169     };
170
171 #define WEBKIT_SECURITY_ORIGIN_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_SECURITY_ORIGIN, WebKitSecurityOriginPrivate))
172     struct _WebKitSecurityOriginPrivate {
173         RefPtr<WebCore::SecurityOrigin> coreOrigin;
174         gchar* protocol;
175         gchar* host;
176         GHashTable* webDatabases;
177
178         gboolean disposed;
179     };
180
181     PassRefPtr<WebCore::Frame>
182     webkit_web_frame_init_with_web_view(WebKitWebView*, WebCore::HTMLFrameOwnerElement*);
183
184     void
185     webkit_web_frame_core_frame_gone(WebKitWebFrame*);
186
187     // WebKitWebHistoryItem private
188     WebKitWebHistoryItem*
189     webkit_web_history_item_new_with_core_item(PassRefPtr<WebCore::HistoryItem> historyItem);
190
191     WEBKIT_API G_CONST_RETURN gchar*
192     webkit_web_history_item_get_target(WebKitWebHistoryItem*);
193
194     WEBKIT_API gboolean
195     webkit_web_history_item_is_target_item(WebKitWebHistoryItem*);
196
197     WEBKIT_API GList*
198     webkit_web_history_item_get_children(WebKitWebHistoryItem*);
199     // end WebKitWebHistoryItem private
200
201     // WebKitWebResource private
202     #define WEBKIT_WEB_RESOURCE_GET_PRIVATE(obj)        (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_RESOURCE, WebKitWebResourcePrivate))
203     struct _WebKitWebResourcePrivate {
204         WebCore::ArchiveResource* resource;
205
206         gchar* uri;
207         gchar* mimeType;
208         gchar* textEncoding;
209         gchar* frameName;
210
211         GString* data;
212     };
213     WebKitWebResource*
214     webkit_web_resource_new_with_core_resource(PassRefPtr<WebCore::ArchiveResource>);
215
216     void
217     webkit_web_resource_init_with_core_resource(WebKitWebResource*, PassRefPtr<WebCore::ArchiveResource>);
218
219     // end WebKitWebResource private
220
221     void
222     webkit_web_inspector_set_inspector_client(WebKitWebInspector*, WebCore::Page*);
223
224     void
225     webkit_web_inspector_set_web_view(WebKitWebInspector *web_inspector, WebKitWebView *web_view);
226
227     void
228     webkit_web_inspector_set_inspected_uri(WebKitWebInspector* web_inspector, const gchar* inspected_uri);
229
230     WEBKIT_API void
231     webkit_web_inspector_execute_script(WebKitWebInspector* inspector, long callId, const gchar* script);
232
233
234     WebKitWebWindowFeatures*
235     webkit_web_window_features_new_from_core_features (const WebCore::WindowFeatures& features);
236
237     void
238     webkit_web_view_notify_ready (WebKitWebView* web_view);
239
240     void
241     webkit_web_view_request_download(WebKitWebView* web_view, WebKitNetworkRequest* request, const WebCore::ResourceResponse& response = WebCore::ResourceResponse(), WebCore::ResourceHandle* handle = 0);
242
243     void
244     webkit_web_view_add_resource(WebKitWebView*, const char*, WebKitWebResource*);
245
246     WebKitWebResource*
247     webkit_web_view_get_resource(WebKitWebView*, char*);
248
249     WebKitWebResource*
250     webkit_web_view_get_main_resource(WebKitWebView*);
251
252     void
253     webkit_web_view_clear_resources(WebKitWebView*);
254
255     GList*
256     webkit_web_view_get_subresources(WebKitWebView*);
257
258     void
259     webkit_web_view_set_tooltip_text(WebKitWebView*, const char*);
260
261     WebKitDownload*
262     webkit_download_new_with_handle(WebKitNetworkRequest* request, WebCore::ResourceHandle* handle, const WebCore::ResourceResponse& response);
263
264     void
265     webkit_download_set_suggested_filename(WebKitDownload* download, const gchar* suggestedFilename);
266
267     WebKitWebPolicyDecision*
268     webkit_web_policy_decision_new (WebKitWebFrame*, WebCore::FramePolicyFunction);
269
270     void
271     webkit_web_policy_decision_cancel (WebKitWebPolicyDecision* decision);
272
273     WebKitNetworkRequest*
274     webkit_network_request_new_with_core_request(const WebCore::ResourceRequest& resourceRequest);
275
276     WebKitNetworkResponse*
277     webkit_network_response_new_with_core_response(const WebCore::ResourceResponse& resourceResponse);
278
279     WebKitGeolocationPolicyDecision*
280     webkit_geolocation_policy_decision_new(WebKitWebFrame*, WebCore::Geolocation*);
281
282     // FIXME: move this to webkitnetworkrequest.h once the API is agreed upon.
283     WEBKIT_API SoupMessage*
284     webkit_network_request_get_message(WebKitNetworkRequest* request);
285
286     // FIXME: move this functionality into a 'WebKitWebDataSource' once implemented
287     WEBKIT_API gchar*
288     webkit_web_frame_get_response_mime_type(WebKitWebFrame* frame);
289
290     // FIXME: Move these to webkitwebframe.h once their API has been discussed.
291
292     WEBKIT_API GSList*
293     webkit_web_frame_get_children (WebKitWebFrame* frame);
294
295     WEBKIT_API gchar*
296     webkit_web_frame_get_inner_text (WebKitWebFrame* frame);
297
298     WEBKIT_API gchar*
299     webkit_web_frame_dump_render_tree (WebKitWebFrame* frame);
300
301     WEBKIT_API gchar*
302     webkit_web_frame_counter_value_for_element_by_id (WebKitWebFrame* frame, const gchar* id);
303
304     WEBKIT_API int
305     webkit_web_frame_page_number_for_element_by_id(WebKitWebFrame* frame, const gchar* id, float pageWidth, float pageHeight);
306
307     WEBKIT_API int
308     webkit_web_frame_number_of_pages(WebKitWebFrame* frame, float pageWidth, float pageHeight);
309
310     WEBKIT_API guint
311     webkit_web_frame_get_pending_unload_event_count(WebKitWebFrame* frame);
312
313     WEBKIT_API bool
314     webkit_web_frame_pause_animation(WebKitWebFrame* frame, const gchar* name, double time, const gchar* element);
315
316     WEBKIT_API bool
317     webkit_web_frame_pause_transition(WebKitWebFrame* frame, const gchar* name, double time, const gchar* element);
318
319     WEBKIT_API bool
320     webkit_web_frame_pause_svg_animation(WebKitWebFrame* frame, const gchar* animationId, double time, const gchar* elementId);
321
322     WEBKIT_API gchar*
323     webkit_web_frame_marker_text_for_list_item(WebKitWebFrame* frame, JSContextRef context, JSValueRef nodeObject);
324
325     WEBKIT_API unsigned int
326     webkit_web_frame_number_of_active_animations(WebKitWebFrame* frame);
327
328     WEBKIT_API void
329     webkit_web_frame_clear_main_frame_name(WebKitWebFrame* frame);
330
331     WEBKIT_API AtkObject*
332     webkit_web_frame_get_focused_accessible_element(WebKitWebFrame* frame);
333
334     WEBKIT_API gchar*
335     webkit_web_view_get_selected_text (WebKitWebView* web_view);
336
337     WEBKIT_API void
338     webkit_web_view_set_group_name(WebKitWebView* web_view, const gchar* group_name);
339
340     WEBKIT_API void
341     webkit_web_settings_add_extra_plugin_directory (WebKitWebView *web_view, const gchar* directory);
342
343     GSList*
344     webkit_web_settings_get_enchant_dicts(WebKitWebView* web_view);
345
346     bool
347     webkit_web_view_use_primary_for_paste(WebKitWebView* web_view);
348
349     GHashTable*
350     webkit_history_items(void);
351
352     WEBKIT_API void
353     webkit_gc_collect_javascript_objects();
354
355     WEBKIT_API void
356     webkit_gc_collect_javascript_objects_on_alternate_thread(gboolean waitUntilDone);
357
358     WEBKIT_API gsize
359     webkit_gc_count_javascript_objects();
360
361     WEBKIT_API void
362     webkit_application_cache_set_maximum_size(unsigned long long size);
363
364     WEBKIT_API unsigned int
365     webkit_worker_thread_count();
366     
367     WEBKIT_API void
368     webkit_white_list_access_from_origin(const gchar* sourceOrigin, const gchar* destinationProtocol, const gchar* destinationHost, bool allowDestinationSubdomains);
369     
370     WEBKIT_API void
371     webkit_reset_origin_access_white_lists();
372
373     // WebKitWebDataSource private
374     WebKitWebDataSource*
375     webkit_web_data_source_new_with_loader(PassRefPtr<WebKit::DocumentLoader>);
376
377     WEBKIT_API WebKitWebDatabase *
378     webkit_security_origin_get_web_database(WebKitSecurityOrigin* securityOrigin, const char* databaseName);
379
380     WEBKIT_API void
381     webkit_web_frame_layout(WebKitWebFrame* frame);
382 }
383
384 #endif