74 lines
2.7 KiB
C++
74 lines
2.7 KiB
C++
// Copyright 2014 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "common/common_types.h"
|
|
|
|
#include "core/file_sys/archive_backend.h"
|
|
#include "core/hle/result.h"
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// FileSys namespace
|
|
|
|
namespace FileSys {
|
|
|
|
/// File system interface to the ExtSaveData archive
|
|
class ArchiveFactory_ExtSaveData final : public ArchiveFactory {
|
|
public:
|
|
ArchiveFactory_ExtSaveData(const std::string& mount_point, bool shared);
|
|
|
|
/**
|
|
* Initialize the archive.
|
|
* @return true if it initialized successfully
|
|
*/
|
|
bool Initialize();
|
|
|
|
std::string GetName() const override { return "ExtSaveData"; }
|
|
|
|
ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override;
|
|
ResultCode Format(const Path& path) override;
|
|
|
|
const std::string& GetMountPoint() const { return mount_point; }
|
|
|
|
private:
|
|
/**
|
|
* This holds the full directory path for this archive, it is only set after a successful call
|
|
* to Open, this is formed as <base extsavedatapath>/<type>/<high>/<low>.
|
|
* See GetExtSaveDataPath for the code that extracts this data from an archive path.
|
|
*/
|
|
std::string mount_point;
|
|
};
|
|
|
|
/**
|
|
* Constructs a path to the concrete ExtData archive in the host filesystem based on the
|
|
* input Path and base mount point.
|
|
* @param mount_point The base mount point of the ExtSaveData archives.
|
|
* @param path The path that identifies the requested concrete ExtSaveData archive.
|
|
* @returns The complete path to the specified extdata archive in the host filesystem
|
|
*/
|
|
std::string GetExtSaveDataPath(const std::string& mount_point, const Path& path);
|
|
|
|
/**
|
|
* Constructs a path to the base folder to hold concrete ExtSaveData archives in the host file system.
|
|
* @param mount_point The base folder where this folder resides, ie. SDMC or NAND.
|
|
* @param shared Whether this ExtSaveData container is for SharedExtSaveDatas or not.
|
|
* @returns The path to the base ExtSaveData archives' folder in the host file system
|
|
*/
|
|
std::string GetExtDataContainerPath(const std::string& mount_point, bool shared);
|
|
|
|
/**
|
|
* Constructs a FileSys::Path object that refers to the ExtData archive identified by
|
|
* the specified media type, high save id and low save id.
|
|
* @param media_type The media type where the archive is located (NAND / SDMC)
|
|
* @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 ConstructExtDataBinaryPath(u32 media_type, u32 high, u32 low);
|
|
|
|
} // namespace FileSys
|