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