lib/vfs/path.h

   1 #ifndef MC__VFS_PATH_H
   2 #define MC__VFS_PATH_H
   3
   4 /*** typedefs(not structures) and defined constants **********************************************/
   5
   6 #define VFS_PATH_URL_DELIMITER "://"
   7
   8 /*** enums ***************************************************************************************/
   9
  10 /*** structures declarations (and typedefs of structures)*****************************************/
  11
  12 struct vfs_class;
  13 struct vfs_url_struct;
  14
  15 typedef struct
  16 {
  17     GList *path;
  18 } vfs_path_t;
  19
  20 typedef struct
  21 {
  22     char *user;
  23     char *password;
  24     char *host;
  25     int port;
  26     char *path;
  27     struct vfs_class *class;
  28     char *encoding;
  29     char *vfs_prefix;
  30
  31     struct
  32     {
  33         GIConv converter;
  34         DIR *info;
  35     } dir;
  36 } vfs_path_element_t;
  37
  38 /*** global variables defined in .c file *********************************************************/
  39
  40 /*** declarations of public functions ************************************************************/
  41
  42 vfs_path_t *vfs_path_new (void);
  43 vfs_path_t *vfs_path_clone (const vfs_path_t * vpath);
  44 void vfs_path_remove_element_by_index (vfs_path_t * vpath, int element_index);
  45 void vfs_path_free (vfs_path_t * path);
  46 int vfs_path_elements_count (const vfs_path_t * path);
  47
  48 char *vfs_path_to_str (const vfs_path_t * path);
  49 char *vfs_path_to_str_elements_count (const vfs_path_t * path, int elements_count);
  50 vfs_path_t *vfs_path_from_str (const char *path_str);
  51
  52 vfs_path_element_t *vfs_path_get_by_index (const vfs_path_t * path, int element_index);
  53 vfs_path_element_t *vfs_path_element_clone (const vfs_path_element_t * element);
  54 void vfs_path_element_free (vfs_path_element_t * element);
  55
  56 struct vfs_class *vfs_prefix_to_class (const char *prefix);
  57
  58 gboolean vfs_path_element_need_cleanup_converter (const vfs_path_element_t * element);
  59
  60 char *vfs_path_serialize (const vfs_path_t * vpath, GError ** error);
  61 vfs_path_t *vfs_path_deserialize (const char *data, GError ** error);
  62
  63 /*** inline functions ****************************************************************************/
  64
  65 static inline gboolean
  66 vfs_path_element_valid (const vfs_path_element_t * element)
  67 {
  68     return (element != NULL && element->class != NULL);
  69 }
  70
  71 #endif