Add basic parsing for menu lists with only loadMenus instructions

This commit is contained in:
Jan 2021-10-31 15:37:46 +01:00
parent 037e13b874
commit bba55706bf
27 changed files with 602 additions and 1 deletions

View File

@ -0,0 +1,17 @@
#pragma once
#include "Game/IW4/IW4.h"
#include "AssetLoading/BasicAssetLoader.h"
#include "AssetLoading/IAssetLoadingManager.h"
#include "SearchPath/ISearchPath.h"
namespace IW4
{
class AssetLoaderMenuDef final : public BasicAssetLoader<ASSET_TYPE_MENU, menuDef_t>
{
public:
_NODISCARD void* CreateEmptyAsset(const std::string& assetName, MemoryManager* memory) override;
_NODISCARD bool CanLoadFromRaw() const override;
bool LoadFromRaw(const std::string& assetName, ISearchPath* searchPath, MemoryManager* memory, IAssetLoadingManager* manager, Zone* zone) const override;
};
}

View File

@ -0,0 +1,46 @@
#include "AssetLoaderMenuList.h"
#include <cstring>
#include <iostream>
#include "Game/IW4/IW4.h"
#include "Parsing/Menu/MenuFileReader.h"
#include "Pool/GlobalAssetPool.h"
using namespace IW4;
void* AssetLoaderMenuList::CreateEmptyAsset(const std::string& assetName, MemoryManager* memory)
{
auto* menuList = memory->Create<MenuList>();
memset(menuList, 0, sizeof(MenuList));
menuList->name = memory->Dup(assetName.c_str());
return menuList;
}
bool AssetLoaderMenuList::CanLoadFromRaw() const
{
return true;
}
bool AssetLoaderMenuList::LoadFromRaw(const std::string& assetName, ISearchPath* searchPath, MemoryManager* memory, IAssetLoadingManager* manager, Zone* zone) const
{
const auto file = searchPath->Open(assetName);
if (!file.IsOpen())
return false;
MenuFileReader reader(*file.m_stream, assetName, [searchPath](const std::string& filename) -> std::unique_ptr<std::istream>
{
auto foundFileToInclude = searchPath->Open(filename);
if (!foundFileToInclude.IsOpen() || !foundFileToInclude.m_stream)
return nullptr;
return std::move(foundFileToInclude.m_stream);
});
if(!reader.ReadMenuFile(MenuFeatureLevel::IW4))
{
std::cout << "Could not read menu list \"" << assetName << "\"\n";
}
return true;
}

View File

@ -0,0 +1,17 @@
#pragma once
#include "Game/IW4/IW4.h"
#include "AssetLoading/BasicAssetLoader.h"
#include "AssetLoading/IAssetLoadingManager.h"
#include "SearchPath/ISearchPath.h"
namespace IW4
{
class AssetLoaderMenuList final : public BasicAssetLoader<ASSET_TYPE_MENULIST, MenuList>
{
public:
_NODISCARD void* CreateEmptyAsset(const std::string& assetName, MemoryManager* memory) override;
_NODISCARD bool CanLoadFromRaw() const override;
bool LoadFromRaw(const std::string& assetName, ISearchPath* searchPath, MemoryManager* memory, IAssetLoadingManager* manager, Zone* zone) const override;
};
}

View File

