Moved CTags preprocess subroutine in proper place

Author: cmaglie

arduino/builder/preprocessor/ctags.go

@@ -18,17 +18,116 @@ package preprocessor
 import (
 	"context"
 	"fmt"
+	"strconv"
 	"strings"
 
+	"github.com/arduino/arduino-cli/arduino/builder/preprocessor/ctags"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/executils"
 	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/arduino-cli/legacy/builder/utils"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
 )
 
 var tr = i18n.Tr
 
+// DebugPreprocessor when set to true the CTags preprocessor will output debugging info to stdout
+// this is useful for unit-testing to provide more infos
+var DebugPreprocessor bool
+
+// CTags performs a run of ctags on the given source file. Returns the ctags output and the stderr contents.
+func CTags(sourceFile *paths.Path, targetFile *paths.Path, sketch *sketch.Sketch, lineOffset int, buildProperties *properties.Map) ([]byte, error) {
+	ctagsOutput, ctagsStdErr, err := RunCTags(sourceFile, buildProperties)
+	if err != nil {
+		return ctagsStdErr, err
+	}
+
+	// func PrototypesAdder(sketch *sketch.Sketch, source string, ctagsStdout []byte, lineOffset int) string {
+	parser := &ctags.CTagsParser{}
+	prototypes, firstFunctionLine := parser.Parse(ctagsOutput, sketch.MainFile)
+	if firstFunctionLine == -1 {
+		firstFunctionLine = 0
+	}
+
+	var source string
+	if sourceData, err := targetFile.ReadFile(); err != nil {
+		return nil, err
+	} else {
+		source = string(sourceData)
+	}
+	source = strings.Replace(source, "\r\n", "\n", -1)
+	source = strings.Replace(source, "\r", "\n", -1)
+	sourceRows := strings.Split(source, "\n")
+	if isFirstFunctionOutsideOfSource(firstFunctionLine, sourceRows) {
+		return nil, nil
+	}
+
+	insertionLine := firstFunctionLine + lineOffset - 1
+	firstFunctionChar := len(strings.Join(sourceRows[:insertionLine], "\n")) + 1
+	prototypeSection := composePrototypeSection(firstFunctionLine, prototypes)
+	preprocessedSource := source[:firstFunctionChar] + prototypeSection + source[firstFunctionChar:]
+
+	if DebugPreprocessor {
+		fmt.Println("#PREPROCESSED SOURCE")
+		prototypesRows := strings.Split(prototypeSection, "\n")
+		prototypesRows = prototypesRows[:len(prototypesRows)-1]
+		for i := 0; i < len(sourceRows)+len(prototypesRows); i++ {
+			if i < insertionLine {
+				fmt.Printf("   |%s\n", sourceRows[i])
+			} else if i < insertionLine+len(prototypesRows) {
+				fmt.Printf("PRO|%s\n", prototypesRows[i-insertionLine])
+			} else {
+				fmt.Printf("   |%s\n", sourceRows[i-len(prototypesRows)])
+			}
+		}
+		fmt.Println("#END OF PREPROCESSED SOURCE")
+	}
+
+	err = targetFile.WriteFile([]byte(preprocessedSource))
+	return ctagsStdErr, err
+}
+
+func composePrototypeSection(line int, prototypes []*ctags.Prototype) string {
+	if len(prototypes) == 0 {
+		return ""
+	}
+
+	str := joinPrototypes(prototypes)
+	str += "\n#line "
+	str += strconv.Itoa(line)
+	str += " " + utils.QuoteCppString(prototypes[0].File)
+	str += "\n"
+
+	return str
+}
+
+func joinPrototypes(prototypes []*ctags.Prototype) string {
+	prototypesSlice := []string{}
+	for _, proto := range prototypes {
+		if signatureContainsaDefaultArg(proto) {
+			continue
+		}
+		prototypesSlice = append(prototypesSlice, "#line "+strconv.Itoa(proto.Line)+" "+utils.QuoteCppString(proto.File))
+		prototypeParts := []string{}
+		if proto.Modifiers != "" {
+			prototypeParts = append(prototypeParts, proto.Modifiers)
+		}
+		prototypeParts = append(prototypeParts, proto.Prototype)
+		prototypesSlice = append(prototypesSlice, strings.Join(prototypeParts, " "))
+	}
+	return strings.Join(prototypesSlice, "\n")
+}
+
+func signatureContainsaDefaultArg(proto *ctags.Prototype) bool {
+	return strings.Contains(proto.Prototype, "=")
+}
+
+func isFirstFunctionOutsideOfSource(firstFunctionLine int, sourceRows []string) bool {
+	return firstFunctionLine > len(sourceRows)-1
+}
+
 // RunCTags performs a run of ctags on the given source file. Returns the ctags output and the stderr contents.
 func RunCTags(sourceFile *paths.Path, buildProperties *properties.Map) ([]byte, []byte, error) {
 	ctagsBuildProperties := properties.NewMap()

legacy/builder/container_add_prototypes.go

@@ -70,19 +70,21 @@ func PreprocessSketchWithCtags(ctx *types.Context) error {
 		return err
 	}
 
-	ctagsStdout, ctagsStderr, err := preprocessor.RunCTags(targetFilePath, ctx.BuildProperties)
+	sketchCpp := ctx.SketchBuildPath.Join(fmt.Sprintf("%s.cpp", ctx.Sketch.MainFile.Base()))
+	ctagsStderr, err := preprocessor.CTags(targetFilePath, sketchCpp, ctx.Sketch, ctx.LineOffset, ctx.BuildProperties)
 	if ctx.Verbose {
 		ctx.WriteStderr(ctagsStderr)
 	}
 	if err != nil {
 		return err
 	}
-	ctx.SketchSourceAfterArduinoPreprocessing = PrototypesAdder(ctx.Sketch, ctx.SketchSourceMerged, ctagsStdout, ctx.LineOffset)
 
-	if err := bldr.SketchSaveItemCpp(ctx.Sketch.MainFile, []byte(ctx.SketchSourceAfterArduinoPreprocessing), ctx.SketchBuildPath); err != nil {
-		return errors.WithStack(err)
+	// Save preprocesssed source in context
+	if d, err := sketchCpp.ReadFile(); err != nil {
+		return err
+	} else {
+		ctx.SketchSourceAfterArduinoPreprocessing = string(d)
 	}
-
 	return nil
 }
 

legacy/builder/preprocess_sketch.go

@@ -88,5 +88,5 @@ func PreprocessSketchWithArduinoPreprocessor(ctx *types.Context) error {
 
 	//fmt.Printf("PREPROCESSOR OUTPUT:\n%s\n", output)
 	ctx.SketchSourceAfterArduinoPreprocessing = string(result)
-	return bldr.SketchSaveItemCpp(ctx.Sketch.MainFile, []byte(ctx.SketchSourceAfterArduinoPreprocessing), ctx.SketchBuildPath)
+	return bldr.SketchSaveItemCpp(ctx.Sketch.MainFile, result, ctx.SketchBuildPath)
 }

legacy/builder/prototypes_adder.go

@@ -20,6 +20,7 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/arduino/arduino-cli/arduino/builder/preprocessor"
 	"github.com/arduino/arduino-cli/legacy/builder"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	paths "github.com/arduino/go-paths-helper"
@@ -202,7 +203,7 @@ func TestTryBuild042(t *testing.T) {
 }
 
 func makeDefaultContext() *types.Context {
-	builder.DebugPreprocessor = true
+	preprocessor.DebugPreprocessor = true
 	return &types.Context{
 		HardwareDirs:         paths.NewPathList(filepath.Join("..", "hardware"), "downloaded_hardware", "downloaded_board_manager_stuff"),
 		BuiltInToolsDirs:     paths.NewPathList("downloaded_tools"),