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