2014-06-25 15:15:35 -07:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-16 21:38:14 -08:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-06-25 15:15:35 -07:00
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "common/common_types.h"
|
|
|
|
|
2014-12-14 20:51:38 -08:00
|
|
|
#include "core/file_sys/archive_backend.h"
|
2014-10-22 20:20:01 -07:00
|
|
|
#include "core/hle/kernel/kernel.h"
|
2015-02-07 10:06:48 -08:00
|
|
|
#include "core/hle/kernel/session.h"
|
2014-10-22 20:20:01 -07:00
|
|
|
#include "core/hle/result.h"
|
2014-06-25 15:15:35 -07:00
|
|
|
|
2015-01-03 17:46:05 -08:00
|
|
|
/// The unique system identifier hash, also known as ID0
|
2015-01-04 06:10:27 -08:00
|
|
|
extern const std::string SYSTEM_ID;
|
2015-01-03 17:46:05 -08:00
|
|
|
/// The scrambled SD card CID, also known as ID1
|
2015-01-04 06:10:27 -08:00
|
|
|
extern const std::string SDCARD_ID;
|
2015-01-03 17:46:05 -08:00
|
|
|
|
2015-01-30 06:32:46 -08:00
|
|
|
namespace Kernel {
|
|
|
|
class Session;
|
|
|
|
}
|
|
|
|
|
2014-12-13 23:55:11 -08:00
|
|
|
namespace Service {
|
|
|
|
namespace FS {
|
2014-06-25 15:15:35 -07:00
|
|
|
|
2014-12-14 20:44:04 -08:00
|
|
|
/// Supported archive types
|
|
|
|
enum class ArchiveIdCode : u32 {
|
|
|
|
RomFS = 0x00000003,
|
|
|
|
SaveData = 0x00000004,
|
|
|
|
ExtSaveData = 0x00000006,
|
|
|
|
SharedExtSaveData = 0x00000007,
|
|
|
|
SystemSaveData = 0x00000008,
|
|
|
|
SDMC = 0x00000009,
|
|
|
|
SDMCWriteOnly = 0x0000000A,
|
2014-12-31 16:36:50 -08:00
|
|
|
SaveDataCheck = 0x2345678A,
|
2014-12-14 20:44:04 -08:00
|
|
|
};
|
|
|
|
|
2014-12-15 00:41:02 -08:00
|
|
|
typedef u64 ArchiveHandle;
|
|
|
|
|
2015-02-07 10:06:48 -08:00
|
|
|
class File : public Kernel::Session {
|
|
|
|
public:
|
|
|
|
File(std::unique_ptr<FileSys::FileBackend>&& backend, const FileSys::Path& path)
|
|
|
|
: path(path), priority(0), backend(std::move(backend)) {
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string GetName() const override { return "Path: " + path.DebugStr(); }
|
|
|
|
|
|
|
|
FileSys::Path path; ///< Path of the file
|
|
|
|
u32 priority; ///< Priority of the file. TODO(Subv): Find out what this means
|
|
|
|
std::unique_ptr<FileSys::FileBackend> backend; ///< File backend interface
|
|
|
|
|
|
|
|
ResultVal<bool> SyncRequest() override;
|
|
|
|
};
|
|
|
|
|
|
|
|
class Directory : public Kernel::Session {
|
|
|
|
public:
|
|
|
|
Directory(std::unique_ptr<FileSys::DirectoryBackend>&& backend, const FileSys::Path& path)
|
|
|
|
: path(path), backend(std::move(backend)) {
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string GetName() const override { return "Directory: " + path.DebugStr(); }
|
|
|
|
|
|
|
|
FileSys::Path path; ///< Path of the directory
|
|
|
|
std::unique_ptr<FileSys::DirectoryBackend> backend; ///< File backend interface
|
|
|
|
|
|
|
|
ResultVal<bool> SyncRequest() override;
|
|
|
|
};
|
|
|
|
|
2014-06-25 15:15:35 -07:00
|
|
|
/**
|
2014-06-27 13:18:56 -07:00
|
|
|
* Opens an archive
|
|
|
|
* @param id_code IdCode of the archive to open
|
2014-12-29 10:04:37 -08:00
|
|
|
* @param archive_path Path to the archive, used with Binary paths
|
2014-10-22 20:20:01 -07:00
|
|
|
* @return Handle to the opened archive
|
2014-06-25 15:15:35 -07:00
|
|
|
*/
|
2014-12-29 10:04:37 -08:00
|
|
|
ResultVal<ArchiveHandle> OpenArchive(ArchiveIdCode id_code, FileSys::Path& archive_path);
|
2014-06-27 13:18:56 -07:00
|
|
|
|
2014-09-14 04:52:52 -07:00
|
|
|
/**
|
|
|
|
* Closes an archive
|
2015-01-20 10:52:44 -08:00
|
|
|
* @param handle Handle to the archive to close
|
2014-09-14 04:52:52 -07:00
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode CloseArchive(ArchiveHandle handle);
|
2014-09-14 04:52:52 -07:00
|
|
|
|
2014-06-27 13:18:56 -07:00
|
|
|
/**
|
2015-02-06 05:53:14 -08:00
|
|
|
* Registers an Archive type, instances of which can later be opened using its IdCode.
|
2014-06-27 13:18:56 -07:00
|
|
|
* @param backend File system backend interface to the archive
|
2014-12-14 20:44:04 -08:00
|
|
|
* @param id_code Id code used to access this type of archive
|
2014-06-27 13:18:56 -07:00
|
|
|
*/
|
2015-02-06 05:53:14 -08:00
|
|
|
ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code);
|
2014-06-25 15:15:35 -07:00
|
|
|
|
2014-09-11 15:45:40 -07:00
|
|
|
/**
|
|
|
|
* Open a File from an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the File inside of the Archive
|
|
|
|
* @param mode Mode under which to open the File
|
2015-01-30 06:32:46 -08:00
|
|
|
* @return The opened File object as a Session
|
2014-09-11 15:45:40 -07:00
|
|
|
*/
|
2015-02-07 10:06:48 -08:00
|
|
|
ResultVal<Kernel::SharedPtr<File>> OpenFileFromArchive(ArchiveHandle archive_handle,
|
2015-01-30 06:32:46 -08:00
|
|
|
const FileSys::Path& path, const FileSys::Mode mode);
|
2014-10-28 22:52:56 -07:00
|
|
|
|
2014-11-11 10:37:26 -08:00
|
|
|
/**
|
|
|
|
* Delete a File from an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the File inside of the Archive
|
|
|
|
* @return Whether deletion succeeded
|
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode DeleteFileFromArchive(ArchiveHandle archive_handle, const FileSys::Path& path);
|
2014-11-11 10:37:26 -08:00
|
|
|
|
2014-11-23 23:20:04 -08:00
|
|
|
/**
|
|
|
|
* Rename a File between two Archives
|
|
|
|
* @param src_archive_handle Handle to the source Archive object
|
|
|
|
* @param src_path Path to the File inside of the source Archive
|
|
|
|
* @param dest_archive_handle Handle to the destination Archive object
|
|
|
|
* @param dest_path Path to the File inside of the destination Archive
|
|
|
|
* @return Whether rename succeeded
|
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode RenameFileBetweenArchives(ArchiveHandle src_archive_handle, const FileSys::Path& src_path,
|
|
|
|
ArchiveHandle dest_archive_handle, const FileSys::Path& dest_path);
|
2014-11-23 23:20:04 -08:00
|
|
|
|
2014-11-11 10:37:26 -08:00
|
|
|
/**
|
|
|
|
* Delete a Directory from an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the Directory inside of the Archive
|
|
|
|
* @return Whether deletion succeeded
|
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode DeleteDirectoryFromArchive(ArchiveHandle archive_handle, const FileSys::Path& path);
|
2014-11-11 10:37:26 -08:00
|
|
|
|
2014-12-20 07:43:50 -08:00
|
|
|
/**
|
|
|
|
* Create a File in an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the File inside of the Archive
|
|
|
|
* @param file_size The size of the new file, filled with zeroes
|
|
|
|
* @return File creation result code
|
|
|
|
*/
|
2015-01-01 09:39:27 -08:00
|
|
|
ResultCode CreateFileInArchive(ArchiveHandle archive_handle, const FileSys::Path& path, u32 file_size);
|
2014-12-20 07:43:50 -08:00
|
|
|
|
2014-10-28 22:52:56 -07:00
|
|
|
/**
|
|
|
|
* Create a Directory from an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the Directory inside of the Archive
|
|
|
|
* @return Whether creation of directory succeeded
|
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode CreateDirectoryFromArchive(ArchiveHandle archive_handle, const FileSys::Path& path);
|
2014-09-11 15:45:40 -07:00
|
|
|
|
2014-11-24 01:12:58 -08:00
|
|
|
/**
|
|
|
|
* Rename a Directory between two Archives
|
|
|
|
* @param src_archive_handle Handle to the source Archive object
|
|
|
|
* @param src_path Path to the Directory inside of the source Archive
|
|
|
|
* @param dest_archive_handle Handle to the destination Archive object
|
|
|
|
* @param dest_path Path to the Directory inside of the destination Archive
|
|
|
|
* @return Whether rename succeeded
|
|
|
|
*/
|
2014-12-15 00:41:02 -08:00
|
|
|
ResultCode RenameDirectoryBetweenArchives(ArchiveHandle src_archive_handle, const FileSys::Path& src_path,
|
|
|
|
ArchiveHandle dest_archive_handle, const FileSys::Path& dest_path);
|
2014-11-24 01:12:58 -08:00
|
|
|
|
2014-09-11 15:48:04 -07:00
|
|
|
/**
|
|
|
|
* Open a Directory from an Archive
|
|
|
|
* @param archive_handle Handle to an open Archive object
|
|
|
|
* @param path Path to the Directory inside of the Archive
|
2015-01-30 06:32:46 -08:00
|
|
|
* @return The opened Directory object as a Session
|
2014-09-11 15:48:04 -07:00
|
|
|
*/
|
2015-02-07 10:06:48 -08:00
|
|
|
ResultVal<Kernel::SharedPtr<Directory>> OpenDirectoryFromArchive(ArchiveHandle archive_handle,
|
2015-01-30 06:32:46 -08:00
|
|
|
const FileSys::Path& path);
|
2014-09-11 15:48:04 -07:00
|
|
|
|
2014-12-15 21:33:41 -08:00
|
|
|
/**
|
|
|
|
* Creates a blank SaveData archive.
|
|
|
|
* @return ResultCode 0 on success or the corresponding code on error
|
|
|
|
*/
|
|
|
|
ResultCode FormatSaveData();
|
|
|
|
|
2015-01-13 20:56:00 -08:00
|
|
|
/**
|
|
|
|
* Creates a blank SharedExtSaveData archive for the specified extdata ID
|
|
|
|
* @param high The high word of the extdata id to create
|
|
|
|
* @param low The low word of the extdata id to create
|
|
|
|
* @return ResultCode 0 on success or the corresponding code on error
|
|
|
|
*/
|
|
|
|
ResultCode CreateExtSaveData(u32 high, u32 low);
|
|
|
|
|
2014-07-04 10:38:12 -07:00
|
|
|
/// Initialize archives
|
|
|
|
void ArchiveInit();
|
|
|
|
|
|
|
|
/// Shutdown archives
|
|
|
|
void ArchiveShutdown();
|
|
|
|
|
2014-12-13 23:55:11 -08:00
|
|
|
} // namespace FS
|
|
|
|
} // namespace Service
|