annotate liboctave/wrappers/getopt-wrapper.h @ 29911:218716316e62

maint: Merge stable to default.
author John W. Eaton <jwe@octave.org>
date Thu, 22 Jul 2021 13:53:43 -0400
parents 7854d5752dd2 0f41e117789f
children 796f54d4ddbf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
3 // Copyright (C) 2016-2021 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 #if ! defined (octave_getopt_wrapper_h)
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 #define octave_getopt_wrapper_h 1
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 #if defined __cplusplus
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 extern "C" {
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 #endif
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 struct octave_getopt_options
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 {
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 const char *name;
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 int has_arg;
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 int *flag;
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 int val;
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 };
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 #define octave_no_arg 0
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 #define octave_required_arg 1
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 #define octave_optional_arg 2
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44
29231
4e196fbb28a5 Set API tags in files in liboctave/wrappers (patch #8919).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27923
diff changeset
45 extern OCTAVE_API int
22514
1e007e986396 Fix octave_getopt_long_wrapper prototype to avoid warnings on some systems (bug #49131)
Mike Miller <mtmiller@octave.org>
parents: 22090
diff changeset
46 octave_getopt_long_wrapper (int argc, char **argv,
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 const char *shortopts,
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 const struct octave_getopt_options *longopts,
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 int *longind);
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50
29231
4e196fbb28a5 Set API tags in files in liboctave/wrappers (patch #8919).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27923
diff changeset
51 extern OCTAVE_API char * octave_optarg_wrapper (void);
22090
66db9a493c84 avoid accessing optarg and optind directly (bug #48454)
John W. Eaton <jwe@octave.org>
parents: 22064
diff changeset
52
29231
4e196fbb28a5 Set API tags in files in liboctave/wrappers (patch #8919).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27923
diff changeset
53 extern OCTAVE_API int octave_optind_wrapper (void);
22090
66db9a493c84 avoid accessing optarg and optind directly (bug #48454)
John W. Eaton <jwe@octave.org>
parents: 22064
diff changeset
54
29910
0f41e117789f disable getopt error reporting in wrapper program (bug #60886)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
55 extern OCTAVE_API int octave_get_opterr_wrapper (void);
0f41e117789f disable getopt error reporting in wrapper program (bug #60886)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
56 extern OCTAVE_API int octave_set_opterr_wrapper (int val);
0f41e117789f disable getopt error reporting in wrapper program (bug #60886)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
57
22064
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 #if defined __cplusplus
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 }
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 #endif
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61
bd4f3d2ce52f provide wrapper for getopt
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 #endif