2008-01-16 Alp Toker <alp@atoker.com>

        Reviewed by Mark Rowe.

        http://bugs.webkit.org/show_bug.cgi?id=16218
        [GTK] API: Should this entry point be called go_back rather than go_backward?

        Obsolete 'backward' terminology in API in favour of 'back'. Introduce
        step-based back/forward functions.

        Document more functions.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@29550 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/WebKit/gtk/ChangeLog b/WebKit/gtk/ChangeLog
index 5ac4ad4ed347046d343621903b0120b6aec0b1e9..caaadd6abb5e38db2117da6fdab5e58862208417 100644 (file)
--- a/WebKit/gtk/ChangeLog
+++ b/WebKit/gtk/ChangeLog
@@ -1,3 +1,19 @@
+2008-01-16  Alp Toker  <alp@atoker.com>
+
+        Reviewed by Mark Rowe.
+
+        http://bugs.webkit.org/show_bug.cgi?id=16218
+        [GTK] API: Should this entry point be called go_back rather than go_backward?
+
+        Obsolete 'backward' terminology in API in favour of 'back'. Introduce
+        step-based back/forward functions.
+
+        Document more functions.
+
+        * WebView/webkitdefines.h:
+        * WebView/webkitwebview.cpp:
+        * WebView/webkitwebview.h:
+
 2008-01-10  Maciej Stachowiak  <mjs@apple.com>
 
         Reviewed by Sam.

diff --git a/WebKit/gtk/WebView/webkitdefines.h b/WebKit/gtk/WebView/webkitdefines.h
index 2d5e6789f50b4c042f1f37fff0d10370a34f9c74..2fe2b03b98b426ff6399ed8782abf843eb7d44db 100644 (file)
--- a/WebKit/gtk/WebView/webkitdefines.h
+++ b/WebKit/gtk/WebView/webkitdefines.h
@@ -28,8 +28,10 @@
     #else
         #define WEBKIT_API __declspec(dllimport)
     #endif
+    #define WEBKIT_OBSOLETE_API WEBKIT_API
 #else
     #define WEBKIT_API __attribute__((visibility("default")))
+    #define WEBKIT_OBSOLETE_API WEBKIT_API __attribute__((deprecated))
 #endif
 
 #ifndef WEBKIT_API

diff --git a/WebKit/gtk/WebView/webkitwebview.cpp b/WebKit/gtk/WebView/webkitwebview.cpp
index 8fac70fddc77789c4c512d4eab1754955e9c8285..f8cc766240d219100dd6e6f0d420f7f4eef0a746 100644 (file)
--- a/WebKit/gtk/WebView/webkitwebview.cpp
+++ b/WebKit/gtk/WebView/webkitwebview.cpp
@@ -1064,6 +1064,18 @@ WebKitSettings* webkit_web_view_get_settings(WebKitWebView* webView)
 }
 
 void webkit_web_view_go_backward(WebKitWebView* webView)
+{
+    g_warning("webkit_web_view_go_backward() is obsolete; use webkit_web_view_go_back()");
+    webkit_web_view_go_back(webView);
+}
+
+/**
+ * webkit_web_view_go_back:
+ * @web_view: a #WebKitWebView
+ *
+ * Loads the previous history item.
+ */
+void webkit_web_view_go_back(WebKitWebView* webView)
 {
     g_return_if_fail(WEBKIT_IS_WEB_VIEW(webView));
 
@@ -1071,6 +1083,29 @@ void webkit_web_view_go_backward(WebKitWebView* webView)
     frame->loader()->goBackOrForward(-1);
 }
 
+/**
+ * webkit_web_view_go_back_or_forward:
+ * @web_view: a #WebKitWebView
+ * @steps: the number of steps
+ *
+ * Loads the history item that is the number of @steps away from the current
+ * item. Negative values represent steps backward while positive values
+ * represent steps forward.
+ */
+void webkit_web_view_go_back_or_forward(WebKitWebView* webView, gint steps)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_VIEW(webView));
+
+    Frame* frame = core(webkit_web_view_get_main_frame(webView));
+    frame->loader()->goBackOrForward(steps);
+}
+
+/**
+ * webkit_web_view_go_forward:
+ * @web_view: a #WebKitWebView
+ *
+ * Loads the next history item.
+ */
 void webkit_web_view_go_forward(WebKitWebView* webView)
 {
     g_return_if_fail(WEBKIT_IS_WEB_VIEW(webView));
@@ -1080,6 +1115,20 @@ void webkit_web_view_go_forward(WebKitWebView* webView)
 }
 
 gboolean webkit_web_view_can_go_backward(WebKitWebView* webView)
+{
+    g_warning("webkit_web_view_can_go_backward() is obsolete; use webkit_web_view_can_go_back()");
+    return webkit_web_view_can_go_back(webView);
+}
+
+/**
+ * webkit_web_view_can_go_back:
+ * @web_view: a #WebKitWebView
+ *
+ * Determines whether #web_view has a previous history item.
+ *
+ * Return value: %TRUE if able to move back, %FALSE otherwise
+ */
+gboolean webkit_web_view_can_go_back(WebKitWebView* webView)
 {
     g_return_val_if_fail(WEBKIT_IS_WEB_VIEW(webView), FALSE);
 
@@ -1087,6 +1136,33 @@ gboolean webkit_web_view_can_go_backward(WebKitWebView* webView)
     return frame->loader()->canGoBackOrForward(-1);
 }
 
