scm/define-music-display-methods.scm

   1 ;;; define-music-display-methods.scm -- data for displaying music
   2 ;;; expressions using LilyPond notation.
   3 ;;;
   4 ;;; Copyright (C) 2005--2012 Nicolas Sceaux  <nicolas.sceaux@free.fr>
   5 ;;;
   6
   7 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
   8 ;;;
   9 ;;; Display method implementation
  10 ;;;
  11
  12 (define-module (scm display-lily))
  13
  14 ;;;
  15 ;;; Scheme forms
  16 ;;;
  17 (define (scheme-expr->lily-string scm-arg)
  18   (cond ((or (number? scm-arg)
  19              (string? scm-arg)
  20              (boolean? scm-arg))
  21          (format #f "~s" scm-arg))
  22         ((or (symbol? scm-arg)
  23              (list? scm-arg))
  24          (format #f "'~s" scm-arg))
  25         ((procedure? scm-arg)
  26          (format #f "~a"
  27                  (or (procedure-name scm-arg)
  28                      (with-output-to-string
  29                        (lambda ()
  30                          (pretty-print (procedure-source scm-arg)))))))
  31         (else
  32          (format #f "~a"
  33                  (with-output-to-string
  34                    (lambda ()
  35                      (display-scheme-music scm-arg)))))))
  36 ;;;
  37 ;;; Markups
  38 ;;;
  39
  40 (define-public (markup->lily-string markup-expr)
  41   "Return a string describing, in LilyPond syntax, the given markup
  42 expression."
  43   (define (proc->command proc)
  44     (let ((cmd-markup (symbol->string (procedure-name proc))))
  45       (substring cmd-markup 0 (- (string-length cmd-markup)
  46                                  (string-length "-markup")))))
  47   (define (arg->string arg)
  48     (cond ((string? arg)
  49            (format #f "~s" arg))
  50           ((markup? arg) ;; a markup
  51            (markup->lily-string-aux arg))
  52           ((and (pair? arg) (every markup? arg)) ;; a markup list
  53            (format #f "{~{ ~a~}}" (map-in-order markup->lily-string-aux arg)))
  54           (else          ;; a scheme argument
  55            (format #f "#~a" (scheme-expr->lily-string arg)))))
  56   (define (markup->lily-string-aux expr)
  57     (if (string? expr)
  58         (format #f "~s" expr)
  59         (let ((cmd (car expr))
  60               (args (cdr expr)))
  61           (if (eqv? cmd simple-markup) ;; a simple markup
  62               (format #f "~s" (car args))
  63               (format #f "\\~a~{ ~a~}"
  64                       (proc->command cmd)
  65                       (map-in-order arg->string args))))))
  66   (cond ((string? markup-expr)
  67          (format #f "~s" markup-expr))
  68         ((eqv? (car markup-expr) simple-markup)
  69          (format #f "~s" (second markup-expr)))
  70         (else
  71          (format #f "\\markup ~a"
  72                  (markup->lily-string-aux markup-expr)))))
  73
  74 ;;;
  75 ;;; pitch names
  76 ;;;
  77
  78 ;; It is a pity that there is no rassoc in Scheme.
  79 (define* (rassoc item alist #:optional (test equal?))
  80   (do ((alist alist (cdr alist))
  81        (result #f result))
  82       ((or result (null? alist)) result)
  83     (if (and (car alist) (test item (cdar alist)))
  84         (set! result (car alist)))))
  85
  86 (define-public (note-name->lily-string ly-pitch parser)
  87   ;; here we define a custom pitch= function, since we do not want to
  88   ;; test whether octaves are also equal. (otherwise, we would be using equal?)
  89   (define (pitch= pitch1 pitch2)
  90     (and (= (ly:pitch-notename pitch1) (ly:pitch-notename pitch2))
  91          (= (ly:pitch-alteration pitch1) (ly:pitch-alteration pitch2))))
  92   (let ((result (rassoc ly-pitch (ly:parser-lookup parser 'pitchnames) pitch=)))
  93     (if result
  94         (car result)
  95         #f)))
  96
  97 (define-public (octave->lily-string pitch)
  98   (let ((octave (ly:pitch-octave pitch)))
  99     (cond ((>= octave 0)
 100            (make-string (1+ octave) #\'))
 101           ((< octave -1)
 102            (make-string (1- (* -1 octave)) #\,))
 103           (else ""))))
 104
 105 ;;;
 106 ;;; durations
 107 ;;;
 108 (define*-public (duration->lily-string ly-duration #:key (prev-duration (*previous-duration*))
 109                         (force-duration (*force-duration*))
 110                         (time-scale (*time-scale*))
 111                         remember)
 112   (if remember (*previous-duration* ly-duration))
 113   (let ((log2    (ly:duration-log ly-duration))
 114         (dots    (ly:duration-dot-count ly-duration))
 115         (scale (ly:duration-scale ly-duration)))
 116     (if (or force-duration (not prev-duration) (not (equal? ly-duration prev-duration)))
 117         (string-append (case log2
 118                          ((-1) "\\breve")
 119                          ((-2) "\\longa")
 120                          ((-3) "\\maxima")
 121                          (else (number->string (expt 2 log2))))
 122                        (make-string dots #\.)
 123                        (let ((end-scale (/ scale time-scale)))
 124                          (if (= end-scale 1) ""
 125                              (format #f "*~a" end-scale))))
 126         "")))
 127
 128 ;;;
 129 ;;; post events
 130 ;;;
 131
 132 (define (post-event? m)
 133   (music-is-of-type? m 'post-event))
 134
 135 (define* (event-direction->lily-string event #:optional (required #t))
 136   (let ((direction (ly:music-property event 'direction)))
 137     (cond ((or (not direction) (null? direction) (= CENTER direction))
 138            (if required "-" ""))
 139           ((= UP direction) "^")
 140           ((= DOWN direction) "_")
 141           (else ""))))
 142
 143 (define-macro (define-post-event-display-method type vars direction-required str)
 144   `(define-display-method ,type ,vars
 145      (format #f "~a~a"
 146              (event-direction->lily-string ,(car vars) ,direction-required)
 147              ,str)))
 148
 149 (define-macro (define-span-event-display-method type vars direction-required str-start str-stop)
 150   `(define-display-method ,type ,vars
 151      (format #f "~a~a"
 152              (event-direction->lily-string ,(car vars) ,direction-required)
 153              (if (= START (ly:music-property ,(car vars) 'span-direction))
 154                  ,str-start
 155                  ,str-stop))))
 156
 157 (define-display-method HyphenEvent (event parser)
 158   " --")
 159 (define-display-method ExtenderEvent (event parser)
 160   " __")
 161 (define-display-method TieEvent (event parser)
 162   " ~")
 163 (define-display-method BeamForbidEvent (event parser)
 164   "\\noBeam")
 165 (define-display-method StringNumberEvent (event parser)
 166   (format #f "\\~a" (ly:music-property event 'string-number)))
 167
 168
 169 (define-display-method TremoloEvent (event parser)
 170   (let ((tremolo-type (ly:music-property event 'tremolo-type)))
 171     (format #f ":~a" (if (= 0 tremolo-type)
 172                          ""
 173                          tremolo-type))))
 174
 175 (define-display-method ArticulationEvent (event parser) #t
 176   (let* ((articulation  (ly:music-property event 'articulation-type))
 177          (shorthand
 178           (case (string->symbol articulation)
 179             ((marcato) "^")
 180             ((stopped) "+")
 181             ((tenuto)    "-")
 182             ((staccatissimo) "|")
 183             ((accent) ">")
 184             ((staccato) ".")
 185             ((portato) "_")
 186             (else #f))))
 187     (format #f "~a~:[\\~;~]~a"
 188             (event-direction->lily-string event shorthand)
 189             shorthand
 190             (or shorthand articulation))))
 191
 192 (define-post-event-display-method FingeringEvent (event parser) #t
 193   (ly:music-property event 'digit))
 194
 195 (define-post-event-display-method TextScriptEvent (event parser) #t
 196   (markup->lily-string (ly:music-property event 'text)))
 197
 198 (define-post-event-display-method MultiMeasureTextEvent (event parser) #t
 199   (markup->lily-string (ly:music-property event 'text)))
 200
 201 (define-post-event-display-method BendAfterEvent (event parser) #f
 202   (format #f "\\bendAfter #~a" (ly:music-property event 'delta-step)))
 203
 204 (define-post-event-display-method HarmonicEvent (event parser) #f "\\harmonic")
 205 (define-post-event-display-method GlissandoEvent (event parser) #f "\\glissando")
 206 (define-post-event-display-method ArpeggioEvent (event parser) #f "\\arpeggio")
 207 (define-post-event-display-method AbsoluteDynamicEvent (event parser) #f
 208   (format #f "\\~a" (ly:music-property event 'text)))
 209
 210 (define-post-event-display-method StrokeFingerEvent (event parser) #f
 211   (format #f "\\rightHandFinger #~a" (ly:music-property event 'digit)))
 212
 213 (define-span-event-display-method BeamEvent (event parser) #f "[" "]")
 214 (define-span-event-display-method SlurEvent (event parser) #f "(" ")")
 215 (define-span-event-display-method CrescendoEvent (event parser) #f "\\<" "\\!")
 216 (define-span-event-display-method DecrescendoEvent (event parser) #f "\\>" "\\!")
 217 (define-span-event-display-method EpisemaEvent (event parser) #f "\\episemInitium" "\\episemFinis")
 218 (define-span-event-display-method PhrasingSlurEvent (event parser) #f "\\(" "\\)")
 219 (define-span-event-display-method SustainEvent (event parser) #f "\\sustainOn" "\\sustainOff")
 220 (define-span-event-display-method SostenutoEvent (event parser) #f "\\sostenutoOn" "\\sostenutoOff")
 221 (define-span-event-display-method TextSpanEvent (event parser) #f "\\startTextSpan" "\\stopTextSpan")
 222 (define-span-event-display-method TrillSpanEvent (event parser) #f "\\startTrillSpan" "\\stopTrillSpan")
 223 (define-span-event-display-method StaffSpanEvent (event parser) #f "\\startStaff" "\\stopStaff")
 224 (define-span-event-display-method NoteGroupingEvent (event parser) #f "\\startGroup" "\\stopGroup")
 225 (define-span-event-display-method UnaCordaEvent (event parser) #f "\\unaCorda" "\\treCorde")
 226
 227 ;;;
 228 ;;; Graces
 229 ;;;
 230
 231 (define-display-method GraceMusic (expr parser)
 232   (format #f "\\grace ~a"
 233           (music->lily-string (ly:music-property expr 'element) parser)))
 234
 235 ;; \acciaccatura \appoggiatura \grace
 236 ;; TODO: it would be better to compare ?start and ?stop
 237 ;; with startAppoggiaturaMusic and stopAppoggiaturaMusic,
 238 ;; using a custom music equality predicate.
 239 (define-extra-display-method GraceMusic (expr parser)
 240   "Display method for appoggiatura."
 241   (with-music-match (expr (music
 242                            'GraceMusic
 243                            element (music
 244                                     'SequentialMusic
 245                                     elements (?start
 246                                               ?music
 247                                               ?stop))))
 248     ;; we check whether ?start and ?stop look like
 249     ;; startAppoggiaturaMusic stopAppoggiaturaMusic
 250     (and (with-music-match (?start (music
 251                                     'SequentialMusic
 252                                     elements ((music
 253                                                'EventChord
 254                                                elements
 255                                                ((music
 256                                                  'SlurEvent
 257                                                  span-direction START))))))
 258             #t)
 259          (with-music-match (?stop (music
 260                                    'SequentialMusic
 261                                    elements ((music
 262                                               'EventChord
 263                                               elements
 264                                               ((music
 265                                                 'SlurEvent
 266                                                 span-direction STOP))))))
 267             (format #f "\\appoggiatura ~a" (music->lily-string ?music parser))))))
 268
 269
 270 (define-extra-display-method GraceMusic (expr parser)
 271   "Display method for acciaccatura."
 272   (with-music-match (expr (music
 273                            'GraceMusic
 274                            element (music
 275                                     'SequentialMusic
 276                                     elements (?start
 277                                               ?music
 278                                               ?stop))))
 279     ;; we check whether ?start and ?stop look like
 280     ;; startAcciaccaturaMusic stopAcciaccaturaMusic
 281     (and (with-music-match (?start (music
 282                                     'SequentialMusic
 283                                     elements ((music
 284                                                'EventChord
 285                                                elements
 286                                                ((music
 287                                                  'SlurEvent
 288                                                  span-direction START)))
 289                                               (music
 290                                                'ContextSpeccedMusic
 291                                                element (music
 292                                                         'OverrideProperty
 293                                                         grob-property-path '(stroke-style)
 294                                                         grob-value "grace"
 295                                                         symbol 'Flag)))))
 296            #t)
 297          (with-music-match (?stop (music
 298                                    'SequentialMusic
 299                                    elements ((music
 300                                               'ContextSpeccedMusic
 301                                               element (music
 302                                                        'RevertProperty
 303                                                        grob-property-path '(stroke-style)
 304                                                        symbol 'Flag))
 305
 306                                              (music
 307                                               'EventChord
 308                                               elements
 309                                               ((music
 310                                                 'SlurEvent
 311                                                 span-direction STOP))))))
 312            (format #f "\\acciaccatura ~a" (music->lily-string ?music parser))))))
 313
 314 (define-extra-display-method GraceMusic (expr parser)
 315   "Display method for grace."
 316   (with-music-match (expr (music
 317                            'GraceMusic
 318                            element (music
 319                                     'SequentialMusic
 320                                     elements (?start
 321                                               ?music
 322                                               ?stop))))
 323     ;; we check whether ?start and ?stop look like
 324     ;; startGraceMusic stopGraceMusic
 325     (and (null? (ly:music-property ?start 'elements))
 326          (null? (ly:music-property ?stop 'elements))
 327          (format #f "\\grace ~a" (music->lily-string ?music parser)))))
 328
 329 ;;;
 330 ;;; Music sequences
 331 ;;;
 332
 333 (define-display-method SequentialMusic (seq parser)
 334   (let ((force-line-break (and (*force-line-break*)
 335                                ;; hm
 336                                (> (length (ly:music-property seq 'elements))
 337                                   (*max-element-number-before-break*))))
 338         (elements (ly:music-property seq 'elements))
 339         (chord? (make-music-type-predicate 'EventChord))
 340         (note-or-chord? (make-music-type-predicate 'EventChord 'NoteEvent
 341                                                    'LyricEvent 'RestEvent
 342                                                    'ClusterNoteEvent))
 343         (cluster? (make-music-type-predicate 'ClusterNoteEvent))
 344         (note? (make-music-type-predicate 'NoteEvent)))
 345     (format #f "~a~a{~v%~v_~{~a~^ ~}~v%~v_}"
 346             (if (any (lambda (e)
 347                        (or (cluster? e)
 348                            (and (chord? e)
 349                                 (any cluster? (ly:music-property e 'elements)))))
 350                      elements)
 351                 "\\makeClusters "
 352                 "")
 353             (if (*explicit-mode*)
 354                 ;; if the sequence contains EventChord which contains figures ==> figuremode
 355                 ;; if the sequence contains EventChord which contains lyrics ==> lyricmode
 356                 ;; if the sequence contains EventChord which contains drum notes ==> drummode
 357                 (cond ((any (lambda (chord)
 358                               (any (make-music-type-predicate 'BassFigureEvent)
 359                                    (ly:music-property chord 'elements)))
 360                             (filter chord? elements))
 361                        "\\figuremode ")
 362                       ((any (lambda (chord)
 363                               (any (make-music-type-predicate 'LyricEvent)
 364                                    (cons chord
 365                                          (ly:music-property chord 'elements))))
 366                             (filter note-or-chord? elements))
 367                        "\\lyricmode ")
 368                       ((any (lambda (chord)
 369                               (any (lambda (event)
 370                                      (and (note? event)
 371                                           (not (null? (ly:music-property event 'drum-type)))))
 372                                    (cons chord
 373                                          (ly:music-property chord 'elements))))
 374                             (filter note-or-chord? elements))
 375                        "\\drummode ")
 376                       (else ;; TODO: other modes?
 377                        ""))
 378                 "")
 379             (if force-line-break 1 0)
 380             (if force-line-break (+ 2 (*indent*)) 1)
 381             (parameterize ((*indent* (+ 2 (*indent*))))
 382                           (map-in-order (lambda (music)
 383                                           (music->lily-string music parser))
 384                                         elements))
 385             (if force-line-break 1 0)
 386             (if force-line-break (*indent*) 1))))
 387
 388 (define-display-method SimultaneousMusic (sim parser)
 389   (parameterize ((*indent* (+ 3 (*indent*))))
 390     (format #f "<< ~{~a ~}>>"
 391             (map-in-order (lambda (music)
 392                             (music->lily-string music parser))
 393                           (ly:music-property sim 'elements)))))
 394
 395 (define-extra-display-method SimultaneousMusic (expr parser)
 396   "If `sim' is an \afterGrace expression, return \"\\afterGrace ...\".
 397 Otherwise, return #f."
 398   ;; TODO: do something with afterGraceFraction?
 399   (with-music-match (expr (music 'SimultaneousMusic
 400                                  elements (?before-grace
 401                                            (music 'SequentialMusic
 402                                                   elements ((music 'SkipMusic)
 403                                                             (music 'GraceMusic
 404                                                                    element ?grace))))))
 405     (format #f "\\afterGrace ~a ~a"
 406             (music->lily-string ?before-grace parser)
 407             (music->lily-string ?grace parser))))
 408
 409 ;;;
 410 ;;; Chords
 411 ;;;
 412
 413 (define-display-method EventChord (chord parser)
 414   ;; event_chord : command_element
 415   ;;               | note_chord_element
 416
 417   ;; TODO : tagged post_events
 418   ;; post_events : ( post_event | tagged_post_event )*
 419   ;; tagged_post_event: '-' \tag embedded_scm post_event
 420
 421   (let* ((elements (append (ly:music-property chord 'elements)
 422                            (ly:music-property chord 'articulations)))
 423          (chord-repeat (ly:music-property chord 'duration)))
 424     (call-with-values
 425         (lambda ()
 426           (partition (lambda (m) (music-is-of-type? m 'rhythmic-event))
 427                      elements))
 428       (lambda (chord-elements other-elements)
 429         (cond ((pair? chord-elements)
 430                ;; note_chord_element :
 431                ;; '<' (notepitch | drumpitch)* '>" duration post_events
 432                (let ((duration (duration->lily-string (ly:music-property
 433                                                        (car chord-elements)
 434                                                        'duration)
 435                                                       #:remember #t)))
 436                  ;; Format duration first so that it does not appear on
 437                  ;; chord elements
 438                  (format #f "< ~{~a ~}>~a~:{~:[-~;~]~a~^ ~}"
 439                          (map-in-order (lambda (music)
 440                                          (music->lily-string music parser))
 441                                        chord-elements)
 442                          duration
 443                          (map-in-order (lambda (music)
 444                                          (list
 445                                           (post-event? music)
 446                                           (music->lily-string music parser)))
 447                                        other-elements))))
 448               ((ly:duration? chord-repeat)
 449                (let ((duration (duration->lily-string chord-repeat
 450                                                       #:remember #t)))
 451                  (format #f "q~a~:{~:[-~;~]~a~^ ~}"
 452                          duration
 453                          (map-in-order (lambda (music)
 454                                          (list
 455                                           (post-event? music)
 456                                           (music->lily-string music parser)))
 457                                        other-elements))))
 458
 459               ((and (= 1 (length other-elements))
 460                     (not (post-event? (car other-elements))))
 461                (format #f (music->lily-string (car other-elements) parser)))
 462               (else
 463                (format #f "< >~:{~:[-~;~]~a~^ ~}"
 464                        (map-in-order (lambda (music)
 465                                        (list
 466                                         (post-event? music)
 467                                         (music->lily-string music parser)))
 468                                      other-elements))))))))
 469
 470 (define-display-method MultiMeasureRestMusic (mmrest parser)
 471   (format #f "R~a~{~a~^ ~}"
 472           (duration->lily-string (ly:music-property mmrest 'duration)
 473                                  #:remember #t)
 474           (map-in-order (lambda (music)
 475                           (music->lily-string music parser))
 476                         (ly:music-property mmrest 'articulations))))
 477
 478 (define-display-method SkipMusic (skip parser)
 479   (format #f "\\skip ~a" (duration->lily-string (ly:music-property skip 'duration) #:force-duration #t)))
 480
 481 (define-display-method OttavaMusic (ottava parser)
 482   (format #f "\\ottava #~a" (ly:music-property ottava 'ottava-number)))
 483
 484 ;;;
 485 ;;; Notes, rests, skips...
 486 ;;;
 487
 488 (define (simple-note->lily-string event parser)
 489   (format #f "~a~a~a~a~a~a~:{~:[-~;~]~a~}" ; pitchname octave !? octave-check duration optional_rest articulations
 490           (note-name->lily-string (ly:music-property event 'pitch) parser)
 491           (octave->lily-string (ly:music-property event 'pitch))
 492           (let ((forced (ly:music-property event 'force-accidental))
 493                 (cautionary (ly:music-property event 'cautionary)))
 494             (cond ((and (not (null? forced))
 495                         forced
 496                         (not (null? cautionary))
 497                         cautionary)
 498                    "?")
 499                   ((and (not (null? forced)) forced) "!")
 500                   (else "")))
 501           (let ((octave-check (ly:music-property event 'absolute-octave)))
 502             (if (not (null? octave-check))
 503                 (format #f "=~a" (cond ((>= octave-check 0)
 504                                         (make-string (1+ octave-check) #\'))
 505                                        ((< octave-check -1)
 506                                         (make-string (1- (* -1 octave-check)) #\,))
 507                                        (else "")))
 508                 ""))
 509           (duration->lily-string (ly:music-property event 'duration)
 510                                  #:remember #t)
 511           (if ((make-music-type-predicate 'RestEvent) event)
 512               "\\rest" "")
 513           (map-in-order (lambda (event)
 514                           (list
 515                            (post-event? event)
 516                            (music->lily-string event parser)))
 517                         (ly:music-property event 'articulations))))
 518
 519 (define-display-method NoteEvent (note parser)
 520   (cond ((not (null? (ly:music-property note 'pitch))) ;; note
 521          (simple-note->lily-string note parser))
 522         ((not (null? (ly:music-property note 'drum-type))) ;; drum
 523          (format #f "~a~a~{~a~}" (ly:music-property note 'drum-type)
 524                  (duration->lily-string (ly:music-property note 'duration)
 525                                         #:remember #t)
 526                  (map-in-order (lambda (event)
 527                                  (music->lily-string event parser))
 528                                (ly:music-property note 'articulations))))
 529         (else ;; unknown?
 530          "")))
 531
 532 (define-display-method ClusterNoteEvent (note parser)
 533   (simple-note->lily-string note parser))
 534
 535 (define-display-method RestEvent (rest parser)
 536   (if (not (null? (ly:music-property rest 'pitch)))
 537       (simple-note->lily-string rest parser)
 538       (format #f "r~a~{~a~}"
 539               (duration->lily-string (ly:music-property rest 'duration)
 540                                      #:remember #t)
 541               (map-in-order (lambda (event)
 542                               (music->lily-string event parser))
 543                             (ly:music-property rest 'articulations)))))
 544
 545 (define-display-method MultiMeasureRestEvent (rest parser)
 546   (string-append "R" (duration->lily-string (ly:music-property rest 'duration)
 547                                             #:remember #t)))
 548
 549 (define-display-method SkipEvent (rest parser)
 550   (format #f "s~a~{~a~}"
 551           (duration->lily-string (ly:music-property rest 'duration)
 552                                  #:remember #t)
 553           (map-in-order (lambda (event)
 554                           (music->lily-string event parser))
 555                         (ly:music-property rest 'articulations))))
 556
 557 (define-display-method RepeatedChord (chord parser)
 558   (music->lily-string (ly:music-property chord 'element) parser))
 559
 560 (define-display-method MarkEvent (mark parser)
 561   (let ((label (ly:music-property mark 'label)))
 562     (if (null? label)
 563         "\\mark \\default"
 564         (format #f "\\mark ~a" (markup->lily-string label)))))
 565
 566 (define-display-method KeyChangeEvent (key parser)
 567   (let ((pitch-alist (ly:music-property key 'pitch-alist))
 568         (tonic (ly:music-property key 'tonic)))
 569     (if (or (null? pitch-alist)
 570             (null? tonic))
 571         "\\key \\default"
 572         (let ((c-pitch-alist (ly:transpose-key-alist pitch-alist
 573                                                      (ly:pitch-diff (ly:make-pitch 0 0 0) tonic))))
 574           (format #f "\\key ~a \\~a~a"
 575                   (note-name->lily-string (ly:music-property key 'tonic) parser)
 576                   (any (lambda (mode)
 577                          (if (and parser
 578                                   (equal? (ly:parser-lookup parser mode) c-pitch-alist))
 579                              (symbol->string mode)
 580                              #f))
 581                        '(major minor ionian locrian aeolian mixolydian lydian phrygian dorian))
 582                   (new-line->lily-string))))))
 583
 584 (define-display-method RelativeOctaveCheck (octave parser)
 585   (let ((pitch (ly:music-property octave 'pitch)))
 586     (format #f "\\octaveCheck ~a~a"
 587             (note-name->lily-string pitch parser)
 588             (octave->lily-string pitch))))
 589
 590 (define-display-method VoiceSeparator (sep parser)
 591   "\\\\")
 592
 593 (define-display-method LigatureEvent (ligature parser)
 594   (if (= START (ly:music-property ligature 'span-direction))
 595       "\\["
 596       "\\]"))
 597
 598 (define-display-method BarCheck (check parser)
 599   (format #f "|~a" (new-line->lily-string)))
 600
 601 (define-display-method PesOrFlexaEvent (expr parser)
 602   "\\~")
 603
 604 (define-display-method BassFigureEvent (figure parser)
 605   (let ((alteration (ly:music-property figure 'alteration))
 606         (fig (ly:music-property figure 'figure))
 607         (bracket-start (ly:music-property figure 'bracket-start))
 608         (bracket-stop (ly:music-property figure 'bracket-stop)))
 609
 610     (format #f "~a~a~a~a"
 611             (if (null? bracket-start) "" "[")
 612             (cond ((null? fig) "_")
 613                   ((markup? fig) (second fig)) ;; fig: (<number-markup> "number")
 614                   (else fig))
 615             (if (null? alteration)
 616                 ""
 617                 (cond
 618                   ((= alteration DOUBLE-FLAT) "--")
 619                   ((= alteration FLAT) "-")
 620                   ((= alteration NATURAL) "!")
 621                   ((= alteration SHARP) "+")
 622                   ((= alteration DOUBLE-SHARP) "++")
 623                   (else "")))
 624             (if (null? bracket-stop) "" "]"))))
 625
 626 (define-display-method LyricEvent (lyric parser)
 627   (format "~a~{~a~^ ~}"
 628           (let ((text (ly:music-property lyric 'text)))
 629             (if (or (string? text)
 630                     (eqv? (first text) simple-markup))
 631                 ;; a string or a simple markup
 632                 (let ((string (if (string? text)
 633                                   text
 634                                   (second text))))
 635                   (if (string-match "(\"| |[0-9])" string)
 636                       ;; TODO check exactly in which cases double quotes should be used
 637                       (format #f "~s" string)
 638                       string))
 639                 (markup->lily-string text)))
 640           (map-in-order (lambda (m) (music->lily-string m parser))
 641                         (ly:music-property lyric 'articulations))))
 642
 643 (define-display-method BreathingEvent (event parser)
 644   "\\breathe")
 645
 646 ;;;
 647 ;;; Staff switches
 648 ;;;
 649
 650 (define-display-method AutoChangeMusic (m parser)
 651   (format #f "\\autochange ~a"
 652           (music->lily-string (ly:music-property m 'element) parser)))
 653
 654 (define-display-method ContextChange (m parser)
 655   (format #f "\\change ~a = \"~a\""
 656           (ly:music-property m 'change-to-type)
 657           (ly:music-property m 'change-to-id)))
 658
 659 ;;;
 660
 661 (define-display-method TimeScaledMusic (times parser)
 662   (let* ((num (ly:music-property times 'numerator))
 663          (den (ly:music-property times 'denominator))
 664          (scale (/ num den))
 665          (dur (*previous-duration*))
 666          (time-scale (*time-scale*)))
 667
 668     (parameterize ((*force-line-break* #f)
 669                    (*previous-duration*
 670                     (ly:make-duration (ly:duration-log dur)
 671                                       (ly:duration-dot-count dur)
 672                                       (* (ly:duration-scale dur)
 673                                          scale)))
 674                    (*time-scale* (* time-scale scale)))
 675       (format #f "\\times ~a/~a ~a"
 676               num
 677               den
 678               (music->lily-string (ly:music-property times 'element) parser)))))
 679
 680 (define-display-method RelativeOctaveMusic (m parser)
 681   (music->lily-string (ly:music-property m 'element) parser))
 682
 683 (define-display-method TransposedMusic (m parser)
 684   (music->lily-string (ly:music-property m 'element) parser))
 685
 686 ;;;
 687 ;;; Repeats
 688 ;;;
 689
 690 (define-display-method AlternativeEvent (alternative parser) "")
 691
 692 (define (repeat->lily-string expr repeat-type parser)
 693   (let* ((main (music->lily-string (ly:music-property expr 'element) parser)))
 694     (format #f "\\repeat ~a ~a ~a ~a"
 695             repeat-type
 696             (ly:music-property expr 'repeat-count)
 697             main
 698             (let ((alternatives (ly:music-property expr 'elements)))
 699               (if (null? alternatives)
 700                   ""
 701                   (format #f "\\alternative { ~{~a ~}}"
 702                           (map-in-order (lambda (music)
 703                                           (music->lily-string music parser))
 704                                         alternatives)))))))
 705
 706 (define-display-method VoltaRepeatedMusic (expr parser)
 707   (repeat->lily-string expr "volta" parser))
 708
 709 (define-display-method UnfoldedRepeatedMusic (expr parser)
 710   (repeat->lily-string expr "unfold" parser))
 711
 712 (define-display-method PercentRepeatedMusic (expr parser)
 713   (repeat->lily-string expr "percent" parser))
 714
 715 (define-display-method TremoloRepeatedMusic (expr parser)
 716   (let* ((main (ly:music-property expr 'element))
 717          (children (if (music-is-of-type? main 'sequential-music)
 718                        ;; \repeat tremolo n { ... }
 719                        (length (extract-named-music main '(EventChord
 720                                                            NoteEvent)))
 721                        ;; \repeat tremolo n c4
 722                        1))
 723          (times (ly:music-property expr 'repeat-count))
 724
 725          ;; # of dots is equal to the 1 in bitwise representation (minus 1)!
 726          (dots (1- (logcount (* times children))))
 727          ;; The remaining missing multiplicator to scale the notes by
 728          ;; times * children
 729          (mult (/ (* times children (ash 1 dots)) (1- (ash 2 dots))))
 730          (shift (- (ly:intlog2 (floor mult)))))
 731     (set! main (ly:music-deep-copy main))
 732     ;; Adjust the time of the notes
 733     (ly:music-compress main (ly:make-moment children 1))
 734     ;; Adjust the displayed note durations
 735     (shift-duration-log main (- shift) (- dots))
 736     (format #f "\\repeat tremolo ~a ~a"
 737             times
 738             (music->lily-string main parser))))
 739
 740 ;;;
 741 ;;; Contexts
 742 ;;;
 743
 744 (define-display-method ContextSpeccedMusic (expr parser)
 745   (let ((id    (ly:music-property expr 'context-id))
 746         (create-new (ly:music-property expr 'create-new))
 747         (music (ly:music-property expr 'element))
 748         (operations (ly:music-property expr 'property-operations))
 749         (ctype (ly:music-property expr 'context-type)))
 750     (format #f "~a ~a~a~a ~a"
 751             (if (and (not (null? create-new)) create-new)
 752                 "\\new"
 753                 "\\context")
 754             ctype
 755             (if (null? id)
 756                 ""
 757                 (format #f " = ~s" id))
 758             (if (null? operations)
 759                 ""
 760                 (format #f " \\with {~{~a~}~%~v_}"
 761                         (parameterize ((*indent* (+ (*indent*) 2)))
 762                           (map (lambda (op)
 763                                  (format #f "~%~v_\\~a ~s"
 764                                          (*indent*)
 765                                          (first op)
 766                                          (second op)))
 767                                operations))
 768                         (*indent*)))
 769             (parameterize ((*current-context* ctype))
 770               (music->lily-string music parser)))))
 771
 772 ;; special cases: \figures \lyrics \drums
 773 (define-extra-display-method ContextSpeccedMusic (expr parser)
 774   (with-music-match (expr (music 'ContextSpeccedMusic
 775                                  create-new #t
 776                                  property-operations ?op
 777                                  context-type ?context-type
 778                                  element ?sequence))
 779     (if (null? ?op)
 780         (parameterize ((*explicit-mode* #f))
 781           (case ?context-type
 782             ((FiguredBass)
 783              (format #f "\\figures ~a" (music->lily-string ?sequence parser)))
 784             ((Lyrics)
 785              (format #f "\\lyrics ~a" (music->lily-string ?sequence parser)))
 786             ((DrumStaff)
 787              (format #f "\\drums ~a" (music->lily-string ?sequence parser)))
 788             (else
 789              #f)))
 790         #f)))
 791
 792 ;;; Context properties
 793
 794 (define-extra-display-method ContextSpeccedMusic (expr parser)
 795   (let ((element (ly:music-property expr 'element))
 796         (property-tuning? (make-music-type-predicate 'PropertySet
 797                                                      'PropertyUnset
 798                                                      'OverrideProperty
 799                                                      'RevertProperty))
 800         (sequence? (make-music-type-predicate 'SequentialMusic)))
 801     (if (and (ly:music? element)
 802              (or (property-tuning? element)
 803                  (and (sequence? element)
 804                       (every property-tuning? (ly:music-property element 'elements)))))
 805         (parameterize ((*current-context* (ly:music-property expr 'context-type)))
 806           (music->lily-string element parser))
 807         #f)))
 808
 809 (define (property-value->lily-string arg parser)
 810   (cond ((ly:music? arg)
 811          (music->lily-string arg parser))
 812         ((string? arg)
 813          (format #f "#~s" arg))
 814         ((markup? arg)
 815          (markup->lily-string arg))
 816         (else
 817          (format #f "#~a" (scheme-expr->lily-string arg)))))
 818
 819 (define-display-method PropertySet (expr parser)
 820   (let ((property (ly:music-property expr 'symbol))
 821         (value (ly:music-property expr 'value))
 822         (once (ly:music-property expr 'once)))
 823     (format #f "~a\\set ~a~a = ~a~a"
 824             (if (and (not (null? once)))
 825                 "\\once "
 826                 "")
 827             (if (eqv? (*current-context*) 'Bottom)
 828                 ""
 829                 (format #f "~a . " (*current-context*)))
 830             property
 831             (property-value->lily-string value parser)
 832             (new-line->lily-string))))
 833
 834 (define-display-method PropertyUnset (expr parser)
 835   (format #f "\\unset ~a~a~a"
 836           (if (eqv? (*current-context*) 'Bottom)
 837               ""
 838               (format #f "~a . " (*current-context*)))
 839           (ly:music-property expr 'symbol)
 840           (new-line->lily-string)))
 841
 842 ;;; Layout properties
 843
 844 (define-display-method OverrideProperty (expr parser)
 845   (let* ((symbol          (ly:music-property expr 'symbol))
 846          (properties   (ly:music-property expr 'grob-property-path
 847                                              (list (ly:music-property expr 'grob-property))))
 848          (value   (ly:music-property expr 'grob-value))
 849          (once    (ly:music-property expr 'once)))
 850
 851     (format #f "~a\\override ~{~a~^.~} = ~a~a"
 852             (if (or (null? once)
 853                     (not once))
 854                 ""
 855                 "\\once ")
 856             (if (eqv? (*current-context*) 'Bottom)
 857                 (cons symbol properties)
 858                 (cons* (*current-context*) symbol properties))
 859             (property-value->lily-string value parser)
 860             (new-line->lily-string))))
 861
 862 (define-display-method RevertProperty (expr parser)
 863   (let* ((symbol (ly:music-property expr 'symbol))
 864          (properties (ly:music-property expr 'grob-property-path
 865                                              (list (ly:music-property expr 'grob-property)))))
 866     (format #f "\\revert ~{~a~^.~}~a"
 867             (if (eqv? (*current-context*) 'Bottom)
 868                 (cons symbol properties)
 869                 (cons* (*current-context*) symbol properties))
 870             (new-line->lily-string))))
 871
 872 (define-display-method TimeSignatureMusic (expr parser)
 873   (let* ((num (ly:music-property expr 'numerator))
 874          (den (ly:music-property expr 'denominator))
 875          (structure (ly:music-property expr 'beat-structure)))
 876     (if (null? structure)
 877         (format #f
 878                 "\\time ~a/~a~a"
 879                 num den
 880                 (new-line->lily-string))
 881         (format #f
 882                 "\\time #'~a ~a/~a~a"
 883                 structure num den
 884                 (new-line->lily-string)))))
 885
 886 ;;; \melisma and \melismaEnd
 887 (define-extra-display-method ContextSpeccedMusic (expr parser)
 888   "If expr is a melisma, return \"\\melisma\", otherwise, return #f."
 889   (with-music-match (expr (music 'ContextSpeccedMusic
 890                                  element (music 'PropertySet
 891                                                 value #t
 892                                                 symbol 'melismaBusy)))
 893     "\\melisma"))
 894
 895 (define-extra-display-method ContextSpeccedMusic (expr parser)
 896   "If expr is a melisma end, return \"\\melismaEnd\", otherwise, return #f."
 897   (with-music-match (expr (music 'ContextSpeccedMusic
 898                                  element (music 'PropertyUnset
 899                                                 symbol 'melismaBusy)))
 900     "\\melismaEnd"))
 901
 902 ;;; \tempo
 903 (define-extra-display-method SequentialMusic (expr parser)
 904   (with-music-match (expr (music 'SequentialMusic
 905                                  elements ((music 'TempoChangeEvent
 906                                                   text ?text
 907                                                   tempo-unit ?unit
 908                                                   metronome-count ?count)
 909                                            (music 'ContextSpeccedMusic
 910                                                   element (music 'PropertySet
 911                                                                  symbol 'tempoWholesPerMinute)))))
 912     (format #f "\\tempo ~{~a~a~}~a = ~a~a"
 913             (if (markup? ?text)
 914                 (list (markup->lily-string ?text) " ")
 915                 '())
 916             (duration->lily-string ?unit #:force-duration #t)
 917             (if (pair? ?count)
 918                 (format #f "~a ~~ ~a" (car ?count) (cdr ?count))
 919                 ?count)
 920             (new-line->lily-string))))
 921
 922 (define-display-method TempoChangeEvent (expr parser)
 923   (let ((text (ly:music-property expr 'text)))
 924     (format #f "\\tempo ~a~a"
 925             (markup->lily-string text)
 926             (new-line->lily-string))))
 927
 928 ;;; \clef
 929 (define clef-name-alist #f)
 930 (define-public (memoize-clef-names clefs)
 931   "Initialize @code{clef-name-alist}, if not already set."
 932   (if (not clef-name-alist)
 933       (set! clef-name-alist
 934             (map (lambda (name+vals)
 935                    (cons (cdr name+vals)
 936                          (car name+vals)))
 937                  clefs))))
 938
 939 (define-extra-display-method ContextSpeccedMusic (expr parser)
 940   "If @var{expr} is a clef change, return \"\\clef ...\".
 941 Otherwise, return @code{#f}."
 942   (with-music-match (expr (music 'ContextSpeccedMusic
 943                                  context-type 'Staff
 944                                  element (music 'SequentialMusic
 945                                                 elements ((music 'PropertySet
 946                                                                  value ?clef-glyph
 947                                                                  symbol 'clefGlyph)
 948                                                           (music 'PropertySet
 949                                                                  symbol 'middleCClefPosition)
 950                                                           (music 'PropertySet
 951                                                                  value ?clef-position
 952                                                                  symbol 'clefPosition)
 953                                                           (music 'PropertySet
 954                                                                  value ?clef-octavation
 955                                                                  symbol 'clefOctavation)
 956                                                           (music 'ApplyContext
 957                                                                  procedure ly:set-middle-C!)))))
 958     (let ((clef-name (assoc-get (list ?clef-glyph ?clef-position 0)
 959                                 clef-name-alist)))
 960       (if clef-name
 961           (format #f "\\clef \"~a~{~a~a~}\"~a"
 962                   clef-name
 963                   (cond ((= 0 ?clef-octavation)
 964                          (list "" ""))
 965                         ((> ?clef-octavation 0)
 966                          (list "^" (1+ ?clef-octavation)))
 967                         (else
 968                          (list "_" (- 1 ?clef-octavation))))
 969                   (new-line->lily-string))
 970           #f))))
 971
 972 ;;; \bar
 973 (define-extra-display-method ContextSpeccedMusic (expr parser)
 974   "If `expr' is a bar, return \"\\bar ...\".
 975 Otherwise, return #f."
 976   (with-music-match (expr (music 'ContextSpeccedMusic
 977                                  context-type 'Timing
 978                                  element (music 'PropertySet
 979                                                 value ?bar-type
 980                                                 symbol 'whichBar)))
 981     (format #f "\\bar \"~a\"~a" ?bar-type (new-line->lily-string))))
 982
 983 ;;; \partial
 984 (define-extra-display-method ContextSpeccedMusic (expr parser)
 985   "If `expr' is a partial measure, return \"\\partial ...\".
 986 Otherwise, return #f."
 987   (with-music-match (expr (music
 988                            'ContextSpeccedMusic
 989                            element (music
 990                                     'ContextSpeccedMusic
 991                                     context-type 'Timing
 992                                     element (music
 993                                              'PartialSet
 994                                              partial-duration ?duration))))
 995
 996     (and ?duration
 997          (format #f "\\partial ~a"
 998                  (duration->lily-string ?duration #:force-duration #t)))))
 999
1000 ;;;
1001 ;;;
1002
1003 (define-display-method ApplyOutputEvent (applyoutput parser)
1004   (let ((proc (ly:music-property applyoutput 'procedure))
1005         (ctx  (ly:music-property applyoutput 'context-type)))
1006     (format #f "\\applyOutput #'~a #~a"
1007             ctx
1008             (or (procedure-name proc)
1009                 (with-output-to-string
1010                   (lambda ()
1011                     (pretty-print (procedure-source proc))))))))
1012
1013 (define-display-method ApplyContext (applycontext parser)
1014   (let ((proc (ly:music-property applycontext 'procedure)))
1015     (format #f "\\applyContext #~a"
1016             (or (procedure-name proc)
1017                 (with-output-to-string
1018                   (lambda ()
1019                     (pretty-print (procedure-source proc))))))))
1020
1021 ;;; \partcombine
1022 (define-display-method PartCombineMusic (expr parser)
1023   (format #f "\\partcombine ~{~a ~}"
1024           (map-in-order (lambda (music)
1025                           (music->lily-string music parser))
1026                         (ly:music-property expr 'elements))))
1027
1028 (define-extra-display-method PartCombineMusic (expr parser)
1029   (with-music-match (expr (music 'PartCombineMusic
1030                                  elements ((music 'UnrelativableMusic
1031                                                   element (music 'ContextSpeccedMusic
1032                                                                  context-id "one"
1033                                                                  context-type 'Voice
1034                                                                  element ?sequence1))
1035                                            (music 'UnrelativableMusic
1036                                                   element (music 'ContextSpeccedMusic
1037                                                                  context-id "two"
1038                                                                  context-type 'Voice
1039                                                                  element ?sequence2)))))
1040     (format #f "\\partcombine ~a~a~a"
1041             (music->lily-string ?sequence1 parser)
1042             (new-line->lily-string)
1043             (music->lily-string ?sequence2 parser))))
1044
1045 (define-display-method UnrelativableMusic (expr parser)
1046   (music->lily-string (ly:music-property expr 'element) parser))
1047
1048 ;;; Cue notes
1049 (define-display-method QuoteMusic (expr parser)
1050   (or (with-music-match (expr (music
1051                                'QuoteMusic
1052                                quoted-voice-direction ?quoted-voice-direction
1053                                quoted-music-name ?quoted-music-name
1054                                quoted-context-id "cue"
1055                                quoted-context-type 'Voice
1056                                element ?music))
1057         (format #f "\\cueDuring #~s #~a ~a"
1058                 ?quoted-music-name
1059                 ?quoted-voice-direction
1060                 (music->lily-string ?music parser)))
1061       (format #f "\\quoteDuring #~s ~a"
1062               (ly:music-property expr 'quoted-music-name)
1063               (music->lily-string (ly:music-property expr 'element) parser))))
1064
1065 ;;;
1066 ;;; Breaks
1067 ;;;
1068 (define-display-method LineBreakEvent (expr parser)
1069   (if (null? (ly:music-property expr 'break-permission))
1070       "\\noBreak"
1071       "\\break"))
1072
1073 (define-display-method PageBreakEvent (expr parser)
1074   (if (null? (ly:music-property expr 'break-permission))
1075       "\\noPageBreak"
1076       "\\pageBreak"))
1077
1078 (define-display-method PageTurnEvent (expr parser)
1079   (if (null? (ly:music-property expr 'break-permission))
1080       "\\noPageTurn"
1081       "\\pageTurn"))
1082
1083 (define-extra-display-method EventChord (expr parser)
1084   (with-music-match (expr (music 'EventChord
1085                             elements ((music 'LineBreakEvent
1086                                              break-permission 'force)
1087                                       (music 'PageBreakEvent
1088                                              break-permission 'force))))
1089     "\\pageBreak"))
1090
1091 (define-extra-display-method EventChord (expr parser)
1092   (with-music-match (expr (music 'EventChord
1093                             elements ((music 'LineBreakEvent
1094                                              break-permission 'force)
1095                                       (music 'PageBreakEvent
1096                                              break-permission 'force)
1097                                       (music 'PageTurnEvent
1098                                              break-permission 'force))))
1099     "\\pageTurn"))
1100
1101 ;;;
1102 ;;; Lyrics
1103 ;;;
1104
1105 ;;; \lyricsto
1106 (define-display-method LyricCombineMusic (expr parser)
1107   (format #f "\\lyricsto ~s ~a"
1108           (ly:music-property expr 'associated-context)
1109           (parameterize ((*explicit-mode* #f))
1110             (music->lily-string (ly:music-property expr 'element) parser))))
1111
1112 ;; \addlyrics
1113 (define-extra-display-method SimultaneousMusic (expr parser)
1114   (with-music-match (expr (music 'SimultaneousMusic
1115                                  elements ((music 'ContextSpeccedMusic
1116                                                   context-id ?id
1117                                                   context-type 'Voice
1118                                                   element ?note-sequence)
1119                                            (music 'ContextSpeccedMusic
1120                                                   context-type 'Lyrics
1121                                                   create-new #t
1122                                                   element (music 'LyricCombineMusic
1123                                                                  associated-context ?associated-id
1124                                                                  element ?lyric-sequence)))))
1125     (if (string=? ?id ?associated-id)
1126         (format #f "~a~a \\addlyrics ~a"
1127                 (music->lily-string ?note-sequence parser)
1128                 (new-line->lily-string)
1129                 (parameterize ((*explicit-mode* #f))
1130                   (music->lily-string ?lyric-sequence parser)))
1131         #f)))
1132
1133 ;; Silence internal event sent at end of each lyrics block
1134 (define-display-method CompletizeExtenderEvent (expr parser)
1135   "")