1 *if_mzsch.txt* For Vim version 7.2. Last change: 2010 Jan 19
4 VIM REFERENCE MANUAL by Sergey Khorev
7 The MzScheme Interface to Vim *mzscheme* *MzScheme*
9 1. Commands |mzscheme-commands|
10 2. Examples |mzscheme-examples|
11 3. Threads |mzscheme-threads|
12 4. Vim access from MzScheme |mzscheme-vim|
13 5. mzeval() Vim function |mzscheme-mzeval|
14 6. Dynamic loading |mzscheme-dynamic|
16 {Vi does not have any of these commands}
18 The MzScheme interface is available only if Vim was compiled with the
21 Based on the work of Brent Fulgham.
22 Dynamic loading added by Sergey Khorev
24 For downloading MzScheme and other info:
25 http://www.plt-scheme.org/software/mzscheme/
27 Note: On FreeBSD you should use the "drscheme" port.
29 ==============================================================================
30 1. Commands *mzscheme-commands*
33 :[range]mz[scheme] {stmt}
34 Execute MzScheme statement {stmt}. {not in Vi}
36 :[range]mz[scheme] << {endmarker}
39 Execute inlined MzScheme script {script}.
40 Note: This command doesn't work if the MzScheme
41 feature wasn't compiled in. To avoid errors, see
45 :[range]mzf[ile] {file} Execute the MzScheme script in {file}. {not in Vi}
47 All of these commands do essentially the same thing - they execute a piece of
48 MzScheme code, with the "current range" set to the given line
51 In the case of :mzscheme, the code to execute is in the command-line.
52 In the case of :mzfile, the code to execute is the contents of the given file.
54 MzScheme interface defines exception exn:vim, derived from exn.
55 It is raised for various Vim errors.
57 During compilation, the MzScheme interface will remember the current MzScheme
58 collection path. If you want to specify additional paths use the
59 'current-library-collection-paths' parameter. E.g., to cons the user-local
60 MzScheme collection path: >
62 (current-library-collection-paths
64 (build-path (find-system-path 'addon-dir) (version) "collects")
65 (current-library-collection-paths)))
69 All functionality is provided through module vimext.
71 The exn:vim is available without explicit import.
73 To avoid clashes with MzScheme, consider using prefix when requiring module,
75 :mzscheme (require (prefix vim- vimext))
77 All the examples below assume this naming scheme.
80 When executed in the |sandbox|, access to some filesystem and Vim interface
81 procedures is restricted.
83 ==============================================================================
84 2. Examples *mzscheme-examples*
86 :mzscheme (display "Hello")
87 :mz (display (string-append "Using MzScheme version " (version)))
88 :mzscheme (require (prefix vim- vimext)) ; for MzScheme < 4.x
89 :mzscheme (require (prefix-in vim- 'vimext)) ; MzScheme 4.x
90 :mzscheme (vim-set-buff-line 10 "This is line #10")
92 Inline script usage: >
93 function! <SID>SetFirstLine()
96 (require (prefix vim- vimext))
97 ; for newer versions (require (prefix-in vim- 'vimext))
98 (vim-set-buff-line 1 "This is line #1")
103 nmap <F9> :call <SID>SetFirstLine() <CR>
106 :mzfile supascript.scm
108 Vim exception handling: >
110 (require (prefix vim- vimext))
111 ; for newer versions (require (prefix-in vim- 'vimext))
113 ([exn:vim? (lambda (e) (display (exn-message e)))])
114 (vim-eval "nonsense-string"))
117 Auto-instantiation of vimext module (can be placed in your |vimrc|): >
118 function! MzRequire()
119 :redir => l:mzversion
122 if strpart(l:mzversion, 1, 1) < "4"
123 " MzScheme versions < 4.x:
124 :mz (require (prefix vim- vimext))
127 :mz (require (prefix-in vim- 'vimext))
132 silent call MzRequire()
135 ==============================================================================
136 3. Threads *mzscheme-threads*
138 The MzScheme interface supports threads. They are independent from OS threads,
139 thus scheduling is required. The option 'mzquantum' determines how often
140 Vim should poll for available MzScheme threads.
142 Thread scheduling in the console version of Vim is less reliable than in the
145 ==============================================================================
146 4. Vim access from MzScheme *mzscheme-vim*
149 The 'vimext' module provides access to procedures defined in the MzScheme
154 (command {command-string}) Perform the vim ":Ex" style command.
155 (eval {expr-string}) Evaluate the vim expression into
156 respective MzScheme object: |Lists| are
157 represented as Scheme lists,
158 |Dictionaries| as hash tables.
159 NOTE the name clashes with MzScheme eval
160 (range-start) Start/End of the range passed with
161 (range-end) the Scheme command.
163 (get-option {option-name} [buffer-or-window]) Get Vim option value (either
164 local or global, see set-option).
165 (set-option {string} [buffer-or-window])
166 Set a Vim option. String must have option
167 setting form (like optname=optval, or
168 optname+=optval, etc.) When called with
169 {buffer} or {window} the local option will
170 be set. The symbol 'global can be passed
171 as {buffer-or-window}. Then |:setglobal|
174 Buffers *mzscheme-buffer*
176 (buff? {object}) Is object a buffer?
177 (buff-valid? {object}) Is object a valid buffer? (i.e.
178 corresponds to the real Vim buffer)
179 (get-buff-line {linenr} [buffer])
180 Get line from a buffer.
181 (set-buff-line {linenr} {string} [buffer])
182 Set a line in a buffer. If {string} is #f,
183 the line gets deleted. The [buffer]
184 argument is optional. If omitted, the
185 current buffer will be used.
186 (get-buff-line-list {start} {end} [buffer])
187 Get a list of lines in a buffer. {Start}
188 and {end} are 1-based. {Start} is
189 inclusive, {end} - exclusive.
190 (set-buff-line-list {start} {end} {string-list} [buffer])
191 Set a list of lines in a buffer. If
192 string-list is #f or null, the lines get
193 deleted. If a list is shorter than
194 {end}-{start} the remaining lines will
196 (get-buff-name [buffer]) Get a buffer's text name.
197 (get-buff-num [buffer]) Get a buffer's number.
198 (get-buff-size [buffer]) Get buffer line count.
199 (insert-buff-line-list {linenr} {string/string-list} [buffer])
200 Insert a list of lines into a buffer after
201 {linenr}. If {linenr} is 0, lines will be
203 (curr-buff) Get the current buffer. Use procedures
204 from "vimcmd" module to change it.
205 (buff-count) Get count of total buffers in the editor.
206 (get-next-buff [buffer]) Get next buffer.
207 (get-prev-buff [buffer]) Get previous buffer. Return #f when there
209 (open-buff {filename}) Open a new buffer (for file "name")
210 (get-buff-by-name {buffername}) Get a buffer by its filename or #f
211 if there is no such buffer.
212 (get-buff-by-num {buffernum}) Get a buffer by its number (return #f if
213 there is no buffer with this number).
215 Windows *mzscheme-window*
217 (win? {object}) Is object a window?
218 (win-valid? {object}) Is object a valid window (i.e. corresponds
219 to the real Vim window)?
220 (curr-win) Get the current window.
221 (win-count) Get count of windows.
222 (get-win-num [window]) Get window number.
223 (get-win-by-num {windownum}) Get window by its number.
224 (get-win-buffer [window]) Get the buffer for a given window.
225 (get-win-height [window])
226 (set-win-height {height} [window]) Get/Set height of window.
227 (get-win-width [window])
228 (set-win-width {width} [window])Get/Set width of window.
229 (get-win-list [buffer]) Get list of windows for a buffer.
230 (get-cursor [window]) Get cursor position in a window as
231 a pair (linenr . column).
232 (set-cursor (line . col) [window]) Set cursor position.
234 ==============================================================================
235 5. mzeval() Vim function *mzscheme-mzeval*
237 To facilitate bi-directional interface, you can use |mzeval| function to
238 evaluate MzScheme expressions and pass their values to VimL.
240 ==============================================================================
241 6. Dynamic loading *mzscheme-dynamic* *E815*
243 On MS-Windows the MzScheme libraries can be loaded dynamically. The |:version|
244 output then includes |+mzscheme/dyn|.
246 This means that Vim will search for the MzScheme DLL files only when needed.
247 When you don't use the MzScheme interface you don't need them, thus you can
248 use Vim without these DLL files.
250 To use the MzScheme interface the MzScheme DLLs must be in your search path.
251 In a console window type "path" to see what directories are used.
253 The names of the DLLs must match the MzScheme version Vim was compiled with.
254 For MzScheme version 209 they will be "libmzsch209_000.dll" and
255 "libmzgc209_000.dll". To know for sure look at the output of the ":version"
256 command, look for -DDYNAMIC_MZSCH_DLL="something" and
257 -DDYNAMIC_MZGC_DLL="something" in the "Compilation" info.
259 ======================================================================
260 vim:tw=78:ts=8:sts=4:ft=help:norl: