File 0001-Add-g_option_context_parse_utf8.patch of Package mingw32-glib2

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-Add-g_option_context_parse_utf8.patch of Package mingw32-glib2 (Revision 6b992d2931537ba53ffb495f229c3d47)

Currently displaying revision 6b992d2931537ba53ffb495f229c3d47 , Show latest

From 065bd514cb4b9bd0d8625d1a2a09532a0586dac2 Mon Sep 17 00:00:00 2001
From: Christian Persch <chpe@gnome.org>
Date: Thu, 3 Jun 2010 15:15:43 +0200
Subject: [PATCH 1/3] Add g_option_context_parse_utf8
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This patch implements g_option_context_parse_utf()
along the lines of comment 63.

Contrary to the original patch (attachment 116044) I decided that
FILENAME arguments in UTF-8 mode should get the same treatment as in
non-UTF-8 mode, that is they get the exact argument string, and *not*
the string converted to filename encoding, since there's no guarantee it
will be representable in it.

Based on the patches by Tor Lillqvist and Krzysztof Kosiński.

Bug #522131.
---
 docs/reference/glib/glib-sections.txt |    1 +
 glib/glib.symbols                     |    1 +
 glib/goption.c                        |  222 +++++++++++++++++++++------------
 glib/goption.h                        |    5 +
 glib/tests/option-context.c           |  125 ++++++++++++++++++
 5 files changed, 277 insertions(+), 77 deletions(-)

diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index cdd0a2e..5810f68 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -1091,6 +1091,7 @@ g_option_context_set_translate_func
 g_option_context_set_translation_domain
 g_option_context_free
 g_option_context_parse
+g_option_context_parse_utf8
 g_option_context_set_help_enabled
 g_option_context_get_help_enabled
 g_option_context_set_ignore_unknown_options
diff --git a/glib/glib.symbols b/glib/glib.symbols
index 62abfa8..87e9d65 100644
--- a/glib/glib.symbols
+++ b/glib/glib.symbols
@@ -845,6 +845,7 @@ g_option_context_get_main_group
 g_option_context_get_summary
 g_option_context_new
 g_option_context_parse
+g_option_context_parse_utf8
 g_option_context_set_description
 g_option_context_set_help_enabled
 g_option_context_set_ignore_unknown_options
diff --git a/glib/goption.c b/glib/goption.c
index 9747d47..b8c1f71 100644
--- a/glib/goption.c
+++ b/glib/goption.c
@@ -1118,13 +1118,38 @@ add_pending_null (GOptionContext *context,
 
   context->pending_nulls = g_list_prepend (context->pending_nulls, n);
 }
