1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- G N A T . C O M M A N D _ L I N E --
10 -- Copyright (C) 1999-2002 Free Software Foundation, Inc. --
12 -- GNAT is free software; you can redistribute it and/or modify it under --
13 -- terms of the GNU General Public License as published by the Free Soft- --
14 -- ware Foundation; either version 2, or (at your option) any later ver- --
15 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
16 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
17 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
18 -- for more details. You should have received a copy of the GNU General --
19 -- Public License distributed with GNAT; see file COPYING. If not, write --
20 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
21 -- MA 02111-1307, USA. --
23 -- As a special exception, if other files instantiate generics from this --
24 -- unit, or you link this unit with other files to produce an executable, --
25 -- this unit does not by itself cause the resulting executable to be --
26 -- covered by the GNU General Public License. This exception does not --
27 -- however invalidate any other reasons why the executable file might be --
28 -- covered by the GNU Public License. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 with Ada
.Command_Line
;
35 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
37 package body GNAT
.Command_Line
is
39 package CL
renames Ada
.Command_Line
;
41 type Section_Number
is new Natural range 0 .. 65534;
42 for Section_Number
'Size use 16;
44 type Parameter_Type
is record
49 The_Parameter
: Parameter_Type
;
50 The_Switch
: Parameter_Type
;
51 -- This type and this variable are provided to store the current switch
54 type Is_Switch_Type
is array (1 .. CL
.Argument_Count
) of Boolean;
55 pragma Pack
(Is_Switch_Type
);
57 Is_Switch
: Is_Switch_Type
:= (others => False);
58 -- Indicates wich arguments on the command line are considered not be
59 -- switches or parameters to switches (this leaves e.g. the filenames...)
61 type Section_Type
is array (1 .. CL
.Argument_Count
+ 1) of Section_Number
;
62 pragma Pack
(Section_Type
);
63 Section
: Section_Type
:= (others => 1);
64 -- Contains the number of the section associated with the current
65 -- switch. If this number is 0, then it is a section delimiter, which
66 -- is never returns by GetOpt.
67 -- The last element of this array is set to 0 to avoid the need to test for
68 -- if we have reached the end of the command line in loops.
70 Current_Argument
: Natural := 1;
71 -- Number of the current argument parsed on the command line
73 Current_Index
: Natural := 1;
74 -- Index in the current argument of the character to be processed
76 Current_Section
: Section_Number
:= 1;
78 Expansion_It
: aliased Expansion_Iterator
;
79 -- When Get_Argument is expanding a file name, this is the iterator used
81 In_Expansion
: Boolean := False;
82 -- True if we are expanding a file
84 Switch_Character
: Character := '-';
85 -- The character at the beginning of the command line arguments,
86 -- indicating the beginning of a switch
88 Stop_At_First
: Boolean := False;
89 -- If it is True then Getopt stops at the first non-switch argument
91 procedure Set_Parameter
92 (Variable
: out Parameter_Type
;
96 pragma Inline
(Set_Parameter
);
97 -- Set the parameter that will be returned by Parameter below
99 function Goto_Next_Argument_In_Section
return Boolean;
100 -- Go to the next argument on the command line. If we are at the end
101 -- of the current section, we want to make sure there is no other
102 -- identical section on the command line (there might be multiple
103 -- instances of -largs). Returns True iff there is another argument.
105 function Get_File_Names_Case_Sensitive
return Integer;
106 pragma Import
(C
, Get_File_Names_Case_Sensitive
,
107 "__gnat_get_file_names_case_sensitive");
108 File_Names_Case_Sensitive
: constant Boolean :=
109 Get_File_Names_Case_Sensitive
/= 0;
111 procedure Canonical_Case_File_Name
(S
: in out String);
112 -- Given a file name, converts it to canonical case form. For systems
113 -- where file names are case sensitive, this procedure has no effect.
114 -- If file names are not case sensitive (i.e. for example if you have
115 -- the file "xyz.adb", you can refer to it as XYZ.adb or XyZ.AdB), then
116 -- this call converts the given string to canonical all lower case form,
117 -- so that two file names compare equal if they refer to the same file.
119 ------------------------------
120 -- Canonical_Case_File_Name --
121 ------------------------------
123 procedure Canonical_Case_File_Name
(S
: in out String) is
125 if not File_Names_Case_Sensitive
then
126 for J
in S
'Range loop
127 if S
(J
) in 'A' .. 'Z' then
128 S
(J
) := Character'Val (
129 Character'Pos (S
(J
)) +
130 Character'Pos ('a') -
131 Character'Pos ('A'));
135 end Canonical_Case_File_Name
;
141 function Expansion
(Iterator
: Expansion_Iterator
) return String is
142 use GNAT
.Directory_Operations
;
143 type Pointer
is access all Expansion_Iterator
;
145 S
: String (1 .. 1024);
147 It
: Pointer
:= Iterator
'Unrestricted_Access;
149 Current
: Depth
:= It
.Current_Depth
;
153 -- It is assumed that a directory is opened at the current level;
154 -- otherwise, GNAT.Directory_Operations.Directory_Error will be raised
155 -- at the first call to Read.
158 Read
(It
.Levels
(Current
).Dir
, S
, Last
);
160 -- If we have exhausted the directory, close it and go back one level
163 Close
(It
.Levels
(Current
).Dir
);
165 -- If we are at level 1, we are finished; return an empty string.
168 return String'(1 .. 0 => ' ');
170 -- Otherwise, continue with the directory at the previous level
172 Current := Current - 1;
173 It.Current_Depth := Current;
176 -- If this is a directory, that is neither "." or "..", attempt to
177 -- go to the next level.
180 (It.Dir_Name (1 .. It.Levels (Current).Name_Last) & S (1 .. Last))
181 and then S (1 .. Last) /= "."
182 and then S (1 .. Last) /= ".."
184 -- We can go to the next level only if we have not reached the
187 if Current < It.Maximum_Depth then
188 NL := It.Levels (Current).Name_Last;
190 -- And if relative path of this new directory is not too long
192 if NL + Last + 1 < Max_Path_Length then
193 Current := Current + 1;
194 It.Current_Depth := Current;
195 It.Dir_Name (NL + 1 .. NL + Last) := S (1 .. Last);
197 It.Dir_Name (NL) := Directory_Separator;
198 It.Levels (Current).Name_Last := NL;
199 Canonical_Case_File_Name (It.Dir_Name (1 .. NL));
201 -- Open the new directory, and read from it
203 GNAT.Directory_Operations.Open
204 (It.Levels (Current).Dir, It.Dir_Name (1 .. NL));
208 -- If not a directory, check the relative path against the pattern
213 It.Dir_Name (It.Start .. It.Levels (Current).Name_Last) &
216 Canonical_Case_File_Name (Name);
218 -- If it matches, return the relative path
220 if GNAT.Regexp.Match (Name, Iterator.Regexp) then
228 return String'(1 .. 0 => ' ');
235 function Full_Switch
return String is
237 return CL
.Argument
(The_Switch
.Arg_Num
)
238 (The_Switch
.First
.. The_Switch
.Last
);
245 function Get_Argument
(Do_Expansion
: Boolean := False) return String is
246 Total
: constant Natural := CL
.Argument_Count
;
251 S
: String := Expansion
(Expansion_It
);
254 if S
'Length /= 0 then
257 In_Expansion
:= False;
262 if Current_Argument
> Total
then
264 -- If this is the first time this function is called
266 if Current_Index
= 1 then
267 Current_Argument
:= 1;
268 while Current_Argument
<= CL
.Argument_Count
269 and then Section
(Current_Argument
) /= Current_Section
271 Current_Argument
:= Current_Argument
+ 1;
274 return String'(1 .. 0 => ' ');
277 elsif Section (Current_Argument) = 0 then
278 while Current_Argument <= CL.Argument_Count
279 and then Section (Current_Argument) /= Current_Section
281 Current_Argument := Current_Argument + 1;
287 while Current_Argument <= Total
288 and then Is_Switch (Current_Argument)
290 Current_Argument := Current_Argument + 1;
293 if Current_Argument > Total then
294 return String'(1 .. 0 => ' ');
297 if Section
(Current_Argument
) = 0 then
298 return Get_Argument
(Do_Expansion
);
301 Current_Argument
:= Current_Argument
+ 1;
303 -- Could it be a file name with wild cards to expand?
307 Arg
: String renames CL
.Argument
(Current_Argument
- 1);
308 Index
: Positive := Arg
'First;
311 while Index
<= Arg
'Last loop
314 or else Arg
(Index
) = '?'
315 or else Arg
(Index
) = '['
317 In_Expansion
:= True;
318 Start_Expansion
(Expansion_It
, Arg
);
319 return Get_Argument
(Do_Expansion
);
327 return CL
.Argument
(Current_Argument
- 1);
334 function Getopt
(Switches
: String) return Character is
338 -- If we have finished parsing the current command line item (there
339 -- might be multiple switches in a single item), then go to the next
342 if Current_Argument
> CL
.Argument_Count
343 or else (Current_Index
> CL
.Argument
(Current_Argument
)'Last
344 and then not Goto_Next_Argument_In_Section
)
349 -- If we are on a new item, test if this might be a switch
351 if Current_Index
= 1 then
352 if CL
.Argument
(Current_Argument
)(1) /= Switch_Character
then
353 if Switches
(Switches
'First) = '*' then
354 Set_Parameter
(The_Switch
,
355 Arg_Num
=> Current_Argument
,
357 Last
=> CL
.Argument
(Current_Argument
)'Last);
358 Is_Switch
(Current_Argument
) := True;
359 Dummy
:= Goto_Next_Argument_In_Section
;
363 if Stop_At_First
then
364 Current_Argument
:= Positive'Last;
367 elsif not Goto_Next_Argument_In_Section
then
371 return Getopt
(Switches
);
376 Is_Switch
(Current_Argument
) := True;
380 Arg
: String renames CL
.Argument
(Current_Argument
);
381 Index_Switches
: Natural := 0;
382 Max_Length
: Natural := 0;
383 Index
: Natural := Switches
'First;
384 Length
: Natural := 1;
388 while Index
<= Switches
'Last loop
390 -- Search the length of the parameter at this position in Switches
393 while Length
<= Switches
'Last
394 and then Switches
(Length
) /= ' '
396 Length
:= Length
+ 1;
399 if (Switches
(Length
- 1) = ':' or else
400 Switches
(Length
- 1) = '=' or else
401 Switches
(Length
- 1) = '?' or else
402 Switches
(Length
- 1) = '!')
403 and then Length
> Index
+ 1
405 Length
:= Length
- 1;
408 -- If it is the one we searched, it may be a candidate
410 if Current_Index
+ Length
- 1 - Index
<= Arg
'Last
412 Switches
(Index
.. Length
- 1) =
413 Arg
(Current_Index
.. Current_Index
+ Length
- 1 - Index
)
414 and then Length
- Index
> Max_Length
416 Index_Switches
:= Index
;
417 Max_Length
:= Length
- Index
;
420 -- Look for the next switch in Switches
422 while Index
<= Switches
'Last
423 and then Switches
(Index
) /= ' ' loop
430 End_Index
:= Current_Index
+ Max_Length
- 1;
432 -- If switch is not accepted, skip it, unless we had '*' in Switches
434 if Index_Switches
= 0 then
435 if Switches
(Switches
'First) = '*' then
436 Set_Parameter
(The_Switch
,
437 Arg_Num
=> Current_Argument
,
439 Last
=> CL
.Argument
(Current_Argument
)'Last);
440 Is_Switch
(Current_Argument
) := True;
441 Dummy
:= Goto_Next_Argument_In_Section
;
445 Set_Parameter
(The_Switch
,
446 Arg_Num
=> Current_Argument
,
447 First
=> Current_Index
,
448 Last
=> Current_Index
);
449 Current_Index
:= Current_Index
+ 1;
450 raise Invalid_Switch
;
453 Set_Parameter
(The_Switch
,
454 Arg_Num
=> Current_Argument
,
455 First
=> Current_Index
,
458 -- Case of switch needs an argument
460 if Index_Switches
+ Max_Length
<= Switches
'Last then
462 case Switches
(Index_Switches
+ Max_Length
) is
466 if End_Index
< Arg
'Last then
467 Set_Parameter
(The_Parameter
,
468 Arg_Num
=> Current_Argument
,
469 First
=> End_Index
+ 1,
471 Dummy
:= Goto_Next_Argument_In_Section
;
473 elsif Section
(Current_Argument
+ 1) /= 0 then
476 Arg_Num
=> Current_Argument
+ 1,
478 Last
=> CL
.Argument
(Current_Argument
+ 1)'Last);
479 Current_Argument
:= Current_Argument
+ 1;
480 Is_Switch
(Current_Argument
) := True;
481 Dummy
:= Goto_Next_Argument_In_Section
;
484 Current_Index
:= End_Index
+ 1;
485 raise Invalid_Parameter
;
490 -- If the switch is of the form <switch>=xxx
492 if End_Index
< Arg
'Last then
494 if Arg
(End_Index
+ 1) = '='
495 and then End_Index
+ 1 < Arg
'Last
497 Set_Parameter
(The_Parameter
,
498 Arg_Num
=> Current_Argument
,
499 First
=> End_Index
+ 2,
501 Dummy
:= Goto_Next_Argument_In_Section
;
504 Current_Index
:= End_Index
+ 1;
505 raise Invalid_Parameter
;
508 -- If the switch is of the form <switch> xxx
510 elsif Section
(Current_Argument
+ 1) /= 0 then
513 Arg_Num
=> Current_Argument
+ 1,
515 Last
=> CL
.Argument
(Current_Argument
+ 1)'Last);
516 Current_Argument
:= Current_Argument
+ 1;
517 Is_Switch
(Current_Argument
) := True;
518 Dummy
:= Goto_Next_Argument_In_Section
;
521 Current_Index
:= End_Index
+ 1;
522 raise Invalid_Parameter
;
527 if End_Index
< Arg
'Last then
528 Set_Parameter
(The_Parameter
,
529 Arg_Num
=> Current_Argument
,
530 First
=> End_Index
+ 1,
532 Dummy
:= Goto_Next_Argument_In_Section
;
535 Current_Index
:= End_Index
+ 1;
536 raise Invalid_Parameter
;
541 if End_Index
< Arg
'Last then
542 Set_Parameter
(The_Parameter
,
543 Arg_Num
=> Current_Argument
,
544 First
=> End_Index
+ 1,
548 Set_Parameter
(The_Parameter
,
549 Arg_Num
=> Current_Argument
,
553 Dummy
:= Goto_Next_Argument_In_Section
;
557 Current_Index
:= End_Index
+ 1;
561 Current_Index
:= End_Index
+ 1;
564 return Switches
(Index_Switches
);
568 -----------------------------------
569 -- Goto_Next_Argument_In_Section --
570 -----------------------------------
572 function Goto_Next_Argument_In_Section
return Boolean is
575 Current_Argument
:= Current_Argument
+ 1;
577 if Section
(Current_Argument
) = 0 then
579 if Current_Argument
> CL
.Argument_Count
then
583 Current_Argument
:= Current_Argument
+ 1;
584 exit when Section
(Current_Argument
) = Current_Section
;
588 end Goto_Next_Argument_In_Section
;
594 procedure Goto_Section
(Name
: String := "") is
595 Index
: Integer := 1;
598 In_Expansion
:= False;
601 Current_Argument
:= 1;
603 Current_Section
:= 1;
607 while Index
<= CL
.Argument_Count
loop
609 if Section
(Index
) = 0
610 and then CL
.Argument
(Index
) = Switch_Character
& Name
612 Current_Argument
:= Index
+ 1;
615 if Current_Argument
<= CL
.Argument_Count
then
616 Current_Section
:= Section
(Current_Argument
);
624 Current_Argument
:= Positive'Last;
625 Current_Index
:= 2; -- so that Get_Argument returns nothing
628 ----------------------------
629 -- Initialize_Option_Scan --
630 ----------------------------
632 procedure Initialize_Option_Scan
633 (Switch_Char
: Character := '-';
634 Stop_At_First_Non_Switch
: Boolean := False;
635 Section_Delimiters
: String := "")
637 Section_Num
: Section_Number
:= 1;
638 Section_Index
: Integer := Section_Delimiters
'First;
640 Delimiter_Found
: Boolean;
643 Current_Argument
:= 0;
645 In_Expansion
:= False;
646 Switch_Character
:= Switch_Char
;
647 Stop_At_First
:= Stop_At_First_Non_Switch
;
649 -- If we are using sections, we have to preprocess the command line
650 -- to delimit them. A section can be repeated, so we just give each
651 -- item on the command line a section number
653 while Section_Index
<= Section_Delimiters
'Last loop
655 Last
:= Section_Index
;
656 while Last
<= Section_Delimiters
'Last
657 and then Section_Delimiters
(Last
) /= ' '
662 Delimiter_Found
:= False;
663 Section_Num
:= Section_Num
+ 1;
665 for Index
in 1 .. CL
.Argument_Count
loop
666 if CL
.Argument
(Index
)(1) = Switch_Character
668 CL
.Argument
(Index
) = Switch_Character
&
670 (Section_Index
.. Last
- 1)
672 Section
(Index
) := 0;
673 Delimiter_Found
:= True;
675 elsif Section
(Index
) = 0 then
676 Delimiter_Found
:= False;
678 elsif Delimiter_Found
then
679 Section
(Index
) := Section_Num
;
683 Section_Index
:= Last
+ 1;
684 while Section_Index
<= Section_Delimiters
'Last
685 and then Section_Delimiters
(Section_Index
) = ' '
687 Section_Index
:= Section_Index
+ 1;
691 Delimiter_Found
:= Goto_Next_Argument_In_Section
;
692 end Initialize_Option_Scan
;
698 function Parameter
return String is
700 if The_Parameter
.First
> The_Parameter
.Last
then
701 return String'(1 .. 0 => ' ');
703 return CL.Argument (The_Parameter.Arg_Num)
704 (The_Parameter.First .. The_Parameter.Last);
712 procedure Set_Parameter
713 (Variable : out Parameter_Type;
719 Variable.Arg_Num := Arg_Num;
720 Variable.First := First;
721 Variable.Last := Last;
724 ---------------------
725 -- Start_Expansion --
726 ---------------------
728 procedure Start_Expansion
729 (Iterator : out Expansion_Iterator;
731 Directory : String := "";
732 Basic_Regexp : Boolean := True)
734 Directory_Separator : Character;
735 pragma Import (C, Directory_Separator, "__gnat_dir_separator");
736 First : Positive := Pattern'First;
738 Pat : String := Pattern;
741 Canonical_Case_File_Name (Pat);
742 Iterator.Current_Depth := 1;
744 -- If Directory is unspecified, use the current directory ("./" or ".\")
746 if Directory = "" then
747 Iterator.Dir_Name (1 .. 2) := "." & Directory_Separator;
751 Iterator.Dir_Name (1 .. Directory'Length) := Directory;
752 Iterator.Start := Directory'Length + 1;
753 Canonical_Case_File_Name (Iterator.Dir_Name (1 .. Directory'Length));
755 -- Make sure that the last character is a directory separator
757 if Directory (Directory'Last) /= Directory_Separator then
758 Iterator.Dir_Name (Iterator.Start) := Directory_Separator;
759 Iterator.Start := Iterator.Start + 1;
763 Iterator.Levels (1).Name_Last := Iterator.Start - 1;
765 -- Open the initial Directory, at depth 1
767 GNAT.Directory_Operations.Open
768 (Iterator.Levels (1).Dir, Iterator.Dir_Name (1 .. Iterator.Start - 1));
770 -- If in the current directory and the pattern starts with "./",
771 -- drop the "./" from the pattern.
773 if Directory = "" and then Pat'Length > 2
774 and then Pat (Pat'First .. Pat'First + 1) = "./"
776 First := Pat'First + 2;
780 GNAT.Regexp.Compile (Pat (First .. Pat'Last), Basic_Regexp, True);
782 Iterator.Maximum_Depth := 1;
784 -- Maximum_Depth is equal to 1 plus the number of directory separators
787 for Index in First .. Pat'Last loop
788 if Pat (Index) = Directory_Separator then
789 Iterator.Maximum_Depth := Iterator.Maximum_Depth + 1;
790 exit when Iterator.Maximum_Depth = Max_Depth;
797 Section (CL.Argument_Count + 1) := 0;
798 end GNAT.Command_Line;