573036b38e
Added a few interfaces for adding/deleting/replacing/saving cheats. The cheats list is guarded by a std::shared_mutex, and would only need a exclusive lock when it's being updated. I marked the `Execute` function as `const` to avoid accidentally changing the internal state of the cheat on execution, so that execution can be considered a "read" operation which only needs a shared lock. Whether a cheat is enabled or not is now saved by a special comment line `*citra_enabled`.
111 lines
3.4 KiB
C++
111 lines
3.4 KiB
C++
// Copyright 2018 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#include <fstream>
|
|
#include <functional>
|
|
#include <fmt/format.h>
|
|
#include "common/file_util.h"
|
|
#include "core/cheats/cheats.h"
|
|
#include "core/cheats/gateway_cheat.h"
|
|
#include "core/core.h"
|
|
#include "core/core_timing.h"
|
|
#include "core/hle/kernel/process.h"
|
|
|
|
namespace Cheats {
|
|
|
|
constexpr u64 run_interval_ticks = BASE_CLOCK_RATE_ARM11 / 60;
|
|
|
|
CheatEngine::CheatEngine(Core::System& system_) : system(system_) {
|
|
LoadCheatFile();
|
|
event = system.CoreTiming().RegisterEvent(
|
|
"CheatCore::run_event",
|
|
[this](u64 thread_id, s64 cycle_late) { RunCallback(thread_id, cycle_late); });
|
|
system.CoreTiming().ScheduleEvent(run_interval_ticks, event);
|
|
}
|
|
|
|
CheatEngine::~CheatEngine() {
|
|
system.CoreTiming().UnscheduleEvent(event, 0);
|
|
}
|
|
|
|
std::vector<std::shared_ptr<CheatBase>> CheatEngine::GetCheats() const {
|
|
std::shared_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
return cheats_list;
|
|
}
|
|
|
|
void CheatEngine::AddCheat(const std::shared_ptr<CheatBase>& cheat) {
|
|
std::unique_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
cheats_list.push_back(cheat);
|
|
}
|
|
|
|
void CheatEngine::RemoveCheat(int index) {
|
|
std::unique_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
if (index < 0 || index >= cheats_list.size()) {
|
|
LOG_ERROR(Core_Cheats, "Invalid index {}", index);
|
|
return;
|
|
}
|
|
cheats_list.erase(cheats_list.begin() + index);
|
|
}
|
|
|
|
void CheatEngine::UpdateCheat(int index, const std::shared_ptr<CheatBase>& new_cheat) {
|
|
std::unique_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
if (index < 0 || index >= cheats_list.size()) {
|
|
LOG_ERROR(Core_Cheats, "Invalid index {}", index);
|
|
return;
|
|
}
|
|
cheats_list[index] = new_cheat;
|
|
}
|
|
|
|
void CheatEngine::SaveCheatFile() const {
|
|
const std::string cheat_dir = FileUtil::GetUserPath(FileUtil::UserPath::CheatsDir);
|
|
const std::string filepath = fmt::format(
|
|
"{}{:016X}.txt", cheat_dir, system.Kernel().GetCurrentProcess()->codeset->program_id);
|
|
|
|
if (!FileUtil::IsDirectory(cheat_dir)) {
|
|
FileUtil::CreateDir(cheat_dir);
|
|
}
|
|
|
|
std::ofstream file;
|
|
OpenFStream(file, filepath, std::ios_base::out);
|
|
|
|
auto cheats = GetCheats();
|
|
for (const auto& cheat : cheats) {
|
|
file << cheat->ToString();
|
|
}
|
|
|
|
file.flush();
|
|
}
|
|
|
|
void CheatEngine::LoadCheatFile() {
|
|
const std::string cheat_dir = FileUtil::GetUserPath(FileUtil::UserPath::CheatsDir);
|
|
const std::string filepath = fmt::format(
|
|
"{}{:016X}.txt", cheat_dir, system.Kernel().GetCurrentProcess()->codeset->program_id);
|
|
|
|
if (!FileUtil::IsDirectory(cheat_dir)) {
|
|
FileUtil::CreateDir(cheat_dir);
|
|
}
|
|
|
|
if (!FileUtil::Exists(filepath))
|
|
return;
|
|
|
|
auto gateway_cheats = GatewayCheat::LoadFile(filepath);
|
|
{
|
|
std::unique_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
std::move(gateway_cheats.begin(), gateway_cheats.end(), std::back_inserter(cheats_list));
|
|
}
|
|
}
|
|
|
|
void CheatEngine::RunCallback([[maybe_unused]] u64 userdata, int cycles_late) {
|
|
{
|
|
std::shared_lock<std::shared_mutex> lock(cheats_list_mutex);
|
|
for (auto& cheat : cheats_list) {
|
|
if (cheat->IsEnabled()) {
|
|
cheat->Execute(system);
|
|
}
|
|
}
|
|
}
|
|
system.CoreTiming().ScheduleEvent(run_interval_ticks - cycles_late, event);
|
|
}
|
|
|
|
} // namespace Cheats
|