builder

Documentation

Index

• func PrepareSketchBuildPath(sketch *sketch.Sketch, sourceOverrides map[string]string, ...) (int, error)
• func SetupBuildProperties(boardBuildProperties *properties.Map, buildPath *paths.Path, ...) *properties.Map
• func SketchSaveItemCpp(path *paths.Path, contents []byte, destPath *paths.Path) error
• type CompilationCommand
• type CompilationDatabase
  • func LoadCompilationDatabase(file *paths.Path) (*CompilationDatabase, error)
  • func NewCompilationDatabase(filename *paths.Path) *CompilationDatabase
  • func (db *CompilationDatabase) Add(target *paths.Path, command *exec.Cmd)
  • func (db *CompilationDatabase) SaveToFile()

Functions

func PrepareSketchBuildPath

func PrepareSketchBuildPath(sketch *sketch.Sketch, sourceOverrides map[string]string, buildPath *paths.Path) (int, error)

PrepareSketchBuildPath copies the sketch source files in the build path. The .ino files are merged together to create a .cpp file (by the way, the .cpp file still needs to be Arduino-preprocessed to compile).

func SetupBuildProperties

func SetupBuildProperties(boardBuildProperties *properties.Map, buildPath *paths.Path, sketch *sketch.Sketch, optimizeForDebug bool) *properties.Map

SetupBuildProperties adds the build properties related to the sketch to the default board build properties map.

func SketchSaveItemCpp

func SketchSaveItemCpp(path *paths.Path, contents []byte, destPath *paths.Path) error

SketchSaveItemCpp saves a preprocessed .cpp sketch file on disk

Types

type CompilationCommand

type CompilationCommand struct {
	Directory string   `json:"directory"`
	Command   string   `json:"command,omitempty"`
	Arguments []string `json:"arguments,omitempty"`
	File      string   `json:"file"`
}

CompilationCommand keeps track of a single run of a compile command

type CompilationDatabase

type CompilationDatabase struct {
	Contents []CompilationCommand
	File     *paths.Path
}

CompilationDatabase keeps track of all the compile commands run by the builder

func LoadCompilationDatabase

func LoadCompilationDatabase(file *paths.Path) (*CompilationDatabase, error)

LoadCompilationDatabase reads a compilation database from a file

func NewCompilationDatabase

func NewCompilationDatabase(filename *paths.Path) *CompilationDatabase

NewCompilationDatabase creates an empty CompilationDatabase

func (*CompilationDatabase) Add

func (db *CompilationDatabase) Add(target *paths.Path, command *exec.Cmd)

Add adds a new CompilationDatabase entry

func (*CompilationDatabase) SaveToFile

func (db *CompilationDatabase) SaveToFile()

SaveToFile save the CompilationDatabase to file as a clangd-compatible compile_commands.json, see https://clang.llvm.org/docs/JSONCompilationDatabase.html