Updated gnulib and added hash-pjw-bare
[gnutls.git] / src / cli-args.h
blob86e710b0e76a9701e56b9616867dbe01286ab318
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 September 30, 2012 at 03:25:07 PM by AutoGen 5.16
6 * From the definitions cli-args.def
7 * and the template file options
9 * Generated from AutoOpts 36:4:11 templates.
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.
19 * The gnutls-cli program is copyrighted and licensed
20 * under the following terms:
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>
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.
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.
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/>.
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.
47 #ifndef AUTOOPTS_CLI_ARGS_H_GUARD
48 #define AUTOOPTS_CLI_ARGS_H_GUARD 1
49 #include "config.h"
50 #include <autoopts/options.h>
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.
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
67 * Enumeration of each option:
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_OCSP_STATUS_REQUEST = 8,
79 INDEX_OPT_STARTTLS = 9,
80 INDEX_OPT_UDP = 10,
81 INDEX_OPT_MTU = 11,
82 INDEX_OPT_CRLF = 12,
83 INDEX_OPT_X509FMTDER = 13,
84 INDEX_OPT_FINGERPRINT = 14,
85 INDEX_OPT_DISABLE_EXTENSIONS = 15,
86 INDEX_OPT_PRINT_CERT = 16,
87 INDEX_OPT_RECORDSIZE = 17,
88 INDEX_OPT_DH_BITS = 18,
89 INDEX_OPT_PRIORITY = 19,
90 INDEX_OPT_X509CAFILE = 20,
91 INDEX_OPT_X509CRLFILE = 21,
92 INDEX_OPT_PGPKEYFILE = 22,
93 INDEX_OPT_PGPKEYRING = 23,
94 INDEX_OPT_PGPCERTFILE = 24,
95 INDEX_OPT_X509KEYFILE = 25,
96 INDEX_OPT_X509CERTFILE = 26,
97 INDEX_OPT_PGPSUBKEY = 27,
98 INDEX_OPT_SRPUSERNAME = 28,
99 INDEX_OPT_SRPPASSWD = 29,
100 INDEX_OPT_PSKUSERNAME = 30,
101 INDEX_OPT_PSKKEY = 31,
102 INDEX_OPT_PORT = 32,
103 INDEX_OPT_INSECURE = 33,
104 INDEX_OPT_BENCHMARK_CIPHERS = 34,
105 INDEX_OPT_BENCHMARK_SOFT_CIPHERS = 35,
106 INDEX_OPT_BENCHMARK_TLS_KX = 36,
107 INDEX_OPT_BENCHMARK_TLS_CIPHERS = 37,
108 INDEX_OPT_LIST = 38,
109 INDEX_OPT_VERSION = 39,
110 INDEX_OPT_HELP = 40,
111 INDEX_OPT_MORE_HELP = 41
112 } teOptIndex;
114 #define OPTION_CT 42
115 #define GNUTLS_CLI_VERSION "@VERSION@"
116 #define GNUTLS_CLI_FULL_VERSION "gnutls-cli @VERSION@"
119 * Interface defines for all options. Replace "n" with the UPPER_CASED
120 * option name (as in the teOptIndex enumeration above).
121 * e.g. HAVE_OPT(DEBUG)
123 #define DESC(n) (gnutls_cliOptions.pOptDesc[INDEX_OPT_## n])
124 #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
125 #define OPT_ARG(n) (DESC(n).optArg.argString)
126 #define STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
127 #define COUNT_OPT(n) (DESC(n).optOccCt)
128 #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
129 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
130 #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
131 #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
132 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
133 #define CLEAR_OPT(n) STMTS( \
134 DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \
135 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
136 DESC(n).fOptState |= OPTST_DISABLED; \
137 DESC(n).optCookie = NULL )
139 /* * * * * *
141 * Enumeration of gnutls-cli exit codes
143 typedef enum {
144 GNUTLS_CLI_EXIT_SUCCESS = 0,
145 GNUTLS_CLI_EXIT_FAILURE = 1,
146 GNUTLS_CLI_EXIT_LIBOPTS_FAILURE = 70
147 } gnutls_cli_exit_code_t;
148 /* * * * * *
150 * Interface defines for specific options.
152 #define VALUE_OPT_DEBUG 'd'
154 #define OPT_VALUE_DEBUG (DESC(DEBUG).optArg.argInt)
155 #define VALUE_OPT_VERBOSE 'V'
156 #define VALUE_OPT_TOFU 2
157 #define VALUE_OPT_OCSP 3
158 #define VALUE_OPT_RESUME 'r'
159 #define VALUE_OPT_HEARTBEAT 'b'
160 #define VALUE_OPT_REHANDSHAKE 'e'
161 #define VALUE_OPT_NOTICKET 7
162 #define VALUE_OPT_OCSP_STATUS_REQUEST 8
163 #define VALUE_OPT_STARTTLS 's'
164 #define VALUE_OPT_UDP 'u'
165 #define VALUE_OPT_MTU 11
167 #define OPT_VALUE_MTU (DESC(MTU).optArg.argInt)
168 #define VALUE_OPT_CRLF 12
169 #define VALUE_OPT_X509FMTDER 13
170 #define VALUE_OPT_FINGERPRINT 'f'
171 #define VALUE_OPT_DISABLE_EXTENSIONS 15
172 #define VALUE_OPT_PRINT_CERT 16
173 #define VALUE_OPT_RECORDSIZE 17
175 #define OPT_VALUE_RECORDSIZE (DESC(RECORDSIZE).optArg.argInt)
176 #define VALUE_OPT_DH_BITS 18
178 #define OPT_VALUE_DH_BITS (DESC(DH_BITS).optArg.argInt)
179 #define VALUE_OPT_PRIORITY 19
180 #define VALUE_OPT_X509CAFILE 20
181 #define VALUE_OPT_X509CRLFILE 21
182 #define VALUE_OPT_PGPKEYFILE 22
183 #define VALUE_OPT_PGPKEYRING 23
184 #define VALUE_OPT_PGPCERTFILE 24
185 #define VALUE_OPT_X509KEYFILE 25
186 #define VALUE_OPT_X509CERTFILE 26
187 #define VALUE_OPT_PGPSUBKEY 27
188 #define VALUE_OPT_SRPUSERNAME 28
189 #define VALUE_OPT_SRPPASSWD 29
190 #define VALUE_OPT_PSKUSERNAME 30
191 #define VALUE_OPT_PSKKEY 31
192 #define VALUE_OPT_PORT 'p'
193 #define VALUE_OPT_INSECURE 129
194 #define VALUE_OPT_BENCHMARK_CIPHERS 130
195 #define VALUE_OPT_BENCHMARK_SOFT_CIPHERS 131
196 #define VALUE_OPT_BENCHMARK_TLS_KX 132
197 #define VALUE_OPT_BENCHMARK_TLS_CIPHERS 133
198 #define VALUE_OPT_LIST 'l'
199 #define VALUE_OPT_HELP 'h'
200 #define VALUE_OPT_MORE_HELP '!'
201 #define VALUE_OPT_VERSION 'v'
203 * Interface defines not associated with particular options
205 #define ERRSKIP_OPTERR STMTS(gnutls_cliOptions.fOptSet &= ~OPTPROC_ERRSTOP)
206 #define ERRSTOP_OPTERR STMTS(gnutls_cliOptions.fOptSet |= OPTPROC_ERRSTOP)
207 #define RESTART_OPT(n) STMTS( \
208 gnutls_cliOptions.curOptIdx = (n); \
209 gnutls_cliOptions.pzCurOpt = NULL)
210 #define START_OPT RESTART_OPT(1)
211 #define USAGE(c) (*gnutls_cliOptions.pUsageProc)(&gnutls_cliOptions, c)
212 /* extracted from opthead.tlib near line 484 */
214 #ifdef __cplusplus
215 extern "C" {
216 #endif
218 * global exported definitions
220 #include <gettext.h>
223 /* * * * * *
225 * Declare the gnutls-cli option descriptor.
227 extern tOptions gnutls_cliOptions;
229 #if defined(ENABLE_NLS)
230 # ifndef _
231 # include <stdio.h>
232 static inline char* aoGetsText(char const* pz) {
233 if (pz == NULL) return NULL;
234 return (char*)gettext(pz);
236 # define _(s) aoGetsText(s)
237 # endif /* _() */
239 # define OPT_NO_XLAT_CFG_NAMES STMTS(gnutls_cliOptions.fOptSet |= \
240 OPTPROC_NXLAT_OPT_CFG;)
241 # define OPT_NO_XLAT_OPT_NAMES STMTS(gnutls_cliOptions.fOptSet |= \
242 OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
244 # define OPT_XLAT_CFG_NAMES STMTS(gnutls_cliOptions.fOptSet &= \
245 ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
246 # define OPT_XLAT_OPT_NAMES STMTS(gnutls_cliOptions.fOptSet &= \
247 ~OPTPROC_NXLAT_OPT;)
249 #else /* ENABLE_NLS */
250 # define OPT_NO_XLAT_CFG_NAMES
251 # define OPT_NO_XLAT_OPT_NAMES
253 # define OPT_XLAT_CFG_NAMES
254 # define OPT_XLAT_OPT_NAMES
256 # ifndef _
257 # define _(_s) _s
258 # endif
259 #endif /* ENABLE_NLS */
261 #ifdef __cplusplus
263 #endif
264 #endif /* AUTOOPTS_CLI_ARGS_H_GUARD */
265 /* cli-args.h ends here */