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 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 --  Subprograms to set, get and cache external references, to be used as
  28 --  External functions in project files.
  29
  30 package Prj.Ext is
  31
  32    Gpr_Project_Path : constant String := "GPR_PROJECT_PATH";
  33    --  Name of primary env. variable that contain path name(s) of directories
  34    --  where project files may reside.
  35
  36    procedure Add_Search_Project_Directory (Path : String);
  37    --  Add a directory to the project path. Directories added with this
  38    --  procedure are added in order after the current directory and before
  39    --  the path given by the environment variable GPR_PROJECT_PATH. A value
  40    --  of "-" will remove the default project directory from the project path.
  41
  42    function Project_Path return String;
  43    --  Return the current value of the project path, either the value set
  44    --  during elaboration of the package or, if procedure Set_Project_Path has
  45    --  been called, the value set by the last call to Set_Project_Path.
  46
  47    procedure Set_Project_Path (New_Path : String);
  48    --  Give a new value to the project path. The new value New_Path should
  49    --  always start with the current directory (".") and the path separators
  50    --  should be the correct ones for the platform.
  51
  52    procedure Add
  53      (External_Name : String;
  54       Value         : String);
  55    --  Add an external reference (or modify an existing one)
  56
  57    function Value_Of
  58      (External_Name : Name_Id;
  59       With_Default  : Name_Id := No_Name)
  60       return          Name_Id;
  61    --  Get the value of an external reference, and cache it for future uses
  62
  63    function Check (Declaration : String) return Boolean;
  64    --  Check that an external declaration <external>=<value> is correct.
  65    --  If it is correct, the external reference is Added.
  66
  67    procedure Reset;
  68    --  Clear the internal data structure that stores the external references
  69    --  and free any allocated memory.
  70
  71 end Prj.Ext;