Usr_41

はじめに vim-script-intro script

:let i = 1
:while i < 5
:  echo "count is" i
:  let i += 1
:endwhile

:let {variable} = {expression}

:while {condition}
:  {statements}
:endwhile

:for i in range(1, 4)
:  echo "count is" i
:endfor

4種類の数値

31.

:echo 0x7f 0o36

:echo 0x7f -0o36

:echo 0x7f - 0o36

41.2 変数

:let

:let s:count = 1
:while s:count < 5
:  source other.vim
:  let s:count += 1
:endwhile

変数の削除

:unlet s:count

:unlet! s:count

:if !exists(s:call_count)

:if "true"

文字列変数と定数

:let name = "peter"
:echo name

:let name = "\"peter\""
:echo name

:let name = '"peter"'
:echo name

41.3 式

:echo "The value of 'tabstop' is" &ts
:echo "Your home directory is" $HOME
:if @a > 5

:let save_ic = &ic
:set noic
:/The Start/,$delete
:let &ic = save_ic

数学

:echo 10 + 5 * 2

:echo (10 + 5) * 2

:echo "foo" .. "bar"

:let i = 4
:echo i > 5 ? "i is big" : "i is small"

41.4 条件文

:if &term == "xterm"
:  " Do stuff for xterm
:elseif &term == "vt100"
:  " Do stuff for a vt100 terminal
:else
:  " Do something for other terminals
:endif

論理演算

:if v:version >= 700
:  echo "congratulations"
:else
:  echo "you are using an old version, upgrade!"
:endif

:if 0 == "one"
:  echo "yes"
:endif

:if str =~ " "
:  echo "str contains a space"
:endif
:if str !~ '\.$'
:  echo "str does not end in a full stop"
:endif

ループ処理の追加

:while counter < 40
:  call do_something()
:  if skip_flag
:    continue
:  endif
:  if finished_flag
:    break
:  endif
:  sleep 50m
:endwhile

41.5 式の実行

:execute "tag " .. tag_name

:tag get_cmd

:normal gg=G

:execute "normal " .. normal_commands

:execute "normal Inew text \<Esc>"

:let optname = "path"
:let optval = eval('&' .. optname)

:exe 'let optval = &' .. optname

41.6 関数の使用

:call search("Date: ", "W")

:let line = getline(".")
:let repl = substitute(line, '\a', "*", "g")
:call setline(".", repl)

