glib/goption.c

   1 /* goption.c - Option parser
   2  *
   3  *  Copyright (C) 1999, 2003 Red Hat Software
   4  *  Copyright (C) 2004       Anders Carlsson <andersca@gnome.org>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 /**
  23  * SECTION:option
  24  * @Short_description: parses commandline options
  25  * @Title: Commandline option parser
  26  *
  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:
  30  *
  31  * <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal>
  32  *
  33  * The example demonstrates a number of features of the GOption
  34  * commandline parser
  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>
  53  *
  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.
  63  *
  64  * <informalexample><screen>
  65  * Usage:
  66  *   testtreemodel [OPTION...] - test tree model performance
  67  *
  68  * Help Options:
  69  *   -h, --help               Show help options
  70  *   --help-all               Show all help options
  71  *   --help-gtk               Show GTK+ Options
  72  *
  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>
  81  *
  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.
  87  *
  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().
  93  *
  94  * Here is a complete example of setting up GOption to parse the example
  95  * commandline above and produce the example help output.
  96  *
  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;
 103  *
 104  * static GOptionEntry entries[] =
 105  * {
 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 },
 111  *   { NULL }
 112  * };
 113  *
 114  * int
 115  * main (int argc, char *argv[])
 116  * {
 117  *   GError *error = NULL;
 118  *   GOptionContext *context;
 119  *
 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))
 124  *     {
 125  *       g_print ("option parsing failed: %s\n", error->message);
 126  *       exit (1);
 127  *     }
 128  *
 129  *   /&ast; ... &ast;/
 130  *
 131  * }
 132  * </programlisting></informalexample>
 133  */
 134
 135 #include "config.h"
 136
 137 #include <string.h>
 138 #include <stdlib.h>
 139 #include <stdio.h>
 140 #include <errno.h>
 141
 142 #include "goption.h"
 143
 144 #include "gprintf.h"
 145 #include "glibintl.h"
 146
 147 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
 148
 149 #define NO_ARG(entry) ((entry)->arg == G_OPTION_ARG_NONE ||       \
 150                        ((entry)->arg == G_OPTION_ARG_CALLBACK &&  \
 151                         ((entry)->flags & G_OPTION_FLAG_NO_ARG)))
 152
 153 #define OPTIONAL_ARG(entry) ((entry)->arg == G_OPTION_ARG_CALLBACK &&  \
 154                        (entry)->flags & G_OPTION_FLAG_OPTIONAL_ARG)
 155
 156 typedef struct
 157 {
 158   GOptionArg arg_type;
 159   gpointer arg_data;
 160   union
 161   {
 162     gboolean bool;
 163     gint integer;
 164     gchar *str;
 165     gchar **array;
 166     gdouble dbl;
 167     gint64 int64;
 168   } prev;
 169   union
 170   {
 171     gchar *str;
 172     struct
 173     {
 174       gint len;
 175       gchar **data;
 176     } array;
 177   } allocated;
 178 } Change;
 179
 180 typedef struct
 181 {
 182   gchar **ptr;
 183   gchar *value;
 184 } PendingNull;
 185
 186 struct _GOptionContext
 187 {
 188   GList           *groups;
 189
 190   gchar           *parameter_string;
 191   gchar           *summary;
 192   gchar           *description;
 193
 194   GTranslateFunc   translate_func;
 195   GDestroyNotify   translate_notify;
 196   gpointer         translate_data;
 197
 198   guint            help_enabled   : 1;
 199   guint            ignore_unknown : 1;
 200
 201   GOptionGroup    *main_group;
 202
 203   /* We keep a list of change so we can revert them */
 204   GList           *changes;
 205
 206   /* We also keep track of all argv elements
 207    * that should be NULLed or modified.
 208    */
 209   GList           *pending_nulls;
 210 };
 211
 212 struct _GOptionGroup
 213 {
 214   gchar           *name;
 215   gchar           *description;
 216   gchar           *help_description;
 217
 218   GDestroyNotify   destroy_notify;
 219   gpointer         user_data;
 220
 221   GTranslateFunc   translate_func;
 222   GDestroyNotify   translate_notify;
 223   gpointer         translate_data;
 224
 225   GOptionEntry    *entries;
 226   gint             n_entries;
 227
 228   GOptionParseFunc pre_parse_func;
 229   GOptionParseFunc post_parse_func;
 230   GOptionErrorFunc error_func;
 231 };
 232
 233 static void free_changes_list (GOptionContext *context,
 234                                gboolean        revert);
 235 static void free_pending_nulls (GOptionContext *context,
 236                                 gboolean        perform_nulls);
 237
 238
 239 static int
 240 _g_unichar_get_width (gunichar c)
 241 {
 242   if (G_UNLIKELY (g_unichar_iszerowidth (c)))
 243     return 0;
 244
 245   /* we ignore the fact that we should call g_unichar_iswide_cjk() under
 246    * some locales (legacy East Asian ones) */
 247   if (g_unichar_iswide (c))
 248     return 2;
 249
 250   return 1;
 251 }
 252
 253 static glong
 254 _g_utf8_strwidth (const gchar *p,
 255                   gssize       max)
 256 {
 257   glong len = 0;
 258   const gchar *start = p;
 259   g_return_val_if_fail (p != NULL || max == 0, 0);
 260
 261   if (max < 0)
 262     {
 263       while (*p)
 264         {
 265           len += _g_unichar_get_width (g_utf8_get_char (p));
 266           p = g_utf8_next_char (p);
 267         }
 268     }
 269   else
 270     {
 271       if (max == 0 || !*p)
 272         return 0;
 273
 274       /* this case may not be quite correct */
 275
 276       len += _g_unichar_get_width (g_utf8_get_char (p));
 277       p = g_utf8_next_char (p);
 278
 279       while (p - start < max && *p)
 280         {
 281           len += _g_unichar_get_width (g_utf8_get_char (p));
 282           p = g_utf8_next_char (p);
 283         }
 284     }
 285
 286   return len;
 287 }
 288
 289
 290 GQuark
 291 g_option_error_quark (void)
 292 {
 293   return g_quark_from_static_string ("g-option-context-error-quark");
 294 }
 295
 296 /**
 297  * g_option_context_new:
 298  * @parameter_string: a string which is displayed in
 299  *    the first line of <option>--help</option> output, after the
 300  *    usage summary
 301  *    <literal><replaceable>programname</replaceable> [OPTION...]</literal>
 302  *
 303  * Creates a new option context.
 304  *
 305  * The @parameter_string can serve multiple purposes. It can be used
 306  * to add descriptions for "rest" arguments, which are not parsed by
 307  * the #GOptionContext, typically something like "FILES" or
 308  * "FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
 309  * collecting "rest" arguments, GLib handles this automatically by
 310  * using the @arg_description of the corresponding #GOptionEntry in
 311  * the usage summary.
 312  *
 313  * Another usage is to give a short summary of the program
 314  * functionality, like " - frob the strings", which will be displayed
 315  * in the same line as the usage. For a longer description of the
 316  * program functionality that should be displayed as a paragraph
 317  * below the usage line, use g_option_context_set_summary().
 318  *
 319  * Note that the @parameter_string is translated using the
 320  * function set with g_option_context_set_translate_func(), so
 321  * it should normally be passed untranslated.
 322  *
 323  * Returns: a newly created #GOptionContext, which must be
 324  *    freed with g_option_context_free() after use.
 325  *
 326  * Since: 2.6
 327  */
 328 GOptionContext *
 329 g_option_context_new (const gchar *parameter_string)
 330
 331 {
 332   GOptionContext *context;
 333
 334   context = g_new0 (GOptionContext, 1);
 335
 336   context->parameter_string = g_strdup (parameter_string);
 337   context->help_enabled = TRUE;
 338   context->ignore_unknown = FALSE;
 339
 340   return context;
 341 }
 342
 343 /**
 344  * g_option_context_free:
 345  * @context: a #GOptionContext
 346  *
 347  * Frees context and all the groups which have been
 348  * added to it.
 349  *
 350  * Please note that parsed arguments need to be freed separately (see
 351  * #GOptionEntry).
 352  *
 353  * Since: 2.6
 354  */
 355 void g_option_context_free (GOptionContext *context)
 356 {
 357   g_return_if_fail (context != NULL);
 358
 359   g_list_foreach (context->groups, (GFunc)g_option_group_free, NULL);
 360   g_list_free (context->groups);
 361
 362   if (context->main_group)
 363     g_option_group_free (context->main_group);
 364
 365   free_changes_list (context, FALSE);
 366   free_pending_nulls (context, FALSE);
 367
 368   g_free (context->parameter_string);
 369   g_free (context->summary);
 370   g_free (context->description);
 371
 372   if (context->translate_notify)
 373     (* context->translate_notify) (context->translate_data);
 374
 375   g_free (context);
 376 }
 377
 378
 379 /**
 380  * g_option_context_set_help_enabled:
 381  * @context: a #GOptionContext
 382  * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
 383  *
 384  * Enables or disables automatic generation of <option>--help</option>
 385  * output. By default, g_option_context_parse() recognizes
 386  * <option>--help</option>, <option>-h</option>,
 387  * <option>-?</option>, <option>--help-all</option>
 388  * and <option>--help-</option><replaceable>groupname</replaceable> and creates
 389  * suitable output to stdout.
 390  *
 391  * Since: 2.6
 392  */
 393 void g_option_context_set_help_enabled (GOptionContext *context,
 394                                         gboolean        help_enabled)
 395
 396 {
 397   g_return_if_fail (context != NULL);
 398
 399   context->help_enabled = help_enabled;
 400 }
 401
 402 /**
 403  * g_option_context_get_help_enabled:
 404  * @context: a #GOptionContext
 405  *
 406  * Returns whether automatic <option>--help</option> generation
 407  * is turned on for @context. See g_option_context_set_help_enabled().
 408  *
 409  * Returns: %TRUE if automatic help generation is turned on.
 410  *
 411  * Since: 2.6
 412  */
 413 gboolean
 414 g_option_context_get_help_enabled (GOptionContext *context)
 415 {
 416   g_return_val_if_fail (context != NULL, FALSE);
 417
 418   return context->help_enabled;
 419 }
 420
 421 /**
 422  * g_option_context_set_ignore_unknown_options:
 423  * @context: a #GOptionContext
 424  * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
 425  *    an error when unknown options are met
 426  *
 427  * Sets whether to ignore unknown options or not. If an argument is
 428  * ignored, it is left in the @argv array after parsing. By default,
 429  * g_option_context_parse() treats unknown options as error.
 430  *
 431  * This setting does not affect non-option arguments (i.e. arguments
 432  * which don't start with a dash). But note that GOption cannot reliably
 433  * determine whether a non-option belongs to a preceding unknown option.
 434  *
 435  * Since: 2.6
 436  **/
 437 void
 438 g_option_context_set_ignore_unknown_options (GOptionContext *context,
 439                                              gboolean        ignore_unknown)
 440 {
 441   g_return_if_fail (context != NULL);
 442
 443   context->ignore_unknown = ignore_unknown;
 444 }
 445
 446 /**
 447  * g_option_context_get_ignore_unknown_options:
 448  * @context: a #GOptionContext
 449  *
 450  * Returns whether unknown options are ignored or not. See
 451  * g_option_context_set_ignore_unknown_options().
 452  *
 453  * Returns: %TRUE if unknown options are ignored.
 454  *
 455  * Since: 2.6
 456  **/
 457 gboolean
 458 g_option_context_get_ignore_unknown_options (GOptionContext *context)
 459 {
 460   g_return_val_if_fail (context != NULL, FALSE);
 461
 462   return context->ignore_unknown;
 463 }
 464
 465 /**
 466  * g_option_context_add_group:
 467  * @context: a #GOptionContext
 468  * @group: the group to add
 469  *
 470  * Adds a #GOptionGroup to the @context, so that parsing with @context
 471  * will recognize the options in the group. Note that the group will
 472  * be freed together with the context when g_option_context_free() is
 473  * called, so you must not free the group yourself after adding it
 474  * to a context.
 475  *
 476  * Since: 2.6
 477  **/
 478 void
 479 g_option_context_add_group (GOptionContext *context,
 480                             GOptionGroup   *group)
 481 {
 482   GList *list;
 483
 484   g_return_if_fail (context != NULL);
 485   g_return_if_fail (group != NULL);
 486   g_return_if_fail (group->name != NULL);
 487   g_return_if_fail (group->description != NULL);
 488   g_return_if_fail (group->help_description != NULL);
 489
 490   for (list = context->groups; list; list = list->next)
 491     {
 492       GOptionGroup *g = (GOptionGroup *)list->data;
 493
 494       if ((group->name == NULL && g->name == NULL) ||
 495           (group->name && g->name && strcmp (group->name, g->name) == 0))
 496         g_warning ("A group named \"%s\" is already part of this GOptionContext",
 497                    group->name);
 498     }
 499
 500   context->groups = g_list_append (context->groups, group);
 501 }
 502
 503 /**
 504  * g_option_context_set_main_group:
 505  * @context: a #GOptionContext
 506  * @group: the group to set as main group
 507  *
 508  * Sets a #GOptionGroup as main group of the @context.
 509  * This has the same effect as calling g_option_context_add_group(),
 510  * the only difference is that the options in the main group are
 511  * treated differently when generating <option>--help</option> output.
 512  *
 513  * Since: 2.6
 514  **/
 515 void
 516 g_option_context_set_main_group (GOptionContext *context,
 517                                  GOptionGroup   *group)
 518 {
 519   g_return_if_fail (context != NULL);
 520   g_return_if_fail (group != NULL);
 521
 522   if (context->main_group)
 523     {
 524       g_warning ("This GOptionContext already has a main group");
 525
 526       return;
 527     }
 528
 529   context->main_group = group;
 530 }
 531
 532 /**
 533  * g_option_context_get_main_group:
 534  * @context: a #GOptionContext
 535  *
 536  * Returns a pointer to the main group of @context.
 537  *
 538  * Return value: the main group of @context, or %NULL if @context doesn't
 539  *  have a main group. Note that group belongs to @context and should
 540  *  not be modified or freed.
 541  *
 542  * Since: 2.6
 543  **/
 544 GOptionGroup *
 545 g_option_context_get_main_group (GOptionContext *context)
 546 {
 547   g_return_val_if_fail (context != NULL, NULL);
 548
 549   return context->main_group;
 550 }
 551
 552 /**
 553  * g_option_context_add_main_entries:
 554  * @context: a #GOptionContext
 555  * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
 556  * @translation_domain: a translation domain to use for translating
 557  *    the <option>--help</option> output for the options in @entries
 558  *    with gettext(), or %NULL
 559  *
 560  * A convenience function which creates a main group if it doesn't
 561  * exist, adds the @entries to it and sets the translation domain.
 562  *
 563  * Since: 2.6
 564  **/
 565 void
 566 g_option_context_add_main_entries (GOptionContext      *context,
 567                                    const GOptionEntry  *entries,
 568                                    const gchar         *translation_domain)
 569 {
 570   g_return_if_fail (entries != NULL);
 571
 572   if (!context->main_group)
 573     context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
 574
 575   g_option_group_add_entries (context->main_group, entries);
 576   g_option_group_set_translation_domain (context->main_group, translation_domain);
 577 }
 578
 579 static gint
 580 calculate_max_length (GOptionGroup *group)
 581 {
 582   GOptionEntry *entry;
 583   gint i, len, max_length;
 584
 585   max_length = 0;
 586
 587   for (i = 0; i < group->n_entries; i++)
 588     {
 589       entry = &group->entries[i];
 590
 591       if (entry->flags & G_OPTION_FLAG_HIDDEN)
 592         continue;
 593
 594       len = _g_utf8_strwidth (entry->long_name, -1);
 595
 596       if (entry->short_name)
 597         len += 4;
 598
 599       if (!NO_ARG (entry) && entry->arg_description)
 600         len += 1 + _g_utf8_strwidth (TRANSLATE (group, entry->arg_description), -1);
 601
 602       max_length = MAX (max_length, len);
 603     }
 604
 605   return max_length;
 606 }
 607
 608 static void
 609 print_entry (GOptionGroup       *group,
 610              gint                max_length,
 611              const GOptionEntry *entry,
 612              GString            *string)
 613 {
 614   GString *str;
 615
 616   if (entry->flags & G_OPTION_FLAG_HIDDEN)
 617     return;
 618
 619   if (entry->long_name[0] == 0)
 620     return;
 621
 622   str = g_string_new (NULL);
 623
 624   if (entry->short_name)
 625     g_string_append_printf (str, "  -%c, --%s", entry->short_name, entry->long_name);
 626   else
 627     g_string_append_printf (str, "  --%s", entry->long_name);
 628
 629   if (entry->arg_description)
 630     g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
 631
 632   g_string_append_printf (string, "%s%*s %s\n", str->str,
 633                           (int) (max_length + 4 - _g_utf8_strwidth (str->str, -1)), "",
 634                           entry->description ? TRANSLATE (group, entry->description) : "");
 635   g_string_free (str, TRUE);
 636 }
 637
 638 static gboolean
 639 group_has_visible_entries (GOptionContext *context,
 640                            GOptionGroup *group,
 641                            gboolean      main_entries)
 642 {
 643   GOptionFlags reject_filter = G_OPTION_FLAG_HIDDEN;
 644   GOptionEntry *entry;
 645   gint i, l;
 646   gboolean main_group = group == context->main_group;
 647
 648   if (!main_entries)
 649     reject_filter |= G_OPTION_FLAG_IN_MAIN;
 650
 651   for (i = 0, l = (group ? group->n_entries : 0); i < l; i++)
 652     {
 653       entry = &group->entries[i];
 654
 655       if (main_entries && !main_group && !(entry->flags & G_OPTION_FLAG_IN_MAIN))
 656         continue;
 657       if (!(entry->flags & reject_filter))
 658         return TRUE;
 659     }
 660
 661   return FALSE;
 662 }
 663
 664 static gboolean
 665 group_list_has_visible_entires (GOptionContext *context,
 666                                 GList          *group_list,
 667                                 gboolean       main_entries)
 668 {
 669   while (group_list)
 670     {
 671       if (group_has_visible_entries (context, group_list->data, main_entries))
 672         return TRUE;
 673
 674       group_list = group_list->next;
 675     }
 676
 677   return FALSE;
 678 }
 679
 680 static gboolean
 681 context_has_h_entry (GOptionContext *context)
 682 {
 683   gsize i;
 684   GList *list;
 685
 686   if (context->main_group)
 687     {
 688       for (i = 0; i < context->main_group->n_entries; i++)
 689         {
 690           if (context->main_group->entries[i].short_name == 'h')
 691             return TRUE;
 692         }
 693     }
 694
 695   for (list = context->groups; list != NULL; list = g_list_next (list))
 696     {
 697      GOptionGroup *group;
 698
 699       group = (GOptionGroup*)list->data;
 700       for (i = 0; i < group->n_entries; i++)
 701         {
 702           if (group->entries[i].short_name == 'h')
 703             return TRUE;
 704         }
 705     }
 706   return FALSE;
 707 }
 708
 709 /**
 710  * g_option_context_get_help:
 711  * @context: a #GOptionContext
 712  * @main_help: if %TRUE, only include the main group
 713  * @group: the #GOptionGroup to create help for, or %NULL
 714  *
 715  * Returns a formatted, translated help text for the given context.
 716  * To obtain the text produced by <option>--help</option>, call
 717  * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
 718  * To obtain the text produced by <option>--help-all</option>, call
 719  * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
 720  * To obtain the help text for an option group, call
 721  * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
 722  *
 723  * Returns: A newly allocated string containing the help text
 724  *
 725  * Since: 2.14
 726  */
 727 gchar *
 728 g_option_context_get_help (GOptionContext *context,
 729                            gboolean        main_help,
 730                            GOptionGroup   *group)
 731 {
 732   GList *list;
 733   gint max_length, len;
 734   gint i;
 735   GOptionEntry *entry;
 736   GHashTable *shadow_map;
 737   gboolean seen[256];
 738   const gchar *rest_description;
 739   GString *string;
 740   guchar token;
 741
 742   string = g_string_sized_new (1024);
 743
 744   rest_description = NULL;
 745   if (context->main_group)
 746     {
 747
 748       for (i = 0; i < context->main_group->n_entries; i++)
 749         {
 750           entry = &context->main_group->entries[i];
 751           if (entry->long_name[0] == 0)
 752             {
 753               rest_description = TRANSLATE (context->main_group, entry->arg_description);
 754               break;
 755             }
 756         }
 757     }
 758
 759   g_string_append_printf (string, "%s\n  %s %s",
 760                           _("Usage:"), g_get_prgname(), _("[OPTION...]"));
 761
 762   if (rest_description)
 763     {
 764       g_string_append (string, " ");
 765       g_string_append (string, rest_description);
 766     }
 767
 768   if (context->parameter_string)
 769     {
 770       g_string_append (string, " ");
 771       g_string_append (string, TRANSLATE (context, context->parameter_string));
 772     }
 773
 774   g_string_append (string, "\n\n");
 775
 776   if (context->summary)
 777     {
 778       g_string_append (string, TRANSLATE (context, context->summary));
 779       g_string_append (string, "\n\n");
 780     }
 781
 782   memset (seen, 0, sizeof (gboolean) * 256);
 783   shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
 784
 785   if (context->main_group)
 786     {
 787       for (i = 0; i < context->main_group->n_entries; i++)
 788         {
 789           entry = &context->main_group->entries[i];
 790           g_hash_table_insert (shadow_map,
 791                                (gpointer)entry->long_name,
 792                                entry);
 793
 794           if (seen[(guchar)entry->short_name])
 795             entry->short_name = 0;
 796           else
 797             seen[(guchar)entry->short_name] = TRUE;
 798         }
 799     }
 800
 801   list = context->groups;
 802   while (list != NULL)
 803     {
 804       GOptionGroup *g = list->data;
 805       for (i = 0; i < g->n_entries; i++)
 806         {
 807           entry = &g->entries[i];
 808           if (g_hash_table_lookup (shadow_map, entry->long_name) &&
 809               !(entry->flags & G_OPTION_FLAG_NOALIAS))
 810             entry->long_name = g_strdup_printf ("%s-%s", g->name, entry->long_name);
 811           else
 812             g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
 813
 814           if (seen[(guchar)entry->short_name] &&
 815               !(entry->flags & G_OPTION_FLAG_NOALIAS))
 816             entry->short_name = 0;
 817           else
 818             seen[(guchar)entry->short_name] = TRUE;
 819         }
 820       list = list->next;
 821     }
 822
 823   g_hash_table_destroy (shadow_map);
 824
 825   list = context->groups;
 826
 827   max_length = _g_utf8_strwidth ("-?, --help", -1);
 828
 829   if (list)
 830     {
 831       len = _g_utf8_strwidth ("--help-all", -1);
 832       max_length = MAX (max_length, len);
 833     }
 834
 835   if (context->main_group)
 836     {
 837       len = calculate_max_length (context->main_group);
 838       max_length = MAX (max_length, len);
 839     }
 840
 841   while (list != NULL)
 842     {
 843       GOptionGroup *g = list->data;
 844
 845       /* First, we check the --help-<groupname> options */
 846       len = _g_utf8_strwidth ("--help-", -1) + _g_utf8_strwidth (g->name, -1);
 847       max_length = MAX (max_length, len);
 848
 849       /* Then we go through the entries */
 850       len = calculate_max_length (g);
 851       max_length = MAX (max_length, len);
 852
 853       list = list->next;
 854     }
 855
 856   /* Add a bit of padding */
 857   max_length += 4;
 858
 859   if (!group)
 860     {
 861       list = context->groups;
 862
 863       token = context_has_h_entry (context) ? '?' : 'h';
 864
 865       g_string_append_printf (string, "%s\n  -%c, --%-*s %s\n",
 866                               _("Help Options:"), token, max_length - 4, "help",
 867                               _("Show help options"));
 868
 869       /* We only want --help-all when there are groups */
 870       if (list)
 871         g_string_append_printf (string, "  --%-*s %s\n",
 872                                 max_length, "help-all",
 873                                 _("Show all help options"));
 874
 875       while (list)
 876         {
 877           GOptionGroup *g = list->data;
 878
 879           if (group_has_visible_entries (context, g, FALSE))
 880             g_string_append_printf (string, "  --help-%-*s %s\n",
 881                                     max_length - 5, g->name,
 882                                     TRANSLATE (g, g->help_description));
 883
 884           list = list->next;
 885         }
 886
 887       g_string_append (string, "\n");
 888     }
 889
 890   if (group)
 891     {
 892       /* Print a certain group */
 893
 894       if (group_has_visible_entries (context, group, FALSE))
 895         {
 896           g_string_append (string, TRANSLATE (group, group->description));
 897           g_string_append (string, "\n");
 898           for (i = 0; i < group->n_entries; i++)
 899             print_entry (group, max_length, &group->entries[i], string);
 900           g_string_append (string, "\n");
 901         }
 902     }
 903   else if (!main_help)
 904     {
 905       /* Print all groups */
 906
 907       list = context->groups;
 908
 909       while (list)
 910         {
 911           GOptionGroup *g = list->data;
 912
 913           if (group_has_visible_entries (context, g, FALSE))
 914             {
 915               g_string_append (string, g->description);
 916               g_string_append (string, "\n");
 917               for (i = 0; i < g->n_entries; i++)
 918                 if (!(g->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
 919                   print_entry (g, max_length, &g->entries[i], string);
 920
 921               g_string_append (string, "\n");
 922             }
 923
 924           list = list->next;
 925         }
 926     }
 927
 928   /* Print application options if --help or --help-all has been specified */
 929   if ((main_help || !group) &&
 930       (group_has_visible_entries (context, context->main_group, TRUE) ||
 931        group_list_has_visible_entires (context, context->groups, TRUE)))
 932     {
 933       list = context->groups;
 934
 935       g_string_append (string,  _("Application Options:"));
 936       g_string_append (string, "\n");
 937       if (context->main_group)
 938         for (i = 0; i < context->main_group->n_entries; i++)
 939           print_entry (context->main_group, max_length,
 940                        &context->main_group->entries[i], string);
 941
 942       while (list != NULL)
 943         {
 944           GOptionGroup *g = list->data;
 945
 946           /* Print main entries from other groups */
 947           for (i = 0; i < g->n_entries; i++)
 948             if (g->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
 949               print_entry (g, max_length, &g->entries[i], string);
 950
 951           list = list->next;
 952         }
 953
 954       g_string_append (string, "\n");
 955     }
 956
 957   if (context->description)
 958     {
 959       g_string_append (string, TRANSLATE (context, context->description));
 960       g_string_append (string, "\n");
 961     }
 962
 963   return g_string_free (string, FALSE);
 964 }
 965
 966 G_GNUC_NORETURN
 967 static void
 968 print_help (GOptionContext *context,
 969             gboolean        main_help,
 970             GOptionGroup   *group)
 971 {
 972   gchar *help;
 973
 974   help = g_option_context_get_help (context, main_help, group);
 975   g_print ("%s", help);
 976   g_free (help);
 977
 978   exit (0);
 979 }
 980
 981 static gboolean
 982 parse_int (const gchar *arg_name,
 983            const gchar *arg,
 984            gint        *result,
 985            GError     **error)
 986 {
 987   gchar *end;
 988   glong tmp;
 989
 990   errno = 0;
 991   tmp = strtol (arg, &end, 0);
 992
 993   if (*arg == '\0' || *end != '\0')
 994     {
 995       g_set_error (error,
 996                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 997                    _("Cannot parse integer value '%s' for %s"),
 998                    arg, arg_name);
 999       return FALSE;
1000     }
1001
1002   *result = tmp;
1003   if (*result != tmp || errno == ERANGE)
1004     {
1005       g_set_error (error,
1006                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1007                    _("Integer value '%s' for %s out of range"),
1008                    arg, arg_name);
1009       return FALSE;
1010     }
1011
1012   return TRUE;
1013 }
1014
1015
1016 static gboolean
1017 parse_double (const gchar *arg_name,
1018            const gchar *arg,
1019            gdouble        *result,
1020            GError     **error)
1021 {
1022   gchar *end;
1023   gdouble tmp;
1024
1025   errno = 0;
1026   tmp = g_strtod (arg, &end);
1027
1028   if (*arg == '\0' || *end != '\0')
1029     {
1030       g_set_error (error,
1031                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1032                    _("Cannot parse double value '%s' for %s"),
1033                    arg, arg_name);
1034       return FALSE;
1035     }
1036   if (errno == ERANGE)
1037     {
1038       g_set_error (error,
1039                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1040                    _("Double value '%s' for %s out of range"),
1041                    arg, arg_name);
1042       return FALSE;
1043     }
1044
1045   *result = tmp;
1046
1047   return TRUE;
1048 }
1049
1050
1051 static gboolean
1052 parse_int64 (const gchar *arg_name,
1053              const gchar *arg,
1054              gint64      *result,
1055              GError     **error)
1056 {
1057   gchar *end;
1058   gint64 tmp;
1059
1060   errno = 0;
1061   tmp = g_ascii_strtoll (arg, &end, 0);
1062
1063   if (*arg == '\0' || *end != '\0')
1064     {
1065       g_set_error (error,
1066                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1067                    _("Cannot parse integer value '%s' for %s"),
1068                    arg, arg_name);
1069       return FALSE;
1070     }
1071   if (errno == ERANGE)
1072     {
1073       g_set_error (error,
1074                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1075                    _("Integer value '%s' for %s out of range"),
1076                    arg, arg_name);
1077       return FALSE;
1078     }
1079
1080   *result = tmp;
1081
1082   return TRUE;
1083 }
1084
1085
1086 static Change *
1087 get_change (GOptionContext *context,
1088             GOptionArg      arg_type,
1089             gpointer        arg_data)
1090 {
1091   GList *list;
1092   Change *change = NULL;
1093
1094   for (list = context->changes; list != NULL; list = list->next)
1095     {
1096       change = list->data;
1097
1098       if (change->arg_data == arg_data)
1099         goto found;
1100     }
1101
1102   change = g_new0 (Change, 1);
1103   change->arg_type = arg_type;
1104   change->arg_data = arg_data;
1105
1106   context->changes = g_list_prepend (context->changes, change);
1107
1108  found:
1109
1110   return change;
1111 }
1112
1113 static void
1114 add_pending_null (GOptionContext *context,
1115                   gchar         **ptr,
1116                   gchar          *value)
1117 {
1118   PendingNull *n;
1119
1120   n = g_new0 (PendingNull, 1);
1121   n->ptr = ptr;
1122   n->value = value;
1123
1124   context->pending_nulls = g_list_prepend (context->pending_nulls, n);
1125 }
1126
1127 static gboolean
1128 parse_arg (GOptionContext *context,
1129            GOptionGroup   *group,
1130            GOptionEntry   *entry,
1131            const gchar    *value,
1132            const gchar    *option_name,
1133            GError        **error)
1134
1135 {
1136   Change *change;
1137
1138   g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
1139
1140   switch (entry->arg)
1141     {
1142     case G_OPTION_ARG_NONE:
1143       {
1144         change = get_change (context, G_OPTION_ARG_NONE,
1145                              entry->arg_data);
1146
1147         *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1148         break;
1149       }
1150     case G_OPTION_ARG_STRING:
1151       {
1152         gchar *data;
1153
1154         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1155
1156         if (!data)
1157           return FALSE;
1158
1159         change = get_change (context, G_OPTION_ARG_STRING,
1160                              entry->arg_data);
1161         g_free (change->allocated.str);
1162
1163         change->prev.str = *(gchar **)entry->arg_data;
1164         change->allocated.str = data;
1165
1166         *(gchar **)entry->arg_data = data;
1167         break;
1168       }
1169     case G_OPTION_ARG_STRING_ARRAY:
1170       {
1171         gchar *data;
1172
1173         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1174
1175         if (!data)
1176           return FALSE;
1177
1178         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1179                              entry->arg_data);
1180
1181         if (change->allocated.array.len == 0)
1182           {
1183             change->prev.array = *(gchar ***)entry->arg_data;
1184             change->allocated.array.data = g_new (gchar *, 2);
1185           }
1186         else
1187           change->allocated.array.data =
1188             g_renew (gchar *, change->allocated.array.data,
1189                      change->allocated.array.len + 2);
1190
1191         change->allocated.array.data[change->allocated.array.len] = data;
1192         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1193
1194         change->allocated.array.len ++;
1195
1196         *(gchar ***)entry->arg_data = change->allocated.array.data;
1197
1198         break;
1199       }
1200
1201     case G_OPTION_ARG_FILENAME:
1202       {
1203         gchar *data;
1204
1205 #ifdef G_OS_WIN32
1206         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1207
1208         if (!data)
1209           return FALSE;
1210 #else
1211         data = g_strdup (value);
1212 #endif
1213         change = get_change (context, G_OPTION_ARG_FILENAME,
1214                              entry->arg_data);
1215         g_free (change->allocated.str);
1216
1217         change->prev.str = *(gchar **)entry->arg_data;
1218         change->allocated.str = data;
1219
1220         *(gchar **)entry->arg_data = data;
1221         break;
1222       }
1223
1224     case G_OPTION_ARG_FILENAME_ARRAY:
1225       {
1226         gchar *data;
1227
1228 #ifdef G_OS_WIN32
1229         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1230
1231         if (!data)
1232           return FALSE;
1233 #else
1234         data = g_strdup (value);
1235 #endif
1236         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1237                              entry->arg_data);
1238
1239         if (change->allocated.array.len == 0)
1240           {
1241             change->prev.array = *(gchar ***)entry->arg_data;
1242             change->allocated.array.data = g_new (gchar *, 2);
1243           }
1244         else
1245           change->allocated.array.data =
1246             g_renew (gchar *, change->allocated.array.data,
1247                      change->allocated.array.len + 2);
1248
1249         change->allocated.array.data[change->allocated.array.len] = data;
1250         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1251
1252         change->allocated.array.len ++;
1253
1254         *(gchar ***)entry->arg_data = change->allocated.array.data;
1255
1256         break;
1257       }
1258
1259     case G_OPTION_ARG_INT:
1260       {
1261         gint data;
1262
1263         if (!parse_int (option_name, value,
1264                         &data,
1265                         error))
1266           return FALSE;
1267
1268         change = get_change (context, G_OPTION_ARG_INT,
1269                              entry->arg_data);
1270         change->prev.integer = *(gint *)entry->arg_data;
1271         *(gint *)entry->arg_data = data;
1272         break;
1273       }
1274     case G_OPTION_ARG_CALLBACK:
1275       {
1276         gchar *data;
1277         gboolean retval;
1278
1279         if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1280           data = NULL;
1281         else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1282           data = NULL;
1283         else if (entry->flags & G_OPTION_FLAG_FILENAME)
1284           {
1285 #ifdef G_OS_WIN32
1286             data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1287 #else
1288             data = g_strdup (value);
1289 #endif
1290           }
1291         else
1292           data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1293
1294         if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1295             !data)
1296           return FALSE;
1297
1298         retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1299
1300         if (!retval && error != NULL && *error == NULL)
1301           g_set_error (error,
1302                        G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1303                        _("Error parsing option %s"), option_name);
1304
1305         g_free (data);
1306
1307         return retval;
1308
1309         break;
1310       }
1311     case G_OPTION_ARG_DOUBLE:
1312       {
1313         gdouble data;
1314
1315         if (!parse_double (option_name, value,
1316                         &data,
1317                         error))
1318           {
1319             return FALSE;
1320           }
1321
1322         change = get_change (context, G_OPTION_ARG_DOUBLE,
1323                              entry->arg_data);
1324         change->prev.dbl = *(gdouble *)entry->arg_data;
1325         *(gdouble *)entry->arg_data = data;
1326         break;
1327       }
1328     case G_OPTION_ARG_INT64:
1329       {
1330         gint64 data;
1331
1332         if (!parse_int64 (option_name, value,
1333                          &data,
1334                          error))
1335           {
1336             return FALSE;
1337           }
1338
1339         change = get_change (context, G_OPTION_ARG_INT64,
1340                              entry->arg_data);
1341         change->prev.int64 = *(gint64 *)entry->arg_data;
1342         *(gint64 *)entry->arg_data = data;
1343         break;
1344       }
1345     default:
1346       g_assert_not_reached ();
1347     }
1348
1349   return TRUE;
1350 }
1351
1352 static gboolean
1353 parse_short_option (GOptionContext *context,
1354                     GOptionGroup   *group,
1355                     gint            idx,
1356                     gint           *new_idx,
1357                     gchar           arg,
1358                     gint           *argc,
1359                     gchar        ***argv,
1360                     GError        **error,
1361                     gboolean       *parsed)
1362 {
1363   gint j;
1364
1365   for (j = 0; j < group->n_entries; j++)
1366     {
1367       if (arg == group->entries[j].short_name)
1368         {
1369           gchar *option_name;
1370           gchar *value = NULL;
1371
1372           option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1373
1374           if (NO_ARG (&group->entries[j]))
1375             value = NULL;
1376           else
1377             {
1378               if (*new_idx > idx)
1379                 {
1380                   g_set_error (error,
1381                                G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1382                                _("Error parsing option %s"), option_name);
1383                   g_free (option_name);
1384                   return FALSE;
1385                 }
1386
1387               if (idx < *argc - 1)
1388                 {
1389                   if (!OPTIONAL_ARG (&group->entries[j]))
1390                     {
1391                       value = (*argv)[idx + 1];
1392                       add_pending_null (context, &((*argv)[idx + 1]), NULL);
1393                       *new_idx = idx + 1;
1394                     }
1395                   else
1396                     {
1397                       if ((*argv)[idx + 1][0] == '-')
1398                         value = NULL;
1399                       else
1400                         {
1401                           value = (*argv)[idx + 1];
1402                           add_pending_null (context, &((*argv)[idx + 1]), NULL);
1403                           *new_idx = idx + 1;
1404                         }
1405                     }
1406                 }
1407               else if (idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1408                 value = NULL;
1409               else
1410                 {
1411                   g_set_error (error,
1412                                G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1413                                _("Missing argument for %s"), option_name);
1414                   g_free (option_name);
1415                   return FALSE;
1416                 }
1417             }
1418
1419           if (!parse_arg (context, group, &group->entries[j],
1420                           value, option_name, error))
1421             {
1422               g_free (option_name);
1423               return FALSE;
1424             }
1425
1426           g_free (option_name);
1427           *parsed = TRUE;
1428         }
1429     }
1430
1431   return TRUE;
1432 }
1433
1434 static gboolean
1435 parse_long_option (GOptionContext *context,
1436                    GOptionGroup   *group,
1437                    gint           *idx,
1438                    gchar          *arg,
1439                    gboolean        aliased,
1440                    gint           *argc,
1441                    gchar        ***argv,
1442                    GError        **error,
1443                    gboolean       *parsed)
1444 {
1445   gint j;
1446
1447   for (j = 0; j < group->n_entries; j++)
1448     {
1449       if (*idx >= *argc)
1450         return TRUE;
1451
1452       if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1453         continue;
1454
1455       if (NO_ARG (&group->entries[j]) &&
1456           strcmp (arg, group->entries[j].long_name) == 0)
1457         {
1458           gchar *option_name;
1459           gboolean retval;
1460
1461           option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1462           retval = parse_arg (context, group, &group->entries[j],
1463                               NULL, option_name, error);
1464           g_free (option_name);
1465
1466           add_pending_null (context, &((*argv)[*idx]), NULL);
1467           *parsed = TRUE;
1468
1469           return retval;
1470         }
1471       else
1472         {
1473           gint len = strlen (group->entries[j].long_name);
1474
1475           if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1476               (arg[len] == '=' || arg[len] == 0))
1477             {
1478               gchar *value = NULL;
1479               gchar *option_name;
1480
1481               add_pending_null (context, &((*argv)[*idx]), NULL);
1482               option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1483
1484               if (arg[len] == '=')
1485                 value = arg + len + 1;
1486               else if (*idx < *argc - 1)
1487                 {
1488                   if (!OPTIONAL_ARG (&group->entries[j]))
1489                     {
1490                       value = (*argv)[*idx + 1];
1491                       add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1492                       (*idx)++;
1493                     }
1494                   else
1495                     {
1496                       if ((*argv)[*idx + 1][0] == '-')
1497                         {
1498                           gboolean retval;
1499                           retval = parse_arg (context, group, &group->entries[j],
1500                                               NULL, option_name, error);
1501                           *parsed = TRUE;
1502                           g_free (option_name);
1503                           return retval;
1504                         }
1505                       else
1506                         {
1507                           value = (*argv)[*idx + 1];
1508                           add_pending_null (context, &((*argv)[*idx + 1]), NULL);
1509                           (*idx)++;
1510                         }
1511                     }
1512                 }
1513               else if (*idx >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1514                 {
1515                     gboolean retval;
1516                     retval = parse_arg (context, group, &group->entries[j],
1517                                         NULL, option_name, error);
1518                     *parsed = TRUE;
1519                     g_free (option_name);
1520                     return retval;
1521                 }
1522               else
1523                 {
1524                   g_set_error (error,
1525                                G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1526                                _("Missing argument for %s"), option_name);
1527                   g_free (option_name);
1528                   return FALSE;
1529                 }
1530
1531               if (!parse_arg (context, group, &group->entries[j],
1532                               value, option_name, error))
1533                 {
1534                   g_free (option_name);
1535                   return FALSE;
1536                 }
1537
1538               g_free (option_name);
1539               *parsed = TRUE;
1540             }
1541         }
1542     }
1543
1544   return TRUE;
1545 }
1546
1547 static gboolean
1548 parse_remaining_arg (GOptionContext *context,
1549                      GOptionGroup   *group,
1550                      gint           *idx,
1551                      gint           *argc,
1552                      gchar        ***argv,
1553                      GError        **error,
1554                      gboolean       *parsed)
1555 {
1556   gint j;
1557
1558   for (j = 0; j < group->n_entries; j++)
1559     {
1560       if (*idx >= *argc)
1561         return TRUE;
1562
1563       if (group->entries[j].long_name[0])
1564         continue;
1565
1566       g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1567                             group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1568                             group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1569
1570       add_pending_null (context, &((*argv)[*idx]), NULL);
1571
1572       if (!parse_arg (context, group, &group->entries[j], (*argv)[*idx], "", error))
1573         return FALSE;
1574
1575       *parsed = TRUE;
1576       return TRUE;
1577     }
1578
1579   return TRUE;
1580 }
1581
1582 static void
1583 free_changes_list (GOptionContext *context,
1584                    gboolean        revert)
1585 {
1586   GList *list;
1587
1588   for (list = context->changes; list != NULL; list = list->next)
1589     {
1590       Change *change = list->data;
1591
1592       if (revert)
1593         {
1594           switch (change->arg_type)
1595             {
1596             case G_OPTION_ARG_NONE:
1597               *(gboolean *)change->arg_data = change->prev.bool;
1598               break;
1599             case G_OPTION_ARG_INT:
1600               *(gint *)change->arg_data = change->prev.integer;
1601               break;
1602             case G_OPTION_ARG_STRING:
1603             case G_OPTION_ARG_FILENAME:
1604               g_free (change->allocated.str);
1605               *(gchar **)change->arg_data = change->prev.str;
1606               break;
1607             case G_OPTION_ARG_STRING_ARRAY:
1608             case G_OPTION_ARG_FILENAME_ARRAY:
1609               g_strfreev (change->allocated.array.data);
1610               *(gchar ***)change->arg_data = change->prev.array;
1611               break;
1612             case G_OPTION_ARG_DOUBLE:
1613               *(gdouble *)change->arg_data = change->prev.dbl;
1614               break;
1615             case G_OPTION_ARG_INT64:
1616               *(gint64 *)change->arg_data = change->prev.int64;
1617               break;
1618             default:
1619               g_assert_not_reached ();
1620             }
1621         }
1622
1623       g_free (change);
1624     }
1625
1626   g_list_free (context->changes);
1627   context->changes = NULL;
1628 }
1629
1630 static void
1631 free_pending_nulls (GOptionContext *context,
1632                     gboolean        perform_nulls)
1633 {
1634   GList *list;
1635
1636   for (list = context->pending_nulls; list != NULL; list = list->next)
1637     {
1638       PendingNull *n = list->data;
1639
1640       if (perform_nulls)
1641         {
1642           if (n->value)
1643             {
1644               /* Copy back the short options */
1645               *(n->ptr)[0] = '-';
1646               strcpy (*n->ptr + 1, n->value);
1647             }
1648           else
1649             *n->ptr = NULL;
1650         }
1651
1652       g_free (n->value);
1653       g_free (n);
1654     }
1655
1656   g_list_free (context->pending_nulls);
1657   context->pending_nulls = NULL;
1658 }
1659
1660 /* Use a platform-specific mechanism to look up the first argument to
1661  * the current process.
1662  * Note if you implement this for other platforms, also add it to
1663  * tests/option-argv0.c
1664  */
1665 static char *
1666 platform_get_argv0 (void)
1667 {
1668 #ifdef __linux
1669   char *cmdline;
1670   char *base_arg0;
1671   gsize len;
1672
1673   if (!g_file_get_contents ("/proc/self/cmdline",
1674                             &cmdline,
1675                             &len,
1676                             NULL))
1677     return NULL;
1678   /* Sanity check for a NUL terminator. */
1679   if (!memchr (cmdline, 0, len))
1680     return NULL;
1681   /* We could just return cmdline, but I think it's better
1682    * to hold on to a smaller malloc block; the arguments
1683    * could be large.
1684    */
1685   base_arg0 = g_path_get_basename (cmdline);
1686   g_free (cmdline);
1687   return base_arg0;
1688 #endif
1689
1690   return NULL;
1691 }
1692
1693 /**
1694  * g_option_context_parse:
1695  * @context: a #GOptionContext
1696  * @argc: a pointer to the number of command line arguments
1697  * @argv: a pointer to the array of command line arguments
1698  * @error: a return location for errors
1699  *
1700  * Parses the command line arguments, recognizing options
1701  * which have been added to @context. A side-effect of
1702  * calling this function is that g_set_prgname() will be
1703  * called.
1704  *
1705  * If the parsing is successful, any parsed arguments are
1706  * removed from the array and @argc and @argv are updated
1707  * accordingly. A '--' option is stripped from @argv
1708  * unless there are unparsed options before and after it,
1709  * or some of the options after it start with '-'. In case
1710  * of an error, @argc and @argv are left unmodified.
1711  *
1712  * If automatic <option>--help</option> support is enabled
1713  * (see g_option_context_set_help_enabled()), and the
1714  * @argv array contains one of the recognized help options,
1715  * this function will produce help output to stdout and
1716  * call <literal>exit (0)</literal>.
1717  *
1718  * Note that function depends on the
1719  * <link linkend="setlocale">current locale</link> for
1720  * automatic character set conversion of string and filename
1721  * arguments.
1722  *
1723  * Return value: %TRUE if the parsing was successful,
1724  *               %FALSE if an error occurred
1725  *
1726  * Since: 2.6
1727  **/
1728 gboolean
1729 g_option_context_parse (GOptionContext   *context,
1730                         gint             *argc,
1731                         gchar          ***argv,
1732                         GError          **error)
1733 {
1734   gint i, j, k;
1735   GList *list;
1736
1737   /* Set program name */
1738   if (!g_get_prgname())
1739     {
1740       gchar *prgname;
1741
1742       if (argc && argv && *argc)
1743         prgname = g_path_get_basename ((*argv)[0]);
1744       else
1745         prgname = platform_get_argv0 ();
1746
1747       if (prgname)
1748         g_set_prgname (prgname);
1749       else
1750         g_set_prgname ("<unknown>");
1751
1752       g_free (prgname);
1753     }
1754
1755   /* Call pre-parse hooks */
1756   list = context->groups;
1757   while (list)
1758     {
1759       GOptionGroup *group = list->data;
1760
1761       if (group->pre_parse_func)
1762         {
1763           if (!(* group->pre_parse_func) (context, group,
1764                                           group->user_data, error))
1765             goto fail;
1766         }
1767
1768       list = list->next;
1769     }
1770
1771   if (context->main_group && context->main_group->pre_parse_func)
1772     {
1773       if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1774                                                     context->main_group->user_data, error))
1775         goto fail;
1776     }
1777
1778   if (argc && argv)
1779     {
1780       gboolean stop_parsing = FALSE;
1781       gboolean has_unknown = FALSE;
1782       gint separator_pos = 0;
1783
1784       for (i = 1; i < *argc; i++)
1785         {
1786           gchar *arg, *dash;
1787           gboolean parsed = FALSE;
1788
1789           if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1790             {
1791               if ((*argv)[i][1] == '-')
1792                 {
1793                   /* -- option */
1794
1795                   arg = (*argv)[i] + 2;
1796
1797                   /* '--' terminates list of arguments */
1798                   if (*arg == 0)
1799                     {
1800                       separator_pos = i;
1801                       stop_parsing = TRUE;
1802                       continue;
1803                     }
1804
1805                   /* Handle help options */
1806                   if (context->help_enabled)
1807                     {
1808                       if (strcmp (arg, "help") == 0)
1809                         print_help (context, TRUE, NULL);
1810                       else if (strcmp (arg, "help-all") == 0)
1811                         print_help (context, FALSE, NULL);
1812                       else if (strncmp (arg, "help-", 5) == 0)
1813                         {
1814                           list = context->groups;
1815
1816                           while (list)
1817                             {
1818                               GOptionGroup *group = list->data;
1819
1820                               if (strcmp (arg + 5, group->name) == 0)
1821                                 print_help (context, FALSE, group);
1822
1823                               list = list->next;
1824                             }
1825                         }
1826                     }
1827
1828                   if (context->main_group &&
1829                       !parse_long_option (context, context->main_group, &i, arg,
1830                                           FALSE, argc, argv, error, &parsed))
1831                     goto fail;
1832
1833                   if (parsed)
1834                     continue;
1835
1836                   /* Try the groups */
1837                   list = context->groups;
1838                   while (list)
1839                     {
1840                       GOptionGroup *group = list->data;
1841
1842                       if (!parse_long_option (context, group, &i, arg,
1843                                               FALSE, argc, argv, error, &parsed))
1844                         goto fail;
1845
1846                       if (parsed)
1847                         break;
1848
1849                       list = list->next;
1850                     }
1851
1852                   if (parsed)
1853                     continue;
1854
1855                   /* Now look for --<group>-<option> */
1856                   dash = strchr (arg, '-');
1857                   if (dash)
1858                     {
1859                       /* Try the groups */
1860                       list = context->groups;
1861                       while (list)
1862                         {
1863                           GOptionGroup *group = list->data;
1864
1865                           if (strncmp (group->name, arg, dash - arg) == 0)
1866                             {
1867                               if (!parse_long_option (context, group, &i, dash + 1,
1868                                                       TRUE, argc, argv, error, &parsed))
1869                                 goto fail;
1870
1871                               if (parsed)
1872                                 break;
1873                             }
1874
1875                           list = list->next;
1876                         }
1877                     }
1878
1879                   if (context->ignore_unknown)
1880                     continue;
1881                 }
1882               else
1883                 { /* short option */
1884                   gint new_i = i, arg_length;
1885                   gboolean *nulled_out = NULL;
1886                   gboolean has_h_entry = context_has_h_entry (context);
1887                   arg = (*argv)[i] + 1;
1888                   arg_length = strlen (arg);
1889                   nulled_out = g_newa (gboolean, arg_length);
1890                   memset (nulled_out, 0, arg_length * sizeof (gboolean));
1891                   for (j = 0; j < arg_length; j++)
1892                     {
1893                       if (context->help_enabled && (arg[j] == '?' ||
1894                         (arg[j] == 'h' && !has_h_entry)))
1895                         print_help (context, TRUE, NULL);
1896                       parsed = FALSE;
1897                       if (context->main_group &&
1898                           !parse_short_option (context, context->main_group,
1899                                                i, &new_i, arg[j],
1900                                                argc, argv, error, &parsed))
1901                         goto fail;
1902                       if (!parsed)
1903                         {
1904                           /* Try the groups */
1905                           list = context->groups;
1906                           while (list)
1907                             {
1908                               GOptionGroup *group = list->data;
1909                               if (!parse_short_option (context, group, i, &new_i, arg[j],
1910                                                        argc, argv, error, &parsed))
1911                                 goto fail;
1912                               if (parsed)
1913                                 break;
1914                               list = list->next;
1915                             }
1916                         }
1917
1918                       if (context->ignore_unknown && parsed)
1919                         nulled_out[j] = TRUE;
1920                       else if (context->ignore_unknown)
1921                         continue;
1922                       else if (!parsed)
1923                         break;
1924                       /* !context->ignore_unknown && parsed */
1925                     }
1926                   if (context->ignore_unknown)
1927                     {
1928                       gchar *new_arg = NULL;
1929                       gint arg_index = 0;
1930                       for (j = 0; j < arg_length; j++)
1931                         {
1932                           if (!nulled_out[j])
1933                             {
1934                               if (!new_arg)
1935                                 new_arg = g_malloc (arg_length + 1);
1936                               new_arg[arg_index++] = arg[j];
1937                             }
1938                         }
1939                       if (new_arg)
1940                         new_arg[arg_index] = '\0';
1941                       add_pending_null (context, &((*argv)[i]), new_arg);
1942                     }
1943                   else if (parsed)
1944                     {
1945                       add_pending_null (context, &((*argv)[i]), NULL);
1946                       i = new_i;
1947                     }
1948                 }
1949
1950               if (!parsed)
1951                 has_unknown = TRUE;
1952
1953               if (!parsed && !context->ignore_unknown)
1954                 {
1955                   g_set_error (error,
1956                                G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1957                                    _("Unknown option %s"), (*argv)[i]);
1958                   goto fail;
1959                 }
1960             }
1961           else
1962             {
1963               /* Collect remaining args */
1964               if (context->main_group &&
1965                   !parse_remaining_arg (context, context->main_group, &i,
1966                                         argc, argv, error, &parsed))
1967                 goto fail;
1968
1969               if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1970                 separator_pos = 0;
1971             }
1972         }
1973
1974       if (separator_pos > 0)
1975         add_pending_null (context, &((*argv)[separator_pos]), NULL);
1976
1977     }
1978
1979   /* Call post-parse hooks */
1980   list = context->groups;
1981   while (list)
1982     {
1983       GOptionGroup *group = list->data;
1984
1985       if (group->post_parse_func)
1986         {
1987           if (!(* group->post_parse_func) (context, group,
1988                                            group->user_data, error))
1989             goto fail;
1990         }
1991
1992       list = list->next;
1993     }
1994
1995   if (context->main_group && context->main_group->post_parse_func)
1996     {
1997       if (!(* context->main_group->post_parse_func) (context, context->main_group,
1998                                                      context->main_group->user_data, error))
1999         goto fail;
2000     }
2001
2002   if (argc && argv)
2003     {
2004       free_pending_nulls (context, TRUE);
2005
2006       for (i = 1; i < *argc; i++)
2007         {
2008           for (k = i; k < *argc; k++)
2009             if ((*argv)[k] != NULL)
2010               break;
2011
2012           if (k > i)
2013             {
2014               k -= i;
2015               for (j = i + k; j < *argc; j++)
2016                 {
2017                   (*argv)[j-k] = (*argv)[j];
2018                   (*argv)[j] = NULL;
2019                 }
2020               *argc -= k;
2021             }
2022         }
2023     }
2024
2025   return TRUE;
2026
2027  fail:
2028
2029   /* Call error hooks */
2030   list = context->groups;
2031   while (list)
2032     {
2033       GOptionGroup *group = list->data;
2034
2035       if (group->error_func)
2036         (* group->error_func) (context, group,
2037                                group->user_data, error);
2038
2039       list = list->next;
2040     }
2041
2042   if (context->main_group && context->main_group->error_func)
2043     (* context->main_group->error_func) (context, context->main_group,
2044                                          context->main_group->user_data, error);
2045
2046   free_changes_list (context, TRUE);
2047   free_pending_nulls (context, FALSE);
2048
2049   return FALSE;
2050 }
2051
2052 /**
2053  * g_option_group_new:
2054  * @name: the name for the option group, this is used to provide
2055  *   help for the options in this group with <option>--help-</option>@name
2056  * @description: a description for this group to be shown in
2057  *   <option>--help</option>. This string is translated using the translation
2058  *   domain or translation function of the group
2059  * @help_description: a description for the <option>--help-</option>@name option.
2060  *   This string is translated using the translation domain or translation function
2061  *   of the group
2062  * @user_data: user data that will be passed to the pre- and post-parse hooks,
2063  *   the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
2064  * @destroy: a function that will be called to free @user_data, or %NULL
2065  *
2066  * Creates a new #GOptionGroup.
2067  *
2068  * Return value: a newly created option group. It should be added
2069  *   to a #GOptionContext or freed with g_option_group_free().
2070  *
2071  * Since: 2.6
2072  **/
2073 GOptionGroup *
2074 g_option_group_new (const gchar    *name,
2075                     const gchar    *description,
2076                     const gchar    *help_description,
2077                     gpointer        user_data,
2078                     GDestroyNotify  destroy)
2079
2080 {
2081   GOptionGroup *group;
2082
2083   group = g_new0 (GOptionGroup, 1);
2084   group->name = g_strdup (name);
2085   group->description = g_strdup (description);
2086   group->help_description = g_strdup (help_description);
2087   group->user_data = user_data;
2088   group->destroy_notify = destroy;
2089
2090   return group;
2091 }
2092
2093
2094 /**
2095  * g_option_group_free:
2096  * @group: a #GOptionGroup
2097  *
2098  * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
2099  * free groups which have been added to a #GOptionContext.
2100  *
2101  * Since: 2.6
2102  **/
2103 void
2104 g_option_group_free (GOptionGroup *group)
2105 {
2106   g_return_if_fail (group != NULL);
2107
2108   g_free (group->name);
2109   g_free (group->description);
2110   g_free (group->help_description);
2111
2112   g_free (group->entries);
2113
2114   if (group->destroy_notify)
2115     (* group->destroy_notify) (group->user_data);
2116
2117   if (group->translate_notify)
2118     (* group->translate_notify) (group->translate_data);
2119
2120   g_free (group);
2121 }
2122
2123
2124 /**
2125  * g_option_group_add_entries:
2126  * @group: a #GOptionGroup
2127  * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
2128  *
2129  * Adds the options specified in @entries to @group.
2130  *
2131  * Since: 2.6
2132  **/
2133 void
2134 g_option_group_add_entries (GOptionGroup       *group,
2135                             const GOptionEntry *entries)
2136 {
2137   gint i, n_entries;
2138
2139   g_return_if_fail (entries != NULL);
2140
2141   for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
2142
2143   group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
2144
2145   memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
2146
2147   for (i = group->n_entries; i < group->n_entries + n_entries; i++)
2148     {
2149       gchar c = group->entries[i].short_name;
2150
2151       if (c == '-' || (c != 0 && !g_ascii_isprint (c)))
2152         {
2153           g_warning (G_STRLOC ": ignoring invalid short option '%c' (%d)", c, c);
2154           group->entries[i].short_name = 0;
2155         }
2156
2157       if (group->entries[i].arg != G_OPTION_ARG_NONE &&
2158           (group->entries[i].flags & G_OPTION_FLAG_REVERSE) != 0)
2159         {
2160           g_warning (G_STRLOC ": ignoring reverse flag on option of type %d", group->entries[i].arg);
2161
2162           group->entries[i].flags &= ~G_OPTION_FLAG_REVERSE;
2163         }
2164
2165       if (group->entries[i].arg != G_OPTION_ARG_CALLBACK &&
2166           (group->entries[i].flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME)) != 0)
2167         {
2168           g_warning (G_STRLOC ": ignoring no-arg, optional-arg or filename flags (%d) on option of type %d", group->entries[i].flags, group->entries[i].arg);
2169
2170           group->entries[i].flags &= ~(G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG|G_OPTION_FLAG_FILENAME);
2171         }
2172     }
2173
2174   group->n_entries += n_entries;
2175 }
2176
2177 /**
2178  * g_option_group_set_parse_hooks:
2179  * @group: a #GOptionGroup
2180  * @pre_parse_func: a function to call before parsing, or %NULL
2181  * @post_parse_func: a function to call after parsing, or %NULL
2182  *
2183  * Associates two functions with @group which will be called
2184  * from g_option_context_parse() before the first option is parsed
2185  * and after the last option has been parsed, respectively.
2186  *
2187  * Note that the user data to be passed to @pre_parse_func and
2188  * @post_parse_func can be specified when constructing the group
2189  * with g_option_group_new().
2190  *
2191  * Since: 2.6
2192  **/
2193 void
2194 g_option_group_set_parse_hooks (GOptionGroup     *group,
2195                                 GOptionParseFunc  pre_parse_func,
2196                                 GOptionParseFunc  post_parse_func)
2197 {
2198   g_return_if_fail (group != NULL);
2199
2200   group->pre_parse_func = pre_parse_func;
2201   group->post_parse_func = post_parse_func;
2202 }
2203
2204 /**
2205  * g_option_group_set_error_hook:
2206  * @group: a #GOptionGroup
2207  * @error_func: a function to call when an error occurs
2208  *
2209  * Associates a function with @group which will be called
2210  * from g_option_context_parse() when an error occurs.
2211  *
2212  * Note that the user data to be passed to @error_func can be
2213  * specified when constructing the group with g_option_group_new().
2214  *
2215  * Since: 2.6
2216  **/
2217 void
2218 g_option_group_set_error_hook (GOptionGroup     *group,
2219                                GOptionErrorFunc  error_func)
2220 {
2221   g_return_if_fail (group != NULL);
2222
2223   group->error_func = error_func;
2224 }
2225
2226
2227 /**
2228  * g_option_group_set_translate_func:
2229  * @group: a #GOptionGroup
2230  * @func: the #GTranslateFunc, or %NULL
2231  * @data: user data to pass to @func, or %NULL
2232  * @destroy_notify: a function which gets called to free @data, or %NULL
2233  *
2234  * Sets the function which is used to translate user-visible
2235  * strings, for <option>--help</option> output. Different
2236  * groups can use different #GTranslateFunc<!-- -->s. If @func
2237  * is %NULL, strings are not translated.
2238  *
2239  * If you are using gettext(), you only need to set the translation
2240  * domain, see g_option_group_set_translation_domain().
2241  *
2242  * Since: 2.6
2243  **/
2244 void
2245 g_option_group_set_translate_func (GOptionGroup   *group,
2246                                    GTranslateFunc  func,
2247                                    gpointer        data,
2248                                    GDestroyNotify  destroy_notify)
2249 {
2250   g_return_if_fail (group != NULL);
2251
2252   if (group->translate_notify)
2253     group->translate_notify (group->translate_data);
2254
2255   group->translate_func = func;
2256   group->translate_data = data;
2257   group->translate_notify = destroy_notify;
2258 }
2259
2260 static const gchar *
2261 dgettext_swapped (const gchar *msgid,
2262                   const gchar *domainname)
2263 {
2264   return g_dgettext (domainname, msgid);
2265 }
2266
2267 /**
2268  * g_option_group_set_translation_domain:
2269  * @group: a #GOptionGroup
2270  * @domain: the domain to use
2271  *
2272  * A convenience function to use gettext() for translating
2273  * user-visible strings.
2274  *
2275  * Since: 2.6
2276  **/
2277 void
2278 g_option_group_set_translation_domain (GOptionGroup *group,
2279                                        const gchar  *domain)
2280 {
2281   g_return_if_fail (group != NULL);
2282
2283   g_option_group_set_translate_func (group,
2284                                      (GTranslateFunc)dgettext_swapped,
2285                                      g_strdup (domain),
2286                                      g_free);
2287 }
2288
2289 /**
2290  * g_option_context_set_translate_func:
2291  * @context: a #GOptionContext
2292  * @func: the #GTranslateFunc, or %NULL
2293  * @data: user data to pass to @func, or %NULL
2294  * @destroy_notify: a function which gets called to free @data, or %NULL
2295  *
2296  * Sets the function which is used to translate the contexts
2297  * user-visible strings, for <option>--help</option> output.
2298  * If @func is %NULL, strings are not translated.
2299  *
2300  * Note that option groups have their own translation functions,
2301  * this function only affects the @parameter_string (see g_option_context_new()),
2302  * the summary (see g_option_context_set_summary()) and the description
2303  * (see g_option_context_set_description()).
2304  *
2305  * If you are using gettext(), you only need to set the translation
2306  * domain, see g_option_context_set_translation_domain().
2307  *
2308  * Since: 2.12
2309  **/
2310 void
2311 g_option_context_set_translate_func (GOptionContext *context,
2312                                      GTranslateFunc func,
2313                                      gpointer       data,
2314                                      GDestroyNotify destroy_notify)
2315 {
2316   g_return_if_fail (context != NULL);
2317
2318   if (context->translate_notify)
2319     context->translate_notify (context->translate_data);
2320
2321   context->translate_func = func;
2322   context->translate_data = data;
2323   context->translate_notify = destroy_notify;
2324 }
2325
2326 /**
2327  * g_option_context_set_translation_domain:
2328  * @context: a #GOptionContext
2329  * @domain: the domain to use
2330  *
2331  * A convenience function to use gettext() for translating
2332  * user-visible strings.
2333  *
2334  * Since: 2.12
2335  **/
2336 void
2337 g_option_context_set_translation_domain (GOptionContext *context,
2338                                          const gchar     *domain)
2339 {
2340   g_return_if_fail (context != NULL);
2341
2342   g_option_context_set_translate_func (context,
2343                                        (GTranslateFunc)dgettext_swapped,
2344                                        g_strdup (domain),
2345                                        g_free);
2346 }
2347
2348 /**
2349  * g_option_context_set_summary:
2350  * @context: a #GOptionContext
2351  * @summary: a string to be shown in <option>--help</option> output
2352  *  before the list of options, or %NULL
2353  *
2354  * Adds a string to be displayed in <option>--help</option> output
2355  * before the list of options. This is typically a summary of the
2356  * program functionality.
2357  *
2358  * Note that the summary is translated (see
2359  * g_option_context_set_translate_func() and
2360  * g_option_context_set_translation_domain()).
2361  *
2362  * Since: 2.12
2363  */
2364 void
2365 g_option_context_set_summary (GOptionContext *context,
2366                               const gchar    *summary)
2367 {
2368   g_return_if_fail (context != NULL);
2369
2370   g_free (context->summary);
2371   context->summary = g_strdup (summary);
2372 }
2373
2374
2375 /**
2376  * g_option_context_get_summary:
2377  * @context: a #GOptionContext
2378  *
2379  * Returns the summary. See g_option_context_set_summary().
2380  *
2381  * Returns: the summary
2382  *
2383  * Since: 2.12
2384  */
2385 G_CONST_RETURN gchar *
2386 g_option_context_get_summary (GOptionContext *context)
2387 {
2388   g_return_val_if_fail (context != NULL, NULL);
2389
2390   return context->summary;
2391 }
2392
2393 /**
2394  * g_option_context_set_description:
2395  * @context: a #GOptionContext
2396  * @description: a string to be shown in <option>--help</option> output
2397  *   after the list of options, or %NULL
2398  *
2399  * Adds a string to be displayed in <option>--help</option> output
2400  * after the list of options. This text often includes a bug reporting
2401  * address.
2402  *
2403  * Note that the summary is translated (see
2404  * g_option_context_set_translate_func()).
2405  *
2406  * Since: 2.12
2407  */
2408 void
2409 g_option_context_set_description (GOptionContext *context,
2410                                   const gchar    *description)
2411 {
2412   g_return_if_fail (context != NULL);
2413
2414   g_free (context->description);
2415   context->description = g_strdup (description);
2416 }
2417
2418
2419 /**
2420  * g_option_context_get_description:
2421  * @context: a #GOptionContext
2422  *
2423  * Returns the description. See g_option_context_set_description().
2424  *
2425  * Returns: the description
2426  *
2427  * Since: 2.12
2428  */
2429 G_CONST_RETURN gchar *
2430 g_option_context_get_description (GOptionContext *context)
2431 {
2432   g_return_val_if_fail (context != NULL, NULL);
2433
2434   return context->description;
2435 }