core.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2024, 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_CORE_H__
# define __JO_CORE_H__
 
#ifdef JO_DEBUG
 
extern char     __jo_last_error[JO_PRINTF_BUF_SIZE];
void    __jo_core_error(char *message, const char *function);
# define jo_core_error(...)     do {sprintf(__jo_last_error, __VA_ARGS__); __jo_core_error(__jo_last_error, __FUNCTION__);} while(0)
 
#endif
 
# define JO_ENGINE_VERSION  (10.0)
 
/*
** TYPEDEFS
*/
typedef void    (*jo_event_callback)(void);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT
 
typedef void    (*jo_slave_callback)(void);
 
#endif
 
void    jo_core_init(const jo_color back_color);
 
void    jo_core_run(void);
 
int     jo_core_add_vblank_callback(const jo_event_callback callback);
 
void    jo_core_remove_vblank_callback(const int vblank_event_id);
 
int     jo_core_add_callback(const jo_event_callback callback);
 
void    jo_core_remove_callback(const int event_id);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT
 
int     jo_core_add_slave_callback(const jo_event_callback callback);
 
void    jo_core_remove_slave_callback(const int event_id);
 
#endif
 
void    jo_core_set_restart_game_callback(const jo_event_callback callback);
 
void    jo_goto_boot_menu(void);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT
 
void    jo_core_exec_on_slave(jo_slave_callback callback);
 
void    jo_core_wait_for_slave(void);
 
#endif
 
static  __jo_force_inline void jo_core_disable_reset(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(DisableReset);
}
 
static  __jo_force_inline void jo_core_enable_reset(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(EnableReset);
}
 
static  __jo_force_inline void      jo_core_tv_off(void)
{
    slTVOff();
}
 
static  __jo_force_inline void      jo_core_tv_on(void)
{
    slTVOn();
}
 
static  __jo_force_inline void jo_core_exit_to_multiplayer(void)
{
 
    (**(void(**)(void))0x600026C)();
}
 
static  __jo_force_inline void jo_core_restart_saturn(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(SystemReset);
}
 
#define                             jo_core_set_screens_order(screen1, args...) __jo_core_set_screens_order(screen1, ## args, ~0);
 
#ifdef JO_DEBUG
 
void    jo_core_suspend(void);
 
static  __jo_force_inline char * jo_get_last_error(void)
{
    return (__jo_last_error);
}
 
void                jo_dump_vdp1_registers(void);
 
void                jo_dump_vdp2_registers(void);
 
#endif
 
void                                __jo_core_set_screens_order(jo_scroll_screen screen1, ...);
 
#endif /* !__JO_CORE_H__ */
 
/*
** END OF FILE
*/