root/src/filemanager/panel.h

/*   */

INCLUDED FROM

DEFINITIONS

1. panel_empty_new
2. panel_with_dir_new
3. panel_new
4. panel_sized_new

   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 #include <limits.h>    // MB_LEN_MAX
  10 
  11 #include "lib/global.h"  // gboolean
  12 #include "lib/fs.h"      // MC_MAXPATHLEN
  13 #include "lib/strutil.h"
  14 #include "lib/widget.h"  // Widget
  15 #include "lib/filehighlight.h"
  16 #include "lib/file-entry.h"
  17 
  18 #include "dir.h"  // dir_list
  19 
  20 /*** typedefs(not structures) and defined constants **********************************************/
  21 
  22 #define PANEL(x)     ((WPanel *) (x))
  23 
  24 #define LIST_FORMATS 4
  25 
  26 #define UP_KEEPSEL   ((char *) -1)
  27 
  28 /*** enums ***************************************************************************************/
  29 
  30 typedef enum
  31 {
  32     list_full,   // Name, size, perm/date
  33     list_brief,  // Name
  34     list_long,   // Like ls -l
  35     list_user    // User defined
  36 } list_format_t;
  37 
  38 typedef enum
  39 {
  40     frame_full,  // full screen frame
  41     frame_half   // half screen frame
  42 } panel_display_t;
  43 
  44 typedef enum
  45 {
  46     UP_OPTIMIZE = 0,
  47     UP_RELOAD = 1,
  48     UP_ONLY_CURRENT = 2
  49 } panel_update_flags_t;
  50 
  51 /* run mode and params */
  52 enum cd_enum
  53 {
  54     cd_parse_command,
  55     cd_exact
  56 };
  57 
  58 /*** structures declarations (and typedefs of structures)*****************************************/
  59 
  60 typedef struct panel_field_struct
  61 {
  62     const char *id;
  63     int min_size;
  64     gboolean expands;
  65     align_crt_t default_just;
  66     const char *hotkey;
  67     const char *title_hotkey;
  68     gboolean is_user_choice;
  69     gboolean use_in_user_format;
  70     const char *(*string_fn) (const file_entry_t *fe, int len);
  71     GCompareFunc sort_routine;  // used by mouse_sort_col()
  72 } panel_field_t;
  73 
  74 typedef struct
  75 {
  76     dir_list list;
  77     vfs_path_t *root_vpath;
  78 } panelized_descr_t;
  79 
  80 typedef struct
  81 {
  82     Widget widget;
  83 
  84     char *name;  // The panel name
  85 
  86     panel_display_t frame_size;  // half or full frame
  87 
  88     gboolean dirty;  // Should we redisplay the panel?
  89 
  90     gboolean is_panelized;               // Panelization: special mode, can't reload the file list
  91     panelized_descr_t *panelized_descr;  // Panelization descriptor
  92 
  93     int codepage;  // Panel codepage
  94 
  95     dir_list dir;          // Directory contents
  96     struct stat dir_stat;  // Stat of current dir: used by execute ()
  97 
  98     vfs_path_t *cwd_vpath;  // Current Working Directory
  99     vfs_path_t *lwd_vpath;  // Last Working Directory
 100 
 101     list_format_t list_format;  // Listing type
 102     GSList *format;             // Display format
 103     char *user_format;          // User format
 104     int list_cols;              // Number of file list columns
 105     int brief_cols;             // Number of columns in case of list_brief format
 106     // sort
 107     dir_sort_options_t sort_info;
 108     const panel_field_t *sort_field;
 109 
 110     int marked;       // Count of marked files
 111     int dirs_marked;  // Count of marked directories
 112     uintmax_t total;  // Bytes in marked files
 113 
 114     int top;      // The file shown on the top of the panel
 115     int current;  // Index to the currently selected file
 116 
 117     GSList *status_format;                   // Mini status format
 118     gboolean user_mini_status;               // Is user_status_format used
 119     char *user_status_format[LIST_FORMATS];  // User format for status line
 120 
 121     file_filter_t filter;  // File name filter
 122 
 123     struct
 124     {
 125         char *name;      // Directory history name for history file
 126         GList *list;     // Directory history
 127         GList *current;  // Pointer to the current history item
 128     } dir_history;
 129 
 130     struct
 131     {
 132         gboolean active;
 133         GString *buffer;
 134         GString *prev_buffer;
 135         char ch[MB_LEN_MAX];  // Buffer for multi-byte character
 136         int chpoint;          // Point after last characters in @ch
 137     } quick_search;
 138 
 139     unsigned int content_shift;  // Number of characters of filename need to skip from left side
 140     unsigned int max_shift;      // Max shift for visible part of current panel
 141 } WPanel;
 142 
 143 /*** global variables defined in .c file *********************************************************/
 144 
 145 extern hook_t *select_file_hook;
 146 
 147 extern mc_fhl_t *mc_filehighlight;
 148 
 149 /*** declarations of public functions ************************************************************/
 150 
 151 WPanel *panel_sized_empty_new (const char *panel_name, const WRect *r);
 152 WPanel *panel_sized_with_dir_new (const char *panel_name, const WRect *r, const vfs_path_t *vpath);
 153 
 154 void panel_clean_dir (WPanel *panel);
 155 
 156 void panel_reload (WPanel *panel);
 157 void panel_set_sort_order (WPanel *panel, const panel_field_t *sort_order);
 158 void panel_re_sort (WPanel *panel);
 159 
 160 void panel_change_encoding (WPanel *panel);
 161 vfs_path_t *remove_encoding_from_path (const vfs_path_t *vpath);
 162 
 163 void update_panels (panel_update_flags_t flags, const char *current_file);
 164 int set_panel_formats (WPanel *p);
 165 
 166 void panel_set_filter (WPanel *panel, const file_filter_t *filter);
 167 
 168 file_entry_t *panel_current_entry (const WPanel *panel);
 169 void panel_set_current_by_name (WPanel *panel, const char *name);
 170 
 171 void unmark_files (WPanel *panel);
 172 void select_item (WPanel *panel);
 173 
 174 void recalculate_panel_summary (WPanel *panel);
 175 void file_mark (WPanel *panel, int idx, int val);
 176 void do_file_mark (WPanel *panel, int idx, int val);
 177 const GString *panel_find_marked_file (const WPanel *panel, int *current_file);
 178 const GString *panel_get_marked_file (const WPanel *panel, int *current_file);
 179 
 180 gboolean panel_do_cd (WPanel *panel, const vfs_path_t *new_dir_vpath, enum cd_enum cd_type);
 181 MC_MOCKABLE gboolean panel_cd (WPanel *panel, const vfs_path_t *new_dir_vpath,
 182                                enum cd_enum cd_type);
 183 
 184 gsize panel_get_num_of_sortable_fields (void);
 185 char **panel_get_sortable_fields (gsize *array_size);
 186 const panel_field_t *panel_get_field_by_id (const char *name);
 187 const panel_field_t *panel_get_field_by_title (const char *name);
 188 const panel_field_t *panel_get_field_by_title_hotkey (const char *name);
 189 gsize panel_get_num_of_user_possible_fields (void);
 190 char **panel_get_user_possible_fields (gsize *array_size);
 191 void panel_set_cwd (WPanel *panel, const vfs_path_t *vpath);
 192 void panel_set_lwd (WPanel *panel, const vfs_path_t *vpath);
 193 
 194 void panel_panelize_restore (void);
 195 void panel_panelize_change_root (WPanel *panel, const vfs_path_t *new_root);
 196 void panel_panelize_absolutize_if_needed (WPanel *panel);
 197 void panel_panelize_save (WPanel *panel);
 198 
 199 void panel_init (void);
 200 void panel_deinit (void);
 201 
 202 /* --------------------------------------------------------------------------------------------- */
 203 /*** inline functions ****************************************************************************/
 204 /* --------------------------------------------------------------------------------------------- */
 205 /**
 206  * Empty panel creation.
 207  *
 208  * @param panel_name name of panel for setup retrieving
 209  *
 210  * @return new instance of WPanel
 211  */
 212 
 213 static inline WPanel *
 214 panel_empty_new (const char *panel_name)
     /*   */
 215 {
 216     // Unknown sizes of the panel at startup
 217     WRect r = { 0, 0, 1, 1 };
 218 
 219     return panel_sized_empty_new (panel_name, &r);
 220 }
 221 
 222 /* --------------------------------------------------------------------------------------------- */
 223 /**
 224  * Panel creation for specified directory.
 225  *
 226  * @param panel_name name of panel for setup retrieving
 227  * @param vpath working panel directory. If NULL then current directory is used
 228  *
 229  * @return new instance of WPanel
 230  */
 231 
 232 static inline WPanel *
 233 panel_with_dir_new (const char *panel_name, const vfs_path_t *vpath)
     /*   */
 234 {
 235     // Unknown sizes of the panel at startup
 236     WRect r = { 0, 0, 1, 1 };
 237 
 238     return panel_sized_with_dir_new (panel_name, &r, vpath);
 239 }
 240 
 241 /* --------------------------------------------------------------------------------------------- */
 242 /**
 243  * Panel creation.
 244  *
 245  * @param panel_name name of panel for setup retrieving
 246  *
 247  * @return new instance of WPanel
 248  */
 249 
 250 static inline WPanel *
 251 panel_new (const char *panel_name)
     /*   */
 252 {
 253     return panel_with_dir_new (panel_name, NULL);
 254 }
 255 
 256 /* --------------------------------------------------------------------------------------------- */
 257 /**
 258  * Panel creation with specified size.
 259  *
 260  * @param panel_name name of panel for setup retrieving
 261  * @param r panel area
 262  *
 263  * @return new instance of WPanel
 264  */
 265 
 266 static inline WPanel *
 267 panel_sized_new (const char *panel_name, const WRect *r)
     /*   */
 268 {
 269     return panel_sized_with_dir_new (panel_name, r, NULL);
 270 }
 271 
 272 /* --------------------------------------------------------------------------------------------- */
 273 
 274 #endif

/*   */