// Author:
// Atsushi Enomoto <atsushi@ximian.com>
//
-// Licensed under the terms of the GNU GPL
+// Dual licensed under the terms of the MIT X11 or GNU GPL
//
-// (C) 2004 Novell, Inc.
+// Copyright 2004 Novell, Inc.
//
//
-#if ! BOOTSTRAP_WITH_OLDLIB
+
using System;
-using System.Collections;
-using System.Collections.Specialized;
+using System.Collections.Generic;
using System.IO;
-using System.Reflection;
-using System.Reflection.Emit;
-using System.Runtime.CompilerServices;
-using System.Runtime.InteropServices;
-using System.Security;
-using System.Security.Permissions;
using System.Text;
using System.Xml;
+using System.Linq;
-using Mono.CompilerServices.SymbolWriter;
namespace Mono.CSharp {
//
// Support class for XML documentation.
//
-#if NET_2_0
- static
-#else
- abstract
-#endif
- public class DocUtil
+ static class DocUtil
{
-#if !NET_2_0
- private DocUtil () {}
-#endif
// TypeContainer
//
// handle warning report.
//
internal static void GenerateTypeDocComment (TypeContainer t,
- DeclSpace ds)
+ DeclSpace ds, Report Report)
{
- GenerateDocComment (t, ds);
+ GenerateDocComment (t, ds, Report);
if (t.DefaultStaticConstructor != null)
t.DefaultStaticConstructor.GenerateDocComment (t);
foreach (TypeContainer tc in t.Types)
tc.GenerateDocComment (t);
- 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);
-
if (t.Constants != null)
foreach (Const c in t.Constants)
c.GenerateDocComment (t);
p.GenerateDocComment (t);
if (t.Methods != null)
- foreach (Method m in t.Methods)
+ foreach (MethodOrOperator m in t.Methods)
m.GenerateDocComment (t);
if (t.Operators != null)
}
// MemberCore
- private static readonly string lineHead =
+ private static readonly string line_head =
Environment.NewLine + " ";
private static XmlNode GetDocCommentNode (MemberCore mc,
- string name)
+ string name, Report Report)
{
// FIXME: It could be even optimizable as not
// to use XmlDocument. But anyways the nodes
if (s.Length > 0)
split [j++] = s;
}
- el.InnerXml = lineHead + String.Join (
- lineHead, split, 0, j);
+ el.InnerXml = line_head + String.Join (
+ line_head, split, 0, j);
return el;
- } catch (XmlException ex) {
+ } catch (Exception ex) {
Report.Warning (1570, 1, mc.Location, "XML comment on `{0}' has non-well-formed XML ({1})", name, ex.Message);
XmlComment com = doc.CreateComment (String.Format ("FIXME: Invalid documentation markup was found for member {0}", name));
return com;
// handle warning report.
//
internal static void GenerateDocComment (MemberCore mc,
- DeclSpace ds)
+ DeclSpace ds, Report Report)
{
if (mc.DocComment != null) {
string name = mc.GetDocCommentName (ds);
- XmlNode n = GetDocCommentNode (mc, name);
+ XmlNode n = GetDocCommentNode (mc, name, Report);
XmlElement el = n as XmlElement;
if (el != null) {
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);
+ var al = new List<XmlNode> (nl.Count);
foreach (XmlNode inc in nl)
al.Add (inc);
foreach (XmlElement inc in al)
- if (!HandleInclude (mc, inc))
+ if (!HandleInclude (mc, inc, Report))
inc.ParentNode.RemoveChild (inc);
}
// FIXME: it could be done with XmlReader
- DeclSpace dsTarget = mc as DeclSpace;
- if (dsTarget == null)
- dsTarget = ds;
+ DeclSpace ds_target = mc as DeclSpace;
+ if (ds_target == null)
+ ds_target = ds;
foreach (XmlElement see in n.SelectNodes (".//see"))
- HandleSee (mc, dsTarget, see);
+ HandleSee (mc, ds_target, see, Report);
foreach (XmlElement seealso in n.SelectNodes (".//seealso"))
- HandleSeeAlso (mc, dsTarget, seealso);
+ HandleSeeAlso (mc, ds_target, seealso ,Report);
foreach (XmlElement see in n.SelectNodes (".//exception"))
- HandleException (mc, dsTarget, see);
+ HandleException (mc, ds_target, see, Report);
}
n.WriteTo (RootContext.Documentation.XmlCommentOutput);
// Processes "include" element. Check included file and
// embed the document content inside this documentation node.
//
- private static bool HandleInclude (MemberCore mc, XmlElement el)
+ private static bool HandleInclude (MemberCore mc, XmlElement el, Report Report)
{
- bool keepIncludeNode = false;
+ bool keep_include_node = 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;
+ keep_include_node = true;
}
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;
+ keep_include_node = true;
}
else {
- XmlDocument doc = RootContext.Documentation.StoredDocuments [file] as XmlDocument;
- if (doc == null) {
+ XmlDocument doc;
+ if (!RootContext.Documentation.StoredDocuments.TryGetValue (file, out doc)) {
try {
doc = new XmlDocument ();
doc.Load (file);
if (nl.Count == 0) {
el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" No matching elements were found for the include tag embedded here. "), el);
- keepIncludeNode = true;
+ keep_include_node = true;
}
foreach (XmlNode n in nl)
el.ParentNode.InsertBefore (el.OwnerDocument.ImportNode (n, true), el);
}
}
}
- return keepIncludeNode;
+ return keep_include_node;
}
//
// Handles <see> elements.
//
private static void HandleSee (MemberCore mc,
- DeclSpace ds, XmlElement see)
+ DeclSpace ds, XmlElement see, Report r)
{
- HandleXrefCommon (mc, ds, see);
+ HandleXrefCommon (mc, ds, see, r);
}
//
// Handles <seealso> elements.
//
private static void HandleSeeAlso (MemberCore mc,
- DeclSpace ds, XmlElement seealso)
+ DeclSpace ds, XmlElement seealso, Report r)
{
- HandleXrefCommon (mc, ds, seealso);
+ HandleXrefCommon (mc, ds, seealso, r);
}
//
// Handles <exception> elements.
//
private static void HandleException (MemberCore mc,
- DeclSpace ds, XmlElement seealso)
+ DeclSpace ds, XmlElement seealso, Report r)
{
- HandleXrefCommon (mc, ds, seealso);
+ HandleXrefCommon (mc, ds, seealso, r);
}
static readonly char [] wsChars =
// returns a full runtime type name from a name which might
// be C# specific type name.
//
- private static Type FindDocumentedType (MemberCore mc, string name, DeclSpace ds, string cref)
+ private static TypeSpec FindDocumentedType (MemberCore mc, string name, DeclSpace ds, string cref, Report r)
{
- bool isArray = false;
+ bool is_array = false;
string identifier = name;
if (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);
- isArray = true;
+ is_array = true;
}
}
- Type t = FindDocumentedTypeNonArray (mc, identifier, ds, cref);
- if (t != null && isArray)
- t = Array.CreateInstance (t, 0).GetType ();
+ TypeSpec t = FindDocumentedTypeNonArray (mc, identifier, ds, cref, r);
+ if (t != null && is_array)
+ t = ArrayContainer.MakeType (t);
return t;
}
- private static Type FindDocumentedTypeNonArray (MemberCore mc,
- string identifier, DeclSpace ds, string cref)
+ private static TypeSpec FindDocumentedTypeNonArray (MemberCore mc,
+ string identifier, DeclSpace ds, string cref, Report r)
{
switch (identifier) {
case "int":
- return typeof (int);
+ return TypeManager.int32_type;
case "uint":
- return typeof (uint);
+ return TypeManager.uint32_type;
case "short":
- return typeof (short);
+ return TypeManager.short_type;;
case "ushort":
- return typeof (ushort);
+ return TypeManager.ushort_type;
case "long":
- return typeof (long);
+ return TypeManager.int64_type;
case "ulong":
- return typeof (ulong);
+ return TypeManager.uint64_type;;
case "float":
- return typeof (float);
+ return TypeManager.float_type;;
case "double":
- return typeof (double);
+ return TypeManager.double_type;
case "char":
- return typeof (char);
+ return TypeManager.char_type;;
case "decimal":
- return typeof (decimal);
+ return TypeManager.decimal_type;;
case "byte":
- return typeof (byte);
+ return TypeManager.byte_type;;
case "sbyte":
- return typeof (sbyte);
+ return TypeManager.sbyte_type;;
case "object":
- return typeof (object);
+ return TypeManager.object_type;;
case "bool":
- return typeof (bool);
+ return TypeManager.bool_type;;
case "string":
- return typeof (string);
+ return TypeManager.string_type;;
case "void":
- return typeof (void);
+ return TypeManager.void_type;;
}
- FullNamedExpression e = ds.LookupType (identifier, mc.Location, false);
+ FullNamedExpression e = ds.LookupNamespaceOrType (identifier, 0, mc.Location, false);
if (e != null) {
if (!(e is TypeExpr))
return null;
int index = identifier.LastIndexOf ('.');
if (index < 0)
return null;
+
+ var nsName = identifier.Substring (0, index);
+ var typeName = identifier.Substring (index + 1);
+ Namespace ns = ds.NamespaceEntry.NS.GetNamespace (nsName, false);
+ ns = ns ?? mc.Module.GlobalRootNamespace.GetNamespace(nsName, false);
+ if (ns != null) {
+ var te = ns.LookupType(mc.Compiler, typeName, 0, true, mc.Location);
+ if(te != null)
+ return te.Type;
+ }
+
int warn;
- Type parent = FindDocumentedType (mc, identifier.Substring (0, index), ds, cref);
+ TypeSpec parent = FindDocumentedType (mc, identifier.Substring (0, index), ds, cref, r);
if (parent == null)
return null;
// no need to detect warning 419 here
- return FindDocumentedMember (mc, parent,
+ var ts = FindDocumentedMember (mc, parent,
identifier.Substring (index + 1),
- 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;
- }
+ null, ds, out warn, cref, false, null, r) as TypeSpec;
+ if (ts != null)
+ return ts;
+ return null;
}
//
// Returns a MemberInfo that is referenced in XML documentation
// (by "see" or "seealso" elements).
//
- private static FoundMember FindDocumentedMember (MemberCore mc,
- Type type, string memberName, Type [] paramList,
- DeclSpace ds, out int warningType, string cref,
- bool warn419, string nameForError)
+ private static MemberSpec FindDocumentedMember (MemberCore mc,
+ TypeSpec type, string member_name, AParametersCollection param_list,
+ DeclSpace ds, out int warning_type, string cref,
+ bool warn419, string name_for_error, Report r)
{
- for (; type != null; type = type.DeclaringType) {
- MemberInfo mi = FindDocumentedMemberNoNest (
- mc, type, memberName, paramList, ds,
- out warningType, cref, warn419,
- nameForError);
+// for (; type != null; type = type.DeclaringType) {
+ var mi = FindDocumentedMemberNoNest (
+ mc, type, member_name, param_list, ds,
+ out warning_type, cref, warn419,
+ name_for_error, r);
if (mi != null)
- return new FoundMember (type, mi);
- }
- warningType = 0;
- return FoundMember.Empty;
+ return mi; // new FoundMember (type, mi);
+// }
+ warning_type = 0;
+ return null;
}
- private static MemberInfo FindDocumentedMemberNoNest (
- MemberCore mc, Type type, string memberName,
- Type [] paramList, DeclSpace ds, out int warningType,
- string cref, bool warn419, string nameForError)
+ private static MemberSpec FindDocumentedMemberNoNest (
+ MemberCore mc, TypeSpec type, string member_name,
+ AParametersCollection param_list, DeclSpace ds, out int warning_type,
+ string cref, bool warn419, string name_for_error, Report Report)
{
- warningType = 0;
- MemberInfo [] mis;
+ warning_type = 0;
+// var filter = new MemberFilter (member_name, 0, MemberKind.All, param_list, null);
+ IList<MemberSpec> found = null;
+ while (type != null && found == null) {
+ found = MemberCache.FindMembers (type, member_name, false);
+ type = type.DeclaringType;
+ }
+
+ if (found == null)
+ return null;
+
+ if (warn419 && found.Count > 1) {
+ Report419 (mc, name_for_error, found.ToArray (), Report);
+ }
- if (paramList == null) {
+ return found [0];
+
+/*
+ if (param_list == null) {
// search for fields/events etc.
mis = TypeManager.MemberLookup (type, null,
- type, MemberTypes.All,
- BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
- memberName, null);
+ type, MemberKind.All,
+ BindingRestriction.None,
+ member_name, null);
mis = FilterOverridenMembersOut (mis);
if (mis == null || mis.Length == 0)
return null;
if (warn419 && IsAmbiguous (mis))
- Report419 (mc, nameForError, mis);
+ Report419 (mc, name_for_error, mis, Report);
return mis [0];
}
- MethodSignature msig = new MethodSignature (memberName, null, paramList);
+ MethodSignature msig = new MethodSignature (member_name, null, param_list);
mis = FindMethodBase (type,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
msig);
if (warn419 && mis.Length > 0) {
if (IsAmbiguous (mis))
- Report419 (mc, nameForError, mis);
+ Report419 (mc, name_for_error, mis, Report);
return mis [0];
}
// search for operators (whose parameters exactly
// matches with the list) and possibly report CS1581.
string oper = null;
- string returnTypeName = null;
- if (memberName.StartsWith ("implicit operator ")) {
- oper = "op_Implicit";
- returnTypeName = memberName.Substring (18).Trim (wsChars);
+ string return_type_name = null;
+ if (member_name.StartsWith ("implicit operator ")) {
+ Operator.GetMetadataName (Operator.OpType.Implicit);
+ return_type_name = member_name.Substring (18).Trim (wsChars);
}
- else if (memberName.StartsWith ("explicit operator ")) {
- oper = "op_Explicit";
- returnTypeName = memberName.Substring (18).Trim (wsChars);
+ else if (member_name.StartsWith ("explicit operator ")) {
+ oper = Operator.GetMetadataName (Operator.OpType.Explicit);
+ return_type_name = member_name.Substring (18).Trim (wsChars);
}
- else if (memberName.StartsWith ("operator ")) {
- oper = memberName.Substring (9).Trim (wsChars);
+ else if (member_name.StartsWith ("operator ")) {
+ oper = member_name.Substring (9).Trim (wsChars);
switch (oper) {
// either unary or binary
case "+":
- oper = paramList.Length == 2 ?
- Binary.oper_names [(int) Binary.Operator.Addition] :
- Unary.oper_names [(int) Unary.Operator.UnaryPlus];
+ oper = param_list.Length == 2 ?
+ Operator.GetMetadataName (Operator.OpType.Addition) :
+ Operator.GetMetadataName (Operator.OpType.UnaryPlus);
break;
case "-":
- oper = paramList.Length == 2 ?
- Binary.oper_names [(int) Binary.Operator.Subtraction] :
- Unary.oper_names [(int) Unary.Operator.UnaryNegation];
+ oper = param_list.Length == 2 ?
+ Operator.GetMetadataName (Operator.OpType.Subtraction) :
+ Operator.GetMetadataName (Operator.OpType.UnaryNegation);
break;
- // unary
- case "!":
- oper = Unary.oper_names [(int) Unary.Operator.LogicalNot]; break;
- case "~":
- oper = Unary.oper_names [(int) Unary.Operator.OnesComplement]; break;
-
- case "++":
- oper = "op_Increment"; break;
- case "--":
- oper = "op_Decrement"; break;
- case "true":
- oper = "op_True"; break;
- case "false":
- oper = "op_False"; break;
- // binary
- case "*":
- oper = Binary.oper_names [(int) Binary.Operator.Multiply]; break;
- case "/":
- oper = Binary.oper_names [(int) Binary.Operator.Division]; break;
- case "%":
- oper = Binary.oper_names [(int) Binary.Operator.Modulus]; break;
- case "&":
- oper = Binary.oper_names [(int) Binary.Operator.BitwiseAnd]; break;
- case "|":
- oper = Binary.oper_names [(int) Binary.Operator.BitwiseOr]; break;
- case "^":
- oper = Binary.oper_names [(int) Binary.Operator.ExclusiveOr]; break;
- case "<<":
- oper = Binary.oper_names [(int) Binary.Operator.LeftShift]; break;
- case ">>":
- oper = Binary.oper_names [(int) Binary.Operator.RightShift]; break;
- case "==":
- oper = Binary.oper_names [(int) Binary.Operator.Equality]; break;
- case "!=":
- oper = Binary.oper_names [(int) Binary.Operator.Inequality]; break;
- case "<":
- oper = Binary.oper_names [(int) Binary.Operator.LessThan]; break;
- case ">":
- oper = Binary.oper_names [(int) Binary.Operator.GreaterThan]; break;
- case "<=":
- oper = Binary.oper_names [(int) Binary.Operator.LessThanOrEqual]; break;
- case ">=":
- oper = Binary.oper_names [(int) Binary.Operator.GreaterThanOrEqual]; break;
default:
- warningType = 1584;
- Report.Warning (1020, 1, mc.Location, "Overloadable {0} operator is expected", paramList.Length == 2 ? "binary" : "unary");
+ oper = Operator.GetMetadataName (oper);
+ if (oper != null)
+ break;
+
+ warning_type = 1584;
+ Report.Warning (1020, 1, mc.Location, "Overloadable {0} operator is expected", param_list.Length == 2 ? "binary" : "unary");
Report.Warning (1584, 1, mc.Location, "XML comment on `{0}' has syntactically incorrect cref attribute `{1}'",
mc.GetSignatureForError (), cref);
return null;
}
// here we still don't consider return type (to
// detect CS1581 or CS1002+CS1584).
- msig = new MethodSignature (oper, null, paramList);
+ msig = new MethodSignature (oper, null, param_list);
mis = FindMethodBase (type,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
msig);
if (mis.Length == 0)
return null; // CS1574
- MemberInfo mi = mis [0];
- Type expected = mi is MethodInfo ?
- ((MethodInfo) mi).ReturnType :
- mi is PropertyInfo ?
- ((PropertyInfo) mi).PropertyType :
+ var mi = mis [0];
+ TypeSpec expected = mi is MethodSpec ?
+ ((MethodSpec) mi).ReturnType :
+ mi is PropertySpec ?
+ ((PropertySpec) mi).PropertyType :
null;
- if (returnTypeName != null) {
- Type returnType = FindDocumentedType (mc, returnTypeName, ds, cref);
+ if (return_type_name != null) {
+ TypeSpec returnType = FindDocumentedType (mc, return_type_name, ds, cref, Report);
if (returnType == null || returnType != expected) {
- warningType = 1581;
+ warning_type = 1581;
Report.Warning (1581, 1, mc.Location, "Invalid return type in XML comment cref attribute `{0}'", cref);
return null;
}
}
return mis [0];
- }
-
- private static bool IsAmbiguous (MemberInfo [] members)
- {
- if (members.Length < 2)
- return false;
- if (members.Length > 2)
- return true;
- if (members [0] is EventInfo && members [1] is FieldInfo)
- return false;
- if (members [1] is EventInfo && members [0] is FieldInfo)
- return false;
- return true;
+*/
}
//
// Checks cref attribute.
//
private static void HandleXrefCommon (MemberCore mc,
- DeclSpace ds, XmlElement xref)
+ DeclSpace ds, XmlElement xref, Report Report)
{
string cref = xref.GetAttribute ("cref").Trim (wsChars);
// when, XmlReader, "if (cref == null)"
string name; // method invokation "(...)" are removed
string parameters; // method parameter list
- // strip 'T:' 'M:' 'F:' 'P:' 'E:' etc.
- // Here, MS ignores its member kind. No idea why.
+ // When it found '?:' ('T:' 'M:' 'F:' 'P:' 'E:' etc.),
+ // MS ignores not only its member kind, but also
+ // the entire syntax correctness. Nor it also does
+ // type fullname resolution i.e. "T:List(int)" is kept
+ // as T:List(int), not
+ // T:System.Collections.Generic.List<System.Int32>
if (cref.Length > 2 && cref [1] == ':')
- signature = cref.Substring (2).Trim (wsChars);
+ return;
else
signature = cref;
- int parensPos = signature.IndexOf ('(');
- int bracePos = parensPos >= 0 ? -1 :
+ // Also note that without "T:" any generic type
+ // indication fails.
+
+ int parens_pos = signature.IndexOf ('(');
+ int brace_pos = parens_pos >= 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).Trim (wsChars);
+ if (parens_pos > 0 && signature [signature.Length - 1] == ')') {
+ name = signature.Substring (0, parens_pos).Trim (wsChars);
+ parameters = signature.Substring (parens_pos + 1, signature.Length - parens_pos - 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 if (brace_pos > 0 && signature [signature.Length - 1] == ']') {
+ name = signature.Substring (0, brace_pos).Trim (wsChars);
+ parameters = signature.Substring (brace_pos + 1, signature.Length - brace_pos - 2).Trim (wsChars);
}
else {
name = signature;
parameters = null;
}
- Normalize (mc, ref name);
+ Normalize (mc, ref name, Report);
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 = GetBodyIdentifierFromName (nameElems [i]);
+ string [] name_elems = identifier.Split ('.');
+ for (int i = 0; i < name_elems.Length; i++) {
+ string nameElem = GetBodyIdentifierFromName (name_elems [i]);
if (i > 0)
- Normalize (mc, ref nameElem);
+ Normalize (mc, ref nameElem, Report);
if (!Tokenizer.IsValidIdentifier (nameElem)
&& nameElem.IndexOf ("operator") < 0) {
Report.Warning (1584, 1, mc.Location, "XML comment on `{0}' has syntactically incorrect cref attribute `{1}'",
}
// check if parameters are valid
- Type [] parameterTypes;
+ AParametersCollection parameter_types;
if (parameters == null)
- parameterTypes = null;
+ parameter_types = null;
else if (parameters.Length == 0)
- parameterTypes = Type.EmptyTypes;
+ parameter_types = ParametersCompiled.EmptyReadOnlyParameters;
else {
- string [] paramList = parameters.Split (',');
- ArrayList plist = new ArrayList ();
- for (int i = 0; i < paramList.Length; i++) {
- string paramTypeName = paramList [i].Trim (wsChars);
- Normalize (mc, ref paramTypeName);
- Type paramType = FindDocumentedType (mc, paramTypeName, ds, cref);
- if (paramType == null) {
+ string [] param_list = parameters.Split (',');
+ var plist = new List<TypeSpec> ();
+ for (int i = 0; i < param_list.Length; i++) {
+ string param_type_name = param_list [i].Trim (wsChars);
+ Normalize (mc, ref param_type_name, Report);
+ TypeSpec param_type = FindDocumentedType (mc, param_type_name, ds, cref, Report);
+ if (param_type == null) {
Report.Warning (1580, 1, mc.Location, "Invalid type for parameter `{0}' in XML comment cref attribute `{1}'",
(i + 1).ToString (), cref);
return;
}
- plist.Add (paramType);
+ plist.Add (param_type);
}
- parameterTypes = plist.ToArray (typeof (Type)) as Type [];
+
+ parameter_types = ParametersCompiled.CreateFullyResolved (plist.ToArray ());
}
- Type type = FindDocumentedType (mc, name, ds, cref);
+ TypeSpec type = FindDocumentedType (mc, name, ds, cref, Report);
if (type != null
// delegate must not be referenced with args
- && (!type.IsSubclassOf (typeof (System.Delegate))
- || parameterTypes == null)) {
+ && (!type.IsDelegate
+ || parameter_types == null)) {
string result = GetSignatureForDoc (type)
- + (bracePos < 0 ? String.Empty : signature.Substring (bracePos));
+ + (brace_pos < 0 ? String.Empty : signature.Substring (brace_pos));
xref.SetAttribute ("cref", "T:" + result);
return; // a type
}
int period = name.LastIndexOf ('.');
if (period > 0) {
string typeName = name.Substring (0, period);
- string memberName = name.Substring (period + 1);
- Normalize (mc, ref memberName);
- type = FindDocumentedType (mc, typeName, ds, cref);
- int warnResult;
+ string member_name = name.Substring (period + 1);
+ string lookup_name = member_name == "this" ? MemberCache.IndexerNameAlias : member_name;
+ Normalize (mc, ref lookup_name, Report);
+ Normalize (mc, ref member_name, Report);
+ type = FindDocumentedType (mc, typeName, ds, cref, Report);
+ int warn_result;
if (type != null) {
- FoundMember fm = FindDocumentedMember (mc, type, memberName, parameterTypes, ds, out warnResult, cref, true, name);
- if (warnResult > 0)
+ var mi = FindDocumentedMember (mc, type, lookup_name, parameter_types, ds, out warn_result, cref, true, name, Report);
+ if (warn_result > 0)
return;
- if (!fm.IsEmpty) {
- MemberInfo mi = fm.Member;
+ if (mi != null) {
// 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));
+ xref.SetAttribute ("cref", GetMemberDocHead (mi) + GetSignatureForDoc (mi.DeclaringType) + "." + member_name + GetParametersFormatted (mi));
return; // a member of a type
}
}
- }
- else {
- int warnResult;
- FoundMember fm = FindDocumentedMember (mc, ds.TypeBuilder, name, parameterTypes, ds, out warnResult, cref, true, name);
- if (warnResult > 0)
+ } else {
+ int warn_result;
+ var mi = FindDocumentedMember (mc, ds.PartialContainer.Definition, name, parameter_types, ds, out warn_result, cref, true, name, Report);
+
+ if (warn_result > 0)
return;
- if (!fm.IsEmpty) {
- MemberInfo mi = fm.Member;
+ if (mi != null) {
// 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));
+ xref.SetAttribute ("cref", GetMemberDocHead (mi) + GetSignatureForDoc (mi.DeclaringType) + "." + 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);
+ xref.SetAttribute ("cref", "N:" + ns.GetSignatureForError ());
return; // a namespace
}
- if (RootNamespace.Global.IsNamespace (name)) {
+ if (mc.Module.GlobalRootNamespace.IsNamespace (name)) {
xref.SetAttribute ("cref", "N:" + name);
return; // a namespace
}
xref.SetAttribute ("cref", "!:" + name);
}
- static string GetParametersFormatted (MemberInfo mi)
+ static string GetParametersFormatted (MemberSpec 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;
+ var pm = mi as IParametersMember;
+ if (pm == null || pm.Parameters.IsEmpty)
+ return string.Empty;
- ParameterData parameters = TypeManager.GetParameterData (mb);
+ AParametersCollection parameters = pm.Parameters;
+/*
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 (is_setter && i + 1 == parameters.Count)
+// break; // skip "value".
if (i > 0)
sb.Append (',');
- Type t = parameters.ParameterType (i);
+ TypeSpec t = parameters.Types [i];
sb.Append (GetSignatureForDoc (t));
}
sb.Append (')');
return identifier;
}
- static void Report419 (MemberCore mc, string memberName, MemberInfo [] mis)
+ static void Report419 (MemberCore mc, string member_name, MemberSpec [] mis, Report Report)
{
Report.Warning (419, 3, mc.Location,
"Ambiguous reference in cref attribute `{0}'. Assuming `{1}' but other overloads including `{2}' have also matched",
- memberName,
+ member_name,
TypeManager.GetFullNameSignature (mis [0]),
TypeManager.GetFullNameSignature (mis [1]));
}
// Get a prefix from member type for XML documentation (used
// to formalize cref target name).
//
- static string GetMemberDocHead (MemberTypes type)
+ static string GetMemberDocHead (MemberSpec type)
{
- switch (type) {
- case MemberTypes.Constructor:
- case MemberTypes.Method:
+ if (type is FieldSpec)
+ return "F:";
+ if (type is MethodSpec)
return "M:";
- case MemberTypes.Event:
+ if (type is EventSpec)
return "E:";
- case MemberTypes.Field:
- return "F:";
- case MemberTypes.NestedType:
- case MemberTypes.TypeInfo:
- return "T:";
- case MemberTypes.Property:
+ if (type is PropertySpec)
return "P:";
- }
+ if (type is TypeSpec)
+ return "T:";
+
return "!:";
}
// Returns a string that represents the signature for this
// member which should be used in XML documentation.
//
- public static string GetMethodDocCommentName (MethodCore mc, DeclSpace ds)
+ public static string GetMethodDocCommentName (MemberCore mc, ParametersCompiled parameters, DeclSpace ds)
{
- Parameter [] plist = mc.Parameters.FixedParameters;
+ IParameterData [] plist = parameters.FixedParameters;
string paramSpec = String.Empty;
if (plist != null) {
StringBuilder psb = new StringBuilder ();
+ int i = 0;
foreach (Parameter p in plist) {
psb.Append (psb.Length != 0 ? "," : "(");
- psb.Append (GetSignatureForDoc (p.ExternalType ()));
+ psb.Append (GetSignatureForDoc (parameters.Types [i++]));
+ if ((p.ModFlags & Parameter.Modifier.ISBYREF) != 0)
+ psb.Append ('@');
}
paramSpec = psb.ToString ();
}
if (paramSpec.Length > 0)
paramSpec += ")";
- string name = mc is Constructor ? "#ctor" : mc.Name;
+ string name = mc.Name;
+ if (mc is Constructor)
+ name = "#ctor";
+ else if (mc is InterfaceMemberBase) {
+ var imb = (InterfaceMemberBase) mc;
+ name = imb.GetFullName (imb.ShortName);
+ }
+ name = name.Replace ('.', '#');
+
+ if (mc.MemberName.TypeArguments != null && mc.MemberName.TypeArguments.Count > 0)
+ name += "``" + mc.MemberName.CountTypeArguments;
+
string suffix = String.Empty;
Operator op = mc as Operator;
if (op != null) {
switch (op.OperatorType) {
case Operator.OpType.Implicit:
case Operator.OpType.Explicit:
- suffix = "~" + GetSignatureForDoc (op.MethodBuilder.ReturnType);
+ suffix = "~" + GetSignatureForDoc (op.ReturnType);
break;
}
}
return String.Concat (mc.DocCommentHeader, ds.Name, ".", name, paramSpec, suffix);
}
- static string GetSignatureForDoc (Type type)
+ static string GetSignatureForDoc (TypeSpec type)
{
- return TypeManager.IsGenericParameter (type) ?
- "`" + TypeManager.GenericParameterPosition (type) :
- type.FullName.Replace ("+", ".").Replace ('&', '@');
+ var tp = type as TypeParameterSpec;
+ if (tp != null) {
+ int c = 0;
+ type = type.DeclaringType;
+ while (type != null && type.DeclaringType != null) {
+ type = type.DeclaringType;
+ c += type.MemberDefinition.TypeParametersCount;
+ }
+ var prefix = tp.IsMethodOwned ? "``" : "`";
+ return prefix + (c + tp.DeclaredPosition);
+ }
+
+ var pp = type as PointerContainer;
+ if (pp != null)
+ return GetSignatureForDoc (pp.Element) + "*";
+
+ ArrayContainer ap = type as ArrayContainer;
+ if (ap != null)
+ return GetSignatureForDoc (ap.Element) +
+ ArrayContainer.GetPostfixSignature (ap.Rank);
+
+ if (TypeManager.IsGenericType (type)) {
+ string g = type.MemberDefinition.Namespace;
+ if (g != null && g.Length > 0)
+ g += '.';
+ int idx = type.Name.LastIndexOf ('`');
+ g += (idx < 0 ? type.Name : type.Name.Substring (0, idx)) + '{';
+ int argpos = 0;
+ foreach (TypeSpec t in TypeManager.GetTypeArguments (type))
+ g += (argpos++ > 0 ? "," : String.Empty) + GetSignatureForDoc (t);
+ g += '}';
+ return g;
+ }
+
+ string name = type.GetMetaInfo ().FullName != null ? type.GetMetaInfo ().FullName : type.Name;
+ return name.Replace ("+", ".").Replace ('&', '@');
}
//
// that means removal of DOM use.
//
internal static void OnMethodGenerateDocComment (
- MethodCore mc, XmlElement el)
+ MethodCore mc, XmlElement el, Report Report)
{
- Hashtable paramTags = new Hashtable ();
+ var paramTags = new Dictionary<string, string> ();
foreach (XmlElement pelem in el.SelectNodes ("param")) {
- int i;
string xname = pelem.GetAttribute ("name");
if (xname.Length == 0)
continue; // really? but MS looks doing so
- if (xname != "" && mc.Parameters.GetParameterByName (xname, out i) == null)
+ if (xname != "" && mc.ParameterInfo.GetParameterIndexByName (xname) < 0)
Report.Warning (1572, 2, mc.Location, "XML comment on `{0}' has a param tag for `{1}', but there is no parameter by that name",
mc.GetSignatureForError (), xname);
- else if (paramTags [xname] != null)
+ else if (paramTags.ContainsKey (xname))
Report.Warning (1571, 2, mc.Location, "XML comment on `{0}' has a duplicate param tag for `{1}'",
mc.GetSignatureForError (), xname);
paramTags [xname] = xname;
}
- Parameter [] plist = mc.Parameters.FixedParameters;
+ IParameterData [] plist = mc.ParameterInfo.FixedParameters;
foreach (Parameter p in plist) {
- if (paramTags.Count > 0 && paramTags [p.Name] == null)
+ if (paramTags.Count > 0 && !paramTags.ContainsKey (p.Name))
Report.Warning (1573, 4, mc.Location, "Parameter `{0}' has no matching param tag in the XML comment for `{1}'",
p.Name, mc.GetSignatureForError ());
}
}
- private static void Normalize (MemberCore mc, ref string name)
+ private static void Normalize (MemberCore mc, ref string name, Report Report)
{
if (name.Length > 0 && name [0] == '@')
name = name.Substring (1);
// Stores XmlDocuments that are included in XML documentation.
// Keys are included filenames, values are XmlDocuments.
//
- public Hashtable StoredDocuments = new Hashtable ();
+ public Dictionary<string, XmlDocument> StoredDocuments = new Dictionary<string, XmlDocument> ();
//
// Outputs XML documentation comment from tokenized comments.
//
- public bool OutputDocComment (string asmfilename)
+ public bool OutputDocComment (string asmfilename, Report Report)
{
XmlTextWriter w = null;
try {
w.WriteEndElement (); // assembly
w.WriteStartElement ("members");
XmlCommentOutput = w;
- GenerateDocComment ();
+ GenerateDocComment (Report);
w.WriteFullEndElement (); // members
w.WriteEndElement ();
w.WriteWhitespace (Environment.NewLine);
//
// Fixes full type name of each documented types/members up.
//
- public void GenerateDocComment ()
+ public void GenerateDocComment (Report r)
{
TypeContainer root = RootContext.ToplevelTypes;
- if (root.Interfaces != null)
- foreach (Interface i in root.Interfaces)
- DocUtil.GenerateTypeDocComment (i, null);
if (root.Types != null)
foreach (TypeContainer tc in root.Types)
- DocUtil.GenerateTypeDocComment (tc, null);
-
- if (root.Delegates != null)
- foreach (Delegate d in root.Delegates)
- DocUtil.GenerateDocComment (d, null);
-
- if (root.Enums != null)
- foreach (Enum e in root.Enums)
- e.GenerateDocComment (null);
-
+ DocUtil.GenerateTypeDocComment (tc, null, r);
}
}
}
-#endif
projects / mono.git / blobdiff