src/popt.c

   1 /* (C) 1998 Red Hat Software, Inc. -- Licensing details are in the COPYING
   2    file accompanying popt source distributions, available from
   3    ftp://ftp.redhat.com/pub/code/popt */
   4
   5 /** \file popt.c
   6  *  \brief Source: a module for parsing command line options
   7  */
   8
   9 #ifdef HAVE_CONFIG_H
  10 #include "config.h"
  11 #endif
  12
  13 #include "poptalloca.h"
  14 #include <errno.h>
  15 #include <ctype.h>
  16 #include <limits.h>
  17 #include <stdio.h>
  18 #include <stdlib.h>
  19 #include <string.h>
  20 #include <unistd.h>
  21
  22 #include "global.h"
  23 #include "findme.h"
  24 #include "popt.h"
  25 #include "poptint.h"
  26
  27 #ifndef HAVE_STRERROR
  28 static char * strerror(int errno) {
  29     extern int sys_nerr;
  30     extern char * sys_errlist[];
  31
  32     if ((0 <= errno) && (errno < sys_nerr))
  33         return sys_errlist[errno];
  34     else
  35         return POPT_("unknown errno");
  36 }
  37 #endif
  38
  39 void poptSetExecPath(poptContext con, const char * path, int allowAbsolute) {
  40     if (con->execPath) free(con->execPath);
  41     con->execPath = strdup(path);
  42     con->execAbsolute = allowAbsolute;
  43 }
  44
  45 static void invokeCallbacks(poptContext con, const struct poptOption * table,
  46                             int post) {
  47     const struct poptOption * opt = table;
  48
  49     while (opt->longName || opt->shortName || opt->arg.p) {
  50         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
  51             invokeCallbacks(con, opt->arg.p, post);
  52         } else if (((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK) &&
  53                    ((!post && (opt->argInfo & POPT_CBFLAG_PRE)) ||
  54                     ( post && (opt->argInfo & POPT_CBFLAG_POST)))) {
  55             opt->arg.f1(con, post ? POPT_CALLBACK_REASON_POST : POPT_CALLBACK_REASON_PRE,
  56                NULL, NULL, opt->descrip);
  57         }
  58         opt++;
  59     }
  60 }
  61
  62 poptContext poptGetContext(const char * name, int argc, char ** argv,
  63                            const struct poptOption * options, int flags) {
  64     poptContext con = malloc(sizeof(*con));
  65
  66     memset(con, 0, sizeof(*con));
  67
  68     con->os = con->optionStack;
  69     con->os->argc = argc;
  70     con->os->argv = argv;
  71
  72     if (!(flags & POPT_CONTEXT_KEEP_FIRST))
  73         con->os->next = 1;                      /* skip argv[0] */
  74
  75     con->leftovers = malloc(sizeof(char *) * (argc + 1));
  76     con->options = options;
  77     con->finalArgv = malloc(sizeof(*con->finalArgv) * (argc * 2));
  78     con->finalArgvAlloced = argc * 2;
  79     con->flags = flags;
  80     con->execAbsolute = 1;
  81
  82     if (getenv("POSIXLY_CORRECT") || getenv("POSIX_ME_HARDER"))
  83         con->flags |= POPT_CONTEXT_POSIXMEHARDER;
  84
  85     if (name)
  86         con->appName = strcpy(malloc(strlen(name) + 1), name);
  87
  88     invokeCallbacks(con, con->options, 0);
  89
  90     return con;
  91 }
  92
  93 void poptResetContext(poptContext con) {
  94     int i;
  95
  96     con->os = con->optionStack;
  97     con->os->currAlias = NULL;
  98     con->os->nextCharArg = NULL;
  99     con->os->nextArg = NULL;
 100     con->os->next = 1;                  /* skip argv[0] */
 101
 102     con->numLeftovers = 0;
 103     con->nextLeftover = 0;
 104     con->restLeftover = 0;
 105     con->doExec = NULL;
 106
 107     for (i = 0; i < con->finalArgvCount; i++)
 108         free(con->finalArgv[i]);
 109
 110     con->finalArgvCount = 0;
 111 }
 112
 113 /* Only one of longName, shortName may be set at a time */
 114 static int handleExec(poptContext con, char * longName, char shortName) {
 115     int i;
 116
 117     i = con->numExecs - 1;
 118     if (longName) {
 119         while (i >= 0 && (!con->execs[i].longName ||
 120             strcmp(con->execs[i].longName, longName))) i--;
 121     } else {
 122         while (i >= 0 &&
 123             con->execs[i].shortName != shortName) i--;
 124     }
 125
 126     if (i < 0) return 0;
 127
 128     if (con->flags & POPT_CONTEXT_NO_EXEC)
 129         return 1;
 130
 131     if (!con->doExec) {
 132         con->doExec = con->execs + i;
 133         return 1;
 134     }
 135
 136     /* We already have an exec to do; remember this option for next
 137        time 'round */
 138     if ((con->finalArgvCount + 1) >= (con->finalArgvAlloced)) {
 139         con->finalArgvAlloced += 10;
 140         con->finalArgv = realloc(con->finalArgv,
 141                         sizeof(*con->finalArgv) * con->finalArgvAlloced);
 142     }
 143
 144     i = con->finalArgvCount++;
 145     con->finalArgv[i] = malloc((longName ? strlen(longName) : 0) + 3);
 146     if (longName)
 147         sprintf(con->finalArgv[i], "--%s", longName);
 148     else
 149         sprintf(con->finalArgv[i], "-%c", shortName);
 150
 151     return 1;
 152 }
 153
 154 /* Only one of longName, shortName may be set at a time */
 155 static int handleAlias(poptContext con, char * longName, char shortName,
 156                        char * nextCharArg) {
 157     int i;
 158
 159     if (con->os->currAlias && con->os->currAlias->longName && longName &&
 160         !strcmp(con->os->currAlias->longName, longName))
 161         return 0;
 162     if (con->os->currAlias && shortName &&
 163             shortName == con->os->currAlias->shortName)
 164         return 0;
 165
 166     i = con->numAliases - 1;
 167     if (longName) {
 168         while (i >= 0 && (!con->aliases[i].longName ||
 169             strcmp(con->aliases[i].longName, longName))) i--;
 170     } else {
 171         while (i >= 0 &&
 172             con->aliases[i].shortName != shortName) i--;
 173     }
 174
 175     if (i < 0) return 0;
 176
 177     if ((con->os - con->optionStack + 1)
 178             == POPT_OPTION_DEPTH)
 179         return POPT_ERROR_OPTSTOODEEP;
 180
 181     if (nextCharArg && *nextCharArg)
 182         con->os->nextCharArg = nextCharArg;
 183
 184     con->os++;
 185     con->os->next = 0;
 186     con->os->stuffed = 0;
 187     con->os->nextArg = con->os->nextCharArg = NULL;
 188     con->os->currAlias = con->aliases + i;
 189     con->os->argc = con->os->currAlias->argc;
 190     con->os->argv = con->os->currAlias->argv;
 191
 192     return 1;
 193 }
 194
 195 static void execCommand(poptContext con) {
 196 #if 0
 197     char ** argv;
 198     int pos = 0;
 199     char * script = con->doExec->script;
 200
 201     argv = malloc(sizeof(*argv) *
 202                         (6 + con->numLeftovers + con->finalArgvCount));
 203
 204     if (!con->execAbsolute && strchr(script, '/')) return;
 205
 206     if (!strchr(script, '/') && con->execPath) {
 207         argv[pos] = alloca(strlen(con->execPath) + strlen(script) + 2);
 208         sprintf(argv[pos], "%s/%s", con->execPath, script);
 209     } else {
 210         argv[pos] = script;
 211     }
 212     pos++;
 213
 214     argv[pos] = findProgramPath(con->os->argv[0]);
 215     if (argv[pos]) pos++;
 216     argv[pos++] = ";";
 217
 218     memcpy(argv + pos, con->finalArgv, sizeof(*argv) * con->finalArgvCount);
 219     pos += con->finalArgvCount;
 220
 221     if (con->numLeftovers) {
 222         argv[pos++] = "--";
 223         memcpy(argv + pos, con->leftovers, sizeof(*argv) * con->numLeftovers);
 224         pos += con->numLeftovers;
 225     }
 226
 227     argv[pos++] = NULL;
 228
 229     execvp(argv[0], argv);
 230 #else
 231     (void) con;
 232     abort();
 233 #endif
 234 }
 235
 236 static const struct poptOption * findOption(const struct poptOption * table,
 237                                             const char * longName,
 238                                             char shortName,
 239                                             poptCallbackType * callback,
 240                                             void ** callbackData,
 241                                             int singleDash) {
 242     const struct poptOption * opt = table;
 243     const struct poptOption * opt2;
 244     const struct poptOption * cb = NULL;
 245
 246     /* This happens when a single - is given */
 247     if (singleDash && !shortName && !*longName)
 248         shortName = '-';
 249
 250     while (opt->longName || opt->shortName || opt->arg.p) {
 251         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
 252             opt2 = findOption(opt->arg.p, longName, shortName, callback,
 253                               callbackData, singleDash);
 254             if (opt2) {
 255                 if (*callback && !*callbackData)
 256                     *callbackData = opt->descrip;
 257                 return opt2;
 258             }
 259         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK) {
 260             cb = opt;
 261         } else if (longName && opt->longName &&
 262                    (!singleDash || (opt->argInfo & POPT_ARGFLAG_ONEDASH)) &&
 263                    !strcmp(longName, opt->longName)) {
 264             break;
 265         } else if (shortName && shortName == opt->shortName) {
 266             break;
 267         }
 268         opt++;
 269     }
 270
 271     if (!opt->longName && !opt->shortName) return NULL;
 272     *callbackData = NULL;
 273     *callback = NULL;
 274     if (cb) {
 275         *callback = cb->arg.f2;
 276         if (!(cb->argInfo & POPT_CBFLAG_INC_DATA))
 277             *callbackData = cb->descrip;
 278     }
 279
 280     return opt;
 281 }
 282
 283 /* returns 'val' element, -1 on last item, POPT_ERROR_* on error */
 284 int poptGetNextOpt(poptContext con) {
 285     char * optString, * chptr, * localOptString;
 286     char * longArg = NULL;
 287     char * origOptString;
 288     long aLong;
 289     char * end;
 290     const struct poptOption * opt = NULL;
 291     int done = 0;
 292     int i;
 293     poptCallbackType cb;
 294     void * cbData;
 295     int singleDash;
 296
 297     while (!done) {
 298         while (!con->os->nextCharArg && con->os->next == con->os->argc
 299                 && con->os > con->optionStack)
 300             con->os--;
 301         if (!con->os->nextCharArg && con->os->next == con->os->argc) {
 302             invokeCallbacks(con, con->options, 1);
 303             if (con->doExec) execCommand(con);
 304             return -1;
 305         }
 306
 307         if (!con->os->nextCharArg) {
 308
 309             origOptString = con->os->argv[con->os->next++];
 310
 311             if (con->restLeftover || *origOptString != '-') {
 312                 con->leftovers[con->numLeftovers++] = origOptString;
 313                 if (con->flags & POPT_CONTEXT_POSIXMEHARDER)
 314                     con->restLeftover = 1;
 315                 continue;
 316             }
 317
 318             /* Make a copy we can hack at */
 319             localOptString = optString =
 320                         strcpy(alloca(strlen(origOptString) + 1),
 321                         origOptString);
 322
 323             if (!optString[0])
 324                 return POPT_ERROR_BADOPT;
 325
 326             if (optString[1] == '-' && !optString[2]) {
 327                 con->restLeftover = 1;
 328                 continue;
 329             } else {
 330                 optString++;
 331                 if (*optString == '-')
 332                     singleDash = 0, optString++;
 333                 else
 334                     singleDash = 1;
 335
 336                 if (handleAlias(con, optString, '\0', NULL))
 337                     continue;
 338                 if (handleExec(con, optString, '\0'))
 339                     continue;
 340
 341                 chptr = optString;
 342                 while (*chptr && *chptr != '=') chptr++;
 343                 if (*chptr == '=') {
 344                     longArg = origOptString + (chptr - localOptString) + 1;
 345                     *chptr = '\0';
 346                 }
 347
 348                 opt = findOption(con->options, optString, '\0', &cb, &cbData,
 349                                  singleDash);
 350                 if (!opt && !singleDash) return POPT_ERROR_BADOPT;
 351             }
 352
 353             if (!opt)
 354                 con->os->nextCharArg = origOptString + 1;
 355         }
 356
 357         if (con->os->nextCharArg) {
 358             origOptString = con->os->nextCharArg;
 359
 360             con->os->nextCharArg = NULL;
 361
 362             if (handleAlias(con, NULL, *origOptString,
 363                             origOptString + 1)) {
 364                 origOptString++;
 365                 continue;
 366             }
 367             if (handleExec(con, NULL, *origOptString))
 368                 continue;
 369
 370             opt = findOption(con->options, NULL, *origOptString, &cb,
 371                              &cbData, 0);
 372             if (!opt) return POPT_ERROR_BADOPT;
 373
 374             origOptString++;
 375             if (*origOptString)
 376                 con->os->nextCharArg = origOptString;
 377         }
 378
 379         if (opt->arg.p && (opt->argInfo & POPT_ARG_MASK) == POPT_ARG_NONE) {
 380             *((int *)opt->arg.p) = 1;
 381         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_VAL) {
 382             if (opt->arg.p) *((int *) opt->arg.p) = opt->val;
 383         } else if ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE) {
 384             if (longArg) {
 385                 con->os->nextArg = longArg;
 386             } else if (con->os->nextCharArg) {
 387                 con->os->nextArg = con->os->nextCharArg;
 388                 con->os->nextCharArg = NULL;
 389             } else {
 390                 while (con->os->next == con->os->argc &&
 391                        con->os > con->optionStack)
 392                     con->os--;
 393                 if (con->os->next == con->os->argc)
 394                     return POPT_ERROR_NOARG;
 395
 396                 con->os->nextArg = con->os->argv[con->os->next++];
 397             }
 398
 399             if (opt->arg.p) {
 400                 switch (opt->argInfo & POPT_ARG_MASK) {
 401                   case POPT_ARG_STRING:
 402                     *((char **) opt->arg.p) = con->os->nextArg;
 403                     break;
 404
 405                   case POPT_ARG_INT:
 406                   case POPT_ARG_LONG:
 407                     aLong = strtol(con->os->nextArg, &end, 0);
 408                     if (!(end && *end == '\0'))
 409                         return POPT_ERROR_BADNUMBER;
 410
 411                     if (aLong == LONG_MIN || aLong == LONG_MAX)
 412                         return POPT_ERROR_OVERFLOW;
 413                     if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_LONG) {
 414                         *((long *) opt->arg.p) = aLong;
 415                     } else {
 416                         if (aLong > INT_MAX || aLong < INT_MIN)
 417                             return POPT_ERROR_OVERFLOW;
 418                         *((int *) opt->arg.p) =aLong;
 419                     }
 420                     break;
 421
 422                   default:
 423                     fprintf(stdout, POPT_("option type (%d) not implemented in popt\n"),
 424                       opt->argInfo & POPT_ARG_MASK);
 425                     exit(1);
 426                 }
 427             }
 428         }
 429
 430         if (cb)
 431             cb(con, POPT_CALLBACK_REASON_OPTION, opt, con->os->nextArg, cbData);
 432         else if (opt->val && ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_VAL))
 433             done = 1;
 434
 435         if ((con->finalArgvCount + 2) >= (con->finalArgvAlloced)) {
 436             con->finalArgvAlloced += 10;
 437             con->finalArgv = realloc(con->finalArgv,
 438                             sizeof(*con->finalArgv) * con->finalArgvAlloced);
 439         }
 440
 441         i = con->finalArgvCount++;
 442         con->finalArgv[i] =
 443                 malloc((opt->longName ? strlen(opt->longName) : 0) + 3);
 444         if (opt->longName)
 445             sprintf(con->finalArgv[i], "--%s", opt->longName);
 446         else
 447             sprintf(con->finalArgv[i], "-%c", opt->shortName);
 448
 449         if (opt->arg.p && (opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE
 450                      && (opt->argInfo & POPT_ARG_MASK) != POPT_ARG_VAL)
 451             con->finalArgv[con->finalArgvCount++] = strdup(con->os->nextArg);
 452     }
 453
 454     return opt->val;
 455 }
 456
 457 char * poptGetOptArg(poptContext con) {
 458     char * ret = con->os->nextArg;
 459     con->os->nextArg = NULL;
 460     return ret;
 461 }
 462
 463 char * poptGetArg(poptContext con) {
 464     if (con->numLeftovers == con->nextLeftover) return NULL;
 465     return (con->leftovers[con->nextLeftover++]);
 466 }
 467
 468 char * poptPeekArg(poptContext con) {
 469     if (con->numLeftovers == con->nextLeftover) return NULL;
 470     return (con->leftovers[con->nextLeftover]);
 471 }
 472
 473 char ** poptGetArgs(poptContext con) {
 474     if (con->numLeftovers == con->nextLeftover) return NULL;
 475
 476     /* some apps like [like RPM ;-) ] need this NULL terminated */
 477     con->leftovers[con->numLeftovers] = NULL;
 478
 479     return (con->leftovers + con->nextLeftover);
 480 }
 481
 482 void poptFreeContext(poptContext con) {
 483     int i;
 484
 485     for (i = 0; i < con->numAliases; i++) {
 486         if (con->aliases[i].longName) free(con->aliases[i].longName);
 487         free(con->aliases[i].argv);
 488     }
 489
 490     for (i = 0; i < con->numExecs; i++) {
 491         if (con->execs[i].longName) free(con->execs[i].longName);
 492         free(con->execs[i].script);
 493     }
 494
 495     for (i = 0; i < con->finalArgvCount; i++)
 496         free(con->finalArgv[i]);
 497
 498     free(con->leftovers);
 499     free(con->finalArgv);
 500     if (con->appName) free(con->appName);
 501     if (con->aliases) free(con->aliases);
 502     if (con->otherHelp) free(con->otherHelp);
 503     if (con->execPath) free(con->execPath);
 504     free(con);
 505 }
 506
 507 int poptAddAlias(poptContext con, struct poptAlias newAlias, int flags) {
 508     int aliasNum = con->numAliases++;
 509     struct poptAlias * alias;
 510
 511     (void) flags;
 512
 513     /* SunOS won't realloc(NULL, ...) */
 514     if (!con->aliases)
 515         con->aliases = malloc(sizeof(newAlias) * con->numAliases);
 516     else
 517         con->aliases = realloc(con->aliases,
 518                                sizeof(newAlias) * con->numAliases);
 519     alias = con->aliases + aliasNum;
 520
 521     *alias = newAlias;
 522     if (alias->longName)
 523         alias->longName = strcpy(malloc(strlen(alias->longName) + 1),
 524                                     alias->longName);
 525     else
 526         alias->longName = NULL;
 527
 528     return 0;
 529 }
 530
 531 char * poptBadOption(poptContext con, int flags) {
 532     struct optionStackEntry * os;
 533
 534     if (flags & POPT_BADOPTION_NOALIAS)
 535         os = con->optionStack;
 536     else
 537         os = con->os;
 538
 539     return os->argv[os->next - 1];
 540 }
 541
 542 #define POPT_ERROR_NOARG        -10
 543 #define POPT_ERROR_BADOPT       -11
 544 #define POPT_ERROR_OPTSTOODEEP  -13
 545 #define POPT_ERROR_BADQUOTE     -15     /* only from poptParseArgString() */
 546 #define POPT_ERROR_ERRNO        -16     /* only from poptParseArgString() */
 547
 548 const char * poptStrerror(const int error) {
 549     switch (error) {
 550       case POPT_ERROR_NOARG:
 551         return _("missing argument");
 552       case POPT_ERROR_BADOPT:
 553         return _("unknown option");
 554       case POPT_ERROR_OPTSTOODEEP:
 555         return POPT_("aliases nested too deeply");
 556       case POPT_ERROR_BADQUOTE:
 557         return POPT_("error in parameter quoting");
 558       case POPT_ERROR_BADNUMBER:
 559         return _("invalid numeric value");
 560       case POPT_ERROR_OVERFLOW:
 561         return POPT_("number too large or too small");
 562       case POPT_ERROR_ERRNO:
 563         return strerror(errno);
 564       default:
 565         return POPT_("unknown error");
 566     }
 567 }
 568
 569 int poptStuffArgs(poptContext con, char ** argv) {
 570     int i;
 571
 572     if ((con->os - con->optionStack) == POPT_OPTION_DEPTH)
 573         return POPT_ERROR_OPTSTOODEEP;
 574
 575     for (i = 0; argv[i]; i++);
 576
 577     con->os++;
 578     con->os->next = 0;
 579     con->os->nextArg = con->os->nextCharArg = NULL;
 580     con->os->currAlias = NULL;
 581     con->os->argc = i;
 582     con->os->argv = argv;
 583     con->os->stuffed = 1;
 584
 585     return 0;
 586 }
 587
 588 const char * poptGetInvocationName(poptContext con) {
 589     return con->os->argv[0];
 590 }