2 // delegate.cs: Delegate Handler
5 // Ravi Pratap (ravi@ximian.com)
6 // Miguel de Icaza (miguel@ximian.com)
7 // Marek Safar (marek.safar@gmail.com)
9 // Dual licensed under the terms of the MIT X11 or GNU GPL
11 // Copyright 2001 Ximian, Inc (http://www.ximian.com)
12 // Copyright 2003-2009 Novell, Inc (http://www.novell.com)
16 using System.Reflection;
17 using System.Reflection.Emit;
18 using System.Collections.Generic;
20 namespace Mono.CSharp {
23 // Delegate container implementation
25 public class Delegate : TypeContainer
27 FullNamedExpression ReturnType;
28 public readonly ParametersCompiled Parameters;
30 Constructor Constructor;
32 Method BeginInvokeBuilder;
33 Method EndInvokeBuilder;
35 static readonly string[] attribute_targets = new string [] { "type", "return" };
37 public static readonly string InvokeMethodName = "Invoke";
39 Expression instance_expr;
40 ReturnParameter return_attributes;
42 const Modifiers MethodModifiers = Modifiers.PUBLIC | Modifiers.VIRTUAL;
44 const Modifiers AllowedModifiers =
52 public Delegate (NamespaceEntry ns, DeclSpace parent, FullNamedExpression type,
53 Modifiers mod_flags, MemberName name, ParametersCompiled param_list,
55 : base (ns, parent, name, attrs, MemberKind.Delegate)
58 this.ReturnType = type;
59 ModFlags = ModifiersExtensions.Check (AllowedModifiers, mod_flags,
60 IsTopLevel ? Modifiers.INTERNAL :
61 Modifiers.PRIVATE, name.Location, Report);
62 Parameters = param_list;
63 spec = new TypeSpec (Kind, null, this, null, ModFlags | Modifiers.SEALED);
66 public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
68 if (a.Target == AttributeTargets.ReturnValue) {
69 if (return_attributes == null)
70 return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
72 return_attributes.ApplyAttributeBuilder (a, ctor, cdata, pa);
76 base.ApplyAttributeBuilder (a, ctor, cdata, pa);
79 public override AttributeTargets AttributeTargets {
81 return AttributeTargets.Delegate;
85 public override TypeSpec BaseType {
87 return TypeManager.multicast_delegate_type;
91 protected override bool DoDefineMembers ()
93 var ctor_parameters = ParametersCompiled.CreateFullyResolved (
95 new Parameter (new TypeExpression (TypeManager.object_type, Location), "object", Parameter.Modifier.NONE, null, Location),
96 new Parameter (new TypeExpression (TypeManager.intptr_type, Location), "method", Parameter.Modifier.NONE, null, Location)
99 TypeManager.object_type,
100 TypeManager.intptr_type
104 Constructor = new Constructor (this, System.Reflection.ConstructorInfo.ConstructorName,
105 Modifiers.PUBLIC, null, ctor_parameters, null, Location);
106 Constructor.Define ();
109 // Here the various methods like Invoke, BeginInvoke etc are defined
111 // First, call the `out of band' special method for
112 // defining recursively any types we need:
116 if (!p.Resolve (this))
123 // Check accessibility
124 foreach (var partype in p.Types) {
125 if (!IsAccessibleAs (partype)) {
126 Report.SymbolRelatedToPreviousError (partype);
127 Report.Error (59, Location,
128 "Inconsistent accessibility: parameter type `{0}' is less accessible than delegate `{1}'",
129 TypeManager.CSharpName (partype), GetSignatureForError ());
133 ReturnType = ReturnType.ResolveAsTypeTerminal (this, false);
134 if (ReturnType == null)
137 var ret_type = ReturnType.Type;
140 // We don't have to check any others because they are all
141 // guaranteed to be accessible - they are standard types.
143 if (!IsAccessibleAs (ret_type)) {
144 Report.SymbolRelatedToPreviousError (ret_type);
145 Report.Error (58, Location,
146 "Inconsistent accessibility: return type `" +
147 TypeManager.CSharpName (ret_type) + "' is less " +
148 "accessible than delegate `" + GetSignatureForError () + "'");
152 CheckProtectedModifier ();
154 if (RootContext.StdLib && TypeManager.IsSpecialType (ret_type)) {
155 Method.Error1599 (Location, ret_type, Report);
159 TypeManager.CheckTypeVariance (ret_type, Variance.Covariant, this);
161 InvokeBuilder = new Method (this, null, ReturnType, MethodModifiers, new MemberName (InvokeMethodName), p, null);
162 InvokeBuilder.Define ();
165 // Don't emit async method for compiler generated delegates (e.g. dynamic site containers)
167 if (TypeManager.iasyncresult_type != null && TypeManager.asynccallback_type != null && !IsCompilerGenerated) {
168 DefineAsyncMethods (Parameters.CallingConvention);
174 void DefineAsyncMethods (CallingConventions cc)
179 Parameter[] compiled = new Parameter[Parameters.Count];
180 for (int i = 0; i < compiled.Length; ++i)
181 compiled[i] = new Parameter (new TypeExpression (Parameters.Types[i], Location),
182 Parameters.FixedParameters[i].Name,
183 Parameters.FixedParameters[i].ModFlags & (Parameter.Modifier.REF | Parameter.Modifier.OUT),
186 ParametersCompiled async_parameters = new ParametersCompiled (Compiler, compiled);
188 async_parameters = ParametersCompiled.MergeGenerated (Compiler, async_parameters, false,
190 new Parameter (new TypeExpression (TypeManager.asynccallback_type, Location), "callback", Parameter.Modifier.NONE, null, Location),
191 new Parameter (new TypeExpression (TypeManager.object_type, Location), "object", Parameter.Modifier.NONE, null, Location)
194 TypeManager.asynccallback_type,
195 TypeManager.object_type
199 BeginInvokeBuilder = new Method (this, null,
200 new TypeExpression (TypeManager.iasyncresult_type, Location), MethodModifiers,
201 new MemberName ("BeginInvoke"), async_parameters, null);
202 BeginInvokeBuilder.Define ();
205 // EndInvoke is a bit more interesting, all the parameters labeled as
206 // out or ref have to be duplicated here.
210 // Define parameters, and count out/ref parameters
212 ParametersCompiled end_parameters;
215 foreach (Parameter p in Parameters.FixedParameters) {
216 if ((p.ModFlags & Parameter.Modifier.ISBYREF) != 0)
220 if (out_params > 0) {
221 var end_param_types = new TypeSpec [out_params];
222 Parameter[] end_params = new Parameter[out_params];
225 for (int i = 0; i < Parameters.FixedParameters.Length; ++i) {
226 Parameter p = Parameters [i];
227 if ((p.ModFlags & Parameter.Modifier.ISBYREF) == 0)
230 end_param_types[param] = Parameters.Types[i];
231 end_params[param] = p;
234 end_parameters = ParametersCompiled.CreateFullyResolved (end_params, end_param_types);
236 end_parameters = ParametersCompiled.EmptyReadOnlyParameters;
239 end_parameters = ParametersCompiled.MergeGenerated (Compiler, end_parameters, false,
241 new TypeExpression (TypeManager.iasyncresult_type, Location),
242 "result", Parameter.Modifier.NONE, null, Location),
243 TypeManager.iasyncresult_type);
246 // Create method, define parameters, register parameters with type system
248 EndInvokeBuilder = new Method (this, null, ReturnType, MethodModifiers, new MemberName ("EndInvoke"), end_parameters, null);
249 EndInvokeBuilder.Define ();
252 public override void DefineConstants ()
254 if (!Parameters.IsEmpty && Parameters[Parameters.Count - 1].HasDefaultValue) {
255 var rc = new ResolveContext (this);
256 Parameters.ResolveDefaultValues (rc);
260 public override void EmitType ()
262 if (ReturnType.Type == InternalType.Dynamic) {
263 return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
264 PredefinedAttributes.Get.Dynamic.EmitAttribute (return_attributes.Builder);
266 var trans_flags = TypeManager.HasDynamicTypeUsed (ReturnType.Type);
267 if (trans_flags != null) {
268 var pa = PredefinedAttributes.Get.DynamicTransform;
269 if (pa.Constructor != null || pa.ResolveConstructor (Location, ArrayContainer.MakeType (TypeManager.bool_type))) {
270 return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
271 return_attributes.Builder.SetCustomAttribute (
272 new CustomAttributeBuilder (pa.Constructor, new object [] { trans_flags }));
277 Parameters.ApplyAttributes (InvokeBuilder.MethodBuilder);
279 Constructor.ConstructorBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
280 InvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
282 if (BeginInvokeBuilder != null) {
283 BeginInvokeBuilder.ParameterInfo.ApplyAttributes (BeginInvokeBuilder.MethodBuilder);
285 BeginInvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
286 EndInvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
289 if (OptAttributes != null) {
290 OptAttributes.Emit ();
296 protected override TypeAttributes TypeAttr {
298 return ModifiersExtensions.TypeAttr (ModFlags, IsTopLevel) |
299 TypeAttributes.Class | TypeAttributes.Sealed |
304 public override string[] ValidAttributeTargets {
306 return attribute_targets;
311 protected override bool VerifyClsCompliance ()
313 if (!base.VerifyClsCompliance ()) {
317 Parameters.VerifyClsCompliance (this);
319 if (!ReturnType.Type.IsCLSCompliant ()) {
320 Report.Warning (3002, 1, Location, "Return type of `{0}' is not CLS-compliant",
321 GetSignatureForError ());
327 public static MethodSpec GetConstructor (CompilerContext ctx, TypeSpec container_type, TypeSpec delType)
329 var ctor = MemberCache.FindMember (delType, MemberFilter.Constructor (null), BindingRestriction.DeclaredOnly);
330 return (MethodSpec) ctor;
334 // Returns the "Invoke" from a delegate type
336 public static MethodSpec GetInvokeMethod (CompilerContext ctx, TypeSpec delType)
338 var invoke = MemberCache.FindMember (delType,
339 MemberFilter.Method (InvokeMethodName, 0, null, null),
340 BindingRestriction.DeclaredOnly);
342 return (MethodSpec) invoke;
345 public static AParametersCollection GetParameters (CompilerContext ctx, TypeSpec delType)
347 var invoke_mb = GetInvokeMethod (ctx, delType);
348 return invoke_mb.Parameters;
352 // 15.2 Delegate compatibility
354 public static bool IsTypeCovariant (Expression a, TypeSpec b)
357 // For each value parameter (a parameter with no ref or out modifier), an
358 // identity conversion or implicit reference conversion exists from the
359 // parameter type in D to the corresponding parameter type in M
364 if (RootContext.Version == LanguageVersion.ISO_1)
367 return Convert.ImplicitReferenceConversionExists (a, b);
370 public static string FullDelegateDesc (MethodSpec invoke_method)
372 return TypeManager.GetFullNameSignature (invoke_method).Replace (".Invoke", "");
375 public Expression InstanceExpression {
377 return instance_expr;
380 instance_expr = value;
386 // Base class for `NewDelegate' and `ImplicitDelegateCreation'
388 public abstract class DelegateCreation : Expression, MethodGroupExpr.IErrorHandler
390 protected MethodSpec constructor_method;
391 protected MethodSpec delegate_method;
392 // We keep this to handle IsBase only
393 protected MethodGroupExpr method_group;
394 protected Expression delegate_instance_expression;
396 // TODO: Should either cache it or use interface to abstract it
397 public static Arguments CreateDelegateMethodArguments (AParametersCollection pd, Location loc)
399 Arguments delegate_arguments = new Arguments (pd.Count);
400 for (int i = 0; i < pd.Count; ++i) {
401 Argument.AType atype_modifier;
402 TypeSpec atype = pd.Types [i];
403 switch (pd.FixedParameters [i].ModFlags) {
404 case Parameter.Modifier.REF:
405 atype_modifier = Argument.AType.Ref;
406 //atype = atype.GetElementType ();
408 case Parameter.Modifier.OUT:
409 atype_modifier = Argument.AType.Out;
410 //atype = atype.GetElementType ();
416 delegate_arguments.Add (new Argument (new TypeExpression (atype, loc), atype_modifier));
418 return delegate_arguments;
421 public override Expression CreateExpressionTree (ResolveContext ec)
423 MemberAccess ma = new MemberAccess (new MemberAccess (new QualifiedAliasMember ("global", "System", loc), "Delegate", loc), "CreateDelegate", loc);
425 Arguments args = new Arguments (3);
426 args.Add (new Argument (new TypeOf (new TypeExpression (type, loc), loc)));
427 args.Add (new Argument (new NullLiteral (loc)));
428 args.Add (new Argument (new TypeOfMethod (delegate_method, loc)));
429 Expression e = new Invocation (ma, args).Resolve (ec);
433 e = Convert.ExplicitConversion (ec, e, type, loc);
437 return e.CreateExpressionTree (ec);
440 protected override Expression DoResolve (ResolveContext ec)
442 constructor_method = Delegate.GetConstructor (ec.Compiler, ec.CurrentType, type);
444 var invoke_method = Delegate.GetInvokeMethod (ec.Compiler, type);
445 method_group.DelegateType = type;
446 method_group.CustomErrorHandler = this;
448 Arguments arguments = CreateDelegateMethodArguments (invoke_method.Parameters, loc);
449 method_group = method_group.OverloadResolve (ec, ref arguments, false, loc);
450 if (method_group == null)
453 delegate_method = (MethodSpec) method_group;
455 if (TypeManager.IsNullableType (delegate_method.DeclaringType)) {
456 ec.Report.Error (1728, loc, "Cannot create delegate from method `{0}' because it is a member of System.Nullable<T> type",
457 TypeManager.GetFullNameSignature (delegate_method));
461 Invocation.IsSpecialMethodInvocation (ec, delegate_method, loc);
463 ExtensionMethodGroupExpr emg = method_group as ExtensionMethodGroupExpr;
465 delegate_instance_expression = emg.ExtensionExpression;
466 TypeSpec e_type = delegate_instance_expression.Type;
467 if (TypeManager.IsValueType (e_type)) {
468 ec.Report.Error (1113, loc, "Extension method `{0}' of value type `{1}' cannot be used to create delegates",
469 delegate_method.GetSignatureForError (), TypeManager.CSharpName (e_type));
473 TypeSpec rt = delegate_method.ReturnType;
474 Expression ret_expr = new TypeExpression (rt, loc);
475 if (!Delegate.IsTypeCovariant (ret_expr, invoke_method.ReturnType)) {
476 Error_ConversionFailed (ec, delegate_method, ret_expr);
479 if (delegate_method.IsConditionallyExcluded (loc)) {
480 ec.Report.SymbolRelatedToPreviousError (delegate_method);
481 MethodOrOperator m = delegate_method.MemberDefinition as MethodOrOperator;
482 if (m != null && m.IsPartialDefinition) {
483 ec.Report.Error (762, loc, "Cannot create delegate from partial method declaration `{0}'",
484 delegate_method.GetSignatureForError ());
486 ec.Report.Error (1618, loc, "Cannot create delegate with `{0}' because it has a Conditional attribute",
487 TypeManager.CSharpSignature (delegate_method));
491 DoResolveInstanceExpression (ec);
492 eclass = ExprClass.Value;
496 void DoResolveInstanceExpression (ResolveContext ec)
499 // Argument is another delegate
501 if (delegate_instance_expression != null)
504 if (method_group.IsStatic) {
505 delegate_instance_expression = null;
509 Expression instance = method_group.InstanceExpression;
510 if (instance != null && instance != EmptyExpression.Null) {
511 delegate_instance_expression = instance;
512 TypeSpec instance_type = delegate_instance_expression.Type;
513 if (TypeManager.IsValueType (instance_type) || TypeManager.IsGenericParameter (instance_type)) {
514 delegate_instance_expression = new BoxedCast (
515 delegate_instance_expression, TypeManager.object_type);
518 delegate_instance_expression = ec.GetThis (loc);
522 public override void Emit (EmitContext ec)
524 if (delegate_instance_expression == null)
525 ec.Emit (OpCodes.Ldnull);
527 delegate_instance_expression.Emit (ec);
529 // Any delegate must be sealed
530 if (!delegate_method.DeclaringType.IsDelegate && delegate_method.IsVirtual && !method_group.IsBase) {
531 ec.Emit (OpCodes.Dup);
532 ec.Emit (OpCodes.Ldvirtftn, delegate_method);
534 ec.Emit (OpCodes.Ldftn, delegate_method);
537 ec.Emit (OpCodes.Newobj, constructor_method);
540 void Error_ConversionFailed (ResolveContext ec, MethodSpec method, Expression return_type)
542 var invoke_method = Delegate.GetInvokeMethod (ec.Compiler, type);
543 string member_name = delegate_instance_expression != null ?
544 Delegate.FullDelegateDesc (method) :
545 TypeManager.GetFullNameSignature (method);
547 ec.Report.SymbolRelatedToPreviousError (type);
548 ec.Report.SymbolRelatedToPreviousError (method);
549 if (RootContext.Version == LanguageVersion.ISO_1) {
550 ec.Report.Error (410, loc, "A method or delegate `{0} {1}' parameters and return type must be same as delegate `{2} {3}' parameters and return type",
551 TypeManager.CSharpName (method.ReturnType), member_name,
552 TypeManager.CSharpName (invoke_method.ReturnType), Delegate.FullDelegateDesc (invoke_method));
555 if (return_type == null) {
556 ec.Report.Error (123, loc, "A method or delegate `{0}' parameters do not match delegate `{1}' parameters",
557 member_name, Delegate.FullDelegateDesc (invoke_method));
561 ec.Report.Error (407, loc, "A method or delegate `{0} {1}' return type does not match delegate `{2} {3}' return type",
562 return_type.GetSignatureForError (), member_name,
563 TypeManager.CSharpName (invoke_method.ReturnType), Delegate.FullDelegateDesc (invoke_method));
566 public static bool ImplicitStandardConversionExists (ResolveContext ec, MethodGroupExpr mg, TypeSpec target_type)
568 if (target_type == TypeManager.delegate_type || target_type == TypeManager.multicast_delegate_type)
571 mg.DelegateType = target_type;
572 var invoke = Delegate.GetInvokeMethod (ec.Compiler, target_type);
574 Arguments arguments = CreateDelegateMethodArguments (invoke.Parameters, mg.Location);
575 return mg.OverloadResolve (ec, ref arguments, true, mg.Location) != null;
578 #region IErrorHandler Members
580 public bool NoExactMatch (ResolveContext ec, MethodSpec method)
582 if (method.IsGeneric)
585 Error_ConversionFailed (ec, method, null);
589 public bool AmbiguousCall (ResolveContext ec, MethodSpec ambiguous)
598 // Created from the conversion code
600 public class ImplicitDelegateCreation : DelegateCreation
602 ImplicitDelegateCreation (TypeSpec t, MethodGroupExpr mg, Location l)
605 this.method_group = mg;
609 static public Expression Create (ResolveContext ec, MethodGroupExpr mge,
610 TypeSpec target_type, Location loc)
612 ImplicitDelegateCreation d = new ImplicitDelegateCreation (target_type, mge, loc);
613 return d.DoResolve (ec);
618 // A delegate-creation-expression, invoked from the `New' class
620 public class NewDelegate : DelegateCreation
622 public Arguments Arguments;
625 // This constructor is invoked from the `New' expression
627 public NewDelegate (TypeSpec type, Arguments Arguments, Location loc)
630 this.Arguments = Arguments;
634 protected override Expression DoResolve (ResolveContext ec)
636 if (Arguments == null || Arguments.Count != 1) {
637 ec.Report.Error (149, loc, "Method name expected");
641 Argument a = Arguments [0];
642 if (!a.ResolveMethodGroup (ec))
645 Expression e = a.Expr;
647 AnonymousMethodExpression ame = e as AnonymousMethodExpression;
648 if (ame != null && RootContext.Version != LanguageVersion.ISO_1) {
649 e = ame.Compatible (ec, type);
653 return e.Resolve (ec);
656 method_group = e as MethodGroupExpr;
657 if (method_group == null) {
658 if (e.Type == InternalType.Dynamic) {
659 e = Convert.ImplicitConversionRequired (ec, e, type, loc);
660 } else if (!e.Type.IsDelegate) {
661 e.Error_UnexpectedKind (ec, ResolveFlags.MethodGroup | ResolveFlags.Type, loc);
666 // An argument is not a method but another delegate
668 delegate_instance_expression = e;
669 method_group = new MethodGroupExpr (Delegate.GetInvokeMethod (ec.Compiler, e.Type), e.Type, loc);
672 return base.DoResolve (ec);
677 // Invocation converted to delegate Invoke call
679 class DelegateInvocation : ExpressionStatement
681 readonly Expression InstanceExpr;
685 public DelegateInvocation (Expression instance_expr, Arguments args, Location loc)
687 this.InstanceExpr = instance_expr;
688 this.arguments = args;
692 public override Expression CreateExpressionTree (ResolveContext ec)
694 Arguments args = Arguments.CreateForExpressionTree (ec, this.arguments,
695 InstanceExpr.CreateExpressionTree (ec));
697 return CreateExpressionFactoryCall (ec, "Invoke", args);
700 protected override Expression DoResolve (ResolveContext ec)
702 if (InstanceExpr is EventExpr) {
703 ((EventExpr) InstanceExpr).Error_CannotAssign (ec);
707 TypeSpec del_type = InstanceExpr.Type;
708 if (del_type == null)
711 method = Delegate.GetInvokeMethod (ec.Compiler, del_type);
713 var me = new MethodGroupExpr (mb, del_type, loc);
714 me.InstanceExpression = InstanceExpr;
716 AParametersCollection pd = mb.Parameters;
717 int pd_count = pd.Count;
719 int arg_count = arguments == null ? 0 : arguments.Count;
721 bool params_method = pd.HasParams;
722 bool is_params_applicable = false;
723 bool is_applicable = me.IsApplicable (ec, ref arguments, arg_count, ref mb, ref is_params_applicable) == 0;
724 if (arguments != null)
725 arg_count = arguments.Count;
727 if (!is_applicable && !params_method && arg_count != pd_count) {
728 ec.Report.Error (1593, loc, "Delegate `{0}' does not take `{1}' arguments",
729 TypeManager.CSharpName (del_type), arg_count.ToString ());
730 } else if (arguments == null || !arguments.HasDynamic) {
731 me.VerifyArgumentsCompat (ec, ref arguments, arg_count, mb,
732 is_params_applicable || (!is_applicable && params_method), false, loc);
735 type = method.ReturnType;
736 eclass = ExprClass.Value;
740 public override void Emit (EmitContext ec)
743 // Invocation on delegates call the virtual Invoke member
744 // so we are always `instance' calls
746 Invocation.EmitCall (ec, false, InstanceExpr, method, arguments, loc);
749 public override void EmitStatement (EmitContext ec)
753 // Pop the return value if there is one
755 if (type != TypeManager.void_type)
756 ec.Emit (OpCodes.Pop);
759 public override System.Linq.Expressions.Expression MakeExpression (BuilderContext ctx)
761 return Invocation.MakeExpression (ctx, InstanceExpr, method, arguments);