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
  44 #define ROKEN_LIB_CALL     __cdecl
  45 #else
  46 #define ROKEN_LIB_FUNCTION
  47 #define ROKEN_LIB_CALL
  48 #endif
  49 #endif
  50
  51 struct getargs{
  52     const char *long_name;
  53     char short_name;
  54     enum { arg_integer,
  55            arg_string,
  56            arg_flag,
  57            arg_negative_flag,
  58            arg_strings,
  59            arg_double,
  60            arg_collect,
  61            arg_counter
  62     } type;
  63     void *value;
  64     const char *help;
  65     const char *arg_help;
  66 };
  67
  68 enum {
  69     ARG_ERR_NO_MATCH  = 1,
  70     ARG_ERR_BAD_ARG,
  71     ARG_ERR_NO_ARG
  72 };
  73
  74 typedef struct getarg_strings {
  75     int num_strings;
  76     char **strings;
  77 } getarg_strings;
  78
  79 typedef int (*getarg_collect_func)(int short_opt,
  80                                    int argc,
  81                                    char **argv,
  82                                    int *goptind,
  83                                    int *goptarg,
  84                                    void *data);
  85
  86 typedef struct getarg_collect_info {
  87     getarg_collect_func func;
  88     void *data;
  89 } getarg_collect_info;
  90
  91 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
  92 getarg(struct getargs *args, size_t num_args,
  93        int argc, char **argv, int *goptind);
  94
  95 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
  96 arg_printusage (struct getargs *args,
  97                 size_t num_args,
  98                 const char *progname,
  99                 const char *extra_string);
 100
 101 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 102 arg_printusage_i18n (struct getargs *args,
 103                      size_t num_args,
 104                      const char *usage,
 105                      const char *progname,
 106                      const char *extra_string,
 107                      char *(*i18n)(const char *));
 108
 109 ROKEN_LIB_FUNCTION void ROKEN_LIB_CALL
 110 free_getarg_strings (getarg_strings *);
 111
 112 #endif /* __GETARG_H__ */