diff options
Diffstat (limited to 'src/libopts/genshell.h')
| -rw-r--r-- | src/libopts/genshell.h | 94 |
1 files changed, 61 insertions, 33 deletions
diff --git a/src/libopts/genshell.h b/src/libopts/genshell.h index d91c069e1e..37ecc3bc7b 100644 --- a/src/libopts/genshell.h +++ b/src/libopts/genshell.h @@ -1,12 +1,12 @@ /* -*- buffer-read-only: t -*- vi: set ro: - * + * * DO NOT EDIT THIS FILE (genshell.h) - * - * It has been AutoGen-ed May 6, 2012 at 04:20:59 PM by AutoGen 5.16pre36 + * + * It has been AutoGen-ed March 31, 2013 at 10:41:27 AM by AutoGen 5.17.3 * From the definitions genshell.def * and the template file options * - * Generated from AutoOpts 36:4:11 templates. + * Generated from AutoOpts 38:0:13 templates. * * AutoOpts is a copyrighted work. This header file is not encumbered * by AutoOpts licensing, but is provided under the licensing terms chosen @@ -19,26 +19,26 @@ * The genshellopt program is copyrighted and licensed * under the following terms: * - * Copyright (C) 1999-2012 Bruce Korb, all rights reserved. + * Copyright (C) 1999-2013 Bruce Korb, all rights reserved. * This is free software. It is licensed for use, modification and - * redistribution under the terms of the - * GNU General Public License, version 3 or later - * <http://gnu.org/licenses/gpl.html> + * redistribution under the terms of the GNU Lesser General Public License, + * version 2 or later <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html> * - * genshellopt is free software: you can redistribute it and/or modify it - * under the terms of the GNU General Public License as published by the - * Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * genshellopt is distributed in the hope that it will be useful, but + * The genshellopt library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - * See the GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License along - * with this program. If not, see <http://www.gnu.org/licenses/>. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with this library; if not, see + * <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html> */ -/* +/** * This file contains the programmatic interface to the Automated * Options generated for the genshellopt program. * These macros are documented in the AutoGen info file in the @@ -48,22 +48,22 @@ #define AUTOOPTS_GENSHELL_H_GUARD 1 #include <autoopts/options.h> -/* +/** * Ensure that the library used for compiling this generated header is at * least as new as the version current when the header template was released * (not counting patch version increments). Also ensure that the oldest * tolerable version is at least as old as what was current when the header * template was released. */ -#define AO_TEMPLATE_VERSION 147460 +#define AO_TEMPLATE_VERSION 155648 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \ || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION) # error option template version mismatches autoopts/options.h header Choke Me. #endif -/* - * Enumeration of each option: +/** + * Enumeration of each option type for genshellopt */ typedef enum { INDEX_GENSHELL_OPT_SCRIPT = 0, @@ -72,49 +72,71 @@ typedef enum { INDEX_GENSHELL_OPT_HELP = 3, INDEX_GENSHELL_OPT_MORE_HELP = 4 } teGenshell_OptIndex; - +/** count of all options for genshellopt */ #define GENSHELL_OPTION_CT 5 +/** genshellopt version */ #define GENSHELLOPT_VERSION "1" +/** Full genshellopt version text */ #define GENSHELLOPT_FULL_VERSION "genshellopt 1" -/* +/** * Interface defines for all options. Replace "n" with the UPPER_CASED * option name (as in the teGenshell_OptIndex enumeration above). * e.g. HAVE_GENSHELL_OPT(SCRIPT) */ #define GENSHELL_DESC(n) (genshelloptOptions.pOptDesc[INDEX_GENSHELL_OPT_## n]) +/** 'true' if an option has been specified in any way */ #define HAVE_GENSHELL_OPT(n) (! UNUSED_OPT(& GENSHELL_DESC(n))) +/** The string argument to an option. The argument type must be "string". */ #define GENSHELL_OPT_ARG(n) (GENSHELL_DESC(n).optArg.argString) +/** Mask the option state revealing how an option was specified. + * It will be one and only one of \a OPTST_SET, \a OPTST_PRESET, + * \a OPTST_DEFINED, \a OPTST_RESET or zero. + */ #define STATE_GENSHELL_OPT(n) (GENSHELL_DESC(n).fOptState & OPTST_SET_MASK) +/** Count of option's occurrances *on the command line*. */ #define COUNT_GENSHELL_OPT(n) (GENSHELL_DESC(n).optOccCt) +/** mask of \a OPTST_SET and \a OPTST_DEFINED. */ #define ISSEL_GENSHELL_OPT(n) (SELECTED_OPT(&GENSHELL_DESC(n))) +/** 'true' if \a HAVE_OPT would yield 'false'. */ #define ISUNUSED_GENSHELL_OPT(n) (UNUSED_OPT(& GENSHELL_DESC(n))) +/** 'true' if OPTST_DISABLED bit not set. */ #define ENABLED_GENSHELL_OPT(n) (! DISABLED_OPT(& GENSHELL_DESC(n))) +/** number of stacked option arguments. + * Valid only for stacked option arguments. */ #define STACKCT_GENSHELL_OPT(n) (((tArgList*)(GENSHELL_DESC(n).optCookie))->useCt) +/** stacked argument vector. + * Valid only for stacked option arguments. */ #define STACKLST_GENSHELL_OPT(n) (((tArgList*)(GENSHELL_DESC(n).optCookie))->apzArgs) +/** Reset an option. */ #define CLEAR_GENSHELL_OPT(n) STMTS( \ GENSHELL_DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \ if ((GENSHELL_DESC(n).fOptState & OPTST_INITENABLED) == 0) \ GENSHELL_DESC(n).fOptState |= OPTST_DISABLED; \ GENSHELL_DESC(n).optCookie = NULL ) -/* * * * * * - * +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/** * Enumeration of genshellopt exit codes */ typedef enum { - GENSHELLOPT_EXIT_SUCCESS = 0, - GENSHELLOPT_EXIT_FAILURE = 1, + GENSHELLOPT_EXIT_SUCCESS = 0, + GENSHELLOPT_EXIT_FAILURE = 1, + GENSHELLOPT_EXIT_USAGE_ERROR = 64, GENSHELLOPT_EXIT_LIBOPTS_FAILURE = 70 } genshellopt_exit_code_t; -/* * * * * * - * +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/** * Interface defines for specific options. + * @{ */ #define VALUE_GENSHELL_OPT_SCRIPT 'o' #define VALUE_GENSHELL_OPT_SHELL 's' +/** option flag (value) for " (get "val-name") " option */ #define VALUE_GENSHELL_OPT_HELP '?' +/** option flag (value) for " (get "val-name") " option */ #define VALUE_GENSHELL_OPT_MORE_HELP '!' +/** option flag (value) for " (get "val-name") " option */ #define VALUE_GENSHELL_OPT_VERSION 'v' /* * Interface defines not associated with particular options @@ -126,7 +148,7 @@ typedef enum { genshelloptOptions.pzCurOpt = NULL ) #define START_GENSHELL_OPT RESTART_GENSHELL_OPT(1) #define GENSHELL_USAGE(c) (*genshelloptOptions.pUsageProc)(&genshelloptOptions, c) -/* extracted from opthead.tlib near line 484 */ +/* extracted from opthead.tlib near line 538 */ #ifdef __cplusplus extern "C" { @@ -142,6 +164,12 @@ extern tOptions genshelloptOptions; #if defined(ENABLE_NLS) # ifndef _ # include <stdio.h> +# ifndef HAVE_GETTEXT + extern char * gettext(char const *); +# else +# include <libintl.h> +# endif + static inline char* aoGetsText(char const* pz) { if (pz == NULL) return NULL; return (char*)gettext(pz); |