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