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