Merge branch 'gmstl10n' into 'master'

Allow composition of GMST l10n values

See merge request OpenMW/openmw!4873

Author: Capostrophic

apps/components_tests/lua/testl10n.cpp

@@ -26,6 +26,8 @@ namespace
     constexpr VFS::Path::NormalizedView test3DePath("l10n/test3/de.yaml");
     constexpr VFS::Path::NormalizedView test4RuPath("l10n/test4/ru.yaml");
     constexpr VFS::Path::NormalizedView test4EnPath("l10n/test4/en.yaml");
+    constexpr VFS::Path::NormalizedView test5GmstPath("l10n/test5/gmst.yaml");
+    constexpr VFS::Path::NormalizedView test5EnPath("l10n/test5/en.yaml");
 
     VFSTestFile invalidScript("not a script");
     VFSTestFile incorrectScript(
@@ -83,6 +85,31 @@ stat_increase: "Your {stat} has increased to {value}"
 speed: "Speed"
 )X");
 
+    VFSTestFile test5(R"X(
+string: "sSimpleString"
+format_string: "sFormatString"
+inject_string: "sStringInjection"
+not_found: "sNoSuchString"
+no_gmst:
+    pattern: "Hello world"
+interpreted_string:
+    pattern: "{gmst:sFormatString} {sSimpleString} {gmst:sFormatString}"
+    variables:
+        - ["a", "b"]
+        - ["b", "a"]
+plural_string:
+    pattern: |-
+        {count, plural,
+            one{{gmst:sSimpleString}}
+            other{{gmst:sFormatString}}
+        }
+    variables:
+        - []
+        - ["count", "count"]
+unnamed_string:
+    pattern: "{gmst:sFormatString}"
+)X");
+
     struct LuaL10nTest : Test
     {
         std::unique_ptr<VFS::Manager> mVFS = createTestVFS({
@@ -94,6 +121,8 @@ speed: "Speed"
             { test3DePath, &test1De },
             { test4RuPath, &test4Ru },
             { test4EnPath, &test4En },
+            { test5GmstPath, &test5 },
+            { test5EnPath, &test5 },
         });
 
         LuaUtil::ScriptsConfiguration mCfg;
@@ -197,4 +226,52 @@ speed: "Speed"
                 "Your Speed has increased to 100");
         });
     }
+
+    TEST_F(LuaL10nTest, L10nGMST)
+    {
+        LuaUtil::LuaState lua{ mVFS.get(), &mCfg };
+        lua.protectedCall([&](LuaUtil::LuaView& view) {
+            sol::state_view& l = view.sol();
+            L10n::Manager l10nManager(mVFS.get());
+            const std::map<std::string_view, std::string, Misc::StringUtils::CiComp> gmsts{
+                { "sSimpleString", "Hello it's the world" },
+                { "sFormatString", "You have %i %s" },
+                { "sStringInjection", "{a}" },
+            };
+            l10nManager.setGmstLoader([&](std::string_view gmst) -> const std::string* {
+                auto it = gmsts.find(gmst);
+                if (it != gmsts.end())
+                    return &it->second;
+                return nullptr;
+            });
+
+            internal::CaptureStdout();
+            l10nManager.setPreferredLocales({ "en" });
+            EXPECT_THAT(internal::GetCapturedStdout(), "Preferred locales: gmst en\n");
+
+            l["l10n"] = LuaUtil::initL10nLoader(l, &l10nManager);
+            l.safe_script("t5 = l10n('Test5')");
+
+            EXPECT_EQ(get<std::string>(l, "t5('string')"), "Hello it's the world");
+            EXPECT_EQ(get<std::string>(l, "t5('format_string')"), "You have %i %s");
+            EXPECT_EQ(get<std::string>(l, "t5('format_string', { i = 1, s = 'a' })"), "You have %i %s");
+            EXPECT_EQ(
+                get<std::string>(l, "t5('interpreted_string')"), "You have {a} {b} {sSimpleString} You have {b} {a}");
+            EXPECT_EQ(get<std::string>(l, "t5('interpreted_string', { a = 1, b = 2, sSimpleString = 3 })"),
+                "You have 1 2 3 You have 2 1");
+            EXPECT_EQ(get<std::string>(l, "t5('inject_string')"), "{a}");
+            EXPECT_EQ(get<std::string>(l, "t5('inject_string', { a = 1 })"), "{a}");
+            EXPECT_EQ(get<std::string>(l, "t5('plural_string', { count = 1 })"), "Hello it's the world");
+            EXPECT_EQ(get<std::string>(l, "t5('plural_string', { count = 2 })"), "You have 2 2");
+            EXPECT_EQ(get<std::string>(l, "t5('unnamed_string')"), "You have {0} {1}");
+            EXPECT_EQ(get<std::string>(l, "t5('unnamed_string', { ['0'] = 'a', ['1'] = 'b' })"), "You have a b");
+            EXPECT_EQ(get<std::string>(l, "t5('no_gmst')"), "Hello world");
+            EXPECT_EQ(get<std::string>(l, "t5('not_found')"), "GMST:sNoSuchString");
+
+            l10nManager.setPreferredLocales({ "en" }, false);
+            EXPECT_EQ(get<std::string>(l, "t5('string')"), "sSimpleString");
+            EXPECT_EQ(get<std::string>(l, "t5('format_string')"), "sFormatString");
+            EXPECT_EQ(get<std::string>(l, "t5('not_found')"), "sNoSuchString");
+        });
+    }
 }

