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