- added optional second argument for `DUP` to have index variable
- option `--exp` will create file even when no `EXPORT` is used
- fixing variable name-clash when compiling against musl-clib
- LuaBridge updated, CMake and Makefile updated a bit
- minor bugfixes/improvements in parser in specific edge cases

- parse decimal numeric constants with warning (for easier Lua 5.4 life)
- added `SAVEAMSDOS` (like SAVEBIN with AMSDOS header)
- added "smart" SMC offset syntax for self-modify-code labels: `abc+*: or 123`
- added `DEFDEVICE` to define custom devices
- Makefile cleanup

- Lua: upgrade to 5.4, replacing tolua++ bindings with LuaBridge2.6 library, extending some bindings
- Lua: bindings slightly modified (required by upgrade), refreshed docs, added test coverage
- Lua: the 3rd party extensions (BTW not working for many years) are obsolete in 5.4 and removed
- Lua: more accurate errors/warning location reported even in complex cases
- warnings: added -Wall, --help=warnings shows on/off status, rdlow off by default
- Added HIGH mode to relocation data generator (MSB-only relocation mode)
- many open-file "fatal" errors become "non-fatal", assembling will continue
- deprecated features removed: --syntax=m, label `abs` in expressions
- `--color=auto` will stay no-color when env.var. `NO_COLOR` is defined
- refactorings, improving some error messages and parsing, small fixes in parsing logic
- fix listing of Lua's sj.parse_code (eol-comments), minor memory leaks fixed
- fix relocation of temporary labels in expressions
- invalid CLI options are reported as regular errors (also changing exit code)
- errors are colored similarly to gcc (only keyword has color), console input name is `<stdin>`

- added Amstrad CPC devices ("AMSTRADCPC464", "AMSTRADCPC6128") - by Oli Wilkinson
- added Amstrad CPC save snapshot and CDT (`SAVECPCSNA`, `SAVECDT`) - by Oli Wilkinson
- added `SAVE3DOS` (like SAVEBIN with +3DOS header)
- the deprecated "ok" warning suppression is removed, use "<warning-id>-ok" comment or -Wno-...
- new temporary label suffix syntax "_b" and "_f", enabling them for all expressions
- fix `--longptr` mode to keep 32b address when `DS 0` is used
- added fake instructions adc|add|sbc|sub de,bc|de|hl|sp
- dec|inc|pop|push will accept also single-comma multiarg in --syntax=a mode
- DUP/REPT will now accept also zero count (skipping the block)
- DEFL labels can be defined even as late as in last pass
- bugfixes (macros, listing, file names in errors, SLD reversepop data)

- added `--color` to enable/disable ANSI coloring of errors/warnings
- added `--syntax=s` mode to disable sub-word substitutions of DEFINEs
- added at-sign prefix for macro local labels to act as non-macro local label
- `SAVETRD` accepts names containing dot ("z.x.B" is "z.x" with extension "B") - by Dart Alver
- `SAVETRD` has optional argument to save BASIC with variables (length_minus_variables)
- minor bugfixes (conditional block parser)

- [may break old sources] new exist operator to check label existence
- the --syntax=i mode makes now also register parsing case insensitive
- minor bugfixes (predefined values, savenex BMP loader less strict about "colors used" content)

- Big-Endian hosts support (experimental and not tested continuously)
- added "listall", "listact" commands to OPT - to switch between listing types
- `WHILE` has optional argument to set explicit guardian-counter
- `ASSERT` has optional argument (to add description/notes for expression)
- `SLOT` and `MMU` will now accept also starting address of slot instead of its number
- fix: option --sym was not exporting labels starting with underscore
- fix: SAVENEX BMP-loader bug when certain builds of sjasmplus were unable to open BMP files
- fix: after STRUCT instance the "main" label is not polluted by last field of STRUCT
- minor bugfixes in parser, windows cmake-builds have now icon
- docs: adding "Index" section
- docs: adding some missing information (__DATE__, __TIME__), fixing HTML anchor names

- [may break old sources] the colon between end of EQU/DEFL/= expression and instruction is mandatory
- [may break old sources] new abs operator for absolute integer value
- new system of warnings (and suppression), the "; ok" comments are now deprecated
- `DISPLAY` has now also binary and char formatting
- `DEFINE+` added to [re]define identifier without error
- `ELSEIF` added to conditional assembling arsenal
- `WHILE` added for conditional loops
- added "NOSLOT64K" device with 2MiB of virtual memory
- `LABELSLIST` has new optional argument to dump 16bit "virtual labels"
- `CSPECTMAP` exports STRUCT symbols with more detail (instance labels with physical address)
- SMC offset syntax for self-modify-code labels for source brevity
- added exclamation mark prefix for labels to not affect following local labels
- added "listmc" command to OPT - to list only lines with machine code bytes
- added `--lstlab=sort` variant to have symbols in listings in predictable order
- minor bugfixes in parser and listing-line-numbering, refactored symbols/labels implementation
- Added example (chargfx2asm) how to use sjasmplus as byte-processor for binary files
- SLD data improvements based on Maziac's feedback and DeZog's needs