apps/openmw/engine.cpp

@@ -868,21 +868,15 @@ void OMW::Engine::prepareEngine()
     mWorld->setRandomSeed(mRandomSeed);
 
     const MWWorld::Store<ESM::GameSetting>* gmst = &mWorld->getStore().get<ESM::GameSetting>();
-    mL10nManager->setGmstLoader(
-        [gmst, misses = std::set<std::string, std::less<>>()](std::string_view gmstName) mutable {
-            const ESM::GameSetting* res = gmst->search(gmstName);
-            if (res && res->mValue.getType() == ESM::VT_String)
-                return res->mValue.getString();
-            else
-            {
-                if (misses.count(gmstName) == 0)
-                {
-                    misses.emplace(gmstName);
-                    Log(Debug::Error) << "GMST " << gmstName << " not found";
-                }
-                return std::string("GMST:") + std::string(gmstName);
-            }
-        });
+    mL10nManager->setGmstLoader([gmst, misses = std::set<std::string, Misc::StringUtils::CiComp>()](
+                                    std::string_view gmstName) mutable -> const std::string* {
+        const ESM::GameSetting* res = gmst->search(gmstName);
+        if (res && res->mValue.getType() == ESM::VT_String)
+            return &res->mValue.getString();
+        if (misses.emplace(gmstName).second)
+            Log(Debug::Error) << "GMST " << gmstName << " not found";
+        return nullptr;
+    });
 
     mWindowManager->setStore(mWorld->getStore());
     mWindowManager->initUI();

components/l10n/manager.hpp

@@ -24,7 +24,7 @@ namespace L10n
         void dropCache() { mCache.clear(); }
         void setPreferredLocales(const std::vector<std::string>& locales, bool gmstHasPriority = true);
         const std::vector<icu::Locale>& getPreferredLocales() const { return mPreferredLocales; }
-        void setGmstLoader(std::function<std::string(std::string_view)> fn) { mGmstLoader = std::move(fn); }
+        void setGmstLoader(GmstLoader fn) { mGmstLoader = std::move(fn); }
 
         std::shared_ptr<const MessageBundles> getContext(
             std::string_view contextName, const std::string& fallbackLocale = "en");
@@ -41,7 +41,7 @@ namespace L10n
         const VFS::Manager* mVFS;
         std::vector<icu::Locale> mPreferredLocales;
         std::map<std::tuple<std::string, std::string>, std::shared_ptr<MessageBundles>, std::less<>> mCache;
-        std::function<std::string(std::string_view)> mGmstLoader;
+        GmstLoader mGmstLoader;
     };
 
 }