Add Library.UtilityFolder

This path is constructed and checked when loading the library instead of
in various places among the code, slightly simplifying the code.

Signed-off-by: Matthijs Kooijman <matthijs@stdin.nl>

Author: matthijskooijman

src/arduino.cc/builder/libraries_loader.go

@@ -113,6 +113,14 @@ func makeLibrary(libraryFolder string, debugLevel int, logger i18n.Logger) (*typ
 	return makeNewLibrary(libraryFolder, debugLevel, logger)
 }
 
+func addUtilityFolder(library *types.Library) {
+	utilitySourcePath := filepath.Join(library.Folder, constants.LIBRARY_FOLDER_UTILITY)
+	stat, err := os.Stat(utilitySourcePath)
+	if err == nil && stat.IsDir() {
+		library.UtilityFolder = utilitySourcePath
+	}
+}
+
 func makeNewLibrary(libraryFolder string, debugLevel int, logger i18n.Logger) (*types.Library, error) {
 	libProperties, err := properties.Load(filepath.Join(libraryFolder, constants.LIBRARY_PROPERTIES), logger)
 	if err != nil {
@@ -130,12 +138,14 @@ func makeNewLibrary(libraryFolder string, debugLevel int, logger i18n.Logger) (*
 	}
 
 	library := &types.Library{}
+	library.Folder = libraryFolder
 	if stat, err := os.Stat(filepath.Join(libraryFolder, constants.LIBRARY_FOLDER_SRC)); err == nil && stat.IsDir() {
 		library.Layout = types.LIBRARY_RECURSIVE
 		library.SrcFolder = filepath.Join(libraryFolder, constants.LIBRARY_FOLDER_SRC)
 	} else {
 		library.Layout = types.LIBRARY_FLAT
 		library.SrcFolder = libraryFolder
+		addUtilityFolder(library)
 	}
 
 	subFolders, err := utils.ReadDirFiltered(libraryFolder, utils.FilterDirs)
@@ -173,7 +183,6 @@ func makeNewLibrary(libraryFolder string, debugLevel int, logger i18n.Logger) (*
 	}
 	library.License = libProperties[constants.LIBRARY_LICENSE]
 
-	library.Folder = libraryFolder
 	library.Name = filepath.Base(libraryFolder)
 	library.Version = strings.TrimSpace(libProperties[constants.LIBRARY_VERSION])
 	library.Author = strings.TrimSpace(libProperties[constants.LIBRARY_AUTHOR])
@@ -197,6 +206,7 @@ func makeLegacyLibrary(libraryFolder string) (*types.Library, error) {
 		Archs:     []string{constants.LIBRARY_ALL_ARCHS},
 		IsLegacy:  true,
 	}
+	addUtilityFolder(library)
 	return library, nil
 }
 

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

@@ -30,7 +30,6 @@
 package phases
 
 import (
-	"os"
 	"path/filepath"
 
 	"arduino.cc/builder/builder_utils"
@@ -107,20 +106,17 @@ func compileLibrary(library *types.Library, buildPath string, buildProperties pr
 			objectFiles = []string{archiveFile}
 		}
 	} else {
-		utilitySourcePath := filepath.Join(library.SrcFolder, constants.LIBRARY_FOLDER_UTILITY)
-		stat, err := os.Stat(utilitySourcePath)
-		haveUtilityDir := err == nil && stat.IsDir()
-		if haveUtilityDir {
-			includes = append(includes, utils.WrapWithHyphenI(utilitySourcePath))
+		if library.UtilityFolder != "" {
+			includes = append(includes, utils.WrapWithHyphenI(library.UtilityFolder))
 		}
 		objectFiles, err = builder_utils.CompileFiles(objectFiles, library.SrcFolder, false, libraryBuildPath, buildProperties, includes, verbose, warningsLevel, logger)
 		if err != nil {
 			return nil, i18n.WrapError(err)
 		}
 
-		if haveUtilityDir {
+		if library.UtilityFolder != "" {
 			utilityBuildPath := filepath.Join(libraryBuildPath, constants.LIBRARY_FOLDER_UTILITY)
-			objectFiles, err = builder_utils.CompileFiles(objectFiles, utilitySourcePath, false, utilityBuildPath, buildProperties, includes, verbose, warningsLevel, logger)
+			objectFiles, err = builder_utils.CompileFiles(objectFiles, library.UtilityFolder, false, utilityBuildPath, buildProperties, includes, verbose, warningsLevel, logger)
 			if err != nil {
 				return nil, i18n.WrapError(err)
 			}

src/arduino.cc/builder/types/types.go

@@ -30,7 +30,6 @@
 package types
 
 import (
-	"os"
 	"fmt"
 	"path/filepath"
 	"strconv"
@@ -166,6 +165,7 @@ const (
 type Library struct {
 	Folder      string
 	SrcFolder   string
+	UtilityFolder string
 	Layout      LibraryLayout
 	Name        string
 	Archs       []string
@@ -262,11 +262,8 @@ func LibraryToSourceFolder(library *Library) []SourceFolder {
 	sourceFolders := []SourceFolder{}
 	recurse := library.Layout == LIBRARY_RECURSIVE
 	sourceFolders = append(sourceFolders, SourceFolder{Folder: library.SrcFolder, Recurse: recurse})
-	if library.Layout == LIBRARY_FLAT {
-		utility := filepath.Join(library.SrcFolder, constants.LIBRARY_FOLDER_UTILITY)
-		if info, err := os.Stat(utility); err == nil && info.IsDir() {
-			sourceFolders = append(sourceFolders, SourceFolder{Folder: utility, Recurse: false})
-		}
+	if library.UtilityFolder != "" {
+		sourceFolders = append(sourceFolders, SourceFolder{Folder: library.UtilityFolder, Recurse: false})
 	}
 	return sourceFolders
 }