builder

Documentation

Index

• Variables
• type Builder
  • func NewBuilder(ctx context.Context, sk *sketch.Sketch, boardBuildProperties *properties.Map, ...) (*Builder, error)
  • func (b *Builder) Build() error
  • func (b *Builder) CompilerDiagnostics() diagnostics.Diagnostics
  • func (b *Builder) ExecutableSectionsSize() ExecutablesFileSections
  • func (b *Builder) GetBuildPath() *paths.Path
  • func (b *Builder) GetBuildProperties() *properties.Map
  • func (b *Builder) ImportedLibraries() libraries.List
  • func (b *Builder) Preprocess() ([]byte, error)
  • func (b *Builder) RunRecipe(prefix, suffix string, skipIfOnlyUpdatingCompilationDatabase bool) error
• type ExecutableSectionSize
• type ExecutablesFileSections
  • func (s ExecutablesFileSections) ToRPCExecutableSectionSizeArray() []*rpc.ExecutableSectionSize

Variables

var (
	FloatAbiCflag = "float-abi"
	FpuCflag      = "fpu"
)

nolint

var ErrSketchCannotBeLocatedInBuildPath = errors.New("sketch cannot be located in build path")

ErrSketchCannotBeLocatedInBuildPath fixdoc

Types

type Builder

type Builder struct {

	// Progress of all various steps
	Progress *progress.Struct
	// contains filtered or unexported fields
}

Builder is a Sketch builder.

func NewBuilder

func NewBuilder(
	ctx context.Context,
	sk *sketch.Sketch,
	boardBuildProperties *properties.Map,
	buildPath *paths.Path,
	optimizeForDebug bool,
	coreBuildCachePath *paths.Path,
	extraCoreBuildCachePaths paths.PathList,
	jobs int,
	requestBuildProperties []string,
	hardwareDirs, otherLibrariesDirs paths.PathList,
	builtInLibrariesDirs *paths.Path,
	fqbn *cores.FQBN,
	clean bool,
	sourceOverrides map[string]string,
	onlyUpdateCompilationDatabase bool,
	targetPlatform, actualPlatform *cores.PlatformRelease,
	useCachedLibrariesResolution bool,
	librariesManager *librariesmanager.LibrariesManager,
	libraryDirs paths.PathList,
	stdout, stderr io.Writer, verbose bool, warningsLevel string,
	progresCB rpc.TaskProgressCB,
	toolEnv []string,
) (*Builder, error)

NewBuilder creates a sketch Builder.

func (*Builder) Build

func (b *Builder) Build() error

Build fixdoc

func (*Builder) CompilerDiagnostics

func (b *Builder) CompilerDiagnostics() diagnostics.Diagnostics

CompilerDiagnostics returns the parsed compiler diagnostics

func (*Builder) ExecutableSectionsSize

func (b *Builder) ExecutableSectionsSize() ExecutablesFileSections

ExecutableSectionsSize fixdoc

func (*Builder) GetBuildPath

func (b *Builder) GetBuildPath() *paths.Path

GetBuildPath returns the build path

func (*Builder) GetBuildProperties

func (b *Builder) GetBuildProperties() *properties.Map

GetBuildProperties returns the build properties for running this build

func (*Builder) ImportedLibraries

func (b *Builder) ImportedLibraries() libraries.List

ImportedLibraries fixdoc

func (*Builder) Preprocess

func (b *Builder) Preprocess() ([]byte, error)

Preprocess fixdoc

func (*Builder) RunRecipe

func (b *Builder) RunRecipe(prefix, suffix string, skipIfOnlyUpdatingCompilationDatabase bool) error

RunRecipe fixdoc

type ExecutableSectionSize

type ExecutableSectionSize struct {
	Name    string `json:"name"`
	Size    int    `json:"size"`
	MaxSize int    `json:"max_size"`
}

ExecutableSectionSize represents a section of the executable output file

type ExecutablesFileSections

type ExecutablesFileSections []ExecutableSectionSize

ExecutablesFileSections is an array of ExecutablesFileSection

func (ExecutablesFileSections) ToRPCExecutableSectionSizeArray

func (s ExecutablesFileSections) ToRPCExecutableSectionSizeArray() []*rpc.ExecutableSectionSize

ToRPCExecutableSectionSizeArray transforms this array into a []*rpc.ExecutableSectionSize