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

• func JoinNames(names ...string) string
• func ModuleName(s string) string
• type DB
  • func (db *DB) Index(files ...string)
  • func (db *DB) VisibleModules(id string, mod *syntax.Module) []*Node
• type Node
  • func Definitions(id string, n syntax.Node, t *Tree) []*Node
  • func Inspect(files []string, fn func(*Tree) []*Node) ([]*Node, error)
• type NodeEvent
• type Scope
  • func NewScope(n syntax.Node, tree *Tree) *Scope
  • func (scp *Scope) Insert(n syntax.Node, id *syntax.Ident)
  • func (scp *Scope) Lookup(name string) []*Node
• type Source
• type Tree
  • func Parse(src string) *Tree
  • func ParseFile(path string) *Tree
  • func (t *Tree) Components() []*Node
  • func (t *Tree) Controls() []*Node
  • func (t *Tree) ExprAt(pos int) syntax.Expr
  • func (t *Tree) Filename() string
  • func (t *Tree) Funcs() []*Node
  • func (t *Tree) IdentifierAt(line, col int) syntax.Expr
  • func (t *Tree) Imports() []*Node
  • func (t *Tree) Lookup(n syntax.Expr) []*Node
  • func (t *Tree) LookupWithDB(n syntax.Expr, db *DB) []*Node
  • func (t *Tree) ModuleOf(n syntax.Node) *syntax.Module
  • func (t *Tree) ModulePars() []*Node
  • func (t *Tree) Modules() []*Node
  • func (t *Tree) ParentOf(n syntax.Node) syntax.Node
  • func (t *Tree) Ports() []*Node
  • func (t *Tree) QualifiedName(n syntax.Node) string
  • func (tree *Tree) Tags() []syntax.Node
  • func (t *Tree) Tests() []*Node
  • func (t *Tree) TypeOf(n syntax.Node, db *DB) []*Node

Functions

func JoinNames

func JoinNames(names ...string) string

JoinNames joins a list of non-empty names with a dot.

func ModuleName

func ModuleName(s string) string

ModuleName returns the module name part of a name string or an empty string if there is no module name.

Types

type DB

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

	// Uses maps from symbol name to a list of files that use the symbol.
	Uses 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 *syntax.Module) []*Node

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 Node

type Node struct {
	*syntax.Ident
	syntax.Node
	*Tree
	Next *Node
}

func Definitions

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

func Inspect

func Inspect(files []string, fn func(*Tree) []*Node) ([]*Node, error)

Inspect the AST and return a list of all the definitions found by fn.

type NodeEvent

type NodeEvent struct {
	// Kind is the type of an node event (AddToken, OpenFooBar, CloseFooBar).
	Kind string `json:"kind"`

	// Text is the text of a AddToken event.
	Text string `json:"text,omitempty"`

	// Offset is the position of the first character belonging to the node.
	Offs int `json:"offs"`

	// End is the position of the first character immediately after the node.
	Len int `json:"len"`

	// Other is the index of the matching node event.
	Other int `json:"other,omitempty"`
}

type Scope

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

func NewScope

func NewScope(n syntax.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 syntax.Node, id *syntax.Ident)

func (*Scope) Lookup

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

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

type Source

type Source struct {
	Filename string
	Events   []NodeEvent `json:"events"`
}

type Tree

type Tree struct {
	*syntax.Root
	Names map[string]bool
	Uses  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() []*Node

func (*Tree) Controls

func (t *Tree) Controls() []*Node

func (*Tree) ExprAt

func (t *Tree) ExprAt(pos int) syntax.Expr

ExprAt returns the expression at 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() []*Node

func (*Tree) IdentifierAt

func (t *Tree) IdentifierAt(line, col int) syntax.Expr

IdentifierAt returns the primary expression enclosing the identifer at the given position.

func (*Tree) Imports

func (t *Tree) Imports() []*Node

func (*Tree) Lookup

func (t *Tree) Lookup(n syntax.Expr) []*Node

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

func (*Tree) LookupWithDB

func (t *Tree) LookupWithDB(n syntax.Expr, db *DB) []*Node

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

func (*Tree) ModuleOf

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

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

func (*Tree) ModulePars

func (t *Tree) ModulePars() []*Node

func (*Tree) Modules

func (t *Tree) Modules() []*Node

func (*Tree) ParentOf

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

ParentOf returns the parent of the given node.

func (*Tree) Ports

func (t *Tree) Ports() []*Node

func (*Tree) QualifiedName

func (t *Tree) QualifiedName(n syntax.Node) string

Returns the qualified name of the given node.

func (*Tree) Tags

func (tree *Tree) Tags() []syntax.Node

func (*Tree) Tests

func (t *Tree) Tests() []*Node

func (*Tree) TypeOf

func (t *Tree) TypeOf(n syntax.Node, db *DB) []*Node