aboutsummaryrefslogtreecommitdiffstats
path: root/modules/markup/markdown/math/inline_parser.go
blob: a711d1e1cd1d7a97f070cc495295f734b5c38a1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// Copyright 2022 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package math

import (
	"bytes"

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

type inlineParser struct {
	trigger              []byte
	endBytesSingleDollar []byte
	endBytesDoubleDollar []byte
	endBytesParentheses  []byte
	enableInlineDollar   bool
}

func NewInlineDollarParser(enableInlineDollar bool) parser.InlineParser {
	return &inlineParser{
		trigger:              []byte{'$'},
		endBytesSingleDollar: []byte{'$'},
		endBytesDoubleDollar: []byte{'$', '$'},
		enableInlineDollar:   enableInlineDollar,
	}
}

var defaultInlineParenthesesParser = &inlineParser{
	trigger:             []byte{'\\', '('},
	endBytesParentheses: []byte{'\\', ')'},
}

func NewInlineParenthesesParser() parser.InlineParser {
	return defaultInlineParenthesesParser
}

// Trigger triggers this parser on $ or \
func (parser *inlineParser) Trigger() []byte {
	return parser.trigger
}

func isPunctuation(b byte) bool {
	return b == '.' || b == '!' || b == '?' || b == ',' || b == ';' || b == ':'
}

func isParenthesesClose(b byte) bool {
	return b == ')'
}

func isAlphanumeric(b byte) bool {
	return (b >= 'a' && b <= 'z') || (b >= 'A' && b <= 'Z') || (b >= '0' && b <= '9')
}

// Parse parses the current line and returns a result of parsing.
func (parser *inlineParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node {
	line, _ := block.PeekLine()

	if !bytes.HasPrefix(line, parser.trigger) {
		// We'll catch this one on the next time round
		return nil
	}

	var startMarkLen int
	var stopMark []byte
	checkSurrounding := true
	if line[0] == '$' {
		startMarkLen = 1
		stopMark = parser.endBytesSingleDollar
		if len(line) > 1 {
			switch line[1] {
			case '$':
				startMarkLen = 2
				stopMark = parser.endBytesDoubleDollar
			case '`':
				pos := 1
				for ; pos < len(line) && line[pos] == '`'; pos++ {
				}
				startMarkLen = pos
				stopMark = bytes.Repeat([]byte{'`'}, pos)
				stopMark[len(stopMark)-1] = '$'
				checkSurrounding = false
			}
		}
	} else {
		startMarkLen = 2
		stopMark = parser.endBytesParentheses
	}

	if line[0] == '$' && !parser.enableInlineDollar && (len(line) == 1 || line[1] != '`') {
		return nil
	}

	if checkSurrounding {
		precedingCharacter := block.PrecendingCharacter()
		if precedingCharacter < 256 && (isAlphanumeric(byte(precedingCharacter)) || isPunctuation(byte(precedingCharacter))) {
			// need to exclude things like `a$` from being considered a start
			return nil
		}
	}

	// move the opener marker point at the start of the text
	opener := startMarkLen

	// Now look for an ending line
	depth := 0
	ender := -1
	for i := opener; i < len(line); i++ {
		if depth == 0 && bytes.HasPrefix(line[i:], stopMark) {
			succeedingCharacter := byte(0)
			if i+len(stopMark) < len(line) {
				succeedingCharacter = line[i+len(stopMark)]
			}
			// check valid ending character
			isValidEndingChar := isPunctuation(succeedingCharacter) || isParenthesesClose(succeedingCharacter) ||
				succeedingCharacter == ' ' || succeedingCharacter == '\n' || succeedingCharacter == 0
			if checkSurrounding && !isValidEndingChar {
				break
			}
			ender = i
			break
		}
		if line[i] == '\\' {
			i++
			continue
		}
		switch line[i] {
		case '{':
			depth++
		case '}':
			depth--
		}
	}
	if ender == -1 {
		return nil
	}

	block.Advance(opener)
	_, pos := block.Position()
	node := NewInline()

	segment := pos.WithStop(pos.Start + ender - opener)
	node.AppendChild(node, ast.NewRawTextSegment(segment))
	block.Advance(ender - opener + len(stopMark))
	trimBlock(node, block)
	return node
}

func trimBlock(node *Inline, block text.Reader) {
	if node.IsBlank(block.Source()) {
		return
	}

	// trim first space and last space
	first := node.FirstChild().(*ast.Text)
	if !(!first.Segment.IsEmpty() && block.Source()[first.Segment.Start] == ' ') {
		return
	}

	last := node.LastChild().(*ast.Text)
	if !(!last.Segment.IsEmpty() && block.Source()[last.Segment.Stop-1] == ' ') {
		return
	}

	first.Segment = first.Segment.WithStart(first.Segment.Start + 1)
	last.Segment = last.Segment.WithStop(last.Segment.Stop - 1)
}