symbols

Documentation

Overview

Package symbols is a static reposistory of the symbols of generated parser. It is used by all code generation modules

Index

• func GetNonTerminalSymbols() []string
• func GetSymbols() []string
• func GetTerminalSymbols() []string
• func GetTerminalTypeStrings() []string
• func Init(g *ast.GoGLL)
• func IsNonTerminal(sym string) bool
• type NT
  • func GetNTType(nt string) NT
  • func GetNonTerminals() []NT
  • func (nt NT) GoString() string
  • func (NT) IsNonTerminal() bool
  • func (nt NT) Literal() string
  • func (nt NT) String() string
• type Symbol
  • func FromASTString(astSym string) Symbol
• type Symbols
  • func (ss Symbols) Empty() bool
  • func (ss Symbols) GoStrings() []string
  • func (ss Symbols) Strings() []string
• type T
  • func GetTerminals() []T
  • func TerminalLiteralToType(s string) T
  • func (t T) GoString() string
  • func (t T) ID() string
  • func (T) IsNonTerminal() bool
  • func (t T) Literal() string
  • func (t T) String() string
  • func (t T) Suppress() bool
  • func (t T) TypeString() string

Functions

func GetNonTerminalSymbols

func GetNonTerminalSymbols() []string

GetNonTerminalSymbols returns the list of non-terminals used by code generation modules

func GetSymbols

func GetSymbols() []string

GetSymbols returns the code strings of all the NT and T symbols

func GetTerminalSymbols

func GetTerminalSymbols() []string

GetTerminalSymbols returns the list of symbol strings used by code generation modules of the terminals

func GetTerminalTypeStrings

func GetTerminalTypeStrings() []string

GetTerminalTypeStrings returns the type strings of the terminals in order of their types.

func Init

func Init(g *ast.GoGLL)

Init initialises the symbols

func IsNonTerminal

func IsNonTerminal(sym string) bool

Types

type NT

type NT int

NT is the type of a non-terminal symbol

func GetNTType

func GetNTType(nt string) NT

GetNTType returns the NT values of nt

func GetNonTerminals

func GetNonTerminals() []NT

GetNonTerminals returns the list of non-terminals used by code generation modules

func (NT) GoString

func (nt NT) GoString() string

GoString returns the Go representation of nt used by code generation modules

func (NT) IsNonTerminal

func (NT) IsNonTerminal() bool

IsNonTerminal always returns true if the symbol is a non-terminal

func (NT) Literal

func (nt NT) Literal() string

Literal returns the literal value of nt in the grammar

func (NT) String

func (nt NT) String() string

String returns the string representation of nt used by code generation modules

type Symbol

type Symbol interface {

	// IsNonTerminal returns true iff this symbol is a non-terminal
	IsNonTerminal() bool

	// Literal returns the literal value of the symbol in the grammar
	Literal() string

	// GoString returns the Go representation of the symbol that is used
	// for code generation
	GoString() string

	// String returns the string representation of the symbol that is used
	// for code generation
	String() string
	// contains filtered or unexported methods
}

Symbol is T or NT

func FromASTString

func FromASTString(astSym string) Symbol

FromASTString translates an AST symbol string to Symbol

type Symbols

type Symbols []Symbol

Symbols is a list of Symbol

func (Symbols) Empty

func (ss Symbols) Empty() bool

Empty returns true iff ss is empty

func (Symbols) GoStrings

func (ss Symbols) GoStrings() []string

GoStrings returns a slice containing the Go representation of the the symbols in ss used by code generation modules

func (Symbols) Strings

func (ss Symbols) Strings() []string

Strings returns a slice containing the string representation of the the symbols in ss used for printing

type T

type T int

T is the type of a terminal symbol

const (
	Error T = iota
	EoF
	StartOfTokens // First user defined token
)

func GetTerminals

func GetTerminals() []T

GetTerminals returns the list of terminals used by code generation modules

func TerminalLiteralToType

func TerminalLiteralToType(s string) T

TerminalLiteralToType returns the T corresponding to the terminal litral s

func (T) GoString

func (t T) GoString() string

GoString returns the Go representation of t used by code generation modules

func (T) ID

func (t T) ID() string

func (T) IsNonTerminal

func (T) IsNonTerminal() bool

IsNonTerminal always returns false if the symbol is a terminal

func (T) Literal

func (t T) Literal() string

Literal returns the literal value of t in the grammar

func (T) String

func (t T) String() string

String returns the string representation of t used by code generation modules

func (T) Suppress

func (t T) Suppress() bool

Suppress returns true iff t is suppressed by the lexer

func (T) TypeString

func (t T) TypeString() string

TypeString returns the Go representation of t used by code generation modules