/*   -*- buffer-read-only: t -*- vi: set ro:

 *

 *  DO NOT EDIT THIS FILE   (tpmtool-args.h)

 *

 *  It has been AutoGen-ed

 *  From the definitions    tpmtool-args.def

 *  and the template file   options

 *

 * Generated from AutoOpts 42:1:17 templates.

 *

 *  AutoOpts is a copyrighted work.  This header file is not encumbered

 *  by AutoOpts licensing, but is provided under the licensing terms chosen

 *  by the tpmtool author or copyright holder.  AutoOpts is

 *  licensed under the terms of the LGPL.  The redistributable library

 *  (``libopts'') is licensed under the terms of either the LGPL or, at the

 *  users discretion, the BSD license.  See the AutoOpts and/or libopts sources

 *  for details.

 *

 * The tpmtool program is copyrighted and licensed

 * under the following terms:

 *

 *  Copyright (C) 2000-2020 Free Software Foundation, and others, all rights reserved.

 *  This is free software. It is licensed for use, modification and

 *  redistribution under the terms of the GNU General Public License,

 *  version 3 or later <http://gnu.org/licenses/gpl.html>

 *

 *  tpmtool is free software: you can redistribute it and/or modify it

 *  under the terms of the GNU General Public License as published by the

 *  Free Software Foundation, either version 3 of the License, or

 *  (at your option) any later version.

 *

 *  tpmtool is distributed in the hope that it will be useful, but

 *  WITHOUT ANY WARRANTY; without even the implied warranty of

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

 *  See the GNU General Public License for more details.

 *

 *  You should have received a copy of the GNU General Public License along

 *  with this program.  If not, see <http://www.gnu.org/licenses/>.

 */

/**

 *  This file contains the programmatic interface to the Automated

 *  Options generated for the tpmtool program.

 *  These macros are documented in the AutoGen info file in the

 *  "AutoOpts" chapter.  Please refer to that doc for usage help.

 */

#ifndef AUTOOPTS_TPMTOOL_ARGS_H_GUARD

#define AUTOOPTS_TPMTOOL_ARGS_H_GUARD 1

#include "config.h"

#include <autoopts/options.h>

#include <stdarg.h>

#include <stdnoreturn.h>

/**

 *  Ensure that the library used for compiling this generated header is at

 *  least as new as the version current when the header template was released

 *  (not counting patch version increments).  Also ensure that the oldest

 *  tolerable version is at least as old as what was current when the header

 *  template was released.

 */

#define AO_TEMPLATE_VERSION 172033

#if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \

 || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)

# error option template version mismatches autoopts/options.h header

  Choke Me.

#endif

#if GCC_VERSION > 40400

#define NOT_REACHED __builtin_unreachable();

#else

#define NOT_REACHED

#endif

/**

 *  Enumeration of each option type for tpmtool

 */

typedef enum {

    INDEX_OPT_DEBUG           =  0,

    INDEX_OPT_INFILE          =  1,

    INDEX_OPT_OUTFILE         =  2,

    INDEX_OPT_GENERATE_RSA    =  3,

    INDEX_OPT_REGISTER        =  4,

    INDEX_OPT_SIGNING         =  5,

    INDEX_OPT_LEGACY          =  6,

    INDEX_OPT_USER            =  7,

    INDEX_OPT_SYSTEM          =  8,

    INDEX_OPT_PUBKEY          =  9,

    INDEX_OPT_LIST            = 10,

    INDEX_OPT_DELETE          = 11,

    INDEX_OPT_TEST_SIGN       = 12,

    INDEX_OPT_SEC_PARAM       = 13,

    INDEX_OPT_BITS            = 14,

    INDEX_OPT_INDER           = 15,

    INDEX_OPT_OUTDER          = 16,

    INDEX_OPT_SRK_WELL_KNOWN  = 17,

    INDEX_OPT_VERSION         = 18,

    INDEX_OPT_HELP            = 19,

    INDEX_OPT_MORE_HELP       = 20

} teOptIndex;

/** count of all options for tpmtool */

#define OPTION_CT    21

/** tpmtool version */

#define TPMTOOL_VERSION       "3.6.14"

/** Full tpmtool version text */

#define TPMTOOL_FULL_VERSION  "tpmtool 3.6.14"

/**

 *  Interface defines for all options.  Replace "n" with the UPPER_CASED

 *  option name (as in the teOptIndex enumeration above).

 *  e.g. HAVE_OPT(DEBUG)

 */

#define         DESC(n) (tpmtoolOptions.pOptDesc[INDEX_OPT_## n])

/** 'true' if an option has been specified in any way */

#define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))

/** The string argument to an option. The argument type must be \"string\". */

#define      OPT_ARG(n) (DESC(n).optArg.argString)

/** Mask the option state revealing how an option was specified.

 *  It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,

 * \a OPTST_DEFINED, \a OPTST_RESET or zero.

 */

#define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)

/** Count of option's occurrances *on the command line*. */

#define    COUNT_OPT(n) (DESC(n).optOccCt)

