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) ResolveAt(file string, line int, col int) []*Definition
• type Definition
• type Scope
  • func NewScope(n ast.Node, tree *Tree) *Scope
  • func (scp *Scope) Insert(id *ast.Ident)
• 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 (t *Tree) Funcs() []*ast.FuncDecl
  • func (t *Tree) Imports() []*ast.ImportDecl
  • func (t *Tree) ModulePars() []*ast.Declarator
  • func (t *Tree) Modules() []*ast.Module
  • 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) ResolveAt

func (db *DB) ResolveAt(file string, line int, col int) []*Definition

type Definition

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

type Scope

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

func NewScope

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

func (*Scope) Insert

func (scp *Scope) Insert(id *ast.Ident)

type Tree

type Tree struct {
	FileSet *loc.FileSet
	Root    ast.NodeList
	Names   map[string]bool
	Err     error
}

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) Funcs

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

func (*Tree) Imports

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

func (*Tree) ModulePars

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

func (*Tree) Modules

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

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