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

History

Andy McFadden 97a372a884 Add selectable auto-label styles SourceGen creates "auto" labels when it finds a reference to an address that doesn't have a label associated with it. The label for address $1234 would be "L1234". This change allows the project to specify alternative label naming conventions, annotating them with information from the cross-reference data. For example, a subroutine entry point (i.e. the target of a JSR) would be "S_1234". (The underscore was added to avoid confusion when an annotation letter is the same as a hex digit.) Also, tweaked the way the preferred clipboard line format is stored in the settings file (was an integer, now an enumeration string).		2019-04-15 15:14:04 -07:00
..
Apple	Add some more Applesoft zero-page locations	2018-10-11 16:48:30 -07:00
Atari	Add symbols for Atari Lynx	2018-10-11 14:51:54 -07:00
Commodore	Add a C128 Kernal entry point list	2018-10-11 10:46:47 -07:00
Help	Add selectable auto-label styles	2019-04-15 15:14:04 -07:00
Nintendo	Initial file commit	2018-09-28 10:05:11 -07:00
TestData	Initial file commit	2018-09-28 10:05:11 -07:00
AboutImage.png	Initial file commit	2018-09-28 10:05:11 -07:00
LegalStuff.txt	Initial file commit	2018-09-28 10:05:11 -07:00
Logo.png	Initial file commit	2018-09-28 10:05:11 -07:00
README.md	Fix items in angle brackets	2018-10-08 17:11:03 -07:00
RuntimeData.csproj	Initial file commit	2018-09-28 10:05:11 -07:00
SystemDefs.json	Split C64 system def into .PRG/.BIN	2018-10-23 12:30:19 -07: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.

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.