2014-04-09 03:15:46 +04:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
|
|
|
// Licensed under GPLv2
|
|
|
|
// Refer to the license.txt file included.
|
2013-09-20 07:21:22 +04:00
|
|
|
|
2014-04-09 03:15:46 +04:00
|
|
|
#pragma once
|
2013-09-20 07:21:22 +04:00
|
|
|
|
2014-06-19 02:58:09 +04:00
|
|
|
#include <vector>
|
|
|
|
|
2014-04-09 04:15:08 +04:00
|
|
|
#include "common/common.h"
|
2013-09-20 07:21:22 +04:00
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
2014-06-17 07:18:10 +04:00
|
|
|
// Loader namespace
|
2013-09-20 07:21:22 +04:00
|
|
|
|
|
|
|
namespace Loader {
|
|
|
|
|
2014-06-19 02:58:09 +04:00
|
|
|
/// File types supported by CTR
|
|
|
|
enum class FileType {
|
|
|
|
Error,
|
|
|
|
Unknown,
|
|
|
|
CCI,
|
|
|
|
CXI,
|
|
|
|
CIA,
|
|
|
|
ELF,
|
|
|
|
};
|
|
|
|
|
|
|
|
/// Return type for functions in Loader namespace
|
|
|
|
enum class ResultStatus {
|
|
|
|
Success,
|
|
|
|
Error,
|
|
|
|
ErrorInvalidFormat,
|
|
|
|
ErrorNotImplemented,
|
|
|
|
ErrorNotLoaded,
|
2014-06-19 07:53:22 +04:00
|
|
|
ErrorNotUsed,
|
2014-06-19 02:58:09 +04:00
|
|
|
ErrorAlreadyLoaded,
|
|
|
|
};
|
|
|
|
|
|
|
|
/// Interface for loading an application
|
|
|
|
class AppLoader : NonCopyable {
|
|
|
|
public:
|
|
|
|
AppLoader() { }
|
|
|
|
virtual ~AppLoader() { }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Load the application
|
|
|
|
* @return ResultStatus result of function
|
|
|
|
*/
|
2014-06-20 01:46:05 +04:00
|
|
|
virtual ResultStatus Load() = 0;
|
2014-06-19 02:58:09 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the code (typically .code section) of the application
|
2014-06-27 23:33:23 +04:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-19 02:58:09 +04:00
|
|
|
*/
|
2014-06-27 23:33:23 +04:00
|
|
|
virtual ResultStatus ReadCode(std::vector<u8>& buffer) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-19 02:58:09 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 23:40:21 +04:00
|
|
|
* Get the icon (typically icon section) of the application
|
2014-06-27 23:33:23 +04:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-19 02:58:09 +04:00
|
|
|
*/
|
2014-06-27 23:33:23 +04:00
|
|
|
virtual ResultStatus ReadIcon(std::vector<u8>& buffer) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-19 02:58:09 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 23:40:21 +04:00
|
|
|
* Get the banner (typically banner section) of the application
|
2014-06-27 23:33:23 +04:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-19 02:58:09 +04:00
|
|
|
*/
|
2014-06-27 23:33:23 +04:00
|
|
|
virtual ResultStatus ReadBanner(std::vector<u8>& buffer) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-19 02:58:09 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-06-22 23:40:21 +04:00
|
|
|
* Get the logo (typically logo section) of the application
|
2014-06-27 23:33:23 +04:00
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-19 02:58:09 +04:00
|
|
|
*/
|
2014-06-27 23:33:23 +04:00
|
|
|
virtual ResultStatus ReadLogo(std::vector<u8>& buffer) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-19 02:58:09 +04:00
|
|
|
}
|
2013-09-20 07:21:22 +04:00
|
|
|
|
2014-06-19 02:58:09 +04:00
|
|
|
/**
|
2014-06-27 23:33:23 +04:00
|
|
|
* Get the RomFS of the application
|
|
|
|
* @param buffer Reference to buffer to store data
|
|
|
|
* @return ResultStatus result of function
|
2014-06-19 02:58:09 +04:00
|
|
|
*/
|
2014-06-27 23:33:23 +04:00
|
|
|
virtual ResultStatus ReadRomFS(std::vector<u8>& buffer) {
|
|
|
|
return ResultStatus::ErrorNotImplemented;
|
2014-06-19 02:58:09 +04:00
|
|
|
}
|
2013-09-20 07:21:22 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Identifies the type of a bootable file
|
|
|
|
* @param filename String filename of bootable file
|
|
|
|
* @return FileType of file
|
|
|
|
*/
|
2014-06-20 01:46:05 +04:00
|
|
|
FileType IdentifyFile(const std::string &filename);
|
2013-09-20 07:21:22 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Identifies and loads a bootable file
|
|
|
|
* @param filename String filename of bootable file
|
2014-06-19 02:58:09 +04:00
|
|
|
* @return ResultStatus result of function
|
2013-09-20 07:21:22 +04:00
|
|
|
*/
|
2014-06-20 01:46:05 +04:00
|
|
|
ResultStatus LoadFile(const std::string& filename);
|
2013-09-20 07:21:22 +04:00
|
|
|
|
|
|
|
} // namespace
|