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