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 / exp_tss.ads < prev    next >
Text File  |  1996-09-28  |  6KB  |  99 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                              E X P _ T S S                               --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.2 $                              --
  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. --  Type Support Subprogram (TSS) handling
  26.  
  27. with Types; use Types;
  28.  
  29. package Exp_TSS is
  30.  
  31.    --  A type support subprogram (TSS) is an internally generated function or
  32.    --  procedure that is associated with a particular type. Examples are the
  33.    --  implicit initialization procedure, and subprograms for the Input and
  34.    --  Output attributes.
  35.  
  36.    --  A given TSS is either generated once at the point of the declaration of
  37.    --  the type, or it is generated as needed in clients, but only one copy is
  38.    --  required in any one generated object file. The choice between these two
  39.    --  possibilities is made on a TSS-by-TSS basis depending on the estimation
  40.    --  of how likely the TSS is to be used. Initialization procedures fall in
  41.    --  the first category, for example, since it is likely that any declared
  42.    --  type will be used in a context requiring initialization, but the stream
  43.    --  attributes use the second approach, since it is more likely that they
  44.    --  will not be used at all, or will only be used in one client in any case.
  45.  
  46.    --  A TSS is identified by its Chars name, i.e. for a given TSS type, the
  47.    --  same name is used for all types, e.g. the initialization routine has
  48.    --  the name _init for all types.
  49.  
  50.    --  The TSS's for a given type are stored in an element list associated with
  51.    --  the type, and referenced from the TSS_Elist field of the N_Freeze_Entity
  52.    --  node associated with the type (all types that need TSS's always need to
  53.    --  be explicitly frozen, so the N_Freeze_Entity node always exists).
  54.  
  55.    function TSS (Typ : Entity_Id; Nam : Name_Id) return Entity_Id;
  56.    --  Finds the TSS with the given name associated with the given type. If
  57.    --  no such TSS exists, then Empty is returned.
  58.  
  59.    procedure Set_TSS (Typ : Entity_Id; TSS : Entity_Id);
  60.    --  This procedure is used to install a newly created TSS. The second
  61.    --  argument is the entity for a newly created TSS. The tree for this TSS
  62.    --  has not yet been inserted into the main tree or analyzed. Set_TSS finds
  63.    --  the appropriate place to install the subprogram tree, and then analyzes
  64.    --  it. The resulting analyzed entity is then placed in the TSS list for the
  65.    --  type whose entity is given as the first argument, replacing an old entry
  66.    --  of the same name if there was one present.
  67.  
  68.    procedure Copy_TSS (TSS : Entity_Id; Typ : Entity_Id);
  69.    --  Given an existing TSS for another type (which is already installed,
  70.    --  analyzed and expanded), install it as the corresponding TSS for Typ.
  71.    --  Note that this just copies a reference, not the tree.
  72.  
  73.    function Init_Proc (Typ : Entity_Id) return Entity_Id;
  74.    pragma Inline (Init_Proc);
  75.    --  Obtains the _init TSS entry for the given type. This function call is
  76.    --  equivalent to TSS (Typ, Name_uInit). The _init TSS is the procedure
  77.    --  used to initialize otherwise uninitialized instances of a type. If
  78.    --  there is no _init TSS, then the type requires no initialization. Note
  79.    --  that subtypes and implicit types never have an _init TSS since subtype
  80.    --  objects are always initialized using the initialization procedure for
  81.    --  the corresponding base type (see Base_Init_Proc function). A special
  82.    --  case arises for concurrent types. Such types do not themselves have an
  83.    --  _init TSR, but initialization is required. The initialization procedure
  84.    --  used is the one fot the corresponding record type (see Base_Init_Proc).
  85.  
  86.    function Base_Init_Proc (Typ : Entity_Id) return Entity_Id;
  87.    --  Obtains the _Init TSS entry from the base type of the entity, and also
  88.    --  deals with going indirect through the Corresponding_Record_Type field
  89.    --  for concurrent objects (which are initialized with the initialization
  90.    --  routine for the corresponding record type). Returns Empty if there is
  91.    --  no _Init TSS entry for the base type.
  92.  
  93.    procedure Set_Init_Proc (Typ : Entity_Id; Init : Entity_Id);
  94.    pragma Inline (Set_Init_Proc);
  95.    --  The second argument is the _init TSS to be established for the type
  96.    --  given as the first argument. Equivalent to Set_TSS (Typ, Init).
  97.  
  98. end Exp_TSS;
  99.