refactor: rework search paths

This commit is contained in:
Jan
2024-10-27 19:21:47 +01:00
parent fd421c4784
commit be6c30c503
24 changed files with 1072 additions and 1066 deletions

View File

@ -4,16 +4,17 @@
#include "ContentLister/ZoneDefWriter.h"
#include "IObjLoader.h"
#include "IObjWriter.h"
#include "ObjContainer/IWD/IWD.h"
#include "ObjLoading.h"
#include "ObjWriting.h"
#include "SearchPath/IWD.h"
#include "SearchPath/SearchPathFilesystem.h"
#include "SearchPath/SearchPaths.h"
#include "UnlinkerArgs.h"
#include "UnlinkerPaths.h"
#include "Utils/ClassUtils.h"
#include "Utils/ObjFileStream.h"
#include "ZoneLoading.h"
#include <cassert>
#include <filesystem>
#include <format>
#include <fstream>
@ -37,13 +38,14 @@ public:
if (!shouldContinue)
return true;
if (!BuildSearchPaths())
UnlinkerPaths paths;
if (!paths.LoadUserPaths(m_args))
return false;
if (!LoadZones())
if (!LoadZones(paths))
return false;
const auto result = UnlinkZones();
const auto result = UnlinkZones(paths);
UnloadZones();
return result;
@ -55,106 +57,6 @@ private:
return m_args.m_task != UnlinkerArgs::ProcessingTask::LIST && !m_args.m_skip_obj;
}
/**
* \brief Loads a search path.
* \param searchPath The search path to load.
*/
void LoadSearchPath(ISearchPath& searchPath) const
{
if (ShouldLoadObj())
{
if (m_args.m_verbose)
std::cout << std::format("Loading search path: \"{}\"\n", searchPath.GetPath());
ObjLoading::LoadIWDsInSearchPath(searchPath);
}
}
/**
* \brief Unloads a search path.
* \param searchPath The search path to unload.
*/
void UnloadSearchPath(ISearchPath& searchPath) const
{
if (ShouldLoadObj())
{
if (m_args.m_verbose)
std::cout << std::format("Unloading search path: \"{}\"\n", searchPath.GetPath());
ObjLoading::UnloadIWDsInSearchPath(searchPath);
}
}
/**
* \brief Loads all search paths that are valid for the specified zone and returns them.
* \param zonePath The path to the zone file that should be prepared for.
* \return A \c SearchPaths object that contains all search paths that should be considered when loading the specified zone.
*/
SearchPaths GetSearchPathsForZone(const std::string& zonePath)
{
SearchPaths searchPathsForZone;
const auto absoluteZoneDirectory = fs::absolute(std::filesystem::path(zonePath).remove_filename()).string();
if (m_last_zone_search_path != nullptr && m_last_zone_search_path->GetPath() == absoluteZoneDirectory)
{
searchPathsForZone.IncludeSearchPath(m_last_zone_search_path.get());
}
else if (m_absolute_search_paths.find(absoluteZoneDirectory) == m_absolute_search_paths.end())
{
if (m_last_zone_search_path)
{
UnloadSearchPath(*m_last_zone_search_path);
}
m_last_zone_search_path = std::make_unique<SearchPathFilesystem>(absoluteZoneDirectory);
searchPathsForZone.IncludeSearchPath(m_last_zone_search_path.get());
LoadSearchPath(*m_last_zone_search_path);
}
for (auto* iwd : IWD::Repository)
{
searchPathsForZone.IncludeSearchPath(iwd);
}
return searchPathsForZone;
}
/**
* \brief Initializes the Unlinker object's search paths based on the user's input.
* \return \c true if building the search paths was successful, otherwise \c false.
*/
bool BuildSearchPaths()
{
for (const auto& path : m_args.m_user_search_paths)
{
auto absolutePath = fs::absolute(path);
if (!fs::is_directory(absolutePath))
{
std::cerr << std::format("Could not find directory of search path: \"{}\"\n", path);
return false;
}
auto searchPath = std::make_unique<SearchPathFilesystem>(absolutePath.string());
LoadSearchPath(*searchPath);
m_search_paths.CommitSearchPath(std::move(searchPath));
m_absolute_search_paths.insert(absolutePath.string());
}
if (m_args.m_verbose)
{
std::cout << std::format("{} SearchPaths{}\n", m_absolute_search_paths.size(), !m_absolute_search_paths.empty() ? ":" : "");
for (const auto& absoluteSearchPath : m_absolute_search_paths)
std::cout << std::format(" \"{}\"\n", absoluteSearchPath);
if (!m_absolute_search_paths.empty())
std::cerr << "\n";
}
return true;
}
bool WriteZoneDefinitionFile(const Zone& zone, const fs::path& zoneDefinitionFileFolder) const
{
auto zoneDefinitionFilePath(zoneDefinitionFileFolder);
@ -251,7 +153,7 @@ private:
* \brief Performs the tasks specified by the command line arguments on the specified zone.
* \param searchPath The search path for obj data.
* \param zone The zone to handle.
* \return \c true if handling the zone was successful, otherwise \c false.
* \return \c true if handling the zone was successful, otherwise \c false
*/
bool HandleZone(ISearchPath& searchPath, Zone& zone) const
{
@ -310,7 +212,7 @@ private:
return true;
}
bool LoadZones()
bool LoadZones(UnlinkerPaths& paths)
{
for (const auto& zonePath : m_args.m_zones_to_load)
{
@ -322,9 +224,7 @@ private:
auto absoluteZoneDirectory = absolute(std::filesystem::path(zonePath).remove_filename()).string();
auto searchPathsForZone = GetSearchPathsForZone(absoluteZoneDirectory);
searchPathsForZone.IncludeSearchPath(&m_search_paths);
auto searchPathsForZone = paths.GetSearchPathsForZone(absoluteZoneDirectory);
auto zone = ZoneLoading::LoadZone(zonePath);
if (zone == nullptr)
{
@ -338,7 +238,7 @@ private:
if (ShouldLoadObj())
{
const auto* objLoader = IObjLoader::GetObjLoaderForGame(zone->m_game->GetId());
objLoader->LoadReferencedContainersForZone(searchPathsForZone, *zone);
objLoader->LoadReferencedContainersForZone(*searchPathsForZone, *zone);
}
m_loaded_zones.emplace_back(std::move(zone));
@ -370,7 +270,7 @@ private:
m_loaded_zones.clear();
}
bool UnlinkZones()
bool UnlinkZones(UnlinkerPaths& paths) const
{
for (const auto& zonePath : m_args.m_zones_to_unlink)
{
@ -385,8 +285,7 @@ private:
zoneDirectory = fs::current_path();
auto absoluteZoneDirectory = absolute(zoneDirectory).string();
auto searchPathsForZone = GetSearchPathsForZone(absoluteZoneDirectory);
searchPathsForZone.IncludeSearchPath(&m_search_paths);
auto searchPathsForZone = paths.GetSearchPathsForZone(absoluteZoneDirectory);
std::string zoneName;
auto zone = ZoneLoading::LoadZone(zonePath);
@ -402,9 +301,9 @@ private:
const auto* objLoader = IObjLoader::GetObjLoaderForGame(zone->m_game->GetId());
if (ShouldLoadObj())
objLoader->LoadReferencedContainersForZone(searchPathsForZone, *zone);
objLoader->LoadReferencedContainersForZone(*searchPathsForZone, *zone);
if (!HandleZone(searchPathsForZone, *zone))
if (!HandleZone(*searchPathsForZone, *zone))
return false;
if (ShouldLoadObj())
@ -419,10 +318,6 @@ private:
}
UnlinkerArgs m_args;
SearchPaths m_search_paths;
std::unique_ptr<SearchPathFilesystem> m_last_zone_search_path;
std::set<std::string> m_absolute_search_paths;
std::vector<std::unique_ptr<Zone>> m_loaded_zones;
};

View File

@ -1,7 +1,9 @@
#pragma once
#include "Utils/Arguments/ArgumentParser.h"
#include "Zone/Zone.h"
#include <cstdint>
#include <regex>
#include <set>
#include <string>
@ -37,7 +39,7 @@ public:
LIST
};
enum class AssetTypeHandling
enum class AssetTypeHandling : std::uint8_t
{
EXCLUDE,
INCLUDE

View File

@ -0,0 +1,72 @@
#include "UnlinkerPaths.h"
#include "SearchPath/IWD.h"
#include "SearchPath/SearchPathFilesystem.h"
#include "Utils/StringUtils.h"
#include <filesystem>
#include <iostream>
namespace fs = std::filesystem;
bool UnlinkerPaths::LoadUserPaths(const UnlinkerArgs& args)
{
for (const auto& path : args.m_user_search_paths)
{
auto absolutePath = fs::absolute(path);
if (!fs::is_directory(absolutePath))
{
std::cerr << std::format("Could not find directory of search path: \"{}\"\n", path);
return false;
}
auto searchPathName = absolutePath.string();
m_user_paths.CommitSearchPath(std::make_unique<SearchPathFilesystem>(searchPathName));
m_specified_user_paths.emplace(std::move(searchPathName));
}
std::cout << std::format("{} SearchPaths{}\n", m_specified_user_paths.size(), !m_specified_user_paths.empty() ? ":" : "");
for (const auto& absoluteSearchPath : m_specified_user_paths)
std::cout << std::format(" \"{}\"\n", absoluteSearchPath);
if (!m_specified_user_paths.empty())
std::cerr << "\n";
return true;
}
std::unique_ptr<ISearchPath> UnlinkerPaths::GetSearchPathsForZone(const std::string& zonePath)
{
const auto absoluteZoneDirectory = fs::absolute(std::filesystem::path(zonePath).remove_filename());
const auto absoluteZoneDirectoryString = absoluteZoneDirectory.string();
if (m_last_zone_path != absoluteZoneDirectoryString)
{
m_last_zone_path = absoluteZoneDirectoryString;
m_last_zone_search_paths = SearchPaths();
m_last_zone_search_paths.CommitSearchPath(std::make_unique<SearchPathFilesystem>(absoluteZoneDirectoryString));
std::filesystem::directory_iterator iterator(absoluteZoneDirectory);
const auto end = fs::end(iterator);
for (auto i = fs::begin(iterator); i != end; ++i)
{
if (!i->is_regular_file())
continue;
auto extension = i->path().extension().string();
utils::MakeStringLowerCase(extension);
if (extension == ".iwd")
{
auto iwd = iwd::LoadFromFile(i->path().string());
if (iwd)
m_last_zone_search_paths.CommitSearchPath(std::move(iwd));
}
}
}
auto result = std::make_unique<SearchPaths>();
result->IncludeSearchPath(&m_last_zone_search_paths);
result->IncludeSearchPath(&m_user_paths);
return result;
}

View File

@ -0,0 +1,21 @@
#pragma once
#include "SearchPath/SearchPaths.h"
#include "UnlinkerArgs.h"
#include <string>
#include <unordered_set>
class UnlinkerPaths
{
public:
bool LoadUserPaths(const UnlinkerArgs& args);
std::unique_ptr<ISearchPath> GetSearchPathsForZone(const std::string& zonePath);
private:
std::string m_last_zone_path;
SearchPaths m_last_zone_search_paths;
std::unordered_set<std::string> m_specified_user_paths;
SearchPaths m_user_paths;
};