Cómo usar la voz de VoiceOver con AppleScript para nuestros scriptss

Otra función muy útil para aquellos usuarios de VoiceOver es la de poder utilizar la voz de VoiceOver para dar mensajes.

Con esta función podremos utilizar la voz por defecto de VoiceOver para verbalizar un mensaje pero si VoiceOver no está disponible utilizará la voz del sistema.


on sayWithVoiceOver( textToSay )
try
tell application "VoiceOver"
output textToSay
end tell
on error
say textToSay
end try
end sayWithVoiceOver

Cómo saber si VoiceOver puede ser controlado con AppleScript desde un script de AppleScript

Una función muy necesaria para los scripts de AppleScript destinados a funcionar con VoiceOver, el lector de pantallas de Apple para sus productos, es saber si VoiceOver para MacOS tiene habilitada la opción de poder ser controlado por AppleScript ya que esto nos permitirá manipular el comportamiento de VoiceOver desde nuestros scripts de AppleScript.

Para ello lo que hacemos es comunicarnos con la aplicación VoiceOver y probamos a llamar a alguna de sus funciones internas.

El código de nuestra función sería el siguiente:


on isVoiceOverRunningWithAppleScript()
set isRunning to true
-- is AppleScript enabled on VoiceOver --
tell application "VoiceOver"
try
set x to bounds of vo cursor
on error
set isRunning to false
end try
end tell
return isRunning
end isVoiceOverRunningWithAppleScript

Cómo saber si se está ejecutando VoiceOver con AppleScript

Ya hemos visto cómo crear nuestras propias funciones o rutinas con AppleScript para modularizar nuestro código. Y para ayudar a crear una librería interesante de rutinas o funciones de AppleScript vamos a ir viendo en futuros artículos algunos ejemplos de funciones útiles.

Para comenzar esta serie de artículos comenzaremos por una función muy sencilla y muy útil para usuarios ciegos de MacOS.

Saber si VoiceOver se está ejecutando

Para nuestros scripts puede que necesitemos saber si se está ejecutando VoiceOver. Veamos un ejemplo muy sencillo de una función que nos devuelve true o false dependiendo si VoiceOver se está ejecutando o no.

El código es el siguiente:


on isVoiceOverRunning()
set isRunning to false
tell application "System Events"
set isRunning to (name of processes) contains "VoiceOver"
end tell
return isRunning
end isVoiceOverRunning

Lo que hace esta función es preguntar a la aplicación System Events si se está ejecutando algún programa o servicio en nuestra máquina que se llame o que contenga la cadena de texto VoiceOver. Si encuentra algún programa o servicio que cumpla esa condición actualizaría el valor de la variable isRunning a true, si no dejaría el valor inicial que es false.

Cómo crear nuestras propias funciones en AppleScript

Dentro de cualquier lenguaje de programación es necesario utilizar alguna característica del lenguaje que permita modularizar el código para que pueda ser reutilizado, sea más sencillo de leer y mantener y esté mejor estructurado dentro del fichero de código que lo contiene. En AppleScript esto se consigue utilizando funciones o subrutinas.

Una función o subrutina en un lenguaje de programación consiste en un bloque de código que puede ser ejecutado desde otras funciones o subrutinas. Es como un pequeño programa dentro de un programa más grande.

La ejecución de una función o subrutina puede ser modificada gracias a que podemos enviarle parámetros. Por ejemplo, imaginemos una función que calcula la suma de dos números cualesquiera. Los parámetros para dicha función serían esos dos números cualesquiera.

Las funciones o subrutinas pueden devolver un valor, por ejemplo el resultado de la suma de dos números.

Creación simple de una función o subrutina

Ya hemos visto la creación y uso de funciones y subrutinas con AppleScript en otros artículos pero ahora lo vamos a ver con más detalle.

Para crear una función o subrutina utilizamos el comando on seguido del nombre que queramos darle a nuestra subrutina. El nombre de toda subrutina en AppleScript debe acabar con los símbolos de abre y cierra paréntesis ( ) ya que entre estos paréntesis es donde irán, si son necesarios, los parámetros que pasaremos a la subrutina.

