globals.h

Go to the documentation of this file.

#ifndef NVIM_GLOBALS_H
#define NVIM_GLOBALS_H

#include <stdbool.h>
#include <inttypes.h>

#include "nvim/macros.h"
#include "nvim/ex_eval.h"
#include "nvim/iconv.h"
#include "nvim/mbyte.h"
#include "nvim/menu.h"
#include "nvim/syntax_defs.h"
#include "nvim/types.h"
#include "nvim/event/loop.h"
#include "nvim/os/os_defs.h"

#define IOSIZE         (1024+1)          // file I/O and sprintf buffer size

# define MSG_BUF_LEN 480                 // length of buffer for small messages
# define MSG_BUF_CLEN  (MSG_BUF_LEN / 6) // cell length (worst case: utf-8
                                         // takes 6 bytes for one cell)

#ifdef WIN32
# define _PATHSEPSTR "\\"
#else
# define _PATHSEPSTR "/"
#endif

#ifndef FILETYPE_FILE
# define FILETYPE_FILE  "filetype.vim"
#endif

#ifndef FTPLUGIN_FILE
# define FTPLUGIN_FILE  "ftplugin.vim"
#endif

#ifndef INDENT_FILE
# define INDENT_FILE    "indent.vim"
#endif

#ifndef FTOFF_FILE
# define FTOFF_FILE     "ftoff.vim"
#endif

#ifndef FTPLUGOF_FILE
# define FTPLUGOF_FILE  "ftplugof.vim"
#endif

#ifndef INDOFF_FILE
# define INDOFF_FILE    "indoff.vim"
#endif

#define DFLT_ERRORFILE  "errors.err"

#ifndef SYS_VIMRC_FILE
# define SYS_VIMRC_FILE "$VIM" _PATHSEPSTR "sysinit.vim"
#endif

#ifndef DFLT_HELPFILE
# define DFLT_HELPFILE  "$VIMRUNTIME" _PATHSEPSTR "doc" _PATHSEPSTR "help.txt"
#endif

#ifndef SYNTAX_FNAME
# define SYNTAX_FNAME   "$VIMRUNTIME" _PATHSEPSTR "syntax" _PATHSEPSTR "%s.vim"
#endif

#ifndef EXRC_FILE
# define EXRC_FILE      ".exrc"
#endif

#ifndef VIMRC_FILE
# define VIMRC_FILE     ".nvimrc"
#endif

typedef enum {
  kNone  = -1,
  kFalse = 0,
  kTrue  = 1,
} TriState;

EXTERN struct nvim_stats_s {
  int64_t fsync;
  int64_t redraw;
} g_stats INIT(= { 0, 0 });

// Values for "starting".
#define NO_SCREEN       2       // no screen updating yet
#define NO_BUFFERS      1       // not all buffers loaded yet
//                      0          not starting anymore

/*
 * Number of Rows and Columns in the screen.
 * Must be long to be able to use them as options in option.c.
 * Note: Use default_grid.Rows and default_grid.Columns to access items in
 * default_grid.chars[]. They may have different values when the screen
 * wasn't (re)allocated yet after setting Rows or Columns (e.g., when starting
 * up).
 */
#define DFLT_COLS       80              // default value for 'columns'
#define DFLT_ROWS       24              // default value for 'lines'
EXTERN long Rows INIT(= DFLT_ROWS);     // nr of rows in the screen
EXTERN long Columns INIT(= DFLT_COLS);  // nr of columns in the screen

// We use 64-bit file functions here, if available.  E.g. ftello() returns
// off_t instead of long, which helps if long is 32 bit and off_t is 64 bit.
// We assume that when fseeko() is available then ftello() is too.
// Note that Windows has different function names.
#if (defined(_MSC_VER) && (_MSC_VER >= 1300)) || defined(__MINGW32__)
typedef __int64 off_T;
# ifdef __MINGW32__
#  define vim_lseek lseek64
#  define vim_fseek fseeko64
#  define vim_ftell ftello64
# else
#  define vim_lseek _lseeki64
#  define vim_fseek _fseeki64
#  define vim_ftell _ftelli64
# endif
#else
typedef off_t off_T;
# ifdef HAVE_FSEEKO
#  define vim_lseek lseek
#  define vim_ftell ftello
#  define vim_fseek fseeko
# else
#  define vim_lseek lseek
#  define vim_ftell ftell
#  define vim_fseek(a, b, c) fseek(a, (long)b, c)
# endif
#endif

/*
 * When vgetc() is called, it sets mod_mask to the set of modifiers that are
 * held down based on the MOD_MASK_* symbols that are read first.
 */
EXTERN int mod_mask INIT(= 0x0);                /* current key modifiers */

/*
 * Cmdline_row is the row where the command line starts, just below the
 * last window.
 * When the cmdline gets longer than the available space the screen gets
 * scrolled up. After a CTRL-D (show matches), after hitting ':' after
 * "hit return", and for the :global command, the command line is
 * temporarily moved.  The old position is restored with the next call to
 * update_screen().
 */
EXTERN int cmdline_row;

EXTERN int redraw_cmdline INIT(= false);          // cmdline must be redrawn
EXTERN int clear_cmdline INIT(= false);           // cmdline must be cleared
EXTERN int mode_displayed INIT(= false);          // mode is being displayed
EXTERN int cmdline_star INIT(= false);            // cmdline is crypted
EXTERN int redrawing_cmdline INIT(= false);       // cmdline is being redrawn
EXTERN int cmdline_was_last_drawn INIT(= false);  // cmdline was last drawn

EXTERN int exec_from_reg INIT(= false);         // executing register

/*
 * When '$' is included in 'cpoptions' option set:
 * When a change command is given that deletes only part of a line, a dollar
 * is put at the end of the changed text. dollar_vcol is set to the virtual
 * column of this '$'.  -1 is used to indicate no $ is being displayed.
 */
EXTERN colnr_T dollar_vcol INIT(= -1);

/*
 * Variables for Insert mode completion.
 */

/* Length in bytes of the text being completed (this is deleted to be replaced
 * by the match.) */
EXTERN int compl_length INIT(= 0);

/* Set when character typed while looking for matches and it means we should
 * stop looking for matches. */
