Changeset 169805 in webkit

Timestamp:

Jun 11, 2014 7:30:34 AM (10 years ago)

Author:

mitz@apple.com

Message:

<rdar://problem/17218629> [Cocoa] WKWebView’s canGoBack and canGoForward properties are not KVO-compliant
​https://bugs.webkit.org/show_bug.cgi?id=133722

Reviewed by Anders Carlsson.

• UIProcess/API/Cocoa/WKBrowsingContextController.mm: Added no-op overrides of new

PageLoadStateObserver member functions.

• UIProcess/API/Cocoa/WKWebView.h: Documented the canGoBack and canGoForward properties as

being KVO-compliant.

• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView canGoBack]): Changed to get the return value from the page load state.
(-[WKWebView canGoForward]): Ditto.

• UIProcess/Cocoa/NavigationState.h:
• UIProcess/Cocoa/NavigationState.mm:

(WebKit::NavigationState::willChangeCanGoBack): Override this new PageLoadStateObserver
member function by sending the appropriate KVO change message to the WKWebView.
(WebKit::NavigationState::didChangeCanGoBack): Ditto.
(WebKit::NavigationState::willChangeCanGoForward): Ditto.
(WebKit::NavigationState::didChangeCanGoForward): Ditto.

• UIProcess/PageLoadState.cpp:

(WebKit::PageLoadState::commitChanges): Check for changes to canGoBack and canGoForward
and call the observers if needed.
(WebKit::PageLoadState::canGoBack): Added. Returns the value from the committed state.
(WebKit::PageLoadState::setCanGoBack): Added. Sets the value in the uncommitted state.
(WebKit::PageLoadState::canGoForward): Added. Returns the value from the committed state.
(WebKit::PageLoadState::setCanGoForward): Added. Sets the value in the uncommitted state.

• UIProcess/PageLoadState.h:

(WebKit::PageLoadState::Data::Data): Added canGoBack and canGoForward boolean members.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::didChangeBackForwardList): Update the page load state with the new
state of canGoBack and canGoForward.

• UIProcess/WebPageProxy.h: Removed unused member variables m_canGoBack and m_canGoForward.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/Cocoa/WKBrowsingContextController.mm (modified) (1 diff)
• UIProcess/API/Cocoa/WKWebView.h (modified) (2 diffs)
• UIProcess/API/Cocoa/WKWebView.mm (modified) (1 diff)
• UIProcess/Cocoa/NavigationState.h (modified) (1 diff)
• UIProcess/Cocoa/NavigationState.mm (modified) (1 diff)
• UIProcess/PageLoadState.cpp (modified) (4 diffs)
• UIProcess/PageLoadState.h (modified) (4 diffs)
• UIProcess/WebPageProxy.cpp (modified) (1 diff)
• UIProcess/WebPageProxy.h (modified) (1 diff)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2014-06-11  Dan Bernstein  <mitz@apple.com>
+
+        <rdar://problem/17218629> [Cocoa] WKWebView’s canGoBack and canGoForward properties are not KVO-compliant
+        https://bugs.webkit.org/show_bug.cgi?id=133722
+
+        Reviewed by Anders Carlsson.
+
+        * UIProcess/API/Cocoa/WKBrowsingContextController.mm: Added no-op overrides of new
+        PageLoadStateObserver member functions.
+
+        * UIProcess/API/Cocoa/WKWebView.h: Documented the canGoBack and canGoForward properties as
+        being KVO-compliant.
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView canGoBack]): Changed to get the return value from the page load state.
+        (-[WKWebView canGoForward]): Ditto.
+
+        * UIProcess/Cocoa/NavigationState.h:
+        * UIProcess/Cocoa/NavigationState.mm:
+        (WebKit::NavigationState::willChangeCanGoBack): Override this new PageLoadStateObserver
+        member function by sending the appropriate KVO change message to the WKWebView.
+        (WebKit::NavigationState::didChangeCanGoBack): Ditto.
+        (WebKit::NavigationState::willChangeCanGoForward): Ditto.
+        (WebKit::NavigationState::didChangeCanGoForward): Ditto.
+
+        * UIProcess/PageLoadState.cpp:
+        (WebKit::PageLoadState::commitChanges): Check for changes to canGoBack and canGoForward
+        and call the observers if needed.
+        (WebKit::PageLoadState::canGoBack): Added. Returns the value from the committed state.
+        (WebKit::PageLoadState::setCanGoBack): Added. Sets the value in the uncommitted state.
+        (WebKit::PageLoadState::canGoForward): Added. Returns the value from the committed state.
+        (WebKit::PageLoadState::setCanGoForward): Added. Sets the value in the uncommitted state.
+        * UIProcess/PageLoadState.h:
+        (WebKit::PageLoadState::Data::Data): Added canGoBack and canGoForward boolean members.
+
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::didChangeBackForwardList): Update the page load state with the new
+        state of canGoBack and canGoForward.
+        * UIProcess/WebPageProxy.h: Removed unused member variables m_canGoBack and m_canGoForward.
+
 2014-06-11  Zan Dobersek  <zdobersek@igalia.com>
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBrowsingContextController.mm