A continuación del nombre de la función deberemos ir a la siguiente línea para comenzar el bloque de código a ejecutar dentro de la subrutina y por último indicamos el fin de la subrutina con el comando end seguido del nombre de nuestra subrutina pero esta vez sin los paréntesis para parámetros.


on miFuncion()
say "Esta es mi función"
end miFuncion

Llamando a una función para ser ejecutada

Para ejecutar una función simplemente debemos llamarla con su nombre seguido de los parámetros que necesite encerrados entre paréntesis. Si no requiere ningún parámetro simplemente deberemos usar los paréntesis vacíos.

Veamos un ejemplo simple en el que desde el evento run de nuestro script llamamos a nuestra función saluda().


on saluda()
say "Hola a todos"
end saluda

on run
saluda()
end run

Pasando parámetros a nuestra función

Para pasar parámetros a una función simplemente debemos declararlos a la hora de definir nuestra función con el comando on colocando cada parámetro dentro de los paréntesis separados por el caracter coma (,).

Veamos un ejemplo muy simple de una función verbalizaSuma


on verbalizaSuma(num1, num2)
set resultado to num1 + num2
say resultado
end suma

Para poder ejecutar nuestra función deberemos llamarla indicando dos números como parámetros.

El ejemplo completo sería el siguiente:


on verbalizaSuma(num1, num2)
set resultado to num1 + num2
say resultado
end verbalizaSuma

on run
verbalizaSuma(32, 23)
end run

Devolviendo un resultado desde nuestra función

Uno de los objetivos más importantes de las subrutinas o funciones es la de calcular un resultado según los valores que se le hayan pasado como parámetros. Para ello la función nos tiene que devolver un resultado.

En AppleScript utilizamos el comando return para devolver un resultado. Hay que tener cuidado ya que cualquier código que esté después del comando return no se ejecutará. Veamos el siguiente ejemplo:


on resta(num1, num2)
return num1 - num2
say "Este mensaje nunca se leerá"
end resta

Reescribamos nuestro ejemplo de la suma para que en lugar de verbalizaSuma utilicemos una función más genérica la cual sólo calculará la suma de dos números. El ejemplo quedaría así:


on suma(num1, num2)
return num1 + num2
end suma

on run
say "El resultado de sumar 22 y 33 es " & suma(22, 33)
end run

Fijaos que la llamada a la función suma() se ha indicado como un valor más de la cadena de texto que se va a verbalizar. Esto se debe a que cualquier llamada a una función se resuelve antes que el código en el que se encuentra la llamada.

Modularizar es bueno

Gracias a la posibiilidad de crear nuestras propias subrutinas o funciones podemos crear nuestra propia librería de funciones para resolver tareas como por ejemplo saber si VoiceOver está en ejecución, enviar un correo electrónico con una sola línea de código, cambiar aspectos de la interfaz gráfica de forma más sencilla, etc. Estas subrutinas pueden ser almacenadas en un fichero de código a parte y sólo copiar y pegar en el fichero de script que estemos trabajando aquellas funciones que vayamos a utilizar. De esta forma nuestro código será más sencillo de leer y mantener.

Eventos de ejecución en aplicaciones creadas con AppleScript

En el artículo Convertir un AppleScript en una aplicación para MacOS aprendimos cómo convertir nuestro script de AppleScript en una aplicación. Esto, entre otras ventajas, nos permite poder ejecutar más rapidamente nuestro script. Pero además podremos acceder a ciertos eventos que se dan en las aplicaciones.

Evento run

El evento run se ejecuta al arrancar la aplicación. Ya hemos visto código que utiliza este evento ya que la función on run se da tanto en aplicaciones como scripts de AppleScript.

Este evento suele utilizarse para inicializar valores para variables, preparar o cargar los recursos necesarios para ejecutar correctamente la aplicación o mostrar la interfaz de bienvenida al usuario.

Evento quit

El evento quit se produce cuando la aplicación va a terminar de ejecutarse y antes de cerrarse dispara el evento quit y ejecuta el código que hayamos codificado para él.

