src/systemkey-args.h.bak

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (systemkey-args.h)
   4  *
   5  *  It has been AutoGen-ed
   6  *  From the definitions    systemkey-args.def
   7  *  and the template file   options
   8  *
   9  * Generated from AutoOpts 41:1:16 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 systemkey-tool 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 systemkey-tool program is copyrighted and licensed
  20  * under the following terms:
  21  *
  22  *  Copyright (C) 2000-2016 Free Software Foundation, and others, all rights reserved.
  23  *  This is free software. It is licensed for use, modification and
  24  *  redistribution under the terms of the GNU General Public License,
  25  *  version 3 or later <http://gnu.org/licenses/gpl.html>
  26  *
  27  *  systemkey-tool is free software: you can redistribute it and/or modify it
  28  *  under the terms of the GNU General Public License as published by the
  29  *  Free Software Foundation, either version 3 of the License, or
  30  *  (at your option) any later version.
  31  *
  32  *  systemkey-tool is distributed in the hope that it will be useful, but
  33  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  34  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  35  *  See the GNU General Public License for more details.
  36  *
  37  *  You should have received a copy of the GNU General Public License along
  38  *  with this program.  If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 /**
  41  *  This file contains the programmatic interface to the Automated
  42  *  Options generated for the systemkey-tool program.
  43  *  These macros are documented in the AutoGen info file in the
  44  *  "AutoOpts" chapter.  Please refer to that doc for usage help.
  45  */
  46 #ifndef AUTOOPTS_SYSTEMKEY_ARGS_H_GUARD
  47 #define AUTOOPTS_SYSTEMKEY_ARGS_H_GUARD 1
  48 #include "config.h"
  49 #include <autoopts/options.h>
  50
  51 /**
  52  *  Ensure that the library used for compiling this generated header is at
  53  *  least as new as the version current when the header template was released
  54  *  (not counting patch version increments).  Also ensure that the oldest
  55  *  tolerable version is at least as old as what was current when the header
  56  *  template was released.
  57  */
  58 #define AO_TEMPLATE_VERSION 167937
  59 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  60  || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  61 # error option template version mismatches autoopts/options.h header
  62   Choke Me.
  63 #endif
  64
  65 /**
  66  *  Enumeration of each option type for systemkey-tool
  67  */
  68 typedef enum {
  69     INDEX_OPT_DEBUG       =  0,
  70     INDEX_OPT_INFILE      =  1,
  71     INDEX_OPT_OUTFILE     =  2,
  72     INDEX_OPT_LIST        =  3,
  73     INDEX_OPT_DELETE      =  4,
  74     INDEX_OPT_INDER       =  5,
  75     INDEX_OPT_OUTDER      =  6,
  76     INDEX_OPT_VERSION     =  7,
  77     INDEX_OPT_HELP        =  8,
  78     INDEX_OPT_MORE_HELP   =  9
  79 } teOptIndex;
  80 /** count of all options for systemkey-tool */
  81 #define OPTION_CT    10
  82 /** systemkey-tool version */
  83 #define SYSTEMKEY_TOOL_VERSION       "3.4.11"
  84 /** Full systemkey-tool version text */
  85 #define SYSTEMKEY_TOOL_FULL_VERSION  "systemkey-tool 3.4.11"
  86
  87 /**
  88  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
  89  *  option name (as in the teOptIndex enumeration above).
  90  *  e.g. HAVE_OPT(DEBUG)
  91  */
  92 #define         DESC(n) (systemkey_toolOptions.pOptDesc[INDEX_OPT_## n])
  93 /** 'true' if an option has been specified in any way */
  94 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  95 /** The string argument to an option. The argument type must be \"string\". */
  96 #define      OPT_ARG(n) (DESC(n).optArg.argString)
  97 /** Mask the option state revealing how an option was specified.
  98  *  It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
  99  * \a OPTST_DEFINED, \a OPTST_RESET or zero.
 100  */
 101 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 102 /** Count of option's occurrances *on the command line*. */
 103 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 104 /** mask of \a OPTST_SET and \a OPTST_DEFINED. */
 105 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 106 /** 'true' if \a HAVE_OPT would yield 'false'. */
 107 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 108 /** 'true' if OPTST_DISABLED bit not set. */
 109 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 110 /** number of stacked option arguments.
 111  *  Valid only for stacked option arguments. */
 112 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 113 /** stacked argument vector.
 114  *  Valid only for stacked option arguments. */
 115 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 116 /** Reset an option. */
 117 #define    CLEAR_OPT(n) STMTS( \
 118                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 119                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 120                     DESC(n).fOptState |= OPTST_DISABLED; \
 121                 DESC(n).optCookie = NULL )
 122 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 123 /**
 124  *  Enumeration of systemkey-tool exit codes
 125  */
 126 typedef enum {
 127     SYSTEMKEY_TOOL_EXIT_SUCCESS         = 0,
 128     SYSTEMKEY_TOOL_EXIT_FAILURE         = 1,
 129     SYSTEMKEY_TOOL_EXIT_USAGE_ERROR     = 64,
 130     SYSTEMKEY_TOOL_EXIT_LIBOPTS_FAILURE = 70
 131 }   systemkey_tool_exit_code_t;
 132 /**
 133  *  Interface defines for specific options.
 134  * @{
 135  */
 136 #define VALUE_OPT_DEBUG          'd'
 137
 138 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 139 #define VALUE_OPT_INFILE         0x1001
 140 #define VALUE_OPT_OUTFILE        0x1002
 141 #define VALUE_OPT_LIST           0x1003
 142 #define VALUE_OPT_DELETE         0x1004
 143 #define VALUE_OPT_INDER          0x1005
 144 #define VALUE_OPT_OUTDER         0x1006
 145 /** option flag (value) for help-value option */
 146 #define VALUE_OPT_HELP          'h'
 147 /** option flag (value) for more-help-value option */
 148 #define VALUE_OPT_MORE_HELP     '!'
 149 /** option flag (value) for version-value option */
 150 #define VALUE_OPT_VERSION       'v'
 151 /*
 152  *  Interface defines not associated with particular options
 153  */
 154 #define ERRSKIP_OPTERR  STMTS(systemkey_toolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 155 #define ERRSTOP_OPTERR  STMTS(systemkey_toolOptions.fOptSet |= OPTPROC_ERRSTOP)
 156 #define RESTART_OPT(n)  STMTS( \
 157                 systemkey_toolOptions.curOptIdx = (n); \
 158                 systemkey_toolOptions.pzCurOpt  = NULL )
 159 #define START_OPT       RESTART_OPT(1)
 160 #define USAGE(c)        (*systemkey_toolOptions.pUsageProc)(&systemkey_toolOptions, c)
 161
 162 #ifdef  __cplusplus
 163 extern "C" {
 164 #endif
 165 /*
 166  *  global exported definitions
 167  */
 168 #include <gettext.h>
 169
 170
 171 /* * * * * *
 172  *
 173  *  Declare the systemkey-tool option descriptor.
 174  */
 175 extern tOptions systemkey_toolOptions;
 176
 177 #if defined(ENABLE_NLS)
 178 # ifndef _
 179 #   include <stdio.h>
 180 #   ifndef HAVE_GETTEXT
 181       extern char * gettext(char const *);
 182 #   else
 183 #     include <libintl.h>
 184 #   endif
 185
 186 # ifndef ATTRIBUTE_FORMAT_ARG
 187 #   define ATTRIBUTE_FORMAT_ARG(_a)
 188 # endif
 189
 190 static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
 191 static inline char* aoGetsText(char const* pz) {
 192     if (pz == NULL) return NULL;
 193     return (char*)gettext(pz);
 194 }
 195 #   define _(s)  aoGetsText(s)
 196 # endif /* _() */
 197
 198 # define OPT_NO_XLAT_CFG_NAMES  STMTS(systemkey_toolOptions.fOptSet |= \
 199                                     OPTPROC_NXLAT_OPT_CFG;)
 200 # define OPT_NO_XLAT_OPT_NAMES  STMTS(systemkey_toolOptions.fOptSet |= \
 201                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 202
 203 # define OPT_XLAT_CFG_NAMES     STMTS(systemkey_toolOptions.fOptSet &= \
 204                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 205 # define OPT_XLAT_OPT_NAMES     STMTS(systemkey_toolOptions.fOptSet &= \
 206                                   ~OPTPROC_NXLAT_OPT;)
 207
 208 #else   /* ENABLE_NLS */
 209 # define OPT_NO_XLAT_CFG_NAMES
 210 # define OPT_NO_XLAT_OPT_NAMES
 211
 212 # define OPT_XLAT_CFG_NAMES
 213 # define OPT_XLAT_OPT_NAMES
 214
 215 # ifndef _
 216 #   define _(_s)  _s
 217 # endif
 218 #endif  /* ENABLE_NLS */
 219
 220 #ifdef  __cplusplus
 221 }
 222 #endif
 223 #endif /* AUTOOPTS_SYSTEMKEY_ARGS_H_GUARD */
 224
 225 /* systemkey-args.h ends here */