Merge pull request #106 from CE-Programming/library-additions

Library additions

Author: mateoconlechuga

examples/os_input/autotester.json

@@ -0,0 +1,39 @@
+{
+  "rom": "84pce_515.rom",
+  "transfer_files": [
+    "bin/DEMO.8xp"
+  ],
+  "target": {
+    "name": "DEMO",
+    "isASM": true
+  },
+  "sequence": [
+    "action|launch",
+    "delay|700",
+    "key|1",
+    "delay|200",
+    "key|2",
+    "delay|200",
+    "key|enter",
+    "delay|200",
+    "hash|1",
+    "key|enter",
+    "delay|200",
+    "hashWait|2"
+  ],
+  "hashes": {
+    "1": {
+      "description": "Output should be N is 12",
+      "start": "0xD44B00",
+      "size": "0x25800",
+      "expected_CRCs": [ "7DBE5A77" ]
+    },
+    "2": {
+      "description": "Back to the home screen (exit check)",
+      "start": "vram_start",
+      "size": "vram_16_size",
+      "expected_CRCs": [ "FFAF89BA", "101734A5", "9DA19F44" ]
+    }
+  }
+}
+

examples/os_input/makefile

@@ -0,0 +1,33 @@
+# ----------------------------
+# Set NAME to the program name
+# Set DEBUGMODE to "DEBUG" to use debug functions
+# Set ICON to the png icon file name
+# Set DESCRIPTION to display within a compatible shell
+# Set COMPRESSED to "YES" to create a compressed program
+# ** Add all shared library names to L **
+# ----------------------------
+
+NAME        ?= DEMO
+DEBUGMODE   ?= NDEBUG
+COMPRESSED  ?= NO
+ICON        ?= iconc.png
+DESCRIPTION ?= "C SDK Demo"
+
+L ?=
+
+# ----------------------------
+# Specify source and output locations
+# ----------------------------
+
+SRCDIR ?= src
+OBJDIR ?= obj
+BINDIR ?= bin
+GFXDIR ?= src/gfx
+
+# ----------------------------
+# Use OS helper functions (Advanced)
+# ----------------------------
+
+USE_FLASH_FUNCTIONS ?= YES
+
+include $(CEDEV)/include/.makefile

examples/os_input/readme.md

@@ -0,0 +1,7 @@
+### OS Input Demo
+
+This demo shows how to get an input string from the OS.
+
+---
+
+This demo is a part of the C SDK Toolchain for use on the CE.

examples/os_input/src/main.c

@@ -0,0 +1,48 @@
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <tice.h>
+
+#include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define INPUT_SIZE 10
+#define BUFFER_SIZE 20
+
+/* Function prototypes */
+void print(char *text, uint8_t xpos, uint8_t ypos);
+
+/* Main Function */
+void main(void) {
+    const char prompt[] = "What is N? ";
+    char input[INPUT_SIZE];
+    char response[BUFFER_SIZE];
+    
+    /* Clear the homescreen */
+    os_ClrHome();
+    
+    /* Get an input string from the user */
+    os_GetStringInput(prompt, input, sizeof input);
+
+    /* Build the user response */
+    strcpy(response, "N is ");
+    strcat(response, input);
+    
+    /* Clear the homescreen */
+    os_ClrHome();
+    
+    /* Print the message back to the user */
+    print(response, 0, 0);
+    
+    /* Wait for a key press */
+    while (!os_GetCSC());
+}
+
+/* Draw text on the homescreen at the given X/Y location */
+void print(char *text, uint8_t xpos, uint8_t ypos) {
+    os_SetCursorPos(ypos, xpos);
+    os_PutStrFull(text);
+}
+

src/ce/getstringinput.src

@@ -0,0 +1,57 @@
+;-------------------------------------------------------------------------
+; void os_GetStringInput(char *string, char *buf, size_t bufsize)
+;-------------------------------------------------------------------------
+	.def	_os_GetStringInput
+	.assume adl=1
+
+_os_GetStringInput:
+	push	ix
+	ld	ix,0
+	add	ix,sp
+	ld	hl,(ix+6)		; hl -> input string prompt
+	add	hl,de
+	xor	a,a
+	sbc	hl,de
+	ld	de,0D00879h		; ioPrompt
+	jr	z,donecopy
+copyloop:
+	ld	a,(hl)
+	or	a,a
+	jr	z,donecopy
+	ld	(de),a
+	inc	hl
+	inc	de
+	jr	copyloop		; copy the input prompt here
+donecopy:
+	ld	(de),a
+	ld	(0D00599h),a		; curUnder
+	ld	iy,0D00080h
+	ld	b,(iy+9)
+	ld	c,(iy+28)		; back up old flag values
+	res	6,(iy+28)
+	set	7,(iy+9)
+	push	ix
+	push	bc
+	call	021320h			; _GetStringInput, get the input from the user
+	pop	bc
+	res	4,b			; restore old flag values
+	ld	(iy+9),b
+	ld	(iy+28),c
+	ld	hl,(0D0244Eh)		; editSym
+	call	020AE8h			; _VarNameToOP1HL, lookup the temporary input symbol
+	call	02050Ch			; _ChkFindSym
+	pop	ix
+	jr	c,SomeError
+	ex	de,hl
+	inc	hl
+	inc	hl
+	ld	de,(ix+9)		; hl -> input string prompt
+	ld	bc,(ix+12)		; bc = input string length
+	dec	bc
+	ldir
+	xor	a,a
+	ld	(de),a			; null terminate the string
+SomeError:
+	call	021578h			; DeleteTempEditEqu, delete the temporary input
+	pop	ix
+	ret

