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