a1e4462e85967c11aafe2d954e5ea480e299ef78
[WebKit-https.git] / Source / WebCore / page / DOMWindow.h
1 /*
2  * Copyright (C) 2006, 2007, 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef DOMWindow_h
28 #define DOMWindow_h
29
30 #include "KURL.h"
31 #include "MessagePort.h"
32 #include "SecurityOrigin.h"
33
34 namespace WebCore {
35
36     class BarInfo;
37     class CSSRuleList;
38     class CSSStyleDeclaration;
39     class Console;
40     class DOMApplicationCache;
41     class DOMSelection;
42     class DOMURL;
43     class Database;
44     class DatabaseCallback;
45     class Document;
46     class Element;
47     class ErrorCallback;
48     class EventListener;
49     class FileSystemCallback;
50     class FloatRect;
51     class History;
52     class IDBFactory;
53     class Location;
54     class MediaQueryList;
55     class Navigator;
56     class Node;
57     class NotificationCenter;
58     class Performance;
59     class PostMessageTimer;
60     class ScheduledAction;
61     class Screen;
62     class SerializedScriptValue;
63     class Storage;
64     class StyleMedia;
65     class WebKitPoint;
66
67 #if ENABLE(REQUEST_ANIMATION_FRAME)
68     class RequestAnimationFrameCallback;
69 #endif
70
71     struct WindowFeatures;
72
73     typedef int ExceptionCode;
74
75     enum SetLocationLocking { LockHistoryBasedOnGestureState, LockHistoryAndBackForwardList };
76
77     class DOMWindow : public RefCounted<DOMWindow>, public EventTarget {
78     public:
79         static PassRefPtr<DOMWindow> create(Frame* frame) { return adoptRef(new DOMWindow(frame)); }
80         virtual ~DOMWindow();
81
82         virtual DOMWindow* toDOMWindow() { return this; }
83         virtual ScriptExecutionContext* scriptExecutionContext() const;
84
85         Frame* frame() const { return m_frame; }
86         void disconnectFrame();
87
88         void clear();
89
90         PassRefPtr<MediaQueryList> matchMedia(const String&);
91
92         void setSecurityOrigin(SecurityOrigin* securityOrigin) { m_securityOrigin = securityOrigin; }
93         SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
94
95         void setURL(const KURL& url) { m_url = url; }
96         KURL url() const { return m_url; }
97
98         unsigned pendingUnloadEventListeners() const;
99
100         static bool dispatchAllPendingBeforeUnloadEvents();
101         static void dispatchAllPendingUnloadEvents();
102
103         static void adjustWindowRect(const FloatRect& screen, FloatRect& window, const FloatRect& pendingChanges);
104
105         // FIXME: We can remove this function once V8 showModalDialog is changed to use DOMWindow.
106         static void parseModalDialogFeatures(const String&, HashMap<String, String>&);
107
108         bool allowPopUp(); // Call on first window, not target window.
109         static bool allowPopUp(Frame* firstFrame);
110         static bool canShowModalDialog(const Frame*);
111         static bool canShowModalDialogNow(const Frame*);
112
113         // DOM Level 0
114
115         Screen* screen() const;
116         History* history() const;
117         BarInfo* locationbar() const;
118         BarInfo* menubar() const;
119         BarInfo* personalbar() const;
120         BarInfo* scrollbars() const;
121         BarInfo* statusbar() const;
122         BarInfo* toolbar() const;
123         Navigator* navigator() const;
124         Navigator* clientInformation() const { return navigator(); }
125
126         Location* location() const;
127         void setLocation(const String& location, DOMWindow* activeWindow, DOMWindow* firstWindow,
128             SetLocationLocking = LockHistoryBasedOnGestureState);
129
130         DOMSelection* getSelection();
131
132         Element* frameElement() const;
133
134         void focus();
135         void blur();
136         void close(ScriptExecutionContext* = 0);
137         void print();
138         void stop();
139
140         PassRefPtr<DOMWindow> open(const String& urlString, const AtomicString& frameName, const String& windowFeaturesString,
141             DOMWindow* activeWindow, DOMWindow* firstWindow);
142
143         typedef void (*PrepareDialogFunction)(DOMWindow*, void* context);
144         void showModalDialog(const String& urlString, const String& dialogFeaturesString,
145             DOMWindow* activeWindow, DOMWindow* firstWindow, PrepareDialogFunction, void* functionContext);
146
147         void alert(const String& message);
148         bool confirm(const String& message);
149         String prompt(const String& message, const String& defaultValue);
150         String btoa(const String& stringToEncode, ExceptionCode&);
151         String atob(const String& encodedString, ExceptionCode&);
152
153         bool find(const String&, bool caseSensitive, bool backwards, bool wrap, bool wholeWord, bool searchInFrames, bool showDialog) const;
154
155         bool offscreenBuffering() const;
156
157         int outerHeight() const;
158         int outerWidth() const;
159         int innerHeight() const;
160         int innerWidth() const;
161         int screenX() const;
162         int screenY() const;
163         int screenLeft() const { return screenX(); }
164         int screenTop() const { return screenY(); }
165         int scrollX() const;
166         int scrollY() const;
167         int pageXOffset() const { return scrollX(); }
168         int pageYOffset() const { return scrollY(); }
169
170         bool closed() const;
171
172         unsigned length() const;
173
174         String name() const;
175         void setName(const String&);
176
177         String status() const;
178         void setStatus(const String&);
179         String defaultStatus() const;
180         void setDefaultStatus(const String&);
181
182         // This attribute is an alias of defaultStatus and is necessary for legacy uses.
183         String defaultstatus() const { return defaultStatus(); }
184         void setDefaultstatus(const String& status) { setDefaultStatus(status); }
185
186         // Self-referential attributes
187
188         DOMWindow* self() const;
189         DOMWindow* window() const { return self(); }
190         DOMWindow* frames() const { return self(); }
191
192         DOMWindow* opener() const;
193         DOMWindow* parent() const;
194         DOMWindow* top() const;
195
196         // DOM Level 2 AbstractView Interface
197
198         Document* document() const;
199
200         // CSSOM View Module
201
202         PassRefPtr<StyleMedia> styleMedia() const;
203
204         // DOM Level 2 Style Interface
205
206         PassRefPtr<CSSStyleDeclaration> getComputedStyle(Element*, const String& pseudoElt) const;
207
208         // WebKit extensions
209
210         PassRefPtr<CSSRuleList> getMatchedCSSRules(Element*, const String& pseudoElt, bool authorOnly = true) const;
211         double devicePixelRatio() const;
212
213         PassRefPtr<WebKitPoint> webkitConvertPointFromPageToNode(Node*, const WebKitPoint*) const;
214         PassRefPtr<WebKitPoint> webkitConvertPointFromNodeToPage(Node*, const WebKitPoint*) const;        
215
216         Console* console() const;
217
218         void printErrorMessage(const String&);
219         String crossDomainAccessErrorMessage(DOMWindow* activeWindow);
220
221         void pageDestroyed();
222
223         void postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray*, const String& targetOrigin, DOMWindow* source, ExceptionCode&);
224         // FIXME: remove this when we update the ObjC bindings (bug #28774).
225         void postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort*, const String& targetOrigin, DOMWindow* source, ExceptionCode&);
226         void postMessageTimerFired(PostMessageTimer*);
227
228         void scrollBy(int x, int y) const;
229         void scrollTo(int x, int y) const;
230         void scroll(int x, int y) const { scrollTo(x, y); }
231
232         void moveBy(float x, float y) const;
233         void moveTo(float x, float y) const;
234
235         void resizeBy(float x, float y) const;
236         void resizeTo(float width, float height) const;
237
238         // Timers
239         int setTimeout(PassOwnPtr<ScheduledAction>, int timeout, ExceptionCode&);
240         void clearTimeout(int timeoutId);
241         int setInterval(PassOwnPtr<ScheduledAction>, int timeout, ExceptionCode&);
242         void clearInterval(int timeoutId);
243
244         // WebKit animation extensions
245 #if ENABLE(REQUEST_ANIMATION_FRAME)
246         int webkitRequestAnimationFrame(PassRefPtr<RequestAnimationFrameCallback>, Element*);
247         void webkitCancelRequestAnimationFrame(int id);
248 #endif
249
250         // Events
251         // EventTarget API
252         virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
253         virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
254         virtual void removeAllEventListeners();
255
256         using EventTarget::dispatchEvent;
257         bool dispatchEvent(PassRefPtr<Event> prpEvent, PassRefPtr<EventTarget> prpTarget);
258         void dispatchLoadEvent();
259         void dispatchTimedEvent(PassRefPtr<Event> event, Document* target, double* startTime, double* endTime);
260
261         DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
262         DEFINE_ATTRIBUTE_EVENT_LISTENER(beforeunload);
263         DEFINE_ATTRIBUTE_EVENT_LISTENER(blur);
264         DEFINE_ATTRIBUTE_EVENT_LISTENER(canplay);
265         DEFINE_ATTRIBUTE_EVENT_LISTENER(canplaythrough);
266         DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
267         DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
268         DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
269         DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
270         DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
271         DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
272         DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
273         DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
274         DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
275         DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
276         DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
277         DEFINE_ATTRIBUTE_EVENT_LISTENER(durationchange);
278         DEFINE_ATTRIBUTE_EVENT_LISTENER(emptied);
279         DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
280         DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
281         DEFINE_ATTRIBUTE_EVENT_LISTENER(focus);
282         DEFINE_ATTRIBUTE_EVENT_LISTENER(formchange);
283         DEFINE_ATTRIBUTE_EVENT_LISTENER(forminput);
284         DEFINE_ATTRIBUTE_EVENT_LISTENER(hashchange);
285         DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
286         DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
287         DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
288         DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
289         DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
290         DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
291         DEFINE_ATTRIBUTE_EVENT_LISTENER(loadeddata);
292         DEFINE_ATTRIBUTE_EVENT_LISTENER(loadedmetadata);
293         DEFINE_ATTRIBUTE_EVENT_LISTENER(loadstart);
294         DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
295         DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
296         DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
297         DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
298         DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
299         DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
300         DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
301         DEFINE_ATTRIBUTE_EVENT_LISTENER(offline);
302         DEFINE_ATTRIBUTE_EVENT_LISTENER(online);
303         DEFINE_ATTRIBUTE_EVENT_LISTENER(pagehide);
304         DEFINE_ATTRIBUTE_EVENT_LISTENER(pageshow);
305         DEFINE_ATTRIBUTE_EVENT_LISTENER(pause);
306         DEFINE_ATTRIBUTE_EVENT_LISTENER(play);
307         DEFINE_ATTRIBUTE_EVENT_LISTENER(playing);
308         DEFINE_ATTRIBUTE_EVENT_LISTENER(popstate);
309         DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
310         DEFINE_ATTRIBUTE_EVENT_LISTENER(ratechange);
311         DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
312         DEFINE_ATTRIBUTE_EVENT_LISTENER(resize);
313         DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
314         DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
315         DEFINE_ATTRIBUTE_EVENT_LISTENER(seeked);
316         DEFINE_ATTRIBUTE_EVENT_LISTENER(seeking);
317         DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
318         DEFINE_ATTRIBUTE_EVENT_LISTENER(stalled);
319         DEFINE_ATTRIBUTE_EVENT_LISTENER(storage);
320         DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
321         DEFINE_ATTRIBUTE_EVENT_LISTENER(suspend);
322         DEFINE_ATTRIBUTE_EVENT_LISTENER(timeupdate);
323         DEFINE_ATTRIBUTE_EVENT_LISTENER(unload);
324         DEFINE_ATTRIBUTE_EVENT_LISTENER(volumechange);
325         DEFINE_ATTRIBUTE_EVENT_LISTENER(waiting);
326         DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitbeginfullscreen);
327         DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitendfullscreen);
328
329         DEFINE_MAPPED_ATTRIBUTE_EVENT_LISTENER(webkitanimationstart, webkitAnimationStart);
330         DEFINE_MAPPED_ATTRIBUTE_EVENT_LISTENER(webkitanimationiteration, webkitAnimationIteration);
331         DEFINE_MAPPED_ATTRIBUTE_EVENT_LISTENER(webkitanimationend, webkitAnimationEnd);
332         DEFINE_MAPPED_ATTRIBUTE_EVENT_LISTENER(webkittransitionend, webkitTransitionEnd);
333
334         void captureEvents();
335         void releaseEvents();
336
337         void finishedLoading();
338
339         // These functions are used for GC marking. See JSDOMWindow::markChildren(MarkStack&) in JSDOMWindowCustom.cpp.
340         Screen* optionalScreen() const { return m_screen.get(); }
341         DOMSelection* optionalSelection() const { return m_selection.get(); }
342         History* optionalHistory() const { return m_history.get(); }
343         BarInfo* optionalLocationbar() const { return m_locationbar.get(); }
344         BarInfo* optionalMenubar() const { return m_menubar.get(); }
345         BarInfo* optionalPersonalbar() const { return m_personalbar.get(); }
346         BarInfo* optionalScrollbars() const { return m_scrollbars.get(); }
347         BarInfo* optionalStatusbar() const { return m_statusbar.get(); }
348         BarInfo* optionalToolbar() const { return m_toolbar.get(); }
349         Console* optionalConsole() const { return m_console.get(); }
350         Navigator* optionalNavigator() const { return m_navigator.get(); }
351         Location* optionalLocation() const { return m_location.get(); }
352         StyleMedia* optionalMedia() const { return m_media.get(); }
353
354         using RefCounted<DOMWindow>::ref;
355         using RefCounted<DOMWindow>::deref;
356
357 #if ENABLE(BLOB)
358         DOMURL* webkitURL() const;
359 #endif
360
361 #if ENABLE(DATABASE)
362         // HTML 5 client-side database
363         PassRefPtr<Database> openDatabase(const String& name, const String& version, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback> creationCallback, ExceptionCode&);
364 #endif
365
366 #if ENABLE(DEVICE_ORIENTATION)
367         DEFINE_ATTRIBUTE_EVENT_LISTENER(devicemotion);
368         DEFINE_ATTRIBUTE_EVENT_LISTENER(deviceorientation);
369 #endif
370
371 #if ENABLE(DOM_STORAGE)
372         // HTML 5 key/value storage
373         Storage* sessionStorage(ExceptionCode&) const;
374         Storage* localStorage(ExceptionCode&) const;
375         Storage* optionalSessionStorage() const { return m_sessionStorage.get(); }
376         Storage* optionalLocalStorage() const { return m_localStorage.get(); }
377 #endif
378
379 #if ENABLE(FILE_SYSTEM)
380         // They are placed here and in all capital letters so they can be checked against the constants in the
381         // IDL at compile time.
382         enum FileSystemType {
383             TEMPORARY,
384             PERSISTENT,
385         };
386         void requestFileSystem(int type, long long size, PassRefPtr<FileSystemCallback>, PassRefPtr<ErrorCallback>);
387 #endif
388
389 #if ENABLE(INDEXED_DATABASE)
390         IDBFactory* webkitIndexedDB() const;
391 #endif
392
393 #if ENABLE(NOTIFICATIONS)
394         NotificationCenter* webkitNotifications() const;
395 #endif
396
397 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
398         DOMApplicationCache* applicationCache() const;
399         DOMApplicationCache* optionalApplicationCache() const { return m_applicationCache.get(); }
400 #endif
401
402 #if ENABLE(ORIENTATION_EVENTS)
403         // This is the interface orientation in degrees. Some examples are:
404         //  0 is straight up; -90 is when the device is rotated 90 clockwise;
405         //  90 is when rotated counter clockwise.
406         int orientation() const;
407
408         DEFINE_ATTRIBUTE_EVENT_LISTENER(orientationchange);
409 #endif
410
411 #if ENABLE(TOUCH_EVENTS)
412         DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
413         DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
414         DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
415         DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
416 #endif
417
418 #if ENABLE(WEB_TIMING)
419         Performance* performance() const;
420         Performance* optionalPerformance() const { return m_performance.get(); }
421 #endif
422
423     private:
424         DOMWindow(Frame*);
425
426         virtual void refEventTarget() { ref(); }
427         virtual void derefEventTarget() { deref(); }
428         virtual EventTargetData* eventTargetData();
429         virtual EventTargetData* ensureEventTargetData();
430
431         static Frame* createWindow(const String& urlString, const AtomicString& frameName, const WindowFeatures&,
432             DOMWindow* activeWindow, Frame* firstFrame, Frame* openerFrame,
433             PrepareDialogFunction = 0, void* functionContext = 0);
434         bool isInsecureScriptAccess(DOMWindow* activeWindow, const String& urlString);
435
436         RefPtr<SecurityOrigin> m_securityOrigin;
437         KURL m_url;
438
439         bool m_shouldPrintWhenFinishedLoading;
440         Frame* m_frame;
441         mutable RefPtr<Screen> m_screen;
442         mutable RefPtr<DOMSelection> m_selection;
443         mutable RefPtr<History> m_history;
444         mutable RefPtr<BarInfo> m_locationbar;
445         mutable RefPtr<BarInfo> m_menubar;
446         mutable RefPtr<BarInfo> m_personalbar;
447         mutable RefPtr<BarInfo> m_scrollbars;
448         mutable RefPtr<BarInfo> m_statusbar;
449         mutable RefPtr<BarInfo> m_toolbar;
450         mutable RefPtr<Console> m_console;
451         mutable RefPtr<Navigator> m_navigator;
452         mutable RefPtr<Location> m_location;
453         mutable RefPtr<StyleMedia> m_media;
454
455         EventTargetData m_eventTargetData;
456
457         String m_status;
458         String m_defaultStatus;
459
460 #if ENABLE(DOM_STORAGE)
461         mutable RefPtr<Storage> m_sessionStorage;
462         mutable RefPtr<Storage> m_localStorage;
463 #endif
464
465 #if ENABLE(INDEXED_DATABASE)
466         mutable RefPtr<IDBFactory> m_idbFactory;
467 #endif
468
469 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
470         mutable RefPtr<DOMApplicationCache> m_applicationCache;
471 #endif
472
473 #if ENABLE(NOTIFICATIONS)
474         mutable RefPtr<NotificationCenter> m_notifications;
475 #endif
476
477 #if ENABLE(WEB_TIMING)
478         mutable RefPtr<Performance> m_performance;
479 #endif
480
481 #if ENABLE(BLOB)
482         mutable RefPtr<DOMURL> m_domURL;
483 #endif
484     };
485
486     inline String DOMWindow::status() const
487     {
488         return m_status;
489     }
490
491     inline String DOMWindow::defaultStatus() const
492     {
493         return m_defaultStatus;
494     } 
495
496 } // namespace WebCore
497
498 #endif // DOMWindow_h