Reviewed by Gustavo Noronha Silva.
[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 "DragActions.h"
52 #include "Frame.h"
53 #include "GOwnPtr.h"
54 #include "Geolocation.h"
55 #include "HistoryItem.h"
56 #include "InspectorClientGtk.h"
57 #include "IntPoint.h"
58 #include "FrameLoaderClient.h"
59 #include "FullscreenVideoController.h"
60 #include "Node.h"
61 #include "Page.h"
62 #include "ResourceHandle.h"
63 #include "ResourceRequest.h"
64 #include "ResourceResponse.h"
65 #include "WindowFeatures.h"
66 #include "SecurityOrigin.h"
67 #include "Settings.h"
68 #include <enchant.h>
69 #include <wtf/OwnPtr.h>
70 #include <wtf/text/CString.h>
71
72 #include <atk/atk.h>
73 #include <glib.h>
74 #include <libsoup/soup.h>
75
76 class DownloadClient;
77
78 namespace WebKit {
79
80     class DocumentLoader;
81     class PasteboardHelperGtk;
82
83     WebKitWebView* getViewFromFrame(WebKitWebFrame*);
84
85     WebCore::Frame* core(WebKitWebFrame*);
86     WebKitWebFrame* kit(WebCore::Frame*);
87
88     WebCore::Page* core(WebKitWebView*);
89     WebKitWebView* kit(WebCore::Page*);
90
91     WebCore::HistoryItem* core(WebKitWebHistoryItem*);
92     WebKitWebHistoryItem* kit(PassRefPtr<WebCore::HistoryItem>);
93
94     WebCore::BackForwardList* core(WebKitWebBackForwardList*);
95
96     WebKitWebNavigationReason kit(WebCore::NavigationType type);
97     WebCore::NavigationType core(WebKitWebNavigationReason reason);
98
99     WebCore::ResourceRequest core(WebKitNetworkRequest* request);
100
101     WebCore::ResourceResponse core(WebKitNetworkResponse* response);
102
103     WebCore::EditingBehaviorType core(WebKitEditingBehavior type);
104
105     WebKitSecurityOrigin* kit(WebCore::SecurityOrigin*);
106     WebCore::SecurityOrigin* core(WebKitSecurityOrigin*);
107
108     WebKitHitTestResult* kit(const WebCore::HitTestResult&);
109
110     PasteboardHelperGtk* pasteboardHelperInstance();
111
112     typedef struct DroppingContext_ {
113         WebKitWebView* webView;
114         GdkDragContext* gdkContext;
115         RefPtr<WebCore::DataObjectGtk> dataObject;
116         WebCore::IntPoint lastMotionPosition;
117         int pendingDataRequests;
118         bool dropHappened;
119     } DroppingContext;
120 }
121
122 extern "C" {
123     void webkit_init();
124
125 #ifdef HAVE_GSETTINGS
126     GSettings* inspectorGSettings();
127 #endif
128
129 #define WEBKIT_PARAM_READABLE ((GParamFlags)(G_PARAM_READABLE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB))
130 #define WEBKIT_PARAM_READWRITE ((GParamFlags)(G_PARAM_READWRITE|G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB))
131
132     #define WEBKIT_WEB_VIEW_GET_PRIVATE(obj)    (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebViewPrivate))
133     typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
134     struct _WebKitWebViewPrivate {
135         WebCore::Page* corePage;
136         WebKitWebSettings* webSettings;
137         WebKitWebInspector* webInspector;
138         WebKitWebWindowFeatures* webWindowFeatures;
139
140         WebKitWebFrame* mainFrame;
141         WebKitWebBackForwardList* backForwardList;
142
143         GtkMenu* currentMenu;
144         gint lastPopupXPosition;
145         gint lastPopupYPosition;
146
147         HashSet<GtkWidget*> children;
148         bool editable;
149         GtkIMContext* imContext;
150
151         gboolean transparent;
152
153         GtkAdjustment* horizontalAdjustment;
154         GtkAdjustment* verticalAdjustment;
155
156         gboolean zoomFullContent;
157         WebKitLoadStatus loadStatus;
158         char* encoding;
159         char* customEncoding;
160
161         char* iconURI;
162
163         gboolean disposing;
164         gboolean usePrimaryForPaste;
165
166         FullscreenVideoController* fullscreenVideoController;
167
168         // These are hosted here because the DataSource object is
169         // created too late in the frame loading process.
170         WebKitWebResource* mainResource;
171         char* mainResourceIdentifier;
172         GHashTable* subResources;
173         char* tooltipText;
174
175         int currentClickCount;
176         WebCore::IntPoint* previousClickPoint;
177         guint previousClickButton;
178         guint32 previousClickTime;
179
180         HashMap<GdkDragContext*, RefPtr<WebCore::DataObjectGtk> >* draggingDataObjects;
181         HashMap<GdkDragContext*, WebKit::DroppingContext*>* droppingContexts;
182     };
183
184     #define WEBKIT_WEB_FRAME_GET_PRIVATE(obj)    (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_FRAME, WebKitWebFramePrivate))
185     typedef struct _WebKitWebFramePrivate WebKitWebFramePrivate;
186     struct _WebKitWebFramePrivate {
187         WebCore::Frame* coreFrame;
188         WebKitWebView* webView;
189
190         gchar* name;
191         gchar* title;
192         gchar* uri;
193         WebKitLoadStatus loadStatus;
194         WebKitSecurityOrigin* origin;
195     };
196
197 #define WEBKIT_SECURITY_ORIGIN_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_SECURITY_ORIGIN, WebKitSecurityOriginPrivate))
198     struct _WebKitSecurityOriginPrivate {
199         RefPtr<WebCore::SecurityOrigin> coreOrigin;
200         gchar* protocol;
201         gchar* host;
202         GHashTable* webDatabases;
203
204         gboolean disposed;
205     };
206
207     void
208     webkit_web_frame_core_frame_gone(WebKitWebFrame*);
209
210     // WebKitWebHistoryItem private
211     WebKitWebHistoryItem*
212     webkit_web_history_item_new_with_core_item(PassRefPtr<WebCore::HistoryItem> historyItem);
213
214     WEBKIT_API G_CONST_RETURN gchar*
215     webkit_web_history_item_get_target(WebKitWebHistoryItem*);
216
217     WEBKIT_API gboolean
218     webkit_web_history_item_is_target_item(WebKitWebHistoryItem*);
219
220     WEBKIT_API GList*
221     webkit_web_history_item_get_children(WebKitWebHistoryItem*);
222     // end WebKitWebHistoryItem private
223
224     // WebKitWebResource private
225     #define WEBKIT_WEB_RESOURCE_GET_PRIVATE(obj)        (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_RESOURCE, WebKitWebResourcePrivate))
226     struct _WebKitWebResourcePrivate {
227         WebCore::ArchiveResource* resource;
228
229         gchar* uri;
230         gchar* mimeType;
231         gchar* textEncoding;
232         gchar* frameName;
233
234         GString* data;
235     };
236     WebKitWebResource*
237     webkit_web_resource_new_with_core_resource(PassRefPtr<WebCore::ArchiveResource>);
238
239     void
240     webkit_web_resource_init_with_core_resource(WebKitWebResource*, PassRefPtr<WebCore::ArchiveResource>);
241
242     // end WebKitWebResource private
243
244     void
245     webkit_web_inspector_set_inspector_client(WebKitWebInspector*, WebCore::Page*);
246
247     void
248     webkit_web_inspector_set_web_view(WebKitWebInspector *web_inspector, WebKitWebView *web_view);
249
250     void
251     webkit_web_inspector_set_inspected_uri(WebKitWebInspector* web_inspector, const gchar* inspected_uri);
252
253     WEBKIT_API void
254     webkit_web_inspector_execute_script(WebKitWebInspector* inspector, long callId, const gchar* script);
255
256
257     WebKitWebWindowFeatures*
258     webkit_web_window_features_new_from_core_features (const WebCore::WindowFeatures& features);
259
260     void
261     webkit_web_view_notify_ready (WebKitWebView* web_view);
262
263     void
264     webkit_web_view_request_download(WebKitWebView* web_view, WebKitNetworkRequest* request, const WebCore::ResourceResponse& response = WebCore::ResourceResponse(), WebCore::ResourceHandle* handle = 0);
265
266     void
267     webkit_web_view_add_resource(WebKitWebView*, const char*, WebKitWebResource*);
268
269     WebKitWebResource*
270     webkit_web_view_get_resource(WebKitWebView*, char*);
271
272     WebKitWebResource*
273     webkit_web_view_get_main_resource(WebKitWebView*);
274
275     void
276     webkit_web_view_clear_resources(WebKitWebView*);
277
278     GList*
279     webkit_web_view_get_subresources(WebKitWebView*);
280
281     void
282     webkit_web_view_set_tooltip_text(WebKitWebView*, const char*);
283
284     WEBKIT_API void
285     webkit_web_view_execute_core_command_by_name(WebKitWebView* webView, const gchar* name, const gchar* value);
286
287     WEBKIT_API gboolean
288     webkit_web_view_is_command_enabled(WebKitWebView* webView, const gchar* name);
289
290     WebKitDownload*
291     webkit_download_new_with_handle(WebKitNetworkRequest* request, WebCore::ResourceHandle* handle, const WebCore::ResourceResponse& response);
292
293     void
294     webkit_download_set_suggested_filename(WebKitDownload* download, const gchar* suggestedFilename);
295
296     WebKitWebPolicyDecision*
297     webkit_web_policy_decision_new (WebKitWebFrame*, WebCore::FramePolicyFunction);
298
299     void
300     webkit_web_policy_decision_cancel (WebKitWebPolicyDecision* decision);
301
302     WebKitNetworkRequest*
303     webkit_network_request_new_with_core_request(const WebCore::ResourceRequest& resourceRequest);
304
305     WebKitNetworkResponse*
306     webkit_network_response_new_with_core_response(const WebCore::ResourceResponse& resourceResponse);
307
308     WebKitGeolocationPolicyDecision*
309     webkit_geolocation_policy_decision_new(WebKitWebFrame*, WebCore::Geolocation*);
310
311     // FIXME: move this to webkitnetworkrequest.h once the API is agreed upon.
312     WEBKIT_API SoupMessage*
313     webkit_network_request_get_message(WebKitNetworkRequest* request);
314
315     // FIXME: move this functionality into a 'WebKitWebDataSource' once implemented
316     WEBKIT_API gchar*
317     webkit_web_frame_get_response_mime_type(WebKitWebFrame* frame);
318
319     // FIXME: Move these to webkitwebframe.h once their API has been discussed.
320
321     WEBKIT_API GSList*
322     webkit_web_frame_get_children (WebKitWebFrame* frame);
323
324     WEBKIT_API gchar*
325     webkit_web_frame_get_inner_text (WebKitWebFrame* frame);
326
327     WEBKIT_API gchar*
328     webkit_web_frame_dump_render_tree (WebKitWebFrame* frame);
329
330     WEBKIT_API gchar*
331     webkit_web_frame_counter_value_for_element_by_id (WebKitWebFrame* frame, const gchar* id);
332
333     WEBKIT_API int
334     webkit_web_frame_page_number_for_element_by_id(WebKitWebFrame* frame, const gchar* id, float pageWidth, float pageHeight);
335
336     WEBKIT_API int
337     webkit_web_frame_number_of_pages(WebKitWebFrame* frame, float pageWidth, float pageHeight);
338
339     WEBKIT_API guint
340     webkit_web_frame_get_pending_unload_event_count(WebKitWebFrame* frame);
341
342     WEBKIT_API bool
343     webkit_web_frame_pause_animation(WebKitWebFrame* frame, const gchar* name, double time, const gchar* element);
344
345     WEBKIT_API bool
346     webkit_web_frame_pause_transition(WebKitWebFrame* frame, const gchar* name, double time, const gchar* element);
347
348     WEBKIT_API bool
349     webkit_web_frame_pause_svg_animation(WebKitWebFrame* frame, const gchar* animationId, double time, const gchar* elementId);
350
351     WEBKIT_API gchar*
352     webkit_web_frame_marker_text_for_list_item(WebKitWebFrame* frame, JSContextRef context, JSValueRef nodeObject);
353
354     WEBKIT_API unsigned int
355     webkit_web_frame_number_of_active_animations(WebKitWebFrame* frame);
356
357     WEBKIT_API void
358     webkit_web_frame_suspend_animations(WebKitWebFrame* frame);
359
360     WEBKIT_API void
361     webkit_web_frame_resume_animations(WebKitWebFrame* frame);
362
363     WEBKIT_API void
364     webkit_web_frame_clear_main_frame_name(WebKitWebFrame* frame);
365
366     WEBKIT_API AtkObject*
367     webkit_web_frame_get_focused_accessible_element(WebKitWebFrame* frame);
368
369     WEBKIT_API gchar*
370     webkit_web_view_get_selected_text (WebKitWebView* web_view);
371
372     WEBKIT_API void
373     webkit_web_view_set_group_name(WebKitWebView* web_view, const gchar* group_name);
374
375     WEBKIT_API void
376     webkit_web_settings_add_extra_plugin_directory (WebKitWebView *web_view, const gchar* directory);
377
378     GSList*
379     webkit_web_settings_get_enchant_dicts(WebKitWebView* web_view);
380
381     bool
382     webkit_web_view_use_primary_for_paste(WebKitWebView* web_view);
383
384     GHashTable*
385     webkit_history_items(void);
386
387     WEBKIT_API void
388     webkit_gc_collect_javascript_objects();
389
390     WEBKIT_API void
391     webkit_gc_collect_javascript_objects_on_alternate_thread(gboolean waitUntilDone);
392
393     WEBKIT_API gsize
394     webkit_gc_count_javascript_objects();
395
396     WEBKIT_API void
397     webkit_application_cache_set_maximum_size(unsigned long long size);
398
399     WEBKIT_API unsigned int
400     webkit_worker_thread_count();
401     
402     WEBKIT_API void
403     webkit_white_list_access_from_origin(const gchar* sourceOrigin, const gchar* destinationProtocol, const gchar* destinationHost, bool allowDestinationSubdomains);
404     
405     WEBKIT_API void
406     webkit_reset_origin_access_white_lists();
407
408     // WebKitWebDataSource private
409     WebKitWebDataSource*
410     webkit_web_data_source_new_with_loader(PassRefPtr<WebKit::DocumentLoader>);
411
412     WEBKIT_API WebKitWebDatabase *
413     webkit_security_origin_get_web_database(WebKitSecurityOrigin* securityOrigin, const char* databaseName);
414
415     WEBKIT_API void
416     webkit_web_frame_layout(WebKitWebFrame* frame);
417
418     void webkitWebViewEnterFullscreen(WebKitWebView* webView, WebCore::Node* node);
419     void webkitWebViewExitFullscreen(WebKitWebView* webView);
420 }
421
422 #endif