Internationalization part 1 (#467)

Part 1 of (hopefully) 2 for internationalizing Yafc. Primarily, this
downloads an appropriate Noto Sans font for languages Roboto doesn't
support, and then restarts to switch to that font.

Author: shpaass

Docs/MoreLanguagesSupport.md

@@ -1,17 +1,21 @@
 # YAFC support for more languages
 
-YAFC language support is experimental. If your language is missing, that is probably because of one of two reasons:
+You can ask Yafc to display non-English names for Factorio objects from the Welcome screen:
+- On the Welcome screen, click the language name (probably "English") next to "In-game objects language:"
+- Select your language from the drop-down that appears.
+- If your language uses non-European glyphs, it may appear at the bottom of the list.
+  - To use these languages, Yafc may need to do a one-time download of a suitable font.
+Click "Confirm" if Yafc asks permission to download a font.
+  - If you do not wish to have Yafc automatically download a suitable font, click "Select font" in the drop-down, and select a font file that supports your language.
 
-- It has less than 90% support in official Factorio translation
-- It uses non-European glyphs (such as Chinese or Japanese languages)
-
-You can enable support for your language using this method:
-- Navigate to `yafc.config` file located at `%localappdata%\YAFC` (`C:\Users\username\AppData\Local\YAFC`). Open it with the text editor.
-- Find `language` section and replace the value with your language code. Here are examples of language codes:
-    - Chinese (Simplified): `zh-CN`
+If your language is supported by Factorio but does not appear in the Welcome screen, you can manually force YAFC to use the strings for your language:
+- Navigate to `yafc2.config` file located at `%localappdata%\YAFC` (`C:\Users\username\AppData\Local\YAFC`). Open it with a text editor.
+- Find the `language` section and replace the value with your language code. Here are examples of language codes:
+	- Chinese (Simplified): `zh-CN`
 	- Chinese (Traditional): `zh-TW`
 	- Korean: `ko`
 	- Japanese: `ja`
 	- Hebrew: `he`
-	- Else: Look into `Factorio/data/base/locale` folder and find folder with your language.
-- If your language have non-European glyphs, you also need to replace fonts: `Yafc/Data/Roboto-Light.ttf` and `Roboto-Regular.ttf` with any fonts that support your language glyphs.
+	- Else: Look into `Factorio/data/base/locale` folder and find the folder with your language.
+- If your language uses non-European glyphs, you also need to replace the fonts `Yafc/Data/Roboto-Light.ttf` and `Roboto-Regular.ttf` with fonts that support your language.
+You may also use the "Select font" button in the language dropdown on the Welcome screen to change the font.

Yafc.Model/Analysis/Analysis.cs

@@ -21,8 +21,6 @@ public static void ProcessAnalyses(IProgress<(string, string)> progress, Project
         }
     }
 
-    public abstract string description { get; }
-
     public static void Do<T>(Project project) where T : Analysis {
         foreach (var analysis in analyses) {
             if (analysis is T t) {

Yafc.Model/Analysis/AutomationAnalysis.cs

@@ -90,6 +90,4 @@ public override void Compute(Project project, ErrorCollector warnings) {
         }
         automatable = state;
     }
-
-    public override string description => "Automation analysis tries to find what objects can be automated. Object cannot be automated if it requires looting an entity or manual crafting.";
 }

Yafc.Model/Analysis/CostAnalysis.cs

@@ -362,10 +362,6 @@ public override void Compute(Project project, ErrorCollector warnings) {
         workspaceSolver.Dispose();
     }
 
-    public override string description => "Cost analysis computes a hypothetical late-game base. This simulation has two very important results: " +
-        "How much does stuff (items, recipes, etc) cost and how much of stuff do you need. It also collects a bunch of auxiliary results, for example " +
-        "how efficient are different recipes. These results are used as heuristics and weights for calculations, and are also useful by themselves.";
-
     private static readonly StringBuilder sb = new StringBuilder();
     public static string GetDisplayCost(FactorioObject goods) {
         float cost = goods.Cost();
@@ -415,6 +411,6 @@ public static string GetDisplayCost(FactorioObject goods) {
             return null;
         }
 
-        return DataUtils.FormatAmount(itemFlow * 1000f, UnitOfMeasure.None, itemAmountPrefix);
+        return itemAmountPrefix + DataUtils.FormatAmount(itemFlow * 1000f, UnitOfMeasure.None);
     }
 }

Yafc.Model/Analysis/Milestones.cs

@@ -265,7 +265,4 @@ private static bool[] WalkAccessibilityGraph(Project project, HashSet<FactorioOb
     private const string UseDependencyExplorer = "\n\nFor this reason YAFC has a Dependency Explorer that allows you to manually enable some of the core recipes. " +
         "YAFC will iteratively try to unlock all the dependencies after each recipe you manually enabled. " +
         "For most modpacks it's enough to unlock a few early recipes like any special recipes for plates that everything in the mod is based on.";
-
-    public override string description => "Milestone analysis starts from objects that are placed on map by the map generator and tries to find all objects that are accessible from that, " +
-        "taking notes about which objects are locked behind which milestones.";
 }

Yafc.Model/Analysis/TechnologyScienceAnalysis.cs

@@ -108,7 +108,4 @@ public override void Compute(Project project, ErrorCollector warnings) {
         allSciencePacks = Database.technologies.CreateMapping(
             tech => sciencePackCount.Select((x, id) => x[tech] == 0 ? null : new Ingredient(sciencePacks[id], x[tech])).WhereNotNull().ToArray());
     }
