4 * \brief Header: Virtual File System directory structure
8 #ifndef MC__VFS_XDIRENTRY_H
9 #define MC__VFS_XDIRENTRY_H
12 #include <sys/types.h>
14 #include "lib/global.h" /* GList */
15 #include "lib/vfs/path.h" /* vfs_path_t */
17 /*** typedefs(not structures) and defined constants **********************************************/
19 #define LINK_FOLLOW 15
20 #define LINK_NO_FOLLOW -1
22 /* For vfs_s_find_entry and vfs_s_find_inode */
31 /* For vfs_s_entry_from_path */
35 #define ERRNOR(a, b) do { me->verrno = a; return b; } while (0)
37 #define VFS_SUBCLASS(a) ((struct vfs_s_subclass *) (a))
39 #define VFS_SUPER(a) ((struct vfs_s_super *) (a))
40 #define CONST_VFS_SUPER(a) ((const struct vfs_s_super *) (a))
41 #define VFS_ENTRY(a) ((struct vfs_s_entry *) (a))
42 #define VFS_INODE(a) ((struct vfs_s_inode *) (a))
44 #define VFS_FILE_HANDLER(a) ((vfs_file_handler_t *) a)
45 #define VFS_FILE_HANDLER_SUPER(a) VFS_FILE_HANDLER (a)->ino->super
47 /*** enums ***************************************************************************************/
57 /*** structures declarations (and typedefs of structures)*****************************************/
59 /* Single connection or archive */
63 struct vfs_s_inode
*root
;
64 char *name
; /* My name, whatever it means */
65 int fd_usage
; /* Number of open files */
66 int ino_usage
; /* Usage count of this superblock */
67 gboolean want_stale
; /* If set, we do not flush cache properly */
69 vfs_path_element_t
*path_element
;
70 #endif /* ENABLE_VFS_NET */
74 * Single virtual file - directory entry. The same inode can have many
75 * entries (i.e. hard links), but usually has only one.
79 struct vfs_s_inode
*dir
; /* Directory we are in, i.e. our parent */
80 char *name
; /* Name of this entry */
81 struct vfs_s_inode
*ino
; /* ... and its inode */
82 ssize_t leading_spaces
; /* number of leading spases in the file name */
85 /* Single virtual file - inode */
88 struct vfs_s_super
*super
; /* Archive the file is on */
89 struct vfs_s_entry
*ent
; /* Our entry in the parent directory -
90 use only for directories because they
91 cannot be hardlinked */
92 GQueue
*subdir
; /* If this is a directory, its entry. List of vfs_s_entry */
93 struct stat st
; /* Parameters of this inode */
94 char *linkname
; /* Symlink's contents */
95 char *localname
; /* Filename of local file, if we have one */
96 gint64 timestamp
; /* Subclass specific */
97 off_t data_offset
; /* Subclass specific */
98 void *user_data
; /* Subclass specific */
101 /* Data associated with an open file */
104 struct vfs_s_inode
*ino
;
105 off_t pos
; /* This is for module's use */
106 int handle
; /* This is for module's use, but if != -1, will be mc_close()d */
107 gboolean changed
; /* Did this file change? */
108 vfs_linear_state_t linear
; /* Is that file open with O_LINEAR? */
109 } vfs_file_handler_t
;
112 * One of our subclasses (tar, cpio, shell, ftpfs) with data and methods.
115 struct vfs_s_subclass
117 struct vfs_class base
; /* base class */
124 int (*init_inode
) (struct vfs_class
* me
, struct vfs_s_inode
* ino
); /* optional */
125 void (*free_inode
) (struct vfs_class
* me
, struct vfs_s_inode
* ino
); /* optional */
126 int (*init_entry
) (struct vfs_class
* me
, struct vfs_s_entry
* entry
); /* optional */
128 void *(*archive_check
) (const vfs_path_t
* vpath
); /* optional */
129 int (*archive_same
) (const vfs_path_element_t
* vpath_element
, struct vfs_s_super
* psup
,
130 const vfs_path_t
* vpath
, void *cookie
);
131 struct vfs_s_super
*(*new_archive
) (struct vfs_class
* me
);
132 int (*open_archive
) (struct vfs_s_super
* psup
,
133 const vfs_path_t
* vpath
, const vfs_path_element_t
* vpath_element
);
134 void (*free_archive
) (struct vfs_class
* me
, struct vfs_s_super
* psup
);
136 vfs_file_handler_t
*(*fh_new
) (struct vfs_s_inode
* ino
, gboolean changed
);
137 int (*fh_open
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
, int flags
, mode_t mode
);
138 int (*fh_close
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
);
139 void (*fh_free
) (vfs_file_handler_t
* fh
);
141 struct vfs_s_entry
*(*find_entry
) (struct vfs_class
* me
,
142 struct vfs_s_inode
* root
,
143 const char *path
, int follow
, int flags
);
144 int (*dir_load
) (struct vfs_class
* me
, struct vfs_s_inode
* ino
, const char *path
);
145 gboolean (*dir_uptodate
) (struct vfs_class
* me
, struct vfs_s_inode
* ino
);
146 int (*file_store
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
, char *path
, char *localname
);
148 int (*linear_start
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
, off_t from
);
149 ssize_t (*linear_read
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
, void *buf
, size_t len
);
150 void (*linear_close
) (struct vfs_class
* me
, vfs_file_handler_t
* fh
);
154 /*** global variables defined in .c file *********************************************************/
156 /*** declarations of public functions ************************************************************/
158 /* entries and inodes */
159 struct vfs_s_inode
*vfs_s_new_inode (struct vfs_class
*me
,
160 struct vfs_s_super
*super
, struct stat
*initstat
);
161 void vfs_s_free_inode (struct vfs_class
*me
, struct vfs_s_inode
*ino
);
163 struct vfs_s_entry
*vfs_s_new_entry (struct vfs_class
*me
, const char *name
,
164 struct vfs_s_inode
*inode
);
165 void vfs_s_free_entry (struct vfs_class
*me
, struct vfs_s_entry
*ent
);
166 void vfs_s_insert_entry (struct vfs_class
*me
, struct vfs_s_inode
*dir
, struct vfs_s_entry
*ent
);
167 int vfs_s_entry_compare (const void *a
, const void *b
);
168 struct stat
*vfs_s_default_stat (struct vfs_class
*me
, mode_t mode
);
170 struct vfs_s_entry
*vfs_s_generate_entry (struct vfs_class
*me
, const char *name
,
171 struct vfs_s_inode
*parent
, mode_t mode
);
172 struct vfs_s_inode
*vfs_s_find_inode (struct vfs_class
*me
,
173 const struct vfs_s_super
*super
,
174 const char *path
, int follow
, int flags
);
175 struct vfs_s_inode
*vfs_s_find_root (struct vfs_class
*me
, struct vfs_s_entry
*entry
);
177 /* outside interface */
178 void vfs_init_subclass (struct vfs_s_subclass
*sub
, const char *name
, vfs_flags_t flags
,
180 const char *vfs_s_get_path (const vfs_path_t
* vpath
, struct vfs_s_super
**archive
, int flags
);
181 struct vfs_s_super
*vfs_get_super_by_vpath (const vfs_path_t
* vpath
);
183 void vfs_s_invalidate (struct vfs_class
*me
, struct vfs_s_super
*super
);
184 char *vfs_s_fullpath (struct vfs_class
*me
, struct vfs_s_inode
*ino
);
186 void vfs_s_init_fh (vfs_file_handler_t
* fh
, struct vfs_s_inode
*ino
, gboolean changed
);
188 /* network filesystems support */
189 int vfs_s_select_on_two (int fd1
, int fd2
);
190 int vfs_s_get_line (struct vfs_class
*me
, int sock
, char *buf
, int buf_len
, char term
);
191 int vfs_s_get_line_interruptible (struct vfs_class
*me
, char *buffer
, int size
, int fd
);
193 int vfs_s_retrieve_file (struct vfs_class
*me
, struct vfs_s_inode
*ino
);
195 void vfs_s_normalize_filename_leading_spaces (struct vfs_s_inode
*root_inode
, size_t final_filepos
);
197 /*** inline functions ****************************************************************************/
200 vfs_s_store_filename_leading_spaces (struct vfs_s_entry
*entry
, size_t position
)
202 entry
->leading_spaces
= (ssize_t
) position
;