Platform rewrite warnings are now emitted only for the actual selected library.

Fixes #57

Signed-off-by: Federico Fissore <[email protected]>

Author: Federico Fissore

Diff for: src/arduino.cc/builder/add_additional_entries_to_context.go

@@ -86,6 +86,7 @@ func (s *AddAdditionalEntriesToContext) Run(context map[string]interface{}) erro
 	context[constants.CTX_FOLDERS_WITH_SOURCES_QUEUE] = foldersWithSources
 
 	context[constants.CTX_LIBRARY_RESOLUTION_RESULTS] = make(map[string]types.LibraryResolutionResult)
+	context[constants.CTX_HARDWARE_REWRITE_RESULTS] = make(map[*types.Platform][]types.PlatforKeyRewrite)
 
 	return nil
 }

Diff for: src/arduino.cc/builder/builder.go

@@ -77,6 +77,8 @@ func (s *Builder) Run(context map[string]interface{}) error {
 
 		&ContainerBuildOptions{},
 
+		&WarnAboutPlatformRewrites{},
+
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 
 		&ContainerMergeCopySketchFiles{},

Diff for: src/arduino.cc/builder/constants/constants.go

@@ -99,6 +99,7 @@ const CTX_GCC_MINUS_E_SOURCE = "gccMinusESource"
 const CTX_GCC_MINUS_M_OUTPUT = "gccMinusMOutput"
 const CTX_HARDWARE_FOLDERS = "hardwareFolders"
 const CTX_HARDWARE = "hardware"
+const CTX_HARDWARE_REWRITE_RESULTS = "hardwareRewriteResults"
 const CTX_HEADER_TO_LIBRARIES = "headerToLibraries"
 const CTX_IMPORTED_LIBRARIES = "importedLibraries"
 const CTX_INCLUDE_FOLDERS = "includeFolders"

Diff for: src/arduino.cc/builder/rewrite_hardware_keys.go

@@ -31,10 +31,8 @@ package builder
 
 import (
 	"arduino.cc/builder/constants"
-	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
-	"os"
 )
 
 type RewriteHardwareKeys struct{}
@@ -46,19 +44,17 @@ func (s *RewriteHardwareKeys) Run(context map[string]interface{}) error {
 
 	packages := context[constants.CTX_HARDWARE].(*types.Packages)
 	platformKeysRewrite := context[constants.CTX_PLATFORM_KEYS_REWRITE].(types.PlatforKeysRewrite)
-	logger := context[constants.CTX_LOGGER].(i18n.Logger)
-
-	warn := utils.DebugLevel(context) > 0
+	hardwareRewriteResults := context[constants.CTX_HARDWARE_REWRITE_RESULTS].(map[*types.Platform][]types.PlatforKeyRewrite)
 
 	for _, aPackage := range packages.Packages {
 		for _, platform := range aPackage.Platforms {
 			if platform.Properties[constants.REWRITING] != constants.REWRITING_DISABLED {
 				for _, rewrite := range platformKeysRewrite.Rewrites {
 					if platform.Properties[rewrite.Key] != constants.EMPTY_STRING && platform.Properties[rewrite.Key] == rewrite.OldValue {
 						platform.Properties[rewrite.Key] = rewrite.NewValue
-						if warn {
-							logger.Fprintln(os.Stderr, constants.MSG_WARNING_PLATFORM_OLD_VALUES, platform.Properties[constants.PLATFORM_NAME], rewrite.Key+"="+rewrite.OldValue, rewrite.Key+"="+rewrite.NewValue)
-						}
+						appliedRewrites := rewritesAppliedToPlatform(platform, hardwareRewriteResults)
+						appliedRewrites = append(appliedRewrites, rewrite)
+						hardwareRewriteResults[platform] = appliedRewrites
 					}
 				}
 			}
@@ -67,3 +63,10 @@ func (s *RewriteHardwareKeys) Run(context map[string]interface{}) error {
 
 	return nil
 }
+
+func rewritesAppliedToPlatform(platform *types.Platform, hardwareRewriteResults map[*types.Platform][]types.PlatforKeyRewrite) []types.PlatforKeyRewrite {
+	if hardwareRewriteResults[platform] == nil {
+		hardwareRewriteResults[platform] = []types.PlatforKeyRewrite{}
+	}
+	return hardwareRewriteResults[platform]
+}

Diff for: src/arduino.cc/builder/warn_about_platform_rewrites.go

@@ -0,0 +1,67 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package builder
+
+import (
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/i18n"
+	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
+	"os"
+)
+
+type WarnAboutPlatformRewrites struct{}
+
+func (s *WarnAboutPlatformRewrites) Run(context map[string]interface{}) error {
+	warn := utils.DebugLevel(context) > 0
+	if !warn {
+		return nil
+	}
+
+	logger := context[constants.CTX_LOGGER].(i18n.Logger)
+	hardwareRewriteResults := context[constants.CTX_HARDWARE_REWRITE_RESULTS].(map[*types.Platform][]types.PlatforKeyRewrite)
+	targetPlatform := context[constants.CTX_TARGET_PLATFORM].(*types.Platform)
+	actualPlatform := context[constants.CTX_ACTUAL_PLATFORM].(*types.Platform)
+
+	platforms := []*types.Platform{targetPlatform}
+	if actualPlatform != targetPlatform {
+		platforms = append(platforms, actualPlatform)
+	}
+
+	for _, platform := range platforms {
+		if hardwareRewriteResults[platform] != nil {
+			for _, rewrite := range hardwareRewriteResults[platform] {
+				logger.Fprintln(os.Stderr, constants.MSG_WARNING_PLATFORM_OLD_VALUES, platform.Properties[constants.PLATFORM_NAME], rewrite.Key+"="+rewrite.OldValue, rewrite.Key+"="+rewrite.NewValue)
+			}
+		}
+	}
+
+	return nil
+}