Moved Source and SourceGccMinusE into Context

Some helper "Command" now accepts directly the address of the target
string to work on instead of the key of the context map that contains
the string. Those "arguments" are, I guess, legacy from old
preprocessing and library discovery and IMHO they can be removed with a
bit of refactoring.

Anyway, I've intentionally limited the scope of this commit and left
further optimization for the future.

Signed-off-by: Cristian Maglie <c.maglie@arduino.cc>

Author: cmaglie

src/arduino.cc/builder/constants/constants.go

@@ -76,7 +76,6 @@ const CTAGS = "ctags"
 const CTX_ARCHIVE_FILE_PATH_CORE = "archiveFileCore"
 const CTX_BUILD_CORE = "buildCore"
 const CTX_FILE_PATH_TO_READ = "filePathToRead"
-const CTX_GCC_MINUS_E_SOURCE = "gccMinusESource"
 const CTX_GCC_MINUS_M_OUTPUT = "gccMinusMOutput"
 const CTX_HARDWARE = "hardware"
 const CTX_HARDWARE_REWRITE_RESULTS = "hardwareRewriteResults"
@@ -87,7 +86,6 @@ const CTX_OBJECT_FILES_CORE = "objectFilesCore"
 const CTX_OBJECT_FILES_LIBRARIES = "objectFilesLibraries"
 const CTX_OBJECT_FILES_SKETCH = "objectFilesSketch"
 const CTX_PLATFORM_KEYS_REWRITE = "platformKeysRewrite"
-const CTX_SOURCE = "source"
 const CTX_TOOLS = "tools"
 const CTX_VIDPID = "VIDPID"
 const EMPTY_STRING = ""

src/arduino.cc/builder/container_add_prototypes.go

@@ -41,8 +41,8 @@ type ContainerAddPrototypes struct{}
 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},
-		&CTagsTargetFileSaver{SourceField: constants.CTX_GCC_MINUS_E_SOURCE, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},
+		&ReadFileAndStoreInContext{Target: &ctx.SourceGccMinusE},
+		&CTagsTargetFileSaver{Source: &ctx.SourceGccMinusE, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},
 		&ctags.CTagsRunner{},
 		&ctags.CTagsParser{},
 		&CollectCTagsFromSketchFiles{},

src/arduino.cc/builder/container_find_includes.go

@@ -105,7 +105,7 @@ func findIncludesUntilDone(context map[string]interface{}, ctx *types.Context, s
 	for !done {
 		commands := []types.Command{
 			&GCCPreprocRunnerForDiscoveringIncludes{SourceFilePath: sourceFilePath, TargetFilePath: targetFilePath},
-			&IncludesFinderWithRegExp{ContextField: constants.CTX_GCC_MINUS_E_SOURCE},
+			&IncludesFinderWithRegExp{Source: &ctx.SourceGccMinusE},
 			&IncludesToIncludeFolders{},
 		}
 		for _, command := range commands {

src/arduino.cc/builder/ctags_target_file_saver.go

@@ -37,12 +37,12 @@ import (
 )
 
 type CTagsTargetFileSaver struct {
-	SourceField    string
+	Source         *string
 	TargetFileName string
 }
 
 func (s *CTagsTargetFileSaver) Run(context map[string]interface{}, ctx *types.Context) error {
-	source := context[s.SourceField].(string)
+	source := *s.Source
 
 	preprocPath := ctx.PreprocPath
 	err := utils.EnsureFolderExists(preprocPath)

src/arduino.cc/builder/external_include_replacer.go

@@ -36,22 +36,22 @@ import (
 )
 
 type ExternalIncludeReplacer struct {
-	SourceKey string
-	TargetKey string
-	From      string
-	To        string
+	Source *string
+	Target *string
+	From   string
+	To     string
 }
 
 func (s *ExternalIncludeReplacer) Run(context map[string]interface{}, ctx *types.Context) error {
-	source := context[s.SourceKey].(string)
+	source := *s.Source
 	nonAbsoluteIncludes := findNonAbsoluteIncludes(ctx.Includes)
 
 	for _, include := range nonAbsoluteIncludes {
 		source = strings.Replace(source, s.From+"<"+include+">", s.To+"<"+include+">", -1)
 		source = strings.Replace(source, s.From+"\""+include+"\"", s.To+"\""+include+"\"", -1)
 	}
 
-	context[s.TargetKey] = source
+	*s.Target = source
 
 	return nil
 }

src/arduino.cc/builder/gcc_preproc_runner.go

@@ -93,7 +93,7 @@ func (s *GCCPreprocRunnerForDiscoveringIncludes) Run(context map[string]interfac
 		return i18n.WrapError(err)
 	}
 
-	context[constants.CTX_GCC_MINUS_E_SOURCE] = string(stderr)
+	ctx.SourceGccMinusE = string(stderr)
 
 	return nil
 }

src/arduino.cc/builder/gcc_preproc_source_saver.go

@@ -46,8 +46,6 @@ func (s *GCCPreprocSourceSaver) Run(context map[string]interface{}, ctx *types.C
 		return i18n.WrapError(err)
 	}
 
-	source := context[constants.CTX_SOURCE].(string)
-
-	err = utils.WriteFile(filepath.Join(preprocPath, constants.FILE_GCC_PREPROC_TARGET), source)
+	err = utils.WriteFile(filepath.Join(preprocPath, constants.FILE_GCC_PREPROC_TARGET), ctx.Source)
 	return i18n.WrapError(err)
 }

src/arduino.cc/builder/includes_finder_with_regexp.go

@@ -40,11 +40,11 @@ import (
 var INCLUDE_REGEXP = regexp.MustCompile("(?ms)^\\s*#[ \t]*include\\s*[<\"](\\S+)[\">]")
 
 type IncludesFinderWithRegExp struct {
-	ContextField string
+	Source *string
 }
 
 func (s *IncludesFinderWithRegExp) Run(context map[string]interface{}, ctx *types.Context) error {
-	source := context[s.ContextField].(string)
+	source := *s.Source
 
 	matches := INCLUDE_REGEXP.FindAllStringSubmatch(source, -1)
 	includes := []string{}

src/arduino.cc/builder/print_preprocessed_source.go

@@ -30,17 +30,13 @@
 package builder
 
 import (
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 	"fmt"
 )
 
 type PrintPreprocessedSource struct{}
 
 func (s *PrintPreprocessedSource) Run(context map[string]interface{}, ctx *types.Context) error {
-	source := context[constants.CTX_GCC_MINUS_E_SOURCE].(string)
-
-	fmt.Println(source)
-
+	fmt.Println(ctx.SourceGccMinusE)
 	return nil
 }

src/arduino.cc/builder/prototypes_adder.go

@@ -41,7 +41,7 @@ type PrototypesAdder struct{}
 
 func (s *PrototypesAdder) Run(context map[string]interface{}, ctx *types.Context) error {
 	debugOutput := ctx.DebugPreprocessor
-	source := context[constants.CTX_SOURCE].(string)
+	source := ctx.Source
 
 	source = strings.Replace(source, "\r\n", "\n", -1)
 	source = strings.Replace(source, "\r", "\n", -1)
@@ -74,7 +74,7 @@ func (s *PrototypesAdder) Run(context map[string]interface{}, ctx *types.Context
 		}
 		fmt.Println("#END OF PREPROCESSED SOURCE")
 	}
-	context[constants.CTX_SOURCE] = source
+	ctx.Source = source
 
 	return nil
 }