Enhanced TextHelper to support different locales

Author: wise0704

PluginCore/PluginCore/Localization/LocaleVersion.cs

@@ -1,22 +1,48 @@
 namespace PluginCore.Localization
 {
-    public enum LocaleVersion
+    public enum LocaleVersion : sbyte
     {
+        /// <summary>
+        /// English - UNITED STATES (US)
+        /// </summary>
         [StringValue("en_US")]
         en_US = 0,
 
+        /// <summary>
+        /// Japanese - JAPAN (JP)
+        /// </summary>
         [StringValue("ja_JP")]
         ja_JP = 1,
 
+        /// <summary>
+        /// German - GERMANY (DE)
+        /// </summary>
         [StringValue("de_DE")]
         de_DE = 2,
 
+        /// <summary>
+        /// Basque - SPAIN (ES)
+        /// </summary>
         [StringValue("eu_ES")]
         eu_ES = 3,
 
+        /// <summary>
+        /// Chinese - CHINA (CN)
+        /// </summary>
         [StringValue("zh_CN")]
-        zh_CN = 4
+        zh_CN = 4,
 
+        /// <summary>
+        /// Korean - KOREA, REPUBLIC OF (KR)
+        /// </summary>
+        [StringValue("ko_KR")]
+        ko_KR = 5,
+
+        /// <summary>
+        /// Represents an invalid locale.
+        /// </summary>
+        [System.ComponentModel.Browsable(false)]
+        Invalid = -1
     }
 
 }

PluginCore/PluginCore/Localization/TextHelper.cs

@@ -5,34 +5,126 @@
 
 namespace PluginCore.Localization
 {
-    public class TextHelper
+    /// <summary>
+    /// Provides methods to retrieve and modify localized resource strings.
+    /// </summary>
+    public static class TextHelper
     {
-        private static ResourceManager resourceManager = null;
-        private static LocaleVersion storedLocale = LocaleVersion.en_US;
+        static ResourceManager resourceManager;
+        static LocaleVersion storedLocale = LocaleVersion.Invalid;
 
         /// <summary>
-        /// Gets the specified localized string
+        /// Gets the specified localized string.
+        /// <para/>
+        /// The calling assembly's name will be used as the default prefix for the specified key.
+        /// If the key with the default prefix does not exist, the key without the default prefix
+        /// will be used to retrieve the localized string.
+        /// <see cref="String.Empty"/> is returned if the key does not exist.
         /// </summary>
+        /// <param name="key">The key used to retrieve the localized string.</param>
         public static String GetString(String key)
         {
-            String result; String prefix;
-            if (PluginBase.MainForm == null || PluginBase.MainForm.Settings == null) return key;
-            LocaleVersion localeSetting = PluginBase.MainForm.Settings.LocaleVersion;
-            if (resourceManager == null || localeSetting != storedLocale)
+            return GetStringInternal(key, Assembly.GetCallingAssembly());
+        }
+
+        /// <summary>
+        /// Gets the specified localized string with ampersand (&amp;) characters removed.
+        /// <para/>
+        /// Internally calls <see cref="TextHelper.RemoveMnemonics(String)"/> on the string
+        /// returned from <see cref="TextHelper.GetString(String)"/>.
+        /// </summary>
+        /// <param name="key">The key used to retrieve the localized string.</param>
+        public static String GetStringWithoutMnemonics(String key)
+        {
+            return RemoveMnemonics(GetStringInternal(key, Assembly.GetCallingAssembly()));
+        }
+
+        /// <summary>
+        /// Gets the specified localized string with trailing triple dots (...) removed.
+        /// <para/>
+        /// Internally calls <see cref="TextHelper.RemoveEllipsis(String)"/> on the string returned
+        /// from <see cref="TextHelper.GetString(String)"/>.
+        /// </summary>
+        /// <param name="key">The key used to retrieve the localized string.</param>
+        public static String GetStringWithoutEllipsis(String key)
+        {
+            return RemoveEllipsis(GetStringInternal(key, Assembly.GetCallingAssembly()));
+        }
+
+        /// <summary>
+        /// Gets the specified localized string with mnemonics and ellipsis removed.
+        /// <para/>
+        /// Internally calls <see cref="TextHelper.RemoveMnemonicsAndEllipsis(String)"/> on the
+        /// string returned from <see cref="TextHelper.GetString(String)"/>.
+        /// </summary>
+        /// <param name="key">The key used to retrieve the localized string.</param>
+        public static String GetStringWithoutMnemonicsOrEllipsis(String key)
+        {
+            return RemoveMnemonicsAndEllipsis(GetStringInternal(key, Assembly.GetCallingAssembly()));
+        }
+
+        /// <summary>
+        /// Removes mnemonics from the specified string.
+        /// <para/>
+        /// The string can be in two forms: <code>"&amp;Close"</code> or <code>"Close (&amp;C)"</code>.
+        /// In both cases this method will return the string <code>"Close"</code>.
+        /// </summary>
+        /// <param name="text">A <see cref="String"/> instance to remove mnemonics from.</param>
+        public static String RemoveMnemonics(String text)
+        {
+            if (String.IsNullOrEmpty(text)) return String.Empty;
+            Int32 index = text.Length;
+            if (index > 4 &&
+                text[--index].Equals(')') &&
+                Char.IsUpper(text[--index]) &&
+                text[--index].Equals('&') &&
+                text[--index].Equals('('))
             {
-                storedLocale = localeSetting;
-                String path = "PluginCore.PluginCore.Resources." + storedLocale;
-                resourceManager = new ResourceManager(path, Assembly.GetExecutingAssembly());
+                if (!text[--index].Equals(' ')) index++;
+                return text.Remove(index);
             }
-            prefix = Assembly.GetCallingAssembly().GetName().Name;
+            return text.Replace("&", String.Empty);
+        }
+
+        /// <summary>
+        /// Removes trailing ellipsis (...) from the specified string.
+        /// </summary>
+        /// <param name="text">A <see cref="String"/> instance to remove ellipsis from.</param>
+        public static String RemoveEllipsis(String text)
+        {
+            if (String.IsNullOrEmpty(text)) return String.Empty;
+            Int32 index = text.LastIndexOf("...", StringComparison.Ordinal);
+            return index == -1 ? text : text.Remove(index, 3);
+        }
+
+        /// <summary>
+        /// Removes mnemonics and ellipsis from the specified string.
+        /// Note that Mnemonics are removed first due to strings like "Open... (&amp;O)".
+        /// </summary>
+        /// <param name="text">A <see cref="String"/> instance to remove mnemonics and ellipsis from.</param>
+        public static String RemoveMnemonicsAndEllipsis(String text)
+        {
+            return RemoveMnemonics(RemoveEllipsis(text));
+        }
+
+        /// <summary>
+        /// Gets the specified localized string with the specified assembly's name as the default prefix.
+        /// </summary>
+        static String GetStringInternal(String key, Assembly assembly)
+        {
+            if (!RefreshStoredLocale()) return key ?? String.Empty;
+            String prefix = assembly.GetName().Name;
             // On different distro we need to use FlashDevelop prefix
             if (prefix == DistroConfig.DISTRIBUTION_NAME) prefix = "FlashDevelop";
-            result = resourceManager.GetString(prefix + "." + key);
-            if (result == null) result = resourceManager.GetString(key);
+            String result = resourceManager.GetString(prefix + "." + key);
             if (result == null)
             {
-                TraceManager.Add("No localized string found: " + key);
-                result = String.Empty;
+                result = resourceManager.GetString(key);
+                if (result == null)
+                {
+                    TraceManager.Add("No localized string found: " + key);
+                    return String.Empty;
+                }
             }
             // Replace FlashDevelop with distro name if needed
             if (DistroConfig.DISTRIBUTION_NAME != "FlashDevelop")
@@ -44,6 +136,22 @@ public static String GetString(String key)
             return result;
         }
 
+        /// <summary>
+        /// Checks and updates the stored locale and resource manager if necessary.
+        /// Returns whether the operation succeeded (<code>true</code>) or failed (<code>false</code>).
+        /// </summary>
+        static bool RefreshStoredLocale()
+        {
+            if (PluginBase.MainForm == null || PluginBase.MainForm.Settings == null) return false;
+            LocaleVersion localeSetting = PluginBase.MainForm.Settings.LocaleVersion;
+            if (localeSetting != storedLocale)
+            {
+                storedLocale = localeSetting;
+                String path = "PluginCore.PluginCore.Resources." + storedLocale;
+                resourceManager = new ResourceManager(path, Assembly.GetExecutingAssembly());
+            }
+            return true;
+        }
     }
 
 }