6502/6502bench
1
0
Fork 0
mirror of https://github.com/fadden/6502bench.git synced 2024-12-04 11:49:58 +00:00
Code Issues Projects Releases Wiki Activity
c380b001b7
6502bench/SourceGen/RuntimeData/Help/index.html

199 lines
8.8 KiB
HTML
Raw Normal View History

Initial file commit
2018-09-28 17:05:11 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="main.css" rel="stylesheet" type="text/css" />
<title>Contents - 6502bench SourceGen</title>
</head>
<body>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<div id="content">
Initial file commit
2018-09-28 17:05:11 +00:00
<h1>6502bench SourceGen</h1>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<p>SourceGen is an interactive disassembler for 6502, 65C02,
Initial file commit
2018-09-28 17:05:11 +00:00
and 65816 code. The official web site is
<a href="https://6502bench.com/">https://6502bench.com/</a>.</p>
Add installation notes to README Also, add a link to the tutorial near the top of the manual's index page.
2018-10-01 18:09:04 +00:00
<p>If you want to dive right in, try the
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<a href="tutorials.html">tutorials</a>.</p>
Add installation notes to README Also, add a link to the tutorial near the top of the manual's index page.
2018-10-01 18:09:04 +00:00
Initial file commit
2018-09-28 17:05:11 +00:00
<h2>Contents</h2>
<ul>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="intro.html">Overview</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="intro.html#fundamental-concepts">Fundamental Concepts</a></li>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<li><a href="intro.html#begin">About 6502 Code</a>
<ul>
<li><a href="intro.html#charenc">Character Encoding</a></li>
</ul></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="intro.html#sgintro">How SourceGen Works</a>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<ul>
<li><a href="intro.html#scripts">Extension Scripts</a></li>
<li><a href="intro.html#hints">Analyzer Hints</a></li>
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="intro.html#sgconcepts">SourceGen Concepts</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="intro.html#about-symbols">All About Symbols</a>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<ul>
Data Bank Register management, part 5 Update documentation. Add some information about OMF relocation data as well. Fix bug in B=K handling.
2020-07-10 20:29:36 +00:00
<li><a href="intro.html#connecting-operands">Connecting Operands With Labels</a></li>
Label rework, part 1 This adds the concept of label annotations. The primary driver of the feature is the desire to note that sometimes you know what a thing is, but sometimes you're just taking an educated guess. Instead of writing "high_score_maybe", you can now write "high_score?", which is more compact and consistent. The annotations are stripped off when generating source code, making them similar to Notes. I also created a "Generated" annotation for the labels that are synthesized by the address table formatter, but don't modify the label for them, because there's not much need to remind the user that "T1234" was generated by algorithm. This also lays some of the groundwork for non-unique labels.
2019-11-09 04:44:45 +00:00
<li><a href="intro.html#internal-address-symbols">Internal Address Symbols</a></li>
<li><a href="intro.html#external-address-symbols">External Address Symbols</a></li>
Label rework, part 7 (of 7) Updated documentation for non-unique label changes. Added a new section to tutorial #1. Updated examples to use non-unique labels and variable tables. Tweaked the EditLabel radio button names.
2019-11-19 01:45:41 +00:00
<li><a href="intro.html#unique-local-global">Unique vs. Non-Unique and Local vs. Global</a></li>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<li><a href="intro.html#weak-refs">Weak References</a></li>
<li><a href="intro.html#symbol-parts">Parts and Adjustments</a></li>
<li><a href="intro.html#nearby-targets">Automatic Use of Nearby Targets</a></li>
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="intro.html#width-disambiguation">Width Disambiguation</a></li>
<li><a href="intro.html#pseudo-ops">Data and Directive Pseudo-Opcodes</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="mainwin.html">Using SourceGen</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="mainwin.html#starting-new">Starting a New Project</a></li>
<li><a href="mainwin.html#opening">Opening an Existing Project</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="mainwin.html#working">Working With a Project</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="mainwin.html#code-list">Code List</a></li>
<li><a href="mainwin.html#undo">Undo &amp; Redo</a></li>
<li><a href="mainwin.html#references">References Window</a></li>
<li><a href="mainwin.html#notes">Notes Window</a></li>
<li><a href="mainwin.html#symbols">Symbols Window</a></li>
<li><a href="mainwin.html#info">Info Window</a></li>
Add message list, part 2 (of 2) Implemented show/hide mechanic, using a button on the right side of the status bar to show status and to trigger un-hide. Also, show I/O direction in project symbols editor list.
2019-10-21 01:02:23 +00:00
<li><a href="mainwin.html#messages">Messages Window</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="mainwin.html#navigation">Navigation</a></li>
<li><a href="mainwin.html#hints">Adding and Removing Hints</a></li>
Rename FormatSplitAddress to FormatAddressTable Updated menus and docs to match.
2019-09-15 20:37:38 +00:00
<li><a href="mainwin.html#address-table">Format Address Table</a></li>
Instruction operand editor rework, part 2 Implemented local variable editing. Operands that have a local variable reference, or are eligible to have one, can now be edited directly from the instruction operand edit dialog. Also, updated the code list double-click handler so that, if you double-click on the opcode of an instruction that uses a local variable reference, the selection and view will jump to the place where that variable was defined. Also, tweaked the way the References window refers to references to an address that didn't use a symbol at that address. Updated the explanation in the manual, which was a bit confusing. Also, fixed some odds and ends in the manual. Also, fixed a nasty infinite recursion bug (issue #47).
2019-09-08 01:57:22 +00:00
<li><a href="mainwin.html#toggle-single">Toggle Single-Byte Format</a></li>
Add Actions > Format As Word (Ctrl+W) Formats a pair of bytes into a 16-bit word. As a special case, attempts to grab the next byte if only one byte is selected. (issue #29)
2018-11-12 01:20:12 +00:00
<li><a href="mainwin.html#format-as-word">Format As Word</a></li>
Make hint application less annoying Two changes: (1) Code and data hints are now only applied to the first byte on each selected line. This allows you to slap a code hint on a string without lighting up the whole string. Inline-data hints and hint removal work as before. (2) Added a menu item (with Ctrl+D as shortcut) to toggle the state of the uncategorized data analyzer. This makes it easy to turn off the feature that put the code into a string in the first place.
2018-10-08 04:51:15 +00:00
<li><a href="mainwin.html#toggle-data">Toggle Data Scan</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="mainwin.html#clipboard">Copying to Clipboard</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="editors.html">Editors</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="editors.html#address">Edit Address</a></li>
<li><a href="editors.html#flags">Edit Status Flags</a></li>
<li><a href="editors.html#label">Edit Label</a></li>
Instruction operand editor rework, part 4 (of 4) Updated the manual, and changed tutorial #2 to use local variables for pointers. If the symbol text box isn't empty, use the string as the initial value for the Label when creating a new project property. Fixed a crash when editing a project property.
2019-09-09 04:56:47 +00:00
<li><a href="editors.html#instruction-operand">Edit Instruction Operand</a>
<ul>
<li><a href="editors.html#explicit-format">Explicit Formats</a></li>
<li><a href="editors.html#shortcut-nar">Numeric Address References</a></li>
<li><a href="editors.html#shortcut-local-var">Local Variable References</a></li>
</ul></li>
<li><a href="editors.html#data-operand">Edit Data Operand</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="editors.html#comment">Edit Comment</a></li>
<li><a href="editors.html#long-comment">Edit Long Comment</a></li>
Data Bank Register management, part 5 Update documentation. Add some information about OMF relocation data as well. Fix bug in B=K handling.
2020-07-10 20:29:36 +00:00
<li><a href="editors.html#data-bank">Edit Data Bank (65816 only)</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="editors.html#note">Edit Note</a></li>
<li><a href="editors.html#project-symbol">Edit Project Symbol</a></li>
Add local variable tables to documentation
2019-09-02 01:14:59 +00:00
<li><a href="editors.html#lvtable">Edit Local Variable Table</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Visualizer improvements Various changes: - Generally treat visualization sets like long comments and notes when it comes to defining data region boundaries. (We were doing this for selections; now we're also doing it for format-as-word and in the data analyzer when scanning for strings/fill.) - Clear the visualization cache when the address map is altered. This is necessary for visualizers that dereference addresses. - Read the Apple II screen image from a series of addresses rather than a series of offsets. This allows it to work when the image is contiguous in memory but split into chunks in the file. - Put 1 pixel of padding around the images in the main code list, so they don't blend into the background. - Remember the last visualizer used, so we can re-use it the next time the user selects "new". - Move min-size hack from Loaded to ContentRendered, as it apparently spoils CenterOwner placement.
2019-12-06 22:49:35 +00:00
<li><a href="visualization.html">Visualizations</a>
<ul>
<li><a href="visualization.html#overview">Overview</a></li>
<li><a href="visualization.html#vis-and-sets">Visualizations and Visualization Sets</a></li>
<li><a href="visualization.html#runtime">Scripts Included with SourceGen</a></li>
</ul></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="codegen.html">Code Generation &amp; Assembly</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="codegen.html#supported">Supported Assemblers</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="codegen.html#version">Version-Specific Code Generation</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
<li><a href="codegen.html#generate">Generating Source Code</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="codegen.html#localizer">Label Localizer</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="codegen.html#assemble">Cross-Assembling Generated Code</a></li>
Progress toward 64tass support Most tests pass, but 2007-labels-and-symbols fails because the expressions recognized by 64tass don't match up with either of the other assemblers. This is currently using a workaround for the local label syntax. 64tass uses '_' as the prefix, which is unfortunate since SourceGen explicitly allowed underscores in labels. (So does 64tass for that matter, but it treats labels specially when the '_' comes first.) We will need to rename any non-local user labels that start with '_'. (issue #16)
2018-10-23 23:06:29 +00:00
<li><a href="codegen.html#quirks">Assembler-Specific Bugs &amp; Quirks</a>
<ul>
<li><a href="codegen.html#64tass">64tass</a></li>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<li><a href="codegen.html#acme">ACME</a></li>
Progress toward 64tass support Most tests pass, but 2007-labels-and-symbols fails because the expressions recognized by 64tass don't match up with either of the other assemblers. This is currently using a workaround for the local label syntax. 64tass uses '_' as the prefix, which is unfortunate since SourceGen explicitly allowed underscores in labels. (So does 64tass for that matter, but it treats labels specially when the '_' comes first.) We will need to rename any non-local user labels that start with '_'. (issue #16)
2018-10-23 23:06:29 +00:00
<li><a href="codegen.html#cc65">cc65</a></li>
<li><a href="codegen.html#merlin32">Merlin 32</a></li>
</ul></li>
Minor fixes Change + save + undo + change was being treated as non-dirty. Added link to "export" feature to documentation TOC. Added keyboard shortcut for high part in data operand editor. Corrected various things in the tutorial.
2019-09-27 20:43:58 +00:00
<li><a href="codegen.html#export-source">Exporting Source Code</a>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="settings.html">Properties &amp; Settings</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="settings.html#app-settings">Application Settings</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="settings.html#appset-codeview">Code View</a></li>
Update documentation PETSCII, ACME, and other improvements.
2019-08-18 23:42:40 +00:00
<li><a href="settings.html#appset-textdelim">Text Delimiters</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="settings.html#appset-asmconfig">Asm Config</a></li>
<li><a href="settings.html#appset-displayformat">Display Format</a></li>
<li><a href="settings.html#appset-pseudoop">Pseudo-Op</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
<li><a href="settings.html#project-properties">Project Properties</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
<li><a href="settings.html#projprop-general">General</a></li>
<li><a href="settings.html#projprop-projsym">Project Symbols</a></li>
<li><a href="settings.html#projprop-symfiles">Symbol Files</a></li>
<li><a href="settings.html#projprop-extscripts">Extension Scripts</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="tools.html">Tools</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
Use relocation data to format instruction operands This was a relatively lightweight change to confirm the usefulness of relocation data. The results were very positive. The relatively superficial integration of the data into the data analysis process causes some problems, e.g. the cross-reference table entries show an offset because the code analyzer's computed operand offset doesn't match the value of the label. The feature should be considered experimental The feature can be enabled or disabled with a project property. The results were sufficiently useful and non-annoying to make the setting enabled by default.
2020-07-04 00:37:04 +00:00
<li><a href="tools.html#instruction-chart">Instruction Chart</a></li>
<li><a href="tools.html#ascii-chart">ASCII Chart</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="tools.html#hexdump">Hex Dump Viewer</a></li>
Add file concatenation tool Select a list of files and save it. File lengths and CRCs are shown for reference.
2019-12-29 01:14:29 +00:00
<li><a href="tools.html#file-concat">File Concatenator</a></li>
Use relocation data to format instruction operands This was a relatively lightweight change to confirm the usefulness of relocation data. The results were very positive. The relatively superficial integration of the data into the data analysis process causes some problems, e.g. the cross-reference table entries show an offset because the code analyzer's computed operand offset doesn't match the value of the label. The feature should be considered experimental The feature can be enabled or disabled with a project property. The results were sufficiently useful and non-annoying to make the setting enabled by default.
2020-07-04 00:37:04 +00:00
<li><a href="tools.html#file-slicer">File Slicer</a></li>
<li><a href="tools.html#omf-converter">OMF Converter</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="advanced.html">Advanced Topics</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
Move symbol file and extension script docs into manual Once upon a time, symbol files and extension scripts could only be defined in the RuntimeData directory, so having the documentation there made sense. Since both of these things can now be defined in project directories, the documentation belongs in the manual. (issue #27)
2018-10-08 22:30:43 +00:00
<li><a href="advanced.html#platform-symbols">Platform Symbol Files (.sym65)</a></li>
<li><a href="advanced.html#extension-scripts">Extension Scripts</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="advanced.html#multi-bin">Working With Multiple Binaries</a></li>
<li><a href="advanced.html#overlap">Overlapping Address Spaces</a></li>
Data Bank Register management, part 5 Update documentation. Add some information about OMF relocation data as well. Fix bug in B=K handling.
2020-07-10 20:29:36 +00:00
<li><a href="advanced.html#reloc-data">OMF Relocation Dictionaries</a></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="advanced.html#debug">Debug Menu Options</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="analysis.html">Appendix: Instruction and Data Analysis</a>
Initial file commit
2018-09-28 17:05:11 +00:00
<ul>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="analysis.html#analysis-process">Analysis Process</a>
Revise documentation
2018-10-04 01:03:04 +00:00
<ul>
<li><a href="analysis.html#auto-format">Automatic Formatting</a></li>
<li><a href="analysis.html#undo-redo">Interaction With Undo/Redo</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
<li><a href="analysis.html#code-analysis">Code Analysis</a>
Revise documentation
2018-10-04 01:03:04 +00:00
<ul>
<li><a href="analysis.html#extension-scripts">Extension Scripts</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
<li><a href="analysis.html#data-analysis">Data Analysis</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Initial file commit
2018-09-28 17:05:11 +00:00
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="end-notes.html">End Notes</a> </li>
Initial file commit
2018-09-28 17:05:11 +00:00
Revise documentation
2018-10-04 01:03:04 +00:00
<br/>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<li><a href="tutorials.html">Tutorials</a>
Revise documentation
2018-10-04 01:03:04 +00:00
<ul>
Add a bit to the tutorial In the data operand edit section, walk through selecting a single byte vs. multiple bytes when you want to set a multi-byte format. (inspired by issue #41)
2018-11-08 19:35:35 +00:00
<li><a href="tutorials.html#basic-features">Tutorial #1: Basic Features</a></li>
<li><a href="tutorials.html#advanced-features">Tutorial #2: Advanced Features</a></li>
Rearrange the tutorial files Copied the extension script tutorial files out of the Scripts directory and into the Tutorial directory. This makes more sense, and makes it possible to expand the script sample without altering the tutorial. Reverted the Scripts sample to be an actual sample, rather than a tutorial. Renumbered the last two tutorials and added them to the ToC. This gives them actual numbers rather than treating them as add-ons to the advanced tutorial. Moved the source files for the tutorial binaries into a subdirectory to reduce clutter. This does mean we have two separate copies of the inline string sample plugins, but that's an artifact of our attempts at security.
2019-10-30 16:49:11 +00:00
<li><a href="tutorials.html#address-tables">Tutorial #3: Address Table Formatting</a></li>
<li><a href="tutorials.html#extension-scripts">Tutorial #4: Extension Scripts</a></li>
Add file concatenation tool Select a list of files and save it. File lengths and CRCs are shown for reference.
2019-12-29 01:14:29 +00:00
<li><a href="tutorials.html#visualizations">Tutorial #5: Visualizations</a></li>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
</ul></li>
Revise documentation
2018-10-04 01:03:04 +00:00
Initial file commit
2018-09-28 17:05:11 +00:00
</ul>
</div>
Clean up HTML in manual
2018-10-09 17:04:10 +00:00
<div id="footer">
<hr/>
Minor fixes Change + save + undo + change was being treated as non-dirty. Added link to "export" feature to documentation TOC. Added keyboard shortcut for high part in data operand editor. Corrected various things in the tutorial.
2019-09-27 20:43:58 +00:00
<p>Copyright 2019 faddenSoft</p>
Initial file commit
2018-09-28 17:05:11 +00:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink