Skip to content

Refactor markdown render #32736

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 4 commits into from
Dec 6, 2024
Merged

Refactor markdown render #32736

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62a0952
fix
wxiaoguang Dec 6, 2024
f0ef2e3
Merge branch 'main' into refactor-render-markdown
wxiaoguang Dec 6, 2024
537f107
add one more test
wxiaoguang Dec 6, 2024
e93de92
fine tune tests
wxiaoguang Dec 6, 2024
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
54 changes: 48 additions & 6 deletions modules/markup/markdown/markdown_math_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func TestMathRender(t *testing.T) {
},
{
"$$a$$",
`<pre class="code-block is-loading"><code class="chroma language-math display">a</code></pre>` + nl,
`<code class="chroma language-math display">a</code>` + nl,
},
{
"$$a$$ test",
Expand All @@ -79,9 +79,13 @@ func TestMathRender(t *testing.T) {
`<p>test <code class="language-math display is-loading">a</code></p>` + nl,
},
{
"foo $x=\\$$ bar",
`foo $x=\$$ bar`,
`<p>foo <code class="language-math is-loading">x=\$</code> bar</p>` + nl,
},
{
`$\text{$b$}$`,
`<p><code class="language-math is-loading">\text{$b$}</code></p>` + nl,
},
}

for _, test := range testcases {
Expand Down Expand Up @@ -119,7 +123,7 @@ func TestMathRenderBlockIndent(t *testing.T) {
\]
`,
`<pre class="code-block is-loading"><code class="chroma language-math display">
\alpha
\alpha
</code></pre>
`,
},
Expand All @@ -131,24 +135,62 @@ func TestMathRenderBlockIndent(t *testing.T) {
\]
`,
`<pre class="code-block is-loading"><code class="chroma language-math display">
\alpha
\alpha
</code></pre>
`,
},
{
"indent-0-oneline",
`$$ x $$
foo`,
`<pre class="code-block is-loading"><code class="chroma language-math display"> x </code></pre>
`<code class="chroma language-math display"> x </code>
<p>foo</p>
`,
},
{
"indent-3-oneline",
` $$ x $$<SPACE>
foo`,
`<pre class="code-block is-loading"><code class="chroma language-math display"> x </code></pre>
`<code class="chroma language-math display"> x </code>
<p>foo</p>
`,
},
{
"quote-block",
`
> \[
> a
> \]
> \[
> b
> \]
`,
`<blockquote>
<pre class="code-block is-loading"><code class="chroma language-math display">
a
</code></pre>
<pre class="code-block is-loading"><code class="chroma language-math display">
b
</code></pre>
</blockquote>
`,
},
{
"list-block",
`
1. a
\[
x
\]
2. b`,
`<ol>
<li>a
<pre class="code-block is-loading"><code class="chroma language-math display">
x
</code></pre>
</li>
<li>b</li>
</ol>
`,
},
}
Expand Down
1 change: 1 addition & 0 deletions modules/markup/markdown/math/block_node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ type Block struct {
Dollars bool
Indent int
Closed bool
Inline bool
}

// KindBlock is the node kind for math blocks
Expand Down
39 changes: 17 additions & 22 deletions modules/markup/markdown/math/block_parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,26 @@ package math
import (
"bytes"

giteaUtil "code.gitea.io/gitea/modules/util"

"github.com/yuin/goldmark/ast"
"github.com/yuin/goldmark/parser"
"github.com/yuin/goldmark/text"
"github.com/yuin/goldmark/util"
)

type blockParser struct {
parseDollars bool
parseDollars bool
endBytesDollars []byte
endBytesBracket []byte
}

// NewBlockParser creates a new math BlockParser
func NewBlockParser(parseDollarBlocks bool) parser.BlockParser {
return &blockParser{
parseDollars: parseDollarBlocks,
parseDollars: parseDollarBlocks,
endBytesDollars: []byte{'$', '$'},
endBytesBracket: []byte{'\\', ']'},
}
}

