scanner

Documentation

Overview

Package scanner provides a TTCN-3 scanner

Index

• type ErrorHandler
• type SMode
• type Scanner
  • func (s *Scanner) Init(file *loc.File, src []byte, err ErrorHandler)
  • func (s *Scanner) Scan() (pos loc.Pos, tok token.Kind, lit string)

Types

type ErrorHandler

type ErrorHandler func(pos loc.Position, msg string)

An ErrorHandler may be provided to Scanner.Init. If a syntax error is encountered and a handler was installed, the handler is called with a position and an error message. The position points to the beginning of the offending

type SMode

type SMode uint

A SMode value is a set of flags (or 0). They control scanner behavior.

const (
	ScanComments SMode = 1 << iota // return comments as COMMENT tokens
)

type Scanner

type Scanner struct {
	Err ErrorHandler // error reporting; or nil

	// public state - ok to modify
	ErrorCount int // number of errors encountered
	// contains filtered or unexported fields
}

A Scanner holds the scanner's internal state while processing a given text. It can be allocated as part of another data structure but must be initialized via Init before use.

func (*Scanner) Init

func (s *Scanner) Init(file *loc.File, src []byte, err ErrorHandler)

Init prepares the scanner s to tokenize the text src by setting the scanner at the beginning of src. The scanner uses the file set file for position information and it adds line information for each line. It is ok to re-use the same file when re-scanning the same file as line information which is already present is ignored. Init causes a panic if the file size does not match the src size.

Calls to Scan will invoke the error handler Err if they encounter a syntax error and Err is not nil. Also, for each error encountered, the Scanner field ErrorCount is incremented by one.

Note that Init may call Err if there is an error in the first character of the file.

func (*Scanner) Scan

func (s *Scanner) Scan() (pos loc.Pos, tok token.Kind, lit string)

Scan scans the next token and returns the token position, the token, and its literal string if applicable. The source end is indicated by EOF.

If the returned token is a literal (IDENT, INT, FLOAT, IMAG, CHAR, STRING) or COMMENT, the literal string has the corresponding value.

If the returned token is a keyword, the literal string is the keyword.

If the returned token is ILLEGAL, the literal string is the offending character.

In all other cases, Scan returns an empty literal string.

For more tolerant parsing, Scan will return a valid token if possible even if a syntax error was encountered. Thus, even if the resulting token sequence contains no illegal tokens, a client may not assume that no error occurred. Instead it must check the scanner's ErrorCount or the number of calls of the error handler, if there was one installed.

Scan adds line information to the file added to the file set with Init. Kind positions are relative to that file and thus relative to the file set.