[glib/gvariant] Increase consistency of GVariant function names



commit b2ad0e859c4b3189bb549d4892ddf736b0be9b3f
Author: Ryan Lortie <desrt desrt ca>
Date:   Sun Jun 14 13:33:07 2009 -0400

    Increase consistency of GVariant function names
    
      g_variant_get_child -> g_variant_get_child_value
      g_variant_iter_next -> g_variant_iter_next_value
      g_variant_iterate -> g_variant_iter_next
    
    In general, a function that returns a child GVariant * should be
    called a name the ends with _value.

 docs/reference/glib/glib-sections.txt |    6 +-
 glib/glib.symbols                     |    6 +-
 glib/gvariant-core.c                  |    6 +-
 glib/gvariant-markup.c                |   12 +++---
 glib/gvariant-util.c                  |   12 +++---
 glib/gvariant-valist.c                |   18 ++++----
 glib/gvariant.h                       |    6 +-
 glib/tests/gvariant-big.c             |    4 +-
 glib/tests/gvariant-varargs.c         |   66 ++++++++++++++++----------------
 9 files changed, 68 insertions(+), 68 deletions(-)
---
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 18c350a..87ac97d 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -2782,7 +2782,7 @@ g_variant_dup_strv
 
 <SUBSECTION>
 g_variant_n_children
-g_variant_get_child
+g_variant_get_child_value
 g_variant_get_fixed
 g_variant_get_fixed_array
 
@@ -2797,9 +2797,9 @@ g_variant_format_string_scan
 GVariantIter
 g_variant_iter_cancel
 g_variant_iter_init
-g_variant_iter_next
+g_variant_iter_next_value
 g_variant_iter_was_cancelled
-g_variant_iterate
+g_variant_iter_next
 
 <SUBSECTION>
 GVariantBuilder
diff --git a/glib/glib.symbols b/glib/glib.symbols
index 23473a5..1c18185 100644
--- a/glib/glib.symbols
+++ b/glib/glib.symbols
@@ -1625,7 +1625,7 @@ g_variant_ref_sink
 g_variant_unref
 g_variant_get_fixed
 g_variant_get_fixed_array
-g_variant_get_child
+g_variant_get_child_value
 g_variant_n_children
 g_variant_get_type
 #endif
@@ -1668,7 +1668,7 @@ g_variant_get_variant
 g_variant_get_strv
 g_variant_dup_strv
 g_variant_iter_init
-g_variant_iter_next
+g_variant_iter_next_value
 g_variant_iter_cancel
 g_variant_iter_was_cancelled
 g_variant_builder_add_value
@@ -1691,7 +1691,7 @@ g_variant_markup_parse
 #endif
 
 #if IN_FILE(_gvariant_valist_c_)
-g_variant_iterate
+g_variant_iter_next
 g_variant_builder_add
 g_variant_new
 g_variant_get
diff --git a/glib/gvariant-core.c b/glib/gvariant-core.c
index dd018e9..0dda068 100644
--- a/glib/gvariant-core.c
+++ b/glib/gvariant-core.c
@@ -932,7 +932,7 @@ g_variant_n_children (GVariant *value)
 }
 
 /**
- * g_variant_get_child:
+ * g_variant_get_child_value:
  * @value: a container #GVariant
  * @index: the index of the child to fetch
  * @returns: the child at the specified index
@@ -948,8 +948,8 @@ g_variant_n_children (GVariant *value)
  * This function never fails.
  **/
 GVariant *
