tools.h File Reference

Jo Engine Tools (printf, etc,). More...

#include "math.h"
#include <stdarg.h>

Go to the source code of this file.

Data Structures
struct	jo_datetime
	DateTime struct. More...

Macros
#define	JO_FIXED_TV_WIDTH
	Fixed value of JO_TV_WIDTH.
#define	JO_FIXED_TV_HEIGHT
	Fixed value of JO_TV_HEIGHT.
#define	jo_printf_debug(X, Y, fmt, args...)
#define	JO_NULL
	NULL implementation.
#define	JO_UNUSED_ARG(ARG)
	Mark function argument as unused.

Enumerations
enum	jo_language {   English , Deutsch , French , Espanol ,   Italiano , Japanese }
	Language type. More...
enum	jo_horizontal_move { None , Left , Right }
	Horizontal move. More...

Functions
static __jo_force_inline short	jo_swap_endian_short (short value)
	Swap Short endian.
static __jo_force_inline unsigned short	jo_swap_endian_ushort (unsigned short value)
	Swap Unsigned short endian.
static __jo_force_inline unsigned int	jo_swap_endian_uint (unsigned int value)
	Swap unsigned int endian.
static __jo_force_inline int	jo_swap_endian_int (int value)
	Swap int endian.
static __jo_force_inline unsigned short	jo_read_big_endian_ushort (const unsigned char *const p)
	Read a big endian unsigned short (16 bits) from any address (the bytes of a file, aligned or not).
static __jo_force_inline unsigned int	jo_read_big_endian_uint (const unsigned char *const p)
	Read a big endian unsigned int (32 bits) from any address (the bytes of a file, aligned or not).
int	sprintf (char *str, const char *format,...)
	sprintf prototypes
int	jo_sprintf (char *const str, const char *const format,...)
	A small sprintf of the engine (jo_printf()...): d i u x X c s %%, the flags - and 0, a width. Faster and smaller than the one of the C library (which handles the floats: f is not supported here, written as it is).
int	jo_vsprintf (char *const str, const char *format, va_list args)
	jo_sprintf() with a list of arguments
void	jo_memcpy (void *const restrict dst, const void *const restrict src, unsigned int size)
	Copies size bytes from the object pointed to by src to the object pointed to by dst.
