gcc/ada/s-imgenu.ads

   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-2007, 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 2,  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 COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  Enumeration_Type'Image for all enumeration types except those in package
  35 --  Standard (where we have no opportunity to build image tables), and in
  36 --  package System (where it is too early to start building image tables).
  37 --  Special routines exist for the enumeration types in these packages.
  38
  39 --  Note: this is an obsolete package, replaced by System.Img_Enum_New, which
  40 --  provides procedures instead of functions for these enumeration image calls.
  41 --  The reason we maintain this package is that when bootstrapping with old
  42 --  compilers, the old compiler will search for this unit, expectinng to find
  43 --  these functions. The new commpiler will search for procedures in the new
  44 --  version of the unit.
  45
  46 pragma Warnings (Off);
  47 pragma Compiler_Unit;
  48 pragma Warnings (On);
  49
  50 package System.Img_Enum is
  51    pragma Pure;
  52
  53    function Image_Enumeration_8
  54      (Pos     : Natural;
  55       Names   : String;
  56       Indexes : System.Address) return String;
  57    --  Used to compute Enum'Image (Str) where Enum is some enumeration type
  58    --  other than those defined in package Standard. Names is a string with a
  59    --  lower bound of 1 containing the characters of all the enumeration
  60    --  literals concatenated together in sequence. Indexes is the address of an
  61    --  array of type array (0 .. N) of Natural_8, where N is the number of
  62    --  enumeration literals in the type. The Indexes values are the starting
  63    --  subscript of each enumeration literal, indexed by Pos values, with an
  64    --  extra entry at the end containing Names'Length + 1. The reason that
  65    --  Indexes is passed by address is that the actual type is created on the
  66    --  fly by the expander. The value returned is the desired 'Image value.
  67
  68    function Image_Enumeration_16
  69      (Pos     : Natural;
  70       Names   : String;
  71       Indexes : System.Address) return String;
  72    --  Identical to Image_Enumeration_8 except that it handles types
  73    --  using array (0 .. Num) of Natural_16 for the Indexes table.
  74
  75    function Image_Enumeration_32
  76      (Pos     : Natural;
  77       Names   : String;
  78       Indexes : System.Address) return String;
  79    --  Identical to Image_Enumeration_8 except that it handles types
  80    --  using array (0 .. Num) of Natural_32 for the Indexes table.
  81
  82 end System.Img_Enum;