Use ZoneState to check whether localize key is duplicated

Laupetin · Dec 31, 2023 · 196e2ed · 196e2ed
1 parent e4cfda7
commit 196e2ed
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 15 deletions.
diff --git a/src/ObjLoading/Game/IW4/AssetLoaders/AssetLoaderLocalizeEntry.cpp b/src/ObjLoading/Game/IW4/AssetLoaders/AssetLoaderLocalizeEntry.cpp
@@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
     if (!file.IsOpen())
         return false;
 
-    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language);
+    auto* zoneState = manager->GetAssetLoadingContext()->GetZoneAssetLoaderState<LocalizeReadingZoneState>();
+    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language, zoneState);
     const auto localizeEntries = reader.ReadLocalizeFile();
 
     for (const auto& [key, value] : localizeEntries)

diff --git a/src/ObjLoading/Game/IW5/AssetLoaders/AssetLoaderLocalizeEntry.cpp b/src/ObjLoading/Game/IW5/AssetLoaders/AssetLoaderLocalizeEntry.cpp
@@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
     if (!file.IsOpen())
         return false;
 
-    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language);
+    auto* zoneState = manager->GetAssetLoadingContext()->GetZoneAssetLoaderState<LocalizeReadingZoneState>();
+    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language, zoneState);
     const auto localizeEntries = reader.ReadLocalizeFile();
 
     for (const auto& [key, value] : localizeEntries)

diff --git a/src/ObjLoading/Game/T5/AssetLoaders/AssetLoaderLocalizeEntry.cpp b/src/ObjLoading/Game/T5/AssetLoaders/AssetLoaderLocalizeEntry.cpp
@@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
     if (!file.IsOpen())
         return false;
 
-    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language);
+    auto* zoneState = manager->GetAssetLoadingContext()->GetZoneAssetLoaderState<LocalizeReadingZoneState>();
+    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language, zoneState);
     const auto localizeEntries = reader.ReadLocalizeFile();
 
     for (const auto& [key, value] : localizeEntries)

diff --git a/src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderLocalizeEntry.cpp b/src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderLocalizeEntry.cpp
@@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
     if (!file.IsOpen())
         return false;
 
-    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language);
+    auto* zoneState = manager->GetAssetLoadingContext()->GetZoneAssetLoaderState<LocalizeReadingZoneState>();
+    LocalizeFileReader reader(*file.m_stream, assetName, zone->m_language, zoneState);
     const auto localizeEntries = reader.ReadLocalizeFile();
 
     for (const auto& [key, value] : localizeEntries)

diff --git a/src/ObjLoading/Localize/LocalizeReadingZoneState.cpp b/src/ObjLoading/Localize/LocalizeReadingZoneState.cpp
@@ -0,0 +1,11 @@
+#include "LocalizeReadingZoneState.h"
+
+bool LocalizeReadingZoneState::DoLocalizeEntryDuplicateCheck(const std::string& key)
+{
+    const auto existingEntry = m_keys.find(key);
+    if (existingEntry != m_keys.end())
+        return false;
+
+    m_keys.emplace(key);
+    return true;
+}
diff --git a/src/ObjLoading/Localize/LocalizeReadingZoneState.h b/src/ObjLoading/Localize/LocalizeReadingZoneState.h
@@ -0,0 +1,22 @@
+#pragma once
+
+#include "AssetLoading/IZoneAssetLoaderState.h"
+
+#include <string>
+#include <unordered_set>
+
+class LocalizeReadingZoneState final : public IZoneAssetLoaderState
+{
+public:
+    /**
+     * Checks whether a localize key was already added.
+     * Inserts key if it was not added yet.
+     *
+     * \param key The key to check
+     * \returns \c true if key was not duplicated yet, \c false otherwise
+     */
+    bool DoLocalizeEntryDuplicateCheck(const std::string& key);
+
+private:
+    std::unordered_set<std::string> m_keys;
+};
diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileParser.cpp b/src/ObjLoading/Localize/Parsing/LocalizeFileParser.cpp
@@ -8,8 +8,8 @@
 #include "Sequence/SequenceLocalizeFileReference.h"
 #include "Sequence/SequenceLocalizeFileVersion.h"
 
-LocalizeFileParser::LocalizeFileParser(SimpleLexer* lexer, GameLanguage language)
-    : AbstractParser(lexer, std::make_unique<LocalizeFileParserState>(language))
+LocalizeFileParser::LocalizeFileParser(SimpleLexer* lexer, GameLanguage language, LocalizeReadingZoneState* zoneState)
+    : AbstractParser(lexer, std::make_unique<LocalizeFileParserState>(language, zoneState))
 {
 }
 

diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileParser.h b/src/ObjLoading/Localize/Parsing/LocalizeFileParser.h
@@ -12,6 +12,6 @@ class LocalizeFileParser final : public AbstractParser<SimpleParserValue, Locali
     const std::vector<sequence_t*>& GetTestsForState() override;
 
 public:
-    LocalizeFileParser(SimpleLexer* lexer, GameLanguage language);
+    LocalizeFileParser(SimpleLexer* lexer, GameLanguage language, LocalizeReadingZoneState* zoneState);
     std::map<std::string, std::string> GetParsedValues();
 };
diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileParserState.cpp b/src/ObjLoading/Localize/Parsing/LocalizeFileParserState.cpp
@@ -2,9 +2,10 @@
 
 #include "Localize/LocalizeCommon.h"
 
-LocalizeFileParserState::LocalizeFileParserState(const GameLanguage language)
+LocalizeFileParserState::LocalizeFileParserState(const GameLanguage language, LocalizeReadingZoneState* zoneState)
     : m_end(false),
-      m_language(language)
+      m_language(language),
+      m_zone_state(zoneState)
 {
     m_language_name_caps = LocalizeCommon::GetNameOfLanguage(m_language);
     for (auto& c : m_language_name_caps)

diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileParserState.h b/src/ObjLoading/Localize/Parsing/LocalizeFileParserState.h
@@ -1,5 +1,7 @@
 #pragma once
+
 #include "Game/GameLanguage.h"
+#include "Localize/LocalizeReadingZoneState.h"
 
 #include <map>
 #include <unordered_set>
@@ -12,10 +14,11 @@ class LocalizeFileParserState
     std::map<std::string, std::string> m_entries;
 
     GameLanguage m_language;
+    LocalizeReadingZoneState* m_zone_state;
     std::string m_language_name_caps;
 
     std::string m_current_reference;
     std::unordered_set<std::string> m_current_reference_languages;
 
-    explicit LocalizeFileParserState(GameLanguage language);
+    LocalizeFileParserState(GameLanguage language, LocalizeReadingZoneState* zoneState);
 };
diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileReader.cpp b/src/ObjLoading/Localize/Parsing/LocalizeFileReader.cpp
@@ -4,10 +4,11 @@
 #include "Parsing/Impl/CommentRemovingStreamProxy.h"
 #include "Parsing/Impl/ParserSingleInputStream.h"
 
-LocalizeFileReader::LocalizeFileReader(std::istream& stream, std::string fileName, GameLanguage language)
+LocalizeFileReader::LocalizeFileReader(std::istream& stream, std::string fileName, GameLanguage language, LocalizeReadingZoneState* zoneState)
     : m_file_name(std::move(fileName)),
       m_stream(nullptr),
-      m_language(language)
+      m_language(language),
+      m_zone_state(zoneState)
 {
     OpenBaseStream(stream);
     SetupStreamProxies();
@@ -37,7 +38,7 @@ std::map<std::string, std::string> LocalizeFileReader::ReadLocalizeFile()
     lexerConfig.m_read_floating_point_numbers = false;
     const auto lexer = std::make_unique<SimpleLexer>(m_stream, std::move(lexerConfig));
 
-    const auto parser = std::make_unique<LocalizeFileParser>(lexer.get(), m_language);
+    const auto parser = std::make_unique<LocalizeFileParser>(lexer.get(), m_language, m_zone_state);
 
     if (parser->Parse())
         return parser->GetParsedValues();

diff --git a/src/ObjLoading/Localize/Parsing/LocalizeFileReader.h b/src/ObjLoading/Localize/Parsing/LocalizeFileReader.h
@@ -1,6 +1,7 @@
 #pragma once
 
 #include "Game/GameLanguage.h"
+#include "Localize/LocalizeReadingZoneState.h"
 #include "Parsing/IParserLineStream.h"
 
 #include <map>
@@ -14,12 +15,13 @@ class LocalizeFileReader
     IParserLineStream* m_stream;
     std::vector<std::unique_ptr<IParserLineStream>> m_open_streams;
     GameLanguage m_language;
+    LocalizeReadingZoneState* m_zone_state;
 
     bool OpenBaseStream(std::istream& stream);
     void SetupStreamProxies();
 
 public:
-    LocalizeFileReader(std::istream& stream, std::string fileName, GameLanguage language);
+    LocalizeFileReader(std::istream& stream, std::string fileName, GameLanguage language, LocalizeReadingZoneState* zoneState);
 
     std::map<std::string, std::string> ReadLocalizeFile();
 };
diff --git a/src/ObjLoading/Localize/Parsing/Sequence/SequenceLocalizeFileLanguageValue.cpp b/src/ObjLoading/Localize/Parsing/Sequence/SequenceLocalizeFileLanguageValue.cpp
@@ -33,7 +33,7 @@ void SequenceLocalizeFileLanguageValue::ProcessMatch(LocalizeFileParserState* st
     if (langName == state->m_language_name_caps)
     {
         const auto& currentReference = state->m_current_reference;
-        if (const auto i = state->m_entries.find(currentReference); i != state->m_entries.end())
+        if (!state->m_zone_state->DoLocalizeEntryDuplicateCheck(currentReference))
         {
             std::cout << "Localize: a value for reference \"" << currentReference << "\" was already defined\n";
         }