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