2 // namespace.cs: Tracks namespaces
5 // Miguel de Icaza (miguel@ximian.com)
7 // (C) 2001 Ximian, Inc.
10 using System.Collections;
11 using System.Collections.Specialized;
12 using System.Reflection;
14 namespace Mono.CSharp {
16 public class RootNamespace : Namespace {
17 static MethodInfo get_namespaces_method;
20 Assembly referenced_assembly;
22 Hashtable all_namespaces;
24 static Hashtable root_namespaces;
25 public static GlobalRootNamespace Global;
27 static RootNamespace ()
29 get_namespaces_method = typeof (Assembly).GetMethod ("GetNamespaces", BindingFlags.Instance | BindingFlags.NonPublic);
34 public static void Reset ()
36 root_namespaces = new Hashtable ();
37 Global = new GlobalRootNamespace ();
38 root_namespaces ["global"] = Global;
41 protected RootNamespace (string alias_name, Assembly assembly)
42 : base (null, String.Empty)
44 this.alias_name = alias_name;
45 referenced_assembly = assembly;
47 all_namespaces = new Hashtable ();
48 all_namespaces.Add ("", this);
50 if (referenced_assembly != null)
51 ComputeNamespaces (this.referenced_assembly);
54 public static void DefineRootNamespace (string name, Assembly assembly)
56 if (name == "global") {
57 // FIXME: Add proper error number
58 Report.Error (-42, "Cannot define an external alias named `global'");
61 RootNamespace retval = GetRootNamespace (name);
62 if (retval == null || retval.referenced_assembly != assembly)
63 root_namespaces [name] = new RootNamespace (name, assembly);
66 public static RootNamespace GetRootNamespace (string name)
68 return (RootNamespace) root_namespaces [name];
71 public virtual Type LookupTypeReflection (string name, Location loc)
73 return GetTypeInAssembly (referenced_assembly, name);
76 public void RegisterNamespace (Namespace child)
79 all_namespaces.Add (child.Name, child);
82 public bool IsNamespace (string name)
84 return all_namespaces.Contains (name);
87 protected void EnsureNamespace (string dotted_name)
89 if (dotted_name != null && dotted_name.Length != 0 && ! IsNamespace (dotted_name))
90 GetNamespace (dotted_name, true);
93 protected void ComputeNamespaces (Assembly assembly)
95 if (get_namespaces_method != null) {
96 string [] namespaces = (string []) get_namespaces_method.Invoke (assembly, null);
97 foreach (string ns in namespaces)
102 foreach (Type t in assembly.GetExportedTypes ())
103 EnsureNamespace (t.Namespace);
106 protected static Type GetTypeInAssembly (Assembly assembly, string name)
108 Type t = assembly.GetType (name);
113 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 Type LookupTypeReflection (string name, Location loc)
192 Type found_type = null;
194 foreach (Assembly a in assemblies) {
195 Type t = GetTypeInAssembly (a, name);
199 if (found_type == null) {
204 Report.SymbolRelatedToPreviousError (found_type);
205 Report.SymbolRelatedToPreviousError (t);
206 Report.Error (433, loc, "The imported type `{0}' is defined multiple times", name);
211 if (modules != null) {
212 foreach (Module module in modules) {
213 Type t = module.GetType (name);
217 if (found_type == null) {
222 Report.SymbolRelatedToPreviousError (t);
223 Report.SymbolRelatedToPreviousError (found_type);
224 Report.Warning (436, 2, loc, "Ignoring imported type `{0}' since the current assembly already has a declaration with the same name",
225 TypeManager.CSharpName (t));
235 /// Keeps track of the namespaces defined in the C# code.
237 /// This is an Expression to allow it to be referenced in the
238 /// compiler parse/intermediate tree during name resolution.
240 public class Namespace : FullNamedExpression {
244 Hashtable namespaces;
245 IDictionary declspaces;
246 Hashtable cached_types;
249 public readonly MemberName MemberName;
252 /// Constructor Takes the current namespace and the
253 /// name. This is bootstrapped with parent == null
256 public Namespace (Namespace parent, string name)
258 // Expression members.
259 this.eclass = ExprClass.Namespace;
261 this.loc = Location.Null;
263 this.parent = parent;
266 this.root = parent.root;
268 this.root = this as RootNamespace;
270 if (this.root == null)
271 throw new InternalErrorException ("Root namespaces must be created using RootNamespace");
273 string pname = parent != null ? parent.Name : "";
278 fullname = parent.Name + "." + name;
280 if (fullname == null)
281 throw new InternalErrorException ("Namespace has a null fullname");
283 if (parent != null && parent.MemberName != MemberName.Null)
284 MemberName = new MemberName (parent.MemberName, name, parent.MemberName.Location);
285 else if (name.Length == 0)
286 MemberName = MemberName.Null;
288 MemberName = new MemberName (name, Location.Null);
290 namespaces = new Hashtable ();
291 cached_types = new Hashtable ();
293 root.RegisterNamespace (this);
296 public override Expression DoResolve (EmitContext ec)
301 public override void Emit (EmitContext ec)
303 throw new InternalErrorException ("Expression tree referenced namespace " + fullname + " during Emit ()");
306 public override string GetSignatureForError ()
311 public Namespace GetNamespace (string name, bool create)
313 int pos = name.IndexOf ('.');
318 first = name.Substring (0, pos);
322 ns = (Namespace) namespaces [first];
327 ns = new Namespace (this, first);
328 namespaces.Add (first, ns);
332 ns = ns.GetNamespace (name.Substring (pos + 1), create);
337 TypeExpr LookupType (string name, Location loc)
339 if (cached_types.Contains (name))
340 return cached_types [name] as TypeExpr;
343 if (declspaces != null) {
344 DeclSpace tdecl = declspaces [name] as DeclSpace;
347 // Note that this is not:
349 // t = tdecl.DefineType ()
351 // This is to make it somewhat more useful when a DefineType
352 // fails due to problems in nested types (more useful in the sense
353 // of fewer misleading error messages)
356 t = tdecl.TypeBuilder;
359 string lookup = t != null ? t.FullName : (fullname.Length == 0 ? name : fullname + "." + name);
360 Type rt = root.LookupTypeReflection (lookup, loc);
364 TypeExpr te = t == null ? null : new TypeExpression (t, Location.Null);
365 cached_types [name] = te;
369 public FullNamedExpression Lookup (DeclSpace ds, string name, Location loc)
371 if (namespaces.Contains (name))
372 return (Namespace) namespaces [name];
374 TypeExpr te = LookupType (name, loc);
375 if (te == null || !ds.CheckAccessLevel (te.Type))
381 public void AddDeclSpace (string name, DeclSpace ds)
383 if (declspaces == null)
384 declspaces = new HybridDictionary ();
385 declspaces.Add (name, ds);
389 /// The qualified name of the current namespace
392 get { return fullname; }
395 public override string FullName {
396 get { return fullname; }
400 /// The parent of this namespace, used by the parser to "Pop"
401 /// the current namespace declaration
403 public Namespace Parent {
404 get { return parent; }
407 public override string ToString ()
409 return String.Format ("Namespace ({0})", Name);
413 public class NamespaceEntry {
415 NamespaceEntry parent, implicit_parent;
419 ArrayList using_clauses;
420 public bool DeclarationFound = false;
423 ListDictionary extern_aliases;
425 static ArrayList entries = new ArrayList ();
427 public static void Reset ()
429 entries = new ArrayList ();
433 // This class holds the location where a using definition is
434 // done, and whether it has been used by the program or not.
436 // We use this to flag using clauses for namespaces that do not
439 public class UsingEntry {
440 public readonly MemberName Name;
441 readonly Expression Expr;
442 readonly NamespaceEntry NamespaceEntry;
443 readonly Location Location;
445 public UsingEntry (NamespaceEntry entry, MemberName name, Location loc)
448 Expr = name.GetTypeExpression ();
449 NamespaceEntry = entry;
453 internal Namespace resolved;
455 public Namespace Resolve ()
457 if (resolved != null)
460 DeclSpace root = RootContext.Tree.Types;
461 root.NamespaceEntry = NamespaceEntry;
462 FullNamedExpression fne = Expr.ResolveAsTypeStep (root, false);
463 root.NamespaceEntry = null;
466 Error_NamespaceNotFound (Location, Name.ToString ());
470 resolved = fne as Namespace;
471 if (resolved == null) {
472 Report.Error (138, Location,
473 "`{0} is a type not a namespace. A using namespace directive can only be applied to namespaces", Name.ToString ());
479 public abstract class AliasEntry {
480 public readonly string Name;
481 public readonly NamespaceEntry NamespaceEntry;
482 public readonly Location Location;
484 protected AliasEntry (NamespaceEntry entry, string name, Location loc)
487 NamespaceEntry = entry;
491 protected FullNamedExpression resolved;
494 public FullNamedExpression Resolve ()
496 if (resolved != null || error)
498 resolved = DoResolve ();
499 if (resolved == null)
504 protected abstract FullNamedExpression DoResolve ();
507 public class LocalAliasEntry : AliasEntry
509 public readonly Expression Alias;
511 public LocalAliasEntry (NamespaceEntry entry, string name, MemberName alias, Location loc) :
512 base (entry, name, loc)
514 Alias = alias.GetTypeExpression ();
517 protected override FullNamedExpression DoResolve ()
519 DeclSpace root = RootContext.Tree.Types;
520 root.NamespaceEntry = NamespaceEntry;
521 resolved = Alias.ResolveAsTypeStep (root, false);
522 root.NamespaceEntry = null;
524 if (resolved == null)
525 Error_NamespaceNotFound (Location, Alias.ToString ());
530 public class ExternAliasEntry : AliasEntry
532 public ExternAliasEntry (NamespaceEntry entry, string name, Location loc) :
533 base (entry, name, loc)
537 protected override FullNamedExpression DoResolve ()
539 resolved = RootNamespace.GetRootNamespace (Name);
540 if (resolved == null)
541 Report.Error (430, Location, "The extern alias '" + Name +
542 "' was not specified in a /reference option");
548 public NamespaceEntry (NamespaceEntry parent, SourceFile file, string name)
550 this.parent = parent;
553 this.ID = entries.Count;
556 ns = parent.NS.GetNamespace (name, true);
557 else if (name != null)
558 ns = RootNamespace.Global.GetNamespace (name, true);
560 ns = RootNamespace.Global;
563 private NamespaceEntry (NamespaceEntry parent, SourceFile file, Namespace ns)
565 this.parent = parent;
567 // no need to add self to 'entries', since we don't have any aliases or using entries.
569 this.IsImplicit = true;
574 // According to section 16.3.1 (using-alias-directive), the namespace-or-type-name is
575 // resolved as if the immediately containing namespace body has no using-directives.
577 // Section 16.3.2 says that the same rule is applied when resolving the namespace-name
578 // in the using-namespace-directive.
580 // To implement these rules, the expressions in the using directives are resolved using
581 // the "doppelganger" (ghostly bodiless duplicate).
583 NamespaceEntry doppelganger;
584 NamespaceEntry Doppelganger {
586 if (!IsImplicit && doppelganger == null)
587 doppelganger = new NamespaceEntry (ImplicitParent, file, ns);
592 public readonly int ID;
593 public readonly bool IsImplicit;
595 public Namespace NS {
599 public NamespaceEntry Parent {
600 get { return parent; }
603 public NamespaceEntry ImplicitParent {
607 if (implicit_parent == null) {
608 implicit_parent = (parent.NS == ns.Parent)
610 : new NamespaceEntry (parent, file, ns.Parent);
612 return implicit_parent;
617 /// Records a new namespace for resolving name references
619 public void Using (MemberName name, Location loc)
621 if (DeclarationFound){
622 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
628 if (name.Equals (ns.MemberName))
631 if (using_clauses == null)
632 using_clauses = new ArrayList ();
634 foreach (UsingEntry old_entry in using_clauses) {
635 if (name.Equals (old_entry.Name)) {
636 Report.Warning (105, 3, loc, "The using directive for `{0}' appeared previously in this namespace", name.GetName ());
641 UsingEntry ue = new UsingEntry (Doppelganger, name, loc);
642 using_clauses.Add (ue);
645 public void UsingAlias (string name, MemberName alias, Location loc)
647 if (DeclarationFound){
648 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
655 aliases = new Hashtable ();
657 if (aliases.Contains (name)) {
658 AliasEntry ae = (AliasEntry) aliases [name];
659 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
660 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
664 if (RootContext.Version == LanguageVersion.Default &&
665 name == "global" && RootContext.WarningLevel >= 2)
666 Report.Warning (440, 2, loc, "An alias named `global' will not be used when resolving 'global::';" +
667 " the global namespace will be used instead");
669 // FIXME: get correct error number. See if the above check can be merged
670 if (extern_aliases != null && extern_aliases.Contains (name)) {
671 AliasEntry ae = (AliasEntry) extern_aliases [name];
672 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
673 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
677 aliases [name] = new LocalAliasEntry (Doppelganger, name, alias, loc);
680 public void UsingExternalAlias (string name, Location loc)
682 if (UsingFound || DeclarationFound) {
683 Report.Error (439, loc, "An extern alias declaration must precede all other elements");
687 // Share the extern_aliases field with the Doppelganger
688 if (extern_aliases == null) {
689 extern_aliases = new ListDictionary ();
690 Doppelganger.extern_aliases = extern_aliases;
693 if (extern_aliases.Contains (name)) {
694 AliasEntry ae = (AliasEntry) extern_aliases [name];
695 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
696 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
700 if (name == "global") {
701 Report.Error (1681, loc, "You cannot redefine the global extern alias");
705 // Register the alias in aliases and extern_aliases, since we need both of them
706 // to keep things simple (different resolution scenarios)
707 ExternAliasEntry alias = new ExternAliasEntry (Doppelganger, name, loc);
708 extern_aliases [name] = alias;
711 public FullNamedExpression LookupNamespaceOrType (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
713 // Precondition: Only simple names (no dots) will be looked up with this function.
714 FullNamedExpression resolved = null;
715 for (NamespaceEntry curr_ns = this; curr_ns != null; curr_ns = curr_ns.ImplicitParent) {
716 if ((resolved = curr_ns.Lookup (ds, name, loc, ignore_cs0104)) != null)
722 static void Error_AmbiguousTypeReference (Location loc, string name, FullNamedExpression t1, FullNamedExpression t2)
724 Report.Error (104, loc, "`{0}' is an ambiguous reference between `{1}' and `{2}'",
725 name, t1.FullName, t2.FullName);
728 // Looks-up a alias named @name in this and surrounding namespace declarations
729 public FullNamedExpression LookupAlias (string name)
731 AliasEntry entry = null;
732 for (NamespaceEntry n = this; n != null; n = n.ImplicitParent) {
733 if (n.extern_aliases != null && (entry = n.extern_aliases [name] as AliasEntry) != null)
735 if (n.aliases != null && (entry = n.aliases [name] as AliasEntry) != null)
738 return entry == null ? null : entry.Resolve ();
741 private FullNamedExpression Lookup (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
744 // Check whether it's in the namespace.
746 FullNamedExpression fne = NS.Lookup (ds, name, loc);
750 if (extern_aliases != null) {
751 AliasEntry entry = extern_aliases [name] as AliasEntry;
753 return entry.Resolve ();
762 if (aliases != null) {
763 AliasEntry entry = aliases [name] as AliasEntry;
765 return entry.Resolve ();
769 // Check using entries.
771 FullNamedExpression match = null;
772 foreach (Namespace using_ns in GetUsingTable ()) {
773 match = using_ns.Lookup (ds, name, loc);
774 if (match == null || !(match is TypeExpr))
778 Error_AmbiguousTypeReference (loc, name, fne, match);
787 // Our cached computation.
788 readonly Namespace [] empty_namespaces = new Namespace [0];
789 Namespace [] namespace_using_table;
790 Namespace [] GetUsingTable ()
792 if (namespace_using_table != null)
793 return namespace_using_table;
795 if (using_clauses == null) {
796 namespace_using_table = empty_namespaces;
797 return namespace_using_table;
800 ArrayList list = new ArrayList (using_clauses.Count);
802 foreach (UsingEntry ue in using_clauses) {
803 Namespace using_ns = ue.Resolve ();
804 if (using_ns == null)
810 namespace_using_table = new Namespace [list.Count];
811 list.CopyTo (namespace_using_table, 0);
812 return namespace_using_table;
815 readonly string [] empty_using_list = new string [0];
817 public int SymbolFileID {
819 if (symfile_id == 0 && file.SourceFileEntry != null) {
820 int parent_id = parent == null ? 0 : parent.SymbolFileID;
822 string [] using_list = empty_using_list;
823 if (using_clauses != null) {
824 using_list = new string [using_clauses.Count];
825 for (int i = 0; i < using_clauses.Count; i++)
826 using_list [i] = ((UsingEntry) using_clauses [i]).Name.ToString ();
829 symfile_id = CodeGen.SymbolWriter.DefineNamespace (ns.Name, file.SourceFileEntry, using_list, parent_id);
835 static void MsgtryRef (string s)
837 Console.WriteLine (" Try using -r:" + s);
840 static void MsgtryPkg (string s)
842 Console.WriteLine (" Try using -pkg:" + s);
845 public static void Error_NamespaceNotFound (Location loc, string name)
847 Report.Error (246, loc, "The type or namespace name `{0}' could not be found. Are you missing a using directive or an assembly reference?",
851 case "Gtk": case "GtkSharp":
852 MsgtryPkg ("gtk-sharp");
855 case "Gdk": case "GdkSharp":
856 MsgtryPkg ("gdk-sharp");
859 case "Glade": case "GladeSharp":
860 MsgtryPkg ("glade-sharp");
863 case "System.Drawing":
864 case "System.Web.Services":
867 case "System.Windows.Forms":
874 /// Used to validate that all the using clauses are correct
875 /// after we are finished parsing all the files.
879 if (extern_aliases != null) {
880 foreach (DictionaryEntry de in extern_aliases)
881 ((AliasEntry) de.Value).Resolve ();
884 if (using_clauses != null) {
885 foreach (UsingEntry ue in using_clauses)
889 if (aliases != null) {
890 foreach (DictionaryEntry de in aliases)
891 ((AliasEntry) de.Value).Resolve ();
896 /// Used to validate that all the using clauses are correct
897 /// after we are finished parsing all the files.
899 static public void VerifyAllUsing ()
901 foreach (NamespaceEntry entry in entries)
902 entry.VerifyUsing ();
905 public string GetSignatureForError ()
907 return ns.GetSignatureForError ();
910 public override string ToString ()
912 return ns.ToString ();