Updating ctags and ensuring namespaces are ignored when generating prototypes.

Fixes #44

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

Author: Federico Fissore

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

@@ -45,13 +45,14 @@ const FIELD_CODE = "code"
 const FIELD_FUNCTION_NAME = "functionName"
 const FIELD_CLASS = "class"
 const FIELD_STRUCT = "struct"
+const FIELD_NAMESPACE = "namespace"
 const FIELD_SKIP = "skipMe"
 
 const KIND_PROTOTYPE = "prototype"
 
 const TEMPLATE = "template"
 
-var FIELDS = map[string]bool{"kind": true, "line": true, "typeref": true, "signature": true, "returntype": true, "class": true, "struct": true}
+var FIELDS = map[string]bool{"kind": true, "line": true, "typeref": true, "signature": true, "returntype": true, "class": true, "struct": true, "namespace": true}
 var KNOWN_TAG_KINDS = map[string]bool{"prototype": true, "function": true}
 
 type CTagsParser struct {
@@ -71,6 +72,7 @@ func (s *CTagsParser) Run(context map[string]interface{}) error {
 	tags = filterOutUnknownTags(tags)
 	tags = filterOutTagsWithField(tags, FIELD_CLASS)
 	tags = filterOutTagsWithField(tags, FIELD_STRUCT)
+	tags = filterOutTagsWithField(tags, FIELD_NAMESPACE)
 	tags = skipTagsWhere(tags, signatureContainsDefaultArg)
 	tags = addPrototypes(tags)
 	tags = removeDefinedProtypes(tags)

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

@@ -0,0 +1,4 @@
+value	/tmp/test030883150/preproc/ctags_target.cpp	/^    int value() {$/;"	kind:function	line:3	namespace:Test	signature:()	returntype:int
+setup	/tmp/test030883150/preproc/ctags_target.cpp	/^void setup() {}$/;"	kind:function	line:8	signature:()	returntype:void
+loop	/tmp/test030883150/preproc/ctags_target.cpp	/^void loop() {}$/;"	kind:function	line:9	signature:()	returntype:void
+

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

@@ -225,3 +225,21 @@ func TestCTagsParserDefaultArguments(t *testing.T) {
 	require.Equal(t, "void setup();", prototypes[0].Prototype)
 	require.Equal(t, "void loop();", prototypes[1].Prototype)
 }
+
+func TestCTagsParserNamespace(t *testing.T) {
+	context := make(map[string]interface{})
+
+	bytes, err := ioutil.ReadFile(filepath.Join("ctags_output", "TestCTagsParserNamespace.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].([]*types.Prototype)
+
+	require.Equal(t, 2, len(prototypes))
+	require.Equal(t, "void setup();", prototypes[0].Prototype)
+	require.Equal(t, "void loop();", prototypes[1].Prototype)
+}

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

@@ -181,3 +181,48 @@ func TestCTagsRunnerSketchWithTypename(t *testing.T) {
 
 	require.Equal(t, expectedOutput, strings.Replace(context[constants.CTX_CTAGS_OUTPUT].(string), "\r\n", "\n", -1))
 }
+
+func TestCTagsRunnerSketchWithNamespace(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_namespace", "sketch.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_BUILT_IN_LIBRARIES_FOLDERS] = []string{"downloaded_libraries"}
+	context[constants.CTX_OTHER_LIBRARIES_FOLDERS] = []string{"libraries"}
+	context[constants.CTX_VERBOSE] = true
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+
+		&builder.ContainerMergeCopySketchFiles{},
+
+		&builder.ContainerFindIncludes{},
+
+		&builder.PrintUsedLibrariesIfVerbose{},
+		&builder.WarnAboutArchIncompatibleLibraries{},
+		&builder.CTagsTargetFileSaver{SourceField: constants.CTX_SOURCE},
+		&builder.CTagsRunner{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	ctagsTempFileName := context[constants.CTX_CTAGS_TEMP_FILE_NAME].(string)
+	expectedOutput := "value\t" + ctagsTempFileName + "\t/^\tint value() {$/;\"\tkind:function\tline:3\tnamespace:Test\tsignature:()\treturntype:int\n" +
+		"setup\t" + ctagsTempFileName + "\t/^void setup() {}$/;\"\tkind:function\tline:8\tsignature:()\treturntype:void\n" +
+		"loop\t" + ctagsTempFileName + "\t/^void loop() {}$/;\"\tkind:function\tline:9\tsignature:()\treturntype:void\n"
+
+	require.Equal(t, expectedOutput, strings.Replace(context[constants.CTX_CTAGS_OUTPUT].(string), "\r\n", "\n", -1))
+}

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

@@ -108,12 +108,12 @@ func DownloadCoresAndToolsAndLibraries(t *testing.T) {
 			OsUrl{Os: "i686-mingw32", Url: "http://downloads.arduino.cc/tools/coan-5.2-i686-mingw32.zip"},
 			OsUrl{Os: "x86_64-apple-darwin", Url: "http://downloads.arduino.cc/tools/coan-5.2-x86_64-apple-darwin.zip"},
 		}},
-		Tool{Name: "ctags", Version: "5.8-arduino2",
+		Tool{Name: "ctags", Version: "5.8-arduino3",
 			OsUrls: []OsUrl{
-				OsUrl{Os: "i686-pc-linux-gnu", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino2-i686-pc-linux-gnu.tar.bz2"},
-				OsUrl{Os: "x86_64-pc-linux-gnu", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino2-x86_64-pc-linux-gnu.tar.bz2"},
-				OsUrl{Os: "i686-mingw32", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino2-i686-mingw32.zip"},
-				OsUrl{Os: "x86_64-apple-darwin", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino2-x86_64-apple-darwin.zip"},
+				OsUrl{Os: "i686-pc-linux-gnu", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino3-i686-pc-linux-gnu.tar.bz2"},
+				OsUrl{Os: "x86_64-pc-linux-gnu", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino3-x86_64-pc-linux-gnu.tar.bz2"},
+				OsUrl{Os: "i686-mingw32", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino3-i686-mingw32.zip"},
+				OsUrl{Os: "x86_64-apple-darwin", Url: "http://downloads.arduino.cc/tools/ctags-5.8-arduino3-x86_64-apple-darwin.zip"},
 			}},
 	}
 

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

@@ -0,0 +1,8 @@
+namespace Test {
+	int value() {
+		return 42;
+	}
+	int ciao = 24;
+}
+void setup() {}
+void loop() {}