/** mask of \a OPTST_SET and \a OPTST_DEFINED. */

#define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))

/** 'true' if \a HAVE_OPT would yield 'false'. */

#define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))

/** 'true' if OPTST_DISABLED bit not set. */

#define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))

/** number of stacked option arguments.

 *  Valid only for stacked option arguments. */

#define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)

/** stacked argument vector.

 *  Valid only for stacked option arguments. */

#define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)

/** Reset an option. */

#define    CLEAR_OPT(n) STMTS( \

                DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \

                if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \

                    DESC(n).fOptState |= OPTST_DISABLED; \

                DESC(n).optCookie = NULL )

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/**

 *  Enumeration of tpmtool exit codes

 */

typedef enum {

    TPMTOOL_EXIT_SUCCESS         = 0,

    TPMTOOL_EXIT_FAILURE         = 1,

    TPMTOOL_EXIT_USAGE_ERROR     = 64,

    TPMTOOL_EXIT_LIBOPTS_FAILURE = 70

}   tpmtool_exit_code_t;

/**

 *  Interface defines for specific options.

 * @{

 */

#define VALUE_OPT_DEBUG          'd'

#define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)

#define VALUE_OPT_INFILE         0x1001

#define VALUE_OPT_OUTFILE        0x1002

#define VALUE_OPT_GENERATE_RSA   0x1003

#define VALUE_OPT_REGISTER       0x1004

#define VALUE_OPT_SIGNING        0x1005

#define VALUE_OPT_LEGACY         0x1006

#define VALUE_OPT_USER           0x1007

#define VALUE_OPT_SYSTEM         0x1008

#define VALUE_OPT_PUBKEY         0x1009

#define VALUE_OPT_LIST           0x100A

#define VALUE_OPT_DELETE         0x100B

#define VALUE_OPT_TEST_SIGN      0x100C

#define VALUE_OPT_SEC_PARAM      0x100D

#define VALUE_OPT_BITS           0x100E

#define OPT_VALUE_BITS           (DESC(BITS).optArg.argInt)

#define VALUE_OPT_INDER          0x100F

#define VALUE_OPT_OUTDER         0x1010

#define VALUE_OPT_SRK_WELL_KNOWN 0x1011

/** option flag (value) for help-value option */

#define VALUE_OPT_HELP          'h'

/** option flag (value) for more-help-value option */

#define VALUE_OPT_MORE_HELP     '!'

/** option flag (value) for version-value option */

#define VALUE_OPT_VERSION       'v'

/*

 *  Interface defines not associated with particular options

 */

#define ERRSKIP_OPTERR  STMTS(tpmtoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)

#define ERRSTOP_OPTERR  STMTS(tpmtoolOptions.fOptSet |= OPTPROC_ERRSTOP)

#define RESTART_OPT(n)  STMTS( \

                tpmtoolOptions.curOptIdx = (n); \

                tpmtoolOptions.pzCurOpt  = NULL )

#define START_OPT       RESTART_OPT(1)

#define USAGE(c)        (*tpmtoolOptions.pUsageProc)(&tpmtoolOptions, c)

#ifdef  __cplusplus

extern "C" {

#endif

/*

 *  global exported definitions

 */

#include <gettext.h>

/* * * * * *

 *

 *  Declare the tpmtool option descriptor.

 */

extern tOptions tpmtoolOptions;

#if defined(ENABLE_NLS)

# ifndef _

#   include <stdio.h>

#   ifndef HAVE_GETTEXT

      extern char * gettext(char const *);

#   else

#     include <libintl.h>

#   endif

# ifndef ATTRIBUTE_FORMAT_ARG

#   define ATTRIBUTE_FORMAT_ARG(_a)

# endif

static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);

static inline char* aoGetsText(char const* pz) {

    if (pz == NULL) return NULL;

    return (char*)gettext(pz);

}

#   define _(s)  aoGetsText(s)

# endif /* _() */

# define OPT_NO_XLAT_CFG_NAMES  STMTS(tpmtoolOptions.fOptSet |= \

                                    OPTPROC_NXLAT_OPT_CFG;)

# define OPT_NO_XLAT_OPT_NAMES  STMTS(tpmtoolOptions.fOptSet |= \

                                    OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)

# define OPT_XLAT_CFG_NAMES     STMTS(tpmtoolOptions.fOptSet &= \

                                  ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)

# define OPT_XLAT_OPT_NAMES     STMTS(tpmtoolOptions.fOptSet &= \

                                  ~OPTPROC_NXLAT_OPT;)

#else   /* ENABLE_NLS */

# define OPT_NO_XLAT_CFG_NAMES

# define OPT_NO_XLAT_OPT_NAMES

# define OPT_XLAT_CFG_NAMES

# define OPT_XLAT_OPT_NAMES

# ifndef _

#   define _(_s)  _s

# endif

#endif  /* ENABLE_NLS */

#ifdef  __cplusplus

}

#endif

#endif /* AUTOOPTS_TPMTOOL_ARGS_H_GUARD */

/* tpmtool-args.h ends here */