Library updated to version 1.0 with 3 new functions added

Author: JimmyDansbo

README.md

@@ -157,7 +157,7 @@ ZP registers affected: none<br>
 
 ## Function name: get_bank
 Purpose: Get the current VERA bank<br>
-Call address: `VTUILIB+53`<br>
+Call address: `VTUILIB+56`<br>
 Macro name: `VTUI_GET_BANK`<br>
 Routine name: `vtui_get_bank`<br>
 Communication registers: .C<br>
@@ -189,7 +189,7 @@ ZP registers affected: r0l ($02)<br>
 
 ## Function name: get_stride
 Purpose: Get the current VERA stride value<br>
-Call address: `VTUILIB+56`<br>
+Call address: `VTUILIB+59`<br>
 Macro name: `VTUI_GET_STRIDE`<br>
 Routine name: `vtui_get_stride`<br>
 Communication registers: .A<br>
@@ -221,7 +221,7 @@ ZP registers affected: none<br>
 
 ## Function name: get_decr
 Purpose: Get the current VERA decrement bit<br>
-Call address: `VTUILIB+59`<br>
+Call address: `VTUILIB+62`<br>
 Macro name: `VTUI_GET_DECR`<br>
 Routine name: `vtui_set_decr`<br>
 Communication registers: .C<br>

VTUI1.0.BIN

@@ -1,6 +1,6 @@
 #!/bin/bash
-rm -rf *.o *.PRG VTUI0.9.BIN
-acme -f cbm -o VTUI0.9.BIN -l vtuilib-generic.lst vtuilib-generic.asm
+rm -rf *.o *.PRG *.BIN
+acme -f cbm -o VTUI1.0.BIN -l vtuilib-generic.lst vtuilib-generic.asm
 acme -f cbm -o EXAMPL01.PRG example01.asm
 acme -f cbm -o EXAMPL02.PRG example02.asm
 acme -f cbm -o ACME-EX1.PRG acme-ex01.asm

build.sh

