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