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)
12 using System.Collections;
13 using System.Reflection;
14 using System.Reflection.Emit;
15 using System.Diagnostics;
17 namespace Mono.CSharp {
19 public class RootContext {
22 // Contains the parsed tree
27 // This hashtable contains all of the #definitions across the source code
28 // it is used by the ConditionalAttribute handler.
30 public static Hashtable AllDefines = new Hashtable ();
33 // Whether we are being linked against the standard libraries.
34 // This is only used to tell whether `System.Object' should
35 // have a parent or not.
37 public static bool StdLib = true;
40 // This keeps track of the order in which classes were defined
41 // so that we can poulate them in that order.
43 // Order is important, because we need to be able to tell by
44 // examining the parent's list of methods which ones are virtual
45 // or abstract as well as the parent names (to implement new,
48 static ArrayList type_container_resolve_order;
49 static ArrayList interface_resolve_order;
50 static ArrayList attribute_types;
53 // Holds a reference to the Private Implementation Details
56 static ArrayList helper_classes;
58 static TypeBuilder impl_details_class;
60 public static int WarningLevel = 2;
62 public static Target Target = Target.Exe;
63 public static string TargetExt = ".exe";
65 public static bool VerifyClsCompliance = true;
68 // If set, enable C# version 2 features
70 public static bool V2 = true;
73 // We keep strongname related info here because
74 // it's also used as complier options from CSC 8.x
76 public static string StrongNameKeyFile;
77 public static string StrongNameKeyContainer;
78 public static bool StrongNameDelaySign = false;
86 interface_resolve_order = new ArrayList ();
87 type_container_resolve_order = new ArrayList ();
90 public static bool NeedsEntryPoint {
92 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
96 static public Tree Tree {
102 static public string MainClass;
104 public static void RegisterOrder (Interface iface)
106 interface_resolve_order.Add (iface);
109 public static void RegisterOrder (TypeContainer tc)
111 type_container_resolve_order.Add (tc);
114 public static void RegisterAttribute (TypeContainer tc)
116 if (attribute_types == null)
117 attribute_types = new ArrayList ();
119 attribute_types.Add (tc);
123 // The default compiler checked state
125 static public bool Checked = false;
128 // Whether to allow Unsafe code
130 static public bool Unsafe = false;
132 static string MakeFQN (string nsn, string name)
136 return String.Concat (nsn, ".", name);
140 // This function is used to resolve the hierarchy tree.
141 // It processes interfaces, structs and classes in that order.
143 // It creates the TypeBuilder's as it processes the user defined
146 static public void ResolveTree ()
149 // Process the attribute types separately and before anything else
151 if (attribute_types != null)
152 foreach (TypeContainer tc in attribute_types)
156 // Interfaces are processed next, as classes and
157 // structs might inherit from an object or implement
158 // a set of interfaces, we need to be able to tell
159 // them appart by just using the TypeManager.
161 TypeContainer root = Tree.Types;
163 ArrayList ifaces = root.Interfaces;
165 foreach (Interface i in ifaces)
169 foreach (TypeContainer tc in root.Types)
172 if (root.Delegates != null)
173 foreach (Delegate d in root.Delegates)
176 if (root.Enums != null)
177 foreach (Enum e in root.Enums)
181 static void Error_TypeConflict (string name, Location loc)
184 520, loc, "`" + name + "' conflicts with a predefined type");
187 static void Error_TypeConflict (string name)
190 520, "`" + name + "' conflicts with a predefined type");
194 // Resolves a single class during the corlib bootstrap process
196 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
198 object o = root.GetDefinition (name);
200 Report.Error (518, "The predefined type `" + name + "' is not defined");
206 DeclSpace d = (DeclSpace) o;
208 Error_TypeConflict (name, d.Location);
210 Error_TypeConflict (name);
215 return ((DeclSpace) o).DefineType ();
219 // Resolves a struct during the corlib bootstrap process
221 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
223 object o = root.GetDefinition (name);
225 Report.Error (518, "The predefined type `" + name + "' is not defined");
231 DeclSpace d = (DeclSpace) o;
233 Error_TypeConflict (name, d.Location);
235 Error_TypeConflict (name);
240 ((DeclSpace) o).DefineType ();
244 // Resolves a struct during the corlib bootstrap process
246 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
248 object o = root.GetDefinition (name);
250 Report.Error (518, "The predefined type `" + name + "' is not defined");
254 if (!(o is Interface)){
256 DeclSpace d = (DeclSpace) o;
258 Error_TypeConflict (name, d.Location);
260 Error_TypeConflict (name);
265 ((DeclSpace) o).DefineType ();
269 // Resolves a delegate during the corlib bootstrap process
271 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
273 object o = root.GetDefinition (name);
275 Report.Error (518, "The predefined type `" + name + "' is not defined");
276 Environment.Exit (1);
279 if (!(o is Delegate)){
280 Error_TypeConflict (name);
284 ((DeclSpace) o).DefineType ();
289 /// Resolves the core types in the compiler when compiling with --nostdlib
291 static public void ResolveCore ()
293 TypeContainer root = Tree.Types;
295 TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
296 TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
297 TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
299 string [] interfaces_first_stage = {
300 "System.IComparable", "System.ICloneable",
301 "System.IConvertible",
303 "System.Collections.IEnumerable",
304 "System.Collections.ICollection",
305 "System.Collections.IEnumerator",
306 "System.Collections.IList",
307 "System.IAsyncResult",
308 "System.IDisposable",
310 "System.Runtime.Serialization.ISerializable",
312 "System.Reflection.IReflect",
313 "System.Reflection.ICustomAttributeProvider"
316 foreach (string iname in interfaces_first_stage)
317 BootstrapCorlib_ResolveInterface (root, iname);
320 // These are the base value types
322 string [] structs_first_stage = {
323 "System.Byte", "System.SByte",
324 "System.Int16", "System.UInt16",
325 "System.Int32", "System.UInt32",
326 "System.Int64", "System.UInt64",
329 foreach (string cname in structs_first_stage)
330 BootstrapCorlib_ResolveStruct (root, cname);
333 // Now, we can load the enumerations, after this point,
336 TypeManager.InitEnumUnderlyingTypes ();
338 string [] structs_second_stage = {
339 "System.Single", "System.Double",
340 "System.Char", "System.Boolean",
341 "System.Decimal", "System.Void",
342 "System.RuntimeFieldHandle",
343 "System.RuntimeArgumentHandle",
344 "System.RuntimeTypeHandle",
346 "System.TypedReference",
350 foreach (string cname in structs_second_stage)
351 BootstrapCorlib_ResolveStruct (root, cname);
354 // These are classes that depends on the core interfaces
356 string [] classes_second_stage = {
357 "System.Reflection.MemberInfo",
362 // These are not really important in the order, but they
363 // are used by the compiler later on (typemanager/CoreLookupType-d)
365 "System.Runtime.CompilerServices.RuntimeHelpers",
366 "System.Reflection.DefaultMemberAttribute",
367 "System.Threading.Monitor",
369 "System.AttributeUsageAttribute",
370 "System.Runtime.InteropServices.DllImportAttribute",
371 "System.Runtime.CompilerServices.MethodImplAttribute",
372 "System.Runtime.InteropServices.MarshalAsAttribute",
373 "System.Diagnostics.ConditionalAttribute",
374 "System.ObsoleteAttribute",
375 "System.ParamArrayAttribute",
376 "System.CLSCompliantAttribute",
377 "System.Security.UnverifiableCodeAttribute",
378 "System.Runtime.CompilerServices.IndexerNameAttribute",
379 "System.Runtime.InteropServices.InAttribute",
380 "System.Runtime.InteropServices.StructLayoutAttribute",
381 "System.Runtime.InteropServices.FieldOffsetAttribute",
382 "System.InvalidOperationException",
383 "System.MarshalByRefObject"
386 // We must store them here before calling BootstrapCorlib_ResolveDelegate.
387 TypeManager.string_type = BootstrapCorlib_ResolveClass (root, "System.String");
388 TypeManager.enum_type = BootstrapCorlib_ResolveClass (root, "System.Enum");
389 TypeManager.array_type = BootstrapCorlib_ResolveClass (root, "System.Array");
390 TypeManager.multicast_delegate_type = BootstrapCorlib_ResolveClass (root, "System.MulticastDelegate");
391 TypeManager.delegate_type = BootstrapCorlib_ResolveClass (root, "System.Delegate");
393 foreach (string cname in classes_second_stage)
394 BootstrapCorlib_ResolveClass (root, cname);
396 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
400 // Closes all open types
404 // We usually use TypeBuilder types. When we are done
405 // creating the type (which will happen after we have added
406 // methods, fields, etc) we need to "Define" them before we
407 // can save the Assembly
409 static public void CloseTypes ()
411 TypeContainer root = Tree.Types;
413 if (root.Enums != null)
414 foreach (Enum en in root.Enums)
417 if (attribute_types != null)
418 foreach (TypeContainer tc in attribute_types)
421 foreach (Interface iface in interface_resolve_order)
425 // We do this in two passes, first we close the structs,
426 // then the classes, because it seems the code needs it this
427 // way. If this is really what is going on, we should probably
428 // make sure that we define the structs in order as well.
430 foreach (TypeContainer tc in type_container_resolve_order){
431 if (tc is Struct && tc.Parent == tree.Types){
436 foreach (TypeContainer tc in type_container_resolve_order){
437 if (!(tc is Struct && tc.Parent == tree.Types))
441 if (root.Delegates != null)
442 foreach (Delegate d in root.Delegates)
447 // If we have a <PrivateImplementationDetails> class, close it
449 if (helper_classes != null){
450 foreach (TypeBuilder type_builder in helper_classes)
451 type_builder.CreateType ();
454 attribute_types = null;
455 interface_resolve_order = null;
456 type_container_resolve_order = null;
457 helper_classes = null;
459 TypeManager.CleanUp ();
463 /// Used to register classes that need to be closed after all the
464 /// user defined classes
466 public static void RegisterHelperClass (TypeBuilder helper_class)
468 if (helper_classes == null)
469 helper_classes = new ArrayList ();
470 helper_classes.Add (helper_class);
474 // This idea is from Felix Arrese-Igor
476 // Returns : the implicit parent of a composite namespace string
477 // eg. Implicit parent of A.B is A
479 static public string ImplicitParent (string ns)
481 int i = ns.LastIndexOf ('.');
485 return ns.Substring (0, i);
488 static Type NamespaceLookup (DeclSpace ds, string name, bool silent,
492 // Try in the current namespace and all its implicit parents
494 for (NamespaceEntry ns = ds.NamespaceEntry; ns != null; ns = ns.ImplicitParent) {
495 object result = ns.Lookup (ds, name, silent, loc);
500 return (Type) result;
509 // Public function used to locate types, this can only
510 // be used after the ResolveTree function has been invoked.
512 // Returns: Type or null if they type can not be found.
514 // Come to think of it, this should be a DeclSpace
516 static public Type LookupType (DeclSpace ds, string name, bool silent, Location loc)
520 if (ds.Cache.Contains (name)) {
521 t = (Type) ds.Cache [name];
524 // For the case the type we are looking for is nested within this one
525 // or is in any base class
527 DeclSpace containing_ds = ds;
528 while (containing_ds != null){
530 // if the member cache has been created, lets use it.
531 // the member cache is MUCH faster.
532 if (containing_ds.MemberCache != null) {
533 t = containing_ds.MemberCache.FindNestedType (name);
535 containing_ds = containing_ds.Parent;
543 // no member cache. Do it the hard way -- reflection
544 Type current_type = containing_ds.TypeBuilder;
546 while (current_type != null &&
547 current_type != TypeManager.object_type) {
551 t = TypeManager.LookupType (current_type.FullName + "." + name);
557 current_type = current_type.BaseType;
560 containing_ds = containing_ds.Parent;
563 t = NamespaceLookup (ds, name, silent, loc);
568 if (t == null && !silent)
569 Report.Error (246, loc, "Cannot find type `"+name+"'");
575 // This is the silent version of LookupType, you can use this
576 // to `probe' for a type
578 static public Type LookupType (TypeContainer tc, string name, Location loc)
580 return LookupType (tc, name, true, loc);
583 static public bool IsNamespace (string name)
587 if (tree.Namespaces != null){
588 ns = (Namespace) tree.Namespaces [name];
597 static void Report1530 (Location loc)
599 Report.Error (1530, loc, "Keyword new not allowed for namespace elements");
602 static public void PopulateCoreType (TypeContainer root, string name)
604 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
606 ds.DefineMembers (root);
610 static public void BootCorlib_PopulateCoreTypes ()
612 TypeContainer root = tree.Types;
614 PopulateCoreType (root, "System.Object");
615 PopulateCoreType (root, "System.ValueType");
616 PopulateCoreType (root, "System.Attribute");
620 // Populates the structs and classes with fields and methods
623 // This is invoked after all interfaces, structs and classes
624 // have been defined through `ResolveTree'
625 static public void PopulateTypes ()
627 TypeContainer root = Tree.Types;
629 if (attribute_types != null)
630 foreach (TypeContainer tc in attribute_types)
631 tc.DefineMembers (root);
633 if (interface_resolve_order != null){
634 foreach (Interface iface in interface_resolve_order)
635 if ((iface.ModFlags & Modifiers.NEW) == 0)
636 iface.DefineMembers (root);
638 Report1530 (iface.Location);
642 if (type_container_resolve_order != null){
643 if (RootContext.StdLib){
644 foreach (TypeContainer tc in type_container_resolve_order)
645 tc.DefineMembers (root);
647 foreach (TypeContainer tc in type_container_resolve_order) {
648 // When compiling corlib, these types have already been
649 // populated from BootCorlib_PopulateCoreTypes ().
650 if (((tc.Name == "System.Object") ||
651 (tc.Name == "System.Attribute") ||
652 (tc.Name == "System.ValueType")))
655 tc.DefineMembers (root);
660 ArrayList delegates = root.Delegates;
661 if (delegates != null){
662 foreach (Delegate d in delegates)
663 if ((d.ModFlags & Modifiers.NEW) == 0)
664 d.DefineMembers (root);
666 Report1530 (d.Location);
669 ArrayList enums = root.Enums;
671 foreach (Enum en in enums)
672 if ((en.ModFlags & Modifiers.NEW) == 0)
673 en.DefineMembers (root);
675 Report1530 (en.Location);
679 // Check for cycles in the struct layout
681 if (type_container_resolve_order != null){
682 Hashtable seen = new Hashtable ();
683 foreach (TypeContainer tc in type_container_resolve_order)
684 TypeManager.CheckStructCycles (tc, seen);
689 // A generic hook delegate
691 public delegate void Hook ();
694 // A hook invoked when the code has been generated.
696 public static event Hook EmitCodeHook;
699 // DefineTypes is used to fill in the members of each type.
701 static public void DefineTypes ()
703 TypeContainer root = Tree.Types;
705 if (attribute_types != null)
706 foreach (TypeContainer tc in attribute_types)
709 if (interface_resolve_order != null){
710 foreach (Interface iface in interface_resolve_order)
711 if ((iface.ModFlags & Modifiers.NEW) == 0)
716 if (type_container_resolve_order != null){
717 foreach (TypeContainer tc in type_container_resolve_order) {
718 // When compiling corlib, these types have already been
719 // populated from BootCorlib_PopulateCoreTypes ().
720 if (!RootContext.StdLib &&
721 ((tc.Name == "System.Object") ||
722 (tc.Name == "System.Attribute") ||
723 (tc.Name == "System.ValueType")))
726 if ((tc.ModFlags & Modifiers.NEW) == 0)
731 ArrayList delegates = root.Delegates;
732 if (delegates != null){
733 foreach (Delegate d in delegates)
734 if ((d.ModFlags & Modifiers.NEW) == 0)
738 ArrayList enums = root.Enums;
740 foreach (Enum en in enums)
741 if ((en.ModFlags & Modifiers.NEW) == 0)
746 static public void EmitCode ()
748 if (attribute_types != null)
749 foreach (TypeContainer tc in attribute_types)
752 CodeGen.Assembly.Emit (Tree.Types);
753 CodeGen.Module.Emit (Tree.Types);
755 if (Tree.Types.Enums != null) {
756 foreach (Enum e in Tree.Types.Enums)
760 if (interface_resolve_order != null) {
761 foreach (Interface iface in interface_resolve_order)
762 iface.Emit (Tree.Types);
765 if (type_container_resolve_order != null) {
766 foreach (TypeContainer tc in type_container_resolve_order)
769 foreach (TypeContainer tc in type_container_resolve_order)
773 if (Tree.Types.Delegates != null) {
774 foreach (Delegate d in Tree.Types.Delegates)
778 // Run any hooks after all the types have been defined.
779 // This is used to create nested auxiliary classes for example
782 if (EmitCodeHook != null)
787 // Public Field, used to track which method is the public entry
790 static public MethodInfo EntryPoint;
793 // Track the location of the entry point.
795 static public Location EntryPointLocation;
798 // These are used to generate unique names on the structs and fields.
800 static int field_count;
803 // Makes an initialized struct, returns the field builder that
804 // references the data. Thanks go to Sergey Chaban for researching
805 // how to do this. And coming up with a shorter mechanism than I
806 // was able to figure out.
808 // This works but makes an implicit public struct $ArrayType$SIZE and
809 // makes the fields point to it. We could get more control if we did
812 // 1. DefineNestedType on the impl_details_class with our struct.
814 // 2. Define the field on the impl_details_class
816 static public FieldBuilder MakeStaticData (byte [] data)
820 if (impl_details_class == null){
821 impl_details_class = CodeGen.Module.Builder.DefineType (
822 "<PrivateImplementationDetails>",
823 TypeAttributes.NotPublic,
824 TypeManager.object_type);
826 RegisterHelperClass (impl_details_class);
829 fb = impl_details_class.DefineInitializedData (
830 "$$field-" + (field_count++), data,
831 FieldAttributes.Static | FieldAttributes.Assembly);