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