Merge pull request #3004 from eclipse/lb_2293

Normalization of Line Terminators in Xbase strings

org.eclipse.xtend.core.tests/src/org/eclipse/xtend/core/tests/compiler/AbstractXbaseEvaluationTest.java

@@ -909,9 +909,17 @@ public abstract class AbstractXbaseEvaluationTest extends Assert {
 	}
 
 	@Test public void testStringLiteral_03() throws Exception {
-		assertEvaluatesTo("lite\r\nr\\al", "'lite\r\nr\\\\al'");
+		assertEvaluatesTo("lite\nr\\al", "'lite\r\nr\\\\al'");
 	}
-
+
+	@Test public void testStringLiteral_03_Issue_2293_01() throws Exception {
+		assertEvaluatesTo("lite\nr\\al", "'lite\\nr\\\\al'");
+	}
+
+	@Test public void testStringLiteral_03_Issue_2293_02() throws Exception {
+		assertEvaluatesTo("lite\r\nr\\al", "'lite\\r\\nr\\\\al'");
+	}
+
 	@Test public void testStringLiteral_04() throws Exception {
 		assertEvaluatesTo('\n', "{ val char x = '\n' x}");
 	}

org.eclipse.xtend.core/src/org/eclipse/xtend/core/XtendRuntimeModule.java

@@ -17,7 +17,7 @@
 import org.eclipse.xtend.core.compiler.XtendOutputConfigurationProvider;
 import org.eclipse.xtend.core.conversion.IntUnderscoreValueConverter;
 import org.eclipse.xtend.core.conversion.JavaIDValueConverter;
-import org.eclipse.xtend.core.conversion.StringValueConverter;
+import org.eclipse.xtend.core.conversion.XtendStringValueConverter;
 import org.eclipse.xtend.core.conversion.XtendValueConverterService;
 import org.eclipse.xtend.core.documentation.XtendDocumentationProvider;
 import org.eclipse.xtend.core.documentation.XtendFileHeaderProvider;
@@ -296,8 +296,9 @@ public Class<? extends XbaseValueConverterService.IntUnderscoreValueConverter> b
 		return IntUnderscoreValueConverter.class;
 	}
 
+	@Override
 	public Class<? extends STRINGValueConverter> bindSTRINGValueConverter() {
-		return StringValueConverter.class;
+		return XtendStringValueConverter.class;
 	}
 
 	public Class<? extends TokenRegionProvider> bindTokenRegionProvider() {

org.eclipse.xtend.core/src/org/eclipse/xtend/core/conversion/StringValueConverter.java → org.eclipse.xtend.core/src/org/eclipse/xtend/core/conversion/XtendStringValueConverter.java

@@ -12,21 +12,21 @@
 
 import org.antlr.runtime.TokenSource;
 import org.eclipse.xtend.core.parser.antlr.internal.FlexerFactory;
-import org.eclipse.xtext.conversion.impl.STRINGValueConverter;
+import org.eclipse.xtext.xbase.conversion.XbaseStringValueConverter;
 
 import com.google.inject.Inject;
 
 /**
  * @author Sebastian Zarnekow - Initial contribution and API
  */
-public class StringValueConverter extends STRINGValueConverter {
+public class XtendStringValueConverter extends XbaseStringValueConverter {
 
 	@Inject
 	private FlexerFactory flexerFactory;
-	
+
 	@Override
 	protected TokenSource getTokenSource(String escapedValue) {
 		return flexerFactory.createTokenSource(new StringReader(escapedValue));
 	}
-	
+
 }

org.eclipse.xtext.xbase.testing/META-INF/MANIFEST.MF

@@ -16,7 +16,7 @@ Bundle-ActivationPolicy: lazy
 Export-Package: org.eclipse.xtext.xbase.testing;version="2.35.0",
  org.eclipse.xtext.xbase.testing.evaluation;version="2.35.0";x-friends:="org.eclipse.xtext.xbase.tests,org.eclipse.xtext.purexbase.tests",
  org.eclipse.xtext.xbase.testing.typesystem;version="2.35.0";x-internal:=true,
- testdata;version="2.35.0";x-friends:="org.eclipse.xtext.xbase.tests",
+ testdata;version="2.35.0";x-friends:="org.eclipse.xtext.xbase.tests,org.eclipse.xtend.core.tests",
  testdata.a;version="2.35.0";x-internal:=true,
  testdata.b;version="2.35.0";x-internal:=true
 Import-Package: org.apache.log4j;version="1.2.24"

org.eclipse.xtext.xbase.testing/src/org/eclipse/xtext/xbase/testing/evaluation/AbstractXbaseEvaluationTest.java

@@ -912,9 +912,17 @@ public abstract class AbstractXbaseEvaluationTest extends Assert {
 	}
 
 	@Test public void testStringLiteral_03() throws Exception {
-		assertEvaluatesTo("lite\r\nr\\al", "'lite\r\nr\\\\al'");
+		assertEvaluatesTo("lite\nr\\al", "'lite\r\nr\\\\al'");
 	}
-
+
+	@Test public void testStringLiteral_03_Issue_2293_01() throws Exception {
+		assertEvaluatesTo("lite\nr\\al", "'lite\\nr\\\\al'");
+	}
+
+	@Test public void testStringLiteral_03_Issue_2293_02() throws Exception {
+		assertEvaluatesTo("lite\r\nr\\al", "'lite\\r\\nr\\\\al'");
+	}
+
 	@Test public void testStringLiteral_04() throws Exception {
 		assertEvaluatesTo('\n', "{ val char x = '\n' x}");
 	}

org.eclipse.xtext.xbase.tests/src/org/eclipse/xtext/xbase/tests/compiler/Compiler2Tests.java

@@ -2190,4 +2190,39 @@ public void testLibIssue60() throws Exception {
 				"}\n" +
 				"return _xblockexpression;\n");
 	}
+
+	@Test
+	public void testStringLiteralWithUnixEOL_Issue2293() throws Exception {
+		compilesTo(
+				"{var s = \"a multiline\nstring\"}",
+				"String s = \"a multiline\\nstring\";");
+	}
+
+	@Test
+	public void testStringLiteralWithWindowsEOL_Issue2293() throws Exception {
+		compilesTo(
+				"{var s = \"a multiline\r\nstring\r\nstring\"}",
+				"String s = \"a multiline\\nstring\\nstring\";");
+	}
+
+	@Test
+	public void testStringLiteralWithCarriageReturn_Issue2293() throws Exception {
+		compilesTo(
+				"{\"astring\".toString.replace(\"\\r\", \"\");}",
+				"return \"astring\".toString().replace(\"\\r\", \"\");");
+	}
+
+	@Test
+	public void testStringLiteralWithCarriageReturn2_Issue2293() throws Exception {
+		compilesTo(
+				"{\"astring\".toString.replaceAll(\"\\r?\\n\", \"\\n\");}",
+				"return \"astring\".toString().replaceAll(\"\\r?\\n\", \"\\n\");");
+	}
+
+	@Test
+	public void testStringLiteralWithCarriageReturn3_Issue2293() throws Exception {
+		compilesTo(
+				"{\"astring\".toString.replaceAll(\"\\r\\n\", \"\\n\");}",
+				"return \"astring\".toString().replaceAll(\"\\r\\n\", \"\\n\");");
+	}
 }

