/
api_2vim_8h.html
175 lines (168 loc) · 11 KB
/
api_2vim_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>Neovim: src/nvim/api/vim.h File Reference</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
<link href="extra.css" rel="stylesheet" type="text/css"/>
<link href="http://fonts.googleapis.com/css?family=Lato:400,700,900" rel="stylesheet">
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<header class="navbar">
<div class="container">
<nav class="site-nav">
<ul>
<li><a href="http://neovim.io/">Neovim Home</a></li>
</ul>
</nav>
<a href="index.html">
<img src="logo-devdoc.png" class="logo" alt="Neovim Dev-Doc">
</a>
</div>
</header>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_bc030da22f6f77ebb27ffd39b609bafa.html">nvim</a></li><li class="navelem"><a class="el" href="dir_5031ba7ba6e88ee94a8e02befd8c46c8.html">api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">vim.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <stdint.h></code><br />
<code>#include "<a class="el" href="api_2private_2defs_8h_source.html">nvim/api/private/defs.h</a>"</code><br />
<code>#include "<a class="el" href="map_8h_source.html">nvim/map.h</a>"</code><br />
</div>
<p><a href="api_2vim_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac5432d85188911e85dd484c1cefbb618"><td class="memItemLeft" align="right" valign="top"><a class="el" href="main_8c.html#a77366c1bd428629dc898e188bfd182a3">EXTERN</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="api_2vim_8h.html#ac5432d85188911e85dd484c1cefbb618">Map</a> (<a class="el" href="structString.html">String</a>, <a class="el" href="types_8h.html#a5fe5d437f595ae0cbe41e77669592921">handle_T</a>) *namespace_ids <a class="el" href="ui_8h.html#a27c21d4021bc9427736ecac6521891f0">INIT</a>(</td></tr>
<tr class="separator:ac5432d85188911e85dd484c1cefbb618"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a045b5f1427cff02e1962118a0ff75e98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="main_8c.html#a77366c1bd428629dc898e188bfd182a3">EXTERN</a> <a class="el" href="types_8h.html#a5fe5d437f595ae0cbe41e77669592921">handle_T</a> next_namespace_id </td><td class="memItemRight" valign="bottom"><a class="el" href="api_2vim_8h.html#a045b5f1427cff02e1962118a0ff75e98">INIT</a> (=1)</td></tr>
<tr class="memdesc:a045b5f1427cff02e1962118a0ff75e98"><td class="mdescLeft"> </td><td class="mdescRight">PROF_ values. <a href="api_2vim_8h.html#a045b5f1427cff02e1962118a0ff75e98">More...</a><br /></td></tr>
<tr class="separator:a045b5f1427cff02e1962118a0ff75e98"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a045b5f1427cff02e1962118a0ff75e98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045b5f1427cff02e1962118a0ff75e98">◆ </a></span>INIT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="main_8c.html#a77366c1bd428629dc898e188bfd182a3">EXTERN</a> int msg_scrolled_at_flush INIT </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>PROF_ values. </p>
<p>cmdline recursion level</p>
<p>result of cmdline window or 0</p>
<p>type of cmdline window or 0</p>
<p>key value of 'cedit' option</p>
<p>Stream to write script to.</p>
<p>Encoding used when 'fencs' is set to "default".</p>
<p>true when redoing Visual.</p>
<p>Type of Visual mode.</p>
<p>Whether Select mode is active.</p>
<p>Whether Visual mode is active.</p>
<p>Batch-mode: "-es" or "-Es" commandline argument was given.</p>
<p>Non-zero when the current buffer can't be changed. Used for FileChangedRO.</p>
<p>the previous argument list id</p>
<p>Lines left before a "more" message. Ex mode needs to be able to reset this after you type something.</p>
<p>Set when a throw that cannot be handled in <a class="el" href="ex__docmd_8c.html#af1389379522b3f5c8684393b4ce13f7d">do_cmdline()</a> must be propagated to the cstack of the previously called <a class="el" href="ex__docmd_8c.html#af1389379522b3f5c8684393b4ce13f7d">do_cmdline()</a>.</p>
<p>Set when a ":finish" or ":return" that cannot be handled in <a class="el" href="ex__docmd_8c.html#af1389379522b3f5c8684393b4ce13f7d">do_cmdline()</a> must be propagated to the cstack of the previously called <a class="el" href="ex__docmd_8c.html#af1389379522b3f5c8684393b4ce13f7d">do_cmdline()</a>.</p>
<p>Number of nested try conditionals (across function calls and ":source" commands).</p>
<p>When "force_abort" is true, always skip commands after an error message, even after the outermost ":endif", ":endwhile" or ":endfor" or for a function without the "abort" flag. It is set to true when "trylevel" is non-zero (and ":silent!" was not used) or an exception is being thrown at the time an error is detected. It is set to false when "trylevel" gets zero again and there was no error or interrupt or throw.</p>
<p>"msg_list" points to a variable in the stack of <a class="el" href="ex__docmd_8c.html#af1389379522b3f5c8684393b4ce13f7d">do_cmdline()</a> which keeps the list of arguments of several <a class="el" href="message_8c.html#a8dd7d7e6e1d4f531274a218c32884d36">emsg()</a> calls, one of which is to be converted to an error exception immediately after the failing command returns. The message to be used for the exception value is pointed to by the "throw_msg" field of the first element in the list. It is usually the same as the "msg" field of that element, but can be identical to the "msg" field of a later list element, when the "emsg_severe" flag was set when the <a class="el" href="message_8c.html#a8dd7d7e6e1d4f531274a218c32884d36">emsg()</a> call was made.</p>
<p>When set, don't convert an error to an exception. Used when displaying the interrupt message or reporting an exception that is still uncaught at the top level (which has already been discarded then). Also used for the error message when no exception can be thrown.</p>
<p>The stack of all caught and not finished exceptions. The exception on the top of the stack is the one got by evaluation of v:exception. The complete stack of all caught and pending exceptions is embedded in the various cstacks; the pending exceptions, however, are not on the caught stack.</p>
<p>Garbage collection can only take place when we are sure there are no Lists or Dictionaries being used internally. This is flagged with "may_garbage_collect" when we are at the toplevel. "want_garbage_collect" is set by the garbagecollect() function, which means we do garbage collection before waiting for a char at the toplevel. "garbage_collect_at_exit" indicates garbagecollect(1) was called.</p>
<p>Non-zero when only "safe" commands are allowed, e.g. when sourcing .exrc or .vimrc in current directory.</p>
<p>Non-zero when changing text and jumping to another window/buffer is not allowed.</p>
<p>Non-zero when no buffer name can be changed, no buffer can be deleted and current directory can't be changed. Used for SwapExists et al.</p>
<p>Non-zero when evaluating an expression in a "sandbox". Several things are not allowed then.</p>
<p>"State" is the main state of Vim. There are other variables that modify the state: Visual_mode: When State is NORMAL or INSERT. finish_op : When State is NORMAL, after typing the operator and before typing the motion command. motion_force: Last motion_force from <a class="el" href="normal_8c.html#adee6c2d2e497294bde891811eceeb135">do_pending_operator()</a> debug_mode: Debug mode </p>
</div>
</div>
<a id="ac5432d85188911e85dd484c1cefbb618"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5432d85188911e85dd484c1cefbb618">◆ </a></span>Map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="main_8c.html#a77366c1bd428629dc898e188bfd182a3">EXTERN</a> Map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structString.html">String</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5fe5d437f595ae0cbe41e77669592921">handle_T</a> </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<footer>
<div class="container">
Generated on Sat May 15 2021 05:47:36 for Neovim by
<a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.17
</div>
</footer>
</body>
</html>