形容一个 Markdown translator 玩?

Markdown
早以 2004
年虽深受发明出来,能够普及到今之程度离不开它的发明者和有以她来写的总人口

它们的着力语法说明可以于那发明者的
Blog
中找到。Markdown 的盛行一定程度达离不开 github 的奉献,同时 github
也扩展了 Markdown 语法,使得它可以表达更为助长的情节。

Markdown 的起就是以为文本内容变得易读易写,所以借助 Markdown
的语法格则,即使在纯文本模式下呢得获取比好的开卷效果。不过,很多景象下,我们见面以
Markdown 解析成 HTML,配合 CSS 来取得进一步绚丽之读书感受。

当自最初接触 Markdown
的当儿,我发觉多解析器之间的结果有差别,比如有这么的文书:

# header
===

深信不疑您会找到不只一个 Markdown
解析器,那么它对于地方的文书会发生不同的剖析结果也?

答案是肯定的。

那是呀来头致差的解析器之间发生的结果碰头不同?我信任广大人还早就知道了
i++ * i++ * i++ 这个经典的 C语言的题材了
(如果不掌握得扣押这里)

正确,这便是 Markdown 中之 Undefined Behavior,究其原因就是坐 Markdown
的发明者并从未为出 Markdown
语法的整定义,他只是在语法说明遭到推选了部分略的例子,并附上了上下一心使用
Perl 写的
Translator。不幸的凡立即段代码都年久失修,你得挺容易物色来她的
bug,对于下的公文:

> ## This is an H2 in a blockquote
> > nested blockquote
> H1
> ====

它们见面被有脚的结果:

<blockquote>
  <h2>This is an H2 in a blockquote</h2>

<blockquote>
  <p>nested blockquote</p>

<h1>H1</h1>
</blockquote>

<p></blockquote></p>

习 HTML 语法的同室很轻就见面发觉最后一行的荒谬。

好在由 Markdown 的撰稿人没有叫闹整体的语法定义,导致在遇见一些 Undefined
Behavior 时,每个 translator
的作者必须协调去思一个适用的输出结果,这样虽造成了各家的输出会生出有进出。可能作者也不曾悟出
Markdown 会流行到是水平吧,哈。

死早前我一度就此 js 写过一个简陋的 Markdown
translator,它是由于若干的正则配合局部流水线控制语句来完成的。最近收看许多关于
Markdown 语法的稿子,我不怕以回头看了下那些代码,于是决定使用 swift
重写一个。

这次又写我说了算作出点样子,代码中将不以正则,在条分缕析了 Markdown
文本下,首先很成一个 Tree,然后才是因 Tree 中之始末来 HTML。

本来在写之前,还是要分析下 Markdown
语法,并无能够只是看有小例子,需要在 github 和其它几个 Markdown
编辑软件不断遭受试错,小毕起语法,并采取 XEBNF 来叙述。

XEBNF 是本身好之 C语言extend
BNF,哈哈。使用
XEBNF 是因为 BNF 的 ::= 书写最好累,而 ABNF 又没有 EBNF 中的 exception
- 功能。我还描绘了一个 Atom 的 Syntax 来支撑
XBNF,于是它看起像是这般:

脚就是自我时微毕起的语法,目前只有 block
元素,因为自己事先勾勒的丘元素的辨析:

Char                          = [#x0000-#xD7FF] | [#xE000-#x10FFFF]
SP                            = #x0020
HTAB                          = #x0009
CR                            = #x000D
LF                            = #x000A
CRLF                          = CR LF
NL                            = CR | LF | CRLF
WSP                           = HTAB | SP
LWSP                          = NL | WSP
DIGIT                         = [#x0030-#x0039]

; md
md                            = md-block*

; md-block
md-block                      = paragraph | header | blockquote | list | codeblock

; paragraph
paragraph-begin               = SP{0,3} ( Char - ( LWSP | ">" | "*" | "#" ) )
paragraph-content             = ( ( Char - NL ) NL? )+
paragraph-end                 = NL{2} | NL ( Char - ( ">" | "*" | "#" ) )
paragraph                     = paragraph-begin paragraph-content paragraph-end

; header-setext
header-setext-begin           = SP{0,3} ( Char - ( LWSP | ">" | "*" | "# ) )
header-setext-content         = Char - NL
header-setext-end             = NL ( "=" | "-" )+
header-setext                 = header-setext-begin header-setext-content header-setext-end

; header-atx
header-atx-begin              = SP{0,3} "#"+ WSP* ( Char - LWSP )
header-atx-content            = Char - NL
header-atx-end                = "#"* NL
header-atx                    = header-atx-begin header-atx-content header-atx-end

; header
header                        = header-setext | header-atx

; blockquote
blockquote-begin              = SP{0,3} ">"
blockquote-content            = ( header | paragraph | blockquote | list | codeblock )*
blockquote-end                = NL{2} ( Char - ">" )

; list-ul-item
list-ul-item-begin            = SP{0,3} "*" WSP
list-ul-item-content          = ( paragraph | blockquote | list | codeblock )*
list-ul-item-end              = NL{2} ( Char - SP )
list-ul-item                  = list-ul-item-begin list-ul-item-content list-ul-item-end

; list-ul
list-ul                       = list-ul-item+

; list-ol-item
list-ol-item-begin            = SP{0,3} DIGIT "." WSP
list-ol-item-content          = ( paragraph | blockquote | list | codeblock )*
list-ol-item-end              = NL{2} ( Char - SP )
list-ol-item                  = list-ol-item+

; list
list                          = list-ul | list-ol

; codeblock-md
codeblock-md-begin            = ( SP{4} | HTAB ) WSP* ( Char - WSP )
codeblock-md-content          = Char* - codeblock-md-end
codeblock-md-end              = NL SP{0,3} ( Char - WSP )
codeblock-md                  = codeblock-md-begin codeblock-md-content codeblock-md-end

; codeblock-ext
codeblock-ext-begin           = SP{0,3} "`"{3} ( Char - NL ) NL
codeblock-ext-content         = Char* - codeblock-ext-end
codeblock-ext-end             = NL "`"{3} ( Char - NL ) NL
codeblock-ext                 = codeblock-ext-begin codeblock-ext-content codeblock-ext-end

; codeblock
codeblock                     = codeblock-md | codeblock-ext

; html-element
html-element-attr             = Char+ - LWSP
html-element-name             = Char+ - LWSP

html-void-element             = SP{0,3} "<"html-element-name WSP* "/>" NL

html-normal-element-start     = SP{0,3} "<"html-element-name (WSP+ html-element-attr)* WSP* ">"
html-normal-element-content   = Char* - html-normal-element-end
html-normal-element-end       = "</"html-element-name WSP* ">" NL
html-normal-element           = html-normal-element-start html-normal-element-content html-normal-element-end

html-element                  = html-empty-element | html-void-element

发出了语法之后,就可初步勾画代码了,过程是很单调的,就是使递归下降的方,都是有些良机械的工作,代码在这里,相信会坚持写了吧樂

梦想得以于想使团结下手写一个 Markdown translator 的同学一点支援吧