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