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