From 9a8df9c4980a3e173fa0a26f6a01327e8c970ab9 Mon Sep 17 00:00:00 2001 From: Andy McFadden Date: Sun, 1 Sep 2019 18:14:59 -0700 Subject: [PATCH] Add local variable tables to documentation --- SourceGen/RuntimeData/Help/editors.html | 21 ++++++ SourceGen/RuntimeData/Help/index.html | 4 +- SourceGen/RuntimeData/Help/intro.html | 93 +++++++++++++++++++++--- SourceGen/RuntimeData/Help/mainwin.html | 4 + SourceGen/RuntimeData/Help/settings.html | 6 +- 5 files changed, 116 insertions(+), 12 deletions(-) diff --git a/SourceGen/RuntimeData/Help/editors.html b/SourceGen/RuntimeData/Help/editors.html index 0f3ab8b..0221375 100644 --- a/SourceGen/RuntimeData/Help/editors.html +++ b/SourceGen/RuntimeData/Help/editors.html @@ -257,6 +257,27 @@ the .EQ directive.

operand references an address outside the scope of the data file. Symbols marked as "constant" will not, though you can still specify them manually.

+ +

Edit Local Variable Table

+

Local variables are arranged in +tables, which are created at a specific file offset. They must be +associated with a line of code, and are usually placed at the start of +a subroutine. The editor allows you to create, edit, delete, and +move tables.

+

Empty tables are allowed. These can be useful if the "clear previous" +flag is set. If you want to delete the table, click the "Delete Table" +button.

+

Use the buttons to add, edit, or remove individual variables. Each +variable has a name, a value, a width, and an optional comment. The +standard naming rules for symbols apply. Variables are only used for +zero-page and stack-relative operands, so all values must fall in the +range 0-255, with their width factored in. So the maximum address for +a two-byte pointer is $fe.

+

You can move a table to any offset that is the start of an instruction +and doesn't already have a local variable table present. Click the +"Move Table" button and enter the new offset in hex. You can also use the +up/down arrows to move to the next valid offset.

+