preprocessor

package

v1.2.0 Latest Latest Go to latest Published: Feb 24, 2025 License: GPL-3.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/arduino/arduino-cli

Documentation ¶

Index ¶

Variables
func RunCTags(ctx context.Context, sourceFile *paths.Path, buildProperties *properties.Map) ([]byte, []byte, string, error)
type Result

Constants ¶

This section is empty.

Variables ¶

View Source

var DebugPreprocessor bool

DebugPreprocessor when set to true the CTags preprocessor will output debugging info to stdout this is useful for unit-testing to provide more infos

Functions ¶

func RunCTags ¶

func RunCTags(ctx context.Context, sourceFile *paths.Path, buildProperties *properties.Map) ([]byte, []byte, string, error)

RunCTags performs a run of ctags on the given source file. Returns the ctags output and the stderr contents.

Types ¶

type Result ¶

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

func GCC ¶

func GCC(
	ctx context.Context,
	sourceFilePath, targetFilePath *paths.Path,
	includes paths.PathList, buildProperties *properties.Map,
) (Result, error)

GCC performs a run of the gcc preprocess (macro/includes expansion). The function outputs the result to targetFilePath. Returns the stdout/stderr of gcc if any.

func PreprocessSketchWithArduinoPreprocessor ¶

func PreprocessSketchWithArduinoPreprocessor(
	ctx context.Context,
	sk *sketch.Sketch, buildPath *paths.Path, includeFolders paths.PathList,
	lineOffset int, buildProperties *properties.Map, onlyUpdateCompilationDatabase bool,
) (*Result, error)

PreprocessSketchWithArduinoPreprocessor performs preprocessing of the arduino sketch using arduino-preprocessor (https://github.com/arduino/arduino-preprocessor).

func PreprocessSketchWithCtags ¶

func PreprocessSketchWithCtags(
	ctx context.Context,
	sketch *sketch.Sketch, buildPath *paths.Path, includes paths.PathList,
	lineOffset int, buildProperties *properties.Map,
	onlyUpdateCompilationDatabase, verbose bool,
) (*Result, error)

PreprocessSketchWithCtags performs preprocessing of the arduino sketch using CTags.

func (Result) Args ¶

func (r Result) Args() []string

func (Result) Stderr ¶

func (r Result) Stderr() []byte

func (Result) Stdout ¶

func (r Result) Stdout() []byte

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
ctags

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL