Index: /trunk/src/org/openstreetmap/josm/tools/I18n.java
===================================================================
--- /trunk/src/org/openstreetmap/josm/tools/I18n.java (revision 4393)
+++ /trunk/src/org/openstreetmap/josm/tools/I18n.java (revision 4394)
@@ -9,5 +9,7 @@
import java.net.URL;
import java.text.MessageFormat;
+import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
@@ -15,5 +17,4 @@
import java.util.zip.ZipEntry;
import java.util.Locale;
-import java.util.Vector;
import javax.swing.JColorChooser;
@@ -127,4 +128,10 @@
* These strings are collected by a script that runs on the source code files.
* After translation, the localizations are distributed with the main program.
+ *
+ * For example, {@code tr("JOSM''s default value is ''{0}''.", val)}.
+ *
+ * Use {@see #trn} for distinguishing singular from plural text, i.e.,
+ * do not use {@code tr(size == 1 ? "singular" : "plural")} nor
+ * {@code size == 1 ? tr("singular") : tr("plural")}
*
* @param text the text to translate.
@@ -132,9 +139,10 @@
* Can be broken over multiple lines.
* An apostrophe ' must be quoted by another apostrophe.
- * @param objects Parameters for the string.
- * Mark occurrences in text with {0}, {1}, ...
- * @return the translated string
- *
- * Example: tr("JOSM''s default value is ''{0}''.", val);
+ * @param objects the parameters for the string.
+ * Mark occurrences in {@code text} with {@code {0}}, {@code {1}}, ...
+ * @return the translated string.
+ * @see #trn
+ * @see #trc
+ * @see #trnc
*/
public static final String tr(String text, Object... objects) {
@@ -142,19 +150,15 @@
}
- public static final String tr(String text) {
- if (text == null)
- return null;
- return MessageFormat.format(gettext(text, null), (Object)null);
- }
-
- /**
- * Provide translation in a context.
- * There can be different translations for the same text (but
- * different context).
+ /**
+ * Translates some text in a context for the current locale.
+ * There can be different translations for the same text within different contexts.
*
* @param context string that helps translators to find an appropriate
- * translation for text
- * @param text the text to translate
- * @return the translated string
+ * translation for {@code text}.
+ * @param text the text to translate.
+ * @return the translated string.
+ * @see #tr
+ * @see #trn
+ * @see #trnc
*/
public static final String trc(String context, String text) {
@@ -178,7 +182,9 @@
* the translatable strings from the source files).
*
- * Example:
+ * For example, {@code
* String[] options = new String[] {marktr("up"), marktr("down")};
- * lbl.setText(tr(options[0]));
+ * lbl.setText(tr(options[0]));}
+ * @param text the string to be marked for translation.
+ * @return {@code text} unmodified.
*/
public static final String marktr(String text) {
@@ -191,26 +197,58 @@
/**
- * Example: trn("Found {0} error in {1}!", "Found {0} errors in {1}!", i, Integer.toString(i), url);
- */
- public static final String trn(String text, String pluralText, long n, Object... objects) {
- return MessageFormat.format(gettextn(text, pluralText, null, n), objects);
- }
-
- /**
- * Example: trn("There was an error!", "There were errors!", i);
- */
- public static final String trn(String text, String pluralText, long n) {
- return MessageFormat.format(gettextn(text, pluralText, null, n), (Object)null);
- }
-
- public static final String trnc(String ctx, String text, String pluralText, long n, Object... objects) {
- return MessageFormat.format(gettextn(text, pluralText, ctx, n), objects);
- }
-
- public static final String trnc(String ctx, String text, String pluralText, long n) {
- return MessageFormat.format(gettextn(text, pluralText, ctx, n), (Object)null);
- }
-
- private static final String gettext(String text, String ctx)
+ * Translates some text for the current locale and distinguishes between
+ * {@code singularText} and {@code pluralText} depending on {@code n}.
+ *
+ * For instance, {@code trn("There was an error!", "There were errors!", i)} or
+ * {@code trn("Found {0} error in {1}!", "Found {0} errors in {1}!", i, Integer.toString(i), url)}.
+ *
+ * @param singularText the singular text to translate.
+ * Must be a string literal. (No constants or local vars.)
+ * Can be broken over multiple lines.
+ * An apostrophe ' must be quoted by another apostrophe.
+ * @param pluralText the plural text to translate.
+ * Must be a string literal. (No constants or local vars.)
+ * Can be broken over multiple lines.
+ * An apostrophe ' must be quoted by another apostrophe.
+ * @param n a number to determine whether {@code singularText} or {@code pluralText} is used.
+ * @param objects the parameters for the string.
+ * Mark occurrences in {@code singularText} and {@code pluralText} with {@code {0}}, {@code {1}}, ...
+ * @return the translated string.
+ * @see #tr
+ * @see #trc
+ * @see #trnc
+ */
+ public static final String trn(String singularText, String pluralText, long n, Object... objects) {
+ return MessageFormat.format(gettextn(singularText, pluralText, null, n), objects);
+ }
+
+ /**
+ * Translates some text in a context for the current locale and distinguishes between
+ * {@code singularText} and {@code pluralText} depending on {@code n}.
+ * There can be different translations for the same text within different contexts.
+ *
+ * @param context string that helps translators to find an appropriate
+ * translation for {@code text}.
+ * @param singularText the singular text to translate.
+ * Must be a string literal. (No constants or local vars.)
+ * Can be broken over multiple lines.
+ * An apostrophe ' must be quoted by another apostrophe.
+ * @param pluralText the plural text to translate.
+ * Must be a string literal. (No constants or local vars.)
+ * Can be broken over multiple lines.
+ * An apostrophe ' must be quoted by another apostrophe.
+ * @param n a number to determine whether {@code singularText} or {@code pluralText} is used.
+ * @param objects the parameters for the string.
+ * Mark occurrences in {@code singularText} and {@code pluralText} with {@code {0}}, {@code {1}}, ...
+ * @return the translated string.
+ * @see #tr
+ * @see #trc
+ * @see #trn
+ */
+ public static final String trnc(String context, String singularText, String pluralText, long n, Object... objects) {
+ return MessageFormat.format(gettextn(singularText, pluralText, context, n), objects);
+ }
+
+ private static final String gettext(String text, String ctx, boolean lazy)
{
int i;
@@ -231,28 +269,15 @@
return trans[0];
}
- return text;
- }
+ return lazy ? gettext(text, null) : text;
+ }
+
+ private static final String gettext(String text, String ctx) {
+ return gettext(text, ctx, false);
+ }
+
/* try without context, when context try fails */
- private static final String gettext_lazy(String text, String ctx)
- {
- int i;
- if(ctx == null && text.startsWith("_:") && (i = text.indexOf("\n")) >= 0)
- {
- ctx = text.substring(2,i-1);
- text = text.substring(i+1);
- }
- if(strings != null)
- {
- String trans = strings.get(ctx == null ? text : "_:"+ctx+"\n"+text);
- if(trans != null)
- return trans;
- }
- if(pstrings != null) {
- String[] trans = pstrings.get(ctx == null ? text : "_:"+ctx+"\n"+text);
- if(trans != null)
- return trans[0];
- }
- return gettext(text, null);
+ private static final String gettext_lazy(String text, String ctx) {
+ return gettext(text, ctx, true);
}
@@ -281,5 +306,5 @@
*/
public static final Locale[] getAvailableTranslations() {
- Vector v = new Vector();
+ Collection v = new ArrayList(languages.size());
if(Main.class.getResource("/data/en.lang") != null)
{