Merge pull request #7 from nihirash/terminal_emulator_update

Terminal emulation update

Author: nihirash

.version

@@ -1 +1 @@
-2024.05.04
+2024.06.09

Makefile

@@ -6,7 +6,7 @@ EDOS=src/edos/edos.bin
 all: $(BINARY)
 
 $(BINARY): $(EDOS) $(SOURCES)
-	(cd src && ez80asm -i zinc.asm ../$(BINARY))
+	(cd src && ez80asm -i -l zinc.asm ../$(BINARY))
 
 $(EDOS): $(SOURCES)
 	date '+%Y.%m.%d' >.version

README.md

@@ -19,6 +19,38 @@ zinc mbasic test
 
 You shouldn't specify file extension for executable file(`.com` will be added automatically) and directory should no contain files with long file names.
 
+## Terminal emulation layer
+
+Currently, it supports "ADM-3a"-like compatible terminal emulation routines(like KayPro or some other computers). 
+
+It also allows disable(and re-enable terminal emulation routines) with `27, 255`(two bytes, 27 in decimal first, 255 in decimal secord) character sequence. If you disable terminal emulation routines you'll have possibility use all Agon's VDP commands, including graphics, sounds etc. Also you can get back to terminal emulation mode by same sequence. 
+
+### Control sequences and codes
+
+ * `0x01` - Home cursor
+
+ * `0x07` - Bell(makes single beep)
+
+ * `0x08` - move cursor left on one character
+
+ * `0x0C` - move cursor right on one character
+
+ * `0x14` - move cursor up on one character
+
+ * `0x16` - move cursor left on one character
+
+ * `0x17` - move cursor right on one character
+
+ * `0x18` - clean current line(after current cursor position)
+
+ * `0x1A` - clean screen
+
+ * `0x1B` - ESCAPE control sequences:
+  
+    - `ESC`+`=` - load cursor position(`ESC`+`=`+`y-coordinate`+`x-coordinate`)
+    
+    - `ESC`+`0xFF` - toggle terminal emulation(enable or disable it)
+
 ## Development
 
 You should use fresh version of [agon-ez80asm](https://github.com/envenomator/agon-ez80asm) for building system.

src/edos/console.asm

@@ -6,26 +6,29 @@
 ;; Works similar to real BDOS
 console_in:
     call CONIN
-    call check_char
-    ret c          ;; Do not echo some symbols
-
-    push af
-    ld c,a
-    call console_out
-    pop af
-    
-    ret
 
-check_char:
     cp CR
     ret z
+    
     cp LF
     ret z
+    
     cp TAB
     ret z
+    
     cp BS
+    ret z    
+    
     ret z
+
     cp ' '
+    ret c          ;; Do not echo some symbols
+
+    push af
+    ld c,a
+    call console_out
+    pop af
+    
     ret
 
 ;; I think we can here skip a bit complex things

src/edos/core.asm

@@ -18,8 +18,9 @@ CNTRLE:     equ $05
 BS:         equ $08
 TAB:        equ $09
 LF:         equ $0A
+CNTRLL:     equ $0C
 CR:         equ $0D
-    
+
     include "mos.asm"
 entrypoint:
     jp edos

src/edos/ebios/console.asm

@@ -42,6 +42,12 @@ bios_in:
     ld.lil (hl), a
 
     ld a, (keycode)
+    cp $15
+    jr nz, @ok
+
+    ld a, CNTRLL
+
+@ok:
 
     RESTORESP
     ret

src/edos/mos.asm

@@ -10,6 +10,7 @@
 
 ;; API CALLS
 MOS_GET_KEY:    equ     $00
+MOS_LOAD:       equ     $01
 MOS_DELETE:     equ     $05
 MOS_RENAME:     equ     $06
 MOS_SYS_VARS:   equ     $08
@@ -37,6 +38,10 @@ FA_CREATE:      equ     $04
 FA_CREATE_ALW:  equ     $08
 FA_OPEN_ALW:    equ     $10
 
-VAR_VKEYCOUNT: equ $19
+VAR_VDP_DONE:  equ $04
 VAR_KEYASCII:  equ $05
-VAR_KEYDOWN:   equ $18
+VAR_CURSORX:   equ $07
+VAR_CURSORY:   equ $08
+VAR_SCRWIDTH:  equ $13
+VAR_KEYDOWN:   equ $18
+VAR_VKEYCOUNT: equ $19

src/terminal.asm

@@ -10,25 +10,52 @@
 ;; Emulates simple ADM-3a like terminal
 ;; It's good enough and fast
 
-TERM_HOME:  equ $01
-TERM_LEFT:  equ $08
-TERM_CLS:   equ $0C
-TERM_UP:    equ $14
-TERM_LEFT2: equ $16
-TERM_RIGHT: equ $17
-TERM_CLINE: equ $18
-TERM_CLS2:  equ $1A
-TERM_ESC:   equ $1B
+TERM_HOME:   equ $01
+TERM_BELL:   equ $07
+TERM_LEFT:   equ $08
+TERM_FF:     equ $0C
+TERM_UP:     equ $14
+TERM_LEFT2:  equ $16
+TERM_RIGHT:  equ $17
+TERM_CLINE:  equ $18
+TERM_CLS2:   equ $1A
+TERM_ESC:    equ $1B
+TERM_SWITCH: equ $ff
 
     macro VDU byte
     ld a, byte
     rst.lil $10
     endmacro
 
+;; Little preparation for work - setting variables and other things
+term_init:
+    push ix
+    MOSCALL MOS_SYS_VARS
+
+    lea hl, ix + VAR_CURSORX
+    ld (term_pos), hl
+
+    lea hl, ix + VAR_SCRWIDTH
+    ld (term_size), hl
+
+    lea hl, ix + VAR_VDP_DONE
+    ld (cmd_done), hl
+
+    pop ix
+
+    ld hl, @msg
+    ld bc, 0
+    xor a
+    rst.lil $18
+
+    ret
+@msg:
+    db 13,10, "ADM-3a compatible terminal emulation started", 0
+
+
 termout:
     call _putc
 term_fsm: equ $ - 3
-
     ret.lil
 
 _cls:
@@ -44,21 +71,62 @@ _left:
     ret
 _up:
     VDU 11
-    ret
+    ret 
 _right:
     VDU 9
     ret
 
+_bell:
+    VDU 7
+    ret
+
 _esc:
     cp '='
     jr z, @load_coords
-;; You can add some ESC codes here
 
+;; Disable terminal emulation routine
+    cp TERM_SWITCH
+    jr z, @term_switch
+
+;; You can add some ESC codes here
     jr exit_fsm
 @load_coords:
     ld hl, _loadx 
     ld (term_fsm), hl
     ret
+@term_switch:
+    ld hl, _vdp
+    ld (term_fsm), hl
+    ret
+
+_vdp:
+    cp TERM_ESC
+    jr z, @vpd_esc
+
+    rst.lil $10
+    ret
+@vpd_esc:
+    ld hl, _vdp_esc
+    ld (term_fsm), hl
+    ret
+
+_vdp_esc:
+    cp TERM_SWITCH
+    jr z, @back_to_emul
+
+    push af
+    ld a, TERM_ESC
+    rst.lil $10
+    pop af
+    rst.lil $10
+
+    ld hl, _vdp
+    ld (term_fsm), hl
+    ret
+@back_to_emul:
+    ld hl, _putc
+    ld (term_fsm), hl
+    ret
 
 _loadx:
     sub 32
@@ -88,7 +156,8 @@ exit_fsm:
     ret
 
 _putc:
-    and $7f
+    cp TERM_FF
+    jp z, _right
 
     cp ' '
     jr nc, @draw
@@ -99,6 +168,9 @@ _putc:
     cp 10
     jr z, @draw
 
+    cp TERM_BELL
+    jp z, _bell
+
 ;; Move cursor
     cp TERM_LEFT
     jp z, _left
@@ -109,15 +181,18 @@ _putc:
     cp TERM_RIGHT
     jp z, _right
 
+
 ;; Home cursor
     cp TERM_HOME
     jp z, _home
-;; Clear screen
-    cp TERM_CLS
-    jp z, _cls
+
+;; Clear screen    
     cp TERM_CLS2
     jp z, _cls
 
+    cp TERM_CLINE
+    jp z, _clear_line
+
 ;; ESC control sequences 
     cp TERM_ESC
     jr z, @set_esc
@@ -134,11 +209,90 @@ _putc:
     ld (term_fsm), hl
     ret
 
+
+;; Clear current line. Mostly cause KayPro - many softwares except that this command is implemented
+;; Even if original ADM-3A haven't it
+_clear_line:
+    xor a 
+    ld mb, a
+    ld hl, (cmd_done)
+    ld (hl), a
+
+    ld hl, @prepare
+    ld bc, 3
+    rst.lil $18
+
+    call @cmd_result
+
+    xor a
+    ld (hl), a
+
+    ld hl, @prepare2
+    ld bc, 3
+    rst.lil $18
+    call @cmd_result
+
+    ld hl, (term_pos)
+    ld a, (hl)
+    ld (@coords), a
+    inc hl
+    ld a, (hl)
+    ld (@coords + 1), a
+
+    ld hl, @cmd
+    ld bc, 3
+    rst.lil $18
+
+    ld hl, (term_size)
+    ld a, (hl)
+    ld c, a
+    ld a, (@coords)
+    ld b, a
+    ld a, c
+    sub b
+    ld b, a
+@loop:
+    push bc
+    VDU ' '
+    pop bc
+    djnz @loop
+
+    ld hl, @cmd
+    ld bc, 3
+    rst.lil $18    
+
+    ld a, EDOS_PAGE
+    ld mb, a
+    ret
+;; It's more robust way be sure that our fetch command was executed
+@cmd_result:
+    ld hl, (cmd_done)
+@wait:
+    ld a, (hl)
+    and a 
+    jr z, @wait
+    ret
+@prepare:
+    db 23, 0, $86
+@prepare2:
+    db 23, 0, $82
+@cmd:
+    db 31
+@coords:
+    db 0
+    db 0
+
+
 set_pos_cmd:
     db 31
 term_y:
     db 0
 term_x:
     db 0
 
+cmd_done:
+    dl 0
+term_pos:
+    dl 0
+term_size:
     dl 0