state

Documentation

Index

• type CommentCallback
• type CommentState
• type Func

Types

type CommentCallback

type CommentCallback func(comment, filename string, lines []string, linecnt int) error

CommentCallback is a function which acts on an encountered comment

type CommentState

type CommentState int

CommentState is an enum representing the current state the traverser is in

const (
	// NonComment is the default state a traverser is at
	NonComment CommentState = iota

	// String is the state while the traverser is reading a string
	String

	// SingleLineComment is the state while the traverser is reading a single-line comment
	SingleLineComment

	// MultiLineComment is the state while the traverser is reading a multi-line comment
	MultiLineComment
)

type Func

type Func func(filepath, line string, linecnt int, prevToken, currToken, nextToken rune) (CommentState, error)

Func represents a state-transitioning function used in the state-machine design pattern Its parameters are tailored to traversing a file's stream of tokens