mcs/mcs/eval.cs

   1 //
   2 // eval.cs: Evaluation and Hosting API for the C# compiler
   3 //
   4 // Authors:
   5 //   Miguel de Icaza (miguel@gnome.org)
   6 //   Marek Safar (marek.safar@gmail.com)
   7 //
   8 // Dual licensed under the terms of the MIT X11 or GNU GPL
   9 //
  10 // Copyright 2001, 2002, 2003 Ximian, Inc (http://www.ximian.com)
  11 // Copyright 2004-2011 Novell, Inc
  12 // Copyright 2011 Xamarin Inc
  13 //
  14
  15 using System;
  16 using System.Threading;
  17 using System.Collections.Generic;
  18 using System.Reflection;
  19 using System.Reflection.Emit;
  20 using System.IO;
  21 using System.Text;
  22 using System.Linq;
  23
  24 namespace Mono.CSharp
  25 {
  26
  27         /// <summary>
  28         /// Experimental!
  29         /// </summary>
  30         public delegate void ValueModificationHandler (string variableName, int row, int column, object value);
  31
  32         /// <summary>
  33         ///   Evaluator: provides an API to evaluate C# statements and
  34         ///   expressions dynamically.
  35         /// </summary>
  36         /// <remarks>
  37         ///   This class exposes static methods to evaluate expressions in the
  38         ///   current program.
  39         ///
  40         ///   To initialize the evaluator with a number of compiler
  41         ///   options call the Init(string[]args) method with a set of
  42         ///   command line options that the compiler recognizes.
  43         ///
  44         ///   To interrupt execution of a statement, you can invoke the
  45         ///   Evaluator.Interrupt method.
  46         /// </remarks>
  47         public class Evaluator {
  48
  49                 enum ParseMode {
  50                         // Parse silently, do not output any error messages
  51                         Silent,
  52
  53                         // Report errors during parse
  54                         ReportErrors,
  55
  56                         // Auto-complete, means that the tokenizer will start producing
  57                         // GETCOMPLETIONS tokens when it reaches a certain point.
  58                         GetCompletions
  59                 }
  60
  61                 static object evaluator_lock = new object ();
  62                 static volatile bool invoking;
  63
  64 #if !STATIC
  65                 static int count;
  66 #endif
  67                 static Thread invoke_thread;
  68
  69                 readonly Dictionary<string, Tuple<FieldSpec, FieldInfo>> fields;
  70
  71                 Type base_class;
  72                 bool inited;
  73                 int startup_files;
  74
  75                 readonly CompilerContext ctx;
  76                 readonly ModuleContainer module;
  77                 readonly ReflectionImporter importer;
  78                 readonly CompilationSourceFile source_file;
  79
  80                 int? listener_id;
  81
  82                 public Evaluator (CompilerContext ctx)
  83                 {
  84                         this.ctx = ctx;
  85
  86                         module = new ModuleContainer (ctx);
  87                         module.Evaluator = this;
  88
  89                         source_file = new CompilationSourceFile (module, null);
  90                         module.AddTypeContainer (source_file);
  91
  92                         startup_files = ctx.SourceFiles.Count;
  93
  94                         // FIXME: Importer needs this assembly for internalsvisibleto
  95                         module.SetDeclaringAssembly (new AssemblyDefinitionDynamic (module, "evaluator"));
  96                         importer = new ReflectionImporter (module, ctx.BuiltinTypes);
  97
  98                         InteractiveBaseClass = typeof (InteractiveBase);
  99                         fields = new Dictionary<string, Tuple<FieldSpec, FieldInfo>> ();
 100                 }
 101
 102                 void Init ()
 103                 {
 104                         var loader = new DynamicLoader (importer, ctx);
 105
 106                         CompilerCallableEntryPoint.Reset ();
 107                         RootContext.ToplevelTypes = module;
 108
 109                         //var startup_files = new List<string> ();
 110                         //foreach (CompilationUnit file in Location.SourceFiles)
 111                         //    startup_files.Add (file.Path);
 112
 113                         loader.LoadReferences (module);
 114                         ctx.BuiltinTypes.CheckDefinitions (module);
 115                         module.InitializePredefinedTypes ();
 116
 117                         inited = true;
 118                 }
 119
 120                 void ParseStartupFiles ()
 121                 {
 122                         Driver d = new Driver (ctx);
 123
 124                         Location.Initialize (ctx.SourceFiles);
 125
 126                         var parser_session = new ParserSession ();
 127                         for (int i = 0; i < startup_files; ++i) {
 128                                 var sf = ctx.SourceFiles [i];
 129                                 d.Parse (sf, module, parser_session, ctx.Report);
 130                         }
 131                 }
 132
 133                 void Reset ()
 134                 {
 135                         CompilerCallableEntryPoint.PartialReset ();
 136
 137                         Location.Reset ();
 138                         Location.Initialize (ctx.SourceFiles);
 139                 }
 140
 141                 /// <summary>
 142                 /// When set evaluator will automatically wait on Task of async methods. When not
 143                 /// set it's called responsibility to handle Task execution
 144                 /// </summary>
 145                 public bool WaitOnTask { get; set; }
 146
 147                 /// <summary>
 148                 ///   If true, turns type expressions into valid expressions
 149                 ///   and calls the describe method on it
 150                 /// </summary>
 151                 public bool DescribeTypeExpressions;
 152
 153                 /// <summary>
 154                 ///   Whether the evaluator will use terse syntax, and the semicolons at the end are optional
 155                 /// </summary>
 156                 public bool Terse = true;
 157
 158                 /// <summary>
 159                 ///   The base class for the classes that host the user generated code
 160                 /// </summary>
 161                 /// <remarks>
 162                 ///
 163                 ///   This is the base class that will host the code
 164                 ///   executed by the Evaluator.  By default
 165                 ///   this is the Mono.CSharp.InteractiveBase class
 166                 ///   which is useful for interactive use.
 167                 ///
 168                 ///   By changing this property you can control the
 169                 ///   base class and the static members that are
 170                 ///   available to your evaluated code.
 171                 /// </remarks>
 172                 public Type InteractiveBaseClass {
 173                         get {
 174                                 return base_class;
 175                         }
 176                         set {
 177                                 base_class = value;
 178
 179                                 if (value != null && typeof (InteractiveBase).IsAssignableFrom (value))
 180                                         InteractiveBase.Evaluator = this;
 181                         }
 182                 }
 183
 184                 /// <summary>
 185                 ///   Interrupts the evaluation of an expression executing in Evaluate.
 186                 /// </summary>
 187                 /// <remarks>
 188                 ///   Use this method to interrupt long-running invocations.
 189                 /// </remarks>
 190                 public void Interrupt ()
 191                 {
 192                         if (!inited || !invoking)
 193                                 return;
 194
 195                         if (invoke_thread != null)
 196                                 invoke_thread.Abort ();
 197                 }
 198
 199                 /// <summary>
 200                 ///   Compiles the input string and returns a delegate that represents the compiled code.
 201                 /// </summary>
 202                 /// <remarks>
 203                 ///
 204                 ///   Compiles the input string as a C# expression or
 205                 ///   statement, unlike the Evaluate method, the
 206                 ///   resulting delegate can be invoked multiple times
 207                 ///   without incurring in the compilation overhead.
 208                 ///
 209                 ///   If the return value of this function is null,
 210                 ///   this indicates that the parsing was complete.
 211                 ///   If the return value is a string it indicates
 212                 ///   that the input string was partial and that the
 213                 ///   invoking code should provide more code before
 214                 ///   the code can be successfully compiled.
 215                 ///
 216                 ///   If you know that you will always get full expressions or
 217                 ///   statements and do not care about partial input, you can use
 218                 ///   the other Compile overload.
 219                 ///
 220                 ///   On success, in addition to returning null, the
 221                 ///   compiled parameter will be set to the delegate
 222                 ///   that can be invoked to execute the code.
 223                 ///
 224                 /// </remarks>
 225                 public string Compile (string input, out CompiledMethod compiled)
 226                 {
 227                         if (input == null || input.Length == 0){
 228                                 compiled = null;
 229                                 return null;
 230                         }
 231
 232                         lock (evaluator_lock){
 233                                 if (!inited) {
 234                                         Init ();
 235                                         ParseStartupFiles ();
 236                                 } else {
 237                                         ctx.Report.Printer.Reset ();
 238                                 }
 239
 240                                 bool partial_input;
 241                                 CSharpParser parser = ParseString (ParseMode.Silent, input, out partial_input);
 242
 243                                 // Terse mode, try to provide the trailing semicolon automatically.
 244                                 if (parser == null && Terse && partial_input){
 245                                         bool ignore;
 246
 247                                         // check if the source would compile with a block, if so, we should not
 248                                         // add the semicolon.
 249                                         var needs_block = ParseString (ParseMode.Silent, input + "{}", out ignore) != null;
 250                                         if (!needs_block)
 251                                                 parser = ParseString (ParseMode.Silent, input + ";", out ignore);
 252                                 }
 253                                 if (parser == null){
 254                                         compiled = null;
 255                                         if (partial_input)
 256                                                 return input;
 257
 258                                         ParseString (ParseMode.ReportErrors, input, out partial_input);
 259                                         return null;
 260                                 }
 261
 262                                 Class parser_result = parser.InteractiveResult;
 263                                 compiled = CompileBlock (parser_result, parser.undo, ctx.Report);
 264                                 return null;
 265                         }
 266                 }
 267
 268                 /// <summary>
 269                 ///   Compiles the input string and returns a delegate that represents the compiled code.
 270                 /// </summary>
 271                 /// <remarks>
 272                 ///
 273                 ///   Compiles the input string as a C# expression or
 274                 ///   statement, unlike the Evaluate method, the
 275                 ///   resulting delegate can be invoked multiple times
 276                 ///   without incurring in the compilation overhead.
 277                 ///
 278                 ///   This method can only deal with fully formed input
 279                 ///   strings and does not provide a completion mechanism.
 280                 ///   If you must deal with partial input (for example for
 281                 ///   interactive use) use the other overload.
 282                 ///
 283                 ///   On success, a delegate is returned that can be used
 284                 ///   to invoke the method.
 285                 ///
 286                 /// </remarks>
 287                 public CompiledMethod Compile (string input)
 288                 {
 289                         CompiledMethod compiled;
 290
 291                         // Ignore partial inputs
 292                         if (Compile (input, out compiled) != null){
 293                                 // Error, the input was partial.
 294                                 return null;
 295                         }
 296
 297                         // Either null (on error) or the compiled method.
 298                         return compiled;
 299                 }
 300
 301                 static MethodInfo listener_proxy_value;
 302                 internal void EmitValueChangedCallback (EmitContext ec, string name, TypeSpec type, Location loc)
 303                 {
 304                         if (listener_id == null)
 305                                 listener_id = ListenerProxy.Register (ModificationListener);
 306
 307                         if (listener_proxy_value == null)
 308                                 listener_proxy_value = typeof (ListenerProxy).GetMethod ("ValueChanged");
 309
 310 #if STATIC
 311                         throw new NotSupportedException ();
 312 #else
 313                         // object value, int row, int col, string name, int listenerId
 314                         if (type.IsStructOrEnum)
 315                                 ec.Emit (OpCodes.Box, type);
 316
 317                         ec.EmitInt (loc.Row);
 318                         ec.EmitInt (loc.Column);
 319                         ec.Emit (OpCodes.Ldstr, name);
 320                         ec.EmitInt (listener_id.Value);
 321                         ec.Emit (OpCodes.Call, listener_proxy_value);
 322 #endif
 323                 }
 324
 325                 /// <summary>
 326                 ///   Evaluates and expression or statement and returns any result values.
 327                 /// </summary>
 328                 /// <remarks>
 329                 ///   Evaluates the input string as a C# expression or
 330                 ///   statement.  If the input string is an expression
 331                 ///   the result will be stored in the result variable
 332                 ///   and the result_set variable will be set to true.
 333                 ///
 334                 ///   It is necessary to use the result/result_set
 335                 ///   pair to identify when a result was set (for
 336                 ///   example, execution of user-provided input can be
 337                 ///   an expression, a statement or others, and
 338                 ///   result_set would only be set if the input was an
 339                 ///   expression.
 340                 ///
 341                 ///   If the return value of this function is null,
 342                 ///   this indicates that the parsing was complete.
 343                 ///   If the return value is a string, it indicates
 344                 ///   that the input is partial and that the user
 345                 ///   should provide an updated string.
 346                 /// </remarks>
 347                 public string Evaluate (string input, out object result, out bool result_set)
 348                 {
 349                         CompiledMethod compiled;
 350
 351                         result_set = false;
 352                         result = null;
 353
 354                         input = Compile (input, out compiled);
 355                         if (input != null)
 356                                 return input;
 357
 358                         if (compiled == null)
 359                                 return null;
 360
 361                         //
 362                         // The code execution does not need to keep the compiler lock
 363                         //
 364                         object retval = typeof (QuitValue);
 365
 366                         try {
 367                                 invoke_thread = System.Threading.Thread.CurrentThread;
 368                                 invoking = true;
 369                                 compiled (ref retval);
 370                         } catch (ThreadAbortException e){
 371                                 Thread.ResetAbort ();
 372                                 Console.WriteLine ("Interrupted!\n{0}", e);
 373                         } finally {
 374                                 invoking = false;
 375
 376                                 if (listener_id != null) {
 377                                         ListenerProxy.Unregister (listener_id.Value);
 378                                         listener_id = null;
 379                                 }
 380                         }
 381
 382                         //
 383                         // We use a reference to a compiler type, in this case
 384                         // Driver as a flag to indicate that this was a statement
 385                         //
 386                         if (!ReferenceEquals (retval, typeof (QuitValue))) {
 387                                 result_set = true;
 388                                 result = retval;
 389                         }
 390
 391                         return null;
 392                 }
 393
 394                 public string [] GetCompletions (string input, out string prefix)
 395                 {
 396                         prefix = "";
 397                         if (input == null || input.Length == 0)
 398                                 return null;
 399
 400                         lock (evaluator_lock){
 401                                 if (!inited)
 402                                         Init ();
 403
 404                                 bool partial_input;
 405                                 CSharpParser parser = ParseString (ParseMode.GetCompletions, input, out partial_input);
 406                                 if (parser == null){
 407                                         return null;
 408                                 }
 409
 410                                 Class host = parser.InteractiveResult;
 411
 412                                 var base_class_imported = importer.ImportType (base_class);
 413                                 var baseclass_list = new List<FullNamedExpression> (1) {
 414                                         new TypeExpression (base_class_imported, host.Location)
 415                                 };
 416                                 host.SetBaseTypes (baseclass_list);
 417
 418 #if NET_4_0
 419                                 var access = AssemblyBuilderAccess.RunAndCollect;
 420 #else
 421                                 var access = AssemblyBuilderAccess.Run;
 422 #endif
 423                                 var a = new AssemblyDefinitionDynamic (module, "completions");
 424                                 a.Create (AppDomain.CurrentDomain, access);
 425                                 module.SetDeclaringAssembly (a);
 426
 427                                 // Need to setup MemberCache
 428                                 host.CreateContainer ();
 429                                 // Need to setup base type
 430                                 host.DefineContainer ();
 431
 432                                 var method = host.Members[0] as Method;
 433                                 BlockContext bc = new BlockContext (method, method.Block, ctx.BuiltinTypes.Void);
 434
 435                                 try {
 436                                         method.Block.Resolve (bc, method);
 437                                 } catch (CompletionResult cr) {
 438                                         prefix = cr.BaseText;
 439                                         return cr.Result;
 440                                 }
 441                         }
 442                         return null;
 443                 }
 444
 445                 /// <summary>
 446                 ///   Executes the given expression or statement.
 447                 /// </summary>
 448                 /// <remarks>
 449                 ///    Executes the provided statement, returns true
 450                 ///    on success, false on parsing errors.  Exceptions
 451                 ///    might be thrown by the called code.
 452                 /// </remarks>
 453                 public bool Run (string statement)
 454                 {
 455                         object result;
 456                         bool result_set;
 457
 458                         return Evaluate (statement, out result, out result_set) == null;
 459                 }
 460
 461                 /// <summary>
 462                 ///   Evaluates and expression or statement and returns the result.
 463                 /// </summary>
 464                 /// <remarks>
 465                 ///   Evaluates the input string as a C# expression or
 466                 ///   statement and returns the value.
 467                 ///
 468                 ///   This method will throw an exception if there is a syntax error,
 469                 ///   of if the provided input is not an expression but a statement.
 470                 /// </remarks>
 471                 public object Evaluate (string input)
 472                 {
 473                         object result;
 474                         bool result_set;
 475
 476                         string r = Evaluate (input, out result, out result_set);
 477
 478                         if (r != null)
 479                                 throw new ArgumentException ("Syntax error on input: partial input");
 480
 481                         if (result_set == false)
 482                                 throw new ArgumentException ("The expression failed to resolve");
 483
 484                         return result;
 485                 }
 486
 487                 /// <summary>
 488                 /// Experimental!
 489                 /// </summary>
 490                 public ValueModificationHandler ModificationListener { get; set; }
 491
 492                 enum InputKind {
 493                         EOF,
 494                         StatementOrExpression,
 495                         CompilationUnit,
 496                         Error
 497                 }
 498
 499                 //
 500                 // Deambiguates the input string to determine if we
 501                 // want to process a statement or if we want to
 502                 // process a compilation unit.
 503                 //
 504                 // This is done using a top-down predictive parser,
 505                 // since the yacc/jay parser can not deambiguage this
 506                 // without more than one lookahead token.   There are very
 507                 // few ambiguities.
 508                 //
 509                 InputKind ToplevelOrStatement (SeekableStreamReader seekable)
 510                 {
 511                         Tokenizer tokenizer = new Tokenizer (seekable, source_file, new ParserSession (), ctx.Report);
 512
 513                         // Prefer contextual block keywords over identifiers
 514                         tokenizer.parsing_block++;
 515
 516                         int t = tokenizer.token ();
 517                         switch (t){
 518                         case Token.EOF:
 519                                 return InputKind.EOF;
 520
 521                         // These are toplevels
 522                         case Token.EXTERN:
 523                         case Token.OPEN_BRACKET:
 524                         case Token.ABSTRACT:
 525                         case Token.CLASS:
 526                         case Token.ENUM:
 527                         case Token.INTERFACE:
 528                         case Token.INTERNAL:
 529                         case Token.NAMESPACE:
 530                         case Token.PRIVATE:
 531                         case Token.PROTECTED:
 532                         case Token.PUBLIC:
 533                         case Token.SEALED:
 534                         case Token.STATIC:
 535                         case Token.STRUCT:
 536                                 return InputKind.CompilationUnit;
 537
 538                         // Definitely expression
 539                         case Token.FIXED:
 540                         case Token.BOOL:
 541                         case Token.BYTE:
 542                         case Token.CHAR:
 543                         case Token.DECIMAL:
 544                         case Token.DOUBLE:
 545                         case Token.FLOAT:
 546                         case Token.INT:
 547                         case Token.LONG:
 548                         case Token.NEW:
 549                         case Token.OBJECT:
 550                         case Token.SBYTE:
 551                         case Token.SHORT:
 552                         case Token.STRING:
 553                         case Token.UINT:
 554                         case Token.ULONG:
 555                                 return InputKind.StatementOrExpression;
 556
 557                         // These need deambiguation help
 558                         case Token.USING:
 559                                 t = tokenizer.token ();
 560                                 if (t == Token.EOF)
 561                                         return InputKind.EOF;
 562
 563                                 if (t == Token.IDENTIFIER || t == Token.STATIC)
 564                                         return InputKind.CompilationUnit;
 565                                 return InputKind.StatementOrExpression;
 566
 567
 568                         // Distinguish between:
 569                         //    delegate opt_anonymous_method_signature block
 570                         //    delegate type
 571                         case Token.DELEGATE:
 572                                 t = tokenizer.token ();
 573                                 if (t == Token.EOF)
 574                                         return InputKind.EOF;
 575                                 if (t == Token.OPEN_PARENS || t == Token.OPEN_BRACE)
 576                                         return InputKind.StatementOrExpression;
 577                                 return InputKind.CompilationUnit;
 578
 579                         // Distinguih between:
 580                         //    unsafe block
 581                         //    unsafe as modifier of a type declaration
 582                         case Token.UNSAFE:
 583                                 t = tokenizer.token ();
 584                                 if (t == Token.EOF)
 585                                         return InputKind.EOF;
 586                                 if (t == Token.OPEN_PARENS)
 587                                         return InputKind.StatementOrExpression;
 588                                 return InputKind.CompilationUnit;
 589
 590                         // These are errors: we list explicitly what we had
 591                         // from the grammar, ERROR and then everything else
 592
 593                         case Token.READONLY:
 594                         case Token.OVERRIDE:
 595                         case Token.ERROR:
 596                                 return InputKind.Error;
 597
 598                         // This catches everything else allowed by
 599                         // expressions.  We could add one-by-one use cases
 600                         // if needed.
 601                         default:
 602                                 return InputKind.StatementOrExpression;
 603                         }
 604                 }
 605
 606                 //
 607                 // Parses the string @input and returns a CSharpParser if succeeful.
 608                 //
 609                 // if @silent is set to true then no errors are
 610                 // reported to the user.  This is used to do various calls to the
 611                 // parser and check if the expression is parsable.
 612                 //
 613                 // @partial_input: if @silent is true, then it returns whether the
 614                 // parsed expression was partial, and more data is needed
 615                 //
 616                 CSharpParser ParseString (ParseMode mode, string input, out bool partial_input)
 617                 {
 618                         partial_input = false;
 619                         Reset ();
 620
 621                         var enc = ctx.Settings.Encoding;
 622                         var s = new MemoryStream (enc.GetBytes (input));
 623                         SeekableStreamReader seekable = new SeekableStreamReader (s, enc);
 624
 625                         InputKind kind = ToplevelOrStatement (seekable);
 626                         if (kind == InputKind.Error){
 627                                 if (mode == ParseMode.ReportErrors)
 628                                         ctx.Report.Error (-25, "Detection Parsing Error");
 629                                 partial_input = false;
 630                                 return null;
 631                         }
 632
 633                         if (kind == InputKind.EOF){
 634                                 if (mode == ParseMode.ReportErrors)
 635                                         Console.Error.WriteLine ("Internal error: EOF condition should have been detected in a previous call with silent=true");
 636                                 partial_input = true;
 637                                 return null;
 638
 639                         }
 640                         seekable.Position = 0;
 641
 642                         source_file.DeclarationFound = false;
 643                         CSharpParser parser = new CSharpParser (seekable, source_file, new ParserSession ());
 644
 645                         if (kind == InputKind.StatementOrExpression){
 646                                 parser.Lexer.putback_char = Tokenizer.EvalStatementParserCharacter;
 647                                 parser.Lexer.parsing_block++;
 648                                 ctx.Settings.StatementMode = true;
 649                         } else {
 650                                 parser.Lexer.putback_char = Tokenizer.EvalCompilationUnitParserCharacter;
 651                                 ctx.Settings.StatementMode = false;
 652                         }
 653
 654                         if (mode == ParseMode.GetCompletions)
 655                                 parser.Lexer.CompleteOnEOF = true;
 656
 657                         ReportPrinter old_printer = null;
 658                         if ((mode == ParseMode.Silent || mode == ParseMode.GetCompletions))
 659                                 old_printer = ctx.Report.SetPrinter (new StreamReportPrinter (TextWriter.Null));
 660
 661                         try {
 662                                 parser.parse ();
 663                         } finally {
 664                                 if (ctx.Report.Errors != 0){
 665                                         if (mode != ParseMode.ReportErrors  && parser.UnexpectedEOF)
 666                                                 partial_input = true;
 667
 668                                         if (parser.undo != null)
 669                                                 parser.undo.ExecuteUndo ();
 670
 671                                         parser = null;
 672                                 }
 673
 674                                 if (old_printer != null)
 675                                         ctx.Report.SetPrinter (old_printer);
 676                         }
 677                         return parser;
 678                 }
 679
 680                 CompiledMethod CompileBlock (Class host, Undo undo, Report Report)
 681                 {
 682 #if STATIC
 683                         throw new NotSupportedException ();
 684 #else
 685                         string current_debug_name = "eval-" + count + ".dll";
 686                         ++count;
 687
 688                         AssemblyDefinitionDynamic assembly;
 689                         AssemblyBuilderAccess access;
 690
 691                         if (Environment.GetEnvironmentVariable ("SAVE") != null) {
 692                                 access = AssemblyBuilderAccess.RunAndSave;
 693                                 assembly = new AssemblyDefinitionDynamic (module, current_debug_name, current_debug_name);
 694                                 assembly.Importer = importer;
 695                         } else {
 696 #if NET_4_0
 697                                 access = AssemblyBuilderAccess.RunAndCollect;
 698 #else
 699                                 access = AssemblyBuilderAccess.Run;
 700 #endif
 701                                 assembly = new AssemblyDefinitionDynamic (module, current_debug_name);
 702                         }
 703
 704                         assembly.Create (AppDomain.CurrentDomain, access);
 705
 706                         Method expression_method;
 707                         if (host != null) {
 708                                 var base_class_imported = importer.ImportType (base_class);
 709                                 var baseclass_list = new List<FullNamedExpression> (1) {
 710                                         new TypeExpression (base_class_imported, host.Location)
 711                                 };
 712
 713                                 host.SetBaseTypes (baseclass_list);
 714
 715                                 expression_method = (Method) host.Members[0];
 716
 717                                 if ((expression_method.ModFlags & Modifiers.ASYNC) != 0) {
 718                                         //
 719                                         // Host method is async. When WaitOnTask is set we wrap it with wait
 720                                         //
 721                                         // void AsyncWait (ref object $retval) {
 722                                         //      $retval = Host();
 723                                         //      ((Task)$retval).Wait();  // When WaitOnTask is set
 724                                         // }
 725                                         //
 726                                         var p = new ParametersCompiled (
 727                                                 new Parameter (new TypeExpression (module.Compiler.BuiltinTypes.Object, Location.Null), "$retval", Parameter.Modifier.REF, null, Location.Null)
 728                                         );
 729
 730                                         var method = new Method(host, new TypeExpression(module.Compiler.BuiltinTypes.Void, Location.Null),
 731                                                 Modifiers.PUBLIC | Modifiers.STATIC, new MemberName("AsyncWait"), p, null);
 732
 733                                         method.Block = new ToplevelBlock(method.Compiler, p, Location.Null);
 734                                         method.Block.AddStatement(new StatementExpression (new SimpleAssign(
 735                                                 new SimpleName(p [0].Name, Location.Null),
 736                                                 new Invocation(new SimpleName(expression_method.MemberName.Name, Location.Null), new Arguments(0)),
 737                                                 Location.Null), Location.Null));
 738
 739                                         if (WaitOnTask) {
 740                                                 var task = new Cast (expression_method.TypeExpression, new SimpleName (p [0].Name, Location.Null), Location.Null);
 741
 742                                                 method.Block.AddStatement (new StatementExpression (new Invocation (
 743                                                                 new MemberAccess (task, "Wait", Location.Null),
 744                                                         new Arguments (0)), Location.Null));
 745                                         }
 746
 747                                         host.AddMember(method);
 748
 749                                         expression_method = method;
 750                                 }
 751
 752                                 host.CreateContainer();
 753                                 host.DefineContainer();
 754                                 host.Define();
 755
 756                         } else {
 757                                 expression_method = null;
 758                         }
 759
 760                         module.CreateContainer ();
 761
 762                         // Disable module and source file re-definition checks
 763                         module.EnableRedefinition ();
 764                         source_file.EnableRedefinition ();
 765
 766                         module.Define ();
 767
 768                         if (Report.Errors != 0){
 769                                 if (undo != null)
 770                                         undo.ExecuteUndo ();
 771
 772                                 return null;
 773                         }
 774
 775                         if (host != null){
 776                                 host.PrepareEmit ();
 777                                 host.EmitContainer ();
 778                         }
 779
 780                         module.EmitContainer ();
 781
 782                         if (Report.Errors != 0){
 783                                 if (undo != null)
 784                                         undo.ExecuteUndo ();
 785                                 return null;
 786                         }
 787
 788                         module.CloseContainer ();
 789                         if (host != null)
 790                                 host.CloseContainer ();
 791
 792                         if (access == AssemblyBuilderAccess.RunAndSave)
 793                                 assembly.Save ();
 794
 795                         if (host == null)
 796                                 return null;
 797
 798                         //
 799                         // Unlike Mono, .NET requires that the MethodInfo is fetched, it cant
 800                         // work from MethodBuilders.   Retarded, I know.
 801                         //
 802                         var tt = assembly.Builder.GetType (host.TypeBuilder.Name);
 803                         var mi = tt.GetMethod (expression_method.MemberName.Name);
 804
 805                         //
 806                         // We need to then go from FieldBuilder to FieldInfo
 807                         // or reflection gets confused (it basically gets confused, and variables override each
 808                         // other).
 809                         //
 810                         foreach (var member in host.Members) {
 811                                 var field = member as Field;
 812                                 if (field == null)
 813                                         continue;
 814
 815                                 var fi = tt.GetField (field.Name);
 816
 817                                 Tuple<FieldSpec, FieldInfo> old;
 818
 819                                 // If a previous value was set, nullify it, so that we do
 820                                 // not leak memory
 821                                 if (fields.TryGetValue (field.Name, out old)) {
 822                                         if (old.Item1.MemberType.IsStruct) {
 823                                                 //
 824                                                 // TODO: Clear fields for structs
 825                                                 //
 826                                         } else {
 827                                                 try {
 828                                                         old.Item2.SetValue (null, null);
 829                                                 } catch {
 830                                                 }
 831                                         }
 832                                 }
 833
 834                                 fields[field.Name] = Tuple.Create (field.Spec, fi);
 835                         }
 836
 837                         return (CompiledMethod) System.Delegate.CreateDelegate (typeof (CompiledMethod), mi);
 838 #endif
 839                 }
 840
 841                 /// <summary>
 842                 ///   A sentinel value used to indicate that no value was
 843                 ///   was set by the compiled function.   This is used to
 844                 ///   differentiate between a function not returning a
 845                 ///   value and null.
 846                 /// </summary>
 847                 internal static class QuitValue { }
 848
 849                 internal Tuple<FieldSpec, FieldInfo> LookupField (string name)
 850                 {
 851                         Tuple<FieldSpec, FieldInfo> fi;
 852                         fields.TryGetValue (name, out fi);
 853                         return fi;
 854                 }
 855
 856                 static string Quote (string s)
 857                 {
 858                         if (s.IndexOf ('"') != -1)
 859                                 s = s.Replace ("\"", "\\\"");
 860
 861                         return "\"" + s + "\"";
 862                 }
 863
 864                 public string GetUsing ()
 865                 {
 866                         if (source_file == null || source_file.Usings == null)
 867                                 return string.Empty;
 868
 869                         StringBuilder sb = new StringBuilder ();
 870                         // TODO:
 871                         //foreach (object x in ns.using_alias_list)
 872                         //    sb.AppendFormat ("using {0};\n", x);
 873
 874                         foreach (var ue in source_file.Usings) {
 875                                 if (ue.Alias != null || ue.ResolvedExpression == null)
 876                                         continue;
 877
 878                                 sb.AppendFormat("using {0};", ue.ToString ());
 879                                 sb.Append (Environment.NewLine);
 880                         }
 881
 882                         return sb.ToString ();
 883                 }
 884
 885                 internal List<string> GetUsingList ()
 886                 {
 887                         var res = new List<string> ();
 888
 889                         if (source_file == null || source_file.Usings == null)
 890                                 return res;
 891
 892                         foreach (var ue in source_file.Usings)
 893                         {
 894                                 if (ue.Alias != null || ue.ResolvedExpression == null)
 895                                         continue;
 896
 897                                 res.Add (ue.NamespaceExpression.Name);
 898                         }
 899
 900                         return res;
 901                 }
 902
 903                 internal string [] GetVarNames ()
 904                 {
 905                         lock (evaluator_lock){
 906                                 return new List<string> (fields.Keys).ToArray ();
 907                         }
 908                 }
 909
 910                 public string GetVars ()
 911                 {
 912                         lock (evaluator_lock){
 913                                 StringBuilder sb = new StringBuilder ();
 914
 915                                 foreach (var de in fields){
 916                                         var fi = LookupField (de.Key);
 917                                         object value;
 918                                         try {
 919                                                 value = fi.Item2.GetValue (null);
 920                                                 if (value is string)
 921                                                         value = Quote ((string)value);
 922                                         } catch {
 923                                                 value = "<error reading value>";
 924                                         }
 925
 926                                         sb.AppendFormat ("{0} {1} = {2}", fi.Item1.MemberType.GetSignatureForError (), de.Key, value);
 927                                         sb.AppendLine ();
 928                                 }
 929
 930                                 return sb.ToString ();
 931                         }
 932                 }
 933
 934                 /// <summary>
 935                 ///    Loads the given assembly and exposes the API to the user.
 936                 /// </summary>
 937                 public void LoadAssembly (string file)
 938                 {
 939                         var loader = new DynamicLoader (importer, ctx);
 940                         var assembly = loader.LoadAssemblyFile (file, false);
 941                         if (assembly == null)
 942                                 return;
 943
 944                         lock (evaluator_lock){
 945                                 importer.ImportAssembly (assembly, module.GlobalRootNamespace);
 946                         }
 947                 }
 948
 949                 /// <summary>
 950                 ///    Exposes the API of the given assembly to the Evaluator
 951                 /// </summary>
 952                 public void ReferenceAssembly (Assembly a)
 953                 {
 954                         lock (evaluator_lock){
 955                                 importer.ImportAssembly (a, module.GlobalRootNamespace);
 956                         }
 957                 }
 958         }
 959
 960
 961         /// <summary>
 962         ///   A delegate that can be used to invoke the
 963         ///   compiled expression or statement.
 964         /// </summary>
 965         /// <remarks>
 966         ///   Since the Compile methods will compile
 967         ///   statements and expressions into the same
 968         ///   delegate, you can tell if a value was returned
 969         ///   by checking whether the returned value is of type
 970         ///   NoValueSet.
 971         /// </remarks>
 972
 973         public delegate void CompiledMethod (ref object retvalue);
 974
 975         /// <summary>
 976         ///   The default base class for every interaction line
 977         /// </summary>
 978         /// <remarks>
 979         ///   The expressions and statements behave as if they were
 980         ///   a static method of this class.   The InteractiveBase class
 981         ///   contains a number of useful methods, but can be overwritten
 982         ///   by setting the InteractiveBaseType property in the Evaluator
 983         /// </remarks>
 984         public class InteractiveBase {
 985                 /// <summary>
 986                 ///   Determines where the standard output of methods in this class will go.
 987                 /// </summary>
 988                 public static TextWriter Output = Console.Out;
 989
 990                 /// <summary>
 991                 ///   Determines where the standard error of methods in this class will go.
 992                 /// </summary>
 993                 public static TextWriter Error = Console.Error;
 994
 995                 /// <summary>
 996                 ///   The primary prompt used for interactive use.
 997                 /// </summary>
 998                 public static string Prompt             = "csharp> ";
 999
1000                 /// <summary>
1001                 ///   The secondary prompt used for interactive use (used when
1002                 ///   an expression is incomplete).
1003                 /// </summary>
1004                 public static string ContinuationPrompt = "      > ";
1005
1006                 /// <summary>
1007                 ///   Used to signal that the user has invoked the  `quit' statement.
1008                 /// </summary>
1009                 public static bool QuitRequested;
1010
1011                 public static Evaluator Evaluator;
1012
1013                 /// <summary>
1014                 ///   Shows all the variables defined so far.
1015                 /// </summary>
1016                 static public void ShowVars ()
1017                 {
1018                         Output.Write (Evaluator.GetVars ());
1019                         Output.Flush ();
1020                 }
1021
1022                 /// <summary>
1023                 ///   Displays the using statements in effect at this point.
1024                 /// </summary>
1025                 static public void ShowUsing ()
1026                 {
1027                         Output.Write (Evaluator.GetUsing ());
1028                         Output.Flush ();
1029                 }
1030
1031                 /// <summary>
1032                 ///   Times the execution of the given delegate
1033                 /// </summary>
1034                 static public TimeSpan Time (Action a)
1035                 {
1036                         DateTime start = DateTime.Now;
1037                         a ();
1038                         return DateTime.Now - start;
1039                 }
1040
1041                 /// <summary>
1042                 ///   Loads the assemblies from a package
1043                 /// </summary>
1044                 /// <remarks>
1045                 ///   Loads the assemblies from a package.   This is equivalent
1046                 ///   to passing the -pkg: command line flag to the C# compiler
1047                 ///   on the command line.
1048                 /// </remarks>
1049                 static public void LoadPackage (string pkg)
1050                 {
1051                         if (pkg == null){
1052                                 Error.WriteLine ("Invalid package specified");
1053                                 return;
1054                         }
1055
1056                         string pkgout = Driver.GetPackageFlags (pkg, null);
1057
1058                         string [] xargs = pkgout.Trim (new Char [] {' ', '\n', '\r', '\t'}).
1059                                 Split (new Char [] { ' ', '\t'});
1060
1061                         foreach (string s in xargs){
1062                                 if (s.StartsWith ("-r:") || s.StartsWith ("/r:") || s.StartsWith ("/reference:")){
1063                                         string lib = s.Substring (s.IndexOf (':')+1);
1064
1065                                         Evaluator.LoadAssembly (lib);
1066                                         continue;
1067                                 }
1068                         }
1069                 }
1070
1071                 /// <summary>
1072                 ///   Loads the assembly
1073                 /// </summary>
1074                 /// <remarks>
1075                 ///   Loads the specified assembly and makes its types
1076                 ///   available to the evaluator.  This is equivalent
1077                 ///   to passing the -pkg: command line flag to the C#
1078                 ///   compiler on the command line.
1079                 /// </remarks>
1080                 static public void LoadAssembly (string assembly)
1081                 {
1082                         Evaluator.LoadAssembly (assembly);
1083                 }
1084
1085                 static public void print (object obj)
1086                 {
1087                         Output.WriteLine (obj);
1088                 }
1089
1090                 static public void print (string fmt, params object [] args)
1091                 {
1092                         Output.WriteLine (fmt, args);
1093                 }
1094
1095                 /// <summary>
1096                 ///   Returns a list of available static methods.
1097                 /// </summary>
1098                 static public string help {
1099                         get {
1100                                 return "Static methods:\n" +
1101                                         "  Describe (object);       - Describes the object's type\n" +
1102                                         "  LoadPackage (package);   - Loads the given Package (like -pkg:FILE)\n" +
1103                                         "  LoadAssembly (assembly); - Loads the given assembly (like -r:ASSEMBLY)\n" +
1104                                         "  ShowVars ();             - Shows defined local variables.\n" +
1105                                         "  ShowUsing ();            - Show active using declarations.\n" +
1106                                         "  Prompt                   - The prompt used by the C# shell\n" +
1107                                         "  ContinuationPrompt       - The prompt for partial input\n" +
1108                                         "  Time (() => { });        - Times the specified code\n" +
1109                                         "  print (obj);             - Shorthand for Console.WriteLine\n" +
1110                                         "  quit;                    - You'll never believe it - this quits the repl!\n" +
1111                                         "  help;                    - This help text\n";
1112                         }
1113                 }
1114
1115                 /// <summary>
1116                 ///   Indicates to the read-eval-print-loop that the interaction should be finished.
1117                 /// </summary>
1118                 static public object quit {
1119                         get {
1120                                 QuitRequested = true;
1121
1122                                 // To avoid print null at the exit
1123                                 return typeof (Evaluator.QuitValue);
1124                         }
1125                 }
1126
1127                 /// <summary>
1128                 ///   Same as quit - useful in script scenerios
1129                 /// </summary>
1130                 static public void Quit () {
1131                         QuitRequested = true;
1132                 }
1133
1134 #if !NET_2_1
1135                 /// <summary>
1136                 ///   Describes an object or a type.
1137                 /// </summary>
1138                 /// <remarks>
1139                 ///   This method will show a textual representation
1140                 ///   of the object's type.  If the object is a
1141                 ///   System.Type it renders the type directly,
1142                 ///   otherwise it renders the type returned by
1143                 ///   invoking GetType on the object.
1144                 /// </remarks>
1145                 static public string Describe (object x)
1146                 {
1147                         if (x == null)
1148                                 return "<null>";
1149
1150                         var type = x as Type ?? x.GetType ();
1151
1152                         StringWriter sw = new StringWriter ();
1153                         new Outline (type, sw, true, false, false).OutlineType ();
1154                         return sw.ToString ();
1155                 }
1156 #endif
1157         }
1158
1159         class InteractiveMethod : Method
1160         {
1161                 public InteractiveMethod(TypeDefinition parent, FullNamedExpression returnType, Modifiers mod, ParametersCompiled parameters)
1162                         : base(parent, returnType, mod, new MemberName("Host"), parameters, null)
1163                 {
1164                 }
1165
1166                 public void ChangeToAsync ()
1167                 {
1168                         ModFlags |= Modifiers.ASYNC;
1169                         ModFlags &= ~Modifiers.UNSAFE;
1170                         type_expr = new TypeExpression(Module.PredefinedTypes.Task.TypeSpec, Location);
1171                         parameters = ParametersCompiled.EmptyReadOnlyParameters;
1172                 }
1173
1174                 public override string GetSignatureForError()
1175                 {
1176                         return "InteractiveHost";
1177                 }
1178         }
1179
1180         class HoistedEvaluatorVariable : HoistedVariable
1181         {
1182                 public HoistedEvaluatorVariable (Field field)
1183                         : base (null, field)
1184                 {
1185                 }
1186
1187                 protected override FieldExpr GetFieldExpression (EmitContext ec)
1188                 {
1189                         return new FieldExpr (field, field.Location);
1190                 }
1191         }
1192
1193         /// <summary>
1194         ///    A class used to assign values if the source expression is not void
1195         ///
1196         ///    Used by the interactive shell to allow it to call this code to set
1197         ///    the return value for an invocation.
1198         /// </summary>
1199         class OptionalAssign : SimpleAssign {
1200                 public OptionalAssign (Expression s, Location loc)
1201                         : base (null, s, loc)
1202                 {
1203                 }
1204
1205                 public override Location StartLocation {
1206                         get {
1207                                 return Location.Null;
1208                         }
1209                 }
1210
1211                 protected override Expression DoResolve (ResolveContext ec)
1212                 {
1213                         Expression clone = source.Clone (new CloneContext ());
1214
1215                         clone = clone.Resolve (ec);
1216                         if (clone == null)
1217                                 return null;
1218
1219                         //
1220                         // A useful feature for the REPL: if we can resolve the expression
1221                         // as a type, Describe the type;
1222                         //
1223                         if (ec.Module.Evaluator.DescribeTypeExpressions && !(ec.CurrentAnonymousMethod is AsyncInitializer)) {
1224                                 var old_printer = ec.Report.SetPrinter (new SessionReportPrinter ());
1225                                 Expression tclone;
1226                                 try {
1227                                         // Note: clone context cannot be shared otherwise block mapping would leak
1228                                         tclone = source.Clone (new CloneContext ());
1229                                         tclone = tclone.Resolve (ec, ResolveFlags.Type);
1230                                         if (ec.Report.Errors > 0)
1231                                                 tclone = null;
1232                                 } finally {
1233                                         ec.Report.SetPrinter (old_printer);
1234                                 }
1235
1236                                 if (tclone is TypeExpr) {
1237                                         Arguments args = new Arguments (1);
1238                                         args.Add (new Argument (new TypeOf ((TypeExpr) clone, Location)));
1239                                         return new Invocation (new SimpleName ("Describe", Location), args).Resolve (ec);
1240                                 }
1241                         }
1242
1243                         // This means its really a statement.
1244                         if (clone.Type.Kind == MemberKind.Void || clone is DynamicInvocation || clone is Assign) {
1245                                 return clone;
1246                         }
1247
1248                         source = clone;
1249
1250                         var host = (Method) ec.MemberContext.CurrentMemberDefinition;
1251
1252                         if (host.ParameterInfo.IsEmpty) {
1253                                 eclass = ExprClass.Value;
1254                                 type = InternalType.FakeInternalType;
1255                                 return this;
1256                         }
1257
1258                         target = new SimpleName (host.ParameterInfo[0].Name, Location);
1259
1260                         return base.DoResolve (ec);
1261                 }
1262
1263                 public override void EmitStatement(EmitContext ec)
1264                 {
1265                         if (target == null) {
1266                                 source.Emit (ec);
1267                                 return;
1268                         }
1269
1270                         base.EmitStatement(ec);
1271                 }
1272         }
1273
1274         public class Undo
1275         {
1276                 List<Action> undo_actions;
1277
1278                 public void AddTypeContainer (TypeContainer current_container, TypeDefinition tc)
1279                 {
1280                         if (current_container == tc){
1281                                 Console.Error.WriteLine ("Internal error: inserting container into itself");
1282                                 return;
1283                         }
1284
1285                         if (undo_actions == null)
1286                                 undo_actions = new List<Action> ();
1287
1288                         if (current_container.Containers != null)
1289                         {
1290                                 var existing = current_container.Containers.FirstOrDefault (l => l.MemberName.Basename == tc.MemberName.Basename);
1291                                 if (existing != null) {
1292                                         current_container.RemoveContainer (existing);
1293                                         undo_actions.Add (() => current_container.AddTypeContainer (existing));
1294                                 }
1295                         }
1296
1297                         undo_actions.Add (() => current_container.RemoveContainer (tc));
1298                 }
1299
1300                 public void ExecuteUndo ()
1301                 {
1302                         if (undo_actions == null)
1303                                 return;
1304
1305                         foreach (var p in undo_actions){
1306                                 p ();
1307                         }
1308
1309                         undo_actions = null;
1310                 }
1311         }
1312
1313         static class ListenerProxy
1314         {
1315                 static readonly Dictionary<int, ValueModificationHandler> listeners = new Dictionary<int, ValueModificationHandler> ();
1316
1317                 static int counter;
1318
1319                 public static int Register (ValueModificationHandler listener)
1320                 {
1321                         lock (listeners) {
1322                                 var id = counter++;
1323                                 listeners.Add (id, listener);
1324                                 return id;
1325                         }
1326                 }
1327
1328                 public static void Unregister (int listenerId)
1329                 {
1330                         lock (listeners) {
1331                                 listeners.Remove (listenerId);
1332                         }
1333                 }
1334
1335                 public static void ValueChanged (object value, int row, int col, string name, int listenerId)
1336                 {
1337                         ValueModificationHandler action;
1338                         lock (listeners) {
1339                                 if (!listeners.TryGetValue (listenerId, out action))
1340                                         return;
1341                         }
1342
1343                         action (name, row, col, value);
1344                 }
1345         }
1346 }