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