src/filemanager/panel.h

   1 /** \file panel.h
   2  *  \brief Header: defines WPanel structure
   3  */
   4
   5 #ifndef MC__PANEL_H
   6 #define MC__PANEL_H
   7
   8 #include <inttypes.h>           /* uintmax_t */
   9
  10 #include "lib/global.h"         /* gboolean */
  11 #include "lib/fs.h"             /* MC_MAXPATHLEN */
  12 #include "lib/strutil.h"
  13 #include "lib/widget.h"         /* Widget */
  14
  15 #include "dir.h"                /* dir_list */
  16
  17 /*** typedefs(not structures) and defined constants **********************************************/
  18
  19 #define selection(p) (&(p->dir.list[p->selected]))
  20 #define DEFAULT_USER_FORMAT "half type name | size | perm"
  21
  22 #define LIST_TYPES 4
  23
  24 #define UP_KEEPSEL ((char *) -1)
  25
  26 /*** enums ***************************************************************************************/
  27
  28 enum list_types
  29 {
  30     list_full,                  /* Name, size, perm/date */
  31     list_brief,                 /* Name */
  32     list_long,                  /* Like ls -l */
  33     list_user                   /* User defined */
  34 };
  35
  36 typedef enum
  37 {
  38     frame_full,                 /* full screen frame */
  39     frame_half                  /* half screen frame */
  40 } panel_display_t;
  41
  42 typedef enum
  43 {
  44     UP_OPTIMIZE = 0,
  45     UP_RELOAD = 1,
  46     UP_ONLY_CURRENT = 2
  47 } panel_update_flags_t;
  48
  49 /* run mode and params */
  50
  51 enum cd_enum
  52 {
  53     cd_parse_command,
  54     cd_exact
  55 };
  56
  57 /*** structures declarations (and typedefs of structures)*****************************************/
  58
  59 struct format_e;
  60
  61 typedef struct panel_field_struct
  62 {
  63     const char *id;
  64     int min_size;
  65     int expands;
  66     align_crt_t default_just;
  67     const char *hotkey;
  68     const char *title_hotkey;
  69     gboolean is_user_choice;
  70     gboolean use_in_user_format;
  71     const char *(*string_fn) (file_entry *, int);
  72     sortfn *sort_routine;       /* used by mouse_sort_col() */
  73 } panel_field_t;
  74
  75 typedef struct
  76 {
  77     dir_list list;
  78     int count;
  79     vfs_path_t *root_vpath;
  80 } panelized_panel_t;
  81
  82 typedef struct panel_sort_info_struct
  83 {
  84     gboolean reverse;           /* Show listing in reverse? */
  85     gboolean case_sensitive;    /* Listing is case sensitive? */
  86     gboolean exec_first;        /* Show executable top in list? */
  87     const panel_field_t *sort_field;
  88 } panel_sort_info_t;
  89
  90 typedef struct WPanel
  91 {
  92     Widget widget;
  93     dir_list dir;               /* Directory contents */
  94
  95     int list_type;              /* listing type (was view_type) */
  96     int active;                 /* If panel is currently selected */
  97     vfs_path_t *cwd_vpath;      /* Current Working Directory */
  98     vfs_path_t *lwd_vpath;      /* Last Working Directory */
  99     GList *dir_history;         /* directory history */
 100     GList *dir_history_current; /* pointer to the current history item */
 101     char *hist_name;            /* directory history name for history file */
 102     int count;                  /* Number of files in dir structure */
 103     int marked;                 /* Count of marked files */
 104     int dirs_marked;            /* Count of marked directories */
 105     uintmax_t total;            /* Bytes in marked files */
 106     int top_file;               /* The file showed on the top of the panel */
 107     int selected;               /* Index to the selected file */
 108     int split;                  /* Split panel to allow two columns */
 109     gboolean is_panelized;      /* Flag: special filelisting, can't reload */
 110     panel_display_t frame_size; /* half or full frame */
 111     char *filter;               /* File name filter */
 112     panel_sort_info_t sort_info;        /* Sort descriptor */
 113
 114     int dirty;                  /* Should we redisplay the panel? */
 115
 116     int user_mini_status;       /* Is user_status_format used */
 117     char *user_format;          /* User format */
 118     char *user_status_format[LIST_TYPES];       /* User format for status line */
 119
 120     struct format_e *format;    /* Display format */
 121     struct format_e *status_format;     /* Mini status format */
 122
 123     int format_modified;        /* If the format was changed this is set */
 124
 125     char *panel_name;           /* The panel name */
 126     struct stat dir_stat;       /* Stat of current dir: used by execute () */
 127
 128 #ifdef HAVE_CHARSET
 129     int codepage;               /* panel codepage */
 130 #endif
 131
 132     gboolean searching;
 133     char search_buffer[MC_MAXFILENAMELEN];
 134     char prev_search_buffer[MC_MAXFILENAMELEN];
 135     char search_char[MB_LEN_MAX];       /*buffer for multibytes characters */
 136     int search_chpoint;         /*point after last characters in search_char */
 137     int content_shift;          /* Number of characters of filename need to skip from left side. */
 138     int max_shift;              /* Max shift for visible part of current panel */
 139 } WPanel;
 140
 141 /*** global variables defined in .c file *********************************************************/
 142
 143 extern panelized_panel_t panelized_panel;
 144
 145 extern panel_field_t panel_fields[];
 146
 147 extern hook_t *select_file_hook;
 148
 149 /*** declarations of public functions ************************************************************/
 150
 151 WPanel *panel_new (const char *panel_name);
 152 WPanel *panel_new_with_dir (const char *panel_name, const char *dr);
 153 void panel_clean_dir (WPanel * panel);
 154
 155 void panel_reload (WPanel * panel);
 156 void panel_set_sort_order (WPanel * panel, const panel_field_t * sort_order);
 157 void panel_re_sort (WPanel * panel);
 158
 159 #ifdef HAVE_CHARSET
 160 void panel_change_encoding (WPanel * panel);
 161 vfs_path_t *remove_encoding_from_path (const vfs_path_t * vpath);
 162 #endif
 163
 164 void update_panels (panel_update_flags_t flags, const char *current_file);
 165 int set_panel_formats (WPanel * p);
 166 void panel_update_cols (Widget * widget, panel_display_t frame_size);
 167
 168 void try_to_select (WPanel * panel, const char *name);
 169
 170 void unmark_files (WPanel * panel);
 171 void select_item (WPanel * panel);
 172
 173 void recalculate_panel_summary (WPanel * panel);
 174 void file_mark (WPanel * panel, int idx, int val);
 175 void do_file_mark (WPanel * panel, int idx, int val);
 176
 177 gboolean do_panel_cd (struct WPanel *panel, const vfs_path_t * new_dir_vpath, enum cd_enum cd_type);
 178
 179 gsize panel_get_num_of_sortable_fields (void);
 180 const char **panel_get_sortable_fields (gsize *);
 181 const panel_field_t *panel_get_field_by_id (const char *);
 182 const panel_field_t *panel_get_field_by_title (const char *);
 183 const panel_field_t *panel_get_field_by_title_hotkey (const char *);
 184 gsize panel_get_num_of_user_possible_fields (void);
 185 const char **panel_get_user_possible_fields (gsize *);
 186 void panel_set_cwd (WPanel * panel, const char *path_str);
 187 void panel_set_lwd (WPanel * panel, const char *path_str);
 188
 189 void panel_init (void);
 190 void panel_deinit (void);
 191 gboolean do_cd (const vfs_path_t * new_dir_vpath, enum cd_enum cd_type);
 192
 193 /*** inline functions ****************************************************************************/
 194 #endif /* MC__PANEL_H */