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