mdspan

Documentation

Index

• Variables
• func DetectAutomaticLink(s *Context) (consumed int)
• func DetectCode(s *Context) (consumed int)
• func DetectEmphasis(s *Context) (consumed int)
• func DetectEscapedChar(s *Context) (consumed int)
• func DetectImage(s *Context) (consumed int)
• func DetectLink(s *Context) (consumed int)
• func Parse(buf []byte, detectors []Detector) []md.Tag
• type Context
  • func (s *Context) Emit(slice []byte, tag interface{}, selfClose bool)
• type Detector
• type DetectorFunc
  • func (d DetectorFunc) Detect(s *Context) (consumed int)
• type MaybeOpening
• type NodeType
• type OpeningsStack
  • func (s OpeningsStack) NullTopmostTagged(tag string) bool
  • func (s OpeningsStack) Peek() *MaybeOpening
  • func (s *OpeningsStack) Pop()
  • func (s *OpeningsStack) PopTo(f func(*MaybeOpening) bool) (MaybeOpening, bool)
  • func (s *OpeningsStack) Push(o MaybeOpening)
• type Span

Variables

var DefaultDetectors = []Detector{
	DetectorFunc(DetectEscapedChar),
	DetectorFunc(DetectLink),
	DetectorFunc(DetectEmphasis),
	DetectorFunc(DetectCode),
	DetectorFunc(DetectImage),
	DetectorFunc(DetectAutomaticLink),
}

Functions

func DetectAutomaticLink

func DetectAutomaticLink(s *Context) (consumed int)

func DetectCode

func DetectCode(s *Context) (consumed int)

func DetectEmphasis

func DetectEmphasis(s *Context) (consumed int)

func DetectEscapedChar

func DetectEscapedChar(s *Context) (consumed int)

func DetectImage

func DetectImage(s *Context) (consumed int)

func DetectLink

func DetectLink(s *Context) (consumed int)

func Parse

func Parse(buf []byte, detectors []Detector) []md.Tag

Types

type Context

type Context struct {
	Buf      []byte
	Pos      int
	Openings OpeningsStack
	Spans    []Span
}

func (*Context) Emit

func (s *Context) Emit(slice []byte, tag interface{}, selfClose bool)

type Detector

type Detector interface {
	Detect(*Context) (consumed int)
}

type DetectorFunc

type DetectorFunc func(*Context) (consumed int)

func (DetectorFunc) Detect

func (d DetectorFunc) Detect(s *Context) (consumed int)

type MaybeOpening

type MaybeOpening struct {
	Tag string
	Pos int
}

type NodeType

type NodeType int

type OpeningsStack

type OpeningsStack []MaybeOpening

func (OpeningsStack) NullTopmostTagged

func (s OpeningsStack) NullTopmostTagged(tag string) bool

func (OpeningsStack) Peek

func (s OpeningsStack) Peek() *MaybeOpening

func (*OpeningsStack) Pop

func (s *OpeningsStack) Pop()

func (*OpeningsStack) PopTo

func (s *OpeningsStack) PopTo(f func(*MaybeOpening) bool) (MaybeOpening, bool)

func (*OpeningsStack) Push

func (s *OpeningsStack) Push(o MaybeOpening)

type Span

type Span struct {
	// Pos is a subslice of the original input buffer
	Pos       []byte
	Tag       md.Tag
	SelfClose bool
}