PR target/16201
[official-gcc.git] / gcc / ada / s-valenu.ads
blob15a5fbd90b7799c7a017325343e5095a41571f45
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S Y S T E M . V A L _ E N U M --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2000, 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, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, 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 ------------------------------------------------------------------------------
34 -- This package is used to compute the Value attribute for enumeration types
35 -- other than those in packages Standard and System. See unit Exp_Imgv for
36 -- details of the format of constructed image tables.
38 package System.Val_Enum is
39 pragma Pure (Val_Enum);
41 function Value_Enumeration_8
42 (Names : String;
43 Indexes : System.Address;
44 Num : Natural;
45 Str : String)
46 return Natural;
47 -- Used to compute Enum'Value (Str) where Enum is some enumeration type
48 -- other than those defined in package Standard. Names is a string with
49 -- a lower bound of 1 containing the characters of all the enumeration
50 -- literals concatenated together in sequence. Indexes is the address
51 -- of an array of type array (0 .. N) of Natural_8, where N is the
52 -- number of enumeration literals in the type. The Indexes values are
53 -- the starting subscript of each enumeration literal, indexed by Pos
54 -- values, with an extra entry at the end containing Names'Length + 1.
55 -- The parameter Num is the value N - 1 (i.e. Enum'Pos (Enum'Last)).
56 -- The reason that Indexes is passed by address is that the actual type
57 -- is created on the fly by the expander.
59 -- Str is the argument of the attribute function, and may have leading
60 -- and trailing spaces, and letters can be upper or lower case or mixed.
61 -- If the image is found in Names, then the corresponding Pos value is
62 -- returned. If not, Constraint_Error is raised.
64 function Value_Enumeration_16
65 (Names : String;
66 Indexes : System.Address;
67 Num : Natural;
68 Str : String)
69 return Natural;
70 -- Identical to Value_Enumeration_8 except that it handles types
71 -- using array (0 .. Num) of Natural_16 for the Indexes table.
73 function Value_Enumeration_32
74 (Names : String;
75 Indexes : System.Address;
76 Num : Natural;
77 Str : String)
78 return Natural;
79 -- Identical to Value_Enumeration_8 except that it handles types
80 -- using array (0 .. Num) of Natural_32 for the Indexes table.
82 end System.Val_Enum;