6 * \brief Header: editor low level data handling and cursor fundamentals
11 #ifndef MC__EDIT_IMPL_H
12 #define MC__EDIT_IMPL_H
16 #include "lib/search.h" /* mc_search_type_t */
17 #include "lib/widget.h" /* cb_ret_t */
18 #include "lib/vfs/vfs.h" /* vfs_path_t */
22 /*** typedefs(not structures) and defined constants **********************************************/
24 #define REDRAW_LINE (1 << 0)
25 #define REDRAW_LINE_ABOVE (1 << 1)
26 #define REDRAW_LINE_BELOW (1 << 2)
27 #define REDRAW_AFTER_CURSOR (1 << 3)
28 #define REDRAW_BEFORE_CURSOR (1 << 4)
29 #define REDRAW_PAGE (1 << 5)
30 #define REDRAW_IN_BOUNDS (1 << 6)
31 #define REDRAW_CHAR_ONLY (1 << 7)
32 #define REDRAW_COMPLETELY (1 << 8)
34 #define EDIT_TEXT_HORIZONTAL_OFFSET 0
35 #define EDIT_TEXT_VERTICAL_OFFSET 0
36 #define EDIT_WITH_FRAME 1
38 #define EDIT_RIGHT_EXTREME option_edit_right_extreme
39 #define EDIT_LEFT_EXTREME option_edit_left_extreme
40 #define EDIT_TOP_EXTREME option_edit_top_extreme
41 #define EDIT_BOTTOM_EXTREME option_edit_bottom_extreme
44 * The editor keeps data in two arrays of buffers.
45 * All buffers have the same size, which must be a power of 2.
48 /* Configurable: log2 of the buffer size in bytes */
49 #ifndef S_EDIT_BUF_SIZE
50 #define S_EDIT_BUF_SIZE 16
53 /* Size of the buffer */
54 #define EDIT_BUF_SIZE (((off_t) 1) << S_EDIT_BUF_SIZE)
56 /* Buffer mask (used to find cursor position relative to the buffer) */
57 #define M_EDIT_BUF_SIZE (EDIT_BUF_SIZE - 1)
60 * Configurable: Maximal allowed number of buffers in each buffer array.
61 * This number can be increased for systems with enough physical memory.
67 /* Maximal length of file that can be opened */
68 #define SIZE_LIMIT (EDIT_BUF_SIZE * (MAXBUFF - 2))
70 /* Initial size of the undo stack, in bytes */
71 #define START_STACK_SIZE 32
73 /* Some codes that may be pushed onto or returned from the undo stack */
75 #define CURS_RIGHT 602
78 #define STACK_BOTTOM 605
79 #define CURS_LEFT_LOTS 606
80 #define CURS_RIGHT_LOTS 607
82 #define COLUMN_OFF 609
83 #define DELCHAR_BR 610
84 #define BACKSPACE_BR 611
86 #define MARK_2 500000000
87 #define MARK_CURS 1000000000
88 #define KEY_PRESS 1500000000
90 /* Tabs spaces: (sofar only HALF_TAB_SIZE is used: */
91 #define TAB_SIZE option_tab_spacing
92 #define HALF_TAB_SIZE ((int) option_tab_spacing / 2)
94 /* max count stack files */
95 #define MAX_HISTORY_MOVETO 50
96 #define LINE_STATE_WIDTH 8
98 #define LB_NAMES (LB_MAC + 1)
100 #define get_sys_error(s) (s)
102 #define edit_error_dialog(h,s) query_dialog (h, s, D_ERROR, 1, _("&Dismiss"))
104 #define edit_query_dialog2(h,t,a,b) query_dialog (h, t, D_NORMAL, 2, a, b)
105 #define edit_query_dialog3(h,t,a,b,c) query_dialog (h, t, D_NORMAL, 3, a, b, c)
107 /*** enums ***************************************************************************************/
109 /* type for file which is currently being edited */
112 EDIT_FILE_COMMON
= 0,
113 EDIT_FILE_SYNTAX
= 1,
115 } edit_current_file_t
;
133 /*** structures declarations (and typedefs of structures)*****************************************/
135 /* search/replace options */
136 typedef struct edit_search_options_t
138 mc_search_type_t type
;
141 gboolean only_in_selection
;
142 gboolean whole_words
;
143 gboolean all_codepages
;
144 } edit_search_options_t
;
146 typedef struct edit_stack_type
149 vfs_path_t
*filename_vpath
;
155 /*** global variables defined in .c file *********************************************************/
157 extern const char VERTICAL_MAGIC
[5];
158 /* if enable_show_tabs_tws ==1 then use visible_tab visible_tws */
159 extern int enable_show_tabs_tws
;
161 extern edit_search_options_t edit_search_options
;
163 extern int edit_stack_iterator
;
164 extern edit_stack_type edit_history_moveto
[MAX_HISTORY_MOVETO
];
166 extern int option_line_state_width
;
168 extern int option_max_undo
;
169 extern int option_auto_syntax
;
171 extern int option_edit_right_extreme
;
172 extern int option_edit_left_extreme
;
173 extern int option_edit_top_extreme
;
174 extern int option_edit_bottom_extreme
;
176 extern const char *option_whole_chars_search
;
177 extern gboolean search_create_bookmark
;
179 /*** declarations of public functions ************************************************************/
181 gboolean
edit_add_window (Dlg_head
* h
, int y
, int x
, int lines
, int cols
,
182 const vfs_path_t
* f
, int fline
);
183 WEdit
*find_editor (const Dlg_head
* h
);
184 gboolean
edit_widget_is_editor (const Widget
* w
);
185 gboolean
edit_drop_hotkey_menu (Dlg_head
* h
, int key
);
186 void edit_menu_cmd (Dlg_head
* h
);
187 void user_menu (WEdit
* edit
, const char *menu_file
, int selected_entry
);
188 void edit_init_menu (struct WMenuBar
*menubar
);
189 void edit_save_mode_cmd (void);
190 gboolean
edit_translate_key (WEdit
* edit
, long x_key
, int *cmd
, int *ch
);
191 int edit_get_byte (WEdit
* edit
, long byte_index
);
192 int edit_get_utf (WEdit
* edit
, long byte_index
, int *char_width
);
193 long edit_count_lines (WEdit
* edit
, long current
, long upto
);
194 long edit_move_forward (WEdit
* edit
, long current
, long lines
, long upto
);
195 long edit_move_forward3 (WEdit
* edit
, long current
, int cols
, long upto
);
196 long edit_move_backward (WEdit
* edit
, long current
, long lines
);
197 void edit_scroll_screen_over_cursor (WEdit
* edit
);
198 void edit_render_keypress (WEdit
* edit
);
199 void edit_scroll_upward (WEdit
* edit
, unsigned long i
);
200 void edit_scroll_downward (WEdit
* edit
, int i
);
201 void edit_scroll_right (WEdit
* edit
, int i
);
202 void edit_scroll_left (WEdit
* edit
, int i
);
203 void edit_move_up (WEdit
* edit
, unsigned long i
, int scroll
);
204 void edit_move_down (WEdit
* edit
, unsigned long i
, int scroll
);
205 void edit_move_to_prev_col (WEdit
* edit
, long p
);
206 int edit_get_col (WEdit
* edit
);
207 long edit_bol (WEdit
* edit
, long current
);
208 long edit_eol (WEdit
* edit
, long current
);
209 void edit_update_curs_row (WEdit
* edit
);
210 void edit_update_curs_col (WEdit
* edit
);
211 void edit_find_bracket (WEdit
* edit
);
212 gboolean
edit_reload_line (WEdit
* edit
, const vfs_path_t
* filename_vpath
, long line
);
213 void edit_set_codeset (WEdit
* edit
);
215 void edit_block_copy_cmd (WEdit
* edit
);
216 void edit_block_move_cmd (WEdit
* edit
);
217 int edit_block_delete_cmd (WEdit
* edit
);
218 void edit_delete_line (WEdit
* edit
);
220 int edit_delete (WEdit
* edit
, const int byte_delete
);
221 void edit_insert (WEdit
* edit
, int c
);
222 void edit_cursor_move (WEdit
* edit
, long increment
);
223 void edit_push_undo_action (WEdit
* edit
, long c
, ...);
224 void edit_push_redo_action (WEdit
* edit
, long c
, ...);
225 void edit_push_key_press (WEdit
* edit
);
226 void edit_insert_ahead (WEdit
* edit
, int c
);
227 long edit_write_stream (WEdit
* edit
, FILE * f
);
228 char *edit_get_write_filter (const vfs_path_t
* write_name_vpath
,
229 const vfs_path_t
* filename_vpath
);
230 int edit_save_confirm_cmd (WEdit
* edit
);
231 int edit_save_as_cmd (WEdit
* edit
);
232 WEdit
*edit_init (WEdit
* edit
, int y
, int x
, int lines
, int cols
,
233 const vfs_path_t
* filename_vpath
, long line
);
234 gboolean
edit_clean (WEdit
* edit
);
235 gboolean
edit_ok_to_exit (WEdit
* edit
);
236 gboolean
edit_renew (WEdit
* edit
);
237 gboolean
edit_new_cmd (WEdit
* edit
);
238 gboolean
edit_load_cmd (WEdit
* edit
, edit_current_file_t what
);
239 gboolean
edit_close_cmd (WEdit
* edit
);
240 void edit_mark_cmd (WEdit
* edit
, int unmark
);
241 void edit_mark_current_word_cmd (WEdit
* edit
);
242 void edit_mark_current_line_cmd (WEdit
* edit
);
243 void edit_set_markers (WEdit
* edit
, long m1
, long m2
, int c1
, int c2
);
244 void edit_push_markers (WEdit
* edit
);
245 void edit_replace_cmd (WEdit
* edit
, int again
);
246 void edit_search_cmd (WEdit
* edit
, gboolean again
);
247 mc_search_cbret_t
edit_search_cmd_callback (const void *user_data
, gsize char_offset
,
249 void edit_complete_word_cmd (WEdit
* edit
);
250 void edit_get_match_keyword_cmd (WEdit
* edit
);
251 int edit_save_block (WEdit
* edit
, const char *filename
, long start
, long finish
);
252 int edit_save_block_cmd (WEdit
* edit
);
253 gboolean
edit_insert_file_cmd (WEdit
* edit
);
254 void edit_insert_over (WEdit
* edit
);
255 int edit_insert_column_of_text_from_file (WEdit
* edit
, int file
,
256 long *start_pos
, long *end_pos
, int *col1
, int *col2
);
257 long edit_insert_file (WEdit
* edit
, const vfs_path_t
* filename_vpath
);
258 gboolean
edit_load_back_cmd (WEdit
* edit
);
259 gboolean
edit_load_forward_cmd (WEdit
* edit
);
260 void edit_block_process_cmd (WEdit
* edit
, int macro_number
);
261 void edit_refresh_cmd (WEdit
* edit
);
262 void edit_date_cmd (WEdit
* edit
);
263 void edit_goto_cmd (WEdit
* edit
);
264 int eval_marks (WEdit
* edit
, long *start_mark
, long *end_mark
);
265 void edit_info_status (WEdit
* edit
);
266 void edit_status (WEdit
* edit
);
267 void edit_execute_key_command (WEdit
* edit
, unsigned long command
, int char_for_insertion
);
268 void edit_update_screen (WEdit
* edit
);
269 void edit_save_size (WEdit
* edit
);
270 gboolean
edit_handle_move_resize (WEdit
* edit
, unsigned long command
);
271 void edit_move_to_line (WEdit
* e
, long line
);
272 void edit_move_display (WEdit
* e
, long line
);
273 void edit_word_wrap (WEdit
* edit
);
274 int edit_sort_cmd (WEdit
* edit
);
275 int edit_ext_cmd (WEdit
* edit
);
277 int edit_store_macro_cmd (WEdit
* edit
);
278 gboolean
edit_load_macro_cmd (WEdit
* edit
);
279 void edit_delete_macro_cmd (WEdit
* edit
);
280 gboolean
edit_repeat_macro_cmd (WEdit
* edit
);
282 int edit_copy_to_X_buf_cmd (WEdit
* edit
);
283 int edit_cut_to_X_buf_cmd (WEdit
* edit
);
284 void edit_paste_from_X_buf_cmd (WEdit
* edit
);
286 void edit_select_codepage_cmd (WEdit
* edit
);
287 void edit_insert_literal_cmd (WEdit
* edit
);
288 gboolean
edit_execute_macro (WEdit
* edit
, int hotkey
);
289 void edit_begin_end_macro_cmd (WEdit
* edit
);
290 void edit_begin_end_repeat_cmd (WEdit
* edit
);
292 void edit_paste_from_history (WEdit
* edit
);
294 void edit_set_filename (WEdit
* edit
, const vfs_path_t
* name_vpath
);
296 void edit_load_syntax (WEdit
* edit
, char ***pnames
, const char *type
);
297 void edit_free_syntax_rules (WEdit
* edit
);
298 void edit_get_syntax_color (WEdit
* edit
, long byte_index
, int *color
);
300 void book_mark_insert (WEdit
* edit
, size_t line
, int c
);
301 int book_mark_query_color (WEdit
* edit
, int line
, int c
);
302 int book_mark_query_all (WEdit
* edit
, int line
, int *c
);
303 struct _book_mark
*book_mark_find (WEdit
* edit
, int line
);
304 int book_mark_clear (WEdit
* edit
, int line
, int c
);
305 void book_mark_flush (WEdit
* edit
, int c
);
306 void book_mark_inc (WEdit
* edit
, int line
);
307 void book_mark_dec (WEdit
* edit
, int line
);
308 void book_mark_serialize (WEdit
* edit
, int color
);
309 void book_mark_restore (WEdit
* edit
, int color
);
311 int line_is_blank (WEdit
* edit
, long line
);
312 int edit_indent_width (WEdit
* edit
, long p
);
313 void edit_insert_indent (WEdit
* edit
, int indent
);
314 void edit_options_dialog (WEdit
* edit
);
315 void edit_syntax_dialog (WEdit
* edit
);
316 void edit_mail_dialog (WEdit
* edit
);
317 void format_paragraph (WEdit
* edit
, int force
);
319 /* either command or char_for_insertion must be passed as -1 */
320 void edit_execute_cmd (WEdit
* edit
, unsigned long command
, int char_for_insertion
);
322 /*** inline functions ****************************************************************************/
325 * Load a new file into the editor. If it fails, preserve the old file.
326 * To do it, allocate a new widget, initialize it and, if the new file
327 * was loaded, copy the data to the old widget.
329 * @returns TRUE on success, FALSE on failure.
331 static inline gboolean
332 edit_reload (WEdit
* edit
, const vfs_path_t
* filename_vpath
)
334 return edit_reload_line (edit
, filename_vpath
, 0);
337 #endif /* MC__EDIT_IMPL_H */