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