Guida rapida a Vimscript

Vimscript è il linguaggio di scripting integrato per personalizzare ed estendere l'editor di testo Vim.

Per Iniziare

let name = "John"
echo "Hello, " . name

Puoi salvare questo codice in un file (script.vim) ed eseguirlo con (:source script.vim), oppure eseguire comandi direttamente in modalità normale via :let ed :echo.

Imparare con gli Esempi

function! SuperTab()
  let l:part = strpart(getline('.'), col('.') - 2, 1)
  if (l:part =~ '^\W\?$')
    return "\<Tab>"
  else
    return "\<C-n>"
  endif
endfunction

imap <Tab> <C-R>=SuperTab()<CR>

Variabili

Definizione

let var = "hello"

Prefissi di Ambito delle Variabili

let g:ack_options = '-s -H'    " g: global
let s:ack_program = 'ack'      " s: local (to script)
let l:foo = 'bar'              " l: local (to function)
let a:arg = 'baz'              " a: function argument

Il prefisso s: può essere usato anche per funzioni locali allo script. Vedi :help local-variables.

Altri Ambiti

let w:foo = 'bar'    " w: window local
let b:state = 'on'   " b: buffer local
let t:state = 'off'  " t: tab page local
echo v:version       " v: vim internal variable

let @/ = ''          " @  register
echo $PATH           " $  environment variable

Opzioni di Vim

echo 'tabstop is ' . &tabstop
if &insertmode
echo &g:option
echo &l:option

Aggiungi il prefisso & ai nomi delle opzioni per leggerle o modificarle nelle espressioni.

Operatori Aritmetici e di Stringa

a + b             " Numbers only!
'hello ' . name   " String concatenation

let var -= 2
let var += 5
let var .= 'string'

Stringhe

Sintassi delle Stringhe

let str = "String"
let str = "String with \n newline"

let literal = 'literal, no \ escaping'
let literal = 'that''s enough'

echo "result = " . res

Funzioni per Stringhe

strlen(str)
len(str)
strchars(str)

split("one two three")       "=> ['one', 'two', 'three']
split("one.two.three", '.')  "=> ['one', 'two', 'three']

join(['a', 'b'], ',')        "=> 'a,b'

tolower('Hello')
toupper('Hello')

Funzioni

Definizione di Funzioni

function! s:Initialize(cmd, args)
  echo "Command: " . a:cmd
  return 1
endfunction

Sovrascrittura di Funzioni

function! MyFunc()
  echo "Function defined or replaced"
endfunction

L'uso di function! (con !) sostituisce qualsiasi funzione precedentemente definita con lo stesso nome senza generare errori.

Namespace e Autoload

function! myplugin#hello()
  " autoload/myplugin.vim
endfunction

Chiamata di Funzioni

call s:Initialize()
call s:Initialize("hello", 123)

Cattura dei Valori di Ritorno

let result = s:Initialize()

Interruzione in caso di errore (Abort)

function! MyFunction() abort
endfunction

Argomenti Variadici

function! Infect(...)
  echo a:0
  echo a:1
  echo a:2

  for item in a:000
    echon ' ' . item
  endfor
endfunction

call Infect('jake', 'bella')

Cicli e Controllo del Flusso

Cicli (Loops)

for s in list
  echo s
  continue
  break
endfor

while x < 5
  let x += 1
endwhile

Comandi Personalizzati (Custom Commands)

Definizione dei Comandi

command! Save :set fo=want tw=80 nowrap

I comandi definiti dall'utente devono iniziare con una lettera maiuscola. Il punto esclamativo ! permette di sovrascrivere comandi esistenti.

Invocazione di Funzioni nei Comandi

command! Save call <SID>Foo()

function! s:Foo()
endfunction

Argomenti dei Comandi

command! -nargs=? Save call script#foo(<args>)

Specifica Argomenti	Descrizione
`-nargs=0`	0 argomenti (predefinito)
`-nargs=1`	Esattamente 1 argomento (può contenere spazi)
`-nargs=?`	0 o 1 argomento
`-nargs=*`	0 o più argomenti separati da spazio
`-nargs=+`	1 o più argomenti separati da spazio

Condizionali

If / Elseif / Else

let char = getchar()
if char == "\<LeftMouse>"
elseif char == "\<RightMouse>"
else
endif

Valutazione Booleana (Truthiness)

if 1       "=> True
if 0       "=> False
if "1"     "=> True
if "456"   "=> True
if "xfz"   "=> False

