hak/lib/hak-opt.h

/*
    Copyright (c) 2016-2018 Chung, Hyung-Hwan. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _HAK_OPT_H_
#define _HAK_OPT_H_

#include <hak-cmn.h>

/** \file
 * This file defines functions and data structures to process
 * command-line arguments.
 */

typedef struct hak_uopt_t hak_uopt_t;
typedef struct hak_uopt_lng_t hak_uopt_lng_t;

struct hak_uopt_lng_t
{
	const hak_uch_t* str;
	hak_uci_t        val;
};

struct hak_uopt_t
{
	/* input */
	const hak_uch_t* str; /* option string  */
	hak_uopt_lng_t*  lng; /* long options */

	/* output */
	hak_uci_t        opt; /* character checked for validity */
	hak_uch_t*       arg; /* argument associated with an option */

	/* output */
	const hak_uch_t* lngopt;

	/* input + output */
	int              ind; /* index into parent argv vector */

	/* input + output - internal*/
	hak_uch_t*       cur;
};

typedef struct hak_bopt_t hak_bopt_t;
typedef struct hak_bopt_lng_t hak_bopt_lng_t;

struct hak_bopt_lng_t
{
	const hak_bch_t* str;
	hak_bci_t        val;
};

struct hak_bopt_t
{
	/* input */
	const hak_bch_t* str; /* option string  */
	hak_bopt_lng_t*  lng; /* long options */

	/* output */
	hak_bci_t        opt; /* character checked for validity */
	hak_bch_t*       arg; /* argument associated with an option */

	/* output */
	const hak_bch_t* lngopt;

	/* input + output */
	int              ind; /* index into parent argv vector */

	/* input + output - internal*/
	hak_bch_t*       cur;
};

#if defined(__cplusplus)
extern "C" {
#endif

/**
 * The hak_getopt() function processes the \a argc command-line arguments
 * pointed to by \a argv as configured in \a opt. It can process two
 * different option styles: a single character starting with '-', and a
 * long name starting with '--'.
 *
 * A character in \a opt.str is treated as a single character option. Should
 * it require a parameter, specify ':' after it.
 *
 * Two special returning option characters indicate special error conditions.
 * - \b ? indicates a bad option stored in the \a opt->opt field.
 * - \b : indicates a bad parameter for an option stored in the \a opt->opt field.
 *
 * \return an option character on success, HAK_CHAR_EOF on no more options.
 */
HAK_EXPORT hak_uci_t hak_getuopt (
	int                argc, /* argument count */
	hak_uch_t* const*  argv, /* argument array */
	hak_uopt_t*        opt   /* option configuration */
);

HAK_EXPORT hak_bci_t hak_getbopt (
	int                argc, /* argument count */
	hak_bch_t* const*  argv, /* argument array */
	hak_bopt_t*        opt   /* option configuration */
);


#if defined(HAK_OOCH_IS_UCH)
#	define hak_opt_t hak_uopt_t
#	define hak_opt_lng_t hak_uopt_lng_t
#	define hak_getopt(argc,argv,opt) hak_getuopt(argc,argv,opt)
#else
#	define hak_opt_t hak_bopt_t
#	define hak_opt_lng_t hak_bopt_lng_t
#	define hak_getopt(argc,argv,opt) hak_getbopt(argc,argv,opt)
#endif

#if defined(__cplusplus)
}
#endif

#endif