annotate liboctave/prog-args.h @ 6469:a848b846cb3a ss-2-9-10

[project @ 2007-03-27 18:42:11 by jwe]
author jwe
date Tue, 27 Mar 2007 18:42:11 +0000
parents 143b556ce725
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1816
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
1 /*
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 1993
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
1816
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
4
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
6
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
10 later version.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
11
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
15 for more details.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
16
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 2847
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 2847
diff changeset
20 02110-1301, USA.
1816
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
21
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
22 */
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
23
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_prog_args_h)
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
25 #define octave_prog_args_h 1
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
26
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
27 struct
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
28 long_options
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
29 {
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
30 const char *name;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
31 int has_arg;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
32 int *flag;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
33 int val;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
34 };
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
35
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
36 class
6108
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe]
jwe
parents: 5307
diff changeset
37 OCTAVE_API
1816
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
38 prog_args
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
39 {
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
40 public:
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
41
1855
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
42 // These values must match the corresponding defines in getopt.h.
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
43 enum option_argument
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
44 {
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
45 no_arg = 0,
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
46 required_arg = 1,
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
47 optional_arg = 2
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
48 };
cdc5b74cc261 [project @ 1996-02-03 14:48:32 by jwe]
jwe
parents: 1816
diff changeset
49
1816
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
50 prog_args (int argc, char *const *argv, const char *s_opts, const
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
51 long_options* l_opts = 0)
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
52 : xargc (argc), xargv (argv), short_opts (s_opts), long_opts (l_opts)
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
53 {
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
54 init ();
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
55 }
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
56
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
57 ~prog_args (void) { }
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
58
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
59 int getopt (void);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
60
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
61 const char *optarg (void);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
62
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
63 int optind (void);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
64
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
65 private:
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
66
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
67 // Number of args.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
68 int xargc;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
69
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
70 // Program args.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
71 char *const *xargv;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
72
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
73 // Single character options.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
74 const char *short_opts;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
75
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
76 // Long options.
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
77 const long_options *long_opts;
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
78
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
79 void init (void);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
80
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
81 prog_args (const prog_args&);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
82
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
83 prog_args& operator = (const prog_args&);
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
84 };
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
85
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
86 #endif
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
87
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
88 /*
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
89 ;;; Local Variables: ***
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
90 ;;; mode: C++ ***
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
91 ;;; End: ***
747a99cbe1b0 [project @ 1996-01-29 21:11:41 by jwe]
jwe
parents:
diff changeset
92 */