-g_variant_get_child (GVariant *value,
-                     gsize     index)
+g_variant_get_child_value (GVariant *value,
+                           gsize     index)
 {
   GVariant *child;
 
diff --git a/glib/gvariant-markup.c b/glib/gvariant-markup.c
index da6e7e7..03356c8 100644
--- a/glib/gvariant-markup.c
+++ b/glib/gvariant-markup.c
@@ -119,7 +119,7 @@ g_variant_markup_print (GVariant *value,
             g_string_append (string, "<maybe>");
             g_variant_markup_newline (string, newlines);
 
-            element = g_variant_get_child (value, 0);
+            element = g_variant_get_child_value (value, 0);
             g_variant_markup_print (element, string,
                                     newlines, indentation, tabstop);
             g_variant_unref (element);
@@ -145,7 +145,7 @@ g_variant_markup_print (GVariant *value,
             g_string_append (string, "<array>");
             g_variant_markup_newline (string, newlines);
 
-            while ((element = g_variant_iter_next (&iter)))
+            while ((element = g_variant_iter_next_value (&iter)))
               g_variant_markup_print (element, string,
                                       newlines, indentation, tabstop);
 
@@ -170,7 +170,7 @@ g_variant_markup_print (GVariant *value,
             g_string_append (string, "<struct>");
             g_variant_markup_newline (string, newlines);
 
-            while ((element = g_variant_iter_next (&iter)))
+            while ((element = g_variant_iter_next_value (&iter)))
               g_variant_markup_print (element, string,
                                       newlines, indentation, tabstop);
 
@@ -192,7 +192,7 @@ g_variant_markup_print (GVariant *value,
         g_variant_markup_newline (string, newlines);
 
         g_variant_iter_init (&iter, value);
-        while ((element = g_variant_iter_next (&iter)))
+        while ((element = g_variant_iter_next_value (&iter)))
           g_variant_markup_print (element, string,
                                   newlines, indentation, tabstop);
 
@@ -356,7 +356,7 @@ g_variant_parse_data_end (GVariantParseData  *data,
   variant = g_variant_builder_end (data->builder);
   data->builder = NULL;
 
-  value = g_variant_get_child (variant, 0);
+  value = g_variant_get_child_value (variant, 0);
   g_variant_unref (variant);
 
   if (and_free)
@@ -906,7 +906,7 @@ g_variant_markup_parse (const gchar         *text,
   value = g_variant_builder_end (data->builder);
   g_slice_free (GVariantParseData, data);
 
-  child = g_variant_get_child (value, 0);
+  child = g_variant_get_child_value (value, 0);
   g_variant_unref (value);
 
   return child;
diff --git a/glib/gvariant-util.c b/glib/gvariant-util.c
index aa86c1f..56ba795 100644
--- a/glib/gvariant-util.c
+++ b/glib/gvariant-util.c
@@ -102,7 +102,7 @@ g_variant_iter_init (GVariantIter *iter,
  * which case %NULL is returned and nothing else happens.
  **/
 GVariant *
-g_variant_iter_next (GVariantIter *iter)
+g_variant_iter_next_value (GVariantIter *iter)
 {
   GVariantIterReal *real = (GVariantIterReal *) iter;
 
@@ -115,7 +115,7 @@ g_variant_iter_next (GVariantIter *iter)
   if (real->value == NULL)
     return NULL;
 
-  real->child = g_variant_get_child (real->value, real->offset++);
+  real->child = g_variant_get_child_value (real->value, real->offset++);
 
   if (real->offset == real->length)
     {
@@ -802,7 +802,7 @@ g_variant_get_variant (GVariant *value)
 {
   g_assert (g_variant_matches (value, G_VARIANT_TYPE_VARIANT));
 
-  return g_variant_get_child (value, 0);
+  return g_variant_get_child_value (value, 0);
 }
 
 /**
@@ -1752,7 +1752,7 @@ g_variant_deep_copy (GVariant *value)
                                          g_variant_get_type (value));
         g_variant_iter_init (&iter, value);
 
-        while ((child = g_variant_iter_next (&iter)))
+        while ((child = g_variant_iter_next_value (&iter)))
           g_variant_builder_add_value (builder, g_variant_deep_copy (child));
 
         return g_variant_builder_end (builder);
@@ -1827,7 +1827,7 @@ g_variant_get_strv (GVariant *value,
 
   for (i = 0; i < my_length; i++)
     {
-      GVariant *child = g_variant_get_child (value, i);
+      GVariant *child = g_variant_get_child_value (value, i);
       result[i] = g_variant_get_string (child, NULL);
       g_variant_unref (child);
     }
@@ -1874,7 +1874,7 @@ g_variant_dup_strv (GVariant *value,
 
   for (i = 0; i < my_length; i++)
     {
-      GVariant *child = g_variant_get_child (value, i);
+      GVariant *child = g_variant_get_child_value (value, i);
       result[i] = g_variant_dup_string (child, NULL);
       g_variant_unref (child);
     }
diff --git a/glib/gvariant-valist.c b/glib/gvariant-valist.c
index e31a11c..5d85aef 100644
--- a/glib/gvariant-valist.c
+++ b/glib/gvariant-valist.c
@@ -753,7 +753,7 @@ g_variant_valist_get (GVariant     *value,
         GVariant *just;
 
         if (value && g_variant_n_children (value))
-          just = g_variant_get_child (value, 0);
+          just = g_variant_get_child_value (value, 0);
         else
           just = NULL;
 
@@ -799,7 +799,7 @@ g_variant_valist_get (GVariant     *value,
           {
             if (value)
               {
-                child = g_variant_iter_next (&iter);
+                child = g_variant_iter_next_value (&iter);
                 g_assert (child != NULL);
               }
             else
@@ -811,7 +811,7 @@ g_variant_valist_get (GVariant     *value,
 
         if (value)
           {
-            child = g_variant_iter_next (&iter);
+            child = g_variant_iter_next_value (&iter);
             g_assert (child == NULL);
           }
 
@@ -1308,7 +1308,7 @@ g_variant_get_va (GVariant     *value,
 }
 
 /**
- * g_variant_iterate:
+ * g_variant_iter_next:
  * @iter: a #GVariantIter
  * @format_string: a format string
  * @...: arguments, as per @format_string
@@ -1336,22 +1336,22 @@ g_variant_get_va (GVariant     *value,
  *   GVariantIter iter;
  *   ...
  *
- *   while (g_variant_iterate (iter, "{ss}", &key, &value))
+ *   while (g_variant_iter_next (iter, "{ss}", &key, &value))
  *     printf ("dict['%s'] = '%s'\n", key, value);
  * }
  * </programlisting>
  **/
 gboolean
-g_variant_iterate (GVariantIter *iter,
-                   const gchar  *format_string,
-                   ...)
+g_variant_iter_next (GVariantIter *iter,
+                     const gchar  *format_string,
+                     ...)
 {
   gboolean free_args;
   GVariant *next;
   va_list ap;
 
   free_args = g_variant_iter_should_free (iter);
-  next = g_variant_iter_next (iter);
+  next = g_variant_iter_next_value (iter);
   /* g_assert (free_args || next != NULL);
    * XXX this fails on empty iters */
 
diff --git a/glib/gvariant.h b/glib/gvariant.h
index 9356bf1..bebe9b0 100644
--- a/glib/gvariant.h
+++ b/glib/gvariant.h
@@ -100,17 +100,17 @@ gconstpointer                   g_variant_get_fixed                     (GVarian
 gconstpointer                   g_variant_get_fixed_array               (GVariant             *value,
                                                                          gsize                 elem_size,
                                                                          gsize                *length);
-GVariant                       *g_variant_get_child                     (GVariant             *value,
+GVariant                       *g_variant_get_child_value               (GVariant             *value,
                                                                          gsize                 index);
 gsize                           g_variant_n_children                    (GVariant             *value);
 
 /* GVariantIter */
 gsize                           g_variant_iter_init                     (GVariantIter         *iter,
                                                                          GVariant             *value);
-GVariant                       *g_variant_iter_next                     (GVariantIter         *iter);
+GVariant                       *g_variant_iter_next_value               (GVariantIter         *iter);
 void                            g_variant_iter_cancel                   (GVariantIter         *iter);
 gboolean                        g_variant_iter_was_cancelled            (GVariantIter         *iter);
-gboolean                        g_variant_iterate                       (GVariantIter         *iter,
+gboolean                        g_variant_iter_next                     (GVariantIter         *iter,
                                                                          const gchar          *format_string,
                                                                          ...);
 
diff --git a/glib/tests/gvariant-big.c b/glib/tests/gvariant-big.c
index 3bc1e7c..ddaaa42 100644
--- a/glib/tests/gvariant-big.c
+++ b/glib/tests/gvariant-big.c
@@ -41,7 +41,7 @@ verify2 (GVariant *value,
   g_assert_cmpint (actual, ==, length);
 
   actual = 0;
-  while ((child = g_variant_iter_next (&iter)))
+  while ((child = g_variant_iter_next_value (&iter)))
     {
       switch (class)
         {
@@ -169,7 +169,7 @@ verify (GVariant *value,
   g_assert_cmpint (actual, ==, length);
   actual = 0;
 
-  while ((child = g_variant_iter_next (&iter)))
+  while ((child = g_variant_iter_next_value (&iter)))
     {
       verify2 (g_variant_get_variant (child), rand);
       actual++;
diff --git a/glib/tests/gvariant-varargs.c b/glib/tests/gvariant-varargs.c
index f0d0621..5a6b1d7 100644
--- a/glib/tests/gvariant-varargs.c
+++ b/glib/tests/gvariant-varargs.c
@@ -122,25 +122,25 @@ test_iterate (void)
   first = TRUE;
   count = 0;
 
-  while (g_variant_iterate (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
-                                   "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
-                                   &boolean, &byte, /* by */
+  while (g_variant_iter_next (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
+                                     "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
+                                     &boolean, &byte, /* by */
 
-                                   &is_just, &int16, &uint16, &int32,
-                                             &uint32, &string, &one,
+                                     &is_just, &int16, &uint16, &int32,
+                                               &uint32, &string, &one,
 
-                                   &int64, &uint64, &floating, /* xtd */
+                                     &int64, &uint64, &floating, /* xtd */
 
-                                   &two, &three, &four, &five, &six, &seven,
-                                   &eight, /* ? s@?* *r@r */
+                                     &two, &three, &four, &five, &six, &seven,
+                                     &eight, /* ? s@?* *r@r */
 
-                                   &fixed_struct,
-                                   &fixed_array, &fixed_array_size,
+                                     &fixed_struct,
+                                     &fixed_array, &fixed_array_size,
 
-                                   &maybe_string, &maybe_one, &maybe_two,
-                                   &maybe_three, &maybe_four, &maybe_five,
+                                     &maybe_string, &maybe_one, &maybe_two,
+                                     &maybe_three, &maybe_four, &maybe_five,
 
-                                   &array, &maybe_array, &maybe_fixed_struct))
+                                     &array, &maybe_array, &maybe_fixed_struct))
     {
       g_assert_cmpint (boolean, ==, TRUE);
       g_assert_cmpint (byte, ==, 0x8c);
@@ -211,7 +211,7 @@ test_iterate (void)
 
           /* access this once, but not the other time, to make sure
            * freeing works in both cases */
-          g_assert (g_variant_iter_next (&array) == NULL);
+          g_assert (g_variant_iter_next_value (&array) == NULL);
         }
 
       first = FALSE;
@@ -233,16 +233,16 @@ test_null (void)
   g_variant_unref (value);
   first = TRUE;
 
-  while (g_variant_iterate (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
-                                   "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
-                                   NULL, NULL,
-                                   &is_just, NULL, NULL, NULL,
-                                             NULL, NULL, NULL,
-                                   NULL, NULL, NULL,
-                                   NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-                                   NULL, NULL, NULL,
-                                   NULL, NULL, NULL, NULL, NULL, NULL,
-                                   NULL, NULL, NULL))
+  while (g_variant_iter_next (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
+                                     "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
+                                     NULL, NULL,
+                                     &is_just, NULL, NULL, NULL,
+                                               NULL, NULL, NULL,
+                                     NULL, NULL, NULL,
+                                     NULL, NULL, NULL, NULL, NULL, NULL, NULL,
+                                     NULL, NULL, NULL,
+                                     NULL, NULL, NULL, NULL, NULL, NULL,
+                                     NULL, NULL, NULL))
     {
       g_assert_cmpint (is_just, ==, first);
       first = FALSE;
@@ -260,17 +260,17 @@ test_totally_null (void)
   g_variant_unref (value);
   count = 0;
 
-  while (g_variant_iterate (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
-                                   "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
-                                   NULL, NULL,
+  while (g_variant_iter_next (&iter, "(bym(nquisv)xtd? s@?* *r@r&(bqutd)"
+                                     "&a(bqutd)msmvm*m?m sm@*anmanm&(bqutd))",
+                                     NULL, NULL,
 
-                                   NULL, /* skip the ones for the struct */
+                                     NULL, /* skip the ones for the struct */
 
-                                   NULL, NULL, NULL,
-                                   NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-                                   NULL, NULL, NULL,
-                                   NULL, NULL, NULL, NULL, NULL, NULL,
-                                   NULL, NULL, NULL))
+                                     NULL, NULL, NULL,
+                                     NULL, NULL, NULL, NULL, NULL, NULL, NULL,
+                                     NULL, NULL, NULL,
+                                     NULL, NULL, NULL, NULL, NULL, NULL,
+                                     NULL, NULL, NULL))
     count++;
 
   g_assert_cmpint (count, ==, 3);



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]