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