src/editor/edit-impl.h

src/editor/edit-impl.h
Manual pages: mc • mcdiff • mcedit • mcview
/* */
This source file includes following definitions.
edit_reload
   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 "src/setup.h"  // option_tab_spacing
  21 
  22 #include "edit.h"
  23 
  24 /*** typedefs(not structures) and defined constants **********************************************/
  25 
  26 #define REDRAW_LINE                 (1 << 0)
  27 #define REDRAW_LINE_ABOVE           (1 << 1)
  28 #define REDRAW_LINE_BELOW           (1 << 2)
  29 #define REDRAW_AFTER_CURSOR         (1 << 3)
  30 #define REDRAW_BEFORE_CURSOR        (1 << 4)
  31 #define REDRAW_PAGE                 (1 << 5)
  32 #define REDRAW_IN_BOUNDS            (1 << 6)
  33 #define REDRAW_CHAR_ONLY            (1 << 7)
  34 #define REDRAW_COMPLETELY           (1 << 8)
  35 
  36 #define EDIT_TEXT_HORIZONTAL_OFFSET 0
  37 #define EDIT_TEXT_VERTICAL_OFFSET   0
  38 
  39 #define EDIT_RIGHT_EXTREME          0
  40 #define EDIT_LEFT_EXTREME           0
  41 #define EDIT_TOP_EXTREME            0
  42 #define EDIT_BOTTOM_EXTREME         0
  43 
  44 /* Initial size of the undo stack, in bytes */
  45 #define START_STACK_SIZE 32
  46 
  47 /* Some codes that may be pushed onto or returned from the undo stack */
  48 #define CURS_LEFT       601
  49 #define CURS_RIGHT      602
  50 #define DELCHAR         603
  51 #define BACKSPACE       604
  52 #define STACK_BOTTOM    605
  53 #define CURS_LEFT_LOTS  606
  54 #define CURS_RIGHT_LOTS 607
  55 #define COLUMN_ON       608
  56 #define COLUMN_OFF      609
  57 #define DELCHAR_BR      610
  58 #define BACKSPACE_BR    611
  59 #define MARK_1          1000
  60 #define MARK_2          500000000
  61 #define MARK_CURS       1000000000
  62 #define KEY_PRESS       1500000000
  63 
  64 /* Tabs spaces: (sofar only HALF_TAB_SIZE is used: */
  65 #define TAB_SIZE      option_tab_spacing
  66 #define HALF_TAB_SIZE ((int) option_tab_spacing / 2)
  67 
  68 /* max count stack files */
  69 #define MAX_HISTORY_MOVETO                50
  70 #define LINE_STATE_WIDTH                  8
  71 
  72 #define LB_NAMES                          (LB_MAC + 1)
  73 
  74 #define edit_query_dialog2(h, t, a, b)    query_dialog (h, t, D_NORMAL, 2, a, b)
  75 #define edit_query_dialog3(h, t, a, b, c) query_dialog (h, t, D_NORMAL, 3, a, b, c)
  76 
  77 /*** enums ***************************************************************************************/
  78 
  79 /* line breaks */
  80 typedef enum
  81 {
  82     LB_ASIS = 0,
  83     LB_UNIX,
  84     LB_WIN,
  85     LB_MAC
  86 } LineBreaks;
  87 
  88 typedef enum
  89 {
  90     EDIT_QUICK_SAVE = 0,
  91     EDIT_SAFE_SAVE,
  92     EDIT_DO_BACKUP
  93 } edit_save_mode_t;
  94 
  95 /*** structures declarations (and typedefs of structures)*****************************************/
  96 
  97 /*** global variables defined in .c file *********************************************************/
  98 
  99 extern const char VERTICAL_MAGIC[5];
 100 /* if enable_show_tabs_tws == TRUE then use visible_tab visible_tws */
 101 extern gboolean enable_show_tabs_tws;
 102 
 103 extern unsigned int edit_stack_iterator;
 104 extern edit_arg_t edit_history_moveto[MAX_HISTORY_MOVETO];
 105 
 106 extern int max_undo;
 107 extern gboolean auto_syntax;
 108 
 109 extern gboolean search_create_bookmark;
 110 
 111 extern char *edit_window_state_char;
 112 extern char *edit_window_close_char;
 113 
 114 /*** declarations of public functions ************************************************************/
 115 
 116 gboolean edit_add_window (WDialog *h, const WRect *r, const edit_arg_t *arg);
 117 WEdit *edit_find_editor (const WDialog *h);
 118 gboolean edit_widget_is_editor (const Widget *w);
 119 gboolean edit_drop_hotkey_menu (WDialog *h, int key);
 120 void edit_menu_cmd (WDialog *h);
 121 void edit_user_menu (WEdit *edit, const char *menu_file, int selected_entry);
 122 void edit_init_menu (WMenuBar *menubar);
 123 void edit_save_mode_cmd (void);
 124 off_t edit_move_forward3 (const WEdit *edit, off_t current, long cols, off_t upto);
 125 void edit_scroll_screen_over_cursor (WEdit *edit);
 126 void edit_render_keypress (WEdit *edit);
 127 void edit_scroll_upward (WEdit *edit, long i);
 128 void edit_scroll_downward (WEdit *edit, long i);
 129 void edit_scroll_right (WEdit *edit, long i);
 130 void edit_scroll_left (WEdit *edit, long i);
 131 void edit_move_up (WEdit *edit, long i, gboolean do_scroll);
 132 void edit_move_down (WEdit *edit, long i, gboolean do_scroll);
 133 void edit_move_to_prev_col (WEdit *edit, off_t p);
 134 long edit_get_col (const WEdit *edit);
 135 void edit_update_curs_row (WEdit *edit);
 136 void edit_update_curs_col (WEdit *edit);
 137 void edit_find_bracket (WEdit *edit);
 138 gboolean edit_reload_line (WEdit *edit, const edit_arg_t *arg);
 139 void edit_set_codeset (WEdit *edit);
 140 
 141 void edit_block_copy_cmd (WEdit *edit);
 142 void edit_block_move_cmd (WEdit *edit);
 143 gboolean edit_block_delete_cmd (WEdit *edit);
 144 void edit_delete_line (WEdit *edit);
 145 
 146 int edit_delete (WEdit *edit, gboolean byte_delete);
 147 int edit_backspace (WEdit *edit, gboolean byte_delete);
 148 void edit_insert (WEdit *edit, int c);
 149 void edit_insert_over (WEdit *edit);
 150 void edit_cursor_move (WEdit *edit, off_t increment);
 151 void edit_push_undo_action (WEdit *edit, long c);
 152 void edit_push_redo_action (WEdit *edit, long c);
 153 void edit_push_key_press (WEdit *edit);
 154 void edit_insert_ahead (WEdit *edit, int c);
 155 off_t edit_write_stream (WEdit *edit, FILE *f);
 156 char *edit_get_write_filter (const vfs_path_t *write_name_vpath, const vfs_path_t *filename_vpath);
 157 gboolean edit_save_confirm_cmd (WEdit *edit);
 158 gboolean edit_save_as_cmd (WEdit *edit);
 159 WEdit *edit_init (WEdit *edit, const WRect *r, const edit_arg_t *arg);
 160 gboolean edit_clean (WEdit *edit);
 161 gboolean edit_ok_to_quit (WEdit *edit);
 162 gboolean edit_load_cmd (WDialog *h);
 163 gboolean edit_load_file_from_filename (WDialog *h, const edit_arg_t *arg);
 164 gboolean edit_load_file_from_history (WDialog *h);
 165 gboolean edit_load_syntax_file (WDialog *h);
 166 gboolean edit_load_menu_file (WDialog *h);
 167 gboolean edit_close_cmd (WEdit *edit);
 168 void edit_mark_cmd (WEdit *edit, gboolean unmark);
 169 void edit_mark_current_word_cmd (WEdit *edit);
 170 void edit_mark_current_line_cmd (WEdit *edit);
 171 void edit_set_markers (WEdit *edit, off_t m1, off_t m2, long c1, long c2);
 172 void edit_push_markers (WEdit *edit);
 173 
 174 gboolean edit_save_block (WEdit *edit, const char *filename, off_t start, off_t finish);
 175 gboolean edit_save_block_cmd (WEdit *edit);
 176 gboolean edit_insert_file_cmd (WEdit *edit);
 177 
 178 off_t edit_insert_file (WEdit *edit, const vfs_path_t *filename_vpath);
 179 gboolean edit_load_back_cmd (WEdit *edit);
 180 gboolean edit_load_forward_cmd (WEdit *edit);
 181 void edit_block_process_cmd (WEdit *edit, int macro_number);
 182 void edit_refresh_cmd (void);
 183 void edit_syntax_onoff_cmd (WDialog *h);
 184 void edit_show_tabs_tws_cmd (WDialog *h);
 185 void edit_show_margin_cmd (WDialog *h);
 186 void edit_show_numbers_cmd (WDialog *h);
 187 void edit_date_cmd (WEdit *edit);
 188 void edit_goto_cmd (WEdit *edit);
 189 gboolean eval_marks (WEdit *edit, off_t *start_mark, off_t *end_mark);
 190 void edit_status (WEdit *edit, gboolean active);
 191 void edit_execute_key_command (WEdit *edit, long command, int char_for_insertion);
 192 void edit_update_screen (WEdit *edit);
 193 void edit_save_size (WEdit *edit);
 194 gboolean edit_handle_move_resize (WEdit *edit, long command);
 195 void edit_toggle_fullscreen (WEdit *edit);
 196 void edit_move_to_line (WEdit *e, long line);
 197 void edit_move_display (WEdit *e, long line);
 198 void edit_word_wrap (WEdit *edit);
 199 int edit_sort_cmd (WEdit *edit);
 200 int edit_ext_cmd (WEdit *edit);
 201 
 202 gboolean edit_copy_to_X_buf_cmd (WEdit *edit);
 203 gboolean edit_cut_to_X_buf_cmd (WEdit *edit);
 204 gboolean edit_paste_from_X_buf_cmd (WEdit *edit);
 205 
 206 void edit_select_codepage_cmd (WEdit *edit);
 207 void edit_insert_literal_cmd (WEdit *edit);
 208 
 209 void edit_paste_from_history (WEdit *edit);
 210 
 211 void edit_set_filename (WEdit *edit, const vfs_path_t *name_vpath);
 212 
 213 MC_MOCKABLE void edit_load_syntax (WEdit *edit, GPtrArray *pnames, const char *type);
 214 void edit_free_syntax_rules (WEdit *edit);
 215 MC_MOCKABLE int edit_get_syntax_color (WEdit *edit, off_t byte_index);
 216 void edit_syntax_dialog (WEdit *edit);
 217 
 218 void book_mark_insert (WEdit *edit, long line, int c);
 219 gboolean book_mark_query_color (WEdit *edit, long line, int c);
 220 struct edit_book_mark_t *book_mark_find (WEdit *edit, long line);
 221 gboolean book_mark_clear (WEdit *edit, long line, int c);
 222 void book_mark_flush (WEdit *edit, int c);
 223 void book_mark_inc (WEdit *edit, long line);
 224 void book_mark_dec (WEdit *edit, long line);
 225 void book_mark_serialize (WEdit *edit, int color);
 226 void book_mark_restore (WEdit *edit, int color);
 227 
 228 gboolean edit_line_is_blank (WEdit *edit, long line);
 229 gboolean is_break_char (char c);
 230 void edit_options_dialog (WDialog *h);
 231 void edit_mail_dialog (WEdit *edit);
 232 void format_paragraph (WEdit *edit, gboolean force);
 233 
 234 /* either command or char_for_insertion must be passed as -1 */
 235 void edit_execute_cmd (WEdit *edit, long command, int char_for_insertion);
 236 
 237 int editcmd_dialog_raw_key_query (const char *heading, const char *query, gboolean cancel);
 238 
 239 /*** inline functions ****************************************************************************/
 240 
 241 /**
 242  * Load a new file into the editor.  If it fails, preserve the old file.
 243  * To do it, allocate a new widget, initialize it and, if the new file
 244  * was loaded, copy the data to the old widget.
 245  *
 246  * @return TRUE on success, FALSE on failure.
 247  */
 248 static inline gboolean
 249 edit_reload (WEdit *edit, const vfs_path_t *filename_vpath)
     /*   */
 250 {
 251     edit_arg_t arg;
 252 
 253     edit_arg_init (&arg, (vfs_path_t *) filename_vpath, 0);
 254 
 255     return edit_reload_line (edit, &arg);
 256 }
 257 
 258 #endif
/* */
root/src/editor/edit-impl.h

INCLUDED FROM

DEFINITIONS
