mirror of
https://github.com/MidnightCommander/mc
synced 2024-12-23 04:46:55 +03:00
186 lines
7.3 KiB
C
186 lines
7.3 KiB
C
|
|
/**
|
|
* \file
|
|
* \brief Header: Virtual File System directory structure
|
|
*/
|
|
|
|
|
|
#ifndef MC__VFS_XDIRENTRY_H
|
|
#define MC__VFS_XDIRENTRY_H
|
|
|
|
#include <stdio.h>
|
|
#include <sys/types.h>
|
|
|
|
#include "lib/global.h" /* GList */
|
|
#include "lib/vfs/path.h" /* vfs_path_t */
|
|
|
|
/*** typedefs(not structures) and defined constants **********************************************/
|
|
|
|
#define LINK_FOLLOW 15
|
|
#define LINK_NO_FOLLOW -1
|
|
|
|
/* For vfs_s_find_entry */
|
|
#define FL_NONE 0
|
|
#define FL_MKDIR 1
|
|
#define FL_MKFILE 2
|
|
#define FL_DIR 4
|
|
|
|
/* For open_super */
|
|
#define FL_NO_OPEN 1
|
|
|
|
/* For vfs_s_entry_from_path */
|
|
#define FL_FOLLOW 1
|
|
#define FL_DIR 4
|
|
|
|
/* For vfs_s_subclass->flags */
|
|
#define VFS_S_REMOTE 1
|
|
#define VFS_S_READONLY 2
|
|
|
|
#define ERRNOR(a, b) do { me->verrno = a; return b; } while (0)
|
|
|
|
#define MEDATA ((struct vfs_s_subclass *) me->data)
|
|
|
|
#define VFSDATA(a) ((a->class != NULL) ? (struct vfs_s_subclass *) a->class->data : NULL)
|
|
|
|
#define FH ((vfs_file_handler_t *) fh)
|
|
#define FH_SUPER FH->ino->super
|
|
|
|
#define LS_NOT_LINEAR 0
|
|
#define LS_LINEAR_CLOSED 1
|
|
#define LS_LINEAR_OPEN 2
|
|
#define LS_LINEAR_PREOPEN 3
|
|
|
|
/*** enums ***************************************************************************************/
|
|
|
|
/*** structures declarations (and typedefs of structures)*****************************************/
|
|
|
|
/* Single connection or archive */
|
|
struct vfs_s_super
|
|
{
|
|
struct vfs_class *me;
|
|
struct vfs_s_inode *root;
|
|
char *name; /* My name, whatever it means */
|
|
int fd_usage; /* Number of open files */
|
|
int ino_usage; /* Usage count of this superblock */
|
|
int want_stale; /* If set, we do not flush cache properly */
|
|
#ifdef ENABLE_VFS_NET
|
|
vfs_path_element_t *path_element;
|
|
#endif /* ENABLE_VFS_NET */
|
|
|
|
void *data; /* This is for filesystem-specific use */
|
|
};
|
|
|
|
/*
|
|
* Single virtual file - directory entry. The same inode can have many
|
|
* entries (i.e. hard links), but usually has only one.
|
|
*/
|
|
struct vfs_s_entry
|
|
{
|
|
struct vfs_s_inode *dir; /* Directory we are in, i.e. our parent */
|
|
char *name; /* Name of this entry */
|
|
struct vfs_s_inode *ino; /* ... and its inode */
|
|
};
|
|
|
|
/* Single virtual file - inode */
|
|
struct vfs_s_inode
|
|
{
|
|
struct vfs_s_super *super; /* Archive the file is on */
|
|
struct vfs_s_entry *ent; /* Our entry in the parent directory -
|
|
use only for directories because they
|
|
cannot be hardlinked */
|
|
GList *subdir; /* If this is a directory, its entry. List of vfs_s_entry */
|
|
struct stat st; /* Parameters of this inode */
|
|
char *linkname; /* Symlink's contents */
|
|
char *localname; /* Filename of local file, if we have one */
|
|
struct timeval timestamp; /* Subclass specific */
|
|
off_t data_offset; /* Subclass specific */
|
|
};
|
|
|
|
/* Data associated with an open file */
|
|
typedef struct
|
|
{
|
|
struct vfs_s_inode *ino;
|
|
off_t pos; /* This is for module's use */
|
|
int handle; /* This is for module's use, but if != -1, will be mc_close()d */
|
|
int changed; /* Did this file change? */
|
|
int linear; /* Is that file open with O_LINEAR? */
|
|
void *data; /* This is for filesystem-specific use */
|
|
} vfs_file_handler_t;
|
|
|
|
/*
|
|
* One of our subclasses (tar, cpio, fish, ftpfs) with data and methods.
|
|
* Extends vfs_class. Stored in the "data" field of vfs_class.
|
|
*/
|
|
struct vfs_s_subclass
|
|
{
|
|
GList *supers;
|
|
int inode_counter;
|
|
int flags; /* whether the subclass is remove, read-only etc */
|
|
dev_t rdev;
|
|
FILE *logfile;
|
|
int flush; /* if set to 1, invalidate directory cache */
|
|
|
|
int (*init_inode) (struct vfs_class * me, struct vfs_s_inode * ino); /* optional */
|
|
void (*free_inode) (struct vfs_class * me, struct vfs_s_inode * ino); /* optional */
|
|
int (*init_entry) (struct vfs_class * me, struct vfs_s_entry * entry); /* optional */
|
|
|
|
void *(*archive_check) (const vfs_path_t * vpath); /* optional */
|
|
int (*archive_same) (const vfs_path_element_t * vpath_element, struct vfs_s_super * psup,
|
|
const vfs_path_t * vpath, void *cookie);
|
|
int (*open_archive) (struct vfs_s_super * psup,
|
|
const vfs_path_t * vpath, const vfs_path_element_t * vpath_element);
|
|
void (*free_archive) (struct vfs_class * me, struct vfs_s_super * psup);
|
|
|
|
int (*fh_open) (struct vfs_class * me, vfs_file_handler_t * fh, int flags, mode_t mode);
|
|
int (*fh_close) (struct vfs_class * me, vfs_file_handler_t * fh);
|
|
|
|
struct vfs_s_entry *(*find_entry) (struct vfs_class * me,
|
|
struct vfs_s_inode * root,
|
|
const char *path, int follow, int flags);
|
|
int (*dir_load) (struct vfs_class * me, struct vfs_s_inode * ino, char *path);
|
|
int (*dir_uptodate) (struct vfs_class * me, struct vfs_s_inode * ino);
|
|
int (*file_store) (struct vfs_class * me, vfs_file_handler_t * fh, char *path, char *localname);
|
|
|
|
int (*linear_start) (struct vfs_class * me, vfs_file_handler_t * fh, off_t from);
|
|
int (*linear_read) (struct vfs_class * me, vfs_file_handler_t * fh, void *buf, size_t len);
|
|
void (*linear_close) (struct vfs_class * me, vfs_file_handler_t * fh);
|
|
};
|
|
|
|
/*** global variables defined in .c file *********************************************************/
|
|
|
|
/*** declarations of public functions ************************************************************/
|
|
|
|
/* entries and inodes */
|
|
struct vfs_s_inode *vfs_s_new_inode (struct vfs_class *me,
|
|
struct vfs_s_super *super, struct stat *initstat);
|
|
struct vfs_s_entry *vfs_s_new_entry (struct vfs_class *me, const char *name,
|
|
struct vfs_s_inode *inode);
|
|
void vfs_s_free_entry (struct vfs_class *me, struct vfs_s_entry *ent);
|
|
void vfs_s_insert_entry (struct vfs_class *me, struct vfs_s_inode *dir, struct vfs_s_entry *ent);
|
|
struct stat *vfs_s_default_stat (struct vfs_class *me, mode_t mode);
|
|
|
|
struct vfs_s_entry *vfs_s_generate_entry (struct vfs_class *me, const char *name,
|
|
struct vfs_s_inode *parent, mode_t mode);
|
|
struct vfs_s_inode *vfs_s_find_inode (struct vfs_class *me,
|
|
const struct vfs_s_super *super,
|
|
const char *path, int follow, int flags);
|
|
struct vfs_s_inode *vfs_s_find_root (struct vfs_class *me, struct vfs_s_entry *entry);
|
|
|
|
/* outside interface */
|
|
void vfs_s_init_class (struct vfs_class *vclass, struct vfs_s_subclass *sub);
|
|
const char *vfs_s_get_path_mangle (const vfs_path_t * vpath, struct vfs_s_super **archive,
|
|
int flags);
|
|
|
|
void vfs_s_invalidate (struct vfs_class *me, struct vfs_s_super *super);
|
|
char *vfs_s_fullpath (struct vfs_class *me, struct vfs_s_inode *ino);
|
|
|
|
/* network filesystems support */
|
|
int vfs_s_select_on_two (int fd1, int fd2);
|
|
int vfs_s_get_line (struct vfs_class *me, int sock, char *buf, int buf_len, char term);
|
|
int vfs_s_get_line_interruptible (struct vfs_class *me, char *buffer, int size, int fd);
|
|
/* misc */
|
|
int vfs_s_retrieve_file (struct vfs_class *me, struct vfs_s_inode *ino);
|
|
|
|
/*** inline functions ****************************************************************************/
|
|
#endif
|