2 // assign.cs: Assignments.
5 // Miguel de Icaza (miguel@ximian.com)
6 // Martin Baulig (martin@ximian.com)
8 // (C) 2001, 2002, 2003 Ximian, Inc.
9 // (C) 2004 Novell, Inc
12 using System
.Reflection
;
13 using System
.Reflection
.Emit
;
15 namespace Mono
.CSharp
{
18 /// This interface is implemented by expressions that can be assigned to.
21 /// This interface is implemented by Expressions whose values can not
22 /// store the result on the top of the stack.
24 /// Expressions implementing this (Properties, Indexers and Arrays) would
25 /// perform an assignment of the Expression "source" into its final
28 /// No values on the top of the stack are expected to be left by
29 /// invoking this method.
31 public interface IAssignMethod
{
33 // This is an extra version of Emit. If leave_copy is `true'
34 // A copy of the expression will be left on the stack at the
35 // end of the code generated for EmitAssign
37 void Emit (EmitContext ec
, bool leave_copy
);
40 // This method does the assignment
41 // `source' will be stored into the location specified by `this'
42 // if `leave_copy' is true, a copy of `source' will be left on the stack
43 // if `prepare_for_load' is true, when `source' is emitted, there will
44 // be data on the stack that it can use to compuatate its value. This is
45 // for expressions like a [f ()] ++, where you can't call `f ()' twice.
47 void EmitAssign (EmitContext ec
, Expression source
, bool leave_copy
, bool prepare_for_load
);
50 For simple assignments, this interface is very simple, EmitAssign is called with source
51 as the source expression and leave_copy and prepare_for_load false.
53 For compound assignments it gets complicated.
55 EmitAssign will be called as before, however, prepare_for_load will be
56 true. The @source expression will contain an expression
57 which calls Emit. So, the calls look like:
59 this.EmitAssign (ec, source, false, true) ->
62 this.Emit (ec, false); ->
63 end this.Emit (ec, false); ->
66 end this.EmitAssign (ec, source, false, true)
69 When prepare_for_load is true, EmitAssign emits a `token' on the stack that
70 Emit will use for its state.
72 Let's take FieldExpr as an example. assume we are emitting f ().y += 1;
74 Here is the call tree again. This time, each call is annotated with the IL
77 this.EmitAssign (ec, source, false, true)
82 this.Emit (ec, false);
84 end this.Emit (ec, false);
94 end this.EmitAssign (ec, source, false, true)
97 1) EmitAssign left a token on the stack. It was the result of f ().
98 2) This token was used by Emit
100 leave_copy (in both EmitAssign and Emit) tells the compiler to leave a copy
101 of the expression at that point in evaluation. This is used for pre/post inc/dec
102 and for a = x += y. Let's do the above example with leave_copy true in EmitAssign
104 this.EmitAssign (ec, source, true, true)
109 this.Emit (ec, false);
111 end this.Emit (ec, false);
124 end this.EmitAssign (ec, source, true, true)
126 And with it true in Emit
128 this.EmitAssign (ec, source, false, true)
133 this.Emit (ec, true);
137 end this.Emit (ec, true);
148 end this.EmitAssign (ec, source, false, true)
150 Note that these two examples are what happens for ++x and x++, respectively.
155 /// An Expression to hold a temporary value.
158 /// The LocalTemporary class is used to hold temporary values of a given
159 /// type to "simulate" the expression semantics on property and indexer
160 /// access whose return values are void.
162 /// The local temporary is used to alter the normal flow of code generation
163 /// basically it creates a local variable, and its emit instruction generates
164 /// code to access this value, return its address or save its value.
166 /// If `is_address' is true, then the value that we store is the address to the
167 /// real value, and not the value itself.
169 /// This is needed for a value type, because otherwise you just end up making a
170 /// copy of the value on the stack and modifying it. You really need a pointer
171 /// to the origional value so that you can modify it in that location. This
172 /// Does not happen with a class because a class is a pointer -- so you always
173 /// get the indirection.
175 /// The `is_address' stuff is really just a hack. We need to come up with a better
176 /// way to handle it.
178 public class LocalTemporary
: Expression
, IMemoryLocation
{
179 LocalBuilder builder
;
182 public LocalTemporary (Type t
) : this (t
, false) {}
184 public LocalTemporary (Type t
, bool is_address
)
187 eclass
= ExprClass
.Value
;
188 this.is_address
= is_address
;
191 public LocalTemporary (LocalBuilder b
, Type t
)
194 eclass
= ExprClass
.Value
;
199 public void Release (EmitContext ec
)
201 ec
.FreeTemporaryLocal (builder
, type
);
205 public override Expression
DoResolve (EmitContext ec
)
210 public override void Emit (EmitContext ec
)
212 ILGenerator ig
= ec
.ig
;
214 ig
.Emit (OpCodes
.Ldloc
, builder
);
215 // we need to copy from the pointer
217 LoadFromPtr (ig
, type
);
220 // NB: if you have `is_address' on the stack there must
221 // be a managed pointer. Otherwise, it is the type from
223 public void Store (EmitContext ec
)
225 ILGenerator ig
= ec
.ig
;
227 builder
= ec
.GetTemporaryLocal (is_address
? TypeManager
.GetReferenceType (type
): type
);
229 ig
.Emit (OpCodes
.Stloc
, builder
);
232 public void AddressOf (EmitContext ec
, AddressOp mode
)
235 builder
= ec
.GetTemporaryLocal (is_address
? TypeManager
.GetReferenceType (type
): type
);
237 // if is_address, than this is just the address anyways,
238 // so we just return this.
239 ILGenerator ig
= ec
.ig
;
242 ig
.Emit (OpCodes
.Ldloc
, builder
);
244 ig
.Emit (OpCodes
.Ldloca
, builder
);
247 public bool PointsToAddress
{
255 /// The Assign node takes care of assigning the value of source into
256 /// the expression represented by target.
258 public class Assign
: ExpressionStatement
{
259 protected Expression target
, source
, real_source
;
260 protected LocalTemporary temp
= null, real_temp
= null;
261 protected Assign embedded
= null;
262 protected bool is_embedded
= false;
263 protected bool must_free_temp
= false;
265 public Assign (Expression target
, Expression source
)
266 : this (target
, source
, target
.Location
)
270 public Assign (Expression target
, Expression source
, Location l
)
272 this.target
= target
;
273 this.source
= this.real_source
= source
;
277 protected Assign (Assign embedded
, Location l
)
278 : this (embedded
.target
, embedded
.source
, l
)
280 this.is_embedded
= true;
283 protected virtual Assign
GetEmbeddedAssign (Location loc
)
285 return new Assign (this, loc
);
288 public Expression Target
{
298 public Expression Source
{
308 public static void error70 (EventInfo ei
, Location l
)
310 Report
.Error (70, l
, "The event `" + TypeManager
.CSharpSignature (ei
) +
311 "' can only appear on the left hand side of += or -= (except when" +
312 " used from within the type `" + ei
.DeclaringType
+ "')");
316 // Will return either `this' or an instance of `New'.
318 public override Expression
DoResolve (EmitContext ec
)
320 // Create an embedded assignment if our source is an assignment.
321 if (source
is Assign
)
322 source
= embedded
= ((Assign
) source
).GetEmbeddedAssign (loc
);
324 real_source
= source
= source
.Resolve (ec
);
325 if (source
== null) {
326 // Ensure that we don't propagate the error as spurious "uninitialized variable" errors.
327 target
= target
.ResolveLValue (ec
, EmptyExpression
.Null
, Location
);
332 // This is used in an embedded assignment.
333 // As an example, consider the statement "A = X = Y = Z".
335 if (is_embedded
&& !(source
is Constant
)) {
336 // If this is the innermost assignment (the "Y = Z" in our example),
337 // create a new temporary local, otherwise inherit that variable
338 // from our child (the "X = (Y = Z)" inherits the local from the
339 // "Y = Z" assignment).
341 if (embedded
== null) {
342 if (this is CompoundAssign
)
343 real_temp
= temp
= new LocalTemporary (target
.Type
);
345 real_temp
= temp
= new LocalTemporary (source
.Type
);
347 temp
= embedded
.temp
;
349 // Set the source to the new temporary variable.
350 // This means that the following target.ResolveLValue () will tell
351 // the target to read it's source value from that variable.
355 // If we have an embedded assignment, use the embedded assignment's temporary
356 // local variable as source.
357 if (embedded
!= null)
358 source
= (embedded
.temp
!= null) ? embedded
.temp
: embedded
.source
;
360 target
= target
.ResolveLValue (ec
, source
, Location
);
365 bool same_assignment
= (embedded
!= null) ? embedded
.Target
.Equals(target
) : source
.Equals (target
);
366 if (same_assignment
) {
367 Report
.Warning (1717, 3, loc
, "Assignment made to same variable; did you mean to assign something else?");
370 Type target_type
= target
.Type
;
371 Type source_type
= real_source
.Type
;
373 // If we're an embedded assignment, our parent will reuse our source as its
374 // source, it won't read from our target.
379 eclass
= ExprClass
.Value
;
381 if (target
is EventExpr
) {
382 EventInfo ei
= ((EventExpr
) target
).EventInfo
;
384 Expression ml
= MemberLookup (
385 ec
.ContainerType
, ec
.ContainerType
, ei
.Name
,
386 MemberTypes
.Event
, AllBindingFlags
| BindingFlags
.DeclaredOnly
, loc
);
390 // If this is the case, then the Event does not belong
391 // to this Type and so, according to the spec
392 // is allowed to only appear on the left hand of
393 // the += and -= operators
395 // Note that target will not appear as an EventExpr
396 // in the case it is being referenced within the same type container;
397 // it will appear as a FieldExpr in that case.
400 if (!(source
is BinaryDelegate
)) {
407 if (!(target
is IAssignMethod
) && (target
.eclass
!= ExprClass
.EventAccess
)) {
408 Report
.Error (131, loc
,
409 "Left hand of an assignment must be a variable, " +
410 "a property or an indexer");
414 if ((source
.eclass
== ExprClass
.Type
) && (source
is TypeExpr
)) {
415 source
.Error_UnexpectedKind (ec
.DeclContainer
, "variable or value", loc
);
417 } else if ((RootContext
.Version
== LanguageVersion
.ISO_1
) &&
418 (source
is MethodGroupExpr
)){
419 ((MethodGroupExpr
) source
).ReportUsageError ();
424 if (target_type
== source_type
){
425 if (source
is New
&& target_type
.IsValueType
&&
426 (target
.eclass
!= ExprClass
.IndexerAccess
) && (target
.eclass
!= ExprClass
.PropertyAccess
)){
427 New n
= (New
) source
;
429 if (n
.SetValueTypeVariable (target
))
439 // If this assignment/operator was part of a compound binary
440 // operator, then we allow an explicit conversion, as detailed
444 if (this is CompoundAssign
){
445 CompoundAssign a
= (CompoundAssign
) this;
447 Binary b
= source
as Binary
;
450 // 1. if the source is explicitly convertible to the
454 source
= Convert
.ExplicitConversion (ec
, source
, target_type
, loc
);
456 a
.original_source
.Error_ValueCannotBeConverted (loc
, target_type
, true);
461 // 2. and the original right side is implicitly convertible to
462 // the type of target
464 if (Convert
.ImplicitStandardConversionExists (a
.original_source
, target_type
))
468 // In the spec 2.4 they added: or if type of the target is int
469 // and the operator is a shift operator...
471 if (source_type
== TypeManager
.int32_type
&&
472 (b
.Oper
== Binary
.Operator
.LeftShift
|| b
.Oper
== Binary
.Operator
.RightShift
))
475 a
.original_source
.Error_ValueCannotBeConverted (loc
, target_type
, false);
480 if (source
.eclass
== ExprClass
.MethodGroup
&& !TypeManager
.IsDelegateType (target_type
)) {
481 Report
.Error (428, source
.Location
, "Cannot convert method group `{0}' to non-delegate type `{1}'. Did you intend to invoke the method?",
482 ((MethodGroupExpr
)source
).Name
, target
.GetSignatureForError ());
486 source
= Convert
.ImplicitConversionRequired (ec
, source
, target_type
, loc
);
490 // If we're an embedded assignment, we need to create a new temporary variable
491 // for the converted value. Our parent will use this new variable as its source.
492 // The same applies when we have an embedded assignment - in this case, we need
493 // to convert our embedded assignment's temporary local variable to the correct
494 // type and store it in a new temporary local.
495 if (is_embedded
|| embedded
!= null) {
497 temp
= new LocalTemporary (type
);
498 must_free_temp
= true;
504 Expression
EmitEmbedded (EmitContext ec
)
506 // Emit an embedded assignment.
508 if (real_temp
!= null) {
509 // If we're the innermost assignment, `real_source' is the right-hand
510 // expression which gets assigned to all the variables left of it.
511 // Emit this expression and store its result in real_temp.
512 real_source
.Emit (ec
);
513 real_temp
.Store (ec
);
516 if (embedded
!= null)
517 embedded
.EmitEmbedded (ec
);
519 // This happens when we've done a type conversion, in this case source will be
520 // the expression which does the type conversion from real_temp.
521 // So emit it and store the result in temp; this is the var which will be read
523 if (temp
!= real_temp
) {
528 Expression temp_source
= (temp
!= null) ? temp
: source
;
529 ((IAssignMethod
) target
).EmitAssign (ec
, temp_source
, false, false);
533 void ReleaseEmbedded (EmitContext ec
)
535 if (embedded
!= null)
536 embedded
.ReleaseEmbedded (ec
);
538 if (real_temp
!= null)
539 real_temp
.Release (ec
);
545 void Emit (EmitContext ec
, bool is_statement
)
547 if (target
is EventExpr
) {
548 ((EventExpr
) target
).EmitAddOrRemove (ec
, source
);
552 IAssignMethod am
= (IAssignMethod
) target
;
554 Expression temp_source
;
555 if (embedded
!= null) {
556 temp_source
= embedded
.EmitEmbedded (ec
);
564 temp_source
= source
;
566 am
.EmitAssign (ec
, temp_source
, !is_statement
, this is CompoundAssign
);
568 if (embedded
!= null) {
571 embedded
.ReleaseEmbedded (ec
);
575 public override void Emit (EmitContext ec
)
580 public override void EmitStatement (EmitContext ec
)
588 // This class is used for compound assignments.
590 class CompoundAssign
: Assign
{
592 public Expression original_source
;
594 public CompoundAssign (Binary
.Operator op
, Expression target
, Expression source
)
595 : base (target
, source
, target
.Location
)
597 original_source
= source
;
601 protected CompoundAssign (CompoundAssign embedded
, Location l
)
602 : this (embedded
.op
, embedded
.target
, embedded
.source
)
604 this.is_embedded
= true;
607 protected override Assign
GetEmbeddedAssign (Location loc
)
609 return new CompoundAssign (this, loc
);
612 public override Expression
DoResolve (EmitContext ec
)
614 original_source
= original_source
.Resolve (ec
);
615 if (original_source
== null)
618 target
= target
.Resolve (ec
);
623 // Only now we can decouple the original source/target
624 // into a tree, to guarantee that we do not have side
627 source
= new Binary (op
, target
, original_source
);
628 return base.DoResolve (ec
);