Use ZoneState to check whether localize key is duplicated

This commit is contained in:
Jan 2023-12-31 12:28:13 +01:00
parent e4cfda73dc
commit 196e2edd8a
No known key found for this signature in database
GPG Key ID: 44B581F78FF5C57C
13 changed files with 59 additions and 15 deletions

View File

@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
if (!file.IsOpen()) if (!file.IsOpen())
return false; 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(); const auto localizeEntries = reader.ReadLocalizeFile();
for (const auto& [key, value] : localizeEntries) for (const auto& [key, value] : localizeEntries)

View File

@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
if (!file.IsOpen()) if (!file.IsOpen())
return false; 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(); const auto localizeEntries = reader.ReadLocalizeFile();
for (const auto& [key, value] : localizeEntries) for (const auto& [key, value] : localizeEntries)

View File

@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
if (!file.IsOpen()) if (!file.IsOpen())
return false; 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(); const auto localizeEntries = reader.ReadLocalizeFile();
for (const auto& [key, value] : localizeEntries) for (const auto& [key, value] : localizeEntries)

View File

@ -36,7 +36,8 @@ bool AssetLoaderLocalizeEntry::LoadFromRaw(
if (!file.IsOpen()) if (!file.IsOpen())
return false; 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(); const auto localizeEntries = reader.ReadLocalizeFile();
for (const auto& [key, value] : localizeEntries) for (const auto& [key, value] : localizeEntries)

View File

@ -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;
}

View File

@ -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;
};

View File

@ -8,8 +8,8 @@
#include "Sequence/SequenceLocalizeFileReference.h" #include "Sequence/SequenceLocalizeFileReference.h"
#include "Sequence/SequenceLocalizeFileVersion.h" #include "Sequence/SequenceLocalizeFileVersion.h"
LocalizeFileParser::LocalizeFileParser(SimpleLexer* lexer, GameLanguage language) LocalizeFileParser::LocalizeFileParser(SimpleLexer* lexer, GameLanguage language, LocalizeReadingZoneState* zoneState)
: AbstractParser(lexer, std::make_unique<LocalizeFileParserState>(language)) : AbstractParser(lexer, std::make_unique<LocalizeFileParserState>(language, zoneState))
{ {
} }

View File

@ -12,6 +12,6 @@ protected:
const std::vector<sequence_t*>& GetTestsForState() override; const std::vector<sequence_t*>& GetTestsForState() override;
public: public:
LocalizeFileParser(SimpleLexer* lexer, GameLanguage language); LocalizeFileParser(SimpleLexer* lexer, GameLanguage language, LocalizeReadingZoneState* zoneState);
std::map<std::string, std::string> GetParsedValues(); std::map<std::string, std::string> GetParsedValues();
}; };

View File

@ -2,9 +2,10 @@
#include "Localize/LocalizeCommon.h" #include "Localize/LocalizeCommon.h"
LocalizeFileParserState::LocalizeFileParserState(const GameLanguage language) LocalizeFileParserState::LocalizeFileParserState(const GameLanguage language, LocalizeReadingZoneState* zoneState)
: m_end(false), : m_end(false),
m_language(language) m_language(language),
m_zone_state(zoneState)
{ {
m_language_name_caps = LocalizeCommon::GetNameOfLanguage(m_language); m_language_name_caps = LocalizeCommon::GetNameOfLanguage(m_language);
for (auto& c : m_language_name_caps) for (auto& c : m_language_name_caps)

View File

@ -1,5 +1,7 @@
#pragma once #pragma once
#include "Game/GameLanguage.h" #include "Game/GameLanguage.h"
#include "Localize/LocalizeReadingZoneState.h"
#include <map> #include <map>
#include <unordered_set> #include <unordered_set>
@ -12,10 +14,11 @@ public:
std::map<std::string, std::string> m_entries; std::map<std::string, std::string> m_entries;
GameLanguage m_language; GameLanguage m_language;
LocalizeReadingZoneState* m_zone_state;
std::string m_language_name_caps; std::string m_language_name_caps;
std::string m_current_reference; std::string m_current_reference;
std::unordered_set<std::string> m_current_reference_languages; std::unordered_set<std::string> m_current_reference_languages;
explicit LocalizeFileParserState(GameLanguage language); LocalizeFileParserState(GameLanguage language, LocalizeReadingZoneState* zoneState);
}; };

View File

@ -4,10 +4,11 @@
#include "Parsing/Impl/CommentRemovingStreamProxy.h" #include "Parsing/Impl/CommentRemovingStreamProxy.h"
#include "Parsing/Impl/ParserSingleInputStream.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_file_name(std::move(fileName)),
m_stream(nullptr), m_stream(nullptr),
m_language(language) m_language(language),
m_zone_state(zoneState)
{ {
OpenBaseStream(stream); OpenBaseStream(stream);
SetupStreamProxies(); SetupStreamProxies();
@ -37,7 +38,7 @@ std::map<std::string, std::string> LocalizeFileReader::ReadLocalizeFile()
lexerConfig.m_read_floating_point_numbers = false; lexerConfig.m_read_floating_point_numbers = false;
const auto lexer = std::make_unique<SimpleLexer>(m_stream, std::move(lexerConfig)); 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()) if (parser->Parse())
return parser->GetParsedValues(); return parser->GetParsedValues();

View File

@ -1,6 +1,7 @@
#pragma once #pragma once
#include "Game/GameLanguage.h" #include "Game/GameLanguage.h"
#include "Localize/LocalizeReadingZoneState.h"
#include "Parsing/IParserLineStream.h" #include "Parsing/IParserLineStream.h"
#include <map> #include <map>
@ -14,12 +15,13 @@ class LocalizeFileReader
IParserLineStream* m_stream; IParserLineStream* m_stream;
std::vector<std::unique_ptr<IParserLineStream>> m_open_streams; std::vector<std::unique_ptr<IParserLineStream>> m_open_streams;
GameLanguage m_language; GameLanguage m_language;
LocalizeReadingZoneState* m_zone_state;
bool OpenBaseStream(std::istream& stream); bool OpenBaseStream(std::istream& stream);
void SetupStreamProxies(); void SetupStreamProxies();
public: 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(); std::map<std::string, std::string> ReadLocalizeFile();
}; };

View File

@ -33,7 +33,7 @@ void SequenceLocalizeFileLanguageValue::ProcessMatch(LocalizeFileParserState* st
if (langName == state->m_language_name_caps) if (langName == state->m_language_name_caps)
{ {
const auto& currentReference = state->m_current_reference; 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"; std::cout << "Localize: a value for reference \"" << currentReference << "\" was already defined\n";
} }