@ -5,6 +5,7 @@
#include "ObjContainer/IPak/IPak.h" #include "ObjContainer/IPak/IPak.h"
#include "ObjLoading.h" #include "ObjLoading.h"
#include "AssetLoaders/AssetLoaderLocalizeEntry.h" #include "AssetLoaders/AssetLoaderLocalizeEntry.h"
#include "AssetLoaders/AssetLoaderMenuList.h"
#include "AssetLoaders/AssetLoaderRawFile.h" #include "AssetLoaders/AssetLoaderRawFile.h"
#include "AssetLoading/AssetLoadingManager.h" #include "AssetLoading/AssetLoadingManager.h"
#include "Image/Dx9TextureLoader.h" #include "Image/Dx9TextureLoader.h"
@ -43,7 +44,7 @@ ObjLoader::ObjLoader()
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_GFXWORLD, GfxWorld)) REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_GFXWORLD, GfxWorld))
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_LIGHT_DEF, GfxLightDef)) REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_LIGHT_DEF, GfxLightDef))
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_FONT, Font_s)) REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_FONT, Font_s))
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_MENULIST, MenuList)) REGISTER_ASSET_LOADER(AssetLoaderMenuList)
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_MENU, menuDef_t)) REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_MENU, menuDef_t))
REGISTER_ASSET_LOADER(AssetLoaderLocalizeEntry) REGISTER_ASSET_LOADER(AssetLoaderLocalizeEntry)
REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_WEAPON, WeaponCompleteDef)) REGISTER_ASSET_LOADER(BASIC_LOADER(ASSET_TYPE_WEAPON, WeaponCompleteDef))

View File

@ -0,0 +1,9 @@
#pragma once
#include <string>
class CommonFunctionDef
{
public:
std::string m_name;
};

View File

@ -0,0 +1,9 @@
#pragma once
#include <string>
class CommonItemDef
{
public:
std::string m_name;
};

View File

@ -0,0 +1,13 @@
#pragma once
#include <string>
#include <vector>
#include "CommonItemDef.h"
class CommonMenuDef
{
public:
std::string m_name;
std::vector<std::unique_ptr<CommonItemDef>> m_items;
};

View File

@ -0,0 +1,7 @@
#pragma once
enum class MenuFeatureLevel
{
IW4,
IW5
};

View File

@ -0,0 +1,82 @@
#include "MenuFileParser.h"
#include "Sequence/SequenceCloseBlock.h"
#include "Sequence/SequenceFunctionDef.h"
#include "Sequence/SequenceItemDef.h"
#include "Sequence/SequenceLoadMenu.h"
#include "Sequence/SequenceMenuDef.h"
#include "Sequence/SequenceOpenGlobalScopeBlock.h"
MenuFileParser::MenuFileParser(SimpleLexer* lexer, const MenuFeatureLevel featureLevel)
: AbstractParser(lexer, std::make_unique<MenuFileParserState>(featureLevel))
{
CreateTestCollections();
}
void MenuFileParser::AddTest(std::vector<sequence_t*>& collection, std::unique_ptr<sequence_t> test)
{
collection.push_back(test.get());
m_all_tests.emplace_back(std::move(test));
}
void MenuFileParser::CreateNoScopeTests()
{
AddTest(m_no_scope_tests, std::make_unique<SequenceOpenGlobalScopeBlock>());
}
void MenuFileParser::CreateGlobalScopeTests()
{
AddTest(m_global_scope_tests, std::make_unique<SequenceCloseBlock>());
AddTest(m_global_scope_tests, std::make_unique<SequenceMenuDef>());
AddTest(m_global_scope_tests, std::make_unique<SequenceFunctionDef>());
AddTest(m_global_scope_tests, std::make_unique<SequenceLoadMenu>());
}
void MenuFileParser::CreateFunctionScopeTests()
{
AddTest(m_function_scope_tests, std::make_unique<SequenceCloseBlock>());
}
void MenuFileParser::CreateMenuScopeTests()
{
AddTest(m_menu_scope_tests, std::make_unique<SequenceCloseBlock>());
AddTest(m_menu_scope_tests, std::make_unique<SequenceItemDef>());
}
void MenuFileParser::CreateItemScopeTests()
{
AddTest(m_item_scope_tests, std::make_unique<SequenceCloseBlock>());
}
void MenuFileParser::CreateTestCollections()
{
m_all_tests.clear();
m_no_scope_tests.clear();
m_global_scope_tests.clear();
m_function_scope_tests.clear();
m_menu_scope_tests.clear();
m_item_scope_tests.clear();
CreateNoScopeTests();
CreateGlobalScopeTests();
CreateFunctionScopeTests();
CreateMenuScopeTests();
CreateItemScopeTests();
}
const std::vector<MenuFileParser::sequence_t*>& MenuFileParser::GetTestsForState()
{
if (!m_state->m_in_global_scope)
return m_no_scope_tests;
if (m_state->m_current_item)
return m_item_scope_tests;
if (m_state->m_current_function)
return m_function_scope_tests;
if (m_state->m_current_menu)
return m_menu_scope_tests;
return m_global_scope_tests;
}

