src/cli-args.h

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (cli-args.h)
   4  *
   5  *  It has been AutoGen-ed  August 30, 2012 at 09:58:04 PM by AutoGen 5.16
   6  *  From the definitions    cli-args.def
   7  *  and the template file   options
   8  *
   9  * Generated from AutoOpts 36:4:11 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 gnutls-cli 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 gnutls-cli program is copyrighted and licensed
  20  * under the following terms:
  21  *
  22  *  Copyright (C) 2000-2012 Free Software Foundation, all rights reserved.
  23  *  This is free software. It is licensed for use, modification and
  24  *  redistribution under the terms of the
  25  *  GNU General Public License, version 3 or later
  26  *      <http://gnu.org/licenses/gpl.html>
  27  *
  28  *  gnutls-cli is free software: you can redistribute it and/or modify it
  29  *  under the terms of the GNU General Public License as published by the
  30  *  Free Software Foundation, either version 3 of the License, or
  31  *  (at your option) any later version.
  32  *
  33  *  gnutls-cli is distributed in the hope that it will be useful, but
  34  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  35  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  36  *  See the GNU General Public License for more details.
  37  *
  38  *  You should have received a copy of the GNU General Public License along
  39  *  with this program.  If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 /*
  42  *  This file contains the programmatic interface to the Automated
  43  *  Options generated for the gnutls-cli program.
  44  *  These macros are documented in the AutoGen info file in the
  45  *  "AutoOpts" chapter.  Please refer to that doc for usage help.
  46  */
  47 #ifndef AUTOOPTS_CLI_ARGS_H_GUARD
  48 #define AUTOOPTS_CLI_ARGS_H_GUARD 1
  49 #include "config.h"
  50 #include <autoopts/options.h>
  51
  52 /*
  53  *  Ensure that the library used for compiling this generated header is at
  54  *  least as new as the version current when the header template was released
  55  *  (not counting patch version increments).  Also ensure that the oldest
  56  *  tolerable version is at least as old as what was current when the header
  57  *  template was released.
  58  */
  59 #define AO_TEMPLATE_VERSION 147460
  60 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  61  || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  62 # error option template version mismatches autoopts/options.h header
  63   Choke Me.
  64 #endif
  65
  66 /*
  67  *  Enumeration of each option:
  68  */
  69 typedef enum {
  70     INDEX_OPT_DEBUG                   =  0,
  71     INDEX_OPT_VERBOSE                 =  1,
  72     INDEX_OPT_TOFU                    =  2,
  73     INDEX_OPT_OCSP                    =  3,
  74     INDEX_OPT_RESUME                  =  4,
  75     INDEX_OPT_HEARTBEAT               =  5,
  76     INDEX_OPT_REHANDSHAKE             =  6,
  77     INDEX_OPT_NOTICKET                =  7,
  78     INDEX_OPT_STARTTLS                =  8,
  79     INDEX_OPT_UDP                     =  9,
  80     INDEX_OPT_MTU                     = 10,
  81     INDEX_OPT_CRLF                    = 11,
  82     INDEX_OPT_X509FMTDER              = 12,
  83     INDEX_OPT_FINGERPRINT             = 13,
  84     INDEX_OPT_DISABLE_EXTENSIONS      = 14,
  85     INDEX_OPT_PRINT_CERT              = 15,
  86     INDEX_OPT_RECORDSIZE              = 16,
  87     INDEX_OPT_DH_BITS                 = 17,
  88     INDEX_OPT_PRIORITY                = 18,
  89     INDEX_OPT_X509CAFILE              = 19,
  90     INDEX_OPT_X509CRLFILE             = 20,
  91     INDEX_OPT_PGPKEYFILE              = 21,
  92     INDEX_OPT_PGPKEYRING              = 22,
  93     INDEX_OPT_PGPCERTFILE             = 23,
  94     INDEX_OPT_X509KEYFILE             = 24,
  95     INDEX_OPT_X509CERTFILE            = 25,
  96     INDEX_OPT_PGPSUBKEY               = 26,
  97     INDEX_OPT_SRPUSERNAME             = 27,
  98     INDEX_OPT_SRPPASSWD               = 28,
  99     INDEX_OPT_PSKUSERNAME             = 29,
 100     INDEX_OPT_PSKKEY                  = 30,
 101     INDEX_OPT_PORT                    = 31,
 102     INDEX_OPT_INSECURE                = 32,
 103     INDEX_OPT_BENCHMARK_CIPHERS       = 33,
 104     INDEX_OPT_BENCHMARK_SOFT_CIPHERS  = 34,
 105     INDEX_OPT_BENCHMARK_TLS_KX        = 35,
 106     INDEX_OPT_BENCHMARK_TLS_CIPHERS   = 36,
 107     INDEX_OPT_LIST                    = 37,
 108     INDEX_OPT_VERSION                 = 38,
 109     INDEX_OPT_HELP                    = 39,
 110     INDEX_OPT_MORE_HELP               = 40
 111 } teOptIndex;
 112
 113 #define OPTION_CT    41
 114 #define GNUTLS_CLI_VERSION       "@VERSION@"
 115 #define GNUTLS_CLI_FULL_VERSION  "gnutls-cli @VERSION@"
 116
 117 /*
 118  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 119  *  option name (as in the teOptIndex enumeration above).
 120  *  e.g. HAVE_OPT(DEBUG)
 121  */
 122 #define         DESC(n) (gnutls_cliOptions.pOptDesc[INDEX_OPT_## n])
 123 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 124 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 125 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 126 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 127 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 128 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 129 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 130 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 131 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 132 #define    CLEAR_OPT(n) STMTS( \
 133                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 134                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 135                     DESC(n).fOptState |= OPTST_DISABLED; \
 136                 DESC(n).optCookie = NULL )
 137
 138 /* * * * * *
 139  *
 140  *  Enumeration of gnutls-cli exit codes
 141  */
 142 typedef enum {
 143     GNUTLS_CLI_EXIT_SUCCESS = 0,
 144     GNUTLS_CLI_EXIT_FAILURE = 1,
 145     GNUTLS_CLI_EXIT_LIBOPTS_FAILURE = 70
 146 } gnutls_cli_exit_code_t;
 147 /* * * * * *
 148  *
 149  *  Interface defines for specific options.
 150  */
 151 #define VALUE_OPT_DEBUG          'd'
 152
 153 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 154 #define VALUE_OPT_VERBOSE        'V'
 155 #define VALUE_OPT_TOFU           2
 156 #define VALUE_OPT_OCSP           3
 157 #define VALUE_OPT_RESUME         'r'
 158 #define VALUE_OPT_HEARTBEAT      'b'
 159 #define VALUE_OPT_REHANDSHAKE    'e'
 160 #define VALUE_OPT_NOTICKET       7
 161 #define VALUE_OPT_STARTTLS       's'
 162 #define VALUE_OPT_UDP            'u'
 163 #define VALUE_OPT_MTU            10
 164
 165 #define OPT_VALUE_MTU            (DESC(MTU).optArg.argInt)
 166 #define VALUE_OPT_CRLF           11
 167 #define VALUE_OPT_X509FMTDER     12
 168 #define VALUE_OPT_FINGERPRINT    'f'
 169 #define VALUE_OPT_DISABLE_EXTENSIONS 14
 170 #define VALUE_OPT_PRINT_CERT     15
 171 #define VALUE_OPT_RECORDSIZE     16
 172
 173 #define OPT_VALUE_RECORDSIZE     (DESC(RECORDSIZE).optArg.argInt)
 174 #define VALUE_OPT_DH_BITS        17
 175
 176 #define OPT_VALUE_DH_BITS        (DESC(DH_BITS).optArg.argInt)
 177 #define VALUE_OPT_PRIORITY       18
 178 #define VALUE_OPT_X509CAFILE     19
 179 #define VALUE_OPT_X509CRLFILE    20
 180 #define VALUE_OPT_PGPKEYFILE     21
 181 #define VALUE_OPT_PGPKEYRING     22
 182 #define VALUE_OPT_PGPCERTFILE    23
 183 #define VALUE_OPT_X509KEYFILE    24
 184 #define VALUE_OPT_X509CERTFILE   25
 185 #define VALUE_OPT_PGPSUBKEY      26
 186 #define VALUE_OPT_SRPUSERNAME    27
 187 #define VALUE_OPT_SRPPASSWD      28
 188 #define VALUE_OPT_PSKUSERNAME    29
 189 #define VALUE_OPT_PSKKEY         30
 190 #define VALUE_OPT_PORT           'p'
 191 #define VALUE_OPT_INSECURE       32
 192 #define VALUE_OPT_BENCHMARK_CIPHERS 129
 193 #define VALUE_OPT_BENCHMARK_SOFT_CIPHERS 130
 194 #define VALUE_OPT_BENCHMARK_TLS_KX 131
 195 #define VALUE_OPT_BENCHMARK_TLS_CIPHERS 132
 196 #define VALUE_OPT_LIST           'l'
 197 #define VALUE_OPT_HELP          'h'
 198 #define VALUE_OPT_MORE_HELP     '!'
 199 #define VALUE_OPT_VERSION       'v'
 200 /*
 201  *  Interface defines not associated with particular options
 202  */
 203 #define ERRSKIP_OPTERR  STMTS(gnutls_cliOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 204 #define ERRSTOP_OPTERR  STMTS(gnutls_cliOptions.fOptSet |= OPTPROC_ERRSTOP)
 205 #define RESTART_OPT(n)  STMTS( \
 206                 gnutls_cliOptions.curOptIdx = (n); \
 207                 gnutls_cliOptions.pzCurOpt  = NULL)
 208 #define START_OPT       RESTART_OPT(1)
 209 #define USAGE(c)        (*gnutls_cliOptions.pUsageProc)(&gnutls_cliOptions, c)
 210 /* extracted from opthead.tlib near line 484 */
 211
 212 #ifdef  __cplusplus
 213 extern "C" {
 214 #endif
 215 /*
 216  *  global exported definitions
 217  */
 218 #include <gettext.h>
 219
 220
 221 /* * * * * *
 222  *
 223  *  Declare the gnutls-cli option descriptor.
 224  */
 225 extern tOptions gnutls_cliOptions;
 226
 227 #if defined(ENABLE_NLS)
 228 # ifndef _
 229 #   include <stdio.h>
 230 static inline char* aoGetsText(char const* pz) {
 231     if (pz == NULL) return NULL;
 232     return (char*)gettext(pz);
 233 }
 234 #   define _(s)  aoGetsText(s)
 235 # endif /* _() */
 236
 237 # define OPT_NO_XLAT_CFG_NAMES  STMTS(gnutls_cliOptions.fOptSet |= \
 238                                     OPTPROC_NXLAT_OPT_CFG;)
 239 # define OPT_NO_XLAT_OPT_NAMES  STMTS(gnutls_cliOptions.fOptSet |= \
 240                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 241
 242 # define OPT_XLAT_CFG_NAMES     STMTS(gnutls_cliOptions.fOptSet &= \
 243                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 244 # define OPT_XLAT_OPT_NAMES     STMTS(gnutls_cliOptions.fOptSet &= \
 245                                   ~OPTPROC_NXLAT_OPT;)
 246
 247 #else   /* ENABLE_NLS */
 248 # define OPT_NO_XLAT_CFG_NAMES
 249 # define OPT_NO_XLAT_OPT_NAMES
 250
 251 # define OPT_XLAT_CFG_NAMES
 252 # define OPT_XLAT_OPT_NAMES
 253
 254 # ifndef _
 255 #   define _(_s)  _s
 256 # endif
 257 #endif  /* ENABLE_NLS */
 258
 259 #ifdef  __cplusplus
 260 }
 261 #endif
 262 #endif /* AUTOOPTS_CLI_ARGS_H_GUARD */
 263 /* cli-args.h ends here */