src/tpmtool-args.h

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (tpmtool-args.h)
   4  *
   5  *  It has been AutoGen-ed  November  8, 2012 at 11:35:56 PM by AutoGen 5.16
   6  *  From the definitions    tpmtool-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 tpmtool 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 tpmtool 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  *  tpmtool 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  *  tpmtool 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 tpmtool 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_TPMTOOL_ARGS_H_GUARD
  48 #define AUTOOPTS_TPMTOOL_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_INFILE        =  1,
  72     INDEX_OPT_OUTFILE       =  2,
  73     INDEX_OPT_GENERATE_RSA  =  3,
  74     INDEX_OPT_REGISTER      =  4,
  75     INDEX_OPT_SIGNING       =  5,
  76     INDEX_OPT_LEGACY        =  6,
  77     INDEX_OPT_USER          =  7,
  78     INDEX_OPT_SYSTEM        =  8,
  79     INDEX_OPT_PUBKEY        =  9,
  80     INDEX_OPT_LIST          = 10,
  81     INDEX_OPT_DELETE        = 11,
  82     INDEX_OPT_SEC_PARAM     = 12,
  83     INDEX_OPT_BITS          = 13,
  84     INDEX_OPT_INDER         = 14,
  85     INDEX_OPT_OUTDER        = 15,
  86     INDEX_OPT_VERSION       = 16,
  87     INDEX_OPT_HELP          = 17,
  88     INDEX_OPT_MORE_HELP     = 18
  89 } teOptIndex;
  90
  91 #define OPTION_CT    19
  92 #define TPMTOOL_VERSION       "@VERSION@"
  93 #define TPMTOOL_FULL_VERSION  "tpmtool @VERSION@"
  94
  95 /*
  96  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
  97  *  option name (as in the teOptIndex enumeration above).
  98  *  e.g. HAVE_OPT(DEBUG)
  99  */
 100 #define         DESC(n) (tpmtoolOptions.pOptDesc[INDEX_OPT_## n])
 101 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 102 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 103 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 104 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 105 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 106 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 107 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 108 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 109 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 110 #define    CLEAR_OPT(n) STMTS( \
 111                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 112                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 113                     DESC(n).fOptState |= OPTST_DISABLED; \
 114                 DESC(n).optCookie = NULL )
 115
 116 /* * * * * *
 117  *
 118  *  Enumeration of tpmtool exit codes
 119  */
 120 typedef enum {
 121     TPMTOOL_EXIT_SUCCESS = 0,
 122     TPMTOOL_EXIT_FAILURE = 1,
 123     TPMTOOL_EXIT_LIBOPTS_FAILURE = 70
 124 } tpmtool_exit_code_t;
 125 /* * * * * *
 126  *
 127  *  Interface defines for specific options.
 128  */
 129 #define VALUE_OPT_DEBUG          'd'
 130
 131 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 132 #define VALUE_OPT_INFILE         1
 133 #define VALUE_OPT_OUTFILE        2
 134 #define VALUE_OPT_GENERATE_RSA   3
 135 #define VALUE_OPT_REGISTER       4
 136 #define VALUE_OPT_SIGNING        5
 137 #define VALUE_OPT_LEGACY         6
 138 #define VALUE_OPT_USER           7
 139 #define VALUE_OPT_SYSTEM         8
 140 #define VALUE_OPT_PUBKEY         9
 141 #define VALUE_OPT_LIST           10
 142 #define VALUE_OPT_DELETE         11
 143 #define VALUE_OPT_SEC_PARAM      12
 144 #define VALUE_OPT_BITS           13
 145
 146 #define OPT_VALUE_BITS           (DESC(BITS).optArg.argInt)
 147 #define VALUE_OPT_INDER          14
 148 #define VALUE_OPT_OUTDER         15
 149 #define VALUE_OPT_HELP          'h'
 150 #define VALUE_OPT_MORE_HELP     '!'
 151 #define VALUE_OPT_VERSION       'v'
 152 /*
 153  *  Interface defines not associated with particular options
 154  */
 155 #define ERRSKIP_OPTERR  STMTS(tpmtoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 156 #define ERRSTOP_OPTERR  STMTS(tpmtoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 157 #define RESTART_OPT(n)  STMTS( \
 158                 tpmtoolOptions.curOptIdx = (n); \
 159                 tpmtoolOptions.pzCurOpt  = NULL)
 160 #define START_OPT       RESTART_OPT(1)
 161 #define USAGE(c)        (*tpmtoolOptions.pUsageProc)(&tpmtoolOptions, c)
 162 /* extracted from opthead.tlib near line 484 */
 163
 164 #ifdef  __cplusplus
 165 extern "C" {
 166 #endif
 167 /*
 168  *  global exported definitions
 169  */
 170 #include <gettext.h>
 171
 172
 173 /* * * * * *
 174  *
 175  *  Declare the tpmtool option descriptor.
 176  */
 177 extern tOptions tpmtoolOptions;
 178
 179 #if defined(ENABLE_NLS)
 180 # ifndef _
 181 #   include <stdio.h>
 182 static inline char* aoGetsText(char const* pz) {
 183     if (pz == NULL) return NULL;
 184     return (char*)gettext(pz);
 185 }
 186 #   define _(s)  aoGetsText(s)
 187 # endif /* _() */
 188
 189 # define OPT_NO_XLAT_CFG_NAMES  STMTS(tpmtoolOptions.fOptSet |= \
 190                                     OPTPROC_NXLAT_OPT_CFG;)
 191 # define OPT_NO_XLAT_OPT_NAMES  STMTS(tpmtoolOptions.fOptSet |= \
 192                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 193
 194 # define OPT_XLAT_CFG_NAMES     STMTS(tpmtoolOptions.fOptSet &= \
 195                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 196 # define OPT_XLAT_OPT_NAMES     STMTS(tpmtoolOptions.fOptSet &= \
 197                                   ~OPTPROC_NXLAT_OPT;)
 198
 199 #else   /* ENABLE_NLS */
 200 # define OPT_NO_XLAT_CFG_NAMES
 201 # define OPT_NO_XLAT_OPT_NAMES
 202
 203 # define OPT_XLAT_CFG_NAMES
 204 # define OPT_XLAT_OPT_NAMES
 205
 206 # ifndef _
 207 #   define _(_s)  _s
 208 # endif
 209 #endif  /* ENABLE_NLS */
 210
 211 #ifdef  __cplusplus
 212 }
 213 #endif
 214 #endif /* AUTOOPTS_TPMTOOL_ARGS_H_GUARD */
 215 /* tpmtool-args.h ends here */