dist/ntp/sntp/sntp-opts.h

   1 /*      $NetBSD$        */
   2
   3 /*
   4  *  EDIT THIS FILE WITH CAUTION  (sntp-opts.h)
   5  *
   6  *  It has been AutoGen-ed  Monday May 18, 2009 at 05:03:25 AM EDT
   7  *  From the definitions    sntp-opts.def
   8  *  and the template file   options
   9  *
  10  * Generated from AutoOpts 29:0:4 templates.
  11  */
  12
  13 /*
  14  *  This file was produced by an AutoOpts template.  AutoOpts is a
  15  *  copyrighted work.  This header file is not encumbered by AutoOpts
  16  *  licensing, but is provided under the licensing terms chosen by the
  17  *  sntp author or copyright holder.  AutoOpts is licensed under
  18  *  the terms of the LGPL.  The redistributable library (``libopts'') is
  19  *  licensed under the terms of either the LGPL or, at the users discretion,
  20  *  the BSD license.  See the AutoOpts and/or libopts sources for details.
  21  *
  22  * This source file is copyrighted and licensed under the following terms:
  23  *
  24  * sntp copyright 1970-2006 ntp.org - all rights reserved
  25  *
  26  *         General Public Licence for the software known as MSNTP
  27  *         ------------------------------------------------------
  28  *
  29  *        (c) Copyright, N.M. Maclaren, 1996, 1997, 2000
  30  *        (c) Copyright, University of Cambridge, 1996, 1997, 2000
  31  *
  32  *
  33  *
  34  * Free use of MSNTP in source and binary forms is permitted, provided that this
  35  * entire licence is duplicated in all copies, and that any documentation,
  36  * announcements, and other materials related to use acknowledge that the software
  37  * was developed by N.M. Maclaren (hereafter refered to as the Author) at the
  38  * University of Cambridge.  Neither the name of the Author nor the University of
  39  * Cambridge may be used to endorse or promote products derived from this material
  40  * without specific prior written permission.
  41  *
  42  * The Author and the University of Cambridge retain the copyright and all other
  43  * legal rights to the software and make it available non-exclusively.  All users
  44  * must ensure that the software in all its derivations carries a copyright notice
  45  * in the form:
  46  *        (c) Copyright N.M. Maclaren,
  47  *        (c) Copyright University of Cambridge.
  48  *
  49  *
  50  *
  51  *                            NO WARRANTY
  52  *
  53  * Because the MSNTP software is licensed free of charge, the Author and the
  54  * University of Cambridge provide absolutely no warranty, either expressed or
  55  * implied, including, but not limited to, the implied warranties of
  56  * merchantability and fitness for a particular purpose.  The entire risk as to
  57  * the quality and performance of the MSNTP software is with you.  Should MSNTP
  58  * prove defective, you assume the cost of all necessary servicing or repair.
  59  *
  60  * In no event, unless required by law, will the Author or the University of
  61  * Cambridge, or any other party who may modify and redistribute this software as
  62  * permitted in accordance with the provisions below, be liable for damages for
  63  * any losses whatsoever, including but not limited to lost profits, lost monies,
  64  * lost or corrupted data, or other special, incidental or consequential losses
  65  * that may arise out of the use or inability to use the MSNTP software.
  66  *
  67  *
  68  *
  69  *                          COPYING POLICY
  70  *
  71  * Permission is hereby granted for copying and distribution of copies of the
  72  * MSNTP source and binary files, and of any part thereof, subject to the
  73  * following licence conditions:
  74  *
  75  * 1. You may distribute MSNTP or components of MSNTP, with or without additions
  76  * developed by you or by others.  No charge, other than an "at-cost" distribution
  77  * fee, may be charged for copies, derivations, or distributions of this material
  78  * without the express written consent of the copyright holders.
  79  *
  80  * 2. You may also distribute MSNTP along with any other product for sale,
  81  * provided that the cost of the bundled package is the same regardless of whether
  82  * MSNTP is included or not, and provided that those interested only in MSNTP must
  83  * be notified that it is a product freely available from the University of
  84  * Cambridge.
  85  *
  86  * 3. If you distribute MSNTP software or parts of MSNTP, with or without
  87  * additions developed by you or others, then you must either make available the
  88  * source to all portions of the MSNTP system (exclusive of any additions made by
  89  * you or by others) upon request, or instead you may notify anyone requesting
  90  * source that it is freely available from the University of Cambridge.
  91  *
  92  * 4. You may not omit any of the copyright notices on either the source files,
  93  * the executable files, or the documentation.
  94  *
  95  * 5. You may not omit transmission of this License agreement with whatever
  96  * portions of MSNTP that are distributed.
  97  *
  98  * 6. Any users of this software must be notified that it is without warranty or
  99  * guarantee of any nature, express or implied, nor is there any fitness for use
 100  * represented.
 101  *
 102  *
 103  * October 1996
 104  * April 1997
 105  * October 2000
 106  */
 107 /*
 108  *  This file contains the programmatic interface to the Automated
 109  *  Options generated for the sntp program.
 110  *  These macros are documented in the AutoGen info file in the
 111  *  "AutoOpts" chapter.  Please refer to that doc for usage help.
 112  */
 113 #ifndef AUTOOPTS_SNTP_OPTS_H_GUARD
 114 #define AUTOOPTS_SNTP_OPTS_H_GUARD
 115 #include "config.h"
 116 #include <autoopts/options.h>
 117
 118 /*
 119  *  Ensure that the library used for compiling this generated header is at
 120  *  least as new as the version current when the header template was released
 121  *  (not counting patch version increments).  Also ensure that the oldest
 122  *  tolerable version is at least as old as what was current when the header
 123  *  template was released.
 124  */
 125 #define AO_TEMPLATE_VERSION 118784
 126 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
 127  || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
 128 # error option template version mismatches autoopts/options.h header
 129   Choke Me.
 130 #endif
 131
 132 /*
 133  *  Enumeration of each option:
 134  */
 135 typedef enum {
 136         INDEX_OPT_IPV4             =  0,
 137         INDEX_OPT_IPV6             =  1,
 138         INDEX_OPT_UNPRIVPORT       =  2,
 139         INDEX_OPT_NORMALVERBOSE    =  3,
 140         INDEX_OPT_EXTRAVERBOSE     =  4,
 141         INDEX_OPT_MEGAVERBOSE      =  5,
 142         INDEX_OPT_SETTIMEOFDAY     =  6,
 143         INDEX_OPT_ADJTIME          =  7,
 144         INDEX_OPT_VERSION          = 8,
 145         INDEX_OPT_HELP             = 9,
 146         INDEX_OPT_MORE_HELP        = 10,
 147         INDEX_OPT_SAVE_OPTS        = 11,
 148         INDEX_OPT_LOAD_OPTS        = 12
 149 } teOptIndex;
 150
 151 #define OPTION_CT    13
 152 #define SNTP_VERSION       "4.2.4p7"
 153 #define SNTP_FULL_VERSION  "sntp - standard SNTP program - Ver. 4.2.4p7"
 154
 155 /*
 156  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 157  *  option name (as in the teOptIndex enumeration above).
 158  *  e.g. HAVE_OPT( IPV4 )
 159  */
 160 #define         DESC(n) (sntpOptions.pOptDesc[INDEX_OPT_## n])
 161 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 162 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 163 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 164 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 165 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 166 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 167 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 168 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 169 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 170 #define    CLEAR_OPT(n) STMTS( \
 171                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 172                 if ( (DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 173                     DESC(n).fOptState |= OPTST_DISABLED; \
 174                 DESC(n).optCookie = NULL )
 175
 176 /*
 177  *  Make sure there are no #define name conflicts with the option names
 178  */
 179 #ifndef     NO_OPTION_NAME_WARNINGS
 180 # ifdef    IPV4
 181 #  warning undefining IPV4 due to option name conflict
 182 #  undef   IPV4
 183 # endif
 184 # ifdef    IPV6
 185 #  warning undefining IPV6 due to option name conflict
 186 #  undef   IPV6
 187 # endif
 188 # ifdef    UNPRIVPORT
 189 #  warning undefining UNPRIVPORT due to option name conflict
 190 #  undef   UNPRIVPORT
 191 # endif
 192 # ifdef    NORMALVERBOSE
 193 #  warning undefining NORMALVERBOSE due to option name conflict
 194 #  undef   NORMALVERBOSE
 195 # endif
 196 # ifdef    EXTRAVERBOSE
 197 #  warning undefining EXTRAVERBOSE due to option name conflict
 198 #  undef   EXTRAVERBOSE
 199 # endif
 200 # ifdef    MEGAVERBOSE
 201 #  warning undefining MEGAVERBOSE due to option name conflict
 202 #  undef   MEGAVERBOSE
 203 # endif
 204 # ifdef    SETTIMEOFDAY
 205 #  warning undefining SETTIMEOFDAY due to option name conflict
 206 #  undef   SETTIMEOFDAY
 207 # endif
 208 # ifdef    ADJTIME
 209 #  warning undefining ADJTIME due to option name conflict
 210 #  undef   ADJTIME
 211 # endif
 212 #else  /* NO_OPTION_NAME_WARNINGS */
 213 # undef IPV4
 214 # undef IPV6
 215 # undef UNPRIVPORT
 216 # undef NORMALVERBOSE
 217 # undef EXTRAVERBOSE
 218 # undef MEGAVERBOSE
 219 # undef SETTIMEOFDAY
 220 # undef ADJTIME
 221 #endif  /*  NO_OPTION_NAME_WARNINGS */
 222
 223 /*
 224  *  Interface defines for specific options.
 225  */
 226 #define VALUE_OPT_IPV4           '4'
 227 #define WHICH_OPT_IPV4           (DESC(IPV4).optActualValue)
 228 #define WHICH_IDX_IPV4           (DESC(IPV4).optActualIndex)
 229 #define VALUE_OPT_IPV6           '6'
 230 #define VALUE_OPT_UNPRIVPORT     'u'
 231 #define VALUE_OPT_NORMALVERBOSE  'v'
 232 #define VALUE_OPT_EXTRAVERBOSE   'V'
 233 #define VALUE_OPT_MEGAVERBOSE    'W'
 234 #define VALUE_OPT_SETTIMEOFDAY   'r'
 235 #define VALUE_OPT_ADJTIME        'a'
 236
 237 #define VALUE_OPT_VERSION       'v'
 238 #define VALUE_OPT_HELP          '?'
 239 #define VALUE_OPT_MORE_HELP     '!'
 240 #define VALUE_OPT_SAVE_OPTS     '>'
 241 #define VALUE_OPT_LOAD_OPTS     '<'
 242 #define SET_OPT_SAVE_OPTS(a)   STMTS( \
 243         DESC(SAVE_OPTS).fOptState &= OPTST_PERSISTENT_MASK; \
 244         DESC(SAVE_OPTS).fOptState |= OPTST_SET; \
 245         DESC(SAVE_OPTS).optArg.argString = (char const*)(a) )
 246 /*
 247  *  Interface defines not associated with particular options
 248  */
 249 #define ERRSKIP_OPTERR  STMTS( sntpOptions.fOptSet &= ~OPTPROC_ERRSTOP )
 250 #define ERRSTOP_OPTERR  STMTS( sntpOptions.fOptSet |= OPTPROC_ERRSTOP )
 251 #define RESTART_OPT(n)  STMTS( \
 252                 sntpOptions.curOptIdx = (n); \
 253                 sntpOptions.pzCurOpt  = NULL )
 254 #define START_OPT       RESTART_OPT(1)
 255 #define USAGE(c)        (*sntpOptions.pUsageProc)( &sntpOptions, c )
 256 /* extracted from /usr/local/gnu/share/autogen/opthead.tpl near line 360 */
 257
 258 /* * * * * *
 259  *
 260  *  Declare the sntp option descriptor.
 261  */
 262 #ifdef  __cplusplus
 263 extern "C" {
 264 #endif
 265
 266 extern tOptions   sntpOptions;
 267
 268 #ifndef _
 269 #  if ENABLE_NLS
 270 #    include <stdio.h>
 271      static inline char* aoGetsText( char const* pz ) {
 272          if (pz == NULL) return NULL;
 273          return (char*)gettext( pz );
 274      }
 275 #    define _(s)  aoGetsText(s)
 276 #  else  /* ENABLE_NLS */
 277 #    define _(s)  s
 278 #  endif /* ENABLE_NLS */
 279 #endif
 280
 281 #ifdef  __cplusplus
 282 }
 283 #endif
 284 #endif /* AUTOOPTS_SNTP_OPTS_H_GUARD */
 285 /* sntp-opts.h ends here */