latex

README

go-latex

This package is a simple LaTeX parser which is used by Eolymp to render problem statements written using LaTeX.

Documentation

Index

• Constants
• func KeyValue(raw string) (map[string]string, error)
• func Measure(raw string) (float32, string, error)
• func MeasurePixels(raw string) (float32, error)
• func Render(w io.Writer, node *Node) error
• func String(node *Node) (out string)
• func ToPixels(value float32, unit string) (float32, error)
• type ColumnSpec
  • func ColumnSpecs(raw string) (spec []ColumnSpec)
• type Command
• type EnvironmentEnd
• type EnvironmentStart
• type Kind
• type Node
  • func Parse(r Scanner) (*Node, error)
  • func Strict(r Scanner) (*Node, error)
• type OptionalEnd
• type OptionalStart
• type ParameterEnd
• type ParameterStart
• type Parser
  • func NewParser(r Scanner) *Parser
  • func NewStrictParser(r Scanner) *Parser
  • func (p *Parser) Define(key, val string)
  • func (p *Parser) Parse() (*Node, error)
  • func (p *Parser) Value(key string) string
• type Scanner
• type Symbol
• type Text
• type Tokenizer
  • func NewTokenizer(r Scanner) *Tokenizer
  • func (l *Tokenizer) Peek() (rune, error)
  • func (l *Tokenizer) Skip() error
  • func (l *Tokenizer) SkipEOL() error
  • func (l *Tokenizer) Token() (any, error)
  • func (l *Tokenizer) Verbatim(stop func(rune, error) bool) (string, error)
• type Verbatim

Constants

const (
	TextKind = iota
	DocumentKind
	ElementKind
)

Functions

func KeyValue

func KeyValue(raw string) (map[string]string, error)

func Measure

func Measure(raw string) (float32, string, error)

Measure parses measurement value, a number and units, for example: 5.1cm, 6em, 0.25\textwidth

func MeasurePixels

func MeasurePixels(raw string) (float32, error)

func Render

func Render(w io.Writer, node *Node) error

func String

func String(node *Node) (out string)

func ToPixels

func ToPixels(value float32, unit string) (float32, error)

Types

type ColumnSpec

type ColumnSpec struct {
	BorderLeft  bool   // column should have left border
	BorderRight bool   // column should have right border
	Align       string // column alignment: c, l or r
}

func ColumnSpecs

func ColumnSpecs(raw string) (spec []ColumnSpec)

ColumnSpecs parses column spec in tabular environment todo: add support for repeated syntax *{x}{...} todo: if not support, at least correctly handle @{} and !{}

type Command

type Command string

type EnvironmentEnd

type EnvironmentEnd struct {
	Name string
}

type EnvironmentStart

type EnvironmentStart struct {
	Name string
}

type Kind

type Kind int

type Node

type Node struct {
	Kind       Kind
	Parameters map[string]string
	Data       string
	Children   []*Node
}

func Parse

func Parse(r Scanner) (*Node, error)

func Strict

func Strict(r Scanner) (*Node, error)

type OptionalEnd

type OptionalEnd struct {
}

type OptionalStart

type OptionalStart struct {
}

type ParameterEnd

type ParameterEnd struct {
}

type ParameterStart

type ParameterStart struct {
}

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func NewParser

func NewParser(r Scanner) *Parser

func NewStrictParser

func NewStrictParser(r Scanner) *Parser

func (*Parser) Define

func (p *Parser) Define(key, val string)

func (*Parser) Parse

func (p *Parser) Parse() (*Node, error)

func (*Parser) Value

func (p *Parser) Value(key string) string

type Scanner

type Scanner interface {
	io.RuneScanner
	io.Seeker
}

type Symbol

type Symbol string

type Text

type Text string

type Tokenizer

type Tokenizer struct {
	// contains filtered or unexported fields
}

func NewTokenizer

func NewTokenizer(r Scanner) *Tokenizer

func (*Tokenizer) Peek

func (l *Tokenizer) Peek() (rune, error)

func (*Tokenizer) Skip

func (l *Tokenizer) Skip() error

Skip until next non-whitespace symbol

func (*Tokenizer) SkipEOL

func (l *Tokenizer) SkipEOL() error

Skip until next non-whitespace symbol or end of line

func (*Tokenizer) Token

func (l *Tokenizer) Token() (any, error)

func (*Tokenizer) Verbatim

func (l *Tokenizer) Verbatim(stop func(rune, error) bool) (string, error)

Verbatim reads render rune by rune until stop returns true

type Verbatim

type Verbatim struct {
	Kind string
	Attr map[string]string
	Data string
}