gcc/ada/prj-ext.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              P R J . E X T                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2000-2007, 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 --  Subprograms to set, get and cache external references, to be used as
  27 --  External functions in project files.
  28
  29 package Prj.Ext is
  30
  31    Gpr_Project_Path : constant String := "GPR_PROJECT_PATH";
  32    --  Name of primary env. variable that contain path name(s) of directories
  33    --  where project files may reside.
  34
  35    procedure Add_Search_Project_Directory (Path : String);
  36    --  Add a directory to the project path. Directories added with this
  37    --  procedure are added in order after the current directory and before
  38    --  the path given by the environment variable GPR_PROJECT_PATH. A value
  39    --  of "-" will remove the default project directory from the project path.
  40
  41    function Project_Path return String;
  42    --  Return the current value of the project path, either the value set
  43    --  during elaboration of the package or, if procedure Set_Project_Path has
  44    --  been called, the value set by the last call to Set_Project_Path.
  45
  46    procedure Set_Project_Path (New_Path : String);
  47    --  Give a new value to the project path. The new value New_Path should
  48    --  always start with the current directory (".") and the path separators
  49    --  should be the correct ones for the platform.
  50
  51    procedure Add
  52      (External_Name : String;
  53       Value         : String);
  54    --  Add an external reference (or modify an existing one)
  55
  56    function Value_Of
  57      (External_Name : Name_Id;
  58       With_Default  : Name_Id := No_Name)
  59       return          Name_Id;
  60    --  Get the value of an external reference, and cache it for future uses
  61
  62    function Check (Declaration : String) return Boolean;
  63    --  Check that an external declaration <external>=<value> is correct.
  64    --  If it is correct, the external reference is Added.
  65
  66    procedure Reset;
  67    --  Clear the internal data structure that stores the external references
  68    --  and free any allocated memory.
  69
  70 end Prj.Ext;