EXTERN int compl_interrupted INIT(= FALSE);

// Set when doing something for completion that may call edit() recursively,
// which is not allowed. Also used to disable folding during completion
EXTERN int compl_busy INIT(= false);

/* List of flags for method of completion. */
EXTERN int compl_cont_status INIT(= 0);
# define CONT_ADDING    1       /* "normal" or "adding" expansion */
# define CONT_INTRPT    (2 + 4) /* a ^X interrupted the current expansion */
                                /* it's set only iff N_ADDS is set */
# define CONT_N_ADDS    4       /* next ^X<> will add-new or expand-current */
# define CONT_S_IPOS    8       /* next ^X<> will set initial_pos?
                                 * if so, word-wise-expansion will set SOL */
# define CONT_SOL       16      /* pattern includes start of line, just for
                                 * word-wise expansion, not set for ^X^L */
# define CONT_LOCAL     32      /* for ctrl_x_mode 0, ^X^P/^X^N do a local
                                 * expansion, (eg use complete=.) */

// state for putting characters in the message area
EXTERN int cmdmsg_rl INIT(= false);  // cmdline is drawn right to left
EXTERN int msg_col;
EXTERN int msg_row;
EXTERN int msg_scrolled;        // Number of screen lines that windows have
                                // scrolled because of printing messages.
// when true don't set need_wait_return in msg_puts_attr()
// when msg_scrolled is non-zero
EXTERN bool msg_scrolled_ign INIT(= false);
// Whether the screen is damaged due to scrolling. Sometimes msg_scrolled
// is reset before the screen is redrawn, so we need to keep track of this.
EXTERN bool msg_did_scroll INIT(= false);


EXTERN char_u   *keep_msg INIT(= NULL);     /* msg to be shown after redraw */
EXTERN int keep_msg_attr INIT(= 0);         /* highlight attr for keep_msg */
EXTERN int keep_msg_more INIT(= FALSE);      /* keep_msg was set by msgmore() */
EXTERN int need_fileinfo INIT(= FALSE);     /* do fileinfo() after redraw */
EXTERN int msg_scroll INIT(= FALSE);        /* msg_start() will scroll */
EXTERN int msg_didout INIT(= FALSE);        /* msg_outstr() was used in line */
EXTERN int msg_didany INIT(= FALSE);        /* msg_outstr() was used at all */
EXTERN int msg_nowait INIT(= FALSE);        /* don't wait for this msg */
EXTERN int emsg_off INIT(= 0);              /* don't display errors for now,
                                               unless 'debug' is set. */
EXTERN int info_message INIT(= FALSE);      /* printing informative message */
EXTERN int msg_hist_off INIT(= FALSE);      /* don't add messages to history */
EXTERN int need_clr_eos INIT(= FALSE);      /* need to clear text before
                                               displaying a message. */
EXTERN int emsg_skip INIT(= 0);             /* don't display errors for
                                               expression that is skipped */
EXTERN int emsg_severe INIT(= FALSE);        /* use message of next of several
                                                emsg() calls for throw */
EXTERN int did_endif INIT(= FALSE);         /* just had ":endif" */
EXTERN dict_T vimvardict;                   /* Dictionary with v: variables */
EXTERN dict_T globvardict;                  /* Dictionary with g: variables */
EXTERN int did_emsg;                        /* set by emsg() when the message
                                               is displayed or thrown */
EXTERN bool called_vim_beep;                // set if vim_beep() is called
EXTERN int did_emsg_syntax;                 /* did_emsg set because of a
                                               syntax error */
EXTERN int called_emsg;                     /* always set by emsg() */
EXTERN int ex_exitval INIT(= 0);            /* exit value for ex mode */
EXTERN int emsg_on_display INIT(= FALSE);       /* there is an error message */
EXTERN int rc_did_emsg INIT(= FALSE);       /* vim_regcomp() called emsg() */

EXTERN int no_wait_return INIT(= 0);        /* don't wait for return for now */
EXTERN int need_wait_return INIT(= 0);      /* need to wait for return later */
EXTERN int did_wait_return INIT(= FALSE);       /* wait_return() was used and
                                                   nothing written since then */
EXTERN int need_maketitle INIT(= TRUE);      /* call maketitle() soon */

EXTERN int quit_more INIT(= false);         // 'q' hit at "--more--" msg
EXTERN int ex_keep_indent INIT(= false);    // getexmodeline(): keep indent
EXTERN int vgetc_busy INIT(= 0);            // when inside vgetc() then > 0

EXTERN int didset_vim INIT(= FALSE);        /* did set $VIM ourselves */
EXTERN int didset_vimruntime INIT(= FALSE);        /* idem for $VIMRUNTIME */

EXTERN int lines_left INIT(= -1);           // lines left for listing
EXTERN int msg_no_more INIT(= false);       // don't use more prompt, truncate
                                            // messages

EXTERN char_u   *sourcing_name INIT( = NULL); /* name of error message source */
EXTERN linenr_T sourcing_lnum INIT(= 0);    /* line number of the source file */

EXTERN int ex_nesting_level INIT(= 0);          // nesting level
EXTERN int debug_break_level INIT(= -1);        // break below this level
EXTERN int debug_did_msg INIT(= false);         // did "debug mode" message
EXTERN int debug_tick INIT(= 0);                // breakpoint change count
EXTERN int debug_backtrace_level INIT(= 0);     // breakpoint backtrace level

// Values for "do_profiling".
#define PROF_NONE       0       
#define PROF_YES        1       
#define PROF_PAUSED     2       
EXTERN int do_profiling INIT(= PROF_NONE);      

EXTERN except_T *current_exception;

EXTERN int need_rethrow INIT(= false);

EXTERN int check_cstack INIT(= false);

EXTERN int trylevel INIT(= 0);

EXTERN int force_abort INIT(= false);

EXTERN struct msglist **msg_list INIT(= NULL);

EXTERN int suppress_errthrow INIT(= false);

EXTERN except_T *caught_stack INIT(= NULL);


EXTERN int may_garbage_collect INIT(= false);
EXTERN int want_garbage_collect INIT(= false);
EXTERN int garbage_collect_at_exit INIT(= false);

