semantic

Documentation

Overview

Package semantic contains semantic checking for AST parsed from a IDL.

Index

• func Deref(ast *parser.Thrift, t *parser.Type) (*parser.Thrift, *parser.Type, error)
• func IDLPrefix(filename string) string
• func ResolveSymbols(ast *parser.Thrift) error
• func SplitType(id string) []string
• func SplitValue(id string) (sss [][]string)
• type Checker
  • func NewChecker(opt Options) Checker
• type Options

Functions

func Deref

func Deref(ast *parser.Thrift, t *parser.Type) (*parser.Thrift, *parser.Type, error)

Deref returns the target type that t refers to and the AST it belongs to. Typedef will be dereferenced.

func IDLPrefix

func IDLPrefix(filename string) string

IDLPrefix returns the file name without extension.

func ResolveSymbols

func ResolveSymbols(ast *parser.Thrift) error

ResolveSymbols checks the existence of each symbol in the current AST and build a name-to-category mapping for all locally-defined symbols. If a type, a value or a service refers to another one from an external IDL, the index of that IDL in the include list will be recorded. ResolveSymbols stops when it encounters any error.

func SplitType

func SplitType(id string) []string

SplitType tries to split the given ID into two part: the name of an included IDL without file extension and the type name in that IDL. If ID is a type name containing no dot, then the it is returned unchanged.

func SplitValue

func SplitValue(id string) (sss [][]string)

SplitValue tries to find any possible resolution of the given ID assuming it is a name of a constant value or an enum value. When ID contains no dot, it is returned unchanged. Otherwise, this function tries to explain it as 'IDL.Value' or as 'IDL.EnumType.Value' and to return all possible divisions.

Types

type Checker

type Checker interface {
	CheckAll(t *parser.Thrift) (warns []string, err error)
}

Checker reports whether there are semantic errors in the AST and produces warning messages for non-fatal errors.

func NewChecker

func NewChecker(opt Options) Checker

NewChecker creates a checker.

type Options

type Options struct {
	FixWarnings bool
}

Options controls the behavior of the default checker.