class/corlib/System.Reflection.Emit/SignatureHelper.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/SignatureHelper.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.Globalization;
  38 using System.Runtime.CompilerServices;
  39 using System.Runtime.InteropServices;
  40
  41 namespace System.Reflection.Emit {
  42         [ComVisible (true)]
  43         [ComDefaultInterface (typeof (_SignatureHelper))]
  44         [ClassInterface (ClassInterfaceType.None)]
  45         public sealed class SignatureHelper : _SignatureHelper {
  46                 internal enum SignatureHelperType {
  47                         HELPER_FIELD,
  48                         HELPER_LOCAL,
  49                         HELPER_METHOD,
  50                         HELPER_PROPERTY
  51                 }
  52
  53                 private ModuleBuilder module; // can be null in 2.0
  54                 private Type[] arguments;
  55                 private SignatureHelperType type;
  56                 private Type returnType;
  57                 private CallingConventions callConv;
  58                 private CallingConvention unmanagedCallConv;
  59 #pragma warning disable 649
  60                 private Type[][] modreqs;
  61                 private Type[][] modopts;
  62 #pragma warning restore 649
  63
  64                 internal SignatureHelper (ModuleBuilder module, SignatureHelperType type)
  65                 {
  66                         this.type = type;
  67                         this.module = module;
  68                 }
  69
  70                 public static SignatureHelper GetFieldSigHelper (Module mod)
  71                 {
  72                         if (mod != null && !(mod is ModuleBuilder))
  73                                 throw new ArgumentException ("ModuleBuilder is expected");
  74
  75                         return new SignatureHelper ((ModuleBuilder) mod, SignatureHelperType.HELPER_FIELD);
  76                 }
  77
  78                 public static SignatureHelper GetLocalVarSigHelper (Module mod)
  79                 {
  80                         if (mod != null && !(mod is ModuleBuilder))
  81                                 throw new ArgumentException ("ModuleBuilder is expected");
  82
  83                         return new SignatureHelper ((ModuleBuilder) mod, SignatureHelperType.HELPER_LOCAL);
  84                 }
  85
  86                 public static SignatureHelper GetLocalVarSigHelper ()
  87                 {
  88                         return new SignatureHelper (null, SignatureHelperType.HELPER_LOCAL);
  89                 }
  90
  91                 public static SignatureHelper GetMethodSigHelper (CallingConventions callingConvention, Type returnType)
  92                 {
  93                         return GetMethodSigHelper (null, callingConvention, (CallingConvention)0, returnType, null);
  94                 }
  95
  96                 public static SignatureHelper GetMethodSigHelper (CallingConvention unmanagedCallingConvention, Type returnType)
  97                 {
  98                         return GetMethodSigHelper (null, CallingConventions.Standard, unmanagedCallingConvention, returnType, null);
  99                 }
 100
 101                 public static SignatureHelper GetMethodSigHelper (Module mod, CallingConventions callingConvention, Type returnType)
 102                 {
 103                         return GetMethodSigHelper (mod, callingConvention, (CallingConvention)0, returnType, null);
 104                 }
 105
 106                 public static SignatureHelper GetMethodSigHelper (Module mod, CallingConvention unmanagedCallConv, Type returnType)
 107                 {
 108                         return GetMethodSigHelper (mod, CallingConventions.Standard, unmanagedCallConv, returnType, null);
 109                 }
 110
 111                 public static SignatureHelper GetMethodSigHelper (Module mod, Type returnType, Type[] parameterTypes)
 112                 {
 113                         return GetMethodSigHelper (mod, CallingConventions.Standard, (CallingConvention)0, returnType, parameterTypes);
 114                 }
 115                 [MonoTODO("Not implemented")]
 116                 public static SignatureHelper GetPropertySigHelper (Module mod, Type returnType, Type[] parameterTypes)
 117                 {
 118                         throw new NotImplementedException ();
 119                 }
 120
 121                 //
 122                 // Grows the given array, and returns the index where the element
 123                 // was added
 124                 //
 125                 static int AppendArray (ref Type [] array, Type t)
 126                 {
 127                         if (array != null) {
 128                                 Type[] new_a = new Type [array.Length + 1];
 129                                 System.Array.Copy (array, new_a, array.Length);
 130                                 new_a [array.Length] = t;
 131                                 array = new_a;
 132                                 return array.Length-1;
 133                         } else {
 134                                 array = new Type [1];
 135                                 array [0] = t;
 136                                 return 0;
 137                         }
 138                 }
 139
 140                 //
 141                 // Appends the given type array @t into the @array passed at
 142                 // position @pos.   If there is no array, it gets created
 143                 //
 144                 // This allows adding data to a null array at position 5 for
 145                 // example, creating 4 empty slots before the slot where @t
 146                 // is stored.
 147                 //
 148                 //
 149                 static void AppendArrayAt (ref Type [][] array, Type [] t, int pos)
 150                 {
 151                         int top = Math.Max (pos, array == null ? 0 : array.Length);
 152                         Type[][] new_a = new Type [top+1][];
 153                         if (array != null)
 154                                 System.Array.Copy (array, new_a, top);
 155                         new_a [pos] = t;
 156                         array = new_a;
 157                 }
 158
 159                 static void ValidateParameterModifiers (string name, Type [] parameter_modifiers)
 160                 {
 161                         foreach (Type modifier in parameter_modifiers){
 162                                 if (modifier == null)
 163                                         throw new ArgumentNullException (name);
 164                                 if (modifier.IsArray)
 165                                         throw new ArgumentException (Locale.GetText ("Array type not permitted"), name);
 166                                 if (modifier.ContainsGenericParameters)
 167                                         throw new ArgumentException (Locale.GetText ("Open Generic Type not permitted"), name);
 168                         }
 169                 }
 170
 171                 static void ValidateCustomModifier (int n, Type [][] custom_modifiers, string name)
 172                 {
 173                         if (custom_modifiers == null)
 174                                 return;
 175
 176                         if (custom_modifiers.Length != n)
 177                                 throw new ArgumentException (
 178                                      Locale.GetText (
 179                                         String.Format ("Custom modifiers length `{0}' does not match the size of the arguments")));
 180
 181                         foreach (Type [] parameter_modifiers in custom_modifiers){
 182                                 if (parameter_modifiers == null)
 183                                         continue;
 184
 185                                 ValidateParameterModifiers (name, parameter_modifiers);
 186                         }
 187                 }
 188
 189                 static Exception MissingFeature ()
 190                 {
 191                         throw new NotImplementedException ("Mono does not currently support setting modOpt/modReq through SignatureHelper");
 192                 }
 193
 194                 [MonoTODO("Currently we ignore requiredCustomModifiers and optionalCustomModifiers")]
 195                 public void AddArguments (Type[] arguments, Type[][] requiredCustomModifiers, Type[][] optionalCustomModifiers)
 196                 {
 197                         if (arguments == null)
 198                                 throw new ArgumentNullException ("arguments");
 199
 200                         // For now
 201                         if (requiredCustomModifiers != null || optionalCustomModifiers != null){
 202                                 throw MissingFeature();
 203                         }
 204
 205                         ValidateCustomModifier (arguments.Length, requiredCustomModifiers, "requiredCustomModifiers");
 206                         ValidateCustomModifier (arguments.Length, optionalCustomModifiers, "optionalCustomModifiers");
 207
 208                         for (int i = 0; i < arguments.Length; i++){
 209                                 AddArgument (arguments [i],
 210                                              requiredCustomModifiers != null ? requiredCustomModifiers [i] : null,
 211                                              optionalCustomModifiers != null ? optionalCustomModifiers [i] : null);
 212                         }
 213                 }
 214
 215                 [MonoTODO ("pinned is ignored")]
 216                 public void AddArgument (Type argument, bool pinned)
 217                 {
 218                         AddArgument (argument);
 219                 }
 220
 221                 public void AddArgument (Type argument, Type [] requiredCustomModifiers, Type [] optionalCustomModifiers)
 222                 {
 223                         if (argument == null)
 224                                 throw new ArgumentNullException ("argument");
 225
 226                         if (requiredCustomModifiers != null)
 227                                 ValidateParameterModifiers ("requiredCustomModifiers", requiredCustomModifiers);
 228                         if (optionalCustomModifiers != null)
 229                                 ValidateParameterModifiers ("optionalCustomModifiers", optionalCustomModifiers);
 230
 231                         int p = AppendArray (ref arguments, argument);
 232                         if (requiredCustomModifiers != null)
 233                                 AppendArrayAt (ref modreqs, requiredCustomModifiers, p);
 234                         if (optionalCustomModifiers != null)
 235                                 AppendArrayAt (ref modopts, optionalCustomModifiers, p);
 236                 }
 237
 238                 [MonoTODO("Not implemented")]
 239                 public static SignatureHelper GetPropertySigHelper (Module mod, Type returnType,
 240                                                                     Type [] requiredReturnTypeCustomModifiers,
 241                                                                     Type [] optionalReturnTypeCustomModifiers,
 242                                                                     Type [] parameterTypes,
 243                                                                     Type [] [] requiredParameterTypeCustomModifiers,
 244                                                                     Type [] [] optionalParameterTypeCustomModifiers)
 245                 {
 246                         throw new NotImplementedException ();
 247                 }
 248
 249                 public void AddArgument (Type clsArgument)
 250                 {
 251                         if (clsArgument == null)
 252                                 throw new ArgumentNullException ("clsArgument");
 253
 254                         AppendArray (ref arguments, clsArgument);
 255                 }
 256
 257                 [MonoTODO("Not implemented")]
 258                 public void AddSentinel ()
 259                 {
 260                         throw new NotImplementedException ();
 261                 }
 262
 263                 static bool CompareOK (Type [][] one, Type [][] two)
 264                 {
 265                         if (one == null){
 266                                 if (two == null)
 267                                         return true;
 268                                 return false;
 269                         } else if (two == null)
 270                                 return false;
 271
 272                         if (one.Length != two.Length)
 273                                 return false;
 274
 275                         for (int i = 0; i < one.Length; i++){
 276                                 Type [] tone = one [i];
 277                                 Type [] ttwo = two [i];
 278
 279                                 if (tone == null){
 280                                         if (ttwo == null)
 281                                                 continue;
 282                                 } else if (ttwo == null)
 283                                         return false;
 284
 285                                 if (tone.Length != ttwo.Length)
 286                                         return false;
 287
 288                                 for (int j = 0; j < tone.Length; j++){
 289                                         Type uone = tone [j];
 290                                         Type utwo = ttwo [j];
 291
 292                                         if (uone == null){
 293                                                 if (utwo == null)
 294                                                         continue;
 295                                                 return false;
 296                                         } else if (utwo == null)
 297                                                 return false;
 298
 299                                         if (!uone.Equals (utwo))
 300                                                 return false;
 301                                 }
 302                         }
 303                         return true;
 304                 }
 305
 306                 public override bool Equals (object obj)
 307                 {
 308                         SignatureHelper other = obj as SignatureHelper;
 309                         if (other == null)
 310                                 return false;
 311
 312                         if (other.module != module ||
 313                             other.returnType != returnType ||
 314                             other.callConv != callConv ||
 315                             other.unmanagedCallConv != unmanagedCallConv)
 316                                 return false;
 317
 318                         if (arguments != null){
 319                                 if (other.arguments == null)
 320                                         return false;
 321                                 if (arguments.Length != other.arguments.Length)
 322                                         return false;
 323
 324                                 for (int i = 0; i < arguments.Length; i++)
 325                                         if (!other.arguments [i].Equals (arguments [i]))
 326                                                 return false;
 327                         } else if (other.arguments != null)
 328                                 return false;
 329
 330                         return CompareOK (other.modreqs, modreqs) && CompareOK (other.modopts, modopts);
 331                 }
 332
 333                 public override int GetHashCode ()
 334                 {
 335                         // Lame, but easy, and will work, and chances are
 336                         // you will only need a few of these.
 337                         return 0;
 338                 }
 339
 340                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 341                 internal extern byte[] get_signature_local ();
 342
 343                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 344                 internal extern byte[] get_signature_field ();
 345
 346                 public byte[] GetSignature ()
 347                 {
 348                         switch (type) {
 349                         case SignatureHelperType.HELPER_LOCAL:
 350                                 return get_signature_local ();
 351                         case SignatureHelperType.HELPER_FIELD:
 352                                 return get_signature_field ();
 353                         default:
 354                                 throw new NotImplementedException ();
 355                         }
 356                 }
 357
 358                 public override string ToString() {
 359                         return "SignatureHelper";
 360                 }
 361
 362                 internal static SignatureHelper GetMethodSigHelper (Module mod, CallingConventions callingConvention, CallingConvention unmanagedCallingConvention, Type returnType,
 363                                                                                                                    Type [] parameters)
 364                 {
 365                         if (mod != null && !(mod is ModuleBuilder))
 366                                 throw new ArgumentException ("ModuleBuilder is expected");
 367
 368                         if (returnType == null)
 369                                 returnType = typeof (void);
 370
 371                         if (returnType.IsUserType)
 372                                 throw new NotSupportedException ("User defined subclasses of System.Type are not yet supported.");
 373                         if (parameters != null) {
 374                                 for (int i = 0; i < parameters.Length; ++i)
 375                                         if (parameters [i].IsUserType)
 376                                                 throw new NotSupportedException ("User defined subclasses of System.Type are not yet supported.");
 377
 378                         }
 379
 380                         SignatureHelper helper =
 381                                 new SignatureHelper ((ModuleBuilder)mod, SignatureHelperType.HELPER_METHOD);
 382                         helper.returnType = returnType;
 383                         helper.callConv = callingConvention;
 384                         helper.unmanagedCallConv = unmanagedCallingConvention;
 385
 386                         if (parameters != null) {
 387                                 helper.arguments = new Type [parameters.Length];
 388                                 for (int i = 0; i < parameters.Length; ++i)
 389                                         helper.arguments [i] = parameters [i];
 390                         }
 391
 392                         return helper;
 393                 }
 394
 395                 void _SignatureHelper.GetIDsOfNames ([In] ref Guid riid, IntPtr rgszNames, uint cNames, uint lcid, IntPtr rgDispId)
 396                 {
 397                         throw new NotImplementedException ();
 398                 }
 399
 400                 void _SignatureHelper.GetTypeInfo (uint iTInfo, uint lcid, IntPtr ppTInfo)
 401                 {
 402                         throw new NotImplementedException ();
 403                 }
 404
 405                 void _SignatureHelper.GetTypeInfoCount (out uint pcTInfo)
 406                 {
 407                         throw new NotImplementedException ();
 408                 }
 409
 410                 void _SignatureHelper.Invoke (uint dispIdMember, [In] ref Guid riid, uint lcid, short wFlags, IntPtr pDispParams, IntPtr pVarResult, IntPtr pExcepInfo, IntPtr puArgErr)
 411                 {
 412                         throw new NotImplementedException ();
 413                 }
 414         }
 415 }