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