Use a 1-byte enum class for TextDirection
[WebKit-https.git] / Source / WebCore / dom / Document.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004-2018 Apple Inc. All rights reserved.
7  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2008, 2009, 2011, 2012 Google Inc. All rights reserved.
9  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
10  * Copyright (C) Research In Motion Limited 2010-2011. All rights reserved.
11  *
12  * This library is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Library General Public
14  * License as published by the Free Software Foundation; either
15  * version 2 of the License, or (at your option) any later version.
16  *
17  * This library is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public License
23  * along with this library; see the file COPYING.LIB.  If not, write to
24  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25  * Boston, MA 02110-1301, USA.
26  */
27
28 #include "config.h"
29 #include "Document.h"
30
31 #include "AXObjectCache.h"
32 #include "ApplicationStateChangeListener.h"
33 #include "Attr.h"
34 #include "BeforeUnloadEvent.h"
35 #include "CDATASection.h"
36 #include "CSSAnimationController.h"
37 #include "CSSFontSelector.h"
38 #include "CSSStyleDeclaration.h"
39 #include "CSSStyleSheet.h"
40 #include "CachedCSSStyleSheet.h"
41 #include "CachedFrame.h"
42 #include "CachedResourceLoader.h"
43 #include "CanvasRenderingContext2D.h"
44 #include "Chrome.h"
45 #include "ChromeClient.h"
46 #include "Comment.h"
47 #include "CommonVM.h"
48 #include "CompositionEvent.h"
49 #include "ConstantPropertyMap.h"
50 #include "ContentSecurityPolicy.h"
51 #include "CookieJar.h"
52 #include "CustomElementReactionQueue.h"
53 #include "CustomElementRegistry.h"
54 #include "CustomEvent.h"
55 #include "DOMImplementation.h"
56 #include "DOMWindow.h"
57 #include "DateComponents.h"
58 #include "DebugPageOverlays.h"
59 #include "DocumentAnimationScheduler.h"
60 #include "DocumentLoader.h"
61 #include "DocumentMarkerController.h"
62 #include "DocumentSharedObjectPool.h"
63 #include "DocumentTimeline.h"
64 #include "DocumentType.h"
65 #include "Editing.h"
66 #include "Editor.h"
67 #include "ElementIterator.h"
68 #include "EventHandler.h"
69 #include "ExtensionStyleSheets.h"
70 #include "FocusController.h"
71 #include "FocusEvent.h"
72 #include "FontFaceSet.h"
73 #include "FormController.h"
74 #include "Frame.h"
75 #include "FrameLoader.h"
76 #include "FrameLoaderClient.h"
77 #include "FrameView.h"
78 #include "GenericCachedHTMLCollection.h"
79 #include "HTMLAllCollection.h"
80 #include "HTMLAnchorElement.h"
81 #include "HTMLAttachmentElement.h"
82 #include "HTMLBaseElement.h"
83 #include "HTMLBodyElement.h"
84 #include "HTMLCanvasElement.h"
85 #include "HTMLDocument.h"
86 #include "HTMLElementFactory.h"
87 #include "HTMLFormControlElement.h"
88 #include "HTMLFrameOwnerElement.h"
89 #include "HTMLFrameSetElement.h"
90 #include "HTMLHeadElement.h"
91 #include "HTMLHtmlElement.h"
92 #include "HTMLImageElement.h"
93 #include "HTMLInputElement.h"
94 #include "HTMLLinkElement.h"
95 #include "HTMLMediaElement.h"
96 #include "HTMLNameCollection.h"
97 #include "HTMLParserIdioms.h"
98 #include "HTMLPictureElement.h"
99 #include "HTMLPlugInElement.h"
100 #include "HTMLScriptElement.h"
101 #include "HTMLStyleElement.h"
102 #include "HTMLTitleElement.h"
103 #include "HTMLUnknownElement.h"
104 #include "HTTPHeaderNames.h"
105 #include "HTTPParsers.h"
106 #include "HashChangeEvent.h"
107 #include "History.h"
108 #include "HitTestResult.h"
109 #include "ImageBitmapRenderingContext.h"
110 #include "ImageLoader.h"
111 #include "InspectorInstrumentation.h"
112 #include "JSCustomElementInterface.h"
113 #include "JSDOMPromiseDeferred.h"
114 #include "JSLazyEventListener.h"
115 #include "KeyboardEvent.h"
116 #include "KeyframeEffectReadOnly.h"
117 #include "LayoutDisallowedScope.h"
118 #include "LibWebRTCProvider.h"
119 #include "LoaderStrategy.h"
120 #include "Logging.h"
121 #include "MediaCanStartListener.h"
122 #include "MediaProducer.h"
123 #include "MediaQueryList.h"
124 #include "MediaQueryMatcher.h"
125 #include "MessageEvent.h"
126 #include "Microtasks.h"
127 #include "MouseEventWithHitTestResults.h"
128 #include "MutationEvent.h"
129 #include "NameNodeList.h"
130 #include "NavigationDisabler.h"
131 #include "NavigationScheduler.h"
132 #include "NestingLevelIncrementer.h"
133 #include "NodeIterator.h"
134 #include "NodeRareData.h"
135 #include "NodeWithIndex.h"
136 #include "OriginAccessEntry.h"
137 #include "OverflowEvent.h"
138 #include "PageConsoleClient.h"
139 #include "PageGroup.h"
140 #include "PageTransitionEvent.h"
141 #include "PlatformLocale.h"
142 #include "PlatformMediaSessionManager.h"
143 #include "PlatformScreen.h"
144 #include "PlatformStrategies.h"
145 #include "PlugInsResources.h"
146 #include "PluginDocument.h"
147 #include "PointerLockController.h"
148 #include "PolicyChecker.h"
149 #include "PopStateEvent.h"
150 #include "ProcessingInstruction.h"
151 #include "PublicSuffix.h"
152 #include "RealtimeMediaSourceCenter.h"
153 #include "RenderChildIterator.h"
154 #include "RenderLayerCompositor.h"
155 #include "RenderTreeUpdater.h"
156 #include "RenderView.h"
157 #include "RenderWidget.h"
158 #include "RequestAnimationFrameCallback.h"
159 #include "ResourceLoadObserver.h"
160 #include "RuntimeApplicationChecks.h"
161 #include "RuntimeEnabledFeatures.h"
162 #include "SVGDocumentExtensions.h"
163 #include "SVGElement.h"
164 #include "SVGElementFactory.h"
165 #include "SVGNames.h"
166 #include "SVGSVGElement.h"
167 #include "SVGTitleElement.h"
168 #include "SVGUseElement.h"
169 #include "SVGZoomEvent.h"
170 #include "SWClientConnection.h"
171 #include "SchemeRegistry.h"
172 #include "ScopedEventQueue.h"
173 #include "ScriptController.h"
174 #include "ScriptDisallowedScope.h"
175 #include "ScriptModuleLoader.h"
176 #include "ScriptRunner.h"
177 #include "ScriptSourceCode.h"
178 #include "ScriptState.h"
179 #include "ScriptedAnimationController.h"
180 #include "ScrollingCoordinator.h"
181 #include "SecurityOrigin.h"
182 #include "SecurityOriginData.h"
183 #include "SecurityOriginPolicy.h"
184 #include "SecurityPolicy.h"
185 #include "SegmentedString.h"
186 #include "SelectorQuery.h"
187 #include "ServiceWorkerClientData.h"
188 #include "ServiceWorkerProvider.h"
189 #include "Settings.h"
190 #include "ShadowRoot.h"
191 #include "SocketProvider.h"
192 #include "StorageEvent.h"
193 #include "StringCallback.h"
194 #include "StyleColor.h"
195 #include "StyleProperties.h"
196 #include "StyleResolveForDocument.h"
197 #include "StyleResolver.h"
198 #include "StyleScope.h"
199 #include "StyleSheetContents.h"
200 #include "StyleSheetList.h"
201 #include "StyleTreeResolver.h"
202 #include "SubresourceLoader.h"
203 #include "TextAutoSizing.h"
204 #include "TextEvent.h"
205 #include "TextNodeTraversal.h"
206 #include "TransformSource.h"
207 #include "TreeWalker.h"
208 #include "UserGestureIndicator.h"
209 #include "ValidationMessageClient.h"
210 #include "VisibilityChangeClient.h"
211 #include "VisitedLinkState.h"
212 #include "WebAnimation.h"
213 #include "WheelEvent.h"
214 #include "WindowFeatures.h"
215 #include "XMLDocument.h"
216 #include "XMLDocumentParser.h"
217 #include "XMLNSNames.h"
218 #include "XMLNames.h"
219 #include "XPathEvaluator.h"
220 #include "XPathExpression.h"
221 #include "XPathNSResolver.h"
222 #include "XPathResult.h"
223 #include <JavaScriptCore/ConsoleMessage.h>
224 #include <JavaScriptCore/RegularExpression.h>
225 #include <JavaScriptCore/ScriptCallStack.h>
226 #include <JavaScriptCore/VM.h>
227 #include <ctime>
228 #include <wtf/IsoMallocInlines.h>
229 #include <wtf/Language.h>
230 #include <wtf/NeverDestroyed.h>
231 #include <wtf/SetForScope.h>
232 #include <wtf/SystemTracing.h>
233 #include <wtf/UUID.h>
234 #include <wtf/text/StringBuffer.h>
235 #include <wtf/text/TextStream.h>
236
237 #if ENABLE(DEVICE_ORIENTATION)
238 #include "DeviceMotionEvent.h"
239 #include "DeviceOrientationEvent.h"
240 #endif
241
242 #if ENABLE(FULLSCREEN_API)
243 #include "RenderFullScreen.h"
244 #endif
245
246 #if ENABLE(INDEXED_DATABASE)
247 #include "IDBConnectionProxy.h"
248 #include "IDBOpenDBRequest.h"
249 #endif
250
251 #if PLATFORM(IOS)
252 #include "CSSFontSelector.h"
253 #include "DeviceMotionClientIOS.h"
254 #include "DeviceMotionController.h"
255 #include "DeviceOrientationClientIOS.h"
256 #include "DeviceOrientationController.h"
257 #include "Geolocation.h"
258 #include "Navigator.h"
259 #include "NavigatorGeolocation.h"
260 #include "WKContentObservation.h"
261 #endif
262
263 #if ENABLE(IOS_GESTURE_EVENTS)
264 #include "GestureEvent.h"
265 #endif
266
267 #if ENABLE(MATHML)
268 #include "MathMLElement.h"
269 #include "MathMLElementFactory.h"
270 #include "MathMLNames.h"
271 #endif
272
273 #if ENABLE(MEDIA_SESSION)
274 #include "MediaSession.h"
275 #endif
276
277 #if USE(QUICK_LOOK)
278 #include "QuickLook.h"
279 #endif
280
281 #if ENABLE(TOUCH_EVENTS)
282 #include "TouchEvent.h"
283 #endif
284
285 #if ENABLE(VIDEO_TRACK)
286 #include "CaptionUserPreferences.h"
287 #endif
288
289 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
290 #include "MediaPlaybackTargetClient.h"
291 #endif
292
293 #if ENABLE(XSLT)
294 #include "XSLTProcessor.h"
295 #endif
296
297 #if ENABLE(MEDIA_STREAM)
298 #include "MediaStream.h"
299 #include "MediaStreamRegistry.h"
300 #endif
301
302 #if ENABLE(WEBGL)
303 #include "WebGLRenderingContext.h"
304 #endif
305 #if ENABLE(WEBGL2)
306 #include "WebGL2RenderingContext.h"
307 #endif
308 #if ENABLE(WEBGPU)
309 #include "WebGPURenderingContext.h"
310 #endif
311
312
313 namespace WebCore {
314
315 WTF_MAKE_ISO_ALLOCATED_IMPL(Document);
316
317 using namespace PAL;
318 using namespace WTF;
319 using namespace Unicode;
320
321 using namespace HTMLNames;
322
323 static const unsigned cMaxWriteRecursionDepth = 21;
324 bool Document::hasEverCreatedAnAXObjectCache = false;
325
326 unsigned ScriptDisallowedScope::LayoutAssertionDisableScope::s_layoutAssertionDisableCount = 0;
327
328 // DOM Level 2 says (letters added):
329 //
330 // a) Name start characters must have one of the categories Ll, Lu, Lo, Lt, Nl.
331 // b) Name characters other than Name-start characters must have one of the categories Mc, Me, Mn, Lm, or Nd.
332 // c) Characters in the compatibility area (i.e. with character code greater than #xF900 and less than #xFFFE) are not allowed in XML names.
333 // d) Characters which have a font or compatibility decomposition (i.e. those with a "compatibility formatting tag" in field 5 of the database -- marked by field 5 beginning with a "<") are not allowed.
334 // e) The following characters are treated as name-start characters rather than name characters, because the property file classifies them as Alphabetic: [#x02BB-#x02C1], #x0559, #x06E5, #x06E6.
335 // f) Characters #x20DD-#x20E0 are excluded (in accordance with Unicode, section 5.14).
336 // g) Character #x00B7 is classified as an extender, because the property list so identifies it.
337 // h) Character #x0387 is added as a name character, because #x00B7 is its canonical equivalent.
338 // i) Characters ':' and '_' are allowed as name-start characters.
339 // j) Characters '-' and '.' are allowed as name characters.
340 //
341 // It also contains complete tables. If we decide it's better, we could include those instead of the following code.
342
343 static inline bool isValidNameStart(UChar32 c)
344 {
345     // rule (e) above
346     if ((c >= 0x02BB && c <= 0x02C1) || c == 0x559 || c == 0x6E5 || c == 0x6E6)
347         return true;
348
349     // rule (i) above
350     if (c == ':' || c == '_')
351         return true;
352
353     // rules (a) and (f) above
354     if (!(U_GET_GC_MASK(c) & (U_GC_LL_MASK | U_GC_LU_MASK | U_GC_LO_MASK | U_GC_LT_MASK | U_GC_NL_MASK)))
355         return false;
356
357     // rule (c) above
358     if (c >= 0xF900 && c < 0xFFFE)
359         return false;
360
361     // rule (d) above
362     int type = u_getIntPropertyValue(c, UCHAR_DECOMPOSITION_TYPE);
363     if (type == U_DT_FONT || type == U_DT_COMPAT)
364         return false;
365
366     return true;
367 }
368
369 static inline bool isValidNamePart(UChar32 c)
370 {
371     // rules (a), (e), and (i) above
372     if (isValidNameStart(c))
373         return true;
374
375     // rules (g) and (h) above
376     if (c == 0x00B7 || c == 0x0387)
377         return true;
378
379     // rule (j) above
380     if (c == '-' || c == '.')
381         return true;
382
383     // rules (b) and (f) above
384     if (!(U_GET_GC_MASK(c) & (U_GC_M_MASK | U_GC_LM_MASK | U_GC_ND_MASK)))
385         return false;
386
387     // rule (c) above
388     if (c >= 0xF900 && c < 0xFFFE)
389         return false;
390
391     // rule (d) above
392     int type = u_getIntPropertyValue(c, UCHAR_DECOMPOSITION_TYPE);
393     if (type == U_DT_FONT || type == U_DT_COMPAT)
394         return false;
395
396     return true;
397 }
398
399 static Widget* widgetForElement(Element* focusedElement)
400 {
401     if (!focusedElement)
402         return nullptr;
403     auto* renderer = focusedElement->renderer();
404     if (!is<RenderWidget>(renderer))
405         return nullptr;
406     return downcast<RenderWidget>(*renderer).widget();
407 }
408
409 static bool acceptsEditingFocus(const Element& element)
410 {
411     ASSERT(element.hasEditableStyle());
412
413     auto* root = element.rootEditableElement();
414     Frame* frame = element.document().frame();
415     if (!frame || !root)
416         return false;
417
418     return frame->editor().shouldBeginEditing(rangeOfContents(*root).ptr());
419 }
420
421 static bool canAccessAncestor(const SecurityOrigin& activeSecurityOrigin, Frame* targetFrame)
422 {
423     // targetFrame can be 0 when we're trying to navigate a top-level frame
424     // that has a 0 opener.
425     if (!targetFrame)
426         return false;
427
428     const bool isLocalActiveOrigin = activeSecurityOrigin.isLocal();
429     for (Frame* ancestorFrame = targetFrame; ancestorFrame; ancestorFrame = ancestorFrame->tree().parent()) {
430         Document* ancestorDocument = ancestorFrame->document();
431         // FIXME: Should be an ASSERT? Frames should alway have documents.
432         if (!ancestorDocument)
433             return true;
434
435         const SecurityOrigin& ancestorSecurityOrigin = ancestorDocument->securityOrigin();
436         if (activeSecurityOrigin.canAccess(ancestorSecurityOrigin))
437             return true;
438         
439         // Allow file URL descendant navigation even when allowFileAccessFromFileURLs is false.
440         // FIXME: It's a bit strange to special-case local origins here. Should we be doing
441         // something more general instead?
442         if (isLocalActiveOrigin && ancestorSecurityOrigin.isLocal())
443             return true;
444     }
445
446     return false;
447 }
448
449 static void printNavigationErrorMessage(Frame* frame, const URL& activeURL, const char* reason)
450 {
451     String message = "Unsafe JavaScript attempt to initiate navigation for frame with URL '" + frame->document()->url().string() + "' from frame with URL '" + activeURL.string() + "'. " + reason + "\n";
452
453     // FIXME: should we print to the console of the document performing the navigation instead?
454     frame->document()->domWindow()->printErrorMessage(message);
455 }
456
457 uint64_t Document::s_globalTreeVersion = 0;
458
459 auto Document::allDocumentsMap() -> DocumentsMap&
460 {
461     static NeverDestroyed<DocumentsMap> documents;
462     return documents;
463 }
464
465 auto Document::allDocuments() -> DocumentsMap::ValuesIteratorRange
466 {
467     return allDocumentsMap().values();
468 }
469
470 static inline int currentOrientation(Frame* frame)
471 {
472 #if ENABLE(ORIENTATION_EVENTS)
473     if (frame)
474         return frame->orientation();
475 #else
476     UNUSED_PARAM(frame);
477 #endif
478     return 0;
479 }
480
481 Document::Document(Frame* frame, const URL& url, unsigned documentClasses, unsigned constructionFlags)
482     : ContainerNode(*this, CreateDocument)
483     , TreeScope(*this)
484     , FrameDestructionObserver(frame)
485 #if ENABLE(IOS_TOUCH_EVENTS)
486     , m_touchEventsChangedTimer(*this, &Document::touchEventsChangedTimerFired)
487 #endif
488     , m_settings(frame ? Ref<Settings>(frame->settings()) : Settings::create(nullptr))
489     , m_cachedResourceLoader(m_frame ? Ref<CachedResourceLoader>(m_frame->loader().activeDocumentLoader()->cachedResourceLoader()) : CachedResourceLoader::create(nullptr))
490     , m_domTreeVersion(++s_globalTreeVersion)
491     , m_styleScope(std::make_unique<Style::Scope>(*this))
492     , m_extensionStyleSheets(std::make_unique<ExtensionStyleSheets>(*this))
493     , m_visitedLinkState(std::make_unique<VisitedLinkState>(*this))
494     , m_markers(std::make_unique<DocumentMarkerController>(*this))
495     , m_styleRecalcTimer([this] { updateStyleIfNeeded(); })
496     , m_documentCreationTime(MonotonicTime::now())
497     , m_scriptRunner(std::make_unique<ScriptRunner>(*this))
498     , m_moduleLoader(std::make_unique<ScriptModuleLoader>(*this))
499 #if ENABLE(XSLT)
500     , m_applyPendingXSLTransformsTimer(*this, &Document::applyPendingXSLTransformsTimerFired)
501 #endif
502     , m_xmlVersion("1.0"_s)
503     , m_constantPropertyMap(std::make_unique<ConstantPropertyMap>(*this))
504     , m_documentClasses(documentClasses)
505     , m_eventQueue(*this)
506     , m_loadEventDelayTimer(*this, &Document::loadEventDelayTimerFired)
507 #if PLATFORM(IOS)
508 #if ENABLE(DEVICE_ORIENTATION)
509     , m_deviceMotionClient(std::make_unique<DeviceMotionClientIOS>())
510     , m_deviceMotionController(std::make_unique<DeviceMotionController>(m_deviceMotionClient.get()))
511     , m_deviceOrientationClient(std::make_unique<DeviceOrientationClientIOS>())
512     , m_deviceOrientationController(std::make_unique<DeviceOrientationController>(m_deviceOrientationClient.get()))
513 #endif
514 #endif
515     , m_pendingTasksTimer(*this, &Document::pendingTasksTimerFired)
516     , m_visualUpdatesSuppressionTimer(*this, &Document::visualUpdatesSuppressionTimerFired)
517     , m_sharedObjectPoolClearTimer(*this, &Document::clearSharedObjectPool)
518     , m_fontSelector(CSSFontSelector::create(*this))
519     , m_didAssociateFormControlsTimer(*this, &Document::didAssociateFormControlsTimerFired)
520     , m_cookieCacheExpiryTimer(*this, &Document::invalidateDOMCookieCache)
521     , m_socketProvider(page() ? &page()->socketProvider() : nullptr)
522     , m_isSynthesized(constructionFlags & Synthesized)
523     , m_isNonRenderedPlaceholder(constructionFlags & NonRenderedPlaceholder)
524     , m_orientationNotifier(currentOrientation(frame))
525     , m_identifier(generateObjectIdentifier<DocumentIdentifierType>())
526 {
527     auto addResult = allDocumentsMap().add(m_identifier, this);
528     ASSERT_UNUSED(addResult, addResult.isNewEntry);
529
530     // We depend on the url getting immediately set in subframes, but we
531     // also depend on the url NOT getting immediately set in opened windows.
532     // See fast/dom/early-frame-url.html
533     // and fast/dom/location-new-window-no-crash.html, respectively.
534     // FIXME: Can/should we unify this behavior?
535     if ((frame && frame->ownerElement()) || !url.isEmpty())
536         setURL(url);
537
538     m_cachedResourceLoader->setDocument(this);
539
540     resetLinkColor();
541     resetVisitedLinkColor();
542     resetActiveLinkColor();
543
544     initSecurityContext();
545     initDNSPrefetch();
546
547     m_fontSelector->registerForInvalidationCallbacks(*this);
548
549     for (auto& nodeListAndCollectionCount : m_nodeListAndCollectionCounts)
550         nodeListAndCollectionCount = 0;
551 }
552
553 #if ENABLE(FULLSCREEN_API)
554
555 static bool isAttributeOnAllOwners(const WebCore::QualifiedName& attribute, const WebCore::QualifiedName& prefixedAttribute, const HTMLFrameOwnerElement* owner)
556 {
557     if (!owner)
558         return true;
559     do {
560         if (!(owner->hasAttribute(attribute) || owner->hasAttribute(prefixedAttribute)))
561             return false;
562     } while ((owner = owner->document().ownerElement()));
563     return true;
564 }
565
566 #endif
567
568 Ref<Document> Document::create(Document& contextDocument)
569 {
570     auto document = adoptRef(*new Document(nullptr, URL()));
571     document->setContextDocument(contextDocument);
572     document->setSecurityOriginPolicy(contextDocument.securityOriginPolicy());
573     return document;
574 }
575
576 Document::~Document()
577 {
578     if (m_logger)
579         m_logger->removeObserver(*this);
580
581     ASSERT(allDocumentsMap().contains(m_identifier));
582     allDocumentsMap().remove(m_identifier);
583     // We need to remove from the contexts map very early in the destructor so that calling postTask() on this Document from another thread is safe.
584     removeFromContextsMap();
585
586     ASSERT(!renderView());
587     ASSERT(m_pageCacheState != InPageCache);
588     ASSERT(m_ranges.isEmpty());
589     ASSERT(!m_parentTreeScope);
590     ASSERT(!m_disabledFieldsetElementsCount);
591     ASSERT(m_inDocumentShadowRoots.isEmpty());
592
593 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
594     m_deviceMotionClient->deviceMotionControllerDestroyed();
595     m_deviceOrientationClient->deviceOrientationControllerDestroyed();
596 #endif
597
598     if (m_templateDocument)
599         m_templateDocument->setTemplateDocumentHost(nullptr); // balanced in templateDocument().
600
601     // FIXME: Should we reset m_domWindow when we detach from the Frame?
602     if (m_domWindow)
603         m_domWindow->resetUnlessSuspendedForDocumentSuspension();
604
605     m_scriptRunner = nullptr;
606     m_moduleLoader = nullptr;
607
608     removeAllEventListeners();
609
610     // Currently we believe that Document can never outlive the parser.
611     // Although the Document may be replaced synchronously, DocumentParsers
612     // generally keep at least one reference to an Element which would in turn
613     // has a reference to the Document.  If you hit this ASSERT, then that
614     // assumption is wrong.  DocumentParser::detach() should ensure that even
615     // if the DocumentParser outlives the Document it won't cause badness.
616     ASSERT(!m_parser || m_parser->refCount() == 1);
617     detachParser();
618
619     if (this == &topDocument())
620         clearAXObjectCache();
621
622     m_decoder = nullptr;
623
624     if (m_styleSheetList)
625         m_styleSheetList->detachFromDocument();
626
627     extensionStyleSheets().detachFromDocument();
628
629     styleScope().clearResolver(); // We need to destroy CSSFontSelector before destroying m_cachedResourceLoader.
630     m_fontSelector->clearDocument();
631     m_fontSelector->unregisterForInvalidationCallbacks(*this);
632
633     // It's possible for multiple Documents to end up referencing the same CachedResourceLoader (e.g., SVGImages
634     // load the initial empty document and the SVGDocument with the same DocumentLoader).
635     if (m_cachedResourceLoader->document() == this)
636         m_cachedResourceLoader->setDocument(nullptr);
637
638 #if ENABLE(VIDEO)
639     if (auto* platformMediaSessionManager = PlatformMediaSessionManager::sharedManagerIfExists())
640         platformMediaSessionManager->stopAllMediaPlaybackForDocument(this);
641 #endif
642     
643     // We must call clearRareData() here since a Document class inherits TreeScope
644     // as well as Node. See a comment on TreeScope.h for the reason.
645     if (hasRareData())
646         clearRareData();
647
648     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(m_listsInvalidatedAtDocument.isEmpty());
649     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(m_collectionsInvalidatedAtDocument.isEmpty());
650     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(m_svgUseElements.isEmpty());
651
652     for (unsigned count : m_nodeListAndCollectionCounts)
653         ASSERT_UNUSED(count, !count);
654 }
655
656 void Document::removedLastRef()
657 {
658     ASSERT(!m_deletionHasBegun);
659     if (m_referencingNodeCount) {
660         // If removing a child removes the last node reference, we don't want the scope to be destroyed
661         // until after removeDetachedChildren returns, so we protect ourselves.
662         incrementReferencingNodeCount();
663
664         RELEASE_ASSERT(!hasLivingRenderTree());
665         // We must make sure not to be retaining any of our children through
666         // these extra pointers or we will create a reference cycle.
667         m_focusedElement = nullptr;
668         m_hoveredElement = nullptr;
669         m_activeElement = nullptr;
670         m_titleElement = nullptr;
671         m_documentElement = nullptr;
672         m_focusNavigationStartingNode = nullptr;
673         m_userActionElements.clear();
674 #if ENABLE(FULLSCREEN_API)
675         m_fullScreenElement = nullptr;
676         m_fullScreenElementStack.clear();
677 #endif
678         m_associatedFormControls.clear();
679
680         detachParser();
681
682         // removeDetachedChildren() doesn't always unregister IDs,
683         // so tear down scope information up front to avoid having
684         // stale references in the map.
685
686         destroyTreeScopeData();
687         removeDetachedChildren();
688         m_formController = nullptr;
689         
690         m_markers->detach();
691         
692         m_cssCanvasElements.clear();
693         
694         commonTeardown();
695
696 #ifndef NDEBUG
697         // We need to do this right now since selfOnlyDeref() can delete this.
698         m_inRemovedLastRefFunction = false;
699 #endif
700         decrementReferencingNodeCount();
701     } else {
702 #ifndef NDEBUG
703         m_inRemovedLastRefFunction = false;
704         m_deletionHasBegun = true;
705 #endif
706         delete this;
707     }
708 }
709
710 void Document::commonTeardown()
711 {
712     if (svgExtensions())
713         accessSVGExtensions().pauseAnimations();
714
715     clearScriptedAnimationController();
716 }
717
718 Element* Document::getElementByAccessKey(const String& key)
719 {
720     if (key.isEmpty())
721         return nullptr;
722     if (!m_accessKeyMapValid) {
723         buildAccessKeyMap(this);
724         m_accessKeyMapValid = true;
725     }
726     return m_elementsByAccessKey.get(key.impl());
727 }
728
729 void Document::buildAccessKeyMap(TreeScope* scope)
730 {
731     ASSERT(scope);
732     for (auto& element : descendantsOfType<Element>(scope->rootNode())) {
733         const AtomicString& accessKey = element.attributeWithoutSynchronization(accesskeyAttr);
734         if (!accessKey.isEmpty())
735             m_elementsByAccessKey.set(accessKey.impl(), &element);
736
737         if (ShadowRoot* root = element.shadowRoot())
738             buildAccessKeyMap(root);
739     }
740 }
741
742 void Document::invalidateAccessKeyMap()
743 {
744     m_accessKeyMapValid = false;
745     m_elementsByAccessKey.clear();
746 }
747
748 ExceptionOr<SelectorQuery&> Document::selectorQueryForString(const String& selectorString)
749 {
750     if (selectorString.isEmpty())
751         return Exception { SyntaxError };
752     if (!m_selectorQueryCache)
753         m_selectorQueryCache = std::make_unique<SelectorQueryCache>();
754     return m_selectorQueryCache->add(selectorString, *this);
755 }
756
757 void Document::clearSelectorQueryCache()
758 {
759     m_selectorQueryCache = nullptr;
760 }
761
762 void Document::setReferrerPolicy(ReferrerPolicy referrerPolicy)
763 {
764     // Do not override existing referrer policy with the "empty string" one as the "empty string" means we should use
765     // the policy defined elsewhere.
766     if (m_referrerPolicy && referrerPolicy == ReferrerPolicy::EmptyString)
767         return;
768
769     m_referrerPolicy = referrerPolicy;
770 }
771
772 MediaQueryMatcher& Document::mediaQueryMatcher()
773 {
774     if (!m_mediaQueryMatcher)
775         m_mediaQueryMatcher = MediaQueryMatcher::create(*this);
776     return *m_mediaQueryMatcher;
777 }
778
779 void Document::setCompatibilityMode(DocumentCompatibilityMode mode)
780 {
781     if (m_compatibilityModeLocked || mode == m_compatibilityMode)
782         return;
783     bool wasInQuirksMode = inQuirksMode();
784     m_compatibilityMode = mode;
785
786     clearSelectorQueryCache();
787
788     if (inQuirksMode() != wasInQuirksMode) {
789         // All user stylesheets have to reparse using the different mode.
790         extensionStyleSheets().clearPageUserSheet();
791         extensionStyleSheets().invalidateInjectedStyleSheetCache();
792     }
793 }
794
795 String Document::compatMode() const
796 {
797     return inQuirksMode() ? "BackCompat" : "CSS1Compat";
798 }
799
800 void Document::resetLinkColor()
801 {
802     m_linkColor = StyleColor::colorFromKeyword(CSSValueWebkitLink, styleColorOptions());
803 }
804
805 void Document::resetVisitedLinkColor()
806 {
807     m_visitedLinkColor = StyleColor::colorFromKeyword(CSSValueWebkitLink, styleColorOptions() | StyleColor::Options::ForVisitedLink);
808 }
809
810 void Document::resetActiveLinkColor()
811 {
812     m_activeLinkColor = StyleColor::colorFromKeyword(CSSValueWebkitActivelink, styleColorOptions());
813 }
814
815 DOMImplementation& Document::implementation()
816 {
817     if (!m_implementation)
818         m_implementation = std::make_unique<DOMImplementation>(*this);
819     return *m_implementation;
820 }
821
822 bool Document::hasManifest() const
823 {
824     return documentElement() && documentElement()->hasTagName(htmlTag) && documentElement()->hasAttributeWithoutSynchronization(manifestAttr);
825 }
826
827 DocumentType* Document::doctype() const
828 {
829     for (Node* node = firstChild(); node; node = node->nextSibling()) {
830         if (node->isDocumentTypeNode())
831             return static_cast<DocumentType*>(node);
832     }
833     return nullptr;
834 }
835
836 void Document::childrenChanged(const ChildChange& change)
837 {
838     ContainerNode::childrenChanged(change);
839
840     // FIXME: Chrome::didReceiveDocType() used to be called only when the doctype changed. We need to check the
841     // impact of calling this systematically. If the overhead is negligible, we need to rename didReceiveDocType,
842     // otherwise, we need to detect the doc type changes before updating the viewport.
843     if (Page* page = this->page())
844         page->chrome().didReceiveDocType(*frame());
845
846     Element* newDocumentElement = childrenOfType<Element>(*this).first();
847     if (newDocumentElement == m_documentElement)
848         return;
849     m_documentElement = newDocumentElement;
850     // The root style used for media query matching depends on the document element.
851     styleScope().clearResolver();
852 }
853
854 static ALWAYS_INLINE Ref<HTMLElement> createUpgradeCandidateElement(Document& document, const QualifiedName& name)
855 {
856     if (!RuntimeEnabledFeatures::sharedFeatures().customElementsEnabled()
857         || Document::validateCustomElementName(name.localName()) != CustomElementNameValidationStatus::Valid)
858         return HTMLUnknownElement::create(name, document);
859
860     auto element = HTMLElement::create(name, document);
861     element->setIsCustomElementUpgradeCandidate();
862     return element;
863 }
864
865 static ALWAYS_INLINE Ref<HTMLElement> createUpgradeCandidateElement(Document& document, const AtomicString& localName)
866 {
867     return createUpgradeCandidateElement(document, QualifiedName { nullAtom(), localName, xhtmlNamespaceURI });
868 }
869
870 static inline bool isValidHTMLElementName(const AtomicString& localName)
871 {
872     return Document::isValidName(localName);
873 }
874
875 static inline bool isValidHTMLElementName(const QualifiedName& name)
876 {
877     return Document::isValidName(name.localName());
878 }
879
880 template<typename NameType>
881 static ExceptionOr<Ref<Element>> createHTMLElementWithNameValidation(Document& document, const NameType& name)
882 {
883     auto element = HTMLElementFactory::createKnownElement(name, document);
884     if (LIKELY(element))
885         return Ref<Element> { element.releaseNonNull() };
886
887     if (auto* window = document.domWindow()) {
888         auto* registry = window->customElementRegistry();
889         if (UNLIKELY(registry)) {
890             if (auto* elementInterface = registry->findInterface(name))
891                 return elementInterface->constructElementWithFallback(document, name);
892         }
893     }
894
895     if (UNLIKELY(!isValidHTMLElementName(name)))
896         return Exception { InvalidCharacterError };
897
898     return Ref<Element> { createUpgradeCandidateElement(document, name) };
899 }
900
901 ExceptionOr<Ref<Element>> Document::createElementForBindings(const AtomicString& name)
902 {
903     if (isHTMLDocument())
904         return createHTMLElementWithNameValidation(*this, name.convertToASCIILowercase());
905
906     if (isXHTMLDocument())
907         return createHTMLElementWithNameValidation(*this, name);
908
909     if (!isValidName(name))
910         return Exception { InvalidCharacterError };
911
912     return createElement(QualifiedName(nullAtom(), name, nullAtom()), false);
913 }
914
915 Ref<DocumentFragment> Document::createDocumentFragment()
916 {
917     return DocumentFragment::create(document());
918 }
919
920 Ref<Text> Document::createTextNode(const String& data)
921 {
922     return Text::create(*this, data);
923 }
924
925 Ref<Comment> Document::createComment(const String& data)
926 {
927     return Comment::create(*this, data);
928 }
929
930 ExceptionOr<Ref<CDATASection>> Document::createCDATASection(const String& data)
931 {
932     if (isHTMLDocument())
933         return Exception { NotSupportedError };
934     return CDATASection::create(*this, data);
935 }
936
937 ExceptionOr<Ref<ProcessingInstruction>> Document::createProcessingInstruction(const String& target, const String& data)
938 {
939     if (!isValidName(target))
940         return Exception { InvalidCharacterError };
941
942     if (data.contains("?>"))
943         return Exception { InvalidCharacterError };
944
945     return ProcessingInstruction::create(*this, target, data);
946 }
947
948 Ref<Text> Document::createEditingTextNode(const String& text)
949 {
950     return Text::createEditingText(*this, text);
951 }
952
953 Ref<CSSStyleDeclaration> Document::createCSSStyleDeclaration()
954 {
955     Ref<MutableStyleProperties> propertySet(MutableStyleProperties::create());
956     return propertySet->ensureCSSStyleDeclaration();
957 }
958
959 ExceptionOr<Ref<Node>> Document::importNode(Node& nodeToImport, bool deep)
960 {
961     switch (nodeToImport.nodeType()) {
962     case DOCUMENT_FRAGMENT_NODE:
963         if (nodeToImport.isShadowRoot())
964             break;
965         FALLTHROUGH;
966     case ELEMENT_NODE:
967     case TEXT_NODE:
968     case CDATA_SECTION_NODE:
969     case PROCESSING_INSTRUCTION_NODE:
970     case COMMENT_NODE:
971         return nodeToImport.cloneNodeInternal(document(), deep ? CloningOperation::Everything : CloningOperation::OnlySelf);
972
973     case ATTRIBUTE_NODE:
974         // FIXME: This will "Attr::normalize" child nodes of Attr.
975         return Ref<Node> { Attr::create(*this, QualifiedName(nullAtom(), downcast<Attr>(nodeToImport).name(), nullAtom()), downcast<Attr>(nodeToImport).value()) };
976
977     case DOCUMENT_NODE: // Can't import a document into another document.
978     case DOCUMENT_TYPE_NODE: // FIXME: Support cloning a DocumentType node per DOM4.
979         break;
980     }
981
982     return Exception { NotSupportedError };
983 }
984
985
986 ExceptionOr<Ref<Node>> Document::adoptNode(Node& source)
987 {
988     EventQueueScope scope;
989
990     switch (source.nodeType()) {
991     case DOCUMENT_NODE:
992         return Exception { NotSupportedError };
993     case ATTRIBUTE_NODE: {
994         auto& attr = downcast<Attr>(source);
995         if (auto* element = attr.ownerElement()) {
996             auto result = element->removeAttributeNode(attr);
997             if (result.hasException())
998                 return result.releaseException();
999         }
1000         break;
1001     }       
1002     default:
1003         if (source.isShadowRoot()) {
1004             // ShadowRoot cannot disconnect itself from the host node.
1005             return Exception { HierarchyRequestError };
1006         }
1007         if (is<HTMLFrameOwnerElement>(source)) {
1008             auto& frameOwnerElement = downcast<HTMLFrameOwnerElement>(source);
1009             if (frame() && frame()->tree().isDescendantOf(frameOwnerElement.contentFrame()))
1010                 return Exception { HierarchyRequestError };
1011         }
1012         auto result = source.remove();
1013         if (result.hasException())
1014             return result.releaseException();
1015         RELEASE_ASSERT(!source.isConnected());
1016         RELEASE_ASSERT(!source.parentNode());
1017     }
1018
1019     source.setTreeScopeRecursively(*this);
1020
1021     return Ref<Node> { source };
1022 }
1023
1024 bool Document::hasValidNamespaceForElements(const QualifiedName& qName)
1025 {
1026     // These checks are from DOM Core Level 2, createElementNS
1027     // http://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-DocCrElNS
1028     if (!qName.prefix().isEmpty() && qName.namespaceURI().isNull()) // createElementNS(null, "html:div")
1029         return false;
1030     if (qName.prefix() == xmlAtom() && qName.namespaceURI() != XMLNames::xmlNamespaceURI) // createElementNS("http://www.example.com", "xml:lang")
1031         return false;
1032
1033     // Required by DOM Level 3 Core and unspecified by DOM Level 2 Core:
1034     // http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-DocCrElNS
1035     // createElementNS("http://www.w3.org/2000/xmlns/", "foo:bar"), createElementNS(null, "xmlns:bar"), createElementNS(null, "xmlns")
1036     if (qName.prefix() == xmlnsAtom() || (qName.prefix().isEmpty() && qName.localName() == xmlnsAtom()))
1037         return qName.namespaceURI() == XMLNSNames::xmlnsNamespaceURI;
1038     return qName.namespaceURI() != XMLNSNames::xmlnsNamespaceURI;
1039 }
1040
1041 bool Document::hasValidNamespaceForAttributes(const QualifiedName& qName)
1042 {
1043     return hasValidNamespaceForElements(qName);
1044 }
1045
1046 static Ref<HTMLElement> createFallbackHTMLElement(Document& document, const QualifiedName& name)
1047 {
1048     if (auto* window = document.domWindow()) {
1049         auto* registry = window->customElementRegistry();
1050         if (UNLIKELY(registry)) {
1051             if (auto* elementInterface = registry->findInterface(name)) {
1052                 auto element = HTMLElement::create(name, document);
1053                 element->enqueueToUpgrade(*elementInterface);
1054                 return element;
1055             }
1056         }
1057     }
1058     // FIXME: Should we also check the equality of prefix between the custom element and name?
1059     return createUpgradeCandidateElement(document, name);
1060 }
1061
1062 // FIXME: This should really be in a possible ElementFactory class.
1063 Ref<Element> Document::createElement(const QualifiedName& name, bool createdByParser)
1064 {
1065     RefPtr<Element> element;
1066
1067     // FIXME: Use registered namespaces and look up in a hash to find the right factory.
1068     if (name.namespaceURI() == xhtmlNamespaceURI) {
1069         element = HTMLElementFactory::createKnownElement(name, *this, nullptr, createdByParser);
1070         if (UNLIKELY(!element))
1071             element = createFallbackHTMLElement(*this, name);
1072     } else if (name.namespaceURI() == SVGNames::svgNamespaceURI)
1073         element = SVGElementFactory::createElement(name, *this, createdByParser);
1074 #if ENABLE(MATHML)
1075     else if (name.namespaceURI() == MathMLNames::mathmlNamespaceURI)
1076         element = MathMLElementFactory::createElement(name, *this, createdByParser);
1077 #endif
1078
1079     if (element)
1080         m_sawElementsInKnownNamespaces = true;
1081     else
1082         element = Element::create(name, document());
1083
1084     // <image> uses imgTag so we need a special rule.
1085     ASSERT((name.matches(imageTag) && element->tagQName().matches(imgTag) && element->tagQName().prefix() == name.prefix()) || name == element->tagQName());
1086
1087     return element.releaseNonNull();
1088 }
1089
1090 // https://html.spec.whatwg.org/#valid-custom-element-name
1091
1092 struct UnicodeCodePointRange {
1093     UChar32 minimum;
1094     UChar32 maximum;
1095 };
1096
1097 #if !ASSERT_DISABLED
1098
1099 static inline bool operator<(const UnicodeCodePointRange& a, const UnicodeCodePointRange& b)
1100 {
1101     ASSERT(a.minimum <= a.maximum);
1102     ASSERT(b.minimum <= b.maximum);
1103     return a.maximum < b.minimum;
1104 }
1105
1106 #endif
1107
1108 static inline bool operator<(const UnicodeCodePointRange& a, UChar32 b)
1109 {
1110     ASSERT(a.minimum <= a.maximum);
1111     return a.maximum < b;
1112 }
1113
1114 static inline bool operator<(UChar32 a, const UnicodeCodePointRange& b)
1115 {
1116     ASSERT(b.minimum <= b.maximum);
1117     return a < b.minimum;
1118 }
1119
1120 static inline bool isPotentialCustomElementNameCharacter(UChar32 character)
1121 {
1122     static const UnicodeCodePointRange ranges[] = {
1123         { '-', '.' },
1124         { '0', '9' },
1125         { '_', '_' },
1126         { 'a', 'z' },
1127         { 0xB7, 0xB7 },
1128         { 0xC0, 0xD6 },
1129         { 0xD8, 0xF6 },
1130         { 0xF8, 0x37D },
1131         { 0x37F, 0x1FFF },
1132         { 0x200C, 0x200D },
1133         { 0x203F, 0x2040 },
1134         { 0x2070, 0x218F },
1135         { 0x2C00, 0x2FEF },
1136         { 0x3001, 0xD7FF },
1137         { 0xF900, 0xFDCF },
1138         { 0xFDF0, 0xFFFD },
1139         { 0x10000, 0xEFFFF },
1140     };
1141
1142     ASSERT(std::is_sorted(std::begin(ranges), std::end(ranges)));
1143     return std::binary_search(std::begin(ranges), std::end(ranges), character);
1144 }
1145
1146 CustomElementNameValidationStatus Document::validateCustomElementName(const AtomicString& localName)
1147 {
1148     if (!isASCIILower(localName[0]))
1149         return CustomElementNameValidationStatus::FirstCharacterIsNotLowercaseASCIILetter;
1150
1151     bool containsHyphen = false;
1152     for (auto character : StringView(localName).codePoints()) {
1153         if (isASCIIUpper(character))
1154             return CustomElementNameValidationStatus::ContainsUppercaseASCIILetter;
1155         if (!isPotentialCustomElementNameCharacter(character))
1156             return CustomElementNameValidationStatus::ContainsDisallowedCharacter;
1157         if (character == '-')
1158             containsHyphen = true;
1159     }
1160
1161     if (!containsHyphen)
1162         return CustomElementNameValidationStatus::ContainsNoHyphen;
1163
1164 #if ENABLE(MATHML)
1165     const auto& annotationXmlLocalName = MathMLNames::annotation_xmlTag->localName();
1166 #else
1167     static NeverDestroyed<const AtomicString> annotationXmlLocalName("annotation-xml", AtomicString::ConstructFromLiteral);
1168 #endif
1169
1170     if (localName == SVGNames::color_profileTag->localName()
1171         || localName == SVGNames::font_faceTag->localName()
1172         || localName == SVGNames::font_face_formatTag->localName()
1173         || localName == SVGNames::font_face_nameTag->localName()
1174         || localName == SVGNames::font_face_srcTag->localName()
1175         || localName == SVGNames::font_face_uriTag->localName()
1176         || localName == SVGNames::missing_glyphTag->localName()
1177         || localName == annotationXmlLocalName)
1178         return CustomElementNameValidationStatus::ConflictsWithStandardElementName;
1179
1180     return CustomElementNameValidationStatus::Valid;
1181 }
1182
1183 ExceptionOr<Ref<Element>> Document::createElementNS(const AtomicString& namespaceURI, const String& qualifiedName)
1184 {
1185     auto parseResult = parseQualifiedName(namespaceURI, qualifiedName);
1186     if (parseResult.hasException())
1187         return parseResult.releaseException();
1188     QualifiedName parsedName { parseResult.releaseReturnValue() };
1189     if (!hasValidNamespaceForElements(parsedName))
1190         return Exception { NamespaceError };
1191
1192     if (parsedName.namespaceURI() == xhtmlNamespaceURI)
1193         return createHTMLElementWithNameValidation(*this, parsedName);
1194
1195     return createElement(parsedName, false);
1196 }
1197
1198 void Document::setReadyState(ReadyState readyState)
1199 {
1200     if (readyState == m_readyState)
1201         return;
1202
1203     switch (readyState) {
1204     case Loading:
1205         if (!m_documentTiming.domLoading)
1206             m_documentTiming.domLoading = MonotonicTime::now();
1207         break;
1208     case Interactive:
1209         if (!m_documentTiming.domInteractive)
1210             m_documentTiming.domInteractive = MonotonicTime::now();
1211         break;
1212     case Complete:
1213         if (!m_documentTiming.domComplete)
1214             m_documentTiming.domComplete = MonotonicTime::now();
1215         break;
1216     }
1217
1218     m_readyState = readyState;
1219     dispatchEvent(Event::create(eventNames().readystatechangeEvent, false, false));
1220
1221     if (settings().suppressesIncrementalRendering())
1222         setVisualUpdatesAllowed(readyState);
1223 }
1224
1225 void Document::setVisualUpdatesAllowed(ReadyState readyState)
1226 {
1227     ASSERT(settings().suppressesIncrementalRendering());
1228     switch (readyState) {
1229     case Loading:
1230         ASSERT(!m_visualUpdatesSuppressionTimer.isActive());
1231         ASSERT(m_visualUpdatesAllowed);
1232         setVisualUpdatesAllowed(false);
1233         break;
1234     case Interactive:
1235         ASSERT(m_visualUpdatesSuppressionTimer.isActive() || m_visualUpdatesAllowed);
1236         break;
1237     case Complete:
1238         if (m_visualUpdatesSuppressionTimer.isActive()) {
1239             ASSERT(!m_visualUpdatesAllowed);
1240
1241             if (view() && !view()->visualUpdatesAllowedByClient())
1242                 return;
1243
1244             setVisualUpdatesAllowed(true);
1245         } else
1246             ASSERT(m_visualUpdatesAllowed);
1247         break;
1248     }
1249 }
1250     
1251 void Document::setVisualUpdatesAllowed(bool visualUpdatesAllowed)
1252 {
1253     if (m_visualUpdatesAllowed == visualUpdatesAllowed)
1254         return;
1255
1256     m_visualUpdatesAllowed = visualUpdatesAllowed;
1257
1258     if (visualUpdatesAllowed)
1259         m_visualUpdatesSuppressionTimer.stop();
1260     else
1261         m_visualUpdatesSuppressionTimer.startOneShot(1_s * settings().incrementalRenderingSuppressionTimeoutInSeconds());
1262
1263     if (!visualUpdatesAllowed)
1264         return;
1265
1266     RefPtr<FrameView> frameView = view();
1267     bool needsLayout = frameView && renderView() && (frameView->layoutContext().isLayoutPending() || renderView()->needsLayout());
1268     if (needsLayout)
1269         updateLayout();
1270
1271     if (Page* page = this->page()) {
1272         if (frame()->isMainFrame()) {
1273             frameView->addPaintPendingMilestones(DidFirstPaintAfterSuppressedIncrementalRendering);
1274             if (page->requestedLayoutMilestones() & DidFirstLayoutAfterSuppressedIncrementalRendering)
1275                 frame()->loader().didReachLayoutMilestone(DidFirstLayoutAfterSuppressedIncrementalRendering);
1276         }
1277     }
1278
1279     if (frameView)
1280         frameView->updateCompositingLayersAfterLayout();
1281
1282     if (RenderView* renderView = this->renderView())
1283         renderView->repaintViewAndCompositedLayers();
1284
1285     if (Frame* frame = this->frame())
1286         frame->loader().forcePageTransitionIfNeeded();
1287 }
1288
1289 void Document::visualUpdatesSuppressionTimerFired()
1290 {
1291     ASSERT(!m_visualUpdatesAllowed);
1292
1293     // If the client is extending the visual update suppression period explicitly, the
1294     // watchdog should not re-enable visual updates itself, but should wait for the client.
1295     if (view() && !view()->visualUpdatesAllowedByClient())
1296         return;
1297
1298     setVisualUpdatesAllowed(true);
1299 }
1300
1301 void Document::setVisualUpdatesAllowedByClient(bool visualUpdatesAllowedByClient)
1302 {
1303     // We should only re-enable visual updates if ReadyState is Completed or the watchdog timer has fired,
1304     // both of which we can determine by looking at the timer.
1305
1306     if (visualUpdatesAllowedByClient && !m_visualUpdatesSuppressionTimer.isActive() && !visualUpdatesAllowed())
1307         setVisualUpdatesAllowed(true);
1308 }
1309
1310 String Document::characterSetWithUTF8Fallback() const
1311 {
1312     AtomicString name = encoding();
1313     if (!name.isNull())
1314         return name;
1315     return UTF8Encoding().domName();
1316 }
1317
1318 String Document::defaultCharsetForLegacyBindings() const
1319 {
1320     if (!frame())
1321         UTF8Encoding().domName();
1322     return settings().defaultTextEncodingName();
1323 }
1324
1325 void Document::setCharset(const String& charset)
1326 {
1327     if (!decoder())
1328         return;
1329     decoder()->setEncoding(charset, TextResourceDecoder::UserChosenEncoding);
1330 }
1331
1332 void Document::setContentLanguage(const String& language)
1333 {
1334     if (m_contentLanguage == language)
1335         return;
1336     m_contentLanguage = language;
1337
1338     // Recalculate style so language is used when selecting the initial font.
1339     m_styleScope->didChangeStyleSheetEnvironment();
1340 }
1341
1342 ExceptionOr<void> Document::setXMLVersion(const String& version)
1343 {
1344     if (!XMLDocumentParser::supportsXMLVersion(version))
1345         return Exception { NotSupportedError };
1346
1347     m_xmlVersion = version;
1348     return { };
1349 }
1350
1351 void Document::setXMLStandalone(bool standalone)
1352 {
1353     m_xmlStandalone = standalone ? StandaloneStatus::Standalone : StandaloneStatus::NotStandalone;
1354 }
1355
1356 void Document::setDocumentURI(const String& uri)
1357 {
1358     // This property is read-only from JavaScript, but writable from Objective-C.
1359     m_documentURI = uri;
1360     updateBaseURL();
1361 }
1362
1363 void Document::setContent(const String& content)
1364 {
1365     open();
1366     // FIXME: This should probably use insert(), but that's (intentionally)
1367     // not implemented for the XML parser as it's normally synonymous with
1368     // document.write(). append() will end up yielding, but close() will
1369     // pump the tokenizer syncrhonously and finish the parse.
1370     m_parser->append(content.impl());
1371     close();
1372 }
1373
1374 String Document::suggestedMIMEType() const
1375 {
1376     if (isXHTMLDocument())
1377         return "application/xhtml+xml"_s;
1378     if (isSVGDocument())
1379         return "image/svg+xml"_s;
1380     if (xmlStandalone())
1381         return "text/xml"_s;
1382     if (isHTMLDocument())
1383         return "text/html"_s;
1384     if (DocumentLoader* loader = this->loader())
1385         return loader->responseMIMEType();
1386     return String();
1387 }
1388
1389 void Document::overrideMIMEType(const String& mimeType)
1390 {
1391     m_overriddenMIMEType = mimeType;
1392 }
1393
1394 String Document::contentType() const
1395 {
1396     if (!m_overriddenMIMEType.isNull())
1397         return m_overriddenMIMEType;
1398
1399     if (DocumentLoader* documentLoader = loader())
1400         return documentLoader->currentContentType();
1401
1402     String mimeType = suggestedMIMEType();
1403     if (!mimeType.isNull())
1404         return mimeType;
1405
1406     return "application/xml"_s;
1407 }
1408
1409 RefPtr<Range> Document::caretRangeFromPoint(int x, int y)
1410 {
1411     return caretRangeFromPoint(LayoutPoint(x, y));
1412 }
1413
1414 RefPtr<Range> Document::caretRangeFromPoint(const LayoutPoint& clientPoint)
1415 {
1416     if (!hasLivingRenderTree())
1417         return nullptr;
1418
1419     LayoutPoint localPoint;
1420     Node* node = nodeFromPoint(clientPoint, &localPoint);
1421     if (!node)
1422         return nullptr;
1423
1424     RenderObject* renderer = node->renderer();
1425     if (!renderer)
1426         return nullptr;
1427     Position rangeCompliantPosition = renderer->positionForPoint(localPoint).parentAnchoredEquivalent();
1428     if (rangeCompliantPosition.isNull())
1429         return nullptr;
1430
1431     unsigned offset = rangeCompliantPosition.offsetInContainerNode();
1432     node = &retargetToScope(*rangeCompliantPosition.containerNode());
1433     if (node != rangeCompliantPosition.containerNode())
1434         offset = 0;
1435
1436     return Range::create(*this, node, offset, node, offset);
1437 }
1438
1439 Element* Document::scrollingElement()
1440 {
1441     // FIXME: When we fix https://bugs.webkit.org/show_bug.cgi?id=106133, this should be replaced with the full implementation
1442     // of Document.scrollingElement() as specified at http://dev.w3.org/csswg/cssom-view/#dom-document-scrollingelement.
1443
1444     return body();
1445 }
1446
1447 template<typename CharacterType> static inline String canonicalizedTitle(Document& document, const String& title)
1448 {
1449     // FIXME: Compiling a separate copy of this for LChar and UChar is likely unnecessary.
1450     // FIXME: Missing an optimized case for when title is fine as-is. This unnecessarily allocates
1451     // and keeps around a new copy, and it's even the less optimal type of StringImpl with a separate buffer.
1452     // Could probably just use StringBuilder instead.
1453
1454     auto* characters = title.characters<CharacterType>();
1455     unsigned length = title.length();
1456
1457     StringBuffer<CharacterType> buffer { length };
1458     unsigned bufferLength = 0;
1459
1460     auto* decoder = document.decoder();
1461     auto backslashAsCurrencySymbol = decoder ? decoder->encoding().backslashAsCurrencySymbol() : '\\';
1462
1463     // Collapse runs of HTML spaces into single space characters.
1464     // Strip leading and trailing spaces.
1465     // Replace backslashes with currency symbols.
1466     bool previousCharacterWasHTMLSpace = false;
1467     for (unsigned i = 0; i < length; ++i) {
1468         auto character = characters[i];
1469         if (isHTMLSpace(character))
1470             previousCharacterWasHTMLSpace = true;
1471         else {
1472             if (character == '\\')
1473                 character = backslashAsCurrencySymbol;
1474             if (previousCharacterWasHTMLSpace && bufferLength)
1475                 buffer[bufferLength++] = ' ';
1476             buffer[bufferLength++] = character;
1477             previousCharacterWasHTMLSpace = false;
1478         }
1479     }
1480     if (!bufferLength)
1481         return { };
1482
1483     buffer.shrink(bufferLength);
1484     return String::adopt(WTFMove(buffer));
1485 }
1486
1487 void Document::updateTitle(const StringWithDirection& title)
1488 {
1489     if (m_rawTitle == title)
1490         return;
1491
1492     m_rawTitle = title;
1493     m_title = title;
1494
1495     if (!m_title.string.isEmpty()) {
1496         if (m_title.string.is8Bit())
1497             m_title.string = canonicalizedTitle<LChar>(*this, m_title.string);
1498         else
1499             m_title.string = canonicalizedTitle<UChar>(*this, m_title.string);
1500     }
1501
1502     if (auto* loader = this->loader())
1503         loader->setTitle(m_title);
1504 }
1505
1506 void Document::updateTitleFromTitleElement()
1507 {
1508     if (!m_titleElement) {
1509         updateTitle({ });
1510         return;
1511     }
1512
1513     if (is<HTMLTitleElement>(*m_titleElement))
1514         updateTitle(downcast<HTMLTitleElement>(*m_titleElement).textWithDirection());
1515     else if (is<SVGTitleElement>(*m_titleElement)) {
1516         // FIXME: Does the SVG title element have a text direction?
1517         updateTitle({ downcast<SVGTitleElement>(*m_titleElement).textContent(), TextDirection::LTR });
1518     }
1519 }
1520
1521 void Document::setTitle(const String& title)
1522 {
1523     if (!m_titleElement) {
1524         if (isHTMLDocument() || isXHTMLDocument()) {
1525             auto* headElement = head();
1526             if (!headElement)
1527                 return;
1528             m_titleElement = HTMLTitleElement::create(HTMLNames::titleTag, *this);
1529             headElement->appendChild(*m_titleElement);
1530         } else if (isSVGDocument()) {
1531             auto* element = documentElement();
1532             if (!is<SVGSVGElement>(element))
1533                 return;
1534             m_titleElement = SVGTitleElement::create(SVGNames::titleTag, *this);
1535             element->insertBefore(*m_titleElement, element->firstChild());
1536         }
1537     } else if (!isHTMLDocument() && !isXHTMLDocument() && !isSVGDocument()) {
1538         // FIXME: What exactly is the point of this? This seems like a strange moment
1539         // in time to demote something from being m_titleElement, when setting the
1540         // value of the title attribute. Do we have test coverage for this?
1541         m_titleElement = nullptr;
1542     }
1543
1544     if (is<HTMLTitleElement>(m_titleElement.get()))
1545         downcast<HTMLTitleElement>(*m_titleElement).setTextContent(title);
1546     else if (is<SVGTitleElement>(m_titleElement.get()))
1547         downcast<SVGTitleElement>(*m_titleElement).setTextContent(title);
1548     else
1549         updateTitle({ title, TextDirection::LTR });
1550 }
1551
1552 template<typename> struct TitleTraits;
1553
1554 template<> struct TitleTraits<HTMLTitleElement> {
1555     static bool isInEligibleLocation(HTMLTitleElement& element) { return element.isConnected() && !element.isInShadowTree(); }
1556     static HTMLTitleElement* findTitleElement(Document& document) { return descendantsOfType<HTMLTitleElement>(document).first(); }
1557 };
1558
1559 template<> struct TitleTraits<SVGTitleElement> {
1560     static bool isInEligibleLocation(SVGTitleElement& element) { return element.parentNode() == element.document().documentElement(); }
1561     static SVGTitleElement* findTitleElement(Document& document) { return childrenOfType<SVGTitleElement>(*document.documentElement()).first(); }
1562 };
1563
1564 template<typename TitleElement> Element* selectNewTitleElement(Document& document, Element* oldTitleElement, Element& changingTitleElement)
1565 {
1566     using Traits = TitleTraits<TitleElement>;
1567
1568     if (!is<TitleElement>(changingTitleElement)) {
1569         ASSERT(oldTitleElement == Traits::findTitleElement(document));
1570         return oldTitleElement;
1571     }
1572
1573     if (oldTitleElement)
1574         return Traits::findTitleElement(document);
1575
1576     // Optimized common case: We have no title element yet.
1577     // We can figure out which title element should be used without searching.
1578     bool isEligible = Traits::isInEligibleLocation(downcast<TitleElement>(changingTitleElement));
1579     auto* newTitleElement = isEligible ? &changingTitleElement : nullptr;
1580     ASSERT(newTitleElement == Traits::findTitleElement(document));
1581     return newTitleElement;
1582 }
1583
1584 void Document::updateTitleElement(Element& changingTitleElement)
1585 {
1586     // Most documents use HTML title rules.
1587     // Documents with SVG document elements use SVG title rules.
1588     auto selectTitleElement = is<SVGSVGElement>(documentElement())
1589         ? selectNewTitleElement<SVGTitleElement> : selectNewTitleElement<HTMLTitleElement>;
1590     auto newTitleElement = selectTitleElement(*this, m_titleElement.get(), changingTitleElement);
1591     if (m_titleElement == newTitleElement)
1592         return;
1593     m_titleElement = newTitleElement;
1594     updateTitleFromTitleElement();
1595 }
1596
1597 void Document::titleElementAdded(Element& titleElement)
1598 {
1599     if (m_titleElement == &titleElement)
1600         return;
1601
1602     updateTitleElement(titleElement);
1603 }
1604
1605 void Document::titleElementRemoved(Element& titleElement)
1606 {
1607     if (m_titleElement != &titleElement)
1608         return;
1609
1610     updateTitleElement(titleElement);
1611 }
1612
1613 void Document::titleElementTextChanged(Element& titleElement)
1614 {
1615     if (m_titleElement != &titleElement)
1616         return;
1617
1618     updateTitleFromTitleElement();
1619 }
1620
1621 void Document::registerForVisibilityStateChangedCallbacks(VisibilityChangeClient* client)
1622 {
1623     m_visibilityStateCallbackClients.add(client);
1624 }
1625
1626 void Document::unregisterForVisibilityStateChangedCallbacks(VisibilityChangeClient* client)
1627 {
1628     m_visibilityStateCallbackClients.remove(client);
1629 }
1630
1631 void Document::visibilityStateChanged()
1632 {
1633     enqueueDocumentEvent(Event::create(eventNames().visibilitychangeEvent, false, false));
1634     for (auto* client : m_visibilityStateCallbackClients)
1635         client->visibilityStateChanged();
1636
1637     notifyMediaCaptureOfVisibilityChanged();
1638 }
1639
1640 VisibilityState Document::visibilityState() const
1641 {
1642     // The visibility of the document is inherited from the visibility of the
1643     // page. If there is no page associated with the document, we will assume
1644     // that the page is hidden, as specified by the spec:
1645     // http://dvcs.w3.org/hg/webperf/raw-file/tip/specs/PageVisibility/Overview.html#dom-document-hidden
1646     if (!m_frame || !m_frame->page())
1647         return VisibilityState::Hidden;
1648     return m_frame->page()->visibilityState();
1649 }
1650
1651 bool Document::hidden() const
1652 {
1653     return visibilityState() != VisibilityState::Visible;
1654 }
1655
1656 #if ENABLE(VIDEO)
1657
1658 void Document::registerForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement& element)
1659 {
1660     m_allowsMediaDocumentInlinePlaybackElements.add(&element);
1661 }
1662
1663 void Document::unregisterForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement& element)
1664 {
1665     m_allowsMediaDocumentInlinePlaybackElements.remove(&element);
1666 }
1667
1668 void Document::allowsMediaDocumentInlinePlaybackChanged()
1669 {
1670     for (auto* element : m_allowsMediaDocumentInlinePlaybackElements)
1671         element->allowsMediaDocumentInlinePlaybackChanged();
1672 }
1673
1674 #endif
1675
1676 String Document::nodeName() const
1677 {
1678     return "#document"_s;
1679 }
1680
1681 Node::NodeType Document::nodeType() const
1682 {
1683     return DOCUMENT_NODE;
1684 }
1685
1686 FormController& Document::formController()
1687 {
1688     if (!m_formController)
1689         m_formController = std::make_unique<FormController>();
1690     return *m_formController;
1691 }
1692
1693 Vector<String> Document::formElementsState() const
1694 {
1695     if (!m_formController)
1696         return Vector<String>();
1697     return m_formController->formElementsState();
1698 }
1699
1700 void Document::setStateForNewFormElements(const Vector<String>& stateVector)
1701 {
1702     if (!stateVector.size() && !m_formController)
1703         return;
1704     formController().setStateForNewFormElements(stateVector);
1705 }
1706
1707 FrameView* Document::view() const
1708 {
1709     return m_frame ? m_frame->view() : nullptr;
1710 }
1711
1712 Page* Document::page() const
1713 {
1714     return m_frame ? m_frame->page() : nullptr;
1715 }
1716
1717 Ref<Range> Document::createRange()
1718 {
1719     return Range::create(*this);
1720 }
1721
1722 Ref<NodeIterator> Document::createNodeIterator(Node& root, unsigned long whatToShow, RefPtr<NodeFilter>&& filter, bool)
1723 {
1724     return NodeIterator::create(root, whatToShow, WTFMove(filter));
1725 }
1726
1727 Ref<TreeWalker> Document::createTreeWalker(Node& root, unsigned long whatToShow, RefPtr<NodeFilter>&& filter, bool)
1728 {
1729     return TreeWalker::create(root, whatToShow, WTFMove(filter));
1730 }
1731
1732 void Document::scheduleForcedStyleRecalc()
1733 {
1734     m_pendingStyleRecalcShouldForce = true;
1735     scheduleStyleRecalc();
1736 }
1737
1738 void Document::scheduleStyleRecalc()
1739 {
1740     ASSERT(!m_renderView || !m_renderView->inHitTesting());
1741
1742     if (m_styleRecalcTimer.isActive() || pageCacheState() != NotInPageCache)
1743         return;
1744
1745     ASSERT(childNeedsStyleRecalc() || m_pendingStyleRecalcShouldForce);
1746
1747     // FIXME: Why on earth is this here? This is clearly misplaced.
1748     invalidateAccessKeyMap();
1749     
1750     m_styleRecalcTimer.startOneShot(0_s);
1751
1752     InspectorInstrumentation::didScheduleStyleRecalculation(*this);
1753 }
1754
1755 void Document::unscheduleStyleRecalc()
1756 {
1757     ASSERT(!childNeedsStyleRecalc());
1758
1759     m_styleRecalcTimer.stop();
1760     m_pendingStyleRecalcShouldForce = false;
1761 }
1762
1763 bool Document::hasPendingStyleRecalc() const
1764 {
1765     return m_styleRecalcTimer.isActive() && !m_inStyleRecalc;
1766 }
1767
1768 bool Document::hasPendingForcedStyleRecalc() const
1769 {
1770     return m_styleRecalcTimer.isActive() && m_pendingStyleRecalcShouldForce;
1771 }
1772
1773 void Document::resolveStyle(ResolveStyleType type)
1774 {
1775     ASSERT(!view() || !view()->isPainting());
1776
1777     // NOTE: XSL code seems to be the only client stumbling in here without a RenderView.
1778     if (!m_renderView)
1779         return;
1780
1781     FrameView& frameView = m_renderView->frameView();
1782     Ref<FrameView> protect(frameView);
1783     if (frameView.isPainting())
1784         return;
1785     
1786     if (m_inStyleRecalc)
1787         return; // Guard against re-entrancy. -dwh
1788
1789     TraceScope tracingScope(StyleRecalcStart, StyleRecalcEnd);
1790
1791     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
1792     AnimationUpdateBlock animationUpdateBlock(&m_frame->animation());
1793
1794     // FIXME: Do this update per tree scope.
1795     {
1796         auto elements = copyToVectorOf<RefPtr<SVGUseElement>>(m_svgUseElements);
1797         // We can't clear m_svgUseElements here because updateShadowTree may end up executing arbitrary scripts
1798         // which may insert new SVG use elements or remove existing ones inside sync IPC via ImageLoader::updateFromElement.
1799         for (auto& element : elements)
1800             element->updateShadowTree();
1801     }
1802
1803     // FIXME: We should update style on our ancestor chain before proceeding (especially for seamless),
1804     // however doing so currently causes several tests to crash, as Frame::setDocument calls Document::attach
1805     // before setting the DOMWindow on the Frame, or the SecurityOrigin on the document. The attach, in turn
1806     // resolves style (here) and then when we resolve style on the parent chain, we may end up
1807     // re-attaching our containing iframe, which when asked HTMLFrameElementBase::isURLAllowed
1808     // hits a null-dereference due to security code always assuming the document has a SecurityOrigin.
1809
1810     {
1811         ScriptDisallowedScope::InMainThread scriptDisallowedScope;
1812         styleScope().flushPendingUpdate();
1813         frameView.willRecalcStyle();
1814     }
1815
1816     InspectorInstrumentationCookie cookie = InspectorInstrumentation::willRecalculateStyle(*this);
1817
1818     bool updatedCompositingLayers = false;
1819     {
1820         Style::PostResolutionCallbackDisabler disabler(*this);
1821         WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
1822         ScriptDisallowedScope::InMainThread scriptDisallowedScope;
1823
1824         m_inStyleRecalc = true;
1825
1826         if (m_pendingStyleRecalcShouldForce)
1827             type = ResolveStyleType::Rebuild;
1828
1829         if (type == ResolveStyleType::Rebuild) {
1830             // This may get set again during style resolve.
1831             m_hasNodesWithNonFinalStyle = false;
1832             m_hasNodesWithMissingStyle = false;
1833
1834             auto documentStyle = Style::resolveForDocument(*this);
1835
1836             // Inserting the pictograph font at the end of the font fallback list is done by the
1837             // font selector, so set a font selector if needed.
1838             if (settings().fontFallbackPrefersPictographs())
1839                 documentStyle.fontCascade().update(&fontSelector());
1840
1841             auto documentChange = Style::determineChange(documentStyle, m_renderView->style());
1842             if (documentChange != Style::NoChange)
1843                 renderView()->setStyle(WTFMove(documentStyle));
1844
1845             if (auto* documentElement = this->documentElement())
1846                 documentElement->invalidateStyleForSubtree();
1847         }
1848
1849         Style::TreeResolver resolver(*this);
1850         auto styleUpdate = resolver.resolve();
1851
1852         m_lastStyleUpdateSizeForTesting = styleUpdate ? styleUpdate->size() : 0;
1853
1854         setHasValidStyle();
1855         clearChildNeedsStyleRecalc();
1856         unscheduleStyleRecalc();
1857
1858         m_inStyleRecalc = false;
1859
1860         if (styleUpdate) {
1861             SetForScope<bool> inRenderTreeUpdate(m_inRenderTreeUpdate, true);
1862
1863             RenderTreeUpdater updater(*this);
1864             updater.commit(WTFMove(styleUpdate));
1865
1866             frameView.styleDidChange();
1867         }
1868
1869         updatedCompositingLayers = frameView.updateCompositingLayersAfterStyleChange();
1870
1871         if (m_renderView->needsLayout())
1872             frameView.layoutContext().scheduleLayout();
1873
1874         // Usually this is handled by post-layout.
1875         if (!frameView.needsLayout())
1876             frameView.frame().selection().scheduleAppearanceUpdateAfterStyleChange();
1877
1878         // As a result of the style recalculation, the currently hovered element might have been
1879         // detached (for example, by setting display:none in the :hover style), schedule another mouseMove event
1880         // to check if any other elements ended up under the mouse pointer due to re-layout.
1881         if (m_hoveredElement && !m_hoveredElement->renderer())
1882             frameView.frame().mainFrame().eventHandler().dispatchFakeMouseMoveEventSoon();
1883
1884         ++m_styleRecalcCount;
1885         // FIXME: Assert ASSERT(!needsStyleRecalc()) here. Do we still have some cases where it's not true?
1886     }
1887
1888     // If we wanted to call implicitClose() during recalcStyle, do so now that we're finished.
1889     if (m_closeAfterStyleRecalc) {
1890         m_closeAfterStyleRecalc = false;
1891         implicitClose();
1892     }
1893
1894     InspectorInstrumentation::didRecalculateStyle(cookie);
1895
1896     // Some animated images may now be inside the viewport due to style recalc,
1897     // resume them if necessary if there is no layout pending. Otherwise, we'll
1898     // check if they need to be resumed after layout.
1899     if (updatedCompositingLayers && !frameView.needsLayout())
1900         frameView.viewportContentsChanged();
1901
1902     if (m_gotoAnchorNeededAfterStylesheetsLoad && !styleScope().hasPendingSheets())
1903         frameView.scrollToFragment(m_url);
1904 }
1905
1906 void Document::updateTextRenderer(Text& text, unsigned offsetOfReplacedText, unsigned lengthOfReplacedText)
1907 {
1908     ASSERT(!m_inRenderTreeUpdate);
1909     SetForScope<bool> inRenderTreeUpdate(m_inRenderTreeUpdate, true);
1910
1911     auto textUpdate = std::make_unique<Style::Update>(*this);
1912     textUpdate->addText(text, { offsetOfReplacedText, lengthOfReplacedText, std::nullopt });
1913
1914     RenderTreeUpdater renderTreeUpdater(*this);
1915     renderTreeUpdater.commit(WTFMove(textUpdate));
1916 }
1917
1918 bool Document::needsStyleRecalc() const
1919 {
1920     if (pageCacheState() != NotInPageCache)
1921         return false;
1922
1923     if (m_pendingStyleRecalcShouldForce)
1924         return true;
1925
1926     if (childNeedsStyleRecalc())
1927         return true;
1928
1929     if (styleScope().hasPendingUpdate())
1930         return true;
1931
1932     // Ensure this happens eventually as it is currently in resolveStyle. This can be removed if the code moves.
1933     if (m_gotoAnchorNeededAfterStylesheetsLoad && !styleScope().hasPendingSheets())
1934         return true;
1935
1936     return false;
1937 }
1938
1939 static bool isSafeToUpdateStyleOrLayout(const Document& document)
1940 {
1941     bool isSafeToExecuteScript = ScriptDisallowedScope::InMainThread::isScriptAllowed();
1942     auto* frameView = document.view();
1943     bool isInFrameFlattening = frameView && frameView->isInChildFrameWithFrameFlattening();
1944     bool isAssertionDisabled = ScriptDisallowedScope::LayoutAssertionDisableScope::shouldDisable();
1945     return isSafeToExecuteScript || isInFrameFlattening || !isInWebProcess() || isAssertionDisabled;
1946 }
1947
1948 bool Document::updateStyleIfNeeded()
1949 {
1950     RefPtr<FrameView> frameView = view();
1951     {
1952         ScriptDisallowedScope::InMainThread scriptDisallowedScope;
1953         ASSERT(isMainThread());
1954         ASSERT(!frameView || !frameView->isPainting());
1955
1956         if (!frameView || frameView->layoutContext().isInRenderTreeLayout())
1957             return false;
1958
1959         styleScope().flushPendingUpdate();
1960
1961         if (!needsStyleRecalc())
1962             return false;
1963     }
1964
1965     // The early exit above for !needsStyleRecalc() is needed when updateWidgetPositions() is called in runOrScheduleAsynchronousTasks().
1966     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(isSafeToUpdateStyleOrLayout(*this));
1967
1968     resolveStyle();
1969     return true;
1970 }
1971
1972 void Document::updateLayout()
1973 {
1974     ASSERT(isMainThread());
1975
1976     RefPtr<FrameView> frameView = view();
1977     if (frameView && frameView->layoutContext().isInRenderTreeLayout()) {
1978         // View layout should not be re-entrant.
1979         ASSERT_NOT_REACHED();
1980         return;
1981     }
1982     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(isSafeToUpdateStyleOrLayout(*this));
1983
1984     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
1985
1986     if (HTMLFrameOwnerElement* owner = ownerElement())
1987         owner->document().updateLayout();
1988
1989     updateStyleIfNeeded();
1990
1991     StackStats::LayoutCheckPoint layoutCheckPoint;
1992
1993     // Only do a layout if changes have occurred that make it necessary.      
1994     if (frameView && renderView() && (frameView->layoutContext().isLayoutPending() || renderView()->needsLayout()))
1995         frameView->layoutContext().layout();
1996 }
1997
1998 void Document::updateLayoutIgnorePendingStylesheets(Document::RunPostLayoutTasks runPostLayoutTasks)
1999 {
2000     bool oldIgnore = m_ignorePendingStylesheets;
2001
2002     if (!haveStylesheetsLoaded()) {
2003         m_ignorePendingStylesheets = true;
2004         // FIXME: This should just invalidate elements with missing styles.
2005         if (m_hasNodesWithMissingStyle)
2006             scheduleForcedStyleRecalc();
2007     }
2008
2009     updateLayout();
2010
2011     if (runPostLayoutTasks == RunPostLayoutTasks::Synchronously && view())
2012         view()->flushAnyPendingPostLayoutTasks();
2013
2014     m_ignorePendingStylesheets = oldIgnore;
2015 }
2016
2017 std::unique_ptr<RenderStyle> Document::styleForElementIgnoringPendingStylesheets(Element& element, const RenderStyle* parentStyle, PseudoId pseudoElementSpecifier)
2018 {
2019     ASSERT(&element.document() == this);
2020     ASSERT(!element.isPseudoElement() || pseudoElementSpecifier == PseudoId::None);
2021     ASSERT(pseudoElementSpecifier == PseudoId::None || parentStyle);
2022
2023     // On iOS request delegates called during styleForElement may result in re-entering WebKit and killing the style resolver.
2024     Style::PostResolutionCallbackDisabler disabler(*this, Style::PostResolutionCallbackDisabler::DrainCallbacks::No);
2025
2026     SetForScope<bool> change(m_ignorePendingStylesheets, true);
2027     auto& resolver = element.styleResolver();
2028
2029     if (pseudoElementSpecifier != PseudoId::None)
2030         return resolver.pseudoStyleForElement(element, PseudoStyleRequest(pseudoElementSpecifier), *parentStyle);
2031
2032     auto elementStyle = resolver.styleForElement(element, parentStyle);
2033     if (elementStyle.relations) {
2034         Style::Update emptyUpdate(*this);
2035         Style::commitRelations(WTFMove(elementStyle.relations), emptyUpdate);
2036     }
2037
2038     return WTFMove(elementStyle.renderStyle);
2039 }
2040
2041 bool Document::updateLayoutIfDimensionsOutOfDate(Element& element, DimensionsCheck dimensionsCheck)
2042 {
2043     ASSERT(isMainThread());
2044     
2045     // If the stylesheets haven't loaded, just give up and do a full layout ignoring pending stylesheets.
2046     if (!haveStylesheetsLoaded()) {
2047         updateLayoutIgnorePendingStylesheets();
2048         return true;
2049     }
2050     
2051     // Check for re-entrancy and assert (same code that is in updateLayout()).
2052     RefPtr<FrameView> frameView = view();
2053     if (frameView && frameView->layoutContext().isInRenderTreeLayout()) {
2054         // View layout should not be re-entrant.
2055         ASSERT_NOT_REACHED();
2056         return true;
2057     }
2058     
2059     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
2060     
2061     // Mimic the structure of updateLayout(), but at each step, see if we have been forced into doing a full
2062     // layout.
2063     bool requireFullLayout = false;
2064     if (HTMLFrameOwnerElement* owner = ownerElement()) {
2065         if (owner->document().updateLayoutIfDimensionsOutOfDate(*owner))
2066             requireFullLayout = true;
2067     }
2068     
2069     updateStyleIfNeeded();
2070
2071     RenderObject* renderer = element.renderer();
2072     if (!renderer || renderer->needsLayout()) {
2073         // If we don't have a renderer or if the renderer needs layout for any reason, give up.
2074         requireFullLayout = true;
2075     }
2076
2077     // Turn off this optimization for input elements with shadow content.
2078     if (is<HTMLInputElement>(element))
2079         requireFullLayout = true;
2080
2081     bool isVertical = renderer && !renderer->isHorizontalWritingMode();
2082     bool checkingLogicalWidth = ((dimensionsCheck & WidthDimensionsCheck) && !isVertical) || ((dimensionsCheck & HeightDimensionsCheck) && isVertical);
2083     bool checkingLogicalHeight = ((dimensionsCheck & HeightDimensionsCheck) && !isVertical) || ((dimensionsCheck & WidthDimensionsCheck) && isVertical);
2084     bool hasSpecifiedLogicalHeight = renderer && renderer->style().logicalMinHeight() == Length(0, Fixed) && renderer->style().logicalHeight().isFixed() && renderer->style().logicalMaxHeight().isAuto();
2085     
2086     if (!requireFullLayout) {
2087         RenderBox* previousBox = nullptr;
2088         RenderBox* currentBox = nullptr;
2089         
2090         // Check our containing block chain. If anything in the chain needs a layout, then require a full layout.
2091         for (RenderObject* currRenderer = element.renderer(); currRenderer && !currRenderer->isRenderView(); currRenderer = currRenderer->container()) {
2092             
2093             // Require the entire container chain to be boxes.
2094             if (!is<RenderBox>(currRenderer)) {
2095                 requireFullLayout = true;
2096                 break;
2097             }
2098             
2099             previousBox = currentBox;
2100             currentBox = downcast<RenderBox>(currRenderer);
2101             
2102             // If a box needs layout for itself or if a box has changed children and sizes its width to
2103             // its content, then require a full layout.
2104             if (currentBox->selfNeedsLayout() ||
2105                 (checkingLogicalWidth && currRenderer->needsLayout() && currentBox->sizesLogicalWidthToFitContent(MainOrPreferredSize))) {
2106                 requireFullLayout = true;
2107                 break;
2108             }
2109             
2110             // If a block contains floats and the child's height isn't specified, then
2111             // give up also, since our height could end up being influenced by the floats.
2112             if (checkingLogicalHeight && !hasSpecifiedLogicalHeight && currentBox->isRenderBlockFlow()) {
2113                 RenderBlockFlow* currentBlockFlow = downcast<RenderBlockFlow>(currentBox);
2114                 if (currentBlockFlow->containsFloats() && previousBox && !previousBox->isFloatingOrOutOfFlowPositioned()) {
2115                     requireFullLayout = true;
2116                     break;
2117                 }
2118             }
2119             
2120             if (!currentBox->isRenderBlockFlow() || currentBox->enclosingFragmentedFlow() || currentBox->isWritingModeRoot()) {
2121                 // FIXME: For now require only block flows all the way back to the root. This limits the optimization
2122                 // for now, and we'll expand it in future patches to apply to more and more scenarios.
2123                 // Disallow columns from having the optimization.
2124                 // Give up if the writing mode changes at all in the containing block chain.
2125                 requireFullLayout = true;
2126                 break;
2127             }
2128             
2129             if (currRenderer == frameView->layoutContext().subtreeLayoutRoot())
2130                 break;
2131         }
2132     }
2133     
2134     StackStats::LayoutCheckPoint layoutCheckPoint;
2135
2136     // Only do a layout if changes have occurred that make it necessary.      
2137     if (requireFullLayout && frameView && renderView() && (frameView->layoutContext().isLayoutPending() || renderView()->needsLayout()))
2138         frameView->layoutContext().layout();
2139     
2140     return requireFullLayout;
2141 }
2142
2143 bool Document::isPageBoxVisible(int pageIndex)
2144 {
2145     updateStyleIfNeeded();
2146     std::unique_ptr<RenderStyle> pageStyle(styleScope().resolver().styleForPage(pageIndex));
2147     return pageStyle->visibility() != Visibility::Hidden; // display property doesn't apply to @page.
2148 }
2149
2150 void Document::pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft)
2151 {
2152     updateStyleIfNeeded();
2153     auto style = styleScope().resolver().styleForPage(pageIndex);
2154
2155     int width = pageSize.width();
2156     int height = pageSize.height();
2157     switch (style->pageSizeType()) {
2158     case PAGE_SIZE_AUTO:
2159         break;
2160     case PAGE_SIZE_AUTO_LANDSCAPE:
2161         if (width < height)
2162             std::swap(width, height);
2163         break;
2164     case PAGE_SIZE_AUTO_PORTRAIT:
2165         if (width > height)
2166             std::swap(width, height);
2167         break;
2168     case PAGE_SIZE_RESOLVED: {
2169         auto& size = style->pageSize();
2170         ASSERT(size.width.isFixed());
2171         ASSERT(size.height.isFixed());
2172         width = valueForLength(size.width, 0);
2173         height = valueForLength(size.height, 0);
2174         break;
2175     }
2176     default:
2177         ASSERT_NOT_REACHED();
2178     }
2179     pageSize = IntSize(width, height);
2180
2181     // The percentage is calculated with respect to the width even for margin top and bottom.
2182     // http://www.w3.org/TR/CSS2/box.html#margin-properties
2183     marginTop = style->marginTop().isAuto() ? marginTop : intValueForLength(style->marginTop(), width);
2184     marginRight = style->marginRight().isAuto() ? marginRight : intValueForLength(style->marginRight(), width);
2185     marginBottom = style->marginBottom().isAuto() ? marginBottom : intValueForLength(style->marginBottom(), width);
2186     marginLeft = style->marginLeft().isAuto() ? marginLeft : intValueForLength(style->marginLeft(), width);
2187 }
2188
2189 StyleResolver& Document::userAgentShadowTreeStyleResolver()
2190 {
2191     if (!m_userAgentShadowTreeStyleResolver)
2192         m_userAgentShadowTreeStyleResolver = std::make_unique<StyleResolver>(*this);
2193     return *m_userAgentShadowTreeStyleResolver;
2194 }
2195
2196 void Document::fontsNeedUpdate(FontSelector&)
2197 {
2198     invalidateMatchedPropertiesCacheAndForceStyleRecalc();
2199 }
2200
2201 void Document::invalidateMatchedPropertiesCacheAndForceStyleRecalc()
2202 {
2203     if (auto* resolver = styleScope().resolverIfExists())
2204         resolver->invalidateMatchedPropertiesCache();
2205     if (pageCacheState() != NotInPageCache || !renderView())
2206         return;
2207     scheduleForcedStyleRecalc();
2208 }
2209
2210 void Document::didClearStyleResolver()
2211 {
2212     m_userAgentShadowTreeStyleResolver = nullptr;
2213 }
2214
2215 void Document::createRenderTree()
2216 {
2217     ASSERT(!renderView());
2218     ASSERT(m_pageCacheState != InPageCache);
2219     ASSERT(!m_axObjectCache || this != &topDocument());
2220
2221     if (m_isNonRenderedPlaceholder)
2222         return;
2223
2224     // FIXME: It would be better if we could pass the resolved document style directly here.
2225     m_renderView = createRenderer<RenderView>(*this, RenderStyle::create());
2226     Node::setRenderer(m_renderView.get());
2227
2228     renderView()->setIsInWindow(true);
2229
2230     resolveStyle(ResolveStyleType::Rebuild);
2231 }
2232
2233 void Document::didBecomeCurrentDocumentInFrame()
2234 {
2235     // FIXME: Are there cases where the document can be dislodged from the frame during the event handling below?
2236     // If so, then m_frame could become 0, and we need to do something about that.
2237
2238     m_frame->script().updateDocument();
2239
2240     if (!hasLivingRenderTree())
2241         createRenderTree();
2242
2243     dispatchDisabledAdaptationsDidChangeForMainFrame();
2244     updateViewportArguments();
2245
2246     // FIXME: Doing this only for the main frame is insufficient.
2247     // Changing a subframe can also change the wheel event handler count.
2248     // FIXME: Doing this only when a document goes into the frame is insufficient.
2249     // Removing a document can also change the wheel event handler count.
2250     // FIXME: Doing this every time is a waste. If the current document and its
2251     // subframes' documents have no wheel event handlers, then the count did not change,
2252     // unless the documents they are replacing had wheel event handlers.
2253     if (page() && m_frame->isMainFrame())
2254         wheelEventHandlersChanged();
2255
2256     // Ensure that the scheduled task state of the document matches the DOM suspension state of the frame. It can
2257     // be out of sync if the DOM suspension state changed while the document was not in the frame (possibly in the
2258     // page cache, or simply newly created).
2259     if (m_frame->activeDOMObjectsAndAnimationsSuspended()) {
2260         if (RuntimeEnabledFeatures::sharedFeatures().webAnimationsCSSIntegrationEnabled())
2261             timeline().suspendAnimations();
2262         else
2263             m_frame->animation().suspendAnimationsForDocument(this);
2264         suspendScheduledTasks(ReasonForSuspension::PageWillBeSuspended);
2265     } else {
2266         resumeScheduledTasks(ReasonForSuspension::PageWillBeSuspended);
2267         if (RuntimeEnabledFeatures::sharedFeatures().webAnimationsCSSIntegrationEnabled())
2268             timeline().resumeAnimations();
2269         else
2270             m_frame->animation().resumeAnimationsForDocument(this);
2271     }
2272 }
2273
2274 void Document::frameDestroyed()
2275 {
2276     // detachFromFrame() must be called before destroying the Frame.
2277     RELEASE_ASSERT(!m_frame);
2278     FrameDestructionObserver::frameDestroyed();
2279 }
2280
2281 void Document::attachToCachedFrame(CachedFrameBase& cachedFrame)
2282 {
2283     RELEASE_ASSERT(cachedFrame.document() == this);
2284     ASSERT(cachedFrame.view());
2285     ASSERT(m_pageCacheState == Document::InPageCache);
2286     observeFrame(&cachedFrame.view()->frame());
2287 }
2288
2289 void Document::detachFromCachedFrame(CachedFrameBase& cachedFrame)
2290 {
2291     ASSERT_UNUSED(cachedFrame, cachedFrame.view());
2292     RELEASE_ASSERT(cachedFrame.document() == this);
2293     ASSERT(m_frame == &cachedFrame.view()->frame());
2294     ASSERT(m_pageCacheState == Document::InPageCache);
2295     detachFromFrame();
2296 }
2297
2298 void Document::destroyRenderTree()
2299 {
2300     ASSERT(hasLivingRenderTree());
2301     ASSERT(frame());
2302     ASSERT(frame()->document() == this);
2303     ASSERT(page());
2304
2305     // Prevent Widget tree changes from committing until the RenderView is dead and gone.
2306     WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
2307
2308     SetForScope<bool> change(m_renderTreeBeingDestroyed, true);
2309
2310     if (this == &topDocument())
2311         clearAXObjectCache();
2312
2313     documentWillBecomeInactive();
2314
2315     if (view())
2316         view()->willDestroyRenderTree();
2317
2318     if (m_documentElement)
2319         RenderTreeUpdater::tearDownRenderers(*m_documentElement);
2320
2321     clearChildNeedsStyleRecalc();
2322
2323     unscheduleStyleRecalc();
2324
2325     // FIXME: RenderObject::view() uses m_renderView and we can't null it before destruction is completed
2326     {
2327         RenderTreeBuilder builder(*m_renderView);
2328         // FIXME: This is a workaround for leftover content (see webkit.org/b/182547).
2329         while (m_renderView->firstChild())
2330             builder.destroy(*m_renderView->firstChild());
2331         m_renderView->destroy();
2332     }
2333     m_renderView.release();
2334
2335     Node::setRenderer(nullptr);
2336
2337 #if ENABLE(TEXT_AUTOSIZING)
2338     m_textAutoSizing = nullptr;
2339 #endif
2340
2341     if (view())
2342         view()->didDestroyRenderTree();
2343 }
2344
2345 void Document::prepareForDestruction()
2346 {
2347     if (m_hasPreparedForDestruction)
2348         return;
2349
2350     if (m_frame)
2351         m_frame->animation().detachFromDocument(this);
2352
2353 #if USE(LIBWEBRTC)
2354     // FIXME: This should be moved to Modules/mediastream.
2355     if (LibWebRTCProvider::webRTCAvailable()) {
2356         if (auto* page = this->page())
2357             page->libWebRTCProvider().unregisterMDNSNames(identifier().toUInt64());
2358     }
2359 #endif
2360
2361 #if ENABLE(SERVICE_WORKER)
2362     setActiveServiceWorker(nullptr);
2363     setServiceWorkerConnection(nullptr);
2364 #endif
2365
2366 #if ENABLE(IOS_TOUCH_EVENTS)
2367     clearTouchEventHandlersAndListeners();
2368 #endif
2369
2370 #if HAVE(ACCESSIBILITY)
2371     if (this != &topDocument()) {
2372         // Let the ax cache know that this subframe goes out of scope.
2373         if (auto* cache = existingAXObjectCache())
2374             cache->prepareForDocumentDestruction(*this);
2375     }
2376 #endif
2377
2378     {
2379         NavigationDisabler navigationDisabler(m_frame);
2380         disconnectDescendantFrames();
2381     }
2382
2383     if (m_domWindow && m_frame)
2384         m_domWindow->willDetachDocumentFromFrame();
2385
2386     styleScope().clearResolver();
2387
2388     if (hasLivingRenderTree())
2389         destroyRenderTree();
2390
2391     if (is<PluginDocument>(*this))
2392         downcast<PluginDocument>(*this).detachFromPluginElement();
2393
2394 #if ENABLE(POINTER_LOCK)
2395     if (page())
2396         page()->pointerLockController().documentDetached(*this);
2397 #endif
2398
2399     if (auto* page = this->page()) {
2400         if (auto* validationMessageClient = page->validationMessageClient())
2401             validationMessageClient->documentDetached(*this);
2402     }
2403
2404     InspectorInstrumentation::documentDetached(*this);
2405
2406     stopActiveDOMObjects();
2407     m_eventQueue.close();
2408 #if ENABLE(FULLSCREEN_API)
2409     m_fullScreenChangeEventTargetQueue.clear();
2410     m_fullScreenErrorEventTargetQueue.clear();
2411 #endif
2412
2413     commonTeardown();
2414
2415 #if ENABLE(TOUCH_EVENTS)
2416     if (m_touchEventTargets && m_touchEventTargets->size() && parentDocument())
2417         parentDocument()->didRemoveEventTargetNode(*this);
2418 #endif
2419
2420     if (m_wheelEventTargets && m_wheelEventTargets->size() && parentDocument())
2421         parentDocument()->didRemoveEventTargetNode(*this);
2422
2423     if (m_mediaQueryMatcher)
2424         m_mediaQueryMatcher->documentDestroyed();
2425
2426 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
2427     if (!m_clientToIDMap.isEmpty() && page()) {
2428         for (auto* client : copyToVector(m_clientToIDMap.keys()))
2429             removePlaybackTargetPickerClient(*client);
2430     }
2431 #endif
2432
2433     m_cachedResourceLoader->stopUnusedPreloadsTimer();
2434
2435     if (page() && m_mediaState != MediaProducer::IsNotPlaying) {
2436         m_mediaState = MediaProducer::IsNotPlaying;
2437         page()->updateIsPlayingMedia(HTMLMediaElementInvalidID);
2438     }
2439
2440     detachFromFrame();
2441
2442     if (m_timeline) {
2443         m_timeline->detachFromDocument();
2444         m_timeline = nullptr;
2445     }
2446
2447 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
2448     if (m_animationScheduler) {
2449         m_animationScheduler->detachFromDocument();
2450         m_animationScheduler = nullptr;
2451     }
2452 #endif
2453
2454     m_hasPreparedForDestruction = true;
2455
2456     // Note that m_pageCacheState can be Document::AboutToEnterPageCache if our frame
2457     // was removed in an onpagehide event handler fired when the top-level frame is
2458     // about to enter the page cache.
2459     RELEASE_ASSERT(m_pageCacheState != Document::InPageCache);
2460 }
2461
2462 void Document::removeAllEventListeners()
2463 {
2464     EventTarget::removeAllEventListeners();
2465
2466     if (m_domWindow)
2467         m_domWindow->removeAllEventListeners();
2468
2469 #if ENABLE(IOS_TOUCH_EVENTS)
2470     clearTouchEventHandlersAndListeners();
2471 #endif
2472     for (Node* node = firstChild(); node; node = NodeTraversal::next(*node))
2473         node->removeAllEventListeners();
2474
2475 #if ENABLE(TOUCH_EVENTS)
2476     m_touchEventTargets = nullptr;
2477 #endif
2478     m_wheelEventTargets = nullptr;
2479 }
2480
2481 void Document::suspendDeviceMotionAndOrientationUpdates()
2482 {
2483     if (m_areDeviceMotionAndOrientationUpdatesSuspended)
2484         return;
2485     m_areDeviceMotionAndOrientationUpdatesSuspended = true;
2486 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
2487     if (m_deviceMotionController)
2488         m_deviceMotionController->suspendUpdates();
2489     if (m_deviceOrientationController)
2490         m_deviceOrientationController->suspendUpdates();
2491 #endif
2492 }
2493
2494 void Document::resumeDeviceMotionAndOrientationUpdates()
2495 {
2496     if (!m_areDeviceMotionAndOrientationUpdatesSuspended)
2497         return;
2498     m_areDeviceMotionAndOrientationUpdatesSuspended = false;
2499 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
2500     if (m_deviceMotionController)
2501         m_deviceMotionController->resumeUpdates();
2502     if (m_deviceOrientationController)
2503         m_deviceOrientationController->resumeUpdates();
2504 #endif
2505 }
2506
2507 bool Document::shouldBypassMainWorldContentSecurityPolicy() const
2508 {
2509     // Bypass this policy when the world is known, and it not the normal world.
2510     auto& callFrame = *commonVM().topCallFrame;
2511     return &callFrame != JSC::CallFrame::noCaller() && !currentWorld(callFrame).isNormal();
2512 }
2513
2514 void Document::platformSuspendOrStopActiveDOMObjects()
2515 {
2516 #if PLATFORM(IOS)
2517     if (WebThreadCountOfObservedContentModifiers() > 0) {
2518         if (auto* frame = this->frame()) {
2519             if (auto* page = frame->page())
2520                 page->chrome().client().clearContentChangeObservers(*frame);
2521         }
2522     }
2523 #endif
2524 }
2525
2526 void Document::suspendActiveDOMObjects(ReasonForSuspension why)
2527 {
2528     ScriptExecutionContext::suspendActiveDOMObjects(why);
2529     suspendDeviceMotionAndOrientationUpdates();
2530     platformSuspendOrStopActiveDOMObjects();
2531 }
2532
2533 void Document::resumeActiveDOMObjects(ReasonForSuspension why)
2534 {
2535     ScriptExecutionContext::resumeActiveDOMObjects(why);
2536     resumeDeviceMotionAndOrientationUpdates();
2537     // FIXME: For iOS, do we need to add content change observers that were removed in Document::suspendActiveDOMObjects()?
2538 }
2539
2540 void Document::stopActiveDOMObjects()
2541 {
2542     ScriptExecutionContext::stopActiveDOMObjects();
2543     platformSuspendOrStopActiveDOMObjects();
2544 }
2545
2546 void Document::clearAXObjectCache()
2547 {
2548     ASSERT(&topDocument() == this);
2549     // Clear the cache member variable before calling delete because attempts
2550     // are made to access it during destruction.
2551     m_axObjectCache = nullptr;
2552 }
2553
2554 AXObjectCache* Document::existingAXObjectCacheSlow() const
2555 {
2556     ASSERT(hasEverCreatedAnAXObjectCache);
2557     return topDocument().m_axObjectCache.get();
2558 }
2559
2560 AXObjectCache* Document::axObjectCache() const
2561 {
2562     if (!AXObjectCache::accessibilityEnabled())
2563         return nullptr;
2564     
2565     // The only document that actually has a AXObjectCache is the top-level
2566     // document.  This is because we need to be able to get from any WebCoreAXObject
2567     // to any other WebCoreAXObject on the same page.  Using a single cache allows
2568     // lookups across nested webareas (i.e. multiple documents).
2569     Document& topDocument = this->topDocument();
2570
2571     // If the document has already been detached, do not make a new axObjectCache.
2572     if (!topDocument.hasLivingRenderTree())
2573         return nullptr;
2574
2575     ASSERT(&topDocument == this || !m_axObjectCache);
2576     if (!topDocument.m_axObjectCache) {
2577         topDocument.m_axObjectCache = std::make_unique<AXObjectCache>(topDocument);
2578         hasEverCreatedAnAXObjectCache = true;
2579     }
2580     return topDocument.m_axObjectCache.get();
2581 }
2582
2583 void Document::setVisuallyOrdered()
2584 {
2585     m_visuallyOrdered = true;
2586     if (renderView())
2587         renderView()->mutableStyle().setRTLOrdering(Order::Visual);
2588 }
2589
2590 Ref<DocumentParser> Document::createParser()
2591 {
2592     // FIXME: this should probably pass the frame instead
2593     return XMLDocumentParser::create(*this, view());
2594 }
2595
2596 ScriptableDocumentParser* Document::scriptableDocumentParser() const
2597 {
2598     return parser() ? parser()->asScriptableDocumentParser() : nullptr;
2599 }
2600
2601 ExceptionOr<RefPtr<WindowProxy>> Document::openForBindings(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& url, const AtomicString& name, const String& features)
2602 {
2603     if (!m_domWindow)
2604         return Exception { InvalidAccessError };
2605
2606     return m_domWindow->open(activeWindow, firstWindow, url, name, features);
2607 }
2608
2609 // FIXME: Add support for the 'type' and 'replace' parameters.
2610 ExceptionOr<Document&> Document::openForBindings(Document* responsibleDocument, const String&, const String&)
2611 {
2612     if (!isHTMLDocument() || m_throwOnDynamicMarkupInsertionCount)
2613         return Exception { InvalidStateError };
2614
2615     open(responsibleDocument);
2616     return *this;
2617 }
2618
2619 void Document::open(Document* responsibleDocument)
2620 {
2621     if (m_ignoreOpensDuringUnloadCount)
2622         return;
2623
2624     if (responsibleDocument) {
2625         setURL(responsibleDocument->url());
2626         setCookieURL(responsibleDocument->cookieURL());
2627         setSecurityOriginPolicy(responsibleDocument->securityOriginPolicy());
2628     }
2629
2630     if (m_frame) {
2631         if (ScriptableDocumentParser* parser = scriptableDocumentParser()) {
2632             if (parser->isParsing()) {
2633                 // FIXME: HTML5 doesn't tell us to check this, it might not be correct.
2634                 if (parser->isExecutingScript())
2635                     return;
2636
2637                 if (!parser->wasCreatedByScript() && parser->hasInsertionPoint())
2638                     return;
2639             }
2640         }
2641
2642         if (m_frame->loader().policyChecker().delegateIsDecidingNavigationPolicy())
2643             m_frame->loader().policyChecker().stopCheck();
2644         if (m_frame->loader().state() == FrameStateProvisional)
2645             m_frame->loader().stopAllLoaders();
2646     }
2647
2648     removeAllEventListeners();
2649     implicitOpen();
2650     if (ScriptableDocumentParser* parser = scriptableDocumentParser())
2651         parser->setWasCreatedByScript(true);
2652
2653     if (m_frame)
2654         m_frame->loader().didExplicitOpen();
2655 }
2656
2657 void Document::detachParser()
2658 {
2659     if (!m_parser)
2660         return;
2661     m_parser->detach();
2662     m_parser = nullptr;
2663 }
2664
2665 void Document::cancelParsing()
2666 {
2667     if (!m_parser)
2668         return;
2669
2670     // We have to clear the parser to avoid possibly triggering
2671     // the onload handler when closing as a side effect of a cancel-style
2672     // change, such as opening a new document or closing the window while
2673     // still parsing
2674     detachParser();
2675     explicitClose();
2676 }
2677
2678 void Document::implicitOpen()
2679 {
2680     removeChildren();
2681
2682     setCompatibilityMode(DocumentCompatibilityMode::NoQuirksMode);
2683
2684     cancelParsing();
2685     m_parser = createParser();
2686
2687     if (hasActiveParserYieldToken())
2688         m_parser->didBeginYieldingParser();
2689
2690     setParsing(true);
2691     setReadyState(Loading);
2692 }
2693
2694 HTMLBodyElement* Document::body() const
2695 {
2696     auto* element = documentElement();
2697     if (!element)
2698         return nullptr;
2699     return childrenOfType<HTMLBodyElement>(*element).first();
2700 }
2701
2702 HTMLElement* Document::bodyOrFrameset() const
2703 {
2704     // Return the first body or frameset child of the html element.
2705     auto* element = documentElement();
2706     if (!is<HTMLHtmlElement>(element))
2707         return nullptr;
2708     for (auto& child : childrenOfType<HTMLElement>(*element)) {
2709         if (is<HTMLBodyElement>(child) || is<HTMLFrameSetElement>(child))
2710             return &child;
2711     }
2712     return nullptr;
2713 }
2714
2715 ExceptionOr<void> Document::setBodyOrFrameset(RefPtr<HTMLElement>&& newBody)
2716 {
2717     if (!is<HTMLBodyElement>(newBody) && !is<HTMLFrameSetElement>(newBody))
2718         return Exception { HierarchyRequestError };
2719
2720     auto* currentBody = bodyOrFrameset();
2721     if (newBody == currentBody)
2722         return { };
2723
2724     if (!m_documentElement)
2725         return Exception { HierarchyRequestError };
2726
2727     if (currentBody)
2728         return m_documentElement->replaceChild(*newBody, *currentBody);
2729     return m_documentElement->appendChild(*newBody);
2730 }
2731
2732 Location* Document::location() const
2733 {
2734     auto* window = domWindow();
2735     if (!window)
2736         return nullptr;
2737
2738     return window->location();
2739 }
2740
2741 HTMLHeadElement* Document::head()
2742 {
2743     if (auto element = documentElement())
2744         return childrenOfType<HTMLHeadElement>(*element).first();
2745     return nullptr;
2746 }
2747
2748 ExceptionOr<void> Document::closeForBindings()
2749 {
2750     // FIXME: We should follow the specification more closely:
2751     //        http://www.whatwg.org/specs/web-apps/current-work/#dom-document-close
2752
2753     if (!isHTMLDocument() || m_throwOnDynamicMarkupInsertionCount)
2754         return Exception { InvalidStateError };
2755
2756     close();
2757     return { };
2758 }
2759
2760 void Document::close()
2761 {
2762     if (!scriptableDocumentParser() || !scriptableDocumentParser()->wasCreatedByScript() || !scriptableDocumentParser()->isParsing())
2763         return;
2764
2765     explicitClose();
2766 }
2767
2768 void Document::explicitClose()
2769 {
2770     if (RefPtr<DocumentParser> parser = m_parser)
2771         parser->finish();
2772
2773     if (!m_frame) {
2774         // Because we have no frame, we don't know if all loading has completed,
2775         // so we just call implicitClose() immediately. FIXME: This might fire
2776         // the load event prematurely <http://bugs.webkit.org/show_bug.cgi?id=14568>.
2777         implicitClose();
2778         return;
2779     }
2780
2781     checkCompleted();
2782 }
2783
2784 void Document::implicitClose()
2785 {
2786     // If we're in the middle of recalcStyle, we need to defer the close until the style information is accurate and all elements are re-attached.
2787     if (m_inStyleRecalc) {
2788         m_closeAfterStyleRecalc = true;
2789         return;
2790     }
2791
2792     bool wasLocationChangePending = frame() && frame()->navigationScheduler().locationChangePending();
2793     bool doload = !parsing() && m_parser && !m_processingLoadEvent && !wasLocationChangePending;
2794     
2795     if (!doload)
2796         return;
2797
2798     // Call to dispatchWindowLoadEvent can blow us from underneath.
2799     Ref<Document> protectedThis(*this);
2800
2801     m_processingLoadEvent = true;
2802
2803     ScriptableDocumentParser* parser = scriptableDocumentParser();
2804     m_wellFormed = parser && parser->wellFormed();
2805
2806     // We have to clear the parser, in case someone document.write()s from the
2807     // onLoad event handler, as in Radar 3206524.
2808     detachParser();
2809
2810     // FIXME: We kick off the icon loader when the Document is done parsing.
2811     // There are earlier opportunities we could start it:
2812     //  -When the <head> finishes parsing
2813     //  -When any new HTMLLinkElement is inserted into the document
2814     // But those add a dynamic component to the favicon that has UI 
2815     // ramifications, and we need to decide what is the Right Thing To Do(tm)
2816     RefPtr<Frame> f = frame();
2817     if (f) {
2818 #if ENABLE(XSLT)
2819         // Apply XSL transforms before load events so that event handlers can access the transformed DOM tree.
2820         applyPendingXSLTransformsNowIfScheduled();
2821 #endif
2822
2823         if (auto* documentLoader = loader())
2824             documentLoader->startIconLoading();
2825
2826         f->animation().startAnimationsIfNotSuspended(this);
2827
2828         // FIXME: We shouldn't be dispatching pending events globally on all Documents here.
2829         // For now, only do this when there is a Frame, otherwise this could cause JS reentrancy
2830         // below SVG font parsing, for example. <https://webkit.org/b/136269>
2831         ImageLoader::dispatchPendingBeforeLoadEvents();
2832         ImageLoader::dispatchPendingLoadEvents();
2833         ImageLoader::dispatchPendingErrorEvents();
2834         HTMLLinkElement::dispatchPendingLoadEvents();
2835         HTMLStyleElement::dispatchPendingLoadEvents();
2836
2837         // To align the HTML load event and the SVGLoad event for the outermost <svg> element, fire it from
2838         // here, instead of doing it from SVGElement::finishedParsingChildren (if externalResourcesRequired="false",
2839         // which is the default, for ='true' its fired at a later time, once all external resources finished loading).
2840         if (svgExtensions())
2841             accessSVGExtensions().dispatchSVGLoadEventToOutermostSVGElements();
2842     }
2843
2844     dispatchWindowLoadEvent();
2845     dispatchPageshowEvent(PageshowEventNotPersisted);
2846     if (m_pendingStateObject)
2847         dispatchPopstateEvent(WTFMove(m_pendingStateObject));
2848
2849     if (f)
2850         f->loader().dispatchOnloadEvents();
2851
2852     // An event handler may have removed the frame
2853     if (!frame()) {
2854         m_processingLoadEvent = false;
2855         return;
2856     }
2857
2858     // Make sure both the initial layout and reflow happen after the onload
2859     // fires. This will improve onload scores, and other browsers do it.
2860     // If they wanna cheat, we can too. -dwh
2861
2862     if (frame()->navigationScheduler().locationChangePending() && timeSinceDocumentCreation() < settings().layoutInterval()) {
2863         // Just bail out. Before or during the onload we were shifted to another page.
2864         // The old i-Bench suite does this. When this happens don't bother painting or laying out.        
2865         m_processingLoadEvent = false;
2866         view()->layoutContext().unscheduleLayout();
2867         return;
2868     }
2869
2870     frame()->loader().checkCallImplicitClose();
2871     
2872     // We used to force a synchronous display and flush here.  This really isn't
2873     // necessary and can in fact be actively harmful if pages are loading at a rate of > 60fps
2874     // (if your platform is syncing flushes and limiting them to 60fps).
2875     m_overMinimumLayoutThreshold = true;
2876     if (!ownerElement() || (ownerElement()->renderer() && !ownerElement()->renderer()->needsLayout())) {
2877         updateStyleIfNeeded();
2878         
2879         // Always do a layout after loading if needed.
2880         if (view() && renderView() && (!renderView()->firstChild() || renderView()->needsLayout()))
2881             view()->layoutContext().layout();
2882     }
2883
2884     m_processingLoadEvent = false;
2885
2886 #if PLATFORM(COCOA) || PLATFORM(WIN) || PLATFORM(GTK)
2887     if (f && hasLivingRenderTree() && AXObjectCache::accessibilityEnabled()) {
2888         // The AX cache may have been cleared at this point, but we need to make sure it contains an
2889         // AX object to send the notification to. getOrCreate will make sure that an valid AX object
2890         // exists in the cache (we ignore the return value because we don't need it here). This is 
2891         // only safe to call when a layout is not in progress, so it can not be used in postNotification.
2892         //
2893         // This notification is now called AXNewDocumentLoadComplete because there are other handlers that will
2894         // catch new AND page history loads, and that uses AXLoadComplete
2895         
2896         axObjectCache()->getOrCreate(renderView());
2897         if (this == &topDocument())
2898             axObjectCache()->postNotification(renderView(), AXObjectCache::AXNewDocumentLoadComplete);
2899         else {
2900             // AXLoadComplete can only be posted on the top document, so if it's a document
2901             // in an iframe that just finished loading, post AXLayoutComplete instead.
2902             axObjectCache()->postNotification(renderView(), AXObjectCache::AXLayoutComplete);
2903         }
2904     }
2905 #endif
2906
2907     if (svgExtensions())
2908         accessSVGExtensions().startAnimations();
2909 }
2910
2911 void Document::setParsing(bool b)
2912 {
2913     m_bParsing = b;
2914
2915     if (m_bParsing && !m_sharedObjectPool)
2916         m_sharedObjectPool = std::make_unique<DocumentSharedObjectPool>();
2917
2918     if (!m_bParsing && view() && !view()->needsLayout())
2919         view()->fireLayoutRelatedMilestonesIfNeeded();
2920 }
2921
2922 bool Document::shouldScheduleLayout()
2923 {
2924     if (!documentElement())
2925         return false;
2926     if (!is<HTMLHtmlElement>(*documentElement()))
2927         return true;
2928     if (!bodyOrFrameset())
2929         return false;
2930     if (styleScope().hasPendingSheetsBeforeBody())
2931         return false;
2932
2933     return true;
2934 }
2935     
2936 bool Document::isLayoutTimerActive()
2937 {
2938     return view() && view()->layoutContext().isLayoutPending() && !minimumLayoutDelay();
2939 }
2940
2941 Seconds Document::minimumLayoutDelay()
2942 {
2943     if (m_overMinimumLayoutThreshold)
2944         return 0_s;
2945     
2946     auto elapsed = timeSinceDocumentCreation();
2947     m_overMinimumLayoutThreshold = elapsed > settings().layoutInterval();
2948
2949     // We'll want to schedule the timer to fire at the minimum layout threshold.
2950     return std::max(0_s, settings().layoutInterval() - elapsed);
2951 }
2952
2953 Seconds Document::timeSinceDocumentCreation() const
2954 {
2955     return MonotonicTime::now() - m_documentCreationTime;
2956 }
2957
2958 void Document::write(Document* responsibleDocument, SegmentedString&& text)
2959 {
2960     NestingLevelIncrementer nestingLevelIncrementer(m_writeRecursionDepth);
2961
2962     m_writeRecursionIsTooDeep = (m_writeRecursionDepth > 1) && m_writeRecursionIsTooDeep;
2963     m_writeRecursionIsTooDeep = (m_writeRecursionDepth > cMaxWriteRecursionDepth) || m_writeRecursionIsTooDeep;
2964
2965     if (m_writeRecursionIsTooDeep)
2966         return;
2967
2968     bool hasInsertionPoint = m_parser && m_parser->hasInsertionPoint();
2969     if (!hasInsertionPoint && (m_ignoreOpensDuringUnloadCount || m_ignoreDestructiveWriteCount))
2970         return;
2971
2972     if (!hasInsertionPoint)
2973         open(responsibleDocument);
2974
2975     ASSERT(m_parser);
2976     m_parser->insert(WTFMove(text));
2977 }
2978
2979 ExceptionOr<void> Document::write(Document* responsibleDocument, Vector<String>&& strings)
2980 {
2981     if (!isHTMLDocument() || m_throwOnDynamicMarkupInsertionCount)
2982         return Exception { InvalidStateError };
2983
2984     SegmentedString text;
2985     for (auto& string : strings)
2986         text.append(WTFMove(string));
2987
2988     write(responsibleDocument, WTFMove(text));
2989
2990     return { };
2991 }
2992
2993 ExceptionOr<void> Document::writeln(Document* responsibleDocument, Vector<String>&& strings)
2994 {
2995     if (!isHTMLDocument() || m_throwOnDynamicMarkupInsertionCount)
2996         return Exception { InvalidStateError };
2997
2998     SegmentedString text;
2999     for (auto& string : strings)
3000         text.append(WTFMove(string));
3001
3002     text.append("\n"_s);
3003     write(responsibleDocument, WTFMove(text));
3004
3005     return { };
3006 }
3007
3008 Seconds Document::minimumDOMTimerInterval() const
3009 {
3010     auto* page = this->page();
3011     if (!page)
3012         return ScriptExecutionContext::minimumDOMTimerInterval();
3013     return page->settings().minimumDOMTimerInterval();
3014 }
3015
3016 void Document::setTimerThrottlingEnabled(bool shouldThrottle)
3017 {
3018     if (m_isTimerThrottlingEnabled == shouldThrottle)
3019         return;
3020
3021     m_isTimerThrottlingEnabled = shouldThrottle;
3022     didChangeTimerAlignmentInterval();
3023 }
3024
3025 Seconds Document::domTimerAlignmentInterval(bool hasReachedMaxNestingLevel) const
3026 {
3027     auto alignmentInterval = ScriptExecutionContext::domTimerAlignmentInterval(hasReachedMaxNestingLevel);
3028     if (!hasReachedMaxNestingLevel)
3029         return alignmentInterval;
3030
3031     // Apply Document-level DOMTimer throttling only if timers have reached their maximum nesting level as the Page may still be visible.
3032     if (m_isTimerThrottlingEnabled)
3033         alignmentInterval = std::max(alignmentInterval, DOMTimer::hiddenPageAlignmentInterval());
3034
3035     if (Page* page = this->page())
3036         alignmentInterval = std::max(alignmentInterval, page->domTimerAlignmentInterval());
3037
3038     if (!topOrigin().canAccess(securityOrigin()) && !hasHadUserInteraction())
3039         alignmentInterval = std::max(alignmentInterval, DOMTimer::nonInteractedCrossOriginFrameAlignmentInterval());
3040
3041     return alignmentInterval;
3042 }
3043
3044 EventTarget* Document::errorEventTarget()
3045 {
3046     return m_domWindow.get();
3047 }
3048
3049 void Document::logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&& callStack)
3050 {
3051     addMessage(MessageSource::JS, MessageLevel::Error, errorMessage, sourceURL, lineNumber, columnNumber, WTFMove(callStack));
3052 }
3053
3054 void Document::setURL(const URL& url)
3055 {
3056     const URL& newURL = url.isEmpty() ? blankURL() : url;
3057     if (newURL == m_url)
3058         return;
3059
3060     m_url = newURL;
3061     m_documentURI = m_url.string();
3062     updateBaseURL();
3063 }
3064
3065 void Document::updateBaseURL()
3066 {
3067     URL oldBaseURL = m_baseURL;
3068     // DOM 3 Core: When the Document supports the feature "HTML" [DOM Level 2 HTML], the base URI is computed using
3069     // first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute
3070     // from the Document interface otherwise.
3071     if (!m_baseElementURL.isEmpty())
3072         m_baseURL = m_baseElementURL;
3073     else if (!m_baseURLOverride.isEmpty())
3074         m_baseURL = m_baseURLOverride;
3075     else {
3076         // The documentURI attribute is read-only from JavaScript, but writable from Objective C, so we need to retain
3077         // this fallback behavior. We use a null base URL, since the documentURI attribute is an arbitrary string
3078         // and DOM 3 Core does not specify how it should be resolved.
3079         m_baseURL = URL(ParsedURLString, documentURI());
3080     }
3081
3082     clearSelectorQueryCache();
3083
3084     if (!m_baseURL.isValid())
3085         m_baseURL = URL();
3086
3087     if (!equalIgnoringFragmentIdentifier(oldBaseURL, m_baseURL)) {
3088         // Base URL change changes any relative visited links.
3089         // FIXME: There are other URLs in the tree that would need to be re-evaluated on dynamic base URL change. Style should be invalidated too.
3090         for (auto& anchor : descendantsOfType<HTMLAnchorElement>(*this))
3091             anchor.invalidateCachedVisitedLinkHash();
3092     }
3093 }
3094
3095 void Document::setBaseURLOverride(const URL& url)
3096 {
3097     m_baseURLOverride = url;
3098     updateBaseURL();
3099 }
3100
3101 void Document::processBaseElement()
3102 {
3103     // Find the first href attribute in a base element and the first target attribute in a base element.
3104     const AtomicString* href = nullptr;
3105     const AtomicString* target = nullptr;
3106     auto baseDescendants = descendantsOfType<HTMLBaseElement>(*this);
3107     for (auto& base : baseDescendants) {
3108         if (!href) {
3109             const AtomicString& value = base.attributeWithoutSynchronization(hrefAttr);
3110             if (!value.isNull()) {
3111                 href = &value;
3112                 if (target)
3113                     break;
3114             }
3115         }
3116         if (!target) {
3117             const AtomicString& value = base.attributeWithoutSynchronization(targetAttr);
3118             if (!value.isNull()) {
3119                 target = &value;
3120                 if (href)
3121                     break;
3122             }
3123         }
3124     }
3125
3126     // FIXME: Since this doesn't share code with completeURL it may not handle encodings correctly.
3127     URL baseElementURL;
3128     if (href) {
3129         String strippedHref = stripLeadingAndTrailingHTMLSpaces(*href);
3130         if (!strippedHref.isEmpty())
3131             baseElementURL = URL(url(), strippedHref);
3132     }
3133     if (m_baseElementURL != baseElementURL && contentSecurityPolicy()->allowBaseURI(baseElementURL)) {
3134         m_baseElementURL = baseElementURL;
3135         updateBaseURL();
3136     }
3137
3138     m_baseTarget = target ? *target : nullAtom();
3139 }
3140
3141 String Document::userAgent(const URL& url) const
3142 {
3143     return frame() ? frame()->loader().userAgent(url) : String();
3144 }
3145
3146 void Document::disableEval(const String& errorMessage)
3147 {
3148     if (!frame())
3149         return;
3150
3151     frame()->script().disableEval(errorMessage);
3152 }
3153
3154 void Document::disableWebAssembly(const String& errorMessage)
3155 {
3156     if (!frame())
3157         return;
3158
3159     frame()->script().disableWebAssembly(errorMessage);
3160 }
3161
3162 #if ENABLE(INDEXED_DATABASE)
3163 IDBClient::IDBConnectionProxy* Document::idbConnectionProxy()
3164 {
3165     if (!m_idbConnectionProxy) {
3166         Page* currentPage = page();
3167         if (!currentPage)
3168             return nullptr;
3169         m_idbConnectionProxy = &currentPage->idbConnection().proxy();
3170     }
3171     return m_idbConnectionProxy.get();
3172 }
3173 #endif
3174
3175 SocketProvider* Document::socketProvider()
3176 {
3177     return m_socketProvider.get();
3178 }
3179     
3180 bool Document::canNavigate(Frame* targetFrame)
3181 {
3182     if (!m_frame)
3183         return false;
3184
3185     // FIXME: We shouldn't call this function without a target frame, but
3186     // fast/forms/submit-to-blank-multiple-times.html depends on this function
3187     // returning true when supplied with a 0 targetFrame.
3188     if (!targetFrame)
3189         return true;
3190
3191     if (m_frame != targetFrame) {
3192         auto sourceCrossOriginWindowPolicy = m_frame->window() ? m_frame->window()->crossOriginWindowPolicy() : CrossOriginWindowPolicy::Allow;
3193         auto destinationCrossOriginWindowPolicy = targetFrame->window() ? targetFrame->window()->crossOriginWindowPolicy() : CrossOriginWindowPolicy::Allow;
3194         if (sourceCrossOriginWindowPolicy != CrossOriginWindowPolicy::Allow || destinationCrossOriginWindowPolicy != CrossOriginWindowPolicy::Allow) {
3195             if (m_frame->document() && targetFrame->document() && !m_frame->document()->securityOrigin().canAccess(targetFrame->document()->securityOrigin())) {
3196                 printNavigationErrorMessage(targetFrame, url(), "Navigation was not allowed due to Cross-Origin-Window-Policy header."_s);
3197                 return false;
3198             }
3199         }
3200     }
3201
3202     // Cases (i), (ii) and (iii) pass the tests from the specifications but might not pass the "security origin" tests.
3203
3204     // i. A frame can navigate its top ancestor when its 'allow-top-navigation' flag is set (sometimes known as 'frame-busting').
3205     if (!isSandboxed(SandboxTopNavigation) && targetFrame == &m_frame->tree().top())
3206         return true;
3207
3208     // ii. A frame can navigate its top ancestor when its 'allow-top-navigation-by-user-activation' flag is set and navigation is triggered by user activation.
3209     if (!isSandboxed(SandboxTopNavigationByUserActivation) && UserGestureIndicator::processingUserGesture() && targetFrame == &m_frame->tree().top())
3210         return true;
3211
3212     // iii. A sandboxed frame can always navigate its descendants.
3213     if (isSandboxed(SandboxNavigation) && targetFrame->tree().isDescendantOf(m_frame))
3214         return true;
3215
3216     // From https://html.spec.whatwg.org/multipage/browsers.html#allowed-to-navigate.
3217     // 1. If A is not the same browsing context as B, and A is not one of the ancestor browsing contexts of B, and B is not a top-level browsing context, and A's active document's active sandboxing
3218     // flag set has its sandboxed navigation browsing context flag set, then abort these steps negatively.
3219     if (m_frame != targetFrame && isSandboxed(SandboxNavigation) && targetFrame->tree().parent() && !targetFrame->tree().isDescendantOf(m_frame)) {
3220         printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation is sandboxed, and is therefore disallowed from navigating its ancestors."_s);
3221         return false;
3222     }
3223
3224     // 2. Otherwise, if B is a top-level browsing context, and is one of the ancestor browsing contexts of A, then:
3225     if (m_frame != targetFrame && targetFrame == &m_frame->tree().top()) {
3226         bool triggeredByUserActivation = UserGestureIndicator::processingUserGesture();
3227         // 1. If this algorithm is triggered by user activation and A's active document's active sandboxing flag set has its sandboxed top-level navigation with user activation browsing context flag set, then abort these steps negatively.
3228         if (triggeredByUserActivation && isSandboxed(SandboxTopNavigationByUserActivation)) {
3229             printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation of the top-level window is sandboxed, but the 'allow-top-navigation-by-user-activation' flag is not set and navigation is not triggered by user activation."_s);
3230             return false;
3231         }
3232         // 2. Otherwise, If this algorithm is not triggered by user activation and A's active document's active sandboxing flag set has its sandboxed top-level navigation without user activation browsing context flag set, then abort these steps negatively.
3233         if (!triggeredByUserActivation && isSandboxed(SandboxTopNavigation)) {
3234             printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation of the top-level window is sandboxed, but the 'allow-top-navigation' flag is not set."_s);
3235             return false;
3236         }
3237     }
3238
3239     // 3. Otherwise, if B is a top-level browsing context, and is neither A nor one of the ancestor browsing contexts of A, and A's Document's active sandboxing flag set has its
3240     // sandboxed navigation browsing context flag set, and A is not the one permitted sandboxed navigator of B, then abort these steps negatively.
3241     if (!targetFrame->tree().parent() && m_frame != targetFrame && targetFrame != &m_frame->tree().top() && isSandboxed(SandboxNavigation) && targetFrame->loader().opener() != m_frame) {
3242         printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation is sandboxed, and is not allowed to navigate this popup."_s);
3243         return false;
3244     }
3245
3246     // 4. Otherwise, terminate positively!
3247
3248     // This is the normal case. A document can navigate its descendant frames,
3249     // or, more generally, a document can navigate a frame if the document is
3250     // in the same origin as any of that frame's ancestors (in the frame
3251     // hierarchy).
3252     //
3253     // See http://www.adambarth.com/papers/2008/barth-jackson-mitchell.pdf for
3254     // historical information about this security check.
3255     if (canAccessAncestor(securityOrigin(), targetFrame))
3256         return true;
3257
3258     // Top-level frames are easier to navigate than other frames because they
3259     // display their URLs in the address bar (in most browsers). However, there
3260     // are still some restrictions on navigation to avoid nuisance attacks.
3261     // Specifically, a document can navigate a top-level frame if that frame
3262     // opened the document or if the document is the same-origin with any of
3263     // the top-level frame's opener's ancestors (in the frame hierarchy).
3264     //
3265     // In both of these cases, the document performing the navigation is in
3266     // some way related to the frame being navigate (e.g., by the "opener"
3267     // and/or "parent" relation). Requiring some sort of relation prevents a
3268     // document from navigating arbitrary, unrelated top-level frames.
3269     if (!targetFrame->tree().parent()) {
3270         if (targetFrame == m_frame->loader().opener())
3271             return true;
3272
3273         if (canAccessAncestor(securityOrigin(), targetFrame->loader().opener()))
3274             return true;
3275     }
3276
3277     printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation is neither same-origin with the target, nor is it the target's parent or opener.");
3278     return false;
3279 }
3280
3281 void Document::didRemoveAllPendingStylesheet()
3282 {
3283     if (auto* parser = scriptableDocumentParser())
3284         parser->executeScriptsWaitingForStylesheetsSoon();
3285 }
3286
3287 bool Document::usesStyleBasedEditability() const
3288 {
3289     if (m_hasElementUsingStyleBasedEditability)
3290         return true;
3291
3292     ASSERT(!m_renderView || !m_renderView->frameView().isPainting());
3293     ASSERT(!m_inStyleRecalc);
3294
3295     auto& styleScope = const_cast<Style::Scope&>(this->styleScope());
3296     styleScope.flushPendingUpdate();
3297     return styleScope.usesStyleBasedEditability();
3298 }
3299
3300 void Document::setHasElementUsingStyleBasedEditability()
3301 {
3302     m_hasElementUsingStyleBasedEditability = true;
3303 }
3304
3305 void Document::processHttpEquiv(const String& equiv, const String& content, bool isInDocumentHead)
3306 {
3307     ASSERT(!equiv.isNull());
3308     ASSERT(!content.isNull());
3309
3310     HttpEquivPolicy policy = httpEquivPolicy();
3311     if (policy != HttpEquivPolicy::Enabled) {
3312         String reason;
3313         switch (policy) {
3314         case HttpEquivPolicy::Enabled:
3315             ASSERT_NOT_REACHED();
3316             break;
3317         case HttpEquivPolicy::DisabledBySettings:
3318             reason = "by the embedder.";
3319             break;
3320         case HttpEquivPolicy::DisabledByContentDispositionAttachmentSandbox:
3321             reason = "for documents with Content-Disposition: attachment.";
3322             break;
3323         }
3324         String message = "http-equiv '" + equiv + "' is disabled " + reason;
3325         addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
3326         return;
3327     }
3328
3329     Frame* frame = this->frame();
3330     auto* documentLoader = frame ? frame->loader().documentLoader() : nullptr;
3331     auto httpStatusCode = documentLoader ? documentLoader->response().httpStatusCode() : 0;
3332
3333     HTTPHeaderName headerName;
3334     if (!findHTTPHeaderName(equiv, headerName))
3335         return;
3336
3337     switch (headerName) {
3338     case HTTPHeaderName::DefaultStyle:
3339         // The preferred style set has been overridden as per section
3340         // 14.3.2 of the HTML4.0 specification.  We need to update the
3341         // sheet used variable and then update our style selector.
3342         // For more info, see the test at:
3343         // http://www.hixie.ch/tests/evil/css/import/main/preferred.html
3344         // -dwh
3345         styleScope().setPreferredStylesheetSetName(content);
3346         break;
3347
3348     case HTTPHeaderName::Refresh: {
3349         double delay;
3350         String urlString;
3351         if (frame && parseMetaHTTPEquivRefresh(content, delay, urlString)) {
3352             URL completedURL;
3353             if (urlString.isEmpty())
3354                 completedURL = m_url;
3355             else
3356                 completedURL = completeURL(urlString);
3357             if (!protocolIsJavaScript(completedURL))
3358                 frame->navigationScheduler().scheduleRedirect(*this, delay, completedURL);
3359             else {
3360                 String message = "Refused to refresh " + m_url.stringCenterEllipsizedToLength() + " to a javascript: URL";
3361                 addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
3362             }
3363         }
3364
3365         break;
3366     }
3367
3368     case HTTPHeaderName::SetCookie:
3369         // FIXME: make setCookie work on XML documents too; e.g. in case of <html:meta .....>
3370         if (is<HTMLDocument>(*this)) {
3371             // Exception (for sandboxed documents) ignored.
3372             downcast<HTMLDocument>(*this).setCookie(content);
3373         }
3374         break;
3375
3376     case HTTPHeaderName::ContentLanguage:
3377         setContentLanguage(content);
3378         break;
3379
3380     case HTTPHeaderName::XDNSPrefetchControl:
3381         parseDNSPrefetchControlHeader(content);
3382         break;
3383
3384     case HTTPHeaderName::XFrameOptions:
3385         if (frame) {
3386             FrameLoader& frameLoader = frame->loader();
3387             unsigned long requestIdentifier = 0;
3388             if (frameLoader.activeDocumentLoader() && frameLoader.activeDocumentLoader()->mainResourceLoader())
3389                 requestIdentifier = frameLoader.activeDocumentLoader()->mainResourceLoader()->identifier();
3390
3391             String message = "The X-Frame-Option '" + content + "' supplied in a <meta> element was ignored. X-Frame-Options may only be provided by an HTTP header sent with the document.";
3392             addConsoleMessage(MessageSource::Security, MessageLevel::Error, message, requestIdentifier);
3393         }
3394         break;
3395
3396     case HTTPHeaderName::ContentSecurityPolicy:
3397         if (isInDocumentHead)
3398             contentSecurityPolicy()->didReceiveHeader(content, ContentSecurityPolicyHeaderType::Enforce, ContentSecurityPolicy::PolicyFrom::HTTPEquivMeta, referrer(), httpStatusCode);
3399         break;
3400
3401     case HTTPHeaderName::XWebKitCSP:
3402         if (isInDocumentHead)
3403             contentSecurityPolicy()->didReceiveHeader(content, ContentSecurityPolicyHeaderType::PrefixedEnforce, ContentSecurityPolicy::PolicyFrom::HTTPEquivMeta, referrer(), httpStatusCode);
3404         break;
3405
3406     default:
3407         break;
3408     }
3409 }
3410
3411 void Document::processDisabledAdaptations(const String& disabledAdaptationsString)
3412 {
3413     auto disabledAdaptations = parseDisabledAdaptations(disabledAdaptationsString);
3414     if (m_disabledAdaptations == disabledAdaptations)
3415         return;
3416
3417     m_disabledAdaptations = disabledAdaptations;
3418     dispatchDisabledAdaptationsDidChangeForMainFrame();
3419 }
3420
3421 void Document::dispatchDisabledAdaptationsDidChangeForMainFrame()
3422 {
3423     if (!frame()->isMainFrame())
3424         return;
3425
3426     if (!page())
3427         return;
3428
3429     page()->chrome().dispatchDisabledAdaptationsDidChange(m_disabledAdaptations);
3430 }
3431
3432 void Document::setOverrideViewportArguments(const std::optional<ViewportArguments>& viewportArguments)
3433 {
3434     if (viewportArguments == m_overrideViewportArguments)
3435         return;
3436
3437     m_overrideViewportArguments = viewportArguments;
3438     updateViewportArguments();
3439 }
3440
3441 void Document::processViewport(const String& features, ViewportArguments::Type origin)
3442 {
3443     ASSERT(!features.isNull());
3444
3445     LOG_WITH_STREAM(Viewports, stream << "Document::processViewport " << features);
3446
3447     if (origin < m_viewportArguments.type)
3448         return;
3449
3450     m_viewportArguments = ViewportArguments(origin);
3451
3452     LOG_WITH_STREAM(Viewports, stream  << " resolved to " << m_viewportArguments);
3453
3454     processFeaturesString(features, FeatureMode::Viewport, [this](StringView key, StringView value) {
3455         setViewportFeature(m_viewportArguments, *this, key, value);
3456     });
3457
3458     updateViewportArguments();
3459 }
3460
3461 void Document::updateViewportArguments()
3462 {
3463     if (page() && frame()->isMainFrame()) {
3464 #ifndef NDEBUG
3465         m_didDispatchViewportPropertiesChanged = true;
3466 #endif
3467         page()->chrome().dispatchViewportPropertiesDidChange(m_overrideViewportArguments ? m_overrideViewportArguments.value() : m_viewportArguments);
3468         page()->chrome().didReceiveDocType(*frame());
3469     }
3470 }
3471
3472 #if PLATFORM(IOS)
3473
3474 void Document::processFormatDetection(const String& features)
3475 {
3476     // FIXME: Find a better place for this function.
3477     processFeaturesString(features, FeatureMode::Viewport, [this](StringView key, StringView value) {
3478         if (equalLettersIgnoringASCIICase(key, "telephone") && equalLettersIgnoringASCIICase(value, "no"))
3479             setIsTelephoneNumberParsingAllowed(false);
3480     });
3481 }
3482
3483 void Document::processWebAppOrientations()
3484 {
3485     if (Page* page = this->page())
3486         page->chrome().client().webAppOrientationsUpdated();
3487 }
3488
3489 #endif
3490
3491 void Document::processReferrerPolicy(const String& policy, ReferrerPolicySource source)
3492 {
3493     ASSERT(!policy.isNull());
3494
3495     // Documents in a Content-Disposition: attachment sandbox should never send a Referer header,
3496     // even if the document has a meta tag saying otherwise.
3497     if (shouldEnforceContentDispositionAttachmentSandbox())
3498         return;
3499
3500 #if USE(QUICK_LOOK)
3501     if (shouldEnforceQuickLookSandbox())
3502         return;
3503 #endif
3504     
3505     auto referrerPolicy = parseReferrerPolicy(policy, source);
3506     if (!referrerPolicy) {
3507         // Unknown policy values are ignored (https://w3c.github.io/webappsec-referrer-policy/#unknown-policy-values).
3508         addConsoleMessage(MessageSource::Rendering, MessageLevel::Error, "Failed to set referrer policy: The value '" + policy + "' is not one of 'no-referrer', 'no-referrer-when-downgrade', 'same-origin', 'origin', 'strict-origin', 'origin-when-cross-origin', 'strict-origin-when-cross-origin' or 'unsafe-url'.");
3509         return;
3510     }
3511     setReferrerPolicy(referrerPolicy.value());
3512 }
3513
3514 MouseEventWithHitTestResults Document::prepareMouseEvent(const HitTestRequest& request, const LayoutPoint& documentPoint, const PlatformMouseEvent& event)
3515 {
3516     if (!hasLivingRenderTree())
3517         return MouseEventWithHitTestResults(event, HitTestResult(LayoutPoint()));
3518
3519     HitTestResult result(documentPoint);
3520     renderView()->hitTest(request, result);
3521
3522     if (!request.readOnly())
3523         updateHoverActiveState(request, result.targetElement());
3524
3525     return MouseEventWithHitTestResults(event, result);
3526 }
3527
3528 // DOM Section 1.1.1
3529 bool Document::childTypeAllowed(NodeType type) const
3530 {
3531     switch (type) {
3532     case ATTRIBUTE_NODE:
3533     case CDATA_SECTION_NODE:
3534     case DOCUMENT_FRAGMENT_NODE:
3535     case DOCUMENT_NODE:
3536     case TEXT_NODE:
3537         return false;
3538     case COMMENT_NODE:
3539     case PROCESSING_INSTRUCTION_NODE:
3540         return true;
3541     case DOCUMENT_TYPE_NODE:
3542     case ELEMENT_NODE:
3543         // Documents may contain no more than one of each of these.
3544         // (One Element and one DocumentType.)
3545         for (Node* c = firstChild(); c; c = c->nextSibling())
3546             if (c->nodeType() == type)
3547                 return false;
3548         return true;
3549     }
3550     return false;
3551 }
3552
3553 bool Document::canAcceptChild(const Node& newChild, const Node* refChild, AcceptChildOperation operation) const
3554 {
3555     if (operation == AcceptChildOperation::Replace && refChild->nodeType() == newChild.nodeType())
3556         return true;
3557
3558     switch (newChild.nodeType()) {
3559     case ATTRIBUTE_NODE:
3560     case CDATA_SECTION_NODE:
3561     case DOCUMENT_NODE:
3562     case TEXT_NODE:
3563         return false;
3564     case COMMENT_NODE:
3565     case PROCESSING_INSTRUCTION_NODE:
3566         return true;
3567     case DOCUMENT_FRAGMENT_NODE: {
3568         bool hasSeenElementChild = false;
3569         for (auto* node = downcast<DocumentFragment>(newChild).firstChild(); node; node = node->nextSibling()) {
3570             if (is<Element>(*node)) {
3571                 if (hasSeenElementChild)
3572                     return false;
3573                 hasSeenElementChild = true;
3574             }
3575             if (!canAcceptChild(*node, refChild, operation))
3576                 return false;
3577         }
3578         break;
3579     }
3580     case DOCUMENT_TYPE_NODE: {
3581         auto* existingDocType = childrenOfType<DocumentType>(*this).first();
3582         if (operation == AcceptChildOperation::Replace) {
3583             //  parent has a doctype child that is not child, or an element is preceding child.
3584             if (existingDocType && existingDocType != refChild)
3585                 return false;
3586             if (refChild->previousElementSibling())
3587                 return false;
3588         } else {
3589             ASSERT(operation == AcceptChildOperation::InsertOrAdd);
3590             if (existingDocType)
3591                 return false;
3592             if ((refChild && refChild->previousElementSibling()) || (!refChild && firstElementChild()))
3593                 return false;
3594         }
3595         break;
3596     }
3597     case ELEMENT_NODE: {
3598         auto* existingElementChild = firstElementChild();
3599         if (operation == AcceptChildOperation::Replace) {
3600             if (existingElementChild && existingElementChild != refChild)
3601                 return false;
3602             for (auto* child = refChild->nextSibling(); child; child = child->nextSibling()) {
3603                 if (is<DocumentType>(*child))
3604                     return false;
3605             }
3606         } else {
3607             ASSERT(operation == AcceptChildOperation::InsertOrAdd);
3608             if (existingElementChild)
3609                 return false;
3610             for (auto* child = refChild; child; child = child->nextSibling()) {
3611                 if (is<DocumentType>(*child))
3612                     return false;
3613             }
3614         }
3615         break;
3616     }
3617     }
3618     return true;
3619 }
3620
3621 Ref<Node> Document::cloneNodeInternal(Document&, CloningOperation type)
3622 {
3623     Ref<Document> clone = cloneDocumentWithoutChildren();
3624     clone->cloneDataFromDocument(*this);
3625     switch (type) {
3626     case CloningOperation::OnlySelf:
3627     case CloningOperation::SelfWithTemplateContent:
3628         break;