sketchMapper: added info about preprocessed lines

Author: cmaglie

Diff for: handler/sourcemapper/ino.go

@@ -11,11 +11,12 @@ import (
 
 // InoMapper is a mapping between the .ino sketch and the preprocessed .cpp file
 type InoMapper struct {
-	InoText map[lsp.DocumentURI]*SourceRevision
-	CppText *SourceRevision
-	CppFile lsp.DocumentURI
-	toCpp   map[InoLine]int // Converts File.ino:line -> line
-	toIno   map[int]InoLine // Convers line -> File.ino:line
+	InoText         map[lsp.DocumentURI]*SourceRevision
+	CppText         *SourceRevision
+	CppFile         lsp.DocumentURI
+	toCpp           map[InoLine]int // Converts File.ino:line -> line
+	toIno           map[int]InoLine // Convers line -> File.ino:line
+	cppPreprocessed map[int]InoLine // map of the lines added by the preprocessor: preprocessed line -> File.ino:line
 }
 
 type SourceRevision struct {
@@ -76,8 +77,9 @@ func (s *InoMapper) CppToInoLineOk(targetLine int) (string, int, bool) {
 // CreateInoMapper create a InoMapper from the given target file
 func CreateInoMapper(targetFile io.Reader) *InoMapper {
 	mapper := &InoMapper{
-		toCpp: map[InoLine]int{},
-		toIno: map[int]InoLine{},
+		toCpp:           map[InoLine]int{},
+		toIno:           map[int]InoLine{},
+		cppPreprocessed: map[int]InoLine{},
 	}
 
 	sourceFile := ""
@@ -94,17 +96,24 @@ func CreateInoMapper(targetFile io.Reader) *InoMapper {
 			}
 			sourceFile = unquoteCppString(tokens[2])
 		} else if sourceFile != "" {
-			mapper.toCpp[InoLine{sourceFile, sourceLine}] = targetLine
-			mapper.toIno[targetLine] = InoLine{sourceFile, sourceLine}
+			mapper.mapLine(sourceFile, sourceLine, targetLine)
 			sourceLine++
 		}
 		targetLine++
 	}
-	mapper.toCpp[InoLine{sourceFile, sourceLine}] = targetLine
-	mapper.toIno[targetLine] = InoLine{sourceFile, sourceLine}
+	mapper.mapLine(sourceFile, sourceLine, targetLine)
 	return mapper
 }
 
+func (s *InoMapper) mapLine(sourceFile string, sourceLine, targetLine int) {
+	inoLine := InoLine{sourceFile, sourceLine}
+	if line, ok := s.toCpp[inoLine]; ok {
+		s.cppPreprocessed[line] = inoLine
+	}
+	s.toCpp[inoLine] = targetLine
+	s.toIno[targetLine] = inoLine
+}
+
 func unquoteCppString(str string) string {
 	if len(str) >= 2 && strings.HasPrefix(str, `"`) && strings.HasSuffix(str, `"`) {
 		str = strings.TrimSuffix(str, `"`)[1:]

Diff for: handler/sourcemapper/ino_test.go

@@ -43,8 +43,8 @@ void loop() {
 	}, sourceMap.toCpp)
 	require.EqualValues(t, map[int]InoLine{
 		3:  {"sketch_july2a.ino", 0},
-		5:  {"sketch_july2a.ino", 1},
-		7:  {"sketch_july2a.ino", 6},
+		5:  {"sketch_july2a.ino", 1}, // setup
+		7:  {"sketch_july2a.ino", 6}, // loop
 		9:  {"sketch_july2a.ino", 1},
 		10: {"sketch_july2a.ino", 2},
 		11: {"sketch_july2a.ino", 3},
@@ -56,6 +56,10 @@ void loop() {
 		17: {"sketch_july2a.ino", 9},
 		18: {"sketch_july2a.ino", 10},
 	}, sourceMap.toIno)
+	require.EqualValues(t, map[int]InoLine{
+		5: {"sketch_july2a.ino", 1}, // setup
+		7: {"sketch_july2a.ino", 6}, // loop
+	}, sourceMap.cppPreprocessed)
 }
 
 func TestCreateMultifileSourceMap(t *testing.T) {
@@ -105,10 +109,6 @@ void secondFunction() {
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 0}:  2,
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 1}:  3,
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 2}:  4,
-		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3}:  6,
-		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 8}:  8,
-		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 22}: 10,
-		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 1}:     12,
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3}:  14,
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 4}:  15,
 		{"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 5}:  16,
@@ -141,10 +141,10 @@ void secondFunction() {
 		2:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 0},
 		3:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 1},
 		4:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 2},
-		6:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3},
-		8:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 8},
-		10: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 22},
-		12: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 1},
+		6:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3},  // setup
+		8:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 8},  // loop
+		10: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 22}, // vino
+		12: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 1},     // secondFunction
 		14: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3},
 		15: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 4},
 		16: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 5},
@@ -173,6 +173,12 @@ void secondFunction() {
 		40: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 3},
 		41: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 4},
 	})
+	require.EqualValues(t, map[int]InoLine{
+		6:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 3},  // setup
+		8:  {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 8},  // loop
+		10: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/Prova_Spazio.ino", 22}, // vino
+		12: {"/home/megabug/Workspace/sketchbook-cores-beta/Prova_Spazio/SecondTab.ino", 1},     // secondFunction
+	}, sourceMap.cppPreprocessed)
 }
 
 // func TestUpdateSourceMaps1(t *testing.T) {