| 1 |
using System; |
| 2 |
using System.Xml; |
| 3 |
using System.Linq; |
| 4 |
using StringList = System.Collections.Generic.List<string>; |
| 5 |
using StringToStringMap = System.Collections.Generic.Dictionary<string, string>; |
| 6 |
using Mono.Documentation.Updater.Frameworks; |
| 7 |
|
| 8 |
namespace Mono.Documentation.Updater |
| 9 |
{ |
| 10 |
public class DocumentationMember |
| 11 |
{ |
| 12 |
public StringToStringMap MemberSignatures = new StringToStringMap (); |
| 13 |
public string ReturnType; |
| 14 |
public StringList Parameters; |
| 15 |
public StringList TypeParameters; |
| 16 |
public string MemberName; |
| 17 |
public string MemberType; |
| 18 |
|
| 19 |
/// <summary>Removes modreq and modopt from ReturnType, Parameters, and TypeParameters</summary> |
| 20 |
private void CleanTypes () |
| 21 |
{ |
| 22 |
ReturnType = MemberFormatter.RemoveMod (ReturnType); |
| 23 |
MemberType = MemberFormatter.RemoveMod (MemberType); |
| 24 |
|
| 25 |
if (Parameters != null) |
| 26 |
{ |
| 27 |
for (var i = 0; i < Parameters.Count; i++) |
| 28 |
Parameters[i] = MemberFormatter.RemoveMod (Parameters[i]); |
| 29 |
} |
| 30 |
|
| 31 |
if (TypeParameters != null) |
| 32 |
{ |
| 33 |
for (var i = 0; i < TypeParameters.Count; i++) |
| 34 |
TypeParameters[i] = MemberFormatter.RemoveMod (TypeParameters[i]); |
| 35 |
} |
| 36 |
} |
| 37 |
|
| 38 |
public DocumentationMember (XmlReader reader) |
| 39 |
{ |
| 40 |
MemberName = reader.GetAttribute ("MemberName"); |
| 41 |
int depth = reader.Depth; |
| 42 |
bool go = true; |
| 43 |
StringList p = new StringList (); |
| 44 |
StringList tp = new StringList (); |
| 45 |
do |
| 46 |
{ |
| 47 |
if (reader.NodeType != XmlNodeType.Element) |
| 48 |
continue; |
| 49 |
|
| 50 |
bool shouldUse = true; |
| 51 |
try |
| 52 |
{ |
| 53 |
string apistyle = reader.GetAttribute ("apistyle"); |
| 54 |
shouldUse = string.IsNullOrWhiteSpace (apistyle) || apistyle == "classic"; // only use this tag if it's an 'classic' style node |
| 55 |
} |
| 56 |
catch (Exception) { } |
| 57 |
switch (reader.Name) |
| 58 |
{ |
| 59 |
case "MemberSignature": |
| 60 |
if (shouldUse) |
| 61 |
{ |
| 62 |
MemberSignatures[reader.GetAttribute ("Language")] = reader.GetAttribute ("Value"); |
| 63 |
} |
| 64 |
break; |
| 65 |
case "MemberType": |
| 66 |
MemberType = reader.ReadElementString (); |
| 67 |
break; |
| 68 |
case "ReturnType": |
| 69 |
if (reader.Depth == depth + 2 && shouldUse) |
| 70 |
ReturnType = reader.ReadElementString (); |
| 71 |
break; |
| 72 |
case "Parameter": |
| 73 |
if (reader.Depth == depth + 2 && shouldUse) |
| 74 |
{ |
| 75 |
var ptype = reader.GetAttribute ("Type"); |
| 76 |
var reftypeAttribute = reader.GetAttribute ("RefType"); |
| 77 |
if (!ptype.EndsWith("&", StringComparison.Ordinal) && |
| 78 |
(reftypeAttribute == "out" || reftypeAttribute == "ref")) |
| 79 |
{ |
| 80 |
// let's add the `&` back, for comparisons |
| 81 |
ptype += '&'; |
| 82 |
} |
| 83 |
p.Add (ptype); |
| 84 |
} |
| 85 |
break; |
| 86 |
case "TypeParameter": |
| 87 |
if (reader.Depth == depth + 2 && shouldUse) |
| 88 |
tp.Add (reader.GetAttribute ("Name")); |
| 89 |
break; |
| 90 |
case "Docs": |
| 91 |
if (reader.Depth == depth + 1) |
| 92 |
go = false; |
| 93 |
break; |
| 94 |
} |
| 95 |
} while (go && reader.Read () && reader.Depth >= depth); |
| 96 |
if (p.Count > 0) |
| 97 |
{ |
| 98 |
Parameters = p; |
| 99 |
} |
| 100 |
if (tp.Count > 0) |
| 101 |
{ |
| 102 |
TypeParameters = tp; |
| 103 |
} |
| 104 |
else |
| 105 |
{ |
| 106 |
DiscernTypeParameters (); |
| 107 |
} |
| 108 |
|
| 109 |
CleanTypes (); |
| 110 |
} |
| 111 |
|
| 112 |
public DocumentationMember (XmlNode node, FrameworkTypeEntry typeEntry) |
| 113 |
{ |
| 114 |
MemberName = node.Attributes["MemberName"].Value; |
| 115 |
foreach (XmlNode n in node.SelectNodes ("MemberSignature")) |
| 116 |
{ |
| 117 |
XmlAttribute l = n.Attributes["Language"]; |
| 118 |
XmlAttribute v = n.Attributes["Value"]; |
| 119 |
XmlAttribute apistyle = n.Attributes["apistyle"]; |
| 120 |
bool shouldUse = apistyle == null || apistyle.Value == "classic"; |
| 121 |
if (l != null && v != null && shouldUse) |
| 122 |
MemberSignatures[l.Value] = v.Value; |
| 123 |
} |
| 124 |
MemberType = node.SelectSingleNode ("MemberType").InnerText; |
| 125 |
XmlNode rt = node.SelectSingleNode ("ReturnValue/ReturnType[not(@apistyle) or @apistyle='classic']"); |
| 126 |
if (rt != null) |
| 127 |
ReturnType = rt.InnerText; |
| 128 |
var p = node.SelectNodes ("Parameters/Parameter[not(@apistyle) or @apistyle='classic']").Cast<XmlElement>().ToArray (); |
| 129 |
if (p.Length > 0) |
| 130 |
{ |
| 131 |
Func<string, string, string> processType = (reftype, typename) => |
| 132 |
!typename.EndsWith("&", StringComparison.Ordinal) && (reftype == "ref" || reftype == "out") ? typename + '&' : typename; |
| 133 |
if (p.Any (para => para.HasAttribute ("Index"))) |
| 134 |
{ |
| 135 |
var pgroup = p |
| 136 |
.Select (para => new |
| 137 |
{ |
| 138 |
Index = para.GetAttribute ("Index"), |
| 139 |
Type = para.GetAttribute ("Type"), |
| 140 |
RefType = para.GetAttribute ("RefType") |
| 141 |
}) |
| 142 |
.GroupBy (para => new |
| 143 |
{ |
| 144 |
para.Index, |
| 145 |
Type = processType (para.RefType, para.Type) |
| 146 |
}) |
| 147 |
.ToArray (); |
| 148 |
|
| 149 |
Parameters = new StringList (pgroup.Length); |
| 150 |
Parameters.AddRange (pgroup.Select (pg => pg.Key.Type)); |
| 151 |
} |
| 152 |
else { |
| 153 |
var ptypes = p |
| 154 |
.Select (para => new |
| 155 |
{ |
| 156 |
Type = para.GetAttribute ("Type"), |
| 157 |
RefType = para.GetAttribute ("RefType") |
| 158 |
}) |
| 159 |
.Select (para => processType(para.RefType, para.Type)) |
| 160 |
.ToArray (); |
| 161 |
|
| 162 |
Parameters = new StringList (ptypes); |
| 163 |
} |
| 164 |
} |
| 165 |
XmlNodeList tp = node.SelectNodes ("TypeParameters/TypeParameter[not(@apistyle) or @apistyle='classic']"); |
| 166 |
if (tp.Count > 0) |
| 167 |
{ |
| 168 |
TypeParameters = new StringList (tp.Count); |
| 169 |
for (int i = 0; i < tp.Count; ++i) |
| 170 |
TypeParameters.Add (tp[i].Attributes["Name"].Value); |
| 171 |
} |
| 172 |
else |
| 173 |
{ |
| 174 |
DiscernTypeParameters (); |
| 175 |
} |
| 176 |
|
| 177 |
CleanTypes (); |
| 178 |
} |
| 179 |
|
| 180 |
void DiscernTypeParameters () |
| 181 |
{ |
| 182 |
// see if we can discern the param list from the name |
| 183 |
if (MemberName.Contains ("<") && MemberName.EndsWith (">")) |
| 184 |
{ |
| 185 |
var starti = MemberName.IndexOf ("<") + 1; |
| 186 |
var endi = MemberName.LastIndexOf (">"); |
| 187 |
var paramlist = MemberName.Substring (starti, endi - starti); |
| 188 |
var tparams = paramlist.Split (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries); |
| 189 |
TypeParameters = new StringList (tparams); |
| 190 |
} |
| 191 |
} |
| 192 |
|
| 193 |
public override string ToString () |
| 194 |
{ |
| 195 |
if (MemberSignatures.Count > 0) |
| 196 |
return MemberSignatures.Values.First (); |
| 197 |
else |
| 198 |
return $"{MemberType}{ReturnType} {MemberName}<{TypeParameters.Count}> ({Parameters.Count})"; |
| 199 |
} |
| 200 |
} |
| 201 |
} |