Use QuoteCppString in testcases

matthijskooijman · matthijskooijman · commit a2eb033b7035 · 2016-05-19T15:59:41.000+02:00
In some testcases, the generated output is checked, which contains #line
directives with filenames. Previously, this compared against the
filename with just backslashes escaped, but this would be incorrect when
there are quotes in the filename. Since the previous commit, the
arduino-builder code itself uses a new `utils.QuoteCppString` function to
apply escaping, so this applies that same escaping.

Part of the changes modify the test code directly, part of the changes
replace the `EscapeBackSlashes` "function" that was used in
interpolating some text files with a call to QuoteCppString instead.

Note that QuoteCppString already adds quotes around its result, so those
are removed from the places where this function is called.

Signed-off-by: Matthijs Kooijman &lt;matthijs@stdin.nl&gt;
diff --git a/src/arduino.cc/builder/test/helper.go b/src/arduino.cc/builder/test/helper.go
@@ -33,22 +33,20 @@ package test
 import (
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
 	"bytes"
 	"fmt"
 	"github.com/go-errors/errors"
 	"github.com/stretchr/testify/assert"
 	"io/ioutil"
 	"path/filepath"
-	"strings"
 	"testing"
 	"text/template"
 )
 
 func LoadAndInterpolate(t *testing.T, filename string, ctx *types.Context) string {
 	funcsMap := template.FuncMap{
-		"EscapeBackSlashes": func(s string) string {
-			return strings.Replace(s, "\\", "\\\\", -1)
-		},
+		"QuoteCppString": utils.QuoteCppString,
 	}
 
 	tpl, err := template.New(filepath.Base(filename)).Funcs(funcsMap).ParseFiles(filename)
diff --git a/src/arduino.cc/builder/test/prototypes_adder_test.go b/src/arduino.cc/builder/test/prototypes_adder_test.go
diff --git a/src/arduino.cc/builder/test/sketch1/merged_sketch.txt b/src/arduino.cc/builder/test/sketch1/merged_sketch.txt
@@ -1,16 +1,16 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
 
 }
 
 void loop() {
 
 }
-#line 1 "{{EscapeBackSlashes (index .sketch.OtherSketchFiles 0).Name}}"
+#line 1 {{QuoteCppString (index .sketch.OtherSketchFiles 0).Name}}
 
-#line 1 "{{EscapeBackSlashes (index .sketch.OtherSketchFiles 1).Name}}"
+#line 1 {{QuoteCppString (index .sketch.OtherSketchFiles 1).Name}}
 String hello() {
   return "world";
 }
diff --git a/src/arduino.cc/builder/test/sketch2/SketchWithIfDef.preprocessed.txt b/src/arduino.cc/builder/test/sketch2/SketchWithIfDef.preprocessed.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #define DEBUG 1
 #define DISABLED 0
 
@@ -16,17 +16,17 @@ typedef int MyType;
 
 #include "empty_2.h"
 
-#line 16 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 16 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 21 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 21 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 33 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 33 {{QuoteCppString .sketch.MainFile.Name}}
 void debug();
-#line 44 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 44 {{QuoteCppString .sketch.MainFile.Name}}
 void disabledIsDefined();
-#line 48 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 48 {{QuoteCppString .sketch.MainFile.Name}}
 int useMyType(MyType type);
-#line 16 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 16 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
   // put your setup code here, to run once:
 
diff --git a/src/arduino.cc/builder/test/sketch2/SketchWithIfDef.resolved.directives.txt b/src/arduino.cc/builder/test/sketch2/SketchWithIfDef.resolved.directives.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #define DEBUG 1
 #define DISABLED 0
 
diff --git a/src/arduino.cc/builder/test/sketch3/Baladuino.preprocessed.txt b/src/arduino.cc/builder/test/sketch3/Baladuino.preprocessed.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 /*
  * The code is released under the GNU General Public License.
  * Developed by Kristian Lauszus, TKJ Electronics 2013
@@ -88,11 +88,11 @@ WII Wii(&Btd); // The Wii library can communicate with Wiimotes and the Nunchuck
 // This can also be done using the Android or Processing application
 #endif
 
-#line 88 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 88 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 204 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 204 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 88 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 88 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
   /* Initialize UART */
   Serial.begin(115200);
