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 if (context->main_group)
317 g_warning ("This GOptionContext already has a main group");
322 context->main_group = group;
326 * g_option_context_get_main_group:
327 * @context: a #GOptionContext
329 * Returns a pointer to the main group of @context.
331 * Return value: the main group of @context, or %NULL if @context doesn't
332 * have a main group. Note that group belongs to @context and should
333 * not be modified or freed.
338 g_option_context_get_main_group (GOptionContext *context)
340 g_return_val_if_fail (context != NULL, NULL);
342 return context->main_group;
346 * g_option_context_add_main_entries:
347 * @context: a #GOptionContext
348 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
349 * @translation_domain: a translation domain to use for translating
350 * the <option>--help</option> output for the options in @entries
351 * with gettext(), or %NULL
353 * A convenience function which creates a main group if it doesn't
354 * exist, adds the @entries to it and sets the translation domain.
359 g_option_context_add_main_entries (GOptionContext *context,
360 const GOptionEntry *entries,
361 const gchar *translation_domain)
363 g_return_if_fail (entries != NULL);
365 if (!context->main_group)
366 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
368 g_option_group_add_entries (context->main_group, entries);
369 g_option_group_set_translation_domain (context->main_group, translation_domain);
373 calculate_max_length (GOptionGroup *group)
376 gint i, len, max_length;
380 for (i = 0; i < group->n_entries; i++)
382 entry = &group->entries[i];
384 if (entry->flags & G_OPTION_FLAG_HIDDEN)
387 len = g_utf8_strlen (entry->long_name, -1);
389 if (entry->short_name)
392 if (entry->arg != G_OPTION_ARG_NONE && entry->arg_description)
393 len += 1 + g_utf8_strlen (TRANSLATE (group, entry->arg_description), -1);
395 max_length = MAX (max_length, len);
402 print_entry (GOptionGroup *group,
404 const GOptionEntry *entry)
408 if (entry->flags & G_OPTION_FLAG_HIDDEN)
411 if (entry->long_name[0] == 0)
414 str = g_string_new (NULL);
416 if (entry->short_name)
417 g_string_append_printf (str, " -%c, --%s", entry->short_name, entry->long_name);
419 g_string_append_printf (str, " --%s", entry->long_name);
421 if (entry->arg_description)
422 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
424 g_print ("%-*s %s\n", max_length + 4, str->str,
425 entry->description ? TRANSLATE (group, entry->description) : "");
426 g_string_free (str, TRUE);
430 print_help (GOptionContext *context,
435 gint max_length, len;
438 GHashTable *shadow_map;
440 gchar *rest_description;
442 rest_description = NULL;
443 if (context->main_group)
445 for (i = 0; i < context->main_group->n_entries; i++)
447 entry = &context->main_group->entries[i];
448 if (entry->long_name[0] == 0)
450 rest_description = entry->arg_description;
456 g_print ("%s\n %s %s%s%s%s%s\n\n",
457 _("Usage:"), g_get_prgname(), _("[OPTION...]"),
458 rest_description ? " " : "",
459 rest_description ? rest_description : "",
460 context->parameter_string ? " " : "",
461 context->parameter_string ? context->parameter_string : "");
463 memset (seen, 0, sizeof (gboolean) * 256);
464 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
466 if (context->main_group)
468 for (i = 0; i < context->main_group->n_entries; i++)
470 entry = &context->main_group->entries[i];
471 g_hash_table_insert (shadow_map,
472 (gpointer)entry->long_name,
475 if (seen[(guchar)entry->short_name])
476 entry->short_name = 0;
478 seen[(guchar)entry->short_name] = TRUE;
482 list = context->groups;
485 GOptionGroup *group = list->data;
486 for (i = 0; i < group->n_entries; i++)
488 entry = &group->entries[i];
489 if (g_hash_table_lookup (shadow_map, entry->long_name))
490 entry->long_name = g_strdup_printf ("%s-%s", group->name, entry->long_name);
492 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
494 if (seen[(guchar)entry->short_name])
495 entry->short_name = 0;
497 seen[(guchar)entry->short_name] = TRUE;
502 g_hash_table_destroy (shadow_map);
504 list = context->groups;
506 max_length = g_utf8_strlen ("-?, --help", -1);
510 len = g_utf8_strlen ("--help-all", -1);
511 max_length = MAX (max_length, len);
514 if (context->main_group)
516 len = calculate_max_length (context->main_group);
517 max_length = MAX (max_length, len);
522 GOptionGroup *group = list->data;
524 /* First, we check the --help-<groupname> options */
525 len = g_utf8_strlen ("--help-", -1) + g_utf8_strlen (group->name, -1);
526 max_length = MAX (max_length, len);
528 /* Then we go through the entries */
529 len = calculate_max_length (group);
530 max_length = MAX (max_length, len);
535 /* Add a bit of padding */
540 list = context->groups;
542 g_print ("%s\n -%c, --%-*s %s\n",
543 _("Help Options:"), '?', max_length - 4, "help",
544 _("Show help options"));
546 /* We only want --help-all when there are groups */
548 g_print (" --%-*s %s\n", max_length, "help-all",
549 _("Show all help options"));
553 GOptionGroup *group = list->data;
555 g_print (" --help-%-*s %s\n", max_length - 5, group->name,
556 TRANSLATE (group, group->help_description));
566 /* Print a certain group */
568 g_print ("%s\n", TRANSLATE (group, group->description));
569 for (i = 0; i < group->n_entries; i++)
570 print_entry (group, max_length, &group->entries[i]);
575 /* Print all groups */
577 list = context->groups;
581 GOptionGroup *group = list->data;
583 g_print ("%s\n", group->description);
585 for (i = 0; i < group->n_entries; i++)
586 if (!(group->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
587 print_entry (group, max_length, &group->entries[i]);
594 /* Print application options if --help or --help-all has been specified */
595 if (main_help || !group)
597 list = context->groups;
599 g_print ("%s\n", _("Application Options:"));
601 if (context->main_group)
602 for (i = 0; i < context->main_group->n_entries; i++)
603 print_entry (context->main_group, max_length,
604 &context->main_group->entries[i]);
608 GOptionGroup *group = list->data;
610 /* Print main entries from other groups */
611 for (i = 0; i < group->n_entries; i++)
612 if (group->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
613 print_entry (group, max_length, &group->entries[i]);
625 parse_int (const gchar *arg_name,
631 glong tmp = strtol (arg, &end, 0);
635 if (*arg == '\0' || *end != '\0')
638 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
639 _("Cannot parse integer value '%s' for %s"),
645 if (*result != tmp || errno == ERANGE)
648 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
649 _("Integer value '%s' for %s out of range"),
658 get_change (GOptionContext *context,
663 Change *change = NULL;
665 for (list = context->changes; list != NULL; list = list->next)
669 if (change->arg_data == arg_data)
673 change = g_new0 (Change, 1);
674 change->arg_type = arg_type;
675 change->arg_data = arg_data;
677 context->changes = g_list_prepend (context->changes, change);
685 add_pending_null (GOptionContext *context,
691 n = g_new0 (PendingNull, 1);
695 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
699 parse_arg (GOptionContext *context,
703 const gchar *option_name,
711 case G_OPTION_ARG_NONE:
713 change = get_change (context, G_OPTION_ARG_NONE,
716 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
719 case G_OPTION_ARG_STRING:
723 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
728 change = get_change (context, G_OPTION_ARG_STRING,
730 g_free (change->allocated.str);
732 change->prev.str = *(gchar **)entry->arg_data;
733 change->allocated.str = data;
735 *(gchar **)entry->arg_data = data;
738 case G_OPTION_ARG_STRING_ARRAY:
742 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
747 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
750 if (change->allocated.array.len == 0)
752 change->prev.array = entry->arg_data;
753 change->allocated.array.data = g_new (gchar *, 2);
756 change->allocated.array.data =
757 g_renew (gchar *, change->allocated.array.data,
758 change->allocated.array.len + 2);
760 change->allocated.array.data[change->allocated.array.len] = data;
761 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
763 change->allocated.array.len ++;
765 *(gchar ***)entry->arg_data = change->allocated.array.data;
770 case G_OPTION_ARG_FILENAME:
775 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
780 data = g_strdup (value);
782 change = get_change (context, G_OPTION_ARG_FILENAME,
784 g_free (change->allocated.str);
786 change->prev.str = *(gchar **)entry->arg_data;
787 change->allocated.str = data;
789 *(gchar **)entry->arg_data = data;
793 case G_OPTION_ARG_FILENAME_ARRAY:
798 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
803 data = g_strdup (value);
805 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
808 if (change->allocated.array.len == 0)
810 change->prev.array = entry->arg_data;
811 change->allocated.array.data = g_new (gchar *, 2);
814 change->allocated.array.data =
815 g_renew (gchar *, change->allocated.array.data,
816 change->allocated.array.len + 2);
818 change->allocated.array.data[change->allocated.array.len] = data;
819 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
821 change->allocated.array.len ++;
823 *(gchar ***)entry->arg_data = change->allocated.array.data;
828 case G_OPTION_ARG_INT:
832 if (!parse_int (option_name, value,
837 change = get_change (context, G_OPTION_ARG_INT,
839 change->prev.integer = *(gint *)entry->arg_data;
840 *(gint *)entry->arg_data = data;
843 case G_OPTION_ARG_CALLBACK:
848 tmp = g_locale_to_utf8 (value, -1, NULL, NULL, error);
853 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, tmp, group->user_data, error);
862 g_assert_not_reached ();
869 parse_short_option (GOptionContext *context,
881 for (j = 0; j < group->n_entries; j++)
883 if (arg == group->entries[j].short_name)
885 if (group->entries[j].arg == G_OPTION_ARG_NONE)
887 parse_arg (context, group, &group->entries[j],
896 if (*new_index > index)
898 g_warning ("FIXME: figure out the correct error here");
903 if (index < *argc - 1)
905 value = (*argv)[index + 1];
906 add_pending_null (context, &((*argv)[index + 1]), NULL);
907 *new_index = index + 1;
913 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
915 if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
917 g_free (option_name);
921 g_free (option_name);
931 parse_long_option (GOptionContext *context,
942 for (j = 0; j < group->n_entries; j++)
947 if (group->entries[j].arg == G_OPTION_ARG_NONE &&
948 strcmp (arg, group->entries[j].long_name) == 0)
950 parse_arg (context, group, &group->entries[j],
953 add_pending_null (context, &((*argv)[*index]), NULL);
958 gint len = strlen (group->entries[j].long_name);
960 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
961 (arg[len] == '=' || arg[len] == 0))
966 add_pending_null (context, &((*argv)[*index]), NULL);
969 value = arg + len + 1;
970 else if (*index < *argc - 1)
972 value = (*argv)[*index + 1];
973 add_pending_null (context, &((*argv)[*index + 1]), NULL);
979 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
981 if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
983 g_free (option_name);
987 g_free (option_name);
997 parse_remaining_arg (GOptionContext *context,
1007 for (j = 0; j < group->n_entries; j++)
1009 if (*index >= *argc)
1012 if (group->entries[j].long_name[0])
1015 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1016 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1018 add_pending_null (context, &((*argv)[*index]), NULL);
1020 if (!parse_arg (context, group, &group->entries[j], (*argv)[*index], "", error))
1031 free_changes_list (GOptionContext *context,
1036 for (list = context->changes; list != NULL; list = list->next)
1038 Change *change = list->data;
1042 switch (change->arg_type)
1044 case G_OPTION_ARG_NONE:
1045 *(gboolean *)change->arg_data = change->prev.bool;
1047 case G_OPTION_ARG_INT:
1048 *(gint *)change->arg_data = change->prev.integer;
1050 case G_OPTION_ARG_STRING:
1051 case G_OPTION_ARG_FILENAME:
1052 g_free (change->allocated.str);
1053 *(gchar **)change->arg_data = change->prev.str;
1055 case G_OPTION_ARG_STRING_ARRAY:
1056 case G_OPTION_ARG_FILENAME_ARRAY:
1057 g_strfreev (change->allocated.array.data);
1058 *(gchar ***)change->arg_data = change->prev.array;
1061 g_assert_not_reached ();
1068 g_list_free (context->changes);
1069 context->changes = NULL;
1073 free_pending_nulls (GOptionContext *context,
1074 gboolean perform_nulls)
1078 for (list = context->pending_nulls; list != NULL; list = list->next)
1080 PendingNull *n = list->data;
1086 /* Copy back the short options */
1088 strcpy (*n->ptr + 1, n->value);
1098 g_list_free (context->pending_nulls);
1099 context->pending_nulls = NULL;
1103 * g_option_context_parse:
1104 * @context: a #GOptionContext
1105 * @argc: a pointer to the number of command line arguments.
1106 * @argv: a pointer to the array of command line arguments.
1107 * @error: a return location for errors
1109 * Parses the command line arguments, recognizing options
1110 * which have been added to @context. A side-effect of
1111 * calling this function is that g_set_prgname() will be
1114 * If the parsing is successful, any parsed arguments are
1115 * removed from the array and @argc and @argv are updated
1116 * accordingly. A '--' option is stripped from @argv
1117 * unless there are unparsed options before and after it,
1118 * or some of the options after it start with '-'. In case
1119 * of an error, @argc and @argv are left unmodified.
1121 * If automatic <option>--help</option> support is enabled
1122 * (see g_option_context_set_help_enabled()), and the
1123 * @argv array contains one of the recognized help options,
1124 * this function will produce help output to stdout and
1125 * call <literal>exit (0)</literal>.
1127 * Return value: %TRUE if the parsing was successful,
1128 * %FALSE if an error occurred
1133 g_option_context_parse (GOptionContext *context,
1141 /* Set program name */
1142 if (argc && argv && *argc)
1146 prgname = g_path_get_basename ((*argv)[0]);
1147 g_set_prgname (prgname);
1152 g_set_prgname ("<unknown>");
1155 /* Call pre-parse hooks */
1156 list = context->groups;
1159 GOptionGroup *group = list->data;
1161 if (group->pre_parse_func)
1163 if (!(* group->pre_parse_func) (context, group,
1164 group->user_data, error))
1171 if (context->main_group && context->main_group->pre_parse_func)
1173 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1174 context->main_group->user_data, error))
1180 gboolean stop_parsing = FALSE;
1181 gboolean has_unknown = FALSE;
1182 gint separator_pos = 0;
1184 for (i = 1; i < *argc; i++)
1187 gboolean parsed = FALSE;
1189 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1191 if ((*argv)[i][1] == '-')
1195 arg = (*argv)[i] + 2;
1197 /* '--' terminates list of arguments */
1201 stop_parsing = TRUE;
1205 /* Handle help options */
1206 if (context->help_enabled)
1208 if (strcmp (arg, "help") == 0)
1209 print_help (context, TRUE, NULL);
1210 else if (strcmp (arg, "help-all") == 0)
1211 print_help (context, FALSE, NULL);
1212 else if (strncmp (arg, "help-", 5) == 0)
1216 list = context->groups;
1220 GOptionGroup *group = list->data;
1222 if (strcmp (arg + 5, group->name) == 0)
1223 print_help (context, FALSE, group);
1230 if (context->main_group &&
1231 !parse_long_option (context, context->main_group, &i, arg,
1232 argc, argv, error, &parsed))
1238 /* Try the groups */
1239 list = context->groups;
1242 GOptionGroup *group = list->data;
1244 if (!parse_long_option (context, group, &i, arg,
1245 argc, argv, error, &parsed))
1257 /* Now look for --<group>-<option> */
1258 dash = strchr (arg, '-');
1261 /* Try the groups */
1262 list = context->groups;
1265 GOptionGroup *group = list->data;
1267 if (strncmp (group->name, arg, dash - arg) == 0)
1269 if (!parse_long_option (context, group, &i, dash + 1,
1270 argc, argv, error, &parsed))
1281 if (context->ignore_unknown)
1289 gboolean *nulled_out = NULL;
1291 arg = (*argv)[i] + 1;
1295 if (context->ignore_unknown)
1296 nulled_out = g_new0 (gboolean, strlen (arg));
1298 for (j = 0; j < strlen (arg); j++)
1300 if (context->help_enabled && arg[j] == '?')
1301 print_help (context, TRUE, NULL);
1305 if (context->main_group &&
1306 !parse_short_option (context, context->main_group,
1308 argc, argv, error, &parsed))
1311 g_free (nulled_out);
1317 /* Try the groups */
1318 list = context->groups;
1321 GOptionGroup *group = list->data;
1323 if (!parse_short_option (context, group, i, &new_i, arg[j],
1324 argc, argv, error, &parsed))
1334 if (context->ignore_unknown)
1337 nulled_out[j] = TRUE;
1346 if (context->ignore_unknown)
1348 gchar *new_arg = NULL;
1351 for (j = 0; j < strlen (arg); j++)
1356 new_arg = g_malloc (strlen (arg) + 1);
1357 new_arg[arg_index++] = arg[j];
1361 new_arg[arg_index] = '\0';
1363 add_pending_null (context, &((*argv)[i]), new_arg);
1367 add_pending_null (context, &((*argv)[i]), NULL);
1375 if (!parsed && !context->ignore_unknown)
1378 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1379 _("Unknown option %s"), (*argv)[i]);
1385 /* Collect remaining args */
1386 if (context->main_group &&
1387 !parse_remaining_arg (context, context->main_group, &i,
1388 argc, argv, error, &parsed))
1391 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1396 if (separator_pos > 0)
1397 add_pending_null (context, &((*argv)[separator_pos]), NULL);
1401 /* Call post-parse hooks */
1402 list = context->groups;
1405 GOptionGroup *group = list->data;
1407 if (group->post_parse_func)
1409 if (!(* group->post_parse_func) (context, group,
1410 group->user_data, error))
1417 if (context->main_group && context->main_group->post_parse_func)
1419 if (!(* context->main_group->post_parse_func) (context, context->main_group,
1420 context->main_group->user_data, error))
1426 free_pending_nulls (context, TRUE);
1428 for (i = 1; i < *argc; i++)
1430 for (k = i; k < *argc; k++)
1431 if ((*argv)[k] != NULL)
1437 for (j = i + k; j < *argc; j++)
1439 (*argv)[j-k] = (*argv)[j];
1451 /* Call error hooks */
1452 list = context->groups;
1455 GOptionGroup *group = list->data;
1457 if (group->error_func)
1458 (* group->error_func) (context, group,
1459 group->user_data, error);
1464 if (context->main_group && context->main_group->error_func)
1465 (* context->main_group->error_func) (context, context->main_group,
1466 context->main_group->user_data, error);
1468 free_changes_list (context, TRUE);
1469 free_pending_nulls (context, FALSE);
1475 * g_option_group_new:
1476 * @name: the name for the option group, this is used to provide
1477 * help for the options in this group with <option>--help-</option>@name
1478 * @description: a description for this group to be shown in
1479 * <option>--help</option>. This string is translated using the translation
1480 * domain or translation function of the group
1481 * @help_description: a description for the <option>--help-</option>@name option.
1482 * This string is translated using the translation domain or translation function
1484 * @user_data: user data that will be passed to the pre- and post-parse hooks,
1485 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1486 * @destroy: a function that will be called to free @user_data, or %NULL
1488 * Creates a new #GOptionGroup.
1490 * Return value: a newly created option group. It should be added
1491 * to a #GOptionContext or freed with g_option_group_free().
1496 g_option_group_new (const gchar *name,
1497 const gchar *description,
1498 const gchar *help_description,
1500 GDestroyNotify destroy)
1503 GOptionGroup *group;
1505 group = g_new0 (GOptionGroup, 1);
1506 group->name = g_strdup (name);
1507 group->description = g_strdup (description);
1508 group->help_description = g_strdup (help_description);
1509 group->user_data = user_data;
1510 group->destroy_notify = destroy;
1517 * g_option_group_free:
1518 * @group: a #GOptionGroup
1520 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
1521 * free groups which have been added to a #GOptionContext.
1526 g_option_group_free (GOptionGroup *group)
1528 g_return_if_fail (group != NULL);
1530 g_free (group->name);
1531 g_free (group->description);
1532 g_free (group->help_description);
1534 g_free (group->entries);
1536 if (group->destroy_notify)
1537 (* group->destroy_notify) (group->user_data);
1539 if (group->translate_notify)
1540 (* group->translate_notify) (group->translate_data);
1547 * g_option_group_add_entries:
1548 * @group: a #GOptionGroup
1549 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
1551 * Adds the options specified in @entries to @group.
1556 g_option_group_add_entries (GOptionGroup *group,
1557 const GOptionEntry *entries)
1561 g_return_if_fail (entries != NULL);
1563 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++);
1565 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
1567 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
1569 group->n_entries += n_entries;
1573 * g_option_group_set_parse_hooks:
1574 * @group: a #GOptionGroup
1575 * @pre_parse_func: a function to call before parsing, or %NULL
1576 * @post_parse_func: a function to call after parsing, or %NULL
1578 * Associates two functions with @group which will be called
1579 * from g_option_context_parse() before the first option is parsed
1580 * and after the last option has been parsed, respectively.
1582 * Note that the user data to be passed to @pre_parse_func and
1583 * @post_parse_func can be specified when constructing the group
1584 * with g_option_group_new().
1589 g_option_group_set_parse_hooks (GOptionGroup *group,
1590 GOptionParseFunc pre_parse_func,
1591 GOptionParseFunc post_parse_func)
1593 g_return_if_fail (group != NULL);
1595 group->pre_parse_func = pre_parse_func;
1596 group->post_parse_func = post_parse_func;
1600 * g_option_group_set_error_hook:
1601 * @group: a #GOptionGroup
1602 * @error_func: a function to call when an error occurs
1604 * Associates a function with @group which will be called
1605 * from g_option_context_parse() when an error occurs.
1607 * Note that the user data to be passed to @pre_parse_func and
1608 * @post_parse_func can be specified when constructing the group
1609 * with g_option_group_new().
1614 g_option_group_set_error_hook (GOptionGroup *group,
1615 GOptionErrorFunc error_func)
1617 g_return_if_fail (group != NULL);
1619 group->error_func = error_func;
1624 * g_option_group_set_translate_func:
1625 * @group: a #GOptionGroup
1626 * @func: the #GTranslateFunc, or %NULL
1627 * @data: user data to pass to @func, or %NULL
1628 * @destroy_notify: a function which gets called to free @data, or %NULL
1630 * Sets the function which is used to translate user-visible
1631 * strings, for <option>--help</option> output. Different
1632 * groups can use different #GTranslateFunc<!-- -->s. If @func
1633 * is %NULL, strings are not translated.
1635 * If you are using gettext(), you only need to set the translation
1636 * domain, see g_option_group_set_translation_domain().
1641 g_option_group_set_translate_func (GOptionGroup *group,
1642 GTranslateFunc func,
1644 GDestroyNotify destroy_notify)
1646 g_return_if_fail (group != NULL);
1648 if (group->translate_notify)
1649 group->translate_notify (group->translate_data);
1651 group->translate_func = func;
1652 group->translate_data = data;
1653 group->translate_notify = destroy_notify;
1657 dgettext_swapped (const gchar *msgid,
1658 const gchar *domainname)
1660 return dgettext (domainname, msgid);
1664 * g_option_group_set_translation_domain:
1665 * @group: a #GOptionGroup
1666 * @domain: the domain to use
1668 * A convenience function to use gettext() for translating
1669 * user-visible strings.
1674 g_option_group_set_translation_domain (GOptionGroup *group,
1675 const gchar *domain)
1677 g_return_if_fail (group != NULL);
1679 g_option_group_set_translate_func (group,
1680 (GTranslateFunc)dgettext_swapped,
1685 #define __G_OPTION_C__
1686 #include "galiasdef.c"