<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[170683] trunk</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/170683">170683</a></dd>
<dt>Author</dt> <dd>andersca@apple.com</dd>
<dt>Date</dt> <dd>2014-07-01 17:47:19 -0700 (Tue, 01 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add ABI hacks to allow WKPageRef to use WKSessionStateRef
https://bugs.webkit.org/show_bug.cgi?id=134529
Reviewed by Sam Weinig.
* UIProcess/API/APISessionState.h:
Add a sessionState() getter.
* UIProcess/API/C/WKPage.cpp:
(WKPageCopySessionState):
Add a hack where we return a WKSessionStateRef if the least significant bit of the context pointer
is 1, and a WKDataRef otherwise.
(WKPageRestoreFromSessionState):
Handle both WKDataRef and WKSessionStateref.
* UIProcess/API/C/WKPage.h:
Use WKTypeRefs for state saving and restoration.
* UIProcess/API/C/WKSessionStateRef.cpp:
(WKSessionStateCopyData):
Add helper function.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPIAPISessionStateh">trunk/Source/WebKit2/UIProcess/API/APISessionState.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICWKPagecpp">trunk/Source/WebKit2/UIProcess/API/C/WKPage.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICWKPageh">trunk/Source/WebKit2/UIProcess/API/C/WKPage.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICWKSessionStateRefcpp">trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICWKSessionStateRefh">trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.h</a></li>
<li><a href="#trunkToolsTestWebKitAPITestsWebKit2RestoreSessionStateContainingFormDatacpp">trunk/Tools/TestWebKitAPI/Tests/WebKit2/RestoreSessionStateContainingFormData.cpp</a></li>
<li><a href="#trunkToolsTestWebKitAPITestsWebKit2WKPageGetScaleFactorNotZerocpp">trunk/Tools/TestWebKitAPI/Tests/WebKit2/WKPageGetScaleFactorNotZero.cpp</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/ChangeLog 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -1,5 +1,30 @@
</span><span class="cx"> 2014-07-01 Anders Carlsson <andersca@apple.com>
</span><span class="cx">
</span><ins>+ Add ABI hacks to allow WKPageRef to use WKSessionStateRef
+ https://bugs.webkit.org/show_bug.cgi?id=134529
+
+ Reviewed by Sam Weinig.
+
+ * UIProcess/API/APISessionState.h:
+ Add a sessionState() getter.
+
+ * UIProcess/API/C/WKPage.cpp:
+ (WKPageCopySessionState):
+ Add a hack where we return a WKSessionStateRef if the least significant bit of the context pointer
+ is 1, and a WKDataRef otherwise.
+
+ (WKPageRestoreFromSessionState):
+ Handle both WKDataRef and WKSessionStateref.
+
+ * UIProcess/API/C/WKPage.h:
+ Use WKTypeRefs for state saving and restoration.
+
+ * UIProcess/API/C/WKSessionStateRef.cpp:
+ (WKSessionStateCopyData):
+ Add helper function.
+
+2014-07-01 Anders Carlsson <andersca@apple.com>
+
</ins><span class="cx"> WKPageRestoreFromSessionState should use the new session state restore code path
</span><span class="cx"> https://bugs.webkit.org/show_bug.cgi?id=134526
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPIAPISessionStateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/APISessionState.h (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/APISessionState.h 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/UIProcess/API/APISessionState.h 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -36,6 +36,8 @@
</span><span class="cx"> static PassRefPtr<SessionState> create(WebKit::SessionState);
</span><span class="cx"> virtual ~SessionState();
</span><span class="cx">
</span><ins>+ const WebKit::SessionState& sessionState() const { return m_sessionState; }
+
</ins><span class="cx"> private:
</span><span class="cx"> explicit SessionState(WebKit::SessionState);
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICWKPagecpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/C/WKPage.cpp (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/C/WKPage.cpp 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/UIProcess/API/C/WKPage.cpp 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -32,6 +32,7 @@
</span><span class="cx"> #include "APIFindClient.h"
</span><span class="cx"> #include "APILoaderClient.h"
</span><span class="cx"> #include "APIPolicyClient.h"
</span><ins>+#include "APISessionState.h"
</ins><span class="cx"> #include "APIUIClient.h"
</span><span class="cx"> #include "ImmutableDictionary.h"
</span><span class="cx"> #include "LegacySessionStateCoding.h"
</span><span class="lines">@@ -350,8 +351,12 @@
</span><span class="cx"> return toAPI(sessionBackForwardListValueType);
</span><span class="cx"> }
</span><span class="cx">
</span><del>-WKDataRef WKPageCopySessionState(WKPageRef pageRef, void *context, WKPageSessionStateFilterCallback filter)
</del><ins>+WKTypeRef WKPageCopySessionState(WKPageRef pageRef, void* context, WKPageSessionStateFilterCallback filter)
</ins><span class="cx"> {
</span><ins>+ // FIXME: This is a hack to make sure we return a WKDataRef to maintain compatibility with older versions of Safari.
+ bool shouldReturnData = !(reinterpret_cast<uintptr_t>(context) & 1);
+ context = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(context) & ~1);
+
</ins><span class="cx"> auto sessionState = toImpl(pageRef)->sessionState([pageRef, context, filter](WebBackForwardListItem& item) {
</span><span class="cx"> if (filter) {
</span><span class="cx"> if (!filter(pageRef, WKPageGetSessionBackForwardListItemValueType(), toAPI(&item), context))
</span><span class="lines">@@ -364,15 +369,26 @@
</span><span class="cx"> return true;
</span><span class="cx"> });
</span><span class="cx">
</span><del>- return toAPI(encodeLegacySessionState(sessionState).release().leakRef());
</del><ins>+ if (shouldReturnData)
+ toAPI(encodeLegacySessionState(sessionState).release().leakRef());
+
+ return toAPI(API::SessionState::create(std::move(sessionState)).leakRef());
</ins><span class="cx"> }
</span><span class="cx">
</span><del>-void WKPageRestoreFromSessionState(WKPageRef pageRef, WKDataRef sessionStateData)
</del><ins>+void WKPageRestoreFromSessionState(WKPageRef pageRef, WKTypeRef sessionStateRef)
</ins><span class="cx"> {
</span><span class="cx"> SessionState sessionState;
</span><del>- if (!decodeLegacySessionState(*toImpl(sessionStateData), sessionState))
- return;
</del><span class="cx">
</span><ins>+ // FIXME: This is for backwards compatibility with Safari. Remove it once Safari no longer depends on it.
+ if (toImpl(sessionStateRef)->type() == API::Object::Type::Data) {
+ if (!decodeLegacySessionState(*toImpl(static_cast<WKDataRef>(sessionStateRef)), sessionState))
+ return;
+ } else {
+ ASSERT(toImpl(sessionStateRef)->type() == API::Object::Type::SessionState);
+
+ sessionState = toImpl(static_cast<WKSessionStateRef>(sessionStateRef))->sessionState();
+ }
+
</ins><span class="cx"> toImpl(pageRef)->restoreFromState(std::move(sessionState));
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICWKPageh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/C/WKPage.h (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/C/WKPage.h 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/UIProcess/API/C/WKPage.h 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -130,9 +130,15 @@
</span><span class="cx"> WK_EXPORT WKStringRef WKPageGetSessionBackForwardListItemValueType(void);
</span><span class="cx">
</span><span class="cx"> typedef bool (*WKPageSessionStateFilterCallback)(WKPageRef page, WKStringRef valueType, WKTypeRef value, void* context);
</span><del>-WK_EXPORT WKDataRef WKPageCopySessionState(WKPageRef page, void* context, WKPageSessionStateFilterCallback urlAllowedCallback);
-WK_EXPORT void WKPageRestoreFromSessionState(WKPageRef page, WKDataRef sessionStateData);
</del><span class="cx">
</span><ins>+// FIXME: This should return a WKSessionStateRef object, not a WKTypeRef.
+// It currently returns a WKTypeRef for backwards compatibility with Safari.
+WK_EXPORT WKTypeRef WKPageCopySessionState(WKPageRef page, void* context, WKPageSessionStateFilterCallback urlAllowedCallback);
+
+// FIXME: This should take a WKSessionStateRef object, not a WKTypeRef.
+// It currently takes a WKTypeRef for backwards compatibility with Safari.
+WK_EXPORT void WKPageRestoreFromSessionState(WKPageRef page, WKTypeRef sessionState);
+
</ins><span class="cx"> WK_EXPORT double WKPageGetBackingScaleFactor(WKPageRef page);
</span><span class="cx"> WK_EXPORT void WKPageSetCustomBackingScaleFactor(WKPageRef page, double customScaleFactor);
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICWKSessionStateRefcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.cpp (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.cpp 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.cpp 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -26,6 +26,7 @@
</span><span class="cx"> #include "config.h"
</span><span class="cx"> #include "WKSessionStateRef.h"
</span><span class="cx">
</span><ins>+#include "APIData.h"
</ins><span class="cx"> #include "APISessionState.h"
</span><span class="cx"> #include "LegacySessionStateCoding.h"
</span><span class="cx"> #include "SessionState.h"
</span><span class="lines">@@ -44,3 +45,8 @@
</span><span class="cx">
</span><span class="cx"> return WebKit::toAPI(API::SessionState::create(std::move(sessionState)).leakRef());
</span><span class="cx"> }
</span><ins>+
+WKDataRef WKSessionStateCopyData(WKSessionStateRef sessionState)
+{
+ return WebKit::toAPI(WebKit::encodeLegacySessionState(WebKit::toImpl(sessionState)->sessionState()).release().leakRef());
+}
</ins></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICWKSessionStateRefh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.h (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.h 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Source/WebKit2/UIProcess/API/C/WKSessionStateRef.h 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -36,6 +36,8 @@
</span><span class="cx">
</span><span class="cx"> WK_EXPORT WKSessionStateRef WKSessionStateCreateFromData(WKDataRef data);
</span><span class="cx">
</span><ins>+WK_EXPORT WKDataRef WKSessionStateCopyData(WKSessionStateRef sessionState);
+
</ins><span class="cx"> #ifdef __cplusplus
</span><span class="cx"> }
</span><span class="cx"> #endif
</span></span></pre></div>
<a id="trunkToolsTestWebKitAPITestsWebKit2RestoreSessionStateContainingFormDatacpp"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2/RestoreSessionStateContainingFormData.cpp (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestWebKitAPI/Tests/WebKit2/RestoreSessionStateContainingFormData.cpp 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2/RestoreSessionStateContainingFormData.cpp 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -28,6 +28,7 @@
</span><span class="cx"> #include "PlatformUtilities.h"
</span><span class="cx"> #include "PlatformWebView.h"
</span><span class="cx"> #include "Test.h"
</span><ins>+#include <WebKit2/WKSessionStateRef.h>
</ins><span class="cx">
</span><span class="cx"> namespace TestWebKitAPI {
</span><span class="cx">
</span><span class="lines">@@ -49,7 +50,7 @@
</span><span class="cx"> WKPageSetPageLoaderClient(page, &loaderClient.base);
</span><span class="cx"> }
</span><span class="cx">
</span><del>-static WKRetainPtr<WKDataRef> createSessionStateContainingFormData(WKContextRef context)
</del><ins>+static WKRetainPtr<WKDataRef> createSessionStateDataContainingFormData(WKContextRef context)
</ins><span class="cx"> {
</span><span class="cx"> PlatformWebView webView(context);
</span><span class="cx"> setPageLoaderClient(webView.page());
</span><span class="lines">@@ -62,7 +63,8 @@
</span><span class="cx"> Util::run(&didFinishLoad);
</span><span class="cx"> didFinishLoad = false;
</span><span class="cx">
</span><del>- return adoptWK(WKPageCopySessionState(webView.page(), 0, 0));
</del><ins>+ auto sessionState = adoptWK(static_cast<WKSessionStateRef>(WKPageCopySessionState(webView.page(), reinterpret_cast<void*>(1), nullptr)));
+ return adoptWK(WKSessionStateCopyData(sessionState.get()));
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> TEST(WebKit2, RestoreSessionStateContainingFormData)
</span><span class="lines">@@ -75,10 +77,12 @@
</span><span class="cx"> PlatformWebView webView(context.get());
</span><span class="cx"> setPageLoaderClient(webView.page());
</span><span class="cx">
</span><del>- WKRetainPtr<WKDataRef> data = createSessionStateContainingFormData(context.get());
</del><ins>+ WKRetainPtr<WKDataRef> data = createSessionStateDataContainingFormData(context.get());
</ins><span class="cx"> EXPECT_NOT_NULL(data);
</span><span class="cx">
</span><del>- WKPageRestoreFromSessionState(webView.page(), data.get());
</del><ins>+ auto sessionState = adoptWK(WKSessionStateCreateFromData(data.get()));
+ WKPageRestoreFromSessionState(webView.page(), sessionState.get());
+
</ins><span class="cx"> Util::run(&didFinishLoad);
</span><span class="cx">
</span><span class="cx"> EXPECT_TRUE(WKPageCanGoBack(webView.page()));
</span></span></pre></div>
<a id="trunkToolsTestWebKitAPITestsWebKit2WKPageGetScaleFactorNotZerocpp"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2/WKPageGetScaleFactorNotZero.cpp (170682 => 170683)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestWebKitAPI/Tests/WebKit2/WKPageGetScaleFactorNotZero.cpp 2014-07-02 00:43:42 UTC (rev 170682)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2/WKPageGetScaleFactorNotZero.cpp 2014-07-02 00:47:19 UTC (rev 170683)
</span><span class="lines">@@ -48,7 +48,7 @@
</span><span class="cx"> WKPageSetPageLoaderClient(page, &loaderClient.base);
</span><span class="cx"> }
</span><span class="cx">
</span><del>-static WKRetainPtr<WKDataRef> createSessionState(WKContextRef context)
</del><ins>+static WKRetainPtr<WKSessionStateRef> createSessionState(WKContextRef context)
</ins><span class="cx"> {
</span><span class="cx"> PlatformWebView webView(context);
</span><span class="cx"> setPageLoaderClient(webView.page());
</span><span class="lines">@@ -57,7 +57,7 @@
</span><span class="cx"> Util::run(&didFinishLoad);
</span><span class="cx"> didFinishLoad = false;
</span><span class="cx">
</span><del>- return adoptWK(WKPageCopySessionState(webView.page(), 0, 0));
</del><ins>+ return adoptWK(static_cast<WKSessionStateRef>(WKPageCopySessionState(webView.page(), reinterpret_cast<void*>(1), nullptr)));
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> TEST(WebKit2, WKPageGetScaleFactorNotZero)
</span><span class="lines">@@ -67,10 +67,10 @@
</span><span class="cx"> PlatformWebView webView(context.get());
</span><span class="cx"> setPageLoaderClient(webView.page());
</span><span class="cx">
</span><del>- WKRetainPtr<WKDataRef> data = createSessionState(context.get());
- EXPECT_NOT_NULL(data);
</del><ins>+ auto sessionState = createSessionState(context.get());
+ EXPECT_NOT_NULL(sessionState);
</ins><span class="cx">
</span><del>- WKPageRestoreFromSessionState(webView.page(), data.get());
</del><ins>+ WKPageRestoreFromSessionState(webView.page(), sessionState.get());
</ins><span class="cx"> Util::run(&didFinishLoad);
</span><span class="cx">
</span><span class="cx"> EXPECT_TRUE(WKPageGetScaleFactor(webView.page()) == 1.0);
</span></span></pre>
</div>
</div>
</body>
</html>