diff --git a/src/arduino.cc/builder/test/sketch4/CharWithEscapedDoubleQuote.preprocessed.txt b/src/arduino.cc/builder/test/sketch4/CharWithEscapedDoubleQuote.preprocessed.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #include <SoftwareSerial.h> // required to send and receive AT commands from the GPRS Shield
 #include <Wire.h> // required for I2C communication with the RTC
 
@@ -39,49 +39,49 @@ Code Exclusively for GPRS shield:
 //  Default set of instructions for GPRS Shield power control
 //
 
-#line 39 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 39 {{QuoteCppString .sketch.MainFile.Name}}
 void setPowerStateTo( int newState );
-#line 64 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 64 {{QuoteCppString .sketch.MainFile.Name}}
 int getPowerState();
-#line 75 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 75 {{QuoteCppString .sketch.MainFile.Name}}
 void powerUpOrDown();
-#line 90 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 90 {{QuoteCppString .sketch.MainFile.Name}}
 void clearBufferArray();
-#line 96 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 96 {{QuoteCppString .sketch.MainFile.Name}}
 void makeMissedCall( char num[] );
-#line 111 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 111 {{QuoteCppString .sketch.MainFile.Name}}
 void sendTextMessage( char number[], char messg[] );
-#line 129 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 129 {{QuoteCppString .sketch.MainFile.Name}}
 void analise(byte incoming[], int length);
-#line 179 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 179 {{QuoteCppString .sketch.MainFile.Name}}
 byte decToBcd( byte b );
-#line 184 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 184 {{QuoteCppString .sketch.MainFile.Name}}
 boolean getBit( byte addr, int pos );
-#line 190 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 190 {{QuoteCppString .sketch.MainFile.Name}}
 void setBit( byte addr, int pos, boolean newBit );
-#line 204 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 204 {{QuoteCppString .sketch.MainFile.Name}}
 byte getByte( byte addr );
-#line 213 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 213 {{QuoteCppString .sketch.MainFile.Name}}
 boolean getBytes( byte addr, int amount );
-#line 230 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 230 {{QuoteCppString .sketch.MainFile.Name}}
 void setByte( byte addr, byte newByte );
-#line 235 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 235 {{QuoteCppString .sketch.MainFile.Name}}
 void setBytes( byte addr, byte newBytes[], int amount );
-#line 244 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 244 {{QuoteCppString .sketch.MainFile.Name}}
 void getTime();
-#line 260 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 260 {{QuoteCppString .sketch.MainFile.Name}}
 void setTime( byte newTime[ 7 ] );
-#line 267 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 267 {{QuoteCppString .sketch.MainFile.Name}}
 void getRTCTemperature();
-#line 277 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 277 {{QuoteCppString .sketch.MainFile.Name}}
 void gprsListen();
-#line 294 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 294 {{QuoteCppString .sketch.MainFile.Name}}
 void printTime();