// Special values for current_SID.
#define SID_MODELINE    -1      // when using a modeline
#define SID_CMDARG      -2      // for "--cmd" argument
#define SID_CARG        -3      // for "-c" argument
#define SID_ENV         -4      // for sourcing environment variable
#define SID_ERROR       -5      // option was reset because of an error
#define SID_NONE        -6      // don't set scriptID
#define SID_LUA         -7      // for Lua scripts/chunks
#define SID_API_CLIENT  -8      // for API clients

// ID of script being sourced or was sourced to define the current function.
EXTERN scid_T current_SID INIT(= 0);
// ID of the current channel making a client API call
EXTERN uint64_t current_channel_id INIT(= 0);

EXTERN bool did_source_packages INIT(= false);

// Scope information for the code that indirectly triggered the current
// provider function call
EXTERN struct caller_scope {
  scid_T SID;
  uint8_t *sourcing_name, *autocmd_fname, *autocmd_match; 
  linenr_T sourcing_lnum;
  int autocmd_bufnr;
  void *funccalp;
} provider_caller_scope;
EXTERN int provider_call_nesting INIT(= 0);


EXTERN int t_colors INIT(= 256);                // int value of T_CCO

/*
 * When highlight_match is TRUE, highlight a match, starting at the cursor
 * position.  Search_match_lines is the number of lines after the match (0 for
 * a match within one line), search_match_endcol the column number of the
 * character just after the match in the last line.
 */
EXTERN int highlight_match INIT(= FALSE);       /* show search match pos */
EXTERN linenr_T search_match_lines;             /* lines of of matched string */
EXTERN colnr_T search_match_endcol;             /* col nr of match end */

EXTERN int no_smartcase INIT(= FALSE);          /* don't use 'smartcase' once */

EXTERN int need_check_timestamps INIT(= FALSE);      /* need to check file
                                                        timestamps asap */
EXTERN int did_check_timestamps INIT(= FALSE);      /* did check timestamps
                                                       recently */
EXTERN int no_check_timestamps INIT(= 0);       /* Don't check timestamps */

EXTERN int autocmd_busy INIT(= FALSE);          /* Is apply_autocmds() busy? */
EXTERN int autocmd_no_enter INIT(= FALSE);      /* *Enter autocmds disabled */
EXTERN int autocmd_no_leave INIT(= FALSE);      /* *Leave autocmds disabled */
EXTERN int modified_was_set;                    /* did ":set modified" */
EXTERN int did_filetype INIT(= FALSE);          /* FileType event found */
EXTERN int keep_filetype INIT(= FALSE);         /* value for did_filetype when
                                                   starting to execute
                                                   autocommands */

// When deleting the current buffer, another one must be loaded.
// If we know which one is preferred, au_new_curbuf is set to it.
EXTERN bufref_T au_new_curbuf INIT(= { NULL, 0, 0 });

// When deleting a buffer/window and autocmd_busy is TRUE, do not free the
// buffer/window. but link it in the list starting with
// au_pending_free_buf/ap_pending_free_win, using b_next/w_next.
// Free the buffer/window when autocmd_busy is being set to FALSE.
EXTERN buf_T *au_pending_free_buf INIT(= NULL);
EXTERN win_T *au_pending_free_win INIT(= NULL);

// Mouse coordinates, set by handle_mouse_event()
EXTERN int mouse_grid;
EXTERN int mouse_row;
EXTERN int mouse_col;
EXTERN bool mouse_past_bottom INIT(= false);    /* mouse below last line */
EXTERN bool mouse_past_eol INIT(= false);       /* mouse right of line */
EXTERN int mouse_dragging INIT(= 0);            /* extending Visual area with
                                                   mouse dragging */

/* Value set from 'diffopt'. */
EXTERN int diff_context INIT(= 6);              /* context for folds */
EXTERN int diff_foldcolumn INIT(= 2);           /* 'foldcolumn' for diff mode */
EXTERN int diff_need_scrollbind INIT(= FALSE);

/* The root of the menu hierarchy. */
EXTERN vimmenu_T        *root_menu INIT(= NULL);
/*
 * While defining the system menu, sys_menu is TRUE.  This avoids
 * overruling of menus that the user already defined.
 */
EXTERN int sys_menu INIT(= FALSE);

/* While redrawing the screen this flag is set.  It means the screen size
 * ('lines' and 'rows') must not be changed. */
EXTERN int updating_screen INIT(= FALSE);

/*
 * All windows are linked in a list. firstwin points to the first entry,
 * lastwin to the last entry (can be the same as firstwin) and curwin to the
 * currently active window.
 */
EXTERN win_T    *firstwin;              /* first window */
EXTERN win_T    *lastwin;               /* last window */
EXTERN win_T    *prevwin INIT(= NULL);  /* previous window */
# define ONE_WINDOW (firstwin == lastwin)
/*
 * When using this macro "break" only breaks out of the inner loop. Use "goto"
 * to break out of the tabpage loop.
 */
# define FOR_ALL_TAB_WINDOWS(tp, wp) \
  FOR_ALL_TABS(tp) \
    FOR_ALL_WINDOWS_IN_TAB(wp, tp)

// -V:FOR_ALL_WINDOWS_IN_TAB:501
# define FOR_ALL_WINDOWS_IN_TAB(wp, tp) \
  for (win_T *wp = ((tp) == curtab) \
              ? firstwin : (tp)->tp_firstwin; wp != NULL; wp = wp->w_next)

EXTERN win_T    *curwin;        /* currently active window */

EXTERN win_T    *aucmd_win;     /* window used in aucmd_prepbuf() */
EXTERN int aucmd_win_used INIT(= FALSE);        /* aucmd_win is being used */

/*
 * The window layout is kept in a tree of frames.  topframe points to the top
 * of the tree.
 */
EXTERN frame_T  *topframe;      /* top of the window frame tree */

/*
 * Tab pages are alternative topframes.  "first_tabpage" points to the first
 * one in the list, "curtab" is the current one.
 */
EXTERN tabpage_T    *first_tabpage;
EXTERN tabpage_T    *curtab;
EXTERN int redraw_tabline INIT(= FALSE);           /* need to redraw tabline */

