9d12e5eead39b8edabf8140e10673ced4744d951
[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, 2012, 2013 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 "CollectionType.h"
32 #include "Color.h"
33 #include "ContainerNode.h"
34 #include "DocumentEventQueue.h"
35 #include "DocumentTiming.h"
36 #include "FocusDirection.h"
37 #include "HitTestRequest.h"
38 #include "IconURL.h"
39 #include "InspectorCounters.h"
40 #include "MutationObserver.h"
41 #include "PageVisibilityState.h"
42 #include "PlatformScreen.h"
43 #include "QualifiedName.h"
44 #include "ReferrerPolicy.h"
45 #include "ScriptExecutionContext.h"
46 #include "StringWithDirection.h"
47 #include "StyleResolveTree.h"
48 #include "Timer.h"
49 #include "TreeScope.h"
50 #include "UserActionElementSet.h"
51 #include "ViewportArguments.h"
52 #include <wtf/Deque.h>
53 #include <wtf/HashSet.h>
54 #include <wtf/OwnPtr.h>
55 #include <wtf/PassOwnPtr.h>
56 #include <wtf/PassRefPtr.h>
57 #include <wtf/WeakPtr.h>
58
59 namespace WebCore {
60
61 class AXObjectCache;
62 class Attr;
63 class CDATASection;
64 class CSSStyleDeclaration;
65 class CSSStyleSheet;
66 class CachedCSSStyleSheet;
67 class CachedResourceLoader;
68 class CachedScript;
69 class CanvasRenderingContext;
70 class CharacterData;
71 class Comment;
72 class CustomElementConstructor;
73 class CustomElementRegistry;
74 class DOMImplementation;
75 class DOMNamedFlowCollection;
76 class DOMSelection;
77 class DOMWindow;
78 class DOMWrapperWorld;
79 class Database;
80 class DatabaseThread;
81 class DocumentFragment;
82 class DocumentLoader;
83 class DocumentMarkerController;
84 class DocumentParser;
85 class DocumentSharedObjectPool;
86 class DocumentStyleSheetCollection;
87 class DocumentType;
88 class Element;
89 class EntityReference;
90 class Event;
91 class EventListener;
92 class FloatRect;
93 class FloatQuad;
94 class FormController;
95 class Frame;
96 class FrameView;
97 class HTMLCanvasElement;
98 class HTMLCollection;
99 class HTMLAllCollection;
100 class HTMLDocument;
101 class HTMLElement;
102 class HTMLFrameOwnerElement;
103 class HTMLHeadElement;
104 class HTMLIFrameElement;
105 class HTMLMapElement;
106 class HTMLNameCollection;
107 class HTMLScriptElement;
108 class HitTestRequest;
109 class HitTestResult;
110 class IntPoint;
111 class LayoutPoint;
112 class LayoutRect;
113 class LiveNodeListBase;
114 class DOMWrapperWorld;
115 class JSNode;
116 class Locale;
117 class MediaCanStartListener;
118 class MediaQueryList;
119 class MediaQueryMatcher;
120 class MouseEventWithHitTestResults;
121 class NamedFlowCollection;
122 class NodeFilter;
123 class NodeIterator;
124 class Page;
125 class PlatformMouseEvent;
126 class ProcessingInstruction;
127 class Range;
128 class RegisteredEventListener;
129 class RenderArena;
130 class RenderView;
131 class RenderFullScreen;
132 class ScriptableDocumentParser;
133 class ScriptElementData;
134 class ScriptRunner;
135 class SecurityOrigin;
136 class SelectorQueryCache;
137 class SerializedScriptValue;
138 class SegmentedString;
139 class Settings;
140 class StyleResolver;
141 class StyleSheet;
142 class StyleSheetContents;
143 class StyleSheetList;
144 class Text;
145 class TextResourceDecoder;
146 class TreeWalker;
147 class VisitedLinkState;
148 class WebKitNamedFlow;
149 class XMLHttpRequest;
150 class XPathEvaluator;
151 class XPathExpression;
152 class XPathNSResolver;
153 class XPathResult;
154
155 #if ENABLE(SVG)
156 class SVGDocumentExtensions;
157 #endif
158
159 #if ENABLE(XSLT)
160 class TransformSource;
161 #endif
162
163 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
164 struct AnnotatedRegionValue;
165 #endif
166
167 #if ENABLE(TOUCH_EVENTS)
168 class Touch;
169 class TouchList;
170 #endif
171
172 #if ENABLE(REQUEST_ANIMATION_FRAME)
173 class RequestAnimationFrameCallback;
174 class ScriptedAnimationController;
175 #endif
176
177 #if ENABLE(TEXT_AUTOSIZING)
178 class TextAutosizer;
179 #endif
180
181 #if ENABLE(CSP_NEXT)
182 class DOMSecurityPolicy;
183 #endif
184
185 #if ENABLE(FONT_LOAD_EVENTS)
186 class FontLoader;
187 #endif
188
189 typedef int ExceptionCode;
190
191 #if ENABLE(IOS_TEXT_AUTOSIZING)
192 struct TextAutoSizingHash;
193 class TextAutoSizingKey;
194 class TextAutoSizingValue;
195
196 struct TextAutoSizingTraits : WTF::GenericHashTraits<TextAutoSizingKey> {
197     static const bool emptyValueIsZero = true;
198     static void constructDeletedValue(TextAutoSizingKey& slot);
199     static bool isDeletedValue(const TextAutoSizingKey& value);
200 };
201 #endif
202
203 enum PageshowEventPersistence {
204     PageshowEventNotPersisted = 0,
205     PageshowEventPersisted = 1
206 };
207
208 enum StyleResolverUpdateFlag { RecalcStyleImmediately, DeferRecalcStyle, RecalcStyleIfNeeded, DeferRecalcStyleIfNeeded };
209
210 enum NodeListInvalidationType {
211     DoNotInvalidateOnAttributeChanges = 0,
212     InvalidateOnClassAttrChange,
213     InvalidateOnIdNameAttrChange,
214     InvalidateOnNameAttrChange,
215     InvalidateOnForAttrChange,
216     InvalidateForFormControls,
217     InvalidateOnHRefAttrChange,
218     InvalidateOnAnyAttrChange,
219 };
220 const int numNodeListInvalidationTypes = InvalidateOnAnyAttrChange + 1;
221
222 typedef HashCountedSet<Node*> TouchEventTargetSet;
223
224 enum DocumentClass {
225     DefaultDocumentClass = 0,
226     HTMLDocumentClass = 1,
227     XHTMLDocumentClass = 1 << 1,
228     ImageDocumentClass = 1 << 2,
229     PluginDocumentClass = 1 << 3,
230     MediaDocumentClass = 1 << 4,
231     SVGDocumentClass = 1 << 5,
232 };
233
234 typedef unsigned char DocumentClassFlags;
235
236 class Document : public ContainerNode, public TreeScope, public ScriptExecutionContext {
237 public:
238     static PassRefPtr<Document> create(Frame* frame, const KURL& url)
239     {
240         return adoptRef(new Document(frame, url));
241     }
242     static PassRefPtr<Document> createXHTML(Frame* frame, const KURL& url)
243     {
244         return adoptRef(new Document(frame, url, XHTMLDocumentClass));
245     }
246     virtual ~Document();
247
248     MediaQueryMatcher& mediaQueryMatcher();
249
250     using ContainerNode::ref;
251     using ContainerNode::deref;
252
253     Element* getElementById(const AtomicString& id) const;
254
255     virtual bool canContainRangeEndPoint() const { return true; }
256
257     Element* getElementByAccessKey(const String& key);
258     void invalidateAccessKeyMap();
259
260     SelectorQueryCache& selectorQueryCache();
261
262     // DOM methods & attributes for Document
263
264     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
265     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
266     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
267     DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
268     DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
269     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
270     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
271     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
272     DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
273     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
274     DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
275     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
276     DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
277     DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
278     DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
279     DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
280     DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
281     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
282     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseenter);
283     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseleave);
284     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
285     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
286     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
287     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
288     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
289     DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
290     DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
291     DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
292     DEFINE_ATTRIBUTE_EVENT_LISTENER(wheel);
293
294     DEFINE_ATTRIBUTE_EVENT_LISTENER(blur);
295     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
296     DEFINE_ATTRIBUTE_EVENT_LISTENER(focus);
297     DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
298     DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange);
299
300     // WebKit extensions
301     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut);
302     DEFINE_ATTRIBUTE_EVENT_LISTENER(cut);
303     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy);
304     DEFINE_ATTRIBUTE_EVENT_LISTENER(copy);
305     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste);
306     DEFINE_ATTRIBUTE_EVENT_LISTENER(paste);
307     DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
308     DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
309     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectstart);
310     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectionchange);
311 #if ENABLE(TOUCH_EVENTS)
312     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
313     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
314     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
315     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
316 #endif
317 #if ENABLE(FULLSCREEN_API)
318     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenchange);
319     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenerror);
320 #endif
321 #if ENABLE(POINTER_LOCK)
322     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitpointerlockchange);
323     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitpointerlockerror);
324 #endif
325 #if ENABLE(PAGE_VISIBILITY_API)
326     DEFINE_ATTRIBUTE_EVENT_LISTENER(visibilitychange);
327 #endif
328 #if ENABLE(CSP_NEXT)
329     DEFINE_ATTRIBUTE_EVENT_LISTENER(securitypolicyviolation);
330 #endif
331
332     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
333     ViewportArguments viewportArguments() const { return m_viewportArguments; }
334 #ifndef NDEBUG
335     bool didDispatchViewportPropertiesChanged() const { return m_didDispatchViewportPropertiesChanged; }
336 #endif
337
338     void setReferrerPolicy(ReferrerPolicy referrerPolicy) { m_referrerPolicy = referrerPolicy; }
339     ReferrerPolicy referrerPolicy() const { return m_referrerPolicy; }
340
341     DocumentType* doctype() const;
342
343     DOMImplementation* implementation();
344     
345     Element* documentElement() const
346     {
347         return m_documentElement.get();
348     }
349
350     bool hasManifest() const;
351     
352     virtual PassRefPtr<Element> createElement(const AtomicString& tagName, ExceptionCode&);
353     PassRefPtr<DocumentFragment> createDocumentFragment();
354     PassRefPtr<Text> createTextNode(const String& data);
355     PassRefPtr<Comment> createComment(const String& data);
356     PassRefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
357     PassRefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
358     PassRefPtr<Attr> createAttribute(const String& name, ExceptionCode&);
359     PassRefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&, bool shouldIgnoreNamespaceChecks = false);
360     PassRefPtr<EntityReference> createEntityReference(const String& name, ExceptionCode&);
361     PassRefPtr<Node> importNode(Node* importedNode, ExceptionCode& ec) { return importNode(importedNode, true, ec); }
362     PassRefPtr<Node> importNode(Node* importedNode, bool deep, ExceptionCode&);
363     PassRefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
364     PassRefPtr<Element> createElement(const QualifiedName&, bool createdByParser);
365
366     bool cssStickyPositionEnabled() const;
367     bool cssRegionsEnabled() const;
368     bool cssCompositingEnabled() const;
369 #if ENABLE(CSS_REGIONS)
370     PassRefPtr<DOMNamedFlowCollection> webkitGetNamedFlows();
371 #endif
372
373     NamedFlowCollection* namedFlows();
374
375     bool regionBasedColumnsEnabled() const;
376
377     bool cssGridLayoutEnabled() const;
378
379     Element* elementFromPoint(int x, int y) const;
380     PassRefPtr<Range> caretRangeFromPoint(int x, int y);
381
382     String readyState() const;
383
384     String defaultCharset() const;
385
386     String inputEncoding() const { return Document::encoding(); }
387     String charset() const { return Document::encoding(); }
388     String characterSet() const { return Document::encoding(); }
389
390     String encoding() const;
391
392     void setCharset(const String&);
393
394     void setContent(const String&);
395
396     String suggestedMIMEType() const;
397
398     String contentLanguage() const { return m_contentLanguage; }
399     void setContentLanguage(const String&);
400
401     String xmlEncoding() const { return m_xmlEncoding; }
402     String xmlVersion() const { return m_xmlVersion; }
403     enum StandaloneStatus { StandaloneUnspecified, Standalone, NotStandalone };
404     bool xmlStandalone() const { return m_xmlStandalone == Standalone; }
405     StandaloneStatus xmlStandaloneStatus() const { return static_cast<StandaloneStatus>(m_xmlStandalone); }
406     bool hasXMLDeclaration() const { return m_hasXMLDeclaration; }
407
408     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
409     void setXMLVersion(const String&, ExceptionCode&);
410     void setXMLStandalone(bool, ExceptionCode&);
411     void setHasXMLDeclaration(bool hasXMLDeclaration) { m_hasXMLDeclaration = hasXMLDeclaration ? 1 : 0; }
412
413     String documentURI() const { return m_documentURI; }
414     void setDocumentURI(const String&);
415
416     virtual KURL baseURI() const;
417
418 #if ENABLE(PAGE_VISIBILITY_API)
419     String visibilityState() const;
420     bool hidden() const;
421 #endif
422
423 #if ENABLE(CSP_NEXT)
424     DOMSecurityPolicy* securityPolicy();
425 #endif
426
427     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
428
429     PassRefPtr<HTMLCollection> images();
430     PassRefPtr<HTMLCollection> embeds();
431     PassRefPtr<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
432     PassRefPtr<HTMLCollection> applets();
433     PassRefPtr<HTMLCollection> links();
434     PassRefPtr<HTMLCollection> forms();
435     PassRefPtr<HTMLCollection> anchors();
436     PassRefPtr<HTMLCollection> scripts();
437     PassRefPtr<HTMLCollection> all();
438
439     PassRefPtr<HTMLCollection> windowNamedItems(const AtomicString& name);
440     PassRefPtr<HTMLCollection> documentNamedItems(const AtomicString& name);
441
442     // Other methods (not part of DOM)
443     bool isHTMLDocument() const { return m_documentClasses & HTMLDocumentClass; }
444     bool isXHTMLDocument() const { return m_documentClasses & XHTMLDocumentClass; }
445     bool isImageDocument() const { return m_documentClasses & ImageDocumentClass; }
446     bool isSVGDocument() const { return m_documentClasses & SVGDocumentClass; }
447     bool isPluginDocument() const { return m_documentClasses & PluginDocumentClass; }
448     bool isMediaDocument() const { return m_documentClasses & MediaDocumentClass; }
449 #if ENABLE(SVG)
450     bool hasSVGRootNode() const;
451 #else
452     static bool hasSVGRootNode() { return false; }
453 #endif
454     virtual bool isFrameSet() const { return false; }
455
456     bool isSrcdocDocument() const { return m_isSrcdocDocument; }
457
458     StyleResolver* styleResolverIfExists() const { return m_styleResolver.get(); }
459
460     bool isViewSource() const { return m_isViewSource; }
461     void setIsViewSource(bool);
462
463     bool sawElementsInKnownNamespaces() const { return m_sawElementsInKnownNamespaces; }
464
465     StyleResolver& ensureStyleResolver()
466     { 
467         if (!m_styleResolver)
468             createStyleResolver();
469         return *m_styleResolver;
470     }
471
472     void notifyRemovePendingSheetIfNeeded();
473
474     bool haveStylesheetsLoaded() const;
475
476     // This is a DOM function.
477     StyleSheetList* styleSheets();
478
479     DocumentStyleSheetCollection* styleSheetCollection() { return m_styleSheetCollection.get(); }
480
481     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
482     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
483
484     /**
485      * Called when one or more stylesheets in the document may have been added, removed or changed.
486      *
487      * Creates a new style resolver and assign it to this document. This is done by iterating through all nodes in
488      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
489      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
490      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
491      * found and is used to calculate the derived styles for all rendering objects.
492      */
493     void styleResolverChanged(StyleResolverUpdateFlag);
494
495     void scheduleOptimizedStyleSheetUpdate();
496
497     void didAccessStyleResolver();
498
499     void evaluateMediaQueryList();
500
501     FormController& formController();
502     Vector<String> formElementsState() const;
503     void setStateForNewFormElements(const Vector<String>&);
504
505     FrameView* view() const; // can be NULL
506     Frame* frame() const { return m_frame; } // can be NULL
507     Page* page() const; // can be NULL
508     Settings* settings() const; // can be NULL
509
510     float deviceScaleFactor() const;
511
512     PassRefPtr<Range> createRange();
513
514     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
515         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
516
517     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow,
518         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
519
520     // Special support for editing
521     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
522     PassRefPtr<Text> createEditingTextNode(const String&);
523
524     void recalcStyle(Style::Change = Style::NoChange);
525     void updateStyleIfNeeded();
526     void updateLayout();
527     void updateLayoutIgnorePendingStylesheets();
528     PassRefPtr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element*);
529
530     // Returns true if page box (margin boxes and page borders) is visible.
531     bool isPageBoxVisible(int pageIndex);
532
533     // Returns the preferred page size and margins in pixels, assuming 96
534     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
535     // marginLeft must be initialized to the default values that are used if
536     // auto is specified.
537     void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
538
539     CachedResourceLoader* cachedResourceLoader() { return m_cachedResourceLoader.get(); }
540
541     void didBecomeCurrentDocumentInFrame();
542     void destroyRenderTree();
543     void disconnectFromFrame();
544     void prepareForDestruction();
545
546     // Override ScriptExecutionContext methods to do additional work
547     virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) OVERRIDE;
548     virtual void resumeActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) OVERRIDE;
549
550     RenderArena* renderArena() { return m_renderArena.get(); }
551     RenderView* renderView() const { return m_renderView; }
552
553     bool renderTreeBeingDestroyed() const { return m_renderTreeBeingDestroyed; }
554     bool hasLivingRenderTree() const { return renderView() && !renderTreeBeingDestroyed(); }
555
556     AXObjectCache* existingAXObjectCache() const;
557     AXObjectCache* axObjectCache() const;
558     void clearAXObjectCache();
559
560     // to get visually ordered hebrew and arabic pages right
561     void setVisuallyOrdered();
562     bool visuallyOrdered() const { return m_visuallyOrdered; }
563     
564     DocumentLoader* loader() const;
565
566     void open(Document* ownerDocument = 0);
567     void implicitOpen();
568
569     // close() is the DOM API document.close()
570     void close();
571     // In some situations (see the code), we ignore document.close().
572     // explicitClose() bypass these checks and actually tries to close the
573     // input stream.
574     void explicitClose();
575     // implicitClose() actually does the work of closing the input stream.
576     void implicitClose();
577
578     void cancelParsing();
579
580     void write(const SegmentedString& text, Document* ownerDocument = 0);
581     void write(const String& text, Document* ownerDocument = 0);
582     void writeln(const String& text, Document* ownerDocument = 0);
583
584     bool wellFormed() const { return m_wellFormed; }
585
586     virtual const KURL& url() const OVERRIDE FINAL { return m_url; }
587     void setURL(const KURL&);
588
589     // To understand how these concepts relate to one another, please see the
590     // comments surrounding their declaration.
591     const KURL& baseURL() const { return m_baseURL; }
592     void setBaseURLOverride(const KURL&);
593     const KURL& baseURLOverride() const { return m_baseURLOverride; }
594     const KURL& baseElementURL() const { return m_baseElementURL; }
595     const String& baseTarget() const { return m_baseTarget; }
596     void processBaseElement();
597
598     virtual KURL completeURL(const String&) const OVERRIDE FINAL;
599     KURL completeURL(const String&, const KURL& baseURLOverride) const;
600
601     virtual String userAgent(const KURL&) const;
602
603     virtual void disableEval(const String& errorMessage);
604
605     bool canNavigate(Frame* targetFrame);
606     Frame* findUnsafeParentScrollPropagationBoundary();
607
608     CSSStyleSheet& elementSheet();
609     
610     virtual PassRefPtr<DocumentParser> createParser();
611     DocumentParser* parser() const { return m_parser.get(); }
612     ScriptableDocumentParser* scriptableDocumentParser() const;
613     
614     bool printing() const { return m_printing; }
615     void setPrinting(bool p) { m_printing = p; }
616
617     bool paginatedForScreen() const { return m_paginatedForScreen; }
618     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
619     
620     bool paginated() const { return printing() || paginatedForScreen(); }
621
622     enum CompatibilityMode { QuirksMode, LimitedQuirksMode, NoQuirksMode };
623
624     void setCompatibilityMode(CompatibilityMode m);
625     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
626     CompatibilityMode compatibilityMode() const { return m_compatibilityMode; }
627
628     String compatMode() const;
629
630     bool inQuirksMode() const { return m_compatibilityMode == QuirksMode; }
631     bool inLimitedQuirksMode() const { return m_compatibilityMode == LimitedQuirksMode; }
632     bool inNoQuirksMode() const { return m_compatibilityMode == NoQuirksMode; }
633
634     enum ReadyState {
635         Loading,
636         Interactive,
637         Complete
638     };
639     void setReadyState(ReadyState);
640     void setParsing(bool);
641     bool parsing() const { return m_bParsing; }
642     int minimumLayoutDelay();
643
644     bool shouldScheduleLayout();
645     bool isLayoutTimerActive();
646     int elapsedTime() const;
647     
648     void setTextColor(const Color& color) { m_textColor = color; }
649     Color textColor() const { return m_textColor; }
650
651     const Color& linkColor() const { return m_linkColor; }
652     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
653     const Color& activeLinkColor() const { return m_activeLinkColor; }
654     void setLinkColor(const Color& c) { m_linkColor = c; }
655     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
656     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
657     void resetLinkColor();
658     void resetVisitedLinkColor();
659     void resetActiveLinkColor();
660     VisitedLinkState& visitedLinkState() const { return *m_visitedLinkState; }
661
662     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const LayoutPoint&, const PlatformMouseEvent&);
663
664     /* Newly proposed CSS3 mechanism for selecting alternate
665        stylesheets using the DOM. May be subject to change as
666        spec matures. - dwh
667     */
668     String preferredStylesheetSet() const;
669     String selectedStylesheetSet() const;
670     void setSelectedStylesheetSet(const String&);
671
672     bool setFocusedElement(PassRefPtr<Element>, FocusDirection = FocusDirectionNone);
673     Element* focusedElement() const { return m_focusedElement.get(); }
674     UserActionElementSet& userActionElements()  { return m_userActionElements; }
675     const UserActionElementSet& userActionElements() const { return m_userActionElements; }
676
677     // The m_ignoreAutofocus flag specifies whether or not the document has been changed by the user enough 
678     // for WebCore to ignore the autofocus attribute on any form controls
679     bool ignoreAutofocus() const { return m_ignoreAutofocus; };
680     void setIgnoreAutofocus(bool shouldIgnore = true) { m_ignoreAutofocus = shouldIgnore; };
681
682     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
683     void hoveredElementDidDetach(Element*);
684     void elementInActiveChainDidDetach(Element*);
685
686     void updateHoverActiveState(const HitTestRequest&, Element*, const PlatformMouseEvent* = 0, StyleResolverUpdateFlag = RecalcStyleIfNeeded);
687
688     // Updates for :target (CSS3 selector).
689     void setCSSTarget(Element*);
690     Element* cssTarget() const { return m_cssTarget; }
691     
692     void scheduleForcedStyleRecalc();
693     void scheduleStyleRecalc();
694     void unscheduleStyleRecalc();
695     bool hasPendingStyleRecalc() const;
696     bool hasPendingForcedStyleRecalc() const;
697     void styleRecalcTimerFired(Timer<Document>*);
698     void optimizedStyleSheetUpdateTimerFired(Timer<Document>*);
699
700     void registerNodeList(LiveNodeListBase*);
701     void unregisterNodeList(LiveNodeListBase*);
702     bool shouldInvalidateNodeListCaches(const QualifiedName* attrName = 0) const;
703     void invalidateNodeListCaches(const QualifiedName* attrName);
704
705     void attachNodeIterator(NodeIterator*);
706     void detachNodeIterator(NodeIterator*);
707     void moveNodeIteratorsToNewDocument(Node*, Document*);
708
709     void attachRange(Range*);
710     void detachRange(Range*);
711
712     void updateRangesAfterChildrenChanged(ContainerNode*);
713     // nodeChildrenWillBeRemoved is used when removing all node children at once.
714     void nodeChildrenWillBeRemoved(ContainerNode*);
715     // nodeWillBeRemoved is only safe when removing one node at a time.
716     void nodeWillBeRemoved(Node*);
717     bool canReplaceChild(Node* newChild, Node* oldChild);
718
719     void textInserted(Node*, unsigned offset, unsigned length);
720     void textRemoved(Node*, unsigned offset, unsigned length);
721     void textNodesMerged(Text* oldNode, unsigned offset);
722     void textNodeSplit(Text* oldNode);
723
724     void createDOMWindow();
725     void takeDOMWindowFrom(Document*);
726
727     DOMWindow* domWindow() const { return m_domWindow.get(); }
728     // In DOM Level 2, the Document's DOMWindow is called the defaultView.
729     DOMWindow* defaultView() const { return domWindow(); } 
730
731     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
732     void setWindowAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
733     EventListener* getWindowAttributeEventListener(const AtomicString& eventType);
734     void dispatchWindowEvent(PassRefPtr<Event>, PassRefPtr<EventTarget> = 0);
735     void dispatchWindowLoadEvent();
736
737     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
738
739     // keep track of what types of event listeners are registered, so we don't
740     // dispatch events unnecessarily
741     enum ListenerType {
742         DOMSUBTREEMODIFIED_LISTENER          = 1,
743         DOMNODEINSERTED_LISTENER             = 1 << 1,
744         DOMNODEREMOVED_LISTENER              = 1 << 2,
745         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 1 << 3,
746         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 1 << 4,
747         DOMCHARACTERDATAMODIFIED_LISTENER    = 1 << 5,
748         OVERFLOWCHANGED_LISTENER             = 1 << 6,
749         ANIMATIONEND_LISTENER                = 1 << 7,
750         ANIMATIONSTART_LISTENER              = 1 << 8,
751         ANIMATIONITERATION_LISTENER          = 1 << 9,
752         TRANSITIONEND_LISTENER               = 1 << 10,
753         BEFORELOAD_LISTENER                  = 1 << 11,
754         SCROLL_LISTENER                      = 1 << 12
755         // 3 bits remaining
756     };
757
758     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
759     void addListenerTypeIfNeeded(const AtomicString& eventType);
760
761     bool hasMutationObserversOfType(MutationObserver::MutationType type) const
762     {
763         return m_mutationObserverTypes & type;
764     }
765     bool hasMutationObservers() const { return m_mutationObserverTypes; }
766     void addMutationObserverTypes(MutationObserverOptions types) { m_mutationObserverTypes |= types; }
767
768     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
769
770     /**
771      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
772      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
773      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
774      * specified in a HTML file.
775      *
776      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
777      * @param content The header value (value of the meta tag's "content" attribute)
778      */
779     void processHttpEquiv(const String& equiv, const String& content);
780     void processViewport(const String& features, ViewportArguments::Type origin);
781     void updateViewportArguments();
782     void processReferrerPolicy(const String& policy);
783
784     // Returns the owning element in the parent document.
785     // Returns 0 if this is the top level document.
786     HTMLFrameOwnerElement* ownerElement() const;
787
788     HTMLIFrameElement* seamlessParentIFrame() const;
789     bool shouldDisplaySeamlesslyWithParent() const;
790
791     // Used by DOM bindings; no direction known.
792     String title() const { return m_title.string(); }
793     void setTitle(const String&);
794
795     void setTitleElement(const StringWithDirection&, Element* titleElement);
796     void removeTitle(Element* titleElement);
797
798     String cookie(ExceptionCode&) const;
799     void setCookie(const String&, ExceptionCode&);
800
801     String referrer() const;
802
803     String domain() const;
804     void setDomain(const String& newDomain, ExceptionCode&);
805
806     String lastModified() const;
807
808     // The cookieURL is used to query the cookie database for this document's
809     // cookies. For example, if the cookie URL is http://example.com, we'll
810     // use the non-Secure cookies for example.com when computing
811     // document.cookie.
812     //
813     // Q: How is the cookieURL different from the document's URL?
814     // A: The two URLs are the same almost all the time.  However, if one
815     //    document inherits the security context of another document, it
816     //    inherits its cookieURL but not its URL.
817     //
818     const KURL& cookieURL() const { return m_cookieURL; }
819     void setCookieURL(const KURL& url) { m_cookieURL = url; }
820
821     // The firstPartyForCookies is used to compute whether this document
822     // appears in a "third-party" context for the purpose of third-party
823     // cookie blocking.  The document is in a third-party context if the
824     // cookieURL and the firstPartyForCookies are from different hosts.
825     //
826     // Note: Some ports (including possibly Apple's) only consider the
827     //       document in a third-party context if the cookieURL and the
828     //       firstPartyForCookies have a different registry-controlled
829     //       domain.
830     //
831     const KURL& firstPartyForCookies() const { return m_firstPartyForCookies; }
832     void setFirstPartyForCookies(const KURL& url) { m_firstPartyForCookies = url; }
833     
834     // The following implements the rule from HTML 4 for what valid names are.
835     // To get this right for all the XML cases, we probably have to improve this or move it
836     // and make it sensitive to the type of document.
837     static bool isValidName(const String&);
838
839     // The following breaks a qualified name into a prefix and a local name.
840     // It also does a validity check, and returns false if the qualified name
841     // is invalid.  It also sets ExceptionCode when name is invalid.
842     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
843
844     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
845     static bool hasValidNamespaceForElements(const QualifiedName&);
846     static bool hasValidNamespaceForAttributes(const QualifiedName&);
847
848     HTMLElement* body() const;
849     void setBody(PassRefPtr<HTMLElement>, ExceptionCode&);
850
851     HTMLHeadElement* head();
852
853     DocumentMarkerController& markers() const { return *m_markers; }
854
855     bool directionSetOnDocumentElement() const { return m_directionSetOnDocumentElement; }
856     bool writingModeSetOnDocumentElement() const { return m_writingModeSetOnDocumentElement; }
857     void setDirectionSetOnDocumentElement(bool b) { m_directionSetOnDocumentElement = b; }
858     void setWritingModeSetOnDocumentElement(bool b) { m_writingModeSetOnDocumentElement = b; }
859
860     bool execCommand(const String& command, bool userInterface = false, const String& value = String());
861     bool queryCommandEnabled(const String& command);
862     bool queryCommandIndeterm(const String& command);
863     bool queryCommandState(const String& command);
864     bool queryCommandSupported(const String& command);
865     String queryCommandValue(const String& command);
866
867     KURL openSearchDescriptionURL();
868
869     // designMode support
870     enum InheritedBool { off = false, on = true, inherit };    
871     void setDesignMode(InheritedBool value);
872     InheritedBool getDesignMode() const;
873     bool inDesignMode() const;
874
875     Document* parentDocument() const;
876     Document* topDocument() const;
877     
878     ScriptRunner* scriptRunner() { return m_scriptRunner.get(); }
879
880     HTMLScriptElement* currentScript() const { return !m_currentScriptStack.isEmpty() ? m_currentScriptStack.last().get() : 0; }
881     void pushCurrentScript(PassRefPtr<HTMLScriptElement>);
882     void popCurrentScript();
883
884 #if ENABLE(XSLT)
885     void applyXSLTransform(ProcessingInstruction* pi);
886     PassRefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
887     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
888
889     void setTransformSource(PassOwnPtr<TransformSource>);
890     TransformSource* transformSource() const { return m_transformSource.get(); }
891 #endif
892
893     void incDOMTreeVersion() { m_domTreeVersion = ++s_globalTreeVersion; }
894     uint64_t domTreeVersion() const { return m_domTreeVersion; }
895
896     // XPathEvaluator methods
897     PassRefPtr<XPathExpression> createExpression(const String& expression,
898                                                  XPathNSResolver* resolver,
899                                                  ExceptionCode& ec);
900     PassRefPtr<XPathNSResolver> createNSResolver(Node *nodeResolver);
901     PassRefPtr<XPathResult> evaluate(const String& expression,
902                                      Node* contextNode,
903                                      XPathNSResolver* resolver,
904                                      unsigned short type,
905                                      XPathResult* result,
906                                      ExceptionCode& ec);
907
908     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
909
910     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
911
912     bool hasNodesWithPlaceholderStyle() const { return m_hasNodesWithPlaceholderStyle; }
913     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
914
915     const Vector<IconURL>& shortcutIconURLs();
916     const Vector<IconURL>& iconURLs(int iconTypesMask);
917     void addIconURL(const String& url, const String& mimeType, const String& size, IconType);
918
919     void updateFocusAppearanceSoon(bool restorePreviousSelection);
920     void cancelFocusAppearanceUpdate();
921         
922     // Extension for manipulating canvas drawing contexts for use in CSS
923     CanvasRenderingContext* getCSSCanvasContext(const String& type, const String& name, int width, int height);
924     HTMLCanvasElement* getCSSCanvasElement(const String& name);
925
926     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
927     void parseDNSPrefetchControlHeader(const String&);
928
929     virtual void postTask(PassOwnPtr<Task>); // Executes the task on context's thread asynchronously.
930
931     void suspendScriptedAnimationControllerCallbacks();
932     void resumeScriptedAnimationControllerCallbacks();
933     virtual void scriptedAnimationControllerSetThrottled(bool);
934     
935     void windowScreenDidChange(PlatformDisplayID);
936
937     void finishedParsing();
938
939     bool inPageCache() const { return m_inPageCache; }
940     void setInPageCache(bool flag);
941
942     // Elements can register themselves for the "documentWillSuspendForPageCache()" and  
943     // "documentDidResumeFromPageCache()" callbacks
944     void registerForPageCacheSuspensionCallbacks(Element*);
945     void unregisterForPageCacheSuspensionCallbacks(Element*);
946
947     void documentWillBecomeInactive();
948     void documentWillSuspendForPageCache();
949     void documentDidResumeFromPageCache();
950
951     void registerForMediaVolumeCallbacks(Element*);
952     void unregisterForMediaVolumeCallbacks(Element*);
953     void mediaVolumeDidChange();
954
955     void registerForPrivateBrowsingStateChangedCallbacks(Element*);
956     void unregisterForPrivateBrowsingStateChangedCallbacks(Element*);
957     void storageBlockingStateDidChange();
958     void privateBrowsingStateDidChange();
959
960 #if ENABLE(VIDEO_TRACK)
961     void registerForCaptionPreferencesChangedCallbacks(Element*);
962     void unregisterForCaptionPreferencesChangedCallbacks(Element*);
963     void captionPreferencesChanged();
964 #endif
965
966     void setShouldCreateRenderers(bool);
967     bool shouldCreateRenderers();
968
969     void setDecoder(PassRefPtr<TextResourceDecoder>);
970     TextResourceDecoder* decoder() const { return m_decoder.get(); }
971
972     String displayStringModifiedByEncoding(const String&) const;
973     PassRefPtr<StringImpl> displayStringModifiedByEncoding(PassRefPtr<StringImpl>) const;
974     void displayBufferModifiedByEncoding(LChar* buffer, unsigned len) const
975     {
976         displayBufferModifiedByEncodingInternal(buffer, len);
977     }
978     void displayBufferModifiedByEncoding(UChar* buffer, unsigned len) const
979     {
980         displayBufferModifiedByEncodingInternal(buffer, len);
981     }
982
983     // Quirk for the benefit of Apple's Dictionary application.
984     void setFrameElementsShouldIgnoreScrolling(bool ignore) { m_frameElementsShouldIgnoreScrolling = ignore; }
985     bool frameElementsShouldIgnoreScrolling() const { return m_frameElementsShouldIgnoreScrolling; }
986
987 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
988     void setAnnotatedRegionsDirty(bool f) { m_annotatedRegionsDirty = f; }
989     bool annotatedRegionsDirty() const { return m_annotatedRegionsDirty; }
990     bool hasAnnotatedRegions () const { return m_hasAnnotatedRegions; }
991     void setHasAnnotatedRegions(bool f) { m_hasAnnotatedRegions = f; }
992     const Vector<AnnotatedRegionValue>& annotatedRegions() const;
993     void setAnnotatedRegions(const Vector<AnnotatedRegionValue>&);
994 #endif
995
996     virtual void removeAllEventListeners();
997
998 #if ENABLE(SVG)
999     const SVGDocumentExtensions* svgExtensions();
1000     SVGDocumentExtensions* accessSVGExtensions();
1001 #endif
1002
1003     void initSecurityContext();
1004     void initContentSecurityPolicy();
1005
1006     void updateURLForPushOrReplaceState(const KURL&);
1007     void statePopped(PassRefPtr<SerializedScriptValue>);
1008
1009     bool processingLoadEvent() const { return m_processingLoadEvent; }
1010     bool loadEventFinished() const { return m_loadEventFinished; }
1011
1012     virtual bool isContextThread() const;
1013     virtual bool isJSExecutionForbidden() const { return false; }
1014
1015     bool containsValidityStyleRules() const { return m_containsValidityStyleRules; }
1016     void setContainsValidityStyleRules() { m_containsValidityStyleRules = true; }
1017
1018     void enqueueWindowEvent(PassRefPtr<Event>);
1019     void enqueueDocumentEvent(PassRefPtr<Event>);
1020     void enqueuePageshowEvent(PageshowEventPersistence);
1021     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1022     void enqueuePopstateEvent(PassRefPtr<SerializedScriptValue> stateObject);
1023     DocumentEventQueue& eventQueue() const { return m_eventQueue; }
1024
1025     void addMediaCanStartListener(MediaCanStartListener*);
1026     void removeMediaCanStartListener(MediaCanStartListener*);
1027     MediaCanStartListener* takeAnyMediaCanStartListener();
1028
1029     const QualifiedName& idAttributeName() const { return m_idAttributeName; }
1030     
1031 #if ENABLE(FULLSCREEN_API)
1032     bool webkitIsFullScreen() const { return m_fullScreenElement.get(); }
1033     bool webkitFullScreenKeyboardInputAllowed() const { return m_fullScreenElement.get() && m_areKeysEnabledInFullScreen; }
1034     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1035     
1036     enum FullScreenCheckType {
1037         EnforceIFrameAllowFullScreenRequirement,
1038         ExemptIFrameAllowFullScreenRequirement,
1039     };
1040
1041     void requestFullScreenForElement(Element*, unsigned short flags, FullScreenCheckType);
1042     void webkitCancelFullScreen();
1043     
1044     void webkitWillEnterFullScreenForElement(Element*);
1045     void webkitDidEnterFullScreenForElement(Element*);
1046     void webkitWillExitFullScreenForElement(Element*);
1047     void webkitDidExitFullScreenForElement(Element*);
1048     
1049     void setFullScreenRenderer(RenderFullScreen*);
1050     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer; }
1051     void fullScreenRendererDestroyed();
1052     
1053     void fullScreenChangeDelayTimerFired(Timer<Document>*);
1054     bool fullScreenIsAllowedForElement(Element*) const;
1055     void fullScreenElementRemoved();
1056     void removeFullScreenElementOfSubtree(Node*, bool amongChildrenOnly = false);
1057     bool isAnimatingFullScreen() const;
1058     void setAnimatingFullScreen(bool);
1059
1060     // W3C API
1061     bool webkitFullscreenEnabled() const;
1062     Element* webkitFullscreenElement() const { return !m_fullScreenElementStack.isEmpty() ? m_fullScreenElementStack.last().get() : 0; }
1063     void webkitExitFullscreen();
1064 #endif
1065
1066 #if ENABLE(POINTER_LOCK)
1067     void webkitExitPointerLock();
1068     Element* webkitPointerLockElement() const;
1069 #endif
1070
1071     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1072     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1073     void decrementLoadEventDelayCount();
1074     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1075
1076 #if ENABLE(TOUCH_EVENTS)
1077     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;
1078 #endif
1079
1080 #if ENABLE(WEB_TIMING)
1081     const DocumentTiming* timing() const { return &m_documentTiming; }
1082 #endif
1083
1084 #if ENABLE(REQUEST_ANIMATION_FRAME)
1085     int requestAnimationFrame(PassRefPtr<RequestAnimationFrameCallback>);
1086     void cancelAnimationFrame(int id);
1087     void serviceScriptedAnimations(double monotonicAnimationStartTime);
1088 #endif
1089
1090     virtual EventTarget* errorEventTarget();
1091     virtual void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, PassRefPtr<ScriptCallStack>);
1092
1093     void initDNSPrefetch();
1094
1095     unsigned wheelEventHandlerCount() const { return m_wheelEventHandlerCount; }
1096     void didAddWheelEventHandler();
1097     void didRemoveWheelEventHandler();
1098
1099     double lastHandledUserGestureTimestamp() const { return m_lastHandledUserGestureTimestamp; }
1100     void resetLastHandledUserGestureTimestamp();
1101
1102 #if ENABLE(TOUCH_EVENTS)
1103     bool hasTouchEventHandlers() const { return (m_touchEventTargets.get()) ? m_touchEventTargets->size() : false; }
1104 #else
1105     bool hasTouchEventHandlers() const { return false; }
1106 #endif
1107
1108     void didAddTouchEventHandler(Node*);
1109     void didRemoveTouchEventHandler(Node*);
1110
1111 #if ENABLE(TOUCH_EVENTS)
1112     void didRemoveEventTargetNode(Node*);
1113 #endif
1114
1115 #if ENABLE(TOUCH_EVENTS)
1116     const TouchEventTargetSet* touchEventTargets() const { return m_touchEventTargets.get(); }
1117 #else
1118     const TouchEventTargetSet* touchEventTargets() const { return 0; }
1119 #endif
1120
1121     bool visualUpdatesAllowed() const { return m_visualUpdatesAllowed; }
1122
1123     bool isInDocumentWrite() { return m_writeRecursionDepth > 0; }
1124
1125     void suspendScheduledTasks(ActiveDOMObject::ReasonForSuspension);
1126     void resumeScheduledTasks(ActiveDOMObject::ReasonForSuspension);
1127
1128 #if ENABLE(CSS_DEVICE_ADAPTATION)
1129     IntSize initialViewportSize() const;
1130 #endif
1131
1132 #if ENABLE(TEXT_AUTOSIZING)
1133     TextAutosizer* textAutosizer() { return m_textAutosizer.get(); }
1134 #endif
1135
1136 #if ENABLE(CUSTOM_ELEMENTS)
1137     PassRefPtr<Element> createElement(const AtomicString& localName, const AtomicString& typeExtension, ExceptionCode&);
1138     PassRefPtr<Element> createElementNS(const AtomicString& namespaceURI, const String& qualifiedName, const AtomicString& typeExtension, ExceptionCode&);
1139     PassRefPtr<CustomElementConstructor> registerElement(JSC::ExecState*, const AtomicString& name, ExceptionCode&);
1140     PassRefPtr<CustomElementConstructor> registerElement(JSC::ExecState*, const AtomicString& name, const Dictionary& options, ExceptionCode&);
1141     CustomElementRegistry* registry() const { return m_registry.get(); }
1142     void didCreateCustomElement(Element*, CustomElementConstructor*);
1143 #endif
1144
1145     void adjustFloatQuadsForScrollAndAbsoluteZoomAndFrameScale(Vector<FloatQuad>&, RenderObject*);
1146     void adjustFloatRectForScrollAndAbsoluteZoomAndFrameScale(FloatRect&, RenderObject*);
1147
1148     bool hasActiveParser();
1149     void incrementActiveParserCount() { ++m_activeParserCount; }
1150     void decrementActiveParserCount();
1151
1152     DocumentSharedObjectPool* sharedObjectPool() { return m_sharedObjectPool.get(); }
1153
1154     void didRemoveAllPendingStylesheet();
1155     void setNeedsNotifyRemoveAllPendingStylesheet() { m_needsNotifyRemoveAllPendingStylesheet = true; }
1156     void clearStyleResolver();
1157     void notifySeamlessChildDocumentsOfStylesheetUpdate() const;
1158
1159     bool inStyleRecalc() { return m_inStyleRecalc; }
1160
1161     // Return a Locale for the default locale if the argument is null or empty.
1162     Locale& getCachedLocale(const AtomicString& locale = nullAtom);
1163
1164 #if ENABLE(TEMPLATE_ELEMENT)
1165     const Document* templateDocument() const;
1166     Document* ensureTemplateDocument();
1167     void setTemplateDocumentHost(Document* templateDocumentHost) { m_templateDocumentHost = templateDocumentHost; }
1168     Document* templateDocumentHost() { return m_templateDocumentHost; }
1169 #endif
1170
1171     void didAssociateFormControl(Element*);
1172
1173     virtual void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0);
1174
1175     virtual SecurityOrigin* topOrigin() const OVERRIDE;
1176
1177 #if ENABLE(FONT_LOAD_EVENTS)
1178     PassRefPtr<FontLoader> fontloader();
1179 #endif
1180
1181     void ensurePlugInsInjectedScript(DOMWrapperWorld*);
1182
1183     void setVisualUpdatesAllowedByClient(bool);
1184
1185 protected:
1186     Document(Frame*, const KURL&, unsigned = DefaultDocumentClass);
1187
1188     void clearXMLVersion() { m_xmlVersion = String(); }
1189
1190 private:
1191     friend class Node;
1192     friend class IgnoreDestructiveWriteCountIncrementer;
1193
1194     RenderObject* renderer() const WTF_DELETED_FUNCTION;
1195     void setRenderer(RenderObject*) WTF_DELETED_FUNCTION;
1196     void setRenderView(RenderView*);
1197
1198     virtual void createRenderTree();
1199     virtual void dropChildren() OVERRIDE;
1200
1201     void detachParser();
1202
1203     typedef void (*ArgumentsCallback)(const String& keyString, const String& valueString, Document*, void* data);
1204     void processArguments(const String& features, void* data, ArgumentsCallback);
1205
1206     virtual bool isDocument() const OVERRIDE { return true; }
1207
1208     virtual void childrenChanged(const ChildChange&) OVERRIDE;
1209
1210     virtual String nodeName() const;
1211     virtual NodeType nodeType() const;
1212     virtual bool childTypeAllowed(NodeType) const;
1213     virtual PassRefPtr<Node> cloneNode(bool deep);
1214
1215     virtual void refScriptExecutionContext() { ref(); }
1216     virtual void derefScriptExecutionContext() { deref(); }
1217
1218     virtual void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, PassRefPtr<ScriptCallStack>, JSC::ExecState* = 0, unsigned long requestIdentifier = 0);
1219
1220     virtual double minimumTimerInterval() const;
1221
1222     virtual double timerAlignmentInterval() const;
1223
1224     void updateTitle(const StringWithDirection&);
1225     void updateFocusAppearanceTimerFired(Timer<Document>*);
1226     void updateBaseURL();
1227
1228     void buildAccessKeyMap(TreeScope* root);
1229
1230     void createStyleResolver();
1231
1232     void seamlessParentUpdatedStylesheets();
1233
1234     void loadEventDelayTimerFired(Timer<Document>*);
1235
1236     void pendingTasksTimerFired(Timer<Document>*);
1237
1238     static void didReceiveTask(void*);
1239     
1240     template <typename CharacterType>
1241     void displayBufferModifiedByEncodingInternal(CharacterType*, unsigned) const;
1242
1243 #if ENABLE(PAGE_VISIBILITY_API)
1244     PageVisibilityState pageVisibilityState() const;
1245 #endif
1246
1247     PassRefPtr<HTMLCollection> ensureCachedCollection(CollectionType);
1248
1249 #if ENABLE(FULLSCREEN_API)
1250     void clearFullscreenElementStack();
1251     void popFullscreenElementStack();
1252     void pushFullscreenElementStack(Element*);
1253     void addDocumentToFullScreenChangeEventQueue(Document*);
1254 #endif
1255
1256     void setVisualUpdatesAllowed(ReadyState);
1257     void setVisualUpdatesAllowed(bool);
1258     void visualUpdatesSuppressionTimerFired(Timer<Document>*);
1259
1260     void addListenerType(ListenerType listenerType) { m_listenerTypes |= listenerType; }
1261
1262     void didAssociateFormControlsTimerFired(Timer<Document>*);
1263
1264     void styleResolverThrowawayTimerFired(DeferrableOneShotTimer<Document>*);
1265     DeferrableOneShotTimer<Document> m_styleResolverThrowawayTimer;
1266
1267     OwnPtr<StyleResolver> m_styleResolver;
1268     bool m_didCalculateStyleResolver;
1269     bool m_hasNodesWithPlaceholderStyle;
1270     bool m_needsNotifyRemoveAllPendingStylesheet;
1271     // But sometimes you need to ignore pending stylesheet count to
1272     // force an immediate layout when requested by JS.
1273     bool m_ignorePendingStylesheets;
1274
1275     // If we do ignore the pending stylesheet count, then we need to add a boolean
1276     // to track that this happened so that we can do a full repaint when the stylesheets
1277     // do eventually load.
1278     PendingSheetLayout m_pendingSheetLayout;
1279
1280     Frame* m_frame;
1281     RefPtr<DOMWindow> m_domWindow;
1282
1283     RefPtr<CachedResourceLoader> m_cachedResourceLoader;
1284     RefPtr<DocumentParser> m_parser;
1285     unsigned m_activeParserCount;
1286
1287     bool m_wellFormed;
1288
1289     // Document URLs.
1290     KURL m_url; // Document.URL: The URL from which this document was retrieved.
1291     KURL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1292     KURL m_baseURLOverride; // An alternative base URL that takes precedence over m_baseURL (but not m_baseElementURL).
1293     KURL m_baseElementURL; // The URL set by the <base> element.
1294     KURL m_cookieURL; // The URL to use for cookie access.
1295     KURL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1296
1297     // Document.documentURI:
1298     // Although URL-like, Document.documentURI can actually be set to any
1299     // string by content.  Document.documentURI affects m_baseURL unless the
1300     // document contains a <base> element, in which case the <base> element
1301     // takes precedence.
1302     //
1303     // This property is read-only from JavaScript, but writable from Objective C.
1304     String m_documentURI;
1305
1306     String m_baseTarget;
1307
1308     OwnPtr<DOMImplementation> m_implementation;
1309
1310     RefPtr<CSSStyleSheet> m_elementSheet;
1311
1312     bool m_printing;
1313     bool m_paginatedForScreen;
1314
1315     bool m_ignoreAutofocus;
1316
1317     CompatibilityMode m_compatibilityMode;
1318     bool m_compatibilityModeLocked; // This is cheaper than making setCompatibilityMode virtual.
1319
1320     Color m_textColor;
1321
1322     RefPtr<Element> m_focusedElement;
1323     RefPtr<Element> m_hoveredElement;
1324     RefPtr<Element> m_activeElement;
1325     RefPtr<Element> m_documentElement;
1326     UserActionElementSet m_userActionElements;
1327
1328     uint64_t m_domTreeVersion;
1329     static uint64_t s_globalTreeVersion;
1330     
1331     HashSet<NodeIterator*> m_nodeIterators;
1332     HashSet<Range*> m_ranges;
1333
1334     unsigned short m_listenerTypes;
1335
1336     MutationObserverOptions m_mutationObserverTypes;
1337
1338     OwnPtr<DocumentStyleSheetCollection> m_styleSheetCollection;
1339     RefPtr<StyleSheetList> m_styleSheetList;
1340
1341     OwnPtr<FormController> m_formController;
1342
1343     Color m_linkColor;
1344     Color m_visitedLinkColor;
1345     Color m_activeLinkColor;
1346     const OwnPtr<VisitedLinkState> m_visitedLinkState;
1347
1348     bool m_visuallyOrdered;
1349     ReadyState m_readyState;
1350     bool m_bParsing;
1351
1352     Timer<Document> m_optimizedStyleSheetUpdateTimer;
1353     Timer<Document> m_styleRecalcTimer;
1354     bool m_pendingStyleRecalcShouldForce;
1355     bool m_inStyleRecalc;
1356     bool m_closeAfterStyleRecalc;
1357
1358     bool m_gotoAnchorNeededAfterStylesheetsLoad;
1359     bool m_isDNSPrefetchEnabled;
1360     bool m_haveExplicitlyDisabledDNSPrefetch;
1361     bool m_frameElementsShouldIgnoreScrolling;
1362     bool m_containsValidityStyleRules;
1363     bool m_updateFocusAppearanceRestoresSelection;
1364
1365     // http://www.whatwg.org/specs/web-apps/current-work/#ignore-destructive-writes-counter
1366     unsigned m_ignoreDestructiveWriteCount;
1367
1368     StringWithDirection m_title;
1369     StringWithDirection m_rawTitle;
1370     bool m_titleSetExplicitly;
1371     RefPtr<Element> m_titleElement;
1372
1373     OwnPtr<RenderArena> m_renderArena;
1374
1375     OwnPtr<AXObjectCache> m_axObjectCache;
1376     const OwnPtr<DocumentMarkerController> m_markers;
1377     
1378     Timer<Document> m_updateFocusAppearanceTimer;
1379
1380     Element* m_cssTarget;
1381
1382     // FIXME: Merge these 2 variables into an enum. Also, FrameLoader::m_didCallImplicitClose
1383     // is almost a duplication of this data, so that should probably get merged in too.
1384     // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
1385     // and should be merged.
1386     bool m_processingLoadEvent;
1387     bool m_loadEventFinished;
1388
1389     RefPtr<SerializedScriptValue> m_pendingStateObject;
1390     double m_startTime;
1391     bool m_overMinimumLayoutThreshold;
1392     
1393     OwnPtr<ScriptRunner> m_scriptRunner;
1394
1395     Vector<RefPtr<HTMLScriptElement> > m_currentScriptStack;
1396
1397 #if ENABLE(XSLT)
1398     OwnPtr<TransformSource> m_transformSource;
1399     RefPtr<Document> m_transformSourceDocument;
1400 #endif
1401
1402     String m_xmlEncoding;
1403     String m_xmlVersion;
1404     unsigned m_xmlStandalone : 2;
1405     unsigned m_hasXMLDeclaration : 1;
1406
1407     String m_contentLanguage;
1408
1409     RenderView* m_savedRenderView;
1410     
1411     RefPtr<TextResourceDecoder> m_decoder;
1412
1413     InheritedBool m_designMode;
1414
1415     HashSet<LiveNodeListBase*> m_listsInvalidatedAtDocument;
1416     unsigned m_nodeListCounts[numNodeListInvalidationTypes];
1417
1418     RefPtr<XPathEvaluator> m_xpathEvaluator;
1419
1420 #if ENABLE(SVG)
1421     OwnPtr<SVGDocumentExtensions> m_svgExtensions;
1422 #endif
1423
1424 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
1425     Vector<AnnotatedRegionValue> m_annotatedRegions;
1426     bool m_hasAnnotatedRegions;
1427     bool m_annotatedRegionsDirty;
1428 #endif
1429
1430     HashMap<String, RefPtr<HTMLCanvasElement> > m_cssCanvasElements;
1431
1432     bool m_createRenderers;
1433     bool m_inPageCache;
1434     Vector<IconURL> m_iconURLs;
1435
1436     HashSet<Element*> m_documentSuspensionCallbackElements;
1437     HashSet<Element*> m_mediaVolumeCallbackElements;
1438     HashSet<Element*> m_privateBrowsingStateChangedElements;
1439 #if ENABLE(VIDEO_TRACK)
1440     HashSet<Element*> m_captionPreferencesChangedElements;
1441 #endif
1442
1443     HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;
1444     bool m_accessKeyMapValid;
1445
1446     OwnPtr<SelectorQueryCache> m_selectorQueryCache;
1447
1448     DocumentClassFlags m_documentClasses;
1449
1450     bool m_isViewSource;
1451     bool m_sawElementsInKnownNamespaces;
1452     bool m_isSrcdocDocument;
1453
1454     RenderView* m_renderView;
1455     mutable DocumentEventQueue m_eventQueue;
1456
1457     WeakPtrFactory<Document> m_weakFactory;
1458
1459     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1460
1461     QualifiedName m_idAttributeName;
1462
1463 #if ENABLE(FULLSCREEN_API)
1464     bool m_areKeysEnabledInFullScreen;
1465     RefPtr<Element> m_fullScreenElement;
1466     Vector<RefPtr<Element> > m_fullScreenElementStack;
1467     RenderFullScreen* m_fullScreenRenderer;
1468     Timer<Document> m_fullScreenChangeDelayTimer;
1469     Deque<RefPtr<Node> > m_fullScreenChangeEventTargetQueue;
1470     Deque<RefPtr<Node> > m_fullScreenErrorEventTargetQueue;
1471     bool m_isAnimatingFullScreen;
1472     LayoutRect m_savedPlaceholderFrameRect;
1473     RefPtr<RenderStyle> m_savedPlaceholderRenderStyle;
1474 #endif
1475
1476     int m_loadEventDelayCount;
1477     Timer<Document> m_loadEventDelayTimer;
1478
1479     ViewportArguments m_viewportArguments;
1480
1481     ReferrerPolicy m_referrerPolicy;
1482
1483     bool m_directionSetOnDocumentElement;
1484     bool m_writingModeSetOnDocumentElement;
1485
1486 #if ENABLE(WEB_TIMING)
1487     DocumentTiming m_documentTiming;
1488 #endif
1489
1490     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1491     bool m_writeRecursionIsTooDeep;
1492     unsigned m_writeRecursionDepth;
1493     
1494     unsigned m_wheelEventHandlerCount;
1495 #if ENABLE(TOUCH_EVENTS)
1496     OwnPtr<TouchEventTargetSet> m_touchEventTargets;
1497 #endif
1498
1499     double m_lastHandledUserGestureTimestamp;
1500
1501 #if ENABLE(REQUEST_ANIMATION_FRAME)
1502     void clearScriptedAnimationController();
1503     RefPtr<ScriptedAnimationController> m_scriptedAnimationController;
1504 #endif
1505
1506     Timer<Document> m_pendingTasksTimer;
1507     Vector<OwnPtr<Task> > m_pendingTasks;
1508
1509 #if ENABLE(IOS_TEXT_AUTOSIZING)
1510 public:
1511     void addAutoSizingNode(Node*, float size);
1512     void validateAutoSizingNodes();
1513     void resetAutoSizingNodes();
1514
1515 private:
1516     typedef HashMap<TextAutoSizingKey, RefPtr<TextAutoSizingValue>, TextAutoSizingHash, TextAutoSizingTraits> TextAutoSizingMap;
1517     TextAutoSizingMap m_textAutoSizedNodes;
1518 #endif
1519
1520 #if ENABLE(TEXT_AUTOSIZING)
1521     OwnPtr<TextAutosizer> m_textAutosizer;
1522 #endif
1523
1524 #if ENABLE(CUSTOM_ELEMENTS)
1525     RefPtr<CustomElementRegistry> m_registry;
1526 #endif
1527
1528     bool m_scheduledTasksAreSuspended;
1529     
1530     bool m_visualUpdatesAllowed;
1531     Timer<Document> m_visualUpdatesSuppressionTimer;
1532
1533     RefPtr<NamedFlowCollection> m_namedFlows;
1534
1535 #if ENABLE(CSP_NEXT)
1536     RefPtr<DOMSecurityPolicy> m_domSecurityPolicy;
1537 #endif
1538
1539     void sharedObjectPoolClearTimerFired(Timer<Document>*);
1540     Timer<Document> m_sharedObjectPoolClearTimer;
1541
1542     OwnPtr<DocumentSharedObjectPool> m_sharedObjectPool;
1543
1544 #ifndef NDEBUG
1545     bool m_didDispatchViewportPropertiesChanged;
1546 #endif
1547
1548     typedef HashMap<AtomicString, OwnPtr<Locale> > LocaleIdentifierToLocaleMap;
1549     LocaleIdentifierToLocaleMap m_localeCache;
1550
1551 #if ENABLE(TEMPLATE_ELEMENT)
1552     RefPtr<Document> m_templateDocument;
1553     Document* m_templateDocumentHost; // Manually managed weakref (backpointer from m_templateDocument).
1554 #endif
1555
1556 #if ENABLE(FONT_LOAD_EVENTS)
1557     RefPtr<FontLoader> m_fontloader;
1558 #endif
1559
1560     Timer<Document> m_didAssociateFormControlsTimer;
1561     HashSet<RefPtr<Element> > m_associatedFormControls;
1562
1563     bool m_hasInjectedPlugInsScript;
1564     bool m_renderTreeBeingDestroyed;
1565 };
1566
1567 inline void Document::notifyRemovePendingSheetIfNeeded()
1568 {
1569     if (m_needsNotifyRemoveAllPendingStylesheet)
1570         didRemoveAllPendingStylesheet();
1571 }
1572
1573 #if ENABLE(TEMPLATE_ELEMENT)
1574 inline const Document* Document::templateDocument() const
1575 {
1576     // If DOCUMENT does not have a browsing context, Let TEMPLATE CONTENTS OWNER be DOCUMENT and abort these steps.
1577     if (!m_frame)
1578         return this;
1579
1580     return m_templateDocument.get();
1581 }
1582 #endif
1583
1584 inline Document* toDocument(ScriptExecutionContext* scriptExecutionContext)
1585 {
1586     ASSERT_WITH_SECURITY_IMPLICATION(!scriptExecutionContext || scriptExecutionContext->isDocument());
1587     return static_cast<Document*>(scriptExecutionContext);
1588 }
1589
1590 inline const Document* toDocument(const ScriptExecutionContext* scriptExecutionContext)
1591 {
1592     ASSERT_WITH_SECURITY_IMPLICATION(!scriptExecutionContext || scriptExecutionContext->isDocument());
1593     return static_cast<const Document*>(scriptExecutionContext);
1594 }
1595
1596 inline Document* toDocument(Node* node)
1597 {
1598     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isDocumentNode());
1599     return static_cast<Document*>(node);
1600 }
1601
1602 inline const Document* toDocument(const Node* node)
1603 {
1604     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isDocumentNode());
1605     return static_cast<const Document*>(node);
1606 }
1607
1608 // This will catch anyone doing an unnecessary cast.
1609 void toDocument(const Document*);
1610
1611 // Put these methods here, because they require the Document definition, but we really want to inline them.
1612
1613 inline bool Node::isDocumentNode() const
1614 {
1615     return this == documentInternal();
1616 }
1617
1618 inline Node::Node(Document* document, ConstructionType type)
1619     : m_nodeFlags(type)
1620     , m_parentNode(0)
1621     , m_treeScope(document ? document : TreeScope::noDocumentInstance())
1622     , m_previous(0)
1623     , m_next(0)
1624 {
1625     m_treeScope->selfOnlyRef();
1626
1627 #if !defined(NDEBUG) || (defined(DUMP_NODE_STATISTICS) && DUMP_NODE_STATISTICS)
1628     trackForDebugging();
1629 #endif
1630
1631     InspectorCounters::incrementCounter(InspectorCounters::NodeCounter);
1632 }
1633
1634 Node* eventTargetNodeForDocument(Document*);
1635
1636 } // namespace WebCore
1637
1638 namespace WTF {
1639 inline WebCore::Document* getPtr(WebCore::Document& p) { return &p; }
1640 }
1641
1642 #endif // Document_h