Este evento sólo está disponible cuando convertimos nuestro script en aplicación. Por ejemplo, veamos el siguiente código:


on quit
display alert "Adios a todos!"
end quit

on run
display alert "Hola a todos!"
end run

Si ejecutamos el código en el editor de AppleScript sólo se mostrará el mensaje de saludo pero nunca la despedida. Para poder ver la despedida deberemos convertir nuestro script de AppleScript en una aplicación de MacOS y ejecutarla como una app más. Entonces veremos el mensaje de despedida tras el mensaje de saludo.

Evento idle

El evento idle nos permite ejecutar un código de script cada X segundos. Con esto podemos crear aplicaciones que repitan un script cada cierto tiempo.

Este evento sólo está disponible cuando convertimos nuestro script en aplicación.

Otro requisito de este evento es que requiere más tiempo de ejecución que una aplicación habitual de AppleScript por lo que es recomendable que cuando vayamos a exportar nuestro script para convertirlo en aplicación verifiquemos la casilla Permanecer abierto tras el gestor de ejecución asegurándonos que nuestra ventana de aplicación permanece abierta ejecutando el evento idle hasta que decidamos cerrar la ventana de la aplicación de forma manual.

Al codificar el evento idle debemos finalizar su codificación devolviendo un número que representará el número de segundos necesarios para volver a ejecutar el evento idle. Por ejemplo, el valor 60 se referirá a un minuto y el valor 3600 a una hora. Para devolver ese valor usamos el comando return que nos permite devolver un resultado cuando ejecutamos una función de AppleScript.

Veamos un ejemplo muy sencillo. Vamos a crear una aplicación que reproducirá un sonido cada minuto.


on idle
do shell script "afplay /System/Library/Sounds/Blow.aiff"
return 60
end idle

Ejemplo completo

Nuestro ejemplo deberá realizar las siguientes tareas:

  1. Saludar al inicio
  2. Reproducir un sonido cada 30 segundos
  3. Despedirse al cerrar la ventana de la aplicación

el código sería algo como lo siguiente:


on run
display alert "Hola a todos!"
end run

on quit
display alert "Adios a todos!"
end quit

on idle
do shell script "afplay /System/Library/Sounds/Blow.aiff"
return 30
end idle

Recuerda verificar la casilla Permanecer abierto tras el gestor de ejecución al exportar tu script para convertirlo en aplicación.

Cómo obtener texto del usuario con AppleScript

En anteriores artículos hemos visto diversas opciones para que el usuario pueda elegir qué debe suceder al utilizar uno de nuestros scripts. Pero a veces necesitamos que el usuario nos de información que no hemos podido predecir a la hora de crear nuestro script. Esta información debe ser introducida a través de un campo de texto el cual puede ser utilizado por el usuario para aportar cualquier información que necesite nuestro script y el usuario quiera ofrecer.

Hemos visto ya el comando de AppleScript display dialog. Este comando también nos permite configurarlo para que muestre un campo de texto al usuario. Su sintaxis sería la siguiente:


display dialog "Texto de la pregunta" default answer ""

Obteniendo la respuesta

Como viene siendo habitual para poder hacer algo con la información introducida o seleccionada por el usuario debemos almacenarla en una variable. Podemos hacerlo de la siguiente forma:


set dialogResult to display dialog "?Cual es tu nombre?" default answer ""
set theName to the text returned of (dialogResult)

Primero almacenamos el resultado de la pregunta en la variable dialogResult y luego obtenemos el texto de dialogResult almacenandolo en la variable theName.

Podemos hacer estas dos operaciones en un sólo paso aunque se dificulta la lectura del código de nuestro script. El ejemplo quedaría de la siguiente forma:


set theName to the text returned of (display dialog "?Cual es tu nombre?" default answer "")

Un pequeño ejemplo

Vamos a crear un pequeño script que nos pregunte nuestro nombre y nos muestre un saludo personalizado.


set dialogResult to display dialog "?Cual es tu nombre?" default answer ""
set theName to the text returned of (dialogResult)
set sayHelloText to "Hola " & theName
display alert sayHelloText