1 /* goption.c - Option parser
3 * Copyright (C) 1999, 2003 Red Hat Software
4 * Copyright (C) 2004 Anders Carlsson <andersca@gnome.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @Short_description: parses commandline options
25 * @Title: Commandline option parser
27 * The GOption commandline parser is intended to be a simpler replacement
28 * for the popt library. It supports short and long commandline options,
29 * as shown in the following example:
31 * <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal>
33 * The example demonstrates a number of features of the GOption
35 * <itemizedlist><listitem><para>
36 * Options can be single letters, prefixed by a single dash. Multiple
37 * short options can be grouped behind a single dash.
38 * </para></listitem><listitem><para>
39 * Long options are prefixed by two consecutive dashes.
40 * </para></listitem><listitem><para>
41 * Options can have an extra argument, which can be a number, a string or
42 * a filename. For long options, the extra argument can be appended with
43 * an equals sign after the option name, which is useful if the extra
44 * argument starts with a dash, which would otherwise cause it to be
45 * interpreted as another option.
46 * </para></listitem><listitem><para>
47 * Non-option arguments are returned to the application as rest arguments.
48 * </para></listitem><listitem><para>
49 * An argument consisting solely of two dashes turns off further parsing,
50 * any remaining arguments (even those starting with a dash) are returned
51 * to the application as rest arguments.
52 * </para></listitem></itemizedlist>
54 * Another important feature of GOption is that it can automatically
55 * generate nicely formatted help output. Unless it is explicitly turned
56 * off with g_option_context_set_help_enabled(), GOption will recognize
57 * the <option>--help</option>, <option>-?</option>,
58 * <option>--help-all</option> and
59 * <option>--help-</option><replaceable>groupname</replaceable> options
60 * (where <replaceable>groupname</replaceable> is the name of a
61 * #GOptionGroup) and write a text similar to the one shown in the
62 * following example to stdout.
64 * <informalexample><screen>
66 * testtreemodel [OPTION...] - test tree model performance
69 * -h, --help Show help options
70 * --help-all Show all help options
71 * --help-gtk Show GTK+ Options
73 * Application Options:
74 * -r, --repeats=N Average over N repetitions
75 * -m, --max-size=M Test up to 2^M items
76 * --display=DISPLAY X display to use
77 * -v, --verbose Be verbose
78 * -b, --beep Beep when done
79 * --rand Randomize the data
80 * </screen></informalexample>
82 * GOption groups options in #GOptionGroup<!-- -->s, which makes it easy to
83 * incorporate options from multiple sources. The intended use for this is
84 * to let applications collect option groups from the libraries it uses,
85 * add them to their #GOptionContext, and parse all options by a single call
86 * to g_option_context_parse(). See gtk_get_option_group() for an example.
88 * If an option is declared to be of type string or filename, GOption takes
89 * care of converting it to the right encoding; strings are returned in
90 * UTF-8, filenames are returned in the GLib filename encoding. Note that
91 * this only works if setlocale() has been called before
92 * g_option_context_parse().
94 * Here is a complete example of setting up GOption to parse the example
95 * commandline above and produce the example help output.
97 * <informalexample><programlisting>
98 * static gint repeats = 2;
99 * static gint max_size = 8;
100 * static gboolean verbose = FALSE;
101 * static gboolean beep = FALSE;
102 * static gboolean rand = FALSE;
104 * static GOptionEntry entries[] =
106 * { "repeats", 'r', 0, G_OPTION_ARG_INT, &repeats, "Average over N repetitions", "N" },
107 * { "max-size", 'm', 0, G_OPTION_ARG_INT, &max_size, "Test up to 2^M items", "M" },
108 * { "verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose, "Be verbose", NULL },
109 * { "beep", 'b', 0, G_OPTION_ARG_NONE, &beep, "Beep when done", NULL },
110 * { "rand", 0, 0, G_OPTION_ARG_NONE, &rand, "Randomize the data", NULL },
115 * main (int argc, char *argv[])
117 * GError *error = NULL;
118 * GOptionContext *context;
120 * context = g_option_context_new ("- test tree model performance");
121 * g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
122 * g_option_context_add_group (context, gtk_get_option_group (TRUE));
123 * if (!g_option_context_parse (context, &argc, &argv, &error))
125 * g_print ("option parsing failed: %s\n", error->message);
132 * </programlisting></informalexample>
142 #if defined __OpenBSD__
143 #include <sys/types.h>
145 #include <sys/param.h>
146 #include <sys/sysctl.h>
152 #include "glibintl.h"
154 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
156 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
157 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
158 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
160 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
161 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
193 struct _GOptionContext
197 gchar
*parameter_string
;
201 GTranslateFunc translate_func
;
202 GDestroyNotify translate_notify
;
203 gpointer translate_data
;
205 guint help_enabled
: 1;
206 guint ignore_unknown
: 1;
208 GOptionGroup
*main_group
;
210 /* We keep a list of change so we can revert them */
213 /* We also keep track of all argv elements
214 * that should be NULLed or modified.
216 GList
*pending_nulls
;
223 gchar
*help_description
;
225 GDestroyNotify destroy_notify
;
228 GTranslateFunc translate_func
;
229 GDestroyNotify translate_notify
;
230 gpointer translate_data
;
232 GOptionEntry
*entries
;
235 GOptionParseFunc pre_parse_func
;
236 GOptionParseFunc post_parse_func
;
237 GOptionErrorFunc error_func
;
240 static void free_changes_list (GOptionContext
*context
,
242 static void free_pending_nulls (GOptionContext
*context
,
243 gboolean perform_nulls
);
247 _g_unichar_get_width (gunichar c
)
249 if (G_UNLIKELY (g_unichar_iszerowidth (c
)))
252 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
253 * some locales (legacy East Asian ones) */
254 if (g_unichar_iswide (c
))
261 _g_utf8_strwidth (const gchar
*p
)
264 g_return_val_if_fail (p
!= NULL
, 0);
268 len
+= _g_unichar_get_width (g_utf8_get_char (p
));
269 p
= g_utf8_next_char (p
);
275 G_DEFINE_QUARK (g
-option
-context
-error
-quark
, g_option_error
)
278 * g_option_context_new:
279 * @parameter_string: (allow-none): a string which is displayed in
280 * the first line of <option>--help</option> output, after the
282 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
284 * Creates a new option context.
286 * The @parameter_string can serve multiple purposes. It can be used
287 * to add descriptions for "rest" arguments, which are not parsed by
288 * the #GOptionContext, typically something like "FILES" or
289 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
290 * collecting "rest" arguments, GLib handles this automatically by
291 * using the @arg_description of the corresponding #GOptionEntry in
294 * Another usage is to give a short summary of the program
295 * functionality, like " - frob the strings", which will be displayed
296 * in the same line as the usage. For a longer description of the
297 * program functionality that should be displayed as a paragraph
298 * below the usage line, use g_option_context_set_summary().
300 * Note that the @parameter_string is translated using the
301 * function set with g_option_context_set_translate_func(), so
302 * it should normally be passed untranslated.
304 * Returns: a newly created #GOptionContext, which must be
305 * freed with g_option_context_free() after use.
310 g_option_context_new (const gchar
*parameter_string
)
313 GOptionContext
*context
;
315 context
= g_new0 (GOptionContext
, 1);
317 context
->parameter_string
= g_strdup (parameter_string
);
318 context
->help_enabled
= TRUE
;
319 context
->ignore_unknown
= FALSE
;
325 * g_option_context_free:
326 * @context: a #GOptionContext
328 * Frees context and all the groups which have been
331 * Please note that parsed arguments need to be freed separately (see
336 void g_option_context_free (GOptionContext
*context
)
338 g_return_if_fail (context
!= NULL
);
340 g_list_free_full (context
->groups
, (GDestroyNotify
) g_option_group_free
);
342 if (context
->main_group
)
343 g_option_group_free (context
->main_group
);
345 free_changes_list (context
, FALSE
);
346 free_pending_nulls (context
, FALSE
);
348 g_free (context
->parameter_string
);
349 g_free (context
->summary
);
350 g_free (context
->description
);
352 if (context
->translate_notify
)
353 (* context
->translate_notify
) (context
->translate_data
);
360 * g_option_context_set_help_enabled:
361 * @context: a #GOptionContext
362 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
364 * Enables or disables automatic generation of <option>--help</option>
365 * output. By default, g_option_context_parse() recognizes
366 * <option>--help</option>, <option>-h</option>,
367 * <option>-?</option>, <option>--help-all</option>
368 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
369 * suitable output to stdout.
373 void g_option_context_set_help_enabled (GOptionContext
*context
,
374 gboolean help_enabled
)
377 g_return_if_fail (context
!= NULL
);
379 context
->help_enabled
= help_enabled
;
383 * g_option_context_get_help_enabled:
384 * @context: a #GOptionContext
386 * Returns whether automatic <option>--help</option> generation
387 * is turned on for @context. See g_option_context_set_help_enabled().
389 * Returns: %TRUE if automatic help generation is turned on.
394 g_option_context_get_help_enabled (GOptionContext
*context
)
396 g_return_val_if_fail (context
!= NULL
, FALSE
);
398 return context
->help_enabled
;
402 * g_option_context_set_ignore_unknown_options:
403 * @context: a #GOptionContext
404 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
405 * an error when unknown options are met
407 * Sets whether to ignore unknown options or not. If an argument is
408 * ignored, it is left in the @argv array after parsing. By default,
409 * g_option_context_parse() treats unknown options as error.
411 * This setting does not affect non-option arguments (i.e. arguments
412 * which don't start with a dash). But note that GOption cannot reliably
413 * determine whether a non-option belongs to a preceding unknown option.
418 g_option_context_set_ignore_unknown_options (GOptionContext
*context
,
419 gboolean ignore_unknown
)
421 g_return_if_fail (context
!= NULL
);
423 context
->ignore_unknown
= ignore_unknown
;
427 * g_option_context_get_ignore_unknown_options:
428 * @context: a #GOptionContext
430 * Returns whether unknown options are ignored or not. See
431 * g_option_context_set_ignore_unknown_options().
433 * Returns: %TRUE if unknown options are ignored.
438 g_option_context_get_ignore_unknown_options (GOptionContext
*context
)
440 g_return_val_if_fail (context
!= NULL
, FALSE
);
442 return context
->ignore_unknown
;
446 * g_option_context_add_group:
447 * @context: a #GOptionContext
448 * @group: the group to add
450 * Adds a #GOptionGroup to the @context, so that parsing with @context
451 * will recognize the options in the group. Note that the group will
452 * be freed together with the context when g_option_context_free() is
453 * called, so you must not free the group yourself after adding it
459 g_option_context_add_group (GOptionContext
*context
,
464 g_return_if_fail (context
!= NULL
);
465 g_return_if_fail (group
!= NULL
);
466 g_return_if_fail (group
->name
!= NULL
);
467 g_return_if_fail (group
->description
!= NULL
);
468 g_return_if_fail (group
->help_description
!= NULL
);
470 for (list
= context
->groups
; list
; list
= list
->next
)
472 GOptionGroup
*g
= (GOptionGroup
*)list
->data
;
474 if ((group
->name
== NULL
&& g
->name
== NULL
) ||
475 (group
->name
&& g
->name
&& strcmp (group
->name
, g
->name
) == 0))
476 g_warning ("A group named \"%s\" is already part of this GOptionContext",
480 context
->groups
= g_list_append (context
->groups
, group
);
484 * g_option_context_set_main_group:
485 * @context: a #GOptionContext
486 * @group: the group to set as main group
488 * Sets a #GOptionGroup as main group of the @context.
489 * This has the same effect as calling g_option_context_add_group(),
490 * the only difference is that the options in the main group are
491 * treated differently when generating <option>--help</option> output.
496 g_option_context_set_main_group (GOptionContext
*context
,
499 g_return_if_fail (context
!= NULL
);
500 g_return_if_fail (group
!= NULL
);
502 if (context
->main_group
)
504 g_warning ("This GOptionContext already has a main group");
509 context
->main_group
= group
;
513 * g_option_context_get_main_group:
514 * @context: a #GOptionContext
516 * Returns a pointer to the main group of @context.
518 * Return value: the main group of @context, or %NULL if @context doesn't
519 * have a main group. Note that group belongs to @context and should
520 * not be modified or freed.
525 g_option_context_get_main_group (GOptionContext
*context
)
527 g_return_val_if_fail (context
!= NULL
, NULL
);
529 return context
->main_group
;
533 * g_option_context_add_main_entries:
534 * @context: a #GOptionContext
535 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
536 * @translation_domain: (allow-none): a translation domain to use for translating
537 * the <option>--help</option> output for the options in @entries
538 * with gettext(), or %NULL
540 * A convenience function which creates a main group if it doesn't
541 * exist, adds the @entries to it and sets the translation domain.
546 g_option_context_add_main_entries (GOptionContext
*context
,
547 const GOptionEntry
*entries
,
548 const gchar
*translation_domain
)
550 g_return_if_fail (entries
!= NULL
);
552 if (!context
->main_group
)
553 context
->main_group
= g_option_group_new (NULL
, NULL
, NULL
, NULL
, NULL
);
555 g_option_group_add_entries (context
->main_group
, entries
);
556 g_option_group_set_translation_domain (context
->main_group
, translation_domain
);
560 calculate_max_length (GOptionGroup
*group
,
564 gint i
, len
, max_length
;
565 const gchar
*long_name
;
569 for (i
= 0; i
< group
->n_entries
; i
++)
571 entry
= &group
->entries
[i
];
573 if (entry
->flags
& G_OPTION_FLAG_HIDDEN
)
576 long_name
= g_hash_table_lookup (aliases
, &entry
->long_name
);
578 long_name
= entry
->long_name
;
579 len
= _g_utf8_strwidth (long_name
);
581 if (entry
->short_name
)
584 if (!NO_ARG (entry
) && entry
->arg_description
)
585 len
+= 1 + _g_utf8_strwidth (TRANSLATE (group
, entry
->arg_description
));
587 max_length
= MAX (max_length
, len
);
594 print_entry (GOptionGroup
*group
,
596 const GOptionEntry
*entry
,
601 const gchar
*long_name
;
603 if (entry
->flags
& G_OPTION_FLAG_HIDDEN
)
606 if (entry
->long_name
[0] == 0)
609 long_name
= g_hash_table_lookup (aliases
, &entry
->long_name
);
611 long_name
= entry
->long_name
;
613 str
= g_string_new (NULL
);
615 if (entry
->short_name
)
616 g_string_append_printf (str
, " -%c, --%s", entry
->short_name
, long_name
);
618 g_string_append_printf (str
, " --%s", long_name
);
620 if (entry
->arg_description
)
621 g_string_append_printf (str
, "=%s", TRANSLATE (group
, entry
->arg_description
));
623 g_string_append_printf (string
, "%s%*s %s\n", str
->str
,
624 (int) (max_length
+ 4 - _g_utf8_strwidth (str
->str
)), "",
625 entry
->description
? TRANSLATE (group
, entry
->description
) : "");
626 g_string_free (str
, TRUE
);
630 group_has_visible_entries (GOptionContext
*context
,
632 gboolean main_entries
)
634 GOptionFlags reject_filter
= G_OPTION_FLAG_HIDDEN
;
637 gboolean main_group
= group
== context
->main_group
;
640 reject_filter
|= G_OPTION_FLAG_IN_MAIN
;
642 for (i
= 0, l
= (group
? group
->n_entries
: 0); i
< l
; i
++)
644 entry
= &group
->entries
[i
];
646 if (main_entries
&& !main_group
&& !(entry
->flags
& G_OPTION_FLAG_IN_MAIN
))
648 if (entry
->long_name
[0] == 0) /* ignore rest entry */
650 if (!(entry
->flags
& reject_filter
))
658 group_list_has_visible_entries (GOptionContext
*context
,
660 gboolean main_entries
)
664 if (group_has_visible_entries (context
, group_list
->data
, main_entries
))
667 group_list
= group_list
->next
;
674 context_has_h_entry (GOptionContext
*context
)
679 if (context
->main_group
)
681 for (i
= 0; i
< context
->main_group
->n_entries
; i
++)
683 if (context
->main_group
->entries
[i
].short_name
== 'h')
688 for (list
= context
->groups
; list
!= NULL
; list
= g_list_next (list
))
692 group
= (GOptionGroup
*)list
->data
;
693 for (i
= 0; i
< group
->n_entries
; i
++)
695 if (group
->entries
[i
].short_name
== 'h')
703 * g_option_context_get_help:
704 * @context: a #GOptionContext
705 * @main_help: if %TRUE, only include the main group
706 * @group: (allow-none): the #GOptionGroup to create help for, or %NULL
708 * Returns a formatted, translated help text for the given context.
709 * To obtain the text produced by <option>--help</option>, call
710 * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
711 * To obtain the text produced by <option>--help-all</option>, call
712 * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
713 * To obtain the help text for an option group, call
714 * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
716 * Returns: A newly allocated string containing the help text
721 g_option_context_get_help (GOptionContext
*context
,
726 gint max_length
= 0, len
;
729 GHashTable
*shadow_map
;
732 const gchar
*rest_description
;
736 string
= g_string_sized_new (1024);
738 rest_description
= NULL
;
739 if (context
->main_group
)
742 for (i
= 0; i
< context
->main_group
->n_entries
; i
++)
744 entry
= &context
->main_group
->entries
[i
];
745 if (entry
->long_name
[0] == 0)
747 rest_description
= TRANSLATE (context
->main_group
, entry
->arg_description
);
753 g_string_append_printf (string
, "%s\n %s %s",
754 _("Usage:"), g_get_prgname(), _("[OPTION...]"));
756 if (rest_description
)
758 g_string_append (string
, " ");
759 g_string_append (string
, rest_description
);
762 if (context
->parameter_string
)
764 g_string_append (string
, " ");
765 g_string_append (string
, TRANSLATE (context
, context
->parameter_string
));
768 g_string_append (string
, "\n\n");
770 if (context
->summary
)
772 g_string_append (string
, TRANSLATE (context
, context
->summary
));
773 g_string_append (string
, "\n\n");
776 memset (seen
, 0, sizeof (gboolean
) * 256);
777 shadow_map
= g_hash_table_new (g_str_hash
, g_str_equal
);
778 aliases
= g_hash_table_new_full (NULL
, NULL
, NULL
, g_free
);
780 if (context
->main_group
)
782 for (i
= 0; i
< context
->main_group
->n_entries
; i
++)
784 entry
= &context
->main_group
->entries
[i
];
785 g_hash_table_insert (shadow_map
,
786 (gpointer
)entry
->long_name
,
789 if (seen
[(guchar
)entry
->short_name
])
790 entry
->short_name
= 0;
792 seen
[(guchar
)entry
->short_name
] = TRUE
;
796 list
= context
->groups
;
799 GOptionGroup
*g
= list
->data
;
800 for (i
= 0; i
< g
->n_entries
; i
++)
802 entry
= &g
->entries
[i
];
803 if (g_hash_table_lookup (shadow_map
, entry
->long_name
) &&
804 !(entry
->flags
& G_OPTION_FLAG_NOALIAS
))
806 g_hash_table_insert (aliases
, &entry
->long_name
,
807 g_strdup_printf ("%s-%s", g
->name
, entry
->long_name
));
810 g_hash_table_insert (shadow_map
, (gpointer
)entry
->long_name
, entry
);
812 if (seen
[(guchar
)entry
->short_name
] &&
813 !(entry
->flags
& G_OPTION_FLAG_NOALIAS
))
814 entry
->short_name
= 0;
816 seen
[(guchar
)entry
->short_name
] = TRUE
;
821 g_hash_table_destroy (shadow_map
);
823 list
= context
->groups
;
825 if (context
->help_enabled
)
827 max_length
= _g_utf8_strwidth ("-?, --help");
831 len
= _g_utf8_strwidth ("--help-all");
832 max_length
= MAX (max_length
, len
);
836 if (context
->main_group
)
838 len
= calculate_max_length (context
->main_group
, aliases
);
839 max_length
= MAX (max_length
, len
);
844 GOptionGroup
*g
= list
->data
;
846 if (context
->help_enabled
)
848 /* First, we check the --help-<groupname> options */
849 len
= _g_utf8_strwidth ("--help-") + _g_utf8_strwidth (g
->name
);
850 max_length
= MAX (max_length
, len
);
853 /* Then we go through the entries */
854 len
= calculate_max_length (g
, aliases
);
855 max_length
= MAX (max_length
, len
);
860 /* Add a bit of padding */
863 if (!group
&& context
->help_enabled
)
865 list
= context
->groups
;
867 token
= context_has_h_entry (context
) ? '?' : 'h';
869 g_string_append_printf (string
, "%s\n -%c, --%-*s %s\n",
870 _("Help Options:"), token
, max_length
- 4, "help",
871 _("Show help options"));
873 /* We only want --help-all when there are groups */
875 g_string_append_printf (string
, " --%-*s %s\n",
876 max_length
, "help-all",
877 _("Show all help options"));
881 GOptionGroup
*g
= list
->data
;
883 if (group_has_visible_entries (context
, g
, FALSE
))
884 g_string_append_printf (string
, " --help-%-*s %s\n",
885 max_length
- 5, g
->name
,
886 TRANSLATE (g
, g
->help_description
));
891 g_string_append (string
, "\n");
896 /* Print a certain group */
898 if (group_has_visible_entries (context
, group
, FALSE
))
900 g_string_append (string
, TRANSLATE (group
, group
->description
));
901 g_string_append (string
, "\n");
902 for (i
= 0; i
< group
->n_entries
; i
++)
903 print_entry (group
, max_length
, &group
->entries
[i
], string
, aliases
);
904 g_string_append (string
, "\n");
909 /* Print all groups */
911 list
= context
->groups
;
915 GOptionGroup
*g
= list
->data
;
917 if (group_has_visible_entries (context
, g
, FALSE
))
919 g_string_append (string
, g
->description
);
920 g_string_append (string
, "\n");
921 for (i
= 0; i
< g
->n_entries
; i
++)
922 if (!(g
->entries
[i
].flags
& G_OPTION_FLAG_IN_MAIN
))
923 print_entry (g
, max_length
, &g
->entries
[i
], string
, aliases
);
925 g_string_append (string
, "\n");
932 /* Print application options if --help or --help-all has been specified */
933 if ((main_help
|| !group
) &&
934 (group_has_visible_entries (context
, context
->main_group
, TRUE
) ||
935 group_list_has_visible_entries (context
, context
->groups
, TRUE
)))
937 list
= context
->groups
;
939 g_string_append (string
, _("Application Options:"));
940 g_string_append (string
, "\n");
941 if (context
->main_group
)
942 for (i
= 0; i
< context
->main_group
->n_entries
; i
++)
943 print_entry (context
->main_group
, max_length
,
944 &context
->main_group
->entries
[i
], string
, aliases
);
948 GOptionGroup
*g
= list
->data
;
950 /* Print main entries from other groups */
951 for (i
= 0; i
< g
->n_entries
; i
++)
952 if (g
->entries
[i
].flags
& G_OPTION_FLAG_IN_MAIN
)
953 print_entry (g
, max_length
, &g
->entries
[i
], string
, aliases
);
958 g_string_append (string
, "\n");
961 if (context
->description
)
963 g_string_append (string
, TRANSLATE (context
, context
->description
));
964 g_string_append (string
, "\n");
967 g_hash_table_destroy (aliases
);
969 return g_string_free (string
, FALSE
);
974 print_help (GOptionContext
*context
,
980 help
= g_option_context_get_help (context
, main_help
, group
);
981 g_print ("%s", help
);
988 parse_int (const gchar
*arg_name
,
997 tmp
= strtol (arg
, &end
, 0);
999 if (*arg
== '\0' || *end
!= '\0')
1002 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1003 _("Cannot parse integer value '%s' for %s"),
1009 if (*result
!= tmp
|| errno
== ERANGE
)
1012 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1013 _("Integer value '%s' for %s out of range"),
1023 parse_double (const gchar
*arg_name
,
1032 tmp
= g_strtod (arg
, &end
);
1034 if (*arg
== '\0' || *end
!= '\0')
1037 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1038 _("Cannot parse double value '%s' for %s"),
1042 if (errno
== ERANGE
)
1045 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1046 _("Double value '%s' for %s out of range"),
1058 parse_int64 (const gchar
*arg_name
,
1067 tmp
= g_ascii_strtoll (arg
, &end
, 0);
1069 if (*arg
== '\0' || *end
!= '\0')
1072 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1073 _("Cannot parse integer value '%s' for %s"),
1077 if (errno
== ERANGE
)
1080 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1081 _("Integer value '%s' for %s out of range"),
1093 get_change (GOptionContext
*context
,
1094 GOptionArg arg_type
,
1098 Change
*change
= NULL
;
1100 for (list
= context
->changes
; list
!= NULL
; list
= list
->next
)
1102 change
= list
->data
;
1104 if (change
->arg_data
== arg_data
)
1108 change
= g_new0 (Change
, 1);
1109 change
->arg_type
= arg_type
;
1110 change
->arg_data
= arg_data
;
1112 context
->changes
= g_list_prepend (context
->changes
, change
);
1120 add_pending_null (GOptionContext
*context
,
1126 n
= g_new0 (PendingNull
, 1);
1130 context
->pending_nulls
= g_list_prepend (context
->pending_nulls
, n
);
1134 parse_arg (GOptionContext
*context
,
1135 GOptionGroup
*group
,
1136 GOptionEntry
*entry
,
1138 const gchar
*option_name
,
1144 g_assert (value
|| OPTIONAL_ARG (entry
) || NO_ARG (entry
));
1148 case G_OPTION_ARG_NONE
:
1150 change
= get_change (context
, G_OPTION_ARG_NONE
,
1153 *(gboolean
*)entry
->arg_data
= !(entry
->flags
& G_OPTION_FLAG_REVERSE
);
1156 case G_OPTION_ARG_STRING
:
1160 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1165 change
= get_change (context
, G_OPTION_ARG_STRING
,
1167 g_free (change
->allocated
.str
);
1169 change
->prev
.str
= *(gchar
**)entry
->arg_data
;
1170 change
->allocated
.str
= data
;
1172 *(gchar
**)entry
->arg_data
= data
;
1175 case G_OPTION_ARG_STRING_ARRAY
:
1179 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1184 change
= get_change (context
, G_OPTION_ARG_STRING_ARRAY
,
1187 if (change
->allocated
.array
.len
== 0)
1189 change
->prev
.array
= *(gchar
***)entry
->arg_data
;
1190 change
->allocated
.array
.data
= g_new (gchar
*, 2);
1193 change
->allocated
.array
.data
=
1194 g_renew (gchar
*, change
->allocated
.array
.data
,
1195 change
->allocated
.array
.len
+ 2);
1197 change
->allocated
.array
.data
[change
->allocated
.array
.len
] = data
;
1198 change
->allocated
.array
.data
[change
->allocated
.array
.len
+ 1] = NULL
;
1200 change
->allocated
.array
.len
++;
1202 *(gchar
***)entry
->arg_data
= change
->allocated
.array
.data
;
1207 case G_OPTION_ARG_FILENAME
:
1212 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1217 data
= g_strdup (value
);
1219 change
= get_change (context
, G_OPTION_ARG_FILENAME
,
1221 g_free (change
->allocated
.str
);
1223 change
->prev
.str
= *(gchar
**)entry
->arg_data
;
1224 change
->allocated
.str
= data
;
1226 *(gchar
**)entry
->arg_data
= data
;
1230 case G_OPTION_ARG_FILENAME_ARRAY
:
1235 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1240 data
= g_strdup (value
);
1242 change
= get_change (context
, G_OPTION_ARG_STRING_ARRAY
,
1245 if (change
->allocated
.array
.len
== 0)
1247 change
->prev
.array
= *(gchar
***)entry
->arg_data
;
1248 change
->allocated
.array
.data
= g_new (gchar
*, 2);
1251 change
->allocated
.array
.data
=
1252 g_renew (gchar
*, change
->allocated
.array
.data
,
1253 change
->allocated
.array
.len
+ 2);
1255 change
->allocated
.array
.data
[change
->allocated
.array
.len
] = data
;
1256 change
->allocated
.array
.data
[change
->allocated
.array
.len
+ 1] = NULL
;
1258 change
->allocated
.array
.len
++;
1260 *(gchar
***)entry
->arg_data
= change
->allocated
.array
.data
;
1265 case G_OPTION_ARG_INT
:
1269 if (!parse_int (option_name
, value
,
1274 change
= get_change (context
, G_OPTION_ARG_INT
,
1276 change
->prev
.integer
= *(gint
*)entry
->arg_data
;
1277 *(gint
*)entry
->arg_data
= data
;
1280 case G_OPTION_ARG_CALLBACK
:
1285 if (!value
&& entry
->flags
& G_OPTION_FLAG_OPTIONAL_ARG
)
1287 else if (entry
->flags
& G_OPTION_FLAG_NO_ARG
)
1289 else if (entry
->flags
& G_OPTION_FLAG_FILENAME
)
1292 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1294 data
= g_strdup (value
);
1298 data
= g_locale_to_utf8 (value
, -1, NULL
, NULL
, error
);
1300 if (!(entry
->flags
& (G_OPTION_FLAG_NO_ARG
|G_OPTION_FLAG_OPTIONAL_ARG
)) &&
1304 retval
= (* (GOptionArgFunc
) entry
->arg_data
) (option_name
, data
, group
->user_data
, error
);
1306 if (!retval
&& error
!= NULL
&& *error
== NULL
)
1308 G_OPTION_ERROR
, G_OPTION_ERROR_FAILED
,
1309 _("Error parsing option %s"), option_name
);
1317 case G_OPTION_ARG_DOUBLE
:
1321 if (!parse_double (option_name
, value
,
1328 change
= get_change (context
, G_OPTION_ARG_DOUBLE
,
1330 change
->prev
.dbl
= *(gdouble
*)entry
->arg_data
;
1331 *(gdouble
*)entry
->arg_data
= data
;
1334 case G_OPTION_ARG_INT64
:
1338 if (!parse_int64 (option_name
, value
,
1345 change
= get_change (context
, G_OPTION_ARG_INT64
,
1347 change
->prev
.int64
= *(gint64
*)entry
->arg_data
;
1348 *(gint64
*)entry
->arg_data
= data
;
1352 g_assert_not_reached ();
1359 parse_short_option (GOptionContext
*context
,
1360 GOptionGroup
*group
,
1371 for (j
= 0; j
< group
->n_entries
; j
++)
1373 if (arg
== group
->entries
[j
].short_name
)
1376 gchar
*value
= NULL
;
1378 option_name
= g_strdup_printf ("-%c", group
->entries
[j
].short_name
);
1380 if (NO_ARG (&group
->entries
[j
]))
1387 G_OPTION_ERROR
, G_OPTION_ERROR_FAILED
,
1388 _("Error parsing option %s"), option_name
);
1389 g_free (option_name
);
1393 if (idx
< *argc
- 1)
1395 if (!OPTIONAL_ARG (&group
->entries
[j
]))
1397 value
= (*argv
)[idx
+ 1];
1398 add_pending_null (context
, &((*argv
)[idx
+ 1]), NULL
);
1403 if ((*argv
)[idx
+ 1][0] == '-')
1407 value
= (*argv
)[idx
+ 1];
1408 add_pending_null (context
, &((*argv
)[idx
+ 1]), NULL
);
1413 else if (idx
>= *argc
- 1 && OPTIONAL_ARG (&group
->entries
[j
]))
1418 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1419 _("Missing argument for %s"), option_name
);
1420 g_free (option_name
);
1425 if (!parse_arg (context
, group
, &group
->entries
[j
],
1426 value
, option_name
, error
))
1428 g_free (option_name
);
1432 g_free (option_name
);
1441 parse_long_option (GOptionContext
*context
,
1442 GOptionGroup
*group
,
1453 for (j
= 0; j
< group
->n_entries
; j
++)
1458 if (aliased
&& (group
->entries
[j
].flags
& G_OPTION_FLAG_NOALIAS
))
1461 if (NO_ARG (&group
->entries
[j
]) &&
1462 strcmp (arg
, group
->entries
[j
].long_name
) == 0)
1467 option_name
= g_strconcat ("--", group
->entries
[j
].long_name
, NULL
);
1468 retval
= parse_arg (context
, group
, &group
->entries
[j
],
1469 NULL
, option_name
, error
);
1470 g_free (option_name
);
1472 add_pending_null (context
, &((*argv
)[*idx
]), NULL
);
1479 gint len
= strlen (group
->entries
[j
].long_name
);
1481 if (strncmp (arg
, group
->entries
[j
].long_name
, len
) == 0 &&
1482 (arg
[len
] == '=' || arg
[len
] == 0))
1484 gchar
*value
= NULL
;
1487 add_pending_null (context
, &((*argv
)[*idx
]), NULL
);
1488 option_name
= g_strconcat ("--", group
->entries
[j
].long_name
, NULL
);
1490 if (arg
[len
] == '=')
1491 value
= arg
+ len
+ 1;
1492 else if (*idx
< *argc
- 1)
1494 if (!OPTIONAL_ARG (&group
->entries
[j
]))
1496 value
= (*argv
)[*idx
+ 1];
1497 add_pending_null (context
, &((*argv
)[*idx
+ 1]), NULL
);
1502 if ((*argv
)[*idx
+ 1][0] == '-')
1505 retval
= parse_arg (context
, group
, &group
->entries
[j
],
1506 NULL
, option_name
, error
);
1508 g_free (option_name
);
1513 value
= (*argv
)[*idx
+ 1];
1514 add_pending_null (context
, &((*argv
)[*idx
+ 1]), NULL
);
1519 else if (*idx
>= *argc
- 1 && OPTIONAL_ARG (&group
->entries
[j
]))
1522 retval
= parse_arg (context
, group
, &group
->entries
[j
],
1523 NULL
, option_name
, error
);
1525 g_free (option_name
);
1531 G_OPTION_ERROR
, G_OPTION_ERROR_BAD_VALUE
,
1532 _("Missing argument for %s"), option_name
);
1533 g_free (option_name
);
1537 if (!parse_arg (context
, group
, &group
->entries
[j
],
1538 value
, option_name
, error
))
1540 g_free (option_name
);
1544 g_free (option_name
);
1554 parse_remaining_arg (GOptionContext
*context
,
1555 GOptionGroup
*group
,
1564 for (j
= 0; j
< group
->n_entries
; j
++)
1569 if (group
->entries
[j
].long_name
[0])
1572 g_return_val_if_fail (group
->entries
[j
].arg
== G_OPTION_ARG_CALLBACK
||
1573 group
->entries
[j
].arg
== G_OPTION_ARG_STRING_ARRAY
||
1574 group
->entries
[j
].arg
== G_OPTION_ARG_FILENAME_ARRAY
, FALSE
);
1576 add_pending_null (context
, &((*argv
)[*idx
]), NULL
);
1578 if (!parse_arg (context
, group
, &group
->entries
[j
], (*argv
)[*idx
], "", error
))
1589 free_changes_list (GOptionContext
*context
,
1594 for (list
= context
->changes
; list
!= NULL
; list
= list
->next
)
1596 Change
*change
= list
->data
;
1600 switch (change
->arg_type
)
1602 case G_OPTION_ARG_NONE
:
1603 *(gboolean
*)change
->arg_data
= change
->prev
.bool;
1605 case G_OPTION_ARG_INT
:
1606 *(gint
*)change
->arg_data
= change
->prev
.integer
;
1608 case G_OPTION_ARG_STRING
:
1609 case G_OPTION_ARG_FILENAME
:
1610 g_free (change
->allocated
.str
);
1611 *(gchar
**)change
->arg_data
= change
->prev
.str
;
1613 case G_OPTION_ARG_STRING_ARRAY
:
1614 case G_OPTION_ARG_FILENAME_ARRAY
:
1615 g_strfreev (change
->allocated
.array
.data
);
1616 *(gchar
***)change
->arg_data
= change
->prev
.array
;
1618 case G_OPTION_ARG_DOUBLE
:
1619 *(gdouble
*)change
->arg_data
= change
->prev
.dbl
;
1621 case G_OPTION_ARG_INT64
:
1622 *(gint64
*)change
->arg_data
= change
->prev
.int64
;
1625 g_assert_not_reached ();
1632 g_list_free (context
->changes
);
1633 context
->changes
= NULL
;
1637 free_pending_nulls (GOptionContext
*context
,
1638 gboolean perform_nulls
)
1642 for (list
= context
->pending_nulls
; list
!= NULL
; list
= list
->next
)
1644 PendingNull
*n
= list
->data
;
1650 /* Copy back the short options */
1652 strcpy (*n
->ptr
+ 1, n
->value
);
1662 g_list_free (context
->pending_nulls
);
1663 context
->pending_nulls
= NULL
;
1666 /* Use a platform-specific mechanism to look up the first argument to
1667 * the current process.
1668 * Note if you implement this for other platforms, also add it to
1669 * tests/option-argv0.c
1672 platform_get_argv0 (void)
1679 if (!g_file_get_contents ("/proc/self/cmdline",
1684 /* Sanity check for a NUL terminator. */
1685 if (!memchr (cmdline
, 0, len
))
1687 /* We could just return cmdline, but I think it's better
1688 * to hold on to a smaller malloc block; the arguments
1691 base_arg0
= g_path_get_basename (cmdline
);
1694 #elif defined __OpenBSD__
1695 char **cmdline
= NULL
;
1697 gsize len
= PATH_MAX
;
1699 int mib
[] = { CTL_KERN
, KERN_PROC_ARGS
, getpid(), KERN_PROC_ARGV
};
1701 cmdline
= (char **) realloc (cmdline
, len
);
1703 if (sysctl (mib
, G_N_ELEMENTS (mib
), cmdline
, &len
, NULL
, 0) == -1)
1709 /* We could just return cmdline, but I think it's better
1710 * to hold on to a smaller malloc block; the arguments
1713 base_arg0
= g_path_get_basename (*cmdline
);
1722 * g_option_context_parse:
1723 * @context: a #GOptionContext
1724 * @argc: (inout) (allow-none): a pointer to the number of command line arguments
1725 * @argv: (inout) (array length=argc) (allow-none): a pointer to the array of command line arguments
1726 * @error: a return location for errors
1728 * Parses the command line arguments, recognizing options
1729 * which have been added to @context. A side-effect of
1730 * calling this function is that g_set_prgname() will be
1733 * If the parsing is successful, any parsed arguments are
1734 * removed from the array and @argc and @argv are updated
1735 * accordingly. A '--' option is stripped from @argv
1736 * unless there are unparsed options before and after it,
1737 * or some of the options after it start with '-'. In case
1738 * of an error, @argc and @argv are left unmodified.
1740 * If automatic <option>--help</option> support is enabled
1741 * (see g_option_context_set_help_enabled()), and the
1742 * @argv array contains one of the recognized help options,
1743 * this function will produce help output to stdout and
1744 * call <literal>exit (0)</literal>.
1746 * Note that function depends on the
1747 * <link linkend="setlocale">current locale</link> for
1748 * automatic character set conversion of string and filename
1751 * Return value: %TRUE if the parsing was successful,
1752 * %FALSE if an error occurred
1757 g_option_context_parse (GOptionContext
*context
,
1765 /* Set program name */
1766 if (!g_get_prgname())
1770 if (argc
&& argv
&& *argc
)
1771 prgname
= g_path_get_basename ((*argv
)[0]);
1773 prgname
= platform_get_argv0 ();
1776 g_set_prgname (prgname
);
1778 g_set_prgname ("<unknown>");
1783 /* Call pre-parse hooks */
1784 list
= context
->groups
;
1787 GOptionGroup
*group
= list
->data
;
1789 if (group
->pre_parse_func
)
1791 if (!(* group
->pre_parse_func
) (context
, group
,
1792 group
->user_data
, error
))
1799 if (context
->main_group
&& context
->main_group
->pre_parse_func
)
1801 if (!(* context
->main_group
->pre_parse_func
) (context
, context
->main_group
,
1802 context
->main_group
->user_data
, error
))
1808 gboolean stop_parsing
= FALSE
;
1809 gboolean has_unknown
= FALSE
;
1810 gint separator_pos
= 0;
1812 for (i
= 1; i
< *argc
; i
++)
1815 gboolean parsed
= FALSE
;
1817 if ((*argv
)[i
][0] == '-' && (*argv
)[i
][1] != '\0' && !stop_parsing
)
1819 if ((*argv
)[i
][1] == '-')
1823 arg
= (*argv
)[i
] + 2;
1825 /* '--' terminates list of arguments */
1829 stop_parsing
= TRUE
;
1833 /* Handle help options */
1834 if (context
->help_enabled
)
1836 if (strcmp (arg
, "help") == 0)
1837 print_help (context
, TRUE
, NULL
);
1838 else if (strcmp (arg
, "help-all") == 0)
1839 print_help (context
, FALSE
, NULL
);
1840 else if (strncmp (arg
, "help-", 5) == 0)
1842 list
= context
->groups
;
1846 GOptionGroup
*group
= list
->data
;
1848 if (strcmp (arg
+ 5, group
->name
) == 0)
1849 print_help (context
, FALSE
, group
);
1856 if (context
->main_group
&&
1857 !parse_long_option (context
, context
->main_group
, &i
, arg
,
1858 FALSE
, argc
, argv
, error
, &parsed
))
1864 /* Try the groups */
1865 list
= context
->groups
;
1868 GOptionGroup
*group
= list
->data
;
1870 if (!parse_long_option (context
, group
, &i
, arg
,
1871 FALSE
, argc
, argv
, error
, &parsed
))
1883 /* Now look for --<group>-<option> */
1884 dash
= strchr (arg
, '-');
1887 /* Try the groups */
1888 list
= context
->groups
;
1891 GOptionGroup
*group
= list
->data
;
1893 if (strncmp (group
->name
, arg
, dash
- arg
) == 0)
1895 if (!parse_long_option (context
, group
, &i
, dash
+ 1,
1896 TRUE
, argc
, argv
, error
, &parsed
))
1907 if (context
->ignore_unknown
)
1911 { /* short option */
1912 gint new_i
= i
, arg_length
;
1913 gboolean
*nulled_out
= NULL
;
1914 gboolean has_h_entry
= context_has_h_entry (context
);
1915 arg
= (*argv
)[i
] + 1;
1916 arg_length
= strlen (arg
);
1917 nulled_out
= g_newa (gboolean
, arg_length
);
1918 memset (nulled_out
, 0, arg_length
* sizeof (gboolean
));
1919 for (j
= 0; j
< arg_length
; j
++)
1921 if (context
->help_enabled
&& (arg
[j
] == '?' ||
1922 (arg
[j
] == 'h' && !has_h_entry
)))
1923 print_help (context
, TRUE
, NULL
);
1925 if (context
->main_group
&&
1926 !parse_short_option (context
, context
->main_group
,
1928 argc
, argv
, error
, &parsed
))
1932 /* Try the groups */
1933 list
= context
->groups
;
1936 GOptionGroup
*group
= list
->data
;
1937 if (!parse_short_option (context
, group
, i
, &new_i
, arg
[j
],
1938 argc
, argv
, error
, &parsed
))
1946 if (context
->ignore_unknown
&& parsed
)
1947 nulled_out
[j
] = TRUE
;
1948 else if (context
->ignore_unknown
)
1952 /* !context->ignore_unknown && parsed */
1954 if (context
->ignore_unknown
)
1956 gchar
*new_arg
= NULL
;
1958 for (j
= 0; j
< arg_length
; j
++)
1963 new_arg
= g_malloc (arg_length
+ 1);
1964 new_arg
[arg_index
++] = arg
[j
];
1968 new_arg
[arg_index
] = '\0';
1969 add_pending_null (context
, &((*argv
)[i
]), new_arg
);
1973 add_pending_null (context
, &((*argv
)[i
]), NULL
);
1981 if (!parsed
&& !context
->ignore_unknown
)
1984 G_OPTION_ERROR
, G_OPTION_ERROR_UNKNOWN_OPTION
,
1985 _("Unknown option %s"), (*argv
)[i
]);
1991 /* Collect remaining args */
1992 if (context
->main_group
&&
1993 !parse_remaining_arg (context
, context
->main_group
, &i
,
1994 argc
, argv
, error
, &parsed
))
1997 if (!parsed
&& (has_unknown
|| (*argv
)[i
][0] == '-'))
2002 if (separator_pos
> 0)
2003 add_pending_null (context
, &((*argv
)[separator_pos
]), NULL
);
2007 /* Call post-parse hooks */
2008 list
= context
->groups
;
2011 GOptionGroup
*group
= list
->data
;
2013 if (group
->post_parse_func
)
2015 if (!(* group
->post_parse_func
) (context
, group
,
2016 group
->user_data
, error
))
2023 if (context
->main_group
&& context
->main_group
->post_parse_func
)
2025 if (!(* context
->main_group
->post_parse_func
) (context
, context
->main_group
,
2026 context
->main_group
->user_data
, error
))
2032 free_pending_nulls (context
, TRUE
);
2034 for (i
= 1; i
< *argc
; i
++)
2036 for (k
= i
; k
< *argc
; k
++)
2037 if ((*argv
)[k
] != NULL
)
2043 for (j
= i
+ k
; j
< *argc
; j
++)
2045 (*argv
)[j
-k
] = (*argv
)[j
];
2057 /* Call error hooks */
2058 list
= context
->groups
;
2061 GOptionGroup
*group
= list
->data
;
2063 if (group
->error_func
)
2064 (* group
->error_func
) (context
, group
,
2065 group
->user_data
, error
);
2070 if (context
->main_group
&& context
->main_group
->error_func
)
2071 (* context
->main_group
->error_func
) (context
, context
->main_group
,
2072 context
->main_group
->user_data
, error
);
2074 free_changes_list (context
, TRUE
);
2075 free_pending_nulls (context
, FALSE
);
2081 * g_option_group_new:
2082 * @name: the name for the option group, this is used to provide
2083 * help for the options in this group with <option>--help-</option>@name
2084 * @description: a description for this group to be shown in
2085 * <option>--help</option>. This string is translated using the translation
2086 * domain or translation function of the group
2087 * @help_description: a description for the <option>--help-</option>@name option.
2088 * This string is translated using the translation domain or translation function
2090 * @user_data: (allow-none): user data that will be passed to the pre- and post-parse hooks,
2091 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
2092 * @destroy: (allow-none): a function that will be called to free @user_data, or %NULL
2094 * Creates a new #GOptionGroup.
2096 * Return value: a newly created option group. It should be added
2097 * to a #GOptionContext or freed with g_option_group_free().
2102 g_option_group_new (const gchar
*name
,
2103 const gchar
*description
,
2104 const gchar
*help_description
,
2106 GDestroyNotify destroy
)
2109 GOptionGroup
*group
;
2111 group
= g_new0 (GOptionGroup
, 1);
2112 group
->name
= g_strdup (name
);
2113 group
->description
= g_strdup (description
);
2114 group
->help_description
= g_strdup (help_description
);
2115 group
->user_data
= user_data
;
2116 group
->destroy_notify
= destroy
;
2123 * g_option_group_free:
2124 * @group: a #GOptionGroup
2126 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
2127 * free groups which have been added to a #GOptionContext.
2132 g_option_group_free (GOptionGroup
*group
)
2134 g_return_if_fail (group
!= NULL
);
2136 g_free (group
->name
);
2137 g_free (group
->description
);
2138 g_free (group
->help_description
);
2140 g_free (group
->entries
);
2142 if (group
->destroy_notify
)
2143 (* group
->destroy_notify
) (group
->user_data
);
2145 if (group
->translate_notify
)
2146 (* group
->translate_notify
) (group
->translate_data
);
2153 * g_option_group_add_entries:
2154 * @group: a #GOptionGroup
2155 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
2157 * Adds the options specified in @entries to @group.
2162 g_option_group_add_entries (GOptionGroup
*group
,
2163 const GOptionEntry
*entries
)
2167 g_return_if_fail (entries
!= NULL
);
2169 for (n_entries
= 0; entries
[n_entries
].long_name
!= NULL
; n_entries
++) ;
2171 group
->entries
= g_renew (GOptionEntry
, group
->entries
, group
->n_entries
+ n_entries
);
2173 memcpy (group
->entries
+ group
->n_entries
, entries
, sizeof (GOptionEntry
) * n_entries
);
2175 for (i
= group
->n_entries
; i
< group
->n_entries
+ n_entries
; i
++)
2177 gchar c
= group
->entries
[i
].short_name
;
2179 if (c
== '-' || (c
!= 0 && !g_ascii_isprint (c
)))
2181 g_warning (G_STRLOC
": ignoring invalid short option '%c' (%d) in entry %s:%s",
2182 c
, c
, group
->name
, group
->entries
[i
].long_name
);
2183 group
->entries
[i
].short_name
= '\0';
2186 if (group
->entries
[i
].arg
!= G_OPTION_ARG_NONE
&&
2187 (group
->entries
[i
].flags
& G_OPTION_FLAG_REVERSE
) != 0)
2189 g_warning (G_STRLOC
": ignoring reverse flag on option of arg-type %d in entry %s:%s",
2190 group
->entries
[i
].arg
, group
->name
, group
->entries
[i
].long_name
);
2192 group
->entries
[i
].flags
&= ~G_OPTION_FLAG_REVERSE
;
2195 if (group
->entries
[i
].arg
!= G_OPTION_ARG_CALLBACK
&&
2196 (group
->entries
[i
].flags
& (G_OPTION_FLAG_NO_ARG
|G_OPTION_FLAG_OPTIONAL_ARG
|G_OPTION_FLAG_FILENAME
)) != 0)
2198 g_warning (G_STRLOC
": ignoring no-arg, optional-arg or filename flags (%d) on option of arg-type %d in entry %s:%s",
2199 group
->entries
[i
].flags
, group
->entries
[i
].arg
, group
->name
, group
->entries
[i
].long_name
);
2201 group
->entries
[i
].flags
&= ~(G_OPTION_FLAG_NO_ARG
|G_OPTION_FLAG_OPTIONAL_ARG
|G_OPTION_FLAG_FILENAME
);
2205 group
->n_entries
+= n_entries
;
2209 * g_option_group_set_parse_hooks:
2210 * @group: a #GOptionGroup
2211 * @pre_parse_func: (allow-none): a function to call before parsing, or %NULL
2212 * @post_parse_func: (allow-none): a function to call after parsing, or %NULL
2214 * Associates two functions with @group which will be called
2215 * from g_option_context_parse() before the first option is parsed
2216 * and after the last option has been parsed, respectively.
2218 * Note that the user data to be passed to @pre_parse_func and
2219 * @post_parse_func can be specified when constructing the group
2220 * with g_option_group_new().
2225 g_option_group_set_parse_hooks (GOptionGroup
*group
,
2226 GOptionParseFunc pre_parse_func
,
2227 GOptionParseFunc post_parse_func
)
2229 g_return_if_fail (group
!= NULL
);
2231 group
->pre_parse_func
= pre_parse_func
;
2232 group
->post_parse_func
= post_parse_func
;
2236 * g_option_group_set_error_hook:
2237 * @group: a #GOptionGroup
2238 * @error_func: a function to call when an error occurs
2240 * Associates a function with @group which will be called
2241 * from g_option_context_parse() when an error occurs.
2243 * Note that the user data to be passed to @error_func can be
2244 * specified when constructing the group with g_option_group_new().
2249 g_option_group_set_error_hook (GOptionGroup
*group
,
2250 GOptionErrorFunc error_func
)
2252 g_return_if_fail (group
!= NULL
);
2254 group
->error_func
= error_func
;
2259 * g_option_group_set_translate_func:
2260 * @group: a #GOptionGroup
2261 * @func: (allow-none): the #GTranslateFunc, or %NULL
2262 * @data: (allow-none): user data to pass to @func, or %NULL
2263 * @destroy_notify: (allow-none): a function which gets called to free @data, or %NULL
2265 * Sets the function which is used to translate user-visible
2266 * strings, for <option>--help</option> output. Different
2267 * groups can use different #GTranslateFunc<!-- -->s. If @func
2268 * is %NULL, strings are not translated.
2270 * If you are using gettext(), you only need to set the translation
2271 * domain, see g_option_group_set_translation_domain().
2276 g_option_group_set_translate_func (GOptionGroup
*group
,
2277 GTranslateFunc func
,
2279 GDestroyNotify destroy_notify
)
2281 g_return_if_fail (group
!= NULL
);
2283 if (group
->translate_notify
)
2284 group
->translate_notify (group
->translate_data
);
2286 group
->translate_func
= func
;
2287 group
->translate_data
= data
;
2288 group
->translate_notify
= destroy_notify
;
2291 static const gchar
*
2292 dgettext_swapped (const gchar
*msgid
,
2293 const gchar
*domainname
)
2295 return g_dgettext (domainname
, msgid
);
2299 * g_option_group_set_translation_domain:
2300 * @group: a #GOptionGroup
2301 * @domain: the domain to use
2303 * A convenience function to use gettext() for translating
2304 * user-visible strings.
2309 g_option_group_set_translation_domain (GOptionGroup
*group
,
2310 const gchar
*domain
)
2312 g_return_if_fail (group
!= NULL
);
2314 g_option_group_set_translate_func (group
,
2315 (GTranslateFunc
)dgettext_swapped
,
2321 * g_option_context_set_translate_func:
2322 * @context: a #GOptionContext
2323 * @func: (allow-none): the #GTranslateFunc, or %NULL
2324 * @data: (allow-none): user data to pass to @func, or %NULL
2325 * @destroy_notify: (allow-none): a function which gets called to free @data, or %NULL
2327 * Sets the function which is used to translate the contexts
2328 * user-visible strings, for <option>--help</option> output.
2329 * If @func is %NULL, strings are not translated.
2331 * Note that option groups have their own translation functions,
2332 * this function only affects the @parameter_string (see g_option_context_new()),
2333 * the summary (see g_option_context_set_summary()) and the description
2334 * (see g_option_context_set_description()).
2336 * If you are using gettext(), you only need to set the translation
2337 * domain, see g_option_context_set_translation_domain().
2342 g_option_context_set_translate_func (GOptionContext
*context
,
2343 GTranslateFunc func
,
2345 GDestroyNotify destroy_notify
)
2347 g_return_if_fail (context
!= NULL
);
2349 if (context
->translate_notify
)
2350 context
->translate_notify (context
->translate_data
);
2352 context
->translate_func
= func
;
2353 context
->translate_data
= data
;
2354 context
->translate_notify
= destroy_notify
;
2358 * g_option_context_set_translation_domain:
2359 * @context: a #GOptionContext
2360 * @domain: the domain to use
2362 * A convenience function to use gettext() for translating
2363 * user-visible strings.
2368 g_option_context_set_translation_domain (GOptionContext
*context
,
2369 const gchar
*domain
)
2371 g_return_if_fail (context
!= NULL
);
2373 g_option_context_set_translate_func (context
,
2374 (GTranslateFunc
)dgettext_swapped
,
2380 * g_option_context_set_summary:
2381 * @context: a #GOptionContext
2382 * @summary: (allow-none): a string to be shown in <option>--help</option> output
2383 * before the list of options, or %NULL
2385 * Adds a string to be displayed in <option>--help</option> output
2386 * before the list of options. This is typically a summary of the
2387 * program functionality.
2389 * Note that the summary is translated (see
2390 * g_option_context_set_translate_func() and
2391 * g_option_context_set_translation_domain()).
2396 g_option_context_set_summary (GOptionContext
*context
,
2397 const gchar
*summary
)
2399 g_return_if_fail (context
!= NULL
);
2401 g_free (context
->summary
);
2402 context
->summary
= g_strdup (summary
);
2407 * g_option_context_get_summary:
2408 * @context: a #GOptionContext
2410 * Returns the summary. See g_option_context_set_summary().
2412 * Returns: the summary
2417 g_option_context_get_summary (GOptionContext
*context
)
2419 g_return_val_if_fail (context
!= NULL
, NULL
);
2421 return context
->summary
;
2425 * g_option_context_set_description:
2426 * @context: a #GOptionContext
2427 * @description: (allow-none): a string to be shown in <option>--help</option> output
2428 * after the list of options, or %NULL
2430 * Adds a string to be displayed in <option>--help</option> output
2431 * after the list of options. This text often includes a bug reporting
2434 * Note that the summary is translated (see
2435 * g_option_context_set_translate_func()).
2440 g_option_context_set_description (GOptionContext
*context
,
2441 const gchar
*description
)
2443 g_return_if_fail (context
!= NULL
);
2445 g_free (context
->description
);
2446 context
->description
= g_strdup (description
);
2451 * g_option_context_get_description:
2452 * @context: a #GOptionContext
2454 * Returns the description. See g_option_context_set_description().
2456 * Returns: the description
2461 g_option_context_get_description (GOptionContext
*context
)
2463 g_return_val_if_fail (context
!= NULL
, NULL
);
2465 return context
->description
;