From 8adcc1a699d7fcfb83f12bd1ea7ef6b2d4696a0a Mon Sep 17 00:00:00 2001 From: Matthew Budd Date: Sun, 8 Nov 2020 15:42:48 -0500 Subject: [PATCH] Added Game Genie encode/decode window to Qt GUI. --- src/CMakeLists.txt | 1 + src/drivers/Qt/CheatsConf.cpp | 2 +- src/drivers/Qt/ConsoleUtilities.cpp | 68 +++++ src/drivers/Qt/ConsoleUtilities.h | 14 + src/drivers/Qt/ConsoleWindow.cpp | 20 ++ src/drivers/Qt/ConsoleWindow.h | 2 + src/drivers/Qt/GameGenie.cpp | 445 ++++++++++++++++++++++++++++ src/drivers/Qt/GameGenie.h | 60 ++++ 8 files changed, 611 insertions(+), 1 deletion(-) create mode 100644 src/drivers/Qt/GameGenie.cpp create mode 100644 src/drivers/Qt/GameGenie.h diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 0cf16cc3..862111c7 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -434,6 +434,7 @@ set(SRC_DRIVERS_SDL ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/MovieOptions.cpp ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/LuaControl.cpp ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/CheatsConf.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/GameGenie.cpp ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/HexEditor.cpp ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/CodeDataLogger.cpp ${CMAKE_CURRENT_SOURCE_DIR}/drivers/Qt/SymbolicDebug.cpp diff --git a/src/drivers/Qt/CheatsConf.cpp b/src/drivers/Qt/CheatsConf.cpp index 015cadbb..83fb1b3d 100644 --- a/src/drivers/Qt/CheatsConf.cpp +++ b/src/drivers/Qt/CheatsConf.cpp @@ -634,7 +634,7 @@ int GuiCheatsDialog_t::activeCheatListCB (char *name, uint32 a, uint8 v, int c, if (c >= 0) { - sprintf (codeStr, "$%04X:%02X:%02X", a,v,c); + sprintf (codeStr, "$%04X?%02X:%02X", a,c,v); } else { diff --git a/src/drivers/Qt/ConsoleUtilities.cpp b/src/drivers/Qt/ConsoleUtilities.cpp index b4a345d4..b1f70f20 100644 --- a/src/drivers/Qt/ConsoleUtilities.cpp +++ b/src/drivers/Qt/ConsoleUtilities.cpp @@ -256,3 +256,71 @@ QValidator::State fceuDecIntValidtor::validate(QString &input, int &pos) const return QValidator::Invalid; } //--------------------------------------------------------------------------- +// FCEU Data Entry Custom Validators +//--------------------------------------------------------------------------- +fceuHexIntValidtor::fceuHexIntValidtor( int min, int max, QObject *parent) + : QValidator(parent) +{ + this->min = min; + this->max = max; +} +//--------------------------------------------------------------------------- +void fceuHexIntValidtor::setMinMax( int min, int max) +{ + this->min = min; + this->max = max; +} +//--------------------------------------------------------------------------- +QValidator::State fceuHexIntValidtor::validate(QString &input, int &pos) const +{ + int i, v; + //printf("Validate: %i '%s'\n", input.size(), input.toStdString().c_str() ); + + if ( input.size() == 0 ) + { + return QValidator::Acceptable; + } + input = input.toUpper(); + std::string s = input.toStdString(); + i=0; + + if (s[i] == '-') + { + if ( min >= 0 ) + { + return QValidator::Invalid; + } + i++; + } + else if ( s[i] == '+' ) + { + i++; + } + + if ( s[i] == 0 ) + { + return QValidator::Acceptable; + } + + if ( isxdigit(s[i]) ) + { + while ( isxdigit(s[i]) ) i++; + + if ( s[i] == 0 ) + { + v = strtol( s.c_str(), NULL, 16 ); + + if ( v < min ) + { + return QValidator::Invalid; + } + else if ( v > max ) + { + return QValidator::Invalid; + } + return QValidator::Acceptable; + } + } + return QValidator::Invalid; +} +//--------------------------------------------------------------------------- diff --git a/src/drivers/Qt/ConsoleUtilities.h b/src/drivers/Qt/ConsoleUtilities.h index 2a99ade9..ca1221a8 100644 --- a/src/drivers/Qt/ConsoleUtilities.h +++ b/src/drivers/Qt/ConsoleUtilities.h @@ -25,3 +25,17 @@ class fceuDecIntValidtor : public QValidator int min; int max; }; + +class fceuHexIntValidtor : public QValidator +{ + public: + fceuHexIntValidtor( int min, int max, QObject *parent); + + QValidator::State validate(QString &input, int &pos) const; + + void setMinMax( int min, int max ); + private: + int min; + int max; +}; + diff --git a/src/drivers/Qt/ConsoleWindow.cpp b/src/drivers/Qt/ConsoleWindow.cpp index 890d656e..7a59d4ae 100644 --- a/src/drivers/Qt/ConsoleWindow.cpp +++ b/src/drivers/Qt/ConsoleWindow.cpp @@ -28,6 +28,7 @@ #include "Qt/MovieOptions.h" #include "Qt/LuaControl.h" #include "Qt/CheatsConf.h" +#include "Qt/GameGenie.h" #include "Qt/HexEditor.h" #include "Qt/TraceLogger.h" #include "Qt/CodeDataLogger.h" @@ -649,6 +650,14 @@ void consoleWin_t::createMainMenu(void) debugMenu->addAction(codeDataLogAct); + // Debug -> Game Genie Encode/Decode Viewer + ggEncodeAct = new QAction(tr("Game Genie Encode/Decode"), this); + //ggEncodeAct->setShortcut( QKeySequence(tr("Shift+F7"))); + ggEncodeAct->setStatusTip(tr("Open Game Genie Encode/Decode")); + connect(ggEncodeAct, SIGNAL(triggered()), this, SLOT(openGGEncoder(void)) ); + + debugMenu->addAction(ggEncodeAct); + // Debug -> iNES Header Editor iNesEditAct = new QAction(tr("iNES Header Editor..."), this); //iNesEditAct->setShortcut( QKeySequence(tr("Shift+F7"))); @@ -1295,6 +1304,17 @@ void consoleWin_t::openCodeDataLogger(void) cdlWin->show(); } +void consoleWin_t::openGGEncoder(void) +{ + GameGenieDialog_t *win; + + //printf("Open Game Genie Window\n"); + + win = new GameGenieDialog_t(this); + + win->show(); +} + void consoleWin_t::openNesHeaderEditor(void) { iNesHeaderEditor_t *win; diff --git a/src/drivers/Qt/ConsoleWindow.h b/src/drivers/Qt/ConsoleWindow.h index 53df423e..a5361f19 100644 --- a/src/drivers/Qt/ConsoleWindow.h +++ b/src/drivers/Qt/ConsoleWindow.h @@ -103,6 +103,7 @@ class consoleWin_t : public QMainWindow QAction *hexEditAct; QAction *ppuViewAct; QAction *ntViewAct; + QAction *ggEncodeAct; QAction *iNesEditAct; QAction *openMovAct; QAction *stopMovAct; @@ -183,6 +184,7 @@ class consoleWin_t : public QMainWindow void emuSetFrameAdvDelay(void); void openPPUViewer(void); void openNTViewer(void); + void openGGEncoder(void); void openNesHeaderEditor(void); void openCheats(void); void openRamWatch(void); diff --git a/src/drivers/Qt/GameGenie.cpp b/src/drivers/Qt/GameGenie.cpp new file mode 100644 index 00000000..bff0cb1e --- /dev/null +++ b/src/drivers/Qt/GameGenie.cpp @@ -0,0 +1,445 @@ +// GameGenie.cpp +// +#include +#include +#include +#include + +#include +#include + +#include "../../types.h" +#include "../../fceu.h" +#include "../../cart.h" +#include "../../cheat.h" +#include "../../debug.h" +#include "../../driver.h" + +#include "Qt/main.h" +#include "Qt/dface.h" +#include "Qt/dface.h" +#include "Qt/input.h" +#include "Qt/config.h" +#include "Qt/keyscan.h" +#include "Qt/fceuWrapper.h" +#include "Qt/HexEditor.h" +#include "Qt/GameGenie.h" + +static const char *GameGenieLetters = "APZLGITYEOXUKSVN"; + +class fceuGGCodeValidtor : public QValidator +{ + public: + fceuGGCodeValidtor( QObject *parent) + : QValidator(parent) + { + + } + + QValidator::State validate(QString &input, int &pos) const + { + int i,j, ok; + //printf("Validate: %i '%s'\n", input.size(), input.toStdString().c_str() ); + + if ( input.size() == 0 ) + { + return QValidator::Acceptable; + } + input = input.toUpper(); + std::string s = input.toStdString(); + i=0; + + while ( s[i] != 0 ) + { + j=0; ok=0; + while ( GameGenieLetters[j] != 0 ) + { + if ( s[i] == GameGenieLetters[j] ) + { + ok = 1; break; + } + j++; + } + + if ( !ok ) + { + return QValidator::Invalid; + } + i++; + } + + return QValidator::Acceptable; + } + + private: +}; +//---------------------------------------------------------------------------- +GameGenieDialog_t::GameGenieDialog_t(QWidget *parent) + : QDialog( parent ) +{ + int charWidth; + QVBoxLayout *mainLayout, *vbox1, *vbox; + QHBoxLayout *hbox1, *hbox; + QTreeWidgetItem *item; + QGroupBox *frame; + QFont font; + fceuGGCodeValidtor *ggCodeValidator; + + font.setFamily("Courier New"); + font.setStyle( QFont::StyleNormal ); + font.setStyleHint( QFont::Monospace ); + + QFontMetrics fm(font); + +#if QT_VERSION > QT_VERSION_CHECK(5, 11, 0) + charWidth = fm.horizontalAdvance(QLatin1Char('2')); +#else + charWidth = fm.width(QLatin1Char('2')); +#endif + + setWindowTitle("Game Genie Encoder/Decoder Tool"); + + mainLayout = new QVBoxLayout(); + vbox = new QVBoxLayout(); + vbox1 = new QVBoxLayout(); + hbox1 = new QHBoxLayout(); + + frame = new QGroupBox( tr("Address/Compare/Value") ); + mainLayout->addLayout( hbox1 ); + frame->setLayout( vbox ); + + hbox1->addWidget( frame ); + hbox1->addLayout( vbox1 ); + addr = new QLineEdit(); + cmp = new QLineEdit(); + val = new QLineEdit(); + + hbox = new QHBoxLayout(); + vbox->addLayout( hbox ); + hbox->addWidget( new QLabel( tr("Address:") ), 0, Qt::AlignRight ); + hbox->addWidget( addr, 0, Qt::AlignLeft ); + + hbox = new QHBoxLayout(); + vbox->addLayout( hbox ); + hbox->addWidget( new QLabel( tr("Compare:") ), 0, Qt::AlignRight ); + hbox->addWidget( cmp, 0, Qt::AlignLeft ); + + hbox = new QHBoxLayout(); + vbox->addLayout( hbox ); + hbox->addWidget( new QLabel( tr("Value:") ), 0, Qt::AlignRight ); + hbox->addWidget( val, 0, Qt::AlignLeft ); + + frame = new QGroupBox( tr("Game Genie Code") ); + vbox = new QVBoxLayout(); + vbox1->addWidget( frame ); + frame->setLayout( vbox ); + + ggCode = new QLineEdit(); + vbox->addWidget( ggCode ); + + addCheatBtn = new QPushButton( tr("Add To Cheat List") ); + vbox1->addWidget( addCheatBtn ); + + tree = new QTreeWidget(); + + tree->setColumnCount(1); + + item = new QTreeWidgetItem(); + item->setText( 0, QString::fromStdString( "Possible Affected ROM File Addresses" ) ); + item->setTextAlignment( 0, Qt::AlignLeft); + + tree->setHeaderItem( item ); + + tree->header()->setSectionResizeMode( QHeaderView::ResizeToContents ); + + mainLayout->addWidget( tree ); + + setLayout( mainLayout ); + + addrValidator = new fceuHexIntValidtor( 0, 0xFFFF, this ); + cmpValidator = new fceuHexIntValidtor( 0, 0x00FF, this ); + valValidator = new fceuHexIntValidtor( 0, 0x00FF, this ); + + ggCodeValidator = new fceuGGCodeValidtor( this ); + + addr->setValidator( addrValidator ); + cmp->setValidator( cmpValidator ); + val->setValidator( valValidator ); + ggCode->setValidator( ggCodeValidator ); + + addr->setMaxLength( 4 ); + cmp->setMaxLength( 2 ); + val->setMaxLength( 2 ); + ggCode->setMaxLength( 8 ); + + addr->setMinimumWidth( 6 * charWidth ); + cmp->setMinimumWidth( 4 * charWidth ); + val->setMinimumWidth( 4 * charWidth ); + addr->setMaximumWidth( 6 * charWidth ); + cmp->setMaximumWidth( 4 * charWidth ); + val->setMaximumWidth( 4 * charWidth ); + + addr->setAlignment(Qt::AlignCenter); + cmp->setAlignment(Qt::AlignCenter); + val->setAlignment(Qt::AlignCenter); + + addr->setFont( font ); + cmp->setFont( font ); + val->setFont( font ); + ggCode->setFont( font ); + + connect( addCheatBtn, SIGNAL(clicked(void)), this, SLOT(addCheatClicked(void))); + + connect( addr , SIGNAL(textEdited(const QString &)), this, SLOT(addrChanged(const QString &))); + connect( cmp , SIGNAL(textEdited(const QString &)), this, SLOT(cmpChanged(const QString &))); + connect( val , SIGNAL(textEdited(const QString &)), this, SLOT(valChanged(const QString &))); + connect( ggCode, SIGNAL(textEdited(const QString &)), this, SLOT(ggChanged(const QString &))); + + connect( tree, SIGNAL(itemActivated(QTreeWidgetItem*, int)), this, SLOT(romAddrDoubleClicked(QTreeWidgetItem*, int)) ); + + addCheatBtn->setEnabled( false ); +} +//---------------------------------------------------------------------------- +GameGenieDialog_t::~GameGenieDialog_t(void) +{ + printf("Destroy Game Genie Window\n"); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::closeEvent(QCloseEvent *event) +{ + printf("Game Genie Close Window Event\n"); + done(0); + deleteLater(); + event->accept(); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::closeWindow(void) +{ + //printf("Close Window\n"); + done(0); + deleteLater(); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::addCheatClicked(void) +{ + int a = -1, v = -1, c = -1; + std::string name; + + name = ggCode->text().toStdString(); + + if ( addr->text().size() > 0 ) + { + a = strtol( addr->text().toStdString().c_str(), NULL, 16 ); + } + if ( val->text().size() > 0 ) + { + v = strtol( val->text().toStdString().c_str(), NULL, 16 ); + } + if ( cmp->text().size() > 0 ) + { + c = strtol( cmp->text().toStdString().c_str(), NULL, 16 ); + } + + fceuWrapperLock(); + FCEUI_AddCheat( name.c_str(), a, v, c, 1 ); + fceuWrapperUnLock(); + +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::romAddrDoubleClicked(QTreeWidgetItem *item, int column) +{ + int addr; + + addr = strtol( item->text(0).toStdString().c_str(), NULL, 16 ); + + printf("ROM Addr: %06X \n", addr ); + + hexEditorOpenFromDebugger( QHexEdit::MODE_NES_ROM, addr ); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::addrChanged(const QString &s) +{ + int a, v, c = -1; + char gg[12]; + + a = strtol( s.toStdString().c_str(), NULL, 16 ); + v = strtol( val->text().toStdString().c_str(), NULL, 16 ); + + if ( cmp->text().size() > 0 ) + { + c = strtol( cmp->text().toStdString().c_str(), NULL, 16 ); + } + + EncodeGG( gg, a, v, c ); + + ggCode->setText( tr(gg) ); + + ListGGAddresses(); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::cmpChanged(const QString &s) +{ + int a, v, c = -1; + char gg[12]; + + a = strtol( addr->text().toStdString().c_str(), NULL, 16 ); + v = strtol( val->text().toStdString().c_str(), NULL, 16 ); + + if ( s.size() > 0 ) + { + c = strtol( s.toStdString().c_str(), NULL, 16 ); + } + + EncodeGG( gg, a, v, c ); + + ggCode->setText( tr(gg) ); + + ListGGAddresses(); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::valChanged(const QString &s) +{ + int a, v, c = -1; + char gg[12]; + + a = strtol( addr->text().toStdString().c_str(), NULL, 16 ); + v = strtol( s.toStdString().c_str(), NULL, 16 ); + + if ( cmp->text().size() > 0 ) + { + c = strtol( cmp->text().toStdString().c_str(), NULL, 16 ); + } + EncodeGG( gg, a, v, c ); + + ggCode->setText( tr(gg) ); + + ListGGAddresses(); +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::ggChanged(const QString &s) +{ + int a = -1, c = -1, v = -1; + char gg[12]; + char stmp[32]; + + memset( gg, 0, sizeof(gg) ); + + strncpy( gg, ggCode->text().toStdString().c_str(), 8 ); + + FCEUI_DecodeGG( gg, &a, &v, &c); + + if ( a >= 0 ) + { + sprintf( stmp, "%04X", a ); + + addr->setText( tr(stmp) ); + } + else + { + addr->clear(); + } + + if ( v >= 0 ) + { + sprintf( stmp, "%02X", v ); + + val->setText( tr(stmp) ); + } + else + { + val->clear(); + } + + if ( c >= 0 ) + { + sprintf( stmp, "%02X", c ); + + cmp->setText( tr(stmp) ); + } + else + { + cmp->clear(); + } + + ListGGAddresses(); +} +//---------------------------------------------------------------------------- +//The code in this function is a modified version +//of Chris Covell's work - I'd just like to point that out +void EncodeGG(char *str, int a, int v, int c) +{ + uint8 num[8]; + int i; + + a&=0x7fff; + + num[0]=(v&7)+((v>>4)&8); + num[1]=((v>>4)&7)+((a>>4)&8); + num[2]=((a>>4)&7); + num[3]=(a>>12)+(a&8); + num[4]=(a&7)+((a>>8)&8); + num[5]=((a>>8)&7); + + if (c == -1){ + num[5]+=v&8; + for(i = 0;i < 6;i++)str[i] = GameGenieLetters[num[i]]; + str[6] = 0; + } else { + num[2]+=8; + num[5]+=c&8; + num[6]=(c&7)+((c>>4)&8); + num[7]=((c>>4)&7)+(v&8); + for(i = 0;i < 8;i++)str[i] = GameGenieLetters[num[i]]; + str[8] = 0; + } + return; +} +//---------------------------------------------------------------------------- +void GameGenieDialog_t::ListGGAddresses(void) +{ + int i; //mbg merge 7/18/06 changed from int + int a = -1; int v = -1; int c = -1; + QTreeWidgetItem *item; + char str[32]; + bool addCheatEmable; + + if ( addr->text().size() > 0 ) + { + a = strtol( addr->text().toStdString().c_str(), NULL, 16 ); + } + if ( val->text().size() > 0 ) + { + v = strtol( val->text().toStdString().c_str(), NULL, 16 ); + } + if ( cmp->text().size() > 0 ) + { + c = strtol( cmp->text().toStdString().c_str(), NULL, 16 ); + } + // also enable/disable the add GG button here + addCheatEmable = (a >= 0) && ( (ggCode->text().size() == 6) || (ggCode->text().size() == 8) ); + + addCheatBtn->setEnabled( addCheatEmable ); + + tree->clear(); + + if (a != -1 && v != -1) + { + for (i = 0; i < PRGsize[0]; i += 0x2000) + { + if (c == -1 || PRGptr[0][i + (a & 0x1FFF)] == c) + { + item = new QTreeWidgetItem(); + + sprintf(str, "%06X", i + (a & 0x1FFF) + 0x10); + + //printf("Added ROM ADDR: %s\n", str ); + item->setText( 0, tr(str) ); + + item->setTextAlignment( 0, Qt::AlignCenter); + tree->addTopLevelItem( item ); + } + } + } + tree->viewport()->update(); +} +//---------------------------------------------------------------------------- diff --git a/src/drivers/Qt/GameGenie.h b/src/drivers/Qt/GameGenie.h new file mode 100644 index 00000000..47c4aee6 --- /dev/null +++ b/src/drivers/Qt/GameGenie.h @@ -0,0 +1,60 @@ +// GameGenie.h +// + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "Qt/main.h" +#include "Qt/ConsoleUtilities.h" + +class GameGenieDialog_t : public QDialog +{ + Q_OBJECT + + public: + GameGenieDialog_t(QWidget *parent = 0); + ~GameGenieDialog_t(void); + + protected: + void closeEvent(QCloseEvent *event); + + fceuHexIntValidtor *addrValidator; + fceuHexIntValidtor *cmpValidator; + fceuHexIntValidtor *valValidator; + + QLineEdit *addr; + QLineEdit *cmp; + QLineEdit *val; + QLineEdit *ggCode; + QPushButton *addCheatBtn; + QTreeWidget *tree; + + private: + void ListGGAddresses(void); + + public slots: + void closeWindow(void); + private slots: + void addCheatClicked(void); + void addrChanged(const QString &); + void cmpChanged(const QString &); + void valChanged(const QString &); + void ggChanged(const QString &); + void romAddrDoubleClicked(QTreeWidgetItem *item, int column); + +}; + +void EncodeGG(char *str, int a, int v, int c);