void	jo_dma_copy_async (const void *const src, void *const dest, const unsigned int size)
	Start a copy with the DMA controller of the current CPU (the function doesn't wait for the end of the copy).
void	jo_dma_wait (void)
	Wait for the end of the copy started by jo_dma_copy_async() on the current CPU.
void	jo_dma_copy (const void *const src, void *const dest, const unsigned int size)
	Copy with the DMA controller of the current CPU and wait for the end of the copy.
void	jo_dma_fill32 (void *const dest, const unsigned int value, const unsigned int size)
	Fill memory with a 32 bits value using the DMA controller of the current CPU (waits for the end).
void	__jo_dma_read_port32 (const volatile void *const port, void *const dest, const unsigned int size)
	Read a 32 bits I/O port into memory with the DMA controller of the current CPU (Internal usage).
static __jo_force_inline bool	jo_tools_is_whitespace (const char c)
	Check if the character is a whitespace.
static __jo_force_inline int	jo_4_char_hash (const char *const str)
	Create an hash code based on the first four character of the string.
jo_language	jo_get_current_language (void)
	Get Sega saturn current language.
void	jo_getdate (jo_datetime *now)
	get current date and time
int	jo_tools_atoi (const char *restrict str)
	atoi implementation
int	jo_strlen (const char *restrict str)
	strlen implementation
int	jo_strcmp (const char *restrict p1, const char *restrict p2)
	strcmp implementation
static __jo_force_inline bool	jo_string_equals (const char *restrict p1, const char *restrict p2)
	Determine if two string equals.
bool	jo_endwith (const char *restrict str, const char *restrict end)
	determine if str end with a specific string
void	jo_memset (const void *const restrict ptr, const int value, unsigned int num)
	Sets the first num bytes of the block of memory pointed by ptr to the specified value (interpreted as an unsigned char).
int	jo_memcmp (const void *const p1, const void *const p2, unsigned int num)
	memcmp implementation
static __jo_force_inline unsigned int	jo_lz_size (const unsigned char *const src)
	Size of the data compressed by Compiler/COMMON/jo_lz.py (the 4 bytes at its start, big endian).
unsigned int	jo_lz_decompress (const unsigned char *const src, unsigned char *const dst)
	Decompress data compressed by Compiler/COMMON/jo_lz.py (LZSS: a byte of 8 flags, 1 a byte as it is, 0 a copy of 3 to 18 bytes from 1 to 4096 bytes before: 12 bits of distance, 4 bits of length).
static __jo_force_inline void	jo_yield (void)
	Little pause possible.
static __jo_force_inline void	jo_spin_wait (int iterations)
	Causes "a thread" to wait the number of times defined by the iterations parameter.
void	jo_map_to_vram (unsigned short *restrict data, unsigned short *restrict vram_addr, unsigned short suuj, unsigned short suui, unsigned short palnum, unsigned int mapoff)
	Copies the image map data to VRAM.
static __jo_force_inline void	jo_cell_to_vram (unsigned char *restrict data, unsigned char *restrict vram_addr, unsigned int size)
	Copies the image cel data to VRAM.

Variables
char	__jo_sprintf_buf [JO_PRINTF_BUF_SIZE]
	Internal sprintf buffer.

Detailed Description

Jo Engine Tools (printf, etc,).

Author

Johannes Fetz

Bug

No known bugs.

---

Data Structure Documentation

jo_datetime

struct jo_datetime

DateTime struct.

Data Fields
unsigned char	day
unsigned char	hour
unsigned char	minute
unsigned char	month
unsigned char	second
unsigned char	week
unsigned short	year

Macro Definition Documentation

JO_FIXED_TV_HEIGHT

#define JO_FIXED_TV_HEIGHT

Fixed value of JO_TV_HEIGHT.

JO_FIXED_TV_WIDTH

#define JO_FIXED_TV_WIDTH

Fixed value of JO_TV_WIDTH.

JO_NULL

#define JO_NULL

NULL implementation.

jo_printf_debug

#define jo_printf_debug	(		X,
			Y,
			fmt,
			args... )

JO_UNUSED_ARG

#define JO_UNUSED_ARG

(

ARG

)

Mark function argument as unused.

Enumeration Type Documentation

jo_horizontal_move

enum jo_horizontal_move

Horizontal move.

Enumerator
None
Left
Right

jo_language

enum jo_language

Language type.

Enumerator
English
Deutsch
French
Espanol
Italiano
Japanese

Function Documentation

__jo_dma_read_port32()

void __jo_dma_read_port32	(	const volatile void *const	port,
		void *const	dest,
		const unsigned int	size )

Read a 32 bits I/O port into memory with the DMA controller of the current CPU (Internal usage).

Parameters

