2 #ifndef MC_VIEWER_INTERNAL_H
3 #define MC_VIEWER_INTERNAL_H
9 #include "lib/global.h"
11 #include "lib/search.h"
13 #include "src/dialog.h"
14 #include "src/widget.h"
15 #include "src/keybind.h" /* global_keymap_t */
17 /*** typedefs(not structures) and defined constants ********************/
19 typedef unsigned char byte
;
21 /* A width or height on the screen */
22 typedef unsigned int screen_dimen
;
24 extern const off_t INVALID_OFFSET
;
25 extern const off_t OFFSETTYPE_MAX
;
27 /*** enums *************************************************************/
29 /* data sources of the view */
32 DS_NONE
, /* No data available */
33 DS_STDIO_PIPE
, /* Data comes from a pipe using popen/pclose */
34 DS_VFS_PIPE
, /* Data comes from a piped-in VFS file */
35 DS_FILE
, /* Data comes from a VFS file */
36 DS_STRING
/* Data comes from a string in memory */
49 NROFF_TYPE_UNDERLINE
= 2
52 /*** structures declarations (and typedefs of structures)***************/
54 /* A node for building a change list on change_list */
55 struct hexedit_change_node
57 struct hexedit_change_node
*next
;
64 screen_dimen top
, left
;
65 screen_dimen height
, width
;
68 /* A cache entry for mapping offsets into line/column pairs and vice versa.
69 * cc_offset, cc_line, and cc_column are the 0-based values of the offset,
70 * line and column of that cache entry. cc_nroff_column is the column
71 * corresponding to cc_offset in nroff mode.
78 off_t cc_nroff_column
;
79 } coord_cache_entry_t
;
85 coord_cache_entry_t
**cache
;
88 struct mcview_nroff_struct
;
90 typedef struct mcview_struct
94 char *filename
; /* Name of the file */
95 char *workdir
; /* Name of the working directory */
96 char *command
; /* Command used to pipe data in */
98 enum view_ds datasource
; /* Where the displayed data comes from */
100 /* stdio pipe data source */
101 FILE *ds_stdio_pipe
; /* Output of a shell command */
103 /* vfs pipe data source */
104 int ds_vfs_pipe
; /* Non-seekable vfs file descriptor */
106 /* vfs file data source */
107 int ds_file_fd
; /* File with random access */
108 off_t ds_file_filesize
; /* Size of the file */
109 off_t ds_file_offset
; /* Offset of the currently loaded data */
110 byte
*ds_file_data
; /* Currently loaded data */
111 size_t ds_file_datalen
; /* Number of valid bytes in file_data */
112 size_t ds_file_datasize
; /* Number of allocated bytes in file_data */
114 /* string data source */
115 byte
*ds_string_data
; /* The characters of the string */
116 size_t ds_string_len
; /* The length of the string */
118 /* Growing buffers information */
119 gboolean growbuf_in_use
; /* Use the growing buffers? */
120 GPtrArray
*growbuf_blockptr
; /* Pointer to the block pointers */
121 size_t growbuf_lastindex
; /* Number of bytes in the last page of the
123 gboolean growbuf_finished
; /* TRUE when all data has been read. */
126 gboolean hex_mode
; /* Hexview or Hexedit */
127 gboolean hexedit_mode
; /* Hexedit */
128 gboolean hexview_in_text
; /* Is the hexview cursor in the text area? */
129 gboolean text_nroff_mode
; /* Nroff-style highlighting */
130 gboolean text_wrap_mode
; /* Wrap text lines to fit them on the screen */
131 gboolean magic_mode
; /* Preprocess the file using external programs */
132 gboolean hexedit_lownibble
; /* Are we editing the last significant nibble? */
133 gboolean locked
; /* We hold lock on current file */
135 gboolean utf8
; /* It's multibyte file codeset */
137 coord_cache_t
*coord_cache
; /* Cache for mapping offsets to cursor positions */
139 /* Display information */
140 screen_dimen dpy_frame_size
; /* Size of the frame surrounding the real viewer */
141 off_t dpy_start
; /* Offset of the displayed data */
142 off_t dpy_end
; /* Offset after the displayed data */
143 off_t dpy_text_column
; /* Number of skipped columns in non-wrap
145 off_t hex_cursor
; /* Hexview cursor position in file */
146 screen_dimen cursor_col
; /* Cursor column */
147 screen_dimen cursor_row
; /* Cursor row */
148 struct hexedit_change_node
*change_list
; /* Linked list of changes */
149 struct area status_area
; /* Where the status line is displayed */
150 struct area ruler_area
; /* Where the ruler is displayed */
151 struct area data_area
; /* Where the data is displayed */
153 int dirty
; /* Number of skipped updates */
154 gboolean dpy_bbar_dirty
; /* Does the button bar need to be updated? */
157 int bytes_per_line
; /* Number of bytes per line in hex mode */
159 /* Search variables */
160 off_t search_start
; /* First character to start searching from */
161 off_t search_end
; /* Length of found string or 0 if none was found */
164 int marker
; /* mark to use */
165 off_t marks
[10]; /* 10 marks: 0..9 */
167 int move_dir
; /* return value from widget:
169 * -1 view previous file
173 off_t update_steps
; /* The number of bytes between percent
175 off_t update_activate
; /* Last point where we updated the status */
177 /* converter for translation of text */
181 const global_keymap_t
*plain_map
;
182 const global_keymap_t
*hex_map
;
184 /* handle of search engine */
186 gchar
*last_search_string
;
187 struct mcview_nroff_struct
*search_nroff_seq
;
189 int search_numNeedSkipChar
;
191 GArray
*saved_bookmarks
;
194 typedef struct mcview_nroff_struct
201 nroff_type_t prev_type
;
204 typedef struct mcview_search_options_t
206 mc_search_type_t type
;
209 gboolean whole_words
;
210 gboolean all_codepages
;
211 } mcview_search_options_t
;
213 /*** global variables defined in .c file *******************************/
215 extern mcview_search_options_t mcview_search_options
;
217 /*** declarations of public functions **********************************/
220 cb_ret_t
mcview_callback (Widget
* w
, widget_msg_t msg
, int parm
);
221 cb_ret_t
mcview_dialog_callback (Dlg_head
* h
, Widget
* sender
,
222 dlg_msg_t msg
, int parm
, void *data
);
225 coord_cache_t
*coord_cache_new (void);
226 void coord_cache_free (coord_cache_t
* cache
);
228 #ifdef MC_ENABLE_DEBUGGING_CODE
229 void mcview_ccache_dump (mcview_t
* view
);
232 void mcview_ccache_lookup (mcview_t
* view
, coord_cache_entry_t
* coord
,
233 enum ccache_type lookup_what
);
236 void mcview_set_datasource_none (mcview_t
*);
237 off_t
mcview_get_filesize (mcview_t
*);
238 void mcview_update_filesize (mcview_t
* view
);
239 char *mcview_get_ptr_file (mcview_t
*, off_t
);
240 char *mcview_get_ptr_string (mcview_t
*, off_t
);
241 int mcview_get_utf (mcview_t
*, off_t
, int *, gboolean
*);
242 gboolean
mcview_get_byte_string (mcview_t
*, off_t
, int *);
243 gboolean
mcview_get_byte_none (mcview_t
*, off_t
, int *);
244 void mcview_set_byte (mcview_t
*, off_t
, byte
);
245 void mcview_file_load_data (mcview_t
*, off_t
);
246 void mcview_close_datasource (mcview_t
*);
247 void mcview_set_datasource_file (mcview_t
*, int, const struct stat
*);
248 gboolean
mcview_load_command_output (mcview_t
*, const char *);
249 void mcview_set_datasource_vfs_pipe (mcview_t
*, int);
250 void mcview_set_datasource_string (mcview_t
*, const char *);
253 gboolean
mcview_dialog_search (mcview_t
* view
);
254 gboolean
mcview_dialog_goto (mcview_t
* view
, off_t
* offset
);
257 void mcview_update (mcview_t
* view
);
258 void mcview_display (mcview_t
* view
);
259 void mcview_compute_areas (mcview_t
* view
);
260 void mcview_update_bytes_per_line (mcview_t
* view
);
261 void mcview_display_toggle_ruler (mcview_t
* view
);
262 void mcview_display_clean (mcview_t
* view
);
263 void mcview_display_ruler (mcview_t
* view
);
264 void mcview_percent (mcview_t
* view
, off_t p
);
267 void mcview_growbuf_init (mcview_t
* view
);
268 void mcview_growbuf_free (mcview_t
* view
);
269 off_t
mcview_growbuf_filesize (mcview_t
* view
);
270 void mcview_growbuf_read_until (mcview_t
* view
, off_t p
);
271 gboolean
mcview_get_byte_growing_buffer (mcview_t
* view
, off_t p
, int *);
272 char *mcview_get_ptr_growing_buffer (mcview_t
* view
, off_t p
);
275 void mcview_display_hex (mcview_t
* view
);
276 gboolean
mcview_hexedit_save_changes (mcview_t
* view
);
277 void mcview_toggle_hexedit_mode (mcview_t
* view
);
278 void mcview_hexedit_free_change_list (mcview_t
* view
);
279 void mcview_enqueue_change (struct hexedit_change_node
**, struct hexedit_change_node
*);
282 void mcview_toggle_magic_mode (mcview_t
* view
);
283 void mcview_toggle_wrap_mode (mcview_t
* view
);
284 void mcview_toggle_nroff_mode (mcview_t
* view
);
285 void mcview_toggle_hex_mode (mcview_t
* view
);
286 gboolean
mcview_ok_to_quit (mcview_t
* view
);
287 void mcview_init (mcview_t
* view
);
288 void mcview_done (mcview_t
* view
);
289 void mcview_select_encoding (mcview_t
* view
);
290 void mcview_set_codeset (mcview_t
* view
);
291 void mcview_show_error (mcview_t
* view
, const char *error
);
292 off_t
mcview_bol (mcview_t
* view
, off_t current
, off_t limit
);
293 off_t
mcview_eol (mcview_t
* view
, off_t current
, off_t limit
);
294 char *mcview_get_title (const Dlg_head
* h
, size_t len
);
295 gboolean
mcview_lock_file (mcview_t
* view
);
296 gboolean
mcview_unlock_file (mcview_t
* view
);
299 void mcview_move_up (mcview_t
*, off_t
);
300 void mcview_move_down (mcview_t
*, off_t
);
301 void mcview_move_left (mcview_t
*, off_t
);
302 void mcview_move_right (mcview_t
*, off_t
);
303 void mcview_scroll_to_cursor (mcview_t
*);
304 void mcview_moveto_top (mcview_t
*);
305 void mcview_moveto_bottom (mcview_t
*);
306 void mcview_moveto_bol (mcview_t
*);
307 void mcview_moveto_eol (mcview_t
*);
308 void mcview_moveto_offset (mcview_t
*, off_t
);
309 void mcview_moveto (mcview_t
*, off_t
, off_t
);
310 void mcview_coord_to_offset (mcview_t
*, off_t
*, off_t
, off_t
);
311 void mcview_offset_to_coord (mcview_t
*, off_t
*, off_t
*, off_t
);
312 void mcview_place_cursor (mcview_t
*);
313 void mcview_moveto_match (mcview_t
*);
316 void mcview_display_nroff (mcview_t
* view
);
317 int mcview__get_nroff_real_len (mcview_t
* view
, off_t
, off_t p
);
319 mcview_nroff_t
*mcview_nroff_seq_new_num (mcview_t
* view
, off_t p
);
320 mcview_nroff_t
*mcview_nroff_seq_new (mcview_t
* view
);
321 void mcview_nroff_seq_free (mcview_nroff_t
**);
322 nroff_type_t
mcview_nroff_seq_info (mcview_nroff_t
*);
323 int mcview_nroff_seq_next (mcview_nroff_t
*);
326 void mcview_display_text (mcview_t
*);
329 int mcview_search_cmd_callback (const void *user_data
, gsize char_offset
);
330 int mcview_search_update_cmd_callback (const void *, gsize
);
331 void mcview_do_search (mcview_t
* view
);
334 /*** inline functions ****************************************************************************/
338 #endif /* MC_VIEWER_INTERNAL_H */