OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [tags/] [gnu-src/] [gcc-4.5.1/] [gcc-4.5.1-or32-1.0rc3/] [gcc/] [ada/] [prj.ads] - Blame information for rev 516

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 281 jeremybenn
------------------------------------------------------------------------------
2
--                                                                          --
3
--                         GNAT COMPILER COMPONENTS                         --
4
--                                                                          --
5
--                                  P R J                                   --
6
--                                                                          --
7
--                                 S p e c                                  --
8
--                                                                          --
9
--          Copyright (C) 2001-2009, 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 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.          --
20
--                                                                          --
21
-- GNAT was originally developed  by the GNAT team at  New York University. --
22
-- Extensive contributions were provided by Ada Core Technologies Inc.      --
23
--                                                                          --
24
------------------------------------------------------------------------------
25
 
26
--  The following package declares the data types for GNAT project.
27
--  These data types may be used by GNAT Project-aware tools.
28
 
29
--  Children of these package implements various services on these data types.
30
--  See in particular Prj.Pars and Prj.Env.
31
 
32
with Casing; use Casing;
33
with Namet;  use Namet;
34
with Osint;
35
with Scans;  use Scans;
36
with Types;  use Types;
37
 
38
with GNAT.Dynamic_HTables; use GNAT.Dynamic_HTables;
39
with GNAT.Dynamic_Tables;
40
with GNAT.OS_Lib;          use GNAT.OS_Lib;
41
 
42
package Prj is
43
 
44
   All_Other_Names : constant Name_Id := Names_High_Bound;
45
   --  Name used to replace others as an index of an associative array
46
   --  attribute in situations where this is allowed.
47
 
48
   Subdirs : String_Ptr := null;
49
   --  The value after the equal sign in switch --subdirs=...
50
   --  Contains the relative subdirectory.
51
 
52
   type Library_Support is (None, Static_Only, Full);
53
   --  Support for Library Project File.
54
   --  - None: Library Project Files are not supported at all
55
   --  - Static_Only: Library Project Files are only supported for static
56
   --    libraries.
57
   --  - Full: Library Project Files are supported for static and dynamic
58
   --    (shared) libraries.
59
 
60
   type Yes_No_Unknown is (Yes, No, Unknown);
61
   --  Tri-state to decide if -lgnarl is needed when linking
62
 
63
   type Project_Qualifier is
64
     (Unspecified,
65
      Standard,
66
      Library,
67
      Configuration,
68
      Dry,
69
      Aggregate,
70
      Aggregate_Library);
71
   --  Qualifiers that can prefix the reserved word "project" in a project
72
   --  file:
73
   --    Standard:             standard project ...
74
   --    Library:              library project is ...
75
   --    Dry:                  abstract project is
76
   --    Aggregate:            aggregate project is
77
   --    Aggregate_Library:    aggregate library project is ...
78
   --    Configuration:        configuration project is ...
79
 
80
   All_Packages : constant String_List_Access;
81
   --  Default value of parameter Packages of procedures Parse, in Prj.Pars and
82
   --  Prj.Part, indicating that all packages should be checked.
83
 
84
   type Project_Tree_Data;
85
   type Project_Tree_Ref is access all Project_Tree_Data;
86
   --  Reference to a project tree. Several project trees may exist in memory
87
   --  at the same time.
88
 
89
   No_Project_Tree : constant Project_Tree_Ref;
90
 
91
   procedure Free (Tree : in out Project_Tree_Ref);
92
   --  Free memory associated with the tree
93
 
94
   Config_Project_File_Extension : String := ".cgpr";
95
   Project_File_Extension : String := ".gpr";
96
   --  The standard config and user project file name extensions. They are not
97
   --  constants, because Canonical_Case_File_Name is called on these variables
98
   --  in the body of Prj.
99
 
100
   function Empty_File   return File_Name_Type;
101
   function Empty_String return Name_Id;
102
   --  Return the id for an empty string ""
103
 
104
   type Path_Information is record
105
      Name         : Path_Name_Type := No_Path;
106
      Display_Name : Path_Name_Type := No_Path;
107
   end record;
108
   --  Directory names always end with a directory separator
109
 
110
   No_Path_Information : constant Path_Information := (No_Path, No_Path);
111
 
112
   type Project_Data;
113
   type Project_Id is access all Project_Data;
114
   No_Project : constant Project_Id := null;
115
   --  Id of a Project File
116
 
117
   type String_List_Id is new Nat;
118
   Nil_String : constant String_List_Id := 0;
119
   type String_Element is record
120
      Value         : Name_Id        := No_Name;
121
      Index         : Int            := 0;
122
      Display_Value : Name_Id        := No_Name;
123
      Location      : Source_Ptr     := No_Location;
124
      Flag          : Boolean        := False;
125
      Next          : String_List_Id := Nil_String;
126
   end record;
127
   --  To hold values for string list variables and array elements.
128
   --  Component Flag may be used for various purposes. For source
129
   --  directories, it indicates if the directory contains Ada source(s).
130
 
131
   package String_Element_Table is new GNAT.Dynamic_Tables
132
     (Table_Component_Type => String_Element,
133
      Table_Index_Type     => String_List_Id,
134
      Table_Low_Bound      => 1,
135
      Table_Initial        => 200,
136
      Table_Increment      => 100);
137
   --  The table for string elements in string lists
138
 
139
   type Variable_Kind is (Undefined, List, Single);
140
   --  Different kinds of variables
141
 
142
   subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
143
   --  The defined kinds of variables
144
 
145
   Ignored : constant Variable_Kind;
146
   --  Used to indicate that a package declaration must be ignored
147
   --  while processing the project tree (unknown package name).
148
 
149
   type Variable_Value (Kind : Variable_Kind := Undefined) is record
150
      Project  : Project_Id := No_Project;
151
      Location : Source_Ptr := No_Location;
152
      Default  : Boolean    := False;
153
      case Kind is
154
         when Undefined =>
155
            null;
156
         when List =>
157
            Values : String_List_Id := Nil_String;
158
         when Single =>
159
            Value : Name_Id := No_Name;
160
            Index : Int     := 0;
161
      end case;
162
   end record;
163
   --  Values for variables and array elements. Default is True if the
164
   --  current value is the default one for the variable.
165
 
166
   Nil_Variable_Value : constant Variable_Value;
167
   --  Value of a non existing variable or array element
168
 
169
   type Variable_Id is new Nat;
170
   No_Variable : constant Variable_Id := 0;
171
   type Variable is record
172
      Next  : Variable_Id := No_Variable;
173
      Name  : Name_Id;
174
      Value : Variable_Value;
175
   end record;
176
   --  To hold the list of variables in a project file and in packages
177
 
178
   package Variable_Element_Table is new GNAT.Dynamic_Tables
179
     (Table_Component_Type => Variable,
180
      Table_Index_Type     => Variable_Id,
181
      Table_Low_Bound      => 1,
182
      Table_Initial        => 200,
183
      Table_Increment      => 100);
184
   --  The table of variable in list of variables
185
 
186
   type Array_Element_Id is new Nat;
187
   No_Array_Element : constant Array_Element_Id := 0;
188
   type Array_Element is record
189
      Index                : Name_Id;
190
      Src_Index            : Int := 0;
191
      Index_Case_Sensitive : Boolean := True;
192
      Value                : Variable_Value;
193
      Next                 : Array_Element_Id := No_Array_Element;
194
   end record;
195
   --  Each Array_Element represents an array element and is linked (Next)
196
   --  to the next array element, if any, in the array.
197
 
198
   package Array_Element_Table is new GNAT.Dynamic_Tables
199
     (Table_Component_Type => Array_Element,
200
      Table_Index_Type     => Array_Element_Id,
201
      Table_Low_Bound      => 1,
202
      Table_Initial        => 200,
203
      Table_Increment      => 100);
204
   --  The table that contains all array elements
205
 
206
   type Array_Id is new Nat;
207
   No_Array : constant Array_Id := 0;
208
   type Array_Data is record
209
      Name     : Name_Id          := No_Name;
210
      Location : Source_Ptr       := No_Location;
211
      Value    : Array_Element_Id := No_Array_Element;
212
      Next     : Array_Id         := No_Array;
213
   end record;
214
   --  Each Array_Data value represents an array.
215
   --  Value is the id of the first element.
216
   --  Next is the id of the next array in the project file or package.
217
 