@@ -6,20 +6,24 @@ int main() {
 	// Load VTUI library into pre-allocated memory and initialize it
 	// ensure defined memory is large enough to hold VTUI library
 //	char	vtui[1023];
-//	vtui_load(vtui, "vtui0.9.bin");
+//	vtui_load(vtui, "vtui1.0.bin");
 //	vtui_initialize(vtui);
 
 	// Load VTUI library to address 0x0400 and initialize it
-	vtui_load((char*)0x0400, "vtui0.9.bin");
+	vtui_load((char*)0x0400, "vtui1.0.bin");
 	vtui_initialize((char*)0x0400);
 
 	// Switch to standard PETSCII character set
 	__asm__ ("lda #$8E");
 	__asm__ ("jsr $FFD2");
 
 	if (vtui_screen_set(SCRMODE40X30)) {
-		vtui_set_stride(1);
-		vtui_set_decr(0);
+		if (vtui_get_bank()!=1)
+			vtui_set_bank(1);
+		if (vtui_get_stride()!=1)
+			vtui_set_stride(1);
+		if (vtui_get_decr()!=0)
+			vtui_set_decr(0);
 		vtui_clr_scr(vtui_pet2scr(' '), (LIGHTGRAY<<4)+BLACK);
 
 		vtui_gotoxy(11, 2);
@@ -45,7 +49,7 @@ int main() {
 		// Write a character to show header starts
 		vtui_plot_char(0x73, 0x74);
 		// Write box header
-		vtui_print_str("version 0.9", 11, (YELLOW<<4)+PURPLE, PETSCII_TRUE);
+		vtui_print_str("version 1.0", 11, (YELLOW<<4)+PURPLE, PETSCII_TRUE);
 		// Write a character to show header ends
 		vtui_plot_char(0x6B, 0x74);
 		vtui_gotoxy(3, 17);

cc65-ex01.c

@@ -43,6 +43,9 @@ VTUI_border	= LIBSTART+44
 VTUI_save_rect	= LIBSTART+47
 VTUI_rest_rect	= LIBSTART+50
 VTUI_input_str	= LIBSTART+53
+VTUI_get_bank	= LIBSTART+56
+vtui_get_stride	= LIBSTART+59
+vtui_get_decr	= LIBSTART+62
 
 main:
 	; Load the library using standard Kernal functions
@@ -274,13 +277,13 @@ load_library:
 	rts
 
 Libname		!text	"VTUI LIBRARY"
-Verstr		!text	"VERSION 0.9"
+Verstr		!text	"VERSION 1.0"
 Boxstr		!text	"BOXES WITH OR WITHOUT BORDERS"
 Hlinestr	!text	"HORIZONTAL LINES"
 Vlinestr	!text	"VERTICAL LINES"
 Plotstr		!text	"PLOT OR SCAN CHARACTERS"
 Dramstr		!text	"DIRECTLY TO/FROM SCREEN RAM"
-Morestr		!text	"***MORE TO SEE AND TO COME***"
+Morestr		!text	"*** NOW WITH CC65 SUPPORT ***"
 
-Fname		!text	"VTUI0.9.BIN"
+Fname		!text	"VTUI1.0.BIN"
 End_fname

example01.asm

@@ -43,6 +43,11 @@ VTUI_scr2pet	= LIBSTART+41
 VTUI_border	= LIBSTART+44
 VTUI_save_rect	= LIBSTART+47
 VTUI_rest_rect	= LIBSTART+50
+VTUI_input_str	= LIBSTART+53
+VTUI_get_bank	= LIBSTART+56
+vtui_get_stride	= LIBSTART+59
+vtui_get_decr	= LIBSTART+62
+
 
 main:
 	; Initialize the library
@@ -250,12 +255,12 @@ main:
 	rts
 
 Libname		!text	"VTUI LIBRARY"
-Verstr		!text	"VERSION 0.9"
+Verstr		!text	"VERSION 1.0"
 Boxstr		!text	"BOXES WITH OR WITHOUT BORDERS"
 Hlinestr	!text	"HORIZONTAL LINES"
 Vlinestr	!text	"VERTICAL LINES"
 Plotstr		!text	"PLOT OR SCAN CHARACTERS"
 Dramstr		!text	"DIRECTLY TO/FROM SCREEN RAM"
-Morestr		!text	"***MORE TO SEE AND TO COME***"
+Morestr		!text	"*** NOW WITH CC65 SUPPORT ***"
 
-VTUI		!bin	"VTUI0.9.BIN"
+VTUI		!bin	"VTUI1.0.BIN"

example02.asm

@@ -87,6 +87,9 @@ vtui_border	= VTUI_LIB+44
 vtui_save_rect	= VTUI_LIB+47
 vtui_rest_rect	= VTUI_LIB+50
 vtui_input_str	= VTUI_LIB+53
+vtui_get_bank	= VTUI_LIB+56
+vtui_get_stride	= VTUI_LIB+59
+vtui_get_decr	= VTUI_LIB+62
 
 	jsr	vtui_initialize
 	jmp	VTUI_LIB_END
@@ -112,6 +115,16 @@ vtui_input_str	= VTUI_LIB+53
 	jsr	vtui_set_bank
 }
 
+; *****************************************************************************
+; Get current VERA bank (high memory bit)
+; *****************************************************************************
+; USES:		.A
+; RETURNS:	.C = Bank number, 0 or 1
+; *****************************************************************************
+!macro VTUI_GET_BANK {
+	jsr	vtui_get_bank
+}
+
 ; *****************************************************************************
 ; Set the stride without changing other values in VERA_ADDR_H
 ; *****************************************************************************
@@ -122,6 +135,15 @@ vtui_input_str	= VTUI_LIB+53
 	jsr	vtui_set_stride
 }
 
+; *****************************************************************************
+; Get current VERA stride value
+; *****************************************************************************
+; RETURNS:		.A = stride value
+; *****************************************************************************
+!macro VTUI_GET_STRIDE {
+	jsr	vtui_get_stride
+}
+
 ; *****************************************************************************
 ; Set the decrement value without changing other values in VERA_ADDR_H
 ; *****************************************************************************
@@ -132,6 +154,16 @@ vtui_input_str	= VTUI_LIB+53
 	jsr	vtui_set_decr
 }
 
+; *****************************************************************************
+; Get the current VERA decrement value
+; *****************************************************************************
+; USES:			.A
+; RETURNS:		.C (1 = decrement, 0 = increment)
+; *****************************************************************************
+!macro VTUI_GET_DECR {
+	jsr	vtui_get_decr
+}
+
 ; *****************************************************************************
 ; Write character and possibly color to current VERA address
 ; If VERA stride = 1 and decrement = 0, colorcode in X will be written as well.
@@ -300,6 +332,6 @@ vtui_input_str	= VTUI_LIB+53
 	jsr	vtui_input_str
 }
 
-VTUI:	!bin	"VTUI0.9.BIN"
+VTUI:	!bin	"VTUI1.0.BIN"
 
 VTUI_LIB_END:

vtuilib-acme.inc

@@ -87,6 +87,9 @@ vtui_border	= VTUI_LIB+44
 vtui_save_rect	= VTUI_LIB+47
 vtui_rest_rect	= VTUI_LIB+50
 vtui_input_scr	= VTUI_LIB+53
+vtui_get_bank	= VTUI_LIB+56
+vtui_get_stride	= VTUI_LIB+59
+vtui_get_decr	= VTUI_LIB+62
 
 	jsr	vtui_initialize
 	jmp	VTUI_LIB_END
@@ -112,6 +115,16 @@ vtui_input_scr	= VTUI_LIB+53
 	jsr	vtui_set_bank
 .endmacro
 
+; *****************************************************************************
+; Get current VERA bank (high memory bit)
+; *****************************************************************************
+; USES:		.A
+; RETURNS:	.C = Bank number, 0 or 1
+; *****************************************************************************
+.macro VTUI_GET_BANK
+	jsr	vtui_get_bank
+.endmacro
+
 ; *****************************************************************************
 ; Set the stride without changing other values in VERA_ADDR_H
 ; *****************************************************************************