Vimscript non ha un tipo booleano separato: 0 è falso e qualsiasi intero diverso da zero è vero.

Operatori di Confronto

if 3 > 2
if a && b
if (a && b) || (c && d)
if !c

Case Sensitivity nelle Stringhe

if name ==# 'John'     " case-sensitive
if name ==? 'John'     " case-insensitive
if name == 'John'      " &ignorecase

Confronto di Identità

if a is b
if a isnot b

Verifica se a e b puntano alla stessa identica istanza in memoria.

Corrispondenze con Espressioni Regolari

"hello" =~ 'xx*'
"hello" !~ 'xx*'
"hello" =~ '\v<\d+>'

\v attiva la sintassi 'very magic', evitando escape pesanti per caratteri speciali.

Istruzioni su Singola Riga

if empty(a:path) | return [] | endif
let status = a ? b : c

Usa | per concatenare più istruzioni sulla stessa riga.

Strutture Dati

Liste (Lists)

let mylist = [1, "two", 3, "four"]

let first = mylist[0]
let last  = mylist[-1]

let second = get(mylist, 1)
let fallback = get(mylist, 10, "NONE")

Operazioni sulle Liste

len(mylist)
empty(mylist)

let sortedlist = sort(copy(mylist))

let shortlist = mylist[2:-1]
let shortlist = mylist[2:]
let single = mylist[2:2]

let longlist = mylist + [5, 6]
let mylist += [7, 8]
call add(mylist, 9)

Metodi Funzionali per Liste

call map(files, "bufname(v:val)")
call filter(files, 'v:val != ""')

Dizionari (Dictionaries)

let colors = {
  \ "apple": "red",
  \ "banana": "yellow"
}

echo colors["apple"]
echo get(colors, "apple")

Operazioni sui Dizionari

call remove(colors, "apple")

if has_key(dict, 'foo')
if empty(dict)
let k = keys(dict)
let v = values(dict)
let n = len(dict)

echo max(dict)
echo min(dict)

call extend(s:fruits, { "cherry": "red" })

for key in keys(mydict)
  echo key . ': ' . mydict[key]
endfor

I prefissi di ambito (s:, g:, l:, b:) sono essi stessi accessibili come dizionari:

let script_keys = keys(s:)

Numeri e Aritmetica

let int = 1000
let hex = 0xff
let oct = 0755
let fl = 100.1
let sci = 5.4e4

3 / 2     "=> 1
3 / 2.0   "=> 1.5

sqrt(100)
floor(3.5)
ceil(3.3)
abs(-3.4)

Specificità di Vim

Esecuzione Dinamica di Comandi (execute)

execute "vsplit"
execute "edit " . fnameescape(filename)

Simulazione Pressioni Tasti in Modalità Normale

normal G
normal! G

execute "normal! gg/foo\<cr>dd"

Espansione Nomi File

echo expand("%")      " path/file.txt
echo expand("%:t")    " file.txt
echo expand("%:p:h")  " /home/user/path
echo expand("%:r")    " path/file
echo expand("%:e")    " txt

Controllo Output e Messaggi

silent g/pattern/p

echo 'Simple text'
echomsg 'Persistent text recorded in :messages'
echoerr 'Error message'

echohl WarningMsg | echomsg "=> Warning!" | echohl None

Opzioni di Configurazione

set number
set nonumber
set number!
set numberwidth=5
set guioptions+=e

Introspezione e Rilevamento Funzionalità

has("clipboard")
executable("python3")
globpath(&rtp, "syntax/c.vim")

exists("$ENV")
exists(":command")
exists("variable")
exists("+option")

Mappature dei Tasti (Key Mappings)

Modalità

[nvixso](nore)map

Flag Comuni per le Mappature

Flag	Significato
`<buffer>`	Locale solo per il buffer corrente
`<silent>`	Non visualizzare il comando nella barra di stato
`<nowait>`	Esegui immediatamente senza attendere

Evidenziazione della Sintassi e Conceal

Gruppi di Evidenziazione

hi Comment term=bold gui=bold ctermfg=4 guifg=#80a0ff
hi def link markdownH1 htmlH1

Rilevamento del Tipo di File

augroup filetypedetect
  au! BufNewFile,BufRead *.json setf javascript
augroup END

au Filetype markdown setlocal spell

Occultamento Testo (Conceal)

set conceallevel=2
syn match newLine "<br>" conceal cchar=}
hi newLine guifg=green

Guardie di Inclusione

if exists('g:loaded_myplugin')
  finish
endif
let g:loaded_myplugin = 1