5464ab37d2
Since writers are normally only used synchronously (i.e. to write one document
at a time), we don't guard modifications to their internal
state (e.g. temporarily replacing the string.Builder in WriteNodesAsString)
against race conditions.
The package global `orgWriter` and corresponding use cases of it (`org.String`,
`$node.String`) break that pattern - the writer is potentially used from
multiple go routines at the same time. This results in race conditions that
manifest as error messages like e.g.
could not write output: runtime error: invalid memory address or nil pointer dereference. Using unrendered content.
Additionally, since we catch panics in `Document.Write`, the corresponding
stack trace is lost and dependents of go-org never know what hit them.
As using a writer across simultaneously across go routines is not a standard
pattern, we'll sync the use of the global `orgWriter` instead of trying to make
the actual writer threadsafe; less code noise for the common use case.
35 lines
977 B
Go
35 lines
977 B
Go
package org
|
|
|
|
import (
|
|
"regexp"
|
|
)
|
|
|
|
type FootnoteDefinition struct {
|
|
Name string
|
|
Children []Node
|
|
Inline bool
|
|
}
|
|
|
|
var footnoteDefinitionRegexp = regexp.MustCompile(`^\[fn:([\w-]+)\](\s+(.+)|\s*$)`)
|
|
|
|
func lexFootnoteDefinition(line string) (token, bool) {
|
|
if m := footnoteDefinitionRegexp.FindStringSubmatch(line); m != nil {
|
|
return token{"footnoteDefinition", 0, m[1], m}, true
|
|
}
|
|
return nilToken, false
|
|
}
|
|
|
|
func (d *Document) parseFootnoteDefinition(i int, parentStop stopFn) (int, Node) {
|
|
start, name := i, d.tokens[i].content
|
|
d.tokens[i] = tokenize(d.tokens[i].matches[2])
|
|
stop := func(d *Document, i int) bool {
|
|
return parentStop(d, i) ||
|
|
(isSecondBlankLine(d, i) && i > start+1) ||
|
|
d.tokens[i].kind == "headline" || d.tokens[i].kind == "footnoteDefinition"
|
|
}
|
|
consumed, nodes := d.parseMany(i, stop)
|
|
definition := FootnoteDefinition{name, nodes, false}
|
|
return consumed, definition
|
|
}
|
|
|
|
func (n FootnoteDefinition) String() string { return String(n) }
|