analysis

Documentation

Index

• type Analyzer
  • func (a *Analyzer) Title() string
  • func (a *Analyzer) Validate() error
• type Diagnostic
• type Pass
  • func (pass *Pass) Reportf(pos scanner.Position, format string, args ...interface{})

Types

type Analyzer

type Analyzer struct {
	// Name of the analyzer.
	Name string

	// Doc is the documentation for the analyzer.
	Doc string

	// Run the analyzer.
	Run func(*Pass) error
}

An Analyzer describes an analysis function and its options.

func (*Analyzer) Title

func (a *Analyzer) Title() string

Title is the part before the first "\n\n" of the documentation.

func (*Analyzer) Validate

func (a *Analyzer) Validate() error

Validate the analyzer metadata.

type Diagnostic

type Diagnostic struct {
	Pos     scanner.Position
	Message string
}

A Diagnostic is a message associated with a source location.

type Pass

type Pass struct {
	Analyzer    *Analyzer
	File        *dbc.File
	Diagnostics []*Diagnostic
}

Pass is the interface to the run function that analyzes DBC definitions.

func (*Pass) Reportf

func (pass *Pass) Reportf(pos scanner.Position, format string, args ...interface{})

Reportf reports a diagnostic by building a message from the provided format and args.