* codegen.cs (EmitContext): Remove ResolvingTypeTree.
[mono.git] / mcs / mcs / codegen.cs
1 //
2 // codegen.cs: The code generator
3 //
4 // Author:
5 //   Miguel de Icaza (miguel@ximian.com)
6 //
7 // (C) 2001, 2002, 2003 Ximian, Inc.
8 // (C) 2004 Novell, Inc.
9 //
10 //#define PRODUCTION
11 using System;
12 using System.IO;
13 using System.Collections;
14 using System.Collections.Specialized;
15 using System.Reflection;
16 using System.Reflection.Emit;
17 using System.Runtime.InteropServices;
18 using System.Security;
19 using System.Security.Cryptography;
20 using System.Security.Permissions;
21
22 using Mono.Security.Cryptography;
23
24 namespace Mono.CSharp {
25
26         /// <summary>
27         ///    Code generator class.
28         /// </summary>
29         public class CodeGen {
30                 static AppDomain current_domain;
31                 static public SymbolWriter SymbolWriter;
32
33                 public static AssemblyClass Assembly;
34                 public static ModuleClass Module;
35
36                 static CodeGen ()
37                 {
38                         Assembly = new AssemblyClass ();
39                         Module = new ModuleClass (RootContext.Unsafe);
40                 }
41
42                 public static string Basename (string name)
43                 {
44                         int pos = name.LastIndexOf ('/');
45
46                         if (pos != -1)
47                                 return name.Substring (pos + 1);
48
49                         pos = name.LastIndexOf ('\\');
50                         if (pos != -1)
51                                 return name.Substring (pos + 1);
52
53                         return name;
54                 }
55
56                 public static string Dirname (string name)
57                 {
58                         int pos = name.LastIndexOf ('/');
59
60                         if (pos != -1)
61                                 return name.Substring (0, pos);
62
63                         pos = name.LastIndexOf ('\\');
64                         if (pos != -1)
65                                 return name.Substring (0, pos);
66
67                         return ".";
68                 }
69
70                 static string TrimExt (string name)
71                 {
72                         int pos = name.LastIndexOf ('.');
73
74                         return name.Substring (0, pos);
75                 }
76
77                 static public string FileName;
78
79                 //
80                 // Initializes the symbol writer
81                 //
82                 static void InitializeSymbolWriter (string filename)
83                 {
84                         SymbolWriter = SymbolWriter.GetSymbolWriter (Module.Builder, filename);
85
86                         //
87                         // If we got an ISymbolWriter instance, initialize it.
88                         //
89                         if (SymbolWriter == null) {
90                                 Report.Warning (
91                                         -18, "Could not find the symbol writer assembly (Mono.CompilerServices.SymbolWriter.dll). This is normally an installation problem. Please make sure to compile and install the mcs/class/Mono.CompilerServices.SymbolWriter directory.");
92                                 return;
93                         }
94                 }
95
96                 //
97                 // Initializes the code generator variables
98                 //
99                 static public void Init (string name, string output, bool want_debugging_support)
100                 {
101                         FileName = output;
102                         AssemblyName an = Assembly.GetAssemblyName (name, output);
103
104                         if (an.KeyPair != null) {
105                                 // If we are going to strong name our assembly make
106                                 // sure all its refs are strong named
107                                 foreach (Assembly a in TypeManager.GetAssemblies ()) {
108                                         AssemblyName ref_name = a.GetName ();
109                                         byte [] b = ref_name.GetPublicKeyToken ();
110                                         if (b == null || b.Length == 0) {
111                                                 Report.Warning (1577, "Assembly generation failed " +
112                                                                 "-- Referenced assembly '" +
113                                                                 ref_name.Name +
114                                                                 "' does not have a strong name.");
115                                                 //Environment.Exit (1);
116                                         }
117                                 }
118                         }
119                         
120                         current_domain = AppDomain.CurrentDomain;
121
122                         try {
123                                 Assembly.Builder = current_domain.DefineDynamicAssembly (an,
124                                         AssemblyBuilderAccess.Save, Dirname (name));
125                         }
126                         catch (ArgumentException) {
127                                 // specified key may not be exportable outside it's container
128                                 if (RootContext.StrongNameKeyContainer != null) {
129                                         Report.Error (1548, "Could not access the key inside the container `" +
130                                                 RootContext.StrongNameKeyContainer + "'.");
131                                         Environment.Exit (1);
132                                 }
133                                 throw;
134                         }
135                         catch (CryptographicException) {
136                                 if ((RootContext.StrongNameKeyContainer != null) || (RootContext.StrongNameKeyFile != null)) {
137                                         Report.Error (1548, "Could not use the specified key to strongname the assembly.");
138                                         Environment.Exit (1);
139                                 }
140                                 throw;
141                         }
142
143                         //
144                         // Pass a path-less name to DefineDynamicModule.  Wonder how
145                         // this copes with output in different directories then.
146                         // FIXME: figure out how this copes with --output /tmp/blah
147                         //
148                         // If the third argument is true, the ModuleBuilder will dynamically
149                         // load the default symbol writer.
150                         //
151                         Module.Builder = Assembly.Builder.DefineDynamicModule (
152                                 Basename (name), Basename (output), false);
153
154                         if (want_debugging_support)
155                                 InitializeSymbolWriter (output);
156                 }
157
158                 static public void Save (string name)
159                 {
160                         try {
161                                 Assembly.Builder.Save (Basename (name));
162                         }
163                         catch (COMException) {
164                                 if ((RootContext.StrongNameKeyFile == null) || (!RootContext.StrongNameDelaySign))
165                                         throw;
166
167                                 // FIXME: it seems Microsoft AssemblyBuilder doesn't like to delay sign assemblies 
168                                 Report.Error (1548, "Couldn't delay-sign the assembly with the '" +
169                                         RootContext.StrongNameKeyFile +
170                                         "', Use MCS with the Mono runtime or CSC to compile this assembly.");
171                         }
172                         catch (System.IO.IOException io) {
173                                 Report.Error (16, "Could not write to file `"+name+"', cause: " + io.Message);
174                         }
175
176                         if (SymbolWriter != null)
177                                 SymbolWriter.WriteSymbolFile ();
178                 }
179         }
180
181         //
182         // Provides "local" store across code that can yield: locals
183         // or fields, notice that this should not be used by anonymous
184         // methods to create local storage, those only require
185         // variable mapping.
186         //
187         public class VariableStorage {
188                 FieldBuilder fb;
189                 LocalBuilder local;
190                 
191                 static int count;
192                 
193                 public VariableStorage (EmitContext ec, Type t)
194                 {
195                         count++;
196                         if (ec.InIterator)
197                                 fb = ec.CurrentIterator.MapVariable ("s_", count.ToString (), t);
198                         else
199                                 local = ec.ig.DeclareLocal (t);
200                 }
201
202                 public void EmitThis (ILGenerator ig)
203                 {
204                         if (fb != null)
205                                 ig.Emit (OpCodes.Ldarg_0);
206                 }
207
208                 public void EmitStore (ILGenerator ig)
209                 {
210                         if (fb == null)
211                                 ig.Emit (OpCodes.Stloc, local);
212                         else
213                                 ig.Emit (OpCodes.Stfld, fb);
214                 }
215
216                 public void EmitLoad (ILGenerator ig)
217                 {
218                         if (fb == null)
219                                 ig.Emit (OpCodes.Ldloc, local);
220                         else 
221                                 ig.Emit (OpCodes.Ldfld, fb);
222                 }
223
224                 public void EmitLoadAddress (ILGenerator ig)
225                 {
226                         if (fb == null)
227                                 ig.Emit (OpCodes.Ldloca, local);
228                         else 
229                                 ig.Emit (OpCodes.Ldflda, fb);
230                 }
231                 
232                 public void EmitCall (ILGenerator ig, MethodInfo mi)
233                 {
234                         // FIXME : we should handle a call like tostring
235                         // here, where boxing is needed. However, we will
236                         // never encounter that with the current usage.
237                         
238                         bool value_type_call;
239                         EmitThis (ig);
240                         if (fb == null) {
241                                 value_type_call = local.LocalType.IsValueType;
242                                 
243                                 if (value_type_call)
244                                         ig.Emit (OpCodes.Ldloca, local);
245                                 else
246                                         ig.Emit (OpCodes.Ldloc, local);
247                         } else {
248                                 value_type_call = fb.FieldType.IsValueType;
249                                 
250                                 if (value_type_call)
251                                         ig.Emit (OpCodes.Ldflda, fb);
252                                 else
253                                         ig.Emit (OpCodes.Ldfld, fb);
254                         }
255                         
256                         ig.Emit (value_type_call ? OpCodes.Call : OpCodes.Callvirt, mi);
257                 }
258         }
259
260         /// <summary>
261         ///   An Emit Context is created for each body of code (from methods,
262         ///   properties bodies, indexer bodies or constructor bodies)
263         /// </summary>
264         public class EmitContext {
265                 public DeclSpace DeclSpace;
266                 public DeclSpace TypeContainer;
267                 public ILGenerator   ig;
268
269                 /// <summary>
270                 ///   This variable tracks the `checked' state of the compilation,
271                 ///   it controls whether we should generate code that does overflow
272                 ///   checking, or if we generate code that ignores overflows.
273                 ///
274                 ///   The default setting comes from the command line option to generate
275                 ///   checked or unchecked code plus any source code changes using the
276                 ///   checked/unchecked statements or expressions.   Contrast this with
277                 ///   the ConstantCheckState flag.
278                 /// </summary>
279                 
280                 public bool CheckState;
281
282                 /// <summary>
283                 ///   The constant check state is always set to `true' and cant be changed
284                 ///   from the command line.  The source code can change this setting with
285                 ///   the `checked' and `unchecked' statements and expressions. 
286                 /// </summary>
287                 public bool ConstantCheckState;
288
289                 /// <summary>
290                 ///   Whether we are emitting code inside a static or instance method
291                 /// </summary>
292                 public bool IsStatic;
293
294                 /// <summary>
295                 ///   Whether the actual created method is static or instance method.
296                 ///   Althoug the method might be declared as `static', if an anonymous
297                 ///   method is involved, we might turn this into an instance method.
298                 ///
299                 ///   So this reflects the low-level staticness of the method, while
300                 ///   IsStatic represents the semantic, high-level staticness.
301                 /// </summary>
302                 public bool MethodIsStatic;
303
304                 /// <summary>
305                 ///   Whether we are emitting a field initializer
306                 /// </summary>
307                 public bool IsFieldInitializer;
308
309                 /// <summary>
310                 ///   The value that is allowed to be returned or NULL if there is no
311                 ///   return type.
312                 /// </summary>
313                 public Type ReturnType;
314
315                 /// <summary>
316                 ///   Points to the Type (extracted from the TypeContainer) that
317                 ///   declares this body of code
318                 /// </summary>
319                 public Type ContainerType;
320                 
321                 /// <summary>
322                 ///   Whether this is generating code for a constructor
323                 /// </summary>
324                 public bool IsConstructor;
325
326                 /// <summary>
327                 ///   Whether we're control flow analysis enabled
328                 /// </summary>
329                 public bool DoFlowAnalysis;
330                 
331                 /// <summary>
332                 ///   Keeps track of the Type to LocalBuilder temporary storage created
333                 ///   to store structures (used to compute the address of the structure
334                 ///   value on structure method invocations)
335                 /// </summary>
336                 public Hashtable temporary_storage;
337
338                 public Block CurrentBlock;
339
340                 public int CurrentFile;
341
342                 /// <summary>
343                 ///   The location where we store the return value.
344                 /// </summary>
345                 LocalBuilder return_value;
346
347                 /// <summary>
348                 ///   The location where return has to jump to return the
349                 ///   value
350                 /// </summary>
351                 public Label ReturnLabel;
352
353                 /// <summary>
354                 ///   If we already defined the ReturnLabel
355                 /// </summary>
356                 public bool HasReturnLabel;
357
358                 /// <summary>
359                 ///   Whether we are inside an iterator block.
360                 /// </summary>
361                 public bool InIterator;
362
363                 public bool IsLastStatement;
364
365                 /// <summary>
366                 ///   Whether remapping of locals, parameters and fields is turned on.
367                 ///   Used by iterators and anonymous methods.
368                 /// </summary>
369                 public bool RemapToProxy;
370
371                 /// <summary>
372                 ///  Whether we are inside an unsafe block
373                 /// </summary>
374                 public bool InUnsafe;
375
376                 /// <summary>
377                 ///  Whether we are in a `fixed' initialization
378                 /// </summary>
379                 public bool InFixedInitializer;
380
381                 /// <summary>
382                 ///  Whether we are inside an anonymous method.
383                 /// </summary>
384                 public AnonymousMethod CurrentAnonymousMethod;
385                 
386                 /// <summary>
387                 ///   Location for this EmitContext
388                 /// </summary>
389                 public Location loc;
390
391                 /// <summary>
392                 ///   Inside an enum definition, we do not resolve enumeration values
393                 ///   to their enumerations, but rather to the underlying type/value
394                 ///   This is so EnumVal + EnumValB can be evaluated.
395                 ///
396                 ///   There is no "E operator + (E x, E y)", so during an enum evaluation
397                 ///   we relax the rules
398                 /// </summary>
399                 public bool InEnumContext;
400
401                 /// <summary>
402                 ///   Anonymous methods can capture local variables and fields,
403                 ///   this object tracks it.  It is copied from the TopLevelBlock
404                 ///   field.
405                 /// </summary>
406                 public CaptureContext capture_context;
407
408                 /// <summary>
409                 /// Trace when method is called and is obsolete then this member suppress message
410                 /// when call is inside next [Obsolete] method or type.
411                 /// </summary>
412                 public bool TestObsoleteMethodUsage = true;
413
414                 /// <summary>
415                 ///    The current iterator
416                 /// </summary>
417                 public Iterator CurrentIterator;
418
419                 /// <summary>
420                 ///    Whether we are in the resolving stage or not
421                 /// </summary>
422                 enum Phase {
423                         Created,
424                         Resolving,
425                         Emitting
426                 }
427                 
428                 Phase current_phase;
429                 FlowBranching current_flow_branching;
430                 
431                 public EmitContext (DeclSpace parent, DeclSpace ds, Location l, ILGenerator ig,
432                                     Type return_type, int code_flags, bool is_constructor)
433                 {
434                         this.ig = ig;
435
436                         TypeContainer = parent;
437                         DeclSpace = ds;
438                         CheckState = RootContext.Checked;
439                         ConstantCheckState = true;
440
441                         IsStatic = (code_flags & Modifiers.STATIC) != 0;
442                         MethodIsStatic = IsStatic;
443                         InIterator = (code_flags & Modifiers.METHOD_YIELDS) != 0;
444                         RemapToProxy = InIterator;
445                         ReturnType = return_type;
446                         IsConstructor = is_constructor;
447                         CurrentBlock = null;
448                         CurrentFile = 0;
449                         current_phase = Phase.Created;
450                         
451                         if (parent != null){
452                                 // Can only be null for the ResolveType contexts.
453                                 ContainerType = parent.TypeBuilder;
454                                 if (parent.UnsafeContext)
455                                         InUnsafe = true;
456                                 else
457                                         InUnsafe = (code_flags & Modifiers.UNSAFE) != 0;
458                         }
459                         loc = l;
460
461                         if (ReturnType == TypeManager.void_type)
462                                 ReturnType = null;
463                 }
464
465                 public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
466                                     Type return_type, int code_flags, bool is_constructor)
467                         : this (tc, tc, l, ig, return_type, code_flags, is_constructor)
468                 {
469                 }
470
471                 public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
472                                     Type return_type, int code_flags)
473                         : this (tc, tc, l, ig, return_type, code_flags, false)
474                 {
475                 }
476
477                 public FlowBranching CurrentBranching {
478                         get {
479                                 return current_flow_branching;
480                         }
481                 }
482
483                 public bool HaveCaptureInfo {
484                         get {
485                                 return capture_context != null;
486                         }
487                 }
488
489                 // <summary>
490                 //   Starts a new code branching.  This inherits the state of all local
491                 //   variables and parameters from the current branching.
492                 // </summary>
493                 public FlowBranching StartFlowBranching (FlowBranching.BranchingType type, Location loc)
494                 {
495                         current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, null, loc);
496                         return current_flow_branching;
497                 }
498
499                 // <summary>
500                 //   Starts a new code branching for block `block'.
501                 // </summary>
502                 public FlowBranching StartFlowBranching (Block block)
503                 {
504                         FlowBranching.BranchingType type;
505
506                         if (CurrentBranching.Type == FlowBranching.BranchingType.Switch)
507                                 type = FlowBranching.BranchingType.SwitchSection;
508                         else
509                                 type = FlowBranching.BranchingType.Block;
510
511                         current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, block, block.StartLocation);
512                         return current_flow_branching;
513                 }
514
515                 public FlowBranchingException StartFlowBranching (ExceptionStatement stmt)
516                 {
517                         FlowBranchingException branching = new FlowBranchingException (
518                                 CurrentBranching, stmt);
519                         current_flow_branching = branching;
520                         return branching;
521                 }
522
523                 // <summary>
524                 //   Ends a code branching.  Merges the state of locals and parameters
525                 //   from all the children of the ending branching.
526                 // </summary>
527                 public FlowBranching.UsageVector DoEndFlowBranching ()
528                 {
529                         FlowBranching old = current_flow_branching;
530                         current_flow_branching = current_flow_branching.Parent;
531
532                         return current_flow_branching.MergeChild (old);
533                 }
534
535                 // <summary>
536                 //   Ends a code branching.  Merges the state of locals and parameters
537                 //   from all the children of the ending branching.
538                 // </summary>
539                 public FlowBranching.Reachability EndFlowBranching ()
540                 {
541                         FlowBranching.UsageVector vector = DoEndFlowBranching ();
542
543                         return vector.Reachability;
544                 }
545
546                 // <summary>
547                 //   Kills the current code branching.  This throws away any changed state
548                 //   information and should only be used in case of an error.
549                 // </summary>
550                 public void KillFlowBranching ()
551                 {
552                         current_flow_branching = current_flow_branching.Parent;
553                 }
554
555                 public void CaptureVariable (LocalInfo li)
556                 {
557                         capture_context.AddLocal (CurrentAnonymousMethod, li);
558                         li.IsCaptured = true;
559                 }
560
561                 public void CaptureParameter (string name, Type t, int idx)
562                 {
563                         capture_context.AddParameter (this, CurrentAnonymousMethod, name, t, idx);
564                 }
565
566                 public void CaptureThis ()
567                 {
568                         capture_context.CaptureThis ();
569                 }
570                 
571                 
572                 //
573                 // Use to register a field as captured
574                 //
575                 public void CaptureField (FieldExpr fe)
576                 {
577                         capture_context.AddField (fe);
578                 }
579
580                 //
581                 // Whether anonymous methods have captured variables
582                 //
583                 public bool HaveCapturedVariables ()
584                 {
585                         if (capture_context != null)
586                                 return capture_context.HaveCapturedVariables;
587                         return false;
588                 }
589
590                 //
591                 // Whether anonymous methods have captured fields or this.
592                 //
593                 public bool HaveCapturedFields ()
594                 {
595                         if (capture_context != null)
596                                 return capture_context.HaveCapturedFields;
597                         return false;
598                 }
599
600                 //
601                 // Emits the instance pointer for the host method
602                 //
603                 public void EmitMethodHostInstance (EmitContext target, AnonymousMethod am)
604                 {
605                         if (capture_context != null)
606                                 capture_context.EmitMethodHostInstance (target, am);
607                         else if (IsStatic)
608                                 target.ig.Emit (OpCodes.Ldnull);
609                         else
610                                 target.ig.Emit (OpCodes.Ldarg_0);
611                 }
612
613                 //
614                 // Returns whether the `local' variable has been captured by an anonymous
615                 // method
616                 //
617                 public bool IsCaptured (LocalInfo local)
618                 {
619                         return capture_context.IsCaptured (local);
620                 }
621
622                 public bool IsParameterCaptured (string name)
623                 {
624                         if (capture_context != null)
625                                 return capture_context.IsParameterCaptured (name);
626                         return false;
627                 }
628                 
629                 public void EmitMeta (ToplevelBlock b, InternalParameters ip)
630                 {
631                         if (capture_context != null)
632                                 capture_context.EmitAnonymousHelperClasses (this);
633                         b.EmitMeta (this);
634
635                         if (HasReturnLabel)
636                                 ReturnLabel = ig.DefineLabel ();
637                 }
638
639                 //
640                 // Here until we can fix the problem with Mono.CSharp.Switch, which
641                 // currently can not cope with ig == null during resolve (which must
642                 // be fixed for switch statements to work on anonymous methods).
643                 //
644                 public void EmitTopBlock (ToplevelBlock block, InternalParameters ip, Location loc)
645                 {
646                         if (block == null)
647                                 return;
648                         
649                         bool unreachable;
650                         
651                         if (ResolveTopBlock (null, block, ip, loc, out unreachable)){
652                                 EmitMeta (block, ip);
653
654                                 current_phase = Phase.Emitting;
655                                 EmitResolvedTopBlock (block, unreachable);
656                         }
657                 }
658
659                 public bool ResolveTopBlock (EmitContext anonymous_method_host, ToplevelBlock block,
660                                              InternalParameters ip, Location loc, out bool unreachable)
661                 {
662                         current_phase = Phase.Resolving;
663                         
664                         unreachable = false;
665
666                         capture_context = block.CaptureContext;
667                         
668                         if (!Location.IsNull (loc))
669                                 CurrentFile = loc.File;
670
671 #if PRODUCTION
672                         try {
673 #endif
674                                 int errors = Report.Errors;
675
676                                 block.ResolveMeta (block, this, ip);
677
678                                 
679                                 if (Report.Errors == errors){
680                                         bool old_do_flow_analysis = DoFlowAnalysis;
681                                         DoFlowAnalysis = true;
682
683                                         if (anonymous_method_host != null)
684                                                 current_flow_branching = FlowBranching.CreateBranching (
685                                                 anonymous_method_host.CurrentBranching, FlowBranching.BranchingType.Block,
686                                                 block, loc);
687                                         else 
688                                                 current_flow_branching = FlowBranching.CreateBranching (
689                                                         null, FlowBranching.BranchingType.Block, block, loc);
690
691                                         if (!block.Resolve (this)) {
692                                                 current_flow_branching = null;
693                                                 DoFlowAnalysis = old_do_flow_analysis;
694                                                 return false;
695                                         }
696
697                                         FlowBranching.Reachability reachability = current_flow_branching.MergeTopBlock ();
698                                         current_flow_branching = null;
699                                         
700                                         DoFlowAnalysis = old_do_flow_analysis;
701
702                                         if (reachability.AlwaysReturns ||
703                                             reachability.AlwaysThrows ||
704                                             reachability.IsUnreachable)
705                                                 unreachable = true;
706                                 }
707 #if PRODUCTION
708                         } catch (Exception e) {
709                                         Console.WriteLine ("Exception caught by the compiler while compiling:");
710                                         Console.WriteLine ("   Block that caused the problem begin at: " + loc);
711                                         
712                                         if (CurrentBlock != null){
713                                                 Console.WriteLine ("                     Block being compiled: [{0},{1}]",
714                                                                    CurrentBlock.StartLocation, CurrentBlock.EndLocation);
715                                         }
716                                         Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
717                                         throw;
718                         }
719 #endif
720
721                         if (ReturnType != null && !unreachable){
722                                 if (!InIterator){
723                                         if (CurrentAnonymousMethod != null){
724                                                 Report.Error (1643, loc, "Not all code paths return a value in anonymous method of type `{0}'",
725                                                               CurrentAnonymousMethod.Type);
726                                         } else {
727                                                 Report.Error (161, loc, "Not all code paths return a value");
728                                         }
729                                         
730                                         return false;
731                                 }
732                         }
733                         block.CompleteContexts ();
734
735                         return true;
736                 }
737
738                 public void EmitResolvedTopBlock (ToplevelBlock block, bool unreachable)
739                 {
740                         if (block != null)
741                                 block.Emit (this);
742                         
743                         if (HasReturnLabel)
744                                 ig.MarkLabel (ReturnLabel);
745                         
746                         if (return_value != null){
747                                 ig.Emit (OpCodes.Ldloc, return_value);
748                                 ig.Emit (OpCodes.Ret);
749                         } else {
750                                 //
751                                 // If `HasReturnLabel' is set, then we already emitted a
752                                 // jump to the end of the method, so we must emit a `ret'
753                                 // there.
754                                 //
755                                 // Unfortunately, System.Reflection.Emit automatically emits
756                                 // a leave to the end of a finally block.  This is a problem
757                                 // if no code is following the try/finally block since we may
758                                 // jump to a point after the end of the method.
759                                 // As a workaround, we're always creating a return label in
760                                 // this case.
761                                 //
762
763                                 if ((block != null) && block.IsDestructor) {
764                                         // Nothing to do; S.R.E automatically emits a leave.
765                                 } else if (HasReturnLabel || (!unreachable && !InIterator)) {
766                                         if (ReturnType != null)
767                                                 ig.Emit (OpCodes.Ldloc, TemporaryReturn ());
768                                         ig.Emit (OpCodes.Ret);
769                                 }
770                         }
771
772                         //
773                         // Close pending helper classes if we are the toplevel
774                         //
775                         if (capture_context != null && capture_context.ParentToplevel == null)
776                                 capture_context.CloseAnonymousHelperClasses ();
777                 }
778
779                 /// <summary>
780                 ///   This is called immediately before emitting an IL opcode to tell the symbol
781                 ///   writer to which source line this opcode belongs.
782                 /// </summary>
783                 public void Mark (Location loc, bool check_file)
784                 {
785                         if ((CodeGen.SymbolWriter == null) || Location.IsNull (loc))
786                                 return;
787
788                         if (check_file && (CurrentFile != loc.File))
789                                 return;
790
791                         CodeGen.SymbolWriter.MarkSequencePoint (ig, loc.Row, 0);
792                 }
793
794                 public void DefineLocalVariable (string name, LocalBuilder builder)
795                 {
796                         if (CodeGen.SymbolWriter == null)
797                                 return;
798
799                         CodeGen.SymbolWriter.DefineLocalVariable (name, builder);
800                 }
801
802                 public void BeginScope ()
803                 {
804                         ig.BeginScope();
805
806                         if (CodeGen.SymbolWriter != null)
807                                 CodeGen.SymbolWriter.OpenScope(ig);
808                 }
809
810                 public void EndScope ()
811                 {
812                         ig.EndScope();
813
814                         if (CodeGen.SymbolWriter != null)
815                                 CodeGen.SymbolWriter.CloseScope(ig);
816                 }
817
818                 /// <summary>
819                 ///   Returns a temporary storage for a variable of type t as 
820                 ///   a local variable in the current body.
821                 /// </summary>
822                 public LocalBuilder GetTemporaryLocal (Type t)
823                 {
824                         LocalBuilder location = null;
825                         
826                         if (temporary_storage != null){
827                                 object o = temporary_storage [t];
828                                 if (o != null){
829                                         if (o is ArrayList){
830                                                 ArrayList al = (ArrayList) o;
831                                                 
832                                                 for (int i = 0; i < al.Count; i++){
833                                                         if (al [i] != null){
834                                                                 location = (LocalBuilder) al [i];
835                                                                 al [i] = null;
836                                                                 break;
837                                                         }
838                                                 }
839                                         } else
840                                                 location = (LocalBuilder) o;
841                                         if (location != null)
842                                                 return location;
843                                 }
844                         }
845                         
846                         return ig.DeclareLocal (t);
847                 }
848
849                 public void FreeTemporaryLocal (LocalBuilder b, Type t)
850                 {
851                         if (temporary_storage == null){
852                                 temporary_storage = new Hashtable ();
853                                 temporary_storage [t] = b;
854                                 return;
855                         }
856                         object o = temporary_storage [t];
857                         if (o == null){
858                                 temporary_storage [t] = b;
859                                 return;
860                         }
861                         if (o is ArrayList){
862                                 ArrayList al = (ArrayList) o;
863                                 for (int i = 0; i < al.Count; i++){
864                                         if (al [i] == null){
865                                                 al [i] = b;
866                                                 return;
867                                         }
868                                 }
869                                 al.Add (b);
870                                 return;
871                         }
872                         ArrayList replacement = new ArrayList ();
873                         replacement.Add (o);
874                         temporary_storage.Remove (t);
875                         temporary_storage [t] = replacement;
876                 }
877
878                 /// <summary>
879                 ///   Current loop begin and end labels.
880                 /// </summary>
881                 public Label LoopBegin, LoopEnd;
882
883                 /// <summary>
884                 ///   Default target in a switch statement.   Only valid if
885                 ///   InSwitch is true
886                 /// </summary>
887                 public Label DefaultTarget;
888
889                 /// <summary>
890                 ///   If this is non-null, points to the current switch statement
891                 /// </summary>
892                 public Switch Switch;
893
894                 /// <summary>
895                 ///   ReturnValue creates on demand the LocalBuilder for the
896                 ///   return value from the function.  By default this is not
897                 ///   used.  This is only required when returns are found inside
898                 ///   Try or Catch statements.
899                 ///
900                 ///   This method is typically invoked from the Emit phase, so
901                 ///   we allow the creation of a return label if it was not
902                 ///   requested during the resolution phase.   Could be cleaned
903                 ///   up, but it would replicate a lot of logic in the Emit phase
904                 ///   of the code that uses it.
905                 /// </summary>
906                 public LocalBuilder TemporaryReturn ()
907                 {
908                         if (return_value == null){
909                                 return_value = ig.DeclareLocal (ReturnType);
910                                 if (!HasReturnLabel){
911                                         ReturnLabel = ig.DefineLabel ();
912                                         HasReturnLabel = true;
913                                 }
914                         }
915
916                         return return_value;
917                 }
918
919                 /// <summary>
920                 ///   This method is used during the Resolution phase to flag the
921                 ///   need to define the ReturnLabel
922                 /// </summary>
923                 public void NeedReturnLabel ()
924                 {
925                         if (current_phase != Phase.Resolving){
926                                 //
927                                 // The reason is that the `ReturnLabel' is declared between
928                                 // resolution and emission
929                                 // 
930                                 throw new Exception ("NeedReturnLabel called from Emit phase, should only be called during Resolve");
931                         }
932                         
933                         if (!InIterator && !HasReturnLabel) 
934                                 HasReturnLabel = true;
935                 }
936
937                 //
938                 // Creates a field `name' with the type `t' on the proxy class
939                 //
940                 public FieldBuilder MapVariable (string name, Type t)
941                 {
942                         if (InIterator)
943                                 return CurrentIterator.MapVariable ("v_", name, t);
944
945                         throw new Exception ("MapVariable for an unknown state");
946                 }
947
948                 public Expression RemapParameter (int idx)
949                 {
950                         FieldExpr fe = new FieldExprNoAddress (CurrentIterator.parameter_fields [idx].FieldBuilder, loc);
951                         fe.InstanceExpression = new ProxyInstance ();
952                         return fe.DoResolve (this);
953                 }
954
955                 public Expression RemapParameterLValue (int idx, Expression right_side)
956                 {
957                         FieldExpr fe = new FieldExprNoAddress (CurrentIterator.parameter_fields [idx].FieldBuilder, loc);
958                         fe.InstanceExpression = new ProxyInstance ();
959                         return fe.DoResolveLValue (this, right_side);
960                 }
961                 
962                 //
963                 // Emits the proper object to address fields on a remapped
964                 // variable/parameter to field in anonymous-method/iterator proxy classes.
965                 //
966                 public void EmitThis ()
967                 {
968                         ig.Emit (OpCodes.Ldarg_0);
969                         if (InIterator){
970                                 if (!IsStatic){
971                                         FieldBuilder this_field = CurrentIterator.this_field.FieldBuilder;
972                                         if (TypeManager.IsValueType (this_field.FieldType))
973                                                 ig.Emit (OpCodes.Ldflda, this_field);
974                                         else
975                                                 ig.Emit (OpCodes.Ldfld, this_field);
976                                 } 
977                         } else if (capture_context != null && CurrentAnonymousMethod != null){
978                                 ScopeInfo si = CurrentAnonymousMethod.Scope;
979                                 while (si != null){
980                                         if (si.ParentLink != null)
981                                                 ig.Emit (OpCodes.Ldfld, si.ParentLink);
982                                         if (si.THIS != null){
983                                                 ig.Emit (OpCodes.Ldfld, si.THIS);
984                                                 break;
985                                         }
986                                         si = si.ParentScope;
987                                 }
988                         } 
989                 }
990
991                 //
992                 // Emits the code necessary to load the instance required
993                 // to access the captured LocalInfo
994                 //
995                 public void EmitCapturedVariableInstance (LocalInfo li)
996                 {
997                         if (RemapToProxy){
998                                 ig.Emit (OpCodes.Ldarg_0);
999                                 return;
1000                         }
1001                         
1002                         if (capture_context == null)
1003                                 throw new Exception ("Calling EmitCapturedContext when there is no capture_context");
1004                         
1005                         capture_context.EmitCapturedVariableInstance (this, li, CurrentAnonymousMethod);
1006                 }
1007
1008                 public void EmitParameter (string name)
1009                 {
1010                         capture_context.EmitParameter (this, name);
1011                 }
1012
1013                 public void EmitAssignParameter (string name, Expression source, bool leave_copy, bool prepare_for_load)
1014                 {
1015                         capture_context.EmitAssignParameter (this, name, source, leave_copy, prepare_for_load);
1016                 }
1017
1018                 public void EmitAddressOfParameter (string name)
1019                 {
1020                         capture_context.EmitAddressOfParameter (this, name);
1021                 }
1022                 
1023                 public Expression GetThis (Location loc)
1024                 {
1025                         This my_this;
1026                         if (CurrentBlock != null)
1027                                 my_this = new This (CurrentBlock, loc);
1028                         else
1029                                 my_this = new This (loc);
1030
1031                         if (!my_this.ResolveBase (this))
1032                                 my_this = null;
1033
1034                         return my_this;
1035                 }
1036         }
1037
1038
1039         public abstract class CommonAssemblyModulClass: Attributable {
1040                 protected CommonAssemblyModulClass ():
1041                         base (null)
1042                 {
1043                 }
1044
1045                 public void AddAttributes (ArrayList attrs)
1046                 {
1047                         if (OptAttributes == null) {
1048                                 OptAttributes = new Attributes (attrs);
1049                                 return;
1050                         }
1051                         OptAttributes.AddAttributes (attrs);
1052                 }
1053
1054                 public virtual void Emit (TypeContainer tc) 
1055                 {
1056                         if (OptAttributes == null)
1057                                 return;
1058
1059                         EmitContext ec = new EmitContext (tc, Mono.CSharp.Location.Null, null, null, 0, false);
1060                         OptAttributes.Emit (ec, this);
1061                 }
1062                 
1063                 protected Attribute GetClsCompliantAttribute ()
1064                 {
1065                         if (OptAttributes == null)
1066                                 return null;
1067
1068                         // Ensure that we only have GlobalAttributes, since the Search below isn't safe with other types.
1069                         if (!OptAttributes.CheckTargets (this))
1070                                 return null;
1071
1072                         EmitContext temp_ec = new EmitContext (RootContext.Tree.Types, Mono.CSharp.Location.Null, null, null, 0, false);
1073                         Attribute a = OptAttributes.Search (TypeManager.cls_compliant_attribute_type, temp_ec);
1074                         if (a != null) {
1075                                 a.Resolve (temp_ec);
1076                         }
1077                         return a;
1078                 }
1079         }
1080                 
1081         public class AssemblyClass: CommonAssemblyModulClass {
1082                 // TODO: make it private and move all builder based methods here
1083                 public AssemblyBuilder Builder;
1084                 bool is_cls_compliant;
1085                 public Attribute ClsCompliantAttribute;
1086
1087                 ListDictionary declarative_security;
1088
1089                 static string[] attribute_targets = new string [] { "assembly" };
1090
1091                 public AssemblyClass (): base ()
1092                 {
1093                         is_cls_compliant = false;
1094                 }
1095
1096                 public bool IsClsCompliant {
1097                         get {
1098                                 return is_cls_compliant;
1099                         }
1100                 }
1101
1102                 public override AttributeTargets AttributeTargets {
1103                         get {
1104                                 return AttributeTargets.Assembly;
1105                         }
1106                 }
1107
1108                 public override bool IsClsCompliaceRequired(DeclSpace ds)
1109                 {
1110                         return is_cls_compliant;
1111                 }
1112
1113                 public void ResolveClsCompliance ()
1114                 {
1115                         ClsCompliantAttribute = GetClsCompliantAttribute ();
1116                         if (ClsCompliantAttribute == null)
1117                                 return;
1118
1119                         is_cls_compliant = ClsCompliantAttribute.GetClsCompliantAttributeValue (null);
1120                 }
1121
1122                 // fix bug #56621
1123                 private void SetPublicKey (AssemblyName an, byte[] strongNameBlob) 
1124                 {
1125                         try {
1126                                 // check for possible ECMA key
1127                                 if (strongNameBlob.Length == 16) {
1128                                         // will be rejected if not "the" ECMA key
1129                                         an.SetPublicKey (strongNameBlob);
1130                                 }
1131                                 else {
1132                                         // take it, with or without, a private key
1133                                         RSA rsa = CryptoConvert.FromCapiKeyBlob (strongNameBlob);
1134                                         // and make sure we only feed the public part to Sys.Ref
1135                                         byte[] publickey = CryptoConvert.ToCapiPublicKeyBlob (rsa);
1136                                         
1137                                         // AssemblyName.SetPublicKey requires an additional header
1138                                         byte[] publicKeyHeader = new byte [12] { 0x00, 0x24, 0x00, 0x00, 0x04, 0x80, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00 };
1139
1140                                         byte[] encodedPublicKey = new byte [12 + publickey.Length];
1141                                         Buffer.BlockCopy (publicKeyHeader, 0, encodedPublicKey, 0, 12);
1142                                         Buffer.BlockCopy (publickey, 0, encodedPublicKey, 12, publickey.Length);
1143                                         an.SetPublicKey (encodedPublicKey);
1144                                 }
1145                         }
1146                         catch (Exception) {
1147                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1148                                         RootContext.StrongNameKeyFile + "' incorrectly encoded.");
1149                                 Environment.Exit (1);
1150                         }
1151                 }
1152
1153                 // TODO: rewrite this code (to kill N bugs and make it faster) and use standard ApplyAttribute way.
1154                 public AssemblyName GetAssemblyName (string name, string output) 
1155                 {
1156                         if (OptAttributes != null) {
1157                                 foreach (Attribute a in OptAttributes.Attrs) {
1158                                         // cannot rely on any resolve-based members before you call Resolve
1159                                         if (a.ExplicitTarget == null || a.ExplicitTarget != "assembly")
1160                                                 continue;
1161
1162                                         // TODO: This code is buggy: comparing Attribute name without resolving it is wrong.
1163                                         //       However, this is invoked by CodeGen.Init, at which time none of the namespaces
1164                                         //       are loaded yet.
1165                                         switch (a.Name) {
1166                                                 case "AssemblyKeyFile":
1167                                                 case "AssemblyKeyFileAttribute":
1168                                                 case "System.Reflection.AssemblyKeyFileAttribute":
1169                                                         if (RootContext.StrongNameKeyFile != null) {
1170                                                                 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1171                                                                 Report.Warning (1616, "Compiler option '{0}' overrides '{1}' given in source", "keyfile", "System.Reflection.AssemblyKeyFileAttribute");
1172                                                         }
1173                                                         else {
1174                                                                 string value = a.GetString ();
1175                                                                 if (value != String.Empty)
1176                                                                         RootContext.StrongNameKeyFile = value;
1177                                                         }
1178                                                         break;
1179                                                 case "AssemblyKeyName":
1180                                                 case "AssemblyKeyNameAttribute":
1181                                                 case "System.Reflection.AssemblyKeyNameAttribute":
1182                                                         if (RootContext.StrongNameKeyContainer != null) {
1183                                                                 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1184                                                                 Report.Warning (1616, "keycontainer", "Compiler option '{0}' overrides '{1}' given in source", "System.Reflection.AssemblyKeyNameAttribute");
1185                                                         }
1186                                                         else {
1187                                                                 string value = a.GetString ();
1188                                                                 if (value != String.Empty)
1189                                                                         RootContext.StrongNameKeyContainer = value;
1190                                                         }
1191                                                         break;
1192                                                 case "AssemblyDelaySign":
1193                                                 case "AssemblyDelaySignAttribute":
1194                                                 case "System.Reflection.AssemblyDelaySignAttribute":
1195                                                         RootContext.StrongNameDelaySign = a.GetBoolean ();
1196                                                         break;
1197                                         }
1198                                 }
1199                         }
1200
1201                         AssemblyName an = new AssemblyName ();
1202                         an.Name = Path.GetFileNameWithoutExtension (name);
1203
1204                         // note: delay doesn't apply when using a key container
1205                         if (RootContext.StrongNameKeyContainer != null) {
1206                                 an.KeyPair = new StrongNameKeyPair (RootContext.StrongNameKeyContainer);
1207                                 return an;
1208                         }
1209
1210                         // strongname is optional
1211                         if (RootContext.StrongNameKeyFile == null)
1212                                 return an;
1213
1214                         string AssemblyDir = Path.GetDirectoryName (output);
1215
1216                         // the StrongName key file may be relative to (a) the compiled
1217                         // file or (b) to the output assembly. See bugzilla #55320
1218                         // http://bugzilla.ximian.com/show_bug.cgi?id=55320
1219
1220                         // (a) relative to the compiled file
1221                         string filename = Path.GetFullPath (RootContext.StrongNameKeyFile);
1222                         bool exist = File.Exists (filename);
1223                         if ((!exist) && (AssemblyDir != null) && (AssemblyDir != String.Empty)) {
1224                                 // (b) relative to the outputed assembly
1225                                 filename = Path.GetFullPath (Path.Combine (AssemblyDir, RootContext.StrongNameKeyFile));
1226                                 exist = File.Exists (filename);
1227                         }
1228
1229                         if (exist) {
1230                                 using (FileStream fs = new FileStream (filename, FileMode.Open, FileAccess.Read)) {
1231                                         byte[] snkeypair = new byte [fs.Length];
1232                                         fs.Read (snkeypair, 0, snkeypair.Length);
1233
1234                                         if (RootContext.StrongNameDelaySign) {
1235                                                 // delayed signing - DO NOT include private key
1236                                                 SetPublicKey (an, snkeypair);
1237                                         }
1238                                         else {
1239                                                 // no delay so we make sure we have the private key
1240                                                 try {
1241                                                         CryptoConvert.FromCapiPrivateKeyBlob (snkeypair);
1242                                                         an.KeyPair = new StrongNameKeyPair (snkeypair);
1243                                                 }
1244                                                 catch (CryptographicException) {
1245                                                         if (snkeypair.Length == 16) {
1246                                                                 // error # is different for ECMA key
1247                                                                 Report.Error (1606, "Could not strongname the assembly. " + 
1248                                                                         "ECMA key can only be used to delay-sign assemblies");
1249                                                         }
1250                                                         else {
1251                                                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1252                                                                         RootContext.StrongNameKeyFile +
1253                                                                         "' doesn't have a private key.");
1254                                                         }
1255                                                         Environment.Exit (1);
1256                                                 }
1257                                         }
1258                                 }
1259                         }
1260                         else {
1261                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1262                                         RootContext.StrongNameKeyFile + "' not found.");
1263                                 Environment.Exit (1);
1264                         }
1265                         return an;
1266                 }
1267
1268                 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1269                 {
1270                         if (a.Type.IsSubclassOf (TypeManager.security_attr_type) && a.CheckSecurityActionValidity (true)) {
1271                                 if (declarative_security == null)
1272                                         declarative_security = new ListDictionary ();
1273
1274                                 a.ExtractSecurityPermissionSet (declarative_security);
1275                                 return;
1276                         }
1277
1278                         Builder.SetCustomAttribute (customBuilder);
1279                 }
1280
1281                 public override void Emit (TypeContainer tc)
1282                 {
1283                         base.Emit (tc);
1284
1285                         if (declarative_security != null) {
1286
1287                                 MethodInfo add_permission = typeof (AssemblyBuilder).GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1288                                 object builder_instance = Builder;
1289
1290                                 try {
1291                                         // Microsoft runtime hacking
1292                                         if (add_permission == null) {
1293                                                 Type assembly_builder = typeof (AssemblyBuilder).Assembly.GetType ("System.Reflection.Emit.AssemblyBuilderData");
1294                                                 add_permission = assembly_builder.GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1295
1296                                                 FieldInfo fi = typeof (AssemblyBuilder).GetField ("m_assemblyData", BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField);
1297                                                 builder_instance = fi.GetValue (Builder);
1298                                         }
1299
1300                                         object[] args = new object [] { declarative_security [SecurityAction.RequestMinimum],
1301                                                                                                   declarative_security [SecurityAction.RequestOptional],
1302                                                                                                   declarative_security [SecurityAction.RequestRefuse] };
1303                                         add_permission.Invoke (builder_instance, args);
1304                                 }
1305                                 catch {
1306                                         Report.RuntimeMissingSupport (Location.Null, "assembly permission setting");
1307                                 }
1308                         }
1309                 }
1310
1311                 public override string[] ValidAttributeTargets {
1312                         get {
1313                                 return attribute_targets;
1314                         }
1315                 }
1316         }
1317
1318         public class ModuleClass: CommonAssemblyModulClass {
1319                 // TODO: make it private and move all builder based methods here
1320                 public ModuleBuilder Builder;
1321                 bool m_module_is_unsafe;
1322
1323                 static string[] attribute_targets = new string [] { "module" };
1324
1325                 public ModuleClass (bool is_unsafe)
1326                 {
1327                         m_module_is_unsafe = is_unsafe;
1328                 }
1329
1330                 public override AttributeTargets AttributeTargets {
1331                         get {
1332                                 return AttributeTargets.Module;
1333                         }
1334                 }
1335
1336                 public override bool IsClsCompliaceRequired(DeclSpace ds)
1337                 {
1338                         return CodeGen.Assembly.IsClsCompliant;
1339                 }
1340
1341                 public override void Emit (TypeContainer tc) 
1342                 {
1343                         base.Emit (tc);
1344
1345                         if (!m_module_is_unsafe)
1346                                 return;
1347
1348                         if (TypeManager.unverifiable_code_ctor == null) {
1349                                 Console.WriteLine ("Internal error ! Cannot set unverifiable code attribute.");
1350                                 return;
1351                         }
1352                                 
1353                         Builder.SetCustomAttribute (new CustomAttributeBuilder (TypeManager.unverifiable_code_ctor, new object [0]));
1354                 }
1355                 
1356                 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1357                 {
1358                         if (a.Type == TypeManager.cls_compliant_attribute_type) {
1359                                 if (CodeGen.Assembly.ClsCompliantAttribute == null) {
1360                                         Report.Warning (3012, a.Location, "You must specify the CLSCompliant attribute on the assembly, not the module, to enable CLS compliance checking");
1361                                 }
1362                                 else if (CodeGen.Assembly.IsClsCompliant != a.GetBoolean ()) {
1363                                         Report.SymbolRelatedToPreviousError (CodeGen.Assembly.ClsCompliantAttribute.Location, CodeGen.Assembly.ClsCompliantAttribute.Name);
1364                                         Report.Error (3017, a.Location, "You cannot specify the CLSCompliant attribute on a module that differs from the CLSCompliant attribute on the assembly");
1365                                         return;
1366                                 }
1367                         }
1368
1369                         Builder.SetCustomAttribute (customBuilder);
1370                 }
1371
1372                 public override string[] ValidAttributeTargets {
1373                         get {
1374                                 return attribute_targets;
1375                         }
1376                 }
1377         }
1378 }