]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/fr/extending/scheme-tutorial.itely
Doc-fr: Extending
[lilypond.git] / Documentation / fr / extending / scheme-tutorial.itely
1 @c -*- coding: utf-8; mode: texinfo; documentlanguage: fr -*-
2
3 @ignore
4     Translation of GIT committish: 00e1520dc9f0b4dabe38da8895d147b07af843b8
5
6     When revising a translation, copy the HEAD committish of the
7     version that you are working on.  For details, see the Contributors'
8     Guide, node Updating translation committishes..
9 @end ignore
10
11 @c \version "2.17.6"
12
13 @c Translators: Jean-Charles Malahieude
14
15 @node Tutoriel Scheme
16 @chapter Tutoriel Scheme
17
18 @cindex Scheme
19 @cindex GUILE
20 @cindex Scheme, inclusion de code
21 @cindex accéder à Scheme
22 @cindex évaluation Scheme
23 @cindex LISP
24
25 LilyPond recourt abondamment au langage de programmation Scheme, tant au
26 niveau de la syntaxe de saisie que des mécanismes internes chargés de
27 combiner les différents modules du logiciel.  Les lignes qui suivent
28 constituent un bref aperçu de la manière de saisir des données en
29 Scheme.  Si vous désirez en apprendre plus sur Scheme, n'hésitez pas à
30 vous rendre sur @uref{http://@/www@/.schemers@/.org}.
31
32 Le Scheme utilisé par LilyPond repose sur l'implémentation GNU
33 Guile ; celle-ci se base sur le standard Scheme @qq{R5RS}.  Si
34 votre but est d'apprendre Scheme au travers de LilyPond, sachez que
35 l'utilisation d'une autre implémentation ou d'un autre standard pourrait
36 être source de désagrément.  Vous trouverez plus d'information sur
37 GUILE à la page @uref{http://www.gnu.org/software/guile/} ; le
38 standard Scheme @qq{R5RS} est quant à lui disponible à la page
39 @uref{http://www.schemers.org/Documents/Standards/R5RS/}.
40
41 @menu
42 * Introduction à Scheme::
43 * Scheme et LilyPond::
44 * Construction de fonctions complexes::
45 @end menu
46
47
48 @node Introduction à Scheme
49 @section Introduction à Scheme
50 @translationof Introduction to Scheme
51
52 Nous commencerons par nous intéresser à Scheme et à son fonctionnement,
53 grâce à l'interpréteur GUILE.  Une fois plus à l'aise avec Scheme, nous
54 verrons comment ce langage peut s'intégrer à un fichier LilyPond.
55
56 @menu
57 * Le bac à sable de Scheme::
58 * Scheme et les variables::
59 * Types de données Scheme simples::
60 * Types de données Scheme composites::
61 * Scheme et les calculs::
62 * Scheme et les procédures::
63 * Scheme et les conditions::
64 @end menu
65
66
67 @node Le bac à sable de Scheme
68 @subsection Le bac à sable de Scheme
69 @translationof Scheme sandbox
70
71 L'installation de LilyPond comprend l'implémentation GUILE de Scheme.
72 La plupart des systèmes disposent d'un @qq{bac à sable} Scheme pour
73 effectuer des tests ; vous y accéderez en tapant @qq{guile} dans
74 un terminal.  Certains systèmes, notamment Windows, nécessitent d'avoir
75 auparavant créé la variable d'environnement @code{GUILE_LOAD_PATH} qui
76 devra pointer vers le répertoire @code{../usr/share/guile/1.8} de
77 l'installation de LilyPond -- pour connaître le chemin complet d'accès à
78 ce répertoire, consultez @rlearning{Autres sources de documentation}.
79 Les utilisateurs de Windows peuvent aussi prendre l'option @qq{Exécuter}
80 à partir du menu @qq{Démarrer} puis taper @qq{guile}.
81
82 Néanmoins, tous les paquetages de LilyPond disposent d'un bac à sable
83 Scheme, accessible par la commande :
84 @example
85 lilypond scheme-sandbox
86 @end example
87
88 @noindent
89 Une fois le bac à sable actif, vous obtiendrez l'invite :
90 @lisp
91 guile>
92 @end lisp
93
94 Vous pouvez dès à présent saisir des expressions Scheme pour vous
95 exercer.  Si vous souhaitez pouvoir utiliser la bibliothèque GNU
96 @code{readline}, qui offre une ligne de commande plus élaborée,
97 consultez les informations contenues dans le fichier
98 @file{ly/scheme-sandbox.ly}.  La bibliothèque @var{readline}, dans la
99 mesure où elle est habituellement activée dans vos sessions Guile,
100 devrait être effective y compris dans le bac à sable.
101
102
103 @node Scheme et les variables
104 @subsection Scheme et les variables
105 @translationof Scheme variables
106
107 Une variable Scheme peut contenir n'importe quelle valeur valide en
108 Scheme, y compris une procédure Scheme.
109
110 Une variable Scheme se crée avec la fonction @code{define} :
111
112 @lisp
113 guile> (define a 2)
114 guile>
115 @end lisp
116
117 L'évaluation d'une variable Scheme se réalise en saisissant le nom de
118 cette variable à l'invite de Guile :
119
120 @lisp
121 guile> a
122 2
123 guile>
124 @end lisp
125
126 Une variable Scheme s'affiche à l'écran à l'aide de la fonction
127 @code{display} :
128
129 @lisp
130 guile> (display a)
131 2guile>
132 @end lisp
133
134 @noindent
135 Vous aurez remarqué que la valeur @code{2} et l'invite @code{guile}
136 apparaissent sur une même ligne.  On peut améliorer la présentation à
137 l'aide de la procédure @code{newline} ou bien en affichant un caractère
138 @qq{retour chariot}.
139
140 @lisp
141 guile> (display a)(newline)
142 2
143 guile> (display a)(display "\n")
144 2
145 guile>
146 @end lisp
147
148 Après avoir créé une variable, vous pouvez en modifier la valeur grâce à
149 un @code{set!} :
150
151 @lisp
152 guile> (set! a 12345)
153 guile> a
154 12345
155 guile>
156 @end lisp
157
158 Vous quitterez proprement le bac à sable à l'aide de l'instruction
159 @code{quit} :
160
161 @lisp
162 guile> (quit)
163 @end lisp
164
165
166 @node Types de données Scheme simples
167 @subsection Types de données Scheme simples
168 @translationof Scheme simple data types
169
170 L'un des concepts de base de tout langage est la saisie de données,
171 qu'il s'agisse de nombres, de chaînes de caractères, de listes etc.
172 Voici les différents types de données Scheme simples utilisées
173 couramment dans LilyPond.
174
175 @table @asis
176 @item Booléens
177 Les valeurs booléennes sont vrai ou faux.  En Scheme, ce sera @code{#t}
178 pour vrai, et @code{#f} pour faux.
179 @funindex ##t
180 @funindex ##f
181
182 @item Nombres
183 Les nombres se saisissent le plus communément : @code{1} est le
184 nombre (entier) un, alors que @w{@code{-1.5}} est un nombre à virgule
185 flottante (un nombre non entier).
186
187 @item Chaînes
188 Les chaînes de caractères sont bornées par des guillemets
189 informatiques :
190
191 @example
192 "ceci est une chaîne"
193 @end example
194
195 Une chaîne peut s'étendre sur plusieurs lignes :
196
197 @example
198 "ceci
199 est
200 une chaîne"
201 @end example
202
203 @noindent
204 auquel cas les retours à la ligne seront inclus dans la chaîne.
205
206 Un caractère de retour à la ligne peut s'ajouter dans la chaîne, sous la
207 forme d'un @code{\n}.
208
209 @example
210 "ceci\nest une\nchaîne multiligne"
211 @end example
212
213 Guillemets et obliques inverses dans une chaîne doivent être précédés
214 d'une oblique inverse.  La chaîne @code{\a dit "b"} se saisit donc
215
216 @example
217 "\\a dit \"b\""
218 @end example
219
220 @end table
221
222 Il existe bien d'autres types de données Scheme, dont nous ne parlerons
223 pas ici.  Vous en trouverez une liste exhaustive dans le guide de
224 référence de Guile, à la page
225 @uref{http://www.gnu.org/software/guile/manual/html_node/Simple-Data-Types.html}.
226
227
228 @node Types de données Scheme composites
229 @subsection Types de données Scheme composites
230 @translationof Scheme compound data types
231
232 Scheme prend aussi en charge des types de données composites.  LilyPond
233 utilise beaucoup les paires, listes, listes associatives et tables de
234 hachage.
235
236 @menu
237 * Paires::
238 * Listes::
239 * Listes associatives (alists)::
240 * Tables de hachage::
241 @end menu
242
243
244 @node Paires
245 @unnumberedsubsubsec Paires
246 @translationof Pairs
247
248 Le type de donnée composite fondamental est la paire (@code{pair}).
249 Comme son nom l'indique, il s'agit de lier deux valeurs, à l'aide de
250 l'opérateur @code{cons}.
251
252 @lisp
253 guile> (cons 4 5)
254 (4 . 5)
255 guile>
256 @end lisp
257
258 Vous aurez noté que la paire s'affiche sous la forme de deux éléments
259 bornés par des parenthèses et séparés par une espace, un point
260 (@code{.}) et une autre espace.  Le point n'est en aucune manière un
261 séparateur décimal ; il s'agit de l'indicateur d'une paire.
262
263 Vous pouvez aussi saisir littéralement les valeurs d'une paire, en la
264 faisant précéder d'une apostrophe.
265
266 @lisp
267 guile> '(4 . 5)
268 (4 . 5)
269 guile>
270 @end lisp
271
272 Les deux éléments d'une paire peuvent être constitués de n'importe
273 quelle valeur Scheme valide :
274
275 @lisp
276 guile> (cons #t #f)
277 (#t . #f)
278 guile> '("blah-blah" . 3.1415926535)
279 ("blah-blah" . 3.1415926535)
280 guile>
281 @end lisp
282
283 Les premier et second éléments de la paire sont accessibles à l'aide des
284 procédures Scheme @code{car} et @code{cdr}.
285
286 @lisp
287 guile> (define mypair (cons 123 "hello there")
288 ... )
289 guile> (car mypair)
290 123
291 guile> (cdr mypair)
292 "hello there"
293 guile>
294 @end lisp
295
296 @noindent
297
298 Note :  @code{cdr} se prononce @qq{couldeur}, comme l'indiquent Sussman et
299 Abelson -- voir
300 @uref{http://mitpress.mit.edu/sicp/full-text/book/book-Z-H-14.html#footnote_Temp_133}.
301
302
303 @node Listes
304 @unnumberedsubsubsec Listes
305 @translationof Lists
306
307 Autre structure de donnée commune en Scheme : la liste (@emph{list}).
308 Une liste se définit comme étant vide (représentée par @code{'()}) ou
309 une paire dont le @code{cdr} est une liste.
310
311 Il existe plusieurs méthodes pour créer une liste, la plus courante
312 étant l'utilisation de la procédure @code{list} :
313
314 @lisp
315 guile> (list 1 2 3 "abc" 17.5)
316 (1 2 3 "abc" 17.5)
317 @end lisp
318
319 Comme vous le remarquez, une liste s'affiche sous la forme d'une suite
320 d'éléments séparés par une espace, bornée par des parenthèses.
321 Contrairement à une paire, il n'y a pas de point entre les éléments.
322
323 Vous pouvez aussi saisir directement une liste en entourant ses éléments
324 par des parenthèses à la suite d'une apostrophe :
325
326 @lisp
327 guile> '(17 23 "foo" "bar" "bazzle")
328 (17 23 "foo" "bar" "bazzle")
329 @end lisp
330
331 Les listes ont une importance considérable en Scheme.  Certains vont
332 d'ailleurs jusqu'à considérer Scheme comme un dialecte du lisp, où
333 @qq{lisp} serait une abréviation de @qq{List Processing}.  Il est vrai
334 que toute expression Scheme est une liste.
335
336
337 @node Listes associatives (alists)
338 @unnumberedsubsubsec Listes associatives (alists)
339 @translationof Association lists (alists)
340
341 Il existe un type particulier de liste : la @emph{liste associative} --
342 ou @emph{alist}.  Une @emph{alist} permet de stocker des données dans le
343 but de les réutiliser.
344
345 Une liste associative est une liste dont les éléments sont des paires.
346 Le @code{car} de chacun des éléments constitue une clé (@emph{key}) et
347 chaque @code{cdr} une valeur (@emph{value}).  La procédure Scheme
348 @code{assoc} permet de retrouver une entrée de la liste
349 associative ; son @code{cdr} en fournira la valeur :
350
351 @lisp
352 guile> (define mon-alist '((1  . "A") (2 . "B") (3 . "C")))
353 guile> mon-alist
354 ((1 . "A") (2 . "B") (3 . "C"))
355 guile> (assoc 2 mon-alist)
356 (2 . "B")
357 guile> (cdr (assoc 2 mon-alist))
358 "B"
359 guile>
360 @end lisp
361
362 LilyPond recourt abondamment aux @emph{alists} pour stocker des
363 propriétés ou autres données.
364
365
366 @node Tables de hachage
367 @unnumberedsubsubsec Tables de hachage
368 @translationof Hash tables
369
370 Il s'agit d'une structure de données à laquelle LilyPond fait parfois
371 appel.  Une table de hachage (@emph{hash table}) peut se comparer à une
372 matrice ou un tableau dont l'index peut être n'importe quel type de
373 valeur Scheme et ne se limitant pas à des nombres entiers.
374
375 Les tables de hachage sont un moyen plus efficace que les listes
376 associatives lorsqu'il s'agit d'enregistrer de nombreuses données qui ne
377 changeront que peu fréquemment.
378
379 La syntaxe permettant de créer une table de hachage peut paraître
380 complexe, mais vous en trouverez de nombreux exemples dans les sources
381 de LilyPond.
382
383 @lisp
384 guile> (define h (make-hash-table 10))
385 guile> h
386 #<hash-table 0/31>
387 guile> (hashq-set! h 'cle1 "valeur1")
388 "valeur1"
389 guile> (hashq-set! h 'key2 "valeur2")
390 "valeur2"
391 guile> (hashq-set! h 3 "valeur3")
392 "valeur3"
393 @end lisp
394
395 La procédure @code{hashq-ref} permet de récupérer une valeur dans la
396 table de hachage.
397
398 @lisp
399 guile> (hashq-ref h 3)
400 "valeur3"
401 guile> (hashq-ref h 'cle2)
402 "valeur2"
403 guile>
404 @end lisp
405
406 La procédure @code{hashq-get-handle} permet de retrouver à la fois une
407 clé et sa valeur.  Cette procédure a l'avantage de renvoyer @code{#f}
408 lorsque la clé n'existe pas.
409
410 @lisp
411 guile> (hashq-get-handle h 'cle1)
412 (cle1 . "valeur1")
413 guile> (hashq-get-handle h 'zut)
414 #f
415 guile>
416 @end lisp
417
418 @node Scheme et les calculs
419 @subsection Scheme et les calculs
420 @translationof Calculations in Scheme
421
422 @ignore
423 We have been using lists all along.  A calculation, like @code{(+ 1 2)}
424 is also a list (containing the symbol @code{+} and the numbers 1
425 and@tie{}2).  Normally lists are interpreted as calculations, and the
426 Scheme interpreter substitutes the outcome of the calculation.  To enter a
427 list, we stop the evaluation.  This is done by quoting the list with a
428 quote @code{'} symbol.  So, for calculations do not use a quote.
429
430 Inside a quoted list or pair, there is no need to quote anymore.  The
431 following is a pair of symbols, a list of symbols and a list of lists
432 respectively,
433
434 @example
435 #'(stem . head)
436 #'(staff clef key-signature)
437 #'((1) (2))
438 @end example
439 @end ignore
440
441 Scheme permet aussi d'effectuer des calculs.  Il utilise alors un
442 @emph{préfixe}.  Additionner 1 et 2 s'écrira @code{(+ 1 2)} et
443 non @math{1+2} comme on aurait pu s'y attendre.
444
445 @lisp
446 guile> (+ 1 2)
447 3
448 @end lisp
449
450 Les calculs peuvent s'imbriquer ; le résultat d'une fonction peut
451 servir pour un autre calcul.
452
453 @lisp
454 guile> (+ 1 (* 3 4))
455 13
456 @end lisp
457
458 Ces calculs sont un exemple d'évaluation : une expression telle que
459 @code{(* 3 4)} est remplacée par sa valeur, soit @code{12}.
460
461 En matière de calcul, Scheme fait la différence entre des nombres entiers
462 ou non.  Les calculs sur des nombres entiers seront exacts, alors que
463 s'il s'agit de nombres non entiers, les calculs tiendront compte de la
464 précision mentionnée :
465
466 @lisp
467 guile> (/ 7 3)
468 7/3
469 guile> (/ 7.0 3.0)
470 2.33333333333333
471 @end lisp
472
473 Lorsque l'interpréteur Scheme rencontre une expression sous forme de
474 liste, le premier élément de cette liste est considéré en tant que
475 procédure qui prendra en argument le restant de la liste.  C'est la
476 raison pour laquelle, en Scheme, tous les opérateurs sont en préfixe.
477
478 Le fait que le premier élément d'une expression Scheme sous forme de
479 liste ne soit pas un opérateur ou une procédure déclenchera une
480 erreur de la part de l'interpréteur :
481
482 @lisp
483 guile> (1 2 3)
484
485 Backtrace:
486 In current input:
487   52: 0* [1 2 3]
488
489 <unnamed port>:52:1: In expression (1 2 3):
490 <unnamed port>:52:1: Wrong type to apply: 1
491 ABORT: (misc-error)
492 guile>
493 @end lisp
494
495 Vous pouvez constater que l'interpréteur a tenté de considérer @code{1}
496 comme étant un opérateur ou une procédure, ce qu'il n'a pu réaliser.  Il
497 a donc renvoyé l'erreur @qq{Wrong type to apply: 1} (@emph{Application
498 d'un type erroné : 1}).
499
500 C'est pourquoi il est impératif, pour créer une liste, soit d'utiliser
501 l'opérateur consacré (@code{list}), soit de faire précéder la liste
502 d'une apostrophe, de telle sorte que l'interpréteur ne tente pas de
503 l'évaluer.
504
505 @lisp
506 guile> (list 1 2 3)
507 (1 2 3)
508 guile> '(1 2 3)
509 (1 2 3)
510 guile>
511 @end lisp
512
513 Vous pourrez être confronté à cette erreur lorsque vous intégrerez
514 Scheme à LilyPond.
515
516 @ignore
517 The same assignment can be done in completely in Scheme as well,
518
519 @example
520 #(define twentyFour (* 2 twelve))
521 @end example
522
523 @c this next section is confusing -- need to rewrite
524
525 The @emph{name} of a variable is also an expression, similar to a
526 number or a string.  It is entered as
527
528 @example
529 #'twentyFour
530 @end example
531
532 @funindex #'symbol
533 @cindex quoting in Scheme
534
535 The quote mark @code{'} prevents the Scheme interpreter from substituting
536 @code{24} for the @code{twentyFour}.  Instead, we get the name
537 @code{twentyFour}.
538 @end ignore
539
540
541 @node Scheme et les procédures
542 @subsection Scheme et les procédures
543 @translationof Scheme procedures
544
545 Une procédure Scheme est une expression Scheme qui renverra une valeur
546 issue de son exécution.  Les procédures Scheme sont capables de
547 manipuler des variables qui ne sont pas définies en leur sein.
548
549 @menu
550 * Définition de procédures::
551 * Prédicats::
552 * Valeurs de retour::
553 @end menu
554
555
556 @node Définition de procédures
557 @unnumberedsubsubsec Définition de procédures
558 @translationof Defining procedures
559
560 En Scheme, on définit une procédure à l'aide de l'instruction
561 @code{define} :
562
563 @example
564 (define (nom-fonction argument1 argument2 ... argumentn)
565  expression-scheme-qui-donnera-une-valeur-en-retour)
566 @end example
567
568 Nous pourrions, par exemple, définir une procédure calculant la moyenne
569 de deux nombres :
570
571 @lisp
572 guile> (define (moyenne x y) (/ (+ x y) 2))
573 guile> moyenne
574 #<procedure moyenne (x y)>
575 @end lisp
576
577 Une fois la procédure définie, on l'appelle en la faisant suivre, dans
578 une liste, des arguments qui doivent l'accompagner.  Calculons
579 maintenant la moyenne de 3 et 12 :
580
581 @lisp
582 guile> (moyenne 3 12)
583 15/2
584 @end lisp
585
586
587 @node Prédicats
588 @unnumberedsubsubsec Prédicats
589 @translationof Predicates
590
591 Une procédure Scheme chargée de retourner une valeur booléenne s'appelle
592 un @qq{prédicat} (@emph{predicate}).  Par convention, plutôt que par
593 nécessité, le nom d'un prédicat se termine par un point
594 d'interrogation :
595
596 @lisp
597 guile> (define (moins-de-dix? x) (< x 10))
598 guile> (moins-de-dix? 9)
599 #t
600 guile> (moins-de-dix? 15)
601 #f
602 @end lisp
603
604
605 @node Valeurs de retour
606 @unnumberedsubsubsec Valeurs de retour
607 @translationof Return values
608
609 Une procédure Scheme doit toujours renvoyer une valeur de retour, en
610 l'occurrence la valeur de la dernière expression exécutée par cette
611 procédure.  La valeur de retour sera une valeur Scheme valide, y compris
612 une structure de donnée complexe ou une procédure.
613
614 On peut avoir besoin de regrouper plusieurs expressions Scheme dans une
615 même procédure.  Deux méthodes permettent de combiner des expressions
616 multiples.  La première consiste à utiliser la procédure @code{begin},
617 qui permet l'évaluation de plusieurs expressions et renvoie la valeur de
618 la dernière expression.
619
620 @lisp
621 guile> (begin (+ 1 2) (- 5 8) (* 2 2))
622 4
623 @end lisp
624
625 Une deuxième méthode consiste à combiner les expressions dans un bloc
626 @code{let}.  Ceci aura pour effet de créer une série de liens, puis
627 d'évaluer en séquence les expressions susceptibles d'inclure ces
628 liens.  La valeur renvoyée par un bloc @emph{let} est la valeur de
629 retour de la dernière clause de ce bloc :
630
631 @lisp
632 guile> (let ((x 2) (y 3) (z 4)) (display (+ x y)) (display (- z 4))
633 ... (+ (* x y) (/ z x)))
634 508
635 @end lisp
636
637
638 @node Scheme et les conditions
639 @subsection Scheme et les conditions
640 @translationof Scheme conditionals
641
642 @menu
643 * if::
644 * cond::
645 @end menu
646
647
648 @node if
649 @unnumberedsubsubsec if
650 @translationof if
651
652 Scheme dispose d'une procédure @code{if} :
653
654 @example
655 (if expression-test expression-affirmative expression-négative)
656 @end example
657
658 @var{expression-test} est une expression qui renverra une valeur
659 booléenne.  Dans le cas où @var{expression-test} retourne @code{#t}, la
660 procédure @code{if} renvoie la valeur de @var{expression-affirmative},
661 et celle de @var{expression-négative} dans le cas contraire.
662
663 @lisp
664 guile> (define a 3)
665 guile> (define b 5)
666 guile> (if (> a b) "a est plus grand que b" "a n'est pas plus grand que b")
667 "a n'est pas plus grand que b"
668 @end lisp
669
670
671 @node cond
672 @unnumberedsubsubsec cond
673 @translationof cond
674
675 Une autre manière d'introduire une condition en Scheme est d'utiliser
676 l'instruction @code{cond} :
677
678 @example
679 (cond (expression-test-1 expression-résultat-séquence-1)
680       (expression-test-2 expression-résultat-séquence-2)
681       ...
682       (expression-test-n expression-résultat-séquence-n))
683 @end example
684
685 Comme par exemple ici :
686
687 @lisp
688 guile> (define a 6)
689 guile> (define b 8)
690 guile> (cond ((< a b) "a est plus petit que b")
691 ...          ((= a b) "a égale b")
692 ...          ((> a b) "a est plus grand que b"))
693 "a est plus petit que b"
694 @end lisp
695
696
697 @node Scheme et LilyPond
698 @section Scheme et LilyPond
699 @translationof Scheme in LilyPond
700
701 @menu
702 * Syntaxe Scheme dans LilyPond::
703 * Variables LilyPond::
704 * Saisie de variables et Scheme::
705 * Import de code Scheme dans LilyPond::
706 * Propriétés des objets::
707 * Variables LilyPond composites::
708 * Représentation interne de la musique::
709 @end menu
710
711 @node Syntaxe Scheme dans LilyPond
712 @subsection Syntaxe Scheme dans LilyPond
713 @translationof LilyPond Scheme syntax
714
715 @funindex $
716 @funindex #
717
718 L'installation de LilyPond comprenant l'interpréteur Guile, les fichiers
719 source LilyPond peuvent contenir du Scheme.  Vous disposez de plusieurs
720 méthodes pour inclure du Scheme dans vos fichiers LilyPond.
721
722 La méthode la plus simple consiste à insérer un @emph{hash} (le caractère
723 @code{#}, improprement appelé dièse) avant l'expression Scheme.
724
725 Rappelons-nous qu'un fichier source LilyPond est structuré en jetons et
726 expressions, tout comme le langage humain est structuré en mots et
727 phrases.  LilyPond dispose d'un analyseur lexical (appelé @emph{lexer})
728 qui sait identifier les jetons -- nombres, chaînes, éléments Scheme,
729 hauteurs etc. -- ainsi que d'un analyseur syntaxique (appelé
730 @emph{parser}) -- voir l'annexe @ruser{Grammaire de LilyPond}.  Dès lors
731 que le programme sait quelle règle grammaticale particulière doit
732 s'appliquer, il exécute les consignes qui lui sont associées.
733
734 Le recours à un @emph{hash} pour mettre en exergue du Scheme est tout à
735 fait approprié.  Dès qu'il rencontre un @code{#}, l'analyseur lexical
736 passe le relais au lecteur Scheme qui va alors déchiffrer l'intégralité
737 de l'expression Scheme -- ce peut être un identificateur, une expression
738 bornée par des parenthèses ou bien d'autres choses encore.  Une fois
739 cette expression lue, elle est enregistrée en tant que valeur d'un
740 élément grammatical @code{SCM_TOKEN}.  Puisque l'analyseur syntaxique
741 sait comment traiter ce jeton, il charge Guile d'évaluer l'expression
742 Scheme.  Dans la mesure où le @emph{parser} requiert une lecture en
743 avance de la part du @emph{lexer} pour prendre une décision, cette
744 distinction entre lecture et évaluation -- @emph{lexer} et @emph{parser}
745 -- révèle toute sa pertinence lorsqu'il s'agit d'exécuter conjointement
746 des expressions LilyPond et des expressions Scheme.  C'est la raison
747 pour laquelle nous vous recommandons, dans toute la mesure du possible,
748 d'utiliser un signe @emph{hash} lorsque vous faites appel à Scheme.
749
750 Une autre manière de faire appel à l'interpréteur Scheme à partir de
751 LilyPond consiste à introduire une expression Scheme par un caractère
752 dollar au lieu d'un caractère dièse -- un @code{$} au lieu
753 d'un @code{#}.  En pareil cas, LilyPond évalue le code dès sa lecture
754 par l'analyseur lexical, vérifie le type d'expression Scheme qui en
755 résulte et détermine un type de jeton (l'un des @code{xxx_IDENTIFIER} de
756 la grammaire) qui lui corresponde, puis en fait une copie qui servira à
757 traiter la valeur de ce jeton.  Lorsque la valeur de l'expression est
758 @emph{void}, autrement dit une valeur Guile @code{*unspecified*} (pour
759 @emph{non spécifiée}), aucune information n'est transmise à l'analyseur
760 grammatical.
761
762 C'est, en réalité, la manière dont LilyPond opère lorsque vous rappelez
763 une variable ou une fonction par son nom -- au travers d'un @code{\nom}
764 --, à la seule différence que sa finalité est déterminée par l'analyseur
765 lexical de LilyPond sans consultation du lecteur Scheme ; le nom de
766 la variable rappelée doit donc être en corrélation avec le mode LilyPond
767 actif à ce moment là.
768
769 L'immédiateté de l'opérateur @code{$} peut entraîner des effets
770 indésirables dont nous reparlerons à la rubrique
771 @ref{Saisie de variables et Scheme} ; aussi est-il préférable
772 d'utiliser un @code{#} dès que l'analyseur grammatical le supporte.
773 Dans le cadre d'une expression musicale, une expression qui aura été
774 créée à l'aide d'un @code{#} sera interprétée comme étant de la musique.
775 Elle ne sera cependant pas recopiée avant utilisation.  Si la structure
776 qui l'abrite devait être réutilisée, un appel expicite à
777 @code{ly:music-deep-copy} pourrait être requis.
778
779 @funindex $@@
780 @funindex #@@
781
782 Les opérateurs @code{$@@} et @code{#@@} agissent comme des « colleurs de
783 liste » : leur fonction consiste à insérer tous les éléments d'un liste
784 dans le contexte environnant.
785
786 Examinons à présent du vrai code Scheme.  Nous pouvons définir des
787 procédures Scheme au milieu d'un fichier source LilyPond :
788
789 @example
790 #(define (moyenne a b c) (/ (+ a b c) 3))
791 @end example
792
793 Pour mémoire, vous noterez que les commentaires LilyPond (@code{%} ou
794 @code{%@{ %@}}) ne peuvent s'utiliser dans du code Scheme, même si
795 celui-ci se trouve au sein d'un fichier LilyPond.  Ceci tient au fait
796 que l'expression Scheme est lue par l'interpréteur Guile, et en aucune
797 façon par l'analyseur lexical de LilyPond.  Voici comment introduire des
798 commentaires dans votre code Scheme :
799
800 @example
801 ; ceci n'est qu'une simple ligne de commentaire
802
803 #!
804   Ceci constitue un bloc de commentaire (non imbricable)
805   dans le style Guile.
806   En fait, les Schemeurs les utilisent très rarement,
807   et vous n'en trouverez jamais dans le code source
808   de LilyPond.
809 !#
810 @end example
811
812 Dans la suite de notre propos, nous partons du principe que les données
813 sont incluses dans un fichier musical, aussi toutes les expressions
814 Scheme seront introduites par un @code{#}.
815
816 Toutes les expressions Scheme de haut niveau incluses dans un fichier
817 LilyPond peuvent se combiner en une expression Scheme unique à l'aide de
818 la clause @code{begin} :
819
820 @example
821 #(begin
822   (define foo 0)
823   (define bar 1))
824 @end example
825
826
827 @node Variables LilyPond
828 @subsection Variables LilyPond
829 @translationof LilyPond variables
830
831 Les variables LilyPond sont enregistrées en interne sous la forme de
832 variables Scheme.  Ainsi,
833
834 @example
835 douze = 12
836 @end example
837
838 @noindent
839 est équivalant à
840
841 @example
842 #(define douze 12)
843 @end example
844
845 Ceci a pour conséquence que toute variable LilyPond peut être utilisée
846 dans une expression Scheme.  Par exemple, nous pourrions dire
847
848 @example
849 vingtQuatre = #(* 2 douze)
850 @end example
851
852 @noindent
853 ce qui aurait pour conséquence que le nombre 24 sera stocké dans la
854 variable LilyPond (et Scheme) @code{vingtQuatre}.
855
856 La façon habituelle de faire référence à une variable LilyPond consiste
857 à la rappeler à l'aide d'une oblique inverse -- autrement dit saisir
858 @code{\vingtQuatre}.  Dans la mesure où ceci, pour la plupart des types
859 internes de LilyPond y compris les expressions musicales, aura pour
860 effet d'en recopier la valeur, les fonctions musicales n'ont pas pour
861 habitude de créer une copie du matériau qu'elles vont modifier.  De
862 fait, une expression musicale introduite par @code{#} ne devrait pas
863 contenir de matériau inexistant auparavant ou bien littéralement
864 recopié, mais plutôt une référence explicite.
865
866
867 @node Saisie de variables et Scheme
868 @subsection Saisie de variables et Scheme
869 @translationof Input variables and Scheme
870
871 Le format de saisie prend en charge la notion de variable -- ou
872 identificateur.  Dans l'exemple suivant, une expression musicale se voit
873 attribuer un identificateur qui portera le nom de @code{traLaLa}.
874
875 @example
876 traLaLa = @{ c'4 d'4 @}
877 @end example
878
879 @noindent
880
881 Une variable a aussi une portée.  Dans l'exemple suivant, le bloc
882 @code{\layout} contient une variable @code{traLaLa} tout à fait
883 indépendante de l'autre @code{\traLaLa}.
884
885 @example
886 traLaLa = @{ c'4 d'4 @}
887 \layout @{ traLaLa = 1.0 @}
888 @end example
889
890 Dans les faits, chaque fichier a un domaine de compétence, et les
891 différents blocs @code{\header}, @code{\midi} et @code{\layout} ont leur
892 propre champ de compétence, imbriqué dans ce domaine principal.
893
894 Variables et champs de compétence sont implémentés par le système de
895 modules de Guile.  Un module anonyme Scheme est attaché à chacun de ces
896 domaines.  Une assertion telle que
897
898 @example
899 traLaLa = @{ c'4 d'4 @}
900 @end example
901
902 @noindent
903 est convertie, en interne, en une définition Scheme :
904
905 @example
906 (define traLaLa @var{valeur Scheme de `@code{... }'})
907 @end example
908
909 Cela signifie que variables LilyPond et variables Scheme peuvent tout à
910 fait se mélanger.  Dans l'exemple suivant, un fragment musical est
911 stocké dans la variable @code{traLaLa} puis dupliqué à l'aide de Scheme.
912 Le résultat est alors importé dans un bloc @code{\score} au moyen d'une
913 seconde variable @code{twice}.
914
915 @lilypond[verbatim]
916 traLaLa = { c'4 d'4 }
917
918 #(define newLa (map ly:music-deep-copy
919   (list traLaLa traLaLa)))
920 #(define twice
921   (make-sequential-music newLa))
922
923 \twice
924 @end lilypond
925
926 @c Due to parser lookahead
927
928 Cet exemple est particulièrement intéressant.  L'assignation
929 n'interviendra qu'une fois que l'analyseur grammatical aura l'assurance
930 que rien du type de @code{\addlyrics} ne suit ; il doit donc
931 vérifier ce qui vient après.  Le @emph{parser} lit le @code{#} et
932 l'expression Scheme qui le suit @strong{sans} l'évaluer, de telle sorte
933 qu'il peut procéder à l'assignation, et @strong{ensuite} exécuter le
934 code Scheme sans problème.
935
936
937 @node Import de code Scheme dans LilyPond
938 @subsection Import de code Scheme dans LilyPond
939 @translationof Importing Scheme in LilyPond
940
941 @funindex $
942 @funindex #
943
944 L'exemple précédent illustre la manière @qq{d'exporter} une expression
945 musicale à partir des saisies et à destination de l'interpréteur Scheme.
946 L'inverse est aussi réalisable : en la plaçant derrière un @code{$}, une
947 valeur Scheme sera interprétée comme si elle avait été saisie en
948 syntaxe LilyPond.  Au lieu de définir @code{\twice}, nous aurions tout
949 aussi bien pu écrire
950
951 @example
952 ...
953 $(make-sequential-music (list newLa))
954 @end example
955
956 Vous pouvez utiliser @code{$} suivi d'une expression Scheme partout où
957 vous auriez utilisé @code{\@var{nom}}, dès lors que vous aurez assigné à
958 cette expression Scheme le nom de variable @var{nom}.  La substitution
959 intervenant au niveau de l'analyseur lexical (le @emph{lexer}), LilyPond
960 ne saurait faire la différence.
961
962 Cette manière de procéder comporte cependant un inconvénient au niveau
963 de la temporisation.  Si nous avions défini @code{newLa} avec un
964 @code{$} plutôt qu'un @code{#}, la définition Scheme suivante aurait
965 échoué du fait que @code{traLaLa} n'était pas encore défini.  Pour plus
966 d'information quant au problème de synchronisation, voir la rubrique
967 @ref{Syntaxe Scheme dans LilyPond}.
968
969 @funindex $@@
970 @funindex #@@
971
972 Une autre façon de procéder serait de recourir aux « colleurs de liste »
973 @code{$@@} et @code{#@@} dont la fonction est d'insérer les éléments
974 d'une liste dans le contexte environnant.  Grâce à ces opérateurs, la
975 dernière partie de notre fonction pourrait s'écrire ainsi :
976
977 @example
978 ...
979 @{ #@@newLa @}
980 @end example
981
982 Ici, chaque élément de la liste stockée dans @code{newLa} est pris à
983 son tour et inséré dans la liste, tout comme si nous avions écrit
984
985 @example
986 @{ #(premier newLa) #(deuxième newLa) @}
987 @end example
988
989 Dans ces deux dernières formes, le code Scheme est évalué alors même que
990 le code initial est en cours de traitement, que ce soit par le
991 @emph{lexer} ou par le @emph{parser}.  Si le code Scheme ne doit être
992 exécuté que plus tard, consultez la rubrique
993 @ref{Fonctions Scheme fantômes}, ou stockez le dans une procédure comme
994 ici :
995
996 @example
997 #(define (nopc)
998   (ly:set-option 'point-and-click #f))
999
1000 ...
1001 #(nopc)
1002 @{ c'4 @}
1003 @end example
1004
1005 @knownissues
1006 L'imbrication de variables Scheme et LilyPond n'est pas possible
1007 avec l'option @option{--safe}.
1008
1009
1010 @node Propriétés des objets
1011 @subsection Propriétés des objets
1012 @translationof Object properties
1013
1014 Les propriétés des objets sont stockées dans LilyPond sous la forme
1015 d'enchaînements de listes associatives, autrement dit des listes de
1016 listes associatives.  Une propriété se détermine par l'ajout de valeurs
1017 en début de liste de cette propriété.  Les caractéristiques d'une
1018 propriété s'ajustent donc à la lecture des différentes valeurs des
1019 listes associatives.
1020
1021 La modification d'une valeur pour une propriété donnée requiert
1022 l'assignation d'une valeur de la liste associative, tant pour la clé que
1023 la valeur associée.  Voici comment procéder selon la syntaxe de
1024 LilyPond :
1025
1026 @example
1027 \override Stem.thickness = #2.6
1028 @end example
1029
1030 Cette instruction ajuste l'apparence des hampes.  Une entrée
1031 @w{@code{'(thickness . 2.6)}} de la @emph{alist} est ajoutée à la liste
1032 de la propriété de l'objet @code{Stem}.  @code{thickness} devant
1033 s'exprimer en unité d'épaisseur de ligne, les hampes auront donc une
1034 épaisseur de 2,6 ligne de portée, et à peu près le double de leur
1035 épaisseur normale.  Afin de faire la distinction entre les variables que
1036 vous définissez au fil de vos fichiers -- tel le @code{vingtQuatre} que
1037 nous avons vu plus haut -- et les variables internes des objets, nous
1038 parlerons de @qq{propriétés} pour ces dernières, et de @qq{variables}
1039 pour les autres.  Ainsi, l'objet hampe possède une propriété
1040 @code{thickness}, alors que @code{vingtQuatre} est une variable.
1041
1042 @cindex propriétés ou variables
1043 @cindex variables ou propriétés
1044
1045 @c  todo -- here we're getting interesting.  We're now introducing
1046 @c  LilyPond variable types.  I think this deserves a section all
1047 @c  its own
1048
1049
1050 @node Variables LilyPond composites
1051 @subsection Variables LilyPond composites
1052 @translationof LilyPond compound variables
1053
1054 @menu
1055 * Décalages (offsets)::
1056 * Fractions::
1057 * Étendues (extents)::
1058 * Propriété en alists::
1059 * Chaînes d'alist::
1060 @end menu
1061
1062
1063 @node Décalages (offsets)
1064 @unnumberedsubsubsec Décalages (@emph{offsets})
1065 @translationof Offsets
1066
1067 Les décalages (@emph{offset}) sur deux axes (coordonnées X et Y) sont
1068 stockés sous forme de @emph{paires}. Le @code{car} de l'offset
1069 correspond à l'abscisse (coordonnée X) et le @code{cdr} à l'ordonnée
1070 (coordonnée Y).
1071
1072 @example
1073 \override TextScript.extra-offset = #'(1 . 2)
1074 @end example
1075
1076 Cette clause affecte la paire @code{(1 . 2)} à la propriété
1077 @code{extra-offset} de l'objet @code{TextScript}.  Ces nombres sont
1078 exprimés en espace de portée.  La commande aura donc pour effet de
1079 déplacer l'objet d'un espace de portée vers la droite, et de deux
1080 espaces vers le haut.
1081
1082 Les procédures permettant de manipuler les offsets sont regroupées dans
1083 le fichier @file{scm/lily-library.scm}.
1084
1085
1086 @node Fractions
1087 @unnumberedsubsubsec Fractions
1088 @translationof Fractions
1089
1090 Les fractions, tel que LilyPond les utilise, sont aussi stockées sous
1091 forme de @emph{paire}.  Alors que Scheme est tout à fait capable de
1092 représenter des nombres rationnels, vous conviendrez que, musicalement
1093 parlant, @samp{2/4} et @samp{1/2} ne se valent pas ; nous devrons
1094 donc pouvoir les distinguer.  Dans le même ordre d'idée, LilyPond ne
1095 connaît pas les @qq{fractions} négatives.  Pour ces raisons, @code{2/4}
1096 en LilyPond correspond à @code{(2 . 4)} en Scheme, et @code{#2/4} en
1097 LilyPond correspond à @code{1/2} en Scheme.
1098
1099
1100 @node Étendues (extents)
1101 @unnumberedsubsubsec Étendues (@emph{extents})
1102 @translationof Extents
1103
1104 Les paires permettent aussi de stocker des intervalles qui représentent
1105 un ensemble de nombres compris entre un minimum (le @code{car}) et un
1106 maximum (le @code{cdr}).  Ces intervalles stockent l'étendue, tant au
1107 niveau horizontal (X) que vertical (Y) des objets imprimables.  En
1108 matière d'étendue sur les X, le @code{car} correspond à la coordonnée de
1109 l'extrémité gauche, et le @code{cdr} à la coordonnée de l'extrémité
1110 droite.  En matière d'étendue sur les Y, le @code{car} correspond à la
1111 coordonnée de l'extrémité basse, et le @code{cdr} à la coordonnée de
1112 l'extrémité haute.
1113
1114 Les procédures permettant de manipuler les offsets sont regroupées dans
1115 le fichier @file{scm/lily-library.scm}.  Nous vous recommandons
1116 l'utilisation de ces procédures dans toute la mesure du possible afin
1117 d'assurer la cohérence du code.
1118
1119
1120 @node Propriété en alists
1121 @unnumberedsubsubsec Propriété en @emph{alists}
1122 @translationof Property alists
1123
1124 Les propriétés en @emph{alists} sont des structures de données
1125 particulières à LilyPond.  Il s'agit de listes associatives dont les
1126 clés sont des propriétés et les valeurs des expressions Scheme
1127 fournissant la valeur requise pour cette propriété.
1128
1129 Les propriétés LilyPond sont des symboles Scheme, à l'instar de
1130 @code{'thickness}.
1131
1132
1133 @node Chaînes d'alist
1134 @unnumberedsubsubsec Chaînes d'@emph{alist}
1135 @translationof Alist chains
1136
1137 Une chaîne d'@emph{alist} est une liste contenant les listes
1138 associatives d'une propriété.
1139
1140 L'intégralité du jeu de propriétés qui doivent s'appliquer à un objet
1141 graphique est en fait stocké en tant que chaîne d'@emph{alist}.  Afin
1142 d'obtenir la valeur d'une propriété particulière qu'un objet graphique
1143 devrait avoir, on examinera chacune des listes associatives de la
1144 chaîne, à la recherche d'une entrée contenant la clé de cette propriété.
1145 Est renvoyée la première entrée d'@emph{alist} trouvée, sa valeur étant
1146 la valeur de la propriété.
1147
1148 L'obtention des valeurs de propriété des objets graphiques se réalise en
1149 principe à l'aide de la procédure Scheme @code{chain-assoc-get}.
1150
1151
1152 @node Représentation interne de la musique
1153 @subsection Représentation interne de la musique
1154 @translationof Internal music representation
1155
1156 Dans les entrailles du programme, la musique se présente comme une liste
1157 Scheme.  Cette liste comporte les différents éléments qui affecteront la
1158 sortie imprimable.  L'analyse grammaticale (l'opération @emph{parsing})
1159 est le processus chargé de convertir la musique représentée par le code
1160 LilyPond en présentation interne Scheme.
1161
1162 L'analyse d'une expression musicale se traduit par un jeu d'objets
1163 musicaux en Scheme.  Une objet musical est déterminé par le temps qu'il
1164 occupe, que l'on appelle @emph{durée}.  Les durées s'expriment par des
1165 nombres rationnels représentant la longueur d'un objet musical par
1166 rapport à la ronde.
1167
1168 Un objet musical dispose de trois types :
1169 @itemize
1170 @item
1171 un nom de musique : Toute expression musicale a un nom.  Par exemple,
1172 une note amène à un @rinternals{NoteEvent}, un @code{\simultaneous} à un
1173 @rinternals{SimultaneousMusic}.  Une liste exhaustive des différentes
1174 expressions est disponible dans la référence des propriétés internes, à
1175 la rubrique @rinternals{Music expressions}.
1176
1177 @item
1178 un @qq{type} ou interface : Tout nom de musique dispose de
1179 plusieurs types ou interfaces.  Ainsi, une note est tout à la fois un
1180 @code{event}, un @code{note-event}, un @code{rhythmic-event} et un
1181 @code{melodic-event}.  Les différentes classes musicales sont
1182 répertoriées à la rubrique @rinternals{Music classes} de la référence
1183 des propriétés internes.
1184
1185 @item
1186 un objet C++ : Tout objet musical est représenté par un objet de la
1187 classe C++ @code{Music}.
1188 @end itemize
1189
1190 L'information réelle d'une expression musicale est enregistrée sous
1191 forme de propriétés.  Par exemple, un @rinternals{NoteEvent} dispose des
1192 propriétés @code{pitch} et @code{duration}, respectivement chargées de
1193 stocker la hauteur et la durée de cette note.  Les différentes
1194 propriétés sont répertoriées à la rubrique @rinternals{Music properties}
1195 de la référence des propriétés internes.
1196
1197 Une expression composite est un objet musical dont les propriétés
1198 contiennent d'autres objets musicaux.  S'il s'agit d'une liste d'objets,
1199 elle sera stockée dans la propriété @code{elements} d'un objet
1200 musical ; s'il n'y a qu'un seul objet @qq{enfant}, il sera stocké
1201 dans la propriété @code{element}.  Ainsi, par exemple, les enfants de
1202 @rinternals{SequentialMusic} iront dans @code{elements}, alors que
1203 l'argument unique de @rinternals{GraceMusic} ira dans @code{element}.
1204 De même, le corps d'une répétition ira dans la propriété @code{element}
1205 d'un @rinternals{RepeatedMusic}, les alternatives quant à elles dans la
1206 propriété @code{elements}.
1207
1208
1209 @node Construction de fonctions complexes
1210 @section Construction de fonctions complexes
1211 @translationof Building complicated functions
1212
1213 Nous allons voir dans cette partie les moyens dont vous disposez pour
1214 obtenir les informations qui vous permettront de créer vos propres
1215 fonctions musicales complexes.
1216
1217 @menu
1218 * Affichage d'expressions musicales::
1219 * Propriétés musicales::
1220 * Doublement d'une note avec liaison (exemple)::
1221 * Ajout d'articulation à des notes (exemple)::
1222 @end menu
1223
1224
1225 @node Affichage d'expressions musicales
1226 @subsection Affichage d'expressions musicales
1227 @translationof Displaying music expressions
1228
1229 @cindex stockage interne
1230 @cindex expression musicale, affichage
1231 @cindex représentation interne, affichage
1232 @cindex displayMusic
1233 @funindex \displayMusic
1234
1235 Lorsque l'on veut écrire une fonction musicale, il est intéressant
1236 d'examiner comment une expression musicale est représentée en interne.
1237 Vous disposez à cet effet de la fonction musicale @code{\displayMusic}.
1238
1239 @example
1240 @{
1241   \displayMusic @{ c'4\f @}
1242 @}
1243 @end example
1244
1245 @noindent
1246 affichera
1247
1248 @example
1249 (make-music
1250   'SequentialMusic
1251   'elements
1252   (list (make-music
1253           'NoteEvent
1254           'articulations
1255           (list (make-music
1256                   'AbsoluteDynamicEvent
1257                   'text
1258                   "f"))
1259           'duration
1260           (ly:make-duration 2 0 1 1)
1261           'pitch
1262           (ly:make-pitch 0 0 0))))
1263 @end example
1264
1265 Par défaut, LilyPond affichera ces messages sur la console, parmi toutes
1266 les autres informations.  Vous pouvez, afin de les isoler et de garder
1267 le résultat des commandes @code{\display@{TRUC@}}, rediriger la sortie
1268 vers un fichier :
1269
1270 @example
1271 lilypond file.ly >display.txt
1272 @end example
1273
1274 Un peu de Scheme combiné à notre code LilyPond, et les seules
1275 informations qui nous intéressent se retrouveront directement dans un
1276 fichier indépendant :
1277
1278 @example
1279 @{
1280   #(with-output-to-file "display.txt"
1281       (lambda () #@{ \displayMusic @{ c'4\f @} #@}))
1282 @}
1283 @end example
1284
1285 L'information sera encore plus lisible après un peu de mise en forme :
1286
1287 @example
1288 (make-music 'SequentialMusic
1289   'elements (list
1290              (make-music 'NoteEvent
1291                'articulations (list
1292                                (make-music 'AbsoluteDynamicEvent
1293                                  'text
1294                                  "f"))
1295                'duration (ly:make-duration 2 0 1 1)
1296                'pitch    (ly:make-pitch 0 0 0))))
1297 @end example
1298
1299 Une séquence musicale @code{@{ ... @}} se voit attribuer le nom de
1300 @code{SequentialMusic}, et les expressions qu'elle contient sont
1301 enregistrées en tant que liste dans sa propriété @code{'elements}.  Une
1302 note est représentée par un objet @code{NoteEvent} -- contenant les
1303 propriétés de durée et hauteur -- ainsi que l'information qui lui est
1304 attachée -- en l'occurrence un @code{AbsoluteDynamicEvent} ayant une
1305 propriété @code{text} de valeur @code{"f"} -- et stockée dans sa
1306 propriété @code{articulations}.
1307
1308 @funindex{\void}
1309 La fonction @code{\displayMusic} renvoie la musique qu'elle
1310 affiche ; celle-ci sera donc aussi interprétée.  L'insertion d'une
1311 commande @code{\void} avant le @code{\displayMusic} permet de
1312 s'affranchir de la phase d'interprétation.
1313
1314
1315 @node Propriétés musicales
1316 @subsection Propriétés musicales
1317 @translationof Music properties
1318
1319 Nous abordons ici les propriétés @emph{music}, et non pas les propriétés
1320 @emph{context} ou @emph{layout}.
1321
1322 Partons de cet exemple simple@tie{}:
1323
1324 @example
1325 someNote = c'
1326 \displayMusic \someNote
1327 ===>
1328 (make-music
1329   'NoteEvent
1330   'duration
1331   (ly:make-duration 2 0 1 1)
1332   'pitch
1333   (ly:make-pitch 0 0 0))
1334 @end example
1335
1336 L'objet @code{NoteEvent} est la représentation brute de @code{someNote}.
1337 Voyons ce qui se passe lorsque nous plaçons ce @notation{c'} dans une
1338 construction d'accord :
1339
1340 @example
1341 someNote = <c'>
1342 \displayMusic \someNote
1343 ===>
1344 (make-music
1345   'EventChord
1346   'elements
1347   (list (make-music
1348           'NoteEvent
1349           'duration
1350           (ly:make-duration 2 0 1 1)
1351           'pitch
1352           (ly:make-pitch 0 0 0))))
1353 @end example
1354
1355 L'objet @code{NoteEvent} est maintenant le premier objet de la propriété
1356 @code{'elements} de @code{someNote}.
1357
1358 @code{\displayMusic} utilise la fonction @code{display-scheme-music}
1359 pour afficher la représentation en Scheme d'une expression musicale :
1360
1361 @example
1362 #(display-scheme-music (first (ly:music-property someNote 'elements)))
1363 ===>
1364 (make-music
1365   'NoteEvent
1366   'duration
1367   (ly:make-duration 2 0 1 1)
1368   'pitch
1369   (ly:make-pitch 0 0 0))
1370 @end example
1371
1372 La hauteur de la note est accessible au travers de la propriété
1373 @code{'pitch} de l'objet @code{NoteEvent} :
1374
1375 @example
1376 #(display-scheme-music
1377    (ly:music-property (first (ly:music-property someNote 'elements))
1378                       'pitch))
1379 ===>
1380 (ly:make-pitch 0 0 0)
1381 @end example
1382
1383 La hauteur de la note se modifie en définissant sa propriété
1384 @code{'pitch}@tie{}:
1385
1386 @funindex \displayLilyMusic
1387
1388 @example
1389 #(set! (ly:music-property (first (ly:music-property someNote 'elements))
1390                           'pitch)
1391        (ly:make-pitch 0 1 0)) ;; set the pitch to d'.
1392 \displayLilyMusic \someNote
1393 ===>
1394 d'
1395 @end example
1396
1397
1398 @node Doublement d'une note avec liaison (exemple)
1399 @subsection Doublement d'une note avec liaison (exemple)
1400 @translationof Doubling a note with slurs (example)
1401
1402 Supposons que nous ayons besoin de créer une fonction transformant une
1403 saisie @code{a} en @w{@code{@{ a( a) @}}}.  Commençons par examiner
1404 comment le résultat est représenté en interne.
1405
1406 @example
1407 \displayMusic@{ a'( a') @}
1408 ===>
1409 (make-music
1410   'SequentialMusic
1411   'elements
1412   (list (make-music
1413           'NoteEvent
1414           'articulations
1415           (list (make-music
1416                   'SlurEvent
1417                   'span-direction
1418                   -1))
1419           'duration
1420           (ly:make-duration 2 0 1 1)
1421           'pitch
1422           (ly:make-pitch 0 5 0))
1423         (make-music
1424           'NoteEvent
1425           'articulations
1426           (list (make-music
1427                   'SlurEvent
1428                   'span-direction
1429                   1))
1430           'duration
1431           (ly:make-duration 2 0 1 1)
1432           'pitch
1433           (ly:make-pitch 0 5 0))))
1434 @end example
1435
1436 Mauvaise nouvelle ! Les expressions @code{SlurEvent} doivent
1437 s'ajouter @qq{à l'intérieur} de la note -- dans sa propriété
1438 @code{articulations}.
1439
1440 Examinons à présent la saisie :
1441
1442 @example
1443 \displayMusic a'
1444 ===>
1445 (make-music
1446   'NoteEvent
1447   'duration
1448   (ly:make-duration 2 0 1 1)
1449   'pitch
1450   (ly:make-pitch 0 5 0))))
1451 @end example
1452
1453 Nous aurons donc besoin, dans notre fonction, de cloner cette expression
1454 -- de telle sorte que les deux notes constituent la séquence -- puis
1455 d'ajouter un @code{SlurEvent} à la propriété @code{'articulations} de
1456 chacune d'elles, et enfin réaliser un @code{SequentialMusic} de ces deux
1457 @code{EventChords}.  En tenant compte du fait que, dans le cadre d'un
1458 ajout, une propriété non définie est lue @code{'()} (une liste vide),
1459 aucune vérification n'est requise avant d'introduire un nouvel élément
1460 en tête de la propriété @code{articulations}.
1461
1462 @example
1463 doubleSlur = #(define-music-function (parser location note) (ly:music?)
1464          "Renvoie : @{ note ( note ) @}.
1465          `note' est censé être une note unique."
1466          (let ((note2 (ly:music-deep-copy note)))
1467            (set! (ly:music-property note 'articulations)
1468                  (cons (make-music 'SlurEvent 'span-direction -1)
1469                        (ly:music-property note 'articulations)))
1470            (set! (ly:music-property note2 'articulations)
1471                  (cons (make-music 'SlurEvent 'span-direction 1)
1472                        (ly:music-property note2 'articulations)))
1473            (make-music 'SequentialMusic 'elements (list note note2))))
1474 @end example
1475
1476
1477 @node Ajout d'articulation à des notes (exemple)
1478 @subsection Ajout d'articulation à des notes (exemple)
1479 @translationof Adding articulation to notes (example)
1480
1481 Le moyen d'ajouter une articulation à des notes consiste à fusionner
1482 deux expressions musicales en un même contexte, comme nous l'avons vu à
1483 la rubrique @ruser{Création d'un contexte}.  L'option de réaliser
1484 nous-mêmes une fonction musicale à cette fin nous offre l'avantage de
1485 pouvoir alors ajouter une articulation, telle qu'une instruction de
1486 doigté, individuellement à l'une des notes d'un accord, ce qui est
1487 impossible dans le cadre d'une simple fusion de musique indépendante.
1488
1489 Un @code{$variable} au milieu de la notation @code{#@{...#@}} se
1490 comporte exactement comme un banal @code{\variable} en notation LilyPond
1491 traditionnelle.  Nous savons déjà que
1492
1493 @example
1494 @{ \musique -. -> @}
1495 @end example
1496
1497 @noindent
1498 n'est pas admis par LilyPond.  Nous pourrions tout à fait contourner ce
1499 problème en attachant l'articulation à un accord vide,
1500
1501 @example
1502 @{ << \musique <> -. -> >> @}
1503 @end example
1504
1505 @noindent
1506 mais, pour les besoins de la démonstration, nous allons voir comment
1507 réaliser ceci en Scheme.  Commençons par examiner une saisie simple et
1508 le résultat auquel nous désirons aboutir :
1509
1510 @example
1511 %  saisie
1512 \displayMusic c4
1513 ===>
1514 (make-music
1515   'NoteEvent
1516   'duration
1517   (ly:make-duration 2 0 1 1)
1518   'pitch
1519   (ly:make-pitch -1 0 0))))
1520 =====
1521 %  résultat attendu
1522 \displayMusic c4->
1523 ===>
1524 (make-music
1525   'NoteEvent
1526   'articulations
1527   (list (make-music
1528           'ArticulationEvent
1529           'articulation-type
1530           "accent"))
1531   'duration
1532   (ly:make-duration 2 0 1 1)
1533   'pitch
1534   (ly:make-pitch -1 0 0))
1535 @end example
1536
1537 Nous voyons qu'une note (@code{c4}) est représentée par une expression
1538 @code{NoteEvent}.  Si nous souhaitons ajouter une articulation
1539 @notation{accent}, nous devrons ajouter une expression
1540 @code{ArticulationEvent} à la propriété @code{articulations} de
1541 l'expression @code{NoteEvent}.
1542
1543 Construisons notre fonction en commençant par
1544
1545 @example
1546 (define (ajoute-accent note-event)
1547   "Ajoute un accent (ArticulationEvent) aux articulations de `note-event',
1548   qui est censé être une expression NoteEvent."
1549   (set! (ly:music-property note-event 'articulations)
1550         (cons (make-music 'ArticulationEvent
1551                 'articulation-type "accent")
1552               (ly:music-property note-event 'articulations)))
1553   note-event)
1554 @end example
1555
1556 La première ligne est la manière de définir une fonction en Scheme : la
1557 fonction Scheme a pour nom @code{ajoute-accent} et elle comporte une
1558 variable appelée @code{note-event}.  En Scheme, le type d'une variable
1559 se déduit la plupart de temps de par son nom -- c'est d'ailleurs une
1560 excellente pratique que l'on retrouve dans de nombreux autres langages.
1561
1562 @example
1563 "Ajoute un accent..."
1564 @end example
1565
1566 @noindent
1567 décrit ce que fait la fonction.  Bien que ceci ne soit pas primordial,
1568 tout comme des noms de variable évidents, tâchons néanmoins de prendre
1569 de bonnes habitudes dès nos premiers pas.
1570
1571 Vous pouvez vous demander pourquoi nous modifions directement
1572 l'événement note plutôt que d'en manipuler une copie -- on pourrait
1573 utiliser @code{ly:music-deep-copy} à cette fin.  La raison en est qu'il
1574 existe un contrat tacite : les fonctions musicales sont autorisées
1575 à modifier leurs arguments -- ils sont générés en partant de zéro (comme
1576 les notes que vous saisissez) ou déjà recopiés (faire référence à une
1577 variable musicale avec @samp{\name} ou à de la musique issue
1578 d'expressions Scheme @samp{$(@dots{})} aboutit à une copie).  Dans la
1579 mesure où surmultiplier les copies serait contre productif, la valeur de
1580 retour d'une fonction musicale n'est @strong{pas} recopiée.  Afin de
1581 respecter ce contrat, n'utilisez pas un même argument à plusieurs
1582 reprises, et n'oubliez pas que le retourner compte pour une utilisation.
1583
1584 Dans un exemple précédent, nous avons construit de la musique en
1585 répétant un certain argument musical.  Dans ce cas là, l'une des
1586 répétitions se devait d'être une copie.  Dans le cas contraire,
1587 certaines bizarreries auraient pu survenir.  Par exemple, la présence
1588 d'un @code{\relative} ou d'un @code{\transpose}, après plusieurs
1589 répétitions du même élément, entraînerait des @qq{relativisations} ou
1590 transpositions en cascade.  Si nous les assignons à une variable
1591 musicale, l'enchaînement est rompu puisque la référence à @samp{\nom}
1592 créera une nouvelle copie sans toutefois prendre en considération
1593 l'identité des éléments répétés.
1594
1595 Cette fonction n'étant pas une fonction musicale à part entière, elle
1596 peut s'utiliser dans d'autres fonctions musicales.  Il est donc sensé de
1597 respecter le même contrat que pour les fonctions musicales :
1598 l'entrée peut être modifiée pour arriver à une sortie, et il est de la
1599 responsabilité de l'appelant d'effectuer des copies s'il a réellement
1600 besoin de l'argument dans son état originel.  Vous constaterez, à la
1601 lecture des fonctions propres à LilyPond, comme @code{music-map}, que ce
1602 principe est toujours respecté.
1603
1604 Revenons à nos moutons@dots{} Nous disposons maintenant d'un
1605 @code{note-event} que nous pouvons modifier, non pas grâce à un
1606 @code{ly:music-deep-copy}, mais plutôt en raison de notre précédente
1607 réflexion.  Nous ajoutons @notation{l'accent} à la liste de ses
1608 propriétés @code{'articulations}.
1609
1610 @example
1611 (set! emplacement nouvelle-valeur)
1612 @end example
1613
1614 L'emplacement est ce que nous voulons ici définir.  Il s'agit de la
1615 propriété @code{'articulations} de l'expression @code{note-event}.
1616
1617 @example
1618 (ly:music-property note-event 'articulations)
1619 @end example
1620
1621 La fonction @code{ly:music-property} permet d'accéder aux propriétés
1622 musicales -- les @code{'articulations}, @code{'duration}, @code{'pitch}
1623 etc. que @code{\displayMusic} nous a indiquées.  La nouvelle valeur sera
1624 l'ancienne propriété @code{'articulations}, augmentée d'un
1625 élément : l'expression @code{ArticulationEvent}, que nous
1626 recopions à partir des informations de @code{\displayMusic}.
1627
1628 @example
1629 (cons (make-music 'ArticulationEvent
1630         'articulation-type "accent")
1631       (ly:music-property result-event-chord 'articulations))
1632 @end example
1633
1634 @code{cons} permet d'ajouter un élément en tête de liste sans pour
1635 autant modifier la liste originale.  C'est exactement ce que nous
1636 recherchons : la même liste qu'auparavant, plus la nouvelle
1637 expression @code{ArticulationEvent}.  L'ordre au sein de la propriété
1638 @code{'articulations} n'a ici aucune importance.
1639
1640 Enfin, après avoir ajouté l'articulation @notation{accent} à sa
1641 propriété @code{articulations}, nous pouvons renvoyer le
1642 @code{note-event}, ce que réalise la dernière ligne de notre fonction.
1643
1644 Nous pouvons à présent transformer la fonction @code{ajoute-accent} en
1645 fonction musicale, à l'aide d'un peu d'enrobage syntaxique et mention du
1646 type de son unique argument @qq{réel}.
1647
1648 @example
1649 ajouteAccent = #(define-music-function (parser location note-event)
1650                                         (ly:music?)
1651   "Ajoute un accent (ArticulationEvent) aux articulations de `note-event',
1652   qui est censé être une expression NoteEvent."
1653   (set! (ly:music-property note-event 'articulations)
1654         (cons (make-music 'ArticulationEvent
1655                 'articulation-type "accent")
1656               (ly:music-property note-event 'articulations)))
1657   note-event)
1658 @end example
1659
1660 Par acquis de conscience, vérifions que tout ceci fonctione :
1661
1662 @example
1663 \displayMusic \ajouteAccent c4
1664 @end example
1665
1666
1667
1668 @ignore
1669 @menu
1670 * Tweaking with Scheme::
1671 @end menu
1672
1673 @c @nod e Tweaking with Scheme
1674 @c @sectio n Tweaking with Scheme
1675
1676 We have seen how LilyPond output can be heavily modified using
1677 commands like
1678 @code{\override TextScript.extra-offset = ( 1 . -1)}.  But
1679 we have even more power if we use Scheme.  For a full explanation
1680 of this, see the @ref{Scheme tutorial}, and
1681 @ref{Interfaces for programmers}.
1682
1683 We can use Scheme to simply @code{\override} commands,
1684
1685 TODO Find a simple example
1686 @c This isn't a valid example with skylining
1687 @c It works fine without padText  -td
1688 @end ignore
1689
1690 @ignore
1691 @lilypond[quote,verbatim,ragged-right]
1692 padText = #(define-music-function (parser location padding) (number?)
1693 #{
1694   \once \override TextScript.padding = #padding
1695 #})
1696
1697 \relative c''' {
1698   c4^"piu mosso" b a b
1699   \padText #1.8
1700   c4^"piu mosso" d e f
1701   \padText #2.6
1702   c4^"piu mosso" fis a g
1703 }
1704 @end lilypond
1705 @end ignore
1706
1707 @ignore
1708 We can use it to create new commands:
1709
1710 @c Check this is a valid example with skylining
1711 @c It is - 'padding still works
1712
1713
1714 @lilypond[quote,verbatim,ragged-right]
1715 tempoPadded = #(define-music-function (parser location padding tempotext)
1716   (number? markup?)
1717 #{
1718   \once \override Score.MetronomeMark.padding = #padding
1719   \tempo \markup { \bold #tempotext }
1720 #})
1721
1722 \relative c'' {
1723   \tempo \markup { "Low tempo" }
1724   c4 d e f g1
1725   \tempoPadded #4.0 "High tempo"
1726   g4 f e d c1
1727 }
1728 @end lilypond
1729
1730
1731 Even music expressions can be passed in:
1732
1733 @lilypond[quote,verbatim,ragged-right]
1734 pattern = #(define-music-function (parser location x y) (ly:music? ly:music?)
1735 #{
1736   #x e8 a b $y b a e
1737 #})
1738
1739 \relative c''{
1740   \pattern c8 c8\f
1741   \pattern {d16 dis} { ais16-> b\p }
1742 }
1743 @end lilypond
1744 @end ignore