2 // namespace.cs: Tracks namespaces
5 // Miguel de Icaza (miguel@ximian.com)
6 // Marek Safar (marek.safar@seznam.cz)
8 // (C) 2001 Ximian, Inc.
11 using System.Collections;
12 using System.Collections.Specialized;
13 using System.Reflection;
15 namespace Mono.CSharp {
17 public class RootNamespace : Namespace {
18 static MethodInfo get_namespaces_method;
21 Assembly referenced_assembly;
23 Hashtable all_namespaces;
25 static Hashtable root_namespaces;
26 public static GlobalRootNamespace Global;
28 static RootNamespace ()
30 get_namespaces_method = typeof (Assembly).GetMethod ("GetNamespaces", BindingFlags.Instance | BindingFlags.NonPublic);
35 public static void Reset ()
37 root_namespaces = new Hashtable ();
38 Global = new GlobalRootNamespace ();
39 root_namespaces ["global"] = Global;
42 protected RootNamespace (string alias_name, Assembly assembly)
43 : base (null, String.Empty)
45 this.alias_name = alias_name;
46 referenced_assembly = assembly;
48 all_namespaces = new Hashtable ();
49 all_namespaces.Add ("", this);
51 if (referenced_assembly != null)
52 ComputeNamespaces (this.referenced_assembly);
55 public static void DefineRootNamespace (string name, Assembly assembly)
57 if (name == "global") {
58 // FIXME: Add proper error number
59 Report.Error (-42, "Cannot define an external alias named `global'");
62 RootNamespace retval = GetRootNamespace (name);
63 if (retval == null || retval.referenced_assembly != assembly)
64 root_namespaces [name] = new RootNamespace (name, assembly);
67 public static RootNamespace GetRootNamespace (string name)
69 return (RootNamespace) root_namespaces [name];
72 public virtual Type LookupTypeReflection (string name, Location loc)
74 return GetTypeInAssembly (referenced_assembly, name);
77 public void RegisterNamespace (Namespace child)
80 all_namespaces.Add (child.Name, child);
83 public bool IsNamespace (string name)
85 return all_namespaces.Contains (name);
88 protected void EnsureNamespace (string dotted_name)
90 if (dotted_name != null && dotted_name.Length != 0 && ! IsNamespace (dotted_name))
91 GetNamespace (dotted_name, true);
94 protected void ComputeNamespaces (Assembly assembly)
96 if (get_namespaces_method != null) {
97 string [] namespaces = (string []) get_namespaces_method.Invoke (assembly, null);
98 foreach (string ns in namespaces)
103 foreach (Type t in assembly.GetExportedTypes ())
104 EnsureNamespace (t.Namespace);
107 protected static Type GetTypeInAssembly (Assembly assembly, string name)
109 Type t = assembly.GetType (name);
114 throw new InternalErrorException ("Use GetPointerType() to get a pointer");
116 TypeAttributes ta = t.Attributes & TypeAttributes.VisibilityMask;
117 if (ta == TypeAttributes.NestedPrivate)
120 if (ta == TypeAttributes.NotPublic ||
121 ta == TypeAttributes.NestedAssembly ||
122 ta == TypeAttributes.NestedFamANDAssem)
123 if (!TypeManager.IsFriendAssembly (t.Assembly))
129 public override string ToString ()
131 return String.Format ("RootNamespace ({0}::)", alias_name);
134 public override string GetSignatureForError ()
136 return alias_name + "::";
140 public class GlobalRootNamespace : RootNamespace {
141 Assembly [] assemblies;
144 public GlobalRootNamespace ()
145 : base ("global", null)
147 assemblies = new Assembly [0];
150 public Assembly [] Assemblies {
151 get { return assemblies; }
154 public Module [] Modules {
155 get { return modules; }
158 public void AddAssemblyReference (Assembly a)
160 foreach (Assembly assembly in assemblies) {
165 int top = assemblies.Length;
166 Assembly [] n = new Assembly [top + 1];
167 assemblies.CopyTo (n, 0);
171 ComputeNamespaces (a);
174 public void AddModuleReference (Module m)
176 int top = modules != null ? modules.Length : 0;
177 Module [] n = new Module [top + 1];
179 modules.CopyTo (n, 0);
183 if (m == CodeGen.Module.Builder)
186 foreach (Type t in m.GetTypes ())
187 EnsureNamespace (t.Namespace);
190 public override void Error_NamespaceDoesNotExist(Location loc, string name)
192 Report.Error (400, loc, "The type or namespace name `{0}' could not be found in the global namespace (are you missing an assembly reference?)",
196 public override Type LookupTypeReflection (string name, Location loc)
198 Type found_type = null;
200 foreach (Assembly a in assemblies) {
201 Type t = GetTypeInAssembly (a, name);
205 if (found_type == null) {
210 Report.SymbolRelatedToPreviousError (found_type);
211 Report.SymbolRelatedToPreviousError (t);
212 Report.Error (433, loc, "The imported type `{0}' is defined multiple times", name);
217 if (modules != null) {
218 foreach (Module module in modules) {
219 Type t = module.GetType (name);
223 if (found_type == null) {
228 Report.SymbolRelatedToPreviousError (t);
229 Report.SymbolRelatedToPreviousError (found_type);
230 Report.Warning (436, 2, loc, "Ignoring imported type `{0}' since the current assembly already has a declaration with the same name",
231 TypeManager.CSharpName (t));
241 /// Keeps track of the namespaces defined in the C# code.
243 /// This is an Expression to allow it to be referenced in the
244 /// compiler parse/intermediate tree during name resolution.
246 public class Namespace : FullNamedExpression {
250 Hashtable namespaces;
251 IDictionary declspaces;
252 Hashtable cached_types;
255 public readonly MemberName MemberName;
258 /// Constructor Takes the current namespace and the
259 /// name. This is bootstrapped with parent == null
262 public Namespace (Namespace parent, string name)
264 // Expression members.
265 this.eclass = ExprClass.Namespace;
267 this.loc = Location.Null;
269 this.parent = parent;
272 this.root = parent.root;
274 this.root = this as RootNamespace;
276 if (this.root == null)
277 throw new InternalErrorException ("Root namespaces must be created using RootNamespace");
279 string pname = parent != null ? parent.Name : "";
284 fullname = parent.Name + "." + name;
286 if (fullname == null)
287 throw new InternalErrorException ("Namespace has a null fullname");
289 if (parent != null && parent.MemberName != MemberName.Null)
290 MemberName = new MemberName (parent.MemberName, name, parent.MemberName.Location);
291 else if (name.Length == 0)
292 MemberName = MemberName.Null;
294 MemberName = new MemberName (name, Location.Null);
296 namespaces = new Hashtable ();
297 cached_types = new Hashtable ();
299 root.RegisterNamespace (this);
302 public override Expression DoResolve (EmitContext ec)
307 public virtual void Error_NamespaceDoesNotExist (Location loc, string name)
309 Report.Error (234, loc, "The type or namespace name `{0}' does not exist in the namespace `{1}'. Are you missing an assembly reference?",
313 public override void Emit (EmitContext ec)
315 throw new InternalErrorException ("Expression tree referenced namespace " + fullname + " during Emit ()");
318 public override string GetSignatureForError ()
323 public Namespace GetNamespace (string name, bool create)
325 int pos = name.IndexOf ('.');
330 first = name.Substring (0, pos);
334 ns = (Namespace) namespaces [first];
339 ns = new Namespace (this, first);
340 namespaces.Add (first, ns);
344 ns = ns.GetNamespace (name.Substring (pos + 1), create);
349 TypeExpr LookupType (string name, Location loc)
351 if (cached_types.Contains (name))
352 return cached_types [name] as TypeExpr;
355 if (declspaces != null) {
356 DeclSpace tdecl = declspaces [name] as DeclSpace;
359 // Note that this is not:
361 // t = tdecl.DefineType ()
363 // This is to make it somewhat more useful when a DefineType
364 // fails due to problems in nested types (more useful in the sense
365 // of fewer misleading error messages)
368 t = tdecl.TypeBuilder;
371 string lookup = t != null ? t.FullName : (fullname.Length == 0 ? name : fullname + "." + name);
372 Type rt = root.LookupTypeReflection (lookup, loc);
376 TypeExpr te = t == null ? null : new TypeExpression (t, Location.Null);
377 cached_types [name] = te;
381 public FullNamedExpression Lookup (DeclSpace ds, string name, Location loc)
383 if (namespaces.Contains (name))
384 return (Namespace) namespaces [name];
386 TypeExpr te = LookupType (name, loc);
387 if (te == null || !ds.CheckAccessLevel (te.Type))
393 public void AddDeclSpace (string name, DeclSpace ds)
395 if (declspaces == null)
396 declspaces = new HybridDictionary ();
397 declspaces.Add (name, ds);
401 /// The qualified name of the current namespace
404 get { return fullname; }
407 public override string FullName {
408 get { return fullname; }
412 /// The parent of this namespace, used by the parser to "Pop"
413 /// the current namespace declaration
415 public Namespace Parent {
416 get { return parent; }
419 public override string ToString ()
421 return String.Format ("Namespace ({0})", Name);
425 public class NamespaceEntry {
427 NamespaceEntry parent, implicit_parent;
431 ArrayList using_clauses;
432 public bool DeclarationFound = false;
435 public readonly DeclSpace SlaveDeclSpace;
437 ListDictionary extern_aliases;
439 static ArrayList entries = new ArrayList ();
441 public static void Reset ()
443 entries = new ArrayList ();
447 // This class holds the location where a using definition is
448 // done, and whether it has been used by the program or not.
450 // We use this to flag using clauses for namespaces that do not
453 public class UsingEntry : IResolveContext {
454 public readonly MemberName Name;
455 readonly Expression Expr;
456 readonly NamespaceEntry NamespaceEntry;
457 readonly Location Location;
459 public UsingEntry (NamespaceEntry entry, MemberName name, Location loc)
462 Expr = name.GetTypeExpression ();
463 NamespaceEntry = entry;
467 internal Namespace resolved;
469 public Namespace Resolve ()
471 if (resolved != null)
474 FullNamedExpression fne = Expr.ResolveAsTypeStep (this, false);
476 Error_NamespaceNotFound (Location, Name.ToString ());
480 resolved = fne as Namespace;
481 if (resolved == null) {
482 Report.Error (138, Location,
483 "`{0} is a type not a namespace. A using namespace directive can only be applied to namespaces", Name.ToString ());
488 DeclSpace IResolveContext.DeclContainer {
489 get { return NamespaceEntry.SlaveDeclSpace; }
491 DeclSpace IResolveContext.GenericDeclContainer {
492 get { return NamespaceEntry.SlaveDeclSpace; }
494 bool IResolveContext.IsInObsoleteScope {
495 get { return false; }
497 bool IResolveContext.IsInUnsafeScope {
498 get { return false; }
502 public abstract class AliasEntry {
503 public readonly string Name;
504 public readonly NamespaceEntry NamespaceEntry;
505 public readonly Location Location;
507 protected AliasEntry (NamespaceEntry entry, string name, Location loc)
510 NamespaceEntry = entry;
514 protected FullNamedExpression resolved;
517 public FullNamedExpression Resolve ()
519 if (resolved != null || error)
521 resolved = DoResolve ();
522 if (resolved == null)
527 protected abstract FullNamedExpression DoResolve ();
530 public class LocalAliasEntry : AliasEntry, IResolveContext {
531 public readonly Expression Alias;
533 public LocalAliasEntry (NamespaceEntry entry, string name, MemberName alias, Location loc) :
534 base (entry, name, loc)
536 Alias = alias.GetTypeExpression ();
539 protected override FullNamedExpression DoResolve ()
541 resolved = Alias.ResolveAsTypeStep (this, false);
542 if (resolved == null)
545 if (resolved.Type != null) {
546 TypeAttributes attr = resolved.Type.Attributes & TypeAttributes.VisibilityMask;
547 if (attr == TypeAttributes.NestedPrivate || attr == TypeAttributes.NestedFamily ||
548 ((attr == TypeAttributes.NestedFamORAssem || attr == TypeAttributes.NestedAssembly) &&
549 TypeManager.LookupDeclSpace (resolved.Type) == null)) {
550 Expression.ErrorIsInaccesible (Alias.Location, Alias.ToString ());
558 DeclSpace IResolveContext.DeclContainer {
559 get { return NamespaceEntry.SlaveDeclSpace; }
561 DeclSpace IResolveContext.GenericDeclContainer {
562 get { return NamespaceEntry.SlaveDeclSpace; }
564 bool IResolveContext.IsInObsoleteScope {
565 get { return false; }
567 bool IResolveContext.IsInUnsafeScope {
568 get { return false; }
572 public class ExternAliasEntry : AliasEntry {
573 public ExternAliasEntry (NamespaceEntry entry, string name, Location loc) :
574 base (entry, name, loc)
578 protected override FullNamedExpression DoResolve ()
580 resolved = RootNamespace.GetRootNamespace (Name);
581 if (resolved == null)
582 Report.Error (430, Location, "The extern alias '" + Name +
583 "' was not specified in a /reference option");
589 public NamespaceEntry (NamespaceEntry parent, SourceFile file, string name)
591 this.parent = parent;
594 this.ID = entries.Count;
597 ns = parent.NS.GetNamespace (name, true);
598 else if (name != null)
599 ns = RootNamespace.Global.GetNamespace (name, true);
601 ns = RootNamespace.Global;
602 SlaveDeclSpace = new RootDeclSpace (this);
605 private NamespaceEntry (NamespaceEntry parent, SourceFile file, Namespace ns, bool slave)
607 this.parent = parent;
609 // no need to add self to 'entries', since we don't have any aliases or using entries.
611 this.IsImplicit = true;
613 this.SlaveDeclSpace = slave ? new RootDeclSpace (this) : null;
617 // According to section 16.3.1 (using-alias-directive), the namespace-or-type-name is
618 // resolved as if the immediately containing namespace body has no using-directives.
620 // Section 16.3.2 says that the same rule is applied when resolving the namespace-name
621 // in the using-namespace-directive.
623 // To implement these rules, the expressions in the using directives are resolved using
624 // the "doppelganger" (ghostly bodiless duplicate).
626 NamespaceEntry doppelganger;
627 NamespaceEntry Doppelganger {
629 if (!IsImplicit && doppelganger == null)
630 doppelganger = new NamespaceEntry (ImplicitParent, file, ns, true);
635 public readonly int ID;
636 public readonly bool IsImplicit;
638 public Namespace NS {
642 public NamespaceEntry Parent {
643 get { return parent; }
646 public NamespaceEntry ImplicitParent {
650 if (implicit_parent == null) {
651 implicit_parent = (parent.NS == ns.Parent)
653 : new NamespaceEntry (parent, file, ns.Parent, false);
655 return implicit_parent;
660 /// Records a new namespace for resolving name references
662 public void Using (MemberName name, Location loc)
664 if (DeclarationFound){
665 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
671 if (name.Equals (ns.MemberName))
674 if (using_clauses == null)
675 using_clauses = new ArrayList ();
677 foreach (UsingEntry old_entry in using_clauses) {
678 if (name.Equals (old_entry.Name)) {
679 Report.Warning (105, 3, loc, "The using directive for `{0}' appeared previously in this namespace", name.GetName ());
684 UsingEntry ue = new UsingEntry (Doppelganger, name, loc);
685 using_clauses.Add (ue);
688 public void UsingAlias (string name, MemberName alias, Location loc)
690 if (DeclarationFound){
691 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
698 aliases = new Hashtable ();
700 if (aliases.Contains (name)) {
701 AliasEntry ae = (AliasEntry) aliases [name];
702 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
703 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
707 if (RootContext.Version == LanguageVersion.Default &&
708 name == "global" && RootContext.WarningLevel >= 2)
709 Report.Warning (440, 2, loc, "An alias named `global' will not be used when resolving 'global::';" +
710 " the global namespace will be used instead");
712 // FIXME: get correct error number. See if the above check can be merged
713 if (extern_aliases != null && extern_aliases.Contains (name)) {
714 AliasEntry ae = (AliasEntry) extern_aliases [name];
715 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
716 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
720 aliases [name] = new LocalAliasEntry (Doppelganger, name, alias, loc);
723 public void UsingExternalAlias (string name, Location loc)
725 if (UsingFound || DeclarationFound) {
726 Report.Error (439, loc, "An extern alias declaration must precede all other elements");
730 // Share the extern_aliases field with the Doppelganger
731 if (extern_aliases == null) {
732 extern_aliases = new ListDictionary ();
733 Doppelganger.extern_aliases = extern_aliases;
736 if (extern_aliases.Contains (name)) {
737 AliasEntry ae = (AliasEntry) extern_aliases [name];
738 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
739 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
743 if (name == "global") {
744 Report.Error (1681, loc, "You cannot redefine the global extern alias");
748 // Register the alias in aliases and extern_aliases, since we need both of them
749 // to keep things simple (different resolution scenarios)
750 ExternAliasEntry alias = new ExternAliasEntry (Doppelganger, name, loc);
751 extern_aliases [name] = alias;
754 public FullNamedExpression LookupNamespaceOrType (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
756 // Precondition: Only simple names (no dots) will be looked up with this function.
757 FullNamedExpression resolved = null;
758 for (NamespaceEntry curr_ns = this; curr_ns != null; curr_ns = curr_ns.ImplicitParent) {
759 if ((resolved = curr_ns.Lookup (ds, name, loc, ignore_cs0104)) != null)
765 static void Error_AmbiguousTypeReference (Location loc, string name, FullNamedExpression t1, FullNamedExpression t2)
767 Report.Error (104, loc, "`{0}' is an ambiguous reference between `{1}' and `{2}'",
768 name, t1.FullName, t2.FullName);
771 // Looks-up a alias named @name in this and surrounding namespace declarations
772 public FullNamedExpression LookupAlias (string name)
774 AliasEntry entry = null;
775 for (NamespaceEntry n = this; n != null; n = n.ImplicitParent) {
776 if (n.extern_aliases != null && (entry = n.extern_aliases [name] as AliasEntry) != null)
778 if (n.aliases != null && (entry = n.aliases [name] as AliasEntry) != null)
781 return entry == null ? null : entry.Resolve ();
784 private FullNamedExpression Lookup (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
787 // Check whether it's in the namespace.
789 FullNamedExpression fne = NS.Lookup (ds, name, loc);
793 if (extern_aliases != null) {
794 AliasEntry entry = extern_aliases [name] as AliasEntry;
796 return entry.Resolve ();
805 if (aliases != null) {
806 AliasEntry entry = aliases [name] as AliasEntry;
808 return entry.Resolve ();
812 // Check using entries.
814 FullNamedExpression match = null;
815 foreach (Namespace using_ns in GetUsingTable ()) {
816 match = using_ns.Lookup (ds, name, loc);
817 if (match == null || !(match is TypeExpr))
821 Error_AmbiguousTypeReference (loc, name, fne, match);
830 // Our cached computation.
831 readonly Namespace [] empty_namespaces = new Namespace [0];
832 Namespace [] namespace_using_table;
833 Namespace [] GetUsingTable ()
835 if (namespace_using_table != null)
836 return namespace_using_table;
838 if (using_clauses == null) {
839 namespace_using_table = empty_namespaces;
840 return namespace_using_table;
843 ArrayList list = new ArrayList (using_clauses.Count);
845 foreach (UsingEntry ue in using_clauses) {
846 Namespace using_ns = ue.Resolve ();
847 if (using_ns == null)
853 namespace_using_table = new Namespace [list.Count];
854 list.CopyTo (namespace_using_table, 0);
855 return namespace_using_table;
858 readonly string [] empty_using_list = new string [0];
860 public int SymbolFileID {
862 if (symfile_id == 0 && file.SourceFileEntry != null) {
863 int parent_id = parent == null ? 0 : parent.SymbolFileID;
865 string [] using_list = empty_using_list;
866 if (using_clauses != null) {
867 using_list = new string [using_clauses.Count];
868 for (int i = 0; i < using_clauses.Count; i++)
869 using_list [i] = ((UsingEntry) using_clauses [i]).Name.ToString ();
872 symfile_id = CodeGen.SymbolWriter.DefineNamespace (ns.Name, file.SourceFileEntry, using_list, parent_id);
878 static void MsgtryRef (string s)
880 Console.WriteLine (" Try using -r:" + s);
883 static void MsgtryPkg (string s)
885 Console.WriteLine (" Try using -pkg:" + s);
888 public static void Error_NamespaceNotFound (Location loc, string name)
890 Report.Error (246, loc, "The type or namespace name `{0}' could not be found. Are you missing a using directive or an assembly reference?",
894 case "Gtk": case "GtkSharp":
895 MsgtryPkg ("gtk-sharp");
898 case "Gdk": case "GdkSharp":
899 MsgtryPkg ("gdk-sharp");
902 case "Glade": case "GladeSharp":
903 MsgtryPkg ("glade-sharp");
906 case "System.Drawing":
907 case "System.Web.Services":
910 case "System.Windows.Forms":
917 /// Used to validate that all the using clauses are correct
918 /// after we are finished parsing all the files.
922 if (extern_aliases != null) {
923 foreach (DictionaryEntry de in extern_aliases)
924 ((AliasEntry) de.Value).Resolve ();
927 if (using_clauses != null) {
928 foreach (UsingEntry ue in using_clauses)
932 if (aliases != null) {
933 foreach (DictionaryEntry de in aliases)
934 ((AliasEntry) de.Value).Resolve ();
939 /// Used to validate that all the using clauses are correct
940 /// after we are finished parsing all the files.
942 static public void VerifyAllUsing ()
944 foreach (NamespaceEntry entry in entries)
945 entry.VerifyUsing ();
948 public string GetSignatureForError ()
950 return ns.GetSignatureForError ();
953 public override string ToString ()
955 return ns.ToString ();