src/vim.h

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