gcc/ada/sem_aggr.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             S E M _ A G G R                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2024, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package contains the resolution code for aggregates. It is logically
  27 --  part of Sem_Res, but is split off since the aggregate code is so complex.
  28
  29 with Einfo.Entities; use Einfo.Entities;
  30 with Sinfo.Nodes;    use Sinfo.Nodes;
  31 with Types;          use Types;
  32
  33 package Sem_Aggr is
  34
  35    procedure Resolve_Delta_Aggregate     (N : Node_Id; Typ : Entity_Id);
  36    procedure Resolve_Aggregate           (N : Node_Id; Typ : Entity_Id);
  37    procedure Resolve_Extension_Aggregate (N : Node_Id; Typ : Entity_Id);
  38    procedure Resolve_Container_Aggregate (N : Node_Id; Typ : Entity_Id);
  39
  40    function Is_Others_Aggregate (Aggr : Node_Id) return Boolean;
  41    --  Returns True is aggregate Aggr consists of a single OTHERS choice
  42
  43    function Is_Single_Aggregate (Aggr : Node_Id) return Boolean;
  44    --  Returns True if aggregate Aggr consists of a single choice
  45
  46    --  WARNING: There is a matching C declaration of this subprogram in fe.h
  47
  48    function Is_Indexed_Aggregate
  49      (N           : N_Aggregate_Id;
  50       Add_Unnamed : Node_Id;
  51       New_Indexed : Node_Id) return Boolean;
  52    --  Returns True if N satisfies the criteria for being an indexed aggregate,
  53    --  that is, N is a container aggregate whose type has an Aggregate aspect
  54    --  that specifies a New_Indexed operation (it's Present), the aggregate
  55    --  is not a null aggregate, and either the type doesn't specify Add_Unnamed
  56    --  or there is a component association that is an N_Component_Association
  57    --  or is an N_Iterated_Component_Association with a Defining_Identifier.
  58    --  Returns False otherwise. The actuals for the Add_Unnamed and New_Indexed
  59    --  formals must be nodes that are names denoting the subprograms specified
  60    --  for those operations in the Aggregate aspect of the aggregate's type,
  61    --  or else Empty if the operation was not specified.
  62
  63    function Is_Null_Aggregate (N : Node_Id) return Boolean;
  64    --  Returns True for a "[]" aggregate (an Ada 2022 feature), even after
  65    --  it has been transformed by expansion. Returns False otherwise.
  66
  67    function Is_Null_Array_Aggregate_High_Bound (N : Node_Id) return Boolean;
  68    --  Returns True for the high bound of a null array aggregate.
  69
  70    function Is_Deep_Choice
  71      (Choice    : Node_Id;
  72       Aggr_Type : Type_Kind_Id) return Boolean;
  73    --  Returns whether Choice from a delta aggregate of type Aggr_Type is a
  74    --  deep choice.
  75
  76    function Is_Root_Prefix_Of_Deep_Choice (Pref : Node_Id) return Boolean;
  77    --  Returns whether prefix Pref of a deep choice is its root prefix. Except
  78    --  for its use in Is_Deep_Choice, this function should only be called on
  79    --  prefixes of a deep choice as identified by Is_Deep_Choice.
  80
  81 end Sem_Aggr;