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