1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2002-2010, 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 Unix_Line_Terminators : Boolean := False;
59 -- Set to True with option -T
61 type String_Array is array (Boolean) of String_Access;
62 Yes_No : constant String_Array :=
63 (False => new String'("YES"),
64 True => new String'("NO"));
66 Infile_Name : Name_Id := No_Name;
67 Outfile_Name : Name_Id := No_Name;
68 Deffile_Name : Name_Id := No_Name;
70 Output_Directory : Name_Id := No_Name;
71 -- Used when the specified output is an existing directory
73 Input_Directory : Name_Id := No_Name;
74 -- Used when the specified input and output are existing directories
76 Source_Ref_Pragma : Boolean := False;
77 -- Record command line options (set if -r switch set)
79 Text_Outfile : aliased Ada.Text_IO.File_Type;
80 Outfile : constant File_Access := Text_Outfile'Access;
82 File_Name_Buffer_Initial_Size : constant := 50;
83 File_Name_Buffer : String_Access :=
84 new String (1 .. File_Name_Buffer_Initial_Size);
85 -- A buffer to build output file names from input file names
91 procedure Display_Copyright;
92 -- Display the copyright notice
95 -- Null procedure, needed by instantiation of Scng below
97 package Scanner is new Scng
101 Errutil.Error_Msg_SC,
102 Errutil.Error_Msg_SP,
104 -- The scanner for the preprocessor
106 function Is_ASCII_Letter (C : Character) return Boolean;
107 -- True if C is in 'a' .. 'z' or in 'A' .. 'Z'
109 procedure Double_File_Name_Buffer;
110 -- Double the size of the file name buffer
112 procedure Preprocess_Infile_Name;
113 -- When the specified output is a directory, preprocess the infile name
114 -- for symbol substitution, to get the output file name.
116 procedure Process_Files;
117 -- Process the single input file or all the files in the directory tree
118 -- rooted at the input directory.
120 procedure Process_Command_Line_Symbol_Definition (S : String);
121 -- Process a -D switch on the command line
123 procedure Put_Char_To_Outfile (C : Character);
124 -- Output one character to the output file. Used to initialize the
127 procedure New_EOL_To_Outfile;
128 -- Output a new line to the output file. Used to initialize the
131 procedure Scan_Command_Line;
132 -- Scan the switches and the file names
137 -----------------------
138 -- Display_Copyright --
139 -----------------------
141 procedure Display_Copyright is
143 if not Copyright_Displayed then
144 Display_Version ("GNAT Preprocessor", "1996");
145 Copyright_Displayed := True;
147 end Display_Copyright;
149 -----------------------------
150 -- Double_File_Name_Buffer --
151 -----------------------------
153 procedure Double_File_Name_Buffer is
154 New_Buffer : constant String_Access :=
155 new String (1 .. 2 * File_Name_Buffer'Length);
157 New_Buffer (File_Name_Buffer'Range) := File_Name_Buffer.all;
158 Free (File_Name_Buffer);
159 File_Name_Buffer := New_Buffer;
160 end Double_File_Name_Buffer;
166 procedure Gnatprep is
168 -- Do some initializations (order is important here!)
175 -- Initialize the preprocessor
178 (Error_Msg => Errutil.Error_Msg'Access,
179 Scan => Scanner.Scan'Access,
180 Set_Ignore_Errors => Errutil.Set_Ignore_Errors'Access,
181 Put_Char => Put_Char_To_Outfile'Access,
182 New_EOL => New_EOL_To_Outfile'Access);
184 -- Set the scanner characteristics for the preprocessor
186 Scanner.Set_Special_Character ('#');
187 Scanner.Set_Special_Character ('$');
188 Scanner.Set_End_Of_Line_As_Token (True);
190 -- Initialize the mapping table of symbols to values
192 Prep.Symbol_Table.Init (Prep.Mapping);
194 -- Parse the switches and arguments
198 if Opt.Verbose_Mode then
202 -- Test we had all the arguments needed
204 if Infile_Name = No_Name then
206 -- No input file specified, just output the usage and exit
211 elsif Outfile_Name = No_Name then
213 -- No output file specified, just output the usage and exit
219 -- If a pragma Source_File_Name, we need to keep line numbers. So, if
220 -- the deleted lines are not put as comment, we must output them as
223 if Source_Ref_Pragma and (not Opt.Comment_Deleted_Lines) then
224 Opt.Blank_Deleted_Lines := True;
227 -- If we have a definition file, parse it
229 if Deffile_Name /= No_Name then
231 Deffile : Source_File_Index;
235 Deffile := Sinput.C.Load_File (Get_Name_String (Deffile_Name));
237 -- Set Main_Source_File to the definition file for the benefit of
240 Sinput.Main_Source_File := Deffile;
242 if Deffile = No_Source_File then
243 Fail ("unable to find definition file """
244 & Get_Name_String (Deffile_Name)
248 Scanner.Initialize_Scanner (Deffile);
254 -- If there are errors in the definition file, output them and exit
256 if Total_Errors_Detected > 0 then
257 Errutil.Finalize (Source_Type => "definition");
258 Fail ("errors in definition file """
259 & Get_Name_String (Deffile_Name)
263 -- If -s switch was specified, print a sorted list of symbol names and
266 if Opt.List_Preprocessing_Symbols then
267 Prep.List_Symbols (Foreword => "");
270 Output_Directory := No_Name;
271 Input_Directory := No_Name;
273 -- Check if the specified output is an existing directory
275 if Is_Directory (Get_Name_String (Outfile_Name)) then
276 Output_Directory := Outfile_Name;
278 -- As the output is an existing directory, check if the input too
281 if Is_Directory (Get_Name_String (Infile_Name)) then
282 Input_Directory := Infile_Name;
286 -- And process the single input or the files in the directory tree
287 -- rooted at the input directory.
292 ---------------------
293 -- Is_ASCII_Letter --
294 ---------------------
296 function Is_ASCII_Letter (C : Character) return Boolean is
298 return C in 'A' .. 'Z' or else C in 'a' .. 'z';
301 ------------------------
302 -- New_EOL_To_Outfile --
303 ------------------------
305 procedure New_EOL_To_Outfile is
307 New_Line (Outfile.all);
308 end New_EOL_To_Outfile;
314 procedure Post_Scan is
319 ----------------------------
320 -- Preprocess_Infile_Name --
321 ----------------------------
323 procedure Preprocess_Infile_Name is
331 -- Initialize the buffer with the name of the input file
333 Get_Name_String (Infile_Name);
336 while File_Name_Buffer'Length < Len loop
337 Double_File_Name_Buffer;
340 File_Name_Buffer (1 .. Len) := Name_Buffer (1 .. Len);
342 -- Look for possible symbols in the file name
345 while First < Len loop
347 -- A symbol starts with a dollar sign followed by a letter
349 if File_Name_Buffer (First) = '$' and then
350 Is_ASCII_Letter (File_Name_Buffer (First + 1))
354 -- Find the last letter of the symbol
356 while Last < Len and then
357 Is_ASCII_Letter (File_Name_Buffer (Last + 1))
362 -- Get the symbol name id
364 Name_Len := Last - First;
365 Name_Buffer (1 .. Name_Len) :=
366 File_Name_Buffer (First + 1 .. Last);
367 To_Lower (Name_Buffer (1 .. Name_Len));
370 -- And look for this symbol name in the symbol table
372 for Index in 1 .. Symbol_Table.Last (Mapping) loop
373 Data := Mapping.Table (Index);
375 if Data.Symbol = Symbol then
377 -- We found the symbol. If its value is not a string,
378 -- replace the symbol in the file name with the value of
381 if not Data.Is_A_String then
382 String_To_Name_Buffer (Data.Value);
385 Sym_Len : constant Positive := Last - First + 1;
386 Offset : constant Integer := Name_Len - Sym_Len;
387 New_Len : constant Natural := Len + Offset;
390 while New_Len > File_Name_Buffer'Length loop
391 Double_File_Name_Buffer;
394 File_Name_Buffer (Last + 1 + Offset .. New_Len) :=
395 File_Name_Buffer (Last + 1 .. Len);
397 Last := Last + Offset;
398 File_Name_Buffer (First .. Last) :=
399 Name_Buffer (1 .. Name_Len);
407 -- Skip over the symbol name or its value: we are not checking
408 -- for another symbol name in the value.
417 -- We now have the output file name in the buffer. Get the output
418 -- path and put it in Outfile_Name.
420 Get_Name_String (Output_Directory);
421 Add_Char_To_Name_Buffer (Directory_Separator);
422 Add_Str_To_Name_Buffer (File_Name_Buffer (1 .. Len));
423 Outfile_Name := Name_Find;
424 end Preprocess_Infile_Name;
426 --------------------------------------------
427 -- Process_Command_Line_Symbol_Definition --
428 --------------------------------------------
430 procedure Process_Command_Line_Symbol_Definition (S : String) is
435 -- Check the symbol definition and get the symbol and its value.
436 -- Fail if symbol definition is illegal.
438 Check_Command_Line_Symbol_Definition (S, Data);
440 Symbol := Index_Of (Data.Symbol);
442 -- If symbol does not already exist, create a new entry in the mapping
445 if Symbol = No_Symbol then
446 Symbol_Table.Increment_Last (Mapping);
447 Symbol := Symbol_Table.Last (Mapping);
450 Mapping.Table (Symbol) := Data;
451 end Process_Command_Line_Symbol_Definition;
457 procedure Process_Files is
459 procedure Process_One_File;
460 -- Process input file Infile_Name and put the result in file
463 procedure Recursive_Process (In_Dir : String; Out_Dir : String);
464 -- Process recursively files in In_Dir. Results go to Out_Dir
466 ----------------------
467 -- Process_One_File --
468 ----------------------
470 procedure Process_One_File is
471 Infile : Source_File_Index;
474 pragma Warnings (Off, Modified);
477 -- Create the output file (fails if this does not work)
481 (File => Text_Outfile,
483 Name => Get_Name_String (Outfile_Name),
484 Form => "Text_Translation=" &
485 Yes_No (Unix_Line_Terminators).all);
490 ("unable to create output file """
491 & Get_Name_String (Outfile_Name)
495 -- Load the input file
497 Infile := Sinput.C.Load_File (Get_Name_String (Infile_Name));
499 if Infile = No_Source_File then
500 Fail ("unable to find input file """
501 & Get_Name_String (Infile_Name)
505 -- Set Main_Source_File to the input file for the benefit of
508 Sinput.Main_Source_File := Infile;
510 Scanner.Initialize_Scanner (Infile);
512 -- Output the pragma Source_Reference if asked to
514 if Source_Ref_Pragma then
517 "pragma Source_Reference (1, """ &
518 Get_Name_String (Sinput.Full_File_Name (Infile)) & """);");
521 -- Preprocess the input file
523 Prep.Preprocess (Modified);
525 -- In verbose mode, if there is no error, report it
527 if Opt.Verbose_Mode and then Err_Vars.Total_Errors_Detected = 0 then
528 Errutil.Finalize (Source_Type => "input");
531 -- If we had some errors, delete the output file, and report them
533 if Err_Vars.Total_Errors_Detected > 0 then
534 if Outfile /= Standard_Output then
535 Delete (Text_Outfile);
538 Errutil.Finalize (Source_Type => "input");
542 -- Otherwise, close the output file, and we are done
544 elsif Outfile /= Standard_Output then
545 Close (Text_Outfile);
547 end Process_One_File;
549 -----------------------
550 -- Recursive_Process --
551 -----------------------
553 procedure Recursive_Process (In_Dir : String; Out_Dir : String) is
555 Name : String (1 .. 255);
557 In_Dir_Name : Name_Id;
558 Out_Dir_Name : Name_Id;
560 procedure Set_Directory_Names;
561 -- Establish or reestablish the current input and output directories
563 -------------------------
564 -- Set_Directory_Names --
565 -------------------------
567 procedure Set_Directory_Names is
569 Input_Directory := In_Dir_Name;
570 Output_Directory := Out_Dir_Name;
571 end Set_Directory_Names;
573 -- Start of processing for Recursive_Process
576 -- Open the current input directory
579 Open (Dir_In, In_Dir);
582 when Directory_Error =>
583 Fail ("could not read directory " & In_Dir);
586 -- Set the new input and output directory names
588 Name_Len := In_Dir'Length;
589 Name_Buffer (1 .. Name_Len) := In_Dir;
590 In_Dir_Name := Name_Find;
591 Name_Len := Out_Dir'Length;
592 Name_Buffer (1 .. Name_Len) := Out_Dir;
593 Out_Dir_Name := Name_Find;
597 -- Traverse the input directory
599 Read (Dir_In, Name, Last);
602 if Name (1 .. Last) /= "." and then Name (1 .. Last) /= ".." then
604 Input : constant String :=
605 In_Dir & Directory_Separator & Name (1 .. Last);
606 Output : constant String :=
607 Out_Dir & Directory_Separator & Name (1 .. Last);
610 -- If input is an ordinary file, process it
612 if Is_Regular_File (Input) then
613 -- First get the output file name
616 Name_Buffer (1 .. Name_Len) := Name (1 .. Last);
617 Infile_Name := Name_Find;
618 Preprocess_Infile_Name;
620 -- Set the input file name and process the file
622 Name_Len := Input'Length;
623 Name_Buffer (1 .. Name_Len) := Input;
624 Infile_Name := Name_Find;
627 elsif Is_Directory (Input) then
628 -- Input is a directory. If the corresponding output
629 -- directory does not already exist, create it.
631 if not Is_Directory (Output) then
633 Make_Dir (Dir_Name => Output);
636 when Directory_Error =>
637 Fail ("could not create directory """
643 -- And process this new input directory
645 Recursive_Process (Input, Output);
647 -- Reestablish the input and output directory names
648 -- that have been modified by the recursive call.
655 end Recursive_Process;
657 -- Start of processing for Process_Files
660 if Output_Directory = No_Name then
662 -- If the output is not a directory, fail if the input is
663 -- an existing directory, to avoid possible problems.
665 if Is_Directory (Get_Name_String (Infile_Name)) then
666 Fail ("input file """ & Get_Name_String (Infile_Name) &
667 """ is a directory");
670 -- Just process the single input file
674 elsif Input_Directory = No_Name then
676 -- Get the output file name from the input file name, and process
677 -- the single input file.
679 Preprocess_Infile_Name;
683 -- Recursively process files in the directory tree rooted at the
687 (In_Dir => Get_Name_String (Input_Directory),
688 Out_Dir => Get_Name_String (Output_Directory));
692 -------------------------
693 -- Put_Char_To_Outfile --
694 -------------------------
696 procedure Put_Char_To_Outfile (C : Character) is
698 Put (Outfile.all, C);
699 end Put_Char_To_Outfile;
701 -----------------------
702 -- Scan_Command_Line --
703 -----------------------
705 procedure Scan_Command_Line is
708 procedure Check_Version_And_Help is new Check_Version_And_Help_G (Usage);
710 -- Start of processing for Scan_Command_Line
713 -- First check for --version or --help
715 Check_Version_And_Help ("GNATPREP", "1996");
717 -- Now scan the other switches
719 GNAT.Command_Line.Initialize_Option_Scan;
723 Switch := GNAT.Command_Line.Getopt ("D: b c C r s T u v");
731 Process_Command_Line_Symbol_Definition
732 (S => GNAT.Command_Line.Parameter);
735 Opt.Blank_Deleted_Lines := True;
738 Opt.Comment_Deleted_Lines := True;
741 Opt.Replace_In_Comments := True;
744 Source_Ref_Pragma := True;
747 Opt.List_Preprocessing_Symbols := True;
750 Unix_Line_Terminators := True;
753 Opt.Undefined_Symbols_Are_False := True;
756 Opt.Verbose_Mode := True;
759 Fail ("Invalid Switch: -" & Switch);
763 when GNAT.Command_Line.Invalid_Switch =>
764 Write_Str ("Invalid Switch: -");
765 Write_Line (GNAT.Command_Line.Full_Switch);
771 -- Get the file names
775 S : constant String := GNAT.Command_Line.Get_Argument;
778 exit when S'Length = 0;
780 Name_Len := S'Length;
781 Name_Buffer (1 .. Name_Len) := S;
783 if Infile_Name = No_Name then
784 Infile_Name := Name_Find;
785 elsif Outfile_Name = No_Name then
786 Outfile_Name := Name_Find;
787 elsif Deffile_Name = No_Name then
788 Deffile_Name := Name_Find;
790 Fail ("too many arguments specified");
794 end Scan_Command_Line;
803 Write_Line ("Usage: gnatprep [-bcrsuv] [-Dsymbol=value] " &
804 "infile outfile [deffile]");
806 Write_Line (" infile Name of the input file");
807 Write_Line (" outfile Name of the output file");
808 Write_Line (" deffile Name of the definition file");
810 Write_Line ("gnatprep switches:");
811 Write_Line (" -b Replace preprocessor lines by blank lines");
812 Write_Line (" -c Keep preprocessor lines as comments");
813 Write_Line (" -C Do symbol replacements within comments");
814 Write_Line (" -D Associate symbol with value");
815 Write_Line (" -r Generate Source_Reference pragma");
816 Write_Line (" -s Print a sorted list of symbol names and values");
817 Write_Line (" -T Use LF as line terminators");
818 Write_Line (" -u Treat undefined symbols as FALSE");
819 Write_Line (" -v Verbose mode");