summaryrefslogtreecommitdiff
path: root/src/p11tool-args.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/p11tool-args.h')
-rw-r--r--src/p11tool-args.h75
1 files changed, 51 insertions, 24 deletions
diff --git a/src/p11tool-args.h b/src/p11tool-args.h
index c60633ca3a..672e835eb8 100644
--- a/src/p11tool-args.h
+++ b/src/p11tool-args.h
@@ -1,12 +1,12 @@
/* -*- buffer-read-only: t -*- vi: set ro:
- *
+ *
* DO NOT EDIT THIS FILE (p11tool-args.h)
- *
- * It has been AutoGen-ed November 28, 2012 at 11:45:35 PM by AutoGen 5.16
+ *
+ * It has been AutoGen-ed May 29, 2013 at 07:49:16 PM by AutoGen 5.17.3
* From the definitions p11tool-args.def
* and the template file options
*
- * Generated from AutoOpts 36:4:11 templates.
+ * 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
@@ -21,24 +21,23 @@
*
* 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
- * <http://gnu.org/licenses/gpl.html>
+ * redistribution under the terms of the GNU General Public License,
+ * version 3 or later <http://gnu.org/licenses/gpl.html>
*
* p11tool 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.
- *
+ *
* p11tool 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 <http://www.gnu.org/licenses/>.
*/
-/*
+/**
* This file contains the programmatic interface to the Automated
* Options generated for the p11tool program.
* These macros are documented in the AutoGen info file in the
@@ -49,22 +48,22 @@
#include "config.h"
#include <autoopts/options.h>
-/*
+/**
* 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 147460
+#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:
+/**
+ * Enumeration of each option type for p11tool
*/
typedef enum {
INDEX_OPT_DEBUG = 0,
@@ -102,44 +101,63 @@ typedef enum {
INDEX_OPT_HELP = 32,
INDEX_OPT_MORE_HELP = 33
} teOptIndex;
-
+/** count of all options for p11tool */
#define OPTION_CT 34
+/** p11tool version */
#define P11TOOL_VERSION "@VERSION@"
+/** Full p11tool version text */
#define P11TOOL_FULL_VERSION "p11tool @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) (p11toolOptions.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 p11tool exit codes
*/
typedef enum {
- P11TOOL_EXIT_SUCCESS = 0,
- P11TOOL_EXIT_FAILURE = 1,
- P11TOOL_EXIT_LIBOPTS_FAILURE = 70
+ P11TOOL_EXIT_SUCCESS = 0,
+ P11TOOL_EXIT_FAILURE = 1,
+ P11TOOL_EXIT_USAGE_ERROR = 64,
+ P11TOOL_EXIT_LIBOPTS_FAILURE = 70
} p11tool_exit_code_t;
-/* * * * * *
- *
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+/**
* Interface defines for specific options.
+ * @{
*/
#define VALUE_OPT_DEBUG 'd'
@@ -176,8 +194,11 @@ typedef enum {
#define VALUE_OPT_INDER 28
#define VALUE_OPT_INRAW 29
#define VALUE_OPT_PROVIDER 30
+/** 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
@@ -189,7 +210,7 @@ typedef enum {
p11toolOptions.pzCurOpt = NULL)
#define START_OPT RESTART_OPT(1)
#define USAGE(c) (*p11toolOptions.pUsageProc)(&p11toolOptions, c)
-/* extracted from opthead.tlib near line 484 */
+/* extracted from opthead.tlib near line 538 */
#ifdef __cplusplus
extern "C" {
@@ -209,6 +230,12 @@ extern tOptions p11toolOptions;
#if defined(ENABLE_NLS)
# ifndef _
# include <stdio.h>
+# ifndef HAVE_GETTEXT
+ extern char * gettext(char const *);
+# else
+# include <libintl.h>
+# endif
+
static inline char* aoGetsText(char const* pz) {
if (pz == NULL) return NULL;
return (char*)gettext(pz);