-
-    public override string description =>
-        "Technology analysis calculates the total amount of science packs required for each technology";
 }

Yafc.Model/Data/DataUtils.cs

@@ -564,25 +564,22 @@ public static string FormatTime(float time) {
         return $"{time / 3600f:#} hours";
     }
 
-    public static string FormatAmount(float amount, UnitOfMeasure unit, string? prefix = null, string? suffix = null, bool precise = false) {
+    public static string FormatAmount(float amount, UnitOfMeasure unit, bool precise = false) {
         var (multiplier, unitSuffix) = Project.current == null ? (1f, null) : Project.current.ResolveUnitOfMeasure(unit);
 
-        return FormatAmountRaw(amount, multiplier, unitSuffix, precise ? PreciseFormat : FormatSpec, prefix, suffix);
+        return FormatAmountRaw(amount, multiplier, unitSuffix, precise ? PreciseFormat : FormatSpec);
     }
 
-    public static string FormatAmountRaw(float amount, float unitMultiplier, string? unitSuffix, (char suffix, float multiplier, string format)[] formatSpec, string? prefix = null, string? suffix = null) {
+    public static string FormatAmountRaw(float amount, float unitMultiplier, string? unitSuffix, (char suffix, float multiplier, string format)[] formatSpec) {
         if (float.IsNaN(amount) || float.IsInfinity(amount)) {
             return "-";
         }
 
         if (amount == 0f) {
-            return prefix + "0" + unitSuffix + suffix;
+            return "0" + unitSuffix;
         }
 
         _ = amountBuilder.Clear();
-        if (prefix != null) {
-            _ = amountBuilder.Append(prefix);
-        }
 
         if (amount < 0) {
             _ = amountBuilder.Append('-');
@@ -600,10 +597,6 @@ public static string FormatAmountRaw(float amount, float unitMultiplier, string?
 
         _ = amountBuilder.Append(unitSuffix);
 
-        if (suffix != null) {
-            _ = amountBuilder.Append(suffix);
-        }
-
         return amountBuilder.ToString();
     }
 

Yafc.Parser/FactorioDataSource.cs

@@ -121,6 +121,16 @@ private static void LoadModLocale(string modName, string locale) {
         }
     }
 
+    public static void LoadYafcLocale(string locale) {
+        try {
+            foreach (string localeName in Directory.EnumerateFiles("Data/locale/" + locale + "/")) {
+                using Stream stream = File.Open(localeName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
+                FactorioLocalization.Parse(stream);
+            }
+        }
+        catch (DirectoryNotFoundException) { /* No Yafc translation for this locale */ }
+    }
+
     private static void FindMods(string directory, IProgress<(string, string)> progress, List<ModInfo> mods) {
         foreach (string entry in Directory.EnumerateDirectories(directory)) {
             string infoFile = Path.Combine(entry, "info.json");

Yafc.UI/Rendering/Font.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using SDL2;
 
 namespace Yafc.UI;
@@ -23,11 +24,28 @@ public FontFile.FontSize GetFontSize(float pixelsPreUnit) {
         return lastFontSize;
     }
 
+    /// <summary>
+    /// Returns <see langword="true"/> if the current font has glyphs for all characters in the supplied string, or <see langword="false"/> if
+    /// any characters do not have a glyph.
+    /// </summary>
+    public bool CanDraw(string value) {
+        nint handle = lastFontSize!.handle;
+        foreach (char ch in value) {
+            if (SDL_ttf.TTF_GlyphIsProvided(handle, ch) == 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+
     public IntPtr GetHandle(float pixelsPreUnit) => GetFontSize(pixelsPreUnit).handle;
 
     public float GetLineSize(float pixelsPreUnit) => GetFontSize(pixelsPreUnit).lineSize / pixelsPreUnit;
 
     public void Dispose() => file.Dispose();
+
+    public static bool FilesExist(string baseFileName)
+        => File.Exists($"Data/{baseFileName}-Regular.ttf") && File.Exists($"Data/{baseFileName}-Light.ttf");
 }
 
 public sealed class FontFile(string fileName) : IDisposable {

Yafc/Program.cs

@@ -23,9 +23,16 @@ private static void Main(string[] args) {
             Console.Error.WriteException(ex);
         }
 
+        string baseFileName = "Roboto";
+        if (WelcomeScreen.languageMapping.TryGetValue(Preferences.Instance.language, out LanguageInfo? language)) {
+            if (Font.FilesExist(language.BaseFontName)) {
+                baseFileName = language.BaseFontName;
+            }
+        }
+
         hasOverriddenFont = overriddenFontFile != null;
-        Font.header = new Font(overriddenFontFile ?? new FontFile("Data/Roboto-Light.ttf"), 2f);
-        var regular = overriddenFontFile ?? new FontFile("Data/Roboto-Regular.ttf");
+        Font.header = new Font(overriddenFontFile ?? new FontFile($"Data/{baseFileName}-Light.ttf"), 2f);
+        var regular = overriddenFontFile ?? new FontFile($"Data/{baseFileName}-Regular.ttf");
         Font.subheader = new Font(regular, 1.5f);
         Font.productionTableHeader = new Font(regular, 1.23f);
         Font.text = new Font(regular, 1f);