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)
18
using IKVM.Reflection;
19
using IKVM.Reflection.Emit;
21
using System.Reflection;
22
using System.Reflection.Emit;
25
namespace Mono.CSharp {
28
// Delegate container implementation
30
public class Delegate : TypeContainer, IParametersMember
32
public FullNamedExpression ReturnType;
33
readonly ParametersCompiled parameters;
35
Constructor Constructor;
37
Method BeginInvokeBuilder;
38
Method EndInvokeBuilder;
40
static readonly string[] attribute_targets = new string [] { "type", "return" };
42
public static readonly string InvokeMethodName = "Invoke";
44
Expression instance_expr;
45
ReturnParameter return_attributes;
47
const Modifiers MethodModifiers = Modifiers.PUBLIC | Modifiers.VIRTUAL;
49
const Modifiers AllowedModifiers =
57
public Delegate (NamespaceContainer ns, DeclSpace parent, FullNamedExpression type,
58
Modifiers mod_flags, MemberName name, ParametersCompiled param_list,
60
: base (ns, parent, name, attrs, MemberKind.Delegate)
63
this.ReturnType = type;
64
ModFlags = ModifiersExtensions.Check (AllowedModifiers, mod_flags,
65
IsTopLevel ? Modifiers.INTERNAL :
66
Modifiers.PRIVATE, name.Location, Report);
67
parameters = param_list;
68
spec = new TypeSpec (Kind, null, this, null, ModFlags | Modifiers.SEALED);
72
public TypeSpec MemberType {
74
return ReturnType.Type;
78
public AParametersCollection Parameters {
85
public override void Accept (StructuralVisitor visitor)
90
public override void ApplyAttributeBuilder (Attribute a, MethodSpec ctor, byte[] cdata, PredefinedAttributes pa)
92
if (a.Target == AttributeTargets.ReturnValue) {
93
if (return_attributes == null)
94
return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
96
return_attributes.ApplyAttributeBuilder (a, ctor, cdata, pa);
100
base.ApplyAttributeBuilder (a, ctor, cdata, pa);
103
public override AttributeTargets AttributeTargets {
105
return AttributeTargets.Delegate;
109
protected override bool DoDefineMembers ()
111
var builtin_types = Compiler.BuiltinTypes;
113
var ctor_parameters = ParametersCompiled.CreateFullyResolved (
115
new Parameter (new TypeExpression (builtin_types.Object, Location), "object", Parameter.Modifier.NONE, null, Location),
116
new Parameter (new TypeExpression (builtin_types.IntPtr, Location), "method", Parameter.Modifier.NONE, null, Location)
119
builtin_types.Object,
124
Constructor = new Constructor (this, Constructor.ConstructorName,
125
Modifiers.PUBLIC, null, ctor_parameters, null, Location);
126
Constructor.Define ();
129
// Here the various methods like Invoke, BeginInvoke etc are defined
131
// First, call the `out of band' special method for
132
// defining recursively any types we need:
136
if (!p.Resolve (this))
143
// Check accessibility
144
foreach (var partype in p.Types) {
145
if (!IsAccessibleAs (partype)) {
146
Report.SymbolRelatedToPreviousError (partype);
147
Report.Error (59, Location,
148
"Inconsistent accessibility: parameter type `{0}' is less accessible than delegate `{1}'",
149
TypeManager.CSharpName (partype), GetSignatureForError ());
153
var ret_type = ReturnType.ResolveAsType (this);
154
if (ret_type == null)
158
// We don't have to check any others because they are all
159
// guaranteed to be accessible - they are standard types.
161
if (!IsAccessibleAs (ret_type)) {
162
Report.SymbolRelatedToPreviousError (ret_type);
163
Report.Error (58, Location,
164
"Inconsistent accessibility: return type `" +
165
TypeManager.CSharpName (ret_type) + "' is less " +
166
"accessible than delegate `" + GetSignatureForError () + "'");
170
CheckProtectedModifier ();
172
if (Compiler.Settings.StdLib && ret_type.IsSpecialRuntimeType) {
173
Method.Error1599 (Location, ret_type, Report);
177
TypeManager.CheckTypeVariance (ret_type, Variance.Covariant, this);
179
InvokeBuilder = new Method (this, null, ReturnType, MethodModifiers, new MemberName (InvokeMethodName), p, null);
180
InvokeBuilder.Define ();
183
// Don't emit async method for compiler generated delegates (e.g. dynamic site containers)
185
if (!IsCompilerGenerated) {
186
DefineAsyncMethods (Parameters.CallingConvention);
192
void DefineAsyncMethods (CallingConventions cc)
194
var iasync_result = Module.PredefinedTypes.IAsyncResult;
195
var async_callback = Module.PredefinedTypes.AsyncCallback;
198
// It's ok when async types don't exist, the delegate will have Invoke method only
200
if (!iasync_result.Define () || !async_callback.Define ())
206
ParametersCompiled async_parameters;
207
if (Parameters.Count == 0) {
208
async_parameters = ParametersCompiled.EmptyReadOnlyParameters;
210
var compiled = new Parameter[Parameters.Count];
211
for (int i = 0; i < compiled.Length; ++i) {
212
var p = parameters[i];
213
compiled[i] = new Parameter (new TypeExpression (parameters.Types[i], Location),
215
p.ModFlags & (Parameter.Modifier.REF | Parameter.Modifier.OUT),
216
p.OptAttributes == null ? null : p.OptAttributes.Clone (), Location);
219
async_parameters = new ParametersCompiled (compiled);
222
async_parameters = ParametersCompiled.MergeGenerated (Compiler, async_parameters, false,
224
new Parameter (new TypeExpression (async_callback.TypeSpec, Location), "callback", Parameter.Modifier.NONE, null, Location),
225
new Parameter (new TypeExpression (Compiler.BuiltinTypes.Object, Location), "object", Parameter.Modifier.NONE, null, Location)
228
async_callback.TypeSpec,
229
Compiler.BuiltinTypes.Object
233
BeginInvokeBuilder = new Method (this, null,
234
new TypeExpression (iasync_result.TypeSpec, Location), MethodModifiers,
235
new MemberName ("BeginInvoke"), async_parameters, null);
236
BeginInvokeBuilder.Define ();
239
// EndInvoke is a bit more interesting, all the parameters labeled as
240
// out or ref have to be duplicated here.
244
// Define parameters, and count out/ref parameters
246
ParametersCompiled end_parameters;
249
foreach (Parameter p in Parameters.FixedParameters) {
250
if ((p.ModFlags & Parameter.Modifier.ISBYREF) != 0)
254
if (out_params > 0) {
255
Parameter[] end_params = new Parameter[out_params];
258
for (int i = 0; i < Parameters.FixedParameters.Length; ++i) {
259
Parameter p = parameters [i];
260
if ((p.ModFlags & Parameter.Modifier.ISBYREF) == 0)
263
end_params [param++] = new Parameter (new TypeExpression (p.Type, Location),
265
p.ModFlags & (Parameter.Modifier.REF | Parameter.Modifier.OUT),
266
p.OptAttributes == null ? null : p.OptAttributes.Clone (), Location);
269
end_parameters = new ParametersCompiled (end_params);
271
end_parameters = ParametersCompiled.EmptyReadOnlyParameters;
274
end_parameters = ParametersCompiled.MergeGenerated (Compiler, end_parameters, false,
276
new TypeExpression (iasync_result.TypeSpec, Location),
277
"result", Parameter.Modifier.NONE, null, Location),
278
iasync_result.TypeSpec);
281
// Create method, define parameters, register parameters with type system
283
EndInvokeBuilder = new Method (this, null, ReturnType, MethodModifiers, new MemberName ("EndInvoke"), end_parameters, null);
284
EndInvokeBuilder.Define ();
287
public override void DefineConstants ()
289
if (!Parameters.IsEmpty) {
290
parameters.ResolveDefaultValues (this);
294
public override void EmitType ()
296
if (ReturnType.Type != null) {
297
if (ReturnType.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
298
return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
299
Module.PredefinedAttributes.Dynamic.EmitAttribute (return_attributes.Builder);
300
} else if (ReturnType.Type.HasDynamicElement) {
301
return_attributes = new ReturnParameter (this, InvokeBuilder.MethodBuilder, Location);
302
Module.PredefinedAttributes.Dynamic.EmitAttribute (return_attributes.Builder, ReturnType.Type, Location);
305
ConstraintChecker.Check (this, ReturnType.Type, ReturnType.Location);
308
Constructor.ParameterInfo.ApplyAttributes (this, Constructor.ConstructorBuilder);
309
Constructor.ConstructorBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
311
parameters.CheckConstraints (this);
312
parameters.ApplyAttributes (this, InvokeBuilder.MethodBuilder);
313
InvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
315
if (BeginInvokeBuilder != null) {
316
BeginInvokeBuilder.ParameterInfo.ApplyAttributes (this, BeginInvokeBuilder.MethodBuilder);
317
EndInvokeBuilder.ParameterInfo.ApplyAttributes (this, EndInvokeBuilder.MethodBuilder);
319
BeginInvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
320
EndInvokeBuilder.MethodBuilder.SetImplementationFlags (MethodImplAttributes.Runtime);
323
if (OptAttributes != null) {
324
OptAttributes.Emit ();
330
protected override TypeSpec[] ResolveBaseTypes (out FullNamedExpression base_class)
332
base_type = Compiler.BuiltinTypes.MulticastDelegate;
337
protected override TypeAttributes TypeAttr {
339
return ModifiersExtensions.TypeAttr (ModFlags, IsTopLevel) |
340
TypeAttributes.Class | TypeAttributes.Sealed |
345
public override string[] ValidAttributeTargets {
347
return attribute_targets;
352
protected override bool VerifyClsCompliance ()
354
if (!base.VerifyClsCompliance ()) {
358
parameters.VerifyClsCompliance (this);
360
if (!InvokeBuilder.MemberType.IsCLSCompliant ()) {
361
Report.Warning (3002, 1, Location, "Return type of `{0}' is not CLS-compliant",
362
GetSignatureForError ());
368
public static MethodSpec GetConstructor (TypeSpec delType)
370
var ctor = MemberCache.FindMember (delType, MemberFilter.Constructor (null), BindingRestriction.DeclaredOnly);
371
return (MethodSpec) ctor;
375
// Returns the "Invoke" from a delegate type
377
public static MethodSpec GetInvokeMethod (TypeSpec delType)
379
var invoke = MemberCache.FindMember (delType,
380
MemberFilter.Method (InvokeMethodName, 0, null, null),
381
BindingRestriction.DeclaredOnly);
383
return (MethodSpec) invoke;
386
public static AParametersCollection GetParameters (TypeSpec delType)
388
var invoke_mb = GetInvokeMethod (delType);
389
return invoke_mb.Parameters;
393
// 15.2 Delegate compatibility
395
public static bool IsTypeCovariant (ResolveContext rc, TypeSpec a, TypeSpec b)
398
// For each value parameter (a parameter with no ref or out modifier), an
399
// identity conversion or implicit reference conversion exists from the
400
// parameter type in D to the corresponding parameter type in M
405
if (rc.Module.Compiler.Settings.Version == LanguageVersion.ISO_1)
408
if (a.IsGenericParameter && b.IsGenericParameter)
411
return Convert.ImplicitReferenceConversionExists (a, b);
414
public static string FullDelegateDesc (MethodSpec invoke_method)
416
return TypeManager.GetFullNameSignature (invoke_method).Replace (".Invoke", "");
419
public Expression InstanceExpression {
421
return instance_expr;
424
instance_expr = value;
430
// Base class for `NewDelegate' and `ImplicitDelegateCreation'
432
public abstract class DelegateCreation : Expression, OverloadResolver.IErrorHandler
434
protected MethodSpec constructor_method;
435
protected MethodGroupExpr method_group;
437
public static Arguments CreateDelegateMethodArguments (AParametersCollection pd, TypeSpec[] types, Location loc)
439
Arguments delegate_arguments = new Arguments (pd.Count);
440
for (int i = 0; i < pd.Count; ++i) {
441
Argument.AType atype_modifier;
442
switch (pd.FixedParameters [i].ModFlags) {
443
case Parameter.Modifier.REF:
444
atype_modifier = Argument.AType.Ref;
446
case Parameter.Modifier.OUT:
447
atype_modifier = Argument.AType.Out;
454
delegate_arguments.Add (new Argument (new TypeExpression (types [i], loc), atype_modifier));
457
return delegate_arguments;
460
public override Expression CreateExpressionTree (ResolveContext ec)
462
MemberAccess ma = new MemberAccess (new MemberAccess (new QualifiedAliasMember ("global", "System", loc), "Delegate", loc), "CreateDelegate", loc);
464
Arguments args = new Arguments (3);
465
args.Add (new Argument (new TypeOf (type, loc)));
467
if (method_group.InstanceExpression == null)
468
args.Add (new Argument (new NullLiteral (loc)));
470
args.Add (new Argument (method_group.InstanceExpression));
472
args.Add (new Argument (method_group.CreateExpressionTree (ec)));
473
Expression e = new Invocation (ma, args).Resolve (ec);
477
e = Convert.ExplicitConversion (ec, e, type, loc);
481
return e.CreateExpressionTree (ec);
484
protected override Expression DoResolve (ResolveContext ec)
486
constructor_method = Delegate.GetConstructor (type);
488
var invoke_method = Delegate.GetInvokeMethod (type);
490
Arguments arguments = CreateDelegateMethodArguments (invoke_method.Parameters, invoke_method.Parameters.Types, loc);
491
method_group = method_group.OverloadResolve (ec, ref arguments, this, OverloadResolver.Restrictions.CovariantDelegate);
492
if (method_group == null)
495
var delegate_method = method_group.BestCandidate;
497
if (delegate_method.DeclaringType.IsNullableType) {
498
ec.Report.Error (1728, loc, "Cannot create delegate from method `{0}' because it is a member of System.Nullable<T> type",
499
delegate_method.GetSignatureForError ());
503
Invocation.IsSpecialMethodInvocation (ec, delegate_method, loc);
505
ExtensionMethodGroupExpr emg = method_group as ExtensionMethodGroupExpr;
507
method_group.InstanceExpression = emg.ExtensionExpression;
508
TypeSpec e_type = emg.ExtensionExpression.Type;
509
if (TypeSpec.IsValueType (e_type)) {
510
ec.Report.Error (1113, loc, "Extension method `{0}' of value type `{1}' cannot be used to create delegates",
511
delegate_method.GetSignatureForError (), TypeManager.CSharpName (e_type));
515
TypeSpec rt = delegate_method.ReturnType;
516
if (!Delegate.IsTypeCovariant (ec, rt, invoke_method.ReturnType)) {
517
Expression ret_expr = new TypeExpression (rt, loc);
518
Error_ConversionFailed (ec, delegate_method, ret_expr);
521
if (delegate_method.IsConditionallyExcluded (ec.Module.Compiler, loc)) {
522
ec.Report.SymbolRelatedToPreviousError (delegate_method);
523
MethodOrOperator m = delegate_method.MemberDefinition as MethodOrOperator;
524
if (m != null && m.IsPartialDefinition) {
525
ec.Report.Error (762, loc, "Cannot create delegate from partial method declaration `{0}'",
526
delegate_method.GetSignatureForError ());
528
ec.Report.Error (1618, loc, "Cannot create delegate with `{0}' because it has a Conditional attribute",
529
TypeManager.CSharpSignature (delegate_method));
533
var expr = method_group.InstanceExpression;
534
if (expr != null && (expr.Type.IsGenericParameter || !TypeSpec.IsReferenceType (expr.Type)))
535
method_group.InstanceExpression = new BoxedCast (expr, ec.BuiltinTypes.Object);
537
eclass = ExprClass.Value;
541
public override void Emit (EmitContext ec)
543
if (method_group.InstanceExpression == null)
544
ec.Emit (OpCodes.Ldnull);
546
method_group.InstanceExpression.Emit (ec);
548
var delegate_method = method_group.BestCandidate;
550
// Any delegate must be sealed
551
if (!delegate_method.DeclaringType.IsDelegate && delegate_method.IsVirtual && !method_group.IsBase) {
552
ec.Emit (OpCodes.Dup);
553
ec.Emit (OpCodes.Ldvirtftn, delegate_method);
555
ec.Emit (OpCodes.Ldftn, delegate_method);
558
ec.Emit (OpCodes.Newobj, constructor_method);
561
void Error_ConversionFailed (ResolveContext ec, MethodSpec method, Expression return_type)
563
var invoke_method = Delegate.GetInvokeMethod (type);
564
string member_name = method_group.InstanceExpression != null ?
565
Delegate.FullDelegateDesc (method) :
566
TypeManager.GetFullNameSignature (method);
568
ec.Report.SymbolRelatedToPreviousError (type);
569
ec.Report.SymbolRelatedToPreviousError (method);
570
if (ec.Module.Compiler.Settings.Version == LanguageVersion.ISO_1) {
571
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",
572
TypeManager.CSharpName (method.ReturnType), member_name,
573
TypeManager.CSharpName (invoke_method.ReturnType), Delegate.FullDelegateDesc (invoke_method));
577
if (return_type == null) {
578
ec.Report.Error (123, loc, "A method or delegate `{0}' parameters do not match delegate `{1}' parameters",
579
member_name, Delegate.FullDelegateDesc (invoke_method));
583
ec.Report.Error (407, loc, "A method or delegate `{0} {1}' return type does not match delegate `{2} {3}' return type",
584
return_type.GetSignatureForError (), member_name,
585
TypeManager.CSharpName (invoke_method.ReturnType), Delegate.FullDelegateDesc (invoke_method));
588
public static bool ImplicitStandardConversionExists (ResolveContext ec, MethodGroupExpr mg, TypeSpec target_type)
590
// if (target_type == TypeManager.delegate_type || target_type == TypeManager.multicast_delegate_type)
593
var invoke = Delegate.GetInvokeMethod (target_type);
595
Arguments arguments = CreateDelegateMethodArguments (invoke.Parameters, invoke.Parameters.Types, mg.Location);
596
return mg.OverloadResolve (ec, ref arguments, null, OverloadResolver.Restrictions.CovariantDelegate | OverloadResolver.Restrictions.ProbingOnly) != null;
599
#region IErrorHandler Members
601
bool OverloadResolver.IErrorHandler.AmbiguousCandidates (ResolveContext ec, MemberSpec best, MemberSpec ambiguous)
606
bool OverloadResolver.IErrorHandler.ArgumentMismatch (ResolveContext rc, MemberSpec best, Argument arg, int index)
608
Error_ConversionFailed (rc, best as MethodSpec, null);
612
bool OverloadResolver.IErrorHandler.NoArgumentMatch (ResolveContext rc, MemberSpec best)
614
Error_ConversionFailed (rc, best as MethodSpec, null);
618
bool OverloadResolver.IErrorHandler.TypeInferenceFailed (ResolveContext rc, MemberSpec best)
627
// Created from the conversion code
629
public class ImplicitDelegateCreation : DelegateCreation
631
ImplicitDelegateCreation (TypeSpec t, MethodGroupExpr mg, Location l)
634
this.method_group = mg;
638
static public Expression Create (ResolveContext ec, MethodGroupExpr mge,
639
TypeSpec target_type, Location loc)
641
ImplicitDelegateCreation d = new ImplicitDelegateCreation (target_type, mge, loc);
642
return d.DoResolve (ec);
647
// A delegate-creation-expression, invoked from the `New' class
649
public class NewDelegate : DelegateCreation
651
public Arguments Arguments;
654
// This constructor is invoked from the `New' expression
656
public NewDelegate (TypeSpec type, Arguments Arguments, Location loc)
659
this.Arguments = Arguments;
663
protected override Expression DoResolve (ResolveContext ec)
665
if (Arguments == null || Arguments.Count != 1) {
666
ec.Report.Error (149, loc, "Method name expected");
670
Argument a = Arguments [0];
671
if (!a.ResolveMethodGroup (ec))
674
Expression e = a.Expr;
676
AnonymousMethodExpression ame = e as AnonymousMethodExpression;
677
if (ame != null && ec.Module.Compiler.Settings.Version != LanguageVersion.ISO_1) {
678
e = ame.Compatible (ec, type);
682
return e.Resolve (ec);
685
method_group = e as MethodGroupExpr;
686
if (method_group == null) {
687
if (e.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
688
e = Convert.ImplicitConversionRequired (ec, e, type, loc);
689
} else if (!e.Type.IsDelegate) {
690
e.Error_UnexpectedKind (ec, ResolveFlags.MethodGroup | ResolveFlags.Type, loc);
695
// An argument is not a method but another delegate
697
method_group = new MethodGroupExpr (Delegate.GetInvokeMethod (e.Type), e.Type, loc);
698
method_group.InstanceExpression = e;
701
return base.DoResolve (ec);
706
// Invocation converted to delegate Invoke call
708
class DelegateInvocation : ExpressionStatement
710
readonly Expression InstanceExpr;
714
public DelegateInvocation (Expression instance_expr, Arguments args, Location loc)
716
this.InstanceExpr = instance_expr;
717
this.arguments = args;
721
public override Expression CreateExpressionTree (ResolveContext ec)
723
Arguments args = Arguments.CreateForExpressionTree (ec, this.arguments,
724
InstanceExpr.CreateExpressionTree (ec));
726
return CreateExpressionFactoryCall (ec, "Invoke", args);
729
protected override Expression DoResolve (ResolveContext ec)
731
TypeSpec del_type = InstanceExpr.Type;
732
if (del_type == null)
736
// Do only core overload resolution the rest of the checks has been
737
// done on primary expression
739
method = Delegate.GetInvokeMethod (del_type);
740
var res = new OverloadResolver (new MemberSpec[] { method }, OverloadResolver.Restrictions.DelegateInvoke, loc);
741
var valid = res.ResolveMember<MethodSpec> (ec, ref arguments);
742
if (valid == null && !res.BestCandidateIsDynamic)
745
type = method.ReturnType;
746
eclass = ExprClass.Value;
750
public override void Emit (EmitContext ec)
753
// Invocation on delegates call the virtual Invoke member
754
// so we are always `instance' calls
756
Invocation.EmitCall (ec, InstanceExpr, method, arguments, loc);
759
public override void EmitStatement (EmitContext ec)
763
// Pop the return value if there is one
765
if (type.Kind != MemberKind.Void)
766
ec.Emit (OpCodes.Pop);
769
public override System.Linq.Expressions.Expression MakeExpression (BuilderContext ctx)
771
return Invocation.MakeExpression (ctx, InstanceExpr, method, arguments);