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;
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;
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;
68 public static Target Target;
69 public static string TargetExt;
71 public static bool VerifyClsCompliance = true;
74 /// Holds /optimize option
76 public static bool Optimize = true;
78 public static LanguageVersion Version;
81 // We keep strongname related info here because
82 // it's also used as complier options from CSC 8.x
84 public static string StrongNameKeyFile;
85 public static string StrongNameKeyContainer;
86 public static bool StrongNameDelaySign;
88 public static bool BrokenCircularDeps;
90 // If set, enable XML documentation generation
92 public static Documentation Documentation;
94 static public string MainClass;
104 public static void Reset ()
107 type_container_resolve_order = new ArrayList ();
113 StrongNameKeyFile = null;
114 StrongNameKeyContainer = null;
115 StrongNameDelaySign = false;
119 Version = LanguageVersion.Default;
120 Documentation = null;
121 impl_details_class = null;
124 public static bool NeedsEntryPoint {
126 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
130 static public Tree Tree {
136 public static void RegisterOrder (TypeContainer tc)
138 type_container_resolve_order.Add (tc);
142 // The default compiler checked state
144 static public bool Checked;
147 // Whether to allow Unsafe code
149 static public bool Unsafe;
152 // This function is used to resolve the hierarchy tree.
153 // It processes interfaces, structs and classes in that order.
155 // It creates the TypeBuilder's as it processes the user defined
158 static public void ResolveTree ()
161 // Interfaces are processed next, as classes and
162 // structs might inherit from an object or implement
163 // a set of interfaces, we need to be able to tell
164 // them appart by just using the TypeManager.
166 TypeContainer root = Tree.Types;
168 ArrayList ifaces = root.Interfaces;
170 foreach (TypeContainer i in ifaces)
174 foreach (TypeContainer tc in root.Types)
177 if (root.Delegates != null)
178 foreach (Delegate d in root.Delegates)
181 if (root.Enums != null)
182 foreach (Enum e in root.Enums)
186 static void Error_TypeConflict (string name, Location loc)
189 520, loc, "`" + name + "' conflicts with a predefined type");
192 static void Error_TypeConflict (string name)
195 520, "`" + name + "' conflicts with a predefined type");
199 // Resolves a single class during the corlib bootstrap process
201 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
203 object o = root.GetDefinition (name);
205 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
211 DeclSpace d = (DeclSpace) o;
213 Error_TypeConflict (name, d.Location);
215 Error_TypeConflict (name);
220 return ((DeclSpace) o).DefineType ();
224 // Resolves a struct during the corlib bootstrap process
226 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
228 object o = root.GetDefinition (name);
230 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
236 DeclSpace d = (DeclSpace) o;
238 Error_TypeConflict (name, d.Location);
240 Error_TypeConflict (name);
245 ((DeclSpace) o).DefineType ();
249 // Resolves a struct during the corlib bootstrap process
251 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
253 object o = root.GetDefinition (name);
255 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
259 if (!(o is Interface)){
261 DeclSpace d = (DeclSpace) o;
263 Error_TypeConflict (name, d.Location);
265 Error_TypeConflict (name);
270 ((DeclSpace) o).DefineType ();
274 // Resolves a delegate during the corlib bootstrap process
276 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
278 object o = root.GetDefinition (name);
280 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
284 if (!(o is Delegate)){
285 Error_TypeConflict (name);
289 ((DeclSpace) o).DefineType ();
294 /// Resolves the core types in the compiler when compiling with --nostdlib
296 static public void ResolveCore ()
298 TypeContainer root = Tree.Types;
300 TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
301 TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
302 TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
303 TypeManager.indexer_name_type = BootstrapCorlib_ResolveClass (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
305 string [] interfaces_first_stage = {
306 "System.IComparable", "System.ICloneable",
307 "System.IConvertible",
309 "System.Collections.IEnumerable",
310 "System.Collections.ICollection",
311 "System.Collections.IEnumerator",
312 "System.Collections.IList",
313 "System.IAsyncResult",
314 "System.IDisposable",
316 "System.Runtime.Serialization.ISerializable",
317 "System.Runtime.InteropServices._Exception",
319 "System.Reflection.IReflect",
320 "System.Reflection.ICustomAttributeProvider",
325 "System.Collections.Generic.IEnumerator`1",
326 "System.Collections.Generic.IEnumerable`1"
329 foreach (string iname in interfaces_first_stage)
330 BootstrapCorlib_ResolveInterface (root, iname);
333 // These are the base value types
335 string [] structs_first_stage = {
336 "System.Byte", "System.SByte",
337 "System.Int16", "System.UInt16",
338 "System.Int32", "System.UInt32",
339 "System.Int64", "System.UInt64",
342 foreach (string cname in structs_first_stage)
343 BootstrapCorlib_ResolveStruct (root, cname);
346 // Now, we can load the enumerations, after this point,
349 TypeManager.InitEnumUnderlyingTypes ();
351 string [] structs_second_stage = {
352 "System.Single", "System.Double",
353 "System.Char", "System.Boolean",
354 "System.Decimal", "System.Void",
355 "System.RuntimeFieldHandle",
356 "System.RuntimeArgumentHandle",
357 "System.RuntimeTypeHandle",
359 "System.TypedReference",
363 foreach (string cname in structs_second_stage)
364 BootstrapCorlib_ResolveStruct (root, cname);
367 // These are classes that depends on the core interfaces
369 string [] classes_second_stage = {
373 "System.Reflection.MemberInfo",
379 // These are not really important in the order, but they
380 // are used by the compiler later on (typemanager/CoreLookupType-d)
382 "System.Runtime.CompilerServices.RuntimeHelpers",
383 "System.Reflection.DefaultMemberAttribute",
384 "System.Threading.Monitor",
386 "System.AttributeUsageAttribute",
387 "System.Runtime.InteropServices.DllImportAttribute",
388 "System.Runtime.CompilerServices.MethodImplAttribute",
389 "System.Runtime.InteropServices.MarshalAsAttribute",
390 "System.Runtime.CompilerServices.CompilerGeneratedAttribute",
391 "System.Runtime.CompilerServices.FixedBufferAttribute",
392 "System.Diagnostics.ConditionalAttribute",
393 "System.ObsoleteAttribute",
394 "System.ParamArrayAttribute",
395 "System.CLSCompliantAttribute",
396 "System.Security.UnverifiableCodeAttribute",
397 "System.Security.Permissions.SecurityAttribute",
398 "System.Runtime.CompilerServices.DecimalConstantAttribute",
399 "System.Runtime.InteropServices.InAttribute",
400 "System.Runtime.InteropServices.OutAttribute",
401 "System.Runtime.InteropServices.StructLayoutAttribute",
402 "System.Runtime.InteropServices.FieldOffsetAttribute",
403 "System.Runtime.InteropServices.DefaultCharSetAttribute",
404 "System.InvalidOperationException",
405 "System.NotSupportedException",
406 "System.MarshalByRefObject",
407 "System.Security.CodeAccessPermission",
408 "System.Runtime.CompilerServices.RequiredAttributeAttribute",
409 "System.Runtime.InteropServices.GuidAttribute",
410 "System.Reflection.AssemblyCultureAttribute"
413 foreach (string cname in classes_second_stage)
414 BootstrapCorlib_ResolveClass (root, cname);
416 BootstrapCorlib_ResolveStruct (root, "System.Nullable`1");
418 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
420 // These will be defined indirectly during the previous ResolveDelegate.
421 // However make sure the rest of the checks happen.
422 string [] delegate_types = { "System.Delegate", "System.MulticastDelegate" };
423 foreach (string cname in delegate_types)
424 BootstrapCorlib_ResolveClass (root, cname);
428 // Closes all open types
432 // We usually use TypeBuilder types. When we are done
433 // creating the type (which will happen after we have added
434 // methods, fields, etc) we need to "Define" them before we
435 // can save the Assembly
437 static public void CloseTypes ()
439 TypeContainer root = Tree.Types;
441 if (root.Enums != null)
442 foreach (Enum en in root.Enums)
446 // We do this in two passes, first we close the structs,
447 // then the classes, because it seems the code needs it this
448 // way. If this is really what is going on, we should probably
449 // make sure that we define the structs in order as well.
451 foreach (TypeContainer tc in type_container_resolve_order){
452 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
457 foreach (TypeContainer tc in type_container_resolve_order){
458 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
462 if (root.Delegates != null)
463 foreach (Delegate d in root.Delegates)
468 // If we have a <PrivateImplementationDetails> class, close it
470 if (helper_classes != null){
471 foreach (TypeBuilder type_builder in helper_classes) {
472 type_builder.SetCustomAttribute (TypeManager.compiler_generated_attr);
473 type_builder.CreateType ();
477 type_container_resolve_order = null;
478 helper_classes = null;
480 TypeManager.CleanUp ();
484 /// Used to register classes that need to be closed after all the
485 /// user defined classes
487 public static void RegisterCompilerGeneratedType (TypeBuilder helper_class)
489 if (helper_classes == null)
490 helper_classes = new ArrayList ();
492 helper_classes.Add (helper_class);
495 static public void PopulateCoreType (TypeContainer root, string name)
497 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
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");
510 PopulateCoreType (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
514 // Populates the structs and classes with fields and methods
517 // This is invoked after all interfaces, structs and classes
518 // have been defined through `ResolveTree'
519 static public void PopulateTypes ()
521 TypeContainer root = Tree.Types;
523 if (type_container_resolve_order != null){
524 foreach (TypeContainer tc in type_container_resolve_order)
526 foreach (TypeContainer tc in type_container_resolve_order)
530 ArrayList delegates = root.Delegates;
531 if (delegates != null){
532 foreach (Delegate d in delegates)
536 ArrayList enums = root.Enums;
538 foreach (Enum en in enums)
543 // Check for cycles in the struct layout
545 if (type_container_resolve_order != null){
546 Hashtable seen = new Hashtable ();
547 foreach (TypeContainer tc in type_container_resolve_order)
548 TypeManager.CheckStructCycles (tc, seen);
553 // A generic hook delegate
555 public delegate void Hook ();
558 // A hook invoked when the code has been generated.
560 public static event Hook EmitCodeHook;
563 // DefineTypes is used to fill in the members of each type.
565 static public void DefineTypes ()
567 TypeContainer root = Tree.Types;
569 ArrayList delegates = root.Delegates;
570 if (delegates != null){
571 foreach (Delegate d in delegates)
575 if (type_container_resolve_order != null){
576 foreach (TypeContainer tc in type_container_resolve_order) {
577 // When compiling corlib, these types have already been
578 // populated from BootCorlib_PopulateCoreTypes ().
579 if (!RootContext.StdLib &&
580 ((tc.Name == "System.Object") ||
581 (tc.Name == "System.Attribute") ||
582 (tc.Name == "System.ValueType") ||
583 (tc.Name == "System.Runtime.CompilerServices.IndexerNameAttribute")))
590 ArrayList enums = root.Enums;
592 foreach (Enum en in enums)
597 static public void EmitCode ()
599 if (Tree.Types.Enums != null) {
600 foreach (Enum e in Tree.Types.Enums)
604 if (type_container_resolve_order != null) {
605 foreach (TypeContainer tc in type_container_resolve_order)
608 if (Report.Errors > 0)
611 foreach (TypeContainer tc in type_container_resolve_order)
615 if (Tree.Types.Delegates != null) {
616 foreach (Delegate d in Tree.Types.Delegates)
620 // Run any hooks after all the types have been defined.
621 // This is used to create nested auxiliary classes for example
624 if (EmitCodeHook != null)
627 CodeGen.Assembly.Emit (Tree.Types);
628 CodeGen.Module.Emit (Tree.Types);
632 // Public Field, used to track which method is the public entry
635 static public MethodInfo EntryPoint;
638 // Track the location of the entry point.
640 static public Location EntryPointLocation;
643 // These are used to generate unique names on the structs and fields.
645 static int field_count;
648 // Makes an initialized struct, returns the field builder that
649 // references the data. Thanks go to Sergey Chaban for researching
650 // how to do this. And coming up with a shorter mechanism than I
651 // was able to figure out.
653 // This works but makes an implicit public struct $ArrayType$SIZE and
654 // makes the fields point to it. We could get more control if we did
657 // 1. DefineNestedType on the impl_details_class with our struct.
659 // 2. Define the field on the impl_details_class
661 static public FieldBuilder MakeStaticData (byte [] data)
665 if (impl_details_class == null){
666 impl_details_class = CodeGen.Module.Builder.DefineType (
667 "<PrivateImplementationDetails>",
668 TypeAttributes.NotPublic,
669 TypeManager.object_type);
671 RegisterCompilerGeneratedType (impl_details_class);
674 fb = impl_details_class.DefineInitializedData (
675 "$$field-" + (field_count++), data,
676 FieldAttributes.Static | FieldAttributes.Assembly);
681 public static void CheckUnsafeOption (Location loc)
684 Report.Error (227, loc,
685 "Unsafe code requires the `unsafe' command line option to be specified");