2005-02-14 Marek Safar <marek.safar@seznam.cz>
[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                 ///   Used to flag that it is ok to define types recursively, as the
393                 ///   expressions are being evaluated as part of the type lookup
394                 ///   during the type resolution process
395                 /// </summary>
396                 public bool ResolvingTypeTree;
397                 
398                 /// <summary>
399                 ///   Inside an enum definition, we do not resolve enumeration values
400                 ///   to their enumerations, but rather to the underlying type/value
401                 ///   This is so EnumVal + EnumValB can be evaluated.
402                 ///
403                 ///   There is no "E operator + (E x, E y)", so during an enum evaluation
404                 ///   we relax the rules
405                 /// </summary>
406                 public bool InEnumContext;
407
408                 /// <summary>
409                 ///   Anonymous methods can capture local variables and fields,
410                 ///   this object tracks it.  It is copied from the TopLevelBlock
411                 ///   field.
412                 /// </summary>
413                 public CaptureContext capture_context;
414
415                 /// <summary>
416                 /// Trace when method is called and is obsolete then this member suppress message
417                 /// when call is inside next [Obsolete] method or type.
418                 /// </summary>
419                 public bool TestObsoleteMethodUsage = true;
420
421                 /// <summary>
422                 ///    The current iterator
423                 /// </summary>
424                 public Iterator CurrentIterator;
425
426                 /// <summary>
427                 ///    Whether we are in the resolving stage or not
428                 /// </summary>
429                 enum Phase {
430                         Created,
431                         Resolving,
432                         Emitting
433                 }
434                 
435                 Phase current_phase;
436                 FlowBranching current_flow_branching;
437                 
438                 public EmitContext (DeclSpace parent, DeclSpace ds, Location l, ILGenerator ig,
439                                     Type return_type, int code_flags, bool is_constructor)
440                 {
441                         this.ig = ig;
442
443                         TypeContainer = parent;
444                         DeclSpace = ds;
445                         CheckState = RootContext.Checked;
446                         ConstantCheckState = true;
447
448                         IsStatic = (code_flags & Modifiers.STATIC) != 0;
449                         MethodIsStatic = IsStatic;
450                         InIterator = (code_flags & Modifiers.METHOD_YIELDS) != 0;
451                         RemapToProxy = InIterator;
452                         ReturnType = return_type;
453                         IsConstructor = is_constructor;
454                         CurrentBlock = null;
455                         CurrentFile = 0;
456                         current_phase = Phase.Created;
457                         
458                         if (parent != null){
459                                 // Can only be null for the ResolveType contexts.
460                                 ContainerType = parent.TypeBuilder;
461                                 if (parent.UnsafeContext)
462                                         InUnsafe = true;
463                                 else
464                                         InUnsafe = (code_flags & Modifiers.UNSAFE) != 0;
465                         }
466                         loc = l;
467
468                         if (ReturnType == TypeManager.void_type)
469                                 ReturnType = null;
470                 }
471
472                 public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
473                                     Type return_type, int code_flags, bool is_constructor)
474                         : this (tc, tc, l, ig, return_type, code_flags, is_constructor)
475                 {
476                 }
477
478                 public EmitContext (TypeContainer tc, Location l, ILGenerator ig,
479                                     Type return_type, int code_flags)
480                         : this (tc, tc, l, ig, return_type, code_flags, false)
481                 {
482                 }
483
484                 public FlowBranching CurrentBranching {
485                         get {
486                                 return current_flow_branching;
487                         }
488                 }
489
490                 public bool HaveCaptureInfo {
491                         get {
492                                 return capture_context != null;
493                         }
494                 }
495
496                 // <summary>
497                 //   Starts a new code branching.  This inherits the state of all local
498                 //   variables and parameters from the current branching.
499                 // </summary>
500                 public FlowBranching StartFlowBranching (FlowBranching.BranchingType type, Location loc)
501                 {
502                         current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, null, loc);
503                         return current_flow_branching;
504                 }
505
506                 // <summary>
507                 //   Starts a new code branching for block `block'.
508                 // </summary>
509                 public FlowBranching StartFlowBranching (Block block)
510                 {
511                         FlowBranching.BranchingType type;
512
513                         if (CurrentBranching.Type == FlowBranching.BranchingType.Switch)
514                                 type = FlowBranching.BranchingType.SwitchSection;
515                         else
516                                 type = FlowBranching.BranchingType.Block;
517
518                         current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, block, block.StartLocation);
519                         return current_flow_branching;
520                 }
521
522                 public FlowBranchingException StartFlowBranching (ExceptionStatement stmt)
523                 {
524                         FlowBranchingException branching = new FlowBranchingException (
525                                 CurrentBranching, stmt);
526                         current_flow_branching = branching;
527                         return branching;
528                 }
529
530                 // <summary>
531                 //   Ends a code branching.  Merges the state of locals and parameters
532                 //   from all the children of the ending branching.
533                 // </summary>
534                 public FlowBranching.UsageVector DoEndFlowBranching ()
535                 {
536                         FlowBranching old = current_flow_branching;
537                         current_flow_branching = current_flow_branching.Parent;
538
539                         return current_flow_branching.MergeChild (old);
540                 }
541
542                 // <summary>
543                 //   Ends a code branching.  Merges the state of locals and parameters
544                 //   from all the children of the ending branching.
545                 // </summary>
546                 public FlowBranching.Reachability EndFlowBranching ()
547                 {
548                         FlowBranching.UsageVector vector = DoEndFlowBranching ();
549
550                         return vector.Reachability;
551                 }
552
553                 // <summary>
554                 //   Kills the current code branching.  This throws away any changed state
555                 //   information and should only be used in case of an error.
556                 // </summary>
557                 public void KillFlowBranching ()
558                 {
559                         current_flow_branching = current_flow_branching.Parent;
560                 }
561
562                 public void CaptureVariable (LocalInfo li)
563                 {
564                         capture_context.AddLocal (CurrentAnonymousMethod, li);
565                         li.IsCaptured = true;
566                 }
567
568                 public void CaptureParameter (string name, Type t, int idx)
569                 {
570                         capture_context.AddParameter (this, CurrentAnonymousMethod, name, t, idx);
571                 }
572
573                 public void CaptureThis ()
574                 {
575                         capture_context.CaptureThis ();
576                 }
577                 
578                 
579                 //
580                 // Use to register a field as captured
581                 //
582                 public void CaptureField (FieldExpr fe)
583                 {
584                         capture_context.AddField (fe);
585                 }
586
587                 //
588                 // Whether anonymous methods have captured variables
589                 //
590                 public bool HaveCapturedVariables ()
591                 {
592                         if (capture_context != null)
593                                 return capture_context.HaveCapturedVariables;
594                         return false;
595                 }
596
597                 //
598                 // Whether anonymous methods have captured fields or this.
599                 //
600                 public bool HaveCapturedFields ()
601                 {
602                         if (capture_context != null)
603                                 return capture_context.HaveCapturedFields;
604                         return false;
605                 }
606
607                 //
608                 // Emits the instance pointer for the host method
609                 //
610                 public void EmitMethodHostInstance (EmitContext target, AnonymousMethod am)
611                 {
612                         if (capture_context != null)
613                                 capture_context.EmitMethodHostInstance (target, am);
614                         else if (IsStatic)
615                                 target.ig.Emit (OpCodes.Ldnull);
616                         else
617                                 target.ig.Emit (OpCodes.Ldarg_0);
618                 }
619
620                 //
621                 // Returns whether the `local' variable has been captured by an anonymous
622                 // method
623                 //
624                 public bool IsCaptured (LocalInfo local)
625                 {
626                         return capture_context.IsCaptured (local);
627                 }
628
629                 public bool IsParameterCaptured (string name)
630                 {
631                         if (capture_context != null)
632                                 return capture_context.IsParameterCaptured (name);
633                         return false;
634                 }
635                 
636                 public void EmitMeta (ToplevelBlock b, InternalParameters ip)
637                 {
638                         if (capture_context != null)
639                                 capture_context.EmitAnonymousHelperClasses (this);
640                         b.EmitMeta (this);
641
642                         if (HasReturnLabel)
643                                 ReturnLabel = ig.DefineLabel ();
644                 }
645
646                 //
647                 // Here until we can fix the problem with Mono.CSharp.Switch, which
648                 // currently can not cope with ig == null during resolve (which must
649                 // be fixed for switch statements to work on anonymous methods).
650                 //
651                 public void EmitTopBlock (ToplevelBlock block, InternalParameters ip, Location loc)
652                 {
653                         if (block == null)
654                                 return;
655                         
656                         bool unreachable;
657                         
658                         if (ResolveTopBlock (null, block, ip, loc, out unreachable)){
659                                 EmitMeta (block, ip);
660
661                                 current_phase = Phase.Emitting;
662                                 EmitResolvedTopBlock (block, unreachable);
663                         }
664                 }
665
666                 public bool ResolveTopBlock (EmitContext anonymous_method_host, ToplevelBlock block,
667                                              InternalParameters ip, Location loc, out bool unreachable)
668                 {
669                         current_phase = Phase.Resolving;
670                         
671                         unreachable = false;
672
673                         capture_context = block.CaptureContext;
674                         
675                         if (!Location.IsNull (loc))
676                                 CurrentFile = loc.File;
677
678 #if PRODUCTION
679                         try {
680 #endif
681                                 int errors = Report.Errors;
682
683                                 block.ResolveMeta (block, this, ip);
684
685                                 
686                                 if (Report.Errors == errors){
687                                         bool old_do_flow_analysis = DoFlowAnalysis;
688                                         DoFlowAnalysis = true;
689
690                                         if (anonymous_method_host != null)
691                                                 current_flow_branching = FlowBranching.CreateBranching (
692                                                 anonymous_method_host.CurrentBranching, FlowBranching.BranchingType.Block,
693                                                 block, loc);
694                                         else 
695                                                 current_flow_branching = FlowBranching.CreateBranching (
696                                                         null, FlowBranching.BranchingType.Block, block, loc);
697
698                                         if (!block.Resolve (this)) {
699                                                 current_flow_branching = null;
700                                                 DoFlowAnalysis = old_do_flow_analysis;
701                                                 return false;
702                                         }
703
704                                         FlowBranching.Reachability reachability = current_flow_branching.MergeTopBlock ();
705                                         current_flow_branching = null;
706                                         
707                                         DoFlowAnalysis = old_do_flow_analysis;
708
709                                         if (reachability.AlwaysReturns ||
710                                             reachability.AlwaysThrows ||
711                                             reachability.IsUnreachable)
712                                                 unreachable = true;
713                                 }
714 #if PRODUCTION
715                         } catch (Exception e) {
716                                         Console.WriteLine ("Exception caught by the compiler while compiling:");
717                                         Console.WriteLine ("   Block that caused the problem begin at: " + loc);
718                                         
719                                         if (CurrentBlock != null){
720                                                 Console.WriteLine ("                     Block being compiled: [{0},{1}]",
721                                                                    CurrentBlock.StartLocation, CurrentBlock.EndLocation);
722                                         }
723                                         Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
724                                         throw;
725                         }
726 #endif
727
728                         if (ReturnType != null && !unreachable){
729                                 if (!InIterator){
730                                         if (CurrentAnonymousMethod != null){
731                                                 Report.Error (1643, loc, "Not all code paths return a value in anonymous method of type `{0}'",
732                                                               CurrentAnonymousMethod.Type);
733                                         } else {
734                                                 Report.Error (161, loc, "Not all code paths return a value");
735                                         }
736                                         
737                                         return false;
738                                 }
739                         }
740                         block.CompleteContexts ();
741
742                         return true;
743                 }
744
745                 public void EmitResolvedTopBlock (ToplevelBlock block, bool unreachable)
746                 {
747                         if (block != null)
748                                 block.Emit (this);
749                         
750                         if (HasReturnLabel)
751                                 ig.MarkLabel (ReturnLabel);
752                         
753                         if (return_value != null){
754                                 ig.Emit (OpCodes.Ldloc, return_value);
755                                 ig.Emit (OpCodes.Ret);
756                         } else {
757                                 //
758                                 // If `HasReturnLabel' is set, then we already emitted a
759                                 // jump to the end of the method, so we must emit a `ret'
760                                 // there.
761                                 //
762                                 // Unfortunately, System.Reflection.Emit automatically emits
763                                 // a leave to the end of a finally block.  This is a problem
764                                 // if no code is following the try/finally block since we may
765                                 // jump to a point after the end of the method.
766                                 // As a workaround, we're always creating a return label in
767                                 // this case.
768                                 //
769
770                                 if ((block != null) && block.IsDestructor) {
771                                         // Nothing to do; S.R.E automatically emits a leave.
772                                 } else if (HasReturnLabel || (!unreachable && !InIterator)) {
773                                         if (ReturnType != null)
774                                                 ig.Emit (OpCodes.Ldloc, TemporaryReturn ());
775                                         ig.Emit (OpCodes.Ret);
776                                 }
777                         }
778
779                         //
780                         // Close pending helper classes if we are the toplevel
781                         //
782                         if (capture_context != null && capture_context.ParentToplevel == null)
783                                 capture_context.CloseAnonymousHelperClasses ();
784                 }
785
786                 /// <summary>
787                 ///   This is called immediately before emitting an IL opcode to tell the symbol
788                 ///   writer to which source line this opcode belongs.
789                 /// </summary>
790                 public void Mark (Location loc, bool check_file)
791                 {
792                         if ((CodeGen.SymbolWriter == null) || Location.IsNull (loc))
793                                 return;
794
795                         if (check_file && (CurrentFile != loc.File))
796                                 return;
797
798                         CodeGen.SymbolWriter.MarkSequencePoint (ig, loc.Row, 0);
799                 }
800
801                 public void DefineLocalVariable (string name, LocalBuilder builder)
802                 {
803                         if (CodeGen.SymbolWriter == null)
804                                 return;
805
806                         CodeGen.SymbolWriter.DefineLocalVariable (name, builder);
807                 }
808
809                 /// <summary>
810                 ///   Returns a temporary storage for a variable of type t as 
811                 ///   a local variable in the current body.
812                 /// </summary>
813                 public LocalBuilder GetTemporaryLocal (Type t)
814                 {
815                         LocalBuilder location = null;
816                         
817                         if (temporary_storage != null){
818                                 object o = temporary_storage [t];
819                                 if (o != null){
820                                         if (o is ArrayList){
821                                                 ArrayList al = (ArrayList) o;
822                                                 
823                                                 for (int i = 0; i < al.Count; i++){
824                                                         if (al [i] != null){
825                                                                 location = (LocalBuilder) al [i];
826                                                                 al [i] = null;
827                                                                 break;
828                                                         }
829                                                 }
830                                         } else
831                                                 location = (LocalBuilder) o;
832                                         if (location != null)
833                                                 return location;
834                                 }
835                         }
836                         
837                         return ig.DeclareLocal (t);
838                 }
839
840                 public void FreeTemporaryLocal (LocalBuilder b, Type t)
841                 {
842                         if (temporary_storage == null){
843                                 temporary_storage = new Hashtable ();
844                                 temporary_storage [t] = b;
845                                 return;
846                         }
847                         object o = temporary_storage [t];
848                         if (o == null){
849                                 temporary_storage [t] = b;
850                                 return;
851                         }
852                         if (o is ArrayList){
853                                 ArrayList al = (ArrayList) o;
854                                 for (int i = 0; i < al.Count; i++){
855                                         if (al [i] == null){
856                                                 al [i] = b;
857                                                 return;
858                                         }
859                                 }
860                                 al.Add (b);
861                                 return;
862                         }
863                         ArrayList replacement = new ArrayList ();
864                         replacement.Add (o);
865                         temporary_storage.Remove (t);
866                         temporary_storage [t] = replacement;
867                 }
868
869                 /// <summary>
870                 ///   Current loop begin and end labels.
871                 /// </summary>
872                 public Label LoopBegin, LoopEnd;
873
874                 /// <summary>
875                 ///   Default target in a switch statement.   Only valid if
876                 ///   InSwitch is true
877                 /// </summary>
878                 public Label DefaultTarget;
879
880                 /// <summary>
881                 ///   If this is non-null, points to the current switch statement
882                 /// </summary>
883                 public Switch Switch;
884
885                 /// <summary>
886                 ///   ReturnValue creates on demand the LocalBuilder for the
887                 ///   return value from the function.  By default this is not
888                 ///   used.  This is only required when returns are found inside
889                 ///   Try or Catch statements.
890                 ///
891                 ///   This method is typically invoked from the Emit phase, so
892                 ///   we allow the creation of a return label if it was not
893                 ///   requested during the resolution phase.   Could be cleaned
894                 ///   up, but it would replicate a lot of logic in the Emit phase
895                 ///   of the code that uses it.
896                 /// </summary>
897                 public LocalBuilder TemporaryReturn ()
898                 {
899                         if (return_value == null){
900                                 return_value = ig.DeclareLocal (ReturnType);
901                                 if (!HasReturnLabel){
902                                         ReturnLabel = ig.DefineLabel ();
903                                         HasReturnLabel = true;
904                                 }
905                         }
906
907                         return return_value;
908                 }
909
910                 /// <summary>
911                 ///   This method is used during the Resolution phase to flag the
912                 ///   need to define the ReturnLabel
913                 /// </summary>
914                 public void NeedReturnLabel ()
915                 {
916                         if (current_phase != Phase.Resolving){
917                                 //
918                                 // The reason is that the `ReturnLabel' is declared between
919                                 // resolution and emission
920                                 // 
921                                 throw new Exception ("NeedReturnLabel called from Emit phase, should only be called during Resolve");
922                         }
923                         
924                         if (!InIterator && !HasReturnLabel) 
925                                 HasReturnLabel = true;
926                 }
927
928                 //
929                 // Creates a field `name' with the type `t' on the proxy class
930                 //
931                 public FieldBuilder MapVariable (string name, Type t)
932                 {
933                         if (InIterator)
934                                 return CurrentIterator.MapVariable ("v_", name, t);
935
936                         throw new Exception ("MapVariable for an unknown state");
937                 }
938
939                 public Expression RemapParameter (int idx)
940                 {
941                         FieldExpr fe = new FieldExprNoAddress (CurrentIterator.parameter_fields [idx].FieldBuilder, loc);
942                         fe.InstanceExpression = new ProxyInstance ();
943                         return fe.DoResolve (this);
944                 }
945
946                 public Expression RemapParameterLValue (int idx, Expression right_side)
947                 {
948                         FieldExpr fe = new FieldExprNoAddress (CurrentIterator.parameter_fields [idx].FieldBuilder, loc);
949                         fe.InstanceExpression = new ProxyInstance ();
950                         return fe.DoResolveLValue (this, right_side);
951                 }
952                 
953                 //
954                 // Emits the proper object to address fields on a remapped
955                 // variable/parameter to field in anonymous-method/iterator proxy classes.
956                 //
957                 public void EmitThis ()
958                 {
959                         ig.Emit (OpCodes.Ldarg_0);
960                         if (InIterator){
961                                 if (!IsStatic){
962                                         FieldBuilder this_field = CurrentIterator.this_field.FieldBuilder;
963                                         if (TypeManager.IsValueType (this_field.FieldType))
964                                                 ig.Emit (OpCodes.Ldflda, this_field);
965                                         else
966                                                 ig.Emit (OpCodes.Ldfld, this_field);
967                                 } 
968                         } else if (capture_context != null && CurrentAnonymousMethod != null){
969                                 ScopeInfo si = CurrentAnonymousMethod.Scope;
970                                 while (si != null){
971                                         if (si.ParentLink != null)
972                                                 ig.Emit (OpCodes.Ldfld, si.ParentLink);
973                                         if (si.THIS != null){
974                                                 ig.Emit (OpCodes.Ldfld, si.THIS);
975                                                 break;
976                                         }
977                                         si = si.ParentScope;
978                                 }
979                         } 
980                 }
981
982                 //
983                 // Emits the code necessary to load the instance required
984                 // to access the captured LocalInfo
985                 //
986                 public void EmitCapturedVariableInstance (LocalInfo li)
987                 {
988                         if (RemapToProxy){
989                                 ig.Emit (OpCodes.Ldarg_0);
990                                 return;
991                         }
992                         
993                         if (capture_context == null)
994                                 throw new Exception ("Calling EmitCapturedContext when there is no capture_context");
995                         
996                         capture_context.EmitCapturedVariableInstance (this, li, CurrentAnonymousMethod);
997                 }
998
999                 public void EmitParameter (string name)
1000                 {
1001                         capture_context.EmitParameter (this, name);
1002                 }
1003
1004                 public void EmitAssignParameter (string name, Expression source, bool leave_copy, bool prepare_for_load)
1005                 {
1006                         capture_context.EmitAssignParameter (this, name, source, leave_copy, prepare_for_load);
1007                 }
1008
1009                 public void EmitAddressOfParameter (string name)
1010                 {
1011                         capture_context.EmitAddressOfParameter (this, name);
1012                 }
1013                 
1014                 public Expression GetThis (Location loc)
1015                 {
1016                         This my_this;
1017                         if (CurrentBlock != null)
1018                                 my_this = new This (CurrentBlock, loc);
1019                         else
1020                                 my_this = new This (loc);
1021
1022                         if (!my_this.ResolveBase (this))
1023                                 my_this = null;
1024
1025                         return my_this;
1026                 }
1027         }
1028
1029
1030         public abstract class CommonAssemblyModulClass: Attributable {
1031                 protected CommonAssemblyModulClass ():
1032                         base (null)
1033                 {
1034                 }
1035
1036                 public void AddAttributes (ArrayList attrs)
1037                 {
1038                         if (OptAttributes == null) {
1039                                 OptAttributes = new Attributes (attrs);
1040                                 return;
1041                         }
1042                         OptAttributes.AddAttributes (attrs);
1043                 }
1044
1045                 public virtual void Emit (TypeContainer tc) 
1046                 {
1047                         if (OptAttributes == null)
1048                                 return;
1049
1050                         EmitContext ec = new EmitContext (tc, Mono.CSharp.Location.Null, null, null, 0, false);
1051                         OptAttributes.Emit (ec, this);
1052                 }
1053                 
1054                 protected Attribute GetClsCompliantAttribute ()
1055                 {
1056                         if (OptAttributes == null)
1057                                 return null;
1058
1059                         // Ensure that we only have GlobalAttributes, since the Search below isn't safe with other types.
1060                         if (!OptAttributes.CheckTargets (this))
1061                                 return null;
1062
1063                         EmitContext temp_ec = new EmitContext (RootContext.Tree.Types, Mono.CSharp.Location.Null, null, null, 0, false);
1064                         Attribute a = OptAttributes.Search (TypeManager.cls_compliant_attribute_type, temp_ec);
1065                         if (a != null) {
1066                                 a.Resolve (temp_ec);
1067                         }
1068                         return a;
1069                 }
1070         }
1071                 
1072         public class AssemblyClass: CommonAssemblyModulClass {
1073                 // TODO: make it private and move all builder based methods here
1074                 public AssemblyBuilder Builder;
1075                 bool is_cls_compliant;
1076                 public Attribute ClsCompliantAttribute;
1077
1078                 ListDictionary declarative_security;
1079
1080                 static string[] attribute_targets = new string [] { "assembly" };
1081
1082                 public AssemblyClass (): base ()
1083                 {
1084                         is_cls_compliant = false;
1085                 }
1086
1087                 public bool IsClsCompliant {
1088                         get {
1089                                 return is_cls_compliant;
1090                         }
1091                 }
1092
1093                 public override AttributeTargets AttributeTargets {
1094                         get {
1095                                 return AttributeTargets.Assembly;
1096                         }
1097                 }
1098
1099                 public override bool IsClsCompliaceRequired(DeclSpace ds)
1100                 {
1101                         return is_cls_compliant;
1102                 }
1103
1104                 public void ResolveClsCompliance ()
1105                 {
1106                         ClsCompliantAttribute = GetClsCompliantAttribute ();
1107                         if (ClsCompliantAttribute == null)
1108                                 return;
1109
1110                         is_cls_compliant = ClsCompliantAttribute.GetClsCompliantAttributeValue (null);
1111                 }
1112
1113                 // fix bug #56621
1114                 private void SetPublicKey (AssemblyName an, byte[] strongNameBlob) 
1115                 {
1116                         try {
1117                                 // check for possible ECMA key
1118                                 if (strongNameBlob.Length == 16) {
1119                                         // will be rejected if not "the" ECMA key
1120                                         an.SetPublicKey (strongNameBlob);
1121                                 }
1122                                 else {
1123                                         // take it, with or without, a private key
1124                                         RSA rsa = CryptoConvert.FromCapiKeyBlob (strongNameBlob);
1125                                         // and make sure we only feed the public part to Sys.Ref
1126                                         byte[] publickey = CryptoConvert.ToCapiPublicKeyBlob (rsa);
1127                                         
1128                                         // AssemblyName.SetPublicKey requires an additional header
1129                                         byte[] publicKeyHeader = new byte [12] { 0x00, 0x24, 0x00, 0x00, 0x04, 0x80, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00 };
1130
1131                                         byte[] encodedPublicKey = new byte [12 + publickey.Length];
1132                                         Buffer.BlockCopy (publicKeyHeader, 0, encodedPublicKey, 0, 12);
1133                                         Buffer.BlockCopy (publickey, 0, encodedPublicKey, 12, publickey.Length);
1134                                         an.SetPublicKey (encodedPublicKey);
1135                                 }
1136                         }
1137                         catch (Exception) {
1138                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1139                                         RootContext.StrongNameKeyFile + "' incorrectly encoded.");
1140                                 Environment.Exit (1);
1141                         }
1142                 }
1143
1144                 // TODO: rewrite this code (to kill N bugs and make it faster) and use standard ApplyAttribute way.
1145                 public AssemblyName GetAssemblyName (string name, string output) 
1146                 {
1147                         if (OptAttributes != null) {
1148                                 foreach (Attribute a in OptAttributes.Attrs) {
1149                                         // cannot rely on any resolve-based members before you call Resolve
1150                                         if (a.ExplicitTarget == null || a.ExplicitTarget != "assembly")
1151                                                 continue;
1152
1153                                         // TODO: This code is buggy: comparing Attribute name without resolving it is wrong.
1154                                         //       However, this is invoked by CodeGen.Init, at which time none of the namespaces
1155                                         //       are loaded yet.
1156                                         switch (a.Name) {
1157                                                 case "AssemblyKeyFile":
1158                                                 case "AssemblyKeyFileAttribute":
1159                                                 case "System.Reflection.AssemblyKeyFileAttribute":
1160                                                         if (RootContext.StrongNameKeyFile != null) {
1161                                                                 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1162                                                                 Report.Warning (1616, "Compiler option '{0}' overrides '{1}' given in source", "keyfile", "System.Reflection.AssemblyKeyFileAttribute");
1163                                                         }
1164                                                         else {
1165                                                                 string value = a.GetString ();
1166                                                                 if (value != String.Empty)
1167                                                                         RootContext.StrongNameKeyFile = value;
1168                                                         }
1169                                                         break;
1170                                                 case "AssemblyKeyName":
1171                                                 case "AssemblyKeyNameAttribute":
1172                                                 case "System.Reflection.AssemblyKeyNameAttribute":
1173                                                         if (RootContext.StrongNameKeyContainer != null) {
1174                                                                 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1175                                                                 Report.Warning (1616, "keycontainer", "Compiler option '{0}' overrides '{1}' given in source", "System.Reflection.AssemblyKeyNameAttribute");
1176                                                         }
1177                                                         else {
1178                                                                 string value = a.GetString ();
1179                                                                 if (value != String.Empty)
1180                                                                         RootContext.StrongNameKeyContainer = value;
1181                                                         }
1182                                                         break;
1183                                                 case "AssemblyDelaySign":
1184                                                 case "AssemblyDelaySignAttribute":
1185                                                 case "System.Reflection.AssemblyDelaySignAttribute":
1186                                                         RootContext.StrongNameDelaySign = a.GetBoolean ();
1187                                                         break;
1188                                         }
1189                                 }
1190                         }
1191
1192                         AssemblyName an = new AssemblyName ();
1193                         an.Name = Path.GetFileNameWithoutExtension (name);
1194
1195                         // note: delay doesn't apply when using a key container
1196                         if (RootContext.StrongNameKeyContainer != null) {
1197                                 an.KeyPair = new StrongNameKeyPair (RootContext.StrongNameKeyContainer);
1198                                 return an;
1199                         }
1200
1201                         // strongname is optional
1202                         if (RootContext.StrongNameKeyFile == null)
1203                                 return an;
1204
1205                         string AssemblyDir = Path.GetDirectoryName (output);
1206
1207                         // the StrongName key file may be relative to (a) the compiled
1208                         // file or (b) to the output assembly. See bugzilla #55320
1209                         // http://bugzilla.ximian.com/show_bug.cgi?id=55320
1210
1211                         // (a) relative to the compiled file
1212                         string filename = Path.GetFullPath (RootContext.StrongNameKeyFile);
1213                         bool exist = File.Exists (filename);
1214                         if ((!exist) && (AssemblyDir != null) && (AssemblyDir != String.Empty)) {
1215                                 // (b) relative to the outputed assembly
1216                                 filename = Path.GetFullPath (Path.Combine (AssemblyDir, RootContext.StrongNameKeyFile));
1217                                 exist = File.Exists (filename);
1218                         }
1219
1220                         if (exist) {
1221                                 using (FileStream fs = new FileStream (filename, FileMode.Open, FileAccess.Read)) {
1222                                         byte[] snkeypair = new byte [fs.Length];
1223                                         fs.Read (snkeypair, 0, snkeypair.Length);
1224
1225                                         if (RootContext.StrongNameDelaySign) {
1226                                                 // delayed signing - DO NOT include private key
1227                                                 SetPublicKey (an, snkeypair);
1228                                         }
1229                                         else {
1230                                                 // no delay so we make sure we have the private key
1231                                                 try {
1232                                                         CryptoConvert.FromCapiPrivateKeyBlob (snkeypair);
1233                                                         an.KeyPair = new StrongNameKeyPair (snkeypair);
1234                                                 }
1235                                                 catch (CryptographicException) {
1236                                                         if (snkeypair.Length == 16) {
1237                                                                 // error # is different for ECMA key
1238                                                                 Report.Error (1606, "Could not strongname the assembly. " + 
1239                                                                         "ECMA key can only be used to delay-sign assemblies");
1240                                                         }
1241                                                         else {
1242                                                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1243                                                                         RootContext.StrongNameKeyFile +
1244                                                                         "' doesn't have a private key.");
1245                                                         }
1246                                                         Environment.Exit (1);
1247                                                 }
1248                                         }
1249                                 }
1250                         }
1251                         else {
1252                                 Report.Error (1548, "Could not strongname the assembly. File `" +
1253                                         RootContext.StrongNameKeyFile + "' not found.");
1254                                 Environment.Exit (1);
1255                         }
1256                         return an;
1257                 }
1258
1259                 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1260                 {
1261                         if (a.Type.IsSubclassOf (TypeManager.security_attr_type) && a.CheckSecurityActionValidity (true)) {
1262                                 if (declarative_security == null)
1263                                         declarative_security = new ListDictionary ();
1264
1265                                 a.ExtractSecurityPermissionSet (declarative_security);
1266                                 return;
1267                         }
1268
1269                         Builder.SetCustomAttribute (customBuilder);
1270                 }
1271
1272                 public override void Emit (TypeContainer tc)
1273                 {
1274                         base.Emit (tc);
1275
1276                         if (declarative_security != null) {
1277
1278                                 MethodInfo add_permission = typeof (AssemblyBuilder).GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1279                                 object builder_instance = Builder;
1280
1281                                 try {
1282                                         // Microsoft runtime hacking
1283                                         if (add_permission == null) {
1284                                                 Type assembly_builder = typeof (AssemblyBuilder).Assembly.GetType ("System.Reflection.Emit.AssemblyBuilderData");
1285                                                 add_permission = assembly_builder.GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1286
1287                                                 FieldInfo fi = typeof (AssemblyBuilder).GetField ("m_assemblyData", BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField);
1288                                                 builder_instance = fi.GetValue (Builder);
1289                                         }
1290
1291                                         object[] args = new object [] { declarative_security [SecurityAction.RequestMinimum],
1292                                                                                                   declarative_security [SecurityAction.RequestOptional],
1293                                                                                                   declarative_security [SecurityAction.RequestRefuse] };
1294                                         add_permission.Invoke (builder_instance, args);
1295                                 }
1296                                 catch {
1297                                         Report.RuntimeMissingSupport (Location.Null, "assembly permission setting");
1298                                 }
1299                         }
1300                 }
1301
1302                 public override string[] ValidAttributeTargets {
1303                         get {
1304                                 return attribute_targets;
1305                         }
1306                 }
1307         }
1308
1309         public class ModuleClass: CommonAssemblyModulClass {
1310                 // TODO: make it private and move all builder based methods here
1311                 public ModuleBuilder Builder;
1312                 bool m_module_is_unsafe;
1313
1314                 static string[] attribute_targets = new string [] { "module" };
1315
1316                 public ModuleClass (bool is_unsafe)
1317                 {
1318                         m_module_is_unsafe = is_unsafe;
1319                 }
1320
1321                 public override AttributeTargets AttributeTargets {
1322                         get {
1323                                 return AttributeTargets.Module;
1324                         }
1325                 }
1326
1327                 public override bool IsClsCompliaceRequired(DeclSpace ds)
1328                 {
1329                         return CodeGen.Assembly.IsClsCompliant;
1330                 }
1331
1332                 public override void Emit (TypeContainer tc) 
1333                 {
1334                         base.Emit (tc);
1335
1336                         if (!m_module_is_unsafe)
1337                                 return;
1338
1339                         if (TypeManager.unverifiable_code_ctor == null) {
1340                                 Console.WriteLine ("Internal error ! Cannot set unverifiable code attribute.");
1341                                 return;
1342                         }
1343                                 
1344                         Builder.SetCustomAttribute (new CustomAttributeBuilder (TypeManager.unverifiable_code_ctor, new object [0]));
1345                 }
1346                 
1347                 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1348                 {
1349                         if (a.Type == TypeManager.cls_compliant_attribute_type) {
1350                                 if (CodeGen.Assembly.ClsCompliantAttribute == null) {
1351                                         Report.Warning (3012, a.Location, "You must specify the CLSCompliant attribute on the assembly, not the module, to enable CLS compliance checking");
1352                                 }
1353                                 else if (CodeGen.Assembly.IsClsCompliant != a.GetBoolean ()) {
1354                                         Report.SymbolRelatedToPreviousError (CodeGen.Assembly.ClsCompliantAttribute.Location, CodeGen.Assembly.ClsCompliantAttribute.Name);
1355                                         Report.Error (3017, a.Location, "You cannot specify the CLSCompliant attribute on a module that differs from the CLSCompliant attribute on the assembly");
1356                                         return;
1357                                 }
1358                         }
1359
1360                         Builder.SetCustomAttribute (customBuilder);
1361                 }
1362
1363                 public override string[] ValidAttributeTargets {
1364                         get {
1365                                 return attribute_targets;
1366                         }
1367                 }
1368         }
1369 }