File: EcmaDocumentationEnumerator.cs

package info (click to toggle)
mono 6.12.0.199%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,296,836 kB
  • sloc: cs: 11,181,803; xml: 2,850,076; ansic: 699,709; cpp: 123,344; perl: 59,361; javascript: 30,841; asm: 21,853; makefile: 20,405; sh: 15,009; python: 4,839; pascal: 925; sql: 859; sed: 16; php: 1
file content (169 lines) | stat: -rw-r--r-- 8,322 bytes parent folder | download | duplicates (7)
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Xml;

using Mono.Cecil;
using Mono.Documentation.Updater.Frameworks;
using Mono.Documentation.Util;

namespace Mono.Documentation.Updater
{
    class EcmaDocumentationEnumerator : DocumentationEnumerator
    {

        XmlReader ecmadocs;
        MDocUpdater app;

        public EcmaDocumentationEnumerator (MDocUpdater app, XmlReader ecmaDocs)
        {
            this.app = app;
            this.ecmadocs = ecmaDocs;
        }

        public override IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
        {
            HashSet<string> seen = new HashSet<string> ();
            return GetDocumentationTypes (assembly, forTypes, seen)
                .Concat (base.GetDocumentationTypes (assembly, forTypes, seen));
        }

        new IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
        {
            int typeDepth = -1;
            while (ecmadocs.Read ())
            {
                switch (ecmadocs.Name)
                {
                    case "Type":
                        {
                            if (typeDepth == -1)
                                typeDepth = ecmadocs.Depth;
                            if (ecmadocs.NodeType != XmlNodeType.Element)
                                continue;
                            if (typeDepth != ecmadocs.Depth) // nested <TypeDefinition/> element?
                                continue;
                            string typename = ecmadocs.GetAttribute ("FullName");
                            string typename2 = MDocUpdater.GetTypeFileName (typename);
                            if (forTypes != null &&
                                    forTypes.BinarySearch (typename) < 0 &&
                                    typename != typename2 &&
                                    forTypes.BinarySearch (typename2) < 0)
                                continue;
                            TypeDefinition t;
                            if ((t = assembly.GetType (typename)) == null &&
                                    (t = assembly.GetType (typename2)) == null)
                                continue;
                            seen.Add (typename);
                            if (typename != typename2)
                                seen.Add (typename2);
                            Console.WriteLine ("  Import: {0}", t.FullName);
                            if (ecmadocs.Name != "Docs")
                            {
                                int depth = ecmadocs.Depth;
                                while (ecmadocs.Read ())
                                {
                                    if (ecmadocs.Name == "Docs" && ecmadocs.Depth == depth + 1)
                                        break;
                                }
                            }
                            if (!ecmadocs.IsStartElement ("Docs"))
                                throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expecting <Docs/>!");
                            yield return t;
                            break;
                        }
                    default:
                        break;
                }
            }
        }

        public override IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type, FrameworkTypeEntry typeEntry)
        {
            return GetMembers (basefile, type, typeEntry)
                .Concat (base.GetDocumentationMembers (basefile, type, typeEntry));
        }

        private IEnumerable<DocsNodeInfo> GetMembers (XmlDocument basefile, TypeDefinition type, FrameworkTypeEntry typeEntry)
        {
            while (ecmadocs.Name != "Members" && ecmadocs.Read ())
            {
                // do nothing
            }
            if (ecmadocs.IsEmptyElement)
                yield break;

            int membersDepth = ecmadocs.Depth;
            bool go = true;
            while (go && ecmadocs.Read ())
            {
                switch (ecmadocs.Name)
                {
                    case "Member":
                        {
                            if (membersDepth != ecmadocs.Depth - 1 || ecmadocs.NodeType != XmlNodeType.Element)
                                continue;
                            DocumentationMember dm = new DocumentationMember (ecmadocs);

                            string xp = MDocUpdater.GetXPathForMember (dm);
                            XmlElement oldmember = (XmlElement)basefile.SelectSingleNode (xp);
                            MemberReference m;
                            if (oldmember == null)
                            {
                                m = GetMember (type, dm);
                                if (m == null)
                                {
                                    app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
                                            type.FullName, dm.MemberSignatures["C#"]);
                                    // SelectSingleNode (ecmaDocsMember, "MemberSignature[@Language=\"C#\"]/@Value").Value);
                                    continue;
                                }
                                // oldmember lookup may have failed due to type parameter renames.
                                // Try again.
                                oldmember = (XmlElement)basefile.SelectSingleNode (MDocUpdater.GetXPathForMember (m)); //todo: why always null???
                                if (oldmember == null)
                                {
                                    XmlElement members = MDocUpdater.WriteElement (basefile.DocumentElement, "Members");
                                    oldmember = basefile.CreateElement ("Member");
                                    oldmember.SetAttribute ("MemberName", dm.MemberName);
                                    members.AppendChild (oldmember);
                                    foreach (string key in MDocUpdater.Sort (dm.MemberSignatures.Keys))
                                    {
                                        XmlElement ms = basefile.CreateElement ("MemberSignature");
                                        ms.SetAttribute ("Language", key);
                                        ms.SetAttribute ("Value", (string)dm.MemberSignatures[key]);
                                        oldmember.AppendChild (ms);
                                    }
                                    oldmember.SetAttribute ("__monodocer-seen__", "true");
                                    Console.WriteLine ("Member Added: {0}", oldmember.SelectSingleNode ("MemberSignature[@Language='C#']/@Value").InnerText);
                                    app.additions++;
                                }
                            }
                            else
                            {
                                m = GetMember (type, new DocumentationMember (oldmember, typeEntry));
                                if (m == null)
                                {
                                    app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
                                            type.FullName, dm.MemberSignatures["C#"]);
                                    continue;
                                }
                                oldmember.SetAttribute ("__monodocer-seen__", "true");
                            }
                            DocsNodeInfo node = new DocsNodeInfo (oldmember, m);
                            if (ecmadocs.Name != "Docs")
                                throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expected <Docs/>!");
                            yield return node;
                            break;
                        }
                    case "Members":
                        if (membersDepth == ecmadocs.Depth && ecmadocs.NodeType == XmlNodeType.EndElement)
                        {
                            go = false;
                        }
                        break;
                }
            }
        }
    }
}