rename stuff and add comments

Author: warmCabin

src/drivers/win/debugger.cpp

@@ -258,6 +258,7 @@ unsigned int AddBreak(HWND hwndDlg)
 
 // This function is for "smart" scrolling...
 // it attempts to scroll up one line by a whole instruction
+// Should we add the label-respecting logic from dumper.cpp?
 int InstructionUp(int from)
 {
 	int i = std::min(16, from), j;
@@ -562,7 +563,7 @@ void UpdateDisassembleView(HWND hWnd, UINT id, int lines, bool text = false)
 	SendDlgItemMessage(hWnd, id, EM_SETEVENTMASK, 0, eventMask);
 }
 
-void Disassemble(HWND hWnd, int id, int scrollid, unsigned int addr)
+void DisassembleToWindow(HWND hWnd, int id, int scrollid, unsigned int addr)
 {
 	wchar_t chr[40] = { 0 };
 	wchar_t debug_wbuf[2048] = { 0 };
@@ -903,7 +904,7 @@ void UpdateDebugger(bool jump_to_pc)
 		{
 			starting_address = InstructionUp(starting_address);
 		}
-		Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
+		DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
 
 		// HACK, but I don't see any other way to ensure the ">" pointer is visible when "Symbolic debug" is enabled
 		if (!PCPointerWasDrawn && PC_pointerOffset)
@@ -912,14 +913,14 @@ void UpdateDebugger(bool jump_to_pc)
 			PC_pointerOffset = 0;
 			starting_address = X.PC;
 			// retry with (PC_pointerOffset = 0) now
-			Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
+			DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
 		}
 
 		starting_address = X.PC;
 	} else
 	{
 		starting_address = disassembly_addresses[0];
-		Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
+		DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, starting_address);
 	}
 
 
@@ -1232,7 +1233,7 @@ BOOL CALLBACK DebuggerEnumWindowsProc(HWND hwnd, LPARAM lParam)
 			crect.bottom += dy_l;
 			SetWindowPos(hwnd, 0, 0, 0, crect.right - crect.left, crect.bottom - crect.top, SWP_NOZORDER | SWP_NOMOVE);
 			GetScrollInfo(GetDlgItem(parent, IDC_DEBUGGER_DISASSEMBLY_VSCR), SB_CTL, &si);
-			Disassemble(parent, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
+			DisassembleToWindow(parent, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
 			break;
 		case IDC_DEBUGGER_DISASSEMBLY_LEFT_PANEL:
 			// vertical stretch, no movement
@@ -1665,10 +1666,10 @@ inline void UpdateSymbolsPopup(HMENU symbolsPopup)
 	EnableMenuItem(symbolsPopup, ID_DEBUGGER_RELOAD_SYMBOLS, EnabledFlag(GameInfo));
 }
 
-inline void UpdateToolsPopup(HMENU symbolsPopup)
+inline void UpdateToolsPopup(HMENU toolsPopup)
 {
-	EnableMenuItem(symbolsPopup, ID_DEBUGGER_ROM_PATCHER, EnabledFlag(GameInfo));
-	EnableMenuItem(symbolsPopup, ID_DEBUGGER_CODE_DUMPER, EnabledFlag(GameInfo));
+	EnableMenuItem(toolsPopup, ID_DEBUGGER_ROM_PATCHER, EnabledFlag(GameInfo));
+	EnableMenuItem(toolsPopup, ID_DEBUGGER_CODE_DUMPER, EnabledFlag(GameInfo));
 }
 
 void DebuggerInitDialog(HWND hwndDlg)
@@ -2118,7 +2119,7 @@ void DebuggerBnClicked(HWND hwndDlg, uint16 btnId, HWND hwndBtn)
 				{
 					sprintf(str,"%04X", tmp);
 					SetDlgItemText(hwndDlg,IDC_DEBUGGER_VAL_PCSEEK,str);
-					Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, tmp);
+					DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, tmp);
 					// The address in the Add Bookmark textbox follows the scroll pos.
 					sprintf(str,"%04X", si.nPos);
 					SetDlgItemText(hDebug, IDC_DEBUGGER_BOOKMARK, str);
