Introducing types.Prototype: useful for carrying more data about original

ctags output, including function name
Function name is used in compare_prototypes_from_source_and_preproc_source
to understand if a function is part of preprocessed output.
Also, prototype from preprocessed output is used instead of that coming from
ctags on plain sketch, as ctags may be fooled by #define
Fixes #28

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

Author: Federico Fissore

src/arduino.cc/builder/compare_prototypes_from_source_and_preproc_source.go

@@ -31,19 +31,20 @@ package builder
 
 import (
 	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
 )
 
 type ComparePrototypesFromSourceAndPreprocSource struct{}
 
 func (s *ComparePrototypesFromSourceAndPreprocSource) Run(context map[string]interface{}) error {
-	prototypesOfSource := context[constants.CTX_PROTOTYPES_OF_SOURCE].([]string)
-	prototypesOfPreprocSource := context[constants.CTX_PROTOTYPES_OF_PREPROC_SOURCE].([]string)
+	prototypesOfSource := context[constants.CTX_PROTOTYPES_OF_SOURCE].([]*types.Prototype)
+	prototypesOfPreprocSource := context[constants.CTX_PROTOTYPES_OF_PREPROC_SOURCE].([]*types.Prototype)
 
-	var actualPrototypes []string
-	for _, prototypeOfSource := range prototypesOfSource {
-		if utils.SliceContains(prototypesOfPreprocSource, prototypeOfSource) {
-			actualPrototypes = append(actualPrototypes, prototypeOfSource)
+	actualPrototypes := []*types.Prototype{}
+	for _, prototypeOfPreprocSource := range prototypesOfPreprocSource {
+		if utils.SliceContainsPrototype(prototypesOfSource, prototypeOfPreprocSource) {
+			actualPrototypes = append(actualPrototypes, prototypeOfPreprocSource)
 		}
 	}
 

src/arduino.cc/builder/ctags_parser.go

@@ -31,6 +31,7 @@ package builder
 
 import (
 	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
 	"strconv"
 	"strings"
@@ -83,18 +84,24 @@ func (s *CTagsParser) Run(context map[string]interface{}) error {
 		context[constants.CTX_FIRST_FUNCTION_AT_LINE] = line
 	}
 
-	var prototypes []string
-	for _, tag := range tags {
-		if tag[FIELD_SKIP] != "true" {
-			prototypes = append(prototypes, tag[KIND_PROTOTYPE])
-		}
-	}
+	prototypes := toPrototypes(tags)
 
 	context[s.PrototypesField] = prototypes
 
 	return nil
 }
 
+func toPrototypes(tags []map[string]string) []*types.Prototype {
+	prototypes := []*types.Prototype{}
+	for _, tag := range tags {
+		if tag[FIELD_SKIP] != "true" {
+			ctag := types.Prototype{FunctionName: tag[FIELD_FUNCTION_NAME], Prototype: tag[KIND_PROTOTYPE], Fields: tag}
+			prototypes = append(prototypes, &ctag)
+		}
+	}
+	return prototypes
+}
+
 func addPrototypes(tags []map[string]string) []map[string]string {
 	for _, tag := range tags {
 		addPrototype(tag)

src/arduino.cc/builder/prototypes_adder.go

@@ -31,6 +31,7 @@ package builder
 
 import (
 	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
 	"arduino.cc/builder/utils"
 	"strconv"
 	"strings"
@@ -55,7 +56,7 @@ func (s *PrototypesAdder) Run(context map[string]interface{}) error {
 	if firstFunctionLine > 1 {
 		firstFunctionLine -= context[constants.CTX_LINE_OFFSET].(int)
 	}
-	prototypeSection := composePrototypeSection(firstFunctionLine, context[constants.CTX_PROTOTYPES].([]string))
+	prototypeSection := composePrototypeSection(firstFunctionLine, context[constants.CTX_PROTOTYPES].([]*types.Prototype))
 	context[constants.CTX_PROTOTYPE_SECTION] = prototypeSection
 	source = source[:firstFunctionChar] + prototypeSection + source[firstFunctionChar:]
 
@@ -68,19 +69,27 @@ func (s *PrototypesAdder) Run(context map[string]interface{}) error {
 	return nil
 }
 
-func composePrototypeSection(line int, prototypes []string) string {
+func composePrototypeSection(line int, prototypes []*types.Prototype) string {
 	if len(prototypes) == 0 {
 		return constants.EMPTY_STRING
 	}
 
-	str := strings.Join(prototypes, "\n") + "\n"
+	str := joinPrototypes(prototypes)
 	str += "#line "
 	str += strconv.Itoa(line)
 	str += "\n"
 
 	return str
 }
 
+func joinPrototypes(prototypes []*types.Prototype) string {
+	join := ""
+	for _, proto := range prototypes {
+		join = join + proto.Prototype + "\n"
+	}
+	return join
+}
+
 func composeIncludeArduinoSection() string {
 	str := "#include <Arduino.h>\n"
 	str += "#line 1\n"

src/arduino.cc/builder/test/ctags_parser_test.go

@@ -32,6 +32,7 @@ package test
 import (
 	"arduino.cc/builder"
 	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
 	"github.com/stretchr/testify/require"
 	"io/ioutil"
 	"path/filepath"
@@ -49,14 +50,14 @@ func TestCTagsParserShouldListPrototypes(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 5, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
-	require.Equal(t, "void digitalCommand(YunClient client);", prototypes[2])
-	require.Equal(t, "void analogCommand(YunClient client);", prototypes[3])
-	require.Equal(t, "void modeCommand(YunClient client);", prototypes[4])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
+	require.Equal(t, "void digitalCommand(YunClient client);", prototypes[2].Prototype)
+	require.Equal(t, "void analogCommand(YunClient client);", prototypes[3].Prototype)
+	require.Equal(t, "void modeCommand(YunClient client);", prototypes[4].Prototype)
 }
 
 func TestCTagsParserShouldListTemplates(t *testing.T) {
@@ -70,12 +71,12 @@ func TestCTagsParserShouldListTemplates(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 3, len(prototypes))
-	require.Equal(t, "template <typename T> T minimum (T a, T b);", prototypes[0])
-	require.Equal(t, "void setup();", prototypes[1])
-	require.Equal(t, "void loop();", prototypes[2])
+	require.Equal(t, "template <typename T> T minimum (T a, T b);", prototypes[0].Prototype)
+	require.Equal(t, "void setup();", prototypes[1].Prototype)
+	require.Equal(t, "void loop();", prototypes[2].Prototype)
 }
 
 func TestCTagsParserShouldListTemplates2(t *testing.T) {
@@ -89,13 +90,13 @@ func TestCTagsParserShouldListTemplates2(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 4, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
-	require.Equal(t, "template <class T> int SRAM_writeAnything(int ee, const T& value);", prototypes[2])
-	require.Equal(t, "template <class T> int SRAM_readAnything(int ee, T& value);", prototypes[3])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
+	require.Equal(t, "template <class T> int SRAM_writeAnything(int ee, const T& value);", prototypes[2].Prototype)
+	require.Equal(t, "template <class T> int SRAM_readAnything(int ee, T& value);", prototypes[3].Prototype)
 }
 
 func TestCTagsParserShouldDealWithClasses(t *testing.T) {
@@ -109,7 +110,7 @@ func TestCTagsParserShouldDealWithClasses(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 0, len(prototypes))
 }
@@ -125,12 +126,12 @@ func TestCTagsParserShouldDealWithStructs(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 3, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
-	require.Equal(t, "void dostuff(A_NEW_TYPE * bar);", prototypes[2])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
+	require.Equal(t, "void dostuff(A_NEW_TYPE * bar);", prototypes[2].Prototype)
 }
 
 func TestCTagsParserShouldDealWithMacros(t *testing.T) {
@@ -144,14 +145,14 @@ func TestCTagsParserShouldDealWithMacros(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 5, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
-	require.Equal(t, "void debug();", prototypes[2])
-	require.Equal(t, "void disabledIsDefined();", prototypes[3])
-	require.Equal(t, "int useMyType(MyType type);", prototypes[4])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
+	require.Equal(t, "void debug();", prototypes[2].Prototype)
+	require.Equal(t, "void disabledIsDefined();", prototypes[3].Prototype)
+	require.Equal(t, "int useMyType(MyType type);", prototypes[4].Prototype)
 }
 
 func TestCTagsParserShouldDealFunctionWithDifferentSignatures(t *testing.T) {
@@ -165,10 +166,10 @@ func TestCTagsParserShouldDealFunctionWithDifferentSignatures(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 1, len(prototypes))
-	require.Equal(t, "boolean getBytes( byte addr, int amount );", prototypes[0])
+	require.Equal(t, "boolean getBytes( byte addr, int amount );", prototypes[0].Prototype)
 }
 
 func TestCTagsParserClassMembersAreFilteredOut(t *testing.T) {
@@ -182,11 +183,11 @@ func TestCTagsParserClassMembersAreFilteredOut(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 2, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
 }
 
 func TestCTagsParserStructWithFunctions(t *testing.T) {
@@ -200,11 +201,11 @@ func TestCTagsParserStructWithFunctions(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 2, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
 }
 
 func TestCTagsParserDefaultArguments(t *testing.T) {
@@ -218,9 +219,9 @@ func TestCTagsParserDefaultArguments(t *testing.T) {
 	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
 	ctagsParser.Run(context)
 
-	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+	prototypes := context[constants.CTX_PROTOTYPES].([]*types.Prototype)
 
 	require.Equal(t, 2, len(prototypes))
-	require.Equal(t, "void setup();", prototypes[0])
-	require.Equal(t, "void loop();", prototypes[1])
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
 }

src/arduino.cc/builder/test/prototypes_adder_test.go

@@ -537,7 +537,7 @@ func TestPrototypesAdderSketchWithInlineFunction(t *testing.T) {
 	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("sketch_with_inline_function", "sketch.ino")
 	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
 	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
-	context[constants.CTX_VERBOSE] = true
+	context[constants.CTX_VERBOSE] = false
 
 	commands := []types.Command{
 		&builder.SetupHumanLoggerIfMissing{},
@@ -562,3 +562,43 @@ func TestPrototypesAdderSketchWithInlineFunction(t *testing.T) {
 	require.Equal(t, "#include <Arduino.h>\n#line 1\n", context[constants.CTX_INCLUDE_SECTION].(string))
 	require.Equal(t, "void setup();\nvoid loop();\nshort unsigned int testInt();\nint8_t testInline();\nuint8_t testAttribute();\n#line 1\n", context[constants.CTX_PROTOTYPE_SECTION].(string))
 }
+
+func TestPrototypesAdderSketchWithFunctionSignatureInsideIFDEF(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	_ = SetupBuildPath(t, context)
+	//defer os.RemoveAll(buildPath)
+
+	context[constants.CTX_HARDWARE_FOLDERS] = []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}
+	context[constants.CTX_TOOLS_FOLDERS] = []string{"downloaded_tools"}
+	context[constants.CTX_FQBN] = "arduino:avr:leonardo"
+	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("sketch_with_function_signature_inside_ifdef", "sketch.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+	context[constants.CTX_VERBOSE] = true
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+
+		&builder.ContainerMergeCopySketchFiles{},
+
+		&builder.ContainerFindIncludes{},
+
+		&builder.PrintUsedLibrariesIfVerbose{},
+		&builder.WarnAboutArchIncompatibleLibraries{},
+
+		&builder.ContainerAddPrototypes{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	require.Equal(t, "#include <Arduino.h>\n#line 1\n", context[constants.CTX_INCLUDE_SECTION].(string))
+	require.Equal(t, "void setup();\nvoid loop();\nint8_t adalight();\n#line 1\n", context[constants.CTX_PROTOTYPE_SECTION].(string))
+}

src/arduino.cc/builder/test/sketch_with_function_signature_inside_ifdef/sketch.ino

@@ -0,0 +1,20 @@
+void setup() {}
+
+void loop() {
+  // Visualize leds via Adalight
+  int8_t newData = adalight();
+
+}
+
+
+//#define ADALIGHT_USE_TEMPLATE
+
+#ifdef ADALIGHT_USE_TEMPLATE
+int16_t adalight()
+#else
+int8_t adalight()
+#endif
+{
+  // Flag if the leds got a new frame that should be updated
+  return 0;
+}

src/arduino.cc/builder/types/accessories.go

@@ -52,16 +52,6 @@ func (h *UniqueStringQueue) Empty() bool {
 	return h.Len() == 0
 }
 
-// duplication of utils.SliceContains! Thanks golang! Why? Because you can't have import cycles, so types cannot import from utils because utils already imports from types
-func sliceContains(slice []string, target string) bool {
-	for _, value := range slice {
-		if value == target {
-			return true
-		}
-	}
-	return false
-}
-
 type LibraryResolutionResult struct {
 	Library          *Library
 	NotUsedLibraries []*Library