// Iterates over all tabs in the tab list
# define FOR_ALL_TABS(tp) for (tabpage_T *tp = first_tabpage; tp != NULL; tp = tp->tp_next)

/*
 * All buffers are linked in a list. 'firstbuf' points to the first entry,
 * 'lastbuf' to the last entry and 'curbuf' to the currently active buffer.
 */
EXTERN buf_T    *firstbuf INIT(= NULL);  // first buffer
EXTERN buf_T    *lastbuf INIT(= NULL);   // last buffer
EXTERN buf_T    *curbuf INIT(= NULL);    // currently active buffer

// Iterates over all buffers in the buffer list.
#define FOR_ALL_BUFFERS(buf) \
  for (buf_T *buf = firstbuf; buf != NULL; buf = buf->b_next)
#define FOR_ALL_BUFFERS_BACKWARDS(buf) \
  for (buf_T *buf = lastbuf; buf != NULL; buf = buf->b_prev)

// Iterate through all the signs placed in a buffer
#define FOR_ALL_SIGNS_IN_BUF(buf, sign) \
  for (sign = buf->b_signlist; sign != NULL; sign = sign->next)   // NOLINT


/*
 * List of files being edited (global argument list).  curwin->w_alist points
 * to this when the window is using the global argument list.
 */
EXTERN alist_T global_alist;    /* global argument list */
EXTERN int max_alist_id INIT(= 0);     
EXTERN bool arg_had_last INIT(= false);     // accessed last file in
                                            // global_alist

EXTERN int ru_col;              /* column for ruler */
EXTERN int ru_wid;              /* 'rulerfmt' width of ruler when non-zero */
EXTERN int sc_col;              /* column for shown command */

//
// When starting or exiting some things are done differently (e.g. screen
// updating).
//

// First NO_SCREEN, then NO_BUFFERS, then 0 when startup finished.
EXTERN int starting INIT(= NO_SCREEN);
// true when planning to exit. Might keep running if there is a changed buffer.
EXTERN int exiting INIT(= false);
// is stdin a terminal?
EXTERN int stdin_isatty INIT(= true);
// is stdout a terminal?
EXTERN int stdout_isatty INIT(= true);
// true when doing full-screen output, otherwise only writing some messages.
// volatile because it is used in a signal handler.
EXTERN volatile int full_screen INIT(= false);

// When started in restricted mode (-Z).
EXTERN int restricted INIT(= false);

EXTERN int secure INIT(= false);

EXTERN int textlock INIT(= 0);

EXTERN int curbuf_lock INIT(= 0);

EXTERN int allbuf_lock INIT(= 0);

EXTERN int sandbox INIT(= 0);

EXTERN int silent_mode INIT(= false);

EXTERN pos_T VIsual;
EXTERN int VIsual_active INIT(= false);
EXTERN int VIsual_select INIT(= false);
EXTERN int VIsual_reselect;
EXTERN int VIsual_mode INIT(= 'v');
EXTERN int redo_VIsual_busy INIT(= false);

EXTERN pos_T where_paste_started;

/*
 * This flag is used to make auto-indent work right on lines where only a
 * <RETURN> or <ESC> is typed. It is set when an auto-indent is done, and
 * reset when any other editing is done on the line. If an <ESC> or <RETURN>
 * is received, and did_ai is TRUE, the line is truncated.
 */
EXTERN bool did_ai INIT(= false);

/*
 * Column of first char after autoindent.  0 when no autoindent done.  Used
 * when 'backspace' is 0, to avoid backspacing over autoindent.
 */
EXTERN colnr_T ai_col INIT(= 0);

/*
 * This is a character which will end a start-middle-end comment when typed as
 * the first character on a new line.  It is taken from the last character of
 * the "end" comment leader when the COM_AUTO_END flag is given for that
 * comment end in 'comments'.  It is only valid when did_ai is TRUE.
 */
EXTERN int end_comment_pending INIT(= NUL);

/*
 * This flag is set after a ":syncbind" to let the check_scrollbind() function
 * know that it should not attempt to perform scrollbinding due to the scroll
 * that was a result of the ":syncbind." (Otherwise, check_scrollbind() will
 * undo some of the work done by ":syncbind.")  -ralston
 */
EXTERN int did_syncbind INIT(= FALSE);

/*
 * This flag is set when a smart indent has been performed. When the next typed
 * character is a '{' the inserted tab will be deleted again.
 */
EXTERN bool did_si INIT(= false);

/*
 * This flag is set after an auto indent. If the next typed character is a '}'
 * one indent will be removed.
 */
EXTERN bool can_si INIT(= false);

/*
 * This flag is set after an "O" command. If the next typed character is a '{'
 * one indent will be removed.
 */
EXTERN bool can_si_back INIT(= false);

// w_cursor before formatting text.
EXTERN pos_T saved_cursor INIT(= { 0, 0, 0 });

/*
 * Stuff for insert mode.
 */
EXTERN pos_T Insstart;                  /* This is where the latest
                                         * insert/append mode started. */

// This is where the latest insert/append mode started. In contrast to
// Insstart, this won't be reset by certain keys and is needed for
// op_insert(), to detect correctly where inserting by the user started.
EXTERN pos_T Insstart_orig;

/*
 * Stuff for VREPLACE mode.
 */
EXTERN int orig_line_count INIT(= 0);       /* Line count when "gR" started */
EXTERN int vr_lines_changed INIT(= 0);      /* #Lines changed by "gR" so far */


/*
 * These flags are set based upon 'fileencoding'.
 * Note that "enc_utf8" is also set for "unicode", because the characters are
 * internally stored as UTF-8 (to avoid trouble with NUL bytes).
 */
# define DBCS_JPN       932     /* japan */
# define DBCS_JPNU      9932    /* euc-jp */
# define DBCS_KOR       949     /* korea */
# define DBCS_KORU      9949    /* euc-kr */
# define DBCS_CHS       936     /* chinese */
# define DBCS_CHSU      9936    /* euc-cn */
# define DBCS_CHT       950     /* taiwan */
# define DBCS_CHTU      9950    /* euc-tw */
# define DBCS_2BYTE     1       /* 2byte- */
# define DBCS_DEBUG     -1