218
   package Array_Table is new GNAT.Dynamic_Tables
219
     (Table_Component_Type => Array_Data,
220
      Table_Index_Type     => Array_Id,
221
      Table_Low_Bound      => 1,
222
      Table_Initial        => 200,
223
      Table_Increment      => 100);
224
   --  The table that contains all arrays
225
 
226
   type Package_Id is new Nat;
227
   No_Package : constant Package_Id := 0;
228
   type Declarations is record
229
      Variables  : Variable_Id := No_Variable;
230
      Attributes : Variable_Id := No_Variable;
231
      Arrays     : Array_Id    := No_Array;
232
      Packages   : Package_Id  := No_Package;
233
   end record;
234
   --  Contains the declarations (variables, single and array attributes,
235
   --  packages) for a project or a package in a project.
236
 
237
   No_Declarations : constant Declarations :=
238
     (Variables  => No_Variable,
239
      Attributes => No_Variable,
240
      Arrays     => No_Array,
241
      Packages   => No_Package);
242
   --  Default value of Declarations: indicates that there is no declarations
243
 
244
   type Package_Element is record
245
      Name   : Name_Id      := No_Name;
246
      Decl   : Declarations := No_Declarations;
247
      Parent : Package_Id   := No_Package;
248
      Next   : Package_Id   := No_Package;
249
   end record;
250
   --  A package (includes declarations that may include other packages)
251
 
252
   package Package_Table is new GNAT.Dynamic_Tables
253
     (Table_Component_Type => Package_Element,
254
      Table_Index_Type     => Package_Id,
255
      Table_Low_Bound      => 1,
256
      Table_Initial        => 100,
257
      Table_Increment      => 100);
258
   --  The table that contains all packages
259
 
260
   type Language_Data;
261
   type Language_Ptr is access all Language_Data;
262
   --  Index of language data
263
 
264
   No_Language_Index : constant Language_Ptr := null;
265
   --  Constant indicating that there is no language data
266
 
267
   function Get_Language_From_Name
268
     (Project : Project_Id;
269
      Name    : String) return Language_Ptr;
270
   --  Get a language from a project. This might return null if no such
271
   --  language exists in the project
272
 
273
   Max_Header_Num : constant := 6150;
274
   type Header_Num is range 0 .. Max_Header_Num;
275
   --  Size for hash table below. The upper bound is an arbitrary value, the
276
   --  value here was chosen after testing to determine a good compromise
277
   --  between speed of access and memory usage.
278
 
279
   function Hash (Name : Name_Id)        return Header_Num;
280
   function Hash (Name : File_Name_Type) return Header_Num;
281
   function Hash (Name : Path_Name_Type) return Header_Num;
282
   function Hash (Project : Project_Id)  return Header_Num;
283
   --  Used for computing hash values for names put into hash tables
284
 
285
   type Language_Kind is (File_Based, Unit_Based);
286
   --  Type for the kind of language. All languages are file based, except Ada
287
   --  which is unit based.
288
 
289
   type Dependency_File_Kind is (None, Makefile, ALI_File);
290
   --  Type of dependency to be checked: no dependency file, Makefile fragment
291
   --  or ALI file (for Ada).
292
 
293
   Makefile_Dependency_Suffix : constant String := ".d";
294
   ALI_Dependency_Suffix      : constant String := ".ali";
295
 
296
   Switches_Dependency_Suffix : constant String := ".cswi";
297
 
298
   Binder_Exchange_Suffix     : constant String := ".bexch";
299
   --  Suffix for binder exchange files
300
 
301
   Library_Exchange_Suffix     : constant String := ".lexch";
302
   --  Suffix for library exchange files
303
 
304
   type Name_List_Index is new Nat;
305
   No_Name_List            : constant Name_List_Index := 0;
306
 
307
   type Name_Node is record
308
      Name : Name_Id         := No_Name;
309
      Next : Name_List_Index := No_Name_List;
310
   end record;
311
 
312
   package Name_List_Table is new GNAT.Dynamic_Tables
313
     (Table_Component_Type => Name_Node,
314
      Table_Index_Type     => Name_List_Index,
315
      Table_Low_Bound      => 1,
316
      Table_Initial        => 10,
317
      Table_Increment      => 100);
318
   --  The table for lists of names
319
 
320
   function Length
321
     (Table : Name_List_Table.Instance;
322
      List  : Name_List_Index) return Natural;
323
   --  Return the number of elements in specified list
324
 
325
   type Number_List_Index is new Nat;
326
   No_Number_List : constant Number_List_Index := 0;
327
 
328
   type Number_Node is record
329
      Number : Natural           := 0;
330
      Next   : Number_List_Index := No_Number_List;
331
   end record;
332
 
333
   package Number_List_Table is new GNAT.Dynamic_Tables
334
     (Table_Component_Type => Number_Node,
335
      Table_Index_Type     => Number_List_Index,
336
      Table_Low_Bound      => 1,
337
      Table_Initial        => 10,
338
      Table_Increment      => 100);
339
   --  The table for lists of numbers
340
 
341
   package Mapping_Files_Htable is new Simple_HTable
342
     (Header_Num => Header_Num,
343
      Element    => Path_Name_Type,
344
      No_Element => No_Path,
345
      Key        => Path_Name_Type,
346
      Hash       => Hash,
347
      Equal      => "=");
348
   --  A hash table to store the mapping files that are not used
349
 
350
   --  The following record ???
351
 
352
   type Lang_Naming_Data is record
353
      Dot_Replacement : File_Name_Type := No_File;
354
      --  The string to replace '.' in the source file name (for Ada)
355
 
356
      Casing : Casing_Type := All_Lower_Case;
357
      --  The casing of the source file name (for Ada)
358
 
359
      Separate_Suffix : File_Name_Type := No_File;
360
      --  String to append to unit name for source file name of an Ada subunit
361
 
362
      Spec_Suffix : File_Name_Type := No_File;
363
      --  The string to append to the unit name for the
364
      --  source file name of a spec.
365
 
366
      Body_Suffix : File_Name_Type := No_File;
367
      --  The string to append to the unit name for the
368
      --  source file name of a body.
369
   end record;
370
 
371
   No_Lang_Naming_Data : constant Lang_Naming_Data :=
372
                           (Dot_Replacement => No_File,
373
                            Casing          => All_Lower_Case,
374
                            Separate_Suffix => No_File,
375
                            Spec_Suffix     => No_File,
376
                            Body_Suffix     => No_File);
377
 
378
   function Is_Standard_GNAT_Naming (Naming : Lang_Naming_Data) return Boolean;
379
   --  True if the naming scheme is GNAT's default naming scheme. This
380
   --  is to take into account shortened names like "Ada." (a-), "System." (s-)
381
   --  and so on.
382
 
383
   type Source_Data;
384
   type Source_Id is access all Source_Data;
385
 
386
   function Is_Compilable (Source : Source_Id) return Boolean;
387
   pragma Inline (Is_Compilable);
388
   --  Return True if we know how to compile Source (i.e. if a compiler is
389
   --  defined). This doesn't indicate whether the source should be compiled.
390
 
391
   function Object_To_Global_Archive (Source : Source_Id) return Boolean;
392
   pragma Inline (Object_To_Global_Archive);
393
   --  Return True if the object file should be put in the global archive.
394
   --  This is for Ada, when only the closure of a main needs to be
395
   --  (re)compiled.
396
 
397
   function Other_Part (Source : Source_Id) return Source_Id;
398
   pragma Inline (Other_Part);
399
   --  Source ID for the other part, if any: for a spec, indicates its body;
400
   --  for a body, indicates its spec.
401
 
402
   No_Source : constant Source_Id := null;
403
 
404
   type Path_Syntax_Kind is
405
     (Canonical,
406
      --  Unix style
407
      Host);
408
      --  Host specific syntax, for example on VMS (the default)
409
 
410
   --  The following record describes the configuration of a language
411
 
412
   type Language_Config is record
413
      Kind : Language_Kind := File_Based;
414
      --  Kind of language. All languages are file based, except Ada which is
415
      --  unit based.
416
 
417
      Naming_Data : Lang_Naming_Data;
418
      --  The naming data for the languages (prefixes, etc.)
419
 
420
      Include_Compatible_Languages : Name_List_Index := No_Name_List;
421
      --  List of languages that are "include compatible" with this language. A
422
      --  language B (for example "C") is "include compatible" with a language
