Introducing types.Context structure

For now it is used in conjunction with the old map[string]string, but
it will be slowly populated with all the fields currently used in the
map in the next commits.

When the migration will be completed the old map will be removed.

Signed-off-by: Cristian Maglie <[email protected]>

Author: cmaglie

src/arduino.cc/builder/add_additional_entries_to_context.go

@@ -38,7 +38,7 @@ import (
 
 type AddAdditionalEntriesToContext struct{}
 
-func (s *AddAdditionalEntriesToContext) Run(context map[string]interface{}) error {
+func (s *AddAdditionalEntriesToContext) Run(context map[string]interface{}, ctx *types.Context) error {
 	if utils.MapHas(context, constants.CTX_BUILD_PATH) {
 		buildPath := context[constants.CTX_BUILD_PATH].(string)
 		preprocPath, err := filepath.Abs(filepath.Join(buildPath, constants.FOLDER_PREPROC))

src/arduino.cc/builder/add_build_board_property_if_missing.go

@@ -39,7 +39,7 @@ import (
 
 type AddBuildBoardPropertyIfMissing struct{}
 
-func (s *AddBuildBoardPropertyIfMissing) Run(context map[string]interface{}) error {
+func (s *AddBuildBoardPropertyIfMissing) Run(context map[string]interface{}, ctx *types.Context) error {
 	packages := context[constants.CTX_HARDWARE].(*types.Packages)
 	logger := context[constants.CTX_LOGGER].(i18n.Logger)
 

src/arduino.cc/builder/add_missing_build_properties_from_parent_platform_txt_files.go

@@ -37,7 +37,7 @@ import (
 
 type AddMissingBuildPropertiesFromParentPlatformTxtFiles struct{}
 
-func (s *AddMissingBuildPropertiesFromParentPlatformTxtFiles) Run(context map[string]interface{}) error {
+func (s *AddMissingBuildPropertiesFromParentPlatformTxtFiles) Run(context map[string]interface{}, ctx *types.Context) error {
 	packages := context[constants.CTX_HARDWARE].(*types.Packages)
 	targetPackage := context[constants.CTX_TARGET_PACKAGE].(*types.Package)
 	buildProperties := context[constants.CTX_BUILD_PROPERTIES].(props.PropertiesMap)

src/arduino.cc/builder/additional_sketch_files_copier.go

@@ -40,7 +40,7 @@ import (
 
 type AdditionalSketchFilesCopier struct{}
 
-func (s *AdditionalSketchFilesCopier) Run(context map[string]interface{}) error {
+func (s *AdditionalSketchFilesCopier) Run(context map[string]interface{}, ctx *types.Context) error {
 	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
 	sketchBuildPath := context[constants.CTX_SKETCH_BUILD_PATH].(string)
 

src/arduino.cc/builder/builder.go

@@ -66,7 +66,7 @@ const DEFAULT_BUILD_CORE = "arduino"
 
 type Builder struct{}
 
-func (s *Builder) Run(context map[string]interface{}) error {
+func (s *Builder) Run(context map[string]interface{}, ctx *types.Context) error {
 	commands := []types.Command{
 		&SetupHumanLoggerIfMissing{},
 
@@ -115,14 +115,14 @@ func (s *Builder) Run(context map[string]interface{}) error {
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 	}
 
-	mainErr := runCommands(context, commands, true)
+	mainErr := runCommands(context, ctx, commands, true)
 
 	commands = []types.Command{
 		&PrintUsedAndNotUsedLibraries{},
 
 		&PrintUsedLibrariesIfVerbose{},
 	}
-	otherErr := runCommands(context, commands, false)
+	otherErr := runCommands(context, ctx, commands, false)
 
 	if mainErr != nil {
 		return mainErr
@@ -133,7 +133,7 @@ func (s *Builder) Run(context map[string]interface{}) error {
 
 type Preprocess struct{}
 
-func (s *Preprocess) Run(context map[string]interface{}) error {
+func (s *Preprocess) Run(context map[string]interface{}, ctx *types.Context) error {
 	commands := []types.Command{
 		&SetupHumanLoggerIfMissing{},
 
@@ -157,12 +157,12 @@ func (s *Preprocess) Run(context map[string]interface{}) error {
 		&PrintPreprocessedSource{},
 	}
 
-	return runCommands(context, commands, true)
+	return runCommands(context, ctx, commands, true)
 }
 
 type ParseHardwareAndDumpBuildProperties struct{}
 
-func (s *ParseHardwareAndDumpBuildProperties) Run(context map[string]interface{}) error {
+func (s *ParseHardwareAndDumpBuildProperties) Run(context map[string]interface{}, ctx *types.Context) error {
 	commands := []types.Command{
 		&SetupHumanLoggerIfMissing{},
 
@@ -173,18 +173,18 @@ func (s *ParseHardwareAndDumpBuildProperties) Run(context map[string]interface{}
 		&DumpBuildProperties{},
 	}
 
-	return runCommands(context, commands, true)
+	return runCommands(context, ctx, commands, true)
 }
 
-func runCommands(context map[string]interface{}, commands []types.Command, progressEnabled bool) error {
+func runCommands(context map[string]interface{}, ctx *types.Context, commands []types.Command, progressEnabled bool) error {
 	commandsLength := len(commands)
 	progressForEachCommand := float32(100) / float32(commandsLength)
 
 	progress := float32(0)
 	for _, command := range commands {
 		PrintRingNameIfDebug(context, command)
 		printProgressIfProgressEnabledAndMachineLogger(progressEnabled, context, progress)
-		err := command.Run(context)
+		err := command.Run(context, ctx)
 		if err != nil {
 			return utils.WrapError(err)
 		}
@@ -213,17 +213,17 @@ func PrintRingNameIfDebug(context map[string]interface{}, command types.Command)
 	}
 }
 
-func RunBuilder(context map[string]interface{}) error {
+func RunBuilder(context map[string]interface{}, ctx *types.Context) error {
 	command := Builder{}
-	return command.Run(context)
+	return command.Run(context, ctx)
 }
 
-func RunParseHardwareAndDumpBuildProperties(context map[string]interface{}) error {
+func RunParseHardwareAndDumpBuildProperties(context map[string]interface{}, ctx *types.Context) error {
 	command := ParseHardwareAndDumpBuildProperties{}
-	return command.Run(context)
+	return command.Run(context, ctx)
 }
 
-func RunPreprocess(context map[string]interface{}) error {
+func RunPreprocess(context map[string]interface{}, ctx *types.Context) error {
 	command := Preprocess{}
-	return command.Run(context)
+	return command.Run(context, ctx)
 }

src/arduino.cc/builder/coan_runner.go

@@ -33,6 +33,7 @@ import (
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/props"
+	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
 	"fmt"
 	"path/filepath"
@@ -43,7 +44,7 @@ var ALLOWED_ARG = regexp.MustCompile("^source$|\\-E$|\\-m$|\\-P$|\\-kb$|\\-D.*")
 
 type CoanRunner struct{}
 
-func (s *CoanRunner) Run(context map[string]interface{}) error {
+func (s *CoanRunner) Run(context map[string]interface{}, ctx *types.Context) error {
 	source := context[constants.CTX_SOURCE].(string)
 	source += "\n"
 	verbose := context[constants.CTX_VERBOSE].(bool)

src/arduino.cc/builder/collect_all_source_files_from_folders_with_sources.go

@@ -42,7 +42,7 @@ import (
 
 type CollectAllSourceFilesFromFoldersWithSources struct{}
 
-func (s *CollectAllSourceFilesFromFoldersWithSources) Run(context map[string]interface{}) error {
+func (s *CollectAllSourceFilesFromFoldersWithSources) Run(context map[string]interface{}, ctx *types.Context) error {
 	foldersWithSources := context[constants.CTX_FOLDERS_WITH_SOURCES_QUEUE].(*types.UniqueSourceFolderQueue)
 	sourceFiles := context[constants.CTX_COLLECTED_SOURCE_FILES_QUEUE].(*types.UniqueStringQueue)
 

src/arduino.cc/builder/collect_ctags_from_sketch_files.go

@@ -38,7 +38,7 @@ import (
 
 type CollectCTagsFromSketchFiles struct{}
 
-func (s *CollectCTagsFromSketchFiles) Run(context map[string]interface{}) error {
+func (s *CollectCTagsFromSketchFiles) Run(context map[string]interface{}, ctx *types.Context) error {
 	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
 	sketchFileNames := collectSketchFileNamesFrom(sketch)
 

src/arduino.cc/builder/container_add_prototypes.go

@@ -38,7 +38,7 @@ import (
 
 type ContainerAddPrototypes struct{}
 
-func (s *ContainerAddPrototypes) Run(context map[string]interface{}) error {
+func (s *ContainerAddPrototypes) Run(context map[string]interface{}, ctx *types.Context) error {
 	commands := []types.Command{
 		&GCCPreprocRunner{TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},
 		&ReadFileAndStoreInContext{TargetField: constants.CTX_GCC_MINUS_E_SOURCE},
@@ -53,7 +53,7 @@ func (s *ContainerAddPrototypes) Run(context map[string]interface{}) error {
 
 	for _, command := range commands {
 		PrintRingNameIfDebug(context, command)
-		err := command.Run(context)
+		err := command.Run(context, ctx)
 		if err != nil {
 			return utils.WrapError(err)
 		}

src/arduino.cc/builder/container_build_options.go

@@ -36,7 +36,7 @@ import (
 
 type ContainerBuildOptions struct{}
 
-func (s *ContainerBuildOptions) Run(context map[string]interface{}) error {
+func (s *ContainerBuildOptions) Run(context map[string]interface{}, ctx *types.Context) error {
 	commands := []types.Command{
 		&CreateBuildOptionsMap{},
 		&LoadPreviousBuildOptionsMap{},
@@ -46,7 +46,7 @@ func (s *ContainerBuildOptions) Run(context map[string]interface{}) error {
 
 	for _, command := range commands {
 		PrintRingNameIfDebug(context, command)
-		err := command.Run(context)
+		err := command.Run(context, ctx)
 		if err != nil {
 			return utils.WrapError(err)
 		}