/usr/include/teem/hest.h is in libteem-dev 1.11.0~svn5226-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | /*
Teem: Tools to process and visualize scientific data and images
Copyright (C) 2008, 2007, 2006, 2005 Gordon Kindlmann
Copyright (C) 2004, 2003, 2002, 2001, 2000, 1999, 1998 University of Utah
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
(LGPL) as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The terms of redistributing and/or modifying this software also
include exceptions to the LGPL that facilitate static linking.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef HEST_HAS_BEEN_INCLUDED
#define HEST_HAS_BEEN_INCLUDED
#include <stdio.h>
#include <stddef.h>
#include <stdarg.h>
#include <string.h>
#include <teem/air.h>
#if defined(_WIN32) && !defined(__CYGWIN__) && !defined(TEEM_STATIC)
# if defined(TEEM_BUILD) || defined(hest_EXPORTS) || defined(teem_EXPORTS)
# define HEST_EXPORT extern __declspec(dllexport)
# else
# define HEST_EXPORT extern __declspec(dllimport)
# endif
#else /* TEEM_STATIC || UNIX */
# define HEST_EXPORT extern
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
******** hestCB struct
**
** for when the thing you want to parse from the command-line is not a
** simple boolean, number, airEnum, or string. hestParse() will not
** allocate anything to store individual things, though it may
** allocate an array in the case of a multiple variable parameter
** option. If your things are actually pointers to things, then you
** do the allocation in the parse() callback. In this case, you set
** destroy() to be your "destructor", and it will be called on the
** result of derefencing the argument to parse().
*/
typedef struct {
size_t size; /* sizeof() one thing */
char *type; /* used by hestGlossary() to describe the type */
int (*parse)(void *ptr, char *str, char err[AIR_STRLEN_HUGE]);
/* how to parse one thing from a string. This will
be called multiple times for multiple parameter
options. A non-zero return value is considered
an error. Error message go in the err string */
void *(*destroy)(void *ptr);
/* if non-NULL, this is the destructor that will be
called by hestParseFree() (or by hestParse() if
there is an error midway through parsing). The
argument is NOT the same as passed to parse():
it is the result of dereferencing the argument
to parse() */
} hestCB;
/*
******** hestOpt struct
**
** information which specifies one command-line option
*/
typedef struct {
char *flag, /* how the option is identified on the cmd line */
*name; /* simple description of option's parameter(s) */
int type; /* type of option (from airType enum) */
unsigned int min;
int max; /* min and max # of parameters for option */
void *valueP; /* storage of parsed values */
char *dflt, /* default value written out as string */
*info; /* description to be printed with "glossary" info */
unsigned int *sawP; /* used ONLY for multiple variable parameter options
(min < max > 2): storage of # of parsed values */
airEnum *enm; /* used ONLY for airTypeEnum options */
hestCB *CB; /* used ONLY for airTypeOther options */
/* --------------------- end of user-defined fields */
int kind, /* what kind of option is this, based on min and max,
set by hestParse() (actually _hestPanic()),
later used by hestFree():
1: min == max == 0
stand-alone flag; no parameters
2: min == max == 1
single fixed parameter
3: min == max >= 2
multiple fixed parameters
4: min == 0; max == 1;
single variable parameter
5: max - min >= 1; max >= 2
multiple variable parameters */
alloc; /* information about whether flag is non-NULL, and what
parameters were used, that determines whether or
not memory was allocated by hestParse(); info
later used by hestParseFree():
0: no free()ing needed
1: free(*valueP), either because it is a single
string, or because was a dynamically allocated
array of non-strings
2: free((*valueP)[i]), because they are elements
of a fixed-length array of strings
3: free((*valueP)[i]) and free(*valueP), because
it is a dynamically allocated array of strings */
} hestOpt;
/*
******** hestParm struct
**
** parameters to control behavior of hest functions.
**
** GK: Don't even think about storing per-parse state in here.
*/
typedef struct {
int verbosity, /* verbose diagnostic messages to stdout */
respFileEnable, /* whether or not to use response files */
elideSingleEnumType, /* if type is airTypeEnum, and if its a single fixed
parameter option, then don't bother printing the
type information as part of hestGlossary() */
elideSingleOtherType, /* like above, but for airTypeOther */
elideSingleOtherDefault, /* don't display default for single fixed
airTypeOther parameter */
elideSingleNonExistFloatDefault, /* if default for a single fixed floating
point (float or double) parameter
doesn't AIR_EXIST, then don't display
the default */
elideMultipleNonExistFloatDefault,
elideSingleEmptyStringDefault, /* if default for a single string is empty
(""), then don't display default */
elideMultipleEmptyStringDefault,
noArgsIsNoProblem, /* if non-zero, having no arguments to parse is not in
and of itself a problem; this means that if all
options have defaults, it would be *ok* to invoke
the problem without any further command-line
options. This is counter to pre-Teem-1.11
behavior (for which no arguments *always* meant
"show me usage info"). */
greedySingleString, /* when parsing a single string, whether or not
to be greedy (as per airParseStrS) */
cleverPluralizeOtherY, /* when printing the type for airTypeOther, when
the min number of items is > 1, and the type
string ends with "y", then pluralize with
"ies" instead of "ys" */
columns; /* number of printable columns in output */
char respFileFlag, /* the character at the beginning of an argument
indicating that this is a response file name */
respFileComment, /* comment character for the repose files */
varParamStopFlag, /* prefixed by '-' to form the flag which signals
the end of a flagged variable parameter option
(single or multiple) */
multiFlagSep; /* character in flag which signifies that there is
a long and short version, and which separates
the two. Or, can be set to '\0' to disable this
behavior entirely. */
} hestParm;
/* defaultsHest.c */
/* HEY: recent Teem conventions say these should all start with
"hestDef" not just "hest" */
HEST_EXPORT int hestVerbosity;
HEST_EXPORT int hestRespFileEnable;
HEST_EXPORT int hestElideSingleEnumType;
HEST_EXPORT int hestElideSingleOtherType;
HEST_EXPORT int hestElideSingleOtherDefault;
HEST_EXPORT int hestElideSingleNonExistFloatDefault;
HEST_EXPORT int hestElideMultipleNonExistFloatDefault;
HEST_EXPORT int hestElideSingleEmptyStringDefault;
HEST_EXPORT int hestElideMultipleEmptyStringDefault;
HEST_EXPORT int hestNoArgsIsNoProblem;
HEST_EXPORT int hestGreedySingleString;
HEST_EXPORT int hestCleverPluralizeOtherY;
HEST_EXPORT int hestColumns;
HEST_EXPORT char hestRespFileFlag;
HEST_EXPORT char hestRespFileComment;
HEST_EXPORT char hestVarParamStopFlag;
HEST_EXPORT char hestMultiFlagSep;
/* methodsHest.c */
HEST_EXPORT const int hestPresent;
HEST_EXPORT hestParm *hestParmNew(void);
HEST_EXPORT hestParm *hestParmFree(hestParm *parm);
HEST_EXPORT void hestOptAdd(hestOpt **optP,
const char *flag, const char *name,
int type, int min, int max,
void *valueP, const char *dflt, const char *info,
... /* int *sawP, airEnum *enm , hestCB *CB */);
HEST_EXPORT hestOpt *hestOptFree(hestOpt *opt);
HEST_EXPORT int hestOptCheck(hestOpt *opt, char **errP);
/* parseHest.c */
HEST_EXPORT int hestParse(hestOpt *opt, int argc, const char **argv,
char **errP, hestParm *parm);
HEST_EXPORT void *hestParseFree(hestOpt *opt);
HEST_EXPORT void hestParseOrDie(hestOpt *opt, int argc, const char **argv,
hestParm *parm,
const char *me, const char *info,
int doInfo, int doUsage, int doGlossary);
/* usage.c */
HEST_EXPORT void _hestPrintStr(FILE *f, int indent, int already, int width,
const char *_str, int bslash);
HEST_EXPORT int hestMinNumArgs(hestOpt *opt);
HEST_EXPORT void hestUsage(FILE *file, hestOpt *opt, const char *argv0,
hestParm *parm);
HEST_EXPORT void hestGlossary(FILE *file, hestOpt *opt, hestParm *parm);
HEST_EXPORT void hestInfo(FILE *file, const char *argv0, const char *info,
hestParm *parm);
#ifdef __cplusplus
}
#endif
#endif /* HEST_HAS_BEEN_INCLUDED */
|