GCC v8.2
[gcc.git] / gcc / ada / libgnat / s-imenne.ads
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-2018, 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
43 pragma Compiler_Unit_Warning;
44
45 package System.Img_Enum_New is
46    pragma Pure;
47
48    procedure Image_Enumeration_8
49      (Pos     : Natural;
50       S       : in out String;
51       P       : out Natural;
52       Names   : String;
53       Indexes : System.Address);
54    --  Used to compute Enum'Image (Str) where Enum is some enumeration type
55    --  other than those defined in package Standard. Names is a string with
56    --  a lower bound of 1 containing the characters of all the enumeration
57    --  literals concatenated together in sequence. Indexes is the address of
58    --  an array of type array (0 .. N) of Natural_8, where N is the number of
59    --  enumeration literals in the type. The Indexes values are the starting
60    --  subscript of each enumeration literal, indexed by Pos values, with an
61    --  extra entry at the end containing Names'Length + 1. The reason that
62    --  Indexes is passed by address is that the actual type is created on the
63    --  fly by the expander. The desired 'Image value is stored in S (1 .. P)
64    --  and P is set on return. The caller guarantees that S is long enough to
65    --  hold the result and that the lower bound is 1.
66
67    procedure Image_Enumeration_16
68      (Pos     : Natural;
69       S       : in out String;
70       P       : out Natural;
71       Names   : String;
72       Indexes : System.Address);
73    --  Identical to Set_Image_Enumeration_8 except that it handles types using
74    --  array (0 .. Num) of Natural_16 for the Indexes table.
75
76    procedure Image_Enumeration_32
77      (Pos     : Natural;
78       S       : in out String;
79       P       : out Natural;
80       Names   : String;
81       Indexes : System.Address);
82    --  Identical to Set_Image_Enumeration_8 except that it handles types using
83    --  array (0 .. Num) of Natural_32 for the Indexes table.
84
85 end System.Img_Enum_New;