423
      --  A (for example "C++") if it is expected that sources of language A
424
      --  may "include" header files from language B.
425
 
426
      Compiler_Driver : File_Name_Type := No_File;
427
      --  The name of the executable for the compiler of the language
428
 
429
      Compiler_Driver_Path : String_Access := null;
430
      --  The path name of the executable for the compiler of the language
431
 
432
      Compiler_Leading_Required_Switches : Name_List_Index := No_Name_List;
433
      --  The list of initial switches that are required as a minimum to invoke
434
      --  the compiler driver.
435
 
436
      Compiler_Trailing_Required_Switches : Name_List_Index := No_Name_List;
437
      --  The list of final switches that are required as a minimum to invoke
438
      --  the compiler driver.
439
 
440
      Multi_Unit_Switches : Name_List_Index := No_Name_List;
441
      --  The switch(es) to indicate the index of a unit in a multi-source file
442
 
443
      Multi_Unit_Object_Separator : Character := ' ';
444
      --  The string separating the base name of a source from the index of the
445
      --  unit in a multi-source file, in the object file name.
446
 
447
      Path_Syntax : Path_Syntax_Kind := Host;
448
      --  Value may be Canonical (Unix style) or Host (host syntax, for example
449
      --  on VMS for DEC C).
450
 
451
      Object_File_Suffix : Name_Id := No_Name;
452
      --  Optional alternate object file suffix
453
 
454
      Object_File_Switches : Name_List_Index := No_Name_List;
455
      --  Optional object file switches. When this is defined, the switches
456
      --  are used to specify the object file. The object file name is appended
457
      --  to the last switch in the list. Example: ("-o", "").
458
 
459
      Compilation_PIC_Option : Name_List_Index := No_Name_List;
460
      --  The option(s) to compile a source in Position Independent Code for
461
      --  shared libraries. Specified in the configuration. When not specified,
462
      --  there is no need for such switch.
463
 
464
      Object_Generated : Boolean := True;
465
      --  False in no object file is generated
466
 
467
      Objects_Linked : Boolean := True;
468
      --  False if object files are not use to link executables and build
469
      --  libraries.
470
 
471
      Runtime_Library_Dir : Name_Id := No_Name;
472
      --  Path name of the runtime library directory, if any
473
 
474
      Runtime_Source_Dir : Name_Id := No_Name;
475
      --  Path name of the runtime source directory, if any
476
 
477
      Mapping_File_Switches : Name_List_Index := No_Name_List;
478
      --  The option(s) to provide a mapping file to the compiler. Specified in
479
      --  the configuration. When value is No_Name_List, there is no mapping
480
      --  file.
481
 
482
      Mapping_Spec_Suffix : File_Name_Type := No_File;
483
      --  Placeholder representing the spec suffix in a mapping file
484
 
485
      Mapping_Body_Suffix : File_Name_Type := No_File;
486
      --  Placeholder representing the body suffix in a mapping file
487
 
488
      Config_File_Switches : Name_List_Index := No_Name_List;
489
      --  The option(s) to provide a config file to the compiler. Specified in
490
      --  the configuration. If value is No_Name_List there is no config file.
491
 
492
      Dependency_Kind : Dependency_File_Kind := None;
493
      --  The kind of dependency to be checked: none, Makefile fragment or
494
      --  ALI file (for Ada).
495
 
496
      Dependency_Option : Name_List_Index := No_Name_List;
497
      --  The option(s) to be used to create the dependency file. When value is
498
      --  No_Name_List, there is not such option(s).
499
 
500
      Compute_Dependency : Name_List_Index := No_Name_List;
501
      --  Hold the value of attribute Dependency_Driver, if declared for the
502
      --  language.
503
 
504
      Include_Option : Name_List_Index := No_Name_List;
505
      --  Hold the value of attribute Include_Switches, if declared for the
506
      --  language.
507
 
508
      Include_Path : Name_Id := No_Name;
509
      --  Name of environment variable declared by attribute Include_Path for
510
      --  the language.
511
 
512
      Include_Path_File : Name_Id := No_Name;
513
      --  Name of environment variable declared by attribute Include_Path_File
514
      --  for the language.
515
 
516
      Objects_Path : Name_Id := No_Name;
517
      --  Name of environment variable declared by attribute Objects_Path for
518
      --  the language.
519
 
520
      Objects_Path_File : Name_Id := No_Name;
521
      --  Name of environment variable declared by attribute Objects_Path_File
522
      --  for the language.
523
 
524
      Config_Body : Name_Id := No_Name;
525
      --  The template for a pragma Source_File_Name(_Project) for a specific
526
      --  file name of a body.
527
 
528
      Config_Body_Index : Name_Id := No_Name;
529
      --  The template for a pragma Source_File_Name(_Project) for a specific
530
      --  file name of a body in a multi-source file.
531
 
532
      Config_Body_Pattern : Name_Id := No_Name;
533
      --  The template for a pragma Source_File_Name(_Project) for a naming
534
      --  body pattern.
535
 
536
      Config_Spec : Name_Id := No_Name;
537
      --  The template for a pragma Source_File_Name(_Project) for a specific
538
      --  file name of a spec.
539
 
540
      Config_Spec_Index : Name_Id := No_Name;
541
      --  The template for a pragma Source_File_Name(_Project) for a specific
542
      --  file name of a spec in a multi-source file.
543
 
544
      Config_Spec_Pattern : Name_Id := No_Name;
545
      --  The template for a pragma Source_File_Name(_Project) for a naming
546
      --  spec pattern.
547
 
548
      Config_File_Unique : Boolean := False;
549
      --  Indicate if the config file specified to the compiler needs to be
550
      --  unique. If it is unique, then all config files are concatenated into
551
      --  a temp config file.
552
 
553
      Binder_Driver : File_Name_Type := No_File;
554
      --  The name of the binder driver for the language, if any
555
 
556
      Binder_Driver_Path : Path_Name_Type := No_Path;
557
      --  The path name of the binder driver
558
 
559
      Binder_Required_Switches : Name_List_Index := No_Name_List;
560
      --  Hold the value of attribute Binder'Required_Switches for the language
561
 
562
      Binder_Prefix : Name_Id := No_Name;
563
      --  Hold the value of attribute Binder'Prefix for the language
564
 
565
      Toolchain_Version : Name_Id := No_Name;
566
      --  Hold the value of attribute Toolchain_Version for the language
567
 
568
      Toolchain_Description : Name_Id := No_Name;
569
      --  Hold the value of attribute Toolchain_Description for the language
570
 
571
   end record;
572
 
573
   No_Language_Config : constant Language_Config :=
574
                          (Kind                         => File_Based,
575
                           Naming_Data                  => No_Lang_Naming_Data,
576
                           Include_Compatible_Languages => No_Name_List,
577
                           Compiler_Driver              => No_File,
578
                           Compiler_Driver_Path         => null,
579
                           Compiler_Leading_Required_Switches  => No_Name_List,
580
                           Compiler_Trailing_Required_Switches => No_Name_List,
581
                           Multi_Unit_Switches          => No_Name_List,
582
                           Multi_Unit_Object_Separator  => ' ',
583
                           Path_Syntax                  => Canonical,
584
                           Object_File_Suffix           => No_Name,
585
                           Object_File_Switches         => No_Name_List,
586
                           Compilation_PIC_Option       => No_Name_List,
587
                           Object_Generated             => True,
588
                           Objects_Linked               => True,
589
                           Runtime_Library_Dir          => No_Name,
590
                           Runtime_Source_Dir           => No_Name,
591
                           Mapping_File_Switches        => No_Name_List,
592
                           Mapping_Spec_Suffix          => No_File,
593
                           Mapping_Body_Suffix          => No_File,
594
                           Config_File_Switches         => No_Name_List,
595
                           Dependency_Kind              => None,
596
                           Dependency_Option            => No_Name_List,
597
                           Compute_Dependency           => No_Name_List,
598
                           Include_Option               => No_Name_List,
599
                           Include_Path                 => No_Name,
600
                           Include_Path_File            => No_Name,
601
                           Objects_Path                 => No_Name,
602
                           Objects_Path_File            => No_Name,
603
                           Config_Body                  => No_Name,
604
                           Config_Body_Index            => No_Name,
605
                           Config_Body_Pattern          => No_Name,
606
                           Config_Spec                  => No_Name,
607
                           Config_Spec_Index            => No_Name,
608
                           Config_Spec_Pattern          => No_Name,
609
                           Config_File_Unique           => False,
610
                           Binder_Driver                => No_File,
611
                           Binder_Driver_Path           => No_Path,
612
                           Binder_Required_Switches     => No_Name_List,
613
                           Binder_Prefix                => No_Name,
614
                           Toolchain_Version            => No_Name,
615
                           Toolchain_Description        => No_Name);
