ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dolphin/Source/Core/Common/DebugInterface.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

85 lines
3.2 KiB
C
Raw Normal View History

Add missing license headers
2015-05-24 04:32:32 +00:00
// Copyright 2008 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
Replace all include guard ifdefs with "#pragma once"
2014-02-10 18:54:46 +00:00
#pragma once
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
Fix memory breakpoint when checking the middle of the data If the delimiters of a memory aren't exactly the same as an address, but their size includes the memory breakpoint delimiter, the break will not go through. This makes it so that you can specify a search for a memory breakpoint with a data size and will check if the data fits with that size on all memory breakpoints so the breaks go through.
2017-03-03 01:07:24 +00:00
#include <cstddef>
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
#include <string>
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
#include <vector>
#include "Common/CommonTypes.h"
Debugger: Add a Thread widget DebugInterface: Add GetThreads WatchWidget: Update widget on AddWatch
2020-03-21 07:48:49 +00:00
#include "Common/Debug/Threads.h"
Common/DebugInterface: Use forward declarations where applicable We're allowed (by the standard) to forward declare types within std::vector, so we can replace direct includes with forward declarations and then include the types where they're directly needed. While we're at it, we can remove an unused inclusion of <cstring>, given nothing in the header uses anything from it. This also revealed an indirect inclusion, which this also resolves.
2019-07-08 22:07:11 +00:00
namespace Common::Debug
{
struct MemoryPatch;
struct Watch;
} // namespace Common::Debug
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
Common/DebugInterface: Namespace code under the Common namespace Gets more identifiers out of the global namespace and makes it more in line with the rest of the (mostly) namespaced Common code.
2018-07-10 01:47:50 +00:00
namespace Common
{
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
class DebugInterface
{
protected:
Common/DebugInterface: Default virtual destructor While we're at it, we can also default the constructor and destructor of inheriting classes in their respective cpp file to prevent the construction and destruction of non-trivial types being inlined into other regions of code.
2019-07-08 21:44:56 +00:00
virtual ~DebugInterface() = default;
Reformat all the things!
2018-04-12 12:18:04 +00:00
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
public:
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
// Watches
Common/Watches: std::move strings where applicable Allows calling code to move the std::string into the Watch instances, avoiding copies.
2019-07-08 21:28:07 +00:00
virtual std::size_t SetWatch(u32 address, std::string name = "") = 0;
Common/DebugInterface: Use forward declarations where applicable We're allowed (by the standard) to forward declare types within std::vector, so we can replace direct includes with forward declarations and then include the types where they're directly needed. While we're at it, we can remove an unused inclusion of <cstring>, given nothing in the header uses anything from it. This also revealed an indirect inclusion, which this also resolves.
2019-07-08 22:07:11 +00:00
virtual const Debug::Watch& GetWatch(std::size_t index) const = 0;
virtual const std::vector<Debug::Watch>& GetWatches() const = 0;
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
virtual void UnsetWatch(u32 address) = 0;
Common/Watches: std::move strings where applicable Allows calling code to move the std::string into the Watch instances, avoiding copies.
2019-07-08 21:28:07 +00:00
virtual void UpdateWatch(std::size_t index, u32 address, std::string name) = 0;
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
virtual void UpdateWatchAddress(std::size_t index, u32 address) = 0;
Common/Watches: std::move strings where applicable Allows calling code to move the std::string into the Watch instances, avoiding copies.
2019-07-08 21:28:07 +00:00
virtual void UpdateWatchName(std::size_t index, std::string name) = 0;
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
virtual void EnableWatch(std::size_t index) = 0;
virtual void DisableWatch(std::size_t index) = 0;
virtual bool HasEnabledWatch(u32 address) const = 0;
virtual void RemoveWatch(std::size_t index) = 0;
virtual void LoadWatchesFromStrings(const std::vector<std::string>& watches) = 0;
virtual std::vector<std::string> SaveWatchesToStrings() const = 0;
virtual void ClearWatches() = 0;
DebugInterface: MemoryPatches methods added CodeView: Restore instruction added
2018-05-21 14:46:03 +00:00
// Memory Patches
virtual void SetPatch(u32 address, u32 value) = 0;
virtual void SetPatch(u32 address, std::vector<u8> value) = 0;
Common/DebugInterface: Use forward declarations where applicable We're allowed (by the standard) to forward declare types within std::vector, so we can replace direct includes with forward declarations and then include the types where they're directly needed. While we're at it, we can remove an unused inclusion of <cstring>, given nothing in the header uses anything from it. This also revealed an indirect inclusion, which this also resolves.
2019-07-08 22:07:11 +00:00
virtual const std::vector<Debug::MemoryPatch>& GetPatches() const = 0;
DebugInterface: MemoryPatches methods added CodeView: Restore instruction added
2018-05-21 14:46:03 +00:00
virtual void UnsetPatch(u32 address) = 0;
virtual void EnablePatch(std::size_t index) = 0;
virtual void DisablePatch(std::size_t index) = 0;
virtual bool HasEnabledPatch(u32 address) const = 0;
virtual void RemovePatch(std::size_t index) = 0;
virtual void ClearPatches() = 0;
Debugger: Add a Thread widget DebugInterface: Add GetThreads WatchWidget: Update widget on AddWatch
2020-03-21 07:48:49 +00:00
// Threads
virtual Debug::Threads GetThreads() const = 0;
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual std::string Disassemble(u32 /*address*/) const { return "NODEBUGGER"; }
virtual std::string GetRawMemoryString(int /*memory*/, u32 /*address*/) const
Common: asterisks go against the type name not the variable name
2016-01-21 19:46:25 +00:00
{
DebugInterface: Make GetRawMemoryString return a std::string
2016-10-07 13:56:02 +00:00
return "NODEBUGGER";
Common: asterisks go against the type name not the variable name
2016-01-21 19:46:25 +00:00
}
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual bool IsAlive() const { return true; }
virtual bool IsBreakpoint(u32 /*address*/) const { return false; }
Common/DebugInterface: Use u32 instead of unsigned int consistently Previously u32 was being used for part of the interface and unsigned int was being used for other parts. This makes the interface fully consistent by using only one type. We opt for u32 here given they communicate the same thing (for platforms we care about where int is 32-bit), while also being less to read.
2019-07-08 21:53:47 +00:00
virtual void SetBreakpoint(u32 /*address*/) {}
virtual void ClearBreakpoint(u32 /*address*/) {}
Change the DebugInterface, PPCDebugInterface, and DSPDebugInterface to use CamelCase names. This is the standard coding convention in the codebase, so our interfaces should use it too.
2014-03-03 05:39:08 +00:00
virtual void ClearAllBreakpoints() {}
Common/DebugInterface: Use u32 instead of unsigned int consistently Previously u32 was being used for part of the interface and unsigned int was being used for other parts. This makes the interface fully consistent by using only one type. We opt for u32 here given they communicate the same thing (for platforms we care about where int is 32-bit), while also being less to read.
2019-07-08 21:53:47 +00:00
virtual void ToggleBreakpoint(u32 /*address*/) {}
Add ClearAllMemChecks to DebugInterface Breakpoints have one, but memchecks don't, despite being cleared directly in the breakpoint window. Now DolphinWX should call the interface functions and not the direct functions of the breakpoints or memchecks for clearing.
2014-03-06 01:51:27 +00:00
virtual void ClearAllMemChecks() {}
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual bool IsMemCheck(u32 /*address*/, size_t /*size*/) const { return false; }
Common/DebugInterface: Use u32 instead of unsigned int consistently Previously u32 was being used for part of the interface and unsigned int was being used for other parts. This makes the interface fully consistent by using only one type. We opt for u32 here given they communicate the same thing (for platforms we care about where int is 32-bit), while also being less to read.
2019-07-08 21:53:47 +00:00
virtual void ToggleMemCheck(u32 /*address*/, bool /*read*/, bool /*write*/, bool /*log*/) {}
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual u32 ReadMemory(u32 /*address*/) const { return 0; }
Common/DebugInterface: Use u32 instead of unsigned int consistently Previously u32 was being used for part of the interface and unsigned int was being used for other parts. This makes the interface fully consistent by using only one type. We opt for u32 here given they communicate the same thing (for platforms we care about where int is 32-bit), while also being less to read.
2019-07-08 21:53:47 +00:00
virtual void WriteExtraMemory(int /*memory*/, u32 /*value*/, u32 /*address*/) {}
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual u32 ReadExtraMemory(int /*memory*/, u32 /*address*/) const { return 0; }
virtual u32 ReadInstruction(u32 /*address*/) const { return 0; }
virtual u32 GetPC() const { return 0; }
Common/DebugInterface: Use u32 instead of unsigned int consistently Previously u32 was being used for part of the interface and unsigned int was being used for other parts. This makes the interface fully consistent by using only one type. We opt for u32 here given they communicate the same thing (for platforms we care about where int is 32-bit), while also being less to read.
2019-07-08 21:53:47 +00:00
virtual void SetPC(u32 /*address*/) {}
Change the DebugInterface, PPCDebugInterface, and DSPDebugInterface to use CamelCase names. This is the standard coding convention in the codebase, so our interfaces should use it too.
2014-03-03 05:39:08 +00:00
virtual void Step() {}
virtual void RunToBreakpoint() {}
Common/DebugInterface: Mark a few member functions as const Quite a few member functions act as a means to query information. Given these don't actually modify object state, they can be made const.
2019-07-08 22:25:14 +00:00
virtual u32 GetColor(u32 /*address*/) const { return 0xFFFFFFFF; }
virtual std::string GetDescription(u32 /*address*/) const = 0;
DebugInterface: Watches methods added Move Watches to Common
2018-01-29 16:58:02 +00:00
virtual void Clear() = 0;
set svn:eol-style=native for **.h git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1438 8ced0084-cf51-0410-be5f-012b33b47a6e
2008-12-08 04:46:09 +00:00
};
Common/DebugInterface: Namespace code under the Common namespace Gets more identifiers out of the global namespace and makes it more in line with the rest of the (mostly) namespaced Common code.
2018-07-10 01:47:50 +00:00
} // namespace Common