blob: 92a8428f10a4866499c097316b062cdc03732876 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 */
8
9/*
10 * This file contains various definitions of structures that are used by Vim
11 */
12
13/*
14 * There is something wrong in the SAS compiler that makes typedefs not
15 * valid in include files. Has been fixed in version 6.58.
16 */
17#if defined(SASC) && SASC < 658
18typedef long linenr_T;
19typedef unsigned colnr_T;
20typedef unsigned short short_u;
21#endif
22
23/*
24 * position in file or buffer
25 */
26typedef struct
27{
28 linenr_T lnum; /* line number */
29 colnr_T col; /* column number */
30#ifdef FEAT_VIRTUALEDIT
31 colnr_T coladd;
32#endif
33} pos_T;
34
35#ifdef FEAT_VIRTUALEDIT
36# define INIT_POS_T {0, 0, 0}
37#else
38# define INIT_POS_T {0, 0}
39#endif
40
41/*
42 * Same, but without coladd.
43 */
44typedef struct
45{
46 linenr_T lnum; /* line number */
47 colnr_T col; /* column number */
48} lpos_T;
49
50/*
51 * Structure used for growing arrays.
52 * This is used to store information that only grows, is deleted all at
53 * once, and needs to be accessed by index. See ga_clear() and ga_grow().
54 */
55typedef struct growarray
56{
57 int ga_len; /* current number of items used */
Bram Moolenaar86b68352004-12-27 21:59:20 +000058 int ga_maxlen; /* maximum number of items possible */
Bram Moolenaared203462004-06-16 11:19:22 +000059 int ga_itemsize; /* sizeof(item) */
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 int ga_growsize; /* number of items to grow each time */
61 void *ga_data; /* pointer to the first item */
62} garray_T;
63
64#define GA_EMPTY {0, 0, 0, 0, NULL}
65
66/*
67 * This is here because regexp.h needs pos_T and below regprog_T is used.
68 */
69#include "regexp.h"
70
71typedef struct window win_T;
72typedef struct wininfo wininfo_T;
73typedef struct frame frame_T;
74typedef int scid_T; /* script ID */
75
76/*
77 * This is here because gui.h needs the pos_T and win_T, and win_T needs gui.h
78 * for scrollbar_T.
79 */
80#ifdef FEAT_GUI
81# include "gui.h"
82#else
83# ifdef FEAT_XCLIPBOARD
84# include <X11/Intrinsic.h>
85# endif
86# define guicolor_T int /* avoid error in prototypes */
87#endif
88
89/*
90 * marks: positions in a file
91 * (a normal mark is a lnum/col pair, the same as a file position)
92 */
93
94/* (Note: for EBCDIC there are more than 26, because there are gaps in the
95 * alphabet coding. To minimize changes to the code, I decided to just
96 * increase the number of possible marks. */
97#define NMARKS ('z' - 'a' + 1) /* max. # of named marks */
98#define JUMPLISTSIZE 100 /* max. # of marks in jump list */
99#define TAGSTACKSIZE 20 /* max. # of tags in tag stack */
100
101typedef struct filemark
102{
103 pos_T mark; /* cursor position */
104 int fnum; /* file number */
105} fmark_T;
106
107/* Xtended file mark: also has a file name */
108typedef struct xfilemark
109{
110 fmark_T fmark;
111 char_u *fname; /* file name, used when fnum == 0 */
112} xfmark_T;
113
114/*
115 * The taggy struct is used to store the information about a :tag command.
116 */
117typedef struct taggy
118{
119 char_u *tagname; /* tag name */
120 fmark_T fmark; /* cursor position BEFORE ":tag" */
121 int cur_match; /* match number */
122 int cur_fnum; /* buffer number used for cur_match */
123} taggy_T;
124
125/*
126 * Structure that contains all options that are local to a window.
127 * Used twice in a window: for the current buffer and for all buffers.
128 * Also used in wininfo_T.
129 */
130typedef struct
131{
132#ifdef FEAT_ARABIC
133 int wo_arab;
134# define w_p_arab w_onebuf_opt.wo_arab /* 'arabic' */
135#endif
136#ifdef FEAT_DIFF
137 int wo_diff;
138# define w_p_diff w_onebuf_opt.wo_diff /* 'diff' */
139#endif
140#ifdef FEAT_FOLDING
141 long wo_fdc;
142# define w_p_fdc w_onebuf_opt.wo_fdc /* 'foldcolumn' */
143 int wo_fen;
144# define w_p_fen w_onebuf_opt.wo_fen /* 'foldenable' */
145 char_u *wo_fdi;
146# define w_p_fdi w_onebuf_opt.wo_fdi /* 'foldignore' */
147 long wo_fdl;
148# define w_p_fdl w_onebuf_opt.wo_fdl /* 'foldlevel' */
149 char_u *wo_fdm;
150# define w_p_fdm w_onebuf_opt.wo_fdm /* 'foldmethod' */
151 long wo_fml;
152# define w_p_fml w_onebuf_opt.wo_fml /* 'foldminlines' */
153 long wo_fdn;
154# define w_p_fdn w_onebuf_opt.wo_fdn /* 'foldnextmax' */
155# ifdef FEAT_EVAL
156 char_u *wo_fde;
157# define w_p_fde w_onebuf_opt.wo_fde /* 'foldexpr' */
158 char_u *wo_fdt;
159# define w_p_fdt w_onebuf_opt.wo_fdt /* 'foldtext' */
160# endif
161 char_u *wo_fmr;
162# define w_p_fmr w_onebuf_opt.wo_fmr /* 'foldmarker' */
163#endif
164#ifdef FEAT_LINEBREAK
165 int wo_lbr;
166# define w_p_lbr w_onebuf_opt.wo_lbr /* 'linebreak' */
167#endif
168 int wo_list;
169#define w_p_list w_onebuf_opt.wo_list /* 'list' */
170 int wo_nu;
171#define w_p_nu w_onebuf_opt.wo_nu /* 'number' */
Bram Moolenaar592e0a22004-07-03 16:05:59 +0000172#ifdef FEAT_LINEBREAK
173 long wo_nuw;
174# define w_p_nuw w_onebuf_opt.wo_nuw /* 'numberwidth' */
175#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176#if defined(FEAT_WINDOWS)
177 int wo_wfh;
178# define w_p_wfh w_onebuf_opt.wo_wfh /* 'winfixheight' */
179#endif
180#if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
181 int wo_pvw;
182# define w_p_pvw w_onebuf_opt.wo_pvw /* 'previewwindow' */
183#endif
184#ifdef FEAT_RIGHTLEFT
185 int wo_rl;
186# define w_p_rl w_onebuf_opt.wo_rl /* 'rightleft' */
187 char_u *wo_rlc;
188# define w_p_rlc w_onebuf_opt.wo_rlc /* 'rightleftcmd' */
189#endif
190 long wo_scr;
191#define w_p_scr w_onebuf_opt.wo_scr /* 'scroll' */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000192#ifdef FEAT_STL_OPT
193 char_u *wo_stl;
194#define w_p_stl w_onebuf_opt.wo_stl /* 'statusline' */
195#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196#ifdef FEAT_SCROLLBIND
197 int wo_scb;
198# define w_p_scb w_onebuf_opt.wo_scb /* 'scrollbind' */
199#endif
200 int wo_wrap;
201#define w_p_wrap w_onebuf_opt.wo_wrap /* 'wrap' */
202} winopt_T;
203
204/*
205 * Window info stored with a buffer.
206 *
207 * Two types of info are kept for a buffer which are associated with a
208 * specific window:
209 * 1. Each window can have a different line number associated with a buffer.
210 * 2. The window-local options for a buffer work in a similar way.
211 * The window-info is kept in a list at b_wininfo. It is kept in
212 * most-recently-used order.
213 */
214struct wininfo
215{
216 wininfo_T *wi_next; /* next entry or NULL for last entry */
217 wininfo_T *wi_prev; /* previous entry or NULL for first entry */
218 win_T *wi_win; /* pointer to window that did set wi_lnum */
219 pos_T wi_fpos; /* last cursor position in the file */
220 int wi_optset; /* TRUE when wi_opt has useful values */
221 winopt_T wi_opt; /* local window options */
222#ifdef FEAT_FOLDING
223 int wi_fold_manual; /* copy of w_fold_manual */
224 garray_T wi_folds; /* clone of w_folds */
225#endif
226};
227
228/*
229 * Info used to pass info about a fold from the fold-detection code to the
230 * code that displays the foldcolumn.
231 */
232typedef struct foldinfo
233{
234 int fi_level; /* level of the fold; when this is zero the
235 other fields are invalid */
236 int fi_lnum; /* line number where fold starts */
237 int fi_low_level; /* lowest fold level that starts in the same
238 line */
239} foldinfo_T;
240
241/*
242 * stuctures used for undo
243 */
244
245typedef struct u_entry u_entry_T;
246typedef struct u_header u_header_T;
247struct u_entry
248{
249 u_entry_T *ue_next; /* pointer to next entry in list */
250 linenr_T ue_top; /* number of line above undo block */
251 linenr_T ue_bot; /* number of line below undo block */
252 linenr_T ue_lcount; /* linecount when u_save called */
253 char_u **ue_array; /* array of lines in undo block */
254 long ue_size; /* number of lines in ue_array */
255};
256
257struct u_header
258{
259 u_header_T *uh_next; /* pointer to next header in list */
260 u_header_T *uh_prev; /* pointer to previous header in list */
261 u_entry_T *uh_entry; /* pointer to first entry */
262 u_entry_T *uh_getbot_entry; /* pointer to where ue_bot must be set */
263 pos_T uh_cursor; /* cursor position before saving */
264#ifdef FEAT_VIRTUALEDIT
265 long uh_cursor_vcol;
266#endif
267 int uh_flags; /* see below */
268 pos_T uh_namedm[NMARKS]; /* marks before undo/after redo */
269};
270
271/* values for uh_flags */
272#define UH_CHANGED 0x01 /* b_changed flag before undo/after redo */
273#define UH_EMPTYBUF 0x02 /* buffer was empty */
274
275/*
276 * stuctures used in undo.c
277 */
278#if SIZEOF_INT > 2
279# define ALIGN_LONG /* longword alignment and use filler byte */
280# define ALIGN_SIZE (sizeof(long))
281#else
282# define ALIGN_SIZE (sizeof(short))
283#endif
284
285#define ALIGN_MASK (ALIGN_SIZE - 1)
286
287typedef struct m_info minfo_T;
288
289/*
290 * stucture used to link chunks in one of the free chunk lists.
291 */
292struct m_info
293{
294#ifdef ALIGN_LONG
295 long_u m_size; /* size of the chunk (including m_info) */
296#else
297 short_u m_size; /* size of the chunk (including m_info) */
298#endif
299 minfo_T *m_next; /* pointer to next free chunk in the list */
300};
301
302/*
303 * structure used to link blocks in the list of allocated blocks.
304 */
305typedef struct m_block mblock_T;
306struct m_block
307{
308 mblock_T *mb_next; /* pointer to next allocated block */
309 size_t mb_size; /* total size of all chunks in this block */
310 minfo_T mb_info; /* head of free chuck list for this block */
311};
312
313/*
314 * things used in memfile.c
315 */
316
317typedef struct block_hdr bhdr_T;
318typedef struct memfile memfile_T;
319typedef long blocknr_T;
320
321/*
322 * for each (previously) used block in the memfile there is one block header.
323 *
324 * The block may be linked in the used list OR in the free list.
325 * The used blocks are also kept in hash lists.
326 *
327 * The used list is a doubly linked list, most recently used block first.
328 * The blocks in the used list have a block of memory allocated.
329 * mf_used_count is the number of pages in the used list.
330 * The hash lists are used to quickly find a block in the used list.
331 * The free list is a single linked list, not sorted.
332 * The blocks in the free list have no block of memory allocated and
333 * the contents of the block in the file (if any) is irrelevant.
334 */
335
336struct block_hdr
337{
338 bhdr_T *bh_next; /* next block_hdr in free or used list */
339 bhdr_T *bh_prev; /* previous block_hdr in used list */
340 bhdr_T *bh_hash_next; /* next block_hdr in hash list */
341 bhdr_T *bh_hash_prev; /* previous block_hdr in hash list */
342 blocknr_T bh_bnum; /* block number */
343 char_u *bh_data; /* pointer to memory (for used block) */
344 int bh_page_count; /* number of pages in this block */
345
346#define BH_DIRTY 1
347#define BH_LOCKED 2
348 char bh_flags; /* BH_DIRTY or BH_LOCKED */
349};
350
351/*
352 * when a block with a negative number is flushed to the file, it gets
353 * a positive number. Because the reference to the block is still the negative
354 * number, we remember the translation to the new positive number in the
355 * double linked trans lists. The structure is the same as the hash lists.
356 */
357typedef struct nr_trans NR_TRANS;
358
359struct nr_trans
360{
361 NR_TRANS *nt_next; /* next nr_trans in hash list */
362 NR_TRANS *nt_prev; /* previous nr_trans in hash list */
363 blocknr_T nt_old_bnum; /* old, negative, number */
364 blocknr_T nt_new_bnum; /* new, positive, number */
365};
366
367/*
368 * structure used to store one block of the stuff/redo/recording buffers
369 */
370struct buffblock
371{
372 struct buffblock *b_next; /* pointer to next buffblock */
373 char_u b_str[1]; /* contents (actually longer) */
374};
375
376/*
377 * header used for the stuff buffer and the redo buffer
378 */
379struct buffheader
380{
381 struct buffblock bh_first; /* first (dummy) block of list */
382 struct buffblock *bh_curr; /* buffblock for appending */
383 int bh_index; /* index for reading */
384 int bh_space; /* space in bh_curr for appending */
385};
386
387/*
388 * used for completion on the command line
389 */
390typedef struct expand
391{
392 int xp_context; /* type of expansion */
393 char_u *xp_pattern; /* start of item to expand */
394#if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
395 char_u *xp_arg; /* completion function */
396 int xp_scriptID; /* SID for completion function */
397#endif
398 int xp_backslash; /* one of the XP_BS_ values */
399 int xp_numfiles; /* number of files found by
400 file name completion */
401 char_u **xp_files; /* list of files */
402} expand_T;
403
404/* values for xp_backslash */
405#define XP_BS_NONE 0 /* nothing special for backslashes */
406#define XP_BS_ONE 1 /* uses one backslash before a space */
407#define XP_BS_THREE 2 /* uses three backslashes before a space */
408
409/*
410 * Command modifiers ":vertical", ":browse", ":confirm" and ":hide" set a flag.
411 * This needs to be saved for recursive commands, put them in a structure for
412 * easy manipulation.
413 */
414typedef struct
415{
416 int hide; /* TRUE when ":hide" was used */
417# ifdef FEAT_BROWSE
418 int browse; /* TRUE to invoke file dialog */
419# endif
420# ifdef FEAT_WINDOWS
421 int split; /* flags for win_split() */
422# endif
423# if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
424 int confirm; /* TRUE to invoke yes/no dialog */
425# endif
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000426 int keepalt; /* TRUE when ":keepalt" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427 int keepmarks; /* TRUE when ":keepmarks" was used */
428 int keepjumps; /* TRUE when ":keepjumps" was used */
429 int lockmarks; /* TRUE when ":lockmarks" was used */
430} cmdmod_T;
431
432/*
433 * Simplistic hashing scheme to quickly locate the blocks in the used list.
434 * 64 blocks are found directly (64 * 4K = 256K, most files are smaller).
435 */
436#define MEMHASHSIZE 64
437#define MEMHASH(nr) ((nr) & (MEMHASHSIZE - 1))
438
439struct memfile
440{
441 char_u *mf_fname; /* name of the file */
442 char_u *mf_ffname; /* idem, full path */
443 int mf_fd; /* file descriptor */
444 bhdr_T *mf_free_first; /* first block_hdr in free list */
445 bhdr_T *mf_used_first; /* mru block_hdr in used list */
446 bhdr_T *mf_used_last; /* lru block_hdr in used list */
447 unsigned mf_used_count; /* number of pages in used list */
448 unsigned mf_used_count_max; /* maximum number of pages in memory */
449 bhdr_T *mf_hash[MEMHASHSIZE]; /* array of hash lists */
450 NR_TRANS *mf_trans[MEMHASHSIZE]; /* array of trans lists */
451 blocknr_T mf_blocknr_max; /* highest positive block number + 1*/
452 blocknr_T mf_blocknr_min; /* lowest negative block number - 1 */
453 blocknr_T mf_neg_count; /* number of negative blocks numbers */
454 blocknr_T mf_infile_count; /* number of pages in the file */
455 unsigned mf_page_size; /* number of bytes in a page */
456 int mf_dirty; /* TRUE if there are dirty blocks */
457};
458
459/*
460 * things used in memline.c
461 */
462/*
463 * When searching for a specific line, we remember what blocks in the tree
464 * are the branches leading to that block. This is stored in ml_stack. Each
465 * entry is a pointer to info in a block (may be data block or pointer block)
466 */
467typedef struct info_pointer
468{
469 blocknr_T ip_bnum; /* block number */
470 linenr_T ip_low; /* lowest lnum in this block */
471 linenr_T ip_high; /* highest lnum in this block */
472 int ip_index; /* index for block with current lnum */
473} infoptr_T; /* block/index pair */
474
475#ifdef FEAT_BYTEOFF
476typedef struct ml_chunksize
477{
478 int mlcs_numlines;
479 long mlcs_totalsize;
480} chunksize_T;
481
482 /* Flags when calling ml_updatechunk() */
483
484#define ML_CHNK_ADDLINE 1
485#define ML_CHNK_DELLINE 2
486#define ML_CHNK_UPDLINE 3
487#endif
488
489/*
490 * the memline structure holds all the information about a memline
491 */
492typedef struct memline
493{
494 linenr_T ml_line_count; /* number of lines in the buffer */
495
496 memfile_T *ml_mfp; /* pointer to associated memfile */
497
498#define ML_EMPTY 1 /* empty buffer */
499#define ML_LINE_DIRTY 2 /* cached line was changed and allocated */
500#define ML_LOCKED_DIRTY 4 /* ml_locked was changed */
501#define ML_LOCKED_POS 8 /* ml_locked needs positive block number */
502 int ml_flags;
503
504 infoptr_T *ml_stack; /* stack of pointer blocks (array of IPTRs) */
505 int ml_stack_top; /* current top if ml_stack */
506 int ml_stack_size; /* total number of entries in ml_stack */
507
508 linenr_T ml_line_lnum; /* line number of cached line, 0 if not valid */
509 char_u *ml_line_ptr; /* pointer to cached line */
510
511 bhdr_T *ml_locked; /* block used by last ml_get */
512 linenr_T ml_locked_low; /* first line in ml_locked */
513 linenr_T ml_locked_high; /* last line in ml_locked */
514 int ml_locked_lineadd; /* number of lines inserted in ml_locked */
515#ifdef FEAT_BYTEOFF
516 chunksize_T *ml_chunksize;
517 int ml_numchunks;
518 int ml_usedchunks;
519#endif
520} memline_T;
521
522#if defined(FEAT_SIGNS) || defined(PROTO)
523typedef struct signlist signlist_T;
524
525struct signlist
526{
527 int id; /* unique identifier for each placed sign */
528 linenr_T lnum; /* line number which has this sign */
529 int typenr; /* typenr of sign */
530 signlist_T *next; /* next signlist entry */
531# ifdef FEAT_NETBEANS_INTG
532 signlist_T *prev; /* previous entry -- for easy reordering */
533# endif
534};
535
536/* type argument for buf_getsigntype() */
537#define SIGN_ANY 0
538#define SIGN_LINEHL 1
539#define SIGN_ICON 2
540#define SIGN_TEXT 3
541#endif
542
543/*
544 * Argument list: Array of file names.
545 * Used for the global argument list and the argument lists local to a window.
546 */
547typedef struct arglist
548{
549 garray_T al_ga; /* growarray with the array of file names */
550 int al_refcount; /* number of windows using this arglist */
551} alist_T;
552
553/*
554 * For each argument remember the file name as it was given, and the buffer
555 * number that contains the expanded file name (required for when ":cd" is
556 * used.
557 */
558typedef struct argentry
559{
560 char_u *ae_fname; /* file name as specified */
561 int ae_fnum; /* buffer number with expanded file name */
562} aentry_T;
563
564#ifdef FEAT_WINDOWS
565# define ALIST(win) (win)->w_alist
566#else
567# define ALIST(win) (&global_alist)
568#endif
569#define GARGLIST ((aentry_T *)global_alist.al_ga.ga_data)
570#define ARGLIST ((aentry_T *)ALIST(curwin)->al_ga.ga_data)
571#define WARGLIST(wp) ((aentry_T *)ALIST(wp)->al_ga.ga_data)
572#define AARGLIST(al) ((aentry_T *)((al)->al_ga.ga_data))
573#define GARGCOUNT (global_alist.al_ga.ga_len)
574#define ARGCOUNT (ALIST(curwin)->al_ga.ga_len)
575#define WARGCOUNT(wp) (ALIST(wp)->al_ga.ga_len)
576
577/*
578 * A list used for saving values of "emsg_silent". Used by ex_try() to save the
579 * value of "emsg_silent" if it was non-zero. When this is done, the CSF_SILENT
580 * flag below is set.
581 */
582
583typedef struct eslist_elem eslist_T;
584struct eslist_elem
585{
586 int saved_emsg_silent; /* saved value of "emsg_silent" */
587 eslist_T *next; /* next element on the list */
588};
589
590/*
591 * For conditional commands a stack is kept of nested conditionals.
592 * When cs_idx < 0, there is no conditional command.
593 */
594#define CSTACK_LEN 50
595
596struct condstack
597{
Bram Moolenaar12805862005-01-05 22:16:17 +0000598 short cs_flags[CSTACK_LEN]; /* CSF_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599 char cs_pending[CSTACK_LEN]; /* CSTP_: what's pending in ":finally"*/
600 union {
Bram Moolenaar12805862005-01-05 22:16:17 +0000601 void *csp_rv[CSTACK_LEN]; /* return typeval for pending return */
602 void *csp_ex[CSTACK_LEN]; /* exception for pending throw */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603 } cs_pend;
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000604 void *cs_forinfo[CSTACK_LEN]; /* info used by ":for" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000605 int cs_line[CSTACK_LEN]; /* line nr of ":while"/":for" line */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606 int cs_idx; /* current entry, or -1 if none */
Bram Moolenaar12805862005-01-05 22:16:17 +0000607 int cs_looplevel; /* nr of nested ":while"s and ":for"s */
608 int cs_trylevel; /* nr of nested ":try"s */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 eslist_T *cs_emsg_silent_list; /* saved values of "emsg_silent" */
Bram Moolenaar12805862005-01-05 22:16:17 +0000610 char cs_lflags; /* loop flags: CSL_ flags */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611};
Bram Moolenaar12805862005-01-05 22:16:17 +0000612# define cs_rettv cs_pend.csp_rv
613# define cs_exception cs_pend.csp_ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000615/* There is no CSF_IF, the lack of CSF_WHILE, CSF_FOR and CSF_TRY means ":if"
616 * was used. */
Bram Moolenaar12805862005-01-05 22:16:17 +0000617# define CSF_TRUE 0x0001 /* condition was TRUE */
618# define CSF_ACTIVE 0x0002 /* current state is active */
619# define CSF_ELSE 0x0004 /* ":else" has been passed */
620# define CSF_WHILE 0x0008 /* is a ":while" */
621# define CSF_FOR 0x0010 /* is a ":for" */
622
623# define CSF_TRY 0x0100 /* is a ":try" */
624# define CSF_FINALLY 0x0200 /* ":finally" has been passed */
625# define CSF_THROWN 0x0400 /* exception thrown to this try conditional */
626# define CSF_CAUGHT 0x0800 /* exception caught by this try conditional */
627# define CSF_SILENT 0x1000 /* "emsg_silent" reset by ":try" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628/* Note that CSF_ELSE is only used when CSF_TRY and CSF_WHILE are unset
629 * (an ":if"), and CSF_SILENT is only used when CSF_TRY is set. */
630
631/*
632 * What's pending for being reactivated at the ":endtry" of this try
633 * conditional:
634 */
635# define CSTP_NONE 0 /* nothing pending in ":finally" clause */
636# define CSTP_ERROR 1 /* an error is pending */
637# define CSTP_INTERRUPT 2 /* an interrupt is pending */
638# define CSTP_THROW 4 /* a throw is pending */
639# define CSTP_BREAK 8 /* ":break" is pending */
640# define CSTP_CONTINUE 16 /* ":continue" is pending */
641# define CSTP_RETURN 24 /* ":return" is pending */
642# define CSTP_FINISH 32 /* ":finish" is pending */
643
644/*
Bram Moolenaar12805862005-01-05 22:16:17 +0000645 * Flags for the cs_lflags item in struct condstack.
646 */
647# define CSL_HAD_LOOP 1 /* just found ":while" or ":for" */
648# define CSL_HAD_ENDLOOP 2 /* just found ":endwhile" or ":endfor" */
649# define CSL_HAD_CONT 4 /* just found ":continue" */
650# define CSL_HAD_FINA 8 /* just found ":finally" */
651
652/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 * A list of error messages that can be converted to an exception. "throw_msg"
654 * is only set in the first element of the list. Usually, it points to the
655 * original message stored in that element, but sometimes it points to a later
656 * message in the list. See cause_errthrow() below.
657 */
658struct msglist
659{
660 char_u *msg; /* original message */
661 char_u *throw_msg; /* msg to throw: usually original one */
662 struct msglist *next; /* next of several messages in a row */
663};
664
665/*
666 * Structure describing an exception.
667 * (don't use "struct exception", it's used by the math library).
668 */
669typedef struct vim_exception except_T;
670struct vim_exception
671{
672 int type; /* exception type */
673 char_u *value; /* exception value */
674 struct msglist *messages; /* message(s) causing error exception */
675 char_u *throw_name; /* name of the throw point */
676 linenr_T throw_lnum; /* line number of the throw point */
677 except_T *caught; /* next exception on the caught stack */
678};
679
680/*
681 * The exception types.
682 */
683#define ET_USER 0 /* exception caused by ":throw" command */
684#define ET_ERROR 1 /* error exception */
685#define ET_INTERRUPT 2 /* interrupt exception triggered by Ctrl-C */
686
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000687/*
688 * Structure to save the error/interrupt/exception state between calls to
689 * enter_cleanup() and leave_cleanup(). Must be allocated as an automatic
690 * variable by the (common) caller of these functions.
691 */
692typedef struct cleanup_stuff cleanup_T;
693struct cleanup_stuff
694{
695 int pending; /* error/interrupt/exception state */
696 except_T *exception; /* exception value */
697};
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699#ifdef FEAT_SYN_HL
700/* struct passed to in_id_list() */
701struct sp_syn
702{
703 int inc_tag; /* ":syn include" unique tag */
704 short id; /* highlight group ID of item */
705 short *cont_in_list; /* cont.in group IDs, if non-zero */
706};
707
708/*
709 * Each keyword has one keyentry, which is linked in a hash list.
710 */
711typedef struct keyentry keyentry_T;
712
713struct keyentry
714{
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000715 keyentry_T *ke_next; /* next entry with identical "keyword[]" */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 struct sp_syn k_syn; /* struct passed to in_id_list() */
717 short *next_list; /* ID list for next match (if non-zero) */
718 short flags; /* see syntax.c */
719 char_u keyword[1]; /* actually longer */
720};
721
722/*
723 * Struct used to store one state of the state stack.
724 */
725typedef struct buf_state
726{
727 int bs_idx; /* index of pattern */
728 long bs_flags; /* flags for pattern */
729 reg_extmatch_T *bs_extmatch; /* external matches from start pattern */
730} bufstate_T;
731
732/*
733 * syn_state contains the syntax state stack for the start of one line.
734 * Used by b_sst_array[].
735 */
736typedef struct syn_state synstate_T;
737
738struct syn_state
739{
740 synstate_T *sst_next; /* next entry in used or free list */
741 linenr_T sst_lnum; /* line number for this state */
742 union
743 {
744 bufstate_T sst_stack[SST_FIX_STATES]; /* short state stack */
745 garray_T sst_ga; /* growarray for long state stack */
746 } sst_union;
747 int sst_next_flags; /* flags for sst_next_list */
748 short *sst_next_list; /* "nextgroup" list in this state
749 * (this is a copy, don't free it! */
750 short sst_stacksize; /* number of states on the stack */
751 disptick_T sst_tick; /* tick when last displayed */
752 linenr_T sst_change_lnum;/* when non-zero, change in this line
753 * may have made the state invalid */
754};
755#endif /* FEAT_SYN_HL */
756
757/*
758 * Structure shared between syntax.c, screen.c and gui_x11.c.
759 */
760typedef struct attr_entry
761{
762 short ae_attr; /* HL_BOLD, etc. */
763 union
764 {
765 struct
766 {
767 char_u *start; /* start escape sequence */
768 char_u *stop; /* stop escape sequence */
769 } term;
770 struct
771 {
772 char_u fg_color; /* foreground color number */
773 char_u bg_color; /* background color number */
774 } cterm;
775# ifdef FEAT_GUI
776 struct
777 {
778 guicolor_T fg_color; /* foreground color handle */
779 guicolor_T bg_color; /* background color handle */
780 GuiFont font; /* font handle */
781# ifdef FEAT_XFONTSET
782 GuiFontset fontset; /* fontset handle */
783# endif
784 } gui;
785# endif
786 } ae_u;
787} attrentry_T;
788
789#ifdef USE_ICONV
790# ifdef HAVE_ICONV_H
791# include <iconv.h>
792# else
793# if defined(MACOS_X)
794# include <sys/errno.h>
795# define EILSEQ ENOENT /* MacOS X does not have EILSEQ */
796typedef struct _iconv_t *iconv_t;
797# else
798# if defined(MACOS_CLASSIC)
799typedef struct _iconv_t *iconv_t;
800# define EINVAL 22
801# define E2BIG 7
802# define ENOENT 2
803# define EFAULT 14
804# define EILSEQ 123
805# else
806# include <errno.h>
807# endif
808# endif
809typedef void *iconv_t;
810# endif
811#endif
812
813/*
814 * Used for the typeahead buffer: typebuf.
815 */
816typedef struct
817{
818 char_u *tb_buf; /* buffer for typed characters */
819 char_u *tb_noremap; /* mapping flags for characters in tb_buf[] */
820 int tb_buflen; /* size of tb_buf[] */
821 int tb_off; /* current position in tb_buf[] */
822 int tb_len; /* number of valid bytes in tb_buf[] */
823 int tb_maplen; /* nr of mapped bytes in tb_buf[] */
824 int tb_silent; /* nr of silently mapped bytes in tb_buf[] */
825 int tb_no_abbr_cnt; /* nr of bytes without abbrev. in tb_buf[] */
826 int tb_change_cnt; /* nr of time tb_buf was changed; never zero */
827} typebuf_T;
828
829/* Struct to hold the saved typeahead for save_typeahead(). */
830typedef struct
831{
832 typebuf_T save_typebuf;
833 int typebuf_valid; /* TRUE when save_typebuf valid */
834 struct buffheader save_stuffbuff;
835#ifdef USE_INPUT_BUF
836 char_u *save_inputbuf;
837#endif
838} tasave_T;
839
840/*
841 * Used for conversion of terminal I/O and script files.
842 */
843typedef struct
844{
845 int vc_type; /* zero or one of the CONV_ values */
846 int vc_factor; /* max. expansion factor */
847# ifdef WIN3264
848 int vc_cpfrom; /* codepage to convert from (CONV_CODEPAGE) */
849 int vc_cpto; /* codepage to convert to (CONV_CODEPAGE) */
850# endif
851# ifdef USE_ICONV
852 iconv_t vc_fd; /* for CONV_ICONV */
853# endif
854 int vc_fail; /* fail for invalid char, don't use '?' */
855} vimconv_T;
856
857/*
858 * Structure used for reading from the viminfo file.
859 */
860typedef struct
861{
862 char_u *vir_line; /* text of the current line */
863 FILE *vir_fd; /* file descriptor */
864#ifdef FEAT_MBYTE
865 vimconv_T vir_conv; /* encoding conversion */
866#endif
867} vir_T;
868
869#define CONV_NONE 0
870#define CONV_TO_UTF8 1
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000871#define CONV_9_TO_UTF8 2
872#define CONV_TO_LATIN1 3
873#define CONV_TO_LATIN9 4
874#define CONV_ICONV 5
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875#ifdef WIN3264
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000876# define CONV_CODEPAGE 10 /* codepage -> codepage */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877#endif
878#ifdef MACOS_X
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000879# define CONV_MAC_LATIN1 20
880# define CONV_LATIN1_MAC 21
881# define CONV_MAC_UTF8 22
882# define CONV_UTF8_MAC 23
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883#endif
884
885/*
886 * Structure used for mappings and abbreviations.
887 */
888typedef struct mapblock mapblock_T;
889struct mapblock
890{
891 mapblock_T *m_next; /* next mapblock in list */
892 char_u *m_keys; /* mapped from */
893 int m_keylen; /* strlen(m_keys) */
894 char_u *m_str; /* mapped to */
895 int m_mode; /* valid mode */
896 int m_noremap; /* if non-zero no re-mapping for m_str */
897 char m_silent; /* <silent> used, don't echo commands */
898#if 0 /* Not used yet */
899 scid_T m_script_ID; /* ID of script where map was defined,
900 used for s: variables and functions */
901#endif
902};
903
904/*
905 * Used for highlighting in the status line.
906 */
907struct stl_hlrec
908{
909 char_u *start;
910 int userhl;
911};
912
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000913/* Item for a hashtable. "hi_key" can be one of three values:
914 * NULL: Never been used
915 * HI_KEY_REMOVED: Entry was removed
916 * Otherwise: Used item, pointer to the actual key; this usually is
917 * inside the item, subtract an offset to locate the item.
918 * This reduces the size of hashitem by 1/3.
919 */
920typedef struct hashitem_S
921{
922 long_u hi_hash; /* cached hash number of hi_key */
923 char_u *hi_key;
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000924} hashitem_T;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000925
926/* The address of "hash_removed" is used as a magic number for hi_key to
927 * indicate a removed item. */
928#define HI_KEY_REMOVED &hash_removed
929#define HASHITEM_EMPTY(hi) ((hi)->hi_key == NULL || (hi)->hi_key == &hash_removed)
930
931/* Initial size for a hashtable. Our items are relatively small and growing
932 * is expensive, thus use 16 as a start. Must be a power of 2. */
933#define HT_INIT_SIZE 16
934
935typedef struct hashtable_S
936{
937 long_u ht_mask; /* mask used for hash value (nr of items in
938 * array is "ht_mask" + 1) */
Bram Moolenaar677ee682005-01-27 14:41:15 +0000939 long_u ht_used; /* number of items used */
940 long_u ht_filled; /* number of items used + removed */
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000941 int ht_locked; /* counter for hash_lock() */
942 int ht_error; /* when set growing failed, can't add more
943 items before growing works */
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000944 hashitem_T *ht_array; /* points to the array, allocated when it's
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000945 not "ht_smallarray" */
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000946 hashitem_T ht_smallarray[HT_INIT_SIZE]; /* initial array */
947} hashtab_T;
948
949typedef long_u hash_T; /* Type for hi_hash */
950
951
952#if SIZEOF_INT <= 3 /* use long if int is smaller than 32 bits */
953typedef long varnumber_T;
954#else
955typedef int varnumber_T;
956#endif
957
958typedef struct listvar_S list_T;
959typedef struct dictvar_S dict_T;
960
961/*
962 * Structure to hold an internal variable without a name.
963 */
964typedef struct
965{
Bram Moolenaar2ce06f62005-01-31 19:19:04 +0000966 char v_type; /* see below: VAR_NUMBER, VAR_STRING, etc. */
967 char v_lock; /* see below: VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000968 union
969 {
970 varnumber_T v_number; /* number value */
971 char_u *v_string; /* string value (can be NULL!) */
972 list_T *v_list; /* list value (can be NULL!) */
973 dict_T *v_dict; /* dict value (can be NULL!) */
974 } vval;
975} typval_T;
976
977/* Values for "v_type". */
978#define VAR_UNKNOWN 0
979#define VAR_NUMBER 1 /* "v_number" is used */
980#define VAR_STRING 2 /* "v_string" is used */
981#define VAR_FUNC 3 /* "v_string" is function name */
982#define VAR_LIST 4 /* "v_list" is used */
983#define VAR_DICT 5 /* "v_dict" is used */
984
Bram Moolenaar2ce06f62005-01-31 19:19:04 +0000985/* Values for "v_lock". */
986#define VAR_LOCKED 1 /* locked with lock(), can use unlock() */
987#define VAR_FIXED 2 /* locked forever */
988
Bram Moolenaar8f999f12005-01-25 22:12:55 +0000989/*
990 * Structure to hold an item of a list: an internal variable without a name.
991 */
992typedef struct listitem_S listitem_T;
993
994struct listitem_S
995{
996 listitem_T *li_next; /* next item in list */
997 listitem_T *li_prev; /* previous item in list */
998 typval_T li_tv; /* type and value of the variable */
999};
1000
1001/*
1002 * Struct used by those that are using an item in a list.
1003 */
1004typedef struct listwatch_S listwatch_T;
1005
1006struct listwatch_S
1007{
1008 listitem_T *lw_item; /* item being watched */
1009 listwatch_T *lw_next; /* next watcher */
1010};
1011
1012/*
1013 * Structure to hold info about a list.
1014 */
1015struct listvar_S
1016{
1017 int lv_refcount; /* reference count */
Bram Moolenaar748bf032005-02-02 23:04:36 +00001018 int lv_len; /* number of items */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001019 listitem_T *lv_first; /* first item, NULL if none */
1020 listitem_T *lv_last; /* last item, NULL if none */
1021 listwatch_T *lv_watch; /* first watcher, NULL if none */
Bram Moolenaar748bf032005-02-02 23:04:36 +00001022 int lv_idx; /* cached index of an item */
1023 listitem_T *lv_idx_item; /* when not NULL item at index "lv_idx" */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001024 int lv_copyID; /* ID used by deepcopy() */
1025 list_T *lv_copylist; /* copied list used by deepcopy() */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001026 char lv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001027};
1028
1029/*
1030 * Structure to hold an item of a Dictionary.
1031 * Also used for a variable.
1032 * The key is copied into "di_key" to avoid an extra alloc/free for it.
1033 */
1034struct dictitem_S
1035{
1036 typval_T di_tv; /* type and value of the variable */
1037 char_u di_flags; /* flags (only used for variable) */
1038 char_u di_key[1]; /* key (actually longer!) */
1039};
1040
1041typedef struct dictitem_S dictitem_T;
1042
1043#define DI_FLAGS_RO 1 /* "di_flags" value: read-only variable */
1044#define DI_FLAGS_RO_SBX 2 /* "di_flags" value: read-only in the sandbox */
1045#define DI_FLAGS_FIX 4 /* "di_flags" value: fixed variable, not allocated */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001046#define DI_FLAGS_LOCK 8 /* "di_flags" value: locked variable */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001047
1048/*
1049 * Structure to hold info about a Dictionary.
1050 */
1051struct dictvar_S
1052{
1053 int dv_refcount; /* reference count */
1054 hashtab_T dv_hashtab; /* hashtab that refers to the items */
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001055 int dv_copyID; /* ID used by deepcopy() */
1056 dict_T *dv_copydict; /* copied dict used by deepcopy() */
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001057 char dv_lock; /* zero, VAR_LOCKED, VAR_FIXED */
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001058};
1059
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00001060
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061/*
1062 * buffer: structure that holds information about one file
1063 *
1064 * Several windows can share a single Buffer
1065 * A buffer is unallocated if there is no memfile for it.
1066 * A buffer is new if the associated file has never been loaded yet.
1067 */
1068
1069typedef struct file_buffer buf_T;
1070
1071struct file_buffer
1072{
1073 memline_T b_ml; /* associated memline (also contains line
1074 count) */
1075
1076 buf_T *b_next; /* links in list of buffers */
1077 buf_T *b_prev;
1078
1079 int b_nwindows; /* nr of windows open on this buffer */
1080
1081 int b_flags; /* various BF_ flags */
1082
1083 /*
1084 * b_ffname has the full path of the file (NULL for no name).
1085 * b_sfname is the name as the user typed it (or NULL).
1086 * b_fname is the same as b_sfname, unless ":cd" has been done,
1087 * then it is the same as b_ffname (NULL for no name).
1088 */
1089 char_u *b_ffname; /* full path file name */
1090 char_u *b_sfname; /* short file name */
1091 char_u *b_fname; /* current file name */
1092
1093#ifdef UNIX
1094 int b_dev; /* device number (-1 if not set) */
1095 ino_t b_ino; /* inode number */
1096#endif
1097#ifdef FEAT_CW_EDITOR
1098 FSSpec b_FSSpec; /* MacOS File Identification */
1099#endif
1100#ifdef VMS
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001101 char b_fab_rfm; /* Record format */
1102 char b_fab_rat; /* Record attribute */
1103 unsigned int b_fab_mrs; /* Max record size */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001104#endif
1105#ifdef FEAT_SNIFF
1106 int b_sniff; /* file was loaded through Sniff */
1107#endif
1108
1109 int b_fnum; /* buffer number for this file. */
1110
1111 int b_changed; /* 'modified': Set to TRUE if something in the
1112 file has been changed and not written out. */
1113 int b_changedtick; /* incremented for each change, also for undo */
1114
1115 int b_saving; /* Set to TRUE if we are in the middle of
1116 saving the buffer. */
1117
1118 /*
1119 * Changes to a buffer require updating of the display. To minimize the
1120 * work, remember changes made and update everything at once.
1121 */
1122 int b_mod_set; /* TRUE when there are changes since the last
1123 time the display was updated */
1124 linenr_T b_mod_top; /* topmost lnum that was changed */
1125 linenr_T b_mod_bot; /* lnum below last changed line, AFTER the
1126 change */
1127 long b_mod_xlines; /* number of extra buffer lines inserted;
1128 negative when lines were deleted */
1129
1130 wininfo_T *b_wininfo; /* list of last used info for each window */
1131
1132 long b_mtime; /* last change time of original file */
1133 long b_mtime_read; /* last change time when reading */
1134 size_t b_orig_size; /* size of original file in bytes */
1135 int b_orig_mode; /* mode of original file */
1136
1137 pos_T b_namedm[NMARKS]; /* current named marks (mark.c) */
1138
1139#ifdef FEAT_VISUAL
1140 /* These variables are set when VIsual_active becomes FALSE */
1141 pos_T b_visual_start; /* start pos of last VIsual */
1142 pos_T b_visual_end; /* end position of last VIsual */
1143 int b_visual_mode; /* VIsual_mode of last VIsual */
1144# ifdef FEAT_EVAL
1145 int b_visual_mode_eval; /* b_visual_mode for visualmode() */
1146# endif
1147 colnr_T b_visual_curswant; /* MAXCOL from w_curswant */
1148#endif
1149
1150 pos_T b_last_cursor; /* cursor position when last unloading this
1151 buffer */
1152 pos_T b_last_insert; /* where Insert mode was left */
1153 pos_T b_last_change; /* position of last change: '. mark */
1154
1155#ifdef FEAT_JUMPLIST
1156 /*
1157 * the changelist contains old change positions
1158 */
1159 pos_T b_changelist[JUMPLISTSIZE];
1160 int b_changelistlen; /* number of active entries */
1161 int b_new_change; /* set by u_savecommon() */
1162#endif
1163
1164 /*
1165 * Character table, only used in charset.c for 'iskeyword'
1166 * 32 bytes of 8 bits: 1 bit per character 0-255.
1167 */
1168 char_u b_chartab[32];
1169
1170#ifdef FEAT_LOCALMAP
1171 /* Table used for mappings local to a buffer. */
1172 mapblock_T *(b_maphash[256]);
1173
1174 /* First abbreviation local to a buffer. */
1175 mapblock_T *b_first_abbr;
1176#endif
1177#ifdef FEAT_USR_CMDS
1178 /* User commands local to the buffer. */
1179 garray_T b_ucmds;
1180#endif
1181 /*
1182 * start and end of an operator, also used for '[ and ']
1183 */
1184 pos_T b_op_start;
1185 pos_T b_op_end;
1186
1187#ifdef FEAT_VIMINFO
1188 int b_marks_read; /* Have we read viminfo marks yet? */
1189#endif
1190
1191 /*
1192 * The following only used in undo.c.
1193 */
1194 u_header_T *b_u_oldhead; /* pointer to oldest header */
1195 u_header_T *b_u_newhead; /* pointer to newest header */
1196 u_header_T *b_u_curhead; /* pointer to current header */
1197 int b_u_numhead; /* current number of headers */
1198 int b_u_synced; /* entry lists are synced */
1199
1200 /*
1201 * variables for "U" command in undo.c
1202 */
1203 char_u *b_u_line_ptr; /* saved line for "U" command */
1204 linenr_T b_u_line_lnum; /* line number of line in u_line */
1205 colnr_T b_u_line_colnr; /* optional column number */
1206
1207 /*
1208 * The following only used in undo.c
1209 */
1210 mblock_T b_block_head; /* head of allocated memory block list */
1211 minfo_T *b_m_search; /* pointer to chunk before previously
1212 allocated/freed chunk */
1213 mblock_T *b_mb_current; /* block where m_search points in */
1214#ifdef FEAT_INS_EXPAND
1215 int b_scanned; /* ^N/^P have scanned this buffer */
1216#endif
1217
1218 /* flags for use of ":lmap" and IM control */
1219 long b_p_iminsert; /* input mode for insert */
1220 long b_p_imsearch; /* input mode for search */
1221#define B_IMODE_USE_INSERT -1 /* Use b_p_iminsert value for search */
1222#define B_IMODE_NONE 0 /* Input via none */
1223#define B_IMODE_LMAP 1 /* Input via langmap */
1224#ifndef USE_IM_CONTROL
1225# define B_IMODE_LAST 1
1226#else
1227# define B_IMODE_IM 2 /* Input via input method */
1228# define B_IMODE_LAST 2
1229#endif
1230
1231#ifdef FEAT_KEYMAP
1232 short b_kmap_state; /* using "lmap" mappings */
1233# define KEYMAP_INIT 1 /* 'keymap' was set, call keymap_init() */
1234# define KEYMAP_LOADED 2 /* 'keymap' mappings have been loaded */
1235 garray_T b_kmap_ga; /* the keymap table */
1236#endif
1237
1238 /*
1239 * Options local to a buffer.
1240 * They are here because their value depends on the type of file
1241 * or contents of the file being edited.
1242 */
1243 int b_p_initialized; /* set when options initialized */
1244
1245 int b_p_ai; /* 'autoindent' */
1246 int b_p_ai_nopaste; /* b_p_ai saved for paste mode */
1247 int b_p_ci; /* 'copyindent' */
1248 int b_p_bin; /* 'binary' */
1249#ifdef FEAT_MBYTE
1250 int b_p_bomb; /* 'bomb' */
1251#endif
1252#if defined(FEAT_QUICKFIX)
1253 char_u *b_p_bh; /* 'bufhidden' */
1254 char_u *b_p_bt; /* 'buftype' */
1255#endif
1256 int b_p_bl; /* 'buflisted' */
1257#ifdef FEAT_CINDENT
1258 int b_p_cin; /* 'cindent' */
1259 char_u *b_p_cino; /* 'cinoptions' */
1260 char_u *b_p_cink; /* 'cinkeys' */
1261#endif
1262#if defined(FEAT_CINDENT) || defined(FEAT_SMARTINDENT)
1263 char_u *b_p_cinw; /* 'cinwords' */
1264#endif
1265#ifdef FEAT_COMMENTS
1266 char_u *b_p_com; /* 'comments' */
1267#endif
1268#ifdef FEAT_FOLDING
1269 char_u *b_p_cms; /* 'commentstring' */
1270#endif
1271#ifdef FEAT_INS_EXPAND
1272 char_u *b_p_cpt; /* 'complete' */
1273#endif
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001274#ifdef FEAT_COMPL_FUNC
1275 char_u *b_p_cfu; /* 'completefunc' */
1276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 int b_p_eol; /* 'endofline' */
1278 int b_p_et; /* 'expandtab' */
1279 int b_p_et_nobin; /* b_p_et saved for binary mode */
1280#ifdef FEAT_MBYTE
1281 char_u *b_p_fenc; /* 'fileencoding' */
1282#endif
1283 char_u *b_p_ff; /* 'fileformat' */
1284#ifdef FEAT_AUTOCMD
1285 char_u *b_p_ft; /* 'filetype' */
1286#endif
1287 char_u *b_p_fo; /* 'formatoptions' */
Bram Moolenaar86b68352004-12-27 21:59:20 +00001288 char_u *b_p_flp; /* 'formatlistpat' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 int b_p_inf; /* 'infercase' */
1290 char_u *b_p_isk; /* 'iskeyword' */
1291#ifdef FEAT_FIND_ID
1292 char_u *b_p_def; /* 'define' local value */
1293 char_u *b_p_inc; /* 'include' */
1294# ifdef FEAT_EVAL
1295 char_u *b_p_inex; /* 'includeexpr' */
1296# endif
1297#endif
1298#if defined(FEAT_CINDENT) && defined(FEAT_EVAL)
1299 char_u *b_p_inde; /* 'indentexpr' */
1300 char_u *b_p_indk; /* 'indentkeys' */
1301#endif
1302#ifdef FEAT_CRYPT
1303 char_u *b_p_key; /* 'key' */
1304#endif
1305 char_u *b_p_kp; /* 'keywordprg' */
1306#ifdef FEAT_LISP
1307 int b_p_lisp; /* 'lisp' */
1308#endif
1309 char_u *b_p_mps; /* 'matchpairs' */
1310 int b_p_ml; /* 'modeline' */
1311 int b_p_ml_nobin; /* b_p_ml saved for binary mode */
1312 int b_p_ma; /* 'modifiable' */
1313 char_u *b_p_nf; /* 'nrformats' */
1314#ifdef FEAT_OSFILETYPE
1315 char_u *b_p_oft; /* 'osfiletype' */
1316#endif
1317 int b_p_pi; /* 'preserveindent' */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001318#ifdef FEAT_TEXTOBJ
1319 char_u *b_p_qe; /* 'quoteescape' */
1320#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 int b_p_ro; /* 'readonly' */
1322 long b_p_sw; /* 'shiftwidth' */
1323#ifndef SHORT_FNAME
1324 int b_p_sn; /* 'shortname' */
1325#endif
1326#ifdef FEAT_SMARTINDENT
1327 int b_p_si; /* 'smartindent' */
1328#endif
1329 long b_p_sts; /* 'softtabstop' */
1330 long b_p_sts_nopaste; /* b_p_sts saved for paste mode */
1331#ifdef FEAT_SEARCHPATH
1332 char_u *b_p_sua; /* 'suffixesadd' */
1333#endif
1334 int b_p_swf; /* 'swapfile' */
1335#ifdef FEAT_SYN_HL
1336 char_u *b_p_syn; /* 'syntax' */
1337#endif
1338 long b_p_ts; /* 'tabstop' */
1339 int b_p_tx; /* 'textmode' */
1340 long b_p_tw; /* 'textwidth' */
1341 long b_p_tw_nobin; /* b_p_tw saved for binary mode */
1342 long b_p_tw_nopaste; /* b_p_tw saved for paste mode */
1343 long b_p_wm; /* 'wrapmargin' */
1344 long b_p_wm_nobin; /* b_p_wm saved for binary mode */
1345 long b_p_wm_nopaste; /* b_p_wm saved for paste mode */
1346#ifdef FEAT_KEYMAP
1347 char_u *b_p_keymap; /* 'keymap' */
1348#endif
1349
1350 /* local values for options which are normally global */
1351#ifdef FEAT_QUICKFIX
1352 char_u *b_p_gp; /* 'grepprg' local value */
1353 char_u *b_p_mp; /* 'makeprg' local value */
1354 char_u *b_p_efm; /* 'errorformat' local value */
1355#endif
1356 char_u *b_p_ep; /* 'equalprg' local value */
1357 char_u *b_p_path; /* 'path' local value */
1358 int b_p_ar; /* 'autoread' local value */
1359 char_u *b_p_tags; /* 'tags' local value */
1360#ifdef FEAT_INS_EXPAND
1361 char_u *b_p_dict; /* 'dictionary' local value */
1362 char_u *b_p_tsr; /* 'thesaurus' local value */
1363#endif
1364
1365 /* end of buffer options */
1366
1367 int b_start_eol; /* last line had eol when it was read */
1368 int b_start_ffc; /* first char of 'ff' when edit started */
1369#ifdef FEAT_MBYTE
1370 char_u *b_start_fenc; /* 'fileencoding' when edit started or NULL */
1371#endif
1372
1373#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001374 dictitem_T b_bufvar; /* variable for "b:" Dictionary */
1375 dict_T b_vars; /* internal variables, local to buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376#endif
1377
1378 /* When a buffer is created, it starts without a swap file. b_may_swap is
1379 * then set to indicate that a swap file may be opened later. It is reset
1380 * if a swap file could not be opened.
1381 */
1382 int b_may_swap;
1383 int b_did_warn; /* Set to 1 if user has been warned on first
1384 change of a read-only file */
1385 int b_help; /* buffer for help file (when set b_p_bt is
1386 "help") */
1387
1388#ifndef SHORT_FNAME
1389 int b_shortname; /* this file has an 8.3 file name */
1390#endif
1391
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001392#ifdef FEAT_MZSCHEME
1393 void *mzscheme_ref; /* The MzScheme reference to this buffer */
1394#endif
1395
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396#ifdef FEAT_PERL
1397 void *perl_private;
1398#endif
1399
1400#ifdef FEAT_PYTHON
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001401 void *python_ref; /* The Python reference to this buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402#endif
1403
1404#ifdef FEAT_TCL
1405 void *tcl_ref;
1406#endif
1407
1408#ifdef FEAT_RUBY
1409 void *ruby_ref;
1410#endif
1411
1412#ifdef FEAT_SYN_HL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001413 hashtab_T b_keywtab; /* syntax keywords hash table */
1414 hashtab_T b_keywtab_ic; /* idem, ignore case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 int b_syn_ic; /* ignore case for :syn cmds */
1416 garray_T b_syn_patterns; /* table for syntax patterns */
1417 garray_T b_syn_clusters; /* table for syntax clusters */
1418 int b_syn_containedin; /* TRUE when there is an item with a
1419 "containedin" argument */
1420 int b_syn_sync_flags; /* flags about how to sync */
1421 short b_syn_sync_id; /* group to sync on */
1422 long b_syn_sync_minlines; /* minimal sync lines offset */
1423 long b_syn_sync_maxlines; /* maximal sync lines offset */
1424 long b_syn_sync_linebreaks; /* offset for multi-line pattern */
1425 char_u *b_syn_linecont_pat; /* line continuation pattern */
1426 regprog_T *b_syn_linecont_prog; /* line continuation program */
1427 int b_syn_linecont_ic; /* ignore-case flag for above */
1428 int b_syn_topgrp; /* for ":syntax include" */
1429# ifdef FEAT_FOLDING
1430 int b_syn_folditems; /* number of patterns with the HL_FOLD
1431 flag set */
1432# endif
1433/*
1434 * b_sst_array[] contains the state stack for a number of lines, for the start
1435 * of that line (col == 0). This avoids having to recompute the syntax state
1436 * too often.
1437 * b_sst_array[] is allocated to hold the state for all displayed lines, and
1438 * states for 1 out of about 20 other lines.
1439 * b_sst_array pointer to an array of synstate_T
1440 * b_sst_len number of entries in b_sst_array[]
1441 * b_sst_first pointer to first used entry in b_sst_array[] or NULL
1442 * b_sst_firstfree pointer to first free entry in b_sst_array[] or NULL
1443 * b_sst_freecount number of free entries in b_sst_array[]
1444 * b_sst_check_lnum entries after this lnum need to be checked for
1445 * validity (MAXLNUM means no check needed)
1446 */
1447 synstate_T *b_sst_array;
1448 int b_sst_len;
1449 synstate_T *b_sst_first;
1450 synstate_T *b_sst_firstfree;
1451 int b_sst_freecount;
1452 linenr_T b_sst_check_lnum;
1453 short_u b_sst_lasttick; /* last display tick */
1454#endif /* FEAT_SYN_HL */
1455
1456#ifdef FEAT_SIGNS
1457 signlist_T *b_signlist; /* list of signs to draw */
1458#endif
1459
1460#ifdef FEAT_NETBEANS_INTG
1461 int b_netbeans_file; /* TRUE when buffer is owned by NetBeans */
1462 int b_was_netbeans_file;/* TRUE if b_netbeans_file was once set */
1463#endif
1464
1465};
1466
1467/*
1468 * Structure to cache info for displayed lines in w_lines[].
1469 * Each logical line has one entry.
1470 * The entry tells how the logical line is currently displayed in the window.
1471 * This is updated when displaying the window.
1472 * When the display is changed (e.g., when clearing the screen) w_lines_valid
1473 * is changed to exclude invalid entries.
1474 * When making changes to the buffer, wl_valid is reset to indicate wl_size
1475 * may not reflect what is actually in the buffer. When wl_valid is FALSE,
1476 * the entries can only be used to count the number of displayed lines used.
1477 * wl_lnum and wl_lastlnum are invalid too.
1478 */
1479typedef struct w_line
1480{
1481 linenr_T wl_lnum; /* buffer line number for logical line */
1482 short_u wl_size; /* height in screen lines */
1483 char wl_valid; /* TRUE values are valid for text in buffer */
1484#ifdef FEAT_FOLDING
1485 char wl_folded; /* TRUE when this is a range of folded lines */
1486 linenr_T wl_lastlnum; /* last buffer line number for logical line */
1487#endif
1488} wline_T;
1489
1490/*
1491 * Windows are kept in a tree of frames. Each frame has a column (FR_COL)
1492 * or row (FR_ROW) layout or is a leaf, which has a window.
1493 */
1494struct frame
1495{
1496 char fr_layout; /* FR_LEAF, FR_COL or FR_ROW */
1497#ifdef FEAT_VERTSPLIT
1498 int fr_width;
1499#endif
1500 int fr_height;
1501 int fr_newheight; /* new height used in win_equal_rec() */
1502 frame_T *fr_parent; /* containing frame or NULL */
1503 frame_T *fr_next; /* frame right or below in same parent, NULL
1504 for first */
1505 frame_T *fr_prev; /* frame left or above in same parent, NULL
1506 for last */
1507 /* fr_child and fr_win are mutually exclusive */
1508 frame_T *fr_child; /* first contained frame */
1509 win_T *fr_win; /* window that fills this frame */
1510};
1511
1512#define FR_LEAF 0 /* frame is a leaf */
1513#define FR_ROW 1 /* frame with a row of windows */
1514#define FR_COL 2 /* frame with a column of windows */
1515
1516/*
1517 * Structure which contains all information that belongs to a window
1518 *
1519 * All row numbers are relative to the start of the window, except w_winrow.
1520 */
1521struct window
1522{
1523 buf_T *w_buffer; /* buffer we are a window into (used
1524 often, keep it the first item!) */
1525
1526#ifdef FEAT_WINDOWS
1527 win_T *w_prev; /* link to previous window */
1528 win_T *w_next; /* link to next window */
1529#endif
1530
1531 frame_T *w_frame; /* frame containing this window */
1532
1533 pos_T w_cursor; /* cursor position in buffer */
1534
1535 colnr_T w_curswant; /* The column we'd like to be at. This is
1536 used to try to stay in the same column
1537 for up/down cursor motions. */
1538
1539 int w_set_curswant; /* If set, then update w_curswant the next
1540 time through cursupdate() to the
1541 current virtual column */
1542
1543#ifdef FEAT_VISUAL
1544 /*
1545 * the next six are used to update the visual part
1546 */
1547 char w_old_visual_mode; /* last known VIsual_mode */
1548 linenr_T w_old_cursor_lnum; /* last known end of visual part */
1549 colnr_T w_old_cursor_fcol; /* first column for block visual part */
1550 colnr_T w_old_cursor_lcol; /* last column for block visual part */
1551 linenr_T w_old_visual_lnum; /* last known start of visual part */
1552 colnr_T w_old_curswant; /* last known value of Curswant */
1553#endif
1554
1555 /*
1556 * The next three specify the offsets for displaying the buffer:
1557 */
1558 linenr_T w_topline; /* buffer line number of the line at the
1559 top of the window */
1560#ifdef FEAT_DIFF
1561 int w_topfill; /* number of filler lines above w_topline */
1562 int w_old_topfill; /* w_topfill at last redraw */
1563 int w_botfill; /* TRUE when filler lines are actually
1564 below w_topline (at end of file) */
1565 int w_old_botfill; /* w_botfill at last redraw */
1566#endif
1567 colnr_T w_leftcol; /* window column number of the left most
1568 character in the window; used when
1569 'wrap' is off */
1570 colnr_T w_skipcol; /* starting column when a single line
1571 doesn't fit in the window */
1572
1573 /*
1574 * Layout of the window in the screen.
1575 * May need to add "msg_scrolled" to "w_winrow" in rare situations.
1576 */
1577#ifdef FEAT_WINDOWS
1578 int w_winrow; /* first row of window in screen */
1579#endif
1580 int w_height; /* number of rows in window, excluding
1581 status/command line(s) */
1582#ifdef FEAT_WINDOWS
1583 int w_status_height; /* number of status lines (0 or 1) */
1584#endif
1585#ifdef FEAT_VERTSPLIT
1586 int w_wincol; /* Leftmost column of window in screen.
1587 use W_WINCOL() */
1588 int w_width; /* Width of window, excluding separation.
1589 use W_WIDTH() */
1590 int w_vsep_width; /* Number of separator columns (0 or 1).
1591 use W_VSEP_WIDTH() */
1592#endif
1593
1594 /*
1595 * === start of cached values ====
1596 */
1597 /*
1598 * Recomputing is minimized by storing the result of computations.
1599 * Use functions in screen.c to check if they are valid and to update.
1600 * w_valid is a bitfield of flags, which indicate if specific values are
1601 * valid or need to be recomputed. See screen.c for values.
1602 */
1603 int w_valid;
1604 pos_T w_valid_cursor; /* last known position of w_cursor, used
1605 to adjust w_valid */
1606 colnr_T w_valid_leftcol; /* last known w_leftcol */
1607
1608 /*
1609 * w_cline_height is the number of physical lines taken by the buffer line
1610 * that the cursor is on. We use this to avoid extra calls to plines().
1611 */
1612 int w_cline_height; /* current size of cursor line */
1613#ifdef FEAT_FOLDING
1614 int w_cline_folded; /* cursor line is folded */
1615#endif
1616
1617 int w_cline_row; /* starting row of the cursor line */
1618
1619 colnr_T w_virtcol; /* column number of the cursor in the
1620 buffer line, as opposed to the column
1621 number we're at on the screen. This
1622 makes a difference on lines which span
1623 more than one screen line or when
1624 w_leftcol is non-zero */
1625
1626 /*
1627 * w_wrow and w_wcol specify the cursor position in the window.
1628 * This is related to positions in the window, not in the display or
1629 * buffer, thus w_wrow is relative to w_winrow.
1630 */
1631 int w_wrow, w_wcol; /* cursor position in window */
1632
1633 linenr_T w_botline; /* number of the line below the bottom of
1634 the screen */
1635 int w_empty_rows; /* number of ~ rows in window */
1636#ifdef FEAT_DIFF
1637 int w_filler_rows; /* number of filler rows at the end of the
1638 window */
1639#endif
1640
1641 /*
1642 * Info about the lines currently in the window is remembered to avoid
1643 * recomputing it every time. The allocated size of w_lines[] is Rows.
1644 * Only the w_lines_valid entries are actually valid.
1645 * When the display is up-to-date w_lines[0].wl_lnum is equal to w_topline
1646 * and w_lines[w_lines_valid - 1].wl_lnum is equal to w_botline.
1647 * Between changing text and updating the display w_lines[] represents
1648 * what is currently displayed. wl_valid is reset to indicated this.
1649 * This is used for efficient redrawing.
1650 */
1651 int w_lines_valid; /* number of valid entries */
1652 wline_T *w_lines;
1653
1654#ifdef FEAT_FOLDING
1655 garray_T w_folds; /* array of nested folds */
1656 char w_fold_manual; /* when TRUE: some folds are opened/closed
1657 manually */
1658 char w_foldinvalid; /* when TRUE: folding needs to be
1659 recomputed */
1660#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00001661#ifdef FEAT_LINEBREAK
1662 int w_nrwidth; /* width of 'number' column being used */
1663#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
1665 /*
1666 * === end of cached values ===
1667 */
1668
1669 int w_redr_type; /* type of redraw to be performed on win */
1670 int w_upd_rows; /* number of window lines to update when
1671 w_redr_type is REDRAW_TOP */
1672 linenr_T w_redraw_top; /* when != 0: first line needing redraw */
1673 linenr_T w_redraw_bot; /* when != 0: last line needing redraw */
1674#ifdef FEAT_WINDOWS
1675 int w_redr_status; /* if TRUE status line must be redrawn */
1676#endif
1677
1678#ifdef FEAT_CMDL_INFO
1679 /* remember what is shown in the ruler for this window (if 'ruler' set) */
1680 pos_T w_ru_cursor; /* cursor position shown in ruler */
1681 colnr_T w_ru_virtcol; /* virtcol shown in ruler */
1682 linenr_T w_ru_topline; /* topline shown in ruler */
1683 linenr_T w_ru_line_count; /* line count used for ruler */
1684# ifdef FEAT_DIFF
1685 int w_ru_topfill; /* topfill shown in ruler */
1686# endif
1687 char w_ru_empty; /* TRUE if ruler shows 0-1 (empty line) */
1688#endif
1689
1690 int w_alt_fnum; /* alternate file (for # and CTRL-^) */
1691
1692#ifdef FEAT_WINDOWS
1693 alist_T *w_alist; /* pointer to arglist for this window */
1694#endif
1695 int w_arg_idx; /* current index in argument list (can be
1696 out of range!) */
1697 int w_arg_idx_invalid; /* editing another file than w_arg_idx */
1698
1699 char_u *w_localdir; /* absolute path of local directory or
1700 NULL */
1701 /*
1702 * Options local to a window.
1703 * They are local because they influence the layout of the window or
1704 * depend on the window layout.
1705 * There are two values: w_onebuf_opt is local to the buffer currently in
1706 * this window, w_allbuf_opt is for all buffers in this window.
1707 */
1708 winopt_T w_onebuf_opt;
1709 winopt_T w_allbuf_opt;
1710
1711 /* transform a pointer to a "onebuf" option into a "allbuf" option */
1712#define GLOBAL_WO(p) ((char *)p + sizeof(winopt_T))
1713
1714#ifdef FEAT_SCROLLBIND
1715 long w_scbind_pos;
1716#endif
1717
1718#ifdef FEAT_EVAL
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001719 dictitem_T w_winvar; /* variable for "w:" Dictionary */
1720 dict_T w_vars; /* internal variables, local to window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721#endif
1722
1723#if defined(FEAT_RIGHTLEFT) && defined(FEAT_FKMAP)
1724 int w_farsi; /* for the window dependent Farsi functions */
1725#endif
1726
1727 /*
1728 * The w_prev_pcmark field is used to check whether we really did jump to
1729 * a new line after setting the w_pcmark. If not, then we revert to
1730 * using the previous w_pcmark.
1731 */
1732 pos_T w_pcmark; /* previous context mark */
1733 pos_T w_prev_pcmark; /* previous w_pcmark */
1734
1735#ifdef FEAT_JUMPLIST
1736 /*
1737 * the jumplist contains old cursor positions
1738 */
1739 xfmark_T w_jumplist[JUMPLISTSIZE];
1740 int w_jumplistlen; /* number of active entries */
1741 int w_jumplistidx; /* current position */
1742
1743 int w_changelistidx; /* current position in b_changelist */
1744#endif
1745
1746#ifdef FEAT_SEARCH_EXTRA
1747 regmmatch_T w_match; /* regexp program for ":match" */
1748 int w_match_id; /* highlight ID for ":match" */
1749#endif
1750
1751 /*
1752 * the tagstack grows from 0 upwards:
1753 * entry 0: older
1754 * entry 1: newer
1755 * entry 2: newest
1756 */
1757 taggy_T w_tagstack[TAGSTACKSIZE]; /* the tag stack */
1758 int w_tagstackidx; /* idx just below activ entry */
1759 int w_tagstacklen; /* number of tags on stack */
1760
1761 /*
1762 * w_fraction is the fractional row of the cursor within the window, from
1763 * 0 at the top row to FRACTION_MULT at the last row.
1764 * w_prev_fraction_row was the actual cursor row when w_fraction was last
1765 * calculated.
1766 */
1767 int w_fraction;
1768 int w_prev_fraction_row;
1769
1770#ifdef FEAT_GUI
1771 scrollbar_T w_scrollbars[2]; /* vert. Scrollbars for this window */
1772#endif
Bram Moolenaar592e0a22004-07-03 16:05:59 +00001773#ifdef FEAT_LINEBREAK
1774 linenr_T w_nrwidth_line_count; /* line count when ml_nrwidth_width
1775 * was computed. */
1776 int w_nrwidth_width; /* nr of chars to print line count. */
1777#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001779
1780#ifdef FEAT_MZSCHEME
1781 void *mzscheme_ref; /* The MzScheme value referring to this window */
1782#endif
1783
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784#ifdef FEAT_PERL
1785 void *perl_private;
1786#endif
1787
1788#ifdef FEAT_PYTHON
1789 void *python_ref; /* The Python value referring to this
1790 window */
1791#endif
1792
1793#ifdef FEAT_TCL
1794 void *tcl_ref;
1795#endif
1796
1797#ifdef FEAT_RUBY
1798 void *ruby_ref;
1799#endif
1800};
1801
1802/*
1803 * Arguments for operators.
1804 */
1805typedef struct oparg
1806{
1807 int op_type; /* current pending operator type */
1808 int regname; /* register to use for the operator */
1809 int motion_type; /* type of the current cursor motion */
1810 int motion_force; /* force motion type: 'v', 'V' or CTRL-V */
1811 int use_reg_one; /* TRUE if delete uses reg 1 even when not
1812 linewise */
1813 int inclusive; /* TRUE if char motion is inclusive (only
1814 valid when motion_type is MCHAR */
1815 int end_adjusted; /* backuped b_op_end one char (only used by
1816 do_format()) */
1817 pos_T start; /* start of the operator */
1818 pos_T end; /* end of the operator */
1819 pos_T cursor_start; /* cursor position before motion for "gw" */
1820
1821 long line_count; /* number of lines from op_start to op_end
1822 (inclusive) */
1823 int empty; /* op_start and op_end the same (only used by
1824 do_change()) */
1825#ifdef FEAT_VISUAL
1826 int is_VIsual; /* operator on Visual area */
1827 int block_mode; /* current operator is Visual block mode */
1828#endif
1829 colnr_T start_vcol; /* start col for block mode operator */
1830 colnr_T end_vcol; /* end col for block mode operator */
1831} oparg_T;
1832
1833/*
1834 * Arguments for Normal mode commands.
1835 */
1836typedef struct cmdarg
1837{
1838 oparg_T *oap; /* Operator arguments */
1839 int prechar; /* prefix character (optional, always 'g') */
1840 int cmdchar; /* command character */
1841 int nchar; /* next command character (optional) */
1842#ifdef FEAT_MBYTE
1843 int ncharC1; /* first composing character (optional) */
1844 int ncharC2; /* second composing character (optional) */
1845#endif
1846 int extra_char; /* yet another character (optional) */
1847 long opcount; /* count before an operator */
1848 long count0; /* count before command, default 0 */
1849 long count1; /* count before command, default 1 */
1850 int arg; /* extra argument from nv_cmds[] */
1851 int retval; /* return: CA_* values */
1852 char_u *searchbuf; /* return: pointer to search pattern or NULL */
1853} cmdarg_T;
1854
1855/* values for retval: */
1856#define CA_COMMAND_BUSY 1 /* skip restarting edit() once */
1857#define CA_NO_ADJ_OP_END 2 /* don't adjust operator end */
1858
1859#ifdef CURSOR_SHAPE
1860/*
1861 * struct to store values from 'guicursor' and 'mouseshape'
1862 */
1863/* Indexes in shape_table[] */
1864#define SHAPE_IDX_N 0 /* Normal mode */
1865#define SHAPE_IDX_V 1 /* Visual mode */
1866#define SHAPE_IDX_I 2 /* Insert mode */
1867#define SHAPE_IDX_R 3 /* Replace mode */
1868#define SHAPE_IDX_C 4 /* Command line Normal mode */
1869#define SHAPE_IDX_CI 5 /* Command line Insert mode */
1870#define SHAPE_IDX_CR 6 /* Command line Replace mode */
1871#define SHAPE_IDX_O 7 /* Operator-pending mode */
1872#define SHAPE_IDX_VE 8 /* Visual mode with 'seleciton' exclusive */
1873#define SHAPE_IDX_CLINE 9 /* On command line */
1874#define SHAPE_IDX_STATUS 10 /* A status line */
1875#define SHAPE_IDX_SDRAG 11 /* dragging a status line */
1876#define SHAPE_IDX_VSEP 12 /* A vertical separator line */
1877#define SHAPE_IDX_VDRAG 13 /* dragging a vertical separator line */
1878#define SHAPE_IDX_MORE 14 /* Hit-return or More */
1879#define SHAPE_IDX_MOREL 15 /* Hit-return or More in last line */
1880#define SHAPE_IDX_SM 16 /* showing matching paren */
1881#define SHAPE_IDX_COUNT 17
1882
1883#define SHAPE_BLOCK 0 /* block cursor */
1884#define SHAPE_HOR 1 /* horizontal bar cursor */
1885#define SHAPE_VER 2 /* vertical bar cursor */
1886
1887#define MSHAPE_NUMBERED 1000 /* offset for shapes identified by number */
1888#define MSHAPE_HIDE 1 /* hide mouse pointer */
1889
1890#define SHAPE_MOUSE 1 /* used for mouse pointer shape */
1891#define SHAPE_CURSOR 2 /* used for text cursor shape */
1892
1893typedef struct cursor_entry
1894{
1895 int shape; /* one of the SHAPE_ defines */
1896 int mshape; /* one of the MSHAPE defines */
1897 int percentage; /* percentage of cell for bar */
1898 long blinkwait; /* blinking, wait time before blinking starts */
1899 long blinkon; /* blinking, on time */
1900 long blinkoff; /* blinking, off time */
1901 int id; /* highlight group ID */
1902 int id_lm; /* highlight group ID for :lmap mode */
1903 char *name; /* mode name (fixed) */
1904 char used_for; /* SHAPE_MOUSE and/or SHAPE_CURSOR */
1905} cursorentry_T;
1906#endif /* CURSOR_SHAPE */
1907
1908#ifdef FEAT_MENU
1909
1910/* Indices into vimmenu_T->strings[] and vimmenu_T->noremap[] for each mode */
1911#define MENU_INDEX_INVALID -1
1912#define MENU_INDEX_NORMAL 0
1913#define MENU_INDEX_VISUAL 1
1914#define MENU_INDEX_OP_PENDING 2
1915#define MENU_INDEX_INSERT 3
1916#define MENU_INDEX_CMDLINE 4
1917#define MENU_INDEX_TIP 5
1918#define MENU_MODES 6
1919
1920/* Menu modes */
1921#define MENU_NORMAL_MODE (1 << MENU_INDEX_NORMAL)
1922#define MENU_VISUAL_MODE (1 << MENU_INDEX_VISUAL)
1923#define MENU_OP_PENDING_MODE (1 << MENU_INDEX_OP_PENDING)
1924#define MENU_INSERT_MODE (1 << MENU_INDEX_INSERT)
1925#define MENU_CMDLINE_MODE (1 << MENU_INDEX_CMDLINE)
1926#define MENU_TIP_MODE (1 << MENU_INDEX_TIP)
1927#define MENU_ALL_MODES ((1 << MENU_INDEX_TIP) - 1)
1928/*note MENU_INDEX_TIP is not a 'real' mode*/
1929
1930/* Start a menu name with this to not include it on the main menu bar */
1931#define MNU_HIDDEN_CHAR ']'
1932
1933typedef struct VimMenu vimmenu_T;
1934
1935struct VimMenu
1936{
1937 int modes; /* Which modes is this menu visible for? */
1938 int enabled; /* for which modes the menu is enabled */
1939 char_u *name; /* Name of menu */
1940 char_u *dname; /* Displayed Name (without '&') */
1941 int mnemonic; /* mnemonic key (after '&') */
1942 char_u *actext; /* accelerator text (after TAB) */
1943 int priority; /* Menu order priority */
1944#ifdef FEAT_GUI
1945 void (*cb)(); /* Call-back routine */
1946#endif
1947#ifdef FEAT_TOOLBAR
1948 char_u *iconfile; /* name of file for icon or NULL */
1949 int iconidx; /* icon index (-1 if not set) */
1950 int icon_builtin; /* icon names is BuiltIn{nr} */
1951#endif
1952 char_u *strings[MENU_MODES]; /* Mapped string for each mode */
1953 int noremap[MENU_MODES]; /* A REMAP_ flag for each mode */
1954 char silent[MENU_MODES]; /* A silent flag for each mode */
1955 vimmenu_T *children; /* Children of sub-menu */
1956 vimmenu_T *parent; /* Parent of menu */
1957 vimmenu_T *next; /* Next item in menu */
1958#ifdef FEAT_GUI_X11
1959 Widget id; /* Manage this to enable item */
1960 Widget submenu_id; /* If this is submenu, add children here */
1961#endif
Bram Moolenaar843ee412004-06-30 16:16:41 +00001962#ifdef FEAT_GUI_KDE
1963 QPopupMenu *widget;
1964#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965#ifdef FEAT_GUI_GTK
1966 GtkWidget *id; /* Manage this to enable item */
1967 GtkWidget *submenu_id; /* If this is submenu, add children here */
1968 GtkWidget *tearoff_handle;
1969 GtkWidget *label; /* Used by "set wak=" code. */
1970#endif
1971#ifdef FEAT_GUI_MOTIF
1972 int sensitive; /* turn button on/off */
Bram Moolenaarec2dad62005-01-02 11:36:03 +00001973 char **xpm; /* pixmap data */
Bram Moolenaar7c626922005-02-07 22:01:03 +00001974 char *xpm_fname; /* file with pixmap data */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975#endif
Bram Moolenaarec2dad62005-01-02 11:36:03 +00001976#ifdef FEAT_GUI_ATHENA
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 Pixmap image; /* Toolbar image */
1978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979#ifdef FEAT_BEVAL_TIP
1980 BalloonEval *tip; /* tooltip for this menu item */
1981#endif
1982#ifdef FEAT_GUI_W16
1983 UINT id; /* Id of menu item */
1984 HMENU submenu_id; /* If this is submenu, add children here */
1985#endif
1986#ifdef FEAT_GUI_W32
1987 UINT id; /* Id of menu item */
1988 HMENU submenu_id; /* If this is submenu, add children here */
1989 HWND tearoff_handle; /* hWnd of tearoff if created */
1990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991#ifdef FEAT_GUI_MAC
1992/* MenuHandle id; */
1993/* short index; */ /* the item index within the father menu */
1994 short menu_id; /* the menu id to which this item belong */
1995 short submenu_id; /* the menu id of the children (could be
1996 get throught some tricks) */
1997 MenuHandle menu_handle;
1998 MenuHandle submenu_handle;
1999#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000#ifdef RISCOS
2001 int *id; /* Not used, but gui.c needs it */
2002 int greyed_out; /* Flag */
2003 int hidden;
2004#endif
2005#ifdef FEAT_GUI_PHOTON
2006 PtWidget_t *id;
2007 PtWidget_t *submenu_id;
2008#endif
2009};
2010#else
2011/* For generating prototypes when FEAT_MENU isn't defined. */
2012typedef int vimmenu_T;
2013
2014#endif /* FEAT_MENU */
2015
2016/*
2017 * Struct to save values in before executing autocommands for a buffer that is
2018 * not the current buffer.
2019 */
2020typedef struct
2021{
2022 buf_T *save_buf; /* saved curbuf */
2023 buf_T *new_curbuf; /* buffer to be used */
2024 win_T *save_curwin; /* saved curwin, NULL if it didn't change */
2025 win_T *new_curwin; /* new curwin if save_curwin != NULL */
2026 pos_T save_cursor; /* saved cursor pos of save_curwin */
2027 linenr_T save_topline; /* saved topline of save_curwin */
2028#ifdef FEAT_DIFF
2029 int save_topfill; /* saved topfill of save_curwin */
2030#endif
2031} aco_save_T;
2032
2033/*
2034 * Generic option table item, only used for printer at the moment.
2035 */
2036typedef struct
2037{
2038 const char *name;
2039 int hasnum;
2040 long number;
2041 char_u *string; /* points into option string */
2042 int strlen;
2043 int present;
2044} option_table_T;
2045
2046/*
2047 * Structure to hold printing color and font attributes.
2048 */
2049typedef struct
2050{
2051 long_u fg_color;
2052 long_u bg_color;
2053 int bold;
2054 int italic;
2055 int underline;
2056} prt_text_attr_T;
2057
2058/*
2059 * Structure passed back to the generic printer code.
2060 */
2061typedef struct
2062{
2063 int n_collated_copies;
2064 int n_uncollated_copies;
2065 int duplex;
2066 int chars_per_line;
2067 int lines_per_page;
2068 int has_color;
2069 prt_text_attr_T number;
2070#ifdef FEAT_SYN_HL
2071 int modec;
2072 int do_syntax;
2073#endif
2074 int user_abort;
2075 char_u *jobname;
2076#ifdef FEAT_POSTSCRIPT
2077 char_u *outfile;
2078 char_u *arguments;
2079#endif
2080} prt_settings_T;
2081
2082#define PRINT_NUMBER_WIDTH 8