]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/es/extending/programming-interface.itely
Run update-with-convert-ly
[lilypond.git] / Documentation / es / extending / programming-interface.itely
index 56d7f6a39d69a571681aeff3ba8ecaa30d1b956d..0a5336b488d158525f552e99135f027622c6bf23 100644 (file)
@@ -1,13 +1,13 @@
 @c -*- coding: utf-8; mode: texinfo; documentlanguage: es -*-
 @c This file is part of extending.tely
 @ignore
-    Translation of GIT committish: 2055f35c47a045a50a01ff4dba8524322cfc3b48
+    Translation of GIT committish: abf44faa7aff3481efcd8b241c352c6d5080ccd5
 
     When revising a translation, copy the HEAD committish of the
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
-@c \version "2.14.0"
+@c \version "2.15.17"
 
 @node Interfaces para programadores
 @chapter Interfaces para programadores
@@ -19,9 +19,10 @@ Scheme, @ref{Tutorial de Scheme}.
 
 
 @menu
-* Bloques de código de Lilypond::
+* Bloques de código de LilyPond::
 * Funciones de Scheme::
 * Funciones musicales::
+* Funciones de eventos::
 * Funciones de marcado::
 * Contextos para programadores::
 * Funciones de callback::
@@ -29,21 +30,21 @@ Scheme, @ref{Tutorial de Scheme}.
 * Trucos difíciles::
 @end menu
 
-@node Bloques de código de Lilypond
-@section Bloques de código de Lilypond
+@node Bloques de código de LilyPond
+@section Bloques de código de LilyPond
 @translationof Lilypond code blocks
 
-Los bloques de código de Lilypond tienen el siguiente aspecto:
+Los bloques de código de LilyPond tienen el siguiente aspecto:
 @example
-  #@{ @var{código de Lilypond} #@}
+  #@{ @var{código de LilyPond} #@}
 @end example
 Se pueden usar en cualquier lugar en el que se pueda escribir código
 de Scheme: el lector de Scheme en efecto se modifica para que pueda
-incorporar bloques de código de Lilypond.  Mientras se está leyendo el
-bloque de código de Lilypond, se analiza sintácticamente de forma
+incorporar bloques de código de LilyPond.  Mientras se está leyendo el
+bloque de código de LilyPond, se analiza sintácticamente de forma
 superficial y se sustituye por una llamada al analizador sintáctico de
-Lilypond, que funciona en tiempo de ejecución para que interprete el
-bloque de código de Lilypond.
+LilyPond, que funciona en tiempo de ejecución para que interprete el
+bloque de código de LilyPond.
 
 El objeto del análisis superficial es la interpretación de los
 símbolos @code{$} que se pueden usar para aislar expresiones del
@@ -53,15 +54,15 @@ siguientes:
 
 @table @code
 @item $$
-simplemente pasa un único símbolo @code{$} al analizador de Lilypond.
+simplemente pasa un único símbolo @code{$} al analizador de LilyPond.
 @item $@var{forma}
 evalúa la forma Scheme en tiempo de ejecución y la analiza como un
-identificador @code{\forma} en el analizador de Lilypond.  Dependiendo
+identificador @code{\forma} en el analizador de LilyPond.  Dependiendo
 del tipo del valor, se puede interpretar como varias entidades
 sintácticas diferentes.
 @item #$@var{forma}
 evalúa la forma de Scheme en tiempo de ejecución y analiza su valor
