diff options
Diffstat (limited to 'src/buffer_defs.h')
| -rw-r--r-- | src/buffer_defs.h | 1081 |
1 files changed, 1081 insertions, 0 deletions
diff --git a/src/buffer_defs.h b/src/buffer_defs.h new file mode 100644 index 0000000000..9d5e75b609 --- /dev/null +++ b/src/buffer_defs.h @@ -0,0 +1,1081 @@ +#ifndef NEOVIM_BUFFER_DEFS_H +#define NEOVIM_BUFFER_DEFS_H + +// for garray_T +#include "garray.h" +// for pos_T and lpos_T +#include "pos.h" +// for the number window-local and buffer-local options +#include "option_defs.h" +// for jump list and tag stack sizes in a buffer and mark types +#include "mark_defs.h" +// for u_header_T +#include "undo_defs.h" +// for hashtab_T +#include "hashtab.h" +// for dict_T +#include "eval_defs.h" + +typedef struct window_S win_T; +typedef struct wininfo_S wininfo_T; +typedef struct frame_S frame_T; +typedef int scid_T; /* script ID */ +typedef struct file_buffer buf_T; /* forward declaration */ +typedef struct memfile memfile_T; + +// for struct memline (it needs memfile_T) +#include "memline_defs.h" + +// for struct memfile, bhdr_T, blocknr_T... (it needs buf_T) +#include "memfile_defs.h" + +/* + * This is here because regexp_defs.h needs win_T and buf_T. regprog_T is + * used below. + */ +#include "regexp_defs.h" + +// for synstate_T (needs reg_extmatch_T, win_T and buf_T) +#include "syntax_defs.h" + +/* + * The taggy struct is used to store the information about a :tag command. + */ +typedef struct taggy { + char_u *tagname; /* tag name */ + fmark_T fmark; /* cursor position BEFORE ":tag" */ + int cur_match; /* match number */ + int cur_fnum; /* buffer number used for cur_match */ +} taggy_T; + +/* + * structure used to store one block of the stuff/redo/recording buffers + */ +struct buffblock { + struct buffblock *b_next; /* pointer to next buffblock */ + char_u b_str[1]; /* contents (actually longer) */ +}; + +/* + * header used for the stuff buffer and the redo buffer + */ +struct buffheader { + struct buffblock bh_first; /* first (dummy) block of list */ + struct buffblock *bh_curr; /* buffblock for appending */ + int bh_index; /* index for reading */ + int bh_space; /* space in bh_curr for appending */ +}; + +/* + * Structure that contains all options that are local to a window. + * Used twice in a window: for the current buffer and for all buffers. + * Also used in wininfo_T. + */ +typedef struct { + int wo_arab; +# define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */ + int wo_diff; +# define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */ + long wo_fdc; +# define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */ + int wo_fdc_save; +# define w_p_fdc_save w_onebuf_opt.wo_fdc_save /* 'foldenable' saved for diff mode */ + int wo_fen; +# define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */ + int wo_fen_save; +# define w_p_fen_save w_onebuf_opt.wo_fen_save /* 'foldenable' saved for diff mode */ + char_u *wo_fdi; +# define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */ + long wo_fdl; +# define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */ + int wo_fdl_save; +# define w_p_fdl_save w_onebuf_opt.wo_fdl_save /* 'foldlevel' state saved for diff mode */ + char_u *wo_fdm; +# define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */ + char_u *wo_fdm_save; +# define w_p_fdm_save w_onebuf_opt.wo_fdm_save /* 'fdm' saved for diff mode */ + long wo_fml; +# define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */ + long wo_fdn; +# define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnestmax' */ + char_u *wo_fde; +# define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */ + char_u *wo_fdt; +# define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */ + char_u *wo_fmr; +# define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */ + int wo_lbr; +# define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */ + int wo_list; +#define w_p_list w_onebuf_opt.wo_list /* 'list' */ + int wo_nu; +#define w_p_nu w_onebuf_opt.wo_nu /* 'number' */ + int wo_rnu; +#define w_p_rnu w_onebuf_opt.wo_rnu /* 'relativenumber' */ + long wo_nuw; +# define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */ + int wo_wfh; +# define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */ + int wo_wfw; +# define w_p_wfw w_onebuf_opt.wo_wfw /* 'winfixwidth' */ + int wo_pvw; +# define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */ + int wo_rl; +# define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */ + char_u *wo_rlc; +# define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */ + long wo_scr; +#define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */ + int wo_spell; +# define w_p_spell w_onebuf_opt.wo_spell /* 'spell' */ + int wo_cuc; +# define w_p_cuc w_onebuf_opt.wo_cuc /* 'cursorcolumn' */ + int wo_cul; +# define w_p_cul w_onebuf_opt.wo_cul /* 'cursorline' */ + char_u *wo_cc; +# define w_p_cc w_onebuf_opt.wo_cc /* 'colorcolumn' */ + char_u *wo_stl; +#define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */ + int wo_scb; +# define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */ + int wo_diff_saved; /* options were saved for starting diff mode */ +# define w_p_diff_saved w_onebuf_opt.wo_diff_saved + int wo_scb_save; /* 'scrollbind' saved for diff mode*/ +# define w_p_scb_save w_onebuf_opt.wo_scb_save + int wo_wrap; +#define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */ + int wo_wrap_save; /* 'wrap' state saved for diff mode*/ +# define w_p_wrap_save w_onebuf_opt.wo_wrap_save + char_u *wo_cocu; /* 'concealcursor' */ +# define w_p_cocu w_onebuf_opt.wo_cocu + long wo_cole; /* 'conceallevel' */ +# define w_p_cole w_onebuf_opt.wo_cole + int wo_crb; +# define w_p_crb w_onebuf_opt.wo_crb /* 'cursorbind' */ + int wo_crb_save; /* 'cursorbind' state saved for diff mode*/ +# define w_p_crb_save w_onebuf_opt.wo_crb_save + + int wo_scriptID[WV_COUNT]; /* SIDs for window-local options */ +# define w_p_scriptID w_onebuf_opt.wo_scriptID +} winopt_T; + +/* + * Window info stored with a buffer. + * + * Two types of info are kept for a buffer which are associated with a + * specific window: + * 1. Each window can have a different line number associated with a buffer. + * 2. The window-local options for a buffer work in a similar way. + * The window-info is kept in a list at b_wininfo. It is kept in + * most-recently-used order. + */ +struct wininfo_S { + wininfo_T *wi_next; /* next entry or NULL for last entry */ + wininfo_T *wi_prev; /* previous entry or NULL for first entry */ + win_T *wi_win; /* pointer to window that did set wi_fpos */ + pos_T wi_fpos; /* last cursor position in the file */ + int wi_optset; /* TRUE when wi_opt has useful values */ + winopt_T wi_opt; /* local window options */ + int wi_fold_manual; /* copy of w_fold_manual */ + garray_T wi_folds; /* clone of w_folds */ +}; + +/* + * Argument list: Array of file names. + * Used for the global argument list and the argument lists local to a window. + * + * TODO: move struct arglist to another header + */ +typedef struct arglist { + garray_T al_ga; /* growarray with the array of file names */ + int al_refcount; /* number of windows using this arglist */ +} alist_T; + +/* + * For each argument remember the file name as it was given, and the buffer + * number that contains the expanded file name (required for when ":cd" is + * used. + * + * TODO: move aentry_T to another header + */ +typedef struct argentry { + char_u *ae_fname; /* file name as specified */ + int ae_fnum; /* buffer number with expanded file name */ +} aentry_T; + +# define ALIST(win) (win)->w_alist +#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data) +#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data) +#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data) +#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data)) +#define GARGCOUNT (global_alist.al_ga.ga_len) +#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len) +#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len) + +#ifdef USE_ICONV +# ifdef HAVE_ICONV_H +# include <iconv.h> +# else +# include <errno.h> +typedef void *iconv_t; +# endif +#endif + +/* + * Used for the typeahead buffer: typebuf. + */ +typedef struct { + char_u *tb_buf; /* buffer for typed characters */ + char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */ + int tb_buflen; /* size of tb_buf[] */ + int tb_off; /* current position in tb_buf[] */ + int tb_len; /* number of valid bytes in tb_buf[] */ + int tb_maplen; /* nr of mapped bytes in tb_buf[] */ + int tb_silent; /* nr of silently mapped bytes in tb_buf[] */ + int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */ + int tb_change_cnt; /* nr of time tb_buf was changed; never zero */ +} typebuf_T; + +/* Struct to hold the saved typeahead for save_typeahead(). */ +typedef struct { + typebuf_T save_typebuf; + int typebuf_valid; /* TRUE when save_typebuf valid */ + int old_char; + int old_mod_mask; + struct buffheader save_stuffbuff; +#ifdef USE_INPUT_BUF + char_u *save_inputbuf; +#endif +} tasave_T; + +/* + * Used for conversion of terminal I/O and script files. + */ +typedef struct { + int vc_type; /* zero or one of the CONV_ values */ + int vc_factor; /* max. expansion factor */ +# ifdef USE_ICONV + iconv_t vc_fd; /* for CONV_ICONV */ +# endif + int vc_fail; /* fail for invalid char, don't use '?' */ +} vimconv_T; + +/* + * Structure used for reading from the viminfo file. + */ +typedef struct { + char_u *vir_line; /* text of the current line */ + FILE *vir_fd; /* file descriptor */ + vimconv_T vir_conv; /* encoding conversion */ +} vir_T; + +#define CONV_NONE 0 +#define CONV_TO_UTF8 1 +#define CONV_9_TO_UTF8 2 +#define CONV_TO_LATIN1 3 +#define CONV_TO_LATIN9 4 +#define CONV_ICONV 5 + +/* + * Structure used for mappings and abbreviations. + */ +typedef struct mapblock mapblock_T; +struct mapblock { + mapblock_T *m_next; /* next mapblock in list */ + char_u *m_keys; /* mapped from, lhs */ + char_u *m_str; /* mapped to, rhs */ + char_u *m_orig_str; /* rhs as entered by the user */ + int m_keylen; /* strlen(m_keys) */ + int m_mode; /* valid mode */ + int m_noremap; /* if non-zero no re-mapping for m_str */ + char m_silent; /* <silent> used, don't echo commands */ + char m_nowait; /* <nowait> used */ + char m_expr; /* <expr> used, m_str is an expression */ + scid_T m_script_ID; /* ID of script where map was defined */ +}; + +/* + * Used for highlighting in the status line. + */ +struct stl_hlrec { + char_u *start; + int userhl; /* 0: no HL, 1-9: User HL, < 0 for syn ID */ +}; + +/* values for b_syn_spell: what to do with toplevel text */ +#define SYNSPL_DEFAULT 0 /* spell check if @Spell not defined */ +#define SYNSPL_TOP 1 /* spell check toplevel text */ +#define SYNSPL_NOTOP 2 /* don't spell check toplevel text */ + +/* avoid #ifdefs for when b_spell is not available */ +# define B_SPELL(buf) ((buf)->b_spell) + +typedef struct qf_info_S qf_info_T; + +/* + * Used for :syntime: timing of executing a syntax pattern. + */ +typedef struct { + proftime_T total; /* total time used */ + proftime_T slowest; /* time of slowest call */ + long count; /* nr of times used */ + long match; /* nr of times matched */ +} syn_time_T; + +/* + * These are items normally related to a buffer. But when using ":ownsyntax" + * a window may have its own instance. + */ +typedef struct { + hashtab_T b_keywtab; /* syntax keywords hash table */ + hashtab_T b_keywtab_ic; /* idem, ignore case */ + int b_syn_error; /* TRUE when error occurred in HL */ + int b_syn_ic; /* ignore case for :syn cmds */ + int b_syn_spell; /* SYNSPL_ values */ + garray_T b_syn_patterns; /* table for syntax patterns */ + garray_T b_syn_clusters; /* table for syntax clusters */ + int b_spell_cluster_id; /* @Spell cluster ID or 0 */ + int b_nospell_cluster_id; /* @NoSpell cluster ID or 0 */ + int b_syn_containedin; /* TRUE when there is an item with a + "containedin" argument */ + int b_syn_sync_flags; /* flags about how to sync */ + short b_syn_sync_id; /* group to sync on */ + long b_syn_sync_minlines; /* minimal sync lines offset */ + long b_syn_sync_maxlines; /* maximal sync lines offset */ + long b_syn_sync_linebreaks; /* offset for multi-line pattern */ + char_u *b_syn_linecont_pat; /* line continuation pattern */ + regprog_T *b_syn_linecont_prog; /* line continuation program */ + syn_time_T b_syn_linecont_time; + int b_syn_linecont_ic; /* ignore-case flag for above */ + int b_syn_topgrp; /* for ":syntax include" */ + int b_syn_conceal; /* auto-conceal for :syn cmds */ + int b_syn_folditems; /* number of patterns with the HL_FOLD + flag set */ + /* + * b_sst_array[] contains the state stack for a number of lines, for the + * start of that line (col == 0). This avoids having to recompute the + * syntax state too often. + * b_sst_array[] is allocated to hold the state for all displayed lines, + * and states for 1 out of about 20 other lines. + * b_sst_array pointer to an array of synstate_T + * b_sst_len number of entries in b_sst_array[] + * b_sst_first pointer to first used entry in b_sst_array[] or NULL + * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL + * b_sst_freecount number of free entries in b_sst_array[] + * b_sst_check_lnum entries after this lnum need to be checked for + * validity (MAXLNUM means no check needed) + */ + synstate_T *b_sst_array; + int b_sst_len; + synstate_T *b_sst_first; + synstate_T *b_sst_firstfree; + int b_sst_freecount; + linenr_T b_sst_check_lnum; + short_u b_sst_lasttick; /* last display tick */ + + /* for spell checking */ + garray_T b_langp; /* list of pointers to slang_T, see spell.c */ + char_u b_spell_ismw[256]; /* flags: is midword char */ + char_u *b_spell_ismw_mb; /* multi-byte midword chars */ + char_u *b_p_spc; /* 'spellcapcheck' */ + regprog_T *b_cap_prog; /* program for 'spellcapcheck' */ + char_u *b_p_spf; /* 'spellfile' */ + char_u *b_p_spl; /* 'spelllang' */ + int b_cjk; /* all CJK letters as OK */ +} synblock_T; + + +/* + * buffer: structure that holds information about one file + * + * Several windows can share a single Buffer + * A buffer is unallocated if there is no memfile for it. + * A buffer is new if the associated file has never been loaded yet. + */ + +struct file_buffer { + memline_T b_ml; /* associated memline (also contains line + count) */ + + buf_T *b_next; /* links in list of buffers */ + buf_T *b_prev; + + int b_nwindows; /* nr of windows open on this buffer */ + + int b_flags; /* various BF_ flags */ + int b_closing; /* buffer is being closed, don't let + autocommands close it too. */ + + /* + * b_ffname has the full path of the file (NULL for no name). + * b_sfname is the name as the user typed it (or NULL). + * b_fname is the same as b_sfname, unless ":cd" has been done, + * then it is the same as b_ffname (NULL for no name). + */ + char_u *b_ffname; /* full path file name */ + char_u *b_sfname; /* short file name */ + char_u *b_fname; /* current file name */ + +#ifdef UNIX + int b_dev_valid; /* TRUE when b_dev has a valid number */ + dev_t b_dev; /* device number */ + ino_t b_ino; /* inode number */ +#endif + + int b_fnum; /* buffer number for this file. */ + + int b_changed; /* 'modified': Set to TRUE if something in the + file has been changed and not written out. */ + int b_changedtick; /* incremented for each change, also for undo */ + + int b_saving; /* Set to TRUE if we are in the middle of + saving the buffer. */ + + /* + * Changes to a buffer require updating of the display. To minimize the + * work, remember changes made and update everything at once. + */ + int b_mod_set; /* TRUE when there are changes since the last + time the display was updated */ + linenr_T b_mod_top; /* topmost lnum that was changed */ + linenr_T b_mod_bot; /* lnum below last changed line, AFTER the + change */ + long b_mod_xlines; /* number of extra buffer lines inserted; + negative when lines were deleted */ + + wininfo_T *b_wininfo; /* list of last used info for each window */ + + long b_mtime; /* last change time of original file */ + long b_mtime_read; /* last change time when reading */ + off_t b_orig_size; /* size of original file in bytes */ + int b_orig_mode; /* mode of original file */ + + pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */ + + /* These variables are set when VIsual_active becomes FALSE */ + visualinfo_T b_visual; + int b_visual_mode_eval; /* b_visual.vi_mode for visualmode() */ + + pos_T b_last_cursor; /* cursor position when last unloading this + buffer */ + pos_T b_last_insert; /* where Insert mode was left */ + pos_T b_last_change; /* position of last change: '. mark */ + + /* + * the changelist contains old change positions + */ + pos_T b_changelist[JUMPLISTSIZE]; + int b_changelistlen; /* number of active entries */ + int b_new_change; /* set by u_savecommon() */ + + /* + * Character table, only used in charset.c for 'iskeyword' + * 32 bytes of 8 bits: 1 bit per character 0-255. + */ + char_u b_chartab[32]; + + /* Table used for mappings local to a buffer. */ + mapblock_T *(b_maphash[256]); + + /* First abbreviation local to a buffer. */ + mapblock_T *b_first_abbr; + /* User commands local to the buffer. */ + garray_T b_ucmds; + /* + * start and end of an operator, also used for '[ and '] + */ + pos_T b_op_start; + pos_T b_op_end; + + int b_marks_read; /* Have we read viminfo marks yet? */ + + /* + * The following only used in undo.c. + */ + u_header_T *b_u_oldhead; /* pointer to oldest header */ + u_header_T *b_u_newhead; /* pointer to newest header; may not be valid + if b_u_curhead is not NULL */ + u_header_T *b_u_curhead; /* pointer to current header */ + int b_u_numhead; /* current number of headers */ + int b_u_synced; /* entry lists are synced */ + long b_u_seq_last; /* last used undo sequence number */ + long b_u_save_nr_last; /* counter for last file write */ + long b_u_seq_cur; /* hu_seq of header below which we are now */ + time_t b_u_time_cur; /* uh_time of header below which we are now */ + long b_u_save_nr_cur; /* file write nr after which we are now */ + + /* + * variables for "U" command in undo.c + */ + char_u *b_u_line_ptr; /* saved line for "U" command */ + linenr_T b_u_line_lnum; /* line number of line in u_line */ + colnr_T b_u_line_colnr; /* optional column number */ + + int b_scanned; /* ^N/^P have scanned this buffer */ + + /* flags for use of ":lmap" and IM control */ + long b_p_iminsert; /* input mode for insert */ + long b_p_imsearch; /* input mode for search */ +#define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */ +#define B_IMODE_NONE 0 /* Input via none */ +#define B_IMODE_LMAP 1 /* Input via langmap */ +#ifndef USE_IM_CONTROL +# define B_IMODE_LAST 1 +#else +# define B_IMODE_IM 2 /* Input via input method */ +# define B_IMODE_LAST 2 +#endif + + short b_kmap_state; /* using "lmap" mappings */ +# define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */ +# define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */ + garray_T b_kmap_ga; /* the keymap table */ + + /* + * Options local to a buffer. + * They are here because their value depends on the type of file + * or contents of the file being edited. + */ + int b_p_initialized; /* set when options initialized */ + + int b_p_scriptID[BV_COUNT]; /* SIDs for buffer-local options */ + + int b_p_ai; /* 'autoindent' */ + int b_p_ai_nopaste; /* b_p_ai saved for paste mode */ + int b_p_ci; /* 'copyindent' */ + int b_p_bin; /* 'binary' */ + int b_p_bomb; /* 'bomb' */ + char_u *b_p_bh; /* 'bufhidden' */ + char_u *b_p_bt; /* 'buftype' */ + int b_p_bl; /* 'buflisted' */ + int b_p_cin; /* 'cindent' */ + char_u *b_p_cino; /* 'cinoptions' */ + char_u *b_p_cink; /* 'cinkeys' */ + char_u *b_p_cinw; /* 'cinwords' */ + char_u *b_p_com; /* 'comments' */ + char_u *b_p_cms; /* 'commentstring' */ + char_u *b_p_cpt; /* 'complete' */ + char_u *b_p_cfu; /* 'completefunc' */ + char_u *b_p_ofu; /* 'omnifunc' */ + int b_p_eol; /* 'endofline' */ + int b_p_et; /* 'expandtab' */ + int b_p_et_nobin; /* b_p_et saved for binary mode */ + char_u *b_p_fenc; /* 'fileencoding' */ + char_u *b_p_ff; /* 'fileformat' */ + char_u *b_p_ft; /* 'filetype' */ + char_u *b_p_fo; /* 'formatoptions' */ + char_u *b_p_flp; /* 'formatlistpat' */ + int b_p_inf; /* 'infercase' */ + char_u *b_p_isk; /* 'iskeyword' */ + char_u *b_p_def; /* 'define' local value */ + char_u *b_p_inc; /* 'include' */ + char_u *b_p_inex; /* 'includeexpr' */ + long_u b_p_inex_flags; /* flags for 'includeexpr' */ + char_u *b_p_inde; /* 'indentexpr' */ + long_u b_p_inde_flags; /* flags for 'indentexpr' */ + char_u *b_p_indk; /* 'indentkeys' */ + char_u *b_p_fex; /* 'formatexpr' */ + long_u b_p_fex_flags; /* flags for 'formatexpr' */ + char_u *b_p_key; /* 'key' */ + char_u *b_p_kp; /* 'keywordprg' */ + int b_p_lisp; /* 'lisp' */ + char_u *b_p_mps; /* 'matchpairs' */ + int b_p_ml; /* 'modeline' */ + int b_p_ml_nobin; /* b_p_ml saved for binary mode */ + int b_p_ma; /* 'modifiable' */ + char_u *b_p_nf; /* 'nrformats' */ + int b_p_pi; /* 'preserveindent' */ + char_u *b_p_qe; /* 'quoteescape' */ + int b_p_ro; /* 'readonly' */ + long b_p_sw; /* 'shiftwidth' */ +#ifndef SHORT_FNAME + int b_p_sn; /* 'shortname' */ +#endif + int b_p_si; /* 'smartindent' */ + long b_p_sts; /* 'softtabstop' */ + long b_p_sts_nopaste; /* b_p_sts saved for paste mode */ + char_u *b_p_sua; /* 'suffixesadd' */ + int b_p_swf; /* 'swapfile' */ + long b_p_smc; /* 'synmaxcol' */ + char_u *b_p_syn; /* 'syntax' */ + long b_p_ts; /* 'tabstop' */ + int b_p_tx; /* 'textmode' */ + long b_p_tw; /* 'textwidth' */ + long b_p_tw_nobin; /* b_p_tw saved for binary mode */ + long b_p_tw_nopaste; /* b_p_tw saved for paste mode */ + long b_p_wm; /* 'wrapmargin' */ + long b_p_wm_nobin; /* b_p_wm saved for binary mode */ + long b_p_wm_nopaste; /* b_p_wm saved for paste mode */ + char_u *b_p_keymap; /* 'keymap' */ + + /* local values for options which are normally global */ + char_u *b_p_gp; /* 'grepprg' local value */ + char_u *b_p_mp; /* 'makeprg' local value */ + char_u *b_p_efm; /* 'errorformat' local value */ + char_u *b_p_ep; /* 'equalprg' local value */ + char_u *b_p_path; /* 'path' local value */ + int b_p_ar; /* 'autoread' local value */ + char_u *b_p_tags; /* 'tags' local value */ + char_u *b_p_dict; /* 'dictionary' local value */ + char_u *b_p_tsr; /* 'thesaurus' local value */ + long b_p_ul; /* 'undolevels' local value */ + int b_p_udf; /* 'undofile' */ + + /* end of buffer options */ + + /* values set from b_p_cino */ + int b_ind_level; + int b_ind_open_imag; + int b_ind_no_brace; + int b_ind_first_open; + int b_ind_open_extra; + int b_ind_close_extra; + int b_ind_open_left_imag; + int b_ind_jump_label; + int b_ind_case; + int b_ind_case_code; + int b_ind_case_break; + int b_ind_param; + int b_ind_func_type; + int b_ind_comment; + int b_ind_in_comment; + int b_ind_in_comment2; + int b_ind_cpp_baseclass; + int b_ind_continuation; + int b_ind_unclosed; + int b_ind_unclosed2; + int b_ind_unclosed_noignore; + int b_ind_unclosed_wrapped; + int b_ind_unclosed_whiteok; + int b_ind_matching_paren; + int b_ind_paren_prev; + int b_ind_maxparen; + int b_ind_maxcomment; + int b_ind_scopedecl; + int b_ind_scopedecl_code; + int b_ind_java; + int b_ind_js; + int b_ind_keep_case_label; + int b_ind_hash_comment; + int b_ind_cpp_namespace; + int b_ind_if_for_while; + + linenr_T b_no_eol_lnum; /* non-zero lnum when last line of next binary + * write should not have an end-of-line */ + + int b_start_eol; /* last line had eol when it was read */ + int b_start_ffc; /* first char of 'ff' when edit started */ + char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */ + int b_bad_char; /* "++bad=" argument when edit started or 0 */ + int b_start_bomb; /* 'bomb' when it was read */ + + dictitem_T b_bufvar; /* variable for "b:" Dictionary */ + dict_T *b_vars; /* internal variables, local to buffer */ + + char_u *b_p_cm; /* 'cryptmethod' */ + + /* When a buffer is created, it starts without a swap file. b_may_swap is + * then set to indicate that a swap file may be opened later. It is reset + * if a swap file could not be opened. + */ + int b_may_swap; + int b_did_warn; /* Set to 1 if user has been warned on first + change of a read-only file */ + + /* Two special kinds of buffers: + * help buffer - used for help files, won't use a swap file. + * spell buffer - used for spell info, never displayed and doesn't have a + * file name. + */ + int b_help; /* TRUE for help file buffer (when set b_p_bt + is "help") */ + int b_spell; /* TRUE for a spell file buffer, most fields + are not used! Use the B_SPELL macro to + access b_spell without #ifdef. */ + +#ifndef SHORT_FNAME + int b_shortname; /* this file has an 8.3 file name */ +#endif + + synblock_T b_s; /* Info related to syntax highlighting. w_s + * normally points to this, but some windows + * may use a different synblock_T. */ +}; + +/* + * Stuff for diff mode. + */ +# define DB_COUNT 4 /* up to four buffers can be diff'ed */ + +/* + * Each diffblock defines where a block of lines starts in each of the buffers + * and how many lines it occupies in that buffer. When the lines are missing + * in the buffer the df_count[] is zero. This is all counted in + * buffer lines. + * There is always at least one unchanged line in between the diffs. + * Otherwise it would have been included in the diff above or below it. + * df_lnum[] + df_count[] is the lnum below the change. When in one buffer + * lines have been inserted, in the other buffer df_lnum[] is the line below + * the insertion and df_count[] is zero. When appending lines at the end of + * the buffer, df_lnum[] is one beyond the end! + * This is using a linked list, because the number of differences is expected + * to be reasonable small. The list is sorted on lnum. + */ +typedef struct diffblock_S diff_T; +struct diffblock_S { + diff_T *df_next; + linenr_T df_lnum[DB_COUNT]; /* line number in buffer */ + linenr_T df_count[DB_COUNT]; /* nr of inserted/changed lines */ +}; + +#define SNAP_HELP_IDX 0 +# define SNAP_AUCMD_IDX 1 +# define SNAP_COUNT 2 + +/* + * Tab pages point to the top frame of each tab page. + * Note: Most values are NOT valid for the current tab page! Use "curwin", + * "firstwin", etc. for that. "tp_topframe" is always valid and can be + * compared against "topframe" to find the current tab page. + */ +typedef struct tabpage_S tabpage_T; +struct tabpage_S { + tabpage_T *tp_next; /* next tabpage or NULL */ + frame_T *tp_topframe; /* topframe for the windows */ + win_T *tp_curwin; /* current window in this Tab page */ + win_T *tp_prevwin; /* previous window in this Tab page */ + win_T *tp_firstwin; /* first window in this Tab page */ + win_T *tp_lastwin; /* last window in this Tab page */ + long tp_old_Rows; /* Rows when Tab page was left */ + long tp_old_Columns; /* Columns when Tab page was left */ + long tp_ch_used; /* value of 'cmdheight' when frame size + was set */ + diff_T *tp_first_diff; + buf_T *(tp_diffbuf[DB_COUNT]); + int tp_diff_invalid; /* list of diffs is outdated */ + frame_T *(tp_snapshot[SNAP_COUNT]); /* window layout snapshots */ + dictitem_T tp_winvar; /* variable for "t:" Dictionary */ + dict_T *tp_vars; /* internal variables, local to tab page */ +}; + +/* + * Structure to cache info for displayed lines in w_lines[]. + * Each logical line has one entry. + * The entry tells how the logical line is currently displayed in the window. + * This is updated when displaying the window. + * When the display is changed (e.g., when clearing the screen) w_lines_valid + * is changed to exclude invalid entries. + * When making changes to the buffer, wl_valid is reset to indicate wl_size + * may not reflect what is actually in the buffer. When wl_valid is FALSE, + * the entries can only be used to count the number of displayed lines used. + * wl_lnum and wl_lastlnum are invalid too. + */ +typedef struct w_line { + linenr_T wl_lnum; /* buffer line number for logical line */ + short_u wl_size; /* height in screen lines */ + char wl_valid; /* TRUE values are valid for text in buffer */ + char wl_folded; /* TRUE when this is a range of folded lines */ + linenr_T wl_lastlnum; /* last buffer line number for logical line */ +} wline_T; + +/* + * Windows are kept in a tree of frames. Each frame has a column (FR_COL) + * or row (FR_ROW) layout or is a leaf, which has a window. + */ +struct frame_S { + char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */ + int fr_width; + int fr_newwidth; /* new width used in win_equal_rec() */ + int fr_height; + int fr_newheight; /* new height used in win_equal_rec() */ + frame_T *fr_parent; /* containing frame or NULL */ + frame_T *fr_next; /* frame right or below in same parent, NULL + for first */ + frame_T *fr_prev; /* frame left or above in same parent, NULL + for last */ + /* fr_child and fr_win are mutually exclusive */ + frame_T *fr_child; /* first contained frame */ + win_T *fr_win; /* window that fills this frame */ +}; + +#define FR_LEAF 0 /* frame is a leaf */ +#define FR_ROW 1 /* frame with a row of windows */ +#define FR_COL 2 /* frame with a column of windows */ + +/* + * Struct used for highlighting 'hlsearch' matches, matches defined by + * ":match" and matches defined by match functions. + * For 'hlsearch' there is one pattern for all windows. For ":match" and the + * match functions there is a different pattern for each window. + */ +typedef struct { + regmmatch_T rm; /* points to the regexp program; contains last found + match (may continue in next line) */ + buf_T *buf; /* the buffer to search for a match */ + linenr_T lnum; /* the line to search for a match */ + int attr; /* attributes to be used for a match */ + int attr_cur; /* attributes currently active in win_line() */ + linenr_T first_lnum; /* first lnum to search for multi-line pat */ + colnr_T startcol; /* in win_line() points to char where HL starts */ + colnr_T endcol; /* in win_line() points to char where HL ends */ + proftime_T tm; /* for a time limit */ +} match_T; + +/* + * matchitem_T provides a linked list for storing match items for ":match" and + * the match functions. + */ +typedef struct matchitem matchitem_T; +struct matchitem { + matchitem_T *next; + int id; /* match ID */ + int priority; /* match priority */ + char_u *pattern; /* pattern to highlight */ + int hlg_id; /* highlight group ID */ + regmmatch_T match; /* regexp program for pattern */ + match_T hl; /* struct for doing the actual highlighting */ +}; + +/* + * Structure which contains all information that belongs to a window + * + * All row numbers are relative to the start of the window, except w_winrow. + */ +struct window_S { + buf_T *w_buffer; /* buffer we are a window into (used + often, keep it the first item!) */ + + synblock_T *w_s; /* for :ownsyntax */ + + win_T *w_prev; /* link to previous window */ + win_T *w_next; /* link to next window */ + int w_closing; /* window is being closed, don't let + autocommands close it too. */ + + frame_T *w_frame; /* frame containing this window */ + + pos_T w_cursor; /* cursor position in buffer */ + + colnr_T w_curswant; /* The column we'd like to be at. This is + used to try to stay in the same column + for up/down cursor motions. */ + + int w_set_curswant; /* If set, then update w_curswant the next + time through cursupdate() to the + current virtual column */ + + /* + * the next six are used to update the visual part + */ + char w_old_visual_mode; /* last known VIsual_mode */ + linenr_T w_old_cursor_lnum; /* last known end of visual part */ + colnr_T w_old_cursor_fcol; /* first column for block visual part */ + colnr_T w_old_cursor_lcol; /* last column for block visual part */ + linenr_T w_old_visual_lnum; /* last known start of visual part */ + colnr_T w_old_visual_col; /* last known start of visual part */ + colnr_T w_old_curswant; /* last known value of Curswant */ + + /* + * "w_topline", "w_leftcol" and "w_skipcol" specify the offsets for + * displaying the buffer. + */ + linenr_T w_topline; /* buffer line number of the line at the + top of the window */ + char w_topline_was_set; /* flag set to TRUE when topline is set, + e.g. by winrestview() */ + int w_topfill; /* number of filler lines above w_topline */ + int w_old_topfill; /* w_topfill at last redraw */ + int w_botfill; /* TRUE when filler lines are actually + below w_topline (at end of file) */ + int w_old_botfill; /* w_botfill at last redraw */ + colnr_T w_leftcol; /* window column number of the left most + character in the window; used when + 'wrap' is off */ + colnr_T w_skipcol; /* starting column when a single line + doesn't fit in the window */ + + /* + * Layout of the window in the screen. + * May need to add "msg_scrolled" to "w_winrow" in rare situations. + */ + int w_winrow; /* first row of window in screen */ + int w_height; /* number of rows in window, excluding + status/command line(s) */ + int w_status_height; /* number of status lines (0 or 1) */ + int w_wincol; /* Leftmost column of window in screen. + use W_WINCOL() */ + int w_width; /* Width of window, excluding separation. + use W_WIDTH() */ + int w_vsep_width; /* Number of separator columns (0 or 1). + use W_VSEP_WIDTH() */ + + /* + * === start of cached values ==== + */ + /* + * Recomputing is minimized by storing the result of computations. + * Use functions in screen.c to check if they are valid and to update. + * w_valid is a bitfield of flags, which indicate if specific values are + * valid or need to be recomputed. See screen.c for values. + */ + int w_valid; + pos_T w_valid_cursor; /* last known position of w_cursor, used + to adjust w_valid */ + colnr_T w_valid_leftcol; /* last known w_leftcol */ + + /* + * w_cline_height is the number of physical lines taken by the buffer line + * that the cursor is on. We use this to avoid extra calls to plines(). + */ + int w_cline_height; /* current size of cursor line */ + int w_cline_folded; /* cursor line is folded */ + + int w_cline_row; /* starting row of the cursor line */ + + colnr_T w_virtcol; /* column number of the cursor in the + buffer line, as opposed to the column + number we're at on the screen. This + makes a difference on lines which span + more than one screen line or when + w_leftcol is non-zero */ + + /* + * w_wrow and w_wcol specify the cursor position in the window. + * This is related to positions in the window, not in the display or + * buffer, thus w_wrow is relative to w_winrow. + */ + int w_wrow, w_wcol; /* cursor position in window */ + + linenr_T w_botline; /* number of the line below the bottom of + the screen */ + int w_empty_rows; /* number of ~ rows in window */ + int w_filler_rows; /* number of filler rows at the end of the + window */ + + /* + * Info about the lines currently in the window is remembered to avoid + * recomputing it every time. The allocated size of w_lines[] is Rows. + * Only the w_lines_valid entries are actually valid. + * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline + * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline. + * Between changing text and updating the display w_lines[] represents + * what is currently displayed. wl_valid is reset to indicated this. + * This is used for efficient redrawing. + */ + int w_lines_valid; /* number of valid entries */ + wline_T *w_lines; + + garray_T w_folds; /* array of nested folds */ + char w_fold_manual; /* when TRUE: some folds are opened/closed + manually */ + char w_foldinvalid; /* when TRUE: folding needs to be + recomputed */ + int w_nrwidth; /* width of 'number' and 'relativenumber' + column being used */ + + /* + * === end of cached values === + */ + + int w_redr_type; /* type of redraw to be performed on win */ + int w_upd_rows; /* number of window lines to update when + w_redr_type is REDRAW_TOP */ + linenr_T w_redraw_top; /* when != 0: first line needing redraw */ + linenr_T w_redraw_bot; /* when != 0: last line needing redraw */ + int w_redr_status; /* if TRUE status line must be redrawn */ + + /* remember what is shown in the ruler for this window (if 'ruler' set) */ + pos_T w_ru_cursor; /* cursor position shown in ruler */ + colnr_T w_ru_virtcol; /* virtcol shown in ruler */ + linenr_T w_ru_topline; /* topline shown in ruler */ + linenr_T w_ru_line_count; /* line count used for ruler */ + int w_ru_topfill; /* topfill shown in ruler */ + char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */ + + int w_alt_fnum; /* alternate file (for # and CTRL-^) */ + + alist_T *w_alist; /* pointer to arglist for this window */ + int w_arg_idx; /* current index in argument list (can be + out of range!) */ + int w_arg_idx_invalid; /* editing another file than w_arg_idx */ + + char_u *w_localdir; /* absolute path of local directory or + NULL */ + /* + * Options local to a window. + * They are local because they influence the layout of the window or + * depend on the window layout. + * There are two values: w_onebuf_opt is local to the buffer currently in + * this window, w_allbuf_opt is for all buffers in this window. + */ + winopt_T w_onebuf_opt; + winopt_T w_allbuf_opt; + + /* A few options have local flags for P_INSECURE. */ + long_u w_p_stl_flags; /* flags for 'statusline' */ + long_u w_p_fde_flags; /* flags for 'foldexpr' */ + long_u w_p_fdt_flags; /* flags for 'foldtext' */ + int *w_p_cc_cols; /* array of columns to highlight or NULL */ + + /* transform a pointer to a "onebuf" option into a "allbuf" option */ +#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T)) + + long w_scbind_pos; + + dictitem_T w_winvar; /* variable for "w:" Dictionary */ + dict_T *w_vars; /* internal variables, local to window */ + + int w_farsi; /* for the window dependent Farsi functions */ + + /* + * The w_prev_pcmark field is used to check whether we really did jump to + * a new line after setting the w_pcmark. If not, then we revert to + * using the previous w_pcmark. + */ + pos_T w_pcmark; /* previous context mark */ + pos_T w_prev_pcmark; /* previous w_pcmark */ + + /* + * the jumplist contains old cursor positions + */ + xfmark_T w_jumplist[JUMPLISTSIZE]; + int w_jumplistlen; /* number of active entries */ + int w_jumplistidx; /* current position */ + + int w_changelistidx; /* current position in b_changelist */ + + matchitem_T *w_match_head; /* head of match list */ + int w_next_match_id; /* next match ID */ + + /* + * the tagstack grows from 0 upwards: + * entry 0: older + * entry 1: newer + * entry 2: newest + */ + taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */ + int w_tagstackidx; /* idx just below active entry */ + int w_tagstacklen; /* number of tags on stack */ + + /* + * w_fraction is the fractional row of the cursor within the window, from + * 0 at the top row to FRACTION_MULT at the last row. + * w_prev_fraction_row was the actual cursor row when w_fraction was last + * calculated. + */ + int w_fraction; + int w_prev_fraction_row; + + linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width + * was computed. */ + int w_nrwidth_width; /* nr of chars to print line count. */ + + qf_info_T *w_llist; /* Location list for this window */ + /* + * Location list reference used in the location list window. + * In a non-location list window, w_llist_ref is NULL. + */ + qf_info_T *w_llist_ref; +}; + +#endif // NEOVIM_BUFFER_DEFS_H |