Skip to content

[Tools.JavaSource] Support html tags with attributes #1286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 7, 2025
Merged

[Tools.JavaSource] Support html tags with attributes #1286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1be795a
[Tools.JavaSource] Support `<i>` tags with attributes
pjcollins Jan 2, 2025
0ca8d8d
Apply feedback
pjcollins Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 5 additions & 18 deletions ...ols.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.HtmlBnfTerms.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
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.Rule = CreateStartElement ("pre") + preText + CreateEndElement ("pre", grammar, optional: true);
PreBlockDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
if (!grammar.ShouldImport (ImportJavadoc.Remarks)) {
parseNode.AstNode = "";
Expand All @@ -82,7 +82,7 @@ internal void CreateRules (SourceJavadocToXmldocGrammar grammar)
FontStyleDeclaration.Rule = fontstyle_tt | fontstyle_i;

PBlockDeclaration.Rule =
CreateStartElement ("p", grammar) + InlineDeclarations + CreateEndElement ("p", grammar, optional:true)
CreateStartElement ("p") + InlineDeclarations + CreateEndElement ("p", grammar, optional:true)
;
PBlockDeclaration.AstConfig.NodeCreator = (context, parseNode) => {
var remarks = FinishParse (context, parseNode).Remarks;
Expand Down Expand Up @@ -260,7 +260,7 @@ static string GetChildNodesAsString (ParseTreeNode parseNode)

static NonTerminal CreateHtmlToCrefElement (Grammar grammar, string htmlElement, string crefElement, BnfTerm body, bool optionalEnd = false)
{
var start = CreateStartElement (htmlElement, grammar);
var start = CreateStartElement (htmlElement);
var end = CreateEndElement (htmlElement, grammar, optionalEnd);
var nonTerminal = new NonTerminal ("<" + htmlElement + ">", ConcatChildNodes) {
Rule = start + body + end,
Expand All @@ -275,28 +275,15 @@ static NonTerminal CreateHtmlToCrefElement (Grammar grammar, string htmlElement,
return nonTerminal;
}

static NonTerminal CreateStartElement (string startElement, Grammar grammar)
static RegexBasedTerminal CreateStartElement (string startElement, string attribute = "")
{
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}[^>]*>") {
return new RegexBasedTerminal ($"<{startElement} {attribute}>", $@"(?i)<\b{startElement}\b\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 = "") {
Expand Down
4 changes: 4 additions & 0 deletions tests/Java.Interop.Tools.JavaSource-Tests/SourceJavadocToXmldocGrammar.HtmlBnfTermsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ public void PBlockDeclaration ()
r = p.Parse("<p>r= <em>unknown</em> text");
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
Assert.AreEqual ("<para>r= &lt;em&gt;unknown&lt;/em&gt; text</para>", r.Root.AstNode.ToString ());

r = p.Parse ("<p>For <li>A <i id=\"deviceowner\">Device Owner</i>");
Assert.IsFalse (r.HasErrors (), DumpMessages (r, p));
Assert.AreEqual ("<para>For &lt;li&gt;A <i>Device Owner</i></para>", r.Root.AstNode.ToString ());
}

[Test]
Expand Down