[epiphany/wip/downloads: 2/10] downloads: Add API to query the status of an EphyDownload

[Carlos Garcia Campos <carlosgc src gnome org>]

commit c45bd62e523545554ad769990f059ed7eff9af02
Author: Carlos Garcia Campos <cgarcia igalia com>
Date:   Wed Oct 7 10:22:12 2015 +0200

    downloads: Add API to query the status of an EphyDownload
    
    To know if a downloads is completed, failed or active. Also improved the
    signals and used the GError in the "error" signal instead of the error
    code, detail and message. Removed the virtual methods for the signals,
    since the EphyDownload object is not actually inheritable.

 embed/ephy-download.c |   73 ++++++++++++++++++++++++++++++++++++++++---------
 embed/ephy-download.h |   12 +++-----
 2 files changed, 64 insertions(+), 21 deletions(-)
---
diff --git a/embed/ephy-download.c b/embed/ephy-download.c
index 868a4fb..ae9b3e0 100644
--- a/embed/ephy-download.c
+++ b/embed/ephy-download.c
@@ -51,6 +51,8 @@ struct _EphyDownloadPrivate
 
   EphyDownloadActionType action;
   guint32 start_time;
+  gboolean finished;
+  GError *error;
 
   GtkWindow *window;
   GtkWidget *widget;
@@ -69,6 +71,17 @@ enum
   PROP_WIDGET
 };
 
+enum
+{
+  FILENAME_SUGGESTED,
+  ERROR,
+  COMPLETED,
+
+  LAST_SIGNAL
+};
+
+static guint signals[LAST_SIGNAL];
+
 static void
 ephy_download_get_property (GObject    *object,
                             guint       property_id,
@@ -550,6 +563,37 @@ ephy_download_cancel (EphyDownload *download)
   webkit_download_cancel (download->priv->download);
 }
 
+gboolean
+ephy_download_is_active (EphyDownload *download)
+{
+  g_return_val_if_fail (EPHY_IS_DOWNLOAD (download), FALSE);
+
+  return !download->priv->finished;
+}
+
+gboolean
+ephy_download_succeeded (EphyDownload *download)
+{
+  g_return_val_if_fail (EPHY_IS_DOWNLOAD (download), FALSE);
+
+  return download->priv->finished && !download->priv->error;
+}
+
+gboolean
+ephy_download_failed (EphyDownload *download,
+                      GError      **error)
+{
+  g_return_val_if_fail (EPHY_IS_DOWNLOAD (download), FALSE);
+
+  if (download->priv->finished && download->priv->error) {
+    if (error)
+      *error = download->priv->error;
+    return TRUE;
+  }
+
+  return FALSE;
+}
+
 /**
  * ephy_download_do_download_action:
  * @download: an #EphyDownload
@@ -636,6 +680,8 @@ ephy_download_dispose (GObject *object)
     priv->widget = NULL;
   }
 
+  g_clear_error(&priv->error);
+
   G_OBJECT_CLASS (ephy_download_parent_class)->dispose (object);
 }
 
@@ -748,15 +794,15 @@ ephy_download_class_init (EphyDownloadClass *klass)
                                                         G_PARAM_STATIC_BLURB));
 
   /**
-   * EphyDownload::completed:
+   * EphyDownload::filename-suggested:
    *
    * The ::filename-suggested signal is emitted when we have received the
    * suggested filename from WebKit.
    **/