// mbyte flags that used to depend on 'encoding'. These are now deprecated, as
// 'encoding' is always "utf-8". Code that use them can be refactored to
// remove dead code.
#define enc_utf8 true
#define has_mbyte true

EXTERN char_u *fenc_default INIT(= NULL);

# if defined(USE_ICONV) && defined(DYNAMIC_ICONV)
/* Pointers to functions and variables to be loaded at runtime */
EXTERN size_t (*iconv)(iconv_t cd, const char **inbuf, size_t *inbytesleft,
                       char **outbuf, size_t *outbytesleft);
EXTERN iconv_t (*iconv_open)(const char *tocode, const char *fromcode);
EXTERN int (*iconv_close)(iconv_t cd);
EXTERN int (*iconvctl)(iconv_t cd, int request, void *argument);
EXTERN int* (*iconv_errno)(void);
# endif

EXTERN int State INIT(= NORMAL);        // This is the current state of the
                                        // command interpreter.

EXTERN bool finish_op INIT(= false);    // true while an operator is pending
EXTERN long opcount INIT(= 0);          // count for pending operator
EXTERN int motion_force INIT(=0);       // motion force for pending operator

// Ex Mode (Q) state
EXTERN int exmode_active INIT(= 0);     // Zero, EXMODE_NORMAL or EXMODE_VIM.
EXTERN int ex_no_reprint INIT(=false);  // No need to print after z or p.

EXTERN int reg_recording INIT(= 0);     // register for recording  or zero
EXTERN int reg_executing INIT(= 0);     // register being executed or zero

EXTERN int no_mapping INIT(= false);    // currently no mapping allowed
EXTERN int no_zero_mapping INIT(= 0);   // mapping zero not allowed
EXTERN int no_u_sync INIT(= 0);         // Don't call u_sync()
EXTERN int u_sync_once INIT(= 0);       // Call u_sync() once when evaluating
                                        // an expression.

EXTERN bool force_restart_edit INIT(= false);  // force restart_edit after
                                               // ex_normal returns
EXTERN int restart_edit INIT(= 0);      /* call edit when next cmd finished */
EXTERN int arrow_used;                  /* Normally FALSE, set to TRUE after
                                         * hitting cursor key in insert mode.
                                         * Used by vgetorpeek() to decide when
                                         * to call u_sync() */
EXTERN int ins_at_eol INIT(= FALSE);      /* put cursor after eol when
                                             restarting edit after CTRL-O */
EXTERN char_u   *edit_submode INIT(= NULL); /* msg for CTRL-X submode */
EXTERN char_u   *edit_submode_pre INIT(= NULL); /* prepended to edit_submode */
EXTERN char_u   *edit_submode_extra INIT(= NULL); /* appended to edit_submode */
EXTERN hlf_T edit_submode_highl;        /* highl. method for extra info */
EXTERN int ctrl_x_mode INIT(= 0);       /* Which Ctrl-X mode are we in? */

EXTERN int no_abbr INIT(= TRUE);        /* TRUE when no abbreviations loaded */

EXTERN int mapped_ctrl_c INIT(= 0);  // Modes where CTRL-C is mapped.

EXTERN cmdmod_T cmdmod;                 /* Ex command modifiers */

EXTERN int msg_silent INIT(= 0);         // don't print messages
EXTERN int emsg_silent INIT(= 0);        // don't print error messages
EXTERN bool emsg_noredir INIT(= false);  // don't redirect error messages
EXTERN bool cmd_silent INIT(= false);    // don't echo the command line

/* Values for swap_exists_action: what to do when swap file already exists */
#define SEA_NONE        0       /* don't use dialog */
#define SEA_DIALOG      1       /* use dialog when possible */
#define SEA_QUIT        2       /* quit editing the file */
#define SEA_RECOVER     3       /* recover the file */

EXTERN int swap_exists_action INIT(= SEA_NONE);
/* For dialog when swap file already
 * exists. */
EXTERN int swap_exists_did_quit INIT(= FALSE);
/* Selected "quit" at the dialog. */

EXTERN char_u IObuff[IOSIZE];               
EXTERN char_u NameBuff[MAXPATHL];           
EXTERN char_u msg_buf[MSG_BUF_LEN];         
EXTERN char os_buf[                         
#if MAXPATHL > IOSIZE
MAXPATHL
#else
IOSIZE
#endif
];

/* When non-zero, postpone redrawing. */
EXTERN int RedrawingDisabled INIT(= 0);

EXTERN int readonlymode INIT(= FALSE);      /* Set to TRUE for "view" */
EXTERN int recoverymode INIT(= FALSE);      /* Set to TRUE for "-r" option */

// typeahead buffer
EXTERN typebuf_T typebuf INIT(= { NULL, NULL, 0, 0, 0, 0, 0, 0, 0 });

EXTERN int ex_normal_busy INIT(= 0);     // recursiveness of ex_normal()
EXTERN int ex_normal_lock INIT(= 0);     // forbid use of ex_normal()
EXTERN int ignore_script INIT(= false);  // ignore script input
EXTERN int stop_insert_mode;             // for ":stopinsert" and 'insertmode'
EXTERN bool KeyTyped;                    // true if user typed current char
EXTERN int KeyStuffed;                   // TRUE if current char from stuffbuf
EXTERN int maptick INIT(= 0);            // tick for each non-mapped char

EXTERN int must_redraw INIT(= 0);           /* type of redraw necessary */
EXTERN int skip_redraw INIT(= FALSE);       /* skip redraw once */
EXTERN int do_redraw INIT(= FALSE);         /* extra redraw once */

EXTERN int need_highlight_changed INIT(= true);

EXTERN FILE *scriptout INIT(= NULL);  

// volatile because it is used in a signal handler.
EXTERN volatile int got_int INIT(= false);  // set to true when interrupt
                                            // signal occurred
EXTERN int bangredo INIT(= FALSE);          /* set to TRUE with ! command */
EXTERN int searchcmdlen;                    /* length of previous search cmd */
EXTERN int reg_do_extmatch INIT(= 0);       /* Used when compiling regexp:
                                             * REX_SET to allow \z\(...\),
                                             * REX_USE to allow \z\1 et al. */
EXTERN reg_extmatch_T *re_extmatch_in INIT(= NULL); /* Used by vim_regexec():
                                                     * strings for \z\1...\z\9 */
