mirror of https://github.com/fadden/6502bench.git synced 2024-11-29 10:50:28 +00:00

History

Andy McFadden 4bf1ab2799 Tweak visualizer interface Report visualization generation errors through an explicit IApplication interface, instead of pulling messages out of the DebugLog stream. Declare that GetVisGenDescrs() is only called when the plugin is in the "prepared" state, so that plugins can taylor the set based on the contents of the file. (This could be used to set min/max on the "offset" entries, but I want special handling for offsets, so we might as well set it later.)		2019-12-05 10:29:00 -08:00
..
Apple	Tweak visualizer interface	2019-12-05 10:29:00 -08:00
Atari	External symbol I/O direction and address mask, part 2	2019-10-16 14:55:10 -07:00
Commodore	Add a C128 Kernal entry point list	2018-10-11 10:46:47 -07:00
Help	Tweak documentation	2019-11-19 13:43:42 -08:00
Nintendo	Update NES symbols	2019-11-08 07:53:28 -08:00
TestData	Initial file commit	2018-09-28 10:05:11 -07:00
ExportTemplate.html	Minor updates	2019-10-25 18:16:09 -07:00
LegalStuff.txt	Initial file commit	2018-09-28 10:05:11 -07:00
README.md	Add default text encoding mode to system definition	2019-08-14 18:03:40 -07:00
RuntimeData.csproj	Initial file commit	2018-09-28 10:05:11 -07:00
SGStyle.css	Make links less distracting in HTML output	2019-09-22 16:45:08 -07:00
SystemDefs.json	Improve visualization	2019-12-04 15:59:37 -08:00

README.md

Runtime Data

Symbol files and analyzer scripts are split into directories by platform manufacturer.

The Visual Studio project (RuntimeData.csproj) exists so you can edit scripts with IntelliSense and error highlighting. Everything here is distributed as source, not in compiled form; all compilation occurs at run time.

SystemDefs.json

This file defines the systems available in the "new project" screen. The following fields are mandatory:

Name - Short name that identifies the system.
GroupName - Short string used to group common items together in the UI.
CPU - Type of CPU used. The string must be part of the known set (see CpuDef.cs)
Speed - Clock rate, in MHz, of the CPU on the system. When multiple speeds are possible, use the most common, favoring NTSC over PAL.
SymbolFiles - List of platform symbol file identifiers (see below).
ExtensionScripts - List of extension script file identifiers (see below).
Parameters - List of optional parameters (see below).

The currently-supported parameters are:

load-address=<addr> - Specify the initial load address. The default is 0x1000.
entry-flags=<flag-set> - Specify the processor status flag values to use at entry points. This is intended for use on the 65802/65816, and may be one of "emulation", "native-short", and "native-long". The default is "emulation".
undocumented-opcodes={true|false} - Enable or disable undocumented opcodes. They are disabled by default.
first-word-is-load-addr={true|false} - If true, the first two bytes of the file contain the load address.
default-text-encoding=<mode> - Specify default character encoding. Use "c64-petscii" for PETSCII. The default is low/high ASCII.

All of these things can be changed after the project has begun, but it's nice to have them configured in advance.

SymbolFiles and ExtensionScripts use file identifiers, which look like "RT:Apple/ProDOS8.sym65". The "RT:" means that the file lives in the RuntimeData directory, and the rest is a partial pathname. Files that live in the same directory as the project file are prefixed with "PROJ:". All symbol files and extension scripts must live in the RuntimeData directory or project file directory, or they will not be loaded.

All "RT:" identifier paths are relative to the RuntimeData directory. The Group Name is not automatically added.

Platform Symbol Files and Extension Scripts

These are described in the "Advanced Topics" section of the manual (here).

Misc Files

LegalStuff.txt, Logo.png, and AboutImage.png are displayed by SourceGen, on the start screen and the About box.