parse

Documentation

Overview

Package parse provides the functionality for parsing raw text into an

in memory representation of Go

For Example: Raw text -> Functions Raw text -> Expression ...and so on

Index

• type Classifier
• type Expression
  • func (e Expression) String() string
  • func (e *Expression) Type() T
• type Function
  • func (f Function) String() (str string)
  • func (f Function) Type() T
• type T

Types

type Classifier

type Classifier interface {
	Type() T
}

Classifier allows types to identify themselves

type Expression

type Expression struct {
	Raw string
}

Expression is anything that is not a function

func (Expression) String

func (e Expression) String() string

func (*Expression) Type

func (e *Expression) Type() T

Type is an identifier for the Function type

type Function

type Function struct {
	// Raw, the raw input which was determined to be a function
	Raw string

	// Identifier, the identifier of the function.
	// For example:
	// func a() {}
	// Identifier would = a
	Identifier string

	// Params is a raw string which identifies the parameters of the function
	Params string

	// Return is the return signature of the function
	Return string

	// Body is everything which is contained in the function
	Body string
}

Function is the in memory representation of a function

func (Function) String

func (f Function) String() (str string)

func (Function) Type

func (f Function) Type() T

Type is an identifier for the Function type

type T

type T int

T is a constant identifier for concepts in Go

const (
	// Tfunction represents a parse.Function
	Tfunction T = iota

	// Texpression represents a parse.Expression
	Texpression
)