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       if (group_has_visible_entries (context, group_list->data, main_entries))
 557         return TRUE;
 558
 559       group_list = group_list->next;
 560     }
 561
 562   return FALSE;
 563 }
 564
 565 /**
 566  * g_option_context_get_help:
 567  * @context: a #GOptionContext
 568  * @main_help: if %TRUE, only include the main group
 569  * @group: the #GOptionGroup to create help for, or %NULL
 570  *
 571  * Returns a formatted, translated help text for the given context.
 572  * To obtain the text produced by <option>--help</option>, call
 573  * <literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
 574  * To obtain the text produced by <option>--help-all</option>, call
 575  * <literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
 576  * To obtain the help text for an option group, call
 577  * <literal>g_option_context_get_help (context, FALSE, group)</literal>.
 578  *
 579  * Returns: A newly allocated string containing the help text
 580  *
 581  * Since: 2.14
 582  */
 583 gchar *
 584 g_option_context_get_help (GOptionContext *context,
 585                            gboolean        main_help,
 586                            GOptionGroup   *group)
 587 {
 588   GList *list;
 589   gint max_length, len;
 590   gint i;
 591   GOptionEntry *entry;
 592   GHashTable *shadow_map;
 593   gboolean seen[256];
 594   const gchar *rest_description;
 595   GString *string;
 596
 597   string = g_string_sized_new (1024);
 598
 599   rest_description = NULL;
 600   if (context->main_group)
 601     {
 602
 603       for (i = 0; i < context->main_group->n_entries; i++)
 604         {
 605           entry = &context->main_group->entries[i];
 606           if (entry->long_name[0] == 0)
 607             {
 608               rest_description = TRANSLATE (context->main_group, entry->arg_description);
 609               break;
 610             }
 611         }
 612     }
 613
 614   g_string_append_printf (string, "%s\n  %s %s",
 615                           _("Usage:"), g_get_prgname(), _("[OPTION...]"));
 616
 617   if (rest_description)
 618     {
 619       g_string_append (string, " ");
 620       g_string_append (string, rest_description);
 621     }
 622
 623   if (context->parameter_string)
 624     {
 625       g_string_append (string, " ");
 626       g_string_append (string, TRANSLATE (context, context->parameter_string));
 627     }
 628
 629   g_string_append (string, "\n\n");
 630
 631   if (context->summary)
 632     {
 633       g_string_append (string, TRANSLATE (context, context->summary));
 634       g_string_append (string, "\n\n");
 635     }
 636
 637   memset (seen, 0, sizeof (gboolean) * 256);
 638   shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
 639
 640   if (context->main_group)
 641     {
 642       for (i = 0; i < context->main_group->n_entries; i++)
 643         {
 644           entry = &context->main_group->entries[i];
 645           g_hash_table_insert (shadow_map,
 646                                (gpointer)entry->long_name,
 647                                entry);
 648
 649           if (seen[(guchar)entry->short_name])
 650             entry->short_name = 0;
 651           else
 652             seen[(guchar)entry->short_name] = TRUE;
 653         }
 654     }
 655
 656   list = context->groups;
 657   while (list != NULL)
 658     {
 659       GOptionGroup *group = list->data;
 660       for (i = 0; i < group->n_entries; i++)
 661         {
 662           entry = &group->entries[i];
 663           if (g_hash_table_lookup (shadow_map, entry->long_name) &&
 664               !(entry->flags & G_OPTION_FLAG_NOALIAS))
 665             entry->long_name = g_strdup_printf ("%s-%s", group->name, entry->long_name);
 666           else
 667             g_hash_table_insert (shadow_map, (gpointer)entry->long_name, entry);
 668
 669           if (seen[(guchar)entry->short_name] &&
 670               !(entry->flags & G_OPTION_FLAG_NOALIAS))
 671             entry->short_name = 0;
 672           else
 673             seen[(guchar)entry->short_name] = TRUE;
 674         }
 675       list = list->next;
 676     }
 677
 678   g_hash_table_destroy (shadow_map);
 679
 680   list = context->groups;
 681
 682   max_length = _g_utf8_strwidth ("-?, --help", -1);
 683
 684   if (list)
 685     {
 686       len = _g_utf8_strwidth ("--help-all", -1);
 687       max_length = MAX (max_length, len);
 688     }
 689
 690   if (context->main_group)
 691     {
 692       len = calculate_max_length (context->main_group);
 693       max_length = MAX (max_length, len);
 694     }
 695
 696   while (list != NULL)
 697     {
 698       GOptionGroup *group = list->data;
 699
 700       /* First, we check the --help-<groupname> options */
 701       len = _g_utf8_strwidth ("--help-", -1) + _g_utf8_strwidth (group->name, -1);
 702       max_length = MAX (max_length, len);
 703
 704       /* Then we go through the entries */
 705       len = calculate_max_length (group);
 706       max_length = MAX (max_length, len);
 707
 708       list = list->next;
 709     }
 710
 711   /* Add a bit of padding */
 712   max_length += 4;
 713
 714   if (!group)
 715     {
 716       list = context->groups;
 717
 718       g_string_append_printf (string, "%s\n  -%c, --%-*s %s\n",
 719                               _("Help Options:"), '?', max_length - 4, "help",
 720                               _("Show help options"));
 721
 722       /* We only want --help-all when there are groups */
 723       if (list)
 724         g_string_append_printf (string, "  --%-*s %s\n",
 725                                 max_length, "help-all",
 726                                 _("Show all help options"));
 727
 728       while (list)
 729         {
 730           GOptionGroup *group = list->data;
 731
 732           if (group_has_visible_entries (context, group, FALSE))
 733             g_string_append_printf (string, "  --help-%-*s %s\n",
 734                                     max_length - 5, group->name,
 735                                     TRANSLATE (group, group->help_description));
 736
 737           list = list->next;
 738         }
 739
 740       g_string_append (string, "\n");
 741     }
 742
 743   if (group)
 744     {
 745       /* Print a certain group */
 746
 747       if (group_has_visible_entries (context, group, FALSE))
 748         {
 749           g_string_append (string, TRANSLATE (group, group->description));
 750           g_string_append (string, "\n");
 751           for (i = 0; i < group->n_entries; i++)
 752             print_entry (group, max_length, &group->entries[i], string);
 753           g_string_append (string, "\n");
 754         }
 755     }
 756   else if (!main_help)
 757     {
 758       /* Print all groups */
 759
 760       list = context->groups;
 761
 762       while (list)
 763         {
 764           GOptionGroup *group = list->data;
 765
 766           if (group_has_visible_entries (context, group, FALSE))
 767             {
 768               g_string_append (string, group->description);
 769               g_string_append (string, "\n");
 770               for (i = 0; i < group->n_entries; i++)
 771                 if (!(group->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
 772                   print_entry (group, max_length, &group->entries[i], string);
 773
 774               g_string_append (string, "\n");
 775             }
 776
 777           list = list->next;
 778         }
 779     }
 780
 781   /* Print application options if --help or --help-all has been specified */
 782   if ((main_help || !group) &&
 783       (group_has_visible_entries (context, context->main_group, TRUE) ||
 784        group_list_has_visible_entires (context, context->groups, TRUE)))
 785     {
 786       list = context->groups;
 787
 788       g_string_append (string,  _("Application Options:"));
 789       g_string_append (string, "\n");
 790       if (context->main_group)
 791         for (i = 0; i < context->main_group->n_entries; i++)
 792           print_entry (context->main_group, max_length,
 793                        &context->main_group->entries[i], string);
 794
 795       while (list != NULL)
 796         {
 797           GOptionGroup *group = list->data;
 798
 799           /* Print main entries from other groups */
 800           for (i = 0; i < group->n_entries; i++)
 801             if (group->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
 802               print_entry (group, max_length, &group->entries[i], string);
 803
 804           list = list->next;
 805         }
 806
 807       g_string_append (string, "\n");
 808     }
 809
 810   if (context->description)
 811     {
 812       g_string_append (string, TRANSLATE (context, context->description));
 813       g_string_append (string, "\n");
 814     }
 815
 816   return g_string_free (string, FALSE);
 817 }
 818
 819 static void
 820 print_help (GOptionContext *context,
 821             gboolean        main_help,
 822             GOptionGroup   *group)
 823 {
 824   gchar *help;
 825
 826   help = g_option_context_get_help (context, main_help, group);
 827   g_print ("%s", help);
 828   g_free (help);
 829
 830   exit (0);
 831 }
 832
 833 static gboolean
 834 parse_int (const gchar *arg_name,
 835            const gchar *arg,
 836            gint        *result,
 837            GError     **error)
 838 {
 839   gchar *end;
 840   glong tmp;
 841
 842   errno = 0;
 843   tmp = strtol (arg, &end, 0);
 844
 845   if (*arg == '\0' || *end != '\0')
 846     {
 847       g_set_error (error,
 848                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 849                    _("Cannot parse integer value '%s' for %s"),
 850                    arg, arg_name);
 851       return FALSE;
 852     }
 853
 854   *result = tmp;
 855   if (*result != tmp || errno == ERANGE)
 856     {
 857       g_set_error (error,
 858                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 859                    _("Integer value '%s' for %s out of range"),
 860                    arg, arg_name);
 861       return FALSE;
 862     }
 863
 864   return TRUE;
 865 }
 866
 867
 868 static gboolean
 869 parse_double (const gchar *arg_name,
 870            const gchar *arg,
 871            gdouble        *result,
 872            GError     **error)
 873 {
 874   gchar *end;
 875   gdouble tmp;
 876
 877   errno = 0;
 878   tmp = g_strtod (arg, &end);
 879
 880   if (*arg == '\0' || *end != '\0')
 881     {
 882       g_set_error (error,
 883                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 884                    _("Cannot parse double value '%s' for %s"),
 885                    arg, arg_name);
 886       return FALSE;
 887     }
 888   if (errno == ERANGE)
 889     {
 890       g_set_error (error,
 891                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 892                    _("Double value '%s' for %s out of range"),
 893                    arg, arg_name);
 894       return FALSE;
 895     }
 896
 897   *result = tmp;
 898
 899   return TRUE;
 900 }
 901
 902
 903 static gboolean
 904 parse_int64 (const gchar *arg_name,
 905              const gchar *arg,
 906              gint64      *result,
 907              GError     **error)
 908 {
 909   gchar *end;
 910   gint64 tmp;
 911
 912   errno = 0;
 913   tmp = g_ascii_strtoll (arg, &end, 0);
 914
 915   if (*arg == '\0' || *end != '\0')
 916     {
 917       g_set_error (error,
 918                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 919                    _("Cannot parse integer value '%s' for %s"),
 920                    arg, arg_name);
 921       return FALSE;
 922     }
 923   if (errno == ERANGE)
 924     {
 925       g_set_error (error,
 926                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 927                    _("Integer value '%s' for %s out of range"),
 928                    arg, arg_name);
 929       return FALSE;
 930     }
 931
 932   *result = tmp;
 933
 934   return TRUE;
 935 }
 936
 937
 938 static Change *
 939 get_change (GOptionContext *context,
 940             GOptionArg      arg_type,
 941             gpointer        arg_data)
 942 {
 943   GList *list;
 944   Change *change = NULL;
 945
 946   for (list = context->changes; list != NULL; list = list->next)
 947     {
 948       change = list->data;
 949
 950       if (change->arg_data == arg_data)
 951         goto found;
 952     }
 953
 954   change = g_new0 (Change, 1);
 955   change->arg_type = arg_type;
 956   change->arg_data = arg_data;
 957
 958   context->changes = g_list_prepend (context->changes, change);
 959
 960  found:
 961
 962   return change;
 963 }
 964
 965 static void
 966 add_pending_null (GOptionContext *context,
 967                   gchar         **ptr,
 968                   gchar          *value)
 969 {
 970   PendingNull *n;
 971
 972   n = g_new0 (PendingNull, 1);
 973   n->ptr = ptr;
 974   n->value = value;
 975
 976   context->pending_nulls = g_list_prepend (context->pending_nulls, n);
 977 }
 978
 979 static gboolean
 980 parse_arg (GOptionContext *context,
 981            GOptionGroup   *group,
 982            GOptionEntry   *entry,
 983            const gchar    *value,
 984            const gchar    *option_name,
 985            GError        **error)
 986
 987 {
 988   Change *change;
 989
 990   g_assert (value || OPTIONAL_ARG (entry) || NO_ARG (entry));
 991
 992   switch (entry->arg)
 993     {
 994     case G_OPTION_ARG_NONE:
 995       {
 996         change = get_change (context, G_OPTION_ARG_NONE,
 997                              entry->arg_data);
 998
 999         *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
1000         break;
1001       }
1002     case G_OPTION_ARG_STRING:
1003       {
1004         gchar *data;
1005
1006         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1007
1008         if (!data)
1009           return FALSE;
1010
1011         change = get_change (context, G_OPTION_ARG_STRING,
1012                              entry->arg_data);
1013         g_free (change->allocated.str);
1014
1015         change->prev.str = *(gchar **)entry->arg_data;
1016         change->allocated.str = data;
1017
1018         *(gchar **)entry->arg_data = data;
1019         break;
1020       }
1021     case G_OPTION_ARG_STRING_ARRAY:
1022       {
1023         gchar *data;
1024
1025         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1026
1027         if (!data)
1028           return FALSE;
1029
1030         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1031                              entry->arg_data);
1032
1033         if (change->allocated.array.len == 0)
1034           {
1035             change->prev.array = *(gchar ***)entry->arg_data;
1036             change->allocated.array.data = g_new (gchar *, 2);
1037           }
1038         else
1039           change->allocated.array.data =
1040             g_renew (gchar *, change->allocated.array.data,
1041                      change->allocated.array.len + 2);
1042
1043         change->allocated.array.data[change->allocated.array.len] = data;
1044         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1045
1046         change->allocated.array.len ++;
1047
1048         *(gchar ***)entry->arg_data = change->allocated.array.data;
1049
1050         break;
1051       }
1052
1053     case G_OPTION_ARG_FILENAME:
1054       {
1055         gchar *data;
1056
1057 #ifdef G_OS_WIN32
1058         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1059
1060         if (!data)
1061           return FALSE;
1062 #else
1063         data = g_strdup (value);
1064 #endif
1065         change = get_change (context, G_OPTION_ARG_FILENAME,
1066                              entry->arg_data);
1067         g_free (change->allocated.str);
1068
1069         change->prev.str = *(gchar **)entry->arg_data;
1070         change->allocated.str = data;
1071
1072         *(gchar **)entry->arg_data = data;
1073         break;
1074       }
1075
1076     case G_OPTION_ARG_FILENAME_ARRAY:
1077       {
1078         gchar *data;
1079
1080 #ifdef G_OS_WIN32
1081         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1082
1083         if (!data)
1084           return FALSE;
1085 #else
1086         data = g_strdup (value);
1087 #endif
1088         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
1089                              entry->arg_data);
1090
1091         if (change->allocated.array.len == 0)
1092           {
1093             change->prev.array = *(gchar ***)entry->arg_data;
1094             change->allocated.array.data = g_new (gchar *, 2);
1095           }
1096         else
1097           change->allocated.array.data =
1098             g_renew (gchar *, change->allocated.array.data,
1099                      change->allocated.array.len + 2);
1100
1101         change->allocated.array.data[change->allocated.array.len] = data;
1102         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
1103
1104         change->allocated.array.len ++;
1105
1106         *(gchar ***)entry->arg_data = change->allocated.array.data;
1107
1108         break;
1109       }
1110
1111     case G_OPTION_ARG_INT:
1112       {
1113         gint data;
1114
1115         if (!parse_int (option_name, value,
1116                         &data,
1117                         error))
1118           return FALSE;
1119
1120         change = get_change (context, G_OPTION_ARG_INT,
1121                              entry->arg_data);
1122         change->prev.integer = *(gint *)entry->arg_data;
1123         *(gint *)entry->arg_data = data;
1124         break;
1125       }
1126     case G_OPTION_ARG_CALLBACK:
1127       {
1128         gchar *data;
1129         gboolean retval;
1130
1131         if (!value && entry->flags & G_OPTION_FLAG_OPTIONAL_ARG)
1132           data = NULL;
1133         else if (entry->flags & G_OPTION_FLAG_NO_ARG)
1134           data = NULL;
1135         else if (entry->flags & G_OPTION_FLAG_FILENAME)
1136           {
1137 #ifdef G_OS_WIN32
1138             data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1139 #else
1140             data = g_strdup (value);
1141 #endif
1142           }
1143         else
1144           data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
1145
1146         if (!(entry->flags & (G_OPTION_FLAG_NO_ARG|G_OPTION_FLAG_OPTIONAL_ARG)) &&
1147             !data)
1148           return FALSE;
1149
1150         retval = (* (GOptionArgFunc) entry->arg_data) (option_name, data, group->user_data, error);
1151
1152         g_free (data);
1153
1154         return retval;
1155
1156         break;
1157       }
1158     case G_OPTION_ARG_DOUBLE:
1159       {
1160         gdouble data;
1161
1162         if (!parse_double (option_name, value,
1163                         &data,
1164                         error))
1165           {
1166             return FALSE;
1167           }
1168
1169         change = get_change (context, G_OPTION_ARG_DOUBLE,
1170                              entry->arg_data);
1171         change->prev.dbl = *(gdouble *)entry->arg_data;
1172         *(gdouble *)entry->arg_data = data;
1173         break;
1174       }
1175     case G_OPTION_ARG_INT64:
1176       {
1177         gint64 data;
1178
1179         if (!parse_int64 (option_name, value,
1180                          &data,
1181                          error))
1182           {
1183             return FALSE;
1184           }
1185
1186         change = get_change (context, G_OPTION_ARG_INT64,
1187                              entry->arg_data);
1188         change->prev.int64 = *(gint64 *)entry->arg_data;
1189         *(gint64 *)entry->arg_data = data;
1190         break;
1191       }
1192     default:
1193       g_assert_not_reached ();
1194     }
1195
1196   return TRUE;
1197 }
1198
1199 static gboolean
1200 parse_short_option (GOptionContext *context,
1201                     GOptionGroup   *group,
1202                     gint            index,
1203                     gint           *new_index,
1204                     gchar           arg,
1205                     gint           *argc,
1206                     gchar        ***argv,
1207                     GError        **error,
1208                     gboolean       *parsed)
1209 {
1210   gint j;
1211
1212   for (j = 0; j < group->n_entries; j++)
1213     {
1214       if (arg == group->entries[j].short_name)
1215         {
1216           gchar *option_name;
1217           gchar *value = NULL;
1218
1219           option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
1220
1221           if (NO_ARG (&group->entries[j]))
1222             value = NULL;
1223           else
1224             {
1225               if (*new_index > index)
1226                 {
1227                   g_set_error (error,
1228                                G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
1229                                _("Error parsing option %s"), option_name);
1230                   g_free (option_name);
1231                   return FALSE;
1232                 }
1233
1234               if (index < *argc - 1)
1235                 {
1236                   if (!OPTIONAL_ARG (&group->entries[j]))
1237                     {
1238                       value = (*argv)[index + 1];
1239                       add_pending_null (context, &((*argv)[index + 1]), NULL);
1240                       *new_index = index+1;
1241                     }
1242                   else
1243                     {
1244                       if ((*argv)[index + 1][0] == '-')
1245                         value = NULL;
1246                       else
1247                         {
1248                           value = (*argv)[index + 1];
1249                           add_pending_null (context, &((*argv)[index + 1]), NULL);
1250                           *new_index = index + 1;
1251                         }
1252                     }
1253                 }
1254               else if (index >= *argc - 1 && OPTIONAL_ARG (&group->entries[j]))
1255                 value = NULL;
1256               else
1257                 {
1258                   g_set_error (error,
1259                                G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1260                                _("Missing argument for %s"), option_name);
1261                   g_free (option_name);
1262                   return FALSE;
1263                 }
1264             }
1265
1266           if (!parse_arg (context, group, &group->entries[j],
1267                           value, option_name, error))
1268             {
1269               g_free (option_name);
1270               return FALSE;
1271             }
1272
1273           g_free (option_name);
1274           *parsed = TRUE;
1275         }
1276     }
1277
1278   return TRUE;
1279 }
1280
1281 static gboolean
1282 parse_long_option (GOptionContext *context,
1283                    GOptionGroup   *group,
1284                    gint           *index,
1285                    gchar          *arg,
1286                    gboolean        aliased,
1287                    gint           *argc,
1288                    gchar        ***argv,
1289                    GError        **error,
1290                    gboolean       *parsed)
1291 {
1292   gint j;
1293
1294   for (j = 0; j < group->n_entries; j++)
1295     {
1296       if (*index >= *argc)
1297         return TRUE;
1298
1299       if (aliased && (group->entries[j].flags & G_OPTION_FLAG_NOALIAS))
1300         continue;
1301
1302       if (NO_ARG (&group->entries[j]) &&
1303           strcmp (arg, group->entries[j].long_name) == 0)
1304         {
1305           gchar *option_name;
1306
1307           option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1308           parse_arg (context, group, &group->entries[j],
1309                      NULL, option_name, error);
1310           g_free(option_name);
1311
1312           add_pending_null (context, &((*argv)[*index]), NULL);
1313           *parsed = TRUE;
1314         }
1315       else
1316         {
1317           gint len = strlen (group->entries[j].long_name);
1318
1319           if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
1320               (arg[len] == '=' || arg[len] == 0))
1321             {
1322               gchar *value = NULL;
1323               gchar *option_name;
1324
1325               add_pending_null (context, &((*argv)[*index]), NULL);
1326               option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
1327
1328               if (arg[len] == '=')
1329                 value = arg + len + 1;
1330               else if (*index < *argc - 1)
1331                 {
1332                   if (!(group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG))
1333                     {
1334                       value = (*argv)[*index + 1];
1335                       add_pending_null (context, &((*argv)[*index + 1]), NULL);
1336                       (*index)++;
1337                     }
1338                   else
1339                     {
1340                       if ((*argv)[*index + 1][0] == '-')
1341                         {
1342                           gboolean retval;
1343                           retval = parse_arg (context, group, &group->entries[j],
1344                                               NULL, option_name, error);
1345                           *parsed = TRUE;
1346                           g_free (option_name);
1347                           return retval;
1348                         }
1349                       else
1350                         {
1351                           value = (*argv)[*index + 1];
1352                           add_pending_null (context, &((*argv)[*index + 1]), NULL);
1353                           (*index)++;
1354                         }
1355                     }
1356                 }
1357               else if (*index >= *argc - 1 &&
1358                        group->entries[j].flags & G_OPTION_FLAG_OPTIONAL_ARG)
1359                 {
1360                     gboolean retval;
1361                     retval = parse_arg (context, group, &group->entries[j],
1362                                         NULL, option_name, error);
1363                     *parsed = TRUE;
1364                     g_free (option_name);
1365                     return retval;
1366                 }
1367               else
1368                 {
1369                   g_set_error (error,
1370                                G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
1371                                _("Missing argument for %s"), option_name);
1372                   g_free (option_name);
1373                   return FALSE;
1374                 }
1375
1376               if (!parse_arg (context, group, &group->entries[j],
1377                               value, option_name, error))
1378                 {
1379                   g_free (option_name);
1380                   return FALSE;
1381                 }
1382
1383               g_free (option_name);
1384               *parsed = TRUE;
1385             }
1386         }
1387     }
1388
1389   return TRUE;
1390 }
1391
1392 static gboolean
1393 parse_remaining_arg (GOptionContext *context,
1394                      GOptionGroup   *group,
1395                      gint           *index,
1396                      gint           *argc,
1397                      gchar        ***argv,
1398                      GError        **error,
1399                      gboolean       *parsed)
1400 {
1401   gint j;
1402
1403   for (j = 0; j < group->n_entries; j++)
1404     {
1405       if (*index >= *argc)
1406         return TRUE;
1407
1408       if (group->entries[j].long_name[0])
1409         continue;
1410
1411       g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_CALLBACK ||
1412                             group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
1413                             group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
1414
1415       add_pending_null (context, &((*argv)[*index]), NULL);
1416
1417       if (!parse_arg (context, group, &group->entries[j], (*argv)[*index], "", error))
1418         return FALSE;
1419
1420       *parsed = TRUE;
1421       return TRUE;
1422     }
1423
1424   return TRUE;
1425 }
1426
1427 static void
1428 free_changes_list (GOptionContext *context,
1429                    gboolean        revert)
1430 {
1431   GList *list;
1432
1433   for (list = context->changes; list != NULL; list = list->next)
1434     {
1435       Change *change = list->data;
1436
1437       if (revert)
1438         {
1439           switch (change->arg_type)
1440             {
1441             case G_OPTION_ARG_NONE:
1442               *(gboolean *)change->arg_data = change->prev.bool;
1443               break;
1444             case G_OPTION_ARG_INT:
1445               *(gint *)change->arg_data = change->prev.integer;
1446               break;
1447             case G_OPTION_ARG_STRING:
1448             case G_OPTION_ARG_FILENAME:
1449               g_free (change->allocated.str);
1450               *(gchar **)change->arg_data = change->prev.str;
1451               break;
1452             case G_OPTION_ARG_STRING_ARRAY:
1453             case G_OPTION_ARG_FILENAME_ARRAY:
1454               g_strfreev (change->allocated.array.data);
1455               *(gchar ***)change->arg_data = change->prev.array;
1456               break;
1457             case G_OPTION_ARG_DOUBLE:
1458               *(gdouble *)change->arg_data = change->prev.dbl;
1459               break;
1460             case G_OPTION_ARG_INT64:
1461               *(gint64 *)change->arg_data = change->prev.int64;
1462               break;
1463             default:
1464               g_assert_not_reached ();
1465             }
1466         }
1467
1468       g_free (change);
1469     }
1470
1471   g_list_free (context->changes);
1472   context->changes = NULL;
1473 }
1474
1475 static void
1476 free_pending_nulls (GOptionContext *context,
1477                     gboolean        perform_nulls)
1478 {
1479   GList *list;
1480
1481   for (list = context->pending_nulls; list != NULL; list = list->next)
1482     {
1483       PendingNull *n = list->data;
1484
1485       if (perform_nulls)
1486         {
1487           if (n->value)
1488             {
1489               /* Copy back the short options */
1490               *(n->ptr)[0] = '-';
1491               strcpy (*n->ptr + 1, n->value);
1492             }
1493           else
1494             *n->ptr = NULL;
1495         }
1496
1497       g_free (n->value);
1498       g_free (n);
1499     }
1500
1501   g_list_free (context->pending_nulls);
1502   context->pending_nulls = NULL;
1503 }
1504
1505 /**
1506  * g_option_context_parse:
1507  * @context: a #GOptionContext
1508  * @argc: a pointer to the number of command line arguments
1509  * @argv: a pointer to the array of command line arguments
1510  * @error: a return location for errors
1511  *
1512  * Parses the command line arguments, recognizing options
1513  * which have been added to @context. A side-effect of
1514  * calling this function is that g_set_prgname() will be
1515  * called.
1516  *
1517  * If the parsing is successful, any parsed arguments are
1518  * removed from the array and @argc and @argv are updated
1519  * accordingly. A '--' option is stripped from @argv
1520  * unless there are unparsed options before and after it,
1521  * or some of the options after it start with '-'. In case
1522  * of an error, @argc and @argv are left unmodified.
1523  *
1524  * If automatic <option>--help</option> support is enabled
1525  * (see g_option_context_set_help_enabled()), and the
1526  * @argv array contains one of the recognized help options,
1527  * this function will produce help output to stdout and
1528  * call <literal>exit (0)</literal>.
1529  *
1530  * Note that function depends on the
1531  * <link linkend="setlocale">current locale</link> for
1532  * automatic character set conversion of string and filename
1533  * arguments.
1534  *
1535  * Return value: %TRUE if the parsing was successful,
1536  *               %FALSE if an error occurred
1537  *
1538  * Since: 2.6
1539  **/
1540 gboolean
1541 g_option_context_parse (GOptionContext   *context,
1542                         gint             *argc,
1543                         gchar          ***argv,
1544                         GError          **error)
1545 {
1546   gint i, j, k;
1547   GList *list;
1548
1549   /* Set program name */
1550   if (!g_get_prgname())
1551     {
1552       if (argc && argv && *argc)
1553         {
1554           gchar *prgname;
1555
1556           prgname = g_path_get_basename ((*argv)[0]);
1557           g_set_prgname (prgname);
1558           g_free (prgname);
1559         }
1560       else
1561         g_set_prgname ("<unknown>");
1562     }
1563
1564   /* Call pre-parse hooks */
1565   list = context->groups;
1566   while (list)
1567     {
1568       GOptionGroup *group = list->data;
1569
1570       if (group->pre_parse_func)
1571         {
1572           if (!(* group->pre_parse_func) (context, group,
1573                                           group->user_data, error))
1574             goto fail;
1575         }
1576
1577       list = list->next;
1578     }
1579
1580   if (context->main_group && context->main_group->pre_parse_func)
1581     {
1582       if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1583                                                     context->main_group->user_data, error))
1584         goto fail;
1585     }
1586
1587   if (argc && argv)
1588     {
1589       gboolean stop_parsing = FALSE;
1590       gboolean has_unknown = FALSE;
1591       gint separator_pos = 0;
1592
1593       for (i = 1; i < *argc; i++)
1594         {
1595           gchar *arg, *dash;
1596           gboolean parsed = FALSE;
1597
1598           if ((*argv)[i][0] == '-' && (*argv)[i][1] != '\0' && !stop_parsing)
1599             {
1600               if ((*argv)[i][1] == '-')
1601                 {
1602                   /* -- option */
1603
1604                   arg = (*argv)[i] + 2;
1605
1606                   /* '--' terminates list of arguments */
1607                   if (*arg == 0)
1608                     {
1609                       separator_pos = i;
1610                       stop_parsing = TRUE;
1611                       continue;
1612                     }
1613
1614                   /* Handle help options */
1615                   if (context->help_enabled)
1616                     {
1617                       if (strcmp (arg, "help") == 0)
1618                         print_help (context, TRUE, NULL);
1619                       else if (strcmp (arg, "help-all") == 0)
1620                         print_help (context, FALSE, NULL);
1621                       else if (strncmp (arg, "help-", 5) == 0)
1622                         {
1623                           GList *list;
1624
1625                           list = context->groups;
1626
1627                           while (list)
1628                             {
1629                               GOptionGroup *group = list->data;
1630
1631                               if (strcmp (arg + 5, group->name) == 0)
1632                                 print_help (context, FALSE, group);
1633
1634                               list = list->next;
1635                             }
1636                         }
1637                     }
1638
1639                   if (context->main_group &&
1640                       !parse_long_option (context, context->main_group, &i, arg,
1641                                           FALSE, argc, argv, error, &parsed))
1642                     goto fail;
1643
1644                   if (parsed)
1645                     continue;
1646
1647                   /* Try the groups */
1648                   list = context->groups;
1649                   while (list)
1650                     {
1651                       GOptionGroup *group = list->data;
1652
1653                       if (!parse_long_option (context, group, &i, arg,
1654                                               FALSE, argc, argv, error, &parsed))
1655                         goto fail;
1656
1657                       if (parsed)
1658                         break;
1659
1660                       list = list->next;
1661                     }
1662
1663                   if (parsed)
1664                     continue;
1665
1666                   /* Now look for --<group>-<option> */
1667                   dash = strchr (arg, '-');
1668                   if (dash)
1669                     {
1670                       /* Try the groups */
1671                       list = context->groups;
1672                       while (list)
1673                         {
1674                           GOptionGroup *group = list->data;
1675
1676                           if (strncmp (group->name, arg, dash - arg) == 0)
1677                             {
1678                               if (!parse_long_option (context, group, &i, dash + 1,
1679                                                       TRUE, argc, argv, error, &parsed))
1680                                 goto fail;
1681
1682                               if (parsed)
1683                                 break;
1684                             }
1685
1686                           list = list->next;
1687                         }
1688                     }
1689
1690                   if (context->ignore_unknown)
1691                     continue;
1692                 }
1693               else
1694                 { /* short option */
1695                   gint j, new_i = i, arg_length;
1696                   gboolean *nulled_out = NULL;
1697                   arg = (*argv)[i] + 1;
1698                   arg_length = strlen (arg);
1699                   nulled_out = g_newa (gboolean, arg_length);
1700                   memset (nulled_out, 0, arg_length * sizeof (gboolean));
1701                   for (j = 0; j < arg_length; j++)
1702                     {
1703                       if (context->help_enabled && arg[j] == '?')
1704                         print_help (context, TRUE, NULL);
1705                       parsed = FALSE;
1706                       if (context->main_group &&
1707                           !parse_short_option (context, context->main_group,
1708                                                i, &new_i, arg[j],
1709                                                argc, argv, error, &parsed))
1710                         goto fail;
1711                       if (!parsed)
1712                         {
1713                           /* Try the groups */
1714                           list = context->groups;
1715                           while (list)
1716                             {
1717                               GOptionGroup *group = list->data;
1718                               if (!parse_short_option (context, group, i, &new_i, arg[j],
1719                                                        argc, argv, error, &parsed))
1720                                 goto fail;
1721                               if (parsed)
1722                                 break;
1723                               list = list->next;
1724                             }
1725                         }
1726
1727                       if (context->ignore_unknown && parsed)
1728                         nulled_out[j] = TRUE;
1729                       else if (context->ignore_unknown)
1730                         continue;
1731                       else if (!parsed)
1732                         break;
1733                       /* !context->ignore_unknown && parsed */
1734                     }
1735                   if (context->ignore_unknown)
1736                     {
1737                       gchar *new_arg = NULL;
1738                       gint arg_index = 0;
1739                       for (j = 0; j < arg_length; j++)
1740                         {
1741                           if (!nulled_out[j])
1742                             {
1743                               if (!new_arg)
1744                                 new_arg = g_malloc (arg_length + 1);
1745                               new_arg[arg_index++] = arg[j];
1746                             }
1747                         }
1748                       if (new_arg)
1749                         new_arg[arg_index] = '\0';
1750                       add_pending_null (context, &((*argv)[i]), new_arg);
1751                     }
1752                   else if (parsed)
1753                     {
1754                       add_pending_null (context, &((*argv)[i]), NULL);
1755                       i = new_i;
1756                     }
1757                 }
1758
1759               if (!parsed)
1760                 has_unknown = TRUE;
1761
1762               if (!parsed && !context->ignore_unknown)
1763                 {
1764                   g_set_error (error,
1765                                G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1766                                    _("Unknown option %s"), (*argv)[i]);
1767                   goto fail;
1768                 }
1769             }
1770           else
1771             {
1772               /* Collect remaining args */
1773               if (context->main_group &&
1774                   !parse_remaining_arg (context, context->main_group, &i,
1775                                         argc, argv, error, &parsed))
1776                 goto fail;
1777
1778               if (!parsed && (has_unknown || (*argv)[i][0] == '-'))
1779                 separator_pos = 0;
1780             }
1781         }
1782
1783       if (separator_pos > 0)
1784         add_pending_null (context, &((*argv)[separator_pos]), NULL);
1785
1786     }
1787
1788   /* Call post-parse hooks */
1789   list = context->groups;
1790   while (list)
1791     {
1792       GOptionGroup *group = list->data;
1793
1794       if (group->post_parse_func)
1795         {
1796           if (!(* group->post_parse_func) (context, group,
1797                                            group->user_data, error))
1798             goto fail;
1799         }
1800
1801       list = list->next;
1802     }
1803
1804   if (context->main_group && context->main_group->post_parse_func)
1805     {
1806       if (!(* context->main_group->post_parse_func) (context, context->main_group,
1807                                                      context->main_group->user_data, error))
1808         goto fail;
1809     }
1810
1811   if (argc && argv)
1812     {
1813       free_pending_nulls (context, TRUE);
1814
1815       for (i = 1; i < *argc; i++)
1816         {
1817           for (k = i; k < *argc; k++)
1818             if ((*argv)[k] != NULL)
1819               break;
1820
1821           if (k > i)
1822             {
1823               k -= i;
1824               for (j = i + k; j < *argc; j++)
1825                 {
1826                   (*argv)[j-k] = (*argv)[j];
1827                   (*argv)[j] = NULL;
1828                 }
1829               *argc -= k;
1830             }
1831         }
1832     }
1833
1834   return TRUE;
1835
1836  fail:
1837
1838   /* Call error hooks */
1839   list = context->groups;
1840   while (list)
1841     {
1842       GOptionGroup *group = list->data;
1843
1844       if (group->error_func)
1845         (* group->error_func) (context, group,
1846                                group->user_data, error);
1847
1848       list = list->next;
1849     }
1850
1851   if (context->main_group && context->main_group->error_func)
1852     (* context->main_group->error_func) (context, context->main_group,
1853                                          context->main_group->user_data, error);
1854
1855   free_changes_list (context, TRUE);
1856   free_pending_nulls (context, FALSE);
1857
1858   return FALSE;
1859 }
1860
1861 /**
1862  * g_option_group_new:
1863  * @name: the name for the option group, this is used to provide
1864  *   help for the options in this group with <option>--help-</option>@name
1865  * @description: a description for this group to be shown in
1866  *   <option>--help</option>. This string is translated using the translation
1867  *   domain or translation function of the group
1868  * @help_description: a description for the <option>--help-</option>@name option.
1869  *   This string is translated using the translation domain or translation function
1870  *   of the group
1871  * @user_data: user data that will be passed to the pre- and post-parse hooks,
1872  *   the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1873  * @destroy: a function that will be called to free @user_data, or %NULL
1874  *
1875  * Creates a new #GOptionGroup.
1876  *
1877  * Return value: a newly created option group. It should be added
1878  *   to a #GOptionContext or freed with g_option_group_free().
1879  *
1880  * Since: 2.6
1881  **/
1882 GOptionGroup *
1883 g_option_group_new (const gchar    *name,
1884                     const gchar    *description,
1885                     const gchar    *help_description,
1886                     gpointer        user_data,
1887                     GDestroyNotify  destroy)
1888
1889 {
1890   GOptionGroup *group;
1891
1892   group = g_new0 (GOptionGroup, 1);
1893   group->name = g_strdup (name);
1894   group->description = g_strdup (description);
1895   group->help_description = g_strdup (help_description);
1896   group->user_data = user_data;
1897   group->destroy_notify = destroy;
1898
1899   return group;
1900 }
1901
1902
1903 /**
1904  * g_option_group_free:
1905  * @group: a #GOptionGroup
1906  *
1907  * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
1908  * free groups which have been added to a #GOptionContext.
1909  *
1910  * Since: 2.6
1911  **/
1912 void
1913 g_option_group_free (GOptionGroup *group)
1914 {
1915   g_return_if_fail (group != NULL);
1916
1917   g_free (group->name);
1918   g_free (group->description);
1919   g_free (group->help_description);
1920
1921   g_free (group->entries);
1922
1923   if (group->destroy_notify)
1924     (* group->destroy_notify) (group->user_data);
1925
1926   if (group->translate_notify)
1927     (* group->translate_notify) (group->translate_data);
1928
1929   g_free (group);
1930 }
1931
1932
1933 /**
1934  * g_option_group_add_entries:
1935  * @group: a #GOptionGroup
1936  * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
1937  *
1938  * Adds the options specified in @entries to @group.
1939  *
1940  * Since: 2.6
1941  **/
1942 void
1943 g_option_group_add_entries (GOptionGroup       *group,
1944                             const GOptionEntry *entries)
1945 {
1946   gint i, n_entries;
1947
1948   g_return_if_fail (entries != NULL);
1949
1950   for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++) ;
1951
1952   group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
1953
1954   memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
1955
1956   for (i = group->n_entries; i < group->n_entries + n_entries; i++)
1957     {
1958       gchar c = group->entries[i].short_name;
1959
1960       if (c)
1961         {
1962           if (c == '-' || !g_ascii_isprint (c))
1963             {
1964               g_warning (G_STRLOC": ignoring invalid short option '%c' (%d)", c, c);
1965               group->entries[i].short_name = 0;
1966             }
1967         }
1968     }
1969
1970   group->n_entries += n_entries;
1971 }
1972
1973 /**
1974  * g_option_group_set_parse_hooks:
1975  * @group: a #GOptionGroup
1976  * @pre_parse_func: a function to call before parsing, or %NULL
1977  * @post_parse_func: a function to call after parsing, or %NULL
1978  *
1979  * Associates two functions with @group which will be called
1980  * from g_option_context_parse() before the first option is parsed
1981  * and after the last option has been parsed, respectively.
1982  *
1983  * Note that the user data to be passed to @pre_parse_func and
1984  * @post_parse_func can be specified when constructing the group
1985  * with g_option_group_new().
1986  *
1987  * Since: 2.6
1988  **/
1989 void
1990 g_option_group_set_parse_hooks (GOptionGroup     *group,
1991                                 GOptionParseFunc  pre_parse_func,
1992                                 GOptionParseFunc  post_parse_func)
1993 {
1994   g_return_if_fail (group != NULL);
1995
1996   group->pre_parse_func = pre_parse_func;
1997   group->post_parse_func = post_parse_func;
1998 }
1999
2000 /**
2001  * g_option_group_set_error_hook:
2002  * @group: a #GOptionGroup
2003  * @error_func: a function to call when an error occurs
2004  *
2005  * Associates a function with @group which will be called
2006  * from g_option_context_parse() when an error occurs.
2007  *
2008  * Note that the user data to be passed to @pre_parse_func and
2009  * @post_parse_func can be specified when constructing the group
2010  * with g_option_group_new().
2011  *
2012  * Since: 2.6
2013  **/
2014 void
2015 g_option_group_set_error_hook (GOptionGroup     *group,
2016                                GOptionErrorFunc  error_func)
2017 {
2018   g_return_if_fail (group != NULL);
2019
2020   group->error_func = error_func;
2021 }
2022
2023
2024 /**
2025  * g_option_group_set_translate_func:
2026  * @group: a #GOptionGroup
2027  * @func: the #GTranslateFunc, or %NULL
2028  * @data: user data to pass to @func, or %NULL
2029  * @destroy_notify: a function which gets called to free @data, or %NULL
2030  *
2031  * Sets the function which is used to translate user-visible
2032  * strings, for <option>--help</option> output. Different
2033  * groups can use different #GTranslateFunc<!-- -->s. If @func
2034  * is %NULL, strings are not translated.
2035  *
2036  * If you are using gettext(), you only need to set the translation
2037  * domain, see g_option_group_set_translation_domain().
2038  *
2039  * Since: 2.6
2040  **/
2041 void
2042 g_option_group_set_translate_func (GOptionGroup   *group,
2043                                    GTranslateFunc  func,
2044                                    gpointer        data,
2045                                    GDestroyNotify  destroy_notify)
2046 {
2047   g_return_if_fail (group != NULL);
2048
2049   if (group->translate_notify)
2050     group->translate_notify (group->translate_data);
2051
2052   group->translate_func = func;
2053   group->translate_data = data;
2054   group->translate_notify = destroy_notify;
2055 }
2056
2057 static gchar *
2058 dgettext_swapped (const gchar *msgid,
2059                   const gchar *domainname)
2060 {
2061   return g_dgettext (domainname, msgid);
2062 }
2063
2064 /**
2065  * g_option_group_set_translation_domain:
2066  * @group: a #GOptionGroup
2067  * @domain: the domain to use
2068  *
2069  * A convenience function to use gettext() for translating
2070  * user-visible strings.
2071  *
2072  * Since: 2.6
2073  **/
2074 void
2075 g_option_group_set_translation_domain (GOptionGroup *group,
2076                                        const gchar  *domain)
2077 {
2078   g_return_if_fail (group != NULL);
2079
2080   g_option_group_set_translate_func (group,
2081                                      (GTranslateFunc)dgettext_swapped,
2082                                      g_strdup (domain),
2083                                      g_free);
2084 }
2085
2086 /**
2087  * g_option_context_set_translate_func:
2088  * @context: a #GOptionContext
2089  * @func: the #GTranslateFunc, or %NULL
2090  * @data: user data to pass to @func, or %NULL
2091  * @destroy_notify: a function which gets called to free @data, or %NULL
2092  *
2093  * Sets the function which is used to translate the contexts
2094  * user-visible strings, for <option>--help</option> output.
2095  * If @func is %NULL, strings are not translated.
2096  *
2097  * Note that option groups have their own translation functions,
2098  * this function only affects the @parameter_string (see g_option_context_new()),
2099  * the summary (see g_option_context_set_summary()) and the description
2100  * (see g_option_context_set_description()).
2101  *
2102  * If you are using gettext(), you only need to set the translation
2103  * domain, see g_context_group_set_translation_domain().
2104  *
2105  * Since: 2.12
2106  **/
2107 void
2108 g_option_context_set_translate_func (GOptionContext *context,
2109                                      GTranslateFunc func,
2110                                      gpointer       data,
2111                                      GDestroyNotify destroy_notify)
2112 {
2113   g_return_if_fail (context != NULL);
2114
2115   if (context->translate_notify)
2116     context->translate_notify (context->translate_data);
2117
2118   context->translate_func = func;
2119   context->translate_data = data;
2120   context->translate_notify = destroy_notify;
2121 }
2122
2123 /**
2124  * g_option_context_set_translation_domain:
2125  * @context: a #GOptionContext
2126  * @domain: the domain to use
2127  *
2128  * A convenience function to use gettext() for translating
2129  * user-visible strings.
2130  *
2131  * Since: 2.12
2132  **/
2133 void
2134 g_option_context_set_translation_domain (GOptionContext *context,
2135                                          const gchar     *domain)
2136 {
2137   g_return_if_fail (context != NULL);
2138
2139   g_option_context_set_translate_func (context,
2140                                        (GTranslateFunc)dgettext_swapped,
2141                                        g_strdup (domain),
2142                                        g_free);
2143 }
2144
2145 /**
2146  * g_option_context_set_summary:
2147  * @context: a #GOptionContext
2148  * @summary: a string to be shown in <option>--help</option> output
2149  *  before the list of options, or %NULL
2150  *
2151  * Adds a string to be displayed in <option>--help</option> output
2152  * before the list of options. This is typically a summary of the
2153  * program functionality.
2154  *
2155  * Note that the summary is translated (see
2156  * g_option_context_set_translate_func(), g_option_context_set_translation_domain()).
2157  *
2158  * Since: 2.12
2159  */
2160 void
2161 g_option_context_set_summary (GOptionContext *context,
2162                               const gchar    *summary)
2163 {
2164   g_return_if_fail (context != NULL);
2165
2166   g_free (context->summary);
2167   context->summary = g_strdup (summary);
2168 }
2169
2170
2171 /**
2172  * g_option_context_get_summary:
2173  * @context: a #GOptionContext
2174  *
2175  * Returns the summary. See g_option_context_set_summary().
2176  *
2177  * Returns: the summary
2178  *
2179  * Since: 2.12
2180  */
2181 G_CONST_RETURN gchar *
2182 g_option_context_get_summary (GOptionContext *context)
2183 {
2184   g_return_val_if_fail (context != NULL, NULL);
2185
2186   return context->summary;
2187 }
2188
2189 /**
2190  * g_option_context_set_description:
2191  * @context: a #GOptionContext
2192  * @description: a string to be shown in <option>--help</option> output
2193  *   after the list of options, or %NULL
2194  *
2195  * Adds a string to be displayed in <option>--help</option> output
2196  * after the list of options. This text often includes a bug reporting
2197  * address.
2198  *
2199  * Note that the summary is translated (see
2200  * g_option_context_set_translate_func()).
2201  *
2202  * Since: 2.12
2203  */
2204 void
2205 g_option_context_set_description (GOptionContext *context,
2206                                   const gchar    *description)
2207 {
2208   g_return_if_fail (context != NULL);
2209
2210   g_free (context->description);
2211   context->description = g_strdup (description);
2212 }
2213
2214
2215 /**
2216  * g_option_context_get_description:
2217  * @context: a #GOptionContext
2218  *
2219  * Returns the description. See g_option_context_set_description().
2220  *
2221  * Returns: the description
2222  *
2223  * Since: 2.12
2224  */
2225 G_CONST_RETURN gchar *
2226 g_option_context_get_description (GOptionContext *context)
2227 {
2228   g_return_val_if_fail (context != NULL, NULL);
2229
2230   return context->description;
2231 }
2232
2233
2234 #define __G_OPTION_C__
2235 #include "galiasdef.c"