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.
36 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
38 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
39 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
40 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
42 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
43 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
75 struct _GOptionContext
79 gchar *parameter_string;
83 GTranslateFunc translate_func;
84 GDestroyNotify translate_notify;
85 gpointer translate_data;
87 guint help_enabled : 1;
88 guint ignore_unknown : 1;
90 GOptionGroup *main_group;
92 /* We keep a list of change so we can revert them */
95 /* We also keep track of all argv elements
96 * that should be NULLed or modified.
105 gchar *help_description;
107 GDestroyNotify destroy_notify;
110 GTranslateFunc translate_func;
111 GDestroyNotify translate_notify;
112 gpointer translate_data;
114 GOptionEntry *entries;
117 GOptionParseFunc pre_parse_func;
118 GOptionParseFunc post_parse_func;
119 GOptionErrorFunc error_func;
122 static void free_changes_list (GOptionContext *context,
124 static void free_pending_nulls (GOptionContext *context,
125 gboolean perform_nulls);
129 _g_unichar_get_width (gunichar c)
131 if (G_UNLIKELY (g_unichar_iszerowidth (c)))
134 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
135 * some locales (legacy East Asian ones) */
136 if (g_unichar_iswide (c))
143 _g_utf8_strwidth (const gchar *p,
147 const gchar *start = p;
148 g_return_val_if_fail (p != NULL || max == 0, 0);
154 len += _g_unichar_get_width (g_utf8_get_char (p));
155 p = g_utf8_next_char (p);
163 /* this case may not be quite correct */
165 len += _g_unichar_get_width (g_utf8_get_char (p));
166 p = g_utf8_next_char (p);
168 while (p - start < max && *p)
170 len += _g_unichar_get_width (g_utf8_get_char (p));
171 p = g_utf8_next_char (p);
180 g_option_error_quark (void)
182 return g_quark_from_static_string ("g-option-context-error-quark");
186 * g_option_context_new:
187 * @parameter_string: a string which is displayed in
188 * the first line of <option>--help</option> output, after the
190 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
192 * Creates a new option context.
194 * The @parameter_string can serve multiple purposes. It can be used
195 * to add descriptions for "rest" arguments, which are not parsed by
196 * the #GOptionContext, typically something like "FILES" or
197 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
198 * collecting "rest" arguments, GLib handles this automatically by
199 * using the @arg_description of the corresponding #GOptionEntry in
202 * Another usage is to give a short summary of the program
203 * functionality, like " - frob the strings", which will be displayed
204 * in the same line as the usage. For a longer description of the
205 * program functionality that should be displayed as a paragraph
206 * below the usage line, use g_option_context_set_summary().
208 * Note that the @parameter_string is translated using the
209 * function set with g_option_context_set_translate_func(), so
210 * it should normally be passed untranslated.
212 * Returns: a newly created #GOptionContext, which must be
213 * freed with g_option_context_free() after use.
218 g_option_context_new (const gchar *parameter_string)
221 GOptionContext *context;
223 context = g_new0 (GOptionContext, 1);
225 context->parameter_string = g_strdup (parameter_string);
226 context->help_enabled = TRUE;
227 context->ignore_unknown = FALSE;
233 * g_option_context_free:
234 * @context: a #GOptionContext
236 * Frees context and all the groups which have been
241 void g_option_context_free (GOptionContext *context)
243 g_return_if_fail (context != NULL);
245 g_list_foreach (context->groups, (GFunc)g_option_group_free, NULL);
246 g_list_free (context->groups);
248 if (context->main_group)
249 g_option_group_free (context->main_group);
251 free_changes_list (context, FALSE);
252 free_pending_nulls (context, FALSE);
254 g_free (context->parameter_string);
255 g_free (context->summary);
256 g_free (context->description);
258 if (context->translate_notify)
259 (* context->translate_notify) (context->translate_data);
266 * g_option_context_set_help_enabled:
267 * @context: a #GOptionContext
268 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
270 * Enables or disables automatic generation of <option>--help</option>
271 * output. By default, g_option_context_parse() recognizes
272 * <option>--help</option>, <option>-?</option>, <option>--help-all</option>
273 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
274 * suitable output to stdout.
278 void g_option_context_set_help_enabled (GOptionContext *context,
279 gboolean help_enabled)
282 g_return_if_fail (context != NULL);
284 context->help_enabled = help_enabled;
288 * g_option_context_get_help_enabled:
289 * @context: a #GOptionContext
291 * Returns whether automatic <option>--help</option> generation
292 * is turned on for @context. See g_option_context_set_help_enabled().
294 * Returns: %TRUE if automatic help generation is turned on.
299 g_option_context_get_help_enabled (GOptionContext *context)
301 g_return_val_if_fail (context != NULL, FALSE);
303 return context->help_enabled;
307 * g_option_context_set_ignore_unknown_options:
308 * @context: a #GOptionContext
309 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
310 * an error when unknown options are met
312 * Sets whether to ignore unknown options or not. If an argument is
313 * ignored, it is left in the @argv array after parsing. By default,
314 * g_option_context_parse() treats unknown options as error.
316 * This setting does not affect non-option arguments (i.e. arguments
317 * which don't start with a dash). But note that GOption cannot reliably
318 * determine whether a non-option belongs to a preceding unknown option.
323 g_option_context_set_ignore_unknown_options (GOptionContext *context,
324 gboolean ignore_unknown)
326 g_return_if_fail (context != NULL);
328 context->ignore_unknown = ignore_unknown;
332 * g_option_context_get_ignore_unknown_options:
333 * @context: a #GOptionContext
335 * Returns whether unknown options are ignored or not. See
336 * g_option_context_set_ignore_unknown_options().
338 * Returns: %TRUE if unknown options are ignored.
343 g_option_context_get_ignore_unknown_options (GOptionContext *context)
345 g_return_val_if_fail (context != NULL, FALSE);
347 return context->ignore_unknown;
351 * g_option_context_add_group:
352 * @context: a #GOptionContext
353 * @group: the group to add
355 * Adds a #GOptionGroup to the @context, so that parsing with @context
356 * will recognize the options in the group. Note that the group will
357 * be freed together with the context when g_option_context_free() is
358 * called, so you must not free the group yourself after adding it
364 g_option_context_add_group (GOptionContext *context,
369 g_return_if_fail (context != NULL);
370 g_return_if_fail (group != NULL);
371 g_return_if_fail (group->name != NULL);
372 g_return_if_fail (group->description != NULL);
373 g_return_if_fail (group->help_description != NULL);
375 for (list = context->groups; list; list = list->next)
377 GOptionGroup *g = (GOptionGroup *)list->data;
379 if ((group->name == NULL && g->name == NULL) ||
380 (group->name && g->name && strcmp (group->name, g->name) == 0))
381 g_warning ("A group named \"%s\" is already part of this GOptionContext",
385 context->groups = g_list_append (context->groups, group);
389 * g_option_context_set_main_group:
390 * @context: a #GOptionContext
391 * @group: the group to set as main group
393 * Sets a #GOptionGroup as main group of the @context.
394 * This has the same effect as calling g_option_context_add_group(),
395 * the only difference is that the options in the main group are
396 * treated differently when generating <option>--help</option> output.
401 g_option_context_set_main_group (GOptionContext *context,
404 g_return_if_fail (context != NULL);
405 g_return_if_fail (group != NULL);
407 if (context->main_group)
409 g_warning ("This GOptionContext already has a main group");
414 context->main_group = group;
418 * g_option_context_get_main_group:
419 * @context: a #GOptionContext
421 * Returns a pointer to the main group of @context.
423 * Return value: the main group of @context, or %NULL if @context doesn't
424 * have a main group. Note that group belongs to @context and should
425 * not be modified or freed.
430 g_option_context_get_main_group (GOptionContext *context)
432 g_return_val_if_fail (context != NULL, NULL);
434 return context->main_group;
438 * g_option_context_add_main_entries:
439 * @context: a #GOptionContext
440 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
441 * @translation_domain: a translation domain to use for translating
442 * the <option>--help</option> output for the options in @entries
443 * with gettext(), or %NULL
445 * A convenience function which creates a main group if it doesn't
446 * exist, adds the @entries to it and sets the translation domain.
451 g_option_context_add_main_entries (GOptionContext *context,
452 const GOptionEntry *entries,
453 const gchar *translation_domain)
455 g_return_if_fail (entries != NULL);
457 if (!context->main_group)
458 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
460 g_option_group_add_entries (context->main_group, entries);
461 g_option_group_set_translation_domain (context->main_group, translation_domain);
465 calculate_max_length (GOptionGroup *group)
468 gint i, len, max_length;
472 for (i = 0; i < group->n_entries; i++)
474 entry = &group->entries[i];
476 if (entry->flags & G_OPTION_FLAG_HIDDEN)
479 len = _g_utf8_strwidth (entry->long_name, -1);
481 if (entry->short_name)
484 if (!NO_ARG (entry) && entry->arg_description)
485 len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description), -1);
487 max_length = MAX (max_length, len);
494 print_entry (GOptionGroup *group,
496 const GOptionEntry *entry,
501 if (entry->flags & G_OPTION_FLAG_HIDDEN)
504 if (entry->long_name[0] == 0)
507 str = g_string_new (NULL);
509 if (entry->short_name)
510 g_string_append_printf (str, " -%c, --%s", entry->short_name, entry->long_name);
512 g_string_append_printf (str, " --%s", entry->long_name);
514 if (entry->arg_description)
515 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
517 g_string_append_printf (string, "%s%*s %s\n", str->str,
518 (int) (max_length + 4 - _g_utf8_strwidth (str->str, -1)), "",
519 entry->description ? TRANSLATE (group, entry->description) : "");
520 g_string_free (str, TRUE);
524 * g_option_context_get_help:
525 * @context: a #GOptionContext
526 * @main_help: if %TRUE, only include the main group
527 * @group: the #GOptionGroup to create help for, or %NULL
529 * Returns a formatted, translated help text for the given context.
530 * To obtain the text produced by <option>--help</option>, call
531 * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
532 * To obtain the text produced by <option>--help-all</option>, call
533 * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
534 * To obtain the help text for an option group, call
535 * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
537 * Returns: A newly allocated string containing the help text
542 g_option_context_get_help (GOptionContext *context,
547 gint max_length, len;
550 GHashTable *shadow_map;
552 const gchar *rest_description;
555 string = g_string_sized_new (1024);
557 rest_description = NULL;
558 if (context->main_group)
561 for (i = 0; i < context->main_group->n_entries; i++)
563 entry = &context->main_group->entries[i];
564 if (entry->long_name[0] == 0)
566 rest_description = TRANSLATE (context->main_group, entry->arg_description);
572 g_string_append_printf (string, "%s\n %s %s",
573 _("Usage:"), g_get_prgname(), _("[OPTION...]"));
575 if (rest_description)
577 g_string_append (string, " ");
578 g_string_append (string, rest_description);
581 if (context->parameter_string)
583 g_string_append (string, " ");
584 g_string_append (string, TRANSLATE (context, context->parameter_string));
587 g_string_append (string, "\n\n");
589 if (context->summary)
591 g_string_append (string, TRANSLATE (context, context->summary));
592 g_string_append (string, "\n\n");
595 memset (seen, 0, sizeof (gboolean) * 256);
596 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
598 if (context->main_group)
600 for (i = 0; i < context->main_group->n_entries; i++)
602 entry = &context->main_group->entries[i];
603 g_hash_table_insert (shadow_map,
604 (gpointer)entry->long_name,
607 if (seen[(guchar)entry->short_name])
608 entry->short_name = 0;
610 seen[(guchar)entry->short_name] = TRUE;
614 list = context->groups;
617 GOptionGroup *group = list->data;
618 for (i = 0; i < group->n_entries; i++)
620 entry = &group->entries[i];
621 if (g_hash_table_lookup (shadow_map, entry->long_name) &&
622 !(entry->flags & G_OPTION_FLAG_NOALIAS))
623 entry->long_name = g_strdup_printf ("%s-%s", group->name, entry->long_name);
625 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
627 if (seen[(guchar)entry->short_name] &&
628 !(entry->flags & G_OPTION_FLAG_NOALIAS))
629 entry->short_name = 0;
631 seen[(guchar)entry->short_name] = TRUE;
636 g_hash_table_destroy (shadow_map);
638 list = context->groups;
640 max_length = _g_utf8_strwidth ("-?, --help", -1);
644 len = _g_utf8_strwidth ("--help-all", -1);
645 max_length = MAX (max_length, len);
648 if (context->main_group)
650 len = calculate_max_length (context->main_group);
651 max_length = MAX (max_length, len);
656 GOptionGroup *group = list->data;
658 /* First, we check the --help-<groupname> options */
659 len = _g_utf8_strwidth ("--help-", -1) + _g_utf8_strwidth (group->name, -1);
660 max_length = MAX (max_length, len);
662 /* Then we go through the entries */
663 len = calculate_max_length (group);
664 max_length = MAX (max_length, len);
669 /* Add a bit of padding */
674 list = context->groups;
676 g_string_append_printf (string, "%s\n -%c, --%-*s %s\n",
677 _("Help Options:"), '?', max_length - 4, "help",
678 _("Show help options"));
680 /* We only want --help-all when there are groups */
682 g_string_append_printf (string, " --%-*s %s\n",
683 max_length, "help-all",
684 _("Show all help options"));
688 GOptionGroup *group = list->data;
690 g_string_append_printf (string, " --help-%-*s %s\n",
691 max_length - 5, group->name,
692 TRANSLATE (group, group->help_description));
697 g_string_append (string, "\n");
702 /* Print a certain group */
704 g_string_append (string, TRANSLATE (group, group->description));
705 g_string_append (string, "\n");
706 for (i = 0; i < group->n_entries; i++)
707 print_entry (group, max_length, &group->entries[i], string);
708 g_string_append (string, "\n");
712 /* Print all groups */
714 list = context->groups;
718 GOptionGroup *group = list->data;
720 g_string_append (string, group->description);
721 g_string_append (string, "\n");
722 for (i = 0; i < group->n_entries; i++)
723 if (!(group->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
724 print_entry (group, max_length, &group->entries[i], string);
726 g_string_append (string, "\n");
731 /* Print application options if --help or --help-all has been specified */
732 if (main_help || !group)
734 list = context->groups;
736 g_string_append (string, _("Application Options:"));
737 g_string_append (string, "\n");
738 if (context->main_group)
739 for (i = 0; i < context->main_group->n_entries; i++)
740 print_entry (context->main_group, max_length,
741 &context->main_group->entries[i], string);
745 GOptionGroup *group = list->data;
747 /* Print main entries from other groups */
748 for (i = 0; i < group->n_entries; i++)
749 if (group->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
750 print_entry (group, max_length, &group->entries[i], string);
755 g_string_append (string, "\n");
758 if (context->description)
760 g_string_append (string, TRANSLATE (context, context->description));
761 g_string_append (string, "\n");
764 return g_string_free (string, FALSE);
768 print_help (GOptionContext *context,
774 help = g_option_context_get_help (context, main_help, group);
782 parse_int (const gchar *arg_name,
791 tmp = strtol (arg, &end, 0);
793 if (*arg == '\0' || *end != '\0')
796 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
797 _("Cannot parse integer value '%s' for %s"),
803 if (*result != tmp || errno == ERANGE)
806 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
807 _("Integer value '%s' for %s out of range"),
817 parse_double (const gchar *arg_name,
826 tmp = g_strtod (arg, &end);
828 if (*arg == '\0' || *end != '\0')
831 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
832 _("Cannot parse double value '%s' for %s"),
839 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
840 _("Double value '%s' for %s out of range"),
852 parse_int64 (const gchar *arg_name,
861 tmp = g_ascii_strtoll (arg, &end, 0);
863 if (*arg == '\0' || *end != '\0')
866 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
867 _("Cannot parse integer value '%s' for %s"),
874 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
875 _("Integer value '%s' for %s out of range"),
887 get_change (GOptionContext *context,
892 Change *change = NULL;
894 for (list = context->changes; list != NULL; list = list->next)
898 if (change->arg_data == arg_data)
902 change = g_new0 (Change, 1);
903 change->arg_type = arg_type;
904 change->arg_data = arg_data;
906 context->changes = g_list_prepend (context->changes, change);
914 add_pending_null (GOptionContext *context,
920 n = g_new0 (PendingNull, 1);
924 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
928 parse_arg (GOptionContext *context,
932 const gchar *option_name,
938 g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
942 case G_OPTION_ARG_NONE:
944 change = get_change (context, G_OPTION_ARG_NONE,
947 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
950 case G_OPTION_ARG_STRING:
954 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
959 change = get_change (context, G_OPTION_ARG_STRING,
961 g_free (change->allocated.str);
963 change->prev.str = *(gchar **)entry->arg_data;
964 change->allocated.str = data;
966 *(gchar **)entry->arg_data = data;
969 case G_OPTION_ARG_STRING_ARRAY:
973 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
978 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
981 if (change->allocated.array.len == 0)
983 change->prev.array = *(gchar ***)entry->arg_data;
984 change->allocated.array.data = g_new (gchar *, 2);
987 change->allocated.array.data =
988 g_renew (gchar *, change->allocated.array.data,
989 change->allocated.array.len + 2);
991 change->allocated.array.data[change->allocated.array.len] = data;
992 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
994 change->allocated.array.len ++;
996 *(gchar ***)entry->arg_data = change->allocated.array.data;
1001 case G_OPTION_ARG_FILENAME:
1006 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1011 data = g_strdup (value);
1013 change = get_change (context, G_OPTION_ARG_FILENAME,
1015 g_free (change->allocated.str);
1017 change->prev.str = *(gchar **)entry->arg_data;
1018 change->allocated.str = data;
1020 *(gchar **)entry->arg_data = data;
1024 case G_OPTION_ARG_FILENAME_ARRAY:
1029 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1034 data = g_strdup (value);
1036 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1039 if (change->allocated.array.len == 0)
1041 change->prev.array = *(gchar ***)entry->arg_data;
1042 change->allocated.array.data = g_new (gchar *, 2);
1045 change->allocated.array.data =
1046 g_renew (gchar *, change->allocated.array.data,
1047 change->allocated.array.len + 2);
1049 change->allocated.array.data[change->allocated.array.len] = data;
1050 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1052 change->allocated.array.len ++;
1054 *(gchar ***)entry->arg_data = change->allocated.array.data;
1059 case G_OPTION_ARG_INT:
1063 if (!parse_int (option_name, value,
1068 change = get_change (context, G_OPTION_ARG_INT,
1070 change->prev.integer = *(gint *)entry->arg_data;
1071 *(gint *)entry->arg_data = data;
1074 case G_OPTION_ARG_CALLBACK:
1079 if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1081 else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1083 else if (entry->flags & G_OPTION_FLAG_FILENAME)
1086 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1088 data = g_strdup (value);
1092 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1094 if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1098 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1106 case G_OPTION_ARG_DOUBLE:
1110 if (!parse_double (option_name, value,
1117 change = get_change (context, G_OPTION_ARG_DOUBLE,
1119 change->prev.dbl = *(gdouble *)entry->arg_data;
1120 *(gdouble *)entry->arg_data = data;
1123 case G_OPTION_ARG_INT64:
1127 if (!parse_int64 (option_name, value,
1134 change = get_change (context, G_OPTION_ARG_INT64,
1136 change->prev.int64 = *(gint64 *)entry->arg_data;
1137 *(gint64 *)entry->arg_data = data;
1141 g_assert_not_reached ();
1148 parse_short_option (GOptionContext *context,
1149 GOptionGroup *group,
1160 for (j = 0; j < group->n_entries; j++)
1162 if (arg == group->entries[j].short_name)
1165 gchar *value = NULL;
1167 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1169 if (NO_ARG (&group->entries[j]))
1173 if (*new_index > index)
1176 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1177 _("Error parsing option %s"), option_name);
1178 g_free (option_name);
1182 if (index < *argc - 1)
1184 if (!OPTIONAL_ARG (&group->entries[j]))
1186 value = (*argv)[index + 1];
1187 add_pending_null (context, &((*argv)[index + 1]), NULL);
1188 *new_index = index+1;
1192 if ((*argv)[index + 1][0] == '-')
1196 value = (*argv)[index + 1];
1197 add_pending_null (context, &((*argv)[index + 1]), NULL);
1198 *new_index = index + 1;
1202 else if (index >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1207 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1208 _("Missing argument for %s"), option_name);
1209 g_free (option_name);
1214 if (!parse_arg (context, group, &group->entries[j],
1215 value, option_name, error))
1217 g_free (option_name);
1221 g_free (option_name);
1230 parse_long_option (GOptionContext *context,
1231 GOptionGroup *group,
1242 for (j = 0; j < group->n_entries; j++)
1244 if (*index >= *argc)
1247 if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1250 if (NO_ARG (&group->entries[j]) &&
1251 strcmp (arg, group->entries[j].long_name) == 0)
1255 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1256 parse_arg (context, group, &group->entries[j],
1257 NULL, option_name, error);
1258 g_free(option_name);
1260 add_pending_null (context, &((*argv)[*index]), NULL);
1265 gint len = strlen (group->entries[j].long_name);
1267 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1268 (arg[len] == '=' || arg[len] == 0))
1270 gchar *value = NULL;
1273 add_pending_null (context, &((*argv)[*index]), NULL);
1274 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1276 if (arg[len] == '=')
1277 value = arg + len + 1;
1278 else if (*index < *argc - 1)
1280 if (!(group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG))
1282 value = (*argv)[*index + 1];
1283 add_pending_null (context, &((*argv)[*index + 1]), NULL);
1288 if ((*argv)[*index + 1][0] == '-')
1291 retval = parse_arg (context, group, &group->entries[j],
1292 NULL, option_name, error);
1294 g_free (option_name);
1299 value = (*argv)[*index + 1];
1300 add_pending_null (context, &((*argv)[*index + 1]), NULL);
1305 else if (*index >= *argc - 1 &&
1306 group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG)
1309 retval = parse_arg (context, group, &group->entries[j],
1310 NULL, option_name, error);
1312 g_free (option_name);
1318 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1319 _("Missing argument for %s"), option_name);
1320 g_free (option_name);
1324 if (!parse_arg (context, group, &group->entries[j],
1325 value, option_name, error))
1327 g_free (option_name);
1331 g_free (option_name);
1341 parse_remaining_arg (GOptionContext *context,
1342 GOptionGroup *group,
1351 for (j = 0; j < group->n_entries; j++)
1353 if (*index >= *argc)
1356 if (group->entries[j].long_name[0])
1359 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1360 group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1361 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1363 add_pending_null (context, &((*argv)[*index]), NULL);
1365 if (!parse_arg (context, group, &group->entries[j], (*argv)[*index], "", error))
1376 free_changes_list (GOptionContext *context,
1381 for (list = context->changes; list != NULL; list = list->next)
1383 Change *change = list->data;
1387 switch (change->arg_type)
1389 case G_OPTION_ARG_NONE:
1390 *(gboolean *)change->arg_data = change->prev.bool;
1392 case G_OPTION_ARG_INT:
1393 *(gint *)change->arg_data = change->prev.integer;
1395 case G_OPTION_ARG_STRING:
1396 case G_OPTION_ARG_FILENAME:
1397 g_free (change->allocated.str);
1398 *(gchar **)change->arg_data = change->prev.str;
1400 case G_OPTION_ARG_STRING_ARRAY:
1401 case G_OPTION_ARG_FILENAME_ARRAY:
1402 g_strfreev (change->allocated.array.data);
1403 *(gchar ***)change->arg_data = change->prev.array;
1405 case G_OPTION_ARG_DOUBLE:
1406 *(gdouble *)change->arg_data = change->prev.dbl;
1408 case G_OPTION_ARG_INT64:
1409 *(gint64 *)change->arg_data = change->prev.int64;
1412 g_assert_not_reached ();
1419 g_list_free (context->changes);
1420 context->changes = NULL;
1424 free_pending_nulls (GOptionContext *context,
1425 gboolean perform_nulls)
1429 for (list = context->pending_nulls; list != NULL; list = list->next)
1431 PendingNull *n = list->data;
1437 /* Copy back the short options */
1439 strcpy (*n->ptr + 1, n->value);
1449 g_list_free (context->pending_nulls);
1450 context->pending_nulls = NULL;
1454 * g_option_context_parse:
1455 * @context: a #GOptionContext
1456 * @argc: a pointer to the number of command line arguments
1457 * @argv: a pointer to the array of command line arguments
1458 * @error: a return location for errors
1460 * Parses the command line arguments, recognizing options
1461 * which have been added to @context. A side-effect of
1462 * calling this function is that g_set_prgname() will be
1465 * If the parsing is successful, any parsed arguments are
1466 * removed from the array and @argc and @argv are updated
1467 * accordingly. A '--' option is stripped from @argv
1468 * unless there are unparsed options before and after it,
1469 * or some of the options after it start with '-'. In case
1470 * of an error, @argc and @argv are left unmodified.
1472 * If automatic <option>--help</option> support is enabled
1473 * (see g_option_context_set_help_enabled()), and the
1474 * @argv array contains one of the recognized help options,
1475 * this function will produce help output to stdout and
1476 * call <literal>exit (0)</literal>.
1478 * Note that function depends on the
1479 * <link linkend="setlocale">current locale</link> for
1480 * automatic character set conversion of string and filename
1483 * Return value: %TRUE if the parsing was successful,
1484 * %FALSE if an error occurred
1489 g_option_context_parse (GOptionContext *context,
1497 /* Set program name */
1498 if (!g_get_prgname())
1500 if (argc && argv && *argc)
1504 prgname = g_path_get_basename ((*argv)[0]);
1505 g_set_prgname (prgname);
1509 g_set_prgname ("<unknown>");
1512 /* Call pre-parse hooks */
1513 list = context->groups;
1516 GOptionGroup *group = list->data;
1518 if (group->pre_parse_func)
1520 if (!(* group->pre_parse_func) (context, group,
1521 group->user_data, error))
1528 if (context->main_group && context->main_group->pre_parse_func)
1530 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1531 context->main_group->user_data, error))
1537 gboolean stop_parsing = FALSE;
1538 gboolean has_unknown = FALSE;
1539 gint separator_pos = 0;
1541 for (i = 1; i < *argc; i++)
1544 gboolean parsed = FALSE;
1546 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1548 if ((*argv)[i][1] == '-')
1552 arg = (*argv)[i] + 2;
1554 /* '--' terminates list of arguments */
1558 stop_parsing = TRUE;
1562 /* Handle help options */
1563 if (context->help_enabled)
1565 if (strcmp (arg, "help") == 0)
1566 print_help (context, TRUE, NULL);
1567 else if (strcmp (arg, "help-all") == 0)
1568 print_help (context, FALSE, NULL);
1569 else if (strncmp (arg, "help-", 5) == 0)
1573 list = context->groups;
1577 GOptionGroup *group = list->data;
1579 if (strcmp (arg + 5, group->name) == 0)
1580 print_help (context, FALSE, group);
1587 if (context->main_group &&
1588 !parse_long_option (context, context->main_group, &i, arg,
1589 FALSE, argc, argv, error, &parsed))
1595 /* Try the groups */
1596 list = context->groups;
1599 GOptionGroup *group = list->data;
1601 if (!parse_long_option (context, group, &i, arg,
1602 FALSE, argc, argv, error, &parsed))
1614 /* Now look for --<group>-<option> */
1615 dash = strchr (arg, '-');
1618 /* Try the groups */
1619 list = context->groups;
1622 GOptionGroup *group = list->data;
1624 if (strncmp (group->name, arg, dash - arg) == 0)
1626 if (!parse_long_option (context, group, &i, dash + 1,
1627 TRUE, argc, argv, error, &parsed))
1638 if (context->ignore_unknown)
1642 { /* short option */
1643 gint j, new_i = i, arg_length;
1644 gboolean *nulled_out = NULL;
1645 arg = (*argv)[i] + 1;
1646 arg_length = strlen (arg);
1647 nulled_out = g_newa (gboolean, arg_length);
1648 memset (nulled_out, 0, arg_length * sizeof (gboolean));
1649 for (j = 0; j < arg_length; j++)
1651 if (context->help_enabled && arg[j] == '?')
1652 print_help (context, TRUE, NULL);
1654 if (context->main_group &&
1655 !parse_short_option (context, context->main_group,
1657 argc, argv, error, &parsed))
1661 /* Try the groups */
1662 list = context->groups;
1665 GOptionGroup *group = list->data;
1666 if (!parse_short_option (context, group, i, &new_i, arg[j],
1667 argc, argv, error, &parsed))
1675 if (context->ignore_unknown && parsed)
1676 nulled_out[j] = TRUE;
1677 else if (context->ignore_unknown)
1681 /* !context->ignore_unknown && parsed */
1683 if (context->ignore_unknown)
1685 gchar *new_arg = NULL;
1687 for (j = 0; j < arg_length; j++)
1692 new_arg = g_malloc (arg_length + 1);
1693 new_arg[arg_index++] = arg[j];
1697 new_arg[arg_index] = '\0';
1698 add_pending_null (context, &((*argv)[i]), new_arg);
1702 add_pending_null (context, &((*argv)[i]), NULL);
1710 if (!parsed && !context->ignore_unknown)
1713 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1714 _("Unknown option %s"), (*argv)[i]);
1720 /* Collect remaining args */
1721 if (context->main_group &&
1722 !parse_remaining_arg (context, context->main_group, &i,
1723 argc, argv, error, &parsed))
1726 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1731 if (separator_pos > 0)
1732 add_pending_null (context, &((*argv)[separator_pos]), NULL);
1736 /* Call post-parse hooks */
1737 list = context->groups;
1740 GOptionGroup *group = list->data;
1742 if (group->post_parse_func)
1744 if (!(* group->post_parse_func) (context, group,
1745 group->user_data, error))
1752 if (context->main_group && context->main_group->post_parse_func)
1754 if (!(* context->main_group->post_parse_func) (context, context->main_group,
1755 context->main_group->user_data, error))
1761 free_pending_nulls (context, TRUE);
1763 for (i = 1; i < *argc; i++)
1765 for (k = i; k < *argc; k++)
1766 if ((*argv)[k] != NULL)
1772 for (j = i + k; j < *argc; j++)
1774 (*argv)[j-k] = (*argv)[j];
1786 /* Call error hooks */
1787 list = context->groups;
1790 GOptionGroup *group = list->data;
1792 if (group->error_func)
1793 (* group->error_func) (context, group,
1794 group->user_data, error);
1799 if (context->main_group && context->main_group->error_func)
1800 (* context->main_group->error_func) (context, context->main_group,
1801 context->main_group->user_data, error);
1803 free_changes_list (context, TRUE);
1804 free_pending_nulls (context, FALSE);
1810 * g_option_group_new:
1811 * @name: the name for the option group, this is used to provide
1812 * help for the options in this group with <option>--help-</option>@name
1813 * @description: a description for this group to be shown in
1814 * <option>--help</option>. This string is translated using the translation
1815 * domain or translation function of the group
1816 * @help_description: a description for the <option>--help-</option>@name option.
1817 * This string is translated using the translation domain or translation function
1819 * @user_data: user data that will be passed to the pre- and post-parse hooks,
1820 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1821 * @destroy: a function that will be called to free @user_data, or %NULL
1823 * Creates a new #GOptionGroup.
1825 * Return value: a newly created option group. It should be added
1826 * to a #GOptionContext or freed with g_option_group_free().
1831 g_option_group_new (const gchar *name,
1832 const gchar *description,
1833 const gchar *help_description,
1835 GDestroyNotify destroy)
1838 GOptionGroup *group;
1840 group = g_new0 (GOptionGroup, 1);
1841 group->name = g_strdup (name);
1842 group->description = g_strdup (description);
1843 group->help_description = g_strdup (help_description);
1844 group->user_data = user_data;
1845 group->destroy_notify = destroy;
1852 * g_option_group_free:
1853 * @group: a #GOptionGroup
1855 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
1856 * free groups which have been added to a #GOptionContext.
1861 g_option_group_free (GOptionGroup *group)
1863 g_return_if_fail (group != NULL);
1865 g_free (group->name);
1866 g_free (group->description);
1867 g_free (group->help_description);
1869 g_free (group->entries);
1871 if (group->destroy_notify)
1872 (* group->destroy_notify) (group->user_data);
1874 if (group->translate_notify)
1875 (* group->translate_notify) (group->translate_data);
1882 * g_option_group_add_entries:
1883 * @group: a #GOptionGroup
1884 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
1886 * Adds the options specified in @entries to @group.
1891 g_option_group_add_entries (GOptionGroup *group,
1892 const GOptionEntry *entries)
1896 g_return_if_fail (entries != NULL);
1898 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
1900 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
1902 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
1904 for (i = group->n_entries; i < group->n_entries + n_entries; i++)
1906 gchar c = group->entries[i].short_name;
1910 if (c == '-' || !g_ascii_isprint (c))
1912 g_warning (G_STRLOC": ignoring invalid short option '%c' (%d)", c, c);
1913 group->entries[i].short_name = 0;
1918 group->n_entries += n_entries;
1922 * g_option_group_set_parse_hooks:
1923 * @group: a #GOptionGroup
1924 * @pre_parse_func: a function to call before parsing, or %NULL
1925 * @post_parse_func: a function to call after parsing, or %NULL
1927 * Associates two functions with @group which will be called
1928 * from g_option_context_parse() before the first option is parsed
1929 * and after the last option has been parsed, respectively.
1931 * Note that the user data to be passed to @pre_parse_func and
1932 * @post_parse_func can be specified when constructing the group
1933 * with g_option_group_new().
1938 g_option_group_set_parse_hooks (GOptionGroup *group,
1939 GOptionParseFunc pre_parse_func,
1940 GOptionParseFunc post_parse_func)
1942 g_return_if_fail (group != NULL);
1944 group->pre_parse_func = pre_parse_func;
1945 group->post_parse_func = post_parse_func;
1949 * g_option_group_set_error_hook:
1950 * @group: a #GOptionGroup
1951 * @error_func: a function to call when an error occurs
1953 * Associates a function with @group which will be called
1954 * from g_option_context_parse() when an error occurs.
1956 * Note that the user data to be passed to @pre_parse_func and
1957 * @post_parse_func can be specified when constructing the group
1958 * with g_option_group_new().
1963 g_option_group_set_error_hook (GOptionGroup *group,
1964 GOptionErrorFunc error_func)
1966 g_return_if_fail (group != NULL);
1968 group->error_func = error_func;
1973 * g_option_group_set_translate_func:
1974 * @group: a #GOptionGroup
1975 * @func: the #GTranslateFunc, or %NULL
1976 * @data: user data to pass to @func, or %NULL
1977 * @destroy_notify: a function which gets called to free @data, or %NULL
1979 * Sets the function which is used to translate user-visible
1980 * strings, for <option>--help</option> output. Different
1981 * groups can use different #GTranslateFunc<!-- -->s. If @func
1982 * is %NULL, strings are not translated.
1984 * If you are using gettext(), you only need to set the translation
1985 * domain, see g_option_group_set_translation_domain().
1990 g_option_group_set_translate_func (GOptionGroup *group,
1991 GTranslateFunc func,
1993 GDestroyNotify destroy_notify)
1995 g_return_if_fail (group != NULL);
1997 if (group->translate_notify)
1998 group->translate_notify (group->translate_data);
2000 group->translate_func = func;
2001 group->translate_data = data;
2002 group->translate_notify = destroy_notify;
2006 dgettext_swapped (const gchar *msgid,
2007 const gchar *domainname)
2009 return dgettext (domainname, msgid);
2013 * g_option_group_set_translation_domain:
2014 * @group: a #GOptionGroup
2015 * @domain: the domain to use
2017 * A convenience function to use gettext() for translating
2018 * user-visible strings.
2023 g_option_group_set_translation_domain (GOptionGroup *group,
2024 const gchar *domain)
2026 g_return_if_fail (group != NULL);
2028 g_option_group_set_translate_func (group,
2029 (GTranslateFunc)dgettext_swapped,
2035 * g_option_context_set_translate_func:
2036 * @context: a #GOptionContext
2037 * @func: the #GTranslateFunc, or %NULL
2038 * @data: user data to pass to @func, or %NULL
2039 * @destroy_notify: a function which gets called to free @data, or %NULL
2041 * Sets the function which is used to translate the contexts
2042 * user-visible strings, for <option>--help</option> output.
2043 * If @func is %NULL, strings are not translated.
2045 * Note that option groups have their own translation functions,
2046 * this function only affects the @parameter_string (see g_option_context_new()),
2047 * the summary (see g_option_context_set_summary()) and the description
2048 * (see g_option_context_set_description()).
2050 * If you are using gettext(), you only need to set the translation
2051 * domain, see g_context_group_set_translation_domain().
2056 g_option_context_set_translate_func (GOptionContext *context,
2057 GTranslateFunc func,
2059 GDestroyNotify destroy_notify)
2061 g_return_if_fail (context != NULL);
2063 if (context->translate_notify)
2064 context->translate_notify (context->translate_data);
2066 context->translate_func = func;
2067 context->translate_data = data;
2068 context->translate_notify = destroy_notify;
2072 * g_option_context_set_translation_domain:
2073 * @context: a #GOptionContext
2074 * @domain: the domain to use
2076 * A convenience function to use gettext() for translating
2077 * user-visible strings.
2082 g_option_context_set_translation_domain (GOptionContext *context,
2083 const gchar *domain)
2085 g_return_if_fail (context != NULL);
2087 g_option_context_set_translate_func (context,
2088 (GTranslateFunc)dgettext_swapped,
2094 * g_option_context_set_summary:
2095 * @context: a #GOptionContext
2096 * @summary: a string to be shown in <option>--help</option> output
2097 * before the list of options, or %NULL
2099 * Adds a string to be displayed in <option>--help</option> output
2100 * before the list of options. This is typically a summary of the
2101 * program functionality.
2103 * Note that the summary is translated (see
2104 * g_option_context_set_translate_func(), g_option_context_set_translation_domain()).
2109 g_option_context_set_summary (GOptionContext *context,
2110 const gchar *summary)
2112 g_return_if_fail (context != NULL);
2114 g_free (context->summary);
2115 context->summary = g_strdup (summary);
2120 * g_option_context_get_summary:
2121 * @context: a #GOptionContext
2123 * Returns the summary. See g_option_context_set_summary().
2125 * Returns: the summary
2129 G_CONST_RETURN gchar *
2130 g_option_context_get_summary (GOptionContext *context)
2132 g_return_val_if_fail (context != NULL, NULL);
2134 return context->summary;
2138 * g_option_context_set_description:
2139 * @context: a #GOptionContext
2140 * @description: a string to be shown in <option>--help</option> output
2141 * after the list of options, or %NULL
2143 * Adds a string to be displayed in <option>--help</option> output
2144 * after the list of options. This text often includes a bug reporting
2147 * Note that the summary is translated (see
2148 * g_option_context_set_translate_func()).
2153 g_option_context_set_description (GOptionContext *context,
2154 const gchar *description)
2156 g_return_if_fail (context != NULL);
2158 g_free (context->description);
2159 context->description = g_strdup (description);
2164 * g_option_context_get_description:
2165 * @context: a #GOptionContext
2167 * Returns the description. See g_option_context_set_description().
2169 * Returns: the description
2173 G_CONST_RETURN gchar *
2174 g_option_context_get_description (GOptionContext *context)
2176 g_return_val_if_fail (context != NULL, NULL);
2178 return context->description;
2182 #define __G_OPTION_C__
2183 #include "galiasdef.c"