FileSys: Move all result description to errors.h

5 files changed, 96 insertions, 61 deletions

diff --git a/src/core/file_sys/archive_extsavedata.cpp b/src/core/file_sys/archive_extsavedata.cpp
index f454e7840..4867c9d17 100644
--- a/src/core/file_sys/archive_extsavedata.cpp
+++ b/src/core/file_sys/archive_extsavedata.cpp
@@ -38,8 +38,7 @@ public:
     ResultVal<size_t> Write(u64 offset, size_t length, bool flush,
                             const u8* buffer) const override {
         if (offset > size) {
-            return ResultCode(ErrorDescription::FS_WriteBeyondEnd, ErrorModule::FS,
-                              ErrorSummary::InvalidArgument, ErrorLevel::Usage);
+            return ERR_WRITE_BEYOND_END;
         } else if (offset == size) {
             return MakeResult<size_t>(0);
         }
@@ -191,11 +190,9 @@ ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_ExtSaveData::Open(cons
         // TODO(Subv): Verify the archive behavior of SharedExtSaveData compared to ExtSaveData.
         // ExtSaveData seems to return FS_NotFound (120) when the archive doesn't exist.
         if (!shared) {
-            return ResultCode(ErrorDescription::FS_NotFound, ErrorModule::FS,
-                              ErrorSummary::InvalidState, ErrorLevel::Status);
+            return ERR_NOT_FOUND_INVALID_STATE;
         } else {
-            return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
-                              ErrorSummary::InvalidState, ErrorLevel::Status);
+            return ERR_NOT_FORMATTED;
         }
     }
     auto archive = std::make_unique<ExtSaveDataArchive>(fullpath);
@@ -230,8 +227,7 @@ ResultVal<ArchiveFormatInfo> ArchiveFactory_ExtSaveData::GetFormatInfo(const Pat
     if (!file.IsOpen()) {
         LOG_ERROR(Service_FS, "Could not open metadata information for archive");
         // TODO(Subv): Verify error code
-        return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
-                          ErrorSummary::InvalidState, ErrorLevel::Status);
+        return ERR_NOT_FORMATTED;
     }
 
     ArchiveFormatInfo info = {};
diff --git a/src/core/file_sys/archive_source_sd_savedata.cpp b/src/core/file_sys/archive_source_sd_savedata.cpp
index f31a68038..a7e331724 100644
--- a/src/core/file_sys/archive_source_sd_savedata.cpp
+++ b/src/core/file_sys/archive_source_sd_savedata.cpp
@@ -6,6 +6,7 @@
 #include "common/logging/log.h"
 #include "common/string_util.h"
 #include "core/file_sys/archive_source_sd_savedata.h"
+#include "core/file_sys/errors.h"
 #include "core/file_sys/savedata_archive.h"
 #include "core/hle/service/fs/archive.h"
 
@@ -49,8 +50,7 @@ ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveSource_SDSaveData::Open(u64 pr
         // save file/directory structure expected by the game has not yet been initialized.
         // Returning the NotFormatted error code will signal the game to provision the SaveData
         // archive with the files and folders that it expects.
-        return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
-                          ErrorSummary::InvalidState, ErrorLevel::Status);
+        return ERR_NOT_FORMATTED;
     }
 
     auto archive = std::make_unique<SaveDataArchive>(std::move(concrete_mount_point));
@@ -81,8 +81,7 @@ ResultVal<ArchiveFormatInfo> ArchiveSource_SDSaveData::GetFormatInfo(u64 program
     if (!file.IsOpen()) {
         LOG_ERROR(Service_FS, "Could not open metadata information for archive");
         // TODO(Subv): Verify error code
-        return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
-                          ErrorSummary::InvalidState, ErrorLevel::Status);
+        return ERR_NOT_FORMATTED;
     }
 
     ArchiveFormatInfo info = {};
diff --git a/src/core/file_sys/archive_systemsavedata.cpp b/src/core/file_sys/archive_systemsavedata.cpp
index 8986b5c0e..81423bffd 100644
--- a/src/core/file_sys/archive_systemsavedata.cpp
+++ b/src/core/file_sys/archive_systemsavedata.cpp
@@ -9,6 +9,7 @@
 #include "common/file_util.h"
 #include "common/string_util.h"
 #include "core/file_sys/archive_systemsavedata.h"
