libparser

README

Tomefile Parser

Library to parse Tomefile code and output statements similar to AST for use by another program.

Uses just-in-time compilation to allow for execution of statements as soon as possible rather than waiting for the entire code to parse first. It comes with a drawback of not catching errors ahead of time.

Documentation

Index

• Variables
• type FormatModifier
  • func GetModifier(name string, args []string) FormatModifier
• type FormatPart
• type Formatter
  • func NewFormatter(reader io.Reader) *Formatter
  • func (formatter *Formatter) Parse() ([]FormatPart, error)
  • func (formatter *Formatter) Read() (rune, error)
• type LiteralFormat
  • func (format LiteralFormat) Eval(_ Scope) (string, error)
• type Node
  • func (node *Node) IsError() bool
• type NodeType
• type Parser
  • func New(reader *bufio.Reader, consumer chan *Node) *Parser
  • func (parser *Parser) ParseComplete()
  • func (parser *Parser) ParseFragmented()
• type Scope
• type VariableFormat
  • func (format VariableFormat) Eval(scope Scope) (string, error)

Variables

var Null = &Node{Type: NODE_NULL}

Types

type FormatModifier

type FormatModifier func(string) string

func GetModifier

func GetModifier(name string, args []string) FormatModifier

type FormatPart

type FormatPart interface {
	Eval(Scope) (string, error)
}

type Formatter

type Formatter struct {
	Reader *bufio.Reader
	// contains filtered or unexported fields
}

func NewFormatter

func NewFormatter(reader io.Reader) *Formatter

func (*Formatter) Parse

func (formatter *Formatter) Parse() ([]FormatPart, error)

func (*Formatter) Read

func (formatter *Formatter) Read() (rune, error)

type LiteralFormat

type LiteralFormat struct {
	Literal string
}

func (LiteralFormat) Eval

func (format LiteralFormat) Eval(_ Scope) (string, error)

type Node

type Node struct {
	Parent *Node // Optional

	Type    NodeType
	Literal string
	Args    []any // can either contain [string] or [*Node]

	// The offset in bytes where this node begins
	OffsetStart uint
	// The offset in bytes where this node ends
	OffsetEnd uint

	Col, Row uint
	// Equals 0 if offset range is multi-line. Otherwise the length starting from [.Col]
	Length uint

	Children []*Node // Optional
}

func (*Node) IsError

func (node *Node) IsError() bool

type NodeType

type NodeType byte

const (
	NODE_NULL NodeType = iota
	NODE_COMMENT
	NODE_DIRECTIVE
	NODE_MACRO
	NODE_EXEC

	NODE_ERROR_READ
	NODE_ERROR_SYNTAX

	ErrMin = NODE_ERROR_READ
	ErrMax = NODE_ERROR_SYNTAX
)

type Parser

type Parser struct {
	Reader  *internal.AdvancedReader
	Channel chan *Node
	// contains filtered or unexported fields
}

func New

func New(reader *bufio.Reader, consumer chan *Node) *Parser

func (*Parser) ParseComplete

func (parser *Parser) ParseComplete()

Nodes are returned only once all of their children are read (slow). Sets Node.Children if applicable. Node.Parent is always nil to prevent pointer recursion

func (*Parser) ParseFragmented

func (parser *Parser) ParseFragmented()

Nodes are returned as soon as they are read (fast). Sets Node.Parent. Node.Children is always nil

type Scope

type Scope map[string]string

type VariableFormat

type VariableFormat struct {
	Name       string
	Modifier   FormatModifier
	IsOptional bool
}

func (VariableFormat) Eval

func (format VariableFormat) Eval(scope Scope) (string, error)