mcs/mcs/rootcontext.cs

   1 //
   2 // rootcontext.cs: keeps track of our tree representation, and assemblies loaded.
   3 //
   4 // Author: Miguel de Icaza (miguel@ximian.com)
   5 //         Ravi Pratap     (ravi@ximian.com)
   6 //
   7 // Licensed under the terms of the GNU GPL
   8 //
   9 // (C) 2001 Ximian, Inc (http://www.ximian.com)
  10 // (C) 2004 Novell, Inc
  11
  12 using System;
  13 using System.Collections;
  14 using System.Reflection;
  15 using System.Reflection.Emit;
  16 using System.Diagnostics;
  17
  18 namespace Mono.CSharp {
  19
  20         public enum LanguageVersion
  21         {
  22                 Default = 0,
  23                 ISO_1   = 1
  24         }
  25
  26         public class RootContext {
  27
  28                 //
  29                 // Contains the parsed tree
  30                 //
  31                 static RootTypes root;
  32
  33                 //
  34                 // This hashtable contains all of the #definitions across the source code
  35                 // it is used by the ConditionalAttribute handler.
  36                 //
  37                 public static Hashtable AllDefines = new Hashtable ();
  38
  39                 //
  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.
  43                 //
  44                 public static bool StdLib;
  45
  46                 //
  47                 // This keeps track of the order in which classes were defined
  48                 // so that we can poulate them in that order.
  49                 //
  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,
  53                 // override).
  54                 //
  55                 static ArrayList type_container_resolve_order;
  56
  57                 //
  58                 // Holds a reference to the Private Implementation Details
  59                 // class.
  60                 //
  61                 static ArrayList helper_classes;
  62
  63                 static TypeBuilder impl_details_class;
  64
  65                 public static int WarningLevel;
  66
  67                 public static Target Target;
  68                 public static string TargetExt;
  69
  70                 public static bool VerifyClsCompliance = true;
  71
  72                 /// <summary>
  73                 /// Holds /optimize option
  74                 /// </summary>
  75                 public static bool Optimize = true;
  76
  77                 public static LanguageVersion Version;
  78
  79                 //
  80                 // We keep strongname related info here because
  81                 // it's also used as complier options from CSC 8.x
  82                 //
  83                 public static string StrongNameKeyFile;
  84                 public static string StrongNameKeyContainer;
  85                 public static bool StrongNameDelaySign;
  86
  87                 //
  88                 // If set, enable XML documentation generation
  89                 //
  90                 public static Documentation Documentation;
  91
  92                 static public string MainClass;
  93
  94                 //
  95                 // Constructor
  96                 //
  97                 static RootContext ()
  98                 {
  99                         Reset ();
 100                 }
 101
 102                 public static void Reset ()
 103                 {
 104                         root = new RootTypes ();
 105                         type_container_resolve_order = new ArrayList ();
 106                         EntryPoint = null;
 107                         WarningLevel = 3;
 108                         Checked = false;
 109                         Unsafe = false;
 110                         StdLib = true;
 111                         StrongNameKeyFile = null;
 112                         StrongNameKeyContainer = null;
 113                         StrongNameDelaySign = false;
 114                         MainClass = null;
 115                         Target = Target.Exe;
 116                         TargetExt = ".exe";
 117                         Version = LanguageVersion.Default;
 118                         Documentation = null;
 119                         impl_details_class = null;
 120                         helper_classes = null;
 121                 }
 122
 123                 public static bool NeedsEntryPoint {
 124                         get { return RootContext.Target == Target.Exe || RootContext.Target == Target.WinExe; }
 125                 }
 126
 127                 static public RootTypes ToplevelTypes {
 128                         get { return root; }
 129                 }
 130
 131                 public static void RegisterOrder (TypeContainer tc)
 132                 {
 133                         type_container_resolve_order.Add (tc);
 134                 }
 135
 136                 //
 137                 // The default compiler checked state
 138                 //
 139                 static public bool Checked;
 140
 141                 //
 142                 // Whether to allow Unsafe code
 143                 //
 144                 static public bool Unsafe;
 145
 146                 // <remarks>
 147                 //   This function is used to resolve the hierarchy tree.
 148                 //   It processes interfaces, structs and classes in that order.
 149                 //
 150                 //   It creates the TypeBuilder's as it processes the user defined
 151                 //   types.
 152                 // </remarks>
 153                 static public void ResolveTree ()
 154                 {
 155                         //
 156                         // Interfaces are processed next, as classes and
 157                         // structs might inherit from an object or implement
 158                         // a set of interfaces, we need to be able to tell
 159                         // them appart by just using the TypeManager.
 160                         //
 161                         ArrayList ifaces = root.Interfaces;
 162                         if (ifaces != null){
 163                                 foreach (TypeContainer i in ifaces)
 164                                         i.DefineType ();
 165                         }
 166
 167                         foreach (TypeContainer tc in root.Types)
 168                                 tc.DefineType ();
 169
 170                         if (root.Delegates != null)
 171                                 foreach (Delegate d in root.Delegates)
 172                                         d.DefineType ();
 173
 174                         if (root.Enums != null)
 175                                 foreach (Enum e in root.Enums)
 176                                         e.DefineType ();
 177                 }
 178
 179                 static void Error_TypeConflict (string name, Location loc)
 180                 {
 181                         Report.Error (
 182                                 520, loc, "`" + name + "' conflicts with a predefined type");
 183                 }
 184
 185                 static void Error_TypeConflict (string name)
 186                 {
 187                         Report.Error (
 188                                 520, "`" + name + "' conflicts with a predefined type");
 189                 }
 190
 191                 //
 192                 // Resolves a single class during the corlib bootstrap process
 193                 //
 194                 static TypeBuilder BootstrapCorlib_ResolveClass (TypeContainer root, string name)
 195                 {
 196                         object o = root.GetDefinition (name);
 197                         if (o == null){
 198                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
 199                                 return null;
 200                         }
 201
 202                         if (!(o is Class)){
 203                                 if (o is DeclSpace){
 204                                         DeclSpace d = (DeclSpace) o;
 205
 206                                         Error_TypeConflict (name, d.Location);
 207                                 } else
 208                                         Error_TypeConflict (name);
 209
 210                                 return null;
 211                         }
 212
 213                         return ((DeclSpace) o).DefineType ();
 214                 }
 215
 216                 //
 217                 // Resolves a struct during the corlib bootstrap process
 218                 //
 219                 static void BootstrapCorlib_ResolveStruct (TypeContainer root, string name)
 220                 {
 221                         object o = root.GetDefinition (name);
 222                         if (o == null){
 223                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
 224                                 return;
 225                         }
 226
 227                         if (!(o is Struct)){
 228                                 if (o is DeclSpace){
 229                                         DeclSpace d = (DeclSpace) o;
 230
 231                                         Error_TypeConflict (name, d.Location);
 232                                 } else
 233                                         Error_TypeConflict (name);
 234
 235                                 return;
 236                         }
 237
 238                         ((DeclSpace) o).DefineType ();
 239                 }
 240
 241                 //
 242                 // Resolves a struct during the corlib bootstrap process
 243                 //
 244                 static void BootstrapCorlib_ResolveInterface (TypeContainer root, string name)
 245                 {
 246                         object o = root.GetDefinition (name);
 247                         if (o == null){
 248                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
 249                                 return;
 250                         }
 251
 252                         if (!(o is Interface)){
 253                                 if (o is DeclSpace){
 254                                         DeclSpace d = (DeclSpace) o;
 255
 256                                         Error_TypeConflict (name, d.Location);
 257                                 } else
 258                                         Error_TypeConflict (name);
 259
 260                                 return;
 261                         }
 262
 263                         ((DeclSpace) o).DefineType ();
 264                 }
 265
 266                 //
 267                 // Resolves a delegate during the corlib bootstrap process
 268                 //
 269                 static void BootstrapCorlib_ResolveDelegate (TypeContainer root, string name)
 270                 {
 271                         object o = root.GetDefinition (name);
 272                         if (o == null){
 273                                 Report.Error (518, "The predefined type `" + name + "' is not defined or imported");
 274                                 return;
 275                         }
 276
 277                         if (!(o is Delegate)){
 278                                 Error_TypeConflict (name);
 279                                 return;
 280                         }
 281
 282                         ((DeclSpace) o).DefineType ();
 283                 }
 284
 285
 286                 /// <summary>
 287                 ///    Resolves the core types in the compiler when compiling with --nostdlib
 288                 /// </summary>
 289                 static public void ResolveCore ()
 290                 {
 291                         TypeManager.object_type = BootstrapCorlib_ResolveClass (root, "System.Object");
 292                         TypeManager.system_object_expr.Type = TypeManager.object_type;
 293                         TypeManager.value_type = BootstrapCorlib_ResolveClass (root, "System.ValueType");
 294                         TypeManager.system_valuetype_expr.Type = TypeManager.value_type;
 295                         TypeManager.attribute_type = BootstrapCorlib_ResolveClass (root, "System.Attribute");
 296                         TypeManager.indexer_name_type = BootstrapCorlib_ResolveClass (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
 297
 298                         string [] interfaces_first_stage = {
 299                                 "System.IComparable", "System.ICloneable",
 300                                 "System.IConvertible",
 301
 302                                 "System.Collections.IEnumerable",
 303                                 "System.Collections.ICollection",
 304                                 "System.Collections.IEnumerator",
 305                                 "System.Collections.IList",
 306                                 "System.IAsyncResult",
 307                                 "System.IDisposable",
 308
 309                                 "System.Runtime.Serialization.ISerializable",
 310
 311                                 "System.Reflection.IReflect",
 312                                 "System.Reflection.ICustomAttributeProvider"
 313                         };
 314
 315                         foreach (string iname in interfaces_first_stage)
 316                                 BootstrapCorlib_ResolveInterface (root, iname);
 317
 318                         //
 319                         // These are the base value types
 320                         //
 321                         string [] structs_first_stage = {
 322                                 "System.Byte",    "System.SByte",
 323                                 "System.Int16",   "System.UInt16",
 324                                 "System.Int32",   "System.UInt32",
 325                                 "System.Int64",   "System.UInt64",
 326                         };
 327
 328                         foreach (string cname in structs_first_stage)
 329                                 BootstrapCorlib_ResolveStruct (root, cname);
 330
 331                         //
 332                         // Now, we can load the enumerations, after this point,
 333                         // we can use enums.
 334                         //
 335                         TypeManager.InitEnumUnderlyingTypes ();
 336
 337                         string [] structs_second_stage = {
 338                                 "System.Single",  "System.Double",
 339                                 "System.Char",    "System.Boolean",
 340                                 "System.Decimal", "System.Void",
 341                                 "System.RuntimeFieldHandle",
 342                                 "System.RuntimeArgumentHandle",
 343                                 "System.RuntimeTypeHandle",
 344                                 "System.IntPtr",
 345                                 "System.TypedReference",
 346                                 "System.ArgIterator"
 347                         };
 348
 349                         foreach (string cname in structs_second_stage)
 350                                 BootstrapCorlib_ResolveStruct (root, cname);
 351
 352                         //
 353                         // These are classes that depends on the core interfaces
 354                         //
 355                         string [] classes_second_stage = {
 356                                 "System.Enum",
 357                                 "System.String",
 358                                 "System.Array",
 359                                 "System.Reflection.MemberInfo",
 360                                 "System.Type",
 361                                 "System.Exception",
 362
 363                                 //
 364                                 // These are not really important in the order, but they
 365                                 // are used by the compiler later on (typemanager/CoreLookupType-d)
 366                                 //
 367                                 "System.Runtime.CompilerServices.RuntimeHelpers",
 368                                 "System.Reflection.DefaultMemberAttribute",
 369                                 "System.Threading.Monitor",
 370
 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.DecimalConstantAttribute",
 382                                 "System.Runtime.InteropServices.InAttribute",
 383                                 "System.Runtime.InteropServices.OutAttribute",
 384                                 "System.Runtime.InteropServices.StructLayoutAttribute",
 385                                 "System.Runtime.InteropServices.FieldOffsetAttribute",
 386                                 "System.InvalidOperationException",
 387                                 "System.NotSupportedException",
 388                                 "System.MarshalByRefObject",
 389                                 "System.Security.CodeAccessPermission",
 390                                 "System.Runtime.CompilerServices.RequiredAttributeAttribute",
 391                                 "System.Runtime.InteropServices.GuidAttribute",
 392                                 "System.Reflection.AssemblyCultureAttribute"
 393                         };
 394
 395                         foreach (string cname in classes_second_stage)
 396                                 BootstrapCorlib_ResolveClass (root, cname);
 397
 398                         BootstrapCorlib_ResolveDelegate (root, "System.AsyncCallback");
 399
 400                         // These will be defined indirectly during the previous ResolveDelegate.
 401                         // However make sure the rest of the checks happen.
 402                         string [] delegate_types = { "System.Delegate", "System.MulticastDelegate" };
 403                         foreach (string cname in delegate_types)
 404                                 BootstrapCorlib_ResolveClass (root, cname);
 405                 }
 406
 407                 // <summary>
 408                 //   Closes all open types
 409                 // </summary>
 410                 //
 411                 // <remarks>
 412                 //   We usually use TypeBuilder types.  When we are done
 413                 //   creating the type (which will happen after we have added
 414                 //   methods, fields, etc) we need to "Define" them before we
 415                 //   can save the Assembly
 416                 // </remarks>
 417                 static public void CloseTypes ()
 418                 {
 419                         if (root.Enums != null)
 420                                 foreach (Enum en in root.Enums)
 421                                         en.CloseType ();
 422
 423                         //
 424                         // We do this in two passes, first we close the structs,
 425                         // then the classes, because it seems the code needs it this
 426                         // way.  If this is really what is going on, we should probably
 427                         // make sure that we define the structs in order as well.
 428                         //
 429                         foreach (TypeContainer tc in type_container_resolve_order){
 430                                 if (tc.Kind == Kind.Struct && tc.Parent == root){
 431                                         tc.CloseType ();
 432                                 }
 433                         }
 434
 435                         foreach (TypeContainer tc in type_container_resolve_order){
 436                                 if (!(tc.Kind == Kind.Struct && tc.Parent == root))
 437                                         tc.CloseType ();
 438                         }
 439
 440                         if (root.Delegates != null)
 441                                 foreach (Delegate d in root.Delegates)
 442                                         d.CloseType ();
 443
 444
 445                         //
 446                         // If we have a <PrivateImplementationDetails> class, close it
 447                         //
 448                         if (helper_classes != null){
 449                                 foreach (TypeBuilder type_builder in helper_classes) {
 450 #if NET_2_0
 451                                         type_builder.SetCustomAttribute (TypeManager.compiler_generated_attr);
 452 #endif
 453                                         type_builder.CreateType ();
 454                                 }
 455                         }
 456
 457                         type_container_resolve_order = null;
 458                         helper_classes = null;
 459                         //root = null;
 460                         TypeManager.CleanUp ();
 461                 }
 462
 463                 /// <summary>
 464                 ///   Used to register classes that need to be closed after all the
 465                 ///   user defined classes
 466                 /// </summary>
 467                 public static void RegisterCompilerGeneratedType (TypeBuilder helper_class)
 468                 {
 469                         if (helper_classes == null)
 470                                 helper_classes = new ArrayList ();
 471
 472                         helper_classes.Add (helper_class);
 473                 }
 474
 475                 static public void PopulateCoreType (TypeContainer root, string name)
 476                 {
 477                         DeclSpace ds = (DeclSpace) root.GetDefinition (name);
 478
 479                         ds.DefineMembers ();
 480                         ds.Define ();
 481                 }
 482
 483                 static public void BootCorlib_PopulateCoreTypes ()
 484                 {
 485                         PopulateCoreType (root, "System.Object");
 486                         PopulateCoreType (root, "System.ValueType");
 487                         PopulateCoreType (root, "System.Attribute");
 488                         PopulateCoreType (root, "System.Runtime.CompilerServices.IndexerNameAttribute");
 489                 }
 490
 491                 // <summary>
 492                 //   Populates the structs and classes with fields and methods
 493                 // </summary>
 494                 //
 495                 // This is invoked after all interfaces, structs and classes
 496                 // have been defined through `ResolveTree'
 497                 static public void PopulateTypes ()
 498                 {
 499                         if (type_container_resolve_order != null){
 500                                 foreach (TypeContainer tc in type_container_resolve_order)
 501                                         tc.DefineMembers ();
 502                         }
 503
 504                         ArrayList delegates = root.Delegates;
 505                         if (delegates != null){
 506                                 foreach (Delegate d in delegates)
 507                                         d.DefineMembers ();
 508                         }
 509
 510                         ArrayList enums = root.Enums;
 511                         if (enums != null){
 512                                 foreach (Enum en in enums)
 513                                         en.DefineMembers ();
 514                         }
 515
 516                         //
 517                         // Check for cycles in the struct layout
 518                         //
 519                         if (type_container_resolve_order != null){
 520                                 Hashtable seen = new Hashtable ();
 521                                 foreach (TypeContainer tc in type_container_resolve_order)
 522                                         TypeManager.CheckStructCycles (tc, seen);
 523                         }
 524                 }
 525
 526                 //
 527                 // A generic hook delegate
 528                 //
 529                 public delegate void Hook ();
 530
 531                 //
 532                 // A hook invoked when the code has been generated.
 533                 //
 534                 public static event Hook EmitCodeHook;
 535
 536                 //
 537                 // DefineTypes is used to fill in the members of each type.
 538                 //
 539                 static public void DefineTypes ()
 540                 {
 541                         ArrayList delegates = root.Delegates;
 542                         if (delegates != null){
 543                                 foreach (Delegate d in delegates)
 544                                         d.Define ();
 545                         }
 546
 547                         if (type_container_resolve_order != null){
 548                                 foreach (TypeContainer tc in type_container_resolve_order) {
 549                                         // When compiling corlib, these types have already been
 550                                         // populated from BootCorlib_PopulateCoreTypes ().
 551                                         if (!RootContext.StdLib &&
 552                                             ((tc.Name == "System.Object") ||
 553                                              (tc.Name == "System.Attribute") ||
 554                                              (tc.Name == "System.ValueType") ||
 555                                              (tc.Name == "System.Runtime.CompilerServices.IndexerNameAttribute")))
 556                                                 continue;
 557
 558                                         tc.Define ();
 559                                 }
 560                         }
 561
 562                         ArrayList enums = root.Enums;
 563                         if (enums != null){
 564                                 foreach (Enum en in enums)
 565                                         en.Define ();
 566                         }
 567                 }
 568
 569                 static public void EmitCode ()
 570                 {
 571                         if (root.Enums != null) {
 572                                 foreach (Enum e in root.Enums)
 573                                         e.Emit ();
 574                         }
 575
 576                         if (type_container_resolve_order != null) {
 577                                 foreach (TypeContainer tc in type_container_resolve_order)
 578                                         tc.EmitType ();
 579
 580                                 if (Report.Errors > 0)
 581                                         return;
 582
 583                                 foreach (TypeContainer tc in type_container_resolve_order)
 584                                         tc.VerifyMembers ();
 585                         }
 586
 587                         if (root.Delegates != null) {
 588                                 foreach (Delegate d in root.Delegates)
 589                                         d.Emit ();
 590                         }
 591                         //
 592                         // Run any hooks after all the types have been defined.
 593                         // This is used to create nested auxiliary classes for example
 594                         //
 595
 596                         if (EmitCodeHook != null)
 597                                 EmitCodeHook ();
 598
 599                         CodeGen.Assembly.Emit (root);
 600                         CodeGen.Module.Emit (root);
 601                 }
 602
 603                 //
 604                 // Public Field, used to track which method is the public entry
 605                 // point.
 606                 //
 607                 static public MethodInfo EntryPoint;
 608
 609                 //
 610                 // Track the location of the entry point.
 611                 //
 612                 static public Location EntryPointLocation;
 613
 614                 //
 615                 // These are used to generate unique names on the structs and fields.
 616                 //
 617                 static int field_count;
 618
 619                 //
 620                 // Makes an initialized struct, returns the field builder that
 621                 // references the data.  Thanks go to Sergey Chaban for researching
 622                 // how to do this.  And coming up with a shorter mechanism than I
 623                 // was able to figure out.
 624                 //
 625                 // This works but makes an implicit public struct $ArrayType$SIZE and
 626                 // makes the fields point to it.  We could get more control if we did
 627                 // use instead:
 628                 //
 629                 // 1. DefineNestedType on the impl_details_class with our struct.
 630                 //
 631                 // 2. Define the field on the impl_details_class
 632                 //
 633                 static public FieldBuilder MakeStaticData (byte [] data)
 634                 {
 635                         FieldBuilder fb;
 636
 637                         if (impl_details_class == null){
 638                                 impl_details_class = CodeGen.Module.Builder.DefineType (
 639                                         "<PrivateImplementationDetails>",
 640                                         TypeAttributes.NotPublic,
 641                                         TypeManager.object_type);
 642
 643                                 RegisterCompilerGeneratedType (impl_details_class);
 644                         }
 645
 646                         fb = impl_details_class.DefineInitializedData (
 647                                 "$$field-" + (field_count++), data,
 648                                 FieldAttributes.Static | FieldAttributes.Assembly);
 649
 650                         return fb;
 651                 }
 652
 653                 public static void CheckUnsafeOption (Location loc)
 654                 {
 655                         if (!Unsafe) {
 656                                 Report.Error (227, loc,
 657                                         "Unsafe code requires the `unsafe' command line option to be specified");
 658                         }
 659                 }
 660         }
 661 }
 662
 663