src/editor/edit-impl.h

   1 /* edit.h - editor private API
   2
   3    Copyright (C) 1996, 1997, 2009 Free Software Foundation, Inc.
   4
   5    Authors: 1996, 1997 Paul Sheer
   6    2009 Andrew Borodin
   7
   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.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22  */
  23
  24 /** \file edit-impl.h
  25  *  \brief Header: editor low level data handling and cursor fundamentals
  26  *  \author Paul Sheer
  27  *  \date 1996, 1997
  28  */
  29
  30 #ifndef MC__EDIT_IMPL_H
  31 #define MC__EDIT_IMPL_H
  32
  33 #include <stdio.h>
  34
  35 #include "lib/search.h"         /* mc_search_type_t */
  36 #include "lib/widget.h"         /* cb_ret_t */
  37
  38 #include "edit.h"
  39
  40 /*** typedefs(not structures) and defined constants **********************************************/
  41
  42 #define SEARCH_DIALOG_OPTION_NO_SCANF   (1 << 0)
  43 #define SEARCH_DIALOG_OPTION_NO_REGEX   (1 << 1)
  44 #define SEARCH_DIALOG_OPTION_NO_CASE    (1 << 2)
  45 #define SEARCH_DIALOG_OPTION_BACKWARDS  (1 << 3)
  46 #define SEARCH_DIALOG_OPTION_BOOKMARK   (1 << 4)
  47
  48 #define EDIT_KEY_EMULATION_NORMAL 0
  49 #define EDIT_KEY_EMULATION_EMACS  1
  50 #define EDIT_KEY_EMULATION_USER   2
  51
  52 #define REDRAW_LINE          (1 << 0)
  53 #define REDRAW_LINE_ABOVE    (1 << 1)
  54 #define REDRAW_LINE_BELOW    (1 << 2)
  55 #define REDRAW_AFTER_CURSOR  (1 << 3)
  56 #define REDRAW_BEFORE_CURSOR (1 << 4)
  57 #define REDRAW_PAGE          (1 << 5)
  58 #define REDRAW_IN_BOUNDS     (1 << 6)
  59 #define REDRAW_CHAR_ONLY     (1 << 7)
  60 #define REDRAW_COMPLETELY    (1 << 8)
  61
  62 #define EDIT_TEXT_HORIZONTAL_OFFSET 0
  63 #define EDIT_TEXT_VERTICAL_OFFSET   1
  64
  65 #define EDIT_RIGHT_EXTREME option_edit_right_extreme
  66 #define EDIT_LEFT_EXTREME option_edit_left_extreme
  67 #define EDIT_TOP_EXTREME option_edit_top_extreme
  68 #define EDIT_BOTTOM_EXTREME option_edit_bottom_extreme
  69
  70 /*
  71  * The editor keeps data in two arrays of buffers.
  72  * All buffers have the same size, which must be a power of 2.
  73  */
  74
  75 /* Configurable: log2 of the buffer size in bytes */
  76 #ifndef S_EDIT_BUF_SIZE
  77 #define S_EDIT_BUF_SIZE 16
  78 #endif
  79
  80 /* Size of the buffer */
  81 #define EDIT_BUF_SIZE (((off_t) 1) << S_EDIT_BUF_SIZE)
  82
  83 /* Buffer mask (used to find cursor position relative to the buffer) */
  84 #define M_EDIT_BUF_SIZE (EDIT_BUF_SIZE - 1)
  85
  86 /*
  87  * Configurable: Maximal allowed number of buffers in each buffer array.
  88  * This number can be increased for systems with enough physical memory.
  89  */
  90 #ifndef MAXBUFF
  91 #define MAXBUFF 1024
  92 #endif
  93
  94 /* Maximal length of file that can be opened */
  95 #define SIZE_LIMIT (EDIT_BUF_SIZE * (MAXBUFF - 2))
  96
  97 /* Initial size of the undo stack, in bytes */
  98 #define START_STACK_SIZE 32
  99
 100 /* Some codes that may be pushed onto or returned from the undo stack */
 101 #define CURS_LEFT       601
 102 #define CURS_RIGHT      602
 103 #define DELCHAR         603
 104 #define BACKSPACE       604
 105 #define STACK_BOTTOM    605
 106 #define CURS_LEFT_LOTS  606
 107 #define CURS_RIGHT_LOTS 607
 108 #define COLUMN_ON       608
 109 #define COLUMN_OFF      609
 110 #define DELCHAR_BR      610
 111 #define BACKSPACE_BR    611
 112 #define MARK_1          1000
 113 #define MARK_2          500000000
 114 #define MARK_CURS       1000000000
 115 #define KEY_PRESS       1500000000
 116
 117 /* Tabs spaces: (sofar only HALF_TAB_SIZE is used: */
 118 #define TAB_SIZE      option_tab_spacing
 119 #define HALF_TAB_SIZE ((int) option_tab_spacing / 2)
 120
 121 /* max count stack files */
 122 #define MAX_HISTORY_MOVETO     50
 123 #define LINE_STATE_WIDTH 8
 124
 125 #define LB_NAMES (LB_MAC + 1)
 126
 127 #define get_sys_error(s) (s)
 128
 129 #define edit_error_dialog(h,s) query_dialog (h, s, D_ERROR, 1, _("&Dismiss"))
 130
 131 #define edit_query_dialog2(h,t,a,b) query_dialog (h, t, D_NORMAL, 2, a, b)
 132 #define edit_query_dialog3(h,t,a,b,c) query_dialog (h, t, D_NORMAL, 3, a, b, c)
 133
 134 #ifndef MAX_PATH_LEN
 135 #ifdef PATH_MAX
 136 #define MAX_PATH_LEN PATH_MAX
 137 #else
 138 #define MAX_PATH_LEN 1024
 139 #endif
 140 #endif
 141
 142 /*** enums ***************************************************************************************/
 143
 144 /* type for file which is currently being edited */
 145 typedef enum
 146 {
 147     EDIT_FILE_COMMON = 0,
 148     EDIT_FILE_SYNTAX = 1,
 149     EDIT_FILE_MENU = 2
 150 } edit_current_file_t;
 151
 152 /* line breaks */
 153 typedef enum
 154 {
 155     LB_ASIS = 0,
 156     LB_UNIX,
 157     LB_WIN,
 158     LB_MAC
 159 } LineBreaks;
 160
 161 typedef enum
 162 {
 163     EDIT_QUICK_SAVE = 0,
 164     EDIT_SAFE_SAVE,
 165     EDIT_DO_BACKUP
 166 } edit_save_mode_t;
 167
 168 /*** structures declarations (and typedefs of structures)*****************************************/
 169
 170 /* search/replace options */
 171 typedef struct edit_search_options_t
 172 {
 173     mc_search_type_t type;
 174     gboolean case_sens;
 175     gboolean backwards;
 176     gboolean only_in_selection;
 177     gboolean whole_words;
 178     gboolean all_codepages;
 179 } edit_search_options_t;
 180
 181 typedef struct edit_stack_type
 182 {
 183     long line;
 184     char *filename;
 185 } edit_stack_type;
 186
 187 struct macro
 188 {
 189     unsigned long command;
 190     int ch;
 191 };
 192
 193 struct Widget;
 194 struct WMenuBar;
 195
 196 /*** global variables defined in .c file *********************************************************/
 197
 198 extern const char VERTICAL_MAGIC[5];
 199 /* if enable_show_tabs_tws ==1 then use visible_tab visible_tws */
 200 extern int enable_show_tabs_tws;
 201
 202 extern edit_search_options_t edit_search_options;
 203
 204 extern int edit_stack_iterator;
 205 extern edit_stack_type edit_history_moveto[MAX_HISTORY_MOVETO];
 206
 207 extern int option_line_state_width;
 208
 209 extern int option_max_undo;
 210 extern int option_auto_syntax;
 211
 212 extern int option_edit_right_extreme;
 213 extern int option_edit_left_extreme;
 214 extern int option_edit_top_extreme;
 215 extern int option_edit_bottom_extreme;
 216
 217 extern const char *option_whole_chars_search;
 218 extern gboolean search_create_bookmark;
 219
 220 /*** declarations of public functions ************************************************************/
 221
 222 int edit_drop_hotkey_menu (WEdit * e, int key);
 223 void edit_menu_cmd (WEdit * e);
 224 void edit_init_menu (struct WMenuBar *menubar);
 225 void menu_save_mode_cmd (void);
 226 int edit_translate_key (WEdit * edit, long x_key, int *cmd, int *ch);
 227 int edit_get_byte (WEdit * edit, long byte_index);
 228 char *edit_get_byte_ptr (WEdit * edit, long byte_index);
 229 char *edit_get_buf_ptr (WEdit * edit, long byte_index);
 230 int edit_get_utf (WEdit * edit, long byte_index, int *char_width);
 231 int edit_get_prev_utf (WEdit * edit, long byte_index, int *char_width);
 232 long edit_count_lines (WEdit * edit, long current, long upto);
 233 long edit_move_forward (WEdit * edit, long current, long lines, long upto);
 234 long edit_move_forward3 (WEdit * edit, long current, int cols, long upto);
 235 long edit_move_backward (WEdit * edit, long current, long lines);
 236 void edit_scroll_screen_over_cursor (WEdit * edit);
 237 void edit_render_keypress (WEdit * edit);
 238 void edit_scroll_upward (WEdit * edit, unsigned long i);
 239 void edit_scroll_downward (WEdit * edit, int i);
 240 void edit_scroll_right (WEdit * edit, int i);
 241 void edit_scroll_left (WEdit * edit, int i);
 242 void edit_move_up (WEdit * edit, unsigned long i, int scroll);
 243 void edit_move_down (WEdit * edit, unsigned long i, int scroll);
 244 void edit_move_to_prev_col (WEdit * edit, long p);
 245 int edit_get_col (WEdit * edit);
 246 long edit_bol (WEdit * edit, long current);
 247 long edit_eol (WEdit * edit, long current);
 248 void edit_update_curs_row (WEdit * edit);
 249 void edit_update_curs_col (WEdit * edit);
 250 void edit_find_bracket (WEdit * edit);
 251 int edit_reload_line (WEdit * edit, const char *filename, long line);
 252 void edit_set_codeset (WEdit * edit);
 253
 254 void edit_block_copy_cmd (WEdit * edit);
 255 void edit_block_move_cmd (WEdit * edit);
 256 int edit_block_delete_cmd (WEdit * edit);
 257 void edit_delete_line (WEdit * edit);
 258 void insert_spaces_tab (WEdit * edit, int half);
 259
 260 int edit_delete (WEdit * edit, const int byte_delete);
 261 void edit_insert (WEdit * edit, int c);
 262 void edit_cursor_move (WEdit * edit, long increment);
 263 void edit_move_block_to_right (WEdit * edit);
 264 void edit_move_block_to_left (WEdit * edit);
 265 void edit_push_undo_action (WEdit * edit, long c, ...);
 266 void edit_push_redo_action (WEdit * edit, long c, ...);
 267 void edit_push_key_press (WEdit * edit);
 268 void edit_insert_ahead (WEdit * edit, int c);
 269 long edit_write_stream (WEdit * edit, FILE * f);
 270 char *edit_get_write_filter (const char *writename, const char *filename);
 271 int edit_save_confirm_cmd (WEdit * edit);
 272 int edit_save_as_cmd (WEdit * edit);
 273 WEdit *edit_init (WEdit * edit, int lines, int columns, const char *filename, long line);
 274 int edit_clean (WEdit * edit);
 275 gboolean edit_ok_to_exit (WEdit * edit);
 276 int edit_renew (WEdit * edit);
 277 int edit_new_cmd (WEdit * edit);
 278 int edit_reload (WEdit * edit, const char *filename);
 279 int edit_load_cmd (WEdit * edit, edit_current_file_t what);
 280 void edit_mark_cmd (WEdit * edit, int unmark);
 281 void edit_mark_current_word_cmd (WEdit * edit);
 282 void edit_mark_current_line_cmd (WEdit * edit);
 283 void edit_set_markers (WEdit * edit, long m1, long m2, int c1, int c2);
 284 void edit_push_markers (WEdit * edit);
 285 void edit_replace_cmd (WEdit * edit, int again);
 286 void edit_search_cmd (WEdit * edit, gboolean again);
 287 int edit_search_cmd_callback (const void *user_data, gsize char_offset);
 288 void edit_complete_word_cmd (WEdit * edit);
 289 void edit_get_match_keyword_cmd (WEdit * edit);
 290 int edit_save_block (WEdit * edit, const char *filename, long start, long finish);
 291 int edit_save_block_cmd (WEdit * edit);
 292 int edit_insert_file_cmd (WEdit * edit);
 293 void edit_insert_column_of_text (WEdit * edit, unsigned char *data, int size, int width);
 294 int edit_insert_column_of_text_from_file (WEdit * edit, int file);
 295 long edit_insert_file (WEdit * edit, const char *filename);
 296 int edit_load_back_cmd (WEdit * edit);
 297 int edit_load_forward_cmd (WEdit * edit);
 298 void edit_block_process_cmd (WEdit * edit, const char *shell_cmd, int block);
 299 void edit_refresh_cmd (WEdit * edit);
 300 void edit_date_cmd (WEdit * edit);
 301 void edit_goto_cmd (WEdit * edit);
 302 int eval_marks (WEdit * edit, long *start_mark, long *end_mark);
 303 void edit_status (WEdit * edit);
 304 void edit_execute_key_command (WEdit * edit, unsigned long command, int char_for_insertion);
 305 void edit_update_screen (WEdit * edit);
 306 int edit_print_string (WEdit * e, const char *s);
 307 void edit_move_to_line (WEdit * e, long line);
 308 void edit_move_display (WEdit * e, long line);
 309 void edit_word_wrap (WEdit * edit);
 310 int edit_sort_cmd (WEdit * edit);
 311 int edit_ext_cmd (WEdit * edit);
 312 void edit_help_cmd (WEdit * edit);
 313
 314 int edit_save_macro_cmd (WEdit * edit, struct macro macro[], int n);
 315 int edit_load_macro_cmd (WEdit * edit, struct macro macro[], int *n, int k);
 316 void edit_delete_macro_cmd (WEdit * edit);
 317
 318 int edit_copy_to_X_buf_cmd (WEdit * edit);
 319 int edit_cut_to_X_buf_cmd (WEdit * edit);
 320 void edit_paste_from_X_buf_cmd (WEdit * edit);
 321
 322 void edit_select_codepage_cmd (WEdit * edit);
 323 void edit_insert_literal_cmd (WEdit * edit);
 324 void edit_execute_macro_cmd (WEdit * edit);
 325 void edit_begin_end_macro_cmd (WEdit * edit);
 326
 327 void edit_paste_from_history (WEdit * edit);
 328
 329 void edit_set_filename (WEdit * edit, const char *name);
 330
 331 void edit_load_syntax (WEdit * edit, char ***pnames, const char *type);
 332 void edit_free_syntax_rules (WEdit * edit);
 333 void edit_get_syntax_color (WEdit * edit, long byte_index, int *color);
 334
 335 void book_mark_insert (WEdit * edit, size_t line, int c);
 336 int book_mark_query_color (WEdit * edit, int line, int c);
 337 int book_mark_query_all (WEdit * edit, int line, int *c);
 338 struct _book_mark *book_mark_find (WEdit * edit, int line);
 339 int book_mark_clear (WEdit * edit, int line, int c);
 340 void book_mark_flush (WEdit * edit, int c);
 341 void book_mark_inc (WEdit * edit, int line);
 342 void book_mark_dec (WEdit * edit, int line);
 343 void book_mark_serialize (WEdit * edit, int color);
 344 void book_mark_restore (WEdit * edit, int color);
 345
 346 int line_is_blank (WEdit * edit, long line);
 347 int edit_indent_width (WEdit * edit, long p);
 348 void edit_insert_indent (WEdit * edit, int indent);
 349 void edit_options_dialog (WEdit * edit);
 350 void edit_syntax_dialog (WEdit * edit);
 351 void edit_mail_dialog (WEdit * edit);
 352 void format_paragraph (WEdit * edit, int force);
 353
 354 unsigned int edit_unlock_file (WEdit * edit);
 355 unsigned int edit_lock_file (WEdit * edit);
 356
 357 /* either command or char_for_insertion must be passed as -1 */
 358 void edit_execute_cmd (WEdit * edit, unsigned long command, int char_for_insertion);
 359
 360 /*** inline functions ****************************************************************************/
 361
 362 #endif /* MC__EDIT_IMPL_H */