src/psk-args.h

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (psk-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    psk-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 psktool 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 psktool 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  *  psktool 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  *  psktool 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 psktool 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_PSK_ARGS_H_GUARD
  48 #define AUTOOPTS_PSK_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_KEYSIZE     =  1,
  72     INDEX_OPT_USERNAME    =  2,
  73     INDEX_OPT_PASSWD      =  3,
  74     INDEX_OPT_VERSION     =  4,
  75     INDEX_OPT_HELP        =  5,
  76     INDEX_OPT_MORE_HELP   =  6
  77 } teOptIndex;
  78
  79 #define OPTION_CT    7
  80 #define PSKTOOL_VERSION       "@VERSION@"
  81 #define PSKTOOL_FULL_VERSION  "psktool @VERSION@"
  82
  83 /*
  84  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
  85  *  option name (as in the teOptIndex enumeration above).
  86  *  e.g. HAVE_OPT(DEBUG)
  87  */
  88 #define         DESC(n) (psktoolOptions.pOptDesc[INDEX_OPT_## n])
  89 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  90 #define      OPT_ARG(n) (DESC(n).optArg.argString)
  91 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
  92 #define    COUNT_OPT(n) (DESC(n).optOccCt)
  93 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
  94 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
  95 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
  96 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
  97 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
  98 #define    CLEAR_OPT(n) STMTS( \
  99                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 100                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 101                     DESC(n).fOptState |= OPTST_DISABLED; \
 102                 DESC(n).optCookie = NULL )
 103
 104 /* * * * * *
 105  *
 106  *  Enumeration of psktool exit codes
 107  */
 108 typedef enum {
 109     PSKTOOL_EXIT_SUCCESS = 0,
 110     PSKTOOL_EXIT_FAILURE = 1,
 111     PSKTOOL_EXIT_LIBOPTS_FAILURE = 70
 112 } psktool_exit_code_t;
 113 /* * * * * *
 114  *
 115  *  Interface defines for specific options.
 116  */
 117 #define VALUE_OPT_DEBUG          'd'
 118
 119 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 120 #define VALUE_OPT_KEYSIZE        's'
 121
 122 #define OPT_VALUE_KEYSIZE        (DESC(KEYSIZE).optArg.argInt)
 123 #define VALUE_OPT_USERNAME       'u'
 124 #define VALUE_OPT_PASSWD         'p'
 125 #define VALUE_OPT_HELP          'h'
 126 #define VALUE_OPT_MORE_HELP     '!'
 127 #define VALUE_OPT_VERSION       'v'
 128 /*
 129  *  Interface defines not associated with particular options
 130  */
 131 #define ERRSKIP_OPTERR  STMTS(psktoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 132 #define ERRSTOP_OPTERR  STMTS(psktoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 133 #define RESTART_OPT(n)  STMTS( \
 134                 psktoolOptions.curOptIdx = (n); \
 135                 psktoolOptions.pzCurOpt  = NULL)
 136 #define START_OPT       RESTART_OPT(1)
 137 #define USAGE(c)        (*psktoolOptions.pUsageProc)(&psktoolOptions, c)
 138 /* extracted from opthead.tlib near line 484 */
 139
 140 #ifdef  __cplusplus
 141 extern "C" {
 142 #endif
 143 /*
 144  *  global exported definitions
 145  */
 146 #include <gettext.h>
 147
 148
 149 /* * * * * *
 150  *
 151  *  Declare the psktool option descriptor.
 152  */
 153 extern tOptions psktoolOptions;
 154
 155 #if defined(ENABLE_NLS)
 156 # ifndef _
 157 #   include <stdio.h>
 158 static inline char* aoGetsText(char const* pz) {
 159     if (pz == NULL) return NULL;
 160     return (char*)gettext(pz);
 161 }
 162 #   define _(s)  aoGetsText(s)
 163 # endif /* _() */
 164
 165 # define OPT_NO_XLAT_CFG_NAMES  STMTS(psktoolOptions.fOptSet |= \
 166                                     OPTPROC_NXLAT_OPT_CFG;)
 167 # define OPT_NO_XLAT_OPT_NAMES  STMTS(psktoolOptions.fOptSet |= \
 168                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 169
 170 # define OPT_XLAT_CFG_NAMES     STMTS(psktoolOptions.fOptSet &= \
 171                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 172 # define OPT_XLAT_OPT_NAMES     STMTS(psktoolOptions.fOptSet &= \
 173                                   ~OPTPROC_NXLAT_OPT;)
 174
 175 #else   /* ENABLE_NLS */
 176 # define OPT_NO_XLAT_CFG_NAMES
 177 # define OPT_NO_XLAT_OPT_NAMES
 178
 179 # define OPT_XLAT_CFG_NAMES
 180 # define OPT_XLAT_OPT_NAMES
 181
 182 # ifndef _
 183 #   define _(_s)  _s
 184 # endif
 185 #endif  /* ENABLE_NLS */
 186
 187 #ifdef  __cplusplus
 188 }
 189 #endif
 190 #endif /* AUTOOPTS_PSK_ARGS_H_GUARD */
 191 /* psk-args.h ends here */