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