-
Notifications
You must be signed in to change notification settings - Fork 63
Expand file tree
/
Copy pathSourceJavadocToXmldocGrammar.HtmlBnfTerms.cs
More file actions
433 lines (374 loc) · 15.9 KB
/
SourceJavadocToXmldocGrammar.HtmlBnfTerms.cs
File metadata and controls
433 lines (374 loc) · 15.9 KB
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Xml;
using System.Xml.Linq;
using Irony.Ast;
using Irony.Parsing;
namespace Java.Interop.Tools.JavaSource {
using static IronyExtensions;
public partial class SourceJavadocToXmldocGrammar {
public class HtmlBnfTerms {
internal HtmlBnfTerms ()
{
}
internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
{
AllHtmlTerms.Rule = TopLevelInlineDeclaration
| PBlockDeclaration
| PreBlockDeclaration
;
var inlineDeclaration = new NonTerminal ("<html inline decl>", ConcatChildNodes) {
Rule = ParsedCharacterData
| FontStyleDeclaration
/*
| PhraseDeclaration
| SpecialDeclaration
| FormCtrlDeclaration
*/
| InlineHyperLinkDeclaration
| CodeElementDeclaration
| grammar.InlineTagsTerms.AllInlineTerms
| UnknownHtmlElementStart
,
};
var inlineDeclarations = new NonTerminal ("<html inline decl>*", ConcatChildNodes);
inlineDeclarations.MakePlusRule (grammar, inlineDeclaration);
InlineDeclaration.Rule = inlineDeclaration;
InlineDeclarations.MakeStarRule (grammar, InlineDeclaration);
TopLevelInlineDeclaration.Rule = inlineDeclarations;
TopLevelInlineDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
var remarks = FinishParse (context, parseNode).Remarks;
var addRemarks = grammar.ShouldImport (ImportJavadoc.Remarks) ||
(grammar.ShouldImport (ImportJavadoc.Summary) && remarks.Count == 0);
if (!addRemarks) {
parseNode.AstNode = "";
return;
}
foreach (var p in GetParagraphs (parseNode.ChildNodes)) {
remarks.Add (p);
}
parseNode.AstNode = "";
};
var fontstyle_tt = CreateHtmlToCrefElement (grammar, "tt", "c", InlineDeclarations, optionalEnd: true);
var fontstyle_i = CreateHtmlToCrefElement (grammar, "i", "i", InlineDeclarations, optionalEnd: true);
var preText = new PreBlockDeclarationBodyTerminal ();
PreBlockDeclaration.Rule = CreateStartElementIgnoreAttribute ("pre") + preText + CreateEndElement ("pre", grammar, optional: true);
PreBlockDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
if (!grammar.ShouldImport (ImportJavadoc.Remarks)) {
parseNode.AstNode = "";
return;
}
var c = new XElement ("code",
new XAttribute ("lang", "text/java"),
parseNode.ChildNodes [1].Token.Value);
FinishParse (context, parseNode).Remarks.Add (c);
parseNode.AstNode = c;
};
FontStyleDeclaration.Rule = fontstyle_tt | fontstyle_i;
PBlockDeclaration.Rule =
CreateStartElement ("p", grammar) + InlineDeclarations + CreateEndElement ("p", grammar, optional:true)
;
PBlockDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
var remarks = FinishParse (context, parseNode).Remarks;
var addRemarks = grammar.ShouldImport (ImportJavadoc.Remarks) ||
(grammar.ShouldImport (ImportJavadoc.Summary) && remarks.Count == 0);
if (!addRemarks) {
parseNode.AstNode = "";
return;
}
var p = new XElement ("para",
parseNode.ChildNodes
.Select (c => AstNodeToXmlContent (c)));
FinishParse (context, parseNode).Remarks.Add (p);
parseNode.AstNode = p;
};
InlineHyperLinkDeclaration.Rule = InlineHyperLinkOpenTerm + InlineDeclarations + CreateEndElement ("a", grammar, optional: true);
InlineHyperLinkDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
var nodesAsString = GetChildNodesAsString (parseNode);
var tokenValue = parseNode.ChildNodes [0].Token.Text;
int stopIndex = nodesAsString.IndexOf ('>');
if (stopIndex == -1 || !tokenValue.Contains ("href", StringComparison.OrdinalIgnoreCase)) {
parseNode.AstNode = new XText (nodesAsString);
return;
}
var attributeName = parseNode.ChildNodes [0].Term.Name;
var attributeValue = nodesAsString.Substring (0, stopIndex).Trim ().Trim ('\'', '"');
var elementValue = nodesAsString.Substring (stopIndex + 1);
if (!string.IsNullOrEmpty (attributeValue) && attributeValue.StartsWith ("http", StringComparison.OrdinalIgnoreCase)) {
var unparsed = $"<see href=\"{attributeValue}\">{elementValue}</see>";
XNode? seeElement = TryParseElement (unparsed);
if (seeElement == null) {
// Try to parse with HTML entities decoded
seeElement = TryParseElement (WebUtility.HtmlDecode (unparsed));
if (seeElement == null) {
// Finally, try to parse with only the element value encoded
seeElement = TryParseElement ($"<see href=\"{attributeValue}\">{WebUtility.HtmlEncode (elementValue)}</see>", logError: true);
}
}
parseNode.AstNode = seeElement ?? new XText (nodesAsString);
} else {
// TODO: Need to convert relative paths or code references to appropriate CREF value.
parseNode.AstNode = new XText (elementValue);
}
};
CodeElementDeclaration.Rule = CodeElementContentTerm;
CodeElementDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
// Parse the entire <code> element captured in the token
var codeElementText = parseNode.ChildNodes [0].Token.Text;
int startIndex = codeElementText.IndexOf ('>');
int stopIndex = codeElementText.LastIndexOf ('<');
if (startIndex == -1 || stopIndex == -1) {
parseNode.AstNode = new XText (codeElementText);
return;
}
var target = codeElementText.Substring (startIndex + 1, stopIndex - startIndex - 1);
parseNode.AstNode = new XElement ("c", target);
};
}
static IEnumerable<XElement> GetParagraphs (ParseTreeNodeList children)
{
var items = new List<object> ();
foreach (var child in children) {
var s = child.AstNode as string;
if (s == null || (!s.Contains ("\n\n") && !s.Contains ("\r\n\r\n"))) {
items.Add (child.AstNode);
continue;
}
const string UnixParagraph = "\n\n";
const string DosParagraph = "\r\n\r\n";
for (int i = 0; i < s.Length; ) {
int len = 0;
int n = -1;
if ((n = s.IndexOf (UnixParagraph, i, StringComparison.Ordinal)) >= 0) {
len = UnixParagraph.Length;
}
else if ((n = s.IndexOf (DosParagraph, i, StringComparison.Ordinal)) >= 0) {
len = DosParagraph.Length;
}
if (n <= 0) {
items.Add (s.Substring (i));
break;
}
var c = s.Substring (i, n-i);
items.Add (c);
i = n + len;
yield return new XElement ("para", items.Select (v => ToXmlContent (v)));
items.Clear ();
}
}
if (items.Count > 0) {
yield return new XElement ("para", items.Select (v => ToXmlContent (v)));
}
}
static string GetChildNodesAsString (ParseTreeNode parseNode)
{
var unparsed = string.Empty;
foreach (var cn in parseNode.ChildNodes) {
if (cn.ChildNodes?.Count > 1) {
foreach (var gcn in cn.ChildNodes) {
unparsed += gcn.AstNode?.ToString ();
}
} else {
unparsed += cn.AstNode?.ToString ();
}
}
return unparsed;
}
static XElement? TryParseElement (string unparsed, bool logError = false)
{
try {
return XElement.Parse (unparsed);
} catch (Exception x) {
if (logError)
Console.Error.WriteLine ($"## Unable to parse HTML element: `{unparsed}`\n{x.GetType ()}: {x.Message}");
return null;
}
}
public readonly NonTerminal AllHtmlTerms = new NonTerminal (nameof (AllHtmlTerms), ConcatChildNodes);
public readonly NonTerminal TopLevelInlineDeclaration = new NonTerminal (nameof (TopLevelInlineDeclaration), ConcatChildNodes);
// https://www.w3.org/TR/html401/struct/global.html#h-7.5.3
// public readonly Terminal ParsedCharacterData = new RegexBasedTerminal (nameof (ParsedCharacterData), "[^<{@}]*") {
// public readonly Terminal ParsedCharacterData = new WikiTextTerminal (nameof (ParsedCharacterData)) {*
public readonly Terminal ParsedCharacterData = new CharacterDataTerminal ("#PCDATA", preserveLeadingWhitespace:true);
// https://www.w3.org/TR/html4/sgml/dtd.html#inline
public readonly NonTerminal InlineDeclaration = new NonTerminal (nameof (InlineDeclaration), ConcatChildNodes);
public readonly NonTerminal InlineDeclarations = new NonTerminal (nameof (InlineDeclarations), ConcatChildNodes);
// https://www.w3.org/TR/html4/sgml/dtd.html#fontstyle
public readonly NonTerminal FontStyleDeclaration = new NonTerminal (nameof (FontStyleDeclaration), ConcatChildNodes);
// https://www.w3.org/TR/html4/sgml/dtd.html#phrase
public readonly NonTerminal PhraseDeclaration = new NonTerminal (nameof (PhraseDeclaration), ConcatChildNodes);
// https://www.w3.org/TR/html4/sgml/dtd.html#special
public readonly NonTerminal SpecialDeclaration = new NonTerminal (nameof (SpecialDeclaration), ConcatChildNodes);
// https://www.w3.org/TR/html4/sgml/dtd.html#formctrl
public readonly NonTerminal FormCtrlDeclaration = new NonTerminal (nameof (FormCtrlDeclaration), ConcatChildNodes);
// https://www.w3.org/TR/html4/sgml/dtd.html#block
public readonly NonTerminal BlockDeclaration = new NonTerminal (nameof (BlockDeclaration), ConcatChildNodes);
public readonly NonTerminal PBlockDeclaration = new NonTerminal (nameof (PBlockDeclaration), ConcatChildNodes);
public readonly NonTerminal PreBlockDeclaration = new NonTerminal (nameof (PreBlockDeclaration), ConcatChildNodes);
public readonly NonTerminal InlineHyperLinkDeclaration = new NonTerminal (nameof (InlineHyperLinkDeclaration), ConcatChildNodes);
public readonly NonTerminal CodeElementDeclaration = new NonTerminal (nameof (CodeElementDeclaration), ConcatChildNodes);
public readonly Terminal CodeElementContentTerm = new RegexBasedTerminal ("<code>", $@"(?i)<code\s*[^>]*>(.|\s)*?(<\/code>|<\/null>|<code>)") {
AstConfig = new AstNodeConfig {
NodeCreator = (context, parseNode) => parseNode.AstNode = "",
},
};
public readonly Terminal InlineHyperLinkOpenTerm = new RegexBasedTerminal ("<a attr=", @"(?i)<a\s*.*=") {
AstConfig = new AstNodeConfig {
NodeCreator = (context, parseNode) => parseNode.AstNode = "",
},
};
public readonly Terminal UnknownHtmlElementStart = new UnknownHtmlElementStartTerminal (nameof (UnknownHtmlElementStart)) {
AstConfig = new AstNodeConfig {
NodeCreator = (context, parseNode) => parseNode.AstNode = parseNode.Token.Value.ToString (),
},
};
static NonTerminal CreateHtmlToCrefElement (Grammar grammar, string htmlElement, string crefElement, BnfTerm body, bool optionalEnd = false)
{
var start = CreateStartElement (htmlElement, grammar);
var end = CreateEndElement (htmlElement, grammar, optionalEnd);
var nonTerminal = new NonTerminal ("<" + htmlElement + ">", ConcatChildNodes) {
Rule = start + body + end,
AstConfig = {
NodeCreator = (context, parseNode) => {
var n = new XElement (crefElement,
parseNode.ChildNodes.Select (c => c.AstNode ?? ""));
parseNode.AstNode = n;
},
}
};
return nonTerminal;
}
static NonTerminal CreateStartElement (string startElement, Grammar grammar)
{
var start = new NonTerminal ("<" + startElement + ">", nodeCreator: (context, parseNode) => parseNode.AstNode = "") {
Rule = grammar.ToTerm ("<" + startElement + ">") | "<" + startElement.ToUpperInvariant () + ">",
};
return start;
}
static RegexBasedTerminal CreateStartElementIgnoreAttribute (string startElement, string attribute)
{
return new RegexBasedTerminal ($"<{startElement} {attribute}", $@"(?i)<{startElement}\s*{attribute}[^>]*>") {
AstConfig = new AstNodeConfig {
NodeCreator = (context, parseNode) => parseNode.AstNode = "",
},
};
}
static RegexBasedTerminal CreateStartElementIgnoreAttribute (string startElement)
{
return CreateStartElementIgnoreAttribute (startElement, "");
}
static NonTerminal CreateEndElement (string endElement, Grammar grammar, bool optional = false)
{
var end = new NonTerminal (endElement, nodeCreator: (context, parseNode) => parseNode.AstNode = "") {
Rule = grammar.ToTerm ("</" + endElement + ">") | "</" + endElement.ToUpperInvariant () + ">",
};
if (optional) {
end.Rule |= grammar.Empty;
}
return end;
}
}
}
// Based in part on WikiTextTerminal
class CharacterDataTerminal : Terminal {
char[]? _stopChars;
bool preserveLeadingWhitespace;
public CharacterDataTerminal (string name, bool preserveLeadingWhitespace)
: base (name)
{
base.Priority = TerminalPriority.Low;
this.preserveLeadingWhitespace = preserveLeadingWhitespace;
this.AstConfig.NodeCreator = (context, parseNode) =>
parseNode.AstNode = parseNode.Token.Value.ToString ();
}
public override void Init (GrammarData grammarData)
{
base.Init (grammarData);
var stopCharSet = new Irony.CharHashSet ();
foreach(var term in grammarData.Terminals) {
var firsts = term.GetFirsts ();
if (firsts == null)
continue;
foreach (var first in firsts) {
if (string.IsNullOrEmpty (first))
continue;
stopCharSet.Add (first [0]);
}
}
_stopChars = stopCharSet.ToArray();
}
public override Token? TryMatch (ParsingContext context, ISourceStream source)
{
if (_stopChars is null)
throw new InvalidOperationException ("Init must be called before TryMatch");
var stopIndex = source.Text.IndexOfAny (_stopChars, source.Location.Position);
if (stopIndex == source.Location.Position)
return null;
if (stopIndex < 0)
stopIndex = source.Text.Length;
source.PreviewPosition = stopIndex;
// preserve leading whitespace, if present.
int start = source.Location.Position;
if (preserveLeadingWhitespace) {
while (start > 0 && char.IsWhiteSpace (source.Text, start-1)) {
start--;
}
}
var content = source.Text.Substring (start, stopIndex - start);
return source.CreateToken (this.OutputTerminal, content);
}
}
class PreBlockDeclarationBodyTerminal : Terminal {
public PreBlockDeclarationBodyTerminal ()
: base ("<pre> body")
{
this.AstConfig.NodeCreator = (context, parseNode) =>
parseNode.AstNode = parseNode.Token.Value.ToString ();
}
public override void Init (GrammarData grammarData)
{
base.Init (grammarData);
}
public override Token? TryMatch (ParsingContext context, ISourceStream source)
{
int startIndex = source.Location.Position;
var stopIndex = source.Text.IndexOf ("</pre>", source.Location.Position, StringComparison.OrdinalIgnoreCase);
if (stopIndex < 0)
stopIndex = source.Text.Length;
source.PreviewPosition = stopIndex;
var content = source.Text.Substring (startIndex, stopIndex - startIndex);
return source.CreateToken (this.OutputTerminal, content);
}
}
class UnknownHtmlElementStartTerminal : Terminal {
bool addingRemarks;
public UnknownHtmlElementStartTerminal (string name)
: base (name)
{
base.Priority = TerminalPriority.Low-1;
}
public override void Init (GrammarData grammarData)
{
base.Init (grammarData);
var g = grammarData.Grammar as SourceJavadocToXmldocGrammar;
addingRemarks = g?.ShouldImport (ImportJavadoc.Remarks) ?? false;
}
public override Token? TryMatch (ParsingContext context, ISourceStream source)
{
if (source.Text [source.Location.Position] != '<')
return null;
source.PreviewPosition += 1;
int start = source.Location.Position;
int stop = start;
while (stop < source.Text.Length && source.Text [stop] != '>' )
stop++;
if (addingRemarks) {
Console.Error.WriteLine ($"# Unsupported HTML element: {source.Text.Substring (start, stop - start)}");
}
return source.CreateToken (this.OutputTerminal, "<");
}
}
}