home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / sinput-l.ads < prev    next >
Text File  |  1996-09-28  |  6KB  |  102 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                             S I N P U T . L                              --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.3 $                              --
  10. --                                                                          --
  11. --        Copyright (c) 1992,1993,1994,1995 NYU, All Rights Reserved        --
  12. --                                                                          --
  13. -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14. -- terms of the  GNU General Public License as published  by the Free Soft- --
  15. -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16. -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17. -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18. -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19. -- for  more details.  You should have  received  a copy of the GNU General --
  20. -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21. -- to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. --
  22. --                                                                          --
  23. ------------------------------------------------------------------------------
  24.  
  25. --  This child package contains the routines used to actually load a source
  26. --  file and create entries in the source file table. It also contains the
  27. --  routines to create virtual entries for instantiations. This is separated
  28. --  off into a child package to avoid a dependence of Sinput on Osint which
  29. --  would cause trouble in the tree read/write routines.
  30.  
  31. with Types; use Types;
  32.  
  33. package Sinput.L is
  34.  
  35.    -------------------------------------
  36.    -- Handling Generic Instantiations --
  37.    -------------------------------------
  38.  
  39.    --  As described in Sem_Ch12, a generic instantiation involves making a
  40.    --  copy of the tree of the generic template. The source locations in
  41.    --  this tree directly reference the source of the template. However it
  42.    --  is also possible to find the location of the instantiation.
  43.  
  44.    --  This is achieved as follows. When an instantiation occurs, a new entry
  45.    --  is made in the source file table. This entry points to the same source
  46.    --  text, i.e. the file that contains the instantiation, but has a distinct
  47.    --  set of Source_Ptr index values. The separate range of Sloc values avoids
  48.    --  confusion, and means that the Sloc values can still be used to uniquely
  49.    --  identify the source file table entry. It is possible for both entries
  50.    --  to point to the same text, because of the virtual origin pointers used
  51.    --  in the source table.
  52.  
  53.    --  The Instantiation field of this source file index entry, usually set
  54.    --  to No_Source_File, instead contains the Sloc of the instantiation. In
  55.    --  the case of nested instantiations, this Sloc may itself refer to an
  56.    --  instantiation, so the complete chain can be traced.
  57.  
  58.    --  Two routines are used to build these special entries in the source
  59.    --  file table. Create_Instantiation_Source is first called to build
  60.    --  the virtual source table entry for the instantiation, and then the
  61.    --  Sloc values in the copy are adjusted using Adjust_Instantiation_Sloc.
  62.  
  63.    type Sloc_Adjustment is private;
  64.    --  Type returned by Create_Instantiation_Source for use in subsequent
  65.    --  calls to Adjust_Instantiation_Sloc.
  66.  
  67.    -----------------
  68.    -- Subprograms --
  69.    -----------------
  70.  
  71.    procedure Adjust_Instantiation_Sloc (N : Node_Id; A : Sloc_Adjustment);
  72.    --  The instantiation tree is created by copying the tree of the generic
  73.    --  template (including the original Sloc values), applying Adjust_Sloc
  74.    --  to each copied node to adjust the Sloc to reference the source entry
  75.    --  for the instantiation.
  76.  
  77.    procedure Create_Instantiation_Source
  78.      (X   : Source_File_Index;
  79.       Loc : Source_Ptr;
  80.       A   : out Sloc_Adjustment);
  81.    --  This procedure creates the source table entry for an instantiation.
  82.    --  X is the index of the source file containing the generic template,
  83.    --  and A is set to an adjustment factor to be used in subsequent calls
  84.    --  to Adjust_Instantiation_Sloc. Loc is the SLoc for the instantiation.
  85.  
  86.    function Load_Source_File (N : File_Name_Type) return Source_File_Index;
  87.    --  Given a source file name, returns the index of the corresponding entry
  88.    --  in the the source file table. If the file is not currently loaded, then
  89.    --  this is the call that causes the source file to be read and an entry
  90.    --  made in the table. A new entry in the table has the file name and time
  91.    --  stamp entries set and the Casing entries set to Unknown. Version is set
  92.    --  to all blanks, and the lines table is initialized but only the first
  93.    --  entry is set (and Last_Line is set to 1). If the given source file
  94.    --  cannot be opened, then the value returned is No_Source_File.
  95.  
  96. private
  97.    type Sloc_Adjustment is new Int;
  98.    --  This is simply the Int value to be added to the template Sloc value
  99.    --  to obtain the corresponding Sloc for the instantiation reference.
  100.  
  101. end Sinput.L;
  102.