class/corlib/System.Reflection/FieldInfo.cs

   1 //
   2 // System.Reflection.FieldInfo.cs
   3 //
   4 // Author:
   5 //   Miguel de Icaza (miguel@ximian.com)
   6 //
   7 // (C) Ximian, Inc.  http://www.ximian.com
   8 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28
  29 using System.Diagnostics;
  30 using System.Reflection.Emit;
  31 using System.Globalization;
  32 using System.Runtime.CompilerServices;
  33 using System.Runtime.InteropServices;
  34
  35 namespace System.Reflection {
  36
  37         [ComVisible (true)]
  38         [ComDefaultInterfaceAttribute (typeof (_FieldInfo))]
  39         [Serializable]
  40         [ClassInterface(ClassInterfaceType.None)]
  41         public abstract class FieldInfo : MemberInfo, _FieldInfo {
  42
  43                 public abstract FieldAttributes Attributes {get;}
  44                 public abstract RuntimeFieldHandle FieldHandle {get;}
  45
  46                 protected FieldInfo () {}
  47
  48                 public abstract Type FieldType { get; }
  49
  50                 public abstract object GetValue(object obj);
  51
  52                 public override MemberTypes MemberType {
  53                         get { return MemberTypes.Field;}
  54                 }
  55
  56                 public bool IsLiteral
  57                 {
  58                         get {return (Attributes & FieldAttributes.Literal) != 0;}
  59                 }
  60
  61                 public bool IsStatic
  62                 {
  63                         get {return (Attributes & FieldAttributes.Static) != 0;}
  64                 }
  65
  66                 public bool IsInitOnly
  67                 {
  68                         get {return (Attributes & FieldAttributes.InitOnly) != 0;}
  69                 }
  70                 public Boolean IsPublic
  71                 {
  72                         get
  73                         {
  74                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.Public;
  75                         }
  76                 }
  77                 public Boolean IsPrivate
  78                 {
  79                         get
  80                         {
  81                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.Private;
  82                         }
  83                 }
  84                 public Boolean IsFamily
  85                 {
  86                         get
  87                         {
  88                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.Family;
  89                         }
  90                 }
  91                 public Boolean IsAssembly
  92                 {
  93                         get
  94                         {
  95                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.Assembly;
  96                         }
  97                 }
  98                 public Boolean IsFamilyAndAssembly
  99                 {
 100                         get {
 101                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.FamANDAssem;
 102                         }
 103                 }
 104                 public Boolean IsFamilyOrAssembly
 105                 {
 106                         get
 107                         {
 108                                 return (Attributes & FieldAttributes.FieldAccessMask) == FieldAttributes.FamORAssem;
 109                         }
 110                 }
 111                 public Boolean IsPinvokeImpl
 112                 {
 113                         get
 114                         {
 115                                 return (Attributes & FieldAttributes.PinvokeImpl) == FieldAttributes.PinvokeImpl;
 116                         }
 117                 }
 118                 public Boolean IsSpecialName
 119                 {
 120                         get
 121                         {
 122                                 return (Attributes & FieldAttributes.SpecialName) == FieldAttributes.SpecialName;
 123                         }
 124                 }
 125                 public Boolean IsNotSerialized
 126                 {
 127                         get
 128                         {
 129                                 return (Attributes & FieldAttributes.NotSerialized) == FieldAttributes.NotSerialized;
 130                         }
 131                 }
 132
 133                 public abstract void SetValue (object obj, object value, BindingFlags invokeAttr, Binder binder, CultureInfo culture);
 134
 135 #if ONLY_1_1
 136                 public new Type GetType ()
 137                 {
 138                         return base.GetType ();
 139                 }
 140 #endif
 141
 142                 [DebuggerHidden]
 143                 [DebuggerStepThrough]
 144                 public void SetValue (object obj, object value)
 145                 {
 146                         SetValue (obj, value, 0, null, null);
 147                 }
 148
 149                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 150                 private static extern FieldInfo internal_from_handle_type (IntPtr field_handle, IntPtr type_handle);
 151
 152                 public static FieldInfo GetFieldFromHandle (RuntimeFieldHandle handle)
 153                 {
 154                         if (handle.Value == IntPtr.Zero)
 155                                 throw new ArgumentException ("The handle is invalid.");
 156                         return internal_from_handle_type (handle.Value, IntPtr.Zero);
 157                 }
 158
 159                 [ComVisible (false)]
 160                 public static FieldInfo GetFieldFromHandle (RuntimeFieldHandle handle, RuntimeTypeHandle declaringType)
 161                 {
 162                         if (handle.Value == IntPtr.Zero)
 163                                 throw new ArgumentException ("The handle is invalid.");
 164                         FieldInfo fi = internal_from_handle_type (handle.Value, declaringType.Value);
 165                         if (fi == null)
 166                                 throw new ArgumentException ("The field handle and the type handle are incompatible.");
 167                         return fi;
 168                 }
 169
 170                 //
 171                 // Note: making this abstract imposes an implementation requirement
 172                 //       on any class that derives from it.  However, since it's also
 173                 //       internal, that means only classes inside corlib can derive
 174                 //       from FieldInfo.  See
 175                 //
 176                 //          errors/cs0534-4.cs errors/CS0534-4-lib.cs
 177                 //
 178                 //          class/Microsoft.JScript/Microsoft.JScript/JSFieldInfo.cs
 179                 //
 180                 internal virtual int GetFieldOffset ()
 181                 {
 182                         throw new SystemException ("This method should not be called");
 183                 }
 184
 185                 [CLSCompliant(false)]
 186                 [MonoTODO("Not implemented")]
 187                 public virtual object GetValueDirect (TypedReference obj)
 188                 {
 189                         throw new NotImplementedException ();
 190                 }
 191
 192                 [CLSCompliant(false)]
 193                 [MonoTODO("Not implemented")]
 194                 public virtual void SetValueDirect (TypedReference obj, object value)
 195                 {
 196                         throw new NotImplementedException ();
 197                 }
 198
 199                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 200                 private extern UnmanagedMarshal GetUnmanagedMarshal ();
 201
 202                 internal virtual UnmanagedMarshal UMarshal {
 203                         get {
 204                                 return GetUnmanagedMarshal ();
 205                         }
 206                 }
 207
 208                 internal object[] GetPseudoCustomAttributes ()
 209                 {
 210                         int count = 0;
 211
 212                         if (IsNotSerialized)
 213                                 count ++;
 214
 215                         if (DeclaringType.IsExplicitLayout)
 216                                 count ++;
 217
 218                         UnmanagedMarshal marshalAs = UMarshal;
 219                         if (marshalAs != null)
 220                                 count ++;
 221
 222                         if (count == 0)
 223                                 return null;
 224                         object[] attrs = new object [count];
 225                         count = 0;
 226
 227                         if (IsNotSerialized)
 228                                 attrs [count ++] = new NonSerializedAttribute ();
 229                         if (DeclaringType.IsExplicitLayout)
 230                                 attrs [count ++] = new FieldOffsetAttribute (GetFieldOffset ());
 231                         if (marshalAs != null)
 232                                 attrs [count ++] = marshalAs.ToMarshalAsAttribute ();
 233
 234                         return attrs;
 235                 }
 236
 237                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 238                 extern Type[] GetTypeModifiers (bool optional);
 239
 240                 public virtual Type[] GetOptionalCustomModifiers () {
 241                         Type[] types = GetTypeModifiers (true);
 242                         if (types == null)
 243                                 return Type.EmptyTypes;
 244                         return types;
 245                 }
 246
 247                 public virtual Type[] GetRequiredCustomModifiers () {
 248                         Type[] types = GetTypeModifiers (false);
 249                         if (types == null)
 250                                 return Type.EmptyTypes;
 251                         return types;
 252                 }
 253
 254                 public virtual object GetRawConstantValue ()
 255                 {
 256                         throw new NotSupportedException ("This non-CLS method is not implemented.");
 257                 }
 258
 259
 260 #if NET_4_0
 261                 public override bool Equals (object obj)
 262                 {
 263                         return obj == this;
 264                 }
 265
 266                 public override int GetHashCode ()
 267                 {
 268                         return base.GetHashCode ();
 269                 }
 270
 271                 public static bool operator == (FieldInfo left, FieldInfo right)
 272                 {
 273                         if ((object)left == (object)right)
 274                                 return true;
 275                         if ((object)left == null ^ (object)right == null)
 276                                 return false;
 277                         return left.Equals (right);
 278                 }
 279
 280                 public static bool operator != (FieldInfo left, FieldInfo right)
 281                 {
 282                         if ((object)left == (object)right)
 283                                 return false;
 284                         if ((object)left == null ^ (object)right == null)
 285                                 return true;
 286                         return !left.Equals (right);
 287                 }
 288 #endif
 289                 void _FieldInfo.GetIDsOfNames ([In] ref Guid riid, IntPtr rgszNames, uint cNames, uint lcid, IntPtr rgDispId)
 290                 {
 291                         throw new NotImplementedException ();
 292                 }
 293
 294                 void _FieldInfo.GetTypeInfo (uint iTInfo, uint lcid, IntPtr ppTInfo)
 295                 {
 296                         throw new NotImplementedException ();
 297                 }
 298
 299                 void _FieldInfo.GetTypeInfoCount (out uint pcTInfo)
 300                 {
 301                         throw new NotImplementedException ();
 302                 }
 303
 304                 void _FieldInfo.Invoke (uint dispIdMember, [In] ref Guid riid, uint lcid, short wFlags, IntPtr pDispParams, IntPtr pVarResult, IntPtr pExcepInfo, IntPtr puArgErr)
 305                 {
 306                         throw new NotImplementedException ();
 307                 }
 308         }
 309 }