xref: /aosp_15_r20/external/coreboot/src/lib/gnat/s-imenne.ads (revision b9411a12aaaa7e1e6a6fb7c5e057f44ee179a49c)
1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT RUN-TIME COMPONENTS                         --
4--                                                                          --
5--                  S Y S T E M . I M G _ E N U M _ N E W                   --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2000-2013, 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.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- GNAT was originally developed  by the GNAT team at  New York University. --
28-- Extensive contributions were provided by Ada Core Technologies Inc.      --
29--                                                                          --
30------------------------------------------------------------------------------
31
32--  Enumeration_Type'Image for all enumeration types except those in package
33--  Standard (where we have no opportunity to build image tables), and in
34--  package System (where it is too early to start building image tables).
35--  Special routines exist for the enumeration types in these packages.
36
37--  This is the new version of the package, for use by compilers built after
38--  Nov 21st, 2007, which provides procedures that avoid using the secondary
39--  stack. The original package System.Img_Enum is maintained in the sources
40--  for bootstrapping with older versions of the compiler which expect to find
41--  functions in this package.
42
43package System.Img_Enum_New is
44   pragma Pure;
45
46   procedure Image_Enumeration_8
47     (Pos     : Natural;
48      S       : in out String;
49      P       : out Natural;
50      Names   : String;
51      Indexes : System.Address);
52   --  Used to compute Enum'Image (Str) where Enum is some enumeration type
53   --  other than those defined in package Standard. Names is a string with
54   --  a lower bound of 1 containing the characters of all the enumeration
55   --  literals concatenated together in sequence. Indexes is the address of
56   --  an array of type array (0 .. N) of Natural_8, where N is the number of
57   --  enumeration literals in the type. The Indexes values are the starting
58   --  subscript of each enumeration literal, indexed by Pos values, with an
59   --  extra entry at the end containing Names'Length + 1. The reason that
60   --  Indexes is passed by address is that the actual type is created on the
61   --  fly by the expander. The desired 'Image value is stored in S (1 .. P)
62   --  and P is set on return. The caller guarantees that S is long enough to
63   --  hold the result and that the lower bound is 1.
64
65   procedure Image_Enumeration_16
66     (Pos     : Natural;
67      S       : in out String;
68      P       : out Natural;
69      Names   : String;
70      Indexes : System.Address);
71   --  Identical to Set_Image_Enumeration_8 except that it handles types using
72   --  array (0 .. Num) of Natural_16 for the Indexes table.
73
74   procedure Image_Enumeration_32
75     (Pos     : Natural;
76      S       : in out String;
77      P       : out Natural;
78      Names   : String;
79      Indexes : System.Address);
80   --  Identical to Set_Image_Enumeration_8 except that it handles types using
81   --  array (0 .. Num) of Natural_32 for the Indexes table.
82
83end System.Img_Enum_New;
84