parse

Documentation

Overview

Package parse provides parsing facilities for supertext files.

Index

• func ParseGeoLocation(coords string) (float64, float64, bool)
• type Lexed
  • func Lex(text string) Lexed
  • func (p Lexed) DocHeading() bool
  • func (p Lexed) DocSummary(level uint8, maxlen int) string
  • func (p Lexed) Lookup(anchor string) (Lexed, bool)
  • func (p Lexed) SubTree() Lexed
  • func (p Lexed) Values(key string) Lexed
  • func (p Lexed) Write(w io.Writer) error
• type Token
  • func (n Token) Rest() string
  • func (n Token) TocView() string
• type TokenType

Functions

func ParseGeoLocation

func ParseGeoLocation(coords string) (float64, float64, bool)

Types

type Lexed

type Lexed []Token

func Lex

func Lex(text string) Lexed

func (Lexed) DocHeading

func (p Lexed) DocHeading() bool

func (Lexed) DocSummary

func (p Lexed) DocSummary(level uint8, maxlen int) string

func (Lexed) Lookup

func (p Lexed) Lookup(anchor string) (Lexed, bool)

func (Lexed) SubTree

func (p Lexed) SubTree() Lexed

func (Lexed) Values

func (p Lexed) Values(key string) Lexed

func (Lexed) Write

func (p Lexed) Write(w io.Writer) error

type Token

type Token struct {
	Typ       TokenType
	Line      int
	Offset    int // Counted in runes
	EndOffset int // Counted in runes

	Anchor string // HEADING, PREFORMATTED, LINK
	Key    string // POINT, HEADING

	DataType string // POINT

	// HEADING
	Title string
	Level uint8

	// PARAGRAPH, PREFORMATTED, QUOTE
	Body string

	// POINT, LINK
	Value string

	// PREFORMATTED
	Ext string
}

func (Token) Rest

func (n Token) Rest() string

func (Token) TocView

func (n Token) TocView() string

type TokenType

type TokenType int

const (
	PARAGRAPH TokenType = iota
	HEADING
	PREFORMATTED
	LINK
	POINT
	QUOTE
)