Vim / Neovim 完全指南 / 09 - VimScript 编程

" 变量作用域前缀
let g:var = "global"       " 全局变量
let b:var = "buffer"       " 缓冲区局部变量
let w:var = "window"       " 窗口局部变量
let t:var = "tab"          " 标签页局部变量
let s:var = "script"       " 脚本局部变量
let l:var = "local"        " 函数局部变量
let a:arg = "argument"     " 函数参数
let v:var = "vim"          " Vim 内置变量

" 在函数内 let 默认是函数局部
let myvar = "hello"

" 常量
const MY_CONST = 42

" 数字
let num = 42
let hex = 0xff
let oct = 0777

" 浮点数
let float = 3.14
let sci = 1.5e10

" 字符串
let str1 = "hello"
let str2 = 'world'       " 单引号不解释转义

" 列表（数组）
let list = [1, 2, 3, "four"]

" 字典（哈希表）
let dict = {"name": "vim", "version": 9}

" 布尔
let flag = v:true
let flag2 = v:false
let nothing = v:null

" 算术
let sum = 1 + 2
let div = 10 / 3      " 整数除法
let mod = 10 % 3      " 取模

" 字符串连接
let greeting = "Hello, " . name . "!"

" 列表操作
let list = [1, 2] + [3, 4]    " [1, 2, 3, 4]
let sub = list[1:2]           " [2, 3]

" 比较
if a == b
if a != b
if a > b
if a =~ pattern       " 正则匹配
if a !~ pattern       " 正则不匹配
if a is b             " 引用相等

" 条件
if condition
    " ...
elseif other_condition
    " ...
else
    " ...
endif

" 循环
for i in range(10)
    echo i
endfor

for item in mylist
    echo item
endfor

for [key, value] in items(mydict)
    echo key . ": " . value
endfor

let i = 0
while i < 10
    let i += 1
endwhile

" 异常处理
try
    " ...
catch /pattern/
    " ...
finally
    " ...
endtry

" 基本函数
function! Greet(name)
    echo "Hello, " . a:name . "!"
endfunction

" 有返回值
function! Add(a, b)
    return a:a + a:b
endfunction

" 可变参数
function! Sum(...)
    let total = 0
    for i in a:000
        let total += i
    endfor
    return total
endfunction

" 调用
call Greet("Vim")
let result = Add(1, 2)
echo Sum(1, 2, 3, 4, 5)

" autoload 延迟加载
function! mylib#format(text)
    return "[" . a:text . "]"
endfunction
" 文件路径：autoload/mylib.vim

" dict 函数
function! MyObj.method() dict
    return self.name
endfunction

" 闭包
function! Counter()
    let count = 0
    return {-> let count += 1}
endfunction

" 字符串
strlen("hello")           " 5
substitute("aabb", "a", "x", "g")  " xxbb
matchstr("hello", "llo")  " llo
toupper("hello")          " HELLO
split("a,b,c", ",")       " ['a', 'b', 'c']
join(['a', 'b'], '-')     " a-b

" 列表
len([1, 2, 3])            " 3
add([1, 2], 3)            " [1, 2, 3]
sort([3, 1, 2])           " [1, 2, 3]
map([1, 2, 3], {i, v -> v * 2})  " [2, 4, 6]
filter([1, 2, 3], {i, v -> v > 1})  " [2, 3]

" 字典
keys({"a": 1, "b": 2})   " ['a', 'b']
values({"a": 1, "b": 2}) " [1, 2]
has_key(dict, "a")        " 1 (true)

" 系统
system("ls")              " 执行外部命令
executable("python3")     " 是否存在

" 创建自动命令
autocmd Event pattern command

" 使用 augroup 分组（避免重复）
augroup MyGroup
    autocmd!    " 清除组内已有命令
    autocmd BufWritePre *.py %s/\s\+$//e
    autocmd FileType python setlocal tabstop=4
augroup END

" 高亮复制的文本（0.5 秒）
autocmd TextYankPost * silent! lua vim.highlight.on_yank()

" 保存时自动去除尾部空格
autocmd BufWritePre * :%s/\s\+$//e

" 打开文件时恢复光标位置
autocmd BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g'\"" | endif

" 特定文件类型设置
autocmd FileType python setlocal tabstop=4 shiftwidth=4
autocmd FileType javascript setlocal tabstop=2 shiftwidth=2
autocmd FileType go setlocal tabstop=4 shiftwidth=4 noexpandtab

" 自动创建目录
autocmd BufWritePre * if !isdirectory(expand("<afile>:p:h")) | call mkdir(expand("<afile>:p:h"), "p") | endif

" 基本映射
nnoremap <leader>w :w<CR>
nnoremap <leader>q :q<CR>

" 带参数的映射
nnoremap <leader>e :e <C-r>=expand("%:p:h")<CR>/

" 表达式映射
nnoremap <expr> j v:count ? 'j' : 'gj'
nnoremap <expr> k v:count ? 'k' : 'gk'

" 映射到 Lua 函数（Neovim）
nnoremap <leader>f <cmd>lua vim.lsp.buf.format()<CR>

" 清除映射
unmap <leader>f
mapclear

" plugin/my-plugin.vim
if exists('g:loaded_my_plugin')
    finish
endif
let g:loaded_my_plugin = 1

" 默认配置
let g:my_plugin_enabled = get(g:, 'my_plugin_enabled', 1)

" 命令
command! MyPluginEnable  call my_plugin#enable()
command! MyPluginDisable call my_plugin#disable()

" autoload/my_plugin.vim
function! my_plugin#enable()
    let g:my_plugin_enabled = 1
    echo "My Plugin enabled"
endfunction

function! my_plugin#disable()
    let g:my_plugin_enabled = 0
    echo "My Plugin disabled"
endfunction