@@ -121 +121 @@
     }
 
+    virtual void willChangeCanGoBack() override { }
+    virtual void didChangeCanGoBack() override { }
+    virtual void willChangeCanGoForward() override { }
+    virtual void didChangeCanGoForward() override { }
+
     WKBrowsingContextController *m_controller;
 };

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h

@@ -147 +147 @@
 /*! @abstract A Boolean value indicating whether there is a back item in
  the back-forward list that can be navigated to.
+ @discussion @link WKWebView @/link is key-value observing (KVO) compliant
+ for this property.
  @seealso backForwardList.
  */
@@ -153 +155 @@
 /*! @abstract A Boolean value indicating whether there is a forward item in
  the back-forward list that can be navigated to.
+ @discussion @link WKWebView @/link is key-value observing (KVO) compliant
+ for this property.
  @seealso backForwardList.
  */

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm

@@ -405 +405 @@
 }
 
-// FIXME: This should be KVO compliant.
 - (BOOL)canGoBack
 {
-    return !!_page->backForwardList().backItem();
-}
-
-// FIXME: This should be KVO compliant.
+    return _page->pageLoadState().canGoBack();
+}
+
 - (BOOL)canGoForward
 {
-    return !!_page->backForwardList().forwardItem();
+    return _page->pageLoadState().canGoForward();
 }
 

trunk/Source/WebKit2/UIProcess/Cocoa/NavigationState.h

@@ -128 +128 @@
     virtual void willChangeEstimatedProgress() override;
     virtual void didChangeEstimatedProgress() override;
+    virtual void willChangeCanGoBack() override;
+    virtual void didChangeCanGoBack() override;
+    virtual void willChangeCanGoForward() override;
+    virtual void didChangeCanGoForward() override;
 
     WKWebView *m_webView;

trunk/Source/WebKit2/UIProcess/Cocoa/NavigationState.mm

@@ -733 +733 @@
 }
 
+void NavigationState::willChangeCanGoBack()
+{
+    [m_webView willChangeValueForKey:@"canGoBack"];
+}
+
+void NavigationState::didChangeCanGoBack()
+{
+    [m_webView didChangeValueForKey:@"canGoBack"];
+}
+
+void NavigationState::willChangeCanGoForward()
+{
+    [m_webView willChangeValueForKey:@"canGoForward"];
+}
+
+void NavigationState::didChangeCanGoForward()
+{
+    [m_webView didChangeValueForKey:@"canGoForward"];
+}
+
 } // namespace WebKit
 

trunk/Source/WebKit2/UIProcess/PageLoadState.cpp

@@ -96 +96 @@
     m_mayHaveUncommittedChanges = false;
 
