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