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 enum LanguageVersion
25 public class RootContext {
28 // Contains the parsed tree
33 // This hashtable contains all of the #definitions across the source code
34 // it is used by the ConditionalAttribute handler.
36 public static Hashtable AllDefines = new Hashtable ();
39 // Whether we are being linked against the standard libraries.
40 // This is only used to tell whether `System.Object' should
41 // have a parent or not.
43 public static bool StdLib = true;
46 // This keeps track of the order in which classes were defined
47 // so that we can poulate them in that order.
49 // Order is important, because we need to be able to tell by
50 // examining the parent's list of methods which ones are virtual
51 // or abstract as well as the parent names (to implement new,
54 static ArrayList type_container_resolve_order;
55 static ArrayList attribute_types;
58 // Holds a reference to the Private Implementation Details
61 static ArrayList helper_classes;
63 static TypeBuilder impl_details_class;
65 public static int WarningLevel = 2;
67 public static Target Target = Target.Exe;
68 public static string TargetExt = ".exe";
70 public static bool VerifyClsCompliance = true;
72 public static LanguageVersion Version = LanguageVersion.Default;
75 // We keep strongname related info here because
76 // it's also used as complier options from CSC 8.x
78 public static string StrongNameKeyFile;
79 public static string StrongNameKeyContainer;
80 public static bool StrongNameDelaySign = false;
88 type_container_resolve_order = new ArrayList ();
91 public static bool NeedsEntryPoint {
93 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
97 static public Tree Tree {
103 static public string MainClass;
105 public static void RegisterOrder (TypeContainer tc)
107 type_container_resolve_order.Add (tc);
110 public static void RegisterAttribute (TypeContainer tc)
112 if (attribute_types == null)
113 attribute_types = new ArrayList ();
115 attribute_types.Add (tc);
119 // The default compiler checked state
121 static public bool Checked = false;
124 // Whether to allow Unsafe code
126 static public bool Unsafe = false;
128 static string MakeFQN (string nsn, string name)
132 return String.Concat (nsn, ".", name);
136 // This function is used to resolve the hierarchy tree.
137 // It processes interfaces, structs and classes in that order.
139 // It creates the TypeBuilder's as it processes the user defined
142 static public void ResolveTree ()
145 // Process the attribute types separately and before anything else
147 if (attribute_types != null)
148 foreach (TypeContainer tc in attribute_types)
152 // Interfaces are processed next, as classes and
153 // structs might inherit from an object or implement
154 // a set of interfaces, we need to be able to tell
155 // them appart by just using the TypeManager.
157 TypeContainer root = Tree.Types;
159 ArrayList ifaces = root.Interfaces;
161 foreach (Interface i in ifaces)
165 foreach (TypeContainer tc in root.Types)
168 if (root.Delegates != null)
169 foreach (Delegate d in root.Delegates)
172 if (root.Enums != null)
173 foreach (Enum e in root.Enums)
177 static void Error_TypeConflict (string name, Location loc)
180 520, loc, "`" + name + "' conflicts with a predefined type");
183 static void Error_TypeConflict (string name)
186 520, "`" + name + "' conflicts with a predefined type");
190 // Resolves a single class during the corlib bootstrap process
192 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
194 object o = root.GetDefinition (name);
196 Report.Error (518, "The predefined type `" + name + "' is not defined");
202 DeclSpace d = (DeclSpace) o;
204 Error_TypeConflict (name, d.Location);
206 Error_TypeConflict (name);
211 return ((DeclSpace) o).DefineType ();
215 // Resolves a struct during the corlib bootstrap process
217 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
219 object o = root.GetDefinition (name);
221 Report.Error (518, "The predefined type `" + name + "' is not defined");
227 DeclSpace d = (DeclSpace) o;
229 Error_TypeConflict (name, d.Location);
231 Error_TypeConflict (name);
236 ((DeclSpace) o).DefineType ();
240 // Resolves a struct during the corlib bootstrap process
242 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
244 object o = root.GetDefinition (name);
246 Report.Error (518, "The predefined type `" + name + "' is not defined");
250 if (!(o is Interface)){
252 DeclSpace d = (DeclSpace) o;
254 Error_TypeConflict (name, d.Location);
256 Error_TypeConflict (name);
261 ((DeclSpace) o).DefineType ();
265 // Resolves a delegate during the corlib bootstrap process
267 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
269 object o = root.GetDefinition (name);
271 Report.Error (518, "The predefined type `" + name + "' is not defined");
272 Environment.Exit (1);
275 if (!(o is Delegate)){
276 Error_TypeConflict (name);
280 ((DeclSpace) o).DefineType ();
285 /// Resolves the core types in the compiler when compiling with --nostdlib
287 static public void ResolveCore ()
289 TypeContainer root = Tree.Types;
291 TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
292 TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
293 TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
295 string [] interfaces_first_stage = {
296 "System.IComparable", "System.ICloneable",
297 "System.IConvertible",
299 "System.Collections.IEnumerable",
300 "System.Collections.ICollection",
301 "System.Collections.IEnumerator",
302 "System.Collections.IList",
303 "System.IAsyncResult",
304 "System.IDisposable",
306 "System.Runtime.Serialization.ISerializable",
308 "System.Reflection.IReflect",
309 "System.Reflection.ICustomAttributeProvider"
312 foreach (string iname in interfaces_first_stage)
313 BootstrapCorlib_ResolveInterface (root, iname);
316 // These are the base value types
318 string [] structs_first_stage = {
319 "System.Byte", "System.SByte",
320 "System.Int16", "System.UInt16",
321 "System.Int32", "System.UInt32",
322 "System.Int64", "System.UInt64",
325 foreach (string cname in structs_first_stage)
326 BootstrapCorlib_ResolveStruct (root, cname);
329 // Now, we can load the enumerations, after this point,
332 TypeManager.InitEnumUnderlyingTypes ();
334 string [] structs_second_stage = {
335 "System.Single", "System.Double",
336 "System.Char", "System.Boolean",
337 "System.Decimal", "System.Void",
338 "System.RuntimeFieldHandle",
339 "System.RuntimeArgumentHandle",
340 "System.RuntimeTypeHandle",
342 "System.TypedReference",
346 foreach (string cname in structs_second_stage)
347 BootstrapCorlib_ResolveStruct (root, cname);
350 // These are classes that depends on the core interfaces
352 string [] classes_second_stage = {
353 "System.Reflection.MemberInfo",
358 // These are not really important in the order, but they
359 // are used by the compiler later on (typemanager/CoreLookupType-d)
361 "System.Runtime.CompilerServices.RuntimeHelpers",
362 "System.Reflection.DefaultMemberAttribute",
363 "System.Threading.Monitor",
365 "System.AttributeUsageAttribute",
366 "System.Runtime.InteropServices.DllImportAttribute",
367 "System.Runtime.CompilerServices.MethodImplAttribute",
368 "System.Runtime.InteropServices.MarshalAsAttribute",
369 "System.Diagnostics.ConditionalAttribute",
370 "System.ObsoleteAttribute",
371 "System.ParamArrayAttribute",
372 "System.CLSCompliantAttribute",
373 "System.Security.UnverifiableCodeAttribute",
374 "System.Runtime.CompilerServices.IndexerNameAttribute",
375 "System.Runtime.InteropServices.InAttribute",
376 "System.Runtime.InteropServices.StructLayoutAttribute",
377 "System.Runtime.InteropServices.FieldOffsetAttribute",
378 "System.InvalidOperationException",
379 "System.NotSupportedException",
380 "System.MarshalByRefObject"
383 // We must store them here before calling BootstrapCorlib_ResolveDelegate.
384 TypeManager.string_type = BootstrapCorlib_ResolveClass (root, "System.String");
385 TypeManager.enum_type = BootstrapCorlib_ResolveClass (root, "System.Enum");
386 TypeManager.array_type = BootstrapCorlib_ResolveClass (root, "System.Array");
387 TypeManager.multicast_delegate_type = BootstrapCorlib_ResolveClass (root, "System.MulticastDelegate");
388 TypeManager.delegate_type = BootstrapCorlib_ResolveClass (root, "System.Delegate");
390 foreach (string cname in classes_second_stage)
391 BootstrapCorlib_ResolveClass (root, cname);
393 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
397 // Closes all open types
401 // We usually use TypeBuilder types. When we are done
402 // creating the type (which will happen after we have added
403 // methods, fields, etc) we need to "Define" them before we
404 // can save the Assembly
406 static public void CloseTypes ()
408 TypeContainer root = Tree.Types;
410 if (root.Enums != null)
411 foreach (Enum en in root.Enums)
414 if (attribute_types != null)
415 foreach (TypeContainer tc in attribute_types)
419 // We do this in two passes, first we close the structs,
420 // then the classes, because it seems the code needs it this
421 // way. If this is really what is going on, we should probably
422 // make sure that we define the structs in order as well.
424 foreach (TypeContainer tc in type_container_resolve_order){
425 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
430 foreach (TypeContainer tc in type_container_resolve_order){
431 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
435 if (root.Delegates != null)
436 foreach (Delegate d in root.Delegates)
441 // If we have a <PrivateImplementationDetails> class, close it
443 if (helper_classes != null){
444 foreach (TypeBuilder type_builder in helper_classes)
445 type_builder.CreateType ();
448 attribute_types = null;
449 type_container_resolve_order = null;
450 helper_classes = null;
452 TypeManager.CleanUp ();
456 /// Used to register classes that need to be closed after all the
457 /// user defined classes
459 public static void RegisterHelperClass (TypeBuilder helper_class)
461 if (helper_classes == null)
462 helper_classes = new ArrayList ();
463 helper_classes.Add (helper_class);
467 // This idea is from Felix Arrese-Igor
469 // Returns : the implicit parent of a composite namespace string
470 // eg. Implicit parent of A.B is A
472 static public string ImplicitParent (string ns)
474 int i = ns.LastIndexOf ('.');
478 return ns.Substring (0, i);
481 static Type NamespaceLookup (DeclSpace ds, string name, bool silent,
485 // Try in the current namespace and all its implicit parents
487 for (NamespaceEntry ns = ds.NamespaceEntry; ns != null; ns = ns.ImplicitParent) {
488 object result = ns.Lookup (ds, name, false, silent, loc);
493 return (Type) result;
502 // Public function used to locate types, this can only
503 // be used after the ResolveTree function has been invoked.
505 // Returns: Type or null if they type can not be found.
507 // Come to think of it, this should be a DeclSpace
509 static public Type LookupType (DeclSpace ds, string name, bool silent, Location loc)
513 if (ds.Cache.Contains (name)) {
514 t = (Type) ds.Cache [name];
517 // For the case the type we are looking for is nested within this one
518 // or is in any base class
520 DeclSpace containing_ds = ds;
521 while (containing_ds != null){
523 // if the member cache has been created, lets use it.
524 // the member cache is MUCH faster.
525 if (containing_ds.MemberCache != null) {
526 t = containing_ds.MemberCache.FindNestedType (name);
528 containing_ds = containing_ds.Parent;
536 // no member cache. Do it the hard way -- reflection
537 Type current_type = containing_ds.TypeBuilder;
539 while (current_type != null &&
540 current_type != TypeManager.object_type) {
544 t = TypeManager.LookupType (current_type.FullName + "." + name);
550 current_type = current_type.BaseType;
553 containing_ds = containing_ds.Parent;
556 t = NamespaceLookup (ds, name, silent, loc);
561 if (t == null && !silent)
562 Report.Error (246, loc, "Cannot find type `"+name+"'");
568 // This is the silent version of LookupType, you can use this
569 // to `probe' for a type
571 static public Type LookupType (TypeContainer tc, string name, Location loc)
573 return LookupType (tc, name, true, loc);
576 static void Report1530 (Location loc)
578 Report.Error (1530, loc, "Keyword new not allowed for namespace elements");
581 static public void PopulateCoreType (TypeContainer root, string name)
583 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
585 ds.DefineMembers (root);
589 static public void BootCorlib_PopulateCoreTypes ()
591 TypeContainer root = tree.Types;
593 PopulateCoreType (root, "System.Object");
594 PopulateCoreType (root, "System.ValueType");
595 PopulateCoreType (root, "System.Attribute");
599 // Populates the structs and classes with fields and methods
602 // This is invoked after all interfaces, structs and classes
603 // have been defined through `ResolveTree'
604 static public void PopulateTypes ()
606 TypeContainer root = Tree.Types;
608 if (attribute_types != null)
609 foreach (TypeContainer tc in attribute_types)
610 tc.DefineMembers (root);
612 if (type_container_resolve_order != null){
613 if (RootContext.StdLib){
614 foreach (TypeContainer tc in type_container_resolve_order)
615 tc.DefineMembers (root);
617 foreach (TypeContainer tc in type_container_resolve_order) {
618 // When compiling corlib, these types have already been
619 // populated from BootCorlib_PopulateCoreTypes ().
620 if (((tc.Name == "System.Object") ||
621 (tc.Name == "System.Attribute") ||
622 (tc.Name == "System.ValueType")))
625 tc.DefineMembers (root);
630 ArrayList delegates = root.Delegates;
631 if (delegates != null){
632 foreach (Delegate d in delegates)
633 if ((d.ModFlags & Modifiers.NEW) == 0)
634 d.DefineMembers (root);
636 Report1530 (d.Location);
639 ArrayList enums = root.Enums;
641 foreach (Enum en in enums)
642 if ((en.ModFlags & Modifiers.NEW) == 0)
643 en.DefineMembers (root);
645 Report1530 (en.Location);
649 // Check for cycles in the struct layout
651 if (type_container_resolve_order != null){
652 Hashtable seen = new Hashtable ();
653 foreach (TypeContainer tc in type_container_resolve_order)
654 TypeManager.CheckStructCycles (tc, seen);
659 // A generic hook delegate
661 public delegate void Hook ();
664 // A hook invoked when the code has been generated.
666 public static event Hook EmitCodeHook;
669 // DefineTypes is used to fill in the members of each type.
671 static public void DefineTypes ()
673 TypeContainer root = Tree.Types;
675 if (attribute_types != null)
676 foreach (TypeContainer tc in attribute_types)
679 if (type_container_resolve_order != null){
680 foreach (TypeContainer tc in type_container_resolve_order) {
681 // When compiling corlib, these types have already been
682 // populated from BootCorlib_PopulateCoreTypes ().
683 if (!RootContext.StdLib &&
684 ((tc.Name == "System.Object") ||
685 (tc.Name == "System.Attribute") ||
686 (tc.Name == "System.ValueType")))
689 if ((tc.ModFlags & Modifiers.NEW) == 0)
694 ArrayList delegates = root.Delegates;
695 if (delegates != null){
696 foreach (Delegate d in delegates)
697 if ((d.ModFlags & Modifiers.NEW) == 0)
701 ArrayList enums = root.Enums;
703 foreach (Enum en in enums)
704 if ((en.ModFlags & Modifiers.NEW) == 0)
709 static public void EmitCode ()
711 if (attribute_types != null)
712 foreach (TypeContainer tc in attribute_types)
715 CodeGen.Assembly.Emit (Tree.Types);
716 CodeGen.Module.Emit (Tree.Types);
718 if (Tree.Types.Enums != null) {
719 foreach (Enum e in Tree.Types.Enums)
723 if (type_container_resolve_order != null) {
724 foreach (TypeContainer tc in type_container_resolve_order)
728 if (Tree.Types.Delegates != null) {
729 foreach (Delegate d in Tree.Types.Delegates)
733 // Run any hooks after all the types have been defined.
734 // This is used to create nested auxiliary classes for example
737 if (EmitCodeHook != null)
742 // Public Field, used to track which method is the public entry
745 static public MethodInfo EntryPoint;
748 // Track the location of the entry point.
750 static public Location EntryPointLocation;
753 // These are used to generate unique names on the structs and fields.
755 static int field_count;
758 // Makes an initialized struct, returns the field builder that
759 // references the data. Thanks go to Sergey Chaban for researching
760 // how to do this. And coming up with a shorter mechanism than I
761 // was able to figure out.
763 // This works but makes an implicit public struct $ArrayType$SIZE and
764 // makes the fields point to it. We could get more control if we did
767 // 1. DefineNestedType on the impl_details_class with our struct.
769 // 2. Define the field on the impl_details_class
771 static public FieldBuilder MakeStaticData (byte [] data)
775 if (impl_details_class == null){
776 impl_details_class = CodeGen.Module.Builder.DefineType (
777 "<PrivateImplementationDetails>",
778 TypeAttributes.NotPublic,
779 TypeManager.object_type);
781 RegisterHelperClass (impl_details_class);
784 fb = impl_details_class.DefineInitializedData (
785 "$$field-" + (field_count++), data,
786 FieldAttributes.Static | FieldAttributes.Assembly);