Move XPath from ExceptionCode to Exception
[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-2010, 2012-2013, 2015, 2016 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 #pragma once
29
30 #include "CollectionType.h"
31 #include "Color.h"
32 #include "ContainerNode.h"
33 #include "DocumentEventQueue.h"
34 #include "DocumentTiming.h"
35 #include "ExceptionOr.h"
36 #include "FocusDirection.h"
37 #include "FontSelectorClient.h"
38 #include "MediaProducer.h"
39 #include "MutationObserver.h"
40 #include "PageVisibilityState.h"
41 #include "PlatformEvent.h"
42 #include "ReferrerPolicy.h"
43 #include "Region.h"
44 #include "RenderPtr.h"
45 #include "ScriptExecutionContext.h"
46 #include "StringWithDirection.h"
47 #include "StyleChange.h"
48 #include "Supplementable.h"
49 #include "TextResourceDecoder.h"
50 #include "Timer.h"
51 #include "TreeScope.h"
52 #include "UserActionElementSet.h"
53 #include "ViewportArguments.h"
54 #include <chrono>
55 #include <memory>
56 #include <wtf/Deque.h>
57 #include <wtf/HashCountedSet.h>
58 #include <wtf/HashSet.h>
59 #include <wtf/PassRefPtr.h>
60 #include <wtf/WeakPtr.h>
61 #include <wtf/text/AtomicStringHash.h>
62
63 #if PLATFORM(IOS)
64 #include "EventTrackingRegions.h"
65 #endif
66
67 namespace JSC {
68 class ExecState;
69 #if ENABLE(WEB_REPLAY)
70 class InputCursor;
71 #endif
72 }
73
74 namespace WebCore {
75
76 class AXObjectCache;
77 class Attr;
78 class CDATASection;
79 class CSSFontSelector;
80 class CSSStyleDeclaration;
81 class CSSStyleSheet;
82 class CachedCSSStyleSheet;
83 class CachedResourceLoader;
84 class CachedScript;
85 class CanvasRenderingContext;
86 class CharacterData;
87 class Comment;
88 class DOMImplementation;
89 class DOMNamedFlowCollection;
90 class DOMSelection;
91 class DOMWindow;
92 class DOMWrapperWorld;
93 class Database;
94 class DatabaseThread;
95 class DocumentFragment;
96 class DocumentLoader;
97 class DocumentMarkerController;
98 class DocumentParser;
99 class DocumentSharedObjectPool;
100 class DocumentType;
101 class ExtensionStyleSheets;
102 class FloatRect;
103 class FloatQuad;
104 class FormController;
105 class Frame;
106 class FrameView;
107 class HTMLAllCollection;
108 class HTMLBodyElement;
109 class HTMLCanvasElement;
110 class HTMLCollection;
111 class HTMLDocument;
112 class HTMLElement;
113 class HTMLFrameOwnerElement;
114 class HTMLHeadElement;
115 class HTMLIFrameElement;
116 class HTMLImageElement;
117 class HTMLMapElement;
118 class HTMLMediaElement;
119 class HTMLPictureElement;
120 class HTMLScriptElement;
121 class HitTestRequest;
122 class HitTestResult;
123 class IntPoint;
124 class LayoutPoint;
125 class LayoutRect;
126 class LiveNodeList;
127 class ScriptModuleLoader;
128 class JSNode;
129 class Locale;
130 class Location;
131 class MediaCanStartListener;
132 class MediaPlaybackTarget;
133 class MediaPlaybackTargetClient;
134 class MediaQueryList;
135 class MediaQueryMatcher;
136 class ScriptModuleLoader;
137 class MouseEventWithHitTestResults;
138 class NamedFlowCollection;
139 class NodeFilter;
140 class NodeIterator;
141 class Page;
142 class PlatformMouseEvent;
143 class ProcessingInstruction;
144 class QualifiedName;
145 class Range;
146 class RenderView;
147 class RenderFullScreen;
148 class ScriptableDocumentParser;
149 class ScriptElementData;
150 class ScriptRunner;
151 class SecurityOrigin;
152 class SelectorQuery;
153 class SelectorQueryCache;
154 class SerializedScriptValue;
155 class SegmentedString;
156 class Settings;
157 class StyleResolver;
158 class StyleSheet;
159 class StyleSheetContents;
160 class StyleSheetList;
161 class SVGDocumentExtensions;
162 class SVGSVGElement;
163 class Text;
164 class TextResourceDecoder;
165 class TreeWalker;
166 class VisitedLinkState;
167 class WebKitNamedFlow;
168 class XMLHttpRequest;
169 class XPathEvaluator;
170 class XPathExpression;
171 class XPathNSResolver;
172 class XPathResult;
173
174 enum class ShouldOpenExternalURLsPolicy;
175
176 using PlatformDisplayID = uint32_t;
177
178 #if ENABLE(XSLT)
179 class TransformSource;
180 #endif
181
182 #if ENABLE(DASHBOARD_SUPPORT)
183 struct AnnotatedRegionValue;
184 #endif
185
186 #if ENABLE(IOS_TOUCH_EVENTS)
187 #include <WebKitAdditions/DocumentIOSForward.h>
188 #endif
189
190 #if ENABLE(TOUCH_EVENTS) || ENABLE(IOS_TOUCH_EVENTS)
191 class Touch;
192 class TouchList;
193 #endif
194
195 #if ENABLE(REQUEST_ANIMATION_FRAME)
196 class RequestAnimationFrameCallback;
197 class ScriptedAnimationController;
198 #endif
199
200 class FontFaceSet;
201
202 typedef int ExceptionCode;
203
204 #if PLATFORM(IOS)
205 class DeviceMotionClient;
206 class DeviceMotionController;
207 class DeviceOrientationClient;
208 class DeviceOrientationController;
209 #endif
210
211 #if ENABLE(TEXT_AUTOSIZING)
212 struct TextAutoSizingHash;
213 class TextAutoSizingKey;
214 class TextAutoSizingValue;
215
216 struct TextAutoSizingTraits : WTF::GenericHashTraits<TextAutoSizingKey> {
217     static const bool emptyValueIsZero = true;
218     static void constructDeletedValue(TextAutoSizingKey& slot);
219     static bool isDeletedValue(const TextAutoSizingKey& value);
220 };
221 #endif
222
223 #if ENABLE(MEDIA_SESSION)
224 class MediaSession;
225 #endif
226
227 namespace Style {
228 class Scope;
229 };
230
231 const uint64_t HTMLMediaElementInvalidID = 0;
232
233 enum PageshowEventPersistence {
234     PageshowEventNotPersisted = 0,
235     PageshowEventPersisted = 1
236 };
237
238 enum NodeListInvalidationType {
239     DoNotInvalidateOnAttributeChanges = 0,
240     InvalidateOnClassAttrChange,
241     InvalidateOnIdNameAttrChange,
242     InvalidateOnNameAttrChange,
243     InvalidateOnForAttrChange,
244     InvalidateForFormControls,
245     InvalidateOnHRefAttrChange,
246     InvalidateOnAnyAttrChange,
247 };
248 const int numNodeListInvalidationTypes = InvalidateOnAnyAttrChange + 1;
249
250 enum class EventHandlerRemoval { One, All };
251 typedef HashCountedSet<Node*> EventTargetSet;
252
253 enum DocumentClass {
254     DefaultDocumentClass = 0,
255     HTMLDocumentClass = 1,
256     XHTMLDocumentClass = 1 << 1,
257     ImageDocumentClass = 1 << 2,
258     PluginDocumentClass = 1 << 3,
259     MediaDocumentClass = 1 << 4,
260     SVGDocumentClass = 1 << 5,
261     TextDocumentClass = 1 << 6,
262     XMLDocumentClass = 1 << 7,
263 };
264
265 typedef unsigned char DocumentClassFlags;
266
267 enum class DocumentCompatibilityMode : unsigned char {
268     NoQuirksMode = 1,
269     QuirksMode = 1 << 1,
270     LimitedQuirksMode = 1 << 2
271 };
272
273 enum DimensionsCheck { WidthDimensionsCheck = 1 << 0, HeightDimensionsCheck = 1 << 1, AllDimensionsCheck = 1 << 2 };
274
275 enum class SelectionRestorationMode {
276     Restore,
277     SetDefault,
278 };
279
280 enum class HttpEquivPolicy {
281     Enabled,
282     DisabledBySettings,
283     DisabledByContentDispositionAttachmentSandbox
284 };
285
286 enum class CustomElementNameValidationStatus { Valid, ConflictsWithBuiltinNames, NoHyphen, ContainsUpperCase };
287
288 class Document
289     : public ContainerNode
290     , public TreeScope
291     , public ScriptExecutionContext
292     , public FontSelectorClient
293     , public Supplementable<Document> {
294 public:
295     static Ref<Document> create(Frame* frame, const URL& url)
296     {
297         return adoptRef(*new Document(frame, url));
298     }
299
300     static Ref<Document> createNonRenderedPlaceholder(Frame* frame, const URL& url)
301     {
302         return adoptRef(*new Document(frame, url, DefaultDocumentClass, NonRenderedPlaceholder));
303     }
304     static Ref<Document> create(Document&);
305
306     virtual ~Document();
307
308     // Nodes belonging to this document increase referencingNodeCount -
309     // these are enough to keep the document from being destroyed, but
310     // not enough to keep it from removing its children. This allows a
311     // node that outlives its document to still have a valid document
312     // pointer without introducing reference cycles.
313     void incrementReferencingNodeCount()
314     {
315         ASSERT(!m_deletionHasBegun);
316         ++m_referencingNodeCount;
317     }
318
319     void decrementReferencingNodeCount()
320     {
321         ASSERT(!m_deletionHasBegun || !m_referencingNodeCount);
322         --m_referencingNodeCount;
323         if (!m_referencingNodeCount && !refCount()) {
324 #if !ASSERT_DISABLED
325             m_deletionHasBegun = true;
326 #endif
327             delete this;
328         }
329     }
330
331     unsigned referencingNodeCount() const { return m_referencingNodeCount; }
332
333     void removedLastRef();
334
335     WEBCORE_EXPORT static HashSet<Document*>& allDocuments();
336
337     MediaQueryMatcher& mediaQueryMatcher();
338
339     using ContainerNode::ref;
340     using ContainerNode::deref;
341     using TreeScope::rootNode;
342
343     bool canContainRangeEndPoint() const final { return true; }
344
345     Element* getElementByAccessKey(const String& key);
346     void invalidateAccessKeyMap();
347
348     void addImageElementByCaseFoldedUsemap(const AtomicStringImpl&, HTMLImageElement&);
349     void removeImageElementByCaseFoldedUsemap(const AtomicStringImpl&, HTMLImageElement&);
350     HTMLImageElement* imageElementByCaseFoldedUsemap(const AtomicStringImpl&) const;
351
352     SelectorQuery* selectorQueryForString(const String&, ExceptionCode&);
353     void clearSelectorQueryCache();
354
355     // DOM methods & attributes for Document
356
357     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
358     ViewportArguments viewportArguments() const { return m_viewportArguments; }
359 #ifndef NDEBUG
360     bool didDispatchViewportPropertiesChanged() const { return m_didDispatchViewportPropertiesChanged; }
361 #endif
362
363     void setReferrerPolicy(ReferrerPolicy referrerPolicy) { m_referrerPolicy = referrerPolicy; }
364     ReferrerPolicy referrerPolicy() const { return m_referrerPolicy; }
365
366     WEBCORE_EXPORT DocumentType* doctype() const;
367
368     WEBCORE_EXPORT DOMImplementation& implementation();
369     
370     Element* documentElement() const
371     {
372         return m_documentElement.get();
373     }
374     static ptrdiff_t documentElementMemoryOffset() { return OBJECT_OFFSETOF(Document, m_documentElement); }
375
376     WEBCORE_EXPORT Element* activeElement();
377     WEBCORE_EXPORT bool hasFocus() const;
378
379     bool hasManifest() const;
380     
381     WEBCORE_EXPORT RefPtr<Element> createElementForBindings(const AtomicString& tagName, ExceptionCode&);
382     WEBCORE_EXPORT Ref<DocumentFragment> createDocumentFragment();
383     WEBCORE_EXPORT Ref<Text> createTextNode(const String& data);
384     WEBCORE_EXPORT Ref<Comment> createComment(const String& data);
385     WEBCORE_EXPORT RefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
386     WEBCORE_EXPORT RefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
387     WEBCORE_EXPORT RefPtr<Attr> createAttribute(const String& name, ExceptionCode&);
388     WEBCORE_EXPORT RefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&, bool shouldIgnoreNamespaceChecks = false);
389     WEBCORE_EXPORT RefPtr<Node> importNode(Node& nodeToImport, bool deep, ExceptionCode&);
390     WEBCORE_EXPORT RefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
391     WEBCORE_EXPORT Ref<Element> createElement(const QualifiedName&, bool createdByParser);
392
393     static CustomElementNameValidationStatus validateCustomElementName(const AtomicString&);
394
395 #if ENABLE(CSS_GRID_LAYOUT)
396     bool isCSSGridLayoutEnabled() const;
397 #endif
398 #if ENABLE(CSS_REGIONS)
399     RefPtr<DOMNamedFlowCollection> webkitGetNamedFlows();
400 #endif
401
402     NamedFlowCollection& namedFlows();
403
404     WEBCORE_EXPORT RefPtr<Range> caretRangeFromPoint(int x, int y);
405     RefPtr<Range> caretRangeFromPoint(const LayoutPoint& clientPoint);
406
407     WEBCORE_EXPORT Element* scrollingElement();
408
409     WEBCORE_EXPORT String readyState() const;
410
411     WEBCORE_EXPORT String defaultCharsetForLegacyBindings() const;
412
413     String charset() const { return Document::encoding(); }
414     WEBCORE_EXPORT String characterSetWithUTF8Fallback() const;
415     TextEncoding textEncoding() const;
416
417     AtomicString encoding() const { return textEncoding().domName(); }
418
419     WEBCORE_EXPORT void setCharset(const String&); // Used by ObjC / GOBject bindings only.
420
421     void setContent(const String&);
422
423     String suggestedMIMEType() const;
424
425     void overrideMIMEType(const String&);
426     WEBCORE_EXPORT String contentType() const;
427
428     String contentLanguage() const { return m_contentLanguage; }
429     void setContentLanguage(const String&);
430
431     String xmlEncoding() const { return m_xmlEncoding; }
432     String xmlVersion() const { return m_xmlVersion; }
433     enum StandaloneStatus { StandaloneUnspecified, Standalone, NotStandalone };
434     bool xmlStandalone() const { return m_xmlStandalone == Standalone; }
435     StandaloneStatus xmlStandaloneStatus() const { return static_cast<StandaloneStatus>(m_xmlStandalone); }
436     bool hasXMLDeclaration() const { return m_hasXMLDeclaration; }
437
438     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
439     WEBCORE_EXPORT void setXMLVersion(const String&, ExceptionCode&);
440     WEBCORE_EXPORT void setXMLStandalone(bool);
441     void setHasXMLDeclaration(bool hasXMLDeclaration) { m_hasXMLDeclaration = hasXMLDeclaration ? 1 : 0; }
442
443     String documentURI() const { return m_documentURI; }
444     WEBCORE_EXPORT void setDocumentURI(const String&);
445
446 #if ENABLE(WEB_REPLAY)
447     JSC::InputCursor& inputCursor();
448     void setInputCursor(Ref<JSC::InputCursor>&&);
449 #endif
450
451     void visibilityStateChanged();
452     WEBCORE_EXPORT String visibilityState() const;
453     WEBCORE_EXPORT bool hidden() const;
454
455     void setTimerThrottlingEnabled(bool);
456     bool isTimerThrottlingEnabled() const { return m_isTimerThrottlingEnabled; }
457
458     WEBCORE_EXPORT RefPtr<Node> adoptNode(Node& source, ExceptionCode&);
459
460     WEBCORE_EXPORT Ref<HTMLCollection> images();
461     WEBCORE_EXPORT Ref<HTMLCollection> embeds();
462     WEBCORE_EXPORT Ref<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
463     WEBCORE_EXPORT Ref<HTMLCollection> applets();
464     WEBCORE_EXPORT Ref<HTMLCollection> links();
465     WEBCORE_EXPORT Ref<HTMLCollection> forms();
466     WEBCORE_EXPORT Ref<HTMLCollection> anchors();
467     WEBCORE_EXPORT Ref<HTMLCollection> scripts();
468     Ref<HTMLCollection> all();
469
470     Ref<HTMLCollection> windowNamedItems(const AtomicString& name);
471     Ref<HTMLCollection> documentNamedItems(const AtomicString& name);
472
473     // Other methods (not part of DOM)
474     bool isSynthesized() const { return m_isSynthesized; }
475     bool isHTMLDocument() const { return m_documentClasses & HTMLDocumentClass; }
476     bool isXHTMLDocument() const { return m_documentClasses & XHTMLDocumentClass; }
477     bool isXMLDocument() const { return m_documentClasses & XMLDocumentClass; }
478     bool isImageDocument() const { return m_documentClasses & ImageDocumentClass; }
479     bool isSVGDocument() const { return m_documentClasses & SVGDocumentClass; }
480     bool isPluginDocument() const { return m_documentClasses & PluginDocumentClass; }
481     bool isMediaDocument() const { return m_documentClasses & MediaDocumentClass; }
482     bool isTextDocument() const { return m_documentClasses & TextDocumentClass; }
483     bool hasSVGRootNode() const;
484     virtual bool isFrameSet() const { return false; }
485
486     static ptrdiff_t documentClassesMemoryOffset() { return OBJECT_OFFSETOF(Document, m_documentClasses); }
487     static uint32_t isHTMLDocumentClassFlag() { return HTMLDocumentClass; }
488
489     bool isSrcdocDocument() const { return m_isSrcdocDocument; }
490
491     bool sawElementsInKnownNamespaces() const { return m_sawElementsInKnownNamespaces; }
492
493     StyleResolver& userAgentShadowTreeStyleResolver();
494
495     CSSFontSelector& fontSelector() { return m_fontSelector; }
496
497     void notifyRemovePendingSheetIfNeeded();
498
499     WEBCORE_EXPORT bool haveStylesheetsLoaded() const;
500
501     WEBCORE_EXPORT StyleSheetList& styleSheets();
502
503     Style::Scope& styleScope() { return *m_styleScope; }
504     const Style::Scope& styleScope() const { return *m_styleScope; }
505     ExtensionStyleSheets& extensionStyleSheets() { return *m_extensionStyleSheets; }
506     const ExtensionStyleSheets& extensionStyleSheets() const { return *m_extensionStyleSheets; }
507
508     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
509     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
510
511     void evaluateMediaQueryList();
512
513     FormController& formController();
514     Vector<String> formElementsState() const;
515     void setStateForNewFormElements(const Vector<String>&);
516
517     WEBCORE_EXPORT FrameView* view() const; // can be NULL
518     Frame* frame() const { return m_frame; } // can be NULL
519     WEBCORE_EXPORT Page* page() const; // can be NULL
520     WEBCORE_EXPORT Settings* settings() const; // can be NULL
521
522     float deviceScaleFactor() const;
523
524     WEBCORE_EXPORT Ref<Range> createRange();
525
526     // The last bool parameter is for ObjC bindings.
527     WEBCORE_EXPORT Ref<NodeIterator> createNodeIterator(Node& root, unsigned long whatToShow = 0xFFFFFFFF, RefPtr<NodeFilter>&& = nullptr, bool = false);
528
529     // The last bool parameter is for ObjC bindings.
530     WEBCORE_EXPORT Ref<TreeWalker> createTreeWalker(Node& root, unsigned long whatToShow = 0xFFFFFFFF, RefPtr<NodeFilter>&& = nullptr, bool = false);
531
532     // Special support for editing
533     WEBCORE_EXPORT Ref<CSSStyleDeclaration> createCSSStyleDeclaration();
534     Ref<Text> createEditingTextNode(const String&);
535
536     void recalcStyle(Style::Change = Style::NoChange);
537     WEBCORE_EXPORT void updateStyleIfNeeded();
538     bool needsStyleRecalc() const;
539     unsigned lastStyleUpdateSizeForTesting() const { return m_lastStyleUpdateSizeForTesting; }
540
541     WEBCORE_EXPORT void updateLayout();
542     
543     // updateLayoutIgnorePendingStylesheets() forces layout even if we are waiting for pending stylesheet loads,
544     // so calling this may cause a flash of unstyled content (FOUC).
545     enum class RunPostLayoutTasks {
546         Asynchronously,
547         Synchronously,
548     };
549     WEBCORE_EXPORT void updateLayoutIgnorePendingStylesheets(RunPostLayoutTasks = RunPostLayoutTasks::Asynchronously);
550
551     std::unique_ptr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element&, const RenderStyle* parentStyle);
552
553     // Returns true if page box (margin boxes and page borders) is visible.
554     WEBCORE_EXPORT bool isPageBoxVisible(int pageIndex);
555
556     // Returns the preferred page size and margins in pixels, assuming 96
557     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
558     // marginLeft must be initialized to the default values that are used if
559     // auto is specified.
560     WEBCORE_EXPORT void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
561
562     CachedResourceLoader& cachedResourceLoader() { return m_cachedResourceLoader; }
563
564     void didBecomeCurrentDocumentInFrame();
565     void destroyRenderTree();
566     void disconnectFromFrame();
567     void prepareForDestruction();
568
569     // Override ScriptExecutionContext methods to do additional work
570     bool shouldBypassMainWorldContentSecurityPolicy() const final;
571     void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) final;
572     void resumeActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) final;
573     void stopActiveDOMObjects() final;
574
575     void suspendDeviceMotionAndOrientationUpdates();
576     void resumeDeviceMotionAndOrientationUpdates();
577
578     RenderView* renderView() const { return m_renderView.get(); }
579
580     bool renderTreeBeingDestroyed() const { return m_renderTreeBeingDestroyed; }
581     bool hasLivingRenderTree() const { return renderView() && !renderTreeBeingDestroyed(); }
582     
583     bool updateLayoutIfDimensionsOutOfDate(Element&, DimensionsCheck = AllDimensionsCheck);
584     
585     AXObjectCache* existingAXObjectCache() const;
586     WEBCORE_EXPORT AXObjectCache* axObjectCache() const;
587     void clearAXObjectCache();
588
589     // to get visually ordered hebrew and arabic pages right
590     void setVisuallyOrdered();
591     bool visuallyOrdered() const { return m_visuallyOrdered; }
592     
593     WEBCORE_EXPORT DocumentLoader* loader() const;
594
595     WEBCORE_EXPORT void open(Document* ownerDocument = nullptr);
596     void implicitOpen();
597
598     // close() is the DOM API document.close()
599     WEBCORE_EXPORT void close();
600     // In some situations (see the code), we ignore document.close().
601     // explicitClose() bypass these checks and actually tries to close the
602     // input stream.
603     void explicitClose();
604     // implicitClose() actually does the work of closing the input stream.
605     void implicitClose();
606
607     void cancelParsing();
608
609     void write(const SegmentedString& text, Document* ownerDocument = nullptr);
610     WEBCORE_EXPORT void write(const String& text, Document* ownerDocument = nullptr);
611     WEBCORE_EXPORT void writeln(const String& text, Document* ownerDocument = nullptr);
612
613     bool wellFormed() const { return m_wellFormed; }
614
615     const URL& url() const final { return m_url; }
616     void setURL(const URL&);
617     const URL& urlForBindings() const { return m_url.isEmpty() ? blankURL() : m_url; }
618
619     // To understand how these concepts relate to one another, please see the
620     // comments surrounding their declaration.
621     const URL& baseURL() const { return m_baseURL; }
622     void setBaseURLOverride(const URL&);
623     const URL& baseURLOverride() const { return m_baseURLOverride; }
624     const URL& baseElementURL() const { return m_baseElementURL; }
625     const String& baseTarget() const { return m_baseTarget; }
626     void processBaseElement();
627
628     WEBCORE_EXPORT URL completeURL(const String&) const final;
629     URL completeURL(const String&, const URL& baseURLOverride) const;
630
631     String userAgent(const URL&) const final;
632
633     void disableEval(const String& errorMessage) final;
634
635 #if ENABLE(INDEXED_DATABASE)
636     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
637 #endif
638 #if ENABLE(WEB_SOCKETS)
639     SocketProvider* socketProvider() final;
640 #endif
641
642     bool canNavigate(Frame* targetFrame);
643     Frame* findUnsafeParentScrollPropagationBoundary();
644
645     bool usesStyleBasedEditability() const;
646     void setHasElementUsingStyleBasedEditability();
647     
648     virtual Ref<DocumentParser> createParser();
649     DocumentParser* parser() const { return m_parser.get(); }
650     ScriptableDocumentParser* scriptableDocumentParser() const;
651     
652     bool printing() const { return m_printing; }
653     void setPrinting(bool p) { m_printing = p; }
654
655     bool paginatedForScreen() const { return m_paginatedForScreen; }
656     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
657     
658     bool paginated() const { return printing() || paginatedForScreen(); }
659
660     void setCompatibilityMode(DocumentCompatibilityMode);
661     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
662     static ptrdiff_t compatibilityModeMemoryOffset() { return OBJECT_OFFSETOF(Document, m_compatibilityMode); }
663
664     WEBCORE_EXPORT String compatMode() const;
665
666     bool inQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::QuirksMode; }
667     bool inLimitedQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::LimitedQuirksMode; }
668     bool inNoQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::NoQuirksMode; }
669
670     enum ReadyState {
671         Loading,
672         Interactive,
673         Complete
674     };
675     void setReadyState(ReadyState);
676     void setParsing(bool);
677     bool parsing() const { return m_bParsing; }
678     std::chrono::milliseconds minimumLayoutDelay();
679
680     bool shouldScheduleLayout();
681     bool isLayoutTimerActive();
682     std::chrono::milliseconds elapsedTime() const;
683     
684     void setTextColor(const Color& color) { m_textColor = color; }
685     const Color& textColor() const { return m_textColor; }
686
687     const Color& linkColor() const { return m_linkColor; }
688     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
689     const Color& activeLinkColor() const { return m_activeLinkColor; }
690     void setLinkColor(const Color& c) { m_linkColor = c; }
691     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
692     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
693     void resetLinkColor();
694     void resetVisitedLinkColor();
695     void resetActiveLinkColor();
696     VisitedLinkState& visitedLinkState() const { return *m_visitedLinkState; }
697
698     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const LayoutPoint&, const PlatformMouseEvent&);
699
700     WEBCORE_EXPORT String preferredStylesheetSet() const;
701     WEBCORE_EXPORT String selectedStylesheetSet() const;
702     WEBCORE_EXPORT void setSelectedStylesheetSet(const String&);
703
704     enum class FocusRemovalEventsMode { Dispatch, DoNotDispatch };
705     WEBCORE_EXPORT bool setFocusedElement(Element*, FocusDirection = FocusDirectionNone,
706         FocusRemovalEventsMode = FocusRemovalEventsMode::Dispatch);
707     Element* focusedElement() const { return m_focusedElement.get(); }
708     UserActionElementSet& userActionElements()  { return m_userActionElements; }
709     const UserActionElementSet& userActionElements() const { return m_userActionElements; }
710
711     void setFocusNavigationStartingNode(Node*);
712     Element* focusNavigationStartingNode(FocusDirection) const;
713
714     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
715     void hoveredElementDidDetach(Element*);
716     void elementInActiveChainDidDetach(Element*);
717
718     void updateHoverActiveState(const HitTestRequest&, Element*);
719
720     // Updates for :target (CSS3 selector).
721     void setCSSTarget(Element*);
722     Element* cssTarget() const { return m_cssTarget; }
723     static ptrdiff_t cssTargetMemoryOffset() { return OBJECT_OFFSETOF(Document, m_cssTarget); }
724
725     WEBCORE_EXPORT void scheduleForcedStyleRecalc();
726     void scheduleStyleRecalc();
727     void unscheduleStyleRecalc();
728     bool hasPendingStyleRecalc() const;
729     bool hasPendingForcedStyleRecalc() const;
730
731     void registerNodeListForInvalidation(LiveNodeList&);
732     void unregisterNodeListForInvalidation(LiveNodeList&);
733     WEBCORE_EXPORT void registerCollection(HTMLCollection&);
734     void unregisterCollection(HTMLCollection&);
735     void collectionCachedIdNameMap(const HTMLCollection&);
736     void collectionWillClearIdNameMap(const HTMLCollection&);
737     bool shouldInvalidateNodeListAndCollectionCaches(const QualifiedName* attrName = nullptr) const;
738     void invalidateNodeListAndCollectionCaches(const QualifiedName* attrName);
739
740     void attachNodeIterator(NodeIterator*);
741     void detachNodeIterator(NodeIterator*);
742     void moveNodeIteratorsToNewDocument(Node*, Document*);
743
744     void attachRange(Range*);
745     void detachRange(Range*);
746
747     void updateRangesAfterChildrenChanged(ContainerNode&);
748     // nodeChildrenWillBeRemoved is used when removing all node children at once.
749     void nodeChildrenWillBeRemoved(ContainerNode&);
750     // nodeWillBeRemoved is only safe when removing one node at a time.
751     void nodeWillBeRemoved(Node&);
752     void removeFocusNavigationNodeOfSubtree(Node&, bool amongChildrenOnly = false);
753     enum class AcceptChildOperation { Replace, InsertOrAdd };
754     bool canAcceptChild(const Node& newChild, const Node* refChild, AcceptChildOperation) const;
755
756     void textInserted(Node*, unsigned offset, unsigned length);
757     void textRemoved(Node*, unsigned offset, unsigned length);
758     void textNodesMerged(Text* oldNode, unsigned offset);
759     void textNodeSplit(Text* oldNode);
760
761     void createDOMWindow();
762     void takeDOMWindowFrom(Document*);
763
764     DOMWindow* domWindow() const { return m_domWindow.get(); }
765     // In DOM Level 2, the Document's DOMWindow is called the defaultView.
766     DOMWindow* defaultView() const { return domWindow(); } 
767
768     Document& contextDocument() const;
769     void setContextDocument(Document& document) { m_contextDocument = document.createWeakPtr(); }
770
771     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
772     void setWindowAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
773     void setWindowAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
774     EventListener* getWindowAttributeEventListener(const AtomicString& eventType);
775     WEBCORE_EXPORT void dispatchWindowEvent(Event&, EventTarget* = nullptr);
776     void dispatchWindowLoadEvent();
777
778     WEBCORE_EXPORT RefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
779
780     // keep track of what types of event listeners are registered, so we don't
781     // dispatch events unnecessarily
782     enum ListenerType {
783         DOMSUBTREEMODIFIED_LISTENER          = 1,
784         DOMNODEINSERTED_LISTENER             = 1 << 1,
785         DOMNODEREMOVED_LISTENER              = 1 << 2,
786         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 1 << 3,
787         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 1 << 4,
788         DOMCHARACTERDATAMODIFIED_LISTENER    = 1 << 5,
789         OVERFLOWCHANGED_LISTENER             = 1 << 6,
790         ANIMATIONEND_LISTENER                = 1 << 7,
791         ANIMATIONSTART_LISTENER              = 1 << 8,
792         ANIMATIONITERATION_LISTENER          = 1 << 9,
793         TRANSITIONEND_LISTENER               = 1 << 10,
794         BEFORELOAD_LISTENER                  = 1 << 11,
795         SCROLL_LISTENER                      = 1 << 12,
796         FORCEWILLBEGIN_LISTENER              = 1 << 13,
797         FORCECHANGED_LISTENER                = 1 << 14,
798         FORCEDOWN_LISTENER                   = 1 << 15,
799         FORCEUP_LISTENER                     = 1 << 16
800     };
801
802     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
803     bool hasListenerTypeForEventType(PlatformEvent::Type) const;
804     void addListenerTypeIfNeeded(const AtomicString& eventType);
805
806     bool hasMutationObserversOfType(MutationObserver::MutationType type) const
807     {
808         return m_mutationObserverTypes & type;
809     }
810     bool hasMutationObservers() const { return m_mutationObserverTypes; }
811     void addMutationObserverTypes(MutationObserverOptions types) { m_mutationObserverTypes |= types; }
812
813     WEBCORE_EXPORT CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
814
815     // Handles an HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
816     // when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
817     // tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
818     // specified in an HTML file.
819     void processHttpEquiv(const String& equiv, const String& content, bool isInDocumentHead);
820
821 #if PLATFORM(IOS)
822     void processFormatDetection(const String&);
823
824     // Called when <meta name="apple-mobile-web-app-orientations"> changes.
825     void processWebAppOrientations();
826 #endif
827     
828     void processViewport(const String& features, ViewportArguments::Type origin);
829     void updateViewportArguments();
830     void processReferrerPolicy(const String& policy);
831
832     // Returns the owning element in the parent document.
833     // Returns 0 if this is the top level document.
834     HTMLFrameOwnerElement* ownerElement() const;
835
836     // Used by DOM bindings; no direction known.
837     String title() const { return m_title.string(); }
838     WEBCORE_EXPORT void setTitle(const String&);
839
840     WEBCORE_EXPORT const AtomicString& dir() const;
841     WEBCORE_EXPORT void setDir(const AtomicString&);
842
843     void titleElementAdded(Element& titleElement);
844     void titleElementRemoved(Element& titleElement);
845     void titleElementTextChanged(Element& titleElement);
846
847     WEBCORE_EXPORT String cookie(ExceptionCode&);
848     WEBCORE_EXPORT void setCookie(const String&, ExceptionCode&);
849
850     WEBCORE_EXPORT String referrer() const;
851
852     WEBCORE_EXPORT String origin() const;
853
854     WEBCORE_EXPORT String domain() const;
855     void setDomain(const String& newDomain, ExceptionCode&);
856
857     WEBCORE_EXPORT String lastModified();
858
859     // The cookieURL is used to query the cookie database for this document's
860     // cookies. For example, if the cookie URL is http://example.com, we'll
861     // use the non-Secure cookies for example.com when computing
862     // document.cookie.
863     //
864     // Q: How is the cookieURL different from the document's URL?
865     // A: The two URLs are the same almost all the time.  However, if one
866     //    document inherits the security context of another document, it
867     //    inherits its cookieURL but not its URL.
868     //
869     const URL& cookieURL() const { return m_cookieURL; }
870     void setCookieURL(const URL&);
871
872     // The firstPartyForCookies is used to compute whether this document
873     // appears in a "third-party" context for the purpose of third-party
874     // cookie blocking.  The document is in a third-party context if the
875     // cookieURL and the firstPartyForCookies are from different hosts.
876     //
877     // Note: Some ports (including possibly Apple's) only consider the
878     //       document in a third-party context if the cookieURL and the
879     //       firstPartyForCookies have a different registry-controlled
880     //       domain.
881     //
882     const URL& firstPartyForCookies() const { return m_firstPartyForCookies; }
883     void setFirstPartyForCookies(const URL& url) { m_firstPartyForCookies = url; }
884     
885     // The following implements the rule from HTML 4 for what valid names are.
886     // To get this right for all the XML cases, we probably have to improve this or move it
887     // and make it sensitive to the type of document.
888     static bool isValidName(const String&);
889
890     // The following breaks a qualified name into a prefix and a local name.
891     // It also does a validity check, and returns false if the qualified name
892     // is invalid.  It also sets ExceptionCode when name is invalid.
893     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
894
895     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
896     static bool hasValidNamespaceForElements(const QualifiedName&);
897     static bool hasValidNamespaceForAttributes(const QualifiedName&);
898
899     HTMLBodyElement* body() const;
900     WEBCORE_EXPORT HTMLElement* bodyOrFrameset() const;
901     WEBCORE_EXPORT void setBodyOrFrameset(RefPtr<HTMLElement>&&, ExceptionCode&);
902
903     Location* location() const;
904
905     WEBCORE_EXPORT HTMLHeadElement* head();
906
907     DocumentMarkerController& markers() const { return *m_markers; }
908
909     WEBCORE_EXPORT bool execCommand(const String& command, bool userInterface = false, const String& value = String());
910     WEBCORE_EXPORT bool queryCommandEnabled(const String& command);
911     WEBCORE_EXPORT bool queryCommandIndeterm(const String& command);
912     WEBCORE_EXPORT bool queryCommandState(const String& command);
913     WEBCORE_EXPORT bool queryCommandSupported(const String& command);
914     WEBCORE_EXPORT String queryCommandValue(const String& command);
915
916     // designMode support
917     enum InheritedBool { off = false, on = true, inherit };    
918     void setDesignMode(InheritedBool value);
919     InheritedBool getDesignMode() const;
920     bool inDesignMode() const;
921     WEBCORE_EXPORT String designMode() const;
922     WEBCORE_EXPORT void setDesignMode(const String&);
923
924     Document* parentDocument() const;
925     Document& topDocument() const;
926     
927     ScriptRunner* scriptRunner() { return m_scriptRunner.get(); }
928     ScriptModuleLoader* moduleLoader() { return m_moduleLoader.get(); }
929
930     HTMLScriptElement* currentScript() const { return !m_currentScriptStack.isEmpty() ? m_currentScriptStack.last().get() : nullptr; }
931     void pushCurrentScript(HTMLScriptElement*);
932     void popCurrentScript();
933
934 #if ENABLE(XSLT)
935     void applyXSLTransform(ProcessingInstruction* pi);
936     RefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
937     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
938
939     void setTransformSource(std::unique_ptr<TransformSource>);
940     TransformSource* transformSource() const { return m_transformSource.get(); }
941 #endif
942
943     void incDOMTreeVersion() { m_domTreeVersion = ++s_globalTreeVersion; }
944     uint64_t domTreeVersion() const { return m_domTreeVersion; }
945
946     // XPathEvaluator methods
947     WEBCORE_EXPORT ExceptionOr<Ref<XPathExpression>> createExpression(const String& expression, RefPtr<XPathNSResolver>&&);
948     WEBCORE_EXPORT Ref<XPathNSResolver> createNSResolver(Node* nodeResolver);
949     WEBCORE_EXPORT ExceptionOr<Ref<XPathResult>> evaluate(const String& expression, Node* contextNode, RefPtr<XPathNSResolver>&&, unsigned short type, XPathResult*);
950
951     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
952
953     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
954
955     bool hasNodesWithPlaceholderStyle() const { return m_hasNodesWithPlaceholderStyle; }
956     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
957
958     void updateFocusAppearanceSoon(SelectionRestorationMode);
959     void cancelFocusAppearanceUpdate();
960
961     // Extension for manipulating canvas drawing contexts for use in CSS
962     CanvasRenderingContext* getCSSCanvasContext(const String& type, const String& name, int width, int height);
963     HTMLCanvasElement* getCSSCanvasElement(const String& name);
964
965     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
966     void parseDNSPrefetchControlHeader(const String&);
967
968     void postTask(Task&&) final; // Executes the task on context's thread asynchronously.
969
970 #if ENABLE(REQUEST_ANIMATION_FRAME)
971     ScriptedAnimationController* scriptedAnimationController() { return m_scriptedAnimationController.get(); }
972 #endif
973     void suspendScriptedAnimationControllerCallbacks();
974     void resumeScriptedAnimationControllerCallbacks();
975     void scriptedAnimationControllerSetThrottled(bool);
976     
977     void windowScreenDidChange(PlatformDisplayID);
978
979     void finishedParsing();
980
981     enum PageCacheState { NotInPageCache, AboutToEnterPageCache, InPageCache };
982
983     PageCacheState pageCacheState() const { return m_pageCacheState; }
984     void setPageCacheState(PageCacheState);
985
986     // Elements can register themselves for the "suspend()" and
987     // "resume()" callbacks
988     void registerForDocumentSuspensionCallbacks(Element*);
989     void unregisterForDocumentSuspensionCallbacks(Element*);
990
991     void documentWillBecomeInactive();
992     void suspend(ActiveDOMObject::ReasonForSuspension);
993     void resume(ActiveDOMObject::ReasonForSuspension);
994
995     void registerForMediaVolumeCallbacks(Element*);
996     void unregisterForMediaVolumeCallbacks(Element*);
997     void mediaVolumeDidChange();
998
999 #if ENABLE(MEDIA_SESSION)
1000     MediaSession& defaultMediaSession();
1001 #endif
1002
1003     void registerForPrivateBrowsingStateChangedCallbacks(Element*);
1004     void unregisterForPrivateBrowsingStateChangedCallbacks(Element*);
1005     void storageBlockingStateDidChange();
1006     void privateBrowsingStateDidChange();
1007
1008 #if ENABLE(VIDEO_TRACK)
1009     void registerForCaptionPreferencesChangedCallbacks(Element*);
1010     void unregisterForCaptionPreferencesChangedCallbacks(Element*);
1011     void captionPreferencesChanged();
1012 #endif
1013
1014 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1015     void registerForPageScaleFactorChangedCallbacks(HTMLMediaElement*);
1016     void unregisterForPageScaleFactorChangedCallbacks(HTMLMediaElement*);
1017     void pageScaleFactorChangedAndStable();
1018     void registerForUserInterfaceLayoutDirectionChangedCallbacks(HTMLMediaElement&);
1019     void unregisterForUserInterfaceLayoutDirectionChangedCallbacks(HTMLMediaElement&);
1020     void userInterfaceLayoutDirectionChanged();
1021 #endif
1022
1023     void registerForVisibilityStateChangedCallbacks(Element*);
1024     void unregisterForVisibilityStateChangedCallbacks(Element*);
1025
1026 #if ENABLE(VIDEO)
1027     void registerForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement&);
1028     void unregisterForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement&);
1029     void allowsMediaDocumentInlinePlaybackChanged();
1030 #endif
1031
1032     WEBCORE_EXPORT void setShouldCreateRenderers(bool);
1033     bool shouldCreateRenderers();
1034
1035     void setDecoder(RefPtr<TextResourceDecoder>&&);
1036     TextResourceDecoder* decoder() const { return m_decoder.get(); }
1037
1038     WEBCORE_EXPORT String displayStringModifiedByEncoding(const String&) const;
1039     RefPtr<StringImpl> displayStringModifiedByEncoding(PassRefPtr<StringImpl>) const;
1040     void displayBufferModifiedByEncoding(LChar* buffer, unsigned len) const
1041     {
1042         displayBufferModifiedByEncodingInternal(buffer, len);
1043     }
1044     void displayBufferModifiedByEncoding(UChar* buffer, unsigned len) const
1045     {
1046         displayBufferModifiedByEncodingInternal(buffer, len);
1047     }
1048
1049     // Quirk for the benefit of Apple's Dictionary application.
1050     void setFrameElementsShouldIgnoreScrolling(bool ignore) { m_frameElementsShouldIgnoreScrolling = ignore; }
1051     bool frameElementsShouldIgnoreScrolling() const { return m_frameElementsShouldIgnoreScrolling; }
1052
1053 #if ENABLE(DASHBOARD_SUPPORT)
1054     void setAnnotatedRegionsDirty(bool f) { m_annotatedRegionsDirty = f; }
1055     bool annotatedRegionsDirty() const { return m_annotatedRegionsDirty; }
1056     bool hasAnnotatedRegions () const { return m_hasAnnotatedRegions; }
1057     void setHasAnnotatedRegions(bool f) { m_hasAnnotatedRegions = f; }
1058     WEBCORE_EXPORT const Vector<AnnotatedRegionValue>& annotatedRegions() const;
1059     void setAnnotatedRegions(const Vector<AnnotatedRegionValue>&);
1060 #endif
1061
1062     void removeAllEventListeners() final;
1063
1064     WEBCORE_EXPORT const SVGDocumentExtensions* svgExtensions();
1065     WEBCORE_EXPORT SVGDocumentExtensions& accessSVGExtensions();
1066
1067     void initSecurityContext();
1068     void initContentSecurityPolicy();
1069
1070     void updateURLForPushOrReplaceState(const URL&);
1071     void statePopped(PassRefPtr<SerializedScriptValue>);
1072
1073     bool processingLoadEvent() const { return m_processingLoadEvent; }
1074     bool loadEventFinished() const { return m_loadEventFinished; }
1075
1076     bool isContextThread() const final;
1077     bool isJSExecutionForbidden() const final { return false; }
1078
1079     void enqueueWindowEvent(Ref<Event>&&);
1080     void enqueueDocumentEvent(Ref<Event>&&);
1081     void enqueueOverflowEvent(Ref<Event>&&);
1082     void enqueuePageshowEvent(PageshowEventPersistence);
1083     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1084     void enqueuePopstateEvent(RefPtr<SerializedScriptValue>&& stateObject);
1085     DocumentEventQueue& eventQueue() const final { return m_eventQueue; }
1086
1087     WEBCORE_EXPORT void addMediaCanStartListener(MediaCanStartListener*);
1088     WEBCORE_EXPORT void removeMediaCanStartListener(MediaCanStartListener*);
1089     MediaCanStartListener* takeAnyMediaCanStartListener();
1090
1091 #if ENABLE(FULLSCREEN_API)
1092     bool webkitIsFullScreen() const { return m_fullScreenElement.get(); }
1093     bool webkitFullScreenKeyboardInputAllowed() const { return m_fullScreenElement.get() && m_areKeysEnabledInFullScreen; }
1094     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1095     
1096     enum FullScreenCheckType {
1097         EnforceIFrameAllowFullScreenRequirement,
1098         ExemptIFrameAllowFullScreenRequirement,
1099     };
1100
1101     void requestFullScreenForElement(Element*, unsigned short flags, FullScreenCheckType);
1102     WEBCORE_EXPORT void webkitCancelFullScreen();
1103     
1104     WEBCORE_EXPORT void webkitWillEnterFullScreenForElement(Element*);
1105     WEBCORE_EXPORT void webkitDidEnterFullScreenForElement(Element*);
1106     WEBCORE_EXPORT void webkitWillExitFullScreenForElement(Element*);
1107     WEBCORE_EXPORT void webkitDidExitFullScreenForElement(Element*);
1108     
1109     void setFullScreenRenderer(RenderFullScreen*);
1110     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer; }
1111     void fullScreenRendererDestroyed();
1112     
1113     void fullScreenChangeDelayTimerFired();
1114     bool fullScreenIsAllowedForElement(Element*) const;
1115     void fullScreenElementRemoved();
1116     void removeFullScreenElementOfSubtree(Node*, bool amongChildrenOnly = false);
1117     bool isAnimatingFullScreen() const;
1118     WEBCORE_EXPORT void setAnimatingFullScreen(bool);
1119
1120     WEBCORE_EXPORT bool webkitFullscreenEnabled() const;
1121     Element* webkitFullscreenElement() const { return !m_fullScreenElementStack.isEmpty() ? m_fullScreenElementStack.last().get() : nullptr; }
1122     WEBCORE_EXPORT void webkitExitFullscreen();
1123 #endif
1124
1125 #if ENABLE(POINTER_LOCK)
1126     void exitPointerLock();
1127     Element* pointerLockElement() const;
1128 #endif
1129
1130     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1131     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1132     void decrementLoadEventDelayCount();
1133     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1134
1135 #if ENABLE(IOS_TOUCH_EVENTS)
1136 #include <WebKitAdditions/DocumentIOS.h>
1137 #elif ENABLE(TOUCH_EVENTS)
1138     RefPtr<Touch> createTouch(DOMWindow*, EventTarget*, int identifier, int pageX, int pageY, int screenX, int screenY, int radiusX, int radiusY, float rotationAngle, float force, ExceptionCode&) const;
1139 #endif
1140
1141 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
1142     DeviceMotionController* deviceMotionController() const;
1143     DeviceOrientationController* deviceOrientationController() const;
1144 #endif
1145
1146 #if ENABLE(WEB_TIMING)
1147     const DocumentTiming& timing() const { return m_documentTiming; }
1148 #endif
1149
1150     double monotonicTimestamp() const;
1151
1152 #if ENABLE(REQUEST_ANIMATION_FRAME)
1153     int requestAnimationFrame(PassRefPtr<RequestAnimationFrameCallback>);
1154     void cancelAnimationFrame(int id);
1155     void serviceScriptedAnimations(double timestamp);
1156 #endif
1157
1158     void sendWillRevealEdgeEventsIfNeeded(const IntPoint& oldPosition, const IntPoint& newPosition, const IntRect& visibleRect, const IntSize& contentsSize, Element* target = nullptr);
1159
1160     EventTarget* errorEventTarget() final;
1161     void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) final;
1162
1163     void initDNSPrefetch();
1164
1165     void didAddWheelEventHandler(Node&);
1166     void didRemoveWheelEventHandler(Node&, EventHandlerRemoval = EventHandlerRemoval::One);
1167
1168     double lastHandledUserGestureTimestamp() const { return m_lastHandledUserGestureTimestamp; }
1169     void updateLastHandledUserGestureTimestamp();
1170
1171 #if ENABLE(TOUCH_EVENTS)
1172     bool hasTouchEventHandlers() const { return (m_touchEventTargets.get()) ? m_touchEventTargets->size() : false; }
1173 #else
1174     bool hasTouchEventHandlers() const { return false; }
1175 #endif
1176
1177     // Used for testing. Count handlers in the main document, and one per frame which contains handlers.
1178     WEBCORE_EXPORT unsigned wheelEventHandlerCount() const;
1179     WEBCORE_EXPORT unsigned touchEventHandlerCount() const;
1180
1181     WEBCORE_EXPORT void startTrackingStyleRecalcs();
1182     WEBCORE_EXPORT unsigned styleRecalcCount() const;
1183
1184     void didAddTouchEventHandler(Node&);
1185     void didRemoveTouchEventHandler(Node&, EventHandlerRemoval = EventHandlerRemoval::One);
1186
1187     void didRemoveEventTargetNode(Node&);
1188
1189     const EventTargetSet* touchEventTargets() const
1190     {
1191 #if ENABLE(TOUCH_EVENTS)
1192         return m_touchEventTargets.get();
1193 #else
1194         return nullptr;
1195 #endif
1196     }
1197
1198     const EventTargetSet* wheelEventTargets() const { return m_wheelEventTargets.get(); }
1199
1200     typedef std::pair<Region, bool> RegionFixedPair;
1201     RegionFixedPair absoluteRegionForEventTargets(const EventTargetSet*);
1202
1203     LayoutRect absoluteEventHandlerBounds(bool&) final;
1204
1205     bool visualUpdatesAllowed() const { return m_visualUpdatesAllowed; }
1206
1207     bool isInDocumentWrite() { return m_writeRecursionDepth > 0; }
1208
1209     void suspendScheduledTasks(ActiveDOMObject::ReasonForSuspension);
1210     void resumeScheduledTasks(ActiveDOMObject::ReasonForSuspension);
1211
1212 #if ENABLE(CSS_DEVICE_ADAPTATION)
1213     IntSize initialViewportSize() const;
1214 #endif
1215
1216     void adjustFloatQuadsForScrollAndAbsoluteZoomAndFrameScale(Vector<FloatQuad>&, const RenderStyle&);
1217     void adjustFloatRectForScrollAndAbsoluteZoomAndFrameScale(FloatRect&, const RenderStyle&);
1218
1219     bool hasActiveParser();
1220     void incrementActiveParserCount() { ++m_activeParserCount; }
1221     void decrementActiveParserCount();
1222
1223     DocumentSharedObjectPool* sharedObjectPool() { return m_sharedObjectPool.get(); }
1224
1225     void didRemoveAllPendingStylesheet();
1226     void setNeedsNotifyRemoveAllPendingStylesheet() { m_needsNotifyRemoveAllPendingStylesheet = true; }
1227     void didClearStyleResolver();
1228
1229     bool inStyleRecalc() const { return m_inStyleRecalc; }
1230     bool inRenderTreeUpdate() const { return m_inRenderTreeUpdate; }
1231
1232     // Return a Locale for the default locale if the argument is null or empty.
1233     Locale& getCachedLocale(const AtomicString& locale = nullAtom);
1234
1235     const Document* templateDocument() const;
1236     Document& ensureTemplateDocument();
1237     void setTemplateDocumentHost(Document* templateDocumentHost) { m_templateDocumentHost = templateDocumentHost; }
1238     Document* templateDocumentHost() { return m_templateDocumentHost; }
1239
1240     void didAssociateFormControl(Element*);
1241     bool hasDisabledFieldsetElement() const { return m_disabledFieldsetElementsCount; }
1242     void addDisabledFieldsetElement() { m_disabledFieldsetElementsCount++; }
1243     void removeDisabledFieldsetElement() { ASSERT(m_disabledFieldsetElementsCount); m_disabledFieldsetElementsCount--; }
1244
1245     WEBCORE_EXPORT void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0) final;
1246
1247     WEBCORE_EXPORT SecurityOrigin* topOrigin() const final;
1248
1249     Ref<FontFaceSet> fonts();
1250
1251     void ensurePlugInsInjectedScript(DOMWrapperWorld&);
1252
1253     void setVisualUpdatesAllowedByClient(bool);
1254
1255 #if ENABLE(SUBTLE_CRYPTO)
1256     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
1257     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
1258 #endif
1259
1260     void setHasStyleWithViewportUnits() { m_hasStyleWithViewportUnits = true; }
1261     bool hasStyleWithViewportUnits() const { return m_hasStyleWithViewportUnits; }
1262     void updateViewportUnitsOnResize();
1263
1264     WEBCORE_EXPORT void addAudioProducer(MediaProducer*);
1265     WEBCORE_EXPORT void removeAudioProducer(MediaProducer*);
1266     MediaProducer::MediaStateFlags mediaState() const { return m_mediaState; }
1267     WEBCORE_EXPORT void updateIsPlayingMedia(uint64_t = HTMLMediaElementInvalidID);
1268     void pageMutedStateDidChange();
1269     WeakPtr<Document> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
1270
1271 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1272     void addPlaybackTargetPickerClient(MediaPlaybackTargetClient&);
1273     void removePlaybackTargetPickerClient(MediaPlaybackTargetClient&);
1274     void showPlaybackTargetPicker(MediaPlaybackTargetClient&, bool);
1275     void playbackTargetPickerClientStateDidChange(MediaPlaybackTargetClient&, MediaProducer::MediaStateFlags);
1276
1277     void setPlaybackTarget(uint64_t, Ref<MediaPlaybackTarget>&&);
1278     void playbackTargetAvailabilityDidChange(uint64_t, bool);
1279     void setShouldPlayToPlaybackTarget(uint64_t, bool);
1280 #endif
1281
1282     ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToPropagate() const;
1283     bool shouldEnforceContentDispositionAttachmentSandbox() const;
1284     void applyContentDispositionAttachmentSandbox();
1285
1286     void addViewportDependentPicture(HTMLPictureElement&);
1287     void removeViewportDependentPicture(HTMLPictureElement&);
1288
1289 #if ENABLE(MEDIA_STREAM)
1290     void setHasActiveMediaStreamTrack() { m_hasHadActiveMediaStreamTrack = true; }
1291     bool hasHadActiveMediaStreamTrack() const { return m_hasHadActiveMediaStreamTrack; }
1292 #endif
1293
1294     using ContainerNode::setAttributeEventListener;
1295     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value);
1296
1297     DOMSelection* getSelection();
1298
1299 protected:
1300     enum ConstructionFlags { Synthesized = 1, NonRenderedPlaceholder = 1 << 1 };
1301     Document(Frame*, const URL&, unsigned = DefaultDocumentClass, unsigned constructionFlags = 0);
1302
1303     void clearXMLVersion() { m_xmlVersion = String(); }
1304
1305     virtual Ref<Document> cloneDocumentWithoutChildren() const;
1306
1307 private:
1308     friend class Node;
1309     friend class IgnoreDestructiveWriteCountIncrementer;
1310     friend class IgnoreOpensDuringUnloadCountIncrementer;
1311
1312     void updateTitleElement(Element* newTitleElement);
1313
1314     void commonTeardown();
1315
1316     RenderObject* renderer() const = delete;
1317     void setRenderer(RenderObject*) = delete;
1318
1319     void createRenderTree();
1320     void detachParser();
1321
1322     // FontSelectorClient
1323     void fontsNeedUpdate(FontSelector&) final;
1324
1325     bool isDocument() const final { return true; }
1326
1327     void childrenChanged(const ChildChange&) final;
1328
1329     String nodeName() const final;
1330     NodeType nodeType() const final;
1331     bool childTypeAllowed(NodeType) const final;
1332     Ref<Node> cloneNodeInternal(Document&, CloningOperation) final;
1333     void cloneDataFromDocument(const Document&);
1334
1335     void refScriptExecutionContext() final { ref(); }
1336     void derefScriptExecutionContext() final { deref(); }
1337
1338     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0) final;
1339
1340     std::chrono::milliseconds minimumTimerInterval() const final;
1341
1342     std::chrono::milliseconds timerAlignmentInterval(bool hasReachedMaxNestingLevel) const final;
1343
1344     void updateTitleFromTitleElement();
1345     void updateTitle(const StringWithDirection&);
1346     void updateFocusAppearanceTimerFired();
1347     void updateBaseURL();
1348
1349     void buildAccessKeyMap(TreeScope* root);
1350
1351     void loadEventDelayTimerFired();
1352
1353     void pendingTasksTimerFired();
1354
1355     template <typename CharacterType>
1356     void displayBufferModifiedByEncodingInternal(CharacterType*, unsigned) const;
1357
1358     PageVisibilityState pageVisibilityState() const;
1359
1360     template <CollectionType collectionType>
1361     Ref<HTMLCollection> ensureCachedCollection();
1362
1363 #if ENABLE(FULLSCREEN_API)
1364     void dispatchFullScreenChangeOrErrorEvent(Deque<RefPtr<Node>>&, const AtomicString& eventName, bool shouldNotifyMediaElement);
1365     void clearFullscreenElementStack();
1366     void popFullscreenElementStack();
1367     void pushFullscreenElementStack(Element*);
1368     void addDocumentToFullScreenChangeEventQueue(Document*);
1369 #endif
1370
1371     void setVisualUpdatesAllowed(ReadyState);
1372     void setVisualUpdatesAllowed(bool);
1373     void visualUpdatesSuppressionTimerFired();
1374
1375     void addListenerType(ListenerType listenerType) { m_listenerTypes |= listenerType; }
1376
1377     void didAssociateFormControlsTimerFired();
1378
1379     void wheelEventHandlersChanged();
1380
1381     HttpEquivPolicy httpEquivPolicy() const;
1382
1383     // DOM Cookies caching.
1384     const String& cachedDOMCookies() const { return m_cachedDOMCookies; }
1385     void setCachedDOMCookies(const String&);
1386     bool isDOMCookieCacheValid() const { return m_cookieCacheExpiryTimer.isActive(); }
1387     void invalidateDOMCookieCache();
1388     void didLoadResourceSynchronously() final;
1389
1390     void checkViewportDependentPictures();
1391
1392 #if USE(QUICK_LOOK)
1393     bool shouldEnforceQuickLookSandbox() const;
1394     void applyQuickLookSandbox();
1395 #endif
1396
1397     unsigned m_referencingNodeCount;
1398
1399     std::unique_ptr<StyleResolver> m_userAgentShadowTreeStyleResolver;
1400     bool m_hasNodesWithPlaceholderStyle;
1401     bool m_needsNotifyRemoveAllPendingStylesheet;
1402     // But sometimes you need to ignore pending stylesheet count to
1403     // force an immediate layout when requested by JS.
1404     bool m_ignorePendingStylesheets;
1405
1406     // If we do ignore the pending stylesheet count, then we need to add a boolean
1407     // to track that this happened so that we can do a full repaint when the stylesheets
1408     // do eventually load.
1409     PendingSheetLayout m_pendingSheetLayout;
1410
1411     Frame* m_frame;
1412     RefPtr<DOMWindow> m_domWindow;
1413     WeakPtr<Document> m_contextDocument;
1414
1415     Ref<CachedResourceLoader> m_cachedResourceLoader;
1416     RefPtr<DocumentParser> m_parser;
1417     unsigned m_activeParserCount;
1418
1419     bool m_wellFormed;
1420
1421     // Document URLs.
1422     URL m_url; // Document.URL: The URL from which this document was retrieved.
1423     URL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1424     URL m_baseURLOverride; // An alternative base URL that takes precedence over m_baseURL (but not m_baseElementURL).
1425     URL m_baseElementURL; // The URL set by the <base> element.
1426     URL m_cookieURL; // The URL to use for cookie access.
1427     URL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1428
1429     // Document.documentURI:
1430     // Although URL-like, Document.documentURI can actually be set to any
1431     // string by content.  Document.documentURI affects m_baseURL unless the
1432     // document contains a <base> element, in which case the <base> element
1433     // takes precedence.
1434     //
1435     // This property is read-only from JavaScript, but writable from Objective C.
1436     String m_documentURI;
1437
1438     String m_baseTarget;
1439
1440     // MIME type of the document in case it was cloned or created by XHR.
1441     String m_overriddenMIMEType;
1442
1443     std::unique_ptr<DOMImplementation> m_implementation;
1444
1445     bool m_hasElementUsingStyleBasedEditability { false };
1446
1447     bool m_printing;
1448     bool m_paginatedForScreen;
1449
1450     DocumentCompatibilityMode m_compatibilityMode;
1451     bool m_compatibilityModeLocked; // This is cheaper than making setCompatibilityMode virtual.
1452
1453     Color m_textColor;
1454
1455     bool m_focusNavigationStartingNodeIsRemoved;
1456     RefPtr<Node> m_focusNavigationStartingNode;
1457     RefPtr<Element> m_focusedElement;
1458     RefPtr<Element> m_hoveredElement;
1459     RefPtr<Element> m_activeElement;
1460     RefPtr<Element> m_documentElement;
1461     UserActionElementSet m_userActionElements;
1462
1463     uint64_t m_domTreeVersion;
1464     static uint64_t s_globalTreeVersion;
1465     
1466     HashSet<NodeIterator*> m_nodeIterators;
1467     HashSet<Range*> m_ranges;
1468
1469     unsigned m_listenerTypes;
1470
1471     MutationObserverOptions m_mutationObserverTypes;
1472
1473     std::unique_ptr<Style::Scope> m_styleScope;
1474     std::unique_ptr<ExtensionStyleSheets> m_extensionStyleSheets;
1475     RefPtr<StyleSheetList> m_styleSheetList;
1476
1477     std::unique_ptr<FormController> m_formController;
1478
1479     Color m_linkColor;
1480     Color m_visitedLinkColor;
1481     Color m_activeLinkColor;
1482     const std::unique_ptr<VisitedLinkState> m_visitedLinkState;
1483
1484     bool m_visuallyOrdered;
1485     ReadyState m_readyState;
1486     bool m_bParsing;
1487
1488     Timer m_styleRecalcTimer;
1489     bool m_pendingStyleRecalcShouldForce;
1490     bool m_inStyleRecalc;
1491     bool m_closeAfterStyleRecalc;
1492     bool m_inRenderTreeUpdate { false };
1493     unsigned m_lastStyleUpdateSizeForTesting { 0 };
1494
1495     bool m_gotoAnchorNeededAfterStylesheetsLoad;
1496     bool m_isDNSPrefetchEnabled;
1497     bool m_haveExplicitlyDisabledDNSPrefetch;
1498     bool m_frameElementsShouldIgnoreScrolling;
1499     SelectionRestorationMode m_updateFocusAppearanceRestoresSelection;
1500
1501     // https://html.spec.whatwg.org/multipage/webappapis.html#ignore-destructive-writes-counter
1502     unsigned m_ignoreDestructiveWriteCount { 0 };
1503
1504     // https://html.spec.whatwg.org/multipage/webappapis.html#ignore-opens-during-unload-counter
1505     unsigned m_ignoreOpensDuringUnloadCount { 0 };
1506
1507     unsigned m_styleRecalcCount { 0 };
1508
1509     StringWithDirection m_title;
1510     StringWithDirection m_rawTitle;
1511     RefPtr<Element> m_titleElement;
1512
1513     std::unique_ptr<AXObjectCache> m_axObjectCache;
1514     const std::unique_ptr<DocumentMarkerController> m_markers;
1515     
1516     Timer m_updateFocusAppearanceTimer;
1517
1518     Element* m_cssTarget;
1519
1520     // FIXME: Merge these 2 variables into an enum. Also, FrameLoader::m_didCallImplicitClose
1521     // is almost a duplication of this data, so that should probably get merged in too.
1522     // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadDispatched are roughly the same
1523     // and should be merged.
1524     bool m_processingLoadEvent;
1525     bool m_loadEventFinished;
1526
1527     RefPtr<SerializedScriptValue> m_pendingStateObject;
1528     std::chrono::steady_clock::time_point m_startTime;
1529     bool m_overMinimumLayoutThreshold;
1530     
1531     std::unique_ptr<ScriptRunner> m_scriptRunner;
1532     std::unique_ptr<ScriptModuleLoader> m_moduleLoader;
1533
1534     Vector<RefPtr<HTMLScriptElement>> m_currentScriptStack;
1535
1536 #if ENABLE(XSLT)
1537     std::unique_ptr<TransformSource> m_transformSource;
1538     RefPtr<Document> m_transformSourceDocument;
1539 #endif
1540
1541     String m_xmlEncoding;
1542     String m_xmlVersion;
1543     unsigned m_xmlStandalone : 2;
1544     unsigned m_hasXMLDeclaration : 1;
1545
1546     String m_contentLanguage;
1547
1548     RefPtr<TextResourceDecoder> m_decoder;
1549
1550     InheritedBool m_designMode;
1551
1552     HashSet<LiveNodeList*> m_listsInvalidatedAtDocument;
1553     HashSet<HTMLCollection*> m_collectionsInvalidatedAtDocument;
1554     unsigned m_nodeListAndCollectionCounts[numNodeListInvalidationTypes];
1555
1556     RefPtr<XPathEvaluator> m_xpathEvaluator;
1557
1558     std::unique_ptr<SVGDocumentExtensions> m_svgExtensions;
1559
1560 #if ENABLE(DASHBOARD_SUPPORT)
1561     Vector<AnnotatedRegionValue> m_annotatedRegions;
1562     bool m_hasAnnotatedRegions;
1563     bool m_annotatedRegionsDirty;
1564 #endif
1565
1566     HashMap<String, RefPtr<HTMLCanvasElement>> m_cssCanvasElements;
1567
1568     bool m_createRenderers;
1569     PageCacheState m_pageCacheState { NotInPageCache };
1570
1571     HashSet<Element*> m_documentSuspensionCallbackElements;
1572     HashSet<Element*> m_mediaVolumeCallbackElements;
1573     HashSet<Element*> m_privateBrowsingStateChangedElements;
1574 #if ENABLE(VIDEO_TRACK)
1575     HashSet<Element*> m_captionPreferencesChangedElements;
1576 #endif
1577
1578 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1579     HashSet<HTMLMediaElement*> m_pageScaleFactorChangedElements;
1580     HashSet<HTMLMediaElement*> m_userInterfaceLayoutDirectionChangedElements;
1581 #endif
1582
1583     HashSet<Element*> m_visibilityStateCallbackElements;
1584 #if ENABLE(VIDEO)
1585     HashSet<HTMLMediaElement*> m_allowsMediaDocumentInlinePlaybackElements;
1586 #endif
1587
1588     HashMap<StringImpl*, Element*, ASCIICaseInsensitiveHash> m_elementsByAccessKey;
1589     bool m_accessKeyMapValid;
1590
1591     DocumentOrderedMap m_imagesByUsemap;
1592
1593     std::unique_ptr<SelectorQueryCache> m_selectorQueryCache;
1594
1595     DocumentClassFlags m_documentClasses;
1596
1597     bool m_isSynthesized;
1598     bool m_isNonRenderedPlaceholder;
1599
1600     bool m_sawElementsInKnownNamespaces;
1601     bool m_isSrcdocDocument;
1602
1603     RenderPtr<RenderView> m_renderView;
1604     mutable DocumentEventQueue m_eventQueue;
1605
1606     WeakPtrFactory<Document> m_weakFactory;
1607
1608     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1609
1610 #if ENABLE(FULLSCREEN_API)
1611     bool m_areKeysEnabledInFullScreen;
1612     RefPtr<Element> m_fullScreenElement;
1613     Vector<RefPtr<Element>> m_fullScreenElementStack;
1614     RenderFullScreen* m_fullScreenRenderer;
1615     Timer m_fullScreenChangeDelayTimer;
1616     Deque<RefPtr<Node>> m_fullScreenChangeEventTargetQueue;
1617     Deque<RefPtr<Node>> m_fullScreenErrorEventTargetQueue;
1618     bool m_isAnimatingFullScreen;
1619     LayoutRect m_savedPlaceholderFrameRect;
1620     std::unique_ptr<RenderStyle> m_savedPlaceholderRenderStyle;
1621 #endif
1622
1623     HashSet<HTMLPictureElement*> m_viewportDependentPictures;
1624
1625     int m_loadEventDelayCount;
1626     Timer m_loadEventDelayTimer;
1627
1628     ViewportArguments m_viewportArguments;
1629
1630     ReferrerPolicy m_referrerPolicy;
1631
1632 #if ENABLE(WEB_TIMING)
1633     DocumentTiming m_documentTiming;
1634 #endif
1635
1636     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1637     bool m_writeRecursionIsTooDeep;
1638     unsigned m_writeRecursionDepth;
1639     
1640 #if ENABLE(TOUCH_EVENTS)
1641     std::unique_ptr<EventTargetSet> m_touchEventTargets;
1642 #endif
1643     std::unique_ptr<EventTargetSet> m_wheelEventTargets;
1644
1645     double m_lastHandledUserGestureTimestamp;
1646
1647 #if ENABLE(REQUEST_ANIMATION_FRAME)
1648     void clearScriptedAnimationController();
1649     RefPtr<ScriptedAnimationController> m_scriptedAnimationController;
1650 #endif
1651
1652 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
1653     std::unique_ptr<DeviceMotionClient> m_deviceMotionClient;
1654     std::unique_ptr<DeviceMotionController> m_deviceMotionController;
1655     std::unique_ptr<DeviceOrientationClient> m_deviceOrientationClient;
1656     std::unique_ptr<DeviceOrientationController> m_deviceOrientationController;
1657 #endif
1658
1659 // FIXME: Find a better place for this functionality.
1660 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
1661 public:
1662
1663     // These functions provide a two-level setting:
1664     //    - A user-settable wantsTelephoneNumberParsing (at the Page / WebView level)
1665     //    - A read-only telephoneNumberParsingAllowed which is set by the
1666     //      document if it has the appropriate meta tag.
1667     //    - isTelephoneNumberParsingEnabled() == isTelephoneNumberParsingAllowed() && page()->settings()->isTelephoneNumberParsingEnabled()
1668
1669     WEBCORE_EXPORT bool isTelephoneNumberParsingAllowed() const;
1670     WEBCORE_EXPORT bool isTelephoneNumberParsingEnabled() const;
1671
1672 private:
1673     friend void setParserFeature(const String& key, const String& value, Document*, void* userData);
1674     void setIsTelephoneNumberParsingAllowed(bool);
1675
1676     bool m_isTelephoneNumberParsingAllowed;
1677 #endif
1678
1679     Timer m_pendingTasksTimer;
1680     Vector<Task> m_pendingTasks;
1681
1682 #if ENABLE(TEXT_AUTOSIZING)
1683 public:
1684     void addAutoSizedNode(Text&, float size);
1685     void updateAutoSizedNodes();
1686     void clearAutoSizedNodes();
1687
1688 private:
1689     using TextAutoSizingMap = HashMap<TextAutoSizingKey, std::unique_ptr<TextAutoSizingValue>, TextAutoSizingHash, TextAutoSizingTraits>;
1690     TextAutoSizingMap m_textAutoSizedNodes;
1691 #endif
1692
1693     void platformSuspendOrStopActiveDOMObjects();
1694
1695     bool m_scheduledTasksAreSuspended;
1696     
1697     bool m_visualUpdatesAllowed;
1698     Timer m_visualUpdatesSuppressionTimer;
1699
1700     RefPtr<NamedFlowCollection> m_namedFlows;
1701
1702     void clearSharedObjectPool();
1703     Timer m_sharedObjectPoolClearTimer;
1704
1705     std::unique_ptr<DocumentSharedObjectPool> m_sharedObjectPool;
1706
1707 #ifndef NDEBUG
1708     bool m_didDispatchViewportPropertiesChanged;
1709 #endif
1710
1711     typedef HashMap<AtomicString, std::unique_ptr<Locale>> LocaleIdentifierToLocaleMap;
1712     LocaleIdentifierToLocaleMap m_localeCache;
1713
1714     RefPtr<Document> m_templateDocument;
1715     Document* m_templateDocumentHost; // Manually managed weakref (backpointer from m_templateDocument).
1716
1717     Ref<CSSFontSelector> m_fontSelector;
1718
1719 #if ENABLE(WEB_REPLAY)
1720     Ref<JSC::InputCursor> m_inputCursor;
1721 #endif
1722
1723     Timer m_didAssociateFormControlsTimer;
1724     Timer m_cookieCacheExpiryTimer;
1725     String m_cachedDOMCookies;
1726     HashSet<RefPtr<Element>> m_associatedFormControls;
1727     unsigned m_disabledFieldsetElementsCount;
1728
1729     bool m_hasInjectedPlugInsScript;
1730     bool m_renderTreeBeingDestroyed { false };
1731     bool m_hasPreparedForDestruction { false };
1732
1733     bool m_hasStyleWithViewportUnits;
1734     bool m_isTimerThrottlingEnabled { false };
1735     bool m_isSuspended { false };
1736
1737     HashSet<MediaProducer*> m_audioProducers;
1738     MediaProducer::MediaStateFlags m_mediaState { MediaProducer::IsNotPlaying };
1739
1740 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1741     typedef HashMap<uint64_t, WebCore::MediaPlaybackTargetClient*> TargetIdToClientMap;
1742     TargetIdToClientMap m_idToClientMap;
1743     typedef HashMap<WebCore::MediaPlaybackTargetClient*, uint64_t> TargetClientToIdMap;
1744     TargetClientToIdMap m_clientToIDMap;
1745 #endif
1746
1747 #if ENABLE(MEDIA_SESSION)
1748     RefPtr<MediaSession> m_defaultMediaSession;
1749 #endif
1750     bool m_areDeviceMotionAndOrientationUpdatesSuspended { false };
1751
1752 #if ENABLE(MEDIA_STREAM)
1753     bool m_hasHadActiveMediaStreamTrack { false };
1754 #endif
1755
1756 #if ENABLE(INDEXED_DATABASE)
1757     RefPtr<IDBClient::IDBConnectionProxy> m_idbConnectionProxy;
1758 #endif
1759 #if ENABLE(WEB_SOCKETS)
1760     RefPtr<SocketProvider> m_socketProvider;
1761 #endif
1762 };
1763
1764 inline void Document::notifyRemovePendingSheetIfNeeded()
1765 {
1766     if (m_needsNotifyRemoveAllPendingStylesheet)
1767         didRemoveAllPendingStylesheet();
1768 }
1769
1770 inline TextEncoding Document::textEncoding() const
1771 {
1772     if (auto* decoder = this->decoder())
1773         return decoder->encoding();
1774     return TextEncoding();
1775 }
1776
1777 inline const Document* Document::templateDocument() const
1778 {
1779     return m_templateDocumentHost ? this : m_templateDocument.get();
1780 }
1781
1782 // Put these methods here, because they require the Document definition, but we really want to inline them.
1783
1784 inline bool Node::isDocumentNode() const
1785 {
1786     return this == &document();
1787 }
1788
1789 inline ScriptExecutionContext* Node::scriptExecutionContext() const
1790 {
1791     return &document().contextDocument();
1792 }
1793
1794 Element* eventTargetElementForDocument(Document*);
1795
1796 } // namespace WebCore
1797
1798 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Document)
1799     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isDocument(); }
1800     static bool isType(const WebCore::Node& node) { return node.isDocumentNode(); }
1801 SPECIALIZE_TYPE_TRAITS_END()