saiast

Documentation

Overview

Package saiast contains information parsed from AST of the SAI header.

Index

• func TrimSAIName(name string, makeCamel, makeUpper bool) string
• type FuncMetadata
• type SAIAPI
  • func Get(ast *cc.AST) *SAIAPI
  • func (sai *SAIAPI) GetFuncMeta(fn *TypeDecl) *FuncMetadata
• type SAIFunc
• type SAIInterface
• type TypeDecl

Functions

func TrimSAIName

func TrimSAIName(name string, makeCamel, makeUpper bool) string

TrimSAIName trims sai_ prefix and _t from the string

Types

type FuncMetadata

type FuncMetadata struct {
	// Name is the name of the function: create_acl_table
	Name string
	// Operation is the action to take: create
	Operation string
	// TypeName is the name of the type: acl_table
	TypeName string
	// Entry is the name of the entry using the instead of id.
	Entry string
	// IsSwitchScoped is whether the API take a switch id as a parameter.
	IsSwitchScoped bool
}

FuncMetadata contains additional information derived from a func definition.

type SAIAPI

type SAIAPI struct {
	Ifaces []*SAIInterface
	Funcs  map[string]*SAIFunc
}

SAIAPI contains the information retreived from the AST.

func Get

func Get(ast *cc.AST) *SAIAPI

Get returns the information parses from the AST.

func (*SAIAPI) GetFuncMeta

func (sai *SAIAPI) GetFuncMeta(fn *TypeDecl) *FuncMetadata

GetFuncMeta returns the metadata for a SAI func.

type SAIFunc

type SAIFunc struct {
	Name       string
	ReturnType string
	Params     []TypeDecl
}

SAIFunc is a function definition.

type SAIInterface

type SAIInterface struct {
	Name  string
	Funcs []*TypeDecl
}

SAIInterface contains the functions contained in the interface.

type TypeDecl

type TypeDecl struct {
	Name string
	Typ  string
}

TypeDecl stores the name and type of a declation.