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