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