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;
18 namespace Mono.CSharp {
20 public enum LanguageVersion
26 public class RootContext {
29 // Contains the parsed tree
34 // This hashtable contains all of the #definitions across the source code
35 // it is used by the ConditionalAttribute handler.
37 public static Hashtable AllDefines = new Hashtable ();
40 // Whether we are being linked against the standard libraries.
41 // This is only used to tell whether `System.Object' should
42 // have a parent or not.
44 public static bool StdLib = true;
47 // This keeps track of the order in which classes were defined
48 // so that we can poulate them in that order.
50 // Order is important, because we need to be able to tell by
51 // examining the parent's list of methods which ones are virtual
52 // or abstract as well as the parent names (to implement new,
55 static ArrayList type_container_resolve_order;
56 static ArrayList attribute_types;
59 // Holds a reference to the Private Implementation Details
62 static ArrayList helper_classes;
64 static TypeBuilder impl_details_class;
66 public static int WarningLevel = 2;
68 public static Target Target = Target.Exe;
69 public static string TargetExt = ".exe";
71 public static bool VerifyClsCompliance = true;
73 public static LanguageVersion Version = LanguageVersion.Default;
76 // We keep strongname related info here because
77 // it's also used as complier options from CSC 8.x
79 public static string StrongNameKeyFile;
80 public static string StrongNameKeyContainer;
81 public static bool StrongNameDelaySign = false;
84 // If set, enable XML documentation generation
86 public static Documentation Documentation;
94 type_container_resolve_order = new ArrayList ();
97 public static bool NeedsEntryPoint {
99 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
103 static public Tree Tree {
109 static public string MainClass;
111 public static void RegisterOrder (TypeContainer tc)
113 type_container_resolve_order.Add (tc);
116 public static void RegisterAttribute (TypeContainer tc)
118 if (attribute_types == null)
119 attribute_types = new ArrayList ();
121 attribute_types.Add (tc);
125 // The default compiler checked state
127 static public bool Checked = false;
130 // Whether to allow Unsafe code
132 static public bool Unsafe = false;
134 static string MakeFQN (string nsn, string name)
138 return String.Concat (nsn, ".", name);
142 // This function is used to resolve the hierarchy tree.
143 // It processes interfaces, structs and classes in that order.
145 // It creates the TypeBuilder's as it processes the user defined
148 static public void ResolveTree ()
151 // Process the attribute types separately and before anything else
153 if (attribute_types != null)
154 foreach (TypeContainer tc in attribute_types)
158 // Interfaces are processed next, as classes and
159 // structs might inherit from an object or implement
160 // a set of interfaces, we need to be able to tell
161 // them appart by just using the TypeManager.
163 TypeContainer root = Tree.Types;
165 ArrayList ifaces = root.Interfaces;
167 foreach (Interface i in ifaces)
171 foreach (TypeContainer tc in root.Types)
174 if (root.Delegates != null)
175 foreach (Delegate d in root.Delegates)
178 if (root.Enums != null)
179 foreach (Enum e in root.Enums)
183 static void Error_TypeConflict (string name, Location loc)
186 520, loc, "`" + name + "' conflicts with a predefined type");
189 static void Error_TypeConflict (string name)
192 520, "`" + name + "' conflicts with a predefined type");
196 // Resolves a single class during the corlib bootstrap process
198 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
200 object o = root.GetDefinition (name);
202 Report.Error (518, "The predefined type `" + name + "' is not defined");
208 DeclSpace d = (DeclSpace) o;
210 Error_TypeConflict (name, d.Location);
212 Error_TypeConflict (name);
217 return ((DeclSpace) o).DefineType ();
221 // Resolves a struct during the corlib bootstrap process
223 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
225 object o = root.GetDefinition (name);
227 Report.Error (518, "The predefined type `" + name + "' is not defined");
233 DeclSpace d = (DeclSpace) o;
235 Error_TypeConflict (name, d.Location);
237 Error_TypeConflict (name);
242 ((DeclSpace) o).DefineType ();
246 // Resolves a struct during the corlib bootstrap process
248 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
250 object o = root.GetDefinition (name);
252 Report.Error (518, "The predefined type `" + name + "' is not defined");
256 if (!(o is Interface)){
258 DeclSpace d = (DeclSpace) o;
260 Error_TypeConflict (name, d.Location);
262 Error_TypeConflict (name);
267 ((DeclSpace) o).DefineType ();
271 // Resolves a delegate during the corlib bootstrap process
273 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
275 object o = root.GetDefinition (name);
277 Report.Error (518, "The predefined type `" + name + "' is not defined");
278 Environment.Exit (1);
281 if (!(o is Delegate)){
282 Error_TypeConflict (name);
286 ((DeclSpace) o).DefineType ();
291 /// Resolves the core types in the compiler when compiling with --nostdlib
293 static public void ResolveCore ()
295 TypeContainer root = Tree.Types;
297 TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
298 TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
299 TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
301 string [] interfaces_first_stage = {
302 "System.IComparable", "System.ICloneable",
303 "System.IConvertible",
305 "System.Collections.IEnumerable",
306 "System.Collections.ICollection",
307 "System.Collections.IEnumerator",
308 "System.Collections.IList",
309 "System.IAsyncResult",
310 "System.IDisposable",
312 "System.Runtime.Serialization.ISerializable",
314 "System.Reflection.IReflect",
315 "System.Reflection.ICustomAttributeProvider"
318 foreach (string iname in interfaces_first_stage)
319 BootstrapCorlib_ResolveInterface (root, iname);
322 // These are the base value types
324 string [] structs_first_stage = {
325 "System.Byte", "System.SByte",
326 "System.Int16", "System.UInt16",
327 "System.Int32", "System.UInt32",
328 "System.Int64", "System.UInt64",
331 foreach (string cname in structs_first_stage)
332 BootstrapCorlib_ResolveStruct (root, cname);
335 // Now, we can load the enumerations, after this point,
338 TypeManager.InitEnumUnderlyingTypes ();
340 string [] structs_second_stage = {
341 "System.Single", "System.Double",
342 "System.Char", "System.Boolean",
343 "System.Decimal", "System.Void",
344 "System.RuntimeFieldHandle",
345 "System.RuntimeArgumentHandle",
346 "System.RuntimeTypeHandle",
348 "System.TypedReference",
352 foreach (string cname in structs_second_stage)
353 BootstrapCorlib_ResolveStruct (root, cname);
356 // These are classes that depends on the core interfaces
358 string [] classes_second_stage = {
359 "System.Reflection.MemberInfo",
364 // These are not really important in the order, but they
365 // are used by the compiler later on (typemanager/CoreLookupType-d)
367 "System.Runtime.CompilerServices.RuntimeHelpers",
368 "System.Reflection.DefaultMemberAttribute",
369 "System.Threading.Monitor",
371 "System.AttributeUsageAttribute",
372 "System.Runtime.InteropServices.DllImportAttribute",
373 "System.Runtime.CompilerServices.MethodImplAttribute",
374 "System.Runtime.InteropServices.MarshalAsAttribute",
375 "System.Diagnostics.ConditionalAttribute",
376 "System.ObsoleteAttribute",
377 "System.ParamArrayAttribute",
378 "System.CLSCompliantAttribute",
379 "System.Security.UnverifiableCodeAttribute",
380 "System.Security.Permissions.SecurityAttribute",
381 "System.Runtime.CompilerServices.IndexerNameAttribute",
382 "System.Runtime.CompilerServices.DecimalConstantAttribute",
383 "System.Runtime.InteropServices.InAttribute",
384 "System.Runtime.InteropServices.StructLayoutAttribute",
385 "System.Runtime.InteropServices.FieldOffsetAttribute",
386 "System.InvalidOperationException",
387 "System.NotSupportedException",
388 "System.MarshalByRefObject",
389 "System.Security.CodeAccessPermission"
392 // We must store them here before calling BootstrapCorlib_ResolveDelegate.
393 TypeManager.string_type = BootstrapCorlib_ResolveClass (root, "System.String");
394 TypeManager.enum_type = BootstrapCorlib_ResolveClass (root, "System.Enum");
395 TypeManager.array_type = BootstrapCorlib_ResolveClass (root, "System.Array");
396 TypeManager.multicast_delegate_type = BootstrapCorlib_ResolveClass (root, "System.MulticastDelegate");
397 TypeManager.delegate_type = BootstrapCorlib_ResolveClass (root, "System.Delegate");
399 foreach (string cname in classes_second_stage)
400 BootstrapCorlib_ResolveClass (root, cname);
402 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
406 // Closes all open types
410 // We usually use TypeBuilder types. When we are done
411 // creating the type (which will happen after we have added
412 // methods, fields, etc) we need to "Define" them before we
413 // can save the Assembly
415 static public void CloseTypes ()
417 TypeContainer root = Tree.Types;
419 if (root.Enums != null)
420 foreach (Enum en in root.Enums)
423 if (attribute_types != null)
424 foreach (TypeContainer tc in attribute_types)
428 // We do this in two passes, first we close the structs,
429 // then the classes, because it seems the code needs it this
430 // way. If this is really what is going on, we should probably
431 // make sure that we define the structs in order as well.
433 foreach (TypeContainer tc in type_container_resolve_order){
434 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
439 foreach (TypeContainer tc in type_container_resolve_order){
440 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
444 if (root.Delegates != null)
445 foreach (Delegate d in root.Delegates)
450 // If we have a <PrivateImplementationDetails> class, close it
452 if (helper_classes != null){
453 foreach (TypeBuilder type_builder in helper_classes)
454 type_builder.CreateType ();
457 attribute_types = null;
458 type_container_resolve_order = null;
459 helper_classes = null;
461 TypeManager.CleanUp ();
465 /// Used to register classes that need to be closed after all the
466 /// user defined classes
468 public static void RegisterHelperClass (TypeBuilder helper_class)
470 if (helper_classes == null)
471 helper_classes = new ArrayList ();
472 helper_classes.Add (helper_class);
476 // This idea is from Felix Arrese-Igor
478 // Returns : the implicit parent of a composite namespace string
479 // eg. Implicit parent of A.B is A
481 static public string ImplicitParent (string ns)
483 int i = ns.LastIndexOf ('.');
487 return ns.Substring (0, i);
490 static Type NamespaceLookup (DeclSpace ds, string name, Location loc)
492 object result = ds.NamespaceEntry.LookupNamespaceOrType (ds, name, loc);
497 return (Type) result;
503 // Public function used to locate types, this can only
504 // be used after the ResolveTree function has been invoked.
506 // Returns: Type or null if they type can not be found.
508 // Come to think of it, this should be a DeclSpace
510 static public Type LookupType (DeclSpace ds, string name, bool silent, Location loc)
514 if (ds.Cache.Contains (name)) {
515 t = (Type) ds.Cache [name];
518 // For the case the type we are looking for is nested within this one
519 // or is in any base class
521 DeclSpace containing_ds = ds;
522 while (containing_ds != null){
524 // if the member cache has been created, lets use it.
525 // the member cache is MUCH faster.
526 if (containing_ds.MemberCache != null) {
527 t = containing_ds.MemberCache.FindNestedType (name);
529 containing_ds = containing_ds.Parent;
537 // no member cache. Do it the hard way -- reflection
538 Type current_type = containing_ds.TypeBuilder;
540 while (current_type != null &&
541 current_type != TypeManager.object_type) {
545 t = TypeManager.LookupType (current_type.FullName + "." + name);
551 current_type = current_type.BaseType;
554 containing_ds = containing_ds.Parent;
557 t = NamespaceLookup (ds, name, loc);
558 if (!silent || t != null)
562 if (t == null && !silent)
563 Report.Error (246, loc, "Cannot find type `"+name+"'");
569 // This is the silent version of LookupType, you can use this
570 // to `probe' for a type
572 static public Type LookupType (TypeContainer tc, string name, Location loc)
574 return LookupType (tc, name, true, loc);
577 static void Report1530 (Location loc)
579 Report.Error (1530, loc, "Keyword new not allowed for namespace elements");
582 static public void PopulateCoreType (TypeContainer root, string name)
584 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
586 ds.DefineMembers (root);
590 static public void BootCorlib_PopulateCoreTypes ()
592 TypeContainer root = tree.Types;
594 PopulateCoreType (root, "System.Object");
595 PopulateCoreType (root, "System.ValueType");
596 PopulateCoreType (root, "System.Attribute");
600 // Populates the structs and classes with fields and methods
603 // This is invoked after all interfaces, structs and classes
604 // have been defined through `ResolveTree'
605 static public void PopulateTypes ()
607 TypeContainer root = Tree.Types;
609 if (attribute_types != null)
610 foreach (TypeContainer tc in attribute_types)
611 tc.DefineMembers (root);
613 if (type_container_resolve_order != null){
614 if (RootContext.StdLib){
615 foreach (TypeContainer tc in type_container_resolve_order)
616 tc.DefineMembers (root);
618 foreach (TypeContainer tc in type_container_resolve_order) {
619 // When compiling corlib, these types have already been
620 // populated from BootCorlib_PopulateCoreTypes ().
621 if (((tc.Name == "System.Object") ||
622 (tc.Name == "System.Attribute") ||
623 (tc.Name == "System.ValueType")))
626 tc.DefineMembers (root);
631 ArrayList delegates = root.Delegates;
632 if (delegates != null){
633 foreach (Delegate d in delegates)
634 if ((d.ModFlags & Modifiers.NEW) == 0)
635 d.DefineMembers (root);
637 Report1530 (d.Location);
640 ArrayList enums = root.Enums;
642 foreach (Enum en in enums)
643 if ((en.ModFlags & Modifiers.NEW) == 0)
644 en.DefineMembers (root);
646 Report1530 (en.Location);
650 // Check for cycles in the struct layout
652 if (type_container_resolve_order != null){
653 Hashtable seen = new Hashtable ();
654 foreach (TypeContainer tc in type_container_resolve_order)
655 TypeManager.CheckStructCycles (tc, seen);
660 // A generic hook delegate
662 public delegate void Hook ();
665 // A hook invoked when the code has been generated.
667 public static event Hook EmitCodeHook;
670 // DefineTypes is used to fill in the members of each type.
672 static public void DefineTypes ()
674 TypeContainer root = Tree.Types;
676 if (attribute_types != null)
677 foreach (TypeContainer tc in attribute_types)
680 if (type_container_resolve_order != null){
681 foreach (TypeContainer tc in type_container_resolve_order) {
682 // When compiling corlib, these types have already been
683 // populated from BootCorlib_PopulateCoreTypes ().
684 if (!RootContext.StdLib &&
685 ((tc.Name == "System.Object") ||
686 (tc.Name == "System.Attribute") ||
687 (tc.Name == "System.ValueType")))
690 if ((tc.ModFlags & Modifiers.NEW) == 0)
695 ArrayList delegates = root.Delegates;
696 if (delegates != null){
697 foreach (Delegate d in delegates)
698 if ((d.ModFlags & Modifiers.NEW) == 0)
702 ArrayList enums = root.Enums;
704 foreach (Enum en in enums)
705 if ((en.ModFlags & Modifiers.NEW) == 0)
710 static public void EmitCode ()
712 if (attribute_types != null)
713 foreach (TypeContainer tc in attribute_types)
716 CodeGen.Assembly.Emit (Tree.Types);
717 CodeGen.Module.Emit (Tree.Types);
719 if (Tree.Types.Enums != null) {
720 foreach (Enum e in Tree.Types.Enums)
724 if (type_container_resolve_order != null) {
725 foreach (TypeContainer tc in type_container_resolve_order)
729 if (Tree.Types.Delegates != null) {
730 foreach (Delegate d in Tree.Types.Delegates)
734 // Run any hooks after all the types have been defined.
735 // This is used to create nested auxiliary classes for example
738 if (EmitCodeHook != null)
743 // Public Field, used to track which method is the public entry
746 static public MethodInfo EntryPoint;
749 // Track the location of the entry point.
751 static public Location EntryPointLocation;
754 // These are used to generate unique names on the structs and fields.
756 static int field_count;
759 // Makes an initialized struct, returns the field builder that
760 // references the data. Thanks go to Sergey Chaban for researching
761 // how to do this. And coming up with a shorter mechanism than I
762 // was able to figure out.
764 // This works but makes an implicit public struct $ArrayType$SIZE and
765 // makes the fields point to it. We could get more control if we did
768 // 1. DefineNestedType on the impl_details_class with our struct.
770 // 2. Define the field on the impl_details_class
772 static public FieldBuilder MakeStaticData (byte [] data)
776 if (impl_details_class == null){
777 impl_details_class = CodeGen.Module.Builder.DefineType (
778 "<PrivateImplementationDetails>",
779 TypeAttributes.NotPublic,
780 TypeManager.object_type);
782 RegisterHelperClass (impl_details_class);
785 fb = impl_details_class.DefineInitializedData (
786 "$$field-" + (field_count++), data,
787 FieldAttributes.Static | FieldAttributes.Assembly);