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 Location StartLocation {
315 return target.StartLocation;
319 public override bool ContainsEmitWithAwait ()
321 return target.ContainsEmitWithAwait () || source.ContainsEmitWithAwait ();
324 public override Expression CreateExpressionTree (ResolveContext ec)
326 ec.Report.Error (832, loc, "An expression tree cannot contain an assignment operator");
330 protected override Expression DoResolve (ResolveContext ec)
333 source = source.Resolve (ec);
335 if (source == null) {
337 source = ErrorExpression.Instance;
340 target = target.ResolveLValue (ec, source);
342 if (target == null || !ok)
345 TypeSpec target_type = target.Type;
346 TypeSpec source_type = source.Type;
348 eclass = ExprClass.Value;
351 if (!(target is IAssignMethod)) {
352 target.Error_ValueAssignment (ec, source);
356 if (target_type != source_type) {
357 Expression resolved = ResolveConversions (ec);
359 if (resolved != this)
366 public override System.Linq.Expressions.Expression MakeExpression (BuilderContext ctx)
368 var tassign = target as IDynamicAssign;
370 throw new InternalErrorException (target.GetType () + " does not support dynamic assignment");
372 var target_object = tassign.MakeAssignExpression (ctx, source);
375 // Some hacking is needed as DLR does not support void type and requires
376 // always have object convertible return type to support caching and chaining
378 // We do this by introducing an explicit block which returns RHS value when
381 if (target_object.NodeType == System.Linq.Expressions.ExpressionType.Block)
382 return target_object;
384 System.Linq.Expressions.UnaryExpression source_object;
385 if (ctx.HasSet (BuilderContext.Options.CheckedScope)) {
386 source_object = System.Linq.Expressions.Expression.ConvertChecked (source.MakeExpression (ctx), target_object.Type);
388 source_object = System.Linq.Expressions.Expression.Convert (source.MakeExpression (ctx), target_object.Type);
391 return System.Linq.Expressions.Expression.Assign (target_object, source_object);
394 protected virtual Expression ResolveConversions (ResolveContext ec)
396 source = Convert.ImplicitConversionRequired (ec, source, target.Type, source.Location);
403 void Emit (EmitContext ec, bool is_statement)
405 IAssignMethod t = (IAssignMethod) target;
406 t.EmitAssign (ec, source, !is_statement, this is CompoundAssign);
409 public override void Emit (EmitContext ec)
414 public override void EmitStatement (EmitContext ec)
419 public override void FlowAnalysis (FlowAnalysisContext fc)
421 source.FlowAnalysis (fc);
423 if (target is ArrayAccess || target is IndexerExpr) {
424 target.FlowAnalysis (fc);
428 var pe = target as PropertyExpr;
429 if (pe != null && !pe.IsAutoPropertyAccess)
430 target.FlowAnalysis (fc);
433 protected override void CloneTo (CloneContext clonectx, Expression t)
435 Assign _target = (Assign) t;
437 _target.target = target.Clone (clonectx);
438 _target.source = source.Clone (clonectx);
441 public override object Accept (StructuralVisitor visitor)
443 return visitor.Visit (this);
447 public class SimpleAssign : Assign
449 public SimpleAssign (Expression target, Expression source)
450 : this (target, source, target.Location)
454 public SimpleAssign (Expression target, Expression source, Location loc)
455 : base (target, source, loc)
459 bool CheckEqualAssign (Expression t)
461 if (source is Assign) {
462 Assign a = (Assign) source;
463 if (t.Equals (a.Target))
465 return a is SimpleAssign && ((SimpleAssign) a).CheckEqualAssign (t);
467 return t.Equals (source);
470 protected override Expression DoResolve (ResolveContext ec)
472 Expression e = base.DoResolve (ec);
473 if (e == null || e != this)
476 if (CheckEqualAssign (target))
477 ec.Report.Warning (1717, 3, loc, "Assignment made to same variable; did you mean to assign something else?");
482 public override void FlowAnalysis (FlowAnalysisContext fc)
484 base.FlowAnalysis (fc);
486 var vr = target as VariableReference;
488 if (vr.VariableInfo != null)
489 fc.SetVariableAssigned (vr.VariableInfo);
494 var fe = target as FieldExpr;
496 fe.SetFieldAssigned (fc);
500 var pe = target as PropertyExpr;
502 pe.SetBackingFieldAssigned (fc);
506 var td = target as TupleDeconstruct;
508 td.SetGeneratedFieldAssigned (fc);
513 public override Reachability MarkReachable (Reachability rc)
515 return source.MarkReachable (rc);
519 public class RuntimeExplicitAssign : Assign
521 public RuntimeExplicitAssign (Expression target, Expression source)
522 : base (target, source, target.Location)
526 protected override Expression ResolveConversions (ResolveContext ec)
528 source = EmptyCast.Create (source, target.Type);
534 // Compiler generated assign
536 class CompilerAssign : Assign
538 public CompilerAssign (Expression target, Expression source, Location loc)
539 : base (target, source, loc)
541 if (target.Type != null) {
543 eclass = ExprClass.Value;
547 protected override Expression DoResolve (ResolveContext ec)
549 var expr = base.DoResolve (ec);
550 var vr = target as VariableReference;
551 if (vr != null && vr.VariableInfo != null)
552 vr.VariableInfo.IsEverAssigned = false;
557 public void UpdateSource (Expression source)
559 base.source = source;
564 // Implements fields and events class initializers
566 public class FieldInitializer : Assign
569 // Field initializers are tricky for partial classes. They have to
570 // share same constructor (block) for expression trees resolve but
571 // they have they own resolve scope
573 sealed class FieldInitializerContext : BlockContext
575 readonly ExplicitBlock ctor_block;
577 public FieldInitializerContext (IMemberContext mc, BlockContext constructorContext)
578 : base (mc, null, constructorContext.ReturnType)
580 flags |= Options.FieldInitializerScope | Options.ConstructorScope;
581 this.ctor_block = constructorContext.CurrentBlock.Explicit;
583 if (ctor_block.IsCompilerGenerated)
584 CurrentBlock = ctor_block;
587 public override ExplicitBlock ConstructorBlock {
595 // Keep resolved value because field initializers have their own rules
597 ExpressionStatement resolved;
600 public FieldInitializer (FieldBase mc, Expression expression, Location loc)
601 : base (new FieldExpr (mc.Spec, expression.Location), expression, loc)
605 ((FieldExpr)target).InstanceExpression = new CompilerGeneratedThis (mc.CurrentType, expression.Location);
608 public int AssignmentOffset { get; private set; }
610 public FieldBase Field {
616 public override Location StartLocation {
622 protected override Expression DoResolve (ResolveContext rc)
624 // Field initializer can be resolved (fail) many times
628 if (resolved == null) {
629 var bc = (BlockContext) rc;
630 var ctx = new FieldInitializerContext (mc, bc);
631 resolved = base.DoResolve (ctx) as ExpressionStatement;
632 AssignmentOffset = ctx.AssignmentInfoOffset - bc.AssignmentInfoOffset;
638 public override void EmitStatement (EmitContext ec)
640 if (resolved == null)
644 // Emit sequence symbol info even if we are in compiler generated
645 // block to allow debugging field initializers when constructor is
646 // compiler generated
648 if (ec.HasSet (BuilderContext.Options.OmitDebugInfo) && ec.HasMethodSymbolBuilder) {
649 using (ec.With (BuilderContext.Options.OmitDebugInfo, false)) {
654 if (resolved != this)
655 resolved.EmitStatement (ec);
657 base.EmitStatement (ec);
660 public override void FlowAnalysis (FlowAnalysisContext fc)
662 source.FlowAnalysis (fc);
663 ((FieldExpr) target).SetFieldAssigned (fc);
666 public bool IsDefaultInitializer {
668 Constant c = source as Constant;
672 FieldExpr fe = (FieldExpr)target;
673 return c.IsDefaultInitializer (fe.Type);
677 public override bool IsSideEffectFree {
679 return source.IsSideEffectFree;
684 class PrimaryConstructorAssign : SimpleAssign
686 readonly Field field;
687 readonly Parameter parameter;
689 public PrimaryConstructorAssign (Field field, Parameter parameter)
690 : base (null, null, parameter.Location)
693 this.parameter = parameter;
696 protected override Expression DoResolve (ResolveContext rc)
698 target = new FieldExpr (field, loc);
699 source = rc.CurrentBlock.ParametersBlock.GetParameterInfo (parameter).CreateReferenceExpression (rc, loc);
700 return base.DoResolve (rc);
703 public override void EmitStatement (EmitContext ec)
705 using (ec.With (BuilderContext.Options.OmitDebugInfo, true)) {
706 base.EmitStatement (ec);
712 // This class is used for compound assignments.
714 public class CompoundAssign : Assign
716 // This is just a hack implemented for arrays only
717 public sealed class TargetExpression : Expression
719 readonly Expression child;
721 public TargetExpression (Expression child)
724 this.loc = child.Location;
727 public bool RequiresEmitWithAwait { get; set; }
729 public override bool ContainsEmitWithAwait ()
731 return RequiresEmitWithAwait || child.ContainsEmitWithAwait ();
734 public override Expression CreateExpressionTree (ResolveContext ec)
736 throw new NotSupportedException ("ET");
739 protected override Expression DoResolve (ResolveContext ec)
742 eclass = ExprClass.Value;
746 public override void Emit (EmitContext ec)
751 public override Expression EmitToField (EmitContext ec)
753 return child.EmitToField (ec);
757 // Used for underlying binary operator
758 readonly Binary.Operator op;
762 public CompoundAssign (Binary.Operator op, Expression target, Expression source)
763 : base (target, source, target.Location)
769 public CompoundAssign (Binary.Operator op, Expression target, Expression source, Expression left)
770 : this (op, target, source)
775 public Binary.Operator Operator {
781 protected override Expression DoResolve (ResolveContext ec)
783 right = right.Resolve (ec);
787 MemberAccess ma = target as MemberAccess;
788 using (ec.Set (ResolveContext.Options.CompoundAssignmentScope)) {
789 target = target.Resolve (ec);
795 if (target is MethodGroupExpr){
796 ec.Report.Error (1656, loc,
797 "Cannot assign to `{0}' because it is a `{1}'",
798 ((MethodGroupExpr)target).Name, target.ExprClassName);
802 var event_expr = target as EventExpr;
803 if (event_expr != null) {
804 source = Convert.ImplicitConversionRequired (ec, right, target.Type, loc);
809 if (op == Binary.Operator.Addition)
810 rside = EmptyExpression.EventAddition;
811 else if (op == Binary.Operator.Subtraction)
812 rside = EmptyExpression.EventSubtraction;
816 target = target.ResolveLValue (ec, rside);
820 eclass = ExprClass.Value;
821 type = event_expr.Operator.ReturnType;
826 // Only now we can decouple the original source/target
827 // into a tree, to guarantee that we do not have side
831 left = new TargetExpression (target);
833 source = new Binary (op, left, right, true);
835 if (target is DynamicMemberAssignable) {
836 Arguments targs = ((DynamicMemberAssignable) target).Arguments;
837 source = source.Resolve (ec);
839 Arguments args = new Arguments (targs.Count + 1);
840 args.AddRange (targs);
841 args.Add (new Argument (source));
843 var binder_flags = CSharpBinderFlags.ValueFromCompoundAssignment;
846 // Compound assignment does target conversion using additional method
847 // call, set checked context as the binary operation can overflow
849 if (ec.HasSet (ResolveContext.Options.CheckedScope))
850 binder_flags |= CSharpBinderFlags.CheckedContext;
852 if (target is DynamicMemberBinder) {
853 source = new DynamicMemberBinder (ma.Name, binder_flags, args, loc).Resolve (ec);
855 // Handles possible event addition/subtraction
856 if (op == Binary.Operator.Addition || op == Binary.Operator.Subtraction) {
857 args = new Arguments (targs.Count + 1);
858 args.AddRange (targs);
859 args.Add (new Argument (right));
860 string method_prefix = op == Binary.Operator.Addition ?
861 Event.AEventAccessor.AddPrefix : Event.AEventAccessor.RemovePrefix;
863 var invoke = DynamicInvocation.CreateSpecialNameInvoke (
864 new MemberAccess (right, method_prefix + ma.Name, loc), args, loc).Resolve (ec);
866 args = new Arguments (targs.Count);
867 args.AddRange (targs);
868 source = new DynamicEventCompoundAssign (ma.Name, args,
869 (ExpressionStatement) source, (ExpressionStatement) invoke, loc).Resolve (ec);
872 source = new DynamicIndexBinder (binder_flags, args, loc).Resolve (ec);
878 return base.DoResolve (ec);
881 public override void FlowAnalysis (FlowAnalysisContext fc)
883 target.FlowAnalysis (fc);
884 source.FlowAnalysis (fc);
887 protected override Expression ResolveConversions (ResolveContext ec)
890 // LAMESPEC: Under dynamic context no target conversion is happening
891 // This allows more natual dynamic behaviour but breaks compatibility
892 // with static binding
894 if (target is RuntimeValueExpression)
897 TypeSpec target_type = target.Type;
900 // 1. the return type is implicitly convertible to the type of target
902 if (Convert.ImplicitConversionExists (ec, source, target_type)) {
903 source = Convert.ImplicitConversion (ec, source, target_type, loc);
908 // Otherwise, if the selected operator is a predefined operator
910 Binary b = source as Binary;
912 if (source is ReducedExpression)
913 b = ((ReducedExpression) source).OriginalExpression as Binary;
914 else if (source is ReducedExpression.ReducedConstantExpression) {
915 b = ((ReducedExpression.ReducedConstantExpression) source).OriginalExpression as Binary;
916 } else if (source is Nullable.LiftedBinaryOperator) {
917 var po = ((Nullable.LiftedBinaryOperator) source);
918 if (po.UserOperator == null)
920 } else if (source is TypeCast) {
921 b = ((TypeCast) source).Child as Binary;
927 // 2a. the operator is a shift operator
929 // 2b. the return type is explicitly convertible to the type of x, and
930 // y is implicitly convertible to the type of x
932 if ((b.Oper & Binary.Operator.ShiftMask) != 0 ||
933 Convert.ImplicitConversionExists (ec, right, target_type)) {
934 source = Convert.ExplicitConversion (ec, source, target_type, loc);
939 if (source.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
940 Arguments arg = new Arguments (1);
941 arg.Add (new Argument (source));
942 return new SimpleAssign (target, new DynamicConversion (target_type, CSharpBinderFlags.ConvertExplicit, arg, loc), loc).Resolve (ec);
945 right.Error_ValueCannotBeConverted (ec, target_type, false);
949 protected override void CloneTo (CloneContext clonectx, Expression t)
951 CompoundAssign ctarget = (CompoundAssign) t;
953 ctarget.right = ctarget.source = source.Clone (clonectx);
954 ctarget.target = target.Clone (clonectx);
957 public override object Accept (StructuralVisitor visitor)
959 return visitor.Visit (this);