@@ -2313,7 +2314,7 @@ void DebuggerVScroll(HWND hwndDlg, uint16 eventType, uint16 scrollPos, HWND hwnd
 			si.nPos = si.nMax - si.nPage;
 		SetScrollInfo(hwndScrollBar, SB_CTL, &si, TRUE);
 
-		Disassemble(hwndDlg, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
+		DisassembleToWindow(hwndDlg, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
 		// The address in the Add Bookmark textbox follows the scroll pos.
 		char str[16];
 		sprintf(str,"%04X", si.nPos);
@@ -2354,7 +2355,7 @@ void DebuggerMouseWheel(HWND hwndDlg, int16 rotAmt, uint16 cursorX, uint16 curso
 	}
 
 	// This function calls UpdateScrollInfo. Don't worry!
-	Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
+	DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, si.nPos);
 	// The address in the Add Bookmark textbox follows the scroll pos.
 	char str[16];
 	sprintf(str,"%04X", si.nPos);

src/drivers/win/debugger.h

@@ -38,7 +38,7 @@ extern char* BreakToText(unsigned int num);
 void UpdateDebugger(bool jump_to_pc = true);
 void DoDebug(uint8 halt);
 void DebuggerExit();
-void Disassemble(HWND hWnd, int id, int scrollid, unsigned int addr);
+void DisassembleToWindow(HWND hWnd, int id, int scrollid, unsigned int addr);
 void PrintOffsetToSeekAndBookmarkFields(int offset);
 
 void LoadGameDebuggerData(HWND hwndDlg);

src/drivers/win/debuggersp.cpp

@@ -640,6 +640,8 @@ void replaceRegNames(char* str)
 /**
 * Searches an address node in a list of address nodes. The found node
 * has the same offset as the passed parameter offs.
+* 
+* Could speed this up with an actual data structure...
 *
 * @param node The address node list
 * @offs The offset to search
@@ -917,7 +919,7 @@ void GoToDebuggerBookmark(HWND hwnd)
 	// If no bookmark is selected just return
 	if (selectedItem == LB_ERR) return;
 	unsigned int n = getBookmarkAddress(selectedItem);
-	Disassemble(hwnd, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, n);
+	DisassembleToWindow(hwnd, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, n);
 }
 
 INT_PTR CALLBACK SymbolicNamingCallB(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam)

src/drivers/win/debuggersp.h

@@ -71,5 +71,5 @@ void AddNewSymbolicName(uint16 newAddress, char* newOffset, char* newName, char*
 void DeleteSymbolicName(uint16 address, int size);
 void WriteNameFileToDisk(const char* filename, Name* node);
 
-extern void Disassemble(HWND hWnd, int id, int scrollid, unsigned int addr);
+extern void DisassembleToWindow(HWND hWnd, int id, int scrollid, unsigned int addr);
 extern void CenterWindow(HWND hwnd);

src/drivers/win/dumper.cpp

@@ -51,7 +51,7 @@ static OPENFILENAME ofn;
 * A9 10    LDA #$10
 * 60       RTS
 *
-* There is a lot of reused logic between this and Disassemble. However, they're different enough that it would
+* There is a lot of reused logic between this and DisassembleToWindow. However, they're different enough that it would
 * be more trouble than it's worth to combine them.
 */
 void Dump(FILE *fout, unsigned int startAddr, unsigned int endAddr)

src/drivers/win/taseditor/history.h

@@ -108,7 +108,7 @@ class HISTORY
 	int registerChanges(int mod_type, int start = 0, int end =-1, int size = 0, const char* comment = NULL, int consecutivenessTag = 0, RowsSelection* frameset = NULL);
 	int registerAdjustLag(int start, int size);
 	void registerMarkersChange(int modificationType, int start = 0, int end =-1, const char* comment = 0);
-	void registerBookmarkSet(int slot, BOOKMARK& backupÑopy, int oldCurrentBranch);
+	void registerBookmarkSet(int slot, BOOKMARK& backupCopy, int oldCurrentBranch);
 	int registerBranching(int slot, bool markersWereChanged);
 	void registerRecording(int frameOfChange, uint32 joypadDifferenceBits);
 	int registerImport(MovieData& md, char* filename);

src/drivers/win/tracer.cpp

@@ -244,7 +244,7 @@ BOOL CALLBACK IDC_TRACER_LOG_WndProc(HWND hwndDlg, UINT uMsg, WPARAM wParam, LPA
 				DoDebug(0);
 				if (hDebug)
 				{
-					Disassemble(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, offset);
+					DisassembleToWindow(hDebug, IDC_DEBUGGER_DISASSEMBLY, IDC_DEBUGGER_DISASSEMBLY_VSCR, offset);
 					PrintOffsetToSeekAndBookmarkFields(offset);
 				}
 			}