goldmark/parser/atx_heading.go

package parser

import (
	"github.com/yuin/goldmark/ast"
	"github.com/yuin/goldmark/text"
	"github.com/yuin/goldmark/util"
	"regexp"
)

// A HeadingConfig struct is a data structure that holds configuration of the renderers related to headings.
type HeadingConfig struct {
	HeadingID bool
}

// SetOption implements SetOptioner.
func (b *HeadingConfig) SetOption(name OptionName, value interface{}) {
	switch name {
	case HeadingID:
		b.HeadingID = true
	}
}

// A HeadingOption interface sets options for heading parsers.
type HeadingOption interface {
	SetHeadingOption(*HeadingConfig)
}

// HeadingID is an option name that enables custom and auto IDs for headings.
var HeadingID OptionName = "HeadingID"

type withHeadingID struct {
}

func (o *withHeadingID) SetConfig(c *Config) {
	c.Options[HeadingID] = true
}

func (o *withHeadingID) SetHeadingOption(p *HeadingConfig) {
	p.HeadingID = true
}

// WithHeadingID is a functional option that enables custom heading ids and
// auto generated heading ids.
func WithHeadingID() interface {
	Option
	HeadingOption
} {
	return &withHeadingID{}
}

var atxHeadingRegexp = regexp.MustCompile(`^[ ]{0,3}(#{1,6})(?:\s+(.*?)\s*([\s]#+\s*)?)?\n?$`)

type atxHeadingParser struct {
	HeadingConfig
}

// NewATXHeadingParser return a new BlockParser that can parse ATX headings.
func NewATXHeadingParser(opts ...HeadingOption) BlockParser {
	p := &atxHeadingParser{}
	for _, o := range opts {
		o.SetHeadingOption(&p.HeadingConfig)
	}
	return p
}

func (b *atxHeadingParser) Open(parent ast.Node, reader text.Reader, pc Context) (ast.Node, State) {
	line, segment := reader.PeekLine()
	pos := pc.BlockOffset()
	i := pos
	for ; i < len(line) && line[i] == '#'; i++ {
	}
	level := i - pos
	if i == pos || level > 6 {
		return nil, NoChildren
	}
	l := util.TrimLeftSpaceLength(line[i:])
	if l == 0 {
		return nil, NoChildren
	}
	start := i + l
	stop := len(line) - util.TrimRightSpaceLength(line)
	if stop <= start { // empty headings like '##[space]'
		stop = start + 1
	} else {
		i = stop - 1
		for ; line[i] == '#' && i >= start; i-- {
		}
		if i != stop-1 && !util.IsSpace(line[i]) {
			i = stop - 1
		}
		i++
		stop = i
	}

	node := ast.NewHeading(level)
	if len(util.TrimRight(line[start:stop], []byte{'#'})) != 0 { // empty heading like '### ###'
		node.Lines().Append(text.NewSegment(segment.Start+start, segment.Start+stop))
	}
	return node, NoChildren
}

func (b *atxHeadingParser) Continue(node ast.Node, reader text.Reader, pc Context) State {
	return Close
}

func (b *atxHeadingParser) Close(node ast.Node, pc Context) {
	if !b.HeadingID {
		return
	}
	parseOrGenerateHeadingID(node.(*ast.Heading), pc)
}

func (b *atxHeadingParser) CanInterruptParagraph() bool {
	return true
}

func (b *atxHeadingParser) CanAcceptIndentedLine() bool {
	return false
}

var headingIDRegexp = regexp.MustCompile(`^(.*[^\\])({#([^}]+)}\s*)\n?$`)
var headingIDMap = NewContextKey()
var attrNameID = []byte("id")

func parseOrGenerateHeadingID(node *ast.Heading, pc Context) {
	existsv := pc.Get(headingIDMap)
	var exists map[string]bool
	if existsv == nil {
		exists = map[string]bool{}
		pc.Set(headingIDMap, exists)
	} else {
		exists = existsv.(map[string]bool)
	}
	lastIndex := node.Lines().Len() - 1
	lastLine := node.Lines().At(lastIndex)
	line := lastLine.Value(pc.Source())
	m := headingIDRegexp.FindSubmatchIndex(line)
	var headingID []byte
	if m != nil {
		headingID = line[m[6]:m[7]]
		lastLine.Stop -= m[5] - m[4]
		node.Lines().Set(lastIndex, lastLine)
	} else {
		headingID = util.GenerateLinkID(line, exists)
	}
	node.SetAttribute(attrNameID, headingID)
}