Mercurial > vim
annotate runtime/doc/if_mzsch.txt @ 9759:0084e5d34750
Added tag v7.4.2154 for changeset 5534cfa2ec877d14864d3fad8003b12d67e07a0f
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Thu, 04 Aug 2016 21:15:05 +0200 |
parents | 5f6f35a3cb12 |
children | 715d6c5707b8 |
rev | line source |
---|---|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
1 *if_mzsch.txt* For Vim version 7.4. Last change: 2016 Jan 24 |
14 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Sergey Khorev | |
5 | |
6 | |
7 The MzScheme Interface to Vim *mzscheme* *MzScheme* | |
8 | |
9 1. Commands |mzscheme-commands| | |
10 2. Examples |mzscheme-examples| | |
11 3. Threads |mzscheme-threads| | |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
12 4. Vim access from MzScheme |mzscheme-vim| |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
13 5. mzeval() Vim function |mzscheme-mzeval| |
4074 | 14 6. Using Function references |mzscheme-funcref| |
15 7. Dynamic loading |mzscheme-dynamic| | |
7609
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
16 8. MzScheme setup |mzscheme-setup| |
14 | 17 |
18 {Vi does not have any of these commands} | |
19 | |
20 The MzScheme interface is available only if Vim was compiled with the | |
21 |+mzscheme| feature. | |
22 | |
23 Based on the work of Brent Fulgham. | |
128 | 24 Dynamic loading added by Sergey Khorev |
14 | 25 |
4074 | 26 MzScheme and PLT Scheme names have been rebranded as Racket. For more |
27 information please check http://racket-lang.org | |
14 | 28 |
4074 | 29 Futures and places of Racket version 5.x up to and including 5.3.1 do not |
30 work correctly with processes created by Vim. | |
31 The simplest solution is to build Racket on your own with these features | |
32 disabled: > | |
33 ./configure --disable-futures --disable-places --prefix=your-install-prefix | |
34 | |
35 To speed up the process, you might also want to use --disable-gracket and | |
36 --disable-docs | |
1121 | 37 |
14 | 38 ============================================================================== |
39 1. Commands *mzscheme-commands* | |
40 | |
41 *:mzscheme* *:mz* | |
42 :[range]mz[scheme] {stmt} | |
43 Execute MzScheme statement {stmt}. {not in Vi} | |
44 | |
45 :[range]mz[scheme] << {endmarker} | |
46 {script} | |
47 {endmarker} | |
48 Execute inlined MzScheme script {script}. | |
49 Note: This command doesn't work if the MzScheme | |
50 feature wasn't compiled in. To avoid errors, see | |
51 |script-here|. | |
52 | |
53 *:mzfile* *:mzf* | |
54 :[range]mzf[ile] {file} Execute the MzScheme script in {file}. {not in Vi} | |
55 | |
56 All of these commands do essentially the same thing - they execute a piece of | |
57 MzScheme code, with the "current range" set to the given line | |
58 range. | |
59 | |
60 In the case of :mzscheme, the code to execute is in the command-line. | |
61 In the case of :mzfile, the code to execute is the contents of the given file. | |
62 | |
63 MzScheme interface defines exception exn:vim, derived from exn. | |
64 It is raised for various Vim errors. | |
65 | |
66 During compilation, the MzScheme interface will remember the current MzScheme | |
67 collection path. If you want to specify additional paths use the | |
68 'current-library-collection-paths' parameter. E.g., to cons the user-local | |
69 MzScheme collection path: > | |
70 :mz << EOF | |
71 (current-library-collection-paths | |
72 (cons | |
73 (build-path (find-system-path 'addon-dir) (version) "collects") | |
74 (current-library-collection-paths))) | |
75 EOF | |
76 < | |
77 | |
78 All functionality is provided through module vimext. | |
79 | |
80 The exn:vim is available without explicit import. | |
81 | |
82 To avoid clashes with MzScheme, consider using prefix when requiring module, | |
83 e.g.: > | |
84 :mzscheme (require (prefix vim- vimext)) | |
85 < | |
1894 | 86 All the examples below assume this naming scheme. |
14 | 87 |
273 | 88 *mzscheme-sandbox* |
89 When executed in the |sandbox|, access to some filesystem and Vim interface | |
90 procedures is restricted. | |
14 | 91 |
92 ============================================================================== | |
93 2. Examples *mzscheme-examples* | |
94 > | |
95 :mzscheme (display "Hello") | |
1894 | 96 :mz (display (string-append "Using MzScheme version " (version))) |
97 :mzscheme (require (prefix vim- vimext)) ; for MzScheme < 4.x | |
98 :mzscheme (require (prefix-in vim- 'vimext)) ; MzScheme 4.x | |
14 | 99 :mzscheme (vim-set-buff-line 10 "This is line #10") |
100 < | |
101 Inline script usage: > | |
102 function! <SID>SetFirstLine() | |
103 :mz << EOF | |
104 (display "!!!") | |
1894 | 105 (require (prefix vim- vimext)) |
106 ; for newer versions (require (prefix-in vim- 'vimext)) | |
14 | 107 (vim-set-buff-line 1 "This is line #1") |
108 (vim-beep) | |
1894 | 109 EOF |
14 | 110 endfunction |
111 | |
112 nmap <F9> :call <SID>SetFirstLine() <CR> | |
113 < | |
114 File execution: > | |
115 :mzfile supascript.scm | |
116 < | |
1894 | 117 Vim exception handling: > |
118 :mz << EOF | |
119 (require (prefix vim- vimext)) | |
120 ; for newer versions (require (prefix-in vim- 'vimext)) | |
121 (with-handlers | |
122 ([exn:vim? (lambda (e) (display (exn-message e)))]) | |
123 (vim-eval "nonsense-string")) | |
124 EOF | |
14 | 125 < |
1894 | 126 Auto-instantiation of vimext module (can be placed in your |vimrc|): > |
127 function! MzRequire() | |
128 :redir => l:mzversion | |
129 :mz (version) | |
130 :redir END | |
131 if strpart(l:mzversion, 1, 1) < "4" | |
132 " MzScheme versions < 4.x: | |
133 :mz (require (prefix vim- vimext)) | |
134 else | |
135 " newer versions: | |
136 :mz (require (prefix-in vim- 'vimext)) | |
137 endif | |
138 endfunction | |
14 | 139 |
1894 | 140 if has("mzscheme") |
141 silent call MzRequire() | |
142 endif | |
143 < | |
14 | 144 ============================================================================== |
145 3. Threads *mzscheme-threads* | |
146 | |
147 The MzScheme interface supports threads. They are independent from OS threads, | |
148 thus scheduling is required. The option 'mzquantum' determines how often | |
149 Vim should poll for available MzScheme threads. | |
150 NOTE | |
151 Thread scheduling in the console version of Vim is less reliable than in the | |
152 GUI version. | |
153 | |
154 ============================================================================== | |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
155 4. Vim access from MzScheme *mzscheme-vim* |
14 | 156 |
157 *mzscheme-vimext* | |
158 The 'vimext' module provides access to procedures defined in the MzScheme | |
159 interface. | |
160 | |
161 Common | |
162 ------ | |
163 (command {command-string}) Perform the vim ":Ex" style command. | |
1894 | 164 (eval {expr-string}) Evaluate the vim expression into |
165 respective MzScheme object: |Lists| are | |
166 represented as Scheme lists, | |
4074 | 167 |Dictionaries| as hash tables, |
168 |Funcref|s as functions (see also | |
169 |mzscheme-funcref|) | |
170 NOTE the name clashes with MzScheme eval, | |
171 use module qualifiers to overcome this. | |
14 | 172 (range-start) Start/End of the range passed with |
173 (range-end) the Scheme command. | |
174 (beep) beep | |
175 (get-option {option-name} [buffer-or-window]) Get Vim option value (either | |
176 local or global, see set-option). | |
177 (set-option {string} [buffer-or-window]) | |
178 Set a Vim option. String must have option | |
179 setting form (like optname=optval, or | |
180 optname+=optval, etc.) When called with | |
181 {buffer} or {window} the local option will | |
182 be set. The symbol 'global can be passed | |
183 as {buffer-or-window}. Then |:setglobal| | |
184 will be used. | |
185 | |
186 Buffers *mzscheme-buffer* | |
187 ------- | |
188 (buff? {object}) Is object a buffer? | |
189 (buff-valid? {object}) Is object a valid buffer? (i.e. | |
190 corresponds to the real Vim buffer) | |
191 (get-buff-line {linenr} [buffer]) | |
192 Get line from a buffer. | |
193 (set-buff-line {linenr} {string} [buffer]) | |
194 Set a line in a buffer. If {string} is #f, | |
195 the line gets deleted. The [buffer] | |
856 | 196 argument is optional. If omitted, the |
197 current buffer will be used. | |
14 | 198 (get-buff-line-list {start} {end} [buffer]) |
199 Get a list of lines in a buffer. {Start} | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2050
diff
changeset
|
200 and {end} are 1-based and inclusive. |
14 | 201 (set-buff-line-list {start} {end} {string-list} [buffer]) |
202 Set a list of lines in a buffer. If | |
203 string-list is #f or null, the lines get | |
204 deleted. If a list is shorter than | |
205 {end}-{start} the remaining lines will | |
206 be deleted. | |
207 (get-buff-name [buffer]) Get a buffer's text name. | |
208 (get-buff-num [buffer]) Get a buffer's number. | |
209 (get-buff-size [buffer]) Get buffer line count. | |
210 (insert-buff-line-list {linenr} {string/string-list} [buffer]) | |
211 Insert a list of lines into a buffer after | |
212 {linenr}. If {linenr} is 0, lines will be | |
213 inserted at start. | |
2098
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2050
diff
changeset
|
214 (curr-buff) Get the current buffer. Use other MzScheme |
3259c3923c1e
Updated runtime an documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
2050
diff
changeset
|
215 interface procedures to change it. |
14 | 216 (buff-count) Get count of total buffers in the editor. |
217 (get-next-buff [buffer]) Get next buffer. | |
218 (get-prev-buff [buffer]) Get previous buffer. Return #f when there | |
219 are no more buffers. | |
220 (open-buff {filename}) Open a new buffer (for file "name") | |
221 (get-buff-by-name {buffername}) Get a buffer by its filename or #f | |
222 if there is no such buffer. | |
223 (get-buff-by-num {buffernum}) Get a buffer by its number (return #f if | |
224 there is no buffer with this number). | |
225 | |
226 Windows *mzscheme-window* | |
227 ------ | |
228 (win? {object}) Is object a window? | |
229 (win-valid? {object}) Is object a valid window (i.e. corresponds | |
230 to the real Vim window)? | |
231 (curr-win) Get the current window. | |
232 (win-count) Get count of windows. | |
233 (get-win-num [window]) Get window number. | |
234 (get-win-by-num {windownum}) Get window by its number. | |
235 (get-win-buffer [window]) Get the buffer for a given window. | |
236 (get-win-height [window]) | |
237 (set-win-height {height} [window]) Get/Set height of window. | |
238 (get-win-width [window]) | |
239 (set-win-width {width} [window])Get/Set width of window. | |
240 (get-win-list [buffer]) Get list of windows for a buffer. | |
241 (get-cursor [window]) Get cursor position in a window as | |
242 a pair (linenr . column). | |
243 (set-cursor (line . col) [window]) Set cursor position. | |
244 | |
625 | 245 ============================================================================== |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
246 5. mzeval() Vim function *mzscheme-mzeval* |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
247 |
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
248 To facilitate bi-directional interface, you can use |mzeval()| function to |
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
249 evaluate MzScheme expressions and pass their values to VimL. |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
250 |
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
251 ============================================================================== |
4074 | 252 6. Using Function references *mzscheme-funcref* |
253 | |
254 MzScheme interface allows use of |Funcref|s so you can call Vim functions | |
255 directly from Scheme. For instance: > | |
256 function! MyAdd2(arg) | |
257 return a:arg + 2 | |
258 endfunction | |
259 mz (define f2 (vim-eval "function(\"MyAdd2\")")) | |
260 mz (f2 7) | |
261 < or : > | |
262 :mz (define indent (vim-eval "function('indent')")) | |
263 " return Vim indent for line 12 | |
264 :mz (indent 12) | |
265 < | |
266 | |
267 ============================================================================== | |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
268 7. Dynamic loading *mzscheme-dynamic* *E815* |
625 | 269 |
270 On MS-Windows the MzScheme libraries can be loaded dynamically. The |:version| | |
271 output then includes |+mzscheme/dyn|. | |
272 | |
273 This means that Vim will search for the MzScheme DLL files only when needed. | |
274 When you don't use the MzScheme interface you don't need them, thus you can | |
275 use Vim without these DLL files. | |
7609
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
276 NOTE: Newer version of MzScheme (Racket) require earlier (trampolined) |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
277 initialisation via scheme_main_setup. So Vim always loads the MzScheme DLL at |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
278 startup if possible. |
625 | 279 |
280 To use the MzScheme interface the MzScheme DLLs must be in your search path. | |
281 In a console window type "path" to see what directories are used. | |
282 | |
283 The names of the DLLs must match the MzScheme version Vim was compiled with. | |
284 For MzScheme version 209 they will be "libmzsch209_000.dll" and | |
1121 | 285 "libmzgc209_000.dll". To know for sure look at the output of the ":version" |
286 command, look for -DDYNAMIC_MZSCH_DLL="something" and | |
287 -DDYNAMIC_MZGC_DLL="something" in the "Compilation" info. | |
625 | 288 |
7609
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
289 For example, if MzScheme (Racket) is installed at C:\Racket63, you may need |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
290 to set the environment variable as the following: > |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
291 |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
292 PATH=%PATH%;C:\Racket63\lib |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
293 PLTCOLLECTS=C:\Racket63\collects |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
294 PLTCONFIGDIR=C:\Racket63\etc |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
295 < |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
296 ============================================================================== |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
297 8. MzScheme setup *mzscheme-setup* *E895* |
7609
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
298 |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
299 Vim requires "racket/base" module for if_mzsch core (fallback to "scheme/base" |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
300 if it doesn't exist), "r5rs" module for test and "raco ctool" command for |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
301 building Vim. If MzScheme did not have them, you can install them with |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
302 MzScheme's raco command: |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
303 > |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
304 raco pkg install scheme-lib # scheme/base module |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
305 raco pkg install r5rs-lib # r5rs module |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
306 raco pkg install cext-lib # raco ctool command |
77a14f3bc18b
commit https://github.com/vim/vim/commit/4e640bd930d133889dbc9f9a77e29bab902e3b7d
Christian Brabandt <cb@256bit.org>
parents:
5294
diff
changeset
|
307 < |
14 | 308 ====================================================================== |
309 vim:tw=78:ts=8:sts=4:ft=help:norl: |