sms/ssc
1
0
Fork 0
Code Issues Pull requests Releases 2 Activity

Updated binary documentation

Browse source 
As to reflect the recent changes in the point system.
This commit is contained in:
arookas 2016-02-12 23:02:30 -05:00
parent aeb22bc4ed
commit cbbb17b9cf
1 changed files with 2 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
extensions.md
View file

@ -57,10 +57,8 @@ The .text section contains all the executable instructions that the interpreter
There is also a method for each of the standard commands defined by `TSpcInterp`. Their job is to simply write the specified command, with the following exceptions:
- It is the responsibility of the `WriteINT` method to redirect to `WriteINT0` or `WriteINT1`, if that functionality is desired. `WriteINT0` and `WriteINT1` are _never_ called by the compiler directly.
- The `WriteJNE` and `WriteJMP` methods have two overloads, each:
- The first overload takes no parameters and returns a `sunPoint` instance. This overload is designed to write a dummy command with an associated `sunPoint` instance which can be later closed to finish writing the command.
- The second overload simply writes the final command directly, without opening a `sunPoint` instance.
- It is the responsibility of the `WriteINT` method to redirect to `WriteINT0` or `WriteINT1`, if that functionality is desired.
`WriteINT0` and `WriteINT1` are **never** called by the compiler directly.
The API defines several methods and properties for navigating the .text section:
@ -71,13 +69,6 @@ The API defines several methods and properties for navigating the .text section:
|`Keep`|Pushes the current offset into the .text section onto the stack.|
|`Back`|Pops the element off the top of the stack and seeks to that offset in the .text section.|
For opening and closing `sunPoint` instances, the following methods exist in the API:
|Method|Description|
|------|-----------|
|`OpenPoint`|Creates a `sunPoint` instance linked to the current offset in the .text section.|
|`ClosePoint`|Closes a `sunPoint` instance. If the `offset` parameter is omitted, the current value of the `Offset` property is used instead.|
#### .data
The .data section contains a table of all the strings used in scripts. These entries are referenced by the `str` instruction. Data entries are automatically interned by _ssc_, so your implementation need not check for duplicate entries.