-		  
+
+static gchar *
+get_string_arg (const gchar *value,
+                gboolean     utf8_flag,
+                GError     **error)
+{
+  if (utf8_flag)
+    return g_strdup (value);
+
+  return g_locale_to_utf8 (value, -1, NULL, NULL, error);
+}
+
+static gchar *
+get_filename_arg (const gchar *value,
+                  gboolean     utf8_flag,
+                  GError     **error)
+{
+#ifdef G_OS_WIN32
+  if (!utf8_flag)
+    return g_locale_to_utf8 (value, -1, NULL, NULL, error);
+#endif
+
+  return g_strdup (value);
+}
+
 static gboolean
 parse_arg (GOptionContext *context,
 	   GOptionGroup   *group,
 	   GOptionEntry   *entry,
 	   const gchar    *value,
 	   const gchar    *option_name,
+	   gboolean        utf8_flag,
 	   GError        **error)
      
 {
@@ -1145,9 +1170,8 @@ parse_arg (GOptionContext *context,
     case G_OPTION_ARG_STRING:
       {
 	gchar *data;
-	
-	data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 
+	data = get_string_arg (value, utf8_flag, error);
 	if (!data)
 	  return FALSE;
 
@@ -1165,8 +1189,7 @@ parse_arg (GOptionContext *context,
       {
 	gchar *data;
 
-	data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
-
+	data = get_string_arg (value, utf8_flag, error);
 	if (!data)
 	  return FALSE;
 
@@ -1197,14 +1220,10 @@ parse_arg (GOptionContext *context,
       {
 	gchar *data;
 
-#ifdef G_OS_WIN32
-	data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
-	
+	data = get_filename_arg (value, utf8_flag, error);
 	if (!data)
 	  return FALSE;
-#else
-	data = g_strdup (value);
-#endif
+
 	change = get_change (context, G_OPTION_ARG_FILENAME,
 			     entry->arg_data);
 	g_free (change->allocated.str);
@@ -1220,14 +1239,10 @@ parse_arg (GOptionContext *context,
       {
 	gchar *data;
 	
-#ifdef G_OS_WIN32
-	data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
-	
+	data = get_filename_arg (value, utf8_flag, error);
 	if (!data)
 	  return FALSE;
-#else
-	data = g_strdup (value);
-#endif
+
 	change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
 			     entry->arg_data);
 
@@ -1276,15 +1291,9 @@ parse_arg (GOptionContext *context,
 	else if (entry->flags & G_OPTION_FLAG_NO_ARG)
 	  data = NULL;
 	else if (entry->flags & G_OPTION_FLAG_FILENAME)
-	  {
-#ifdef G_OS_WIN32
-  	    data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
-#else
-	    data = g_strdup (value);
-#endif
-	  }
+	  data = get_filename_arg (value, utf8_flag, error);
 	else
-	  data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
+	  data = get_string_arg (value, utf8_flag, error);
 
 	if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) && 
 	    !data)
@@ -1350,6 +1359,7 @@ parse_short_option (GOptionContext *context,
 		    gint            idx,
 		    gint           *new_idx,
 		    gchar           arg,
+		    gboolean        utf8_flag,
 		    gint           *argc,
 		    gchar        ***argv,
 		    GError        **error,
@@ -1412,7 +1422,7 @@ parse_short_option (GOptionContext *context,
 	    }
 
 	  if (!parse_arg (context, group, &group->entries[j], 
-			  value, option_name, error))
+			  value, option_name, utf8_flag, error))
 	    {
 	      g_free (option_name);
 	      return FALSE;
@@ -1432,6 +1442,7 @@ parse_long_option (GOptionContext *context,
 		   gint           *idx,
 		   gchar          *arg,
 		   gboolean        aliased,
+		   gboolean        utf8_flag,
 		   gint           *argc,
 		   gchar        ***argv,
 		   GError        **error,
@@ -1455,7 +1466,7 @@ parse_long_option (GOptionContext *context,
 
 	  option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
 	  retval = parse_arg (context, group, &group->entries[j],
-			      NULL, option_name, error);
+			      NULL, option_name, utf8_flag, error);
 	  g_free(option_name);
 	  
 	  add_pending_null (context, &((*argv)[*idx]), NULL);
@@ -1492,7 +1503,7 @@ parse_long_option (GOptionContext *context,
 		        {
 		          gboolean retval;
 		          retval = parse_arg (context, group, &group->entries[j],
-					      NULL, option_name, error);
+					      NULL, option_name, utf8_flag, error);
 	  	          *parsed = TRUE;
 		          g_free (option_name);
 	   	          return retval;
@@ -1510,7 +1521,7 @@ parse_long_option (GOptionContext *context,
 		{
 		    gboolean retval;
 		    retval = parse_arg (context, group, &group->entries[j],
-					NULL, option_name, error);
+					NULL, option_name, utf8_flag, error);
 	  	    *parsed = TRUE;
 		    g_free (option_name);
 	   	    return retval;
@@ -1525,7 +1536,7 @@ parse_long_option (GOptionContext *context,
 		}
 
 	      if (!parse_arg (context, group, &group->entries[j], 
-			      value, option_name, error))
+			      value, option_name, utf8_flag, error))
 		{
 		  g_free (option_name);
 		  return FALSE;
@@ -1543,6 +1554,7 @@ parse_long_option (GOptionContext *context,
 static gboolean
 parse_remaining_arg (GOptionContext *context,
 		     GOptionGroup   *group,
+		     gboolean        utf8_flag,
 		     gint           *idx,
 		     gint           *argc,
 		     gchar        ***argv,
@@ -1565,7 +1577,7 @@ parse_remaining_arg (GOptionContext *context,
       
       add_pending_null (context, &((*argv)[*idx]), NULL);
       
-      if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
+      if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", utf8_flag, error))
 	return FALSE;
       
       *parsed = TRUE;
@@ -1653,46 +1665,12 @@ free_pending_nulls (GOptionContext *context,
   context->pending_nulls = NULL;
 }
 
-/**
- * g_option_context_parse:
- * @context: a #GOptionContext
- * @argc: a pointer to the number of command line arguments
- * @argv: a pointer to the array of command line arguments
- * @error: a return location for errors 
- * 
- * Parses the command line arguments, recognizing options
- * which have been added to @context. A side-effect of 
- * calling this function is that g_set_prgname() will be
- * called.
- *
- * If the parsing is successful, any parsed arguments are
- * removed from the array and @argc and @argv are updated 
- * accordingly. A '--' option is stripped from @argv
- * unless there are unparsed options before and after it, 
- * or some of the options after it start with '-'. In case 
- * of an error, @argc and @argv are left unmodified. 
- *
- * If automatic <option>--help</option> support is enabled
- * (see g_option_context_set_help_enabled()), and the 
- * @argv array contains one of the recognized help options,
- * this function will produce help output to stdout and
- * call <literal>exit (0)</literal>.
- *
- * Note that function depends on the 
- * <link linkend="setlocale">current locale</link> for 
- * automatic character set conversion of string and filename
- * arguments.
- * 
- * Return value: %TRUE if the parsing was successful, 
- *               %FALSE if an error occurred
- *
- * Since: 2.6
- **/
-gboolean
-g_option_context_parse (GOptionContext   *context,
-			gint             *argc,
-			gchar          ***argv,
-			GError          **error)
+static gboolean
+option_context_parse_internal (GOptionContext   *context,
+			       gboolean          utf8_flag,
+			       gint             *argc,
+			       gchar          ***argv,
+			       GError          **error)
 {
   gint i, j, k;
   GList *list;
@@ -1787,7 +1765,7 @@ g_option_context_parse (GOptionContext   *context,
 
 		  if (context->main_group &&
 		      !parse_long_option (context, context->main_group, &i, arg,
-					  FALSE, argc, argv, error, &parsed))
+					  FALSE, utf8_flag, argc, argv, error, &parsed))
 		    goto fail;
 
 		  if (parsed)
@@ -1800,7 +1778,7 @@ g_option_context_parse (GOptionContext   *context,
 		      GOptionGroup *group = list->data;
 		      
 		      if (!parse_long_option (context, group, &i, arg, 
-					      FALSE, argc, argv, error, &parsed))
+					      FALSE, utf8_flag, argc, argv, error, &parsed))
 			goto fail;
 		      
 		      if (parsed)
@@ -1825,7 +1803,7 @@ g_option_context_parse (GOptionContext   *context,
 			  if (strncmp (group->name, arg, dash - arg) == 0)
 			    {
 			      if (!parse_long_option (context, group, &i, dash + 1,
-						      TRUE, argc, argv, error, &parsed))
+						      TRUE, utf8_flag, argc, argv, error, &parsed))
 				goto fail;
 			      
 			      if (parsed)
@@ -1856,7 +1834,7 @@ g_option_context_parse (GOptionContext   *context,
                       parsed = FALSE;
 		      if (context->main_group &&
 			  !parse_short_option (context, context->main_group,
-					       i, &new_i, arg[j],
+					       i, &new_i, arg[j], utf8_flag,
 					       argc, argv, error, &parsed))
                         goto fail;
 		      if (!parsed)
@@ -1867,7 +1845,7 @@ g_option_context_parse (GOptionContext   *context,
 			    {
 			      GOptionGroup *group = list->data;
 			      if (!parse_short_option (context, group, i, &new_i, arg[j],
-						       argc, argv, error, &parsed))
+						       utf8_flag, argc, argv, error, &parsed))
 				goto fail;
 			      if (parsed)
 				break;
@@ -1922,7 +1900,7 @@ g_option_context_parse (GOptionContext   *context,
 	    {
 	      /* Collect remaining args */
 	      if (context->main_group &&
-		  !parse_remaining_arg (context, context->main_group, &i,
+		  !parse_remaining_arg (context, context->main_group, utf8_flag, &i,
 					argc, argv, error, &parsed))
 		goto fail;
 	      
@@ -2008,7 +1986,97 @@ g_option_context_parse (GOptionContext   *context,
 
   return FALSE;
 }
+
+/**
+ * g_option_context_parse:
+ * @context: a #GOptionContext
+ * @argc: (inout): a pointer to the number of command line arguments
+ * @argv: (inout) (array lenth=argc) (element-type filename): a pointer to an array of command line arguments
+ * @error: (allow-none): a location to store a #GError, or %NULL
+ *
+ * Parses the command line arguments, recognizing options
+ * which have been added to @context. A side-effect of
+ * calling this function is that g_set_prgname() will be
+ * called.
+ *
+ * If the parsing is successful, any parsed arguments are
+ * removed from the array and @argc and @argv are updated
+ * accordingly. A '--' option is stripped from @argv
+ * unless there are unparsed options before and after it,
+ * or some of the options after it start with '-'. In case
+ * of an error, @argc and @argv are left unmodified.
+ *
+ * If automatic <option>--help</option> support is enabled
+ * (see g_option_context_set_help_enabled()), and the
+ * @argv array contains one of the recognized help options,
+ * this function will produce help output to stdout and
+ * call <literal>exit (0)</literal>.
+ *
+ * Note that function depends on the
+ * <link linkend="setlocale">current locale</link> for
+ * automatic character set conversion of string and filename
+ * arguments.
+ *
+ * Return value: %TRUE if the parsing was successful,
+ *               %FALSE if an error occurred
+ *
+ * Since: 2.6
+ **/
+gboolean
+g_option_context_parse (GOptionContext   *context,
+			gint             *argc,
+			gchar          ***argv,
+			GError          **error)
+{
+  return option_context_parse_internal (context, FALSE, argc, argv, error);
+}
+
+/**
+ * g_option_context_parse_utf8:
+ * @context: a #GOptionContext
+ * @argc: (inout): a pointer to the number of strings in @argv
+ * @argv: (inout) (array length=argc) (element-type utf-8): a pointer to an array of UTF-8 strings
+ * @error: (allow-none): a location to store a #GError, or %NULL
+ *
+ * A variant of g_option_context_parse() that treats @argv as an
+ * array of UTF-8 strings.
+ *
+ * This function is suitable for use with the wide arguments array
+ * returned from g_win32_get_wargv().
+ *
+ * Note that arguments for %G_OPTION_ARG_FILENAME and
+ * %G_OPTION_ARG_FILENAME_ARRAY options, and %G_OPTION_ARG_CALLBACK
+ * options with %G_OPTION_FLAG_FILENAME will be passed the unchanged
+ * UTF-8 strings, and not strings converted to filename encoding
+ * (see g_filename_from_utf8()).
+ *
+ * Return value: %TRUE if the parsing was successful,
+ *               %FALSE if an error occurred
+ *
+ * Since: 2.26
+ **/
+gboolean
+g_option_context_parse_utf8 (GOptionContext   *context,
+                             gint             *argc,
+                             gchar          ***argv,
+                             GError          **error)
 				   
+{
+  gint i;
+
+  for (i = 0; i < *argc; ++i)
+    {
+      if (!g_utf8_validate ((*argv)[i], -1, NULL))
+        {
+          g_set_error (error, G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
+                       "Argument is not UTF-8");
+          return FALSE;
+        }
+    }
+
+  return option_context_parse_internal (context, TRUE, argc, argv, error);
+}
+
 /**
  * g_option_group_new:
  * @name: the name for the option group, this is used to provide
diff --git a/glib/goption.h b/glib/goption.h
index 557d8f7..01d6ef8 100644
--- a/glib/goption.h
+++ b/glib/goption.h
@@ -329,6 +329,11 @@ gboolean        g_option_context_parse            (GOptionContext      *context,
 						   gint                *argc,
 						   gchar             ***argv,
 						   GError             **error);
+gboolean	g_option_context_parse_utf8       (GOptionContext      *context,
+						   gint                *argc,
+						   gchar             ***argv,
+						   GError             **error);
+
 void            g_option_context_set_translate_func (GOptionContext     *context,
 						     GTranslateFunc      func,
 						     gpointer            data,
diff --git a/glib/tests/option-context.c b/glib/tests/option-context.c
index 913ad5c..ee28d6e 100644
--- a/glib/tests/option-context.c
+++ b/glib/tests/option-context.c
@@ -1717,6 +1717,126 @@ missing_arg_test (void)
   g_option_context_free (context);
 }
 
+static void
+utf8_test_invalid (void)
+{
+  GOptionContext *context;
+  gboolean retval;
+  GError *error = NULL;
+  gchar **argv;
+  int argc;
+  gchar *arg = NULL;
+  GOptionEntry entries [] =
+    { { "test", 't', 0, G_OPTION_ARG_STRING, &arg, NULL, NULL },
+      { NULL } };
+
+  context = g_option_context_new (NULL);
+  g_option_context_add_main_entries (context, entries, NULL);
+
+  /* Now try parsing */
+  argv = split_string ("program --test \xdf", &argc);
+
+  retval = g_option_context_parse_utf8 (context, &argc, &argv, &error);
+  g_assert_error (error, G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE);
+  g_clear_error (&error);
+
+  g_strfreev (argv);
+  g_option_context_free (context);
+}
+
+static void
+utf8_test_arg_string (void)
+{
+  GOptionContext *context;
+  gboolean retval;
+  GError *error = NULL;
+  gchar **argv;
+  const gchar *locale;
+  int argc;
+  gchar *arg = NULL;
+  GOptionEntry entries [] =
+    { { "string", 's', 0, G_OPTION_ARG_STRING, &arg, NULL, NULL },
+      { NULL } };
+
+  context = g_option_context_new (NULL);
+  g_option_context_add_main_entries (context, entries, NULL);
+
+  /* Now try parsing */
+  argv = split_string ("program --string \341\272\236", &argc);
+
+  retval = g_option_context_parse_utf8 (context, &argc, &argv, &error);
+  g_assert_no_error (error);
+
+  g_assert_cmpstr (arg, ==, "\341\272\236");
+  g_free (arg);
+  arg = NULL;
+
+  g_strfreev (argv);
+
+  /* Check that parsing is locale independent */
+  argv = split_string ("program --string \341\272\236", &argc);
+
+  locale = setlocale (LC_ALL, "de_DE.ISO-8859-1");
+
+  retval = g_option_context_parse_utf8 (context, &argc, &argv, &error);
+  g_assert_no_error (error);
+
+  g_assert_cmpstr (arg, ==, "\341\272\236");
+  g_free (arg);
+
+  setlocale (LC_ALL, locale);
+
+  g_strfreev (argv);
+
+  g_option_context_free (context);
+}
+
+static void
+utf8_test_arg_filename (void)
+{
+  GOptionContext *context;
+  gboolean retval;
+  GError *error = NULL;
+  gchar **argv;
+  const gchar *locale;
+  int argc;
+  gchar *arg = NULL;
+  GOptionEntry entries [] =
+    { { "filename", 'f', 0, G_OPTION_ARG_FILENAME, &arg, NULL, NULL },
+      { NULL } };
+
+  context = g_option_context_new (NULL);
+  g_option_context_add_main_entries (context, entries, NULL);
+
+  /* Now try parsing */
+  argv = split_string ("program --filename \341\272\236", &argc);
+
+  retval = g_option_context_parse_utf8 (context, &argc, &argv, &error);
+  g_assert_no_error (error);
+
+  g_assert_cmpstr (arg, ==, "\341\272\236");
+  g_free (arg);
+
+  g_strfreev (argv);
+
+  /* Check that parsing is locale independent */
+  argv = split_string ("program --filename \341\272\236", &argc);
+
+  locale = setlocale (LC_ALL, "de_DE.ISO-8859-1");
+
+  retval = g_option_context_parse_utf8 (context, &argc, &argv, &error);
+  g_assert_no_error (error);
+
+  g_assert_cmpstr (arg, ==, "\341\272\236");
+  g_free (arg);
+
+  setlocale (LC_ALL, locale);
+
+  g_strfreev (argv);
+
+  g_option_context_free (context);
+}
+
 int
 main (int   argc,
       char *argv[])
@@ -1790,5 +1910,10 @@ main (int   argc,
   g_test_add_func ("/bug/lonely-dash", lonely_dash_test);
   g_test_add_func ("/bug/missing-arg", missing_arg_test);
 
+  /* UTF-8 parsing */
+  g_test_add_func ("/utf8/invalid", utf8_test_invalid);
+  g_test_add_func ("/utf8/arg/string", utf8_test_arg_string);
+  g_test_add_func ("/utf8/arg/filename", utf8_test_arg_filename);
+
   return g_test_run();
 }
-- 
1.6.4.2

Places

File 0001-Add-g_option_context_parse_utf8.patch of Package mingw32-glib2 (Revision 6b992d2931537ba53ffb495f229c3d47)

Places