616
 
617
   --  The following record ???
618
 
619
   type Language_Data is record
620
      Name          : Name_Id         := No_Name;
621
      Display_Name  : Name_Id         := No_Name;
622
      Config        : Language_Config := No_Language_Config;
623
      First_Source  : Source_Id       := No_Source;
624
      Mapping_Files : Mapping_Files_Htable.Instance :=
625
                        Mapping_Files_Htable.Nil;
626
      Next          : Language_Ptr  := No_Language_Index;
627
   end record;
628
 
629
   No_Language_Data : constant Language_Data :=
630
                        (Name          => No_Name,
631
                         Display_Name  => No_Name,
632
                         Config        => No_Language_Config,
633
                         First_Source  => No_Source,
634
                         Mapping_Files => Mapping_Files_Htable.Nil,
635
                         Next          => No_Language_Index);
636
 
637
   type Language_List_Element;
638
   type Language_List is access all Language_List_Element;
639
   type Language_List_Element is record
640
      Language : Language_Ptr := No_Language_Index;
641
      Next     : Language_List;
642
   end record;
643
 
644
   type Source_Kind is (Spec, Impl, Sep);
645
   subtype Spec_Or_Body is Source_Kind range Spec .. Impl;
646
 
647
   --  The following declarations declare a structure used to store the Name
648
   --  and File and Path names of a unit, with a reference to its GNAT Project
649
   --  File(s). Some units might have neither Spec nor Impl when they were
650
   --  created for a "separate".
651
 
652
   type File_Names_Data is array (Spec_Or_Body) of Source_Id;
653
 
654
   type Unit_Data is record
655
      Name       : Name_Id := No_Name;
656
      File_Names : File_Names_Data;
657
   end record;
658
 
659
   type Unit_Index is access all Unit_Data;
660
 
661
   No_Unit_Index : constant Unit_Index := null;
662
   --  Used to indicate a null entry for no unit
663
 
664
   --  Structure to define source data
665
 
666
   type Source_Data is record
667
      Project : Project_Id := No_Project;
668
      --  Project of the source
669
 
670
      Source_Dir_Rank : Natural := 0;
671
      --  The rank of the source directory in list declared with attribute
672
      --  Source_Dirs. Two source files with the same name cannot appears in
673
      --  different directory with the same rank. That can happen when the