port	Port address (the address doesn't change)
dest	Destination (4 bytes aligned)
size	Size in bytes (multiple of 4)

jo_4_char_hash()

__jo_force_inline int jo_4_char_hash ( const char *const str )

static

Create an hash code based on the first four character of the string.

Parameters

str

String

Returns

the hashcode (integer)

jo_cell_to_vram()

__jo_force_inline void jo_cell_to_vram ( unsigned char *restrict data, unsigned char *restrict vram_addr, unsigned int size )

static

Copies the image cel data to VRAM.

Parameters

data	Data source
vram_addr	VRAM address
size	Data size

jo_dma_copy()

void jo_dma_copy	(	const void *const	src,
		void *const	dest,
		const unsigned int	size )

Copy with the DMA controller of the current CPU and wait for the end of the copy.

Parameters

src	Data source
dest	Destination
size	Size in bytes

Remarks

Faster than jo_memcpy() for big copies, especially to VRAM or sound RAM. Small or unaligned (odd address or size) copies use jo_memcpy().

jo_dma_copy_async()

void jo_dma_copy_async	(	const void *const	src,
		void *const	dest,
		const unsigned int	size )

Start a copy with the DMA controller of the current CPU (the function doesn't wait for the end of the copy).

Parameters

src	Data source
dest	Destination
size	Size in bytes

Remarks

The CPU keeps working during the copy (the DMA controller steals bus cycles). Each CPU (master and slave) has its own DMA controller.

Small or unaligned (odd address or size) copies are done by the CPU with jo_memcpy() before returning.

Warning

Don't change the source and don't read the destination before jo_dma_wait()

jo_dma_fill32()

void jo_dma_fill32	(	void *const	dest,
		const unsigned int	value,
		const unsigned int	size )

Fill memory with a 32 bits value using the DMA controller of the current CPU (waits for the end).

Parameters

dest	Destination (4 bytes aligned)
value	Value
size	Size in bytes (multiple of 4)

jo_dma_wait()

void jo_dma_wait

(

void

)

Wait for the end of the copy started by jo_dma_copy_async() on the current CPU.

Remarks

Returns immediately if no copy is in progress

jo_endwith()

bool jo_endwith	(	const char *restrict	str,
		const char *restrict	end )

determine if str end with a specific string

Parameters

str	This is the string
end	The ending string

Returns

This function returns true if str end with "end" param otherwise false

jo_get_current_language()

jo_language jo_get_current_language

(

void

)

Get Sega saturn current language.

Returns

The language

jo_getdate()

void jo_getdate

(

jo_datetime *

now

)

get current date and time

Parameters

now

result

jo_lz_decompress()

unsigned int jo_lz_decompress	(	const unsigned char *const	src,
		unsigned char *const	dst )

Decompress data compressed by Compiler/COMMON/jo_lz.py (LZSS: a byte of 8 flags, 1 a byte as it is, 0 a copy of 3 to 18 bytes from 1 to 4096 bytes before: 12 bits of distance, 4 bits of length).

Parameters

src	Compressed data (the size first, see jo_lz_size())
dst	Decompressed data (jo_lz_size() bytes)

Returns

Size of the data once decompressed (bytes)

Remarks

About 4 times smaller in RAM than a model of a car with its textures: kept in RAM, read from the CD once (the CD audio goes on)

jo_lz_size()

__jo_force_inline unsigned int jo_lz_size ( const unsigned char *const src )

static

Size of the data compressed by Compiler/COMMON/jo_lz.py (the 4 bytes at its start, big endian).

Parameters

src	Compressed data

Returns

Size of the data once decompressed (bytes)

jo_map_to_vram()

void jo_map_to_vram	(	unsigned short *restrict	data,
		unsigned short *restrict	vram_addr,
		unsigned short	suuj,
		unsigned short	suui,
		unsigned short	palnum,
		unsigned int	mapoff )

Copies the image map data to VRAM.

Parameters

data	Data source
vram_addr	VRAM address
suui	SUUI
suuj	SUUJ
palnum	Palette number
mapoff	MapOff

jo_memcmp()

int jo_memcmp	(	const void *const	p1,
		const void *const	p2,
		unsigned int	num )

memcmp implementation

Parameters

p1	First block of memory
p2	Second block of memory
num	Number of bytes to compare

Returns

0 if the num first bytes are the same, else the difference of the first different bytes (as unsigned char)

jo_memcpy()

void jo_memcpy	(	void *const restrict	dst,
		const void *const restrict	src,
		unsigned int	size )

Copies size bytes from the object pointed to by src to the object pointed to by dst.

Parameters

dst	Destination
src	Data source
size	Number of bytes to copy

Remarks

No return value in this implementation

jo_memset()

void jo_memset	(	const void *const restrict	ptr,
		const int	value,
		unsigned int	num )

Sets the first num bytes of the block of memory pointed by ptr to the specified value (interpreted as an unsigned char).

Parameters

ptr	Pointer to the block of memory to fill.
value	Value to be set. The value is passed as an int, but the function fills the block of memory using the unsigned char conversion of this value.
num	Number of bytes to be set to the value.

Remarks

No return value in this implementation

jo_read_big_endian_uint()

__jo_force_inline unsigned int jo_read_big_endian_uint ( const unsigned char *const p )

static

Read a big endian unsigned int (32 bits) from any address (the bytes of a file, aligned or not).

Parameters

p	Address of the first byte

Returns

Value

jo_read_big_endian_ushort()

__jo_force_inline unsigned short jo_read_big_endian_ushort ( const unsigned char *const p )

static

Read a big endian unsigned short (16 bits) from any address (the bytes of a file, aligned or not).

Parameters

p	Address of the first byte

Returns

Value

jo_spin_wait()

__jo_force_inline void jo_spin_wait ( int iterations )

static

Causes "a thread" to wait the number of times defined by the iterations parameter.

Parameters

iterations

defines how long "a thread" is to wait

jo_sprintf()

int jo_sprintf	(	char *const	str,
		const char *const	format,
			... )

A small sprintf of the engine (jo_printf()...): d i u x X c s %%, the flags - and 0, a width. Faster and smaller than the one of the C library (which handles the floats: f is not supported here, written as it is).

Parameters

str	String (big enough)
format	Format string
...	Arguments

Returns

The number of characters written (without the null character)

jo_strcmp()

int jo_strcmp	(	const char *restrict	p1,
		const char *restrict	p2 )

strcmp implementation

Parameters

p1	First string
p2	Second string

Returns

Compare p1 and p2, returning less than, equal to or greater than zero if p1 is lexicographically less than, equal to or greater than p2.

jo_string_equals()

__jo_force_inline bool jo_string_equals ( const char *restrict p1, const char *restrict p2 )

static

Determine if two string equals.

Parameters

p1	First string
p2	Second string

Returns

True if p1 and p2 is the same

jo_strlen()

int jo_strlen

(

const char *restrict

str

)

strlen implementation

Parameters

str	This is the string

Returns

This function returns the length of str

jo_swap_endian_int()

__jo_force_inline int jo_swap_endian_int ( int value )

static

Swap int endian.

Parameters

value

Little or Big endian int

Returns

Endian swapped int

jo_swap_endian_short()

__jo_force_inline short jo_swap_endian_short ( short value )

static

Swap Short endian.

Parameters

value

Little or Big endian short

Returns

Endian swapped short

jo_swap_endian_uint()

__jo_force_inline unsigned int jo_swap_endian_uint ( unsigned int value )

static

Swap unsigned int endian.

Parameters

value

Little or Big endian unsigned int

Returns

Endian swapped unsigned int

jo_swap_endian_ushort()

__jo_force_inline unsigned short jo_swap_endian_ushort ( unsigned short value )

static

Swap Unsigned short endian.

Parameters

value

Little or Big endian unsigned short

Returns

Endian swapped unsigned short

jo_tools_atoi()

int jo_tools_atoi

(

const char *restrict

str

)

atoi implementation

Parameters

str	This is the string representation of an integral number

Returns

This function returns the converted integral number as an int value. If no valid conversion could be performed, it returns zero

jo_tools_is_whitespace()

__jo_force_inline bool jo_tools_is_whitespace ( const char c )

static

Check if the character is a whitespace.

Parameters

c	variable of char type

Returns

true if the character is a whitespace otherwise false

jo_vsprintf()

int jo_vsprintf	(	char *const	str,
		const char *	format,
		va_list	args )

jo_sprintf() with a list of arguments

Parameters

str	String (big enough)
format	Format string
args	Arguments

Returns

The number of characters written (without the null character)

jo_yield()

__jo_force_inline void jo_yield ( void )

static

Little pause possible.

sprintf()

int sprintf	(	char *	str,
		const char *	format,
			... )

sprintf prototypes

Parameters

str	String
format	Format string
...	Arguments

Returns

If successful, the total number of characters written is returned excluding the null-character appended at the end of the string, otherwise a negative number is returned in case of failure.

Variable Documentation

__jo_sprintf_buf

char __jo_sprintf_buf[JO_PRINTF_BUF_SIZE]

extern

Internal sprintf buffer.

Warning

MC Hammer: don't touch this