Log some informative progress messages

Before, only commands were logged (in verbose mode). However, all
commands look similar and it is not quite clear what happens where. By
adding some more informative messages, the commands are logically
grouped and it is more clear what is happening exactly, which should
also help users understand what is wrong when a command fails.

Signed-off-by: Matthijs Kooijman <[email protected]>

Author: matthijskooijman

src/arduino.cc/builder/builder.go

@@ -34,6 +34,7 @@ import (
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/phases"
 	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
 	"os"
 	"reflect"
 	"strconv"
@@ -81,25 +82,31 @@ func (s *Builder) Run(ctx *types.Context) error {
 
 		&ContainerMergeCopySketchFiles{},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Detecting libraries used..."),
 		&ContainerFindIncludes{},
 
 		&WarnAboutArchIncompatibleLibraries{},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Generating function prototypes..."),
 		&ContainerAddPrototypes{},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Compiling sketch..."),
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_SKETCH_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 		&phases.SketchBuilder{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_SKETCH_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Compiling libraries..."),
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LIBRARIES_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 		&UnusedCompiledLibrariesRemover{},
 		&phases.LibrariesBuilder{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LIBRARIES_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Compiling core..."),
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_CORE_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 		&phases.CoreBuilder{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_CORE_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 
+		utils.LogIfVerbose(constants.LOG_LEVEL_INFO, "Linking everything together..."),
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LINKING_PRELINK, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 		&phases.Linker{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LINKING_POSTLINK, Suffix: constants.HOOKS_PATTERN_SUFFIX},

src/arduino.cc/builder/phases/libraries_builder.go

@@ -82,6 +82,9 @@ func compileLibraries(libraries []*types.Library, buildPath string, buildPropert
 }
 
 func compileLibrary(library *types.Library, buildPath string, buildProperties props.PropertiesMap, includes []string, verbose bool, warningsLevel string, logger i18n.Logger) ([]string, error) {
+	if verbose {
+		logger.Println(constants.LOG_LEVEL_INFO, "Compiling library \"{0}\"", library.Name)
+	}
 	libraryBuildPath := filepath.Join(buildPath, library.Name)
 
 	err := utils.EnsureFolderExists(libraryBuildPath)

src/arduino.cc/builder/utils/utils.go

@@ -33,6 +33,7 @@ import (
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/gohasissues"
 	"arduino.cc/builder/i18n"
+	"arduino.cc/builder/types"
 	"crypto/md5"
 	"encoding/hex"
 	"io/ioutil"
@@ -366,3 +367,25 @@ func MD5Sum(data []byte) string {
 	md5sumBytes := md5.Sum(data)
 	return hex.EncodeToString(md5sumBytes[:])
 }
+
+type loggerAction struct {
+	onlyIfVerbose bool
+	level         string
+	format        string
+	args          []interface{}
+}
+
+func (l *loggerAction) Run(ctx *types.Context) error {
+	if !l.onlyIfVerbose || ctx.Verbose {
+		ctx.GetLogger().Println(l.level, l.format, l.args...)
+	}
+	return nil
+}
+
+func LogIfVerbose(level string, format string, args ...interface{}) types.Command {
+	return &loggerAction{true, level, format, args}
+}
+
+func LogThis(level string, format string, args ...interface{}) types.Command {
+	return &loggerAction{false, level, format, args}
+}