fs.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_FS_H__
# define __JO_FS_H__
 
#ifdef JO_COMPILE_WITH_FS_SUPPORT
 
/*
** MACROS
*/
# define JO_ROOT_DIR                ((const char *)0)
# define JO_CURRENT_DIR             ((const char *)0)
# define JO_PARENT_DIR              ("..")
 
/*
** TYPEDEFS
*/
typedef void                                (*jo_fs_async_read_callback)(char *contents, int length, int optional_token);

void                                        jo_fs_cd(const char *const sub_dir);

char*                                       jo_fs_read_file_in_dir(const char *const filename, const char *const sub_dir, int *len);

char                                        *jo_fs_read_file_ptr(const char *const filename, void *buf, int *len);

void                                        jo_fs_get_read_stats(unsigned int * const vblanks, unsigned int * const bytes,
                                                                 unsigned int * const files, const bool reset);

static  __jo_force_inline char*             jo_fs_read_file(const char *const filename, int *len)
{
    return (jo_fs_read_file_ptr(filename, 0, len));
}

bool                                        jo_fs_read_file_async_ptr(const char *const filename, jo_fs_async_read_callback callback, int optional_token, void *buf);

static  __jo_force_inline bool              jo_fs_read_file_async(const char *const filename, jo_fs_async_read_callback callback, int optional_token)
{
    return (jo_fs_read_file_async_ptr(filename, callback, optional_token, 0));
}

bool                                        jo_fs_open(jo_file * const file, const char *const filename);

void                                        jo_fs_close(jo_file * const file);

void                                        jo_fs_set_read_sector_count(const int count);

int                                         jo_fs_read_next_bytes(jo_file * const file, char *buffer, unsigned int nbytes);

bool                                        jo_fs_seek_forward(jo_file * const file, unsigned int nbytes);
 
/*
** Internal usage
*/

int                                         __jo_fs_get_file_id(const char * const filename);

void                                        *__jo_fs_open(const int file_id);

void                                        __jo_fs_close(void *handle);

int                                         __jo_fs_get_file_size(void *handle);

int                                         __jo_fs_get_sector_count(void *handle);

bool                                        __jo_fs_seek_sector(void *handle, const int sector);

int                                         __jo_fs_read_sectors(void *handle, int sector_count, void *buf, const int buf_size);

void                                        __jo_cd_play_tracks(const int from_track, const int to_track, const unsigned char play_mode);

void                                        __jo_cd_play_from_fad(const unsigned int fad, const int from_track, const int to_track,
                                                                  const unsigned char play_mode);

# define JO_CD_DRIVE_PAUSE                          (0x01)
# define JO_CD_DRIVE_PLAY                           (0x03)

int                                         __jo_cd_get_status(unsigned int *fad);

void                                        __jo_cd_pause(void);
 
#endif /* !JO_COMPILE_WITH_FS_SUPPORT */
 
#endif /* !__JO_FS_H__ */
 
/*
** END OF FILE
*/