See ChangeLog: Wed Dec 23 13:34:22 CET 1998 Werner Koch
[gnupg.git] / util / argparse.c
1 /* [argparse.c wk 17.06.97] Argument Parser for option handling
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *  This file is part of GnuPG.
4  *
5  *  GnuPG is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  GnuPG is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, write to the Free Software
17  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
18  *
19  *
20  * Note: This is an independent version of the one in WkLib
21  */
22
23 #include <config.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <ctype.h>
27 #include <string.h>
28
29 #include "util.h"
30 #include "i18n.h"
31
32
33 /*********************************
34  * @Summary arg_parse
35  *  #include <wk/lib.h>
36  *
37  *  typedef struct {
38  *      char *argc;               pointer to argc (value subject to change)
39  *      char ***argv;             pointer to argv (value subject to change)
40  *      unsigned flags;           Global flags (DO NOT CHANGE)
41  *      int err;                  print error about last option
42  *                                1 = warning, 2 = abort
43  *      int r_opt;                return option
44  *      int r_type;               type of return value (0 = no argument found)
45  *      union {
46  *          int   ret_int;
47  *          long  ret_long
48  *          ulong ret_ulong;
49  *          char *ret_str;
50  *      } r;                      Return values
51  *      struct {
52  *          int index;
53  *          const char *last;
54  *          void *aliases;
55  *      } internal;               DO NOT CHANGE
56  *  } ARGPARSE_ARGS;
57  *
58  *  typedef struct {
59  *      int         short_opt;
60  *      const char *long_opt;
61  *      unsigned flags;
62  *  } ARGPARSE_OPTS;
63  *
64  *  int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts );
65  *
66  * @Description
67  *  This is my replacement for getopt(). See the example for a typical usage.
68  *  Global flags are:
69  *     Bit 0 : Do not remove options form argv
70  *     Bit 1 : Do not stop at last option but return other args
71  *             with r_opt set to -1.
72  *     Bit 2 : Assume options and real args are mixed.
73  *     Bit 3 : Do not use -- to stop option processing.
74  *     Bit 4 : Do not skip the first arg.
75  *     Bit 5 : allow usage of long option with only one dash
76  *     Bit 6 : ignore --version
77  *     all other bits must be set to zero, this value is modified by the
78  *     function, so assume this is write only.
79  *  Local flags (for each option):
80  *     Bit 2-0 : 0 = does not take an argument
81  *               1 = takes int argument
82  *               2 = takes string argument
83  *               3 = takes long argument
84  *               4 = takes ulong argument
85  *     Bit 3 : argument is optional (r_type will the be set to 0)
86  *     Bit 4 : allow 0x etc. prefixed values.
87  *     Bit 7 : this is a command and not an option
88  *  You stop the option processing by setting opts to NULL, the function will
89  *  then return 0.
90  * @Return Value
91  *   Returns the args.r_opt or 0 if ready
92  *   r_opt may be -2/-7 to indicate an unknown option/command.
93  * @See Also
94  *   ArgExpand
95  * @Notes
96  *  You do not need to process the options 'h', '--help' or '--version'
97  *  because this function includes standard help processing; but if you
98  *  specify '-h', '--help' or '--version' you have to do it yourself.
99  *  The option '--' stops argument processing; if bit 1 is set the function
100  *  continues to return normal arguments.
101  *  To process float args or unsigned args you must use a string args and do
102  *  the conversion yourself.
103  * @Example
104  *
105  *     ARGPARSE_OPTS opts[] = {
106  *     { 'v', "verbose",   0 },
107  *     { 'd', "debug",     0 },
108  *     { 'o', "output",    2 },
109  *     { 'c', "cross-ref", 2|8 },
110  *     { 'm', "my-option", 1|8 },
111  *     { 500, "have-no-short-option-for-this-long-option", 0 },
112  *     {0} };
113  *     ARGPARSE_ARGS pargs = { &argc, &argv, 0 }
114  *
115  *     while( ArgParse( &pargs, &opts) ) {
116  *         switch( pargs.r_opt ) {
117  *           case 'v': opt.verbose++; break;
118  *           case 'd': opt.debug++; break;
119  *           case 'o': opt.outfile = pargs.r.ret_str; break;
120  *           case 'c': opt.crf = pargs.r_type? pargs.r.ret_str:"a.crf"; break;
121  *           case 'm': opt.myopt = pargs.r_type? pargs.r.ret_int : 1; break;
122  *           case 500: opt.a_long_one++;  break
123  *           default : pargs.err = 1; break; -- force warning output --
124  *         }
125  *     }
126  *     if( argc > 1 )
127  *         log_fatal( "Too many args");
128  *
129  */
130
131 typedef struct alias_def_s *ALIAS_DEF;
132 struct alias_def_s {
133     ALIAS_DEF next;
134     char *name;   /* malloced buffer with name, \0, value */
135     const char *value; /* ptr into name */
136 };
137
138 static int  set_opt_arg(ARGPARSE_ARGS *arg, unsigned flags, char *s);
139 static void show_help(ARGPARSE_OPTS *opts, unsigned flags);
140 static void show_version(void);
141
142 static void
143 initialize( ARGPARSE_ARGS *arg, const char *filename, unsigned *lineno )
144 {
145     if( !(arg->flags & (1<<15)) ) { /* initialize this instance */
146         arg->internal.index = 0;
147         arg->internal.last = NULL;
148         arg->internal.inarg = 0;
149         arg->internal.stopped = 0;
150         arg->internal.aliases = NULL;
151         arg->internal.cur_alias = NULL;
152         arg->err = 0;
153         arg->flags |= 1<<15; /* mark initialized */
154         if( *arg->argc < 0 )
155             log_bug("Invalid argument for ArgParse\n");
156     }
157
158     if( arg->err ) { /* last option was erroneous */
159         const char *s;
160
161         if( filename ) {
162             if( arg->r_opt == -6 )
163                 s = "%s:%u: argument not expected\n";
164             else if( arg->r_opt == -5 )
165                 s = "%s:%u: read error\n";
166             else if( arg->r_opt == -4 )
167                 s = "%s:%u: keyword too long\n";
168             else if( arg->r_opt == -3 )
169                 s = "%s:%u: missing argument\n";
170             else if( arg->r_opt == -7 )
171                 s = "%s:%u: invalid command\n";
172             else if( arg->r_opt == -10 )
173                 s = "%s:%u: invalid alias definition\n";
174             else
175                 s = "%s:%u: invalid option\n";
176             log_error(s, filename, *lineno );
177         }
178         else {
179             if( arg->r_opt == -3 )
180                 s = "Missing argument for option \"%.50s\"\n";
181             else if( arg->r_opt == -6 )
182                 s = "Option \"%.50s\" does not expect an argument\n";
183             else if( arg->r_opt == -7 )
184                 s = "Invalid command \"%.50s\"\n";
185             else if( arg->r_opt == -8 )
186                 s = "Option \"%.50s\" is ambiguous\n";
187             else if( arg->r_opt == -9 )
188                 s = "Command \"%.50s\" is ambiguous\n";
189             else
190                 s = "Invalid option \"%.50s\"\n";
191             log_error(s, arg->internal.last? arg->internal.last:"[??]" );
192         }
193         if( arg->err != 1 )
194             exit(2);
195         arg->err = 0;
196     }
197 }
198
199
200
201 static void
202 store_alias( ARGPARSE_ARGS *arg, char *name, char *value )
203 {
204     ALIAS_DEF a = m_alloc( sizeof *a );
205     a->name = name;
206     a->value = value;
207     a->next = (ALIAS_DEF)arg->internal.aliases;
208     (ALIAS_DEF)arg->internal.aliases = a;
209 }
210
211 /****************
212  * Get options from a file.
213  * Lines starting with '#' are comment lines.
214  * Syntax is simply a keyword and the argument.
215  * Valid keywords are all keywords from the long_opt list without
216  * the leading dashes. The special keywords "help", "warranty" and "version"
217  * are not valid here.
218  * The special keyword "alias" may be used to store alias definitions,
219  * which are later expanded like long options.
220  * Caller must free returned strings.
221  * If called with FP set to NULL command line args are parse instead.
222  *
223  * Q: Should we allow the syntax
224  *     keyword = value
225  *    and accept for boolean options a value of 1/0, yes/no or true/false?
226  * Note: Abbreviation of options is here not allowed.
227  */
228 int
229 optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
230                ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts)
231 {
232     int state, i, c;
233     int index=0;
234     char keyword[100];
235     char *buffer = NULL;
236     size_t buflen = 0;
237     int inverse=0;
238     int in_alias=0;
239
240     if( !fp ) /* same as arg_parse() in this case */
241         return arg_parse( arg, opts );
242
243     initialize( arg, filename, lineno );
244
245     /* find the next keyword */
246     state = i = 0;
247     for(;;) {
248         c=getc(fp);
249         if( c == '\n' || c== EOF ) {
250             if( c != EOF )
251                 ++*lineno;
252             if( state == -1 )
253                 break;
254             else if( state == 2 ) {
255                 keyword[i] = 0;
256                 for(i=0; opts[i].short_opt; i++ )
257                     if( opts[i].long_opt && !strcmp( opts[i].long_opt, keyword) )
258                         break;
259                 index = i;
260                 arg->r_opt = opts[index].short_opt;
261                 if( inverse ) /* this does not have an effect, hmmm */
262                     arg->r_opt = -arg->r_opt;
263                 if( !opts[index].short_opt )   /* unknown command/option */
264                     arg->r_opt = (opts[index].flags & 256)? -7:-2;
265                 else if( (opts[index].flags & 8) ) /* no argument */
266                     arg->r_opt = -3;           /* error */
267                 else                           /* no or optional argument */
268                     arg->r_type = 0;           /* okay */
269                 break;
270             }
271             else if( state == 3 ) {            /* no argument found */
272                 if( in_alias )
273                     arg->r_opt = -3;           /* error */
274                 else if( !(opts[index].flags & 7) ) /* does not take an arg */
275                     arg->r_type = 0;           /* okay */
276                 else if( (opts[index].flags & 8) )  /* no optional argument */
277                     arg->r_type = 0;           /* okay */
278                 else                           /* no required argument */
279                     arg->r_opt = -3;           /* error */
280                 break;
281             }
282             else if( state == 4 ) {     /* have an argument */
283                 if( in_alias ) {
284                     if( !buffer )
285                         arg->r_opt = -6;
286                     else {
287                         char *p;
288
289                         buffer[i] = 0;
290                         p = strpbrk( buffer, " \t" );
291                         if( p ) {
292                             *p++ = 0;
293                             trim_spaces( p );
294                         }
295                         if( !p || !*p ) {
296                             m_free( buffer );
297                             arg->r_opt = -10;
298                         }
299                         else {
300                             store_alias( arg, buffer, p );
301                         }
302                     }
303                 }
304                 else if( !(opts[index].flags & 7) )  /* does not take an arg */
305                     arg->r_opt = -6;        /* error */
306                 else {
307                     if( !buffer ) {
308                         keyword[i] = 0;
309                         buffer = m_strdup(keyword);
310                     }
311                     else
312                         buffer[i] = 0;
313
314                     trim_spaces( buffer );
315                     if( !set_opt_arg(arg, opts[index].flags, buffer) )
316                         m_free(buffer);
317                 }
318                 break;
319             }
320             else if( c == EOF ) {
321                 if( ferror(fp) )
322                     arg->r_opt = -5;   /* read error */
323                 else
324                     arg->r_opt = 0;    /* eof */
325                 break;
326             }
327             state = 0;
328             i = 0;
329         }
330         else if( state == -1 )
331             ; /* skip */
332         else if( !state && isspace(c) )
333             ; /* skip leading white space */
334         else if( !state && c == '#' )
335             state = 1;  /* start of a comment */
336         else if( state == 1 )
337             ; /* skip comments */
338         else if( state == 2 && isspace(c) ) {
339             keyword[i] = 0;
340             for(i=0; opts[i].short_opt; i++ )
341                 if( opts[i].long_opt && !strcmp( opts[i].long_opt, keyword) )
342                     break;
343             index = i;
344             arg->r_opt = opts[index].short_opt;
345             if( !opts[index].short_opt ) {
346                 if( !strcmp( keyword, "alias" ) ) {
347                     in_alias = 1;
348                     state = 3;
349                 }
350                 else {
351                     arg->r_opt = (opts[index].flags & 256)? -7:-2;
352                     state = -1;        /* skip rest of line and leave */
353                 }
354             }
355             else
356                 state = 3;
357         }
358         else if( state == 3 ) { /* skip leading spaces of the argument */
359             if( !isspace(c) ) {
360                 i = 0;
361                 keyword[i++] = c;
362                 state = 4;
363             }
364         }
365         else if( state == 4 ) { /* collect the argument */
366             if( buffer ) {
367                 if( i < buflen-1 )
368                     buffer[i++] = c;
369                 else {
370                     buflen += 50;
371                     buffer = m_realloc(buffer, buflen);
372                     buffer[i++] = c;
373                 }
374             }
375             else if( i < DIM(keyword)-1 )
376                 keyword[i++] = c;
377             else {
378                 buflen = DIM(keyword)+50;
379                 buffer = m_alloc(buflen);
380                 memcpy(buffer, keyword, i);
381                 buffer[i++] = c;
382             }
383         }
384         else if( i >= DIM(keyword)-1 ) {
385             arg->r_opt = -4;   /* keyword to long */
386             state = -1;        /* skip rest of line and leave */
387         }
388         else {
389             keyword[i++] = c;
390             state = 2;
391         }
392     }
393
394     return arg->r_opt;
395 }
396
397
398
399 static int
400 find_long_option( ARGPARSE_ARGS *arg,
401                   ARGPARSE_OPTS *opts, const char *keyword )
402 {
403     int i;
404     size_t n;
405
406     /* Would be better if we can do a binary search, but it is not
407        possible to reorder our option table because we would mess
408        up our help strings - What we can do is: Build a nice option
409        lookup table wehn this function is first invoked */
410     if( !*keyword )
411         return -1;
412     for(i=0; opts[i].short_opt; i++ )
413         if( opts[i].long_opt && !strcmp( opts[i].long_opt, keyword) )
414             return i;
415   #if 0
416     {
417         ALIAS_DEF a;
418         /* see whether it is an alias */
419         for( a = args->internal.aliases; a; a = a->next ) {
420             if( !strcmp( a->name, keyword) ) {
421                 /* fixme: must parse the alias here */
422                 args->internal.cur_alias = a;
423                 return -3; /* alias available */
424             }
425         }
426     }
427   #endif
428     /* not found, see whether it is an abbreviation */
429     /* aliases may not be abbreviated */
430     n = strlen( keyword );
431     for(i=0; opts[i].short_opt; i++ ) {
432         if( opts[i].long_opt && !strncmp( opts[i].long_opt, keyword, n ) ) {
433             int j;
434             for(j=i+1; opts[j].short_opt; j++ ) {
435                 if( opts[j].long_opt
436                     && !strncmp( opts[j].long_opt, keyword, n ) )
437                     return -2;  /* abbreviation is ambiguous */
438             }
439             return i;
440         }
441     }
442     return -1;
443 }
444
445 int
446 arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts)
447 {
448     int index;
449     int argc;
450     char **argv;
451     char *s, *s2;
452     int i;
453
454     initialize( arg, NULL, NULL );
455     argc = *arg->argc;
456     argv = *arg->argv;
457     index = arg->internal.index;
458
459     if( !index && argc && !(arg->flags & (1<<4)) ) { /* skip the first entry */
460         argc--; argv++; index++;
461     }
462
463   next_one:
464     if( !argc ) { /* no more args */
465         arg->r_opt = 0;
466         goto leave; /* ready */
467     }
468
469     s = *argv;
470     arg->internal.last = s;
471
472     if( arg->internal.stopped && (arg->flags & (1<<1)) ) {
473         arg->r_opt = -1;  /* not an option but a argument */
474         arg->r_type = 2;
475         arg->r.ret_str = s;
476         argc--; argv++; index++; /* set to next one */
477     }
478     else if( arg->internal.stopped ) { /* ready */
479         arg->r_opt = 0;
480         goto leave;
481     }
482     else if( *s == '-' && s[1] == '-' ) { /* long option */
483         char *argpos;
484
485         arg->internal.inarg = 0;
486         if( !s[2] && !(arg->flags & (1<<3)) ) { /* stop option processing */
487             arg->internal.stopped = 1;
488             argc--; argv++; index++;
489             goto next_one;
490         }
491
492         argpos = strchr( s+2, '=' );
493         if( argpos )
494             *argpos = 0;
495         i = find_long_option( arg, opts, s+2 );
496         if( argpos )
497             *argpos = '=';
498
499         if( i < 0 && !strcmp( "help", s+2) )
500             show_help(opts, arg->flags);
501         else if( i < 0 && !strcmp( "version", s+2) ) {
502             if( !(arg->flags & (1<<6)) ) {
503                 show_version();
504                 exit(0);
505             }
506         }
507         else if( i < 0 && !strcmp( "warranty", s+2) ) {
508             puts( strusage(16) );
509             exit(0);
510         }
511         else if( i < 0 && !strcmp( "dump-options", s+2) ) {
512             for(i=0; opts[i].short_opt; i++ )
513                 if( opts[i].long_opt )
514                     printf( "--%s\n", opts[i].long_opt );
515             exit(0);
516         }
517
518         if( i == -2 ) /* ambiguous option */
519             arg->r_opt = -8;
520         else if( i == -1 ) {
521             arg->r_opt = -2;
522             arg->r.ret_str = s+2;
523         }
524         else
525             arg->r_opt = opts[i].short_opt;
526         if( i < 0 )
527             ;
528         else if( (opts[i].flags & 7) ) {
529             if( argpos ) {
530                 s2 = argpos+1;
531                 if( !*s2 )
532                     s2 = NULL;
533             }
534             else
535                 s2 = argv[1];
536             if( !s2 && (opts[i].flags & 8) ) { /* no argument but it is okay*/
537                 arg->r_type = 0;               /* because it is optional */
538             }
539             else if( !s2 ) {
540                 arg->r_opt = -3; /* missing argument */
541             }
542             else if( !argpos && *s2 == '-' && (opts[i].flags & 8) ) {
543                 /* the argument is optional and the next seems to be
544                  * an option. We do not check this possible option
545                  * but assume no argument */
546                 arg->r_type = 0;
547             }
548             else {
549                 set_opt_arg(arg, opts[i].flags, s2);
550                 if( !argpos ) {
551                     argc--; argv++; index++; /* skip one */
552                 }
553             }
554         }
555         else { /* does not take an argument */
556             if( argpos )
557                 arg->r_type = -6; /* argument not expected */
558             else
559                 arg->r_type = 0;
560         }
561         argc--; argv++; index++; /* set to next one */
562     }
563     else if( (*s == '-' && s[1]) || arg->internal.inarg ) { /* short option */
564         int dash_kludge = 0;
565         i = 0;
566         if( !arg->internal.inarg ) {
567             arg->internal.inarg++;
568             if( arg->flags & (1<<5) ) {
569                 for(i=0; opts[i].short_opt; i++ )
570                     if( opts[i].long_opt && !strcmp( opts[i].long_opt, s+1)) {
571                         dash_kludge=1;
572                         break;
573                     }
574             }
575         }
576         s += arg->internal.inarg;
577
578         if( !dash_kludge ) {
579             for(i=0; opts[i].short_opt; i++ )
580                 if( opts[i].short_opt == *s )
581                     break;
582         }
583
584         if( !opts[i].short_opt && ( *s == 'h' || *s == '?' ) )
585             show_help(opts, arg->flags);
586
587         arg->r_opt = opts[i].short_opt;
588         if( !opts[i].short_opt ) {
589             arg->r_opt = (opts[i].flags & 256)? -7:-2;
590             arg->internal.inarg++; /* point to the next arg */
591             arg->r.ret_str = s;
592         }
593         else if( (opts[i].flags & 7) ) {
594             if( s[1] && !dash_kludge ) {
595                 s2 = s+1;
596                 set_opt_arg(arg, opts[i].flags, s2);
597             }
598             else {
599                 s2 = argv[1];
600                 if( !s2 && (opts[i].flags & 8) ) { /* no argument but it is okay*/
601                     arg->r_type = 0;               /* because it is optional */
602                 }
603                 else if( !s2 ) {
604                     arg->r_opt = -3; /* missing argument */
605                 }
606                 else if( *s2 == '-' && s2[1] && (opts[i].flags & 8) ) {
607                     /* the argument is optional and the next seems to be
608                      * an option. We do not check this possible option
609                      * but assume no argument */
610                     arg->r_type = 0;
611                 }
612                 else {
613                     set_opt_arg(arg, opts[i].flags, s2);
614                     argc--; argv++; index++; /* skip one */
615                 }
616             }
617             s = "x"; /* so that !s[1] yields false */
618         }
619         else { /* does not take an argument */
620             arg->r_type = 0;
621             arg->internal.inarg++; /* point to the next arg */
622         }
623         if( !s[1] || dash_kludge ) { /* no more concatenated short options */
624             arg->internal.inarg = 0;
625             argc--; argv++; index++;
626         }
627     }
628     else if( arg->flags & (1<<2) ) {
629         arg->r_opt = -1;  /* not an option but a argument */
630         arg->r_type = 2;
631         arg->r.ret_str = s;
632         argc--; argv++; index++; /* set to next one */
633     }
634     else {
635         arg->internal.stopped = 1; /* stop option processing */
636         goto next_one;
637     }
638
639   leave:
640     *arg->argc = argc;
641     *arg->argv = argv;
642     arg->internal.index = index;
643     return arg->r_opt;
644 }
645
646
647
648 static int
649 set_opt_arg(ARGPARSE_ARGS *arg, unsigned flags, char *s)
650 {
651     int base = (flags & 16)? 0 : 10;
652
653     switch( arg->r_type = (flags & 7) ) {
654       case 1: /* takes int argument */
655         arg->r.ret_int = (int)strtol(s,NULL,base);
656         return 0;
657       case 3: /* takes long argument   */
658         arg->r.ret_long= strtol(s,NULL,base);
659         return 0;
660       case 4: /* takes ulong argument  */
661         arg->r.ret_ulong= strtoul(s,NULL,base);
662         return 0;
663       case 2: /* takes string argument */
664       default:
665         arg->r.ret_str = s;
666         return 1;
667     }
668 }
669
670
671 static size_t
672 long_opt_strlen( ARGPARSE_OPTS *o )
673 {
674     size_t n = strlen(o->long_opt);
675
676     if( o->description && *o->description == '|' ) {
677         const char *s;
678
679         s=o->description+1;
680         if( *s != '=' )
681             n++;
682         for(; *s && *s != '|'; s++ )
683             n++;
684     }
685     return n;
686 }
687
688 /****************
689  * Print formatted help. The description string has some special
690  * meanings:
691  *  - A description string which is "@" suppresses help output for
692  *    this option
693  *  - a description,ine which starts with a '@' and is followed by
694  *    any other characters is printed as is; this may be used for examples
695  *    ans such.
696  *  - A description which starts with a '|' outputs the string between this
697  *    bar and the next one as arguments of the long option.
698  */
699 static void
700 show_help( ARGPARSE_OPTS *opts, unsigned flags )
701 {
702     const char *s;
703
704     show_version();
705     putchar('\n');
706     s = strusage(41);
707     puts(s);
708     if( opts[0].description ) { /* auto format the option description */
709         int i,j, indent;
710         /* get max. length of long options */
711         for(i=indent=0; opts[i].short_opt; i++ ) {
712             if( opts[i].long_opt )
713                 if( !opts[i].description || *opts[i].description != '@' )
714                     if( (j=long_opt_strlen(opts+i)) > indent && j < 35 )
715                          indent = j;
716         }
717         /* example: " -v, --verbose   Viele Sachen ausgeben" */
718         indent += 10;
719         if( *opts[0].description != '@' )
720             puts("Options:");
721         for(i=0; opts[i].short_opt; i++ ) {
722             s = _( opts[i].description );
723             if( s && *s== '@' && !s[1] ) /* hide this line */
724                 continue;
725             if( s && *s == '@' ) { /* unindented comment only line */
726                 for(s++; *s; s++ ) {
727                     if( *s == '\n' ) {
728                         if( s[1] )
729                             putchar('\n');
730                     }
731                     else
732                         putchar(*s);
733                 }
734                 putchar('\n');
735                 continue;
736             }
737
738             j = 3;
739             if( opts[i].short_opt < 256 ) {
740                 printf(" -%c", opts[i].short_opt );
741                 if( !opts[i].long_opt ) {
742                     if(s && *s == '|' ) {
743                         putchar(' '); j++;
744                         for(s++ ; *s && *s != '|'; s++, j++ )
745                             putchar(*s);
746                         if( *s )
747                             s++;
748                     }
749                 }
750             }
751             else
752                 fputs("   ", stdout);
753             if( opts[i].long_opt ) {
754                 j += printf("%c --%s", opts[i].short_opt < 256?',':' ',
755                                        opts[i].long_opt );
756                 if(s && *s == '|' ) {
757                     if( *++s != '=' ) {
758                         putchar(' ');
759                         j++;
760                     }
761                     for( ; *s && *s != '|'; s++, j++ )
762                         putchar(*s);
763                     if( *s )
764                         s++;
765                 }
766                 fputs("   ", stdout);
767                 j += 3;
768             }
769             for(;j < indent; j++ )
770                 putchar(' ');
771             if( s ) {
772                 if( *s && j > indent ) {
773                     putchar('\n');
774                     for(j=0;j < indent; j++ )
775                         putchar(' ');
776                 }
777                 for(; *s; s++ ) {
778                     if( *s == '\n' ) {
779                         if( s[1] ) {
780                             putchar('\n');
781                             for(j=0;j < indent; j++ )
782                                 putchar(' ');
783                         }
784                     }
785                     else
786                         putchar(*s);
787                 }
788             }
789             putchar('\n');
790         }
791         if( flags & 32 )
792             puts("\n(A single dash may be used instead of the double ones)");
793     }
794     if( (s=strusage(19)) ) {  /* bug reports to ... */
795         putchar('\n');
796         fputs(s, stdout);
797     }
798     fflush(stdout);
799     exit(0);
800 }
801
802 static void
803 show_version()
804 {
805     const char *s;
806     int i;
807     /* version line */
808     fputs(strusage(11), stdout);
809     if( (s=strusage(12)) )
810         printf(" (%s)", s );
811     printf(" %s\n", strusage(13) );
812     /* additional version lines */
813     for(i=20; i < 30; i++ )
814         if( (s=strusage(i)) )
815             printf("%s\n", s );
816     /* copyright string */
817     if( (s=strusage(14)) )
818         printf("%s\n", s );
819     /* copying conditions */
820     if( (s=strusage(15)) )
821         fputs(s, stdout);
822     /* thanks */
823     if( (s=strusage(18)) )
824         fputs(s, stdout);
825     /* additional program info */
826     for(i=30; i < 40; i++ )
827         if( (s=strusage(i)) )
828             fputs(s, stdout);
829     fflush(stdout);
830 }
831
832
833 void
834 usage( int level )
835 {
836     if( !level ) {
837         fprintf(stderr,"%s %s; %s\n", strusage(11), strusage(13),
838                                                      strusage(14) );
839         fflush(stderr);
840     }
841     else if( level == 1 ) {
842         fputs(strusage(40),stderr);
843         exit(2);
844     }
845     else if( level == 2 ) {
846         puts(strusage(41));
847         exit(0);
848     }
849 }
850
851 /* Level
852  *     0: Copyright String auf stderr ausgeben
853  *     1: Kurzusage auf stderr ausgeben und beenden
854  *     2: Langusage auf stdout ausgeben und beenden
855  *    11: name of program
856  *    12: optional name of package which includes this program.
857  *    13: version  string
858  *    14: copyright string
859  *    15: Short copying conditions (with LFs)
860  *    16: Long copying conditions (with LFs)
861  *    17: Optional printable OS name
862  *    18: Optional thanks list   (with LFs)
863  *    19: Bug report info
864  *20..29: Additional lib version strings.
865  *30..39: Additional program info (with LFs)
866  *    40: short usage note (with LF)
867  *    41: long usage note (with LF)
868  */
869 const char *
870 default_strusage( int level )
871 {
872     const char *p = NULL;
873     switch( level ) {
874       case 11: p = "foo"; break;
875       case 13: p = "0.0"; break;
876       case 14: p = "Copyright (C) 1998 Free Software Foundation, Inc."; break;
877       case 15: p =
878 "This program comes with ABSOLUTELY NO WARRANTY.\n"
879 "This is free software, and you are welcome to redistribute it\n"
880 "under certain conditions. See the file COPYING for details.\n"; break;
881       case 16:  p =
882 "This is free software; you can redistribute it and/or modify\n"
883 "it under the terms of the GNU General Public License as published by\n"
884 "the Free Software Foundation; either version 2 of the License, or\n"
885 "(at your option) any later version.\n\n"
886 "It is distributed in the hope that it will be useful,\n"
887 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
888 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"
889 "GNU General Public License for more details.\n\n"
890 "You should have received a copy of the GNU General Public License\n"
891 "along with this program; if not, write to the Free Software\n"
892 "Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\n";
893         break;
894       case 40: /* short and long usage */
895       case 41: p = ""; break;
896     }
897
898     return p;
899 }
900
901
902
903 #ifdef TEST
904 static struct {
905     int verbose;
906     int debug;
907     char *outfile;
908     char *crf;
909     int myopt;
910     int echo;
911     int a_long_one;
912 }opt;
913
914 int
915 main(int argc, char **argv)
916 {
917     ARGPARSE_OPTS opts[] = {
918     { 'v', "verbose",   0 , "Laut sein"},
919     { 'e', "echo"   ,   0 , "Zeile ausgeben, damit wir sehen, was wir einegegeben haben"},
920     { 'd', "debug",     0 , "Debug\nfalls mal etasws\nSchief geht"},
921     { 'o', "output",    2   },
922     { 'c', "cross-ref", 2|8, "cross-reference erzeugen\n" },
923     { 'm', "my-option", 1|8 },
924     { 500, "a-long-option", 0 },
925     {0} };
926     ARGPARSE_ARGS pargs = { &argc, &argv, 2|4|32 };
927     int i;
928
929     while( ArgParse( &pargs, opts) ) {
930         switch( pargs.r_opt ) {
931           case -1 : printf( "arg='%s'\n", pargs.r.ret_str); break;
932           case 'v': opt.verbose++; break;
933           case 'e': opt.echo++; break;
934           case 'd': opt.debug++; break;
935           case 'o': opt.outfile = pargs.r.ret_str; break;
936           case 'c': opt.crf = pargs.r_type? pargs.r.ret_str:"a.crf"; break;
937           case 'm': opt.myopt = pargs.r_type? pargs.r.ret_int : 1; break;
938           case 500: opt.a_long_one++;  break;
939           default : pargs.err = 1; break; /* force warning output */
940         }
941     }
942     for(i=0; i < argc; i++ )
943         printf("%3d -> (%s)\n", i, argv[i] );
944     puts("Options:");
945     if( opt.verbose )
946         printf("  verbose=%d\n", opt.verbose );
947     if( opt.debug )
948         printf("  debug=%d\n", opt.debug );
949     if( opt.outfile )
950         printf("  outfile='%s'\n", opt.outfile );
951     if( opt.crf )
952         printf("  crffile='%s'\n", opt.crf );
953     if( opt.myopt )
954         printf("  myopt=%d\n", opt.myopt );
955     if( opt.a_long_one )
956         printf("  a-long-one=%d\n", opt.a_long_one );
957     if( opt.echo       )
958         printf("  echo=%d\n", opt.echo );
959     return 0;
960 }
961 #endif
962
963 /**** bottom of file ****/