View File

@ -0,0 +1,30 @@
#pragma once
#include "MenuFileParserState.h"
#include "Parsing/Simple/SimpleLexer.h"
#include "Parsing/Simple/SimpleParserValue.h"
#include "Parsing/Impl/AbstractParser.h"
class MenuFileParser final : public AbstractParser<SimpleParserValue, MenuFileParserState>
{
std::vector<std::unique_ptr<sequence_t>> m_all_tests;
std::vector<sequence_t*> m_no_scope_tests;
std::vector<sequence_t*> m_global_scope_tests;
std::vector<sequence_t*> m_function_scope_tests;
std::vector<sequence_t*> m_menu_scope_tests;
std::vector<sequence_t*> m_item_scope_tests;
void AddTest(std::vector<sequence_t*>& collection, std::unique_ptr<sequence_t> test);
void CreateNoScopeTests();
void CreateGlobalScopeTests();
void CreateFunctionScopeTests();
void CreateMenuScopeTests();
void CreateItemScopeTests();
void CreateTestCollections();
protected:
const std::vector<sequence_t*>& GetTestsForState() override;
public:
MenuFileParser(SimpleLexer* lexer, MenuFeatureLevel featureLevel);
};

View File

@ -0,0 +1,7 @@
#include "MenuFileParserState.h"
MenuFileParserState::MenuFileParserState(const MenuFeatureLevel featureLevel)
: m_feature_level(featureLevel),
m_in_global_scope(false)
{
}

View File

@ -0,0 +1,29 @@
#pragma once
#include <map>
#include <memory>
#include <vector>
#include "Domain/CommonFunctionDef.h"
#include "Domain/CommonMenuDef.h"
#include "Domain/MenuFeatureLevel.h"
class MenuFileParserState
{
public:
const MenuFeatureLevel m_feature_level;
std::vector<std::string> m_menus_to_load;
std::vector<std::unique_ptr<CommonFunctionDef>> m_functions;
std::vector<std::unique_ptr<CommonMenuDef>> m_menus;
std::map<std::string, CommonFunctionDef*> m_functions_by_name;
std::map<std::string, CommonMenuDef*> m_menus_by_name;
bool m_in_global_scope;
std::unique_ptr<CommonFunctionDef> m_current_function;
std::unique_ptr<CommonMenuDef> m_current_menu;
std::unique_ptr<CommonItemDef> m_current_item;
explicit MenuFileParserState(MenuFeatureLevel featureLevel);
};

View File

