src/editor/edit-impl.h

   1 /*
   2    editor private API
   3  */
   4
   5 /** \file edit-impl.h
   6  *  \brief Header: editor low level data handling and cursor fundamentals
   7  *  \author Paul Sheer
   8  *  \date 1996, 1997
   9  */
  10
  11 #ifndef MC__EDIT_IMPL_H
  12 #define MC__EDIT_IMPL_H
  13
  14 #include <stdio.h>
  15
  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 */
  19
  20 #include "edit.h"
  21
  22 /*** typedefs(not structures) and defined constants **********************************************/
  23
  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)
  33
  34 #define EDIT_TEXT_HORIZONTAL_OFFSET 0
  35 #define EDIT_TEXT_VERTICAL_OFFSET   0
  36 #define EDIT_WITH_FRAME             1
  37
  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
  42
  43 /*
  44  * The editor keeps data in two arrays of buffers.
  45  * All buffers have the same size, which must be a power of 2.
  46  */
  47
  48 /* Configurable: log2 of the buffer size in bytes */
  49 #ifndef S_EDIT_BUF_SIZE
  50 #define S_EDIT_BUF_SIZE 16
  51 #endif
  52
  53 /* Size of the buffer */
  54 #define EDIT_BUF_SIZE (((off_t) 1) << S_EDIT_BUF_SIZE)
  55
  56 /* Buffer mask (used to find cursor position relative to the buffer) */
  57 #define M_EDIT_BUF_SIZE (EDIT_BUF_SIZE - 1)
  58
  59 /*
  60  * Configurable: Maximal allowed number of buffers in each buffer array.
  61  * This number can be increased for systems with enough physical memory.
  62  */
  63 #ifndef MAXBUFF
  64 #define MAXBUFF 1024
  65 #endif
  66
  67 /* Maximal length of file that can be opened */
  68 #define SIZE_LIMIT (EDIT_BUF_SIZE * (MAXBUFF - 2))
  69
  70 /* Initial size of the undo stack, in bytes */
  71 #define START_STACK_SIZE 32
  72
  73 /* Some codes that may be pushed onto or returned from the undo stack */
  74 #define CURS_LEFT       601
  75 #define CURS_RIGHT      602
  76 #define DELCHAR         603
  77 #define BACKSPACE       604
  78 #define STACK_BOTTOM    605
  79 #define CURS_LEFT_LOTS  606
  80 #define CURS_RIGHT_LOTS 607
  81 #define COLUMN_ON       608
  82 #define COLUMN_OFF      609
  83 #define DELCHAR_BR      610
  84 #define BACKSPACE_BR    611
  85 #define MARK_1          1000
  86 #define MARK_2          500000000
  87 #define MARK_CURS       1000000000
  88 #define KEY_PRESS       1500000000
  89
  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)
  93
  94 /* max count stack files */
  95 #define MAX_HISTORY_MOVETO     50
  96 #define LINE_STATE_WIDTH 8
  97
  98 #define LB_NAMES (LB_MAC + 1)
  99
 100 #define get_sys_error(s) (s)
 101
 102 #define edit_error_dialog(h,s) query_dialog (h, s, D_ERROR, 1, _("&Dismiss"))
 103
 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)
 106
 107 /*** enums ***************************************************************************************/
 108
 109 /* line breaks */
 110 typedef enum
 111 {
 112     LB_ASIS = 0,
 113     LB_UNIX,
 114     LB_WIN,
 115     LB_MAC
 116 } LineBreaks;
 117
 118 typedef enum
 119 {
 120     EDIT_QUICK_SAVE = 0,
 121     EDIT_SAFE_SAVE,
 122     EDIT_DO_BACKUP
 123 } edit_save_mode_t;
 124
 125 /*** structures declarations (and typedefs of structures)*****************************************/
 126
 127 /* search/replace options */
 128 typedef struct edit_search_options_t
 129 {
 130     mc_search_type_t type;
 131     gboolean case_sens;
 132     gboolean backwards;
 133     gboolean only_in_selection;
 134     gboolean whole_words;
 135     gboolean all_codepages;
 136 } edit_search_options_t;
 137
 138 typedef struct edit_stack_type
 139 {
 140     long line;
 141     vfs_path_t *filename_vpath;
 142 } edit_stack_type;
 143
 144 struct Widget;
 145 struct WMenuBar;
 146
 147 /*** global variables defined in .c file *********************************************************/
 148
 149 extern const char VERTICAL_MAGIC[5];
 150 /* if enable_show_tabs_tws ==1 then use visible_tab visible_tws */
 151 extern int enable_show_tabs_tws;
 152
 153 extern edit_search_options_t edit_search_options;
 154
 155 extern int edit_stack_iterator;
 156 extern edit_stack_type edit_history_moveto[MAX_HISTORY_MOVETO];
 157
 158 extern int option_line_state_width;
 159
 160 extern int option_max_undo;
 161 extern int option_auto_syntax;
 162
 163 extern int option_edit_right_extreme;
 164 extern int option_edit_left_extreme;
 165 extern int option_edit_top_extreme;
 166 extern int option_edit_bottom_extreme;
 167
 168 extern const char *option_whole_chars_search;
 169 extern gboolean search_create_bookmark;
 170
 171 /*** declarations of public functions ************************************************************/
 172
 173 gboolean edit_add_window (Dlg_head * h, int y, int x, int lines, int cols,
 174                           const vfs_path_t * f, int fline);
 175 WEdit *find_editor (const Dlg_head * h);
 176 gboolean edit_widget_is_editor (const Widget * w);
 177 gboolean edit_drop_hotkey_menu (Dlg_head * h, int key);
 178 void edit_menu_cmd (Dlg_head * h);
 179 void user_menu (WEdit * edit, const char *menu_file, int selected_entry);
 180 void edit_init_menu (struct WMenuBar *menubar);
 181 void edit_save_mode_cmd (void);
 182 gboolean edit_translate_key (WEdit * edit, long x_key, int *cmd, int *ch);
 183 int edit_get_byte (WEdit * edit, long byte_index);
 184 int edit_get_utf (WEdit * edit, long byte_index, int *char_width);
 185 long edit_count_lines (WEdit * edit, long current, long upto);
 186 long edit_move_forward (WEdit * edit, long current, long lines, long upto);
 187 long edit_move_forward3 (WEdit * edit, long current, int cols, long upto);
 188 long edit_move_backward (WEdit * edit, long current, long lines);
 189 void edit_scroll_screen_over_cursor (WEdit * edit);
 190 void edit_render_keypress (WEdit * edit);
 191 void edit_scroll_upward (WEdit * edit, unsigned long i);
 192 void edit_scroll_downward (WEdit * edit, int i);
 193 void edit_scroll_right (WEdit * edit, int i);
 194 void edit_scroll_left (WEdit * edit, int i);
 195 void edit_move_up (WEdit * edit, unsigned long i, int scroll);
 196 void edit_move_down (WEdit * edit, unsigned long i, int scroll);
 197 void edit_move_to_prev_col (WEdit * edit, long p);
 198 int edit_get_col (WEdit * edit);
 199 long edit_bol (WEdit * edit, long current);
 200 long edit_eol (WEdit * edit, long current);
 201 void edit_update_curs_row (WEdit * edit);
 202 void edit_update_curs_col (WEdit * edit);
 203 void edit_find_bracket (WEdit * edit);
 204 gboolean edit_reload_line (WEdit * edit, const vfs_path_t * filename_vpath, long line);
 205 void edit_set_codeset (WEdit * edit);
 206
 207 void edit_block_copy_cmd (WEdit * edit);
 208 void edit_block_move_cmd (WEdit * edit);
 209 int edit_block_delete_cmd (WEdit * edit);
 210 void edit_delete_line (WEdit * edit);
 211
 212 int edit_delete (WEdit * edit, const int byte_delete);
 213 void edit_insert (WEdit * edit, int c);
 214 void edit_cursor_move (WEdit * edit, long increment);
 215 void edit_push_undo_action (WEdit * edit, long c, ...);
 216 void edit_push_redo_action (WEdit * edit, long c, ...);
 217 void edit_push_key_press (WEdit * edit);
 218 void edit_insert_ahead (WEdit * edit, int c);
 219 long edit_write_stream (WEdit * edit, FILE * f);
 220 char *edit_get_write_filter (const vfs_path_t * write_name_vpath,
 221                              const vfs_path_t * filename_vpath);
 222 int edit_save_confirm_cmd (WEdit * edit);
 223 int edit_save_as_cmd (WEdit * edit);
 224 WEdit *edit_init (WEdit * edit, int y, int x, int lines, int cols,
 225                   const vfs_path_t * filename_vpath, long line);
 226 gboolean edit_clean (WEdit * edit);
 227 gboolean edit_ok_to_exit (WEdit * edit);
 228 gboolean edit_load_cmd (Dlg_head * h);
 229 gboolean edit_load_syntax_file (Dlg_head * h);
 230 gboolean edit_load_menu_file (Dlg_head * h);
 231 gboolean edit_close_cmd (WEdit * edit);
 232 void edit_mark_cmd (WEdit * edit, int unmark);
 233 void edit_mark_current_word_cmd (WEdit * edit);
 234 void edit_mark_current_line_cmd (WEdit * edit);
 235 void edit_set_markers (WEdit * edit, long m1, long m2, int c1, int c2);
 236 void edit_push_markers (WEdit * edit);
 237 void edit_replace_cmd (WEdit * edit, int again);
 238 void edit_search_cmd (WEdit * edit, gboolean again);
 239 mc_search_cbret_t edit_search_cmd_callback (const void *user_data, gsize char_offset,
 240                                             int *current_char);
 241 void edit_complete_word_cmd (WEdit * edit);
 242 void edit_get_match_keyword_cmd (WEdit * edit);
 243 int edit_save_block (WEdit * edit, const char *filename, long start, long finish);
 244 int edit_save_block_cmd (WEdit * edit);
 245 gboolean edit_insert_file_cmd (WEdit * edit);
 246 void edit_insert_over (WEdit * edit);
 247 int edit_insert_column_of_text_from_file (WEdit * edit, int file,
 248                                           long *start_pos, long *end_pos, int *col1, int *col2);
 249 long edit_insert_file (WEdit * edit, const vfs_path_t * filename_vpath);
 250 gboolean edit_load_back_cmd (WEdit * edit);
 251 gboolean edit_load_forward_cmd (WEdit * edit);
 252 void edit_block_process_cmd (WEdit * edit, int macro_number);
 253 void edit_refresh_cmd (void);
 254 void edit_syntax_onoff_cmd (Dlg_head * h);
 255 void edit_show_tabs_tws_cmd (Dlg_head * h);
 256 void edit_show_margin_cmd (Dlg_head * h);
 257 void edit_show_numbers_cmd (Dlg_head * h);
 258 void edit_date_cmd (WEdit * edit);
 259 void edit_goto_cmd (WEdit * edit);
 260 int eval_marks (WEdit * edit, long *start_mark, long *end_mark);
 261 void edit_info_status (WEdit * edit);
 262 void edit_status (WEdit * edit);
 263 void edit_execute_key_command (WEdit * edit, unsigned long command, int char_for_insertion);
 264 void edit_update_screen (WEdit * edit);
 265 void edit_save_size (WEdit * edit);
 266 gboolean edit_handle_move_resize (WEdit * edit, unsigned long command);
 267 void edit_move_to_line (WEdit * e, long line);
 268 void edit_move_display (WEdit * e, long line);
 269 void edit_word_wrap (WEdit * edit);
 270 int edit_sort_cmd (WEdit * edit);
 271 int edit_ext_cmd (WEdit * edit);
 272
 273 int edit_store_macro_cmd (WEdit * edit);
 274 gboolean edit_load_macro_cmd (WEdit * edit);
 275 void edit_delete_macro_cmd (WEdit * edit);
 276 gboolean edit_repeat_macro_cmd (WEdit * edit);
 277
 278 int edit_copy_to_X_buf_cmd (WEdit * edit);
 279 int edit_cut_to_X_buf_cmd (WEdit * edit);
 280 void edit_paste_from_X_buf_cmd (WEdit * edit);
 281
 282 void edit_select_codepage_cmd (WEdit * edit);
 283 void edit_insert_literal_cmd (WEdit * edit);
 284 gboolean edit_execute_macro (WEdit * edit, int hotkey);
 285 void edit_begin_end_macro_cmd (WEdit * edit);
 286 void edit_begin_end_repeat_cmd (WEdit * edit);
 287
 288 void edit_paste_from_history (WEdit * edit);
 289
 290 void edit_set_filename (WEdit * edit, const vfs_path_t * name_vpath);
 291
 292 void edit_load_syntax (WEdit * edit, char ***pnames, const char *type);
 293 void edit_free_syntax_rules (WEdit * edit);
 294 void edit_get_syntax_color (WEdit * edit, long byte_index, int *color);
 295
 296 void book_mark_insert (WEdit * edit, size_t line, int c);
 297 int book_mark_query_color (WEdit * edit, int line, int c);
 298 int book_mark_query_all (WEdit * edit, int line, int *c);
 299 struct _book_mark *book_mark_find (WEdit * edit, int line);
 300 int book_mark_clear (WEdit * edit, int line, int c);
 301 void book_mark_flush (WEdit * edit, int c);
 302 void book_mark_inc (WEdit * edit, int line);
 303 void book_mark_dec (WEdit * edit, int line);
 304 void book_mark_serialize (WEdit * edit, int color);
 305 void book_mark_restore (WEdit * edit, int color);
 306
 307 int line_is_blank (WEdit * edit, long line);
 308 int edit_indent_width (WEdit * edit, long p);
 309 void edit_insert_indent (WEdit * edit, int indent);
 310 void edit_options_dialog (Dlg_head * h);
 311 void edit_syntax_dialog (WEdit * edit);
 312 void edit_mail_dialog (WEdit * edit);
 313 void format_paragraph (WEdit * edit, int force);
 314
 315 /* either command or char_for_insertion must be passed as -1 */
 316 void edit_execute_cmd (WEdit * edit, unsigned long command, int char_for_insertion);
 317
 318 /*** inline functions ****************************************************************************/
 319
 320 /**
 321  * Load a new file into the editor.  If it fails, preserve the old file.
 322  * To do it, allocate a new widget, initialize it and, if the new file
 323  * was loaded, copy the data to the old widget.
 324  *
 325  * @returns TRUE on success, FALSE on failure.
 326  */
 327 static inline gboolean
 328 edit_reload (WEdit * edit, const vfs_path_t * filename_vpath)
 329 {
 330     return edit_reload_line (edit, filename_vpath, 0);
 331 }
 332
 333 #endif /* MC__EDIT_IMPL_H */