------------------------------------------------------------------------------
--                                                                          --
--                         GNAT RUN-TIME COMPONENTS                         --
--                                                                          --
--                  S Y S T E M . I M G _ E N U M _ N E W                   --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--          Copyright (C) 2000-2019, Free Software Foundation, Inc.         --
--                                                                          --
-- GNAT is free software;  you can  redistribute it  and/or modify it under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
--                                                                          --
--                                                                          --
--                                                                          --
--                                                                          --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
-- GNAT was originally developed  by the GNAT team at  New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc.      --
--                                                                          --
------------------------------------------------------------------------------

--  Enumeration_Type'Image for all enumeration types except those in package
--  Standard (where we have no opportunity to build image tables), and in
--  package System (where it is too early to start building image tables).
--  Special routines exist for the enumeration types in these packages.

--  This is the new version of the package, for use by compilers built after
--  Nov 21st, 2007, which provides procedures that avoid using the secondary
--  stack. The original package System.Img_Enum is maintained in the sources
--  for bootstrapping with older versions of the compiler which expect to find
--  functions in this package.

PRAGMA Compiler_Unit_Warning;

PACKAGE System.Img_Enum_New IS
   PRAGMA Pure;

   PROCEDURE Image_Enumeration_8
      (Pos     :        natural;
       S       : IN OUT string;
       P       :    OUT natural;
       Names   :        string;
       Indexes :        System.address);
   --  Used to compute Enum'Image (Str) where Enum is some enumeration type
   --  other than those defined in package Standard. Names is a string with
   --  a lower bound of 1 containing the characters of all the enumeration
   --  literals concatenated together in sequence. Indexes is the address of
   --  an array of type array (0 .. N) of Natural_8, where N is the number of
   --  enumeration literals in the type. The Indexes values are the starting
   --  subscript of each enumeration literal, indexed by Pos values, with an
   --  extra entry at the end containing Names'Length + 1. The reason that
   --  Indexes is passed by address is that the actual type is created on the
   --  fly by the expander. The desired 'Image value is stored in S (1 .. P)
   --  and P is set on return. The caller guarantees that S is long enough to
   --  hold the result and that the lower bound is 1.

   PROCEDURE Image_Enumeration_16
      (Pos     :        natural;
       S       : IN OUT string;
       P       :    OUT natural;
       Names   :        string;
       Indexes :        System.address);
   --  Identical to Set_Image_Enumeration_8 except that it handles types using
   --  array (0 .. Num) of Natural_16 for the Indexes table.

   PROCEDURE Image_Enumeration_32
      (Pos     :        natural;
       S       : IN OUT string;
       P       :    OUT natural;
       Names   :        string;
       Indexes :        System.address);
   --  Identical to Set_Image_Enumeration_8 except that it handles types using
   --  array (0 .. Num) of Natural_32 for the Indexes table.

END System.Img_Enum_New;
