inout.inc

; This file contains MACROs fo preparing parameters and CALL the real Procedures in inout.asm
; These MACROs should be called instead of the Procedures in inout.asm

; THese procedures are external
; MUST be declared at another assembly file with same name,type
; so that the linker join them

EXTRN setCursorPosition:NEAR
EXTRN getCursorPosition:NEAR
EXTRN getPressedKey:NEAR
EXTRN isKeyPressed:NEAR
EXTRN clearKeyboardBuffer:NEAR
EXTRN isLetter:NEAR
EXTRN readString:NEAR
EXTRN printString:NEAR
EXTRN printChar:NEAR
EXTRN printNumber:NEAR
EXTRN clearCharacters:NEAR
EXTRN switchToTextMode:NEAR
EXTRN switchToGraphicsMode:NEAR
EXTRN openFile:NEAR
EXTRN loadImageData:NEAR
EXTRN closeFile:NEAR
EXTRN getSystemTime:NEAR
EXTRN delayInSeconds:NEAR


EXTRN time_seconds:BYTE


callSetCursorPosition MACRO x , y
	PUSHA
	
	MOV DL , x
	MOV DH , y
	
	CALL setCursorPosition
	
	POPA
ENDM callSetCursorPosition



; @Returns x -> DL
; @Returns y -> DH
callGetCursorPosition MACRO
	PUSH BX
	PUSH AX
	
	CALL getCursorPosition
	
	POP AX
	POP BX
ENDM callGetCursorPosition



callWaitForAnyKey MACRO
	PUSH AX

	CALL getPressedKey

	POP AX
ENDM callWaitForAnyKey

; return AH -> scan code , AL -> ASCII code
callGetPressedKey MACRO

	CALL getPressedKey

ENDM callGetPressedKey


; @Return answer in Zero flag
; Zero Flag = 0 -> true , Zero Flag = 1 -> false
; JNZ -> true , JZ -> false
; return AH -> scan code , AL -> ASCII code
callIsKeyPressed MACRO

	CALL isKeyPressed

ENDM callIsKeyPressed


callClearKeyboardBuffer MACRO
	PUSH AX

	CALL clearKeyboardBuffer

	POP AX
ENDM callClearKeyboardBuffer


; @Return result in carry flag
; Carry = 1 -> true , Carry = 0 -> false
; JC -> true , JNC -> false
callIsLetter MACRO letter
	PUSH AX

	MOV AL , letter
	CALL isLetter

	POP AX
ENDM callIsLetter


; inputBuffer should have 2 bytes before it determining the size of buffer
; inputBuffer offsets:
; inputBuffer-2 -> max bytes to read including Enter
; inputBuffer-1 -> @return the actual number of characters read
; inputBuffer   -> the input string
; returned string is saved at memory location of inputBuffer
callReadString MACRO inputBuffer
	PUSHA
	
	LEA DX , inputBuffer
	SUB DX , 2
	
	CALL readString

	POPA
ENDM callReadString



; string must be a memory location terminated with '$'
; string is printed at the current cursor position
callPrintString MACRO string
	PUSH AX
	PUSH DX
	
	LEA DX , string 
	
	CALL printString

	POP DX
	POP AX
ENDM callPrintString


; character is printed at the current cursor position
callPrintChar MACRO char
	PUSH AX
	PUSH DX
	
	MOV DL , char
	
	CALL printChar

	POP DX
	POP AX
ENDM callPrintChar


; number is assumed as byte/word variable/register
; number is printed at the current cursor position
callPrintNumber MACRO number
	PUSHA
	
	MOVZX EAX , number
	CALL printNumber

	POPA
ENDM callPrintNumber


; Clear number of characters to reprint over them without overlapping
; i.e. printing spaces to clear the screen
; Note: it does not change the cursor position
callClearCharacters MACRO numberOfChars
	PUSHA

	MOV CH , 0
	MOV CL , numberOfChars
	CALL clearCharacters

	POPA
ENDM callClearCharacters


callSwitchToTextMode MACRO
	PUSH AX
	
	CALL switchToTextMode
	
	POP AX
ENDM callSwitchToTextMode



callSwitchToGraphicsMode MACRO
	PUSH AX
	
	CALL switchToGraphicsMode
	
	POP AX
ENDM callSwitchToGraphicsMode


; open file from the device with filename
; @ returns the output pointer to this file in fileHandle
callOpenFile MACRO filename , fileHandle
	PUSHA
	
	LEA DX , Filename
	LEA SI , fileHandle
	CALL openFile

	POPA
ENDM callOpenFile



; Loads data from image with its fileHandle and save them in imageData
; dimensions of the image is 16px * 16px
; imageData is assumed an array with available space to store the data (16 * 16 bytes)
callLoadImageData MACRO fileHandle , imageData
	PUSHA

	MOV BX , [fileHandle]
	LEA DX , imageData
	CALL loadImageData

	POPA
ENDM callLoadImageData


; Closes the opened file with its corresponding fileHandle
callCloseFile MACRO fileHandle 
	PUSHA

	LEA SI , fileHandle
	CALL closeFile

	POPA 
ENDM callCloseFile

callGetSystemTime MACRO
	PUSHA

	CALL getSystemTime

	POPA
ENDM callGetSystemTime

callDelayInSeconds MACRO seconds
	PUSHA

	MOV CH , 0
	MOV CL , seconds
	CALL delayInSeconds

	POPA
ENDM callDelayInSeconds


; Memory Macros 
; Same interface as Assembly instructions but for memory to memory operations

MOV_MEMORY_WORD MACRO destination , source

	PUSH source
	POP destination

ENDM MOV_MEMORY_WORD


MOV_MEMORY_BYTE MACRO destination , source
	PUSH AX

	MOV AL , source
	MOV destination , AL

	POP AX
ENDM MOV_MEMORY_BYTE



XCHG_MEMORY_WORD MACRO var_1 , var_2

	PUSH var_1
	PUSH var_2

	POP var_1
	POP var_2

ENDM XCHG_MEMORY_WORD


XCHG_MEMORY_BYTE MACRO var_1 , var_2
	PUSH AX

	MOV AL , var_1
	MOV AH , var_2

	MOV var_1 , AH
	MOV var_2 , AL
	
	POP AX
ENDM XCHG_MEMORY_BYTE


CMP_MEMORY MACRO var_1 , var_2
	PUSH EAX
	PUSH EBX

	MOVZX EAX , var_1
	MOVZX EBX , var_2
	SUB EAX , EBX

	POP EBX
	POP EAX
ENDM CMP_MEMORY