linter

Documentation

Overview

Package linter analyses disassembled code (from the disassembly package) producing a lint report. As it is, it is a proof-of-concept and incomplete.

Current Linters:

. Reading of TIA and RIOT write-only addresses

Index

• func Write(dsm *disassembly.Disassembly, output io.Writer) error
• type LintEntry
  • func (le *LintEntry) String() string
• type Results
  • func Lint(dsm *disassembly.Disassembly) (*Results, error)
  • func (res *Results) String() string

Functions

func Write

func Write(dsm *disassembly.Disassembly, output io.Writer) error

Write performs a lint and writes the results output to io.Writer.

Types

type LintEntry

type LintEntry struct {
	DisasmEntry *disassembly.Entry
	Error       string
	Details     interface{}
}

LintEntry for every lint error detected in disassembly entry.

func (*LintEntry) String

func (le *LintEntry) String() string

type Results

type Results map[string][]*LintEntry

Results is a list of LintEntries grouped by Error.

func Lint

func Lint(dsm *disassembly.Disassembly) (*Results, error)

Lint disassembly and return results.

func (*Results) String

func (res *Results) String() string