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