Skip to content

tools/content: Support surveying unimplemented KaTeX features #1600

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

tools/content: Support surveying unimplemented KaTeX features #1600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b42f784
content test [nfc]: Use const for math block tests
rajveermalviya Apr 24, 2025
4231608
content test [nfc]: Enable skips in testParseExample and testParse
gnprice May 29, 2025
04a3d25
content [nfc]: Inline _logError in _KatexParser._parseSpan
rajveermalviya May 8, 2025
e2022de
content [nfc]: Refactor _KatexParser._parseChildSpans to take list of…
rajveermalviya May 8, 2025
82c6b01
content: Populate `debugHtmlNode` for KatexNode
rajveermalviya May 27, 2025
b6da144
content [nfc]: Reintroduce KatexNode as a base sealed class
rajveermalviya Apr 24, 2025
c8f7d0b
content: Ignore more KaTeX classes that don't have CSS definition
rajveermalviya May 19, 2025
51fb5f5
content: Handle 'mspace' and 'msupsub' KaTeX CSS classes
rajveermalviya May 19, 2025
db0c1d8
content [nfc]: Remove the `inline` property in _Katex widget
rajveermalviya May 19, 2025
0bf40b8
content: Support parsing and handling inline styles for KaTeX content
rajveermalviya Apr 1, 2025
3f8913c
content [nfc]: Make MathNode a sealed class
rajveermalviya Jun 17, 2025
e6c0caf
content [nfc]: Make `KatexHtmlParseError` private
rajveermalviya Jun 17, 2025
867b8f3
content: Allow KaTeX parser to report failure reasons
rajveermalviya Jun 17, 2025
6fdaae9
tools/content: Support surveying unimplemented KaTeX features
rajveermalviya Jun 17, 2025
bd7ae16
tools/content: Add a flag to control verbosity of KaTeX check result
rajveermalviya Jun 18, 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
31 changes: 25 additions & 6 deletions lib/model/content.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,11 +341,13 @@ class CodeBlockSpanNode extends ContentNode {
}
}

abstract class MathNode extends ContentNode {
sealed class MathNode extends ContentNode {
const MathNode({
super.debugHtmlNode,
required this.texSource,
required this.nodes,
this.debugHardFailReason,
this.debugSoftFailReason,
});

final String texSource;
Expand All @@ -357,6 +359,9 @@ abstract class MathNode extends ContentNode {
/// fallback instead.
final List<KatexNode>? nodes;

final KatexParserHardFailReason? debugHardFailReason;
final KatexParserSoftFailReason? debugSoftFailReason;

@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
Expand All @@ -369,8 +374,12 @@ abstract class MathNode extends ContentNode {
}
}

class KatexNode extends ContentNode {
const KatexNode({
sealed class KatexNode extends ContentNode {
const KatexNode({super.debugHtmlNode});
}

class KatexSpanNode extends KatexNode {
const KatexSpanNode({
required this.styles,
required this.text,
required this.nodes,
Expand Down Expand Up @@ -407,6 +416,8 @@ class MathBlockNode extends MathNode implements BlockContentNode {
super.debugHtmlNode,
required super.texSource,
required super.nodes,
super.debugHardFailReason,
super.debugSoftFailReason,
});
}

Expand Down Expand Up @@ -876,6 +887,8 @@ class MathInlineNode extends MathNode implements InlineContentNode {
super.debugHtmlNode,
required super.texSource,
required super.nodes,
super.debugHardFailReason,
super.debugSoftFailReason,
});
}

Expand Down Expand Up @@ -917,7 +930,9 @@ class _ZulipInlineContentParser {
return MathInlineNode(
texSource: parsed.texSource,
nodes: parsed.nodes,
debugHtmlNode: debugHtmlNode);
debugHtmlNode: debugHtmlNode,
debugHardFailReason: kDebugMode ? parsed.hardFailReason : null,
debugSoftFailReason: kDebugMode ? parsed.softFailReason : null);
}

UserMentionNode? parseUserMention(dom.Element element) {
Expand Down Expand Up @@ -1624,7 +1639,9 @@ class _ZulipContentParser {
result.add(MathBlockNode(
texSource: parsed.texSource,
nodes: parsed.nodes,
debugHtmlNode: kDebugMode ? firstChild : null));
debugHtmlNode: kDebugMode ? firstChild : null,
debugHardFailReason: kDebugMode ? parsed.hardFailReason : null,
debugSoftFailReason: kDebugMode ? parsed.softFailReason : null));
} else {
result.add(UnimplementedBlockContentNode(htmlNode: firstChild));
}
Expand Down Expand Up @@ -1660,7 +1677,9 @@ class _ZulipContentParser {
result.add(MathBlockNode(
texSource: parsed.texSource,
nodes: parsed.nodes,
debugHtmlNode: debugHtmlNode));
debugHtmlNode: debugHtmlNode,
debugHardFailReason: kDebugMode ? parsed.hardFailReason : null,
debugSoftFailReason: kDebugMode ? parsed.softFailReason : null));
continue;
}
}
Expand Down
Loading