PKHeX/PKHeX.WinForms/Util/WinFormsTranslator.cs

using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Windows.Forms;

using PKHeX.Core;

namespace PKHeX.WinForms
{
    public static class WinFormsTranslator
    {
        private static readonly Dictionary<string, TranslationContext> Context = new();
        internal static void TranslateInterface(this Control form, string lang) => TranslateForm(form, GetContext(lang));

        private static string GetTranslationFileNameInternal(string lang) => $"lang_{lang}";
        private static string GetTranslationFileNameExternal(string lang) => $"lang_{lang}.txt";

        public static IReadOnlyDictionary<string, string> GetDictionary(string lang) => GetContext(lang).Lookup;

        private static TranslationContext GetContext(string lang)
        {
            if (Context.TryGetValue(lang, out var context))
                return context;

            var lines = GetTranslationFile(lang);
            Context.Add(lang, context = new TranslationContext(lines));
            return context;
        }

        private static void TranslateForm(Control form, TranslationContext context)
        {
            form.SuspendLayout();

            // Translate Title
            var formName = form.Name;
            formName = GetSaneFormName(formName);
            form.Text = context.GetTranslatedText(formName, form.Text);

            // Translate Controls
            var translatable = GetTranslatableControls(form);
            foreach (var c in translatable)
                TranslateControl(c, context, formName);

            form.ResumeLayout();
        }

        private static string GetSaneFormName(string formName)
        {
            // Strip out generic form names
            var degen = formName.IndexOf('`');
            if (degen != -1)
                formName = formName[..degen];

            return formName switch
            {
                nameof(SAV_EventFlags2) => nameof(SAV_EventFlags),
                _ => formName,
            };
        }

        private static void TranslateControl(object c, TranslationContext context, string formname)
        {
            if (c is Control r)
            {
                var current = r.Text;
                var updated = context.GetTranslatedText($"{formname}.{r.Name}", current);
                if (!ReferenceEquals(current, updated))
                    r.Text = updated;
            }
            else if (c is ToolStripItem t)
            {
                var current = t.Text;
                var updated = context.GetTranslatedText($"{formname}.{t.Name}", current);
                if (!ReferenceEquals(current, updated))
                    t.Text = updated;
            }
        }

        private static IEnumerable<string> GetTranslationFile(string lang)
        {
            var file = GetTranslationFileNameInternal(lang);
            // Check to see if a the translation file exists in the same folder as the executable
            string externalLangPath = GetTranslationFileNameExternal(file);
            if (File.Exists(externalLangPath))
            {
                try { return File.ReadAllLines(externalLangPath); }
                catch { /* In use? Just return the internal resource. */ }
            }

            if (Util.IsStringListCached(file, out var result))
                return result;
            var txt = (string?)Properties.Resources.ResourceManager.GetObject(file);
            return Util.LoadStringList(file, txt);
        }

        private static IEnumerable<object> GetTranslatableControls(Control f)
        {
            foreach (var z in f.GetChildrenOfType<Control>())
            {
                switch (z)
                {
                    case ToolStrip menu:
                        foreach (var obj in GetToolStripMenuItems(menu))
                            yield return obj;

                        break;
                    default:
                        if (string.IsNullOrWhiteSpace(z.Name))
                            break;

                        if (z.ContextMenuStrip != null) // control has attached MenuStrip
                        {
                            foreach (var obj in GetToolStripMenuItems(z.ContextMenuStrip))
                                yield return obj;
                        }

                        if (z is ListControl or TextBoxBase or LinkLabel or NumericUpDown or ContainerControl)
                            break; // undesirable to modify, ignore

                        if (!string.IsNullOrWhiteSpace(z.Text))
                            yield return z;
                        break;
                }
            }
        }

        private static IEnumerable<T> GetChildrenOfType<T>(this Control control) where T : class
        {
            foreach (var child in control.Controls.OfType<Control>())
            {
                if (child is T childOfT)
                    yield return childOfT;

                if (!child.HasChildren) continue;
                foreach (var descendant in GetChildrenOfType<T>(child))
                    yield return descendant;
            }
        }

        private static IEnumerable<object> GetToolStripMenuItems(ToolStrip menu)
        {
            foreach (var i in menu.Items.OfType<ToolStripMenuItem>())
            {
                if (!string.IsNullOrWhiteSpace(i.Text))
                    yield return i;
                foreach (var sub in GetToolsStripDropDownItems(i).Where(z => !string.IsNullOrWhiteSpace(z.Text)))
                    yield return sub;
            }
        }

