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.RuntimeTypeHandle",
345 "System.TypedReference",
349 foreach (string cname in structs_second_stage)
350 BootstrapCorlib_ResolveStruct (root, cname);
353 // These are classes that depends on the core interfaces
355 string [] classes_second_stage = {
356 "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.Runtime.CompilerServices.NewConstraintAttribute",
374 "System.Diagnostics.ConditionalAttribute",
375 "System.ObsoleteAttribute",
376 "System.ParamArrayAttribute",
377 "System.CLSCompliantAttribute",
378 "System.Security.UnverifiableCodeAttribute",
379 "System.Runtime.CompilerServices.IndexerNameAttribute",
380 "System.Runtime.InteropServices.InAttribute",
381 "System.Runtime.InteropServices.StructLayoutAttribute",
382 "System.Runtime.InteropServices.FieldOffsetAttribute",
383 "System.InvalidOperationException",
384 "System.MarshalByRefObject"
387 // We must store them here before calling BootstrapCorlib_ResolveDelegate.
388 TypeManager.string_type = BootstrapCorlib_ResolveClass (root, "System.String");
389 TypeManager.enum_type = BootstrapCorlib_ResolveClass (root, "System.Enum");
390 TypeManager.array_type = BootstrapCorlib_ResolveClass (root, "System.Array");
391 TypeManager.multicast_delegate_type = BootstrapCorlib_ResolveClass (root, "System.MulticastDelegate");
392 TypeManager.delegate_type = BootstrapCorlib_ResolveClass (root, "System.Delegate");
394 foreach (string cname in classes_second_stage)
395 BootstrapCorlib_ResolveClass (root, cname);
397 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
401 // Closes all open types
405 // We usually use TypeBuilder types. When we are done
406 // creating the type (which will happen after we have added
407 // methods, fields, etc) we need to "Define" them before we
408 // can save the Assembly
410 static public void CloseTypes ()
412 TypeContainer root = Tree.Types;
414 if (root.Enums != null)
415 foreach (Enum en in root.Enums)
418 if (attribute_types != null)
419 foreach (TypeContainer tc in attribute_types)
422 foreach (Interface iface in interface_resolve_order)
426 // We do this in two passes, first we close the structs,
427 // then the classes, because it seems the code needs it this
428 // way. If this is really what is going on, we should probably
429 // make sure that we define the structs in order as well.
431 foreach (TypeContainer tc in type_container_resolve_order){
432 if (tc is Struct && tc.Parent == tree.Types){
437 foreach (TypeContainer tc in type_container_resolve_order){
438 if (!(tc is Struct && tc.Parent == tree.Types))
442 if (root.Delegates != null)
443 foreach (Delegate d in root.Delegates)
448 // If we have a <PrivateImplementationDetails> class, close it
450 if (helper_classes != null){
451 foreach (TypeBuilder type_builder in helper_classes)
452 type_builder.CreateType ();
455 attribute_types = null;
456 interface_resolve_order = null;
457 type_container_resolve_order = null;
458 helper_classes = null;
460 TypeManager.CleanUp ();
464 /// Used to register classes that need to be closed after all the
465 /// user defined classes
467 public static void RegisterHelperClass (TypeBuilder helper_class)
469 if (helper_classes == null)
470 helper_classes = new ArrayList ();
471 helper_classes.Add (helper_class);
475 // This idea is from Felix Arrese-Igor
477 // Returns : the implicit parent of a composite namespace string
478 // eg. Implicit parent of A.B is A
480 static public string ImplicitParent (string ns)
482 int i = ns.LastIndexOf ('.');
486 return ns.Substring (0, i);
489 static TypeExpr NamespaceLookup (DeclSpace ds, string name,
490 int num_type_args, bool silent, Location loc)
493 // Try in the current namespace and all its implicit parents
495 for (NamespaceEntry ns = ds.NamespaceEntry; ns != null; ns = ns.ImplicitParent) {
496 IAlias result = ns.Lookup (ds, name, num_type_args, silent, loc);
510 static public TypeExpr LookupType (DeclSpace ds, string name, bool silent,
513 return LookupType (ds, name, silent, 0, loc);
517 // Public function used to locate types, this can only
518 // be used after the ResolveTree function has been invoked.
520 // Returns: Type or null if they type can not be found.
522 // Come to think of it, this should be a DeclSpace
524 static public TypeExpr LookupType (DeclSpace ds, string name, bool silent,
525 int num_type_params, Location loc)
529 if (ds.Cache.Contains (name)){
530 t = (TypeExpr) ds.Cache [name];
535 // For the case the type we are looking for is nested within this one
536 // or is in any base class
538 DeclSpace containing_ds = ds;
539 while (containing_ds != null){
540 Type current_type = containing_ds.TypeBuilder;
542 while (current_type != null) {
546 Type type = TypeManager.LookupType (current_type.FullName + "." + name);
548 t = new TypeExpression (type, loc);
553 current_type = current_type.BaseType;
556 containing_ds = containing_ds.Parent;
559 t = NamespaceLookup (ds, name, num_type_params, silent, loc);
567 Report.Error (246, loc, "Cannot find type `"+name+"'");
573 // This is the silent version of LookupType, you can use this
574 // to `probe' for a type
576 static public TypeExpr LookupType (TypeContainer tc, string name, Location loc)
578 return LookupType (tc, name, true, loc);
581 static public bool IsNamespace (string name)
585 if (tree.Namespaces != null){
586 ns = (Namespace) tree.Namespaces [name];
595 static void Report1530 (Location loc)
597 Report.Error (1530, loc, "Keyword new not allowed for namespace elements");
600 static public void PopulateCoreType (TypeContainer root, string name)
602 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
604 ds.DefineMembers (root);
608 static public void BootCorlib_PopulateCoreTypes ()
610 TypeContainer root = tree.Types;
612 PopulateCoreType (root, "System.Object");
613 PopulateCoreType (root, "System.ValueType");
614 PopulateCoreType (root, "System.Attribute");
618 // Populates the structs and classes with fields and methods
621 // This is invoked after all interfaces, structs and classes
622 // have been defined through `ResolveTree'
623 static public void PopulateTypes ()
625 TypeContainer root = Tree.Types;
627 if (attribute_types != null)
628 foreach (TypeContainer tc in attribute_types)
629 tc.DefineMembers (root);
631 if (interface_resolve_order != null){
632 foreach (Interface iface in interface_resolve_order)
633 if ((iface.ModFlags & Modifiers.NEW) == 0)
634 iface.DefineMembers (root);
636 Report1530 (iface.Location);
640 if (type_container_resolve_order != null){
641 if (RootContext.StdLib){
642 foreach (TypeContainer tc in type_container_resolve_order)
643 tc.DefineMembers (root);
645 foreach (TypeContainer tc in type_container_resolve_order) {
646 // When compiling corlib, these types have already been
647 // populated from BootCorlib_PopulateCoreTypes ().
648 if (((tc.Name == "System.Object") ||
649 (tc.Name == "System.Attribute") ||
650 (tc.Name == "System.ValueType")))
653 tc.DefineMembers (root);
658 ArrayList delegates = root.Delegates;
659 if (delegates != null){
660 foreach (Delegate d in delegates)
661 if ((d.ModFlags & Modifiers.NEW) == 0)
662 d.DefineMembers (root);
664 Report1530 (d.Location);
667 ArrayList enums = root.Enums;
669 foreach (Enum en in enums)
670 if ((en.ModFlags & Modifiers.NEW) == 0)
671 en.DefineMembers (root);
673 Report1530 (en.Location);
677 // Check for cycles in the struct layout
679 if (type_container_resolve_order != null){
680 Hashtable seen = new Hashtable ();
681 foreach (TypeContainer tc in type_container_resolve_order)
682 TypeManager.CheckStructCycles (tc, seen);
687 // A generic hook delegate
689 public delegate void Hook ();
692 // A hook invoked when the code has been generated.
694 public static event Hook EmitCodeHook;
697 // DefineTypes is used to fill in the members of each type.
699 static public void DefineTypes ()
701 TypeContainer root = Tree.Types;
703 if (attribute_types != null)
704 foreach (TypeContainer tc in attribute_types)
707 if (interface_resolve_order != null){
708 foreach (Interface iface in interface_resolve_order)
709 if ((iface.ModFlags & Modifiers.NEW) == 0)
714 if (type_container_resolve_order != null){
715 foreach (TypeContainer tc in type_container_resolve_order) {
716 // When compiling corlib, these types have already been
717 // populated from BootCorlib_PopulateCoreTypes ().
718 if (!RootContext.StdLib &&
719 ((tc.Name == "System.Object") ||
720 (tc.Name == "System.Attribute") ||
721 (tc.Name == "System.ValueType")))
724 if ((tc.ModFlags & Modifiers.NEW) == 0)
729 ArrayList delegates = root.Delegates;
730 if (delegates != null){
731 foreach (Delegate d in delegates)
732 if ((d.ModFlags & Modifiers.NEW) == 0)
736 ArrayList enums = root.Enums;
738 foreach (Enum en in enums)
739 if ((en.ModFlags & Modifiers.NEW) == 0)
744 static public void EmitCode ()
746 if (attribute_types != null)
747 foreach (TypeContainer tc in attribute_types)
750 CodeGen.Assembly.Emit (Tree.Types);
751 CodeGen.Module.Emit (Tree.Types);
753 if (Tree.Types.Enums != null) {
754 foreach (Enum e in Tree.Types.Enums)
758 if (interface_resolve_order != null){
759 foreach (Interface iface in interface_resolve_order)
760 iface.Emit (Tree.Types);
763 if (type_container_resolve_order != null) {
764 foreach (TypeContainer tc in type_container_resolve_order)
767 foreach (TypeContainer tc in type_container_resolve_order)
771 if (Tree.Types.Delegates != null) {
772 foreach (Delegate d in Tree.Types.Delegates)
776 // Run any hooks after all the types have been defined.
777 // This is used to create nested auxiliary classes for example
780 if (EmitCodeHook != null)
785 // Public Field, used to track which method is the public entry
788 static public MethodInfo EntryPoint;
791 // Track the location of the entry point.
793 static public Location EntryPointLocation;
796 // These are used to generate unique names on the structs and fields.
798 static int field_count;
801 // Makes an initialized struct, returns the field builder that
802 // references the data. Thanks go to Sergey Chaban for researching
803 // how to do this. And coming up with a shorter mechanism than I
804 // was able to figure out.
806 // This works but makes an implicit public struct $ArrayType$SIZE and
807 // makes the fields point to it. We could get more control if we did
810 // 1. DefineNestedType on the impl_details_class with our struct.
812 // 2. Define the field on the impl_details_class
814 static public FieldBuilder MakeStaticData (byte [] data)
818 if (impl_details_class == null){
819 impl_details_class = CodeGen.Module.Builder.DefineType (
820 "<PrivateImplementationDetails>",
821 TypeAttributes.NotPublic,
822 TypeManager.object_type);
824 RegisterHelperClass (impl_details_class);
827 fb = impl_details_class.DefineInitializedData (
828 "$$field-" + (field_count++), data,
829 FieldAttributes.Static | FieldAttributes.Assembly);