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