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