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