gcc/ada/libgnat/s-pack20.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . P A C K _ 2 0                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2024, 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 --  Handling of packed arrays with Component_Size = 20
  33
  34 package System.Pack_20 is
  35    pragma Preelaborate;
  36
  37    --  20-bit element type definition
  38
  39    Bits : constant := 20;
  40
  41    type Bits_20 is mod 2 ** Bits;
  42    for Bits_20'Size use Bits;
  43
  44    --  In all subprograms below, Rev_SSO is set True if the array has the
  45    --  non-default scalar storage order.
  46
  47    function Get_20
  48      (Arr     : System.Address;
  49       N       : Natural;
  50       Rev_SSO : Boolean) return Bits_20 with Inline;
  51    --  Arr is the address of the packed array, N is the zero-based
  52    --  subscript. This element is extracted and returned.
  53
  54    procedure Set_20
  55      (Arr     : System.Address;
  56       N       : Natural;
  57       E       : Bits_20;
  58       Rev_SSO : Boolean) with Inline;
  59    --  Arr is the address of the packed array, N is the zero-based
  60    --  subscript. This element is set to the given value.
  61
  62    function GetU_20
  63      (Arr     : System.Address;
  64       N       : Natural;
  65       Rev_SSO : Boolean) return Bits_20 with Inline;
  66    --  Arr is the address of the packed array, N is the zero-based
  67    --  subscript. This element is extracted and returned. This version
  68    --  is used when Arr may represent an unaligned address.
  69
  70    procedure SetU_20
  71      (Arr     : System.Address;
  72       N       : Natural;
  73       E       : Bits_20;
  74       Rev_SSO : Boolean) with Inline;
  75    --  Arr is the address of the packed array, N is the zero-based
  76    --  subscript. This element is set to the given value. This version
  77    --  is used when Arr may represent an unaligned address
  78
  79 end System.Pack_20;