1 /* edit.h - editor private API
3 Copyright (C) 1996, 1997, 2009 Free Software Foundation, Inc.
5 Authors: 1996, 1997 Paul Sheer
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 * \brief Header: editor low level data handling and cursor fundamentals
30 #ifndef MC_EDIT_IMPL_H
31 #define MC_EDIT_IMPL_H
35 #include "../src/dialog.h" /* cb_ret_t */
36 #include "../src/keybind.h" /* global_keymap_t */
38 #include "../edit/edit.h"
40 #define SEARCH_DIALOG_OPTION_NO_SCANF (1 << 0)
41 #define SEARCH_DIALOG_OPTION_NO_REGEX (1 << 1)
42 #define SEARCH_DIALOG_OPTION_NO_CASE (1 << 2)
43 #define SEARCH_DIALOG_OPTION_BACKWARDS (1 << 3)
44 #define SEARCH_DIALOG_OPTION_BOOKMARK (1 << 4)
46 #define EDIT_KEY_EMULATION_NORMAL 0
47 #define EDIT_KEY_EMULATION_EMACS 1
48 #define EDIT_KEY_EMULATION_USER 2
50 #define REDRAW_LINE (1 << 0)
51 #define REDRAW_LINE_ABOVE (1 << 1)
52 #define REDRAW_LINE_BELOW (1 << 2)
53 #define REDRAW_AFTER_CURSOR (1 << 3)
54 #define REDRAW_BEFORE_CURSOR (1 << 4)
55 #define REDRAW_PAGE (1 << 5)
56 #define REDRAW_IN_BOUNDS (1 << 6)
57 #define REDRAW_CHAR_ONLY (1 << 7)
58 #define REDRAW_COMPLETELY (1 << 8)
60 #define EDIT_TEXT_HORIZONTAL_OFFSET 0
61 #define EDIT_TEXT_VERTICAL_OFFSET 1
63 #define EDIT_RIGHT_EXTREME option_edit_right_extreme
64 #define EDIT_LEFT_EXTREME option_edit_left_extreme
65 #define EDIT_TOP_EXTREME option_edit_top_extreme
66 #define EDIT_BOTTOM_EXTREME option_edit_bottom_extreme
69 * The editor keeps data in two arrays of buffers.
70 * All buffers have the same size, which must be a power of 2.
73 /* Configurable: log2 of the buffer size in bytes */
74 #ifndef S_EDIT_BUF_SIZE
75 #define S_EDIT_BUF_SIZE 16
78 /* Size of the buffer */
79 #define EDIT_BUF_SIZE (((off_t) 1) << S_EDIT_BUF_SIZE)
81 /* Buffer mask (used to find cursor position relative to the buffer) */
82 #define M_EDIT_BUF_SIZE (EDIT_BUF_SIZE - 1)
85 * Configurable: Maximal allowed number of buffers in each buffer array.
86 * This number can be increased for systems with enough physical memory.
92 /* Maximal length of file that can be opened */
93 #define SIZE_LIMIT (EDIT_BUF_SIZE * (MAXBUFF - 2))
95 /* Initial size of the undo stack, in bytes */
96 #define START_STACK_SIZE 32
98 /* Some codes that may be pushed onto or returned from the undo stack */
100 #define CURS_RIGHT 602
102 #define BACKSPACE 604
103 #define STACK_BOTTOM 605
104 #define CURS_LEFT_LOTS 606
105 #define CURS_RIGHT_LOTS 607
106 #define COLUMN_ON 608
107 #define COLUMN_OFF 609
109 #define MARK_2 700000000
110 #define KEY_PRESS 1400000000
112 /* Tabs spaces: (sofar only HALF_TAB_SIZE is used: */
113 #define TAB_SIZE option_tab_spacing
114 #define HALF_TAB_SIZE ((int) option_tab_spacing / 2)
116 /* max count stack files */
117 #define MAX_HISTORY_MOVETO 50
118 #define LINE_STATE_WIDTH 8
120 typedef struct edit_stack_type
{
130 /* type for file which is currently being edited */
132 EDIT_FILE_COMMON
= 0,
133 EDIT_FILE_SYNTAX
= 1,
135 } edit_current_file_t
;
144 #define LB_NAMES (LB_MAC + 1)
148 extern const char VERTICAL_MAGIC
[5];
149 /* if enable_show_tabs_tws ==1 then use visible_tab visible_tws */
150 extern int enable_show_tabs_tws
;
151 int edit_drop_hotkey_menu (WEdit
*e
, int key
);
152 void edit_menu_cmd (WEdit
*e
);
153 void edit_init_menu (struct WMenuBar
*menubar
);
154 cb_ret_t
edit_menu_execute (int command
);
155 void menu_save_mode_cmd (void);
156 int edit_translate_key (WEdit
*edit
, long x_key
, int *cmd
, int *ch
);
157 int edit_get_byte (WEdit
* edit
, long byte_index
);
158 char *edit_get_byte_ptr (WEdit
* edit
, long byte_index
);
159 char *edit_get_buf_ptr (WEdit
* edit
, long byte_index
);
160 int edit_get_utf (WEdit
* edit
, long byte_index
, int *char_width
);
161 int edit_get_prev_utf (WEdit
* edit
, long byte_index
, int *char_width
);
162 int edit_count_lines (WEdit
* edit
, long current
, int upto
);
163 long edit_move_forward (WEdit
* edit
, long current
, int lines
, long upto
);
164 long edit_move_forward3 (WEdit
* edit
, long current
, int cols
, long upto
);
165 long edit_move_backward (WEdit
* edit
, long current
, int lines
);
166 void edit_scroll_screen_over_cursor (WEdit
* edit
);
167 void edit_render_keypress (WEdit
* edit
);
168 void edit_scroll_upward (WEdit
* edit
, unsigned long i
);
169 void edit_scroll_downward (WEdit
* edit
, int i
);
170 void edit_scroll_right (WEdit
* edit
, int i
);
171 void edit_scroll_left (WEdit
* edit
, int i
);
172 void edit_move_up (WEdit
* edit
, unsigned long i
, int scroll
);
173 void edit_move_down (WEdit
* edit
, int i
, int scroll
);
174 void edit_move_to_prev_col (WEdit
*edit
, long p
);
175 int edit_get_col (WEdit
* edit
);
176 long edit_bol (WEdit
* edit
, long current
);
177 long edit_eol (WEdit
* edit
, long current
);
178 void edit_update_curs_row (WEdit
* edit
);
179 void edit_update_curs_col (WEdit
* edit
);
180 void edit_find_bracket (WEdit
* edit
);
181 int edit_reload_line (WEdit
*edit
, const char *filename
, long line
);
183 void edit_block_copy_cmd (WEdit
* edit
);
184 void edit_block_move_cmd (WEdit
* edit
);
185 int edit_block_delete_cmd (WEdit
* edit
);
186 void edit_delete_line (WEdit
* edit
);
187 void insert_spaces_tab (WEdit
* edit
, int half
);
189 int edit_delete (WEdit
* edit
, const int byte_delete
);
190 void edit_insert (WEdit
* edit
, int c
);
191 void edit_cursor_move (WEdit
* edit
, long increment
);
192 void edit_move_block_to_right (WEdit
* edit
);
193 void edit_move_block_to_left (WEdit
* edit
);
194 void edit_push_action (WEdit
* edit
, long c
, ...);
195 void edit_push_key_press (WEdit
* edit
);
196 void edit_insert_ahead (WEdit
* edit
, int c
);
197 long edit_write_stream (WEdit
* edit
, FILE * f
);
198 char *edit_get_write_filter (const char *writename
, const char *filename
);
199 int edit_save_confirm_cmd (WEdit
* edit
);
200 int edit_save_as_cmd (WEdit
* edit
);
201 WEdit
*edit_init (WEdit
*edit
, int lines
, int columns
,
202 const char *filename
, long line
);
203 int edit_clean (WEdit
* edit
);
204 int edit_ok_to_exit (WEdit
*edit
);
205 int edit_renew (WEdit
* edit
);
206 int edit_new_cmd (WEdit
* edit
);
207 int edit_reload (WEdit
*edit
, const char *filename
);
208 int edit_load_cmd (WEdit
* edit
, edit_current_file_t what
);
209 void edit_mark_cmd (WEdit
* edit
, int unmark
);
210 void edit_set_markers (WEdit
* edit
, long m1
, long m2
, int c1
, int c2
);
211 void edit_push_markers (WEdit
* edit
);
212 void edit_replace_cmd (WEdit
* edit
, int again
);
213 void edit_search_cmd (WEdit
* edit
, int again
);
214 void edit_complete_word_cmd (WEdit
* edit
);
215 void edit_get_match_keyword_cmd (WEdit
*edit
);
216 int edit_save_block (WEdit
* edit
, const char *filename
, long start
, long finish
);
217 int edit_save_block_cmd (WEdit
* edit
);
218 int edit_insert_file_cmd (WEdit
* edit
);
219 void edit_insert_column_of_text (WEdit
* edit
, unsigned char *data
, int size
, int width
);
220 int edit_insert_column_of_text_from_file (WEdit
* edit
, int file
);
221 int edit_insert_file (WEdit
* edit
, const char *filename
);
222 int edit_load_back_cmd (WEdit
* edit
);
223 int edit_load_forward_cmd (WEdit
* edit
);
224 void edit_block_process_cmd (WEdit
* edit
, const char *shell_cmd
, int block
);
225 void edit_refresh_cmd (WEdit
* edit
);
226 void edit_date_cmd (WEdit
* edit
);
227 void edit_goto_cmd (WEdit
* edit
);
228 int eval_marks (WEdit
* edit
, long *start_mark
, long *end_mark
);
229 void edit_status (WEdit
* edit
);
230 void edit_execute_key_command (WEdit
*edit
, int command
,
231 int char_for_insertion
);
232 void edit_update_screen (WEdit
* edit
);
233 int edit_print_string (WEdit
* e
, const char *s
);
234 void edit_move_to_line (WEdit
* e
, long line
);
235 void edit_move_display (WEdit
* e
, long line
);
236 void edit_word_wrap (WEdit
* edit
);
237 int edit_sort_cmd (WEdit
* edit
);
238 int edit_ext_cmd (WEdit
* edit
);
239 void edit_help_cmd (WEdit
* edit
);
241 int edit_save_macro_cmd (WEdit
* edit
, struct macro macro
[], int n
);
242 int edit_load_macro_cmd (WEdit
* edit
, struct macro macro
[], int *n
, int k
);
243 void edit_delete_macro_cmd (WEdit
* edit
);
245 int edit_copy_to_X_buf_cmd (WEdit
* edit
);
246 int edit_cut_to_X_buf_cmd (WEdit
* edit
);
247 void edit_paste_from_X_buf_cmd (WEdit
* edit
);
249 void edit_select_codepage_cmd (WEdit
*edit
);
250 void edit_insert_literal_cmd (WEdit
*edit
);
251 void edit_execute_macro_cmd (WEdit
*edit
);
252 void edit_begin_end_macro_cmd(WEdit
*edit
);
254 void edit_paste_from_history (WEdit
*edit
);
256 void edit_set_filename (WEdit
*edit
, const char *name
);
258 void edit_load_syntax (WEdit
* edit
, char ***pnames
, const char *type
);
259 void edit_free_syntax_rules (WEdit
* edit
);
260 void edit_get_syntax_color (WEdit
* edit
, long byte_index
, int *color
);
263 void book_mark_insert (WEdit
* edit
, int line
, int c
);
264 int book_mark_query_color (WEdit
* edit
, int line
, int c
);
265 int book_mark_query_all (WEdit
* edit
, int line
, int *c
);
266 struct _book_mark
*book_mark_find (WEdit
* edit
, int line
);
267 int book_mark_clear (WEdit
* edit
, int line
, int c
);
268 void book_mark_flush (WEdit
* edit
, int c
);
269 void book_mark_inc (WEdit
* edit
, int line
);
270 void book_mark_dec (WEdit
* edit
, int line
);
272 int line_is_blank (WEdit
*edit
, long line
);
273 int edit_indent_width (WEdit
*edit
, long p
);
274 void edit_insert_indent (WEdit
*edit
, int indent
);
275 void edit_options_dialog (void);
276 void edit_syntax_dialog (void);
277 void edit_mail_dialog (WEdit
*edit
);
278 void format_paragraph (WEdit
*edit
, int force
);
280 /* either command or char_for_insertion must be passed as -1 */
281 void edit_execute_cmd (WEdit
*edit
, int command
, int char_for_insertion
);
283 #define get_sys_error(s) (s)
285 #define edit_error_dialog(h,s) query_dialog (h, s, D_ERROR, 1, _("&Dismiss"))
287 #define edit_query_dialog2(h,t,a,b) query_dialog (h, t, D_NORMAL, 2, a, b)
288 #define edit_query_dialog3(h,t,a,b,c) query_dialog (h, t, D_NORMAL, 3, a, b, c)
290 #define color_palette(x) win->color[x].pixel
292 #define NUM_SELECTION_HISTORY 64
296 #define MAX_PATH_LEN PATH_MAX
298 #define MAX_PATH_LEN 1024
302 extern int edit_stack_iterator
;
303 extern edit_stack_type edit_history_moveto
[MAX_HISTORY_MOVETO
];
306 extern struct WMenuBar
*edit_menubar
;
308 extern const global_keymap_t
*editor_map
;
309 extern const global_keymap_t
*editor_x_map
;
311 extern int option_line_state_width
;
319 extern int option_max_undo
;
320 extern int option_auto_syntax
;
321 extern char *option_syntax_type
;
323 extern int option_edit_right_extreme
;
324 extern int option_edit_left_extreme
;
325 extern int option_edit_top_extreme
;
326 extern int option_edit_bottom_extreme
;
328 extern const char *option_whole_chars_search
;
329 extern int search_create_bookmark
;
331 extern int column_highlighting
;
333 #endif /* MC_EDIT_IMPL_H */