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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
// Copyright © Microsoft Corporation.
// This source file is subject to the Microsoft Permissive License.
// See http://www.microsoft.com/resources/sharedsource/licensingbasics/sharedsourcelicenses.mspx.
// All other rights reserved.
using System;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using System.Xml.XPath;
namespace Microsoft.Ddue.Tools {
public class IntellisenseComponent : BuildComponent {
public IntellisenseComponent (BuildAssembler assembler, XPathNavigator configuration) : base(assembler, configuration) {
XPathNavigator output_node = configuration.SelectSingleNode("output");
if (output_node != null) {
string directory_value = output_node.GetAttribute("directory", String.Empty);
if (!String.IsNullOrEmpty(directory_value)) {
directory = Environment.ExpandEnvironmentVariables(directory_value);
if (!Directory.Exists(directory)) WriteMessage(MessageLevel.Error, String.Format("The output directory '{0}' does not exist.", directory));
}
}
// a way to get additional information into the intellisense file
XPathNodeIterator input_nodes = configuration.Select("input");
foreach (XPathNavigator input_node in input_nodes) {
string file_value = input_node.GetAttribute("file", String.Empty);
if (!String.IsNullOrEmpty(file_value)) {
string file = Environment.ExpandEnvironmentVariables(file_value);
ReadInputFile(file);
}
}
context.AddNamespace("ddue", "http://ddue.schemas.microsoft.com/authoring/2003/5");
summaryExpression.SetContext(context);
memberSummaryExpression.SetContext(context);
returnsExpression.SetContext(context);
parametersExpression.SetContext(context);
parameterNameExpression.SetContext(context);
templatesExpression.SetContext(context);
templateNameExpression.SetContext(context);
exceptionExpression.SetContext(context);
exceptionCrefExpression.SetContext(context);
}
// input content store
private void ReadInputFile (string file) {
try {
XPathDocument document = new XPathDocument(file);
XPathNodeIterator member_nodes = document.CreateNavigator().Select("/metadata/topic[@id]");
foreach (XPathNavigator member_node in member_nodes) {
string id = member_node.GetAttribute("id", String.Empty);
content[id] = member_node.Clone();
}
WriteMessage(MessageLevel.Info, String.Format("Read {0} input content nodes.", member_nodes.Count));
} catch (XmlException e) {
WriteMessage(MessageLevel.Error, String.Format("The input file '{0}' is not a well-formed XML file. The error message is: {1}", file, e.Message));
} catch (IOException e) {
WriteMessage(MessageLevel.Error, String.Format("An error occured while attempting to access the fileThe input file '{0}'. The error message is: {1}", file, e.Message));
}
}
private Dictionary<string, XPathNavigator> content = new Dictionary<string, XPathNavigator>();
// the action of the component
public override void Apply (XmlDocument document, string id) {
// only generate intellisense if id corresponds to an allowed intellisense ID
if (id.Length < 2) return;
if (id[1] != ':') return;
if (!((id[0] == 'T') || (id[0] == 'M') || (id[0] == 'P') || (id[0] == 'F') || (id[0] == 'E') || (id[0] == 'N'))) return;
XPathNavigator root = document.CreateNavigator().SelectSingleNode("/document/comments");
string assembly;
if ((string)root.Evaluate(groupExpression) == "namespace") {
// get the assembly for the namespace
//assembly = (string) root.Evaluate(namespaceAssemblyExpression);
// Assign general name for namespace assemblies since they do not belong to any specific assembly
assembly = "namespaces";
} else {
// get the assembly for the API
assembly = (string) root.Evaluate(assemblyExpression);
}
if (String.IsNullOrEmpty(assembly)) return;
// try/catch block for capturing errors
try {
// get the writer for the assembly
XmlWriter writer;
if (!writers.TryGetValue(assembly, out writer)) {
// create a writer for the assembly
string name = Path.Combine(directory, assembly + ".xml");
// Console.WriteLine("creating {0}", name);
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
try {
writer = XmlWriter.Create(name, settings);
} catch (IOException e) {
WriteMessage(MessageLevel.Error, String.Format("An access error occured while attempting to create the intellisense output file '{0}'. The error message is: {1}", name, e.Message));
}
writers.Add(assembly, writer);
// write out the initial data
writer.WriteStartDocument();
writer.WriteStartElement("doc");
//do not generate assembly nodes for namespace topics
if ((string)root.Evaluate(groupExpression) != "namespace")
{
writer.WriteStartElement("assembly");
writer.WriteElementString("name", assembly);
writer.WriteEndElement();
}
writer.WriteStartElement("members");
}
writer.WriteStartElement("member");
writer.WriteAttributeString("name", id);
// summary
WriteSummary(root, summaryExpression, writer);
// return value
XPathNavigator returns = root.SelectSingleNode(returnsExpression);
if (returns != null) {
writer.WriteStartElement("returns");
XmlReader reader = returns.ReadSubtree();
CopyContent(reader, writer);
reader.Close();
writer.WriteEndElement();
}
// parameters
XPathNodeIterator parameters = root.Select(parametersExpression);
foreach (XPathNavigator parameter in parameters) {
string name = (string)parameter.Evaluate(parameterNameExpression);
XmlReader reader = parameter.ReadSubtree();
writer.WriteStartElement("param");
writer.WriteAttributeString("name", name);
CopyContent(reader, writer);
writer.WriteEndElement();
reader.Close();
}
// templates
XPathNodeIterator templates = root.Select(templatesExpression);
foreach (XPathNavigator template in templates) {
string name = (string)template.Evaluate(templateNameExpression);
XmlReader reader = template.ReadSubtree();
writer.WriteStartElement("typeparam");
writer.WriteAttributeString("name", name);
CopyContent(reader, writer);
writer.WriteEndElement();
reader.Close();
}
// exceptions
XPathNodeIterator exceptions = root.Select(exceptionExpression);
foreach (XPathNavigator exception in exceptions) {
string exceptionCref = (string)exception.Evaluate(exceptionCrefExpression);
XmlReader reader = exception.ReadSubtree();
writer.WriteStartElement("exception");
writer.WriteAttributeString("cref", exceptionCref);
CopyContent(reader, writer);
writer.WriteEndElement();
reader.Close();
}
// stored contents
XPathNavigator input;
if (content.TryGetValue(id, out input)) {
XPathNodeIterator input_nodes = input.SelectChildren(XPathNodeType.Element);
foreach (XPathNavigator input_node in input_nodes) {
input_node.WriteSubtree(writer);
}
}
writer.WriteFullEndElement();
// enumeration members
string subgroup = (string)root.Evaluate(subgroupExpression);
if (subgroup == "enumeration") {
XPathNodeIterator elements = (XPathNodeIterator)root.Evaluate(elementsExpression);
foreach (XPathNavigator element in elements) {
string api = (string)element.GetAttribute("api", string.Empty);
writer.WriteStartElement("member");
writer.WriteAttributeString("name", api);
//summary
WriteSummary(element, memberSummaryExpression, writer);
writer.WriteFullEndElement();
}
}
} catch (IOException e) {
WriteMessage(MessageLevel.Error, String.Format("An access error occured while attempting to write intellisense data. The error message is: {0}", e.Message));
} catch (XmlException e) {
WriteMessage(MessageLevel.Error, String.Format("Intellisense data was not valid XML. The error message is: {0}", e.Message));
}
}
protected override void Dispose(bool disposing) {
if (disposing) {
foreach (XmlWriter writer in writers.Values) {
writer.WriteEndDocument();
writer.Close();
}
}
base.Dispose(disposing);
}
private void WriteSummary(XPathNavigator node, XPathExpression expression, XmlWriter writer) {
XPathNavigator summary = node.SelectSingleNode(expression);
if (summary != null) {
writer.WriteStartElement("summary");
XmlReader reader = summary.ReadSubtree();
CopyContent(reader, writer);
reader.Close();
writer.WriteEndElement();
}
else {
// Console.WriteLine("no summary");
}
}
private void CopyContent (XmlReader reader, XmlWriter writer) {
reader.MoveToContent();
while (true) {
//Console.WriteLine("{0} {1}", reader.ReadState, reader.NodeType);
if (reader.NodeType == XmlNodeType.Text) {
writer.WriteString(reader.ReadString());
} else if (reader.NodeType == XmlNodeType.Element) {
//Console.WriteLine(reader.LocalName);
if (reader.LocalName == "codeEntityReference") {
writer.WriteStartElement("see");
writer.WriteAttributeString("cref", reader.ReadElementString());
writer.WriteEndElement();
} else if (reader.LocalName == "parameterReference") {
writer.WriteStartElement("paramref");
writer.WriteAttributeString("name", reader.ReadElementString());
writer.WriteEndElement();
} else if (reader.LocalName == "link") {
string displayText = reader.ReadElementString();
if (displayText.StartsWith("GTMT#")) {
writer.WriteString(displayText.Substring(displayText.IndexOf("#") + 1));
} else {
writer.WriteString(displayText);
}
} else {
reader.Read();
}
} else {
if (!reader.Read()) break;
}
}
}
private string directory = String.Empty;
private Dictionary<string,XmlWriter> writers = new Dictionary<string,XmlWriter>();
private XPathExpression assemblyExpression = XPathExpression.Compile("string(/document/reference/containers/library/@assembly)");
private XPathExpression namespaceAssemblyExpression = XPathExpression.Compile("string(/document/reference/elements/element/containers/library/@assembly)");
private XPathExpression summaryExpression = XPathExpression.Compile("ddue:dduexml/ddue:summary");
private XPathExpression returnsExpression = XPathExpression.Compile("ddue:dduexml/ddue:returnValue");
private XPathExpression parametersExpression = XPathExpression.Compile("ddue:dduexml/ddue:parameters/ddue:parameter/ddue:content");
private XPathExpression parameterNameExpression = XPathExpression.Compile("string(../ddue:parameterReference)");
private XPathExpression templatesExpression = XPathExpression.Compile("ddue:dduexml/ddue:genericParameters/ddue:genericParameter/ddue:content");
private XPathExpression templateNameExpression = XPathExpression.Compile("string(../ddue:parameterReference)");
private XPathExpression exceptionExpression = XPathExpression.Compile("ddue:dduexml/ddue:exceptions/ddue:exception/ddue:content");
private XPathExpression exceptionCrefExpression = XPathExpression.Compile("string(../ddue:codeEntityReference)");
private XPathExpression subgroupExpression = XPathExpression.Compile("string(/document/reference/apidata/@subgroup)");
private XPathExpression groupExpression = XPathExpression.Compile("string(/document/reference/apidata/@group)");
private XPathExpression elementsExpression = XPathExpression.Compile("/document/reference/elements/element");
private XPathExpression memberSummaryExpression = XPathExpression.Compile("ddue:summary");
private XmlNamespaceManager context = new CustomContext();
}
}
|
