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