2014-06-25 15:15:35 -07:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
|
|
|
// Licensed under GPLv2
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "common/common_types.h"
|
|
|
|
|
2014-06-27 13:18:56 -07:00
|
|
|
#include "core/file_sys/archive.h"
|
2014-10-22 20:20:01 -07:00
|
|
|
#include "core/hle/kernel/kernel.h"
|
|
|
|
#include "core/hle/result.h"
|
2014-06-25 15:15:35 -07:00
|
|
|
|
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-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-10-22 20:20:01 -07:00
|
|
|
* @return Handle to the opened archive
|
2014-06-25 15:15:35 -07:00
|
|
|
*/
|
2014-12-14 20:44:04 -08:00
|
|
|
ResultVal<Handle> OpenArchive(ArchiveIdCode id_code);
|
2014-06-27 13:18:56 -07:00
|
|
|
|
2014-09-14 04:52:52 -07:00
|
|
|
/**
|
|
|
|
* Closes an archive
|
|
|
|
* @param id_code IdCode of the archive to open
|
|
|
|
*/
|
2014-12-14 20:44:04 -08:00
|
|
|
ResultCode CloseArchive(ArchiveIdCode id_code);
|
2014-09-14 04:52:52 -07:00
|
|
|
|
2014-06-27 13:18:56 -07:00
|
|
|
/**
|
|
|
|
* Creates an Archive
|
|
|
|
* @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
|
|
|
*/
|
2014-12-14 20:44:04 -08:00
|
|
|
ResultCode CreateArchive(FileSys::Archive* backend, 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
|
2014-10-22 20:20:01 -07:00
|
|
|
* @return Handle to the opened File object
|
2014-09-11 15:45:40 -07:00
|
|
|
*/
|
2014-10-22 20:20:01 -07:00
|
|
|
ResultVal<Handle> OpenFileFromArchive(Handle archive_handle, 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-11-24 15:45:20 -08:00
|
|
|
ResultCode DeleteFileFromArchive(Handle 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-11-24 15:45:20 -08:00
|
|
|
ResultCode RenameFileBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
|
|
|
|
Handle 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-11-24 15:45:20 -08:00
|
|
|
ResultCode DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
|
2014-11-11 10:37:26 -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-11-24 15:45:20 -08:00
|
|
|
ResultCode CreateDirectoryFromArchive(Handle 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-11-24 15:45:20 -08:00
|
|
|
ResultCode RenameDirectoryBetweenArchives(Handle src_archive_handle, const FileSys::Path& src_path,
|
|
|
|
Handle 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
|
2014-10-22 20:20:01 -07:00
|
|
|
* @return Handle to the opened File object
|
2014-09-11 15:48:04 -07:00
|
|
|
*/
|
2014-10-22 20:20:01 -07:00
|
|
|
ResultVal<Handle> OpenDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
|
2014-09-11 15:48:04 -07:00
|
|
|
|
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
|