Revert r51122 since it's causing strange failures. Restore tree to bootstrap-land
[mono.git] / mcs / mcs / rootcontext.cs
1 //
2 // rootcontext.cs: keeps track of our tree representation, and assemblies loaded.
3 //
4 // Author: Miguel de Icaza (miguel@ximian.com)
5 //         Ravi Pratap     (ravi@ximian.com)
6 //
7 // Licensed under the terms of the GNU GPL
8 //
9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
10 // (C) 2004 Novell, Inc
11
12 using System;
13 using System.Collections;
14 using System.Reflection;
15 using System.Reflection.Emit;
16 using System.Diagnostics;
17
18 namespace Mono.CSharp {
19
20         public enum LanguageVersion
21         {
22                 Default = 0,
23                 ISO_1   = 1
24         }
25
26         public class RootContext {
27
28                 //
29                 // Contains the parsed tree
30                 //
31                 static Tree tree;
32
33                 //
34                 // This hashtable contains all of the #definitions across the source code
35                 // it is used by the ConditionalAttribute handler.
36                 //
37                 public static Hashtable AllDefines = new Hashtable ();
38                 
39                 //
40                 // Whether we are being linked against the standard libraries.
41                 // This is only used to tell whether `System.Object' should
42                 // have a base class or not.
43                 //
44                 public static bool StdLib;
45
46                 //
47                 // This keeps track of the order in which classes were defined
48                 // so that we can poulate them in that order.
49                 //
50                 // Order is important, because we need to be able to tell, by
51                 // examining the list of methods of the base class, which ones are virtual
52                 // or abstract as well as the parent names (to implement new, 
53                 // override).
54                 //
55                 static ArrayList type_container_resolve_order;
56
57                 //
58                 // Holds a reference to the Private Implementation Details
59                 // class.
60                 //
61                 static ArrayList helper_classes;
62                 
63                 static TypeBuilder impl_details_class;
64
65                 public static int WarningLevel;
66                 
67                 public static Target Target;
68                 public static string TargetExt;
69
70                 public static bool VerifyClsCompliance = true;
71
72                 /// <summary>
73                 /// Holds /optimize option
74                 /// </summary>
75                 public static bool Optimize = true;
76
77                 public static LanguageVersion Version;
78
79                 //
80                 // We keep strongname related info here because
81                 // it's also used as complier options from CSC 8.x
82                 //
83                 public static string StrongNameKeyFile;
84                 public static string StrongNameKeyContainer;
85                 public static bool StrongNameDelaySign;
86
87                 //
88                 // If set, enable XML documentation generation
89                 //
90                 public static Documentation Documentation;
91
92                 static public string MainClass;
93
94                 //
95                 // Constructor
96                 //
97                 static RootContext ()
98                 {
99                         Reset ();
100                 }
101
102                 public static void Reset ()
103                 {
104                         tree = new Tree ();
105                         type_container_resolve_order = new ArrayList ();
106                         EntryPoint = null;
107                         WarningLevel = 3;
108                         Checked = false;
109                         Unsafe = false;
110                         StdLib = true;
111                         StrongNameKeyFile = null;
112                         StrongNameKeyContainer = null;
113                         StrongNameDelaySign = false;
114                         MainClass = null;
115                         Target = Target.Exe;
116                         TargetExt = ".exe";
117                         Version = LanguageVersion.Default;
118                         Documentation = null;
119                         impl_details_class = null;
120                 }
121                 
122                 public static bool NeedsEntryPoint {
123                         get {
124                                 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
125                         }
126                 }
127
128                 static public Tree Tree {
129                         get {
130                                 return tree;
131                         }
132                 }
133
134                 public static void RegisterOrder (TypeContainer tc)
135                 {
136                         type_container_resolve_order.Add (tc);
137                 }
138                 
139                 // 
140                 // The default compiler checked state
141                 //
142                 static public bool Checked;
143
144                 //
145                 // Whether to allow Unsafe code
146                 //
147                 static public bool Unsafe;
148                 
149                 // <remarks>
150                 //   This function is used to resolve the hierarchy tree.
151                 //   It processes interfaces, structs and classes in that order.
152                 //
153                 //   It creates the TypeBuilder's as it processes the user defined
154                 //   types.  
155                 // </remarks>
156                 static public void ResolveTree ()
157                 {
158                         //
159                         // Interfaces are processed next, as classes and
160                         // structs might inherit from an object or implement
161                         // a set of interfaces, we need to be able to tell
162                         // them appart by just using the TypeManager.
163                         //
164                         TypeContainer root = Tree.Types;
165
166                         ArrayList ifaces = root.Interfaces;
167                         if (ifaces != null){
168                                 foreach (TypeContainer i in ifaces) 
169                                         i.DefineType ();
170                         }
171
172                         foreach (TypeContainer tc in root.Types)
173                                 tc.DefineType ();
174
175                         if (root.Delegates != null)
176                                 foreach (Delegate d in root.Delegates) 
177                                         d.DefineType ();
178
179                         if (root.Enums != null)
180                                 foreach (Enum e in root.Enums)
181                                         e.DefineType ();
182                 }
183
184                 static void Error_TypeConflict (string name, Location loc)
185                 {
186                         Report.Error (
187                                 520, loc, "`" + name + "' conflicts with a predefined type");
188                 }
189
190                 static void Error_TypeConflict (string name)
191                 {
192                         Report.Error (
193                                 520, "`" + name + "' conflicts with a predefined type");
194                 }
195
196                 //
197                 // Resolves a single class during the corlib bootstrap process
198                 //
199                 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
200                 {
201                         object o = root.GetDefinition (name);
202                         if (o == null){
203                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
204                                 return null;
205                         }
206
207                         if (!(o is Class)){
208                                 if (o is DeclSpace){
209                                         DeclSpace d = (DeclSpace) o;
210
211                                         Error_TypeConflict (name, d.Location);
212                                 } else
213                                         Error_TypeConflict (name);
214
215                                 return null;
216                         }
217
218                         return ((DeclSpace) o).DefineType ();
219                 }
220
221                 //
222                 // Resolves a struct during the corlib bootstrap process
223                 //
224                 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
225                 {
226                         object o = root.GetDefinition (name);
227                         if (o == null){
228                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
229                                 return;
230                         }
231
232                         if (!(o is Struct)){
233                                 if (o is DeclSpace){
234                                         DeclSpace d = (DeclSpace) o;
235
236                                         Error_TypeConflict (name, d.Location);
237                                 } else
238                                         Error_TypeConflict (name);
239
240                                 return;
241                         }
242
243                         ((DeclSpace) o).DefineType ();
244                 }
245
246                 //
247                 // Resolves a struct during the corlib bootstrap process
248                 //
249                 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
250                 {
251                         object o = root.GetDefinition (name);
252                         if (o == null){
253                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
254                                 return;
255                         }
256
257                         if (!(o is Interface)){
258                                 if (o is DeclSpace){
259                                         DeclSpace d = (DeclSpace) o;
260
261                                         Error_TypeConflict (name, d.Location);
262                                 } else
263                                         Error_TypeConflict (name);
264
265                                 return;
266                         }
267
268                         ((DeclSpace) o).DefineType ();
269                 }
270
271                 //
272                 // Resolves a delegate during the corlib bootstrap process
273                 //
274                 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
275                 {
276                         object o = root.GetDefinition (name);
277                         if (o == null){
278                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
279                                 return;
280                         }
281
282                         if (!(o is Delegate)){
283                                 Error_TypeConflict (name);
284                                 return;
285                         }
286
287                         ((DeclSpace) o).DefineType ();
288                 }
289                 
290
291                 /// <summary>
292                 ///    Resolves the core types in the compiler when compiling with --nostdlib
293                 /// </summary>
294                 static public void ResolveCore ()
295                 {
296                         TypeContainer root = Tree.Types;
297
298                         TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
299                         TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
300                         TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
301                         TypeManager.indexer_name_type = BootstrapCorlib_ResolveClass (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
302                         
303                         string [] interfaces_first_stage = {
304                                 "System.IComparable", "System.ICloneable",
305                                 "System.IConvertible",
306                                 
307                                 "System.Collections.IEnumerable",
308                                 "System.Collections.ICollection",
309                                 "System.Collections.IEnumerator",
310                                 "System.Collections.IList", 
311                                 "System.IAsyncResult",
312                                 "System.IDisposable",
313                                 
314                                 "System.Runtime.Serialization.ISerializable",
315
316                                 "System.Reflection.IReflect",
317                                 "System.Reflection.ICustomAttributeProvider"
318                         };
319
320                         foreach (string iname in interfaces_first_stage)
321                                 BootstrapCorlib_ResolveInterface (root, iname);
322
323                         //
324                         // These are the base value types
325                         //
326                         string [] structs_first_stage = {
327                                 "System.Byte",    "System.SByte",
328                                 "System.Int16",   "System.UInt16",
329                                 "System.Int32",   "System.UInt32",
330                                 "System.Int64",   "System.UInt64",
331                         };
332
333                         foreach (string cname in structs_first_stage)
334                                 BootstrapCorlib_ResolveStruct (root, cname);
335
336                         //
337                         // Now, we can load the enumerations, after this point,
338                         // we can use enums.
339                         //
340                         TypeManager.InitEnumUnderlyingTypes ();
341
342                         string [] structs_second_stage = {
343                                 "System.Single",  "System.Double",
344                                 "System.Char",    "System.Boolean",
345                                 "System.Decimal", "System.Void",
346                                 "System.RuntimeFieldHandle",
347                                 "System.RuntimeArgumentHandle",
348                                 "System.RuntimeTypeHandle",
349                                 "System.IntPtr",
350                                 "System.TypedReference",
351                                 "System.ArgIterator"
352                         };
353                         
354                         foreach (string cname in structs_second_stage)
355                                 BootstrapCorlib_ResolveStruct (root, cname);
356                         
357                         //
358                         // These are classes that depends on the core interfaces
359                         //
360                         string [] classes_second_stage = {
361                                 "System.Enum",
362                                 "System.String",
363                                 "System.Array",
364                                 "System.Reflection.MemberInfo",
365                                 "System.Type",
366                                 "System.Exception",
367
368                                 //
369                                 // These are not really important in the order, but they
370                                 // are used by the compiler later on (typemanager/CoreLookupType-d)
371                                 //
372                                 "System.Runtime.CompilerServices.RuntimeHelpers",
373                                 "System.Reflection.DefaultMemberAttribute",
374                                 "System.Threading.Monitor",
375                                 
376                                 "System.AttributeUsageAttribute",
377                                 "System.Runtime.InteropServices.DllImportAttribute",
378                                 "System.Runtime.CompilerServices.MethodImplAttribute",
379                                 "System.Runtime.InteropServices.MarshalAsAttribute",
380                                 "System.Diagnostics.ConditionalAttribute",
381                                 "System.ObsoleteAttribute",
382                                 "System.ParamArrayAttribute",
383                                 "System.CLSCompliantAttribute",
384                                 "System.Security.UnverifiableCodeAttribute",
385                                 "System.Security.Permissions.SecurityAttribute",
386                                 "System.Runtime.CompilerServices.DecimalConstantAttribute",
387                                 "System.Runtime.InteropServices.InAttribute",
388                                 "System.Runtime.InteropServices.OutAttribute",
389                                 "System.Runtime.InteropServices.StructLayoutAttribute",
390                                 "System.Runtime.InteropServices.FieldOffsetAttribute",
391                                 "System.InvalidOperationException",
392                                 "System.NotSupportedException",
393                                 "System.MarshalByRefObject",
394                                 "System.Security.CodeAccessPermission",
395                                 "System.Runtime.CompilerServices.RequiredAttributeAttribute",
396                                 "System.Runtime.InteropServices.GuidAttribute",
397                                 "System.Reflection.AssemblyCultureAttribute"
398                         };
399
400                         foreach (string cname in classes_second_stage)
401                                 BootstrapCorlib_ResolveClass (root, cname);
402
403                         BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
404
405                         // These will be defined indirectly during the previous ResolveDelegate.
406                         // However make sure the rest of the checks happen.
407                         string [] delegate_types = { "System.Delegate", "System.MulticastDelegate" };
408                         foreach (string cname in delegate_types)
409                                 BootstrapCorlib_ResolveClass (root, cname);
410                 }
411                         
412                 // <summary>
413                 //   Closes all open types
414                 // </summary>
415                 //
416                 // <remarks>
417                 //   We usually use TypeBuilder types.  When we are done
418                 //   creating the type (which will happen after we have added
419                 //   methods, fields, etc) we need to "Define" them before we
420                 //   can save the Assembly
421                 // </remarks>
422                 static public void CloseTypes ()
423                 {
424                         TypeContainer root = Tree.Types;
425                         
426                         if (root.Enums != null)
427                                 foreach (Enum en in root.Enums)
428                                         en.CloseType ();
429
430                         //
431                         // We do this in two passes, first we close the structs,
432                         // then the classes, because it seems the code needs it this
433                         // way.  If this is really what is going on, we should probably
434                         // make sure that we define the structs in order as well.
435                         //
436                         foreach (TypeContainer tc in type_container_resolve_order){
437                                 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
438                                         tc.CloseType ();
439                                 }
440                         }
441
442                         foreach (TypeContainer tc in type_container_resolve_order){
443                                 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
444                                         tc.CloseType ();                                        
445                         }
446                         
447                         if (root.Delegates != null)
448                                 foreach (Delegate d in root.Delegates)
449                                         d.CloseType ();
450
451
452                         //
453                         // If we have a <PrivateImplementationDetails> class, close it
454                         //
455                         if (helper_classes != null){
456                                 foreach (TypeBuilder type_builder in helper_classes) {
457 #if NET_2_0
458                                         type_builder.SetCustomAttribute (TypeManager.compiler_generated_attr);
459 #endif
460                                         type_builder.CreateType ();
461                                 }
462                         }
463                         
464                         type_container_resolve_order = null;
465                         helper_classes = null;
466                         //tree = null;
467                         TypeManager.CleanUp ();
468                 }
469
470                 /// <summary>
471                 ///   Used to register classes that need to be closed after all the
472                 ///   user defined classes
473                 /// </summary>
474                 public static void RegisterCompilerGeneratedType (TypeBuilder helper_class)
475                 {
476                         if (helper_classes == null)
477                                 helper_classes = new ArrayList ();
478
479                         helper_classes.Add (helper_class);
480                 }
481                 
482                 static public void PopulateCoreType (TypeContainer root, string name)
483                 {
484                         DeclSpace ds = (DeclSpace) root.GetDefinition (name);
485
486                         ds.DefineMembers (root);
487                         ds.Define ();
488                 }
489                 
490                 static public void BootCorlib_PopulateCoreTypes ()
491                 {
492                         TypeContainer root = tree.Types;
493
494                         PopulateCoreType (root, "System.Object");
495                         PopulateCoreType (root, "System.ValueType");
496                         PopulateCoreType (root, "System.Attribute");
497                         PopulateCoreType (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
498                 }
499                 
500                 // <summary>
501                 //   Populates the structs and classes with fields and methods
502                 // </summary>
503                 //
504                 // This is invoked after all interfaces, structs and classes
505                 // have been defined through `ResolveTree' 
506                 static public void PopulateTypes ()
507                 {
508                         TypeContainer root = Tree.Types;
509
510                         if (type_container_resolve_order != null){
511                                 if (RootContext.StdLib){
512                                         foreach (TypeContainer tc in type_container_resolve_order)
513                                                 tc.DefineMembers (root);
514                                 } else {
515                                         foreach (TypeContainer tc in type_container_resolve_order) {
516                                                 // When compiling corlib, these types have already been
517                                                 // populated from BootCorlib_PopulateCoreTypes ().
518                                                 if (((tc.Name == "System.Object") ||
519                                                         (tc.Name == "System.Attribute") ||
520                                                         (tc.Name == "System.ValueType") ||
521                                                         (tc.Name == "System.Runtime.CompilerServices.IndexerNameAttribute")))
522                                                 continue;
523
524                                                 tc.DefineMembers (root);
525                                         }
526                                 } 
527                         }
528
529                         ArrayList delegates = root.Delegates;
530                         if (delegates != null){
531                                 foreach (Delegate d in delegates)
532                                         d.DefineMembers (root);
533                         }
534
535                         ArrayList enums = root.Enums;
536                         if (enums != null){
537                                 foreach (Enum en in enums)
538                                         en.DefineMembers (root);
539                         }
540
541                         //
542                         // Check for cycles in the struct layout
543                         //
544                         if (type_container_resolve_order != null){
545                                 Hashtable seen = new Hashtable ();
546                                 foreach (TypeContainer tc in type_container_resolve_order)
547                                         TypeManager.CheckStructCycles (tc, seen);
548                         }
549                 }
550
551                 //
552                 // A generic hook delegate
553                 //
554                 public delegate void Hook ();
555
556                 //
557                 // A hook invoked when the code has been generated.
558                 //
559                 public static event Hook EmitCodeHook;
560
561                 //
562                 // DefineTypes is used to fill in the members of each type.
563                 //
564                 static public void DefineTypes ()
565                 {
566                         TypeContainer root = Tree.Types;
567
568                         ArrayList delegates = root.Delegates;
569                         if (delegates != null){
570                                 foreach (Delegate d in delegates)
571                                         d.Define ();
572                         }
573
574                         if (type_container_resolve_order != null){
575                                 foreach (TypeContainer tc in type_container_resolve_order) {
576                                         // When compiling corlib, these types have already been
577                                         // populated from BootCorlib_PopulateCoreTypes ().
578                                         if (!RootContext.StdLib &&
579                                             ((tc.Name == "System.Object") ||
580                                              (tc.Name == "System.Attribute") ||
581                                              (tc.Name == "System.ValueType") ||
582                                              (tc.Name == "System.Runtime.CompilerServices.IndexerNameAttribute")))
583                                                 continue;
584
585                                         tc.Define ();
586                                 }
587                         }
588
589                         ArrayList enums = root.Enums;
590                         if (enums != null){
591                                 foreach (Enum en in enums)
592                                         en.Define ();
593                         }
594                 }
595
596                 static public void EmitCode ()
597                 {
598                         if (Tree.Types.Enums != null) {
599                                 foreach (Enum e in Tree.Types.Enums)
600                                         e.Emit ();
601                         }
602
603                         if (type_container_resolve_order != null) {
604                                 foreach (TypeContainer tc in type_container_resolve_order)
605                                         tc.EmitType ();
606
607                                 if (Report.Errors > 0)
608                                         return;
609
610                                 foreach (TypeContainer tc in type_container_resolve_order)
611                                         tc.VerifyMembers ();
612                         }
613                         
614                         if (Tree.Types.Delegates != null) {
615                                 foreach (Delegate d in Tree.Types.Delegates)
616                                         d.Emit ();
617                         }                       
618                         //
619                         // Run any hooks after all the types have been defined.
620                         // This is used to create nested auxiliary classes for example
621                         //
622
623                         if (EmitCodeHook != null)
624                                 EmitCodeHook ();
625
626                         CodeGen.Assembly.Emit (Tree.Types);
627                         CodeGen.Module.Emit (Tree.Types);
628                 }
629                 
630                 //
631                 // Public Field, used to track which method is the public entry
632                 // point.
633                 //
634                 static public MethodInfo EntryPoint;
635
636                 //
637                 // Track the location of the entry point.
638                 //
639                 static public Location EntryPointLocation;
640
641                 //
642                 // These are used to generate unique names on the structs and fields.
643                 //
644                 static int field_count;
645                 
646                 //
647                 // Makes an initialized struct, returns the field builder that
648                 // references the data.  Thanks go to Sergey Chaban for researching
649                 // how to do this.  And coming up with a shorter mechanism than I
650                 // was able to figure out.
651                 //
652                 // This works but makes an implicit public struct $ArrayType$SIZE and
653                 // makes the fields point to it.  We could get more control if we did
654                 // use instead:
655                 //
656                 // 1. DefineNestedType on the impl_details_class with our struct.
657                 //
658                 // 2. Define the field on the impl_details_class
659                 //
660                 static public FieldBuilder MakeStaticData (byte [] data)
661                 {
662                         FieldBuilder fb;
663                         
664                         if (impl_details_class == null){
665                                 impl_details_class = CodeGen.Module.Builder.DefineType (
666                                         "<PrivateImplementationDetails>",
667                                         TypeAttributes.NotPublic,
668                                         TypeManager.object_type);
669                                 
670                                 RegisterCompilerGeneratedType (impl_details_class);
671                         }
672
673                         fb = impl_details_class.DefineInitializedData (
674                                 "$$field-" + (field_count++), data,
675                                 FieldAttributes.Static | FieldAttributes.Assembly);
676                         
677                         return fb;
678                 }
679
680                 public static void CheckUnsafeOption (Location loc)
681                 {
682                         if (!Unsafe) {
683                                 Report.Error (227, loc, 
684                                         "Unsafe code requires the `unsafe' command line option to be specified");
685                         }
686                 }
687         }
688 }
689               
690