package gen

import "github.com/mmcloughlin/avo/internal/gen"

Package gen provides code generators based on the instruction database.

Index ¶

• type Builder
• type Func
• func (f Func) Generate(is []inst.Instruction) ([]byte, error)
• type Interface
• func GoFmt(i Interface) Interface
• func NewAsmTest(cfg printer.Config) Interface
• func NewBuild(cfg printer.Config) Interface
• func NewCtors(cfg printer.Config) Interface
• func NewCtorsTest(cfg printer.Config) Interface
• func NewGoData(cfg printer.Config) Interface
• func NewGoDataTest(cfg printer.Config) Interface
• func NewMOV(cfg printer.Config) Interface

Types ¶

type Builder ¶

type Builder func(printer.Config) Interface

Builder constructs a code generator.

type Func ¶

type Func func([]inst.Instruction) ([]byte, error)

Func adapts a function to Interface.

func (Func) Generate ¶

func (f Func) Generate(is []inst.Instruction) ([]byte, error)

Generate calls f.

type Interface ¶

type Interface interface {
	Generate([]inst.Instruction) ([]byte, error)
}

Interface of an instruction code generator.

func GoFmt ¶

func GoFmt(i Interface) Interface

GoFmt formats Go code produced from the given generator.

func NewAsmTest ¶

func NewAsmTest(cfg printer.Config) Interface

NewAsmTest prints one massive assembly function containing a line for every instruction form in the database. The intention is to pass this to the Go assembler and confirm there are no errors, thus helping to ensure our database is compatible.

func NewBuild ¶

func NewBuild(cfg printer.Config) Interface

NewBuild builds a printer that will generate instruction functions in the build package. Each instruction will have one method on the build.Context type, and a corresponding wrapper operating on the global Context. These functions are thin wrappers around constructors generated by NewCtors.

func NewCtors ¶

func NewCtors(cfg printer.Config) Interface

NewCtors will build instruction constructors. Each constructor will check that the provided operands match one of the allowed instruction forms. If so it will return an Instruction object that can be added to an avo Function.

func NewCtorsTest ¶

func NewCtorsTest(cfg printer.Config) Interface

NewCtorsTest autogenerates tests for the constructors build by NewCtors.

func NewGoData ¶

func NewGoData(cfg printer.Config) Interface

NewGoData writes a Go variable containing the instructions database. This is intended to provide a more friendly version of the instruction database, rather than having to use the raw data sources all the time.

func NewGoDataTest ¶

func NewGoDataTest(cfg printer.Config) Interface

NewGoDataTest writes a test case to confirm that NewGoData faithfully represented the list. The reason for this is that NewGoData uses custom code to "pretty print" the database so it is somewhat human-readable. In the process we could easily mistakenly print the database incorrectly. This test prints the same slice of instructions with the ugly but correct "%#v" format specifier, and confirms that the two arrays agree.

func NewMOV ¶

func NewMOV(cfg printer.Config) Interface

NewMOV generates a function that will auto-select the correct MOV instruction based on operand types and and sizes.

Source Files ¶

asmtest.go avotypes.go build.go ctors.go ctorstest.go doc.go gen.go godata.go mov.go signature.go util.go