Mercurial > molko

annotate src/libmlk-core/core/vfs.h @ 332:8eee6f92e9ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: implement vfs and vfs-directory
author David Demelier <markand@malikania.fr>
date Wed, 13 Oct 2021 15:03:18 +0200
parents
children 979960e65f76
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 *
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020-2021 David Demelier <markand@malikania.fr>
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
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include "core.h"
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct vfs_file;
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 {
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 void *data;
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 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
29 void (*finish)(struct vfs *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 };
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 struct vfs_file {
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 void *data;
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 size_t (*read)(struct vfs_file *, void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 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
36 int (*flush)(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void (*finish)(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 };
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 CORE_BEGIN_DECLS
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 /* vfs */
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 int
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 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
46
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 void
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 vfs_finish(struct vfs *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 /* vfs_file */
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 size_t
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 vfs_file_read(struct vfs_file *, void *, size_t);
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 size_t
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 vfs_file_write(struct vfs_file *, void *, size_t);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 int
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 vfs_file_flush(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 void
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 vfs_file_finish(struct vfs_file *);
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 CORE_END_DECLS
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
8eee6f92e9ce core: implement vfs and vfs-directory
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 #endif /* MLK_CORE_VFS_H */