1 /* goption.c - Option parser
3 * Copyright (C) 1999, 2003 Red Hat Software
4 * Copyright (C) 2004 Anders Carlsson <andersca@gnome.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
34 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
60 struct _GOptionContext
64 gchar *parameter_string;
66 gboolean help_enabled;
67 gboolean ignore_unknown;
69 GOptionGroup *main_group;
71 /* We keep a list of change so we can revert them */
74 /* We also keep track of all argv elements that should be NULLed or
84 gchar *help_description;
86 GDestroyNotify destroy_notify;
89 GTranslateFunc translate_func;
90 GDestroyNotify translate_notify;
91 gpointer translate_data;
93 GOptionEntry *entries;
96 GOptionParseFunc pre_parse_func;
97 GOptionParseFunc post_parse_func;
98 GOptionErrorFunc error_func;
101 static void free_changes_list (GOptionContext *context,
103 static void free_pending_nulls (GOptionContext *context,
104 gboolean perform_nulls);
107 g_option_error_quark (void)
112 q = g_quark_from_static_string ("g-option-context-error-quark");
118 * g_option_context_new:
119 * @parameter_string: a string which is displayed in
120 * the first line of <option>--help</option> output, after
121 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
123 * Creates a new option context.
125 * Returns: a newly created #GOptionContext, which must be
126 * freed with g_option_context_free() after use.
131 g_option_context_new (const gchar *parameter_string)
134 GOptionContext *context;
136 context = g_new0 (GOptionContext, 1);
138 context->parameter_string = g_strdup (parameter_string);
139 context->help_enabled = TRUE;
140 context->ignore_unknown = FALSE;
146 * g_option_context_free:
147 * @context: a #GOptionContext
149 * Frees context and all the groups which have been
154 void g_option_context_free (GOptionContext *context)
156 g_return_if_fail (context != NULL);
158 g_list_foreach (context->groups, (GFunc)g_option_group_free, NULL);
159 g_list_free (context->groups);
161 if (context->main_group)
162 g_option_group_free (context->main_group);
164 free_changes_list (context, FALSE);
165 free_pending_nulls (context, FALSE);
167 g_free (context->parameter_string);
174 * g_option_context_set_help_enabled:
175 * @context: a #GOptionContext
176 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
178 * Enables or disables automatic generation of <option>--help</option>
179 * output. By default, g_option_context_parse() recognizes
180 * <option>--help</option>, <option>-?</option>, <option>--help-all</option>
181 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
182 * suitable output to stdout.
186 void g_option_context_set_help_enabled (GOptionContext *context,
187 gboolean help_enabled)
190 g_return_if_fail (context != NULL);
192 context->help_enabled = help_enabled;
196 * g_option_context_get_help_enabled:
197 * @context: a #GOptionContext
199 * Returns whether automatic <option>--help</option> generation
200 * is turned on for @context. See g_option_context_set_help_enabled().
202 * Returns: %TRUE if automatic help generation is turned on.
207 g_option_context_get_help_enabled (GOptionContext *context)
209 g_return_val_if_fail (context != NULL, FALSE);
211 return context->help_enabled;
215 * g_option_context_set_ignore_unknown_options:
216 * @context: a #GOptionContext
217 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
218 * an error when unknown options are met
220 * Sets whether to ignore unknown options or not. If an argument is
221 * ignored, it is left in the @argv array after parsing. By default,
222 * g_option_context_parse() treats unknown options as error.
224 * This setting does not affect non-option arguments (i.e. arguments
225 * which don't start with a dash). But note that GOption cannot reliably
226 * determine whether a non-option belongs to a preceding unknown option.
231 g_option_context_set_ignore_unknown_options (GOptionContext *context,
232 gboolean ignore_unknown)
234 g_return_if_fail (context != NULL);
236 context->ignore_unknown = ignore_unknown;
240 * g_option_context_get_ignore_unknown_options:
241 * @context: a #GOptionContext
243 * Returns whether unknown options are ignored or not. See
244 * g_option_context_set_ignore_unknown_options().
246 * Returns: %TRUE if unknown options are ignored.
251 g_option_context_get_ignore_unknown_options (GOptionContext *context)
253 g_return_val_if_fail (context != NULL, FALSE);
255 return context->ignore_unknown;
259 * g_option_context_add_group:
260 * @context: a #GOptionContext
261 * @group: the group to add
263 * Adds a #GOptionGroup to the @context, so that parsing with @context
264 * will recognize the options in the group. Note that the group will
265 * be freed together with the context when g_option_context_free() is
266 * called, so you must not free the group yourself after adding it
272 g_option_context_add_group (GOptionContext *context,
277 g_return_if_fail (context != NULL);
278 g_return_if_fail (group != NULL);
279 g_return_if_fail (group->name != NULL);
280 g_return_if_fail (group->description != NULL);
281 g_return_if_fail (group->help_description != NULL);
283 for (list = context->groups; list; list = list->next)
285 GOptionGroup *g = (GOptionGroup *)list->data;
287 if ((group->name == NULL && g->name == NULL) ||
288 (group->name && g->name && strcmp (group->name, g->name) == 0))
289 g_warning ("A group named \"%s\" is already part of this GOptionContext",
293 context->groups = g_list_append (context->groups, group);
297 * g_option_context_set_main_group:
298 * @context: a #GOptionContext
299 * @group: the group to set as main group
301 * Sets a #GOptionGroup as main group of the @context.
302 * This has the same effect as calling g_option_context_add_group(),
303 * the only difference is that the options in the main group are
304 * treated differently when generating <option>--help</option> output.
309 g_option_context_set_main_group (GOptionContext *context,
312 g_return_if_fail (context != NULL);
313 g_return_if_fail (group != NULL);
315 context->main_group = group;
319 * g_option_context_get_main_group:
320 * @context: a #GOptionContext
322 * Returns a pointer to the main group of @context.
324 * Return value: the main group of @context, or %NULL if @context doesn't
325 * have a main group. Note that group belongs to @context and should
326 * not be modified or freed.
331 g_option_context_get_main_group (GOptionContext *context)
333 g_return_val_if_fail (context != NULL, NULL);
335 return context->main_group;
339 * g_option_context_add_main_entries:
340 * @context: a #GOptionContext
341 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
342 * @translation_domain: a translation domain to use for translating
343 * the <option>--help</option> output for the options in @entries
344 * with gettext(), or %NULL
346 * A convenience function which creates a main group if it doesn't
347 * exist, adds the @entries to it and sets the translation domain.
352 g_option_context_add_main_entries (GOptionContext *context,
353 const GOptionEntry *entries,
354 const gchar *translation_domain)
356 g_return_if_fail (entries != NULL);
358 if (!context->main_group)
359 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
361 g_option_group_add_entries (context->main_group, entries);
362 g_option_group_set_translation_domain (context->main_group, translation_domain);
366 print_entry (GOptionGroup *group,
368 const GOptionEntry *entry)
372 if (entry->flags & G_OPTION_FLAG_HIDDEN)
375 if (entry->long_name[0] == 0)
378 str = g_string_new (NULL);
380 if (entry->short_name)
381 g_string_append_printf (str, " -%c, --%s", entry->short_name, entry->long_name);
383 g_string_append_printf (str, " --%s", entry->long_name);
385 if (entry->arg_description)
386 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
388 g_print ("%-*s %s\n", max_length + 4, str->str,
389 entry->description ? TRANSLATE (group, entry->description) : "");
390 g_string_free (str, TRUE);
394 print_help (GOptionContext *context,
399 gint max_length, len;
401 GHashTable *shadow_map;
404 g_print ("%s\n %s %s %s\n\n",
405 _("Usage:"), g_get_prgname(), _("[OPTION...]"),
406 context->parameter_string ? context->parameter_string : "");
408 memset (seen, 0, sizeof (gboolean) * 256);
409 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
411 if (context->main_group)
413 for (i = 0; i < context->main_group->n_entries; i++)
415 g_hash_table_insert (shadow_map,
416 (gpointer)context->main_group->entries[i].long_name,
417 context->main_group->entries + i);
419 if (seen[(guchar)context->main_group->entries[i].short_name])
420 context->main_group->entries[i].short_name = 0;
422 seen[(guchar)context->main_group->entries[i].short_name] = TRUE;
426 list = context->groups;
429 GOptionGroup *group = list->data;
430 for (i = 0; i < group->n_entries; i++)
432 if (g_hash_table_lookup (shadow_map, group->entries[i].long_name))
433 group->entries[i].long_name = g_strdup_printf ("%s-%s", group->name, group->entries[i].long_name);
435 g_hash_table_insert (shadow_map, (gpointer)group->entries[i].long_name, group->entries + i);
437 if (seen[(guchar)group->entries[i].short_name])
438 group->entries[i].short_name = 0;
440 seen[(guchar)group->entries[i].short_name] = TRUE;
445 g_hash_table_destroy (shadow_map);
447 list = context->groups;
449 max_length = g_utf8_strlen ("--help, -?", -1);
453 len = g_utf8_strlen ("--help-all", -1);
454 max_length = MAX (max_length, len);
459 GOptionGroup *group = list->data;
461 /* First, we check the --help-<groupname> options */
462 len = g_utf8_strlen ("--help-", -1) + g_utf8_strlen (group->name, -1);
463 max_length = MAX (max_length, len);
465 /* Then we go through the entries */
466 for (i = 0; i < group->n_entries; i++)
468 if (group->entries[i].flags & G_OPTION_FLAG_HIDDEN)
471 len = g_utf8_strlen (group->entries[i].long_name, -1);
473 if (group->entries[i].short_name)
476 if (group->entries[i].arg != G_OPTION_ARG_NONE &&
477 group->entries[i].arg_description)
478 len += 1 + g_utf8_strlen (TRANSLATE (group, group->entries[i].arg_description), -1);
480 max_length = MAX (max_length, len);
486 /* Add a bit of padding */
491 list = context->groups;
493 g_print ("%s\n --%-*s %s\n",
494 _("Help Options:"), max_length, "help", _("Show help options"));
496 /* We only want --help-all when there are groups */
498 g_print (" --%-*s %s\n", max_length, "help-all", _("Show all help options"));
502 GOptionGroup *group = list->data;
504 g_print (" --help-%-*s %s\n", max_length - 5, group->name, TRANSLATE (group, group->help_description));
514 /* Print a certain group */
516 g_print ("%s\n", TRANSLATE (group, group->description));
517 for (i = 0; i < group->n_entries; i++)
518 print_entry (group, max_length, &group->entries[i]);
523 /* Print all groups */
525 list = context->groups;
529 GOptionGroup *group = list->data;
531 g_print ("%s\n", group->description);
533 for (i = 0; i < group->n_entries; i++)
534 if (!(group->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
535 print_entry (group, max_length, &group->entries[i]);
542 /* Print application options if --help or --help-all has been specified */
543 if (main_help || !group)
545 list = context->groups;
547 g_print ("%s\n", _("Application Options:"));
549 if (context->main_group)
550 for (i = 0; i < context->main_group->n_entries; i++)
551 print_entry (context->main_group, max_length, &context->main_group->entries[i]);
555 GOptionGroup *group = list->data;
557 /* Print main entries from other groups */
558 for (i = 0; i < group->n_entries; i++)
559 if (group->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
560 print_entry (group, max_length, &group->entries[i]);
572 parse_int (const gchar *arg_name,
578 glong tmp = strtol (arg, &end, 0);
582 if (*arg == '\0' || *end != '\0')
585 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
586 _("Cannot parse integer value '%s' for --%s"),
592 if (*result != tmp || errno == ERANGE)
595 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
596 _("Integer value '%s' for %s out of range"),
605 get_change (GOptionContext *context,
610 Change *change = NULL;
612 for (list = context->changes; list != NULL; list = list->next)
616 if (change->arg_data == arg_data)
620 change = g_new0 (Change, 1);
621 change->arg_type = arg_type;
622 change->arg_data = arg_data;
624 context->changes = g_list_prepend (context->changes, change);
632 add_pending_null (GOptionContext *context,
638 n = g_new0 (PendingNull, 1);
642 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
646 parse_arg (GOptionContext *context,
650 const gchar *option_name,
658 case G_OPTION_ARG_NONE:
660 change = get_change (context, G_OPTION_ARG_NONE,
663 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
666 case G_OPTION_ARG_STRING:
670 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
675 change = get_change (context, G_OPTION_ARG_STRING,
677 g_free (change->allocated.str);
679 change->prev.str = *(gchar **)entry->arg_data;
680 change->allocated.str = data;
682 *(gchar **)entry->arg_data = data;
685 case G_OPTION_ARG_STRING_ARRAY:
689 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
694 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
697 if (change->allocated.array.len == 0)
699 change->prev.array = entry->arg_data;
700 change->allocated.array.data = g_new (gchar *, 2);
703 change->allocated.array.data =
704 g_renew (gchar *, change->allocated.array.data,
705 change->allocated.array.len + 2);
707 change->allocated.array.data[change->allocated.array.len] = data;
708 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
710 change->allocated.array.len ++;
712 *(gchar ***)entry->arg_data = change->allocated.array.data;
717 case G_OPTION_ARG_FILENAME:
722 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
727 data = g_strdup (value);
729 change = get_change (context, G_OPTION_ARG_FILENAME,
731 g_free (change->allocated.str);
733 change->prev.str = *(gchar **)entry->arg_data;
734 change->allocated.str = data;
736 *(gchar **)entry->arg_data = data;
740 case G_OPTION_ARG_FILENAME_ARRAY:
745 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
750 data = g_strdup (value);
752 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
755 if (change->allocated.array.len == 0)
757 change->prev.array = entry->arg_data;
758 change->allocated.array.data = g_new (gchar *, 2);
761 change->allocated.array.data =
762 g_renew (gchar *, change->allocated.array.data,
763 change->allocated.array.len + 2);
765 change->allocated.array.data[change->allocated.array.len] = data;
766 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
768 change->allocated.array.len ++;
770 *(gchar ***)entry->arg_data = change->allocated.array.data;
775 case G_OPTION_ARG_INT:
779 if (!parse_int (option_name, value,
784 change = get_change (context, G_OPTION_ARG_INT,
786 change->prev.integer = *(gint *)entry->arg_data;
787 *(gint *)entry->arg_data = data;
790 case G_OPTION_ARG_CALLBACK:
795 tmp = g_locale_to_utf8 (value, -1, NULL, NULL, error);
800 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, tmp, group->user_data, error);
809 g_assert_not_reached ();
816 parse_short_option (GOptionContext *context,
828 for (j = 0; j < group->n_entries; j++)
830 if (arg == group->entries[j].short_name)
832 if (group->entries[j].arg == G_OPTION_ARG_NONE)
834 parse_arg (context, group, &group->entries[j],
843 if (*new_index > index)
845 g_warning ("FIXME: figure out the correct error here");
850 if (index < *argc - 1)
852 value = (*argv)[index + 1];
853 add_pending_null (context, &((*argv)[index + 1]), NULL);
854 *new_index = index + 1;
860 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
862 if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
864 g_free (option_name);
868 g_free (option_name);
878 parse_long_option (GOptionContext *context,
889 for (j = 0; j < group->n_entries; j++)
894 if (group->entries[j].arg == G_OPTION_ARG_NONE &&
895 strcmp (arg, group->entries[j].long_name) == 0)
897 parse_arg (context, group, &group->entries[j],
900 add_pending_null (context, &((*argv)[*index]), NULL);
905 gint len = strlen (group->entries[j].long_name);
907 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
908 (arg[len] == '=' || arg[len] == 0))
913 add_pending_null (context, &((*argv)[*index]), NULL);
916 value = arg + len + 1;
917 else if (*index < *argc - 1)
919 value = (*argv)[*index + 1];
920 add_pending_null (context, &((*argv)[*index + 1]), NULL);
926 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
928 if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
930 g_free (option_name);
934 g_free (option_name);
944 parse_remaining_arg (GOptionContext *context,
954 for (j = 0; j < group->n_entries; j++)
959 if (group->entries[j].long_name[0])
962 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
963 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
965 add_pending_null (context, &((*argv)[*index]), NULL);
967 if (!parse_arg (context, group, &group->entries[j], (*argv)[*index], "", error))
978 free_changes_list (GOptionContext *context,
983 for (list = context->changes; list != NULL; list = list->next)
985 Change *change = list->data;
989 switch (change->arg_type)
991 case G_OPTION_ARG_NONE:
992 *(gboolean *)change->arg_data = change->prev.bool;
994 case G_OPTION_ARG_INT:
995 *(gint *)change->arg_data = change->prev.integer;
997 case G_OPTION_ARG_STRING:
998 case G_OPTION_ARG_FILENAME:
999 g_free (change->allocated.str);
1000 *(gchar **)change->arg_data = change->prev.str;
1002 case G_OPTION_ARG_STRING_ARRAY:
1003 case G_OPTION_ARG_FILENAME_ARRAY:
1004 g_strfreev (change->allocated.array.data);
1005 *(gchar ***)change->arg_data = change->prev.array;
1008 g_assert_not_reached ();
1015 g_list_free (context->changes);
1016 context->changes = NULL;
1020 free_pending_nulls (GOptionContext *context,
1021 gboolean perform_nulls)
1025 for (list = context->pending_nulls; list != NULL; list = list->next)
1027 PendingNull *n = list->data;
1033 /* Copy back the short options */
1035 strcpy (*n->ptr + 1, n->value);
1045 g_list_free (context->pending_nulls);
1046 context->pending_nulls = NULL;
1050 * g_option_context_parse:
1051 * @context: a #GOptionContext
1052 * @argc: a pointer to the number of command line arguments.
1053 * @argv: a pointer to the array of command line arguments.
1054 * @error: a return location for errors
1056 * Parses the command line arguments, recognizing options
1057 * which have been added to @context. A side-effect of
1058 * calling this function is that g_set_prgname() will be
1061 * If the parsing is successful, any parsed arguments are
1062 * removed from the array and @argc and @argv are updated
1063 * accordingly. A '--' option is stripped from @argv
1064 * unless there are unparsed options before and after it,
1065 * or some of the options after it start with '-'. In case
1066 * of an error, @argc and @argv are left unmodified.
1068 * If automatic <option>--help</option> support is enabled
1069 * (see g_option_context_set_help_enabled()), and the
1070 * @argv array contains one of the recognized help options,
1071 * this function will produce help output to stdout and
1072 * call <literal>exit (0)</literal>.
1074 * Return value: %TRUE if the parsing was successful,
1075 * %FALSE if an error occurred
1080 g_option_context_parse (GOptionContext *context,
1088 /* Set program name */
1089 if (argc && argv && *argc)
1093 prgname = g_path_get_basename ((*argv)[0]);
1094 g_set_prgname (prgname);
1099 g_set_prgname ("<unknown>");
1102 /* Call pre-parse hooks */
1103 list = context->groups;
1106 GOptionGroup *group = list->data;
1108 if (group->pre_parse_func)
1110 if (!(* group->pre_parse_func) (context, group,
1111 group->user_data, error))
1118 if (context->main_group && context->main_group->pre_parse_func)
1120 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1121 context->main_group->user_data, error))
1127 gboolean stop_parsing = FALSE;
1128 gboolean has_unknown = FALSE;
1129 gint separator_pos = 0;
1131 for (i = 1; i < *argc; i++)
1134 gboolean parsed = FALSE;
1136 if ((*argv)[i][0] == '-' && !stop_parsing)
1138 if ((*argv)[i][1] == '-')
1142 arg = (*argv)[i] + 2;
1144 /* '--' terminates list of arguments */
1148 stop_parsing = TRUE;
1152 /* Handle help options */
1153 if (context->help_enabled)
1155 if (strcmp (arg, "help") == 0)
1156 print_help (context, TRUE, NULL);
1157 else if (strcmp (arg, "help-all") == 0)
1158 print_help (context, FALSE, NULL);
1159 else if (strncmp (arg, "help-", 5) == 0)
1163 list = context->groups;
1167 GOptionGroup *group = list->data;
1169 if (strcmp (arg + 5, group->name) == 0)
1170 print_help (context, FALSE, group);
1177 if (context->main_group &&
1178 !parse_long_option (context, context->main_group, &i, arg,
1179 argc, argv, error, &parsed))
1185 /* Try the groups */
1186 list = context->groups;
1189 GOptionGroup *group = list->data;
1191 if (!parse_long_option (context, group, &i, arg,
1192 argc, argv, error, &parsed))
1204 /* Now look for --<group>-<option> */
1205 dash = strchr (arg, '-');
1208 /* Try the groups */
1209 list = context->groups;
1212 GOptionGroup *group = list->data;
1214 if (strncmp (group->name, arg, dash - arg) == 0)
1216 if (!parse_long_option (context, group, &i, dash + 1,
1217 argc, argv, error, &parsed))
1228 if (context->ignore_unknown)
1236 gboolean *nulled_out = NULL;
1238 arg = (*argv)[i] + 1;
1242 if (context->ignore_unknown)
1243 nulled_out = g_new0 (gboolean, strlen (arg));
1245 for (j = 0; j < strlen (arg); j++)
1249 if (context->main_group &&
1250 !parse_short_option (context, context->main_group,
1252 argc, argv, error, &parsed))
1255 g_free (nulled_out);
1261 /* Try the groups */
1262 list = context->groups;
1265 GOptionGroup *group = list->data;
1267 if (!parse_short_option (context, group, i, &new_i, arg[j],
1268 argc, argv, error, &parsed))
1278 if (context->ignore_unknown)
1281 nulled_out[j] = TRUE;
1290 if (context->ignore_unknown)
1292 gchar *new_arg = NULL;
1295 for (j = 0; j < strlen (arg); j++)
1300 new_arg = g_malloc (strlen (arg));
1301 new_arg[arg_index++] = arg[j];
1305 new_arg[arg_index] = '\0';
1307 add_pending_null (context, &((*argv)[i]), new_arg);
1311 add_pending_null (context, &((*argv)[i]), NULL);
1319 if (!parsed && !context->ignore_unknown)
1322 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1323 _("Unknown option %s"), (*argv)[i]);
1329 /* Collect remaining args */
1330 if (context->main_group &&
1331 !parse_remaining_arg (context, context->main_group, &i,
1332 argc, argv, error, &parsed))
1335 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1340 if (separator_pos > 0)
1341 add_pending_null (context, &((*argv)[separator_pos]), NULL);
1345 /* Call post-parse hooks */
1346 list = context->groups;
1349 GOptionGroup *group = list->data;
1351 if (group->post_parse_func)
1353 if (!(* group->post_parse_func) (context, group,
1354 group->user_data, error))
1361 if (context->main_group && context->main_group->post_parse_func)
1363 if (!(* context->main_group->post_parse_func) (context, context->main_group,
1364 context->main_group->user_data, error))
1370 free_pending_nulls (context, TRUE);
1372 for (i = 1; i < *argc; i++)
1374 for (k = i; k < *argc; k++)
1375 if ((*argv)[k] != NULL)
1381 for (j = i + k; j < *argc; j++)
1383 (*argv)[j-k] = (*argv)[j];
1395 /* Call error hooks */
1396 list = context->groups;
1399 GOptionGroup *group = list->data;
1401 if (group->error_func)
1402 (* group->error_func) (context, group,
1403 group->user_data, error);
1408 if (context->main_group && context->main_group->error_func)
1409 (* context->main_group->error_func) (context, context->main_group,
1410 context->main_group->user_data, error);
1412 free_changes_list (context, TRUE);
1413 free_pending_nulls (context, FALSE);
1419 * g_option_group_new:
1420 * @name: the name for the option group, this is used to provide
1421 * help for the options in this group with <option>--help-</option>@name
1422 * @description: a description for this group to be shown in
1423 * <option>--help</option>. This string is translated using the translation
1424 * domain or translation function of the group
1425 * @help_description: a description for the <option>--help-</option>@name option.
1426 * This string is translated using the translation domain or translation function
1428 * @user_data: user data that will be passed to the pre- and post-parse hooks,
1429 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1430 * @destroy: a function that will be called to free @user_data, or %NULL
1432 * Creates a new #GOptionGroup.
1434 * Return value: a newly created option group. It should be added
1435 * to a #GOptionContext or freed with g_option_group_free().
1440 g_option_group_new (const gchar *name,
1441 const gchar *description,
1442 const gchar *help_description,
1444 GDestroyNotify destroy)
1447 GOptionGroup *group;
1449 group = g_new0 (GOptionGroup, 1);
1450 group->name = g_strdup (name);
1451 group->description = g_strdup (description);
1452 group->help_description = g_strdup (help_description);
1453 group->user_data = user_data;
1454 group->destroy_notify = destroy;
1461 * g_option_group_free:
1462 * @group: a #GOptionGroup
1464 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
1465 * free groups which have been added to a #GOptionContext.
1470 g_option_group_free (GOptionGroup *group)
1472 g_return_if_fail (group != NULL);
1474 g_free (group->name);
1475 g_free (group->description);
1476 g_free (group->help_description);
1478 g_free (group->entries);
1480 if (group->destroy_notify)
1481 (* group->destroy_notify) (group->user_data);
1483 if (group->translate_notify)
1484 (* group->translate_notify) (group->translate_data);
1491 * g_option_group_add_entries:
1492 * @group: a #GOptionGroup
1493 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
1495 * Adds the options specified in @entries to @group.
1500 g_option_group_add_entries (GOptionGroup *group,
1501 const GOptionEntry *entries)
1505 g_return_if_fail (entries != NULL);
1507 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++);
1509 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
1511 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
1513 group->n_entries += n_entries;
1517 * g_option_group_set_parse_hooks:
1518 * @group: a #GOptionGroup
1519 * @pre_parse_func: a function to call before parsing, or %NULL
1520 * @post_parse_func: a function to call after parsing, or %NULL
1522 * Associates two functions with @group which will be called
1523 * from g_option_context_parse() before the first option is parsed
1524 * and after the last option has been parsed, respectively.
1526 * Note that the user data to be passed to @pre_parse_func and
1527 * @post_parse_func can be specified when constructing the group
1528 * with g_option_group_new().
1533 g_option_group_set_parse_hooks (GOptionGroup *group,
1534 GOptionParseFunc pre_parse_func,
1535 GOptionParseFunc post_parse_func)
1537 g_return_if_fail (group != NULL);
1539 group->pre_parse_func = pre_parse_func;
1540 group->post_parse_func = post_parse_func;
1544 * g_option_group_set_error_hook:
1545 * @group: a #GOptionGroup
1546 * @error_func: a function to call when an error occurs
1548 * Associates a function with @group which will be called
1549 * from g_option_context_parse() when an error occurs.
1551 * Note that the user data to be passed to @pre_parse_func and
1552 * @post_parse_func can be specified when constructing the group
1553 * with g_option_group_new().
1558 g_option_group_set_error_hook (GOptionGroup *group,
1559 GOptionErrorFunc error_func)
1561 g_return_if_fail (group != NULL);
1563 group->error_func = error_func;
1568 * g_option_group_set_translate_func:
1569 * @group: a #GOptionGroup
1570 * @func: the #GTranslateFunc, or %NULL
1571 * @data: user data to pass to @func, or %NULL
1572 * @destroy_notify: a function which gets called to free @data, or %NULL
1574 * Sets the function which is used to translate user-visible
1575 * strings, for <option>--help</option> output. Different
1576 * groups can use different #GTranslateFunc<!-- -->s. If @func
1577 * is %NULL, strings are not translated.
1579 * If you are using gettext(), you only need to set the translation
1580 * domain, see g_option_group_set_translation_domain().
1585 g_option_group_set_translate_func (GOptionGroup *group,
1586 GTranslateFunc func,
1588 GDestroyNotify destroy_notify)
1590 g_return_if_fail (group != NULL);
1592 if (group->translate_notify)
1593 group->translate_notify (group->translate_data);
1595 group->translate_func = func;
1596 group->translate_data = data;
1597 group->translate_notify = destroy_notify;
1601 dgettext_swapped (const gchar *msgid,
1602 const gchar *domainname)
1604 return dgettext (domainname, msgid);
1608 * g_option_group_set_translation_domain:
1609 * @group: a #GOptionGroup
1610 * @domain: the domain to use
1612 * A convenience function to use gettext() for translating
1613 * user-visible strings.
1618 g_option_group_set_translation_domain (GOptionGroup *group,
1619 const gchar *domain)
1621 g_return_if_fail (group != NULL);
1623 g_option_group_set_translate_func (group,
1624 (GTranslateFunc)dgettext_swapped,