getarg.h revision 102644
155682Smarkm/*
2102644Snectar * Copyright (c) 1997 - 2002 Kungliga Tekniska H�gskolan
355682Smarkm * (Royal Institute of Technology, Stockholm, Sweden).
455682Smarkm * All rights reserved.
555682Smarkm *
655682Smarkm * Redistribution and use in source and binary forms, with or without
755682Smarkm * modification, are permitted provided that the following conditions
855682Smarkm * are met:
955682Smarkm *
1055682Smarkm * 1. Redistributions of source code must retain the above copyright
1155682Smarkm *    notice, this list of conditions and the following disclaimer.
1255682Smarkm *
1355682Smarkm * 2. Redistributions in binary form must reproduce the above copyright
1455682Smarkm *    notice, this list of conditions and the following disclaimer in the
1555682Smarkm *    documentation and/or other materials provided with the distribution.
1655682Smarkm *
1755682Smarkm * 3. Neither the name of the Institute nor the names of its contributors
1855682Smarkm *    may be used to endorse or promote products derived from this software
1955682Smarkm *    without specific prior written permission.
2055682Smarkm *
2155682Smarkm * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
2255682Smarkm * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2355682Smarkm * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2455682Smarkm * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
2555682Smarkm * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2655682Smarkm * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2755682Smarkm * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2855682Smarkm * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2955682Smarkm * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3055682Smarkm * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3155682Smarkm * SUCH DAMAGE.
3255682Smarkm */
3355682Smarkm
34102644Snectar/* $Id: getarg.h,v 1.12 2002/04/18 08:50:08 joda Exp $ */
3555682Smarkm
3655682Smarkm#ifndef __GETARG_H__
3755682Smarkm#define __GETARG_H__
3855682Smarkm
3955682Smarkm#include <stddef.h>
4055682Smarkm
4155682Smarkmstruct getargs{
4255682Smarkm    const char *long_name;
4355682Smarkm    char short_name;
4455682Smarkm    enum { arg_integer,
4555682Smarkm	   arg_string,
4655682Smarkm	   arg_flag,
4755682Smarkm	   arg_negative_flag,
4855682Smarkm	   arg_strings,
4955682Smarkm	   arg_double,
5055682Smarkm	   arg_collect,
5155682Smarkm	   arg_counter
5255682Smarkm    } type;
5355682Smarkm    void *value;
5455682Smarkm    const char *help;
5555682Smarkm    const char *arg_help;
5655682Smarkm};
5755682Smarkm
5855682Smarkmenum {
5955682Smarkm    ARG_ERR_NO_MATCH  = 1,
6055682Smarkm    ARG_ERR_BAD_ARG,
6155682Smarkm    ARG_ERR_NO_ARG
6255682Smarkm};
6355682Smarkm
6455682Smarkmtypedef struct getarg_strings {
6555682Smarkm    int num_strings;
6655682Smarkm    char **strings;
6755682Smarkm} getarg_strings;
6855682Smarkm
6955682Smarkmtypedef int (*getarg_collect_func)(int short_opt,
7055682Smarkm				   int argc,
7155682Smarkm				   char **argv,
72102644Snectar				   int *goptind,
73102644Snectar				   int *goptarg,
7455682Smarkm				   void *data);
7555682Smarkm
7655682Smarkmtypedef struct getarg_collect_info {
7755682Smarkm    getarg_collect_func func;
7855682Smarkm    void *data;
7955682Smarkm} getarg_collect_info;
8055682Smarkm
8155682Smarkmint getarg(struct getargs *args, size_t num_args,
82102644Snectar	   int argc, char **argv, int *goptind);
8355682Smarkm
8455682Smarkmvoid arg_printusage (struct getargs *args,
8555682Smarkm		     size_t num_args,
8655682Smarkm		     const char *progname,
8755682Smarkm		     const char *extra_string);
8855682Smarkm
8978527Sassarvoid free_getarg_strings (getarg_strings *);
9078527Sassar
9155682Smarkm#endif /* __GETARG_H__ */
92