Adding platform includes to the first gcc calls, allowing to compile a sketch

that includes Arduino.h
Fixes #33

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

Author: Federico Fissore

src/arduino.cc/builder/container_find_includes.go

@@ -39,6 +39,11 @@ import (
 type ContainerFindIncludes struct{}
 
 func (s *ContainerFindIncludes) Run(context map[string]interface{}) error {
+	err := runCommand(context, &IncludesToIncludeFolders{})
+	if err != nil {
+		return utils.WrapError(err)
+	}
+
 	sketch := context[constants.CTX_SKETCH].(*types.Sketch)
 	sketchBuildPath := context[constants.CTX_SKETCH_BUILD_PATH].(string)
 	wheelSpins := context[constants.CTX_LIBRARY_DISCOVERY_RECURSION_DEPTH].(int)
@@ -50,8 +55,7 @@ func (s *ContainerFindIncludes) Run(context map[string]interface{}) error {
 		}
 
 		for _, command := range commands {
-			PrintRingNameIfDebug(context, command)
-			err := command.Run(context)
+			err := runCommand(context, command)
 			if err != nil {
 				return utils.WrapError(err)
 			}
@@ -66,8 +70,7 @@ func (s *ContainerFindIncludes) Run(context map[string]interface{}) error {
 		}
 	}
 
-	command := &CollectAllSourceFilesFromFoldersWithSources{}
-	err := command.Run(context)
+	err = runCommand(context, &CollectAllSourceFilesFromFoldersWithSources{})
 	if err != nil {
 		return utils.WrapError(err)
 	}
@@ -83,8 +86,7 @@ func (s *ContainerFindIncludes) Run(context map[string]interface{}) error {
 		}
 
 		for _, command := range commands {
-			PrintRingNameIfDebug(context, command)
-			err := command.Run(context)
+			err := runCommand(context, command)
 			if err != nil {
 				return utils.WrapError(err)
 			}
@@ -93,3 +95,12 @@ func (s *ContainerFindIncludes) Run(context map[string]interface{}) error {
 
 	return nil
 }
+
+func runCommand(context map[string]interface{}, command types.Command) error {
+	PrintRingNameIfDebug(context, command)
+	err := command.Run(context)
+	if err != nil {
+		return utils.WrapError(err)
+	}
+	return nil
+}

src/arduino.cc/builder/dump_context.go

@@ -0,0 +1,50 @@
+/*
+ * 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/utils"
+	"fmt"
+	"sort"
+)
+
+type DumpContext struct{}
+
+func (s *DumpContext) Run(context map[string]interface{}) error {
+	keys := utils.KeysOfMapOfStringInterface(context)
+	sort.Strings(keys)
+
+	for _, key := range keys {
+		fmt.Print(key + "=")
+		fmt.Println(context[key])
+	}
+
+	return nil
+}

src/arduino.cc/builder/includes_to_include_folders.go

@@ -40,11 +40,15 @@ import (
 type IncludesToIncludeFolders struct{}
 
 func (s *IncludesToIncludeFolders) Run(context map[string]interface{}) error {
-	if !utils.MapHas(context, constants.CTX_LIBRARIES) {
-		return nil
+	includes := []string{}
+	if utils.MapHas(context, constants.CTX_INCLUDES) {
+		includes = context[constants.CTX_INCLUDES].([]string)
 	}
-	includes := context[constants.CTX_INCLUDES].([]string)
-	headerToLibraries := context[constants.CTX_HEADER_TO_LIBRARIES].(map[string][]*types.Library)
+	headerToLibraries := make(map[string][]*types.Library)
+	if utils.MapHas(context, constants.CTX_HEADER_TO_LIBRARIES) {
+		headerToLibraries = context[constants.CTX_HEADER_TO_LIBRARIES].(map[string][]*types.Library)
+	}
+
 	platform := context[constants.CTX_TARGET_PLATFORM].(*types.Platform)
 	actualPlatform := context[constants.CTX_ACTUAL_PLATFORM].(*types.Platform)
 	libraryResolutionResults := context[constants.CTX_LIBRARY_RESOLUTION_RESULTS].(map[string]types.LibraryResolutionResult)

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

@@ -603,3 +603,43 @@ func TestPrototypesAdderSketchWithFunctionSignatureInsideIFDEF(t *testing.T) {
 	require.Equal(t, "#include <Arduino.h>\n#line 1\n", context[constants.CTX_INCLUDE_SECTION].(string))
 	require.Equal(t, "void setup();\nvoid loop();\nint8_t adalight();\n#line 1\n", context[constants.CTX_PROTOTYPE_SECTION].(string))
 }
+
+func TestPrototypesAdderSketchWithUSBCON(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_usbcon", "sketch.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+	context[constants.CTX_VERBOSE] = true
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+
+		&builder.ContainerMergeCopySketchFiles{},
+
+		&builder.ContainerFindIncludes{},
+
+		&builder.PrintUsedLibrariesIfVerbose{},
+		&builder.WarnAboutArchIncompatibleLibraries{},
+
+		&builder.ContainerAddPrototypes{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	require.Equal(t, "#include <Arduino.h>\n#line 1\n", context[constants.CTX_INCLUDE_SECTION].(string))
+	require.Equal(t, "void ciao();\nvoid setup();\nvoid loop();\n#line 3\n", context[constants.CTX_PROTOTYPE_SECTION].(string))
+}

src/arduino.cc/builder/test/sketch_with_usbcon/sketch.ino

@@ -0,0 +1,16 @@
+#include <Arduino.h>
+#if defined(USBCON)
+void ciao() {
+
+}
+#endif
+
+void setup() {
+  // put your setup code here, to run once:
+
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}

src/arduino.cc/builder/utils/utils.go

@@ -44,6 +44,14 @@ import (
 	"strings"
 )
 
+func KeysOfMapOfStringInterface(input map[string]interface{}) []string {
+	var keys []string
+	for key, _ := range input {
+		keys = append(keys, key)
+	}
+	return keys
+}
+
 func KeysOfMapOfString(input map[string]string) []string {
 	var keys []string
 	for key, _ := range input {