1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
//
// MonoDocDocumentationProvider.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2012 Xamarin Inc. (http://xamarin.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Xml;
using MonoDevelop.Core;
using System.Text;
using Microsoft.CodeAnalysis;
namespace MonoDevelop.Ide.TypeSystem
{
static class MonoDocDocumentationProvider
{
static bool hadError;
static Dictionary<string, string> commentCache = new Dictionary<string, string> ();
public static string GetDocumentation (ISymbol entity)
{
if (entity == null)
throw new System.ArgumentNullException ("entity");
// If we had an exception while getting the help xml the monodoc help provider
// shouldn't try it again. A corrupt .zip file could cause long tooltip delays otherwise.
if (hadError)
return null;
var idString = entity.GetDocumentationCommentId ();
if (string.IsNullOrEmpty (idString))
return null;
string result;
if (commentCache.TryGetValue (idString, out result))
return result;
XmlDocument doc = null;
try {
var helpTree = MonoDevelop.Projects.HelpService.HelpTree;
if (helpTree == null)
return null;
if (entity.Kind == SymbolKind.NamedType) {
doc = helpTree.GetHelpXml (idString);
} else {
var containingType = entity.ContainingType;
if (containingType == null)
return null;
var parentId = containingType.GetDocumentationCommentId ();
doc = helpTree.GetHelpXml (parentId);
if (doc == null)
return null;
XmlNode node = SelectNode (doc, entity);
if (node != null)
return commentCache [idString] = node.OuterXml;
return null;
}
} catch (Exception e) {
hadError = true;
LoggingService.LogError ("Error while reading monodoc file.", e);
}
if (doc == null) {
commentCache [idString] = null;
return null;
}
return commentCache [idString] = doc.OuterXml;
}
internal static void ClearCommentCache ()
{
commentCache = new Dictionary<string, string> ();
}
static XmlNode SelectNode (XmlDocument doc, ISymbol entity)
{
switch (entity.Kind) {
case SymbolKind.NamedType:
case SymbolKind.Field:
case SymbolKind.Property:
case SymbolKind.Event:
return doc.SelectSingleNode ("/Type/Members/Member[@MemberName='" + entity.Name + "']");
case SymbolKind.Method:
var method = (IMethodSymbol)entity;
if (method.MethodKind == MethodKind.Constructor)
return SelectOverload (doc.SelectNodes ("/Type/Members/Member[@MemberName='.ctor']"), method);
return SelectOverload (doc.SelectNodes ("/Type/Members/Member[@MemberName='" + entity.Name + "']"), method);
default:
throw new ArgumentOutOfRangeException ();
}
}
static XmlNode SelectOverload (XmlNodeList nodes, IMethodSymbol entity)
{
XmlNode node = null;
if (nodes.Count == 1) {
node = nodes [0];
} else {
var p = entity.Parameters;
foreach (XmlNode curNode in nodes) {
var paramList = curNode.SelectNodes ("Parameters/*");
if (p.Length == 0 && paramList.Count == 0)
return curNode;
if (p.Length != paramList.Count)
continue;
bool matched = true;
for (int i = 0; i < p.Length; i++) {
var idString = GetTypeString (p [i].Type);
if (idString != paramList [i].Attributes ["Type"].Value) {
matched = false;
break;
}
}
if (matched) {
return curNode;
}
}
}
if (node != null) {
System.Xml.XmlNode result = node.SelectSingleNode ("Docs");
return result;
}
return null;
}
static string GetTypeString (ITypeSymbol t)
{
switch (t.TypeKind) {
case TypeKind.Array:
var arr = (IArrayTypeSymbol)t;
return GetTypeString (arr.ElementType) + "[" + new string (',', arr.Rank - 1) + "]";
case TypeKind.Pointer:
var ptr = (IPointerTypeSymbol)t;
return "*" + GetTypeString (ptr.PointedAtType);
default:
var docComment = t.GetDocumentationCommentId ();
return docComment != null && docComment.Length > 2 ? docComment.Substring (2) : t.Name;
}
}
}
}
|
