1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2024, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Ada
.Characters
.Conversions
; use Ada
.Characters
.Conversions
;
27 with Ada
.Command_Line
; use Ada
.Command_Line
;
28 with Ada
.Directories
; use Ada
.Directories
;
29 with Ada
.Streams
.Stream_IO
; use Ada
.Streams
;
30 with Ada
.Text_IO
; use Ada
.Text_IO
;
31 with System
.CRTL
; use System
; use System
.CRTL
;
33 with GNAT
.Byte_Order_Mark
; use GNAT
.Byte_Order_Mark
;
34 with GNAT
.Command_Line
; use GNAT
.Command_Line
;
35 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
36 with GNAT
.Heap_Sort_G
;
39 with Switch
; use Switch
;
44 Config_File_Name
: constant String_Access
:= new String'("gnat.adc");
45 -- The name of the file holding the GNAT configuration pragmas
47 Gcc : String_Access := new String'("gcc");
48 -- May be modified by switch --GCC=
50 Gcc_Set
: Boolean := False;
51 -- True if a switch --GCC= is used
53 Gnat_Cmd
: String_Access
;
54 -- Command to execute the GNAT compiler
56 Gnat_Args
: Argument_List_Access
:=
61 new String'("-gnats"),
62 new String'("-gnatu"));
63 -- Arguments used in Gnat_Cmd call
65 EOF
: constant Character := Character'Val (26);
66 -- Special character to signal end of file. Not required in input files,
67 -- but properly treated if present. Not generated in output files except
68 -- as a result of copying input file.
70 BOM_Length
: Natural := 0;
71 -- Reset to non-zero value if BOM detected at start of file
77 subtype File_Num
is Natural;
78 subtype File_Offset
is Natural;
80 type File_Entry
is record
82 -- Name of chop file or directory
84 SR_Name
: String_Access
;
85 -- Null unless the chop file starts with a source reference pragma
86 -- in which case this field points to the file name from this pragma.
89 package File
is new GNAT
.Table
90 (Table_Component_Type
=> File_Entry
,
91 Table_Index_Type
=> File_Num
,
94 Table_Increment
=> 100);
96 Directory
: String_Access
;
97 -- Record name of directory, or a null string if no directory given
99 Compilation_Mode
: Boolean := False;
100 Overwrite_Files
: Boolean := False;
101 Preserve_Mode
: Boolean := False;
102 Quiet_Mode
: Boolean := False;
103 Source_References
: Boolean := False;
104 Verbose_Mode
: Boolean := False;
105 Exit_On_Error
: Boolean := False;
108 Write_gnat_adc
: Boolean := False;
109 -- Gets set true if we append to gnat.adc or create a new gnat.adc.
110 -- Used to inhibit complaint about no units generated.
116 type Line_Num
is new Natural;
117 -- Line number (for source reference pragmas)
119 type Unit_Count_Type
is new Integer;
120 subtype Unit_Num
is Unit_Count_Type
range 1 .. Unit_Count_Type
'Last;
121 -- Used to refer to unit number in unit table
123 type SUnit_Num
is new Integer;
124 -- Used to refer to entry in sorted units table. Note that entry
125 -- zero is only for use by Heapsort, and is not otherwise referenced.
127 type Unit_Kind
is (Unit_Spec
, Unit_Body
, Config_Pragmas
);
129 -- Structure to contain all necessary information for one unit.
130 -- Entries are also temporarily used to record config pragma sequences.
132 type Unit_Info
is record
133 File_Name
: String_Access
;
134 -- File name from GNAT output line
136 Chop_File
: File_Num
;
137 -- File number in chop file sequence
139 Start_Line
: Line_Num
;
140 -- Line number from GNAT output line
142 Offset
: File_Offset
;
143 -- Offset name from GNAT output line
145 SR_Present
: Boolean;
146 -- Set True if SR parameter present
148 Length
: File_Offset
;
149 -- A length of 0 means that the Unit is the last one in the file
152 -- Indicates kind of unit
154 Sorted_Index
: SUnit_Num
;
155 -- Index of unit in sorted unit list
157 Bufferg
: String_Access
;
158 -- Pointer to buffer containing configuration pragmas to be prepended.
159 -- Null if no pragmas to be prepended.
162 -- The following table stores the unit offset information
164 package Unit
is new GNAT
.Table
165 (Table_Component_Type
=> Unit_Info
,
166 Table_Index_Type
=> Unit_Count_Type
,
167 Table_Low_Bound
=> 1,
168 Table_Initial
=> 500,
169 Table_Increment
=> 100);
171 -- The following table is used as a sorted index to the Unit.Table.
172 -- The entries in Unit.Table are not moved, instead we just shuffle
173 -- the entries in Sorted_Units. Note that the zeroeth entry in this
174 -- table is used by GNAT.Heap_Sort_G.
176 package Sorted_Units
is new GNAT
.Table
177 (Table_Component_Type
=> Unit_Num
,
178 Table_Index_Type
=> SUnit_Num
,
179 Table_Low_Bound
=> 0,
180 Table_Initial
=> 500,
181 Table_Increment
=> 100);
183 function Is_Duplicated
(U
: SUnit_Num
) return Boolean;
184 -- Returns true if U is duplicated by a later unit.
185 -- Note that this function returns false for the last entry.
187 procedure Sort_Units
;
188 -- Sort units and set up sorted unit table
190 ----------------------
191 -- File_Descriptors --
192 ----------------------
194 function dup
(handle
: File_Descriptor
) return File_Descriptor
;
195 function dup2
(from
, to
: File_Descriptor
) return File_Descriptor
;
197 ---------------------
198 -- Local variables --
199 ---------------------
201 Warning_Count
: Natural := 0;
202 -- Count of warnings issued so far
204 -----------------------
205 -- Local subprograms --
206 -----------------------
208 procedure Error_Msg
(Message
: String; Warning
: Boolean := False);
209 -- Produce an error message on standard error output
211 function Files_Exist
return Boolean;
212 -- Check Unit.Table for possible file names that already exist
213 -- in the file system. Returns true if files exist, False otherwise
215 function Get_Maximum_File_Name_Length
return Integer;
216 pragma Import
(C
, Get_Maximum_File_Name_Length
,
217 "__gnat_get_maximum_file_name_length");
218 -- Function to get maximum file name length for system
220 Maximum_File_Name_Length
: constant Integer := Get_Maximum_File_Name_Length
;
221 Maximum_File_Name_Length_String
: constant String :=
223 (Maximum_File_Name_Length
);
225 function Locate_Executable
226 (Program_Name
: String;
227 Look_For_Prefix
: Boolean := True) return String_Access
;
228 -- Locate executable for given program name. This takes into account
229 -- the target-prefix of the current command, if Look_For_Prefix is True.
231 subtype EOL_Length
is Natural range 0 .. 2;
232 -- Possible lengths of end of line sequence
234 type EOL_String
(Len
: EOL_Length
:= 0) is record
235 Str
: String (1 .. Len
);
239 (Source
: not null access String;
240 Start
: Positive) return EOL_String
;
241 -- Return the line terminator used in the passed string
244 (Source
: not null access String;
245 Ptr
: in out Positive);
246 -- On return Source (Ptr) is the first character of the next line
247 -- or EOF. Source.all must be terminated by EOF.
249 function Parse_File
(Num
: File_Num
) return Boolean;
250 -- Calls the GNAT compiler to parse the given source file and parses the
251 -- output using Parse_Offset_Info. Returns True if parse operation
252 -- completes, False if some system error (e.g. failure to read the
253 -- offset information) occurs.
255 procedure Parse_Offset_Info
256 (Chop_File
: File_Num
;
257 Source
: not null access String);
258 -- Parses the output of the compiler indicating the offsets and names of
259 -- the compilation units in Chop_File.
261 procedure Parse_Token
262 (Source
: not null access String;
263 Ptr
: in out Positive;
264 Token_Ptr
: out Positive);
265 -- Skips any separators and stores the start of the token in Token_Ptr.
266 -- Then stores the position of the next separator in Ptr. On return
267 -- Source (Token_Ptr .. Ptr - 1) is the token.
270 (FD
: File_Descriptor
;
271 Contents
: out String_Access
;
272 Success
: out Boolean);
273 -- Reads file associated with FS into the newly allocated string Contents.
274 -- Success is true iff the number of bytes read is equal to the file size.
276 function Report_Duplicate_Units
return Boolean;
277 -- Output messages about duplicate units in the input files in Unit.Table
278 -- Returns True if any duplicates found, False if no duplicates found.
280 function Scan_Arguments
return Boolean;
281 -- Scan command line options and set global variables accordingly.
282 -- Also scan out file and directory arguments. Returns True if scan
283 -- was successful, and False if the scan fails for any reason.
286 -- Output message on standard output describing syntax of gnatchop command
288 procedure Warning_Msg
(Message
: String);
289 -- Output a warning message on standard error and update warning count
291 function Write_Chopped_Files
(Input
: File_Num
) return Boolean;
292 -- Write all units that result from chopping the Input file
294 procedure Write_Config_File
(Input
: File_Num
; U
: Unit_Num
);
295 -- Call to write configuration pragmas (append them to gnat.adc). Input is
296 -- the file number for the chop file and U identifies the unit entry for
297 -- the configuration pragmas.
299 function Get_Config_Pragmas
301 U
: Unit_Num
) return String_Access
;
302 -- Call to read configuration pragmas from given unit entry, and return a
303 -- buffer containing the pragmas to be appended to following units. Input
304 -- is the file number for the chop file and U identifies the unit entry for
305 -- the configuration pragmas.
307 procedure Write_Source_Reference_Pragma
310 File
: Stream_IO
.File_Type
;
312 Success
: in out Boolean);
313 -- If Success is True on entry, writes a source reference pragma using
314 -- the chop file from Info, and the given line number. On return Success
315 -- indicates whether the write succeeded. If Success is False on entry,
316 -- or if the global flag Source_References is False, then the call to
317 -- Write_Source_Reference_Pragma has no effect. EOL indicates the end
318 -- of line sequence to be written at the end of the pragma.
321 (Source
: not null access String;
325 Success
: out Boolean);
326 -- Write one compilation unit of the source to file. Source is the pointer
327 -- to the input string, Num is the unit number, TS_Time is the timestamp,
328 -- Write_BOM is set True to write a UTF-8 BOM at the start of the file.
329 -- Success is set True unless the write attempt fails.
335 function dup
(handle
: File_Descriptor
) return File_Descriptor
is
337 return File_Descriptor
(System
.CRTL
.dup
(int
(handle
)));
344 function dup2
(from
, to
: File_Descriptor
) return File_Descriptor
is
346 return File_Descriptor
(System
.CRTL
.dup2
(int
(from
), int
(to
)));
353 procedure Error_Msg
(Message
: String; Warning
: Boolean := False) is
355 Put_Line
(Standard_Error
, Message
);
358 Set_Exit_Status
(Failure
);
360 if Exit_On_Error
then
361 raise Types
.Terminate_Program
;
370 function Files_Exist
return Boolean is
371 Exists
: Boolean := False;
374 for SNum
in 1 .. SUnit_Num
(Unit
.Last
) loop
376 -- Only check and report for the last instance of duplicated files
378 if not Is_Duplicated
(SNum
) then
380 Info
: constant Unit_Info
:=
381 Unit
.Table
(Sorted_Units
.Table
(SNum
));
384 if Is_Writable_File
(Info
.File_Name
.all) then
385 Error_Msg
(Info
.File_Name
.all
386 & " already exists, use -w to overwrite");
396 ------------------------
397 -- Get_Config_Pragmas --
398 ------------------------
400 function Get_Config_Pragmas
402 U
: Unit_Num
) return String_Access
404 Info
: Unit_Info
renames Unit
.Table
(U
);
405 FD
: File_Descriptor
;
406 Name
: aliased constant String :=
407 File
.Table
(Input
).Name
.all & ASCII
.NUL
;
408 Length
: File_Offset
;
409 Buffer
: String_Access
;
410 Result
: String_Access
;
413 pragma Warnings
(Off
, Success
);
416 FD
:= Open_Read
(Name
'Address, Binary
);
418 if FD
= Invalid_FD
then
419 Error_Msg
("cannot open " & File
.Table
(Input
).Name
.all);
423 Read_File
(FD
, Buffer
, Success
);
425 -- A length of 0 indicates that the rest of the file belongs to
426 -- this unit. The actual length must be calculated now. Take into
427 -- account that the last character (EOF) must not be written.
429 if Info
.Length
= 0 then
430 Length
:= Buffer
'Last - (Buffer
'First + Info
.Offset
);
432 Length
:= Info
.Length
;
435 Result
:= new String'(Buffer (1 .. Length));
438 end Get_Config_Pragmas;
445 (Source : not null access String;
446 Start : Positive) return EOL_String
448 Ptr : Positive := Start;
453 -- Skip to end of line
455 while Source (Ptr) /= ASCII.CR and then
456 Source (Ptr) /= ASCII.LF and then
464 if Source (Ptr) /= EOF then
476 if Source (Ptr) = ASCII.CR and then Source (Ptr + 1) = ASCII.LF then
480 return (Len => Last + 1 - First, Str => Source (First .. Last));
487 function Is_Duplicated (U : SUnit_Num) return Boolean is
489 return U < SUnit_Num (Unit.Last)
491 Unit.Table (Sorted_Units.Table (U)).File_Name.all =
492 Unit.Table (Sorted_Units.Table (U + 1)).File_Name.all;
495 -----------------------
496 -- Locate_Executable --
497 -----------------------
499 function Locate_Executable
500 (Program_Name : String;
501 Look_For_Prefix : Boolean := True) return String_Access
503 Gnatchop_Str : constant String := "gnatchop";
504 Current_Command : constant String := Normalize_Pathname (Command_Name);
505 End_Of_Prefix : Natural;
506 Start_Of_Prefix : Positive;
507 Start_Of_Suffix : Positive;
508 Result : String_Access;
511 Start_Of_Prefix := Current_Command'First;
512 Start_Of_Suffix := Current_Command'Last + 1;
513 End_Of_Prefix := Start_Of_Prefix - 1;
515 if Look_For_Prefix then
517 -- Find Start_Of_Prefix
519 for J in reverse Current_Command'Range loop
520 if Current_Command (J) = '/' or else
521 Current_Command (J) = Directory_Separator or else
522 Current_Command (J) = ':'
524 Start_Of_Prefix := J + 1;
529 -- Find End_Of_Prefix
531 for J in Start_Of_Prefix ..
532 Current_Command'Last - Gnatchop_Str'Length + 1
534 if Current_Command (J .. J + Gnatchop_Str'Length - 1) =
537 End_Of_Prefix := J - 1;
543 if End_Of_Prefix > Current_Command'First then
544 Start_Of_Suffix := End_Of_Prefix + Gnatchop_Str'Length + 1;
548 Command : constant String :=
549 Current_Command (Start_Of_Prefix .. End_Of_Prefix)
551 & Current_Command (Start_Of_Suffix ..
552 Current_Command'Last);
554 Result := Locate_Exec_On_Path (Command);
556 if Result = null then
558 (Command & ": installation problem, executable not found");
563 end Locate_Executable;
570 (Source : not null access String;
571 Ptr : in out Positive) is
573 -- Skip to end of line
575 while Source (Ptr) /= ASCII.CR and then Source (Ptr) /= ASCII.LF
576 and then Source (Ptr) /= EOF
581 if Source (Ptr) /= EOF then
582 Ptr := Ptr + 1; -- skip CR or LF
585 -- Skip past CR/LF or LF/CR combination
587 if (Source (Ptr) = ASCII.CR or else Source (Ptr) = ASCII.LF)
588 and then Source (Ptr) /= Source (Ptr - 1)
598 function Parse_File (Num : File_Num) return Boolean is
599 Chop_Name : constant String_Access := File.Table (Num).Name;
600 Save_Stdout : constant File_Descriptor := dup (Standout);
601 Offset_Name : Temp_File_Name;
602 Offset_FD : File_Descriptor := Invalid_FD;
603 Buffer : String_Access;
608 -- Display copy of GNAT command if verbose mode
613 for J in 1 .. Gnat_Args'Length loop
615 Put (Gnat_Args (J).all);
619 Put_Line (Chop_Name.all);
622 -- Create temporary file
624 Create_Temp_File (Offset_FD, Offset_Name);
626 if Offset_FD = Invalid_FD then
627 Error_Msg ("gnatchop: cannot create temporary file");
632 -- Redirect Stdout to this temporary file in the Unix way
634 if dup2 (Offset_FD, Standout) = Invalid_FD then
635 Error_Msg ("gnatchop: cannot redirect stdout to temporary file");
641 -- Call Gnat on the source filename argument with special options
642 -- to generate offset information. If this special compilation completes
643 -- successfully then we can do the actual gnatchop operation.
645 Spawn (Gnat_Cmd.all, Gnat_Args.all & Chop_Name, Success);
648 Error_Msg (Chop_Name.all & ": parse errors detected");
649 Error_Msg (Chop_Name.all & ": chop may not be successful");
654 if dup2 (Save_Stdout, Standout) = Invalid_FD then
655 Error_Msg ("gnatchop: cannot restore stdout");
658 -- Reopen the file to start reading from the beginning
662 Offset_FD := Open_Read (Offset_Name'Address, Binary);
664 if Offset_FD = Invalid_FD then
665 Error_Msg ("gnatchop: cannot access offset info");
669 Read_File (Offset_FD, Buffer, Success);
672 Error_Msg ("gnatchop: error reading offset info");
676 Parse_Offset_Info (Num, Buffer);
679 -- Close and delete temporary file
682 Delete_File (Offset_Name'Address, Success);
687 when Failure | Types.Terminate_Program =>
688 if Offset_FD /= Invalid_FD then
692 Delete_File (Offset_Name'Address, Success);
696 -----------------------
697 -- Parse_Offset_Info --
698 -----------------------
700 procedure Parse_Offset_Info
701 (Chop_File : File_Num;
702 Source : not null access String)
704 First_Unit : constant Unit_Num := Unit.Last + 1;
705 Bufferg : String_Access := null;
706 Parse_Ptr : File_Offset := Source'First;
707 Token_Ptr : File_Offset;
710 function Match (Literal : String) return Boolean;
711 -- Checks if given string appears at the current Token_Ptr location
712 -- and if so, bumps Parse_Ptr past the token and returns True. If
713 -- the string is not present, sets Parse_Ptr to Token_Ptr and
720 function Match (Literal : String) return Boolean is
722 Parse_Token (Source, Parse_Ptr, Token_Ptr);
724 if Source'Last + 1 - Token_Ptr < Literal'Length
726 Source (Token_Ptr .. Token_Ptr + Literal'Length - 1) /= Literal
728 Parse_Ptr := Token_Ptr;
732 Parse_Ptr := Token_Ptr + Literal'Length;
736 -- Start of processing for Parse_Offset_Info
740 -- Set default values, should get changed for all
741 -- units/pragmas except for the last
743 Info.Chop_File := Chop_File;
746 -- Parse the current line of offset information into Info
747 -- and exit the loop if there are any errors or on EOF.
749 -- First case, parse a line in the following format:
751 -- Unit x (spec) line 7, file offset 142, [SR, ]file name x.ads
753 -- Note that the unit name can be an operator name in quotes.
754 -- This is of course illegal, but both GNAT and gnatchop handle
755 -- the case so that this error does not interfere with chopping.
757 -- The SR ir present indicates that a source reference pragma
758 -- was processed as part of this unit (and that therefore no
759 -- Source_Reference pragma should be generated.
761 if Match ("Unit") then
762 Parse_Token (Source, Parse_Ptr, Token_Ptr);
764 if Match ("(body)") then
765 Info.Kind := Unit_Body;
766 elsif Match ("(spec)") then
767 Info.Kind := Unit_Spec;
772 exit when not Match ("line");
773 Parse_Token (Source, Parse_Ptr, Token_Ptr);
774 Info.Start_Line := Line_Num'Value
775 (Source (Token_Ptr .. Parse_Ptr - 1));
777 exit when not Match ("file offset");
778 Parse_Token (Source, Parse_Ptr, Token_Ptr);
779 Info.Offset := File_Offset'Value
780 (Source (Token_Ptr .. Parse_Ptr - 1));
782 Info.SR_Present := Match ("SR, ");
784 exit when not Match ("file name");
785 Parse_Token (Source, Parse_Ptr, Token_Ptr);
786 Info.File_Name := new String'
787 (Directory
.all & Source
(Token_Ptr
.. Parse_Ptr
- 1));
788 Parse_EOL
(Source
, Parse_Ptr
);
790 -- Second case, parse a line of the following form
792 -- Configuration pragmas at line 10, file offset 223
794 elsif Match
("Configuration pragmas at") then
795 Info
.Kind
:= Config_Pragmas
;
796 Info
.File_Name
:= Config_File_Name
;
798 exit when not Match
("line");
799 Parse_Token
(Source
, Parse_Ptr
, Token_Ptr
);
800 Info
.Start_Line
:= Line_Num
'Value
801 (Source
(Token_Ptr
.. Parse_Ptr
- 1));
803 exit when not Match
("file offset");
804 Parse_Token
(Source
, Parse_Ptr
, Token_Ptr
);
805 Info
.Offset
:= File_Offset
'Value
806 (Source
(Token_Ptr
.. Parse_Ptr
- 1));
808 Parse_EOL
(Source
, Parse_Ptr
);
810 -- Third case, parse a line of the following form
812 -- Source_Reference pragma for file "filename"
814 -- This appears at the start of the file only, and indicates
815 -- the name to be used on any generated Source_Reference pragmas.
817 elsif Match
("Source_Reference pragma for file ") then
818 Parse_Token
(Source
, Parse_Ptr
, Token_Ptr
);
819 File
.Table
(Chop_File
).SR_Name
:=
820 new String'(Source (Token_Ptr + 1 .. Parse_Ptr - 2));
821 Parse_EOL (Source, Parse_Ptr);
824 -- Unrecognized keyword or end of file
830 -- Store the data in the Info record in the Unit.Table
833 Unit.Table (Unit.Last) := Info;
835 -- If this is not the first unit from the file, calculate
836 -- the length of the previous unit as difference of the offsets
838 if Unit.Last > First_Unit then
839 Unit.Table (Unit.Last - 1).Length :=
840 Info.Offset - Unit.Table (Unit.Last - 1).Offset;
843 -- If not in compilation mode combine current unit with any
844 -- preceding configuration pragmas.
846 if not Compilation_Mode
847 and then Unit.Last > First_Unit
848 and then Unit.Table (Unit.Last - 1).Kind = Config_Pragmas
850 Info.Start_Line := Unit.Table (Unit.Last - 1).Start_Line;
851 Info.Offset := Unit.Table (Unit.Last - 1).Offset;
853 -- Delete the configuration pragma entry
855 Unit.Table (Unit.Last - 1) := Info;
859 -- If in compilation mode, and previous entry is the initial
860 -- entry for the file and is for configuration pragmas, then
861 -- they are to be appended to every unit in the file.
864 and then Unit.Last = First_Unit + 1
865 and then Unit.Table (First_Unit).Kind = Config_Pragmas
869 (Unit.Table (Unit.Last - 1).Chop_File, First_Unit);
870 Unit.Table (Unit.Last - 1) := Info;
874 Unit.Table (Unit.Last).Bufferg := Bufferg;
876 -- If in compilation mode, and this is not the first item,
877 -- combine configuration pragmas with previous unit, which
878 -- will cause an error message to be generated when the unit
882 and then Unit.Last > First_Unit
883 and then Unit.Table (Unit.Last).Kind = Config_Pragmas
893 -- Find out if the loop was exited prematurely because of
894 -- an error or if the EOF marker was found.
896 if Source (Parse_Ptr) /= EOF then
898 (File.Table (Chop_File).Name.all & ": error parsing offset info");
902 -- Handle case of a chop file consisting only of config pragmas
904 if Unit.Last = First_Unit
905 and then Unit.Table (Unit.Last).Kind = Config_Pragmas
907 -- In compilation mode, we append such a file to gnat.adc
909 if Compilation_Mode then
910 Write_Config_File (Unit.Table (Unit.Last).Chop_File, First_Unit);
913 -- In default (non-compilation) mode, this is invalid
917 (File.Table (Chop_File).Name.all &
918 ": no units found (only pragmas)");
923 -- Handle case of a chop file ending with config pragmas. This can
924 -- happen only in default non-compilation mode, since in compilation
925 -- mode such configuration pragmas are part of the preceding unit.
926 -- We simply concatenate such pragmas to the previous file which
927 -- will cause a compilation error, which is appropriate.
929 if Unit.Last > First_Unit
930 and then Unit.Table (Unit.Last).Kind = Config_Pragmas
934 end Parse_Offset_Info;
940 procedure Parse_Token
941 (Source : not null access String;
942 Ptr : in out Positive;
943 Token_Ptr : out Positive)
945 In_Quotes : Boolean := False;
950 while Source (Ptr) = ' ' or else Source (Ptr) = ',' loop
959 or else not (Source (Ptr) = ' ' or else Source (Ptr) = ','))
960 and then Source (Ptr) >= ' '
962 if Source (Ptr) = '"' then
963 In_Quotes := not In_Quotes;
975 (FD : File_Descriptor;
976 Contents : out String_Access;
977 Success : out Boolean)
979 Length : constant File_Offset := File_Offset (File_Length (FD));
980 -- Include room for EOF char
981 Buffer : String_Access := new String (1 .. Length + 1);
984 Read_Ptr : File_Offset := 1;
988 This_Read := Read (FD,
989 A => Buffer (Read_Ptr)'Address,
990 N => Length + 1 - Read_Ptr);
991 Read_Ptr := Read_Ptr + Integer'Max (This_Read, 0);
992 exit when This_Read <= 0;
995 Buffer (Read_Ptr) := EOF;
997 -- The following test can fail if there was an I/O error, in which case
998 -- Success will be set to False.
1000 if Read_Ptr = Length then
1004 Contents := new String (1 .. Read_Ptr);
1005 Contents.all := Buffer (1 .. Read_Ptr);
1009 Success := Read_Ptr = Length + 1;
1012 ----------------------------
1013 -- Report_Duplicate_Units --
1014 ----------------------------
1016 function Report_Duplicate_Units return Boolean is
1020 Duplicates : Boolean := False;
1024 while US < SUnit_Num (Unit.Last) loop
1025 U := Sorted_Units.Table (US);
1027 if Is_Duplicated (US) then
1030 -- Move to last two versions of duplicated file to make it clearer
1031 -- to understand which file is retained in case of overwriting.
1033 while US + 1 < SUnit_Num (Unit.Last) loop
1034 exit when not Is_Duplicated (US + 1);
1038 U := Sorted_Units.Table (US);
1040 if Overwrite_Files then
1041 Warning_Msg (Unit.Table (U).File_Name.all
1042 & " is duplicated
(all but last will be skipped
)");
1044 elsif Unit.Table (U).Chop_File =
1045 Unit.Table (Sorted_Units.Table (US + 1)).Chop_File
1047 Error_Msg (Unit.Table (U).File_Name.all
1048 & " is duplicated
in "
1049 & File.Table (Unit.Table (U).Chop_File).Name.all);
1052 Error_Msg (Unit.Table (U).File_Name.all
1054 & File.Table (Unit.Table (U).Chop_File).Name.all
1055 & " is duplicated
in "
1058 (Sorted_Units.Table (US + 1)).Chop_File).Name.all);
1065 if Duplicates and not Overwrite_Files then
1066 Put_Line ("use -w to overwrite files
and keep last version
");
1070 end Report_Duplicate_Units;
1072 --------------------
1073 -- Scan_Arguments --
1074 --------------------
1076 function Scan_Arguments return Boolean is
1077 Kset : Boolean := False;
1078 -- Set true if -k switch found
1081 Initialize_Option_Scan;
1083 -- Scan options first
1086 case Getopt ("c gnat? h k? p q r v w x
-GCC
=!") is
1091 Gcc := new String'(Parameter);
1095 Compilation_Mode := True;
1099 new Argument_List'(Gnat_Args.all &
1100 new String'("-gnat
" & Parameter));
1104 raise Types.Terminate_Program;
1108 Param : String_Access := new String'(Parameter);
1111 if Param.all /= "" then
1112 for J in Param'Range loop
1113 if Param (J) not in '0' .. '9' then
1114 Error_Msg ("-k# requires numeric parameter
");
1120 Param := new String'("8");
1124 new Argument_List'(Gnat_Args.all &
1125 new String'("-gnatk
" & Param.all));
1130 Preserve_Mode := True;
1136 Source_References := True;
1139 Verbose_Mode := True;
1140 Display_Version ("GNATCHOP
", "1998");
1143 Overwrite_Files := True;
1146 Exit_On_Error := True;
1153 if not Kset and then Maximum_File_Name_Length > 0 then
1155 -- If this system has restricted filename lengths, tell gnat1
1156 -- about them, removing the leading blank from the image string.
1159 new Argument_List'(Gnat_Args.all
1160 & new String'("-gnatk
"
1161 & Maximum_File_Name_Length_String
1162 (Maximum_File_Name_Length_String'First + 1
1163 .. Maximum_File_Name_Length_String'Last)));
1170 S : constant String := Get_Argument (Do_Expansion => True);
1174 File.Increment_Last;
1175 File.Table (File.Last).Name := new String'(S);
1176 File.Table (File.Last).SR_Name := null;
1180 -- Case of more than one file where last file is a directory
1183 and then Is_Directory (File.Table (File.Last).Name.all)
1185 Directory := File.Table (File.Last).Name;
1186 File.Decrement_Last;
1188 -- Make sure Directory is terminated with a directory separator,
1189 -- so we can generate the output by just appending a filename.
1191 if Directory (Directory'Last) /= Directory_Separator
1192 and then Directory (Directory'Last) /= '/'
1194 Directory := new String'(Directory.all & Directory_Separator);
1197 -- At least one filename must be given
1199 elsif File.Last = 0 then
1200 if Argument_Count = 0 then
1208 -- No directory given, set directory to null, so that we can just
1209 -- concatenate the directory name to the file name unconditionally.
1212 Directory := new String'("");
1215 -- Finally check all filename arguments
1217 for File_Num in 1 .. File.Last loop
1219 F : constant String := File.Table (File_Num).Name.all;
1222 if Is_Directory (F) then
1223 Error_Msg (F & " is a directory
, cannot be chopped
");
1226 elsif not Is_Regular_File (F) then
1227 Error_Msg (F & " not found
");
1236 when Invalid_Switch =>
1237 Error_Msg ("invalid switch
" & Full_Switch);
1240 when Invalid_Parameter =>
1241 Error_Msg ("-k switch requires numeric parameter
");
1249 procedure Sort_Units is
1251 procedure Move (From : Natural; To : Natural);
1252 -- Procedure used to sort the unit list
1253 -- Unit.Table (To) := Unit_List (From); used by sort
1255 function Lt (Left, Right : Natural) return Boolean;
1256 -- Compares Left and Right units based on file name (first),
1257 -- Chop_File (second) and Offset (third). This ordering is
1258 -- important to keep the last version in case of duplicate files.
1260 package Unit_Sort is new GNAT.Heap_Sort_G (Move, Lt);
1261 -- Used for sorting on filename to detect duplicates
1267 function Lt (Left, Right : Natural) return Boolean is
1268 L : Unit_Info renames
1269 Unit.Table (Sorted_Units.Table (SUnit_Num (Left)));
1271 R : Unit_Info renames
1272 Unit.Table (Sorted_Units.Table (SUnit_Num (Right)));
1275 return L.File_Name.all < R.File_Name.all
1276 or else (L.File_Name.all = R.File_Name.all
1277 and then (L.Chop_File < R.Chop_File
1278 or else (L.Chop_File = R.Chop_File
1279 and then L.Offset < R.Offset)));
1286 procedure Move (From : Natural; To : Natural) is
1288 Sorted_Units.Table (SUnit_Num (To)) :=
1289 Sorted_Units.Table (SUnit_Num (From));
1292 -- Start of processing for Sort_Units
1295 Sorted_Units.Set_Last (SUnit_Num (Unit.Last));
1297 for J in 1 .. Unit.Last loop
1298 Sorted_Units.Table (SUnit_Num (J)) := J;
1301 -- Sort Unit.Table, using Sorted_Units.Table (0) as scratch
1303 Unit_Sort.Sort (Natural (Unit.Last));
1305 -- Set the Sorted_Index fields in the unit tables
1307 for J in 1 .. SUnit_Num (Unit.Last) loop
1308 Unit.Table (Sorted_Units.Table (J)).Sorted_Index := J;
1319 ("Usage
: gnatchop
[-c
] [-h
] [-k#
] " &
1320 "[-r
] [-p
] [-q
] [-v
] [-w
] [-x
] [--GCC=xx] file [file ...] [dir]");
1324 Display_Usage_Version_And_Help
;
1327 (" -c compilation mode, configuration pragmas " &
1331 (" -gnatxxx passes the -gnatxxx switch to gnat parser");
1334 (" -h help: output this usage information");
1337 (" -k# krunch file names of generated files to " &
1338 "no more than # characters");
1341 (" -k krunch file names of generated files to " &
1342 "no more than 8 characters");
1345 (" -p preserve time stamp, output files will " &
1346 "have same stamp as input");
1349 (" -q quiet mode, no output of generated file " &
1353 (" -r generate Source_Reference pragmas refer" &
1354 "encing original source file");
1357 (" -v verbose mode, output version and generat" &
1361 (" -w overwrite existing filenames");
1364 (" -x exit on error");
1367 (" --GCC=xx specify the path of the gnat parser to be used");
1371 (" file... list of source files to be chopped");
1374 (" dir directory location for split files (defa" &
1375 "ult = current directory)");
1382 procedure Warning_Msg
(Message
: String) is
1384 Warning_Count
:= Warning_Count
+ 1;
1385 Put_Line
(Standard_Error
, "warning: " & Message
);
1388 -------------------------
1389 -- Write_Chopped_Files --
1390 -------------------------
1392 function Write_Chopped_Files
(Input
: File_Num
) return Boolean is
1393 Name
: aliased constant String :=
1394 File
.Table
(Input
).Name
.all & ASCII
.NUL
;
1395 FD
: File_Descriptor
;
1396 Buffer
: String_Access
;
1400 BOM_Present
: Boolean;
1402 -- Record presence of UTF8 BOM in input
1405 FD
:= Open_Read
(Name
'Address, Binary
);
1406 TS_Time
:= File_Time_Stamp
(FD
);
1408 if FD
= Invalid_FD
then
1409 Error_Msg
("cannot open " & File
.Table
(Input
).Name
.all);
1413 Read_File
(FD
, Buffer
, Success
);
1416 Error_Msg
("cannot read " & File
.Table
(Input
).Name
.all);
1421 if not Quiet_Mode
then
1422 Put_Line
("splitting " & File
.Table
(Input
).Name
.all & " into:");
1425 -- Test for presence of BOM
1427 Read_BOM
(Buffer
.all, BOM_Length
, BOM
, XML_Support
=> False);
1428 BOM_Present
:= BOM
/= Unknown
;
1430 -- Only chop those units that come from this file
1432 for Unit_Number
in 1 .. Unit
.Last
loop
1433 if Unit
.Table
(Unit_Number
).Chop_File
= Input
then
1438 Write_BOM
=> BOM_Present
and then Unit_Number
/= 1,
1439 Success
=> Success
);
1440 exit when not Success
;
1446 end Write_Chopped_Files
;
1448 -----------------------
1449 -- Write_Config_File --
1450 -----------------------
1452 procedure Write_Config_File
(Input
: File_Num
; U
: Unit_Num
) is
1453 FD
: File_Descriptor
;
1454 Name
: aliased constant String := "gnat.adc" & ASCII
.NUL
;
1455 Buffer
: String_Access
;
1458 Buffera
: String_Access
;
1462 Write_gnat_adc
:= True;
1463 FD
:= Open_Read_Write
(Name
'Address, Binary
);
1465 if FD
= Invalid_FD
then
1466 FD
:= Create_File
(Name
'Address, Binary
);
1469 if not Quiet_Mode
then
1470 Put_Line
("writing configuration pragmas from " &
1471 File
.Table
(Input
).Name
.all & " to gnat.adc");
1477 if not Quiet_Mode
then
1479 ("appending configuration pragmas from " &
1480 File
.Table
(Input
).Name
.all & " to gnat.adc");
1484 Success
:= FD
/= Invalid_FD
;
1487 Error_Msg
("cannot create gnat.adc");
1491 -- In append mode, acquire existing gnat.adc file
1494 Read_File
(FD
, Buffera
, Success
);
1497 Error_Msg
("cannot read gnat.adc");
1501 -- Find location of EOF byte if any to exclude from append
1504 while Bufferl
<= Buffera
'Last
1505 and then Buffera
(Bufferl
) /= EOF
1507 Bufferl
:= Bufferl
+ 1;
1510 Bufferl
:= Bufferl
- 1;
1513 -- Write existing gnat.adc to new gnat.adc file
1515 FD
:= Create_File
(Name
'Address, Binary
);
1516 Success
:= Write
(FD
, Buffera
(1)'Address, Bufferl
) = Bufferl
;
1519 Error_Msg
("error writing gnat.adc");
1524 Buffer
:= Get_Config_Pragmas
(Input
, U
);
1526 if Buffer
/= null then
1527 Success
:= Write
(FD
, Buffer
.all'Address, Buffer
'Length) =
1531 Error_Msg
("disk full writing gnat.adc");
1537 end Write_Config_File
;
1539 -----------------------------------
1540 -- Write_Source_Reference_Pragma --
1541 -----------------------------------
1543 procedure Write_Source_Reference_Pragma
1546 File
: Stream_IO
.File_Type
;
1548 Success
: in out Boolean)
1550 FTE
: File_Entry
renames Gnatchop
.File
.Table
(Info
.Chop_File
);
1551 Nam
: String_Access
;
1554 if Success
and then Source_References
and then not Info
.SR_Present
then
1555 if FTE
.SR_Name
/= null then
1562 Reference
: String :=
1563 "pragma Source_Reference (000000, """
1564 & Nam
.all & """);" & EOL
.Str
;
1566 Pos
: Positive := Reference
'First;
1567 Lin
: Line_Num
:= Line
;
1570 while Reference
(Pos
+ 1) /= ',' loop
1574 while Reference
(Pos
) = '0' loop
1575 Reference
(Pos
) := Character'Val
1576 (Character'Pos ('0') + Lin
mod 10);
1581 -- Assume there are enough zeroes for any program length
1583 pragma Assert
(Lin
= 0);
1586 String'Write (Stream_IO
.Stream
(File
), Reference
);
1594 end Write_Source_Reference_Pragma
;
1600 procedure Write_Unit
1601 (Source
: not null access String;
1604 Write_BOM
: Boolean;
1605 Success
: out Boolean)
1608 procedure OS_Filename
1610 W_Name
: Wide_String;
1612 N_Length
: access Natural;
1614 E_Length
: access Natural);
1615 pragma Import
(C
, OS_Filename
, "__gnat_os_filename");
1616 -- Returns in OS_Name the proper name for the OS when used with the
1617 -- returned Encoding value. For example on Windows this will return the
1618 -- UTF-8 encoded name into OS_Name and set Encoding to encoding=utf8
1619 -- (the form parameter for Stream_IO).
1621 -- Name is the filename and W_Name the same filename in Unicode 16 bits
1622 -- (this corresponds to Win32 Unicode ISO/IEC 10646). N_Length/E_Length
1623 -- are the length returned in OS_Name/Encoding respectively.
1625 Info
: Unit_Info
renames Unit
.Table
(Num
);
1626 Name
: aliased constant String := Info
.File_Name
.all & ASCII
.NUL
;
1627 W_Name
: aliased constant Wide_String := To_Wide_String
(Name
);
1628 EOL
: constant EOL_String
:=
1629 Get_EOL
(Source
, Source
'First + Info
.Offset
);
1630 OS_Name
: aliased String (1 .. Name
'Length * 2);
1631 O_Length
: aliased Natural := OS_Name
'Length;
1632 Encoding
: aliased String (1 .. 64);
1633 E_Length
: aliased Natural := Encoding
'Length;
1634 Length
: File_Offset
;
1637 -- Skip duplicated files
1639 if Is_Duplicated
(Info
.Sorted_Index
) then
1640 Put_Line
(" " & Info
.File_Name
.all & " skipped");
1641 Success
:= Overwrite_Files
;
1649 OS_Name
'Address, O_Length
'Access,
1650 Encoding
'Address, E_Length
'Access);
1653 E_Name
: constant String := OS_Name
(1 .. O_Length
);
1654 OS_Encoding
: constant String := Encoding
(1 .. E_Length
);
1655 File
: Stream_IO
.File_Type
;
1659 if not Overwrite_Files
and then Exists
(E_Name
) then
1660 raise Stream_IO
.Name_Error
;
1663 (File
, Stream_IO
.Out_File
, E_Name
, OS_Encoding
);
1668 when Stream_IO
.Name_Error | Stream_IO
.Use_Error
=>
1669 Error_Msg
("cannot create " & Info
.File_Name
.all);
1673 -- A length of 0 indicates that the rest of the file belongs to
1674 -- this unit. The actual length must be calculated now. Take into
1675 -- account that the last character (EOF) must not be written.
1677 if Info
.Length
= 0 then
1678 Length
:= Source
'Last - (Source
'First + Info
.Offset
);
1680 Length
:= Info
.Length
;
1683 -- Write BOM if required
1687 (Stream_IO
.Stream
(File
),
1688 Source
.all (Source
'First .. Source
'First + BOM_Length
- 1));
1691 -- Prepend configuration pragmas if necessary
1693 if Success
and then Info
.Bufferg
/= null then
1694 Write_Source_Reference_Pragma
(Info
, 1, File
, EOL
, Success
);
1695 String'Write (Stream_IO
.Stream
(File
), Info
.Bufferg
.all);
1698 Write_Source_Reference_Pragma
1699 (Info
, Info
.Start_Line
, File
, EOL
, Success
);
1704 (Stream_IO
.Stream
(File
),
1705 Source
(Source
'First + Info
.Offset
..
1706 Source
'First + Info
.Offset
+ Length
- 1));
1708 when Stream_IO
.Use_Error | Stream_IO
.Device_Error
=>
1709 Error_Msg
("disk full writing " & Info
.File_Name
.all);
1714 if not Quiet_Mode
then
1715 Put_Line
(" " & Info
.File_Name
.all);
1718 Stream_IO
.Close
(File
);
1720 if Preserve_Mode
then
1721 Set_File_Last_Modify_Time_Stamp
(E_Name
, TS_Time
);
1726 procedure Check_Version_And_Help
is new Check_Version_And_Help_G
(Usage
);
1728 -- Start of processing for gnatchop
1731 -- Add the directory where gnatchop is invoked in front of the path, if
1732 -- gnatchop is invoked with directory information.
1735 Command
: constant String := Command_Name
;
1738 for Index
in reverse Command
'Range loop
1739 if Command
(Index
) = Directory_Separator
then
1741 Absolute_Dir
: constant String :=
1743 (Command
(Command
'First .. Index
));
1744 PATH
: constant String :=
1747 & Getenv
("PATH").all;
1749 Setenv
("PATH", PATH
);
1757 -- Process command line options and initialize global variables
1759 -- First, scan to detect --version and/or --help
1761 Check_Version_And_Help
("GNATCHOP", "1998");
1763 if not Scan_Arguments
then
1764 Set_Exit_Status
(Failure
);
1768 -- Check presence of required executables
1770 Gnat_Cmd
:= Locate_Executable
(Gcc
.all, not Gcc_Set
);
1772 if Gnat_Cmd
= null then
1773 goto No_Files_Written
;
1776 -- First parse all files and read offset information
1778 for Num
in 1 .. File
.Last
loop
1779 if not Parse_File
(Num
) then
1780 goto No_Files_Written
;
1784 -- Check if any units have been found (assumes non-empty Unit.Table)
1786 if Unit
.Last
= 0 then
1787 if not Write_gnat_adc
then
1788 Error_Msg
("no compilation units found", Warning
=> True);
1791 goto No_Files_Written
;
1796 -- Check if any duplicate files would be created. If so, emit a warning if
1797 -- Overwrite_Files is true, otherwise generate an error.
1799 if Report_Duplicate_Units
and then not Overwrite_Files
then
1800 goto No_Files_Written
;
1803 -- Check if any files exist, if so do not write anything Because all files
1804 -- have been parsed and checked already, there won't be any duplicates
1806 if not Overwrite_Files
and then Files_Exist
then
1807 goto No_Files_Written
;
1810 -- After this point, all source files are read in succession and chopped
1811 -- into their destination files.
1813 -- Source_File_Name pragmas are handled as logical file 0 so write it first
1815 for F
in 1 .. File
.Last
loop
1816 if not Write_Chopped_Files
(F
) then
1817 Set_Exit_Status
(Failure
);
1822 if Warning_Count
> 0 then
1824 Warnings_Msg
: constant String := Warning_Count
'Img & " warning(s)";
1826 Error_Msg
(Warnings_Msg
(2 .. Warnings_Msg
'Last), Warning
=> True);
1832 <<No_Files_Written
>>
1834 -- Special error exit for all situations where no files have
1837 if not Write_gnat_adc
then
1838 Error_Msg
("no source files written", Warning
=> True);
1844 when Types
.Terminate_Program
=>