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