:substitute/\a/*/g

関数 function-list

41.7 関数を定義する

:function {name}({var1}, {var2}, ...)
:  {body}
:endfunction

:function Min(num1, num2)

:  if a:num1 < a:num2

:  if a:num1 < a:num2
:    let smaller = a:num1
:  else
:    let smaller = a:num2
:  endif

:  return smaller
:endfunction

:function Min(num1, num2)
:  if a:num1 < a:num2
:    let smaller = a:num1
:  else
:    let smaller = a:num2
:  endif
:  return smaller
:endfunction

:function Min(num1, num2)
:  if a:num1 < a:num2
:    return a:num1
:  endif
:  return a:num2
:endfunction

:echo Min(5, 8)

:function!  Min(num1, num2, num3)

:function Count_words() range
:  let lnum = a:firstline
:  let n = 0
:  while lnum <= a:lastline
:    let n = n + len(split(getline(lnum)))
:    let lnum = lnum + 1
:  endwhile
:  echo "found " .. n .. " words"
:endfunction

:10,30call Count_words()

:function  Number()
:  echo "line " .. line(".") .. " contains: " .. getline(".")
:endfunction

:10,15call Number()

可変数の引数

:function Show(start, ...)

:function Show(start, ...)
:  echohl Title
:  echo "start is " .. a:start
:  echohl None
:  let index = 1
:  while index <= a:0
:    echo "  Arg " .. index .. " is " .. a:{index}
:    let index = index + 1
:  endwhile
:  echo ""
:endfunction

関数のリスト表示

:function

:function SetSyn

デバッグ

:delfunction Show

関数参照

:let result = 0                " or 1
:function! Right()
:  return 'Right!'
:endfunc
:function! Wrong()
:  return 'Wrong!'
:endfunc
:
:if result == 1
:  let Afunc = function('Right')
:else
:  let Afunc = function('Wrong')
:endif
:echo call(Afunc, [])

41.8 リストと辞書

:let alist = ['aap', 'mies', 'noot']

:let alist = []

:let alist = []
:call add(alist, 'foo')
:call add(alist, 'bar')
:echo alist

:echo alist + ['foo', 'bar']

:let alist = ['one']
:call extend(alist, ['two', 'three'])
:echo alist

:let alist = ['one']
:call add(alist, ['two', 'three'])
:echo alist

FORループ

:let alist = ['one', 'two', 'three']
:for n in alist
:  echo n
:endfor

:for {varname} in {listexpression}
:  {commands}
:endfor

:for a in range(3)
:  echo a
:endfor

:for a in range(8, 4, -2)
:  echo a
:endfor

:for line in getline(1, 20)
:  if line =~ "Date: "
:    echo matchstr(line, 'Date: \zs.*')
:  endif
:endfor

辞書

:let uk2nl = {'one': 'een', 'two': 'twee', 'three': 'drie'}

:echo uk2nl['two']

{<key> : <value>, ...}

{}

:for key in keys(uk2nl)
:  echo key
:endfor

:for key in sort(keys(uk2nl))
:  echo key
:endfor

辞書関数

:echo uk2nl['one']

:echo uk2nl.one

:let uk2nl.four = 'vier'
:echo uk2nl

:function uk2nl.translate(line) dict
:  return join(map(split(a:line), 'get(self, v:val, "???")'))
:endfunction

:echo uk2nl.translate('three two five one')

split(a:line)

:echo split('three two five one')

:let alist = map(split(a:line), 'get(self, v:val, "???")')

:let alist = split(a:line)
:for idx in range(len(alist))
:  let alist[idx] = get(self, alist[idx], "???")
:endfor

オブジェクト指向プログラミング

:let transdict = {}
:function transdict.translate(line) dict
:  return join(map(split(a:line), 'get(self.words, v:val, "???")'))
:endfunction

:let uk2nl = copy(transdict)
:let uk2nl.words = {'one': 'een', 'two': 'twee', 'three': 'drie'}
:echo uk2nl.translate('three one')

:let uk2de = copy(transdict)
:let uk2de.words = {'one': 'eins', 'two': 'zwei', 'three': 'drei'}
:echo uk2de.translate('three one')

:if $LANG =~ "de"
:  let trans = uk2de
:else
:  let trans = uk2nl
:endif
:echo trans.translate('one two three')

:let uk2uk = copy(transdict)
:function! uk2uk.translate(line)
:  return a:line
:endfunction
:echo uk2uk.translate('three one wladiwostok')

:if $LANG =~ "de"
:  let trans = uk2de
:elseif $LANG =~ "nl"
:  let trans = uk2nl
:else
:  let trans = uk2uk
:endif
:echo trans.translate('one two three')

41.9 例外

:try
:   read ~/templates/pascal.tmpl
:catch /E484:/
:   echo "Sorry, the Pascal template file cannot be found."
:endtry

:try
:   read ~/templates/pascal.tmpl
:catch
:   echo "Sorry, the Pascal template file cannot be found."
:endtry

:let tmp = tempname()
:try
:   exe ".,$write " .. tmp
:   exe "!filter " .. tmp
:   .,$delete
:   exe "$read " .. tmp
:finally
:   call delete(tmp)
:endtry

41.10 その他の注意点

:setlocal fileformat=unix

空白

:set tags=my\ nice\ file

:set tags=my nice file

:set tags=my
:set nice
:set file

コメント

:abbrev dev development                " shorthand
:map <F3> o#include                " insert include
:execute cmd                        " do it
:!ls *.c                        " list C files

:abbrev dev development|" shorthand
:map <F3> o#include|" insert include
:execute cmd                        |" do it

:exe '!ls *.c'                        |" list C files

:map <F4> o#include

#!/usr/bin/env vim -S
echo "this is a Vim script"
quit

落とし穴

:map ,ab o#include
:unmap ,ab

:unmap ,ab     " comment

:unmap ,ab|    " comment

ビューの復元

map ,p ma"aYHmbgg"aP`bzt`a

ma"aYHmbgg"aP`bzt`a

パッケージング

名前

本文

14        iabbrev teh the
15        iabbrev otehr other
16        iabbrev wnat want
17        iabbrev synchronisation
18                \ synchronization
19        let s:count = 4

ヘッダー

1        " Vim global plugin for correcting typing mistakes
2        " Last Change:        2000 Oct 15
3        " Maintainer:        Bram Moolenaar <[email protected]>

4        " License:        This file is placed in the public domain.

11        let s:save_cpo = &cpo
12        set cpo&vim
..
42        let &cpo = s:save_cpo
43        unlet s:save_cpo

読み込まない

6        if exists("g:loaded_typecorr")
7          finish
8        endif
9        let g:loaded_typecorr = 1

マッピング

22          map <unique> <Leader>a  <Plug>TypecorrAdd;

let mapleader = "_"

21        if !hasmapto('<Plug>TypecorrAdd;')
22          map <unique> <Leader>a  <Plug>TypecorrAdd;
23        endif

map ,c  <Plug>TypecorrAdd;

ピース

30        function s:Add(from, correct)
31          let to = input("type the correction for " .. a:from .. ": ")
32          exe ":iabbrev " .. a:from .. " " .. to
..
36        endfunction

24        noremap <unique> <script> <Plug>TypecorrAdd;  <SID>Add
..
28        noremap <SID>Add  :call <SID>Add(expand("<cword>"), 1)<CR>

\a  ->  <Plug>TypecorrAdd;  ->  <SID>Add  ->  :call <SID>Add()

26        noremenu <script> Plugin.Add\ Correction      <SID>Add

ユーザーコマンド

38        if !exists(":Correct")
39          command -nargs=1  Correct  :call s:Add(<q-args>, 0)
40        endif

スクリプト変数

19        let s:count = 4
..
30        function s:Add(from, correct)
..
34          let s:count = s:count + 1
35          echo s:count .. " corrections now"
36        endfunction

結果

 1        " Vim global plugin for correcting typing mistakes
 2        " Last Change:        2000 Oct 15
 3        " Maintainer:        Bram Moolenaar <[email protected]>
 4        " License:        This file is placed in the public domain.
 5
 6        if exists("g:loaded_typecorr")
 7          finish
 8        endif
 9        let g:loaded_typecorr = 1
10
11        let s:save_cpo = &cpo
12        set cpo&vim
13
14        iabbrev teh the
15        iabbrev otehr other
16        iabbrev wnat want
17        iabbrev synchronisation
18                \ synchronization
19        let s:count = 4
20
21        if !hasmapto('<Plug>TypecorrAdd;')
22          map <unique> <Leader>a  <Plug>TypecorrAdd;
23        endif
24        noremap <unique> <script> <Plug>TypecorrAdd;  <SID>Add
25
26        noremenu <script> Plugin.Add\ Correction      <SID>Add
27
28        noremap <SID>Add  :call <SID>Add(expand("<cword>"), 1)<CR>
29
30        function s:Add(from, correct)
31          let to = input("type the correction for " .. a:from .. ": ")
32          exe ":iabbrev " .. a:from .. " " .. to
33          if a:correct | exe "normal viws\<C-R>\" \b\e" | endif
34          let s:count = s:count + 1
35          echo s:count .. " corrections now"
36        endfunction
37
38        if !exists(":Correct")
39          command -nargs=1  Correct  :call s:Add(<q-args>, 0)
40        endif
41
42        let &cpo = s:save_cpo
43        unlet s:save_cpo

:set fileformat=unix

ドキュメント write-local-help

 1        *typecorr.txt*        Plugin for correcting typing mistakes
 2
 3        If you make typing mistakes, this plugin will have them corrected
 4        automatically.
 5
 6        There are currently only a few corrections.  Add your own if you like.
 7
 8        Mappings:
 9        <Leader>a   or   <Plug>TypecorrAdd;
10                Add a correction for the word under the cursor.
11
12        Commands:
13        :Correct {word}
14                Add a correction for {word}.
15
16                                                        *typecorr-settings*
17        This plugin doesn't have any settings.

ファイルタイプ検出 plugin-filetype

au BufNewFile,BufRead *.foo                        set filetype=foofoo

まとめ plugin-special

41.12 ファイルタイププラグインの作成 write-filetype-plugin ftplugin

無効化

" Only do this when not done yet for this buffer
if exists("b:did_ftplugin")
  finish
endif
let b:did_ftplugin = 1

let b:did_ftplugin = 1

setlocal textwidth=70

オプション

:setlocal

:setlocal formatoptions& formatoptions+=ro

マッピング

:map <buffer>

if !hasmapto('<Plug>JavaImport;')
  map <buffer> <unique> <LocalLeader>i <Plug>JavaImport;
endif
noremap <buffer> <unique> <Plug>JavaImport; oimport ""<Left><Esc>

" Add mappings, unless the user didn't want this.
if !exists("no_plugin_maps") && !exists("no_mail_maps")
  " Quote text by inserting "> "
  if !hasmapto('<Plug>MailQuote;')
    vmap <buffer> <LocalLeader>q <Plug>MailQuote;
    nmap <buffer> <LocalLeader>q <Plug>MailQuote;
  endif
  vnoremap <buffer> <Plug>MailQuote; :s/^/> /<CR>
  nnoremap <buffer> <Plug>MailQuote; :.,$s/^/> /<CR>
endif

ユーザーコマンド

:command -buffer  Make  make %:r.s

変数

関数

:if !exists("*s:Func")
:  function s:Func(arg)
:    ...
:  endfunction
:endif

アンドゥ undo_indent undo_ftplugin

let b:undo_ftplugin = "setlocal fo< com< tw< commentstring<"
        \ .. "| unlet b:match_ignorecase b:match_words b:match_skip"

ファイル名

概要 ftplugin-special

41.13 コンパイラプラグインの作成 write-compiler-plugin

:next $VIMRUNTIME/compiler/*.vim

:if exists("current_compiler")
:  finish
:endif
:let current_compiler = "mine"

CompilerSet errorformat&                " use the default 'errorformat'
CompilerSet makeprg=nmake

41.14 高速にロードするプラグインの作成 write-plugin-quickload

" Vim global plugin for demonstrating quick loading
" Last Change:        2005 Feb 25
" Maintainer:        Bram Moolenaar <[email protected]>
" License:        This file is placed in the public domain.
if !exists("s:did_load")
        command -nargs=* BNRead  call BufNetRead(<f-args>)
        map <F19> :call BufNetWrite('something')<CR>
        let s:did_load = 1
        exe 'au FuncUndefined BufNet* source ' .. expand('<sfile>')
        finish
endif
function BufNetRead(...)
        echo 'BufNetRead(' .. string(a:000) .. ')'
        " read functionality here
endfunction
function BufNetWrite(...)
        echo 'BufNetWrite(' .. string(a:000) .. ')'
        " write functionality here
endfunction

41.15 ライブラリスクリプトの作成 write-library-script

if !exists('*MyLibFunction')
   runtime library/mylibscript.vim
endif
call MyLibFunction(arg)

call mylib#myfunction(arg)

call netlib#ftp#read('somefile')

function netlib#ftp#read(fname)
        "  Read the file fname through ftp
endfunction

let weekdays = dutch#weekdays

let dutch#weekdays = ['zondag', 'maandag', 'dinsdag', 'woensdag',
        \ 'donderdag', 'vrijdag', 'zaterdag']

41.16 Vimスクリプトの配布 distribute-script