Merge from mainline
[official-gcc.git] / gcc / ada / prepcomp.adb
blob7fd1984cc55e2c49e2341356446113cb0a1c3b44
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-2006, 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, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, 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;
139 begin
140 for J in 1 .. Symbol_Table.Last (Command_Line_Symbols) loop
141 Symbol_Id := Prep.Index_Of (Command_Line_Symbols.Table (J).Symbol);
143 if Symbol_Id = No_Symbol then
144 Symbol_Table.Increment_Last (Prep.Mapping);
145 Symbol_Id := Symbol_Table.Last (Prep.Mapping);
146 end if;
148 Prep.Mapping.Table (Symbol_Id) := Command_Line_Symbols.Table (J);
149 end loop;
150 end Add_Command_Line_Symbols;
152 ----------------------
153 -- Add_Dependencies --
154 ----------------------
156 procedure Add_Dependencies is
157 begin
158 for Index in 1 .. Dependencies.Last loop
159 Add_Preprocessing_Dependency (Dependencies.Table (Index));
160 end loop;
161 end Add_Dependencies;
163 ---------------------------
164 -- Add_Symbol_Definition --
165 ---------------------------
167 procedure Add_Symbol_Definition (Def : String) is
168 begin
169 -- If Symbol_Definitions is not large enough, double it
171 if Last_Definition = Symbol_Definitions'Last then
172 declare
173 New_Symbol_Definitions : constant String_Array_Ptr :=
174 new String_Array (1 .. 2 * Last_Definition);
176 begin
177 New_Symbol_Definitions (Symbol_Definitions'Range) :=
178 Symbol_Definitions.all;
179 Free (Symbol_Definitions);
180 Symbol_Definitions := New_Symbol_Definitions;
181 end;
182 end if;
184 Last_Definition := Last_Definition + 1;
185 Symbol_Definitions (Last_Definition) := new String'(Def);
186 end Add_Symbol_Definition;
188 -------------------
189 -- Check_Symbols --
190 -------------------
192 procedure Check_Symbols is
193 begin
194 -- If there is at least one switch -gnateD specified
196 if Symbol_Table.Last (Command_Line_Symbols) >= 1 then
197 Current_Data := No_Preproc_Data;
198 No_Preprocessing := False;
199 Current_Data.Processed := True;
201 -- Start with an empty, initialized mapping table; use Prep.Mapping,
202 -- because Prep.Index_Of uses Prep.Mapping.
204 Prep.Mapping := No_Mapping;
205 Symbol_Table.Init (Prep.Mapping);
207 -- Add the command line symbols
209 Add_Command_Line_Symbols;
211 -- Put the resulting Prep.Mapping in Current_Data, and immediately
212 -- set Prep.Mapping to nil.
214 Current_Data.Mapping := Prep.Mapping;
215 Prep.Mapping := No_Mapping;
217 -- Set the default data
219 Default_Data := Current_Data;
220 Default_Data_Defined := True;
221 end if;
222 end Check_Symbols;
224 ------------------------------
225 -- Parse_Preprocessing_Data --
226 ------------------------------
228 procedure Parse_Preprocessing_Data_File (N : File_Name_Type) is
229 OK : Boolean := False;
230 Dash_Location : Source_Ptr;
231 Symbol_Data : Prep.Symbol_Data;
232 Symbol_Id : Prep.Symbol_Id;
233 T : constant Nat := Total_Errors_Detected;
235 begin
236 -- Load the preprocessing data file
238 Source_Index_Of_Preproc_Data_File := Load_Preprocessing_Data_File (N);
240 -- Fail if preprocessing data file cannot be found
242 if Source_Index_Of_Preproc_Data_File = No_Source_File then
243 Get_Name_String (N);
244 Fail ("preprocessing data file """,
245 Name_Buffer (1 .. Name_Len),
246 """ not found");
247 end if;
249 -- Initialize the sanner and set its behavior for a processing data file
251 Scn.Scanner.Initialize_Scanner (Source_Index_Of_Preproc_Data_File);
252 Scn.Scanner.Set_End_Of_Line_As_Token (True);
253 Scn.Scanner.Reset_Special_Characters;
255 For_Each_Line : 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
343 if Token /= Tok_Minus then
344 Error_Msg ("`'-` expected", Token_Ptr);
345 Skip_To_End_Of_Line;
346 goto Scan_Line;
347 end if;
349 -- Keep the location of the '-' for possible error reporting
351 Dash_Location := Token_Ptr;
353 -- Scan past the '-'
355 Scan;
356 OK := False;
357 Change_Reserved_Keyword_To_Symbol;
359 -- An identifier (or a reserved word converted to an
360 -- identifier) is expected and there must be no blank space
361 -- between the '-' and the identifier.
363 if Token = Tok_Identifier
364 and then Token_Ptr = Dash_Location + 1
365 then
366 Get_Name_String (Token_Name);
368 -- Check the character in the source, because the case is
369 -- significant.
371 case Sinput.Source (Token_Ptr) is
372 when 'u' =>
374 -- Undefined symbol are False
376 if Name_Len = 1 then
377 Current_Data.Undef_False := True;
378 OK := True;
379 end if;
381 when 'b' =>
383 -- Blank lines
385 if Name_Len = 1 then
386 Current_Data.Always_Blank := True;
387 OK := True;
388 end if;
390 when 'c' =>
392 -- Comment removed lines
394 if Name_Len = 1 then
395 Current_Data.Comments := True;
396 OK := True;
397 end if;
399 when 's' =>
401 -- List symbols
403 if Name_Len = 1 then
404 Current_Data.List_Symbols := True;
405 OK := True;
406 end if;
408 when 'D' =>
410 -- Symbol definition
412 OK := Name_Len > 1;
414 if OK then
416 -- A symbol must be an Ada identifier; it cannot start
417 -- with an underline or a digit.
419 if Name_Buffer (2) = '_'
420 or Name_Buffer (2) in '0' .. '9'
421 then
422 Error_Msg ("symbol expected", Token_Ptr + 1);
423 Skip_To_End_Of_Line;
424 goto Scan_Line;
425 end if;
427 -- Get the name id of the symbol
429 Symbol_Data.On_The_Command_Line := True;
430 Name_Buffer (1 .. Name_Len - 1) :=
431 Name_Buffer (2 .. Name_Len);
432 Name_Len := Name_Len - 1;
433 Symbol_Data.Symbol := Name_Find;
435 if Name_Buffer (1 .. Name_Len) = "if"
436 or else Name_Buffer (1 .. Name_Len) = "else"
437 or else Name_Buffer (1 .. Name_Len) = "elsif"
438 or else Name_Buffer (1 .. Name_Len) = "end"
439 or else Name_Buffer (1 .. Name_Len) = "not"
440 or else Name_Buffer (1 .. Name_Len) = "and"
441 or else Name_Buffer (1 .. Name_Len) = "then"
442 then
443 Error_Msg ("symbol expected", Token_Ptr + 1);
444 Skip_To_End_Of_Line;
445 goto Scan_Line;
446 end if;
448 -- Get the name id of the original symbol, with
449 -- possibly capital letters.
451 Name_Len := Integer (Scan_Ptr - Token_Ptr - 1);
453 for J in 1 .. Name_Len loop
454 Name_Buffer (J) :=
455 Sinput.Source (Token_Ptr + Text_Ptr (J));
456 end loop;
458 Symbol_Data.Original := Name_Find;
460 -- Scan past D<symbol>
462 Scan;
464 if Token /= Tok_Equal then
465 Error_Msg ("`=` expected", Token_Ptr);
466 Skip_To_End_Of_Line;
467 goto Scan_Line;
468 end if;
470 -- Scan past '='
472 Scan;
474 -- Here any reserved word is OK
476 Change_Reserved_Keyword_To_Symbol
477 (All_Keywords => True);
479 -- Value can be an identifier (or a reserved word)
480 -- or a literal string.
482 case Token is
483 when Tok_String_Literal =>
484 Symbol_Data.Is_A_String := True;
485 Symbol_Data.Value := String_Literal_Id;
487 when Tok_Identifier =>
488 Symbol_Data.Is_A_String := False;
489 Start_String;
491 for J in Token_Ptr .. Scan_Ptr - 1 loop
492 Store_String_Char (Sinput.Source (J));
493 end loop;
495 Symbol_Data.Value := End_String;
497 when others =>
498 Error_Msg
499 ("literal string or identifier expected",
500 Token_Ptr);
501 Skip_To_End_Of_Line;
502 goto Scan_Line;
503 end case;
505 -- If symbol already exists, replace old definition
506 -- by new one.
508 Symbol_Id := Prep.Index_Of (Symbol_Data.Symbol);
510 -- Otherwise, add a new entry in the table
512 if Symbol_Id = No_Symbol then
513 Symbol_Table.Increment_Last (Prep.Mapping);
514 Symbol_Id := Symbol_Table.Last (Mapping);
515 end if;
517 Prep.Mapping.Table (Symbol_Id) := Symbol_Data;
518 end if;
520 when others =>
521 null;
522 end case;
524 Scan;
525 end if;
527 if not OK then
528 Error_Msg ("invalid switch", Dash_Location);
529 Skip_To_End_Of_Line;
530 goto Scan_Line;
531 end if;
532 end loop;
534 -- Add the command line symbols, if any, possibly replacing symbols
535 -- just defined.
537 Add_Command_Line_Symbols;
539 -- Put the resulting Prep.Mapping in Current_Data, and immediately
540 -- set Prep.Mapping to nil.
542 Current_Data.Mapping := Prep.Mapping;
543 Prep.Mapping := No_Mapping;
545 -- Record Current_Data
547 if Current_Data.File_Name = No_Name then
548 Default_Data := Current_Data;
550 else
551 Preproc_Data_Table.Increment_Last;
552 Preproc_Data_Table.Table (Preproc_Data_Table.Last) := Current_Data;
553 end if;
555 Current_Data := No_Preproc_Data;
556 end loop For_Each_Line;
558 Scn.Scanner.Set_End_Of_Line_As_Token (False);
560 -- Fail if there were errors in the preprocessing data file
562 if Total_Errors_Detected > T then
563 Errout.Finalize;
564 Fail ("errors found in preprocessing data file """,
565 Get_Name_String (N),
566 """");
567 end if;
569 -- Record the dependency on the preprocessor data file
571 Dependencies.Increment_Last;
572 Dependencies.Table (Dependencies.Last) :=
573 Source_Index_Of_Preproc_Data_File;
574 end Parse_Preprocessing_Data_File;
576 ---------------------------
577 -- Prepare_To_Preprocess --
578 ---------------------------
580 procedure Prepare_To_Preprocess
581 (Source : File_Name_Type;
582 Preprocessing_Needed : out Boolean)
584 Default : Boolean := False;
585 Index : Int := 0;
587 begin
588 -- By default, preprocessing is not needed
590 Preprocessing_Needed := False;
592 if No_Preprocessing then
593 return;
594 end if;
596 -- First, look for preprocessing data specific to the current source
598 for J in 1 .. Preproc_Data_Table.Last loop
599 if Preproc_Data_Table.Table (J).File_Name = Source then
600 Index := J;
601 Current_Data := Preproc_Data_Table.Table (J);
602 exit;
603 end if;
604 end loop;
606 -- If no specific preprocessing data, then take the default
608 if Index = 0 then
609 if Default_Data_Defined then
610 Current_Data := Default_Data;
611 Default := True;
613 else
614 -- If no default, then nothing to do
616 return;
617 end if;
618 end if;
620 -- Set the preprocessing flags according to the preprocessing data
622 if Current_Data.Comments and then not Current_Data.Always_Blank then
623 Comment_Deleted_Lines := True;
624 Blank_Deleted_Lines := False;
626 else
627 Comment_Deleted_Lines := False;
628 Blank_Deleted_Lines := True;
629 end if;
631 Undefined_Symbols_Are_False := Current_Data.Undef_False;
632 List_Preprocessing_Symbols := Current_Data.List_Symbols;
634 -- If not already done it, process the definition file
636 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 (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;