-#line 317 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 317 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 334 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 334 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 39 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 39 {{QuoteCppString .sketch.MainFile.Name}}
 void setPowerStateTo( int newState )
 {
   if( newState != 1 && newState != 0 ) { // tests for an invalid state. In this case no change is made to powerstate
diff --git a/src/arduino.cc/builder/test/sketch5/IncludeBetweenMultilineComment.preprocessed.txt b/src/arduino.cc/builder/test/sketch5/IncludeBetweenMultilineComment.preprocessed.txt
@@ -1,16 +1,16 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #include <CapacitiveSensor.h>
 /*
 #include <WiFi.h>
 */
 CapacitiveSensor cs_13_8 = CapacitiveSensor(13,8);
-#line 6 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 6 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 10 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 10 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 6 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 6 {{QuoteCppString .sketch.MainFile.Name}}
 void setup()
 {
 	Serial.begin(9600);
diff --git a/src/arduino.cc/builder/test/sketch6/LineContinuations.preprocessed.txt b/src/arduino.cc/builder/test/sketch6/LineContinuations.preprocessed.txt
@@ -1,17 +1,17 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 const char *foo = "\
 hello \
 world\n";
 
 //" delete this comment line and the IDE parser will crash
 
-#line 7 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 7 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 11 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 11 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 7 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 7 {{QuoteCppString .sketch.MainFile.Name}}
 void setup()
 {
 }
diff --git a/src/arduino.cc/builder/test/sketch7/StringWithComment.preprocessed.txt b/src/arduino.cc/builder/test/sketch7/StringWithComment.preprocessed.txt
@@ -1,11 +1,11 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 10 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 10 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
   // put your setup code here, to run once:
   // "comment with a double quote
diff --git a/src/arduino.cc/builder/test/sketch8/SketchWithStruct.preprocessed.txt b/src/arduino.cc/builder/test/sketch8/SketchWithStruct.preprocessed.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 /* START CODE */
 
 struct A_NEW_TYPE {
@@ -9,13 +9,13 @@ struct A_NEW_TYPE {
   int c;
 } foo;
 
-#line 9 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 9 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 13 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 13 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 17 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 17 {{QuoteCppString .sketch.MainFile.Name}}
 void dostuff (A_NEW_TYPE * bar);
-#line 9 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 9 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
 
 }
diff --git a/src/arduino.cc/builder/test/sketch_with_config/sketch_with_config.preprocessed.txt b/src/arduino.cc/builder/test/sketch_with_config/sketch_with_config.preprocessed.txt
@@ -1,6 +1,6 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #include "config.h"
 
 #ifdef DEBUG
@@ -13,11 +13,11 @@
 
 #include <Bridge.h>
 
-#line 13 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 13 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 17 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 17 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 13 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 13 {{QuoteCppString .sketch.MainFile.Name}}
 void setup() {
 
 }
diff --git a/src/arduino.cc/builder/test/sketch_with_ifdef/sketch.preprocessed.SAM.txt b/src/arduino.cc/builder/test/sketch_with_ifdef/sketch.preprocessed.SAM.txt
@@ -1,18 +1,18 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #if __SAM3X8E__
-#line 2 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 2 {{QuoteCppString .sketch.MainFile.Name}}
 void ifBranch();
-#line 9 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 9 {{QuoteCppString .sketch.MainFile.Name}}
 void f1();
-#line 10 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 10 {{QuoteCppString .sketch.MainFile.Name}}
 void f2();
-#line 12 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 12 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 14 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 14 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 2 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 2 {{QuoteCppString .sketch.MainFile.Name}}
 void ifBranch() {
 }
 #else
diff --git a/src/arduino.cc/builder/test/sketch_with_ifdef/sketch.preprocessed.txt b/src/arduino.cc/builder/test/sketch_with_ifdef/sketch.preprocessed.txt
@@ -1,21 +1,21 @@
 #include <Arduino.h>
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
+#line 1 {{QuoteCppString .sketch.MainFile.Name}}
 #if __SAM3X8E__
 void ifBranch() {
 }
 #else
-#line 5 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 5 {{QuoteCppString .sketch.MainFile.Name}}
 void elseBranch();
-#line 9 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 9 {{QuoteCppString .sketch.MainFile.Name}}
 void f1();
-#line 10 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 10 {{QuoteCppString .sketch.MainFile.Name}}
 void f2();
-#line 12 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 12 {{QuoteCppString .sketch.MainFile.Name}}
 void setup();
-#line 14 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 14 {{QuoteCppString .sketch.MainFile.Name}}
 void loop();
-#line 5 "{{EscapeBackSlashes .sketch.MainFile.Name}}"
+#line 5 {{QuoteCppString .sketch.MainFile.Name}}
 void elseBranch() {
 }
 #endif

Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`	`1`	`#include <Arduino.h>`
`2`		`-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"`
`3`		`-#line 1 "{{EscapeBackSlashes .sketch.MainFile.Name}}"`
	`2`	`+#line 1 {{QuoteCppString .sketch.MainFile.Name}}`
	`3`	`+#line 1 {{QuoteCppString .sketch.MainFile.Name}}`
`4`	`4`	`void setup() {`
`5`	`5`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`void loop() {`
`9`	`9`
`10`	`10`	`}`
`11`		`-#line 1 "{{EscapeBackSlashes (index .sketch.OtherSketchFiles 0).Name}}"`
	`11`	`+#line 1 {{QuoteCppString (index .sketch.OtherSketchFiles 0).Name}}`
`12`	`12`
`13`		`-#line 1 "{{EscapeBackSlashes (index .sketch.OtherSketchFiles 1).Name}}"`
	`13`	`+#line 1 {{QuoteCppString (index .sketch.OtherSketchFiles 1).Name}}`
`14`	`14`	`String hello() {`
`15`	`15`	`return "world";`
`16`	`16`	`}`