3.4. Su primer código de Script-Fu
| 3. Un tutorial de Script-Fu |

### 3.4. Su primer código de Script-Fu

¿No necesita parar y tomar algo? ¿No? Bien, entonces procederemos con la cuarta lección, su primer código de Script-Fu.

#### 3.4.1. Crear un código: una caja de texto

Una de las operaciones más comunes que realizo en el GIMP es crear una caja con algún texto en ella para una página web, un logo o algo así. Nunca se sabe el tamaño adecuado de una imagen cuando se empieza. No sabe cuanto espacio llenará el texto con la fuente ni el tamaño de fuente que quiere.

Los maestros de Script-Fu (y los estudiantes), rapidamente, reconocen que este problema puede resolverse, facilmente, y automatizando con Script-Fu.

Crearemos un script, llamado Text Box, que creará una imagen, con el tamaño correctamente ajustado a una linea de texto, que el usuario introduce. También, dejaremos al usuario elegir la fuente, el tamaño de la fuente y el color del texto.

#### 3.4.2. Editar y guardar su código

Hasta ahora, hemos trabajado en la consola de Script-Fu. Ahora, sin embargo, vamos a cambiar para editar códigos de archivos de texto.

Donde situar sus códigos es cuestión de preferencias, si tiene acceso al directorio de scripts predefinido de GIMP, puede situarlos allí. Sin embargo, yo prefiero dejar mis códigos personales en mi propio directorio de scripts, para mantenerlos separados de los instalados de fabrica.

En el directorio `.gimp-2.4`, que el GIMP crea en directorio home, debería encontrar un directorio llamado `scripts`. El GIMP, automaticamente, buscará en su directorio `.gimp-2.4`, el directorio de scripts, y añadirá los scripts de este directorio a la base de datos de Script-Fu. Debería situar sus scripts personales aquí.

#### 3.4.3. Lo esencial al descubierto

Cada script Script-Fu define al menos una función, la cual es la función principal del script. Esta es donde haces el trabajo.

Cada script debe, también, registrarse en la base de datos de procedimientos, para poder acceder a el bajo GIMP.

Definiremos la función principal, primero:

            (define (script-fu-text-box inText inFont inFontSize inTextColor))

Aquí, hemos definido una nueva función llamada script-fu-text-box que toma cuatro parámetros, que, más tarde, corresponderán al texto, una fuente, el tamaño de la fuente y el color del texto. La función está vacia y no hace nada.

#### 3.4.4. Convenciones de nombres

Las convenciones de nombres en Scheme parecen preferir minúsculas con guiones, en el nombre de la función. Sin embargo, parto de la convención con los parámetros. Quiero nombres más descriptivos para mis parámetros y variables, y añado el prefijo "in" a los parámetros, así que, puedo, rapidamente, ver que valores entran en el script, más bien que los que se crean en el. Uso el prefijo "the" para las variables definidas en el script.

Es la convención del GIMP para nombrar sus funciones de códigos Script-Fu, porque así están listados en la base de datos de procedimientos, todos ellos se mostrarán bajo script-fu cuando se estén listando las funciones. Esto, también, ayuda a distinguirlos de los plug-ins.

#### 3.4.5. Registro de la función

Ahora, registremos la función con el GIMP. Esto se hace llamando a la función `script-fu-register`. Cuando el GIMP lee en un script, ejecutará esta función, que registrará el script en la base de datos de procedimientos. Puede situar esta llamada a función donde quiera en su script, pero, normalmente, se situa al final, después de las otras lineas de códigos.

Aquí está el listado de registro de esta función (explicaré todos estos parámetros en un minuto):

            (script-fu-register
              "script-fu-text-box"                        ;func name
              "Text Box"                                  ;menu label
              "Creates a simple text box, sized to fit\
                around the user's choice of text,\
                font, font size, and color."              ;description
              "Michael Terry"                             ;author
              "copyright 1997, Michael Terry"             ;copyright notice
              "October 27, 1997"                          ;date created
              ""                     ;image type that the script works on
              SF-STRING      "Text:"         "Text Box"   ;a string variable
              SF-FONT        "Font:"         "Charter"    ;a font variable
              SF-ADJUSTMENT  "Font size"     '(50 1 1000 1 10 0 1)
                                                          ;a spin-button
              SF-COLOR       "Color:"        '(0 0 0)     ;color variable
            )
            (script-fu-menu-register "script-fu-text-box" "<Toolbox>/Xtns/Script-Fu/Text")

Si guardas estas funciones en un archivo de texto con el sufijo `.scm` en su directorio de script, seleccione Exts → Script-Fu → Refresh Scripts, este nuevo script aparecerá como Exts → Script-Fu → Text → Text Box.

Si llama a este nuevo script, no hará nada, desde luego, pero puede ver los apuntes creados cuando se registra el script (más información de lo que hicimos, se descubrirá luego).

Finalmente, si abre el examinador de procedimientos Exts → Examinador de procedimientos), notará que nuestro script aparece en la base de datos.

#### 3.4.6. Pasos para registrar el código

Para registrar nuestro script en elGIMP, llamamos a la función `script-fu-register`, rellenamos los siete parámetros requeridos y añadimos los nuestros propios, junto con una descripción y valores predefinidos para cada parámetro.

Los parámetros requeridos

- El nombre de la función que definimos. Esto es la llamada de función cuando nuestro script es invocado (el punto de entrada de nuestro script). Esto es necesario porque podriamos definir funciones adicionales bajo el mismo archivo, y GIMP necesita saber a cuales de estas funciones se llama. En nuestro ejemplo, solo definimos una función, text box, que registramos.

- La localización en el menú donde el script será insertado. El lugar exacto de el script está especificado, como una ruta en Unix, con la raiz de la ruta estando entre la caja de herramientas o click derecho. The location in the menu where the script will be inserted. The exact location of the script is specified like a path in Unix, with the root of the path being either toolbox or right-click.

  Si su script no opera sobre una imagen existente (y crea una imagen nueva, como hará nuestro Text Box), querrá insertarlo en el menú de la caja de herramientas, este es el menu en la ventana principal del GIMP (donde se localizan todas las herramientas: herramientas de selección, lupa, etc.).

  Si u script está intentando trabajar sobre una imagen que está siendo editada, querrá insertarla en el menú que aparece cuando pulsa el botón derecho sobre una imagen abierta. El resto de la ruta apunta a la lista de menú, menús y sub-menús. Resgistramos nuestro script Text Box en el menú Text de el menú Script-Fu del menú Exts, en el menú de la caja de herramientas ( Exts → Script-Fu → Text → Text Box ).

  Si se fija, el sub-menú Text, en el menú Script-Fu, no estaba allí cuando empezamos, el GIMP crea, automaticamente, cualquier menú que todavia no exista.

- Una descripción de su script, para ser mostrada en el Examinador de Procedimientos.

- Su nombre (el autor del código).

- Información del copyright.

- La fecha en que se hizó el código, o la última revisión del mismo.

- El tipo de imágenes con las trabaja el script. Puede ser uno de los siguientes: RGB, RGBA, GRAY, GRAYA, INDEXED, INDEXEDA. O podría no ser ninguno de ellos, en nuestro caso, estamos creando una imagen, y no necesitamos definir el tipo de imagen sobre la que trabajaremos.

Figura 12.4. The menu of our script.

#### 3.4.7. Registro de los parámetros del código

Una vez que hemos listado los parámetros requeridos, necesitamos listar los parámetros que corresponden a los parámetros que nuestro script necesita. Cuando listamos estos parámetros, les damos indicación de como son. Esto es por el diálogo que surge cuando el usuario selecciona nuestro script. También podemos proporcionar valores predefinidos.

Esta sección del proceso de registro tiene el siguiente formato:

