1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- A D A . C O M M A N D _ L I N E --
10 -- Copyright (C) 1992-2002 Free Software Foundation, Inc. --
12 -- This specification is derived from the Ada Reference Manual for use with --
13 -- GNAT. The copyright notice above, and the license provisions that follow --
14 -- apply solely to the contents of the part following the private keyword. --
16 -- GNAT is free software; you can redistribute it and/or modify it under --
17 -- terms of the GNU General Public License as published by the Free Soft- --
18 -- ware Foundation; either version 2, or (at your option) any later ver- --
19 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
20 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
21 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
22 -- for more details. You should have received a copy of the GNU General --
23 -- Public License distributed with GNAT; see file COPYING. If not, write --
24 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
25 -- MA 02111-1307, USA. --
27 -- As a special exception, if other files instantiate generics from this --
28 -- unit, or you link this unit with other files to produce an executable, --
29 -- this unit does not by itself cause the resulting executable to be --
30 -- covered by the GNU General Public License. This exception does not --
31 -- however invalidate any other reasons why the executable file might be --
32 -- covered by the GNU Public License. --
34 -- GNAT was originally developed by the GNAT team at New York University. --
35 -- Extensive contributions were provided by Ada Core Technologies Inc. --
37 ------------------------------------------------------------------------------
39 package Ada
.Command_Line
is
40 pragma Preelaborate
(Command_Line
);
42 function Argument_Count
return Natural;
43 -- If the external execution environment supports passing arguments to a
44 -- program, then Argument_Count returns the number of arguments passed to
45 -- the program invoking the function. Otherwise it return 0.
47 -- In GNAT: Corresponds to (argc - 1) in C.
49 function Argument
(Number
: Positive) return String;
50 -- If the external execution environment supports passing arguments to
51 -- a program, then Argument returns an implementation-defined value
52 -- corresponding to the argument at relative position Number. If Number
53 -- is outside the range 1 .. Argument_Count, then Constraint_Error is
56 -- in GNAT: Corresponds to argv [n] (for n > 0) in C.
58 function Command_Name
return String;
59 -- If the external execution environment supports passing arguments to
60 -- a program, then Command_Name returns an implementation-defined value
61 -- corresponding to the name of the command invoking the program.
62 -- Otherwise Command_Name returns the null string.
64 -- in GNAT: Corresponds to argv [0] in C.
66 type Exit_Status
is new Integer;
68 Success
: constant Exit_Status
;
69 Failure
: constant Exit_Status
;
71 procedure Set_Exit_Status
(Code
: Exit_Status
);
73 ------------------------------------
74 -- Note on Interface Requirements --
75 ------------------------------------
77 -- If the main program is in Ada, this package works as specified without
78 -- any other work than the normal steps of WITH'ing the package and then
79 -- calling the desired routines.
81 -- If the main program is not in Ada, then the information must be made
82 -- available for this package to work correctly. In particular, it is
83 -- required that the global variable "gnat_argc" contain the number of
84 -- arguments, and that the global variable "gnat_argv" points to an
85 -- array of null-terminated strings, the first entry being the command
86 -- name, and the remaining entries being the command arguments.
88 -- These correspond to the normal argc/argv variables passed to a C
89 -- main program, and the following is an example of a complete C main
90 -- program that stores the required information:
92 -- main(int argc, char **argv, char **envp)
94 -- extern int gnat_argc;
95 -- extern char **gnat_argv;
96 -- extern char **gnat_envp;
106 -- The assignment statements ensure that the necessary information is
107 -- available for finding the command name and command line arguments.
110 Success
: constant Exit_Status
:= 0;
111 Failure
: constant Exit_Status
:= 1;
113 -- The following locations support the operation of the package
114 -- Ada.Command_Line.Remove, whih provides facilities for logically
115 -- removing arguments from the command line. If one of the remove
116 -- procedures is called in this unit, then Remove_Args/Remove_Count
117 -- are set to indicate which arguments are removed. If no such calls
118 -- have been made, then Remove_Args is null.
120 Remove_Count
: Natural;
121 -- Number of arguments reflecting removals. Not defined unless
122 -- Remove_Args is non-null.
124 type Arg_Nums
is array (Positive range <>) of Positive;
125 type Arg_Nums_Ptr
is access Arg_Nums
;
126 -- An array that maps logical argument numbers (reflecting removal)
127 -- to physical argument numbers (e.g. if the first argument has been
128 -- removed, but not the second, then Arg_Nums (1) will be set to 2.
130 Remove_Args
: Arg_Nums_Ptr
:= null;
131 -- Left set to null if no remove calls have been made, otherwise set
132 -- to point to an appropriate mapping array. Only the first Remove_Count
133 -- elements are relevant.
135 pragma Import
(C
, Set_Exit_Status
, "__gnat_set_exit_status");
137 end Ada
.Command_Line
;