-como una espresión de Scheme dentro del analizador de LilyPond.
+como una expresión de Scheme dentro del analizador de LilyPond.
 @item #@var{forma}
 las formas que están dentro de expresiones de Scheme y que comienzan
 por @code{#} se leen y se analizan recursivamente hasta que se
@@ -72,7 +73,7 @@ analiza el valor de la variable dentro de la expresión circundante.
 analiza el valor de la forma dentro de la expresión circundante.  Al
 contrario que las @code{$@var{formas}} a nivel de LilyPond,
 necesitamos separar la forma con un espacio en blanco, haciendo que
-@code{$} sea reconocible como un símblo de Scheme separado.
+@code{$} sea reconocible como un símbolo de Scheme separado.
 @end table
 
 Un bloque de código de LilyPond puede contener cualquier cosa que
@@ -84,8 +85,9 @@ convierte en una expresión de música secuencial.
 @node Funciones de Scheme
 @section Funciones de Scheme
 @translationof Scheme functions
+@cindex Scheme, funciones de (sintaxis de LilyPond)
 
-Las @emph{funciones de Scheme} son procedimientos de Scheme que poeden
+Las @emph{funciones de Scheme} son procedimientos de Scheme que pueden
 crear expresiones de Scheme a partir de código de entrada escrito en
 la sintaxis de LilyPond.  Se pueden llamar desde prácticamente
 cualquier lugar en el que se permita el uso de @code{#} para la
@@ -103,6 +105,7 @@ la sintaxis de LilyPond.
 @node Definición de funciones de Scheme
 @subsection Definición de funciones de Scheme
 @translationof Scheme function definitions
+@funindex define-scheme-function
 
 La forma general de la definición de una función de Scheme es:
 
@@ -118,13 +121,32 @@ funcion =
 donde
 
 @multitable @columnfractions .33 .66
+@item @code{parser}
+@tab tiene que ser literalmente @code{parser} para dar a los bloques de código
+de LilyPond (@code{#@{}@dots{}@code{#@}}) acceso al analizador sintáctico.
+
 @item @code{@var{argN}}
 @tab @var{n}-ésimo argumento
 
 @item @code{@var{typeN?}}
 @tab un @emph{predicado de tipo} de Scheme para el que @code{@var{argN}}
 debe devolver @code{#t}.  Algunos de estos predicados se reconocen de
-forma especial por parte del analizador, véase más abajo.
+forma especial por parte del analizador, véase más abajo.  También
+existe una forma especial @code{(@emph{predicate?} @emph{default})}
+para especificar argumentos opcionales.  Si el argumento actual no
+está presente cuando se llama a la función, el valor predeterminado se
+emplea en sustitución.  Los valores predeterminados se evalúan en
+tiempo de definición (¡incluyendo los bloques de código de LilyPond!),
+de manera que se necesitamos un valor por omisión calculado en tiempo
+de ejecución, debemos escribir en su lugar un valor especial que
+podamos reconocer fácilmente.  Si escribimos el predicado entre
+paréntesis pero no lo seguimos por el valor predeterminado, se usa
+@code{#f} como valor por omisión.  Los valores por omisión no se
+verifican con @emph{predicate?} en tiempo de definición ni en tiempo
+de ejecución: es nuestra responsabilidad tratar con los valores que
+especifiquemos.  Los valores por omisión que son expresiones musicales
+se copian mientras se establece @code{origin} al parámetro
+@code{location}.
 
 @item @code{@var{cuerpo}}
 @tab una secuencia de formas de Scheme que se evalúan ordenadamente; la
@@ -132,11 +154,12 @@ forma especial por parte del analizador, véase más abajo.
 función de Scheme. Puede contener bloques de código de LilyPond
 encerrados entre llaves con almohadillas
 (@tie{}@w{@code{#@{@dots{}#@}}}@tie{}), como se describe en
-@ref{Bloques de código de Lilypond}.  Dentro de los bloques de código
+@ref{Bloques de código de LilyPond}.  Dentro de los bloques de código
 de LilyPond, use el símbolo del dólar @code{$} para hacer referencia a
 argumentos de función (p.ej. @samp{$arg1}) o para iniciar una
 expresión en línea de Scheme que contenga argumentos de función
-(p.ej. @w{@samp{$(cons arg1 arg2)}}).
+(p.ej. @w{@samp{$(cons arg1 arg2)}}).  Si la función devuelve una
+expresión musical, se clona y se le da el @code{origin} correcto.
 @end multitable
 
 @noindent
@@ -178,7 +201,13 @@ Las funciones de Scheme se pueden llamar casi desde cualquier lugar en
 que puede escribirse una expresión de Scheme que comience con la
 almohadilla@tie{}@code{#}.  Llamamos a una función de Scheme
 escribiendo su nombre precedido de la barra invertida@tie{}@code{\}, y
-seguido por sus argumentos.
+seguido por sus argumentos.  El último argumento no puede ser un
+argumento opcional.  Si hay varios argumentos opcionales seguidos, se
+rellenan con valores de izquierda a derecha.  Desde el momento en que
+un argumento opcional no corresponde con la entrada, éste y todos los
+argumentos opcionales inmediatamente siguientes se sustituyen por sus
+valores predeterminados, y la correspondencia continúa con el
+siguiente argumento no opcional.
 
 Aparte de los lugares en que se requiere un valor de Scheme hay
 ciertos sitios en que se aceptan expresiones de almohadilla @code{#} y
@@ -190,7 +219,7 @@ Hay ciertos lugares especiales en los que un argumento que corresponde
 a @code{ly:music?} tiene que ser un identificador musical o bien una
 expresión musical encerrada dentro de @code{@{}@dots{}@code{@}} o
 @code{<<}@dots{}@code{>>} de forma explícita, de manera que las
-duraciones o post-eventos ocionales que posiblemente le sigan no
+duraciones o post-eventos opcionales que posiblemente le sigan no
 puedan confundirse con argumentos adicionales.  Un sitio obvio es
 antes de un predicado @code{ly:duration?}.  Otro es el último
 argumento de una función de Scheme cuando se utiliza en un lugar en
@@ -216,13 +245,15 @@ noApuntarYPulsar =
      ()
    (ly:set-option 'point-and-click #f))
 ...
-\noPointAndClick   % desactivar la función de apuntar y pulsar
+\noApuntarYPulsar   % desactivar la función de apuntar y pulsar
 @end example
 
 @node Funciones musicales
 @section Funciones musicales
 @translationof Music functions
 
+@cindex funciones musicales
+
 Las @emph{funciones musicales} son procedimientos de Scheme que pueden
 crear automáticamente expresiones musicales, y se pueden usar para
 simplificar enormemente el archivo de entrada.
@@ -241,6 +272,8 @@ simplificar enormemente el archivo de entrada.
 @node Definiciones de funciones musicales
 @subsection Definiciones de funciones musicales
 @translationof Music function definitions
+@cindex definición de funciones musicales
+@funindex define-music-function
 
 La forma general para definir funciones musicales es:
 
@@ -255,7 +288,7 @@ funcion =
 @noindent
 de forma bastante análoga a @ref{Definición de funciones de Scheme}.
 Lo más probable es que el @var{cuerpo} sea un
-@ref{Bloques de código de Lilypond,bloque de código de LilyPond}.
+@ref{Bloques de código de LilyPond,bloque de código de LilyPond}.
 
 Para ver una lista de los predicados de tipo disponibles, consulte
 @ruser{Predicados de tipo predefinidos}.
@@ -277,42 +310,40 @@ Archivos de inicio:
 
 Las funciones musicales se pueden actualmente utilizar en tres
 lugares.  Dependiendo de dónde se usan, son de aplicación ciertas
-restricciones para que sea posible su anámusicisis sintáctico de forma
+restricciones para que sea posible su análisis sintáctico de forma
 no ambigua.  El resultado que devuelve una función musical debe ser
 compatible con el contexto desde el que se la llama.
 
 @itemize
 @item
-At top level in a music expression.  There are no special restrictions
-on the argument list.
+En el nivel superior dentro de una expresión musical.  No existen
+especiales restricciones sobre la lista de argumentos.
 
 @item
-As a post-event.  All trailing arguments of the music function with the
-predicate @code{ly:music?} will get parsed also as post-events.  Note
-that returning post-events will also be acceptable for music functions
-called at top level, leading to a result roughly equivalent to
+Como un post-evento, que comienza explícitamente con un indicador de
+dirección (a elegir entre @code{-}, @code{^} @w{y @code{_}}).  Todos
+los argumentos añadidos al final de la función musical con el
+predicado @code{ly:music?} se analizan sintácticamente también como
+post-eventos (si el último argumento es una función de Scheme, éste
+contendrá en su lugar los argumentos @code{ly:music?} del final de la
+función de Scheme).  Observe que se puede aceptar la devolución de un
+post-evento por parte de las funciones musicales que se llaman como
+música normal, lo que lleva a un resultado aproximadamente equivalente
+a
 @example
 s 1*0-\fun
 @end example
 
 @item
-As a chord constituent.  All trailing arguments of the music function
-with the predicate @code{ly:music?} will get parsed also as chord
-constituents.
+Como componente de un acordes.  Todos los argumentos añadidos al final
+de la función musical con el predicado @code{ly:music?} se analizarán
+sintácticamente también como componentes de acorde.
 @end itemize
 
 @noindent
-The special rules for trailing arguments make it possible to write
-polymorphic functions like @code{\tweak} that can be applied to
-different constructs.
-
-There is another somewhat special rule: if you have a predicate
-@code{ly:music?} directly before a @code{ly:duration?} predicate, then
-the corresponding music expression must be either a music identifier, or
-literal sequential or parallel music enclosed in
-@code{@{}@dots{}@code{@}} or @code{<<}@dots{}@code{>>} explicitly.
-Otherwise, Lilypond could get confused about where the music ends and
-the duration starts.
+Las reglas especiales para los argumentos del final hacen posible
+escribir funciones polimórficas como @code{\tweak} que se pueden
+aplicar a construcciones distintas.
 
 @node Funciones de sustitución sencillas
 @subsection Funciones de sustitución sencillas
@@ -462,12 +493,37 @@ lilypond -d display-bar-numbers ARCHIVO.ly
 @subsection Funciones musicales vacías
 @translationof Void music functions
 
-A music function must return a music expression.  If you want to execute
-a function only for its side effect, it might make more sense to use a
-scheme function instead.  But there may be cases where you sometimes
-want to produce a music expression, and sometimes not (like in the
-previous example).  Returning a @code{void} music expression via
-@code{#@{ #@}} will do that.
+Una función musical debe devolver una expresión musical.  Si quiere
+ejecutar una función exclusivamente por sus efectos secundarios,
+podría ser más sensato usar en su lugar una función de Scheme.  Pero
+puede haber casos en los que a veces queremos producir una expresión
+musical, y a veces no (como en el ejemplo anterior).  Devolver una
+expresión musical @code{void} (vacía) por medio de @code{#@{ #@}} lo
+hace posible.
+
+
+@node Funciones de eventos
+@section Funciones de eventos
+@translationof Event functions
+@funindex define-event-function
+@cindex event functions
+
+Para usar una función musical en el lugar de un evento, tenemos que
+escribir un indicador de dirección antes de ella.  Pero a veces, ello
+hace que se pierda la correspondencia con la sintaxis de las
+construcciones que queremos sustituir.  Por ejemplo, si queremos
+escribir instrucciones de matiz dinámico, éstos se adjuntan
+habitualmente sin indicador de dirección, como @code{c'\pp}.  He aquí
+una forma de escribir indicaciones dinámicas arbitrarias:
+
+@lilypond[quote,verbatim,raggedright]
+dyn=#(define-event-function (parser location arg) (markup?)
+(make-dynamic-script arg)) \relative c' { c\dyn pfsss }
+@end lilypond
+
+Podríamos hacer lo mismo usando una función musical, pero entonces
+tendríamos que escribir siempre un indicador de dirección antes de
+llamarla, como @code{@w{c-\dyn pfsss}}.
 
 
 @node Funciones de marcado
@@ -510,10 +566,10 @@ equivale a:
 @noindent
 Este ejemplo muestra las principales reglas de traducción entre la
 sintaxis del marcado normal de LilyPond y la sintaxis del marcado de
-Scheme.  Using @code{#@{
-@dots{} #@}} for entering in Lilypond syntax will often be most
-convenient, but we explain how to use the @code{markup} macro to get a
-Scheme-only solution.
+Scheme.  La utilización de @code{#@{ @dots{} #@}} para escribir en la
+sintaxis de LilyPond será con frecuencia lo más conveniente, pero
+explicamos cómo usar la macro @code{markup} para obtener una solución
+sólo con Scheme.
 
 @quotation
 @multitable @columnfractions .3 .3
@@ -661,7 +717,7 @@ aplicado a todos los elementos de la lista de marcados original.
 Dado que la replicación de los argumentos precedentes para aplicar una
 función de marcado a una lista de marcados es poco costosa
 principalmente por los argumentos de Scheme, se evitan las caídas de
-reindimiento simplemente mediante la utilización de argumentos de
+rendimiento simplemente mediante la utilización de argumentos de
 Scheme para los argumentos antecedentes de las funciones de marcado
 que toman un marcado como su último argumento.
 
@@ -710,8 +766,8 @@ El ejemplo siguiente define una instrucción de marcado para trazar un
 rectángulo doble alrededor de un fragmento de texto.
 
 En primer lugar, necesitamos construir un resultado aproximado
-utilizando marcados.  Una consulta a @ruser{Text markup commands} nos
-muestra que es útil la instrucción @code{\box}:
+utilizando marcados.  Una consulta a @ruser{Instrucciones de marcado
+de texto} nos muestra que es útil la instrucción @code{\box}:
 
 @lilypond[quote,verbatim,ragged-right]
 \markup \box \box HELLO
@@ -731,7 +787,8 @@ Después, el relleno o separación entre los dos rectángulos nos parece
 muy pequeño, así que lo vamos a sobreescribir también:
 
 @lilypond[quote,verbatim,ragged-right]
-\markup \override #'(box-padding . 0.4) \box \override #'(box-padding . 0.6) \box A
+\markup \override #'(box-padding . 0.4) \box
+     \override #'(box-padding . 0.6) \box A
 @end lilypond
 
 Repetir esta extensa instrucción de marcado una y otra vez sería un
@@ -794,13 +851,13 @@ Ahora el código nuevo es como se ve a continuación:
                @{ $text @} #@}))
 @end lisp
 
-Again, the equivalent version using the markup macro would be:
+De nuevo, la versión equivalente que utiliza la macro de marcado sería:
 
 @lisp
 #(define-markup-command (double-box layout props text) (markup?)
   #:properties ((inter-box-padding 0.4)
                 (box-padding 0.6))
-  "Draw a double box around text."
+  "Trazar un rectángulo doble rodeando el texto."
   (interpret-markup layout props
     (markup #:override `(box-padding . ,inter-box-padding) #:box
             #:override `(box-padding . ,box-padding) #:box text)))
@@ -944,11 +1001,11 @@ del argumento @code{props}.
 #(define-markup-list-command (paragraph layout props args) (markup-list?)
    #:properties ((par-indent 2))
    (interpret-markup-list layout props
-     #@{\markuplines \justified-lines @{ \hspace #$par-indent $args @} #@}))
+     #@{\markuplist \justified-lines @{ \hspace #$par-indent $args @} #@}))
 @end example
 
 
-The version using just Scheme is more complex:
+La versión que usa solamente Scheme es más compleja:
 @example
 #(define-markup-list-command (paragraph layout props args) (markup-list?)
    #:properties ((par-indent 2))
@@ -976,7 +1033,7 @@ interpreta usando la función @code{interpret-markup-list}.
 Esta nueva instrucción de lista de marcados se puede usar como sigue:
 
 @example
-\markuplines @{
+\markuplist @{
   \paragraph @{
     El arte de la tipografía musical se llama  \italic @{grabado (en plancha).@}
     El término deriva del proceso tradicional de impresión de música.
@@ -1093,7 +1150,7 @@ p. ej.:
 \override Stem #'thickness = #2.0
 @end example
 
-Las propiedades pueden fijarse también a un procedimiento de scheme,
+Las propiedades pueden fijarse también a un procedimiento de Scheme,
 
 @lilypond[fragment,verbatim,quote,relative=2]
 \override Stem #'thickness = #(lambda (grob)