226a5691 |
1 | /* Copyright (C) 2010-2020 The RetroArch team |
2 | * |
3 | * --------------------------------------------------------------------------------------- |
4 | * The following license statement only applies to this file (file_stream.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_FILE_STREAM_H |
24 | #define __LIBRETRO_SDK_FILE_STREAM_H |
25 | |
26 | #include <stdio.h> |
27 | #include <stdint.h> |
28 | #include <stdlib.h> |
29 | #include <stddef.h> |
30 | |
31 | #include <sys/types.h> |
32 | |
33 | #include <libretro.h> |
34 | #include <retro_common_api.h> |
35 | #include <retro_inline.h> |
36 | #include <boolean.h> |
37 | |
38 | #include <stdarg.h> |
39 | #include <vfs/vfs_implementation.h> |
40 | |
41 | #define FILESTREAM_REQUIRED_VFS_VERSION 2 |
42 | |
43 | RETRO_BEGIN_DECLS |
44 | |
45 | typedef struct RFILE RFILE; |
46 | |
47 | #define FILESTREAM_REQUIRED_VFS_VERSION 2 |
48 | |
49 | void filestream_vfs_init(const struct retro_vfs_interface_info* vfs_info); |
50 | |
51 | int64_t filestream_get_size(RFILE *stream); |
52 | |
53 | int64_t filestream_truncate(RFILE *stream, int64_t length); |
54 | |
55 | /** |
56 | * filestream_open: |
57 | * @path : path to file |
58 | * @mode : file mode to use when opening (read/write) |
59 | * @bufsize : optional buffer size (-1 or 0 to use default) |
60 | * |
61 | * Opens a file for reading or writing, depending on the requested mode. |
62 | * Returns a pointer to an RFILE if opened successfully, otherwise NULL. |
63 | **/ |
64 | RFILE* filestream_open(const char *path, unsigned mode, unsigned hints); |
65 | |
66 | int64_t filestream_seek(RFILE *stream, int64_t offset, int seek_position); |
67 | |
68 | int64_t filestream_read(RFILE *stream, void *data, int64_t len); |
69 | |
70 | int64_t filestream_write(RFILE *stream, const void *data, int64_t len); |
71 | |
72 | int64_t filestream_tell(RFILE *stream); |
73 | |
74 | void filestream_rewind(RFILE *stream); |
75 | |
76 | int filestream_close(RFILE *stream); |
77 | |
78 | int64_t filestream_read_file(const char *path, void **buf, int64_t *len); |
79 | |
80 | char* filestream_gets(RFILE *stream, char *s, size_t len); |
81 | |
82 | int filestream_getc(RFILE *stream); |
83 | |
84 | int filestream_scanf(RFILE *stream, const char* format, ...); |
85 | |
86 | int filestream_eof(RFILE *stream); |
87 | |
88 | bool filestream_write_file(const char *path, const void *data, int64_t size); |
89 | |
90 | int filestream_putc(RFILE *stream, int c); |
91 | |
92 | int filestream_vprintf(RFILE *stream, const char* format, va_list args); |
93 | |
94 | int filestream_printf(RFILE *stream, const char* format, ...); |
95 | |
96 | int filestream_error(RFILE *stream); |
97 | |
98 | int filestream_flush(RFILE *stream); |
99 | |
100 | int filestream_delete(const char *path); |
101 | |
102 | int filestream_rename(const char *old_path, const char *new_path); |
103 | |
104 | const char* filestream_get_path(RFILE *stream); |
105 | |
106 | bool filestream_exists(const char *path); |
107 | |
108 | /* Returned pointer must be freed by the caller. */ |
109 | char* filestream_getline(RFILE *stream); |
110 | |
111 | libretro_vfs_implementation_file* filestream_get_vfs_handle(RFILE *stream); |
112 | |
113 | RETRO_END_DECLS |
114 | |
115 | #endif |