Added code-completion support

Author: cmaglie

arduino-builder/main.go

@@ -54,6 +54,7 @@ const VERSION = "1.3.25"
 const FLAG_ACTION_COMPILE = "compile"
 const FLAG_ACTION_PREPROCESS = "preprocess"
 const FLAG_ACTION_DUMP_PREFS = "dump-prefs"
+const FLAG_ACTION_CODE_COMPLETE_AT = "code-complete-at"
 const FLAG_BUILD_OPTIONS_FILE = "build-options-file"
 const FLAG_HARDWARE = "hardware"
 const FLAG_TOOLS = "tools"
@@ -118,6 +119,7 @@ func (h *propertiesFlag) Set(value string) error {
 var compileFlag *bool
 var preprocessFlag *bool
 var dumpPrefsFlag *bool
+var codeCompleteAtFlag *string
 var buildOptionsFileFlag *string
 var hardwareFoldersFlag foldersFlag
 var toolsFoldersFlag foldersFlag
@@ -141,6 +143,7 @@ func init() {
 	compileFlag = flag.Bool(FLAG_ACTION_COMPILE, false, "compiles the given sketch")
 	preprocessFlag = flag.Bool(FLAG_ACTION_PREPROCESS, false, "preprocess the given sketch")
 	dumpPrefsFlag = flag.Bool(FLAG_ACTION_DUMP_PREFS, false, "dumps build properties used when compiling")
+	codeCompleteAtFlag = flag.String(FLAG_ACTION_CODE_COMPLETE_AT, "", "output code completions for sketch at a specific location. Location format is \"file:line:col\"")
 	buildOptionsFileFlag = flag.String(FLAG_BUILD_OPTIONS_FILE, "", "Instead of specifying --"+FLAG_HARDWARE+", --"+FLAG_TOOLS+" etc every time, you can load all such options from a file")
 	flag.Var(&hardwareFoldersFlag, FLAG_HARDWARE, "Specify a 'hardware' folder. Can be added multiple times for specifying multiple 'hardware' folders")
 	flag.Var(&toolsFoldersFlag, FLAG_TOOLS, "Specify a 'tools' folder. Can be added multiple times for specifying multiple 'tools' folders")
@@ -330,7 +333,8 @@ func main() {
 
 	if *dumpPrefsFlag {
 		err = builder.RunParseHardwareAndDumpBuildProperties(ctx)
-	} else if *preprocessFlag {
+	} else if *preprocessFlag || *codeCompleteAtFlag != "" {
+		ctx.CodeCompleteAt = *codeCompleteAtFlag
 		err = builder.RunPreprocess(ctx)
 	} else {
 		if flag.NArg() == 0 {

hardware/platform.txt

@@ -3,7 +3,7 @@
 
 tools.arduino-preprocessor.path={runtime.tools.arduino-preprocessor.path}
 tools.arduino-preprocessor.cmd.path={path}/bin/arduino-preprocessor
-tools.arduino-preprocessor.pattern="{cmd.path}" "{source_file}" -- -std=gnu++11
+tools.arduino-preprocessor.pattern="{cmd.path}" "{source_file}" "{codecomplete}" -- -std=gnu++11
 
 # ctags
 # ------------------------------

src/arduino.cc/builder/preprocess_sketch.go

@@ -33,8 +33,6 @@ import (
 	"fmt"
 	"path/filepath"
 
-	"io/ioutil"
-
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
@@ -48,7 +46,12 @@ func (s *PreprocessSketch) Run(ctx *types.Context) error {
 	commands := []types.Command{
 		&GCCPreprocRunner{SourceFilePath: sourceFile, TargetFileName: constants.FILE_CTAGS_TARGET_FOR_GCC_MINUS_E, Includes: ctx.IncludeFolders},
 		&ArduinoPreprocessorRunner{},
-		&SketchSaver{},
+	}
+
+	if ctx.CodeCompleteAt != "" {
+		commands = append(commands, &OutputCodeCompletions{})
+	} else {
+		commands = append(commands, &SketchSaver{})
 	}
 
 	for _, command := range commands {
@@ -73,6 +76,11 @@ func (s *ArduinoPreprocessorRunner) Run(ctx *types.Context) error {
 	toolProps := buildProperties.SubTree("tools").SubTree("arduino-preprocessor")
 	properties.Merge(toolProps)
 	properties[constants.BUILD_PROPERTIES_SOURCE_FILE] = targetFilePath
+	if ctx.CodeCompleteAt != "" {
+		properties["codecomplete"] = "-output-code-completions=" + ctx.CodeCompleteAt
+	} else {
+		properties["codecomplete"] = ""
+	}
 
 	pattern := properties[constants.BUILD_PROPERTIES_PATTERN]
 	if pattern == constants.EMPTY_STRING {
@@ -90,20 +98,23 @@ func (s *ArduinoPreprocessorRunner) Run(ctx *types.Context) error {
 		fmt.Println(commandLine)
 	}
 
-	sourceBytes, err := command.Output()
+	buf, err := command.Output()
 	if err != nil {
 		return i18n.WrapError(err)
 	}
-
-	ctx.Source = string(sourceBytes)
-	if ctx.Source == "" {
-		// If the output is empty the original sketch may pass through
-		buf, err := ioutil.ReadFile(targetFilePath)
-		if err != nil {
-			return i18n.WrapError(err)
-		}
-		ctx.Source = string(buf)
+	output := string(buf)
+	//fmt.Printf("PREPROCESSOR OUTPUT:\n%s\n", output)
+	if ctx.CodeCompleteAt != "" {
+		ctx.CodeCompletions = output
+	} else {
+		ctx.Source = output
 	}
-	//fmt.Printf("PREPROCESSOR OUTPUT:\n%s\n", ctx.Source)
+	return nil
+}
+
+type OutputCodeCompletions struct{}
+
+func (s *OutputCodeCompletions) Run(ctx *types.Context) error {
+	fmt.Println(ctx.CodeCompletions)
 	return nil
 }

types/context.go

@@ -18,6 +18,7 @@ type Context struct {
 	SketchLocation          string
 	ArduinoAPIVersion       string
 	FQBN                    string
+	CodeCompleteAt          string
 
 	// Build options are serialized here
 	BuildOptionsJson         string
@@ -53,6 +54,7 @@ type Context struct {
 	Sketch          *Sketch
 	Source          string
 	SourceGccMinusE string
+	CodeCompletions string
 
 	WarningsLevel string