preprocessor

Documentation

Index

• Variables
• func GCC(sourceFilePath *paths.Path, targetFilePath *paths.Path, ...) ([]byte, []byte, error)
• func PreprocessSketchWithArduinoPreprocessor(sk *sketch.Sketch, buildPath *paths.Path, includeFolders paths.PathList, ...) ([]byte, []byte, error)
• func PreprocessSketchWithCtags(sketch *sketch.Sketch, buildPath *paths.Path, includes paths.PathList, ...) ([]byte, []byte, error)
• func RunCTags(sourceFile *paths.Path, buildProperties *properties.Map) ([]byte, []byte, error)

Variables

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 GCC

func GCC(sourceFilePath *paths.Path, targetFilePath *paths.Path, includes paths.PathList, buildProperties *properties.Map) ([]byte, []byte, 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(sk *sketch.Sketch, buildPath *paths.Path, includeFolders paths.PathList, lineOffset int, buildProperties *properties.Map, onlyUpdateCompilationDatabase bool) ([]byte, []byte, error)

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

func PreprocessSketchWithCtags

func PreprocessSketchWithCtags(sketch *sketch.Sketch, buildPath *paths.Path, includes paths.PathList, lineOffset int, buildProperties *properties.Map, onlyUpdateCompilationDatabase bool) ([]byte, []byte, error)

PreprocessSketchWithCtags performs preprocessing of the arduino sketch using CTags.

func RunCTags

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

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