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 !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(DeclSpace ds, 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);
291 else if (name.Length == 0)
292 MemberName = MemberName.Null;
294 MemberName = new MemberName (name);
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 (DeclSpace ds, Location loc, string name)
309 if (name.IndexOf ("`") > 0) {
310 FullNamedExpression retval = Lookup (ds, SimpleName.RemoveGenericArity (name), loc);
311 if (retval != null) {
312 Error_TypeArgumentsCannotBeUsed (retval.Type, loc, "type");
316 Type t = LookForAnyGenericType (name);
318 Error_InvalidNumberOfTypeArguments (t, loc);
323 Report.Error (234, loc, "The type or namespace name `{0}' does not exist in the namespace `{1}'. Are you missing an assembly reference?",
327 public static void Error_InvalidNumberOfTypeArguments (Type t, Location loc)
329 Report.SymbolRelatedToPreviousError (t);
330 Report.Error (305, loc, "Using the generic type `{0}' requires `{1}' type argument(s)",
331 TypeManager.CSharpName(t), TypeManager.GetNumberOfTypeArguments(t).ToString());
334 public static void Error_TypeArgumentsCannotBeUsed(Type t, Location loc, string symbol)
336 Report.SymbolRelatedToPreviousError(t);
337 Report.Error(308, loc, "The non-generic {0} `{1}' cannot be used with the type argument(s)",
338 symbol, TypeManager.CSharpName(t));
341 public override void Emit (EmitContext ec)
343 throw new InternalErrorException ("Expression tree referenced namespace " + fullname + " during Emit ()");
346 public override string GetSignatureForError ()
351 public Namespace GetNamespace (string name, bool create)
353 int pos = name.IndexOf ('.');
358 first = name.Substring (0, pos);
362 ns = (Namespace) namespaces [first];
367 ns = new Namespace (this, first);
368 namespaces.Add (first, ns);
372 ns = ns.GetNamespace (name.Substring (pos + 1), create);
377 TypeExpr LookupType (string name, Location loc)
379 if (cached_types.Contains (name))
380 return cached_types [name] as TypeExpr;
383 if (declspaces != null) {
384 DeclSpace tdecl = declspaces [name] as DeclSpace;
387 // Note that this is not:
389 // t = tdecl.DefineType ()
391 // This is to make it somewhat more useful when a DefineType
392 // fails due to problems in nested types (more useful in the sense
393 // of fewer misleading error messages)
396 t = tdecl.TypeBuilder;
399 string lookup = t != null ? t.FullName : (fullname.Length == 0 ? name : fullname + "." + name);
400 Type rt = root.LookupTypeReflection (lookup, loc);
404 TypeExpr te = t == null ? null : new TypeExpression (t, Location.Null);
405 cached_types [name] = te;
410 /// Used for better error reporting only
412 public Type LookForAnyGenericType (string typeName)
414 if (declspaces == null)
417 typeName = SimpleName.RemoveGenericArity (typeName);
419 foreach (DictionaryEntry de in declspaces) {
420 string type_item = (string) de.Key;
421 int pos = type_item.LastIndexOf ('`');
422 if (pos == typeName.Length && String.Compare (typeName, 0, type_item, 0, pos) == 0)
423 return ((DeclSpace) de.Value).TypeBuilder;
428 public FullNamedExpression Lookup (DeclSpace ds, string name, Location loc)
430 if (namespaces.Contains (name))
431 return (Namespace) namespaces [name];
433 TypeExpr te = LookupType (name, loc);
434 if (te == null || !ds.CheckAccessLevel (te.Type))
440 public void AddDeclSpace (string name, DeclSpace ds)
442 if (declspaces == null)
443 declspaces = new HybridDictionary ();
444 declspaces.Add (name, ds);
448 /// The qualified name of the current namespace
451 get { return fullname; }
454 public override string FullName {
455 get { return fullname; }
459 /// The parent of this namespace, used by the parser to "Pop"
460 /// the current namespace declaration
462 public Namespace Parent {
463 get { return parent; }
466 public override string ToString ()
468 return String.Format ("Namespace ({0})", Name);
472 public class NamespaceEntry {
474 NamespaceEntry parent, implicit_parent;
478 ArrayList using_clauses;
479 public bool DeclarationFound = false;
482 public readonly DeclSpace SlaveDeclSpace;
484 ListDictionary extern_aliases;
486 static ArrayList entries = new ArrayList ();
488 public static void Reset ()
490 entries = new ArrayList ();
494 // This class holds the location where a using definition is
495 // done, and whether it has been used by the program or not.
497 // We use this to flag using clauses for namespaces that do not
500 public class UsingEntry : IResolveContext {
501 public readonly MemberName Name;
502 readonly Expression Expr;
503 readonly NamespaceEntry NamespaceEntry;
504 readonly Location Location;
506 public UsingEntry (NamespaceEntry entry, MemberName name, Location loc)
509 Expr = name.GetTypeExpression ();
510 NamespaceEntry = entry;
514 internal Namespace resolved;
516 public Namespace Resolve ()
518 if (resolved != null)
521 FullNamedExpression fne = Expr.ResolveAsTypeStep (this, false);
523 Error_NamespaceNotFound (Location, Name.ToString ());
527 resolved = fne as Namespace;
528 if (resolved == null) {
529 Report.Error (138, Location,
530 "`{0} is a type not a namespace. A using namespace directive can only be applied to namespaces", Name.ToString ());
535 DeclSpace IResolveContext.DeclContainer {
536 get { return NamespaceEntry.SlaveDeclSpace; }
539 DeclSpace IResolveContext.GenericDeclContainer {
540 get { return NamespaceEntry.SlaveDeclSpace; }
543 bool IResolveContext.IsInObsoleteScope {
544 get { return false; }
546 bool IResolveContext.IsInUnsafeScope {
547 get { return false; }
551 public abstract class AliasEntry {
552 public readonly string Name;
553 public readonly NamespaceEntry NamespaceEntry;
554 public readonly Location Location;
556 protected AliasEntry (NamespaceEntry entry, string name, Location loc)
559 NamespaceEntry = entry;
563 protected FullNamedExpression resolved;
566 public FullNamedExpression Resolve ()
568 if (resolved != null || error)
570 resolved = DoResolve ();
571 if (resolved == null)
576 protected abstract FullNamedExpression DoResolve ();
579 public class LocalAliasEntry : AliasEntry, IResolveContext {
580 public readonly Expression Alias;
582 public LocalAliasEntry (NamespaceEntry entry, string name, MemberName alias, Location loc) :
583 base (entry, name, loc)
585 Alias = alias.GetTypeExpression ();
588 protected override FullNamedExpression DoResolve ()
590 resolved = Alias.ResolveAsTypeStep (this, false);
591 if (resolved == null)
594 if (resolved.Type != null) {
595 TypeAttributes attr = resolved.Type.Attributes & TypeAttributes.VisibilityMask;
596 if (attr == TypeAttributes.NestedPrivate || attr == TypeAttributes.NestedFamily ||
597 ((attr == TypeAttributes.NestedFamORAssem || attr == TypeAttributes.NestedAssembly) &&
598 TypeManager.LookupDeclSpace (resolved.Type) == null)) {
599 Expression.ErrorIsInaccesible (Alias.Location, Alias.ToString ());
607 DeclSpace IResolveContext.DeclContainer {
608 get { return NamespaceEntry.SlaveDeclSpace; }
611 DeclSpace IResolveContext.GenericDeclContainer {
612 get { return NamespaceEntry.SlaveDeclSpace; }
615 bool IResolveContext.IsInObsoleteScope {
616 get { return false; }
618 bool IResolveContext.IsInUnsafeScope {
619 get { return false; }
623 public class ExternAliasEntry : AliasEntry {
624 public ExternAliasEntry (NamespaceEntry entry, string name, Location loc) :
625 base (entry, name, loc)
629 protected override FullNamedExpression DoResolve ()
631 resolved = RootNamespace.GetRootNamespace (Name);
632 if (resolved == null)
633 Report.Error (430, Location, "The extern alias '" + Name +
634 "' was not specified in a /reference option");
640 public NamespaceEntry (NamespaceEntry parent, SourceFile file, string name)
642 this.parent = parent;
645 this.ID = entries.Count;
648 ns = parent.NS.GetNamespace (name, true);
649 else if (name != null)
650 ns = RootNamespace.Global.GetNamespace (name, true);
652 ns = RootNamespace.Global;
653 SlaveDeclSpace = new RootDeclSpace (this);
656 private NamespaceEntry (NamespaceEntry parent, SourceFile file, Namespace ns, bool slave)
658 this.parent = parent;
660 // no need to add self to 'entries', since we don't have any aliases or using entries.
662 this.IsImplicit = true;
664 this.SlaveDeclSpace = slave ? new RootDeclSpace (this) : null;
668 // According to section 16.3.1 (using-alias-directive), the namespace-or-type-name is
669 // resolved as if the immediately containing namespace body has no using-directives.
671 // Section 16.3.2 says that the same rule is applied when resolving the namespace-name
672 // in the using-namespace-directive.
674 // To implement these rules, the expressions in the using directives are resolved using
675 // the "doppelganger" (ghostly bodiless duplicate).
677 NamespaceEntry doppelganger;
678 NamespaceEntry Doppelganger {
680 if (!IsImplicit && doppelganger == null)
681 doppelganger = new NamespaceEntry (ImplicitParent, file, ns, true);
686 public readonly int ID;
687 public readonly bool IsImplicit;
689 public Namespace NS {
693 public NamespaceEntry Parent {
694 get { return parent; }
697 public NamespaceEntry ImplicitParent {
701 if (implicit_parent == null) {
702 implicit_parent = (parent.NS == ns.Parent)
704 : new NamespaceEntry (parent, file, ns.Parent, false);
706 return implicit_parent;
711 /// Records a new namespace for resolving name references
713 public void Using (MemberName name, Location loc)
715 if (DeclarationFound){
716 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
722 if (name.Equals (ns.MemberName))
725 if (using_clauses == null)
726 using_clauses = new ArrayList ();
728 foreach (UsingEntry old_entry in using_clauses) {
729 if (name.Equals (old_entry.Name)) {
730 Report.Warning (105, 3, loc, "The using directive for `{0}' appeared previously in this namespace", name.GetName ());
735 UsingEntry ue = new UsingEntry (Doppelganger, name, loc);
736 using_clauses.Add (ue);
739 public void UsingAlias (string name, MemberName alias, Location loc)
741 if (DeclarationFound){
742 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
749 aliases = new Hashtable ();
751 if (aliases.Contains (name)) {
752 AliasEntry ae = (AliasEntry) aliases [name];
753 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
754 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
758 if (RootContext.Version == LanguageVersion.Default &&
759 name == "global" && RootContext.WarningLevel >= 2)
760 Report.Warning (440, 2, loc, "An alias named `global' will not be used when resolving 'global::';" +
761 " the global namespace will be used instead");
763 // FIXME: get correct error number. See if the above check can be merged
764 if (extern_aliases != null && extern_aliases.Contains (name)) {
765 AliasEntry ae = (AliasEntry) extern_aliases [name];
766 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
767 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
771 aliases [name] = new LocalAliasEntry (Doppelganger, name, alias, loc);
774 public void UsingExternalAlias (string name, Location loc)
776 if (UsingFound || DeclarationFound) {
777 Report.Error (439, loc, "An extern alias declaration must precede all other elements");
781 // Share the extern_aliases field with the Doppelganger
782 if (extern_aliases == null) {
783 extern_aliases = new ListDictionary ();
784 Doppelganger.extern_aliases = extern_aliases;
787 if (extern_aliases.Contains (name)) {
788 AliasEntry ae = (AliasEntry) extern_aliases [name];
789 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
790 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
794 if (name == "global") {
795 Report.Error (1681, loc, "You cannot redefine the global extern alias");
799 // Register the alias in aliases and extern_aliases, since we need both of them
800 // to keep things simple (different resolution scenarios)
801 ExternAliasEntry alias = new ExternAliasEntry (Doppelganger, name, loc);
802 extern_aliases [name] = alias;
805 public FullNamedExpression LookupNamespaceOrType (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
807 // Precondition: Only simple names (no dots) will be looked up with this function.
808 FullNamedExpression resolved = null;
809 for (NamespaceEntry curr_ns = this; curr_ns != null; curr_ns = curr_ns.ImplicitParent) {
810 if ((resolved = curr_ns.Lookup (ds, name, loc, ignore_cs0104)) != null)
816 static void Error_AmbiguousTypeReference (Location loc, string name, FullNamedExpression t1, FullNamedExpression t2)
818 Report.Error (104, loc, "`{0}' is an ambiguous reference between `{1}' and `{2}'",
819 name, t1.FullName, t2.FullName);
822 // Looks-up a alias named @name in this and surrounding namespace declarations
823 public FullNamedExpression LookupAlias (string name)
825 AliasEntry entry = null;
826 for (NamespaceEntry n = this; n != null; n = n.ImplicitParent) {
827 if (n.extern_aliases != null && (entry = n.extern_aliases [name] as AliasEntry) != null)
829 if (n.aliases != null && (entry = n.aliases [name] as AliasEntry) != null)
832 return entry == null ? null : entry.Resolve ();
835 private FullNamedExpression Lookup (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
838 // Check whether it's in the namespace.
840 FullNamedExpression fne = NS.Lookup (ds, name, loc);
844 if (extern_aliases != null) {
845 AliasEntry entry = extern_aliases [name] as AliasEntry;
847 return entry.Resolve ();
856 if (aliases != null) {
857 AliasEntry entry = aliases [name] as AliasEntry;
859 return entry.Resolve ();
863 // Check using entries.
865 FullNamedExpression match = null;
866 foreach (Namespace using_ns in GetUsingTable ()) {
867 match = using_ns.Lookup (ds, name, loc);
868 if (match == null || !(match is TypeExpr))
872 Error_AmbiguousTypeReference (loc, name, fne, match);
881 // Our cached computation.
882 readonly Namespace [] empty_namespaces = new Namespace [0];
883 Namespace [] namespace_using_table;
884 Namespace [] GetUsingTable ()
886 if (namespace_using_table != null)
887 return namespace_using_table;
889 if (using_clauses == null) {
890 namespace_using_table = empty_namespaces;
891 return namespace_using_table;
894 ArrayList list = new ArrayList (using_clauses.Count);
896 foreach (UsingEntry ue in using_clauses) {
897 Namespace using_ns = ue.Resolve ();
898 if (using_ns == null)
904 namespace_using_table = new Namespace [list.Count];
905 list.CopyTo (namespace_using_table, 0);
906 return namespace_using_table;
909 readonly string [] empty_using_list = new string [0];
911 public int SymbolFileID {
913 if (symfile_id == 0 && file.SourceFileEntry != null) {
914 int parent_id = parent == null ? 0 : parent.SymbolFileID;
916 string [] using_list = empty_using_list;
917 if (using_clauses != null) {
918 using_list = new string [using_clauses.Count];
919 for (int i = 0; i < using_clauses.Count; i++)
920 using_list [i] = ((UsingEntry) using_clauses [i]).Name.ToString ();
923 symfile_id = CodeGen.SymbolWriter.DefineNamespace (ns.Name, file.SourceFileEntry, using_list, parent_id);
929 static void MsgtryRef (string s)
931 Console.WriteLine (" Try using -r:" + s);
934 static void MsgtryPkg (string s)
936 Console.WriteLine (" Try using -pkg:" + s);
939 public static void Error_NamespaceNotFound (Location loc, string name)
941 Report.Error (246, loc, "The type or namespace name `{0}' could not be found. Are you missing a using directive or an assembly reference?",
945 case "Gtk": case "GtkSharp":
946 MsgtryPkg ("gtk-sharp");
949 case "Gdk": case "GdkSharp":
950 MsgtryPkg ("gdk-sharp");
953 case "Glade": case "GladeSharp":
954 MsgtryPkg ("glade-sharp");
957 case "System.Drawing":
958 case "System.Web.Services":
961 case "System.Windows.Forms":
968 /// Used to validate that all the using clauses are correct
969 /// after we are finished parsing all the files.
973 if (extern_aliases != null) {
974 foreach (DictionaryEntry de in extern_aliases)
975 ((AliasEntry) de.Value).Resolve ();
978 if (using_clauses != null) {
979 foreach (UsingEntry ue in using_clauses)
983 if (aliases != null) {
984 foreach (DictionaryEntry de in aliases)
985 ((AliasEntry) de.Value).Resolve ();
990 /// Used to validate that all the using clauses are correct
991 /// after we are finished parsing all the files.
993 static public void VerifyAllUsing ()
995 foreach (NamespaceEntry entry in entries)
996 entry.VerifyUsing ();
999 public string GetSignatureForError ()
1001 return ns.GetSignatureForError ();
1004 public override string ToString ()
1006 return ns.ToString ();