深入 commonmark4cj 行内解析机制:加粗、删除线的分隔符匹配是如何实现的
【免费下载链接】commonmark4cj符合CommonMark规范的Markdown解析库项目地址: https://gitcode.com/Cangjie-TPC/commonmark4cj
commonmark4cj 是一款符合 CommonMark 规范的 Markdown 解析库,它能把 Markdown 文本解析成 Node 树并渲染为 HTML。本文带你深入它的行内解析机制:当你写下**加粗**或~~删除线~~时,库内部靠一套「分隔符栈 + 双向扫描」的算法完成匹配,这正是加粗、斜体、删除线得以正确渲染的核心。
一图看懂匹配流程 🧭
整个匹配过程可以拆成三步:
| 步骤 | 动作 | 关键类/方法 |
|---|---|---|
| 1️⃣ 记录 | 扫描到*、~等符号时,把它压入分隔符栈,并判断能否开/闭 | Delimiter、DelimiterRun |
| 2️⃣ 匹配 | 遇到"闭合分隔符"后向前回扫,寻找可匹配的"开分隔符" | processDelimiters |
| 3️⃣ 包装 | 匹配成功后,把中间节点包进新节点(加粗/删除线) | DelimiterProcessor.process |
第一步:分隔符不是马上生效,而是先"入栈排队"
普通文本在 inline_parser_impl.cj 中被扫描时,遇到*、_、~这类特殊字符,并不会立刻决定它是加粗还是字面字符,而是先创建Delimiter(分隔符)对象挂到节点上,并维护一条贯穿整行的分隔符链(previous/next 双向指针)。
每个分隔符连续串(Delimiter Run)都携带两个关键标记,定义在 delimiter_run.cj:
canOpen():能否开启强调(依据 CommonMark 的 flanking 规则,如前接空格/标点)canClose():能否闭合强调
💡 为什么这么设计?因为
*斜体*里的两个*谁是谁,只有看到整行内容后才能确定。先记录、后裁决,是这类解析器的经典手法。
第二步:closer 向前回扫,逐个尝试匹配
真正的匹配发生在行内解析收尾阶段,核心是 inline_parser_impl.cj 中的processDelimiters方法,逻辑非常直白:
- 从栈顶向下找第一个
canClose()的分隔符(closer); - 拿到它对应的
DelimiterProcessor(按字符查表,*、~各有一份); - 从 closer 向前逐个检查 opener:只要
opener.canOpen()且字符匹配,就调用processor.process(opener, closer)尝试处理; - 若处理返回使用数量 > 0,匹配成功;否则继续往前找。
找到 opener 后,已使用的分隔符字符会从两端逐个删除并解链(inline_parser_impl.cj),剩余的字符仍留在栈中等待下一轮匹配——这就是***bold and italic***能同时表达加粗+斜体的原因。
第三步:DelimiterProcessor 决定"包成什么"
处理器接口定义在 delimiter_processor.cj,内置的加粗/斜体处理器在 inline.cj 中实现,两个细节特别值得新手注意:
① "3 的倍数"规则(CommonMark 规范对内部分隔符串的约束):
if ((openingRun.canClose() || closingRun.canOpen()) && closingRun.getOriginalLength() % 3 != 0 && (openingRun.getOriginalLength() + closingRun.getOriginalLength()) % 3 == 0) return 0 // 放弃本次匹配,留给下一轮② 一次最多消耗 2 个分隔符:两端都 ≥2 个时生成StrongEmphasis(加粗),否则生成Emphasis(斜体),并把两端的 Text 节点之间的所有子节点搬进新节点,同时记录源跨度(SourceSpans)以便定位高亮。
删除线:用扩展机制接入同一套匹配流程 ✂️
删除线不是 CommonMark 标准语法,而是项目内置的扩展插件,源码在 strike_through.cj。它只需三步就复用了上面的整个匹配流程:
- 实现
StrikethroughDelimiterProcessor,声明开/闭字符为~,最小长度默认为 2(~~); - 在
process()中校验"开闭长度相等且 ≤2"(与 GitHub 行为一致),然后把中间节点包进Strikethrough节点; - 通过 StrikethroughExtension 把处理器注册到 ParserBuilder,并同时提供 HTML / 纯文本两种渲染器。
想扩展自己的行内语法?照着这个插件抄一遍即可,接口文档详见 doc/feature_api.md。
想动手研究?从这几个文件入手 🔍
| 关注点 | 文件 |
|---|---|
| 分隔符数据结构与开/闭标记 | src/commonmark/delimiter_run.cj |
| 处理器接口与阶梯式路由 | src/commonmark/delimiter_processor.cj |
| 加粗/斜体匹配与 3 倍数规则 | src/commonmark/inline.cj |
| 核心匹配算法 processDelimiters | src/commonmark/inline_parser_impl.cj |
| 删除线扩展实现 | src/strikethrough/strike_through.cj |
| 测试用例(可跑通验证) | test/LLT/delimited_test.cj |
一句话总结:commonmark4cj 的行内解析把"看见符号先入栈、看到闭合再回扫、交给处理器包装"这三步做成了可扩展的管线——理解了这个分隔符匹配机制,加粗、斜体、删除线乃至你自己扩展的语法,就都水到渠成了。
【免费下载链接】commonmark4cj符合CommonMark规范的Markdown解析库项目地址: https://gitcode.com/Cangjie-TPC/commonmark4cj
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考