Merge PR #5651 from mhinz/vv/exitval

mhinz · web-flow · commit d2e8c76dc224 · 2016-12-01T15:00:58.000+01:00
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
@@ -1383,6 +1383,9 @@ v:dying		Normally zero.	When a deadly signal is caught it's set to
 <		Note: if another deadly signal is caught when v:dying is one,
 		VimLeave autocommands will not be executed.
 
+					*v:exiting* *exiting-variable*
+v:exiting	The exit value Nvim will use. Before exiting, it is |v:null|.
+
 					*v:errmsg* *errmsg-variable*
 v:errmsg	Last given error message.  It's allowed to set this variable.
 		Example: >
diff --git a/src/nvim/eval.c b/src/nvim/eval.c
@@ -394,6 +394,7 @@ static struct vimvar {
   VV(VV_TYPE_DICT,      "t_dict",           VAR_NUMBER, VV_RO),
   VV(VV_TYPE_FLOAT,     "t_float",          VAR_NUMBER, VV_RO),
   VV(VV_TYPE_BOOL,      "t_bool",           VAR_NUMBER, VV_RO),
+  VV(VV_EXITING,        "exiting",          VAR_NUMBER, VV_RO),
 };
 #undef VV
 
@@ -581,6 +582,7 @@ void eval_init(void)
   set_vim_var_special(VV_FALSE, kSpecialVarFalse);
   set_vim_var_special(VV_TRUE, kSpecialVarTrue);
   set_vim_var_special(VV_NULL, kSpecialVarNull);
+  set_vim_var_special(VV_EXITING, kSpecialVarNull);
 
   set_reg_var(0);  // default for v:register is not 0 but '"'
 }
@@ -17763,6 +17765,8 @@ void set_vcount(long count, long count1, int set_prevcount)
 /// @param[in]  val  Value to set to.
 void set_vim_var_nr(const VimVarIndex idx, const varnumber_T val)
 {
+  clear_tv(&vimvars[idx].vv_tv);
+  vimvars[idx].vv_type = VAR_NUMBER;
   vimvars[idx].vv_nr = val;
 }
 
@@ -17772,6 +17776,8 @@ void set_vim_var_nr(const VimVarIndex idx, const varnumber_T val)
 /// @param[in]  val  Value to set to.
 void set_vim_var_special(const VimVarIndex idx, const SpecialVarValue val)
 {
+  clear_tv(&vimvars[idx].vv_tv);
+  vimvars[idx].vv_type = VAR_SPECIAL;
   vimvars[idx].vv_special = val;
 }
 
diff --git a/src/nvim/eval.h b/src/nvim/eval.h
@@ -134,6 +134,7 @@ typedef enum {
     VV_TYPE_DICT,
     VV_TYPE_FLOAT,
     VV_TYPE_BOOL,
+    VV_EXITING,
 } VimVarIndex;
 
 /// All recognized msgpack types
diff --git a/src/nvim/main.c b/src/nvim/main.c
@@ -557,6 +557,8 @@ void getout(int exitval)
   if (exmode_active)
     exitval += ex_exitval;
 
+  set_vim_var_nr(VV_EXITING, exitval);
+
   /* Position the cursor on the last screen line, below all the text */
   ui_cursor_goto((int)Rows - 1, 0);
 
diff --git a/test/functional/core/exit_spec.lua b/test/functional/core/exit_spec.lua
@@ -0,0 +1,46 @@
+local helpers = require('test.functional.helpers')(after_each)
+
+local command = helpers.command
+local eval = helpers.eval
+local eq, neq = helpers.eq, helpers.neq
+local run = helpers.run
+
+describe('v:exiting', function()
+  local cid
+
+  before_each(function()
+    helpers.clear()
+    cid = helpers.nvim('get_api_info')[1]
+  end)
+
+  it('defaults to v:null', function()
+    eq(1, eval('v:exiting is v:null'))
+  end)
+
+  it('is 0 on normal exit', function()
+    local function on_setup()
+      command('autocmd VimLeavePre * call rpcrequest('..cid..', "")')
+      command('autocmd VimLeave    * call rpcrequest('..cid..', "")')
+      command('quit')
+    end
+    local function on_request()
+      eq(0, eval('v:exiting'))
+      return ''
+    end
+    run(on_request, nil, on_setup)
+  end)
+
+  it('is non-zero after :cquit', function()
+    local function on_setup()
+      command('autocmd VimLeavePre * call rpcrequest('..cid..', "")')
+      command('autocmd VimLeave    * call rpcrequest('..cid..', "")')
+      command('cquit')
+    end
+    local function on_request()
+      neq(0, eval('v:exiting'))
+      return ''
+    end
+    run(on_request, nil, on_setup)
+  end)
+
+end)

Original file line number	Diff line number	Diff line change
`@@ -394,6 +394,7 @@ static struct vimvar {`
`394`	`394`	`VV(VV_TYPE_DICT, "t_dict", VAR_NUMBER, VV_RO),`
`395`	`395`	`VV(VV_TYPE_FLOAT, "t_float", VAR_NUMBER, VV_RO),`
`396`	`396`	`VV(VV_TYPE_BOOL, "t_bool", VAR_NUMBER, VV_RO),`
	`397`	`+ VV(VV_EXITING, "exiting", VAR_NUMBER, VV_RO),`
`397`	`398`	`};`
`398`	`399`	`#undef VV`
`399`	`400`
`@@ -581,6 +582,7 @@ void eval_init(void)`
`581`	`582`	`set_vim_var_special(VV_FALSE, kSpecialVarFalse);`
`582`	`583`	`set_vim_var_special(VV_TRUE, kSpecialVarTrue);`
`583`	`584`	`set_vim_var_special(VV_NULL, kSpecialVarNull);`
	`585`	`+ set_vim_var_special(VV_EXITING, kSpecialVarNull);`
`584`	`586`
`585`	`587`	`set_reg_var(0); // default for v:register is not 0 but '"'`
`586`	`588`	`}`
`@@ -17763,6 +17765,8 @@ void set_vcount(long count, long count1, int set_prevcount)`
`17763`	`17765`	`/// @param[in] val Value to set to.`
`17764`	`17766`	`void set_vim_var_nr(const VimVarIndex idx, const varnumber_T val)`
`17765`	`17767`	`{`
	`17768`	`+ clear_tv(&vimvars[idx].vv_tv);`
	`17769`	`+ vimvars[idx].vv_type = VAR_NUMBER;`
`17766`	`17770`	`vimvars[idx].vv_nr = val;`
`17767`	`17771`	`}`
`17768`	`17772`
`@@ -17772,6 +17776,8 @@ void set_vim_var_nr(const VimVarIndex idx, const varnumber_T val)`
`17772`	`17776`	`/// @param[in] val Value to set to.`
`17773`	`17777`	`void set_vim_var_special(const VimVarIndex idx, const SpecialVarValue val)`
`17774`	`17778`	`{`
	`17779`	`+ clear_tv(&vimvars[idx].vv_tv);`
	`17780`	`+ vimvars[idx].vv_type = VAR_SPECIAL;`
`17775`	`17781`	`vimvars[idx].vv_special = val;`
`17776`	`17782`	`}`
`17777`	`17783`