Merge branch 'cpd_dart_string_interpolation' into master

Refs #2749

docs/pages/release_notes.md

@@ -191,6 +191,7 @@ are deprecated as internal API.
 *   [#2733](https://github.com/pmd/pmd/pull/2733): Cleanup: Collection::addAll issues  - [XenoAmess](https://github.com/XenoAmess) 
 *   [#2734](https://github.com/pmd/pmd/pull/2734): Cleanup: use try with resources - [XenoAmess](https://github.com/XenoAmess)
 *   [#2744](https://github.com/pmd/pmd/pull/2744): Cleanup: fix typos - [XenoAmess](https://github.com/XenoAmess)
+*   [#2749](https://github.com/pmd/pmd/pull/2749): \[dart] \[cpd] Improvements for Dart interpolated strings - [Maikel Steneker](https://github.com/maikelsteneker)
 
 
 {% endtocmaker %}

pmd-dart/src/main/antlr4/net/sourceforge/pmd/lang/dart/antlr4/Dart2.g4

@@ -351,16 +351,16 @@ SingleLineString
 
 fragment
 StringContentDQ
-  : ~('\\' | '"' /*| '$'*/ | '\n' | '\r')
+  : ~('\\' | '"' | '$' | '\n' | '\r')
   | '\\' ~('\n' | '\r')
-  //| stringInterpolation
+  | StringInterpolation
   ;
 
 fragment
 StringContentSQ
-  : ~('\\' | '\'' /*| '$'*/ | '\n' | '\r')
+  : ~('\\' | '\'' | '$' | '\n' | '\r')
   | '\\' ~('\n' | '\r')
-  //| stringInterpolation
+  | StringInterpolation
   ;
 
 MultiLineString
@@ -372,15 +372,16 @@ MultiLineString
 
 fragment
 StringContentTDQ
-  : ~('\\' | '"' /*| '$'*/)
+  : ~('\\' | '"' | '$')
   | '"' ~'"' | '""' ~'"'
-  //| stringInterpolation
+  | StringInterpolation
   ;
 
-fragment StringContentTSQ
+fragment
-  : ~('\\' | '\'' /*| '$'*/)
+StringContentTSQ
+  : ~('\\' | '\'' | '$')
   | '\'' ~'\'' | '\'\'' ~'\''
-  //| stringInterpolation
+  | StringInterpolation
   ;
 
 NEWLINE
@@ -390,10 +391,17 @@ NEWLINE
   ;
 
 // 16.5.1 String Interpolation
-stringInterpolation
+fragment
-//  : '$' IDENTIFIER_NO_DOLLAR
+StringInterpolation
-  : '$' identifier// FIXME
+  : '$' IDENTIFIER_NO_DOLLAR
-  | '${' expression '}'
+  | '${' StringInterpolationContent* '}'
+  ;
+
+fragment
+StringInterpolationContent
+  : ~('$' | '{' | '}')
+  | '$' IDENTIFIER_NO_DOLLAR
+  | '${' StringInterpolationContent* '}'
   ;
 
 // 16.6 Symbols

pmd-dart/src/test/java/net/sourceforge/pmd/cpd/DartTokenizerTest.java

@@ -54,7 +54,10 @@ public class DartTokenizerTest extends CpdTextComparisonTest {
         doTest("imports");
     }
 
-
+    @Test
+    public void testStringInterpolation() {
+        doTest("string_interpolation");
+    }
 
     @Test
     public void testRegex() {

pmd-dart/src/test/resources/net/sourceforge/pmd/cpd/testdata/escape_sequences.dart

@@ -1,3 +1,3 @@
 var newline = '\n';
-var dollar = '$';
+var dollar = '$newLine';
 var escaped_dollar = "\$";

pmd-dart/src/test/resources/net/sourceforge/pmd/cpd/testdata/escape_sequences.txt

@@ -8,7 +8,7 @@ L2
     [var]                                   1         3
     [dollar]                                5         10
     [=]                                     12        12
-    ['$']                                   14        16
+    ['$newLine']                            14        23
 L3
     [var]                                   1         3
     [escaped_dollar]                        5         18

pmd-dart/src/test/resources/net/sourceforge/pmd/cpd/testdata/string_interpolation.dart

@@ -0,0 +1,4 @@
+var stringInStringUnicode = "${"∆"}";
+var stringInStringNewline = "${"\n"}";
+var nestedInterpolation = "${"${"\n"}"}";
+var interpolationWithMethodCall = "${foo("")}";

pmd-dart/src/test/resources/net/sourceforge/pmd/cpd/testdata/string_interpolation.txt

@@ -0,0 +1,22 @@
+    [Image] or [Truncated image[            Bcol      Ecol
+L1
+    [var]                                   1         3
+    [stringInStringUnicode]                 5         25
+    [=]                                     27        27
+    ["${"∆"}"]                              29        36
+L2
+    [var]                                   1         3
+    [stringInStringNewline]                 5         25
+    [=]                                     27        27
+    ["${"\\n"}"]                            29        37
+L3
+    [var]                                   1         3
+    [nestedInterpolation]                   5         23
+    [=]                                     25        25
+    ["${"${"\\n"}"}"]                       27        40
+L4
+    [var]                                   1         3
+    [interpolationWithMethodCall]           5         31
+    [=]                                     33        33
+    ["${foo("")}"]                          35        46
+EOF