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