src/ocsptool-args.h.bak

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (ocsptool-args.h)
   4  *
   5  *  It has been AutoGen-ed
   6  *  From the definitions    ocsptool-args.def
   7  *  and the template file   options
   8  *
   9  * Generated from AutoOpts 41:1:16 templates.
  10  *
  11  *  AutoOpts is a copyrighted work.  This header file is not encumbered
  12  *  by AutoOpts licensing, but is provided under the licensing terms chosen
  13  *  by the ocsptool author or copyright holder.  AutoOpts is
  14  *  licensed under the terms of the LGPL.  The redistributable library
  15  *  (``libopts'') is licensed under the terms of either the LGPL or, at the
  16  *  users discretion, the BSD license.  See the AutoOpts and/or libopts sources
  17  *  for details.
  18  *
  19  * The ocsptool program is copyrighted and licensed
  20  * under the following terms:
  21  *
  22  *  Copyright (C) 2000-2016 Free Software Foundation, and others, all rights reserved.
  23  *  This is free software. It is licensed for use, modification and
  24  *  redistribution under the terms of the GNU General Public License,
  25  *  version 3 or later <http://gnu.org/licenses/gpl.html>
  26  *
  27  *  ocsptool is free software: you can redistribute it and/or modify it
  28  *  under the terms of the GNU General Public License as published by the
  29  *  Free Software Foundation, either version 3 of the License, or
  30  *  (at your option) any later version.
  31  *
  32  *  ocsptool is distributed in the hope that it will be useful, but
  33  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  34  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  35  *  See the GNU General Public License for more details.
  36  *
  37  *  You should have received a copy of the GNU General Public License along
  38  *  with this program.  If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 /**
  41  *  This file contains the programmatic interface to the Automated
  42  *  Options generated for the ocsptool program.
  43  *  These macros are documented in the AutoGen info file in the
  44  *  "AutoOpts" chapter.  Please refer to that doc for usage help.
  45  */
  46 #ifndef AUTOOPTS_OCSPTOOL_ARGS_H_GUARD
  47 #define AUTOOPTS_OCSPTOOL_ARGS_H_GUARD 1
  48 #include "config.h"
  49 #include <autoopts/options.h>
  50
  51 /**
  52  *  Ensure that the library used for compiling this generated header is at
  53  *  least as new as the version current when the header template was released
  54  *  (not counting patch version increments).  Also ensure that the oldest
  55  *  tolerable version is at least as old as what was current when the header
  56  *  template was released.
  57  */
  58 #define AO_TEMPLATE_VERSION 167937
  59 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  60  || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  61 # error option template version mismatches autoopts/options.h header
  62   Choke Me.
  63 #endif
  64
  65 /**
  66  *  Enumeration of each option type for ocsptool
  67  */
  68 typedef enum {
  69     INDEX_OPT_DEBUG             =  0,
  70     INDEX_OPT_VERBOSE           =  1,
  71     INDEX_OPT_INFILE            =  2,
  72     INDEX_OPT_OUTFILE           =  3,
  73     INDEX_OPT_ASK               =  4,
  74     INDEX_OPT_VERIFY_RESPONSE   =  5,
  75     INDEX_OPT_REQUEST_INFO      =  6,
  76     INDEX_OPT_RESPONSE_INFO     =  7,
  77     INDEX_OPT_GENERATE_REQUEST  =  8,
  78     INDEX_OPT_NONCE             =  9,
  79     INDEX_OPT_LOAD_ISSUER       = 10,
  80     INDEX_OPT_LOAD_CERT         = 11,
  81     INDEX_OPT_LOAD_TRUST        = 12,
  82     INDEX_OPT_LOAD_SIGNER       = 13,
  83     INDEX_OPT_INDER             = 14,
  84     INDEX_OPT_LOAD_REQUEST      = 15,
  85     INDEX_OPT_LOAD_RESPONSE     = 16,
  86     INDEX_OPT_IGNORE_ERRORS     = 17,
  87     INDEX_OPT_VERSION           = 18,
  88     INDEX_OPT_HELP              = 19,
  89     INDEX_OPT_MORE_HELP         = 20
  90 } teOptIndex;
  91 /** count of all options for ocsptool */
  92 #define OPTION_CT    21
  93 /** ocsptool version */
  94 #define OCSPTOOL_VERSION       "3.4.11"
  95 /** Full ocsptool version text */
  96 #define OCSPTOOL_FULL_VERSION  "ocsptool 3.4.11"
  97
  98 /**
  99  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 100  *  option name (as in the teOptIndex enumeration above).
 101  *  e.g. HAVE_OPT(DEBUG)
 102  */
 103 #define         DESC(n) (ocsptoolOptions.pOptDesc[INDEX_OPT_## n])
 104 /** 'true' if an option has been specified in any way */
 105 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 106 /** The string argument to an option. The argument type must be \"string\". */
 107 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 108 /** Mask the option state revealing how an option was specified.
 109  *  It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
 110  * \a OPTST_DEFINED, \a OPTST_RESET or zero.
 111  */
 112 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 113 /** Count of option's occurrances *on the command line*. */
 114 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 115 /** mask of \a OPTST_SET and \a OPTST_DEFINED. */
 116 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 117 /** 'true' if \a HAVE_OPT would yield 'false'. */
 118 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 119 /** 'true' if OPTST_DISABLED bit not set. */
 120 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 121 /** number of stacked option arguments.
 122  *  Valid only for stacked option arguments. */
 123 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 124 /** stacked argument vector.
 125  *  Valid only for stacked option arguments. */
 126 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 127 /** Reset an option. */
 128 #define    CLEAR_OPT(n) STMTS( \
 129                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 130                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 131                     DESC(n).fOptState |= OPTST_DISABLED; \
 132                 DESC(n).optCookie = NULL )
 133 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 134 /**
 135  *  Enumeration of ocsptool exit codes
 136  */
 137 typedef enum {
 138     OCSPTOOL_EXIT_SUCCESS         = 0,
 139     OCSPTOOL_EXIT_FAILURE         = 1,
 140     OCSPTOOL_EXIT_USAGE_ERROR     = 64,
 141     OCSPTOOL_EXIT_LIBOPTS_FAILURE = 70
 142 }   ocsptool_exit_code_t;
 143 /**
 144  *  Interface defines for specific options.
 145  * @{
 146  */
 147 #define VALUE_OPT_DEBUG          'd'
 148
 149 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 150 #define VALUE_OPT_VERBOSE        'V'
 151 #define VALUE_OPT_INFILE         0x1001
 152 #define VALUE_OPT_OUTFILE        0x1002
 153 #define VALUE_OPT_ASK            0x1003
 154 #define VALUE_OPT_VERIFY_RESPONSE 'e'
 155 #define VALUE_OPT_REQUEST_INFO   'i'
 156 #define VALUE_OPT_RESPONSE_INFO  'j'
 157 #define VALUE_OPT_GENERATE_REQUEST 'q'
 158 #define VALUE_OPT_NONCE          0x1004
 159 #define VALUE_OPT_LOAD_ISSUER    0x1005
 160 #define VALUE_OPT_LOAD_CERT      0x1006
 161 #define VALUE_OPT_LOAD_TRUST     0x1007
 162 #define VALUE_OPT_LOAD_SIGNER    0x1008
 163 #define VALUE_OPT_INDER          0x1009
 164 #define VALUE_OPT_LOAD_REQUEST   'Q'
 165 #define VALUE_OPT_LOAD_RESPONSE  'S'
 166 #define VALUE_OPT_IGNORE_ERRORS  0x100A
 167 /** option flag (value) for help-value option */
 168 #define VALUE_OPT_HELP          'h'
 169 /** option flag (value) for more-help-value option */
 170 #define VALUE_OPT_MORE_HELP     '!'
 171 /** option flag (value) for version-value option */
 172 #define VALUE_OPT_VERSION       'v'
 173 /*
 174  *  Interface defines not associated with particular options
 175  */
 176 #define ERRSKIP_OPTERR  STMTS(ocsptoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 177 #define ERRSTOP_OPTERR  STMTS(ocsptoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 178 #define RESTART_OPT(n)  STMTS( \
 179                 ocsptoolOptions.curOptIdx = (n); \
 180                 ocsptoolOptions.pzCurOpt  = NULL )
 181 #define START_OPT       RESTART_OPT(1)
 182 #define USAGE(c)        (*ocsptoolOptions.pUsageProc)(&ocsptoolOptions, c)
 183
 184 #ifdef  __cplusplus
 185 extern "C" {
 186 #endif
 187 /*
 188  *  global exported definitions
 189  */
 190 #include <gettext.h>
 191
 192
 193 /* * * * * *
 194  *
 195  *  Declare the ocsptool option descriptor.
 196  */
 197 extern tOptions ocsptoolOptions;
 198
 199 #if defined(ENABLE_NLS)
 200 # ifndef _
 201 #   include <stdio.h>
 202 #   ifndef HAVE_GETTEXT
 203       extern char * gettext(char const *);
 204 #   else
 205 #     include <libintl.h>
 206 #   endif
 207
 208 # ifndef ATTRIBUTE_FORMAT_ARG
 209 #   define ATTRIBUTE_FORMAT_ARG(_a)
 210 # endif
 211
 212 static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
 213 static inline char* aoGetsText(char const* pz) {
 214     if (pz == NULL) return NULL;
 215     return (char*)gettext(pz);
 216 }
 217 #   define _(s)  aoGetsText(s)
 218 # endif /* _() */
 219
 220 # define OPT_NO_XLAT_CFG_NAMES  STMTS(ocsptoolOptions.fOptSet |= \
 221                                     OPTPROC_NXLAT_OPT_CFG;)
 222 # define OPT_NO_XLAT_OPT_NAMES  STMTS(ocsptoolOptions.fOptSet |= \
 223                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 224
 225 # define OPT_XLAT_CFG_NAMES     STMTS(ocsptoolOptions.fOptSet &= \
 226                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 227 # define OPT_XLAT_OPT_NAMES     STMTS(ocsptoolOptions.fOptSet &= \
 228                                   ~OPTPROC_NXLAT_OPT;)
 229
 230 #else   /* ENABLE_NLS */
 231 # define OPT_NO_XLAT_CFG_NAMES
 232 # define OPT_NO_XLAT_OPT_NAMES
 233
 234 # define OPT_XLAT_CFG_NAMES
 235 # define OPT_XLAT_OPT_NAMES
 236
 237 # ifndef _
 238 #   define _(_s)  _s
 239 # endif
 240 #endif  /* ENABLE_NLS */
 241
 242 #ifdef  __cplusplus
 243 }
 244 #endif
 245 #endif /* AUTOOPTS_OCSPTOOL_ARGS_H_GUARD */
 246
 247 /* ocsptool-args.h ends here */