Mercurial > vim
annotate runtime/doc/if_perl.txt @ 13963:1174611ad715 v8.1.0000
Vim 8.1 release
commit https://github.com/vim/vim/commit/b1c9198afb7ff902588b45fbe44f0760a9f48375
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu May 17 17:04:55 2018 +0200
Vim 8.1 release
Update version number and information. Fix a couple of tests.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Thu, 17 May 2018 17:15:08 +0200 |
| parents | 45987b1b77dc |
| children | 2f7e67dd088c |
| rev | line source |
|---|---|
| 13963 | 1 *if_perl.txt* For Vim version 8.1. Last change: 2017 Nov 24 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Sven Verdoolaege | |
| 5 and Matt Gerassimof | |
| 6 | |
| 7 Perl and Vim *perl* *Perl* | |
| 8 | |
| 9 1. Editing Perl files |perl-editing| | |
| 11473 | 10 2. Compiling Vim with Perl interface |perl-compiling| |
| 7 | 11 3. Using the Perl interface |perl-using| |
| 557 | 12 4. Dynamic loading |perl-dynamic| |
| 7 | 13 |
| 14 {Vi does not have any of these commands} | |
| 15 | |
| 16 The Perl interface only works when Vim was compiled with the |+perl| feature. | |
| 17 | |
| 18 ============================================================================== | |
| 19 1. Editing Perl files *perl-editing* | |
| 20 | |
| 21 Vim syntax highlighting supports Perl and POD files. Vim assumes a file is | |
| 236 | 22 Perl code if the filename has a .pl or .pm suffix. Vim also examines the first |
| 7 | 23 line of a file, regardless of the filename suffix, to check if a file is a |
| 24 Perl script (see scripts.vim in Vim's syntax directory). Vim assumes a file | |
| 25 is POD text if the filename has a .POD suffix. | |
| 26 | |
| 27 To use tags with Perl, you need a recent version of Exuberant ctags. Look | |
| 28 here: | |
| 29 http://ctags.sourceforge.net | |
| 30 | |
| 31 Alternatively, you can use the Perl script pltags.pl, which is shipped with | |
| 32 Vim in the $VIMRUNTIME/tools directory. This script has currently more | |
| 33 features than Exuberant ctags' Perl support. | |
| 34 | |
| 35 ============================================================================== | |
| 11473 | 36 2. Compiling Vim with Perl interface *perl-compiling* |
| 7 | 37 |
| 38 To compile Vim with Perl interface, you need Perl 5.004 (or later). Perl must | |
| 39 be installed before you compile Vim. Vim's Perl interface does NOT work with | |
| 40 the 5.003 version that has been officially released! It will probably work | |
| 41 with Perl 5.003_05 and later. | |
| 42 | |
| 43 The Perl patches for Vim were made by: | |
| 44 Sven Verdoolaege <skimo@breughel.ufsia.ac.be> | |
| 45 Matt Gerassimof | |
| 46 | |
| 3750 | 47 Perl for MS-Windows can be found at: http://www.perl.com/ |
| 48 The ActiveState one should work. | |
| 7 | 49 |
| 50 ============================================================================== | |
| 51 3. Using the Perl interface *perl-using* | |
| 52 | |
| 53 *:perl* *:pe* | |
| 236 | 54 :pe[rl] {cmd} Execute Perl command {cmd}. The current package |
| 3750 | 55 is "main". Simple example to test if `:perl` is |
| 56 working: > | |
| 57 :perl VIM::Msg("Hello") | |
| 7 | 58 |
| 59 :pe[rl] << {endpattern} | |
| 60 {script} | |
| 61 {endpattern} | |
| 62 Execute Perl script {script}. | |
| 63 {endpattern} must NOT be preceded by any white space. | |
| 64 If {endpattern} is omitted, it defaults to a dot '.' | |
| 65 like for the |:append| and |:insert| commands. Using | |
| 66 '.' helps when inside a function, because "$i;" looks | |
| 67 like the start of an |:insert| command to Vim. | |
| 68 This form of the |:perl| command is mainly useful for | |
| 69 including perl code in vim scripts. | |
| 70 Note: This command doesn't work when the Perl feature | |
| 71 wasn't compiled in. To avoid errors, see | |
| 72 |script-here|. | |
| 73 | |
| 74 | |
| 75 Example vim script: > | |
| 76 | |
| 77 function! WhitePearl() | |
| 78 perl << EOF | |
| 79 VIM::Msg("pearls are nice for necklaces"); | |
| 80 VIM::Msg("rubys for rings"); | |
| 81 VIM::Msg("pythons for bags"); | |
| 82 VIM::Msg("tcls????"); | |
| 83 EOF | |
| 84 endfunction | |
| 85 < | |
|
10153
715d6c5707b8
commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
86 To see what version of Perl you have: > |
|
715d6c5707b8
commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
87 :perl print $^V |
|
715d6c5707b8
commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455
Christian Brabandt <cb@256bit.org>
parents:
8673
diff
changeset
|
88 < |
| 7 | 89 |
| 90 *:perldo* *:perld* | |
| 91 :[range]perld[o] {cmd} Execute Perl command {cmd} for each line in the | |
| 92 [range], with $_ being set to the text of each line in | |
| 236 | 93 turn, without a trailing <EOL>. Setting $_ will change |
| 7 | 94 the text, but note that it is not possible to add or |
| 95 delete lines using this command. | |
| 96 The default for [range] is the whole file: "1,$". | |
| 97 | |
| 98 Here are some things you can try: > | |
| 99 | |
| 100 :perl $a=1 | |
| 101 :perldo $_ = reverse($_);1 | |
| 102 :perl VIM::Msg("hello") | |
| 103 :perl $line = $curbuf->Get(42) | |
| 104 < | |
| 105 *E299* | |
| 106 Executing Perl commands in the |sandbox| is limited. ":perldo" will not be | |
| 107 possible at all. ":perl" will be evaluated in the Safe environment, if | |
| 108 possible. | |
| 109 | |
| 110 | |
| 111 *perl-overview* | |
| 112 Here is an overview of the functions that are available to Perl: > | |
| 113 | |
| 114 :perl VIM::Msg("Text") # displays a message | |
| 12968 | 115 :perl VIM::Msg("Wrong!", "ErrorMsg") # displays an error message |
| 7 | 116 :perl VIM::Msg("remark", "Comment") # displays a highlighted message |
| 117 :perl VIM::SetOption("ai") # sets a vim option | |
| 118 :perl $nbuf = VIM::Buffers() # returns the number of buffers | |
| 119 :perl @buflist = VIM::Buffers() # returns array of all buffers | |
| 120 :perl $mybuf = (VIM::Buffers('qq.c'))[0] # returns buffer object for 'qq.c' | |
| 121 :perl @winlist = VIM::Windows() # returns array of all windows | |
| 122 :perl $nwin = VIM::Windows() # returns the number of windows | |
| 123 :perl ($success, $v) = VIM::Eval('&path') # $v: option 'path', $success: 1 | |
| 124 :perl ($success, $v) = VIM::Eval('&xyz') # $v: '' and $success: 0 | |
| 125 :perl $v = VIM::Eval('expand("<cfile>")') # expands <cfile> | |
| 126 :perl $curwin->SetHeight(10) # sets the window height | |
| 127 :perl @pos = $curwin->Cursor() # returns (row, col) array | |
| 128 :perl @pos = (10, 10) | |
| 129 :perl $curwin->Cursor(@pos) # sets cursor to @pos | |
| 130 :perl $curwin->Cursor(10,10) # sets cursor to row 10 col 10 | |
| 131 :perl $mybuf = $curwin->Buffer() # returns the buffer object for window | |
| 132 :perl $curbuf->Name() # returns buffer name | |
| 133 :perl $curbuf->Number() # returns buffer number | |
| 134 :perl $curbuf->Count() # returns the number of lines | |
| 135 :perl $l = $curbuf->Get(10) # returns line 10 | |
| 136 :perl @l = $curbuf->Get(1 .. 5) # returns lines 1 through 5 | |
| 137 :perl $curbuf->Delete(10) # deletes line 10 | |
| 138 :perl $curbuf->Delete(10, 20) # delete lines 10 through 20 | |
| 139 :perl $curbuf->Append(10, "Line") # appends a line | |
| 140 :perl $curbuf->Append(10, "Line1", "Line2", "Line3") # appends 3 lines | |
| 141 :perl @l = ("L1", "L2", "L3") | |
| 142 :perl $curbuf->Append(10, @l) # appends L1, L2 and L3 | |
| 143 :perl $curbuf->Set(10, "Line") # replaces line 10 | |
| 144 :perl $curbuf->Set(10, "Line1", "Line2") # replaces lines 10 and 11 | |
| 145 :perl $curbuf->Set(10, @l) # replaces 3 lines | |
| 146 < | |
| 147 *perl-Msg* | |
| 148 VIM::Msg({msg}, {group}?) | |
| 149 Displays the message {msg}. The optional {group} | |
| 150 argument specifies a highlight group for Vim to use | |
| 151 for the message. | |
| 152 | |
| 153 *perl-SetOption* | |
| 154 VIM::SetOption({arg}) Sets a vim option. {arg} can be any argument that the | |
| 155 ":set" command accepts. Note that this means that no | |
| 156 spaces are allowed in the argument! See |:set|. | |
| 157 | |
| 158 *perl-Buffers* | |
| 159 VIM::Buffers([{bn}...]) With no arguments, returns a list of all the buffers | |
| 160 in an array context or returns the number of buffers | |
| 161 in a scalar context. For a list of buffer names or | |
| 162 numbers {bn}, returns a list of the buffers matching | |
| 163 {bn}, using the same rules as Vim's internal | |
| 164 |bufname()| function. | |
| 22 | 165 WARNING: the list becomes invalid when |:bwipe| is |
| 166 used. Using it anyway may crash Vim. | |
| 7 | 167 |
| 168 *perl-Windows* | |
| 169 VIM::Windows([{wn}...]) With no arguments, returns a list of all the windows | |
| 170 in an array context or returns the number of windows | |
| 171 in a scalar context. For a list of window numbers | |
| 172 {wn}, returns a list of the windows with those | |
| 173 numbers. | |
| 22 | 174 WARNING: the list becomes invalid when a window is |
| 175 closed. Using it anyway may crash Vim. | |
| 7 | 176 |
| 177 *perl-DoCommand* | |
| 178 VIM::DoCommand({cmd}) Executes Ex command {cmd}. | |
| 179 | |
| 180 *perl-Eval* | |
| 3920 | 181 VIM::Eval({expr}) Evaluates {expr} and returns (success, value) in list |
| 182 context or just value in scalar context. | |
| 7 | 183 success=1 indicates that val contains the value of |
| 184 {expr}; success=0 indicates a failure to evaluate | |
| 185 the expression. '@x' returns the contents of register | |
| 186 x, '&x' returns the value of option x, 'x' returns the | |
| 187 value of internal |variables| x, and '$x' is equivalent | |
| 188 to perl's $ENV{x}. All |functions| accessible from | |
| 189 the command-line are valid for {expr}. | |
| 714 | 190 A |List| is turned into a string by joining the items |
| 191 and inserting line breaks. | |
| 7 | 192 |
| 193 *perl-SetHeight* | |
| 194 Window->SetHeight({height}) | |
| 195 Sets the Window height to {height}, within screen | |
| 196 limits. | |
| 197 | |
| 198 *perl-GetCursor* | |
| 199 Window->Cursor({row}?, {col}?) | |
| 200 With no arguments, returns a (row, col) array for the | |
| 201 current cursor position in the Window. With {row} and | |
| 202 {col} arguments, sets the Window's cursor position to | |
| 203 {row} and {col}. Note that {col} is numbered from 0, | |
| 204 Perl-fashion, and thus is one less than the value in | |
| 205 Vim's ruler. | |
| 206 | |
| 207 Window->Buffer() *perl-Buffer* | |
| 208 Returns the Buffer object corresponding to the given | |
| 209 Window. | |
| 210 | |
| 211 *perl-Name* | |
| 212 Buffer->Name() Returns the filename for the Buffer. | |
| 213 | |
| 214 *perl-Number* | |
| 215 Buffer->Number() Returns the number of the Buffer. | |
| 216 | |
| 217 *perl-Count* | |
| 218 Buffer->Count() Returns the number of lines in the Buffer. | |
| 219 | |
| 220 *perl-Get* | |
| 221 Buffer->Get({lnum}, {lnum}?, ...) | |
| 222 Returns a text string of line {lnum} in the Buffer | |
| 236 | 223 for each {lnum} specified. An array can be passed |
| 7 | 224 with a list of {lnum}'s specified. |
| 225 | |
| 226 *perl-Delete* | |
| 227 Buffer->Delete({lnum}, {lnum}?) | |
| 228 Deletes line {lnum} in the Buffer. With the second | |
| 229 {lnum}, deletes the range of lines from the first | |
| 230 {lnum} to the second {lnum}. | |
| 231 | |
| 232 *perl-Append* | |
| 233 Buffer->Append({lnum}, {line}, {line}?, ...) | |
| 234 Appends each {line} string after Buffer line {lnum}. | |
| 235 The list of {line}s can be an array. | |
| 236 | |
| 237 *perl-Set* | |
| 238 Buffer->Set({lnum}, {line}, {line}?, ...) | |
| 239 Replaces one or more Buffer lines with specified | |
| 240 {lines}s, starting at Buffer line {lnum}. The list of | |
| 241 {line}s can be an array. If the arguments are | |
| 242 invalid, replacement does not occur. | |
| 243 | |
| 244 $main::curwin | |
| 245 The current window object. | |
| 246 | |
| 247 $main::curbuf | |
| 248 The current buffer object. | |
| 249 | |
| 250 | |
| 251 *script-here* | |
| 252 When using a script language in-line, you might want to skip this when the | |
| 253 language isn't supported. But this mechanism doesn't work: > | |
| 254 if has('perl') | |
| 255 perl << EOF | |
| 256 this will NOT work! | |
| 257 EOF | |
| 258 endif | |
| 259 Instead, put the Perl/Python/Ruby/etc. command in a function and call that | |
| 260 function: > | |
| 261 if has('perl') | |
| 262 function DefPerl() | |
| 263 perl << EOF | |
| 264 this works | |
| 265 EOF | |
| 266 endfunction | |
| 267 call DefPerl() | |
| 268 endif | |
| 269 Note that "EOF" must be at the start of the line. | |
| 270 | |
| 557 | 271 ============================================================================== |
| 272 4. Dynamic loading *perl-dynamic* | |
| 273 | |
|
2370
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
274 On MS-Windows and Unix the Perl library can be loaded dynamically. The |
|
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
275 |:version| output then includes |+perl/dyn|. |
| 557 | 276 |
|
2370
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
277 This means that Vim will search for the Perl DLL or shared library file only |
|
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
278 when needed. When you don't use the Perl interface you don't need it, thus |
|
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
279 you can use Vim without this file. |
|
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
280 |
| 557 | 281 |
|
2370
454f314d0e61
Make it possible to load Perl dynamically on Unix. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
282 MS-Windows ~ |
| 557 | 283 |
|
2342
f6540762173d
Fixes and improvements for MS-Windows build.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
284 You can download Perl from http://www.perl.org. The one from ActiveState was |
|
f6540762173d
Fixes and improvements for MS-Windows build.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
285 used for building Vim. |
| 557 | 286 |
|
2342
f6540762173d
Fixes and improvements for MS-Windows build.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
287 To use the Perl interface the Perl DLL must be in your search path. |
|
f6540762173d
Fixes and improvements for MS-Windows build.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
288 If Vim reports it cannot find the perl512.dll, make sure your $PATH includes |
|
2355
84c7eeeb09e2
Fix typos in documentation. (Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
289 the directory where it is located. The Perl installer normally does that. |
|
8673
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
290 In a console window type "path" to see what directories are used. The |
|
ed7251c3e2d3
commit https://github.com/vim/vim/commit/e18c0b39815c5a746887a509c2cd9f11fadaba07
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
291 'perldll' option can be also used to specify the Perl DLL. |
| 557 | 292 |
| 293 The name of the DLL must match the Perl version Vim was compiled with. | |
|
2342
f6540762173d
Fixes and improvements for MS-Windows build.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
294 Currently the name is "perl512.dll". That is for Perl 5.12. To know for |
| 557 | 295 sure edit "gvim.exe" and search for "perl\d*.dll\c". |
| 296 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
297 |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
298 Unix ~ |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
299 |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
300 The 'perldll' option can be used to specify the Perl shared library file |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
301 instead of DYNAMIC_PERL_DLL file what was specified at compile time. The |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
302 version of the shared library must match the Perl version Vim was compiled |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
303 with. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
5400
diff
changeset
|
304 |
| 557 | 305 ============================================================================== |
| 7 | 306 vim:tw=78:ts=8:ft=help:norl: |