Changed _ABS to be defined as MY_ABS.
[rsync.git] / popt / popt.c
1 /** \ingroup popt
2  * \file popt/popt.c
3  */
4
5 /* (C) 1998-2002 Red Hat, Inc. -- Licensing details are in the COPYING
6    file accompanying popt source distributions, available from
7    ftp://ftp.rpm.org/pub/rpm/dist */
8
9 #undef  MYDEBUG
10
11 #include "system.h"
12
13 #if HAVE_FLOAT_H
14 #include <float.h>
15 #endif
16 #include <math.h>
17
18 #include "findme.h"
19 #include "poptint.h"
20
21 #ifndef DBL_EPSILON
22 #define DBL_EPSILON 2.2204460492503131e-16
23 #endif
24
25 #ifdef  MYDEBUG
26 /*@unchecked@*/
27 int _popt_debug = 0;
28 #endif
29
30 #if !defined(HAVE_STRERROR) && !defined(__LCLINT__)
31 static char * strerror(int errno)
32 {
33     extern int sys_nerr;
34     extern char * sys_errlist[];
35
36     if ((0 <= errno) && (errno < sys_nerr))
37         return sys_errlist[errno];
38     else
39         return POPT_("unknown errno");
40 }
41 #endif
42
43 #ifdef MYDEBUG
44 /*@unused@*/
45 static void prtcon(const char *msg, poptContext con)
46 {
47     if (msg) fprintf(stderr, "%s", msg);
48     fprintf(stderr, "\tcon %p os %p nextCharArg \"%s\" nextArg \"%s\" argv[%d] \"%s\"\n",
49         con, con->os,
50         (con->os->nextCharArg ? con->os->nextCharArg : ""),
51         (con->os->nextArg ? con->os->nextArg : ""),
52         con->os->next,
53         (con->os->argv && con->os->argv[con->os->next]
54                 ? con->os->argv[con->os->next] : ""));
55 }
56 #endif
57
58 void poptSetExecPath(poptContext con, const char * path, int allowAbsolute)
59 {
60     con->execPath = _free(con->execPath);
61     con->execPath = xstrdup(path);
62     con->execAbsolute = allowAbsolute;
63     /*@-nullstate@*/ /* LCL: con->execPath not NULL */
64     return;
65     /*@=nullstate@*/
66 }
67
68 static void invokeCallbacksPRE(poptContext con, const struct poptOption * opt)
69         /*@globals internalState@*/
70         /*@modifies internalState@*/
71 {
72     if (opt != NULL)
73     for (; opt->longName || opt->shortName || opt->arg; opt++) {
74         if (opt->arg == NULL) continue;         /* XXX program error. */
75         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
76             void * arg = opt->arg;
77 /*@-branchstate@*/
78             /* XXX sick hack to preserve pretense of ABI. */
79             if (arg == poptHelpOptions) arg = poptHelpOptionsI18N;
80 /*@=branchstate@*/
81             /* Recurse on included sub-tables. */
82             invokeCallbacksPRE(con, arg);
83         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK &&
84                    (opt->argInfo & POPT_CBFLAG_PRE))
85         {   /*@-castfcnptr@*/
86             poptCallbackType cb = (poptCallbackType)opt->arg;
87             /*@=castfcnptr@*/
88             /* Perform callback. */
89             /*@-noeffectuncon @*/
90             cb(con, POPT_CALLBACK_REASON_PRE, NULL, NULL, opt->descrip);
91             /*@=noeffectuncon @*/
92         }
93     }
94 }
95
96 static void invokeCallbacksPOST(poptContext con, const struct poptOption * opt)
97         /*@globals internalState@*/
98         /*@modifies internalState@*/
99 {
100     if (opt != NULL)
101     for (; opt->longName || opt->shortName || opt->arg; opt++) {
102         if (opt->arg == NULL) continue;         /* XXX program error. */
103         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
104             void * arg = opt->arg;
105 /*@-branchstate@*/
106             /* XXX sick hack to preserve pretense of ABI. */
107             if (arg == poptHelpOptions) arg = poptHelpOptionsI18N;
108 /*@=branchstate@*/
109             /* Recurse on included sub-tables. */
110             invokeCallbacksPOST(con, arg);
111         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK &&
112                    (opt->argInfo & POPT_CBFLAG_POST))
113         {   /*@-castfcnptr@*/
114             poptCallbackType cb = (poptCallbackType)opt->arg;
115             /*@=castfcnptr@*/
116             /* Perform callback. */
117             /*@-noeffectuncon @*/
118             cb(con, POPT_CALLBACK_REASON_POST, NULL, NULL, opt->descrip);
119             /*@=noeffectuncon @*/
120         }
121     }
122 }
123
124 static void invokeCallbacksOPTION(poptContext con,
125                                   const struct poptOption * opt,
126                                   const struct poptOption * myOpt,
127                                   /*@null@*/ const void * myData, int shorty)
128         /*@globals internalState@*/
129         /*@modifies internalState@*/
130 {
131     const struct poptOption * cbopt = NULL;
132
133     if (opt != NULL)
134     for (; opt->longName || opt->shortName || opt->arg; opt++) {
135         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
136             void * arg = opt->arg;
137 /*@-branchstate@*/
138             /* XXX sick hack to preserve pretense of ABI. */
139             if (arg == poptHelpOptions) arg = poptHelpOptionsI18N;
140 /*@=branchstate@*/
141             /* Recurse on included sub-tables. */
142             if (opt->arg != NULL)       /* XXX program error */
143                 invokeCallbacksOPTION(con, opt->arg, myOpt, myData, shorty);
144         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK &&
145                   !(opt->argInfo & POPT_CBFLAG_SKIPOPTION)) {
146             /* Save callback info. */
147             cbopt = opt;
148         } else if (cbopt != NULL &&
149                    ((myOpt->shortName && opt->shortName && shorty &&
150                         myOpt->shortName == opt->shortName) ||
151                     (myOpt->longName && opt->longName &&
152                 /*@-nullpass@*/         /* LCL: opt->longName != NULL */
153                         !strcmp(myOpt->longName, opt->longName)))
154                 /*@=nullpass@*/
155                    )
156         {   /*@-castfcnptr@*/
157             poptCallbackType cb = (poptCallbackType)cbopt->arg;
158             /*@=castfcnptr@*/
159             const void * cbData = (cbopt->descrip ? cbopt->descrip : myData);
160             /* Perform callback. */
161             if (cb != NULL) {   /* XXX program error */
162                 /*@-noeffectuncon @*/
163                 cb(con, POPT_CALLBACK_REASON_OPTION, myOpt,
164                         con->os->nextArg, cbData);
165                 /*@=noeffectuncon @*/
166             }
167             /* Terminate (unless explcitly continuing). */
168             if (!(cbopt->argInfo & POPT_CBFLAG_CONTINUE))
169                 return;
170         }
171     }
172 }
173
174 poptContext poptGetContext(const char * name, int argc, const char ** argv,
175                            const struct poptOption * options, int flags)
176 {
177     poptContext con = malloc(sizeof(*con));
178
179     if (con == NULL) return NULL;       /* XXX can't happen */
180     memset(con, 0, sizeof(*con));
181
182     con->os = con->optionStack;
183     con->os->argc = argc;
184     /*@-dependenttrans -assignexpose@*/ /* FIX: W2DO? */
185     con->os->argv = argv;
186     /*@=dependenttrans =assignexpose@*/
187     con->os->argb = NULL;
188
189     if (!(flags & POPT_CONTEXT_KEEP_FIRST))
190         con->os->next = 1;                      /* skip argv[0] */
191
192     con->leftovers = calloc( (argc + 1), sizeof(*con->leftovers) );
193     /*@-dependenttrans -assignexpose@*/ /* FIX: W2DO? */
194     con->options = options;
195     /*@=dependenttrans =assignexpose@*/
196     con->aliases = NULL;
197     con->numAliases = 0;
198     con->flags = flags;
199     con->execs = NULL;
200     con->numExecs = 0;
201     con->finalArgvAlloced = argc * 2;
202     con->finalArgv = calloc( con->finalArgvAlloced, sizeof(*con->finalArgv) );
203     con->execAbsolute = 1;
204     con->arg_strip = NULL;
205
206     if (getenv("POSIXLY_CORRECT") || getenv("POSIX_ME_HARDER"))
207         con->flags |= POPT_CONTEXT_POSIXMEHARDER;
208
209     if (name) {
210         size_t bufsize = strlen(name) + 1;
211         char * t = malloc(bufsize);
212         if (t) {
213             strlcpy(t, name, bufsize);
214             con->appName = t;
215         }
216     }
217
218     /*@-internalglobs@*/
219     invokeCallbacksPRE(con, con->options);
220     /*@=internalglobs@*/
221
222     return con;
223 }
224
225 static void cleanOSE(/*@special@*/ struct optionStackEntry *os)
226         /*@uses os @*/
227         /*@releases os->nextArg, os->argv, os->argb @*/
228         /*@modifies os @*/
229 {
230     os->nextArg = _free(os->nextArg);
231     os->argv = _free(os->argv);
232     os->argb = PBM_FREE(os->argb);
233 }
234
235 /*@-boundswrite@*/
236 void poptResetContext(poptContext con)
237 {
238     int i;
239
240     if (con == NULL) return;
241     while (con->os > con->optionStack) {
242         cleanOSE(con->os--);
243     }
244     con->os->argb = PBM_FREE(con->os->argb);
245     con->os->currAlias = NULL;
246     con->os->nextCharArg = NULL;
247     con->os->nextArg = NULL;
248     con->os->next = 1;                  /* skip argv[0] */
249
250     con->numLeftovers = 0;
251     con->nextLeftover = 0;
252     con->restLeftover = 0;
253     con->doExec = NULL;
254
255     if (con->finalArgv != NULL)
256     for (i = 0; i < con->finalArgvCount; i++) {
257         /*@-unqualifiedtrans@*/         /* FIX: typedef double indirection. */
258         con->finalArgv[i] = _free(con->finalArgv[i]);
259         /*@=unqualifiedtrans@*/
260     }
261
262     con->finalArgvCount = 0;
263     con->arg_strip = PBM_FREE(con->arg_strip);
264     /*@-nullstate@*/    /* FIX: con->finalArgv != NULL */
265     return;
266     /*@=nullstate@*/
267 }
268 /*@=boundswrite@*/
269
270 /* Only one of longName, shortName should be set, not both. */
271 /*@-boundswrite@*/
272 static int handleExec(/*@special@*/ poptContext con,
273                 /*@null@*/ const char * longName, char shortName)
274         /*@uses con->execs, con->numExecs, con->flags, con->doExec,
275                 con->finalArgv, con->finalArgvAlloced, con->finalArgvCount @*/
276         /*@modifies con @*/
277 {
278     poptItem item;
279     int i;
280
281     if (con->execs == NULL || con->numExecs <= 0) /* XXX can't happen */
282         return 0;
283
284     for (i = con->numExecs - 1; i >= 0; i--) {
285         item = con->execs + i;
286         if (longName && !(item->option.longName &&
287                         !strcmp(longName, item->option.longName)))
288             continue;
289         else if (shortName != item->option.shortName)
290             continue;
291         break;
292     }
293     if (i < 0) return 0;
294
295
296     if (con->flags & POPT_CONTEXT_NO_EXEC)
297         return 1;
298
299     if (con->doExec == NULL) {
300         con->doExec = con->execs + i;
301         return 1;
302     }
303
304     /* We already have an exec to do; remember this option for next
305        time 'round */
306     if ((con->finalArgvCount + 1) >= (con->finalArgvAlloced)) {
307         con->finalArgvAlloced += 10;
308         con->finalArgv = realloc(con->finalArgv,
309                         sizeof(*con->finalArgv) * con->finalArgvAlloced);
310     }
311
312     i = con->finalArgvCount++;
313     if (con->finalArgv != NULL) /* XXX can't happen */
314     {   size_t bufsize = (longName ? strlen(longName) : 0) + 3;
315         char *s  = malloc(bufsize);
316         if (s != NULL) {        /* XXX can't happen */
317             if (longName)
318                 snprintf(s, bufsize, "--%s", longName);
319             else
320                 snprintf(s, bufsize, "-%c", shortName);
321             con->finalArgv[i] = s;
322         } else
323             con->finalArgv[i] = NULL;
324     }
325
326     /*@-nullstate@*/    /* FIX: con->finalArgv[] == NULL */
327     return 1;
328     /*@=nullstate@*/
329 }
330 /*@=boundswrite@*/
331
332 /* Only one of longName, shortName may be set at a time */
333 static int handleAlias(/*@special@*/ poptContext con,
334                 /*@null@*/ const char * longName, char shortName,
335                 /*@exposed@*/ /*@null@*/ const char * nextCharArg)
336         /*@uses con->aliases, con->numAliases, con->optionStack, con->os,
337                 con->os->currAlias, con->os->currAlias->option.longName @*/
338         /*@modifies con @*/
339 {
340     poptItem item = con->os->currAlias;
341     int rc;
342     int i;
343
344     if (item) {
345         if (longName && (item->option.longName &&
346                 !strcmp(longName, item->option.longName)))
347             return 0;
348         if (shortName && shortName == item->option.shortName)
349             return 0;
350     }
351
352     if (con->aliases == NULL || con->numAliases <= 0) /* XXX can't happen */
353         return 0;
354
355     for (i = con->numAliases - 1; i >= 0; i--) {
356         item = con->aliases + i;
357         if (longName && !(item->option.longName &&
358                         !strcmp(longName, item->option.longName)))
359             continue;
360         else if (shortName != item->option.shortName)
361             continue;
362         break;
363     }
364     if (i < 0) return 0;
365
366     if ((con->os - con->optionStack + 1) == POPT_OPTION_DEPTH)
367         return POPT_ERROR_OPTSTOODEEP;
368
369 /*@-boundsread@*/
370     if (nextCharArg && *nextCharArg)
371         con->os->nextCharArg = nextCharArg;
372 /*@=boundsread@*/
373
374     con->os++;
375     con->os->next = 0;
376     con->os->stuffed = 0;
377     con->os->nextArg = NULL;
378     con->os->nextCharArg = NULL;
379     con->os->currAlias = con->aliases + i;
380     rc = poptDupArgv(con->os->currAlias->argc, con->os->currAlias->argv,
381                 &con->os->argc, &con->os->argv);
382     con->os->argb = NULL;
383
384     return (rc ? rc : 1);
385 }
386
387 /*@-bounds -boundswrite @*/
388 static int execCommand(poptContext con)
389         /*@globals internalState @*/
390         /*@modifies internalState @*/
391 {
392     poptItem item = con->doExec;
393     const char ** argv;
394     int argc = 0;
395     int rc;
396
397     if (item == NULL) /*XXX can't happen*/
398         return POPT_ERROR_NOARG;
399
400     if (item->argv == NULL || item->argc < 1 ||
401         (!con->execAbsolute && strchr(item->argv[0], '/')))
402             return POPT_ERROR_NOARG;
403
404     argv = malloc(sizeof(*argv) *
405                         (6 + item->argc + con->numLeftovers + con->finalArgvCount));
406     if (argv == NULL) return POPT_ERROR_MALLOC;
407
408     if (!strchr(item->argv[0], '/') && con->execPath != NULL) {
409         size_t bufsize = strlen(con->execPath) + strlen(item->argv[0]) + sizeof "/";
410         char *s = alloca(bufsize);
411         snprintf(s, bufsize, "%s/%s", con->execPath, item->argv[0]);
412         argv[argc] = s;
413     } else
414         argv[argc] = findProgramPath(item->argv[0]);
415     if (argv[argc++] == NULL) return POPT_ERROR_NOARG;
416
417     if (item->argc > 1) {
418         memcpy(argv + argc, item->argv + 1, sizeof(*argv) * (item->argc - 1));
419         argc += (item->argc - 1);
420     }
421
422     if (con->finalArgv != NULL && con->finalArgvCount > 0) {
423         memcpy(argv + argc, con->finalArgv,
424                 sizeof(*argv) * con->finalArgvCount);
425         argc += con->finalArgvCount;
426     }
427
428     if (con->leftovers != NULL && con->numLeftovers > 0) {
429         memcpy(argv + argc, con->leftovers, sizeof(*argv) * con->numLeftovers);
430         argc += con->numLeftovers;
431     }
432
433     argv[argc] = NULL;
434
435 #ifdef __hpux
436     rc = setresgid(getgid(), getgid(),-1);
437     if (rc) return POPT_ERROR_ERRNO;
438     rc = setresuid(getuid(), getuid(),-1);
439     if (rc) return POPT_ERROR_ERRNO;
440 #else
441 /*
442  * XXX " ... on BSD systems setuid() should be preferred over setreuid()"
443  * XXX  sez' Timur Bakeyev <mc@bat.ru>
444  * XXX  from Norbert Warmuth <nwarmuth@privat.circular.de>
445  */
446 #if defined(HAVE_SETUID)
447     rc = setgid(getgid());
448     if (rc) return POPT_ERROR_ERRNO;
449     rc = setuid(getuid());
450     if (rc) return POPT_ERROR_ERRNO;
451 #elif defined (HAVE_SETREUID)
452     rc = setregid(getgid(), getgid());
453     if (rc) return POPT_ERROR_ERRNO;
454     rc = setreuid(getuid(), getuid());
455     if (rc) return POPT_ERROR_ERRNO;
456 #else
457     ; /* Can't drop privileges */
458 #endif
459 #endif
460
461     if (argv[0] == NULL)
462         return POPT_ERROR_NOARG;
463
464 #ifdef  MYDEBUG
465 if (_popt_debug)
466     {   const char ** avp;
467         fprintf(stderr, "==> execvp(%s) argv[%d]:", argv[0], argc);
468         for (avp = argv; *avp; avp++)
469             fprintf(stderr, " '%s'", *avp);
470         fprintf(stderr, "\n");
471     }
472 #endif
473
474     rc = execvp(argv[0], (char *const *)argv);
475
476     return POPT_ERROR_ERRNO;
477 }
478 /*@=bounds =boundswrite @*/
479
480 /*@-boundswrite@*/
481 /*@observer@*/ /*@null@*/ static const struct poptOption *
482 findOption(const struct poptOption * opt, /*@null@*/ const char * longName,
483                 char shortName,
484                 /*@null@*/ /*@out@*/ poptCallbackType * callback,
485                 /*@null@*/ /*@out@*/ const void ** callbackData,
486                 int singleDash)
487         /*@modifies *callback, *callbackData */
488 {
489     const struct poptOption * cb = NULL;
490
491     /* This happens when a single - is given */
492     if (singleDash && !shortName && (longName && *longName == '\0'))
493         shortName = '-';
494
495     for (; opt->longName || opt->shortName || opt->arg; opt++) {
496
497         if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_INCLUDE_TABLE) {
498             const struct poptOption * opt2;
499             void * arg = opt->arg;
500
501 /*@-branchstate@*/
502             /* XXX sick hack to preserve pretense of ABI. */
503             if (arg == poptHelpOptions) arg = poptHelpOptionsI18N;
504 /*@=branchstate@*/
505             /* Recurse on included sub-tables. */
506             if (arg == NULL) continue;  /* XXX program error */
507             opt2 = findOption(arg, longName, shortName, callback,
508                               callbackData, singleDash);
509             if (opt2 == NULL) continue;
510             /* Sub-table data will be inheirited if no data yet. */
511             if (!(callback && *callback)) return opt2;
512             if (!(callbackData && *callbackData == NULL)) return opt2;
513             /*@-observertrans -dependenttrans @*/
514             *callbackData = opt->descrip;
515             /*@=observertrans =dependenttrans @*/
516             return opt2;
517         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_CALLBACK) {
518             cb = opt;
519         } else if (longName && opt->longName &&
520                    (!singleDash || (opt->argInfo & POPT_ARGFLAG_ONEDASH)) &&
521                 /*@-nullpass@*/         /* LCL: opt->longName != NULL */
522                    !strcmp(longName, opt->longName))
523                 /*@=nullpass@*/
524         {
525             break;
526         } else if (shortName && shortName == opt->shortName) {
527             break;
528         }
529     }
530
531     if (!opt->longName && !opt->shortName)
532         return NULL;
533     /*@-modobserver -mods @*/
534     if (callback) *callback = NULL;
535     if (callbackData) *callbackData = NULL;
536     if (cb) {
537         if (callback)
538         /*@-castfcnptr@*/
539             *callback = (poptCallbackType)cb->arg;
540         /*@=castfcnptr@*/
541         if (!(cb->argInfo & POPT_CBFLAG_INC_DATA)) {
542             if (callbackData)
543                 /*@-observertrans@*/    /* FIX: typedef double indirection. */
544                 *callbackData = cb->descrip;
545                 /*@=observertrans@*/
546         }
547     }
548     /*@=modobserver =mods @*/
549
550     return opt;
551 }
552 /*@=boundswrite@*/
553
554 static const char * findNextArg(/*@special@*/ poptContext con,
555                 unsigned argx, int delete_arg)
556         /*@uses con->optionStack, con->os,
557                 con->os->next, con->os->argb, con->os->argc, con->os->argv @*/
558         /*@modifies con @*/
559 {
560     struct optionStackEntry * os = con->os;
561     const char * arg;
562
563     do {
564         int i;
565         arg = NULL;
566         while (os->next == os->argc && os > con->optionStack) os--;
567         if (os->next == os->argc && os == con->optionStack) break;
568         if (os->argv != NULL)
569         for (i = os->next; i < os->argc; i++) {
570             /*@-sizeoftype@*/
571             if (os->argb && PBM_ISSET(i, os->argb))
572                 /*@innercontinue@*/ continue;
573             if (*os->argv[i] == '-')
574                 /*@innercontinue@*/ continue;
575             if (--argx > 0)
576                 /*@innercontinue@*/ continue;
577             arg = os->argv[i];
578             if (delete_arg) {
579                 if (os->argb == NULL) os->argb = PBM_ALLOC(os->argc);
580                 if (os->argb != NULL)   /* XXX can't happen */
581                 PBM_SET(i, os->argb);
582             }
583             /*@innerbreak@*/ break;
584             /*@=sizeoftype@*/
585         }
586         if (os > con->optionStack) os--;
587     } while (arg == NULL);
588     return arg;
589 }
590
591 /*@-boundswrite@*/
592 static /*@only@*/ /*@null@*/ const char *
593 expandNextArg(/*@special@*/ poptContext con, const char * s)
594         /*@uses con->optionStack, con->os,
595                 con->os->next, con->os->argb, con->os->argc, con->os->argv @*/
596         /*@modifies con @*/
597 {
598     const char * a = NULL;
599     size_t alen, pos;
600     char *t, *te;
601     size_t tn = strlen(s) + 1;
602     char c;
603
604     te = t = malloc(tn);;
605     if (t == NULL) return NULL;         /* XXX can't happen */
606     while ((c = *s++) != '\0') {
607         switch (c) {
608 #if 0   /* XXX can't do this */
609         case '\\':      /* escape */
610             c = *s++;
611             /*@switchbreak@*/ break;
612 #endif
613         case '!':
614             if (!(s[0] == '#' && s[1] == ':' && s[2] == '+'))
615                 /*@switchbreak@*/ break;
616             /* XXX Make sure that findNextArg deletes only next arg. */
617             if (a == NULL) {
618                 if ((a = findNextArg(con, 1, 1)) == NULL)
619                     /*@switchbreak@*/ break;
620             }
621             s += 3;
622
623             alen = strlen(a);
624             tn += alen;
625             pos = te - t;
626             t = realloc(t, tn);
627             te = t + pos;
628             strncpy(te, a, alen); te += alen;
629             continue;
630             /*@notreached@*/ /*@switchbreak@*/ break;
631         default:
632             /*@switchbreak@*/ break;
633         }
634         *te++ = c;
635     }
636     *te = '\0';
637     t = realloc(t, strlen(t) + 1);      /* XXX memory leak, hard to plug */
638     return t;
639 }
640 /*@=boundswrite@*/
641
642 static void poptStripArg(/*@special@*/ poptContext con, int which)
643         /*@uses con->arg_strip, con->optionStack @*/
644         /*@defines con->arg_strip @*/
645         /*@modifies con @*/
646 {
647     /*@-sizeoftype@*/
648     if (con->arg_strip == NULL)
649         con->arg_strip = PBM_ALLOC(con->optionStack[0].argc);
650     if (con->arg_strip != NULL)         /* XXX can't happen */
651     PBM_SET(which, con->arg_strip);
652     /*@=sizeoftype@*/
653     /*@-compdef@*/ /* LCL: con->arg_strip udefined? */
654     return;
655     /*@=compdef@*/
656 }
657
658 int poptSaveLong(long * arg, int argInfo, long aLong)
659 {
660     /* XXX Check alignment, may fail on funky platforms. */
661     if (arg == NULL || (((unsigned long)arg) & (sizeof(*arg)-1)))
662         return POPT_ERROR_NULLARG;
663
664     if (argInfo & POPT_ARGFLAG_NOT)
665         aLong = ~aLong;
666     switch (argInfo & POPT_ARGFLAG_LOGICALOPS) {
667     case 0:
668         *arg = aLong;
669         break;
670     case POPT_ARGFLAG_OR:
671         *arg |= aLong;
672         break;
673     case POPT_ARGFLAG_AND:
674         *arg &= aLong;
675         break;
676     case POPT_ARGFLAG_XOR:
677         *arg ^= aLong;
678         break;
679     default:
680         return POPT_ERROR_BADOPERATION;
681         /*@notreached@*/ break;
682     }
683     return 0;
684 }
685
686 int poptSaveInt(/*@null@*/ int * arg, int argInfo, long aLong)
687 {
688     /* XXX Check alignment, may fail on funky platforms. */
689     if (arg == NULL || (((unsigned long)arg) & (sizeof(*arg)-1)))
690         return POPT_ERROR_NULLARG;
691
692     if (argInfo & POPT_ARGFLAG_NOT)
693         aLong = ~aLong;
694     switch (argInfo & POPT_ARGFLAG_LOGICALOPS) {
695     case 0:
696         *arg = aLong;
697         break;
698     case POPT_ARGFLAG_OR:
699         *arg |= aLong;
700         break;
701     case POPT_ARGFLAG_AND:
702         *arg &= aLong;
703         break;
704     case POPT_ARGFLAG_XOR:
705         *arg ^= aLong;
706         break;
707     default:
708         return POPT_ERROR_BADOPERATION;
709         /*@notreached@*/ break;
710     }
711     return 0;
712 }
713
714 /*@-boundswrite@*/
715 /* returns 'val' element, -1 on last item, POPT_ERROR_* on error */
716 int poptGetNextOpt(poptContext con)
717 {
718     const struct poptOption * opt = NULL;
719     int done = 0;
720
721     if (con == NULL)
722         return -1;
723     while (!done) {
724         const char * origOptString = NULL;
725         poptCallbackType cb = NULL;
726         const void * cbData = NULL;
727         const char * longArg = NULL;
728         int canstrip = 0;
729         int shorty = 0;
730
731         while (!con->os->nextCharArg && con->os->next == con->os->argc
732                 && con->os > con->optionStack) {
733             cleanOSE(con->os--);
734         }
735         if (!con->os->nextCharArg && con->os->next == con->os->argc) {
736             /*@-internalglobs@*/
737             invokeCallbacksPOST(con, con->options);
738             /*@=internalglobs@*/
739             if (con->doExec) return execCommand(con);
740             return -1;
741         }
742
743         /* Process next long option */
744         if (!con->os->nextCharArg) {
745             char * localOptString, * optString;
746             int thisopt;
747
748             /*@-sizeoftype@*/
749             if (con->os->argb && PBM_ISSET(con->os->next, con->os->argb)) {
750                 con->os->next++;
751                 continue;
752             }
753             /*@=sizeoftype@*/
754             thisopt = con->os->next;
755             if (con->os->argv != NULL)  /* XXX can't happen */
756             origOptString = con->os->argv[con->os->next++];
757
758             if (origOptString == NULL)  /* XXX can't happen */
759                 return POPT_ERROR_BADOPT;
760
761             if (con->restLeftover || *origOptString != '-') {
762                 if (con->flags & POPT_CONTEXT_POSIXMEHARDER)
763                     con->restLeftover = 1;
764                 if (con->flags & POPT_CONTEXT_ARG_OPTS) {
765                     con->os->nextArg = xstrdup(origOptString);
766                     return 0;
767                 }
768                 if (con->leftovers != NULL)     /* XXX can't happen */
769                     con->leftovers[con->numLeftovers++] = origOptString;
770                 continue;
771             }
772
773             /* Make a copy we can hack at */
774             {   size_t bufsize = strlen(origOptString) + 1;
775                 localOptString = optString = alloca(bufsize);
776                 if (optString == NULL) /* XXX can't happen */
777                     return POPT_ERROR_BADOPT;
778                 strlcpy(optString, origOptString, bufsize);
779             }
780
781             if (optString[0] == '\0')
782                 return POPT_ERROR_BADOPT;
783
784             if (optString[1] == '-' && !optString[2]) {
785                 con->restLeftover = 1;
786                 continue;
787             } else {
788                 char *oe;
789                 int singleDash;
790
791                 optString++;
792                 if (*optString == '-')
793                     singleDash = 0, optString++;
794                 else
795                     singleDash = 1;
796
797                 /* XXX aliases with arg substitution need "--alias=arg" */
798                 if (handleAlias(con, optString, '\0', NULL))
799                     continue;
800
801                 if (handleExec(con, optString, '\0'))
802                     continue;
803
804                 /* Check for "--long=arg" option. */
805                 for (oe = optString; *oe && *oe != '='; oe++)
806                     {};
807                 if (*oe == '=') {
808                     *oe++ = '\0';
809                     /* XXX longArg is mapped back to persistent storage. */
810                     longArg = origOptString + (oe - localOptString);
811                 }
812
813                 opt = findOption(con->options, optString, '\0', &cb, &cbData,
814                                  singleDash);
815                 if (!opt && !singleDash)
816                     return POPT_ERROR_BADOPT;
817             }
818
819             if (!opt) {
820                 con->os->nextCharArg = origOptString + 1;
821             } else {
822                 if (con->os == con->optionStack &&
823                    opt->argInfo & POPT_ARGFLAG_STRIP)
824                 {
825                     canstrip = 1;
826                     poptStripArg(con, thisopt);
827                 }
828                 shorty = 0;
829             }
830         }
831
832         /* Process next short option */
833         /*@-branchstate@*/              /* FIX: W2DO? */
834         if (con->os->nextCharArg) {
835             origOptString = con->os->nextCharArg;
836
837             con->os->nextCharArg = NULL;
838
839             if (handleAlias(con, NULL, *origOptString, origOptString + 1))
840                 continue;
841
842             if (handleExec(con, NULL, *origOptString)) {
843                 /* Restore rest of short options for further processing */
844                 origOptString++;
845                 if (*origOptString != '\0')
846                     con->os->nextCharArg = origOptString;
847                 continue;
848             }
849
850             opt = findOption(con->options, NULL, *origOptString, &cb,
851                              &cbData, 0);
852             if (!opt)
853                 return POPT_ERROR_BADOPT;
854             shorty = 1;
855
856             origOptString++;
857             if (*origOptString != '\0')
858                 con->os->nextCharArg = origOptString;
859         }
860         /*@=branchstate@*/
861
862         if (opt == NULL) return POPT_ERROR_BADOPT;      /* XXX can't happen */
863         if (opt->arg && (opt->argInfo & POPT_ARG_MASK) == POPT_ARG_NONE) {
864             if (poptSaveInt((int *)opt->arg, opt->argInfo, 1L))
865                 return POPT_ERROR_BADOPERATION;
866         } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_VAL) {
867             if (opt->arg) {
868                 if (poptSaveInt((int *)opt->arg, opt->argInfo, (long)opt->val))
869                     return POPT_ERROR_BADOPERATION;
870             }
871         } else if ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE) {
872             con->os->nextArg = _free(con->os->nextArg);
873             /*@-usedef@*/       /* FIX: W2DO? */
874             if (longArg) {
875             /*@=usedef@*/
876                 longArg = expandNextArg(con, longArg);
877                 con->os->nextArg = longArg;
878             } else if (con->os->nextCharArg) {
879                 longArg = expandNextArg(con, con->os->nextCharArg);
880                 con->os->nextArg = longArg;
881                 con->os->nextCharArg = NULL;
882             } else {
883                 while (con->os->next == con->os->argc &&
884                        con->os > con->optionStack) {
885                     cleanOSE(con->os--);
886                 }
887                 if (con->os->next == con->os->argc) {
888                     if (!(opt->argInfo & POPT_ARGFLAG_OPTIONAL))
889                         /*@-compdef@*/  /* FIX: con->os->argv not defined */
890                         return POPT_ERROR_NOARG;
891                         /*@=compdef@*/
892                     con->os->nextArg = NULL;
893                 } else {
894
895                     /*
896                      * Make sure this isn't part of a short arg or the
897                      * result of an alias expansion.
898                      */
899                     if (con->os == con->optionStack &&
900                         (opt->argInfo & POPT_ARGFLAG_STRIP) &&
901                         canstrip) {
902                         poptStripArg(con, con->os->next);
903                     }
904                 
905                     if (con->os->argv != NULL) {        /* XXX can't happen */
906                         /* XXX watchout: subtle side-effects live here. */
907                         longArg = con->os->argv[con->os->next++];
908                         longArg = expandNextArg(con, longArg);
909                         con->os->nextArg = longArg;
910                     }
911                 }
912             }
913             longArg = NULL;
914
915             if (opt->arg) {
916                 switch (opt->argInfo & POPT_ARG_MASK) {
917                 case POPT_ARG_STRING:
918                     /* XXX memory leak, hard to plug */
919                     *((const char **) opt->arg) = (con->os->nextArg)
920                         ? xstrdup(con->os->nextArg) : NULL;
921                     /*@switchbreak@*/ break;
922
923                 case POPT_ARG_INT:
924                 case POPT_ARG_LONG:
925                 {   long aLong = 0;
926                     char *end;
927
928                     if (con->os->nextArg) {
929                         aLong = strtol(con->os->nextArg, &end, 0);
930                         if (!(end && *end == '\0'))
931                             return POPT_ERROR_BADNUMBER;
932                     }
933
934                     if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_LONG) {
935                         if (aLong == LONG_MIN || aLong == LONG_MAX)
936                             return POPT_ERROR_OVERFLOW;
937                         if (poptSaveLong((long *)opt->arg, opt->argInfo, aLong))
938                             return POPT_ERROR_BADOPERATION;
939                     } else {
940                         if (aLong > INT_MAX || aLong < INT_MIN)
941                             return POPT_ERROR_OVERFLOW;
942                         if (poptSaveInt((int *)opt->arg, opt->argInfo, aLong))
943                             return POPT_ERROR_BADOPERATION;
944                     }
945                 }   /*@switchbreak@*/ break;
946
947                 case POPT_ARG_FLOAT:
948                 case POPT_ARG_DOUBLE:
949                 {   double aDouble = 0.0;
950                     char *end;
951
952                     if (con->os->nextArg) {
953                         /*@-mods@*/
954                         int saveerrno = errno;
955                         errno = 0;
956                         aDouble = strtod(con->os->nextArg, &end);
957                         if (errno == ERANGE)
958                             return POPT_ERROR_OVERFLOW;
959                         errno = saveerrno;
960                         /*@=mods@*/
961                         if (*end != '\0')
962                             return POPT_ERROR_BADNUMBER;
963                     }
964
965                     if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_DOUBLE) {
966                         *((double *) opt->arg) = aDouble;
967                     } else {
968 #define MY_ABS(a) ((((a) - 0.0) < DBL_EPSILON) ? -(a) : (a))
969                         if ((MY_ABS(aDouble) - FLT_MAX) > DBL_EPSILON)
970                             return POPT_ERROR_OVERFLOW;
971                         if ((FLT_MIN - MY_ABS(aDouble)) > DBL_EPSILON)
972                             return POPT_ERROR_OVERFLOW;
973                         *((float *) opt->arg) = aDouble;
974                     }
975                 }   /*@switchbreak@*/ break;
976                 default:
977                     fprintf(stdout,
978                         POPT_("option type (%d) not implemented in popt\n"),
979                         (opt->argInfo & POPT_ARG_MASK));
980                     exit(EXIT_FAILURE);
981                     /*@notreached@*/ /*@switchbreak@*/ break;
982                 }
983             }
984         }
985
986         if (cb) {
987             /*@-internalglobs@*/
988             invokeCallbacksOPTION(con, con->options, opt, cbData, shorty);
989             /*@=internalglobs@*/
990         } else if (opt->val && ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_VAL))
991             done = 1;
992
993         if ((con->finalArgvCount + 2) >= (con->finalArgvAlloced)) {
994             con->finalArgvAlloced += 10;
995             con->finalArgv = realloc(con->finalArgv,
996                             sizeof(*con->finalArgv) * con->finalArgvAlloced);
997         }
998
999         if (con->finalArgv != NULL)
1000         {   ssize_t bufsize = (opt->longName ? strlen(opt->longName) : 0) + 3;
1001             char *s = malloc(bufsize);
1002             if (s != NULL) {    /* XXX can't happen */
1003                 if (opt->longName)
1004                     snprintf(s, bufsize, "%s%s",
1005                         ((opt->argInfo & POPT_ARGFLAG_ONEDASH) ? "-" : "--"),
1006                         opt->longName);
1007                 else
1008                     snprintf(s, bufsize, "-%c", opt->shortName);
1009                 con->finalArgv[con->finalArgvCount++] = s;
1010             } else
1011                 con->finalArgv[con->finalArgvCount++] = NULL;
1012         }
1013
1014         if (opt->arg && (opt->argInfo & POPT_ARG_MASK) == POPT_ARG_NONE)
1015             /*@-ifempty@*/ ; /*@=ifempty@*/
1016         else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_VAL)
1017             /*@-ifempty@*/ ; /*@=ifempty@*/
1018         else if ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE) {
1019             if (con->finalArgv != NULL && con->os->nextArg)
1020                 con->finalArgv[con->finalArgvCount++] =
1021                         /*@-nullpass@*/ /* LCL: con->os->nextArg != NULL */
1022                         xstrdup(con->os->nextArg);
1023                         /*@=nullpass@*/
1024         }
1025     }
1026
1027     return (opt ? opt->val : -1);       /* XXX can't happen */
1028 }
1029 /*@=boundswrite@*/
1030
1031 const char * poptGetOptArg(poptContext con)
1032 {
1033     const char * ret = NULL;
1034     /*@-branchstate@*/
1035     if (con) {
1036         ret = con->os->nextArg;
1037         con->os->nextArg = NULL;
1038     }
1039     /*@=branchstate@*/
1040     return ret;
1041 }
1042
1043 const char * poptGetArg(poptContext con)
1044 {
1045     const char * ret = NULL;
1046     if (con && con->leftovers != NULL && con->nextLeftover < con->numLeftovers)
1047         ret = con->leftovers[con->nextLeftover++];
1048     return ret;
1049 }
1050
1051 const char * poptPeekArg(poptContext con)
1052 {
1053     const char * ret = NULL;
1054     if (con && con->leftovers != NULL && con->nextLeftover < con->numLeftovers)
1055         ret = con->leftovers[con->nextLeftover];
1056     return ret;
1057 }
1058
1059 /*@-boundswrite@*/
1060 const char ** poptGetArgs(poptContext con)
1061 {
1062     if (con == NULL ||
1063         con->leftovers == NULL || con->numLeftovers == con->nextLeftover)
1064         return NULL;
1065
1066     /* some apps like [like RPM ;-) ] need this NULL terminated */
1067     con->leftovers[con->numLeftovers] = NULL;
1068
1069     /*@-nullret -nullstate @*/  /* FIX: typedef double indirection. */
1070     return (con->leftovers + con->nextLeftover);
1071     /*@=nullret =nullstate @*/
1072 }
1073 /*@=boundswrite@*/
1074
1075 poptContext poptFreeContext(poptContext con)
1076 {
1077     poptItem item;
1078     int i;
1079
1080     if (con == NULL) return con;
1081     poptResetContext(con);
1082     con->os->argb = _free(con->os->argb);
1083
1084     if (con->aliases != NULL)
1085     for (i = 0; i < con->numAliases; i++) {
1086         item = con->aliases + i;
1087         /*@-modobserver -observertrans -dependenttrans@*/
1088         item->option.longName = _free(item->option.longName);
1089         item->option.descrip = _free(item->option.descrip);
1090         item->option.argDescrip = _free(item->option.argDescrip);
1091         /*@=modobserver =observertrans =dependenttrans@*/
1092         item->argv = _free(item->argv);
1093     }
1094     con->aliases = _free(con->aliases);
1095
1096     if (con->execs != NULL)
1097     for (i = 0; i < con->numExecs; i++) {
1098         item = con->execs + i;
1099         /*@-modobserver -observertrans -dependenttrans@*/
1100         item->option.longName = _free(item->option.longName);
1101         item->option.descrip = _free(item->option.descrip);
1102         item->option.argDescrip = _free(item->option.argDescrip);
1103         /*@=modobserver =observertrans =dependenttrans@*/
1104         item->argv = _free(item->argv);
1105     }
1106     con->execs = _free(con->execs);
1107
1108     con->leftovers = _free(con->leftovers);
1109     con->finalArgv = _free(con->finalArgv);
1110     con->appName = _free(con->appName);
1111     con->otherHelp = _free(con->otherHelp);
1112     con->execPath = _free(con->execPath);
1113     con->arg_strip = PBM_FREE(con->arg_strip);
1114     
1115     con = _free(con);
1116     return con;
1117 }
1118
1119 int poptAddAlias(poptContext con, struct poptAlias alias,
1120                 /*@unused@*/ UNUSED(int flags))
1121 {
1122     poptItem item = (poptItem) alloca(sizeof(*item));
1123     memset(item, 0, sizeof(*item));
1124     item->option.longName = alias.longName;
1125     item->option.shortName = alias.shortName;
1126     item->option.argInfo = POPT_ARGFLAG_DOC_HIDDEN;
1127     item->option.arg = 0;
1128     item->option.val = 0;
1129     item->option.descrip = NULL;
1130     item->option.argDescrip = NULL;
1131     item->argc = alias.argc;
1132     item->argv = alias.argv;
1133     return poptAddItem(con, item, 0);
1134 }
1135
1136 /*@-boundswrite@*/
1137 /*@-mustmod@*/ /* LCL: con not modified? */
1138 int poptAddItem(poptContext con, poptItem newItem, int flags)
1139 {
1140     poptItem * items, item;
1141     int * nitems;
1142
1143     switch (flags) {
1144     case 1:
1145         items = &con->execs;
1146         nitems = &con->numExecs;
1147         break;
1148     case 0:
1149         items = &con->aliases;
1150         nitems = &con->numAliases;
1151         break;
1152     default:
1153         return 1;
1154         /*@notreached@*/ break;
1155     }
1156
1157     *items = realloc((*items), ((*nitems) + 1) * sizeof(**items));
1158     if ((*items) == NULL)
1159         return 1;
1160
1161     item = (*items) + (*nitems);
1162
1163     item->option.longName =
1164         (newItem->option.longName ? xstrdup(newItem->option.longName) : NULL);
1165     item->option.shortName = newItem->option.shortName;
1166     item->option.argInfo = newItem->option.argInfo;
1167     item->option.arg = newItem->option.arg;
1168     item->option.val = newItem->option.val;
1169     item->option.descrip =
1170         (newItem->option.descrip ? xstrdup(newItem->option.descrip) : NULL);
1171     item->option.argDescrip =
1172        (newItem->option.argDescrip ? xstrdup(newItem->option.argDescrip) : NULL);
1173     item->argc = newItem->argc;
1174     item->argv = newItem->argv;
1175
1176     (*nitems)++;
1177
1178     return 0;
1179 }
1180 /*@=mustmod@*/
1181 /*@=boundswrite@*/
1182
1183 const char * poptBadOption(poptContext con, int flags)
1184 {
1185     struct optionStackEntry * os = NULL;
1186
1187     if (con != NULL)
1188         os = (flags & POPT_BADOPTION_NOALIAS) ? con->optionStack : con->os;
1189
1190     /*@-nullderef@*/    /* LCL: os->argv != NULL */
1191     return (os && os->argv ? os->argv[os->next - 1] : NULL);
1192     /*@=nullderef@*/
1193 }
1194
1195 const char * poptStrerror(const int error)
1196 {
1197     switch (error) {
1198       case POPT_ERROR_NOARG:
1199         return POPT_("missing argument");
1200       case POPT_ERROR_BADOPT:
1201         return POPT_("unknown option");
1202       case POPT_ERROR_BADOPERATION:
1203         return POPT_("mutually exclusive logical operations requested");
1204       case POPT_ERROR_NULLARG:
1205         return POPT_("opt->arg should not be NULL");
1206       case POPT_ERROR_OPTSTOODEEP:
1207         return POPT_("aliases nested too deeply");
1208       case POPT_ERROR_BADQUOTE:
1209         return POPT_("error in parameter quoting");
1210       case POPT_ERROR_BADNUMBER:
1211         return POPT_("invalid numeric value");
1212       case POPT_ERROR_OVERFLOW:
1213         return POPT_("number too large or too small");
1214       case POPT_ERROR_MALLOC:
1215         return POPT_("memory allocation failed");
1216       case POPT_ERROR_ERRNO:
1217         return strerror(errno);
1218       default:
1219         return POPT_("unknown error");
1220     }
1221 }
1222
1223 int poptStuffArgs(poptContext con, const char ** argv)
1224 {
1225     int argc;
1226     int rc;
1227
1228     if ((con->os - con->optionStack) == POPT_OPTION_DEPTH)
1229         return POPT_ERROR_OPTSTOODEEP;
1230
1231     for (argc = 0; argv[argc]; argc++)
1232         {};
1233
1234     con->os++;
1235     con->os->next = 0;
1236     con->os->nextArg = NULL;
1237     con->os->nextCharArg = NULL;
1238     con->os->currAlias = NULL;
1239     rc = poptDupArgv(argc, argv, &con->os->argc, &con->os->argv);
1240     con->os->argb = NULL;
1241     con->os->stuffed = 1;
1242
1243     return rc;
1244 }
1245
1246 const char * poptGetInvocationName(poptContext con)
1247 {
1248     return (con->os->argv ? con->os->argv[0] : "");
1249 }
1250
1251 /*@-boundswrite@*/
1252 int poptStrippedArgv(poptContext con, int argc, char ** argv)
1253 {
1254     int numargs = argc;
1255     int j = 1;
1256     int i;
1257     
1258     /*@-sizeoftype@*/
1259     if (con->arg_strip)
1260     for (i = 1; i < argc; i++) {
1261         if (PBM_ISSET(i, con->arg_strip))
1262             numargs--;
1263     }
1264     
1265     for (i = 1; i < argc; i++) {
1266         if (con->arg_strip && PBM_ISSET(i, con->arg_strip))
1267             continue;
1268         argv[j] = (j < numargs) ? argv[i] : NULL;
1269         j++;
1270     }
1271     /*@=sizeoftype@*/
1272     
1273     return numargs;
1274 }
1275 /*@=boundswrite@*/