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 using System.Runtime.InteropServices;
  36 using System.Diagnostics.Contracts;
  37
  38 namespace System {
  39         [ComVisible (true)]
  40         public static class Buffer {
  41
  42                 public static int ByteLength (Array array)
  43                 {
  44                         // note: the other methods in this class also use ByteLength to test for
  45                         // null and non-primitive arguments as a side-effect.
  46
  47                         if (array == null)
  48                                 throw new ArgumentNullException ("array");
  49
  50                         int length = ByteLengthInternal (array);
  51                         if (length < 0)
  52                                 throw new ArgumentException (Locale.GetText ("Object must be an array of primitives."));
  53
  54                         return length;
  55                 }
  56
  57                 public static byte GetByte (Array array, int index)
  58                 {
  59                         if (index < 0 || index >= ByteLength (array))
  60                                 throw new ArgumentOutOfRangeException ("index", Locale.GetText(
  61                                         "Value must be non-negative and less than the size of the collection."));
  62
  63                         return GetByteInternal (array, index);
  64                 }
  65
  66                 public static void SetByte (Array array, int index, byte value)
  67                 {
  68                         if (index < 0 || index >= ByteLength (array))
  69                                 throw new ArgumentOutOfRangeException ("index", Locale.GetText(
  70                                         "Value must be non-negative and less than the size of the collection."));
  71
  72                         SetByteInternal (array, index, value);
  73                 }
  74
  75                 public static void BlockCopy (Array src, int srcOffset, Array dst, int dstOffset, int count)
  76                 {
  77                         if (src == null)
  78                                 throw new ArgumentNullException ("src");
  79
  80                         if (dst == null)
  81                                 throw new ArgumentNullException ("dst");
  82
  83                         if (srcOffset < 0)
  84                                 throw new ArgumentOutOfRangeException ("srcOffset", Locale.GetText(
  85                                         "Non-negative number required."));
  86
  87                         if (dstOffset < 0)
  88                                 throw new ArgumentOutOfRangeException ("dstOffset", Locale.GetText (
  89                                         "Non-negative number required."));
  90
  91                         if (count < 0)
  92                                 throw new ArgumentOutOfRangeException ("count", Locale.GetText (
  93                                         "Non-negative number required."));
  94
  95                         // We do the checks in unmanaged code for performance reasons
  96                         bool res = BlockCopyInternal (src, srcOffset, dst, dstOffset, count);
  97                         if (!res) {
  98                                 // watch for integer overflow
  99                                 if ((srcOffset > ByteLength (src) - count) || (dstOffset > ByteLength (dst) - count))
 100                                         throw new ArgumentException (Locale.GetText (
 101                                                 "Offset and length were out of bounds for the array or count is greater than " +
 102                                                 "the number of elements from index to the end of the source collection."));
 103                         }
 104                 }
 105
 106                 // private
 107                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 108                 private extern static int ByteLengthInternal (Array array);
 109
 110                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 111                 private extern static byte GetByteInternal (Array array, int index);
 112
 113                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 114                 private extern static void SetByteInternal (Array array, int index, int value);
 115
 116                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 117                 internal extern static bool BlockCopyInternal (Array src, int src_offset, Array dest, int dest_offset, int count);
 118
 119                 internal static bool InternalBlockCopy (Array src, int src_offset, Array dest, int dest_offset, int count)
 120                 {
 121                         return BlockCopyInternal (src, src_offset, dest, dest_offset, count);
 122                 }
 123
 124                 internal unsafe static void ZeroMemory (byte* src, long len)
 125                 {
 126                         while(len-- > 0)
 127                                 *(src + len) = 0;
 128                 }
 129
 130         internal unsafe static void Memcpy (byte* pDest, int destIndex, byte[] src, int srcIndex, int len)
 131         {
 132             Contract.Assert( (srcIndex >= 0) && (destIndex >= 0) && (len >= 0), "Index and length must be non-negative!");
 133             Contract.Assert(src.Length - srcIndex >= len, "not enough bytes in src");
 134             // If dest has 0 elements, the fixed statement will throw an
 135             // IndexOutOfRangeException.  Special-case 0-byte copies.
 136             if (len==0)
 137                 return;
 138             fixed(byte* pSrc = src) {
 139                 Memcpy(pDest + destIndex, pSrc + srcIndex, len);
 140             }
 141         }
 142
 143         internal unsafe static void Memcpy(byte[] dest, int destIndex, byte* src, int srcIndex, int len) {
 144             Contract.Assert( (srcIndex >= 0) && (destIndex >= 0) && (len >= 0), "Index and length must be non-negative!");
 145             Contract.Assert(dest.Length - destIndex >= len, "not enough bytes in dest");
 146             // If dest has 0 elements, the fixed statement will throw an
 147             // IndexOutOfRangeException.  Special-case 0-byte copies.
 148             if (len==0)
 149                 return;
 150             fixed(byte* pDest = dest) {
 151                 Memcpy(pDest + destIndex, src + srcIndex, len);
 152             }
 153         }
 154
 155                 internal unsafe static void Memcpy (byte* dest, byte* src, int len)
 156                 {
 157                         string.memcpy (dest, src, len);
 158                 }
 159         }
 160 }