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