2 // assign.cs: Assignments.
5 // Miguel de Icaza (miguel@ximian.com)
6 // Martin Baulig (martin@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, 2002, 2003 Ximian, Inc.
12 // Copyright 2004-2008 Novell, Inc
13 // Copyright 2011 Xamarin Inc
18 using IKVM.Reflection.Emit;
20 using System.Reflection.Emit;
23 namespace Mono.CSharp {
26 /// This interface is implemented by expressions that can be assigned to.
29 /// This interface is implemented by Expressions whose values can not
30 /// store the result on the top of the stack.
32 /// Expressions implementing this (Properties, Indexers and Arrays) would
33 /// perform an assignment of the Expression "source" into its final
36 /// No values on the top of the stack are expected to be left by
37 /// invoking this method.
39 public interface IAssignMethod {
41 // This is an extra version of Emit. If leave_copy is `true'
42 // A copy of the expression will be left on the stack at the
43 // end of the code generated for EmitAssign
45 void Emit (EmitContext ec, bool leave_copy);
48 // This method does the assignment
49 // `source' will be stored into the location specified by `this'
50 // if `leave_copy' is true, a copy of `source' will be left on the stack
51 // if `prepare_for_load' is true, when `source' is emitted, there will
52 // be data on the stack that it can use to compuatate its value. This is
53 // for expressions like a [f ()] ++, where you can't call `f ()' twice.
55 void EmitAssign (EmitContext ec, Expression source, bool leave_copy, bool isCompound);
58 For simple assignments, this interface is very simple, EmitAssign is called with source
59 as the source expression and leave_copy and prepare_for_load false.
61 For compound assignments it gets complicated.
63 EmitAssign will be called as before, however, prepare_for_load will be
64 true. The @source expression will contain an expression
65 which calls Emit. So, the calls look like:
67 this.EmitAssign (ec, source, false, true) ->
70 this.Emit (ec, false); ->
71 end this.Emit (ec, false); ->
74 end this.EmitAssign (ec, source, false, true)
77 When prepare_for_load is true, EmitAssign emits a `token' on the stack that
78 Emit will use for its state.
80 Let's take FieldExpr as an example. assume we are emitting f ().y += 1;
82 Here is the call tree again. This time, each call is annotated with the IL
85 this.EmitAssign (ec, source, false, true)
90 this.Emit (ec, false);
92 end this.Emit (ec, false);
102 end this.EmitAssign (ec, source, false, true)
105 1) EmitAssign left a token on the stack. It was the result of f ().
106 2) This token was used by Emit
108 leave_copy (in both EmitAssign and Emit) tells the compiler to leave a copy
109 of the expression at that point in evaluation. This is used for pre/post inc/dec
110 and for a = x += y. Let's do the above example with leave_copy true in EmitAssign
112 this.EmitAssign (ec, source, true, true)
117 this.Emit (ec, false);
119 end this.Emit (ec, false);
132 end this.EmitAssign (ec, source, true, true)
134 And with it true in Emit
136 this.EmitAssign (ec, source, false, true)
141 this.Emit (ec, true);
145 end this.Emit (ec, true);
156 end this.EmitAssign (ec, source, false, true)
158 Note that these two examples are what happens for ++x and x++, respectively.
163 /// An Expression to hold a temporary value.
166 /// The LocalTemporary class is used to hold temporary values of a given
167 /// type to "simulate" the expression semantics. The local variable is
170 /// The local temporary is used to alter the normal flow of code generation
171 /// basically it creates a local variable, and its emit instruction generates
172 /// code to access this value, return its address or save its value.
174 /// If `is_address' is true, then the value that we store is the address to the
175 /// real value, and not the value itself.
177 /// This is needed for a value type, because otherwise you just end up making a
178 /// copy of the value on the stack and modifying it. You really need a pointer
179 /// to the origional value so that you can modify it in that location. This
180 /// Does not happen with a class because a class is a pointer -- so you always
181 /// get the indirection.
184 public class LocalTemporary : Expression, IMemoryLocation, IAssignMethod {
185 LocalBuilder builder;
187 public LocalTemporary (TypeSpec t)
190 eclass = ExprClass.Value;
193 public LocalTemporary (LocalBuilder b, TypeSpec t)
199 public void Release (EmitContext ec)
201 ec.FreeTemporaryLocal (builder, type);
205 public override bool ContainsEmitWithAwait ()
210 public override Expression CreateExpressionTree (ResolveContext ec)
212 Arguments args = new Arguments (1);
213 args.Add (new Argument (this));
214 return CreateExpressionFactoryCall (ec, "Constant", args);
217 protected override Expression DoResolve (ResolveContext ec)
222 public override Expression DoResolveLValue (ResolveContext ec, Expression right_side)
227 public override void Emit (EmitContext ec)
230 throw new InternalErrorException ("Emit without Store, or after Release");
232 ec.Emit (OpCodes.Ldloc, builder);
235 #region IAssignMethod Members
237 public void Emit (EmitContext ec, bool leave_copy)
245 public void EmitAssign (EmitContext ec, Expression source, bool leave_copy, bool isCompound)
248 throw new NotImplementedException ();
260 public LocalBuilder Builder {
261 get { return builder; }
264 public void Store (EmitContext ec)
267 builder = ec.GetTemporaryLocal (type);
269 ec.Emit (OpCodes.Stloc, builder);
272 public void AddressOf (EmitContext ec, AddressOp mode)
275 builder = ec.GetTemporaryLocal (type);
277 if (builder.LocalType.IsByRef) {
279 // if is_address, than this is just the address anyways,
280 // so we just return this.
282 ec.Emit (OpCodes.Ldloc, builder);
284 ec.Emit (OpCodes.Ldloca, builder);
290 /// The Assign node takes care of assigning the value of source into
291 /// the expression represented by target.
293 public abstract class Assign : ExpressionStatement {
294 protected Expression target, source;
296 protected Assign (Expression target, Expression source, Location loc)
298 this.target = target;
299 this.source = source;
303 public Expression Target {
304 get { return target; }
307 public Expression Source {
313 public override bool ContainsEmitWithAwait ()
315 return target.ContainsEmitWithAwait () || source.ContainsEmitWithAwait ();
318 public override Expression CreateExpressionTree (ResolveContext ec)
320 ec.Report.Error (832, loc, "An expression tree cannot contain an assignment operator");
324 protected override Expression DoResolve (ResolveContext ec)
327 source = source.Resolve (ec);
329 if (source == null) {
331 source = EmptyExpression.Null;
334 target = target.ResolveLValue (ec, source);
336 if (target == null || !ok)
339 TypeSpec target_type = target.Type;
340 TypeSpec source_type = source.Type;
342 eclass = ExprClass.Value;
345 if (!(target is IAssignMethod)) {
346 Error_ValueAssignment (ec, source);
350 if (target_type != source_type) {
351 Expression resolved = ResolveConversions (ec);
353 if (resolved != this)
360 #if NET_4_0 || MONODROID
361 public override System.Linq.Expressions.Expression MakeExpression (BuilderContext ctx)
363 var tassign = target as IDynamicAssign;
365 throw new InternalErrorException (target.GetType () + " does not support dynamic assignment");
367 var target_object = tassign.MakeAssignExpression (ctx, source);
370 // Some hacking is needed as DLR does not support void type and requires
371 // always have object convertible return type to support caching and chaining
373 // We do this by introducing an explicit block which returns RHS value when
376 if (target_object.NodeType == System.Linq.Expressions.ExpressionType.Block)
377 return target_object;
379 System.Linq.Expressions.UnaryExpression source_object;
380 if (ctx.HasSet (BuilderContext.Options.CheckedScope)) {
381 source_object = System.Linq.Expressions.Expression.ConvertChecked (source.MakeExpression (ctx), target_object.Type);
383 source_object = System.Linq.Expressions.Expression.Convert (source.MakeExpression (ctx), target_object.Type);
386 return System.Linq.Expressions.Expression.Assign (target_object, source_object);
389 protected virtual Expression ResolveConversions (ResolveContext ec)
391 source = Convert.ImplicitConversionRequired (ec, source, target.Type, source.Location);
398 void Emit (EmitContext ec, bool is_statement)
400 IAssignMethod t = (IAssignMethod) target;
401 t.EmitAssign (ec, source, !is_statement, this is CompoundAssign);
404 public override void Emit (EmitContext ec)
409 public override void EmitStatement (EmitContext ec)
414 protected override void CloneTo (CloneContext clonectx, Expression t)
416 Assign _target = (Assign) t;
418 _target.target = target.Clone (clonectx);
419 _target.source = source.Clone (clonectx);
422 public override object Accept (StructuralVisitor visitor)
424 return visitor.Visit (this);
428 public class SimpleAssign : Assign
430 public SimpleAssign (Expression target, Expression source)
431 : this (target, source, target.Location)
435 public SimpleAssign (Expression target, Expression source, Location loc)
436 : base (target, source, loc)
440 bool CheckEqualAssign (Expression t)
442 if (source is Assign) {
443 Assign a = (Assign) source;
444 if (t.Equals (a.Target))
446 return a is SimpleAssign && ((SimpleAssign) a).CheckEqualAssign (t);
448 return t.Equals (source);
451 protected override Expression DoResolve (ResolveContext ec)
453 Expression e = base.DoResolve (ec);
454 if (e == null || e != this)
457 if (CheckEqualAssign (target))
458 ec.Report.Warning (1717, 3, loc, "Assignment made to same variable; did you mean to assign something else?");
464 public class RuntimeExplicitAssign : Assign
466 public RuntimeExplicitAssign (Expression target, Expression source)
467 : base (target, source, target.Location)
471 protected override Expression ResolveConversions (ResolveContext ec)
473 source = EmptyCast.Create (source, target.Type);
479 // Compiler generated assign
481 class CompilerAssign : Assign
483 public CompilerAssign (Expression target, Expression source, Location loc)
484 : base (target, source, loc)
486 if (target.Type != null) {
488 eclass = ExprClass.Value;
492 protected override Expression DoResolve (ResolveContext ec)
494 var expr = base.DoResolve (ec);
495 var vr = target as VariableReference;
496 if (vr != null && vr.VariableInfo != null)
497 vr.VariableInfo.IsEverAssigned = false;
502 public void UpdateSource (Expression source)
504 base.source = source;
509 // Implements fields and events class initializers
511 public class FieldInitializer : Assign
514 // Field initializers are tricky for partial classes. They have to
515 // share same constructor (block) for expression trees resolve but
516 // they have they own resolve scope
518 sealed class FieldInitializerContext : ResolveContext
520 ExplicitBlock ctor_block;
522 public FieldInitializerContext (IMemberContext mc, ResolveContext constructorContext)
523 : base (mc, Options.FieldInitializerScope | Options.ConstructorScope)
525 this.ctor_block = constructorContext.CurrentBlock.Explicit;
528 public override ExplicitBlock ConstructorBlock {
536 // Keep resolved value because field initializers have their own rules
538 ExpressionStatement resolved;
541 public FieldInitializer (FieldSpec spec, Expression expression, IMemberContext mc)
542 : base (new FieldExpr (spec, expression.Location), expression, expression.Location)
546 ((FieldExpr)target).InstanceExpression = new CompilerGeneratedThis (mc.CurrentType, expression.Location);
549 protected override Expression DoResolve (ResolveContext ec)
551 // Field initializer can be resolved (fail) many times
555 if (resolved == null) {
556 var ctx = new FieldInitializerContext (mc, ec);
557 resolved = base.DoResolve (ctx) as ExpressionStatement;
563 public override void EmitStatement (EmitContext ec)
565 if (resolved == null)
569 // Emit sequence symbol info even if we are in compiler generated
570 // block to allow debugging filed initializers when constructor is
571 // compiler generated
573 if (ec.HasSet (BuilderContext.Options.OmitDebugInfo)) {
574 using (ec.With (BuilderContext.Options.OmitDebugInfo, false)) {
579 if (resolved != this)
580 resolved.EmitStatement (ec);
582 base.EmitStatement (ec);
585 public bool IsDefaultInitializer {
587 Constant c = source as Constant;
591 FieldExpr fe = (FieldExpr)target;
592 return c.IsDefaultInitializer (fe.Type);
596 public override bool IsSideEffectFree {
598 return source.IsSideEffectFree;
604 // This class is used for compound assignments.
606 public class CompoundAssign : Assign
608 // This is just a hack implemented for arrays only
609 public sealed class TargetExpression : Expression
611 readonly Expression child;
613 public TargetExpression (Expression child)
616 this.loc = child.Location;
619 public override bool ContainsEmitWithAwait ()
621 return child.ContainsEmitWithAwait ();
624 public override Expression CreateExpressionTree (ResolveContext ec)
626 throw new NotSupportedException ("ET");
629 protected override Expression DoResolve (ResolveContext ec)
632 eclass = ExprClass.Value;
636 public override void Emit (EmitContext ec)
641 public override Expression EmitToField (EmitContext ec)
643 return child.EmitToField (ec);
647 // Used for underlying binary operator
648 readonly Binary.Operator op;
652 public CompoundAssign (Binary.Operator op, Expression target, Expression source, Location loc)
653 : base (target, source, loc)
659 public CompoundAssign (Binary.Operator op, Expression target, Expression source, Expression left, Location loc)
660 : this (op, target, source, loc)
665 public Binary.Operator Operator {
671 protected override Expression DoResolve (ResolveContext ec)
673 right = right.Resolve (ec);
677 MemberAccess ma = target as MemberAccess;
678 using (ec.Set (ResolveContext.Options.CompoundAssignmentScope)) {
679 target = target.Resolve (ec);
685 if (target is MethodGroupExpr){
686 ec.Report.Error (1656, loc,
687 "Cannot assign to `{0}' because it is a `{1}'",
688 ((MethodGroupExpr)target).Name, target.ExprClassName);
692 var event_expr = target as EventExpr;
693 if (event_expr != null) {
694 source = Convert.ImplicitConversionRequired (ec, right, target.Type, loc);
699 if (op == Binary.Operator.Addition)
700 rside = EmptyExpression.EventAddition;
701 else if (op == Binary.Operator.Subtraction)
702 rside = EmptyExpression.EventSubtraction;
706 target = target.ResolveLValue (ec, rside);
710 eclass = ExprClass.Value;
711 type = event_expr.Operator.ReturnType;
716 // Only now we can decouple the original source/target
717 // into a tree, to guarantee that we do not have side
721 left = new TargetExpression (target);
723 source = new Binary (op, left, right, true, loc);
725 if (target is DynamicMemberAssignable) {
726 Arguments targs = ((DynamicMemberAssignable) target).Arguments;
727 source = source.Resolve (ec);
729 Arguments args = new Arguments (targs.Count + 1);
730 args.AddRange (targs);
731 args.Add (new Argument (source));
733 var binder_flags = CSharpBinderFlags.ValueFromCompoundAssignment;
736 // Compound assignment does target conversion using additional method
737 // call, set checked context as the binary operation can overflow
739 if (ec.HasSet (ResolveContext.Options.CheckedScope))
740 binder_flags |= CSharpBinderFlags.CheckedContext;
742 if (target is DynamicMemberBinder) {
743 source = new DynamicMemberBinder (ma.Name, binder_flags, args, loc).Resolve (ec);
745 // Handles possible event addition/subtraction
746 if (op == Binary.Operator.Addition || op == Binary.Operator.Subtraction) {
747 args = new Arguments (targs.Count + 1);
748 args.AddRange (targs);
749 args.Add (new Argument (right));
750 string method_prefix = op == Binary.Operator.Addition ?
751 Event.AEventAccessor.AddPrefix : Event.AEventAccessor.RemovePrefix;
753 var invoke = DynamicInvocation.CreateSpecialNameInvoke (
754 new MemberAccess (right, method_prefix + ma.Name, loc), args, loc).Resolve (ec);
756 args = new Arguments (targs.Count);
757 args.AddRange (targs);
758 source = new DynamicEventCompoundAssign (ma.Name, args,
759 (ExpressionStatement) source, (ExpressionStatement) invoke, loc).Resolve (ec);
762 source = new DynamicIndexBinder (binder_flags, args, loc).Resolve (ec);
768 return base.DoResolve (ec);
771 protected override Expression ResolveConversions (ResolveContext ec)
774 // LAMESPEC: Under dynamic context no target conversion is happening
775 // This allows more natual dynamic behaviour but breaks compatibility
776 // with static binding
778 if (target is RuntimeValueExpression)
781 TypeSpec target_type = target.Type;
784 // 1. the return type is implicitly convertible to the type of target
786 if (Convert.ImplicitConversionExists (ec, source, target_type)) {
787 source = Convert.ImplicitConversion (ec, source, target_type, loc);
792 // Otherwise, if the selected operator is a predefined operator
794 Binary b = source as Binary;
795 if (b == null && source is ReducedExpression)
796 b = ((ReducedExpression) source).OriginalExpression as Binary;
800 // 2a. the operator is a shift operator
802 // 2b. the return type is explicitly convertible to the type of x, and
803 // y is implicitly convertible to the type of x
805 if ((b.Oper & Binary.Operator.ShiftMask) != 0 ||
806 Convert.ImplicitConversionExists (ec, right, target_type)) {
807 source = Convert.ExplicitConversion (ec, source, target_type, loc);
812 if (source.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
813 Arguments arg = new Arguments (1);
814 arg.Add (new Argument (source));
815 return new SimpleAssign (target, new DynamicConversion (target_type, CSharpBinderFlags.ConvertExplicit, arg, loc), loc).Resolve (ec);
818 right.Error_ValueCannotBeConverted (ec, loc, target_type, false);
822 protected override void CloneTo (CloneContext clonectx, Expression t)
824 CompoundAssign ctarget = (CompoundAssign) t;
826 ctarget.right = ctarget.source = source.Clone (clonectx);
827 ctarget.target = target.Clone (clonectx);
830 public override object Accept (StructuralVisitor visitor)
832 return visitor.Visit (this);