Jo Engine 2026.11.6
Jo Sega Saturn Engine
Loading...
Searching...
No Matches
fs.h
Go to the documentation of this file.
1/*
2** Jo Sega Saturn Engine
3** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
4** All rights reserved.
5**
6** Redistribution and use in source and binary forms, with or without
7** modification, are permitted provided that the following conditions are met:
8** * Redistributions of source code must retain the above copyright
9** notice, this list of conditions and the following disclaimer.
10** * Redistributions in binary form must reproduce the above copyright
11** notice, this list of conditions and the following disclaimer in the
12** documentation and/or other materials provided with the distribution.
13** * Neither the name of the Johannes Fetz nor the
14** names of its contributors may be used to endorse or promote products
15** derived from this software without specific prior written permission.
16**
17** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
21** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27*/
34
35#ifndef __JO_FS_H__
36# define __JO_FS_H__
37
38#ifdef JO_COMPILE_WITH_FS_SUPPORT
39
40/*
41** MACROS
42*/
44# define JO_ROOT_DIR ((const char *)0)
46# define JO_CURRENT_DIR ((const char *)0)
48# define JO_PARENT_DIR ("..")
49
50/*
51** TYPEDEFS
52*/
54typedef void (*jo_fs_async_read_callback)(char *contents, int length, int optional_token);
55
60bool jo_fs_cd(const char *const sub_dir);
61
66bool jo_fs_file_exists(const char *const filename);
67
74char* jo_fs_read_file_in_dir(const char *const filename, const char *const sub_dir, int *len);
75
85char *jo_fs_read_file_ptr(const char *const filename, void *buf, int *len);
86
93void jo_fs_get_read_stats(unsigned int * const vblanks, unsigned int * const bytes,
94 unsigned int * const files, const bool reset);
95
101static __jo_force_inline char* jo_fs_read_file(const char *const filename, int *len)
102{
103 return (jo_fs_read_file_ptr(filename, 0, len));
104}
105
116bool jo_fs_read_file_async_ptr(const char *const filename, jo_fs_async_read_callback callback, int optional_token, void *buf);
117
122
129static __jo_force_inline bool jo_fs_read_file_async(const char *const filename, jo_fs_async_read_callback callback, int optional_token)
130{
131 return (jo_fs_read_file_async_ptr(filename, callback, optional_token, 0));
132}
133
141bool jo_fs_open(jo_file * const file, const char *const filename);
142
146void jo_fs_close(jo_file * const file);
147
154void jo_fs_set_read_sector_count(const int count);
155
164int jo_fs_read_next_bytes(jo_file * const file, char *buffer, unsigned int nbytes);
165
172static __jo_force_inline bool jo_fs_read_exact(jo_file * const file, void * const buffer, const unsigned int nbytes)
173{
174 return (jo_fs_read_next_bytes(file, (char *)buffer, nbytes) == (int)nbytes);
175}
176
182bool jo_fs_seek_forward(jo_file * const file, unsigned int nbytes);
183
185# define JO_CD_DRIVE_PAUSE (0x01)
187# define JO_CD_DRIVE_PLAY (0x03)
188
189#endif /* !JO_COMPILE_WITH_FS_SUPPORT */
190
191#endif /* !__JO_FS_H__ */
192
193/*
194** END OF FILE
195*/
void(*) jo_fs_async_read_callback(char *contents, int length, int optional_token)
Function prototype for ().
Definition fs.h:54
char * jo_fs_read_file_in_dir(const char *const filename, const char *const sub_dir, int *len)
Read a file on the CD.
bool jo_fs_seek_forward(jo_file *const file, unsigned int nbytes)
Seek forward from current position of a file.
char * jo_fs_read_file_ptr(const char *const filename, void *buf, int *len)
Read a file on the CD and put the contents to "buf".
bool jo_fs_file_exists(const char *const filename)
Check if a file is in the current directory of the CD (no error printed when it is not: an optional f...
bool jo_fs_cd(const char *const sub_dir)
Change the current directory (equivalent of Unix cd command).
static __jo_force_inline bool jo_fs_read_file_async(const char *const filename, jo_fs_async_read_callback callback, int optional_token)
Read a file on the CD asynchronously.
Definition fs.h:129
static __jo_force_inline bool jo_fs_read_exact(jo_file *const file, void *const buffer, const unsigned int nbytes)
Read bytes from a file: all of them.
Definition fs.h:172
bool jo_fs_read_file_async_ptr(const char *const filename, jo_fs_async_read_callback callback, int optional_token, void *buf)
Read a file on the CD asynchronously and put the contents to "buf".
void jo_fs_close(jo_file *const file)
Close a file.
static __jo_force_inline char * jo_fs_read_file(const char *const filename, int *len)
Read a file on the CD.
Definition fs.h:101
void jo_fs_set_read_sector_count(const int count)
Set the size of the read buffer of the files opened by jo_fs_open().
bool jo_fs_open(jo_file *const file, const char *const filename)
Open a file.
void jo_fs_get_read_stats(unsigned int *const vblanks, unsigned int *const bytes, unsigned int *const files, const bool reset)
Statistics of the files read by jo_fs_read_file_ptr() (the time of a loading: the CD or the CPU).
void jo_fs_wait_background_jobs(void)
Wait for the end of the reads of jo_fs_read_file_async() (their callbacks called, the files they star...
int jo_fs_read_next_bytes(jo_file *const file, char *buffer, unsigned int nbytes)
Read bytes from a file.
#define __jo_force_inline
force inline attribute (and prevent Doxygen prototype parsing bug)
Definition types.h:39
File definition.
Definition types.h:311