2005-01-16 Steven G. Kargl <kargls@comcast.net>
[official-gcc.git] / gcc / ada / prepcomp.adb
blobf131d7e4d13db0326eddd610a20482b747257d2a
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- P R E P C O M P --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 2003, Free Software Foundation, Inc. --
10 -- --
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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
21 -- --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 -- --
25 ------------------------------------------------------------------------------
27 with Ada.Unchecked_Deallocation;
29 with Errout; use Errout;
30 with Namet; use Namet;
31 with Lib.Writ; use Lib.Writ;
32 with Opt; use Opt;
33 with Osint; use Osint;
34 with Prep; use Prep;
35 with Scans; use Scans;
36 with Scn; use Scn;
37 with Sinput.L; use Sinput.L;
38 with Stringt; use Stringt;
39 with Table;
41 package body Prepcomp is
43 No_Preprocessing : Boolean := True;
44 -- Set to True if there is at least one source that needs to be
45 -- preprocessed.
47 Source_Index_Of_Preproc_Data_File : Source_File_Index := No_Source_File;
49 -- The following variable should be a constant, but this is not
50 -- possible. Warnings are Off because it is never assigned a value.
52 pragma Warnings (Off);
53 No_Mapping : Prep.Symbol_Table.Instance;
54 pragma Warnings (On);
56 type String_Ptr is access String;
57 type String_Array is array (Positive range <>) of String_Ptr;
58 type String_Array_Ptr is access String_Array;
60 procedure Free is
61 new Ada.Unchecked_Deallocation (String_Array, String_Array_Ptr);
63 Symbol_Definitions : String_Array_Ptr := new String_Array (1 .. 4);
64 -- An extensible array to temporarily stores symbol definitions specified
65 -- on the command line with -gnateD switches.
67 Last_Definition : Natural := 0;
68 -- Index of last symbol definition in array Symbol_Definitions
70 type Preproc_Data is record
71 Mapping : Symbol_Table.Instance;
72 File_Name : Name_Id := No_Name;
73 Deffile : String_Id := No_String;
74 Undef_False : Boolean := False;
75 Always_Blank : Boolean := False;
76 Comments : Boolean := False;
77 List_Symbols : Boolean := False;
78 Processed : Boolean := False;
79 end record;
80 -- Structure to keep the preprocessing data for a file name or for the
81 -- default (when Name_Id = No_Name).
83 No_Preproc_Data : constant Preproc_Data :=
84 (Mapping => No_Mapping,
85 File_Name => No_Name,
86 Deffile => No_String,
87 Undef_False => False,
88 Always_Blank => False,
89 Comments => False,
90 List_Symbols => False,
91 Processed => False);
93 Default_Data : Preproc_Data := No_Preproc_Data;
94 -- The preprocessing data to be used when no specific preprocessing data
95 -- is specified for a source.
97 Default_Data_Defined : Boolean := False;
98 -- True if source for which no specific preprocessing is specified need to
99 -- be preprocess with the Default_Data.
101 Current_Data : Preproc_Data := No_Preproc_Data;
103 package Preproc_Data_Table is new Table.Table
104 (Table_Component_Type => Preproc_Data,
105 Table_Index_Type => Int,
106 Table_Low_Bound => 1,
107 Table_Initial => 5,
108 Table_Increment => 5,
109 Table_Name => "Prepcomp.Preproc_Data_Table");
110 -- Table to store the specific preprocessing data
112 Command_Line_Symbols : Symbol_Table.Instance;
113 -- A table to store symbol definitions specified on the command line with
114 -- -gnateD switches.
116 package Dependencies is new Table.Table
117 (Table_Component_Type => Source_File_Index,
118 Table_Index_Type => Int,
119 Table_Low_Bound => 1,
120 Table_Initial => 5,
121 Table_Increment => 5,
122 Table_Name => "Prepcomp.Dependencies");
123 -- Table to store the dependencies on preprocessing files
125 procedure Add_Command_Line_Symbols;
126 -- Add the command line symbol definitions, if any, to the
127 -- Prep.Mapping table.
129 procedure Skip_To_End_Of_Line;
130 -- Ignore errors and scan up to the next end of line or the end of file
132 ------------------------------
133 -- Add_Command_Line_Symbols --
134 ------------------------------
136 procedure Add_Command_Line_Symbols is
137 Symbol_Id : Prep.Symbol_Id;
138 begin
139 for J in 1 .. Symbol_Table.Last (Command_Line_Symbols) loop
140 Symbol_Id := Prep.Index_Of (Command_Line_Symbols.Table (J).Symbol);
142 if Symbol_Id = No_Symbol then
143 Symbol_Table.Increment_Last (Prep.Mapping);
144 Symbol_Id := Symbol_Table.Last (Prep.Mapping);
145 end if;
147 Prep.Mapping.Table (Symbol_Id) := Command_Line_Symbols.Table (J);
148 end loop;
149 end Add_Command_Line_Symbols;
151 ----------------------
152 -- Add_Dependencies --
153 ----------------------
155 procedure Add_Dependencies is
156 begin
157 for Index in 1 .. Dependencies.Last loop
158 Add_Preprocessing_Dependency (Dependencies.Table (Index));
159 end loop;
160 end Add_Dependencies;
162 ---------------------------
163 -- Add_Symbol_Definition --
164 ---------------------------
166 procedure Add_Symbol_Definition (Def : String) is
167 begin
168 -- If Symbol_Definitions is not large enough, double it
170 if Last_Definition = Symbol_Definitions'Last then
171 declare
172 New_Symbol_Definitions : constant String_Array_Ptr :=
173 new String_Array (1 .. 2 * Last_Definition);
175 begin
176 New_Symbol_Definitions (Symbol_Definitions'Range) :=
177 Symbol_Definitions.all;
178 Free (Symbol_Definitions);
179 Symbol_Definitions := New_Symbol_Definitions;
180 end;
181 end if;
183 Last_Definition := Last_Definition + 1;
184 Symbol_Definitions (Last_Definition) := new String'(Def);
185 end Add_Symbol_Definition;
187 -------------------
188 -- Check_Symbols --
189 -------------------
191 procedure Check_Symbols is
192 begin
193 -- If there is at least one switch -gnateD specified
195 if Symbol_Table.Last (Command_Line_Symbols) >= 1 then
196 Current_Data := No_Preproc_Data;
197 No_Preprocessing := False;
198 Current_Data.Processed := True;
200 -- Start with an empty, initialized mapping table; use Prep.Mapping,
201 -- because Prep.Index_Of uses Prep.Mapping.
203 Prep.Mapping := No_Mapping;
204 Symbol_Table.Init (Prep.Mapping);
206 -- Add the command line symbols
208 Add_Command_Line_Symbols;
210 -- Put the resulting Prep.Mapping in Current_Data, and immediately
211 -- set Prep.Mapping to nil.
213 Current_Data.Mapping := Prep.Mapping;
214 Prep.Mapping := No_Mapping;
216 -- Set the default data
218 Default_Data := Current_Data;
219 Default_Data_Defined := True;
220 end if;
221 end Check_Symbols;
223 ------------------------------
224 -- Parse_Preprocessing_Data --
225 ------------------------------
227 procedure Parse_Preprocessing_Data_File (N : File_Name_Type) is
228 OK : Boolean := False;
229 Dash_Location : Source_Ptr;
230 Symbol_Data : Prep.Symbol_Data;
231 Symbol_Id : Prep.Symbol_Id;
232 T : constant Nat := Total_Errors_Detected;
234 begin
235 -- Load the preprocessing data file
237 Source_Index_Of_Preproc_Data_File := Load_Preprocessing_Data_File (N);
239 -- Fail if preprocessing data file cannot be found
241 if Source_Index_Of_Preproc_Data_File = No_Source_File then
242 Get_Name_String (N);
243 Fail ("preprocessing data file """,
244 Name_Buffer (1 .. Name_Len),
245 """ not found");
246 end if;
248 -- Initialize the sanner and set its behavior for a processing data file
249 Scn.Scanner.Initialize_Scanner
250 (No_Unit, Source_Index_Of_Preproc_Data_File);
251 Scn.Scanner.Set_End_Of_Line_As_Token (True);
252 Scn.Scanner.Reset_Special_Characters;
254 For_Each_Line :
255 loop
256 <<Scan_Line>>
257 Scan;
259 exit For_Each_Line when Token = Tok_EOF;
261 if Token = Tok_End_Of_Line then
262 goto Scan_Line;
263 end if;
265 -- Line is not empty
267 OK := False;
268 No_Preprocessing := False;
269 Current_Data := No_Preproc_Data;
271 case Token is
272 when Tok_Asterisk =>
274 -- Default data
276 if Default_Data_Defined then
277 Error_Msg
278 ("multiple default preprocessing data", Token_Ptr);
280 else
281 OK := True;
282 Default_Data_Defined := True;
283 end if;
285 when Tok_String_Literal =>
287 -- Specific data
289 String_To_Name_Buffer (String_Literal_Id);
290 Canonical_Case_File_Name (Name_Buffer (1 .. Name_Len));
291 Current_Data.File_Name := Name_Find;
292 OK := True;
294 for Index in 1 .. Preproc_Data_Table.Last loop
295 if Current_Data.File_Name =
296 Preproc_Data_Table.Table (Index).File_Name
297 then
298 Error_Msg_Name_1 := Current_Data.File_Name;
299 Error_Msg
300 ("multiple preprocessing data for{", Token_Ptr);
301 OK := False;
302 exit;
303 end if;
304 end loop;
306 when others =>
307 Error_Msg ("`'*` or literal string expected", Token_Ptr);
308 end case;
310 -- If there is a problem, skip the line
312 if not OK then
313 Skip_To_End_Of_Line;
314 goto Scan_Line;
315 end if;
317 -- Scan past the * or the literal string
319 Scan;
321 -- A literal string in second position is a definition file
323 if Token = Tok_String_Literal then
324 Current_Data.Deffile := String_Literal_Id;
325 Current_Data.Processed := False;
326 Scan;
328 else
329 -- If there is no definition file, set Processed to True now
331 Current_Data.Processed := True;
332 end if;
334 -- Start with an empty, initialized mapping table; use Prep.Mapping,
335 -- because Prep.Index_Of uses Prep.Mapping.
337 Prep.Mapping := No_Mapping;
338 Symbol_Table.Init (Prep.Mapping);
340 -- Check the switches that may follow
342 while Token /= Tok_End_Of_Line and then Token /= Tok_EOF loop
344 if Token /= Tok_Minus then
345 Error_Msg ("`'-` expected", Token_Ptr);
346 Skip_To_End_Of_Line;
347 goto Scan_Line;
348 end if;
350 -- Keep the location of the '-' for possible error reporting
352 Dash_Location := Token_Ptr;
354 -- Scan past the '-'
356 Scan;
357 OK := False;
358 Change_Reserved_Keyword_To_Symbol;
360 -- An identifier (or a reserved word converted to an
361 -- identifier) is expected and there must be no blank space
362 -- between the '-' and the identifier.
364 if Token = Tok_Identifier
365 and then Token_Ptr = Dash_Location + 1
366 then
367 Get_Name_String (Token_Name);
369 -- Check the character in the source, because the case is
370 -- significant.
372 case Sinput.Source (Token_Ptr) is
373 when 'u' =>
375 -- Undefined symbol are False
377 if Name_Len = 1 then
378 Current_Data.Undef_False := True;
379 OK := True;
380 end if;
382 when 'b' =>
384 -- Blank lines
386 if Name_Len = 1 then
387 Current_Data.Always_Blank := True;
388 OK := True;
389 end if;
391 when 'c' =>
393 -- Comment removed lines
395 if Name_Len = 1 then
396 Current_Data.Comments := True;
397 OK := True;
398 end if;
400 when 's' =>
402 -- List symbols
404 if Name_Len = 1 then
405 Current_Data.List_Symbols := True;
406 OK := True;
407 end if;
409 when 'D' =>
411 -- Symbol definition
413 OK := Name_Len > 1;
415 if OK then
417 -- A symbol must be an Ada identifier; it cannot start
418 -- with an underline or a digit.
420 if Name_Buffer (2) = '_'
421 or Name_Buffer (2) in '0' .. '9'
422 then
423 Error_Msg ("symbol expected", Token_Ptr + 1);
424 Skip_To_End_Of_Line;
425 goto Scan_Line;
426 end if;
428 -- Get the name id of the symbol
430 Symbol_Data.On_The_Command_Line := True;
431 Name_Buffer (1 .. Name_Len - 1) :=
432 Name_Buffer (2 .. Name_Len);
433 Name_Len := Name_Len - 1;
434 Symbol_Data.Symbol := Name_Find;
436 if Name_Buffer (1 .. Name_Len) = "if"
437 or else Name_Buffer (1 .. Name_Len) = "else"
438 or else Name_Buffer (1 .. Name_Len) = "elsif"
439 or else Name_Buffer (1 .. Name_Len) = "end"
440 or else Name_Buffer (1 .. Name_Len) = "not"
441 or else Name_Buffer (1 .. Name_Len) = "and"
442 or else Name_Buffer (1 .. Name_Len) = "then"
443 then
444 Error_Msg ("symbol expected", Token_Ptr + 1);
445 Skip_To_End_Of_Line;
446 goto Scan_Line;
447 end if;
449 -- Get the name id of the original symbol, with
450 -- possibly capital letters.
452 Name_Len := Integer (Scan_Ptr - Token_Ptr - 1);
454 for J in 1 .. Name_Len loop
455 Name_Buffer (J) :=
456 Sinput.Source (Token_Ptr + Text_Ptr (J));
457 end loop;
459 Symbol_Data.Original := Name_Find;
461 -- Scan past D<symbol>
463 Scan;
465 if Token /= Tok_Equal then
466 Error_Msg ("`=` expected", Token_Ptr);
467 Skip_To_End_Of_Line;
468 goto Scan_Line;
469 end if;
471 -- Scan past '='
473 Scan;
475 -- Here any reserved word is OK
477 Change_Reserved_Keyword_To_Symbol
478 (All_Keywords => True);
480 -- Value can be an identifier (or a reserved word)
481 -- or a literal string.
483 case Token is
484 when Tok_String_Literal =>
485 Symbol_Data.Is_A_String := True;
486 Symbol_Data.Value := String_Literal_Id;
488 when Tok_Identifier =>
489 Symbol_Data.Is_A_String := False;
490 Start_String;
492 for J in Token_Ptr .. Scan_Ptr - 1 loop
493 Store_String_Char (Sinput.Source (J));
494 end loop;
496 Symbol_Data.Value := End_String;
498 when others =>
499 Error_Msg
500 ("literal string or identifier expected",
501 Token_Ptr);
502 Skip_To_End_Of_Line;
503 goto Scan_Line;
504 end case;
506 -- If symbol already exists, replace old definition
507 -- by new one.
509 Symbol_Id := Prep.Index_Of (Symbol_Data.Symbol);
511 -- Otherwise, add a new entry in the table.
513 if Symbol_Id = No_Symbol then
514 Symbol_Table.Increment_Last (Prep.Mapping);
515 Symbol_Id := Symbol_Table.Last (Mapping);
516 end if;
518 Prep.Mapping.Table (Symbol_Id) := Symbol_Data;
519 end if;
521 when others =>
522 null;
523 end case;
525 Scan;
526 end if;
528 if not OK then
529 Error_Msg ("invalid switch", Dash_Location);
530 Skip_To_End_Of_Line;
531 goto Scan_Line;
532 end if;
533 end loop;
535 -- Add the command line symbols, if any, possibly replacing symbols
536 -- just defined.
538 Add_Command_Line_Symbols;
540 -- Put the resulting Prep.Mapping in Current_Data, and immediately
541 -- set Prep.Mapping to nil.
543 Current_Data.Mapping := Prep.Mapping;
544 Prep.Mapping := No_Mapping;
546 -- Record Current_Data
548 if Current_Data.File_Name = No_Name then
549 Default_Data := Current_Data;
551 else
552 Preproc_Data_Table.Increment_Last;
553 Preproc_Data_Table.Table (Preproc_Data_Table.Last) := Current_Data;
554 end if;
556 Current_Data := No_Preproc_Data;
557 end loop For_Each_Line;
559 Scn.Scanner.Set_End_Of_Line_As_Token (False);
561 -- Fail if there were errors in the preprocessing data file
563 if Total_Errors_Detected > T then
564 Errout.Finalize;
565 Fail ("errors found in preprocessing data file """,
566 Get_Name_String (N),
567 """");
568 end if;
570 -- Record the dependency on the preprocessor data file
572 Dependencies.Increment_Last;
573 Dependencies.Table (Dependencies.Last) :=
574 Source_Index_Of_Preproc_Data_File;
575 end Parse_Preprocessing_Data_File;
577 ---------------------------
578 -- Prepare_To_Preprocess --
579 ---------------------------
581 procedure Prepare_To_Preprocess
582 (Source : File_Name_Type;
583 Preprocessing_Needed : out Boolean)
585 Default : Boolean := False;
586 Index : Int := 0;
588 begin
589 -- By default, preprocessing is not needed
591 Preprocessing_Needed := False;
593 if No_Preprocessing then
594 return;
595 end if;
597 -- First, look for preprocessing data specific to the current source
599 for J in 1 .. Preproc_Data_Table.Last loop
600 if Preproc_Data_Table.Table (J).File_Name = Source then
601 Index := J;
602 Current_Data := Preproc_Data_Table.Table (J);
603 exit;
604 end if;
605 end loop;
607 -- If no specific preprocessing data, then take the default
609 if Index = 0 then
610 if Default_Data_Defined then
611 Current_Data := Default_Data;
612 Default := True;
614 else
615 -- If no default, then nothing to do
617 return;
618 end if;
619 end if;
621 -- Set the preprocessing flags according to the preprocessing data
623 if Current_Data.Comments and then not Current_Data.Always_Blank then
624 Comment_Deleted_Lines := True;
625 Blank_Deleted_Lines := False;
627 else
628 Comment_Deleted_Lines := False;
629 Blank_Deleted_Lines := True;
630 end if;
632 Undefined_Symbols_Are_False := Current_Data.Undef_False;
633 List_Preprocessing_Symbols := Current_Data.List_Symbols;
635 -- If not already done it, process the definition file
637 if Current_Data.Processed then
638 -- Set Prep.Mapping
640 Prep.Mapping := Current_Data.Mapping;
642 else
643 -- First put the mapping in Prep.Mapping, because Prep.Parse_Def_File
644 -- works on Prep.Mapping.
646 Prep.Mapping := Current_Data.Mapping;
648 String_To_Name_Buffer (Current_Data.Deffile);
650 declare
651 N : constant Name_Id := Name_Find;
652 Deffile : constant Source_File_Index := Load_Definition_File (N);
653 Add_Deffile : Boolean := True;
654 T : constant Nat := Total_Errors_Detected;
656 begin
657 if Deffile = No_Source_File then
658 Fail ("definition file """,
659 Get_Name_String (N),
660 """ cannot be found");
661 end if;
663 -- Initialize the preprocessor and set the characteristics of the
664 -- scanner for a definition file.
666 Prep.Initialize
667 (Error_Msg => Errout.Error_Msg'Access,
668 Scan => Scn.Scanner.Scan'Access,
669 Set_Ignore_Errors => Errout.Set_Ignore_Errors'Access,
670 Put_Char => null,
671 New_EOL => null);
673 Scn.Scanner.Set_End_Of_Line_As_Token (True);
674 Scn.Scanner.Reset_Special_Characters;
676 -- Initialize the scanner and process the definition file
678 Scn.Scanner.Initialize_Scanner (No_Unit, Deffile);
679 Prep.Parse_Def_File;
681 -- Reset the behaviour of the scanner to the default
683 Scn.Scanner.Set_End_Of_Line_As_Token (False);
685 -- Fail if errors were found while processing the definition file
687 if T /= Total_Errors_Detected then
688 Errout.Finalize;
689 Fail ("errors found in definition file """,
690 Get_Name_String (N),
691 """");
692 end if;
694 for Index in 1 .. Dependencies.Last loop
695 if Dependencies.Table (Index) = Deffile then
696 Add_Deffile := False;
697 exit;
698 end if;
699 end loop;
701 if Add_Deffile then
702 Dependencies.Increment_Last;
703 Dependencies.Table (Dependencies.Last) := Deffile;
704 end if;
705 end;
707 -- Get back the mapping, indicate that the definition file is
708 -- processed and store back the preprocessing data.
710 Current_Data.Mapping := Prep.Mapping;
711 Current_Data.Processed := True;
713 if Default then
714 Default_Data := Current_Data;
716 else
717 Preproc_Data_Table.Table (Index) := Current_Data;
718 end if;
719 end if;
721 Preprocessing_Needed := True;
722 end Prepare_To_Preprocess;
724 ---------------------------------------------
725 -- Process_Command_Line_Symbol_Definitions --
726 ---------------------------------------------
728 procedure Process_Command_Line_Symbol_Definitions is
729 Symbol_Data : Prep.Symbol_Data;
730 Found : Boolean := False;
732 begin
733 Symbol_Table.Init (Command_Line_Symbols);
735 -- The command line definitions have been stored temporarily in
736 -- array Symbol_Definitions.
738 for Index in 1 .. Last_Definition loop
739 -- Check each symbol definition, fail immediately if syntax is not
740 -- correct.
742 Check_Command_Line_Symbol_Definition
743 (Definition => Symbol_Definitions (Index).all,
744 Data => Symbol_Data);
745 Found := False;
747 -- If there is already a definition for this symbol, replace the old
748 -- definition by this one.
750 for J in 1 .. Symbol_Table.Last (Command_Line_Symbols) loop
751 if Command_Line_Symbols.Table (J).Symbol = Symbol_Data.Symbol then
752 Command_Line_Symbols.Table (J) := Symbol_Data;
753 Found := True;
754 exit;
755 end if;
756 end loop;
758 -- Otherwise, create a new entry in the table
760 if not Found then
761 Symbol_Table.Increment_Last (Command_Line_Symbols);
762 Command_Line_Symbols.Table
763 (Symbol_Table.Last (Command_Line_Symbols)) := Symbol_Data;
764 end if;
765 end loop;
766 end Process_Command_Line_Symbol_Definitions;
768 -------------------------
769 -- Skip_To_End_Of_Line --
770 -------------------------
772 procedure Skip_To_End_Of_Line is
773 begin
774 Set_Ignore_Errors (To => True);
776 while Token /= Tok_End_Of_Line and then Token /= Tok_EOF loop
777 Scan;
778 end loop;
780 Set_Ignore_Errors (To => False);
781 end Skip_To_End_Of_Line;
783 end Prepcomp;