Remove legacy "rewrite-rules" feature (#2132)

* Refactored AddMissingBuildPropertiesFromParentPlatformTxtFiles

Previously the specific recipes to run CTags were added to global build
properties. Now the global build properties are not altered anymore and
the CTags-specific properties are created only to run CTags and dropped
afterward.

* Removed platform rewrite-rules functionality

Author: cmaglie

arduino/cores/packagemanager/package_manager.go

@@ -360,6 +360,7 @@ func (pme *Explorer) ResolveFQBN(fqbn *cores.FQBN) (
 	buildProperties.Set("runtime.os", properties.GetOSSuffix())
 	buildProperties.Set("build.library_discovery_phase", "0")
 	// Deprecated properties
+	buildProperties.Set("tools.avrdude.path", "{runtime.tools.avrdude.path}")
 	buildProperties.Set("ide_version", "10607")
 	buildProperties.Set("runtime.ide.version", "10607")
 	if !buildProperties.ContainsKey("software") {

legacy/builder/add_additional_entries_to_context.go

@@ -16,7 +16,6 @@
 package builder
 
 import (
-	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/pkg/errors"
@@ -57,7 +56,6 @@ func (*AddAdditionalEntriesToContext) Run(ctx *types.Context) error {
 	ctx.CollectedSourceFiles = &types.UniqueSourceFileQueue{}
 
 	ctx.LibrariesResolutionResults = map[string]types.LibraryResolutionResult{}
-	ctx.HardwareRewriteResults = map[*cores.PlatformRelease][]types.PlatforKeyRewrite{}
 
 	return nil
 }

legacy/builder/add_missing_build_properties_from_parent_platform_txt_files.go

@@ -44,8 +44,6 @@ func (s *Builder) Run(ctx *types.Context) error {
 
 		&ContainerBuildOptions{},
 
-		&WarnAboutPlatformRewrites{},
-
 		&RecipeByPrefixSuffixRunner{Prefix: "recipe.hooks.prebuild", Suffix: ".pattern"},
 
 		&ContainerMergeCopySketchFiles{},

legacy/builder/builder.go

@@ -33,7 +33,6 @@ const BUILD_PROPERTIES_INCLUDES = "includes"
 const BUILD_PROPERTIES_OBJECT_FILE = "object_file"
 const BUILD_PROPERTIES_RUNTIME_PLATFORM_PATH = "runtime.platform.path"
 const EMPTY_STRING = ""
-const FILE_PLATFORM_KEYS_REWRITE_TXT = "platform.keys.rewrite.txt"
 const FOLDER_BOOTLOADERS = "bootloaders"
 const FOLDER_CORE = "core"
 const FOLDER_PREPROC = "preproc"
@@ -52,15 +51,10 @@ const LOG_LEVEL_WARN = "warn"
 const PACKAGE_NAME = "name"
 const PACKAGE_TOOLS = "tools"
 const PLATFORM_ARCHITECTURE = "architecture"
-const PLATFORM_NAME = "name"
-const PLATFORM_REWRITE_NEW = "new"
-const PLATFORM_REWRITE_OLD = "old"
 const PLATFORM_URL = "url"
 const PLATFORM_VERSION = "version"
 const RECIPE_AR_PATTERN = "recipe.ar.pattern"
 const RECIPE_C_COMBINE_PATTERN = "recipe.c.combine.pattern"
-const REWRITING_DISABLED = "disabled"
-const REWRITING = "rewriting"
 const SPACE = " "
 const TOOL_NAME = "name"
 const TOOL_URL = "url"

legacy/builder/constants/constants.go

@@ -31,8 +31,6 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 		&AddAdditionalEntriesToContext{},
 		&FailIfBuildPathEqualsSketchPath{},
 		&HardwareLoader{},
-		&PlatformKeysRewriteLoader{},
-		&RewriteHardwareKeys{},
 		&TargetBoardResolver{},
 		&LibrariesLoader{},
 	}
@@ -53,7 +51,6 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 	commands = []types.Command{
 		&SetupBuildProperties{},
 		&SetCustomBuildProperties{},
-		&AddMissingBuildPropertiesFromParentPlatformTxtFiles{},
 	}
 
 	for _, command := range commands {

legacy/builder/container_setup.go

@@ -29,19 +29,22 @@ import (
 type CTagsRunner struct{}
 
 func (s *CTagsRunner) Run(ctx *types.Context) error {
-	buildProperties := ctx.BuildProperties
 	ctagsTargetFilePath := ctx.CTagsTargetFile
 
-	ctagsProperties := buildProperties.Clone()
-	ctagsProperties.Merge(buildProperties.SubTree("tools").SubTree("ctags"))
-	ctagsProperties.SetPath("source_file", ctagsTargetFilePath)
+	buildProperties := properties.NewMap()
+	buildProperties.Set("tools.ctags.path", "{runtime.tools.ctags.path}")
+	buildProperties.Set("tools.ctags.cmd.path", "{path}/ctags")
+	buildProperties.Set("tools.ctags.pattern", `"{cmd.path}" -u --language-force=c++ -f - --c++-kinds=svpf --fields=KSTtzns --line-directives "{source_file}"`)
+	buildProperties.Merge(ctx.BuildProperties)
+	buildProperties.Merge(buildProperties.SubTree("tools").SubTree("ctags"))
+	buildProperties.SetPath("source_file", ctagsTargetFilePath)
 
-	pattern := ctagsProperties.Get("pattern")
+	pattern := buildProperties.Get("pattern")
 	if pattern == "" {
 		return errors.Errorf(tr("%s pattern is missing"), "ctags")
 	}
 
-	commandLine := ctagsProperties.ExpandPropsInString(pattern)
+	commandLine := buildProperties.ExpandPropsInString(pattern)
 	parts, err := properties.SplitQuotedString(commandLine, `"'`, false)
 	if err != nil {
 		return errors.WithStack(err)

legacy/builder/ctags/ctags_properties.go

@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/arduino/arduino-cli/legacy/builder/utils"
 	"github.com/arduino/go-paths-helper"
+	properties "github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
 )
 
@@ -55,20 +56,28 @@ func GCCPreprocRunnerForDiscoveringIncludes(ctx *types.Context, sourceFilePath *
 }
 
 func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath *paths.Path, targetFilePath *paths.Path, includes paths.PathList) (*exec.Cmd, error) {
-	properties := ctx.BuildProperties.Clone()
-	properties.Set("build.library_discovery_phase", "1")
-	properties.SetPath("source_file", sourceFilePath)
-	properties.SetPath("preprocessed_file_path", targetFilePath)
+	buildProperties := properties.NewMap()
+	buildProperties.Set("preproc.macros.flags", "-w -x c++ -E -CC")
+	buildProperties.Merge(ctx.BuildProperties)
+	buildProperties.Set("build.library_discovery_phase", "1")
+	buildProperties.SetPath("source_file", sourceFilePath)
+	buildProperties.SetPath("preprocessed_file_path", targetFilePath)
 
 	includesStrings := utils.Map(includes.AsStrings(), utils.WrapWithHyphenI)
-	properties.Set("includes", strings.Join(includesStrings, " "))
+	buildProperties.Set("includes", strings.Join(includesStrings, " "))
 
-	if properties.Get("recipe.preproc.macros") == "" {
-		//generate PREPROC_MACROS from RECIPE_CPP_PATTERN
-		properties.Set("recipe.preproc.macros", GeneratePreprocPatternFromCompile(properties.Get("recipe.cpp.o.pattern")))
+	if buildProperties.Get("recipe.preproc.macros") == "" {
+		// autogenerate preprocess macros recipe from compile recipe
+		preprocPattern := buildProperties.Get("recipe.cpp.o.pattern")
+		// add {preproc.macros.flags} to {compiler.cpp.flags}
+		preprocPattern = strings.Replace(preprocPattern, "{compiler.cpp.flags}", "{compiler.cpp.flags} {preproc.macros.flags}", 1)
+		// replace "{object_file}" with "{preprocessed_file_path}"
+		preprocPattern = strings.Replace(preprocPattern, "{object_file}", "{preprocessed_file_path}", 1)
+
+		buildProperties.Set("recipe.preproc.macros", preprocPattern)
 	}
 
-	cmd, err := builder_utils.PrepareCommandForRecipe(properties, "recipe.preproc.macros", true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
+	cmd, err := builder_utils.PrepareCommandForRecipe(buildProperties, "recipe.preproc.macros", true, ctx.PackageManager.GetEnvVarsForSpawnedProcess())
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
@@ -79,12 +88,3 @@ func prepareGCCPreprocRecipeProperties(ctx *types.Context, sourceFilePath *paths
 
 	return cmd, nil
 }
-
-func GeneratePreprocPatternFromCompile(compilePattern string) string {
-	// add {preproc.macros.flags}
-	// replace "{object_file}" with "{preprocessed_file_path}"
-	returnString := compilePattern
-	returnString = strings.Replace(returnString, "{compiler.cpp.flags}", "{compiler.cpp.flags} {preproc.macros.flags}", 1)
-	returnString = strings.Replace(returnString, "{object_file}", "{preprocessed_file_path}", 1)
-	return returnString
-}