Accept options in history APIs to allow scroll restoration to be disabled

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"
 
 namespace blink {
 
 History::History(LocalFrame* frame)
     : DOMWindowProperty(frame)
     , m_lastStateObjectRequested(nullptr)
 {
@@ skipping 21 matching lines @@
 {
     if (!m_frame)
         return 0;
 
     if (HistoryItem* historyItem = m_frame->loader().currentItem())
         return historyItem->stateObject();
 
     return 0;
 }
 
+void History::options(StateOptions& options)
+{
+    if (!m_frame)
+        return;
+
+    if (HistoryItem* historyItem = m_frame->loader().currentItem()) {
+        options.setWillRestoreScroll(!historyItem->shouldRestoreScroll());

[Nate Chapin, 2015/05/07 20:26:59]

The name of this function implies it's a getter, but it's setting state?

[majidvp, 2015/05/08 21:00:46]

Done.

+    }
+}
+
 bool History::stateChanged() const
 {
     return m_lastStateObjectRequested != stateInternal();
 }
 
 bool History::isSameAsCurrentState(SerializedScriptValue* state) const
 {
     return state == stateInternal();
 }
 
@@ skipping 31 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, FrameLoadType type, ExceptionState& exceptionState)
+void History::stateObjectAdded(PassRefPtr<SerializedScriptValue> data, const String& /* title */, const String& urlString, const StateOptions& options, 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;
     }
-    m_frame->loader().updateForSameDocumentNavigation(fullURL, SameDocumentNavigationHistoryApi, data, type);
+
+    bool shouldRestoreScroll = true;
+    if (RuntimeEnabledFeatures::scrollRestorationEnabled())
+        shouldRestoreScroll = !options.willRestoreScroll();

[Nate Chapin, 2015/05/07 20:26:59]

This inversion doesn't make sense, given the names.

[majidvp, 2015/05/08 21:00:46]

Done.

+
+    m_frame->loader().updateForSameDocumentNavigation(fullURL, SameDocumentNavigationHistoryApi, data, shouldRestoreScroll, type);
 }
 
 } // namespace blink