X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=mcs%2Fmcs%2Fdoc.cs;h=90a9d1bb66f255d215ffcb3c66916412a5f54c0c;hb=e0df8328d11d79623c1b0369cf15544b26a18db0;hp=9d05438a5fa8823eb3d059dbc238d5385b73582a;hpb=5479a755bb9fe1147d0425a25a3e159345f7057e;p=mono.git diff --git a/mcs/mcs/doc.cs b/mcs/mcs/doc.cs index 9d05438a5fa..90a9d1bb66f 100644 --- a/mcs/mcs/doc.cs +++ b/mcs/mcs/doc.cs @@ -9,7 +9,6 @@ // (C) 2004 Novell, Inc. // // - #if ! BOOTSTRAP_WITH_OLDLIB using System; using System.Collections; @@ -31,8 +30,16 @@ namespace Mono.CSharp { // // Support class for XML documentation. // +#if NET_2_0 + static +#else + abstract +#endif public class DocUtil { +#if !NET_2_0 + private DocUtil () {} +#endif // TypeContainer // @@ -55,15 +62,9 @@ namespace Mono.CSharp { foreach (TypeContainer tc in t.Types) tc.GenerateDocComment (t); - if (t.Parts != null) { - IDictionary comments = RootContext.Documentation.PartialComments; - foreach (ClassPart cp in t.Parts) { - if (cp.DocComment == null) - continue; - comments [cp] = cp; - } - } - + if (t.Delegates != null) + foreach (Delegate de in t.Delegates) + de.GenerateDocComment (t); if (t.Enums != null) foreach (Enum en in t.Enums) en.GenerateDocComment (t); @@ -73,7 +74,7 @@ namespace Mono.CSharp { c.GenerateDocComment (t); if (t.Fields != null) - foreach (Field f in t.Fields) + foreach (FieldBase f in t.Fields) f.GenerateDocComment (t); if (t.Events != null) @@ -151,11 +152,19 @@ namespace Mono.CSharp { XmlElement el = n as XmlElement; if (el != null) { - mc.OnGenerateDocComment (ds, el); + mc.OnGenerateDocComment (el); // FIXME: it could be done with XmlReader - foreach (XmlElement inc in n.SelectNodes (".//include")) - HandleInclude (mc, inc); + XmlNodeList nl = n.SelectNodes (".//include"); + if (nl.Count > 0) { + // It could result in current node removal, so prepare another list to iterate. + ArrayList al = new ArrayList (nl.Count); + foreach (XmlNode inc in nl) + al.Add (inc); + foreach (XmlElement inc in al) + if (!HandleInclude (mc, inc)) + inc.ParentNode.RemoveChild (inc); + } // FIXME: it could be done with XmlReader DeclSpace dsTarget = mc as DeclSpace; @@ -172,7 +181,7 @@ namespace Mono.CSharp { n.WriteTo (RootContext.Documentation.XmlCommentOutput); } - else if (mc.IsExposedFromAssembly (ds)) { + else if (mc.IsExposedFromAssembly ()) { Constructor c = mc as Constructor; if (c == null || !c.IsDefault ()) Report.Warning (1591, 4, mc.Location, @@ -184,17 +193,20 @@ namespace Mono.CSharp { // Processes "include" element. Check included file and // embed the document content inside this documentation node. // - private static void HandleInclude (MemberCore mc, XmlElement el) + private static bool HandleInclude (MemberCore mc, XmlElement el) { + bool keepIncludeNode = false; string file = el.GetAttribute ("file"); string path = el.GetAttribute ("path"); if (file == "") { Report.Warning (1590, 1, mc.Location, "Invalid XML `include' element. Missing `file' attribute"); el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el); + keepIncludeNode = true; } - else if (path == "") { + else if (path.Length == 0) { Report.Warning (1590, 1, mc.Location, "Invalid XML `include' element. Missing `path' attribute"); el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el); + keepIncludeNode = true; } else { XmlDocument doc = RootContext.Documentation.StoredDocuments [file] as XmlDocument; @@ -208,7 +220,6 @@ namespace Mono.CSharp { Report.Warning (1592, 1, mc.Location, "Badly formed XML in included comments file -- `{0}'", file); } } - bool keepIncludeNode = false; if (doc != null) { try { XmlNodeList nl = doc.SelectNodes (path); @@ -224,9 +235,8 @@ namespace Mono.CSharp { Report.Warning (1589, 1, mc.Location, "Unable to include XML fragment `{0}' of file `{1}' ({2})", path, file, ex.Message); } } - if (!keepIncludeNode) - el.ParentNode.RemoveChild (el); } + return keepIncludeNode; } // @@ -333,41 +343,163 @@ namespace Mono.CSharp { // no need to detect warning 419 here return FindDocumentedMember (mc, parent, identifier.Substring (index + 1), - Type.EmptyTypes, - ds, out warn, cref) as Type; + null, ds, out warn, cref, false, null).Member as Type; + } + + private static MemberInfo [] empty_member_infos = + new MemberInfo [0]; + + private static MemberInfo [] FindMethodBase (Type type, + BindingFlags bindingFlags, MethodSignature signature) + { + MemberList ml = TypeManager.FindMembers ( + type, + MemberTypes.Constructor | MemberTypes.Method | MemberTypes.Property | MemberTypes.Custom, + bindingFlags, + MethodSignature.method_signature_filter, + signature); + if (ml == null) + return empty_member_infos; + + return FilterOverridenMembersOut ((MemberInfo []) ml); + } + + static bool IsOverride (PropertyInfo deriv_prop, PropertyInfo base_prop) + { + if (!Invocation.IsAncestralType (base_prop.DeclaringType, deriv_prop.DeclaringType)) + return false; + + Type [] deriv_pd = TypeManager.GetArgumentTypes (deriv_prop); + Type [] base_pd = TypeManager.GetArgumentTypes (base_prop); + + if (deriv_pd.Length != base_pd.Length) + return false; + + for (int j = 0; j < deriv_pd.Length; ++j) { + if (deriv_pd [j] != base_pd [j]) + return false; + Type ct = TypeManager.TypeToCoreType (deriv_pd [j]); + Type bt = TypeManager.TypeToCoreType (base_pd [j]); + + if (ct != bt) + return false; + } + + return true; + } + + private static MemberInfo [] FilterOverridenMembersOut ( + MemberInfo [] ml) + { + if (ml == null) + return empty_member_infos; + + ArrayList al = new ArrayList (ml.Length); + for (int i = 0; i < ml.Length; i++) { + MethodBase mx = ml [i] as MethodBase; + PropertyInfo px = ml [i] as PropertyInfo; + if (mx != null || px != null) { + bool overriden = false; + for (int j = 0; j < ml.Length; j++) { + if (j == i) + continue; + MethodBase my = ml [j] as MethodBase; + if (mx != null && my != null && + Invocation.IsOverride (my, mx)) { + overriden = true; + break; + } + else if (mx != null) + continue; + PropertyInfo py = ml [j] as PropertyInfo; + if (px != null && py != null && + IsOverride (py, px)) { + overriden = true; + break; + } + } + if (overriden) + continue; + } + al.Add (ml [i]); + } + return al.ToArray (typeof (MemberInfo)) as MemberInfo []; + } + + struct FoundMember + { + public static FoundMember Empty = new FoundMember (true); + + public bool IsEmpty; + public readonly MemberInfo Member; + public readonly Type Type; + + public FoundMember (bool regardlessOfThisValueItsEmpty) + { + IsEmpty = true; + Member = null; + Type = null; + } + + public FoundMember (Type foundType, MemberInfo member) + { + IsEmpty = false; + Type = foundType; + Member = member; + } } // // Returns a MemberInfo that is referenced in XML documentation // (by "see" or "seealso" elements). // - private static MemberInfo FindDocumentedMember (MemberCore mc, + private static FoundMember FindDocumentedMember (MemberCore mc, Type type, string memberName, Type [] paramList, - DeclSpace ds, out int warningType, string cref) + DeclSpace ds, out int warningType, string cref, + bool warn419, string nameForError) { - warningType = 0; - MethodSignature msig = new MethodSignature (memberName, null, paramList); - MemberInfo [] mis = type.FindMembers ( - MemberTypes.All, - BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance, - MethodSignature.method_signature_filter, - msig); - if (mis.Length > 0) { - if (IsAmbiguous (mis)) - warningType = 419; - return mis [0]; + for (; type != null; type = type.DeclaringType) { + MemberInfo mi = FindDocumentedMemberNoNest ( + mc, type, memberName, paramList, ds, + out warningType, cref, warn419, + nameForError); + if (mi != null) + return new FoundMember (type, mi); } + warningType = 0; + return FoundMember.Empty; + } + + private static MemberInfo FindDocumentedMemberNoNest ( + MemberCore mc, Type type, string memberName, + Type [] paramList, DeclSpace ds, out int warningType, + string cref, bool warn419, string nameForError) + { + warningType = 0; + MemberInfo [] mis; - if (paramList.Length == 0) { + if (paramList == null) { // search for fields/events etc. - mis = TypeManager.MemberLookup (null, null, + mis = TypeManager.MemberLookup (type, null, type, MemberTypes.All, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance, memberName, null); + mis = FilterOverridenMembersOut (mis); if (mis == null || mis.Length == 0) return null; + if (warn419 && IsAmbiguous (mis)) + Report419 (mc, nameForError, mis); + return mis [0]; + } + + MethodSignature msig = new MethodSignature (memberName, null, paramList); + mis = FindMethodBase (type, + BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance, + msig); + + if (warn419 && mis.Length > 0) { if (IsAmbiguous (mis)) - warningType = 419; + Report419 (mc, nameForError, mis); return mis [0]; } @@ -451,10 +583,9 @@ namespace Mono.CSharp { // here we still don't consider return type (to // detect CS1581 or CS1002+CS1584). msig = new MethodSignature (oper, null, paramList); - mis = type.FindMembers ( - MemberTypes.Method, - BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static, - MethodSignature.method_signature_filter, + + mis = FindMethodBase (type, + BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance, msig); if (mis.Length == 0) return null; // CS1574 @@ -515,33 +646,30 @@ namespace Mono.CSharp { signature = cref; int parensPos = signature.IndexOf ('('); + int bracePos = parensPos >= 0 ? -1 : + signature.IndexOf ('['); if (parensPos > 0 && signature [signature.Length - 1] == ')') { name = signature.Substring (0, parensPos).Trim (wsChars); - parameters = signature.Substring (parensPos + 1, signature.Length - parensPos - 2); + parameters = signature.Substring (parensPos + 1, signature.Length - parensPos - 2).Trim (wsChars); + } + else if (bracePos > 0 && signature [signature.Length - 1] == ']') { + name = signature.Substring (0, bracePos).Trim (wsChars); + parameters = signature.Substring (bracePos + 1, signature.Length - bracePos - 2).Trim (wsChars); } else { name = signature; - parameters = String.Empty; + parameters = null; } Normalize (mc, ref name); - string identifier = name; - - if (name.Length > 0 && name [name.Length - 1] == ']') { - string tmp = name.Substring (0, name.Length - 1).Trim (wsChars); - if (tmp [tmp.Length - 1] == '[') - identifier = tmp.Substring (0, tmp.Length - 1).Trim (wsChars); - } + string identifier = GetBodyIdentifierFromName (name); // Check if identifier is valid. // This check is not necessary to mark as error, but // csc specially reports CS1584 for wrong identifiers. string [] nameElems = identifier.Split ('.'); for (int i = 0; i < nameElems.Length; i++) { - string nameElem = nameElems [i]; - if (nameElem.EndsWith ("[]")) - nameElem = nameElem.Substring ( - nameElem.Length - 2); + string nameElem = GetBodyIdentifierFromName (nameElems [i]); if (i > 0) Normalize (mc, ref nameElem); if (!Tokenizer.IsValidIdentifier (nameElem) @@ -554,8 +682,12 @@ namespace Mono.CSharp { } // check if parameters are valid - Type [] parameterTypes = Type.EmptyTypes; - if (parameters.Length > 0) { + Type [] parameterTypes; + if (parameters == null) + parameterTypes = null; + else if (parameters.Length == 0) + parameterTypes = Type.EmptyTypes; + else { string [] paramList = parameters.Split (','); ArrayList plist = new ArrayList (); for (int i = 0; i < paramList.Length; i++) { @@ -570,33 +702,19 @@ namespace Mono.CSharp { plist.Add (paramType); } parameterTypes = plist.ToArray (typeof (Type)) as Type []; - StringBuilder sb = new StringBuilder (); - sb.Append ('('); - for (int i = 0; i < parameterTypes.Length; i++) { - Type t = parameterTypes [i]; - if (sb.Length > 1) - sb.Append (','); - sb.Append (t.FullName.Replace ('+', '.')); - } - sb.Append (')'); - parameters = sb.ToString (); } Type type = FindDocumentedType (mc, name, ds, cref); if (type != null // delegate must not be referenced with args && (!type.IsSubclassOf (typeof (System.Delegate)) - || parameterTypes.Length == 0)) { - xref.SetAttribute ("cref", "T:" + type.FullName.Replace ("+", ".")); + || parameterTypes == null)) { + string result = GetSignatureForDoc (type) + + (bracePos < 0 ? String.Empty : signature.Substring (bracePos)); + xref.SetAttribute ("cref", "T:" + result); return; // a type } - // don't use identifier here. System[] is not alloed. - if (RootNamespace.Global.IsNamespace (name)) { - xref.SetAttribute ("cref", "N:" + name); - return; // a namespace - } - int period = name.LastIndexOf ('.'); if (period > 0) { string typeName = name.Substring (0, period); @@ -605,41 +723,107 @@ namespace Mono.CSharp { type = FindDocumentedType (mc, typeName, ds, cref); int warnResult; if (type != null) { - MemberInfo mi = FindDocumentedMember (mc, type, memberName, parameterTypes, ds, out warnResult, cref); - if (warnResult == 419) - Report419 (mc, name, mi); - else if (warnResult > 0) + FoundMember fm = FindDocumentedMember (mc, type, memberName, parameterTypes, ds, out warnResult, cref, true, name); + if (warnResult > 0) return; - if (mi != null) { - xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + type.FullName.Replace ("+", ".") + "." + memberName + parameters); + if (!fm.IsEmpty) { + MemberInfo mi = fm.Member; + // we cannot use 'type' directly + // to get its name, since mi + // could be from DeclaringType + // for nested types. + xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + GetSignatureForDoc (fm.Type) + "." + memberName + GetParametersFormatted (mi)); return; // a member of a type } } } else { int warnResult; - MemberInfo mi = FindDocumentedMember (mc, ds.TypeBuilder, name, parameterTypes, ds, out warnResult, cref); - if (warnResult == 419) - Report419 (mc, name, mi); - else if (warnResult > 0) + FoundMember fm = FindDocumentedMember (mc, ds.TypeBuilder, name, parameterTypes, ds, out warnResult, cref, true, name); + if (warnResult > 0) return; - if (mi != null) { - xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + ds.TypeBuilder.FullName.Replace ("+", ".") + "." + name); + if (!fm.IsEmpty) { + MemberInfo mi = fm.Member; + // we cannot use 'type' directly + // to get its name, since mi + // could be from DeclaringType + // for nested types. + xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + GetSignatureForDoc (fm.Type) + "." + name + GetParametersFormatted (mi)); return; // local member name } } + // It still might be part of namespace name. + Namespace ns = ds.NamespaceEntry.NS.GetNamespace (name, false); + if (ns != null) { + xref.SetAttribute ("cref", "N:" + ns.FullName); + return; // a namespace + } + if (RootNamespace.Global.IsNamespace (name)) { + xref.SetAttribute ("cref", "N:" + name); + return; // a namespace + } + Report.Warning (1574, 1, mc.Location, "XML comment on `{0}' has cref attribute `{1}' that could not be resolved", mc.GetSignatureForError (), cref); xref.SetAttribute ("cref", "!:" + name); } - static void Report419 (MemberCore mc, string memberName, MemberInfo mi) + static string GetParametersFormatted (MemberInfo mi) + { + MethodBase mb = mi as MethodBase; + bool isSetter = false; + PropertyInfo pi = mi as PropertyInfo; + if (pi != null) { + mb = pi.GetGetMethod (); + if (mb == null) { + isSetter = true; + mb = pi.GetSetMethod (); + } + } + if (mb == null) + return String.Empty; + + ParameterData parameters = TypeManager.GetParameterData (mb); + if (parameters == null || parameters.Count == 0) + return String.Empty; + + StringBuilder sb = new StringBuilder (); + sb.Append ('('); + for (int i = 0; i < parameters.Count; i++) { + if (isSetter && i + 1 == parameters.Count) + break; // skip "value". + if (i > 0) + sb.Append (','); + Type t = parameters.ParameterType (i); + sb.Append (GetSignatureForDoc (t)); + } + sb.Append (')'); + return sb.ToString (); + } + + static string GetBodyIdentifierFromName (string name) + { + string identifier = name; + + if (name.Length > 0 && name [name.Length - 1] == ']') { + string tmp = name.Substring (0, name.Length - 1).Trim (wsChars); + int last = tmp.LastIndexOf ('['); + if (last > 0) + identifier = tmp.Substring (0, last).Trim (wsChars); + } + + return identifier; + } + + static void Report419 (MemberCore mc, string memberName, MemberInfo [] mis) { Report.Warning (419, 3, mc.Location, - "Ambiguous reference in cref attribute `{0}'. Assuming `{1}' but other overloads including `{1}' have also matched", - memberName, TypeManager.GetFullNameSignature (mi)); + "Ambiguous reference in cref attribute `{0}'. Assuming `{1}' but other overloads including `{2}' have also matched", + memberName, + TypeManager.GetFullNameSignature (mis [0]), + TypeManager.GetFullNameSignature (mis [1])); } // @@ -674,20 +858,15 @@ namespace Mono.CSharp { public static string GetMethodDocCommentName (MethodCore mc, DeclSpace ds) { Parameter [] plist = mc.Parameters.FixedParameters; - Parameter parr = mc.Parameters.ArrayParameter; string paramSpec = String.Empty; if (plist != null) { StringBuilder psb = new StringBuilder (); foreach (Parameter p in plist) { psb.Append (psb.Length != 0 ? "," : "("); - psb.Append (p.ParameterType.FullName.Replace ("+", ".")); + psb.Append (GetSignatureForDoc (p.ExternalType ())); } paramSpec = psb.ToString (); } - if (parr != null) - paramSpec += String.Concat ( - paramSpec == String.Empty ? "(" : ",", - parr.ParameterType.FullName.Replace ("+", ".")); if (paramSpec.Length > 0) paramSpec += ")"; @@ -699,13 +878,20 @@ namespace Mono.CSharp { switch (op.OperatorType) { case Operator.OpType.Implicit: case Operator.OpType.Explicit: - suffix = "~" + op.OperatorMethodBuilder.ReturnType.FullName.Replace ('+', '.'); + suffix = "~" + GetSignatureForDoc (op.MethodBuilder.ReturnType); break; } } return String.Concat (mc.DocCommentHeader, ds.Name, ".", name, paramSpec, suffix); } + static string GetSignatureForDoc (Type type) + { + return TypeManager.IsGenericParameter (type) ? + "`" + TypeManager.GenericParameterPosition (type) : + type.FullName.Replace ("+", ".").Replace ('&', '@'); + } + // // Raised (and passed an XmlElement that contains the comment) // when GenerateDocComment is writing documentation expectedly. @@ -714,13 +900,13 @@ namespace Mono.CSharp { // that means removal of DOM use. // internal static void OnMethodGenerateDocComment ( - MethodCore mc, DeclSpace ds, XmlElement el) + MethodCore mc, XmlElement el) { Hashtable paramTags = new Hashtable (); foreach (XmlElement pelem in el.SelectNodes ("param")) { int i; string xname = pelem.GetAttribute ("name"); - if (xname == "") + if (xname.Length == 0) continue; // really? but MS looks doing so if (xname != "" && mc.Parameters.GetParameterByName (xname, out i) == null) Report.Warning (1572, 2, mc.Location, "XML comment on `{0}' has a param tag for `{1}', but there is no parameter by that name", @@ -731,12 +917,10 @@ namespace Mono.CSharp { paramTags [xname] = xname; } Parameter [] plist = mc.Parameters.FixedParameters; - if (plist != null) { - foreach (Parameter p in plist) { - if (paramTags.Count > 0 && paramTags [p.Name] == null) - Report.Warning (1573, 4, mc.Location, "Parameter `{0}' has no matching param tag in the XML comment for `{1}'", - p.Name, mc.GetSignatureForError ()); - } + foreach (Parameter p in plist) { + if (paramTags.Count > 0 && paramTags [p.Name] == null) + Report.Warning (1573, 4, mc.Location, "Parameter `{0}' has no matching param tag in the XML comment for `{1}'", + p.Name, mc.GetSignatureForError ()); } } @@ -744,6 +928,8 @@ namespace Mono.CSharp { { if (name.Length > 0 && name [0] == '@') name = name.Substring (1); + else if (name == "this") + name = "Item"; else if (Tokenizer.IsKeyword (name) && !IsTypeName (name)) Report.Warning (1041, 1, mc.Location, "Identifier expected. `{0}' is a keyword", name); } @@ -803,13 +989,6 @@ namespace Mono.CSharp { // public Hashtable StoredDocuments = new Hashtable (); - // - // Stores comments on partial types (should handle uniquely). - // Keys are PartialContainers, values are comment strings - // (didn't use StringBuilder; usually we have just 2 or more). - // - public IDictionary PartialComments = new ListDictionary (); - // // Outputs XML documentation comment from tokenized comments. // @@ -849,7 +1028,7 @@ namespace Mono.CSharp { // public void GenerateDocComment () { - TypeContainer root = RootContext.Tree.Types; + TypeContainer root = RootContext.ToplevelTypes; if (root.Interfaces != null) foreach (Interface i in root.Interfaces) DocUtil.GenerateTypeDocComment (i, null); @@ -858,15 +1037,6 @@ namespace Mono.CSharp { foreach (TypeContainer tc in root.Types) DocUtil.GenerateTypeDocComment (tc, null); - if (root.Parts != null) { - IDictionary comments = PartialComments; - foreach (ClassPart cp in root.Parts) { - if (cp.DocComment == null) - continue; - comments [cp] = cp; - } - } - if (root.Delegates != null) foreach (Delegate d in root.Delegates) DocUtil.GenerateDocComment (d, null); @@ -875,18 +1045,7 @@ namespace Mono.CSharp { foreach (Enum e in root.Enums) e.GenerateDocComment (null); - IDictionary table = new ListDictionary (); - foreach (ClassPart cp in PartialComments.Keys) { - // FIXME: IDictionary does not guarantee that the keys will be - // accessed in the order they were added. - table [cp.PartialContainer] += cp.DocComment; - } - foreach (PartialContainer pc in table.Keys) { - pc.DocComment = table [pc] as string; - DocUtil.GenerateDocComment (pc, null); - } } } } - #endif