gcc/ada/sinput-p.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             S I N P U T . P                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2008, 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 --  This child package contains the routines used to actually load a project
  27 --  file and create entries in the source file table. It also contains two
  28 --  routines to save and restore a project scan context.
  29
  30 with Scans; use Scans;
  31
  32 package Sinput.P is
  33
  34    procedure Clear_Source_File_Table;
  35    --  This procedure frees memory allocated in the Source_File table (in the
  36    --  private part of package Sinput). It should only be used when it is
  37    --  guaranteed that all source files that have been loaded so far will not
  38    --  be accessed before being reloaded. It is intended for tools that parse
  39    --  several times sources, to avoid memory leaks.
  40
  41    function Load_Project_File (Path : String) return Source_File_Index;
  42    --  Load the source of a project source file into memory and initialize the
  43    --  Scans state.
  44
  45    procedure Reset_First;
  46    --  Indicate that the next project loaded should be considered as the first
  47    --  one, so that Sinput.Main_Source_File is set for this project file. This
  48    --  is to get the correct number of lines when error finalization is called.
  49
  50    function Source_File_Is_Subunit (X : Source_File_Index) return Boolean;
  51    --  This function determines if a source file represents a subunit. It works
  52    --  by scanning for the first compilation unit token, and returning True if
  53    --  it is the token SEPARATE. It will return False otherwise, meaning that
  54    --  the file cannot possibly be a legal subunit. This function does NOT do a
  55    --  complete parse of the file, or build a tree. It is used in gnatmake and
  56    --  gprbuild to decide if a body without a spec in a project file needs to
  57    --  be compiled or not.
  58
  59    type Saved_Project_Scan_State is limited private;
  60    --  Used to save project scan state in following two routines
  61
  62    procedure Save_Project_Scan_State
  63      (Saved_State : out Saved_Project_Scan_State);
  64    pragma Inline (Save_Project_Scan_State);
  65    --  Save the Scans state, as well as the values of Source and
  66    --  Current_Source_File.
  67
  68    procedure Restore_Project_Scan_State
  69      (Saved_State : Saved_Project_Scan_State);
  70    pragma Inline (Restore_Project_Scan_State);
  71    --  Restore the Scans state and the values of Source and
  72    --  Current_Source_File.
  73
  74 private
  75
  76    type Saved_Project_Scan_State is record
  77       Scan_State          : Saved_Scan_State;
  78       Source              : Source_Buffer_Ptr;
  79       Current_Source_File : Source_File_Index;
  80    end record;
  81
  82 end Sinput.P;