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