better xlC support on AIX; added option to use bundled getopt on UNIX
[public/netxms.git] / include / netxms_getopt.h
1 /* Declarations for getopt.
2 Copyright (C) 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
3
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
7 later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
17
18 #ifndef _GETOPT_H
19 #define _GETOPT_H 1
20
21 #undef HAVE_GETOPT_LONG
22 #define HAVE_GETOPT_LONG 1
23
24 #undef HAVE_DECL_GETOPT_LONG
25 #define HAVE_DECL_GETOPT_LONG 1
26
27 #ifdef _WIN32
28 #ifdef LIBNETXMS_EXPORTS
29 #define GETOPT_EXPORTABLE __declspec(dllexport)
30 #else
31 #define GETOPT_EXPORTABLE __declspec(dllimport)
32 #endif
33 #else /* _WIN32 */
34 #define GETOPT_EXPORTABLE
35 #endif
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /* For communication from `getopt' to the caller.
42 When `getopt' finds an option that takes an argument,
43 the argument value is returned here.
44 Also, when `ordering' is RETURN_IN_ORDER,
45 each non-option ARGV-element is returned here. */
46
47 extern GETOPT_EXPORTABLE char *optarg;
48
49 /* Index in ARGV of the next element to be scanned.
50 This is used for communication to and from the caller
51 and for communication between successive calls to `getopt'.
52
53 On entry to `getopt', zero means this is the first call; initialize.
54
55 When `getopt' returns EOF, this is the index of the first of the
56 non-option elements that the caller should itself scan.
57
58 Otherwise, `optind' communicates from one call to the next
59 how much of ARGV has been scanned so far. */
60
61 extern GETOPT_EXPORTABLE int optind;
62
63 /* Callers store zero here to inhibit the error message `getopt' prints
64 for unrecognized options. */
65
66 extern GETOPT_EXPORTABLE int opterr;
67
68 /* Set to an option character which was unrecognized. */
69
70 extern GETOPT_EXPORTABLE int optopt;
71
72 /* Describe the long-named options requested by the application.
73 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
74 of `struct option' terminated by an element containing a name which is
75 zero.
76
77 The field `has_arg' is:
78 no_argument (or 0) if the option does not take an argument,
79 required_argument (or 1) if the option requires an argument,
80 optional_argument (or 2) if the option takes an optional argument.
81
82 If the field `flag' is not NULL, it points to a variable that is set
83 to the value given in the field `val' when the option is found, but
84 left unchanged if the option is not found.
85
86 To have a long-named option do something other than set an `int' to
87 a compiled-in constant, such as set a value from `optarg', set the
88 option's `flag' field to zero and its `val' field to a nonzero
89 value (the equivalent single-letter option character, if there is
90 one). For long options that have a zero `flag' field, `getopt'
91 returns the contents of the `val' field. */
92
93 struct option
94 {
95 #if __STDC__
96 const char *name;
97 #else
98 char *name;
99 #endif
100 /* has_arg can't be an enum because some compilers complain about
101 type mismatches in all the code that assumes it is an int. */
102 int has_arg;
103 int *flag;
104 int val;
105 };
106
107 /* Names for the values of the `has_arg' field of `struct option'. */
108
109 #define no_argument 0
110 #define required_argument 1
111 #define optional_argument 2
112
113 extern int GETOPT_EXPORTABLE getopt (int argc, char *const *argv, const char *shortopts);
114 extern int GETOPT_EXPORTABLE getopt_long (int argc, char *const *argv, const char *shortopts,
115 const struct option *longopts, int *longind);
116 extern int GETOPT_EXPORTABLE getopt_long_only (int argc, char *const *argv,
117 const char *shortopts,
118 const struct option *longopts, int *longind);
119
120 /* Internal only. Users should not call this directly. */
121 extern int _getopt_internal (int argc, char *const *argv,
122 const char *shortopts,
123 const struct option *longopts, int *longind,
124 int long_only);
125
126 #ifdef __cplusplus
127 }
128 #endif
129
130 #endif /* _GETOPT_H */