janwas
26d2fc71ad
vfs: move public functions into vfs.cpp to avoid confusion (except vfs_mount in vfs_mount.cpp, but that's obvious) h_mgr: fix bug in filename display causing dir names to be truncated main/gamesetup: replace 2 bools with flags; remove Atlas trampoline functions (clutters up main.cpp) atlas: use GameSetup.h instead of extern .. This was SVN commit r2983.
143 lines
3.4 KiB
C
143 lines
3.4 KiB
C
#ifndef VFS_MOUNT_H__
|
|
#define VFS_MOUNT_H__
|
|
|
|
#include "file.h"
|
|
#include "zip.h"
|
|
|
|
extern void mount_init();
|
|
extern void mount_shutdown();
|
|
|
|
struct Mount;
|
|
|
|
|
|
// If it was possible to forward-declare enums in gcc, this one wouldn't be in
|
|
// the header. Don't use.
|
|
enum MountType
|
|
{
|
|
// the relative ordering of values expresses efficiency of the sources
|
|
// (e.g. archives are faster than loose files). mount_should_replace
|
|
// makes use of this.
|
|
|
|
MT_NONE = 0,
|
|
MT_FILE = 1,
|
|
MT_ARCHIVE = 2
|
|
};
|
|
|
|
|
|
struct XIo
|
|
{
|
|
enum MountType type; // internal use only
|
|
union XIoUnion
|
|
{
|
|
FileIo fio;
|
|
ZipIo zio;
|
|
}
|
|
u;
|
|
};
|
|
|
|
|
|
struct TFile;
|
|
|
|
struct XFile
|
|
{
|
|
enum MountType type; // internal use only
|
|
|
|
// pointer to VFS file info storage; used to update size/mtime
|
|
// after a newly written file is closed.
|
|
TFile* tf;
|
|
|
|
union XFileUnion
|
|
{
|
|
File f;
|
|
ZFile zf;
|
|
}
|
|
u;
|
|
};
|
|
|
|
|
|
// given a Mount, return the actual location (portable path) of
|
|
// <V_path>. used by vfs_realpath and VFile_reopen.
|
|
extern int x_realpath(const Mount* m, const char* V_exact_path, char* P_real_path);
|
|
|
|
extern int x_open(const Mount* m, const char* V_exact_path, int flags, TFile* tf, XFile* xf);
|
|
extern int x_close(XFile* xf);
|
|
|
|
extern int x_validate(const XFile* xf);
|
|
|
|
extern bool x_is_open(const XFile* xf);
|
|
extern off_t x_size(const XFile* xf);
|
|
extern uint x_flags(const XFile* xf);
|
|
extern void x_set_flags(XFile* xf, uint flags);
|
|
|
|
extern int x_io(XFile* xf, off_t ofs, size_t size, void* buf, FileIOCB cb, uintptr_t ctx);;
|
|
|
|
extern int x_map(XFile* xf, void*& p, size_t& size);
|
|
extern int x_unmap(XFile* xf);
|
|
|
|
extern int x_io_issue(XFile* xf, off_t ofs, size_t size, void* buf, XIo* xio);
|
|
extern int x_io_has_completed(XIo* xio);
|
|
extern int x_io_wait(XIo* xio, void*& p, size_t& size);
|
|
extern int x_io_discard(XIo* xio);
|
|
extern int x_io_validate(const XIo* xio);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
// accessor routines that obviate the need to access Mount fields directly:
|
|
//
|
|
|
|
extern bool mount_should_replace(const Mount* m_old, const Mount* m_new,
|
|
bool files_are_identical);
|
|
|
|
extern char mount_get_type(const Mount* m);
|
|
|
|
|
|
|
|
// stored by vfs_tree in TDir
|
|
struct RealDir
|
|
{
|
|
// if exactly one real directory is mounted into this virtual dir,
|
|
// this points to its location. used to add files to VFS when writing.
|
|
//
|
|
// the Mount is actually in the mount info and is invalid when
|
|
// that's unmounted, but the VFS would then be rebuilt anyway.
|
|
//
|
|
// = 0 if no real dir mounted here; = -1 if more than one.
|
|
const Mount* m;
|
|
#ifndef NO_DIR_WATCH
|
|
intptr_t watch;
|
|
#endif
|
|
};
|
|
|
|
extern int mount_attach_real_dir(RealDir* rd, const char* P_path, const Mount* m, int flags);
|
|
extern void mount_detach_real_dir(RealDir* rd);
|
|
|
|
struct TDir;
|
|
extern int mount_populate(TDir* td, RealDir* rd);
|
|
|
|
|
|
// rebuild the VFS, i.e. re-mount everything. open files are not affected.
|
|
// necessary after loose files or directories change, so that the VFS
|
|
// "notices" the changes and updates file locations. res calls this after
|
|
// dir_watch reports changes; can also be called from the console after a
|
|
// rebuild command. there is no provision for updating single VFS dirs -
|
|
// it's not worth the trouble.
|
|
extern int mount_rebuild();
|
|
|
|
// if <path> or its ancestors are mounted,
|
|
// return a VFS path that accesses it.
|
|
// used when receiving paths from external code.
|
|
extern int mount_make_vfs_path(const char* P_path, char* V_path);
|
|
|
|
#endif // #ifndef VFS_MOUNT_H__
|