Make it possible to test rubber-banding in overflow scroll
[WebKit-https.git] / Source / WebCore / html / HTMLBodyElement.cpp
index a769a2c..db8f328 100644 (file)
@@ -3,7 +3,7 @@
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2000 Simon Hausmann (hausmann@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
- * Copyright (C) 2004, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
+ * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
 #include "config.h"
 #include "HTMLBodyElement.h"
 
-#include "Attribute.h"
+#include "CSSImageValue.h"
 #include "CSSParser.h"
 #include "CSSValueKeywords.h"
+#include "DOMWindow.h"
+#include "DOMWrapperWorld.h"
 #include "EventNames.h"
 #include "Frame.h"
 #include "FrameView.h"
-#include "HTMLFrameElementBase.h"
+#include "HTMLFrameElement.h"
+#include "HTMLIFrameElement.h"
 #include "HTMLNames.h"
 #include "HTMLParserIdioms.h"
-#include "Page.h"
-#include "ScriptEventListener.h"
+#include "StyleProperties.h"
+#include <wtf/NeverDestroyed.h>
 
 namespace WebCore {
 
 using namespace HTMLNames;
 
-HTMLBodyElement::HTMLBodyElement(const QualifiedName& tagName, Document* document)
+HTMLBodyElement::HTMLBodyElement(const QualifiedName& tagName, Document& document)
     : HTMLElement(tagName, document)
 {
     ASSERT(hasTagName(bodyTag));
 }
 
-PassRefPtr<HTMLBodyElement> HTMLBodyElement::create(Document* document)
+bool HTMLBodyElement::isFirstBodyElementOfDocument() const
 {
-    return adoptRef(new HTMLBodyElement(bodyTag, document));
+    // By spec http://dev.w3.org/csswg/cssom-view/#the-html-body-element
+    // "The HTML body element is the first body HTML element child of the root HTML element html."
+    return document().body() == this;
 }
 
-PassRefPtr<HTMLBodyElement> HTMLBodyElement::create(const QualifiedName& tagName, Document* document)
+Ref<HTMLBodyElement> HTMLBodyElement::create(Document& document)
 {
-    return adoptRef(new HTMLBodyElement(tagName, document));
+    return adoptRef(*new HTMLBodyElement(bodyTag, document));
 }
 
-HTMLBodyElement::~HTMLBodyElement()
+Ref<HTMLBodyElement> HTMLBodyElement::create(const QualifiedName& tagName, Document& document)
 {
+    return adoptRef(*new HTMLBodyElement(tagName, document));
 }
 
-void HTMLBodyElement::parseAttribute(Attribute* attr)
-{
-    if (attr->name() == backgroundAttr) {
-        String url = stripLeadingAndTrailingHTMLSpaces(attr->value());
-        if (!url.isEmpty())
-            addCSSImageProperty(CSSPropertyBackgroundImage, document()->completeURL(url).string());
-        else
-            removeCSSProperty(CSSPropertyBackgroundImage);
-    } else if (attr->name() == marginwidthAttr || attr->name() == leftmarginAttr) {
-        if (attr->value().isNull())
-            removeCSSProperties(CSSPropertyMarginRight, CSSPropertyMarginLeft);
-        else {
-            addCSSLength(CSSPropertyMarginRight, attr->value());
-            addCSSLength(CSSPropertyMarginLeft, attr->value());
-        }
-    } else if (attr->name() == marginheightAttr || attr->name() == topmarginAttr) {
-        if (attr->value().isNull())
-            removeCSSProperties(CSSPropertyMarginBottom, CSSPropertyMarginTop);
-        else {
-            addCSSLength(CSSPropertyMarginBottom, attr->value());
-            addCSSLength(CSSPropertyMarginTop, attr->value());
-        }
-    } else if (attr->name() == bgcolorAttr) {
-        if (attr->value().isNull())
-            removeCSSProperty(CSSPropertyBackgroundColor);
-        else
-            addCSSColor(CSSPropertyBackgroundColor, attr->value());
-    } else if (attr->name() == textAttr) {
-        if (attr->value().isNull())
-            removeCSSProperty(CSSPropertyColor);
-        else
-            addCSSColor(CSSPropertyColor, attr->value());
-    } else if (attr->name() == bgpropertiesAttr) {
-        if (equalIgnoringCase(attr->value(), "fixed"))
-            addCSSProperty(CSSPropertyBackgroundAttachment, CSSValueFixed);
-        else
-            removeCSSProperty(CSSPropertyBackgroundAttachment);
-    } else if (attr->name() == vlinkAttr ||
-               attr->name() == alinkAttr ||
-               attr->name() == linkAttr) {
-        if (attr->isNull()) {
-            if (attr->name() == linkAttr)
-                document()->resetLinkColor();
-            else if (attr->name() == vlinkAttr)
-                document()->resetVisitedLinkColor();
-            else
-                document()->resetActiveLinkColor();
-        } else {
-            RGBA32 color;
-            if (CSSParser::parseColor(color, attr->value(), !document()->inQuirksMode())) {
-                if (attr->name() == linkAttr)
-                    document()->setLinkColor(color);
-                else if (attr->name() == vlinkAttr)
-                    document()->setVisitedLinkColor(color);
-                else
-                    document()->setActiveLinkColor(color);
-            }
-        }
-        
-        if (attached())
-            document()->recalcStyle(Force);
-    } else if (attr->name() == onloadAttr)
-        document()->setWindowAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onbeforeunloadAttr)
-        document()->setWindowAttributeEventListener(eventNames().beforeunloadEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onunloadAttr)
-        document()->setWindowAttributeEventListener(eventNames().unloadEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onpagehideAttr)
-        document()->setWindowAttributeEventListener(eventNames().pagehideEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onpageshowAttr)
-        document()->setWindowAttributeEventListener(eventNames().pageshowEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onpopstateAttr)
-        document()->setWindowAttributeEventListener(eventNames().popstateEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onblurAttr)
-        document()->setWindowAttributeEventListener(eventNames().blurEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onfocusAttr)
-        document()->setWindowAttributeEventListener(eventNames().focusEvent, createAttributeEventListener(document()->frame(), attr));
-#if ENABLE(ORIENTATION_EVENTS)
-    else if (attr->name() == onorientationchangeAttr)
-        document()->setWindowAttributeEventListener(eventNames().orientationchangeEvent, createAttributeEventListener(document()->frame(), attr));
-#endif
-    else if (attr->name() == onhashchangeAttr)
-        document()->setWindowAttributeEventListener(eventNames().hashchangeEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onresizeAttr)
-        document()->setWindowAttributeEventListener(eventNames().resizeEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onscrollAttr)
-        document()->setWindowAttributeEventListener(eventNames().scrollEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onselectionchangeAttr)
-        document()->setAttributeEventListener(eventNames().selectionchangeEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onstorageAttr)
-        document()->setWindowAttributeEventListener(eventNames().storageEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == ononlineAttr)
-        document()->setWindowAttributeEventListener(eventNames().onlineEvent, createAttributeEventListener(document()->frame(), attr));
-    else if (attr->name() == onofflineAttr)
-        document()->setWindowAttributeEventListener(eventNames().offlineEvent, createAttributeEventListener(document()->frame(), attr));
-    else
-        HTMLElement::parseAttribute(attr);
-}
+HTMLBodyElement::~HTMLBodyElement() = default;
 
-void HTMLBodyElement::insertedIntoDocument()
+bool HTMLBodyElement::isPresentationAttribute(const QualifiedName& name) const
 {
-    HTMLElement::insertedIntoDocument();
-
-    ASSERT(document());
-
-    // FIXME: Perhaps this code should be in attach() instead of here.
-    Element* ownerElement = document()->ownerElement();
-    if (ownerElement && (ownerElement->hasTagName(frameTag) || ownerElement->hasTagName(iframeTag))) {
-        HTMLFrameElementBase* ownerFrameElement = static_cast<HTMLFrameElementBase*>(ownerElement);
-        int marginWidth = ownerFrameElement->marginWidth();
-        if (marginWidth != -1)
-            setAttribute(marginwidthAttr, String::number(marginWidth));
-        int marginHeight = ownerFrameElement->marginHeight();
-        if (marginHeight != -1)
-            setAttribute(marginheightAttr, String::number(marginHeight));
-    }
-
-    // FIXME: This call to scheduleRelayout should not be needed here.
-    // But without it we hang during WebKit tests; need to fix that and remove this.
-    if (FrameView* view = document()->view())
-        view->scheduleRelayout();
-
-    document()->updateViewportArguments();
+    if (name == backgroundAttr || name == marginwidthAttr || name == leftmarginAttr || name == marginheightAttr || name == topmarginAttr || name == bgcolorAttr || name == textAttr || name == bgpropertiesAttr)
+        return true;
+    return HTMLElement::isPresentationAttribute(name);
 }
 
-bool HTMLBodyElement::isURLAttribute(Attribute *attr) const
+void HTMLBodyElement::collectStyleForPresentationAttribute(const QualifiedName& name, const AtomicString& value, MutableStyleProperties& style)
 {
-    return attr->name() == backgroundAttr || HTMLElement::isURLAttribute(attr);
+    if (name == backgroundAttr) {
+        String url = stripLeadingAndTrailingHTMLSpaces(value);
+        if (!url.isEmpty()) {
+            auto imageValue = CSSImageValue::create(document().completeURL(url));
+            imageValue.get().setInitiator(localName());
+            style.setProperty(CSSProperty(CSSPropertyBackgroundImage, WTFMove(imageValue)));
+        }
+    } else if (name == marginwidthAttr || name == leftmarginAttr) {
+        addHTMLLengthToStyle(style, CSSPropertyMarginRight, value);
+        addHTMLLengthToStyle(style, CSSPropertyMarginLeft, value);
+    } else if (name == marginheightAttr || name == topmarginAttr) {
+        addHTMLLengthToStyle(style, CSSPropertyMarginBottom, value);
+        addHTMLLengthToStyle(style, CSSPropertyMarginTop, value);
+    } else if (name == bgcolorAttr) {
+        addHTMLColorToStyle(style, CSSPropertyBackgroundColor, value);
+    } else if (name == textAttr) {
+        addHTMLColorToStyle(style, CSSPropertyColor, value);
+    } else if (name == bgpropertiesAttr) {
+        if (equalLettersIgnoringASCIICase(value, "fixed"))
+           addPropertyToPresentationAttributeStyle(style, CSSPropertyBackgroundAttachment, CSSValueFixed);
+    } else
+        HTMLElement::collectStyleForPresentationAttribute(name, value, style);
 }
 
-bool HTMLBodyElement::supportsFocus() const
+HTMLElement::EventHandlerNameMap HTMLBodyElement::createWindowEventHandlerNameMap()
 {
-    return rendererIsEditable() || HTMLElement::supportsFocus();
+    static const QualifiedName* const table[] = {
+        &onbeforeunloadAttr.get(),
+        &onblurAttr.get(),
+        &onerrorAttr.get(),
+        &onfocusAttr.get(),
+        &onfocusinAttr.get(),
+        &onfocusoutAttr.get(),
+        &onhashchangeAttr.get(),
+        &onlanguagechangeAttr.get(),
+        &onloadAttr.get(),
+        &onmessageAttr.get(),
+        &onofflineAttr.get(),
+        &ononlineAttr.get(),
+        &onorientationchangeAttr.get(),
+        &onpagehideAttr.get(),
+        &onpageshowAttr.get(),
+        &onpopstateAttr.get(),
+        &onresizeAttr.get(),
+        &onscrollAttr.get(),
+        &onstorageAttr.get(),
+        &onunloadAttr.get(),
+        &onwebkitmouseforcechangedAttr.get(),
+        &onwebkitmouseforcedownAttr.get(),
+        &onwebkitmouseforceupAttr.get(),
+        &onwebkitmouseforcewillbeginAttr.get(),
+        &onwebkitwillrevealbottomAttr.get(),
+        &onwebkitwillrevealleftAttr.get(),
+        &onwebkitwillrevealrightAttr.get(),
+        &onwebkitwillrevealtopAttr.get(),
+    };
+
+    EventHandlerNameMap map;
+    populateEventHandlerNameMap(map, table);
+    return map;
 }
 
-String HTMLBodyElement::aLink() const
+const AtomicString& HTMLBodyElement::eventNameForWindowEventHandlerAttribute(const QualifiedName& attributeName)
 {
-    return getAttribute(alinkAttr);
+    static NeverDestroyed<EventHandlerNameMap> map = createWindowEventHandlerNameMap();
+    return eventNameForEventHandlerAttribute(attributeName, map.get());
 }
 
-void HTMLBodyElement::setALink(const String& value)
+void HTMLBodyElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
 {
-    setAttribute(alinkAttr, value);
-}
+    if (name == vlinkAttr || name == alinkAttr || name == linkAttr) {
+        if (value.isNull()) {
+            if (name == linkAttr)
+                document().resetLinkColor();
+            else if (name == vlinkAttr)
+                document().resetVisitedLinkColor();
+            else
+                document().resetActiveLinkColor();
+        } else {
+            Color color = CSSParser::parseColor(value, !document().inQuirksMode());
+            if (color.isValid()) {
+                if (name == linkAttr)
+                    document().setLinkColor(color);
+                else if (name == vlinkAttr)
+                    document().setVisitedLinkColor(color);
+                else
+                    document().setActiveLinkColor(color);
+            }
+        }
 
-String HTMLBodyElement::bgColor() const
-{
-    return getAttribute(bgcolorAttr);
-}
+        invalidateStyleForSubtree();
+        return;
+    }
 
-void HTMLBodyElement::setBgColor(const String& value)
-{
-    setAttribute(bgcolorAttr, value);
-}
+    if (name == onselectionchangeAttr) {
+        document().setAttributeEventListener(eventNames().selectionchangeEvent, name, value, mainThreadNormalWorld());
+        return;
+    }
 
-String HTMLBodyElement::link() const
-{
-    return getAttribute(linkAttr);
-}
+    auto& eventName = eventNameForWindowEventHandlerAttribute(name);
+    if (!eventName.isNull()) {
+        document().setWindowAttributeEventListener(eventName, name, value, mainThreadNormalWorld());
+        return;
+    }
 
-void HTMLBodyElement::setLink(const String& value)
-{
-    setAttribute(linkAttr, value);
+    HTMLElement::parseAttribute(name, value);
 }
 
-String HTMLBodyElement::text() const
+Node::InsertedIntoAncestorResult HTMLBodyElement::insertedIntoAncestor(InsertionType insertionType, ContainerNode& parentOfInsertedTree)
 {
-    return getAttribute(textAttr);
+    HTMLElement::insertedIntoAncestor(insertionType, parentOfInsertedTree);
+    if (!insertionType.connectedToDocument)
+        return InsertedIntoAncestorResult::Done;
+
+    // FIXME: It's surprising this is web compatible since it means a marginwidth and marginheight attribute can
+    // magically appear on the <body> of all documents embedded through <iframe> or <frame>.
+    // FIXME: Perhaps this code should be in attach() instead of here.
+    auto* ownerElement = document().ownerElement();
+    if (!is<HTMLFrameElementBase>(ownerElement))
+        return InsertedIntoAncestorResult::Done;
+
+    return InsertedIntoAncestorResult::NeedsPostInsertionCallback;
 }
 
-void HTMLBodyElement::setText(const String& value)
+void HTMLBodyElement::didFinishInsertingNode()
 {
-    setAttribute(textAttr, value);
+    auto* ownerElement = document().ownerElement();
+    RELEASE_ASSERT(is<HTMLFrameElementBase>(ownerElement));
+    auto& ownerFrameElement = downcast<HTMLFrameElementBase>(*ownerElement);
+
+    // Read values from the owner before setting any attributes, since setting an attribute can run arbitrary
+    // JavaScript, which might delete the owner element.
+    int marginWidth = ownerFrameElement.marginWidth();
+    int marginHeight = ownerFrameElement.marginHeight();
+
+    if (marginWidth != -1)
+        setIntegralAttribute(marginwidthAttr, marginWidth);
+    if (marginHeight != -1)
+        setIntegralAttribute(marginheightAttr, marginHeight);
 }
 
-String HTMLBodyElement::vLink() const
+bool HTMLBodyElement::isURLAttribute(const Attribute& attribute) const
 {
-    return getAttribute(vlinkAttr);
+    return attribute.name() == backgroundAttr || HTMLElement::isURLAttribute(attribute);
 }
 
-void HTMLBodyElement::setVLink(const String& value)
+bool HTMLBodyElement::supportsFocus() const
 {
-    setAttribute(vlinkAttr, value);
+    return hasEditableStyle() || HTMLElement::supportsFocus();
 }
 
-static int adjustForZoom(int value, Document* document)
+static int adjustForZoom(int value, const Frame& frame)
 {
-    Frame* frame = document->frame();
-    float zoomFactor = frame->pageZoomFactor() * frame->frameScaleFactor();
+    double zoomFactor = frame.pageZoomFactor() * frame.frameScaleFactor();
     if (zoomFactor == 1)
         return value;
     // Needed because of truncation (rather than rounding) when scaling up.
@@ -259,71 +241,118 @@ static int adjustForZoom(int value, Document* document)
 
 int HTMLBodyElement::scrollLeft()
 {
-    // Update the document's layout.
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    FrameView* view = document->view();
-    return view ? adjustForZoom(view->scrollX(), document) : 0;
+    if (isFirstBodyElementOfDocument()) {
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return 0;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return 0;
+        return adjustForZoom(view->contentsScrollPosition().x(), *frame);
+    }
+    return HTMLElement::scrollLeft();
 }
 
 void HTMLBodyElement::setScrollLeft(int scrollLeft)
 {
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    Frame* frame = document->frame();
-    if (!frame)
-        return;
-    FrameView* view = frame->view();
-    if (!view)
-        return;
-    view->setScrollPosition(IntPoint(static_cast<int>(scrollLeft * frame->pageZoomFactor() * frame->frameScaleFactor()), view->scrollY()));
+    if (isFirstBodyElementOfDocument()) {
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return;
+        view->setScrollPosition(IntPoint(static_cast<int>(scrollLeft * frame->pageZoomFactor() * frame->frameScaleFactor()), view->scrollY()));
+    }
+    HTMLElement::setScrollLeft(scrollLeft);
 }
 
 int HTMLBodyElement::scrollTop()
 {
-    // Update the document's layout.
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    FrameView* view = document->view();
-    return view ? adjustForZoom(view->scrollY(), document) : 0;
+    if (isFirstBodyElementOfDocument()) {
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return 0;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return 0;
+        return adjustForZoom(view->contentsScrollPosition().y(), *frame);
+    }
+    return HTMLElement::scrollTop();
 }
 
 void HTMLBodyElement::setScrollTop(int scrollTop)
 {
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    Frame* frame = document->frame();
-    if (!frame)
-        return;
-    FrameView* view = frame->view();
-    if (!view)
+    if (isFirstBodyElementOfDocument()) {
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return;
+        view->setScrollPosition(IntPoint(view->scrollX(), static_cast<int>(scrollTop * frame->pageZoomFactor() * frame->frameScaleFactor())));
+    }
+    return HTMLElement::setScrollTop(scrollTop);
+}
+
+void HTMLBodyElement::scrollTo(const ScrollToOptions& options, ScrollClamping clamping)
+{
+    if (isFirstBodyElementOfDocument()) {
+        // If the element is the HTML body element, document is in quirks mode, and the element is not potentially scrollable,
+        // invoke scroll() on window with options as the only argument, and terminate these steps.
+        // Note that WebKit always uses quirks mode document scrolling behavior. See Document::scrollingElement().
+        // FIXME: Scrolling an independently scrollable body is broken: webkit.org/b/161612.
+        auto* window = document().domWindow();
+        if (!window)
+            return;
+
+        window->scrollTo(options);
         return;
-    view->setScrollPosition(IntPoint(view->scrollX(), static_cast<int>(scrollTop * frame->pageZoomFactor() * frame->frameScaleFactor())));
+    }
+    return HTMLElement::scrollTo(options, clamping);
 }
 
 int HTMLBodyElement::scrollHeight()
 {
-    // Update the document's layout.
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    FrameView* view = document->view();
-    return view ? adjustForZoom(view->contentsHeight(), document) : 0;    
+    if (isFirstBodyElementOfDocument()) {
+        // Update the document's layout.
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return 0;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return 0;
+        return adjustForZoom(view->contentsHeight(), *frame);
+    }
+    return HTMLElement::scrollHeight();
 }
 
 int HTMLBodyElement::scrollWidth()
 {
-    // Update the document's layout.
-    Document* document = this->document();
-    document->updateLayoutIgnorePendingStylesheets();
-    FrameView* view = document->view();
-    return view ? adjustForZoom(view->contentsWidth(), document) : 0;    
+    if (isFirstBodyElementOfDocument()) {
+        // Update the document's layout.
+        document().updateLayoutIgnorePendingStylesheets();
+        RefPtr<Frame> frame = document().frame();
+        if (!frame)
+            return 0;
+        RefPtr<FrameView> view = frame->view();
+        if (!view)
+            return 0;
+        return adjustForZoom(view->contentsWidth(), *frame);
+    }
+    return HTMLElement::scrollWidth();
 }
 
-void HTMLBodyElement::addSubresourceAttributeURLs(ListHashSet<KURL>& urls) const
+void HTMLBodyElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
 {
     HTMLElement::addSubresourceAttributeURLs(urls);
 
-    addSubresourceURL(urls, document()->completeURL(getAttribute(backgroundAttr)));
+    addSubresourceURL(urls, document().completeURL(attributeWithoutSynchronization(backgroundAttr)));
 }
 
 } // namespace WebCore