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 "galias.h"
  25
  26 #include "goption.h"
  27 #include "glib.h"
  28 #include "gi18n.h"
  29
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #include <errno.h>
  33
  34 #define TRANSLATE(group, str) (((group)->translate_func ? (* (group)->translate_func) ((str), (group)->translate_data) : (str)))
  35
  36 typedef struct {
  37   GOptionArg arg_type;
  38   gpointer arg_data;
  39   union {
  40     gboolean bool;
  41     gint integer;
  42     gchar *str;
  43     gchar **array;
  44   } prev;
  45   union {
  46     gchar *str;
  47     struct {
  48       gint len;
  49       gchar **data;
  50     } array;
  51   } allocated;
  52 } Change;
  53
  54 typedef struct
  55 {
  56   gchar **ptr;
  57   gchar *value;
  58 } PendingNull;
  59
  60 struct _GOptionContext
  61 {
  62   GList *groups;
  63
  64   gchar *parameter_string;
  65
  66   gboolean help_enabled;
  67   gboolean ignore_unknown;
  68
  69   GOptionGroup *main_group;
  70
  71   /* We keep a list of change so we can revert them */
  72   GList *changes;
  73
  74   /* We also keep track of all argv elements that should be NULLed or
  75    * modified.
  76    */
  77   GList *pending_nulls;
  78 };
  79
  80 struct _GOptionGroup
  81 {
  82   gchar *name;
  83   gchar *description;
  84   gchar *help_description;
  85
  86   GDestroyNotify  destroy_notify;
  87   gpointer        user_data;
  88
  89   GTranslateFunc  translate_func;
  90   GDestroyNotify  translate_notify;
  91   gpointer        translate_data;
  92
  93   GOptionEntry *entries;
  94   gint         n_entries;
  95
  96   GOptionParseFunc pre_parse_func;
  97   GOptionParseFunc post_parse_func;
  98   GOptionErrorFunc error_func;
  99 };
 100
 101 static void free_changes_list (GOptionContext *context,
 102                                gboolean        revert);
 103 static void free_pending_nulls (GOptionContext *context,
 104                                 gboolean        perform_nulls);
 105
 106 GQuark
 107 g_option_error_quark (void)
 108 {
 109   static GQuark q = 0;
 110
 111   if (q == 0)
 112     q = g_quark_from_static_string ("g-option-context-error-quark");
 113
 114   return q;
 115 }
 116
 117 /**
 118  * g_option_context_new:
 119  * @parameter_string: a string which is displayed in
 120  *    the first line of <option>--help</option> output, after
 121  *    <literal><replaceable>programname</replaceable> [OPTION...]</literal>
 122  *
 123  * Creates a new option context.
 124  *
 125  * Returns: a newly created #GOptionContext, which must be
 126  *    freed with g_option_context_free() after use.
 127  *
 128  * Since: 2.6
 129  */
 130 GOptionContext *
 131 g_option_context_new (const gchar *parameter_string)
 132
 133 {
 134   GOptionContext *context;
 135
 136   context = g_new0 (GOptionContext, 1);
 137
 138   context->parameter_string = g_strdup (parameter_string);
 139   context->help_enabled = TRUE;
 140   context->ignore_unknown = FALSE;
 141
 142   return context;
 143 }
 144
 145 /**
 146  * g_option_context_free:
 147  * @context: a #GOptionContext
 148  *
 149  * Frees context and all the groups which have been
 150  * added to it.
 151  *
 152  * Since: 2.6
 153  */
 154 void g_option_context_free (GOptionContext *context)
 155 {
 156   g_return_if_fail (context != NULL);
 157
 158   g_list_foreach (context->groups, (GFunc)g_option_group_free, NULL);
 159   g_list_free (context->groups);
 160
 161   if (context->main_group)
 162     g_option_group_free (context->main_group);
 163
 164   free_changes_list (context, FALSE);
 165   free_pending_nulls (context, FALSE);
 166
 167   g_free (context->parameter_string);
 168
 169   g_free (context);
 170 }
 171
 172
 173 /**
 174  * g_option_context_set_help_enabled:
 175  * @context: a #GOptionContext
 176  * @help_enabled: %TRUE to enable <option>--help</option>, %FALSE to disable it
 177  *
 178  * Enables or disables automatic generation of <option>--help</option>
 179  * output. By default, g_option_context_parse() recognizes
 180  * <option>--help</option>, <option>-?</option>, <option>--help-all</option>
 181  * and <option>--help-</option><replaceable>groupname</replaceable> and creates
 182  * suitable output to stdout.
 183  *
 184  * Since: 2.6
 185  */
 186 void g_option_context_set_help_enabled (GOptionContext *context,
 187                                         gboolean        help_enabled)
 188
 189 {
 190   g_return_if_fail (context != NULL);
 191
 192   context->help_enabled = help_enabled;
 193 }
 194
 195 /**
 196  * g_option_context_get_help_enabled:
 197  * @context: a #GOptionContext
 198  *
 199  * Returns whether automatic <option>--help</option> generation
 200  * is turned on for @context. See g_option_context_set_help_enabled().
 201  *
 202  * Returns: %TRUE if automatic help generation is turned on.
 203  *
 204  * Since: 2.6
 205  */
 206 gboolean
 207 g_option_context_get_help_enabled (GOptionContext *context)
 208 {
 209   g_return_val_if_fail (context != NULL, FALSE);
 210
 211   return context->help_enabled;
 212 }
 213
 214 /**
 215  * g_option_context_set_ignore_unknown_options:
 216  * @context: a #GOptionContext
 217  * @ignore_unknown: %TRUE to ignore unknown options, %FALSE to produce
 218  *    an error when unknown options are met
 219  *
 220  * Sets whether to ignore unknown options or not. If an argument is
 221  * ignored, it is left in the @argv array after parsing. By default,
 222  * g_option_context_parse() treats unknown options as error.
 223  *
 224  * This setting does not affect non-option arguments (i.e. arguments
 225  * which don't start with a dash). But note that GOption cannot reliably
 226  * determine whether a non-option belongs to a preceding unknown option.
 227  *
 228  * Since: 2.6
 229  **/
 230 void
 231 g_option_context_set_ignore_unknown_options (GOptionContext *context,
 232                                              gboolean        ignore_unknown)
 233 {
 234   g_return_if_fail (context != NULL);
 235
 236   context->ignore_unknown = ignore_unknown;
 237 }
 238
 239 /**
 240  * g_option_context_get_ignore_unknown_options:
 241  * @context: a #GOptionContext
 242  *
 243  * Returns whether unknown options are ignored or not. See
 244  * g_option_context_set_ignore_unknown_options().
 245  *
 246  * Returns: %TRUE if unknown options are ignored.
 247  *
 248  * Since: 2.6
 249  **/
 250 gboolean
 251 g_option_context_get_ignore_unknown_options (GOptionContext *context)
 252 {
 253   g_return_val_if_fail (context != NULL, FALSE);
 254
 255   return context->ignore_unknown;
 256 }
 257
 258 /**
 259  * g_option_context_add_group:
 260  * @context: a #GOptionContext
 261  * @group: the group to add
 262  *
 263  * Adds a #GOptionGroup to the @context, so that parsing with @context
 264  * will recognize the options in the group. Note that the group will
 265  * be freed together with the context when g_option_context_free() is
 266  * called, so you must not free the group yourself after adding it
 267  * to a context.
 268  *
 269  * Since: 2.6
 270  **/
 271 void
 272 g_option_context_add_group (GOptionContext *context,
 273                             GOptionGroup   *group)
 274 {
 275   GList *list;
 276
 277   g_return_if_fail (context != NULL);
 278   g_return_if_fail (group != NULL);
 279   g_return_if_fail (group->name != NULL);
 280   g_return_if_fail (group->description != NULL);
 281   g_return_if_fail (group->help_description != NULL);
 282
 283   for (list = context->groups; list; list = list->next)
 284     {
 285       GOptionGroup *g = (GOptionGroup *)list->data;
 286
 287       if ((group->name == NULL && g->name == NULL) ||
 288           (group->name && g->name && strcmp (group->name, g->name) == 0))
 289         g_warning ("A group named \"%s\" is already part of this GOptionContext",
 290                    group->name);
 291     }
 292
 293   context->groups = g_list_append (context->groups, group);
 294 }
 295
 296 /**
 297  * g_option_context_set_main_group:
 298  * @context: a #GOptionContext
 299  * @group: the group to set as main group
 300  *
 301  * Sets a #GOptionGroup as main group of the @context.
 302  * This has the same effect as calling g_option_context_add_group(),
 303  * the only difference is that the options in the main group are
 304  * treated differently when generating <option>--help</option> output.
 305  *
 306  * Since: 2.6
 307  **/
 308 void
 309 g_option_context_set_main_group (GOptionContext *context,
 310                                  GOptionGroup   *group)
 311 {
 312   g_return_if_fail (context != NULL);
 313   g_return_if_fail (group != NULL);
 314
 315   context->main_group = group;
 316 }
 317
 318 /**
 319  * g_option_context_get_main_group:
 320  * @context: a #GOptionContext
 321  *
 322  * Returns a pointer to the main group of @context.
 323  *
 324  * Return value: the main group of @context, or %NULL if @context doesn't
 325  *  have a main group. Note that group belongs to @context and should
 326  *  not be modified or freed.
 327  *
 328  * Since: 2.6
 329  **/
 330 GOptionGroup *
 331 g_option_context_get_main_group (GOptionContext *context)
 332 {
 333   g_return_val_if_fail (context != NULL, NULL);
 334
 335   return context->main_group;
 336 }
 337
 338 /**
 339  * g_option_context_add_main_entries:
 340  * @context: a #GOptionContext
 341  * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
 342  * @translation_domain: a translation domain to use for translating
 343  *    the <option>--help</option> output for the options in @entries
 344  *    with gettext(), or %NULL
 345  *
 346  * A convenience function which creates a main group if it doesn't
 347  * exist, adds the @entries to it and sets the translation domain.
 348  *
 349  * Since: 2.6
 350  **/
 351 void
 352 g_option_context_add_main_entries (GOptionContext      *context,
 353                                    const GOptionEntry  *entries,
 354                                    const gchar         *translation_domain)
 355 {
 356   g_return_if_fail (entries != NULL);
 357
 358   if (!context->main_group)
 359     context->main_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
 360
 361   g_option_group_add_entries (context->main_group, entries);
 362   g_option_group_set_translation_domain (context->main_group, translation_domain);
 363 }
 364
 365 static void
 366 print_entry (GOptionGroup       *group,
 367              gint                max_length,
 368              const GOptionEntry *entry)
 369 {
 370   GString *str;
 371
 372   if (entry->flags & G_OPTION_FLAG_HIDDEN)
 373     return;
 374
 375   str = g_string_new (NULL);
 376
 377   if (entry->short_name)
 378     g_string_append_printf (str, "  -%c, --%s", entry->short_name, entry->long_name);
 379   else
 380     g_string_append_printf (str, "  --%s", entry->long_name);
 381
 382   if (entry->arg_description)
 383     g_string_append_printf (str, "=%s", TRANSLATE (group, entry->arg_description));
 384
 385   g_print ("%-*s %s\n", max_length + 4, str->str,
 386            entry->description ? TRANSLATE (group, entry->description) : "");
 387   g_string_free (str, TRUE);
 388 }
 389
 390 static void
 391 print_help (GOptionContext *context,
 392             gboolean        main_help,
 393             GOptionGroup   *group)
 394 {
 395   GList *list;
 396   gint max_length, len;
 397   gint i;
 398   GHashTable *shadow_map;
 399   gboolean seen[256];
 400
 401   g_print ("%s\n  %s %s %s\n\n",
 402            _("Usage:"), g_get_prgname(), _("[OPTION...]"),
 403            context->parameter_string ? context->parameter_string : "");
 404
 405   memset (seen, 0, sizeof (gboolean) * 256);
 406   shadow_map = g_hash_table_new (g_str_hash, g_str_equal);
 407
 408   if (context->main_group)
 409     {
 410       for (i = 0; i < context->main_group->n_entries; i++)
 411         {
 412           g_hash_table_insert (shadow_map,
 413                                (gpointer)context->main_group->entries[i].long_name,
 414                                context->main_group->entries + i);
 415
 416           if (seen[(guchar)context->main_group->entries[i].short_name])
 417             context->main_group->entries[i].short_name = 0;
 418           else
 419             seen[(guchar)context->main_group->entries[i].short_name] = TRUE;
 420         }
 421     }
 422
 423   list = context->groups;
 424   while (list != NULL)
 425     {
 426       GOptionGroup *group = list->data;
 427       for (i = 0; i < group->n_entries; i++)
 428         {
 429           if (g_hash_table_lookup (shadow_map, group->entries[i].long_name))
 430             group->entries[i].long_name = g_strdup_printf ("%s-%s", group->name, group->entries[i].long_name);
 431           else
 432             g_hash_table_insert (shadow_map, (gpointer)group->entries[i].long_name, group->entries + i);
 433
 434           if (seen[(guchar)group->entries[i].short_name])
 435             group->entries[i].short_name = 0;
 436           else
 437             seen[(guchar)group->entries[i].short_name] = TRUE;
 438         }
 439       list = list->next;
 440     }
 441
 442   g_hash_table_destroy (shadow_map);
 443
 444   list = context->groups;
 445
 446   max_length = g_utf8_strlen ("--help, -?", -1);
 447
 448   if (list)
 449     {
 450       len = g_utf8_strlen ("--help-all", -1);
 451       max_length = MAX (max_length, len);
 452     }
 453
 454   while (list != NULL)
 455     {
 456       GOptionGroup *group = list->data;
 457
 458       /* First, we check the --help-<groupname> options */
 459       len = g_utf8_strlen ("--help-", -1) + g_utf8_strlen (group->name, -1);
 460       max_length = MAX (max_length, len);
 461
 462       /* Then we go through the entries */
 463       for (i = 0; i < group->n_entries; i++)
 464         {
 465           if (group->entries[i].flags & G_OPTION_FLAG_HIDDEN)
 466             continue;
 467
 468           len = g_utf8_strlen (group->entries[i].long_name, -1);
 469
 470           if (group->entries[i].short_name)
 471             len += 4;
 472
 473           if (group->entries[i].arg != G_OPTION_ARG_NONE &&
 474               group->entries[i].arg_description)
 475             len += 1 + g_utf8_strlen (TRANSLATE (group, group->entries[i].arg_description), -1);
 476
 477           max_length = MAX (max_length, len);
 478         }
 479
 480       list = list->next;
 481     }
 482
 483   /* Add a bit of padding */
 484   max_length += 4;
 485
 486   list = context->groups;
 487
 488   g_print ("%s\n  --%-*s %s\n",
 489            _("Help Options:"), max_length, "help", _("Show help options"));
 490
 491   /* We only want --help-all when there are groups */
 492   if (list)
 493     g_print ("  --%-*s %s\n", max_length, "help-all", _("Show all help options"));
 494
 495   while (list)
 496     {
 497       GOptionGroup *group = list->data;
 498
 499       g_print ("  --help-%-*s %s\n", max_length - 5, group->name, TRANSLATE (group, group->help_description));
 500
 501       list = list->next;
 502     }
 503
 504   g_print ("\n");
 505
 506   if (group)
 507     {
 508       /* Print a certain group */
 509
 510       g_print ("%s\n", TRANSLATE (group, group->description));
 511       for (i = 0; i < group->n_entries; i++)
 512         print_entry (group, max_length, &group->entries[i]);
 513       g_print ("\n");
 514     }
 515   else if (!main_help)
 516     {
 517       /* Print all groups */
 518
 519       list = context->groups;
 520
 521       while (list)
 522         {
 523           GOptionGroup *group = list->data;
 524
 525           g_print ("%s\n", group->description);
 526
 527           for (i = 0; i < group->n_entries; i++)
 528             if (!(group->entries[i].flags & G_OPTION_FLAG_IN_MAIN))
 529               print_entry (group, max_length, &group->entries[i]);
 530
 531           g_print ("\n");
 532           list = list->next;
 533         }
 534     }
 535
 536   /* Print application options if --help or --help-all has been specified */
 537   if (main_help || !group)
 538     {
 539       list = context->groups;
 540
 541       g_print ("%s\n", _("Application Options:"));
 542
 543       if (context->main_group)
 544         for (i = 0; i < context->main_group->n_entries; i++)
 545           print_entry (context->main_group, max_length, &context->main_group->entries[i]);
 546
 547       while (list != NULL)
 548         {
 549           GOptionGroup *group = list->data;
 550
 551           /* Print main entries from other groups */
 552           for (i = 0; i < group->n_entries; i++)
 553             if (group->entries[i].flags & G_OPTION_FLAG_IN_MAIN)
 554               print_entry (group, max_length, &group->entries[i]);
 555
 556           list = list->next;
 557         }
 558
 559       g_print ("\n");
 560     }
 561
 562   exit (0);
 563 }
 564
 565 static gboolean
 566 parse_int (const gchar *arg_name,
 567            const gchar *arg,
 568            gint        *result,
 569            GError     **error)
 570 {
 571   gchar *end;
 572   glong tmp = strtol (arg, &end, 0);
 573
 574   errno = 0;
 575
 576   if (*arg == '\0' || *end != '\0')
 577     {
 578       g_set_error (error,
 579                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 580                    _("Cannot parse integer value '%s' for --%s"),
 581                    arg, arg_name);
 582       return FALSE;
 583     }
 584
 585   *result = tmp;
 586   if (*result != tmp || errno == ERANGE)
 587     {
 588       g_set_error (error,
 589                    G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
 590                    _("Integer value '%s' for %s out of range"),
 591                    arg, arg_name);
 592       return FALSE;
 593     }
 594
 595   return TRUE;
 596 }
 597
 598 static Change *
 599 get_change (GOptionContext *context,
 600             GOptionArg      arg_type,
 601             gpointer        arg_data)
 602 {
 603   GList *list;
 604   Change *change = NULL;
 605
 606   for (list = context->changes; list != NULL; list = list->next)
 607     {
 608       change = list->data;
 609
 610       if (change->arg_data == arg_data)
 611         goto found;
 612     }
 613
 614   change = g_new0 (Change, 1);
 615   change->arg_type = arg_type;
 616   change->arg_data = arg_data;
 617
 618   context->changes = g_list_prepend (context->changes, change);
 619
 620  found:
 621
 622   return change;
 623 }
 624
 625 static void
 626 add_pending_null (GOptionContext *context,
 627                   gchar         **ptr,
 628                   gchar          *value)
 629 {
 630   PendingNull *n;
 631
 632   n = g_new0 (PendingNull, 1);
 633   n->ptr = ptr;
 634   n->value = value;
 635
 636   context->pending_nulls = g_list_prepend (context->pending_nulls, n);
 637 }
 638
 639 static gboolean
 640 parse_arg (GOptionContext *context,
 641            GOptionGroup   *group,
 642            GOptionEntry   *entry,
 643            const gchar    *value,
 644            const gchar    *option_name,
 645            GError        **error)
 646
 647 {
 648   Change *change;
 649
 650   switch (entry->arg)
 651     {
 652     case G_OPTION_ARG_NONE:
 653       {
 654         change = get_change (context, G_OPTION_ARG_NONE,
 655                              entry->arg_data);
 656
 657         *(gboolean *)entry->arg_data = !(entry->flags & G_OPTION_FLAG_REVERSE);
 658         break;
 659       }
 660     case G_OPTION_ARG_STRING:
 661       {
 662         gchar *data;
 663
 664         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 665
 666         if (!data)
 667           return FALSE;
 668
 669         change = get_change (context, G_OPTION_ARG_STRING,
 670                              entry->arg_data);
 671         g_free (change->allocated.str);
 672
 673         change->prev.str = *(gchar **)entry->arg_data;
 674         change->allocated.str = data;
 675
 676         *(gchar **)entry->arg_data = data;
 677         break;
 678       }
 679     case G_OPTION_ARG_STRING_ARRAY:
 680       {
 681         gchar *data;
 682
 683         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 684
 685         if (!data)
 686           return FALSE;
 687
 688         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
 689                              entry->arg_data);
 690
 691         if (change->allocated.array.len == 0)
 692           {
 693             change->prev.array = entry->arg_data;
 694             change->allocated.array.data = g_new (gchar *, 2);
 695           }
 696         else
 697           change->allocated.array.data =
 698             g_renew (gchar *, change->allocated.array.data,
 699                      change->allocated.array.len + 2);
 700
 701         change->allocated.array.data[change->allocated.array.len] = data;
 702         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
 703
 704         change->allocated.array.len ++;
 705
 706         *(gchar ***)entry->arg_data = change->allocated.array.data;
 707
 708         break;
 709       }
 710
 711     case G_OPTION_ARG_FILENAME:
 712       {
 713         gchar *data;
 714
 715 #ifdef G_OS_WIN32
 716         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 717
 718         if (!data)
 719           return FALSE;
 720 #else
 721         data = g_strdup (value);
 722 #endif
 723         change = get_change (context, G_OPTION_ARG_FILENAME,
 724                              entry->arg_data);
 725         g_free (change->allocated.str);
 726
 727         change->prev.str = *(gchar **)entry->arg_data;
 728         change->allocated.str = data;
 729
 730         *(gchar **)entry->arg_data = data;
 731         break;
 732       }
 733
 734     case G_OPTION_ARG_FILENAME_ARRAY:
 735       {
 736         gchar *data;
 737
 738 #ifdef G_OS_WIN32
 739         data = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 740
 741         if (!data)
 742           return FALSE;
 743 #else
 744         data = g_strdup (value);
 745 #endif
 746         change = get_change (context, G_OPTION_ARG_STRING_ARRAY,
 747                              entry->arg_data);
 748
 749         if (change->allocated.array.len == 0)
 750           {
 751             change->prev.array = entry->arg_data;
 752             change->allocated.array.data = g_new (gchar *, 2);
 753           }
 754         else
 755           change->allocated.array.data =
 756             g_renew (gchar *, change->allocated.array.data,
 757                      change->allocated.array.len + 2);
 758
 759         change->allocated.array.data[change->allocated.array.len] = data;
 760         change->allocated.array.data[change->allocated.array.len + 1] = NULL;
 761
 762         change->allocated.array.len ++;
 763
 764         *(gchar ***)entry->arg_data = change->allocated.array.data;
 765
 766         break;
 767       }
 768
 769     case G_OPTION_ARG_INT:
 770       {
 771         gint data;
 772
 773         if (!parse_int (option_name, value,
 774                         &data,
 775                         error))
 776           return FALSE;
 777
 778         change = get_change (context, G_OPTION_ARG_INT,
 779                              entry->arg_data);
 780         change->prev.integer = *(gint *)entry->arg_data;
 781         *(gint *)entry->arg_data = data;
 782         break;
 783       }
 784     case G_OPTION_ARG_CALLBACK:
 785       {
 786         gchar *tmp;
 787         gboolean retval;
 788
 789         tmp = g_locale_to_utf8 (value, -1, NULL, NULL, error);
 790
 791         if (!value)
 792           return FALSE;
 793
 794         retval = (* (GOptionArgFunc) entry->arg_data) (option_name, tmp, group->user_data, error);
 795
 796         g_free (tmp);
 797
 798         return retval;
 799
 800         break;
 801       }
 802     default:
 803       g_assert_not_reached ();
 804     }
 805
 806   return TRUE;
 807 }
 808
 809 static gboolean
 810 parse_short_option (GOptionContext *context,
 811                     GOptionGroup   *group,
 812                     gint            index,
 813                     gint           *new_index,
 814                     gchar           arg,
 815                     gint           *argc,
 816                     gchar        ***argv,
 817                     GError        **error,
 818                     gboolean       *parsed)
 819 {
 820   gint j;
 821
 822   for (j = 0; j < group->n_entries; j++)
 823     {
 824       if (arg == group->entries[j].short_name)
 825         {
 826           if (group->entries[j].arg == G_OPTION_ARG_NONE)
 827             {
 828               parse_arg (context, group, &group->entries[j],
 829                          NULL, NULL, error);
 830               *parsed = TRUE;
 831             }
 832           else
 833             {
 834               gchar *value = NULL;
 835               gchar *option_name;
 836
 837               if (*new_index > index)
 838                 {
 839                   g_warning ("FIXME: figure out the correct error here");
 840
 841                   return FALSE;
 842                 }
 843
 844               if (index < *argc - 1)
 845                 {
 846                   value = (*argv)[index + 1];
 847                   add_pending_null (context, &((*argv)[index + 1]), NULL);
 848                   *new_index = index + 1;
 849                 }
 850               else
 851                 value = "";
 852
 853
 854               option_name = g_strdup_printf ("-%c", group->entries[j].short_name);
 855
 856               if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
 857                 {
 858                   g_free (option_name);
 859                   return FALSE;
 860                 }
 861
 862               g_free (option_name);
 863               *parsed = TRUE;
 864             }
 865         }
 866     }
 867
 868   return TRUE;
 869 }
 870
 871 static gboolean
 872 parse_long_option (GOptionContext *context,
 873                    GOptionGroup   *group,
 874                    gint           *index,
 875                    gchar          *arg,
 876                    gint           *argc,
 877                    gchar        ***argv,
 878                    GError        **error,
 879                    gboolean       *parsed)
 880 {
 881   gint j;
 882
 883   for (j = 0; j < group->n_entries; j++)
 884     {
 885       if (*index >= *argc)
 886         return TRUE;
 887
 888       if (group->entries[j].arg == G_OPTION_ARG_NONE &&
 889           strcmp (arg, group->entries[j].long_name) == 0)
 890         {
 891           parse_arg (context, group, &group->entries[j],
 892                      NULL, NULL, error);
 893
 894           add_pending_null (context, &((*argv)[*index]), NULL);
 895           *parsed = TRUE;
 896         }
 897       else
 898         {
 899           gint len = strlen (group->entries[j].long_name);
 900
 901           if (strncmp (arg, group->entries[j].long_name, len) == 0 &&
 902               (arg[len] == '=' || arg[len] == 0))
 903             {
 904               gchar *value = NULL;
 905               gchar *option_name;
 906
 907               add_pending_null (context, &((*argv)[*index]), NULL);
 908
 909               if (arg[len] == '=')
 910                 value = arg + len + 1;
 911               else if (*index < *argc - 1)
 912                 {
 913                   value = (*argv)[*index + 1];
 914                   add_pending_null (context, &((*argv)[*index + 1]), NULL);
 915                   (*index)++;
 916                 }
 917               else
 918                 value = "";
 919
 920               option_name = g_strconcat ("--", group->entries[j].long_name, NULL);
 921
 922               if (!parse_arg (context, group, &group->entries[j], value, option_name, error))
 923                 {
 924                   g_free (option_name);
 925                   return FALSE;
 926                 }
 927
 928               g_free (option_name);
 929               *parsed = TRUE;
 930             }
 931         }
 932     }
 933
 934   return TRUE;
 935 }
 936
 937 static gboolean
 938 parse_remaining_arg (GOptionContext *context,
 939                      GOptionGroup   *group,
 940                      gint           *index,
 941                      gint           *argc,
 942                      gchar        ***argv,
 943                      GError        **error,
 944                      gboolean       *parsed)
 945 {
 946   gint j;
 947
 948   for (j = 0; j < group->n_entries; j++)
 949     {
 950       if (*index >= *argc)
 951         return TRUE;
 952
 953       if (group->entries[j].long_name[0])
 954         continue;
 955
 956       g_return_val_if_fail (group->entries[j].arg == G_OPTION_ARG_STRING_ARRAY ||
 957                             group->entries[j].arg == G_OPTION_ARG_FILENAME_ARRAY, FALSE);
 958
 959       add_pending_null (context, &((*argv)[*index]), NULL);
 960
 961       if (!parse_arg (context, group, &group->entries[j], (*argv)[*index], "", error))
 962         return FALSE;
 963
 964       *parsed = TRUE;
 965       return TRUE;
 966     }
 967
 968   return TRUE;
 969 }
 970
 971 static void
 972 free_changes_list (GOptionContext *context,
 973                    gboolean        revert)
 974 {
 975   GList *list;
 976
 977   for (list = context->changes; list != NULL; list = list->next)
 978     {
 979       Change *change = list->data;
 980
 981       if (revert)
 982         {
 983           switch (change->arg_type)
 984             {
 985             case G_OPTION_ARG_NONE:
 986               *(gboolean *)change->arg_data = change->prev.bool;
 987               break;
 988             case G_OPTION_ARG_INT:
 989               *(gint *)change->arg_data = change->prev.integer;
 990               break;
 991             case G_OPTION_ARG_STRING:
 992             case G_OPTION_ARG_FILENAME:
 993               g_free (change->allocated.str);
 994               *(gchar **)change->arg_data = change->prev.str;
 995               break;
 996             case G_OPTION_ARG_STRING_ARRAY:
 997             case G_OPTION_ARG_FILENAME_ARRAY:
 998               g_strfreev (change->allocated.array.data);
 999               *(gchar ***)change->arg_data = change->prev.array;
1000               break;
1001             default:
1002               g_assert_not_reached ();
1003             }
1004         }
1005
1006       g_free (change);
1007     }
1008
1009   g_list_free (context->changes);
1010   context->changes = NULL;
1011 }
1012
1013 static void
1014 free_pending_nulls (GOptionContext *context,
1015                     gboolean        perform_nulls)
1016 {
1017   GList *list;
1018
1019   for (list = context->pending_nulls; list != NULL; list = list->next)
1020     {
1021       PendingNull *n = list->data;
1022
1023       if (perform_nulls)
1024         {
1025           if (n->value)
1026             {
1027               /* Copy back the short options */
1028               *(n->ptr)[0] = '-';
1029               strcpy (*n->ptr + 1, n->value);
1030             }
1031           else
1032             *n->ptr = NULL;
1033         }
1034
1035       g_free (n->value);
1036       g_free (n);
1037     }
1038
1039   g_list_free (context->pending_nulls);
1040   context->pending_nulls = NULL;
1041 }
1042
1043 /**
1044  * g_option_context_parse:
1045  * @context: a #GOptionContext
1046  * @argc: a pointer to the number of command line arguments.
1047  * @argv: a pointer to the array of command line arguments.
1048  * @error: a return location for errors
1049  *
1050  * Parses the command line arguments, recognizing options
1051  * which have been added to @context. A side-effect of
1052  * calling this function is that g_set_prgname() will be
1053  * called.
1054  *
1055  * If the parsing is successful, any parsed arguments are
1056  * removed from the array and @argc and @argv are updated
1057  * accordingly. In case of an error, @argc and @argv are
1058  * left unmodified.
1059  *
1060  * If automatic <option>--help</option> support is enabled
1061  * (see g_option_context_set_help_enabled()), and the
1062  * @argv array contains one of the recognized help options,
1063  * this function will produce help output to stdout and
1064  * call <literal>exit (0)</literal>.
1065  *
1066  * Return value: %TRUE if the parsing was successful,
1067  *               %FALSE if an error occurred
1068  *
1069  * Since: 2.6
1070  **/
1071 gboolean
1072 g_option_context_parse (GOptionContext   *context,
1073                         gint             *argc,
1074                         gchar          ***argv,
1075                         GError          **error)
1076 {
1077   gint i, j, k;
1078   GList *list;
1079
1080   /* Set program name */
1081   if (argc && argv && *argc)
1082     {
1083       gchar *prgname;
1084
1085       prgname = g_path_get_basename ((*argv)[0]);
1086       g_set_prgname (prgname);
1087       g_free (prgname);
1088     }
1089   else
1090     {
1091       g_set_prgname ("<unknown>");
1092     }
1093
1094   /* Call pre-parse hooks */
1095   list = context->groups;
1096   while (list)
1097     {
1098       GOptionGroup *group = list->data;
1099
1100       if (group->pre_parse_func)
1101         {
1102           if (!(* group->pre_parse_func) (context, group,
1103                                           group->user_data, error))
1104             goto fail;
1105         }
1106
1107       list = list->next;
1108     }
1109
1110   if (context->main_group && context->main_group->pre_parse_func)
1111     {
1112       if (!(* context->main_group->pre_parse_func) (context, context->main_group,
1113                                                     context->main_group->user_data, error))
1114         goto fail;
1115     }
1116
1117   if (argc && argv)
1118     {
1119       gboolean stop_parsing = FALSE;
1120
1121       for (i = 1; i < *argc; i++)
1122         {
1123           gchar *arg, *dash;
1124           gboolean parsed = FALSE;
1125
1126           if ((*argv)[i][0] == '-' && !stop_parsing)
1127             {
1128               if ((*argv)[i][1] == '-')
1129                 {
1130                   /* -- option */
1131
1132                   arg = (*argv)[i] + 2;
1133
1134                   /* '--' terminates list of arguments */
1135                   if (*arg == 0)
1136                     {
1137                       add_pending_null (context, &((*argv)[i]), NULL);
1138                       stop_parsing = TRUE;
1139                       continue;
1140                     }
1141
1142                   /* Handle help options */
1143                   if (context->help_enabled)
1144                     {
1145                       if (strcmp (arg, "help") == 0)
1146                         print_help (context, TRUE, NULL);
1147                       else if (strcmp (arg, "help-all") == 0)
1148                         print_help (context, FALSE, NULL);
1149                       else if (strncmp (arg, "help-", 5) == 0)
1150                         {
1151                           GList *list;
1152
1153                           list = context->groups;
1154
1155                           while (list)
1156                             {
1157                               GOptionGroup *group = list->data;
1158
1159                               if (strcmp (arg + 5, group->name) == 0)
1160                                 print_help (context, FALSE, group);
1161
1162                               list = list->next;
1163                             }
1164                         }
1165                     }
1166
1167                   if (context->main_group &&
1168                       !parse_long_option (context, context->main_group, &i, arg,
1169                                           argc, argv, error, &parsed))
1170                     goto fail;
1171
1172                   if (parsed)
1173                     continue;
1174
1175                   /* Try the groups */
1176                   list = context->groups;
1177                   while (list)
1178                     {
1179                       GOptionGroup *group = list->data;
1180
1181                       if (!parse_long_option (context, group, &i, arg,
1182                                               argc, argv, error, &parsed))
1183                         goto fail;
1184
1185                       if (parsed)
1186                         break;
1187
1188                       list = list->next;
1189                     }
1190
1191                   if (parsed)
1192                     continue;
1193
1194                   /* Now look for --<group>-<option> */
1195                   dash = strchr (arg, '-');
1196                   if (dash)
1197                     {
1198                       /* Try the groups */
1199                       list = context->groups;
1200                       while (list)
1201                         {
1202                           GOptionGroup *group = list->data;
1203
1204                           if (strncmp (group->name, arg, dash - arg) == 0)
1205                             {
1206                               if (!parse_long_option (context, group, &i, dash + 1,
1207                                                       argc, argv, error, &parsed))
1208                                 goto fail;
1209
1210                               if (parsed)
1211                                 break;
1212                             }
1213
1214                           list = list->next;
1215                         }
1216                     }
1217
1218                   if (context->ignore_unknown)
1219                     continue;
1220                 }
1221               else
1222                 {
1223                   /* short option */
1224
1225                   gint new_i, j;
1226                   gboolean *nulled_out = NULL;
1227
1228                   arg = (*argv)[i] + 1;
1229
1230                   new_i = i;
1231
1232                   if (context->ignore_unknown)
1233                     nulled_out = g_new0 (gboolean, strlen (arg));
1234
1235                   for (j = 0; j < strlen (arg); j++)
1236                     {
1237                       parsed = FALSE;
1238
1239                       if (context->main_group &&
1240                           !parse_short_option (context, context->main_group,
1241                                                i, &new_i, arg[j],
1242                                                argc, argv, error, &parsed))
1243                         {
1244
1245                           g_free (nulled_out);
1246                           goto fail;
1247                         }
1248
1249                       if (!parsed)
1250                         {
1251                           /* Try the groups */
1252                           list = context->groups;
1253                           while (list)
1254                             {
1255                               GOptionGroup *group = list->data;
1256
1257                               if (!parse_short_option (context, group, i, &new_i, arg[j],
1258                                                        argc, argv, error, &parsed))
1259                                 goto fail;
1260
1261                               if (parsed)
1262                                 break;
1263
1264                               list = list->next;
1265                             }
1266                         }
1267
1268                       if (context->ignore_unknown)
1269                         {
1270                           if (parsed)
1271                             nulled_out[j] = TRUE;
1272                           else
1273                             continue;
1274                         }
1275
1276                       if (!parsed)
1277                         break;
1278                     }
1279
1280                   if (context->ignore_unknown)
1281                     {
1282                       gchar *new_arg = NULL;
1283                       gint arg_index = 0;
1284
1285                       for (j = 0; j < strlen (arg); j++)
1286                         {
1287                           if (!nulled_out[j])
1288                             {
1289                               if (!new_arg)
1290                                 new_arg = g_malloc (strlen (arg));
1291                               new_arg[arg_index++] = arg[j];
1292                             }
1293                         }
1294                       if (new_arg)
1295                         new_arg[arg_index] = '\0';
1296
1297                       add_pending_null (context, &((*argv)[i]), new_arg);
1298                     }
1299                   else if (parsed)
1300                     {
1301                       add_pending_null (context, &((*argv)[i]), NULL);
1302                       i = new_i;
1303                     }
1304                 }
1305
1306               if (!parsed && !context->ignore_unknown)
1307                 {
1308                   g_set_error (error,
1309                                G_OPTION_ERROR, G_OPTION_ERROR_UNKNOWN_OPTION,
1310                                _("Unknown option %s"), (*argv)[i]);
1311                   goto fail;
1312                 }
1313             }
1314           else
1315             {
1316               /* Collect remaining args */
1317               if (context->main_group &&
1318                   !parse_remaining_arg (context, context->main_group, &i,
1319                                         argc, argv, error, &parsed))
1320                 goto fail;
1321
1322             }
1323         }
1324
1325       /* Call post-parse hooks */
1326       list = context->groups;
1327       while (list)
1328         {
1329           GOptionGroup *group = list->data;
1330
1331           if (group->post_parse_func)
1332             {
1333               if (!(* group->post_parse_func) (context, group,
1334                                                group->user_data, error))
1335                 goto fail;
1336             }
1337
1338           list = list->next;
1339         }
1340
1341       if (context->main_group && context->main_group->post_parse_func)
1342         {
1343           if (!(* context->main_group->post_parse_func) (context, context->main_group,
1344                                                          context->main_group->user_data, error))
1345             goto fail;
1346         }
1347
1348       free_pending_nulls (context, TRUE);
1349
1350       for (i = 1; i < *argc; i++)
1351         {
1352           for (k = i; k < *argc; k++)
1353             if ((*argv)[k] != NULL)
1354               break;
1355
1356           if (k > i)
1357             {
1358               k -= i;
1359               for (j = i + k; j < *argc; j++)
1360                 {
1361                   (*argv)[j-k] = (*argv)[j];
1362                   (*argv)[j] = NULL;
1363                 }
1364               *argc -= k;
1365             }
1366         }
1367     }
1368
1369   return TRUE;
1370
1371  fail:
1372
1373   /* Call error hooks */
1374   list = context->groups;
1375   while (list)
1376     {
1377       GOptionGroup *group = list->data;
1378
1379       if (group->error_func)
1380         (* group->error_func) (context, group,
1381                                group->user_data, error);
1382
1383       list = list->next;
1384     }
1385
1386   if (context->main_group && context->main_group->error_func)
1387     (* context->main_group->error_func) (context, context->main_group,
1388                                          context->main_group->user_data, error);
1389
1390   free_changes_list (context, TRUE);
1391   free_pending_nulls (context, FALSE);
1392
1393   return FALSE;
1394 }
1395
1396 /**
1397  * g_option_group_new:
1398  * @name: the name for the option group, this is used to provide
1399  *   help for the options in this group with <option>--help-</option>@name
1400  * @description: a description for this group to be shown in
1401  *   <option>--help</option>. This string is translated using the translation
1402  *   domain or translation function of the group
1403  * @help_description: a description for the <option>--help-</option>@name option.
1404  *   This string is translated using the translation domain or translation function
1405  *   of the group
1406  * @user_data: user data that will be passed to the pre- and post-parse hooks,
1407  *   the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
1408  * @destroy: a function that will be called to free @user_data, or %NULL
1409  *
1410  * Creates a new #GOptionGroup.
1411  *
1412  * Return value: a newly created option group. It should be added
1413  *   to a #GOptionContext or freed with g_option_group_free().
1414  *
1415  * Since: 2.6
1416  **/
1417 GOptionGroup *
1418 g_option_group_new (const gchar    *name,
1419                     const gchar    *description,
1420                     const gchar    *help_description,
1421                     gpointer        user_data,
1422                     GDestroyNotify  destroy)
1423
1424 {
1425   GOptionGroup *group;
1426
1427   group = g_new0 (GOptionGroup, 1);
1428   group->name = g_strdup (name);
1429   group->description = g_strdup (description);
1430   group->help_description = g_strdup (help_description);
1431   group->user_data = user_data;
1432   group->destroy_notify = destroy;
1433
1434   return group;
1435 }
1436
1437
1438 /**
1439  * g_option_group_free:
1440  * @group: a #GOptionGroup
1441  *
1442  * Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
1443  * free groups which have been added to a #GOptionContext.
1444  *
1445  * Since: 2.6
1446  **/
1447 void
1448 g_option_group_free (GOptionGroup *group)
1449 {
1450   g_return_if_fail (group != NULL);
1451
1452   g_free (group->name);
1453   g_free (group->description);
1454   g_free (group->help_description);
1455
1456   g_free (group->entries);
1457
1458   if (group->destroy_notify)
1459     (* group->destroy_notify) (group->user_data);
1460
1461   if (group->translate_notify)
1462     (* group->translate_notify) (group->translate_data);
1463
1464   g_free (group);
1465 }
1466
1467
1468 /**
1469  * g_option_group_add_entries:
1470  * @group: a #GOptionGroup
1471  * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
1472  *
1473  * Adds the options specified in @entries to @group.
1474  *
1475  * Since: 2.6
1476  **/
1477 void
1478 g_option_group_add_entries (GOptionGroup       *group,
1479                             const GOptionEntry *entries)
1480 {
1481   gint n_entries;
1482
1483   g_return_if_fail (entries != NULL);
1484
1485   for (n_entries = 0; entries[n_entries].long_name != NULL; n_entries++);
1486
1487   group->entries = g_renew (GOptionEntry, group->entries, group->n_entries + n_entries);
1488
1489   memcpy (group->entries + group->n_entries, entries, sizeof (GOptionEntry) * n_entries);
1490
1491   group->n_entries += n_entries;
1492 }
1493
1494 /**
1495  * g_option_group_set_parse_hooks:
1496  * @group: a #GOptionGroup
1497  * @pre_parse_func: a function to call before parsing, or %NULL
1498  * @post_parse_func: a function to call after parsing, or %NULL
1499  *
1500  * Associates two functions with @group which will be called
1501  * from g_option_context_parse() before the first option is parsed
1502  * and after the last option has been parsed, respectively.
1503  *
1504  * Note that the user data to be passed to @pre_parse_func and
1505  * @post_parse_func can be specified when constructing the group
1506  * with g_option_group_new().
1507  *
1508  * Since: 2.6
1509  **/
1510 void
1511 g_option_group_set_parse_hooks (GOptionGroup     *group,
1512                                 GOptionParseFunc  pre_parse_func,
1513                                 GOptionParseFunc  post_parse_func)
1514 {
1515   g_return_if_fail (group != NULL);
1516
1517   group->pre_parse_func = pre_parse_func;
1518   group->post_parse_func = post_parse_func;
1519 }
1520
1521 /**
1522  * g_option_group_set_error_hook:
1523  * @group: a #GOptionGroup
1524  * @error_func: a function to call when an error occurs
1525  *
1526  * Associates a function with @group which will be called
1527  * from g_option_context_parse() when an error occurs.
1528  *
1529  * Note that the user data to be passed to @pre_parse_func and
1530  * @post_parse_func can be specified when constructing the group
1531  * with g_option_group_new().
1532  *
1533  * Since: 2.6
1534  **/
1535 void
1536 g_option_group_set_error_hook (GOptionGroup     *group,
1537                                GOptionErrorFunc  error_func)
1538 {
1539   g_return_if_fail (group != NULL);
1540
1541   group->error_func = error_func;
1542 }
1543
1544
1545 /**
1546  * g_option_group_set_translate_func:
1547  * @group: a #GOptionGroup
1548  * @func: the #GTranslateFunc, or %NULL
1549  * @data: user data to pass to @func, or %NULL
1550  * @destroy_notify: a function which gets called to free @data, or %NULL
1551  *
1552  * Sets the function which is used to translate user-visible
1553  * strings, for <option>--help</option> output. Different
1554  * groups can use different #GTranslateFunc<!-- -->s. If @func
1555  * is %NULL, strings are not translated.
1556  *
1557  * If you are using gettext(), you only need to set the translation
1558  * domain, see g_option_group_set_translation_domain().
1559  *
1560  * Since: 2.6
1561  **/
1562 void
1563 g_option_group_set_translate_func (GOptionGroup   *group,
1564                                    GTranslateFunc  func,
1565                                    gpointer        data,
1566                                    GDestroyNotify  destroy_notify)
1567 {
1568   g_return_if_fail (group != NULL);
1569
1570   if (group->translate_notify)
1571     group->translate_notify (group->translate_data);
1572
1573   group->translate_func = func;
1574   group->translate_data = data;
1575   group->translate_notify = destroy_notify;
1576 }
1577
1578 static gchar *
1579 dgettext_swapped (const gchar *msgid,
1580                   const gchar *domainname)
1581 {
1582   return dgettext (domainname, msgid);
1583 }
1584
1585 /**
1586  * g_option_group_set_translation_domain:
1587  * @group: a #GOptionGroup
1588  * @domain: the domain to use
1589  *
1590  * A convenience function to use gettext() for translating
1591  * user-visible strings.
1592  *
1593  * Since: 2.6
1594  **/
1595 void
1596 g_option_group_set_translation_domain (GOptionGroup *group,
1597                                        const gchar  *domain)
1598 {
1599   g_return_if_fail (group != NULL);
1600
1601   g_option_group_set_translate_func (group,
1602                                      (GTranslateFunc)dgettext_swapped,
1603                                      g_strdup (domain),
1604                                      g_free);
1605 }
1606