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