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 Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 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 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * @Short_description: parses commandline options
23 * @Title: Commandline option parser
25 * The GOption commandline parser is intended to be a simpler replacement
26 * for the popt library. It supports short and long commandline options,
27 * as shown in the following example:
29 * `testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2`
31 * The example demonstrates a number of features of the GOption
34 * - Options can be single letters, prefixed by a single dash.
36 * - Multiple short options can be grouped behind a single dash.
38 * - Long options are prefixed by two consecutive dashes.
40 * - Options can have an extra argument, which can be a number, a string or
41 * a filename. For long options, the extra argument can be appended with
42 * an equals sign after the option name, which is useful if the extra
43 * argument starts with a dash, which would otherwise cause it to be
44 * interpreted as another option.
46 * - Non-option arguments are returned to the application as rest arguments.
48 * - An argument consisting solely of two dashes turns off further parsing,
49 * any remaining arguments (even those starting with a dash) are returned
50 * to the application as rest arguments.
52 * Another important feature of GOption is that it can automatically
53 * generate nicely formatted help output. Unless it is explicitly turned
54 * off with g_option_context_set_help_enabled(), GOption will recognize
55 * the `--help`, `-?`, `--help-all` and `--help-groupname` options
56 * (where `groupname` is the name of a #GOptionGroup) and write a text
57 * similar to the one shown in the following example to stdout.
61 * testtreemodel [OPTION...] - test tree model performance
64 * -h, --help Show help options
65 * --help-all Show all help options
66 * --help-gtk Show GTK+ Options
68 * Application Options:
69 * -r, --repeats=N Average over N repetitions
70 * -m, --max-size=M Test up to 2^M items
71 * --display=DISPLAY X display to use
72 * -v, --verbose Be verbose
73 * -b, --beep Beep when done
74 * --rand Randomize the data
77 * GOption groups options in #GOptionGroups, which makes it easy to
78 * incorporate options from multiple sources. The intended use for this is
79 * to let applications collect option groups from the libraries it uses,
80 * add them to their #GOptionContext, and parse all options by a single call
81 * to g_option_context_parse(). See gtk_get_option_group() for an example.
83 * If an option is declared to be of type string or filename, GOption takes
84 * care of converting it to the right encoding; strings are returned in
85 * UTF-8, filenames are returned in the GLib filename encoding. Note that
86 * this only works if setlocale() has been called before
87 * g_option_context_parse().
89 * Here is a complete example of setting up GOption to parse the example
90 * commandline above and produce the example help output.
91 * |[<!-- language="C" -->
92 * static gint repeats = 2;
93 * static gint max_size = 8;
94 * static gboolean verbose = FALSE;
95 * static gboolean beep = FALSE;
96 * static gboolean randomize = FALSE;
98 * static GOptionEntry entries[] =
100 * { "repeats", 'r', 0, G_OPTION_ARG_INT, &repeats, "Average over N repetitions", "N" },
101 * { "max-size", 'm', 0, G_OPTION_ARG_INT, &max_size, "Test up to 2^M items", "M" },
102 * { "verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose, "Be verbose", NULL },
103 * { "beep", 'b', 0, G_OPTION_ARG_NONE, &beep, "Beep when done", NULL },
104 * { "rand", 0, 0, G_OPTION_ARG_NONE, &randomize, "Randomize the data", NULL },
109 * main (int argc, char *argv[])
111 * GError *error = NULL;
112 * GOptionContext *context;
114 * context = g_option_context_new ("- test tree model performance");
115 * g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
116 * g_option_context_add_group (context, gtk_get_option_group (TRUE));
117 * if (!g_option_context_parse (context, &argc, &argv, &error))
119 * g_print ("option parsing failed: %s\n", error->message);
128 * On UNIX systems, the argv that is passed to main() has no particular
129 * encoding, even to the extent that different parts of it may have
130 * different encodings. In general, normal arguments and flags will be
131 * in the current locale and filenames should be considered to be opaque
132 * byte strings. Proper use of %G_OPTION_ARG_FILENAME vs
133 * %G_OPTION_ARG_STRING is therefore important.
135 * Note that on Windows, filenames do have an encoding, but using
136 * #GOptionContext with the argv as passed to main() will result in a
137 * program that can only accept commandline arguments with characters
138 * from the system codepage. This can cause problems when attempting to
139 * deal with filenames containing Unicode characters that fall outside
142 * A solution to this is to use g_win32_get_command_line() and
143 * g_option_context_parse_strv() which will properly handle full Unicode
144 * filenames. If you are using #GApplication, this is done
145 * automatically for you.
147 * The following example shows how you can use #GOptionContext directly
148 * in order to correctly deal with Unicode filenames on Windows:
150 * |[<!-- language="C" -->
152 * main (int argc, char **argv)
154 * GError *error = NULL;
155 * GOptionContext *context;
159 * args = g_win32_get_command_line ();
161 * args = g_strdupv (argv);
166 * if (!g_option_context_parse_strv (context, &args, &error))
187 #if defined __OpenBSD__
189 #include <sys/sysctl.h>
195 #include "glibintl.h"
197 #if defined G_OS_WIN32
201 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
203 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
204 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
205 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
207 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
208 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
240 struct _GOptionContext
244 gchar *parameter_string; /* (nullable) */
248 GTranslateFunc translate_func;
249 GDestroyNotify translate_notify;
250 gpointer translate_data;
252 guint help_enabled : 1;
253 guint ignore_unknown : 1;
255 guint strict_posix : 1;
257 GOptionGroup *main_group;
259 /* We keep a list of change so we can revert them */
262 /* We also keep track of all argv elements
263 * that should be NULLed or modified.
265 GList *pending_nulls;
272 gchar *help_description;
276 GDestroyNotify destroy_notify;
279 GTranslateFunc translate_func;
280 GDestroyNotify translate_notify;
281 gpointer translate_data;
283 GOptionEntry *entries;
286 GOptionParseFunc pre_parse_func;
287 GOptionParseFunc post_parse_func;
288 GOptionErrorFunc error_func;
291 static void free_changes_list (GOptionContext *context,
293 static void free_pending_nulls (GOptionContext *context,
294 gboolean perform_nulls);
298 _g_unichar_get_width (gunichar c)
300 if (G_UNLIKELY (g_unichar_iszerowidth (c)))
303 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
304 * some locales (legacy East Asian ones) */
305 if (g_unichar_iswide (c))
312 _g_utf8_strwidth (const gchar *p)
315 g_return_val_if_fail (p != NULL, 0);
319 len += _g_unichar_get_width (g_utf8_get_char (p));
320 p = g_utf8_next_char (p);
326 G_DEFINE_QUARK (g-option-context-error-quark, g_option_error)
329 * g_option_context_new:
330 * @parameter_string: (nullable): a string which is displayed in
331 * the first line of `--help` output, after the usage summary
332 * `programname [OPTION...]`
334 * Creates a new option context.
336 * The @parameter_string can serve multiple purposes. It can be used
337 * to add descriptions for "rest" arguments, which are not parsed by
338 * the #GOptionContext, typically something like "FILES" or
339 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
340 * collecting "rest" arguments, GLib handles this automatically by
341 * using the @arg_description of the corresponding #GOptionEntry in
344 * Another usage is to give a short summary of the program
345 * functionality, like " - frob the strings", which will be displayed
346 * in the same line as the usage. For a longer description of the
347 * program functionality that should be displayed as a paragraph
348 * below the usage line, use g_option_context_set_summary().
350 * Note that the @parameter_string is translated using the
351 * function set with g_option_context_set_translate_func(), so
352 * it should normally be passed untranslated.
354 * Returns: a newly created #GOptionContext, which must be
355 * freed with g_option_context_free() after use.
360 g_option_context_new (const gchar *parameter_string)
363 GOptionContext *context;
365 context = g_new0 (GOptionContext, 1);
367 /* Clear the empty string to NULL, otherwise we end up calling gettext(""),
368 * which returns the translation header. */
369 if (parameter_string != NULL && *parameter_string == '\0')
370 parameter_string = NULL;
372 context->parameter_string = g_strdup (parameter_string);
373 context->strict_posix = FALSE;
374 context->help_enabled = TRUE;
375 context->ignore_unknown = FALSE;
381 * g_option_context_free:
382 * @context: a #GOptionContext
384 * Frees context and all the groups which have been
387 * Please note that parsed arguments need to be freed separately (see
392 void g_option_context_free (GOptionContext *context)
394 g_return_if_fail (context != NULL);
396 g_list_free_full (context->groups, (GDestroyNotify) g_option_group_unref);
398 if (context->main_group)
399 g_option_group_unref (context->main_group);
401 free_changes_list (context, FALSE);
402 free_pending_nulls (context, FALSE);
404 g_free (context->parameter_string);
405 g_free (context->summary);
406 g_free (context->description);
408 if (context->translate_notify)
409 (* context->translate_notify) (context->translate_data);
416 * g_option_context_set_help_enabled:
417 * @context: a #GOptionContext
418 * @help_enabled: %TRUE to enable `--help`, %FALSE to disable it
420 * Enables or disables automatic generation of `--help` output.
421 * By default, g_option_context_parse() recognizes `--help`, `-h`,
422 * `-?`, `--help-all` and `--help-groupname` and creates suitable
427 void g_option_context_set_help_enabled (GOptionContext *context,
428 gboolean help_enabled)
431 g_return_if_fail (context != NULL);
433 context->help_enabled = help_enabled;
437 * g_option_context_get_help_enabled:
438 * @context: a #GOptionContext
440 * Returns whether automatic `--help` generation
441 * is turned on for @context. See g_option_context_set_help_enabled().
443 * Returns: %TRUE if automatic help generation is turned on.
448 g_option_context_get_help_enabled (GOptionContext *context)
450 g_return_val_if_fail (context != NULL, FALSE);
452 return context->help_enabled;
456 * g_option_context_set_ignore_unknown_options:
457 * @context: a #GOptionContext
458 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
459 * an error when unknown options are met
461 * Sets whether to ignore unknown options or not. If an argument is
462 * ignored, it is left in the @argv array after parsing. By default,
463 * g_option_context_parse() treats unknown options as error.
465 * This setting does not affect non-option arguments (i.e. arguments
466 * which don't start with a dash). But note that GOption cannot reliably
467 * determine whether a non-option belongs to a preceding unknown option.
472 g_option_context_set_ignore_unknown_options (GOptionContext *context,
473 gboolean ignore_unknown)
475 g_return_if_fail (context != NULL);
477 context->ignore_unknown = ignore_unknown;
481 * g_option_context_get_ignore_unknown_options:
482 * @context: a #GOptionContext
484 * Returns whether unknown options are ignored or not. See
485 * g_option_context_set_ignore_unknown_options().
487 * Returns: %TRUE if unknown options are ignored.
492 g_option_context_get_ignore_unknown_options (GOptionContext *context)
494 g_return_val_if_fail (context != NULL, FALSE);
496 return context->ignore_unknown;
500 * g_option_context_set_strict_posix:
501 * @context: a #GOptionContext
502 * @strict_posix: the new value
504 * Sets strict POSIX mode.
506 * By default, this mode is disabled.
508 * In strict POSIX mode, the first non-argument parameter encountered
509 * (eg: filename) terminates argument processing. Remaining arguments
510 * are treated as non-options and are not attempted to be parsed.
512 * If strict POSIX mode is disabled then parsing is done in the GNU way
513 * where option arguments can be freely mixed with non-options.
515 * As an example, consider "ls foo -l". With GNU style parsing, this
516 * will list "foo" in long mode. In strict POSIX style, this will list
517 * the files named "foo" and "-l".
519 * It may be useful to force strict POSIX mode when creating "verb
520 * style" command line tools. For example, the "gsettings" command line
521 * tool supports the global option "--schemadir" as well as many
522 * subcommands ("get", "set", etc.) which each have their own set of
523 * arguments. Using strict POSIX mode will allow parsing the global
524 * options up to the verb name while leaving the remaining options to be
525 * parsed by the relevant subcommand (which can be determined by
526 * examining the verb name, which should be present in argv[1] after
532 g_option_context_set_strict_posix (GOptionContext *context,
533 gboolean strict_posix)
535 g_return_if_fail (context != NULL);
537 context->strict_posix = strict_posix;
541 * g_option_context_get_strict_posix:
542 * @context: a #GOptionContext
544 * Returns whether strict POSIX code is enabled.
546 * See g_option_context_set_strict_posix() for more information.
548 * Returns: %TRUE if strict POSIX is enabled, %FALSE otherwise.
553 g_option_context_get_strict_posix (GOptionContext *context)
555 g_return_val_if_fail (context != NULL, FALSE);
557 return context->strict_posix;
561 * g_option_context_add_group:
562 * @context: a #GOptionContext
563 * @group: (transfer full): the group to add
565 * Adds a #GOptionGroup to the @context, so that parsing with @context
566 * will recognize the options in the group. Note that this will take
567 * ownership of the @group and thus the @group should not be freed.
572 g_option_context_add_group (GOptionContext *context,
577 g_return_if_fail (context != NULL);
578 g_return_if_fail (group != NULL);
579 g_return_if_fail (group->name != NULL);
580 g_return_if_fail (group->description != NULL);
581 g_return_if_fail (group->help_description != NULL);
583 for (list = context->groups; list; list = list->next)
585 GOptionGroup *g = (GOptionGroup *)list->data;
587 if ((group->name == NULL && g->name == NULL) ||
588 (group->name && g->name && strcmp (group->name, g->name) == 0))
589 g_warning ("A group named \"%s\" is already part of this GOptionContext",
593 context->groups = g_list_append (context->groups, group);
597 * g_option_context_set_main_group:
598 * @context: a #GOptionContext
599 * @group: (transfer full): the group to set as main group
601 * Sets a #GOptionGroup as main group of the @context.
602 * This has the same effect as calling g_option_context_add_group(),
603 * the only difference is that the options in the main group are
604 * treated differently when generating `--help` output.
609 g_option_context_set_main_group (GOptionContext *context,
612 g_return_if_fail (context != NULL);
613 g_return_if_fail (group != NULL);
615 if (context->main_group)
617 g_warning ("This GOptionContext already has a main group");
622 context->main_group = group;
626 * g_option_context_get_main_group:
627 * @context: a #GOptionContext
629 * Returns a pointer to the main group of @context.
631 * Returns: (transfer none): the main group of @context, or %NULL if
632 * @context doesn't have a main group. Note that group belongs to
633 * @context and should not be modified or freed.
638 g_option_context_get_main_group (GOptionContext *context)
640 g_return_val_if_fail (context != NULL, NULL);
642 return context->main_group;
646 * g_option_context_add_main_entries:
647 * @context: a #GOptionContext
648 * @entries: (array zero-terminated=1): a %NULL-terminated array of #GOptionEntrys
649 * @translation_domain: (nullable): a translation domain to use for translating
650 * the `--help` output for the options in @entries
651 * with gettext(), or %NULL
653 * A convenience function which creates a main group if it doesn't
654 * exist, adds the @entries to it and sets the translation domain.
659 g_option_context_add_main_entries (GOptionContext *context,
660 const GOptionEntry *entries,
661 const gchar *translation_domain)
663 g_return_if_fail (context != NULL);
664 g_return_if_fail (entries != NULL);
666 if (!context->main_group)
667 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
669 g_option_group_add_entries (context->main_group, entries);
670 g_option_group_set_translation_domain (context->main_group, translation_domain);
674 calculate_max_length (GOptionGroup *group,
678 gsize i, len, max_length;
679 const gchar *long_name;
683 for (i = 0; i < group->n_entries; i++)
685 entry = &group->entries[i];
687 if (entry->flags & G_OPTION_FLAG_HIDDEN)
690 long_name = g_hash_table_lookup (aliases, &entry->long_name);
692 long_name = entry->long_name;
693 len = _g_utf8_strwidth (long_name);
695 if (entry->short_name)
698 if (!NO_ARG (entry) && entry->arg_description)
699 len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description));
701 max_length = MAX (max_length, len);
708 print_entry (GOptionGroup *group,
710 const GOptionEntry *entry,
715 const gchar *long_name;
717 if (entry->flags & G_OPTION_FLAG_HIDDEN)
720 if (entry->long_name[0] == 0)
723 long_name = g_hash_table_lookup (aliases, &entry->long_name);
725 long_name = entry->long_name;
727 str = g_string_new (NULL);
729 if (entry->short_name)
730 g_string_append_printf (str, " -%c, --%s", entry->short_name, long_name);
732 g_string_append_printf (str, " --%s", long_name);
734 if (entry->arg_description)
735 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
737 g_string_append_printf (string, "%s%*s %s\n", str->str,
738 (int) (max_length + 4 - _g_utf8_strwidth (str->str)), "",
739 entry->description ? TRANSLATE (group, entry->description) : "");
740 g_string_free (str, TRUE);
744 group_has_visible_entries (GOptionContext *context,
746 gboolean main_entries)
748 GOptionFlags reject_filter = G_OPTION_FLAG_HIDDEN;
751 gboolean main_group = group == context->main_group;
754 reject_filter |= G_OPTION_FLAG_IN_MAIN;
756 for (i = 0, l = (group ? group->n_entries : 0); i < l; i++)
758 entry = &group->entries[i];
760 if (main_entries && !main_group && !(entry->flags & G_OPTION_FLAG_IN_MAIN))
762 if (entry->long_name[0] == 0) /* ignore rest entry */
764 if (!(entry->flags & reject_filter))
772 group_list_has_visible_entries (GOptionContext *context,
774 gboolean main_entries)
778 if (group_has_visible_entries (context, group_list->data, main_entries))
781 group_list = group_list->next;
788 context_has_h_entry (GOptionContext *context)
793 if (context->main_group)
795 for (i = 0; i < context->main_group->n_entries; i++)
797 if (context->main_group->entries[i].short_name == 'h')
802 for (list = context->groups; list != NULL; list = g_list_next (list))
806 group = (GOptionGroup*)list->data;
807 for (i = 0; i < group->n_entries; i++)
809 if (group->entries[i].short_name == 'h')
817 * g_option_context_get_help:
818 * @context: a #GOptionContext
819 * @main_help: if %TRUE, only include the main group
820 * @group: (nullable): the #GOptionGroup to create help for, or %NULL
822 * Returns a formatted, translated help text for the given context.
823 * To obtain the text produced by `--help`, call
824 * `g_option_context_get_help (context, TRUE, NULL)`.
825 * To obtain the text produced by `--help-all`, call
826 * `g_option_context_get_help (context, FALSE, NULL)`.
827 * To obtain the help text for an option group, call
828 * `g_option_context_get_help (context, FALSE, group)`.
830 * Returns: A newly allocated string containing the help text
835 g_option_context_get_help (GOptionContext *context,
840 gint max_length = 0, len;
843 GHashTable *shadow_map;
846 const gchar *rest_description;
850 g_return_val_if_fail (context != NULL, NULL);
852 string = g_string_sized_new (1024);
854 rest_description = NULL;
855 if (context->main_group)
858 for (i = 0; i < context->main_group->n_entries; i++)
860 entry = &context->main_group->entries[i];
861 if (entry->long_name[0] == 0)
863 rest_description = TRANSLATE (context->main_group, entry->arg_description);
869 g_string_append_printf (string, "%s\n %s", _("Usage:"), g_get_prgname ());
870 if (context->help_enabled ||
871 (context->main_group && context->main_group->n_entries > 0) ||
872 context->groups != NULL)
873 g_string_append_printf (string, " %s", _("[OPTION…]"));
875 if (rest_description)
877 g_string_append (string, " ");
878 g_string_append (string, rest_description);
881 if (context->parameter_string)
883 g_string_append (string, " ");
884 g_string_append (string, TRANSLATE (context, context->parameter_string));
887 g_string_append (string, "\n\n");
889 if (context->summary)
891 g_string_append (string, TRANSLATE (context, context->summary));
892 g_string_append (string, "\n\n");
895 memset (seen, 0, sizeof (gboolean) * 256);
896 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
897 aliases = g_hash_table_new_full (NULL, NULL, NULL, g_free);
899 if (context->main_group)
901 for (i = 0; i < context->main_group->n_entries; i++)
903 entry = &context->main_group->entries[i];
904 g_hash_table_insert (shadow_map,
905 (gpointer)entry->long_name,
908 if (seen[(guchar)entry->short_name])
909 entry->short_name = 0;
911 seen[(guchar)entry->short_name] = TRUE;
915 list = context->groups;
918 GOptionGroup *g = list->data;
919 for (i = 0; i < g->n_entries; i++)
921 entry = &g->entries[i];
922 if (g_hash_table_lookup (shadow_map, entry->long_name) &&
923 !(entry->flags & G_OPTION_FLAG_NOALIAS))
925 g_hash_table_insert (aliases, &entry->long_name,
926 g_strdup_printf ("%s-%s", g->name, entry->long_name));
929 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
931 if (seen[(guchar)entry->short_name] &&
932 !(entry->flags & G_OPTION_FLAG_NOALIAS))
933 entry->short_name = 0;
935 seen[(guchar)entry->short_name] = TRUE;
940 g_hash_table_destroy (shadow_map);
942 list = context->groups;
944 if (context->help_enabled)
946 max_length = _g_utf8_strwidth ("-?, --help");
950 len = _g_utf8_strwidth ("--help-all");
951 max_length = MAX (max_length, len);
955 if (context->main_group)
957 len = calculate_max_length (context->main_group, aliases);
958 max_length = MAX (max_length, len);
963 GOptionGroup *g = list->data;
965 if (context->help_enabled)
967 /* First, we check the --help-<groupname> options */
968 len = _g_utf8_strwidth ("--help-") + _g_utf8_strwidth (g->name);
969 max_length = MAX (max_length, len);
972 /* Then we go through the entries */
973 len = calculate_max_length (g, aliases);
974 max_length = MAX (max_length, len);
979 /* Add a bit of padding */
982 if (!group && context->help_enabled)
984 list = context->groups;
986 token = context_has_h_entry (context) ? '?' : 'h';
988 g_string_append_printf (string, "%s\n -%c, --%-*s %s\n",
989 _("Help Options:"), token, max_length - 4, "help",
990 _("Show help options"));
992 /* We only want --help-all when there are groups */
994 g_string_append_printf (string, " --%-*s %s\n",
995 max_length, "help-all",
996 _("Show all help options"));
1000 GOptionGroup *g = list->data;
1002 if (group_has_visible_entries (context, g, FALSE))
1003 g_string_append_printf (string, " --help-%-*s %s\n",
1004 max_length - 5, g->name,
1005 TRANSLATE (g, g->help_description));
1010 g_string_append (string, "\n");
1015 /* Print a certain group */
1017 if (group_has_visible_entries (context, group, FALSE))
1019 g_string_append (string, TRANSLATE (group, group->description));
1020 g_string_append (string, "\n");
1021 for (i = 0; i < group->n_entries; i++)
1022 print_entry (group, max_length, &group->entries[i], string, aliases);
1023 g_string_append (string, "\n");
1026 else if (!main_help)
1028 /* Print all groups */
1030 list = context->groups;
1034 GOptionGroup *g = list->data;
1036 if (group_has_visible_entries (context, g, FALSE))
1038 g_string_append (string, g->description);
1039 g_string_append (string, "\n");
1040 for (i = 0; i < g->n_entries; i++)
1041 if (!(g->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
1042 print_entry (g, max_length, &g->entries[i], string, aliases);
1044 g_string_append (string, "\n");
1051 /* Print application options if --help or --help-all has been specified */
1052 if ((main_help || !group) &&
1053 (group_has_visible_entries (context, context->main_group, TRUE) ||
1054 group_list_has_visible_entries (context, context->groups, TRUE)))
1056 list = context->groups;
1058 if (context->help_enabled || list)
1059 g_string_append (string, _("Application Options:"));
1061 g_string_append (string, _("Options:"));
1062 g_string_append (string, "\n");
1063 if (context->main_group)
1064 for (i = 0; i < context->main_group->n_entries; i++)
1065 print_entry (context->main_group, max_length,
1066 &context->main_group->entries[i], string, aliases);
1068 while (list != NULL)
1070 GOptionGroup *g = list->data;
1072 /* Print main entries from other groups */
1073 for (i = 0; i < g->n_entries; i++)
1074 if (g->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
1075 print_entry (g, max_length, &g->entries[i], string, aliases);
1080 g_string_append (string, "\n");
1083 if (context->description)
1085 g_string_append (string, TRANSLATE (context, context->description));
1086 g_string_append (string, "\n");
1089 g_hash_table_destroy (aliases);
1091 return g_string_free (string, FALSE);
1096 print_help (GOptionContext *context,
1098 GOptionGroup *group)
1102 help = g_option_context_get_help (context, main_help, group);
1103 g_print ("%s", help);
1110 parse_int (const gchar *arg_name,
1119 tmp = strtol (arg, &end, 0);
1121 if (*arg == '\0' || *end != '\0')
1124 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1125 _("Cannot parse integer value “%s” for %s"),
1131 if (*result != tmp || errno == ERANGE)
1134 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1135 _("Integer value “%s” for %s out of range"),
1145 parse_double (const gchar *arg_name,
1154 tmp = g_strtod (arg, &end);
1156 if (*arg == '\0' || *end != '\0')
1159 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1160 _("Cannot parse double value “%s” for %s"),
1164 if (errno == ERANGE)
1167 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1168 _("Double value “%s” for %s out of range"),
1180 parse_int64 (const gchar *arg_name,
1189 tmp = g_ascii_strtoll (arg, &end, 0);
1191 if (*arg == '\0' || *end != '\0')
1194 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1195 _("Cannot parse integer value “%s” for %s"),
1199 if (errno == ERANGE)
1202 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1203 _("Integer value “%s” for %s out of range"),
1215 get_change (GOptionContext *context,
1216 GOptionArg arg_type,
1220 Change *change = NULL;
1222 for (list = context->changes; list != NULL; list = list->next)
1224 change = list->data;
1226 if (change->arg_data == arg_data)
1230 change = g_new0 (Change, 1);
1231 change->arg_type = arg_type;
1232 change->arg_data = arg_data;
1234 context->changes = g_list_prepend (context->changes, change);
1242 add_pending_null (GOptionContext *context,
1248 n = g_new0 (PendingNull, 1);
1252 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
1256 parse_arg (GOptionContext *context,
1257 GOptionGroup *group,
1258 GOptionEntry *entry,
1260 const gchar *option_name,
1266 g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
1270 case G_OPTION_ARG_NONE:
1272 (void) get_change (context, G_OPTION_ARG_NONE,
1275 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1278 case G_OPTION_ARG_STRING:
1283 if (!context->strv_mode)
1284 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1286 data = g_strdup (value);
1288 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1294 change = get_change (context, G_OPTION_ARG_STRING,
1297 if (!change->allocated.str)
1298 change->prev.str = *(gchar **)entry->arg_data;
1300 g_free (change->allocated.str);
1302 change->allocated.str = data;
1304 *(gchar **)entry->arg_data = data;
1307 case G_OPTION_ARG_STRING_ARRAY:
1312 if (!context->strv_mode)
1313 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1315 data = g_strdup (value);
1317 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1323 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1326 if (change->allocated.array.len == 0)
1328 change->prev.array = *(gchar ***)entry->arg_data;
1329 change->allocated.array.data = g_new (gchar *, 2);
1332 change->allocated.array.data =
1333 g_renew (gchar *, change->allocated.array.data,
1334 change->allocated.array.len + 2);
1336 change->allocated.array.data[change->allocated.array.len] = data;
1337 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1339 change->allocated.array.len ++;
1341 *(gchar ***)entry->arg_data = change->allocated.array.data;
1346 case G_OPTION_ARG_FILENAME:
1351 if (!context->strv_mode)
1352 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1354 data = g_strdup (value);
1359 data = g_strdup (value);
1361 change = get_change (context, G_OPTION_ARG_FILENAME,
1364 if (!change->allocated.str)
1365 change->prev.str = *(gchar **)entry->arg_data;
1367 g_free (change->allocated.str);
1369 change->allocated.str = data;
1371 *(gchar **)entry->arg_data = data;
1375 case G_OPTION_ARG_FILENAME_ARRAY:
1380 if (!context->strv_mode)
1381 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1383 data = g_strdup (value);
1388 data = g_strdup (value);
1390 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1393 if (change->allocated.array.len == 0)
1395 change->prev.array = *(gchar ***)entry->arg_data;
1396 change->allocated.array.data = g_new (gchar *, 2);
1399 change->allocated.array.data =
1400 g_renew (gchar *, change->allocated.array.data,
1401 change->allocated.array.len + 2);
1403 change->allocated.array.data[change->allocated.array.len] = data;
1404 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1406 change->allocated.array.len ++;
1408 *(gchar ***)entry->arg_data = change->allocated.array.data;
1413 case G_OPTION_ARG_INT:
1417 if (!parse_int (option_name, value,
1422 change = get_change (context, G_OPTION_ARG_INT,
1424 change->prev.integer = *(gint *)entry->arg_data;
1425 *(gint *)entry->arg_data = data;
1428 case G_OPTION_ARG_CALLBACK:
1433 if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1435 else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1437 else if (entry->flags & G_OPTION_FLAG_FILENAME)
1440 if (!context->strv_mode)
1441 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1443 data = g_strdup (value);
1445 data = g_strdup (value);
1449 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1451 if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1455 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1457 if (!retval && error != NULL && *error == NULL)
1459 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1460 _("Error parsing option %s"), option_name);
1468 case G_OPTION_ARG_DOUBLE:
1472 if (!parse_double (option_name, value,
1479 change = get_change (context, G_OPTION_ARG_DOUBLE,
1481 change->prev.dbl = *(gdouble *)entry->arg_data;
1482 *(gdouble *)entry->arg_data = data;
1485 case G_OPTION_ARG_INT64:
1489 if (!parse_int64 (option_name, value,
1496 change = get_change (context, G_OPTION_ARG_INT64,
1498 change->prev.int64 = *(gint64 *)entry->arg_data;
1499 *(gint64 *)entry->arg_data = data;
1503 g_assert_not_reached ();
1510 parse_short_option (GOptionContext *context,
1511 GOptionGroup *group,
1522 for (j = 0; j < group->n_entries; j++)
1524 if (arg == group->entries[j].short_name)
1527 gchar *value = NULL;
1529 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1531 if (NO_ARG (&group->entries[j]))
1538 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1539 _("Error parsing option %s"), option_name);
1540 g_free (option_name);
1544 if (idx < *argc - 1)
1546 if (!OPTIONAL_ARG (&group->entries[j]))
1548 value = (*argv)[idx + 1];
1549 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1554 if ((*argv)[idx + 1][0] == '-')
1558 value = (*argv)[idx + 1];
1559 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1564 else if (idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1569 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1570 _("Missing argument for %s"), option_name);
1571 g_free (option_name);
1576 if (!parse_arg (context, group, &group->entries[j],
1577 value, option_name, error))
1579 g_free (option_name);
1583 g_free (option_name);
1592 parse_long_option (GOptionContext *context,
1593 GOptionGroup *group,
1604 for (j = 0; j < group->n_entries; j++)
1609 if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1612 if (NO_ARG (&group->entries[j]) &&
1613 strcmp (arg, group->entries[j].long_name) == 0)
1618 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1619 retval = parse_arg (context, group, &group->entries[j],
1620 NULL, option_name, error);
1621 g_free (option_name);
1623 add_pending_null (context, &((*argv)[*idx]), NULL);
1630 gint len = strlen (group->entries[j].long_name);
1632 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1633 (arg[len] == '=' || arg[len] == 0))
1635 gchar *value = NULL;
1638 add_pending_null (context, &((*argv)[*idx]), NULL);
1639 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1641 if (arg[len] == '=')
1642 value = arg + len + 1;
1643 else if (*idx < *argc - 1)
1645 if (!OPTIONAL_ARG (&group->entries[j]))
1647 value = (*argv)[*idx + 1];
1648 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1653 if ((*argv)[*idx + 1][0] == '-')
1656 retval = parse_arg (context, group, &group->entries[j],
1657 NULL, option_name, error);
1659 g_free (option_name);
1664 value = (*argv)[*idx + 1];
1665 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1670 else if (*idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1673 retval = parse_arg (context, group, &group->entries[j],
1674 NULL, option_name, error);
1676 g_free (option_name);
1682 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1683 _("Missing argument for %s"), option_name);
1684 g_free (option_name);
1688 if (!parse_arg (context, group, &group->entries[j],
1689 value, option_name, error))
1691 g_free (option_name);
1695 g_free (option_name);
1705 parse_remaining_arg (GOptionContext *context,
1706 GOptionGroup *group,
1715 for (j = 0; j < group->n_entries; j++)
1720 if (group->entries[j].long_name[0])
1723 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1724 group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1725 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1727 add_pending_null (context, &((*argv)[*idx]), NULL);
1729 if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
1740 free_changes_list (GOptionContext *context,
1745 for (list = context->changes; list != NULL; list = list->next)
1747 Change *change = list->data;
1751 switch (change->arg_type)
1753 case G_OPTION_ARG_NONE:
1754 *(gboolean *)change->arg_data = change->prev.bool;
1756 case G_OPTION_ARG_INT:
1757 *(gint *)change->arg_data = change->prev.integer;
1759 case G_OPTION_ARG_STRING:
1760 case G_OPTION_ARG_FILENAME:
1761 g_free (change->allocated.str);
1762 *(gchar **)change->arg_data = change->prev.str;
1764 case G_OPTION_ARG_STRING_ARRAY:
1765 case G_OPTION_ARG_FILENAME_ARRAY:
1766 g_strfreev (change->allocated.array.data);
1767 *(gchar ***)change->arg_data = change->prev.array;
1769 case G_OPTION_ARG_DOUBLE:
1770 *(gdouble *)change->arg_data = change->prev.dbl;
1772 case G_OPTION_ARG_INT64:
1773 *(gint64 *)change->arg_data = change->prev.int64;
1776 g_assert_not_reached ();
1783 g_list_free (context->changes);
1784 context->changes = NULL;
1788 free_pending_nulls (GOptionContext *context,
1789 gboolean perform_nulls)
1793 for (list = context->pending_nulls; list != NULL; list = list->next)
1795 PendingNull *n = list->data;
1801 /* Copy back the short options */
1803 strcpy (*n->ptr + 1, n->value);
1807 if (context->strv_mode)
1818 g_list_free (context->pending_nulls);
1819 context->pending_nulls = NULL;
1822 /* Use a platform-specific mechanism to look up the first argument to
1823 * the current process.
1824 * Note if you implement this for other platforms, also add it to
1825 * tests/option-argv0.c
1828 platform_get_argv0 (void)
1830 #ifdef HAVE_PROC_SELF_CMDLINE
1835 if (!g_file_get_contents ("/proc/self/cmdline",
1841 /* g_file_get_contents() guarantees to put a NUL immediately after the
1842 * file's contents (at cmdline[len] here), even if the file itself was
1843 * not NUL-terminated. */
1844 g_assert (memchr (cmdline, 0, len + 1));
1846 /* We could just return cmdline, but I think it's better
1847 * to hold on to a smaller malloc block; the arguments
1850 base_arg0 = g_path_get_basename (cmdline);
1853 #elif defined __OpenBSD__
1858 int mib[] = { CTL_KERN, KERN_PROC_ARGS, getpid(), KERN_PROC_ARGV };
1860 if (sysctl (mib, G_N_ELEMENTS (mib), NULL, &len, NULL, 0) == -1)
1863 cmdline = g_malloc0 (len);
1865 if (sysctl (mib, G_N_ELEMENTS (mib), cmdline, &len, NULL, 0) == -1)
1871 /* We could just return cmdline, but I think it's better
1872 * to hold on to a smaller malloc block; the arguments
1875 base_arg0 = g_path_get_basename (*cmdline);
1878 #elif defined G_OS_WIN32
1879 const wchar_t *cmdline;
1882 gchar *utf8_buf = NULL;
1883 char *base_arg0 = NULL;
1885 /* Pretend it's const, since we're not allowed to free it */
1886 cmdline = (const wchar_t *) GetCommandLineW ();
1887 if (G_UNLIKELY (cmdline == NULL))
1890 /* Skip leading whitespace. CommandLineToArgvW() is documented
1891 * to behave weirdly with that. The character codes below
1892 * correspond to the *only* unicode characters that are
1893 * considered to be spaces by CommandLineToArgvW(). The rest
1894 * (such as 0xa0 - NO-BREAK SPACE) are treated as
1895 * normal characters.
1897 while (cmdline[0] == 0x09 ||
1898 cmdline[0] == 0x0a ||
1899 cmdline[0] == 0x0c ||
1900 cmdline[0] == 0x0d ||
1904 wargv = CommandLineToArgvW (cmdline, &wargc);
1905 if (G_UNLIKELY (wargv == NULL))
1909 utf8_buf = g_utf16_to_utf8 (wargv[0], -1, NULL, NULL, NULL);
1913 if (G_UNLIKELY (utf8_buf == NULL))
1916 /* We could just return cmdline, but I think it's better
1917 * to hold on to a smaller malloc block; the arguments
1920 base_arg0 = g_path_get_basename (utf8_buf);
1929 * g_option_context_parse:
1930 * @context: a #GOptionContext
1931 * @argc: (inout) (optional): a pointer to the number of command line arguments
1932 * @argv: (inout) (array length=argc) (optional): a pointer to the array of command line arguments
1933 * @error: a return location for errors
1935 * Parses the command line arguments, recognizing options
1936 * which have been added to @context. A side-effect of
1937 * calling this function is that g_set_prgname() will be
1940 * If the parsing is successful, any parsed arguments are
1941 * removed from the array and @argc and @argv are updated
1942 * accordingly. A '--' option is stripped from @argv
1943 * unless there are unparsed options before and after it,
1944 * or some of the options after it start with '-'. In case
1945 * of an error, @argc and @argv are left unmodified.
1947 * If automatic `--help` support is enabled
1948 * (see g_option_context_set_help_enabled()), and the
1949 * @argv array contains one of the recognized help options,
1950 * this function will produce help output to stdout and
1953 * Note that function depends on the [current locale][setlocale] for
1954 * automatic character set conversion of string and filename
1957 * Returns: %TRUE if the parsing was successful,
1958 * %FALSE if an error occurred
1963 g_option_context_parse (GOptionContext *context,
1971 g_return_val_if_fail (context != NULL, FALSE);
1973 /* Set program name */
1974 if (!g_get_prgname())
1978 if (argc && argv && *argc)
1979 prgname = g_path_get_basename ((*argv)[0]);
1981 prgname = platform_get_argv0 ();
1984 g_set_prgname (prgname);
1986 g_set_prgname ("<unknown>");
1991 /* Call pre-parse hooks */
1992 list = context->groups;
1995 GOptionGroup *group = list->data;
1997 if (group->pre_parse_func)
1999 if (!(* group->pre_parse_func) (context, group,
2000 group->user_data, error))
2007 if (context->main_group && context->main_group->pre_parse_func)
2009 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
2010 context->main_group->user_data, error))
2016 gboolean stop_parsing = FALSE;
2017 gboolean has_unknown = FALSE;
2018 gint separator_pos = 0;
2020 for (i = 1; i < *argc; i++)
2023 gboolean parsed = FALSE;
2025 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
2027 if ((*argv)[i][1] == '-')
2031 arg = (*argv)[i] + 2;
2033 /* '--' terminates list of arguments */
2037 stop_parsing = TRUE;
2041 /* Handle help options */
2042 if (context->help_enabled)
2044 if (strcmp (arg, "help") == 0)
2045 print_help (context, TRUE, NULL);
2046 else if (strcmp (arg, "help-all") == 0)
2047 print_help (context, FALSE, NULL);
2048 else if (strncmp (arg, "help-", 5) == 0)
2050 list = context->groups;
2054 GOptionGroup *group = list->data;
2056 if (strcmp (arg + 5, group->name) == 0)
2057 print_help (context, FALSE, group);
2064 if (context->main_group &&
2065 !parse_long_option (context, context->main_group, &i, arg,
2066 FALSE, argc, argv, error, &parsed))
2072 /* Try the groups */
2073 list = context->groups;
2076 GOptionGroup *group = list->data;
2078 if (!parse_long_option (context, group, &i, arg,
2079 FALSE, argc, argv, error, &parsed))
2091 /* Now look for --<group>-<option> */
2092 dash = strchr (arg, '-');
2093 if (dash && arg < dash)
2095 /* Try the groups */
2096 list = context->groups;
2099 GOptionGroup *group = list->data;
2101 if (strncmp (group->name, arg, dash - arg) == 0)
2103 if (!parse_long_option (context, group, &i, dash + 1,
2104 TRUE, argc, argv, error, &parsed))
2115 if (context->ignore_unknown)
2119 { /* short option */
2120 gint new_i = i, arg_length;
2121 gboolean *nulled_out = NULL;
2122 gboolean has_h_entry = context_has_h_entry (context);
2123 arg = (*argv)[i] + 1;
2124 arg_length = strlen (arg);
2125 nulled_out = g_newa (gboolean, arg_length);
2126 memset (nulled_out, 0, arg_length * sizeof (gboolean));
2127 for (j = 0; j < arg_length; j++)
2129 if (context->help_enabled && (arg[j] == '?' ||
2130 (arg[j] == 'h' && !has_h_entry)))
2131 print_help (context, TRUE, NULL);
2133 if (context->main_group &&
2134 !parse_short_option (context, context->main_group,
2136 argc, argv, error, &parsed))
2140 /* Try the groups */
2141 list = context->groups;
2144 GOptionGroup *group = list->data;
2145 if (!parse_short_option (context, group, i, &new_i, arg[j],
2146 argc, argv, error, &parsed))
2154 if (context->ignore_unknown && parsed)
2155 nulled_out[j] = TRUE;
2156 else if (context->ignore_unknown)
2160 /* !context->ignore_unknown && parsed */
2162 if (context->ignore_unknown)
2164 gchar *new_arg = NULL;
2166 for (j = 0; j < arg_length; j++)
2171 new_arg = g_malloc (arg_length + 1);
2172 new_arg[arg_index++] = arg[j];
2176 new_arg[arg_index] = '\0';
2177 add_pending_null (context, &((*argv)[i]), new_arg);
2182 add_pending_null (context, &((*argv)[i]), NULL);
2190 if (!parsed && !context->ignore_unknown)
2193 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
2194 _("Unknown option %s"), (*argv)[i]);
2200 if (context->strict_posix)
2201 stop_parsing = TRUE;
2203 /* Collect remaining args */
2204 if (context->main_group &&
2205 !parse_remaining_arg (context, context->main_group, &i,
2206 argc, argv, error, &parsed))
2209 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
2214 if (separator_pos > 0)
2215 add_pending_null (context, &((*argv)[separator_pos]), NULL);
2219 /* Call post-parse hooks */
2220 list = context->groups;
2223 GOptionGroup *group = list->data;
2225 if (group->post_parse_func)
2227 if (!(* group->post_parse_func) (context, group,
2228 group->user_data, error))
2235 if (context->main_group && context->main_group->post_parse_func)
2237 if (!(* context->main_group->post_parse_func) (context, context->main_group,
2238 context->main_group->user_data, error))
2244 free_pending_nulls (context, TRUE);
2246 for (i = 1; i < *argc; i++)
2248 for (k = i; k < *argc; k++)
2249 if ((*argv)[k] != NULL)
2255 for (j = i + k; j < *argc; j++)
2257 (*argv)[j-k] = (*argv)[j];
2269 /* Call error hooks */
2270 list = context->groups;
2273 GOptionGroup *group = list->data;
2275 if (group->error_func)
2276 (* group->error_func) (context, group,
2277 group->user_data, error);
2282 if (context->main_group && context->main_group->error_func)
2283 (* context->main_group->error_func) (context, context->main_group,
2284 context->main_group->user_data, error);
2286 free_changes_list (context, TRUE);
2287 free_pending_nulls (context, FALSE);
2293 * g_option_group_new:
2294 * @name: the name for the option group, this is used to provide
2295 * help for the options in this group with `--help-`@name
2296 * @description: a description for this group to be shown in
2297 * `--help`. This string is translated using the translation
2298 * domain or translation function of the group
2299 * @help_description: a description for the `--help-`@name option.
2300 * This string is translated using the translation domain or translation function
2302 * @user_data: (nullable): user data that will be passed to the pre- and post-parse hooks,
2303 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
2304 * @destroy: (nullable): a function that will be called to free @user_data, or %NULL
2306 * Creates a new #GOptionGroup.
2308 * Returns: a newly created option group. It should be added
2309 * to a #GOptionContext or freed with g_option_group_unref().
2314 g_option_group_new (const gchar *name,
2315 const gchar *description,
2316 const gchar *help_description,
2318 GDestroyNotify destroy)
2321 GOptionGroup *group;
2323 group = g_new0 (GOptionGroup, 1);
2324 group->ref_count = 1;
2325 group->name = g_strdup (name);
2326 group->description = g_strdup (description);
2327 group->help_description = g_strdup (help_description);
2328 group->user_data = user_data;
2329 group->destroy_notify = destroy;
2336 * g_option_group_free:
2337 * @group: a #GOptionGroup
2339 * Frees a #GOptionGroup. Note that you must not free groups
2340 * which have been added to a #GOptionContext.
2344 * Deprecated: 2.44: Use g_option_group_unref() instead.
2347 g_option_group_free (GOptionGroup *group)
2349 g_option_group_unref (group);
2353 * g_option_group_ref:
2354 * @group: a #GOptionGroup
2356 * Increments the reference count of @group by one.
2358 * Returns: a #GOptionGroup
2363 g_option_group_ref (GOptionGroup *group)
2365 g_return_val_if_fail (group != NULL, NULL);
2373 * g_option_group_unref:
2374 * @group: a #GOptionGroup
2376 * Decrements the reference count of @group by one.
2377 * If the reference count drops to 0, the @group will be freed.
2378 * and all memory allocated by the @group is released.
2383 g_option_group_unref (GOptionGroup *group)
2385 g_return_if_fail (group != NULL);
2387 if (--group->ref_count == 0)
2389 g_free (group->name);
2390 g_free (group->description);
2391 g_free (group->help_description);
2393 g_free (group->entries);
2395 if (group->destroy_notify)
2396 (* group->destroy_notify) (group->user_data);
2398 if (group->translate_notify)
2399 (* group->translate_notify) (group->translate_data);
2406 * g_option_group_add_entries:
2407 * @group: a #GOptionGroup
2408 * @entries: (array zero-terminated=1): a %NULL-terminated array of #GOptionEntrys
2410 * Adds the options specified in @entries to @group.
2415 g_option_group_add_entries (GOptionGroup *group,
2416 const GOptionEntry *entries)
2420 g_return_if_fail (group != NULL);
2421 g_return_if_fail (entries != NULL);
2423 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
2425 g_return_if_fail (n_entries <= G_MAXSIZE - group->n_entries);
2427 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
2429 /* group->entries could be NULL in the trivial case where we add no
2430 * entries to no entries */
2432 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
2434 for (i = group->n_entries; i < group->n_entries + n_entries; i++)
2436 gchar c = group->entries[i].short_name;
2438 if (c == '-' || (c != 0 && !g_ascii_isprint (c)))
2440 g_warning (G_STRLOC ": ignoring invalid short option '%c' (%d) in entry %s:%s",
2441 c, c, group->name, group->entries[i].long_name);
2442 group->entries[i].short_name = '\0';
2445 if (group->entries[i].arg != G_OPTION_ARG_NONE &&
2446 (group->entries[i].flags & G_OPTION_FLAG_REVERSE) != 0)
2448 g_warning (G_STRLOC ": ignoring reverse flag on option of arg-type %d in entry %s:%s",
2449 group->entries[i].arg, group->name, group->entries[i].long_name);
2451 group->entries[i].flags &= ~G_OPTION_FLAG_REVERSE;
2454 if (group->entries[i].arg != G_OPTION_ARG_CALLBACK &&
2455 (group->entries[i].flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME)) != 0)
2457 g_warning (G_STRLOC ": ignoring no-arg, optional-arg or filename flags (%d) on option of arg-type %d in entry %s:%s",
2458 group->entries[i].flags, group->entries[i].arg, group->name, group->entries[i].long_name);
2460 group->entries[i].flags &= ~(G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME);
2464 group->n_entries += n_entries;
2468 * g_option_group_set_parse_hooks:
2469 * @group: a #GOptionGroup
2470 * @pre_parse_func: (nullable): a function to call before parsing, or %NULL
2471 * @post_parse_func: (nullable): a function to call after parsing, or %NULL
2473 * Associates two functions with @group which will be called
2474 * from g_option_context_parse() before the first option is parsed
2475 * and after the last option has been parsed, respectively.
2477 * Note that the user data to be passed to @pre_parse_func and
2478 * @post_parse_func can be specified when constructing the group
2479 * with g_option_group_new().
2484 g_option_group_set_parse_hooks (GOptionGroup *group,
2485 GOptionParseFunc pre_parse_func,
2486 GOptionParseFunc post_parse_func)
2488 g_return_if_fail (group != NULL);
2490 group->pre_parse_func = pre_parse_func;
2491 group->post_parse_func = post_parse_func;
2495 * g_option_group_set_error_hook:
2496 * @group: a #GOptionGroup
2497 * @error_func: a function to call when an error occurs
2499 * Associates a function with @group which will be called
2500 * from g_option_context_parse() when an error occurs.
2502 * Note that the user data to be passed to @error_func can be
2503 * specified when constructing the group with g_option_group_new().
2508 g_option_group_set_error_hook (GOptionGroup *group,
2509 GOptionErrorFunc error_func)
2511 g_return_if_fail (group != NULL);
2513 group->error_func = error_func;
2518 * g_option_group_set_translate_func:
2519 * @group: a #GOptionGroup
2520 * @func: (nullable): the #GTranslateFunc, or %NULL
2521 * @data: (nullable): user data to pass to @func, or %NULL
2522 * @destroy_notify: (nullable): a function which gets called to free @data, or %NULL
2524 * Sets the function which is used to translate user-visible strings,
2525 * for `--help` output. Different groups can use different
2526 * #GTranslateFuncs. If @func is %NULL, strings are not translated.
2528 * If you are using gettext(), you only need to set the translation
2529 * domain, see g_option_group_set_translation_domain().
2534 g_option_group_set_translate_func (GOptionGroup *group,
2535 GTranslateFunc func,
2537 GDestroyNotify destroy_notify)
2539 g_return_if_fail (group != NULL);
2541 if (group->translate_notify)
2542 group->translate_notify (group->translate_data);
2544 group->translate_func = func;
2545 group->translate_data = data;
2546 group->translate_notify = destroy_notify;
2549 static const gchar *
2550 dgettext_swapped (const gchar *msgid,
2551 const gchar *domainname)
2553 return g_dgettext (domainname, msgid);
2557 * g_option_group_set_translation_domain:
2558 * @group: a #GOptionGroup
2559 * @domain: the domain to use
2561 * A convenience function to use gettext() for translating
2562 * user-visible strings.
2567 g_option_group_set_translation_domain (GOptionGroup *group,
2568 const gchar *domain)
2570 g_return_if_fail (group != NULL);
2572 g_option_group_set_translate_func (group,
2573 (GTranslateFunc)dgettext_swapped,
2579 * g_option_context_set_translate_func:
2580 * @context: a #GOptionContext
2581 * @func: (nullable): the #GTranslateFunc, or %NULL
2582 * @data: (nullable): user data to pass to @func, or %NULL
2583 * @destroy_notify: (nullable): a function which gets called to free @data, or %NULL
2585 * Sets the function which is used to translate the contexts
2586 * user-visible strings, for `--help` output. If @func is %NULL,
2587 * strings are not translated.
2589 * Note that option groups have their own translation functions,
2590 * this function only affects the @parameter_string (see g_option_context_new()),
2591 * the summary (see g_option_context_set_summary()) and the description
2592 * (see g_option_context_set_description()).
2594 * If you are using gettext(), you only need to set the translation
2595 * domain, see g_option_context_set_translation_domain().
2600 g_option_context_set_translate_func (GOptionContext *context,
2601 GTranslateFunc func,
2603 GDestroyNotify destroy_notify)
2605 g_return_if_fail (context != NULL);
2607 if (context->translate_notify)
2608 context->translate_notify (context->translate_data);
2610 context->translate_func = func;
2611 context->translate_data = data;
2612 context->translate_notify = destroy_notify;
2616 * g_option_context_set_translation_domain:
2617 * @context: a #GOptionContext
2618 * @domain: the domain to use
2620 * A convenience function to use gettext() for translating
2621 * user-visible strings.
2626 g_option_context_set_translation_domain (GOptionContext *context,
2627 const gchar *domain)
2629 g_return_if_fail (context != NULL);
2631 g_option_context_set_translate_func (context,
2632 (GTranslateFunc)dgettext_swapped,
2638 * g_option_context_set_summary:
2639 * @context: a #GOptionContext
2640 * @summary: (nullable): a string to be shown in `--help` output
2641 * before the list of options, or %NULL
2643 * Adds a string to be displayed in `--help` output before the list
2644 * of options. This is typically a summary of the program functionality.
2646 * Note that the summary is translated (see
2647 * g_option_context_set_translate_func() and
2648 * g_option_context_set_translation_domain()).
2653 g_option_context_set_summary (GOptionContext *context,
2654 const gchar *summary)
2656 g_return_if_fail (context != NULL);
2658 g_free (context->summary);
2659 context->summary = g_strdup (summary);
2664 * g_option_context_get_summary:
2665 * @context: a #GOptionContext
2667 * Returns the summary. See g_option_context_set_summary().
2669 * Returns: the summary
2674 g_option_context_get_summary (GOptionContext *context)
2676 g_return_val_if_fail (context != NULL, NULL);
2678 return context->summary;
2682 * g_option_context_set_description:
2683 * @context: a #GOptionContext
2684 * @description: (nullable): a string to be shown in `--help` output
2685 * after the list of options, or %NULL
2687 * Adds a string to be displayed in `--help` output after the list
2688 * of options. This text often includes a bug reporting address.
2690 * Note that the summary is translated (see
2691 * g_option_context_set_translate_func()).
2696 g_option_context_set_description (GOptionContext *context,
2697 const gchar *description)
2699 g_return_if_fail (context != NULL);
2701 g_free (context->description);
2702 context->description = g_strdup (description);
2707 * g_option_context_get_description:
2708 * @context: a #GOptionContext
2710 * Returns the description. See g_option_context_set_description().
2712 * Returns: the description
2717 g_option_context_get_description (GOptionContext *context)
2719 g_return_val_if_fail (context != NULL, NULL);
2721 return context->description;
2725 * g_option_context_parse_strv:
2726 * @context: a #GOptionContext
2727 * @arguments: (inout) (array null-terminated=1) (optional): a pointer
2728 * to the command line arguments (which must be in UTF-8 on Windows).
2729 * Starting with GLib 2.62, @arguments can be %NULL, which matches
2730 * g_option_context_parse().
2731 * @error: a return location for errors
2733 * Parses the command line arguments.
2735 * This function is similar to g_option_context_parse() except that it
2736 * respects the normal memory rules when dealing with a strv instead of
2737 * assuming that the passed-in array is the argv of the main function.
2739 * In particular, strings that are removed from the arguments list will
2740 * be freed using g_free().
2742 * On Windows, the strings are expected to be in UTF-8. This is in
2743 * contrast to g_option_context_parse() which expects them to be in the
2744 * system codepage, which is how they are passed as @argv to main().
2745 * See g_win32_get_command_line() for a solution.
2747 * This function is useful if you are trying to use #GOptionContext with
2750 * Returns: %TRUE if the parsing was successful,
2751 * %FALSE if an error occurred
2756 g_option_context_parse_strv (GOptionContext *context,
2763 g_return_val_if_fail (context != NULL, FALSE);
2765 context->strv_mode = TRUE;
2766 argc = arguments && *arguments ? g_strv_length (*arguments) : 0;
2767 success = g_option_context_parse (context, &argc, arguments, error);
2768 context->strv_mode = FALSE;