+#include "core/file_sys/errors.h"
 #include "core/file_sys/savedata_archive.h"
 #include "core/hle/service/fs/archive.h"
 
@@ -53,8 +54,7 @@ ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_SystemSaveData::Open(c
     std::string fullpath = GetSystemSaveDataPath(base_path, path);
     if (!FileUtil::Exists(fullpath)) {
         // TODO(Subv): Check error code, this one is probably wrong
-        return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS,
-                          ErrorSummary::InvalidState, ErrorLevel::Status);
+        return ERR_NOT_FORMATTED;
     }
     auto archive = std::make_unique<SaveDataArchive>(fullpath);
     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive));
diff --git a/src/core/file_sys/disk_archive.cpp b/src/core/file_sys/disk_archive.cpp
index a243d9a13..98d80aabc 100644
--- a/src/core/file_sys/disk_archive.cpp
+++ b/src/core/file_sys/disk_archive.cpp
@@ -9,6 +9,7 @@
 #include "common/file_util.h"
 #include "common/logging/log.h"
 #include "core/file_sys/disk_archive.h"
+#include "core/file_sys/errors.h"
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 // FileSys namespace
@@ -17,8 +18,7 @@ namespace FileSys {
 
 ResultVal<size_t> DiskFile::Read(const u64 offset, const size_t length, u8* buffer) const {
     if (!mode.read_flag)
-        return ResultCode(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS,
-                          ErrorSummary::Canceled, ErrorLevel::Status);
+        return ERROR_INVALID_OPEN_FLAGS;
 
     file->Seek(offset, SEEK_SET);
     return MakeResult<size_t>(file->ReadBytes(buffer, length));
@@ -27,8 +27,7 @@ ResultVal<size_t> DiskFile::Read(const u64 offset, const size_t length, u8* buff
 ResultVal<size_t> DiskFile::Write(const u64 offset, const size_t length, const bool flush,
                                   const u8* buffer) const {
     if (!mode.write_flag)
-        return ResultCode(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS,
-                          ErrorSummary::Canceled, ErrorLevel::Status);
+        return ERROR_INVALID_OPEN_FLAGS;
 
     file->Seek(offset, SEEK_SET);
     size_t written = file->WriteBytes(buffer, length);
diff --git a/src/core/file_sys/errors.h b/src/core/file_sys/errors.h
index 9fc8d753b..a974bc775 100644
--- a/src/core/file_sys/errors.h
+++ b/src/core/file_sys/errors.h
@@ -2,52 +2,93 @@
 // Licensed under GPLv2 or any later version
 // Refer to the license.txt file included.
 
+#pragma once
+
 #include "core/hle/result.h"
 
 namespace FileSys {
 
-const ResultCode ERROR_INVALID_PATH(ErrorDescription::FS_InvalidPath, ErrorModule::FS,
-                                    ErrorSummary::InvalidArgument, ErrorLevel::Usage);
-const ResultCode ERROR_UNSUPPORTED_OPEN_FLAGS(ErrorDescription::FS_UnsupportedOpenFlags,
-                                              ErrorModule::FS, ErrorSummary::NotSupported,
-                                              ErrorLevel::Usage);
-const ResultCode ERROR_INVALID_OPEN_FLAGS(ErrorDescription::FS_InvalidOpenFlags, ErrorModule::FS,
-                                          ErrorSummary::Canceled, ErrorLevel::Status);
-const ResultCode ERROR_INVALID_READ_FLAG(ErrorDescription::FS_InvalidReadFlag, ErrorModule::FS,
-                                         ErrorSummary::InvalidArgument, ErrorLevel::Usage);
-const ResultCode ERROR_FILE_NOT_FOUND(ErrorDescription::FS_FileNotFound, ErrorModule::FS,
-                                      ErrorSummary::NotFound, ErrorLevel::Status);
-const ResultCode ERROR_PATH_NOT_FOUND(ErrorDescription::FS_PathNotFound, ErrorModule::FS,
-                                      ErrorSummary::NotFound, ErrorLevel::Status);
-const ResultCode ERROR_NOT_FOUND(ErrorDescription::FS_NotFound, ErrorModule::FS,
-                                 ErrorSummary::NotFound, ErrorLevel::Status);
-const ResultCode ERROR_UNEXPECTED_FILE_OR_DIRECTORY(ErrorDescription::FS_UnexpectedFileOrDirectory,
-                                                    ErrorModule::FS, ErrorSummary::NotSupported,
-                                                    ErrorLevel::Usage);
-const ResultCode ERROR_UNEXPECTED_FILE_OR_DIRECTORY_SDMC(ErrorDescription::FS_NotAFile,
-                                                         ErrorModule::FS, ErrorSummary::Canceled,
-                                                         ErrorLevel::Status);
-const ResultCode ERROR_DIRECTORY_ALREADY_EXISTS(ErrorDescription::FS_DirectoryAlreadyExists,
-                                                ErrorModule::FS, ErrorSummary::NothingHappened,
-                                                ErrorLevel::Status);
-const ResultCode ERROR_FILE_ALREADY_EXISTS(ErrorDescription::FS_FileAlreadyExists, ErrorModule::FS,
-                                           ErrorSummary::NothingHappened, ErrorLevel::Status);
-const ResultCode ERROR_ALREADY_EXISTS(ErrorDescription::FS_AlreadyExists, ErrorModule::FS,
-                                      ErrorSummary::NothingHappened, ErrorLevel::Status);
-const ResultCode ERROR_DIRECTORY_NOT_EMPTY(ErrorDescription::FS_DirectoryNotEmpty, ErrorModule::FS,
-                                           ErrorSummary::Canceled, ErrorLevel::Status);
-const ResultCode ERROR_GAMECARD_NOT_INSERTED(ErrorDescription::FS_GameCardNotInserted,
-                                             ErrorModule::FS, ErrorSummary::NotFound,
-                                             ErrorLevel::Status);
-const ResultCode ERROR_INCORRECT_EXEFS_READ_SIZE(ErrorDescription::FS_IncorrectExeFSReadSize,
-                                                 ErrorModule::FS, ErrorSummary::NotSupported,
-                                                 ErrorLevel::Usage);
-const ResultCode ERROR_ROMFS_NOT_FOUND(ErrorDescription::FS_RomFSNotFound, ErrorModule::FS,
-                                       ErrorSummary::NotFound, ErrorLevel::Status);
-const ResultCode ERROR_COMMAND_NOT_ALLOWED(ErrorDescription::FS_CommandNotAllowed, ErrorModule::FS,
-                                           ErrorSummary::WrongArgument, ErrorLevel::Permanent);
-const ResultCode ERROR_EXEFS_SECTION_NOT_FOUND(ErrorDescription::FS_ExeFSSectionNotFound,
-                                               ErrorModule::FS, ErrorSummary::NotFound,
-                                               ErrorLevel::Status);
+namespace ErrCodes {
+enum {
+    RomFSNotFound = 100,
+    ArchiveNotMounted = 101,
+    FileNotFound = 112,
+    PathNotFound = 113,
+    GameCardNotInserted = 141,
+    NotFound = 120,
+    FileAlreadyExists = 180,
+    DirectoryAlreadyExists = 185,
+    AlreadyExists = 190,
+    InvalidOpenFlags = 230,
+    DirectoryNotEmpty = 240,
+    NotAFile = 250,
+    NotFormatted = 340, ///< This is used by the FS service when creating a SaveData archive
+    ExeFSSectionNotFound = 567,
+    CommandNotAllowed = 630,
+    InvalidReadFlag = 700,
+    InvalidPath = 702,
+    WriteBeyondEnd = 705,
+    UnsupportedOpenFlags = 760,
+    IncorrectExeFSReadSize = 761,
+    UnexpectedFileOrDirectory = 770,
+};
+}
+
+constexpr ResultCode ERROR_INVALID_PATH(ErrCodes::InvalidPath, ErrorModule::FS,
+                                        ErrorSummary::InvalidArgument, ErrorLevel::Usage);
+constexpr ResultCode ERROR_UNSUPPORTED_OPEN_FLAGS(ErrCodes::UnsupportedOpenFlags, ErrorModule::FS,
+                                                  ErrorSummary::NotSupported, ErrorLevel::Usage);
+constexpr ResultCode ERROR_INVALID_OPEN_FLAGS(ErrCodes::InvalidOpenFlags, ErrorModule::FS,
+                                              ErrorSummary::Canceled, ErrorLevel::Status);
+constexpr ResultCode ERROR_INVALID_READ_FLAG(ErrCodes::InvalidReadFlag, ErrorModule::FS,
+                                             ErrorSummary::InvalidArgument, ErrorLevel::Usage);
+constexpr ResultCode ERROR_FILE_NOT_FOUND(ErrCodes::FileNotFound, ErrorModule::FS,
+                                          ErrorSummary::NotFound, ErrorLevel::Status);
+constexpr ResultCode ERROR_PATH_NOT_FOUND(ErrCodes::PathNotFound, ErrorModule::FS,
+                                          ErrorSummary::NotFound, ErrorLevel::Status);
+constexpr ResultCode ERROR_NOT_FOUND(ErrCodes::NotFound, ErrorModule::FS, ErrorSummary::NotFound,
+                                     ErrorLevel::Status);
+constexpr ResultCode ERROR_UNEXPECTED_FILE_OR_DIRECTORY(ErrCodes::UnexpectedFileOrDirectory,
+                                                        ErrorModule::FS, ErrorSummary::NotSupported,
+                                                        ErrorLevel::Usage);
+constexpr ResultCode ERROR_UNEXPECTED_FILE_OR_DIRECTORY_SDMC(ErrCodes::NotAFile, ErrorModule::FS,
+                                                             ErrorSummary::Canceled,
+                                                             ErrorLevel::Status);
+constexpr ResultCode ERROR_DIRECTORY_ALREADY_EXISTS(ErrCodes::DirectoryAlreadyExists,
+                                                    ErrorModule::FS, ErrorSummary::NothingHappened,
+                                                    ErrorLevel::Status);
+constexpr ResultCode ERROR_FILE_ALREADY_EXISTS(ErrCodes::FileAlreadyExists, ErrorModule::FS,
+                                               ErrorSummary::NothingHappened, ErrorLevel::Status);
+constexpr ResultCode ERROR_ALREADY_EXISTS(ErrCodes::AlreadyExists, ErrorModule::FS,
+                                          ErrorSummary::NothingHappened, ErrorLevel::Status);
+constexpr ResultCode ERROR_DIRECTORY_NOT_EMPTY(ErrCodes::DirectoryNotEmpty, ErrorModule::FS,
+                                               ErrorSummary::Canceled, ErrorLevel::Status);
+constexpr ResultCode ERROR_GAMECARD_NOT_INSERTED(ErrCodes::GameCardNotInserted, ErrorModule::FS,
+                                                 ErrorSummary::NotFound, ErrorLevel::Status);
+constexpr ResultCode ERROR_INCORRECT_EXEFS_READ_SIZE(ErrCodes::IncorrectExeFSReadSize,
+                                                     ErrorModule::FS, ErrorSummary::NotSupported,
+                                                     ErrorLevel::Usage);
+constexpr ResultCode ERROR_ROMFS_NOT_FOUND(ErrCodes::RomFSNotFound, ErrorModule::FS,
+                                           ErrorSummary::NotFound, ErrorLevel::Status);
+constexpr ResultCode ERROR_COMMAND_NOT_ALLOWED(ErrCodes::CommandNotAllowed, ErrorModule::FS,
+                                               ErrorSummary::WrongArgument, ErrorLevel::Permanent);
+constexpr ResultCode ERROR_EXEFS_SECTION_NOT_FOUND(ErrCodes::ExeFSSectionNotFound, ErrorModule::FS,
+                                                   ErrorSummary::NotFound, ErrorLevel::Status);
+
+/// Returned when a function is passed an invalid archive handle.
+constexpr ResultCode ERR_INVALID_ARCHIVE_HANDLE(ErrCodes::ArchiveNotMounted, ErrorModule::FS,
+                                                ErrorSummary::NotFound,
+                                                ErrorLevel::Status); // 0xC8804465
+constexpr ResultCode ERR_WRITE_BEYOND_END(ErrCodes::WriteBeyondEnd, ErrorModule::FS,
+                                          ErrorSummary::InvalidArgument, ErrorLevel::Usage);
+
+/**
+ * Variant of ERROR_NOT_FOUND returned in some places in the code. Unknown if these usages are
+ * correct or a bug.
+ */
+constexpr ResultCode ERR_NOT_FOUND_INVALID_STATE(ErrCodes::NotFound, ErrorModule::FS,
+                                                 ErrorSummary::InvalidState, ErrorLevel::Status);
+constexpr ResultCode ERR_NOT_FORMATTED(ErrCodes::NotFormatted, ErrorModule::FS,
+                                       ErrorSummary::InvalidState, ErrorLevel::Status);
 
 } // namespace FileSys