Files
DevilutionX/Source/pfile.h
T
Gleb MazovetskiyandClaude Fable 5 63e85d9b1b Replace tl::expected with std::expected
Now that the project targets C++23, use the standard library's
std::expected instead of the vendored tl::expected polyfill:

- tl::expected -> std::expected, tl::unexpected/tl::make_unexpected -> std::unexpected
- .map()/.map_error() -> .transform()/.transform_error()
- #include <expected.hpp> -> #include <expected>, grouped with std headers
- Remove 3rdParty/tl/expected.hpp (the tl target remains for function_ref.hpp)

Co-Authored-By: Claude Fable 5 <[email protected]>
2026-07-22 00:00:04 +02:00

133 lines
3.2 KiB
C++

/**
* @file pfile.h
*
* Interface of the save game encoding functionality.
*/
#pragma once
#include <cstdint>
#include <expected>
#include <string>
#include "DiabloUI/diabloui.h"
#include "player.h"
#ifdef UNPACKED_SAVES
#include "utils/file_util.h"
#else
#include "mpq/mpq_reader.hpp"
#include "mpq/mpq_writer.hpp"
#endif
namespace devilution {
#define MAX_CHARACTERS 99
extern bool gbValidSaveFile;
#ifdef UNPACKED_SAVES
struct SaveReader {
explicit SaveReader(std::string &&dir)
: dir_(std::move(dir))
{
}
const std::string &dir() const
{
return dir_;
}
std::unique_ptr<std::byte[]> ReadFile(const char *filename, std::size_t &fileSize, int32_t &error);
bool HasFile(const char *path)
{
return ::devilution::FileExists((dir_ + path).c_str());
}
private:
std::string dir_;
};
struct SaveWriter {
explicit SaveWriter(std::string &&dir)
: dir_(std::move(dir))
{
}
bool WriteFile(const char *filename, const std::byte *data, size_t size);
bool HasFile(const char *path)
{
return ::devilution::FileExists((dir_ + path).c_str());
}
void RenameFile(const char *from, const char *to)
{
::devilution::RenameFile((dir_ + from).c_str(), (dir_ + to).c_str());
}
void RemoveHashEntry(const char *path)
{
RemoveFile((dir_ + path).c_str());
}
void RemoveHashEntries(bool (*fnGetName)(uint8_t, char *));
private:
std::string dir_;
};
#else
using SaveReader = MpqArchive;
using SaveWriter = MpqWriter;
#endif
/**
* @brief Comparison result of pfile_compare_hero_demo
*/
struct HeroCompareResult {
enum Status : uint8_t {
ReferenceNotFound,
Same,
Difference,
};
Status status;
std::string message;
};
std::optional<SaveReader> OpenSaveArchive(uint32_t saveNum);
std::optional<SaveReader> OpenStashArchive();
const char *pfile_get_password();
std::unique_ptr<std::byte[]> ReadArchive(SaveReader &archive, const char *pszName, size_t *pdwLen = nullptr);
void pfile_write_hero(bool writeGameData = false);
#ifndef DISABLE_DEMOMODE
/**
* @brief Save a reference game-state (save game) for the demo recording
* @param demo that is recorded
*/
void pfile_write_hero_demo(int demo);
/**
* @brief Compares the actual game-state (savegame) with a reference game-state (save game from demo recording)
* @param demo for the comparison
* @param logDetails in case of a difference log details
* @return The comparison result.
*/
HeroCompareResult pfile_compare_hero_demo(int demo, bool logDetails);
#endif
void sfile_write_stash();
bool pfile_ui_set_hero_infos(bool (*uiAddHeroInfo)(_uiheroinfo *));
void pfile_ui_set_class_stats(HeroClass playerClass, _uidefaultstats *classStats);
uint32_t pfile_ui_get_first_unused_save_num();
bool pfile_ui_save_create(_uiheroinfo *heroinfo);
bool pfile_delete_save(_uiheroinfo *heroInfo);
void pfile_read_player_from_save(uint32_t saveNum, Player &player);
void pfile_save_level();
std::expected<void, std::string> pfile_convert_levels();
void pfile_remove_temp_files();
std::unique_ptr<std::byte[]> pfile_read(const char *pszName, size_t *pdwLen);
void pfile_update(bool forceSave);
} // namespace devilution