4aac16f12587983e2c7faedfe8a3645e8935bf4d
[WebKit-https.git] / Source / WebCore / dom / Document.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
7  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
9  * Copyright (C) 2011 Google Inc. All rights reserved.
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Library General Public
13  * License as published by the Free Software Foundation; either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Library General Public License for more details.
20  *
21  * You should have received a copy of the GNU Library General Public License
22  * along with this library; see the file COPYING.LIB.  If not, write to
23  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24  * Boston, MA 02110-1301, USA.
25  *
26  */
27
28 #ifndef Document_h
29 #define Document_h
30
31 #include "CheckedRadioButtons.h"
32 #include "CollectionType.h"
33 #include "Color.h"
34 #include "ContainerNode.h"
35 #include "DOMTimeStamp.h"
36 #include "DocumentEventQueue.h"
37 #include "DocumentTiming.h"
38 #include "IconURL.h"
39 #include "InspectorCounters.h"
40 #include "IntRect.h"
41 #include "LayoutTypes.h"
42 #include "PageVisibilityState.h"
43 #include "PlatformScreen.h"
44 #include "QualifiedName.h"
45 #include "ScriptExecutionContext.h"
46 #include "SecurityPolicy.h"
47 #include "StringWithDirection.h"
48 #include "Timer.h"
49 #include "TreeScope.h"
50 #include "ViewportArguments.h"
51 #include "WebKitMutationObserver.h"
52 #include <wtf/Deque.h>
53 #include <wtf/FixedArray.h>
54 #include <wtf/OwnPtr.h>
55 #include <wtf/PassOwnPtr.h>
56 #include <wtf/PassRefPtr.h>
57
58 namespace WebCore {
59
60 class AXObjectCache;
61 class Attr;
62 class CDATASection;
63 class CSSStyleDeclaration;
64 class CSSStyleSelector;
65 class CSSStyleSheet;
66 class CSSValuePool;
67 class CachedCSSStyleSheet;
68 class CachedResourceLoader;
69 class CachedScript;
70 class CanvasRenderingContext;
71 class CharacterData;
72 class Comment;
73 class DOMImplementation;
74 class DOMSelection;
75 class DOMWindow;
76 class Database;
77 class DatabaseThread;
78 class DocumentFragment;
79 class DocumentLoader;
80 class DocumentMarkerController;
81 class DocumentType;
82 class DocumentWeakReference;
83 class EditingText;
84 class Element;
85 class EntityReference;
86 class Event;
87 class EventListener;
88 class FontData;
89 class FormAssociatedElement;
90 class Frame;
91 class FrameView;
92 class HTMLCanvasElement;
93 class HTMLCollection;
94 class HTMLAllCollection;
95 class HTMLDocument;
96 class HTMLElement;
97 class HTMLFormControlElementWithState;
98 class HTMLFormElement;
99 class HTMLFrameOwnerElement;
100 class HTMLHeadElement;
101 class HTMLInputElement;
102 class HTMLMapElement;
103 class HTMLNameCollection;
104 class HitTestRequest;
105 class HitTestResult;
106 class IntPoint;
107 class DOMWrapperWorld;
108 class JSNode;
109 class MediaCanStartListener;
110 class MediaQueryList;
111 class MediaQueryMatcher;
112 class MouseEventWithHitTestResults;
113 class NodeFilter;
114 class NodeIterator;
115 class Page;
116 class PlatformMouseEvent;
117 class ProcessingInstruction;
118 class Range;
119 class RegisteredEventListener;
120 class RenderArena;
121 class RenderView;
122 class RenderFullScreen;
123 class ScriptableDocumentParser;
124 class ScriptElementData;
125 class ScriptRunner;
126 class SecurityOrigin;
127 class SerializedScriptValue;
128 class SegmentedString;
129 class Settings;
130 class StyleSheet;
131 class StyleSheetList;
132 class Text;
133 class TextResourceDecoder;
134 class DocumentParser;
135 class TreeWalker;
136 class WebKitNamedFlow;
137 class XMLHttpRequest;
138 class XPathEvaluator;
139 class XPathExpression;
140 class XPathNSResolver;
141 class XPathResult;
142
143 #if ENABLE(SVG)
144 class SVGDocumentExtensions;
145 #endif
146
147 #if ENABLE(XSLT)
148 class TransformSource;
149 #endif
150
151 #if ENABLE(DASHBOARD_SUPPORT)
152 struct DashboardRegionValue;
153 #endif
154
155 #if ENABLE(TOUCH_EVENTS)
156 class Touch;
157 class TouchList;
158 #endif
159
160 #if ENABLE(REQUEST_ANIMATION_FRAME)
161 class RequestAnimationFrameCallback;
162 class ScriptedAnimationController;
163 #endif
164
165 #if ENABLE(MICRODATA)
166 class MicroDataItemList;
167 #endif
168
169 typedef int ExceptionCode;
170
171 class FormElementKey {
172 public:
173     FormElementKey(AtomicStringImpl* = 0, AtomicStringImpl* = 0);
174     ~FormElementKey();
175     FormElementKey(const FormElementKey&);
176     FormElementKey& operator=(const FormElementKey&);
177
178     AtomicStringImpl* name() const { return m_name; }
179     AtomicStringImpl* type() const { return m_type; }
180
181     // Hash table deleted values, which are only constructed and never copied or destroyed.
182     FormElementKey(WTF::HashTableDeletedValueType) : m_name(hashTableDeletedValue()) { }
183     bool isHashTableDeletedValue() const { return m_name == hashTableDeletedValue(); }
184
185 private:
186     void ref() const;
187     void deref() const;
188
189     static AtomicStringImpl* hashTableDeletedValue() { return reinterpret_cast<AtomicStringImpl*>(-1); }
190
191     AtomicStringImpl* m_name;
192     AtomicStringImpl* m_type;
193 };
194
195 inline bool operator==(const FormElementKey& a, const FormElementKey& b)
196 {
197     return a.name() == b.name() && a.type() == b.type();
198 }
199
200 struct FormElementKeyHash {
201     static unsigned hash(const FormElementKey&);
202     static bool equal(const FormElementKey& a, const FormElementKey& b) { return a == b; }
203     static const bool safeToCompareToEmptyOrDeleted = true;
204 };
205
206 struct FormElementKeyHashTraits : WTF::GenericHashTraits<FormElementKey> {
207     static void constructDeletedValue(FormElementKey& slot) { new (NotNull, &slot) FormElementKey(WTF::HashTableDeletedValue); }
208     static bool isDeletedValue(const FormElementKey& value) { return value.isHashTableDeletedValue(); }
209 };
210
211 enum PageshowEventPersistence {
212     PageshowEventNotPersisted = 0,
213     PageshowEventPersisted = 1
214 };
215
216 enum StyleSelectorUpdateFlag { RecalcStyleImmediately, DeferRecalcStyle, RecalcStyleIfNeeded };
217
218 class Document : public ContainerNode, public TreeScope, public ScriptExecutionContext {
219 public:
220     static PassRefPtr<Document> create(Frame* frame, const KURL& url)
221     {
222         return adoptRef(new Document(frame, url, false, false));
223     }
224     static PassRefPtr<Document> createXHTML(Frame* frame, const KURL& url)
225     {
226         return adoptRef(new Document(frame, url, true, false));
227     }
228     virtual ~Document();
229
230     MediaQueryMatcher* mediaQueryMatcher();
231
232     using ContainerNode::ref;
233     using ContainerNode::deref;
234
235     // Nodes belonging to this document hold guard references -
236     // these are enough to keep the document from being destroyed, but
237     // not enough to keep it from removing its children. This allows a
238     // node that outlives its document to still have a valid document
239     // pointer without introducing reference cycles.
240     void guardRef()
241     {
242         ASSERT(!m_deletionHasBegun);
243         ++m_guardRefCount;
244     }
245
246     void guardDeref()
247     {
248         ASSERT(!m_deletionHasBegun);
249         --m_guardRefCount;
250         if (!m_guardRefCount && !refCount()) {
251 #ifndef NDEBUG
252             m_deletionHasBegun = true;
253 #endif
254             delete this;
255         }
256     }
257
258     virtual void removedLastRef();
259
260     Element* getElementById(const AtomicString& id) const;
261
262     virtual bool canContainRangeEndPoint() const { return true; }
263
264     Element* getElementByAccessKey(const String& key);
265     void invalidateAccessKeyMap();
266
267     // DOM methods & attributes for Document
268
269     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
270     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
271     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
272     DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
273     DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
274     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
275     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
276     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
277     DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
278     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
279     DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
280     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
281     DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
282     DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
283     DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
284     DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
285     DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
286     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
287     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
288     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
289     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
290     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
291     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
292     DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
293     DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
294     DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
295
296     DEFINE_ATTRIBUTE_EVENT_LISTENER(blur);
297     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
298     DEFINE_ATTRIBUTE_EVENT_LISTENER(focus);
299     DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
300     DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange);
301
302     // WebKit extensions
303     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut);
304     DEFINE_ATTRIBUTE_EVENT_LISTENER(cut);
305     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy);
306     DEFINE_ATTRIBUTE_EVENT_LISTENER(copy);
307     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste);
308     DEFINE_ATTRIBUTE_EVENT_LISTENER(paste);
309     DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
310     DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
311     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectstart);
312     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectionchange);
313 #if ENABLE(TOUCH_EVENTS)
314     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
315     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
316     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
317     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
318 #endif
319 #if ENABLE(FULLSCREEN_API)
320     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenchange);
321     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenerror);
322 #endif
323 #if ENABLE(PAGE_VISIBILITY_API)
324     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitvisibilitychange);
325 #endif
326
327     ViewportArguments viewportArguments() const { return m_viewportArguments; }
328
329     SecurityPolicy::ReferrerPolicy referrerPolicy() const { return m_referrerPolicy; }
330
331     DocumentType* doctype() const { return m_docType.get(); }
332
333     DOMImplementation* implementation();
334     
335     Element* documentElement() const
336     {
337         return m_documentElement.get();
338     }
339     
340     virtual PassRefPtr<Element> createElement(const AtomicString& tagName, ExceptionCode&);
341     PassRefPtr<DocumentFragment> createDocumentFragment();
342     PassRefPtr<Text> createTextNode(const String& data);
343     PassRefPtr<Comment> createComment(const String& data);
344     PassRefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
345     PassRefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
346     PassRefPtr<Attr> createAttribute(const String& name, ExceptionCode&);
347     PassRefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&, bool shouldIgnoreNamespaceChecks = false);
348     PassRefPtr<EntityReference> createEntityReference(const String& name, ExceptionCode&);
349     PassRefPtr<Node> importNode(Node* importedNode, ExceptionCode& ec) { return importNode(importedNode, true, ec); }
350     PassRefPtr<Node> importNode(Node* importedNode, bool deep, ExceptionCode&);
351     virtual PassRefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
352     PassRefPtr<Element> createElement(const QualifiedName&, bool createdByParser);
353
354     bool cssRegionsEnabled() const;
355     PassRefPtr<WebKitNamedFlow> webkitGetFlowByName(const String&);
356
357     /**
358      * Retrieve all nodes that intersect a rect in the window's document, until it is fully enclosed by
359      * the boundaries of a node.
360      *
361      * @param centerX x reference for the rectangle in CSS pixels
362      * @param centerY y reference for the rectangle in CSS pixels
363      * @param topPadding How much to expand the top of the rectangle
364      * @param rightPadding How much to expand the right of the rectangle
365      * @param bottomPadding How much to expand the bottom of the rectangle
366      * @param leftPadding How much to expand the left of the rectangle
367      * @param ignoreClipping whether or not to ignore the root scroll frame when retrieving the element.
368      *        If false, this method returns null for coordinates outside of the viewport.
369      */
370     PassRefPtr<NodeList> nodesFromRect(int centerX, int centerY, unsigned topPadding, unsigned rightPadding,
371                                        unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping) const;
372     Element* elementFromPoint(int x, int y) const;
373     PassRefPtr<Range> caretRangeFromPoint(int x, int y);
374
375     String readyState() const;
376
377     String defaultCharset() const;
378
379     String inputEncoding() const { return Document::encoding(); }
380     String charset() const { return Document::encoding(); }
381     String characterSet() const { return Document::encoding(); }
382
383     String encoding() const;
384
385     void setCharset(const String&);
386
387     void setContent(const String&);
388
389     String suggestedMIMEType() const;
390
391     String contentLanguage() const { return m_contentLanguage; }
392     void setContentLanguage(const String&);
393
394     String xmlEncoding() const { return m_xmlEncoding; }
395     String xmlVersion() const { return m_xmlVersion; }
396     bool xmlStandalone() const { return m_xmlStandalone; }
397
398     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
399     void setXMLVersion(const String&, ExceptionCode&);
400     void setXMLStandalone(bool, ExceptionCode&);
401
402     String documentURI() const { return m_documentURI; }
403     void setDocumentURI(const String&);
404
405     virtual KURL baseURI() const;
406
407 #if ENABLE(PAGE_VISIBILITY_API)
408     String webkitVisibilityState() const;
409     bool webkitHidden() const;
410     void dispatchVisibilityStateChangeEvent();
411 #endif
412
413     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
414
415     HTMLCollection* images();
416     HTMLCollection* embeds();
417     HTMLCollection* plugins(); // an alias for embeds() required for the JS DOM bindings.
418     HTMLCollection* applets();
419     HTMLCollection* links();
420     HTMLCollection* forms();
421     HTMLCollection* anchors();
422     HTMLCollection* objects();
423     HTMLCollection* scripts();
424     HTMLCollection* windowNamedItems(const AtomicString& name);
425     HTMLCollection* documentNamedItems(const AtomicString& name);
426
427     HTMLAllCollection* all();
428
429     // Other methods (not part of DOM)
430     bool isHTMLDocument() const { return m_isHTML; }
431     bool isXHTMLDocument() const { return m_isXHTML; }
432     virtual bool isImageDocument() const { return false; }
433 #if ENABLE(SVG)
434     virtual bool isSVGDocument() const { return false; }
435     bool hasSVGRootNode() const;
436 #else
437     static bool isSVGDocument() { return false; }
438     static bool hasSVGRootNode() { return false; }
439 #endif
440     virtual bool isPluginDocument() const { return false; }
441     virtual bool isMediaDocument() const { return false; }
442     virtual bool isFrameSet() const { return false; }
443     
444     PassRefPtr<CSSValuePool> cssValuePool() const;
445     
446     CSSStyleSelector* styleSelectorIfExists() const { return m_styleSelector.get(); }
447
448     bool isViewSource() const { return m_isViewSource; }
449     void setIsViewSource(bool);
450
451     bool sawElementsInKnownNamespaces() const { return m_sawElementsInKnownNamespaces; }
452
453     CSSStyleSelector* styleSelector()
454     { 
455         if (!m_styleSelector)
456             createStyleSelector();
457         return m_styleSelector.get();
458     }
459
460     /**
461      * Updates the pending sheet count and then calls updateActiveStylesheets.
462      */
463     void removePendingSheet();
464
465     /**
466      * This method returns true if all top-level stylesheets have loaded (including
467      * any @imports that they may be loading).
468      */
469     bool haveStylesheetsLoaded() const
470     {
471         return m_pendingStylesheets <= 0 || m_ignorePendingStylesheets;
472     }
473
474     /**
475      * Increments the number of pending sheets.  The <link> elements
476      * invoke this to add themselves to the loading list.
477      */
478     void addPendingSheet() { m_pendingStylesheets++; }
479
480     void addStyleSheetCandidateNode(Node*, bool createdByParser);
481     void removeStyleSheetCandidateNode(Node*);
482
483     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
484     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
485
486     /**
487      * Called when one or more stylesheets in the document may have been added, removed or changed.
488      *
489      * Creates a new style selector and assign it to this document. This is done by iterating through all nodes in
490      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
491      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
492      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
493      * found and is used to calculate the derived styles for all rendering objects.
494      */
495     void styleSelectorChanged(StyleSelectorUpdateFlag);
496
497     bool usesSiblingRules() const { return m_usesSiblingRules || m_usesSiblingRulesOverride; }
498     void setUsesSiblingRules(bool b) { m_usesSiblingRulesOverride = b; }
499     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
500     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
501     void setUsesFirstLetterRules(bool b) { m_usesFirstLetterRules = b; }
502     bool usesBeforeAfterRules() const { return m_usesBeforeAfterRules || m_usesBeforeAfterRulesOverride; }
503     void setUsesBeforeAfterRules(bool b) { m_usesBeforeAfterRulesOverride = b; }
504     bool usesRemUnits() const { return m_usesRemUnits; }
505     void setUsesRemUnits(bool b) { m_usesRemUnits = b; }
506     bool usesLinkRules() const { return linkColor() != visitedLinkColor() || m_usesLinkRules; }
507     void setUsesLinkRules(bool b) { m_usesLinkRules = b; }
508
509     // Machinery for saving and restoring state when you leave and then go back to a page.
510     void registerFormElementWithState(HTMLFormControlElementWithState* control) { m_formElementsWithState.add(control); }
511     void unregisterFormElementWithState(HTMLFormControlElementWithState* control) { m_formElementsWithState.remove(control); }
512     Vector<String> formElementsState() const;
513     void setStateForNewFormElements(const Vector<String>&);
514     bool hasStateForNewFormElements() const;
515     bool takeStateForFormElement(AtomicStringImpl* name, AtomicStringImpl* type, String& state);
516     typedef ListHashSet<HTMLFormControlElementWithState*, 64> FormElementListHashSet;
517     const FormElementListHashSet* formElements() const { return &m_formElementsWithState; }
518
519     void registerFormElementWithFormAttribute(FormAssociatedElement*);
520     void unregisterFormElementWithFormAttribute(FormAssociatedElement*);
521     void resetFormElementsOwner();
522
523     FrameView* view() const; // can be NULL
524     Frame* frame() const { return m_frame; } // can be NULL
525     Page* page() const; // can be NULL
526     Settings* settings() const; // can be NULL
527
528     PassRefPtr<Range> createRange();
529
530     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
531         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
532
533     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow, 
534         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
535
536     // Special support for editing
537     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
538     PassRefPtr<EditingText> createEditingTextNode(const String&);
539
540     void recalcStyle(StyleChange = NoChange);
541     bool childNeedsAndNotInStyleRecalc();
542     virtual void updateStyleIfNeeded();
543     void updateLayout();
544     void updateLayoutIgnorePendingStylesheets();
545     PassRefPtr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element*);
546     PassRefPtr<RenderStyle> styleForPage(int pageIndex);
547
548     void registerCustomFont(PassOwnPtr<FontData>);
549
550     // Returns true if page box (margin boxes and page borders) is visible.
551     bool isPageBoxVisible(int pageIndex);
552
553     // Returns the preferred page size and margins in pixels, assuming 96
554     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
555     // marginLeft must be initialized to the default values that are used if
556     // auto is specified.
557     void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
558
559     static void updateStyleForAllDocuments(); // FIXME: Try to reduce the # of calls to this function.
560     CachedResourceLoader* cachedResourceLoader() { return m_cachedResourceLoader.get(); }
561
562     virtual void attach();
563     virtual void detach();
564
565     // Override ScriptExecutionContext methods to do additional work
566     virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) OVERRIDE;
567     virtual void resumeActiveDOMObjects() OVERRIDE;
568
569     RenderArena* renderArena() { return m_renderArena.get(); }
570
571     RenderView* renderView() const;
572
573     void clearAXObjectCache();
574     AXObjectCache* axObjectCache() const;
575     bool axObjectCacheExists() const;
576     
577     // to get visually ordered hebrew and arabic pages right
578     void setVisuallyOrdered();
579     bool visuallyOrdered() const { return m_visuallyOrdered; }
580     
581     DocumentLoader* loader() const;
582
583     void open(Document* ownerDocument = 0);
584     void implicitOpen();
585
586     // close() is the DOM API document.close()
587     void close();
588     // In some situations (see the code), we ignore document.close().
589     // explicitClose() bypass these checks and actually tries to close the
590     // input stream.
591     void explicitClose();
592     // implicitClose() actually does the work of closing the input stream.
593     void implicitClose();
594
595     void cancelParsing();
596
597     void write(const SegmentedString& text, Document* ownerDocument = 0);
598     void write(const String& text, Document* ownerDocument = 0);
599     void writeln(const String& text, Document* ownerDocument = 0);
600
601     bool wellFormed() const { return m_wellFormed; }
602
603     const KURL& url() const { return m_url; }
604     void setURL(const KURL&);
605
606     // To understand how these concepts relate to one another, please see the
607     // comments surrounding their declaration.
608     const KURL& baseURL() const { return m_baseURL; }
609     void setBaseURLOverride(const KURL&);
610     const KURL& baseURLOverride() const { return m_baseURLOverride; }
611     const KURL& baseElementURL() const { return m_baseElementURL; }
612     const String& baseTarget() const { return m_baseTarget; }
613     void processBaseElement();
614
615     KURL completeURL(const String&) const;
616     KURL completeURL(const String&, const KURL& baseURLOverride) const;
617
618     virtual String userAgent(const KURL&) const;
619
620     virtual void disableEval();
621
622     CSSStyleSheet* pageUserSheet();
623     void clearPageUserSheet();
624     void updatePageUserSheet();
625
626     const Vector<RefPtr<CSSStyleSheet> >* pageGroupUserSheets() const;
627     void clearPageGroupUserSheets();
628     void updatePageGroupUserSheets();
629
630     void addUserSheet(PassRefPtr<CSSStyleSheet> userSheet);
631
632     CSSStyleSheet* elementSheet();
633     CSSStyleSheet* mappedElementSheet();
634     
635     virtual PassRefPtr<DocumentParser> createParser();
636     DocumentParser* parser() const { return m_parser.get(); }
637     ScriptableDocumentParser* scriptableDocumentParser() const;
638     
639     bool printing() const { return m_printing; }
640     void setPrinting(bool p) { m_printing = p; }
641
642     bool paginatedForScreen() const { return m_paginatedForScreen; }
643     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
644     
645     bool paginated() const { return printing() || paginatedForScreen(); }
646
647     enum CompatibilityMode { QuirksMode, LimitedQuirksMode, NoQuirksMode };
648
649     virtual void setCompatibilityModeFromDoctype() { }
650     void setCompatibilityMode(CompatibilityMode m);
651     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
652     CompatibilityMode compatibilityMode() const { return m_compatibilityMode; }
653
654     String compatMode() const;
655
656     bool inQuirksMode() const { return m_compatibilityMode == QuirksMode; }
657     bool inLimitedQuirksMode() const { return m_compatibilityMode == LimitedQuirksMode; }
658     bool inNoQuirksMode() const { return m_compatibilityMode == NoQuirksMode; }
659
660     enum ReadyState {
661         Loading,
662         Interactive,
663         Complete
664     };
665     void setReadyState(ReadyState);
666     void setParsing(bool);
667     bool parsing() const { return m_bParsing; }
668     int minimumLayoutDelay();
669
670     bool shouldScheduleLayout();
671     bool isLayoutTimerActive();
672     int elapsedTime() const;
673     
674     void setTextColor(const Color& color) { m_textColor = color; }
675     Color textColor() const { return m_textColor; }
676
677     const Color& linkColor() const { return m_linkColor; }
678     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
679     const Color& activeLinkColor() const { return m_activeLinkColor; }
680     void setLinkColor(const Color& c) { m_linkColor = c; }
681     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
682     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
683     void resetLinkColor();
684     void resetVisitedLinkColor();
685     void resetActiveLinkColor();
686     
687     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const LayoutPoint&, const PlatformMouseEvent&);
688
689     StyleSheetList* styleSheets();
690
691     /* Newly proposed CSS3 mechanism for selecting alternate
692        stylesheets using the DOM. May be subject to change as
693        spec matures. - dwh
694     */
695     String preferredStylesheetSet() const;
696     String selectedStylesheetSet() const;
697     void setSelectedStylesheetSet(const String&);
698
699     bool setFocusedNode(PassRefPtr<Node>);
700     Node* focusedNode() const { return m_focusedNode.get(); }
701
702     void getFocusableNodes(Vector<RefPtr<Node> >&);
703     
704     // The m_ignoreAutofocus flag specifies whether or not the document has been changed by the user enough 
705     // for WebCore to ignore the autofocus attribute on any form controls
706     bool ignoreAutofocus() const { return m_ignoreAutofocus; };
707     void setIgnoreAutofocus(bool shouldIgnore = true) { m_ignoreAutofocus = shouldIgnore; };
708
709     void setHoverNode(PassRefPtr<Node>);
710     Node* hoverNode() const { return m_hoverNode.get(); }
711
712     void setActiveNode(PassRefPtr<Node>);
713     Node* activeNode() const { return m_activeNode.get(); }
714
715     void focusedNodeRemoved();
716     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
717     void hoveredNodeDetached(Node*);
718     void activeChainNodeDetached(Node*);
719
720     // Updates for :target (CSS3 selector).
721     void setCSSTarget(Element*);
722     Element* cssTarget() const { return m_cssTarget; }
723     
724     void scheduleForcedStyleRecalc();
725     void scheduleStyleRecalc();
726     void unscheduleStyleRecalc();
727     bool isPendingStyleRecalc() const;
728     void styleRecalcTimerFired(Timer<Document>*);
729
730     void attachNodeIterator(NodeIterator*);
731     void detachNodeIterator(NodeIterator*);
732     void moveNodeIteratorsToNewDocument(Node*, Document*);
733
734     void attachRange(Range*);
735     void detachRange(Range*);
736
737     void updateRangesAfterChildrenChanged(ContainerNode*);
738     // nodeChildrenWillBeRemoved is used when removing all node children at once.
739     void nodeChildrenWillBeRemoved(ContainerNode*);
740     // nodeWillBeRemoved is only safe when removing one node at a time.
741     void nodeWillBeRemoved(Node*);
742
743     void textInserted(Node*, unsigned offset, unsigned length);
744     void textRemoved(Node*, unsigned offset, unsigned length);
745     void textNodesMerged(Text* oldNode, unsigned offset);
746     void textNodeSplit(Text* oldNode);
747
748     DOMWindow* defaultView() const { return domWindow(); } 
749     DOMWindow* domWindow() const;
750
751     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
752     void setWindowAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
753     EventListener* getWindowAttributeEventListener(const AtomicString& eventType);
754     void dispatchWindowEvent(PassRefPtr<Event>, PassRefPtr<EventTarget> = 0);
755     void dispatchWindowLoadEvent();
756
757     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
758
759     // keep track of what types of event listeners are registered, so we don't
760     // dispatch events unnecessarily
761     enum ListenerType {
762         DOMSUBTREEMODIFIED_LISTENER          = 0x01,
763         DOMNODEINSERTED_LISTENER             = 0x02,
764         DOMNODEREMOVED_LISTENER              = 0x04,
765         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 0x08,
766         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 0x10,
767         DOMATTRMODIFIED_LISTENER             = 0x20,
768         DOMCHARACTERDATAMODIFIED_LISTENER    = 0x40,
769         OVERFLOWCHANGED_LISTENER             = 0x80,
770         ANIMATIONEND_LISTENER                = 0x100,
771         ANIMATIONSTART_LISTENER              = 0x200,
772         ANIMATIONITERATION_LISTENER          = 0x400,
773         TRANSITIONEND_LISTENER               = 0x800,
774         BEFORELOAD_LISTENER                  = 0x1000,
775         TOUCH_LISTENER                       = 0x2000,
776         SCROLL_LISTENER                      = 0x4000,
777         REGIONLAYOUTUPDATE_LISTENER          = 0x8000
778     };
779
780     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
781     void addListenerType(ListenerType listenerType) { m_listenerTypes = m_listenerTypes | listenerType; }
782     void addListenerTypeIfNeeded(const AtomicString& eventType);
783
784 #if ENABLE(MUTATION_OBSERVERS)
785     bool hasMutationObserversOfType(WebKitMutationObserver::MutationType type) const
786     {
787         return m_mutationObserverTypes & type;
788     }
789     bool hasMutationObservers() const { return m_mutationObserverTypes; }
790     void addMutationObserverTypes(MutationObserverOptions types) { m_mutationObserverTypes |= types; }
791 #endif
792
793     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
794
795     int nodeAbsIndex(Node*);
796     Node* nodeWithAbsIndex(int absIndex);
797
798     /**
799      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
800      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
801      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
802      * specified in a HTML file.
803      *
804      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
805      * @param content The header value (value of the meta tag's "content" attribute)
806      */
807     void processHttpEquiv(const String& equiv, const String& content);
808     void processViewport(const String& features);
809     void updateViewportArguments();
810     void processReferrerPolicy(const String& policy);
811
812     // Returns the owning element in the parent document.
813     // Returns 0 if this is the top level document.
814     HTMLFrameOwnerElement* ownerElement() const;
815
816     // Used by DOM bindings; no direction known.
817     String title() const { return m_title.string(); }
818     void setTitle(const String&);
819
820     void setTitleElement(const StringWithDirection&, Element* titleElement);
821     void removeTitle(Element* titleElement);
822
823     String cookie(ExceptionCode&) const;
824     void setCookie(const String&, ExceptionCode&);
825
826     String referrer() const;
827
828     String domain() const;
829     void setDomain(const String& newDomain, ExceptionCode&);
830
831     String lastModified() const;
832
833     // The cookieURL is used to query the cookie database for this document's
834     // cookies. For example, if the cookie URL is http://example.com, we'll
835     // use the non-Secure cookies for example.com when computing
836     // document.cookie.
837     //
838     // Q: How is the cookieURL different from the document's URL?
839     // A: The two URLs are the same almost all the time.  However, if one
840     //    document inherits the security context of another document, it
841     //    inherits its cookieURL but not its URL.
842     //
843     const KURL& cookieURL() const { return m_cookieURL; }
844     void setCookieURL(const KURL& url) { m_cookieURL = url; }
845
846     // The firstPartyForCookies is used to compute whether this document
847     // appears in a "third-party" context for the purpose of third-party
848     // cookie blocking.  The document is in a third-party context if the
849     // cookieURL and the firstPartyForCookies are from different hosts.
850     //
851     // Note: Some ports (including possibly Apple's) only consider the
852     //       document in a third-party context if the cookieURL and the
853     //       firstPartyForCookies have a different registry-controlled
854     //       domain.
855     //
856     const KURL& firstPartyForCookies() const { return m_firstPartyForCookies; }
857     void setFirstPartyForCookies(const KURL& url) { m_firstPartyForCookies = url; }
858     
859     // The following implements the rule from HTML 4 for what valid names are.
860     // To get this right for all the XML cases, we probably have to improve this or move it
861     // and make it sensitive to the type of document.
862     static bool isValidName(const String&);
863
864     // The following breaks a qualified name into a prefix and a local name.
865     // It also does a validity check, and returns false if the qualified name
866     // is invalid.  It also sets ExceptionCode when name is invalid.
867     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
868
869     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
870     static bool hasValidNamespaceForElements(const QualifiedName&);
871     static bool hasValidNamespaceForAttributes(const QualifiedName&);
872
873     HTMLElement* body() const;
874     void setBody(PassRefPtr<HTMLElement>, ExceptionCode&);
875
876     HTMLHeadElement* head();
877
878     DocumentMarkerController* markers() const { return m_markers.get(); }
879
880     bool directionSetOnDocumentElement() const { return m_directionSetOnDocumentElement; }
881     bool writingModeSetOnDocumentElement() const { return m_writingModeSetOnDocumentElement; }
882     void setDirectionSetOnDocumentElement(bool b) { m_directionSetOnDocumentElement = b; }
883     void setWritingModeSetOnDocumentElement(bool b) { m_writingModeSetOnDocumentElement = b; }
884
885     bool execCommand(const String& command, bool userInterface = false, const String& value = String());
886     bool queryCommandEnabled(const String& command);
887     bool queryCommandIndeterm(const String& command);
888     bool queryCommandState(const String& command);
889     bool queryCommandSupported(const String& command);
890     String queryCommandValue(const String& command);
891
892     KURL openSearchDescriptionURL();
893
894     // designMode support
895     enum InheritedBool { off = false, on = true, inherit };    
896     void setDesignMode(InheritedBool value);
897     InheritedBool getDesignMode() const;
898     bool inDesignMode() const;
899
900     Document* parentDocument() const;
901     Document* topDocument() const;
902
903     int docID() const { return m_docID; }
904     
905     ScriptRunner* scriptRunner() { return m_scriptRunner.get(); }
906
907 #if ENABLE(XSLT)
908     void applyXSLTransform(ProcessingInstruction* pi);
909     PassRefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
910     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
911
912     void setTransformSource(PassOwnPtr<TransformSource>);
913     TransformSource* transformSource() const { return m_transformSource.get(); }
914 #endif
915
916     void incDOMTreeVersion() { m_domTreeVersion = ++s_globalTreeVersion; }
917     uint64_t domTreeVersion() const { return m_domTreeVersion; }
918
919     void setDocType(PassRefPtr<DocumentType>);
920
921     // XPathEvaluator methods
922     PassRefPtr<XPathExpression> createExpression(const String& expression,
923                                                  XPathNSResolver* resolver,
924                                                  ExceptionCode& ec);
925     PassRefPtr<XPathNSResolver> createNSResolver(Node *nodeResolver);
926     PassRefPtr<XPathResult> evaluate(const String& expression,
927                                      Node* contextNode,
928                                      XPathNSResolver* resolver,
929                                      unsigned short type,
930                                      XPathResult* result,
931                                      ExceptionCode& ec);
932
933     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
934
935     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
936     
937     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
938
939     const Vector<IconURL>& iconURLs() const;
940     void addIconURL(const String& url, const String& mimeType, const String& size, IconType);
941
942     void setUseSecureKeyboardEntryWhenActive(bool);
943     bool useSecureKeyboardEntryWhenActive() const;
944
945     void updateFocusAppearanceSoon(bool restorePreviousSelection);
946     void cancelFocusAppearanceUpdate();
947         
948     // FF method for accessing the selection added for compatibility.
949     DOMSelection* getSelection() const;
950     
951     // Extension for manipulating canvas drawing contexts for use in CSS
952     CanvasRenderingContext* getCSSCanvasContext(const String& type, const String& name, int width, int height);
953     HTMLCanvasElement* getCSSCanvasElement(const String& name);
954
955     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
956     void parseDNSPrefetchControlHeader(const String&);
957
958     virtual void postTask(PassOwnPtr<Task>); // Executes the task on context's thread asynchronously.
959
960     virtual void suspendScriptedAnimationControllerCallbacks();
961     virtual void resumeScriptedAnimationControllerCallbacks();
962     
963     void windowScreenDidChange(PlatformDisplayID);
964
965     virtual void finishedParsing();
966
967     bool inPageCache() const { return m_inPageCache; }
968     void setInPageCache(bool flag);
969
970     // Elements can register themselves for the "documentWillSuspendForPageCache()" and  
971     // "documentDidResumeFromPageCache()" callbacks
972     void registerForPageCacheSuspensionCallbacks(Element*);
973     void unregisterForPageCacheSuspensionCallbacks(Element*);
974
975     void documentWillBecomeInactive();
976     void documentWillSuspendForPageCache();
977     void documentDidResumeFromPageCache();
978
979     void registerForMediaVolumeCallbacks(Element*);
980     void unregisterForMediaVolumeCallbacks(Element*);
981     void mediaVolumeDidChange();
982
983     void registerForPrivateBrowsingStateChangedCallbacks(Element*);
984     void unregisterForPrivateBrowsingStateChangedCallbacks(Element*);
985     void privateBrowsingStateDidChange();
986
987     void setShouldCreateRenderers(bool);
988     bool shouldCreateRenderers();
989
990     void setDecoder(PassRefPtr<TextResourceDecoder>);
991     TextResourceDecoder* decoder() const { return m_decoder.get(); }
992
993     String displayStringModifiedByEncoding(const String&) const;
994     PassRefPtr<StringImpl> displayStringModifiedByEncoding(PassRefPtr<StringImpl>) const;
995     void displayBufferModifiedByEncoding(UChar* buffer, unsigned len) const;
996
997     // Quirk for the benefit of Apple's Dictionary application.
998     void setFrameElementsShouldIgnoreScrolling(bool ignore) { m_frameElementsShouldIgnoreScrolling = ignore; }
999     bool frameElementsShouldIgnoreScrolling() const { return m_frameElementsShouldIgnoreScrolling; }
1000
1001 #if ENABLE(DASHBOARD_SUPPORT)
1002     void setDashboardRegionsDirty(bool f) { m_dashboardRegionsDirty = f; }
1003     bool dashboardRegionsDirty() const { return m_dashboardRegionsDirty; }
1004     bool hasDashboardRegions () const { return m_hasDashboardRegions; }
1005     void setHasDashboardRegions(bool f) { m_hasDashboardRegions = f; }
1006     const Vector<DashboardRegionValue>& dashboardRegions() const;
1007     void setDashboardRegions(const Vector<DashboardRegionValue>&);
1008 #endif
1009
1010     virtual void removeAllEventListeners();
1011
1012     CheckedRadioButtons& checkedRadioButtons() { return m_checkedRadioButtons; }
1013     
1014 #if ENABLE(SVG)
1015     const SVGDocumentExtensions* svgExtensions();
1016     SVGDocumentExtensions* accessSVGExtensions();
1017 #endif
1018
1019     void initSecurityContext();
1020
1021     // Explicitly override the security origin for this document.
1022     // Note: It is dangerous to change the security origin of a document
1023     //       that already contains content.
1024     void setSecurityOrigin(PassRefPtr<SecurityOrigin>);
1025
1026     void updateURLForPushOrReplaceState(const KURL&);
1027     void statePopped(SerializedScriptValue*);
1028
1029     bool processingLoadEvent() const { return m_processingLoadEvent; }
1030     bool loadEventFinished() const { return m_loadEventFinished; }
1031
1032     virtual bool isContextThread() const;
1033     virtual bool isJSExecutionForbidden() const { return false; }
1034
1035     bool containsValidityStyleRules() const { return m_containsValidityStyleRules; }
1036     void setContainsValidityStyleRules() { m_containsValidityStyleRules = true; }
1037
1038     void enqueueWindowEvent(PassRefPtr<Event>);
1039     void enqueueDocumentEvent(PassRefPtr<Event>);
1040     void enqueuePageshowEvent(PageshowEventPersistence);
1041     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1042     void enqueuePopstateEvent(PassRefPtr<SerializedScriptValue> stateObject);
1043     virtual DocumentEventQueue* eventQueue() const { return m_eventQueue.get(); }
1044
1045     void addMediaCanStartListener(MediaCanStartListener*);
1046     void removeMediaCanStartListener(MediaCanStartListener*);
1047     MediaCanStartListener* takeAnyMediaCanStartListener();
1048
1049     const QualifiedName& idAttributeName() const { return m_idAttributeName; }
1050     
1051 #if ENABLE(FULLSCREEN_API)
1052     bool webkitIsFullScreen() const { return m_fullScreenElement.get(); }
1053     bool webkitFullScreenKeyboardInputAllowed() const { return m_fullScreenElement.get() && m_areKeysEnabledInFullScreen; }
1054     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1055     
1056     enum FullScreenCheckType {
1057         EnforceIFrameAllowFulScreenRequirement,
1058         ExemptIFrameAllowFulScreenRequirement,
1059     };
1060
1061     void requestFullScreenForElement(Element*, unsigned short flags, FullScreenCheckType);
1062     void webkitCancelFullScreen();
1063     
1064     void webkitWillEnterFullScreenForElement(Element*);
1065     void webkitDidEnterFullScreenForElement(Element*);
1066     void webkitWillExitFullScreenForElement(Element*);
1067     void webkitDidExitFullScreenForElement(Element*);
1068     
1069     void setFullScreenRenderer(RenderFullScreen*);
1070     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer; }
1071     void fullScreenRendererDestroyed();
1072     
1073     void setFullScreenRendererSize(const IntSize&);
1074     void setFullScreenRendererBackgroundColor(Color);
1075     
1076     void fullScreenChangeDelayTimerFired(Timer<Document>*);
1077     bool fullScreenIsAllowedForElement(Element*) const;
1078     void fullScreenElementRemoved();
1079     void removeFullScreenElementOfSubtree(Node*, bool amongChildrenOnly = false);
1080     bool isAnimatingFullScreen() const;
1081     void setAnimatingFullScreen(bool);
1082 #endif
1083
1084     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1085     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1086     void decrementLoadEventDelayCount();
1087     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1088
1089 #if ENABLE(TOUCH_EVENTS)
1090     PassRefPtr<Touch> createTouch(DOMWindow*, EventTarget*, int identifier, int pageX, int pageY, int screenX, int screenY, int radiusX, int radiusY, float rotationAngle, float force, ExceptionCode&) const;
1091     PassRefPtr<TouchList> createTouchList(ExceptionCode&) const;
1092 #endif
1093
1094     const DocumentTiming* timing() const { return &m_documentTiming; }
1095
1096 #if ENABLE(REQUEST_ANIMATION_FRAME)
1097     int webkitRequestAnimationFrame(PassRefPtr<RequestAnimationFrameCallback>, Element*);
1098     void webkitCancelAnimationFrame(int id);
1099     void serviceScriptedAnimations(DOMTimeStamp);
1100 #endif
1101
1102     virtual EventTarget* errorEventTarget();
1103     virtual void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, PassRefPtr<ScriptCallStack>);
1104
1105     void initDNSPrefetch();
1106
1107     unsigned wheelEventHandlerCount() const { return m_wheelEventHandlerCount; }
1108     void didAddWheelEventHandler();
1109     void didRemoveWheelEventHandler();
1110
1111     unsigned touchEventHandlerCount() const { return m_touchEventHandlerCount; }
1112     void didAddTouchEventHandler();
1113     void didRemoveTouchEventHandler();
1114
1115     bool visualUpdatesAllowed() const;
1116
1117 #if ENABLE(MICRODATA)
1118     PassRefPtr<NodeList> getItems(const String& typeNames);
1119     void removeCachedMicroDataItemList(MicroDataItemList*, const String&);
1120 #endif
1121     
1122     bool isInDocumentWrite() { return m_writeRecursionDepth > 0; }
1123
1124     void suspendScheduledTasks();
1125     void resumeScheduledTasks();
1126
1127 protected:
1128     Document(Frame*, const KURL&, bool isXHTML, bool isHTML);
1129
1130     void clearXMLVersion() { m_xmlVersion = String(); }
1131
1132 private:
1133     friend class IgnoreDestructiveWriteCountIncrementer;
1134
1135     void detachParser();
1136
1137     typedef void (*ArgumentsCallback)(const String& keyString, const String& valueString, Document*, void* data);
1138     void processArguments(const String& features, void* data, ArgumentsCallback);
1139
1140     virtual bool isDocument() const { return true; }
1141
1142     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
1143
1144     virtual String nodeName() const;
1145     virtual NodeType nodeType() const;
1146     virtual bool childTypeAllowed(NodeType) const;
1147     virtual PassRefPtr<Node> cloneNode(bool deep);
1148     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
1149
1150     virtual void refScriptExecutionContext() { ref(); }
1151     virtual void derefScriptExecutionContext() { deref(); }
1152
1153     virtual const KURL& virtualURL() const; // Same as url(), but needed for ScriptExecutionContext to implement it without a performance loss for direct calls.
1154     virtual KURL virtualCompleteURL(const String&) const; // Same as completeURL() for the same reason as above.
1155
1156     virtual void addMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, PassRefPtr<ScriptCallStack>);
1157
1158     virtual double minimumTimerInterval() const;
1159
1160     void updateTitle(const StringWithDirection&);
1161     void updateFocusAppearanceTimerFired(Timer<Document>*);
1162     void updateBaseURL();
1163
1164     void buildAccessKeyMap(TreeScope* root);
1165
1166     void createStyleSelector();
1167     void clearStyleSelector();
1168     void combineCSSFeatureFlags();
1169     void resetCSSFeatureFlags();
1170     
1171     bool updateActiveStylesheets(StyleSelectorUpdateFlag);
1172     void collectActiveStylesheets(Vector<RefPtr<StyleSheet> >&);
1173     bool testAddedStylesheetRequiresStyleRecalc(CSSStyleSheet*);
1174     void analyzeStylesheetChange(StyleSelectorUpdateFlag, const Vector<RefPtr<StyleSheet> >& newStylesheets, bool& requiresStyleSelectorReset, bool& requiresFullStyleRecalc);
1175
1176     void deleteCustomFonts();
1177
1178     PassRefPtr<NodeList> handleZeroPadding(const HitTestRequest&, HitTestResult&) const;
1179
1180     void loadEventDelayTimerFired(Timer<Document>*);
1181
1182     void pendingTasksTimerFired(Timer<Document>*);
1183
1184     static void didReceiveTask(void*);
1185
1186 #if ENABLE(PAGE_VISIBILITY_API)
1187     PageVisibilityState visibilityState() const;
1188 #endif
1189
1190     HTMLCollection* cachedCollection(CollectionType);
1191
1192     int m_guardRefCount;
1193
1194     OwnPtr<CSSStyleSelector> m_styleSelector;
1195     bool m_didCalculateStyleSelector;
1196     bool m_hasDirtyStyleSelector;
1197     Vector<OwnPtr<FontData> > m_customFonts;
1198
1199     mutable RefPtr<CSSValuePool> m_cssValuePool;
1200
1201     Frame* m_frame;
1202     OwnPtr<CachedResourceLoader> m_cachedResourceLoader;
1203     RefPtr<DocumentParser> m_parser;
1204     bool m_wellFormed;
1205
1206     // Document URLs.
1207     KURL m_url; // Document.URL: The URL from which this document was retrieved.
1208     KURL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1209     KURL m_baseURLOverride; // An alternative base URL that takes precedence over m_baseURL (but not m_baseElementURL).
1210     KURL m_baseElementURL; // The URL set by the <base> element.
1211     KURL m_cookieURL; // The URL to use for cookie access.
1212     KURL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1213
1214     // Document.documentURI:
1215     // Although URL-like, Document.documentURI can actually be set to any
1216     // string by content.  Document.documentURI affects m_baseURL unless the
1217     // document contains a <base> element, in which case the <base> element
1218     // takes precedence.
1219     String m_documentURI;
1220
1221     String m_baseTarget;
1222
1223     RefPtr<DocumentType> m_docType;
1224     OwnPtr<DOMImplementation> m_implementation;
1225
1226     // Track the number of currently loading top-level stylesheets needed for rendering.
1227     // Sheets loaded using the @import directive are not included in this count.
1228     // We use this count of pending sheets to detect when we can begin attaching
1229     // elements and when it is safe to execute scripts.
1230     int m_pendingStylesheets;
1231
1232     // But sometimes you need to ignore pending stylesheet count to
1233     // force an immediate layout when requested by JS.
1234     bool m_ignorePendingStylesheets;
1235
1236     // If we do ignore the pending stylesheet count, then we need to add a boolean
1237     // to track that this happened so that we can do a full repaint when the stylesheets
1238     // do eventually load.
1239     PendingSheetLayout m_pendingSheetLayout;
1240     
1241     bool m_hasNodesWithPlaceholderStyle;
1242
1243     RefPtr<CSSStyleSheet> m_elemSheet;
1244     RefPtr<CSSStyleSheet> m_mappedElementSheet;
1245     RefPtr<CSSStyleSheet> m_pageUserSheet;
1246     mutable OwnPtr<Vector<RefPtr<CSSStyleSheet> > > m_pageGroupUserSheets;
1247     OwnPtr<Vector<RefPtr<CSSStyleSheet> > > m_userSheets;
1248     mutable bool m_pageGroupUserSheetCacheValid;
1249
1250     bool m_printing;
1251     bool m_paginatedForScreen;
1252
1253     bool m_ignoreAutofocus;
1254
1255     CompatibilityMode m_compatibilityMode;
1256     bool m_compatibilityModeLocked; // This is cheaper than making setCompatibilityMode virtual.
1257
1258     Color m_textColor;
1259
1260     RefPtr<Node> m_focusedNode;
1261     RefPtr<Node> m_hoverNode;
1262     RefPtr<Node> m_activeNode;
1263     RefPtr<Element> m_documentElement;
1264
1265     uint64_t m_domTreeVersion;
1266     static uint64_t s_globalTreeVersion;
1267     
1268     HashSet<NodeIterator*> m_nodeIterators;
1269     HashSet<Range*> m_ranges;
1270
1271     unsigned short m_listenerTypes;
1272
1273 #if ENABLE(MUTATION_OBSERVERS)
1274     MutationObserverOptions m_mutationObserverTypes;
1275 #endif
1276
1277     RefPtr<StyleSheetList> m_styleSheets; // All of the stylesheets that are currently in effect for our media type and stylesheet set.
1278     bool m_hadActiveLoadingStylesheet;
1279     
1280     typedef ListHashSet<Node*, 32> StyleSheetCandidateListHashSet;
1281     StyleSheetCandidateListHashSet m_styleSheetCandidateNodes; // All of the nodes that could potentially provide stylesheets to the document (<link>, <style>, <?xml-stylesheet>)
1282
1283     FormElementListHashSet m_formElementsWithState;
1284     typedef ListHashSet<RefPtr<FormAssociatedElement>, 32> FormAssociatedElementListHashSet;
1285     FormAssociatedElementListHashSet m_formElementsWithFormAttribute;
1286
1287     typedef HashMap<FormElementKey, Vector<String>, FormElementKeyHash, FormElementKeyHashTraits> FormElementStateMap;
1288     FormElementStateMap m_stateForNewFormElements;
1289     
1290     Color m_linkColor;
1291     Color m_visitedLinkColor;
1292     Color m_activeLinkColor;
1293
1294     String m_preferredStylesheetSet;
1295     String m_selectedStylesheetSet;
1296
1297     bool m_loadingSheet;
1298     bool m_visuallyOrdered;
1299     ReadyState m_readyState;
1300     bool m_bParsing;
1301     
1302     Timer<Document> m_styleRecalcTimer;
1303     bool m_pendingStyleRecalcShouldForce;
1304     bool m_inStyleRecalc;
1305     bool m_closeAfterStyleRecalc;
1306
1307     bool m_usesSiblingRules;
1308     bool m_usesSiblingRulesOverride;
1309     bool m_usesFirstLineRules;
1310     bool m_usesFirstLetterRules;
1311     bool m_usesBeforeAfterRules;
1312     bool m_usesBeforeAfterRulesOverride;
1313     bool m_usesRemUnits;
1314     bool m_usesLinkRules;
1315     bool m_gotoAnchorNeededAfterStylesheetsLoad;
1316     bool m_isDNSPrefetchEnabled;
1317     bool m_haveExplicitlyDisabledDNSPrefetch;
1318     bool m_frameElementsShouldIgnoreScrolling;
1319     bool m_containsValidityStyleRules;
1320     bool m_updateFocusAppearanceRestoresSelection;
1321
1322     // http://www.whatwg.org/specs/web-apps/current-work/#ignore-destructive-writes-counter
1323     unsigned m_ignoreDestructiveWriteCount;
1324
1325     StringWithDirection m_title;
1326     StringWithDirection m_rawTitle;
1327     bool m_titleSetExplicitly;
1328     RefPtr<Element> m_titleElement;
1329
1330     OwnPtr<RenderArena> m_renderArena;
1331
1332     mutable AXObjectCache* m_axObjectCache;
1333     OwnPtr<DocumentMarkerController> m_markers;
1334     
1335     Timer<Document> m_updateFocusAppearanceTimer;
1336
1337     Element* m_cssTarget;
1338
1339     // FIXME: Merge these 2 variables into an enum. Also, FrameLoader::m_didCallImplicitClose
1340     // is almost a duplication of this data, so that should probably get merged in too.
1341     // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
1342     // and should be merged.
1343     bool m_processingLoadEvent;
1344     bool m_loadEventFinished;
1345
1346     RefPtr<SerializedScriptValue> m_pendingStateObject;
1347     double m_startTime;
1348     bool m_overMinimumLayoutThreshold;
1349     
1350     OwnPtr<ScriptRunner> m_scriptRunner;
1351
1352 #if ENABLE(XSLT)
1353     OwnPtr<TransformSource> m_transformSource;
1354     RefPtr<Document> m_transformSourceDocument;
1355 #endif
1356
1357     int m_docID; // A unique document identifier used for things like document-specific mapped attributes.
1358
1359     String m_xmlEncoding;
1360     String m_xmlVersion;
1361     bool m_xmlStandalone;
1362
1363     String m_contentLanguage;
1364
1365     RenderObject* m_savedRenderer;
1366     
1367     RefPtr<TextResourceDecoder> m_decoder;
1368
1369     InheritedBool m_designMode;
1370     
1371     CheckedRadioButtons m_checkedRadioButtons;
1372
1373     OwnPtr<HTMLCollection> m_collections[NumUnnamedDocumentCachedTypes];
1374     OwnPtr<HTMLAllCollection> m_allCollection;
1375
1376     typedef HashMap<AtomicStringImpl*, OwnPtr<HTMLNameCollection> > NamedCollectionMap;
1377     NamedCollectionMap m_documentNamedItemCollections;
1378     NamedCollectionMap m_windowNamedItemCollections;
1379
1380     RefPtr<XPathEvaluator> m_xpathEvaluator;
1381
1382 #if ENABLE(SVG)
1383     OwnPtr<SVGDocumentExtensions> m_svgExtensions;
1384 #endif
1385
1386 #if ENABLE(DASHBOARD_SUPPORT)
1387     Vector<DashboardRegionValue> m_dashboardRegions;
1388     bool m_hasDashboardRegions;
1389     bool m_dashboardRegionsDirty;
1390 #endif
1391
1392     HashMap<String, RefPtr<HTMLCanvasElement> > m_cssCanvasElements;
1393
1394     bool m_createRenderers;
1395     bool m_inPageCache;
1396     Vector<IconURL> m_iconURLs;
1397
1398     HashSet<Element*> m_documentSuspensionCallbackElements;
1399     HashSet<Element*> m_mediaVolumeCallbackElements;
1400     HashSet<Element*> m_privateBrowsingStateChangedElements;
1401
1402     HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;    
1403     bool m_accessKeyMapValid;
1404
1405     bool m_useSecureKeyboardEntryWhenActive;
1406
1407     bool m_isXHTML;
1408     bool m_isHTML;
1409
1410     bool m_isViewSource;
1411     bool m_sawElementsInKnownNamespaces;
1412
1413     RefPtr<DocumentEventQueue> m_eventQueue;
1414
1415     RefPtr<DocumentWeakReference> m_weakReference;
1416
1417     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1418
1419     QualifiedName m_idAttributeName;
1420
1421 #if ENABLE(FULLSCREEN_API)
1422     bool m_areKeysEnabledInFullScreen;
1423     RefPtr<Element> m_fullScreenElement;
1424     RenderFullScreen* m_fullScreenRenderer;
1425     Timer<Document> m_fullScreenChangeDelayTimer;
1426     Deque<RefPtr<Element> > m_fullScreenChangeEventTargetQueue;
1427     Deque<RefPtr<Element> > m_fullScreenErrorEventTargetQueue;
1428     bool m_isAnimatingFullScreen;
1429     LayoutRect m_savedPlaceholderFrameRect;
1430     RefPtr<RenderStyle> m_savedPlaceholderRenderStyle;
1431 #endif
1432
1433     int m_loadEventDelayCount;
1434     Timer<Document> m_loadEventDelayTimer;
1435
1436     ViewportArguments m_viewportArguments;
1437
1438     SecurityPolicy::ReferrerPolicy m_referrerPolicy;
1439
1440     bool m_directionSetOnDocumentElement;
1441     bool m_writingModeSetOnDocumentElement;
1442
1443     DocumentTiming m_documentTiming;
1444     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1445     bool m_writeRecursionIsTooDeep;
1446     unsigned m_writeRecursionDepth;
1447     
1448     unsigned m_wheelEventHandlerCount;
1449     unsigned m_touchEventHandlerCount;
1450
1451 #if ENABLE(REQUEST_ANIMATION_FRAME)
1452     RefPtr<ScriptedAnimationController> m_scriptedAnimationController;
1453 #endif
1454
1455     Timer<Document> m_pendingTasksTimer;
1456     Vector<OwnPtr<Task> > m_pendingTasks;    
1457 };
1458
1459 // Put these methods here, because they require the Document definition, but we really want to inline them.
1460
1461 inline bool Node::isDocumentNode() const
1462 {
1463     return this == m_document;
1464 }
1465
1466 inline Node::Node(Document* document, ConstructionType type)
1467     : m_nodeFlags(type)
1468     , m_document(document)
1469     , m_previous(0)
1470     , m_next(0)
1471     , m_renderer(0)
1472 {
1473     if (document)
1474         document->guardRef();
1475 #if !defined(NDEBUG) || (defined(DUMP_NODE_STATISTICS) && DUMP_NODE_STATISTICS)
1476     trackForDebugging();
1477 #endif
1478     InspectorCounters::incrementCounter(InspectorCounters::NodeCounter);
1479 }
1480
1481 } // namespace WebCore
1482
1483 #endif // Document_h