tcpprep_opts.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. /* -*- buffer-read-only: t -*- vi: set ro:
  2. *
  3. * DO NOT EDIT THIS FILE (tcpprep_opts.h)
  4. *
  5. * It has been AutoGen-ed
  6. * From the definitions tcpprep_opts.def
  7. * and the template file options
  8. *
  9. * Generated from AutoOpts 41:1:16 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 tcpprep 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 tcpprep program is copyrighted and licensed
  20. * under the following terms:
  21. *
  22. * Copyright (C) 2000-2018 Aaron Turner and Fred Klassen, all rights reserved.
  23. * This is free software. It is licensed for use, modification and
  24. * redistribution under the terms of the GNU General Public License,
  25. * version 3 or later <http://gnu.org/licenses/gpl.html>
  26. *
  27. * tcpprep is free software: you can redistribute it and/or modify it
  28. * under the terms of the GNU General Public License as published by the
  29. * Free Software Foundation, either version 3 of the License, or
  30. * (at your option) any later version.
  31. *
  32. * tcpprep is distributed in the hope that it will be useful, but
  33. * WITHOUT ANY WARRANTY; without even the implied warranty of
  34. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  35. * See the GNU General Public License for more details.
  36. *
  37. * You should have received a copy of the GNU General Public License along
  38. * with this program. If not, see <http://www.gnu.org/licenses/>.
  39. */
  40. /**
  41. * This file contains the programmatic interface to the Automated
  42. * Options generated for the tcpprep program.
  43. * These macros are documented in the AutoGen info file in the
  44. * "AutoOpts" chapter. Please refer to that doc for usage help.
  45. */
  46. #ifndef AUTOOPTS_TCPPREP_OPTS_H_GUARD
  47. #define AUTOOPTS_TCPPREP_OPTS_H_GUARD 1
  48. #include "config.h"
  49. #include <autoopts/options.h>
  50. /**
  51. * Ensure that the library used for compiling this generated header is at
  52. * least as new as the version current when the header template was released
  53. * (not counting patch version increments). Also ensure that the oldest
  54. * tolerable version is at least as old as what was current when the header
  55. * template was released.
  56. */
  57. #define AO_TEMPLATE_VERSION 167937
  58. #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  59. || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  60. # error option template version mismatches autoopts/options.h header
  61. Choke Me.
  62. #endif
  63. /**
  64. * Enumeration of each option type for tcpprep
  65. */
  66. typedef enum {
  67. INDEX_OPT_DBUG = 0,
  68. INDEX_OPT_AUTO = 1,
  69. INDEX_OPT_CIDR = 2,
  70. INDEX_OPT_REGEX = 3,
  71. INDEX_OPT_PORT = 4,
  72. INDEX_OPT_MAC = 5,
  73. INDEX_OPT_REVERSE = 6,
  74. INDEX_OPT_COMMENT = 7,
  75. INDEX_OPT_NO_ARG_COMMENT = 8,
  76. INDEX_OPT_INCLUDE = 9,
  77. INDEX_OPT_EXCLUDE = 10,
  78. INDEX_OPT_CACHEFILE = 11,
  79. INDEX_OPT_PCAP = 12,
  80. INDEX_OPT_PRINT_COMMENT = 13,
  81. INDEX_OPT_PRINT_INFO = 14,
  82. INDEX_OPT_PRINT_STATS = 15,
  83. INDEX_OPT_SERVICES = 16,
  84. INDEX_OPT_NONIP = 17,
  85. INDEX_OPT_RATIO = 18,
  86. INDEX_OPT_MINMASK = 19,
  87. INDEX_OPT_MAXMASK = 20,
  88. INDEX_OPT_VERBOSE = 21,
  89. INDEX_OPT_DECODE = 22,
  90. INDEX_OPT_VERSION = 23,
  91. INDEX_OPT_LESS_HELP = 24,
  92. INDEX_OPT_HELP = 25,
  93. INDEX_OPT_MORE_HELP = 26,
  94. INDEX_OPT_SAVE_OPTS = 27,
  95. INDEX_OPT_LOAD_OPTS = 28
  96. } teOptIndex;
  97. /** count of all options for tcpprep */
  98. #define OPTION_CT 29
  99. /**
  100. * Interface defines for all options. Replace "n" with the UPPER_CASED
  101. * option name (as in the teOptIndex enumeration above).
  102. * e.g. HAVE_OPT(DBUG)
  103. */
  104. #define DESC(n) (tcpprepOptions.pOptDesc[INDEX_OPT_## n])
  105. /** 'true' if an option has been specified in any way */
  106. #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  107. /** The string argument to an option. The argument type must be \"string\". */
  108. #define OPT_ARG(n) (DESC(n).optArg.argString)
  109. /** Mask the option state revealing how an option was specified.
  110. * It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
  111. * \a OPTST_DEFINED, \a OPTST_RESET or zero.
  112. */
  113. #define STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
  114. /** Count of option's occurrances *on the command line*. */
  115. #define COUNT_OPT(n) (DESC(n).optOccCt)
  116. /** mask of \a OPTST_SET and \a OPTST_DEFINED. */
  117. #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
  118. /** 'true' if \a HAVE_OPT would yield 'false'. */
  119. #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
  120. /** 'true' if OPTST_DISABLED bit not set. */
  121. #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
  122. /** number of stacked option arguments.
  123. * Valid only for stacked option arguments. */
  124. #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
  125. /** stacked argument vector.
  126. * Valid only for stacked option arguments. */
  127. #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
  128. /** Reset an option. */
  129. #define CLEAR_OPT(n) STMTS( \
  130. DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \
  131. if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
  132. DESC(n).fOptState |= OPTST_DISABLED; \
  133. DESC(n).optCookie = NULL )
  134. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  135. /**
  136. * Enumeration of tcpprep exit codes
  137. */
  138. typedef enum {
  139. TCPPREP_EXIT_SUCCESS = 0,
  140. TCPPREP_EXIT_FAILURE = 1,
  141. TCPPREP_EXIT_USAGE_ERROR = 64,
  142. TCPPREP_EXIT_NO_CONFIG_INPUT = 66,
  143. TCPPREP_EXIT_LIBOPTS_FAILURE = 70
  144. } tcpprep_exit_code_t;
  145. /**
  146. * Interface defines for specific options.
  147. * @{
  148. */
  149. #define VALUE_OPT_DBUG 'd'
  150. #ifdef DEBUG
  151. #define OPT_VALUE_DBUG (DESC(DBUG).optArg.argInt)
  152. #endif /* DEBUG */
  153. #define VALUE_OPT_AUTO 'a'
  154. #define VALUE_OPT_CIDR 'c'
  155. #define VALUE_OPT_REGEX 'r'
  156. #define VALUE_OPT_PORT 'p'
  157. #define VALUE_OPT_MAC 'e'
  158. #define VALUE_OPT_REVERSE 0x1001
  159. #define VALUE_OPT_COMMENT 'C'
  160. #define VALUE_OPT_NO_ARG_COMMENT 0x1002
  161. #define VALUE_OPT_INCLUDE 'x'
  162. #define VALUE_OPT_EXCLUDE 'X'
  163. #define VALUE_OPT_CACHEFILE 'o'
  164. #define VALUE_OPT_PCAP 'i'
  165. #define VALUE_OPT_PRINT_COMMENT 'P'
  166. #define VALUE_OPT_PRINT_INFO 'I'
  167. #define VALUE_OPT_PRINT_STATS 'S'
  168. #define VALUE_OPT_SERVICES 's'
  169. #define VALUE_OPT_NONIP 'N'
  170. #define VALUE_OPT_RATIO 'R'
  171. #define VALUE_OPT_MINMASK 'm'
  172. #define OPT_VALUE_MINMASK (DESC(MINMASK).optArg.argInt)
  173. #define VALUE_OPT_MAXMASK 'M'
  174. #define OPT_VALUE_MAXMASK (DESC(MAXMASK).optArg.argInt)
  175. #define VALUE_OPT_VERBOSE 'v'
  176. #ifdef ENABLE_VERBOSE
  177. #define SET_OPT_VERBOSE STMTS( \
  178. DESC(VERBOSE).optActualIndex = 21; \
  179. DESC(VERBOSE).optActualValue = VALUE_OPT_VERBOSE; \
  180. DESC(VERBOSE).fOptState &= OPTST_PERSISTENT_MASK; \
  181. DESC(VERBOSE).fOptState |= OPTST_SET )
  182. #endif /* ENABLE_VERBOSE */
  183. #define VALUE_OPT_DECODE 'A'
  184. #define VALUE_OPT_VERSION 'V'
  185. #define VALUE_OPT_LESS_HELP 'h'
  186. /** option flag (value) for help-value option */
  187. #define VALUE_OPT_HELP 'H'
  188. /** option flag (value) for more-help-value option */
  189. #define VALUE_OPT_MORE_HELP '!'
  190. /** option flag (value) for save-opts-value option */
  191. #define VALUE_OPT_SAVE_OPTS 0x1003
  192. /** option flag (value) for load-opts-value option */
  193. #define VALUE_OPT_LOAD_OPTS 0x1004
  194. #define SET_OPT_SAVE_OPTS(a) STMTS( \
  195. DESC(SAVE_OPTS).fOptState &= OPTST_PERSISTENT_MASK; \
  196. DESC(SAVE_OPTS).fOptState |= OPTST_SET; \
  197. DESC(SAVE_OPTS).optArg.argString = (char const*)(a))
  198. /*
  199. * Interface defines not associated with particular options
  200. */
  201. #define ERRSKIP_OPTERR STMTS(tcpprepOptions.fOptSet &= ~OPTPROC_ERRSTOP)
  202. #define ERRSTOP_OPTERR STMTS(tcpprepOptions.fOptSet |= OPTPROC_ERRSTOP)
  203. #define RESTART_OPT(n) STMTS( \
  204. tcpprepOptions.curOptIdx = (n); \
  205. tcpprepOptions.pzCurOpt = NULL )
  206. #define START_OPT RESTART_OPT(1)
  207. #define USAGE(c) (*tcpprepOptions.pUsageProc)(&tcpprepOptions, c)
  208. #ifdef __cplusplus
  209. extern "C" {
  210. #endif
  211. /* * * * * *
  212. *
  213. * Declare the tcpprep option descriptor.
  214. */
  215. extern tOptions tcpprepOptions;
  216. #if defined(ENABLE_NLS)
  217. # ifndef _
  218. # include <stdio.h>
  219. # ifndef HAVE_GETTEXT
  220. extern char * gettext(char const *);
  221. # else
  222. # include <libintl.h>
  223. # endif
  224. # ifndef ATTRIBUTE_FORMAT_ARG
  225. # define ATTRIBUTE_FORMAT_ARG(_a)
  226. # endif
  227. static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
  228. static inline char* aoGetsText(char const* pz) {
  229. if (pz == NULL) return NULL;
  230. return (char*)gettext(pz);
  231. }
  232. # define _(s) aoGetsText(s)
  233. # endif /* _() */
  234. # define OPT_NO_XLAT_CFG_NAMES STMTS(tcpprepOptions.fOptSet |= \
  235. OPTPROC_NXLAT_OPT_CFG;)
  236. # define OPT_NO_XLAT_OPT_NAMES STMTS(tcpprepOptions.fOptSet |= \
  237. OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
  238. # define OPT_XLAT_CFG_NAMES STMTS(tcpprepOptions.fOptSet &= \
  239. ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
  240. # define OPT_XLAT_OPT_NAMES STMTS(tcpprepOptions.fOptSet &= \
  241. ~OPTPROC_NXLAT_OPT;)
  242. #else /* ENABLE_NLS */
  243. # define OPT_NO_XLAT_CFG_NAMES
  244. # define OPT_NO_XLAT_OPT_NAMES
  245. # define OPT_XLAT_CFG_NAMES
  246. # define OPT_XLAT_OPT_NAMES
  247. # ifndef _
  248. # define _(_s) _s
  249. # endif
  250. #endif /* ENABLE_NLS */
  251. #ifdef __cplusplus
  252. }
  253. #endif
  254. #endif /* AUTOOPTS_TCPPREP_OPTS_H_GUARD */
  255. /* tcpprep_opts.h ends here */