edit-daemon-conf.h
/* -*- buffer-read-only: t -*- vi: set ro:
*
* DO NOT EDIT THIS FILE (edit-daemon-conf.h)
*
* It has been AutoGen-ed
* From the definitions stdin
* and the template file options
*
* Generated from AutoOpts 41:1:16 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 daemon 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 daemon program is copyrighted and licensed
* under the following terms:
*
* Copyright (C) 2008-2015 Bruce Korb, 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>
*
* daemon 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.
*
* daemon 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 daemon program.
* These macros are documented in the AutoGen info file in the
* "AutoOpts" chapter. Please refer to that doc for usage help.
*/
#ifndef AUTOOPTS_EDIT_DAEMON_CONF_H_GUARD
#define AUTOOPTS_EDIT_DAEMON_CONF_H_GUARD 1
#include <autoopts/options.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 167937
#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
/**
* Enumeration of each option type for daemon
*/
typedef enum {
INDEX_OPT_PID = 0,
INDEX_OPT_PID_FILE = 1,
INDEX_OPT_NO_SIGHUP = 2,
INDEX_OPT_TEXT = 3,
INDEX_OPT_RESET_OPTION= 4,
INDEX_OPT_VERSION = 5,
INDEX_OPT_HELP = 6,
INDEX_OPT_MORE_HELP = 7,
INDEX_OPT_SAVE_OPTS = 8,
INDEX_OPT_LOAD_OPTS = 9
} teOptIndex;
/** count of all options for daemon */
#define OPTION_CT 10
/** daemon version */
#define DAEMON_VERSION "1.2"
/** Full daemon version text */
#define DAEMON_FULL_VERSION "daemon 1.2"
/**
* Interface defines for all options. Replace "n" with the UPPER_CASED
* option name (as in the teOptIndex enumeration above).
* e.g. HAVE_OPT(PID)
*/
#define DESC(n) (daemonOptions.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 daemon exit codes
*/
typedef enum {
DAEMON_EXIT_SUCCESS = 0,
DAEMON_EXIT_FAILURE = 1,
DAEMON_EXIT_CANNOT_HUP = 62,
DAEMON_EXIT_OPERANDS = 63,
DAEMON_EXIT_USAGE_ERROR = 64,
DAEMON_EXIT_NO_CONFIG_INPUT = 66,
DAEMON_EXIT_LIBOPTS_FAILURE = 70
} daemon_exit_code_t;
/**
* Interface defines for specific options.
* @{
*/
#define VALUE_OPT_PID 0x1001
#define OPT_VALUE_PID (DESC(PID_FILE).optArg.argInt)
#define VALUE_OPT_PID_FILE 0x1002
#define OPT_VALUE_PID_FILE (DESC(PID_FILE).optArg.argFp)
/** Define the option value pid-file is equivalenced to */
#define WHICH_OPT_PID_FILE (DESC(PID_FILE).optActualValue)
/** Define the index of the option pid-file is equivalenced to */
#define WHICH_IDX_PID_FILE (DESC(PID_FILE).optActualIndex)
#define VALUE_OPT_NO_SIGHUP 0x1003
#define VALUE_OPT_TEXT 't'
/** option flag (value) for help-value option */
#define VALUE_OPT_HELP '?'
/** option flag (value) for more-help-value option */
#define VALUE_OPT_MORE_HELP '!'
/** option flag (value) for reset-value option */
#define VALUE_OPT_RESET_OPTION 'R'
/** option flag (value) for version-value option */
#define VALUE_OPT_VERSION 'v'
/** option flag (value) for save-opts-value option */
#define VALUE_OPT_SAVE_OPTS '>'
/** option flag (value) for load-opts-value option */
#define VALUE_OPT_LOAD_OPTS '<'
#define SET_OPT_SAVE_OPTS(a) STMTS( \
DESC(SAVE_OPTS).fOptState &= OPTST_PERSISTENT_MASK; \
DESC(SAVE_OPTS).fOptState |= OPTST_SET; \
DESC(SAVE_OPTS).optArg.argString = (char const*)(a))
/*
* Interface defines not associated with particular options
*/
#define ERRSKIP_OPTERR STMTS(daemonOptions.fOptSet &= ~OPTPROC_ERRSTOP)
#define ERRSTOP_OPTERR STMTS(daemonOptions.fOptSet |= OPTPROC_ERRSTOP)
#define RESTART_OPT(n) STMTS( \
daemonOptions.curOptIdx = (n); \
daemonOptions.pzCurOpt = NULL )
#define START_OPT RESTART_OPT(1)
#define USAGE(c) (*daemonOptions.pUsageProc)(&daemonOptions, c)
#ifdef __cplusplus
extern "C" {
#endif
/* * * * * *
*
* Declare the daemon option descriptor.
*/
extern tOptions daemonOptions;
#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(daemonOptions.fOptSet |= \
OPTPROC_NXLAT_OPT_CFG;)
# define OPT_NO_XLAT_OPT_NAMES STMTS(daemonOptions.fOptSet |= \
OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
# define OPT_XLAT_CFG_NAMES STMTS(daemonOptions.fOptSet &= \
~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
# define OPT_XLAT_OPT_NAMES STMTS(daemonOptions.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_EDIT_DAEMON_CONF_H_GUARD */
/* edit-daemon-conf.h ends here */