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
17 using IKVM.Reflection.Emit;
19 using System.Reflection.Emit;
22 namespace Mono.CSharp {
25 /// This interface is implemented by expressions that can be assigned to.
28 /// This interface is implemented by Expressions whose values can not
29 /// store the result on the top of the stack.
31 /// Expressions implementing this (Properties, Indexers and Arrays) would
32 /// perform an assignment of the Expression "source" into its final
35 /// No values on the top of the stack are expected to be left by
36 /// invoking this method.
38 public interface IAssignMethod {
40 // This is an extra version of Emit. If leave_copy is `true'
41 // A copy of the expression will be left on the stack at the
42 // end of the code generated for EmitAssign
44 void Emit (EmitContext ec, bool leave_copy);
47 // This method does the assignment
48 // `source' will be stored into the location specified by `this'
49 // if `leave_copy' is true, a copy of `source' will be left on the stack
50 // if `prepare_for_load' is true, when `source' is emitted, there will
51 // be data on the stack that it can use to compuatate its value. This is
52 // for expressions like a [f ()] ++, where you can't call `f ()' twice.
54 void EmitAssign (EmitContext ec, Expression source, bool leave_copy, bool isCompound);
57 For simple assignments, this interface is very simple, EmitAssign is called with source
58 as the source expression and leave_copy and prepare_for_load false.
60 For compound assignments it gets complicated.
62 EmitAssign will be called as before, however, prepare_for_load will be
63 true. The @source expression will contain an expression
64 which calls Emit. So, the calls look like:
66 this.EmitAssign (ec, source, false, true) ->
69 this.Emit (ec, false); ->
70 end this.Emit (ec, false); ->
73 end this.EmitAssign (ec, source, false, true)
76 When prepare_for_load is true, EmitAssign emits a `token' on the stack that
77 Emit will use for its state.
79 Let's take FieldExpr as an example. assume we are emitting f ().y += 1;
81 Here is the call tree again. This time, each call is annotated with the IL
84 this.EmitAssign (ec, source, false, true)
89 this.Emit (ec, false);
91 end this.Emit (ec, false);
101 end this.EmitAssign (ec, source, false, true)
104 1) EmitAssign left a token on the stack. It was the result of f ().
105 2) This token was used by Emit
107 leave_copy (in both EmitAssign and Emit) tells the compiler to leave a copy
108 of the expression at that point in evaluation. This is used for pre/post inc/dec
109 and for a = x += y. Let's do the above example with leave_copy true in EmitAssign
111 this.EmitAssign (ec, source, true, true)
116 this.Emit (ec, false);
118 end this.Emit (ec, false);
131 end this.EmitAssign (ec, source, true, true)
133 And with it true in Emit
135 this.EmitAssign (ec, source, false, true)
140 this.Emit (ec, true);
144 end this.Emit (ec, true);
155 end this.EmitAssign (ec, source, false, true)
157 Note that these two examples are what happens for ++x and x++, respectively.
162 /// An Expression to hold a temporary value.
165 /// The LocalTemporary class is used to hold temporary values of a given
166 /// type to "simulate" the expression semantics. The local variable is
169 /// The local temporary is used to alter the normal flow of code generation
170 /// basically it creates a local variable, and its emit instruction generates
171 /// code to access this value, return its address or save its value.
173 /// If `is_address' is true, then the value that we store is the address to the
174 /// real value, and not the value itself.
176 /// This is needed for a value type, because otherwise you just end up making a
177 /// copy of the value on the stack and modifying it. You really need a pointer
178 /// to the origional value so that you can modify it in that location. This
179 /// Does not happen with a class because a class is a pointer -- so you always
180 /// get the indirection.
183 public class LocalTemporary : Expression, IMemoryLocation, IAssignMethod {
184 LocalBuilder builder;
186 public LocalTemporary (TypeSpec t)
189 eclass = ExprClass.Value;
192 public LocalTemporary (LocalBuilder b, TypeSpec t)
198 public void Release (EmitContext ec)
200 ec.FreeTemporaryLocal (builder, type);
204 public override Expression CreateExpressionTree (ResolveContext ec)
206 Arguments args = new Arguments (1);
207 args.Add (new Argument (this));
208 return CreateExpressionFactoryCall (ec, "Constant", args);
211 protected override Expression DoResolve (ResolveContext ec)
216 public override Expression DoResolveLValue (ResolveContext ec, Expression right_side)
221 public override void Emit (EmitContext ec)
224 throw new InternalErrorException ("Emit without Store, or after Release");
226 ec.Emit (OpCodes.Ldloc, builder, type);
229 #region IAssignMethod Members
231 public void Emit (EmitContext ec, bool leave_copy)
239 public void EmitAssign (EmitContext ec, Expression source, bool leave_copy, bool isCompound)
242 throw new NotImplementedException ();
254 public LocalBuilder Builder {
255 get { return builder; }
258 public void Store (EmitContext ec)
261 builder = ec.GetTemporaryLocal (type);
263 ec.Emit (OpCodes.Stloc, builder, type);
266 public void AddressOf (EmitContext ec, AddressOp mode)
269 builder = ec.GetTemporaryLocal (type);
271 if (builder.LocalType.IsByRef) {
273 // if is_address, than this is just the address anyways,
274 // so we just return this.
276 ec.Emit (OpCodes.Ldloc, builder, type);
278 ec.Emit (OpCodes.Ldloca, builder, type);
284 /// The Assign node takes care of assigning the value of source into
285 /// the expression represented by target.
287 public abstract class Assign : ExpressionStatement {
288 protected Expression target, source;
290 protected Assign (Expression target, Expression source, Location loc)
292 this.target = target;
293 this.source = source;
297 public Expression Target {
298 get { return target; }
301 public Expression Source {
307 public override bool ContainsEmitWithAwait ()
309 return target.ContainsEmitWithAwait () || source.ContainsEmitWithAwait ();
312 public override Expression CreateExpressionTree (ResolveContext ec)
314 ec.Report.Error (832, loc, "An expression tree cannot contain an assignment operator");
318 protected override Expression DoResolve (ResolveContext ec)
321 source = source.Resolve (ec);
323 if (source == null) {
325 source = EmptyExpression.Null;
328 target = target.ResolveLValue (ec, source);
330 if (target == null || !ok)
333 TypeSpec target_type = target.Type;
334 TypeSpec source_type = source.Type;
336 eclass = ExprClass.Value;
339 if (!(target is IAssignMethod)) {
340 Error_ValueAssignment (ec, loc);
344 if (target_type != source_type) {
345 Expression resolved = ResolveConversions (ec);
347 if (resolved != this)
355 public override System.Linq.Expressions.Expression MakeExpression (BuilderContext ctx)
357 var tassign = target as IDynamicAssign;
359 throw new InternalErrorException (target.GetType () + " does not support dynamic assignment");
361 var target_object = tassign.MakeAssignExpression (ctx, source);
364 // Some hacking is needed as DLR does not support void type and requires
365 // always have object convertible return type to support caching and chaining
367 // We do this by introducing an explicit block which returns RHS value when
370 if (target_object.NodeType == System.Linq.Expressions.ExpressionType.Block)
371 return target_object;
373 System.Linq.Expressions.UnaryExpression source_object;
374 if (ctx.HasSet (BuilderContext.Options.CheckedScope)) {
375 source_object = System.Linq.Expressions.Expression.ConvertChecked (source.MakeExpression (ctx), target_object.Type);
377 source_object = System.Linq.Expressions.Expression.Convert (source.MakeExpression (ctx), target_object.Type);
380 return System.Linq.Expressions.Expression.Assign (target_object, source_object);
383 protected virtual Expression ResolveConversions (ResolveContext ec)
385 source = Convert.ImplicitConversionRequired (ec, source, target.Type, source.Location);
392 void Emit (EmitContext ec, bool is_statement)
394 IAssignMethod t = (IAssignMethod) target;
395 t.EmitAssign (ec, source, !is_statement, this is CompoundAssign);
398 public override void Emit (EmitContext ec)
403 public override void EmitStatement (EmitContext ec)
408 protected override void CloneTo (CloneContext clonectx, Expression t)
410 Assign _target = (Assign) t;
412 _target.target = target.Clone (clonectx);
413 _target.source = source.Clone (clonectx);
417 public class SimpleAssign : Assign
419 public SimpleAssign (Expression target, Expression source)
420 : this (target, source, target.Location)
424 public SimpleAssign (Expression target, Expression source, Location loc)
425 : base (target, source, loc)
429 bool CheckEqualAssign (Expression t)
431 if (source is Assign) {
432 Assign a = (Assign) source;
433 if (t.Equals (a.Target))
435 return a is SimpleAssign && ((SimpleAssign) a).CheckEqualAssign (t);
437 return t.Equals (source);
440 protected override Expression DoResolve (ResolveContext ec)
442 Expression e = base.DoResolve (ec);
443 if (e == null || e != this)
446 if (CheckEqualAssign (target))
447 ec.Report.Warning (1717, 3, loc, "Assignment made to same variable; did you mean to assign something else?");
453 public class RuntimeExplicitAssign : Assign
455 public RuntimeExplicitAssign (Expression target, Expression source)
456 : base (target, source, target.Location)
460 protected override Expression ResolveConversions (ResolveContext ec)
462 source = EmptyCast.Create (source, target.Type);
468 // Compiler generated assign
470 class CompilerAssign : Assign
472 public CompilerAssign (Expression target, Expression source, Location loc)
473 : base (target, source, loc)
477 public void UpdateSource (Expression source)
479 base.source = source;
484 // Implements fields and events class initializers
486 public class FieldInitializer : Assign
489 // Field initializers are tricky for partial classes. They have to
490 // share same constructor (block) for expression trees resolve but
491 // they have they own resolve scope
493 sealed class FieldInitializerContext : ResolveContext
495 ExplicitBlock ctor_block;
497 public FieldInitializerContext (IMemberContext mc, ResolveContext constructorContext)
498 : base (mc, Options.FieldInitializerScope | Options.ConstructorScope)
500 this.ctor_block = constructorContext.CurrentBlock.Explicit;
503 public override ExplicitBlock ConstructorBlock {
511 // Keep resolved value because field initializers have their own rules
513 ExpressionStatement resolved;
516 public FieldInitializer (FieldSpec spec, Expression expression, IMemberContext mc)
517 : base (new FieldExpr (spec, expression.Location), expression, expression.Location)
521 ((FieldExpr)target).InstanceExpression = new CompilerGeneratedThis (mc.CurrentType, expression.Location);
524 protected override Expression DoResolve (ResolveContext ec)
526 // Field initializer can be resolved (fail) many times
530 if (resolved == null) {
531 var ctx = new FieldInitializerContext (mc, ec);
532 resolved = base.DoResolve (ctx) as ExpressionStatement;
538 public override void EmitStatement (EmitContext ec)
540 if (resolved == null)
543 if (resolved != this)
544 resolved.EmitStatement (ec);
546 base.EmitStatement (ec);
549 public bool IsDefaultInitializer {
551 Constant c = source as Constant;
555 FieldExpr fe = (FieldExpr)target;
556 return c.IsDefaultInitializer (fe.Type);
560 public override bool IsSideEffectFree {
562 return source.IsSideEffectFree;
568 // This class is used for compound assignments.
570 public class CompoundAssign : Assign
572 // This is just a hack implemented for arrays only
573 public sealed class TargetExpression : Expression
575 readonly Expression child;
577 public TargetExpression (Expression child)
580 this.loc = child.Location;
583 public override bool ContainsEmitWithAwait ()
585 return child.ContainsEmitWithAwait ();
588 public override Expression CreateExpressionTree (ResolveContext ec)
590 throw new NotSupportedException ("ET");
593 protected override Expression DoResolve (ResolveContext ec)
596 eclass = ExprClass.Value;
600 public override void Emit (EmitContext ec)
605 public override Expression EmitToField (EmitContext ec)
607 return child.EmitToField (ec);
611 // Used for underlying binary operator
612 readonly Binary.Operator op;
616 public CompoundAssign (Binary.Operator op, Expression target, Expression source, Location loc)
617 : base (target, source, loc)
623 public CompoundAssign (Binary.Operator op, Expression target, Expression source, Expression left, Location loc)
624 : this (op, target, source, loc)
629 protected override Expression DoResolve (ResolveContext ec)
631 right = right.Resolve (ec);
635 MemberAccess ma = target as MemberAccess;
636 using (ec.Set (ResolveContext.Options.CompoundAssignmentScope)) {
637 target = target.Resolve (ec);
643 if (target is MethodGroupExpr){
644 ec.Report.Error (1656, loc,
645 "Cannot assign to `{0}' because it is a `{1}'",
646 ((MethodGroupExpr)target).Name, target.ExprClassName);
650 var event_expr = target as EventExpr;
651 if (event_expr != null) {
652 source = Convert.ImplicitConversionRequired (ec, right, target.Type, loc);
657 if (op == Binary.Operator.Addition)
658 rside = EmptyExpression.EventAddition;
659 else if (op == Binary.Operator.Subtraction)
660 rside = EmptyExpression.EventSubtraction;
664 target = target.ResolveLValue (ec, rside);
668 eclass = ExprClass.Value;
669 type = event_expr.Operator.ReturnType;
674 // Only now we can decouple the original source/target
675 // into a tree, to guarantee that we do not have side
679 left = new TargetExpression (target);
681 source = new Binary (op, left, right, true, loc);
683 if (target is DynamicMemberAssignable) {
684 Arguments targs = ((DynamicMemberAssignable) target).Arguments;
685 source = source.Resolve (ec);
687 Arguments args = new Arguments (targs.Count + 1);
688 args.AddRange (targs);
689 args.Add (new Argument (source));
691 var binder_flags = CSharpBinderFlags.ValueFromCompoundAssignment;
694 // Compound assignment does target conversion using additional method
695 // call, set checked context as the binary operation can overflow
697 if (ec.HasSet (ResolveContext.Options.CheckedScope))
698 binder_flags |= CSharpBinderFlags.CheckedContext;
700 if (target is DynamicMemberBinder) {
701 source = new DynamicMemberBinder (ma.Name, binder_flags, args, loc).Resolve (ec);
703 // Handles possible event addition/subtraction
704 if (op == Binary.Operator.Addition || op == Binary.Operator.Subtraction) {
705 args = new Arguments (targs.Count + 1);
706 args.AddRange (targs);
707 args.Add (new Argument (right));
708 string method_prefix = op == Binary.Operator.Addition ?
709 Event.AEventAccessor.AddPrefix : Event.AEventAccessor.RemovePrefix;
711 var invoke = DynamicInvocation.CreateSpecialNameInvoke (
712 new MemberAccess (right, method_prefix + ma.Name, loc), args, loc).Resolve (ec);
714 args = new Arguments (targs.Count);
715 args.AddRange (targs);
716 source = new DynamicEventCompoundAssign (ma.Name, args,
717 (ExpressionStatement) source, (ExpressionStatement) invoke, loc).Resolve (ec);
720 source = new DynamicIndexBinder (binder_flags, args, loc).Resolve (ec);
726 return base.DoResolve (ec);
729 protected override Expression ResolveConversions (ResolveContext ec)
732 // LAMESPEC: Under dynamic context no target conversion is happening
733 // This allows more natual dynamic behaviour but breaks compatibility
734 // with static binding
736 if (target is RuntimeValueExpression)
739 TypeSpec target_type = target.Type;
742 // 1. the return type is implicitly convertible to the type of target
744 if (Convert.ImplicitConversionExists (ec, source, target_type)) {
745 source = Convert.ImplicitConversion (ec, source, target_type, loc);
750 // Otherwise, if the selected operator is a predefined operator
752 Binary b = source as Binary;
753 if (b == null && source is ReducedExpression)
754 b = ((ReducedExpression) source).OriginalExpression as Binary;
758 // 2a. the operator is a shift operator
760 // 2b. the return type is explicitly convertible to the type of x, and
761 // y is implicitly convertible to the type of x
763 if ((b.Oper & Binary.Operator.ShiftMask) != 0 ||
764 Convert.ImplicitConversionExists (ec, right, target_type)) {
765 source = Convert.ExplicitConversion (ec, source, target_type, loc);
770 if (source.Type.BuiltinType == BuiltinTypeSpec.Type.Dynamic) {
771 Arguments arg = new Arguments (1);
772 arg.Add (new Argument (source));
773 return new SimpleAssign (target, new DynamicConversion (target_type, CSharpBinderFlags.ConvertExplicit, arg, loc), loc).Resolve (ec);
776 right.Error_ValueCannotBeConverted (ec, loc, target_type, false);
780 protected override void CloneTo (CloneContext clonectx, Expression t)
782 CompoundAssign ctarget = (CompoundAssign) t;
784 ctarget.right = ctarget.source = source.Clone (clonectx);
785 ctarget.target = target.Clone (clonectx);