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 base class or not.
44 public static bool StdLib;
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 list of methods of the base class, which ones are virtual
52 // or abstract as well as the parent names (to implement new,
55 static ArrayList type_container_resolve_order;
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;
67 public static Target Target;
68 public static string TargetExt;
70 public static bool VerifyClsCompliance = true;
73 /// Holds /optimize option
75 public static bool Optimize = true;
77 public static LanguageVersion Version;
80 // We keep strongname related info here because
81 // it's also used as complier options from CSC 8.x
83 public static string StrongNameKeyFile;
84 public static string StrongNameKeyContainer;
85 public static bool StrongNameDelaySign;
88 // If set, enable XML documentation generation
90 public static Documentation Documentation;
92 static public string MainClass;
102 public static void Reset ()
105 type_container_resolve_order = new ArrayList ();
111 StrongNameKeyFile = null;
112 StrongNameKeyContainer = null;
113 StrongNameDelaySign = false;
117 Version = LanguageVersion.Default;
118 Documentation = null;
119 impl_details_class = null;
122 public static bool NeedsEntryPoint {
124 return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe;
128 static public Tree Tree {
134 public static void RegisterOrder (TypeContainer tc)
136 type_container_resolve_order.Add (tc);
140 // The default compiler checked state
142 static public bool Checked;
145 // Whether to allow Unsafe code
147 static public bool Unsafe;
150 // This function is used to resolve the hierarchy tree.
151 // It processes interfaces, structs and classes in that order.
153 // It creates the TypeBuilder's as it processes the user defined
156 static public void ResolveTree ()
159 // Interfaces are processed next, as classes and
160 // structs might inherit from an object or implement
161 // a set of interfaces, we need to be able to tell
162 // them appart by just using the TypeManager.
164 TypeContainer root = Tree.Types;
166 ArrayList ifaces = root.Interfaces;
168 foreach (TypeContainer i in ifaces)
172 foreach (TypeContainer tc in root.Types)
175 if (root.Delegates != null)
176 foreach (Delegate d in root.Delegates)
179 if (root.Enums != null)
180 foreach (Enum e in root.Enums)
184 static void Error_TypeConflict (string name, Location loc)
187 520, loc, "`" + name + "' conflicts with a predefined type");
190 static void Error_TypeConflict (string name)
193 520, "`" + name + "' conflicts with a predefined type");
197 // Resolves a single class during the corlib bootstrap process
199 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
201 object o = root.GetDefinition (name);
203 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
209 DeclSpace d = (DeclSpace) o;
211 Error_TypeConflict (name, d.Location);
213 Error_TypeConflict (name);
218 return ((DeclSpace) o).DefineType ();
222 // Resolves a struct during the corlib bootstrap process
224 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
226 object o = root.GetDefinition (name);
228 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
234 DeclSpace d = (DeclSpace) o;
236 Error_TypeConflict (name, d.Location);
238 Error_TypeConflict (name);
243 ((DeclSpace) o).DefineType ();
247 // Resolves a struct during the corlib bootstrap process
249 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
251 object o = root.GetDefinition (name);
253 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
257 if (!(o is Interface)){
259 DeclSpace d = (DeclSpace) o;
261 Error_TypeConflict (name, d.Location);
263 Error_TypeConflict (name);
268 ((DeclSpace) o).DefineType ();
272 // Resolves a delegate during the corlib bootstrap process
274 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
276 object o = root.GetDefinition (name);
278 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
282 if (!(o is Delegate)){
283 Error_TypeConflict (name);
287 ((DeclSpace) o).DefineType ();
292 /// Resolves the core types in the compiler when compiling with --nostdlib
294 static public void ResolveCore ()
296 TypeContainer root = Tree.Types;
298 TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
299 TypeManager.system_object_expr.Type = TypeManager.object_type;
300 TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
301 TypeManager.system_valuetype_expr.Type = TypeManager.value_type;
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",
318 "System.Reflection.IReflect",
319 "System.Reflection.ICustomAttributeProvider"
322 foreach (string iname in interfaces_first_stage)
323 BootstrapCorlib_ResolveInterface (root, iname);
326 // These are the base value types
328 string [] structs_first_stage = {
329 "System.Byte", "System.SByte",
330 "System.Int16", "System.UInt16",
331 "System.Int32", "System.UInt32",
332 "System.Int64", "System.UInt64",
335 foreach (string cname in structs_first_stage)
336 BootstrapCorlib_ResolveStruct (root, cname);
339 // Now, we can load the enumerations, after this point,
342 TypeManager.InitEnumUnderlyingTypes ();
344 string [] structs_second_stage = {
345 "System.Single", "System.Double",
346 "System.Char", "System.Boolean",
347 "System.Decimal", "System.Void",
348 "System.RuntimeFieldHandle",
349 "System.RuntimeArgumentHandle",
350 "System.RuntimeTypeHandle",
352 "System.TypedReference",
356 foreach (string cname in structs_second_stage)
357 BootstrapCorlib_ResolveStruct (root, cname);
360 // These are classes that depends on the core interfaces
362 string [] classes_second_stage = {
366 "System.Reflection.MemberInfo",
371 // These are not really important in the order, but they
372 // are used by the compiler later on (typemanager/CoreLookupType-d)
374 "System.Runtime.CompilerServices.RuntimeHelpers",
375 "System.Reflection.DefaultMemberAttribute",
376 "System.Threading.Monitor",
378 "System.AttributeUsageAttribute",
379 "System.Runtime.InteropServices.DllImportAttribute",
380 "System.Runtime.CompilerServices.MethodImplAttribute",
381 "System.Runtime.InteropServices.MarshalAsAttribute",
382 "System.Diagnostics.ConditionalAttribute",
383 "System.ObsoleteAttribute",
384 "System.ParamArrayAttribute",
385 "System.CLSCompliantAttribute",
386 "System.Security.UnverifiableCodeAttribute",
387 "System.Security.Permissions.SecurityAttribute",
388 "System.Runtime.CompilerServices.DecimalConstantAttribute",
389 "System.Runtime.InteropServices.InAttribute",
390 "System.Runtime.InteropServices.OutAttribute",
391 "System.Runtime.InteropServices.StructLayoutAttribute",
392 "System.Runtime.InteropServices.FieldOffsetAttribute",
393 "System.InvalidOperationException",
394 "System.NotSupportedException",
395 "System.MarshalByRefObject",
396 "System.Security.CodeAccessPermission",
397 "System.Runtime.CompilerServices.RequiredAttributeAttribute",
398 "System.Runtime.InteropServices.GuidAttribute",
399 "System.Reflection.AssemblyCultureAttribute"
402 foreach (string cname in classes_second_stage)
403 BootstrapCorlib_ResolveClass (root, cname);
405 BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
407 // These will be defined indirectly during the previous ResolveDelegate.
408 // However make sure the rest of the checks happen.
409 string [] delegate_types = { "System.Delegate", "System.MulticastDelegate" };
410 foreach (string cname in delegate_types)
411 BootstrapCorlib_ResolveClass (root, cname);
415 // Closes all open types
419 // We usually use TypeBuilder types. When we are done
420 // creating the type (which will happen after we have added
421 // methods, fields, etc) we need to "Define" them before we
422 // can save the Assembly
424 static public void CloseTypes ()
426 TypeContainer root = Tree.Types;
428 if (root.Enums != null)
429 foreach (Enum en in root.Enums)
433 // We do this in two passes, first we close the structs,
434 // then the classes, because it seems the code needs it this
435 // way. If this is really what is going on, we should probably
436 // make sure that we define the structs in order as well.
438 foreach (TypeContainer tc in type_container_resolve_order){
439 if (tc.Kind == Kind.Struct && tc.Parent == tree.Types){
444 foreach (TypeContainer tc in type_container_resolve_order){
445 if (!(tc.Kind == Kind.Struct && tc.Parent == tree.Types))
449 if (root.Delegates != null)
450 foreach (Delegate d in root.Delegates)
455 // If we have a <PrivateImplementationDetails> class, close it
457 if (helper_classes != null){
458 foreach (TypeBuilder type_builder in helper_classes) {
460 type_builder.SetCustomAttribute (TypeManager.compiler_generated_attr);
462 type_builder.CreateType ();
466 type_container_resolve_order = null;
467 helper_classes = null;
469 TypeManager.CleanUp ();
473 /// Used to register classes that need to be closed after all the
474 /// user defined classes
476 public static void RegisterCompilerGeneratedType (TypeBuilder helper_class)
478 if (helper_classes == null)
479 helper_classes = new ArrayList ();
481 helper_classes.Add (helper_class);
484 static public void PopulateCoreType (TypeContainer root, string name)
486 DeclSpace ds = (DeclSpace) root.GetDefinition (name);
492 static public void BootCorlib_PopulateCoreTypes ()
494 TypeContainer root = tree.Types;
496 PopulateCoreType (root, "System.Object");
497 PopulateCoreType (root, "System.ValueType");
498 PopulateCoreType (root, "System.Attribute");
499 PopulateCoreType (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
503 // Populates the structs and classes with fields and methods
506 // This is invoked after all interfaces, structs and classes
507 // have been defined through `ResolveTree'
508 static public void PopulateTypes ()
510 TypeContainer root = Tree.Types;
512 if (type_container_resolve_order != null){
513 foreach (TypeContainer tc in type_container_resolve_order)
517 ArrayList delegates = root.Delegates;
518 if (delegates != null){
519 foreach (Delegate d in delegates)
523 ArrayList enums = root.Enums;
525 foreach (Enum en in enums)
530 // Check for cycles in the struct layout
532 if (type_container_resolve_order != null){
533 Hashtable seen = new Hashtable ();
534 foreach (TypeContainer tc in type_container_resolve_order)
535 TypeManager.CheckStructCycles (tc, seen);
540 // A generic hook delegate
542 public delegate void Hook ();
545 // A hook invoked when the code has been generated.
547 public static event Hook EmitCodeHook;
550 // DefineTypes is used to fill in the members of each type.
552 static public void DefineTypes ()
554 TypeContainer root = Tree.Types;
556 ArrayList delegates = root.Delegates;
557 if (delegates != null){
558 foreach (Delegate d in delegates)
562 if (type_container_resolve_order != null){
563 foreach (TypeContainer tc in type_container_resolve_order) {
564 // When compiling corlib, these types have already been
565 // populated from BootCorlib_PopulateCoreTypes ().
566 if (!RootContext.StdLib &&
567 ((tc.Name == "System.Object") ||
568 (tc.Name == "System.Attribute") ||
569 (tc.Name == "System.ValueType") ||
570 (tc.Name == "System.Runtime.CompilerServices.IndexerNameAttribute")))
577 ArrayList enums = root.Enums;
579 foreach (Enum en in enums)
584 static public void EmitCode ()
586 if (Tree.Types.Enums != null) {
587 foreach (Enum e in Tree.Types.Enums)
591 if (type_container_resolve_order != null) {
592 foreach (TypeContainer tc in type_container_resolve_order)
595 if (Report.Errors > 0)
598 foreach (TypeContainer tc in type_container_resolve_order)
602 if (Tree.Types.Delegates != null) {
603 foreach (Delegate d in Tree.Types.Delegates)
607 // Run any hooks after all the types have been defined.
608 // This is used to create nested auxiliary classes for example
611 if (EmitCodeHook != null)
614 CodeGen.Assembly.Emit (Tree.Types);
615 CodeGen.Module.Emit (Tree.Types);
619 // Public Field, used to track which method is the public entry
622 static public MethodInfo EntryPoint;
625 // Track the location of the entry point.
627 static public Location EntryPointLocation;
630 // These are used to generate unique names on the structs and fields.
632 static int field_count;
635 // Makes an initialized struct, returns the field builder that
636 // references the data. Thanks go to Sergey Chaban for researching
637 // how to do this. And coming up with a shorter mechanism than I
638 // was able to figure out.
640 // This works but makes an implicit public struct $ArrayType$SIZE and
641 // makes the fields point to it. We could get more control if we did
644 // 1. DefineNestedType on the impl_details_class with our struct.
646 // 2. Define the field on the impl_details_class
648 static public FieldBuilder MakeStaticData (byte [] data)
652 if (impl_details_class == null){
653 impl_details_class = CodeGen.Module.Builder.DefineType (
654 "<PrivateImplementationDetails>",
655 TypeAttributes.NotPublic,
656 TypeManager.object_type);
658 RegisterCompilerGeneratedType (impl_details_class);
661 fb = impl_details_class.DefineInitializedData (
662 "$$field-" + (field_count++), data,
663 FieldAttributes.Static | FieldAttributes.Assembly);
668 public static void CheckUnsafeOption (Location loc)
671 Report.Error (227, loc,
672 "Unsafe code requires the `unsafe' command line option to be specified");