gcc/ada/s-bitops.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                GNU ADA RUNTIME LIBRARY (GNARL) COMPONENTS                --
   4 --                                                                          --
   5 --                       S Y S T E M . B I T _ O P S                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision: 1.6 $
  10 --                                                                          --
  11 --          Copyright (C) 1992-1999, Free Software Foundation, Inc.         --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  Operations on packed bit strings
  37
  38 with System;
  39
  40 package System.Bit_Ops is
  41
  42    --  Note: in all the following routines, the System.Address parameters
  43    --  represent the address of the first byte of an array used to represent
  44    --  a packed array (of type System.Unsigned_Types.Packed_Bytes{1,2,4})
  45    --  The length in bits is passed as a separate parameter.
  46
  47    procedure Bit_And
  48      (Left   : System.Address;
  49       Llen   : Natural;
  50       Right  : Address;
  51       Rlen   : Natural;
  52       Result : System.Address);
  53    --  Bitwise "and" of given bit string with result being placed in Result.
  54    --  The or operation is allowed to destroy unused bits in the last byte,
  55    --  i.e. to leave them set in an undefined manner. Note that Left, Right
  56    --  and Result always have the same length in bits (Len).
  57
  58    function Bit_Eq
  59      (Left  : System.Address;
  60       Llen  : Natural;
  61       Right : System.Address;
  62       Rlen  : Natural)
  63       return  Boolean;
  64    --  Left and Right are the addresses of two bit packed arrays with Llen
  65    --  and Rlen being the respective length in bits. The routine compares the
  66    --  two bit strings for equality, being careful not to include the unused
  67    --  bits in the final byte. Note that the result is always False if Rlen
  68    --  is not equal to Llen.
  69
  70    procedure Bit_Not
  71      (Opnd   : System.Address;
  72       Len    : Natural;
  73       Result : System.Address);
  74    --  Bitwise "not" of given bit string with result being placed in Result.
  75    --  The not operation is allowed to destroy unused bits in the last byte,
  76    --  i.e. to leave them set in an undefined manner. Note that Result and
  77    --  Opnd always have the same length in bits (Len).
  78
  79    procedure Bit_Or
  80      (Left   : System.Address;
  81       Llen   : Natural;
  82       Right  : Address;
  83       Rlen   : Natural;
  84       Result : System.Address);
  85    --  Bitwise "or" of given bit string with result being placed in Result.
  86    --  The or operation is allowed to destroy unused bits in the last byte,
  87    --  i.e. to leave them set in an undefined manner. Note that Left, Right
  88    --  and Result always have the same length in bits (Len).
  89
  90    procedure Bit_Xor
  91      (Left   : System.Address;
  92       Llen   : Natural;
  93       Right  : Address;
  94       Rlen   : Natural;
  95       Result : System.Address);
  96    --  Bitwise "xor" of given bit string with result being placed in Result.
  97    --  The or operation is allowed to destroy unused bits in the last byte,
  98    --  i.e. to leave them set in an undefined manner. Note that Left, Right
  99    --  and Result always have the same length in bits (Len).
 100
 101 end System.Bit_Ops;