Geek Gadgets 1

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.ads < prev next >

Wrap

Text File | 1996-09-28 | 18KB | 375 lines

------------------------------------------------------------------------------ -- -- -- GNAT COMPILER COMPONENTS -- -- -- -- S I N P U T -- -- -- -- S p e c -- -- -- -- $Revision: 1.33 $ -- -- -- -- Copyright (c) 1992,1993,1994,1995 NYU, All Rights Reserved -- -- -- -- The GNAT library is free software; you can redistribute it and/or modify -- -- it under terms of the GNU Library General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) any -- -- later version. The GNAT library is distributed in the hope that it will -- -- be useful, but WITHOUT ANY WARRANTY; without even the implied warranty -- -- of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- -- Library General Public License for more details. You should have -- -- received a copy of the GNU Library General Public License along with -- -- the GNAT library; see the file COPYING.LIB. If not, write to the Free -- -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. -- -- -- ------------------------------------------------------------------------------ -- This package contains the input routines used for reading the -- input source file. The actual I/O routines are in OS_Interface, -- with this module containing only the system independent processing. -- General Note: throughout the compiler, we use the term line or source -- line to refer to a physical line in the source, terminated by the end of -- physical line sequence. See Skip_Line_Terminators procedure for a full -- description of the difference between logical and physical lines. with Casing; use Casing; with Table; with Types; use Types; package Sinput is ----------------------- -- Source File Table -- ----------------------- -- The source file table has an entry for each source file read in for -- this run of the compiler. This table is (default) initialized when -- the compiler is loaded, and simply accumulates entries as compilation -- proceeds and the Sinput.L.Load_Source_File procedure is called to load -- required source files. -- In the case where there are multiple main units (e.g. in the case of -- the cross-reference tool), this table is not reset between these units, -- so that a given source file is only read once if it is used by two -- separate main units. -- The entries in the table are accessed using a Source_File_Index that -- ranges from 1 to Last_Source_File. Each entry has the following fields -- File_Name : File_Name_Type -- Name of the source file (simple name with no directory information). -- Set by Sinput.L.Load_Source_File and cannot be subequently changed. -- Full_File_Name : File_Name_Type -- Full file name (full name with directory info), used for generation -- of error messages, etc. Set by Sinput.L.Load_Source_File and cannot -- be subsequently changed. -- Reference_Name : File_Name_Type -- Name to be used for source file references in error messages and -- debugging information. Identical to Full_File_Name unless pragma -- Source_Reference is used to change it. Only the processing for -- the Source_Reference pragma may set this field. -- Line_Offset : Int; -- Line number value to be added to physical line numbers in file to -- get logical line number for error messages. Normally zero unless -- reset by pragma Source_Reference. This value is never referenced by -- clients who should use Logical_To_Physical and Physical_To_Logical -- instead, but it is set by pragma Source_Reference processing. -- Source_Text : Source_Buffer_Ptr -- Text of source file. Note that every source file has a distinct set -- of non-overlapping logical bounds, so it is possible to determine -- which file is referenced from a given subscript (Source_Ptr) value. -- Set by Sinput.L.Load_Source_File and cannot be subsequently changed. -- Source_First : Source_Ptr; -- Subscript of first character in Source_Text. Note that this cannot -- be obtained as Source_Text'First, because we use virtual origin -- addressing. Set by Sinput.L procedures when the entry is first -- created and never subsequently changed. -- Source_Last : Source_Ptr; -- Subscript of last character in Source_Text. Note that this cannot -- be obtained as Source_Text'Last, because we use virtual origin -- addressing, so this value is always Source_Ptr'Last. Set by -- Sinput.L procedures when the entry is first created and never -- subsequently changed. -- Time_Stamp : Time_Stamp_Type; -- Time stamp of the source file. Set by Sinput.L.Load_Source_File, -- and cannot be subsequently changed. -- Num_Source_Lines : Nat -- Number of source lines in the file. While a file is being read, -- it is the number of lines so far scanned. Read only for clients. -- Keyword_Casing : Casing_Type; -- Casing style used in file for keyword casing. This is initialized -- to Unknown, and then set from the first occurrence of a keyword. -- This value is used only for formatting of error messages. -- Identifier_Casing : Casing_Type; -- Casing style used in file for identifier casing. This is initialized -- to Unknown, and then set from an identifier in the program as soon as -- one is found whose casing is sufficiently clear to make a decision. -- This value is used for formatting of error messages, and also is used -- in the detection of keywords misused as identifiers. -- Instantiation : Source_Ptr; -- Source file location of the instantiation if this source file entry -- represents a generic instantiation. Set to No_Location for the case -- of a normal non-instantiation entry. See Sinput_L for details. This -- field is read-only for clients. -- Template : Source_File_Index; -- Source file index of the source file containing the template if this -- is a generic instantiation. Set to No_Source_File for the normal case -- of a non-instantiation entry. See Sinput_L for details. This field is -- read-only for clients. -- The source file table is accessed by clients using the following -- subprogram interface: function File_Name (S : Source_File_Index) return File_Name_Type; function Full_File_Name (S : Source_File_Index) return File_Name_Type; function Identifier_Casing (S : Source_File_Index) return Casing_Type; function Instantiation (S : Source_File_Index) return Source_Ptr; function Keyword_Casing (S : Source_File_Index) return Casing_Type; function Num_Source_Lines (S : Source_File_Index) return Nat; function Reference_Name (S : Source_File_Index) return File_Name_Type; function Source_Text (S : Source_File_Index) return Source_Buffer_Ptr; function Source_First (S : Source_File_Index) return Source_Ptr; function Source_Last (S : Source_File_Index) return Source_Ptr; function Template (S : Source_File_Index) return Source_File_Index; function Time_Stamp (S : Source_File_Index) return Time_Stamp_Type; procedure Set_Keyword_Casing (S : Source_File_Index; C : Casing_Type); procedure Set_Identifier_Casing (S : Source_File_Index; C : Casing_Type); -- The following two routines may be used only by the processing for -- the Source_Reference pragma, and by no other client. procedure Set_Line_Offset (S : Source_File_Index; V : Int); procedure Set_Reference_Name (S : Source_File_Index; N : File_Name_Type); function Last_Source_File return Source_File_Index; -- Index of last source file table entry function Num_Source_Files return Nat; -- Number of source file table entries ----------------- -- Global Data -- ----------------- Current_Source_File : Source_File_Index; -- Source_File table index of source file currently being scanned Current_Source_Unit : Unit_Number_Type; -- Unit number of source file currently being scanned Source : Source_Buffer_Ptr; -- Current source (copy of Source_File.Table (Current_Source_Unit).Source) Internal_Source : aliased Source_Buffer (1 .. 81); -- This buffer is used internally in the compiler when the lexical analyzer -- is used to scan a string from within the compiler. The procedure is to -- establish Internal_Source_Ptr as the value of Source, set the string to -- be scanned, appropriately terminated, in this buffer, and set Scan_Ptr -- to point to the start of the buffer. It is a fatal error if the scanner -- signals an error while scanning a token in this internal buffer. Internal_Source_Ptr : constant Source_Buffer_Ptr := Internal_Source'Access; -- Pointer to internal source buffer ----------------- -- Subprograms -- ----------------- procedure Backup_Line (P : in out Source_Ptr); -- Back up the argument pointer to the start of the previous line. On -- entry, P points to the start of a physical line in the source buffer. -- On return, P is updated to point to the start of the previous line. -- The caller has checked that a Line_Terminator character precedes P so -- that there definitely is a previous line in the source buffer. function Get_Column_Number (P : Source_Ptr) return Column_Number; -- The ones-origin column number of the specified Source_Ptr value is -- determined and returned. Tab characters if present are assumed to -- represent the standard 1,9,17.. spacing pattern. function Get_Line_Number (P : Source_Ptr) return Logical_Line_Number; -- The line number of the specified source position is obtained by -- doing a binary search on the source positions in the lines table -- for the unit containing the given source position. The returned -- value has already been adjusted by adding the Line_Offset value. function Get_Source_File_Index (S : Source_Ptr) return Source_File_Index; -- Return file table index of file identified by given source pointer -- value. This call must always succeed, since any valid source pointer -- value belongs to some previously loaded source file. function Line_Start (P : Source_Ptr) return Source_Ptr; -- Finds the source position of the start of the line containing the -- given source location. function Line_Start (L : Logical_Line_Number; S : Source_File_Index) return Source_Ptr; -- Finds the source position of the start of the given line in -- the given source file. function Logical_To_Physical (Line : Logical_Line_Number; S : Source_File_Index) return Nat; -- Given a logical line number in source file whose source index is S, -- return the corresponding physical line number. function Physical_To_Logical (Line : Nat; S : Source_File_Index) return Logical_Line_Number; -- Given a physical line number in source file whose source index is S, -- return the corresponding logical line number. procedure Skip_Line_Terminators (P : in out Source_Ptr; Physical : out Boolean); -- On entry, Source (P) points to the line terminator character that -- terminates a line. The result set in P is the location of the first -- character of the following line (after skipping the sequence of line -- terminator characters terminating the current line). In addition, if -- the terminator sequence ends a physical line (the definition of what -- constitutes a physical line is embodied in the implementation of this -- function), and it is the first time this sequence is encountered, then -- an entry is made in the lines table to record the location for further -- use by functions such as Get_Line_Number. Physical is set to True if -- the line terminator was the end of a physical line. procedure Write_Location (P : Source_Ptr); -- Writes out a string of the form fff:nn:cc, where fff, nn, cc are the -- file name, line number and column corresponding to the given source -- location. No_Location and Standard_Location appear as the strings -- <no location> and <standard location>. procedure Write_Time_Stamp (S : Source_File_Index); -- Writes time stamp of specified file in YY-MM-DD HH:MM.SS format procedure Tree_Write; -- Writes out internal tables to current tree file using Tree_Write procedure Tree_Read; -- Initializes internal tables from current tree file using Tree_Read private pragma Inline (File_Name); pragma Inline (Full_File_Name); pragma Inline (Identifier_Casing); pragma Inline (Instantiation); pragma Inline (Keyword_Casing); pragma Inline (Last_Source_File); pragma Inline (Num_Source_Files); pragma Inline (Num_Source_Lines); pragma Inline (Reference_Name); pragma Inline (Set_Keyword_Casing); pragma Inline (Set_Identifier_Casing); pragma Inline (Set_Line_Offset); pragma Inline (Set_Reference_Name); pragma Inline (Source_First); pragma Inline (Source_Last); pragma Inline (Source_Text); pragma Inline (Template); pragma Inline (Time_Stamp); type Source_File_Record is record File_Name : File_Name_Type; -- Source file name (simple name with no directory info) Full_File_Name : File_Name_Type; -- Full file name (full name with directory info) Reference_Name : File_Name_Type; -- File name used for error messages (same as Full_File_Name unless -- reset by use of pragma Source_Reference). Line_Offset : Int; -- Offset value for line number references, to be added to physical -- line numbers to obtain logical line numbers. Normally set to zero -- but can be reset by use of pragma Source_Reference. Source_Text : Source_Buffer_Ptr; -- Text of source file. Note that every source file has a distinct set -- of non-overlapping bounds, so it is possible to determine which file -- is referenced from a given subscript (Source_Ptr) value. Source_First : Source_Ptr; -- Subscript of first character in Source_Text. Note that this cannot -- be obtained as Source_Text'First, because we use virtual origin -- addressing, so this value is always zero. Source_Last : Source_Ptr; -- Subscript of last character in Source_Text. Note that this cannot -- be obtained as Source_Text'Last, because we use virtual origin -- addressing, so this value is always Source_Ptr'Last. Time_Stamp : Time_Stamp_Type; -- Time stamp of the source file Num_Source_Lines : Nat; -- Number of entries in Lines_Table, i.e. the subscript of the last -- entry stored in this table. On completion of compilation of a unit -- (status = loaded), this is the number of source lines in the file. Keyword_Casing : Casing_Type; -- Casing style used in file for keyword casing. Initialized to -- Unknown, and then set from the first occurrence of a keyword. -- This value is used only for formatting of error messages. Identifier_Casing : Casing_Type; -- Casing style used in file for identifier casing. Initialized to -- Unknown, and then set from an identifier in the program as soon as -- one is found whose casing is sufficiently clear to make a decision. -- This value is used for formatting of error messages, and also is -- used in the detection of keywords misused as identifiers. Instantiation : Source_Ptr; -- Source file locatoin of the instantiation if this source file entry -- represents a generic instantiation. Set to No_Location for the case -- of a normal non-instantiation entry. See Sinput_L for details. Template : Source_File_Index; -- Source file index of the source file containing the template if -- this is a generic instantiation. Set to No_Source_File for the -- normal case of a non-instantiation entry. See Sinput_L for details. -- The following fields are for internal use only Sloc_Adjust : Source_Ptr; -- A value to be added to Sloc values for this file to reference the -- corresponding lines table. This is zero for the non-instantiation -- case, and set so that the adition references the ultimate template -- for the instantiation case. See Sinput_L for further details. Lines_Table : Lines_Table_Ptr; -- Pointer to lines table for this source. Updated as additional -- lines are accessed using the Skip_Line_Terminators procedure. -- Note: the lines table for an instantiation entry refers to the -- original line numbers of the template see Sinput_L for details. end record; package Source_File is new Table ( Table_Component_Type => Source_File_Record, Table_Index_Type => Source_File_Index, Table_Low_Bound => 1, Table_Initial => 50, Table_Increment => 100, Table_Name => "Source_File"); end Sinput;