INSANEMODE/OpenAssetTools
1
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-06-10 14:58:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add permissive mode for menu parsing that accepts unknown script tokens as long as they can be put into the script

Browse Source
This commit is contained in:
Jan
2021-11-28 17:55:26 +01:00
parent e94c48338c
commit b082e471e7
24 changed files with 200 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
test/ObjLoadingTests/Parsing/Menu/Sequence/EventHandlerSetScopeSequencesTests.cpp
View File

@ -22,13 +22,13 @@ namespace test::parsing::menu::sequence::event_handler_set
unsigned m_consumed_token_count;
explicit EventHandlerSetSequenceTestsHelper(FeatureLevel featureLevel)
: m_state(std::make_unique<MenuFileParserState>(featureLevel)),
explicit EventHandlerSetSequenceTestsHelper(FeatureLevel featureLevel, bool permissive)
: m_state(std::make_unique<MenuFileParserState>(featureLevel, false)),
m_event_handler_set(std::make_unique<CommonEventHandlerSet>()),
m_consumed_token_count(0u)
{
EventHandlerSetScopeSequences scopeSequences(m_all_sequences, m_scope_sequences);
scopeSequences.AddSequences(m_state->m_feature_level);
scopeSequences.AddSequences(m_state->m_feature_level, permissive);
m_state->m_current_menu = m_state->m_menus.emplace_back(std::make_unique<CommonMenuDef>()).get();
m_state->m_current_event_handler_set = m_event_handler_set.get();
@ -54,7 +54,10 @@ namespace test::parsing::menu::sequence::event_handler_set
{
const auto couldMatch = sequence->MatchSequence(m_lexer.get(), m_state.get(), m_consumed_token_count);
if (couldMatch)
{
m_lexer->PopTokens(static_cast<int>(m_consumed_token_count));
return couldMatch;
}
}
return false;
@ -64,7 +67,7 @@ namespace test::parsing::menu::sequence::event_handler_set
#pragma region General
TEST_CASE("EventHandlerSetScopeSequences: Keyword casing doesnt matter", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("fadein")),
@ -84,7 +87,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Invalid keywords are not recognized", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("noScriptCommand")),
@ -99,6 +102,43 @@ namespace test::parsing::menu::sequence::event_handler_set
REQUIRE(helper.m_consumed_token_count == 0);
}
TEST_CASE("EventHandlerSetScopeSequences: Permissive mode ignores unknown script tokens and adds them to script", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, true);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("uiScript")),
SimpleParserValue::Identifier(pos, new std::string("somethingUnknown")),
SimpleParserValue::String(pos, new std::string("anArgumentForTheUnknownScript")),
SimpleParserValue::Character(pos, ';'),
SimpleParserValue::EndOfFile(pos)
});
auto result = helper.PerformTest();
REQUIRE(result);
REQUIRE(helper.m_consumed_token_count == 1);
auto script = helper.m_state->m_current_script.str();
REQUIRE(script == R"("uiScript" )");
result = helper.PerformTest();
REQUIRE(result);
REQUIRE(helper.m_consumed_token_count == 1);
script = helper.m_state->m_current_script.str();
REQUIRE(script == R"("uiScript" "somethingUnknown" )");
result = helper.PerformTest();
REQUIRE(result);
REQUIRE(helper.m_consumed_token_count == 1);
script = helper.m_state->m_current_script.str();
REQUIRE(script == R"("uiScript" "somethingUnknown" "anArgumentForTheUnknownScript" )");
result = helper.PerformTest();
REQUIRE(result);
REQUIRE(helper.m_consumed_token_count == 1);
script = helper.m_state->m_current_script.str();
REQUIRE(script == R"("uiScript" "somethingUnknown" "anArgumentForTheUnknownScript" ; )");
}
#pragma endregion
void TestGenericScriptStatement(const std::initializer_list<Movable<SimpleParserValue>> tokens, const std::string& expectedScript)
@ -109,7 +149,7 @@ namespace test::parsing::menu::sequence::event_handler_set
tokenList.emplace_back(SimpleParserValue::Character(TokenPos(), ';'));
tokenList.emplace_back(SimpleParserValue::EndOfFile(TokenPos()));
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
helper.Tokens(std::move(tokenList));
const auto result = helper.PerformTest();
@ -220,7 +260,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Ensure cannot use setColor with no color", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("setColor")),
@ -761,7 +801,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Ensure setLocalVarBool is setLocalVar handler on non-static value", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(TokenPos(), new std::string("setLocalVarBool")),
@ -796,7 +836,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Ensure setLocalVarInt is setLocalVar handler on non-static value", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(TokenPos(), new std::string("setLocalVarInt")),
@ -831,7 +871,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Ensure setLocalVarFloat is setLocalVar handler on non-static value", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(TokenPos(), new std::string("setLocalVarFloat")),
@ -866,7 +906,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Ensure setLocalVarString is setLocalVar handler on non-static value", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(TokenPos(), new std::string("setLocalVarString")),
@ -905,7 +945,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Closing block terminates EventHandlerSet", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -926,7 +966,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Closing block finishes current script", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -955,7 +995,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: If opens new condition", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("if")),
@ -1001,7 +1041,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: If applies current script", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Identifier(pos, new std::string("if")),
@ -1040,7 +1080,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: ElseIf opens new condition", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1094,7 +1134,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: ElseIf applies current script", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1138,7 +1178,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: ElseIf cannot be specified when not in if", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1155,7 +1195,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: ElseIf cannot be specified when else was already used", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1177,7 +1217,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Else switches to else element", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1209,7 +1249,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Else keeps auto_skip value", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1241,7 +1281,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Else cannot be specified when not in if", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1255,7 +1295,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: Else cannot be specified when else was already used", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1274,7 +1314,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: CloseBlock closes if statements", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1299,7 +1339,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: CloseBlock closes nested if statements to parent if statement", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1328,7 +1368,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: CloseBlock closes nested if statements to parent else statement", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1358,7 +1398,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: CloseBlock closes all autoskip conditions to parent if statement", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),
@ -1391,7 +1431,7 @@ namespace test::parsing::menu::sequence::event_handler_set
TEST_CASE("EventHandlerSetScopeSequences: CloseBlock closes all autoskip conditions to base", "[parsing][sequence][menu]")
{
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4);
EventHandlerSetSequenceTestsHelper helper(FeatureLevel::IW4, false);
const TokenPos pos;
helper.Tokens({
SimpleParserValue::Character(pos, '}'),

20
test/ParserTestUtils/Parsing/Mock/MockLexer.h
View File

@ -14,20 +14,20 @@ class MockLexer final : public ILexer<TokenType>
std::vector<TokenType> m_tokens;
TokenType m_eof;
int m_pop_count;
size_t m_pop_count;
public:
MockLexer(std::initializer_list<Movable<TokenType>> tokens, TokenType eof)
: m_tokens(std::make_move_iterator(tokens.begin()), std::make_move_iterator(tokens.end())),
m_eof(std::move(eof)),
m_pop_count(0)
m_pop_count(0u)
{
}
MockLexer(std::vector<TokenType> tokens, TokenType eof)
: m_tokens(std::move(tokens)),
m_eof(std::move(eof)),
m_pop_count(0)
m_pop_count(0u)
{
}
@ -39,28 +39,30 @@ public:
const TokenType& GetToken(const unsigned index) override
{
if (index < m_tokens.size())
return m_tokens[index];
const auto absoluteIndex = m_pop_count + index;
if (absoluteIndex < m_tokens.size())
return m_tokens[absoluteIndex];
return m_eof;
}
void PopTokens(const int amount) override
{
m_pop_count += amount;
assert(amount >= 0);
m_pop_count += static_cast<size_t>(amount);
}
bool IsEof() override
{
return !m_tokens.empty();
return !m_tokens.empty() || m_pop_count >= m_tokens.size();
}
const TokenPos& GetPos() override
{
return !m_tokens.empty() ? m_tokens[0].GetPos() : m_eof.GetPos();
return !m_tokens.empty() && m_pop_count < m_tokens.size() ? m_tokens[m_pop_count].GetPos() : m_eof.GetPos();
}
_NODISCARD int GetPopCount() const
_NODISCARD size_t GetPopCount() const
{
return m_pop_count;
}