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

[Ken VanDine]

* Added a descending version of the collator filter
* specify a free_function for Filter in the vapi

[Mikkel Kamstrup Erlandsen (kamstrup)]

 review approve

Didn't test this, but looks good

review: Approve

=== modified file 'dee/dee-filters.c'
--- dee/dee-filters.c	2011-03-17 08:58:36 +0000
+++ dee/dee-filters.c	2011-06-29 13:26:35 +0000
@@ -84,6 +84,11 @@
                                              DeeFilterModel *filter_model,
                                              gpointer user_data);
 
+static void _dee_filter_collator_desc_map_notify (DeeModel *orig_model,
+                                                  DeeModelIter *orig_iter,
+                                                  DeeFilterModel *filter_model,
+                                                  gpointer user_data);
+
 static void
 _dee_filter_collator_map_func (DeeModel *orig_model,
                                DeeFilterModel *filter_model,
@@ -109,6 +114,30 @@
 }
 
 static void
+_dee_filter_collator_desc_map_func (DeeModel *orig_model,
+                               DeeFilterModel *filter_model,
+                               gpointer user_data)
+{
+  DeeModelIter   *iter, *end;
+  CollatorFilter *filter;
+
+  g_return_if_fail (user_data != NULL);
+
+  filter = (CollatorFilter *) user_data;
+  filter->collation_key_tag =
+                 dee_model_register_tag (orig_model, (GDestroyNotify) g_free);
+
+  iter = dee_model_get_first_iter (orig_model);
+  end = dee_model_get_last_iter (orig_model);
+  while (iter != end)
+    {
+      _dee_filter_collator_desc_map_notify (orig_model, iter, filter_model, filter);
+      iter = dee_model_next (orig_model, iter);
+    }
+
+}
+
+static void
 _dee_filter_collator_map_notify (DeeModel *orig_model,
                                  DeeModelIter *orig_iter,
                                  DeeFilterModel *filter_model,
@@ -154,6 +183,51 @@
 }
 
 static void
+_dee_filter_collator_desc_map_notify (DeeModel *orig_model,
+                                 DeeModelIter *orig_iter,
+                                 DeeFilterModel *filter_model,
+                                 gpointer user_data)
+{
+  DeeModelIter   *iter, *end;
+  CollatorFilter *filter;
+  const gchar    *column_value, *test_value;
+  gchar          *collation_key;
+
+  g_return_if_fail (user_data != NULL);
+  g_return_if_fail (orig_iter != NULL);
+
+  filter = (CollatorFilter *) user_data;
+
+  /* Build and set collation ley for the current row */
+  column_value = dee_model_get_string (orig_model, orig_iter, filter->column);
+  collation_key = g_utf8_collate_key (column_value, -1);
+  dee_model_set_tag (orig_model, orig_iter,
+                     filter->collation_key_tag, collation_key); // steal collation_key
+
+  iter = dee_model_get_first_iter (DEE_MODEL (filter_model));
+  end = dee_model_get_last_iter (DEE_MODEL (filter_model));
+  while (iter != end)
+    {
+      test_value = dee_model_get_tag (orig_model, iter, filter->collation_key_tag);
+      if (g_strcmp0 (test_value, column_value) > 0)
+        {
+          iter = dee_model_next (DEE_MODEL (filter_model), iter);
+        }
+      else
+        {
+          dee_filter_model_insert_iter_before (filter_model, orig_iter, iter);
+          iter = NULL;
+          break;
+        }
+    }
+
+  if (iter == end)
+    {
+      dee_filter_model_append_iter(filter_model, orig_iter);
+    }
+}
+
+static void
 _dee_filter_key_map_func (DeeModel *orig_model,
                           DeeFilterModel *filter_model,
                           gpointer user_data)