+/**
+ * webkit_web_view_can_go_back_or_forward:
+ * @web_view: a #WebKitWebView
+ * @steps: the number of steps
+ *
+ * Determines whether #web_view has a history item of @steps. Negative values
+ * represent steps backward while positive values represent steps forward.
+ *
+ * Return value: %TRUE if able to move back or forward the given number of
+ * steps, %FALSE otherwise
+ */
+gboolean webkit_web_view_can_go_back_or_forward(WebKitWebView* webView, gint steps)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_VIEW(webView), FALSE);
+
+    Frame* frame = core(webkit_web_view_get_main_frame(webView));
+    return frame->loader()->canGoBackOrForward(steps);
+}
+
+/**
+ * webkit_web_view_can_go_forward:
+ * @web_view: a #WebKitWebView
+ *
+ * Determines whether #web_view has a next history item.
+ *
+ * Return value: %TRUE if able to move forward, %FALSE otherwise
+ */
 gboolean webkit_web_view_can_go_forward(WebKitWebView* webView)
 {
     g_return_val_if_fail(WEBKIT_IS_WEB_VIEW(webView), FALSE);

diff --git a/WebKit/gtk/WebView/webkitwebview.h b/WebKit/gtk/WebView/webkitwebview.h
index 7d120774b4a1f21231d1d64bbaf3d7d8c97f9a94..7c4aaf75b97acc07b4d45a1a3ef3531932d539bd 100644 (file)
--- a/WebKit/gtk/WebView/webkitwebview.h
+++ b/WebKit/gtk/WebView/webkitwebview.h
@@ -90,15 +90,27 @@ webkit_web_view_get_type (void);
 WEBKIT_API GtkWidget*
 webkit_web_view_new (void);
 
-WEBKIT_API gboolean
+WEBKIT_OBSOLETE_API gboolean
 webkit_web_view_can_go_backward (WebKitWebView* web_view);
 
+WEBKIT_API gboolean
+webkit_web_view_can_go_back (WebKitWebView* web_view);
+
+WEBKIT_API gboolean
+webkit_web_view_can_go_back_or_forward (WebKitWebView* web_view, gint steps);
+
 WEBKIT_API gboolean
 webkit_web_view_can_go_forward (WebKitWebView* web_view);
 
-WEBKIT_API void
+WEBKIT_OBSOLETE_API void
 webkit_web_view_go_backward (WebKitWebView* web_view);
 
+WEBKIT_API void
+webkit_web_view_go_back (WebKitWebView* web_view);
+
+WEBKIT_API void
+webkit_web_view_go_back_or_forward (WebKitWebView* web_view, gint steps);
+
 WEBKIT_API void
 webkit_web_view_go_forward (WebKitWebView* web_view);
 

diff --git a/WebKitTools/ChangeLog b/WebKitTools/ChangeLog
index 580f6a90e1e12877893301995b785c0929ebe7a1..92556ecb90bf40380f909ff1068e09682b5aa9bd 100644 (file)
--- a/WebKitTools/ChangeLog
+++ b/WebKitTools/ChangeLog
@@ -1,3 +1,17 @@
+2008-01-16  Alp Toker  <alp@atoker.com>
+
+        Reviewed by Mark Rowe.
+
+        http://bugs.webkit.org/show_bug.cgi?id=16218
+        [GTK] API: Should this entry point be called go_back rather than go_backward?
+
+        Track back/forward API changes in the tools.
+
+        * DumpRenderTree/gtk/WorkQueueItemGtk.cpp:
+        (BackForwardItem::invoke):
+        * GtkLauncher/main.c:
+        (go_back_cb):
+
 2008-01-16  Adam Roben  <aroben@apple.com>
 
         Windows build fix after r29488

diff --git a/WebKitTools/DumpRenderTree/gtk/WorkQueueItemGtk.cpp b/WebKitTools/DumpRenderTree/gtk/WorkQueueItemGtk.cpp
index f47e021f8918ed6abe3a75c4b4dc94489b2654a0..724bcda63bf273175fd931bc300c6fffe2607766 100644 (file)
--- a/WebKitTools/DumpRenderTree/gtk/WorkQueueItemGtk.cpp
+++ b/WebKitTools/DumpRenderTree/gtk/WorkQueueItemGtk.cpp
@@ -71,13 +71,5 @@ void ScriptItem::invoke() const
 void BackForwardItem::invoke() const
 {
     WebKitWebView* webView = webkit_web_frame_get_web_view(mainFrame);
-    if (m_howFar == 1)
-        webkit_web_view_go_forward(webView);
-    else if (m_howFar == -1)
-        webkit_web_view_go_backward(webView);
-    else {
-        g_warning("Can't go backward/forward\n");
-        //notImplemented();
-        // TODO: API doesn't yet support arbitrary back/forward
-    }
+    webkit_web_view_go_back_or_forward(webView, m_howFar);
 }

diff --git a/WebKitTools/GtkLauncher/main.c b/WebKitTools/GtkLauncher/main.c
index fd8627935e01a0cde17fb07acf674b7edd5a96fb..61bdbc8107b51c6f84a7a500a5677248671da45a 100644 (file)
--- a/WebKitTools/GtkLauncher/main.c
+++ b/WebKitTools/GtkLauncher/main.c
@@ -97,7 +97,7 @@ destroy_cb (GtkWidget* widget, gpointer data)
 static void
 go_back_cb (GtkWidget* widget, gpointer data)
 {
-    webkit_web_view_go_backward (web_view);
+    webkit_web_view_go_back (web_view);
 }
 
 static void