ttcn3

Documentation

Overview

Package ttcn3 provides routines for evaluating TTCN-3 source code.

This package is in alpha stage, as we are still figuring out requirements and interfaces.

Index

• type DB
  • func (db *DB) Index(files ...string)
  • func (db *DB) VisibleModules(id string, mod *ast.Module) []*Definition
• type Definition
  • func Definitions(id string, n ast.Node, t *Tree) []*Definition
• type Scope
  • func NewScope(n ast.Node, tree *Tree) *Scope
  • func (scp *Scope) Insert(n ast.Node, id *ast.Ident)
  • func (scp *Scope) Lookup(name string) []*Definition
• type Tree
  • func Parse(src string) *Tree
  • func ParseFile(path string) *Tree
  • func (t *Tree) Components() []*ast.ComponentTypeDecl
  • func (t *Tree) Controls() []*ast.ControlPart
  • func (tree *Tree) ExprAt(pos loc.Pos) ast.Expr
  • func (t *Tree) Filename() string
  • func (t *Tree) Funcs() []*ast.FuncDecl
  • func (t *Tree) Imports() []*ast.ImportDecl
  • func (tree *Tree) Lookup(n ast.Expr) []*Definition
  • func (tree *Tree) LookupWithDB(n ast.Expr, db *DB) []*Definition
  • func (t *Tree) ModuleOf(n ast.Node) *ast.Module
  • func (t *Tree) ModulePars() []*ast.Declarator
  • func (t *Tree) Modules() []*ast.Module
  • func (t *Tree) ParentOf(n ast.Node) ast.Node
  • func (t *Tree) Ports() []*ast.PortTypeDecl
  • func (tree *Tree) Pos(line int, column int) loc.Pos
  • func (tree *Tree) Position(pos loc.Pos) loc.Position
  • func (tree *Tree) SliceAt(pos loc.Pos) []ast.Node

Types

type DB

type DB struct {
	// Names is a map from symbol name to a list of files that contain the symbol.
	Names map[string]map[string]bool

	// Modules maps from module name to file path.
	Modules map[string]map[string]bool
	// contains filtered or unexported fields
}

DB implements database for querying TTCN-3 source code bases.

func (*DB) Index

func (db *DB) Index(files ...string)

Index parses TTCN-3 source files and adds names and dependencies to the database.

func (*DB) VisibleModules

func (db *DB) VisibleModules(id string, mod *ast.Module) []*Definition

VisibleModules returns a list of modules that may contain the given symbol. First parameter id specifies the symbol to look for and second parameter module specifies where the imports come from.

type Definition

type Definition struct {
	*ast.Ident
	ast.Node
	*Tree
	Next *Definition
}

func Definitions

func Definitions(id string, n ast.Node, t *Tree) []*Definition

type Scope

type Scope struct {
	ast.Node
	Tree  *Tree
	Names map[string]*Definition
}

func NewScope

func NewScope(n ast.Node, tree *Tree) *Scope

NewScope builts and populares a new scope from the given syntax node. NewScope returns nil if no valid scope could be built.

func (*Scope) Insert

func (scp *Scope) Insert(n ast.Node, id *ast.Ident)

func (*Scope) Lookup

func (scp *Scope) Lookup(name string) []*Definition

Lookup returns a list of defintions for the given identifier. Lookup may be called with nil as receiver.

type Tree

type Tree struct {
	FileSet *loc.FileSet
	Root    ast.Node
	Names   map[string]bool
	Err     error
	// contains filtered or unexported fields
}

Tree represents the TTCN-3 syntax tree, usually of a file.

func Parse

func Parse(src string) *Tree

Parse parses a string and returns a syntax tree.

func ParseFile

func ParseFile(path string) *Tree

ParseFile parses a file and returns a syntax tree.

func (*Tree) Components

func (t *Tree) Components() []*ast.ComponentTypeDecl

func (*Tree) Controls

func (t *Tree) Controls() []*ast.ControlPart

func (*Tree) ExprAt

func (tree *Tree) ExprAt(pos loc.Pos) ast.Expr

ExprAt returns the primary expression at the given position.

func (*Tree) Filename

func (t *Tree) Filename() string

Filename returns the filename of the file that was parsed.

func (*Tree) Funcs

func (t *Tree) Funcs() []*ast.FuncDecl

func (*Tree) Imports

func (t *Tree) Imports() []*ast.ImportDecl

func (*Tree) Lookup

func (tree *Tree) Lookup(n ast.Expr) []*Definition

Lookup returns the definitions of the given expression. For handling imports and multiple modules, use LookupWithDB.

func (*Tree) LookupWithDB

func (tree *Tree) LookupWithDB(n ast.Expr, db *DB) []*Definition

LookupWithDB returns the definitions of the given expression, but uses the database for import resoltion.

func (*Tree) ModuleOf

func (t *Tree) ModuleOf(n ast.Node) *ast.Module

ModuleOf returns the module of the given node, by walking up the tree.

func (*Tree) ModulePars

func (t *Tree) ModulePars() []*ast.Declarator

func (*Tree) Modules

func (t *Tree) Modules() []*ast.Module

func (*Tree) ParentOf

func (t *Tree) ParentOf(n ast.Node) ast.Node

ParentOf returns the parent of the given node.

func (*Tree) Ports

func (t *Tree) Ports() []*ast.PortTypeDecl

func (*Tree) Pos

func (tree *Tree) Pos(line int, column int) loc.Pos

Pos encodes a line and column tuple into a offset-based Pos tag. If file nas not been parsed yet, Pos will return loc.NoPos.

func (*Tree) Position

func (tree *Tree) Position(pos loc.Pos) loc.Position

Position return a human readable position of the node.

func (*Tree) SliceAt

func (tree *Tree) SliceAt(pos loc.Pos) []ast.Node

SliceAt returns the slice of nodes at the given position.