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
27 public class RootContext
{
30 // Contains the parsed tree
32 static RootTypes root
;
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
;
89 // If set, enable XML documentation generation
91 public static Documentation Documentation
;
93 static public string MainClass
;
103 public static void Reset ()
105 root
= new RootTypes ();
106 type_container_resolve_order
= new ArrayList ();
112 StrongNameKeyFile
= null;
113 StrongNameKeyContainer
= null;
114 StrongNameDelaySign
= false;
118 Version
= LanguageVersion
.Default
;
119 Documentation
= null;
120 impl_details_class
= null;
121 helper_classes
= null;
124 public static bool NeedsEntryPoint
{
125 get { return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe; }
128 static public RootTypes ToplevelTypes
{
132 public static void RegisterOrder (TypeContainer tc
)
134 type_container_resolve_order
.Add (tc
);
138 // The default compiler checked state
140 static public bool Checked
;
143 // Whether to allow Unsafe code
145 static public bool Unsafe
;
148 // This function is used to resolve the hierarchy tree.
149 // It processes interfaces, structs and classes in that order.
151 // It creates the TypeBuilder's as it processes the user defined
154 static public void ResolveTree ()
157 // Interfaces are processed next, as classes and
158 // structs might inherit from an object or implement
159 // a set of interfaces, we need to be able to tell
160 // them appart by just using the TypeManager.
162 foreach (TypeContainer tc
in root
.Types
)
165 foreach (TypeContainer tc
in root
.Types
)
168 if (root
.Delegates
!= null)
169 foreach (Delegate d
in root
.Delegates
)
173 static void Error_TypeConflict (string name
, Location loc
)
176 520, loc
, "`" + name
+ "' conflicts with a predefined type");
179 static void Error_TypeConflict (string name
)
182 520, "`" + name
+ "' conflicts with a predefined type");
186 // Resolves a single class during the corlib bootstrap process
188 static Type
BootstrapCorlib_ResolveClass (TypeContainer root
, string name
)
190 object o
= root
.GetDefinition (name
);
192 Report
.Error (518, "The predefined type `" + name
+ "' is not defined or imported");
198 DeclSpace d
= (DeclSpace
) o
;
200 Error_TypeConflict (name
, d
.Location
);
202 Error_TypeConflict (name
);
207 Type t
= ((DeclSpace
) o
).DefineType ();
209 AttributeTester
.RegisterNonObsoleteType (t
);
214 // Resolves a struct during the corlib bootstrap process
216 static void BootstrapCorlib_ResolveStruct (TypeContainer root
, string name
)
218 object o
= root
.GetDefinition (name
);
220 Report
.Error (518, "The predefined type `" + name
+ "' is not defined or imported");
226 DeclSpace d
= (DeclSpace
) o
;
228 Error_TypeConflict (name
, d
.Location
);
230 Error_TypeConflict (name
);
235 ((DeclSpace
) o
).DefineType ();
239 // Resolves a struct during the corlib bootstrap process
241 static void BootstrapCorlib_ResolveInterface (TypeContainer root
, string name
)
243 object o
= root
.GetDefinition (name
);
245 Report
.Error (518, "The predefined type `" + name
+ "' is not defined or imported");
249 if (!(o
is Interface
)){
251 DeclSpace d
= (DeclSpace
) o
;
253 Error_TypeConflict (name
, d
.Location
);
255 Error_TypeConflict (name
);
260 Type t
= ((DeclSpace
) o
).DefineType ();
262 AttributeTester
.RegisterNonObsoleteType (t
);
266 // Resolves a delegate during the corlib bootstrap process
268 static void BootstrapCorlib_ResolveDelegate (TypeContainer root
, string name
)
270 object o
= root
.GetDefinition (name
);
272 Report
.Error (518, "The predefined type `" + name
+ "' is not defined or imported");
276 if (!(o
is Delegate
)){
277 Error_TypeConflict (name
);
281 ((DeclSpace
) o
).DefineType ();
286 /// Resolves the core types in the compiler when compiling with --nostdlib
288 static public void ResolveCore ()
290 TypeManager
.object_type
= BootstrapCorlib_ResolveClass (root
, "System.Object");
291 TypeManager
.system_object_expr
.Type
= TypeManager
.object_type
;
292 TypeManager
.value_type
= BootstrapCorlib_ResolveClass (root
, "System.ValueType");
293 TypeManager
.system_valuetype_expr
.Type
= TypeManager
.value_type
;
296 // The core attributes
298 BootstrapCorlib_ResolveInterface (root
, "System.Runtime.InteropServices._Attribute");
299 TypeManager
.attribute_type
= BootstrapCorlib_ResolveClass (root
, "System.Attribute");
300 TypeManager
.obsolete_attribute_type
= BootstrapCorlib_ResolveClass (root
, "System.ObsoleteAttribute");
301 TypeManager
.indexer_name_type
= BootstrapCorlib_ResolveClass (root
, "System.Runtime.CompilerServices.IndexerNameAttribute");
303 string [] interfaces_first_stage
= {
304 "System.IComparable", "System.ICloneable",
305 "System.IConvertible",
307 "System.Collections.IEnumerable",
308 "System.Collections.ICollection",
309 "System.Collections.IEnumerator",
310 "System.Collections.IList",
311 "System.IAsyncResult",
312 "System.IDisposable",
314 "System.Runtime.Serialization.ISerializable",
316 "System.Reflection.IReflect",
317 "System.Reflection.ICustomAttributeProvider",
319 "System.Runtime.InteropServices._Exception",
324 "System.Collections.Generic.IEnumerator`1",
325 "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",
381 // These are not really important in the order, but they
382 // are used by the compiler later on (typemanager/CoreLookupType-d)
384 "System.Runtime.CompilerServices.RuntimeHelpers",
385 "System.Reflection.DefaultMemberAttribute",
386 "System.Threading.Monitor",
387 "System.Threading.Interlocked",
389 "System.AttributeUsageAttribute",
390 "System.Runtime.InteropServices.DllImportAttribute",
391 "System.Runtime.CompilerServices.MethodImplAttribute",
392 "System.Runtime.InteropServices.MarshalAsAttribute",
394 "System.Runtime.CompilerServices.CompilerGeneratedAttribute",
395 "System.Runtime.CompilerServices.FixedBufferAttribute",
397 "System.Diagnostics.ConditionalAttribute",
398 "System.ParamArrayAttribute",
399 "System.CLSCompliantAttribute",
400 "System.Security.UnverifiableCodeAttribute",
401 "System.Security.Permissions.SecurityAttribute",
402 "System.Runtime.CompilerServices.DecimalConstantAttribute",
403 "System.Runtime.InteropServices.InAttribute",
404 "System.Runtime.InteropServices.OutAttribute",
405 "System.Runtime.InteropServices.StructLayoutAttribute",
406 "System.Runtime.InteropServices.FieldOffsetAttribute",
408 "System.Runtime.InteropServices.DefaultCharSetAttribute",
410 "System.InvalidOperationException",
411 "System.NotSupportedException",
412 "System.MarshalByRefObject",
413 "System.Security.CodeAccessPermission",
414 "System.Runtime.CompilerServices.RequiredAttributeAttribute",
415 "System.Runtime.InteropServices.GuidAttribute",
416 "System.Reflection.AssemblyCultureAttribute"
419 foreach (string cname
in classes_second_stage
)
420 BootstrapCorlib_ResolveClass (root
, cname
);
422 BootstrapCorlib_ResolveStruct (root
, "System.Nullable`1");
424 BootstrapCorlib_ResolveDelegate (root
, "System.AsyncCallback");
426 // These will be defined indirectly during the previous ResolveDelegate.
427 // However make sure the rest of the checks happen.
428 string [] delegate_types
= { "System.Delegate", "System.MulticastDelegate" }
;
429 foreach (string cname
in delegate_types
)
430 BootstrapCorlib_ResolveClass (root
, cname
);
434 // Closes all open types
438 // We usually use TypeBuilder types. When we are done
439 // creating the type (which will happen after we have added
440 // methods, fields, etc) we need to "Define" them before we
441 // can save the Assembly
443 static public void CloseTypes ()
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
== root
){
457 foreach (TypeContainer tc
in type_container_resolve_order
){
458 if (!(tc
.Kind
== Kind
.Struct
&& tc
.Parent
== root
))
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
) {
473 type_builder
.SetCustomAttribute (TypeManager
.compiler_generated_attr
);
475 type_builder
.CreateType ();
479 type_container_resolve_order
= null;
480 helper_classes
= null;
482 TypeManager
.CleanUp ();
486 /// Used to register classes that need to be closed after all the
487 /// user defined classes
489 public static void RegisterCompilerGeneratedType (TypeBuilder helper_class
)
491 if (helper_classes
== null)
492 helper_classes
= new ArrayList ();
494 helper_classes
.Add (helper_class
);
497 static public void PopulateCoreType (TypeContainer root
, string name
)
499 DeclSpace ds
= (DeclSpace
) root
.GetDefinition (name
);
505 static public void BootCorlib_PopulateCoreTypes ()
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 ()
522 if (type_container_resolve_order
!= null){
523 foreach (TypeContainer tc
in type_container_resolve_order
)
525 foreach (TypeContainer tc
in type_container_resolve_order
)
529 ArrayList delegates
= root
.Delegates
;
530 if (delegates
!= null){
531 foreach (Delegate d
in delegates
)
536 // Check for cycles in the struct layout
538 if (type_container_resolve_order
!= null){
539 Hashtable seen
= new Hashtable ();
540 foreach (TypeContainer tc
in type_container_resolve_order
)
541 TypeManager
.CheckStructCycles (tc
, seen
);
546 // A generic hook delegate
548 public delegate void Hook ();
551 // A hook invoked when the code has been generated.
553 public static event Hook EmitCodeHook
;
556 // DefineTypes is used to fill in the members of each type.
558 static public void DefineTypes ()
560 ArrayList delegates
= root
.Delegates
;
561 if (delegates
!= null){
562 foreach (Delegate d
in delegates
)
566 if (type_container_resolve_order
!= null){
567 foreach (TypeContainer tc
in type_container_resolve_order
) {
568 // When compiling corlib, these types have already been
569 // populated from BootCorlib_PopulateCoreTypes ().
570 if (!RootContext
.StdLib
&&
571 ((tc
.Name
== "System.Object") ||
572 (tc
.Name
== "System.Attribute") ||
573 (tc
.Name
== "System.ValueType") ||
574 (tc
.Name
== "System.Runtime.CompilerServices.IndexerNameAttribute")))
582 static public void EmitCode ()
584 if (type_container_resolve_order
!= null) {
585 foreach (TypeContainer tc
in type_container_resolve_order
)
588 if (Report
.Errors
> 0)
591 foreach (TypeContainer tc
in type_container_resolve_order
)
595 if (root
.Delegates
!= null) {
596 foreach (Delegate d
in root
.Delegates
)
600 // Run any hooks after all the types have been defined.
601 // This is used to create nested auxiliary classes for example
604 if (EmitCodeHook
!= null)
607 CodeGen
.Assembly
.Emit (root
);
608 CodeGen
.Module
.Emit (root
);
612 // Public Field, used to track which method is the public entry
615 static public MethodInfo EntryPoint
;
618 // Track the location of the entry point.
620 static public Location EntryPointLocation
;
623 // These are used to generate unique names on the structs and fields.
625 static int field_count
;
628 // Makes an initialized struct, returns the field builder that
629 // references the data. Thanks go to Sergey Chaban for researching
630 // how to do this. And coming up with a shorter mechanism than I
631 // was able to figure out.
633 // This works but makes an implicit public struct $ArrayType$SIZE and
634 // makes the fields point to it. We could get more control if we did
637 // 1. DefineNestedType on the impl_details_class with our struct.
639 // 2. Define the field on the impl_details_class
641 static public FieldBuilder
MakeStaticData (byte [] data
)
645 if (impl_details_class
== null){
646 impl_details_class
= CodeGen
.Module
.Builder
.DefineType (
647 "<PrivateImplementationDetails>",
648 TypeAttributes
.NotPublic
,
649 TypeManager
.object_type
);
651 RegisterCompilerGeneratedType (impl_details_class
);
654 fb
= impl_details_class
.DefineInitializedData (
655 "$$field-" + (field_count
++), data
,
656 FieldAttributes
.Static
| FieldAttributes
.Assembly
);
661 public static void CheckUnsafeOption (Location loc
)
664 Report
.Error (227, loc
,
665 "Unsafe code requires the `unsafe' command line option to be specified");