src/srptool-args.h

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (srptool-args.h)
   4  *
   5  *  It has been AutoGen-ed  May  9, 2012 at 08:04:44 PM by AutoGen 5.16
   6  *  From the definitions    srptool-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 srptool 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 srptool 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  *  srptool 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  *  srptool 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 srptool 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_SRPTOOL_ARGS_H_GUARD
  48 #define AUTOOPTS_SRPTOOL_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_INDEX        =  1,
  72     INDEX_OPT_USERNAME     =  2,
  73     INDEX_OPT_PASSWD       =  3,
  74     INDEX_OPT_SALT         =  4,
  75     INDEX_OPT_VERIFY       =  5,
  76     INDEX_OPT_PASSWD_CONF  =  6,
  77     INDEX_OPT_CREATE_CONF  =  7,
  78     INDEX_OPT_VERSION      =  8,
  79     INDEX_OPT_HELP         =  9,
  80     INDEX_OPT_MORE_HELP    = 10
  81 } teOptIndex;
  82
  83 #define OPTION_CT    11
  84 #define SRPTOOL_VERSION       "@VERSION@"
  85 #define SRPTOOL_FULL_VERSION  "srptool @VERSION@"
  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) (srptoolOptions.pOptDesc[INDEX_OPT_## n])
  93 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  94 #define      OPT_ARG(n) (DESC(n).optArg.argString)
  95 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
  96 #define    COUNT_OPT(n) (DESC(n).optOccCt)
  97 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
  98 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
  99 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 100 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 101 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 102 #define    CLEAR_OPT(n) STMTS( \
 103                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 104                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 105                     DESC(n).fOptState |= OPTST_DISABLED; \
 106                 DESC(n).optCookie = NULL )
 107
 108 /* * * * * *
 109  *
 110  *  Enumeration of srptool exit codes
 111  */
 112 typedef enum {
 113     SRPTOOL_EXIT_SUCCESS = 0,
 114     SRPTOOL_EXIT_FAILURE = 1,
 115     SRPTOOL_EXIT_LIBOPTS_FAILURE = 70
 116 } srptool_exit_code_t;
 117 /* * * * * *
 118  *
 119  *  Interface defines for specific options.
 120  */
 121 #define VALUE_OPT_DEBUG          'd'
 122
 123 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 124 #define VALUE_OPT_INDEX          'i'
 125 #define VALUE_OPT_USERNAME       'u'
 126 #define VALUE_OPT_PASSWD         'p'
 127 #define VALUE_OPT_SALT           's'
 128
 129 #define OPT_VALUE_SALT           (DESC(SALT).optArg.argInt)
 130 #define VALUE_OPT_VERIFY         5
 131 #define VALUE_OPT_PASSWD_CONF    'v'
 132 #define VALUE_OPT_CREATE_CONF    7
 133 #define VALUE_OPT_HELP          'h'
 134 #define VALUE_OPT_MORE_HELP     '!'
 135 #define VALUE_OPT_VERSION       'v'
 136 /*
 137  *  Interface defines not associated with particular options
 138  */
 139 #define ERRSKIP_OPTERR  STMTS(srptoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 140 #define ERRSTOP_OPTERR  STMTS(srptoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 141 #define RESTART_OPT(n)  STMTS( \
 142                 srptoolOptions.curOptIdx = (n); \
 143                 srptoolOptions.pzCurOpt  = NULL)
 144 #define START_OPT       RESTART_OPT(1)
 145 #define USAGE(c)        (*srptoolOptions.pUsageProc)(&srptoolOptions, c)
 146 /* extracted from opthead.tlib near line 484 */
 147
 148 #ifdef  __cplusplus
 149 extern "C" {
 150 #endif
 151 /*
 152  *  global exported definitions
 153  */
 154 #include <gettext.h>
 155
 156
 157 /* * * * * *
 158  *
 159  *  Declare the srptool option descriptor.
 160  */
 161 extern tOptions srptoolOptions;
 162
 163 #if defined(ENABLE_NLS)
 164 # ifndef _
 165 #   include <stdio.h>
 166 static inline char* aoGetsText(char const* pz) {
 167     if (pz == NULL) return NULL;
 168     return (char*)gettext(pz);
 169 }
 170 #   define _(s)  aoGetsText(s)
 171 # endif /* _() */
 172
 173 # define OPT_NO_XLAT_CFG_NAMES  STMTS(srptoolOptions.fOptSet |= \
 174                                     OPTPROC_NXLAT_OPT_CFG;)
 175 # define OPT_NO_XLAT_OPT_NAMES  STMTS(srptoolOptions.fOptSet |= \
 176                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 177
 178 # define OPT_XLAT_CFG_NAMES     STMTS(srptoolOptions.fOptSet &= \
 179                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 180 # define OPT_XLAT_OPT_NAMES     STMTS(srptoolOptions.fOptSet &= \
 181                                   ~OPTPROC_NXLAT_OPT;)
 182
 183 #else   /* ENABLE_NLS */
 184 # define OPT_NO_XLAT_CFG_NAMES
 185 # define OPT_NO_XLAT_OPT_NAMES
 186
 187 # define OPT_XLAT_CFG_NAMES
 188 # define OPT_XLAT_OPT_NAMES
 189
 190 # ifndef _
 191 #   define _(_s)  _s
 192 # endif
 193 #endif  /* ENABLE_NLS */
 194
 195 #ifdef  __cplusplus
 196 }
 197 #endif
 198 #endif /* AUTOOPTS_SRPTOOL_ARGS_H_GUARD */
 199 /* srptool-args.h ends here */