c2588403c0
All service calls in the CTR OS return result codes indicating the success or failure of the call. Previous to this commit, Citra's HLE emulation of services and the kernel universally either ignored errors or returned dummy -1 error codes. This commit makes an initial effort to provide an infrastructure for error reporting and propagation which can be use going forward to make HLE calls accurately return errors as the original system. A few parts of the code have been updated to use the new system where applicable. One part of this effort is the definition of the `ResultCode` type, which provides facilities for constructing and parsing error codes in the structured format used by the CTR. The `ResultVal` type builds on `ResultCode` by providing a container for values returned by function that can report errors. It enforces that correct error checking will be done on function returns by preventing the use of the return value if the function returned an error code. Currently this change is mostly internal since errors are still suppressed on the ARM<->HLE border, as a temporary compatibility hack. As functionality is implemented and tested this hack can be eventually removed.
85 lines
2.5 KiB
C++
85 lines
2.5 KiB
C++
// Copyright 2014 Citra Emulator Project
|
|
// Licensed under GPLv2
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include "common/common_types.h"
|
|
|
|
#include "core/file_sys/archive.h"
|
|
#include "core/hle/kernel/kernel.h"
|
|
#include "core/hle/result.h"
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Kernel namespace
|
|
|
|
namespace Kernel {
|
|
|
|
/**
|
|
* Opens an archive
|
|
* @param id_code IdCode of the archive to open
|
|
* @return Handle to the opened archive
|
|
*/
|
|
ResultVal<Handle> OpenArchive(FileSys::Archive::IdCode id_code);
|
|
|
|
/**
|
|
* Closes an archive
|
|
* @param id_code IdCode of the archive to open
|
|
*/
|
|
ResultCode CloseArchive(FileSys::Archive::IdCode id_code);
|
|
|
|
/**
|
|
* Creates an Archive
|
|
* @param backend File system backend interface to the archive
|
|
* @param name Name of Archive
|
|
*/
|
|
ResultCode CreateArchive(FileSys::Archive* backend, const std::string& name);
|
|
|
|
/**
|
|
* 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
|
|
* @return Handle to the opened File object
|
|
*/
|
|
ResultVal<Handle> OpenFileFromArchive(Handle archive_handle, const FileSys::Path& path, const FileSys::Mode mode);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
Result DeleteFileFromArchive(Handle archive_handle, const FileSys::Path& path);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
Result DeleteDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
Result CreateDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
|
|
|
|
/**
|
|
* 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
|
|
* @return Handle to the opened File object
|
|
*/
|
|
ResultVal<Handle> OpenDirectoryFromArchive(Handle archive_handle, const FileSys::Path& path);
|
|
|
|
/// Initialize archives
|
|
void ArchiveInit();
|
|
|
|
/// Shutdown archives
|
|
void ArchiveShutdown();
|
|
|
|
} // namespace FileSys
|