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