2014-12-18 04:44:32 +00:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-17 05:38:14 +00:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-12-18 04:44:32 +00:00
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2015-06-21 14:44:11 +00:00
|
|
|
#include <memory>
|
|
|
|
#include <string>
|
2020-01-02 23:34:26 +00:00
|
|
|
#include <boost/serialization/export.hpp>
|
|
|
|
#include <boost/serialization/string.hpp>
|
2014-12-18 04:44:32 +00:00
|
|
|
#include "common/common_types.h"
|
2015-06-21 14:44:11 +00:00
|
|
|
#include "core/file_sys/archive_backend.h"
|
|
|
|
#include "core/hle/result.h"
|
2014-12-18 04:44:32 +00:00
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// FileSys namespace
|
|
|
|
|
|
|
|
namespace FileSys {
|
|
|
|
|
2014-12-18 21:58:42 +00:00
|
|
|
/// File system interface to the SystemSaveData archive
|
2015-02-24 23:02:40 +00:00
|
|
|
class ArchiveFactory_SystemSaveData final : public ArchiveFactory {
|
2014-12-18 04:44:32 +00:00
|
|
|
public:
|
2016-12-07 10:20:35 +00:00
|
|
|
explicit ArchiveFactory_SystemSaveData(const std::string& mount_point);
|
2014-12-18 04:44:32 +00:00
|
|
|
|
2019-02-03 01:14:01 +00:00
|
|
|
ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path, u64 program_id) override;
|
|
|
|
ResultCode Format(const Path& path, const FileSys::ArchiveFormatInfo& format_info,
|
|
|
|
u64 program_id) override;
|
|
|
|
ResultVal<ArchiveFormatInfo> GetFormatInfo(const Path& path, u64 program_id) const override;
|
2014-12-18 04:44:32 +00:00
|
|
|
|
2016-09-18 00:38:01 +00:00
|
|
|
std::string GetName() const override {
|
|
|
|
return "SystemSaveData";
|
|
|
|
}
|
2015-02-24 23:02:40 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
std::string base_path;
|
2020-01-02 23:34:26 +00:00
|
|
|
|
|
|
|
ArchiveFactory_SystemSaveData() = default;
|
|
|
|
template <class Archive>
|
|
|
|
void serialize(Archive& ar, const unsigned int) {
|
2020-01-08 23:19:49 +00:00
|
|
|
ar& boost::serialization::base_object<ArchiveFactory>(*this);
|
2020-01-02 23:34:26 +00:00
|
|
|
ar& base_path;
|
|
|
|
}
|
|
|
|
friend class boost::serialization::access;
|
2014-12-18 04:44:32 +00:00
|
|
|
};
|
|
|
|
|
2015-03-14 17:00:01 +00:00
|
|
|
/**
|
|
|
|
* Constructs a path to the concrete SystemSaveData archive in the host filesystem based on the
|
|
|
|
* input Path and base mount point.
|
|
|
|
* @param mount_point The base mount point of the SystemSaveData archives.
|
|
|
|
* @param path The path that identifies the requested concrete SystemSaveData archive.
|
|
|
|
* @returns The complete path to the specified SystemSaveData archive in the host filesystem
|
|
|
|
*/
|
2020-05-01 13:43:02 +00:00
|
|
|
std::string GetSystemSaveDataPath(std::string_view mount_point, const Path& path);
|
2015-03-14 17:00:01 +00:00
|
|
|
|
|
|
|
/**
|
2016-09-18 00:38:01 +00:00
|
|
|
* Constructs a path to the base folder to hold concrete SystemSaveData archives in the host file
|
|
|
|
* system.
|
2015-03-14 17:00:01 +00:00
|
|
|
* @param mount_point The base folder where this folder resides, ie. SDMC or NAND.
|
|
|
|
* @returns The path to the base SystemSaveData archives' folder in the host file system
|
|
|
|
*/
|
2020-05-01 13:43:02 +00:00
|
|
|
std::string GetSystemSaveDataContainerPath(std::string_view mount_point);
|
2015-03-14 17:00:01 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructs a FileSys::Path object that refers to the SystemSaveData archive identified by
|
|
|
|
* the specified high save id and low save id.
|
|
|
|
* @param high The high word of the save id for the archive
|
|
|
|
* @param low The low word of the save id for the archive
|
|
|
|
* @returns A FileSys::Path to the wanted archive
|
|
|
|
*/
|
|
|
|
Path ConstructSystemSaveDataBinaryPath(u32 high, u32 low);
|
|
|
|
|
2014-12-18 04:44:32 +00:00
|
|
|
} // namespace FileSys
|
2020-01-02 23:34:26 +00:00
|
|
|
|
|
|
|
BOOST_CLASS_EXPORT_KEY(FileSys::ArchiveFactory_SystemSaveData)
|