parser

Documentation

Index

• func Parse(src []byte, name string, mode Mode) (*ast.File, error)
• type Mode
• type ParseError
  • func (e *ParseError) Error() string

Functions

func Parse

func Parse(src []byte, name string, mode Mode) (*ast.File, error)

Parse reads and parses a shell program with an optional name. It returns the parsed program if no issues were encountered. Otherwise, an error is returned.

Types

type Mode

type Mode uint

Mode controls the parser behaviour via a set of flags.

const (
	ParseComments   Mode = 1 << iota // add comments to the AST
	PosixConformant                  // match the POSIX standard where it differs from bash
)

type ParseError

type ParseError struct {
	token.Position
	Filename, Text string
}

ParseError represents an error found when parsing a source file.

func (*ParseError) Error

func (e *ParseError) Error() string