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_ch9.ads < prev    next >
Text File  |  1996-09-28  |  14KB  |  283 lines

  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                              E X P _ C H 9                               --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.45 $                             --
  10. --                                                                          --
  11. --           Copyright (c) 1992,1993,1994 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. --  Expand routines for chapter 9 constructs
  26.  
  27. with Types; use Types;
  28. package Exp_Ch9 is
  29.  
  30.    procedure Add_Discriminal_Declarations
  31.      (Decls : List_Id;
  32.       Typ   : Entity_Id;
  33.       Name  : Name_Id;
  34.       Loc   : Source_Ptr);
  35.    --  This routine is used to add discriminal declarations to task and
  36.    --  protected operation bodies. The discriminants are available by normal
  37.    --  selection from the concurrent object (whose name is passed as the third
  38.    --  parameter). Discriminant references inside the body have already
  39.    --  been replaced by references to the corresponding discriminals. The
  40.    --  declarations constructed by this procedure hook the references up with
  41.    --  the objects:
  42.    --
  43.    --    discriminal_name : discr_type renames name.discriminant_name;
  44.    --
  45.    --  Obviously we could have expanded the discriminant references in the
  46.    --  first place to be the appropriate selection, but this turns out to
  47.    --  be hard to do because it would introduce difference in handling of
  48.    --  discriminant references depending on their location.
  49.  
  50.    procedure Add_Private_Declarations
  51.      (Decls : List_Id;
  52.       Typ   : Entity_Id;
  53.       Name  : Name_Id;
  54.       Loc : Source_Ptr);
  55.    --  This routine is used to add private declarations to protected bodies.
  56.    --  These are analogous to the discriminal declarations added to tasks
  57.    --  and protected operations, and consist of a renaming of each private
  58.    --  object to a selection from the concurrent object passed as an extra
  59.    --  parameter to each such operation:
  60.    --    private_name : private_type renames name.private_name;
  61.    --  As with discriminals, private references inside the protected
  62.    --  subprogram bodies have already been replaced by references to the
  63.    --  corresponding privals.
  64.  
  65.    procedure Build_Activation_Chain_Entity (N : Node_Id);
  66.    --  Given a declaration N of an object that is a task, or contains tasks
  67.    --  (other than allocators to tasks) this routine ensures that an activation
  68.    --  chain has been declared in the appropriate scope, building the required
  69.    --  declaration for the chain variable if not. The name of this variable
  70.    --  is always _Chain and it is accessed by name. This procedure also adds
  71.    --  an appropriate call to Activate_Tasks to activate the tasks for this
  72.    --  activation chain. It does not however deal with the call needed in the
  73.    --  case of allocators to Expunge_Unactivated_Tasks, this is separately
  74.    --  handled in the Expand_Task_Allocator routine.
  75.  
  76.    function Build_Call_With_Task (N : Node_Id; E : Entity_Id) return Node_Id;
  77.    --  N is a node representing the name of a task or an access to a task.
  78.    --  The value returned is a call to the function whose name is the entity
  79.    --  E (typically a runtime routine entity obtained using RTE) with the
  80.    --  Task_Id of the associated task as the parameter. The caller is
  81.    --  responsible for analyzing and resolving the resulting tree.
  82.  
  83.    procedure Build_Master_Entity (E : Entity_Id);
  84.    --  Given an entity E for the declaration of an object containing tasks
  85.    --  or of a type declaration for an allocator whose designated type is a
  86.    --  task or contains tasks, this routine marks the appropriate enclosing
  87.    --  context as a master, and also declares a variable called _Master in
  88.    --  the current declarative part which captures the value of Current_Master
  89.    --  (if not already built by a prior call). We build this object (instead
  90.    --  of just calling Current_Master) for two reasons. First it is clearly
  91.    --  more efficient to call Current_Master only once for a bunch of tasks
  92.    --  in the same declarative part, and second it makes things easier in
  93.    --  generating the initialization routines, since they can just reference
  94.    --  the object _Master by name, and they will get the proper Current_Master
  95.    --  value at the outer level, and copy in the parameter value for the outer
  96.    --  initialization call if the call is for a nested component). Note that
  97.    --  in the case of nested packages, we only really need to make one such
  98.    --  object at the outer level, but it is much easier to generate one per
  99.    --  declarative part.
  100.  
  101.    function Build_Protected_Subprogram_Call
  102.      (N        : Node_Id;
  103.       Name     : Node_Id;
  104.       Rec      : Node_Id;
  105.       External : Boolean := True)
  106.       return Node_Id;
  107.    --  This function returns a subprogram call node to the expansion
  108.    --  of a protected subprogram, given a subprogram or entry call
  109.    --  to the protected subprogram itself. Name is the subprogram,
  110.    --  and Rec is the record corresponding to the protected object.
  111.    --  External is False if the call is to another protected subprogram
  112.    --  within the same object.
  113.  
  114.    procedure Build_Task_Activation_Call (N : Node_Id);
  115.    --  This procedure is called for constructs that can be task activators
  116.    --  i.e. task bodies, subprogram bodies, package bodies and blocks. If
  117.    --  the construct is a task activator (as indicated by the non-empty
  118.    --  setting of Activation_Chain_Entity, either in the construct, or, in
  119.    --  the case of a package body, in its associated package spec), then
  120.    --  a call to Activate_Tasks with this entity as the single parameter
  121.    --  is inserted at the start of the statements of the activator.
  122.  
  123.    procedure Build_Task_Allocate_Block
  124.      (Actions : List_Id;
  125.       N       : Node_Id;
  126.       Args    : List_Id);
  127.    --  This routine is used in the case of allocators where the designated
  128.    --  type is a task or contains tasks. In this case, the normal initialize
  129.    --  call is replaced by:
  130.  
  131.    --    blockname : label;
  132.    --    blockname : declare
  133.    --       _Chain  : Activation_Chain;
  134.  
  135.    --       procedure _Expunge is
  136.    --       begin
  137.    --         Expunge_Unactivated_Tasks (_Chain);
  138.    --       end;
  139.  
  140.    --    begin
  141.    --       Init (Args);
  142.    --       Activate_Tasks (_Chain);
  143.    --    at end
  144.    --       _Expunge;
  145.    --    end;
  146.  
  147.    --  to get the task or tasks created and initialized. The expunge call
  148.    --  ensures that any tasks that get created but not activated due to an
  149.    --  exception are properly expunged (it has no effect in the normal case)
  150.    --  The argument N is the allocator, and Args is the list of arguments
  151.    --  for the initialization call, constructed by the caller, which uses
  152.    --  the Master_Id of the access type as the _Master parameter, and _Chain
  153.    --  (defined above) as the _Chain parameter.
  154.  
  155.    function Convert_Concurrent
  156.      (N    : Node_Id;
  157.       Typ  : Entity_Id)
  158.       return Node_Id;
  159.    --  N is an expression of type Typ. If the type is not a concurrent
  160.    --  type then it is returned unchanged. If it is a task or protected
  161.    --  reference, Convert_Concurrent creates an unchecked conversion node
  162.    --  from this expression to the corresponding concurrent record type
  163.    --  value. We need this in any situation where the concurrent type is
  164.    --  used, because the actual concurrent object is an object of the
  165.    --  corresponding concurrent type, and manipulations on the concurrent
  166.    --  object actually manipulate the corresponding object of the record
  167.    --  type.
  168.  
  169.    function Entry_Index_Expression
  170.      (Sloc  : Source_Ptr;
  171.       Ent   : Entity_Id;
  172.       Index : Node_Id;
  173.       Ttyp  : Entity_Id)
  174.       return  Node_Id;
  175.    --  Returns an expression to compute a task entry index given the name
  176.    --  of the entry or entry family. For the case of a task entry family,
  177.    --  the Index parameter contains the expression for the subscript.
  178.    --  Ttyp is the task type.
  179.  
  180.    procedure Establish_Task_Master (N : Node_Id);
  181.    --  Given a subprogram body, or a block statement, or a task body, this
  182.    --  proccedure makes the necessary transformations required of a task
  183.    --  master (add Enter_Master call at start, and establish a cleanup
  184.    --  routine to make sure Complete_Master is called on exit).
  185.  
  186.    procedure Expand_Accept_Declarations (N : Node_Id; Ent : Entity_Id);
  187.    --  Expand declarations required for accept statement. See bodies of
  188.    --  both Expand_Accept_Declarations and Expand_N_Accept_Statement for
  189.    --  full details of the nature and use of these declarations, which
  190.    --  are inserted immediately before the accept node N. The second
  191.    --  argument is the entity for the corresponding entry.
  192.  
  193.    procedure Expand_Entry_Barrier (N : Node_Id);
  194.    --  Expand the entry barrier into a function.  This is called
  195.    --  directly from Analyze_Entry_Body so that the discriminals
  196.    --  and privals of the barrier can be attached to the function
  197.    --  declaration list, and a new set prepared for the entry body
  198.    --  procedure, before the entry body statement sequence can be
  199.    --  expanded.
  200.  
  201.    procedure Expand_Entry_Body_Declarations (N : Node_Id);
  202.    --  Expand declarations required for the expansion of the
  203.    --  statements of the body.
  204.  
  205.    procedure Expand_N_Abort_Statement            (N : Node_Id);
  206.    procedure Expand_N_Accept_Statement           (N : Node_Id);
  207.    procedure Expand_N_Asynchronous_Select        (N : Node_Id);
  208.    procedure Expand_N_Conditional_Entry_Call     (N : Node_Id);
  209.    procedure Expand_N_Delay_Relative_Statement   (N : Node_Id);
  210.    procedure Expand_N_Delay_Until_Statement      (N : Node_Id);
  211.    procedure Expand_N_Entry_Body                 (N : Node_Id);
  212.    procedure Expand_N_Entry_Call_Statement       (N : Node_Id);
  213.    procedure Expand_N_Entry_Declaration          (N : Node_Id);
  214.    procedure Expand_N_Protected_Body             (N : Node_Id);
  215.  
  216.    procedure Expand_N_Protected_Type_Declaration (N : Node_Id);
  217.    --  Expands protected type declarations. This results, among
  218.    --  other things, in the declaration of a record type for the
  219.    --  representation of protected objects and (if there are entries)
  220.    --  in an entry service procedure. The Protection value used by
  221.    --  the GNARL to control the object will always be the first
  222.    --  field of the record, and the entry service procedure spec
  223.    --  (if it exists) will always immediately follow the record
  224.    --  declaration. This allows these two nodes to be found from
  225.    --  the type using Corresponding_Record, without benefit of
  226.    --  of further attributes.
  227.  
  228.    procedure Expand_N_Requeue_Statement          (N : Node_Id);
  229.    procedure Expand_N_Selective_Accept           (N : Node_Id);
  230.    procedure Expand_N_Single_Task_Declaration    (N : Node_Id);
  231.    procedure Expand_N_Task_Body                  (N : Node_Id);
  232.    procedure Expand_N_Task_Type_Declaration      (N : Node_Id);
  233.    procedure Expand_N_Timed_Entry_Call           (N : Node_Id);
  234.  
  235.    procedure Expand_Protected_Body_Declarations
  236.      (N       : Node_Id;
  237.       Spec_Id : Entity_Id);
  238.    --  Expand declarations required for a protected body. See bodies of
  239.    --  both Expand_Protected_Body_Declarations and Expand_N_Protected_Body
  240.    --  for full details of the nature and use of these declarations.
  241.    --  The second argument is the entity for the corresponding
  242.    --  protected type declaration.
  243.  
  244.    function First_Protected_Operation (D : List_Id) return Node_Id;
  245.    --  Given the declarations list for a protected body, find the
  246.    --  first protected operation body.
  247.  
  248.    function Make_Task_Create_Call (Task_Rec : Entity_Id) return Node_Id;
  249.    --  Given the entity of the record type created for a task type, build
  250.    --  the call to Create_Task
  251.  
  252.    function Make_Initialize_Protection_Call
  253.      (Protect_Rec : Entity_Id)
  254.       return        Node_Id;
  255.    --  Given the entity of the record type created for a protected type, build
  256.    --  the call to Initialize_Protection
  257.  
  258.    function Next_Protected_Operation (N : Node_Id) return Node_Id;
  259.    --  Given a protected operation node (a subprogram or entry body),
  260.    --  find the following node in the declarations list.
  261.  
  262.    procedure Set_Discriminals
  263.      (Dec : Node_Id;
  264.       Op  : Node_Id;
  265.       Loc : Source_Ptr);
  266.    --  Replace discriminals in a protected type for use by the
  267.    --  next protected operation on the type. Each operation needs a
  268.    --  new set of discirminals, since it needs a unique renaming of
  269.    --  the discriminant fields in the record used to implement the
  270.    --  protected type.
  271.  
  272.    procedure Set_Privals
  273.       (Dec : Node_Id;
  274.        Op  : Node_Id;
  275.        Loc : Source_Ptr);
  276.    --  Associates a new set of privals (placeholders for later access to
  277.    --  private components of protected objects) with the private object
  278.    --  declarations of a protected object. These will be used to expand
  279.    --  the references to private objects in the next protected
  280.    --  subprogram or entry body to be expanded.
  281.  
  282. end Exp_Ch9;
  283.