Skipping prototype generation for function with default args. Fixes arduino#23

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

Author: Federico Fissore

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

@@ -44,6 +44,7 @@ const FIELD_CODE = "code"
 const FIELD_FUNCTION_NAME = "functionName"
 const FIELD_CLASS = "class"
 const FIELD_STRUCT = "struct"
+const FIELD_SKIP = "skipMe"
 
 const KIND_PROTOTYPE = "prototype"
 
@@ -69,6 +70,7 @@ func (s *CTagsParser) Run(context map[string]interface{}) error {
 	tags = filterOutUnknownTags(tags)
 	tags = filterOutTagsWithField(tags, FIELD_CLASS)
 	tags = filterOutTagsWithField(tags, FIELD_STRUCT)
+	tags = markTagsWithFunctionWithDefaultArgs(tags)
 	tags = addPrototypes(tags)
 	tags = removeDefinedProtypes(tags)
 	tags = removeDuplicate(tags)
@@ -83,7 +85,9 @@ func (s *CTagsParser) Run(context map[string]interface{}) error {
 
 	var prototypes []string
 	for _, tag := range tags {
-		prototypes = append(prototypes, tag[KIND_PROTOTYPE])
+		if tag[FIELD_SKIP] != "true" {
+			prototypes = append(prototypes, tag[KIND_PROTOTYPE])
+		}
 	}
 
 	context[s.PrototypesField] = prototypes
@@ -142,6 +146,13 @@ func removeDuplicate(tags []map[string]string) []map[string]string {
 	return newTags
 }
 
+func markTagsWithFunctionWithDefaultArgs(tags []map[string]string) []map[string]string {
+	for _, tag := range tags {
+		tag[FIELD_SKIP] = strconv.FormatBool(strings.Contains(tag[FIELD_SIGNATURE], "="))
+	}
+	return tags
+}
+
 func filterOutTagsWithField(tags []map[string]string, field string) []map[string]string {
 	var newTags []map[string]string
 	for _, tag := range tags {

Diff for: src/arduino.cc/builder/test/ctags_output/TestCTagsParserDefaultArguments.txt

@@ -0,0 +1,3 @@
+test	/tmp/test179252494/preproc/ctags_target.cpp	/^void test(int x = 1) {$/;"	kind:function	line:2	signature:(int x = 1)	returntype:void
+setup	/tmp/test179252494/preproc/ctags_target.cpp	/^void setup() {$/;"	kind:function	line:5	signature:()	returntype:void
+loop	/tmp/test179252494/preproc/ctags_target.cpp	/^void loop() {$/;"	kind:function	line:8	signature:()	returntype:void

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

@@ -206,3 +206,21 @@ func TestCTagsParserStructWithFunctions(t *testing.T) {
 	require.Equal(t, "void setup();", prototypes[0])
 	require.Equal(t, "void loop();", prototypes[1])
 }
+
+func TestCTagsParserDefaultArguments(t *testing.T) {
+	context := make(map[string]interface{})
+
+	bytes, err := ioutil.ReadFile(filepath.Join("ctags_output", "TestCTagsParserDefaultArguments.txt"))
+	NoError(t, err)
+
+	context[constants.CTX_CTAGS_OUTPUT] = string(bytes)
+
+	ctagsParser := builder.CTagsParser{PrototypesField: constants.CTX_PROTOTYPES}
+	ctagsParser.Run(context)
+
+	prototypes := context[constants.CTX_PROTOTYPES].([]string)
+
+	require.Equal(t, 2, len(prototypes))
+	require.Equal(t, "void setup();", prototypes[0])
+	require.Equal(t, "void loop();", prototypes[1])
+}

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

@@ -482,3 +482,43 @@ func TestPrototypesAdderSketchNoFunctions(t *testing.T) {
 	require.Nil(t, context[constants.CTX_INCLUDE_SECTION])
 	require.Nil(t, context[constants.CTX_PROTOTYPE_SECTION])
 }
+
+func TestPrototypesAdderSketchWithDefaultArgs(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	buildPath := 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_default_args", "sketch.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+	context[constants.CTX_VERBOSE] = false
+
+	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();\n#line 1\n", context[constants.CTX_PROTOTYPE_SECTION].(string))
+}

Diff for: src/arduino.cc/builder/test/sketch_with_default_args/sketch.ino

@@ -0,0 +1,8 @@
+void test(int x = 1) {
+}
+
+void setup() {
+}
+
+void loop() {
+}