/* AppleWin : An Apple //e emulator for Windows Copyright (C) 1994-1996, Michael O'Brien Copyright (C) 1999-2001, Oliver Schmidt Copyright (C) 2002-2005, Tom Charlesworth Copyright (C) 2006-2014, Tom Charlesworth, Michael Pohoreski AppleWin 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. AppleWin 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 AppleWin; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* Description: Debugger * * Author: Copyright (C) 2006-2010 Michael Pohoreski */ #include "StdAfx.h" #include #include "Debug.h" #include "../Core.h" #define DEBUG_COLOR_CONSOLE 0 // Utility ________________________________________________________________________________________ /* String types: http://www.codeproject.com/cpp/unicode.asp TEXT() _tcsrev _UNICODE Unicode _wcsrev _MBCS Multi-byte _mbsrev n/a ASCII strrev */ // Help ___________________________________________________________________________________________ //=========================================================================== Update_t HelpLastCommand() { return Help_Arg_1( g_iCommand ); } // Loads the arguments with the command to get help on and call display help. //=========================================================================== Update_t Help_Arg_1( int iCommandHelp ) { _Arg_1( iCommandHelp ); strncpy_s(g_aArgs[1].sArg, g_aCommands[iCommandHelp].m_sName, _TRUNCATE); // .3 Fixed: Help_Arg_1() now copies command name into arg.name return CmdHelpSpecific( 1 ); } //=========================================================================== void Help_Categories() { // TODO/FIXME: Colorize( sText, ... ) // Colorize("Usage:") std::string sText = CHC_USAGE "Usage" CHC_DEFAULT ": " CHC_ARG_OPT "[ " CHC_ARG_MAND "< "; for (int iCategory = _PARAM_HELPCATEGORIES_BEGIN ; iCategory < _PARAM_HELPCATEGORIES_END; iCategory++) { const char *pName = g_aParameters[ iCategory ].m_sName; if (sText.length() + strlen(pName) >= (CONSOLE_WIDTH - 1)) { ConsolePrint( sText.c_str() ); sText = " "; // indent } sText += CHC_COMMAND; sText += pName; if (iCategory < (_PARAM_HELPCATEGORIES_END - 1)) { const char sSep[] = " | "; if (sText.length() + strlen(sSep) >= (CONSOLE_WIDTH - 1)) { ConsolePrint( sText.c_str() ); sText = " "; // indent } sText += CHC_ARG_SEP; sText += sSep; } } sText += CHC_ARG_MAND " >" CHC_ARG_OPT " ]"; // ConsoleBufferPush( sText.c_str() ); ConsolePrint( sText.c_str() ); // Transcode colored text to native console color text ConsolePrintFormat( CHC_USAGE "Notes" CHC_DEFAULT ": " CHC_ARG_MAND "<>" CHC_DEFAULT " = mandatory, " CHC_ARG_OPT "[]" CHC_DEFAULT " = optional, " CHC_ARG_SEP "|" CHC_DEFAULT " argument option" ); // ConsoleBufferPush( sText.c_str() ); } void Help_Examples() { ConsolePrintFormat( " %sExamples%s:%s" , CHC_USAGE , CHC_ARG_SEP , CHC_DEFAULT ); } //=========================================================================== void Help_Range() { ConsoleBufferPush( " Where is of the form:" ); ConsoleBufferPush( " address , length [address,address+length)" ); ConsoleBufferPush( " address : end [address,end]" ); } //=========================================================================== void Help_Operators() { // ConsolePrintFormat( " %sOperators%s:" , CHC_USAGE, CHC_DEFAULT ); // ConsolePrintFormat( " Operators: (Math)" ); ConsolePrintFormat( " Operators: (%sMath%s)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s+%s Addition" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s-%s Subtraction" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s*%s Multiplication" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s/%s Division" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s%%%s Modulas or Remainder" , CHC_USAGE, CHC_DEFAULT ); // ConsoleBufferPush( " Operators: (Bit Wise)" ); ConsolePrintFormat( " Operators: (%sBit Wise%s)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s&%s Bit-wise and (AND)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s|%s Bit-wise or (OR )" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s^%s Bit-wise exclusive-or (EOR/XOR)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s!%s Bit-wise negation (NOT)" , CHC_USAGE, CHC_DEFAULT ); // ConsoleBufferPush( " Operators: (Input)" ); ConsolePrintFormat( " Operators: (%sInput%s)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s@%s next number refers to search results", CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s\"%s Designate string in ASCII format" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s\'%s Desginate string in High-Bit apple format", CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s$%s Designate number/symbol" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s#%s Designate number in hex" , CHC_USAGE, CHC_DEFAULT ); // ConsoleBufferPush( " Operators: (Range)" ); ConsolePrintFormat( " Operators: (%sRange%s)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s,%s range separator (2nd address is relative)", CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s:%s range separator (2nd address is absolute)", CHC_USAGE, CHC_DEFAULT ); // ConsolePrintFormat( " Operators: (Misc)" ); ConsolePrintFormat( " Operators: (%sMisc%s)" , CHC_USAGE, CHC_DEFAULT ); ConsolePrintFormat( " %s//%s comment until end of line" , CHC_USAGE, CHC_DEFAULT ); // ConsoleBufferPush( " Operators: (Breakpoint)" ); ConsolePrintFormat( " Operators: (%sBreakpoint%s)" , CHC_USAGE, CHC_DEFAULT ); std::string sText = " " CHC_USAGE; for ( int iBreakOp = 0; iBreakOp < NUM_BREAKPOINT_OPERATORS; iBreakOp++ ) { if ((iBreakOp >= PARAM_BP_LESS_EQUAL) && (iBreakOp <= PARAM_BP_GREATER_EQUAL)) { sText += g_aBreakpointSymbols[ iBreakOp ]; sText += ' '; } } sText += CHC_DEFAULT; ConsolePrint( sText.c_str() ); } void Help_KeyboardShortcuts() { ConsoleBufferPush(" Scrolling:" ); ConsoleBufferPush(" Up Arrow" ); ConsoleBufferPush(" Down Arrow" ); ConsoleBufferPush(" Shift + Up Arrow" ); ConsoleBufferPush(" Shift + Down Arrow" ); ConsoleBufferPush(" Page Up" ); ConsoleBufferPush(" Page Down" ); ConsoleBufferPush(" Shift + Page Up" ); ConsoleBufferPush(" Shift + Page Down" ); ConsoleBufferPush(" Bookmarks:" ); ConsoleBufferPush(" Ctrl-Shift-#" ); ConsoleBufferPush(" Ctrl-# " ); } void _ColorizeHeader( char * & pDst,const char * & pSrc, const char * pHeader, const int nHeaderLen ) { int nLen; nLen = strlen( CHC_USAGE ); strcpy( pDst, CHC_USAGE ); pDst += nLen; nLen = nHeaderLen - 1; strncpy( pDst, pHeader, nLen ); pDst += nLen; pSrc += nHeaderLen; nLen = strlen( CHC_ARG_SEP ); strcpy( pDst, CHC_ARG_SEP ); pDst += nLen; *pDst = ':'; pDst++; nLen = strlen( CHC_DEFAULT ); strcpy( pDst, CHC_DEFAULT ); pDst += nLen; } void _ColorizeString( char * & pDst, const char *pSrc, const size_t nLen ) { strcpy( pDst, pSrc ); pDst += nLen; } // pOperator is one of CHC_* void _ColorizeOperator( char * & pDst, const char * & pSrc, const char * pOperator ) { int nLen; nLen = strlen( pOperator ); strcpy( pDst, pOperator ); pDst += nLen; *pDst = *pSrc; pDst++; nLen = strlen( CHC_DEFAULT ); strcpy( pDst, CHC_DEFAULT ); pDst += nLen; pSrc++; } bool isHexDigit( char c ) { if ((c >= '0') && (c <= '9')) return true; if ((c >= 'A') && (c <= 'F')) return true; if ((c >= 'a') && (c <= 'f')) return true; return false; } // TODO: Use nDstSz to prevent buffer overflow. // Alternatively, Colorize() may simply return a std::string. bool Colorize( char * pDst, size_t /*nDstSz*/, const char* pSrc) { if (! pSrc) return false; if (! pDst) return false; const char sNote [] = "Note:"; const int nNote = sizeof( sNote ) - 1; const char sSeeAlso[] = "See also:"; const char nSeeAlso = sizeof( sSeeAlso ) - 1; const char sUsage[] = "Usage:"; const int nUsage = sizeof( sUsage ) - 1; const char sTotal[] = "Total:"; const int nTotal = sizeof( sTotal ) - 1; const char sExamples[] = "Examples:"; const int nExamples = sizeof( sExamples ) - 1; while (*pSrc) { if (strncmp( sUsage, pSrc, nUsage) == 0) { _ColorizeHeader( pDst, pSrc, sUsage, nUsage ); } else if (strncmp( sSeeAlso, pSrc, nSeeAlso) == 0) { _ColorizeHeader( pDst, pSrc, sSeeAlso, nSeeAlso ); } else if (strncmp( sNote, pSrc, nNote) == 0) { _ColorizeHeader( pDst, pSrc, sNote, nNote ); } else if (strncmp( sTotal, pSrc, nNote) == 0) { _ColorizeHeader( pDst, pSrc, sTotal, nTotal ); } else if (strncmp( sExamples, pSrc, nExamples) == 0) { _ColorizeHeader( pDst, pSrc, sExamples, nExamples ); } else if (*pSrc == '[') { _ColorizeOperator( pDst, pSrc, CHC_ARG_OPT ); } else if (*pSrc == ']') { _ColorizeOperator( pDst, pSrc, CHC_ARG_OPT ); } else if (*pSrc == '<') { _ColorizeOperator( pDst, pSrc, CHC_ARG_MAND ); } else if (*pSrc == '>') { _ColorizeOperator( pDst, pSrc, CHC_ARG_MAND ); } else if (*pSrc == '|') { _ColorizeOperator( pDst, pSrc, CHC_ARG_SEP ); } else if (*pSrc == '\'') { _ColorizeOperator( pDst, pSrc, CHC_ARG_SEP ); } else if ((*pSrc == '$') && isHexDigit(pSrc[1])) // Hex Number { _ColorizeOperator( pDst, pSrc, CHC_ARG_SEP ); const char *start = pSrc; const char *end = pSrc; while ( isHexDigit( *end ) ) end++; size_t nDigits = end - start; _ColorizeString( pDst, CHC_NUM_HEX, strlen( CHC_NUM_HEX ) ); _ColorizeString( pDst, start , nDigits ); _ColorizeString( pDst, CHC_DEFAULT, strlen( CHC_DEFAULT ) ); pSrc += nDigits; } else { *pDst = *pSrc; pDst++; pSrc++; } } *pDst = 0; return true; } template inline bool Colorize(char (&szDst)[_DstSz], const char* pSrc) { return Colorize(szDst, _DstSz, pSrc); } // NOTE: This appends a new line inline bool ConsoleColorizePrint( const char* pText ) { char colorizeBuf[CONSOLE_WIDTH * 2]; if (!Colorize(colorizeBuf, pText)) return false; ConsolePrint(colorizeBuf); return true; } inline bool ConsoleColorizePrintVa( const char* format, va_list va ) { std::string strText = StrFormatV(format, va); return ConsoleColorizePrint(strText.c_str()); } inline bool ConsoleColorizePrintFormat( const char* format, ... ) ATTRIBUTE_FORMAT_PRINTF(1, 2); inline bool ConsoleColorizePrintFormat( const char* format, ... ) { va_list va; va_start(va, format); bool const r = ConsoleColorizePrintVa(format, va); va_end(va); return r; } //=========================================================================== Update_t CmdMOTD( int nArgs ) // Message Of The Day { #if DEBUG_COLOR_CONSOLE ConsolePrint( "`" ); ConsolePrint( "`A" ); ConsolePrint( "`2`A" ); #endif ConsolePrint( "`9`A`7 Apple `9][ ][+ //e `7Emulator for Windows (TM) `9`@" ); CmdVersion(0); CmdSymbols(0); ConsoleColorizePrintFormat( " '%sCtrl ~'%s console, '%s%s'%s (specific), '%s%s'%s (all)" , CHC_KEY , CHC_DEFAULT , CHC_COMMAND , g_aCommands[ CMD_HELP_SPECIFIC ].m_sName , CHC_DEFAULT // , g_aCommands[ CMD_HELP_SPECIFIC ].pHelpSummary , CHC_COMMAND , g_aCommands[ CMD_HELP_LIST ].m_sName , CHC_DEFAULT // , g_aCommands[ CMD_HELP_LIST ].pHelpSummary ); ConsoleUpdate(); return UPDATE_ALL; } // Help on specific command //=========================================================================== Update_t CmdHelpSpecific (int nArgs) { int iArg; if (! nArgs) { Help_Categories(); return ConsoleUpdate(); } CmdFuncPtr_t pFunction = NULL; bool bAllCommands = false; bool bCategory = false; bool bDisplayCategory = true; if ((! _tcscmp( g_aArgs[1].sArg, g_aParameters[ PARAM_WILDSTAR ].m_sName)) || (! _tcscmp( g_aArgs[1].sArg, g_aParameters[ PARAM_MEM_SEARCH_WILD ].m_sName)) ) { bAllCommands = true; nArgs = NUM_COMMANDS; } // If Help on category, push command name as arg // Mame has categories: // General, Memory, Execution, Breakpoints, Watchpoints, Expressions, Comments int iParam = 0; int nNewArgs = 0; int iCmdBegin = 0; int iCmdEnd = 0; int nFound = 0; int iCommand = 0; if (! bAllCommands) { for (iArg = 1; iArg <= nArgs; iArg++ ) { // int nFoundCategory = FindParam( g_aArgs[ iArg ].sArg, MATCH_EXACT, iParam, _PARAM_HELPCATEGORIES_BEGIN, _PARAM_HELPCATEGORIES_END ); int nFoundCategory = FindParam( g_aArgs[ iArg ].sArg, MATCH_FUZZY, iParam, _PARAM_HELPCATEGORIES_BEGIN, _PARAM_HELPCATEGORIES_END ); if ( nFoundCategory ) bCategory = true; else bCategory = false; switch ( iParam ) { case PARAM_CAT_BOOKMARKS : iCmdBegin = CMD_BOOKMARK ; iCmdEnd = CMD_BOOKMARK_SAVE ; break; case PARAM_CAT_BREAKPOINTS: iCmdBegin = CMD_BREAK_INVALID ; iCmdEnd = CMD_BREAKPOINT_CHANGE ; break; case PARAM_CAT_CONFIG : iCmdBegin = CMD_BENCHMARK ; iCmdEnd = CMD_CONFIG_SET_DEBUG_DIR; break; case PARAM_CAT_CPU : iCmdBegin = CMD_ASSEMBLE ; iCmdEnd = CMD_UNASSEMBLE ; break; case PARAM_CAT_FLAGS : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if ( nFound ) // && (iCommand != CMD_MEMORY_FILL)) bCategory = false; else if ( nFoundCategory ) { iCmdBegin = CMD_FLAG_CLEAR ; iCmdEnd = CMD_FLAG_SET_N; } break; case PARAM_CAT_HELP : iCmdBegin = CMD_HELP_LIST ; iCmdEnd = CMD_MOTD ; break; case PARAM_CAT_KEYBOARD : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if ((!nFound) || (iCommand != CMD_INPUT_KEY)) { nArgs = 0; Help_KeyboardShortcuts(); } bCategory = false; break; case PARAM_CAT_MEMORY : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if ( nFound )// && (iCommand != CMD_MEMORY_MOVE)) bCategory = false; else if ( nFoundCategory ) { iCmdBegin = CMD_MEMORY_COMPARE ; iCmdEnd = CMD_MEMORY_FILL ; } break; case PARAM_CAT_OUTPUT : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if ( nFound ) // && (iCommand != CMD_OUT)) bCategory = false; else if ( nFoundCategory ) { iCmdBegin = CMD_OUTPUT_CALC ; iCmdEnd = CMD_OUTPUT_RUN ; } break; case PARAM_CAT_SYMBOLS : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if ( nFound ) // && (iCommand != CMD_SYMBOLS_LOOKUP) && (iCommand != CMD_MEMORY_SEARCH)) bCategory = false; else if ( nFoundCategory ) { iCmdBegin = CMD_SYMBOLS_LOOKUP ; iCmdEnd = CMD_SYMBOLS_LIST ; } break; case PARAM_CAT_VIEW : { iCmdBegin = CMD_VIEW_TEXT4X ; iCmdEnd = CMD_VIEW_DHGR2 ; } break; case PARAM_CAT_WATCHES : nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); // check if we have an exact command match first if (nFound) { bCategory = false; } else // 2.7.0.17: HELP wasn't displaying when category was one of: FLAGS, OUTPUT, WATCHES if ( nFoundCategory ) { iCmdBegin = CMD_WATCH_ADD ; iCmdEnd = CMD_WATCH_LIST ; } break; case PARAM_CAT_WINDOW : iCmdBegin = CMD_WINDOW ; iCmdEnd = CMD_WINDOW_OUTPUT ; break; case PARAM_CAT_ZEROPAGE : iCmdBegin = CMD_ZEROPAGE_POINTER; iCmdEnd = CMD_ZEROPAGE_POINTER_SAVE; break; // case PARAM_CAT_EXPRESSION : // fall-through case PARAM_CAT_OPERATORS : nArgs = 0; Help_Operators(); break; case PARAM_CAT_RANGE : // HACK: check if we have an exact command match first nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); if ((!nFound) || (iCommand != CMD_REGISTER_SET)) { nArgs = 0; Help_Range(); } bCategory = false; break; default: bCategory = false; break; } if (iCmdEnd) iCmdEnd++; nNewArgs = (iCmdEnd - iCmdBegin); if (nNewArgs > 0) break; } } if (nNewArgs > 0) { nArgs = nNewArgs; for (iArg = 1; iArg <= nArgs; iArg++ ) { #if DEBUG_VAL_2 g_aArgs[ iArg ].nVal2 = iCmdBegin + iArg - 1; #endif g_aArgs[ iArg ].nValue = iCmdBegin + iArg - 1; } } for (iArg = 1; iArg <= nArgs; iArg++ ) { iCommand = 0; nFound = 0; if (bCategory) { #if DEBUG_VAL_2 iCommand = g_aArgs[iArg].nVal2; #endif iCommand = g_aArgs[ iArg ].nValue; nFound = 1; } else if (bAllCommands) { iCommand = iArg; if (iCommand == NUM_COMMANDS) // skip: Internal Consistency Check __COMMANDS_VERIFY_TXT__ continue; nFound = 1; } else nFound = FindCommand( g_aArgs[iArg].sArg, pFunction, & iCommand ); if (nFound > 1) { DisplayAmbigiousCommands( nFound ); } if (iCommand > NUM_COMMANDS) continue; if ((nArgs == 1) && (! nFound)) iCommand = g_aArgs[iArg].nValue; Command_t *pCommand = & g_aCommands[ iCommand ]; if (! nFound) { iCommand = NUM_COMMANDS; pCommand = NULL; } // if (nFound && (! bAllCommands) && (! bCategory)) if (nFound && (! bAllCommands) && bDisplayCategory) { const char* pCategory = ""; int iCmd = g_aCommands[ iCommand ].iCommand; // Unaliased command // HACK: Major kludge to display category!!! if (iCmd <= CMD_UNASSEMBLE) pCategory = g_aParameters[ PARAM_CAT_CPU ].m_sName; else if (iCmd <= CMD_BOOKMARK_SAVE) pCategory = g_aParameters[ PARAM_CAT_BOOKMARKS ].m_sName; else if (iCmd <= CMD_BREAKPOINT_SAVE) pCategory = g_aParameters[ PARAM_CAT_BREAKPOINTS ].m_sName; else if (iCmd <= CMD_CONFIG_SET_DEBUG_DIR) pCategory = g_aParameters[ PARAM_CAT_CONFIG ].m_sName; else if (iCmd <= CMD_CURSOR_PAGE_DOWN_4K) pCategory = "Scrolling"; else if (iCmd <= CMD_FLAG_SET_N) pCategory = g_aParameters[ PARAM_CAT_FLAGS ].m_sName; else if (iCmd <= CMD_MOTD) pCategory = g_aParameters[ PARAM_CAT_HELP ].m_sName; else if (iCmd <= CMD_MEMORY_FILL) pCategory = g_aParameters[ PARAM_CAT_MEMORY ].m_sName; else if (iCmd <= CMD_OUTPUT_RUN) pCategory = g_aParameters[ PARAM_CAT_OUTPUT ].m_sName; else if (iCmd <= CMD_SYNC) pCategory = "Source"; else if (iCmd <= CMD_SYMBOLS_LIST) pCategory = g_aParameters[ PARAM_CAT_SYMBOLS ].m_sName; else if (iCmd <= CMD_VIEW_DHGR2) pCategory = g_aParameters[ PARAM_CAT_VIEW ].m_sName; else if (iCmd <= CMD_WATCH_SAVE) pCategory = g_aParameters[ PARAM_CAT_WATCHES ].m_sName; else if (iCmd <= CMD_WINDOW_OUTPUT) pCategory = g_aParameters[ PARAM_CAT_WINDOW ].m_sName; else if (iCmd <= CMD_ZEROPAGE_POINTER_SAVE) pCategory = g_aParameters[ PARAM_CAT_ZEROPAGE ].m_sName; else pCategory = "Unknown!"; ConsolePrintFormat( "%sCategory%s: %s%s" , CHC_USAGE , CHC_DEFAULT , CHC_CATEGORY , pCategory ); if (bCategory) bDisplayCategory = false; } if (pCommand) { const char *const pHelp = pCommand->pHelpSummary; if (pHelp) { std::string strText = StrFormat((bCategory) ? "%s%8s%s, %s%s" : "%s%s%s, %s%s", CHC_COMMAND, pCommand->m_sName, CHC_ARG_SEP, CHC_DEFAULT, pHelp); //ConsoleBufferPush( strText.c_str() ); ConsolePrint( strText.c_str() ); } else { #if _DEBUG ConsoleBufferPushFormat( "%s <-- Missing", pCommand->m_sName ); #if DEBUG_COMMAND_HELP if (! bAllCommands) // Release version doesn't display message { ConsoleBufferPushFormat( "Missing Summary Help: %s", g_aCommands[ iCommand ].aName ); } #endif #endif } if (bCategory) continue; } // MASTER HELP switch (iCommand) { // CPU / General case CMD_ASSEMBLE: ConsoleColorizePrint( " Usage: [address | symbol]" ); ConsoleBufferPush( " Enter mini-assembler mode [starting at optional address or symbol]." ); break; case CMD_UNASSEMBLE: ConsoleColorizePrint( " Usage: [address | symbol]" ); ConsoleBufferPush( " Disassembles memory." ); break; case CMD_GO_NORMAL_SPEED: case CMD_GO_FULL_SPEED: ConsoleColorizePrint( " Usage: address | symbol [Skip,Length]" ); ConsoleColorizePrint( " Usage: address | symbol [Start:End]" ); ConsoleBufferPush( " Skip : Start address to skip stepping" ); ConsoleBufferPush( " Length: Range of bytes past start address to skip stepping" ); ConsoleBufferPush( " End : Inclusive end address to skip stepping" ); ConsoleBufferPush( " If the Program Counter is outside the skip range, resumes single-stepping." ); ConsoleBufferPush( " Can be used to skip ROM/OS/user code." ); Help_Examples(); ConsolePrintFormat( "%s G[G] C600 FA00,600" , CHC_EXAMPLE ); ConsolePrintFormat( "%s G[G] C600 F000:FFFF", CHC_EXAMPLE ); break; case CMD_JSR: ConsoleColorizePrint( " Usage: [symbol | address]" ); ConsoleBufferPush( " Pushes PC on stack; calls the named subroutine." ); break; case CMD_NOP: ConsoleBufferPush( " Puts a NOP opcode at current instruction" ); break; case CMD_OUT: ConsoleColorizePrint( " Usage: [address8 | address16 | symbol] ## [##]" ); ConsoleBufferPush( " Output a byte or word to the IO address $C0xx" ); break; case CMD_PROFILE: ConsoleColorizePrintFormat( " Usage: [%s | %s | %s]" , g_aParameters[ PARAM_RESET ].m_sName , g_aParameters[ PARAM_SAVE ].m_sName , g_aParameters[ PARAM_LIST ].m_sName ); ConsoleBufferPush( " No arguments resets the profile." ); break; // Registers case CMD_REGISTER_SET: ConsoleColorizePrint( " Usage: " ); ConsoleBufferPush( " Where is one of: A X Y P PC SP " ); ConsoleColorizePrintFormat( " See also: %s%s" , CHC_CATEGORY , g_aParameters[ PARAM_CAT_OPERATORS ].m_sName ); Help_Examples(); ConsolePrintFormat( "%s R PC RESET + 1", CHC_EXAMPLE ); ConsolePrintFormat( "%s R PC $FC58" , CHC_EXAMPLE ); ConsolePrintFormat( "%s R A A1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s R A $A1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s R A #A1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s R P 0" , CHC_EXAMPLE ); break; case CMD_SOURCE: // ConsoleBufferPush( " Reads assembler source file." ); ConsoleColorizePrintFormat( " Usage: [ %s | %s ] \"filename\"" , g_aParameters[ PARAM_SRC_MEMORY ].m_sName, g_aParameters[ PARAM_SRC_SYMBOLS ].m_sName ); ConsoleBufferPushFormat( " %s: read source bytes into memory." , g_aParameters[ PARAM_SRC_MEMORY ].m_sName ); ConsoleBufferPushFormat( " %s: read symbols into Source symbol table.", g_aParameters[ PARAM_SRC_SYMBOLS ].m_sName ); ConsoleBufferPushFormat( " Supports: %s." , g_aParameters[ PARAM_SRC_MERLIN ].m_sName ); break; case CMD_STEP_OUT: ConsoleBufferPush( " Steps out of current subroutine" ); ConsoleBufferPush( " Hotkey: Ctrl-Space" ); // TODO: FIXME break; case CMD_STEP_OVER: // Bad name? FIXME/TODO: do we need to rename? ConsoleColorizePrint( " Usage: [#]" ); ConsoleBufferPush( " Steps, # times, thru current instruction" ); ConsoleBufferPush( " JSR will be stepped into AND out of." ); ConsoleBufferPush( " Hotkey: Ctrl-Space" ); // TODO: FIXME break; case CMD_TRACE: ConsoleColorizePrint( " Usage: [#]" ); ConsoleBufferPush( " Traces, # times, current instruction(s)" ); ConsoleBufferPush( " JSR will be stepped into" ); ConsoleBufferPush( " Hotkey: Shift-Space" ); break; case CMD_TRACE_FILE: ConsoleColorizePrint( " Usage: \"[filename]\" [v]" ); break; case CMD_TRACE_LINE: ConsoleColorizePrint( " Usage: [#]" ); ConsoleBufferPush( " Traces into current instruction" ); ConsoleBufferPush( " with cycle counting." ); break; // Bookmarks case CMD_BOOKMARK: case CMD_BOOKMARK_ADD: ConsoleColorizePrint( " Usage: [address | symbol]" ); ConsoleColorizePrint( " Usage: #
" ); ConsoleBufferPush(" If no address or symbol is specified, lists the current bookmarks." ); ConsoleBufferPush(" Updates the specified bookmark (#)" ); Help_Examples(); ConsolePrintFormat( "%s %s RESET ", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 1 HOME", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BOOKMARK_CLEAR: ConsoleColorizePrint( " Usage: [# | *]" ); ConsoleBufferPush( " Clears specified bookmark, or all." ); Help_Examples(); ConsolePrintFormat( "%s %s 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BOOKMARK_LIST: // case CMD_BOOKMARK_LOAD: case CMD_BOOKMARK_SAVE: break; // Breakpoints case CMD_BREAK_INVALID: ConsoleColorizePrintFormat( " Usage: [%s%s | %s%s]" , CHC_COMMAND , g_aParameters[PARAM_ON].m_sName , CHC_COMMAND , g_aParameters[PARAM_OFF].m_sName ); ConsoleColorizePrintFormat(" Usage: [# | # %s%s | # %s%s]" , CHC_COMMAND , g_aParameters[PARAM_ON].m_sName , CHC_COMMAND , g_aParameters[PARAM_OFF].m_sName ); ConsoleColorizePrintFormat( " Usage: [%s%s %s%s | %s%s %s%s]" , CHC_COMMAND , g_aParameters[PARAM_ALL].m_sName , CHC_COMMAND , g_aParameters[PARAM_ON].m_sName , CHC_COMMAND , g_aParameters[PARAM_ALL].m_sName , CHC_COMMAND , g_aParameters[PARAM_OFF].m_sName ); ConsoleColorizePrint( "Where: # is 0=BRK, 1=Invalid Opcode_1, 2=Invalid Opcode_2, 3=Invalid Opcode_3"); break; // case CMD_BREAK_OPCODE: case CMD_BREAKPOINT: ConsoleColorizePrintFormat( " Usage: [%s%s | %s%s | %s%s]" , CHC_COMMAND , g_aParameters[ PARAM_LOAD ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_SAVE ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_RESET ].m_sName ); ConsolePrintFormat( " Maximum breakpoints: %s%d", CHC_NUM_DEC, MAX_BREAKPOINTS ); ConsoleBufferPush( " Set breakpoint at PC if no args." ); ConsoleBufferPush( " Loading/Saving not yet implemented." ); break; case CMD_BREAKPOINT_ADD_REG: ConsoleColorizePrint( " Usage: [A|X|Y|PC|S] [op] " ); ConsoleBufferPush( " Set breakpoint when reg is [op] value" ); ConsoleBufferPush( " Default operator is '='" ); ConsoleColorizePrintFormat( " See also: %s%s" , CHC_CATEGORY , g_aParameters[ PARAM_CAT_OPERATORS ].m_sName ); // ConsoleBufferPush( " Examples:" ); Help_Examples(); ConsolePrintFormat( "%s %s PC < D000" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s PC = F000:FFFF PC < D000,1000", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s A <= D5" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s A != 01:FF" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s X = A5" , CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BREAKPOINT_ADD_SMART: ConsoleColorizePrint( " Usage: [address | register]" ); ConsoleBufferPush( " If address, sets two breakpoints" ); ConsoleBufferPush( " 1. one memory access at address" ); ConsoleBufferPush( " 2. if PC reaches address" ); // "Sets a breakpoint at the current PC or specified address." ); ConsoleBufferPush( " If an IO address, sets breakpoint on IO access." ); ConsoleBufferPush( " If register, sets a breakpoint on memory access at address of register." ); break; case CMD_BREAKPOINT_ADD_PC: ConsoleColorizePrint( " Usage: [address]" ); ConsoleBufferPush( " Sets a breakpoint at the current PC or at the specified address." ); break; case CMD_BREAKPOINT_CLEAR: ConsoleColorizePrint( " Usage: [# | *]" ); ConsoleBufferPush( " Clears specified breakpoint, or all." ); Help_Examples(); ConsolePrintFormat( "%s %s 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BREAKPOINT_DISABLE: ConsoleColorizePrint( " Usage: [# [,#] | *]" ); ConsoleBufferPush( " Disable breakpoint previously set, or all." ); Help_Examples(); ConsolePrintFormat( "%s %s 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BREAKPOINT_ENABLE: ConsoleColorizePrint( " Usage: [# [,#] | *]" ); ConsoleBufferPush( " Re-enables breakpoint previously set, or all." ); Help_Examples(); ConsolePrintFormat( "%s %s 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_BREAKPOINT_LIST: break; case CMD_BREAKPOINT_ADD_MEM: case CMD_BREAKPOINT_ADD_MEMR: case CMD_BREAKPOINT_ADD_MEMW: ConsoleColorizePrint( " Usage: " ); Help_Range(); break; case CMD_BREAKPOINT_ADD_VIDEO: ConsoleColorizePrint( " Usage: " ); break; // Config - Load / Save case CMD_CONFIG_LOAD: ConsoleColorizePrint( " Usage: [\"filename\"]" ); ConsoleBufferPushFormat( " Load debugger configuration from '%s', or the specificed file.", g_sFileNameConfig.c_str() ); break; case CMD_CONFIG_SAVE: ConsoleColorizePrint( " Usage: [\"filename\"]" ); ConsoleBufferPushFormat( " Save debugger configuration to '%s', or the specificed file.", g_sFileNameConfig.c_str() ); break; // Config - Color case CMD_CONFIG_COLOR: ConsoleBufferPush( " Usage: [<#> | <# RR GG BB>]" ); ConsoleBufferPush( " 0 params: switch to 'color' scheme" ); ConsoleBufferPush( " 1 param : dumps R G B for scheme 'color'" ); ConsoleBufferPush( " 4 params: sets R G B for scheme 'color'" ); break; case CMD_CONFIG_MONOCHROME: ConsoleBufferPush( " Usage: [<#> | <# RR GG BB>]" ); ConsoleBufferPush( " 0 params: switch to 'monochrome' scheme" ); ConsoleBufferPush( " 1 param : dumps R G B for scheme 'monochrome'" ); ConsoleBufferPush( " 4 params: sets R G B for scheme 'monochrome'" ); break; // Config - Diasm case CMD_CONFIG_DISASM: { ConsoleColorizePrint( " Note: All arguments effect the disassembly view" ); ConsoleColorizePrintFormat( " Usage: [%s%s | %s%s | %s%s | %s%s | %s%s | %s%s]" , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_BRANCH ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_CLICK ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_COLON ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_OPCODE ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_SPACES ].m_sName , CHC_COMMAND , g_aParameters[ PARAM_CONFIG_TARGET ].m_sName ); ConsoleBufferPush( " Display current settings if no args." ); iParam = PARAM_CONFIG_BRANCH; ConsoleColorizePrintFormat( " Usage: %s [#]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Set the type of branch character:" ); ConsoleBufferPushFormat( " %d off, %d plain, %d fancy", DISASM_BRANCH_OFF, DISASM_BRANCH_PLAIN, DISASM_BRANCH_FANCY ); ConsolePrintFormat( " i.e. %s%s %s 1", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); iParam = PARAM_CONFIG_CLICK; ConsoleColorizePrintFormat( " Usage: %s [#]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Set required key combo. (Alt, Control, or Shift) when left clicking" ); ConsoleBufferPush( " 0 Left-Click (no Alt, Ctrl, Shift)" ); ConsoleBufferPush( " 1 Alt Left-click" ); ConsoleBufferPush( " 2 Ctrl Left-click" ); ConsoleBufferPush( " 3 Alt+Ctrl Left-click" ); ConsoleBufferPush( " 4 Shift Left-click" ); ConsoleBufferPush( " 5 Shift+Alt Left-click" ); ConsoleBufferPush( " 6 Shift+Ctrl Left-click" ); ConsoleBufferPush( " 7 Shift+Ctrl+Alt Left-click" ); Help_Examples(); ConsolePrintFormat( " %s%s %s 0 // Plain Left-click" , CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); ConsolePrintFormat( " %s%s %s 1 // Require Alt Left-click" , CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); ConsolePrintFormat( " %s%s %s 2 // Require Ctrl Left-click" , CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); ConsolePrintFormat( " %s%s %s 3 // Require Alt+Ctrl Left-click", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); iParam = PARAM_CONFIG_COLON; ConsoleColorizePrintFormat( " Usage: %s [0|1]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Display a colon after the address" ); ConsolePrintFormat( " i.e. %s%s %s 0", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); iParam = PARAM_CONFIG_OPCODE; ConsoleColorizePrintFormat( " Usage: %s [0|1]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Display opcode(s) after colon" ); ConsolePrintFormat( " i.e. %s%s %s 1", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); iParam = PARAM_CONFIG_SPACES; ConsoleColorizePrintFormat( " Usage: %s [0|1]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Display spaces between opcodes" ); ConsolePrintFormat( " i.e. %s%s %s 0", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName ); iParam = PARAM_CONFIG_TARGET; ConsoleColorizePrintFormat( " Usage: %s [#]", g_aParameters[ iParam ].m_sName ); ConsoleBufferPush( " Set the type of target address/value displayed:" ); ConsoleBufferPushFormat( " %d off, %d value only, %d address only, %d both", DISASM_TARGET_OFF, DISASM_TARGET_VAL, DISASM_TARGET_ADDR, DISASM_TARGET_BOTH ); ConsolePrintFormat( " i.e. %s%s %s %d", CHC_EXAMPLE, pCommand->m_sName, g_aParameters[ iParam ].m_sName, DISASM_TARGET_VAL ); break; } // Config - Font case CMD_CONFIG_FONT: ConsolePrint( " No longer applicable with new debugger font" ); /* ConsoleBufferPushFormat( " Usage: [%s | %s] \"FontName\" [Height]", g_aParameters[ PARAM_FONT_MODE ].m_sName, g_aParameters[ PARAM_DISASM ].m_sName ); ConsoleBufferPush( " i.e. FONT \"Courier\" 12" ); ConsoleBufferPush( " i.e. FONT \"Lucida Console\" 12" ); ConsoleBufferPushFormat( " %s Controls line spacing.", g_aParameters[ PARAM_FONT_MODE ].m_sName ); ConsoleBufferPushFormat( " Valid values are: %d, %d, %d.", FONT_SPACING_CLASSIC, FONT_SPACING_CLEAN, FONT_SPACING_COMPRESSED ); */ break; // Disasm case CMD_DEFINE_DATA_BYTE1: ConsoleColorizePrintFormat( " Usage: %s
| | ", pCommand->m_sName ); ConsoleBufferPush( " Tell the diassembler to treat the BYTES as data instead of code." ); Help_Examples(); ConsolePrintFormat( "%s %s WNDTOP 22", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s WNDBTM 23", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s WNDTOP // treat as code again", CHC_EXAMPLE, g_aCommands[ CMD_DISASM_CODE ].m_sName ); ConsolePrintFormat( "%s %s // list all addresses viewed as data", CHC_EXAMPLE, g_aCommands[ CMD_DISASM_LIST ].m_sName ); break; case CMD_DEFINE_DATA_WORD1: // DW // use current debug line // DW symbol // DW symbol address // DW symbol range:range // DW address ConsoleColorizePrintFormat( " Usage: %s
| | ", pCommand->m_sName ); ConsoleBufferPush( " Tell the diassembler to treat the WORDS as data instead of code." ); ConsoleColorizePrint( " The data is a range of 2-byte pointer data."); Help_Examples(); ConsolePrintFormat( "%s %s NEXT1 801 // AppleSoft Basic Line#1 Pointer to Next line", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s LINE1 803 // Applesoft Basic Line#1 Line Number", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s NEXT1 // treat as code again", CHC_EXAMPLE, g_aCommands[ CMD_DISASM_CODE ].m_sName ); ConsolePrintFormat( "%s %s // list all addresses viewed as data", CHC_EXAMPLE, g_aCommands[ CMD_DISASM_LIST ].m_sName ); break; // Memory case CMD_MEMORY_ENTER_BYTE: ConsoleColorizePrint( " Usage:
## [## ... ##]" ); ConsoleBufferPush( " Sets memory to the specified 8-Bit Values (bytes)" ); Help_Examples(); ConsolePrintFormat( "%s %s 00 4C FF69", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s 00:4C FF69", CHC_EXAMPLE ); break; case CMD_MEMORY_ENTER_WORD: ConsoleColorizePrint( " Usage:
#### [#### ... ####]" ); ConsoleBufferPush( " Sets memory to the specified 16-Bit Values (words)" ); break; case CMD_MEMORY_FILL: ConsoleColorizePrint( " Usage:
##" ); ConsoleBufferPush( " Fills the memory range with the specified byte" ); ConsoleColorizePrintFormat( " Note: Can't fill IO addresses %s$%sC0xx", CHC_ARG_SEP, CHC_ADDRESS ); Help_Examples(); ConsolePrintFormat( "%s %s 2000:3FFF 00 // Clear HGR page 1", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 4000,2000 00 // Clear HGR page 2", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 2000 3FFF 00 // Clear HGR page 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_MEMORY_MOVE: ConsoleColorizePrint( " Usage: destination range" ); ConsoleBufferPush( " Copies bytes specified by the range to the destination starting address." ); Help_Examples(); ConsolePrintFormat( "%s %s 4000 2000:3FFF // move HGR page 1 to page 2", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 2001 2000:3FFF // clear $2000-$3FFF with the byte at $2000", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s 2001<2000:3FFFM", CHC_EXAMPLE ); break; // case CMD_MEM_MINI_DUMP_ASC_1: // case CMD_MEM_MINI_DUMP_ASC_2: case CMD_MEM_MINI_DUMP_ASCII_1: case CMD_MEM_MINI_DUMP_ASCII_2: ConsoleColorizePrint( " Usage:
" ); ConsoleBufferPush( " Displays ASCII text in the Mini-Memory area" ); ConsoleBufferPush( " ASCII control chars are hilighted" ); ConsoleBufferPush( " ASCII hi-bit chars are normal" ); // break; // case CMD_MEM_MINI_DUMP_TXT_LO_1: // case CMD_MEM_MINI_DUMP_TXT_LO_2: case CMD_MEM_MINI_DUMP_APPLE_1: case CMD_MEM_MINI_DUMP_APPLE_2: ConsoleColorizePrint( " Usage:
" ); ConsoleBufferPush( " Displays APPLE text in the Mini-Memory area" ); ConsoleBufferPush( " APPLE control chars are inverse" ); ConsoleBufferPush( " APPLE hi-bit chars are normal" ); break; // case CMD_MEM_MINI_DUMP_TXT_HI_1: // case CMD_MEM_MINI_DUMP_TXT_HI_2: // ConsoleBufferPush( " Usage:
" ); // ConsoleBufferPush( " Displays text in the Memory Mini-Dump area" ); // ConsoleBufferPush( " ASCII chars with the hi-bit set, is inverse" ); break; case CMD_MEMORY_LOAD: case CMD_MEMORY_SAVE: if (iCommand == CMD_MEMORY_LOAD) { ConsoleColorizePrint( " Usage: [\"Filename\"],[bank:]address[,length]" ); ConsoleColorizePrint( " Usage: [\"Filename\"],[bank:]range" ); Help_Range(); ConsoleBufferPush( " Notes: If no filename specified, defaults to the last filename (if possible)" ); } if (iCommand == CMD_MEMORY_SAVE) { ConsoleColorizePrint( " Usage: [\"Filename\"],[bank:]address,length" ); ConsoleColorizePrint( " Usage: [\"Filename\"],[bank:]range" ); Help_Range(); ConsoleBufferPush( " Notes: If no filename specified, defaults to: '####.####.[bank##].bin'" ); ConsoleBufferPush( " Where the form is
..bin" ); } // ConsoleBufferPush( " Examples:" ); Help_Examples(); ConsolePrintFormat( "%s BSAVE \"test\",FF00,100" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BLOAD \"test\",2000:2010" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BSAVE \"test\",F000:FFFF" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BLOAD \"test\",4000" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BLOAD \"main.bin\",0:2000" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BSAVE \"aux2.bin\",1:2000" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BSAVE \"main.bin\",0:2000,2000" , CHC_EXAMPLE ); ConsolePrintFormat( "%s BSAVE \"aux2.bin\",1:2000:3FFF" , CHC_EXAMPLE ); break; case CMD_MEMORY_SEARCH: ConsoleColorizePrint( " Usage: range <\"ASCII text\" | 'apple text' | hex>" ); Help_Range(); ConsoleBufferPush( " Where text is of the form:" ); ConsoleBufferPush( " \"...\" designate ASCII text" ); ConsoleBufferPush( " '...' designate Apple High-Bit text" ); Help_Examples(); ConsolePrintFormat( "%s %s F000,1000 'Apple' // search High-Bit", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s MT1 @2" , CHC_EXAMPLE ); ConsolePrintFormat( "%s %s D000:FFFF \"FLAS\" // search ASCII ", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s MA1 @1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s %s D000,4000 \"EN\" 'D' // Mixed text" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s MT1 @1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s %s D000,4000 'Apple' ? ']'" , CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_MEMORY_SEARCH_HEX: ConsoleColorizePrint( " Usage: range [text | byte1 [byte2 ...]]" ); Help_Range(); ConsoleBufferPush( " Where is of the form:" ); ConsoleBufferPush( " ## match specific byte" ); ConsoleBufferPush( " #### match specific 16-bit value" ); ConsoleBufferPush( " ? match any byte" ); ConsoleBufferPush( " ?# match any high nibble, match low nibble to specific number" ); ConsoleBufferPush( " #? match specific high nibble, match any low nibble" ); Help_Examples(); ConsolePrintFormat( "%s %s F000,1000 AD ? C0", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s U @1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s %s F000,1000 ?1 C0" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s F000,1000 5? C0" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s F000,1000 10 C?" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s U @2 - 1" , CHC_EXAMPLE ); ConsolePrintFormat( "%s %s F000:FFFF C030" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s U @1 - 1" , CHC_EXAMPLE ); break; // case CMD_MEMORY_SEARCH_APPLE: // ConsoleBufferPushFormat( "Deprecated. Use: %s", g_aCommands[ CMD_MEMORY_SEARCH ].m_sName ); // break; // case CMD_MEMORY_SEARCH_ASCII: // ConsoleBufferPushFormat( "Deprecated. Use: %s", g_aCommands[ CMD_MEMORY_SEARCH ].m_sName ); // break; // Output case CMD_OUTPUT_CALC: ConsoleColorizePrint( " Usage:
" ); ConsoleBufferPush( " Operator is one of: + - * / % ^ ~" ); ConsoleBufferPush( " Output order is: Hex Bin Dec Char" ); ConsoleBufferPush( " Note: symbols take priority." ); ConsoleBufferPush( " Note: #A (if you don't want the accumulator value)" ); ConsoleBufferPush( " Note: #F (if you don't want the flags value)" ); Help_Examples(); ConsolePrintFormat( "%s CALC 5 + #A", CHC_EXAMPLE ); ConsolePrintFormat( "%s CALC 80 * 2", CHC_EXAMPLE ); ConsoleColorizePrint( " See also: " CHC_COMMAND "HELP OP" ); break; case CMD_OUTPUT_ECHO: ConsoleColorizePrint( " Usage: string" ); // ConsoleBufferPush( TEXT(" Examples:" ) ); Help_Examples(); ConsolePrintFormat( "%s %s Checkpoint", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s PC" , CHC_EXAMPLE, pCommand->m_sName ); // ConsoleBufferPush( TEXT(" Echo the string to the console" ) ); break; case CMD_OUTPUT_PRINT: ConsoleColorizePrint( " Usage: [, string | expression]*" ); ConsoleColorizePrint( " Note: To print Register values, they must be in upper case" ); Help_Examples(); ConsolePrintFormat( "%s %s \"A:\",A,\" X:\",X", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s A,\" \",X,\" \",Y" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s PC" , CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_OUTPUT_PRINTF: ConsoleColorizePrint( " Usage: [, expression, ...]" ); ConsoleBufferPush( " The string may contain c-style printf formatting flags: %d %x %z %c" ); ConsoleBufferPush( " Where: %d decimal, %x hex, %z binary, %c char, %% percent" ); Help_Examples(); ConsolePrintFormat( "%s %s \"Dec: %%d Hex: %%x Bin: %%z Char: %%c\",A,A,A,A", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s \"%%x %%x %%x\",A,X,Y" , CHC_EXAMPLE, pCommand->m_sName ); break; // Symbols case CMD_SYMBOLS_LOOKUP: ConsoleColorizePrint( " Usage: symbol [=
]" ); ConsolePrintFormat( " %s\"%ssymbol%s\" = %saddress" , CHC_ARG_MAND , CHC_SYMBOL , CHC_ARG_MAND , CHC_ADDRESS ); ConsoleColorizePrint( " Note: Valid characters are any characters above ASCII space ($20)." ); ConsolePrintFormat( " You %sMUST%s double-quote names containing special characters to be recognized." , CHC_WARNING , CHC_DEFAULT ); Help_Examples(); ConsolePrintFormat( "%s %s HOME" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s LIFE = 2000" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s LIFE" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s \"PR#\" = FE95", CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s \"PR#\"" , CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_SYMBOLS_ROM: case CMD_SYMBOLS_APPLESOFT: case CMD_SYMBOLS_ASSEMBLY: case CMD_SYMBOLS_USER_1: case CMD_SYMBOLS_USER_2: case CMD_SYMBOLS_SRC_1: case CMD_SYMBOLS_SRC_2: // ConsoleBufferPush( " Usage: [ ON | OFF | symbol | address ]" ); // ConsoleBufferPush( " Usage: [ LOAD [\"filename\"] | SAVE \"filename\"]" ); // ConsoleBufferPush( " ON : Turns symbols on in the disasm window" ); // ConsoleBufferPush( " OFF : Turns symbols off in the disasm window" ); // ConsoleBufferPush( " LOAD: Loads symbols from last/default filename" ); // ConsoleBufferPush( " SAVE: Saves symbol table to file" ); // ConsoleBufferPush( " CLEAR: Clears the symbol table" ); ConsoleColorizePrint( " Usage: [ | symbol | address ]" ); ConsoleBufferPush( " Where is one of:" ); ConsolePrintFormat( "%s%-5s%s: Turns symbols on in the disasm window" , CHC_STRING, g_aParameters[ PARAM_ON ].m_sName, CHC_DEFAULT ); ConsolePrintFormat( "%s%-5s%s: Turns symbols off in the disasm window" , CHC_STRING, g_aParameters[ PARAM_OFF ].m_sName, CHC_DEFAULT ); ConsolePrintFormat( "%s%-5s%s: Loads symbols from last/default \"filename\"", CHC_STRING, g_aParameters[ PARAM_LOAD ].m_sName, CHC_DEFAULT ); // 2.6.2.14 Fixed: Save/Load Param help was swapped. ConsolePrintFormat( "%s%-5s%s: Saves symbol table to \"filename\"" , CHC_STRING, g_aParameters[ PARAM_SAVE ].m_sName, CHC_DEFAULT ); // 2.6.2.14 Fixed: Save/Load Param help was swapped. ConsolePrintFormat( "%s%-5s%s: Clears the symbol table" , CHC_STRING, g_aParameters[ PARAM_CLEAR ].m_sName, CHC_DEFAULT ); ConsolePrintFormat( "%s%-5s%s: Remove symbol" , CHC_STRING, g_aTokens[ TOKEN_EXCLAMATION ].sToken, CHC_DEFAULT ); break; case CMD_SYMBOLS_LIST : ConsoleColorizePrint( " Usage: symbol" ); ConsoleBufferPush( " Looks up symbol in all 3 symbol tables: main, user, source" ); break; // Cycles case CMD_CYCLES_INFO: ConsoleColorizePrint(" Usage: "); ConsoleBufferPush(" Where:"); ConsoleBufferPush(" abs = absolute number of cycles since power-on"); ConsoleBufferPush(" rel = number of cycles since last step or breakpoint"); ConsoleBufferPush(" part= number of cycles relative to current instruction"); break; case CMD_CYCLES_RESET: ConsoleBufferPush(" Use in conjunctioned with 'cycles part' to reset to current instruction"); break; // Video-Scanner case CMD_VIDEO_SCANNER_INFO: ConsoleColorizePrint(" Usage: "); ConsoleBufferPush(" Where:"); ConsoleBufferPush(" changes output to dec/hex"); ConsoleBufferPush(" alters horz value to hbl-l,visible,hbl-r or hbl-r+l,visible"); ConsolePrintFormat(" %sYellow%s=invisible (hbl or vbl active) / %sGreen%s=visible" ,CHC_INFO , CHC_DEFAULT // yellow ,CHC_COMMAND, CHC_DEFAULT // green ); break; // View case CMD_VIEW_TEXT4X: case CMD_VIEW_TEXT41: case CMD_VIEW_TEXT42: case CMD_VIEW_TEXT8X: case CMD_VIEW_TEXT81: case CMD_VIEW_TEXT82: case CMD_VIEW_GRX : case CMD_VIEW_GR1 : case CMD_VIEW_GR2 : case CMD_VIEW_DGRX : case CMD_VIEW_DGR1 : case CMD_VIEW_DGR2 : case CMD_VIEW_HGRX : case CMD_VIEW_HGR1 : case CMD_VIEW_HGR2 : case CMD_VIEW_DHGRX : case CMD_VIEW_DHGR1 : case CMD_VIEW_DHGR2 : ConsolePrint( "Show the video output in the specified format." ); break; // Watches case CMD_WATCH_ADD: ConsoleColorizePrint( " Usage:
" ); ConsoleBufferPush( " Adds the specified memory location to the watch window." ); break; // Window case CMD_WINDOW_CODE : // summary is good enough case CMD_WINDOW_CODE_2 : // summary is good enough case CMD_WINDOW_SOURCE_2: // summary is good enough break; // Zero Page pointers case CMD_ZEROPAGE_POINTER: case CMD_ZEROPAGE_POINTER_ADD: ConsoleColorizePrint( " Usage:
" ); ConsoleColorizePrint( " Usage: #
[address...]" ); ConsoleBufferPush(" Adds the specified memory location to the zero page pointer window." ); ConsoleBufferPush(" Update the specified zero page pointer (#) with the address." ); ConsoleBufferPush(" Note: Displayed as symbol name (if possible) and the 16-bit target pointer" ); Help_Examples(); ConsolePrintFormat( "%s %s CH" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 0 CV" , CHC_EXAMPLE, pCommand->m_sName ); ConsolePrintFormat( "%s %s 0 CV CH", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_ZEROPAGE_POINTER_CLEAR: ConsoleColorizePrint( " Usage: [# | *]" ); ConsoleBufferPush( " Clears specified zero page pointer, or all." ); ConsolePrintFormat( " i.e. %s%s 1", CHC_EXAMPLE, pCommand->m_sName ); break; case CMD_ZEROPAGE_POINTER_0: case CMD_ZEROPAGE_POINTER_1: case CMD_ZEROPAGE_POINTER_2: case CMD_ZEROPAGE_POINTER_3: case CMD_ZEROPAGE_POINTER_4: case CMD_ZEROPAGE_POINTER_5: case CMD_ZEROPAGE_POINTER_6: case CMD_ZEROPAGE_POINTER_7: ConsoleColorizePrint( " Usage: [
]" ); ConsoleBufferPush( " If no address specified, will remove watching the zero page pointer." ); break; // Misc case CMD_VERSION: ConsoleColorizePrint( " Usage: [*]" ); ConsoleBufferPush( " * Display extra internal stats" ); break; default: if (bAllCommands) break; if ((! nFound) || (! pCommand)) { ConsoleBufferPush( " Invalid command." ); } else { //#if DEBUG_COMMAND_HELP #if _DEBUG ConsoleBufferPushFormat( "Command help not done yet!: %s", g_aCommands[ iCommand ].m_sName ); #endif } break; } } return ConsoleUpdate(); } //=========================================================================== Update_t CmdHelpList (int nArgs) { const size_t nMaxWidth = g_nConsoleDisplayWidth - 1; extern std::vector g_vSortedCommands; if (! g_vSortedCommands.size()) { for ( int iCommand = 0; iCommand < NUM_COMMANDS_WITH_ALIASES; iCommand++ ) { g_vSortedCommands.push_back( g_aCommands[ iCommand ] ); } std::sort( g_vSortedCommands.begin(), g_vSortedCommands.end(), commands_functor_compare() ); } //Colorize( sText, "Commands: " ); std::string sText = CHC_USAGE "Commands" CHC_DEFAULT ": "; for ( int iCommand = 0; iCommand < NUM_COMMANDS_WITH_ALIASES; iCommand++ ) // aliases are not printed { Command_t *pCommand = & g_vSortedCommands.at( iCommand ); // Command_t *pCommand = & g_aCommands[ iCommand ]; char *pName = pCommand->m_sName; if (! pCommand->pFunction) continue; // not implemented function if ((sText.length() + strlen(pName)) < nMaxWidth) { sText += CHC_COMMAND; } else { ConsolePrint( sText.c_str() ); sText = " " CHC_COMMAND; } sText += pName; sText += ' '; } //ConsoleBufferPush( sText.c_str() ); ConsolePrint( sText.c_str() ); ConsoleUpdate(); return UPDATE_CONSOLE_DISPLAY; } //=========================================================================== Update_t CmdVersion (int nArgs) { unsigned int nVersion = DEBUGGER_VERSION; int nMajor; int nMinor; int nFixMajor; int nFixMinor; UnpackVersion( nVersion, nMajor, nMinor, nFixMajor, nFixMinor ); ConsolePrintFormat( " Emulator: %s%s%s Debugger: %s%d.%d.%d.%d%s" , CHC_SYMBOL , g_VERSIONSTRING.c_str() , CHC_DEFAULT , CHC_SYMBOL , nMajor, nMinor, nFixMajor, nFixMinor , CHC_DEFAULT ); if (nArgs) { for (int iArg = 1; iArg <= g_nArgRaw; iArg++ ) { // * PARAM_WILDSTAR -> ? PARAM_MEM_SEARCH_WILD if ((! _tcscmp( g_aArgs[ iArg ].sArg, g_aParameters[ PARAM_WILDSTAR ].m_sName )) || (! _tcscmp( g_aArgs[ iArg ].sArg, g_aParameters[ PARAM_MEM_SEARCH_WILD ].m_sName )) ) { ConsoleBufferPushFormat( " Arg: %" SIZE_T_FMT " bytes * %d = %" SIZE_T_FMT " bytes", sizeof(Arg_t), MAX_ARGS, sizeof(g_aArgs) ); ConsoleBufferPushFormat( " Console: %" SIZE_T_FMT " bytes * %d height = %" SIZE_T_FMT " bytes", sizeof( g_aConsoleDisplay[0] ), CONSOLE_HEIGHT, sizeof(g_aConsoleDisplay) ); ConsoleBufferPushFormat( " Commands: %d (Aliased: %d) Params: %d", NUM_COMMANDS, NUM_COMMANDS_WITH_ALIASES, NUM_PARAMS ); ConsoleBufferPushFormat( " Cursor(%d) T: %04X C: %04X B: %04X %c D: %02X", // Top, Cur, Bot, Delta g_nDisasmCurLine, g_nDisasmTopAddress, g_nDisasmCurAddress, g_nDisasmBotAddress, g_bDisasmCurBad ? TEXT('*') : TEXT(' ') , g_nDisasmBotAddress - g_nDisasmTopAddress ); CmdConfigGetFont( 0 ); break; } else return Help_Arg_1( CMD_VERSION ); } } return ConsoleUpdate(); }