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.
23 * @Short_description: parses commandline options
24 * @Title: Commandline option parser
26 * The GOption commandline parser is intended to be a simpler replacement for the
27 * popt library. It supports short and long commandline options, as shown in the
31 * <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal>
34 * The example demonstrates a number of features of the GOption commandline parser
36 * Options can be single letters, prefixed by a single dash. Multiple
37 * short options can be grouped behind a single dash.
39 * Long options are prefixed by two consecutive dashes.
41 * Options can have an extra argument, which can be a number, a string or a
42 * filename. For long options, the extra argument can be appended with an
43 * equals sign after the option name.
45 * Non-option arguments are returned to the application as rest arguments.
47 * An argument consisting solely of two dashes turns off further parsing,
48 * any remaining arguments (even those starting with a dash) are returned
49 * to the application as rest arguments.
54 * Another important feature of GOption is that it can automatically generate
55 * nicely formatted help output. Unless it is explicitly turned off with
56 * g_option_context_set_help_enabled(), GOption will recognize the
57 * <option>--help</option>, <option>-?</option>, <option>--help-all</option>
58 * and <option>--help-</option><replaceable>groupname</replaceable> options
59 * (where <replaceable>groupname</replaceable> is the name of a #GOptionGroup)
60 * and write a text similar to the one shown in the following example to stdout.
63 * <informalexample><screen>
65 * testtreemodel [OPTION...] - test tree model performance
68 * -?, --help Show help options
69 * --help-all Show all help options
70 * --help-gtk Show GTK+ Options
72 * Application Options:
73 * -r, --repeats=N Average over N repetitions
74 * -m, --max-size=M Test up to 2^M items
75 * --display=DISPLAY X display to use
76 * -v, --verbose Be verbose
77 * -b, --beep Beep when done
78 * --rand Randomize the data
79 * </screen></informalexample>
81 * GOption groups options in #GOptionGroup<!-- -->s, which makes it easy to
82 * incorporate options from multiple sources. The intended use for this is
83 * to let applications collect option groups from the libraries it uses,
84 * add them to their #GOptionContext, and parse all options by a single call
85 * 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 UTF-8,
90 * filenames are returned in the GLib filename encoding. Note that this only
91 * works if setlocale() has been called before 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>
139 #include "glibintl.h"
149 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
151 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE || \
152 ((entry)->arg == G_OPTION_ARG_CALLBACK && \
153 ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
155 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK && \
156 (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
188 struct _GOptionContext
192 gchar *parameter_string;
196 GTranslateFunc translate_func;
197 GDestroyNotify translate_notify;
198 gpointer translate_data;
200 guint help_enabled : 1;
201 guint ignore_unknown : 1;
203 GOptionGroup *main_group;
205 /* We keep a list of change so we can revert them */
208 /* We also keep track of all argv elements
209 * that should be NULLed or modified.
211 GList *pending_nulls;
218 gchar *help_description;
220 GDestroyNotify destroy_notify;
223 GTranslateFunc translate_func;
224 GDestroyNotify translate_notify;
225 gpointer translate_data;
227 GOptionEntry *entries;
230 GOptionParseFunc pre_parse_func;
231 GOptionParseFunc post_parse_func;
232 GOptionErrorFunc error_func;
235 static void free_changes_list (GOptionContext *context,
237 static void free_pending_nulls (GOptionContext *context,
238 gboolean perform_nulls);
242 _g_unichar_get_width (gunichar c)
244 if (G_UNLIKELY (g_unichar_iszerowidth (c)))
247 /* we ignore the fact that we should call g_unichar_iswide_cjk() under
248 * some locales (legacy East Asian ones) */
249 if (g_unichar_iswide (c))
256 _g_utf8_strwidth (const gchar *p,
260 const gchar *start = p;
261 g_return_val_if_fail (p != NULL || max == 0, 0);
267 len += _g_unichar_get_width (g_utf8_get_char (p));
268 p = g_utf8_next_char (p);
276 /* this case may not be quite correct */
278 len += _g_unichar_get_width (g_utf8_get_char (p));
279 p = g_utf8_next_char (p);
281 while (p - start < max && *p)
283 len += _g_unichar_get_width (g_utf8_get_char (p));
284 p = g_utf8_next_char (p);
293 g_option_error_quark (void)
295 return g_quark_from_static_string ("g-option-context-error-quark");
299 * g_option_context_new:
300 * @parameter_string: a string which is displayed in
301 * the first line of <option>--help</option> output, after the
303 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
305 * Creates a new option context.
307 * The @parameter_string can serve multiple purposes. It can be used
308 * to add descriptions for "rest" arguments, which are not parsed by
309 * the #GOptionContext, typically something like "FILES" or
310 * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
311 * collecting "rest" arguments, GLib handles this automatically by
312 * using the @arg_description of the corresponding #GOptionEntry in
315 * Another usage is to give a short summary of the program
316 * functionality, like " - frob the strings", which will be displayed
317 * in the same line as the usage. For a longer description of the
318 * program functionality that should be displayed as a paragraph
319 * below the usage line, use g_option_context_set_summary().
321 * Note that the @parameter_string is translated using the
322 * function set with g_option_context_set_translate_func(), so
323 * it should normally be passed untranslated.
325 * Returns: a newly created #GOptionContext, which must be
326 * freed with g_option_context_free() after use.
331 g_option_context_new (const gchar *parameter_string)
334 GOptionContext *context;
336 context = g_new0 (GOptionContext, 1);
338 context->parameter_string = g_strdup (parameter_string);
339 context->help_enabled = TRUE;
340 context->ignore_unknown = FALSE;
346 * g_option_context_free:
347 * @context: a #GOptionContext
349 * Frees context and all the groups which have been
352 * Please note that parsed arguments need to be freed separately (see
357 void g_option_context_free (GOptionContext *context)
359 g_return_if_fail (context != NULL);
361 g_list_foreach (context->groups, (GFunc)g_option_group_free, NULL);
362 g_list_free (context->groups);
364 if (context->main_group)
365 g_option_group_free (context->main_group);
367 free_changes_list (context, FALSE);
368 free_pending_nulls (context, FALSE);
370 g_free (context->parameter_string);
371 g_free (context->summary);
372 g_free (context->description);
374 if (context->translate_notify)
375 (* context->translate_notify) (context->translate_data);
382 * g_option_context_set_help_enabled:
383 * @context: a #GOptionContext
384 * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
386 * Enables or disables automatic generation of <option>--help</option>
387 * output. By default, g_option_context_parse() recognizes
388 * <option>--help</option>, <option>-?</option>, <option>--help-all</option>
389 * and <option>--help-</option><replaceable>groupname</replaceable> and creates
390 * suitable output to stdout.
394 void g_option_context_set_help_enabled (GOptionContext *context,
395 gboolean help_enabled)
398 g_return_if_fail (context != NULL);
400 context->help_enabled = help_enabled;
404 * g_option_context_get_help_enabled:
405 * @context: a #GOptionContext
407 * Returns whether automatic <option>--help</option> generation
408 * is turned on for @context. See g_option_context_set_help_enabled().
410 * Returns: %TRUE if automatic help generation is turned on.
415 g_option_context_get_help_enabled (GOptionContext *context)
417 g_return_val_if_fail (context != NULL, FALSE);
419 return context->help_enabled;
423 * g_option_context_set_ignore_unknown_options:
424 * @context: a #GOptionContext
425 * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
426 * an error when unknown options are met
428 * Sets whether to ignore unknown options or not. If an argument is
429 * ignored, it is left in the @argv array after parsing. By default,
430 * g_option_context_parse() treats unknown options as error.
432 * This setting does not affect non-option arguments (i.e. arguments
433 * which don't start with a dash). But note that GOption cannot reliably
434 * determine whether a non-option belongs to a preceding unknown option.
439 g_option_context_set_ignore_unknown_options (GOptionContext *context,
440 gboolean ignore_unknown)
442 g_return_if_fail (context != NULL);
444 context->ignore_unknown = ignore_unknown;
448 * g_option_context_get_ignore_unknown_options:
449 * @context: a #GOptionContext
451 * Returns whether unknown options are ignored or not. See
452 * g_option_context_set_ignore_unknown_options().
454 * Returns: %TRUE if unknown options are ignored.
459 g_option_context_get_ignore_unknown_options (GOptionContext *context)
461 g_return_val_if_fail (context != NULL, FALSE);
463 return context->ignore_unknown;
467 * g_option_context_add_group:
468 * @context: a #GOptionContext
469 * @group: the group to add
471 * Adds a #GOptionGroup to the @context, so that parsing with @context
472 * will recognize the options in the group. Note that the group will
473 * be freed together with the context when g_option_context_free() is
474 * called, so you must not free the group yourself after adding it
480 g_option_context_add_group (GOptionContext *context,
485 g_return_if_fail (context != NULL);
486 g_return_if_fail (group != NULL);
487 g_return_if_fail (group->name != NULL);
488 g_return_if_fail (group->description != NULL);
489 g_return_if_fail (group->help_description != NULL);
491 for (list = context->groups; list; list = list->next)
493 GOptionGroup *g = (GOptionGroup *)list->data;
495 if ((group->name == NULL && g->name == NULL) ||
496 (group->name && g->name && strcmp (group->name, g->name) == 0))
497 g_warning ("A group named \"%s\" is already part of this GOptionContext",
501 context->groups = g_list_append (context->groups, group);
505 * g_option_context_set_main_group:
506 * @context: a #GOptionContext
507 * @group: the group to set as main group
509 * Sets a #GOptionGroup as main group of the @context.
510 * This has the same effect as calling g_option_context_add_group(),
511 * the only difference is that the options in the main group are
512 * treated differently when generating <option>--help</option> output.
517 g_option_context_set_main_group (GOptionContext *context,
520 g_return_if_fail (context != NULL);
521 g_return_if_fail (group != NULL);
523 if (context->main_group)
525 g_warning ("This GOptionContext already has a main group");
530 context->main_group = group;
534 * g_option_context_get_main_group:
535 * @context: a #GOptionContext
537 * Returns a pointer to the main group of @context.
539 * Return value: the main group of @context, or %NULL if @context doesn't
540 * have a main group. Note that group belongs to @context and should
541 * not be modified or freed.
546 g_option_context_get_main_group (GOptionContext *context)
548 g_return_val_if_fail (context != NULL, NULL);
550 return context->main_group;
554 * g_option_context_add_main_entries:
555 * @context: a #GOptionContext
556 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
557 * @translation_domain: a translation domain to use for translating
558 * the <option>--help</option> output for the options in @entries
559 * with gettext(), or %NULL
561 * A convenience function which creates a main group if it doesn't
562 * exist, adds the @entries to it and sets the translation domain.
567 g_option_context_add_main_entries (GOptionContext *context,
568 const GOptionEntry *entries,
569 const gchar *translation_domain)
571 g_return_if_fail (entries != NULL);
573 if (!context->main_group)
574 context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
576 g_option_group_add_entries (context->main_group, entries);
577 g_option_group_set_translation_domain (context->main_group, translation_domain);
581 calculate_max_length (GOptionGroup *group)
584 gint i, len, max_length;
588 for (i = 0; i < group->n_entries; i++)
590 entry = &group->entries[i];
592 if (entry->flags & G_OPTION_FLAG_HIDDEN)
595 len = _g_utf8_strwidth (entry->long_name, -1);
597 if (entry->short_name)
600 if (!NO_ARG (entry) && entry->arg_description)
601 len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description), -1);
603 max_length = MAX (max_length, len);
610 print_entry (GOptionGroup *group,
612 const GOptionEntry *entry,
617 if (entry->flags & G_OPTION_FLAG_HIDDEN)
620 if (entry->long_name[0] == 0)
623 str = g_string_new (NULL);
625 if (entry->short_name)
626 g_string_append_printf (str, " -%c, --%s", entry->short_name, entry->long_name);
628 g_string_append_printf (str, " --%s", entry->long_name);
630 if (entry->arg_description)
631 g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
633 g_string_append_printf (string, "%s%*s %s\n", str->str,
634 (int) (max_length + 4 - _g_utf8_strwidth (str->str, -1)), "",
635 entry->description ? TRANSLATE (group, entry->description) : "");
636 g_string_free (str, TRUE);
640 group_has_visible_entries (GOptionContext *context,
642 gboolean main_entries)
644 GOptionFlags reject_filter = G_OPTION_FLAG_HIDDEN;
647 gboolean main_group = group == context->main_group;
650 reject_filter |= G_OPTION_FLAG_IN_MAIN;
652 for (i = 0, l = (group ? group->n_entries : 0); i < l; i++)
654 entry = &group->entries[i];
656 if (main_entries && !main_group && !(entry->flags & G_OPTION_FLAG_IN_MAIN))
658 if (!(entry->flags & reject_filter))
666 group_list_has_visible_entires (GOptionContext *context,
668 gboolean main_entries)
672 if (group_has_visible_entries (context, group_list->data, main_entries))
675 group_list = group_list->next;
682 * g_option_context_get_help:
683 * @context: a #GOptionContext
684 * @main_help: if %TRUE, only include the main group
685 * @group: the #GOptionGroup to create help for, or %NULL
687 * Returns a formatted, translated help text for the given context.
688 * To obtain the text produced by <option>--help</option>, call
689 * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
690 * To obtain the text produced by <option>--help-all</option>, call
691 * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
692 * To obtain the help text for an option group, call
693 * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
695 * Returns: A newly allocated string containing the help text
700 g_option_context_get_help (GOptionContext *context,
705 gint max_length, len;
708 GHashTable *shadow_map;
710 const gchar *rest_description;
713 string = g_string_sized_new (1024);
715 rest_description = NULL;
716 if (context->main_group)
719 for (i = 0; i < context->main_group->n_entries; i++)
721 entry = &context->main_group->entries[i];
722 if (entry->long_name[0] == 0)
724 rest_description = TRANSLATE (context->main_group, entry->arg_description);
730 g_string_append_printf (string, "%s\n %s %s",
731 _("Usage:"), g_get_prgname(), _("[OPTION...]"));
733 if (rest_description)
735 g_string_append (string, " ");
736 g_string_append (string, rest_description);
739 if (context->parameter_string)
741 g_string_append (string, " ");
742 g_string_append (string, TRANSLATE (context, context->parameter_string));
745 g_string_append (string, "\n\n");
747 if (context->summary)
749 g_string_append (string, TRANSLATE (context, context->summary));
750 g_string_append (string, "\n\n");
753 memset (seen, 0, sizeof (gboolean) * 256);
754 shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
756 if (context->main_group)
758 for (i = 0; i < context->main_group->n_entries; i++)
760 entry = &context->main_group->entries[i];
761 g_hash_table_insert (shadow_map,
762 (gpointer)entry->long_name,
765 if (seen[(guchar)entry->short_name])
766 entry->short_name = 0;
768 seen[(guchar)entry->short_name] = TRUE;
772 list = context->groups;
775 GOptionGroup *g = list->data;
776 for (i = 0; i < g->n_entries; i++)
778 entry = &g->entries[i];
779 if (g_hash_table_lookup (shadow_map, entry->long_name) &&
780 !(entry->flags & G_OPTION_FLAG_NOALIAS))
781 entry->long_name = g_strdup_printf ("%s-%s", g->name, entry->long_name);
783 g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
785 if (seen[(guchar)entry->short_name] &&
786 !(entry->flags & G_OPTION_FLAG_NOALIAS))
787 entry->short_name = 0;
789 seen[(guchar)entry->short_name] = TRUE;
794 g_hash_table_destroy (shadow_map);
796 list = context->groups;
798 max_length = _g_utf8_strwidth ("-?, --help", -1);
802 len = _g_utf8_strwidth ("--help-all", -1);
803 max_length = MAX (max_length, len);
806 if (context->main_group)
808 len = calculate_max_length (context->main_group);
809 max_length = MAX (max_length, len);
814 GOptionGroup *g = list->data;
816 /* First, we check the --help-<groupname> options */
817 len = _g_utf8_strwidth ("--help-", -1) + _g_utf8_strwidth (g->name, -1);
818 max_length = MAX (max_length, len);
820 /* Then we go through the entries */
821 len = calculate_max_length (g);
822 max_length = MAX (max_length, len);
827 /* Add a bit of padding */
832 list = context->groups;
834 g_string_append_printf (string, "%s\n -%c, --%-*s %s\n",
835 _("Help Options:"), '?', max_length - 4, "help",
836 _("Show help options"));
838 /* We only want --help-all when there are groups */
840 g_string_append_printf (string, " --%-*s %s\n",
841 max_length, "help-all",
842 _("Show all help options"));
846 GOptionGroup *g = list->data;
848 if (group_has_visible_entries (context, g, FALSE))
849 g_string_append_printf (string, " --help-%-*s %s\n",
850 max_length - 5, g->name,
851 TRANSLATE (g, g->help_description));
856 g_string_append (string, "\n");
861 /* Print a certain group */
863 if (group_has_visible_entries (context, group, FALSE))
865 g_string_append (string, TRANSLATE (group, group->description));
866 g_string_append (string, "\n");
867 for (i = 0; i < group->n_entries; i++)
868 print_entry (group, max_length, &group->entries[i], string);
869 g_string_append (string, "\n");
874 /* Print all groups */
876 list = context->groups;
880 GOptionGroup *g = list->data;
882 if (group_has_visible_entries (context, g, FALSE))
884 g_string_append (string, g->description);
885 g_string_append (string, "\n");
886 for (i = 0; i < g->n_entries; i++)
887 if (!(g->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
888 print_entry (g, max_length, &g->entries[i], string);
890 g_string_append (string, "\n");
897 /* Print application options if --help or --help-all has been specified */
898 if ((main_help || !group) &&
899 (group_has_visible_entries (context, context->main_group, TRUE) ||
900 group_list_has_visible_entires (context, context->groups, TRUE)))
902 list = context->groups;
904 g_string_append (string, _("Application Options:"));
905 g_string_append (string, "\n");
906 if (context->main_group)
907 for (i = 0; i < context->main_group->n_entries; i++)
908 print_entry (context->main_group, max_length,
909 &context->main_group->entries[i], string);
913 GOptionGroup *g = list->data;
915 /* Print main entries from other groups */
916 for (i = 0; i < g->n_entries; i++)
917 if (g->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
918 print_entry (g, max_length, &g->entries[i], string);
923 g_string_append (string, "\n");
926 if (context->description)
928 g_string_append (string, TRANSLATE (context, context->description));
929 g_string_append (string, "\n");
932 return g_string_free (string, FALSE);
937 print_help (GOptionContext *context,
943 help = g_option_context_get_help (context, main_help, group);
944 g_print ("%s", help);
951 parse_int (const gchar *arg_name,
960 tmp = strtol (arg, &end, 0);
962 if (*arg == '\0' || *end != '\0')
965 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
966 _("Cannot parse integer value '%s' for %s"),
972 if (*result != tmp || errno == ERANGE)
975 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
976 _("Integer value '%s' for %s out of range"),
986 parse_double (const gchar *arg_name,
995 tmp = g_strtod (arg, &end);
997 if (*arg == '\0' || *end != '\0')
1000 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1001 _("Cannot parse double value '%s' for %s"),
1005 if (errno == ERANGE)
1008 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1009 _("Double value '%s' for %s out of range"),
1021 parse_int64 (const gchar *arg_name,
1030 tmp = g_ascii_strtoll (arg, &end, 0);
1032 if (*arg == '\0' || *end != '\0')
1035 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1036 _("Cannot parse integer value '%s' for %s"),
1040 if (errno == ERANGE)
1043 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1044 _("Integer value '%s' for %s out of range"),
1056 get_change (GOptionContext *context,
1057 GOptionArg arg_type,
1061 Change *change = NULL;
1063 for (list = context->changes; list != NULL; list = list->next)
1065 change = list->data;
1067 if (change->arg_data == arg_data)
1071 change = g_new0 (Change, 1);
1072 change->arg_type = arg_type;
1073 change->arg_data = arg_data;
1075 context->changes = g_list_prepend (context->changes, change);
1083 add_pending_null (GOptionContext *context,
1089 n = g_new0 (PendingNull, 1);
1093 context->pending_nulls = g_list_prepend (context->pending_nulls, n);
1097 parse_arg (GOptionContext *context,
1098 GOptionGroup *group,
1099 GOptionEntry *entry,
1101 const gchar *option_name,
1107 g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
1111 case G_OPTION_ARG_NONE:
1113 change = get_change (context, G_OPTION_ARG_NONE,
1116 *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1119 case G_OPTION_ARG_STRING:
1123 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1128 change = get_change (context, G_OPTION_ARG_STRING,
1130 g_free (change->allocated.str);
1132 change->prev.str = *(gchar **)entry->arg_data;
1133 change->allocated.str = data;
1135 *(gchar **)entry->arg_data = data;
1138 case G_OPTION_ARG_STRING_ARRAY:
1142 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1147 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1150 if (change->allocated.array.len == 0)
1152 change->prev.array = *(gchar ***)entry->arg_data;
1153 change->allocated.array.data = g_new (gchar *, 2);
1156 change->allocated.array.data =
1157 g_renew (gchar *, change->allocated.array.data,
1158 change->allocated.array.len + 2);
1160 change->allocated.array.data[change->allocated.array.len] = data;
1161 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1163 change->allocated.array.len ++;
1165 *(gchar ***)entry->arg_data = change->allocated.array.data;
1170 case G_OPTION_ARG_FILENAME:
1175 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1180 data = g_strdup (value);
1182 change = get_change (context, G_OPTION_ARG_FILENAME,
1184 g_free (change->allocated.str);
1186 change->prev.str = *(gchar **)entry->arg_data;
1187 change->allocated.str = data;
1189 *(gchar **)entry->arg_data = data;
1193 case G_OPTION_ARG_FILENAME_ARRAY:
1198 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1203 data = g_strdup (value);
1205 change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1208 if (change->allocated.array.len == 0)
1210 change->prev.array = *(gchar ***)entry->arg_data;
1211 change->allocated.array.data = g_new (gchar *, 2);
1214 change->allocated.array.data =
1215 g_renew (gchar *, change->allocated.array.data,
1216 change->allocated.array.len + 2);
1218 change->allocated.array.data[change->allocated.array.len] = data;
1219 change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1221 change->allocated.array.len ++;
1223 *(gchar ***)entry->arg_data = change->allocated.array.data;
1228 case G_OPTION_ARG_INT:
1232 if (!parse_int (option_name, value,
1237 change = get_change (context, G_OPTION_ARG_INT,
1239 change->prev.integer = *(gint *)entry->arg_data;
1240 *(gint *)entry->arg_data = data;
1243 case G_OPTION_ARG_CALLBACK:
1248 if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1250 else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1252 else if (entry->flags & G_OPTION_FLAG_FILENAME)
1255 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1257 data = g_strdup (value);
1261 data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1263 if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1267 retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1269 if (!retval && error != NULL && *error == NULL)
1271 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1272 _("Error parsing option %s"), option_name);
1280 case G_OPTION_ARG_DOUBLE:
1284 if (!parse_double (option_name, value,
1291 change = get_change (context, G_OPTION_ARG_DOUBLE,
1293 change->prev.dbl = *(gdouble *)entry->arg_data;
1294 *(gdouble *)entry->arg_data = data;
1297 case G_OPTION_ARG_INT64:
1301 if (!parse_int64 (option_name, value,
1308 change = get_change (context, G_OPTION_ARG_INT64,
1310 change->prev.int64 = *(gint64 *)entry->arg_data;
1311 *(gint64 *)entry->arg_data = data;
1315 g_assert_not_reached ();
1322 parse_short_option (GOptionContext *context,
1323 GOptionGroup *group,
1334 for (j = 0; j < group->n_entries; j++)
1336 if (arg == group->entries[j].short_name)
1339 gchar *value = NULL;
1341 option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1343 if (NO_ARG (&group->entries[j]))
1350 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1351 _("Error parsing option %s"), option_name);
1352 g_free (option_name);
1356 if (idx < *argc - 1)
1358 if (!OPTIONAL_ARG (&group->entries[j]))
1360 value = (*argv)[idx + 1];
1361 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1366 if ((*argv)[idx + 1][0] == '-')
1370 value = (*argv)[idx + 1];
1371 add_pending_null (context, &((*argv)[idx + 1]), NULL);
1376 else if (idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1381 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1382 _("Missing argument for %s"), option_name);
1383 g_free (option_name);
1388 if (!parse_arg (context, group, &group->entries[j],
1389 value, option_name, error))
1391 g_free (option_name);
1395 g_free (option_name);
1404 parse_long_option (GOptionContext *context,
1405 GOptionGroup *group,
1416 for (j = 0; j < group->n_entries; j++)
1421 if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1424 if (NO_ARG (&group->entries[j]) &&
1425 strcmp (arg, group->entries[j].long_name) == 0)
1430 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1431 retval = parse_arg (context, group, &group->entries[j],
1432 NULL, option_name, error);
1433 g_free(option_name);
1435 add_pending_null (context, &((*argv)[*idx]), NULL);
1442 gint len = strlen (group->entries[j].long_name);
1444 if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1445 (arg[len] == '=' || arg[len] == 0))
1447 gchar *value = NULL;
1450 add_pending_null (context, &((*argv)[*idx]), NULL);
1451 option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1453 if (arg[len] == '=')
1454 value = arg + len + 1;
1455 else if (*idx < *argc - 1)
1457 if (!(group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG))
1459 value = (*argv)[*idx + 1];
1460 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1465 if ((*argv)[*idx + 1][0] == '-')
1468 retval = parse_arg (context, group, &group->entries[j],
1469 NULL, option_name, error);
1471 g_free (option_name);
1476 value = (*argv)[*idx + 1];
1477 add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1482 else if (*idx >= *argc - 1 &&
1483 group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG)
1486 retval = parse_arg (context, group, &group->entries[j],
1487 NULL, option_name, error);
1489 g_free (option_name);
1495 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1496 _("Missing argument for %s"), option_name);
1497 g_free (option_name);
1501 if (!parse_arg (context, group, &group->entries[j],
1502 value, option_name, error))
1504 g_free (option_name);
1508 g_free (option_name);
1518 parse_remaining_arg (GOptionContext *context,
1519 GOptionGroup *group,
1528 for (j = 0; j < group->n_entries; j++)
1533 if (group->entries[j].long_name[0])
1536 g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1537 group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1538 group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1540 add_pending_null (context, &((*argv)[*idx]), NULL);
1542 if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
1553 free_changes_list (GOptionContext *context,
1558 for (list = context->changes; list != NULL; list = list->next)
1560 Change *change = list->data;
1564 switch (change->arg_type)
1566 case G_OPTION_ARG_NONE:
1567 *(gboolean *)change->arg_data = change->prev.bool;
1569 case G_OPTION_ARG_INT:
1570 *(gint *)change->arg_data = change->prev.integer;
1572 case G_OPTION_ARG_STRING:
1573 case G_OPTION_ARG_FILENAME:
1574 g_free (change->allocated.str);
1575 *(gchar **)change->arg_data = change->prev.str;
1577 case G_OPTION_ARG_STRING_ARRAY:
1578 case G_OPTION_ARG_FILENAME_ARRAY:
1579 g_strfreev (change->allocated.array.data);
1580 *(gchar ***)change->arg_data = change->prev.array;
1582 case G_OPTION_ARG_DOUBLE:
1583 *(gdouble *)change->arg_data = change->prev.dbl;
1585 case G_OPTION_ARG_INT64:
1586 *(gint64 *)change->arg_data = change->prev.int64;
1589 g_assert_not_reached ();
1596 g_list_free (context->changes);
1597 context->changes = NULL;
1601 free_pending_nulls (GOptionContext *context,
1602 gboolean perform_nulls)
1606 for (list = context->pending_nulls; list != NULL; list = list->next)
1608 PendingNull *n = list->data;
1614 /* Copy back the short options */
1616 strcpy (*n->ptr + 1, n->value);
1626 g_list_free (context->pending_nulls);
1627 context->pending_nulls = NULL;
1631 * g_option_context_parse:
1632 * @context: a #GOptionContext
1633 * @argc: a pointer to the number of command line arguments
1634 * @argv: a pointer to the array of command line arguments
1635 * @error: a return location for errors
1637 * Parses the command line arguments, recognizing options
1638 * which have been added to @context. A side-effect of
1639 * calling this function is that g_set_prgname() will be
1642 * If the parsing is successful, any parsed arguments are
1643 * removed from the array and @argc and @argv are updated
1644 * accordingly. A '--' option is stripped from @argv
1645 * unless there are unparsed options before and after it,
1646 * or some of the options after it start with '-'. In case
1647 * of an error, @argc and @argv are left unmodified.
1649 * If automatic <option>--help</option> support is enabled
1650 * (see g_option_context_set_help_enabled()), and the
1651 * @argv array contains one of the recognized help options,
1652 * this function will produce help output to stdout and
1653 * call <literal>exit (0)</literal>.
1655 * Note that function depends on the
1656 * <link linkend="setlocale">current locale</link> for
1657 * automatic character set conversion of string and filename
1660 * Return value: %TRUE if the parsing was successful,
1661 * %FALSE if an error occurred
1666 g_option_context_parse (GOptionContext *context,
1674 /* Set program name */
1675 if (!g_get_prgname())
1677 if (argc && argv && *argc)
1681 prgname = g_path_get_basename ((*argv)[0]);
1682 g_set_prgname (prgname);
1686 g_set_prgname ("<unknown>");
1689 /* Call pre-parse hooks */
1690 list = context->groups;
1693 GOptionGroup *group = list->data;
1695 if (group->pre_parse_func)
1697 if (!(* group->pre_parse_func) (context, group,
1698 group->user_data, error))
1705 if (context->main_group && context->main_group->pre_parse_func)
1707 if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1708 context->main_group->user_data, error))
1714 gboolean stop_parsing = FALSE;
1715 gboolean has_unknown = FALSE;
1716 gint separator_pos = 0;
1718 for (i = 1; i < *argc; i++)
1721 gboolean parsed = FALSE;
1723 if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1725 if ((*argv)[i][1] == '-')
1729 arg = (*argv)[i] + 2;
1731 /* '--' terminates list of arguments */
1735 stop_parsing = TRUE;
1739 /* Handle help options */
1740 if (context->help_enabled)
1742 if (strcmp (arg, "help") == 0)
1743 print_help (context, TRUE, NULL);
1744 else if (strcmp (arg, "help-all") == 0)
1745 print_help (context, FALSE, NULL);
1746 else if (strncmp (arg, "help-", 5) == 0)
1748 list = context->groups;
1752 GOptionGroup *group = list->data;
1754 if (strcmp (arg + 5, group->name) == 0)
1755 print_help (context, FALSE, group);
1762 if (context->main_group &&
1763 !parse_long_option (context, context->main_group, &i, arg,
1764 FALSE, argc, argv, error, &parsed))
1770 /* Try the groups */
1771 list = context->groups;
1774 GOptionGroup *group = list->data;
1776 if (!parse_long_option (context, group, &i, arg,
1777 FALSE, argc, argv, error, &parsed))
1789 /* Now look for --<group>-<option> */
1790 dash = strchr (arg, '-');
1793 /* Try the groups */
1794 list = context->groups;
1797 GOptionGroup *group = list->data;
1799 if (strncmp (group->name, arg, dash - arg) == 0)
1801 if (!parse_long_option (context, group, &i, dash + 1,
1802 TRUE, argc, argv, error, &parsed))
1813 if (context->ignore_unknown)
1817 { /* short option */
1818 gint new_i = i, arg_length;
1819 gboolean *nulled_out = NULL;
1820 arg = (*argv)[i] + 1;
1821 arg_length = strlen (arg);
1822 nulled_out = g_newa (gboolean, arg_length);
1823 memset (nulled_out, 0, arg_length * sizeof (gboolean));
1824 for (j = 0; j < arg_length; j++)
1826 if (context->help_enabled && arg[j] == '?')
1827 print_help (context, TRUE, NULL);
1829 if (context->main_group &&
1830 !parse_short_option (context, context->main_group,
1832 argc, argv, error, &parsed))
1836 /* Try the groups */
1837 list = context->groups;
1840 GOptionGroup *group = list->data;
1841 if (!parse_short_option (context, group, i, &new_i, arg[j],
1842 argc, argv, error, &parsed))
1850 if (context->ignore_unknown && parsed)
1851 nulled_out[j] = TRUE;
1852 else if (context->ignore_unknown)
1856 /* !context->ignore_unknown && parsed */
1858 if (context->ignore_unknown)
1860 gchar *new_arg = NULL;
1862 for (j = 0; j < arg_length; j++)
1867 new_arg = g_malloc (arg_length + 1);
1868 new_arg[arg_index++] = arg[j];
1872 new_arg[arg_index] = '\0';
1873 add_pending_null (context, &((*argv)[i]), new_arg);
1877 add_pending_null (context, &((*argv)[i]), NULL);
1885 if (!parsed && !context->ignore_unknown)
1888 G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1889 _("Unknown option %s"), (*argv)[i]);
1895 /* Collect remaining args */
1896 if (context->main_group &&
1897 !parse_remaining_arg (context, context->main_group, &i,
1898 argc, argv, error, &parsed))
1901 if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1906 if (separator_pos > 0)
1907 add_pending_null (context, &((*argv)[separator_pos]), NULL);
1911 /* Call post-parse hooks */
1912 list = context->groups;
1915 GOptionGroup *group = list->data;
1917 if (group->post_parse_func)
1919 if (!(* group->post_parse_func) (context, group,
1920 group->user_data, error))
1927 if (context->main_group && context->main_group->post_parse_func)
1929 if (!(* context->main_group->post_parse_func) (context, context->main_group,
1930 context->main_group->user_data, error))
1936 free_pending_nulls (context, TRUE);
1938 for (i = 1; i < *argc; i++)
1940 for (k = i; k < *argc; k++)
1941 if ((*argv)[k] != NULL)
1947 for (j = i + k; j < *argc; j++)
1949 (*argv)[j-k] = (*argv)[j];
1961 /* Call error hooks */
1962 list = context->groups;
1965 GOptionGroup *group = list->data;
1967 if (group->error_func)
1968 (* group->error_func) (context, group,
1969 group->user_data, error);
1974 if (context->main_group && context->main_group->error_func)
1975 (* context->main_group->error_func) (context, context->main_group,
1976 context->main_group->user_data, error);
1978 free_changes_list (context, TRUE);
1979 free_pending_nulls (context, FALSE);
1985 * g_option_group_new:
1986 * @name: the name for the option group, this is used to provide
1987 * help for the options in this group with <option>--help-</option>@name
1988 * @description: a description for this group to be shown in
1989 * <option>--help</option>. This string is translated using the translation
1990 * domain or translation function of the group
1991 * @help_description: a description for the <option>--help-</option>@name option.
1992 * This string is translated using the translation domain or translation function
1994 * @user_data: user data that will be passed to the pre- and post-parse hooks,
1995 * the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1996 * @destroy: a function that will be called to free @user_data, or %NULL
1998 * Creates a new #GOptionGroup.
2000 * Return value: a newly created option group. It should be added
2001 * to a #GOptionContext or freed with g_option_group_free().
2006 g_option_group_new (const gchar *name,
2007 const gchar *description,
2008 const gchar *help_description,
2010 GDestroyNotify destroy)
2013 GOptionGroup *group;
2015 group = g_new0 (GOptionGroup, 1);
2016 group->name = g_strdup (name);
2017 group->description = g_strdup (description);
2018 group->help_description = g_strdup (help_description);
2019 group->user_data = user_data;
2020 group->destroy_notify = destroy;
2027 * g_option_group_free:
2028 * @group: a #GOptionGroup
2030 * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
2031 * free groups which have been added to a #GOptionContext.
2036 g_option_group_free (GOptionGroup *group)
2038 g_return_if_fail (group != NULL);
2040 g_free (group->name);
2041 g_free (group->description);
2042 g_free (group->help_description);
2044 g_free (group->entries);
2046 if (group->destroy_notify)
2047 (* group->destroy_notify) (group->user_data);
2049 if (group->translate_notify)
2050 (* group->translate_notify) (group->translate_data);
2057 * g_option_group_add_entries:
2058 * @group: a #GOptionGroup
2059 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
2061 * Adds the options specified in @entries to @group.
2066 g_option_group_add_entries (GOptionGroup *group,
2067 const GOptionEntry *entries)
2071 g_return_if_fail (entries != NULL);
2073 for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
2075 group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
2077 memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
2079 for (i = group->n_entries; i < group->n_entries + n_entries; i++)
2081 gchar c = group->entries[i].short_name;
2085 if (c == '-' || !g_ascii_isprint (c))
2087 g_warning (G_STRLOC": ignoring invalid short option '%c' (%d)", c, c);
2088 group->entries[i].short_name = 0;
2093 group->n_entries += n_entries;
2097 * g_option_group_set_parse_hooks:
2098 * @group: a #GOptionGroup
2099 * @pre_parse_func: a function to call before parsing, or %NULL
2100 * @post_parse_func: a function to call after parsing, or %NULL
2102 * Associates two functions with @group which will be called
2103 * from g_option_context_parse() before the first option is parsed
2104 * and after the last option has been parsed, respectively.
2106 * Note that the user data to be passed to @pre_parse_func and
2107 * @post_parse_func can be specified when constructing the group
2108 * with g_option_group_new().
2113 g_option_group_set_parse_hooks (GOptionGroup *group,
2114 GOptionParseFunc pre_parse_func,
2115 GOptionParseFunc post_parse_func)
2117 g_return_if_fail (group != NULL);
2119 group->pre_parse_func = pre_parse_func;
2120 group->post_parse_func = post_parse_func;
2124 * g_option_group_set_error_hook:
2125 * @group: a #GOptionGroup
2126 * @error_func: a function to call when an error occurs
2128 * Associates a function with @group which will be called
2129 * from g_option_context_parse() when an error occurs.
2131 * Note that the user data to be passed to @error_func can be
2132 * specified when constructing the group with g_option_group_new().
2137 g_option_group_set_error_hook (GOptionGroup *group,
2138 GOptionErrorFunc error_func)
2140 g_return_if_fail (group != NULL);
2142 group->error_func = error_func;
2147 * g_option_group_set_translate_func:
2148 * @group: a #GOptionGroup
2149 * @func: the #GTranslateFunc, or %NULL
2150 * @data: user data to pass to @func, or %NULL
2151 * @destroy_notify: a function which gets called to free @data, or %NULL
2153 * Sets the function which is used to translate user-visible
2154 * strings, for <option>--help</option> output. Different
2155 * groups can use different #GTranslateFunc<!-- -->s. If @func
2156 * is %NULL, strings are not translated.
2158 * If you are using gettext(), you only need to set the translation
2159 * domain, see g_option_group_set_translation_domain().
2164 g_option_group_set_translate_func (GOptionGroup *group,
2165 GTranslateFunc func,
2167 GDestroyNotify destroy_notify)
2169 g_return_if_fail (group != NULL);
2171 if (group->translate_notify)
2172 group->translate_notify (group->translate_data);
2174 group->translate_func = func;
2175 group->translate_data = data;
2176 group->translate_notify = destroy_notify;
2179 static const gchar *
2180 dgettext_swapped (const gchar *msgid,
2181 const gchar *domainname)
2183 return g_dgettext (domainname, msgid);
2187 * g_option_group_set_translation_domain:
2188 * @group: a #GOptionGroup
2189 * @domain: the domain to use
2191 * A convenience function to use gettext() for translating
2192 * user-visible strings.
2197 g_option_group_set_translation_domain (GOptionGroup *group,
2198 const gchar *domain)
2200 g_return_if_fail (group != NULL);
2202 g_option_group_set_translate_func (group,
2203 (GTranslateFunc)dgettext_swapped,
2209 * g_option_context_set_translate_func:
2210 * @context: a #GOptionContext
2211 * @func: the #GTranslateFunc, or %NULL
2212 * @data: user data to pass to @func, or %NULL
2213 * @destroy_notify: a function which gets called to free @data, or %NULL
2215 * Sets the function which is used to translate the contexts
2216 * user-visible strings, for <option>--help</option> output.
2217 * If @func is %NULL, strings are not translated.
2219 * Note that option groups have their own translation functions,
2220 * this function only affects the @parameter_string (see g_option_context_new()),
2221 * the summary (see g_option_context_set_summary()) and the description
2222 * (see g_option_context_set_description()).
2224 * If you are using gettext(), you only need to set the translation
2225 * domain, see g_option_context_set_translation_domain().
2230 g_option_context_set_translate_func (GOptionContext *context,
2231 GTranslateFunc func,
2233 GDestroyNotify destroy_notify)
2235 g_return_if_fail (context != NULL);
2237 if (context->translate_notify)
2238 context->translate_notify (context->translate_data);
2240 context->translate_func = func;
2241 context->translate_data = data;
2242 context->translate_notify = destroy_notify;
2246 * g_option_context_set_translation_domain:
2247 * @context: a #GOptionContext
2248 * @domain: the domain to use
2250 * A convenience function to use gettext() for translating
2251 * user-visible strings.
2256 g_option_context_set_translation_domain (GOptionContext *context,
2257 const gchar *domain)
2259 g_return_if_fail (context != NULL);
2261 g_option_context_set_translate_func (context,
2262 (GTranslateFunc)dgettext_swapped,
2268 * g_option_context_set_summary:
2269 * @context: a #GOptionContext
2270 * @summary: a string to be shown in <option>--help</option> output
2271 * before the list of options, or %NULL
2273 * Adds a string to be displayed in <option>--help</option> output
2274 * before the list of options. This is typically a summary of the
2275 * program functionality.
2277 * Note that the summary is translated (see
2278 * g_option_context_set_translate_func() and
2279 * g_option_context_set_translation_domain()).
2284 g_option_context_set_summary (GOptionContext *context,
2285 const gchar *summary)
2287 g_return_if_fail (context != NULL);
2289 g_free (context->summary);
2290 context->summary = g_strdup (summary);
2295 * g_option_context_get_summary:
2296 * @context: a #GOptionContext
2298 * Returns the summary. See g_option_context_set_summary().
2300 * Returns: the summary
2304 G_CONST_RETURN gchar *
2305 g_option_context_get_summary (GOptionContext *context)
2307 g_return_val_if_fail (context != NULL, NULL);
2309 return context->summary;
2313 * g_option_context_set_description:
2314 * @context: a #GOptionContext
2315 * @description: a string to be shown in <option>--help</option> output
2316 * after the list of options, or %NULL
2318 * Adds a string to be displayed in <option>--help</option> output
2319 * after the list of options. This text often includes a bug reporting
2322 * Note that the summary is translated (see
2323 * g_option_context_set_translate_func()).
2328 g_option_context_set_description (GOptionContext *context,
2329 const gchar *description)
2331 g_return_if_fail (context != NULL);
2333 g_free (context->description);
2334 context->description = g_strdup (description);
2339 * g_option_context_get_description:
2340 * @context: a #GOptionContext
2342 * Returns the description. See g_option_context_set_description().
2344 * Returns: the description
2348 G_CONST_RETURN gchar *
2349 g_option_context_get_description (GOptionContext *context)
2351 g_return_val_if_fail (context != NULL, NULL);
2353 return context->description;
2357 #define __G_OPTION_C__
2358 #include "galiasdef.c"