Builder now support parsing of compiler output

Author: cmaglie

arduino/builder/builder.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/internal/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/detector"
+	"github.com/arduino/arduino-cli/arduino/builder/internal/diagnostics"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/logger"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/progress"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -85,6 +86,10 @@ type Builder struct {
 	buildOptions *buildOptions
 
 	libsDetector *detector.SketchLibrariesDetector
+
+	// This is a function used to parse the output of the compiler
+	// It is used to extract errors and warnings
+	compilerOutputParser diagnostics.CompilerOutputParserCB
 }
 
 // buildArtifacts contains the result of various build

arduino/builder/core.go

@@ -76,6 +76,7 @@ func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 			b.onlyUpdateCompilationDatabase,
 			b.compilationDatabase,
 			b.jobs,
+			b.compilerOutputParser,
 			b.logger,
 			b.Progress,
 		)
@@ -127,6 +128,7 @@ func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 		b.onlyUpdateCompilationDatabase,
 		b.compilationDatabase,
 		b.jobs,
+		b.compilerOutputParser,
 		b.logger,
 		b.Progress,
 	)

arduino/builder/internal/diagnostics/parser.go

@@ -0,0 +1,20 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
+package diagnostics
+
+// CompilerOutputParserCB is a callback function that is called to feed a parser
+// with the plain-text compiler output.
+type CompilerOutputParserCB func(cmdline []string, out []byte)

arduino/builder/internal/utils/utils.go

@@ -27,6 +27,7 @@ import (
 	"unicode"
 
 	"github.com/arduino/arduino-cli/arduino/builder/internal/compilation"
+	"github.com/arduino/arduino-cli/arduino/builder/internal/diagnostics"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/logger"
 	"github.com/arduino/arduino-cli/arduino/builder/internal/progress"
 	"github.com/arduino/arduino-cli/arduino/globals"
@@ -356,6 +357,7 @@ func CompileFiles(
 	onlyUpdateCompilationDatabase bool,
 	compilationDatabase *compilation.Database,
 	jobs int,
+	compilerOutputParser diagnostics.CompilerOutputParserCB,
 	builderLogger *logger.BuilderLogger,
 	progress *progress.Struct,
 ) (paths.PathList, error) {
@@ -366,6 +368,7 @@ func CompileFiles(
 		sourceDir,
 		false,
 		buildPath, buildProperties, includes,
+		compilerOutputParser,
 		builderLogger,
 		progress,
 	)
@@ -379,6 +382,7 @@ func CompileFilesRecursive(
 	onlyUpdateCompilationDatabase bool,
 	compilationDatabase *compilation.Database,
 	jobs int,
+	compilerOutputParser diagnostics.CompilerOutputParserCB,
 	builderLogger *logger.BuilderLogger,
 	progress *progress.Struct,
 ) (paths.PathList, error) {
@@ -389,6 +393,7 @@ func CompileFilesRecursive(
 		sourceDir,
 		true,
 		buildPath, buildProperties, includes,
+		compilerOutputParser,
 		builderLogger,
 		progress,
 	)
@@ -403,6 +408,7 @@ func compileFiles(
 	buildPath *paths.Path,
 	buildProperties *properties.Map,
 	includes []string,
+	compilerOutputParser diagnostics.CompilerOutputParserCB,
 	builderLogger *logger.BuilderLogger,
 	progress *progress.Struct,
 ) (paths.PathList, error) {
@@ -437,6 +443,7 @@ func compileFiles(
 			compilationDatabase,
 			onlyUpdateCompilationDatabase,
 			sourceDir, source, buildPath, buildProperties, includes, recipe,
+			compilerOutputParser,
 			builderLogger,
 		)
 		if builderLogger.Verbose() {
@@ -502,6 +509,7 @@ func compileFileWithRecipe(
 	buildProperties *properties.Map,
 	includes []string,
 	recipe string,
+	compilerOutputParser diagnostics.CompilerOutputParserCB,
 	builderLogger *logger.BuilderLogger,
 ) (*paths.Path, []byte, []byte, []byte, error) {
 	verboseStdout, verboseInfo, errOut := &bytes.Buffer{}, &bytes.Buffer{}, &bytes.Buffer{}
@@ -552,6 +560,12 @@ func compileFileWithRecipe(
 		}
 		errOut.Write(stderr)
 
+		// Parse the output of the compiler to gather errors and warnings...
+		if compilerOutputParser != nil {
+			compilerOutputParser(command.GetArgs(), stdout)
+			compilerOutputParser(command.GetArgs(), stderr)
+		}
+
 		// ...and then return the error
 		if err != nil {
 			return nil, verboseInfo.Bytes(), verboseStdout.Bytes(), errOut.Bytes(), errors.WithStack(err)

arduino/builder/libraries.go

@@ -195,6 +195,7 @@ func (b *Builder) compileLibrary(library *libraries.Library, includes []string)
 			b.onlyUpdateCompilationDatabase,
 			b.compilationDatabase,
 			b.jobs,
+			b.compilerOutputParser,
 			b.logger,
 			b.Progress,
 		)
@@ -226,6 +227,7 @@ func (b *Builder) compileLibrary(library *libraries.Library, includes []string)
 			b.onlyUpdateCompilationDatabase,
 			b.compilationDatabase,
 			b.jobs,
+			b.compilerOutputParser,
 			b.logger,
 			b.Progress,
 		)
@@ -241,6 +243,7 @@ func (b *Builder) compileLibrary(library *libraries.Library, includes []string)
 				b.onlyUpdateCompilationDatabase,
 				b.compilationDatabase,
 				b.jobs,
+				b.compilerOutputParser,
 				b.logger,
 				b.Progress,
 			)

arduino/builder/sketch.go

@@ -187,6 +187,7 @@ func (b *Builder) BuildSketch(includesFolders paths.PathList) error {
 		b.onlyUpdateCompilationDatabase,
 		b.compilationDatabase,
 		b.jobs,
+		b.compilerOutputParser,
 		b.logger,
 		b.Progress,
 	)
@@ -202,6 +203,7 @@ func (b *Builder) BuildSketch(includesFolders paths.PathList) error {
 			b.onlyUpdateCompilationDatabase,
 			b.compilationDatabase,
 			b.jobs,
+			b.compilerOutputParser,
 			b.logger,
 			b.Progress,
 		)