Merge lp:~ken-vandine/dee/model_cleared_signal into lp:dee

[Ken VanDine]

Adds a DeeModel::cleared signal which is emitted when a model is cleared, before the rows are removed.

[Mikkel Kamstrup Erlandsen (kamstrup)]

Can you attach a bug report describing the problem?

Test wise you can get into some more corner cases easily, namely clearing an empty model, and doing two successive clears. Ala:

160 +test_signal_cleared (SignalsFixture *fix, gconstpointer data)
161 +{
162 + gint i;
163 +
164 + g_signal_connect (fix->model, "cleared",
165 + G_CALLBACK (test_signal_cleared_callback), NULL);
166 +
++ /* clearing an empty model should work */
++ dee_model_clear (...)
++ g_assert_cmpint (..., 1);
++
167 + for (i = 0; i < 10000; i++)
168 + {
169 + dee_model_append (fix->model, i, "Test");
170 + }
171 +
172 + n_cleared_signals = 0;
173 + dee_model_clear (fix->model);
174 + g_assert_cmpint (n_cleared_signals, ==, 2);
++
++ /* two successive clears */
++ dee_model_clear (...)
++ g_assert_cmpint (..., 3);
175 +}
176 +

review: Needs Fixing

[Francis Ginther (fginther)]

Review was claimed by accident, please ignore.

review: Abstain

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:342
http://jenkins.qa.ubuntu.com/job/dee-mbs-ci/6/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/dee-mbs-ci/./build=pbuilder,distribution=quantal,flavor=amd64/6/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/dee-mbs-ci/./build=pbuilder,distribution=quantal,flavor=i386/6/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/dee-mbs-ci/6//rebuild/?

review: Needs Fixing (continuous-integration)

[Michal Hruby (mhr3)]

With the changeset support in dee 1.2.6, I don't think we need this anymore.

Unmerged revisions

342. By Ken VanDine on 2012-02-01

Adds a DeeModel::cleared signal which is emitted when a model is cleared, before the rows are removed.

=== modified file 'src/dee-model.c'
--- src/dee-model.c	2012-01-26 18:30:57 +0000
+++ src/dee-model.c	2012-02-01 16:27:18 +0000
@@ -98,6 +98,7 @@
   DEE_MODEL_SIGNAL_ROW_ADDED,
   DEE_MODEL_SIGNAL_ROW_REMOVED,
   DEE_MODEL_SIGNAL_ROW_CHANGED,
+  DEE_MODEL_SIGNAL_CLEARED,
 
   DEE_MODEL_LAST_SIGNAL
 };
@@ -225,6 +226,21 @@
                   g_cclosure_marshal_VOID__BOXED,
                   G_TYPE_NONE, 1,
                   DEE_TYPE_MODEL_ITER);
+
+  /**
+   * DeeModel::cleared:
+   * @self: the #DeeModel on which the signal is emitted
+   *
+   * Connect to this signal to be notified when the model has been cleared.
+   **/
+  dee_model_signals[DEE_MODEL_SIGNAL_CLEARED] =
+    g_signal_new ("cleared",
+                  DEE_TYPE_MODEL,
+                  G_SIGNAL_RUN_LAST,
+                  G_STRUCT_OFFSET (DeeModelIface,cleared),
+                  NULL, NULL, NULL,
+                  G_TYPE_NONE, 0);
+
 }
 
 /**

=== modified file 'src/dee-model.h'
--- src/dee-model.h	2012-01-26 18:30:57 +0000
+++ src/dee-model.h	2012-02-01 16:27:18 +0000
@@ -92,6 +92,8 @@
   void           (*row_changed)     (DeeModel     *self,
                                      DeeModelIter *iter);
 
+  void           (*cleared)         (DeeModel     *self);
+
   /*< public >*/
   void            (*set_schema_full)    (DeeModel          *self,
                                          const char* const *column_schemas,

=== modified file 'src/dee-proxy-model.c'
--- src/dee-proxy-model.c	2011-10-24 19:52:06 +0000
+++ src/dee-proxy-model.c	2012-02-01 16:27:18 +0000
@@ -80,6 +80,7 @@
   gulong     row_added_handler;
   gulong     row_removed_handler;
   gulong     row_changed_handler;
+  gulong     cleared_handler;
 };
 
 #define DEE_PROXY_MODEL_BACK_END(model) (DEE_PROXY_MODEL(model)->priv->back_end)
@@ -212,6 +213,8 @@
 static void           on_back_end_row_changed        (DeeProxyModel *self,
                                                       DeeModelIter  *iter);
 
+static void           on_back_end_cleared            (DeeProxyModel *self);
+
 /*
  * Overrides for DeeSerializableModel
  */
