Mercurial > vim
annotate runtime/doc/netbeans.txt @ 8271:770774e66011 v7.4.1428
commit https://github.com/vim/vim/commit/edb4f2b3601b0abd47091606269c0ac3244a805b
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Feb 27 15:27:23 2016 +0100
patch 7.4.1428
Problem: Compiler warning for non-virtual destructor.
Solution: Make it virtual. (Yasuhiro Matsumoto)
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sat, 27 Feb 2016 15:30:05 +0100 |
parents | f5da459c5698 |
children | 0bdeaf7092bc |
rev | line source |
---|---|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
1 *netbeans.txt* For Vim version 7.4. Last change: 2016 Feb 18 |
7 | 2 |
3 | |
1620 | 4 VIM REFERENCE MANUAL by Gordon Prieur et al. |
7 | 5 |
6 | |
7790
ca19726d5e83
commit https://github.com/vim/vim/commit/298b440930ecece38d6ea0505a3e582dc817e79b
Christian Brabandt <cb@256bit.org>
parents:
6697
diff
changeset
|
7 *netbeans* *netbeans-support* |
1620 | 8 |
9 Vim NetBeans Protocol: a socket interface for Vim integration into an IDE. | |
10 | |
7 | 11 1. Introduction |netbeans-intro| |
1620 | 12 2. Integration features |netbeans-integration| |
7 | 13 3. Configuring Vim for NetBeans |netbeans-configure| |
1620 | 14 4. Error Messages |netbeans-messages| |
15 5. Running Vim in NetBeans mode |netbeans-run| | |
16 6. NetBeans protocol |netbeans-protocol| | |
2210 | 17 7. NetBeans commands |netbeans-commands| |
1620 | 18 8. Known problems |netbeans-problems| |
19 9. Debugging NetBeans protocol |netbeans-debugging| | |
20 10. NetBeans External Editor | |
21 10.1. Downloading NetBeans |netbeans-download| | |
22 10.2. NetBeans Key Bindings |netbeans-keybindings| | |
23 10.3. Preparing NetBeans for Vim |netbeans-preparation| | |
24 10.4. Obtaining the External Editor Module |obtaining-exted| | |
25 10.5. Setting up NetBeans to run with Vim |netbeans-setup| | |
7 | 26 |
27 {Vi does not have any of these features} | |
28 {only available when compiled with the |+netbeans_intg| feature} | |
29 | |
30 ============================================================================== | |
31 1. Introduction *netbeans-intro* | |
32 | |
1620 | 33 The NetBeans interface was initially developed to integrate Vim into the |
34 NetBeans Java IDE, using the external editor plugin. This NetBeans plugin no | |
35 longer exists for recent versions of NetBeans but the protocol was developed | |
36 in such a way that any IDE can use it to integrate Vim. | |
37 | |
38 The NetBeans protocol of Vim is a text based communication protocol, over a | |
39 classical TCP socket. There is no dependency on Java or NetBeans. Any language | |
40 or environment providing a socket interface can control Vim using this | |
41 protocol. There are existing implementations in C, C++, Python and Java. The | |
42 name NetBeans is kept today for historical reasons. | |
43 | |
44 Current projects using the NetBeans protocol of Vim are: | |
45 - VimIntegration, description of various projects doing Vim Integration: | |
46 http://www.freehackers.org/VimIntegration | |
47 - Agide, an IDE for the AAP project, written in Python: | |
48 http://www.a-a-p.org | |
49 - Clewn, a gdb integration into Vim, written in C: | |
50 http://clewn.sourceforge.net/ | |
2210 | 51 - Pyclewn, a gdb integration into Vim, written in Python: |
52 http://pyclewn.sourceforge.net/ | |
1620 | 53 - VimPlugin, integration of Vim inside Eclipse: |
54 http://vimplugin.sourceforge.net/wiki/pmwiki.php | |
55 - PIDA, IDE written in Python integrating Vim: | |
56 http://pida.co.uk/ | |
57 - VimWrapper, library to easy Vim integration into IDE: | |
58 http://www.freehackers.org/VimWrapper | |
59 | |
60 Check the specific project pages to see how to use Vim with these projects. | |
61 | |
62 In the rest of this help page, we will use the term "Vim Controller" to | |
63 describe the program controlling Vim through the NetBeans socket interface. | |
64 | |
65 | |
66 About the NetBeans IDE ~ | |
67 | |
7 | 68 NetBeans is an open source Integrated Development Environment developed |
69 jointly by Sun Microsystems, Inc. and the netbeans.org developer community. | |
70 Initially just a Java IDE, NetBeans has had C, C++, and Fortran support added | |
71 in recent releases. | |
72 | |
1620 | 73 For more information visit the main NetBeans web site http://www.netbeans.org. |
1668 | 74 The External Editor is now, unfortunately, declared obsolete. See |
1620 | 75 http://externaleditor.netbeans.org. |
7 | 76 |
77 Sun Microsystems, Inc. also ships NetBeans under the name Sun ONE Studio. | |
78 Visit http://www.sun.com for more information regarding the Sun ONE Studio | |
79 product line. | |
80 | |
81 Current releases of NetBeans provide full support for Java and limited support | |
236 | 82 for C, C++, and Fortran. Current releases of Sun ONE Studio provide full |
7 | 83 support for Java, C, C++, and Fortran. |
84 | |
85 ============================================================================== | |
1620 | 86 2. Integration features *netbeans-integration* |
7 | 87 |
1620 | 88 The NetBeans socket interface of Vim allows to get information from Vim or to |
89 ask Vim to perform specific actions: | |
90 - get information about buffer: buffer name, cursor position, buffer content, | |
91 etc. | |
92 - be notified when buffers are open or closed | |
93 - be notified of how the buffer content is modified | |
94 - load and save files | |
95 - modify the buffer content | |
96 - installing special key bindings | |
97 - raise the window, control the window geometry | |
7 | 98 |
1620 | 99 For sending key strokes to Vim or for evaluating functions in Vim, you must |
100 use the |clientserver| interface. | |
7 | 101 |
102 | |
103 ============================================================================== | |
104 3. Configuring Vim for NetBeans *netbeans-configure* | |
105 | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
106 For more help about installing Vim, please read |usr_90.txt| in the Vim User |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
107 Manual. |
7 | 108 |
109 | |
1620 | 110 On Unix: |
111 -------- | |
7 | 112 |
113 When running configure without arguments the NetBeans interface should be | |
114 included. That is, if the configure check to find out if your system supports | |
115 the required features succeeds. | |
116 | |
117 In case you do not want the NetBeans interface you can disable it by | |
118 uncommenting a line with "--disable-netbeans" in the Makefile. | |
119 | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
120 Currently the NetBeans interface is supported by Vim running in a terminal and |
2592 | 121 by GVim when it is run with one of the following GUIs: GTK, GNOME, Windows, |
122 Athena and Motif. | |
7 | 123 |
236 | 124 If Motif support is required the user must supply XPM libraries. See |
7 | 125 |workshop-xpm| for details on obtaining the latest version of XPM. |
126 | |
127 | |
1620 | 128 On MS-Windows: |
129 -------------- | |
7 | 130 |
131 The Win32 support is now in beta stage. | |
132 | |
133 To use XPM signs on Win32 (e.g. when using with NetBeans) you can compile | |
134 XPM by yourself or use precompiled libraries from http://iamphet.nm.ru/misc/ | |
135 (for MS Visual C++) or http://gnuwin32.sourceforge.net (for MinGW). | |
136 | |
1620 | 137 Enable debugging: |
138 ----------------- | |
7 | 139 |
1620 | 140 To enable debugging of Vim and of the NetBeans protocol, the "NBDEBUG" macro |
141 needs to be defined. Search in the Makefile of the platform you are using for | |
142 "NBDEBUG" to see what line needs to be uncommented. This effectively adds | |
143 "-DNBDEBUG" to the compile command. Also see |netbeans-debugging| | |
7 | 144 |
145 ============================================================================== | |
1620 | 146 4. Error Messages *netbeans-messages* |
7 | 147 |
1620 | 148 These error messages are specific to NetBeans socket protocol: |
7 | 149 |
150 *E463* | |
151 Region is guarded, cannot modify | |
1620 | 152 The Vim Controller has defined guarded areas in the text, |
153 which you cannot change. Also sets the current buffer, if | |
154 necessary. | |
7 | 155 |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
156 *E532* |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
157 The defineAnnoType highlighting color name is too long |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
158 The maximum length of the "fg" or "bg" color argument in the |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
159 defineAnnoType command is 32 characters. |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
160 New in version 2.5. |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
161 |
7 | 162 *E656* |
1620 | 163 Writes of unmodified buffers forbidden |
164 Writes of unmodified buffers that were opened from the | |
165 Vim Controller are not possible. | |
7 | 166 |
167 *E657* | |
1620 | 168 Partial writes disallowed |
169 Partial writes for buffers that were opened from the | |
170 Vim Controller are not allowed. | |
7 | 171 |
172 *E658* | |
1620 | 173 Connection lost for this buffer |
174 The Vim Controller has become confused about the state of | |
175 this file. Rather than risk data corruption, it has severed | |
176 the connection for this file. Vim will take over | |
177 responsibility for saving changes to this file and the | |
178 Vim Controller will no longer know of these changes. | |
7 | 179 |
146 | 180 *E744* |
1620 | 181 Read-only file |
146 | 182 Vim normally allows changes to a read-only file and only |
183 enforces the read-only rule if you try to write the file. | |
184 However, NetBeans does not let you make changes to a file | |
1620 | 185 which is read-only and becomes confused if Vim does this. |
186 So Vim does not allow modifications to files when run | |
187 in NetBeans mode. | |
188 | |
7 | 189 ============================================================================== |
1620 | 190 5. Running Vim in NetBeans mode *netbeans-run* |
7 | 191 |
2210 | 192 There are two different ways to run Vim in NetBeans mode: |
193 | |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
194 + an IDE may start Vim with the |-nb| command line argument |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
195 + NetBeans can be started from within Vim with the |:nbstart| command |
2210 | 196 |
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
197 Vim uses a 3 second timeout on trying to make the connection. |
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
198 |
2210 | 199 *netbeans-parameters* |
200 Three forms can be used to setup the NetBeans connection parameters. | |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
201 When started from the command line, the |-nb| command line argument may be: |
7 | 202 |
203 -nb={fname} from a file | |
204 -nb:{hostname}:{addr}:{password} directly | |
205 -nb from a file or environment | |
206 | |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
207 When started from within Vim, the |:nbstart| optional argument may be: |
2210 | 208 |
209 ={fname} from a file | |
210 :{hostname}:{addr}:{password} directly | |
211 <MISSING ARGUMENT> from a file or environment | |
212 | |
7 | 213 *E660* *E668* |
2210 | 214 When NetBeans is started from the command line, for security reasons, the best |
215 method is to write the information in a file readable only by the user. The | |
216 name of the file can be passed with the "-nb={fname}" argument or, when "-nb" | |
217 is used without a parameter, the environment variable "__NETBEANS_CONINFO". | |
218 The file must contain these three lines, in any order: | |
7 | 219 |
220 host={hostname} | |
221 port={addr} | |
222 auth={password} | |
223 | |
2210 | 224 Other lines are ignored. The Vim Controller is responsible for deleting the |
7 | 225 file afterwards. |
226 | |
1620 | 227 {hostname} is the name of the machine where Vim Controller is running. When |
228 omitted the environment variable "__NETBEANS_HOST" is used or the default | |
229 "localhost". | |
7 | 230 |
1620 | 231 {addr} is the port number for the NetBeans interface. When omitted the |
232 environment variable "__NETBEANS_SOCKET" is used or the default 3219. | |
7 | 233 |
234 {password} is the password for connecting to NetBeans. When omitted the | |
235 environment variable "__NETBEANS_VIM_PASSWORD" is used or "changeme". | |
236 | |
1620 | 237 Vim will initiate a socket connection (client side) to the specified host and |
238 port upon startup. The password will be sent with the AUTH event when the | |
239 connection has been established. | |
240 | |
7 | 241 |
1620 | 242 ============================================================================== |
243 6. NetBeans protocol *netbeans-protocol* | |
244 | |
245 The communication between the Vim Controller and Vim uses plain text | |
246 messages. This protocol was first designed to work with the external editor | |
247 module of NetBeans. Later it was extended to work with Agide (A-A-P GUI IDE, | |
248 see http://www.a-a-p.org) and then with other IDE. The extensions are marked | |
249 with "version 2.1". | |
7 | 250 |
236 | 251 Version 2.2 of the protocol has several minor changes which should only affect |
252 NetBeans users (ie, not Agide users). However, a bug was fixed which could | |
253 cause confusion. The netbeans_saved() function sent a "save" protocol | |
254 command. In protocol version 2.1 and earlier this was incorrectly interpreted | |
255 as a notification that a write had taken place. In reality, it told NetBeans | |
256 to save the file so multiple writes were being done. This caused various | |
257 problems and has been fixed in 2.2. To decrease the likelihood of this | |
7 | 258 confusion happening again, netbeans_saved() has been renamed to |
259 netbeans_save_buffer(). | |
260 | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
261 We are now at version 2.5. For the differences between 2.4 and 2.5 search for |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
262 "2.5" below. |
718 | 263 |
7 | 264 The messages are currently sent over a socket. Since the messages are in |
265 plain UTF-8 text this protocol could also be used with any other communication | |
266 mechanism. | |
267 | |
3151 | 268 Netbeans messages are processed when Vim is idle, waiting for user input. |
269 When Vim is run in non-interactive mode, for example when running an automated | |
270 test case that sources a Vim script, the idle loop may not be called often | |
3312 | 271 enough. In that case, insert |:sleep| commands in the Vim script. The |:sleep| |
3151 | 272 command does invoke Netbeans messages processing. |
273 | |
1620 | 274 6.1 Kinds of messages |nb-messages| |
275 6.2 Terms |nb-terms| | |
276 6.3 Commands |nb-commands| | |
277 6.4 Functions and Replies |nb-functions| | |
278 6.5 Events |nb-events| | |
279 6.6 Special messages |nb-special| | |
280 6.7 Protocol errors |nb-protocol_errors| | |
718 | 281 |
282 | |
1620 | 283 6.1 Kinds of messages *nb-messages* |
7 | 284 |
285 There are four kinds of messages: | |
286 | |
287 kind direction comment ~ | |
288 Command IDE -> editor no reply necessary | |
289 Function IDE -> editor editor must send back a reply | |
290 Reply editor -> IDE only in response to a Function | |
291 Event editor -> IDE no reply necessary | |
292 | |
293 The messages are sent as a single line with a terminating newline character. | |
294 Arguments are separated by a single space. The first item of the message | |
295 depends on the kind of message: | |
296 | |
297 kind first item example ~ | |
298 Command bufID:name!seqno 11:showBalloon!123 "text" | |
299 Function bufID:name/seqno 11:getLength/123 | |
300 Reply seqno 123 5000 | |
1620 | 301 Event bufID:name=seqno 11:keyCommand=123 "S-F2" |
7 | 302 |
303 | |
1620 | 304 |
305 6.2 Terms *nb-terms* | |
7 | 306 |
307 bufID Buffer number. A message may be either for a specific buffer | |
308 or generic. Generic messages use a bufID of zero. NOTE: this | |
309 buffer ID is assigned by the IDE, it is not Vim's buffer | |
310 number. The bufID must be a sequentially rising number, | |
6697 | 311 starting at one. When the 'switchbuf' option is set to |
312 "usetab" and the "bufID" buffer is not found in the current | |
313 tab page, the netbeans commands and functions that set this | |
314 buffer as the current buffer will jump to the first open | |
315 window that contains this buffer in other tab pages instead of | |
316 replacing the buffer in the current window. | |
7 | 317 |
318 seqno The IDE uses a sequence number for Commands and Functions. A | |
319 Reply must use the sequence number of the Function that it is | |
320 associated with. A zero sequence number can be used for | |
321 Events (the seqno of the last received Command or Function can | |
322 also be used). | |
323 | |
324 string Argument in double quotes. Text is in UTF-8 encoding. This | |
325 means ASCII is passed as-is. Special characters are | |
326 represented with a backslash: | |
327 \" double quote | |
328 \n newline | |
329 \r carriage-return | |
330 \t tab (optional, also works literally) | |
331 \\ backslash | |
332 NUL bytes are not allowed! | |
333 | |
334 boolean Argument with two possible values: | |
335 T true | |
336 F false | |
337 | |
338 number Argument with a decimal number. | |
339 | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
340 color Argument with either a decimal number, "none" (without the |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
341 quotes) or the name of a color (without the quotes) defined |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
342 both in the color list in |highlight-ctermfg| and in the color |
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
343 list in |gui-colors|. |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
344 New in version 2.5. |
7 | 345 |
346 offset A number argument that indicates a byte position in a buffer. | |
347 The first byte has offset zero. Line breaks are counted for | |
348 how they appear in the file (CR/LF counts for two bytes). | |
349 Note that a multi-byte character is counted for the number of | |
350 bytes it takes. | |
351 | |
352 lnum/col Argument with a line number and column number position. The | |
353 line number starts with one, the column is the byte position, | |
354 starting with zero. Note that a multi-byte character counts | |
355 for several columns. | |
356 | |
357 pathname String argument: file name with full path. | |
358 | |
359 | |
1620 | 360 6.3 Commands *nb-commands* |
7 | 361 |
362 actionMenuItem Not implemented. | |
363 | |
364 actionSensitivity | |
365 Not implemented. | |
366 | |
367 addAnno serNum typeNum off len | |
368 Place an annotation in this buffer. | |
369 Arguments: | |
370 serNum number serial number of this placed | |
371 annotation, used to be able to remove | |
372 it | |
373 typeNum number sequence number of the annotation | |
374 defined with defineAnnoType for this | |
375 buffer | |
376 off number offset where annotation is to be placed | |
377 len number not used | |
378 In version 2.1 "lnum/col" can be used instead of "off". | |
379 | |
380 balloonResult text | |
381 Not implemented. | |
382 | |
383 close Close the buffer. This leaves us without current buffer, very | |
384 dangerous to use! | |
385 | |
386 create Creates a buffer without a name. Replaces the current buffer | |
387 (it's hidden when it was changed). | |
1620 | 388 The Vim Controller should use this as the first command for a |
389 file that is being opened. The sequence of commands could be: | |
7 | 390 create |
391 setCaretListener (ignored) | |
392 setModified (no effect) | |
393 setContentType (ignored) | |
394 startDocumentListen | |
395 setTitle | |
396 setFullName | |
397 | |
398 defineAnnoType typeNum typeName tooltip glyphFile fg bg | |
399 Define a type of annotation for this buffer. | |
400 Arguments: | |
401 typeNum number sequence number (not really used) | |
402 typeName string name that identifies this annotation | |
403 tooltip string not used | |
404 glyphFile string name of icon file | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
405 fg color foreground color for line highlighting |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
406 bg color background color for line highlighting |
7 | 407 Vim will define a sign for the annotation. |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
408 When color is a number, this is the "#rrggbb" Red, Green and |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
409 Blue values of the color (see |gui-colors|) and the |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
410 highlighting is only defined for GVim. |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
411 When color is a name, this color is defined both for Vim |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
412 running in a color terminal and for GVim. |
7 | 413 When both "fg" and "bg" are "none" no line highlighting is |
414 used (new in version 2.1). | |
415 When "glyphFile" is empty, no text sign is used (new in | |
416 version 2.1). | |
417 When "glyphFile" is one or two characters long, a text sign is | |
418 defined (new in version 2.1). | |
419 Note: the annotations will be defined in sequence, and the | |
420 sequence number is later used with addAnno. | |
421 | |
422 editFile pathname | |
423 Set the name for the buffer and edit the file "pathname", a | |
424 string argument. | |
1620 | 425 Normal way for the IDE to tell the editor to edit a file. |
426 | |
427 You must set a bufId different of 0 with this command to | |
428 assign a bufId to the buffer. It will trigger an event | |
429 fileOpened with a bufId of 0 but the buffer has been assigned. | |
430 | |
431 If the IDE is going to pass the file text to the editor use | |
432 these commands instead: | |
7 | 433 setFullName |
434 insert | |
435 initDone | |
436 New in version 2.1. | |
437 | |
438 enableBalloonEval | |
439 Not implemented. | |
440 | |
441 endAtomic End an atomic operation. The changes between "startAtomic" | |
442 and "endAtomic" can be undone as one operation. But it's not | |
443 implemented yet. Redraw when necessary. | |
444 | |
445 guard off len | |
446 Mark an area in the buffer as guarded. This means it cannot | |
447 be edited. "off" and "len" are numbers and specify the text | |
448 to be guarded. | |
449 | |
450 initDone Mark the buffer as ready for use. Implicitly makes the buffer | |
451 the current buffer. Fires the BufReadPost autocommand event. | |
452 | |
33 | 453 insertDone |
1620 | 454 Sent by Vim Controller to tell Vim an initial file insert is |
455 done. This triggers a read message being printed. Prior to | |
456 version 2.3, no read messages were displayed after opening a | |
457 file. New in version 2.3. | |
33 | 458 |
7 | 459 moveAnnoToFront serNum |
460 Not implemented. | |
461 | |
462 netbeansBuffer isNetbeansBuffer | |
1668 | 463 If "isNetbeansBuffer" is "T" then this buffer is "owned" by |
7 | 464 NetBeans. |
465 New in version 2.2. | |
466 | |
467 putBufferNumber pathname | |
468 Associate a buffer number with the Vim buffer by the name | |
469 "pathname", a string argument. To be used when the editor | |
470 reported editing another file to the IDE and the IDE needs to | |
471 tell the editor what buffer number it will use for this file. | |
472 Also marks the buffer as initialized. | |
473 New in version 2.1. | |
474 | |
475 raise Bring the editor to the foreground. | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
476 Only when Vim is run with a GUI. |
7 | 477 New in version 2.1. |
478 | |
479 removeAnno serNum | |
6259 | 480 Remove a previously placed annotation for this buffer. |
7 | 481 "serNum" is the same number used in addAnno. |
482 | |
483 save Save the buffer when it was modified. The other side of the | |
484 interface is expected to write the buffer and invoke | |
485 "setModified" to reset the "changed" flag of the buffer. | |
486 The writing is skipped when one of these conditions is true: | |
487 - 'write' is not set | |
488 - the buffer is read-only | |
489 - the buffer does not have a file name | |
490 - 'buftype' disallows writing | |
491 New in version 2.2. | |
492 | |
33 | 493 saveDone |
1620 | 494 Sent by Vim Controller to tell Vim a save is done. This |
495 triggers a save message being printed. Prior to version 2.3, | |
496 no save messages were displayed after a save. | |
33 | 497 New in version 2.3. |
498 | |
7 | 499 setAsUser Not implemented. |
500 | |
501 setBufferNumber pathname | |
502 Associate a buffer number with Vim buffer by the name | |
503 "pathname". To be used when the editor reported editing | |
504 another file to the IDE and the IDE needs to tell the editor | |
505 what buffer number it will use for this file. | |
506 Has the side effect of making the buffer the current buffer. | |
507 See "putBufferNumber" for a more useful command. | |
508 | |
509 setContentType | |
510 Not implemented. | |
511 | |
512 setDot off Make the buffer the current buffer and set the cursor at the | |
659 | 513 specified position. If the buffer is open in another window |
514 than make that window the current window. | |
515 If there are folds they are opened to make the cursor line | |
516 visible. | |
7 | 517 In version 2.1 "lnum/col" can be used instead of "off". |
518 | |
519 setExitDelay seconds | |
520 Set the delay for exiting to "seconds", a number. | |
521 This delay is used to give the IDE a chance to handle things | |
522 before really exiting. The default delay is two seconds. | |
523 New in version 2.1. | |
33 | 524 Obsolete in version 2.3. |
7 | 525 |
526 setFullName pathname | |
527 Set the file name to be used for a buffer to "pathname", a | |
528 string argument. | |
529 Used when the IDE wants to edit a file under control of the | |
530 IDE. This makes the buffer the current buffer, but does not | |
531 read the file. "insert" commands will be used next to set the | |
532 contents. | |
533 | |
534 setLocAndSize Not implemented. | |
535 | |
536 setMark Not implemented. | |
537 | |
538 setModified modified | |
539 When the boolean argument "modified" is "T" mark the buffer as | |
540 modified, when it is "F" mark it as unmodified. | |
541 | |
33 | 542 setModtime time |
1620 | 543 Update a buffers modification time after the file has been |
544 saved directly by the Vim Controller. | |
33 | 545 New in version 2.3. |
546 | |
547 setReadOnly | |
1620 | 548 Set a file as readonly |
549 Implemented in version 2.3. | |
7 | 550 |
551 setStyle Not implemented. | |
552 | |
553 setTitle name | |
554 Set the title for the buffer to "name", a string argument. | |
1620 | 555 The title is only used for the Vim Controller functions, not |
556 by Vim. | |
7 | 557 |
558 setVisible visible | |
559 When the boolean argument "visible" is "T", goto the buffer. | |
560 The "F" argument does nothing. | |
561 | |
562 showBalloon text | |
563 Show a balloon (popup window) at the mouse pointer position, | |
564 containing "text", a string argument. The balloon should | |
565 disappear when the mouse is moved more than a few pixels. | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
566 Only when Vim is run with a GUI. |
7 | 567 New in version 2.1. |
568 | |
33 | 569 specialKeys |
570 Map a set of keys (mostly function keys) to be passed back | |
1620 | 571 to the Vim Controller for processing. This lets regular IDE |
572 hotkeys be used from Vim. | |
33 | 573 Implemented in version 2.3. |
7 | 574 |
575 startAtomic Begin an atomic operation. The screen will not be updated | |
576 until "endAtomic" is given. | |
577 | |
578 startCaretListen | |
579 Not implemented. | |
580 | |
581 startDocumentListen | |
582 Mark the buffer to report changes to the IDE with the | |
583 "insert" and "remove" events. The default is to report | |
584 changes. | |
585 | |
586 stopCaretListen | |
587 Not implemented. | |
588 | |
589 stopDocumentListen | |
590 Mark the buffer to stop reporting changes to the IDE. | |
591 Opposite of startDocumentListen. | |
153 | 592 NOTE: if "netbeansBuffer" was used to mark this buffer as a |
593 NetBeans buffer, then the buffer is deleted in Vim. This is | |
594 for compatibility with Sun Studio 10. | |
7 | 595 |
596 unguard off len | |
597 Opposite of "guard", remove guarding for a text area. | |
659 | 598 Also sets the current buffer, if necessary. |
7 | 599 |
600 version Not implemented. | |
601 | |
602 | |
1620 | 603 6.4 Functions and Replies *nb-functions* |
7 | 604 |
605 getDot Not implemented. | |
606 | |
607 getCursor Return the current buffer and cursor position. | |
608 The reply is: | |
609 seqno bufID lnum col off | |
610 seqno = sequence number of the function | |
611 bufID = buffer ID of the current buffer (if this is unknown -1 | |
612 is used) | |
613 lnum = line number of the cursor (first line is one) | |
614 col = column number of the cursor (in bytes, zero based) | |
615 off = offset of the cursor in the buffer (in bytes) | |
616 New in version 2.1. | |
617 | |
618 getLength Return the length of the buffer in bytes. | |
619 Reply example for a buffer with 5000 bytes: | |
620 123 5000 | |
621 TODO: explain use of partial line. | |
622 | |
623 getMark Not implemented. | |
624 | |
1037 | 625 getAnno serNum |
626 Return the line number of the annotation in the buffer. | |
627 Argument: | |
628 serNum serial number of this placed annotation | |
629 The reply is: | |
630 123 lnum line number of the annotation | |
631 123 0 invalid annotation serial number | |
632 New in version 2.4. | |
633 | |
7 | 634 getModified When a buffer is specified: Return zero if the buffer does not |
635 have changes, one if it does have changes. | |
636 When no buffer is specified (buffer number zero): Return the | |
637 number of buffers with changes. When the result is zero it's | |
638 safe to tell Vim to exit. | |
639 New in version 2.1. | |
640 | |
641 getText Return the contents of the buffer as a string. | |
642 Reply example for a buffer with two lines | |
643 123 "first line\nsecond line\n" | |
644 NOTE: docs indicate an offset and length argument, but this is | |
645 not implemented. | |
646 | |
647 insert off text | |
648 Insert "text" before position "off". "text" is a string | |
649 argument, "off" a number. | |
1620 | 650 "text" should have a "\n" (newline) at the end of each line. |
718 | 651 Or "\r\n" when 'fileformat' is "dos". When using "insert" in |
652 an empty buffer Vim will set 'fileformat' accordingly. | |
653 When "off" points to the start of a line the text is inserted | |
654 above this line. Thus when "off" is zero lines are inserted | |
655 before the first line. | |
656 When "off" points after the start of a line, possibly on the | |
657 NUL at the end of a line, the first line of text is appended | |
658 to this line. Further lines come below it. | |
7 | 659 Possible replies: |
660 123 no problem | |
661 123 !message failed | |
662 Note that the message in the reply is not quoted. | |
659 | 663 Also sets the current buffer, if necessary. |
718 | 664 Does not move the cursor to the changed text. |
665 Resets undo information. | |
7 | 666 |
667 remove off length | |
668 Delete "length" bytes of text at position "off". Both | |
669 arguments are numbers. | |
670 Possible replies: | |
671 123 no problem | |
672 123 !message failed | |
673 Note that the message in the reply is not quoted. | |
659 | 674 Also sets the current buffer, if necessary. |
7 | 675 |
676 saveAndExit Perform the equivalent of closing Vim: ":confirm qall". | |
677 If there are no changed files or the user does not cancel the | |
678 operation Vim exits and no result is sent back. The IDE can | |
679 consider closing the connection as a successful result. | |
680 If the user cancels the operation the number of modified | |
681 buffers that remains is returned and Vim does not exit. | |
682 New in version 2.1. | |
683 | |
684 | |
1620 | 685 6.5 Events *nb-events* |
7 | 686 |
687 balloonEval off len type | |
688 The mouse pointer rests on text for a short while. When "len" | |
689 is zero, there is no selection and the pointer is at position | |
690 "off". When "len" is non-zero the text from position "off" to | |
691 "off" + "len" is selected. | |
692 Only sent after "enableBalloonEval" was used for this buffer. | |
693 "type" is not yet defined. | |
694 Not implemented yet. | |
695 | |
696 balloonText text | |
697 Used when 'ballooneval' is set and the mouse pointer rests on | |
698 some text for a moment. "text" is a string, the text under | |
699 the mouse pointer. | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
700 Only when Vim is run with a GUI. |
7 | 701 New in version 2.1. |
702 | |
703 buttonRelease button lnum col | |
704 Report which button was pressed and the location of the cursor | |
705 at the time of the release. Only for buffers that are owned | |
1620 | 706 by the Vim Controller. This event is not sent if the button |
707 was released while the mouse was in the status line or in a | |
236 | 708 separator line. If col is less than 1 the button release was |
7 | 709 in the sign area. |
710 New in version 2.2. | |
711 | |
33 | 712 disconnect |
1620 | 713 Tell the Vim Controller that Vim is exiting and not to try and |
714 read or write more commands. | |
33 | 715 New in version 2.3. |
716 | |
7 | 717 fileClosed Not implemented. |
718 | |
719 fileModified Not implemented. | |
720 | |
721 fileOpened pathname open modified | |
722 A file was opened by the user. | |
723 Arguments: | |
724 pathname string name of the file | |
725 open boolean always "T" | |
726 modified boolean always "F" | |
727 | |
728 geometry cols rows x y | |
729 Report the size and position of the editor window. | |
730 Arguments: | |
731 cols number number of text columns | |
732 rows number number of text rows | |
733 x number pixel position on screen | |
734 y number pixel position on screen | |
735 Only works for Motif. | |
736 | |
737 insert off text | |
738 Text "text" has been inserted in Vim at position "off". | |
739 Only fired when enabled, see "startDocumentListen". | |
740 | |
741 invokeAction Not implemented. | |
742 | |
743 keyCommand keyName | |
744 Reports a special key being pressed with name "keyName", which | |
745 is a string. | |
746 Supported key names: | |
747 F1 function key 1 | |
748 F2 function key 2 | |
749 ... | |
750 F12 function key 12 | |
751 | |
752 ' ' space (without the quotes) | |
753 ! exclamation mark | |
754 ... any other ASCII printable character | |
755 ~ tilde | |
756 | |
757 X any unrecognized key | |
758 | |
759 The key may be prepended by "C", "S" and/or "M" for Control, | |
760 Shift and Meta (Alt) modifiers. If there is a modifier a dash | |
761 is used to separate it from the key name. For example: | |
762 "C-F2". | |
763 ASCII characters are new in version 2.1. | |
764 | |
765 keyAtPos keyName lnum/col | |
766 Like "keyCommand" and also report the line number and column | |
767 of the cursor. | |
768 New in version 2.1. | |
769 | |
1781 | 770 killed A file was deleted or wiped out by the user and the buffer |
771 annotations have been removed. The bufID number for this | |
772 buffer has become invalid. Only for files that have been | |
773 assigned a bufID number by the IDE. | |
7 | 774 |
775 newDotAndMark off off | |
776 Reports the position of the cursor being at "off" bytes into | |
777 the buffer. Only sent just before a "keyCommand" event. | |
778 | |
779 quit Not implemented. | |
780 | |
781 remove off len | |
782 Text was deleted in Vim at position "off" with byte length | |
783 "len". | |
784 Only fired when enabled, see "startDocumentListen". | |
785 | |
786 revert Not implemented. | |
787 | |
788 save The buffer has been saved and is now unmodified. | |
789 Only fired when enabled, see "startDocumentListen". | |
790 | |
791 startupDone The editor has finished its startup work and is ready for | |
792 editing files. | |
793 New in version 2.1. | |
794 | |
795 unmodified The buffer is now unmodified. | |
796 Only fired when enabled, see "startDocumentListen". | |
797 | |
798 version vers Report the version of the interface implementation. Vim | |
1620 | 799 reports "2.4" (including the quotes). |
7 | 800 |
801 | |
1620 | 802 6.6 Special messages *nb-special* |
7 | 803 |
804 These messages do not follow the style of the messages above. They are | |
805 terminated by a newline character. | |
806 | |
807 ACCEPT Not used. | |
808 | |
809 AUTH password editor -> IDE: First message that the editor sends to the IDE. | |
810 Must contain the password for the socket server, as specified | |
811 with the |-nb| argument. No quotes are used! | |
812 | |
813 DISCONNECT IDE -> editor: break the connection. The editor will exit. | |
814 The IDE must only send this message when there are no unsaved | |
815 changes! | |
816 | |
817 DETACH IDE -> editor: break the connection without exiting the | |
818 editor. Used when the IDE exits without bringing down the | |
819 editor as well. | |
820 New in version 2.1. | |
821 | |
822 REJECT Not used. | |
823 | |
1620 | 824 |
825 6.7 Protocol errors *nb-protocol_errors* | |
826 | |
827 These errors occur when a message violates the protocol: | |
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7790
diff
changeset
|
828 *E627* *E628* *E629* *E632* *E633* *E634* *E635* *E636* |
1620 | 829 *E637* *E638* *E639* *E640* *E641* *E642* *E643* *E644* *E645* *E646* |
830 *E647* *E648* *E649* *E650* *E651* *E652* *E653* *E654* | |
831 | |
832 | |
7 | 833 ============================================================================== |
2210 | 834 7. NetBeans commands *netbeans-commands* |
835 | |
2596 | 836 *:nbstart* *E511* *E838* |
2210 | 837 :nbs[tart] {connection} Start a new Netbeans session with {connection} as the |
838 socket connection parameters. The format of | |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
839 {connection} is described in |netbeans-parameters|. |
2210 | 840 At any time, one may check if the netbeans socket is |
841 connected by running the command: | |
842 ':echo has("netbeans_enabled")' | |
843 | |
844 *:nbclose* | |
845 :nbc[lose] Close the current NetBeans session. Remove all placed | |
846 signs. | |
146 | 847 |
848 *:nbkey* | |
3151 | 849 :nb[key] {key} Pass the {key} to the Vim Controller for processing. |
850 When a hot-key has been installed with the specialKeys | |
851 command, this command can be used to generate a hotkey | |
852 message to the Vim Controller. | |
853 This command can also be used to pass any text to the | |
854 Vim Controller. It is used by Pyclewn, for example, | |
855 to build the complete set of gdb commands as Vim user | |
856 commands. | |
857 The events newDotAndMark, keyCommand and keyAtPos are | |
858 generated (in this order). | |
1620 | 859 |
146 | 860 |
861 ============================================================================== | |
1620 | 862 8. Known problems *netbeans-problems* |
7 | 863 |
864 NUL bytes are not possible. For editor -> IDE they will appear as NL | |
865 characters. For IDE -> editor they cannot be inserted. | |
866 | |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
867 A NetBeans session may be initiated with Vim running in a terminal, and |
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
868 continued later in a GUI environment after running the |:gui| command. In this |
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
869 case, the highlighting defined for the NetBeans annotations may be cleared |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
870 when the ":gui" command sources .gvimrc and this file loads a colorscheme |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
871 that runs the command ":highlight clear". |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
872 New in version 2.5. |
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
873 |
7 | 874 |
1620 | 875 ============================================================================== |
876 9. Debugging NetBeans protocol *netbeans-debugging* | |
877 | |
878 To debug the Vim protocol, you must first compile Vim with debugging support | |
879 and NetBeans debugging support. See |netbeans-configure| for instructions | |
880 about Vim compiling and how to enable debug support. | |
881 | |
882 When running Vim, set the following environment variables: | |
883 | |
884 export SPRO_GVIM_DEBUG=netbeans.log | |
885 export SPRO_GVIM_DLEVEL=0xffffffff | |
886 | |
887 Vim will then log all the incoming and outgoing messages of the NetBeans | |
888 protocol to the file netbeans.log . | |
889 | |
890 The content of netbeans.log after a session looks like this: | |
891 Tue May 20 17:19:27 2008 | |
892 EVT: 0:startupDone=0 | |
893 CMD 1: (1) create | |
894 CMD 2: (1) setTitle "testfile1.txt" | |
895 CMD 3: (1) setFullName "testfile1.txt" | |
896 EVT(suppressed): 1:remove=3 0 -1 | |
897 EVT: 1:fileOpened=0 "d:\\work\\vimWrapper\\vimWrapper2\\pyvimwrapper\\tests\\testfile1.txt" T F | |
898 CMD 4: (1) initDone | |
899 FUN 5: (0) getCursor | |
900 REP 5: 1 1 0 0 | |
901 CMD 6: (2) create | |
902 CMD 7: (2) setTitle "testfile2.txt" | |
903 CMD 8: (2) setFullName "testfile2.txt" | |
904 EVT(suppressed): 2:remove=8 0 -1 | |
905 EVT: 2:fileOpened=0 "d:\\work\\vimWrapper\\vimWrapper2\\pyvimwrapper\\tests\\testfile2.txt" T F | |
906 CMD 9: (2) initDone | |
907 | |
908 | |
909 ============================================================================== | |
910 10. NetBeans External Editor | |
911 | |
912 NOTE: This information is obsolete! Only relevant if you are using an old | |
913 version of NetBeans. | |
914 | |
915 | |
916 10.1. Downloading NetBeans *netbeans-download* | |
917 | |
918 The NetBeans IDE is available for download from netbeans.org. You can download | |
919 a released version, download sources, or use CVS to download the current | |
920 source tree. If you choose to download sources, follow directions from | |
921 netbeans.org on building NetBeans. | |
922 | |
923 Depending on the version of NetBeans you download, you may need to do further | |
924 work to get the required External Editor module. This is the module which lets | |
925 NetBeans work with gvim (or xemacs :-). See http://externaleditor.netbeans.org | |
926 for details on downloading this module if your NetBeans release does not have | |
927 it. | |
928 | |
929 For C, C++, and Fortran support you will also need the cpp module. See | |
930 http://cpp.netbeans.org for information regarding this module. | |
931 | |
932 You can also download Sun ONE Studio from Sun Microsystems, Inc for a 30 day | |
933 free trial. See http://www.sun.com for further details. | |
934 | |
935 | |
936 10.2. NetBeans Key Bindings *netbeans-keybindings* | |
937 | |
938 Vim understands a number of key bindings that execute NetBeans commands. | |
939 These are typically all the Function key combinations. To execute a NetBeans | |
940 command, the user must press the Pause key followed by a NetBeans key binding. | |
941 For example, in order to compile a Java file, the NetBeans key binding is | |
942 "F9". So, while in vim, press "Pause F9" to compile a java file. To toggle a | |
943 breakpoint at the current line, press "Pause Shift F8". | |
944 | |
945 The Pause key is Function key 21. If you don't have a working Pause key and | |
946 want to use F8 instead, use: > | |
947 | |
948 :map <F8> <F21> | |
949 | |
950 The External Editor module dynamically reads the NetBeans key bindings so vim | |
951 should always have the latest key bindings, even when NetBeans changes them. | |
952 | |
953 | |
954 10.3. Preparing NetBeans for Vim *netbeans-preparation* | |
955 | |
956 In order for NetBeans to work with vim, the NetBeans External Editor module | |
957 must be loaded and enabled. If you have a Sun ONE Studio Enterprise Edition | |
958 then this module should be loaded and enabled. If you have a NetBeans release | |
959 you may need to find another way of obtaining this open source module. | |
960 | |
961 You can check if you have this module by opening the Tools->Options dialog | |
962 and drilling down to the "Modules" list (IDE Configuration->System->Modules). | |
963 If your Modules list has an entry for "External Editor" you must make sure | |
964 it is enabled (the "Enabled" property should have the value "True"). If your | |
965 Modules list has no External Editor see the next section on |obtaining-exted|. | |
966 | |
967 | |
968 10.4. Obtaining the External Editor Module *obtaining-exted* | |
969 | |
970 There are 2 ways of obtaining the External Editor module. The easiest way | |
971 is to use the NetBeans Update Center to download and install the module. | |
972 Unfortunately, some versions do not have this module in their update | |
973 center. If you cannot download via the update center you will need to | |
974 download sources and build the module. I will try and get the module | |
975 available from the NetBeans Update Center so building will be unnecessary. | |
976 Also check http://externaleditor.netbeans.org for other availability options. | |
977 | |
978 To download the External Editor sources via CVS and build your own module, | |
979 see http://externaleditor.netbeans.org and http://www.netbeans.org. | |
980 Unfortunately, this is not a trivial procedure. | |
981 | |
982 | |
983 10.5. Setting up NetBeans to run with Vim *netbeans-setup* | |
984 | |
985 Assuming you have loaded and enabled the NetBeans External Editor module | |
986 as described in |netbeans-preparation| all you need to do is verify that | |
987 the gvim command line is properly configured for your environment. | |
988 | |
989 Open the Tools->Options dialog and open the Editing category. Select the | |
990 External Editor. The right hand pane should contain a Properties tab and | |
991 an Expert tab. In the Properties tab make sure the "Editor Type" is set | |
992 to "Vim". In the Expert tab make sure the "Vim Command" is correct. | |
993 | |
994 You should be careful if you change the "Vim Command". There are command | |
995 line options there which must be there for the connection to be properly | |
996 set up. You can change the command name but that's about it. If your gvim | |
997 can be found by your $PATH then the VIM Command can start with "gvim". If | |
998 you don't want gvim searched from your $PATH then hard code in the full | |
999 Unix path name. At this point you should get a gvim for any source file | |
1000 you open in NetBeans. | |
1001 | |
1002 If some files come up in gvim and others (with different file suffixes) come | |
1003 up in the default NetBeans editor you should verify the MIME type in the | |
1004 Expert tab MIME Type property. NetBeans is MIME oriented and the External | |
1005 Editor will only open MIME types specified in this property. | |
1006 | |
1007 | |
7 | 1008 vim:tw=78:ts=8:ft=help:norl: |