src/ce/tice.h

@@ -667,6 +667,16 @@ int os_TestFlagBits(uint16_t offset_pattern);
 void os_SetFlagBits(int16_t offset_pattern);
 void os_ResetFlagBits(int16_t offset_pattern);
 
+/**
+ * Custom implementation input routine for use in conjunction with the TIOS
+ *
+ * @param string Input prompt string to be displayed to the user
+ * @param buf Storage location to store input string
+ * @param bufsize Available storage size for input string. -1 for null termination.
+ * @returns None
+ */
+void os_GetStringInput(char *string, char *buf, size_t bufsize);
+
 /**
  * Gets a key from the OS
  *

src/fileioc/fileioc.h

@@ -201,15 +201,16 @@ uint16_t ti_Tell(const ti_var_t slot);
  * Gets the size of a slot
  *
  * @param slot Slot to test
- * @returns The size of the slot variablee
+ * @returns The size of the slot variable
  */
 uint16_t ti_GetSize(const ti_var_t slot);
 
 /**
  * Resizes the slot variable
  *
  * @param slot Slot to resize
- * @param new_size New size of slot 
+ * @param new_size New size of slot
+ * @returns Resized size on success, 0 on failure, or -1 if the slot cannot be opened
  * @note The variable offset is set to the beginning of the file
  */
 int ti_Resize(size_t new_size, const ti_var_t slot);

src/graphx/graphx.asm

@@ -3,7 +3,7 @@
 
  .libraryAppVar     "GRAPHX"		; Name of library on the calc
  .libraryName       "graphx"		; Name of library
- .libraryVersion    7			; Version information (1-255)
+ .libraryVersion    8			; Version information (1-255)
 
 ;-------------------------------------------------------------------------------
 ; v1 functions - Can no longer move/delete
@@ -118,7 +118,11 @@
  .function "gfx_RotateScaleSprite",_RotateScaleSprite
  .function "gfx_RotatedScaledTransparentSprite_NoClip",_RotatedScaledTransparentSprite_NoClip
  .function "gfx_RotatedScaledSprite_NoClip",_RotatedScaledSprite_NoClip
-
+;-------------------------------------------------------------------------------
+; v8 functions
+;-------------------------------------------------------------------------------
+ .function "gfx_SetCharData",_SetCharData
+ 
  .beginDependencies
  .endDependencies
 
@@ -3335,17 +3339,47 @@ _SetFontData:
 ;  arg0 : Pointer to font data
 ;  Set Pointer to NULL to use default font
 ; Returns:
-;  None
+;  Pointer to previous font data
 	pop	de
 	pop	hl
 	push	hl			; hl -> custom font data
 	push	de
 	add	hl,de
 	or	a,a
 	sbc	hl,de
+	ld	de,(TextData_ASM) \.r
 	jr	nz,+_			; if null make default font
 	ld	hl,Char000 \.r
 _:	ld	(TextData_ASM),hl \.r	; save pointer to custom font
+	ex	de,hl
+	ret
+
+;-------------------------------------------------------------------------------
+_SetCharData:
+; Sets a custom font for a specific character
+; Arguments:
+;  arg1 : Character index to change (0-127 or 0-255)
+;  arg0 : Pointer to character data; if null returns current data
+; Returns:
+;  Pointer to character data if null, otherwise pointer to next character
+	ld	iy,0
+	add	iy,sp
+	ld	hl,(iy+6)		; de -> custom character data
+	add	hl,de
+	or	a,a
+	sbc	hl,de			; sets z flag if null
+	ex	de,hl
+	or	a,a
+	sbc	hl,hl
+	ld	l,(iy+3)		; hl = index
+	add	hl,hl
+	add	hl,hl
+	add	hl,hl
+	ld	bc,(TextData_ASM)
+	add	hl,bc
+	ret	z
+	ld	bc,8
+	ldir
 	ret
 
 ;-------------------------------------------------------------------------------

src/graphx/graphx.h

@@ -1161,15 +1161,27 @@ gfx_sprite_t *gfx_RotateScaleSprite(gfx_sprite_t *sprite_in, gfx_sprite_t *sprit
 gfx_sprite_t *gfx_GetSpriteChar(char c);
 
 /**
- * Sets the font
+ * Sets the font's character data
  *
  * Fonts can be created manually or and exported to a C-style format using 8x8 Pixel ROM Font Editor.
  * (https://www.min.at/prinz/o/software/pixelfont/#download)
  *
  * @param data Pointer to formated 8x8 pixel font
+ * @returns Pointer to previous font data
  * @note Format of font data is 8 bytes horizontally aligned.
  */
-void gfx_SetFontData(uint8_t *data);
+uint8_t *gfx_SetFontData(uint8_t *data);
+
+/**
+ * Sets the font data for a specific character
+ *
+ * @param index Character index to modify (if using default font, values range from 0-127, custom font can have indexes 0-255)
+ * @param data Pointer to formated 8x8 pixel font
+ * @returns Pointer to current character data if \p data is NULL, otherwise a pointer to next character data
+ * @note Format of font data is 8 bytes horizontally aligned.
+ * @see gfx_SetFontData
+ */
+uint8_t *gfx_SetCharData(uint8_t index, uint8_t *data);
 
 /**
  * Sets the font spacing