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>
145 #include "glibintl.h"
147 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
149 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
150 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
151 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
153 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
154 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
186 struct _GOptionContext
190 gchar *parameter_string;
194 GTranslateFunc translate_func;
195 GDestroyNotify translate_notify;
196 gpointer translate_data;
198 guint help_enabled : 1;
199 guint ignore_unknown : 1;
201 GOptionGroup *main_group;
203 /* We keep a list of change so we can revert them */
206 /* We also keep track of all argv elements
207 * that should be NULLed or modified.
209 GList *pending_nulls;
216 gchar *help_description;
218 GDestroyNotify destroy_notify;
221 GTranslateFunc translate_func;
222 GDestroyNotify translate_notify;
223 gpointer translate_data;
225 GOptionEntry *entries;
228 GOptionParseFunc pre_parse_func;
229 GOptionParseFunc post_parse_func;
230 GOptionErrorFunc error_func;
233 static void free_changes_list (GOptionContext *context,
235 static void free_pending_nulls (GOptionContext *context,
236 gboolean perform_nulls);
240 _g_unichar_get_width (gunichar c)
242 if (G_UNLIKELY (g_unichar_iszerowidth (c)))
245 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
246 * some locales (legacy East Asian ones) */
247 if (g_unichar_iswide (c))
254 _g_utf8_strwidth (const gchar *p,
258 const gchar *start = p;
259 g_return_val_if_fail (p != NULL || max == 0, 0);
265 len += _g_unichar_get_width (g_utf8_get_char (p));
266 p = g_utf8_next_char (p);
274 /* this case may not be quite correct */
276 len += _g_unichar_get_width (g_utf8_get_char (p));
277 p = g_utf8_next_char (p);
279 while (p - start < max && *p)
281 len += _g_unichar_get_width (g_utf8_get_char (p));
282 p = g_utf8_next_char (p);
291 g_option_error_quark (void)
293 return g_quark_from_static_string ("g-option-context-error-quark");
297 * g_option_context_new:
298 * @parameter_string: a string which is displayed in
299 * the first line of <option>--help</option> output, after the
301 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
303 * Creates a new option context.
305 * The @parameter_string can serve multiple purposes. It can be used
306 * to add descriptions for "rest" arguments, which are not parsed by
307 * the #GOptionContext, typically something like "FILES" or
308 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
309 * collecting "rest" arguments, GLib handles this automatically by
310 * using the @arg_description of the corresponding #GOptionEntry in
313 * Another usage is to give a short summary of the program
314 * functionality, like " - frob the strings", which will be displayed
315 * in the same line as the usage. For a longer description of the
316 * program functionality that should be displayed as a paragraph
317 * below the usage line, use g_option_context_set_summary().
319 * Note that the @parameter_string is translated using the
320 * function set with g_option_context_set_translate_func(), so
321 * it should normally be passed untranslated.
323 * Returns: a newly created #GOptionContext, which must be
324 * freed with g_option_context_free() after use.
329 g_option_context_new (const gchar *parameter_string)
332 GOptionContext *context;
334 context = g_new0 (GOptionContext, 1);
336 context->parameter_string = g_strdup (parameter_string);
337 context->help_enabled = TRUE;
338 context->ignore_unknown = FALSE;
344 * g_option_context_free:
345 * @context: a #GOptionContext
347 * Frees context and all the groups which have been
350 * Please note that parsed arguments need to be freed separately (see
355 void g_option_context_free (GOptionContext *context)
357 g_return_if_fail (context != NULL);
359 g_list_free_full (context->groups, (GDestroyNotify) g_option_group_free);
361 if (context->main_group)
362 g_option_group_free (context->main_group);
364 free_changes_list (context, FALSE);
365 free_pending_nulls (context, FALSE);
367 g_free (context->parameter_string);
368 g_free (context->summary);
369 g_free (context->description);
371 if (context->translate_notify)
372 (* context->translate_notify) (context->translate_data);
379 * g_option_context_set_help_enabled:
380 * @context: a #GOptionContext
381 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
383 * Enables or disables automatic generation of <option>--help</option>
384 * output. By default, g_option_context_parse() recognizes
385 * <option>--help</option>, <option>-h</option>,
386 * <option>-?</option>, <option>--help-all</option>
387 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
388 * suitable output to stdout.
392 void g_option_context_set_help_enabled (GOptionContext *context,
393 gboolean help_enabled)
396 g_return_if_fail (context != NULL);
398 context->help_enabled = help_enabled;
402 * g_option_context_get_help_enabled:
403 * @context: a #GOptionContext
405 * Returns whether automatic <option>--help</option> generation
406 * is turned on for @context. See g_option_context_set_help_enabled().
408 * Returns: %TRUE if automatic help generation is turned on.
413 g_option_context_get_help_enabled (GOptionContext *context)
415 g_return_val_if_fail (context != NULL, FALSE);
417 return context->help_enabled;
421 * g_option_context_set_ignore_unknown_options:
422 * @context: a #GOptionContext
423 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
424 * an error when unknown options are met
426 * Sets whether to ignore unknown options or not. If an argument is
427 * ignored, it is left in the @argv array after parsing. By default,
428 * g_option_context_parse() treats unknown options as error.
430 * This setting does not affect non-option arguments (i.e. arguments
431 * which don't start with a dash). But note that GOption cannot reliably
432 * determine whether a non-option belongs to a preceding unknown option.
437 g_option_context_set_ignore_unknown_options (GOptionContext *context,
438 gboolean ignore_unknown)
440 g_return_if_fail (context != NULL);
442 context->ignore_unknown = ignore_unknown;
446 * g_option_context_get_ignore_unknown_options:
447 * @context: a #GOptionContext
449 * Returns whether unknown options are ignored or not. See
450 * g_option_context_set_ignore_unknown_options().
452 * Returns: %TRUE if unknown options are ignored.
457 g_option_context_get_ignore_unknown_options (GOptionContext *context)
459 g_return_val_if_fail (context != NULL, FALSE);
461 return context->ignore_unknown;
465 * g_option_context_add_group:
466 * @context: a #GOptionContext
467 * @group: the group to add
469 * Adds a #GOptionGroup to the @context, so that parsing with @context
470 * will recognize the options in the group. Note that the group will
471 * be freed together with the context when g_option_context_free() is
472 * called, so you must not free the group yourself after adding it
478 g_option_context_add_group (GOptionContext *context,
483 g_return_if_fail (context != NULL);
484 g_return_if_fail (group != NULL);
485 g_return_if_fail (group->name != NULL);
486 g_return_if_fail (group->description != NULL);
487 g_return_if_fail (group->help_description != NULL);
489 for (list = context->groups; list; list = list->next)
491 GOptionGroup *g = (GOptionGroup *)list->data;
493 if ((group->name == NULL && g->name == NULL) ||
494 (group->name && g->name && strcmp (group->name, g->name) == 0))
495 g_warning ("A group named \"%s\" is already part of this GOptionContext",
499 context->groups = g_list_append (context->groups, group);
503 * g_option_context_set_main_group:
504 * @context: a #GOptionContext
505 * @group: the group to set as main group
507 * Sets a #GOptionGroup as main group of the @context.
508 * This has the same effect as calling g_option_context_add_group(),
509 * the only difference is that the options in the main group are
510 * treated differently when generating <option>--help</option> output.
515 g_option_context_set_main_group (GOptionContext *context,
518 g_return_if_fail (context != NULL);
519 g_return_if_fail (group != NULL);
521 if (context->main_group)
523 g_warning ("This GOptionContext already has a main group");
528 context->main_group = group;
532 * g_option_context_get_main_group:
533 * @context: a #GOptionContext
535 * Returns a pointer to the main group of @context.
537 * Return value: the main group of @context, or %NULL if @context doesn't
538 * have a main group. Note that group belongs to @context and should
539 * not be modified or freed.
544 g_option_context_get_main_group (GOptionContext *context)
546 g_return_val_if_fail (context != NULL, NULL);
548 return context->main_group;
552 * g_option_context_add_main_entries:
553 * @context: a #GOptionContext
554 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
555 * @translation_domain: a translation domain to use for translating
556 * the <option>--help</option> output for the options in @entries
557 * with gettext(), or %NULL
559 * A convenience function which creates a main group if it doesn't
560 * exist, adds the @entries to it and sets the translation domain.
565 g_option_context_add_main_entries (GOptionContext *context,
566 const GOptionEntry *entries,
567 const gchar *translation_domain)
569 g_return_if_fail (entries != NULL);
571 if (!context->main_group)
572 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
574 g_option_group_add_entries (context->main_group, entries);
575 g_option_group_set_translation_domain (context->main_group, translation_domain);
579 calculate_max_length (GOptionGroup *group)
582 gint i, len, max_length;
586 for (i = 0; i < group->n_entries; i++)
588 entry = &group->entries[i];
590 if (entry->flags & G_OPTION_FLAG_HIDDEN)
593 len = _g_utf8_strwidth (entry->long_name, -1);
595 if (entry->short_name)
598 if (!NO_ARG (entry) && entry->arg_description)
599 len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description), -1);
601 max_length = MAX (max_length, len);
608 print_entry (GOptionGroup *group,
610 const GOptionEntry *entry,
615 if (entry->flags & G_OPTION_FLAG_HIDDEN)
618 if (entry->long_name[0] == 0)
621 str = g_string_new (NULL);
623 if (entry->short_name)
624 g_string_append_printf (str, " -%c, --%s", entry->short_name, entry->long_name);
626 g_string_append_printf (str, " --%s", entry->long_name);
628 if (entry->arg_description)
629 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
631 g_string_append_printf (string, "%s%*s %s\n", str->str,
632 (int) (max_length + 4 - _g_utf8_strwidth (str->str, -1)), "",
633 entry->description ? TRANSLATE (group, entry->description) : "");
634 g_string_free (str, TRUE);
638 group_has_visible_entries (GOptionContext *context,
640 gboolean main_entries)
642 GOptionFlags reject_filter = G_OPTION_FLAG_HIDDEN;
645 gboolean main_group = group == context->main_group;
648 reject_filter |= G_OPTION_FLAG_IN_MAIN;
650 for (i = 0, l = (group ? group->n_entries : 0); i < l; i++)
652 entry = &group->entries[i];
654 if (main_entries && !main_group && !(entry->flags & G_OPTION_FLAG_IN_MAIN))
656 if (!(entry->flags & reject_filter))
664 group_list_has_visible_entires (GOptionContext *context,
666 gboolean main_entries)
670 if (group_has_visible_entries (context, group_list->data, main_entries))
673 group_list = group_list->next;
680 context_has_h_entry (GOptionContext *context)
685 if (context->main_group)
687 for (i = 0; i < context->main_group->n_entries; i++)
689 if (context->main_group->entries[i].short_name == 'h')
694 for (list = context->groups; list != NULL; list = g_list_next (list))
698 group = (GOptionGroup*)list->data;
699 for (i = 0; i < group->n_entries; i++)
701 if (group->entries[i].short_name == 'h')
709 * g_option_context_get_help:
710 * @context: a #GOptionContext
711 * @main_help: if %TRUE, only include the main group
712 * @group: the #GOptionGroup to create help for, or %NULL
714 * Returns a formatted, translated help text for the given context.
715 * To obtain the text produced by <option>--help</option>, call
716 * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
717 * To obtain the text produced by <option>--help-all</option>, call
718 * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
719 * To obtain the help text for an option group, call
720 * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
722 * Returns: A newly allocated string containing the help text
727 g_option_context_get_help (GOptionContext *context,
732 gint max_length, len;
735 GHashTable *shadow_map;
737 const gchar *rest_description;
741 string = g_string_sized_new (1024);
743 rest_description = NULL;
744 if (context->main_group)
747 for (i = 0; i < context->main_group->n_entries; i++)
749 entry = &context->main_group->entries[i];
750 if (entry->long_name[0] == 0)
752 rest_description = TRANSLATE (context->main_group, entry->arg_description);
758 g_string_append_printf (string, "%s\n %s %s",
759 _("Usage:"), g_get_prgname(), _("[OPTION...]"));
761 if (rest_description)
763 g_string_append (string, " ");
764 g_string_append (string, rest_description);
767 if (context->parameter_string)
769 g_string_append (string, " ");
770 g_string_append (string, TRANSLATE (context, context->parameter_string));
773 g_string_append (string, "\n\n");
775 if (context->summary)
777 g_string_append (string, TRANSLATE (context, context->summary));
778 g_string_append (string, "\n\n");
781 memset (seen, 0, sizeof (gboolean) * 256);
782 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
784 if (context->main_group)
786 for (i = 0; i < context->main_group->n_entries; i++)
788 entry = &context->main_group->entries[i];
789 g_hash_table_insert (shadow_map,
790 (gpointer)entry->long_name,
793 if (seen[(guchar)entry->short_name])
794 entry->short_name = 0;
796 seen[(guchar)entry->short_name] = TRUE;
800 list = context->groups;
803 GOptionGroup *g = list->data;
804 for (i = 0; i < g->n_entries; i++)
806 entry = &g->entries[i];
807 if (g_hash_table_lookup (shadow_map, entry->long_name) &&
808 !(entry->flags & G_OPTION_FLAG_NOALIAS))
809 entry->long_name = g_strdup_printf ("%s-%s", g->name, entry->long_name);
811 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
813 if (seen[(guchar)entry->short_name] &&
814 !(entry->flags & G_OPTION_FLAG_NOALIAS))
815 entry->short_name = 0;
817 seen[(guchar)entry->short_name] = TRUE;
822 g_hash_table_destroy (shadow_map);
824 list = context->groups;
826 max_length = _g_utf8_strwidth ("-?, --help", -1);
830 len = _g_utf8_strwidth ("--help-all", -1);
831 max_length = MAX (max_length, len);
834 if (context->main_group)
836 len = calculate_max_length (context->main_group);
837 max_length = MAX (max_length, len);
842 GOptionGroup *g = list->data;
844 /* First, we check the --help-<groupname> options */
845 len = _g_utf8_strwidth ("--help-", -1) + _g_utf8_strwidth (g->name, -1);
846 max_length = MAX (max_length, len);
848 /* Then we go through the entries */
849 len = calculate_max_length (g);
850 max_length = MAX (max_length, len);
855 /* Add a bit of padding */
860 list = context->groups;
862 token = context_has_h_entry (context) ? '?' : 'h';
864 g_string_append_printf (string, "%s\n -%c, --%-*s %s\n",
865 _("Help Options:"), token, max_length - 4, "help",
866 _("Show help options"));
868 /* We only want --help-all when there are groups */
870 g_string_append_printf (string, " --%-*s %s\n",
871 max_length, "help-all",
872 _("Show all help options"));
876 GOptionGroup *g = list->data;
878 if (group_has_visible_entries (context, g, FALSE))
879 g_string_append_printf (string, " --help-%-*s %s\n",
880 max_length - 5, g->name,
881 TRANSLATE (g, g->help_description));
886 g_string_append (string, "\n");
891 /* Print a certain group */
893 if (group_has_visible_entries (context, group, FALSE))
895 g_string_append (string, TRANSLATE (group, group->description));
896 g_string_append (string, "\n");
897 for (i = 0; i < group->n_entries; i++)
898 print_entry (group, max_length, &group->entries[i], string);
899 g_string_append (string, "\n");
904 /* Print all groups */
906 list = context->groups;
910 GOptionGroup *g = list->data;
912 if (group_has_visible_entries (context, g, FALSE))
914 g_string_append (string, g->description);
915 g_string_append (string, "\n");
916 for (i = 0; i < g->n_entries; i++)
917 if (!(g->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
918 print_entry (g, max_length, &g->entries[i], string);
920 g_string_append (string, "\n");
927 /* Print application options if --help or --help-all has been specified */
928 if ((main_help || !group) &&
929 (group_has_visible_entries (context, context->main_group, TRUE) ||
930 group_list_has_visible_entires (context, context->groups, TRUE)))
932 list = context->groups;
934 g_string_append (string, _("Application Options:"));
935 g_string_append (string, "\n");
936 if (context->main_group)
937 for (i = 0; i < context->main_group->n_entries; i++)
938 print_entry (context->main_group, max_length,
939 &context->main_group->entries[i], string);
943 GOptionGroup *g = list->data;
945 /* Print main entries from other groups */
946 for (i = 0; i < g->n_entries; i++)
947 if (g->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
948 print_entry (g, max_length, &g->entries[i], string);
953 g_string_append (string, "\n");
956 if (context->description)
958 g_string_append (string, TRANSLATE (context, context->description));
959 g_string_append (string, "\n");
962 return g_string_free (string, FALSE);
967 print_help (GOptionContext *context,
973 help = g_option_context_get_help (context, main_help, group);
974 g_print ("%s", help);
981 parse_int (const gchar *arg_name,
990 tmp = strtol (arg, &end, 0);
992 if (*arg == '\0' || *end != '\0')
995 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
996 _("Cannot parse integer value '%s' for %s"),
1002 if (*result != tmp || errno == ERANGE)
1005 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1006 _("Integer value '%s' for %s out of range"),
1016 parse_double (const gchar *arg_name,
1025 tmp = g_strtod (arg, &end);
1027 if (*arg == '\0' || *end != '\0')
1030 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1031 _("Cannot parse double value '%s' for %s"),
1035 if (errno == ERANGE)
1038 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1039 _("Double value '%s' for %s out of range"),
1051 parse_int64 (const gchar *arg_name,
1060 tmp = g_ascii_strtoll (arg, &end, 0);
1062 if (*arg == '\0' || *end != '\0')
1065 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1066 _("Cannot parse integer value '%s' for %s"),
1070 if (errno == ERANGE)
1073 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1074 _("Integer value '%s' for %s out of range"),
1086 get_change (GOptionContext *context,
1087 GOptionArg arg_type,
1091 Change *change = NULL;
1093 for (list = context->changes; list != NULL; list = list->next)
1095 change = list->data;
1097 if (change->arg_data == arg_data)
1101 change = g_new0 (Change, 1);
1102 change->arg_type = arg_type;
1103 change->arg_data = arg_data;
1105 context->changes = g_list_prepend (context->changes, change);
1113 add_pending_null (GOptionContext *context,
1119 n = g_new0 (PendingNull, 1);
1123 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
1127 parse_arg (GOptionContext *context,
1128 GOptionGroup *group,
1129 GOptionEntry *entry,
1131 const gchar *option_name,
1137 g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
1141 case G_OPTION_ARG_NONE:
1143 change = get_change (context, G_OPTION_ARG_NONE,
1146 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1149 case G_OPTION_ARG_STRING:
1153 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1158 change = get_change (context, G_OPTION_ARG_STRING,
1160 g_free (change->allocated.str);
1162 change->prev.str = *(gchar **)entry->arg_data;
1163 change->allocated.str = data;
1165 *(gchar **)entry->arg_data = data;
1168 case G_OPTION_ARG_STRING_ARRAY:
1172 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1177 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1180 if (change->allocated.array.len == 0)
1182 change->prev.array = *(gchar ***)entry->arg_data;
1183 change->allocated.array.data = g_new (gchar *, 2);
1186 change->allocated.array.data =
1187 g_renew (gchar *, change->allocated.array.data,
1188 change->allocated.array.len + 2);
1190 change->allocated.array.data[change->allocated.array.len] = data;
1191 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1193 change->allocated.array.len ++;
1195 *(gchar ***)entry->arg_data = change->allocated.array.data;
1200 case G_OPTION_ARG_FILENAME:
1205 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1210 data = g_strdup (value);
1212 change = get_change (context, G_OPTION_ARG_FILENAME,
1214 g_free (change->allocated.str);
1216 change->prev.str = *(gchar **)entry->arg_data;
1217 change->allocated.str = data;
1219 *(gchar **)entry->arg_data = data;
1223 case G_OPTION_ARG_FILENAME_ARRAY:
1228 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1233 data = g_strdup (value);
1235 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1238 if (change->allocated.array.len == 0)
1240 change->prev.array = *(gchar ***)entry->arg_data;
1241 change->allocated.array.data = g_new (gchar *, 2);
1244 change->allocated.array.data =
1245 g_renew (gchar *, change->allocated.array.data,
1246 change->allocated.array.len + 2);
1248 change->allocated.array.data[change->allocated.array.len] = data;
1249 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1251 change->allocated.array.len ++;
1253 *(gchar ***)entry->arg_data = change->allocated.array.data;
1258 case G_OPTION_ARG_INT:
1262 if (!parse_int (option_name, value,
1267 change = get_change (context, G_OPTION_ARG_INT,
1269 change->prev.integer = *(gint *)entry->arg_data;
1270 *(gint *)entry->arg_data = data;
1273 case G_OPTION_ARG_CALLBACK:
1278 if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1280 else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1282 else if (entry->flags & G_OPTION_FLAG_FILENAME)
1285 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1287 data = g_strdup (value);
1291 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1293 if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1297 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1299 if (!retval && error != NULL && *error == NULL)
1301 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1302 _("Error parsing option %s"), option_name);
1310 case G_OPTION_ARG_DOUBLE:
1314 if (!parse_double (option_name, value,
1321 change = get_change (context, G_OPTION_ARG_DOUBLE,
1323 change->prev.dbl = *(gdouble *)entry->arg_data;
1324 *(gdouble *)entry->arg_data = data;
1327 case G_OPTION_ARG_INT64:
1331 if (!parse_int64 (option_name, value,
1338 change = get_change (context, G_OPTION_ARG_INT64,
1340 change->prev.int64 = *(gint64 *)entry->arg_data;
1341 *(gint64 *)entry->arg_data = data;
1345 g_assert_not_reached ();
1352 parse_short_option (GOptionContext *context,
1353 GOptionGroup *group,
1364 for (j = 0; j < group->n_entries; j++)
1366 if (arg == group->entries[j].short_name)
1369 gchar *value = NULL;
1371 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1373 if (NO_ARG (&group->entries[j]))
1380 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1381 _("Error parsing option %s"), option_name);
1382 g_free (option_name);
1386 if (idx < *argc - 1)
1388 if (!OPTIONAL_ARG (&group->entries[j]))
1390 value = (*argv)[idx + 1];
1391 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1396 if ((*argv)[idx + 1][0] == '-')
1400 value = (*argv)[idx + 1];
1401 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1406 else if (idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1411 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1412 _("Missing argument for %s"), option_name);
1413 g_free (option_name);
1418 if (!parse_arg (context, group, &group->entries[j],
1419 value, option_name, error))
1421 g_free (option_name);
1425 g_free (option_name);
1434 parse_long_option (GOptionContext *context,
1435 GOptionGroup *group,
1446 for (j = 0; j < group->n_entries; j++)
1451 if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1454 if (NO_ARG (&group->entries[j]) &&
1455 strcmp (arg, group->entries[j].long_name) == 0)
1460 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1461 retval = parse_arg (context, group, &group->entries[j],
1462 NULL, option_name, error);
1463 g_free (option_name);
1465 add_pending_null (context, &((*argv)[*idx]), NULL);
1472 gint len = strlen (group->entries[j].long_name);
1474 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1475 (arg[len] == '=' || arg[len] == 0))
1477 gchar *value = NULL;
1480 add_pending_null (context, &((*argv)[*idx]), NULL);
1481 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1483 if (arg[len] == '=')
1484 value = arg + len + 1;
1485 else if (*idx < *argc - 1)
1487 if (!OPTIONAL_ARG (&group->entries[j]))
1489 value = (*argv)[*idx + 1];
1490 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1495 if ((*argv)[*idx + 1][0] == '-')
1498 retval = parse_arg (context, group, &group->entries[j],
1499 NULL, option_name, error);
1501 g_free (option_name);
1506 value = (*argv)[*idx + 1];
1507 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1512 else if (*idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1515 retval = parse_arg (context, group, &group->entries[j],
1516 NULL, option_name, error);
1518 g_free (option_name);
1524 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1525 _("Missing argument for %s"), option_name);
1526 g_free (option_name);
1530 if (!parse_arg (context, group, &group->entries[j],
1531 value, option_name, error))
1533 g_free (option_name);
1537 g_free (option_name);
1547 parse_remaining_arg (GOptionContext *context,
1548 GOptionGroup *group,
1557 for (j = 0; j < group->n_entries; j++)
1562 if (group->entries[j].long_name[0])
1565 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1566 group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1567 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1569 add_pending_null (context, &((*argv)[*idx]), NULL);
1571 if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
1582 free_changes_list (GOptionContext *context,
1587 for (list = context->changes; list != NULL; list = list->next)
1589 Change *change = list->data;
1593 switch (change->arg_type)
1595 case G_OPTION_ARG_NONE:
1596 *(gboolean *)change->arg_data = change->prev.bool;
1598 case G_OPTION_ARG_INT:
1599 *(gint *)change->arg_data = change->prev.integer;
1601 case G_OPTION_ARG_STRING:
1602 case G_OPTION_ARG_FILENAME:
1603 g_free (change->allocated.str);
1604 *(gchar **)change->arg_data = change->prev.str;
1606 case G_OPTION_ARG_STRING_ARRAY:
1607 case G_OPTION_ARG_FILENAME_ARRAY:
1608 g_strfreev (change->allocated.array.data);
1609 *(gchar ***)change->arg_data = change->prev.array;
1611 case G_OPTION_ARG_DOUBLE:
1612 *(gdouble *)change->arg_data = change->prev.dbl;
1614 case G_OPTION_ARG_INT64:
1615 *(gint64 *)change->arg_data = change->prev.int64;
1618 g_assert_not_reached ();
1625 g_list_free (context->changes);
1626 context->changes = NULL;
1630 free_pending_nulls (GOptionContext *context,
1631 gboolean perform_nulls)
1635 for (list = context->pending_nulls; list != NULL; list = list->next)
1637 PendingNull *n = list->data;
1643 /* Copy back the short options */
1645 strcpy (*n->ptr + 1, n->value);
1655 g_list_free (context->pending_nulls);
1656 context->pending_nulls = NULL;
1659 /* Use a platform-specific mechanism to look up the first argument to
1660 * the current process.
1661 * Note if you implement this for other platforms, also add it to
1662 * tests/option-argv0.c
1665 platform_get_argv0 (void)
1672 if (!g_file_get_contents ("/proc/self/cmdline",
1677 /* Sanity check for a NUL terminator. */
1678 if (!memchr (cmdline, 0, len))
1680 /* We could just return cmdline, but I think it's better
1681 * to hold on to a smaller malloc block; the arguments
1684 base_arg0 = g_path_get_basename (cmdline);
1693 * g_option_context_parse:
1694 * @context: a #GOptionContext
1695 * @argc: (inout) (allow-none): a pointer to the number of command line arguments
1696 * @argv: (inout) (array length=argc) (allow-none): a pointer to the array of command line arguments
1697 * @error: a return location for errors
1699 * Parses the command line arguments, recognizing options
1700 * which have been added to @context. A side-effect of
1701 * calling this function is that g_set_prgname() will be
1704 * If the parsing is successful, any parsed arguments are
1705 * removed from the array and @argc and @argv are updated
1706 * accordingly. A '--' option is stripped from @argv
1707 * unless there are unparsed options before and after it,
1708 * or some of the options after it start with '-'. In case
1709 * of an error, @argc and @argv are left unmodified.
1711 * If automatic <option>--help</option> support is enabled
1712 * (see g_option_context_set_help_enabled()), and the
1713 * @argv array contains one of the recognized help options,
1714 * this function will produce help output to stdout and
1715 * call <literal>exit (0)</literal>.
1717 * Note that function depends on the
1718 * <link linkend="setlocale">current locale</link> for
1719 * automatic character set conversion of string and filename
1722 * Return value: %TRUE if the parsing was successful,
1723 * %FALSE if an error occurred
1728 g_option_context_parse (GOptionContext *context,
1736 /* Set program name */
1737 if (!g_get_prgname())
1741 if (argc && argv && *argc)
1742 prgname = g_path_get_basename ((*argv)[0]);
1744 prgname = platform_get_argv0 ();
1747 g_set_prgname (prgname);
1749 g_set_prgname ("<unknown>");
1754 /* Call pre-parse hooks */
1755 list = context->groups;
1758 GOptionGroup *group = list->data;
1760 if (group->pre_parse_func)
1762 if (!(* group->pre_parse_func) (context, group,
1763 group->user_data, error))
1770 if (context->main_group && context->main_group->pre_parse_func)
1772 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1773 context->main_group->user_data, error))
1779 gboolean stop_parsing = FALSE;
1780 gboolean has_unknown = FALSE;
1781 gint separator_pos = 0;
1783 for (i = 1; i < *argc; i++)
1786 gboolean parsed = FALSE;
1788 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1790 if ((*argv)[i][1] == '-')
1794 arg = (*argv)[i] + 2;
1796 /* '--' terminates list of arguments */
1800 stop_parsing = TRUE;
1804 /* Handle help options */
1805 if (context->help_enabled)
1807 if (strcmp (arg, "help") == 0)
1808 print_help (context, TRUE, NULL);
1809 else if (strcmp (arg, "help-all") == 0)
1810 print_help (context, FALSE, NULL);
1811 else if (strncmp (arg, "help-", 5) == 0)
1813 list = context->groups;
1817 GOptionGroup *group = list->data;
1819 if (strcmp (arg + 5, group->name) == 0)
1820 print_help (context, FALSE, group);
1827 if (context->main_group &&
1828 !parse_long_option (context, context->main_group, &i, arg,
1829 FALSE, argc, argv, error, &parsed))
1835 /* Try the groups */
1836 list = context->groups;
1839 GOptionGroup *group = list->data;
1841 if (!parse_long_option (context, group, &i, arg,
1842 FALSE, argc, argv, error, &parsed))
1854 /* Now look for --<group>-<option> */
1855 dash = strchr (arg, '-');
1858 /* Try the groups */
1859 list = context->groups;
1862 GOptionGroup *group = list->data;
1864 if (strncmp (group->name, arg, dash - arg) == 0)
1866 if (!parse_long_option (context, group, &i, dash + 1,
1867 TRUE, argc, argv, error, &parsed))
1878 if (context->ignore_unknown)
1882 { /* short option */
1883 gint new_i = i, arg_length;
1884 gboolean *nulled_out = NULL;
1885 gboolean has_h_entry = context_has_h_entry (context);
1886 arg = (*argv)[i] + 1;
1887 arg_length = strlen (arg);
1888 nulled_out = g_newa (gboolean, arg_length);
1889 memset (nulled_out, 0, arg_length * sizeof (gboolean));
1890 for (j = 0; j < arg_length; j++)
1892 if (context->help_enabled && (arg[j] == '?' ||
1893 (arg[j] == 'h' && !has_h_entry)))
1894 print_help (context, TRUE, NULL);
1896 if (context->main_group &&
1897 !parse_short_option (context, context->main_group,
1899 argc, argv, error, &parsed))
1903 /* Try the groups */
1904 list = context->groups;
1907 GOptionGroup *group = list->data;
1908 if (!parse_short_option (context, group, i, &new_i, arg[j],
1909 argc, argv, error, &parsed))
1917 if (context->ignore_unknown && parsed)
1918 nulled_out[j] = TRUE;
1919 else if (context->ignore_unknown)
1923 /* !context->ignore_unknown && parsed */
1925 if (context->ignore_unknown)
1927 gchar *new_arg = NULL;
1929 for (j = 0; j < arg_length; j++)
1934 new_arg = g_malloc (arg_length + 1);
1935 new_arg[arg_index++] = arg[j];
1939 new_arg[arg_index] = '\0';
1940 add_pending_null (context, &((*argv)[i]), new_arg);
1944 add_pending_null (context, &((*argv)[i]), NULL);
1952 if (!parsed && !context->ignore_unknown)
1955 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1956 _("Unknown option %s"), (*argv)[i]);
1962 /* Collect remaining args */
1963 if (context->main_group &&
1964 !parse_remaining_arg (context, context->main_group, &i,
1965 argc, argv, error, &parsed))
1968 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1973 if (separator_pos > 0)
1974 add_pending_null (context, &((*argv)[separator_pos]), NULL);
1978 /* Call post-parse hooks */
1979 list = context->groups;
1982 GOptionGroup *group = list->data;
1984 if (group->post_parse_func)
1986 if (!(* group->post_parse_func) (context, group,
1987 group->user_data, error))
1994 if (context->main_group && context->main_group->post_parse_func)
1996 if (!(* context->main_group->post_parse_func) (context, context->main_group,
1997 context->main_group->user_data, error))
2003 free_pending_nulls (context, TRUE);
2005 for (i = 1; i < *argc; i++)
2007 for (k = i; k < *argc; k++)
2008 if ((*argv)[k] != NULL)
2014 for (j = i + k; j < *argc; j++)
2016 (*argv)[j-k] = (*argv)[j];
2028 /* Call error hooks */
2029 list = context->groups;
2032 GOptionGroup *group = list->data;
2034 if (group->error_func)
2035 (* group->error_func) (context, group,
2036 group->user_data, error);
2041 if (context->main_group && context->main_group->error_func)
2042 (* context->main_group->error_func) (context, context->main_group,
2043 context->main_group->user_data, error);
2045 free_changes_list (context, TRUE);
2046 free_pending_nulls (context, FALSE);
2052 * g_option_group_new:
2053 * @name: the name for the option group, this is used to provide
2054 * help for the options in this group with <option>--help-</option>@name
2055 * @description: a description for this group to be shown in
2056 * <option>--help</option>. This string is translated using the translation
2057 * domain or translation function of the group
2058 * @help_description: a description for the <option>--help-</option>@name option.
2059 * This string is translated using the translation domain or translation function
2061 * @user_data: user data that will be passed to the pre- and post-parse hooks,
2062 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
2063 * @destroy: a function that will be called to free @user_data, or %NULL
2065 * Creates a new #GOptionGroup.
2067 * Return value: a newly created option group. It should be added
2068 * to a #GOptionContext or freed with g_option_group_free().
2073 g_option_group_new (const gchar *name,
2074 const gchar *description,
2075 const gchar *help_description,
2077 GDestroyNotify destroy)
2080 GOptionGroup *group;
2082 group = g_new0 (GOptionGroup, 1);
2083 group->name = g_strdup (name);
2084 group->description = g_strdup (description);
2085 group->help_description = g_strdup (help_description);
2086 group->user_data = user_data;
2087 group->destroy_notify = destroy;
2094 * g_option_group_free:
2095 * @group: a #GOptionGroup
2097 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
2098 * free groups which have been added to a #GOptionContext.
2103 g_option_group_free (GOptionGroup *group)
2105 g_return_if_fail (group != NULL);
2107 g_free (group->name);
2108 g_free (group->description);
2109 g_free (group->help_description);
2111 g_free (group->entries);
2113 if (group->destroy_notify)
2114 (* group->destroy_notify) (group->user_data);
2116 if (group->translate_notify)
2117 (* group->translate_notify) (group->translate_data);
2124 * g_option_group_add_entries:
2125 * @group: a #GOptionGroup
2126 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
2128 * Adds the options specified in @entries to @group.
2133 g_option_group_add_entries (GOptionGroup *group,
2134 const GOptionEntry *entries)
2138 g_return_if_fail (entries != NULL);
2140 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
2142 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
2144 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
2146 for (i = group->n_entries; i < group->n_entries + n_entries; i++)
2148 gchar c = group->entries[i].short_name;
2150 if (c == '-' || (c != 0 && !g_ascii_isprint (c)))
2152 g_warning (G_STRLOC ": ignoring invalid short option '%c' (%d)", c, c);
2153 group->entries[i].short_name = 0;
2156 if (group->entries[i].arg != G_OPTION_ARG_NONE &&
2157 (group->entries[i].flags & G_OPTION_FLAG_REVERSE) != 0)
2159 g_warning (G_STRLOC ": ignoring reverse flag on option of type %d", group->entries[i].arg);
2161 group->entries[i].flags &= ~G_OPTION_FLAG_REVERSE;
2164 if (group->entries[i].arg != G_OPTION_ARG_CALLBACK &&
2165 (group->entries[i].flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME)) != 0)
2167 g_warning (G_STRLOC ": ignoring no-arg, optional-arg or filename flags (%d) on option of type %d", group->entries[i].flags, group->entries[i].arg);
2169 group->entries[i].flags &= ~(G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME);
2173 group->n_entries += n_entries;
2177 * g_option_group_set_parse_hooks:
2178 * @group: a #GOptionGroup
2179 * @pre_parse_func: a function to call before parsing, or %NULL
2180 * @post_parse_func: a function to call after parsing, or %NULL
2182 * Associates two functions with @group which will be called
2183 * from g_option_context_parse() before the first option is parsed
2184 * and after the last option has been parsed, respectively.
2186 * Note that the user data to be passed to @pre_parse_func and
2187 * @post_parse_func can be specified when constructing the group
2188 * with g_option_group_new().
2193 g_option_group_set_parse_hooks (GOptionGroup *group,
2194 GOptionParseFunc pre_parse_func,
2195 GOptionParseFunc post_parse_func)
2197 g_return_if_fail (group != NULL);
2199 group->pre_parse_func = pre_parse_func;
2200 group->post_parse_func = post_parse_func;
2204 * g_option_group_set_error_hook:
2205 * @group: a #GOptionGroup
2206 * @error_func: a function to call when an error occurs
2208 * Associates a function with @group which will be called
2209 * from g_option_context_parse() when an error occurs.
2211 * Note that the user data to be passed to @error_func can be
2212 * specified when constructing the group with g_option_group_new().
2217 g_option_group_set_error_hook (GOptionGroup *group,
2218 GOptionErrorFunc error_func)
2220 g_return_if_fail (group != NULL);
2222 group->error_func = error_func;
2227 * g_option_group_set_translate_func:
2228 * @group: a #GOptionGroup
2229 * @func: the #GTranslateFunc, or %NULL
2230 * @data: user data to pass to @func, or %NULL
2231 * @destroy_notify: a function which gets called to free @data, or %NULL
2233 * Sets the function which is used to translate user-visible
2234 * strings, for <option>--help</option> output. Different
2235 * groups can use different #GTranslateFunc<!-- -->s. If @func
2236 * is %NULL, strings are not translated.
2238 * If you are using gettext(), you only need to set the translation
2239 * domain, see g_option_group_set_translation_domain().
2244 g_option_group_set_translate_func (GOptionGroup *group,
2245 GTranslateFunc func,
2247 GDestroyNotify destroy_notify)
2249 g_return_if_fail (group != NULL);
2251 if (group->translate_notify)
2252 group->translate_notify (group->translate_data);
2254 group->translate_func = func;
2255 group->translate_data = data;
2256 group->translate_notify = destroy_notify;
2259 static const gchar *
2260 dgettext_swapped (const gchar *msgid,
2261 const gchar *domainname)
2263 return g_dgettext (domainname, msgid);
2267 * g_option_group_set_translation_domain:
2268 * @group: a #GOptionGroup
2269 * @domain: the domain to use
2271 * A convenience function to use gettext() for translating
2272 * user-visible strings.
2277 g_option_group_set_translation_domain (GOptionGroup *group,
2278 const gchar *domain)
2280 g_return_if_fail (group != NULL);
2282 g_option_group_set_translate_func (group,
2283 (GTranslateFunc)dgettext_swapped,
2289 * g_option_context_set_translate_func:
2290 * @context: a #GOptionContext
2291 * @func: the #GTranslateFunc, or %NULL
2292 * @data: user data to pass to @func, or %NULL
2293 * @destroy_notify: a function which gets called to free @data, or %NULL
2295 * Sets the function which is used to translate the contexts
2296 * user-visible strings, for <option>--help</option> output.
2297 * If @func is %NULL, strings are not translated.
2299 * Note that option groups have their own translation functions,
2300 * this function only affects the @parameter_string (see g_option_context_new()),
2301 * the summary (see g_option_context_set_summary()) and the description
2302 * (see g_option_context_set_description()).
2304 * If you are using gettext(), you only need to set the translation
2305 * domain, see g_option_context_set_translation_domain().
2310 g_option_context_set_translate_func (GOptionContext *context,
2311 GTranslateFunc func,
2313 GDestroyNotify destroy_notify)
2315 g_return_if_fail (context != NULL);
2317 if (context->translate_notify)
2318 context->translate_notify (context->translate_data);
2320 context->translate_func = func;
2321 context->translate_data = data;
2322 context->translate_notify = destroy_notify;
2326 * g_option_context_set_translation_domain:
2327 * @context: a #GOptionContext
2328 * @domain: the domain to use
2330 * A convenience function to use gettext() for translating
2331 * user-visible strings.
2336 g_option_context_set_translation_domain (GOptionContext *context,
2337 const gchar *domain)
2339 g_return_if_fail (context != NULL);
2341 g_option_context_set_translate_func (context,
2342 (GTranslateFunc)dgettext_swapped,
2348 * g_option_context_set_summary:
2349 * @context: a #GOptionContext
2350 * @summary: a string to be shown in <option>--help</option> output
2351 * before the list of options, or %NULL
2353 * Adds a string to be displayed in <option>--help</option> output
2354 * before the list of options. This is typically a summary of the
2355 * program functionality.
2357 * Note that the summary is translated (see
2358 * g_option_context_set_translate_func() and
2359 * g_option_context_set_translation_domain()).
2364 g_option_context_set_summary (GOptionContext *context,
2365 const gchar *summary)
2367 g_return_if_fail (context != NULL);
2369 g_free (context->summary);
2370 context->summary = g_strdup (summary);
2375 * g_option_context_get_summary:
2376 * @context: a #GOptionContext
2378 * Returns the summary. See g_option_context_set_summary().
2380 * Returns: the summary
2385 g_option_context_get_summary (GOptionContext *context)
2387 g_return_val_if_fail (context != NULL, NULL);
2389 return context->summary;
2393 * g_option_context_set_description:
2394 * @context: a #GOptionContext
2395 * @description: a string to be shown in <option>--help</option> output
2396 * after the list of options, or %NULL
2398 * Adds a string to be displayed in <option>--help</option> output
2399 * after the list of options. This text often includes a bug reporting
2402 * Note that the summary is translated (see
2403 * g_option_context_set_translate_func()).
2408 g_option_context_set_description (GOptionContext *context,
2409 const gchar *description)
2411 g_return_if_fail (context != NULL);
2413 g_free (context->description);
2414 context->description = g_strdup (description);
2419 * g_option_context_get_description:
2420 * @context: a #GOptionContext
2422 * Returns the description. See g_option_context_set_description().
2424 * Returns: the description
2429 g_option_context_get_description (GOptionContext *context)
2431 g_return_val_if_fail (context != NULL, NULL);
2433 return context->description;