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