annotate src/libmlk-core/core/vfs.h @ 423:63ebfa352ae1

core: use err.h in font
author David Demelier <markand@malikania.fr>
date Sat, 15 Oct 2022 14:00:38 +0200
parents e6f972e04519
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * vfs.h -- virtual file system abstraction
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
378
460c78706989 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 339
diff changeset
4 * Copyright (c) 2020-2022 David Demelier <markand@malikania.fr>
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MLK_CORE_VFS_H
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MLK_CORE_VFS_H
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
407
e6f972e04519 tests: don't use automatic feature
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
22 #include <stddef.h>
e6f972e04519 tests: don't use automatic feature
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
23
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include "core.h"
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct vfs_file;
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 struct vfs {
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 void *data;
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 int (*open)(struct vfs *, struct vfs_file *, const char *, const char *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 void (*finish)(struct vfs *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 };
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct vfs_file {
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 void *data;
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 size_t (*read)(struct vfs_file *, void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 size_t (*write)(struct vfs_file *, const void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 int (*flush)(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 void (*finish)(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 };
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 CORE_BEGIN_DECLS
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 /* vfs */
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 int
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 vfs_open(struct vfs *, struct vfs_file *, const char *, const char *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
339
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
49 int
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
50 vfs_ok(struct vfs *);
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
51
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 void
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 vfs_finish(struct vfs *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 /* vfs_file */
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
339
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
57 int
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
58 vfs_file_ok(struct vfs_file *);
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
59
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 size_t
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 vfs_file_read(struct vfs_file *, void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
339
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
63 char *
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
64 vfs_file_aread(struct vfs_file *, size_t *);
979960e65f76 js: add font bindings
David Demelier <markand@malikania.fr>
parents: 332
diff changeset
65
332
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 size_t
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 vfs_file_write(struct vfs_file *, void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 int
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 vfs_file_flush(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 void
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 vfs_file_finish(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 CORE_END_DECLS
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 #endif /* MLK_CORE_VFS_H */