6502bench SourceGen: Main Window
Starting a New Project
Select File > New, or if no project is open, click "Start new project". This opens the Create New Project window.
Start by selecting your target system from the tree on the left. The panel on the right will show the CPU that will be selected, as well as the symbol files and extension scripts that will be loaded by default. All of these may be overridden later from the project properties.
Next, click the "Select File..." button. Pick the file you wish to disassemble. The dialog will update with the pathname and some notes about the file's size. Click "OK" if all looks good to create the project.
NOTE: Support for large 65816 programs is incomplete. The maximum size for a data file is currently 1 MiB.
The first time you save the project (with File > Save), you will be prompted for the project name. It's best to use the data file's name with ".dis65" added, so this will be set as the default. The data file's name is not stored in the project file, so if you pick a different name, or save the project in a different directory, you will have to select the data file manually whenever you open the project.
Opening an Existing Project
Select File > Open, or if no project is open, click "Open existing project". Select the .dis65 project file from the standard file dialog.
SourceGen will try to open a data file with the project's name, minus the ".dis65". If it can't find a file with that name, or if there's something wrong with it (e.g. the CRC doesn't match), you will be given the opportunity to specify the location of the data file to use.
If non-fatal problems with the file are detected, a warning will be shown. If it's something simple, like a missing .sym65 or extension script file, you'll be notified. If it's something more complicated, e.g. the project has a comment on an offset that doesn't exist, you will be warned that the problematic data has been deleted, and will be lost if the project is saved. You will also be given the opportunity to cancel the loading of the project.
The locations of the last few projects you've worked with are saved in the application settings. You can access them from File > Recent Projects. If no project is open, links to the two most-recently-opened projects will be available.
Working With a Project
The main project window is divided into five areas:
- Center: the code list. If no project is open, this will instead have clickable links to open a new or existing project.
- Top left: cross-reference list.
- Bottom left: notes list.
- Top right: symbols list.
- Bottom right: info on selected line.
Most of the action takes place in the center code list.
Code List
The code list provides a view of the code being disassembled. Each line may be an instruction, data item, long comment, note, or assembler directive.
The list is divided into columns:
- Offset. The offset within the file where the instruction or data item starts. Always shown as a six-digit hex value with a leading '+'.
- Address. The address where the assembled code will execute. For 8-bit CPUs this is shown as a 4-digit hex number, for 16-bit CPUs the bank is shown as well. Double-click on this field to open the Edit Address dialog.
- Bytes. Shows up to four bytes from the data file that correspond to the instruction or data. To see the full dump of a longer item, such as an ASCII string, double-click on the field to open the Hex Dump Viewer. This is a floating window, so you can keep it open while you work. Double-clicking in the bytes column in other rows will update the window position and selection.
- Flags. This shows the state of the status flags as they are before the instruction is executed. Double-click on this field to open the Edit Status Flag Override dialog.
- Attributes. Some instructions and data items have interesting attributes. '@' indicates an entry point, 'H' means one or more bytes has a hint, '#' means execution will not continue to the following instruction, '>' is shown for branch targets, and '!' appears when a conditional branch is never taken. (This column is rarely useful and can be hidden.)
- Label. If a label has been defined for this offset, by the user or generated automatically, it will appear here. Also, full-line items like long comments and notes will start in this field. Double-click on this field to open the Edit Label dialog.
- Opcode. The instruction or pseudo-opcode mnemonic. If an instruction is embedded inside this one, a ⏩ symbol will appear. If you double-click this field for an instruction or data item whose operand refers to an address in the file, the selection will jump to that location.
- Operand. The instruction or data operand. Data operands may span a large number of bytes. Double-click on this field to open the Edit Operand or Edit Data Format dialog, as appropriate. (Note you can shift-double-click on data items to edit multiple lines.)
- Comment. End-of-line comment, generally shown with a ';' prefix. If enabled, cycle counts will appear here. Double-click on this field to open the Edit Comment dialog.
Double-clicking anywhere on a line with a note or long comment will open the Edit Note or Edit Long Comment dialog, respectively.
The code list is a standard Windows list view. You can left-click to select an item, ctrl-left-click to toggle individual items on and off, and shift-left-click to select a range. You can select all lines with Edit > Select All. Resize columns by left-clicking on the divider in the header and dragging it.
Multi-line items, such as long comments or ASCII strings, are selected as a whole when any part is selected.
Right-clicking opens a menu. The contents are the same as those in the Actions menu item in the menu bar. The set of options that are enabled will depend on what you have selected in the main window.
- Set Address. Sets the target address at that offset. Enabled when a single instruction or data line is selected.
- Override Status Flags. Changes the status flags at that offset. Enabled when a single instruction line is selected.
- Edit Label. Sets the label at that offset. Enabled when a single instruction or data line is selected.
- Edit Operand. Sets the operand format for that instruction. Enabled when a single instruction line is selected.
- Edit Data Format. Sets the format for data operands. Enabled when one or more data lines are selected.
- Edit Comment. Sets the comment at that offset. Enabled when a single instruction or data line is selected.
- Edit Long Comment. Sets the long comment at that offset. Enabled when a single instruction or data line, or an existing long comment, is selected.
- Edit Note. Sets the note at that offset. Enabled when a single instruction or data line, or an existing note, is selected.
- Edit Project Symbol. Sets the name, value, and comment of the project symbol. Enabled when a single equate directive, generated from a project symbol, is selected.
- Hinting (Hint As Code Entry Point, Hint As Data Start, Hint As Inline Data, Remove Hints). Enabled when one or more code and data lines are selected. Remove Hints is only enabled when at least one line has hints.
- Toggle Single-Byte Format. Toggles a range of lines between default format and single-byte format. Enabled when one or more data lines are selected.
- Delete Note / Long Comment. Deletes the selected note or long comment. Enabled when a single note or long comment is selected.
- Show Hex Dump. Opens the hex dump viewer, with the current selection highlighted. Always enabled. If nothing is selected, the viewer will open at the top of the file.
Undo & Redo
You can undo a change with Edit > Undo, or Ctrl+Z. You can redo a change with Edit > Redo, Ctrl+Y, or Ctrl+Shift+Z.
All changes to the project, including changes to the project properties, are added to the undo/redo buffer. This has no fixed size limit, so no matter how much you change, you can always undo back to the point where the project was opened.
The undo history is not saved as part of the project. Closing a project clears the buffer.
References Window
When a single instruction or data line is selected in the main window, all references to that offset will be shown in the References window. For each reference, the file offset, address, and some details about the type of reference will be shown.
The reference type indicates whether the origin is an instruction or data operand. Branch instructions are called out separately. In addition, it will be identified as a numeric or symbolic reference. Symbolic references may be offset from the actual operand value; if this is the case, the adjustment will be shown as well.
Double-clicking on a reference moves the code list selection to that reference, and adds the previous selection to the navigation stack.
Notes Window
When you add a note, it will also be added to this window. Double-clicking on a note will jump directly to it, and add the previous selection to the navigation stack. This makes notes useful as bookmarks.
Symbols Window
All known symbols are shown here. The filter buttons allow you to screen out symbols you're not interested in, such as platform symbols or constants.
Clicking on one of the column headers will sort the list on that field. Click a second time to reverse the sort direction.
Double-clicking on an auto or user label will jump to that label, and add the previous selection to the navigation stack. This can be a handy way to move around the file, jumping from label to label.
Info Window
Some additional information about the currently-selected line is shown, such as the formatting applied to the operand. If the operand has a default format, any automatically-generated format will be noted. For an instruction, a summary is shown that includes the cycle count, flags affected, and a brief description of what the instruction does. The latter can be especially handy for undocumented instructions.
Navigation
The simplest way to move through the code list is with the scroll wheel on your mouse, or by left-clicking and dragging the scroll bar. You can also use PgUp/PgDn and the arrow keys.
Use Edit > Find to search for text. This performs a case-insensitive text search on the label, opcode, operand, and comment fields. Use Edit > Find Next to find the next match.
Use Edit > Go To to jump to an offset, address, or label. Remember that offsets and addresses are always hexadecimal, and offsets start with a '+'. If you have a label that is also a valid hexadecimal address, like "FEED", the label takes precedence. To jump to the address write "$FEED" instead.
When you jump around, by double-clicking on an opcode or an entry in one of the side windows, the currently-selected line is added to a navigation stack. You can use the arrows on the toolbar to navigate forward or backward. (You can use Alt+Left/Right Arrow, or Ctrl+- / Ctrl+Shift+-, as keyboard shortcuts.)
Adding and Removing Hints
To add code entry or data hints, select the offsets with the instruction opcodes, and then use the "Hint as Code Entry Point" or "Hint as Data" menu item. Remember to avoid hinting additional bytes, especially with code entry points, as that can lead to unwanted embedded instructions.
For inline data, select all of the data that the code analyzer should skip, and use the "Hint as Inline Data" menu item.
If you're having a hard time selecting just the right bytes because the instructions are caught up in a multi-byte data item, such as an auto-detected ASCII string, you can use the "Toggle Single-Byte Format" menu item to "flatten" the item. Apply the hint, then toggle the bytes back to default format. You can also disable uncategorized data analysis entirely from the project properties editor.
Format Split-Address Table
Tables of addresses are fairly common. Sometimes you'll find them as a series of 16-bit words, like this:
jmptab .dd2 func1 .dd2 func2 .dd2 func3
While that's fairly common in 16-bit software, 8-bit software often splits the high and low bytes into separate arrays, like this:
jmptabl .dd1 <func1 .dd1 <func2 .dd1 <func3 jmptabh .dd1 >func1 .dd1 >func2 .dd1 >func3
Sometimes the tables contain address - 1
, because the
values are to be pushed onto the stack for an RTS call.
The split-address table formatter helps you associate symbols with the addresses in the table. To use it, start by selecting the entire table. In the example above, you would select all 6 bytes. The number of bytes in each part must be equal: here, it's 3 low bytes, followed by 3 high bytes. If the number of bytes selected can't be evenly divided by the number of parts, the formatter will report an error.
With the data selected, open the format dialog with Actions > Format Split-Address Table. The rather complicated dialog is split into sections.
- Address Characteristics: select whether the table has 16-bit addresses or 24-bit addresses. (24-bit addresses are disabled if you don't have the CPU set to 65816.) If the address parts are being pushed on the stack for an RTS/RTL, check the "Adjusted for RTS/RTL" box to adjust them by 1.
- Low Bytes: indicate which part of the table holds the low bytes. In the example above, the low bytes came first, followed by the high bytes, so you would select "first part of selection". If they were stored the other way around, you would click "second part" instead.
- High Bytes: indicate which part of the table holds the high bytes. For a 16-bit address this will be the part you didn't pick for the low bytes. Sometimes, if all addresses land on the same 256-byte page, the high byte will be a constant in the code, and only the low bytes will be stored in a table. If that's the case, select "Constant", and enter the high byte in the text box. (Decimal, hex, and binary are accepted.)
- Bank Bytes: for 24-bit addresses, you can select "Nth part of selection", which will just use whichever part you didn't specify for the low and high bytes. If the table holds 16-bit addresses, you can use the "Constant" field to specify the data bank.
- Options: if the table holds the addresses of instructions, check the "Add code entry hint if needed" box to add a code entry point hint to anything that isn't already marked as an instruction.
- Generated Addresses: this shows the full list of addresses that are generated with the current set of parameters. Each address is shown with a file offset and a symbol. If the address can't be mapped within the file, the offset is shown as dashes instead. If the address can be mapped, and it already has a user-specified label, the label will be shown. If no label was found, the table will show "(+)", indicating that a permanent label will be added at the target offset.
For a 16-bit address, you have three choices: low byte first, high byte first, or low byte only with a constant high byte. For a 24-bit address the set of possibilities expands, but is essentially the same: pick the order in which things appear, using fixed constants if desired.
A message at the top of the screen shows how many bytes are selected. It also tells you how many groups there are, but unlike the data operand formatter, the split-address table formatter doesn't care about group boundaries. For this reason, tables do not have to be contiguous in memory. The low bytes and high bytes could be on separate 256-byte pages.
It should be mentioned that SourceGen does not record the fact that the data in question is part of a table. The formatting, labels, and code hints are applied as if you entered them all individually by hand. The formatter is just significantly more convenient. It also does everything as a single undoable action, so if it comes out looking wrong, just hit "undo".
Quick Format Toggle
The "Toggle Single-Byte Format" feature provides a quick way to change a range of bytes to single bytes or back to their default format. It's equivalent to opening the Edit Data Format dialog and selecting "Single bytes" displayed as hex, or selecting "Default".
This can be handy if the default format for a range of bytes is a string, but you want to see it as bytes or set a label in the middle.
Copying to Clipboard
When you use Edit > Copy, all lines selected in the code list are copied to the system clipboard. This can be a convenient way to post code snippets into forum postings or documentation. The text is copied from the data shown on screen, so your chosen capitalization and pseudo-ops will appear in the copy.
Long comments are included, but notes are not.
By default, the label, opcode, operand, and comment fields are included. From the app settings dialog you can select a different format, "Disassembly", which also includes the address and byte columns.
A copy of all of the fields is also written to the clipboard in CSV format. If you have a spreadsheet like Excel, you can use Paste Special to put the data into individual cells.