1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT RUN-TIME COMPONENTS                         --
4--                                                                          --
5--                      S Y S T E M . I M G _ E N U M                       --
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--  Note: this is an obsolete package, replaced by System.Img_Enum_New, which
38--  provides procedures instead of functions for these enumeration image calls.
39--  The reason we maintain this package is that when bootstrapping with old
40--  compilers, the old compiler will search for this unit, expecting to find
41--  these functions. The new compiler will search for procedures in the new
42--  version of the unit.
43
44pragma Compiler_Unit_Warning;
45
46package System.Img_Enum is
47   pragma Pure;
48
49   function Image_Enumeration_8
50     (Pos     : Natural;
51      Names   : String;
52      Indexes : System.Address) return String;
53   --  Used to compute Enum'Image (Str) where Enum is some enumeration type
54   --  other than those defined in package Standard. Names is a string with a
55   --  lower bound of 1 containing the characters of all the enumeration
56   --  literals concatenated together in sequence. Indexes is the address of an
57   --  array of type array (0 .. N) of Natural_8, where N is the number of
58   --  enumeration literals in the type. The Indexes values are the starting
59   --  subscript of each enumeration literal, indexed by Pos values, with an
60   --  extra entry at the end containing Names'Length + 1. The reason that
61   --  Indexes is passed by address is that the actual type is created on the
62   --  fly by the expander. The value returned is the desired 'Image value.
63
64   function Image_Enumeration_16
65     (Pos     : Natural;
66      Names   : String;
67      Indexes : System.Address) return String;
68   --  Identical to Image_Enumeration_8 except that it handles types
69   --  using array (0 .. Num) of Natural_16 for the Indexes table.
70
71   function Image_Enumeration_32
72     (Pos     : Natural;
73      Names   : String;
74      Indexes : System.Address) return String;
75   --  Identical to Image_Enumeration_8 except that it handles types
76   --  using array (0 .. Num) of Natural_32 for the Indexes table.
77
78end System.Img_Enum;
79