2b99d4454e074afffc282ddb643ab0beac0ea738
[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-2018 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 "CSSRegisteredCustomProperty.h"
31 #include "Color.h"
32 #include "ContainerNode.h"
33 #include "DisabledAdaptations.h"
34 #include "DocumentEventQueue.h"
35 #include "DocumentIdentifier.h"
36 #include "DocumentTiming.h"
37 #include "FocusDirection.h"
38 #include "FontSelectorClient.h"
39 #include "FrameDestructionObserver.h"
40 #include "GenericTaskQueue.h"
41 #include "MediaProducer.h"
42 #include "MutationObserver.h"
43 #include "OrientationNotifier.h"
44 #include "PlatformEvent.h"
45 #include "ReferrerPolicy.h"
46 #include "Region.h"
47 #include "RegistrableDomain.h"
48 #include "RenderPtr.h"
49 #include "ScriptExecutionContext.h"
50 #include "SecurityPolicyViolationEvent.h"
51 #include "StringWithDirection.h"
52 #include "StyleColor.h"
53 #include "Supplementable.h"
54 #include "TextResourceDecoder.h"
55 #include "Timer.h"
56 #include "TreeScope.h"
57 #include "UserActionElementSet.h"
58 #include "ViewportArguments.h"
59 #include "VisibilityState.h"
60 #include <pal/SessionID.h>
61 #include <wtf/Deque.h>
62 #include <wtf/Forward.h>
63 #include <wtf/HashCountedSet.h>
64 #include <wtf/HashSet.h>
65 #include <wtf/Logger.h>
66 #include <wtf/ObjectIdentifier.h>
67 #include <wtf/UniqueRef.h>
68 #include <wtf/WeakPtr.h>
69 #include <wtf/text/AtomicStringHash.h>
70
71 #if PLATFORM(IOS_FAMILY)
72 #include "EventTrackingRegions.h"
73 #endif
74
75 #if ENABLE(IOS_TOUCH_EVENTS)
76 #include <wtf/ThreadingPrimitives.h>
77 #endif
78
79 namespace JSC {
80 class ExecState;
81 class InputCursor;
82 }
83
84 namespace WebCore {
85
86 class ApplicationStateChangeListener;
87 class AXObjectCache;
88 class Attr;
89 class CDATASection;
90 class CSSCustomPropertyValue;
91 class CSSFontSelector;
92 class CSSStyleDeclaration;
93 class CSSStyleSheet;
94 class CachedCSSStyleSheet;
95 class CachedFrameBase;
96 class CachedResourceLoader;
97 class CachedScript;
98 class CanvasRenderingContext2D;
99 class CharacterData;
100 class Comment;
101 class ConstantPropertyMap;
102 class ContentChangeObserver;
103 class DOMImplementation;
104 class DOMSelection;
105 class DOMWindow;
106 class DOMWrapperWorld;
107 class Database;
108 class DatabaseThread;
109 class DeferredPromise;
110 class DocumentFragment;
111 class DocumentLoader;
112 class DocumentMarkerController;
113 class DocumentParser;
114 class DocumentSharedObjectPool;
115 class DocumentTimeline;
116 class DocumentType;
117 class ExtensionStyleSheets;
118 class FloatQuad;
119 class FloatRect;
120 class FontFaceSet;
121 class FormController;
122 class Frame;
123 class FrameView;
124 class HTMLAllCollection;
125 class HTMLBodyElement;
126 class HTMLCanvasElement;
127 class HTMLCollection;
128 class HTMLDocument;
129 class HTMLElement;
130 class HTMLFrameOwnerElement;
131 class HTMLHeadElement;
132 class HTMLIFrameElement;
133 class HTMLImageElement;
134 class HTMLMapElement;
135 class HTMLMediaElement;
136 class HTMLPictureElement;
137 class HTMLScriptElement;
138 class HitTestRequest;
139 class HitTestResult;
140 class ImageBitmapRenderingContext;
141 class IntPoint;
142 class JSNode;
143 class LayoutPoint;
144 class LayoutRect;
145 class LiveNodeList;
146 class Locale;
147 class Location;
148 class MediaCanStartListener;
149 class MediaPlaybackTarget;
150 class MediaPlaybackTargetClient;
151 class MediaQueryList;
152 class MediaQueryMatcher;
153 class MouseEventWithHitTestResults;
154 class NodeFilter;
155 class NodeIterator;
156 class Page;
157 class PaintWorkletGlobalScope;
158 class PlatformMouseEvent;
159 class ProcessingInstruction;
160 class QualifiedName;
161 class Quirks;
162 class Range;
163 class RenderFullScreen;
164 class RenderTreeBuilder;
165 class RenderView;
166 class RequestAnimationFrameCallback;
167 class SVGDocumentExtensions;
168 class SVGSVGElement;
169 class SVGUseElement;
170 class SWClientConnection;
171 class ScriptElementData;
172 class ScriptModuleLoader;
173 class ScriptRunner;
174 class ScriptableDocumentParser;
175 class ScriptedAnimationController;
176 class SecurityOrigin;
177 class SegmentedString;
178 class SelectorQuery;
179 class SelectorQueryCache;
180 class SerializedScriptValue;
181 class Settings;
182 class StringCallback;
183 class StyleResolver;
184 class StyleSheet;
185 class StyleSheetContents;
186 class StyleSheetList;
187 class Text;
188 class TextResourceDecoder;
189 class TreeWalker;
190 class UndoManager;
191 class VisibilityChangeClient;
192 class VisitedLinkState;
193 class WebAnimation;
194 class WebGL2RenderingContext;
195 class WebGLRenderingContext;
196 class WebGPURenderingContext;
197 class WebMetalRenderingContext;
198 class WindowProxy;
199 class Worklet;
200 class XPathEvaluator;
201 class XPathExpression;
202 class XPathNSResolver;
203 class XPathResult;
204
205 template<typename> class ExceptionOr;
206
207 enum CollectionType;
208 enum class ShouldOpenExternalURLsPolicy : uint8_t;
209
210 enum class RouteSharingPolicy : uint8_t;
211
212 using PlatformDisplayID = uint32_t;
213
214 #if ENABLE(XSLT)
215 class TransformSource;
216 #endif
217
218 #if ENABLE(DASHBOARD_SUPPORT)
219 struct AnnotatedRegionValue;
220 #endif
221
222 #if ENABLE(TOUCH_EVENTS) || ENABLE(IOS_TOUCH_EVENTS)
223 class Touch;
224 class TouchList;
225 #endif
226
227 #if ENABLE(DEVICE_ORIENTATION)
228 #if PLATFORM(IOS_FAMILY)
229 class DeviceMotionClient;
230 class DeviceMotionController;
231 class DeviceOrientationClient;
232 class DeviceOrientationController;
233 #endif
234 class DeviceOrientationAndMotionAccessController;
235 #endif
236
237 #if ENABLE(TEXT_AUTOSIZING)
238 class TextAutoSizing;
239 #endif
240
241 #if ENABLE(MEDIA_SESSION)
242 class MediaSession;
243 #endif
244
245 #if ENABLE(ATTACHMENT_ELEMENT)
246 class HTMLAttachmentElement;
247 #endif
248
249 #if ENABLE(INTERSECTION_OBSERVER)
250 class IntersectionObserver;
251 #endif
252
253 namespace Style {
254 class Scope;
255 };
256
257 const uint64_t HTMLMediaElementInvalidID = 0;
258
259 enum PageshowEventPersistence { PageshowEventNotPersisted, PageshowEventPersisted };
260
261 enum NodeListInvalidationType {
262     DoNotInvalidateOnAttributeChanges,
263     InvalidateOnClassAttrChange,
264     InvalidateOnIdNameAttrChange,
265     InvalidateOnNameAttrChange,
266     InvalidateOnForTypeAttrChange,
267     InvalidateForFormControls,
268     InvalidateOnHRefAttrChange,
269     InvalidateOnAnyAttrChange,
270 };
271 const int numNodeListInvalidationTypes = InvalidateOnAnyAttrChange + 1;
272
273 enum class EventHandlerRemoval { One, All };
274 typedef HashCountedSet<Node*> EventTargetSet;
275
276 enum DocumentClass {
277     DefaultDocumentClass = 0,
278     HTMLDocumentClass = 1,
279     XHTMLDocumentClass = 1 << 1,
280     ImageDocumentClass = 1 << 2,
281     PluginDocumentClass = 1 << 3,
282     MediaDocumentClass = 1 << 4,
283     SVGDocumentClass = 1 << 5,
284     TextDocumentClass = 1 << 6,
285     XMLDocumentClass = 1 << 7,
286 };
287 typedef unsigned char DocumentClassFlags;
288
289 enum class DocumentCompatibilityMode : unsigned char {
290     NoQuirksMode = 1,
291     QuirksMode = 1 << 1,
292     LimitedQuirksMode = 1 << 2
293 };
294
295 enum DimensionsCheck { WidthDimensionsCheck = 1 << 0, HeightDimensionsCheck = 1 << 1, AllDimensionsCheck = 1 << 2 };
296
297 enum class SelectionRestorationMode { Restore, SetDefault };
298
299 enum class HttpEquivPolicy {
300     Enabled,
301     DisabledBySettings,
302     DisabledByContentDispositionAttachmentSandbox
303 };
304
305 enum class CustomElementNameValidationStatus {
306     Valid,
307     FirstCharacterIsNotLowercaseASCIILetter,
308     ContainsNoHyphen,
309     ContainsUppercaseASCIILetter,
310     ContainsDisallowedCharacter,
311     ConflictsWithStandardElementName
312 };
313
314 using RenderingContext = Variant<
315 #if ENABLE(WEBGL)
316     RefPtr<WebGLRenderingContext>,
317 #endif
318 #if ENABLE(WEBGL2)
319     RefPtr<WebGL2RenderingContext>,
320 #endif
321 #if ENABLE(WEBGPU)
322     RefPtr<WebGPURenderingContext>,
323 #endif
324 #if ENABLE(WEBMETAL)
325     RefPtr<WebMetalRenderingContext>,
326 #endif
327     RefPtr<ImageBitmapRenderingContext>,
328     RefPtr<CanvasRenderingContext2D>
329 >;
330
331 class DocumentParserYieldToken {
332     WTF_MAKE_FAST_ALLOCATED;
333 public:
334     WEBCORE_EXPORT DocumentParserYieldToken(Document&);
335     WEBCORE_EXPORT ~DocumentParserYieldToken();
336
337 private:
338     WeakPtr<Document> m_document;
339 };
340
341 class Document
342     : public ContainerNode
343     , public TreeScope
344     , public ScriptExecutionContext
345     , public FontSelectorClient
346     , public CanMakeWeakPtr<Document>
347     , public FrameDestructionObserver
348     , public Supplementable<Document>
349     , public Logger::Observer {
350     WTF_MAKE_ISO_ALLOCATED(Document);
351 public:
352     static Ref<Document> create(const URL&);
353     static Ref<Document> createNonRenderedPlaceholder(Frame&, const URL&);
354     static Ref<Document> create(Document&);
355
356     virtual ~Document();
357
358     // Nodes belonging to this document increase referencingNodeCount -
359     // these are enough to keep the document from being destroyed, but
360     // not enough to keep it from removing its children. This allows a
361     // node that outlives its document to still have a valid document
362     // pointer without introducing reference cycles.
363     void incrementReferencingNodeCount()
364     {
365         ASSERT(!m_deletionHasBegun);
366         ++m_referencingNodeCount;
367     }
368
369     void decrementReferencingNodeCount()
370     {
371         ASSERT(!m_deletionHasBegun || !m_referencingNodeCount);
372         --m_referencingNodeCount;
373         if (!m_referencingNodeCount && !refCount()) {
374 #if !ASSERT_DISABLED
375             m_deletionHasBegun = true;
376 #endif
377             delete this;
378         }
379     }
380
381     unsigned referencingNodeCount() const { return m_referencingNodeCount; }
382
383     void removedLastRef();
384
385     DocumentIdentifier identifier() const { return m_identifier; }
386
387     using DocumentsMap = HashMap<DocumentIdentifier, Document*>;
388     WEBCORE_EXPORT static DocumentsMap::ValuesIteratorRange allDocuments();
389     WEBCORE_EXPORT static DocumentsMap& allDocumentsMap();
390
391     MediaQueryMatcher& mediaQueryMatcher();
392
393     using ContainerNode::ref;
394     using ContainerNode::deref;
395     using TreeScope::rootNode;
396
397     bool canContainRangeEndPoint() const final { return true; }
398
399     Element* elementForAccessKey(const String& key);
400     void invalidateAccessKeyCache();
401
402     ExceptionOr<SelectorQuery&> selectorQueryForString(const String&);
403     void clearSelectorQueryCache();
404
405     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
406     ViewportArguments viewportArguments() const { return m_viewportArguments; }
407
408     WEBCORE_EXPORT void setOverrideViewportArguments(const Optional<ViewportArguments>&);
409
410     OptionSet<DisabledAdaptations> disabledAdaptations() const { return m_disabledAdaptations; }
411 #ifndef NDEBUG
412     bool didDispatchViewportPropertiesChanged() const { return m_didDispatchViewportPropertiesChanged; }
413 #endif
414
415     void setReferrerPolicy(ReferrerPolicy);
416     ReferrerPolicy referrerPolicy() const { return m_referrerPolicy.valueOr(ReferrerPolicy::NoReferrerWhenDowngrade); }
417
418     WEBCORE_EXPORT DocumentType* doctype() const;
419
420     WEBCORE_EXPORT DOMImplementation& implementation();
421     
422     Element* documentElement() const { return m_documentElement.get(); }
423     static ptrdiff_t documentElementMemoryOffset() { return OBJECT_OFFSETOF(Document, m_documentElement); }
424
425     WEBCORE_EXPORT Element* activeElement();
426     WEBCORE_EXPORT bool hasFocus() const;
427
428     bool hasManifest() const;
429     
430     WEBCORE_EXPORT ExceptionOr<Ref<Element>> createElementForBindings(const AtomicString& tagName);
431     WEBCORE_EXPORT Ref<DocumentFragment> createDocumentFragment();
432     WEBCORE_EXPORT Ref<Text> createTextNode(const String& data);
433     WEBCORE_EXPORT Ref<Comment> createComment(const String& data);
434     WEBCORE_EXPORT ExceptionOr<Ref<CDATASection>> createCDATASection(const String& data);
435     WEBCORE_EXPORT ExceptionOr<Ref<ProcessingInstruction>> createProcessingInstruction(const String& target, const String& data);
436     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> createAttribute(const String& name);
437     WEBCORE_EXPORT ExceptionOr<Ref<Attr>> createAttributeNS(const AtomicString& namespaceURI, const String& qualifiedName, bool shouldIgnoreNamespaceChecks = false);
438     WEBCORE_EXPORT ExceptionOr<Ref<Node>> importNode(Node& nodeToImport, bool deep);
439     WEBCORE_EXPORT ExceptionOr<Ref<Element>> createElementNS(const AtomicString& namespaceURI, const String& qualifiedName);
440     WEBCORE_EXPORT Ref<Element> createElement(const QualifiedName&, bool createdByParser);
441
442     static CustomElementNameValidationStatus validateCustomElementName(const AtomicString&);
443
444     WEBCORE_EXPORT RefPtr<Range> caretRangeFromPoint(int x, int y);
445     RefPtr<Range> caretRangeFromPoint(const LayoutPoint& clientPoint);
446
447     WEBCORE_EXPORT Element* scrollingElementForAPI();
448     Element* scrollingElement();
449
450     enum ReadyState { Loading, Interactive,  Complete };
451     ReadyState readyState() const { return m_readyState; }
452
453     WEBCORE_EXPORT String defaultCharsetForLegacyBindings() const;
454
455     String charset() const { return Document::encoding(); }
456     WEBCORE_EXPORT String characterSetWithUTF8Fallback() const;
457     TextEncoding textEncoding() const;
458
459     AtomicString encoding() const { return textEncoding().domName(); }
460
461     WEBCORE_EXPORT void setCharset(const String&); // Used by ObjC / GOBject bindings only.
462
463     void setContent(const String&);
464
465     String suggestedMIMEType() const;
466
467     void overrideMIMEType(const String&);
468     WEBCORE_EXPORT String contentType() const;
469
470     String contentLanguage() const { return m_contentLanguage; }
471     void setContentLanguage(const String&);
472
473     String xmlEncoding() const { return m_xmlEncoding; }
474     String xmlVersion() const { return m_xmlVersion; }
475     enum class StandaloneStatus : uint8_t { Unspecified, Standalone, NotStandalone };
476     bool xmlStandalone() const { return m_xmlStandalone == StandaloneStatus::Standalone; }
477     StandaloneStatus xmlStandaloneStatus() const { return m_xmlStandalone; }
478     bool hasXMLDeclaration() const { return m_hasXMLDeclaration; }
479
480     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
481     WEBCORE_EXPORT ExceptionOr<void> setXMLVersion(const String&);
482     WEBCORE_EXPORT void setXMLStandalone(bool);
483     void setHasXMLDeclaration(bool hasXMLDeclaration) { m_hasXMLDeclaration = hasXMLDeclaration; }
484
485     String documentURI() const { return m_documentURI; }
486     WEBCORE_EXPORT void setDocumentURI(const String&);
487
488     WEBCORE_EXPORT VisibilityState visibilityState() const;
489     void visibilityStateChanged();
490     WEBCORE_EXPORT bool hidden() const;
491
492     void setTimerThrottlingEnabled(bool);
493     bool isTimerThrottlingEnabled() const { return m_isTimerThrottlingEnabled; }
494
495     WEBCORE_EXPORT ExceptionOr<Ref<Node>> adoptNode(Node& source);
496
497     WEBCORE_EXPORT Ref<HTMLCollection> images();
498     WEBCORE_EXPORT Ref<HTMLCollection> embeds();
499     WEBCORE_EXPORT Ref<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
500     WEBCORE_EXPORT Ref<HTMLCollection> applets();
501     WEBCORE_EXPORT Ref<HTMLCollection> links();
502     WEBCORE_EXPORT Ref<HTMLCollection> forms();
503     WEBCORE_EXPORT Ref<HTMLCollection> anchors();
504     WEBCORE_EXPORT Ref<HTMLCollection> scripts();
505     Ref<HTMLCollection> all();
506     Ref<HTMLCollection> allFilteredByName(const AtomicString&);
507
508     Ref<HTMLCollection> windowNamedItems(const AtomicString&);
509     Ref<HTMLCollection> documentNamedItems(const AtomicString&);
510
511     // Other methods (not part of DOM)
512     bool isSynthesized() const { return m_isSynthesized; }
513     bool isHTMLDocument() const { return m_documentClasses & HTMLDocumentClass; }
514     bool isXHTMLDocument() const { return m_documentClasses & XHTMLDocumentClass; }
515     bool isXMLDocument() const { return m_documentClasses & XMLDocumentClass; }
516     bool isImageDocument() const { return m_documentClasses & ImageDocumentClass; }
517     bool isSVGDocument() const { return m_documentClasses & SVGDocumentClass; }
518     bool isPluginDocument() const { return m_documentClasses & PluginDocumentClass; }
519     bool isMediaDocument() const { return m_documentClasses & MediaDocumentClass; }
520     bool isTextDocument() const { return m_documentClasses & TextDocumentClass; }
521     bool hasSVGRootNode() const;
522     virtual bool isFrameSet() const { return false; }
523
524     static ptrdiff_t documentClassesMemoryOffset() { return OBJECT_OFFSETOF(Document, m_documentClasses); }
525     static uint32_t isHTMLDocumentClassFlag() { return HTMLDocumentClass; }
526
527     bool isSrcdocDocument() const { return m_isSrcdocDocument; }
528
529     bool sawElementsInKnownNamespaces() const { return m_sawElementsInKnownNamespaces; }
530
531     StyleResolver& userAgentShadowTreeStyleResolver();
532
533     CSSFontSelector& fontSelector() { return m_fontSelector; }
534
535     WEBCORE_EXPORT bool haveStylesheetsLoaded() const;
536     bool isIgnoringPendingStylesheets() const { return m_ignorePendingStylesheets; }
537
538     WEBCORE_EXPORT StyleSheetList& styleSheets();
539
540     Style::Scope& styleScope() { return *m_styleScope; }
541     const Style::Scope& styleScope() const { return *m_styleScope; }
542     ExtensionStyleSheets& extensionStyleSheets() { return *m_extensionStyleSheets; }
543     const ExtensionStyleSheets& extensionStyleSheets() const { return *m_extensionStyleSheets; }
544
545     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
546     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
547
548     void evaluateMediaQueryList();
549
550     FormController& formController();
551     Vector<String> formElementsState() const;
552     void setStateForNewFormElements(const Vector<String>&);
553
554     WEBCORE_EXPORT FrameView* view() const; // Can be null.
555     WEBCORE_EXPORT Page* page() const; // Can be null.
556     const Settings& settings() const { return m_settings.get(); }
557     Settings& mutableSettings() { return m_settings.get(); }
558
559     const Quirks& quirks() const { return m_quirks; }
560
561     float deviceScaleFactor() const;
562
563     WEBCORE_EXPORT bool useSystemAppearance() const;
564     WEBCORE_EXPORT bool useDarkAppearance(const RenderStyle*) const;
565
566     OptionSet<StyleColor::Options> styleColorOptions(const RenderStyle*) const;
567
568     WEBCORE_EXPORT Ref<Range> createRange();
569
570     // The last bool parameter is for ObjC bindings.
571     WEBCORE_EXPORT Ref<NodeIterator> createNodeIterator(Node& root, unsigned long whatToShow = 0xFFFFFFFF, RefPtr<NodeFilter>&& = nullptr, bool = false);
572
573     // The last bool parameter is for ObjC bindings.
574     WEBCORE_EXPORT Ref<TreeWalker> createTreeWalker(Node& root, unsigned long whatToShow = 0xFFFFFFFF, RefPtr<NodeFilter>&& = nullptr, bool = false);
575
576     // Special support for editing
577     WEBCORE_EXPORT Ref<CSSStyleDeclaration> createCSSStyleDeclaration();
578     Ref<Text> createEditingTextNode(const String&);
579
580     enum class ResolveStyleType { Normal, Rebuild };
581     void resolveStyle(ResolveStyleType = ResolveStyleType::Normal);
582     WEBCORE_EXPORT bool updateStyleIfNeeded();
583     bool needsStyleRecalc() const;
584     unsigned lastStyleUpdateSizeForTesting() const { return m_lastStyleUpdateSizeForTesting; }
585
586     WEBCORE_EXPORT void updateLayout();
587     
588     // updateLayoutIgnorePendingStylesheets() forces layout even if we are waiting for pending stylesheet loads,
589     // so calling this may cause a flash of unstyled content (FOUC).
590     enum class RunPostLayoutTasks { Asynchronously, Synchronously };
591     WEBCORE_EXPORT void updateLayoutIgnorePendingStylesheets(RunPostLayoutTasks = RunPostLayoutTasks::Asynchronously);
592
593     std::unique_ptr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element&, const RenderStyle* parentStyle, PseudoId = PseudoId::None);
594
595     // Returns true if page box (margin boxes and page borders) is visible.
596     WEBCORE_EXPORT bool isPageBoxVisible(int pageIndex);
597
598     // Returns the preferred page size and margins in pixels, assuming 96
599     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
600     // marginLeft must be initialized to the default values that are used if
601     // auto is specified.
602     WEBCORE_EXPORT void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
603
604     CachedResourceLoader& cachedResourceLoader() { return m_cachedResourceLoader; }
605
606     void didBecomeCurrentDocumentInFrame();
607     void destroyRenderTree();
608     void prepareForDestruction();
609
610     // Override ScriptExecutionContext methods to do additional work
611     WEBCORE_EXPORT bool shouldBypassMainWorldContentSecurityPolicy() const final;
612     void suspendActiveDOMObjects(ReasonForSuspension) final;
613     void resumeActiveDOMObjects(ReasonForSuspension) final;
614     void stopActiveDOMObjects() final;
615
616     void suspendDeviceMotionAndOrientationUpdates();
617     void resumeDeviceMotionAndOrientationUpdates();
618
619     RenderView* renderView() const { return m_renderView.get(); }
620
621     bool renderTreeBeingDestroyed() const { return m_renderTreeBeingDestroyed; }
622     bool hasLivingRenderTree() const { return renderView() && !renderTreeBeingDestroyed(); }
623     
624     bool updateLayoutIfDimensionsOutOfDate(Element&, DimensionsCheck = AllDimensionsCheck);
625     
626     AXObjectCache* existingAXObjectCache() const;
627     WEBCORE_EXPORT AXObjectCache* axObjectCache() const;
628     void clearAXObjectCache();
629
630     Optional<uint64_t> pageID() const;
631     // to get visually ordered hebrew and arabic pages right
632     void setVisuallyOrdered();
633     bool visuallyOrdered() const { return m_visuallyOrdered; }
634     
635     WEBCORE_EXPORT DocumentLoader* loader() const;
636
637     WEBCORE_EXPORT ExceptionOr<RefPtr<WindowProxy>> openForBindings(DOMWindow& activeWindow, DOMWindow& firstDOMWindow, const String& url, const AtomicString& name, const String& features);
638     WEBCORE_EXPORT ExceptionOr<Document&> openForBindings(Document* responsibleDocument, const String&, const String&);
639
640     // FIXME: We should rename this at some point and give back the name 'open' to the HTML specified ones.
641     WEBCORE_EXPORT ExceptionOr<void> open(Document* responsibleDocument = nullptr);
642     void implicitOpen();
643
644     WEBCORE_EXPORT ExceptionOr<void> closeForBindings();
645
646     // FIXME: We should rename this at some point and give back the name 'close' to the HTML specified one.
647     WEBCORE_EXPORT void close();
648     // In some situations (see the code), we ignore document.close().
649     // explicitClose() bypass these checks and actually tries to close the
650     // input stream.
651     void explicitClose();
652     // implicitClose() actually does the work of closing the input stream.
653     void implicitClose();
654
655     void cancelParsing();
656
657     ExceptionOr<void> write(Document* responsibleDocument, SegmentedString&&);
658     WEBCORE_EXPORT ExceptionOr<void> write(Document* responsibleDocument, Vector<String>&&);
659     WEBCORE_EXPORT ExceptionOr<void> writeln(Document* responsibleDocument, Vector<String>&&);
660
661     bool wellFormed() const { return m_wellFormed; }
662
663     const URL& url() const final { return m_url; }
664     void setURL(const URL&);
665     const URL& urlForBindings() const { return m_url.isEmpty() ? WTF::blankURL() : m_url; }
666
667     // To understand how these concepts relate to one another, please see the
668     // comments surrounding their declaration.
669     const URL& baseURL() const { return m_baseURL; }
670     void setBaseURLOverride(const URL&);
671     const URL& baseURLOverride() const { return m_baseURLOverride; }
672     const URL& baseElementURL() const { return m_baseElementURL; }
673     const String& baseTarget() const { return m_baseTarget; }
674     void processBaseElement();
675
676     WEBCORE_EXPORT URL completeURL(const String&) const final;
677     URL completeURL(const String&, const URL& baseURLOverride) const;
678     WEBCORE_EXPORT PAL::SessionID sessionID() const final;
679
680     String userAgent(const URL&) const final;
681
682     void disableEval(const String& errorMessage) final;
683     void disableWebAssembly(const String& errorMessage) final;
684
685 #if ENABLE(INDEXED_DATABASE)
686     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
687 #endif
688     SocketProvider* socketProvider() final;
689
690     bool canNavigate(Frame* targetFrame, const URL& destinationURL = URL());
691
692     bool usesStyleBasedEditability() const;
693     void setHasElementUsingStyleBasedEditability();
694     
695     virtual Ref<DocumentParser> createParser();
696     DocumentParser* parser() const { return m_parser.get(); }
697     ScriptableDocumentParser* scriptableDocumentParser() const;
698     
699     bool printing() const { return m_printing; }
700     void setPrinting(bool p) { m_printing = p; }
701
702     bool paginatedForScreen() const { return m_paginatedForScreen; }
703     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
704     
705     bool paginated() const { return printing() || paginatedForScreen(); }
706
707     void setCompatibilityMode(DocumentCompatibilityMode);
708     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
709     static ptrdiff_t compatibilityModeMemoryOffset() { return OBJECT_OFFSETOF(Document, m_compatibilityMode); }
710
711     WEBCORE_EXPORT String compatMode() const;
712
713     bool inQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::QuirksMode; }
714     bool inLimitedQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::LimitedQuirksMode; }
715     bool inNoQuirksMode() const { return m_compatibilityMode == DocumentCompatibilityMode::NoQuirksMode; }
716
717     void setReadyState(ReadyState);
718     void setParsing(bool);
719     bool parsing() const { return m_bParsing; }
720     Seconds minimumLayoutDelay();
721
722     bool shouldScheduleLayout();
723     bool isLayoutTimerActive();
724     Seconds timeSinceDocumentCreation() const;
725     
726     void setTextColor(const Color& color) { m_textColor = color; }
727     const Color& textColor() const { return m_textColor; }
728
729     const Color& linkColor() const { return m_linkColor; }
730     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
731     const Color& activeLinkColor() const { return m_activeLinkColor; }
732     void setLinkColor(const Color& c) { m_linkColor = c; }
733     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
734     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
735     void resetLinkColor();
736     void resetVisitedLinkColor();
737     void resetActiveLinkColor();
738     VisitedLinkState& visitedLinkState() const { return *m_visitedLinkState; }
739
740     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const LayoutPoint&, const PlatformMouseEvent&);
741
742     enum class FocusRemovalEventsMode { Dispatch, DoNotDispatch };
743     WEBCORE_EXPORT bool setFocusedElement(Element*, FocusDirection = FocusDirectionNone,
744         FocusRemovalEventsMode = FocusRemovalEventsMode::Dispatch);
745     Element* focusedElement() const { return m_focusedElement.get(); }
746     UserActionElementSet& userActionElements()  { return m_userActionElements; }
747     const UserActionElementSet& userActionElements() const { return m_userActionElements; }
748
749     void setFocusNavigationStartingNode(Node*);
750     Element* focusNavigationStartingNode(FocusDirection) const;
751
752     enum class NodeRemoval { Node, ChildrenOfNode };
753     void adjustFocusedNodeOnNodeRemoval(Node&, NodeRemoval = NodeRemoval::Node);
754     void adjustFocusNavigationNodeOnNodeRemoval(Node&, NodeRemoval = NodeRemoval::Node);
755
756     void hoveredElementDidDetach(Element&);
757     void elementInActiveChainDidDetach(Element&);
758
759     void updateHoverActiveState(const HitTestRequest&, Element*);
760
761     // Updates for :target (CSS3 selector).
762     void setCSSTarget(Element*);
763     Element* cssTarget() const { return m_cssTarget; }
764     static ptrdiff_t cssTargetMemoryOffset() { return OBJECT_OFFSETOF(Document, m_cssTarget); }
765
766     WEBCORE_EXPORT void scheduleFullStyleRebuild();
767     void scheduleStyleRecalc();
768     void unscheduleStyleRecalc();
769     bool hasPendingStyleRecalc() const;
770     bool hasPendingFullStyleRebuild() const;
771
772     void registerNodeListForInvalidation(LiveNodeList&);
773     void unregisterNodeListForInvalidation(LiveNodeList&);
774     WEBCORE_EXPORT void registerCollection(HTMLCollection&);
775     void unregisterCollection(HTMLCollection&);
776     void collectionCachedIdNameMap(const HTMLCollection&);
777     void collectionWillClearIdNameMap(const HTMLCollection&);
778     bool shouldInvalidateNodeListAndCollectionCaches() const;
779     bool shouldInvalidateNodeListAndCollectionCachesForAttribute(const QualifiedName& attrName) const;
780
781     template <typename InvalidationFunction>
782     void invalidateNodeListAndCollectionCaches(InvalidationFunction);
783
784     void attachNodeIterator(NodeIterator&);
785     void detachNodeIterator(NodeIterator&);
786     void moveNodeIteratorsToNewDocument(Node& node, Document& newDocument)
787     {
788         if (!m_nodeIterators.isEmpty())
789             moveNodeIteratorsToNewDocumentSlowCase(node, newDocument);
790     }
791
792     void attachRange(Range&);
793     void detachRange(Range&);
794
795     void updateRangesAfterChildrenChanged(ContainerNode&);
796     // nodeChildrenWillBeRemoved is used when removing all node children at once.
797     void nodeChildrenWillBeRemoved(ContainerNode&);
798     // nodeWillBeRemoved is only safe when removing one node at a time.
799     void nodeWillBeRemoved(Node&);
800
801     enum class AcceptChildOperation { Replace, InsertOrAdd };
802     bool canAcceptChild(const Node& newChild, const Node* refChild, AcceptChildOperation) const;
803
804     void textInserted(Node&, unsigned offset, unsigned length);
805     void textRemoved(Node&, unsigned offset, unsigned length);
806     void textNodesMerged(Text& oldNode, unsigned offset);
807     void textNodeSplit(Text& oldNode);
808
809     void createDOMWindow();
810     void takeDOMWindowFrom(Document&);
811
812     DOMWindow* domWindow() const { return m_domWindow.get(); }
813     // In DOM Level 2, the Document's DOMWindow is called the defaultView.
814     WEBCORE_EXPORT WindowProxy* windowProxy() const;
815
816     bool hasBrowsingContext() const { return !!frame(); }
817
818     Document& contextDocument() const;
819     void setContextDocument(Document& document) { m_contextDocument = makeWeakPtr(document); }
820
821     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
822     void setWindowAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value, DOMWrapperWorld&);
823     void setWindowAttributeEventListener(const AtomicString& eventType, RefPtr<EventListener>&&, DOMWrapperWorld&);
824     EventListener* getWindowAttributeEventListener(const AtomicString& eventType, DOMWrapperWorld&);
825     WEBCORE_EXPORT void dispatchWindowEvent(Event&, EventTarget* = nullptr);
826     void dispatchWindowLoadEvent();
827
828     WEBCORE_EXPORT ExceptionOr<Ref<Event>> createEvent(const String& eventType);
829
830     // keep track of what types of event listeners are registered, so we don't
831     // dispatch events unnecessarily
832     enum ListenerType {
833         DOMSUBTREEMODIFIED_LISTENER          = 1,
834         DOMNODEINSERTED_LISTENER             = 1 << 1,
835         DOMNODEREMOVED_LISTENER              = 1 << 2,
836         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 1 << 3,
837         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 1 << 4,
838         DOMCHARACTERDATAMODIFIED_LISTENER    = 1 << 5,
839         OVERFLOWCHANGED_LISTENER             = 1 << 6,
840         ANIMATIONEND_LISTENER                = 1 << 7,
841         ANIMATIONSTART_LISTENER              = 1 << 8,
842         ANIMATIONITERATION_LISTENER          = 1 << 9,
843         TRANSITIONEND_LISTENER               = 1 << 10,
844         BEFORELOAD_LISTENER                  = 1 << 11,
845         SCROLL_LISTENER                      = 1 << 12,
846         FORCEWILLBEGIN_LISTENER              = 1 << 13,
847         FORCECHANGED_LISTENER                = 1 << 14,
848         FORCEDOWN_LISTENER                   = 1 << 15,
849         FORCEUP_LISTENER                     = 1 << 16,
850         RESIZE_LISTENER                      = 1 << 17
851     };
852
853     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
854     bool hasListenerTypeForEventType(PlatformEvent::Type) const;
855     void addListenerTypeIfNeeded(const AtomicString& eventType);
856
857     bool hasMutationObserversOfType(MutationObserver::MutationType type) const
858     {
859         return m_mutationObserverTypes & type;
860     }
861     bool hasMutationObservers() const { return m_mutationObserverTypes; }
862     void addMutationObserverTypes(MutationObserverOptions types) { m_mutationObserverTypes |= types; }
863
864     CSSStyleDeclaration* getOverrideStyle(Element*, const String&) { return nullptr; }
865
866     // Handles an HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
867     // when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
868     // tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
869     // specified in an HTML file.
870     void processHttpEquiv(const String& equiv, const String& content, bool isInDocumentHead);
871
872 #if PLATFORM(IOS_FAMILY)
873     void processFormatDetection(const String&);
874
875     // Called when <meta name="apple-mobile-web-app-orientations"> changes.
876     void processWebAppOrientations();
877
878     WEBCORE_EXPORT ContentChangeObserver& contentChangeObserver();
879 #endif
880     
881     void processViewport(const String& features, ViewportArguments::Type origin);
882     void processDisabledAdaptations(const String& adaptations);
883     void updateViewportArguments();
884     void processReferrerPolicy(const String& policy, ReferrerPolicySource);
885
886 #if ENABLE(DARK_MODE_CSS)
887     void processSupportedColorSchemes(const String& colorSchemes);
888 #endif
889
890     // Returns the owning element in the parent document.
891     // Returns nullptr if this is the top level document.
892     HTMLFrameOwnerElement* ownerElement() const;
893
894     // Used by DOM bindings; no direction known.
895     const String& title() const { return m_title.string; }
896     WEBCORE_EXPORT void setTitle(const String&);
897
898     WEBCORE_EXPORT const AtomicString& dir() const;
899     WEBCORE_EXPORT void setDir(const AtomicString&);
900
901     void titleElementAdded(Element& titleElement);
902     void titleElementRemoved(Element& titleElement);
903     void titleElementTextChanged(Element& titleElement);
904
905     WEBCORE_EXPORT ExceptionOr<String> cookie();
906     WEBCORE_EXPORT ExceptionOr<void> setCookie(const String&);
907
908     WEBCORE_EXPORT String referrer() const;
909
910     WEBCORE_EXPORT String origin() const final;
911
912     WEBCORE_EXPORT String domain() const;
913     ExceptionOr<void> setDomain(const String& newDomain);
914
915     void overrideLastModified(const Optional<WallTime>&);
916     WEBCORE_EXPORT String lastModified() const;
917
918     // The cookieURL is used to query the cookie database for this document's
919     // cookies. For example, if the cookie URL is http://example.com, we'll
920     // use the non-Secure cookies for example.com when computing
921     // document.cookie.
922     //
923     // Q: How is the cookieURL different from the document's URL?
924     // A: The two URLs are the same almost all the time.  However, if one
925     //    document inherits the security context of another document, it
926     //    inherits its cookieURL but not its URL.
927     //
928     const URL& cookieURL() const { return m_cookieURL; }
929     void setCookieURL(const URL&);
930
931     // The firstPartyForCookies is used to compute whether this document
932     // appears in a "third-party" context for the purpose of third-party
933     // cookie blocking.  The document is in a third-party context if the
934     // cookieURL and the firstPartyForCookies are from different hosts.
935     //
936     // Note: Some ports (including possibly Apple's) only consider the
937     //       document in a third-party context if the cookieURL and the
938     //       firstPartyForCookies have a different registry-controlled
939     //       domain.
940     //
941     const URL& firstPartyForCookies() const { return m_firstPartyForCookies; }
942     void setFirstPartyForCookies(const URL& url) { m_firstPartyForCookies = url; }
943
944     bool isFullyActive() const;
945
946     // The full URL corresponding to the "site for cookies" in the Same-Site Cookies spec.,
947     // <https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00>. It is either
948     // the URL of the top-level document or the null URL depending on whether the registrable
949     // domain of this document's URL matches the registrable domain of its parent's/opener's
950     // URL. For the top-level document, it is set to the document's URL.
951     const URL& siteForCookies() const { return m_siteForCookies; }
952     void setSiteForCookies(const URL& url) { m_siteForCookies = url; }
953     
954     // The following implements the rule from HTML 4 for what valid names are.
955     // To get this right for all the XML cases, we probably have to improve this or move it
956     // and make it sensitive to the type of document.
957     static bool isValidName(const String&);
958
959     // The following breaks a qualified name into a prefix and a local name.
960     // It also does a validity check, and returns an error if the qualified name is invalid.
961     static ExceptionOr<std::pair<AtomicString, AtomicString>> parseQualifiedName(const String& qualifiedName);
962     static ExceptionOr<QualifiedName> parseQualifiedName(const AtomicString& namespaceURI, const String& qualifiedName);
963
964     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
965     static bool hasValidNamespaceForElements(const QualifiedName&);
966     static bool hasValidNamespaceForAttributes(const QualifiedName&);
967
968     // This is the "HTML body element" as defined by CSSOM View spec, the first body child of the
969     // document element. See http://dev.w3.org/csswg/cssom-view/#the-html-body-element.
970     WEBCORE_EXPORT HTMLBodyElement* body() const;
971
972     // This is the "body element" as defined by HTML5, the first body or frameset child of the
973     // document element. See https://html.spec.whatwg.org/multipage/dom.html#the-body-element-2.
974     WEBCORE_EXPORT HTMLElement* bodyOrFrameset() const;
975     WEBCORE_EXPORT ExceptionOr<void> setBodyOrFrameset(RefPtr<HTMLElement>&&);
976
977     Location* location() const;
978
979     WEBCORE_EXPORT HTMLHeadElement* head();
980
981     DocumentMarkerController& markers() const { return *m_markers; }
982
983     WEBCORE_EXPORT bool execCommand(const String& command, bool userInterface = false, const String& value = String());
984     WEBCORE_EXPORT bool queryCommandEnabled(const String& command);
985     WEBCORE_EXPORT bool queryCommandIndeterm(const String& command);
986     WEBCORE_EXPORT bool queryCommandState(const String& command);
987     WEBCORE_EXPORT bool queryCommandSupported(const String& command);
988     WEBCORE_EXPORT String queryCommandValue(const String& command);
989
990     UndoManager& undoManager() const { return m_undoManager.get(); }
991
992     // designMode support
993     enum InheritedBool { off = false, on = true, inherit };    
994     void setDesignMode(InheritedBool value);
995     InheritedBool getDesignMode() const;
996     bool inDesignMode() const;
997     WEBCORE_EXPORT String designMode() const;
998     WEBCORE_EXPORT void setDesignMode(const String&);
999
1000     Document* parentDocument() const;
1001     WEBCORE_EXPORT Document& topDocument() const;
1002     
1003     ScriptRunner& scriptRunner() { return *m_scriptRunner; }
1004     ScriptModuleLoader& moduleLoader() { return *m_moduleLoader; }
1005
1006     HTMLScriptElement* currentScript() const { return !m_currentScriptStack.isEmpty() ? m_currentScriptStack.last().get() : nullptr; }
1007     void pushCurrentScript(HTMLScriptElement*);
1008     void popCurrentScript();
1009
1010     bool shouldDeferAsynchronousScriptsUntilParsingFinishes() const;
1011
1012 #if ENABLE(XSLT)
1013     void scheduleToApplyXSLTransforms();
1014     void applyPendingXSLTransformsNowIfScheduled();
1015     RefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
1016     void setTransformSourceDocument(Document* document) { m_transformSourceDocument = document; }
1017
1018     void setTransformSource(std::unique_ptr<TransformSource>);
1019     TransformSource* transformSource() const { return m_transformSource.get(); }
1020 #endif
1021
1022     void incDOMTreeVersion() { m_domTreeVersion = ++s_globalTreeVersion; }
1023     uint64_t domTreeVersion() const { return m_domTreeVersion; }
1024
1025     WEBCORE_EXPORT String originIdentifierForPasteboard();
1026
1027     // XPathEvaluator methods
1028     WEBCORE_EXPORT ExceptionOr<Ref<XPathExpression>> createExpression(const String& expression, RefPtr<XPathNSResolver>&&);
1029     WEBCORE_EXPORT Ref<XPathNSResolver> createNSResolver(Node* nodeResolver);
1030     WEBCORE_EXPORT ExceptionOr<Ref<XPathResult>> evaluate(const String& expression, Node* contextNode, RefPtr<XPathNSResolver>&&, unsigned short type, XPathResult*);
1031
1032     bool hasNodesWithNonFinalStyle() const { return m_hasNodesWithNonFinalStyle; }
1033     void setHasNodesWithNonFinalStyle() { m_hasNodesWithNonFinalStyle = true; }
1034     bool hasNodesWithMissingStyle() const { return m_hasNodesWithMissingStyle; }
1035     void setHasNodesWithMissingStyle() { m_hasNodesWithMissingStyle = true; }
1036
1037     // Extension for manipulating canvas drawing contexts for use in CSS
1038     Optional<RenderingContext> getCSSCanvasContext(const String& type, const String& name, int width, int height);
1039     HTMLCanvasElement* getCSSCanvasElement(const String& name);
1040     String nameForCSSCanvasElement(const HTMLCanvasElement&) const;
1041
1042     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
1043     void parseDNSPrefetchControlHeader(const String&);
1044
1045     WEBCORE_EXPORT void postTask(Task&&) final; // Executes the task on context's thread asynchronously.
1046
1047     ScriptedAnimationController* scriptedAnimationController() { return m_scriptedAnimationController.get(); }
1048     void suspendScriptedAnimationControllerCallbacks();
1049     void resumeScriptedAnimationControllerCallbacks();
1050
1051     void updateAnimationsAndSendEvents(DOMHighResTimeStamp timestamp);
1052     void serviceRequestAnimationFrameCallbacks(DOMHighResTimeStamp timestamp);
1053
1054     void windowScreenDidChange(PlatformDisplayID);
1055
1056     void finishedParsing();
1057
1058     enum PageCacheState { NotInPageCache, AboutToEnterPageCache, InPageCache };
1059
1060     PageCacheState pageCacheState() const { return m_pageCacheState; }
1061     void setPageCacheState(PageCacheState);
1062
1063     void registerForDocumentSuspensionCallbacks(Element&);
1064     void unregisterForDocumentSuspensionCallbacks(Element&);
1065
1066     void documentWillBecomeInactive();
1067     void suspend(ReasonForSuspension);
1068     void resume(ReasonForSuspension);
1069
1070     void registerForMediaVolumeCallbacks(Element&);
1071     void unregisterForMediaVolumeCallbacks(Element&);
1072     void mediaVolumeDidChange();
1073
1074     bool audioPlaybackRequiresUserGesture() const;
1075     bool videoPlaybackRequiresUserGesture() const;
1076
1077 #if ENABLE(MEDIA_SESSION)
1078     MediaSession& defaultMediaSession();
1079 #endif
1080
1081     void registerForPrivateBrowsingStateChangedCallbacks(Element&);
1082     void unregisterForPrivateBrowsingStateChangedCallbacks(Element&);
1083     void storageBlockingStateDidChange();
1084     void privateBrowsingStateDidChange();
1085
1086 #if ENABLE(VIDEO_TRACK)
1087     void registerForCaptionPreferencesChangedCallbacks(Element&);
1088     void unregisterForCaptionPreferencesChangedCallbacks(Element&);
1089     void captionPreferencesChanged();
1090 #endif
1091
1092 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1093     void registerForPageScaleFactorChangedCallbacks(HTMLMediaElement&);
1094     void unregisterForPageScaleFactorChangedCallbacks(HTMLMediaElement&);
1095     void pageScaleFactorChangedAndStable();
1096     void registerForUserInterfaceLayoutDirectionChangedCallbacks(HTMLMediaElement&);
1097     void unregisterForUserInterfaceLayoutDirectionChangedCallbacks(HTMLMediaElement&);
1098     void userInterfaceLayoutDirectionChanged();
1099 #endif
1100
1101     void registerForVisibilityStateChangedCallbacks(VisibilityChangeClient&);
1102     void unregisterForVisibilityStateChangedCallbacks(VisibilityChangeClient&);
1103
1104 #if ENABLE(VIDEO)
1105     void registerForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement&);
1106     void unregisterForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement&);
1107     void allowsMediaDocumentInlinePlaybackChanged();
1108
1109     void stopAllMediaPlayback();
1110     void suspendAllMediaPlayback();
1111     void resumeAllMediaPlayback();
1112     void suspendAllMediaBuffering();
1113     void resumeAllMediaBuffering();
1114 #endif
1115
1116     WEBCORE_EXPORT void setShouldCreateRenderers(bool);
1117     bool shouldCreateRenderers();
1118
1119     void setDecoder(RefPtr<TextResourceDecoder>&&);
1120     TextResourceDecoder* decoder() const { return m_decoder.get(); }
1121
1122     WEBCORE_EXPORT String displayStringModifiedByEncoding(const String&) const;
1123
1124 #if ENABLE(DASHBOARD_SUPPORT)
1125     void setHasAnnotatedRegions(bool f) { m_hasAnnotatedRegions = f; }
1126     WEBCORE_EXPORT const Vector<AnnotatedRegionValue>& annotatedRegions() const;
1127 #endif
1128
1129     enum class AnnotationsAction { Invalidate, Update };
1130     void invalidateRenderingDependentRegions(AnnotationsAction = AnnotationsAction::Invalidate);
1131     void invalidateScrollbarDependentRegions();
1132     void updateZOrderDependentRegions();
1133
1134     void removeAllEventListeners() final;
1135
1136     WEBCORE_EXPORT const SVGDocumentExtensions* svgExtensions();
1137     WEBCORE_EXPORT SVGDocumentExtensions& accessSVGExtensions();
1138
1139     void addSVGUseElement(SVGUseElement&);
1140     void removeSVGUseElement(SVGUseElement&);
1141     HashSet<SVGUseElement*> const svgUseElements() const { return m_svgUseElements; }
1142
1143     void initSecurityContext();
1144     void initContentSecurityPolicy();
1145
1146     void updateURLForPushOrReplaceState(const URL&);
1147     void statePopped(Ref<SerializedScriptValue>&&);
1148
1149     bool processingLoadEvent() const { return m_processingLoadEvent; }
1150     bool loadEventFinished() const { return m_loadEventFinished; }
1151
1152     bool isContextThread() const final;
1153     bool isSecureContext() const final;
1154     bool isJSExecutionForbidden() const final { return false; }
1155
1156     void enqueueWindowEvent(Ref<Event>&&);
1157     void enqueueDocumentEvent(Ref<Event>&&);
1158     void enqueueOverflowEvent(Ref<Event>&&);
1159     void dispatchPageshowEvent(PageshowEventPersistence);
1160     WEBCORE_EXPORT void enqueueSecurityPolicyViolationEvent(SecurityPolicyViolationEvent::Init&&);
1161     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1162     void dispatchPopstateEvent(RefPtr<SerializedScriptValue>&& stateObject);
1163     DocumentEventQueue& eventQueue() const final { return m_eventQueue; }
1164
1165     WEBCORE_EXPORT void addMediaCanStartListener(MediaCanStartListener&);
1166     WEBCORE_EXPORT void removeMediaCanStartListener(MediaCanStartListener&);
1167     MediaCanStartListener* takeAnyMediaCanStartListener();
1168
1169 #if ENABLE(FULLSCREEN_API)
1170     bool webkitIsFullScreen() const { return m_fullScreenElement.get(); }
1171     bool webkitFullScreenKeyboardInputAllowed() const { return m_fullScreenElement.get() && m_areKeysEnabledInFullScreen; }
1172     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1173     Element* webkitCurrentFullScreenElementForBindings() const { return ancestorElementInThisScope(webkitCurrentFullScreenElement()); }
1174
1175     enum FullScreenCheckType {
1176         EnforceIFrameAllowFullScreenRequirement,
1177         ExemptIFrameAllowFullScreenRequirement,
1178     };
1179
1180     void requestFullScreenForElement(Element*, FullScreenCheckType);
1181     WEBCORE_EXPORT void webkitCancelFullScreen();
1182     
1183     WEBCORE_EXPORT void webkitWillEnterFullScreen(Element&);
1184     WEBCORE_EXPORT void webkitDidEnterFullScreen();
1185     WEBCORE_EXPORT void webkitWillExitFullScreen();
1186     WEBCORE_EXPORT void webkitDidExitFullScreen();
1187     
1188     void setFullScreenRenderer(RenderTreeBuilder&, RenderFullScreen&);
1189     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer.get(); }
1190
1191     void dispatchFullScreenChangeEvents();
1192     bool fullScreenIsAllowedForElement(Element&) const;
1193     void fullScreenElementRemoved();
1194     void adjustFullScreenElementOnNodeRemoval(Node&, NodeRemoval = NodeRemoval::Node);
1195
1196     WEBCORE_EXPORT bool isAnimatingFullScreen() const;
1197     WEBCORE_EXPORT void setAnimatingFullScreen(bool);
1198
1199     WEBCORE_EXPORT bool areFullscreenControlsHidden() const;
1200     WEBCORE_EXPORT void setFullscreenControlsHidden(bool);
1201
1202     WEBCORE_EXPORT bool webkitFullscreenEnabled() const;
1203     Element* webkitFullscreenElement() const { return !m_fullScreenElementStack.isEmpty() ? m_fullScreenElementStack.last().get() : nullptr; }
1204     Element* webkitFullscreenElementForBindings() const { return ancestorElementInThisScope(webkitFullscreenElement()); }
1205     WEBCORE_EXPORT void webkitExitFullscreen();
1206 #endif
1207
1208 #if ENABLE(POINTER_LOCK)
1209     WEBCORE_EXPORT void exitPointerLock();
1210 #endif
1211
1212     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1213     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1214     void decrementLoadEventDelayCount();
1215     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1216     void checkCompleted();
1217
1218 #if ENABLE(IOS_TOUCH_EVENTS)
1219 #include <WebKitAdditions/DocumentIOS.h>
1220 #endif
1221
1222 #if ENABLE(DEVICE_ORIENTATION)
1223 #if PLATFORM(IOS_FAMILY)
1224     DeviceMotionController& deviceMotionController() const;
1225     DeviceOrientationController& deviceOrientationController() const;
1226     WEBCORE_EXPORT void simulateDeviceOrientationChange(double alpha, double beta, double gamma);
1227 #endif
1228
1229     DeviceOrientationAndMotionAccessController& deviceOrientationAndMotionAccessController();
1230 #endif // ENABLE(DEVICE_ORIENTATION)
1231
1232     const DocumentTiming& timing() const { return m_documentTiming; }
1233
1234     WEBCORE_EXPORT double monotonicTimestamp() const;
1235
1236     int requestAnimationFrame(Ref<RequestAnimationFrameCallback>&&);
1237     void cancelAnimationFrame(int id);
1238
1239     EventTarget* errorEventTarget() final;
1240     void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) final;
1241
1242     void initDNSPrefetch();
1243
1244     void didAddWheelEventHandler(Node&);
1245     void didRemoveWheelEventHandler(Node&, EventHandlerRemoval = EventHandlerRemoval::One);
1246
1247     MonotonicTime lastHandledUserGestureTimestamp() const { return m_lastHandledUserGestureTimestamp; }
1248     bool hasHadUserInteraction() const { return static_cast<bool>(m_lastHandledUserGestureTimestamp); }
1249     void updateLastHandledUserGestureTimestamp(MonotonicTime);
1250     bool processingUserGestureForMedia() const;
1251
1252     void setUserDidInteractWithPage(bool userDidInteractWithPage) { ASSERT(&topDocument() == this); m_userDidInteractWithPage = userDidInteractWithPage; }
1253     bool userDidInteractWithPage() const { ASSERT(&topDocument() == this); return m_userDidInteractWithPage; }
1254
1255     // Used for testing. Count handlers in the main document, and one per frame which contains handlers.
1256     WEBCORE_EXPORT unsigned wheelEventHandlerCount() const;
1257     WEBCORE_EXPORT unsigned touchEventHandlerCount() const;
1258
1259     WEBCORE_EXPORT void startTrackingStyleRecalcs();
1260     WEBCORE_EXPORT unsigned styleRecalcCount() const;
1261
1262 #if ENABLE(TOUCH_EVENTS)
1263     bool hasTouchEventHandlers() const { return (m_touchEventTargets.get()) ? m_touchEventTargets->size() : false; }
1264     bool touchEventTargetsContain(Node& node) const { return m_touchEventTargets ? m_touchEventTargets->contains(&node) : false; }
1265 #else
1266     bool hasTouchEventHandlers() const { return false; }
1267     bool touchEventTargetsContain(Node&) const { return false; }
1268 #endif
1269 #if PLATFORM(IOS_FAMILY) && ENABLE(POINTER_EVENTS)
1270     void updateTouchActionElements(Element&, const RenderStyle&);
1271     const HashSet<RefPtr<Element>>* touchActionElements() const { return m_touchActionElements.get(); }
1272 #endif
1273
1274     void didAddTouchEventHandler(Node&);
1275     void didRemoveTouchEventHandler(Node&, EventHandlerRemoval = EventHandlerRemoval::One);
1276
1277     void didRemoveEventTargetNode(Node&);
1278
1279     const EventTargetSet* touchEventTargets() const
1280     {
1281 #if ENABLE(TOUCH_EVENTS)
1282         return m_touchEventTargets.get();
1283 #else
1284         return nullptr;
1285 #endif
1286     }
1287
1288     const EventTargetSet* wheelEventTargets() const { return m_wheelEventTargets.get(); }
1289
1290     typedef std::pair<Region, bool> RegionFixedPair;
1291     RegionFixedPair absoluteEventRegionForNode(Node&);
1292     RegionFixedPair absoluteRegionForEventTargets(const EventTargetSet*);
1293
1294     LayoutRect absoluteEventHandlerBounds(bool&) final;
1295
1296     bool visualUpdatesAllowed() const { return m_visualUpdatesAllowed; }
1297
1298     bool isInDocumentWrite() { return m_writeRecursionDepth > 0; }
1299
1300     void suspendScheduledTasks(ReasonForSuspension);
1301     void resumeScheduledTasks(ReasonForSuspension);
1302
1303 #if ENABLE(CSS_DEVICE_ADAPTATION)
1304     IntSize initialViewportSize() const;
1305 #endif
1306
1307     void convertAbsoluteToClientQuads(Vector<FloatQuad>&, const RenderStyle&);
1308     void convertAbsoluteToClientRects(Vector<FloatRect>&, const RenderStyle&);
1309     void convertAbsoluteToClientRect(FloatRect&, const RenderStyle&);
1310
1311     bool hasActiveParser();
1312     void incrementActiveParserCount() { ++m_activeParserCount; }
1313     void decrementActiveParserCount();
1314
1315     std::unique_ptr<DocumentParserYieldToken> createParserYieldToken()
1316     {
1317         return std::make_unique<DocumentParserYieldToken>(*this);
1318     }
1319
1320     bool hasActiveParserYieldToken() const { return m_parserYieldTokenCount; }
1321
1322     DocumentSharedObjectPool* sharedObjectPool() { return m_sharedObjectPool.get(); }
1323
1324     void invalidateMatchedPropertiesCacheAndForceStyleRecalc();
1325
1326     void didRemoveAllPendingStylesheet();
1327     void didClearStyleResolver();
1328
1329     bool inStyleRecalc() const { return m_inStyleRecalc; }
1330     bool inRenderTreeUpdate() const { return m_inRenderTreeUpdate; }
1331     bool isResolvingTreeStyle() const { return m_isResolvingTreeStyle; }
1332     void setIsResolvingTreeStyle(bool);
1333
1334     void updateTextRenderer(Text&, unsigned offsetOfReplacedText, unsigned lengthOfReplacedText);
1335
1336     // Return a Locale for the default locale if the argument is null or empty.
1337     Locale& getCachedLocale(const AtomicString& locale = nullAtom());
1338
1339     const Document* templateDocument() const;
1340     Document& ensureTemplateDocument();
1341     void setTemplateDocumentHost(Document* templateDocumentHost) { m_templateDocumentHost = templateDocumentHost; }
1342     Document* templateDocumentHost() { return m_templateDocumentHost; }
1343
1344     void didAssociateFormControl(Element&);
1345     bool hasDisabledFieldsetElement() const { return m_disabledFieldsetElementsCount; }
1346     void addDisabledFieldsetElement() { m_disabledFieldsetElementsCount++; }
1347     void removeDisabledFieldsetElement() { ASSERT(m_disabledFieldsetElementsCount); m_disabledFieldsetElementsCount--; }
1348
1349     WEBCORE_EXPORT void addConsoleMessage(std::unique_ptr<Inspector::ConsoleMessage>&&) final;
1350
1351     // The following addConsoleMessage function is deprecated.
1352     // Callers should try to create the ConsoleMessage themselves.
1353     WEBCORE_EXPORT void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0) final;
1354
1355     // The following addMessage function is deprecated.
1356     // Callers should try to create the ConsoleMessage themselves.
1357     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;
1358
1359     SecurityOrigin& securityOrigin() const { return *SecurityContext::securityOrigin(); }
1360     SecurityOrigin& topOrigin() const final { return topDocument().securityOrigin(); }
1361
1362     Ref<FontFaceSet> fonts();
1363
1364     void ensurePlugInsInjectedScript(DOMWrapperWorld&);
1365
1366     void setVisualUpdatesAllowedByClient(bool);
1367
1368 #if ENABLE(WEB_CRYPTO)
1369     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
1370     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
1371 #endif
1372
1373     void setHasStyleWithViewportUnits() { m_hasStyleWithViewportUnits = true; }
1374     bool hasStyleWithViewportUnits() const { return m_hasStyleWithViewportUnits; }
1375     void updateViewportUnitsOnResize();
1376
1377     WEBCORE_EXPORT void addAudioProducer(MediaProducer&);
1378     WEBCORE_EXPORT void removeAudioProducer(MediaProducer&);
1379     MediaProducer::MediaStateFlags mediaState() const { return m_mediaState; }
1380     void noteUserInteractionWithMediaElement();
1381     bool isCapturing() const { return MediaProducer::isCapturing(m_mediaState); }
1382     WEBCORE_EXPORT void updateIsPlayingMedia(uint64_t = HTMLMediaElementInvalidID);
1383     void pageMutedStateDidChange();
1384
1385 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1386     void addPlaybackTargetPickerClient(MediaPlaybackTargetClient&);
1387     void removePlaybackTargetPickerClient(MediaPlaybackTargetClient&);
1388     void showPlaybackTargetPicker(MediaPlaybackTargetClient&, bool, RouteSharingPolicy, const String&);
1389     void playbackTargetPickerClientStateDidChange(MediaPlaybackTargetClient&, MediaProducer::MediaStateFlags);
1390
1391     void setPlaybackTarget(uint64_t, Ref<MediaPlaybackTarget>&&);
1392     void playbackTargetAvailabilityDidChange(uint64_t, bool);
1393     void setShouldPlayToPlaybackTarget(uint64_t, bool);
1394 #endif
1395
1396     ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToPropagate() const;
1397     bool shouldEnforceContentDispositionAttachmentSandbox() const;
1398     void applyContentDispositionAttachmentSandbox();
1399
1400     void addViewportDependentPicture(HTMLPictureElement&);
1401     void removeViewportDependentPicture(HTMLPictureElement&);
1402
1403     void addAppearanceDependentPicture(HTMLPictureElement&);
1404     void removeAppearanceDependentPicture(HTMLPictureElement&);
1405
1406 #if ENABLE(INTERSECTION_OBSERVER)
1407     void addIntersectionObserver(IntersectionObserver&);
1408     void removeIntersectionObserver(IntersectionObserver&);
1409     unsigned numberOfIntersectionObservers() const { return m_intersectionObservers.size(); }
1410     void updateIntersectionObservations();
1411 #endif
1412
1413 #if ENABLE(MEDIA_STREAM)
1414     void setHasCaptureMediaStreamTrack() { m_hasHadCaptureMediaStreamTrack = true; }
1415     bool hasHadCaptureMediaStreamTrack() const { return m_hasHadCaptureMediaStreamTrack; }
1416     void setDeviceIDHashSalt(const String&);
1417     String deviceIDHashSalt() const { return m_idHashSalt; }
1418     void stopMediaCapture();
1419     void registerForMediaStreamStateChangeCallbacks(HTMLMediaElement&);
1420     void unregisterForMediaStreamStateChangeCallbacks(HTMLMediaElement&);
1421     void mediaStreamCaptureStateChanged();
1422 #endif
1423
1424 // FIXME: Find a better place for this functionality.
1425 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
1426     // These functions provide a two-level setting:
1427     //    - A user-settable wantsTelephoneNumberParsing (at the Page / WebView level)
1428     //    - A read-only telephoneNumberParsingAllowed which is set by the
1429     //      document if it has the appropriate meta tag.
1430     //    - isTelephoneNumberParsingEnabled() == isTelephoneNumberParsingAllowed() && page()->settings()->isTelephoneNumberParsingEnabled()
1431     WEBCORE_EXPORT bool isTelephoneNumberParsingAllowed() const;
1432     WEBCORE_EXPORT bool isTelephoneNumberParsingEnabled() const;
1433 #endif
1434
1435     using ContainerNode::setAttributeEventListener;
1436     void setAttributeEventListener(const AtomicString& eventType, const QualifiedName& attributeName, const AtomicString& value, DOMWrapperWorld& isolatedWorld);
1437
1438     DOMSelection* getSelection();
1439
1440     void didInsertInDocumentShadowRoot(ShadowRoot&);
1441     void didRemoveInDocumentShadowRoot(ShadowRoot&);
1442     const HashSet<ShadowRoot*>& inDocumentShadowRoots() const { return m_inDocumentShadowRoots; }
1443
1444     void attachToCachedFrame(CachedFrameBase&);
1445     void detachFromCachedFrame(CachedFrameBase&);
1446
1447     ConstantPropertyMap& constantProperties() const { return *m_constantPropertyMap; }
1448
1449     void orientationChanged(int orientation);
1450     OrientationNotifier& orientationNotifier() { return m_orientationNotifier; }
1451
1452     WEBCORE_EXPORT const AtomicString& bgColor() const;
1453     WEBCORE_EXPORT void setBgColor(const String&);
1454     WEBCORE_EXPORT const AtomicString& fgColor() const;
1455     WEBCORE_EXPORT void setFgColor(const String&);
1456     WEBCORE_EXPORT const AtomicString& alinkColor() const;
1457     WEBCORE_EXPORT void setAlinkColor(const String&);
1458     WEBCORE_EXPORT const AtomicString& linkColorForBindings() const;
1459     WEBCORE_EXPORT void setLinkColorForBindings(const String&);
1460     WEBCORE_EXPORT const AtomicString& vlinkColor() const;
1461     WEBCORE_EXPORT void setVlinkColor(const String&);
1462
1463     // Per https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-clear, this method does nothing.
1464     void clear() { }
1465     // Per https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-captureevents, this method does nothing.
1466     void captureEvents() { }
1467     // Per https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-releaseevents, this method does nothing.
1468     void releaseEvents() { }
1469
1470 #if ENABLE(TEXT_AUTOSIZING)
1471     TextAutoSizing& textAutoSizing();
1472 #endif
1473
1474     Logger& logger();
1475
1476     void hasStorageAccess(Ref<DeferredPromise>&& passedPromise);
1477     void requestStorageAccess(Ref<DeferredPromise>&& passedPromise);
1478     void setUserGrantsStorageAccessOverride(bool value) { m_grantStorageAccessOverride = value; }
1479
1480     WEBCORE_EXPORT void setConsoleMessageListener(RefPtr<StringCallback>&&); // For testing.
1481
1482     WEBCORE_EXPORT DocumentTimeline& timeline();
1483     DocumentTimeline* existingTimeline() const { return m_timeline.get(); }
1484     Vector<RefPtr<WebAnimation>> getAnimations();
1485         
1486 #if ENABLE(ATTACHMENT_ELEMENT)
1487     void registerAttachmentIdentifier(const String&);
1488     void didInsertAttachmentElement(HTMLAttachmentElement&);
1489     void didRemoveAttachmentElement(HTMLAttachmentElement&);
1490     WEBCORE_EXPORT RefPtr<HTMLAttachmentElement> attachmentForIdentifier(const String&) const;
1491     const HashMap<String, Ref<HTMLAttachmentElement>>& attachmentElementsByIdentifier() const { return m_attachmentIdentifierToElementMap; }
1492 #endif
1493
1494 #if ENABLE(SERVICE_WORKER)
1495     void setServiceWorkerConnection(SWClientConnection*);
1496 #endif
1497
1498     void addApplicationStateChangeListener(ApplicationStateChangeListener&);
1499     void removeApplicationStateChangeListener(ApplicationStateChangeListener&);
1500     void forEachApplicationStateChangeListener(const Function<void(ApplicationStateChangeListener&)>&);
1501
1502 #if ENABLE(IOS_TOUCH_EVENTS)
1503     bool handlingTouchEvent() const { return m_handlingTouchEvent; }
1504 #endif
1505
1506 #if ENABLE(RESOURCE_LOAD_STATISTICS)
1507     bool hasRequestedPageSpecificStorageAccessWithUserInteraction(const RegistrableDomain&);
1508     void setHasRequestedPageSpecificStorageAccessWithUserInteraction(const RegistrableDomain&);
1509 #endif
1510
1511     String signedPublicKeyAndChallengeString(unsigned keySizeIndex, const String& challengeString, const URL&);
1512
1513     void consumeTemporaryTimeUserGesture();
1514
1515     void registerArticleElement(Element&);
1516     void unregisterArticleElement(Element&);
1517     void updateMainArticleElementAfterLayout();
1518     bool hasMainArticleElement() const { return !!m_mainArticleElement; }
1519
1520     const CSSRegisteredCustomPropertySet& getCSSRegisteredCustomPropertySet() const { return m_CSSRegisteredPropertySet; }
1521     bool registerCSSProperty(CSSRegisteredCustomProperty&&);
1522
1523 #if ENABLE(CSS_PAINTING_API)
1524     Worklet& ensurePaintWorklet();
1525     PaintWorkletGlobalScope* paintWorkletGlobalScopeForName(const String& name);
1526     void setPaintWorkletGlobalScopeForName(const String& name, Ref<PaintWorkletGlobalScope>&&);
1527 #endif
1528
1529     void setAsRunningUserScripts() { m_isRunningUserScripts = true; }
1530     bool isRunningUserScripts() const { return m_isRunningUserScripts; }
1531
1532     void frameWasDisconnectedFromOwner();
1533
1534 protected:
1535     enum ConstructionFlags { Synthesized = 1, NonRenderedPlaceholder = 1 << 1 };
1536     Document(Frame*, const URL&, unsigned = DefaultDocumentClass, unsigned constructionFlags = 0);
1537
1538     void clearXMLVersion() { m_xmlVersion = String(); }
1539
1540     virtual Ref<Document> cloneDocumentWithoutChildren() const;
1541
1542 private:
1543     friend class DocumentParserYieldToken;
1544     friend class Node;
1545     friend class ThrowOnDynamicMarkupInsertionCountIncrementer;
1546     friend class IgnoreOpensDuringUnloadCountIncrementer;
1547     friend class IgnoreDestructiveWriteCountIncrementer;
1548
1549     bool shouldInheritContentSecurityPolicyFromOwner() const;
1550
1551     void updateTitleElement(Element& changingTitleElement);
1552     void willDetachPage() final;
1553     void frameDestroyed() final;
1554
1555     void commonTeardown();
1556
1557     RenderObject* renderer() const = delete;
1558     void setRenderer(RenderObject*) = delete;
1559
1560     void createRenderTree();
1561     void detachParser();
1562
1563     // FontSelectorClient
1564     void fontsNeedUpdate(FontSelector&) final;
1565
1566     bool isDocument() const final { return true; }
1567
1568     void childrenChanged(const ChildChange&) final;
1569
1570     String nodeName() const final;
1571     NodeType nodeType() const final;
1572     bool childTypeAllowed(NodeType) const final;
1573     Ref<Node> cloneNodeInternal(Document&, CloningOperation) final;
1574     void cloneDataFromDocument(const Document&);
1575
1576     void refScriptExecutionContext() final { ref(); }
1577     void derefScriptExecutionContext() final { deref(); }
1578
1579     Seconds minimumDOMTimerInterval() const final;
1580
1581     Seconds domTimerAlignmentInterval(bool hasReachedMaxNestingLevel) const final;
1582
1583     void updateTitleFromTitleElement();
1584     void updateTitle(const StringWithDirection&);
1585     void updateBaseURL();
1586
1587     void invalidateAccessKeyCacheSlowCase();
1588     void buildAccessKeyCache();
1589
1590     void moveNodeIteratorsToNewDocumentSlowCase(Node&, Document&);
1591
1592     void loadEventDelayTimerFired();
1593
1594     void pendingTasksTimerFired();
1595     bool isCookieAverse() const;
1596
1597     void detachFromFrame();
1598
1599     template<CollectionType> Ref<HTMLCollection> ensureCachedCollection();
1600
1601 #if ENABLE(FULLSCREEN_API)
1602     void dispatchFullScreenChangeOrErrorEvent(Deque<RefPtr<Node>>&, const AtomicString& eventName, bool shouldNotifyMediaElement);
1603     void clearFullscreenElementStack();
1604     void popFullscreenElementStack();
1605     void pushFullscreenElementStack(Element&);
1606     void addDocumentToFullScreenChangeEventQueue(Document&);
1607 #endif
1608
1609     void dispatchDisabledAdaptationsDidChangeForMainFrame();
1610
1611     void setVisualUpdatesAllowed(ReadyState);
1612     void setVisualUpdatesAllowed(bool);
1613     void visualUpdatesSuppressionTimerFired();
1614
1615     void addListenerType(ListenerType listenerType) { m_listenerTypes |= listenerType; }
1616
1617     void didAssociateFormControlsTimerFired();
1618
1619     void wheelEventHandlersChanged();
1620
1621 #if ENABLE(DASHBOARD_SUPPORT)
1622     void setAnnotatedRegionsDirty(bool f = true) { m_annotatedRegionsDirty = f; }
1623     bool annotatedRegionsDirty() const { return m_annotatedRegionsDirty; }
1624     bool hasAnnotatedRegions () const { return m_hasAnnotatedRegions; }
1625     void setAnnotatedRegions(const Vector<AnnotatedRegionValue>&);
1626     void updateAnnotatedRegions();
1627 #endif
1628
1629     HttpEquivPolicy httpEquivPolicy() const;
1630     AXObjectCache* existingAXObjectCacheSlow() const;
1631
1632     // DOM Cookies caching.
1633     const String& cachedDOMCookies() const { return m_cachedDOMCookies; }
1634     void setCachedDOMCookies(const String&);
1635     bool isDOMCookieCacheValid() const { return m_cookieCacheExpiryTimer.isActive(); }
1636     void invalidateDOMCookieCache();
1637     void didLoadResourceSynchronously() final;
1638
1639     void checkViewportDependentPictures();
1640     void checkAppearanceDependentPictures();
1641
1642     bool canNavigateInternal(Frame& targetFrame);
1643     bool isNavigationBlockedByThirdPartyIFrameRedirectBlocking(Frame& targetFrame, const URL& destinationURL);
1644
1645 #if ENABLE(INTERSECTION_OBSERVER)
1646     void notifyIntersectionObserversTimerFired();
1647 #endif
1648
1649 #if USE(QUICK_LOOK)
1650     bool shouldEnforceQuickLookSandbox() const;
1651     void applyQuickLookSandbox();
1652 #endif
1653
1654     bool shouldEnforceHTTP09Sandbox() const;
1655
1656     void platformSuspendOrStopActiveDOMObjects();
1657
1658     bool domainIsRegisterable(const String&) const;
1659
1660     void enableTemporaryTimeUserGesture();
1661
1662     bool isBodyPotentiallyScrollable(HTMLBodyElement&);
1663
1664     const Ref<Settings> m_settings;
1665
1666     UniqueRef<Quirks> m_quirks;
1667
1668     std::unique_ptr<StyleResolver> m_userAgentShadowTreeStyleResolver;
1669
1670     RefPtr<DOMWindow> m_domWindow;
1671     WeakPtr<Document> m_contextDocument;
1672
1673     Ref<CachedResourceLoader> m_cachedResourceLoader;
1674     RefPtr<DocumentParser> m_parser;
1675
1676     unsigned m_parserYieldTokenCount { 0 };
1677
1678     // Document URLs.
1679     URL m_url; // Document.URL: The URL from which this document was retrieved.
1680     URL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1681     URL m_baseURLOverride; // An alternative base URL that takes precedence over m_baseURL (but not m_baseElementURL).
1682     URL m_baseElementURL; // The URL set by the <base> element.
1683     URL m_cookieURL; // The URL to use for cookie access.
1684     URL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1685     URL m_siteForCookies; // The policy URL for Same-Site cookies.
1686
1687     // Document.documentURI:
1688     // Although URL-like, Document.documentURI can actually be set to any
1689     // string by content.  Document.documentURI affects m_baseURL unless the
1690     // document contains a <base> element, in which case the <base> element
1691     // takes precedence.
1692     //
1693     // This property is read-only from JavaScript, but writable from Objective C.
1694     String m_documentURI;
1695
1696     String m_baseTarget;
1697
1698     // MIME type of the document in case it was cloned or created by XHR.
1699     String m_overriddenMIMEType;
1700
1701     std::unique_ptr<DOMImplementation> m_implementation;
1702
1703     RefPtr<Node> m_focusNavigationStartingNode;
1704     RefPtr<Element> m_focusedElement;
1705     RefPtr<Element> m_hoveredElement;
1706     RefPtr<Element> m_activeElement;
1707     RefPtr<Element> m_documentElement;
1708     UserActionElementSet m_userActionElements;
1709
1710     uint64_t m_domTreeVersion;
1711     static uint64_t s_globalTreeVersion;
1712
1713     String m_uniqueIdentifier;
1714
1715     HashSet<NodeIterator*> m_nodeIterators;
1716     HashSet<Range*> m_ranges;
1717
1718     std::unique_ptr<Style::Scope> m_styleScope;
1719     std::unique_ptr<ExtensionStyleSheets> m_extensionStyleSheets;
1720     RefPtr<StyleSheetList> m_styleSheetList;
1721
1722     std::unique_ptr<FormController> m_formController;
1723
1724     Color m_textColor { Color::black };
1725     Color m_linkColor;
1726     Color m_visitedLinkColor;
1727     Color m_activeLinkColor;
1728     const std::unique_ptr<VisitedLinkState> m_visitedLinkState;
1729
1730     StringWithDirection m_title;
1731     StringWithDirection m_rawTitle;
1732     RefPtr<Element> m_titleElement;
1733
1734     std::unique_ptr<AXObjectCache> m_axObjectCache;
1735     const std::unique_ptr<DocumentMarkerController> m_markers;
1736     
1737     Timer m_styleRecalcTimer;
1738
1739     Element* m_cssTarget { nullptr };
1740
1741     RefPtr<SerializedScriptValue> m_pendingStateObject;
1742     MonotonicTime m_documentCreationTime;
1743     bool m_overMinimumLayoutThreshold { false };
1744     
1745     std::unique_ptr<ScriptRunner> m_scriptRunner;
1746     std::unique_ptr<ScriptModuleLoader> m_moduleLoader;
1747
1748     Vector<RefPtr<HTMLScriptElement>> m_currentScriptStack;
1749
1750 #if ENABLE(XSLT)
1751     void applyPendingXSLTransformsTimerFired();
1752
1753     std::unique_ptr<TransformSource> m_transformSource;
1754     RefPtr<Document> m_transformSourceDocument;
1755     Timer m_applyPendingXSLTransformsTimer;
1756     bool m_hasPendingXSLTransforms { false };
1757 #endif
1758
1759     String m_xmlEncoding;
1760     String m_xmlVersion;
1761     StandaloneStatus m_xmlStandalone { StandaloneStatus::Unspecified };
1762     bool m_hasXMLDeclaration { false };
1763
1764     String m_contentLanguage;
1765
1766     RefPtr<TextResourceDecoder> m_decoder;
1767
1768     HashSet<LiveNodeList*> m_listsInvalidatedAtDocument;
1769     HashSet<HTMLCollection*> m_collectionsInvalidatedAtDocument;
1770     unsigned m_nodeListAndCollectionCounts[numNodeListInvalidationTypes];
1771
1772     RefPtr<XPathEvaluator> m_xpathEvaluator;
1773
1774     std::unique_ptr<SVGDocumentExtensions> m_svgExtensions;
1775     HashSet<SVGUseElement*> m_svgUseElements;
1776
1777 #if ENABLE(DARK_MODE_CSS)
1778     OptionSet<ColorSchemes> m_supportedColorSchemes;
1779     bool m_allowsColorSchemeTransformations { true };
1780 #endif
1781
1782 #if ENABLE(DASHBOARD_SUPPORT)
1783     Vector<AnnotatedRegionValue> m_annotatedRegions;
1784     bool m_hasAnnotatedRegions { false };
1785     bool m_annotatedRegionsDirty { false };
1786 #endif
1787
1788     HashMap<String, RefPtr<HTMLCanvasElement>> m_cssCanvasElements;
1789
1790     HashSet<Element*> m_documentSuspensionCallbackElements;
1791     HashSet<Element*> m_mediaVolumeCallbackElements;
1792     HashSet<Element*> m_privateBrowsingStateChangedElements;
1793 #if ENABLE(VIDEO_TRACK)
1794     HashSet<Element*> m_captionPreferencesChangedElements;
1795 #endif
1796
1797     Element* m_mainArticleElement { nullptr };
1798     HashSet<Element*> m_articleElements;
1799
1800 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1801     HashSet<HTMLMediaElement*> m_pageScaleFactorChangedElements;
1802     HashSet<HTMLMediaElement*> m_userInterfaceLayoutDirectionChangedElements;
1803 #endif
1804
1805     HashSet<VisibilityChangeClient*> m_visibilityStateCallbackClients;
1806 #if ENABLE(VIDEO)
1807     HashSet<HTMLMediaElement*> m_allowsMediaDocumentInlinePlaybackElements;
1808 #endif
1809
1810     std::unique_ptr<HashMap<String, Element*, ASCIICaseInsensitiveHash>> m_accessKeyCache;
1811
1812     std::unique_ptr<ConstantPropertyMap> m_constantPropertyMap;
1813
1814     std::unique_ptr<SelectorQueryCache> m_selectorQueryCache;
1815
1816     DocumentClassFlags m_documentClasses;
1817
1818     RenderPtr<RenderView> m_renderView;
1819     mutable DocumentEventQueue m_eventQueue;
1820
1821     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1822
1823 #if ENABLE(FULLSCREEN_API)
1824     RefPtr<Element> m_fullScreenElement;
1825     Vector<RefPtr<Element>> m_fullScreenElementStack;
1826     WeakPtr<RenderFullScreen> m_fullScreenRenderer { nullptr };
1827     GenericTaskQueue<Timer> m_fullScreenTaskQueue;
1828     Deque<RefPtr<Node>> m_fullScreenChangeEventTargetQueue;
1829     Deque<RefPtr<Node>> m_fullScreenErrorEventTargetQueue;
1830     LayoutRect m_savedPlaceholderFrameRect;
1831     std::unique_ptr<RenderStyle> m_savedPlaceholderRenderStyle;
1832
1833     bool m_areKeysEnabledInFullScreen { false };
1834     bool m_isAnimatingFullScreen { false };
1835     bool m_areFullscreenControlsHidden { false };
1836 #endif
1837
1838     HashSet<HTMLPictureElement*> m_viewportDependentPictures;
1839     HashSet<HTMLPictureElement*> m_appearanceDependentPictures;
1840
1841 #if ENABLE(INTERSECTION_OBSERVER)
1842     Vector<WeakPtr<IntersectionObserver>> m_intersectionObservers;
1843     Vector<WeakPtr<IntersectionObserver>> m_intersectionObserversWithPendingNotifications;
1844     Timer m_intersectionObserversNotifyTimer;
1845 #endif
1846
1847     Timer m_loadEventDelayTimer;
1848
1849     ViewportArguments m_viewportArguments;
1850     Optional<ViewportArguments> m_overrideViewportArguments;
1851     OptionSet<DisabledAdaptations> m_disabledAdaptations;
1852
1853     DocumentTiming m_documentTiming;
1854
1855     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1856     
1857 #if ENABLE(TOUCH_EVENTS)
1858     std::unique_ptr<EventTargetSet> m_touchEventTargets;
1859 #endif
1860 #if PLATFORM(IOS_FAMILY) && ENABLE(POINTER_EVENTS)
1861     std::unique_ptr<HashSet<RefPtr<Element>>> m_touchActionElements;
1862 #endif
1863     std::unique_ptr<EventTargetSet> m_wheelEventTargets;
1864
1865     MonotonicTime m_lastHandledUserGestureTimestamp;
1866
1867     void clearScriptedAnimationController();
1868     RefPtr<ScriptedAnimationController> m_scriptedAnimationController;
1869
1870     void notifyMediaCaptureOfVisibilityChanged();
1871
1872     void didLogMessage(const WTFLogChannel&, WTFLogLevel, Vector<JSONLogValue>&&) final;
1873
1874 #if ENABLE(RESOURCE_LOAD_STATISTICS)
1875     bool hasFrameSpecificStorageAccess() const;
1876     void setHasFrameSpecificStorageAccess(bool);
1877 #endif
1878
1879 #if ENABLE(DEVICE_ORIENTATION)
1880 #if PLATFORM(IOS_FAMILY)
1881     std::unique_ptr<DeviceMotionClient> m_deviceMotionClient;
1882     std::unique_ptr<DeviceMotionController> m_deviceMotionController;
1883     std::unique_ptr<DeviceOrientationClient> m_deviceOrientationClient;
1884     std::unique_ptr<DeviceOrientationController> m_deviceOrientationController;
1885 #endif
1886     std::unique_ptr<DeviceOrientationAndMotionAccessController> m_deviceOrientationAndMotionAccessController;
1887 #endif
1888
1889     GenericTaskQueue<Timer> m_logMessageTaskQueue;
1890
1891     Timer m_pendingTasksTimer;
1892     Vector<Task> m_pendingTasks;
1893
1894 #if ENABLE(TEXT_AUTOSIZING)
1895     std::unique_ptr<TextAutoSizing> m_textAutoSizing;
1896 #endif
1897
1898     Timer m_visualUpdatesSuppressionTimer;
1899
1900     void clearSharedObjectPool();
1901     Timer m_sharedObjectPoolClearTimer;
1902
1903     std::unique_ptr<DocumentSharedObjectPool> m_sharedObjectPool;
1904
1905     typedef HashMap<AtomicString, std::unique_ptr<Locale>> LocaleIdentifierToLocaleMap;
1906     LocaleIdentifierToLocaleMap m_localeCache;
1907
1908     RefPtr<Document> m_templateDocument;
1909     Document* m_templateDocumentHost { nullptr }; // Manually managed weakref (backpointer from m_templateDocument).
1910
1911     Ref<CSSFontSelector> m_fontSelector;
1912
1913     HashSet<MediaProducer*> m_audioProducers;
1914
1915     HashSet<ShadowRoot*> m_inDocumentShadowRoots;
1916
1917 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1918     typedef HashMap<uint64_t, WebCore::MediaPlaybackTargetClient*> TargetIdToClientMap;
1919     TargetIdToClientMap m_idToClientMap;
1920     typedef HashMap<WebCore::MediaPlaybackTargetClient*, uint64_t> TargetClientToIdMap;
1921     TargetClientToIdMap m_clientToIDMap;
1922 #endif
1923
1924 #if ENABLE(MEDIA_SESSION)
1925     RefPtr<MediaSession> m_defaultMediaSession;
1926 #endif
1927
1928 #if ENABLE(INDEXED_DATABASE)
1929     RefPtr<IDBClient::IDBConnectionProxy> m_idbConnectionProxy;
1930 #endif
1931
1932 #if ENABLE(ATTACHMENT_ELEMENT)
1933     HashMap<String, Ref<HTMLAttachmentElement>> m_attachmentIdentifierToElementMap;
1934 #endif
1935
1936     Timer m_didAssociateFormControlsTimer;
1937     Timer m_cookieCacheExpiryTimer;
1938
1939     RefPtr<SocketProvider> m_socketProvider;
1940
1941     String m_cachedDOMCookies;
1942
1943     Optional<WallTime> m_overrideLastModified;
1944
1945     HashSet<RefPtr<Element>> m_associatedFormControls;
1946     unsigned m_disabledFieldsetElementsCount { 0 };
1947
1948     unsigned m_listenerTypes { 0 };
1949     unsigned m_referencingNodeCount { 0 };
1950     int m_loadEventDelayCount { 0 };
1951     unsigned m_lastStyleUpdateSizeForTesting { 0 };
1952
1953     // https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#throw-on-dynamic-markup-insertion-counter
1954     unsigned m_throwOnDynamicMarkupInsertionCount { 0 };
1955
1956     // https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#ignore-opens-during-unload-counter
1957     unsigned m_ignoreOpensDuringUnloadCount { 0 };
1958
1959     // https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#ignore-destructive-writes-counter
1960     unsigned m_ignoreDestructiveWriteCount { 0 };
1961
1962     unsigned m_activeParserCount { 0 };
1963     unsigned m_styleRecalcCount { 0 };
1964
1965     unsigned m_writeRecursionDepth { 0 };
1966
1967     InheritedBool m_designMode { inherit };
1968     MediaProducer::MediaStateFlags m_mediaState { MediaProducer::IsNotPlaying };
1969     bool m_userHasInteractedWithMediaElement { false };
1970     PageCacheState m_pageCacheState { NotInPageCache };
1971     Optional<ReferrerPolicy> m_referrerPolicy;
1972     ReadyState m_readyState { Complete };
1973
1974     MutationObserverOptions m_mutationObserverTypes { 0 };
1975
1976     bool m_writeRecursionIsTooDeep { false };
1977     bool m_wellFormed { false };
1978     bool m_createRenderers { true };
1979
1980     bool m_hasNodesWithNonFinalStyle { false };
1981     bool m_hasNodesWithMissingStyle { false };
1982     // But sometimes you need to ignore pending stylesheet count to
1983     // force an immediate layout when requested by JS.
1984     bool m_ignorePendingStylesheets { false };
1985
1986     bool m_hasElementUsingStyleBasedEditability { false };
1987     bool m_focusNavigationStartingNodeIsRemoved { false };
1988
1989     bool m_printing { false };
1990     bool m_paginatedForScreen { false };
1991
1992     DocumentCompatibilityMode m_compatibilityMode { DocumentCompatibilityMode::NoQuirksMode };
1993     bool m_compatibilityModeLocked { false }; // This is cheaper than making setCompatibilityMode virtual.
1994
1995     // FIXME: Merge these 2 variables into an enum. Also, FrameLoader::m_didCallImplicitClose
1996     // is almost a duplication of this data, so that should probably get merged in too.
1997     // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadDispatched are roughly the same
1998     // and should be merged.
1999     bool m_processingLoadEvent { false };
2000     bool m_loadEventFinished { false };
2001
2002     bool m_visuallyOrdered { false };
2003     bool m_bParsing { false }; // FIXME: rename
2004
2005     bool m_needsFullStyleRebuild { false };
2006     bool m_inStyleRecalc { false };
2007     bool m_closeAfterStyleRecalc { false };
2008     bool m_inRenderTreeUpdate { false };
2009     bool m_isResolvingTreeStyle { false };
2010
2011     bool m_gotoAnchorNeededAfterStylesheetsLoad { false };
2012     bool m_isDNSPrefetchEnabled { false };
2013     bool m_haveExplicitlyDisabledDNSPrefetch { false };
2014
2015     bool m_isSynthesized { false };
2016     bool m_isNonRenderedPlaceholder { false };
2017
2018     bool m_sawElementsInKnownNamespaces { false };
2019     bool m_isSrcdocDocument { false };
2020
2021     bool m_hasInjectedPlugInsScript { false };
2022     bool m_renderTreeBeingDestroyed { false };
2023     bool m_hasPreparedForDestruction { false };
2024
2025     bool m_hasStyleWithViewportUnits { false };
2026     bool m_isTimerThrottlingEnabled { false };
2027     bool m_isSuspended { false };
2028
2029     bool m_scheduledTasksAreSuspended { false };
2030     bool m_visualUpdatesAllowed { true };
2031
2032     bool m_areDeviceMotionAndOrientationUpdatesSuspended { false };
2033     bool m_userDidInteractWithPage { false };
2034
2035 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
2036     bool m_isTelephoneNumberParsingAllowed { true };
2037 #endif
2038
2039 #if ENABLE(MEDIA_STREAM)
2040     HashSet<HTMLMediaElement*> m_mediaStreamStateChangeElements;
2041     String m_idHashSalt;
2042     bool m_hasHadCaptureMediaStreamTrack { false };
2043 #endif
2044
2045 #ifndef NDEBUG
2046     bool m_didDispatchViewportPropertiesChanged { false };
2047 #endif
2048
2049     OrientationNotifier m_orientationNotifier;
2050     mutable PAL::SessionID m_sessionID;
2051     mutable RefPtr<Logger> m_logger;
2052     RefPtr<StringCallback> m_consoleMessageListener;
2053
2054     static bool hasEverCreatedAnAXObjectCache;
2055
2056     bool m_grantStorageAccessOverride { false };
2057
2058     RefPtr<DocumentTimeline> m_timeline;
2059     DocumentIdentifier m_identifier;
2060
2061 #if ENABLE(SERVICE_WORKER)
2062     RefPtr<SWClientConnection> m_serviceWorkerConnection;
2063 #endif
2064
2065     HashSet<ApplicationStateChangeListener*> m_applicationStateChangeListeners;
2066     
2067 #if ENABLE(RESOURCE_LOAD_STATISTICS)
2068     RegistrableDomain m_registrableDomainRequestedPageSpecificStorageAccessWithUserInteraction { };
2069 #endif
2070     
2071     std::unique_ptr<UserGestureIndicator> m_temporaryUserGesture;
2072
2073     CSSRegisteredCustomPropertySet m_CSSRegisteredPropertySet;
2074
2075 #if ENABLE(CSS_PAINTING_API)
2076     RefPtr<Worklet> m_paintWorklet;
2077     HashMap<String, Ref<PaintWorkletGlobalScope>> m_paintWorkletGlobalScopes;
2078 #endif
2079
2080     bool m_isRunningUserScripts { false };
2081
2082     Ref<UndoManager> m_undoManager;
2083 #if PLATFORM(IOS_FAMILY)
2084     std::unique_ptr<ContentChangeObserver> m_contentChangeObserver;
2085 #endif
2086 };
2087
2088 Element* eventTargetElementForDocument(Document*);
2089
2090 inline TextEncoding Document::textEncoding() const
2091 {
2092     if (auto* decoder = this->decoder())
2093         return decoder->encoding();
2094     return TextEncoding();
2095 }
2096
2097 inline const Document* Document::templateDocument() const
2098 {
2099     return m_templateDocumentHost ? this : m_templateDocument.get();
2100 }
2101
2102 inline AXObjectCache* Document::existingAXObjectCache() const
2103 {
2104     if (!hasEverCreatedAnAXObjectCache)
2105         return nullptr;
2106     return existingAXObjectCacheSlow();
2107 }
2108
2109 inline Ref<Document> Document::create(const URL& url)
2110 {
2111     return adoptRef(*new Document(nullptr, url));
2112 }
2113
2114 inline Ref<Document> Document::createNonRenderedPlaceholder(Frame& frame, const URL& url)
2115 {
2116     return adoptRef(*new Document(&frame, url, DefaultDocumentClass, NonRenderedPlaceholder));
2117 }
2118
2119 inline void Document::invalidateAccessKeyCache()
2120 {
2121     if (UNLIKELY(m_accessKeyCache))
2122         invalidateAccessKeyCacheSlowCase();
2123 }
2124
2125 // These functions are here because they require the Document class definition and we want to inline them.
2126
2127 inline ScriptExecutionContext* Node::scriptExecutionContext() const
2128 {
2129     return &document().contextDocument();
2130 }
2131
2132 inline ActiveDOMObject::ActiveDOMObject(Document& document)
2133     : ActiveDOMObject(static_cast<ScriptExecutionContext*>(&document.contextDocument()))
2134 {
2135 }
2136
2137 } // namespace WebCore
2138
2139 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Document)
2140     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isDocument(); }
2141     static bool isType(const WebCore::Node& node) { return node.isDocumentNode(); }
2142 SPECIALIZE_TYPE_TRAITS_END()