ShuriZma
/
stella
mirror of https://github.com/stella-emu/stella.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

inlined browser dialogs in debugger parser 

added optional browser dialog to "dump" command (somewhat ugly!)
This commit is contained in:
thrust26 2020-12-28 12:37:49 +01:00
parent b45b997923
commit b81617d7d7
10 changed files with 208 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/debugger.html
View File

@ -947,7 +947,7 @@ clearsavestateifs - Clear all savestate points
deltrap - Delete trap <xx>
delwatch - Delete watch <xx>
disasm - Disassemble address xx [yy lines] (default=PC)
dump - Dump data at address <xx> [to yy] [1: memory; 2: CPU state; 4: input regs]
dump - Dump data at address <xx> [to yy] [1: memory; 2: CPU state; 4: input regs] [?]
exec - Execute script file <xx> [prefix]
exitrom - Exit emulator, return to ROM launcher
frame - Advance emulation by <xx> frames (default=1)
@ -989,12 +989,12 @@ clearsavestateifs - Clear all savestate points
runto - Run until string xx in disassembly
runtopc - Run until PC is set to value xx
s - Set Stack Pointer to value xx
save - Save breaks, watches, traps and functions to file xx (use ? for file dialog)
saveaccess - Save access counters to CSV file (use ? for file dialog)
save - Save breaks, watches, traps and functions to file <xx or ?>
saveaccess - Save access counters to CSV file [?]
saveconfig - Save DiStella config file (with default name)
savedis - Save DiStella disassembly (use ? for file dialog)
saverom - Save (possibly patched) ROM (use ? for file dialog)
saveses - Save console session (use ? for file dialog)
savedis - Save DiStella disassembly to file [?]
saverom - Save (possibly patched) ROM to file [?]
saveses - Save console session to file [?]
savesnap - Save current TIA image to PNG file
saveallstates - Save all emulator states
savestate - Save emulator state xx (valid args 0-9)

6
src/debugger/CartDebug.hxx
View File