@@ -357,6 +431,37 @@
 }
 
 /**
+ * dee_filter_new_collator_desc:
+ * @column: The index of a column containing the strings to sort after
+ *
+ * Create a #DeeFilter that takes string values from a column in the model
+ * and builds a #DeeFilterModel with the rows sorted descending according to the
+ * collation rules of the current locale.
+ *
+ * Returns: (transfer full): A newly allocated #DeeFilter. Do not modify it.
+ *          Free with g_free().
+ */
+DeeFilter*
+dee_filter_new_collator_desc    (guint column)
+{
+  DeeFilter      *filter;
+  CollatorFilter *collator; 
+ 
+  filter = g_new0 (DeeFilter, 1); 
+  filter->map_func = _dee_filter_collator_desc_map_func;
+  filter->map_notify = _dee_filter_collator_desc_map_notify;
+ 
+  collator = g_new0 (CollatorFilter, 1);
+  collator->column = column;
+
+  filter->destroy = (GDestroyNotify) g_free;
+  filter->user_data =collator;
+
+  return filter;
+} 
+
+
+/**
  * dee_filter_new_for_key_column:
  * @column: The index of a column containing the string key to match
  *
 
=== modified file 'dee/dee-filters.h'
--- dee/dee-filters.h	2011-03-17 08:58:36 +0000
+++ dee/dee-filters.h	2011-06-29 13:26:35 +0000
@@ -32,6 +32,8 @@
 
 DeeFilter* dee_filter_new_collator       (guint column);
 
+DeeFilter* dee_filter_new_collator_desc       (guint column);
+
 DeeFilter* dee_filter_new_for_key_column (guint column, const gchar *key);
 
 DeeFilter* dee_filter_new_for_any_column (guint column, GVariant *value);
 
=== modified file 'tests/test-filter-model.c'
--- tests/test-filter-model.c	2011-03-17 08:58:36 +0000
+++ tests/test-filter-model.c	2011-06-29 13:26:35 +0000
@@ -39,7 +39,9 @@
                                                 gconstpointer  data);
 static void test_discard_all_append_notify     (FilterFixture *fix,
                                                 gconstpointer  data);
-static void test_collator                      (FilterFixture *fix,
+static void test_collator_asc                  (FilterFixture *fix,
+                                                gconstpointer  data);
+static void test_collator_desc                  (FilterFixture *fix,
                                                 gconstpointer  data);
 static void test_key                           (FilterFixture *fix,
                                                 gconstpointer  data);
@@ -62,8 +64,10 @@
               setup, test_discard_all, teardown);
   g_test_add (DOMAIN"/DiscardAllAppendNotify", FilterFixture, 0,
               setup, test_discard_all_append_notify, teardown);
-  g_test_add (DOMAIN"/Collator", FilterFixture, 0,
-              setup, test_collator, teardown);
+  g_test_add (DOMAIN"/CollatorAscending", FilterFixture, 0,
+              setup, test_collator_asc, teardown);
+  g_test_add (DOMAIN"/CollatorDescending", FilterFixture, 0,
+              setup, test_collator_desc, teardown);
   g_test_add (DOMAIN"/Key", FilterFixture, 0,
               setup, test_key, teardown);
   g_test_add (DOMAIN"/Any", FilterFixture, 0,
@@ -301,9 +305,9 @@
   g_object_unref (m);
 }
 
-/* Test dee_filter_new_collator() */
+/* Test dee_filter_new_collator() ascending */
 static void
-test_collator (FilterFixture *fix, gconstpointer data)
+test_collator_asc (FilterFixture *fix, gconstpointer data)
 {
   DeeModelIter *r0, *r1, *r2, *r3, *r4, *r5;
   DeeFilter    *collator = dee_filter_new_collator (1);
@@ -336,12 +340,57 @@
   /* Appending to the end of the sorted model is a special case in the code,
    * so double check on that... */
   dee_model_append (fix->model, 5, "Zzzz");
+  r0 = dee_model_get_iter_at_row (m, 0);
   r5 = dee_model_get_iter_at_row (m, 5);
+  g_assert_cmpstr ("Four", ==, dee_model_get_string (m, r0, 1));
   g_assert_cmpstr ("Zzzz", ==, dee_model_get_string (m, r5, 1));
 
   g_object_unref (m);
 }
 
