/* -*- buffer-read-only: t -*- vi: set ro: * * DO NOT EDIT THIS FILE (srptool-args.h) * * It has been AutoGen-ed May 5, 2013 at 12:48:28 PM by AutoGen 5.17.3 * From the definitions srptool-args.def * and the template file options * * 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 * by the srptool author or copyright holder. AutoOpts is * licensed under the terms of the LGPL. The redistributable library * (``libopts'') is licensed under the terms of either the LGPL or, at the * users discretion, the BSD license. See the AutoOpts and/or libopts sources * for details. * * The srptool program is copyrighted and licensed * under the following terms: * * Copyright (C) 2000-2012 Free Software Foundation, 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 * * srptool 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. * * srptool 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 . */ /** * This file contains the programmatic interface to the Automated * Options generated for the srptool program. * These macros are documented in the AutoGen info file in the * "AutoOpts" chapter. Please refer to that doc for usage help. */ #ifndef AUTOOPTS_SRPTOOL_ARGS_H_GUARD #define AUTOOPTS_SRPTOOL_ARGS_H_GUARD 1 #include "config.h" #include /** * 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 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 type for srptool */ typedef enum { INDEX_OPT_DEBUG = 0, INDEX_OPT_INDEX = 1, INDEX_OPT_USERNAME = 2, INDEX_OPT_PASSWD = 3, INDEX_OPT_SALT = 4, INDEX_OPT_VERIFY = 5, INDEX_OPT_PASSWD_CONF = 6, INDEX_OPT_CREATE_CONF = 7, INDEX_OPT_VERSION = 8, INDEX_OPT_HELP = 9, INDEX_OPT_MORE_HELP = 10 } teOptIndex; /** count of all options for srptool */ #define OPTION_CT 11 /** srptool version */ #define SRPTOOL_VERSION "@VERSION@" /** Full srptool version text */ #define SRPTOOL_FULL_VERSION "srptool @VERSION@" /** * Interface defines for all options. Replace "n" with the UPPER_CASED * option name (as in the teOptIndex enumeration above). * e.g. HAVE_OPT(DEBUG) */ #define DESC(n) (srptoolOptions.pOptDesc[INDEX_OPT_## n]) /** 'true' if an option has been specified in any way */ #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n))) /** The string argument to an option. The argument type must be "string". */ #define OPT_ARG(n) (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_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK) /** Count of option's occurrances *on the command line*. */ #define COUNT_OPT(n) (DESC(n).optOccCt) /** mask of \a OPTST_SET and \a OPTST_DEFINED. */ #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n))) /** 'true' if \a HAVE_OPT would yield 'false'. */ #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n))) /** 'true' if OPTST_DISABLED bit not set. */ #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n))) /** number of stacked option arguments. * Valid only for stacked option arguments. */ #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt) /** stacked argument vector. * Valid only for stacked option arguments. */ #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs) /** Reset an option. */ #define CLEAR_OPT(n) STMTS( \ DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \ if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \ DESC(n).fOptState |= OPTST_DISABLED; \ DESC(n).optCookie = NULL ) /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** * Enumeration of srptool exit codes */ typedef enum { SRPTOOL_EXIT_SUCCESS = 0, SRPTOOL_EXIT_FAILURE = 1, SRPTOOL_EXIT_USAGE_ERROR = 64, SRPTOOL_EXIT_LIBOPTS_FAILURE = 70 } srptool_exit_code_t; /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** * Interface defines for specific options. * @{ */ #define VALUE_OPT_DEBUG 'd' #define OPT_VALUE_DEBUG (DESC(DEBUG).optArg.argInt) #define VALUE_OPT_INDEX 'i' #define VALUE_OPT_USERNAME 'u' #define VALUE_OPT_PASSWD 'p' #define VALUE_OPT_SALT 's' #define OPT_VALUE_SALT (DESC(SALT).optArg.argInt) #define VALUE_OPT_VERIFY 5 #define VALUE_OPT_PASSWD_CONF 'v' #define VALUE_OPT_CREATE_CONF 7 /** option flag (value) for " (get "val-name") " option */ #define VALUE_OPT_HELP 'h' /** option flag (value) for " (get "val-name") " option */ #define VALUE_OPT_MORE_HELP '!' /** option flag (value) for " (get "val-name") " option */ #define VALUE_OPT_VERSION 'v' /* * Interface defines not associated with particular options */ #define ERRSKIP_OPTERR STMTS(srptoolOptions.fOptSet &= ~OPTPROC_ERRSTOP) #define ERRSTOP_OPTERR STMTS(srptoolOptions.fOptSet |= OPTPROC_ERRSTOP) #define RESTART_OPT(n) STMTS( \ srptoolOptions.curOptIdx = (n); \ srptoolOptions.pzCurOpt = NULL) #define START_OPT RESTART_OPT(1) #define USAGE(c) (*srptoolOptions.pUsageProc)(&srptoolOptions, c) /* extracted from opthead.tlib near line 538 */ #ifdef __cplusplus extern "C" { #endif /* * global exported definitions */ #include /* * * * * * * * Declare the srptool option descriptor. */ extern tOptions srptoolOptions; #if defined(ENABLE_NLS) # ifndef _ # include # ifndef HAVE_GETTEXT extern char * gettext(char const *); # else # include # endif static inline char* aoGetsText(char const* pz) { if (pz == NULL) return NULL; return (char*)gettext(pz); } # define _(s) aoGetsText(s) # endif /* _() */ # define OPT_NO_XLAT_CFG_NAMES STMTS(srptoolOptions.fOptSet |= \ OPTPROC_NXLAT_OPT_CFG;) # define OPT_NO_XLAT_OPT_NAMES STMTS(srptoolOptions.fOptSet |= \ OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;) # define OPT_XLAT_CFG_NAMES STMTS(srptoolOptions.fOptSet &= \ ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);) # define OPT_XLAT_OPT_NAMES STMTS(srptoolOptions.fOptSet &= \ ~OPTPROC_NXLAT_OPT;) #else /* ENABLE_NLS */ # define OPT_NO_XLAT_CFG_NAMES # define OPT_NO_XLAT_OPT_NAMES # define OPT_XLAT_CFG_NAMES # define OPT_XLAT_OPT_NAMES # ifndef _ # define _(_s) _s # endif #endif /* ENABLE_NLS */ #ifdef __cplusplus } #endif #endif /* AUTOOPTS_SRPTOOL_ARGS_H_GUARD */ /* srptool-args.h ends here */