Replace history.options with history.scrollRestoration attribute

Source/core/frame/History.cpp

 /*
  * Copyright (C) 2007 Apple Inc.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 12 matching lines @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "core/frame/History.h"
 
 #include "bindings/core/v8/ExceptionState.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/frame/LocalFrame.h"
-#include "core/frame/StateOptions.h"
 #include "core/loader/DocumentLoader.h"
 #include "core/loader/FrameLoader.h"
 #include "core/loader/FrameLoaderClient.h"
 #include "core/loader/HistoryItem.h"
 #include "core/page/Page.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/weborigin/KURL.h"
 #include "platform/weborigin/SecurityOrigin.h"
 #include "wtf/MainThread.h"
 
@@ skipping 27 matching lines @@
 {
     if (!m_frame)
         return 0;
 
     if (HistoryItem* historyItem = m_frame->loader().currentItem())
         return historyItem->stateObject();
 
     return 0;
 }
 
-void History::options(StateOptions& options)
+void History::setScrollRestoration(const String& value)
 {
-    if (!m_frame)
+    if (!m_frame || !m_frame->page() || !m_frame->loader().documentLoader() || !RuntimeEnabledFeatures::scrollRestorationEnabled())
         return;
 
-    if (HistoryItem* historyItem = m_frame->loader().currentItem()) {
-        options.setScrollRestoration(historyItem->scrollRestorationType() == ScrollRestorationManual ? "manual" : "auto");
+    HistoryScrollRestorationType scrollRestoration = value == "manual" ? ScrollRestorationManual : ScrollRestorationAuto;

[Nate Chapin, 2015/07/16 21:34:01]

My knowledge of the v8 bindings is outdated. Are we guaranteed to get either
"manual" or "auto" here? Should we ASSERT that?

[majidvp, 2015/07/16 22:11:49]

Yes V8 bindings validates that only valid values are allowed here. I will add an
assert as well.

See for example:
https://code.google.com/p/chromium/codesearch#chromium/src/out/Debug/gen/blin...

+    if (scrollRestoration == scrollRestorationInternal())
+        return;
+    // Equivalent to calling replace on the same entry but with new scroll restoration option
+    m_frame->loader().updateForSameDocumentNavigation(m_frame->loader().currentItem()->url(), SameDocumentNavigationHistoryApi, stateInternal(), scrollRestoration, FrameLoadTypeReplaceCurrentItem);

[Nate Chapin, 2015/07/16 21:34:01]

Why is this modeled as a navigation?

[majidvp, 2015/07/16 22:11:49]

Hmm, perhaps it can be made simpler. I think all it needs to do is to update the
current state and notify |FrameLoaderClient| that it has done do. wdyt?

[Nate Chapin, 2015/07/16 22:19:32]

It may not even need to notify FrameLoaderClient. content/renderer holds a
reference to the current HistoryItem (via WebHistoryItem), so I think it should
be updated automatically.

+}
+
+String History::scrollRestoration()
+{
+    return scrollRestorationInternal() == ScrollRestorationManual ? "manual" : "auto";
+}
+
+HistoryScrollRestorationType History::scrollRestorationInternal() const
+{
+    if (m_frame && RuntimeEnabledFeatures::scrollRestorationEnabled()) {
+        if (HistoryItem* historyItem = m_frame->loader().currentItem())
+            return historyItem->scrollRestorationType();
     }
+
+    return ScrollRestorationAuto;
 }
 
 bool History::stateChanged() const
 {
     return m_lastStateObjectRequested != stateInternal();
 }
 
 bool History::isSameAsCurrentState(SerializedScriptValue* state) const
 {
     return state == stateInternal();
@@ skipping 33 matching lines @@
     Document* document = m_frame->document();
 
     if (urlString.isNull())
         return document->url();
     if (urlString.isEmpty())
         return document->baseURL();
 
     return KURL(document->baseURL(), urlString);
 }
 
-void History::stateObjectAdded(PassRefPtr<SerializedScriptValue> data, const String& /* title */, const String& urlString, const StateOptions& options, FrameLoadType type, ExceptionState& exceptionState)
+void History::stateObjectAdded(PassRefPtr<SerializedScriptValue> data, const String& /* title */, const String& urlString, HistoryScrollRestorationType restorationType, FrameLoadType type, ExceptionState& exceptionState)
 {
     if (!m_frame || !m_frame->page() || !m_frame->loader().documentLoader())
         return;
 
     KURL fullURL = urlForState(urlString);
     if (!fullURL.isValid() || !m_frame->document()->securityOrigin()->canRequest(fullURL)) {
         // We can safely expose the URL to JavaScript, as a) no redirection takes place: JavaScript already had this URL, b) JavaScript can only access a same-origin History object.
         exceptionState.throwSecurityError("A history state object with URL '" + fullURL.elidedString() + "' cannot be created in a document with origin '" + m_frame->document()->securityOrigin()->toString() + "'.");
         return;
     }
 
-    HistoryScrollRestorationType restorationType = ScrollRestorationAuto;
-    if (RuntimeEnabledFeatures::scrollRestorationEnabled() && options.scrollRestoration() == "manual")
-        restorationType = ScrollRestorationManual;
-
     m_frame->loader().updateForSameDocumentNavigation(fullURL, SameDocumentNavigationHistoryApi, data, restorationType, type);
 }
 
 } // namespace blink