1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2002-2007, 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 ------------------------------------------------------------------------------
27 with Err_Vars
; use Err_Vars
;
29 with Namet
; use Namet
;
31 with Osint
; use Osint
;
32 with Output
; use Output
;
37 with Stringt
; use Stringt
;
38 with Switch
; use Switch
;
39 with Types
; use Types
;
41 with Ada
.Text_IO
; use Ada
.Text_IO
;
43 with GNAT
.Case_Util
; use GNAT
.Case_Util
;
44 with GNAT
.Command_Line
;
45 with GNAT
.Directory_Operations
; use GNAT
.Directory_Operations
;
47 with System
.OS_Lib
; use System
.OS_Lib
;
51 Copyright_Displayed
: Boolean := False;
52 -- Used to prevent multiple displays of the copyright notice
54 ------------------------
55 -- Argument Line Data --
56 ------------------------
58 Infile_Name
: Name_Id
:= No_Name
;
59 Outfile_Name
: Name_Id
:= No_Name
;
60 Deffile_Name
: Name_Id
:= No_Name
;
62 Output_Directory
: Name_Id
:= No_Name
;
63 -- Used when the specified output is an existing directory
65 Input_Directory
: Name_Id
:= No_Name
;
66 -- Used when the specified input and output are existing directories
68 Source_Ref_Pragma
: Boolean := False;
69 -- Record command line options (set if -r switch set)
71 Text_Outfile
: aliased Ada
.Text_IO
.File_Type
;
72 Outfile
: constant File_Access
:= Text_Outfile
'Access;
74 File_Name_Buffer_Initial_Size
: constant := 50;
75 File_Name_Buffer
: String_Access
:=
76 new String (1 .. File_Name_Buffer_Initial_Size
);
77 -- A buffer to build output file names from input file names
83 procedure Display_Copyright
;
84 -- Display the copyright notice
86 procedure Obsolescent_Check
(S
: Source_Ptr
);
87 -- Null procedure, needed by instantiation of Scng below
90 -- Null procedure, needed by instantiation of Scng below
92 package Scanner
is new Scng
100 -- The scanner for the preprocessor
102 function Is_ASCII_Letter
(C
: Character) return Boolean;
103 -- True if C is in 'a' .. 'z' or in 'A' .. 'Z'
105 procedure Double_File_Name_Buffer
;
106 -- Double the size of the file name buffer
108 procedure Preprocess_Infile_Name
;
109 -- When the specified output is a directory, preprocess the infile name
110 -- for symbol substitution, to get the output file name.
112 procedure Process_Files
;
113 -- Process the single input file or all the files in the directory tree
114 -- rooted at the input directory.
116 procedure Process_Command_Line_Symbol_Definition
(S
: String);
117 -- Process a -D switch on the command line
119 procedure Put_Char_To_Outfile
(C
: Character);
120 -- Output one character to the output file. Used to initialize the
123 procedure New_EOL_To_Outfile
;
124 -- Output a new line to the output file. Used to initialize the
127 procedure Scan_Command_Line
;
128 -- Scan the switches and the file names
133 -----------------------
134 -- Display_Copyright --
135 -----------------------
137 procedure Display_Copyright
is
139 if not Copyright_Displayed
then
140 Display_Version
("GNAT Preprocessor", "1996");
141 Copyright_Displayed
:= True;
143 end Display_Copyright
;
145 -----------------------------
146 -- Double_File_Name_Buffer --
147 -----------------------------
149 procedure Double_File_Name_Buffer
is
150 New_Buffer
: constant String_Access
:=
151 new String (1 .. 2 * File_Name_Buffer
'Length);
153 New_Buffer
(File_Name_Buffer
'Range) := File_Name_Buffer
.all;
154 Free
(File_Name_Buffer
);
155 File_Name_Buffer
:= New_Buffer
;
156 end Double_File_Name_Buffer
;
162 procedure Gnatprep
is
164 -- Do some initializations (order is important here!)
171 -- Initialize the preprocessor
174 (Error_Msg
=> Errutil
.Error_Msg
'Access,
175 Scan
=> Scanner
.Scan
'Access,
176 Set_Ignore_Errors
=> Errutil
.Set_Ignore_Errors
'Access,
177 Put_Char
=> Put_Char_To_Outfile
'Access,
178 New_EOL
=> New_EOL_To_Outfile
'Access);
180 -- Set the scanner characteristics for the preprocessor
182 Scanner
.Set_Special_Character
('#');
183 Scanner
.Set_Special_Character
('$');
184 Scanner
.Set_End_Of_Line_As_Token
(True);
186 -- Initialize the mapping table of symbols to values
188 Prep
.Symbol_Table
.Init
(Prep
.Mapping
);
190 -- Parse the switches and arguments
194 if Opt
.Verbose_Mode
then
198 -- Test we had all the arguments needed
200 if Infile_Name
= No_Name
then
202 -- No input file specified, just output the usage and exit
207 elsif Outfile_Name
= No_Name
then
209 -- No output file specified, just output the usage and exit
215 -- If a pragma Source_File_Name, we need to keep line numbers. So, if
216 -- the deleted lines are not put as comment, we must output them as
219 if Source_Ref_Pragma
and (not Opt
.Comment_Deleted_Lines
) then
220 Opt
.Blank_Deleted_Lines
:= True;
223 -- If we have a definition file, parse it
225 if Deffile_Name
/= No_Name
then
227 Deffile
: Source_File_Index
;
231 Deffile
:= Sinput
.C
.Load_File
(Get_Name_String
(Deffile_Name
));
233 -- Set Main_Source_File to the definition file for the benefit of
236 Sinput
.Main_Source_File
:= Deffile
;
238 if Deffile
= No_Source_File
then
239 Fail
("unable to find definition file """,
240 Get_Name_String
(Deffile_Name
),
244 Scanner
.Initialize_Scanner
(Deffile
);
250 -- If there are errors in the definition file, output them and exit
252 if Total_Errors_Detected
> 0 then
253 Errutil
.Finalize
(Source_Type
=> "definition");
254 Fail
("errors in definition file """,
255 Get_Name_String
(Deffile_Name
), """");
258 -- If -s switch was specified, print a sorted list of symbol names and
261 if Opt
.List_Preprocessing_Symbols
then
262 Prep
.List_Symbols
(Foreword
=> "");
265 Output_Directory
:= No_Name
;
266 Input_Directory
:= No_Name
;
268 -- Check if the specified output is an existing directory
270 if Is_Directory
(Get_Name_String
(Outfile_Name
)) then
271 Output_Directory
:= Outfile_Name
;
273 -- As the output is an existing directory, check if the input too
276 if Is_Directory
(Get_Name_String
(Infile_Name
)) then
277 Input_Directory
:= Infile_Name
;
281 -- And process the single input or the files in the directory tree
282 -- rooted at the input directory.
287 ---------------------
288 -- Is_ASCII_Letter --
289 ---------------------
291 function Is_ASCII_Letter
(C
: Character) return Boolean is
293 return C
in 'A' .. 'Z' or else C
in 'a' .. 'z';
296 ------------------------
297 -- New_EOL_To_Outfile --
298 ------------------------
300 procedure New_EOL_To_Outfile
is
302 New_Line
(Outfile
.all);
303 end New_EOL_To_Outfile
;
305 -----------------------
306 -- Obsolescent_Check --
307 -----------------------
309 procedure Obsolescent_Check
(S
: Source_Ptr
) is
310 pragma Warnings
(Off
, S
);
313 end Obsolescent_Check
;
319 procedure Post_Scan
is
324 ----------------------------
325 -- Preprocess_Infile_Name --
326 ----------------------------
328 procedure Preprocess_Infile_Name
is
336 -- Initialize the buffer with the name of the input file
338 Get_Name_String
(Infile_Name
);
341 while File_Name_Buffer
'Length < Len
loop
342 Double_File_Name_Buffer
;
345 File_Name_Buffer
(1 .. Len
) := Name_Buffer
(1 .. Len
);
347 -- Look for possible symbols in the file name
350 while First
< Len
loop
352 -- A symbol starts with a dollar sign followed by a letter
354 if File_Name_Buffer
(First
) = '$' and then
355 Is_ASCII_Letter
(File_Name_Buffer
(First
+ 1))
359 -- Find the last letter of the symbol
361 while Last
< Len
and then
362 Is_ASCII_Letter
(File_Name_Buffer
(Last
+ 1))
367 -- Get the symbol name id
369 Name_Len
:= Last
- First
;
370 Name_Buffer
(1 .. Name_Len
) :=
371 File_Name_Buffer
(First
+ 1 .. Last
);
372 To_Lower
(Name_Buffer
(1 .. Name_Len
));
375 -- And look for this symbol name in the symbol table
377 for Index
in 1 .. Symbol_Table
.Last
(Mapping
) loop
378 Data
:= Mapping
.Table
(Index
);
380 if Data
.Symbol
= Symbol
then
382 -- We found the symbol. If its value is not a string,
383 -- replace the symbol in the file name with the value of
386 if not Data
.Is_A_String
then
387 String_To_Name_Buffer
(Data
.Value
);
390 Sym_Len
: constant Positive := Last
- First
+ 1;
391 Offset
: constant Integer := Name_Len
- Sym_Len
;
392 New_Len
: constant Natural := Len
+ Offset
;
395 while New_Len
> File_Name_Buffer
'Length loop
396 Double_File_Name_Buffer
;
399 File_Name_Buffer
(Last
+ 1 + Offset
.. New_Len
) :=
400 File_Name_Buffer
(Last
+ 1 .. Len
);
402 Last
:= Last
+ Offset
;
403 File_Name_Buffer
(First
.. Last
) :=
404 Name_Buffer
(1 .. Name_Len
);
412 -- Skip over the symbol name or its value: we are not checking
413 -- for another symbol name in the value.
422 -- We now have the output file name in the buffer. Get the output
423 -- path and put it in Outfile_Name.
425 Get_Name_String
(Output_Directory
);
426 Add_Char_To_Name_Buffer
(Directory_Separator
);
427 Add_Str_To_Name_Buffer
(File_Name_Buffer
(1 .. Len
));
428 Outfile_Name
:= Name_Find
;
429 end Preprocess_Infile_Name
;
431 --------------------------------------------
432 -- Process_Command_Line_Symbol_Definition --
433 --------------------------------------------
435 procedure Process_Command_Line_Symbol_Definition
(S
: String) is
440 -- Check the symbol definition and get the symbol and its value.
441 -- Fail if symbol definition is illegal.
443 Check_Command_Line_Symbol_Definition
(S
, Data
);
445 Symbol
:= Index_Of
(Data
.Symbol
);
447 -- If symbol does not alrady exist, create a new entry in the mapping
450 if Symbol
= No_Symbol
then
451 Symbol_Table
.Increment_Last
(Mapping
);
452 Symbol
:= Symbol_Table
.Last
(Mapping
);
455 Mapping
.Table
(Symbol
) := Data
;
456 end Process_Command_Line_Symbol_Definition
;
462 procedure Process_Files
is
464 procedure Process_One_File
;
465 -- Process input file Infile_Name and put the result in file
468 procedure Recursive_Process
(In_Dir
: String; Out_Dir
: String);
469 -- Process recursively files in In_Dir. Results go to Out_Dir
471 ----------------------
472 -- Process_One_File --
473 ----------------------
475 procedure Process_One_File
is
476 Infile
: Source_File_Index
;
479 -- Create the output file (fails if this does not work)
482 Create
(Text_Outfile
, Out_File
, Get_Name_String
(Outfile_Name
));
487 ("unable to create output file """,
488 Get_Name_String
(Outfile_Name
), """");
491 -- Load the input file
493 Infile
:= Sinput
.C
.Load_File
(Get_Name_String
(Infile_Name
));
495 if Infile
= No_Source_File
then
496 Fail
("unable to find input file """,
497 Get_Name_String
(Infile_Name
), """");
500 -- Set Main_Source_File to the input file for the benefit of
503 Sinput
.Main_Source_File
:= Infile
;
505 Scanner
.Initialize_Scanner
(Infile
);
507 -- Output the pragma Source_Reference if asked to
509 if Source_Ref_Pragma
then
512 "pragma Source_Reference (1, """ &
513 Get_Name_String
(Sinput
.Full_File_Name
(Infile
)) & """);");
516 -- Preprocess the input file
520 -- In verbose mode, if there is no error, report it
522 if Opt
.Verbose_Mode
and then Err_Vars
.Total_Errors_Detected
= 0 then
523 Errutil
.Finalize
(Source_Type
=> "input");
526 -- If we had some errors, delete the output file, and report them
528 if Err_Vars
.Total_Errors_Detected
> 0 then
529 if Outfile
/= Standard_Output
then
530 Delete
(Text_Outfile
);
533 Errutil
.Finalize
(Source_Type
=> "input");
537 -- Otherwise, close the output file, and we are done
539 elsif Outfile
/= Standard_Output
then
540 Close
(Text_Outfile
);
542 end Process_One_File
;
544 -----------------------
545 -- Recursive_Process --
546 -----------------------
548 procedure Recursive_Process
(In_Dir
: String; Out_Dir
: String) is
550 Name
: String (1 .. 255);
552 In_Dir_Name
: Name_Id
;
553 Out_Dir_Name
: Name_Id
;
555 procedure Set_Directory_Names
;
556 -- Establish or reestablish the current input and output directories
558 -------------------------
559 -- Set_Directory_Names --
560 -------------------------
562 procedure Set_Directory_Names
is
564 Input_Directory
:= In_Dir_Name
;
565 Output_Directory
:= Out_Dir_Name
;
566 end Set_Directory_Names
;
568 -- Start of processing for Recursive_Process
571 -- Open the current input directory
574 Open
(Dir_In
, In_Dir
);
577 when Directory_Error
=>
578 Fail
("could not read directory " & In_Dir
);
581 -- Set the new input and output directory names
583 Name_Len
:= In_Dir
'Length;
584 Name_Buffer
(1 .. Name_Len
) := In_Dir
;
585 In_Dir_Name
:= Name_Find
;
586 Name_Len
:= Out_Dir
'Length;
587 Name_Buffer
(1 .. Name_Len
) := Out_Dir
;
588 Out_Dir_Name
:= Name_Find
;
592 -- Traverse the input directory
594 Read
(Dir_In
, Name
, Last
);
597 if Name
(1 .. Last
) /= "." and then Name
(1 .. Last
) /= ".." then
599 Input
: constant String :=
600 In_Dir
& Directory_Separator
& Name
(1 .. Last
);
601 Output
: constant String :=
602 Out_Dir
& Directory_Separator
& Name
(1 .. Last
);
605 -- If input is an ordinary file, process it
607 if Is_Regular_File
(Input
) then
608 -- First get the output file name
611 Name_Buffer
(1 .. Name_Len
) := Name
(1 .. Last
);
612 Infile_Name
:= Name_Find
;
613 Preprocess_Infile_Name
;
615 -- Set the input file name and process the file
617 Name_Len
:= Input
'Length;
618 Name_Buffer
(1 .. Name_Len
) := Input
;
619 Infile_Name
:= Name_Find
;
622 elsif Is_Directory
(Input
) then
623 -- Input is a directory. If the corresponding output
624 -- directory does not already exist, create it.
626 if not Is_Directory
(Output
) then
628 Make_Dir
(Dir_Name
=> Output
);
631 when Directory_Error
=>
632 Fail
("could not create directory """,
637 -- And process this new input directory
639 Recursive_Process
(Input
, Output
);
641 -- Reestablish the input and output directory names
642 -- that have been modified by the recursive call.
649 end Recursive_Process
;
651 -- Start of processing for Process_Files
654 if Output_Directory
= No_Name
then
656 -- If the output is not a directory, fail if the input is
657 -- an existing directory, to avoid possible problems.
659 if Is_Directory
(Get_Name_String
(Infile_Name
)) then
660 Fail
("input file """ & Get_Name_String
(Infile_Name
) &
661 """ is a directory");
664 -- Just process the single input file
668 elsif Input_Directory
= No_Name
then
670 -- Get the output file name from the input file name, and process
671 -- the single input file.
673 Preprocess_Infile_Name
;
677 -- Recursively process files in the directory tree rooted at the
681 (In_Dir
=> Get_Name_String
(Input_Directory
),
682 Out_Dir
=> Get_Name_String
(Output_Directory
));
686 -------------------------
687 -- Put_Char_To_Outfile --
688 -------------------------
690 procedure Put_Char_To_Outfile
(C
: Character) is
692 Put
(Outfile
.all, C
);
693 end Put_Char_To_Outfile
;
695 -----------------------
696 -- Scan_Command_Line --
697 -----------------------
699 procedure Scan_Command_Line
is
703 -- First check for --version or --help
705 Check_Version_And_Help
("GNATPREP", "1996", Usage
'Access);
707 -- Now scan the other switches
709 GNAT
.Command_Line
.Initialize_Option_Scan
;
713 Switch
:= GNAT
.Command_Line
.Getopt
("D: b c C r s u v");
721 Process_Command_Line_Symbol_Definition
722 (S
=> GNAT
.Command_Line
.Parameter
);
725 Opt
.Blank_Deleted_Lines
:= True;
728 Opt
.Comment_Deleted_Lines
:= True;
731 Opt
.Replace_In_Comments
:= True;
734 Source_Ref_Pragma
:= True;
737 Opt
.List_Preprocessing_Symbols
:= True;
740 Opt
.Undefined_Symbols_Are_False
:= True;
743 Opt
.Verbose_Mode
:= True;
746 Fail
("Invalid Switch: -" & Switch
);
750 when GNAT
.Command_Line
.Invalid_Switch
=>
751 Write_Str
("Invalid Switch: -");
752 Write_Line
(GNAT
.Command_Line
.Full_Switch
);
758 -- Get the file names
762 S
: constant String := GNAT
.Command_Line
.Get_Argument
;
765 exit when S
'Length = 0;
767 Name_Len
:= S
'Length;
768 Name_Buffer
(1 .. Name_Len
) := S
;
770 if Infile_Name
= No_Name
then
771 Infile_Name
:= Name_Find
;
772 elsif Outfile_Name
= No_Name
then
773 Outfile_Name
:= Name_Find
;
774 elsif Deffile_Name
= No_Name
then
775 Deffile_Name
:= Name_Find
;
777 Fail
("too many arguments specifed");
781 end Scan_Command_Line
;
790 Write_Line
("Usage: gnatprep [-bcrsuv] [-Dsymbol=value] " &
791 "infile outfile [deffile]");
793 Write_Line
(" infile Name of the input file");
794 Write_Line
(" outfile Name of the output file");
795 Write_Line
(" deffile Name of the definition file");
797 Write_Line
("gnatprep switches:");
798 Write_Line
(" -b Replace preprocessor lines by blank lines");
799 Write_Line
(" -c Keep preprocessor lines as comments");
800 Write_Line
(" -C Do symbol replacements within comments");
801 Write_Line
(" -D Associate symbol with value");
802 Write_Line
(" -r Generate Source_Reference pragma");
803 Write_Line
(" -s Print a sorted list of symbol names and values");
804 Write_Line
(" -u Treat undefined symbols as FALSE");
805 Write_Line
(" -v Verbose mode");