@@ -122,6 +135,15 @@ vtui_input_scr	= VTUI_LIB+53
 	jsr	vtui_set_stride
 .endmacro
 
+; *****************************************************************************
+; Get current VERA stride value
+; *****************************************************************************
+; RETURNS:		.A = stride value
+; *****************************************************************************
+.macro VTUI_GET_STRIDE
+	jsr	vtui_get_stride
+.endmacro
+
 ; *****************************************************************************
 ; Set the decrement value without changing other values in VERA_ADDR_H
 ; *****************************************************************************
@@ -132,6 +154,16 @@ vtui_input_scr	= VTUI_LIB+53
 	jsr	vtui_set_decr
 .endmacro
 
+; *****************************************************************************
+; Get the current VERA decrement value
+; *****************************************************************************
+; USES:			.A
+; RETURNS:		.C (1 = decrement, 0 = increment)
+; *****************************************************************************
+.macro VTUI_GET_DECR
+	jsr	vtui_get_decr
+.endmacro
+
 ; *****************************************************************************
 ; Write character and possibly color to current VERA address
 ; If VERA stride = 1 and decrement = 0, colorcode in X will be written as well.
@@ -300,6 +332,6 @@ vtui_input_scr	= VTUI_LIB+53
 	jsr	vtui_input_str
 .endmacro
 
-VTUI:	.incbin	"VTUI0.9.BIN"
+VTUI:	.incbin	"VTUI1.0.BIN"
 
 VTUI_LIB_END:

vtuilib-ca65.inc

@@ -6,8 +6,11 @@
 .export _vtui_initialize
 .export _vtui_screen_set
 .export _vtui_set_bank
+.export _vtui_get_bank
 .export _vtui_set_stride
+.export _vtui_get_stride
 .export _vtui_set_decr
+.export _vtui_get_decr
 .export _vtui_clr_scr
 .export _vtui_gotoxy
 .export _vtui_plot_char
@@ -120,7 +123,7 @@ _vtui_initialize:
 :	iny				; Add 3 to .Y indexing
 	iny
 	iny
-	cpy	#57			; Ensure we have gone through all addresses
+	cpy	#66			; Ensure we have gone through all addresses
 	bne	:--			; below
 
 	; Library is designed to work with standard PETSCII character set, but
@@ -148,19 +151,46 @@ _vtui_set_bank:
 	ror
 	jmp	vtui_set_bank
 
+; *****************************************************************************
+; Return current bank number
+; *****************************************************************************
+_vtui_get_bank:
+	ldx	#0
+	jsr	vtui_get_bank
+	lda	#0
+	rol
+	rts
+
 ; *****************************************************************************
 ; Set VERA stride, value passed as argument and available in A
 ; *****************************************************************************
 _vtui_set_stride:
 	jmp	vtui_set_stride
 
+; *****************************************************************************
+; Return current stride value
+; *****************************************************************************
+_vtui_get_stride:
+	ldx	#0
+	jmp	vtui_get_stride
+
 ; *****************************************************************************
 ; Move inc/dec value into .C and call vtui_set_decr
 ; *****************************************************************************
 _vtui_set_decr:
 	ror
 	jmp	vtui_set_decr
 
+; *****************************************************************************
+; Return current decrement value
+; *****************************************************************************
+_vtui_get_decr:.byte $db
+	ldx	#0
+	jsr	vtui_get_decr
+	lda	#0
+	rol
+	rts
+
 ; *****************************************************************************
 ; Get char and color arguments into registers and call vtui_clr_scr
 ; *****************************************************************************
@@ -371,3 +401,9 @@ vtui_rest_rect:
 	jmp	$0000
 vtui_input_str:
 	jmp	$0000
+vtui_get_bank:
+	jmp	$0000
+vtui_get_stride:
+	jmp	$0000
+vtui_get_decr:
+	jmp	$0000

vtuilib-cc65.asm

@@ -45,11 +45,14 @@ extern void	__fastcall__ vtui_initialize(char *addr);
 extern char	__fastcall__ vtui_screen_set(char mode);
 // Set high bit (bank) of VERA address without touching anything else in VERA_ADDR_H
 extern void	__fastcall__ vtui_set_bank(char bank);
+extern char	__fastcall__ vtui_get_bank();
 // Set stride value without touching anything else in VERA_ADDR_H
 extern void	__fastcall__ vtui_set_stride(char stride);
+extern char	__fastcall__ vtui_get_stride();
 // Set Decrement bit in VERA_ADDR_H without touching anything else, use the defined
 // VTUI_INC and VTUI_DEC constants for clarity
 extern void	__fastcall__ vtui_set_decr(char decr);
+extern char	__fastcall__ vtui_get_decr();
 // Fill screen with "fillchar" characters and set their color to "color"
 extern void	__fastcall__ vtui_clr_scr(char fillchar, char color);
 // Set VERA address registers to point to X,Y coordinates (max 79,59). Assumes bank=1