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