-  g_signal_new ("filename-suggested",
+  signals[FILENAME_SUGGESTED] = g_signal_new ("filename-suggested",
                 G_OBJECT_CLASS_TYPE (object_class),
                 G_SIGNAL_RUN_LAST,
-                G_STRUCT_OFFSET (EphyDownloadClass, filename_suggested),
+                0,
                 NULL, NULL,
                 g_cclosure_marshal_generic,
                 G_TYPE_NONE,
@@ -768,10 +814,10 @@ ephy_download_class_init (EphyDownloadClass *klass)
    *
    * The ::completed signal is emitted when @download has finished downloading.
    **/
-  g_signal_new ("completed",
+  signals[COMPLETED] = g_signal_new ("completed",
                 G_OBJECT_CLASS_TYPE (object_class),
                 G_SIGNAL_RUN_LAST,
-                G_STRUCT_OFFSET (EphyDownloadClass, completed),
+                0,
                 NULL, NULL,
                 g_cclosure_marshal_VOID__VOID,
                 G_TYPE_NONE,
@@ -781,14 +827,14 @@ ephy_download_class_init (EphyDownloadClass *klass)
    *
    * The ::error signal wraps the @download ::error signal.
    **/
-  g_signal_new ("error",
+  signals[ERROR] = g_signal_new ("error",
                 G_OBJECT_CLASS_TYPE (object_class),
                 G_SIGNAL_RUN_LAST,
-                G_STRUCT_OFFSET (EphyDownloadClass, error),
+                0,
                 NULL, NULL,
                 g_cclosure_marshal_generic,
                 G_TYPE_NONE,
-                0);
+                1, G_TYPE_POINTER);
 }
 
 static void
@@ -824,7 +870,7 @@ download_decide_destination_cb (WebKitDownload *wk_download,
   if (webkit_download_get_destination (wk_download))
     return TRUE;
 
-  g_signal_emit_by_name (download, "filename-suggested", suggested_filename);
+  g_signal_emit (download, signals[FILENAME_SUGGESTED], 0, suggested_filename);
 
   if (webkit_download_get_destination (wk_download))
     return TRUE;
@@ -840,7 +886,8 @@ download_finished_cb (WebKitDownload *wk_download,
 
   priv = download->priv;
 
-  g_signal_emit_by_name (download, "completed");
+  download->priv->finished = TRUE;
+  g_signal_emit (download, signals[COMPLETED], 0);
 
   if (g_settings_get_boolean (EPHY_SETTINGS_MAIN, EPHY_PREFS_AUTO_DOWNLOADS) &&
       priv->action == EPHY_DOWNLOAD_ACTION_NONE)
@@ -856,12 +903,12 @@ download_failed_cb (WebKitDownload *wk_download,
                     GError *error,
                     EphyDownload *download)
 {
-  gboolean ret = FALSE;
-
   g_signal_handlers_disconnect_by_func (wk_download, download_finished_cb, download);
 
   LOG ("error (%d - %d)! %s", error->code, 0, error->message);
-  g_signal_emit_by_name (download, "error", 0, error->code, error->message, &ret);
+  download->priv->finished = TRUE;
+  download->priv->error = g_error_copy (error);
+  g_signal_emit (download, signals[ERROR], 0, download->priv->error);
 
   release_session_inhibitor (download);
 }
diff --git a/embed/ephy-download.h b/embed/ephy-download.h
index ae2a1b0..2cc6fb1 100644
--- a/embed/ephy-download.h
+++ b/embed/ephy-download.h
@@ -55,14 +55,6 @@ struct _EphyDownload
 struct _EphyDownloadClass
 {
   GObjectClass parent_class;
-
-  void (* filename_suggested) (EphyDownload *download,
-                               char *suggested_filename);
-  void (* completed)  (EphyDownload *download);
-  void (* error)      (EphyDownload *download,
-                       gint error_code,
-                       gint error_detail,
-                       char *reason);
 };
 
 typedef enum
@@ -82,6 +74,10 @@ EphyDownload *ephy_download_new_for_uri           (const char *uri,
                                                    GtkWindow *parent);
 
 void          ephy_download_cancel                (EphyDownload *download);
+gboolean      ephy_download_is_active             (EphyDownload *download);
+gboolean      ephy_download_succeeded             (EphyDownload *download);
+gboolean      ephy_download_failed                (EphyDownload *download,
+                                                   GError      **error);
 
 void          ephy_download_set_destination_uri   (EphyDownload *download,
                                                    const char *destination);