Debian Codegraph @

external/api-doc-tools/mdoc/Mono.Documentation/Updater/EcmaDocumentationEnumerator.cs

raw
1 using System;
2 using System.Collections.Generic;
3 using System.Linq;
4 using System.Xml;
5
6 using Mono.Cecil;
7 using Mono.Documentation.Updater.Frameworks;
8 using Mono.Documentation.Util;
9
10 namespace Mono.Documentation.Updater
11 {
12 class EcmaDocumentationEnumerator : DocumentationEnumerator
13 {
14
15 XmlReader ecmadocs;
16 MDocUpdater app;
17
18 public EcmaDocumentationEnumerator (MDocUpdater app, XmlReader ecmaDocs)
19 {
20 this.app = app;
21 this.ecmadocs = ecmaDocs;
22 }
23
24 public override IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
25 {
26 HashSet<string> seen = new HashSet<string> ();
27 return GetDocumentationTypes (assembly, forTypes, seen)
28 .Concat (base.GetDocumentationTypes (assembly, forTypes, seen));
29 }
30
31 new IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
32 {
33 int typeDepth = -1;
34 while (ecmadocs.Read ())
35 {
36 switch (ecmadocs.Name)
37 {
38 case "Type":
39 {
40 if (typeDepth == -1)
41 typeDepth = ecmadocs.Depth;
42 if (ecmadocs.NodeType != XmlNodeType.Element)
43 continue;
44 if (typeDepth != ecmadocs.Depth) // nested <TypeDefinition/> element?
45 continue;
46 string typename = ecmadocs.GetAttribute ("FullName");
47 string typename2 = MDocUpdater.GetTypeFileName (typename);
48 if (forTypes != null &&
49 forTypes.BinarySearch (typename) < 0 &&
50 typename != typename2 &&
51 forTypes.BinarySearch (typename2) < 0)
52 continue;
53 TypeDefinition t;
54 if ((t = assembly.GetType (typename)) == null &&
55 (t = assembly.GetType (typename2)) == null)
56 continue;
57 seen.Add (typename);
58 if (typename != typename2)
59 seen.Add (typename2);
60 Console.WriteLine (" Import: {0}", t.FullName);
61 if (ecmadocs.Name != "Docs")
62 {
63 int depth = ecmadocs.Depth;
64 while (ecmadocs.Read ())
65 {
66 if (ecmadocs.Name == "Docs" && ecmadocs.Depth == depth + 1)
67 break;
68 }
69 }
70 if (!ecmadocs.IsStartElement ("Docs"))
71 throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expecting <Docs/>!");
72 yield return t;
73 break;
74 }
75 default:
76 break;
77 }
78 }
79 }
80
81 public override IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type, FrameworkTypeEntry typeEntry)
82 {
83 return GetMembers (basefile, type, typeEntry)
84 .Concat (base.GetDocumentationMembers (basefile, type, typeEntry));
85 }
86
87 private IEnumerable<DocsNodeInfo> GetMembers (XmlDocument basefile, TypeDefinition type, FrameworkTypeEntry typeEntry)
88 {
89 while (ecmadocs.Name != "Members" && ecmadocs.Read ())
90 {
91 // do nothing
92 }
93 if (ecmadocs.IsEmptyElement)
94 yield break;
95
96 int membersDepth = ecmadocs.Depth;
97 bool go = true;
98 while (go && ecmadocs.Read ())
99 {
100 switch (ecmadocs.Name)
101 {
102 case "Member":
103 {
104 if (membersDepth != ecmadocs.Depth - 1 || ecmadocs.NodeType != XmlNodeType.Element)
105 continue;
106 DocumentationMember dm = new DocumentationMember (ecmadocs);
107
108 string xp = MDocUpdater.GetXPathForMember (dm);
109 XmlElement oldmember = (XmlElement)basefile.SelectSingleNode (xp);
110 MemberReference m;
111 if (oldmember == null)
112 {
113 m = GetMember (type, dm);
114 if (m == null)
115 {
116 app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
117 type.FullName, dm.MemberSignatures["C#"]);
118 // SelectSingleNode (ecmaDocsMember, "MemberSignature[@Language=\"C#\"]/@Value").Value);
119 continue;
120 }
121 // oldmember lookup may have failed due to type parameter renames.
122 // Try again.
123 oldmember = (XmlElement)basefile.SelectSingleNode (MDocUpdater.GetXPathForMember (m)); //todo: why always null???
124 if (oldmember == null)
125 {
126 XmlElement members = MDocUpdater.WriteElement (basefile.DocumentElement, "Members");
127 oldmember = basefile.CreateElement ("Member");
128 oldmember.SetAttribute ("MemberName", dm.MemberName);
129 members.AppendChild (oldmember);
130 foreach (string key in MDocUpdater.Sort (dm.MemberSignatures.Keys))
131 {
132 XmlElement ms = basefile.CreateElement ("MemberSignature");
133 ms.SetAttribute ("Language", key);
134 ms.SetAttribute ("Value", (string)dm.MemberSignatures[key]);
135 oldmember.AppendChild (ms);
136 }
137 oldmember.SetAttribute ("__monodocer-seen__", "true");
138 Console.WriteLine ("Member Added: {0}", oldmember.SelectSingleNode ("MemberSignature[@Language='C#']/@Value").InnerText);
139 app.additions++;
140 }
141 }
142 else
143 {
144 m = GetMember (type, new DocumentationMember (oldmember, typeEntry));
145 if (m == null)
146 {
147 app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
148 type.FullName, dm.MemberSignatures["C#"]);
149 continue;
150 }
151 oldmember.SetAttribute ("__monodocer-seen__", "true");
152 }
153 DocsNodeInfo node = new DocsNodeInfo (oldmember, m);
154 if (ecmadocs.Name != "Docs")
155 throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expected <Docs/>!");
156 yield return node;
157 break;
158 }
159 case "Members":
160 if (membersDepth == ecmadocs.Depth && ecmadocs.NodeType == XmlNodeType.EndElement)
161 {
162 go = false;
163 }
164 break;
165 }
166 }
167 }
168 }
169 }