parser

Documentation

Overview

Package parser turns the source text into a sequence of blocks.

Index

• func MakeFormatted(firstLine, hyphaName string) blocks.Formatted
• func MakeHeading(line, hyphaName string, level uint) blocks.Heading
• func Parse(ctx mycocontext.Context, out chan blocks.Block)
• func ParseImgFirstLine(line, hyphaName string) (img blocks.Img, imgFinished bool)
• func ProcessImgLine(img *blocks.Img, line string) (imgFinished bool)
• func ProcessImgRune(img *blocks.Img, r rune) (done bool)
• func ProcessInDescription(img *blocks.Img, r rune) (shouldReturnTrue bool)
• func ProcessInDimensionsH(img *blocks.Img, r rune) (imgFinished bool)
• func ProcessInDimensionsW(img *blocks.Img, r rune) (shouldReturnTrue bool)
• func ProcessInName(img *blocks.Img, r rune) (shouldReturnTrue bool)
• func ProcessInRoot(img *blocks.Img, r rune) (shouldReturnTrue bool)
• func PushImgEntry(img *blocks.Img)

Functions

func MakeFormatted

func MakeFormatted(firstLine, hyphaName string) blocks.Formatted

MakeFormatted parses the formatted text in the input and returns it. Does it?

func MakeHeading

func MakeHeading(line, hyphaName string, level uint) blocks.Heading

MakeHeading parses the heading on the given line and returns it. Set its level by yourself though.

func Parse

func Parse(ctx mycocontext.Context, out chan blocks.Block)

Parse parses the Mycomarkup document in the given context. All parsed blocks are written to out.

func ParseImgFirstLine

func ParseImgFirstLine(line, hyphaName string) (img blocks.Img, imgFinished bool)

ParseImgFirstLine parses the image gallery on the line and returns it. It also tells if the gallery is finished or not.

func ProcessImgLine

func ProcessImgLine(img *blocks.Img, line string) (imgFinished bool)

ProcessImgLine parses the line and tells if the gallery is finished.

func ProcessImgRune

func ProcessImgRune(img *blocks.Img, r rune) (done bool)

ProcessImgRune parses the rune.

func ProcessInDescription

func ProcessInDescription(img *blocks.Img, r rune) (shouldReturnTrue bool)

func ProcessInDimensionsH

func ProcessInDimensionsH(img *blocks.Img, r rune) (imgFinished bool)

func ProcessInDimensionsW

func ProcessInDimensionsW(img *blocks.Img, r rune) (shouldReturnTrue bool)

func ProcessInName

func ProcessInName(img *blocks.Img, r rune) (shouldReturnTrue bool)

func ProcessInRoot

func ProcessInRoot(img *blocks.Img, r rune) (shouldReturnTrue bool)

func PushImgEntry

func PushImgEntry(img *blocks.Img)

PushImgEntry pushes the most recent entry of Img to Img.Entries and creates a new entry. What an ugly function!