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 RegisterNamespace (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)
99 RegisterNamespace (ns);
103 foreach (Type t in assembly.GetExportedTypes ())
104 RegisterNamespace (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 RegisterNamespace (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 (found_type);
230 DeclSpace ds = TypeManager.LookupDeclSpace (t);
231 Report.Warning (1685, 1, ds.Location, "The type `{0}' conflicts with the predefined type `{1}' and will be ignored",
232 ds.GetSignatureForError (), TypeManager.CSharpName (found_type));
235 Report.SymbolRelatedToPreviousError (t);
236 Report.Warning (436, 2, loc, "The type `{0}' conflicts with the imported type `{1}'. Ignoring the imported type definition",
237 TypeManager.CSharpName (t), TypeManager.CSharpName (found_type));
247 /// Keeps track of the namespaces defined in the C# code.
249 /// This is an Expression to allow it to be referenced in the
250 /// compiler parse/intermediate tree during name resolution.
252 public class Namespace : FullNamedExpression {
256 IDictionary namespaces;
257 IDictionary declspaces;
258 Hashtable cached_types;
261 public readonly MemberName MemberName;
264 /// Constructor Takes the current namespace and the
265 /// name. This is bootstrapped with parent == null
268 public Namespace (Namespace parent, string name)
270 // Expression members.
271 this.eclass = ExprClass.Namespace;
272 this.Type = typeof (Namespace);
273 this.loc = Location.Null;
275 this.parent = parent;
278 this.root = parent.root;
280 this.root = this as RootNamespace;
282 if (this.root == null)
283 throw new InternalErrorException ("Root namespaces must be created using RootNamespace");
285 string pname = parent != null ? parent.Name : "";
290 fullname = parent.Name + "." + name;
292 if (fullname == null)
293 throw new InternalErrorException ("Namespace has a null fullname");
295 if (parent != null && parent.MemberName != MemberName.Null)
296 MemberName = new MemberName (parent.MemberName, name);
297 else if (name.Length == 0)
298 MemberName = MemberName.Null;
300 MemberName = new MemberName (name);
302 namespaces = new HybridDictionary ();
303 cached_types = new Hashtable ();
305 root.RegisterNamespace (this);
308 public override Expression DoResolve (EmitContext ec)
313 public virtual void Error_NamespaceDoesNotExist (DeclSpace ds, Location loc, string name)
315 if (name.IndexOf ('`') > 0) {
316 FullNamedExpression retval = Lookup (ds, SimpleName.RemoveGenericArity (name), loc);
317 if (retval != null) {
318 Error_TypeArgumentsCannotBeUsed (retval.Type, loc, "type");
322 Type t = LookForAnyGenericType (name);
324 Error_InvalidNumberOfTypeArguments (t, loc);
329 Report.Error (234, loc, "The type or namespace name `{0}' does not exist in the namespace `{1}'. Are you missing an assembly reference?",
333 public static void Error_InvalidNumberOfTypeArguments (Type t, Location loc)
335 Report.SymbolRelatedToPreviousError (t);
336 Report.Error (305, loc, "Using the generic type `{0}' requires `{1}' type argument(s)",
337 TypeManager.CSharpName(t), TypeManager.GetNumberOfTypeArguments(t).ToString());
340 public static void Error_TypeArgumentsCannotBeUsed(Type t, Location loc, string symbol)
342 Report.SymbolRelatedToPreviousError(t);
343 Report.Error(308, loc, "The non-generic {0} `{1}' cannot be used with the type argument(s)",
344 symbol, TypeManager.CSharpName(t));
347 public override void Emit (EmitContext ec)
349 throw new InternalErrorException ("Expression tree referenced namespace " + fullname + " during Emit ()");
352 public override string GetSignatureForError ()
357 public Namespace GetNamespace (string name, bool create)
359 int pos = name.IndexOf ('.');
364 first = name.Substring (0, pos);
368 ns = (Namespace) namespaces [first];
373 ns = new Namespace (this, first);
374 namespaces.Add (first, ns);
378 ns = ns.GetNamespace (name.Substring (pos + 1), create);
383 TypeExpr LookupType (string name, Location loc)
385 if (cached_types.Contains (name))
386 return cached_types [name] as TypeExpr;
389 if (declspaces != null) {
390 DeclSpace tdecl = declspaces [name] as DeclSpace;
393 // Note that this is not:
395 // t = tdecl.DefineType ()
397 // This is to make it somewhat more useful when a DefineType
398 // fails due to problems in nested types (more useful in the sense
399 // of fewer misleading error messages)
402 t = tdecl.TypeBuilder;
405 string lookup = t != null ? t.FullName : (fullname.Length == 0 ? name : fullname + "." + name);
406 Type rt = root.LookupTypeReflection (lookup, loc);
408 // HACK: loc.IsNull when the type is core type
409 if (t == null || (rt != null && loc.IsNull))
412 TypeExpr te = t == null ? null : new TypeExpression (t, Location.Null);
413 cached_types [name] = te;
418 /// Used for better error reporting only
420 public Type LookForAnyGenericType (string typeName)
422 if (declspaces == null)
425 typeName = SimpleName.RemoveGenericArity (typeName);
427 foreach (DictionaryEntry de in declspaces) {
428 string type_item = (string) de.Key;
429 int pos = type_item.LastIndexOf ('`');
430 if (pos == typeName.Length && String.Compare (typeName, 0, type_item, 0, pos) == 0)
431 return ((DeclSpace) de.Value).TypeBuilder;
436 public FullNamedExpression Lookup (DeclSpace ds, string name, Location loc)
438 if (namespaces.Contains (name))
439 return (Namespace) namespaces [name];
441 TypeExpr te = LookupType (name, loc);
442 if (te == null || !ds.CheckAccessLevel (te.Type))
448 public void AddDeclSpace (string name, DeclSpace ds)
450 if (declspaces == null)
451 declspaces = new HybridDictionary ();
452 declspaces.Add (name, ds);
456 /// The qualified name of the current namespace
459 get { return fullname; }
462 public override string FullName {
463 get { return fullname; }
467 /// The parent of this namespace, used by the parser to "Pop"
468 /// the current namespace declaration
470 public Namespace Parent {
471 get { return parent; }
474 public override string ToString ()
476 return String.Format ("Namespace ({0})", Name);
480 public class NamespaceEntry {
482 NamespaceEntry parent, implicit_parent;
486 ArrayList using_clauses;
487 public bool DeclarationFound = false;
490 public readonly DeclSpace SlaveDeclSpace;
492 ListDictionary extern_aliases;
494 static ArrayList entries = new ArrayList ();
496 public static void Reset ()
498 entries = new ArrayList ();
502 // This class holds the location where a using definition is
503 // done, and whether it has been used by the program or not.
505 // We use this to flag using clauses for namespaces that do not
508 public class UsingEntry : IResolveContext {
509 public readonly MemberName Name;
510 readonly NamespaceEntry NamespaceEntry;
511 readonly Location Location;
513 public UsingEntry (NamespaceEntry entry, MemberName name, Location loc)
516 NamespaceEntry = entry;
520 internal Namespace resolved;
522 public Namespace Resolve ()
524 if (resolved != null)
527 FullNamedExpression fne = Name.GetTypeExpression ().ResolveAsTypeStep (this, false);
529 Error_NamespaceNotFound (Location, Name.ToString ());
533 resolved = fne as Namespace;
534 if (resolved == null) {
535 Report.SymbolRelatedToPreviousError (fne.Type);
536 Report.Error (138, Location,
537 "`{0}' is a type not a namespace. A using namespace directive can only be applied to namespaces", Name.ToString ());
542 DeclSpace IResolveContext.DeclContainer {
543 get { return NamespaceEntry.SlaveDeclSpace; }
546 DeclSpace IResolveContext.GenericDeclContainer {
547 get { return NamespaceEntry.SlaveDeclSpace; }
550 bool IResolveContext.IsInObsoleteScope {
551 get { return false; }
553 bool IResolveContext.IsInUnsafeScope {
554 get { return false; }
558 public abstract class AliasEntry {
559 public readonly string Name;
560 public readonly NamespaceEntry NamespaceEntry;
561 public readonly Location Location;
563 protected AliasEntry (NamespaceEntry entry, string name, Location loc)
566 NamespaceEntry = entry;
570 protected FullNamedExpression resolved;
573 public FullNamedExpression Resolve ()
575 if (resolved != null || error)
577 resolved = DoResolve ();
578 if (resolved == null)
583 protected abstract FullNamedExpression DoResolve ();
586 public class LocalAliasEntry : AliasEntry, IResolveContext {
587 public readonly Expression Alias;
589 public LocalAliasEntry (NamespaceEntry entry, string name, MemberName alias, Location loc) :
590 base (entry, name, loc)
592 Alias = alias.GetTypeExpression ();
595 protected override FullNamedExpression DoResolve ()
597 resolved = Alias.ResolveAsTypeStep (this, false);
598 if (resolved == null)
601 if (resolved.Type != null) {
602 TypeAttributes attr = resolved.Type.Attributes & TypeAttributes.VisibilityMask;
603 if (attr == TypeAttributes.NestedPrivate || attr == TypeAttributes.NestedFamily ||
604 ((attr == TypeAttributes.NestedFamORAssem || attr == TypeAttributes.NestedAssembly) &&
605 TypeManager.LookupDeclSpace (resolved.Type) == null)) {
606 Expression.ErrorIsInaccesible (Alias.Location, Alias.ToString ());
614 DeclSpace IResolveContext.DeclContainer {
615 get { return NamespaceEntry.SlaveDeclSpace; }
618 DeclSpace IResolveContext.GenericDeclContainer {
619 get { return NamespaceEntry.SlaveDeclSpace; }
622 bool IResolveContext.IsInObsoleteScope {
623 get { return false; }
625 bool IResolveContext.IsInUnsafeScope {
626 get { return false; }
630 public class ExternAliasEntry : AliasEntry {
631 public ExternAliasEntry (NamespaceEntry entry, string name, Location loc) :
632 base (entry, name, loc)
636 protected override FullNamedExpression DoResolve ()
638 resolved = RootNamespace.GetRootNamespace (Name);
639 if (resolved == null)
640 Report.Error (430, Location, "The extern alias '" + Name +
641 "' was not specified in a /reference option");
647 public NamespaceEntry (NamespaceEntry parent, SourceFile file, string name)
649 this.parent = parent;
652 this.ID = entries.Count;
655 ns = parent.NS.GetNamespace (name, true);
656 else if (name != null)
657 ns = RootNamespace.Global.GetNamespace (name, true);
659 ns = RootNamespace.Global;
660 SlaveDeclSpace = new RootDeclSpace (this);
663 private NamespaceEntry (NamespaceEntry parent, SourceFile file, Namespace ns, bool slave)
665 this.parent = parent;
667 // no need to add self to 'entries', since we don't have any aliases or using entries.
669 this.IsImplicit = true;
671 this.SlaveDeclSpace = slave ? new RootDeclSpace (this) : null;
675 // According to section 16.3.1 (using-alias-directive), the namespace-or-type-name is
676 // resolved as if the immediately containing namespace body has no using-directives.
678 // Section 16.3.2 says that the same rule is applied when resolving the namespace-name
679 // in the using-namespace-directive.
681 // To implement these rules, the expressions in the using directives are resolved using
682 // the "doppelganger" (ghostly bodiless duplicate).
684 NamespaceEntry doppelganger;
685 NamespaceEntry Doppelganger {
687 if (!IsImplicit && doppelganger == null)
688 doppelganger = new NamespaceEntry (ImplicitParent, file, ns, true);
693 public readonly int ID;
694 public readonly bool IsImplicit;
696 public Namespace NS {
700 public NamespaceEntry Parent {
701 get { return parent; }
704 public NamespaceEntry ImplicitParent {
708 if (implicit_parent == null) {
709 implicit_parent = (parent.NS == ns.Parent)
711 : new NamespaceEntry (parent, file, ns.Parent, false);
713 return implicit_parent;
718 /// Records a new namespace for resolving name references
720 public void Using (MemberName name, Location loc)
722 if (DeclarationFound){
723 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
729 if (name.Equals (ns.MemberName))
732 if (using_clauses == null)
733 using_clauses = new ArrayList ();
735 foreach (UsingEntry old_entry in using_clauses) {
736 if (name.Equals (old_entry.Name)) {
737 Report.Warning (105, 3, loc, "The using directive for `{0}' appeared previously in this namespace", name.GetName ());
742 UsingEntry ue = new UsingEntry (Doppelganger, name, loc);
743 using_clauses.Add (ue);
746 public void UsingAlias (string name, MemberName alias, Location loc)
748 if (DeclarationFound){
749 Report.Error (1529, loc, "A using clause must precede all other namespace elements except extern alias declarations");
756 aliases = new Hashtable ();
758 if (aliases.Contains (name)) {
759 AliasEntry ae = (AliasEntry) aliases [name];
760 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
761 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
765 if (RootContext.Version == LanguageVersion.Default &&
766 name == "global" && RootContext.WarningLevel >= 2)
767 Report.Warning (440, 2, loc, "An alias named `global' will not be used when resolving 'global::';" +
768 " the global namespace will be used instead");
770 // FIXME: get correct error number. See if the above check can be merged
771 if (extern_aliases != null && extern_aliases.Contains (name)) {
772 AliasEntry ae = (AliasEntry) extern_aliases [name];
773 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
774 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
778 aliases [name] = new LocalAliasEntry (Doppelganger, name, alias, loc);
781 public void UsingExternalAlias (string name, Location loc)
783 if (UsingFound || DeclarationFound) {
784 Report.Error (439, loc, "An extern alias declaration must precede all other elements");
788 // Share the extern_aliases field with the Doppelganger
789 if (extern_aliases == null) {
790 extern_aliases = new ListDictionary ();
791 Doppelganger.extern_aliases = extern_aliases;
794 if (extern_aliases.Contains (name)) {
795 AliasEntry ae = (AliasEntry) extern_aliases [name];
796 Report.SymbolRelatedToPreviousError (ae.Location, ae.Name);
797 Report.Error (1537, loc, "The using alias `{0}' appeared previously in this namespace", name);
801 if (name == "global") {
802 Report.Error (1681, loc, "You cannot redefine the global extern alias");
806 // Register the alias in aliases and extern_aliases, since we need both of them
807 // to keep things simple (different resolution scenarios)
808 ExternAliasEntry alias = new ExternAliasEntry (Doppelganger, name, loc);
809 extern_aliases [name] = alias;
812 public FullNamedExpression LookupNamespaceOrType (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
814 // Precondition: Only simple names (no dots) will be looked up with this function.
815 FullNamedExpression resolved = null;
816 for (NamespaceEntry curr_ns = this; curr_ns != null; curr_ns = curr_ns.ImplicitParent) {
817 if ((resolved = curr_ns.Lookup (ds, name, loc, ignore_cs0104)) != null)
823 static void Error_AmbiguousTypeReference (Location loc, string name, FullNamedExpression t1, FullNamedExpression t2)
825 Report.Error (104, loc, "`{0}' is an ambiguous reference between `{1}' and `{2}'",
826 name, t1.FullName, t2.FullName);
829 // Looks-up a alias named @name in this and surrounding namespace declarations
830 public FullNamedExpression LookupAlias (string name)
832 AliasEntry entry = null;
833 for (NamespaceEntry n = this; n != null; n = n.ImplicitParent) {
834 if (n.extern_aliases != null && (entry = n.extern_aliases [name] as AliasEntry) != null)
836 if (n.aliases != null && (entry = n.aliases [name] as AliasEntry) != null)
839 return entry == null ? null : entry.Resolve ();
842 private FullNamedExpression Lookup (DeclSpace ds, string name, Location loc, bool ignore_cs0104)
845 // Check whether it's in the namespace.
847 FullNamedExpression fne = ns.Lookup (ds, name, loc);
851 if (extern_aliases != null) {
852 AliasEntry entry = extern_aliases [name] as AliasEntry;
854 return entry.Resolve ();
863 if (aliases != null) {
864 AliasEntry entry = aliases [name] as AliasEntry;
866 return entry.Resolve ();
870 // Check using entries.
872 FullNamedExpression match = null;
873 foreach (Namespace using_ns in GetUsingTable ()) {
874 match = using_ns.Lookup (ds, name, loc);
875 if (match == null || !(match is TypeExpr))
879 Error_AmbiguousTypeReference (loc, name, fne, match);
888 // Our cached computation.
889 static readonly Namespace [] empty_namespaces = new Namespace [0];
890 Namespace [] namespace_using_table;
891 Namespace [] GetUsingTable ()
893 if (namespace_using_table != null)
894 return namespace_using_table;
896 if (using_clauses == null) {
897 namespace_using_table = empty_namespaces;
898 return namespace_using_table;
901 ArrayList list = new ArrayList (using_clauses.Count);
903 foreach (UsingEntry ue in using_clauses) {
904 Namespace using_ns = ue.Resolve ();
905 if (using_ns == null)
911 namespace_using_table = new Namespace [list.Count];
912 list.CopyTo (namespace_using_table, 0);
913 return namespace_using_table;
916 static readonly string [] empty_using_list = new string [0];
918 public int SymbolFileID {
920 if (symfile_id == 0 && file.SourceFileEntry != null) {
921 int parent_id = parent == null ? 0 : parent.SymbolFileID;
923 string [] using_list = empty_using_list;
924 if (using_clauses != null) {
925 using_list = new string [using_clauses.Count];
926 for (int i = 0; i < using_clauses.Count; i++)
927 using_list [i] = ((UsingEntry) using_clauses [i]).Name.ToString ();
930 symfile_id = CodeGen.SymbolWriter.DefineNamespace (ns.Name, file.SourceFileEntry, using_list, parent_id);
936 static void MsgtryRef (string s)
938 Console.WriteLine (" Try using -r:" + s);
941 static void MsgtryPkg (string s)
943 Console.WriteLine (" Try using -pkg:" + s);
946 public static void Error_NamespaceNotFound (Location loc, string name)
948 Report.Error (246, loc, "The type or namespace name `{0}' could not be found. Are you missing a using directive or an assembly reference?",
952 case "Gtk": case "GtkSharp":
953 MsgtryPkg ("gtk-sharp");
956 case "Gdk": case "GdkSharp":
957 MsgtryPkg ("gdk-sharp");
960 case "Glade": case "GladeSharp":
961 MsgtryPkg ("glade-sharp");
964 case "System.Drawing":
965 case "System.Web.Services":
968 case "System.Windows.Forms":
975 /// Used to validate that all the using clauses are correct
976 /// after we are finished parsing all the files.
980 if (extern_aliases != null) {
981 foreach (DictionaryEntry de in extern_aliases)
982 ((AliasEntry) de.Value).Resolve ();
985 if (using_clauses != null) {
986 foreach (UsingEntry ue in using_clauses)
990 if (aliases != null) {
991 foreach (DictionaryEntry de in aliases)
992 ((AliasEntry) de.Value).Resolve ();
997 /// Used to validate that all the using clauses are correct
998 /// after we are finished parsing all the files.
1000 static public void VerifyAllUsing ()
1002 foreach (NamespaceEntry entry in entries)
1003 entry.VerifyUsing ();
1006 public string GetSignatureForError ()
1008 return ns.GetSignatureForError ();
1011 public override string ToString ()
1013 return ns.ToString ();