+    bool canGoBackChanged = m_committedState.canGoBack != m_uncommittedState.canGoBack;
+    bool canGoForwardChanged = m_committedState.canGoForward != m_uncommittedState.canGoForward;
     bool titleChanged = m_committedState.title != m_uncommittedState.title;
     bool isLoadingChanged = isLoading(m_committedState) != isLoading(m_uncommittedState);
@@ -102 +104 @@
     bool estimatedProgressChanged = estimatedProgress(m_committedState) != estimatedProgress(m_uncommittedState);
 
+    if (canGoBackChanged)
+        callObserverCallback(&Observer::willChangeCanGoBack);
+    if (canGoForwardChanged)
+        callObserverCallback(&Observer::willChangeCanGoForward);
     if (titleChanged)
         callObserverCallback(&Observer::willChangeTitle);
@@ -126 +132 @@
     if (titleChanged)
         callObserverCallback(&Observer::didChangeTitle);
+    if (canGoForwardChanged)
+        callObserverCallback(&Observer::didChangeCanGoForward);
+    if (canGoBackChanged)
+        callObserverCallback(&Observer::didChangeCanGoBack);
 }
 
@@ -319 +329 @@
 }
 
+bool PageLoadState::canGoBack() const
+{
+    return m_committedState.canGoBack;
+}
+
+void PageLoadState::setCanGoBack(const Transaction::Token& token, bool canGoBack)
+{
+    ASSERT_UNUSED(token, &token.m_pageLoadState == this);
+    m_uncommittedState.canGoBack = canGoBack;
+}
+
+bool PageLoadState::canGoForward() const
+{
+    return m_committedState.canGoForward;
+}
+
+void PageLoadState::setCanGoForward(const Transaction::Token& token, bool canGoForward)
+{
+    ASSERT_UNUSED(token, &token.m_pageLoadState == this);
+    m_uncommittedState.canGoForward = canGoForward;
+}
+
 void PageLoadState::didStartProgress(const Transaction::Token& token)
 {

trunk/Source/WebKit2/UIProcess/PageLoadState.h

@@ -62 +62 @@
         virtual void willChangeEstimatedProgress() = 0;
         virtual void didChangeEstimatedProgress() = 0;
+
+        virtual void willChangeCanGoBack() = 0;
+        virtual void didChangeCanGoBack() = 0;
+
+        virtual void willChangeCanGoForward() = 0;
+        virtual void didChangeCanGoForward() = 0;
     };
 
@@ -135 +141 @@
     void setTitle(const Transaction::Token&, const String&);
 
+    bool canGoBack() const;
+    void setCanGoBack(const Transaction::Token&, bool);
+
+    bool canGoForward() const;
+    void setCanGoForward(const Transaction::Token&, bool);
+
     void didStartProgress(const Transaction::Token&);
     void didChangeProgress(const Transaction::Token&, double);
@@ -151 +163 @@
             : state(State::Finished)
             , hasInsecureContent(false)
+            , canGoBack(false)
+            , canGoForward(false)
             , estimatedProgress(0)
         {
@@ -166 +180 @@
 
         String title;
+
+        bool canGoBack;
+        bool canGoForward;
 
         double estimatedProgress;

trunk/Source/WebKit2/UIProcess/WebPageProxy.cpp

@@ -926 +926 @@
     m_loaderClient->didChangeBackForwardList(this, added, std::move(removed));
 
+    auto transaction = m_pageLoadState.transaction();
+
+    m_pageLoadState.setCanGoBack(transaction, m_backForwardList->backItem());
+    m_pageLoadState.setCanGoForward(transaction, m_backForwardList->forwardItem());
+
 #if PLATFORM(MAC)
     m_pageClient.clearCustomSwipeViews();

trunk/Source/WebKit2/UIProcess/WebPageProxy.h

@@ -1553 +1553 @@
 #endif
         
-    bool m_canGoBack;
-    bool m_canGoForward;
     Ref<WebBackForwardList> m_backForwardList;