mcs/gmcs/namespace.cs

   1 //
   2 // namespace.cs: Tracks namespaces
   3 //
   4 // Author:
   5 //   Miguel de Icaza (miguel@ximian.com)
   6 //
   7 // (C) 2001 Ximian, Inc.
   8 //
   9 using System;
  10 using System.Collections;
  11
  12 namespace Mono.CSharp {
  13
  14         /// <summary>
  15         ///   Keeps track of the namespaces defined in the C# code.
  16         /// </summary>
  17         public class Namespace : IAlias {
  18                 static ArrayList all_namespaces = new ArrayList ();
  19                 static Hashtable namespaces_map = new Hashtable ();
  20
  21                 Namespace parent;
  22                 string fullname;
  23                 ArrayList entries;
  24                 Hashtable namespaces;
  25                 Hashtable defined_names;
  26
  27                 /// <summary>
  28                 ///   Constructor Takes the current namespace and the
  29                 ///   name.  This is bootstrapped with parent == null
  30                 ///   and name = ""
  31                 /// </summary>
  32                 public Namespace (Namespace parent, string name)
  33                 {
  34                         this.parent = parent;
  35
  36                         string pname = parent != null ? parent.Name : "";
  37
  38                         if (pname == "")
  39                                 fullname = name;
  40                         else
  41                                 fullname = parent.Name + "." + name;
  42
  43                         entries = new ArrayList ();
  44                         namespaces = new Hashtable ();
  45                         defined_names = new Hashtable ();
  46
  47                         all_namespaces.Add (this);
  48                         if (namespaces_map.Contains (fullname))
  49                                 return;
  50                         namespaces_map [fullname] = true;
  51                 }
  52
  53                 public static bool IsNamespace (string name)
  54                 {
  55                         return namespaces_map [name] != null;
  56                 }
  57
  58                 public static Namespace Root = new Namespace (null, "");
  59
  60                 public Namespace GetNamespace (string name, bool create)
  61                 {
  62                         int pos = name.IndexOf ('.');
  63
  64                         Namespace ns;
  65                         string first;
  66                         if (pos >= 0)
  67                                 first = name.Substring (0, pos);
  68                         else
  69                                 first = name;
  70
  71                         ns = (Namespace) namespaces [first];
  72                         if (ns == null) {
  73                                 if (!create)
  74                                         return null;
  75
  76                                 ns = new Namespace (this, first);
  77                                 namespaces.Add (first, ns);
  78                         }
  79
  80                         if (pos >= 0)
  81                                 ns = ns.GetNamespace (name.Substring (pos + 1), create);
  82
  83                         return ns;
  84                 }
  85
  86                 public static Namespace LookupNamespace (string name, bool create)
  87                 {
  88                         return Root.GetNamespace (name, create);
  89                 }
  90
  91                 public IAlias Lookup (DeclSpace ds, string name, Location loc)
  92                 {
  93                         IAlias o = Lookup (name);
  94
  95                         Type t;
  96                         DeclSpace tdecl = o as DeclSpace;
  97                         if (tdecl != null) {
  98                                 t = tdecl.DefineType ();
  99
 100                                 if ((ds == null) || ds.CheckAccessLevel (t))
 101                                         return new TypeExpression (t, loc);
 102                         }
 103
 104                         Namespace ns = GetNamespace (name, false);
 105                         if (ns != null)
 106                                 return ns;
 107
 108                         t = TypeManager.LookupType (DeclSpace.MakeFQN (fullname, name));
 109                         if ((t == null) || ((ds != null) && !ds.CheckAccessLevel (t)))
 110                                 return null;
 111
 112                         return new TypeExpression (t, loc);
 113                 }
 114
 115                 public void AddNamespaceEntry (NamespaceEntry entry)
 116                 {
 117                         entries.Add (entry);
 118                 }
 119
 120                 public void DefineName (string name, IAlias o)
 121                 {
 122                         defined_names.Add (name, o);
 123                 }
 124
 125                 public IAlias Lookup (string name)
 126                 {
 127                         return (IAlias) defined_names [name];
 128                 }
 129
 130                 static public ArrayList UserDefinedNamespaces {
 131                         get {
 132                                 return all_namespaces;
 133                         }
 134                 }
 135
 136                 /// <summary>
 137                 ///   The qualified name of the current namespace
 138                 /// </summary>
 139                 public string Name {
 140                         get {
 141                                 return fullname;
 142                         }
 143                 }
 144
 145                 /// <summary>
 146                 ///   The parent of this namespace, used by the parser to "Pop"
 147                 ///   the current namespace declaration
 148                 /// </summary>
 149                 public Namespace Parent {
 150                         get {
 151                                 return parent;
 152                         }
 153                 }
 154
 155                 public static void DefineNamespaces (SymbolWriter symwriter)
 156                 {
 157                         foreach (Namespace ns in all_namespaces) {
 158                                 foreach (NamespaceEntry entry in ns.entries)
 159                                         entry.DefineNamespace (symwriter);
 160                         }
 161                 }
 162
 163                 /// <summary>
 164                 ///   Used to validate that all the using clauses are correct
 165                 ///   after we are finished parsing all the files.
 166                 /// </summary>
 167                 public static void VerifyUsing ()
 168                 {
 169                         foreach (Namespace ns in all_namespaces) {
 170                                 foreach (NamespaceEntry entry in ns.entries)
 171                                         entry.VerifyUsing ();
 172                         }
 173                 }
 174
 175                 public override string ToString ()
 176                 {
 177                         if (this == Root)
 178                                 return "Namespace (<root>)";
 179                         else
 180                                 return String.Format ("Namespace ({0})", Name);
 181                 }
 182
 183                 bool IAlias.IsType {
 184                         get { return false; }
 185                 }
 186
 187                 TypeExpr IAlias.Type {
 188                         get {
 189                                 throw new InvalidOperationException ();
 190                         }
 191                 }
 192         }
 193
 194         public class NamespaceEntry
 195         {
 196                 Namespace ns;
 197                 NamespaceEntry parent, implicit_parent;
 198                 SourceFile file;
 199                 int symfile_id;
 200                 Hashtable aliases;
 201                 ArrayList using_clauses;
 202                 public bool DeclarationFound = false;
 203
 204                 //
 205                 // This class holds the location where a using definition is
 206                 // done, and whether it has been used by the program or not.
 207                 //
 208                 // We use this to flag using clauses for namespaces that do not
 209                 // exist.
 210                 //
 211                 public class UsingEntry {
 212                         public readonly string Name;
 213                         public readonly NamespaceEntry NamespaceEntry;
 214                         public readonly Location Location;
 215
 216                         public UsingEntry (NamespaceEntry entry, string name, Location loc)
 217                         {
 218                                 Name = name;
 219                                 NamespaceEntry = entry;
 220                                 Location = loc;
 221                         }
 222
 223                         Namespace resolved_ns;
 224
 225                         public Namespace Resolve ()
 226                         {
 227                                 if (resolved_ns != null)
 228                                         return resolved_ns;
 229
 230                                 Namespace curr_ns = NamespaceEntry.NS;
 231                                 while ((curr_ns != null) && (resolved_ns == null)) {
 232                                         resolved_ns = curr_ns.GetNamespace (Name, false);
 233
 234                                         if (resolved_ns == null)
 235                                                 curr_ns = curr_ns.Parent;
 236                                 }
 237
 238                                 return resolved_ns;
 239                         }
 240                 }
 241
 242                 public class AliasEntry {
 243                         public readonly string Name;
 244                         public readonly TypeName Alias;
 245                         public readonly NamespaceEntry NamespaceEntry;
 246                         public readonly Location Location;
 247
 248                         public AliasEntry (NamespaceEntry entry, string name, TypeName alias, Location loc)
 249                         {
 250                                 Name = name;
 251                                 Alias = alias;
 252                                 NamespaceEntry = entry;
 253                                 Location = loc;
 254                         }
 255
 256                         IAlias resolved;
 257
 258                         public IAlias Resolve ()
 259                         {
 260                                 if (resolved != null)
 261                                         return resolved;
 262
 263                                 NamespaceEntry curr_ns = NamespaceEntry;
 264
 265                                 //
 266                                 // GENERICS: Cope with the expression and not with the string
 267                                 // this will fail with `using A = Stack<int>'
 268                                 //
 269
 270                                 string alias = Alias.GetTypeName (true);
 271                                 while ((curr_ns != null) && (resolved == null)) {
 272                                         resolved = curr_ns.Lookup (
 273                                                 null, alias, Alias.CountTypeArguments,
 274                                                 false, Location);
 275
 276                                         if (resolved == null)
 277                                                 curr_ns = curr_ns.Parent;
 278                                 }
 279
 280                                 if (resolved == null)
 281                                         return null;
 282
 283                                 if (resolved.IsType)
 284                                         resolved = new TypeAliasExpression (
 285                                                 resolved.Type, Alias.TypeArguments, Location);
 286
 287                                 return resolved;
 288                         }
 289                 }
 290
 291                 public NamespaceEntry (NamespaceEntry parent, SourceFile file, string name, Location loc)
 292                         : this (parent, file, name, false, loc)
 293                 { }
 294
 295                 protected NamespaceEntry (NamespaceEntry parent, SourceFile file, string name, bool is_implicit, Location loc)
 296                 {
 297                         this.parent = parent;
 298                         this.file = file;
 299                         this.IsImplicit = is_implicit;
 300                         this.ID = ++next_id;
 301
 302                         if (!is_implicit && (parent != null))
 303                                 ns = parent.NS.GetNamespace (name, true);
 304                         else if (name != null)
 305                                 ns = Namespace.LookupNamespace (name, true);
 306                         else
 307                                 ns = Namespace.Root;
 308                         ns.AddNamespaceEntry (this);
 309
 310                         if ((parent != null) && (parent.NS != ns.Parent))
 311                                 implicit_parent = new NamespaceEntry (parent, file, ns.Parent.Name, true, loc);
 312                         else
 313                                 implicit_parent = parent;
 314
 315                         this.FullName = ns.Name;
 316                 }
 317
 318                 static int next_id = 0;
 319                 public readonly string FullName;
 320                 public readonly int ID;
 321                 public readonly bool IsImplicit;
 322
 323                 public Namespace NS {
 324                         get {
 325                                 return ns;
 326                         }
 327                 }
 328
 329                 public NamespaceEntry Parent {
 330                         get {
 331                                 return parent;
 332                         }
 333                 }
 334
 335                 public NamespaceEntry ImplicitParent {
 336                         get {
 337                                 return implicit_parent;
 338                         }
 339                 }
 340
 341                 public void DefineName (string name, IAlias o)
 342                 {
 343                         ns.DefineName (name, o);
 344                 }
 345
 346                 /// <summary>
 347                 ///   Records a new namespace for resolving name references
 348                 /// </summary>
 349                 public void Using (string ns, Location loc)
 350                 {
 351                         if (DeclarationFound){
 352                                 Report.Error (1529, loc, "A using clause must precede all other namespace elements");
 353                                 return;
 354                         }
 355
 356                         if (ns == FullName)
 357                                 return;
 358
 359                         if (using_clauses == null)
 360                                 using_clauses = new ArrayList ();
 361
 362                         foreach (UsingEntry old_entry in using_clauses){
 363                                 if (old_entry.Name == ns){
 364                                         Report.Warning (105, loc, "The using directive for '" + ns +
 365                                                         "' appeared previously in this namespace");
 366                                         return;
 367                                 }
 368                         }
 369
 370                         UsingEntry ue = new UsingEntry (this, ns, loc);
 371                         using_clauses.Add (ue);
 372                 }
 373
 374                 public void UsingAlias (string name, TypeName alias, Location loc)
 375                 {
 376                         if (aliases == null)
 377                                 aliases = new Hashtable ();
 378
 379                         if (aliases.Contains (name)){
 380                                 Report.Error (1537, loc, "The using alias `" + name +
 381                                               "' appeared previously in this namespace");
 382                                 return;
 383                         }
 384
 385                         aliases [name] = new AliasEntry (this, name, alias, loc);
 386                 }
 387
 388                 protected AliasEntry GetAliasEntry (string alias)
 389                 {
 390                         AliasEntry entry = null;
 391
 392                         if (aliases != null)
 393                                 entry = (AliasEntry) aliases [alias];
 394                         if (entry == null && Parent != null)
 395                                 entry = Parent.GetAliasEntry (alias);
 396
 397                         return entry;
 398                 }
 399
 400                 public IAlias LookupAlias (string alias)
 401                 {
 402                         AliasEntry entry = GetAliasEntry (alias);
 403
 404                         if (entry == null)
 405                                 return null;
 406
 407                         return entry.Resolve ();
 408                 }
 409
 410                 public IAlias Lookup (DeclSpace ds, string name, int num_type_params,
 411                                       bool silent, Location loc)
 412                 {
 413                         IAlias o;
 414                         Namespace ns;
 415
 416                         //
 417                         // If name is of the form `N.I', first lookup `N', then search a member `I' in it.
 418                         //
 419                         int pos = name.IndexOf ('.');
 420                         if (pos >= 0) {
 421                                 string first = name.Substring (0, pos);
 422                                 string last = name.Substring (pos + 1);
 423
 424                                 o = Lookup (ds, first, 0, silent, loc);
 425                                 if (o == null)
 426                                         return null;
 427
 428                                 ns = o as Namespace;
 429                                 if (ns != null) {
 430                                         o = ns.Lookup (ds, last, loc);
 431                                         return o;
 432                                 }
 433
 434                                 Type nested = TypeManager.LookupType (o.Name + "." + last);
 435                                 if ((nested == null) || ((ds != null) && !ds.CheckAccessLevel (nested)))
 436                                         return null;
 437
 438                                 return new TypeExpression (nested, loc);
 439                         }
 440
 441                         //
 442                         // Check whether it's a namespace.
 443                         //
 444                         o = NS.Lookup (ds, name, loc);
 445                         if (o != null)
 446                                 return o;
 447
 448                         //
 449                         // Check aliases.
 450                         //
 451                         AliasEntry entry = GetAliasEntry (name);
 452                         if (entry != null) {
 453                                 IAlias alias = entry.Resolve ();
 454                                 if (alias != null)
 455                                         return alias;
 456                         }
 457
 458                         if (name.IndexOf ('.') > 0)
 459                                 return null;
 460
 461                         //
 462                         // Check using entries.
 463                         //
 464                         IAlias t = null, match = null;
 465                         foreach (Namespace using_ns in GetUsingTable ()) {
 466                                 match = using_ns.Lookup (ds, name, loc);
 467                                 if ((match != null) && match.IsType){
 468                                         if (t != null) {
 469                                                 if (!silent)
 470                                                         DeclSpace.Error_AmbiguousTypeReference (loc, name, t.Name, match.Name);
 471                                                 return null;
 472                                         } else {
 473                                                 t = match;
 474                                         }
 475                                 }
 476                         }
 477
 478                         return t;
 479                 }
 480
 481                 // Our cached computation.
 482                 Namespace [] namespace_using_table;
 483                 public Namespace[] GetUsingTable ()
 484                 {
 485                         if (namespace_using_table != null)
 486                                 return namespace_using_table;
 487
 488                         if (using_clauses == null)
 489                                 return new Namespace [0];
 490
 491                         ArrayList list = new ArrayList (using_clauses.Count);
 492
 493                         foreach (UsingEntry ue in using_clauses) {
 494                                 Namespace using_ns = ue.Resolve ();
 495                                 if (using_ns == null)
 496                                         continue;
 497
 498                                 list.Add (using_ns);
 499                         }
 500
 501                         namespace_using_table = new Namespace [list.Count];
 502                         list.CopyTo (namespace_using_table, 0);
 503                         return namespace_using_table;
 504                 }
 505
 506                 public void DefineNamespace (SymbolWriter symwriter)
 507                 {
 508                         if (symfile_id != 0)
 509                                 return;
 510                         if (parent != null)
 511                                 parent.DefineNamespace (symwriter);
 512
 513                         string[] using_list;
 514                         if (using_clauses != null) {
 515                                 using_list = new string [using_clauses.Count];
 516                                 for (int i = 0; i < using_clauses.Count; i++)
 517                                         using_list [i] = ((UsingEntry) using_clauses [i]).Name;
 518                         } else {
 519                                 using_list = new string [0];
 520                         }
 521
 522                         int parent_id = parent != null ? parent.symfile_id : 0;
 523                         symfile_id = symwriter.DefineNamespace (ns.Name, file, using_list, parent_id);
 524                 }
 525
 526                 public int SymbolFileID {
 527                         get {
 528                                 return symfile_id;
 529                         }
 530                 }
 531
 532                 static void Msgtry (string s)
 533                 {
 534                         Console.WriteLine ("    Try using -r:" + s);
 535                 }
 536
 537                 protected void error246 (Location loc, string name)
 538                 {
 539                         if (TypeManager.LookupType (name) != null)
 540                                 Report.Error (138, loc, "The using keyword only lets you specify a namespace, " +
 541                                               "`" + name + "' is a class not a namespace.");
 542                         else {
 543                                 Report.Error (246, loc, "The namespace `" + name +
 544                                               "' can not be found (missing assembly reference?)");
 545
 546                                 switch (name){
 547                                 case "Gtk": case "GtkSharp":
 548                                         Msgtry ("gtk-sharp");
 549                                         break;
 550
 551                                 case "Gdk": case "GdkSharp":
 552                                         Msgtry ("gdk-sharp");
 553                                         break;
 554
 555                                 case "Glade": case "GladeSharp":
 556                                         Msgtry ("glade-sharp");
 557                                         break;
 558
 559                                 case "System.Drawing":
 560                                         Msgtry ("System.Drawing");
 561                                         break;
 562
 563                                 case "System.Web.Services":
 564                                         Msgtry ("System.Web.Services");
 565                                         break;
 566
 567                                 case "System.Web":
 568                                         Msgtry ("System.Web");
 569                                         break;
 570
 571                                 case "System.Data":
 572                                         Msgtry ("System.Data");
 573                                         break;
 574
 575                                 case "System.Windows.Forms":
 576                                         Msgtry ("System.Windows.Forms");
 577                                         break;
 578                                 }
 579                         }
 580                 }
 581
 582                 /// <summary>
 583                 ///   Used to validate that all the using clauses are correct
 584                 ///   after we are finished parsing all the files.
 585                 /// </summary>
 586                 public void VerifyUsing ()
 587                 {
 588                         TypeContainer dummy = new TypeContainer ();
 589                         EmitContext ec = new EmitContext (
 590                                 dummy, Location.Null, null, null, 0, false);
 591
 592                         if (using_clauses != null){
 593                                 foreach (UsingEntry ue in using_clauses){
 594                                         if (ue.Resolve () != null)
 595                                                 continue;
 596
 597                                         error246 (ue.Location, ue.Name);
 598                                 }
 599                         }
 600
 601                         if (aliases != null){
 602                                 foreach (DictionaryEntry de in aliases){
 603                                         AliasEntry entry = (AliasEntry) de.Value;
 604
 605                                         IAlias alias = entry.Resolve ();
 606                                         if (alias != null) {
 607                                                 if (alias.IsType)
 608                                                         alias.Type.ResolveType (ec);
 609
 610                                                 continue;
 611                                         }
 612
 613                                         error246 (entry.Location, entry.Alias.ToString ());
 614                                 }
 615                         }
 616                 }
 617
 618                 public override string ToString ()
 619                 {
 620                         if (NS == Namespace.Root)
 621                                 return "NamespaceEntry (<root>)";
 622                         else
 623                                 return String.Format ("NamespaceEntry ({0},{1},{2})", FullName, IsImplicit, ID);
 624                 }
 625         }
 626 }