blob: 5b176d453a28607752f01bf0757ddc27a2f207ea [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#ifndef VIM__H
10# define VIM__H
11
12/* use fastcall for Borland, when compiling for Win32 (not for DOS16) */
13#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
14#if defined(FEAT_PERL) || \
15 defined(FEAT_PYTHON) || \
16 defined(FEAT_RUBY) || \
17 defined(FEAT_TCL) || \
Bram Moolenaar325b7a22004-07-05 15:58:32 +000018 defined(FEAT_MZSCHEME) || \
Bram Moolenaar071d4272004-06-13 20:20:40 +000019 defined(DYNAMIC_GETTEXT) || \
20 defined(DYNAMIC_ICONV) || \
21 defined(DYNAMIC_IME) || \
22 defined(XPM)
Bram Moolenaaraab21c32005-01-25 21:46:35 +000023 #pragma option -pc
Bram Moolenaar071d4272004-06-13 20:20:40 +000024# else
Bram Moolenaaraab21c32005-01-25 21:46:35 +000025 #pragma option -pr
Bram Moolenaar071d4272004-06-13 20:20:40 +000026# endif
27#endif
28
29/* ============ the header file puzzle (ca. 50-100 pieces) ========= */
30
31#ifdef HAVE_CONFIG_H /* GNU autoconf (or something else) was here */
32# include "auto/config.h"
33# define HAVE_PATHDEF
34
35/*
36 * Check if configure correcly managed to find sizeof(int). If this failed,
37 * it becomes zero. This is likely a problem of not being able to run the
38 * test program. Other items from configure may also be wrong then!
39 */
40# if (SIZEOF_INT == 0)
41 Error: configure did not run properly. Check auto/config.log.
42# endif
43
44/*
45 * Cygwin may have fchdir() in a newer rleease, but in most versions it
46 * doesn't work well and avoiding it keeps the binary backward compatible.
47 */
48# if defined(__CYGWIN32__) && defined(HAVE_FCHDIR)
49# undef HAVE_FCHDIR
50# endif
51#endif
52
53#ifdef __EMX__ /* hand-edited config.h for OS/2 with EMX */
54# include "os_os2_cfg.h"
55#endif
56
57/*
58 * MACOS_CLASSIC compiling for MacOS prior to MacOS X
59 * MACOS_X_UNIX compiling for MacOS X (using os_unix.c)
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +000060 * MACOS_X compiling for MacOS X (using os_unix.c)
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 * MACOS compiling for either one
62 */
63#if defined(macintosh) && !defined(MACOS_CLASSIC)
64# define MACOS_CLASSIC
65#endif
66#if defined(MACOS_X_UNIX)
67# define MACOS_X
68# ifndef HAVE_CONFIG_H
69# define UNIX
70# endif
71#endif
72#if defined(MACOS_X) || defined(MACOS_CLASSIC)
73# define MACOS
74#endif
75#if defined(MACOS_X) && defined(MACOS_CLASSIC)
76 Error: To compile for both MACOS X and Classic use a Classic Carbon
77#endif
78/* Unless made through the Makefile enforce GUI on Mac */
79#if defined(MACOS) && !defined(HAVE_CONFIG_H)
80# define FEAT_GUI_MAC
81#endif
82
83
84#if defined(FEAT_GUI_MOTIF) \
85 || defined(FEAT_GUI_GTK) \
86 || defined(FEAT_GUI_ATHENA) \
87 || defined(FEAT_GUI_MAC) \
88 || defined(FEAT_GUI_W32) \
89 || defined(FEAT_GUI_W16) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +000090 || defined(FEAT_GUI_PHOTON)
Bram Moolenaarab79bcb2004-07-18 21:34:53 +000091# if !defined(FEAT_GUI) && !defined(NO_X11_INCLUDES)
Bram Moolenaar071d4272004-06-13 20:20:40 +000092# define FEAT_GUI
93# endif
94#endif
95
Bram Moolenaar362e1a32006-03-06 23:29:24 +000096/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */
97#if _MSC_VER >= 1400
98# define _CRT_SECURE_NO_DEPRECATE
99# define _CRT_NONSTDC_NO_DEPRECATE
100#endif
101
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102#if defined(FEAT_GUI_W32) || defined(FEAT_GUI_W16)
103# define FEAT_GUI_MSWIN
104#endif
105#if defined(WIN16) || defined(WIN32) || defined(_WIN64)
106# define MSWIN
107#endif
108/* Practically everything is common to both Win32 and Win64 */
109#if defined(WIN32) || defined(_WIN64)
110# define WIN3264
111#endif
112
113/*
114 * SIZEOF_INT is used in feature.h, and the system-specific included files
115 * need items from feature.h. Therefore define SIZEOF_INT here.
116 */
117#ifdef WIN3264
118# define SIZEOF_INT 4
119#endif
120#ifdef MSDOS
121# ifdef DJGPP
122# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
123# define SIZEOF_INT 4 /* 32 bit ints */
124# endif
125# define DOS32
126# define FEAT_CLIPBOARD
127# else
128# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
129# define SIZEOF_INT 2 /* 16 bit ints */
130# endif
131# define SMALL_MALLOC /* 16 bit storage allocation */
132# define DOS16
133# endif
134#endif
135
136#ifdef AMIGA
137 /* Be conservative about sizeof(int). It could be 4 too. */
138# ifndef FEAT_GUI_GTK /* avoid problems when generating prototypes */
139# ifdef __GNUC__
140# define SIZEOF_INT 4
141# else
142# define SIZEOF_INT 2
143# endif
144# endif
145#endif
146#ifdef MACOS
Bram Moolenaar2a0449d2006-02-20 21:27:21 +0000147# if defined(__POWERPC__) || defined(MACOS_X) || defined(__fourbyteints__) \
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148 || defined(__MRC__) || defined(__SC__) || defined(__APPLE_CC__)/* MPW Compilers */
149# define SIZEOF_INT 4
150# else
151# define SIZEOF_INT 2
152# endif
153#endif
154#ifdef RISCOS
155# define SIZEOF_INT 4
156#endif
157
158
159#include "feature.h" /* #defines for optionals and features */
160
161/* +x11 is only enabled when it's both available and wanted. */
162#if defined(HAVE_X11) && defined(WANT_X11)
163# define FEAT_X11
164#endif
165
Bram Moolenaarab79bcb2004-07-18 21:34:53 +0000166#ifdef NO_X11_INCLUDES
167 /* In os_mac_conv.c NO_X11_INCLUDES is defined to avoid X11 headers.
168 * Disable all X11 related things to avoid conflicts. */
169# ifdef FEAT_X11
170# undef FEAT_X11
171# endif
172# ifdef FEAT_XCLIPBOARD
173# undef FEAT_XCLIPBOARD
174# endif
175# ifdef FEAT_GUI_MOTIF
176# undef FEAT_GUI_MOTIF
177# endif
178# ifdef FEAT_GUI_ATHENA
179# undef FEAT_GUI_ATHENA
180# endif
181# ifdef FEAT_GUI_GTK
182# undef FEAT_GUI_GTK
183# endif
184# ifdef FEAT_BEVAL_TIP
185# undef FEAT_BEVAL_TIP
186# endif
187# ifdef FEAT_XIM
188# undef FEAT_XIM
189# endif
190# ifdef FEAT_CLIENTSERVER
191# undef FEAT_CLIENTSERVER
192# endif
193#endif
194
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195/* Can't use "PACKAGE" here, conflicts with a Perl include file. */
196#ifndef VIMPACKAGE
197# define VIMPACKAGE "vim"
198#endif
199
200/*
201 * Find out if function definitions should include argument types
202 */
203#ifdef AZTEC_C
204# include <functions.h>
205# define __ARGS(x) x
206#endif
207
208#ifdef SASC
209# include <clib/exec_protos.h>
210# define __ARGS(x) x
211#endif
212
213#ifdef _DCC
214# include <clib/exec_protos.h>
215# define __ARGS(x) x
216#endif
217
218#ifdef __TURBOC__
219# define __ARGS(x) x
220#endif
221
222#ifdef __BEOS__
223# include "os_beos.h"
224# define __ARGS(x) x
225#endif
226
227#if (defined(UNIX) || defined(__EMX__) || defined(VMS)) \
228 && (!defined(MACOS_X) || defined(HAVE_CONFIG_H))
229# include "os_unix.h" /* bring lots of system header files */
230#endif
231
232#if defined(MACOS) && (defined(__MRC__) || defined(__SC__))
233 /* Apple's Compilers support prototypes */
234# define __ARGS(x) x
235#endif
236#ifndef __ARGS
237# if defined(__STDC__) || defined(__GNUC__) || defined(WIN3264)
238# define __ARGS(x) x
239# else
240# define __ARGS(x) ()
241# endif
242#endif
243
244/* __ARGS and __PARMS are the same thing. */
245#ifndef __PARMS
246# define __PARMS(x) __ARGS(x)
247#endif
248
Bram Moolenaar843ee412004-06-30 16:16:41 +0000249/* if we're compiling in C++ (currently only KVim), the system
250 * headers must have the correct prototypes or nothing will build.
251 * conversely, our prototypes might clash due to throw() specifiers and
252 * cause compilation failures even though the headers are correct. for
253 * a concrete example, gcc-3.2 enforces exception specifications, and
254 * glibc-2.2.5 has them in their system headers.
255 */
256#if !defined(__cplusplus) && defined(UNIX) \
257 && !defined(MACOS_X) /* MACOS_X doesn't yet support osdef.h */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258# include "auto/osdef.h" /* bring missing declarations in */
259#endif
260
261#ifdef __EMX__
262# define getcwd _getcwd2
263# define chdir _chdir2
264# undef CHECK_INODE
265#endif
266
267#ifdef AMIGA
268# include "os_amiga.h"
269#endif
270
271#ifdef MSDOS
272# include "os_msdos.h"
273#endif
274
275#ifdef WIN16
276# include "os_win16.h"
277#endif
278
279#ifdef WIN3264
280# include "os_win32.h"
281#endif
282
283#ifdef __MINT__
284# include "os_mint.h"
285#endif
286
287#if defined(MACOS)
288# if defined(__MRC__) || defined(__SC__) /* MPW Compilers */
289# define HAVE_SETENV
290# endif
291# include "os_mac.h"
292#endif
293
294#ifdef RISCOS
295# include "os_riscos.h"
296#endif
297
298#ifdef __QNX__
299# include "os_qnx.h"
300#endif
301
302#ifdef FEAT_SUN_WORKSHOP
303# include "workshop.h"
304#endif
305
306#ifdef X_LOCALE
307# include <X11/Xlocale.h>
308#else
309# ifdef HAVE_LOCALE_H
310# include <locale.h>
311# endif
312#endif
313
314/*
315 * Maximum length of a path (for non-unix systems) Make it a bit long, to stay
316 * on the safe side. But not too long to put on the stack.
317 */
318#ifndef MAXPATHL
319# ifdef MAXPATHLEN
320# define MAXPATHL MAXPATHLEN
321# else
322# define MAXPATHL 256
323# endif
324#endif
325#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000326# define PATH_ESC_CHARS ((char_u *)" \t*?[{`%#")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327#else
Bram Moolenaar0fd92892006-03-09 22:27:48 +0000328# define PATH_ESC_CHARS ((char_u *)" \t*?[{`$\\%#'\"|")
Bram Moolenaar05a7bb32006-01-19 22:09:32 +0000329# define SHELL_ESC_CHARS ((char_u *)" \t*?[{`$\\%#'\"|<>();&!")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330#endif
331
332#define NUMBUFLEN 30 /* length of a buffer to store a number in ASCII */
333
334/*
335 * Shorthand for unsigned variables. Many systems, but not all, have u_char
336 * already defined, so we use char_u to avoid trouble.
337 */
338typedef unsigned char char_u;
339typedef unsigned short short_u;
340typedef unsigned int int_u;
341/* Make sure long_u is big enough to hold a pointer. On Win64 longs are 32
342 * bit and pointers 64 bit. */
343#ifdef _WIN64
344typedef unsigned __int64 long_u;
345#else
346typedef unsigned long long_u;
347#endif
348
349/*
350 * The characters and attributes cached for the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 */
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000352typedef char_u schar_T;
Bram Moolenaar3918c952005-03-15 22:34:55 +0000353#ifdef FEAT_SYN_HL
354typedef unsigned short sattr_T;
355# define MAX_TYPENR 65535
356#else
357typedef unsigned char sattr_T;
358# define MAX_TYPENR 255
359#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360
361/*
362 * The u8char_T can hold one decoded UTF-8 character.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000363 * We normally use 32 bits now, since some Asian characters don't fit in 16
364 * bits. u8char_T is only used for displaying, it could be 16 bits to save
365 * memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 */
367#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000368# ifdef UNICODE16
369typedef unsigned short u8char_T; /* short should be 16 bits */
370# else
371# if SIZEOF_INT >= 4
372typedef unsigned int u8char_T; /* int is 32 bits */
373# else
374typedef unsigned long u8char_T; /* long should be 32 bits or more */
375# endif
376# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377#endif
378
379#ifndef UNIX /* For Unix this is included in os_unix.h */
380# include <stdio.h>
381# include <ctype.h>
382#endif
383
384#include "ascii.h"
385#include "keymap.h"
386#include "term.h"
387#include "macros.h"
388
389#ifdef LATTICE
390# include <sys/types.h>
391# include <sys/stat.h>
392#endif
393#ifdef _DCC
394# include <sys/stat.h>
395#endif
396#if defined(MSDOS) || defined(MSWIN)
397# include <sys/stat.h>
398#endif
399
400/*
401 * Allow other (non-unix) systems to configure themselves now
402 * These are also in os_unix.h, because osdef.sh needs them there.
403 */
404#ifndef UNIX
405/* Note: Some systems need both string.h and strings.h (Savage). If the
406 * system can't handle this, define NO_STRINGS_WITH_STRING_H. */
407# ifdef HAVE_STRING_H
408# include <string.h>
409# endif
410# if defined(HAVE_STRINGS_H) && !defined(NO_STRINGS_WITH_STRING_H)
411# include <strings.h>
412# endif
413# ifdef HAVE_STAT_H
414# include <stat.h>
415# endif
416# ifdef HAVE_STDLIB_H
417# include <stdlib.h>
418# endif
419#endif /* NON-UNIX */
420
421#include <assert.h>
422
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000423#ifdef HAVE_WCTYPE_H
424# include <wctype.h>
425#endif
Bram Moolenaar53805d12005-08-01 07:08:33 +0000426#ifdef HAVE_STDARG_H
427# include <stdarg.h>
428#endif
Bram Moolenaar8fef2ad2005-04-23 20:42:23 +0000429
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430/* ================ end of the header file puzzle =============== */
431
432/*
433 * For dynamically loaded imm library. Currently, only for Win32.
434 */
435#ifdef DYNAMIC_IME
436# ifndef FEAT_MBYTE_IME
437# define FEAT_MBYTE_IME
438# endif
439#endif
440
441/*
442 * Check input method control.
443 */
444#if defined(FEAT_XIM) || \
445 (defined(FEAT_GUI) && (defined(FEAT_MBYTE_IME) || defined(GLOBAL_IME)))
446# define USE_IM_CONTROL
447#endif
448
449/*
450 * For dynamically loaded gettext library. Currently, only for Win32.
451 */
452#ifdef DYNAMIC_GETTEXT
453# ifndef FEAT_GETTEXT
454# define FEAT_GETTEXT
455# endif
456/* These are in os_win32.c */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000457extern char *(*dyn_libintl_gettext)(const char *msgid);
458extern char *(*dyn_libintl_bindtextdomain)(const char *domainname, const char *dirname);
459extern char *(*dyn_libintl_bind_textdomain_codeset)(const char *domainname, const char *codeset);
460extern char *(*dyn_libintl_textdomain)(const char *domainname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461#endif
462
463
464/*
465 * The _() stuff is for using gettext(). It is a no-op when libintl.h is not
466 * found or the +multilang feature is disabled.
467 */
468#ifdef FEAT_GETTEXT
469# ifdef DYNAMIC_GETTEXT
470# define _(x) (*dyn_libintl_gettext)((char *)(x))
471# define N_(x) x
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000472# define bindtextdomain(domain, dir) (*dyn_libintl_bindtextdomain)((domain), (dir))
473# define bind_textdomain_codeset(domain, codeset) (*dyn_libintl_bind_textdomain_codeset)((domain), (codeset))
474# if !defined(HAVE_BIND_TEXTDOMAIN_CODESET)
475# define HAVE_BIND_TEXTDOMAIN_CODESET 1
476# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477# define textdomain(domain) (*dyn_libintl_textdomain)(domain)
478# else
479# include <libintl.h>
480# define _(x) gettext((char *)(x))
481# ifdef gettext_noop
482# define N_(x) gettext_noop(x)
483# else
484# define N_(x) x
485# endif
486# endif
487#else
488# define _(x) ((char *)(x))
489# define N_(x) x
490# ifdef bindtextdomain
491# undef bindtextdomain
492# endif
493# define bindtextdomain(x, y) /* empty */
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000494# ifdef bind_textdomain_codeset
495# undef bind_textdomain_codeset
496# endif
497# define bind_textdomain_codeset(x, y) /* empty */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498# ifdef textdomain
499# undef textdomain
500# endif
501# define textdomain(x) /* empty */
502#endif
503
504/*
505 * flags for update_screen()
506 * The higher the value, the higher the priority
507 */
508#define VALID 10 /* buffer not changed, or changes marked
509 with b_mod_* */
510#define INVERTED 20 /* redisplay inverted part that changed */
511#define INVERTED_ALL 25 /* redisplay whole inverted part */
512#define REDRAW_TOP 30 /* display first w_upd_rows screen lines */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +0000513#define SOME_VALID 35 /* like NOT_VALID but may scroll */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514#define NOT_VALID 40 /* buffer needs complete redraw */
515#define CLEAR 50 /* screen messed up, clear it */
516
517/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518 * Flags for w_valid.
519 * These are set when something in a window structure becomes invalid, except
520 * when the cursor is moved. Call check_cursor_moved() before testing one of
521 * the flags.
522 * These are reset when that thing has been updated and is valid again.
523 *
524 * Every function that invalidates one of these must call one of the
525 * invalidate_* functions.
526 *
527 * w_valid is supposed to be used only in screen.c. From other files, use the
528 * functions that set or reset the flags.
529 *
530 * VALID_BOTLINE VALID_BOTLINE_AP
531 * on on w_botline valid
532 * off on w_botline approximated
533 * off off w_botline not valid
534 * on off not possible
535 */
536#define VALID_WROW 0x01 /* w_wrow (window row) is valid */
537#define VALID_WCOL 0x02 /* w_wcol (window col) is valid */
538#define VALID_VIRTCOL 0x04 /* w_virtcol (file col) is valid */
539#define VALID_CHEIGHT 0x08 /* w_cline_height and w_cline_folded valid */
540#define VALID_CROW 0x10 /* w_cline_row is valid */
541#define VALID_BOTLINE 0x20 /* w_botine and w_empty_rows are valid */
542#define VALID_BOTLINE_AP 0x40 /* w_botine is approximated */
543#define VALID_TOPLINE 0x80 /* w_topline is valid (for cursor position) */
544
545/*
546 * Terminal highlighting attribute bits.
547 * Attibutes above HL_ALL are used for syntax highlighting.
548 */
549#define HL_NORMAL 0x00
550#define HL_INVERSE 0x01
551#define HL_BOLD 0x02
552#define HL_ITALIC 0x04
553#define HL_UNDERLINE 0x08
Bram Moolenaar3918c952005-03-15 22:34:55 +0000554#define HL_UNDERCURL 0x10
555#define HL_STANDOUT 0x20
556#define HL_ALL 0x3f
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558/* special attribute addition: Put message in history */
559#define MSG_HIST 0x1000
560
561/*
562 * values for State
563 *
564 * The lower bits up to 0x20 are used to distinguish normal/visual/op_pending
565 * and cmdline/insert+replace mode. This is used for mapping. If none of
566 * these bits are set, no mapping is done.
567 * The upper bits are used to distinguish between other states.
568 */
569#define NORMAL 0x01 /* Normal mode, command expected */
570#define VISUAL 0x02 /* Visual mode - use get_real_state() */
571#define OP_PENDING 0x04 /* Normal mode, operator is pending - use
572 get_real_state() */
573#define CMDLINE 0x08 /* Editing command line */
574#define INSERT 0x10 /* Insert mode */
575#define LANGMAP 0x20 /* Language mapping, can be combined with
576 INSERT and CMDLINE */
577#define MAP_ALL_MODES 0x3f /* all mode bits used for mapping */
578
579#define REPLACE_FLAG 0x40 /* Replace mode flag */
580#define REPLACE (REPLACE_FLAG + INSERT)
581#ifdef FEAT_VREPLACE
582# define VREPLACE_FLAG 0x80 /* Virtual-replace mode flag */
583# define VREPLACE (REPLACE_FLAG + VREPLACE_FLAG + INSERT)
584#endif
585#define LREPLACE (REPLACE_FLAG + LANGMAP)
586
587#define NORMAL_BUSY (0x100 + NORMAL) /* Normal mode, busy with a command */
588#define HITRETURN (0x200 + NORMAL) /* waiting for return or command */
589#define ASKMORE 0x300 /* Asking if you want --more-- */
590#define SETWSIZE 0x400 /* window size has changed */
591#define ABBREV 0x500 /* abbreviation instead of mapping */
592#define EXTERNCMD 0x600 /* executing an external command */
593#define SHOWMATCH (0x700 + INSERT) /* show matching paren */
594#define CONFIRM 0x800 /* ":confirm" prompt */
595
596/* directions */
597#define FORWARD 1
598#define BACKWARD (-1)
599#define FORWARD_FILE 3
600#define BACKWARD_FILE (-3)
601
602/* return values for functions */
603#if !(defined(OK) && (OK == 1))
604/* OK already defined to 1 in MacOS X curses, skip this */
605# define OK 1
606#endif
607#define FAIL 0
Bram Moolenaarfd371682005-01-14 21:42:54 +0000608#define NOTDONE 2 /* not OK or FAIL but skipped */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610/* flags for b_flags */
611#define BF_RECOVERED 0x01 /* buffer has been recovered */
612#define BF_CHECK_RO 0x02 /* need to check readonly when loading file
613 into buffer (set by ":e", may be reset by
614 ":buf" */
615#define BF_NEVERLOADED 0x04 /* file has never been loaded into buffer,
616 many variables still need to be set */
617#define BF_NOTEDITED 0x08 /* Set when file name is changed after
618 starting to edit, reset when file is
619 written out. */
620#define BF_NEW 0x10 /* file didn't exist when editing started */
621#define BF_NEW_W 0x20 /* Warned for BF_NEW and file created */
622#define BF_READERR 0x40 /* got errors while reading the file */
Bram Moolenaar81695252004-12-29 20:58:21 +0000623#define BF_DUMMY 0x80 /* dummy buffer, only used internally */
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000624#define BF_PRESERVED 0x100 /* ":preserve" was used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626/* Mask to check for flags that prevent normal writing */
627#define BF_WRITE_MASK (BF_NOTEDITED + BF_NEW + BF_READERR)
628
629/*
630 * values for xp_context when doing command line completion
631 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632#define EXPAND_UNSUCCESSFUL (-2)
633#define EXPAND_OK (-1)
634#define EXPAND_NOTHING 0
635#define EXPAND_COMMANDS 1
636#define EXPAND_FILES 2
637#define EXPAND_DIRECTORIES 3
638#define EXPAND_SETTINGS 4
639#define EXPAND_BOOL_SETTINGS 5
640#define EXPAND_TAGS 6
641#define EXPAND_OLD_SETTING 7
642#define EXPAND_HELP 8
643#define EXPAND_BUFFERS 9
644#define EXPAND_EVENTS 10
645#define EXPAND_MENUS 11
646#define EXPAND_SYNTAX 12
647#define EXPAND_HIGHLIGHT 13
648#define EXPAND_AUGROUP 14
649#define EXPAND_USER_VARS 15
650#define EXPAND_MAPPINGS 16
651#define EXPAND_TAGS_LISTFILES 17
652#define EXPAND_FUNCTIONS 18
653#define EXPAND_USER_FUNC 19
654#define EXPAND_EXPRESSION 20
655#define EXPAND_MENUNAMES 21
656#define EXPAND_USER_COMMANDS 22
657#define EXPAND_USER_CMD_FLAGS 23
658#define EXPAND_USER_NARGS 24
659#define EXPAND_USER_COMPLETE 25
660#define EXPAND_ENV_VARS 26
661#define EXPAND_LANGUAGE 27
662#define EXPAND_COLORS 28
663#define EXPAND_COMPILER 29
664#define EXPAND_USER_DEFINED 30
Bram Moolenaara466c992005-07-09 21:03:22 +0000665#define EXPAND_USER_LIST 31
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000666#define EXPAND_SHELLCMD 32
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
668/* Values for exmode_active (0 is no exmode) */
669#define EXMODE_NORMAL 1
670#define EXMODE_VIM 2
671
672/* Values for nextwild() and ExpandOne(). See ExpandOne() for meaning. */
673#define WILD_FREE 1
674#define WILD_EXPAND_FREE 2
675#define WILD_EXPAND_KEEP 3
676#define WILD_NEXT 4
677#define WILD_PREV 5
678#define WILD_ALL 6
679#define WILD_LONGEST 7
680
681#define WILD_LIST_NOTFOUND 1
682#define WILD_HOME_REPLACE 2
683#define WILD_USE_NL 4
684#define WILD_NO_BEEP 8
685#define WILD_ADD_SLASH 16
686#define WILD_KEEP_ALL 32
687#define WILD_SILENT 64
688#define WILD_ESCAPE 128
689
690/* Flags for expand_wildcards() */
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000691#define EW_DIR 0x01 /* include directory names */
692#define EW_FILE 0x02 /* include file names */
693#define EW_NOTFOUND 0x04 /* include not found names */
694#define EW_ADDSLASH 0x08 /* append slash to directory name */
695#define EW_KEEPALL 0x10 /* keep all matches */
696#define EW_SILENT 0x20 /* don't print "1 returned" from shell */
697#define EW_EXEC 0x40 /* executable files */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698/* Note: mostly EW_NOTFOUND and EW_SILENT are mutually exclusive: EW_NOTFOUND
699 * is used when executing commands and EW_SILENT for interactive expanding. */
700
701#ifdef FEAT_VERTSPLIT
702# define W_WINCOL(wp) (wp->w_wincol)
703# define W_WIDTH(wp) (wp->w_width)
704# define W_ENDCOL(wp) (wp->w_wincol + wp->w_width)
705# define W_VSEP_WIDTH(wp) (wp->w_vsep_width)
706#else
707# define W_WINCOL(wp) 0
708# define W_WIDTH(wp) Columns
709# define W_ENDCOL(wp) Columns
710# define W_VSEP_WIDTH(wp) 0
711#endif
712#ifdef FEAT_WINDOWS
713# define W_STATUS_HEIGHT(wp) (wp->w_status_height)
714# define W_WINROW(wp) (wp->w_winrow)
715#else
716# define W_STATUS_HEIGHT(wp) 0
717# define W_WINROW(wp) 0
718#endif
719
720#ifdef NO_EXPANDPATH
721# define gen_expand_wildcards mch_expand_wildcards
722#endif
723
724/* Values for the find_pattern_in_path() function args 'type' and 'action': */
725#define FIND_ANY 1
726#define FIND_DEFINE 2
727#define CHECK_PATH 3
728
729#define ACTION_SHOW 1
730#define ACTION_GOTO 2
731#define ACTION_SPLIT 3
732#define ACTION_SHOW_ALL 4
733#ifdef FEAT_INS_EXPAND
734# define ACTION_EXPAND 5
735#endif
736
737#ifdef FEAT_SYN_HL
738# define SST_MIN_ENTRIES 150 /* minimal size for state stack array */
739# ifdef FEAT_GUI_W16
740# define SST_MAX_ENTRIES 500 /* (only up to 64K blocks) */
741# else
742# define SST_MAX_ENTRIES 1000 /* maximal size for state stack array */
743# endif
744# define SST_FIX_STATES 7 /* size of sst_stack[]. */
745# define SST_DIST 16 /* normal distance between entries */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746#endif
747
748/* Values for 'options' argument in do_search() and searchit() */
749#define SEARCH_REV 0x01 /* go in reverse of previous dir. */
750#define SEARCH_ECHO 0x02 /* echo the search command and handle options */
751#define SEARCH_MSG 0x0c /* give messages (yes, it's not 0x04) */
752#define SEARCH_NFMSG 0x08 /* give all messages except not found */
753#define SEARCH_OPT 0x10 /* interpret optional flags */
754#define SEARCH_HIS 0x20 /* put search pattern in history */
755#define SEARCH_END 0x40 /* put cursor at end of match */
756#define SEARCH_NOOF 0x80 /* don't add offset to position */
757#define SEARCH_START 0x100 /* start search without col offset */
758#define SEARCH_MARK 0x200 /* set previous context mark */
759#define SEARCH_KEEP 0x400 /* keep previous search pattern */
760#define SEARCH_PEEK 0x800 /* peek for typed char, cancel search */
761
762/* Values for find_ident_under_cursor() */
763#define FIND_IDENT 1 /* find identifier (word) */
764#define FIND_STRING 2 /* find any string (WORD) */
765#define FIND_EVAL 4 /* include "->", "[]" and "." */
766
767/* Values for file_name_in_line() */
768#define FNAME_MESS 1 /* give error message */
769#define FNAME_EXP 2 /* expand to path */
770#define FNAME_HYP 4 /* check for hypertext link */
771#define FNAME_INCL 8 /* apply 'includeexpr' */
772#define FNAME_REL 16 /* ".." and "./" are relative to the (current)
773 file instead of the current directory */
774
775/* Values for buflist_getfile() */
776#define GETF_SETMARK 0x01 /* set pcmark before jumping */
777#define GETF_ALT 0x02 /* jumping to alternate file (not buf num) */
778#define GETF_SWITCH 0x04 /* respect 'switchbuf' settings when jumping */
779
780/* Values for buflist_new() flags */
781#define BLN_CURBUF 1 /* May re-use curbuf for new buffer */
782#define BLN_LISTED 2 /* Put new buffer in buffer list */
783#define BLN_DUMMY 4 /* Allocating dummy buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785/* Values for in_cinkeys() */
786#define KEY_OPEN_FORW 0x101
787#define KEY_OPEN_BACK 0x102
788#define KEY_COMPLETE 0x103 /* end of completion */
789
790/* Values for "noremap" argument of ins_typebuf(). Also used for
791 * map->m_noremap and menu->noremap[]. */
792#define REMAP_YES 0 /* allow remapping */
793#define REMAP_NONE -1 /* no remapping */
794#define REMAP_SCRIPT -2 /* remap script-local mappings only */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000795#define REMAP_SKIP -3 /* no remapping for first char */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796
797/* Values for mch_call_shell() second argument */
798#define SHELL_FILTER 1 /* filtering text */
799#define SHELL_EXPAND 2 /* expanding wildcards */
800#define SHELL_COOKED 4 /* set term to cooked mode */
801#define SHELL_DOOUT 8 /* redirecting output */
802#define SHELL_SILENT 16 /* don't print error returned by command */
Bram Moolenaardf177f62005-02-22 08:39:57 +0000803#define SHELL_READ 32 /* read lines and insert into buffer */
804#define SHELL_WRITE 64 /* write lines from buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806/* Values returned by mch_nodetype() */
807#define NODE_NORMAL 0 /* file or directory, check with mch_isdir()*/
808#define NODE_WRITABLE 1 /* something we can write to (character
809 device, fifo, socket, ..) */
810#define NODE_OTHER 2 /* non-writable thing (e.g., block device) */
811
812/* Values for readfile() flags */
813#define READ_NEW 0x01 /* read a file into a new buffer */
814#define READ_FILTER 0x02 /* read filter output */
815#define READ_STDIN 0x04 /* read from stdin */
816#define READ_BUFFER 0x08 /* read from curbuf (converting stdin) */
817#define READ_DUMMY 0x10 /* reading into a dummy buffer */
818
819/* Values for change_indent() */
820#define INDENT_SET 1 /* set indent */
821#define INDENT_INC 2 /* increase indent */
822#define INDENT_DEC 3 /* decrease indent */
823
824/* Values for flags argument for findmatchlimit() */
825#define FM_BACKWARD 0x01 /* search backwards */
826#define FM_FORWARD 0x02 /* search forwards */
827#define FM_BLOCKSTOP 0x04 /* stop at start/end of block */
828#define FM_SKIPCOMM 0x08 /* skip comments */
829
830/* Values for action argument for do_buffer() */
831#define DOBUF_GOTO 0 /* go to specified buffer */
832#define DOBUF_SPLIT 1 /* split window and go to specified buffer */
833#define DOBUF_UNLOAD 2 /* unload specified buffer(s) */
834#define DOBUF_DEL 3 /* delete specified buffer(s) from buflist */
835#define DOBUF_WIPE 4 /* delete specified buffer(s) really */
836
837/* Values for start argument for do_buffer() */
838#define DOBUF_CURRENT 0 /* "count" buffer from current buffer */
839#define DOBUF_FIRST 1 /* "count" buffer from first buffer */
840#define DOBUF_LAST 2 /* "count" buffer from last buffer */
841#define DOBUF_MOD 3 /* "count" mod. buffer from current buffer */
842
843/* Values for sub_cmd and which_pat argument for search_regcomp() */
844/* Also used for which_pat argument for searchit() */
845#define RE_SEARCH 0 /* save/use pat in/from search_pattern */
846#define RE_SUBST 1 /* save/use pat in/from subst_pattern */
847#define RE_BOTH 2 /* save pat in both patterns */
848#define RE_LAST 2 /* use last used pattern if "pat" is NULL */
849
850/* Second argument for vim_regcomp(). */
851#define RE_MAGIC 1 /* 'magic' option */
852#define RE_STRING 2 /* match in string instead of buffer text */
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000853#define RE_STRICT 4 /* don't allow [abc] without ] */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855#ifdef FEAT_SYN_HL
856/* values for reg_do_extmatch */
857# define REX_SET 1 /* to allow \z\(...\), */
858# define REX_USE 2 /* to allow \z\1 et al. */
859#endif
860
861/* Return values for fullpathcmp() */
862/* Note: can use (fullpathcmp() & FPC_SAME) to check for equal files */
863#define FPC_SAME 1 /* both exist and are the same file. */
864#define FPC_DIFF 2 /* both exist and are different files. */
865#define FPC_NOTX 4 /* both don't exist. */
866#define FPC_DIFFX 6 /* one of them doesn't exist. */
867#define FPC_SAMEX 7 /* both don't exist and file names are same. */
868
869/* flags for do_ecmd() */
870#define ECMD_HIDE 0x01 /* don't free the current buffer */
871#define ECMD_SET_HELP 0x02 /* set b_help flag of (new) buffer before
872 opening file */
873#define ECMD_OLDBUF 0x04 /* use existing buffer if it exists */
874#define ECMD_FORCEIT 0x08 /* ! used in Ex command */
875#define ECMD_ADDBUF 0x10 /* don't edit, just add to buffer list */
876
877/* for lnum argument in do_ecmd() */
878#define ECMD_LASTL (linenr_T)0 /* use last position in loaded file */
879#define ECMD_LAST (linenr_T)-1 /* use last position in all files */
880#define ECMD_ONE (linenr_T)1 /* use first line */
881
882/* flags for do_cmdline() */
883#define DOCMD_VERBOSE 0x01 /* included command in error message */
884#define DOCMD_NOWAIT 0x02 /* don't call wait_return() and friends */
885#define DOCMD_REPEAT 0x04 /* repeat exec. until getline() returns NULL */
886#define DOCMD_KEYTYPED 0x08 /* don't reset KeyTyped */
887#define DOCMD_EXCRESET 0x10 /* reset exception environment (for debugging)*/
888#define DOCMD_KEEPLINE 0x20 /* keep typed line for repeating with "." */
889
890/* flags for beginline() */
891#define BL_WHITE 1 /* cursor on first non-white in the line */
892#define BL_SOL 2 /* use 'sol' option */
893#define BL_FIX 4 /* don't leave cursor on a NUL */
894
895/* flags for mf_sync() */
896#define MFS_ALL 1 /* also sync blocks with negative numbers */
897#define MFS_STOP 2 /* stop syncing when a character is available */
898#define MFS_FLUSH 4 /* flushed file to disk */
899#define MFS_ZERO 8 /* only write block 0 */
900
901/* flags for buf_copy_options() */
902#define BCO_ENTER 1 /* going to enter the buffer */
903#define BCO_ALWAYS 2 /* always copy the options */
904#define BCO_NOHELP 4 /* don't touch the help related options */
905
906/* flags for do_put() */
907#define PUT_FIXINDENT 1 /* make indent look nice */
908#define PUT_CURSEND 2 /* leave cursor after end of new text */
Bram Moolenaardf177f62005-02-22 08:39:57 +0000909#define PUT_CURSLINE 4 /* leave cursor on last line of new text */
910#define PUT_LINE 8 /* put register as lines */
911#define PUT_LINE_SPLIT 16 /* split line for linewise register */
912#define PUT_LINE_FORWARD 32 /* put linewise register below Visual sel. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913
914/* flags for set_indent() */
915#define SIN_CHANGED 1 /* call changed_bytes() when line changed */
916#define SIN_INSERT 2 /* insert indent before existing text */
917#define SIN_UNDO 4 /* save line for undo before changing it */
918
919/* flags for insertchar() */
920#define INSCHAR_FORMAT 1 /* force formatting */
921#define INSCHAR_DO_COM 2 /* format comments */
922#define INSCHAR_CTRLV 4 /* char typed just after CTRL-V */
923
924/* flags for open_line() */
925#define OPENLINE_DELSPACES 1 /* delete spaces after cursor */
926#define OPENLINE_DO_COM 2 /* format comments */
927#define OPENLINE_KEEPTRAIL 4 /* keep trailing spaces */
928#define OPENLINE_MARKFIX 8 /* fix mark positions */
929
930/*
931 * There are four history tables:
932 */
933#define HIST_CMD 0 /* colon commands */
934#define HIST_SEARCH 1 /* search commands */
935#define HIST_EXPR 2 /* expressions (from entering = register) */
936#define HIST_INPUT 3 /* input() lines */
937#define HIST_DEBUG 4 /* debug commands */
938#define HIST_COUNT 5 /* number of history tables */
939
940/*
941 * Flags for chartab[].
942 */
943#define CT_CELL_MASK 0x07 /* mask: nr of display cells (1, 2 or 4) */
944#define CT_PRINT_CHAR 0x10 /* flag: set for printable chars */
945#define CT_ID_CHAR 0x20 /* flag: set for ID chars */
946#define CT_FNAME_CHAR 0x40 /* flag: set for file name chars */
947
948/*
949 * Values for do_tag().
950 */
951#define DT_TAG 1 /* jump to newer position or same tag again */
952#define DT_POP 2 /* jump to older position */
953#define DT_NEXT 3 /* jump to next match of same tag */
954#define DT_PREV 4 /* jump to previous match of same tag */
955#define DT_FIRST 5 /* jump to first match of same tag */
956#define DT_LAST 6 /* jump to first match of same tag */
957#define DT_SELECT 7 /* jump to selection from list */
958#define DT_HELP 8 /* like DT_TAG, but no wildcards */
959#define DT_JUMP 9 /* jump to new tag or selection from list */
960#define DT_CSCOPE 10 /* cscope find command (like tjump) */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000961#define DT_LTAG 11 /* tag using location list */
Bram Moolenaarea408852005-06-25 22:49:46 +0000962#define DT_FREE 99 /* free cached matches */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964/*
965 * flags for find_tags().
966 */
967#define TAG_HELP 1 /* only search for help tags */
968#define TAG_NAMES 2 /* only return name of tag */
969#define TAG_REGEXP 4 /* use tag pattern as regexp */
970#define TAG_NOIC 8 /* don't always ignore case */
971#ifdef FEAT_CSCOPE
972# define TAG_CSCOPE 16 /* cscope tag */
973#endif
974#define TAG_VERBOSE 32 /* message verbosity */
975#define TAG_INS_COMP 64 /* Currently doing insert completion */
976#define TAG_KEEP_LANG 128 /* keep current language */
977
978#define TAG_MANY 200 /* When finding many tags (for completion),
979 find up to this many tags */
980
981/*
982 * Types of dialogs passed to do_vim_dialog().
983 */
984#define VIM_GENERIC 0
985#define VIM_ERROR 1
986#define VIM_WARNING 2
987#define VIM_INFO 3
988#define VIM_QUESTION 4
989#define VIM_LAST_TYPE 4 /* sentinel value */
990
991/*
992 * Return values for functions like gui_yesnocancel()
993 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994#define VIM_YES 2
995#define VIM_NO 3
996#define VIM_CANCEL 4
997#define VIM_ALL 5
998#define VIM_DISCARDALL 6
999
1000/*
1001 * arguments for win_split()
1002 */
1003#define WSP_ROOM 1 /* require enough room */
1004#define WSP_VERT 2 /* split vertically */
1005#define WSP_TOP 4 /* window at top-left of shell */
1006#define WSP_BOT 8 /* window at bottom-right of shell */
1007#define WSP_HELP 16 /* creating the help window */
1008#define WSP_BELOW 32 /* put new window below/right */
1009#define WSP_ABOVE 64 /* put new window above/left */
1010
1011/*
1012 * "flags" values for option-setting functions.
1013 * When OPT_GLOBAL and OPT_LOCAL are both missing, set both local and global
1014 * values, get local value.
1015 */
1016#define OPT_FREE 1 /* free old value if it was allocated */
1017#define OPT_GLOBAL 2 /* use global value */
1018#define OPT_LOCAL 4 /* use local value */
1019#define OPT_MODELINE 8 /* option in modeline */
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00001020#define OPT_WINONLY 16 /* only set window-local options */
Bram Moolenaara3227e22006-03-08 21:32:40 +00001021#define OPT_NOWIN 32 /* don't set window-local options */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022
1023/* Magic chars used in confirm dialog strings */
1024#define DLG_BUTTON_SEP '\n'
1025#define DLG_HOTKEY_CHAR '&'
1026
1027/* Values for "starting" */
1028#define NO_SCREEN 2 /* no screen updating yet */
1029#define NO_BUFFERS 1 /* not all buffers loaded yet */
1030/* 0 not starting anymore */
1031
1032/* Values for swap_exists_action: what to do when swap file already exists */
1033#define SEA_NONE 0 /* don't use dialog */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001034#define SEA_DIALOG 1 /* use dialog when possible */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035#define SEA_QUIT 2 /* quit editing the file */
1036#define SEA_RECOVER 3 /* recover the file */
1037
1038/*
1039 * Minimal size for block 0 of a swap file.
1040 * NOTE: This depends on size of struct block0! It's not done with a sizeof(),
1041 * because struct block0 is defined in memline.c (Sorry).
1042 * The maximal block size is arbitrary.
1043 */
1044#define MIN_SWAP_PAGE_SIZE 1048
1045#define MAX_SWAP_PAGE_SIZE 50000
1046
1047/* Special values for current_SID. */
1048#define SID_MODELINE -1 /* when using a modeline */
1049#define SID_CMDARG -2 /* for "--cmd" argument */
1050#define SID_CARG -3 /* for "-c" argument */
1051#define SID_ENV -4 /* for sourcing environment variable */
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001052#define SID_ERROR -5 /* option was reset because of an error */
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001053#define SID_NONE -6 /* don't set scriptID */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054
1055/*
1056 * Events for autocommands.
1057 */
1058enum auto_event
1059{
1060 EVENT_BUFADD = 0, /* after adding a buffer to the buffer list */
1061 EVENT_BUFNEW, /* after creating any buffer */
1062 EVENT_BUFDELETE, /* deleting a buffer from the buffer list */
1063 EVENT_BUFWIPEOUT, /* just before really deleting a buffer */
1064 EVENT_BUFENTER, /* after entering a buffer */
1065 EVENT_BUFFILEPOST, /* after renaming a buffer */
1066 EVENT_BUFFILEPRE, /* before renaming a buffer */
1067 EVENT_BUFLEAVE, /* before leaving a buffer */
1068 EVENT_BUFNEWFILE, /* when creating a buffer for a new file */
1069 EVENT_BUFREADPOST, /* after reading a buffer */
1070 EVENT_BUFREADPRE, /* before reading a buffer */
1071 EVENT_BUFREADCMD, /* read buffer using command */
1072 EVENT_BUFUNLOAD, /* just before unloading a buffer */
1073 EVENT_BUFHIDDEN, /* just after buffer becomes hidden */
1074 EVENT_BUFWINENTER, /* after showing a buffer in a window */
1075 EVENT_BUFWINLEAVE, /* just after buffer removed from window */
1076 EVENT_BUFWRITEPOST, /* after writing a buffer */
1077 EVENT_BUFWRITEPRE, /* before writing a buffer */
1078 EVENT_BUFWRITECMD, /* write buffer using command */
1079 EVENT_CMDWINENTER, /* after entering the cmdline window */
1080 EVENT_CMDWINLEAVE, /* before leaving the cmdline window */
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001081 EVENT_COLORSCHEME, /* after loading a colorscheme */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 EVENT_FILEAPPENDPOST, /* after appending to a file */
1083 EVENT_FILEAPPENDPRE, /* before appending to a file */
1084 EVENT_FILEAPPENDCMD, /* appende to a file using command */
1085 EVENT_FILECHANGEDSHELL, /* after shell command that changed file */
1086 EVENT_FILECHANGEDRO, /* before first change to read-only file */
1087 EVENT_FILEREADPOST, /* after reading a file */
1088 EVENT_FILEREADPRE, /* before reading a file */
1089 EVENT_FILEREADCMD, /* read from a file using command */
1090 EVENT_FILETYPE, /* new file type detected (user defined) */
1091 EVENT_FILEWRITEPOST, /* after writing a file */
1092 EVENT_FILEWRITEPRE, /* before writing a file */
1093 EVENT_FILEWRITECMD, /* write to a file using command */
1094 EVENT_FILTERREADPOST, /* after reading from a filter */
1095 EVENT_FILTERREADPRE, /* before reading from a filter */
1096 EVENT_FILTERWRITEPOST, /* after writing to a filter */
1097 EVENT_FILTERWRITEPRE, /* before writing to a filter */
1098 EVENT_FOCUSGAINED, /* got the focus */
1099 EVENT_FOCUSLOST, /* lost the focus to another app */
1100 EVENT_GUIENTER, /* after starting the GUI */
Bram Moolenaar843ee412004-06-30 16:16:41 +00001101 EVENT_INSERTCHANGE, /* when changing Insert/Replace mode */
1102 EVENT_INSERTENTER, /* when entering Insert mode */
1103 EVENT_INSERTLEAVE, /* when leaving Insert mode */
Bram Moolenaara3ffd9c2005-07-21 21:03:15 +00001104 EVENT_MENUPOPUP, /* just before popup menu is displayed */
Bram Moolenaar7c626922005-02-07 22:01:03 +00001105 EVENT_QUICKFIXCMDPOST, /* after :make, :grep etc */
1106 EVENT_QUICKFIXCMDPRE, /* before :make, :grep etc */
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00001107 EVENT_SESSIONLOADPOST, /* after loading a session file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 EVENT_STDINREADPOST, /* after reading from stdin */
1109 EVENT_STDINREADPRE, /* before reading from stdin */
1110 EVENT_SYNTAX, /* syntax selected */
1111 EVENT_TERMCHANGED, /* after changing 'term' */
1112 EVENT_TERMRESPONSE, /* after setting "v:termresponse" */
1113 EVENT_USER, /* user defined autocommand */
1114 EVENT_VIMENTER, /* after starting Vim */
1115 EVENT_VIMLEAVE, /* before exiting Vim */
1116 EVENT_VIMLEAVEPRE, /* before exiting Vim and writing .viminfo */
1117 EVENT_WINENTER, /* after entering a window */
1118 EVENT_WINLEAVE, /* before leaving a window */
1119 EVENT_ENCODINGCHANGED, /* after changing the 'encoding' option */
1120 EVENT_CURSORHOLD, /* cursor in same position for a while */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001121 EVENT_CURSORHOLDI, /* idem, in Insert mode */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 EVENT_FUNCUNDEFINED, /* if calling a function which doesn't exist */
1123 EVENT_REMOTEREPLY, /* upon string reception from a remote vim */
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001124 EVENT_SWAPEXISTS, /* found existing swap file */
Bram Moolenaara2031822006-03-07 22:29:51 +00001125 EVENT_SOURCEPRE, /* before sourcing a Vim script */
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001126 EVENT_SPELLFILEMISSING, /* spell file missing */
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001127 EVENT_CURSORMOVED, /* cursor was moved */
1128 EVENT_CURSORMOVEDI, /* cursor was moved in Insert mode */
Bram Moolenaar2a0449d2006-02-20 21:27:21 +00001129 EVENT_TABLEAVE, /* before leaving a tab page */
1130 EVENT_TABENTER, /* after entering a tab page */
Bram Moolenaar4e427192006-03-10 21:34:27 +00001131 EVENT_SHELLCMDPOST, /* after ":!cmd" */
1132 EVENT_SHELLFILTERPOST, /* after ":1,2!cmd", ":w !cmd", ":r !cmd". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 NUM_EVENTS /* MUST be the last one */
1134};
1135
Bram Moolenaarcf0c5542006-02-09 23:48:02 +00001136typedef enum auto_event event_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137
1138/*
1139 * Values for index in highlight_attr[].
1140 * When making changes, also update HL_FLAGS below! And update the default
1141 * value of 'highlight' in option.c.
1142 */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001143typedef enum
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144{
1145 HLF_8 = 0 /* Meta & special keys listed with ":map", text that is
1146 displayed different from what it is */
1147 , HLF_AT /* @ and ~ characters at end of screen, characters that
1148 don't really exist in the text */
1149 , HLF_D /* directories in CTRL-D listing */
1150 , HLF_E /* error messages */
1151 , HLF_H /* obsolete, ignored */
1152 , HLF_I /* incremental search */
1153 , HLF_L /* last search string */
1154 , HLF_M /* "--More--" message */
1155 , HLF_CM /* Mode (e.g., "-- INSERT --") */
1156 , HLF_N /* line number for ":number" and ":#" commands */
1157 , HLF_R /* return to continue message and yes/no questions */
1158 , HLF_S /* status lines */
1159 , HLF_SNC /* status lines of not-current windows */
1160 , HLF_C /* column to separate vertically split windows */
1161 , HLF_T /* Titles for output from ":set all", ":autocmd" etc. */
1162 , HLF_V /* Visual mode */
1163 , HLF_VNC /* Visual mode, autoselecting and not clipboard owner */
1164 , HLF_W /* warning messages */
1165 , HLF_WM /* Wildmenu highlight */
1166 , HLF_FL /* Folded line */
1167 , HLF_FC /* Fold column */
1168 , HLF_ADD /* Added diff line */
1169 , HLF_CHD /* Changed diff line */
1170 , HLF_DED /* Deleted diff line */
1171 , HLF_TXD /* Text Changed in diff line */
1172 , HLF_SC /* Sign column */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001173 , HLF_SPB /* SpellBad */
Bram Moolenaarf9184a12005-07-02 23:10:47 +00001174 , HLF_SPC /* SpellCap */
Bram Moolenaar2e4096b2005-03-20 22:25:45 +00001175 , HLF_SPR /* SpellRare */
1176 , HLF_SPL /* SpellLocal */
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001177 , HLF_PNI /* popup menu normal item */
1178 , HLF_PSI /* popup menu selected item */
1179 , HLF_PSB /* popup menu scrollbar */
1180 , HLF_PST /* popup menu scrollbar thumb */
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001181 , HLF_TP /* tabpage line */
1182 , HLF_TPS /* tabpage line selected */
1183 , HLF_TPF /* tabpage line filler */
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001184 , HLF_CUC /* 'cursurcolumn' */
1185 , HLF_CUL /* 'cursurline' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 , HLF_COUNT /* MUST be the last one */
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00001187} hlf_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001189/* The HL_FLAGS must be in the same order as the HLF_ enums!
1190 * When chainging this also adjust the default for 'highlight'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191#define HL_FLAGS {'8', '@', 'd', 'e', 'h', 'i', 'l', 'm', 'M', \
1192 'n', 'r', 's', 'S', 'c', 't', 'v', 'V', 'w', 'W', \
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001193 'f', 'F', 'A', 'C', 'D', 'T', '>', \
1194 'B', 'P', 'R', 'L', \
Bram Moolenaarf71a3db2006-03-12 21:50:18 +00001195 '+', '=', 'x', 'X', '*', '#', '_', '!', '.'}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196
1197/*
1198 * Boolean constants
1199 */
1200#ifndef TRUE
1201# define FALSE 0 /* note: this is an int, not a long! */
1202# define TRUE 1
1203#endif
1204
1205#define MAYBE 2 /* sometimes used for a variant on TRUE */
1206
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207/*
1208 * Operator IDs; The order must correspond to opchars[] in ops.c!
1209 */
1210#define OP_NOP 0 /* no pending operation */
1211#define OP_DELETE 1 /* "d" delete operator */
1212#define OP_YANK 2 /* "y" yank operator */
1213#define OP_CHANGE 3 /* "c" change operator */
1214#define OP_LSHIFT 4 /* "<" left shift operator */
1215#define OP_RSHIFT 5 /* ">" right shift operator */
1216#define OP_FILTER 6 /* "!" filter operator */
1217#define OP_TILDE 7 /* "g~" switch case operator */
1218#define OP_INDENT 8 /* "=" indent operator */
1219#define OP_FORMAT 9 /* "gq" format operator */
1220#define OP_COLON 10 /* ":" colon operator */
1221#define OP_UPPER 11 /* "gU" make upper case operator */
1222#define OP_LOWER 12 /* "gu" make lower case operator */
1223#define OP_JOIN 13 /* "J" join operator, only for Visual mode */
1224#define OP_JOIN_NS 14 /* "gJ" join operator, only for Visual mode */
1225#define OP_ROT13 15 /* "g?" rot-13 encoding */
1226#define OP_REPLACE 16 /* "r" replace chars, only for Visual mode */
1227#define OP_INSERT 17 /* "I" Insert column, only for Visual mode */
1228#define OP_APPEND 18 /* "A" Append column, only for Visual mode */
1229#define OP_FOLD 19 /* "zf" define a fold */
1230#define OP_FOLDOPEN 20 /* "zo" open folds */
1231#define OP_FOLDOPENREC 21 /* "zO" open folds recursively */
1232#define OP_FOLDCLOSE 22 /* "zc" close folds */
1233#define OP_FOLDCLOSEREC 23 /* "zC" close folds recursively */
1234#define OP_FOLDDEL 24 /* "zd" delete folds */
1235#define OP_FOLDDELREC 25 /* "zD" delete folds recursively */
1236#define OP_FORMAT2 26 /* "gw" format operator, keeps cursor pos */
Bram Moolenaar12033fb2005-12-16 21:49:31 +00001237#define OP_FUNCTION 27 /* "g@" call 'operatorfunc' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
1239/*
1240 * Motion types, used for operators and for yank/delete registers.
1241 */
1242#define MCHAR 0 /* character-wise movement/register */
1243#define MLINE 1 /* line-wise movement/register */
1244#define MBLOCK 2 /* block-wise register */
1245
1246#define MAUTO 0xff /* Decide between MLINE/MCHAR */
1247
1248/*
1249 * Minimum screen size
1250 */
1251#define MIN_COLUMNS 12 /* minimal columns for screen */
1252#define MIN_LINES 2 /* minimal lines for screen */
1253#define STATUS_HEIGHT 1 /* height of a status line under a window */
1254#define QF_WINHEIGHT 10 /* default height for quickfix window */
1255
1256/*
1257 * Buffer sizes
1258 */
1259#ifndef CMDBUFFSIZE
1260# define CMDBUFFSIZE 256 /* size of the command processing buffer */
1261#endif
1262
1263#define LSIZE 512 /* max. size of a line in the tags file */
1264
1265#define IOSIZE (1024+1) /* file i/o and sprintf buffer size */
Bram Moolenaard9d30582005-05-18 22:10:28 +00001266
1267#ifdef FEAT_MBYTE
1268# define MSG_BUF_LEN 480 /* length of buffer for small messages */
1269# define MSG_BUF_CLEN (MSG_BUF_LEN / 6) /* cell length (worst case: utf-8
1270 takes 6 bytes for one cell) */
1271#else
1272# define MSG_BUF_LEN 80 /* length of buffer for small messages */
1273# define MSG_BUF_CLEN MSG_BUF_LEN /* cell length */
1274#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275
1276#if defined(AMIGA) || defined(__linux__) || defined(__QNX__) || defined(__CYGWIN32__) || defined(_AIX)
1277# define TBUFSZ 2048 /* buffer size for termcap entry */
1278#else
1279# define TBUFSZ 1024 /* buffer size for termcap entry */
1280#endif
1281
1282/*
1283 * Maximum length of key sequence to be mapped.
1284 * Must be able to hold an Amiga resize report.
1285 */
1286#define MAXMAPLEN 50
1287
1288#ifdef BINARY_FILE_IO
1289# define WRITEBIN "wb" /* no CR-LF translation */
1290# define READBIN "rb"
1291# define APPENDBIN "ab"
1292#else
1293# define WRITEBIN "w"
1294# define READBIN "r"
1295# define APPENDBIN "a"
1296#endif
1297
1298/*
1299 * EMX doesn't have a global way of making open() use binary I/O.
1300 * Use O_BINARY for all open() calls.
1301 */
1302#if defined(__EMX__) || defined(__CYGWIN32__)
1303# define O_EXTRA O_BINARY
1304#else
1305# define O_EXTRA 0
1306#endif
1307
Bram Moolenaara5792f52005-11-23 21:25:05 +00001308#ifndef O_NOFOLLOW
1309# define O_NOFOLLOW 0
1310#endif
1311
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312#ifndef W_OK
1313# define W_OK 2 /* for systems that don't have W_OK in unistd.h */
1314#endif
1315#ifndef R_OK
1316# define R_OK 4 /* for systems that don't have R_OK in unistd.h */
1317#endif
1318
1319/*
1320 * defines to avoid typecasts from (char_u *) to (char *) and back
1321 * (vim_strchr() and vim_strrchr() are now in alloc.c)
1322 */
1323#define STRLEN(s) strlen((char *)(s))
1324#define STRCPY(d, s) strcpy((char *)(d), (char *)(s))
1325#define STRNCPY(d, s, n) strncpy((char *)(d), (char *)(s), (size_t)(n))
1326#define STRCMP(d, s) strcmp((char *)(d), (char *)(s))
1327#define STRNCMP(d, s, n) strncmp((char *)(d), (char *)(s), (size_t)(n))
1328#ifdef HAVE_STRCASECMP
1329# define STRICMP(d, s) strcasecmp((char *)(d), (char *)(s))
1330#else
1331# ifdef HAVE_STRICMP
1332# define STRICMP(d, s) stricmp((char *)(d), (char *)(s))
1333# else
1334# define STRICMP(d, s) vim_stricmp((char *)(d), (char *)(s))
1335# endif
1336#endif
1337
1338#ifdef HAVE_STRNCASECMP
1339# define STRNICMP(d, s, n) strncasecmp((char *)(d), (char *)(s), (size_t)(n))
1340#else
1341# ifdef HAVE_STRNICMP
1342# define STRNICMP(d, s, n) strnicmp((char *)(d), (char *)(s), (size_t)(n))
1343# else
1344# define STRNICMP(d, s, n) vim_strnicmp((char *)(d), (char *)(s), (size_t)(n))
1345# endif
1346#endif
1347
1348#ifdef FEAT_MBYTE
1349# define MB_STRICMP(d, s) (has_mbyte ? mb_strnicmp((char_u *)(d), (char_u *)(s), (int)MAXCOL) : STRICMP((d), (s)))
1350# define MB_STRNICMP(d, s, n) (has_mbyte ? mb_strnicmp((char_u *)(d), (char_u *)(s), (int)(n)) : STRNICMP((d), (s), (n)))
1351#else
1352# define MB_STRICMP(d, s) STRICMP((d), (s))
1353# define MB_STRNICMP(d, s, n) STRNICMP((d), (s), (n))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354#endif
1355
1356#define STRCAT(d, s) strcat((char *)(d), (char *)(s))
1357#define STRNCAT(d, s, n) strncat((char *)(d), (char *)(s), (size_t)(n))
1358
1359#ifdef HAVE_STRPBRK
1360# define vim_strpbrk(s, cs) (char_u *)strpbrk((char *)(s), (char *)(cs))
1361#endif
1362
1363#define MSG(s) msg((char_u *)(s))
1364#define MSG_ATTR(s, attr) msg_attr((char_u *)(s), (attr))
1365#define EMSG(s) emsg((char_u *)(s))
1366#define EMSG2(s, p) emsg2((char_u *)(s), (char_u *)(p))
1367#define EMSG3(s, p, q) emsg3((char_u *)(s), (char_u *)(p), (char_u *)(q))
1368#define EMSGN(s, n) emsgn((char_u *)(s), (long)(n))
1369#define OUT_STR(s) out_str((char_u *)(s))
1370#define OUT_STR_NF(s) out_str_nf((char_u *)(s))
1371#define MSG_PUTS(s) msg_puts((char_u *)(s))
1372#define MSG_PUTS_ATTR(s, a) msg_puts_attr((char_u *)(s), (a))
1373#define MSG_PUTS_TITLE(s) msg_puts_title((char_u *)(s))
Bram Moolenaar1d73c882005-06-19 22:48:47 +00001374#define MSG_PUTS_LONG(s) msg_puts_long_attr((char_u *)(s), 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375#define MSG_PUTS_LONG_ATTR(s, a) msg_puts_long_attr((char_u *)(s), (a))
1376
1377/* Prefer using emsg3(), because perror() may send the output to the wrong
1378 * destination and mess up the screen. */
1379#ifdef HAVE_STRERROR
1380# define PERROR(msg) (void)emsg3((char_u *)"%s: %s", (char_u *)msg, (char_u *)strerror(errno))
1381#else
1382# define PERROR(msg) perror(msg)
1383#endif
1384
1385typedef long linenr_T; /* line number type */
1386typedef unsigned colnr_T; /* column number type */
1387typedef unsigned short disptick_T; /* display tick type */
1388
1389#define MAXLNUM (0x7fffffffL) /* maximum (invalid) line number */
1390
1391/*
1392 * Well, you won't believe it, but some S/390 machines ("host", now also known
1393 * as zServer) us 31 bit pointers. There are also some newer machines, that
1394 * use 64 bit pointers. I don't know how to distinguish between 31 and 64 bit
1395 * machines, so the best way is to assume 31 bits whenever we detect OS/390
1396 * Unix.
1397 * With this we restrict the maximum line length to 1073741823. I guess this is
1398 * not a real problem. BTW: Longer lines are split.
1399 */
1400#if SIZEOF_INT >= 4
1401# ifdef __MVS__
1402# define MAXCOL (0x3fffffffL) /* maximum column number, 30 bits */
1403# else
1404# define MAXCOL (0x7fffffffL) /* maximum column number, 31 bits */
1405# endif
1406#else
1407# define MAXCOL (0x7fff) /* maximum column number, 15 bits */
1408#endif
1409
1410#define SHOWCMD_COLS 10 /* columns needed by shown command */
1411#define STL_MAX_ITEM 80 /* max nr of %<flag> in statusline */
1412
1413typedef void *vim_acl_T; /* dummy to pass an ACL to a function */
1414
1415/*
1416 * Include a prototype for mch_memmove(), it may not be in alloc.pro.
1417 */
1418#ifdef VIM_MEMMOVE
1419void mch_memmove __ARGS((void *, void *, size_t));
1420#else
1421# ifndef mch_memmove
1422# define mch_memmove(to, from, len) memmove(to, from, len)
1423# endif
1424#endif
1425
1426/*
1427 * fnamecmp() is used to compare file names.
1428 * On some systems case in a file name does not matter, on others it does.
1429 * (this does not account for maximum name lengths and things like "../dir",
1430 * thus it is not 100% accurate!)
1431 */
1432#ifdef CASE_INSENSITIVE_FILENAME
1433# ifdef BACKSLASH_IN_FILENAME
1434# define fnamecmp(x, y) vim_fnamecmp((x), (y))
1435# define fnamencmp(x, y, n) vim_fnamencmp((x), (y), (size_t)(n))
1436# else
1437# define fnamecmp(x, y) MB_STRICMP((x), (y))
1438# define fnamencmp(x, y, n) MB_STRNICMP((x), (y), (n))
1439# endif
1440#else
1441# define fnamecmp(x, y) strcmp((char *)(x), (char *)(y))
1442# define fnamencmp(x, y, n) strncmp((char *)(x), (char *)(y), (size_t)(n))
1443#endif
1444
1445#ifdef HAVE_MEMSET
1446# define vim_memset(ptr, c, size) memset((ptr), (c), (size))
1447#else
1448void *vim_memset __ARGS((void *, int, size_t));
1449#endif
1450
1451#ifdef HAVE_MEMCMP
1452# define vim_memcmp(p1, p2, len) memcmp((p1), (p2), (len))
1453#else
1454# ifdef HAVE_BCMP
1455# define vim_memcmp(p1, p2, len) bcmp((p1), (p2), (len))
1456# else
1457int vim_memcmp __ARGS((void *, void *, size_t));
1458# define VIM_MEMCMP
1459# endif
1460#endif
1461
1462#if defined(UNIX) || defined(FEAT_GUI) || defined(OS2) || defined(VMS) \
1463 || defined(FEAT_CLIENTSERVER)
1464# define USE_INPUT_BUF
1465#endif
1466
1467#ifdef MSWIN
1468/* On MS-Windows the third argument isn't size_t. This matters for Win64,
1469 * where sizeof(size_t)==8, not 4 */
1470# define vim_read(fd, buf, count) read((fd), (char *)(buf), (unsigned int)(count))
1471# define vim_write(fd, buf, count) write((fd), (char *)(buf), (unsigned int)(count))
1472#else
1473# define vim_read(fd, buf, count) read((fd), (char *)(buf), (size_t) (count))
1474# define vim_write(fd, buf, count) write((fd), (char *)(buf), (size_t) (count))
1475#endif
1476
1477/*
1478 * Enums need a typecast to be used as array index (for Ultrix).
1479 */
1480#define hl_attr(n) highlight_attr[(int)(n)]
1481#define term_str(n) term_strings[(int)(n)]
1482
1483/*
1484 * vim_iswhite() is used for "^" and the like. It differs from isspace()
1485 * because it doesn't include <CR> and <LF> and the like.
1486 */
1487#define vim_iswhite(x) ((x) == ' ' || (x) == '\t')
1488
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001489/*
1490 * EXTERN is only defined in main.c. That's where global variables are
1491 * actually defined and initialized.
1492 */
1493#ifndef EXTERN
1494# define EXTERN extern
1495# define INIT(x)
1496#else
1497# ifndef INIT
1498# define INIT(x) x
1499# define DO_INIT
1500# endif
1501#endif
1502
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001503#ifdef FEAT_MBYTE
1504# define MAX_MCO 6 /* maximum value for 'maxcombine' */
1505
1506/* Maximum number of bytes in a multi-byte character. It can be one 32-bit
1507 * character of up to 6 bytes, or one 16-bit character of up to three bytes
1508 * plus six following composing characters of three bytes each. */
1509# define MB_MAXBYTES 21
1510#endif
1511
Bram Moolenaara226a6d2006-02-26 23:59:20 +00001512/* Include option.h before structs.h, because the number of window-local and
1513 * buffer-local options is used there. */
1514#include "option.h" /* options and default values */
1515
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516/* Note that gui.h is included by structs.h */
1517
1518#include "structs.h" /* file that defines many structures */
1519
1520#ifdef FEAT_MOUSE
1521
1522/* Codes for mouse button events in lower three bits: */
1523# define MOUSE_LEFT 0x00
1524# define MOUSE_MIDDLE 0x01
1525# define MOUSE_RIGHT 0x02
1526# define MOUSE_RELEASE 0x03
1527
1528/* bit masks for modifiers: */
1529# define MOUSE_SHIFT 0x04
1530# define MOUSE_ALT 0x08
1531# define MOUSE_CTRL 0x10
1532
1533/* mouse buttons that are handled like a key press (GUI only) */
1534# define MOUSE_4 0x100 /* scroll wheel down */
1535# define MOUSE_5 0x200 /* scroll wheel up */
1536
1537# define MOUSE_X1 0x300 /* Mouse-button X1 (6th) */
1538# define MOUSE_X2 0x400 /* Mouse-button X2 */
1539
1540/* 0x20 is reserved by xterm */
1541# define MOUSE_DRAG_XTERM 0x40
1542
1543# define MOUSE_DRAG (0x40 | MOUSE_RELEASE)
1544
1545/* Lowest button code for using the mouse wheel (xterm only) */
1546# define MOUSEWHEEL_LOW 0x60
1547
1548# define MOUSE_CLICK_MASK 0x03
1549
1550# define NUM_MOUSE_CLICKS(code) \
1551 (((unsigned)((code) & 0xC0) >> 6) + 1)
1552
1553# define SET_NUM_MOUSE_CLICKS(code, num) \
1554 (code) = ((code) & 0x3f) | ((((num) - 1) & 3) << 6)
1555
Bram Moolenaar6f3058f2005-04-24 21:58:05 +00001556/* Added to mouse column for GUI when 'mousefocus' wants to give focus to a
1557 * window by simulating a click on its status line. We could use up to 128 *
1558 * 128 = 16384 columns, now it's reduced to 10000. */
1559# define MOUSE_COLOFF 10000
1560
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561/*
1562 * jump_to_mouse() returns one of first four these values, possibly with
1563 * some of the other three added.
1564 */
1565# define IN_UNKNOWN 0
1566# define IN_BUFFER 1
1567# define IN_STATUS_LINE 2 /* on status or command line */
1568# define IN_SEP_LINE 4 /* on vertical separator line */
1569# define IN_OTHER_WIN 8 /* in other window but can't go there */
1570# define CURSOR_MOVED 0x100
1571# define MOUSE_FOLD_CLOSE 0x200 /* clicked on '-' in fold column */
1572# define MOUSE_FOLD_OPEN 0x400 /* clicked on '+' in fold column */
1573
1574/* flags for jump_to_mouse() */
1575# define MOUSE_FOCUS 0x01 /* need to stay in this window */
1576# define MOUSE_MAY_VIS 0x02 /* may start Visual mode */
1577# define MOUSE_DID_MOVE 0x04 /* only act when mouse has moved */
1578# define MOUSE_SETPOS 0x08 /* only set current mouse position */
1579# define MOUSE_MAY_STOP_VIS 0x10 /* may stop Visual mode */
1580# define MOUSE_RELEASED 0x20 /* button was released */
1581
1582# if defined(UNIX) && defined(HAVE_GETTIMEOFDAY) && defined(HAVE_SYS_TIME_H)
1583# define CHECK_DOUBLE_CLICK 1 /* Checking for double clicks ourselves. */
1584# endif
1585
1586#endif /* FEAT_MOUSE */
1587
1588/* defines for eval_vars() */
1589#define VALID_PATH 1
1590#define VALID_HEAD 2
1591
1592/* Defines for Vim variables. These must match vimvars[] in eval.c! */
1593#define VV_COUNT 0
1594#define VV_COUNT1 1
1595#define VV_PREVCOUNT 2
1596#define VV_ERRMSG 3
1597#define VV_WARNINGMSG 4
1598#define VV_STATUSMSG 5
1599#define VV_SHELL_ERROR 6
1600#define VV_THIS_SESSION 7
1601#define VV_VERSION 8
1602#define VV_LNUM 9
1603#define VV_TERMRESPONSE 10
1604#define VV_FNAME 11
1605#define VV_LANG 12
1606#define VV_LC_TIME 13
1607#define VV_CTYPE 14
1608#define VV_CC_FROM 15
1609#define VV_CC_TO 16
1610#define VV_FNAME_IN 17
1611#define VV_FNAME_OUT 18
1612#define VV_FNAME_NEW 19
1613#define VV_FNAME_DIFF 20
1614#define VV_CMDARG 21
1615#define VV_FOLDSTART 22
1616#define VV_FOLDEND 23
1617#define VV_FOLDDASHES 24
1618#define VV_FOLDLEVEL 25
1619#define VV_PROGNAME 26
1620#define VV_SEND_SERVER 27
1621#define VV_DYING 28
1622#define VV_EXCEPTION 29
1623#define VV_THROWPOINT 30
1624#define VV_REG 31
1625#define VV_CMDBANG 32
Bram Moolenaar843ee412004-06-30 16:16:41 +00001626#define VV_INSERTMODE 33
Bram Moolenaar6d14ccd2005-01-15 22:08:30 +00001627#define VV_VAL 34
1628#define VV_KEY 35
Bram Moolenaar05159a02005-02-26 23:04:13 +00001629#define VV_PROFILING 36
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001630#define VV_FCS_REASON 37
1631#define VV_FCS_CHOICE 38
Bram Moolenaar52b4b552005-03-07 23:00:57 +00001632#define VV_BEVAL_BUFNR 39
1633#define VV_BEVAL_WINNR 40
1634#define VV_BEVAL_LNUM 41
1635#define VV_BEVAL_COL 42
1636#define VV_BEVAL_TEXT 43
Bram Moolenaarbb15b652005-10-03 21:52:09 +00001637#define VV_SCROLLSTART 44
Bram Moolenaarbe79f902005-12-07 20:56:14 +00001638#define VV_SWAPNAME 45
1639#define VV_SWAPCHOICE 46
Bram Moolenaarcdbac1e2005-12-11 21:27:22 +00001640#define VV_SWAPCOMMAND 47
1641#define VV_LEN 48 /* number of v: vars */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642
1643#ifdef FEAT_CLIPBOARD
1644
1645/* VIM_ATOM_NAME is the older Vim-specific selection type for X11. Still
1646 * supported for when a mix of Vim versions is used. VIMENC_ATOM_NAME includes
1647 * the encoding to support Vims using different 'encoding' values. */
1648#define VIM_ATOM_NAME "_VIM_TEXT"
1649#define VIMENC_ATOM_NAME "_VIMENC_TEXT"
1650
1651/* Selection states for modeless selection */
1652# define SELECT_CLEARED 0
1653# define SELECT_IN_PROGRESS 1
1654# define SELECT_DONE 2
1655
1656# define SELECT_MODE_CHAR 0
1657# define SELECT_MODE_WORD 1
1658# define SELECT_MODE_LINE 2
1659
1660# ifdef FEAT_GUI_W32
1661# ifdef FEAT_OLE
1662# define WM_OLE (WM_APP+0)
1663# endif
1664# ifdef FEAT_NETBEANS_INTG
1665 /* message for Netbeans socket event */
1666# define WM_NETBEANS (WM_APP+1)
1667# endif
1668# endif
1669
1670/* Info about selected text */
1671typedef struct VimClipboard
1672{
1673 int available; /* Is clipboard available? */
1674 int owned; /* Flag: do we own the selection? */
1675 pos_T start; /* Start of selected area */
1676 pos_T end; /* End of selected area */
1677 int vmode; /* Visual mode character */
1678
1679 /* Fields for selection that doesn't use Visual mode */
1680 short_u origin_row;
1681 short_u origin_start_col;
1682 short_u origin_end_col;
1683 short_u word_start_col;
1684 short_u word_end_col;
1685
1686 pos_T prev; /* Previous position */
1687 short_u state; /* Current selection state */
1688 short_u mode; /* Select by char, word, or line. */
1689
1690# if defined(FEAT_GUI_X11) || defined(FEAT_XCLIPBOARD)
1691 Atom sel_atom; /* PRIMARY/CLIPBOARD selection ID */
1692# endif
1693
1694# ifdef FEAT_GUI_GTK
1695 GdkAtom gtk_sel_atom; /* PRIMARY/CLIPBOARD selection ID */
1696# endif
1697
1698# ifdef MSWIN
1699 int_u format; /* Vim's own special clipboard format */
1700 int_u format_raw; /* Vim's raw text clipboard format */
1701# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702} VimClipboard;
1703#else
1704typedef int VimClipboard; /* This is required for the prototypes. */
1705#endif
1706
1707#ifdef __BORLANDC__
1708/* work around a bug in the Borland 'stat' function: */
1709# include <io.h> /* for access() */
1710
1711# define stat(a,b) (access(a,0) ? -1 : stat(a,b))
1712#endif
1713
Bram Moolenaar05159a02005-02-26 23:04:13 +00001714#ifdef FEAT_PROFILE
Bram Moolenaar4d01d632005-02-28 22:39:03 +00001715# ifdef WIN3264
1716typedef LARGE_INTEGER proftime_T;
1717# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001718typedef struct timeval proftime_T;
Bram Moolenaar4d01d632005-02-28 22:39:03 +00001719# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001720#else
1721typedef int proftime_T; /* dummy for function prototypes */
1722#endif
1723
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724#include "ex_cmds.h" /* Ex command defines */
1725#include "proto.h" /* function prototypes */
1726
1727/* This has to go after the include of proto.h, as proto/gui.pro declares
1728 * functions of these names. The declarations would break if the defines had
1729 * been seen at that stage. But it must be before globals.h, where error_ga
1730 * is declared. */
1731#if !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_X11) \
Bram Moolenaarcef9dcc2005-12-06 19:50:41 +00001732 && !defined(FEAT_GUI_GTK) && !defined(FEAT_GUI_MAC)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733# define mch_errmsg(str) fprintf(stderr, "%s", (str))
1734# define display_errors() fflush(stderr)
1735# define mch_msg(str) printf("%s", (str))
1736#else
1737# define USE_MCH_ERRMSG
1738#endif
1739
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001740#ifndef FEAT_MBYTE
1741# define after_pathsep(b, p) vim_ispathsep(*((p) - 1))
1742# define transchar_byte(c) transchar(c)
1743#endif
1744
1745#ifndef FEAT_LINEBREAK
1746/* Without the 'numberwidth' option line numbers are always 7 chars. */
1747# define number_width(x) 7
1748#endif
1749
1750
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751#include "globals.h" /* global variables and messages */
1752
1753#ifdef FEAT_SNIFF
1754# include "if_sniff.h"
1755#endif
1756
1757#ifndef FEAT_VIRTUALEDIT
1758# define getvvcol(w, p, s, c, e) getvcol(w, p, s, c, e)
1759# define virtual_active() 0
1760# define virtual_op FALSE
1761#endif
1762
1763/*
1764 * If console dialog not supported, but GUI dialog is, use the GUI one.
1765 */
1766#if defined(FEAT_GUI_DIALOG) && !defined(FEAT_CON_DIALOG)
1767# define do_dialog gui_mch_dialog
1768#endif
1769
1770/*
1771 * Default filters for gui_mch_browse().
1772 * The filters are almost system independent. Except for the difference
1773 * between "*" and "*.*" for MSDOS-like systems.
1774 * NOTE: Motif only uses the very first pattern. Therefore
1775 * BROWSE_FILTER_DEFAULT should start with a "*" pattern.
1776 */
1777#ifdef FEAT_BROWSE
1778# ifdef BACKSLASH_IN_FILENAME
1779# define BROWSE_FILTER_MACROS \
1780 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*.*)\t*.*\n"
1781# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*.*)\t*.*\n"
1782# define BROWSE_FILTER_DEFAULT \
1783 (char_u *)"All Files (*.*)\t*.*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVB code (*.bas, *.frm)\t*.bas;*.frm\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n"
1784# else
1785# define BROWSE_FILTER_MACROS \
1786 (char_u *)"Vim macro files (*.vim)\t*.vim\nAll Files (*)\t*\n"
1787# define BROWSE_FILTER_ALL_FILES (char_u *)"All Files (*)\t*\n"
1788# define BROWSE_FILTER_DEFAULT \
1789 (char_u *)"All Files (*)\t*\nC source (*.c, *.h)\t*.c;*.h\nC++ source (*.cpp, *.hpp)\t*.cpp;*.hpp\nVim files (*.vim, _vimrc, _gvimrc)\t*.vim;_vimrc;_gvimrc\n"
1790# endif
Bram Moolenaar7171abe2004-10-11 10:06:20 +00001791# define BROWSE_SAVE 1 /* flag for do_browse() */
1792# define BROWSE_DIR 2 /* flag for do_browse() */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793#endif
1794
1795/* stop using fastcall for Borland */
1796#if defined(__BORLANDC__) && defined(WIN32) && !defined(DEBUG)
Bram Moolenaaraab21c32005-01-25 21:46:35 +00001797 #pragma option -p.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798#endif
1799
1800#if defined(MEM_PROFILE)
1801# define vim_realloc(ptr, size) mem_realloc((ptr), (size))
1802#else
1803# define vim_realloc(ptr, size) realloc((ptr), (size))
1804#endif
1805
1806/*
1807 * The following macros stop displat/event loop nesting at the wrong time.
1808 */
1809#ifdef ALT_X_INPUT
1810# define ALT_INPUT_LOCK_OFF suppress_alternate_input = FALSE
1811# define ALT_INPUT_LOCK_ON suppress_alternate_input = TRUE
1812#endif
1813
1814#ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815/*
1816 * Return byte length of character that starts with byte "b".
1817 * Returns 1 for a single-byte character.
1818 * MB_BYTE2LEN_CHECK() can be used to count a special key as one byte.
1819 * Don't call MB_BYTE2LEN(b) with b < 0 or b > 255!
1820 */
1821# define MB_BYTE2LEN(b) mb_bytelen_tab[b]
1822# define MB_BYTE2LEN_CHECK(b) (((b) < 0 || (b) > 255) ? 1 : mb_bytelen_tab[b])
1823#endif
1824
1825#if defined(FEAT_MBYTE) || defined(FEAT_POSTSCRIPT)
1826/* properties used in enc_canon_table[] (first three mutually exclusive) */
1827# define ENC_8BIT 0x01
1828# define ENC_DBCS 0x02
1829# define ENC_UNICODE 0x04
1830
1831# define ENC_ENDIAN_B 0x10 /* Unicode: Big endian */
1832# define ENC_ENDIAN_L 0x20 /* Unicode: Little endian */
1833
1834# define ENC_2BYTE 0x40 /* Unicode: UCS-2 */
1835# define ENC_4BYTE 0x80 /* Unicode: UCS-4 */
1836# define ENC_2WORD 0x100 /* Unicode: UTF-16 */
1837
1838# define ENC_LATIN1 0x200 /* Latin1 */
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001839# define ENC_LATIN9 0x400 /* Latin9 */
1840# define ENC_MACROMAN 0x800 /* Mac Roman (not Macro Man! :-) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841#endif
1842
1843#ifdef FEAT_MBYTE
1844# ifdef USE_ICONV
1845# ifndef EILSEQ
1846# define EILSEQ 123
1847# endif
1848# ifdef DYNAMIC_ICONV
1849/* On Win32 iconv.dll is dynamically loaded. */
1850# define ICONV_ERRNO (*iconv_errno())
1851# define ICONV_E2BIG 7
1852# define ICONV_EINVAL 22
1853# define ICONV_EILSEQ 42
1854# else
1855# define ICONV_ERRNO errno
1856# define ICONV_E2BIG E2BIG
1857# define ICONV_EINVAL EINVAL
1858# define ICONV_EILSEQ EILSEQ
1859# endif
1860# endif
1861
1862#endif
1863
1864/* ISSYMLINK(mode) tests if a file is a symbolic link. */
1865#if (defined(S_IFMT) && defined(S_IFLNK)) || defined(S_ISLNK)
1866# define HAVE_ISSYMLINK
1867# if defined(S_IFMT) && defined(S_IFLNK)
1868# define ISSYMLINK(mode) (((mode) & S_IFMT) == S_IFLNK)
1869# else
1870# define ISSYMLINK(mode) S_ISLNK(mode)
1871# endif
1872#endif
1873
1874#define SIGN_BYTE 1 /* byte value used where sign is displayed;
1875 attribute value is sign type */
1876
1877#ifdef FEAT_NETBEANS_INTG
1878# define MULTISIGN_BYTE 2 /* byte value used where sign is displayed if
1879 multiple signs exist on the line */
1880#endif
1881
1882#if defined(FEAT_GUI) && defined(FEAT_XCLIPBOARD)
1883# ifdef FEAT_GUI_GTK
1884 /* Avoid using a global variable for the X display. It's ugly
1885 * and is likely to cause trouble in multihead environments. */
1886# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : xterm_dpy)
1887# else
1888# define X_DISPLAY (gui.in_use ? gui.dpy : xterm_dpy)
1889# endif
1890#else
1891# ifdef FEAT_GUI
1892# ifdef FEAT_GUI_GTK
1893# define X_DISPLAY ((gui.in_use) ? gui_mch_get_display() : (Display *)NULL)
1894# else
1895# define X_DISPLAY gui.dpy
1896# endif
1897# else
1898# define X_DISPLAY xterm_dpy
1899# endif
1900#endif
1901
1902#ifdef NBDEBUG /* Netbeans debugging. */
1903# include "nbdebug.h"
1904#else
1905# define nbdebug(a)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906#endif
1907
1908#ifdef IN_PERL_FILE
1909 /*
1910 * Avoid clashes between Perl and Vim namespace.
1911 */
1912# undef NORMAL
1913# undef STRLEN
1914# undef FF
1915# undef OP_DELETE
1916# undef OP_JOIN
1917# ifdef __BORLANDC__
1918# define NOPROTO 1
1919# endif
1920 /* remove MAX and MIN, included by glib.h, redefined by sys/param.h */
1921# ifdef MAX
1922# undef MAX
1923# endif
1924# ifdef MIN
1925# undef MIN
1926# endif
1927 /* We use _() for gettext(), Perl uses it for function prototypes... */
1928# ifdef _
1929# undef _
1930# endif
1931# ifdef DEBUG
1932# undef DEBUG
1933# endif
1934# ifdef _DEBUG
1935# undef _DEBUG
1936# endif
1937# ifdef instr
1938# undef instr
1939# endif
1940 /* bool causes trouble on MACOS but is required on a few other systems */
1941# if defined(bool) && defined(MACOS)
1942# undef bool
1943# endif
1944
1945# ifdef __BORLANDC__
1946 /* Borland has the structure stati64 but not _stati64 */
1947# define _stati64 stati64
1948# endif
1949
1950# include <EXTERN.h>
1951# include <perl.h>
1952# include <XSUB.h>
1953#endif
1954
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00001955/* values for vim_handle_signal() that are not a signal */
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00001956#define SIGNAL_BLOCK -1
1957#define SIGNAL_UNBLOCK -2
Bram Moolenaarb6356332005-07-18 21:40:44 +00001958#if !defined(UNIX) && !defined(VMS)
Bram Moolenaar5eba4c22005-07-12 22:40:29 +00001959# define vim_handle_signal(x) 0
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001960#endif
1961
Bram Moolenaar05159a02005-02-26 23:04:13 +00001962/* flags for skip_vimgrep_pat() */
1963#define VGR_GLOBAL 1
1964#define VGR_NOJUMP 2
1965
Bram Moolenaarb0bf8582005-12-13 20:02:15 +00001966/* behavior for bad character, "++bad=" argument */
1967#define BAD_REPLACE '?' /* replace it with '?' (default) */
1968#define BAD_KEEP -1 /* leave it */
1969#define BAD_DROP -2 /* erase it */
1970
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971#endif /* VIM__H */