mcs/mcs/argument.cs

   1 //
   2 // argument.cs: Argument expressions
   3 //
   4 // Author:
   5 //   Miguel de Icaza (miguel@ximain.com)
   6 //   Marek Safar (marek.safar@gmail.com)
   7 //
   8 // Dual licensed under the terms of the MIT X11 or GNU GPL
   9 // Copyright 2003-2008 Novell, Inc.
  10 //
  11
  12 using System;
  13 using System.Collections;
  14 using System.Reflection;
  15 using System.Reflection.Emit;
  16
  17 namespace Mono.CSharp
  18 {
  19         //
  20         // Argument expression used for invocation
  21         //
  22         public class Argument
  23         {
  24                 public enum AType : byte
  25                 {
  26                         None = 0,
  27                         Ref = 1,                        // ref modifier used
  28                         Out = 2,                        // out modifier used
  29                         Default = 3,            // argument created from default parameter value
  30                         DynamicStatic = 4       // static argument for dynamic binding
  31                 }
  32
  33                 public readonly AType ArgType;
  34                 public Expression Expr;
  35
  36                 public Argument (Expression expr, AType type)
  37                 {
  38                         this.Expr = expr;
  39                         this.ArgType = type;
  40                 }
  41
  42                 public Argument (Expression expr)
  43                 {
  44                         if (expr == null)
  45                                 throw new ArgumentNullException ();
  46
  47                         this.Expr = expr;
  48                 }
  49
  50                 public Type Type {
  51                         get { return Expr.Type; }
  52                 }
  53
  54                 public Parameter.Modifier Modifier {
  55                         get {
  56                                 switch (ArgType) {
  57                                 case AType.Out:
  58                                         return Parameter.Modifier.OUT;
  59
  60                                 case AType.Ref:
  61                                         return Parameter.Modifier.REF;
  62
  63                                 default:
  64                                         return Parameter.Modifier.NONE;
  65                                 }
  66                         }
  67                 }
  68
  69                 public virtual Expression CreateExpressionTree (ResolveContext ec)
  70                 {
  71                         if (ArgType == AType.Default)
  72                                 ec.Report.Error (854, Expr.Location, "An expression tree cannot contain an invocation which uses optional parameter");
  73
  74                         return Expr.CreateExpressionTree (ec);
  75                 }
  76
  77                 public string GetSignatureForError ()
  78                 {
  79                         if (Expr.eclass == ExprClass.MethodGroup)
  80                                 return Expr.ExprClassName;
  81
  82                         return TypeManager.CSharpName (Expr.Type);
  83                 }
  84
  85                 public bool IsByRef {
  86                         get { return ArgType == AType.Ref || ArgType == AType.Out; }
  87                 }
  88
  89                 public bool IsDefaultArgument {
  90                         get { return ArgType == AType.Default; }
  91                 }
  92
  93                 public bool ResolveMethodGroup (ResolveContext ec)
  94                 {
  95                         SimpleName sn = Expr as SimpleName;
  96                         if (sn != null)
  97                                 Expr = sn.GetMethodGroup ();
  98
  99                         // FIXME: csc doesn't report any error if you try to use `ref' or
 100                         //        `out' in a delegate creation expression.
 101                         Expr = Expr.Resolve (ec, ResolveFlags.VariableOrValue | ResolveFlags.MethodGroup);
 102                         if (Expr == null)
 103                                 return false;
 104
 105                         return true;
 106                 }
 107
 108                 public void Resolve (ResolveContext ec)
 109                 {
 110                         if (Expr == EmptyExpression.Null)
 111                                 return;
 112
 113                         using (ec.With (ResolveContext.Options.DoFlowAnalysis, true)) {
 114                                 // Verify that the argument is readable
 115                                 if (ArgType != AType.Out)
 116                                         Expr = Expr.Resolve (ec);
 117
 118                                 // Verify that the argument is writeable
 119                                 if (Expr != null && IsByRef)
 120                                         Expr = Expr.ResolveLValue (ec, EmptyExpression.OutAccess);
 121
 122                                 if (Expr == null)
 123                                         Expr = EmptyExpression.Null;
 124                         }
 125                 }
 126
 127                 public virtual void Emit (EmitContext ec)
 128                 {
 129                         if (!IsByRef) {
 130                                 Expr.Emit (ec);
 131                                 return;
 132                         }
 133
 134                         AddressOp mode = AddressOp.Store;
 135                         if (ArgType == AType.Ref)
 136                                 mode |= AddressOp.Load;
 137
 138                         IMemoryLocation ml = (IMemoryLocation) Expr;
 139                         ParameterReference pr = ml as ParameterReference;
 140
 141                         //
 142                         // ParameterReferences might already be references, so we want
 143                         // to pass just the value
 144                         //
 145                         if (pr != null && pr.IsRef)
 146                                 pr.EmitLoad (ec);
 147                         else
 148                                 ml.AddressOf (ec, mode);
 149                 }
 150
 151                 public Argument Clone (CloneContext clonectx)
 152                 {
 153                         Argument a = (Argument) MemberwiseClone ();
 154                         a.Expr = Expr.Clone (clonectx);
 155                         return a;
 156                 }
 157         }
 158
 159         public class NamedArgument : Argument
 160         {
 161                 public readonly LocatedToken Name;
 162                 LocalTemporary variable;
 163
 164                 public NamedArgument (LocatedToken name, Expression expr)
 165                         : base (expr)
 166                 {
 167                         Name = name;
 168                 }
 169
 170                 public override Expression CreateExpressionTree (ResolveContext ec)
 171                 {
 172                         ec.Report.Error (853, Name.Location, "An expression tree cannot contain named argument");
 173                         return base.CreateExpressionTree (ec);
 174                 }
 175
 176                 public override void Emit (EmitContext ec)
 177                 {
 178                         // TODO: Should guard against multiple emits
 179                         base.Emit (ec);
 180
 181                         // Release temporary variable when used
 182                         if (variable != null)
 183                                 variable.Release (ec);
 184                 }
 185
 186                 public void EmitAssign (EmitContext ec)
 187                 {
 188                         Expr.Emit (ec);
 189                         variable = new LocalTemporary (Expr.Type);
 190                         variable.Store (ec);
 191
 192                         Expr = variable;
 193                 }
 194         }
 195
 196         public class Arguments
 197         {
 198                 ArrayList args;                 // TODO: This should really be linked list
 199                 ArrayList reordered;    // TODO: LinkedList
 200
 201                 public Arguments (int capacity)
 202                 {
 203                         args = new ArrayList (capacity);
 204                 }
 205
 206                 public int Add (Argument arg)
 207                 {
 208                         return args.Add (arg);
 209                 }
 210
 211                 public void AddRange (Arguments args)
 212                 {
 213                         this.args.AddRange (args.args);
 214                 }
 215
 216                 public ArrayList CreateDynamicBinderArguments ()
 217                 {
 218                         ArrayList all = new ArrayList (args.Count);
 219                         Location loc = Location.Null;
 220
 221                         MemberAccess binder = DynamicExpressionStatement.GetBinderNamespace (loc);
 222
 223                         foreach (Argument a in args) {
 224                                 Arguments dargs = new Arguments (2);
 225
 226                                 // CSharpArgumentInfoFlags.None = 0
 227                                 const string info_flags_enum = "CSharpArgumentInfoFlags";
 228                                 Expression info_flags = new IntLiteral (0, loc);
 229
 230                                 if (a.Expr is Constant) {
 231                                         // Any constant is emitted as a literal
 232                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 233                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "LiteralConstant", loc));
 234                                 } else if (a.ArgType == Argument.AType.Ref) {
 235                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 236                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "IsRef", loc));
 237                                 } else if (a.ArgType == Argument.AType.Out) {
 238                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 239                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "IsOut", loc));
 240                                 } else if (a.ArgType == Argument.AType.DynamicStatic) {
 241                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 242                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "IsStaticType", loc));
 243                                 }
 244
 245                                 if (!TypeManager.IsDynamicType (a.Expr.Type)) {
 246                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 247                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "UseCompileTimeType", loc));
 248                                 }
 249
 250                                 string named_value;
 251                                 NamedArgument na = a as NamedArgument;
 252                                 if (na != null) {
 253                                         info_flags = new Binary (Binary.Operator.BitwiseOr, info_flags,
 254                                                 new MemberAccess (new MemberAccess (binder, info_flags_enum, loc), "NamedArgument", loc));
 255
 256                                         named_value = na.Name.Value;
 257                                 } else {
 258                                         named_value = null;
 259                                 }
 260
 261                                 dargs.Add (new Argument (info_flags));
 262                                 dargs.Add (new Argument (new StringLiteral (named_value, loc)));
 263                                 all.Add (new Invocation (new MemberAccess (new MemberAccess (binder, "CSharpArgumentInfo", loc), "Create", loc), dargs));
 264                         }
 265
 266                         return all;
 267                 }
 268
 269                 public static Arguments CreateForExpressionTree (ResolveContext ec, Arguments args, params Expression[] e)
 270                 {
 271                         Arguments all = new Arguments ((args == null ? 0 : args.Count) + e.Length);
 272                         for (int i = 0; i < e.Length; ++i) {
 273                                 if (e [i] != null)
 274                                         all.Add (new Argument (e[i]));
 275                         }
 276
 277                         if (args != null) {
 278                                 foreach (Argument a in args.args) {
 279                                         Expression tree_arg = a.CreateExpressionTree (ec);
 280                                         if (tree_arg != null)
 281                                                 all.Add (new Argument (tree_arg));
 282                                 }
 283                         }
 284
 285                         return all;
 286                 }
 287
 288                 public void CheckArrayAsAttribute (CompilerContext ctx)
 289                 {
 290                         foreach (Argument arg in args) {
 291                                 // Type is undefined (was error 246)
 292                                 if (arg.Type == null)
 293                                         continue;
 294
 295                                 if (arg.Type.IsArray)
 296                                         ctx.Report.Warning (3016, 1, arg.Expr.Location, "Arrays as attribute arguments are not CLS-compliant");
 297                         }
 298                 }
 299
 300                 public Arguments Clone (CloneContext ctx)
 301                 {
 302                         Arguments cloned = new Arguments (args.Count);
 303                         foreach (Argument a in args)
 304                                 cloned.Add (a.Clone (ctx));
 305
 306                         return cloned;
 307                 }
 308
 309                 public int Count {
 310                         get { return args.Count; }
 311                 }
 312
 313                 //
 314                 // Emits a list of resolved Arguments
 315                 //
 316                 public void Emit (EmitContext ec)
 317                 {
 318                         Emit (ec, false, null);
 319                 }
 320
 321                 //
 322                 // if `dup_args' is true, a copy of the arguments will be left
 323                 // on the stack. If `dup_args' is true, you can specify `this_arg'
 324                 // which will be duplicated before any other args. Only EmitCall
 325                 // should be using this interface.
 326                 //
 327                 public void Emit (EmitContext ec, bool dup_args, LocalTemporary this_arg)
 328                 {
 329                         LocalTemporary[] temps = null;
 330
 331                         if (dup_args && Count != 0)
 332                                 temps = new LocalTemporary [Count];
 333
 334                         if (reordered != null && Count > 1) {
 335                                 foreach (NamedArgument na in reordered)
 336                                         na.EmitAssign (ec);
 337                         }
 338
 339                         int i = 0;
 340                         foreach (Argument a in args) {
 341                                 a.Emit (ec);
 342                                 if (dup_args) {
 343                                         ec.ig.Emit (OpCodes.Dup);
 344                                         (temps [i++] = new LocalTemporary (a.Type)).Store (ec);
 345                                 }
 346                         }
 347
 348                         if (dup_args) {
 349                                 if (this_arg != null)
 350                                         this_arg.Emit (ec);
 351
 352                                 for (i = 0; i < temps.Length; i++) {
 353                                         temps[i].Emit (ec);
 354                                         temps[i].Release (ec);
 355                                 }
 356                         }
 357                 }
 358
 359                 public bool GetAttributableValue (ResolveContext ec, out object[] values)
 360                 {
 361                         values = new object [args.Count];
 362                         for (int j = 0; j < values.Length; ++j) {
 363                                 Argument a = this [j];
 364                                 if (!a.Expr.GetAttributableValue (ec, a.Type, out values[j]))
 365                                         return false;
 366                         }
 367
 368                         return true;
 369                 }
 370
 371                 public IEnumerator GetEnumerator ()
 372                 {
 373                         return args.GetEnumerator ();
 374                 }
 375
 376                 public void Insert (int index, Argument arg)
 377                 {
 378                         args.Insert (index, arg);
 379                 }
 380
 381 #if NET_4_0
 382                 public static System.Linq.Expressions.Expression[] MakeExpression (Arguments args, BuilderContext ctx)
 383                 {
 384                         if (args == null || args.Count == 0)
 385                                 return null;
 386
 387                         // TODO: implement
 388                         if (args.reordered != null)
 389                                 throw new NotImplementedException ();
 390
 391                         var exprs = new System.Linq.Expressions.Expression [args.Count];
 392                         for (int i = 0; i < exprs.Length; ++i) {
 393                                 Argument a = (Argument) args.args [i];
 394                                 exprs[i] = a.Expr.MakeExpression (ctx);
 395                         }
 396
 397                         return exprs;
 398                 }
 399 #endif
 400
 401                 public void MarkReorderedArgument (NamedArgument a)
 402                 {
 403                         //
 404                         // Constant expression can have no effect on left-to-right execution
 405                         //
 406                         if (a.Expr is Constant)
 407                                 return;
 408
 409                         if (reordered == null)
 410                                 reordered = new ArrayList ();
 411
 412                         reordered.Add (a);
 413                 }
 414
 415                 //
 416                 // Returns dynamic when at least one argument is of dynamic type
 417                 //
 418                 public void Resolve (ResolveContext ec, out bool dynamic)
 419                 {
 420                         dynamic = false;
 421                         foreach (Argument a in args) {
 422                                 a.Resolve (ec);
 423                                 dynamic |= TypeManager.IsDynamicType (a.Type);
 424                         }
 425                 }
 426
 427                 public void MutateHoistedGenericType (AnonymousMethodStorey storey)
 428                 {
 429                         foreach (Argument a in args)
 430                                 a.Expr.MutateHoistedGenericType (storey);
 431                 }
 432
 433                 public void RemoveAt (int index)
 434                 {
 435                         args.RemoveAt (index);
 436                 }
 437
 438                 public Argument this [int index] {
 439                         get { return (Argument) args [index]; }
 440                         set { args [index] = value; }
 441                 }
 442         }
 443 }