@ -236,13 +236,13 @@ class CartDebug : public DebuggerSystem
/**
Save disassembly and ROM file
*/
string saveDisassembly(string path);
string saveRom(string path);
string saveDisassembly(string path = EmptyString);
string saveRom(string path = EmptyString);
/**
Save access counters file
*/
string saveAccessFile(string path);
string saveAccessFile(string path = EmptyString);
/**
Show Distella directives (both set by the user and determined by Distella)

214
src/debugger/DebuggerParser.cxx
View File

@ -36,6 +36,7 @@
#include "RomWidget.hxx"
#include "ProgressDialog.hxx"
#include "BrowserDialog.hxx"
#include "FrameBuffer.hxx"
#include "TimerManager.hxx"
#include "Vec.hxx"
@ -699,6 +700,21 @@ string DebuggerParser::saveScriptFile(string file)
return "saved " + node.getShortPath() + " OK";
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void DebuggerParser::saveDump(const FilesystemNode& node, const ostringstream& out,
ostringstream& result)
{
// cout << "dump " << args[0] << "-" << args[1] << " to " << path.str() << endl;
std::ofstream ofs(node.getPath(), std::ofstream::out);
if(!ofs.is_open())
result.str(red("Unable to append dump to file " + node.getShortPath()));
else
{
ofs << out.str();
result << " to file " << node.getShortPath();
}
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void DebuggerParser::executeDirective(Device::AccessType type)
{
@ -1126,7 +1142,7 @@ void DebuggerParser::executeDump()
};
// Error checking
if( argCount == 0 || argCount > 3)
if(argCount == 0 || argCount > 4)
{
outputCommandError("wrong number of arguments", myCommand);
return;
@ -1143,32 +1159,33 @@ void DebuggerParser::executeDump()
dump(commandResult, args[0], args[1]);
else
{
ostringstream file;
file << debugger.myOSystem.userDir() << cartName() << "_dbg_";
if(execDepth > 0)
if((args[2] & 0x07) == 0)
{
file << execPrefix;
}
else
{
file << std::hex << std::setw(8) << std::setfill('0')
<< uInt32(TimerManager::getTicks() / 1000);
}
file << ".dump";
FilesystemNode node(file.str());
// cout << "dump " << args[0] << "-" << args[1] << " to " << file.str() << endl;
std::ofstream ofs(node.getPath(), std::ofstream::out | std::ofstream::app);
if(!ofs.is_open())
{
outputCommandError("Unable to append dump to file " + node.getShortPath(), myCommand);
commandResult << red("dump flags must be 1..7");
return;
}
if((args[2] & 0x07) != 0)
if(argCount == 4 && argStrings[3] != "?")
{
commandResult << red("browser dialog parameter must be '?'");
return;
}
ostringstream path;
path << debugger.myOSystem.userDir() << cartName() << "_dbg_";
if(execDepth > 0)
path << execPrefix;
else
path << std::hex << std::setw(8) << std::setfill('0')
<< uInt32(TimerManager::getTicks() / 1000);
path << ".dump";
commandResult << "dumped ";
ostringstream out;
if((args[2] & 0x01) != 0)
{
// dump memory
dump(ofs, args[0], args[1]);
dump(out, args[0], args[1]);
commandResult << "bytes from $" << hex << args[0] << " to $" << hex << args[1];
if((args[2] & 0x06) != 0)
commandResult << ", ";
@ -1177,8 +1194,8 @@ void DebuggerParser::executeDump()
{
// dump CPU state
CpuDebug& cpu = debugger.cpuDebug();
ofs << " <PC>PC SP A X Y - - N V B D I Z C -\n";
ofs << "XC: "
out << " <PC>PC SP A X Y - - N V B D I Z C -\n";
out << "XC: "
<< Base::toString(cpu.pc() & 0xff) << " " // PC lsb
<< Base::toString(cpu.pc() >> 8) << " " // PC msb
<< Base::toString(cpu.sp()) << " " // SP
@ -1203,8 +1220,8 @@ void DebuggerParser::executeDump()
if((args[2] & 0x04) != 0)
{
// dump SWCHx/INPTx state
ofs << " SWA - SWB - IT - - - I0 I1 I2 I3 I4 I5 - -\n";
ofs << "XS: "
out << " SWA - SWB - IT - - - I0 I1 I2 I3 I4 I5 - -\n";
out << "XS: "
<< Base::toString(debugger.peek(0x280)) << " " // SWCHA
<< Base::toString(0) << " " // unused
<< Base::toString(debugger.peek(0x282)) << " " // SWCHB
@ -1224,8 +1241,34 @@ void DebuggerParser::executeDump()
<< endl;
commandResult << "switches and fire buttons";
}
if((args[2] & 0x07) != 0)
commandResult << " to file " << node.getShortPath();
if(argCount == 4)
{
string outStr = out.str(); // ugly, why can't we transfer directly?
string resultStr = commandResult.str(); // same
BrowserDialog::show(debugger.myDialog, "Save Dump as", path.str(),
BrowserDialog::Mode::FileSave,
[this, outStr, resultStr](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
{
ostringstream out, result;
out << outStr; // ...and ugly back
result << resultStr;
saveDump(node, out, result);
dlg->prompt().print(result.str() + '\n');
}
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult.str("_EXIT_DEBUGGER");
}
else
saveDump(FilesystemNode(path.str()), out, commandResult);
}
}
@ -1846,9 +1889,21 @@ void DebuggerParser::executeSave()
{
if(argCount && argStrings[0] == "?")
{
debugger.myDialog->showBrowser(DebuggerDialog::svScript, cartName() + ".script");
DebuggerDialog* dlg = debugger.myDialog;
BrowserDialog::show(dlg, "Save Workbench as",
dlg->instance().userDir().getPath() + cartName() + ".script",
BrowserDialog::Mode::FileSave,
[this](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
dlg->prompt().print(saveScriptFile(node.getPath()) + '\n');
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult << "_EXIT_DEBUGGER";
commandResult.str("_EXIT_DEBUGGER");
}
else
commandResult << saveScriptFile(argStrings[0]);
@ -1860,12 +1915,24 @@ void DebuggerParser::executeSaveAccess()
{
if(argCount && argStrings[0] == "?")
{
debugger.myDialog->showBrowser(DebuggerDialog::svAccess, cartName() + ".csv");
DebuggerDialog* dlg = debugger.myDialog;
BrowserDialog::show(dlg, "Save Access Counters as",
dlg->instance().userDir().getPath() + cartName() + ".csv",
BrowserDialog::Mode::FileSave,
[this](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
dlg->prompt().print(debugger.cartDebug().saveAccessFile(node.getPath()) + '\n');
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult << "_EXIT_DEBUGGER";
commandResult.str("_EXIT_DEBUGGER");
}
else
commandResult << debugger.cartDebug().saveAccessFile(argCount ? argStrings[0] : EmptyString);
commandResult << debugger.cartDebug().saveAccessFile();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -1881,12 +1948,24 @@ void DebuggerParser::executeSavedisassembly()
{
if(argCount && argStrings[0] == "?")
{
debugger.myDialog->showBrowser(DebuggerDialog::svDis, cartName() + ".asm");
DebuggerDialog* dlg = debugger.myDialog;
BrowserDialog::show(dlg, "Save Disassembly as",
dlg->instance().userDir().getPath() + cartName() + ".asm",
BrowserDialog::Mode::FileSave,
[this](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
dlg->prompt().print(debugger.cartDebug().saveDisassembly(node.getPath()) + '\n');
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult << "_EXIT_DEBUGGER";
commandResult.str("_EXIT_DEBUGGER");
}
else
commandResult << debugger.cartDebug().saveDisassembly(argCount ? argStrings[0] : EmptyString);
commandResult << debugger.cartDebug().saveDisassembly();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -1895,12 +1974,24 @@ void DebuggerParser::executeSaverom()
{
if(argCount && argStrings[0] == "?")
{
debugger.myDialog->showBrowser(DebuggerDialog::svRom, cartName() + ".a26");
DebuggerDialog* dlg = debugger.myDialog;
BrowserDialog::show(dlg, "Save ROM as",
dlg->instance().userDir().getPath() + cartName() + ".a26",
BrowserDialog::Mode::FileSave,
[this](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
dlg->prompt().print(debugger.cartDebug().saveRom(node.getPath()) + '\n');
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult << "_EXIT_DEBUGGER";
commandResult.str("_EXIT_DEBUGGER");
}
else
commandResult << debugger.cartDebug().saveRom(argCount ? argStrings[0] : EmptyString);
commandResult << debugger.cartDebug().saveRom();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -1913,22 +2004,32 @@ void DebuggerParser::executeSaveses()
if(argCount && argStrings[0] == "?")
{
debugger.myDialog->showBrowser(DebuggerDialog::svSession, filename.str());
commandResult << "_EXIT_DEBUGGER";
DebuggerDialog* dlg = debugger.myDialog;
BrowserDialog::show(dlg, "Save Session as",
dlg->instance().userDir().getPath() + filename.str(),
BrowserDialog::Mode::FileSave,
[this](bool OK, const FilesystemNode& node)
{
DebuggerDialog* dlg = debugger.myDialog;
if(OK)
dlg->prompt().print(debugger.prompt().saveBuffer(node) + '\n');
dlg->prompt().printPrompt();
});
// avoid printing a new prompt
commandResult.str("_EXIT_DEBUGGER");
}
else
{
ostringstream path;
if(argCount)
path << argStrings[0];
else
path << debugger.myOSystem.userDir() << filename.str();
FilesystemNode file(path.str());
if(debugger.prompt().saveBuffer(file))
commandResult << "saved " + file.getShortPath() + " OK";
else
commandResult << "unable to save session";
commandResult << debugger.prompt().saveBuffer(FilesystemNode(path.str()));
}
}
@ -2667,15 +2768,16 @@ std::array<DebuggerParser::Command, 100> DebuggerParser::commands = { {
{
"dump",
"Dump data at address <xx> [to yy] [1: memory; 2: CPU state; 4: input regs]",
"Dump data at address <xx> [to yy] [1: memory; 2: CPU state; 4: input regs] [?]",
"Example:\n"
" dump f000 - dumps 128 bytes from f000\n"
" dump f000 f0ff - dumps all bytes from f000 to f0ff\n"
" dump f000 f0ff 7 - dumps all bytes from f000 to f0ff,\n"
" CPU state and input registers into a file in user dir",
" CPU state and input registers into a file in user dir,\n"
" dump f000 f0ff 7 ? - same, but with a browser dialog\n",
true,
false,
{ Parameters::ARG_WORD, Parameters::ARG_MULTI_BYTE },
{ Parameters::ARG_WORD, Parameters::ARG_WORD, Parameters::ARG_BYTE, Parameters::ARG_LABEL },
std::mem_fn(&DebuggerParser::executeDump)
},
@ -3095,7 +3197,7 @@ std::array<DebuggerParser::Command, 100> DebuggerParser::commands = { {
{
"save",
"Save breaks, watches, traps and functions to file xx",
"Save breaks, watches, traps and functions to file <xx or ?>",
"Example: save commands.script, save ?\n"
"NOTE: saves to user dir by default",
true,
@ -3106,12 +3208,12 @@ std::array<DebuggerParser::Command, 100> DebuggerParser::commands = { {
{
"saveaccess",
"Save the access counters to CSV file",
"Save the access counters to CSV file [?]",
"Example: saveaccess, saveaccess ?\n"
"NOTE: saves to user dir by default",
false,
false,
{ Parameters::ARG_FILE, Parameters::ARG_END_ARGS },
{ Parameters::ARG_LABEL, Parameters::ARG_END_ARGS },
std::mem_fn(&DebuggerParser::executeSaveAccess)
},
@ -3127,34 +3229,34 @@ std::array<DebuggerParser::Command, 100> DebuggerParser::commands = { {
{
"savedis",
"Save Distella disassembly",
"Save Distella disassembly to file [?]",
"Example: savedis, savedis ?\n"
"NOTE: saves to user dir by default",
false,
false,
{ Parameters::ARG_FILE, Parameters::ARG_END_ARGS },
{ Parameters::ARG_LABEL, Parameters::ARG_END_ARGS },
std::mem_fn(&DebuggerParser::executeSavedisassembly)
},
{
"saverom",
"Save (possibly patched) ROM",
"Save (possibly patched) ROM to file [?]",
"Example: saverom, saverom ?\n"
"NOTE: saves to user dir by default",
false,
false,
{ Parameters::ARG_FILE, Parameters::ARG_END_ARGS },
{ Parameters::ARG_LABEL, Parameters::ARG_END_ARGS },
std::mem_fn(&DebuggerParser::executeSaverom)
},
{
"saveses",
"Save console session",
"Save console session to file [?]",
"Example: saveses, saveses ?\n"
"NOTE: saves to user dir by default",
false,
false,
{ Parameters::ARG_FILE, Parameters::ARG_END_ARGS },
{ Parameters::ARG_LABEL, Parameters::ARG_END_ARGS },
std::mem_fn(&DebuggerParser::executeSaveses)
},

2
src/debugger/DebuggerParser.hxx
View File

@ -65,6 +65,8 @@ class DebuggerParser
bool validateArgs(int cmd);
string eval();
string saveScriptFile(string file);
void saveDump(const FilesystemNode& node, const ostringstream& out,
ostringstream& result);
const string& cartName() const;
private:

60
src/debugger/gui/DebuggerDialog.cxx
View File

@ -400,66 +400,6 @@ void DebuggerDialog::createFont()
tooltip().setFont(*myNFont);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void DebuggerDialog::showBrowser(BrowserType type, const string& defaultName)
{
string title, command;
switch(type)
{
case BrowserType::svAccess:
title = "Access Counters";
command = "saveaccess";
break;
case BrowserType::svDis:
title = "Disassembly";
command = "savedis";
break;
case BrowserType::svRom:
title = "ROM";
command = "saverom";
break;
case BrowserType::svScript:
title = "Workbench";
command = "save";
break;
case BrowserType::svSession:
title = "Session";
command = "saveses";
break;
default:
break;
}
if(command != EmptyString)
{
BrowserDialog::show(this, instance().frameBuffer().font(), "Save " + title + " as",
instance().userDir().getPath() + defaultName,
BrowserDialog::Mode::FileSave,
[this, command](bool OK, const FilesystemNode& node) {
if(OK) runCommand(node, command);
else runCommand(node);
});
}
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void DebuggerDialog::runCommand(const FilesystemNode& node, const string& command)
{
if(command != EmptyString)
{
string result = instance().debugger().parser().run(command + " {" +
node.getPath() + "}");
prompt().print(result + '\n');
}
prompt().printPrompt();
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void DebuggerDialog::showFatalMessage(const string& msg)
{

11
src/debugger/gui/DebuggerDialog.hxx
View File

@ -55,13 +55,6 @@ class DebuggerDialog : public Dialog
kMediumFontMinW = 1160, kMediumFontMinH = 770,
kLargeFontMinW = 1160, kLargeFontMinH = 870
};
enum BrowserType {
svAccess, // saveaccess
svDis, // savedis
svRom, // saverom
svScript, // save
svSession // saveses
};
DebuggerDialog(OSystem& osystem, DialogContainer& parent,
int x, int y, int w, int h);
@ -82,7 +75,6 @@ class DebuggerDialog : public Dialog
void showFatalMessage(const string& msg);
void saveConfig() override;
void showBrowser(BrowserType type, const string& defaultName);
private:
void setPosition() override { positionAt(0); }
@ -127,9 +119,6 @@ class DebuggerDialog : public Dialog
kDDOptionsCmd = 'DDop'
};
void runCommand(const FilesystemNode& node,
const string& command = EmptyString);
TabWidget *myTab{nullptr}, *myRomTab{nullptr};
PromptWidget* myPrompt{nullptr};

11
src/debugger/gui/PromptWidget.cxx
View File

@ -968,7 +968,7 @@ void PromptWidget::scrollToCurrent()
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bool PromptWidget::saveBuffer(const FilesystemNode& file)
string PromptWidget::saveBuffer(const FilesystemNode& file)
{
stringstream out;
for(int start = 0; start < _promptStartPos; start += _lineWidth)
@ -988,8 +988,13 @@ bool PromptWidget::saveBuffer(const FilesystemNode& file)
out << endl;
}
try { return file.write(out) > 0; }
catch(...) { return false; }
try {
if(file.write(out) > 0)
return "saved " + file.getShortPath() + " OK";
}
catch(...) { }
return "unable to save session";
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

2
src/debugger/gui/PromptWidget.hxx
View File

@ -46,7 +46,7 @@ class PromptWidget : public Widget, public CommandSender
ATTRIBUTE_FMT_PRINTF int vprintf(const char* format, va_list argptr);
void print(const string& str);
void printPrompt();
bool saveBuffer(const FilesystemNode& file);
string saveBuffer(const FilesystemNode& file);
// Clear screen and erase all history
void clearScreen();

13
src/gui/BrowserDialog.cxx
View File

@ -20,6 +20,7 @@
#include "FSNode.hxx"
#include "GuiObject.hxx"
#include "OSystem.hxx"
#include "FrameBuffer.hxx"
#include "EditTextWidget.hxx"
#include "FileListWidget.hxx"
#include "Widget.hxx"
@ -131,6 +132,17 @@ void BrowserDialog::show(GuiObject* parent, const GUI::Font& font,
ourBrowser->show(startpath, mode, command, namefilter);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void BrowserDialog::show(GuiObject* parent,
const string& title, const string& startpath,
BrowserDialog::Mode mode,
const Command& command,
const FilesystemNode::NameFilter& namefilter)
{
show(parent, parent->instance().frameBuffer().font(), title, startpath,
mode, command, namefilter);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void BrowserDialog::show(const string& startpath,
BrowserDialog::Mode mode,
@ -247,7 +259,6 @@ void BrowserDialog::handleCommand(CommandSender* sender, int cmd,
// Send a signal to the calling class that a selection has been made
if(_mode != Mode::Directories)
{
// TODO: check if affected by '-baseDir'and 'basedirinapp' params
bool savePath = _savePathBox->getState();
instance().settings().setValue("saveuserdir", savePath);

17
src/gui/BrowserDialog.hxx
View File

@ -69,6 +69,23 @@ class BrowserDialog : public Dialog
const FilesystemNode::NameFilter& namefilter = {
[](const FilesystemNode&) { return true; }});
/**
Place the browser window onscreen, using the given attributes.
@param parent The parent object of the browser (cannot be nullptr)
@param title The title of the browser window
@param startpath The initial path to select in the browser
@param mode The functionality to use (load/save/display)
@param command The command to run when 'OK' or 'Cancel' is clicked
@param namefilter Filter files/directories in browser display
*/
static void show(GuiObject* parent,
const string& title, const string& startpath,
BrowserDialog::Mode mode,
const Command& command,
const FilesystemNode::NameFilter& namefilter = {
[](const FilesystemNode&) { return true; } });
private:
/** Place the browser window onscreen, using the given attributes */
void show(const string& startpath,