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.
24 * @Short_description: parses commandline options
25 * @Title: Commandline option parser
27 * The GOption commandline parser is intended to be a simpler replacement
28 * for the popt library. It supports short and long commandline options,
29 * as shown in the following example:
31 * <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal>
33 * The example demonstrates a number of features of the GOption
35 * <itemizedlist><listitem><para>
36 * Options can be single letters, prefixed by a single dash. Multiple
37 * short options can be grouped behind a single dash.
38 * </para></listitem><listitem><para>
39 * Long options are prefixed by two consecutive dashes.
40 * </para></listitem><listitem><para>
41 * Options can have an extra argument, which can be a number, a string or
42 * a filename. For long options, the extra argument can be appended with
43 * an equals sign after the option name, which is useful if the extra
44 * argument starts with a dash, which would otherwise cause it to be
45 * interpreted as another option.
46 * </para></listitem><listitem><para>
47 * Non-option arguments are returned to the application as rest arguments.
48 * </para></listitem><listitem><para>
49 * An argument consisting solely of two dashes turns off further parsing,
50 * any remaining arguments (even those starting with a dash) are returned
51 * to the application as rest arguments.
52 * </para></listitem></itemizedlist>
54 * Another important feature of GOption is that it can automatically
55 * generate nicely formatted help output. Unless it is explicitly turned
56 * off with g_option_context_set_help_enabled(), GOption will recognize
57 * the <option>--help</option>, <option>-?</option>,
58 * <option>--help-all</option> and
59 * <option>--help-</option><replaceable>groupname</replaceable> options
60 * (where <replaceable>groupname</replaceable> is the name of a
61 * #GOptionGroup) and write a text similar to the one shown in the
62 * following example to stdout.
64 * <informalexample><screen>
66 * testtreemodel [OPTION...] - test tree model performance
69 * -h, --help Show help options
70 * --help-all Show all help options
71 * --help-gtk Show GTK+ Options
73 * Application Options:
74 * -r, --repeats=N Average over N repetitions
75 * -m, --max-size=M Test up to 2^M items
76 * --display=DISPLAY X display to use
77 * -v, --verbose Be verbose
78 * -b, --beep Beep when done
79 * --rand Randomize the data
80 * </screen></informalexample>
82 * GOption groups options in #GOptionGroup<!-- -->s, which makes it easy to
83 * incorporate options from multiple sources. The intended use for this is
84 * to let applications collect option groups from the libraries it uses,
85 * add them to their #GOptionContext, and parse all options by a single call
86 * to g_option_context_parse(). See gtk_get_option_group() for an example.
88 * If an option is declared to be of type string or filename, GOption takes
89 * care of converting it to the right encoding; strings are returned in
90 * UTF-8, filenames are returned in the GLib filename encoding. Note that
91 * this only works if setlocale() has been called before
92 * g_option_context_parse().
94 * Here is a complete example of setting up GOption to parse the example
95 * commandline above and produce the example help output.
97 * <informalexample><programlisting>
98 * static gint repeats = 2;
99 * static gint max_size = 8;
100 * static gboolean verbose = FALSE;
101 * static gboolean beep = FALSE;
102 * static gboolean rand = FALSE;
104 * static GOptionEntry entries[] =
106 * { "repeats", 'r', 0, G_OPTION_ARG_INT, &repeats, "Average over N repetitions", "N" },
107 * { "max-size", 'm', 0, G_OPTION_ARG_INT, &max_size, "Test up to 2^M items", "M" },
108 * { "verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose, "Be verbose", NULL },
109 * { "beep", 'b', 0, G_OPTION_ARG_NONE, &beep, "Beep when done", NULL },
110 * { "rand", 0, 0, G_OPTION_ARG_NONE, &rand, "Randomize the data", NULL },
115 * main (int argc, char *argv[])
117 * GError *error = NULL;
118 * GOptionContext *context;
120 * context = g_option_context_new ("- test tree model performance");
121 * g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
122 * g_option_context_add_group (context, gtk_get_option_group (TRUE));
123 * if (!g_option_context_parse (context, &argc, &argv, &error))
125 * g_print ("option parsing failed: %s\n", error->message);
132 * </programlisting></informalexample>
142 #if defined __OpenBSD__
143 #include <sys/types.h>
145 #include <sys/param.h>
146 #include <sys/sysctl.h>
152 #include "glibintl.h"
154 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
156 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
157 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
158 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
160 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
161 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
193 struct _GOptionContext
197 gchar *parameter_string;
201 GTranslateFunc translate_func;
202 GDestroyNotify translate_notify;
203 gpointer translate_data;
205 guint help_enabled : 1;
206 guint ignore_unknown : 1;
208 GOptionGroup *main_group;
210 /* We keep a list of change so we can revert them */
213 /* We also keep track of all argv elements
214 * that should be NULLed or modified.
216 GList *pending_nulls;
223 gchar *help_description;
225 GDestroyNotify destroy_notify;
228 GTranslateFunc translate_func;
229 GDestroyNotify translate_notify;
230 gpointer translate_data;
232 GOptionEntry *entries;
235 GOptionParseFunc pre_parse_func;
236 GOptionParseFunc post_parse_func;
237 GOptionErrorFunc error_func;
240 static void free_changes_list (GOptionContext *context,
242 static void free_pending_nulls (GOptionContext *context,
243 gboolean perform_nulls);
247 _g_unichar_get_width (gunichar c)
249 if (G_UNLIKELY (g_unichar_iszerowidth (c)))
252 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
253 * some locales (legacy East Asian ones) */
254 if (g_unichar_iswide (c))
261 _g_utf8_strwidth (const gchar *p)
264 g_return_val_if_fail (p != NULL, 0);
268 len += _g_unichar_get_width (g_utf8_get_char (p));
269 p = g_utf8_next_char (p);
275 G_DEFINE_QUARK (g-option-context-error-quark, g_option_error)
278 * g_option_context_new:
279 * @parameter_string: (allow-none): a string which is displayed in
280 * the first line of <option>--help</option> output, after the
282 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
284 * Creates a new option context.
286 * The @parameter_string can serve multiple purposes. It can be used
287 * to add descriptions for "rest" arguments, which are not parsed by
288 * the #GOptionContext, typically something like "FILES" or
289 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
290 * collecting "rest" arguments, GLib handles this automatically by
291 * using the @arg_description of the corresponding #GOptionEntry in
294 * Another usage is to give a short summary of the program
295 * functionality, like " - frob the strings", which will be displayed
296 * in the same line as the usage. For a longer description of the
297 * program functionality that should be displayed as a paragraph
298 * below the usage line, use g_option_context_set_summary().
300 * Note that the @parameter_string is translated using the
301 * function set with g_option_context_set_translate_func(), so
302 * it should normally be passed untranslated.
304 * Returns: a newly created #GOptionContext, which must be
305 * freed with g_option_context_free() after use.
310 g_option_context_new (const gchar *parameter_string)
313 GOptionContext *context;
315 context = g_new0 (GOptionContext, 1);
317 context->parameter_string = g_strdup (parameter_string);
318 context->help_enabled = TRUE;
319 context->ignore_unknown = FALSE;
325 * g_option_context_free:
326 * @context: a #GOptionContext
328 * Frees context and all the groups which have been
331 * Please note that parsed arguments need to be freed separately (see
336 void g_option_context_free (GOptionContext *context)
338 g_return_if_fail (context != NULL);
340 g_list_free_full (context->groups, (GDestroyNotify) g_option_group_free);
342 if (context->main_group)
343 g_option_group_free (context->main_group);
345 free_changes_list (context, FALSE);
346 free_pending_nulls (context, FALSE);
348 g_free (context->parameter_string);
349 g_free (context->summary);
350 g_free (context->description);
352 if (context->translate_notify)
353 (* context->translate_notify) (context->translate_data);
360 * g_option_context_set_help_enabled:
361 * @context: a #GOptionContext
362 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
364 * Enables or disables automatic generation of <option>--help</option>
365 * output. By default, g_option_context_parse() recognizes
366 * <option>--help</option>, <option>-h</option>,
367 * <option>-?</option>, <option>--help-all</option>
368 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
369 * suitable output to stdout.
373 void g_option_context_set_help_enabled (GOptionContext *context,
374 gboolean help_enabled)
377 g_return_if_fail (context != NULL);
379 context->help_enabled = help_enabled;
383 * g_option_context_get_help_enabled:
384 * @context: a #GOptionContext
386 * Returns whether automatic <option>--help</option> generation
387 * is turned on for @context. See g_option_context_set_help_enabled().
389 * Returns: %TRUE if automatic help generation is turned on.
394 g_option_context_get_help_enabled (GOptionContext *context)
396 g_return_val_if_fail (context != NULL, FALSE);
398 return context->help_enabled;
402 * g_option_context_set_ignore_unknown_options:
403 * @context: a #GOptionContext
404 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
405 * an error when unknown options are met
407 * Sets whether to ignore unknown options or not. If an argument is
408 * ignored, it is left in the @argv array after parsing. By default,
409 * g_option_context_parse() treats unknown options as error.
411 * This setting does not affect non-option arguments (i.e. arguments
412 * which don't start with a dash). But note that GOption cannot reliably
413 * determine whether a non-option belongs to a preceding unknown option.
418 g_option_context_set_ignore_unknown_options (GOptionContext *context,
419 gboolean ignore_unknown)
421 g_return_if_fail (context != NULL);
423 context->ignore_unknown = ignore_unknown;
427 * g_option_context_get_ignore_unknown_options:
428 * @context: a #GOptionContext
430 * Returns whether unknown options are ignored or not. See
431 * g_option_context_set_ignore_unknown_options().
433 * Returns: %TRUE if unknown options are ignored.
438 g_option_context_get_ignore_unknown_options (GOptionContext *context)
440 g_return_val_if_fail (context != NULL, FALSE);
442 return context->ignore_unknown;
446 * g_option_context_add_group:
447 * @context: a #GOptionContext
448 * @group: the group to add
450 * Adds a #GOptionGroup to the @context, so that parsing with @context
451 * will recognize the options in the group. Note that the group will
452 * be freed together with the context when g_option_context_free() is
453 * called, so you must not free the group yourself after adding it
459 g_option_context_add_group (GOptionContext *context,
464 g_return_if_fail (context != NULL);
465 g_return_if_fail (group != NULL);
466 g_return_if_fail (group->name != NULL);
467 g_return_if_fail (group->description != NULL);
468 g_return_if_fail (group->help_description != NULL);
470 for (list = context->groups; list; list = list->next)
472 GOptionGroup *g = (GOptionGroup *)list->data;
474 if ((group->name == NULL && g->name == NULL) ||
475 (group->name && g->name && strcmp (group->name, g->name) == 0))
476 g_warning ("A group named \"%s\" is already part of this GOptionContext",
480 context->groups = g_list_append (context->groups, group);
484 * g_option_context_set_main_group:
485 * @context: a #GOptionContext
486 * @group: the group to set as main group
488 * Sets a #GOptionGroup as main group of the @context.
489 * This has the same effect as calling g_option_context_add_group(),
490 * the only difference is that the options in the main group are
491 * treated differently when generating <option>--help</option> output.
496 g_option_context_set_main_group (GOptionContext *context,
499 g_return_if_fail (context != NULL);
500 g_return_if_fail (group != NULL);
502 if (context->main_group)
504 g_warning ("This GOptionContext already has a main group");
509 context->main_group = group;
513 * g_option_context_get_main_group:
514 * @context: a #GOptionContext
516 * Returns a pointer to the main group of @context.
518 * Return value: the main group of @context, or %NULL if @context doesn't
519 * have a main group. Note that group belongs to @context and should
520 * not be modified or freed.
525 g_option_context_get_main_group (GOptionContext *context)
527 g_return_val_if_fail (context != NULL, NULL);
529 return context->main_group;
533 * g_option_context_add_main_entries:
534 * @context: a #GOptionContext
535 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
536 * @translation_domain: (allow-none): a translation domain to use for translating
537 * the <option>--help</option> output for the options in @entries
538 * with gettext(), or %NULL
540 * A convenience function which creates a main group if it doesn't
541 * exist, adds the @entries to it and sets the translation domain.
546 g_option_context_add_main_entries (GOptionContext *context,
547 const GOptionEntry *entries,
548 const gchar *translation_domain)
550 g_return_if_fail (entries != NULL);
552 if (!context->main_group)
553 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
555 g_option_group_add_entries (context->main_group, entries);
556 g_option_group_set_translation_domain (context->main_group, translation_domain);
560 calculate_max_length (GOptionGroup *group,
564 gint i, len, max_length;
565 const gchar *long_name;
569 for (i = 0; i < group->n_entries; i++)
571 entry = &group->entries[i];
573 if (entry->flags & G_OPTION_FLAG_HIDDEN)
576 long_name = g_hash_table_lookup (aliases, &entry->long_name);
578 long_name = entry->long_name;
579 len = _g_utf8_strwidth (long_name);
581 if (entry->short_name)
584 if (!NO_ARG (entry) && entry->arg_description)
585 len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description));
587 max_length = MAX (max_length, len);
594 print_entry (GOptionGroup *group,
596 const GOptionEntry *entry,
601 const gchar *long_name;
603 if (entry->flags & G_OPTION_FLAG_HIDDEN)
606 if (entry->long_name[0] == 0)
609 long_name = g_hash_table_lookup (aliases, &entry->long_name);
611 long_name = entry->long_name;
613 str = g_string_new (NULL);
615 if (entry->short_name)
616 g_string_append_printf (str, " -%c, --%s", entry->short_name, long_name);
618 g_string_append_printf (str, " --%s", long_name);
620 if (entry->arg_description)
621 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
623 g_string_append_printf (string, "%s%*s %s\n", str->str,
624 (int) (max_length + 4 - _g_utf8_strwidth (str->str)), "",
625 entry->description ? TRANSLATE (group, entry->description) : "");
626 g_string_free (str, TRUE);
630 group_has_visible_entries (GOptionContext *context,
632 gboolean main_entries)
634 GOptionFlags reject_filter = G_OPTION_FLAG_HIDDEN;
637 gboolean main_group = group == context->main_group;
640 reject_filter |= G_OPTION_FLAG_IN_MAIN;
642 for (i = 0, l = (group ? group->n_entries : 0); i < l; i++)
644 entry = &group->entries[i];
646 if (main_entries && !main_group && !(entry->flags & G_OPTION_FLAG_IN_MAIN))
648 if (entry->long_name[0] == 0) /* ignore rest entry */
650 if (!(entry->flags & reject_filter))
658 group_list_has_visible_entries (GOptionContext *context,
660 gboolean main_entries)
664 if (group_has_visible_entries (context, group_list->data, main_entries))
667 group_list = group_list->next;
674 context_has_h_entry (GOptionContext *context)
679 if (context->main_group)
681 for (i = 0; i < context->main_group->n_entries; i++)
683 if (context->main_group->entries[i].short_name == 'h')
688 for (list = context->groups; list != NULL; list = g_list_next (list))
692 group = (GOptionGroup*)list->data;
693 for (i = 0; i < group->n_entries; i++)
695 if (group->entries[i].short_name == 'h')
703 * g_option_context_get_help:
704 * @context: a #GOptionContext
705 * @main_help: if %TRUE, only include the main group
706 * @group: (allow-none): the #GOptionGroup to create help for, or %NULL
708 * Returns a formatted, translated help text for the given context.
709 * To obtain the text produced by <option>--help</option>, call
710 * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
711 * To obtain the text produced by <option>--help-all</option>, call
712 * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
713 * To obtain the help text for an option group, call
714 * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
716 * Returns: A newly allocated string containing the help text
721 g_option_context_get_help (GOptionContext *context,
726 gint max_length, len;
729 GHashTable *shadow_map;
732 const gchar *rest_description;
736 string = g_string_sized_new (1024);
738 rest_description = NULL;
739 if (context->main_group)
742 for (i = 0; i < context->main_group->n_entries; i++)
744 entry = &context->main_group->entries[i];
745 if (entry->long_name[0] == 0)
747 rest_description = TRANSLATE (context->main_group, entry->arg_description);
753 g_string_append_printf (string, "%s\n %s %s",
754 _("Usage:"), g_get_prgname(), _("[OPTION...]"));
756 if (rest_description)
758 g_string_append (string, " ");
759 g_string_append (string, rest_description);
762 if (context->parameter_string)
764 g_string_append (string, " ");
765 g_string_append (string, TRANSLATE (context, context->parameter_string));
768 g_string_append (string, "\n\n");
770 if (context->summary)
772 g_string_append (string, TRANSLATE (context, context->summary));
773 g_string_append (string, "\n\n");
776 memset (seen, 0, sizeof (gboolean) * 256);
777 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
778 aliases = g_hash_table_new_full (NULL, NULL, NULL, g_free);
780 if (context->main_group)
782 for (i = 0; i < context->main_group->n_entries; i++)
784 entry = &context->main_group->entries[i];
785 g_hash_table_insert (shadow_map,
786 (gpointer)entry->long_name,
789 if (seen[(guchar)entry->short_name])
790 entry->short_name = 0;
792 seen[(guchar)entry->short_name] = TRUE;
796 list = context->groups;
799 GOptionGroup *g = list->data;
800 for (i = 0; i < g->n_entries; i++)
802 entry = &g->entries[i];
803 if (g_hash_table_lookup (shadow_map, entry->long_name) &&
804 !(entry->flags & G_OPTION_FLAG_NOALIAS))
806 g_hash_table_insert (aliases, &entry->long_name,
807 g_strdup_printf ("%s-%s", g->name, entry->long_name));
810 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
812 if (seen[(guchar)entry->short_name] &&
813 !(entry->flags & G_OPTION_FLAG_NOALIAS))
814 entry->short_name = 0;
816 seen[(guchar)entry->short_name] = TRUE;
821 g_hash_table_destroy (shadow_map);
823 list = context->groups;
825 max_length = _g_utf8_strwidth ("-?, --help");
829 len = _g_utf8_strwidth ("--help-all");
830 max_length = MAX (max_length, len);
833 if (context->main_group)
835 len = calculate_max_length (context->main_group, aliases);
836 max_length = MAX (max_length, len);
841 GOptionGroup *g = list->data;
843 /* First, we check the --help-<groupname> options */
844 len = _g_utf8_strwidth ("--help-") + _g_utf8_strwidth (g->name);
845 max_length = MAX (max_length, len);
847 /* Then we go through the entries */
848 len = calculate_max_length (g, aliases);
849 max_length = MAX (max_length, len);
854 /* Add a bit of padding */
859 list = context->groups;
861 token = context_has_h_entry (context) ? '?' : 'h';
863 g_string_append_printf (string, "%s\n -%c, --%-*s %s\n",
864 _("Help Options:"), token, max_length - 4, "help",
865 _("Show help options"));
867 /* We only want --help-all when there are groups */
869 g_string_append_printf (string, " --%-*s %s\n",
870 max_length, "help-all",
871 _("Show all help options"));
875 GOptionGroup *g = list->data;
877 if (group_has_visible_entries (context, g, FALSE))
878 g_string_append_printf (string, " --help-%-*s %s\n",
879 max_length - 5, g->name,
880 TRANSLATE (g, g->help_description));
885 g_string_append (string, "\n");
890 /* Print a certain group */
892 if (group_has_visible_entries (context, group, FALSE))
894 g_string_append (string, TRANSLATE (group, group->description));
895 g_string_append (string, "\n");
896 for (i = 0; i < group->n_entries; i++)
897 print_entry (group, max_length, &group->entries[i], string, aliases);
898 g_string_append (string, "\n");
903 /* Print all groups */
905 list = context->groups;
909 GOptionGroup *g = list->data;
911 if (group_has_visible_entries (context, g, FALSE))
913 g_string_append (string, g->description);
914 g_string_append (string, "\n");
915 for (i = 0; i < g->n_entries; i++)
916 if (!(g->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
917 print_entry (g, max_length, &g->entries[i], string, aliases);
919 g_string_append (string, "\n");
926 /* Print application options if --help or --help-all has been specified */
927 if ((main_help || !group) &&
928 (group_has_visible_entries (context, context->main_group, TRUE) ||
929 group_list_has_visible_entries (context, context->groups, TRUE)))
931 list = context->groups;
933 g_string_append (string, _("Application Options:"));
934 g_string_append (string, "\n");
935 if (context->main_group)
936 for (i = 0; i < context->main_group->n_entries; i++)
937 print_entry (context->main_group, max_length,
938 &context->main_group->entries[i], string, aliases);
942 GOptionGroup *g = list->data;
944 /* Print main entries from other groups */
945 for (i = 0; i < g->n_entries; i++)
946 if (g->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
947 print_entry (g, max_length, &g->entries[i], string, aliases);
952 g_string_append (string, "\n");
955 if (context->description)
957 g_string_append (string, TRANSLATE (context, context->description));
958 g_string_append (string, "\n");
961 g_hash_table_destroy (aliases);
963 return g_string_free (string, FALSE);
968 print_help (GOptionContext *context,
974 help = g_option_context_get_help (context, main_help, group);
975 g_print ("%s", help);
982 parse_int (const gchar *arg_name,
991 tmp = strtol (arg, &end, 0);
993 if (*arg == '\0' || *end != '\0')
996 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
997 _("Cannot parse integer value '%s' for %s"),
1003 if (*result != tmp || errno == ERANGE)
1006 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1007 _("Integer value '%s' for %s out of range"),
1017 parse_double (const gchar *arg_name,
1026 tmp = g_strtod (arg, &end);
1028 if (*arg == '\0' || *end != '\0')
1031 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1032 _("Cannot parse double value '%s' for %s"),
1036 if (errno == ERANGE)
1039 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1040 _("Double value '%s' for %s out of range"),
1052 parse_int64 (const gchar *arg_name,
1061 tmp = g_ascii_strtoll (arg, &end, 0);
1063 if (*arg == '\0' || *end != '\0')
1066 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1067 _("Cannot parse integer value '%s' for %s"),
1071 if (errno == ERANGE)
1074 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1075 _("Integer value '%s' for %s out of range"),
1087 get_change (GOptionContext *context,
1088 GOptionArg arg_type,
1092 Change *change = NULL;
1094 for (list = context->changes; list != NULL; list = list->next)
1096 change = list->data;
1098 if (change->arg_data == arg_data)
1102 change = g_new0 (Change, 1);
1103 change->arg_type = arg_type;
1104 change->arg_data = arg_data;
1106 context->changes = g_list_prepend (context->changes, change);
1114 add_pending_null (GOptionContext *context,
1120 n = g_new0 (PendingNull, 1);
1124 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
1128 parse_arg (GOptionContext *context,
1129 GOptionGroup *group,
1130 GOptionEntry *entry,
1132 const gchar *option_name,
1138 g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
1142 case G_OPTION_ARG_NONE:
1144 change = get_change (context, G_OPTION_ARG_NONE,
1147 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1150 case G_OPTION_ARG_STRING:
1154 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1159 change = get_change (context, G_OPTION_ARG_STRING,
1161 g_free (change->allocated.str);
1163 change->prev.str = *(gchar **)entry->arg_data;
1164 change->allocated.str = data;
1166 *(gchar **)entry->arg_data = data;
1169 case G_OPTION_ARG_STRING_ARRAY:
1173 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1178 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1181 if (change->allocated.array.len == 0)
1183 change->prev.array = *(gchar ***)entry->arg_data;
1184 change->allocated.array.data = g_new (gchar *, 2);
1187 change->allocated.array.data =
1188 g_renew (gchar *, change->allocated.array.data,
1189 change->allocated.array.len + 2);
1191 change->allocated.array.data[change->allocated.array.len] = data;
1192 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1194 change->allocated.array.len ++;
1196 *(gchar ***)entry->arg_data = change->allocated.array.data;
1201 case G_OPTION_ARG_FILENAME:
1206 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1211 data = g_strdup (value);
1213 change = get_change (context, G_OPTION_ARG_FILENAME,
1215 g_free (change->allocated.str);
1217 change->prev.str = *(gchar **)entry->arg_data;
1218 change->allocated.str = data;
1220 *(gchar **)entry->arg_data = data;
1224 case G_OPTION_ARG_FILENAME_ARRAY:
1229 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1234 data = g_strdup (value);
1236 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1239 if (change->allocated.array.len == 0)
1241 change->prev.array = *(gchar ***)entry->arg_data;
1242 change->allocated.array.data = g_new (gchar *, 2);
1245 change->allocated.array.data =
1246 g_renew (gchar *, change->allocated.array.data,
1247 change->allocated.array.len + 2);
1249 change->allocated.array.data[change->allocated.array.len] = data;
1250 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1252 change->allocated.array.len ++;
1254 *(gchar ***)entry->arg_data = change->allocated.array.data;
1259 case G_OPTION_ARG_INT:
1263 if (!parse_int (option_name, value,
1268 change = get_change (context, G_OPTION_ARG_INT,
1270 change->prev.integer = *(gint *)entry->arg_data;
1271 *(gint *)entry->arg_data = data;
1274 case G_OPTION_ARG_CALLBACK:
1279 if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1281 else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1283 else if (entry->flags & G_OPTION_FLAG_FILENAME)
1286 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1288 data = g_strdup (value);
1292 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1294 if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1298 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1300 if (!retval && error != NULL && *error == NULL)
1302 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1303 _("Error parsing option %s"), option_name);
1311 case G_OPTION_ARG_DOUBLE:
1315 if (!parse_double (option_name, value,
1322 change = get_change (context, G_OPTION_ARG_DOUBLE,
1324 change->prev.dbl = *(gdouble *)entry->arg_data;
1325 *(gdouble *)entry->arg_data = data;
1328 case G_OPTION_ARG_INT64:
1332 if (!parse_int64 (option_name, value,
1339 change = get_change (context, G_OPTION_ARG_INT64,
1341 change->prev.int64 = *(gint64 *)entry->arg_data;
1342 *(gint64 *)entry->arg_data = data;
1346 g_assert_not_reached ();
1353 parse_short_option (GOptionContext *context,
1354 GOptionGroup *group,
1365 for (j = 0; j < group->n_entries; j++)
1367 if (arg == group->entries[j].short_name)
1370 gchar *value = NULL;
1372 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1374 if (NO_ARG (&group->entries[j]))
1381 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1382 _("Error parsing option %s"), option_name);
1383 g_free (option_name);
1387 if (idx < *argc - 1)
1389 if (!OPTIONAL_ARG (&group->entries[j]))
1391 value = (*argv)[idx + 1];
1392 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1397 if ((*argv)[idx + 1][0] == '-')
1401 value = (*argv)[idx + 1];
1402 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1407 else if (idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1412 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1413 _("Missing argument for %s"), option_name);
1414 g_free (option_name);
1419 if (!parse_arg (context, group, &group->entries[j],
1420 value, option_name, error))
1422 g_free (option_name);
1426 g_free (option_name);
1435 parse_long_option (GOptionContext *context,
1436 GOptionGroup *group,
1447 for (j = 0; j < group->n_entries; j++)
1452 if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1455 if (NO_ARG (&group->entries[j]) &&
1456 strcmp (arg, group->entries[j].long_name) == 0)
1461 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1462 retval = parse_arg (context, group, &group->entries[j],
1463 NULL, option_name, error);
1464 g_free (option_name);
1466 add_pending_null (context, &((*argv)[*idx]), NULL);
1473 gint len = strlen (group->entries[j].long_name);
1475 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1476 (arg[len] == '=' || arg[len] == 0))
1478 gchar *value = NULL;
1481 add_pending_null (context, &((*argv)[*idx]), NULL);
1482 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1484 if (arg[len] == '=')
1485 value = arg + len + 1;
1486 else if (*idx < *argc - 1)
1488 if (!OPTIONAL_ARG (&group->entries[j]))
1490 value = (*argv)[*idx + 1];
1491 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1496 if ((*argv)[*idx + 1][0] == '-')
1499 retval = parse_arg (context, group, &group->entries[j],
1500 NULL, option_name, error);
1502 g_free (option_name);
1507 value = (*argv)[*idx + 1];
1508 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1513 else if (*idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1516 retval = parse_arg (context, group, &group->entries[j],
1517 NULL, option_name, error);
1519 g_free (option_name);
1525 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1526 _("Missing argument for %s"), option_name);
1527 g_free (option_name);
1531 if (!parse_arg (context, group, &group->entries[j],
1532 value, option_name, error))
1534 g_free (option_name);
1538 g_free (option_name);
1548 parse_remaining_arg (GOptionContext *context,
1549 GOptionGroup *group,
1558 for (j = 0; j < group->n_entries; j++)
1563 if (group->entries[j].long_name[0])
1566 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1567 group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1568 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1570 add_pending_null (context, &((*argv)[*idx]), NULL);
1572 if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
1583 free_changes_list (GOptionContext *context,
1588 for (list = context->changes; list != NULL; list = list->next)
1590 Change *change = list->data;
1594 switch (change->arg_type)
1596 case G_OPTION_ARG_NONE:
1597 *(gboolean *)change->arg_data = change->prev.bool;
1599 case G_OPTION_ARG_INT:
1600 *(gint *)change->arg_data = change->prev.integer;
1602 case G_OPTION_ARG_STRING:
1603 case G_OPTION_ARG_FILENAME:
1604 g_free (change->allocated.str);
1605 *(gchar **)change->arg_data = change->prev.str;
1607 case G_OPTION_ARG_STRING_ARRAY:
1608 case G_OPTION_ARG_FILENAME_ARRAY:
1609 g_strfreev (change->allocated.array.data);
1610 *(gchar ***)change->arg_data = change->prev.array;
1612 case G_OPTION_ARG_DOUBLE:
1613 *(gdouble *)change->arg_data = change->prev.dbl;
1615 case G_OPTION_ARG_INT64:
1616 *(gint64 *)change->arg_data = change->prev.int64;
1619 g_assert_not_reached ();
1626 g_list_free (context->changes);
1627 context->changes = NULL;
1631 free_pending_nulls (GOptionContext *context,
1632 gboolean perform_nulls)
1636 for (list = context->pending_nulls; list != NULL; list = list->next)
1638 PendingNull *n = list->data;
1644 /* Copy back the short options */
1646 strcpy (*n->ptr + 1, n->value);
1656 g_list_free (context->pending_nulls);
1657 context->pending_nulls = NULL;
1660 /* Use a platform-specific mechanism to look up the first argument to
1661 * the current process.
1662 * Note if you implement this for other platforms, also add it to
1663 * tests/option-argv0.c
1666 platform_get_argv0 (void)
1673 if (!g_file_get_contents ("/proc/self/cmdline",
1678 /* Sanity check for a NUL terminator. */
1679 if (!memchr (cmdline, 0, len))
1681 /* We could just return cmdline, but I think it's better
1682 * to hold on to a smaller malloc block; the arguments
1685 base_arg0 = g_path_get_basename (cmdline);
1688 #elif defined __OpenBSD__
1689 char **cmdline = NULL;
1691 gsize len = PATH_MAX;
1693 int mib[] = { CTL_KERN, KERN_PROC_ARGS, getpid(), KERN_PROC_ARGV };
1695 cmdline = (char **) realloc (cmdline, len);
1697 if (sysctl (mib, G_N_ELEMENTS (mib), cmdline, &len, NULL, 0) == -1)
1703 /* We could just return cmdline, but I think it's better
1704 * to hold on to a smaller malloc block; the arguments
1707 base_arg0 = g_path_get_basename (*cmdline);
1716 * g_option_context_parse:
1717 * @context: a #GOptionContext
1718 * @argc: (inout) (allow-none): a pointer to the number of command line arguments
1719 * @argv: (inout) (array length=argc) (allow-none): a pointer to the array of command line arguments
1720 * @error: a return location for errors
1722 * Parses the command line arguments, recognizing options
1723 * which have been added to @context. A side-effect of
1724 * calling this function is that g_set_prgname() will be
1727 * If the parsing is successful, any parsed arguments are
1728 * removed from the array and @argc and @argv are updated
1729 * accordingly. A '--' option is stripped from @argv
1730 * unless there are unparsed options before and after it,
1731 * or some of the options after it start with '-'. In case
1732 * of an error, @argc and @argv are left unmodified.
1734 * If automatic <option>--help</option> support is enabled
1735 * (see g_option_context_set_help_enabled()), and the
1736 * @argv array contains one of the recognized help options,
1737 * this function will produce help output to stdout and
1738 * call <literal>exit (0)</literal>.
1740 * Note that function depends on the
1741 * <link linkend="setlocale">current locale</link> for
1742 * automatic character set conversion of string and filename
1745 * Return value: %TRUE if the parsing was successful,
1746 * %FALSE if an error occurred
1751 g_option_context_parse (GOptionContext *context,
1759 /* Set program name */
1760 if (!g_get_prgname())
1764 if (argc && argv && *argc)
1765 prgname = g_path_get_basename ((*argv)[0]);
1767 prgname = platform_get_argv0 ();
1770 g_set_prgname (prgname);
1772 g_set_prgname ("<unknown>");
1777 /* Call pre-parse hooks */
1778 list = context->groups;
1781 GOptionGroup *group = list->data;
1783 if (group->pre_parse_func)
1785 if (!(* group->pre_parse_func) (context, group,
1786 group->user_data, error))
1793 if (context->main_group && context->main_group->pre_parse_func)
1795 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1796 context->main_group->user_data, error))
1802 gboolean stop_parsing = FALSE;
1803 gboolean has_unknown = FALSE;
1804 gint separator_pos = 0;
1806 for (i = 1; i < *argc; i++)
1809 gboolean parsed = FALSE;
1811 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1813 if ((*argv)[i][1] == '-')
1817 arg = (*argv)[i] + 2;
1819 /* '--' terminates list of arguments */
1823 stop_parsing = TRUE;
1827 /* Handle help options */
1828 if (context->help_enabled)
1830 if (strcmp (arg, "help") == 0)
1831 print_help (context, TRUE, NULL);
1832 else if (strcmp (arg, "help-all") == 0)
1833 print_help (context, FALSE, NULL);
1834 else if (strncmp (arg, "help-", 5) == 0)
1836 list = context->groups;
1840 GOptionGroup *group = list->data;
1842 if (strcmp (arg + 5, group->name) == 0)
1843 print_help (context, FALSE, group);
1850 if (context->main_group &&
1851 !parse_long_option (context, context->main_group, &i, arg,
1852 FALSE, argc, argv, error, &parsed))
1858 /* Try the groups */
1859 list = context->groups;
1862 GOptionGroup *group = list->data;
1864 if (!parse_long_option (context, group, &i, arg,
1865 FALSE, argc, argv, error, &parsed))
1877 /* Now look for --<group>-<option> */
1878 dash = strchr (arg, '-');
1881 /* Try the groups */
1882 list = context->groups;
1885 GOptionGroup *group = list->data;
1887 if (strncmp (group->name, arg, dash - arg) == 0)
1889 if (!parse_long_option (context, group, &i, dash + 1,
1890 TRUE, argc, argv, error, &parsed))
1901 if (context->ignore_unknown)
1905 { /* short option */
1906 gint new_i = i, arg_length;
1907 gboolean *nulled_out = NULL;
1908 gboolean has_h_entry = context_has_h_entry (context);
1909 arg = (*argv)[i] + 1;
1910 arg_length = strlen (arg);
1911 nulled_out = g_newa (gboolean, arg_length);
1912 memset (nulled_out, 0, arg_length * sizeof (gboolean));
1913 for (j = 0; j < arg_length; j++)
1915 if (context->help_enabled && (arg[j] == '?' ||
1916 (arg[j] == 'h' && !has_h_entry)))
1917 print_help (context, TRUE, NULL);
1919 if (context->main_group &&
1920 !parse_short_option (context, context->main_group,
1922 argc, argv, error, &parsed))
1926 /* Try the groups */
1927 list = context->groups;
1930 GOptionGroup *group = list->data;
1931 if (!parse_short_option (context, group, i, &new_i, arg[j],
1932 argc, argv, error, &parsed))
1940 if (context->ignore_unknown && parsed)
1941 nulled_out[j] = TRUE;
1942 else if (context->ignore_unknown)
1946 /* !context->ignore_unknown && parsed */
1948 if (context->ignore_unknown)
1950 gchar *new_arg = NULL;
1952 for (j = 0; j < arg_length; j++)
1957 new_arg = g_malloc (arg_length + 1);
1958 new_arg[arg_index++] = arg[j];
1962 new_arg[arg_index] = '\0';
1963 add_pending_null (context, &((*argv)[i]), new_arg);
1967 add_pending_null (context, &((*argv)[i]), NULL);
1975 if (!parsed && !context->ignore_unknown)
1978 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1979 _("Unknown option %s"), (*argv)[i]);
1985 /* Collect remaining args */
1986 if (context->main_group &&
1987 !parse_remaining_arg (context, context->main_group, &i,
1988 argc, argv, error, &parsed))
1991 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1996 if (separator_pos > 0)
1997 add_pending_null (context, &((*argv)[separator_pos]), NULL);
2001 /* Call post-parse hooks */
2002 list = context->groups;
2005 GOptionGroup *group = list->data;
2007 if (group->post_parse_func)
2009 if (!(* group->post_parse_func) (context, group,
2010 group->user_data, error))
2017 if (context->main_group && context->main_group->post_parse_func)
2019 if (!(* context->main_group->post_parse_func) (context, context->main_group,
2020 context->main_group->user_data, error))
2026 free_pending_nulls (context, TRUE);
2028 for (i = 1; i < *argc; i++)
2030 for (k = i; k < *argc; k++)
2031 if ((*argv)[k] != NULL)
2037 for (j = i + k; j < *argc; j++)
2039 (*argv)[j-k] = (*argv)[j];
2051 /* Call error hooks */
2052 list = context->groups;
2055 GOptionGroup *group = list->data;
2057 if (group->error_func)
2058 (* group->error_func) (context, group,
2059 group->user_data, error);
2064 if (context->main_group && context->main_group->error_func)
2065 (* context->main_group->error_func) (context, context->main_group,
2066 context->main_group->user_data, error);
2068 free_changes_list (context, TRUE);
2069 free_pending_nulls (context, FALSE);
2075 * g_option_group_new:
2076 * @name: the name for the option group, this is used to provide
2077 * help for the options in this group with <option>--help-</option>@name
2078 * @description: a description for this group to be shown in
2079 * <option>--help</option>. This string is translated using the translation
2080 * domain or translation function of the group
2081 * @help_description: a description for the <option>--help-</option>@name option.
2082 * This string is translated using the translation domain or translation function
2084 * @user_data: (allow-none): user data that will be passed to the pre- and post-parse hooks,
2085 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
2086 * @destroy: (allow-none): a function that will be called to free @user_data, or %NULL
2088 * Creates a new #GOptionGroup.
2090 * Return value: a newly created option group. It should be added
2091 * to a #GOptionContext or freed with g_option_group_free().
2096 g_option_group_new (const gchar *name,
2097 const gchar *description,
2098 const gchar *help_description,
2100 GDestroyNotify destroy)
2103 GOptionGroup *group;
2105 group = g_new0 (GOptionGroup, 1);
2106 group->name = g_strdup (name);
2107 group->description = g_strdup (description);
2108 group->help_description = g_strdup (help_description);
2109 group->user_data = user_data;
2110 group->destroy_notify = destroy;
2117 * g_option_group_free:
2118 * @group: a #GOptionGroup
2120 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
2121 * free groups which have been added to a #GOptionContext.
2126 g_option_group_free (GOptionGroup *group)
2128 g_return_if_fail (group != NULL);
2130 g_free (group->name);
2131 g_free (group->description);
2132 g_free (group->help_description);
2134 g_free (group->entries);
2136 if (group->destroy_notify)
2137 (* group->destroy_notify) (group->user_data);
2139 if (group->translate_notify)
2140 (* group->translate_notify) (group->translate_data);
2147 * g_option_group_add_entries:
2148 * @group: a #GOptionGroup
2149 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
2151 * Adds the options specified in @entries to @group.
2156 g_option_group_add_entries (GOptionGroup *group,
2157 const GOptionEntry *entries)
2161 g_return_if_fail (entries != NULL);
2163 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
2165 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
2167 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
2169 for (i = group->n_entries; i < group->n_entries + n_entries; i++)
2171 gchar c = group->entries[i].short_name;
2173 if (c == '-' || (c != 0 && !g_ascii_isprint (c)))
2175 g_warning (G_STRLOC ": ignoring invalid short option '%c' (%d) in entry %s:%s",
2176 c, c, group->name, group->entries[i].long_name);
2177 group->entries[i].short_name = '\0';
2180 if (group->entries[i].arg != G_OPTION_ARG_NONE &&
2181 (group->entries[i].flags & G_OPTION_FLAG_REVERSE) != 0)
2183 g_warning (G_STRLOC ": ignoring reverse flag on option of arg-type %d in entry %s:%s",
2184 group->entries[i].arg, group->name, group->entries[i].long_name);
2186 group->entries[i].flags &= ~G_OPTION_FLAG_REVERSE;
2189 if (group->entries[i].arg != G_OPTION_ARG_CALLBACK &&
2190 (group->entries[i].flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME)) != 0)
2192 g_warning (G_STRLOC ": ignoring no-arg, optional-arg or filename flags (%d) on option of arg-type %d in entry %s:%s",
2193 group->entries[i].flags, group->entries[i].arg, group->name, group->entries[i].long_name);
2195 group->entries[i].flags &= ~(G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME);
2199 group->n_entries += n_entries;
2203 * g_option_group_set_parse_hooks:
2204 * @group: a #GOptionGroup
2205 * @pre_parse_func: (allow-none): a function to call before parsing, or %NULL
2206 * @post_parse_func: (allow-none): a function to call after parsing, or %NULL
2208 * Associates two functions with @group which will be called
2209 * from g_option_context_parse() before the first option is parsed
2210 * and after the last option has been parsed, respectively.
2212 * Note that the user data to be passed to @pre_parse_func and
2213 * @post_parse_func can be specified when constructing the group
2214 * with g_option_group_new().
2219 g_option_group_set_parse_hooks (GOptionGroup *group,
2220 GOptionParseFunc pre_parse_func,
2221 GOptionParseFunc post_parse_func)
2223 g_return_if_fail (group != NULL);
2225 group->pre_parse_func = pre_parse_func;
2226 group->post_parse_func = post_parse_func;
2230 * g_option_group_set_error_hook:
2231 * @group: a #GOptionGroup
2232 * @error_func: a function to call when an error occurs
2234 * Associates a function with @group which will be called
2235 * from g_option_context_parse() when an error occurs.
2237 * Note that the user data to be passed to @error_func can be
2238 * specified when constructing the group with g_option_group_new().
2243 g_option_group_set_error_hook (GOptionGroup *group,
2244 GOptionErrorFunc error_func)
2246 g_return_if_fail (group != NULL);
2248 group->error_func = error_func;
2253 * g_option_group_set_translate_func:
2254 * @group: a #GOptionGroup
2255 * @func: (allow-none): the #GTranslateFunc, or %NULL
2256 * @data: (allow-none): user data to pass to @func, or %NULL
2257 * @destroy_notify: (allow-none): a function which gets called to free @data, or %NULL
2259 * Sets the function which is used to translate user-visible
2260 * strings, for <option>--help</option> output. Different
2261 * groups can use different #GTranslateFunc<!-- -->s. If @func
2262 * is %NULL, strings are not translated.
2264 * If you are using gettext(), you only need to set the translation
2265 * domain, see g_option_group_set_translation_domain().
2270 g_option_group_set_translate_func (GOptionGroup *group,
2271 GTranslateFunc func,
2273 GDestroyNotify destroy_notify)
2275 g_return_if_fail (group != NULL);
2277 if (group->translate_notify)
2278 group->translate_notify (group->translate_data);
2280 group->translate_func = func;
2281 group->translate_data = data;
2282 group->translate_notify = destroy_notify;
2285 static const gchar *
2286 dgettext_swapped (const gchar *msgid,
2287 const gchar *domainname)
2289 return g_dgettext (domainname, msgid);
2293 * g_option_group_set_translation_domain:
2294 * @group: a #GOptionGroup
2295 * @domain: the domain to use
2297 * A convenience function to use gettext() for translating
2298 * user-visible strings.
2303 g_option_group_set_translation_domain (GOptionGroup *group,
2304 const gchar *domain)
2306 g_return_if_fail (group != NULL);
2308 g_option_group_set_translate_func (group,
2309 (GTranslateFunc)dgettext_swapped,
2315 * g_option_context_set_translate_func:
2316 * @context: a #GOptionContext
2317 * @func: (allow-none): the #GTranslateFunc, or %NULL
2318 * @data: (allow-none): user data to pass to @func, or %NULL
2319 * @destroy_notify: (allow-none): a function which gets called to free @data, or %NULL
2321 * Sets the function which is used to translate the contexts
2322 * user-visible strings, for <option>--help</option> output.
2323 * If @func is %NULL, strings are not translated.
2325 * Note that option groups have their own translation functions,
2326 * this function only affects the @parameter_string (see g_option_context_new()),
2327 * the summary (see g_option_context_set_summary()) and the description
2328 * (see g_option_context_set_description()).
2330 * If you are using gettext(), you only need to set the translation
2331 * domain, see g_option_context_set_translation_domain().
2336 g_option_context_set_translate_func (GOptionContext *context,
2337 GTranslateFunc func,
2339 GDestroyNotify destroy_notify)
2341 g_return_if_fail (context != NULL);
2343 if (context->translate_notify)
2344 context->translate_notify (context->translate_data);
2346 context->translate_func = func;
2347 context->translate_data = data;
2348 context->translate_notify = destroy_notify;
2352 * g_option_context_set_translation_domain:
2353 * @context: a #GOptionContext
2354 * @domain: the domain to use
2356 * A convenience function to use gettext() for translating
2357 * user-visible strings.
2362 g_option_context_set_translation_domain (GOptionContext *context,
2363 const gchar *domain)
2365 g_return_if_fail (context != NULL);
2367 g_option_context_set_translate_func (context,
2368 (GTranslateFunc)dgettext_swapped,
2374 * g_option_context_set_summary:
2375 * @context: a #GOptionContext
2376 * @summary: (allow-none): a string to be shown in <option>--help</option> output
2377 * before the list of options, or %NULL
2379 * Adds a string to be displayed in <option>--help</option> output
2380 * before the list of options. This is typically a summary of the
2381 * program functionality.
2383 * Note that the summary is translated (see
2384 * g_option_context_set_translate_func() and
2385 * g_option_context_set_translation_domain()).
2390 g_option_context_set_summary (GOptionContext *context,
2391 const gchar *summary)
2393 g_return_if_fail (context != NULL);
2395 g_free (context->summary);
2396 context->summary = g_strdup (summary);
2401 * g_option_context_get_summary:
2402 * @context: a #GOptionContext
2404 * Returns the summary. See g_option_context_set_summary().
2406 * Returns: the summary
2411 g_option_context_get_summary (GOptionContext *context)
2413 g_return_val_if_fail (context != NULL, NULL);
2415 return context->summary;
2419 * g_option_context_set_description:
2420 * @context: a #GOptionContext
2421 * @description: (allow-none): a string to be shown in <option>--help</option> output
2422 * after the list of options, or %NULL
2424 * Adds a string to be displayed in <option>--help</option> output
2425 * after the list of options. This text often includes a bug reporting
2428 * Note that the summary is translated (see
2429 * g_option_context_set_translate_func()).
2434 g_option_context_set_description (GOptionContext *context,
2435 const gchar *description)
2437 g_return_if_fail (context != NULL);
2439 g_free (context->description);
2440 context->description = g_strdup (description);
2445 * g_option_context_get_description:
2446 * @context: a #GOptionContext
2448 * Returns the description. See g_option_context_set_description().
2450 * Returns: the description
2455 g_option_context_get_description (GOptionContext *context)
2457 g_return_val_if_fail (context != NULL, NULL);
2459 return context->description;