annotate runtime/doc/netbeans.txt @ 5146:6ec6b7ff2d43 v7.4a

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