- `STRUCT` has new `TEXT` pseudo-instruction to define "DB-like" data (Issue #93)
- `STRUCT` initializer block can be now multi-line (when correctly enclosed in curly braces)
- `EQU` now allows for optional override of page number assigned to the new symbol
- new $$$ and $$$$ operators to retrieve "physical" address/page inside DISP block
- instruction `out (c),0` now emits warning (can be suppressed by the "; ok" comment)
- fixed listing of structures using long BLOCK fields (machine code was correct, but listing not)
- fixed some memory leaks, undefined behaviour and unaligned memory access

- `LUA` the new emit warning (v1.15.1) is now suppressible
- Predefined defines extended and renamed (following gcc/clang ones)
- Added relocation data generator (similar to WinAPE feature), check also example
- bugfixes/improvements in parser like: operators `not`, `low`, `high` can be followed also by "("

Disable real device emulation mode. By default.

Has 4 slots (0-3) with size 4000h, 4 pages (0-3) with size 4000h. Slot 3 (it from 0C000h) enables to current by default.

Has 8 RAM pages (0-7) with size 4000h. Default slot is 3.

Same as Russian clone Scorption 256. Has 16 RAM pages (0-15) with size 4000h.

Same as Russian clones ATM Turbo 512 and Pentagon 512. Has 32 RAM pages (0-31) with size 4000h.

Same as Russian clones ATM Turbo 2 and Pentagon 1024 SL. Has 64 RAM pages (0-63) with size 4000h.

Similar to other spectrum devices, has 128 RAM pages (0-127) with size 4000h.

Similar to other spectrum devices, has 256 RAM pages (0-255) with size 4000h.

Similar to other spectrum devices, has 512 RAM pages (0-511) with size 4000h.

ZX Spectrum Next, has 8 slots (0-7) of size 0x2000 and 224 RAM pages (0-223) totalling at 1.75MiB of memory. The default mapping is similar to ZX128, paging in: {14, 15, 10, 11, 4, 5, 0, 1} pages. Default slot is 7 (memory range 0xE000..0xFFFF). All memory is zeroed during initialization.

Has only single slot of size 64kiB (slot 0), covering full Z80 CPU addressing range. There are 32 memory pages available, by default page 0 is mapped. That makes in total 2MiB of memory available (32 * 64 ki = 2 Mi).

Has 4 slots (0-3) of size 0x4000 and 4 pages (0-3) of 0x4000, totalling 64K. These pages are mapped linearly as { 0, 1, 2, 3 }.

Has 4 slots (0-3) of size 0x4000 and 8 RAM pages (0-7) of 0x4000 (128K total). The default page mapping is { 0, 1, 2, 3 }.

Current version split into three 8bit values, ie. 0x010F02 for "1.15.2".

String value (with quotes around it) of current version like "1.15.2".

Number of errors.

Number of warnings.

Date of assembling (timestamp before first pass).

Time of assembling (timestamp before first pass, 24h form).

Current assembling pass (1, 2 or 3).

Current include-nesting level.

Name of base file (include-level zero).

This is raw value without quotes, practically unusable by asm source, but LUA provides means to operate with such string value.

Name of current file.

This is raw value without quotes, practically unusable by asm source, but LUA provides means to operate with such string value.

Current line number.

Does increment upon each usage (starting as value 0). Currently difficult to use for labels/symbols, because the starting `_` of the define name prevents mid-word substitution, will make more sense with new substitution rules (if ever the sjasmplus v2.x happens, would be too big change for v1.x). Right now call LUA for the rescue.

    DB __COUNTER__   ; DB 0
    LUA ALLPASS
        sj.insert_label("label_" .. sj.get_define("__COUNTER__"), sj.current_address)
                -- creates "label_1" at "$" (0x0001)
        sj.insert_label("label_" .. sj.get_define("__COUNTER__"), _c("$+10"))
                -- creates "label_2" at "$+10" (0x000B)
    ENDLUA
label__COUNTER__: ; does *NOT* substitute in current sjasmplus, sorry
    DB __COUNTER__   ; DB 3

    ; also macro arguments substitution can be used
    MACRO createLabelWithSuffix label?, suffix?
label?_suffix? ; define global label
    ENDM
    createLabelWithSuffix label, __COUNTER__    ; label_4
    createLabelWithSuffix label, __COUNTER__    ; label_5

The predefined values were renamed and extended to be more like gcc/clang pre-defines, the following ones are deprecated originals.

Deprecated, consider using similar __SJASMPLUS__

   IFDEF _SJASMPLUS
     ;code for sjasmplus
   ELSE
     ;code for other compiler
   ENDIF

Deprecated, renamed to __VERSION__

   IF _VERSION = "1.07"
     ;code for 1.07
   ELSE
     ;code for other version
   ENDIF

Deprecated, consider using similar __SJASMPLUS__

   IF _RELEASE = 1 ; 0 - is stable version
     ;code for Release Candidate 1
   ELSE
     ;code for other version
   ENDIF

Number of errors. Deprecated, renamed to __ERRORS__

Number of warnings. Deprecated, renamed to __WARNINGS__

Repeat <single instruction> <repeat-count> many times. Doesn't work in the beginning of line. The <repeat-count> must be either simple integer number or expression fully enclosed in parentheses.

    .3          INC A    ;will be compiled to INC A:INC A:INC A
len             EQU 10
    .(12-len)   BYTE 0   ;will be compiled to BYTE 0,0
    .2 .3       RET      ;will be compiled to 6x RET

Defines a byte or a string of bytes. The offset is added to each of the following bytes.

    ABYTE 2 4,9    ; Same as BYTE 6,11
    ABYTE 3 "ABC"  ; Same as BYTE "DEF"

Defines a byte or a string of bytes, where the last byte of the string will have bit 7 set. The offset is added to each of the following bytes.

    ABYTEC 0 "KIP"        ; Same as BYTE "KI",'P'|128
    ABYTEC 1 "ABC",0,"DE" ; Same as BYTE "BC",'D'|128,1,'E','F'|128

Defines a byte or a string of bytes, followed by a zero. The offset is added to each of the following bytes.

    ABYTEZ 0 "KIP"        ; Same as BYTE "KIP",0

Align advances to nearest address where <new address> modulo <expression> (default 4) equals zero (stays at current address if possible).

If <byte> is specified, memory advanced over is set to it.

    ALIGN         ; => ALIGN 4 - simply align by 4
    ALIGN 2       ; by 2 (preserves value of "device" memory)
    ALIGN 2,0     ; + fills memory with zero

An 'assertion failed' error is issued if the expression evaluates to zero. The "anything" (optional argument since v1.18.1) is then also visible in the error message, so you can add description/notes about expression there.

STACKPOINTER=0D500H
    ASSERT END_OF_PROGRAM < STACKPOINTER, Program code leaks into stack area
END_OF_PROGRAM

Synonym of INCBIN.

Defines space. Has to be followed by the number of byte to reserve, optionally followed by the value to fill these bytes with.

    BLOCK 500     ; define a block of 500 bytes of zero
    BLOCK 500,0   ; define a block of 500 bytes of zero
    BLOCK 400,-1  ; define a block of 400 bytes of 255

Works only in real device emulation mode. See DEVICE.

Opens file to export breakpoints info directly from ASM source, currently two flavours of export are supported: unreal (default) and zesarux. For latest Unreal emulators use filename "bpx.ini", you can then load the file from the emulator UI. For ZEsarUX the file will contain command-line options, which you can add to the command when launching the emulator.

(current version of ZEsarUX will not catch the very first instruction of freshly loaded snapshot/NEX/... file, or it will even disable breakpoints when changing machine parameters and ignore the --enable-breakpoints option - will be hopefully improved in the future)

    BPLIST "bpx.ini" unreal  ; open breakpoints list in "Unreal" format
    ; or (only one file per assembling-unit can be specified)
    BPLIST "cmd_line_options.txt" zesarux ; open breakpoints list in "ZEsarUX" format

Defines a byte or a string of bytes. Each value should be between -129 and 256.

    BYTE 0x56
    BYTE 1,-78,'@'
    BYTE "Format C:? ",0h

Useful for ZX-Spectrum Emulator #CSpect by Mike Dailly.

Works only in real device emulation mode. See DEVICE.

Saves labels list in format:

HEXA_16BIT_ADDRESS HEXA_LONG_ADDRESS TYPE LABELNAME

where TYPE is: 00 = regular label, 01 = EQU or struct defined, 02 = DEFL defined, 03 = ROM page/"none" device, 04 = STRUCT definition.

If no filename is provided, default is created by appending ".map" to source name.

Defines three bytes by 24b constant. Values should be between -16777217 and 16777216.

    D24 0x123456   ; define three bytes 0x56, 0x34, 0x12

Synonym of BYTE.

Same as BYTE, but every last character of a string will have bit 7 set.

    DC "kip" ; same as BYTE "ki",'p'|128

Synonym of DWORD.

Array of DEFINEs.

Use id[#] to retrieve current size of array.

    DEFARRAY myarray 10*20,"A",20,</D,40>,50,70
CNT DEFL 0 ;or CNT=0
    DUP myarray[#]      ; 6
    DISPLAY myarray[CNT]
CNT DEFL CNT+1 ;or CNT=CNT+1
    EDUP

Appending more DEFINEs to already defined array

    DEFARRAY   myarray 'A', 'B', 'C'
    DEFARRAY+  myarray 'D', 'E'            ; now "myarray" has 5 items
    DUP 3 : DEFARRAY+ myarray '!' : EDUP   ; "DEFARRAYFILL" adding 3x '!'

Synonym of BYTE.

Synonym of DWORD.

(since v1.20.1) Add custom device definition. The 64ki Z80 address space is divided evenly by slot_size to form N slots and the total device memory is slot_size * page_count bytes.

The initial pages are implicitly going from 0 to page_count-1 (repeating page page_count-1 for remaining slots when there's not enough pages), but you can specify initial page layout explicitly.

Use DEVICE to select the newly defined device.

Synonym of DG.

Synonym of DH.

The identifier <id> will be replaced with the <replacement>. The DEFINE+ (since v1.18.0) will also redefine the identifier <id> if it already exists. The replacement could be omitted, in such case it is still possible to check if the identifier was defined with IFDEF or IFNDEF.

    DEFINE str_honderd "Honderd"
    BYTE str_honderd,0             ; BYTE "Honderd",0
    DEFINE+ do_stuff set 4,e
    do_stuff                       ; set 4,e
    DEFINE+ do_stuff set 2,e
    do_stuff                       ; set 2,e

Assigns value of <expression> to symbol <label>. New label defined by DEFL is marked internally as "modifiable", allowing to re-assign new values to it with further DEFL statements (you can use also = instead of DEFL).

counter DEFL 0
    DUP 4
        DB 0xAA, counter
counter = counter + 1
    EDUP
; machine code produced: AA 00 AA 01 AA 02 AA 03

Synonym of BYTE.

Synonym of BLOCK.

Synonym of WORD.

Synonym of ENT.

Enables real device emulation mode by it identifier. If there is only single DEVICE directive in whole source batch, it becomes "global" and the device affects all lines of source, otherwise the DEVICE is applied for lines following it.

For ZXSPECTRUM-like devices (except ZX Next) you can provide RAMTOP value, which will init the device memory in similar way as "CLEAR <RAMTOP>" in BASIC would do, putting top of the fake-stack at the RAMTOP address. The default RAMTOP is since v1.15.0 0x5D5B (it was 0xFF57 before).

Predefined devices' identifiers list:

 NONE ; off real device emulation mode
 ZXSPECTRUM48   ; ZX-Spectrum 48 (4 slots, 4 pages, slot/page size 0x4000, default map: 0, 1, 2, 3)
 ZXSPECTRUM128  ; ZX-Spectrum 128 (like 48 with 8 pages, default map: 7, 5, 2, 0)
 ZXSPECTRUM256  ; e.g. Scorpion 256 (exUSSR clone of ZX-Spectrum 128)
 ZXSPECTRUM512  ; e.g. ATM-Turbo 512 (another clone)
 ZXSPECTRUM1024
 ZXSPECTRUM2048
 ZXSPECTRUM4096
 ZXSPECTRUM8192
 ZXSPECTRUMNEXT ; ZX Spectrum Next (8 slots, 224 pages, slot size 0x2000 = 1.75MiB RAM)
                ; (default pages map: 14, 15, 10, 11, 4, 5, 0, 1) (default slot: 7 (0xE000..0xFFFF))
 NOSLOT64K      ; Single slot (slot 0) covering full 64kiB address range of Z80, 32 pages
 AMSTRADCPC464  ; Amstrad CPC 464 (4 slots, 4 pages, slot/page size 0x4000, default map: 0, 1, 2, 3)
 AMSTRADCPC6128 ; Amstrad CPC 6128 (like 464 with 8 pages)

 ;disable:
   DEVICE NONE
 ;enable:
   DEVICE ZXSPECTRUM128

Data comprises of characters in multiples of eight, each block is converted to a byte value.

A hyphen '-' (also '.' and '_') represents 0 and any other non-whitespace character represents 1. It ignores spaces, use them for formatting if you like. Warning, "DG 10100001" is value 255, because character '0' is not a dash '-'. (since v1.11)

    DG 1-1----1  ; store 161 at the current location
    DG ...# #... .##. .... ; store two bytes: 0x18, 0x60

The data string comprises pairs of hexadecimal digits, each pair is converted to a byte value. You can add spaces between pairs as you like. (since v1.11)

    DH "0123456789ABCDEF"   ; eight bytes #01 #23 ...
    DH "01 23  45 67"       ; four bytes #01 #23 #45 #67

Set the address in which the part of code should work. PHASE and TEXTAREA are synonyms of DISP. ENT will restore current address. UNPHASE, DEPHASE and ENDT are synonyms of ENT. DISP blocks can NOT be nested, and to change the displacement address within current DISP block use the ordinary ORG. When in device mode, you can specify fixed value for "fake" page of emitted instructions and regular labels, but to avoid warning, you must also map-in the target page into the target memory slot (MMU). When no fixed page in DISP is specified, the current mapping of memory pages is used.

    DEVICE ZXSPECTRUM48
SCREEN  EQU $4000
        ORG $8000
        LD HL,BEGIN
        LD DE,SCREEN
        LD BC,ENDOFPROG-BEGIN
        LDIR
        JP SCREEN
BEGIN   DISP SCREEN ;code will compile for address $4000, but to the current ORG
MARKA       DEC A
            HALT
            JP NZ,MARKA
            DI
            HALT
        ENT
ENDOFPROG

    ASSERT $800E == BEGIN && $8015 == ENDOFPROG && $4000 == MARKA
    ASSERT $76 == {B $800F}     ; HALT instruction lands at $800F (BEGIN+1)

This pseudo-op comes from ZX-Spectrum assembler ALASM.

Out to console a string of bytes. Each value should be between -129 and 256. Keys /D, /B, /C, /H and /A set format of output of numbers:

/D - out only in Decimal
/B - out only in Binary (truncated to 8 bit)
/C - out as character in apostrophes (truncated to 8 bit)
/H - out only in Hexadecimal
/A - out both in Hexadecimal and Decimal

    ORG 100h
TESTLABEL:
    ;...some code...
    RET
    DISPLAY "--the some program-- by me"
    DISPLAY "TESTLABEL address is:",/A,TESTLABEL
/*
will output to the console strings:
> --the some program-- by me
> TESTLABEL address is:0x100, 256
*/

Synonym of BYTE.

Synonym of BLOCK.

DUP specifies the number of times to generate the following lines until an EDUP pseudo-op is encountered. DUP can be used in macro's.

Optional second argument (since v1.20.2) is label name to have repetition index available inside the block (values 0, 1, 2, 3, ...).

    DUP 3 ; zero count would skip whole block
    NOP
    EDUP

/*this will expand to:
    NOP
    NOP
    NOP
*/

Synonym of WORD.

Defines a so called doubleword. Values should be between -2147483649 and 4294967296.

    DWORD 4000h,0d000h
    DWORD 4

Same as BYTE, but an extra zero will be added at the end.

    DZ 1      ; same as BYTE 1,0
    DZ "kip"  ; same as BYTE "kip",0

Useful only for ZX-Spectrum users

Create the new or truncate existing standard tape file for emulators of ZX-Spectrum. See example of SAVETAP.

Useful only for ZX-Spectrum users

Create the empty TRD image for emulators of ZX-Spectrum. See example of SAVETRD.

Useful only for non English users

Set the current encoding, i.e. if you set "DOS", SjASMPlus will automatically convert strings from ANSI to DOS-866. Encoding may be "DOS"(DOS-866) or "WIN"(ANSI/Win-1251). Default is "WIN".

    ENCODING "WIN"
    DB "тексттекст" ;will be тексттекст
    ENCODING "DOS"
    DB "тексттекст" ;will be ⥪бв⥪бв

The assembler will stop at this point. The pseudo-op END does NOT work in the beginning of line (even with --dirbol). The optional argument is used by SAVESNA, SAVECPCSNA, SAVETAP and SAVENEX.

See LUA for more information.

Synonym of ENDMODULE.

To indicate the end of a module (see MODULE).

Synonym of ENT.

Restore current address. See DISP for more information.

To give the label a value other than the current program counter. The label should not already exist (you can assign only one value to it). The optional pageNumber can enforce explicit page value for the label (for the $$label operator). For modifiable labels holding temporary values use DEFL.

Label EQU 3
Kip   EQU 0x23*256 + low $

The named label will be written to the export-file, in the form 'label: EQU value'. This way the export-file can be included in other sources. Order of labels in file follows the order of EXPORT statements.

DRIE=3
    EXPORT DRIE  ; adds into export file line: "DRIE: EQU 0x00000003"

The FPOS directive makes it possible to set the file position to anywhere in the output file. Position value without sign is used as absolute one to be set, position starting with + or - sign will be used as relative position.

In combination with OUTPUT <filename>,r it is possible to update existing files.

; This example will result in a file with a length of one byte:
    BYTE 0
    FPOS 0
    BYTE 1
    END

Synonym of DH, usually used without quotes around data.

To include a binary file into the outputfile. The offset and length are optional. Added in v1.12.1: if negative offset or length is provided, it counts relatively from the end of the file.

    INCBIN "gfx.scc",7        ; include gfx.scc, skip first 7 bytes
    INCBIN "rantab.com",3,256 ; include 256 bytes from offset 3
    INCBIN gfx.scc ,,7        ; 7 bytes from offset 0 (unquoted filename must end with space)
    INCBIN "48.rom",-768,-256 ; include (from 16kiB file) 512 bytes 15616..16127

To include a data from a hobeta file into the outputfile. The offset and length are optional.

    INCHOB "gfx.$c",7        ; include gfx.scc, skip first 7 bytes
    INCHOB "sprs.$c",3,256   ; include 256 bytes from offset 3
    INCHOB gfx.$c ,7        ; note the space between the filename and the ',7' here :)

To include another sourcefile into the current. Sourcefiles can be nested 20 levels deep. If the file cannot be found in the current directory (the current directory is the directory the current asm file comes from!) the file will be searched for in the directories specified at the commandline. When angle brackets are used, the commandline directories are searched before the current directory.

The directory used to launch the assembling process is automatically added to the list (as if "-i." was added to command line manually) (v1.14.0 and v1.14.1 don't add it, reverted back for v1.14.2). If you want to start with completely empty include-path list, use "--inc" option early (order matters) without the "=" to empty the current list, like: sjasmplus --inc --inc=path1 --inc=path2 file.asm

    INCLUDE <VDP.I>     ; search for file "VDP.I" in the include directories, then in current
    INCLUDE MORE.I      ; search for "MORE.I" in current directory, then in include directories
    INCLUDE "MORE.I"

To include another LUA script in first pass(!). If the file cannot be found in the current directory (the current directory is the directory the current file comes from) the file will be searched for in the directories specified at the commandline. When angle brackets are used, the commandline directories are searched before the current directory.

    INCLUDELUA <mylibrary1.lua>
    INCLUDELUA mylibrary2.lua
    INCLUDELUA "library_for_zx.lua"

To include a file from a TRD image into the outputfile. The offset and length are optional.

    INCTRD "test.trd","mygfx.C" ; include mygfx.C from test.trd
    INCTRD "test.trd","mygfx.C",12 ; include mygfx.C from test.trd, skip first 12 bytes

INSERT is a synonym of INCBIN. See above.

Useful only for ZX-Spectrum Emulator UNREALSPECCY.

Works only in real device emulation mode. See DEVICE.

Save labels list in format:

NN:ADDRESS LABELNAME

where NN is number of RAM page and ADDRESS is truncated to 0000..3FFF range

If <virtual labels> is non zero, then the page number NN is not part of output, and ADDRESS is truncated to 0000..FFFF range.

    LABELSLIST "x:/somepath/user.l"

Using pseudo-ops LUA and ENDLUA you can insert Lua scripts. See more in the chapter "Lua scripting".

Parameter is optional. It may be:

PASS1   -  interpret Lua script in first pass only.
PASS2   -  interpret Lua script in second pass only.
PASS3   -  interpret Lua script in third pass only. By default.
ALLPASS -  interpret Lua script in all passes. It is needed if you generate some Z80 code.

    LUA
-- some comments
        print "Hi, man! This is Lua!"
    ENDLUA
; some code now:
    LUA ALLPASS
        _pl("LABEL LD A,10")
        _pc("RET")
    ENDLUA

Not available yet.

Maps memory page(s) to slot(s), similar to SLOT + PAGE combination, but allows to set up whole range of consecutive slots (with consecutive memory pages). Or when only single slot is specified, extra option can be used to extend particular slot functionality. The slot behaviour will stay set in the current DEVICE until reset by another MMU specifying same slot (even as part of range, that will clear the option to "default").

The optional third argument is address for ORG functionality.

(since v1.18.1) You can also use starting address of particular slot instead of its number, ie. for ZX128: MMU $8000,3 is alias of MMU 2,3

Single slot option (default state is: no error/warning and no wrap = nothing special):

e = error on writing beyond last byte of slot
w = warning on writing beyond last byte of slot
n = wrap address back to start of slot, map next page

    DEVICE ZXSPECTRUM128 : LABELSLIST "po_mmu.lbl"  ; to check label pages
    MMU 1 3, 5      ; maps slots 1, 2, 3 with pages 5, 6, 7
    ORG 0xBFFF
label1_p6: scf      ; last byte of page 6 (in slot 2)
label2_p7: scf      ; first byte of page 7 (in slot 3)

    MMU 3 e, 0      ; page 0 into slot 3, write beyond slot will cause error
    ORG 0xFFFF
    ld  a,1         ; error: Write outside of memory slot: 65536 (65536 = address outside)

    MMU 3 n, 1      ; page 1 into slot 3, make it wrap + map next page automatically
    ORG 0xFFFF      ; ! also the $ address was truncated by MMU from $10001 to $0001 !
label3_p1: scf      ; last byte of page 1, then wrapping back to 0xC000 with page 2
label4_p2: scf      ; first byte of page 2 at 0xC000

Labels has to be unique only whithin the current module (module is added as prefix to them). Also note the use of '@' operator to suppress all this label-processing. Modules can be nested, and module has to be ended by ENDMODULE.

    MODULE xxx
Kip:                ; label xxx.Kip
    ld  hl,@Kip     ; global Kip
    ld  hl,@Kop     ; global Kop
    ld  hl,Kop      ; xxx.Kop
Kop:                ; label xxx.Kop
    ld  hl,Kip      ; xxx.Kip
    ld  hl,yyy.Kip  ; yyy.Kip
    ld  hl,nested.Kip   ; xxx.nested.Kip
        MODULE nested
Kip:        ret     ; label xxx.nested.Kip
        ENDMODULE
    ENDMODULE

    MODULE yyy
Kip:    ret         ; label yyy.Kip
@Kop:   ret         ; label Kop (global one, no module prefix)
@xxx.Kop: nop       ; ERROR: duplicate: label xxx.Kop
    ENDMODULE

Kip     ret         ; global label Kip

Since v1.14.0 the module <name> can NOT contain dot character. You can use nested modules to get identical identifier as in older versions, or please rename with underscores/etc:

    ; invalid since v1.14.0
        MODULE older.version
fn1:        ret        ; final label: @older.version.fn1
        ENDMODULE
    ; can be replaced in v1.14.0 with
        MODULE new
            MODULE version
fn1:            ret    ; final label: @new.version.fn1
            ENDMODULE
        ENDMODULE

Since v1.14.0 the MODULE and ENDMODULE also resets the current "non-local" label prefix back to "_":

Kep:    ; "Kep" label (global one), and also works as "non-local" prefix for local labels
    MODULE zzz
.local: ; in v1.14.0 this will be "zzz._.local" label, previously it was "zzz.Kep.local"
Kup:    ; this is "zzz.Kup", but also defines "non-local" prefix as "Kup"
.local  ; this is "zzz.Kup.local"
    ENDMODULE
.local: ; in v1.14.0 this will be "_.local" label, previously it was "Kup.local"

Allows to reset and modify options affecting syntax and parsing (for lines of source following the OPT). The options allowed for OPT are: -W[no-]<warning_id>, --syntax, --zxnext, --reversepop and --dirbol.

Ahead of options you can use OPT commands: push, pop, reset, listoff, liston, listall, listact, listmc. The "push" command will make OPT to preserve current state of options. The "reset" command will reset OPT-related options to default state. The "listoff" command will suspend the listing for following lines until "liston" command is used (listing availability is part of the push/pop state, so to "nest" listing-off you can use "OPT push listoff : ... code ... : OPT pop" code sequence). The "listall", "listact" and "listmc" commands will select the filter for listing. The "listmc" lists only lines containing machine code bytes, "listact" will remove the "skipped" blocks (like false-blocks of IF/ELSE conditional assembling, or inner definitions of macros and structures), "listall" will switch back to default listing without filtering.

Then the provided options are applied. The default values are: fake instructions enabled (no warning), multi-argument delimiter is ",", both () and [] brackets can be used to access memory, labels can have any name, ZX Next instructions are OFF, POP with multiple arguments doesn't reverse them and pseudo-ops at beginning of line are OFF (to just reset to these defaults you can use OPT reset).

The "pop" command: the previously preserved state of options is restored (states are preserved in "stack" way, so further OPT with "pop" will restore older states).

The id-warning system state is NOT saved/restored by OPT push/pop/reset and can be modified only by -W option.

    POP bc, hl   ; pops BC first
    OPT push reset --reversepop --syntax=af
    POP bc,,hl   ; pops HL first
    LD  bc,hl    ; warning about Fake instruction
    LD  bc,hl    ; warning supressed by lowercase "fake" in this comment
    OPT reset --syntax=a
    POP bc,,hl   ; pop BC first (--reversepop was reset)
    OPT pop      ; restoring syntax to original state

Set the program counter to a specific address. If the second argument is provided, it will change memory page in the current slot, see PAGE and SLOT (it will warn you when <address> is outside of it).

When used inside DISP block, only the virtual "displaced" program counter is affected, but the machine code will be still sequentially emitted in the original physical location and warning is emitted.

    ORG 100h ; or 0x100, or $100, or #100

    ; useful macro that padding code
    MACRO PADORG addr
         ; add padding
         IF $ < addr
         BLOCK addr-$
         ENDIF
         ORG addr
    ENDM

    MACRO PADORG2 addr ; z80asm "FORG" replacement
         ; add padding + display warning
         IF $ > addr
           ; no padding
           DISPLAY /L, "Warning! PADORG failed! ", $, " is more than ", addr
         ELSE
           ; add padding
           BLOCK addr-$
         ENDIF
         ORG addr
    ENDM

Ends generating compiler output to file specified in OUTPUT and resets SIZE value to default "none".

With OUTPUT it is possible to create multiple files from one source. All following instructions will be assembled to this file. It will also close (OUTEND) and finalize any previously opened output.

There are three possible output modes: truncate (overwrite existing files, this is the default), rewind (open and execute FPOS 0) and append (open and leave the file pointer at the end of the file).

OUTPUT <filename>,t  ; truncate (default)
OUTPUT <filename>,r  ; rewind
OUTPUT <filename>,a  ; append

    OUTPUT loader.com
    ORG 100H
    INCLUDE loader.asm
    INCLUDE bios.asm

    OUTPUT bigfile.dat
    ORG 4000H
    INCLUDE main.asm
    ORG 8000H
    INCLUDE data.asm
    OUTEND
    INCLUDE next.asm

This will create two files: loader.com and bigfile.dat.

Works only in real device emulation mode. See DEVICE.

Set the current memory page to current slot.

    PAGE 7 ;set 7 page
    SAVEBIN "ram7.bin",$C000,$4000 ;- save $4000 begin from $C000 of RAM to file

Synonym of DISP.

Ends the block of code for which relocation data are produced (started by RELOCATE_START). To get the relocation data themselves, use RELOCATE_TABLE and related symbols.

For more details/examples check the examples/relocation, examples/SymbOS_nslookup and the relocation tests.

Marks start of block for which relocation data are produced. Any *regular* label (not EQU/DEFL symbols) defined inside the RELOCATE_START .. RELOCATE_END block will be treated as "relocatable" label. Any instruction/directive within the block which needs resulting opcode adjusted when relocated to different address will produce relocation-data for the RELOCATE_TABLE.

The RELOCATE_START HIGH variant checks only high-byte relocation. The produced table points to high byte (MSB) of the machine code. This mode is for OS/loaders which relocate only to 256-byte aligned boundaries (keeping LSB intact).

The relocation feature of regular label is transitive and EQU value based on already relocatable label will be tagged as relocatable too. Also structures instantiated in relocatable block have their labels tagged as relocatable and their initial values may become part of relocation data if the initial value is based on relocatable value.

You can prepend operator norel to label to strip it of its relocatable property for particular expression.

The internal heuristic is not bullet-proof, some complex expression may fail to be recognised as fixed/relocatable value and instead warn about unstable result. It is recommended to assemble relocatable blocks in lower regions of address space (like ORG 0 or ORG $1000) and to keep expressions simple enough.

Emits relocation data gathered across all relocation blocks. There are also two built-in symbols relocate_count and relocate_size containing the size of the table (only word-type tables are supported in sjasmplus, so size is always doubled count).

The table is raw array of WORD (16 bit) values with memory offsets of machine code which should be adjusted (when the code is relocated to different than original base address). To get offsets from particular base address, use ORG ahead of relocation block to land instructions and labels from there.

The <subtract_offset> is subtracted from every offset recorded in the relocation table (same what WinAPE does with its optional argument "base_address" for RELOCATE_TABLE).

Synonym of DUP. There is also synonym ENDR to end REPT block (EDUP works too).

Works only in virtual device emulation mode. See DEVICE.

Like SAVEBIN, saves the block of device RAM from "address", but with +3DOS 128 byte header prepended.

    DEVICE ZXSPECTRUM48
    ...

    ; +3 BASIC header (8 bytes starting from offset 15 in +3DOS header):
    ; type is first byte (0 = basic, 1, 2 = arrays, 3 = code/screen$)
    ; size is "first word" (bytes 1 and 2)
    ; w2_line argument is "second word" (bytes 3 and 4)
    ; w3 argument is "third word" (bytes 5 and 6) (default value = size)

    ; by default the type=3 (CODE/SCREEN$) is saved
    SAVE3DOS "screen.bin", $4000, $1b00
    ; type 3: w2 argument $C000 is target load-address
    SAVE3DOS "code.bin", $8000, $1234, 3, $C000
    ; type 0: BASIC, default w2 = $8000 (no auto-run)
    SAVE3DOS "prg1.bas", $5c00, 1234, 0
    ; type 0: w2_line is LINE auto-run (30 in example)
    SAVE3DOS "prg2.bas", $5c00, 1234, 0, 30
    ; type 1: Numeric array (refer to +3 manual for these)
    SAVE3DOS "b.dat", $8000, 30, 1
    ; type 2: Character array (or maybe just ignore these)
    SAVE3DOS "c.dat", $8000, 30, 2

Works only in virtual device emulation mode. See DEVICE.

Like SAVEBIN, saves the block of device RAM from "address", but with AMSDOS 128 byte header prepended.

    DEVICE AMSTRADCPC464
    ... some code ...

    ; by default the type=2 (BINARY) is saved
    ; "start" (entry) value is by default 0, overriden here to $1234
    SAVEAMSDOS "code.bin", $1000, $1b00, $1234

Works only in real device emulation mode. See DEVICE.

Save the block of RAM.

    PAGE 7 ;set 7 page to current slot
    SAVEBIN "ram7.bin",$C000,$4000 ;- save 4000h begin from C000h of RAM to file
    SAVEBIN "ram2.bin",$8000,$3000 ;- save 3000h begin from 8000h of RAM to file

Works only in Amstrad device emulation mode. See DEVICE.

Manipulate CDT file (tape/TZX file format used by Amstrad CPC emulators).

    DEVICE AMSTRADCPC6128
    ...
    ; create empty CDT file (truncates already existing file to make it empty)
    SAVECDT EMPTY "output.cdt"

    ; snapshot-like dump with default loader, including loading screen, all banks, ...
    SAVECDT FULL "output.cdt" ; defaults: END start addres, screenmode=1, border=1
                              ; ink# = 1, 24, 20, 6, 26, 0, 2, 8, 10, 12, 14, 16, 18, 22, 24, 16

    ; BASIC program prepared at address "label"
    SAVECDT BASIC "output.cdt","A",label,length

    ; block of binary data at address "label" (default "entry" = "label")
    SAVECDT CODE "output.cdt","C",label,length,entry

    ; headless block with custom sync and format at address "label", formats: 0 = AMSTRAD, 1 = ZX
    SAVECDT HEADLESS "output.cdt",label,length,sync,format ; default sync = 0x16, format = 0

Works only in AMSTRADCPC464 / AMSTRADCPC6128 real device emulation mode. See DEVICE.

Save the snapshot for emulators of Amstrad CPC machines. (If start address is omitted, the one provided by END is used)

The snapshot header content is hard-wired in the sjasmplus binary, with the CRTC, Palette and Gate Array registers set to those of a CPC after a boot into the main ROM. Similarly to the ZX-Spectrum SAVESNA directive, interrupts are disabled and must be re-enabled by your program. A full list of the settings can be found in the source. If you absolutely need different defaults and can't afford init-code modifying the state, you can post-patch the resulting SNA file directly from source, see Issue #139 for example.

    DEVICE AMSTRADCPC464
    ORG $1200
START  .... ;some code
    RET
    SAVECPCSNA "game.sna",START ;save snapshot to file game.sna. Start address is START ($1200)

Works only in real device emulation mode. See DEVICE.

Like SAVEBIN, saves the block of device RAM.

But it allows lengths over 64ki, and the offset value goes directly into device virtual memory (where pages are allocated consecutively), ignoring current slot "mapping". I.e. page=2,offset=0 will start saving data from page 2 at its beginning, going through pages 3, 4, 5, ... until the requested length of data is saved.

The offset is not limited to page size, i.e. arguments page=1,offset=0x500 are equal to arguments page=0,offset=0x4500 for ZXSPECTRUM128 device (has page size 0x4000).

    DEVICE ZXSPECTRUM128 : SAVEDEV "fullram.bin",0,0,0x20000 ; save full 128kiB

Works only in real device emulation mode. See DEVICE.

Save the block of RAM in Hobeta format.

    PAGE 7 ;set 7 page to current slot
    SAVEHOB "ram7.$c","myfile1.C",$C000,$4000 ;- save 4000h begin from C000h of RAM to file
    SAVEHOB "ram2.$c","myfile2.C",$8000,$3000 ;- save 3000h begin from 8000h of RAM to file

Commands to build NEX file, for details check SAVENEX chapter.

Works only in ZXSPECTRUMNEXT device emulation mode. See DEVICE.

Works only in real device emulation mode. See DEVICE.

Save the snapshot for emulators of ZX-Spectrum. (If start address is omitted, the one provided by END is used)

The snapshot header content is hard-wired in sjasmplus binary (disabled interrupts may surprise some users, you can check the source to see all the values). If you absolutely need different defaults and can't afford init-code modifying the state, you can post-patch the resulting SNA file directly from source, see Issue #139 for example.

    DEVICE ZXSPECTRUM128
    ORG $8000
START  .... ;something code
    RET
    SAVESNA "game.sna",START ;save snapshot to file game.sna. Start address is START ($8000)

Works only in real device emulation mode. See DEVICE.

Append the tape header or block of data to the end of the standard tape file for emulators of ZX-Spectrum.

    DEVICE ZXSPECTRUM48
    ...
    EMPTYTAP "output.tap"

    SAVETAP "output.tap",BASIC,"noAutorun",label,100
    SAVETAP "output.tap",BASIC,"w/Autorun",label,100,9999
    SAVETAP "output.tap",BASIC,"withVars",label,123,9999,100
    SAVETAP "output.tap",CODE,"bank17",screen,6912
    SAVETAP "output.tap",CODE,"screen",demo,length,org
    SAVETAP "output.tap",NUMBERS,"dimArray",label,100      ; a()
    SAVETAP "output.tap",NUMBERS,"othernum",label,200,'b'  ; b()
    SAVETAP "output.tap",CHARS,"charArray",label,300       ; a$()
    SAVETAP "output.tap",CHARS,"nextone",label,400,'m'     ; m$()
    SAVETAP "output.tap",HEADLESS,start,length

Works only in real device emulation mode. See DEVICE.

Save the tape file for emulators of ZX-Spectrum as a "snapshot" of almost-whole memory. Generated tape file supports the ZX-Spectrum clones with extended RAM such as ATM Turbo 512, etc. (If start address is omitted, the one provided by END is used)

The stored memory starts at $5E00 (with screen data at $4000 auto-detected and optionally stored into the TAP file). The stored memory is automatically trimmed of zero values at start and end of the region (put non-zero byte markers around region you want to store, if you have zero-ed bytes at beginning or end of your code).

    DEVICE ZXSPECTRUM48
    ORG $7FFF
    DB $01      ; non-zero marker to store the following zero-ed data
DAT DS 1024, 0  ; zero-ed data at $8000 (1024 bytes)
START  ....     ; some code
    RET
    SAVETAP "game.tap", START ; save tape-snapshot to file game.tap. Start address is $8400

Works only in real device emulation mode. See DEVICE.

Save the device memory into TRD disk image. Saving two files with same filename will emit warning, but two files (with same name) will be created in the disk directory.

Adding pipe character "|" ahead of file name will make sjasmplus to delete old file(s) with the same name before writing the new one => replace-like functionality. If the deleted file did occupy all sectors till the free space position in disc info, sjasmplus will salvage those sectors back and save new file over them (but it will not do full reshuffle/defrag in more complex cases, sjasmplus is just assembler, not full featured TRD images manipulation tool).

Adding ampersand character "&" ahead of file name will make sjasmplus to look for existing file with the requested name (last of them, any earlier duplicates are deleted). The new content is appended to the file (sector aligned append) and the catalog entry gets only number of sectors patched, up to 255 sectors at most. This is special mode for single-file big-loaders.

The unofficial three-letter extensions are also supported (official extensions are only: B, C, D and #).

    EMPTYTRD "test.trd" ;create empty TRD image
    PAGE 7 ;set 7 page to current slot
    SAVETRD "test.trd","myfile1.C",$C000,$4000 ;- save 4000h begin from C000h of RAM to file to TRD image
    SAVETRD "test.trd","myfile2.C",$8000,$3000 ;- save 3000h begin from 8000h of RAM to file to TRD image
    SAVETRD "test.trd",|"myfile1.C",$B000,$400 ;- replace "myfile1.C" with new file
    SAVETRD "test.trd",&"myfile1.C",$9000,$734 ;- sector-append new data to "myfile1.C"

Works only in real device emulation mode. See DEVICE.

Will add execution-type breakpoint at address <expression> to the BPLIST export file. If no expression is specified, the current program counter will be used.

    BPLIST "cmd_line.options.txt" zesarux ; open breakpoints list in "ZEsarUX" format
start:
        nop     ; ZEsarUX will not catch very first instruction of snapshot file loaded
        SETBP   ; so breakpoint ahead of the second instruction (after first "nop")
        xor  a
        SETBP some_routine_label  ; set also some breakpoint to other code by its label
        SETBREAKPOINT $0D6B       ; alias of SETBP, works identically
        ; ... your code of app
					  

Execute external program <filename> using optional command line <parameters>.

    OUTPUT "mybin.bin"
    ;some code
    IF ((_ERRORS = 0) && (_WARNINGS = 0))
        SHELLEXEC "x:/somepath/bin2tap.exe mybin.bin mytap.tap"
       ; or SHELLEXEC "x:/somepath/bin2tap.exe","mybin.bin mytap.tap"
    ENDIF

If the resulting file is less than the given length, as many zero bytes are added as necessary. See OUTPUT for more.

    SIZE 32768       ; make sure file will be 32K

Type `COMMENT` - add comma delimited list of case sensitive keywords to be detected in end-of-line comments and exported to Source Level Debugging (SLD) data. The particular keywords depend on the debugger you are using to process SLD data.

    DEVICE ZXSPECTRUM128
    SLDOPT COMMENT WPMEM, Log
    ORG $8000
        call init ; Log("calling init") - gets exported to SLD
        ret       ; no keyword here - not exported to SLD
var1    DB 1      ; WPMEM - exported
var2    DB 2      ; WpMem - not exported, case sensitive!

Works only in real device emulation mode. See DEVICE.

Set current slot. Slots are defined by DEVICE pseudo-op. Use pseudo-op PAGE to change page in the current slot.

(since v1.18.1) You can also use starting address of particular slot instead of its number, ie. for ZX128: SLOT $8000 is alias of SLOT 2

    DEVICE ZXSPECTRUM128
    SLOT 3 ;from 0C000h to 0FFFFh
    PAGE 1 ;set page 1 to slot 3
    ORG 0C000h
    ;your program here
    PAGE 2
    INCBIN "somegfx.bin"
    ;....

Ends generating compiler output to tape file block specified in TAPOUT.

Appends one tape block at the end of specified file. All following code will be assembled to this tape file block.

Default value of flagbyte is 255.

    EMPTYTAP screen.tap

    TAPOUT screen.tap,0
    DB 3
    DB 'ScreenName'
    DW 6912
    DW 16384
    DW 32768
    TAPEND

    TAPOUT screen.tap
    INCBIN screen.bin
    TAPEND

This will create tap file with the screen.

Synonym of DISP.

Removes the identifier defined by DEFINE

    DEFINE Release 1

    IFDEF Release
      DISPLAY "Building release version"
    ENDIF

    UNDEFINE Release

    IFNDEF Release
      DISPLAY "It's works!"
    ENDIF

    IFDEF _SJASMPLUS
      DISPLAY "Yes, it's the sjasmplus!"
    ENDIF

    UNDEFINE *  ; undefine all identifiers

    IFNDEF _SJASMPLUS
      DISPLAY "It's not the sjasmplus??"
    ENDIF

Synonym of ENT.

While expression evaluates to non-zero value, generates following lines until an ENDW (EDUP/ENDR alias) pseudo-op is encountered.

The optional guardian-counter value will abort the WHILE if there are more iterations, default guardian-counter is set to 100k.

ptr = $4000
    WHILE ptr < $4020, 500 ; max 500 loops before error
        DB low ptr
ptr = ptr + 1
    ENDW    ; EDUP or ENDR works too, but ENDW is advised for WHILE

/* will emit bytes $00, $01, ..., $1F */

Defines a word. Values should be between -32787 and 65536.

    WORD 4000h,0d000h
    WORD 4,"HA"

If <expression> is non-zero the following lines are assembled until an ELSE, ELSEIF or ENDIF.

Forward reference of label will cause warning - as any machine code emitted inside the IF/IFN block with such expression can lead to unstable results. If you are sure the late definition of label will not affect resulting machine code (the IF block does not emit any machine code and does not define any label), you can suppress the warning.

    IF (aaa == 0) || (2 = aaa && ((bbb % 13) & 0x01))
        ; some code to assemble only if the symbol `aaa` is zero
        ; or (logical OR) when symbol `aaa` is two
        ; and (logical AND) modulo 13 of `bbb` is odd number
    ENDIF

If <expression> is zero the following lines are assembled until an ELSE, ELSEIF or ENDIF.

The condition is true if there is an id defined. These are NOT labels.

    IFDEF MSX_LEAN_AND_MEAN
        CALL InitOwnMM
    ELSE
        CALL InitDos2MemMan
    ENDIF

The condition is true if there isn't an id defined. These are NOT labels.

1   IN A,(0C4H)
    AND 2
    IFNDEF DEBUG
        JR NC,1B
    ENDIF

The condition is true if there is an label used somewhere in the code. You can create libraries of useful functions using IFUSED pseudo-op

    OUTPUT "TEST.OUT"

    CALL LABEL3 ; LABEL3 - yes
    LD A,(LABEL1) ; LABEL1 - yes

    IFUSED LABEL1
LABEL1:
    DB 1
    ENDIF

    IFUSED LABEL2
LABEL2:
    DB 2
    ENDIF

    IFUSED LABEL3
LABEL3:
    DB 3
    ENDIF

    IFUSED LABEL4
LABEL4:
    DB 4
    ENDIF

    LD A,LABEL2 ; LABEL2 - yes

    RET

; Output will contain bytes from LABEL1 to LABEL3 (1, 2, 3), but not contain from LABEL4, because this label is not used.

; Alternative syntax:
LABEL5:
    IFUSED ; sjasmplus will use name of previous label, i.e. LABEL5

    ENDIF
    

Known bug: when code is using label inside module "moduleX", like call labelY, only usage of moduleX.labelY label is noted. Then if you define "labelY" outside of module and hide it inside IFUSED labelY block, the call from module will be unable to find the routine.

Workaround: you can use the global-label operator @: "call @labelY" to trigger usage of the global "labelY", or you can use the alternative IFUSED syntax "labelY: IFUSED" which does not only check condition, but also does define the label. Once the label is defined, the "call labelY" line inside module will find the global variant and mark it as "used" correctly.

Local labels inside the IFUSED block are not visible until the main label is used, if you want to call only local label, you can force the visibility of the routine by "ASSERT main_label" - this will trigger usage of the global "main_label", and then the IFUSED block will be assembled, and local labels will become visible too.

The condition is true if there is an label not used somewhere in the code.

See IF. If the IF condition is false (in all previous IF/ELSEIF blocks), the else-part is assembled.

If the previous IF-block had false condition, the ELSEIF expression is evaluated and the ELSEIF acts as new IF.

Every IF should be followed by an ENDIF.

To define a one byte member. The defaultvalue is used when no initialisation value is given when the structure is declared. (DB and DEFB may be used instead of BYTE).

To define a two byte member. The defaultvalue is used when no initialisation value is given when the structure is declared. (DW and DEFW may be used instead of WORD).

To define a three byte member. The defaultvalue is used when no initialisation value is given when the structure is declared.

To define a four byte member. The defaultvalue is used when no initialisation value is given when the structure is declared. (DD and DEFD may be used instead of DWORD).

(since v1.17) To define a member of the specified length of bytes. The operands are DB-like formatted, and the last byte explicitly defined will fill the remaining bytes reserved upon definition (zeroed when no value is specified at all).

The default value can be modified with init values when structure is used, but then only the given bytes overwrite default content, NOT filling remainder of it.

While the operands are DB-like formatted, they must be enclosed in curly braces. Also make sure the braces are not mistaken with the optional braces on the sub-structure boundaries, when using TEXT member in sub-structure, you may need to use curly braces for the sub-structure itself around of curly braces used for TEXT values (making the sub-structure braces mandatory in such case). The length can be from 1 to 8192 bytes (if you need even longer "text", use two members and split your arguments).

To define a member of the specified number of bytes. Arguments are set when defining the current structure, and are not part of init values when the structure is later used. ('#', DS and DEFS may be used instead of BLOCK).

(since v1.11) If fillbyte is omitted, the device memory content in the block area is preserved (not zeroed).

To align the offset. If the expression is omitted, 4 is assumed. ('##' May be used instead of ALIGN).

(since v1.11) If the byte is omitted, device memory content is preserved (not zeroed).

It is possible to nest structures, and give new defaults for the BYTE and WORD members.

Calculate expression using calculator of the compiler (32-bit only). Example: val = _c("SOMELABEL+12")

Parse string of Z80 assembly. Example: _pc("ADD A,B")

Parse line of Z80 assembly. Example: _pl("SOMELABEL ADD A,B")

This binding makes almost all pseudo-instructions (directives) available from Lua script with all options and features. In the future the bindings API will be mostly frozen, extended only in case where using _pl(...) is too cumbersome.

See _c

See _pc

See _pl

Print error message.

Print warning message.

Check for file exists.

Get define value, returns nil if define is not found. Can optionally search also macro arguments (with higher priority).

Add new define. Returns true if the define is new, false when define already existed and value was replaced or when id is invalid.

Get label address. Returns -1 if name is invalid, 0 when not found or has still undefined value (you can use also _c("name") to get symbol value and do some calculations with it).

Add new label. Returns true when label was successfully inserted (or value modified first time in next assembling pass), false when name is invalid or label was already defined.

Read-only variable. Current address.

Read-only variable. Count of Errors.

Read-only variable. Count of Warnings.

Shutdown the compiler.

Add byte to output (or to memory) and increase sj.current_address

Add word to output (or to memory) and twice increase sj.current_address

Get byte from memory. Works only in real device emulation mode and only in last assembling pass.

Get word from memory. Works only in real device emulation mode and only in last assembling pass.

Return current emulating device's identifier. Returns "NONE" if no emulation mode.

Set current emulating device's identifier. Returns false if requested device id is not found and current device set is lost ("NONE" is set).

Set page "number" to the current slot. Works as pseudo-op PAGE.

Set current slot to "number". Works as pseudo-op SLOT.

(since v1.20.0) You can also use starting address of slot instead, ie. for ZX128 sj.set_slot(0x8000) is alias of sj.set_slot(2).

See pseudo-op SHELLEXEC.

Creates empty TRD image file.

Save block of memory to TRD image file. Work only in real device emulation mode.

Save snapshot of memory in SNA format. Works only in real device emulation mode and only for ZXSPECTRUM48 and ZXSPECTRUM128..

Opens a NEX file, defines start address, stack address and 16k bank to be mapped at 0xC000 before code is executed (if values are omitted, start address is zero = no start, stack address is 0xFFFE, entryBank is zero, fileVersion is 2).

Only single NEX file can be open at the same time, and to finalize the header content the command CLOSE has to be used (does auto-close if source ends).

Entry bank is number of 16k bank (0..111), not native 8k page, default is zero, i.e. the default memory map is identical to ZX 128 (ROM, RAM banks 5, 2 and 0).

Make sure your new stack has at least tens of bytes available as those will be used already by the NEX loader before executing your entry point (although released back).

The fileVersion can be 2 (NEX V1.2) or 3 (NEX V1.3), which will enforce the specified version of file. Otherwise the file is V1.2 by default and will auto-switch to V1.3 when some V1.3 feature is configured/used. When version 2 is enforced, any usage of V1.3 feature will emit error.

Set minimum required Next core version, can be set any time before CLOSE.

Set border colour (during loading), whether the machine should be set to default state (PreserveNextRegs = 0 = default), if the app requires extended RAM (224 8k pages) and how the file handle of the NEX file should be treated: 0 = default = close, 1 = keep open and pass in BC, $4000..$FFFE = keep open, and write into memory at provided address (after entry bank is paged in). This can be set any time before CLOSE.

All of these are NEX format V1.3 features and using "CFG3" command will change the version to V1.3 automatically (if not specified by OPEN).

DoCRC: default = 1, sjasmplus will checksum the file (if you know you will be further patching file afterwards, switch it off, otherwise keep 1).

PreserveExpansionBus: default = 0, 0 = the NEX loader will disable expansion bus through NextReg $80 / 1 = the NEX loader will not do anything.

CLIbufferAdr, CLIbufferSize: default = [0, 0], address and size of buffer for NEX loader to copy the arguments line into. The buffer is copied after the "entryBank" is mapped, so you can allocate buffer in your entryBank. The loader/format has hard limit 2048 bytes, the argument line will be truncated if longer. If your reserved buffer is shorter than 2048 bytes, the copy will be also truncated to your buffer size only. If not truncated, the argument line can end with any of these: Enter (13), colon or zero byte (truncated has no terminator character, just fills the full buffer).

Loading-bar related setup ("colour" usage depends on screen mode), can be set any time before CLOSE.

The posY argument will apply only to V1.3 Layer2 screens in 320x256 and 640x256 resolution (then defaults to 254 = bottom of screen, 2px tall bar).

This is optional command to set palette in alternative way ahead of SCREEN command, with higher priority (if the PALETTE command is used, following SCREEN commands will ignore the palette arguments and keep the palette defined by this command). You can be use it between OPEN and SCREEN command. But appropriate SCREEN type supporting palette must be defined by SCREEN command too.

Palette consists of 512 bytes (256 palette items from index 0), in 9b colour format: first byte is %RRRGGGBB, second byte is %P000000B (P is priority flag for Layer 2 colours).

The DEFAULT palette will generate colour values from the colour index, the same way how default Layer 2 palette is initialized on the ZX Spectrum Next.

The NONE palette will force the "no palette" flag even if SCREEN command later does specify some palette (it will be still ignored).

Layer 2 loading screen, can be used between OPEN and first AUTO/BANK command.

Palette consists of 512 bytes (256 palette items from index 0), in 9b colour format: first byte is %RRRGGGBB, second byte is %P000000B (P is priority flag for Layer 2 colours).

Image data are 48kiB block of memory, the loader will use always banks 9..11 to display it (8k pages 18..23), but if you will prepare the data there, it will be also re-saved by AUTO command, so either use other banks, and overwrite them with valid data/code after using the SCREEN command, or reset pages 18..23 to zero after SCREEN.

If no memory address is specified, the pages 18..23 are stored in file, and if no palette address is specified, no-palette flag is set in NEX file.

Works same way as "L2" variant, but will set up screen for new resolutions 320x256x8 and 640x256x4. The difference is that the required image data are 80kiB (five 16kiB banks; equals ten 8kiB pages), the banks used to show the screen in loader are 9..13 (8k pages 18..27 - that's also the default address of data if not specified) - avoid these in regular banks stored in the file.

These are NEX format V1.3 features and using them will change the version to V1.3 automatically (if not specified by OPEN). This command doesn't allow to set specific palette offset value (too lazy to add it, use BMP variant if you really need it).

The data has to be already in correct format and organized as if displayed (the "transposed" bitmap where +1 address goes to pixel below, and +256 goes to pixel on the right (or pair of pixels in case of 640x256x4bpp mode), this command will just dump them into file "as is".

The loading bar colour byte will be also used "as is", which in 4bpp mode means the byte does define pair of 4 bit pixels, i.e. if you want solid-colour "3" loading bar in 4bpp mode, define it as value $33. Keep also in mind the default loading bar position is Y=254, which on most of the TV/LCD displays is outside of visible range, the reasonably "safe" (visible on almost all of the screens) resolution is about 288x224 (+16px around PAPER area, +24px is visible on many displays too), you may want to organize your screen in a way to show all important information within this area, and make the rest "unimportant" so it can hide beyond the edge of screen.

LoRes (128x96) loading screen, can be used between OPEN and first AUTO/BANK command.

Palette is similar to Layer 2 mode, just LoRes mode doesn't have priority bit.

Image data are 12288 bytes memory block - either consecutive block if specific address is provided, or without address the actual bank 5 memory is stored (taking 6144 bytes from address 0x4000 and 6144 bytes from address 0x6000).

Only small subset of BMP files can be used: 256x192 (Layer 2) or 128x96 (LoRes), indexed (8bit image data with palette) and palette data will be truncated to 3:3:3 color space directly (no smart colour quantization or dithering is applied). And the file must be uncompressed.

For V1.3 NEX files you can include also 320x256 and 640x256 files (Layer 2), the 640x256 should be also 8bit indexed, but only 4 bits of pixel data will be used (256 colour palette is legitimate and will be stored "as is" in NEX file). These two new modes can also include paletteOffset argument 0..15 (does not apply to V1.2 BMP files above), the offset is added to top four bits of pixel value.

The BMP will be included as loading screen, can be used between OPEN and first AUTO/BANK command.

By default the palette from BMP file is used, but you can override that by savePalette = 0.

ULA/Timex modes loading screen, can be used between OPEN and first AUTO/BANK command.

The actual bank 5 memory (pages 10..11) is stored as if the image is displayed, in these modes the palette can't be specified.

SCR is classic ZX 6912 bytes long screen from address 0x4000 (page 10 is used, even if the slot 1 is modified to other page, so you must prepare the image "in place").

SHC and SHR are Timex HiColor (8x1 attribute) and HiRes (512x192 bitmap) modes, prepare data "in place", i.e. 6144 bytes into page 10 and 6144 bytes into page 11 (0x4000 and 0x6000 addresses in default memory setup). For HiRes mode you should specify ink colour (the paper is complement of ink).

NEX V1.3 tilemap loading screen, can be used between OPEN and first AUTO/BANK command.

To define palette use the PALETTE command.

The image data are stored as regular Bank 5 of the NEX file (which is the first bank to be loaded by loader), depending on AlsoStoreBank5 value (default 1), this SCREEN command will also execute BANK 5 command to store the image data.

The NextRegisters $6B, $6C, $6E and $6F should be enough to specify any variant of tilemap mode, so the precise sub-type and image data layout is under control of user, the sjasmplus doesn't enforce any particular configuration.

If you want to use also COPPER command, use it either ahead of the SCREEN TILE command, or use "AlsoStoreBank5 = 0" to delay the storage of Bank 5 data. In such case you must then later explicitly store the Bank 5 as regular bank, either with BANK or AUTO command.

Can be used after OPEN and before first AUTO or BANK command (the copper data are stored between screen and bank data).

Exactly 2048 bytes are stored (full Copper memory), and the loader will start the copper code in mode %01 (reset CPC to 0, then starts the copper), so the copper code will wrap around infinitely after the 1024th instruction executed. The copper is started after the screen block is loaded and displayed.

Can be used after OPEN or SCREEN and before CLOSE, but the 16ki banks must be saved in correct order: 5, 2, 0, 1, 3, 4, 6, 7, 8, 9, 10, ..., 111

Can be used after OPEN or SCREEN and before CLOSE. The sjasmplus will save every 16k bank containing at least one non-zero byte; detected in the correct order (automatically will save every non-zero 16k bank detected in the correct order (automatically starting from first possible bank after previous BANK/AUTO commands, or from provided "fromBank").

For "fromBank" value use the specified order above in BANK command, i.e. 5, 2, 0, ...

Can be used after OPEN. The currently open NEX file will be finalized (header adjusted), and optional extra file just appended to the end of NEX file.