@@ -237,6 +240,8 @@
         g_signal_handler_disconnect (priv->back_end, priv->row_removed_handler);
       if (priv->row_changed_handler != 0)
         g_signal_handler_disconnect (priv->back_end, priv->row_changed_handler);
+      if (priv->cleared_handler != 0)
+        g_signal_handler_disconnect (priv->back_end, priv->cleared_handler);
 
       g_object_unref (priv->back_end);
     }
@@ -269,6 +274,9 @@
       priv->row_changed_handler =
         g_signal_connect_swapped (priv->back_end, "row-changed",
                                   G_CALLBACK (on_back_end_row_changed), object);
+      priv->cleared_handler =
+        g_signal_connect_swapped (priv->back_end, "cleared",
+                                  G_CALLBACK (on_back_end_cleared), object);
     }
   
   /* GObjectClass has NULL 'constructed' member, but we add this check for
@@ -415,6 +423,7 @@
   priv->row_added_handler = 0;
   priv->row_removed_handler = 0;
   priv->row_changed_handler = 0;
+  priv->cleared_handler = 0;
 }
 
 /*
@@ -759,6 +768,12 @@
   g_signal_emit_by_name (self, "row-changed", iter);
 }
 
+static void
+on_back_end_cleared (DeeProxyModel *self)
+{
+  g_signal_emit_by_name (self, "cleared", NULL);
+}
+
 /*
  * Overrides for DeeSerializableModel
  */

=== modified file 'src/dee-serializable-model.c'
--- src/dee-serializable-model.c	2012-01-09 11:17:10 +0000
+++ src/dee-serializable-model.c	2012-02-01 16:27:18 +0000
@@ -462,6 +462,9 @@
 
   iter = dee_model_get_first_iter (self);
 
+  /* emit the cleared signal before removing rows */
+  g_signal_emit_by_name (self, "cleared", NULL);
+
   while (!dee_model_is_last (self, iter))
     {
       dee_model_remove (self, iter);

=== modified file 'tests/test-model-signals.c'
--- tests/test-model-signals.c	2011-03-01 10:45:22 +0000
+++ tests/test-model-signals.c	2012-02-01 16:27:18 +0000
@@ -37,6 +37,7 @@
 static void test_signal_add     (SignalsFixture *fix, gconstpointer data);
 static void test_signal_remove  (SignalsFixture *fix, gconstpointer data);
 static void test_signal_changed (SignalsFixture *fix, gconstpointer data);
+static void test_signal_cleared (SignalsFixture *fix, gconstpointer data);
 
 void
 test_model_signals_create_suite (void)
@@ -58,6 +59,11 @@
               rows_setup, test_signal_changed, rows_teardown);
   g_test_add (PROXY_DOMAIN"/Changed", SignalsFixture, 0,
               proxy_rows_setup, test_signal_changed, proxy_rows_teardown);
+
+  g_test_add (SEQ_DOMAIN"/Cleared", SignalsFixture, 0,
+              rows_setup, test_signal_cleared, rows_teardown);
+  g_test_add (PROXY_DOMAIN"/Cleared", SignalsFixture, 0,
+              proxy_rows_setup, test_signal_cleared, proxy_rows_teardown);
 }
 
 static void
@@ -185,3 +191,30 @@
     }
   g_assert_cmpint (n_changed_signals, ==, 10000);
 }
+
+static guint n_cleared_signals = 0;
+
+static void
+test_signal_cleared_callback (DeeModel *model)
+{
+  n_cleared_signals++;
+}
+
+static void
+test_signal_cleared (SignalsFixture *fix, gconstpointer data)
+{
+  gint           i;
+
+  g_signal_connect (fix->model, "cleared",
+                    G_CALLBACK (test_signal_cleared_callback), NULL);
+
+  for (i = 0; i < 10000; i++)
+    {
+      dee_model_append (fix->model, i, "Test");
+    }
+
+  n_cleared_signals = 0;
+  dee_model_clear (fix->model);
+  g_assert_cmpint (n_cleared_signals, ==, 1);
+}
+

=== modified file 'vapi/dee-1.0.vapi'
--- vapi/dee-1.0.vapi	2012-01-30 08:39:53 +0000
+++ vapi/dee-1.0.vapi	2012-02-01 16:27:18 +0000
@@ -238,6 +238,7 @@
 		public void set_schema (...);
 		public abstract void set_schema_full ([CCode (array_length_cname = "num_columns", array_length_pos = 1.1, array_length_type = "guint", array_null_terminated = true)] string[] column_schemas);
 		public abstract void set_value (Dee.ModelIter iter, uint column, GLib.Variant value);
+		public virtual signal void cleared ();
 		public virtual signal void row_added (Dee.ModelIter iter);
 		public virtual signal void row_changed (Dee.ModelIter iter);
 		public virtual signal void row_removed (Dee.ModelIter iter);