@ -0,0 +1,58 @@
#include "MenuFileReader.h"
#include "MenuFileParser.h"
#include "Parsing/Impl/CommentRemovingStreamProxy.h"
#include "Parsing/Impl/DefinesStreamProxy.h"
#include "Parsing/Impl/IncludingStreamProxy.h"
#include "Parsing/Impl/ParserMultiInputStream.h"
#include "Parsing/Impl/ParserSingleInputStream.h"
#include "Parsing/Simple/SimpleLexer.h"
MenuFileReader::MenuFileReader(std::istream& stream, std::string fileName, include_callback_t includeCallback)
: m_file_name(std::move(fileName)),
m_stream(nullptr)
{
OpenBaseStream(stream, std::move(includeCallback));
SetupStreamProxies();
m_stream = m_open_streams.back().get();
}
MenuFileReader::MenuFileReader(std::istream& stream, std::string fileName)
: m_file_name(std::move(fileName)),
m_stream(nullptr)
{
OpenBaseStream(stream, nullptr);
SetupStreamProxies();
m_stream = m_open_streams.back().get();
}
bool MenuFileReader::OpenBaseStream(std::istream& stream, include_callback_t includeCallback)
{
if(includeCallback)
m_open_streams.emplace_back(std::make_unique<ParserMultiInputStream>(stream, m_file_name, std::move(includeCallback)));
else
m_open_streams.emplace_back(std::make_unique<ParserSingleInputStream>(stream, m_file_name));
return true;
}
void MenuFileReader::SetupStreamProxies()
{
m_open_streams.emplace_back(std::make_unique<CommentRemovingStreamProxy>(m_open_streams.back().get()));
m_open_streams.emplace_back(std::make_unique<IncludingStreamProxy>(m_open_streams.back().get()));
m_open_streams.emplace_back(std::make_unique<DefinesStreamProxy>(m_open_streams.back().get()));
m_stream = m_open_streams.back().get();
}
bool MenuFileReader::ReadMenuFile(MenuFeatureLevel featureLevel)
{
const auto lexer = std::make_unique<SimpleLexer>(m_stream, SimpleLexer::Config{false, true, false});
const auto parser = std::make_unique<MenuFileParser>(lexer.get(), featureLevel);
if (parser->Parse())
return true;
std::cout << "Parsing menu file failed!" << std::endl;
return false;
}

View File

@ -0,0 +1,28 @@
#pragma once
#include <memory>
#include <string>
#include <vector>
#include "Domain/MenuFeatureLevel.h"
#include "Parsing/IParserLineStream.h"
class MenuFileReader
{
public:
using include_callback_t = std::function<std::unique_ptr<std::istream>(const std::string& filename)>;
private:
std::string m_file_name;
IParserLineStream* m_stream;
std::vector<std::unique_ptr<IParserLineStream>> m_open_streams;
bool OpenBaseStream(std::istream& stream, include_callback_t includeCallback);
void SetupStreamProxies();
public:
MenuFileReader(std::istream& stream, std::string fileName);
MenuFileReader(std::istream& stream, std::string fileName, include_callback_t includeCallback);
bool ReadMenuFile(MenuFeatureLevel featureLevel);
};

View File

@ -0,0 +1,67 @@
#include "SequenceCloseBlock.h"
#include <sstream>
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceCloseBlock::SequenceCloseBlock()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Char('}').Capture(CAPTURE_TOKEN)
});
}
void SequenceCloseBlock::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(state->m_current_item || state->m_current_menu || state->m_current_function || state->m_in_global_scope);
assert(!state->m_current_item || (state->m_current_item && state->m_current_menu));
if(state->m_current_item && state->m_current_menu)
{
state->m_current_menu->m_items.emplace_back(std::move(state->m_current_item));
state->m_current_item = nullptr;
}
else if(state->m_current_menu)
{
if(state->m_current_menu->m_name.empty())
throw ParsingException(result.NextCapture(CAPTURE_TOKEN).GetPos(), "Menu must have a name");
const auto existingMenu = state->m_menus_by_name.find(state->m_current_menu->m_name);
if(existingMenu == state->m_menus_by_name.end())
{
state->m_menus_by_name.emplace(std::make_pair(state->m_current_menu->m_name, state->m_current_menu.get()));
state->m_menus.emplace_back(std::move(state->m_current_menu));
state->m_current_menu = nullptr;
}
else
{
std::ostringstream ss;
ss << "Menu with name \"" << state->m_current_menu->m_name << "\" already exists";
throw ParsingException(result.NextCapture(CAPTURE_TOKEN).GetPos(), ss.str());
}
}
else if(state->m_current_function)
{
const auto existingFunction = state->m_functions_by_name.find(state->m_current_function->m_name);
if (existingFunction == state->m_functions_by_name.end())
{
state->m_functions_by_name.emplace(std::make_pair(state->m_current_function->m_name, state->m_current_function.get()));
state->m_functions.emplace_back(std::move(state->m_current_function));
state->m_current_function = nullptr;
}
else
{
std::ostringstream ss;
ss << "Function with name \"" << state->m_current_menu->m_name << "\" already exists";
throw ParsingException(result.NextCapture(CAPTURE_TOKEN).GetPos(), ss.str());
}
}
else if(state->m_in_global_scope)
{
state->m_in_global_scope = false;
}
else
throw ParsingException(result.NextCapture(CAPTURE_TOKEN).GetPos(), "Invalid close block");
}

