document the gnutls_pcert_st
[gnutls.git] / src / cli-debug-args.h
blobb902acd7167e19b0f2bfb649c02a9a56d41f7d65
1 /* -*- buffer-read-only: t -*- vi: set ro:
2 *
3 * DO NOT EDIT THIS FILE (cli-debug-args.h)
4 *
5 * It has been AutoGen-ed May 9, 2012 at 08:04:46 PM by AutoGen 5.16
6 * From the definitions cli-debug-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-debug 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-debug 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-debug 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-debug 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-debug 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_DEBUG_ARGS_H_GUARD
48 #define AUTOOPTS_CLI_DEBUG_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_PORT = 2,
73 INDEX_OPT_VERSION = 3,
74 INDEX_OPT_HELP = 4,
75 INDEX_OPT_MORE_HELP = 5
76 } teOptIndex;
78 #define OPTION_CT 6
79 #define GNUTLS_CLI_DEBUG_VERSION "@VERSION@"
80 #define GNUTLS_CLI_DEBUG_FULL_VERSION "gnutls-cli-debug @VERSION@"
83 * Interface defines for all options. Replace "n" with the UPPER_CASED
84 * option name (as in the teOptIndex enumeration above).
85 * e.g. HAVE_OPT(DEBUG)
87 #define DESC(n) (gnutls_cli_debugOptions.pOptDesc[INDEX_OPT_## n])
88 #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
89 #define OPT_ARG(n) (DESC(n).optArg.argString)
90 #define STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
91 #define COUNT_OPT(n) (DESC(n).optOccCt)
92 #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
93 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
94 #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
95 #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
96 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
97 #define CLEAR_OPT(n) STMTS( \
98 DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \
99 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
100 DESC(n).fOptState |= OPTST_DISABLED; \
101 DESC(n).optCookie = NULL )
103 /* * * * * *
105 * Enumeration of gnutls-cli-debug exit codes
107 typedef enum {
108 GNUTLS_CLI_DEBUG_EXIT_SUCCESS = 0,
109 GNUTLS_CLI_DEBUG_EXIT_FAILURE = 1,
110 GNUTLS_CLI_DEBUG_EXIT_LIBOPTS_FAILURE = 70
111 } gnutls_cli_debug_exit_code_t;
112 /* * * * * *
114 * Interface defines for specific options.
116 #define VALUE_OPT_DEBUG 'd'
118 #define OPT_VALUE_DEBUG (DESC(DEBUG).optArg.argInt)
119 #define VALUE_OPT_VERBOSE 'V'
120 #define VALUE_OPT_PORT 'p'
122 #define OPT_VALUE_PORT (DESC(PORT).optArg.argInt)
123 #define VALUE_OPT_HELP 'h'
124 #define VALUE_OPT_MORE_HELP '!'
125 #define VALUE_OPT_VERSION 'v'
127 * Interface defines not associated with particular options
129 #define ERRSKIP_OPTERR STMTS(gnutls_cli_debugOptions.fOptSet &= ~OPTPROC_ERRSTOP)
130 #define ERRSTOP_OPTERR STMTS(gnutls_cli_debugOptions.fOptSet |= OPTPROC_ERRSTOP)
131 #define RESTART_OPT(n) STMTS( \
132 gnutls_cli_debugOptions.curOptIdx = (n); \
133 gnutls_cli_debugOptions.pzCurOpt = NULL)
134 #define START_OPT RESTART_OPT(1)
135 #define USAGE(c) (*gnutls_cli_debugOptions.pUsageProc)(&gnutls_cli_debugOptions, c)
136 /* extracted from opthead.tlib near line 484 */
138 #ifdef __cplusplus
139 extern "C" {
140 #endif
142 * global exported definitions
144 #include <gettext.h>
147 /* * * * * *
149 * Declare the gnutls-cli-debug option descriptor.
151 extern tOptions gnutls_cli_debugOptions;
153 #if defined(ENABLE_NLS)
154 # ifndef _
155 # include <stdio.h>
156 static inline char* aoGetsText(char const* pz) {
157 if (pz == NULL) return NULL;
158 return (char*)gettext(pz);
160 # define _(s) aoGetsText(s)
161 # endif /* _() */
163 # define OPT_NO_XLAT_CFG_NAMES STMTS(gnutls_cli_debugOptions.fOptSet |= \
164 OPTPROC_NXLAT_OPT_CFG;)
165 # define OPT_NO_XLAT_OPT_NAMES STMTS(gnutls_cli_debugOptions.fOptSet |= \
166 OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
168 # define OPT_XLAT_CFG_NAMES STMTS(gnutls_cli_debugOptions.fOptSet &= \
169 ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
170 # define OPT_XLAT_OPT_NAMES STMTS(gnutls_cli_debugOptions.fOptSet &= \
171 ~OPTPROC_NXLAT_OPT;)
173 #else /* ENABLE_NLS */
174 # define OPT_NO_XLAT_CFG_NAMES
175 # define OPT_NO_XLAT_OPT_NAMES
177 # define OPT_XLAT_CFG_NAMES
178 # define OPT_XLAT_OPT_NAMES
180 # ifndef _
181 # define _(_s) _s
182 # endif
183 #endif /* ENABLE_NLS */
185 #ifdef __cplusplus
187 #endif
188 #endif /* AUTOOPTS_CLI_DEBUG_ARGS_H_GUARD */
189 /* cli-debug-args.h ends here */