1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                           I N T E R F A C E S                            --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2002-2021, Free Software Foundation, Inc.         --
10--                                                                          --
11-- This specification is derived from the Ada Reference Manual for use with --
12-- GNAT. The copyright notice above, and the license provisions that follow --
13-- apply solely to the implementation dependent sections of this file.      --
14--                                                                          --
15-- GNAT is free software;  you can  redistribute it  and/or modify it under --
16-- terms of the  GNU General Public License as published  by the Free Soft- --
17-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
18-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
19-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
20-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
21--                                                                          --
22-- As a special exception under Section 7 of GPL version 3, you are granted --
23-- additional permissions described in the GCC Runtime Library Exception,   --
24-- version 3.1, as published by the Free Software Foundation.               --
25--                                                                          --
26-- You should have received a copy of the GNU General Public License and    --
27-- a copy of the GCC Runtime Library Exception along with this program;     --
28-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
29-- <http://www.gnu.org/licenses/>.                                          --
30--                                                                          --
31-- GNAT was originally developed  by the GNAT team at  New York University. --
32-- Extensive contributions were provided by Ada Core Technologies Inc.      --
33--                                                                          --
34------------------------------------------------------------------------------
35
36--  This is the runtime version of this unit (not used during GNAT build)
37
38package Interfaces is
39   pragma No_Elaboration_Code_All;
40   pragma Pure;
41
42   --  All identifiers in this unit are implementation defined
43
44   pragma Implementation_Defined;
45
46   type Integer_8  is range -2 **  7 .. 2 **  7 - 1;
47   for Integer_8'Size use  8;
48
49   type Integer_16 is range -2 ** 15 .. 2 ** 15 - 1;
50   for Integer_16'Size use 16;
51
52   type Integer_32 is range -2 ** 31 .. 2 ** 31 - 1;
53   for Integer_32'Size use 32;
54
55   type Integer_64 is new Long_Long_Integer;
56   for Integer_64'Size use 64;
57   --  Note: we use Long_Long_Integer'First instead of -2 ** 63 to allow this
58   --  unit to compile when using custom target configuration files where the
59   --  maximum integer is 32 bits. This is useful for static analysis tools
60   --  such as SPARK or CodePeer. In the normal case Long_Long_Integer is
61   --  always 64-bits so we get the desired 64-bit type.
62
63   type Integer_128 is new Long_Long_Long_Integer;
64   --  Note: we use Long_Long_Long_Integer instead of literal bounds to allow
65   --  this unit to be compiled with compilers not supporting 128-bit integers.
66   --  We do not put a confirming size clause of 128 bits for the same reason.
67
68   type Unsigned_8 is mod 2 ** 8;
69   for Unsigned_8'Size use  8;
70
71   type Unsigned_16 is mod 2 ** 16;
72   for Unsigned_16'Size use 16;
73
74   type Unsigned_24 is mod 2 ** 24;
75   for Unsigned_24'Size use 24;
76   --  Declare this type for compatibility with legacy Ada compilers.
77   --  This is particularly useful in the context of CodePeer analysis.
78
79   type Unsigned_32 is mod 2 ** 32;
80   for Unsigned_32'Size use 32;
81
82   type Unsigned_64 is mod 2 ** Long_Long_Integer'Size;
83   for Unsigned_64'Size use 64;
84   --  See comment on Integer_64 above
85
86   type Unsigned_128 is mod 2 ** Long_Long_Long_Integer'Size;
87   --  See comment on Integer_128 above
88
89   function Shift_Left
90     (Value  : Unsigned_8;
91      Amount : Natural) return Unsigned_8
92      with Import, Convention => Intrinsic, Static;
93
94   function Shift_Right
95     (Value  : Unsigned_8;
96      Amount : Natural) return Unsigned_8
97      with Import, Convention => Intrinsic, Static;
98
99   function Shift_Right_Arithmetic
100     (Value  : Unsigned_8;
101      Amount : Natural) return Unsigned_8
102      with Import, Convention => Intrinsic, Static;
103
104   function Rotate_Left
105     (Value  : Unsigned_8;
106      Amount : Natural) return Unsigned_8
107      with Import, Convention => Intrinsic, Static;
108
109   function Rotate_Right
110     (Value  : Unsigned_8;
111      Amount : Natural) return Unsigned_8
112      with Import, Convention => Intrinsic, Static;
113
114   function Shift_Left
115     (Value  : Unsigned_16;
116      Amount : Natural) return Unsigned_16
117      with Import, Convention => Intrinsic, Static;
118
119   function Shift_Right
120     (Value  : Unsigned_16;
121      Amount : Natural) return Unsigned_16
122      with Import, Convention => Intrinsic, Static;
123
124   function Shift_Right_Arithmetic
125     (Value  : Unsigned_16;
126      Amount : Natural) return Unsigned_16
127      with Import, Convention => Intrinsic, Static;
128
129   function Rotate_Left
130     (Value  : Unsigned_16;
131      Amount : Natural) return Unsigned_16
132      with Import, Convention => Intrinsic, Static;
133
134   function Rotate_Right
135     (Value  : Unsigned_16;
136      Amount : Natural) return Unsigned_16
137      with Import, Convention => Intrinsic, Static;
138
139   function Shift_Left
140     (Value  : Unsigned_32;
141      Amount : Natural) return Unsigned_32
142      with Import, Convention => Intrinsic, Static;
143
144   function Shift_Right
145     (Value  : Unsigned_32;
146      Amount : Natural) return Unsigned_32
147      with Import, Convention => Intrinsic, Static;
148
149   function Shift_Right_Arithmetic
150     (Value  : Unsigned_32;
151      Amount : Natural) return Unsigned_32
152      with Import, Convention => Intrinsic, Static;
153
154   function Rotate_Left
155     (Value  : Unsigned_32;
156      Amount : Natural) return Unsigned_32
157      with Import, Convention => Intrinsic, Static;
158
159   function Rotate_Right
160     (Value  : Unsigned_32;
161      Amount : Natural) return Unsigned_32
162      with Import, Convention => Intrinsic, Static;
163
164   function Shift_Left
165     (Value  : Unsigned_64;
166      Amount : Natural) return Unsigned_64
167      with Import, Convention => Intrinsic, Static;
168
169   function Shift_Right
170     (Value  : Unsigned_64;
171      Amount : Natural) return Unsigned_64
172      with Import, Convention => Intrinsic, Static;
173
174   function Shift_Right_Arithmetic
175     (Value  : Unsigned_64;
176      Amount : Natural) return Unsigned_64
177      with Import, Convention => Intrinsic, Static;
178
179   function Rotate_Left
180     (Value  : Unsigned_64;
181      Amount : Natural) return Unsigned_64
182      with Import, Convention => Intrinsic, Static;
183
184   function Rotate_Right
185     (Value  : Unsigned_64;
186      Amount : Natural) return Unsigned_64
187      with Import, Convention => Intrinsic, Static;
188
189   function Shift_Left
190     (Value  : Unsigned_128;
191      Amount : Natural) return Unsigned_128
192      with Import, Convention => Intrinsic, Static;
193
194   function Shift_Right
195     (Value  : Unsigned_128;
196      Amount : Natural) return Unsigned_128
197      with Import, Convention => Intrinsic, Static;
198
199   function Shift_Right_Arithmetic
200     (Value  : Unsigned_128;
201      Amount : Natural) return Unsigned_128
202      with Import, Convention => Intrinsic, Static;
203
204   function Rotate_Left
205     (Value  : Unsigned_128;
206      Amount : Natural) return Unsigned_128
207      with Import, Convention => Intrinsic, Static;
208
209   function Rotate_Right
210     (Value  : Unsigned_128;
211      Amount : Natural) return Unsigned_128
212      with Import, Convention => Intrinsic, Static;
213
214   --  IEEE Floating point types
215
216   type IEEE_Float_32 is digits 6;
217   for IEEE_Float_32'Size use 32;
218
219   type IEEE_Float_64 is digits 15;
220   for IEEE_Float_64'Size use 64;
221
222   --  If there is an IEEE extended float available on the machine, we assume
223   --  that it is available as Long_Long_Float.
224
225   --  Note: it is harmless, and explicitly permitted, to include additional
226   --  types in interfaces, so it is not wrong to have IEEE_Extended_Float
227   --  defined even if the extended format is not available.
228
229   type IEEE_Extended_Float is new Long_Long_Float;
230
231end Interfaces;
232