Add BuildConfig and Buildopts sorting functions

Signed-off-by: Merlin Mathesius <[email protected]>

Author: mmathesius

modulemd/include/private/modulemd-build-config.h

@@ -347,6 +347,7 @@ modulemd_build_config_validate (ModulemdBuildConfig *buildconfig,
 ModulemdBuildConfig *
 modulemd_build_config_copy (ModulemdBuildConfig *self);
 
+
 /**
  * modulemd_build_config_equals:
  * @self_1: A pointer to a #ModulemdBuildConfig object.
@@ -362,4 +363,19 @@ gboolean
 modulemd_build_config_equals (ModulemdBuildConfig *self_1,
                               ModulemdBuildConfig *self_2);
 
+
+/**
+ * modulemd_build_config_compare:
+ * @self_1: (in): A pointer to a #ModulemdBuildConfig object.
+ * @self_2: (in): A pointer to a #ModulemdBuildConfig object.
+ *
+ * Returns: Less than zero if @self_1 sorts less than @self_2, zero for equal,
+ * greater than zero if @self_1 is greater than @self_2.
+ *
+ * Since: 2.10
+ */
+gint
+modulemd_build_config_compare (ModulemdBuildConfig *self_1,
+                               ModulemdBuildConfig *self_2);
+
 G_END_DECLS

modulemd/include/private/modulemd-buildopts-private.h

@@ -63,3 +63,18 @@ gboolean
 modulemd_buildopts_emit_yaml (ModulemdBuildopts *self,
                               yaml_emitter_t *emitter,
                               GError **error);
+
+
+/**
+ * modulemd_buildopts_compare:
+ * @self_1: (in): A #ModulemdBuildopts object.
+ * @self_2: (in): A #ModulemdBuildopts object.
+ *
+ * Returns: Less than zero if @self_1 sorts less than @self_2, zero for equal,
+ * greater than zero if @self_1 is greater than @self_2.
+ *
+ * Since: 2.10
+ */
+gint
+modulemd_buildopts_compare (ModulemdBuildopts *self_1,
+                            ModulemdBuildopts *self_2);

modulemd/include/private/modulemd-util.h

@@ -205,6 +205,27 @@ modulemd_hash_table_equals (GHashTable *a,
                             GHashTable *b,
                             GEqualFunc compare_func);
 
+/*
+ * modulemd_hash_table_compare:
+ * @a: (in): A #GHashTable object.
+ * @b: (in): A #GHashTable object.
+ * @value_compare_func: (in): A #GCompareFunc function that is called to compare
+ * pairs of #GHashTable values for sorting. If NULL, only the #GHashTable keys
+ * are compared.
+ *
+ * Using guidance from
+ * https://docs.python.org/3/tutorial/datastructures.html#comparing-sequences-and-other-types
+ *
+ * Returns: Less than zero if @a sorts less than @b, zero for equal, greater than
+ * zero if @a is greater than @b.
+ *
+ * Since: 2.10
+ */
+gint
+modulemd_hash_table_compare (GHashTable *a,
+                             GHashTable *b,
+                             GCompareFunc value_compare_func);
+
 /**
  * modulemd_strcmp_sort:
  * @a: A #gconstpointer.
@@ -218,6 +239,19 @@ modulemd_hash_table_equals (GHashTable *a,
 gint
 modulemd_strcmp_sort (gconstpointer a, gconstpointer b);
 
+/**
+ * modulemd_strcmp_wrapper:
+ * @a: (in): A #gconstpointer.
+ * @b: (in): A #gconstpointer.
+ *
+ * Returns: 0 if @a and @b are identical strings, a negative value if @a is less
+ * than @b, and a positive value if @a is greater than @b.
+ *
+ * Since: 2.10
+ */
+gint
+modulemd_strcmp_wrapper (gconstpointer a, gconstpointer b);
+
 /**
  * modulemd_ordered_str_keys:
  * @htable: A #GHashTable.

modulemd/modulemd-build-config.c

@@ -722,3 +722,67 @@ modulemd_build_config_equals (ModulemdBuildConfig *self_1,
 
   return TRUE;
 }
+
+
+/* return less than zero if first arg is less than second arg,
+ * zero for equal,
+ * greater than zero if first arg is greater than second arg.
+ */
+gint
+modulemd_build_config_compare (ModulemdBuildConfig *self_1,
+                               ModulemdBuildConfig *self_2)
+{
+  gint cmp;
+
+  if (!self_1 && !self_2)
+    {
+      return 0;
+    }
+
+  if (!self_1)
+    {
+      return -1;
+    }
+
+  if (!self_2)
+    {
+      return 1;
+    }
+
+  g_return_val_if_fail (MODULEMD_IS_BUILD_CONFIG (self_1), 1);
+  g_return_val_if_fail (MODULEMD_IS_BUILD_CONFIG (self_2), -1);
+
+  cmp = g_strcmp0 (self_1->context, self_2->context);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp = g_strcmp0 (self_1->platform, self_2->platform);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp = modulemd_hash_table_compare (
+    self_1->buildrequires, self_2->buildrequires, modulemd_strcmp_wrapper);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp = modulemd_hash_table_compare (
+    self_1->requires, self_2->requires, modulemd_strcmp_wrapper);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp = modulemd_buildopts_compare (self_1->buildopts, self_2->buildopts);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  return 0;
+}

modulemd/modulemd-buildopts.c

@@ -82,6 +82,52 @@ modulemd_buildopts_equals (ModulemdBuildopts *self_1,
   return TRUE;
 }
 
+gint
+modulemd_buildopts_compare (ModulemdBuildopts *self_1,
+                            ModulemdBuildopts *self_2)
+{
+  gint cmp;
+
+  if (!self_1 && !self_2)
+    {
+      return 0;
+    }
+
+  if (!self_1)
+    {
+      return -1;
+    }
+
+  if (!self_2)
+    {
+      return 1;
+    }
+
+  g_return_val_if_fail (MODULEMD_IS_BUILDOPTS (self_1), 1);
+  g_return_val_if_fail (MODULEMD_IS_BUILDOPTS (self_2), -1);
+
+  cmp = g_strcmp0 (self_1->rpm_macros, self_2->rpm_macros);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp =
+    modulemd_hash_table_compare (self_1->whitelist, self_2->whitelist, NULL);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  cmp = modulemd_hash_table_compare (self_1->arches, self_2->arches, NULL);
+  if (cmp != 0)
+    {
+      return cmp;
+    }
+
+  return 0;
+}
+
 
 ModulemdBuildopts *
 modulemd_buildopts_new (void)

modulemd/modulemd-obsoletes.c

@@ -1166,8 +1166,7 @@ modulemd_obsoletes_emit_yaml (ModulemdObsoletes *self,
           g_set_error (error,
                        MODULEMD_ERROR,
                        MMD_ERROR_VALIDATE,
-                       "Cannot convert eol_date: %" PRIu64
-                       " to iso8601 date.",
+                       "Cannot convert eol_date: %" PRIu64 " to iso8601 date.",
                        eol_date);
           return FALSE;
         }

modulemd/modulemd-util.c

@@ -233,12 +233,80 @@ modulemd_hash_table_equals (GHashTable *a,
   return TRUE;
 }
 
+
+gint
+modulemd_hash_table_compare (GHashTable *a,
+                             GHashTable *b,
+                             GCompareFunc value_compare_func)
+{
+  g_autoptr (GPtrArray) set_a = NULL;
+  g_autoptr (GPtrArray) set_b = NULL;
+  int i = 0;
+  gchar *key = NULL;
+  gchar *value_a = NULL;
+  gchar *value_b = NULL;
+  gint cmp;
+
+  /* Get the ordered list of keys from each hashtable. */
+  set_a = modulemd_ordered_str_keys (a, modulemd_strcmp_sort);
+  set_b = modulemd_ordered_str_keys (b, modulemd_strcmp_sort);
+
+  for (i = 0; i < set_a->len; i++)
+    {
+      /* If we ran out of elements in the second set, it is shorter and thus the
+       * lesser one.
+       */
+      if (i >= set_b->len)
+        {
+          return 1;
+        }
+
+      /* Compare the keys. */
+      cmp =
+        g_strcmp0 (g_ptr_array_index (set_a, i), g_ptr_array_index (set_b, i));
+      if (cmp != 0)
+        {
+          return cmp;
+        }
+
+      /* If the keys match, compare the values if needed. */
+      if (value_compare_func)
+        {
+          key = g_ptr_array_index (set_a, i);
+          value_a = g_hash_table_lookup (a, key);
+          value_b = g_hash_table_lookup (b, key);
+          cmp = value_compare_func (value_a, value_b);
+          if (cmp != 0)
+            {
+              return cmp;
+            }
+        }
+    }
+
+  /* If everything has been the same so far but there are more elements in the
+   * second set, it is longer and thus the greater one.
+   */
+  if (set_a->len < set_b->len)
+    {
+      return -1;
+    }
+
+  /* If we made it this far, they are equal. */
+  return 0;
+}
+
 gint
 modulemd_strcmp_sort (gconstpointer a, gconstpointer b)
 {
   return g_strcmp0 (*(const gchar **)a, *(const gchar **)b);
 }
 
+gint
+modulemd_strcmp_wrapper (gconstpointer a, gconstpointer b)
+{
+  return g_strcmp0 ((gchar *)a, (gchar *)b);
+}
+
 GPtrArray *
 modulemd_ordered_str_keys (GHashTable *htable, GCompareFunc compare_func)
 {