parser

Documentation

Overview

Package parser implements a parser for converting the api language into abstract syntax trees.

Index

• func Parse(filename, data string, m ParseMap) (*ast.API, parse.ErrorList)
• type ParseMap
  • func NewParseMap() ParseMap

Functions

func Parse

func Parse(filename, data string, m ParseMap) (*ast.API, parse.ErrorList)

Parse takes a string containing a complete api description and returns the abstract syntax tree representation of it. If the string is not syntactically valid, it will also return the errors encountered. If errors are returned, the ast returned will be the incomplete tree so far, and may not be structurally valid.

Types

type ParseMap

type ParseMap interface {
	// The map object passed to parsers must support the interface used by the
	// parsing library.
	parse.CSTMap
}

ParseMap is the interface to an object into which ast<->cts mappings are stored.

func NewParseMap

func NewParseMap() ParseMap

NewParseMap returns a simple implementation of ParseMap sufficient for basic mapping use cases.