mkfile

Documentation

Index

• Constants
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) GenerateCompileCommands(w io.Writer) error
  • func (b *Builder) GenerateMakeFile(w io.Writer) error
  • func (b *Builder) OutputPath() string
  • func (b *Builder) Parse(entry *Package) error
  • func (b *Builder) WithCacheDir(xcache string) *Builder
  • func (b *Builder) WithCxxFlags(flags []string) *Builder
  • func (b *Builder) WithLDFlags(flags []string) *Builder
  • func (b *Builder) WithOutput(out string) *Builder
• type DependencyDesc
• type Loader
  • func NewLoader() *Loader
  • func (l *Loader) Load(pkgpath string, addons []DependencyDesc) (*Package, error)
  • func (l *Loader) WithSearchPath(paths []string) *Loader
  • func (l *Loader) WithXROOT(xroot string) *Loader
• type MakeFileWriter
  • func NewMakeFileWriter(w io.Writer) *MakeFileWriter
  • func (m *MakeFileWriter) Write(f *Makefile) error
• type Makefile
• type Module
• type ModuleDesc
  • func ParseModuleDesc(modpath string) (*ModuleDesc, error)
• type Package
• type PackgeDesc
  • func ParsePackageDesc(pkgpath string) (*PackgeDesc, error)
• type Runner
  • func NewRunner(ccImage string) *Runner
  • func (r *Runner) Make(mkfile string) error
  • func (r *Runner) WithCacheDir(xcache string) *Runner
  • func (r *Runner) WithEntry(pkg *Package) *Runner
  • func (r *Runner) WithLogger(logger *log.Logger) *Runner
  • func (r *Runner) WithMakeFlags(flags []string) *Runner
  • func (r *Runner) WithOutput(out string) *Runner
  • func (r *Runner) WithXROOT(xroot string) *Runner
  • func (r *Runner) WithoutDocker() *Runner
  • func (r *Runner) WithoutPrecompiledSDK() *Runner
• type Task

Constants

const (
	PkgDescFile     = "xdev.toml"
	ModDescFile     = "mod.toml"
	SelfPackageName = "self"
	XchainPackage   = "xchain"
)

const (
	DefaultXROOT = "/opt/xchain"
)

const (
	MainPackage = "main"
)

Types

type Builder

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

Builder generate makefile

func NewBuilder

func NewBuilder() *Builder

NewBuilder instance a build

func (*Builder) GenerateCompileCommands

func (b *Builder) GenerateCompileCommands(w io.Writer) error

GenerateCompileCommands generates compile_commands.json to io.Writer

func (*Builder) GenerateMakeFile

func (b *Builder) GenerateMakeFile(w io.Writer) error

GenerateMakeFile generates makefile to w

func (*Builder) OutputPath

func (b *Builder) OutputPath() string

OutputPath returns the output path of output file. Must be called after Parse

func (*Builder) Parse

func (b *Builder) Parse(entry *Package) error

Parse parse the package

func (*Builder) WithCacheDir

func (b *Builder) WithCacheDir(xcache string) *Builder

WithCacheDir set the stage dir

func (*Builder) WithCxxFlags

func (b *Builder) WithCxxFlags(flags []string) *Builder

WithCxxFlags set the CXXFLAGS during compiling cxx file

func (*Builder) WithLDFlags

func (b *Builder) WithLDFlags(flags []string) *Builder

WithLDFlags set the LDFLAGS during linking binary

func (*Builder) WithOutput

func (b *Builder) WithOutput(out string) *Builder

WithOutput set the output of package

type DependencyDesc

type DependencyDesc struct {
	Name    string
	Path    string
	Modules []string
}

DependencyDesc 描述了依赖的package信息

type Loader

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

Loader 分析package依赖，并确保所有依赖都已经在本地存在

func NewLoader

func NewLoader() *Loader

NewLoader instance Loader

func (*Loader) Load

func (l *Loader) Load(pkgpath string, addons []DependencyDesc) (*Package, error)

Load parse and load all package's dep packages

func (*Loader) WithSearchPath

func (l *Loader) WithSearchPath(paths []string) *Loader

func (*Loader) WithXROOT

func (l *Loader) WithXROOT(xroot string) *Loader

type MakeFileWriter

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

MakeFileWriter write Makefile according to given MakeFile description

func NewMakeFileWriter

func NewMakeFileWriter(w io.Writer) *MakeFileWriter

NewMakeFileWriter instances a new MakeFileWriter

func (*MakeFileWriter) Write

func (m *MakeFileWriter) Write(f *Makefile) error

Write serializes MakeFile description to MakeFile

type Makefile

type Makefile struct {
	Headers []string
	Tails   []string
	Tasks   []Task
}

Makefile represents a Makefile description

type Module

type Module struct {
	// The name of module
	Name string
	// The full path of module
	Path string
}

Module is the basic compile unit

type ModuleDesc

type ModuleDesc struct {
	Dependencies []DependencyDesc
}

ModuleDesc 描述了module的信息

func ParseModuleDesc

func ParseModuleDesc(modpath string) (*ModuleDesc, error)

type Package

type Package struct {
	// The name of package
	Name string
	// The full path of package in local file system
	Path string
	// The modules will be compiled
	Modules []Module
	// The dep packages
	Deps map[string]*Package
}

Package contains modules and deps

type PackgeDesc

type PackgeDesc struct {
	Package struct {
		Name   string
		Author string
	}
	Dependencies []DependencyDesc
}

PackgeDesc 描述了package的信息

func ParsePackageDesc

func ParsePackageDesc(pkgpath string) (*PackgeDesc, error)

type Runner

type Runner struct {
	*log.Logger
	// contains filtered or unexported fields
}

func NewRunner

func NewRunner(ccImage string) *Runner

func (*Runner) Make

func (r *Runner) Make(mkfile string) error

func (*Runner) WithCacheDir

func (r *Runner) WithCacheDir(xcache string) *Runner

func (*Runner) WithEntry

func (r *Runner) WithEntry(pkg *Package) *Runner

func (*Runner) WithLogger

func (r *Runner) WithLogger(logger *log.Logger) *Runner

WithLogger set the debug logger

func (*Runner) WithMakeFlags

func (r *Runner) WithMakeFlags(flags []string) *Runner

WithMakeFlags set extra flags passing to make command

func (*Runner) WithOutput

func (r *Runner) WithOutput(out string) *Runner

func (*Runner) WithXROOT

func (r *Runner) WithXROOT(xroot string) *Runner

func (*Runner) WithoutDocker

func (r *Runner) WithoutDocker() *Runner

func (*Runner) WithoutPrecompiledSDK

func (r *Runner) WithoutPrecompiledSDK() *Runner

type Task

type Task struct {
	Target  string
	Deps    []string
	Actions []string
}

Task represents a single task description in Makefile