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