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