compiler

Documentation

Index

• Constants
• func JSONDump(v any) string
• func ParseEntityRef(ref string) core.EntityRef
• func Pointer[T any](v T) *T
• func SaveFilesToDir(dst string, files map[string][]byte) error
• type Analyzer
• type Backend
• type Builder
• type Compiler
  • func New(builder Builder, parser Parser, desugarer Desugarer, analyzer Analyzer, ...) Compiler
  • func (c Compiler) Compile(src string, mainPkgName string, dstPath string) error
  • func (c Compiler) CompileToIR(wd string, mainPkgPath string) (*ir.Program, *Error)
• type Desugarer
• type Error
  • func (e Error) Error() string
  • func (e Error) Wrap(child *Error) *Error
• type IRGenerator
• type Parser
• type RawBuild
• type RawModule
• type RawPackage

Constants

const (
	ExternDirective    src.Directive = "extern"
	BindDirective      src.Directive = "bind"
	AutoportsDirective src.Directive = "autoports"
)

Functions

func JSONDump

func JSONDump(v any) string

JSONDump is for debugging purposes only!

func ParseEntityRef

func ParseEntityRef(ref string) core.EntityRef

ParseEntityRef assumes string-ref has form of <pkg_name>.<entity_name≥ or just <entity_name>.

func Pointer

func Pointer[T any](v T) *T

Pointer allows to avoid creating of temporary variables just to take pointers.

func SaveFilesToDir

func SaveFilesToDir(dst string, files map[string][]byte) error

Types

type Analyzer

type Analyzer interface {
	AnalyzeExecutableBuild(mod src.Build, mainPkgName string) (src.Build, *Error)
}

type Backend

type Backend interface {
	Emit(dst string, prog *ir.Program) error
}

type Builder

type Builder interface {
	Build(ctx context.Context, wd string) (RawBuild, string, *Error)
}

type Compiler

type Compiler struct {
	// contains filtered or unexported fields
}

func New

func New(
	builder Builder,
	parser Parser,
	desugarer Desugarer,
	analyzer Analyzer,
	irgen IRGenerator,
	backend Backend,
) Compiler

func (Compiler) Compile

func (c Compiler) Compile(
	src string,
	mainPkgName string,
	dstPath string,
) error

Compile compiles given rawBuild to target language and uses specified backend to emit files to the destination.

func (Compiler) CompileToIR

func (c Compiler) CompileToIR(
	wd string,
	mainPkgPath string,
) (*ir.Program, *Error)

type Desugarer

type Desugarer interface {
	Desugar(build src.Build) (src.Build, *Error)
}

type Error

type Error struct {
	Err      error
	Location *src.Location
	Meta     *core.Meta
	// contains filtered or unexported fields
}

func (Error) Error

func (e Error) Error() string

func (Error) Wrap

func (e Error) Wrap(child *Error) *Error

type IRGenerator

type IRGenerator interface {
	Generate(build src.Build, mainPkgName string) (*ir.Program, *Error)
}

type Parser

type Parser interface {
	ParseModules(rawMods map[src.ModuleRef]RawModule) (map[src.ModuleRef]src.Module, *Error)
}

type RawBuild

type RawBuild struct {
	EntryModRef src.ModuleRef
	Modules     map[src.ModuleRef]RawModule
}

type RawModule

type RawModule struct {
	Manifest src.ModuleManifest    // Manifest must be parsed by builder before passing into compiler
	Packages map[string]RawPackage // Packages themselves on the other hand can be parsed by compiler
}

type RawPackage

type RawPackage map[string][]byte