2 // rootcontext.cs: keeps track of our tree representation, and assemblies loaded.
4 // Author: Miguel de Icaza (miguel@ximian.com)
5 // Ravi Pratap (ravi@ximian.com)
7 // Licensed under the terms of the GNU GPL
9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
10 // (C) 2004 Novell, Inc
13 using System.Collections;
14 using System.Reflection;
15 using System.Reflection.Emit;
16 using System.Diagnostics;
19 namespace Mono.CSharp {
21 public enum LanguageVersion
27 public class RootContext {
30 // Contains the parsed tree
35 // This hashtable contains all of the #definitions across the source code
36 // it is used by the ConditionalAttribute handler.
38 public static Hashtable AllDefines = new Hashtable ();
41 // Whether we are being linked against the standard libraries.
42 // This is only used to tell whether `System.Object' should
43 // have a base class or not.
45 public static bool StdLib = true;
48 // This keeps track of the order in which classes were defined
49 // so that we can poulate them in that order.
51 // Order is important, because we need to be able to tell, by
52 // examining the list of methods of the base class, which ones are virtual
53 // or abstract as well as the parent names (to implement new,
56 static ArrayList type_container_resolve_order;
57 static ArrayList attribute_types;
60 // Holds a reference to the Private Implementation Details
63 static ArrayList helper_classes;
65 static TypeBuilder impl_details_class;
67 public static int WarningLevel = 3;
69 public static Target Target = Target.Exe;
70 public static string TargetExt = ".exe";
72 public static bool VerifyClsCompliance = true;
74 public static LanguageVersion Version = LanguageVersion.Default;
77 // We keep strongname related info here because
78 // it's also used as complier options from CSC 8.x
80 public static string StrongNameKeyFile;
81 public static string StrongNameKeyContainer;
82 public static bool StrongNameDelaySign = false;
85 // If set, enable XML documentation generation
87 public static Documentation Documentation;
95 type_container_resolve_order = new ArrayList ();
98 public static bool NeedsEntryPoint {
100 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
104 static public Tree Tree {
110 static public string MainClass;
112 public static void RegisterOrder (TypeContainer tc)
114 type_container_resolve_order.Add (tc);
117 public static void RegisterAttribute (TypeContainer tc)
119 if (attribute_types == null)
120 attribute_types = new ArrayList ();
122 attribute_types.Add (tc);
126 // The default compiler checked state
128 static public bool Checked = false;
131 // Whether to allow Unsafe code
133 static public bool Unsafe = false;
135 static string MakeFQN (string nsn, string name)
139 return String.Concat (nsn, ".", name);
143 // This function is used to resolve the hierarchy tree.
144 // It processes interfaces, structs and classes in that order.
146 // It creates the TypeBuilder's as it processes the user defined
149 static public void ResolveTree ()
152 // Process the attribute types separately and before anything else
154 if (attribute_types != null)
155 foreach (TypeContainer tc in attribute_types)
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.
164 TypeContainer root = Tree.Types;
166 ArrayList ifaces = root.Interfaces;
168 foreach (Interface i in ifaces)
172 foreach (TypeContainer tc in root.Types)
175 if (root.Delegates != null)
176 foreach (Delegate d in root.Delegates)
179 if (root.Enums != null)
180 foreach (Enum e in root.Enums)
184 static void Error_TypeConflict (string name, Location loc)
187 520, loc, "`" + name + "' conflicts with a predefined type");
190 static void Error_TypeConflict (string name)
193 520, "`" + name + "' conflicts with a predefined type");
197 // Resolves a single class during the corlib bootstrap process
199 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
201 object o = root.GetDefinition (name);
203 Report.Error (518, "The predefined type `" + name + "' is not defined");
209 DeclSpace d = (DeclSpace) o;
211 Error_TypeConflict (name, d.Location);
213 Error_TypeConflict (name);
218 return ((DeclSpace) o).DefineType ();
222 // Resolves a struct during the corlib bootstrap process
224 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
226 object o = root.GetDefinition (name);
228 Report.Error (518, "The predefined type `" + name + "' is not defined");
234 DeclSpace d = (DeclSpace) o;
236 Error_TypeConflict (name, d.Location);
238 Error_TypeConflict (name);
243 ((DeclSpace) o).DefineType ();
247 // Resolves a struct during the corlib bootstrap process
249 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
251 object o = root.GetDefinition (name);
253 Report.Error (518, "The predefined type `" + name + "' is not defined");
257 if (!(o is Interface)){
259 DeclSpace d = (DeclSpace) o;
261 Error_TypeConflict (name, d.Location);
263 Error_TypeConflict (name);
268 ((DeclSpace) o).DefineType ();
272 // Resolves a delegate during the corlib bootstrap process
274 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
276 object o = root.GetDefinition (name);
278 Report.Error (518, "The predefined type `" + name + "' is not defined");
279 Environment.Exit (1);
282 if (!(o is Delegate)){
283 Error_TypeConflict (name);
287 ((DeclSpace) o).DefineType ();
292 /// Resolves the core types in the compiler when compiling with --nostdlib
294 static public void ResolveCore ()
296 TypeContainer root = Tree.Types;
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");
302 string [] interfaces_first_stage = {
303 "System.IComparable", "System.ICloneable",
304 "System.IConvertible",
306 "System.Collections.IEnumerable",
307 "System.Collections.ICollection",
308 "System.Collections.IEnumerator",
309 "System.Collections.IList",
310 "System.IAsyncResult",
311 "System.IDisposable",
313 "System.Runtime.Serialization.ISerializable",
314 "System.Runtime.InteropServices._Exception",
316 "System.Reflection.IReflect",
317 "System.Reflection.ICustomAttributeProvider",
322 "System.Collections.Generic.IEnumerator`1",
323 "System.Collections.Generic.IEnumerable`1",
326 foreach (string iname in interfaces_first_stage)
327 BootstrapCorlib_ResolveInterface (root, iname);
330 // These are the base value types
332 string [] structs_first_stage = {
333 "System.Byte", "System.SByte",
334 "System.Int16", "System.UInt16",
335 "System.Int32", "System.UInt32",
336 "System.Int64", "System.UInt64",
339 foreach (string cname in structs_first_stage)
340 BootstrapCorlib_ResolveStruct (root, cname);
343 // Now, we can load the enumerations, after this point,
346 TypeManager.InitEnumUnderlyingTypes ();
348 string [] structs_second_stage = {
349 "System.Single", "System.Double",
350 "System.Char", "System.Boolean",
351 "System.Decimal", "System.Void",
352 "System.RuntimeFieldHandle",
353 "System.RuntimeArgumentHandle",
354 "System.RuntimeTypeHandle",
356 "System.TypedReference",
360 foreach (string cname in structs_second_stage)
361 BootstrapCorlib_ResolveStruct (root, cname);
364 // These are classes that depends on the core interfaces
366 string [] classes_second_stage = {
370 "System.Reflection.MemberInfo",
376 // These are not really important in the order, but they
377 // are used by the compiler later on (typemanager/CoreLookupType-d)
379 "System.Runtime.CompilerServices.RuntimeHelpers",
380 "System.Reflection.DefaultMemberAttribute",
381 "System.Threading.Monitor",
383 "System.AttributeUsageAttribute",
384 "System.Runtime.InteropServices.DllImportAttribute",
385 "System.Runtime.CompilerServices.MethodImplAttribute",
386 "System.Runtime.InteropServices.MarshalAsAttribute",
387 "System.Runtime.CompilerServices.NewConstraintAttribute",
388 "System.Diagnostics.ConditionalAttribute",
389 "System.ObsoleteAttribute",
390 "System.ParamArrayAttribute",
391 "System.CLSCompliantAttribute",
392 "System.Security.UnverifiableCodeAttribute",
393 "System.Security.Permissions.SecurityAttribute",
394 "System.Runtime.CompilerServices.IndexerNameAttribute",
395 "System.Runtime.CompilerServices.DecimalConstantAttribute",
396 "System.Runtime.InteropServices.InAttribute",
397 "System.Runtime.InteropServices.OutAttribute",
398 "System.Runtime.InteropServices.StructLayoutAttribute",
399 "System.Runtime.InteropServices.FieldOffsetAttribute",
400 "System.InvalidOperationException",
401 "System.NotSupportedException",
402 "System.MarshalByRefObject",
403 "System.Security.CodeAccessPermission"
406 foreach (string cname in classes_second_stage)
407 BootstrapCorlib_ResolveClass (root, cname);
409 BootstrapCorlib_ResolveStruct (root, "System.Nullable`1");
411 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
413 // These will be defined indirectly during the previous ResolveDelegate.
414 // However make sure the rest of the checks happen.
415 string [] delegate_types = { "System.Delegate", "System.MulticastDelegate" };
416 foreach (string cname in delegate_types)
417 BootstrapCorlib_ResolveClass (root, cname);
421 // Closes all open types
425 // We usually use TypeBuilder types. When we are done
426 // creating the type (which will happen after we have added
427 // methods, fields, etc) we need to "Define" them before we
428 // can save the Assembly
430 static public void CloseTypes ()
432 TypeContainer root = Tree.Types;
434 if (root.Enums != null)
435 foreach (Enum en in root.Enums)
438 if (attribute_types != null)
439 foreach (TypeContainer tc in attribute_types)
443 // We do this in two passes, first we close the structs,
444 // then the classes, because it seems the code needs it this
445 // way. If this is really what is going on, we should probably
446 // make sure that we define the structs in order as well.
448 foreach (TypeContainer tc in type_container_resolve_order){
449 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
454 foreach (TypeContainer tc in type_container_resolve_order){
455 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
459 if (root.Delegates != null)
460 foreach (Delegate d in root.Delegates)
465 // If we have a <PrivateImplementationDetails> class, close it
467 if (helper_classes != null){
468 foreach (TypeBuilder type_builder in helper_classes)
469 type_builder.CreateType ();
472 attribute_types = null;
473 type_container_resolve_order = null;
474 helper_classes = null;
476 TypeManager.CleanUp ();
480 /// Used to register classes that need to be closed after all the
481 /// user defined classes
483 public static void RegisterHelperClass (TypeBuilder helper_class)
485 if (helper_classes == null)
486 helper_classes = new ArrayList ();
487 helper_classes.Add (helper_class);
490 static void Report1530 (Location loc)
492 Report.Error (1530, loc, "Keyword new not allowed for namespace elements");
495 static public void PopulateCoreType (TypeContainer root, string name)
497 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
499 ds.DefineMembers (root);
503 static public void BootCorlib_PopulateCoreTypes ()
505 TypeContainer root = tree.Types;
507 PopulateCoreType (root, "System.Object");
508 PopulateCoreType (root, "System.ValueType");
509 PopulateCoreType (root, "System.Attribute");
513 // Populates the structs and classes with fields and methods
516 // This is invoked after all interfaces, structs and classes
517 // have been defined through `ResolveTree'
518 static public void PopulateTypes ()
520 TypeContainer root = Tree.Types;
522 if (attribute_types != null)
523 foreach (TypeContainer tc in attribute_types)
524 tc.DefineMembers (root);
526 if (type_container_resolve_order != null){
527 if (RootContext.StdLib){
528 foreach (TypeContainer tc in type_container_resolve_order)
529 tc.DefineMembers (root);
531 foreach (TypeContainer tc in type_container_resolve_order) {
532 // When compiling corlib, these types have already been
533 // populated from BootCorlib_PopulateCoreTypes ().
534 if (((tc.Name == "System.Object") ||
535 (tc.Name == "System.Attribute") ||
536 (tc.Name == "System.ValueType")))
539 tc.DefineMembers (root);
544 ArrayList delegates = root.Delegates;
545 if (delegates != null){
546 foreach (Delegate d in delegates)
547 if ((d.ModFlags & Modifiers.NEW) == 0)
548 d.DefineMembers (root);
550 Report1530 (d.Location);
553 ArrayList enums = root.Enums;
555 foreach (Enum en in enums)
556 if ((en.ModFlags & Modifiers.NEW) == 0)
557 en.DefineMembers (root);
559 Report1530 (en.Location);
563 // Check for cycles in the struct layout
565 if (type_container_resolve_order != null){
566 Hashtable seen = new Hashtable ();
567 foreach (TypeContainer tc in type_container_resolve_order)
568 TypeManager.CheckStructCycles (tc, seen);
573 // A generic hook delegate
575 public delegate void Hook ();
578 // A hook invoked when the code has been generated.
580 public static event Hook EmitCodeHook;
583 // DefineTypes is used to fill in the members of each type.
585 static public void DefineTypes ()
587 TypeContainer root = Tree.Types;
589 if (attribute_types != null)
590 foreach (TypeContainer tc in attribute_types)
593 if (type_container_resolve_order != null){
594 foreach (TypeContainer tc in type_container_resolve_order) {
595 // When compiling corlib, these types have already been
596 // populated from BootCorlib_PopulateCoreTypes ().
597 if (!RootContext.StdLib &&
598 ((tc.Name == "System.Object") ||
599 (tc.Name == "System.Attribute") ||
600 (tc.Name == "System.ValueType")))
603 if ((tc.ModFlags & Modifiers.NEW) == 0)
608 ArrayList delegates = root.Delegates;
609 if (delegates != null){
610 foreach (Delegate d in delegates)
611 if ((d.ModFlags & Modifiers.NEW) == 0)
615 ArrayList enums = root.Enums;
617 foreach (Enum en in enums)
618 if ((en.ModFlags & Modifiers.NEW) == 0)
623 static public void EmitCode ()
625 if (attribute_types != null)
626 foreach (TypeContainer tc in attribute_types)
629 CodeGen.Assembly.Emit (Tree.Types);
630 CodeGen.Module.Emit (Tree.Types);
632 if (Tree.Types.Enums != null) {
633 foreach (Enum e in Tree.Types.Enums)
637 if (type_container_resolve_order != null) {
638 foreach (TypeContainer tc in type_container_resolve_order)
642 if (Tree.Types.Delegates != null) {
643 foreach (Delegate d in Tree.Types.Delegates)
647 // Run any hooks after all the types have been defined.
648 // This is used to create nested auxiliary classes for example
651 if (EmitCodeHook != null)
656 // Public Field, used to track which method is the public entry
659 static public MethodInfo EntryPoint;
662 // Track the location of the entry point.
664 static public Location EntryPointLocation;
667 // These are used to generate unique names on the structs and fields.
669 static int field_count;
672 // Makes an initialized struct, returns the field builder that
673 // references the data. Thanks go to Sergey Chaban for researching
674 // how to do this. And coming up with a shorter mechanism than I
675 // was able to figure out.
677 // This works but makes an implicit public struct $ArrayType$SIZE and
678 // makes the fields point to it. We could get more control if we did
681 // 1. DefineNestedType on the impl_details_class with our struct.
683 // 2. Define the field on the impl_details_class
685 static public FieldBuilder MakeStaticData (byte [] data)
689 if (impl_details_class == null){
690 impl_details_class = CodeGen.Module.Builder.DefineType (
691 "<PrivateImplementationDetails>",
692 TypeAttributes.NotPublic,
693 TypeManager.object_type);
695 RegisterHelperClass (impl_details_class);
698 fb = impl_details_class.DefineInitializedData (
699 "$$field-" + (field_count++), data,
700 FieldAttributes.Static | FieldAttributes.Assembly);