ARDUIFINE: global compiler options extracted from ctags parsing

Example: these lines in the ino file:
    char ARDUIFINE_1 = "-DMYLIB_BUFFER_LEN=1234";
    char ARDUIFINE_2 = "-DMYLIB2_PARAM";
will globally enable the following line in the compiler command:
    -DMYLIB_BUFFER_LEN=1234 -DMYLIB2_PARAM

That, including during compilation of the core and libraries.

The symbols ARDUIFINExxx, if they are not otherwise used by the sketch,
are normally excluded from the final binary at link time.

Author: d-a-v

legacy/builder/builder_utils/utils.go

@@ -232,6 +232,7 @@ func compileFileWithRecipe(ctx *types.Context, sourcePath *paths.Path, source *p
 	properties := buildProperties.Clone()
 	properties.Set(constants.BUILD_PROPERTIES_COMPILER_WARNING_FLAGS, properties.Get(constants.BUILD_PROPERTIES_COMPILER_WARNING_FLAGS+"."+ctx.WarningsLevel))
 	properties.Set(constants.BUILD_PROPERTIES_INCLUDES, strings.Join(includes, constants.SPACE))
+	properties.Set(constants.BUILD_PROPERTIES_INCLUDES, properties.Get(constants.BUILD_PROPERTIES_INCLUDES) + " " + ctx.Arduifines + " ")
 	properties.SetPath(constants.BUILD_PROPERTIES_SOURCE_FILE, source)
 	relativeSource, err := sourcePath.RelTo(source)
 	if err != nil {

legacy/builder/ctags/ctags_parser.go

@@ -32,6 +32,7 @@ const KIND_FUNCTION = "function"
 const TEMPLATE = "template"
 const STATIC = "static"
 const EXTERN = "extern \"C\""
+const ARDUIFINE = "ARDUIFINE"
 
 var KNOWN_TAG_KINDS = map[string]bool{
 	"prototype": true,
@@ -43,14 +44,19 @@ type CTagsParser struct {
 	mainFile *paths.Path
 }
 
-func (p *CTagsParser) Parse(ctagsOutput string, mainFile *paths.Path) []*types.CTag {
+func (p *CTagsParser) Parse(ctagsOutput string, mainFile *paths.Path) ([]*types.CTag, string) {
+	Arduifines := ""
 	rows := strings.Split(ctagsOutput, "\n")
 	rows = removeEmpty(rows)
 
 	p.mainFile = mainFile
 
 	for _, row := range rows {
-		p.tags = append(p.tags, parseTag(row))
+		if strings.Index(row, " "+ARDUIFINE) != -1 {
+			Arduifines += extractString(row)
+		} else {
+			p.tags = append(p.tags, parseTag(row))
+		}
 	}
 
 	p.skipTagsWhere(tagIsUnknown)
@@ -60,7 +66,7 @@ func (p *CTagsParser) Parse(ctagsOutput string, mainFile *paths.Path) []*types.C
 	p.skipDuplicates()
 	p.skipTagsWhere(p.prototypeAndCodeDontMatch)
 
-	return p.tags
+	return p.tags, Arduifines
 }
 
 func (p *CTagsParser) addPrototypes() {
@@ -238,3 +244,13 @@ func removeEmpty(rows []string) []string {
 
 	return newRows
 }
+
+func extractString (row string) string {
+	first := strings.Index(row, "\"");
+	last := strings.LastIndex(row, "\";$/;\""); // <- $/;" is a ctag addition
+	if (first <= 0 || last <= 0 || first + 1 > last - 1) {
+		//print("\nERROR: malformed \"" + ARDUIFINE + "\" global directive\n\n")
+		return ""
+	}
+	return " " + strings.Replace(strings.Replace(row[first+1 : last], "\\\\", "\\", -1), "\\\"", "\"", -1) + " "
+}

legacy/builder/ctags_runner.go

@@ -56,7 +56,7 @@ func (s *CTagsRunner) Run(ctx *types.Context) error {
 
 	parser := &ctags.CTagsParser{}
 
-	ctx.CTagsOfPreprocessedSource = parser.Parse(ctx.CTagsOutput, ctx.Sketch.MainFile)
+	ctx.CTagsOfPreprocessedSource, ctx.Arduifines = parser.Parse(ctx.CTagsOutput, ctx.Sketch.MainFile.Name)
 	parser.FixCLinkageTagsDeclarations(ctx.CTagsOfPreprocessedSource)
 
 	protos, line := parser.GeneratePrototypes()

legacy/builder/types/context.go

@@ -177,6 +177,10 @@ type Context struct {
 	// The provided source data is used instead of reading it from disk.
 	// The keys of the map are paths relative to sketch folder.
 	SourceOverride map[string]string
+
+	// compiler options from ctags extraction
+	// example: 'char ARDUIFINEyyy = "<compiler options like> -DMYLIB_BUFFER_LEN=1234 -include \"somefile.h\"";'
+	Arduifines string
 }
 
 // ExecutableSectionSize represents a section of the executable output file