src/editor/editbuffer.h

   1 /** \file
   2  *  \brief Header: text keep buffer for WEdit
   3  */
   4
   5 #ifndef MC__EDIT_BUFFER_H
   6 #define MC__EDIT_BUFFER_H
   7
   8 /*** typedefs(not structures) and defined constants **********************************************/
   9
  10 /*** enums ***************************************************************************************/
  11
  12 /*** structures declarations (and typedefs of structures)*****************************************/
  13
  14 typedef struct edit_buffer_struct
  15 {
  16     off_t curs1;                /* position of the cursor from the beginning of the file. */
  17     off_t curs2;                /* position from the end of the file */
  18     GPtrArray *b1;              /* all data up to curs1 */
  19     GPtrArray *b2;              /* all data from end of file down to curs2 */
  20     off_t size;                 /* file size */
  21     long lines;                 /* total lines in the file */
  22     long curs_line;             /* line number of the cursor. */
  23 } edit_buffer_t;
  24
  25 typedef struct edit_buffer_read_file_status_msg_struct
  26 {
  27     simple_status_msg_t status_msg;     /* base class */
  28
  29     gboolean first;
  30     edit_buffer_t *buf;
  31     off_t loaded;
  32 } edit_buffer_read_file_status_msg_t;
  33
  34 /*** global variables defined in .c file *********************************************************/
  35
  36 /*** declarations of public functions ************************************************************/
  37
  38 void edit_buffer_init (edit_buffer_t * buf, off_t size);
  39 void edit_buffer_clean (edit_buffer_t * buf);
  40
  41 int edit_buffer_get_byte (const edit_buffer_t * buf, off_t byte_index);
  42 #ifdef HAVE_CHARSET
  43 int edit_buffer_get_utf (const edit_buffer_t * buf, off_t byte_index, int *char_length);
  44 int edit_buffer_get_prev_utf (const edit_buffer_t * buf, off_t byte_index, int *char_length);
  45 #endif
  46 long edit_buffer_count_lines (const edit_buffer_t * buf, off_t first, off_t last);
  47 off_t edit_buffer_get_bol (const edit_buffer_t * buf, off_t current);
  48 off_t edit_buffer_get_eol (const edit_buffer_t * buf, off_t current);
  49 GString *edit_buffer_get_word_from_pos (const edit_buffer_t * buf, off_t start_pos, off_t * start,
  50                                         gsize * cut);
  51
  52 void edit_buffer_insert (edit_buffer_t * buf, int c);
  53 void edit_buffer_insert_ahead (edit_buffer_t * buf, int c);
  54 int edit_buffer_delete (edit_buffer_t * buf);
  55 int edit_buffer_backspace (edit_buffer_t * buf);
  56
  57 off_t edit_buffer_get_forward_offset (const edit_buffer_t * buf, off_t current, long lines,
  58                                       off_t upto);
  59 off_t edit_buffer_get_backward_offset (const edit_buffer_t * buf, off_t current, long lines);
  60
  61 off_t edit_buffer_read_file (edit_buffer_t * buf, int fd, off_t size,
  62                              edit_buffer_read_file_status_msg_t * sm, gboolean * aborted);
  63 off_t edit_buffer_write_file (edit_buffer_t * buf, int fd);
  64
  65 int edit_buffer_calc_percent (const edit_buffer_t * buf, off_t offset);
  66
  67 /*** inline functions ****************************************************************************/
  68
  69 static inline int
  70 edit_buffer_get_current_byte (const edit_buffer_t * buf)
  71 {
  72     return edit_buffer_get_byte (buf, buf->curs1);
  73 }
  74
  75 /* --------------------------------------------------------------------------------------------- */
  76
  77 static inline int
  78 edit_buffer_get_previous_byte (const edit_buffer_t * buf)
  79 {
  80     return edit_buffer_get_byte (buf, buf->curs1 - 1);
  81 }
  82
  83 /* --------------------------------------------------------------------------------------------- */
  84 /**
  85  * Get "begin-of-line" offset of current line
  86  *
  87  * @param buf editor buffer
  88  *
  89  * @return index of first char of current line
  90  */
  91
  92 static inline off_t
  93 edit_buffer_get_current_bol (const edit_buffer_t * buf)
  94 {
  95     return edit_buffer_get_bol (buf, buf->curs1);
  96 }
  97
  98 /* --------------------------------------------------------------------------------------------- */
  99 /**
 100  * Get "end-of-line" offset of current line
 101  *
 102  * @param buf editor buffer
 103  *
 104  * @return index of first char of current line + 1
 105  */
 106
 107 static inline off_t
 108 edit_buffer_get_current_eol (const edit_buffer_t * buf)
 109 {
 110     return edit_buffer_get_eol (buf, buf->curs1);
 111 }
 112
 113 /* --------------------------------------------------------------------------------------------- */
 114
 115 #endif /* MC__EDIT_BUFFER_H */