snes9x/cheats.h

/*****************************************************************************\
     Snes9x - Portable Super Nintendo Entertainment System (TM) emulator.
                This file is licensed under the Snes9x License.
   For further information, consult the LICENSE file in the root directory.
\*****************************************************************************/

#ifndef _CHEATS_H_
#define _CHEATS_H_

#include <cstdint>
#include <string>
#include <vector>

using bool8 = uint8_t;

struct SCheat
{
	uint32_t	address;
	uint8_t	byte;
	uint8_t	saved_byte;
	bool8	conditional;
	bool8	cond_true;
	uint8_t	cond_byte;
	bool8	enabled;
};

struct SCheatGroup
{
	std::string name;
	bool8 enabled;
	std::vector<struct SCheat> cheat;
};

struct SCheatData
{
	std::vector<struct SCheatGroup> group;
	bool8	enabled;
	uint8_t	CWRAM[0x20000];
	uint8_t	CSRAM[0x80000];
	uint8_t	CIRAM[0x2000];
	uint8_t	*RAM;
	uint8_t	*FillRAM;
	uint8_t	*SRAM;
	uint32_t	ALL_BITS[0x32000 >> 5];
	uint8_t	CWatchRAM[0x32000];
};

struct Watch
{
	bool	on;
	int		size;
	int		format;
	uint32_t	address;
	char	buf[12];
	char	desc[32];
};

typedef enum
{
	S9X_LESS_THAN,
	S9X_GREATER_THAN,
	S9X_LESS_THAN_OR_EQUAL,
	S9X_GREATER_THAN_OR_EQUAL,
	S9X_EQUAL,
	S9X_NOT_EQUAL
}	S9xCheatComparisonType;

typedef enum
{
	S9X_8_BITS,
	S9X_16_BITS,
	S9X_24_BITS,
	S9X_32_BITS
}	S9xCheatDataSize;

extern SCheatData	Cheat;
extern Watch		watches[16];

int S9xAddCheatGroup(const std::string &name, const std::string &cheat);
int S9xModifyCheatGroup(uint32_t index, const std::string &name, const std::string &cheat);
void S9xEnableCheatGroup(uint32_t index);
void S9xDisableCheatGroup(uint32_t index);
void S9xDeleteCheats(void);
std::string S9xCheatGroupToText(const SCheatGroup &g);
std::string S9xCheatGroupToText(uint32_t index);
void S9xDeleteCheatGroup(uint32_t index);
bool8 S9xLoadCheatFile(const std::string &filename);
bool8 S9xSaveCheatFile(const std::string &filename);
void S9xUpdateCheatsInMemory(void);
int S9xImportCheatsFromDatabase(const std::string &filename);
void S9xCheatsDisable(void);
void S9xCheatsEnable(void);
std::string S9xCheatValidate(const std::string &cheat);

void S9xInitCheatData (void);
void S9xInitWatchedAddress (void);
void S9xStartCheatSearch (SCheatData *);
void S9xSearchForChange (SCheatData *, S9xCheatComparisonType, S9xCheatDataSize, bool8, bool8);
void S9xSearchForValue (SCheatData *, S9xCheatComparisonType, S9xCheatDataSize, uint32_t, bool8, bool8);
void S9xSearchForAddress (SCheatData *, S9xCheatComparisonType, S9xCheatDataSize, uint32_t, bool8);
void S9xOutputCheatSearchResults (SCheatData *);

#endif