1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                                B I N D O                                 --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--             Copyright (C) 2019-2021, 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--  The following unit contains the main entry point into the elaboration order
27--  mechanism. See the body for details.
28
29with ALI;   use ALI;
30with Namet; use Namet;
31
32package Bindo is
33
34   --  The following type represents the various phases of the elaboration
35   --  order mechanism.
36
37   type Elaboration_Phase is
38     (Component_Discovery,
39      Cycle_Diagnostics,
40      Cycle_Discovery,
41      Cycle_Validation,
42      Elaboration_Order_Validation,
43      Invocation_Graph_Construction,
44      Invocation_Graph_Validation,
45      Library_Graph_Augmentation,
46      Library_Graph_Construction,
47      Library_Graph_Elaboration,
48      Library_Graph_Validation,
49      Unit_Collection,
50      Unit_Elaboration);
51
52   --  The following type represents the various kinds of precedence between
53   --  two items.
54
55   type Precedence_Kind is
56     (Lower_Precedence,
57      Equal_Precedence,
58      Higher_Precedence);
59
60   procedure Find_Elaboration_Order
61     (Order         : out Unit_Id_Table;
62      Main_Lib_File : File_Name_Type);
63   --  Find an order of all units in the bind that need to be elaborated
64   --  such that elaboration code flow, pragmas Elaborate, Elaborate_All,
65   --  and Elaborate_Body, and with clause dependencies are all honoured.
66   --  Main_Lib_File is the argument of the bind. If a satisfactory order
67   --  exists, it is returned in Order, otherwise Unrecoverable_Error is
68   --  raised.
69
70end Bindo;
71