1 /* Copyright  (C) 2010-2018 The RetroArch team
2 *
3 * ---------------------------------------------------------------------------------------
4 * The following license statement only applies to this file (vfs_implementation.h).
5 * ---------------------------------------------------------------------------------------
6 *
7 * Permission is hereby granted, free of charge,
8 * to any person obtaining a copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
11 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
16 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 */
22 
23 #ifndef __LIBRETRO_SDK_VFS_IMPLEMENTATION_H
24 #define __LIBRETRO_SDK_VFS_IMPLEMENTATION_H
25 
26 #include <stdint.h>
27 #include <libretro.h>
28 
29 /* Replace the following symbol with something appropriate
30  * to signify the file is being compiled for a front end instead of a core.
31  * This allows the same code to act as reference implementation
32  * for VFS and as fallbacks for when the front end does not provide VFS functionality.
33  */
34 
35 #ifdef VFS_FRONTEND
36 typedef struct retro_vfs_file_handle libretro_vfs_implementation_file;
37 #else
38 typedef struct libretro_vfs_implementation_file libretro_vfs_implementation_file;
39 #endif
40 
41 libretro_vfs_implementation_file *retro_vfs_file_open_impl(const char *path, unsigned mode, unsigned hints);
42 
43 int retro_vfs_file_close_impl(libretro_vfs_implementation_file *stream);
44 
45 int retro_vfs_file_error_impl(libretro_vfs_implementation_file *stream);
46 
47 int64_t retro_vfs_file_size_impl(libretro_vfs_implementation_file *stream);
48 
49 int64_t retro_vfs_file_tell_impl(libretro_vfs_implementation_file *stream);
50 
51 int64_t retro_vfs_file_seek_impl(libretro_vfs_implementation_file *stream, int64_t offset, int seek_position);
52 
53 int64_t retro_vfs_file_read_impl(libretro_vfs_implementation_file *stream, void *s, uint64_t len);
54 
55 int64_t retro_vfs_file_write_impl(libretro_vfs_implementation_file *stream, const void *s, uint64_t len);
56 
57 int retro_vfs_file_flush_impl(libretro_vfs_implementation_file *stream);
58 
59 int retro_vfs_file_remove_impl(const char *path);
60 
61 int retro_vfs_file_rename_impl(const char *old_path, const char *new_path);
62 
63 const char *retro_vfs_file_get_path_impl(libretro_vfs_implementation_file *stream);
64 
65 #endif
66