Changed field name Folder->InstallDir SrcFolder->SourceDir Folder->Dir

Author: cmaglie

container_find_includes.go

@@ -319,8 +319,8 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 		cache.ExpectFile(sourcePath)
 
 		includes := ctx.IncludeFolders
-		if library, ok := sourceFile.Origin.(*libraries.Library); ok && library.UtilityFolder != nil {
-			includes = append(includes, library.UtilityFolder)
+		if library, ok := sourceFile.Origin.(*libraries.Library); ok && library.UtilityDir != nil {
+			includes = append(includes, library.UtilityDir)
 		}
 		var preproc_err error
 		var preproc_stderr []byte
@@ -381,10 +381,10 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 		// include path and queue its source files for further
 		// include scanning
 		ctx.ImportedLibraries = append(ctx.ImportedLibraries, library)
-		appendIncludeFolder(ctx, cache, sourcePath, include, library.SrcFolder)
-		sourceFolders := library.SourceDirs()
-		for _, sourceFolder := range sourceFolders {
-			queueSourceFilesFromFolder(ctx, ctx.CollectedSourceFiles, library, sourceFolder.Folder, sourceFolder.Recurse)
+		appendIncludeFolder(ctx, cache, sourcePath, include, library.SourceDir)
+		sourceDirs := library.SourceDirs()
+		for _, sourceDir := range sourceDirs {
+			queueSourceFilesFromFolder(ctx, ctx.CollectedSourceFiles, library, sourceDir.Dir, sourceDir.Recurse)
 		}
 		first = false
 	}

create_cmake_rule.go

@@ -79,17 +79,17 @@ func (s *ExportProjectCMake) Run(ctx *types.Context) error {
 	// Copy used  libraries in the correct folder
 	extensions := func(ext string) bool { return VALID_EXPORT_EXTENSIONS[ext] }
 	for _, library := range ctx.ImportedLibraries {
-		libFolder := libBaseFolder.Join(library.Name)
-		utils.CopyDir(library.Folder.String(), libFolder.String(), extensions)
+		libDir := libBaseFolder.Join(library.Name)
+		utils.CopyDir(library.InstallDir.String(), libDir.String(), extensions)
 		// Remove examples folder
 		if _, err := libBaseFolder.Join("examples").Stat(); err == nil {
-			libFolder.Join("examples").RemoveAll()
+			libDir.Join("examples").RemoveAll()
 		}
 		// Remove stray folders contining incompatible libraries
 		staticLibsExtensions := func(ext string) bool { return DOTAEXTENSION[ext] }
 		mcu := ctx.BuildProperties[constants.BUILD_PROPERTIES_BUILD_MCU]
 		var files []string
-		utils.FindFilesInFolder(&files, libFolder.Join("src").String(), staticLibsExtensions, true)
+		utils.FindFilesInFolder(&files, libDir.Join("src").String(), staticLibsExtensions, true)
 		for _, file := range files {
 			if !strings.Contains(filepath.Dir(file), mcu) {
 				os.RemoveAll(filepath.Dir(file))

fail_if_imported_library_is_wrong.go

@@ -47,17 +47,17 @@ func (s *FailIfImportedLibraryIsWrong) Run(ctx *types.Context) error {
 
 	for _, library := range ctx.ImportedLibraries {
 		if !library.IsLegacy {
-			if isDir, _ := library.Folder.Join(constants.LIBRARY_FOLDER_ARCH).IsDir(); isDir {
+			if isDir, _ := library.InstallDir.Join(constants.LIBRARY_FOLDER_ARCH).IsDir(); isDir {
 				return i18n.ErrorfWithLogger(logger, constants.MSG_ARCH_FOLDER_NOT_SUPPORTED)
 			}
 			for _, propName := range libraries.MandatoryProperties {
 				if _, ok := library.Properties[propName]; !ok {
-					return i18n.ErrorfWithLogger(logger, constants.MSG_PROP_IN_LIBRARY, propName, library.Folder)
+					return i18n.ErrorfWithLogger(logger, constants.MSG_PROP_IN_LIBRARY, propName, library.InstallDir)
 				}
 			}
 			if library.Layout == libraries.RecursiveLayout {
-				if library.UtilityFolder != nil {
-					return i18n.ErrorfWithLogger(logger, constants.MSG_LIBRARY_CAN_USE_SRC_AND_UTILITY_FOLDERS, library.Folder)
+				if library.UtilityDir != nil {
+					return i18n.ErrorfWithLogger(logger, constants.MSG_LIBRARY_CAN_USE_SRC_AND_UTILITY_FOLDERS, library.InstallDir)
 				}
 			}
 		}

phases/libraries_builder.go

@@ -78,7 +78,7 @@ func fixLDFLAGforPrecompiledLibraries(ctx *types.Context, libs libraries.List) e
 			// add library src path to compiler.c.elf.extra_flags
 			// use library.Name as lib name and srcPath/{mcpu} as location
 			mcu := ctx.BuildProperties[constants.BUILD_PROPERTIES_BUILD_MCU]
-			path := library.SrcFolder.Join(mcu).String()
+			path := library.SourceDir.Join(mcu).String()
 			// find all library names in the folder and prepend -l
 			filePaths := []string{}
 			libs_cmd := library.LDflags + " "
@@ -128,7 +128,7 @@ func compileLibrary(ctx *types.Context, library *libraries.Library, buildPath *p
 
 		filePaths := []string{}
 		mcu := buildProperties[constants.BUILD_PROPERTIES_BUILD_MCU]
-		err := utils.FindFilesInFolder(&filePaths, library.SrcFolder.Join(mcu).String(), extensions, true)
+		err := utils.FindFilesInFolder(&filePaths, library.SourceDir.Join(mcu).String(), extensions, true)
 		if err != nil {
 			return nil, i18n.WrapError(err)
 		}
@@ -140,7 +140,7 @@ func compileLibrary(ctx *types.Context, library *libraries.Library, buildPath *p
 	}
 
 	if library.Layout == libraries.RecursiveLayout {
-		libObjectFiles, err := builder_utils.CompileFilesRecursive(ctx, library.SrcFolder, libraryBuildPath, buildProperties, includes)
+		libObjectFiles, err := builder_utils.CompileFilesRecursive(ctx, library.SourceDir, libraryBuildPath, buildProperties, includes)
 		if err != nil {
 			return nil, i18n.WrapError(err)
 		}
@@ -154,18 +154,18 @@ func compileLibrary(ctx *types.Context, library *libraries.Library, buildPath *p
 			objectFiles.AddAll(libObjectFiles)
 		}
 	} else {
-		if library.UtilityFolder != nil {
-			includes = append(includes, utils.WrapWithHyphenI(library.UtilityFolder.String()))
+		if library.UtilityDir != nil {
+			includes = append(includes, utils.WrapWithHyphenI(library.UtilityDir.String()))
 		}
-		libObjectFiles, err := builder_utils.CompileFiles(ctx, library.SrcFolder, false, libraryBuildPath, buildProperties, includes)
+		libObjectFiles, err := builder_utils.CompileFiles(ctx, library.SourceDir, false, libraryBuildPath, buildProperties, includes)
 		if err != nil {
 			return nil, i18n.WrapError(err)
 		}
 		objectFiles.AddAll(libObjectFiles)
 
-		if library.UtilityFolder != nil {
+		if library.UtilityDir != nil {
 			utilityBuildPath := libraryBuildPath.Join("utility")
-			utilityObjectFiles, err := builder_utils.CompileFiles(ctx, library.UtilityFolder, false, utilityBuildPath, buildProperties, includes)
+			utilityObjectFiles, err := builder_utils.CompileFiles(ctx, library.UtilityDir, false, utilityBuildPath, buildProperties, includes)
 			if err != nil {
 				return nil, i18n.WrapError(err)
 			}

print_used_and_not_used_libraries.go

@@ -30,10 +30,11 @@
 package builder
 
 import (
-	"github.com/arduino/arduino-builder/constants"
-	"github.com/arduino/arduino-builder/types"
 	"os"
 	"time"
+
+	"github.com/arduino/arduino-builder/constants"
+	"github.com/arduino/arduino-builder/types"
 )
 
 type PrintUsedAndNotUsedLibraries struct {
@@ -58,9 +59,9 @@ func (s *PrintUsedAndNotUsedLibraries) Run(ctx *types.Context) error {
 
 	for header, libResResult := range libraryResolutionResults {
 		logger.Fprintln(os.Stdout, logLevel, constants.MSG_LIBRARIES_MULTIPLE_LIBS_FOUND_FOR, header)
-		logger.Fprintln(os.Stdout, logLevel, constants.MSG_LIBRARIES_USED, libResResult.Library.Folder)
+		logger.Fprintln(os.Stdout, logLevel, constants.MSG_LIBRARIES_USED, libResResult.Library.InstallDir)
 		for _, notUsedLibrary := range libResResult.NotUsedLibraries {
-			logger.Fprintln(os.Stdout, logLevel, constants.MSG_LIBRARIES_NOT_USED, notUsedLibrary.Folder)
+			logger.Fprintln(os.Stdout, logLevel, constants.MSG_LIBRARIES_NOT_USED, notUsedLibrary.InstallDir)
 		}
 	}
 

print_used_libraries_if_verbose.go

@@ -52,9 +52,9 @@ func (s *PrintUsedLibrariesIfVerbose) Run(ctx *types.Context) error {
 			legacy = constants.MSG_LIB_LEGACY
 		}
 		if library.Version == constants.EMPTY_STRING {
-			logger.Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_LIBRARY, library.Name, library.Folder, legacy)
+			logger.Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_LIBRARY, library.Name, library.InstallDir, legacy)
 		} else {
-			logger.Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_LIBRARY_AT_VERSION, library.Name, library.Version, library.Folder, legacy)
+			logger.Println(constants.LOG_LEVEL_INFO, constants.MSG_USING_LIBRARY_AT_VERSION, library.Name, library.Version, library.InstallDir, legacy)
 		}
 	}
 

test/includes_to_include_folders_test.go

@@ -219,7 +219,7 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "SPI", importedLibraries[0].Name)
-	requireEquivalentPaths(t, importedLibraries[0].SrcFolder.String(), filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI"))
+	requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI"))
 }
 
 func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatform(t *testing.T) {
@@ -257,7 +257,7 @@ func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatfo
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "SPI", importedLibraries[0].Name)
-	requireEquivalentPaths(t, importedLibraries[0].SrcFolder.String(), filepath.Join("libraries", "SPI"))
+	requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("libraries", "SPI"))
 }
 
 func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
@@ -295,7 +295,7 @@ func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
 	sort.Sort(ByLibraryName(importedLibraries))
 	require.Equal(t, 1, len(importedLibraries))
 	require.Equal(t, "USBHost", importedLibraries[0].Name)
-	requireEquivalentPaths(t, importedLibraries[0].SrcFolder.String(), filepath.Join("libraries", "USBHost", "src"))
+	requireEquivalentPaths(t, importedLibraries[0].SourceDir.String(), filepath.Join("libraries", "USBHost", "src"))
 }
 
 func TestIncludesToIncludeFoldersSubfolders(t *testing.T) {

test/libraries_loader_test.go

@@ -90,8 +90,8 @@ func TestLoadLibrariesAVR(t *testing.T) {
 
 	idx++
 	require.Equal(t, "Adafruit_PN532", libs[idx].Name)
-	require.True(t, Abs(t, paths.New("downloaded_libraries/Adafruit_PN532")).EquivalentTo(libs[idx].Folder))
-	require.True(t, Abs(t, paths.New("downloaded_libraries/Adafruit_PN532")).EquivalentTo(libs[idx].SrcFolder))
+	require.True(t, Abs(t, paths.New("downloaded_libraries/Adafruit_PN532")).EquivalentTo(libs[idx].InstallDir))
+	require.True(t, Abs(t, paths.New("downloaded_libraries/Adafruit_PN532")).EquivalentTo(libs[idx].SourceDir))
 	require.Equal(t, 1, len(libs[idx].Architectures))
 	require.Equal(t, constants.LIBRARY_ALL_ARCHS, libs[idx].Architectures[0])
 	require.False(t, libs[idx].IsLegacy)
@@ -106,8 +106,8 @@ func TestLoadLibrariesAVR(t *testing.T) {
 	idx++
 	bridgeLib := libs[idx]
 	require.Equal(t, "Bridge", bridgeLib.Name)
-	require.True(t, Abs(t, paths.New("downloaded_libraries/Bridge")).EquivalentTo(bridgeLib.Folder))
-	require.True(t, Abs(t, paths.New("downloaded_libraries/Bridge/src")).EquivalentTo(bridgeLib.SrcFolder))
+	require.True(t, Abs(t, paths.New("downloaded_libraries/Bridge")).EquivalentTo(bridgeLib.InstallDir))
+	require.True(t, Abs(t, paths.New("downloaded_libraries/Bridge/src")).EquivalentTo(bridgeLib.SourceDir))
 	require.Equal(t, 1, len(bridgeLib.Architectures))
 	require.Equal(t, constants.LIBRARY_ALL_ARCHS, bridgeLib.Architectures[0])
 	require.Equal(t, "Arduino", bridgeLib.Author)

types/types.go

@@ -80,7 +80,7 @@ func sourceRoot(ctx *Context, origin interface{}) *paths.Path {
 	case *Sketch:
 		return ctx.SketchBuildPath
 	case *libraries.Library:
-		return o.SrcFolder
+		return o.SourceDir
 	default:
 		panic("Unexpected origin for SourceFile: " + fmt.Sprint(origin))
 	}