tools.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef __JO_TOOLS_H__
# define __JO_TOOLS_H__
 
/*
** INCLUDES
*/
#include "math.h"
#include <stdarg.h>

#define JO_FIXED_TV_WIDTH   JO_INT_TO_FIXED(JO_TV_WIDTH)
#define JO_FIXED_TV_HEIGHT  JO_INT_TO_FIXED(JO_TV_HEIGHT)

static  __jo_force_inline short        jo_swap_endian_short(short value)
{
    return ((((value) >> 8) & 0xff) | (((value) & 0xff) << 8));
}

static  __jo_force_inline unsigned short        jo_swap_endian_ushort(unsigned short value)
{
    return ((((value) >> 8) & 0xff) | (((value) & 0xff) << 8));
}

static  __jo_force_inline unsigned int        jo_swap_endian_uint(unsigned int value)
{
    return ((((value) & 0xff000000) >> 24) | (((value) & 0x00ff0000) >>  8) | (((value) & 0x0000ff00) <<  8) | (((value) & 0x000000ff) << 24));
}

static  __jo_force_inline int        jo_swap_endian_int(int value)
{
    return ((((value) & 0xff000000) >> 24) | (((value) & 0x00ff0000) >>  8) | (((value) & 0x0000ff00) <<  8) | (((value) & 0x000000ff) << 24));
}

static  __jo_force_inline unsigned short        jo_read_big_endian_ushort(const unsigned char * const p)
{
    return ((unsigned short)((p[0] << 8) | p[1]));
}

static  __jo_force_inline unsigned int        jo_read_big_endian_uint(const unsigned char * const p)
{
    return (((unsigned int)p[0] << 24) | ((unsigned int)p[1] << 16) | ((unsigned int)p[2] << 8) | p[3]);
}

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

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

int                 jo_vsprintf(char * const str, const char * format, va_list args);
 
#ifdef JO_DEBUG
 
#define jo_printf_debug(X, Y, fmt, args...) \
        jo_printf(X, Y, "%s(%s)#%d : " fmt , \
                __FILE__, __FUNCTION__, __LINE__, ## args)
 
#endif

extern char             __jo_sprintf_buf[JO_PRINTF_BUF_SIZE];
 
#ifdef JO_COMPILE_WITH_PRINTF_SUPPORT
 

void jo_print(int x, int y, char * str);

# define jo_printf(X, Y, ...)       do {jo_sprintf(__jo_sprintf_buf, __VA_ARGS__); jo_print(X, Y, __jo_sprintf_buf); } while(0)

# define jo_printf_with_color(X, Y, COLOR_INDEX, ...)  do { jo_set_printf_color_index(COLOR_INDEX); jo_printf(X, Y, __VA_ARGS__); } while(0)

extern unsigned short   __jo_vdp2_printf_palette;

static  __jo_force_inline void        jo_set_printf_color_index(const unsigned char index)
{
    __jo_vdp2_printf_palette = (unsigned short)((index & 7) << 12);
}

void            jo_clear_screen(void);

void            jo_clear_screen_line(const int y);
 
#endif // JO_COMPILE_WITH_PRINTF_SUPPORT

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

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

void            jo_dma_wait(void);

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

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

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

# define JO_NULL                            ((void *)0)

# define JO_UNUSED_ARG(ARG)                     ((void)ARG)

static  __jo_force_inline bool        jo_tools_is_whitespace(const char c)
{
    return c == '\n' || c == '\r' || c == '\t'  || c == ' ';
}

static  __jo_force_inline int        jo_4_char_hash(const char * const str)
{
    return (int)str[0] | (((int)str[1]) << 8) | (((int)str[2]) << 16) | (((int)str[3]) << 24);
}

typedef struct
{
    unsigned char   day;
    unsigned char   month;
    unsigned short  year;
    unsigned char   hour;
    unsigned char   week;
    unsigned char   minute;
    unsigned char   second;
}                   jo_datetime;

typedef enum
{
    English = 0,
    Deutsch = 1,
    French = 2,
    Espanol = 3,
    Italiano = 4,
    Japanese = 5
}                   jo_language;

typedef enum
{
    None,
    Left,
    Right
}                   jo_horizontal_move;

jo_language     jo_get_current_language(void);

void            jo_getdate(jo_datetime *now);

int             jo_tools_atoi(const char * restrict str);

int             jo_strlen(const char * restrict str);

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

static  __jo_force_inline bool        jo_string_equals(const char * restrict p1, const char * restrict p2)
{
    return (jo_strcmp(p1, p2) == 0);
}

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

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

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

static  __jo_force_inline unsigned int  jo_lz_size(const unsigned char * const src)
{
    return (((unsigned int)src[0] << 24) | ((unsigned int)src[1] << 16) | ((unsigned int)src[2] << 8) | src[3]);
}

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

static  __jo_force_inline void        jo_yield(void)
{
    asm("nop");
}

static  __jo_force_inline void        jo_spin_wait(int iterations)
{
    while (iterations--) jo_yield();
}

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);

static  __jo_force_inline void    jo_cell_to_vram(unsigned char * restrict data, unsigned char * restrict vram_addr, unsigned int size)
{
    while (size-- > 0) *(vram_addr++) = *(data++);
}
 
#endif /* !__JO_TOOLS_H__ */
 
/*
** END OF FILE
*/