EXTERN reg_extmatch_T *re_extmatch_out INIT(= NULL); /* Set by vim_regexec()
                                                      * to store \z\(...\) matches */

EXTERN int did_outofmem_msg INIT(= false);
// set after out of memory msg
EXTERN int did_swapwrite_msg INIT(= false);
// set after swap write error msg
EXTERN int undo_off INIT(= false);          // undo switched off for now
EXTERN int global_busy INIT(= 0);           // set when :global is executing
EXTERN int listcmd_busy INIT(= false);      // set when :argdo, :windo or
                                            // :bufdo is executing
EXTERN int need_start_insertmode INIT(= false);
// start insert mode soon
EXTERN char_u *last_cmdline INIT(= NULL);      // last command line (for ":)
EXTERN char_u *repeat_cmdline INIT(= NULL);    // command line for "."
EXTERN char_u *new_last_cmdline INIT(= NULL);  // new value for last_cmdline
EXTERN char_u *autocmd_fname INIT(= NULL);     // fname for <afile> on cmdline
EXTERN int autocmd_bufnr INIT(= 0);            // fnum for <abuf> on cmdline
EXTERN char_u *autocmd_match INIT(= NULL);     // name for <amatch> on cmdline
EXTERN int did_cursorhold INIT(= false);       // set when CursorHold t'gerd

EXTERN int postponed_split INIT(= 0);       /* for CTRL-W CTRL-] command */
EXTERN int postponed_split_flags INIT(= 0);       /* args for win_split() */
EXTERN int postponed_split_tab INIT(= 0);       /* cmdmod.tab */
EXTERN int g_do_tagpreview INIT(= 0);       /* for tag preview commands:
                                               height of preview window */
EXTERN int replace_offset INIT(= 0);        /* offset for replace_push() */

EXTERN char_u   *escape_chars INIT(= (char_u *)" \t\\\"|");
/* need backslash in cmd line */

EXTERN int keep_help_flag INIT(= FALSE);      /* doing :ta from help file */

/*
 * When a string option is NULL (which only happens in out-of-memory
 * situations), it is set to empty_option, to avoid having to check for NULL
 * everywhere.
 */
EXTERN char_u   *empty_option INIT(= (char_u *)"");

EXTERN int redir_off INIT(= false);         // no redirection for a moment
EXTERN FILE *redir_fd INIT(= NULL);         // message redirection file
EXTERN int redir_reg INIT(= 0);             // message redirection register
EXTERN int redir_vname INIT(= 0);           // message redirection variable
EXTERN garray_T *capture_ga INIT(= NULL);   // captured output for execute()

EXTERN char_u langmap_mapchar[256];     /* mapping for language keys */

EXTERN int save_p_ls INIT(= -1);        /* Save 'laststatus' setting */
EXTERN int save_p_wmh INIT(= -1);       /* Save 'winminheight' setting */
EXTERN int wild_menu_showing INIT(= 0);
enum {
  WM_SHOWN = 1,     
  WM_SCROLLED = 2,  
  WM_LIST = 3,      
};


/*
 * Some file names are stored in pathdef.c, which is generated from the
 * Makefile to make their value depend on the Makefile.
 */
#ifdef HAVE_PATHDEF
extern char *default_vim_dir;
extern char *default_vimruntime_dir;
extern char_u *compiled_user;
extern char_u *compiled_sys;
#endif

/* When a window has a local directory, the absolute path of the global
 * current directory is stored here (in allocated memory).  If the current
 * directory is not a local directory, globaldir is NULL. */
EXTERN char_u   *globaldir INIT(= NULL);

/* Whether 'keymodel' contains "stopsel" and "startsel". */
EXTERN int km_stopsel INIT(= FALSE);
EXTERN int km_startsel INIT(= FALSE);

EXTERN int cedit_key INIT(= -1);     
EXTERN int cmdwin_type INIT(= 0);    
EXTERN int cmdwin_result INIT(= 0);  
EXTERN int cmdwin_level INIT(= 0);   

EXTERN char_u no_lines_msg[] INIT(= N_("--No lines in buffer--"));

/*
 * When ":global" is used to number of substitutions and changed lines is
 * accumulated until it's finished.
 * Also used for ":spellrepall".
 */
EXTERN long sub_nsubs;          /* total number of substitutions */
EXTERN linenr_T sub_nlines;     /* total number of lines changed */

/* table to store parsed 'wildmode' */
EXTERN char_u wim_flags[4];

/* whether titlestring and iconstring contains statusline syntax */
# define STL_IN_ICON    1
# define STL_IN_TITLE   2
EXTERN int stl_syntax INIT(= 0);

/* don't use 'hlsearch' temporarily */
EXTERN int no_hlsearch INIT(= FALSE);

/* Page number used for %N in 'pageheader' and 'guitablabel'. */
EXTERN linenr_T printer_page_num;


EXTERN bool typebuf_was_filled INIT(= false);     // received text from client
                                                  // or from feedkeys()


#ifdef BACKSLASH_IN_FILENAME
EXTERN char psepc INIT(= '\\');            // normal path separator character
EXTERN char psepcN INIT(= '/');            // abnormal path separator character
EXTERN char pseps[2] INIT(= { '\\', 0 });  // normal path separator string
#endif

// Set to kTrue when an operator is being executed with virtual editing
// kNone when no operator is being executed, kFalse otherwise.
EXTERN TriState virtual_op INIT(= kNone);

/* Display tick, incremented for each call to update_screen() */
EXTERN disptick_T display_tick INIT(= 0);

/* Line in which spell checking wasn't highlighted because it touched the
 * cursor position in Insert mode. */
EXTERN linenr_T spell_redraw_lnum INIT(= 0);

#ifdef USE_MCH_ERRMSG
// Grow array to collect error messages in until they can be displayed.
EXTERN garray_T error_ga INIT(= GA_EMPTY_INIT_VALUE);
#endif


/*
 * The error messages that can be shared are included here.
 * Excluded are errors that are only used once and debugging messages.
 */
EXTERN char_u e_abort[] INIT(= N_("E470: Command aborted"));
EXTERN char_u e_afterinit[] INIT(= N_(
        "E905: Cannot set this option after startup"));
