mcs/class/corlib/System/Buffer.cs

   1 //
   2 // System.Buffer.cs
   3 //
   4 // Authors:
   5 //   Paolo Molaro (lupus@ximian.com)
   6 //   Dan Lewis (dihlewis@yahoo.co.uk)
   7 //
   8 // (C) 2001 Ximian, Inc.  http://www.ximian.com
   9 //
  10
  11 //
  12 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 using System.Runtime.CompilerServices;
  35
  36 namespace System
  37 {
  38         public sealed class Buffer
  39         {
  40                 private Buffer ()
  41                 {
  42                 }
  43
  44                 public static int ByteLength (Array array)
  45                 {
  46                         // note: the other methods in this class also use ByteLength to test for
  47                         // null and non-primitive arguments as a side-effect.
  48
  49                         if (array == null)
  50                                 throw new ArgumentNullException ("array");
  51
  52                         int length = ByteLengthInternal (array);
  53                         if (length < 0)
  54                                 throw new ArgumentException (Locale.GetText ("Object must be an array of primitives."));
  55
  56                         return length;
  57                 }
  58
  59                 public static byte GetByte (Array array, int index)
  60                 {
  61                         if (index < 0 || index >= ByteLength (array))
  62                                 throw new ArgumentOutOfRangeException ("index", Locale.GetText(
  63                                         "Value must be non-negative and less than the size of the collection."));
  64
  65                         return GetByteInternal (array, index);
  66                 }
  67
  68                 public static void SetByte (Array array, int index, byte value)
  69                 {
  70                         if (index < 0 || index >= ByteLength (array))
  71                                 throw new ArgumentOutOfRangeException ("index", Locale.GetText(
  72                                         "Value must be non-negative and less than the size of the collection."));
  73
  74                         SetByteInternal (array, index, value);
  75                 }
  76
  77                 public static void BlockCopy (Array src, int srcOffset, Array dest, int destOffset, int count)
  78                 {
  79                         if (src == null)
  80                                 throw new ArgumentNullException ("src");
  81
  82                         if (dest == null)
  83                                 throw new ArgumentNullException ("dest");
  84
  85                         if (srcOffset < 0)
  86                                 throw new ArgumentOutOfRangeException ("srcOffset", Locale.GetText(
  87                                         "Non-negative number required."));
  88
  89                         if (destOffset < 0)
  90                                 throw new ArgumentOutOfRangeException ("destOffset", Locale.GetText (
  91                                         "Non-negative number required."));
  92
  93                         if (count < 0)
  94                                 throw new ArgumentOutOfRangeException ("count", Locale.GetText (
  95                                         "Non-negative number required."));
  96
  97                         // We do the checks in unmanaged code for performance reasons
  98                         bool res = BlockCopyInternal (src, srcOffset, dest, destOffset, count);
  99                         if (!res) {
 100                                 // watch for integer overflow
 101                                 if ((srcOffset > ByteLength (src) - count) || (destOffset > ByteLength (dest) - count))
 102                                         throw new ArgumentException (Locale.GetText (
 103                                                 "Offset and length were out of bounds for the array or count is greater than" +
 104                                                 "the number of elements from index to the end of the source collection."));
 105                         }
 106                 }
 107
 108                 // private
 109                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 110                 private extern static int ByteLengthInternal (Array array);
 111
 112                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 113                 private extern static byte GetByteInternal (Array array, int index);
 114
 115                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 116                 private extern static void SetByteInternal (Array array, int index, int value);
 117
 118                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 119                 internal extern static bool BlockCopyInternal (Array src, int src_offset, Array dest, int dest_offset, int count);
 120         }
 121 }