mcs/class/corlib/System/Nullable.cs

   1 //
   2 // System.Nullable.cs
   3 //
   4 // Martin Baulig (martin@ximian.com)
   5 // Marek Safar   (marek.safar@gmail.com)
   6 //
   7 // (C) 2004 Novell, Inc.
   8 //
   9
  10 //
  11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System.Reflection;
  34 using System.Collections.Generic;
  35 using System.Runtime.CompilerServices;
  36 using System.Runtime.InteropServices;
  37 using System.Diagnostics;
  38
  39 namespace System
  40 {
  41         [ComVisible (true)]
  42         public static class Nullable {
  43
  44 #if NET_2_1
  45                 [ComVisible (false)]
  46 #endif
  47                 public static int Compare<T> (T? n1, T? n2) where T: struct
  48                 {
  49                         if (n1.has_value) {
  50                                 if (!n2.has_value)
  51                                         return 1;
  52
  53                                 return Comparer<T>.Default.Compare (n1.value, n2.value);
  54                         }
  55
  56                         return n2.has_value ? -1 : 0;
  57                 }
  58
  59 #if NET_2_1
  60                 [ComVisible (false)]
  61 #endif
  62                 public static bool Equals<T> (T? n1, T? n2) where T: struct
  63                 {
  64                         if (n1.has_value != n2.has_value)
  65                                 return false;
  66
  67                         if (!n1.has_value)
  68                                 return true;
  69
  70                         return EqualityComparer<T>.Default.Equals (n1.value, n2.value);
  71                 }
  72
  73                 public static Type GetUnderlyingType (Type nullableType)
  74                 {
  75                         if (nullableType == null)
  76                                 throw new ArgumentNullException ("nullableType");
  77                         if (nullableType.IsGenericType && nullableType.GetGenericTypeDefinition () == typeof (Nullable<>))
  78                                 return nullableType.GetGenericArguments ()[0];
  79                         else
  80                                 return null;
  81                 }
  82         }
  83
  84         [Serializable]
  85         [DebuggerStepThrough]
  86         public struct Nullable<T> where T: struct
  87         {
  88                 #region Sync with runtime code
  89                 internal T value;
  90                 internal bool has_value;
  91                 #endregion
  92
  93                 public Nullable (T value)
  94                 {
  95                         this.has_value = true;
  96                         this.value = value;
  97                 }
  98
  99                 public bool HasValue {
 100                         get { return has_value; }
 101                 }
 102
 103                 public T Value {
 104                         get {
 105                                 if (!has_value)
 106                                         throw new InvalidOperationException ("Nullable object must have a value.");
 107
 108                                 return value;
 109                         }
 110                 }
 111
 112                 public override bool Equals (object other)
 113                 {
 114                         if (other == null)
 115                                 return has_value == false;
 116                         if (!(other is Nullable<T>))
 117                                 return false;
 118
 119                         return Equals ((Nullable <T>) other);
 120                 }
 121
 122                 bool Equals (Nullable<T> other)
 123                 {
 124                         if (other.has_value != has_value)
 125                                 return false;
 126
 127                         if (has_value == false)
 128                                 return true;
 129
 130                         return other.value.Equals (value);
 131                 }
 132
 133                 public override int GetHashCode ()
 134                 {
 135                         if (!has_value)
 136                                 return 0;
 137
 138                         return value.GetHashCode ();
 139                 }
 140
 141                 public T GetValueOrDefault ()
 142                 {
 143                         return value;
 144                 }
 145
 146                 public T GetValueOrDefault (T defaultValue)
 147                 {
 148                         return has_value ? value : defaultValue;
 149                 }
 150
 151                 public override string ToString ()
 152                 {
 153                         if (has_value)
 154                                 return value.ToString ();
 155                         else
 156                                 return String.Empty;
 157                 }
 158
 159                 public static implicit operator Nullable<T> (T value)
 160                 {
 161                         return new Nullable<T> (value);
 162                 }
 163
 164                 public static explicit operator T (Nullable<T> value)
 165                 {
 166                         return value.Value;
 167                 }
 168
 169                 //
 170                 // These are called by the JIT
 171                 //
 172 #pragma warning disable 169
 173                 //
 174                 // JIT implementation of box valuetype System.Nullable`1<T>
 175                 //
 176                 static object Box (T? o)
 177                 {
 178                         if (!o.has_value)
 179                                 return null;
 180
 181                         return o.value;
 182                 }
 183
 184                 static T? Unbox (object o)
 185                 {
 186                         if (o == null)
 187                                 return null;
 188                         return (T) o;
 189                 }
 190 #pragma warning restore 169
 191         }
 192 }