EXTERN char_u e_api_spawn_failed[] INIT(= N_("E903: Could not spawn API job"));
EXTERN char_u e_argreq[] INIT(= N_("E471: Argument required"));
EXTERN char_u e_backslash[] INIT(= N_("E10: \\ should be followed by /, ? or &"));
EXTERN char_u e_cmdwin[] INIT(= N_(
        "E11: Invalid in command-line window; <CR> executes, CTRL-C quits"));
EXTERN char_u e_curdir[] INIT(= N_(
        "E12: Command not allowed from exrc/vimrc in current dir or tag search"));
EXTERN char_u e_endif[] INIT(= N_("E171: Missing :endif"));
EXTERN char_u e_endtry[] INIT(= N_("E600: Missing :endtry"));
EXTERN char_u e_endwhile[] INIT(= N_("E170: Missing :endwhile"));
EXTERN char_u e_endfor[] INIT(= N_("E170: Missing :endfor"));
EXTERN char_u e_while[] INIT(= N_("E588: :endwhile without :while"));
EXTERN char_u e_for[] INIT(= N_("E588: :endfor without :for"));
EXTERN char_u e_exists[] INIT(= N_("E13: File exists (add ! to override)"));
EXTERN char_u e_failed[] INIT(= N_("E472: Command failed"));
EXTERN char_u e_internal[] INIT(= N_("E473: Internal error"));
EXTERN char_u e_intern2[] INIT(= N_("E685: Internal error: %s"));
EXTERN char_u e_interr[] INIT(= N_("Interrupted"));
EXTERN char_u e_invaddr[] INIT(= N_("E14: Invalid address"));
EXTERN char_u e_invarg[] INIT(= N_("E474: Invalid argument"));
EXTERN char_u e_invarg2[] INIT(= N_("E475: Invalid argument: %s"));
EXTERN char_u e_duparg2[] INIT(= N_("E983: Duplicate argument: %s"));
EXTERN char_u e_invexpr2[] INIT(= N_("E15: Invalid expression: %s"));
EXTERN char_u e_invrange[] INIT(= N_("E16: Invalid range"));
EXTERN char_u e_invcmd[] INIT(= N_("E476: Invalid command"));
EXTERN char_u e_isadir2[] INIT(= N_("E17: \"%s\" is a directory"));
EXTERN char_u e_invchan[] INIT(= N_("E900: Invalid channel id"));
EXTERN char_u e_invchanjob[] INIT(= N_("E900: Invalid channel id: not a job"));
EXTERN char_u e_jobtblfull[] INIT(= N_("E901: Job table is full"));
EXTERN char_u e_jobspawn[] INIT(= N_(
    "E903: Process failed to start: %s: \"%s\""));
EXTERN char_u e_channotpty[] INIT(= N_("E904: channel is not a pty"));
EXTERN char_u e_stdiochan2[] INIT(= N_(
    "E905: Couldn't open stdio channel: %s"));
EXTERN char_u e_invstream[] INIT(= N_("E906: invalid stream for channel"));
EXTERN char_u e_invstreamrpc[] INIT(= N_(
    "E906: invalid stream for rpc channel, use 'rpc'"));
EXTERN char_u e_streamkey[] INIT(= N_(
    "E5210: dict key '%s' already set for buffered stream in channel %"
    PRIu64));
EXTERN char_u e_libcall[] INIT(= N_("E364: Library call failed for \"%s()\""));
EXTERN char e_fsync[] INIT(= N_("E667: Fsync failed: %s"));
EXTERN char_u e_mkdir[] INIT(= N_("E739: Cannot create directory %s: %s"));
EXTERN char_u e_markinval[] INIT(= N_("E19: Mark has invalid line number"));
EXTERN char_u e_marknotset[] INIT(= N_("E20: Mark not set"));
EXTERN char_u e_modifiable[] INIT(= N_(
        "E21: Cannot make changes, 'modifiable' is off"));
EXTERN char_u e_nesting[] INIT(= N_("E22: Scripts nested too deep"));
EXTERN char_u e_noalt[] INIT(= N_("E23: No alternate file"));
EXTERN char_u e_noabbr[] INIT(= N_("E24: No such abbreviation"));
EXTERN char_u e_nobang[] INIT(= N_("E477: No ! allowed"));
EXTERN char_u e_nogroup[] INIT(= N_("E28: No such highlight group name: %s"));
EXTERN char_u e_noinstext[] INIT(= N_("E29: No inserted text yet"));
EXTERN char_u e_nolastcmd[] INIT(= N_("E30: No previous command line"));
EXTERN char_u e_nomap[] INIT(= N_("E31: No such mapping"));
EXTERN char_u e_nomatch[] INIT(= N_("E479: No match"));
EXTERN char_u e_nomatch2[] INIT(= N_("E480: No match: %s"));
EXTERN char_u e_noname[] INIT(= N_("E32: No file name"));
EXTERN char_u e_nopresub[] INIT(= N_(
        "E33: No previous substitute regular expression"));
EXTERN char_u e_noprev[] INIT(= N_("E34: No previous command"));
EXTERN char_u e_noprevre[] INIT(= N_("E35: No previous regular expression"));
EXTERN char_u e_norange[] INIT(= N_("E481: No range allowed"));
EXTERN char_u e_noroom[] INIT(= N_("E36: Not enough room"));
EXTERN char_u e_notmp[] INIT(= N_("E483: Can't get temp file name"));
EXTERN char_u e_notopen[] INIT(= N_("E484: Can't open file %s"));
EXTERN char_u e_notopen_2[] INIT(= N_("E484: Can't open file %s: %s"));
EXTERN char_u e_notread[] INIT(= N_("E485: Can't read file %s"));
EXTERN char_u e_null[] INIT(= N_("E38: Null argument"));
EXTERN char_u e_number_exp[] INIT(= N_("E39: Number expected"));
EXTERN char_u e_openerrf[] INIT(= N_("E40: Can't open errorfile %s"));
EXTERN char_u e_outofmem[] INIT(= N_("E41: Out of memory!"));
EXTERN char_u e_patnotf[] INIT(= N_("Pattern not found"));
EXTERN char_u e_patnotf2[] INIT(= N_("E486: Pattern not found: %s"));
EXTERN char_u e_positive[] INIT(= N_("E487: Argument must be positive"));
EXTERN char_u e_prev_dir[] INIT(= N_(
        "E459: Cannot go back to previous directory"));

