The are two versions of Locomotive BASIC used in the Amstrad CPC and CPC+ computers'''''This artikel originally came from Kevin Thackers' archive at [http://www. v1cpctech.0 is used by the CPC464, and v1org.1 is used by the CPC664, CPC6128, CPC464+ and CPC6128+uk http://www.cpctech.org.uk].'''''
== Passing parameters to a RSX (Resident System Extension) command or binary function =Technical information about Locomotive BASIC =
A RSX (Resident System Extension) command is accessed through The are two versions of Locomotive BASIC with a "|" character prefixused in the Amstrad CPC and CPC+ computers. ev1.g. The "DIR" RSX0 is used by the CPC464, and v1.1 is accessed used by "|DIR"the CPC664, CPC6128, CPC464+ and CPC6128+.
A == Passing parameters to a RSX (Resident System Extension) command or binary function is accessed through BASIC using the "CALL" command. ==
Passing A RSX (Resident System Extension) command is accessed through BASIC with a string parameter:"|" character prefix. e.g. The "DIR" RSX, is accessed by "|DIR".
<br> A binary function is accessed through BASIC v1.0 a$=using the "ACALL":|DRIVE,@a$command.
BASIC v1.1<br> Passing a string parameter:
<br> BASIC v1.0 <pre>a$="A":|DRIVE,@a$</pre> BASIC v1.1: <pre>|DRIVE,"A"</pre> == Additional keywords and variables in BASIC v1.1 ==
== Additional #BASIC v1.1 has the following additional keywords and variables in : #*COPYCHR$ #*CURSOR #*DEC$ #*FILL #*FRAME #*GRAPHICS #*MASK #BASIC v1.1 ==has the following additional predefined variables: #*DERR
* BASIC v1.1 has the following additional keywords:<br> <br>
:* COPYCHR$:* CURSOR:* DEC$:* FILL:* FRAME:* GRAPHICS:* MASK == Entering BASIC programs ==
* A maximum of 255 characters can be entered for a single BASIC v1line.1 has This is converted into the following additional predefined variables:tokenised BASIC program which is more compact than the line entered. The BASIC keywords are converted into "tokens", or 1-2 byte sequences which uniquely identify each keyword.
:* DERR <br>
== Entering Structure of a BASIC programs program ==
A maximum of 255 characters can be entered for a single BASIC lineprogram is stored in a tokenised format.Here the keywords are represented by 1 or 2 byte unique sequences. Each line of the BASIC program has the form:
This is converted into the tokenised BASIC program which is more compact than the line entered. The BASIC keywords are converted into "tokens", or 1-2 byte sequences which uniquely identify each keyword.<br>
{| border== Structure of a BASIC program == A BASIC program is stored in a tokenised format. Here the keywords are represented by "1 or 2 byte unique sequences. Each line of the BASIC program has the form: {|{{Prettytable|width: 700px; font-size: 2em;}}|''Offset''||''Size''||''Description''"
|-
|0||2||Length of line data in bytes (note 1)! Offset ! Size ! Description
|-
|2|0 |2||16-bit decimal integer Length of line number data in bytes (note 21)
|-
|42 |2 |n||BASIC 16-bit decimal integer line encoded into tokens number (note 32)
|-
| 4 |n+1||1||"0" the end of BASIC line marker encoded into tokens (note 43)
|-
| n+1
| 1
| "0" the end of line marker (note 4)
|}
'''<br> Notes:'''
#* This 16-bit value has two functions::#** if "0" it signals the end of the BASIC program. In this case, there is no furthur BASIC program lines or data.:#** otherwise, this value defines the length of the tokenised BASIC program line in bytes, and includes the 2 bytes defining this value, the 2 bytes defining the program line number, and the end of line marker. This number is stored in little endian notation with low byte followed by high byte. #* This 16-bit value defines the line number and exists if the length of line data in bytes is not "0". A line number is a integer number in the range 1-65535. This number is stored in little endian notation with low byte followed by high byte.#* This data defines the tokenised BASIC program line and exists if the length of line data in bytes is not "0". The length is dependant on the BASIC program line contents.#* This value defines the end of the tokenised BASIC line data and exists if the length of line data in bytes is not "0". The BASIC interpreter looks for this token during the processing of this line, and if found, will stop execution and continue to the next line.
== BASIC tokens ==
This table list the BASIC tokens with no prefix byte.
<br> {|{{Prettytableborder="1"|width: 700px-! Code<br>(hexidecimal) ! BASIC keyword|-| & font00 | end of tokenised line marker|-size| &01 | ": 2em" statement seperator|-| &}}02 |''Offset''integer variable definition (defined with "%" suffix)|-|''Count''&03 |string variable definition (defined with "$" suffix)|-| &04 | floating point variable definition (defined with "!" suffix)|-| &05 | var?|-| &06 | var?|-| &07 | var?|-| &08 | var?|-| &09 | var?|-| &0a | var?|-| &0b | variable definition (no suffix)|-| &0c | variable definition (no suffix)|-| &0d | variable definition (no suffix)|-| &0e | number constant "0"|-| &0f | number constant "1"|-| &10 | number constant "2"|-| &11 | number constant "3"|-| &12 | number constant "4"|-| &13 | number constant "5"|-| &14 | number constant "6"|-| &15 | number constant "7"|-| &16 | number constant "8"|-| &17 | number constant "9"|-| &18 | number constant "10"|-| &19 | 8-bit integer decimal value|-| &1a | 16-bit integer decimal value|-| &1b | 16-bit integer binary value (with "&X" prefix)|-| &1c | 16-bit integer hexadecimal value (with "&H" or "&" prefix)|-| &1d | 16-bit BASIC program line memory address pointer|-| &1e | 16-bit integer BASIC line number|-| &1f | floating point value|-| &20 | " " (space) symbol|-| &21 | ASCII "!" symbol|-| &22 | quoted string value|-| &23-7b | ASCII printable symbols|-| &7c | "|" symbol; prefix for RSX commands|-| &80 | AFTER|-| &81 | AUTO|-| &82 | BORDER|-| &83 | CALL|-| &84 | CAT|-| &85 | CHAIN|-| &86 | CLEAR|-| &87 | CLG|-| &88 | CLOSEIN|-| &89 | CLOSEOUT|-| &8a | CLS|-| &8b | CONT|-| &8c | DATA|-| &8d | DEF|-| &8e | DEFINT|-| &8f | DEFREAL|-| &90 | DEFSTR|-| &91 | DEG|-| &92 | DELETE|-| &93 | DIM|-| &94 | DRAW|-| &95 | DRAWR|-| &96 | EDIT|-| &97 | ELSE|-| &98 | END|-| &99 | ENT|-| &9a | ENV|-| &9b | ERASE|-| &9c | ERROR|-| &9d | EVERY|-| &9e | FOR|-| &9f | GOSUB, GO SUB|-| &a0 | GOTO, GO TO|-| &a1 | IF|-| &a2 | INK|-| &a3 | INPUT|-| &a4 | KEY|-| &a5 | LET|-| &a6 | LINE|-| &a7 | LIST|-| &a8 | LOAD|-| &a9 | LOCATE|-| &aa | MEMORY|-| &ab | MERGE|-| &ac | MID$|-| &ad | MODE|-| &ae | MOVE|-| &af | MOVER|-| &b0 | NEXT|-| &b1 | NEW|-| &b2 | ON|-| &b3 | ON BREAK|-| &b4 | ON ERROR GOTO, ON ERROR GO TO|-| &b5 | SQ|-| &b6 | OPENIN|-| &b7 | OPENOUT|-| &b8 | ORIGIN|-| &b9 | OUT|-| &ba | PAPER|-| &bb | PEN|-| &bc | PLOT|-| &bd | PLOTR|-| &be | POKE|-| &bf | PRINT|-| &c0 |"''Description''" symbol (same function as REM keyword)|-| &c1 | RAD|-| &c2 | RANDOMIZE|-| &c3 | READ|-| &c4 | RELEASE|-| &c5 | REM|-| &c6 | RENUM|-| &c7 | RESTORE|-| &c8 | RESUME|-| &c9 | RETURN|-| &ca | RUN|-| &cb | SAVE|-| &cc | SOUND|-| &cd | SPEED|-| &ce | STOP|-| &cf | SYMBOL|-| &d0 | TAG|-| &d1 | TAGOFF|-| &d2 | TROFF|-| &d3 | TRON|-| &d4 | WAIT|-| &d5 | WEND|-| &d6 | WHILE|-| &d7 | WIDTH|-| &d8 | WINDOW|-| &d9 | WRITE|-| &da | ZONE|-| &db | DI|-| &dc | EI|-| &dd | FILL (v1.1)|-| &de | GRAPHICS (v1.1)|-| &df | MASK (v1.1)|-| &e0 | FRAME (v1.1)|-| &e1 | CURSOR (v1.1)|-| &e2 | (note 2)|-| &e3 | ERL|-| &e4 | FN|-| &e5 | SPC|-| &e6 | STEP|-| &e7 | SWAP|-| &e8 | (note 2)|-| &e9 | (note 2)|-| &ea | TAB|-| &eb | THEN|-| &ec | TO|-| &ed | USING|-| &ee | > (greater than)|-| &ef | = (equal)|-| &f0 | &gt=, > =, => (greater or equal)|-| &f1 | < (less than)|-| &f2 | <&gt, < > (not equal)|-| &f3 | =<, <=, < = (less than or equal)|-| &f4 | + (addition)|-| &f5 | - (subtraction or unary minus)|-| &f6 | * (multiplication)|-| &f7 | / (division)|-| &f8 | ^ (x to the power of y)|-| &f9 | \ (integer division)|-| &fa | AND|-| &fb | MOD
|-
|0&fc ||1||"|" character prefixOR
|-
|1&fd ||1||8-bit byte offset to tokens following RSX name.XOR
|-
|2&fe ||x||RSX name. (Last character of name has bit 7 set to "1", all other characters have bit 7 set to "0")NOT
|-
| &ff
| (prefix for additional keywords)
|}
* This token identifies a integer (16-bit) number. The two bytes following this token is the number, stored low byte then high byte. e.g. &19,&2d,&00 represents the integer number "&002d"="45".* This token (&0B) is changed at run-time to &0D* This token identifies a integer variable. 02,00,00,var name offset to number in program setup when program RUN. The variable name is stored directly, with bit 7 of the last character set.* This token identifies a string variable. offset to string in program string stored AS IS with quotes around it.* This token identifies a floating point number. Immediatly following the token are 5 bytes which define the number.<br> Notes:
Offset Count Description 0 1 #*The &1f (note 1) 1 5 Floating point number (note 2) 1. This byte amp;ff code is the BASIC token identifying used as a floating point number 2prefix for more keywords. These 5 bytes define See the floating point numbertable below for the list of keywords using this prefix. #* The space symbol &e2,&e8 and &e9 are not used #*&7c ("|") is a character prefix used as to identify a RSX command seperator * Variable definitions: o The variable definition has the following structure: Offset Count Description 0 1 Token defining variable type 2 2 16-bit Byte offset to variable value within tokenised BASIC program. 4 x Variable name
The 16-bit byte offset is initially set to 0, but is setup when the program is RUNe. The offset is stored in little-endian format, with low byte followed by high byteg. o The token byte defines the variable type (i.e. string, floating point, integer) and the suffix ("$|DIR", none and "%"). o The variable name An RSX is stored encoded in the program, with bit 7 of the last character set to "1". e.g. The variable named "abc" will be encoded as 'a','b','c'+&80 * String values: o Each string value is prefixed with &22 token. o All strings must be enclosed by double quote symbols ("). This symbols define the start and end of the string value. o The string value can contain any symbol except the quote ("). i.e. 0-&21, and &23-&ff can be used. * After running a program, Tokens of "1d" with 16-bit BASIC program line pointers are changed to token "1e" with using the 16-bit memory address of the BASIC line number in memory. following structure:
This table list the BASIC tokens with a {| border="1"|-! Offset ! Count ! Description|-| 0 | 1 | "&ff #124;" character prefix |-| 1 | 1 | 8-bit byteoffset to tokens following RSX name.|-| 2 | x | RSX name.(Last character of name has bit 7 set to "1", all other characters have bit 7 set to "0")|}
Code#*This token identifies a integer (hexidecimal16-bit) BASIC keyword&00 ABS&01 ASC&02 ATN&03 CHR$&04 CINT&05 COS&06 CREAL&07 EXP&08 FIX&09 FRE&0a INKEY&0b INP&0c INT&0d JOY&0e LEN&0f LOG&10 LOG10&11 LOWER$&12 PEEK&13 REMAIN&14 SGN&15 SIN&16 SPACE$&17 SQ&18 SQRnumber. The two bytes following this token is the number, stored low byte then high byte. e.g. &19 STR$,&1a TANamp;2d,&1b UNT&1c UPPER$&1d VAL (note 2)&40 EOF&41 ERR&42 HIMEM&43 INKEY$&44 PIamp;00 represents the integer number "&002d"="45 RND&46 TIME&47 XPOS&48 YPOS&49 DERR (v1".1) #*This token (note 3&0B)is changed at run-time to &71 BIN$amp;0D &72 DEC$ (v1#*This token identifies a integer variable. 02,00,00,var name offset to number in program setup when program RUN. The variable name is stored directly, with bit 7 of the last character set.1)&73 HEX$#*This token identifies a string variable. offset to string in program string stored AS IS with quotes around it. &74 INSTR&75 LEFT$&76 MAX&77 MIN&78 POS&79 RIGHT$&7a ROUND&7b STRING$&7c TEST&7d TESTR&7e COPYCHR$ (v1#*This token identifies a floating point number. Immediatly following the token are 5 bytes which define the number.1)&7f VPOS (note 4)
NOTES:{| border="1"|-! Offset ! Count ! Description|-| 0 | 1 | &1f (note 1)|-| 1 | 5 | Floating point number (note 2)|}
#* #This byte is the BASIC token identifying a floating point number #*#These codes are prefixed by &FF. e.g5 bytes define the floating point number. #*The keyword "ABS" space symbol is stored used as a command seperator #*Variable definitions: #**The variable definition has the following sequencestructure:
&FF,&00{| border="1"|-! Offset ! Count ! Description|-| 0 | 1 | Token defining variable type|-| 2 | 2 | 16-bit Byte offset to variable value within tokenised BASIC program.|-| 4 | x | Variable name|}
* Codes &1e<br> The 16-bit byte offset is initially set to 0, but is setup when the program is RUN.The offset is stored in little-endian format, with low byte followed by high byte..&3f inclusive are not used* Codes &4a...&6f inclusive are not used* Codes &80...&ff inclusive are not used
== Floating Point data definition ==#**The token byte defines the variable type (i.e. string, floating point, integer) and the suffix ("$", none and "%"). #**The variable name is stored in the program, with bit 7 of the last character set to "1". e.g. The variable named "abc" will be encoded as 'a','b','c'+&80 #*String values: #**Each string value is prefixed with &22 token. #**All strings must be enclosed by double quote symbols (&quot). This symbols define the start and end of the string value. #**The string value can contain any symbol except the quote ("). i.e. 0-&21, and &23-&ff can be used. #*After running a program, Tokens of "1d" with 16-bit BASIC program line pointers are changed to token "1e" with the 16-bit memory address of the BASIC line number in memory.
A floating point number represents a number <br> This table list the BASIC tokens with both an integer and fractional parta &ff prefix byte.
In Amstrad BASIC, a floating point number is stored in base-2 in a normalized form:<br>
{| border="1 x 2"|-! Code<exponentbr>(hexidecimal) ! BASIC keyword|-| &00 | ABS|-| &01 | ASC|-| &02 | ATN|-| &03 | CHR$|-| &04 | CINT|-| &05 | COS|-| &06 | CREAL|-| &07 | EXP|-| &08 | FIX|-| &09 | FRE|-| &0a | INKEY|-| &0b | INP|-| &0c | INT|-| &0d | JOY|-| &0e | LEN|-| &0f | LOG|-| &10 | LOG10|-| &11 | LOWER$|-| &12 | PEEK|-| &13 | REMAIN|-| &14 | SGN|-| &15 | SIN|-| &16 | SPACE$|-| &17 | SQ|-| &18 | SQR|-| &19 | STR$|-| &1a | TAN|-| &1b | UNT|-| &1c | UPPER$|-| &1d | VAL|-| | (note 2)|-| &40 | EOF|-| &41 | ERR|-| &42 | HIMEM|-| &43 | INKEY$|-| &44 | PI|-| &45 | RND|-| &46 | TIME|-| &47 | XPOS|-| &48 | YPOS|-| &49 | DERR (v1.1)|-| | (note 3)|-| &71 | BIN$|-| &72 | DEC$ (v1.1)|-| &73 | HEX$|-| &74 | INSTR|-| &75 | LEFT$|-| &76 | MAX|-| &77 | MIN|-| &78 | POS|-| &79 | RIGHT$|-| &7a | ROUND|-| &7b | STRING$|-| &7c | TEST|-| &7d | TESTR|-| &7e | COPYCHR$ (v1.1)|-| &7f | VPOS|-| | (note 4)|}
The representation uses 5 bytes and is stored using the following structure<br> NOTES:
Byte 0 1 2 3 4#*These codes are prefixed by &FF. e.g. The keyword "ABS" is stored as the following sequence: <pre>&FF,&00</pre> Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0#*Codes &1e...&3f inclusive are not used Function mantissa (bits 23-16) mantissa (bits 15-8) mantissa (bits 7-0) sign mantissa (bits 30-24) exponent#*Codes &4a...&6f inclusive are not used #*Codes &80...&ff inclusive are not used
=== Sign =Floating Point data definition ==
The sign is represented by bit 7 of byte 3A floating point number represents a number with both an integer and fractional part.
The value of the sign bit indicates the sign of the <br> In Amstrad BASIC, a floating point number.is stored in base-2 in a normalized form: 1 x 2<sup><exponent></sup> The representation uses 5 bytes and is stored using the following structure:
* If the sign bit is "1", then the number is negative.* If the sign bit is "0", then the number is positive.<br>
{| border="1"|-! Byte ! colspan="8" | 0 ! colspan= Mantissa "8" | 1 ! colspan="8" | 2 ! colspan="8" | 3 ! colspan="8" | 4|-! Bit ! 7 ! 6 ! 5 ! 4 ! 3 ! 2 ! 1 ! 0 ! 7 ! 6 ! 5 ! 4 ! 3 ! 2 ! 1 ! 0 ! 7 ! 6 ! 5 ! 4 ! 3 ! 2 ! 1 ! 0 ! 7 ! 6 ! 5 ! 4 ! 3 ! 2 ! 1 ! 0 ! 7 ! 6 ! 5 ! 4 ! 3 ! 2 ! 1 ! 0|-| Function | colspan="8" | mantissa (bits 23-16) | colspan="8" | mantissa (bits 15-8) | colspan="8" | mantissa (bits 7-0) | colspan="1" | sign | colspan="7" | mantissa (bits 30-24) | colspan="8" | exponent|}
The mantissa holds the normalized number. The exponent is manipulated so that the most significant bit is always 1. Since it is always 1, it is not stored. It's value is implied by the representation.=== Sign ===
=== Exponent ===The sign is represented by bit 7 of byte 3. The value of the sign bit indicates the sign of the floating point number.
The exponent #*If the sign bit is 8-"1", then the number is negative. #*If the sign bit and is stored in byte 4"0", then the number is positive.
It is stored with a bias of 128.=== Mantissa ===
* 128-255 are positive exponentsThe mantissa holds the normalized number. The exponent is manipulated so that the most significant bit is always 1. Since it is always 1,* 0-127 are negative exponentsit is not stored. It's value is implied by the representation.
To obtain the signed exponent, you must subtract 128 from the stored exponent.=== Exponent ===
The minimum exponent is 0 8-bit and this describes is stored in byte 4. It is stored with a number bias of 2^-127128.
The maximum exponent is 255 and this describes a number of 2^#*128-255 are positive exponents, #*0-127 are negative exponents.
== BASIC floatingTo obtain the signed exponent, you must subtract 128 from the stored exponent. The minimum exponent is 0 and this describes a number of 2^-point/real variables ==127. The maximum exponent is 255 and this describes a number of 2^128.
A == BASIC floating -point (/real) variable describes a number with integer and fractional parts.variables ==
* A integer floating point (real) variable is defined with describes a "!" character postfixnumber with integer and fractional parts.
e.g#*A integer variable is defined with a "!" character postfix.
e.g. <pre>a! = 3.141592654</pre> #*A real number uses 5 bytes of memory as storage. The format is described above. #*The address of a real variable can be found in BASIC by: <pre>PRINT @a!</pre>
* A real number uses 5 bytes Where "a" should be replaced with the name of memory as storagethe variable. The format is described above.* The address of a real variable can be found in BASIC by:
PRINT @a!<br>
Where "a" should be replaced with the name of the variable.== BASIC integer variables ==
== BASIC A integer variables ==variable describes a whole number. i.e. a number without any fractional part.
A integer variable describes a whole number. i.e. a number without any fractional part.<br> NOTES:
NOTES:#*A integer variable is defined with a "%" character postfix.
e.g. <pre>a% = 3</pre> #* A integer variable is defined with has a "%" character postfix.range of -32768 to 32767 #*A integer variable always uses two bytes of memory as storage with the following format:
e.g.{| border="1"|-! Offset ! Length ! Description|-| 0 | 2 | Integer number|}
#*The address of the integer variable can be found in BASIC by: <pre>PRINT @a% = 3</pre>
* A integer variable has where "a range " should be replaced with the name of -32768 to 32767* A integer the variable always uses two bytes of memory as storage with the following format:.
Offset Length Description0 2 Integer number== BASIC string variables ==
* The address of the integer A string is a variable can be found in BASIC by:which contains a group of characters.
PRINT @a%<br> NOTES:
where "#**A string variable is defined in BASIC with a" should be replaced with the name of the variable$" character postfix.
e.g. <pre>a$ == BASIC "hello"</pre> #**A string variables ==variable is described internally by a "string descriptor block" which has the following structure:
A string is a variable which contains a group of characters. NOTES: * A string variable is defined in BASIC with a "$" character postfix. e.g. a$ {| border= "hello1"|-* A string variable is described internally by a "string descriptor block" which has the following structure:! Offset ! Length Offset Length ! Description |-| 0 | 1 | Length of string in bytes/characters |-| 1 | 2 | Location of start of string * The address of the "string descriptor block" for the string variable can be found in BASIC by typing:|}
#**The address of the "string descriptor block" for the string variable can be found in BASIC by typing: <pre>PRINT @a$</pre>
replacing "a$" with the name of the string variable.
#** A string uses a minimum of 3 bytes of storage (a 0 character length string) and a maximum of 258 bytes of storage. 3 bytes are used by the "string descriptor block")#** A string variable can contain any ASCII character code in the range 0-255.#** A string variable can store a minimum of 0 characters and a maximum of 255 characters.#** The length of the string in characters is defined in the string descriptor block. The string does not have a termination character.