Tipo de parámetro | Descripción | Ejemplo
--- | --- | ---
SF-IMAGE | Si su script opera en una imagen nueva, esta debería ser el primer parámetro después de los parámetros requeridos. GIMP pasará una referencia a la imagen en este parámetro. | 3
SF-DRAWABLE | Si su script opera sobre una imagen abierta, este sería el segundo parámetro después de el parámetro SF-IMAGE. Se refiere a la capa activa. GIMP pasará una referencia a la capa activa en este parámetro. | 17
SF-VALUE | Acepta números y cadenas. Notese que las cuotas deben eludir el texto predefinido, mejor usar SF-STRING. | 42
SF-STRING | Acepta cadenas. | "Un texto"
SF-COLOR | Indica que color se requiere en este parámetro. | '(0 102 255)
SF-TOGGLE | Se muestra una caja, para obtener un valor Booleano | TRUE o FALSE

#### 3.4.8. The Script-Fu parameter API[5]

| Nota
Beside the above parameter types there are more types for the interactive mode, each of them will create a widget in the control dialog. You will find a list of these parameters with descriptions and examples in the test script `plug-ins/script-fu/scripts/test-sphere.scm` shipped with the GIMP source code.

Tipo de parámetro | Descripción
--- | ---

SF-ADJUSTMENT

Creates an adjustment widget in the dialog.

SF-ADJUSTMENT "label" '(value lower upper step_inc page_inc digits type)

Widget arguments list

Element | Descripción
--- | ---
"label" | Text printed before the widget.
value | Value print at the start.
lower / upper | The lower / upper values (range of choice).
step_inc | Increment/decrement value.
page_inc | Increment/decrement value using page key.
digits | Digits after the point (decimal part).
type | One of: SF-SLIDER or 0, SF-SPINNER or 1

SF-COLOR

TODO: Description

SF-COLOR "label" '(red green blue)

or

SF-COLOR "label" "color"

Widget arguments list

Element | Descripción
--- | ---
"label" | Text printed before the widget.
'(red green blue) | List of three values for the red, green and blue components.
"color" | Color name in CSS notatation.

SF-FONT

TODO: Description

(gimp-text-fontname image drawable x-pos y-pos text border antialias size unit font)

(gimp-text-get-extents-fontname text size unit font)

where font is the fontname you get. The size specified in the fontname is silently ignored. It is only used in the font-selector. So you are asked to set it to a useful value (24 pixels is a good choice).

SF-FONT "label" "fontname"

Widget arguments list

Element | Descripción
--- | ---
"label" | Text printed before the widget.
"fontname" | Name of the default font.

SF-BRUSH | TODO: Description SF-BRUSH "Brush" '("Circle (03)" 100 44 0) Here the brush dialog will be popped up with a default brush of Circle (03) opacity 100 spacing 44 and paint mode of Normal (value 0). If this selection was unchanged the value passed to the function as a parameter would be '("Circle (03)" 100 44 0).
SF-PATTERN | TODO: Description SF-PATTERN "Pattern" "Maple Leaves" The value returned when the script is invoked is a string containing the pattern name. If the above selection was not altered the string would contain "Maple Leaves".
SF-GRADIENT | TODO: Description If the button is pressed a gradient selection dialog will popup. SF-GRADIENT "Gradient" "Deep Sea" The value returned when the script is invoked is a string containing the gradient name. If the above selection was not altered the string would contain "Deep Sea".
SF-PALETTE | TODO: Description If the button is pressed a palette selection dialog will popup. SF-PALETTE "Palette" "Named Colors" The value returned when the script is invoked is a string containing the palette name. If the above selection was not altered the string would contain "Named Colors".
SF-FILENAME | TODO: Description If the button is pressed a file selection dialog will popup. SF-FILENAME "label" (string-append "" gimp-data-directory "/scripts/beavis.jpg") The value returned when the script is invoked is a string containing the filename.
SF-DIRNAME | TODO: Description SF-DIRNAME "label" "/var/tmp/images" The value returned when the script is invoked is a string containing the dirname.
SF-OPTION | TODO: Description The first option is the default choice. SF-OPTION "label" '("option1" "option2") The value returned when the script is invoked is the number of the chosen option, where the option first is counted as 0.
SF-ENUM | TODO: Description SF-ENUM "Interpolation" '("InterpolationType" "linear") The value returned when the script is invoked corresponds to chosen enum value.

[5] This section is not part of the original tutorial.

3.3. Listas, listas y más listas |  | 3.5. Dar algo de sustancia a nuestro script