class/corlib/System.Reflection.Emit/CustomAttributeBuilder.cs

   1
   2 //
   3 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining
   6 // a copy of this software and associated documentation files (the
   7 // "Software"), to deal in the Software without restriction, including
   8 // without limitation the rights to use, copy, modify, merge, publish,
   9 // distribute, sublicense, and/or sell copies of the Software, and to
  10 // permit persons to whom the Software is furnished to do so, subject to
  11 // the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be
  14 // included in all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 //
  24
  25 //
  26 // System.Reflection.Emit/CustomAttributeBuilder.cs
  27 //
  28 // Author:
  29 //   Paolo Molaro (lupus@ximian.com)
  30 //
  31 // (C) 2001 Ximian, Inc.  http://www.ximian.com
  32 //
  33
  34 using System;
  35 using System.Reflection;
  36 using System.Reflection.Emit;
  37 using System.Runtime.CompilerServices;
  38 using System.Runtime.InteropServices;
  39
  40 namespace System.Reflection.Emit {
  41         [ComVisible (true)]
  42         [ComDefaultInterface (typeof (_CustomAttributeBuilder))]
  43         [ClassInterface (ClassInterfaceType.None)]
  44         public class CustomAttributeBuilder : _CustomAttributeBuilder {
  45                 ConstructorInfo ctor;
  46                 byte[] data;
  47
  48                 internal ConstructorInfo Ctor {
  49                         get {return ctor;}
  50                 }
  51
  52                 internal byte[] Data {
  53                         get {return data;}
  54                 }
  55
  56                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  57                 static extern byte[] GetBlob(Assembly asmb, ConstructorInfo con, object[] constructorArgs, PropertyInfo[] namedProperties, object[] propertyValues, FieldInfo[] namedFields, object[] fieldValues);
  58
  59                 internal CustomAttributeBuilder( ConstructorInfo con, byte[] cdata) {
  60                         ctor = con;
  61                         data = (byte[])cdata.Clone ();
  62                         /* should we check that the user supplied data is correct? */
  63                 }
  64
  65                 public CustomAttributeBuilder( ConstructorInfo con, object[] constructorArgs)
  66                 {
  67                         Initialize (con, constructorArgs, new PropertyInfo [0], new object [0],
  68                                         new FieldInfo [0], new object [0]);
  69                 }
  70                 public CustomAttributeBuilder( ConstructorInfo con, object[] constructorArgs,
  71                                 FieldInfo[] namedFields, object[] fieldValues)
  72                 {
  73                         Initialize (con, constructorArgs, new PropertyInfo [0], new object [0],
  74                                         namedFields, fieldValues);
  75                 }
  76                 public CustomAttributeBuilder( ConstructorInfo con, object[] constructorArgs,
  77                                 PropertyInfo[] namedProperties, object[] propertyValues)
  78                 {
  79                         Initialize (con, constructorArgs, namedProperties, propertyValues, new FieldInfo [0],
  80                                         new object [0]);
  81                 }
  82                 public CustomAttributeBuilder( ConstructorInfo con, object[] constructorArgs,
  83                                 PropertyInfo[] namedProperties, object[] propertyValues,
  84                                 FieldInfo[] namedFields, object[] fieldValues)
  85                 {
  86                         Initialize (con, constructorArgs, namedProperties, propertyValues, namedFields, fieldValues);
  87                 }
  88
  89                 private bool IsValidType (Type t)
  90                 {
  91                         /* FIXME: Add more checks */
  92                         if (t.IsArray && t.GetArrayRank () > 1)
  93                                 return false;
  94                         if (t is TypeBuilder && t.IsEnum) {
  95                                 // Check that the enum is properly constructed, the unmanaged code
  96                                 // depends on this
  97                                 Enum.GetUnderlyingType (t);
  98                         }
  99                         if (t.IsClass && !(t.IsArray || t == typeof (object) || t == typeof (Type) || t == typeof (string) || t.Assembly.GetName ().Name == "mscorlib"))
 100                                 return false;
 101                         if (t.IsValueType && !(t.IsPrimitive || t.IsEnum || ((t.Assembly is AssemblyBuilder) && t.Assembly.GetName ().Name == "mscorlib")))
 102                                 return false;
 103                         return true;
 104                 }
 105
 106                 private bool IsValidParam (object o, Type paramType)
 107                 {
 108                         Type t = o.GetType ();
 109                         if (!IsValidType (t))
 110                                 return false;
 111                         if (paramType == typeof (object)) {
 112                                 if (t.IsArray && t.GetArrayRank () == 1)
 113                                         return IsValidType (t.GetElementType ());
 114                                 if (!t.IsPrimitive && !typeof (Type).IsAssignableFrom (t) && t != typeof (string) && !t.IsEnum)
 115                                         return false;
 116                         }
 117                         return true;
 118                 }
 119
 120                 private void Initialize (ConstructorInfo con, object [] constructorArgs,
 121                                 PropertyInfo [] namedProperties, object [] propertyValues,
 122                                 FieldInfo [] namedFields, object [] fieldValues)
 123                 {
 124                         ctor = con;
 125                         if (con == null)
 126                                 throw new ArgumentNullException ("con");
 127                         if (constructorArgs == null)
 128                                 throw new ArgumentNullException ("constructorArgs");
 129                         if (namedProperties == null)
 130                                 throw new ArgumentNullException ("namedProperties");
 131                         if (propertyValues == null)
 132                                 throw new ArgumentNullException ("propertyValues");
 133                         if (namedFields == null)
 134                                 throw new ArgumentNullException ("namedFields");
 135                         if (fieldValues == null)
 136                                 throw new ArgumentNullException ("fieldValues");
 137                         if (con.GetParameterCount () != constructorArgs.Length)
 138                                 throw new ArgumentException ("Parameter count does not match " +
 139                                                 "passed in argument value count.");
 140                         if (namedProperties.Length != propertyValues.Length)
 141                                 throw new ArgumentException ("Array lengths must be the same.",
 142                                                 "namedProperties, propertyValues");
 143                         if (namedFields.Length != fieldValues.Length)
 144                                 throw new ArgumentException ("Array lengths must be the same.",
 145                                                 "namedFields, fieldValues");
 146                         if ((con.Attributes & MethodAttributes.Static) == MethodAttributes.Static ||
 147                                         (con.Attributes & MethodAttributes.MemberAccessMask) == MethodAttributes.Private)
 148                                 throw new ArgumentException ("Cannot have private or static constructor.");
 149
 150                         Type atype = ctor.DeclaringType;
 151                         int i;
 152                         i = 0;
 153                         foreach (FieldInfo fi in namedFields) {
 154                                 Type t = fi.DeclaringType;
 155                                 if ((atype != t) && (!t.IsSubclassOf (atype)) && (!atype.IsSubclassOf (t)))
 156                                         throw new ArgumentException ("Field '" + fi.Name + "' does not belong to the same class as the constructor");
 157                                 if (!IsValidType (fi.FieldType))
 158                                         throw new ArgumentException ("Field '" + fi.Name + "' does not have a valid type.");
 159                                 // FIXME: Check enums and TypeBuilders as well
 160                                 if (fieldValues [i] != null)
 161                                         // IsEnum does not seem to work on TypeBuilders
 162                                         if (!(fi.FieldType is TypeBuilder) && !fi.FieldType.IsEnum && !fi.FieldType.IsInstanceOfType (fieldValues [i])) {
 163                                                 //
 164                                                 // mcs allways uses object[] for array types and
 165                                                 // MS.NET allows this
 166                                                 //
 167                                                 if (!fi.FieldType.IsArray)
 168                                                         throw new ArgumentException ("Value of field '" + fi.Name + "' does not match field type: " + fi.FieldType);
 169                                                 }
 170                                 i ++;
 171                         }
 172
 173                         i = 0;
 174                         foreach (PropertyInfo pi in namedProperties) {
 175                                 if (!pi.CanWrite)
 176                                         throw new ArgumentException ("Property '" + pi.Name + "' does not have a setter.");
 177                                 Type t = pi.DeclaringType;
 178                                 if ((atype != t) && (!t.IsSubclassOf (atype)) && (!atype.IsSubclassOf (t)))
 179                                         throw new ArgumentException ("Property '" + pi.Name + "' does not belong to the same class as the constructor");
 180                                 if (!IsValidType (pi.PropertyType))
 181                                         throw new ArgumentException ("Property '" + pi.Name + "' does not have a valid type.");
 182                                 if (propertyValues [i] != null) {
 183                                         if (!(pi.PropertyType is TypeBuilder) && !pi.PropertyType.IsEnum && !pi.PropertyType.IsInstanceOfType (propertyValues [i]))
 184                                                 if (!pi.PropertyType.IsArray)
 185                                                         throw new ArgumentException ("Value of property '" + pi.Name + "' does not match property type: " + pi.PropertyType + " -> " + propertyValues [i]);
 186                                 }
 187                                 i ++;
 188                         }
 189
 190                         i = 0;
 191                         foreach (ParameterInfo pi in GetParameters (con)) {
 192                                 if (pi != null) {
 193                                         Type paramType = pi.ParameterType;
 194                                         if (!IsValidType (paramType))
 195                                                 throw new ArgumentException ("Parameter " + i + " does not have a valid type.");
 196                                         if (constructorArgs [i] != null) {
 197                                                 if (!(paramType is TypeBuilder) && !paramType.IsEnum && !paramType.IsInstanceOfType (constructorArgs [i]))
 198                                                         if (!paramType.IsArray)
 199                                                                 throw new ArgumentException ("Value of argument " + i + " does not match parameter type: " + paramType + " -> " + constructorArgs [i]);
 200                                                 if (!IsValidParam (constructorArgs [i], paramType))
 201                                                         throw new ArgumentException ("Cannot emit a CustomAttribute with argument of type " + constructorArgs [i].GetType () + ".");
 202                                         }
 203                                 }
 204                                 i ++;
 205                         }
 206
 207                         data = GetBlob (atype.Assembly, con, constructorArgs, namedProperties, propertyValues, namedFields, fieldValues);
 208                 }
 209
 210                 /* helper methods */
 211                 internal static int decode_len (byte[] data, int pos, out int rpos) {
 212                         int len = 0;
 213                         if ((data [pos] & 0x80) == 0) {
 214                                 len = (int)(data [pos++] & 0x7f);
 215                         } else if ((data [pos] & 0x40) == 0) {
 216                                 len = ((data [pos] & 0x3f) << 8) + data [pos + 1];
 217                                 pos += 2;
 218                         } else {
 219                                 len = ((data [pos] & 0x1f) << 24) + (data [pos + 1] << 16) + (data [pos + 2] << 8) + data [pos + 3];
 220                                 pos += 4;
 221                         }
 222                         rpos = pos;
 223                         return len;
 224                 }
 225
 226                 internal static string string_from_bytes (byte[] data, int pos, int len)
 227                 {
 228                         return System.Text.Encoding.UTF8.GetString(data, pos, len);
 229                 }
 230
 231                 internal string string_arg ()
 232                 {
 233                         int pos = 2;
 234                         int len = decode_len (data, pos, out pos);
 235                         return string_from_bytes (data, pos, len);
 236                 }
 237
 238                 internal static UnmanagedMarshal get_umarshal (CustomAttributeBuilder customBuilder, bool is_field) {
 239                         byte[] data = customBuilder.Data;
 240                         UnmanagedType subtype = (UnmanagedType)0x50; /* NATIVE_MAX */
 241                         int sizeConst = -1;
 242                         int sizeParamIndex = -1;
 243                         bool hasSize = false;
 244                         int value;
 245                         int utype; /* the (stupid) ctor takes a short or an enum ... */
 246                         string marshalTypeName = null;
 247                         Type marshalTypeRef = null;
 248                         string marshalCookie = String.Empty;
 249                         utype = (int)data [2];
 250                         utype |= ((int)data [3]) << 8;
 251
 252                         string first_type_name = GetParameters (customBuilder.Ctor) [0].ParameterType.FullName;
 253                         int pos = 6;
 254                         if (first_type_name == "System.Int16")
 255                                 pos = 4;
 256                         int nnamed = (int)data [pos++];
 257                         nnamed |= ((int)data [pos++]) << 8;
 258
 259                         for (int i = 0; i < nnamed; ++i) {
 260                                 int paramType; // What is this ?
 261
 262                                 /* Skip field/property signature */
 263                                 pos ++;
 264                                 /* Read type */
 265                                 paramType = ((int)data [pos++]);
 266                                 if (paramType == 0x55) {
 267                                         /* enums, the value is preceeded by the type */
 268                                         int len2 = decode_len (data, pos, out pos);
 269                                         string_from_bytes (data, pos, len2);
 270                                         pos += len2;
 271                                 }
 272                                 int len = decode_len (data, pos, out pos);
 273                                 string named_name = string_from_bytes (data, pos, len);
 274                                 pos += len;
 275
 276                                 switch (named_name) {
 277                                 case "ArraySubType":
 278                                         value = (int)data [pos++];
 279                                         value |= ((int)data [pos++]) << 8;
 280                                         value |= ((int)data [pos++]) << 16;
 281                                         value |= ((int)data [pos++]) << 24;
 282                                         subtype = (UnmanagedType)value;
 283                                         break;
 284                                 case "SizeConst":
 285                                         value = (int)data [pos++];
 286                                         value |= ((int)data [pos++]) << 8;
 287                                         value |= ((int)data [pos++]) << 16;
 288                                         value |= ((int)data [pos++]) << 24;
 289                                         sizeConst = value;
 290                                         hasSize = true;
 291                                         break;
 292                                 case "SafeArraySubType":
 293                                         value = (int)data[pos++];
 294                                         value |= ((int)data[pos++]) << 8;
 295                                         value |= ((int)data[pos++]) << 16;
 296                                         value |= ((int)data[pos++]) << 24;
 297                                         subtype = (UnmanagedType)value;
 298                                         break;
 299                                 case "IidParameterIndex":
 300                                         pos += 4;
 301                                         break;
 302                                 case "SafeArrayUserDefinedSubType":
 303                                         len = decode_len (data, pos, out pos);
 304                                         string_from_bytes (data, pos, len);
 305                                         pos += len;
 306                                         break;
 307                                 case "SizeParamIndex":
 308                                         value = (int)data [pos++];
 309                                         value |= ((int)data [pos++]) << 8;
 310                                         sizeParamIndex = value;
 311                                         hasSize = true;
 312                                         break;
 313                                 case "MarshalType":
 314                                         len = decode_len (data, pos, out pos);
 315                                         marshalTypeName = string_from_bytes (data, pos, len);
 316                                         pos += len;
 317                                         break;
 318                                 case "MarshalTypeRef":
 319                                         len = decode_len (data, pos, out pos);
 320                                         marshalTypeName = string_from_bytes (data, pos, len);
 321                                         marshalTypeRef = Type.GetType (marshalTypeName);
 322                                         pos += len;
 323                                         break;
 324                                 case "MarshalCookie":
 325                                         len = decode_len (data, pos, out pos);
 326                                         marshalCookie = string_from_bytes (data, pos, len);
 327                                         pos += len;
 328                                         break;
 329                                 default:
 330                                         throw new Exception ("Unknown MarshalAsAttribute field: " + named_name);
 331                                 }
 332                         }
 333
 334                         switch ((UnmanagedType)utype) {
 335                         case UnmanagedType.LPArray:
 336                                 if (hasSize)
 337                                         return UnmanagedMarshal.DefineLPArrayInternal (subtype, sizeConst, sizeParamIndex);
 338                                 else
 339                                         return UnmanagedMarshal.DefineLPArray (subtype);
 340                         case UnmanagedType.SafeArray:
 341                                 return UnmanagedMarshal.DefineSafeArray (subtype);
 342                         case UnmanagedType.ByValArray:
 343                                 if (!is_field)
 344                                         throw new ArgumentException ("Specified unmanaged type is only valid on fields");
 345
 346                                 return UnmanagedMarshal.DefineByValArray (sizeConst);
 347                         case UnmanagedType.ByValTStr:
 348                                 return UnmanagedMarshal.DefineByValTStr (sizeConst);
 349                         case UnmanagedType.CustomMarshaler:
 350                                 return UnmanagedMarshal.DefineCustom (marshalTypeRef, marshalCookie, marshalTypeName, Guid.Empty);
 351                         default:
 352                                 return UnmanagedMarshal.DefineUnmanagedMarshal ((UnmanagedType)utype);
 353                         }
 354                 }
 355
 356                 static Type elementTypeToType (int elementType) {
 357                         /* Partition II, section 23.1.16 */
 358                         switch (elementType) {
 359                         case 0x02:
 360                                 return typeof (bool);
 361                         case 0x03:
 362                                 return typeof (char);
 363                         case 0x04:
 364                                 return typeof (sbyte);
 365                         case 0x05:
 366                                 return typeof (byte);
 367                         case 0x06:
 368                                 return typeof (short);
 369                         case 0x07:
 370                                 return typeof (ushort);
 371                         case 0x08:
 372                                 return typeof (int);
 373                         case 0x09:
 374                                 return typeof (uint);
 375                         case 0x0a:
 376                                 return typeof (long);
 377                         case 0x0b:
 378                                 return typeof (ulong);
 379                         case 0x0c:
 380                                 return typeof (float);
 381                         case 0x0d:
 382                                 return typeof (double);
 383                         case 0x0e:
 384                                 return typeof (string);
 385                         default:
 386                                 throw new Exception ("Unknown element type '" + elementType + "'");
 387                         }
 388                 }
 389
 390                 static object decode_cattr_value (Type t, byte[] data, int pos, out int rpos) {
 391                         switch (Type.GetTypeCode (t)) {
 392                         case TypeCode.String:
 393                                 if (data [pos] == 0xff) {
 394                                         rpos = pos + 1;
 395                                         return null;
 396                                 }
 397                                 int len = decode_len (data, pos, out pos);
 398                                 rpos = pos + len;
 399                                 return string_from_bytes (data, pos, len);
 400                         case TypeCode.Int32:
 401                                 rpos = pos + 4;
 402                                 return data [pos] + (data [pos + 1] << 8) + (data [pos + 2] << 16) + (data [pos + 3] << 24);
 403                         case TypeCode.Boolean:
 404                                 rpos = pos + 1;
 405                                 return (data [pos] == 0) ? false : true;
 406                         case TypeCode.Object:
 407                                 int subtype = data [pos];
 408                                 pos += 1;
 409
 410                                 if (subtype >= 0x02 && subtype <= 0x0e)
 411                                         return decode_cattr_value (elementTypeToType (subtype), data, pos, out rpos);
 412                                 else
 413                                         throw new Exception ("Subtype '" + subtype + "' of type object not yet handled in decode_cattr_value");
 414                         default:
 415                                 throw new Exception ("FIXME: Type " + t + " not yet handled in decode_cattr_value.");
 416                         }
 417                 }
 418
 419                 internal struct CustomAttributeInfo {
 420                         public ConstructorInfo ctor;
 421                         public object[] ctorArgs;
 422                         public string[] namedParamNames;
 423                         public object[] namedParamValues;
 424                 }
 425
 426                 internal static CustomAttributeInfo decode_cattr (CustomAttributeBuilder customBuilder) {
 427                         byte[] data = customBuilder.Data;
 428                         ConstructorInfo ctor = customBuilder.Ctor;
 429                         int pos = 0;
 430
 431                         CustomAttributeInfo info = new CustomAttributeInfo ();
 432
 433                         // Prolog
 434                         if (data.Length < 2)
 435                                 throw new Exception ("Custom attr length is only '" + data.Length + "'");
 436                         if ((data [0] != 0x1) || (data [1] != 0x00))
 437                                 throw new Exception ("Prolog invalid");
 438                         pos = 2;
 439
 440                         ParameterInfo [] pi = GetParameters (ctor);
 441                         info.ctor = ctor;
 442                         info.ctorArgs = new object [pi.Length];
 443                         for (int i = 0; i < pi.Length; ++i)
 444                                 info.ctorArgs [i] = decode_cattr_value (pi [i].ParameterType, data, pos, out pos);
 445
 446                         int num_named = data [pos] + (data [pos + 1] * 256);
 447                         pos += 2;
 448
 449                         info.namedParamNames = new string [num_named];
 450                         info.namedParamValues = new object [num_named];
 451                         for (int i = 0; i < num_named; ++i) {
 452                                 int named_type = data [pos++];
 453                                 int data_type = data [pos++];
 454                                 string enum_type_name = null;
 455
 456                                 if (data_type == 0x55) {
 457                                         int len2 = decode_len (data, pos, out pos);
 458                                         enum_type_name = string_from_bytes (data, pos, len2);
 459                                         pos += len2;
 460                                 }
 461
 462                                 int len = decode_len (data, pos, out pos);
 463                                 string name = string_from_bytes (data, pos, len);
 464                                 info.namedParamNames [i] = name;
 465                                 pos += len;
 466
 467                                 if (named_type == 0x53) {
 468                                         /* Field */
 469                                         FieldInfo fi = ctor.DeclaringType.GetField (name, BindingFlags.Public|BindingFlags.NonPublic|BindingFlags.Instance);
 470                                         if (fi == null)
 471                                                 throw new Exception ("Custom attribute type '" + ctor.DeclaringType + "' doesn't contain a field named '" + name + "'");
 472
 473                                         object val = decode_cattr_value (fi.FieldType, data, pos, out pos);
 474                                         if (enum_type_name != null) {
 475                                                 Type enumType = Type.GetType (enum_type_name);
 476                                                 val = Enum.ToObject (enumType, val);
 477                                         }
 478
 479                                         info.namedParamValues [i] = val;
 480                                 }
 481                                 else
 482                                         // FIXME:
 483                                         throw new Exception ("Unknown named type: " + named_type);
 484                         }
 485
 486                         return info;
 487                 }
 488
 489                 void _CustomAttributeBuilder.GetIDsOfNames ([In] ref Guid riid, IntPtr rgszNames, uint cNames, uint lcid, IntPtr rgDispId)
 490                 {
 491                         throw new NotImplementedException ();
 492                 }
 493
 494                 void _CustomAttributeBuilder.GetTypeInfo (uint iTInfo, uint lcid, IntPtr ppTInfo)
 495                 {
 496                         throw new NotImplementedException ();
 497                 }
 498
 499                 void _CustomAttributeBuilder.GetTypeInfoCount (out uint pcTInfo)
 500                 {
 501                         throw new NotImplementedException ();
 502                 }
 503
 504                 void _CustomAttributeBuilder.Invoke (uint dispIdMember, [In] ref Guid riid, uint lcid, short wFlags, IntPtr pDispParams, IntPtr pVarResult, IntPtr pExcepInfo, IntPtr puArgErr)
 505                 {
 506                         throw new NotImplementedException ();
 507                 }
 508
 509                 static ParameterInfo [] GetParameters (ConstructorInfo ctor)
 510                 {
 511                         ConstructorBuilder cb = ctor as ConstructorBuilder;
 512                         if (cb != null)
 513                                 return cb.GetParametersInternal ();
 514                         return ctor.GetParameters ();
 515                 }
 516         }
 517 }