Expand Down Expand Up @@ -47,10 +53,7 @@ func (b *blockParser) Open(parent ast.Node, reader text.Reader, pc parser.Contex
node := NewBlock(dollars, pos)

// Now we need to check if the ending block is on the segment...
endBytes := []byte{'\\', ']'}
if dollars {
endBytes = []byte{'$', '$'}
}
endBytes := giteaUtil.Iif(dollars, b.endBytesDollars, b.endBytesBracket)
idx := bytes.Index(line[pos+2:], endBytes)
if idx >= 0 {
// for case $$ ... $$ any other text
Expand All @@ -63,6 +66,7 @@ func (b *blockParser) Open(parent ast.Node, reader text.Reader, pc parser.Contex
segment.Stop = segment.Start + idx
node.Lines().Append(segment)
node.Closed = true
node.Inline = true
return node, parser.Close | parser.NoChildren
}

Expand All @@ -79,27 +83,18 @@ func (b *blockParser) Continue(node ast.Node, reader text.Reader, pc parser.Cont
}

line, segment := reader.PeekLine()
w, pos := util.IndentWidth(line, 0)
w, pos := util.IndentWidth(line, reader.LineOffset())
if w < 4 {
if block.Dollars {
i := pos
for ; i < len(line) && line[i] == '$'; i++ {
}
length := i - pos
if length >= 2 && util.IsBlank(line[i:]) {
reader.Advance(segment.Stop - segment.Start - segment.Padding)
block.Closed = true
endBytes := giteaUtil.Iif(block.Dollars, b.endBytesDollars, b.endBytesBracket)
if bytes.HasPrefix(line[pos:], endBytes) && util.IsBlank(line[pos+len(endBytes):]) {
if util.IsBlank(line[pos+len(endBytes):]) {
newline := giteaUtil.Iif(line[len(line)-1] != '\n', 0, 1)
reader.Advance(segment.Stop - segment.Start - newline + segment.Padding)
return parser.Close
}
} else if len(line[pos:]) > 1 && line[pos] == '\\' && line[pos+1] == ']' && util.IsBlank(line[pos+2:]) {
reader.Advance(segment.Stop - segment.Start - segment.Padding)
block.Closed = true
return parser.Close
}
}

pos, padding := util.IndentPosition(line, 0, block.Indent)
seg := text.NewSegmentPadding(segment.Start+pos, segment.Stop, padding)
seg := text.NewSegmentPadding(segment.Start, segment.Stop, segment.Padding)
node.Lines().Append(seg)
return parser.Continue | parser.NoChildren
}
Expand Down
6 changes: 4 additions & 2 deletions modules/markup/markdown/math/block_renderer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package math

import (
"code.gitea.io/gitea/modules/markup/internal"
giteaUtil "code.gitea.io/gitea/modules/util"

gast "github.com/yuin/goldmark/ast"
"github.com/yuin/goldmark/renderer"
Expand Down Expand Up @@ -37,10 +38,11 @@ func (r *BlockRenderer) writeLines(w util.BufWriter, source []byte, n gast.Node)
func (r *BlockRenderer) renderBlock(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error) {
n := node.(*Block)
if entering {
_ = r.renderInternal.FormatWithSafeAttrs(w, `<pre class="code-block is-loading"><code class="chroma language-math display">`)
code := giteaUtil.Iif(n.Inline, "", `<pre class="code-block is-loading">`) + `<code class="chroma language-math display">`
_ = r.renderInternal.FormatWithSafeAttrs(w, code)
r.writeLines(w, source, n)
} else {
_, _ = w.WriteString(`</code></pre>` + "\n")
_, _ = w.WriteString(`</code>` + giteaUtil.Iif(n.Inline, "", `</pre>`) + "\n")
}
return gast.WalkContinue, nil
}
8 changes: 7 additions & 1 deletion modules/markup/markdown/math/inline_parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,10 @@ func (parser *inlineParser) Parse(parent ast.Node, block text.Reader, pc parser.
opener := len(parser.start)

// Now look for an ending line
depth := 0
ender := -1
for i := opener; i < len(line); i++ {
if bytes.HasPrefix(line[i:], parser.end) {
if depth == 0 && bytes.HasPrefix(line[i:], parser.end) {
succeedingCharacter := byte(0)
if i+len(parser.end) < len(line) {
succeedingCharacter = line[i+len(parser.end)]
Expand All @@ -99,6 +100,11 @@ func (parser *inlineParser) Parse(parent ast.Node, block text.Reader, pc parser.
i++
continue
}
if line[i] == '{' {
depth++
} else if line[i] == '}' {
depth--
}
}
if ender == -1 {
return nil
Expand Down
Loading