lib/roken/getarg.h

   1 /*
   2  * Copyright (c) 1997 - 2002 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef __GETARG_H__
  37 #define __GETARG_H__
  38
  39 #include <stddef.h>
  40
  41 #ifndef ROKEN_LIB_FUNCTION
  42 #ifdef _WIN32
  43 #define ROKEN_LIB_FUNCTION _stdcall
  44 #else
  45 #define ROKEN_LIB_FUNCTION
  46 #endif
  47 #endif
  48
  49 struct getargs{
  50     const char *long_name;
  51     char short_name;
  52     enum { arg_integer,
  53            arg_string,
  54            arg_flag,
  55            arg_negative_flag,
  56            arg_strings,
  57            arg_double,
  58            arg_collect,
  59            arg_counter
  60     } type;
  61     void *value;
  62     const char *help;
  63     const char *arg_help;
  64 };
  65
  66 enum {
  67     ARG_ERR_NO_MATCH  = 1,
  68     ARG_ERR_BAD_ARG,
  69     ARG_ERR_NO_ARG
  70 };
  71
  72 typedef struct getarg_strings {
  73     int num_strings;
  74     char **strings;
  75 } getarg_strings;
  76
  77 typedef int (*getarg_collect_func)(int short_opt,
  78                                    int argc,
  79                                    char **argv,
  80                                    int *goptind,
  81                                    int *goptarg,
  82                                    void *data);
  83
  84 typedef struct getarg_collect_info {
  85     getarg_collect_func func;
  86     void *data;
  87 } getarg_collect_info;
  88
  89 int ROKEN_LIB_FUNCTION
  90 getarg(struct getargs *args, size_t num_args,
  91        int argc, char **argv, int *goptind);
  92
  93 void ROKEN_LIB_FUNCTION
  94 arg_printusage (struct getargs *args,
  95                 size_t num_args,
  96                 const char *progname,
  97                 const char *extra_string);
  98
  99 void ROKEN_LIB_FUNCTION
 100 arg_printusage_i18n (struct getargs *args,
 101                      size_t num_args,
 102                      const char *usage,
 103                      const char *progname,
 104                      const char *extra_string,
 105                      char *(i18n)(const char *));
 106
 107 void ROKEN_LIB_FUNCTION
 108 free_getarg_strings (getarg_strings *);
 109
 110 #endif /* __GETARG_H__ */