1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
////////////////////////////////////////////////////////////////////////////////////////
//
// Nestopia - NES/Famicom emulator written in C++
//
// Copyright (C) 2003-2008 Martin Freij
//
// This file is part of Nestopia.
//
// Nestopia is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Nestopia is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Nestopia; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
////////////////////////////////////////////////////////////////////////////////////////
#ifndef NST_API_CHEATS_H
#define NST_API_CHEATS_H
#include "NstApi.hpp"
#ifdef NST_PRAGMA_ONCE
#pragma once
#endif
#if NST_ICC >= 810
#pragma warning( push )
#pragma warning( disable : 444 )
#elif NST_MSVC >= 1200
#pragma warning( push )
#pragma warning( disable : 4512 )
#endif
namespace Nes
{
namespace Api
{
/**
* Cheats interface.
*/
class Cheats : public Base
{
struct Lut;
public:
/**
* Interface constructor.
*
* @param instance emulator instance
*/
template<typename T>
Cheats(T& instance)
: Base(instance) {}
/**
* Cheat code.
*/
struct Code
{
/**
* Address.
*/
ushort address;
/**
* Value.
*/
uchar value;
/**
* Compare-value.
*/
uchar compare;
/**
* Compare-value enable.
*/
bool useCompare;
/**
* Constructor.
*
* @param a address
* @param v value
* @param c compare-value
* @param u compare-value enable
*/
Code(ushort a=0,uchar v=0,uchar c=0,bool u=false)
: address(a), value(v), compare(c), useCompare(u) {}
};
/**
* Adds a new code.
*
* @param code code, any existing code using the same address will be replaced
* @return result code
*/
Result SetCode(const Code& code) throw();
/**
* Returns an existing code.
*
* @param index code index
* @param code object to be filled
* @return result code
*/
Result GetCode(ulong index,Code& code) const throw();
/**
* Returns attributes of an existing code.
*
* @param index code index
* @param address address to be filled or NULL if not needed
* @param value value to be filled or NULL if not needed
* @param compare compare-value to be filled or NULL if not needed
* @param useCompare compare-value enable to be filled or NULL if not needed
* @return result code
*/
Result GetCode(ulong index,ushort* address,uchar* value,uchar* compare,bool* useCompare) const throw();
/**
* Removes an existing code.
*
* @param index code index
* @return result code
*/
Result DeleteCode(ulong index) throw();
/**
* Returns current number of codes.
*
* @return number
*/
ulong NumCodes() const throw();
/**
* Removes all existing codes.
*
* @return result code
*/
Result ClearCodes() throw();
enum
{
RAM_SIZE = 0x800
};
/**
* CPU RAM pointer reference.
*/
typedef const uchar (&Ram)[RAM_SIZE];
/**
* Returns read-only content of CPU RAM.
*
* @return CPU RAM
*/
Ram GetRam() const throw();
/**
* Encodes into a Game Genie code.
*
* @param code code to be encoded
* @param string Game Genie code string to be filled
* @return result code
*/
static Result NST_CALL GameGenieEncode(const Code& code,char (&string)[9]) throw();
/**
* Decodes a Game Genie code.
*
* @param string Game Genie encoded string
* @param code object to be filled
* @return result code
*/
static Result NST_CALL GameGenieDecode(const char* string,Code& code) throw();
/**
* Encodes into a Pro-Action Rocky code.
*
* @param code code to be encoded
* @param string Pro-Action Rocky code string to be filled
* @return result code
*/
static Result NST_CALL ProActionRockyEncode(const Code& code,char (&string)[9]) throw();
/**
* Decodes a Pro-Action Rocky code.
*
* @param string Pro-Action Rocky encoded string
* @param code object to be filled
* @return result
*/
static Result NST_CALL ProActionRockyDecode(const char* string,Code& code) throw();
};
}
}
#if NST_MSVC >= 1200 || NST_ICC >= 810
#pragma warning( pop )
#endif
#endif
|