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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323 | ---------------------------------------------------------------- {{{1 ---------
--: Copyright © 1998 Nasser Abbasi --
--: Copyright © 2003 Martin Krischik --
-------------------------------------------------------------------------------
--: This is free software; you can redistribute it and/or modify it under --
--: terms of the GNU General Public License as published by the Free Soft- --
--: ware Foundation; either version 2, or (at your option) any later ver- --
--: sion. GETOPT is distributed in the hope that it will be useful, but WITH --
--: OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
--: or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
--: for more details. Free Software Foundation, 59 Temple Place - Suite --
--: 330, Boston, MA 02111-1307, USA. --
--: --
--: As a special exception, if other files instantiate generics from this --
--: unit, or you link this unit with other files to produce an executable, --
--: this unit does not by itself cause the resulting executable to be --
--: covered by the GNU General Public License. This exception does not --
--: however invalidate any other reasons why the executable file might be --
--: covered by the GNU Public License. --
-------------------------------------------------------------------------------
--: change history: --
--: --
--: name changes --
--: ---------- --------------------------------------------------------------
--: NMA021899 created --
--: NMA030299 Made it modified GPL. chanegd header. --
--: --
--: description: --
--: --
--: This package is an Ada implementation of getopt() as specified by the --
--: document "The Single UNIX Specification, Version 2", Copyright 1997 The --
--: Open Group --
--: --
--: Compiler used: GNAT 3.11p --
--: Platform: Linux 2.0.36 ( Red hat 5.2) --
--------------------------------------------------------------- }}}1 ----------
pragma License (Modified_Gpl);
pragma Ada_2022;
with Ada.Characters.Latin_1;
with Ada.Strings.Unbounded;
---
-- @summary
-- Ada Class Library
-- Analyze commmandline
--
-- @description
-- An opject oriented version of getopt made for Ada - thats without the C style uglines. If you are looking for a
-- 100% compatible Version of getopt see:
--
-- Also, unlike for exapmle GNAT.Command_Line this package is reentrant. All internal states are kept inside the class
-- instanz so two tasks can parse the commandline in parallel.
--
-- last not least we support GNU style commandline options.
--
package AdaCL.Command_Line.GetOpt is
---
-- internale data
type Object is tagged private;
-- Return values. The C version had only two states: -1 error, > 0 option character.
--
--: @value EndOfOptions no more options
--: @value NoOption no option
--: @value GNU_Style GNU style option
--: @value WithArgument option with argument
--: @value WithoutArgument option without argument
--: @value Error parser encountered error
type FoundFlag is
(EndOfOptions,
NoOption,
GNU_Style,
WithArgument,
WithoutArgument,
Error);
---
-- GNU Option to request Help
--
Help_GNU : constant String;
---
-- Short Option to request Help
--
Help_Short : constant Character;
---
-- Flags an Error, unkown options are errors
--
Option_Error : Character renames Ada.Characters.Latin_1.Question;
---
-- Options with Arguments.
--
Option_Argument : Character renames Ada.Characters.Latin_1.Colon;
---
-- Character with which all options start
--
Option_Marker : Character renames Ada.Characters.Latin_1.Hyphen;
---
-- Option could not be parsed
--
Option_Parse_Error : exception;
---
-- Option was not given
--
Option_Missing_Error : exception;
---
-- Wrong combination of Options was not given
--
Option_Wrong_Error : exception;
---
-- get next Option.
--
--: @param This Object itself.
--: @param Found Result of the Next command
procedure Next (This : in out Object; Found : out FoundFlag);
---
-- Start Parsing the commandline.
--
--: @param This the Object itself
procedure Parse (This : in out Object);
---
-- A Classic Style Option without Argument was found on the commandline
--
--: @param This the Object itself
procedure Analyze_WithoutArgument (This : in out Object);
---
-- A Classic Style Option with Argument was found on the commandline
--
--: @param This the Object itself
procedure Analyze_WithArgument (This : in out Object);
---
-- A GNU Style was found on the commandline
--
--: @param This the Object itself
procedure Analyze_GNU (This : in out Object);
---
-- A File was found on the commandline
--
--: @param This the Object itself
procedure Analyze_File (This : in out Object);
---
-- Print a help line
--
--: @param Long Long GNU style option
--: @param Description descrition of option
procedure Put_Help_Line (Long : String; Description : String) with
Pre => (Long'Length < 20);
---
-- Print a help line
--
--: @param Short Short option
--: @param Long Long GNU style option
--: @param Description descrition of option
procedure Put_Help_Line
(Short : Character;
Long : String;
Description : String) with
Pre => (Long'Length < 20);
---
-- Print a help line
--
--: @param Long Long GNU style option
--: @param Option parameter for option
--: @param Description descrition of option
procedure Put_Help_Line
(Long : String;
Option : String;
Description : String) with
Pre => (Option'Length + 1 < 10) and then (Long'Length + Option'Length + 1 < 20);
---
-- Print a help line
--
--: @param Short Short option
--: @param Long Long GNU style option
--: @param Option parameter for option
--: @param Description descrition of option
procedure Put_Help_Line
(Short : Character;
Long : String;
Option : String;
Description : String) with
Pre => (Option'Length + 1 < 10) and then (Long'Length + Option'Length + 1 < 20);
---
-- A Call for Help was found on the commandline
--
--: @param This the Object itself
procedure WriteHelp (This : in out Object);
---
-- Nr of Last Option processed
--
--: @param This Object itself.
function Get_Optind (This : in Object) return Positive;
pragma Inline (Get_Optind);
---
-- Last Argument Option Found.
--
--: @param This Object itself.
function Get_Argument (This : in Object) return String;
pragma Inline (Get_Argument);
---
-- Last Single Character Option Found.
--
--: @param This Object itself.
--: @return Option found.
function Get_Option (This : in Object) return Character;
pragma Inline (Get_Option);
---
-- Last GNU-Option Found.
--
--: @param This Object itself.
--: @return GNU option found.
function Get_GNUOption (This : in Object) return String;
pragma Inline (Get_GNUOption);
---
-- Get Format string. The usual mix of options and ':'
--
--: @param This Object itself.
--: @return currently used pattern.
function Get_Pattern (This : in Object) return String;
pragma Inline (Get_Pattern);
---
-- Set Format string. The usual mix of options and ':'
--
--: @param This Object itself.
--: @param Pattern Pattern to parse.
procedure Set_Pattern (This : in out Object; Pattern : in String);
pragma Inline (Set_Pattern);
---
-- Set Errorhandling on or off
--
--: @param This Object itself.
--: @param ExceptionOnError when true raise expetion on error else return option ':' or '?'
procedure Set_ExceptionOnError (This : in out Object; ExceptionOnError : in Boolean := True);
pragma Inline (Set_ExceptionOnError);
---
-- Get GNU Option extraction flag. GNU-Options start with "--" and have the Format --option=argument.
--
--: @param This Object itself.
--: @return True if GNU options are parsed.
function Get_ExtractGNU (This : in Object) return Boolean;
pragma Inline (Get_ExtractGNU);
---
-- Set GNU Option extraction flag. GNU-Options start with "--" and have the Format --option=argument.
--
--: @param This Object itself.
--: @param ExtractGNU When true, gnuoptions are extracted.
procedure Set_ExtractGNU (This : in out Object; ExtractGNU : in Boolean := True);
pragma Inline (Set_ExtractGNU);
private
package Unbounded renames Ada.Strings.Unbounded;
---
-- GNU Option to request Help
--
Help_GNU : constant String := "help";
---
-- Short Option to request Help
--
Help_Short : constant Character := Ada.Characters.Latin_1.Question;
---
-- An opject oriented version of getopt made for Ada - thats without the C style uglines. If you are looking for a
-- 100% compatible Version of getopt see:
--
-- Also, unlike for exapmle GNAT.Command_Line this package is reentrant. All internal states are kept inside the
-- class instanz so two tasks can parse the commandline in parallel.
--
-- last not least we support GNU style commandline options.
--
--: @field ExceptionOnError Errorhandling on or off
--: @field Pattern Set Format string. The usual mix of options and ':'
--: @field Argument Last Argument Option Found.
--: @field GNUOption Last GNU-Option Found.
--: @field Option Last Single Character Option Found.
--: @field ExtractGNU GNU Option extraction flag. GNU-Options start with
type Object is tagged record
Curopt : Natural := 2;
Optind : Positive := 1;
ExceptionOnError : Boolean := True;
Pattern : Unbounded.Unbounded_String := Unbounded.Null_Unbounded_String;
Argument : Unbounded.Unbounded_String := Unbounded.Null_Unbounded_String;
GNUOption : Unbounded.Unbounded_String := Unbounded.Null_Unbounded_String;
Option : Character := Option_Error;
ExtractGNU : Boolean := False;
end record;
end AdaCL.Command_Line.GetOpt;
---------------------------------------------------------------- {{{ ----------
--: vim: set textwidth=0 nowrap tabstop=8 shiftwidth=3 softtabstop=3 expandtab :
--: vim: set filetype=ada fileencoding=utf-8 fileformat=unix foldmethod=expr :
--: vim: set spell spelllang=en_gb
|