CTags is now run only once, using the file it reports to filter prototypes

which belong to the sketch. Fixes #52

Signed-off-by: Federico Fissore <f.fissore@arduino.cc>

Author: Federico Fissore

src/arduino.cc/builder/collect_ctags_from_sketch_files.go

@@ -0,0 +1,63 @@
+/*
+ * 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/types"
+	"arduino.cc/builder/utils"
+)
+
+type CollectCTagsFromSketchFiles struct{}
+
+func (s *CollectCTagsFromSketchFiles) Run(context map[string]interface{}) error {
+	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
+	sketchFileNames := collectSketchFileNamesFrom(sketch)
+
+	ctags := context[constants.CTX_CTAGS_OF_PREPROC_SOURCE].([]map[string]string)
+	ctagsOfSketch := []map[string]string{}
+	for _, ctag := range ctags {
+		if utils.SliceContains(sketchFileNames, ctag[FIELD_FILENAME]) {
+			ctagsOfSketch = append(ctagsOfSketch, ctag)
+		}
+	}
+
+	context[constants.CTX_COLLECTED_CTAGS] = ctagsOfSketch
+
+	return nil
+}
+
+func collectSketchFileNamesFrom(sketch *types.Sketch) []string {
+	fileNames := []string{sketch.MainFile.Name}
+	for _, file := range sketch.OtherSketchFiles {
+		fileNames = append(fileNames, file.Name)
+	}
+	return fileNames
+}

src/arduino.cc/builder/container_add_prototypes.go

@@ -44,10 +44,7 @@ func (s *ContainerAddPrototypes) Run(context map[string]interface{}) error {
 		&CTagsTargetFileSaver{SourceField: constants.CTX_GCC_MINUS_E_SOURCE, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E},
 		&CTagsRunner{},
 		&CTagsParser{CTagsField: constants.CTX_CTAGS_OF_PREPROC_SOURCE},
-		&CTagsTargetFileSaver{SourceField: constants.CTX_SOURCE, TargetFileName: constants.FILE_CTAGS_TARGET},
-		&CTagsRunner{},
-		&CTagsParser{CTagsField: constants.CTX_CTAGS_OF_SOURCE},
-		&ComparePrototypesFromSourceAndPreprocSource{},
+		&CollectCTagsFromSketchFiles{},
 		&CTagsToPrototypes{},
 		&PrototypesAdder{},
 		&SketchSaver{},

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

@@ -62,8 +62,6 @@ func TestBuilderEmptySketch(t *testing.T) {
 
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "sketch.ino.cpp.o"))
@@ -97,8 +95,6 @@ func TestBuilderBridge(t *testing.T) {
 
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "Bridge.ino.cpp.o"))
@@ -133,8 +129,6 @@ func TestBuilderSketchWithConfig(t *testing.T) {
 
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "sketch_with_config.ino.cpp.o"))
@@ -173,8 +167,6 @@ func TestBuilderBridgeTwice(t *testing.T) {
 
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "Bridge.ino.cpp.o"))
@@ -214,8 +206,6 @@ func TestBuilderBridgeSAM(t *testing.T) {
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "avr", "dtostrf.c.d"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "Bridge.ino.cpp.o"))
@@ -250,8 +240,6 @@ func TestBuilderBridgeRedBearLab(t *testing.T) {
 
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_CORE, "HardwareSerial.cpp.o"))
 	NoError(t, err)
-	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET))
-	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_PREPROC, constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E))
 	NoError(t, err)
 	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_SKETCH, "Bridge.ino.cpp.o"))