+ * Backslashes are escaped only when the pasted text is not perfectly correct for the .properties + * file, i.e. if the text contains + *
t,n,f,r,u,\true if backslashes need to be escaped, false otherwise
+ */
+ private boolean shouldEscapeSlashes(String text) {
+ int length= text.length();
+ for (int i= 0; i < length; i++) {
+ char c= text.charAt(i);
+ if (c == '\\') {
+ if (i < length - 1) {
+ char nextC= text.charAt(i + 1);
+ switch (nextC) {
+ case 't':
+ case 'n':
+ case 'f':
+ case 'r':
+ case 'u':
+ break;
+ case '\\':
+ i++;
+ break;
+ default:
+ return true;
+ }
+ }else {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ private static String escape(String s, boolean escapeUnicodeChars, boolean escapeSlash) {
StringBuffer sb= new StringBuffer(s.length());
int length= s.length();
for (int i= 0; i < length; i++) {
char c= s.charAt(i);
- sb.append(escape(c));
+ sb.append(escape(c, escapeUnicodeChars, escapeSlash));
}
return sb.toString();
}
- private static String escape(char c) {
+ private static String escape(char c, boolean escapeUnicodeChars, boolean escapeSlash) {
switch (c) {
case '\t':
return "\t";//$NON-NLS-1$
@@ -79,10 +135,9 @@
case '\r':
return "\r";//$NON-NLS-1$
case '\\':
- return "\\";//$NON-NLS-1$
-
+ return escapeSlash ? "\\\\" : "\\"; //$NON-NLS-1$ //$NON-NLS-2$
default:
- return PropertiesFileEscapes.escape(c);
+ return escapeUnicodeChars ? PropertiesFileEscapes.escape(c) : String.valueOf(c);
}
}
}
Index: ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileSourceViewerConfiguration.java
===================================================================
RCS file: /cvsroot/eclipse/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileSourceViewerConfiguration.java,v
retrieving revision 1.39
diff -u -r1.39 PropertiesFileSourceViewerConfiguration.java
--- ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileSourceViewerConfiguration.java 5 Nov 2010 05:49:58 -0000 1.39
+++ ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileSourceViewerConfiguration.java 5 Nov 2010 06:08:01 -0000
@@ -348,7 +348,7 @@
for (int i= 0; i < autoEditStrategies.length; i++) {
stratergies.add(autoEditStrategies[i]);
}
- stratergies.add(new PropertiesFileAutoEditStrategy(((IFileEditorInput)fTextEditor.getEditorInput()).getFile()));
+ stratergies.add(new PropertiesFileAutoEditStrategy(fPreferenceStore, ((IFileEditorInput)fTextEditor.getEditorInput()).getFile()));
return (IAutoEditStrategy[])stratergies.toArray(new IAutoEditStrategy[stratergies.size()]);
} catch (CoreException e) {
JavaPlugin.log(e);
Index: ui/org/eclipse/jdt/ui/PreferenceConstants.java
===================================================================
RCS file: /cvsroot/eclipse/org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/PreferenceConstants.java,v
retrieving revision 1.257
diff -u -r1.257 PreferenceConstants.java
--- ui/org/eclipse/jdt/ui/PreferenceConstants.java 5 Nov 2010 05:49:58 -0000 1.257
+++ ui/org/eclipse/jdt/ui/PreferenceConstants.java 5 Nov 2010 06:08:01 -0000
@@ -3569,6 +3569,17 @@
public static final String PROPERTIES_FILE_COLORING_ARGUMENT_UNDERLINE= PROPERTIES_FILE_COLORING_ARGUMENT + EDITOR_UNDERLINE_SUFFIX;
/**
+ * A named preference that controls whether backslashes are escaped if required, when pasting in
+ * a properties file.
+ *
+ * Value is of type Boolean.
+ *
* Value is an XML encoded version of the history. @@ -3890,6 +3901,8 @@ store.setDefault(PreferenceConstants.PROPERTIES_FILE_COLORING_COMMENT_BOLD, false); store.setDefault(PreferenceConstants.PROPERTIES_FILE_COLORING_COMMENT_ITALIC, false); + store.setDefault(PreferenceConstants.PROPERTIES_FILE_WHEN_PASTING_ESCAPE_BACKSLASH_IF_REQUIRED, true); + // semantic highlighting SemanticHighlightings.initDefaults(store); #P org.eclipse.jdt.ui.tests Index: META-INF/MANIFEST.MF =================================================================== RCS file: /cvsroot/eclipse/org.eclipse.jdt.ui.tests/META-INF/MANIFEST.MF,v retrieving revision 1.17 diff -u -r1.17 MANIFEST.MF --- META-INF/MANIFEST.MF 5 Nov 2010 05:34:10 -0000 1.17 +++ META-INF/MANIFEST.MF 5 Nov 2010 06:08:04 -0000 @@ -33,6 +33,7 @@ org.eclipse.jdt.ui.tests.performance;x-internal:=true, org.eclipse.jdt.ui.tests.performance.views;x-internal:=true, org.eclipse.jdt.ui.tests.preferences;x-internal:=true, + org.eclipse.jdt.ui.tests.propertiesfileeditor;x-internal:=true, org.eclipse.jdt.ui.tests.quickfix;x-internal:=true, org.eclipse.jdt.ui.tests.search;x-internal:=true, org.eclipse.jdt.ui.tests.ui.internal.compatibility;x-internal:=true, Index: ui/org/eclipse/jdt/ui/tests/AutomatedSuite.java =================================================================== RCS file: /cvsroot/eclipse/org.eclipse.jdt.ui.tests/ui/org/eclipse/jdt/ui/tests/AutomatedSuite.java,v retrieving revision 1.55 diff -u -r1.55 AutomatedSuite.java --- ui/org/eclipse/jdt/ui/tests/AutomatedSuite.java 25 Nov 2008 11:01:46 -0000 1.55 +++ ui/org/eclipse/jdt/ui/tests/AutomatedSuite.java 5 Nov 2010 06:08:04 -0000 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2008 IBM Corporation and others. + * Copyright (c) 2000, 2010 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -26,6 +26,7 @@ import org.eclipse.jdt.ui.tests.jarexport.JarExportTests; import org.eclipse.jdt.ui.tests.model.ContentProviderTests; import org.eclipse.jdt.ui.tests.packageview.PackageExplorerTests; +import org.eclipse.jdt.ui.tests.propertiesfileeditor.PropertiesFileEditorTests; import org.eclipse.jdt.ui.tests.quickfix.QuickFixTest; import org.eclipse.jdt.ui.tests.search.SearchTest; import org.eclipse.jdt.ui.tests.wizardapi.NewJavaProjectWizardTest; @@ -73,6 +74,7 @@ addTest(BuildpathModifierActionTest.suite()); addTest(JarExportTests.suite()); + addTest(PropertiesFileEditorTests.suite()); } } Index: ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileAutoEditStrategyTest.java =================================================================== RCS file: ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileAutoEditStrategyTest.java diff -N ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileAutoEditStrategyTest.java --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileAutoEditStrategyTest.java 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,334 @@ +/******************************************************************************* + * Copyright (c) 2010 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.jdt.ui.tests.propertiesfileeditor; + +import java.io.IOException; +import java.io.InputStream; +import java.io.Reader; +import java.io.StringReader; + +import junit.framework.Test; +import junit.framework.TestCase; +import junit.framework.TestSuite; + +import org.eclipse.jdt.testplugin.JavaProjectHelper; + +import org.eclipse.core.runtime.CoreException; + +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; + +import org.eclipse.jface.preference.IPreferenceStore; + +import org.eclipse.jface.text.DocumentCommand; + +import org.eclipse.jdt.core.IJavaProject; +import org.eclipse.jdt.core.IPackageFragment; +import org.eclipse.jdt.core.IPackageFragmentRoot; + +import org.eclipse.jdt.ui.PreferenceConstants; +import org.eclipse.jdt.ui.tests.core.ProjectTestSetup; + +import org.eclipse.jdt.internal.ui.JavaPlugin; +import org.eclipse.jdt.internal.ui.propertiesfileeditor.PropertiesFileAutoEditStrategy; + +/** + * PropertiesFileAutoEditStratergyTest + * + * @since 3.7 + */ +public class PropertiesFileAutoEditStrategyTest extends TestCase { + + private static final String UTF_8= "UTF-8"; + private static final String ISO_8859_1= "ISO-8859-1"; + + private DocumentCommand fDocumentCommand; + + private IPreferenceStore fPreferenceStore; + + private PropertiesFileAutoEditStrategy fPropertiesFileAutoEditStrategyISO_8859_1; + private PropertiesFileAutoEditStrategy fPropertiesFileAutoEditStrategyUTF8; + + private IJavaProject fJProject1; + private IPackageFragmentRoot fSourceFolder; + private IFile fPropertiesFileISO_8859_1; + private IFile fPropertiesFileUTF8; + + public PropertiesFileAutoEditStrategyTest(String name) { + super(name); + fPreferenceStore= JavaPlugin.getDefault().getPreferenceStore(); + fDocumentCommand= new DocumentCommand() { + }; + } + + public static Test suite() { + return new ProjectTestSetup(new TestSuite(PropertiesFileAutoEditStrategyTest.class)); + } + + protected void setUp() throws Exception { + super.setUp(); + setEscapeBackslashIfRequired(true); // make sure that the preference is set to true + try { + fJProject1= ProjectTestSetup.getProject(); + fSourceFolder= JavaProjectHelper.addSourceContainer(fJProject1, "src"); + IPackageFragment pack= fSourceFolder.createPackageFragment("test", false, null); + fPropertiesFileISO_8859_1= write((IFolder)pack.getCorrespondingResource(), "", "Messages_ISO_8859_1.properties"); + fPropertiesFileISO_8859_1.setCharset(ISO_8859_1, null); + fPropertiesFileUTF8= write((IFolder)pack.getCorrespondingResource(), "", "Messages_UTF8.properties"); + fPropertiesFileUTF8.setCharset(UTF_8, null); + fPropertiesFileAutoEditStrategyISO_8859_1= new PropertiesFileAutoEditStrategy(fPreferenceStore, fPropertiesFileISO_8859_1); + fPropertiesFileAutoEditStrategyUTF8= new PropertiesFileAutoEditStrategy(fPreferenceStore, fPropertiesFileUTF8); + } catch (CoreException e) { + e.printStackTrace(); + } + } + + protected void tearDown() throws Exception { + JavaProjectHelper.clear(fJProject1, ProjectTestSetup.getDefaultClasspath()); + super.tearDown(); + } + + //utility methods + private void performTestISO_8859_1() { + fPropertiesFileAutoEditStrategyISO_8859_1.customizeDocumentCommand(null, fDocumentCommand); + } + + private void performTestAutoEscapeSlashDisabledISO_8859_1() { + setEscapeBackslashIfRequired(false); + fPropertiesFileAutoEditStrategyISO_8859_1.customizeDocumentCommand(null, fDocumentCommand); + setEscapeBackslashIfRequired(true); + } + + private void performTestUTF8() { + fPropertiesFileAutoEditStrategyUTF8.customizeDocumentCommand(null, fDocumentCommand); + } + + private void performTestAutoEscapeSlashDisabledUTF8() { + setEscapeBackslashIfRequired(false); + fPropertiesFileAutoEditStrategyUTF8.customizeDocumentCommand(null, fDocumentCommand); + setEscapeBackslashIfRequired(true); + } + + private void setEscapeBackslashIfRequired(boolean value) { + fPreferenceStore.setValue(PreferenceConstants.PROPERTIES_FILE_WHEN_PASTING_ESCAPE_BACKSLASH_IF_REQUIRED, value); + } + + private IFile write(IFolder folder, final String content, final String fileName) throws CoreException { + InputStream stream= new InputStream() { + private final Reader fReader= new StringReader(content); + + public int read() throws IOException { + return fReader.read(); + } + }; + IFile file= fJProject1.getProject().getFile(folder.getProjectRelativePath().append(fileName)); + file.create(stream, true, null); + return file; + } + + //typing ISO-8859-1 + public void testTypeISO_8859_1_01() throws Exception { + fDocumentCommand.text= "\\"; + performTestISO_8859_1(); + assertEquals("\\", fDocumentCommand.text); + } + + public void testTypeISO_8859_1_02() throws Exception { + fDocumentCommand.text= "\t"; + performTestISO_8859_1(); + assertEquals("\t", fDocumentCommand.text); + } + + public void testTypeISO_8859_1_03() throws Exception { + fDocumentCommand.text= "\f"; + performTestISO_8859_1(); + assertEquals("\f", fDocumentCommand.text); + } + + public void testTypeISO_8859_1_04() throws Exception { + fDocumentCommand.text= "\r"; + performTestISO_8859_1(); + assertEquals("\r", fDocumentCommand.text); + } + + public void testTypeISO_8859_1_05() throws Exception { + fDocumentCommand.text= "\n"; + performTestISO_8859_1(); + assertEquals("\n", fDocumentCommand.text); + } + + public void testTypeISO_8859_1_06() throws Exception { + fDocumentCommand.text= "\u2603"; + performTestISO_8859_1(); + assertEquals("\\u2603", fDocumentCommand.text); + } + + //typing UTF-8 + public void testTypeUTF8_01() throws Exception { + fDocumentCommand.text= "\u2603"; + performTestUTF8(); + assertEquals("\u2603", fDocumentCommand.text); + } + + //paste ISO-8859-1 + public void testPasteISO_8859_1_01() throws Exception { + fDocumentCommand.text= "C:\\Program Files\\Java"; + performTestISO_8859_1(); + assertEquals("C:\\\\Program Files\\\\Java", fDocumentCommand.text); + } + + public void testPasteISO_8859_1_02() throws Exception { + fDocumentCommand.text= "C:\\new folder\\A.java"; + performTestISO_8859_1(); + assertEquals("C:\\\\new folder\\\\A.java", fDocumentCommand.text); + } + + public void testPasteISO_8859_1_03() throws Exception { + fDocumentCommand.text= "\u0926 \u0905"; + performTestISO_8859_1(); + assertEquals("\\u0926 \\u0905", fDocumentCommand.text); + } + + public void testPasteISO_8859_1_04() throws Exception { + fDocumentCommand.text= "\u0926 \\u0905"; + performTestISO_8859_1(); + assertEquals("\\u0926 \\\\u0905", fDocumentCommand.text); + } + + public void testPasteISO_8859_1_05() throws Exception { + fDocumentCommand.text= "ä \u0926"; + performTestISO_8859_1(); + assertEquals("ä \\u0926", fDocumentCommand.text); + } + + public void testPasteISO_8859_1_06() throws Exception { + fDocumentCommand.text= "some text\\"; + performTestISO_8859_1(); + assertEquals("some text\\\\", fDocumentCommand.text); + } + + //paste UTF-8 + public void testPasteUTF8_01() throws Exception { + fDocumentCommand.text= "C:\\Program Files\\Java"; + performTestUTF8(); + assertEquals("C:\\\\Program Files\\\\Java", fDocumentCommand.text); + } + + public void testPasteUTF8_02() throws Exception { + fDocumentCommand.text= "C:\\new folder\\A.java"; + performTestUTF8(); + assertEquals("C:\\\\new folder\\\\A.java", fDocumentCommand.text); + } + + public void testPasteUTF8_03() throws Exception { + fDocumentCommand.text= "\u0926 \u0905"; + performTestUTF8(); + assertEquals("\u0926 \u0905", fDocumentCommand.text); + } + + public void testPasteUTF8_04() throws Exception { + fDocumentCommand.text= "\u0926 \\u0905"; + performTestUTF8(); + assertEquals("\u0926 \\u0905", fDocumentCommand.text); + } + + public void testPasteUTF8_05() throws Exception { + fDocumentCommand.text= "\u0926 \\some text"; + performTestUTF8(); + assertEquals("\u0926 \\\\some text", fDocumentCommand.text); + } + + //paste from properties file ISO-8859-1 + public void testPasteFromPropertiesFileISO_8859_1_01() throws Exception { + fDocumentCommand.text= "\t \n \f \r"; + performTestISO_8859_1(); + assertEquals("\t \n \f \r", fDocumentCommand.text); + } + + public void testPasteFromPropertiesFileISO_8859_1_02() throws Exception { + fDocumentCommand.text= "\\u00e4 \\t \\u0926 \\n"; + performTestISO_8859_1(); + assertEquals("\\u00e4 \\t \\u0926 \\n", fDocumentCommand.text); + } + + public void testPasteFromPropertiesFileISO_8859_1_03() throws Exception { + fDocumentCommand.text= "C:\\\\Program Files\\\\Java"; + performTestISO_8859_1(); + assertEquals("C:\\\\Program Files\\\\Java", fDocumentCommand.text); + } + + public void testPasteFromPropertiesFileISO_8859_1_04() throws Exception { + fDocumentCommand.text= "C:\\\\new folder\\\\A.java"; + performTestISO_8859_1(); + assertEquals("C:\\\\new folder\\\\A.java", fDocumentCommand.text); + } + + public void testPasteFromPropertiesFileISO_8859_1_05() throws Exception { + fDocumentCommand.text= "\\u2603 \\\\u2603"; + performTestISO_8859_1(); + assertEquals("\\u2603 \\\\u2603", fDocumentCommand.text); + } + + // paste ISO-8859-1 and PreferenceConstants.PROPERTIES_FILE_ESCAPE_BACKSLASH_ON_PASTE_IF_REQUIRED disabled + public void testAutoEscapeSlashDisabledISO_8859_1_01() throws Exception { + fDocumentCommand.text= "C:\\Program Files\\Java"; + performTestAutoEscapeSlashDisabledISO_8859_1(); + assertEquals("C:\\Program Files\\Java", fDocumentCommand.text); + } + + public void testAutoEscapeSlashDisabledISO_8859_1_02() throws Exception { + fDocumentCommand.text= "C:\\new folder\\A.java"; + performTestAutoEscapeSlashDisabledISO_8859_1(); + assertEquals("C:\\new folder\\A.java", fDocumentCommand.text); + } + + public void testAutoEscapeSlashDisabledISO_8859_1_03() throws Exception { + fDocumentCommand.text= "\u0926 \\u0905"; + performTestAutoEscapeSlashDisabledISO_8859_1(); + assertEquals("\\u0926 \\u0905", fDocumentCommand.text); + } + + //paste UTF-8 and PreferenceConstants.PROPERTIES_FILE_ESCAPE_BACKSLASH_ON_PASTE_IF_REQUIRED disabled + public void testAutoEscapeSlashDisabledUTF8_01() throws Exception { + fDocumentCommand.text= "\u0926 \\some text"; + performTestAutoEscapeSlashDisabledUTF8(); + assertEquals("\u0926 \\some text", fDocumentCommand.text); + } + + //change encoding of file + public void testChangeEncodingOfFile_01() throws Exception { + fDocumentCommand.text= "\u2603"; + performTestUTF8(); + assertEquals("\u2603", fDocumentCommand.text); + + fPropertiesFileUTF8.setCharset(ISO_8859_1, null); + + fDocumentCommand.text= "\u2603"; + performTestUTF8(); + assertEquals("\\u2603", fDocumentCommand.text); + + fPropertiesFileUTF8.setCharset(UTF_8, null); + } + + public void testChangeEncodingOfFile_02() throws Exception { + fDocumentCommand.text= "\u2603"; + performTestISO_8859_1(); + assertEquals("\\u2603", fDocumentCommand.text); + + fPropertiesFileISO_8859_1.setCharset(UTF_8, null); + + fDocumentCommand.text= "\u2603"; + performTestISO_8859_1(); + assertEquals("\u2603", fDocumentCommand.text); + + fPropertiesFileISO_8859_1.setCharset(ISO_8859_1, null); + } +} Index: ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileEditorTests.java =================================================================== RCS file: ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileEditorTests.java diff -N ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileEditorTests.java --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ ui/org/eclipse/jdt/ui/tests/propertiesfileeditor/PropertiesFileEditorTests.java 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,25 @@ +/******************************************************************************* + * Copyright (c) 2010 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.jdt.ui.tests.propertiesfileeditor; + +import junit.framework.Test; +import junit.framework.TestSuite; + +public class PropertiesFileEditorTests { + + public static Test suite() { + TestSuite suite= new TestSuite("Test for org.eclipse.jdt.ui.tests.propertiesfileeditor"); + //$JUnit-BEGIN$ + suite.addTest(PropertiesFileAutoEditStrategyTest.suite()); + //$JUnit-END$ + return suite; + } +}