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