View File

@ -0,0 +1,14 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceCloseBlock final : public MenuFileParser::sequence_t
{
static constexpr auto CAPTURE_TOKEN = 1;
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceCloseBlock();
};

View File

@ -0,0 +1,20 @@
#include "SequenceFunctionDef.h"
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceFunctionDef::SequenceFunctionDef()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Keyword("functionDef"),
create.Char('{'),
});
}
void SequenceFunctionDef::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(!state->m_current_menu);
state->m_current_item = std::make_unique<CommonItemDef>();
}

View File

@ -0,0 +1,12 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceFunctionDef final : public MenuFileParser::sequence_t
{
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceFunctionDef();
};

View File

@ -0,0 +1,20 @@
#include "SequenceItemDef.h"
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceItemDef::SequenceItemDef()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Keyword("itemDef"),
create.Char('{'),
});
}
void SequenceItemDef::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(!state->m_current_menu);
state->m_current_item = std::make_unique<CommonItemDef>();
}

View File

@ -0,0 +1,12 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceItemDef final : public MenuFileParser::sequence_t
{
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceItemDef();
};

View File

@ -0,0 +1,27 @@
#include "SequenceLoadMenu.h"
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceLoadMenu::SequenceLoadMenu()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Keyword("loadMenu"),
create.Char('{'),
create.String().Capture(CAPTURE_MENU_NAME),
create.Char('}'),
});
}
void SequenceLoadMenu::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(!state->m_current_menu);
const auto& menuNameToken = result.NextCapture(CAPTURE_MENU_NAME);
if (menuNameToken.StringValue().empty())
throw ParsingException(menuNameToken.GetPos(), "Invalid menu name");
state->m_menus_to_load.emplace_back(menuNameToken.StringValue());
}

View File

@ -0,0 +1,14 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceLoadMenu final : public MenuFileParser::sequence_t
{
static constexpr auto CAPTURE_MENU_NAME = 1;
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceLoadMenu();
};

View File

@ -0,0 +1,20 @@
#include "SequenceMenuDef.h"
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceMenuDef::SequenceMenuDef()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Keyword("menuDef"),
create.Char('{'),
});
}
void SequenceMenuDef::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(!state->m_current_menu);
state->m_current_menu = std::make_unique<CommonMenuDef>();
}

View File

@ -0,0 +1,12 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceMenuDef final : public MenuFileParser::sequence_t
{
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceMenuDef();
};

View File

@ -0,0 +1,18 @@
#include "SequenceOpenGlobalScopeBlock.h"
#include "Parsing/Simple/Matcher/SimpleMatcherFactory.h"
SequenceOpenGlobalScopeBlock::SequenceOpenGlobalScopeBlock()
{
const SimpleMatcherFactory create(this);
AddMatchers({
create.Char('{')
});
}
void SequenceOpenGlobalScopeBlock::ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const
{
assert(!state->m_in_global_scope);
state->m_in_global_scope = true;
}

View File

@ -0,0 +1,12 @@
#pragma once
#include "Parsing/Menu/MenuFileParser.h"
class SequenceOpenGlobalScopeBlock final : public MenuFileParser::sequence_t
{
protected:
void ProcessMatch(MenuFileParserState* state, SequenceResult<SimpleParserValue>& result) const override;
public:
SequenceOpenGlobalScopeBlock();
};