+/* Test dee_filter_new_collator_desc() descending*/
+static void
+test_collator_desc (FilterFixture *fix, gconstpointer data)
+{
+  DeeModelIter *r0, *r1, *r2, *r3, *r4, *r5;
+  DeeFilter    *collator = dee_filter_new_collator_desc (1);
+  DeeModel     *m = dee_filter_model_new (collator, fix->model);
+
+  g_free (collator);
+
+  /* Test alphabetic sorting after initial construction */
+  r0 = dee_model_get_iter_at_row (m, 0);
+  r1 = dee_model_get_iter_at_row (m, 1);
+  r2 = dee_model_get_iter_at_row (m, 2);
+  g_assert_cmpstr ("Zero", ==, dee_model_get_string (m, r0, 1));
+  g_assert_cmpstr ("Two", ==, dee_model_get_string (m, r1, 1));
+  g_assert_cmpstr ("One", ==, dee_model_get_string (m, r2, 1));
+
+  /* Test alphabetic sorting after updates */
+  dee_model_append (fix->model, 3, "Three");
+  dee_model_append (fix->model, 4, "Four");
+  r0 = dee_model_get_iter_at_row (m, 0);
+  r1 = dee_model_get_iter_at_row (m, 1);
+  r2 = dee_model_get_iter_at_row (m, 2);
+  r3 = dee_model_get_iter_at_row (m, 3);
+  r4 = dee_model_get_iter_at_row (m, 4);
+  g_assert_cmpstr ("Zero", ==, dee_model_get_string (m, r0, 1));
+  g_assert_cmpstr ("Two", ==, dee_model_get_string (m, r1, 1));
+  g_assert_cmpstr ("Three", ==, dee_model_get_string (m, r2, 1));
+  g_assert_cmpstr ("One", ==, dee_model_get_string (m, r3, 1));
+  g_assert_cmpstr ("Four", ==, dee_model_get_string (m, r4, 1));
+
+  /* Appending to the end of the sorted model is a special case in the code,
+   * so double check on that... */
+  dee_model_append (fix->model, 5, "Zzzz");
+  r0 = dee_model_get_iter_at_row (m, 0);
+  r5 = dee_model_get_iter_at_row (m, 5);
+  g_assert_cmpstr ("Four", ==, dee_model_get_string (m, r5, 1));
+  g_assert_cmpstr ("Zzzz", ==, dee_model_get_string (m, r0, 1));
+
+  g_object_unref (m);
+}
+
 static void
 _test_orig_ordering (FilterFixture *fix,
                      DeeFilter     *filter)
 
=== modified file 'vapi/dee-1.0-custom.vala'
--- vapi/dee-1.0-custom.vala	2010-08-11 10:41:35 +0000
+++ vapi/dee-1.0-custom.vala	2011-06-29 13:26:35 +0000
@@ -15,6 +15,11 @@
       [NoAccessorMethod]
       public unowned Filter filter { get; construct; }
     }
+  [Compact]
+  [CCode (free_function = "g_free", cheader_filename = "dee.h")]
+  public class Filter {
+  }
+
   
   [CCode (cheader_filename = "dee.h")]
   public interface ResultSet: GLib.Object
 
=== modified file 'vapi/dee-1.0.gi'
--- vapi/dee-1.0.gi	2011-03-17 09:00:37 +0000
+++ vapi/dee-1.0.gi	2011-06-29 13:26:35 +0000
@@ -82,6 +82,12 @@
 					<parameter name="column" type="guint"/>
 				</parameters>
 			</method>
+			<method name="new_collator_desc" symbol="dee_filter_new_collator_desc">
+				<return-type type="DeeFilter*"/>
+				<parameters>
+					<parameter name="column" type="guint"/>
+				</parameters>
+			</method>
 			<method name="new_for_any_column" symbol="dee_filter_new_for_any_column">
 				<return-type type="DeeFilter*"/>
 				<parameters>
 
=== modified file 'vapi/dee-1.0.vapi'
--- vapi/dee-1.0.vapi	2011-03-17 09:00:37 +0000
+++ vapi/dee-1.0.vapi	2011-06-29 13:26:35 +0000
@@ -31,7 +31,7 @@
 		public string primary_path { get; construct; }
 	}
 	[Compact]
-	[CCode (cheader_filename = "dee.h")]
+	[CCode (free_function = "g_free", cheader_filename = "dee.h")]
 	public class Filter {
 		public weak GLib.DestroyNotify destroy;
 		public weak Dee.ModelMapFunc map_func;
@@ -40,6 +40,8 @@
 		[CCode (has_construct_function = false)]
 		public Filter.collator (uint column);
 		[CCode (has_construct_function = false)]
+		public Filter.collator_desc (uint column);
+		[CCode (has_construct_function = false)]
 		public Filter.for_any_column (uint column, GLib.Variant value);
 		[CCode (has_construct_function = false)]
 		public Filter.for_key_column (uint column, string key);