| 12
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 
 | ------------------------------------------------------------------------------
--                                                                          --
--                     ASIS UTILITY LIBRARY COMPONENTS                      --
--                                                                          --
--                     A S I S _ U L . P R O J E C T S                      --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--                     Copyright (C) 2013-2015, AdaCore                     --
--                                                                          --
-- Asis Utility Library (ASIS UL) is free software; you can redistribute it --
-- and/or  modify  it  under  terms  of  the  GNU General Public License as --
-- published by the Free Software Foundation; either version 3, or (at your --
-- option)  any later version.  ASIS UL  is distributed in the hope that it --
-- will  be  useful,  but  WITHOUT  ANY  WARRANTY; without even the implied --
-- warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the --
-- GNU  General Public License for more details. You should have received a --
-- copy of the  GNU General Public License  distributed with GNAT; see file --
-- COPYING3. If not,  go to http://www.gnu.org/licenses for a complete copy --
-- of the license.                                                          --
--                                                                          --
-- ASIS UL is maintained by AdaCore (http://www.adacore.com).               --
--                                                                          --
------------------------------------------------------------------------------
--  This package contains high-level interfaces to project files. These
--  interfaces are supposed to be enough to extract all the information an
--  [ASIS-based] tool may need from the argument project file.
--
--  A part of project file processing is tool-specific: there are tool-specific
--  packages and parameters in the project file, so this package defines only
--  the common steps needed for extracting the information from the project
--  file by providing the Arg_Project_Type type. A tool has to extend this
--  type by providing operations for dealing with tool-specific attributes.
--
--  The interface provided here assumes that a tool is based on the Source
--  Table defined in ASIS_UL.Source_Table.
--
--  The recommended way of project file processing is:
--
--  Two main steps of processing the project file that is the tool argument
--  should be done:
--
--  (a) analyzing the project file as a part of the analysis of the tool
--      command line arguments. At this stage the following information is
--      supposed to be extracted and stored in the tool data structures:
--
--      * options to be used to call gcc to create tree files;
--      * tool-specific options;
--      * a list of argument sources (in case when a tool is called without
--        argument sources, that means that all the sources of the project
--        should be processed);
--
--  (b) creating the mapping file for the project sources and storing the
--      compilation options that are specific for the argument sources.
--
--  The important thing is that when a project file is provided as a tool
--  parameter, the tool cannot use any source search path to locate sources and
--  to form the set of options (-I options or placing the source search path
--  into an environment variable) for gcc call.
--
--  The general tool architecture implemented in the ASIS Utility Library
--  defines the following sequence of tool initialization:
--
--  (1) tool parameters are analyzed and stored, at this stage the tool
--      argument files are stored in some temporary storage, but not in the
--      source table;
--
--  (2) a check is made that the set of tool options is consistent, and if
--      it is, the argument sources are moved from the temporary storage into
--      the source table, and at this stage it is checked that a source to be
--      placed in the source table exists, and that there is no duplication
--      in the set of argument sources. As a result, the source table
--      contains only existing sources with no duplication.
--
--  ???
--  The step (a) above is a part of the step (1) of the general tool
--  initialization, but the step (b) can be done only when we have a list of
--  the existing argument files with no duplications, so it is performed as a
--  part of step (2) *after* moving the argument files into the source table.
--  This is why there are basically two places in the tool code that is
--  responsible for the project file processing.
--  ???
--
--  To represent the project file provided as a tool parameter, we define the
--  Arg_Project_Type (that is derived from GNATCOLL.Projects.Project_Tree. In
--  the specification below the primitives of this type are separated into
--  three groups:
--  * operations that hardly need redefinition for a tool;
--  * operations that may need redefinition for a tool;
--  * operations that for sure need redefinition for a tool;
--
--  It is supposed that a tool may have at most one project file as its
--  argument, so it can be only one object of a tool-specific descendant of the
--  Arg_Project_Type declared in the tool code.
--
--  *** Processing tool parameters ***
--
--  If a tool can accept a project file as an argument, we have to process tool
--  command line parameters twice and in between we have to process the project
--  file. The reason is that tool options may be specified both on the command
--  line and in the tool-specific package of the project file, and the
--  resulting list of options to be applied to the tool should be the
--  superposition of the options from the project file and from the command
--  line in the following order:
--
--   <options from project file><options from command line>
--
--  So, the processing of the tool parameters should be a sequence of three
--  steps:
--
--  1. Scan the command-line parameters, but store only the following
--     information:
--     * project-specific options (-P, -U, -X, -vP)
--     * '--help' and '--version'
--     * argument sources (specified either directly or by any other means,
--       for example as '--files=list_of_arg_sources.txt'
--       where list_of_arg_sources.txt is a text file containing the names of
--       the argument sources
--
--  2. If at the first step either '--help' or '--version' option is detected,
--     print out the corresponding information and exit from the tool. Else if
--     at the first step '-P prj' option is detected, analyze the project file
--     prj (taking into account all the other project-specific options). This
--     includes extracting the tool options, compilation parameters for
--     creating tree files and argument sources (if needed).
--
--  3. Scan again the command-line parameters, but this time ignore all the
--     options listed in paragraph 1 above, but store all the other options.
--     This gives the required superposition of the options specified in the
--     project file and in the command line.
--
--  The proposed implementation of the project support relies on the following:
--
--  * All the tool-specific options in a project file are given in a
--    tool-specific package;
--  * This tool-specific package can contain two attributes - Default_Switches
--    indexed by "ada" and Switches indexed by the names of Ada sources;
--  * The list of values of these attributes has exactly the same structure
--    as the list of options and arguments in the command line tool call with
--    the following exceptions:
--    - no project-specific option is allowed;
--    - '--help' and '--version' options are not allowed
--    - Switches attribute cannot have argument sources as its values
--      (specified either directly or by a list of sources)
--
--  As a result, the same scanner is used to process the command line and the
--  values of the attributes Default_Switches and Switches - this is the
--  operation Scan_Arguments of Arg_Project_Type that has to be defined for
--  each tool. This procedure with the appropriate command line parser and
--  boolean parameters that indicate the case of ins usage) implements steps 1
--  and 3 above. For step 2, see the class-wide procedure Process_Project_File
--  that combines all the steps of loading and analyzing the project file.
--
--  Procedure Set_Individual_Source_Options stores compilation attributes
--  specific for individual sources. It should be called (immediately) after
--  moving all the argument sources into the source table.
--
--  The important thing is that the routines from GNATCOLL.Projects hierarchy
--  the given package is based upon uses the same data structures as the
--  front-end uses to create and to keep the tree. This means that all the
--  project analysis should be done before an ASIS tool opens an ASIS Context
--  for the first time. Opening a Context usually means reading in some tree
--  file and this completely destroys all the data that represents the project
--  that has been loaded and analysed as a tool option. For this reason ASIS
--  tools should not use GNATCOLL.Projects.Aux.Delete_All_Temp_Files procedure
--  - it will not delete anything.
pragma Ada_2012;
with GNAT.Command_Line; use GNAT.Command_Line;
with GNAT.OS_Lib;       use GNAT.OS_Lib;
with GNATCOLL.Projects; use GNATCOLL.Projects;
with GNATCOLL.VFS;      use GNATCOLL.VFS;
with ASIS_UL.Debug;     use ASIS_UL.Debug;
package ASIS_UL.Projects is
   ------------------------------
   -- Project-specific options --
   ------------------------------
   Try_Project_File : Boolean renames Debug_Flag_9;
   --  If this flag is ON, Process_Project_File does not do any processing of
   --  the argument project file, it only tries to load it and to print out
   --  project sources. And then an exit to OS is issued. This may be useful to
   --  do a general check for GNATCOLL.Projects routines on cross and bb
   --  plarforms where we might not have GNATCOLL installed.
   ---------------------------------------------------------------------
   -- -eL  : Follow all symbolic links when processing project files. --
   ---------------------------------------------------------------------
   Follow_Symbolic_Links : Boolean := False;
   ------------------------------------------------------
   -- -vPn  : verbosity level on project file analysis --
   ------------------------------------------------------
   subtype Verbosity_Levels is Natural range 0 .. 2;
   Verbosity_Level : Verbosity_Levels := 0;
   --------------------------------------------------------------------------
   -- -U [main_unit]  : get the source or main_unit closure of the project --
   --------------------------------------------------------------------------
   File_List_Specified : Boolean := False;
   --  Indicates if '-files=...' option is specified. We need to know this when
   --  getting the list of files from the project - '-U' should be  ignored if
   --  '-files=...' is specified.
   U_Option_Set : Boolean := False;
   --  Indicates if -U option is specified for the project (to process all the
   --  units of the closure of the argument project or to process the closure
   --  of the main unit if the main unit is set)
   Main_Unit : String_Access;
   --  If the tool is called with "... Pproj -U main_unit", main_unit is stored
   --  here
   procedure Store_Main_Unit
     (Unit_Name   : String;
      Store       : Boolean := True);
   --  Processes the result returned by GNAT.Comand_Line.Get_Argument provided
   --  that it is supposed to be the main unit name for '-U' project file
   --  option.
   --
   --  If Store is ON, stores the name of the unit and generates an error
   --  message if the name is already stored (-U allows only one name of the
   --  main unit specified). If Store is OFF, does not do any checks and does
   --  not store anything.
   -----------------------------------------------------------
   --  -Xvariable=value  : set values of external variables --
   -----------------------------------------------------------
   --  An external variable is the parameter of a '-X<par>' tool option, it
   --  is guaranteed that it has a structure <variable_name>=<value>
   procedure Init_External_Variables_Table;
   --  Cleans up and (re)initialize the storage for external variables. You do
   --  not need to call this procedure before the  first usage of this storage.
   procedure Store_External_Variable
     (Var                  : String;
      Is_From_Command_Line : Boolean := True);
   --  Checks if the value for the given external variable is already stored
   --  (the check is case-sensitive), and if it does not, stores the value
   --  setting for the given variable. If it does, overrides the stored value
   --  in case if both the stored and new value are given in the tool command
   --  line or if both of them are from the project file.
   --
   --  Now we do not need  Is_From_Command_Line parameter. It has been
   --  introduced to process the situation when external variables may be
   --  defined both in the command line and in the project file itself.
   --------------------------------------------------------------------------
   -- --subdirs=<d>  : <d> is subdirectories to place the tool output into --
   --------------------------------------------------------------------------
   Subdir_Name : String_Access;
   --  If Subdir_Name is null, no special subdirectory is used for tool
   --  results.
   procedure Set_Subdir_Name (S : String);
   --  Sets Subdir_Name to S (if Subdir_Name is not null, frees the old value).
   --  We may have '--subdirs=<d>' option both in command line and in the list
   --  of values of Default_Switches and Switches attributes in the tool
   --  package in the project file.
   ----------------------------------------------------------------
   -- --no_object_dir : do not place the results into object dir --
   ----------------------------------------------------------------
   No_Object_Dir : Boolean := False;
   --  If this flag is ON, the tool should emulate the old behavior it has had
   --  when the tool has been called as 'gnat <tool> -P prj. Most of the ASIS
   --  tools in this case place their results into current dir, but not in the
   --  object directory of the project file.
   ---------------------------------------------------------
   -- Type to represent a project passed as a tool option --
   ---------------------------------------------------------
   type Arg_Project_Type is new Project_Tree with private;
   --  This type is the base for each tool-specific project type. Most of its
   --  primitives does not need any redefinition for a specific tool.
   ------------------------------------------------------------------
   -- Primitives that hardly need redefinition for a specific tool --
   ------------------------------------------------------------------
   procedure Store_Project_Source
     (My_Project         : in out Arg_Project_Type;
      Project_File_Name  : String);
   --  If Project_File_Name ends with ".gpr", it is taken to be the name of
   --  the project file; otherwise Project_File_Name & ".gpr" is used.
   --  Checks that:
   --    - this is the first -P option provided as a tool parameter;
   --    - the project file exists.
   --  Raises ASIS_UL.Common.Parameter_Error if any of these check fails,
   --  stores the name of the project file My_Project otherwise.
   function Is_Specified (My_Project : Arg_Project_Type) return Boolean;
   --  Checks if the argument represents a project that corresponds to some
   --  project file specified as a tool parameter.
   function Source_Prj (My_Project : Arg_Project_Type) return String;
   --  If My_Project.Is_Specified then returns the full normalized name of the
   --  project file, otherwise returns a null string.
   procedure Load_Tool_Project (My_Project : in out Arg_Project_Type);
   --  Does the same as GNATCOLL.Projects.Load, the only difference is that
   --  all the parameters except the project are hidden. This procedure never
   --  generates any error of warning message, because here we do not know
   --  values of external variables.
   procedure Set_External_Values (My_Project : in out Arg_Project_Type);
   --  For each value of an external variable that has been stored as a result
   --  of the initial parameter processing, checks that the given variable
   --  indeed is defined in the project, and the value specified for it is
   --  the valid value for this variable. If both checks are successful sets
   --  the given value as the value of a given variable, otherwise raises
   --  Parameter_Error. If all the stored pairs of external variable names and
   --  corresponding values are successfully processed, recomputes the view of
   --  the project with these values of external variables.
   procedure Extract_Compilation_Attributes
     (My_Project : in out Arg_Project_Type);
   --  Extracts and stores as compiler options the attributes that may be
   --  needed to call the compiler from the tool to create the tree.
   --
   --  The default version extracts and stores options corresponding to the
   --  following attributes:
   --     Builder.Global_Configuration_Pragmas
   --     Builder.Global_Config_File
   --     Compiler.Local_Configuration_Pragmas
   --     Compiler.Local_Config_File
   --
   --  This procedure is not supposed to be used by the tool directly, but it
   --  is used by Extract_Tool_Attributes, and you may want to redefine it for
   --  your tool.
   --
   --  ??? Should we extract anything more then global configuration file
   --  here???
   procedure Get_Sources_From_Project
     (My_Project : Arg_Project_Type);
   --  Extracts and stores the list of sources of the project to process as
   --  tool arguments.
   --
   --  More documentation is needed:
   --
   --  * when we extract the sources from the project
   --  * what happens when
   --    o there is no -U option
   --    o -U option is specified, but without the main unit
   --    o -U option is specified with the main unit name
   --
   --  ??? Extended projects???
   procedure Set_Global_Result_Dirs (My_Project : in out Arg_Project_Type);
   --  Sets the directory to place the global tool results into.
   procedure Create_Configuration_File (My_Project : Arg_Project_Type);
   procedure Create_Mapping_File (My_Project : Arg_Project_Type);
   --  Create the configuration/mapping file for the project and adds the
   --  corresponding option to the list of options used to create the tree.
   --
   --  These procedures form the important parameters for the compiler call to
   --  create the tree, so the caller should call to
   --  ASIS_US.Compiler_Options.Set_Arg_List after the calls to these
   --  subprograms.
   procedure Set_Individual_Source_Options (My_Project : Arg_Project_Type);
   --  Also for each file from the project that is a tool argument computes and
   --  stores in the source table the list of compiler options needed to create
   --  the tree for this particular file. It also defines the directory the
   --  file-specific results of the tool should be placed into. This procedure
   --  should be called *after* storing the argument files in the source
   --  table. It is NOT a part of the actions combined in Process_Project_File
   --  procedure.
   procedure Store_Files_From_Binder_Output
     (My_Project :        Arg_Project_Type;
      Success    : in out Boolean);
   --  Provided that the tool arguments contain '-U main_unit' parameter,
   --  tries to get the full closure of main_unit and to store it as tool
   --  argument files.
   --  This procedure assumes that:
   --  * the tool temporary directory has already been created;
   --  * we are in the directory the tool has been called from
   ---------------------------------------------------------------
   -- Primitives that may need redefinition for a specific tool --
   ---------------------------------------------------------------
   function Tool_Package_Name (My_Project : Arg_Project_Type) return String;
   --  Returns the name of the tool-specific package in a project file.
   --  Sometimes the name is the same as the tool name in a native GNAT
   --  installation (this is the result of this function), sometimes -
   --  something else (such as "Check" for "gnatcheck"), in this case the
   --  function has to be redefined in the tool.
   function Section_Delimiters (My_Project : Arg_Project_Type) return String;
   --  Returns the string defining section delimiters in the command line/
   --  list of values for Default_Switches/Switches attributes, The default
   --  version returns "cargs'. You may need to redefine this function for your
   --  tool. For example gnatcheck needs "cargs rules"
   function Get_Section_Delimiters
     (My_Project : Arg_Project_Type'Class) return String;
   --  Dispatches to the project-type-specific Section_Delimiters function, and
   --  returns the result, except that "cargs" is replaced with "inner-cargs"
   --  when appropriate, as explained in asis_ul-environment.adb.
   procedure Register_Tool_Attributes (My_Project : Arg_Project_Type) is null;
   --  For the tools that for a long time are a part of the GNAT toolset and
   --  that have got the GNAT Driver support we do not need to register any
   --  attribute because they are already known by the project parser. But for
   --  a new tool you may need to register attributes that are of interest for
   --  extracting tool options or source-specific switches
   procedure Extract_Tool_Options (My_Project : in out Arg_Project_Type);
   --  Extracts tool attributes from the project file. The default does the
   --  following:
   --  * if there is exactly one source file specified, tries to get the tool
   --    options from the Switches attribute with the corresponding index. If
   --    there is no such Switches attribute, tries to get tool attributes from
   --    the Default_Switches attribute.
   --  * otherwise tries to get the tool attributes from the Default_Switches
   --    attribute.
   function Needs_Per_File_Output
     (My_Project : Arg_Project_Type)
      return       Boolean is (False);
   --  Tells if the tool needs to generate some output for each argument file.
   function Source_Result_Dir
     (My_Project  : Arg_Project_Type;
      Source_Prj  : Project_Type;
      Source_File : Virtual_File)
   return           String;
   --  Detects the path to the directory where the source-specific results
   --  for Source_File should be placed. The default version returns the object
   --  directory for the project the source belongs to (Source_Prj), it takes
   --  into account the effect of  '--subdir=<dir>' option.
   function Compute_Project_Closure
     (My_Project  : Arg_Project_Type)
      return        Boolean is (True);
   --  Tells if source files should be extracted from the project if no
   --  argument file is specified explicitly. There are at least two tools
   --  that has to redefine this function to False - gnatelim and gnatstub.
   -------------------------------------------------------------------------
   -- Primitives that will for sure need redefinition for a specific tool --
   -------------------------------------------------------------------------
   procedure Print_Tool_Usage (My_Project : Arg_Project_Type);
   --  Prints out the tool usage info for '--help' option.
   procedure Scan_Arguments
     (My_Project  : in out Arg_Project_Type;
      First_Pass  :        Boolean    := False;
      Parser      :        Opt_Parser := Command_Line_Parser;
      In_Switches :        Boolean    := False);
   --  This procedure should be redefined for each tool project type. It
   --  should be called immediately after the call to Initialize_Option_Scan
   --  that should create the Parser for it. The procedure defines the loop
   --  through the parameters - either command-line parameters or tool
   --  parameters defined in a tool-specific package of the tool argument
   --  project file.
   --  If the actual for Parser is different from Command_Line_Parser, the
   --  procedure assumes the options from the project file. If In_Switches is
   --  ON, it assumes that the options are the values of the Switches
   --  attribute, otherwise - of the Default_Switches attribute.
   --  This procedure is supposed to be used for processing command-line
   --  parameters twice - first, it detects and stores only project-specific
   --  attributes, argument sources and '--help' and "--version' options, when
   --  called for this, it should have First_Pass parameter ON. Then, after
   --  processing the project file (if it is provided as a tool parameter and
   --  detected during the first pass through the command-line parameters),
   --  all the other command-line parameters should be processed and stored
   --  (this allows the parameters specified in the command line to override
   --  the parameters given in the project file), and when called for this,
   --  the procedure should have First_Pass set OFF.
   ------------------------------
   -- Non-primitive operations --
   ------------------------------
   procedure Store_Mapping_File_Name (S : String);
   procedure Store_Config_File_Name  (S : String);
   function Get_Mapping_File_Name return String;
   function Get_Config_File_Name  return String;
   --  A tool has to store the mames of the Ada mapping file and configuration
   --  flles created as a result of project file analysis to have a possibility
   --  to delete them (GNATCOLL.Projects.Aux.Delete_All_Temp_Files cannot be
   --  used for this because reading tree files destroyes the data structures
   --  it uses). Procesure Store_Mapping_File_Name (Store_Config_File_Name)
   --  stores its argument as the name of the mapping (configuration) file.
   --  Function Get_Mapping_File_Name (Get_Config_File_Name) returns the (last)
   --  name stored as the name of the mapping (configuration) file or an empty
   --  string of the mapping file name has not been stored.
   procedure Store_RTS_Path (S : String);
   --  ???
   function Get_RTS_Path return String;
   --  ???
   --------------------------------------
   --  General project file processing --
   --------------------------------------
   procedure Initialize_Environment;
   --  Initializes the environment for extracting the information from the
   --  project file. This includes setting the parameters specific for the
   --  given tool version assuming that the tools for cross environment are
   --  named in a standard way (that is, <cross-prefix>-<tool_name>.
   procedure Process_Project_File (My_Project : in out Arg_Project_Type'Class);
   --  Combines all the actions needed to process the argument project file
   --  except storing individual compilation options for argument files.
   ----------------------------------------------------------------------
   --  Obsolescent or not used operations, to be deleted at some point --
   ----------------------------------------------------------------------
   procedure Register_Non_Standard_Tool_Attributes
     (My_Project : in out Arg_Project_Type);
   --  Registers attributes that are specific for a given tool. The default
   --  version registers the attribute "default_switches" in package
   --  Tool_Package_Name (My_Project).
   --  Do we need this???
   procedure Extract_Tool_Attributes (My_Project : in out Arg_Project_Type);
   --  First of all, tries to extract from the projects all the '-X' attributes
   --  that are specific to a tool. This is done by calling to
   --  Extract_Tool_Xvars. Then sets the values of all the external variables
   --  using the information stored in external variables table. Raises
   --  Fatal_Error if any problem is detected (such as the name of the
   --  non-existent variable or a wrong value). Then reads and stores all the
   --  tool-specific options and parameters (this part is tool-specific, the
   --  default version calls Extract_Compilation_Attributes for this).
   --
   --  Do we need this now???
   --
   --  Comes from the first implementation of the project support framework for
   --  ASIS tools. Is supposed to deal with '-XVar=value' options in the
   --  project file. At some point we should get rid of it.
   procedure Extract_Tool_Xvars (My_Project : in out Arg_Project_Type);
   --  Extracts from the project and stores '-X' options that are specific
   --  for a tool. The default version look for '-X'  options in the list of
   --  values of "<default_switches" attribute in the
   --  Tool_Package_Name (My_Project) package.
   --
   --  This procedure is not supposed to be used by the tool directly, but it
   --  is used by Extract_Tool_Attributes, and you may want to redefine it for
   --  your tool.
   --  Do we need this???
   --  The story here is the following. Extracting the values of external
   --  variables from the tool-specific package of the project file has been
   --  originally implemented in gnattest and then repeated in the first
   --  implementation of the project support framework for ASIS tools. But then
   --  it has been decided that it should be no -XVar=value options in the
   --  project file itself. We keep this function for two reasons:
   --  * for the development period - some ASIS tools still use it for now
   --  * just in case if at some point we decide to go back to having
   --    '-Xvar=value' in a project file (???)
   --
   --  To be revised when the development of this package is mostly done.
   --  Most probably we should get rid of this function!!!
private
   type Arg_Project_Type is new Project_Tree with record
      Source_Prj : String_Access;
      --  Stores the name of the project file that is a tool argument
   end record;
end ASIS_UL.Projects;
 |