Moved Sketch in Context

cmaglie · cmaglie · commit a9fd1c674ee5 · 2016-05-03T11:45:30.000+02:00
Signed-off-by: Cristian Maglie &lt;c.maglie@arduino.cc&gt;
diff --git a/src/arduino.cc/builder/additional_sketch_files_copier.go b/src/arduino.cc/builder/additional_sketch_files_copier.go
@@ -30,7 +30,6 @@
 package builder
 
 import (
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
@@ -42,7 +41,7 @@ import (
 type AdditionalSketchFilesCopier struct{}
 
 func (s *AdditionalSketchFilesCopier) Run(context map[string]interface{}, ctx *types.Context) error {
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	sketchBuildPath := ctx.SketchBuildPath
 
 	err := utils.EnsureFolderExists(sketchBuildPath)
diff --git a/src/arduino.cc/builder/collect_ctags_from_sketch_files.go b/src/arduino.cc/builder/collect_ctags_from_sketch_files.go
@@ -30,7 +30,6 @@
 package builder
 
 import (
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
 	"strings"
@@ -39,8 +38,7 @@ import (
 type CollectCTagsFromSketchFiles struct{}
 
 func (s *CollectCTagsFromSketchFiles) Run(context map[string]interface{}, ctx *types.Context) error {
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
-	sketchFileNames := collectSketchFileNamesFrom(sketch)
+	sketchFileNames := collectSketchFileNamesFrom(ctx.Sketch)
 
 	allCtags := ctx.CTagsOfPreprocessedSource
 	ctagsOfSketch := []*types.CTag{}
diff --git a/src/arduino.cc/builder/constants/constants.go b/src/arduino.cc/builder/constants/constants.go
@@ -88,7 +88,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_SKETCH = "sketch"
 const CTX_SOURCE = "source"
 const CTX_TOOLS = "tools"
 const CTX_VIDPID = "VIDPID"
diff --git a/src/arduino.cc/builder/container_find_includes.go b/src/arduino.cc/builder/container_find_includes.go
@@ -46,7 +46,7 @@ func (s *ContainerFindIncludes) Run(context map[string]interface{}, ctx *types.C
 	}
 
 	sketchBuildPath := ctx.SketchBuildPath
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	err = findIncludesUntilDone(context, ctx, filepath.Join(sketchBuildPath, filepath.Base(sketch.MainFile.Name)+".cpp"))
 	if err != nil {
 		return i18n.WrapError(err)
diff --git a/src/arduino.cc/builder/gcc_preproc_runner.go b/src/arduino.cc/builder/gcc_preproc_runner.go
@@ -46,7 +46,7 @@ type GCCPreprocRunner struct {
 
 func (s *GCCPreprocRunner) Run(context map[string]interface{}, ctx *types.Context) error {
 	sketchBuildPath := ctx.SketchBuildPath
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	properties, targetFilePath, err := prepareGCCPreprocRecipeProperties(context, ctx, filepath.Join(sketchBuildPath, filepath.Base(sketch.MainFile.Name)+".cpp"), s.TargetFileName)
 	if err != nil {
 		return i18n.WrapError(err)
diff --git a/src/arduino.cc/builder/merge_sketch_with_bootloader.go b/src/arduino.cc/builder/merge_sketch_with_bootloader.go
@@ -48,7 +48,7 @@ func (s *MergeSketchWithBootloader) Run(context map[string]interface{}, ctx *typ
 	}
 
 	buildPath := ctx.BuildPath
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	sketchFileName := filepath.Base(sketch.MainFile.Name)
 	logger := ctx.GetLogger()
 
diff --git a/src/arduino.cc/builder/setup_build_properties.go b/src/arduino.cc/builder/setup_build_properties.go
@@ -57,8 +57,8 @@ func (s *SetupBuildProperties) Run(context map[string]interface{}, ctx *types.Co
 	if ctx.BuildPath != "" {
 		buildProperties[constants.BUILD_PROPERTIES_BUILD_PATH] = ctx.BuildPath
 	}
-	if utils.MapHas(context, constants.CTX_SKETCH) {
-		buildProperties[constants.BUILD_PROPERTIES_BUILD_PROJECT_NAME] = filepath.Base(context[constants.CTX_SKETCH].(*types.Sketch).MainFile.Name)
+	if ctx.Sketch != nil {
+		buildProperties[constants.BUILD_PROPERTIES_BUILD_PROJECT_NAME] = filepath.Base(ctx.Sketch.MainFile.Name)
 	}
 	buildProperties[constants.BUILD_PROPERTIES_BUILD_ARCH] = strings.ToUpper(targetPlatform.PlatformId)
 
diff --git a/src/arduino.cc/builder/sketch_loader.go b/src/arduino.cc/builder/sketch_loader.go
@@ -82,7 +82,7 @@ func (s *SketchLoader) Run(context map[string]interface{}, ctx *types.Context) e
 	}
 
 	ctx.SketchLocation = sketchLocation
-	context[constants.CTX_SKETCH] = sketch
+	ctx.Sketch = sketch
 
 	return nil
 }
diff --git a/src/arduino.cc/builder/sketch_saver.go b/src/arduino.cc/builder/sketch_saver.go
@@ -40,7 +40,7 @@ import (
 type SketchSaver struct{}
 
 func (s *SketchSaver) Run(context map[string]interface{}, ctx *types.Context) error {
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	sketchBuildPath := ctx.SketchBuildPath
 	source := context[constants.CTX_SOURCE].(string)
 
diff --git a/src/arduino.cc/builder/sketch_source_merger.go b/src/arduino.cc/builder/sketch_source_merger.go
@@ -40,7 +40,7 @@ import (
 type SketchSourceMerger struct{}
 
 func (s *SketchSourceMerger) Run(context map[string]interface{}, ctx *types.Context) error {
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 
 	lineOffset := 0
 	includeSection := ""
diff --git a/src/arduino.cc/builder/test/coan_runner_test.go b/src/arduino.cc/builder/test/coan_runner_test.go
@@ -68,7 +68,7 @@ func TestCoanRunner(t *testing.T) {
 		NoError(t, err)
 	}
 
-	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch2", "SketchWithIfDef.resolved.directives.txt"), context)
+	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch2", "SketchWithIfDef.resolved.directives.txt"), context, ctx)
 	require.Equal(t, expectedSource, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 
 }
diff --git a/src/arduino.cc/builder/test/helper.go b/src/arduino.cc/builder/test/helper.go
@@ -44,7 +44,7 @@ import (
 	"text/template"
 )
 
-func LoadAndInterpolate(t *testing.T, filename string, context map[string]interface{}) string {
+func LoadAndInterpolate(t *testing.T, filename string, context map[string]interface{}, ctx *types.Context) string {
 	funcsMap := template.FuncMap{
 		"EscapeBackSlashes": func(s string) string {
 			return strings.Replace(s, "\\", "\\\\", -1)
@@ -55,6 +55,7 @@ func LoadAndInterpolate(t *testing.T, filename string, context map[string]interf
 	NoError(t, err)
 
 	var buf bytes.Buffer
+	context["sketch"] = ctx.Sketch
 	err = tpl.Execute(&buf, context)
 	NoError(t, err)
 
diff --git a/src/arduino.cc/builder/test/prototypes_adder_test.go b/src/arduino.cc/builder/test/prototypes_adder_test.go
@@ -124,7 +124,7 @@ func TestPrototypesAdderSketchWithIfDef(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch2", "SketchWithIfDef.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch2", "SketchWithIfDef.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -165,7 +165,7 @@ func TestPrototypesAdderBaladuino(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch3", "Baladuino.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch3", "Baladuino.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -206,7 +206,7 @@ func TestPrototypesAdderCharWithEscapedDoubleQuote(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch4", "CharWithEscapedDoubleQuote.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch4", "CharWithEscapedDoubleQuote.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -247,7 +247,7 @@ func TestPrototypesAdderIncludeBetweenMultilineComment(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch5", "IncludeBetweenMultilineComment.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch5", "IncludeBetweenMultilineComment.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -288,7 +288,7 @@ func TestPrototypesAdderLineContinuations(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch6", "LineContinuations.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch6", "LineContinuations.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -329,7 +329,7 @@ func TestPrototypesAdderStringWithComment(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch7", "StringWithComment.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch7", "StringWithComment.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -370,7 +370,7 @@ func TestPrototypesAdderSketchWithStruct(t *testing.T) {
 		NoError(t, err)
 	}
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch8", "SketchWithStruct.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch8", "SketchWithStruct.preprocessed.txt"), context, ctx)
 	obtained := strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1)
 	// ctags based preprocessing removes the space after "dostuff", but this is still OK
 	// TODO: remove this exception when moving to a more powerful parser
@@ -422,7 +422,7 @@ func TestPrototypesAdderSketchWithConfig(t *testing.T) {
 	require.Equal(t, "#include <Arduino.h>\n#line 1 \""+absoluteSketchLocation+"\"\n", context[constants.CTX_INCLUDE_SECTION].(string))
 	require.Equal(t, "#line 13 \""+absoluteSketchLocation+"\"\nvoid setup();\n#line 17 \""+absoluteSketchLocation+"\"\nvoid loop();\n#line 13 \""+absoluteSketchLocation+"\"\n", ctx.PrototypesSection)
 
-	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch_with_config", "sketch_with_config.preprocessed.txt"), context)
+	preprocessed := LoadAndInterpolate(t, filepath.Join("sketch_with_config", "sketch_with_config.preprocessed.txt"), context, ctx)
 	require.Equal(t, preprocessed, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -793,7 +793,7 @@ func TestPrototypesAdderSketchWithIfDef2(t *testing.T) {
 	require.Equal(t, "#include <Arduino.h>\n#line 1 \""+absoluteSketchLocation+"\"\n", context[constants.CTX_INCLUDE_SECTION].(string))
 	require.Equal(t, "#line 5 \""+absoluteSketchLocation+"\"\nvoid elseBranch();\n#line 9 \""+absoluteSketchLocation+"\"\nvoid f1();\n#line 10 \""+absoluteSketchLocation+"\"\nvoid f2();\n#line 12 \""+absoluteSketchLocation+"\"\nvoid setup();\n#line 14 \""+absoluteSketchLocation+"\"\nvoid loop();\n#line 5 \""+absoluteSketchLocation+"\"\n", ctx.PrototypesSection)
 
-	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch_with_ifdef", "sketch.preprocessed.txt"), context)
+	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch_with_ifdef", "sketch.preprocessed.txt"), context, ctx)
 	require.Equal(t, expectedSource, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
@@ -840,7 +840,7 @@ func TestPrototypesAdderSketchWithIfDef2SAM(t *testing.T) {
 	require.Equal(t, "#include <Arduino.h>\n#line 1 \""+absoluteSketchLocation+"\"\n", context[constants.CTX_INCLUDE_SECTION].(string))
 	require.Equal(t, "#line 2 \""+absoluteSketchLocation+"\"\nvoid ifBranch();\n#line 9 \""+absoluteSketchLocation+"\"\nvoid f1();\n#line 10 \""+absoluteSketchLocation+"\"\nvoid f2();\n#line 12 \""+absoluteSketchLocation+"\"\nvoid setup();\n#line 14 \""+absoluteSketchLocation+"\"\nvoid loop();\n#line 2 \""+absoluteSketchLocation+"\"\n", ctx.PrototypesSection)
 
-	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch_with_ifdef", "sketch.preprocessed.SAM.txt"), context)
+	expectedSource := LoadAndInterpolate(t, filepath.Join("sketch_with_ifdef", "sketch.preprocessed.SAM.txt"), context, ctx)
 	require.Equal(t, expectedSource, strings.Replace(context[constants.CTX_SOURCE].(string), "\r\n", "\n", -1))
 }
 
diff --git a/src/arduino.cc/builder/test/sketch_loader_test.go b/src/arduino.cc/builder/test/sketch_loader_test.go
@@ -31,7 +31,6 @@ package test
 
 import (
 	"arduino.cc/builder"
-	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
 	"github.com/stretchr/testify/require"
 	"path/filepath"
@@ -48,9 +47,7 @@ func TestLoadSketchWithFolder(t *testing.T) {
 	err := loader.Run(context, ctx)
 
 	require.Error(t, err)
-
-	sketch := context[constants.CTX_SKETCH]
-	require.Nil(t, sketch)
+	require.Nil(t, ctx.Sketch)
 }
 
 func TestLoadSketchNonExistentPath(t *testing.T) {
@@ -63,9 +60,7 @@ func TestLoadSketchNonExistentPath(t *testing.T) {
 	err := loader.Run(context, ctx)
 
 	require.Error(t, err)
-
-	sketch := context[constants.CTX_SKETCH]
-	require.Nil(t, sketch)
+	require.Nil(t, ctx.Sketch)
 }
 
 func TestLoadSketch(t *testing.T) {
@@ -83,7 +78,7 @@ func TestLoadSketch(t *testing.T) {
 		NoError(t, err)
 	}
 
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	require.NotNil(t, sketch)
 
 	require.Contains(t, sketch.MainFile.Name, "sketch.ino")
@@ -107,9 +102,7 @@ func TestFailToLoadSketchFromFolder(t *testing.T) {
 	loader := builder.SketchLoader{}
 	err := loader.Run(context, ctx)
 	require.Error(t, err)
-
-	sketch := context[constants.CTX_SKETCH]
-	require.Nil(t, sketch)
+	require.Nil(t, ctx.Sketch)
 }
 
 func TestLoadSketchFromFolder(t *testing.T) {
@@ -127,7 +120,7 @@ func TestLoadSketchFromFolder(t *testing.T) {
 		NoError(t, err)
 	}
 
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	require.NotNil(t, sketch)
 
 	require.Contains(t, sketch.MainFile.Name, "sketch_with_subfolders.ino")
@@ -154,7 +147,7 @@ func TestLoadSketchWithBackup(t *testing.T) {
 		NoError(t, err)
 	}
 
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	require.NotNil(t, sketch)
 
 	require.Contains(t, sketch.MainFile.Name, "sketch.ino")
@@ -178,7 +171,7 @@ func TestLoadSketchWithMacOSXGarbage(t *testing.T) {
 		NoError(t, err)
 	}
 
-	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketch := ctx.Sketch
 	require.NotNil(t, sketch)
 
 	require.Contains(t, sketch.MainFile.Name, "sketch.ino")
diff --git a/src/arduino.cc/builder/test/sketch_source_merger_test.go b/src/arduino.cc/builder/test/sketch_source_merger_test.go
@@ -58,6 +58,6 @@ func TestMergeSketch(t *testing.T) {
 
 	source := context[constants.CTX_SOURCE].(string)
 
-	expected_source := LoadAndInterpolate(t, filepath.Join("sketch1", "merged_sketch.txt"), context)
+	expected_source := LoadAndInterpolate(t, filepath.Join("sketch1", "merged_sketch.txt"), context, ctx)
 	require.Equal(t, expected_source, strings.Replace(source, "\r\n", "\n", -1))
 }
diff --git a/src/arduino.cc/builder/types/context.go b/src/arduino.cc/builder/types/context.go
@@ -35,6 +35,8 @@ type Context struct {
 	CollectedSourceFiles   *UniqueStringQueue
 	FoldersWithSourceFiles *UniqueSourceFolderQueue
 
+	Sketch *Sketch
+
 	WarningsLevel string
 
 	// Libraries handling

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func (s ContainerFindIncludes) Run(context map[string]interface{}, ctx types.C`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`sketchBuildPath := ctx.SketchBuildPath`
`49`		`- sketch := context[constants.CTX_SKETCH].(*types.Sketch)`
	`49`	`+ sketch := ctx.Sketch`
`50`	`50`	`err = findIncludesUntilDone(context, ctx, filepath.Join(sketchBuildPath, filepath.Base(sketch.MainFile.Name)+".cpp"))`
`51`	`51`	`if err != nil {`
`52`	`52`	`return i18n.WrapError(err)`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ func (s MergeSketchWithBootloader) Run(context map[string]interface{}, ctx typ`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`buildPath := ctx.BuildPath`
`51`		`- sketch := context[constants.CTX_SKETCH].(*types.Sketch)`
	`51`	`+ sketch := ctx.Sketch`
`52`	`52`	`sketchFileName := filepath.Base(sketch.MainFile.Name)`
`53`	`53`	`logger := ctx.GetLogger()`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,8 @@ func (s SetupBuildProperties) Run(context map[string]interface{}, ctx types.Co`
`57`	`57`	`if ctx.BuildPath != "" {`
`58`	`58`	`buildProperties[constants.BUILD_PROPERTIES_BUILD_PATH] = ctx.BuildPath`
`59`	`59`	`}`
`60`		`- if utils.MapHas(context, constants.CTX_SKETCH) {`
`61`		`- buildProperties[constants.BUILD_PROPERTIES_BUILD_PROJECT_NAME] = filepath.Base(context[constants.CTX_SKETCH].(*types.Sketch).MainFile.Name)`
	`60`	`+ if ctx.Sketch != nil {`
	`61`	`+ buildProperties[constants.BUILD_PROPERTIES_BUILD_PROJECT_NAME] = filepath.Base(ctx.Sketch.MainFile.Name)`
`62`	`62`	`}`
`63`	`63`	`buildProperties[constants.BUILD_PROPERTIES_BUILD_ARCH] = strings.ToUpper(targetPlatform.PlatformId)`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func (s SketchLoader) Run(context map[string]interface{}, ctx types.Context) e`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`ctx.SketchLocation = sketchLocation`
`85`		`- context[constants.CTX_SKETCH] = sketch`
	`85`	`+ ctx.Sketch = sketch`
`86`	`86`
`87`	`87`	`return nil`
`88`	`88`	`}`