674
      --  recursive notation <dir>/** is used in attribute Source_Dirs.
675
 
676
      Language : Language_Ptr := No_Language_Index;
677
      --  Index of the language. This is an index into
678
      --  Project_Tree.Languages_Data.
679
 
680
      In_Interfaces : Boolean := True;
681
      --  False when the source is not included in interfaces, when attribute
682
      --  Interfaces is declared.
683
 
684
      Declared_In_Interfaces : Boolean := False;
685
      --  True when source is declared in attribute Interfaces
686
 
687
      Alternate_Languages : Language_List := null;
688
      --  List of languages a header file may also be, in addition of language
689
      --  Language_Name.
690
 
691
      Kind : Source_Kind := Spec;
692
      --  Kind of the source: spec, body or subunit
693
 
694
      Unit : Unit_Index := No_Unit_Index;
695
      --  Name of the unit, if language is unit based. This is only set for
696
      --  those files that are part of the compilation set (for instance a
697
      --  file in an extended project that is overridden will not have this
698
      --  field set).
699
 
700
      Index : Int := 0;
701
      --  Index of the source in a multi unit source file (the same Source_Data
702
      --  is duplicated several times when there are several units in the same
703
      --  file). Index is 0 if there is either no unit or a single one, and
704
      --  starts at 1 when there are multiple units
705
 
706
      Locally_Removed : Boolean := False;
707
      --  True if the source has been "excluded"
708
 
709
      Replaced_By : Source_Id := No_Source;
710
      --  Missing comment ???
711
 
712
      File : File_Name_Type := No_File;
713
      --  Canonical file name of the source
714
 
715
      Display_File : File_Name_Type := No_File;
716
      --  File name of the source, for display purposes
717
 
718
      Path : Path_Information := No_Path_Information;
719
      --  Path name of the source
720
 
721
      Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
722
      --  Time stamp of the source file
723
 
724
      Object_Project : Project_Id := No_Project;
725
      --  Project where the object file is. This might be different from
726
      --  Project when using extending project files.
727
 
728
      Object : File_Name_Type := No_File;
729
      --  File name of the object file
730
 
731
      Current_Object_Path : Path_Name_Type := No_Path;
732
      --  Object path of an existing object file
733
 
734
      Object_Path : Path_Name_Type := No_Path;
735
      --  Object path of the real object file
736
 
737
      Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
738
      --  Object file time stamp
739
 
740
      Dep_Name : File_Name_Type := No_File;
741
      --  Dependency file simple name
742
 
743
      Current_Dep_Path : Path_Name_Type := No_Path;
744
      --  Path name of an existing dependency file
745
 
746
      Dep_Path : Path_Name_Type := No_Path;
747
      --  Path name of the real dependency file
748
 
749
      Dep_TS : aliased Osint.File_Attributes := Osint.Unknown_Attributes;
750
      --  Dependency file time stamp
751
 
752
      Switches : File_Name_Type := No_File;
753
      --  File name of the switches file. For all languages, this is a file
754
      --  that ends with the .cswi extension.
755
 
756
      Switches_Path : Path_Name_Type := No_Path;
757
      --  Path name of the switches file
758
 
759
      Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
760
      --  Switches file time stamp
761
 
762
      Naming_Exception : Boolean := False;
763
      --  True if the source has an exceptional name
764
 
765
      Next_In_Lang : Source_Id := No_Source;
766
      --  Link to another source of the same language in the same project
767
   end record;
768
 
769
   No_Source_Data : constant Source_Data :=
770
                      (Project                => No_Project,
771
                       Source_Dir_Rank        => 0,
772
                       Language               => No_Language_Index,
773
                       In_Interfaces          => True,
774
                       Declared_In_Interfaces => False,
775
                       Alternate_Languages    => null,
776
                       Kind                   => Spec,
777
                       Unit                   => No_Unit_Index,
778
                       Index                  => 0,
779
                       Locally_Removed        => False,
780
                       Replaced_By            => No_Source,
781
                       File                   => No_File,
782
                       Display_File           => No_File,
783
                       Path                   => No_Path_Information,
784
                       Source_TS              => Empty_Time_Stamp,
785
                       Object_Project         => No_Project,
786
                       Object                 => No_File,
787
                       Current_Object_Path    => No_Path,
788
                       Object_Path            => No_Path,
789
                       Object_TS              => Empty_Time_Stamp,
790
                       Dep_Name               => No_File,
791
                       Current_Dep_Path       => No_Path,
792
                       Dep_Path               => No_Path,
793
                       Dep_TS                 => Osint.Unknown_Attributes,
794
                       Switches               => No_File,
795
                       Switches_Path          => No_Path,
796
                       Switches_TS            => Empty_Time_Stamp,
797
                       Naming_Exception       => False,
798
                       Next_In_Lang           => No_Source);
799
 
800
   package Source_Paths_Htable is new Simple_HTable
801
     (Header_Num => Header_Num,
802
      Element    => Source_Id,
803
      No_Element => No_Source,
804
      Key        => Path_Name_Type,
805
      Hash       => Hash,
806
      Equal      => "=");
807
   --  Mapping of source paths to source ids
808
 
809
   package Unit_Sources_Htable is new Simple_HTable
810
     (Header_Num => Header_Num,
811
      Element    => Source_Id,
812
      No_Element => No_Source,
813
      Key        => Name_Id,
814
      Hash       => Hash,
815
      Equal      => "=");
816
 
817
   type Verbosity is (Default, Medium, High);
818
   --  Verbosity when parsing GNAT Project Files
819
   --    Default is default (very quiet, if no errors).
820
   --    Medium is more verbose.
821
   --    High is extremely verbose.
822
 
823
   Current_Verbosity : Verbosity := Default;
824
   --  The current value of the verbosity the project files are parsed with
825
 
826
   type Lib_Kind is (Static, Dynamic, Relocatable);
827
 
828
   type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
829
   --  Type to specify the symbol policy, when symbol control is supported.
830
   --  See full explanation about this type in package Symbols.
831
   --    Autonomous: Create a symbol file without considering any reference
832
   --    Compliant:  Try to be as compatible as possible with an existing ref
833
   --    Controlled: Fail if symbols are not the same as those in the reference
834
   --    Restricted: Restrict the symbols to those in the symbol file
835
   --    Direct:     The symbol file is used as is
836
 
837
   type Symbol_Record is record
838
      Symbol_File   : Path_Name_Type := No_Path;
839
      Reference     : Path_Name_Type := No_Path;
840
      Symbol_Policy : Policy  := Autonomous;
841
   end record;
842
   --  Type to keep the symbol data to be used when building a shared library
843
 
844
   No_Symbols : constant Symbol_Record :=
845
     (Symbol_File   => No_Path,
846
      Reference     => No_Path,
847
      Symbol_Policy => Autonomous);
848
   --  The default value of the symbol data
849
 
850
   function Image (The_Casing : Casing_Type) return String;
851
   --  Similar to 'Image (but avoid use of this attribute in compiler)
852
 
853
   function Value (Image : String) return Casing_Type;
854
   --  Similar to 'Value (but avoid use of this attribute in compiler)
855
   --  Raises Constraint_Error if not a Casing_Type image.
856
 
857
   --  The following record contains data for a naming scheme
858
 
859
   function Get_Object_Directory
860
     (Project             : Project_Id;
861
      Including_Libraries : Boolean;
862
      Only_If_Ada         : Boolean := False) return Path_Name_Type;
863
   --  Return the object directory to use for the project. This depends on
864
   --  whether we have a library project or a standard project. This function
865
   --  might return No_Name when no directory applies.
866
   --  If we have a a library project file and Including_Libraries is True then
867
   --  the library dir is returned instead of the object dir.
868
   --  If Only_If_Ada is True, then No_Name will be returned when the project
869
   --  doesn't Ada sources.
870
 
871
   procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
872
   --  For all projects in the tree, compute the list of the projects imported
873
   --  directly or indirectly by project Project. The result is stored in
874
   --  Project.All_Imported_Projects for each project
875
 
876
   function Ultimate_Extending_Project_Of
877
     (Proj : Project_Id) return Project_Id;
878
   --  Returns the ultimate extending project of project Proj. If project Proj
879
   --  is not extended, returns Proj.
880
 
881
   type Project_List_Element;
882
   type Project_List is access all Project_List_Element;
883
   type Project_List_Element is record
884
      Project : Project_Id   := No_Project;
885
      Next    : Project_List := null;
886
   end record;
887
   --  A list of projects
888
 
889
   procedure Free_List
890
     (List         : in out Project_List;
891
      Free_Project : Boolean);
892
   --  Free the list of projects, if Free_Project, each project is also freed
893
 
894
   type Response_File_Format is
895
     (None,
896
      GNU,
897
      Object_List,
898
      Option_List);
899
   --  The format of the different response files
900
 
901
   type Project_Configuration is record
902
      Target : Name_Id := No_Name;
903
      --  The target of the configuration, when specified
904
 
905
      Run_Path_Option : Name_List_Index := No_Name_List;
906
      --  The option to use when linking to specify the path where to look for
907
      --  libraries.
908
 
909
      Run_Path_Origin : Name_Id := No_Name;
910
      --  Specify the string (such as "$ORIGIN") to indicate paths relative to
911
      --  the directory of the executable in the run path option.
912
 
913
      Library_Install_Name_Option : Name_Id := No_Name;
914
      --  When this is not an empty list, this option, followed by the single
915
      --  name of the shared library file is used when linking a shared
916
      --  library.
917
 
918
      Separate_Run_Path_Options : Boolean := False;
919
      --  True if each directory needs to be specified in a separate run path
920
      --  option.
921
 
922
      Executable_Suffix : Name_Id := No_Name;
923
      --  The suffix of executables, when specified in the configuration or in
924
      --  package Builder of the main project. When this is not specified, the
925
      --  executable suffix is the default for the platform.
926
 
927
      --  Linking
928
 
929
      Linker : Path_Name_Type := No_Path;
930
      --  Path name of the linker driver. Specified in the configuration or in
931
      --  the package Builder of the main project.
932
 
933
      Map_File_Option : Name_Id := No_Name;
934
      --  Option to use when invoking the linker to build a map file
935
 
936
      Minimum_Linker_Options : Name_List_Index := No_Name_List;
937
      --  The minimum options for the linker driver. Specified in the
938
      --  configuration.
939
 
940
      Linker_Executable_Option : Name_List_Index := No_Name_List;
941
      --  The option(s) to indicate the name of the executable in the linker
942
      --  command. Specified in the configuration. When not specified, default
943
      --  to -o <executable name>.
944
 
945
      Linker_Lib_Dir_Option : Name_Id := No_Name;
946
      --  The option to specify where to find a library for linking. Specified
947
      --  in the configuration. When not specified, defaults to "-L".
948
 
949
      Linker_Lib_Name_Option : Name_Id := No_Name;
950
      --  The option to specify the name of a library for linking. Specified in
951
      --  the configuration. When not specified, defaults to "-l".
952
 
953
      Max_Command_Line_Length : Natural := 0;
954
      --  When positive and when Resp_File_Format (see below) is not None,
955
      --  if the command line for the invocation of the linker would be greater
956
      --  than this value, a response file is used to invoke the linker.
957
 
958
      Resp_File_Format : Response_File_Format := None;
959
      --  The format of a response file, when linking with a response file is
960
      --  supported.
961
 
962
      Resp_File_Options : Name_List_Index := No_Name_List;
963
      --  The switches, if any, that precede the path name of the response
964
      --  file in the invocation of the linker.
965
 
966
      --  Libraries
967
 
968
      Library_Builder : Path_Name_Type  := No_Path;
969
      --  The executable to build library (specified in the configuration)
970
 
971
      Lib_Support : Library_Support := None;
972
      --  The level of library support. Specified in the configuration. Support
973
      --  is none, static libraries only or both static and shared libraries.
974
 
975
      Archive_Builder : Name_List_Index := No_Name_List;
976
      --  The name of the executable to build archives, with the minimum
977
      --  switches. Specified in the configuration.
978
 
979
      Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
980
      --  The options to append object files to an archive
981
 
982
      Archive_Indexer : Name_List_Index := No_Name_List;
983
      --  The name of the executable to index archives, with the minimum
984
      --  switches. Specified in the configuration.
985
 
986
      Archive_Suffix : File_Name_Type := No_File;
987
      --  The suffix of archives. Specified in the configuration. When not
988
      --  specified, defaults to ".a".
989
 
990
      Lib_Partial_Linker : Name_List_Index := No_Name_List;
991
 
992
      --  Shared libraries
993
 
994
      Shared_Lib_Driver : File_Name_Type := No_File;
995
      --  The driver to link shared libraries. Set with attribute Library_GCC.
996
      --  Default to gcc.
997
 
998
      Shared_Lib_Prefix : File_Name_Type := No_File;
999
      --  Part of a shared library file name that precedes the name of the
1000
      --  library. Specified in the configuration. When not specified, defaults
1001
      --  to "lib".
1002
 
1003
      Shared_Lib_Suffix : File_Name_Type := No_File;
1004
      --  Suffix of shared libraries, after the library name in the shared
1005
      --  library name. Specified in the configuration. When not specified,
1006
      --  default to ".so".
1007
 
1008
      Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1009
      --  The minimum options to use when building a shared library
1010
 
1011
      Lib_Version_Options : Name_List_Index := No_Name_List;
1012
      --  The options to use to specify a library version
1013
 
1014
      Symbolic_Link_Supported : Boolean := False;
1015
      --  True if the platform supports symbolic link files
1016
 
1017
      Lib_Maj_Min_Id_Supported : Boolean := False;
1018
      --  True if platform supports library major and minor options, such as
1019
      --  libname.so -> libname.so.2 -> libname.so.2.4
1020
 
1021
      Auto_Init_Supported : Boolean := False;
1022
      --  True if automatic initialisation is supported for shared stand-alone
1023
      --  libraries.
1024
   end record;
1025
 
1026
   Default_Project_Config : constant Project_Configuration :=
1027
                              (Target                        => No_Name,
1028
                               Run_Path_Option               => No_Name_List,
1029
                               Run_Path_Origin               => No_Name,
1030
                               Library_Install_Name_Option   => No_Name,
1031
                               Separate_Run_Path_Options     => False,
1032
                               Executable_Suffix             => No_Name,
1033
                               Linker                        => No_Path,
1034
                               Map_File_Option               => No_Name,
1035
                               Minimum_Linker_Options        => No_Name_List,
1036
                               Linker_Executable_Option      => No_Name_List,
1037
                               Linker_Lib_Dir_Option         => No_Name,
1038
                               Linker_Lib_Name_Option        => No_Name,
1039
                               Library_Builder               => No_Path,
1040
                               Max_Command_Line_Length       => 0,
1041
                               Resp_File_Format              => None,
1042
                               Resp_File_Options             => No_Name_List,
1043
                               Lib_Support                   => None,
1044
                               Archive_Builder               => No_Name_List,
1045
                               Archive_Builder_Append_Option => No_Name_List,
1046
                               Archive_Indexer               => No_Name_List,
1047
                               Archive_Suffix                => No_File,
1048
                               Lib_Partial_Linker            => No_Name_List,
1049
                               Shared_Lib_Driver             => No_File,
1050
                               Shared_Lib_Prefix             => No_File,
1051
                               Shared_Lib_Suffix             => No_File,
1052
                               Shared_Lib_Min_Options        => No_Name_List,
1053
                               Lib_Version_Options           => No_Name_List,
1054
                               Symbolic_Link_Supported       => False,
1055
                               Lib_Maj_Min_Id_Supported      => False,
1056
                               Auto_Init_Supported           => False);
1057
 
1058
   --  The following record describes a project file representation
1059
 
1060
   --  Note that it is not specified if the path names of directories (source,
1061
   --  object, library or exec directories) end with or without a directory
1062
   --  separator.
1063
 
1064
   type Project_Data is record
1065
 
1066
      -------------
1067
      -- General --
1068
      -------------
1069
 
1070
      Name : Name_Id := No_Name;
1071
      --  The name of the project
1072
 
1073
      Display_Name : Name_Id := No_Name;
1074
      --  The name of the project with the spelling of its declaration
1075
 
1076
      Qualifier : Project_Qualifier := Unspecified;
1077
      --  The eventual qualifier for this project
1078
 
1079
      Externally_Built : Boolean := False;
1080
      --  True if the project is externally built. In such case, the Project
1081
      --  Manager will not modify anything in this project.
1082
 
1083
      Config : Project_Configuration;
1084
 
1085
      Path : Path_Information := No_Path_Information;
1086
      --  The path name of the project file. This include base name of the
1087
      --  project file.
1088
 
1089
      Virtual : Boolean := False;
1090
      --  True for virtual extending projects
1091
 
1092
      Location : Source_Ptr := No_Location;
1093
      --  The location in the project file source of the reserved word project
1094
 
1095
      ---------------
1096
      -- Languages --
1097
      ---------------
1098
 
1099
      Languages : Language_Ptr := No_Language_Index;
1100
      --  First index of the language data in the project.
1101
      --  This is an index into the project_tree_data.languages_data.
1102
      --  Traversing the list gives access to all the languages supported by
1103
      --  the project.
1104
 
1105
      --------------
1106
      -- Projects --
1107
      --------------
1108
 
1109
      Mains : String_List_Id := Nil_String;
1110
      --  List of mains specified by attribute Main
1111
 
1112
      Extends : Project_Id := No_Project;
1113
      --  The reference of the project file, if any, that this project file
1114
      --  extends.
1115
 
1116
      Extended_By : Project_Id := No_Project;
1117
      --  The reference of the project file, if any, that extends this project
1118
      --  file.
1119
 
1120
      Decl : Declarations := No_Declarations;
1121
      --  The declarations (variables, attributes and packages) of this project
1122
      --  file.
1123
 
1124
      Imported_Projects : Project_List;
1125
      --  The list of all directly imported projects, if any
1126
 
1127
      All_Imported_Projects : Project_List;
1128
      --  The list of all projects imported directly or indirectly, if any.
1129
      --  This does not include the project itself.
1130
 
1131
      -----------------
1132
      -- Directories --
1133
      -----------------
1134
 
1135
      Directory : Path_Information := No_Path_Information;
1136
      --  Path name of the directory where the project file resides
1137
 
1138
      Object_Directory : Path_Information := No_Path_Information;
1139
      --  The path name of the object directory of this project file
1140
 
1141
      Exec_Directory : Path_Information := No_Path_Information;
1142
      --  The path name of the exec directory of this project file. Default is
1143
      --  equal to Object_Directory.
1144
 
1145
      -------------
1146
      -- Library --
1147
      -------------
1148
 
1149
      Library : Boolean := False;
1150
      --  True if this is a library project
1151
 
1152
      Library_Name : Name_Id := No_Name;
1153
      --  If a library project, name of the library
1154
 
1155
      Library_Kind : Lib_Kind := Static;
1156
      --  If a library project, kind of library
1157
 
1158
      Library_Dir : Path_Information := No_Path_Information;
1159
      --  If a library project, path name of the directory where the library
1160
      --  resides.
1161
 
1162
      Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1163
      --  The timestamp of a library file in a library project
1164
 
1165
      Library_Src_Dir : Path_Information := No_Path_Information;
1166
      --  If a Stand-Alone Library project, path name of the directory where
1167
      --  the sources of the interfaces of the library are copied. By default,
1168
      --  if attribute Library_Src_Dir is not specified, sources of the
1169
      --  interfaces are not copied anywhere.
1170
 
1171
      Library_ALI_Dir : Path_Information := No_Path_Information;
1172
      --  In a library project, path name of the directory where the ALI files
1173
      --  are copied. If attribute Library_ALI_Dir is not specified, ALI files
1174
      --  are copied in the Library_Dir.
1175
 
1176
      Lib_Internal_Name : Name_Id := No_Name;
1177
      --  If a library project, internal name store inside the library
1178
 
1179
      Standalone_Library : Boolean := False;
1180
      --  Indicate that this is a Standalone Library Project File
1181
 
1182
      Lib_Interface_ALIs : String_List_Id := Nil_String;
1183
      --  For Standalone Library Project Files, indicate the list of Interface
1184
      --  ALI files.
1185
 
1186
      Lib_Auto_Init : Boolean := False;
1187
      --  For non static Stand-Alone Library Project Files, indicate if
1188
      --  the library initialisation should be automatic.
1189
 
1190
      Symbol_Data : Symbol_Record := No_Symbols;
1191
      --  Symbol file name, reference symbol file name, symbol policy
1192
 
1193
      Need_To_Build_Lib : Boolean := False;
1194
      --  Indicates that the library of a Library Project needs to be built or
1195
      --  rebuilt.
1196
 
1197
      -------------
1198
      -- Sources --
1199
      -------------
1200
      --  The sources for all languages including Ada are accessible through
1201
      --  the Source_Iterator type
1202
 
1203
      Interfaces_Defined : Boolean := False;
1204
      --  True if attribute Interfaces is declared for the project or any
1205
      --  project it extends.
1206
 
1207
      Include_Path_File : Path_Name_Type := No_Path;
1208
      --  The path name of the of the source search directory file.
1209
      --  This is only used by gnatmake
1210
 
1211
      Source_Dirs : String_List_Id := Nil_String;
1212
      --  The list of all the source directories
1213
 
1214
      Source_Dir_Ranks : Number_List_Index := No_Number_List;
1215
 
1216
      Ada_Include_Path : String_Access := null;
1217
      --  The cached value of source search path for this project file. Set by
1218
      --  the first call to Prj.Env.Ada_Include_Path for the project. Do not
1219
      --  use this field directly outside of the project manager, use
1220
      --  Prj.Env.Ada_Include_Path instead.
1221
 
1222
      Has_Multi_Unit_Sources : Boolean := False;
1223
      --  Whether there is at least one source file containing multiple units
1224
 
1225
      -------------------
1226
      -- Miscellaneous --
1227
      -------------------
1228
 
1229
      Ada_Objects_Path : String_Access := null;
1230
      --  The cached value of ADA_OBJECTS_PATH for this project file. Do not
1231
      --  use this field directly outside of the compiler, use
1232
      --  Prj.Env.Ada_Objects_Path instead.
1233
 
1234
      Libgnarl_Needed : Yes_No_Unknown := Unknown;
1235
      --  Set to True when libgnarl is needed to link
1236
 
1237
      Objects_Path : String_Access := null;
1238
      --  The cached value of the object dir path, used during the binding
1239
      --  phase of gprbuild.
1240
 
1241
      Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1242
      --  The cached value of the object path temp file (including library
1243
      --  dirs) for this project file.
1244
 
1245
      Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1246
      --  The cached value of the object path temp file (excluding library
1247
      --  dirs) for this project file.
1248
 
1249
      Config_File_Name : Path_Name_Type := No_Path;
1250
      --  The path name of the configuration pragmas file, if any
1251
 
1252
      Config_File_Temp : Boolean := False;
1253
      --  An indication that the configuration pragmas file is a temporary file
1254
      --  that must be deleted at the end.
1255
 
1256
      Config_Checked : Boolean := False;
1257
      --  A flag to avoid checking repetitively the configuration pragmas file
1258
 
1259
      Depth : Natural := 0;
1260
      --  The maximum depth of a project in the project graph. Depth of main
1261
      --  project is 0.
1262
 
1263
      Unkept_Comments : Boolean := False;
1264
      --  True if there are comments in the project sources that cannot be kept
1265
      --  in the project tree.
1266
 
1267
   end record;
1268
 
1269
   function Empty_Project return Project_Data;
1270
   --  Return the representation of an empty project
1271
 
1272
   function Is_Extending
1273
     (Extending : Project_Id;
1274
      Extended  : Project_Id) return Boolean;
1275
   --  Return True if Extending is extending the Extended project
1276
 
1277
   function Has_Ada_Sources (Data : Project_Id) return Boolean;
1278
   --  Return True if the project has Ada sources
1279
 
1280
   Project_Error : exception;
1281
   --  Raised by some subprograms in Prj.Attr
1282
 
1283
   package Units_Htable is new Simple_HTable
1284
     (Header_Num => Header_Num,
1285
      Element    => Unit_Index,
1286
      No_Element => No_Unit_Index,
1287
      Key        => Name_Id,
1288
      Hash       => Hash,
1289
      Equal      => "=");
1290
   --  Mapping of unit names to indexes in the Units table
1291
 
1292
   ---------------------
1293
   -- Source_Iterator --
1294
   ---------------------
1295
 
1296
   type Source_Iterator is private;
1297
 
1298
   function For_Each_Source
1299
     (In_Tree  : Project_Tree_Ref;
1300
      Project  : Project_Id := No_Project;
1301
      Language : Name_Id := No_Name) return Source_Iterator;
1302
   --  Returns an iterator for all the sources of a project tree, or a specific
1303
   --  project, or a specific language.
1304
 
1305
   function Element (Iter : Source_Iterator) return Source_Id;
1306
   --  Return the current source (or No_Source if there are no more sources)
1307
 
1308
   procedure Next (Iter : in out Source_Iterator);
1309
   --  Move on to the next source
1310
 
1311
   function Find_Source
1312
     (In_Tree          : Project_Tree_Ref;
1313
      Project          : Project_Id;
1314
      In_Imported_Only : Boolean := False;
1315
      In_Extended_Only : Boolean := False;
1316
      Base_Name        : File_Name_Type) return Source_Id;
1317
   --  Find the first source file with the given name either in the whole tree
1318
   --  (if In_Imported_Only is False) or in the projects imported or extended
1319
   --  by Project otherwise. In_Extended_Only implies In_Imported_Only, and
1320
   --  will only look in Project and the projects it extends
1321
 
1322
   -----------------------
1323
   -- Project_Tree_Data --
1324
   -----------------------
1325
 
1326
   type Private_Project_Tree_Data is private;
1327
   --  Data for a project tree that is used only by the Project Manager
1328
 
1329
   type Project_Tree_Data is
1330
      record
1331
         Name_Lists        : Name_List_Table.Instance;
1332
         Number_Lists      : Number_List_Table.Instance;
1333
         String_Elements   : String_Element_Table.Instance;
1334
         Variable_Elements : Variable_Element_Table.Instance;
1335
         Array_Elements    : Array_Element_Table.Instance;
1336
         Arrays            : Array_Table.Instance;
1337
         Packages          : Package_Table.Instance;
1338
         Projects          : Project_List;
1339
 
1340
         Units_HT          : Units_Htable.Instance;
1341
         --  Unit name to Unit_Index (and from there so Source_Id)
1342
 
1343
         Source_Paths_HT   : Source_Paths_Htable.Instance;
1344
         --  Full path to Source_Id
1345
 
1346
         Private_Part      : Private_Project_Tree_Data;
1347
      end record;
1348
   --  Data for a project tree
1349
 
1350
   procedure Expect (The_Token : Token_Type; Token_Image : String);
1351
   --  Check that the current token is The_Token. If it is not, then output
1352
   --  an error message.
1353
 
1354
   procedure Initialize (Tree : Project_Tree_Ref);
1355
   --  This procedure must be called before using any services from the Prj
1356
   --  hierarchy. Namet.Initialize must be called before Prj.Initialize.
1357
 
1358
   procedure Reset (Tree : Project_Tree_Ref);
1359
   --  This procedure resets all the tables that are used when processing a
1360
   --  project file tree. Initialize must be called before the call to Reset.
1361
 
1362
   package Project_Boolean_Htable is new Simple_HTable
1363
     (Header_Num => Header_Num,
1364
      Element    => Boolean,
1365
      No_Element => False,
1366
      Key        => Project_Id,
1367
      Hash       => Hash,
1368
      Equal      => "=");
1369
   --  A table that associates a project to a boolean. This is used to detect
1370
   --  whether a project was already processed for instance.
1371
 
1372
   generic
1373
      type State is limited private;
1374
      with procedure Action
1375
        (Project    : Project_Id;
1376
         With_State : in out State);
1377
   procedure For_Every_Project_Imported
1378
     (By             : Project_Id;
1379
      With_State     : in out State;
1380
      Imported_First : Boolean := False);
1381
   --  Call Action for each project imported directly or indirectly by project
1382
   --  By, as well as extended projects.
1383
   --  The order of processing depends on Imported_First:
1384
   --  If False, Action is called according to the order of importation: if A
1385
   --  imports B, directly or indirectly, Action will be called for A before
1386
   --  it is called for B. If two projects import each other directly or
1387
   --  indirectly (using at least one "limited with"), it is not specified
1388
   --  for which of these two projects Action will be called first.
1389
   --  The order is reversed if Imported_First is True.
1390
   --  With_State may be used by Action to choose a behavior or to report some
1391
   --  global result.
1392
 
1393
   function Extend_Name
1394
     (File        : File_Name_Type;
1395
      With_Suffix : String) return File_Name_Type;
1396
   --  Replace the extension of File with With_Suffix
1397
 
1398
   function Object_Name
1399
     (Source_File_Name   : File_Name_Type;
1400
      Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1401
   --  Returns the object file name corresponding to a source file name
1402
 
1403
   function Object_Name
1404
     (Source_File_Name   : File_Name_Type;
1405
      Source_Index       : Int;
1406
      Index_Separator    : Character;
1407
      Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1408
   --  Returns the object file name corresponding to a unit in a multi-source
1409
   --  file.
1410
 
1411
   function Dependency_Name
1412
     (Source_File_Name : File_Name_Type;
1413
      Dependency       : Dependency_File_Kind) return File_Name_Type;
1414
   --  Returns the dependency file name corresponding to a source file name
1415
 
1416
   function Switches_Name
1417
     (Source_File_Name : File_Name_Type) return File_Name_Type;
1418
   --  Returns the switches file name corresponding to a source file name
1419
 
1420
   -----------
1421
   -- Flags --
1422
   -----------
1423
 
1424
   type Processing_Flags is private;
1425
   --  Flags used while parsing and processing a project tree to configure the
1426
   --  behavior of the parser, and indicate how to report error messages. This
1427
   --  structure does not allocate memory and never needs to be freed
1428
 
1429
   type Error_Warning is (Silent, Warning, Error);
1430
   --  Severity of some situations, such as: no Ada sources in a project where
1431
   --  Ada is one of the language.
1432
   --
1433
   --  When the situation occurs, the behaviour depends on the setting:
1434
   --
1435
   --    - Silent:  no action
1436
   --    - Warning: issue a warning, does not cause the tool to fail
1437
   --    - Error:   issue an error, causes the tool to fail
1438
 
1439
   type Error_Handler is access procedure
1440
     (Project    : Project_Id;
1441
      Is_Warning : Boolean);
1442
   --  This warngs when an error was found when parsing a project. The error
1443
   --  itself is handled through Prj.Err (and Prj.Err.Finalize should be called
1444
   --  to actually print the error). This ensures that duplicate error messages
1445
   --  are always correctly removed, that errors msgs are sorted, and that all
1446
   --  tools will report the same error to the user.
1447
 
1448
   function Create_Flags
1449
     (Report_Error               : Error_Handler;
1450
      When_No_Sources            : Error_Warning;
1451
      Require_Sources_Other_Lang : Boolean := True;
1452
      Allow_Duplicate_Basenames  : Boolean := True;
1453
      Compiler_Driver_Mandatory  : Boolean := False;
1454
      Error_On_Unknown_Language  : Boolean := True;
1455
      Require_Obj_Dirs           : Error_Warning := Error)
1456
      return Processing_Flags;
1457
   --  Function used to create Processing_Flags structure
1458
   --
1459
   --  If Allow_Duplicate_Basenames, then files with the same base names are
1460
   --  authorized within a project for source-based languages (never for unit
1461
   --  based languages).
1462
   --
1463
   --  If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
1464
   --  for each language must be defined, or we will not look for its source
1465
   --  files.
1466
   --
1467
   --  When_No_Sources indicates what should be done when no sources of a
1468
   --  language are found in a project where this language is declared.
1469
   --  If Require_Sources_Other_Lang is true, then all languages must have at
1470
   --  least one source file, or an error is reported via When_No_Sources. If
1471
   --  it is false, this is only required for Ada (and only if it is a language
1472
   --  of the project). When this parameter is set to False, we do not check
1473
   --  that a proper naming scheme is defined for languages other than Ada.
1474
   --
1475
   --  If Report_Error is null, use the standard error reporting mechanism
1476
   --  (Errout). Otherwise, report errors using Report_Error.
1477
   --
1478
   --  If Error_On_Unknown_Language is true, an error is displayed if some of
1479
   --  the source files listed in the project do not match any naming scheme
1480
   --
1481
   --  If Require_Obj_Dirs is true, then all object directories must exist
1482
   --  (possibly after they have been created automatically if the appropriate
1483
   --  switches were specified), or an error is raised.
1484
 
1485
   Gprbuild_Flags : constant Processing_Flags;
1486
   Gprclean_Flags : constant Processing_Flags;
1487
   Gnatmake_Flags : constant Processing_Flags;
1488
   --  Flags used by the various tools. They all display the error messages
1489
   --  through Prj.Err.
1490
 
1491
   ----------------
1492
   -- Temp Files --
1493
   ----------------
1494
 
1495
   procedure Record_Temp_File
1496
     (Tree : Project_Tree_Ref;
1497
      Path : Path_Name_Type);
1498
   --  Record the path of a newly created temporary file, so that it can be
1499
   --  deleted later.
1500
 
1501
   procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
1502
   --  Delete all recorded temporary files.
1503
   --  Does nothing if Debug.Debug_Flag_N is set
1504
 
1505
   procedure Delete_Temporary_File
1506
     (Tree : Project_Tree_Ref;
1507
      Path : Path_Name_Type);
1508
   --  Delete a temporary file from the disk. The file is also removed from the
1509
   --  list of temporary files to delete at the end of the program, in case
1510
   --  another program running on the same machine has recreated it.
1511
   --  Does nothing if Debug.Debug_Flag_N is set
1512
 
1513
private
1514
 
1515
   All_Packages : constant String_List_Access := null;
1516
 
1517
   No_Project_Tree : constant Project_Tree_Ref := null;
1518
 
1519
   Ignored : constant Variable_Kind := Single;
1520
 
1521
   Nil_Variable_Value : constant Variable_Value :=
1522
                          (Project  => No_Project,
1523
                           Kind     => Undefined,
1524
                           Location => No_Location,
1525
                           Default  => False);
1526
 
1527
   Virtual_Prefix : constant String := "v$";
1528
   --  The prefix for virtual extending projects. Because of the '$', which is
1529
   --  normally forbidden for project names, there cannot be any name clash.
1530
 
1531
   type Source_Iterator is record
1532
      In_Tree : Project_Tree_Ref;
1533
 
1534
      Project      : Project_List;
1535
      All_Projects : Boolean;
1536
      --  Current project and whether we should move on to the next
1537
 
1538
      Language : Language_Ptr;
1539
      --  Current language processed
1540
 
1541
      Language_Name : Name_Id;
1542
      --  Only sources of this language will be returned (or all if No_Name)
1543
 
1544
      Current : Source_Id;
1545
   end record;
1546
 
1547
   procedure Add_To_Buffer
1548
     (S    : String;
1549
      To   : in out String_Access;
1550
      Last : in out Natural);
1551
   --  Append a String to the Buffer
1552
 
1553
   package Temp_Files_Table is new GNAT.Dynamic_Tables
1554
     (Table_Component_Type => Path_Name_Type,
1555
      Table_Index_Type     => Integer,
1556
      Table_Low_Bound      => 1,
1557
      Table_Initial        => 10,
1558
      Table_Increment      => 10);
1559
   --  Table to store the path name of all the created temporary files, so that
1560
   --  they can be deleted at the end, or when the program is interrupted.
1561
 
1562
   type Private_Project_Tree_Data is record
1563
      Temp_Files   : Temp_Files_Table.Instance;
1564
      --  Temporary files created as part of running tools (pragma files,
1565
      --  mapping files,...)
1566
 
1567
      Current_Source_Path_File : Path_Name_Type := No_Path;
1568
      --  Current value of project source path file env var. Used to avoid
1569
      --  setting the env var to the same value. When different from No_Path,
1570
      --  this indicates that logical names (VMS) or environment variables were
1571
      --  created and should be deassigned to avoid polluting the environment
1572
      --  on VMS.
1573
      --  gnatmake only
1574
 
1575
      Current_Object_Path_File : Path_Name_Type := No_Path;
1576
      --  Current value of project object path file env var. Used to avoid
1577
      --  setting the env var to the same value.
1578
      --  gnatmake only
1579
 
1580
   end record;
1581
   --  Type to represent the part of a project tree which is private to the
1582
   --  Project Manager.
1583
 
1584
   type Processing_Flags is record
1585
      Require_Sources_Other_Lang : Boolean;
1586
      Report_Error               : Error_Handler;
1587
      When_No_Sources            : Error_Warning;
1588
      Allow_Duplicate_Basenames  : Boolean;
1589
      Compiler_Driver_Mandatory  : Boolean;
1590
      Error_On_Unknown_Language  : Boolean;
1591
      Require_Obj_Dirs           : Error_Warning;
1592
   end record;
1593
 
1594
   Gprbuild_Flags : constant Processing_Flags :=
1595
     (Report_Error               => null,
1596
      When_No_Sources            => Warning,
1597
      Require_Sources_Other_Lang => True,
1598
      Allow_Duplicate_Basenames  => False,
1599
      Compiler_Driver_Mandatory  => True,
1600
      Error_On_Unknown_Language  => True,
1601
      Require_Obj_Dirs           => Error);
1602
 
1603
   Gprclean_Flags : constant Processing_Flags :=
1604
     (Report_Error               => null,
1605
      When_No_Sources            => Warning,
1606
      Require_Sources_Other_Lang => True,
1607
      Allow_Duplicate_Basenames  => False,
1608
      Compiler_Driver_Mandatory  => True,
1609
      Error_On_Unknown_Language  => True,
1610
      Require_Obj_Dirs           => Warning);
1611
 
1612
   Gnatmake_Flags : constant Processing_Flags :=
1613
     (Report_Error               => null,
1614
      When_No_Sources            => Error,
1615
      Require_Sources_Other_Lang => False,
1616
      Allow_Duplicate_Basenames  => False,
1617
      Compiler_Driver_Mandatory  => False,
1618
      Error_On_Unknown_Language  => False,
1619
      Require_Obj_Dirs           => Error);
1620
 
1621
end Prj;

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.