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