        private static IEnumerable<ToolStripMenuItem> GetToolsStripDropDownItems(ToolStripDropDownItem item)
        {
            foreach (var dropDownItem in item.DropDownItems.OfType<ToolStripMenuItem>())
            {
                yield return dropDownItem;
                if (!dropDownItem.HasDropDownItems)
                    continue;
                foreach (ToolStripMenuItem subItem in GetToolsStripDropDownItems(dropDownItem))
                    yield return subItem;
            }
        }

#if DEBUG
        public static void UpdateAll(string baseLanguage, IEnumerable<string> others)
        {
            var baseContext = GetContext(baseLanguage);
            foreach (var lang in others)
            {
                var c = GetContext(lang);
                c.UpdateFrom(baseContext);
            }
        }

        public static void DumpAll(params string[] banlist)
        {
            var results = Context.Select(z => new {Lang = z.Key, Lines = z.Value.Write()});
            foreach (var c in results)
            {
                var lang = c.Lang;
                var fn = GetTranslationFileNameExternal(lang);
                var lines = c.Lines;
                var result = lines.Where(z => !banlist.Any(z.Contains));
                File.WriteAllLines(fn, result);
            }
        }

        public static void LoadAllForms(IEnumerable<System.Type> types, params string[] banlist)
        {
            types = types.Where(t => t.BaseType == typeof(Form) && !banlist.Contains(t.Name));
            foreach (var t in types)
            {
                var constructors = t.GetConstructors();
                if (constructors.Length == 0)
                { System.Diagnostics.Debug.WriteLine($"No constructors: {t.Name}"); continue; }
                var argCount = constructors[0].GetParameters().Length;
                try
                {
                    var _ = (Form?)System.Activator.CreateInstance(t, new object[argCount]);
                }
                // This is a debug utility method, will always be logging. Shouldn't ever fail.
                catch
                {
                    System.Diagnostics.Debug.Write($"Failed to create a new form {t}");
                }
            }
        }

        public static void SetRemovalMode(bool status = true)
        {
            foreach (TranslationContext c in Context.Values)
            {
                c.RemoveUsedKeys = status;
                c.AddNew = !status;
            }
        }

        public static void RemoveAll(string defaultLanguage, params string[] banlist)
        {
            var badKeys = Context[defaultLanguage];
            var split = badKeys.Write().Select(z => z.Split(TranslationContext.Separator)[0])
                .Where(l => !banlist.Any(l.StartsWith)).ToArray();
            foreach (var c in Context)
            {
                var lang = c.Key;
                var fn = GetTranslationFileNameExternal(lang);
                var lines = File.ReadAllLines(fn);
                var result = lines.Where(l => !split.Any(s => l.StartsWith(s + TranslationContext.Separator)));
                File.WriteAllLines(fn, result);
            }
        }

        public static void LoadSettings<T>(string defaultLanguage, bool add = true)
        {
            var context = (Dictionary<string, string>)Context[defaultLanguage].Lookup;
            var props = typeof(T).GetProperties(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Instance);
            foreach (var prop in props)
            {
                var p = prop.PropertyType.GetProperties(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Instance);
                foreach (var x in p)
                {
                    var individual = (LocalizedDescriptionAttribute[])x.GetCustomAttributes(typeof(LocalizedDescriptionAttribute), false);
                    foreach (var v in individual)
                    {
                        var hasKey = context.ContainsKey(v.Key);
                        if (add)
                        {
                            if (!hasKey)
                                context.Add(v.Key, v.Fallback);
                        }
                        else
                        {
                            if (hasKey)
                                context.Remove(v.Key);
                        }
                    }
                }
            }
        }
#endif
    }

    public sealed class TranslationContext
    {
        public bool AddNew { private get; set; }
        public bool RemoveUsedKeys { private get; set; }
        public const char Separator = '=';
        private readonly Dictionary<string, string> Translation = new();
        public IReadOnlyDictionary<string, string> Lookup => Translation;

        public TranslationContext(IEnumerable<string> content, char separator = Separator)
        {
            var entries = content.Select(z => z.Split(separator)).Where(z => z.Length == 2);
            foreach (var kvp in entries.Where(z => !Translation.ContainsKey(z[0])))
                Translation.Add(kvp[0], kvp[1]);
        }

        public string? GetTranslatedText(string val, string? fallback)
        {
            if (RemoveUsedKeys)
                Translation.Remove(val);

            if (Translation.TryGetValue(val, out var translated))
                return translated;

            if (fallback != null && AddNew)
                Translation.Add(val, fallback);
            return fallback;
        }

        public IEnumerable<string> Write(char separator = Separator)
        {
            return Translation.Select(z => $"{z.Key}{separator}{z.Value}").OrderBy(z => z.Contains(".")).ThenBy(z => z);
        }

        public void UpdateFrom(TranslationContext other)
        {
            bool oldAdd = AddNew;
            AddNew = true;
            foreach (var kvp in other.Translation)
                GetTranslatedText(kvp.Key, kvp.Value);
            AddNew = oldAdd;
        }
    }
}