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-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 --  This child package contains the routines used to actually load a project
  28 --  file and create entries in the source file table. It also contains two
  29 --  routines to save and restore a project scan context.
  30
  31 with Scans; use Scans;
  32
  33 package Sinput.P is
  34
  35    function Load_Project_File (Path : String) return Source_File_Index;
  36    --  Load into memory the source of a project source file.
  37    --  Initialize the Scans state.
  38
  39    procedure Reset_First;
  40    --  Indicate that the next project loaded should be considered as the first
  41    --  one, so that Sinput.Main_Source_File is set for this project file. This
  42    --  is to get the correct number of lines when error finalization is called.
  43
  44    function Source_File_Is_Subunit (X : Source_File_Index) return Boolean;
  45    --  This function determines if a source file represents a subunit. It
  46    --  works by scanning for the first compilation unit token, and returning
  47    --  True if it is the token SEPARATE. It will return False otherwise,
  48    --  meaning that the file cannot possibly be a legal subunit. This
  49    --  function does NOT do a complete parse of the file, or build a
  50    --  tree. It is used in gnatmake to decide if a body without a spec
  51    --  in a project file needs to be compiled or not.
  52
  53    type Saved_Project_Scan_State is limited private;
  54    --  Used to save project scan state in following two routines
  55
  56    procedure Save_Project_Scan_State
  57      (Saved_State : out Saved_Project_Scan_State);
  58    pragma Inline (Save_Project_Scan_State);
  59    --  Save the Scans state, as well as the values of
  60    --  Source and Current_Source_File.
  61
  62    procedure Restore_Project_Scan_State
  63      (Saved_State : Saved_Project_Scan_State);
  64    pragma Inline (Restore_Project_Scan_State);
  65    --  Restore the Scans state and the values of
  66    --  Source and Current_Source_File.
  67
  68 private
  69
  70    type Saved_Project_Scan_State is record
  71       Scan_State          : Saved_Scan_State;
  72       Source              : Source_Buffer_Ptr;
  73       Current_Source_File : Source_File_Index;
  74    end record;
  75
  76 end Sinput.P;