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