src/viewer/internal.h

   1 #ifndef MC__VIEWER_INTERNAL_H
   2 #define MC__VIEWER_INTERNAL_H
   3
   4 #include <stdlib.h>
   5 #include <stdio.h>
   6 #include <sys/types.h>
   7
   8 #include "lib/global.h"
   9
  10 #include "lib/search.h"
  11 #include "lib/widget.h"
  12 #include "lib/vfs/vfs.h"        /* vfs_path_t */
  13
  14 #include "src/keybind-defaults.h"       /* global_keymap_t */
  15
  16 /*** typedefs(not structures) and defined constants **********************************************/
  17
  18 typedef unsigned char byte;
  19
  20 /* A width or height on the screen */
  21 typedef unsigned int screen_dimen;
  22
  23 extern const off_t INVALID_OFFSET;
  24 extern const off_t OFFSETTYPE_MAX;
  25
  26 /*** enums ***************************************************************************************/
  27
  28 /* data sources of the view */
  29 enum view_ds
  30 {
  31     DS_NONE,                    /* No data available */
  32     DS_STDIO_PIPE,              /* Data comes from a pipe using popen/pclose */
  33     DS_VFS_PIPE,                /* Data comes from a piped-in VFS file */
  34     DS_FILE,                    /* Data comes from a VFS file */
  35     DS_STRING                   /* Data comes from a string in memory */
  36 };
  37
  38 enum ccache_type
  39 {
  40     CCACHE_OFFSET,
  41     CCACHE_LINECOL
  42 };
  43
  44 typedef enum
  45 {
  46     NROFF_TYPE_NONE = 0,
  47     NROFF_TYPE_BOLD = 1,
  48     NROFF_TYPE_UNDERLINE = 2
  49 } nroff_type_t;
  50
  51 /*** structures declarations (and typedefs of structures)*****************************************/
  52
  53 /* A node for building a change list on change_list */
  54 struct hexedit_change_node
  55 {
  56     struct hexedit_change_node *next;
  57     off_t offset;
  58     byte value;
  59 };
  60
  61 struct area
  62 {
  63     screen_dimen top, left;
  64     screen_dimen height, width;
  65 };
  66
  67 /* A cache entry for mapping offsets into line/column pairs and vice versa.
  68  * cc_offset, cc_line, and cc_column are the 0-based values of the offset,
  69  * line and column of that cache entry. cc_nroff_column is the column
  70  * corresponding to cc_offset in nroff mode.
  71  */
  72 typedef struct
  73 {
  74     off_t cc_offset;
  75     off_t cc_line;
  76     off_t cc_column;
  77     off_t cc_nroff_column;
  78 } coord_cache_entry_t;
  79
  80 typedef struct
  81 {
  82     size_t size;
  83     size_t capacity;
  84     coord_cache_entry_t **cache;
  85 } coord_cache_t;
  86
  87 struct mcview_nroff_struct;
  88
  89 typedef struct mcview_struct
  90 {
  91     Widget widget;
  92
  93     vfs_path_t *filename_vpath; /* Name of the file */
  94     vfs_path_t *workdir_vpath;  /* Name of the working directory */
  95     char *command;              /* Command used to pipe data in */
  96
  97     enum view_ds datasource;    /* Where the displayed data comes from */
  98
  99     /* stdio pipe data source */
 100     FILE *ds_stdio_pipe;        /* Output of a shell command */
 101
 102     /* vfs pipe data source */
 103     int ds_vfs_pipe;            /* Non-seekable vfs file descriptor */
 104
 105     /* vfs file data source */
 106     int ds_file_fd;             /* File with random access */
 107     off_t ds_file_filesize;     /* Size of the file */
 108     off_t ds_file_offset;       /* Offset of the currently loaded data */
 109     byte *ds_file_data;         /* Currently loaded data */
 110     size_t ds_file_datalen;     /* Number of valid bytes in file_data */
 111     size_t ds_file_datasize;    /* Number of allocated bytes in file_data */
 112
 113     /* string data source */
 114     byte *ds_string_data;       /* The characters of the string */
 115     size_t ds_string_len;       /* The length of the string */
 116
 117     /* Growing buffers information */
 118     gboolean growbuf_in_use;    /* Use the growing buffers? */
 119     GPtrArray *growbuf_blockptr;        /* Pointer to the block pointers */
 120     size_t growbuf_lastindex;   /* Number of bytes in the last page of the
 121                                    growing buffer */
 122     gboolean growbuf_finished;  /* TRUE when all data has been read. */
 123
 124     /* Editor modes */
 125     gboolean hex_mode;          /* Hexview or Hexedit */
 126     gboolean hexedit_mode;      /* Hexedit */
 127     gboolean hexview_in_text;   /* Is the hexview cursor in the text area? */
 128     gboolean text_nroff_mode;   /* Nroff-style highlighting */
 129     gboolean text_wrap_mode;    /* Wrap text lines to fit them on the screen */
 130     gboolean magic_mode;        /* Preprocess the file using external programs */
 131     gboolean hexedit_lownibble; /* Are we editing the last significant nibble? */
 132     gboolean locked;            /* We hold lock on current file */
 133
 134     gboolean utf8;              /* It's multibyte file codeset */
 135
 136     coord_cache_t *coord_cache; /* Cache for mapping offsets to cursor positions */
 137
 138     /* Display information */
 139     screen_dimen dpy_frame_size;        /* Size of the frame surrounding the real viewer */
 140     off_t dpy_start;            /* Offset of the displayed data */
 141     off_t dpy_end;              /* Offset after the displayed data */
 142     off_t dpy_text_column;      /* Number of skipped columns in non-wrap
 143                                  * text mode */
 144     off_t hex_cursor;           /* Hexview cursor position in file */
 145     screen_dimen cursor_col;    /* Cursor column */
 146     screen_dimen cursor_row;    /* Cursor row */
 147     struct hexedit_change_node *change_list;    /* Linked list of changes */
 148     struct area status_area;    /* Where the status line is displayed */
 149     struct area ruler_area;     /* Where the ruler is displayed */
 150     struct area data_area;      /* Where the data is displayed */
 151
 152     int dirty;                  /* Number of skipped updates */
 153     gboolean dpy_bbar_dirty;    /* Does the button bar need to be updated? */
 154
 155     /* Mode variables */
 156     int bytes_per_line;         /* Number of bytes per line in hex mode */
 157
 158     /* Search variables */
 159     off_t search_start;         /* First character to start searching from */
 160     off_t search_end;           /* Length of found string or 0 if none was found */
 161
 162     /* Markers */
 163     int marker;                 /* mark to use */
 164     off_t marks[10];            /* 10 marks: 0..9 */
 165
 166     int move_dir;               /* return value from widget:
 167                                  * 0 do nothing
 168                                  * -1 view previous file
 169                                  * 1 view next file
 170                                  */
 171
 172     off_t update_steps;         /* The number of bytes between percent
 173                                  * increments */
 174     off_t update_activate;      /* Last point where we updated the status */
 175
 176     /* converter for translation of text */
 177     GIConv converter;
 178
 179     /* handle of search engine */
 180     mc_search_t *search;
 181     gchar *last_search_string;
 182     struct mcview_nroff_struct *search_nroff_seq;
 183
 184     int search_numNeedSkipChar;
 185
 186     GArray *saved_bookmarks;
 187 } mcview_t;
 188
 189 typedef struct mcview_nroff_struct
 190 {
 191     mcview_t *view;
 192     off_t index;
 193     int char_width;
 194     int current_char;
 195     nroff_type_t type;
 196     nroff_type_t prev_type;
 197 } mcview_nroff_t;
 198
 199 typedef struct mcview_search_options_t
 200 {
 201     mc_search_type_t type;
 202     gboolean case_sens;
 203     gboolean backwards;
 204     gboolean whole_words;
 205     gboolean all_codepages;
 206 } mcview_search_options_t;
 207
 208 /*** global variables defined in .c file *********************************************************/
 209
 210 extern mcview_search_options_t mcview_search_options;
 211
 212 /*** declarations of public functions ************************************************************/
 213
 214 /* actions_cmd.c:  */
 215 cb_ret_t mcview_callback (Widget * w, widget_msg_t msg, int parm);
 216 cb_ret_t mcview_dialog_callback (Dlg_head * h, Widget * sender,
 217                                  dlg_msg_t msg, int parm, void *data);
 218
 219 /* coord_cache.c: */
 220 coord_cache_t *coord_cache_new (void);
 221 void coord_cache_free (coord_cache_t * cache);
 222
 223 #ifdef MC_ENABLE_DEBUGGING_CODE
 224 void mcview_ccache_dump (mcview_t * view);
 225 #endif
 226
 227 void mcview_ccache_lookup (mcview_t * view, coord_cache_entry_t * coord,
 228                            enum ccache_type lookup_what);
 229
 230 /* datasource.c: */
 231 void mcview_set_datasource_none (mcview_t *);
 232 off_t mcview_get_filesize (mcview_t *);
 233 void mcview_update_filesize (mcview_t * view);
 234 char *mcview_get_ptr_file (mcview_t *, off_t);
 235 char *mcview_get_ptr_string (mcview_t *, off_t);
 236 int mcview_get_utf (mcview_t *, off_t, int *, gboolean *);
 237 gboolean mcview_get_byte_string (mcview_t *, off_t, int *);
 238 gboolean mcview_get_byte_none (mcview_t *, off_t, int *);
 239 void mcview_set_byte (mcview_t *, off_t, byte);
 240 void mcview_file_load_data (mcview_t *, off_t);
 241 void mcview_close_datasource (mcview_t *);
 242 void mcview_set_datasource_file (mcview_t *, int, const struct stat *);
 243 gboolean mcview_load_command_output (mcview_t *, const char *);
 244 void mcview_set_datasource_vfs_pipe (mcview_t *, int);
 245 void mcview_set_datasource_string (mcview_t *, const char *);
 246
 247 /* dialog.c: */
 248 gboolean mcview_dialog_search (mcview_t * view);
 249 gboolean mcview_dialog_goto (mcview_t * view, off_t * offset);
 250
 251 /* display.c: */
 252 void mcview_update (mcview_t * view);
 253 void mcview_display (mcview_t * view);
 254 void mcview_compute_areas (mcview_t * view);
 255 void mcview_update_bytes_per_line (mcview_t * view);
 256 void mcview_display_toggle_ruler (mcview_t * view);
 257 void mcview_display_clean (mcview_t * view);
 258 void mcview_display_ruler (mcview_t * view);
 259 void mcview_percent (mcview_t * view, off_t p);
 260
 261 /* growbuf.c: */
 262 void mcview_growbuf_init (mcview_t * view);
 263 void mcview_growbuf_free (mcview_t * view);
 264 off_t mcview_growbuf_filesize (mcview_t * view);
 265 void mcview_growbuf_read_until (mcview_t * view, off_t p);
 266 gboolean mcview_get_byte_growing_buffer (mcview_t * view, off_t p, int *);
 267 char *mcview_get_ptr_growing_buffer (mcview_t * view, off_t p);
 268
 269 /* hex.c: */
 270 void mcview_display_hex (mcview_t * view);
 271 gboolean mcview_hexedit_save_changes (mcview_t * view);
 272 void mcview_toggle_hexedit_mode (mcview_t * view);
 273 void mcview_hexedit_free_change_list (mcview_t * view);
 274 void mcview_enqueue_change (struct hexedit_change_node **, struct hexedit_change_node *);
 275
 276 /* lib.c: */
 277 void mcview_toggle_magic_mode (mcview_t * view);
 278 void mcview_toggle_wrap_mode (mcview_t * view);
 279 void mcview_toggle_nroff_mode (mcview_t * view);
 280 void mcview_toggle_hex_mode (mcview_t * view);
 281 gboolean mcview_ok_to_quit (mcview_t * view);
 282 void mcview_init (mcview_t * view);
 283 void mcview_done (mcview_t * view);
 284 void mcview_select_encoding (mcview_t * view);
 285 void mcview_set_codeset (mcview_t * view);
 286 void mcview_show_error (mcview_t * view, const char *error);
 287 off_t mcview_bol (mcview_t * view, off_t current, off_t limit);
 288 off_t mcview_eol (mcview_t * view, off_t current, off_t limit);
 289 char *mcview_get_title (const Dlg_head * h, size_t len);
 290
 291 /* move.c */
 292 void mcview_move_up (mcview_t *, off_t);
 293 void mcview_move_down (mcview_t *, off_t);
 294 void mcview_move_left (mcview_t *, off_t);
 295 void mcview_move_right (mcview_t *, off_t);
 296 void mcview_scroll_to_cursor (mcview_t *);
 297 void mcview_moveto_top (mcview_t *);
 298 void mcview_moveto_bottom (mcview_t *);
 299 void mcview_moveto_bol (mcview_t *);
 300 void mcview_moveto_eol (mcview_t *);
 301 void mcview_moveto_offset (mcview_t *, off_t);
 302 void mcview_moveto (mcview_t *, off_t, off_t);
 303 void mcview_coord_to_offset (mcview_t *, off_t *, off_t, off_t);
 304 void mcview_offset_to_coord (mcview_t *, off_t *, off_t *, off_t);
 305 void mcview_place_cursor (mcview_t *);
 306 void mcview_moveto_match (mcview_t *);
 307
 308 /* nroff.c: */
 309 void mcview_display_nroff (mcview_t * view);
 310 int mcview__get_nroff_real_len (mcview_t * view, off_t, off_t p);
 311
 312 mcview_nroff_t *mcview_nroff_seq_new_num (mcview_t * view, off_t p);
 313 mcview_nroff_t *mcview_nroff_seq_new (mcview_t * view);
 314 void mcview_nroff_seq_free (mcview_nroff_t **);
 315 nroff_type_t mcview_nroff_seq_info (mcview_nroff_t *);
 316 int mcview_nroff_seq_next (mcview_nroff_t *);
 317 int mcview_nroff_seq_prev (mcview_nroff_t *);
 318
 319
 320 /* plain.c: */
 321 void mcview_display_text (mcview_t *);
 322
 323 /* search.c: */
 324 mc_search_cbret_t mcview_search_cmd_callback (const void *user_data, gsize char_offset,
 325                                               int *current_char);
 326 int mcview_search_update_cmd_callback (const void *, gsize);
 327 void mcview_do_search (mcview_t * view);
 328
 329 /*** inline functions ****************************************************************************/
 330
 331 #include "inlines.h"
 332
 333 #endif /* MC__VIEWER_INTERNAL_H */