org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/DefaultXbaseRuntimeModule.java

@@ -10,6 +10,7 @@
 
 import org.eclipse.xtext.common.types.DefaultCommonTypesRuntimeModule;
 import org.eclipse.xtext.conversion.IValueConverterService;
+import org.eclipse.xtext.conversion.impl.STRINGValueConverter;
 import org.eclipse.xtext.debug.IStratumBreakpointSupport;
 import org.eclipse.xtext.documentation.IJavaDocTypeReferenceProvider;
 import org.eclipse.xtext.findReferences.TargetURICollector;
@@ -39,6 +40,7 @@
 import org.eclipse.xtext.xbase.annotations.validation.UnresolvedFeatureCallTypeAwareMessageProvider;
 import org.eclipse.xtext.xbase.compiler.JvmModelGenerator;
 import org.eclipse.xtext.xbase.compiler.output.TraceAwarePostProcessor;
+import org.eclipse.xtext.xbase.conversion.XbaseStringValueConverter;
 import org.eclipse.xtext.xbase.conversion.XbaseValueConverterService;
 import org.eclipse.xtext.xbase.debug.XbaseStratumBreakpointSupport;
 import org.eclipse.xtext.xbase.featurecalls.IdentifiableSimpleNameProvider;
@@ -242,5 +244,11 @@ public Class<? extends TargetURICollector> bindTargetURICollector() {
 	public Class<? extends IJavaDocTypeReferenceProvider> bindIJavaDocReferenceProvider() {
 		return XbaseJavaDocTypeReferenceProvider.class;
 	}
-
+
+	/**
+	 * @since 2.35
+	 */
+	public Class<? extends STRINGValueConverter> bindSTRINGValueConverter() {
+		return XbaseStringValueConverter.class;
+	}
 }

org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/conversion/XbaseStringValueConverter.java

@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Lorenzo Bettini and others.
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package org.eclipse.xtext.xbase.conversion;
+
+import org.eclipse.xtext.conversion.impl.STRINGValueConverter;
+import org.eclipse.xtext.nodemodel.INode;
+import org.eclipse.xtext.util.Strings;
+
+/**
+ * Avoid Windows EOL characters from the original parsed text: this would result
+ * in different generated Java files in Windows see
+ * https://github.com/eclipse/xtext/issues/2293 This is aligned with Java text
+ * blocks' "Normalization of Line Terminators"
+ * 
+ * @author Lorenzo Bettini - Initial contribution and API
+ * @since 2.35
+ */
+public class XbaseStringValueConverter extends STRINGValueConverter {
+	@Override
+	public String toValue(String string, INode node) {
+		return super.toValue(Strings.toUnixLineSeparator(string), node);
+	}
+}

org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/conversion/XbaseValueConverterService.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011 itemis AG (http://www.itemis.eu) and others.
+ * Copyright (c) 2011, 2024 itemis AG (http://www.itemis.eu) and others.
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
  * http://www.eclipse.org/legal/epl-2.0.
@@ -34,6 +34,8 @@
  * <p>Clients, who extend Xbase should inherit from this value converter service.</p>
  * 
  * @author Sebastian Zarnekow - Initial contribution and API
+ * @author Lorenzo Bettini - remove Windows EOLs from string literals,
+ * https://github.com/eclipse/xtext/issues/2293
  */
 @Singleton
 public class XbaseValueConverterService extends DefaultTerminalConverters {
@@ -251,4 +253,5 @@ public Integer toValue(String string, INode node) {
 			return super.toValue(withoutUnderscore, node);
 		}
 	}
+
 }