token

Documentation

Overview

Package token declares a number of constants that represent lexical tokens in spok as well as basic operations on those tokens e.g. printing

Index

• type Token
  • func (t Token) Is(typ Type) bool
  • func (t Token) String() string
• type Type
  • func (i Type) String() string

Types

type Token

type Token struct {
	Value string // Value, e.g. "("
	Type  Type   // Type, e.g. LPAREN
	Pos   int    // Starting position of this token in the input string
	Line  int    // Line number at the start of this token
}

Token represents a spok lexical token.

func (Token) Is

func (t Token) Is(typ Type) bool

Is returns whether or not the current token is of a certain type.

func (Token) String

func (t Token) String() string

String satisfies the stringer interface and allows us to pretty print the tokens.

type Type

type Type int

Type is the set of lexical tokens in spok.

const (
	EOF     Type = iota // EOF
	ERROR               // ERROR
	COMMENT             // COMMENT
	HASH                // #
	LPAREN              // (
	RPAREN              // )
	LBRACE              // {
	RBRACE              // }
	QUOTE               // "
	COMMA               // ,
	TASK                // task
	STRING              // STRING
	COMMAND             // COMMAND
	OUTPUT              // ->
	IDENT               // IDENT
	DECLARE             // :=
	LINTERP             // {{
	RINTERP             // }}
)

Note: EOF is the zero value such that when the parser reads from a closed channel the read value will be token.EOF.

func (Type) String

func (i Type) String() string