linkext.go

package ukuleleweb

import (
	"regexp"
	"slices"

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

var pageNameRE = regexp.MustCompile(`^([A-ZÄÖÜ][a-zäöüß]+){2,}\b`)

// wikiLinkExt is a goldmark extension for recognizing WikiLinks.
// If destFunc is non-nil, it is called with the page name to produce
// the link destination. If nil, the destination defaults to "/"+pageName.
type wikiLinkExt struct {
	destFunc func(pageName string) string
}

func (e *wikiLinkExt) Extend(m goldmark.Markdown) {
	m.Parser().AddOptions(
		parser.WithInlineParsers(
			// One less than the linkify one - we don't want to mess up http links.
			util.Prioritized(&wikiLinkParser{destFunc: e.destFunc}, 998),
		),
	)
}

// A parser for WikiLinks (resolving to /WikiLinks)
type wikiLinkParser struct {
	destFunc func(pageName string) string
}

func (w *wikiLinkParser) Trigger() []byte {
	return []byte{' ', '('}
}

func (w *wikiLinkParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) (res ast.Node) {
	if pc.IsInLinkLabel() {
		return nil
	}
	line, segment := block.PeekLine()
	// Implementation note:
	// The trigger above triggers for the given characters, as well as for newlines.
	// Parse() below must be able to recognize both lines starting with "WikiLink..."
	// as well as lines starting with " WikiLink..." (for any leading trigger character).
	// If the line does start with a trigger, then *on a successful parse*,
	// that trigger must be inserted into the parent node before returning.
	if len(line) > 0 && slices.Contains(w.Trigger(), line[0]) {
		prefixSeg := segment.WithStop(segment.Start + 1)

		// Move line and segment one character further
		// and continue the parsing as if we had not started with a space.
		// e.g. line = "go/foo ..." instead of " go/foo ..."
		block.Advance(1)
		line = line[1:]
		segment = segment.WithStart(segment.Start + 1)

		// Insert the leading space into the parent AST, if parse was a success.
		defer func() {
			if res == nil {
				return
			}
			ast.MergeOrAppendTextSegment(parent, prefixSeg)
		}()
	}

	// Match must be at the beginning of the line either way.
	m := pageNameRE.FindSubmatchIndex(line)
	if m == nil || m[0] != 0 {
		return nil
	}

	linkText := line[0:m[1]]

	block.Advance(m[1])

	link := ast.NewLink()
	link.AppendChild(link, ast.NewTextSegment(text.NewSegment(segment.Start, segment.Start+m[1])))
	dest := "/" + string(linkText)
	if w.destFunc != nil {
		dest = w.destFunc(string(linkText))
	}
	link.Destination = []byte(dest)
	return link
}