EXTERN char_u e_quickfix[] INIT(= N_("E42: No Errors"));
EXTERN char_u e_loclist[] INIT(= N_("E776: No location list"));
EXTERN char_u e_re_damg[] INIT(= N_("E43: Damaged match string"));
EXTERN char_u e_re_corr[] INIT(= N_("E44: Corrupted regexp program"));
EXTERN char_u e_readonly[] INIT(= N_(
    "E45: 'readonly' option is set (add ! to override)"));
EXTERN char_u e_readerrf[] INIT(= N_("E47: Error while reading errorfile"));
EXTERN char_u e_sandbox[] INIT(= N_("E48: Not allowed in sandbox"));
EXTERN char_u e_secure[] INIT(= N_("E523: Not allowed here"));
EXTERN char_u e_screenmode[] INIT(= N_(
        "E359: Screen mode setting not supported"));
EXTERN char_u e_scroll[] INIT(= N_("E49: Invalid scroll size"));
EXTERN char_u e_shellempty[] INIT(= N_("E91: 'shell' option is empty"));
EXTERN char_u e_signdata[] INIT(= N_("E255: Couldn't read in sign data!"));
EXTERN char_u e_swapclose[] INIT(= N_("E72: Close error on swap file"));
EXTERN char_u e_tagstack[] INIT(= N_("E73: tag stack empty"));
EXTERN char_u e_toocompl[] INIT(= N_("E74: Command too complex"));
EXTERN char_u e_longname[] INIT(= N_("E75: Name too long"));
EXTERN char_u e_toomsbra[] INIT(= N_("E76: Too many ["));
EXTERN char_u e_toomany[] INIT(= N_("E77: Too many file names"));
EXTERN char_u e_trailing[] INIT(= N_("E488: Trailing characters"));
EXTERN char_u e_trailing2[] INIT(= N_("E488: Trailing characters: %s"));
EXTERN char_u e_umark[] INIT(= N_("E78: Unknown mark"));
EXTERN char_u e_wildexpand[] INIT(= N_("E79: Cannot expand wildcards"));
EXTERN char_u e_winheight[] INIT(= N_(
        "E591: 'winheight' cannot be smaller than 'winminheight'"));
EXTERN char_u e_winwidth[] INIT(= N_(
        "E592: 'winwidth' cannot be smaller than 'winminwidth'"));
EXTERN char_u e_write[] INIT(= N_("E80: Error while writing"));
EXTERN char_u e_zerocount[] INIT(= N_("E939: Positive count required"));
EXTERN char_u e_usingsid[] INIT(= N_(
    "E81: Using <SID> not in a script context"));
EXTERN char_u e_maxmempat[] INIT(= N_(
        "E363: pattern uses more memory than 'maxmempattern'"));
EXTERN char_u e_emptybuf[] INIT(= N_("E749: empty buffer"));
EXTERN char_u e_nobufnr[] INIT(= N_("E86: Buffer %" PRId64 " does not exist"));

EXTERN char_u e_invalpat[] INIT(= N_(
        "E682: Invalid search pattern or delimiter"));
EXTERN char_u e_bufloaded[] INIT(= N_("E139: File is loaded in another buffer"));
EXTERN char_u e_notset[] INIT(= N_("E764: Option '%s' is not set"));
EXTERN char_u e_invalidreg[] INIT(= N_("E850: Invalid register name"));
EXTERN char_u e_dirnotf[] INIT(= N_(
    "E919: Directory not found in '%s': \"%s\""));
EXTERN char_u e_au_recursive[] INIT(= N_(
    "E952: Autocommand caused recursive behavior"));
EXTERN char_u e_unsupportedoption[] INIT(= N_("E519: Option not supported"));
EXTERN char_u e_fnametoolong[] INIT(= N_("E856: Filename too long"));
EXTERN char_u e_float_as_string[] INIT(= N_("E806: using Float as a String"));

EXTERN char_u e_autocmd_err[] INIT(=N_(
    "E5500: autocmd has thrown an exception: %s"));
EXTERN char_u e_cmdmap_err[] INIT(=N_(
    "E5520: <Cmd> mapping must end with <CR>"));
EXTERN char_u e_cmdmap_repeated[] INIT(=N_(
    "E5521: <Cmd> mapping must end with <CR> before second <Cmd>"));
EXTERN char_u e_cmdmap_key[] INIT(=N_(
    "E5522: <Cmd> mapping must not include %s key"));

EXTERN char_u e_api_error[] INIT(=N_(
    "E5555: API call: %s"));

EXTERN char_u e_floatonly[] INIT(=N_(
    "E5601: Cannot close window, only floating window would remain"));
EXTERN char_u e_floatexchange[] INIT(=N_(
    "E5602: Cannot exchange or rotate float"));


EXTERN char top_bot_msg[] INIT(= N_("search hit TOP, continuing at BOTTOM"));
EXTERN char bot_top_msg[] INIT(= N_("search hit BOTTOM, continuing at TOP"));

// For undo we need to know the lowest time possible.
EXTERN time_t starttime;

EXTERN FILE *time_fd INIT(= NULL);  /* where to write startup timing */

// Some compilers warn for not using a return value, but in some situations we
// can't do anything useful with the value.  Assign to this variable to avoid
// the warning.
EXTERN int vim_ignored;

// Start a msgpack-rpc channel over stdin/stdout.
EXTERN bool embedded_mode INIT(= false);
// Do not start a UI nor read/write to stdio (unless embedding).
EXTERN bool headless_mode INIT(= false);

typedef enum {
  kUnknown,
  kWorking,
  kBroken
} WorkingStatus;

typedef enum {
  kCdScopeInvalid = -1,
  kCdScopeWindow,  
  kCdScopeTab,     
  kCdScopeGlobal,  
} CdScope;

#define MIN_CD_SCOPE  kCdScopeWindow
#define MAX_CD_SCOPE  kCdScopeGlobal

#endif /* NVIM_GLOBALS_H */