added dedicated package to sketch file wrapper

Author: masci

arduino/globals/globals.go

@@ -0,0 +1,43 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to modify or
+// otherwise use the software for commercial activities involving the Arduino
+// software without disclosing the source code of your own applications. To purchase
+// a commercial license, send an email to [email protected].
+
+package globals
+
+var (
+	empty struct{}
+
+	// MainFileValidExtensions lists valid extensions for a sketch file
+	MainFileValidExtensions = map[string]struct{}{
+		".ino": empty,
+		".pde": empty,
+	}
+
+	// AdditionalFileValidExtensions lists any file extension the builder considers as valid
+	AdditionalFileValidExtensions = map[string]struct{}{
+		".h":   empty,
+		".c":   empty,
+		".hpp": empty,
+		".hh":  empty,
+		".cpp": empty,
+		".s":   empty,
+	}
+
+	// SourceFilesValidExtensions lists valid extensions for source files (no headers)
+	SourceFilesValidExtensions = map[string]struct{}{
+		".c":   empty,
+		".cpp": empty,
+		".s":   empty,
+	}
+)

arduino/sketch/sketch.go

@@ -0,0 +1,114 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to modify or
+// otherwise use the software for commercial activities involving the Arduino
+// software without disclosing the source code of your own applications. To purchase
+// a commercial license, send an email to [email protected].
+
+package sketch
+
+import (
+	"io/ioutil"
+	"path/filepath"
+	"sort"
+	"strings"
+
+	"github.com/arduino/arduino-cli/arduino/globals"
+	"github.com/pkg/errors"
+)
+
+// Item holds the source and the path for a single sketch file
+type Item struct {
+	Path   string
+	Source []byte
+}
+
+// NewItem reads the source code for a sketch item and returns an
+// Item instance
+func NewItem(itemPath string) (*Item, error) {
+	// read the file
+	source, err := ioutil.ReadFile(itemPath)
+	if err != nil {
+		return nil, errors.Wrap(err, "error reading source file")
+	}
+
+	return &Item{itemPath, source}, nil
+}
+
+// ItemByPath implements sort.Interface for []Item based on
+// lexicographic order of the path string.
+type ItemByPath []*Item
+
+func (ibn ItemByPath) Len() int           { return len(ibn) }
+func (ibn ItemByPath) Swap(i, j int)      { ibn[i], ibn[j] = ibn[j], ibn[i] }
+func (ibn ItemByPath) Less(i, j int) bool { return ibn[i].Path < ibn[j].Path }
+
+// Sketch holds all the files composing a sketch
+type Sketch struct {
+	MainFile         *Item
+	OtherSketchFiles []*Item
+	AdditionalFiles  []*Item
+}
+
+// New creates an Sketch instance by reading all the files composing a sketch and grouping them
+// by file type.
+func New(sketchFolderPath, mainFilePath, buildPath string, allFilesPaths []string) (*Sketch, error) {
+	var mainFile *Item
+
+	// read all the sketch contents and create sketch Items
+	pathToItem := make(map[string]*Item)
+	for _, p := range allFilesPaths {
+		// create an Item
+		item, err := NewItem(p)
+		if err != nil {
+			return nil, errors.Wrap(err, "error creating the sketch")
+		}
+
+		if p == mainFilePath {
+			// store the main sketch file
+			mainFile = item
+		} else {
+			// map the file path to sketch.Item
+			pathToItem[p] = item
+		}
+	}
+
+	// organize the Items
+	additionalFiles := []*Item{}
+	otherSketchFiles := []*Item{}
+	for p, item := range pathToItem {
+		ext := strings.ToLower(filepath.Ext(p))
+		if _, found := globals.MainFileValidExtensions[ext]; found {
+			// item is a valid main file, see if it's stored at the
+			// sketch root and ignore if it's not.
+			if filepath.Dir(p) == sketchFolderPath {
+				otherSketchFiles = append(otherSketchFiles, item)
+			}
+		} else if _, found := globals.AdditionalFileValidExtensions[ext]; found {
+			// item is a valid sketch file, grab it only if the buildPath is empty
+			// or the file is within the buildPath
+			if buildPath == "" || !strings.Contains(filepath.Dir(p), buildPath) {
+				additionalFiles = append(additionalFiles, item)
+			}
+		} else {
+			return nil, errors.Errorf("unknown sketch file extension '%s'", ext)
+		}
+	}
+
+	sort.Sort(ItemByPath(additionalFiles))
+	sort.Sort(ItemByPath(otherSketchFiles))
+
+	return &Sketch{
+		MainFile:         mainFile,
+		OtherSketchFiles: otherSketchFiles,
+		AdditionalFiles:  additionalFiles,
+	}, nil
+}

arduino/sketch/sketch_test.go

@@ -0,0 +1,67 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to modify or
+// otherwise use the software for commercial activities involving the Arduino
+// software without disclosing the source code of your own applications. To purchase
+// a commercial license, send an email to [email protected].
+
+package sketch_test
+
+import (
+	"path/filepath"
+	"sort"
+	"testing"
+
+	"github.com/arduino/arduino-cli/arduino/sketch"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewItem(t *testing.T) {
+	sketchItem := filepath.Join("testdata", t.Name()+".ino")
+	item, err := sketch.NewItem(sketchItem)
+	assert.Nil(t, err)
+	assert.Equal(t, sketchItem, item.Path)
+	assert.Equal(t, []byte(`#include <testlib.h>`), item.Source)
+
+	item, err = sketch.NewItem("doesnt/exist")
+	assert.Nil(t, item)
+	assert.NotNil(t, err)
+}
+
+func TestSort(t *testing.T) {
+	items := []*sketch.Item{
+		&sketch.Item{"foo", nil},
+		&sketch.Item{"baz", nil},
+		&sketch.Item{"bar", nil},
+	}
+
+	sort.Sort(sketch.ItemByPath(items))
+
+	assert.Equal(t, "bar", items[0].Path)
+	assert.Equal(t, "baz", items[1].Path)
+	assert.Equal(t, "foo", items[2].Path)
+}
+
+func TestNew(t *testing.T) {
+	sketchFolderPath := filepath.Join("testdata", t.Name())
+	mainFilePath := filepath.Join(sketchFolderPath, t.Name()+".ino")
+	otherFile := filepath.Join(sketchFolderPath, "other.cpp")
+	allFilesPaths := []string{
+		mainFilePath,
+		otherFile,
+	}
+
+	sketch, err := sketch.New(sketchFolderPath, mainFilePath, "", allFilesPaths)
+	assert.Nil(t, err)
+	assert.Equal(t, mainFilePath, sketch.MainFile.Path)
+	assert.Len(t, sketch.OtherSketchFiles, 0)
+	assert.Len(t, sketch.AdditionalFiles, 1)
+}

arduino/sketch/testdata/TestNew/TestNew.ino

@@ -0,0 +1,12 @@
+#include <testlib1.h>
+#include "subfolder/other.h"
+#include "src/subfolder/other.h"
+
+MyClass myClass;
+
+void setup() {
+    myClass.init ( &Serial );
+}
+
+void loop() {
+}

arduino/sketch/testdata/TestNew/other.cpp

@@ -0,0 +1,11 @@
+#include <Arduino.h> // Arduino 1.0
+#include <testlib2.h>
+
+#include "other.h"
+
+MyClass::MyClass() {
+}
+
+void MyClass::init ( Stream *stream ) {
+    controllerStream = stream;
+}

arduino/sketch/testdata/TestNewItem.ino

@@ -0,0 +1 @@
+#include <testlib.h>