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 / stringt.ads < prev    next >
Text File  |  1996-09-28  |  7KB  |  132 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                              S T R I N G T                               --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.26 $                             --
  10. --                                                                          --
  11. --        Copyright (c) 1992,1993,1994,1995 NYU, All Rights Reserved        --
  12. --                                                                          --
  13. -- The GNAT library is free software; you can redistribute it and/or modify --
  14. -- it under terms of the GNU Library General Public License as published by --
  15. -- the Free Software  Foundation; either version 2, or (at your option) any --
  16. -- later version.  The GNAT library is distributed in the hope that it will --
  17. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  18. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  19. -- Library  General  Public  License for  more  details.  You  should  have --
  20. -- received  a copy of the GNU  Library  General Public License  along with --
  21. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  22. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  23. --                                                                          --
  24. ------------------------------------------------------------------------------
  25.  
  26. with System; use System;
  27. with Types;  use Types;
  28. with Table;
  29.  
  30. package Stringt is
  31.  
  32. --  This package contains routines for handling the strings table which is
  33. --  used to store string constants encountered in the source, and also those
  34. --  additional string constants generated by compile time concatenation and
  35. --  other similar processing.
  36.  
  37. --  A string constant in this table consists of a series of Char_Code values,
  38. --  so that 16-bit character codes can be properly handled if this feature
  39. --  is implemented in the scanner.
  40.  
  41. --  There is no guarantee that hashing is used in the implementation, although
  42. --  it maybe. This means that the caller cannot count on having the same Id
  43. --  value for two identical strings stored separately and also cannot count on
  44. --  the two Id values being different.
  45.  
  46.    --------------------------------------
  47.    -- String Table Access Subprograms --
  48.    --------------------------------------
  49.  
  50.    procedure Initialize;
  51.    --  Initializes the strings table for a new compilation. Note that
  52.    --  Initialize must not be called if Tree_Read is used.
  53.  
  54.    procedure Start_String;
  55.    --  Sets up for storing a new string in the table. To store a string, a
  56.    --  call is first made to Start_String, then successive calls are
  57.    --  made to Store_String_Character to store the characters of the string.
  58.    --  Finally, a call to End_String terminates the entry and returns it Id.
  59.  
  60.    procedure Start_String (S : String_Id);
  61.    --  Like Start_String with no parameter, except that the contents of the
  62.    --  new string is initialized to be a copy of the given string. A test is
  63.    --  made to see if S is the last created string, and if so it is shared,
  64.    --  rather than copied, this can be particularly helpful for the case of
  65.    --  a continued concatenaion of string constants.
  66.  
  67.    procedure Store_String_Char (C : Char_Code);
  68.    --  Store next character of string, see description above for Start_String
  69.  
  70.    procedure Store_String_Chars (S : String);
  71.    --  Store character codes of given string in sequence
  72.  
  73.    procedure Unstore_String_Char;
  74.    --  Undoes effect of previous Store_String_Char call, used in some error
  75.    --  situations of unterminated string constants.
  76.  
  77.    function End_String return String_Id;
  78.    --  Terminates current string and returns its Id
  79.  
  80.    function String_Length (Id : String_Id) return Nat;
  81.    --  Returns length of previously stored string
  82.  
  83.    function Get_String_Char (Id : String_Id; Index : Int) return Char_Code;
  84.    --  Obtains the specified character from a stored string. The lower bound
  85.    --  of stored strings is always 1, so the range is 1 .. String_Length (Id).
  86.  
  87.    function String_Equal (L, R : String_Id) return Boolean;
  88.    --  Determines if two string literals represent the same string
  89.  
  90.    function String_Chars_Address return System.Address;
  91.    --  Return address of String_Chars table (used by Back_End call to Gigi)
  92.  
  93.    function Strings_Address return System.Address;
  94.    --  Return address of Strings table (used by Back_End call to Gigi)
  95.  
  96.    procedure Tree_Read;
  97.    --  Initializes internal tables from current tree file using Tree_Read.
  98.    --  Note that Initialize should not be called if Tree_Read is used.
  99.    --  Tree_Read includes all necessary initialization.
  100.  
  101.    procedure Tree_Write;
  102.    --  Writes out internal tables to current tree file using Tree_Write
  103.  
  104.    procedure Write_Char_Code (Code : Char_Code);
  105.    --  Procedure to write a character code value, used for debugging purposes
  106.    --  for writing character codes. If the character code is in the range
  107.    --  16#20# .. 16#7A# or 16#7C# .. 16#7F# then the single graphic character
  108.    --  corresponding to the code is output. For any other codes in the range
  109.    --  16#00# .. 16#FF#, the code is output as {hh} where hh is the two
  110.    --  digit hex value for the code. Codes greater than 16#FF# are output as
  111.    --  {hhhh} where hhhh is the four digit hex representation of the code
  112.    --  value (high order byte first). Note: the reason that we output the
  113.    --  code 7B (left brace) in hex is to avoid escape sequence confusion.
  114.    --  Hex letters are always in upper case.
  115.  
  116.    procedure Write_String_Table_Entry (Id : String_Id);
  117.    --  Writes a string value with enclosing quotes to the current file using
  118.    --  routines in package Output. Does not write an end of line character.
  119.    --  This procedure is used for debug output purposes, and also for output
  120.    --  of strings specified by pragma Linker Option to the ali file. 7-bit
  121.    --  ASCII graphics (except for double quote and left brace) are output
  122.    --  literally. The double quote appears as two successive double quotes.
  123.    --  All other codes, are output as described for Write_Char_Code. For
  124.    --  example, the string created by folding "A" & Ascii.LF & "Hello" will
  125.    --  print as "A{0A}Hello".
  126.  
  127. private
  128.    pragma Inline (End_String);
  129.    pragma Inline (String_Length);
  130.  
  131. end Stringt;
  132.