18 KiB
Capítulo 27. Funciones en Vimscript
Las funciones son medios de abtracción, el tercer elemento en el aprendizaje de un nuevo lenguajes de programación.
En capítulos previos, has visto en acción las funciones nativas de Vimscript (len(), filter(), map(), etc.) y las funciones personalizadas. en este capítulo, vas a profundizar en aprender cómo funcionan las funciones.
Reglas de sintaxis de las funciones
En esencia, una función de Vimscript tiene la siguiente sintaxis:
function {NombreFuncion}()
{algunas_tareas}
endfunction
Una definición de una función debe comenzar con una letra mayúscula. Comienza con la palabra clave function y termina con endfunction. A continuación encontrarás una función válida:
function! Sabrosa()
echo "Sabrosa"
endfunction
La siguiente no es una función válida porque no comienza con una letra mayúscula.
function sabrosa()
echo "Sabrosa"
endfunction
Si antepones una función con el prefijo que la marca como una variable de script (s:), puedes declararla con una letra minúscula . function s:sabrosa() es un nombre válido. La razón de porque Vim necesita que se utilice un nombre con la letra inicial en mayúscula es para prevenir una confusión con las funciones propias de Vim (que son todas en minúsculas).
Un nombre de función no puede comenzar con un número. 1Sabrosa() no es un nombre de función válido, pero Sabrosa1() si lo es. Una función tampoco puede contener caracteres no alfanuméricos menos _. Sabrosa-comida(), Sabrosa&comida() o Sabrosa.comida() todos estos son ejemplos de nombres no válidos para nombres de funciones. Sabrosa_comida() si lo es.
Si defines dos funciones con el mismo nombre, Vim mostrará un error quejándose de que la función Sabrosa ya existe. Para sobrescribit la función previa con el mismo nombre, añade un símbolo ! después de la palabra clave function.
function! Sabrosa()
echo "Sabrosa"
endfunction
Mostrar un listado con las funciones disponibles
Para ver todas las funciones propias y personalizadas en Vim, puedes ejecutar el comando :function. Para ver el contenido de la función Sabrosa, puedes ejecutar :function Sabrosa.
También puedes buscar funciones con un patrón mediante :function /patrón, de manera similar a la navegación de búsqueda con Vim (/patrón). Para buscar todas las funciones que contengan la palabra "map", ejecuta :function /map. Si utilizas complementos externos, Vim mostrará las funciones definidas en esos complementos.
Si quieres ver dónde se origina una función, puedes utilizar el comando :verbose junto con el comando :function. Para buscar dónde se originan todas las funciones que contienen la palabra "map", ejecuta:
:verbose function /map
Cuando lo ejecuto, obtengo un número de resultados. Esto me dice que la función fzf#vim#maps una función de autoload (vuelve a echar un vitazo al capítulo 23) está escrita dentro del archivo ~/.vim/plugged/fzf.vim/autoload/fzf/vim.vim, en la línea 1263. Esto es muy útil a la hora de depurar errores.
function fzf#vim#maps(mode, ...)
Last set from ~/.vim/plugged/fzf.vim/autoload/fzf/vim.vim line 1263
Eliminar una función
Para eliminar una función existente, utiliza :delfunction {Nombre_de_funcion}. Para eliminar Sabrosa, ejecuta :delfunction Sabrosa.
Valor de retorno de una función
Para que una función devuelva un valor, necesitas pasarle de manera explícita un valor return. De otra manera, Vim automáticamente devuelve de manera implícita un valor 0.
function! Sabrosa()
echo "Sabrosa"
endfunction
Un valor return vacío es equivalente a un valor 0.
function! Sabrosa()
echo "Sabrosa"
return
endfunction
Si ejecutas :echo Sabrosa() utilizando la función anterior, después de que Vim muestre la palabra "Sabrosa", devolverá un 0, el valor implícito de retorno. Para hacer que la función Sabrosa() devuelva el valor "Sabrosa", puedes hacer lo siguiente:
function! Sabrosa()
return "Sabrosa"
endfunction
Ahora cuando ejecutas :echo Sabrosa(), esta función devuelve la cadena "Sabrosa".
Puedes utilizar una función dentro de una expresión. Vim utilizará el valor de retorno de esa función. La expresión :echo Sabrosa() . " comida." mostrará "Sabrosa comida."
Argumentos formales
Para pasarle el argumento formal comida a tu función Sabrosa, puedes hacerlo de la siguiente manera:
function! Sabrosa(comida)
return "Sabrosa " . a:comida
endfunction
echo Tasty("paella")
" devuelve "Sabrosa paella"
a: es uno de los ámbitos de las variables mencionados en el capítulo anterior. Es el de variable de parámtero formal. Es la manera de Vim para obtener un parámetro formal en una función. Sin este, Vim mostrará un errror:
function! Sabrosa(comida)
return "Sabrosa " . comida
endfunction
echo Tasty("paella")
" devuelve "undefined variable name" error
Variable local de función
Vamos a ver el otro tipo de variable que no aprendimos en el capítulo anterior: la variable local de función (l:).
Cuando estás escribiendo una función, puedes definir una variable dentro de la función:
function! Delicioso()
let sitio = "panza"
return "Delicioso en mi " . sitio
endfunction
echo Delicioso()
" devuelve "Delicioso en mi panza"
En este contexto, la variable sitio es lo mismo que l:sitio. Cuando defines una variable en una función, es variable es local a esa función. Cuando un usuario ve sitio, podría fácilmente caer en el error de que se trata de una variable global. Por eso prefiero no escatimar en información y siempre añadir l: para indicar que es una variable propia de la función.
Otra razón para utilizar el método l:count al declarar una variable propia de una función es que Vim tiene unas variables especiales con alias que son similares a una variable normal. v:count es un ejemplo. Esta variable tien un alias count. En Vim, llamar a count es lo mismo que que llamar a v:count. Es muy sencillo llamar de manera accidental a una de esas variables especiales.
function! Calorias()
let count = "count"
return "I do not " . count . " my calories"
endfunction
echo Calorias()
" muestra un error
La ejecución anterior muestra un error, porque let count = "count" de manera implícita trata de redefinir una variable especial de Vim v:count. Recuerda que las variables especiales (v:) son de solo lectura. No las puedes cambiar. Para solucionar esto, utiliza l:count:
function! Calorias()
let l:count = "count"
return "I do not " . l:count . " my calories"
endfunction
echo Calories()
" devuelve "I do not count my calories"
Llamar a una función
Vim tiene un comando :call para llamar a una función.
function! Sabrosa(comida)
return "Sabrosa " . a:comida
endfunction
call Sabrosa("salsa")
El comando call no muestra el valor de retorno. Vamos a llamar a la función combinando los comandos call y echo.
echo call Sabrosa("salsa")
¡Vaya! obtuviste un error. El comando call anterior es un comando de la línea de comandos (:call). El comando echo anterior es también un comando para la línea de comandos (:echo). No puedes llamar a un comando para la línea de comandos con otro comando para la línea de comandos. Vamos a utilizar otra opción con el comando call:
echo call("Sabrosa", ["salsa"])
" devuelve "Sabrosa salsa"
Para aclarar cualquier confusión, acabas de utilizar dos comandos call diferentes: el comando :call para la línea de comandos y la función call(). La función call() acepta como su primer argumento el nombre de la función (una cadena) y su segundo argumento los parámetros formales (una lista).
Para aprender más sobre :call y call(), echa un vistazo :h call() y :h :call.
Argumento predeterminado
Puedes crear una función con un valor predeterminado con =. Si llamas a la función Desayuno con solo un argumento, el argumento bebida usará el valor predeterminado "leche".
function! Desayuno(comida, bebida = "Leche")
return "Tomé " . a:comida . " y " . a:bebida . " para desayunar"
endfunction
echo Desayuno("Gofres")
" devuelve Gofres y Leche
echo Desayuno("Cereales", "Zumo de naranja")
" devuelve Cereales y Zumo de naranja
Argumentos de variables
Puedes pasarle una variable a un argumento mediante tres puntos (...). Un argumento de variable es útil cuando no sabes cuantas variables dará un usuario.
Supongamos que estás creando un buffet en el que puedas comer todo lo que desees (nunca sabes cuanta comida comerán tus comensales):
function! Buffet(...)
return a:1
endfunction
Si ejecutas echo Buffet("Fideos"), entonces mostrará "Fideos". Vim utiliza a:1 para mostrar el primer argumento que se le pasa a la función hasta ..., más de 20 (a:1 es el primer argumento, a:2 es el segundo argumento, etc). Si ejecutas echo Buffet("Fideos", "Sushi"), mostrará solo "Fideos", vamos a actualizar la función:
function! Buffet(...)
return a:1 . " " . a:2
endfunction
echo Buffet("Fideos", "Sushi")
" devuelve "Fideos Sushi"
El problema con este método es que si ejecutas echo Buffet("Fideos") (con solo una variables), Vim se quejará de que tiene una variable no definida en a:2. ¿Cómo podemos hacerlo lo suficientemente flexible para mostrar exactamente lo que el usuario le de a la función?
Afortunadamente, Vim tiene una variable especial a:0 para mostrar la longitud del argumento pasado en ....
function! Buffet(...)
return a:0
endfunction
echo Buffet("Fideos")
" devuelve 1
echo Buffet("Fideos", "Sushi")
" devuelve 2
echo Buffet("Fideos", "Sushi", "Helado", "Tofu", "Mochi")
" devuelve 5
Con esto, puedes consultar la longitud del argumento.
function! Buffet(...)
let l:contador_comida = 1
let l:alimentos = ""
while l:contador_comida <= a:0
let l:alimentos .= a:{l:contador_comida} . " "
let l:contador_comida += 1
endwhile
return l:alimentos
endfunction
Las llaves a:{l:contador_comida} es una interpolación de una cadena, utiliza el valor del contador contador_comida para llamar a los argumentos del parámetro formal a:1, a:2, a:3, etc.
echo Buffet("Fideos")
" devuelve "Fideos"
echo Buffet("Fideos", "Sushi", "Helado", "Tofu", "Mochi")
" devuelve todo lo que le has pasado: "Fideos Sushi Helado Tofu Mochi"
El argumento de variable tiene una variable especial más a:000. Tiene el valor de todos los argumentos de variable en un formato de lista.
function! Buffet(...)
return a:000
endfunction
echo Buffet("Fideos")
" devuelve ["Fideos"]
echo Buffet("Fideos", "Sushi", "Helado", "Tofu", "Mochi")
" devuelve ["Fideos", "Sushi", "Helado", "Tofu", "Mochi"]
Vamos a volver a escribir la función para utilizar un bucle for:
function! Buffet(...)
let l:comidas = ""
for elemento_comida in a:000
let l:comidas .= elemento_comida . " "
endfor
return l:comidas
endfunction
echo Buffet("Fideos", "Sushi", "Helado", "Tofu", "Mochi")
" devuelve Fideos Sushi Helado Tofu Mochi
Rango
Puedes definir un rango para una función de Vimscript añadiendo la palabra clave range al final de la definición de la función. Un rango de función tiene disponibles dos variables especiales a:firstline y a:lastline.
function! Desayuno() range
echo a:firstline
echo a:lastline
endfunction
Si estás en la línea 100 y ejecutas call Desayuno(), mostrará 100 tanto para firstline como para lastline. Si visualmente resaltas (mediante v, V, o Ctrl-V) las líneas de la 101 a la 105 y ejecutas call Desayuno(), firstline mostrará 101 y lastline mostrará 105. firstline y lastline muestran el rango mínimo y máximo de la función que es llamada.
También puedes utilizar :call y pasarle un rando. Si ejecutas :11,20call Desayuno(), mostrará 11 para firstline y 20 para lastline.
Te podrías preguntar, "Está bien que una función de Vimscript acepte un rango, pero ¿no puedo obtener el número de línea con line(".")? ¿No hará eso lo mismo?"
Buena pregunta. Si esto es a lo que te refieres:
function! Desayuno()
echo line(".")
endfunction
Al llamar a la función :11,20call Desayuno() ejecuta la función Desayuni 10 veces (una por cada línea del rango). Compara eso con la diferencia de si hubieras pasado el argumento del rango range:
function! Desayuno() range
echo line(".")
endfunction
Al llamar con 11,20call Desayuno() esto ejecuta la función Desayuno una vez.
Si le añades la palabra clave range keyword y le pasas un rango numérico (como 11,20) en la llamada call, Vim solo ejecutará esa función una vez. Si no pasas un rango range y le pasas un rango numérico (como 11,20) en la llamada call, Vim ejecuta esa función un número N de veces deppendiendo del rango (en el caso del ejemplo, N = 10).
Dictionary
You can add a function as a dictionary item by adding a dict keyword when defining a function.
If you have a function SecondBreakfast that returns whatever breakfast item you have:
function! SecondBreakfast() dict
return self.breakfast
endfunction
Let's add this function to the meals dictionary:
let meals = {"breakfast": "pancakes", "second_breakfast": function("SecondBreakfast"), "lunch": "pasta"}
echo meals.second_breakfast()
" devuelve "pancakes"
With dict keyword, the key variable self refers to the dictionary where the function is stored (in this case, the meals dictionary). The expression self.breakfast is equal to meals.breakfast.
An alternative way to add a function into a dictionary object to use a namespace.
function! meals.second_lunch()
return self.lunch
endfunction
echo meals.second_lunch()
" devuelve "pasta"
With namespace, you do not have to use the dict keyword.
Funcref
A funcref is a reference to a function. It is one of Vimscript's basic data types mentioned in Ch. 24.
The expression function("SecondBreakfast") above is an example of funcref. Vim has a built-in function function() that returns a funcref when you pass it a function name (string).
function! Breakfast(item)
return "I am having " . a:item . " for breakfast"
endfunction
let Breakfastify = Breakfast
" devuelve error
let Breakfastify = function("Breakfast")
echo Breakfastify("oatmeal")
" devuelve "I am having oatmeal for breakfast"
echo Breakfastify("pancake")
" devuelve "I am having pancake for breakfast"
In Vim, if you want to assign a function to a variable, you can't just run assign it directly like let MyVar = MyFunc. You need to use the function() function, like let MyFar = function("MyFunc").
You can use funcref with maps and filters. Note that maps and filters will pass an index as the first argument and the iterated value as the second argument.
function! Breakfast(index, item)
return "I am having " . a:item . " for breakfast"
endfunction
let breakfast_items = ["pancakes", "hash browns", "waffles"]
let first_meals = map(breakfast_items, function("Breakfast"))
for meal in first_meals
echo meal
endfor
Lambda
A better way to use functions in maps and filters is to use lambda expression (sometimes known as unnamed function). For example:
let Plus = {x,y -> x + y}
echo Plus(1,2)
" devuelve 3
let Tasty = { -> 'tasty'}
echo Tasty()
" devuelve "tasty"
You can call a function from insisde a lambda expression:
function! Lunch(item)
return "I am having " . a:item . " for lunch"
endfunction
let lunch_items = ["sushi", "ramen", "sashimi"]
let day_meals = map(lunch_items, {index, item -> Lunch(item)})
for meal in day_meals
echo meal
endfor
If you don't want to call the function from inside lambda, you can refactor it:
let day_meals = map(lunch_items, {index, item -> "I am having " . item . " for lunch"})
Method Chaining
You can chain several Vimscript functions and lambda expressions sequentially with ->. Keep in mind that -> must be followed by a method name without space.
Source->Method1()->Method2()->...->MethodN()
To convert a float to a number using method chaining:
echo 3.14->float2nr()
" devuelve 3
Let's do a more complicated example. Suppose that you need to capitalize the first letter of each item on a list, then sort the list, then join the list to form a string.
function! Capitalizer(word)
return substitute(a:word, "\^\.", "\\u&", "g")
endfunction
function! CapitalizeList(word_list)
return map(a:word_list, {index, word -> Capitalizer(word)})
endfunction
let dinner_items = ["bruschetta", "antipasto", "calzone"]
echo dinner_items->CapitalizeList()->sort()->join(", ")
" devuelve "Antipasto, Bruschetta, Calzone"
With method chaining, the sequence is more easily read and understood. I can just glance at dinner_items->CapitalizeList()->sort()->join(", ") and know exactly what is going on.
Closure
When you define a variable inside a function, that variable exists within that function boundaries. This is called a lexical scope.
function! Lunch()
let appetizer = "shrimp"
function! SecondLunch()
return appetizer
endfunction
return funcref("SecondLunch")
endfunction
appetizer is defined inside the Lunch function, which returns SecondLunch funcref. Notice that SecondLunch uses the appetizer, but in Vimscript, it doesn't have access to that variable. If you try to run echo Lunch()(), Vim will throw an undefined variable error.
To fix this issue, use the closure keyword. Let's refactor:
function! Lunch()
let appetizer = "shrimp"
function! SecondLunch() closure
return appetizer
endfunction
return funcref("SecondLunch")
endfunction
Now if you run echo Lunch()(), Vim will return "shrimp".
Learn Vimscript Functions The Smart Way
In this chapter, you learned the anatomy of Vim function. You learned how to use different special keywords range, dict, and closure to modify function behavior. You also learned how to use lambda and to chain multiple functions together. Functions are important tools for creating complex abstractions.
This concludes this Vim guide. However, your Vim journey doesn't end here. In fact, it actually starts now. You should have sufficient knowledge to go on your own or even create your own plugins.
Happy Vimming, friends!