scm/output-lib.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
   4 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  21 ;; general
  22
  23 (define-public (grob::has-interface grob iface)
  24   (memq iface (ly:grob-interfaces grob)))
  25
  26 (define-public (grob::is-live? grob)
  27   (pair? (ly:grob-basic-properties grob)))
  28
  29 (define-public (grob::x-parent-width grob)
  30   (ly:grob-property (ly:grob-parent grob X) 'X-extent))
  31
  32 (define-public (make-stencil-boxer thickness padding callback)
  33   "Return function that adds a box around the grob passed as argument."
  34   (lambda (grob)
  35     (box-stencil (callback grob) thickness padding)))
  36
  37 (define-public (make-stencil-circler thickness padding callback)
  38   "Return function that adds a circle around the grob passed as argument."
  39   (lambda (grob)
  40     (circle-stencil (callback grob) thickness padding)))
  41
  42 (define-public (print-circled-text-callback grob)
  43   (grob-interpret-markup grob (make-circle-markup
  44                                (ly:grob-property grob 'text))))
  45
  46 (define-public (event-cause grob)
  47   (let ((cause (ly:grob-property  grob 'cause)))
  48
  49     (cond
  50      ((ly:stream-event? cause) cause)
  51      ((ly:grob? cause) (event-cause cause))
  52      (else #f))))
  53
  54 (define-public (grob-interpret-markup grob text)
  55   (let* ((layout (ly:grob-layout grob))
  56          (defs (ly:output-def-lookup layout 'text-font-defaults))
  57          (props (ly:grob-alist-chain grob defs)))
  58
  59     (ly:text-interface::interpret-markup layout props text)))
  60
  61 (define-public (grob::unpure-Y-extent-from-stencil pure-function)
  62   "The unpure height will come from a stencil whereas the pure
  63    height will come from @code{pure-function}."
  64   (ly:make-unpure-pure-container ly:grob::stencil-height pure-function))
  65
  66 (define-public grob::unpure-horizontal-skylines-from-stencil
  67   (ly:make-unpure-pure-container
  68     ly:grob::horizontal-skylines-from-stencil
  69     ly:grob::pure-simple-horizontal-skylines-from-extents))
  70
  71 (define-public grob::always-horizontal-skylines-from-stencil
  72   (ly:make-unpure-pure-container
  73     ly:grob::horizontal-skylines-from-stencil))
  74
  75 (define-public grob::unpure-vertical-skylines-from-stencil
  76   (ly:make-unpure-pure-container
  77     ly:grob::vertical-skylines-from-stencil
  78     ly:grob::pure-simple-vertical-skylines-from-extents))
  79
  80 (define-public grob::always-vertical-skylines-from-stencil
  81   (ly:make-unpure-pure-container
  82     ly:grob::vertical-skylines-from-stencil))
  83
  84 (define-public grob::always-vertical-skylines-from-element-stencils
  85   (ly:make-unpure-pure-container
  86     ly:grob::vertical-skylines-from-element-stencils
  87     ly:grob::pure-vertical-skylines-from-element-stencils))
  88
  89 (define-public grob::always-horizontal-skylines-from-element-stencils
  90   (ly:make-unpure-pure-container
  91     ly:grob::horizontal-skylines-from-element-stencils
  92     ly:grob::pure-horizontal-skylines-from-element-stencils))
  93
  94 ;; Using this as a callback for a grob's Y-extent promises
  95 ;; that the grob's stencil does not depend on line-spacing.
  96 ;; We use this promise to figure the space required by Clefs
  97 ;; and such at the note-spacing stage.
  98
  99 (define-public grob::always-Y-extent-from-stencil
 100   (ly:make-unpure-pure-container ly:grob::stencil-height))
 101
 102 (define-public (layout-line-thickness grob)
 103   "Get the line thickness of the @var{grob}'s corresponding layout."
 104   (let* ((layout (ly:grob-layout grob))
 105          (line-thickness (ly:output-def-lookup layout 'line-thickness)))
 106
 107         line-thickness))
 108
 109 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 110 ;; beam slope
 111
 112 ;; even though kievan noteheads do not have stems, their
 113 ;; invisible stems help with beam placement
 114 ;; this assures that invisible stems for kievan notes are aligned
 115 ;; to the center of kievan noteheads. that is thus where the beams'
 116 ;; x extrema will fall
 117 (define-public (stem::kievan-offset-callback grob)
 118   (let* ((note-heads (ly:grob-object grob 'note-heads))
 119          (note-heads-grobs (if (not (null? note-heads))
 120                                (ly:grob-array->list note-heads)
 121                                '()))
 122          (first-note-head (if (not (null? note-heads-grobs))
 123                               (car note-heads-grobs)
 124                               '()))
 125          (note-head-w (if (not (null? first-note-head))
 126                           (ly:grob-extent first-note-head first-note-head X)
 127                           '(0 . 0))))
 128     (interval-center note-head-w)))
 129
 130
 131 ;; sets position of beams for Kievan notation
 132 (define-public (beam::get-kievan-positions grob)
 133   (let* ((stems (ly:grob-object grob 'stems))
 134          (stems-grobs (if (not (null? stems))
 135                           (ly:grob-array->list stems)
 136                           '()))
 137          (first-stem (if (not (null? stems-grobs))
 138                          (car stems-grobs)
 139                          '()))
 140          (note-heads (if (not (null? first-stem))
 141                          (ly:grob-object first-stem 'note-heads)
 142                          '()))
 143          (note-heads-grobs (if (not (null? note-heads))
 144                                (ly:grob-array->list note-heads)
 145                                '()))
 146          (first-note-head (if (not (null? note-heads-grobs))
 147                               (car note-heads-grobs)
 148                               '()))
 149          (next-stem (if (not (null? stems))
 150                         (cadr stems-grobs)
 151                         '()))
 152          (next-note-heads (if (not (null? next-stem))
 153                               (ly:grob-object next-stem 'note-heads)
 154                               '()))
 155          (next-note-heads-grobs (if (not (null? next-note-heads))
 156                                     (ly:grob-array->list next-note-heads)
 157                                     '()))
 158          (next-note-head (if (not (null? next-note-heads-grobs))
 159                              (car next-note-heads-grobs)
 160                              '()))
 161          (left-pos (ly:grob-property first-note-head 'Y-offset))
 162          (right-pos (ly:grob-property next-note-head 'Y-offset))
 163          (direction (ly:grob-property grob 'direction))
 164          (first-nh-height (ly:grob::stencil-height first-note-head))
 165          (next-nh-height (ly:grob::stencil-height next-note-head))
 166          (left-height (if (= direction DOWN)
 167                           (+ (car first-nh-height) 0.75)
 168                           (- (cdr first-nh-height) 0.75)))
 169          (right-height (if (= direction DOWN)
 170                            (+ (car next-nh-height) 0.75)
 171                            (- (cdr next-nh-height) 0.75))))
 172     (cons (+ left-pos left-height) (+ right-pos right-height))))
 173
 174 (define-public (beam::get-kievan-quantized-positions grob)
 175   (let* ((pos (ly:grob-property grob 'positions))
 176          (stems (ly:grob-object grob 'stems))
 177          (stems-grobs (if (not (null? stems))
 178                           (ly:grob-array->list stems)
 179                           '())))
 180     (for-each
 181       (lambda (g)
 182         (ly:grob-set-property! g 'stem-begin-position 0)
 183         (ly:grob-set-property! g 'length 0))
 184       stems-grobs)
 185     pos))
 186
 187 ;; calculates each slope of a broken beam individually
 188 (define-public (beam::place-broken-parts-individually grob)
 189   (ly:beam::quanting grob '(+inf.0 . -inf.0) #f))
 190
 191 ;; calculates the slope of a beam as a single unit,
 192 ;; even if it is broken.  this assures that the beam
 193 ;; will pick up where it left off after a line break
 194 (define-public (beam::align-with-broken-parts grob)
 195   (ly:beam::quanting grob '(+inf.0 . -inf.0) #t))
 196
 197 ;; uses the broken beam style from edition peters combines the
 198 ;; values of place-broken-parts-individually and align-with-broken-parts above,
 199 ;; favoring place-broken-parts-individually when the beam naturally has a steeper
 200 ;; incline and align-with-broken-parts when the beam is flat
 201 (define-public (beam::slope-like-broken-parts grob)
 202   (define (slope y x)
 203     (/ (- (cdr y) (car y)) (- (cdr x) (car x))))
 204   (let* ((quant1 (ly:beam::quanting grob '(+inf.0 . -inf.0) #t))
 205          (original (ly:grob-original grob))
 206          (siblings (if (ly:grob? original)
 207                        (ly:spanner-broken-into original)
 208                        '())))
 209     (if (null? siblings)
 210         quant1
 211         (let* ((quant2 (ly:beam::quanting grob '(+inf.0 . -inf.0) #f))
 212                (x-span (ly:grob-property grob 'X-positions))
 213                (slope1 (slope quant1 x-span))
 214                (slope2 (slope quant2 x-span))
 215                (quant2 (if (not (= (sign slope1) (sign slope2)))
 216                            '(0 . 0)
 217                            quant2))
 218                (factor (/ (atan (abs slope1)) PI-OVER-TWO))
 219                (base (cons-map
 220                        (lambda (x)
 221                          (+ (* (x quant1) (- 1 factor))
 222                             (* (x quant2) factor)))
 223                        (cons car cdr))))
 224           (ly:beam::quanting grob base #f)))))
 225
 226 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 227 ;; cross-staff stuff
 228
 229 (define-public (script-or-side-position-cross-staff g)
 230   (or
 231    (ly:script-interface::calc-cross-staff g)
 232    (ly:side-position-interface::calc-cross-staff g)))
 233
 234
 235 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 236 ;; side-position stuff
 237
 238 (define-public (only-if-beamed g)
 239   (any (lambda (x) (ly:grob? (ly:grob-object x 'beam)))
 240        (ly:grob-array->list (ly:grob-object g 'side-support-elements))))
 241
 242 (define-public side-position-interface::y-aligned-side
 243   (ly:make-unpure-pure-container
 244     ly:side-position-interface::y-aligned-side
 245     ly:side-position-interface::pure-y-aligned-side))
 246
 247 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 248 ;; self-alignment stuff
 249
 250 (define-public self-alignment-interface::y-aligned-on-self
 251   (ly:make-unpure-pure-container
 252     ly:self-alignment-interface::y-aligned-on-self
 253     ly:self-alignment-interface::pure-y-aligned-on-self))
 254
 255 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 256 ;; staff symbol
 257
 258 (define staff-symbol-referencer::callback
 259   (ly:make-unpure-pure-container ly:staff-symbol-referencer::callback))
 260
 261 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 262 ;; note heads
 263
 264 (define-public (stem::calc-duration-log grob)
 265   (ly:duration-log
 266    (ly:event-property (event-cause grob) 'duration)))
 267
 268 (define (stem-stub::do-calculations grob)
 269   (and (ly:grob-property (ly:grob-parent grob X) 'cross-staff)
 270        (not (ly:grob-property (ly:grob-parent grob X) 'transparent))))
 271
 272 (define-public (stem-stub::pure-height grob beg end)
 273   (if (stem-stub::do-calculations grob)
 274       '(0 . 0)
 275       '(+inf.0 . -inf.0)))
 276
 277 (define-public (stem-stub::width grob)
 278   (if (stem-stub::do-calculations grob)
 279       (grob::x-parent-width grob)
 280       '(+inf.0 . -inf.0)))
 281
 282 (define-public (stem-stub::extra-spacing-height grob)
 283   (if (stem-stub::do-calculations grob)
 284       (let* ((dad (ly:grob-parent grob X))
 285              (refp (ly:grob-common-refpoint grob dad Y))
 286              (stem_ph (ly:grob-pure-height dad refp 0 INFINITY-INT))
 287              (my_ph (ly:grob-pure-height grob refp 0 INFINITY-INT))
 288              ;; only account for distance if stem is on different staff than stub
 289              (dist (if (grob::has-interface refp 'hara-kiri-group-spanner-interface)
 290                        0
 291                        (- (car my_ph) (car stem_ph)))))
 292         (if (interval-empty? (interval-intersection stem_ph my_ph)) #f (coord-translate stem_ph dist)))
 293       #f))
 294
 295 (define-public (note-head::calc-kievan-duration-log grob)
 296   (min 3
 297        (ly:duration-log
 298          (ly:event-property (event-cause grob) 'duration))))
 299
 300 (define-public (note-head::calc-duration-log grob)
 301   (min 2
 302        (ly:duration-log
 303          (ly:event-property (event-cause grob) 'duration))))
 304
 305 (define-public (dots::calc-dot-count grob)
 306   (ly:duration-dot-count
 307    (ly:event-property (event-cause grob) 'duration)))
 308
 309 (define-public (dots::calc-staff-position grob)
 310   (let* ((head (ly:grob-parent grob Y))
 311          (log (ly:grob-property head 'duration-log)))
 312
 313     (cond
 314      ((or (not (grob::has-interface head 'rest-interface))
 315           (not (integer? log))) 0)
 316      ((= log 7) 4)
 317      ((> log 4) 3)
 318      ((= log 0) -1)
 319      ((= log 1) 1)
 320      ((= log -1) 1)
 321      (else 0))))
 322
 323 ;; Kept separate from note-head::calc-glyph-name to allow use by
 324 ;; markup commands \note and \note-by-number
 325 (define-public (select-head-glyph style log)
 326   "Select a note head glyph string based on note head style @var{style}
 327 and duration-log @var{log}."
 328   (case style
 329     ;; "default" style is directly handled in note-head.cc as a
 330     ;; special case (HW says, mainly for performance reasons).
 331     ;; Therefore, style "default" does not appear in this case
 332     ;; statement.  -- jr
 333     ((xcircle) "2xcircle")
 334     ((harmonic) "0harmonic")
 335     ((harmonic-black) "2harmonic")
 336     ((harmonic-mixed) (if (<= log 1) "0harmonic"
 337                           "2harmonic"))
 338     ((baroque)
 339      ;; Oops, I actually would not call this "baroque", but, for
 340      ;; backwards compatibility to 1.4, this is supposed to take
 341      ;; brevis, longa and maxima from the neo-mensural font and all
 342      ;; other note heads from the default font.  -- jr
 343      (if (< log 0)
 344          (string-append (number->string log) "neomensural")
 345          (number->string log)))
 346     ((altdefault)
 347      ;; Like default, but brevis is drawn with double vertical lines
 348      (if (= log -1)
 349          (string-append (number->string log) "double")
 350          (number->string log)))
 351     ((mensural)
 352      (string-append (number->string log) (symbol->string style)))
 353     ((petrucci)
 354      (if (< log 0)
 355          (string-append (number->string log) "mensural")
 356          (string-append (number->string log) (symbol->string style))))
 357     ((blackpetrucci)
 358      (if (< log 0)
 359          (string-append (number->string log) "blackmensural")
 360          (string-append (number->string log) (symbol->string style))))
 361     ((semipetrucci)
 362      (if (< log 0)
 363          (string-append (number->string log) "semimensural")
 364          (string-append (number->string log) "petrucci")))
 365     ((neomensural)
 366      (string-append (number->string log) (symbol->string style)))
 367     ((kievan)
 368      (string-append (number->string log) "kievan"))
 369     (else
 370      (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
 371          (symbol->string style)
 372          (string-append (number->string (max 0 log))
 373                         (symbol->string style))))))
 374
 375 (define-public (note-head::calc-glyph-name grob)
 376   (let* ((style (ly:grob-property grob 'style))
 377          (log (if (string-match "kievan*" (symbol->string style))
 378                   (min 3 (ly:grob-property grob 'duration-log))
 379                   (min 2 (ly:grob-property grob 'duration-log)))))
 380     (select-head-glyph style log)))
 381
 382 (define-public (note-head::brew-ez-stencil grob)
 383   (let* ((log (ly:grob-property grob 'duration-log))
 384          (pitch (ly:event-property (event-cause grob) 'pitch))
 385          (pitch-index (ly:pitch-notename pitch))
 386          (note-names (ly:grob-property grob 'note-names))
 387          (pitch-string (if (and (vector? note-names)
 388                                 (> (vector-length note-names) pitch-index))
 389                            (vector-ref note-names pitch-index)
 390                            (string
 391                             (integer->char
 392                              (+ (modulo (+ pitch-index 2) 7)
 393                                 (char->integer #\A))))))
 394          (staff-space (ly:staff-symbol-staff-space grob))
 395          (line-thickness (ly:staff-symbol-line-thickness grob))
 396          (stem (ly:grob-object grob 'stem))
 397          (stem-thickness (* (if (ly:grob? stem)
 398                                 (ly:grob-property stem 'thickness)
 399                                 1.3)
 400                             line-thickness))
 401          (radius (/ (+ staff-space line-thickness) 2))
 402          (letter (markup #:center-align #:vcenter pitch-string))
 403          (filled-circle (markup #:draw-circle radius 0 #t)))
 404
 405     (ly:stencil-translate-axis
 406      (grob-interpret-markup
 407       grob
 408       (if (>= log 2)
 409           (make-combine-markup
 410            filled-circle
 411            (make-with-color-markup white letter))
 412           (make-combine-markup
 413            (make-combine-markup
 414             filled-circle
 415             (make-with-color-markup white (make-draw-circle-markup
 416                                            (- radius stem-thickness) 0 #t)))
 417            letter)))
 418      radius X)))
 419
 420 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 421 ;; clipping
 422
 423 (define-public (make-rhythmic-location bar-num num den)
 424   (cons
 425    bar-num (ly:make-moment num den)))
 426
 427 (define-public (rhythmic-location? a)
 428   (and (pair? a)
 429        (integer? (car a))
 430        (ly:moment? (cdr a))))
 431
 432 (define-public (make-graceless-rhythmic-location loc)
 433   (make-rhythmic-location
 434    (car loc)
 435    (ly:moment-main-numerator (rhythmic-location-measure-position loc))
 436    (ly:moment-main-denominator (rhythmic-location-measure-position loc))))
 437
 438 (define-public rhythmic-location-measure-position cdr)
 439 (define-public rhythmic-location-bar-number car)
 440
 441 (define-public (rhythmic-location<? a b)
 442   (cond
 443    ((< (car a) (car b)) #t)
 444    ((> (car a) (car b)) #f)
 445    (else
 446     (ly:moment<? (cdr a) (cdr b)))))
 447
 448 (define-public (rhythmic-location<=? a b)
 449   (not (rhythmic-location<? b a)))
 450 (define-public (rhythmic-location>=? a b)
 451   (not (rhythmic-location<? a b)))
 452 (define-public (rhythmic-location>? a b)
 453   (rhythmic-location<? b a))
 454
 455 (define-public (rhythmic-location=? a b)
 456   (and (rhythmic-location<=? a b)
 457        (rhythmic-location<=? b a)))
 458
 459 (define-public (rhythmic-location->file-string a)
 460   (ly:format "~a.~a.~a"
 461              (car a)
 462              (ly:moment-main-numerator (cdr a))
 463              (ly:moment-main-denominator (cdr a))))
 464
 465 (define-public (rhythmic-location->string a)
 466   (ly:format "bar ~a ~a"
 467              (car a)
 468              (ly:moment->string (cdr a))))
 469
 470 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 471 ;; break visibility
 472
 473 (define-public all-visible             #(#t #t #t))
 474 (define-public begin-of-line-invisible #(#t #t #f))
 475 (define-public center-invisible        #(#t #f #t))
 476 (define-public end-of-line-invisible   #(#f #t #t))
 477 (define-public begin-of-line-visible   #(#f #f #t))
 478 (define-public center-visible          #(#f #t #f))
 479 (define-public end-of-line-visible     #(#t #f #f))
 480 (define-public all-invisible           #(#f #f #f))
 481
 482 (define-public spanbar-begin-of-line-invisible #(#t #f #f))
 483
 484
 485 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 486 ;; neighbor-interface routines
 487
 488
 489 (define-public (shift-right-at-line-begin g)
 490   "Shift an item to the right, but only at the start of the line."
 491   (if (and (ly:item? g)
 492            (equal? (ly:item-break-dir g) RIGHT))
 493       (ly:grob-translate-axis! g 3.5 X)))
 494
 495 (define-public (pure-from-neighbor-interface::extra-spacing-height-at-beginning-of-line grob)
 496   (if (= 1 (ly:item-break-dir grob))
 497       (pure-from-neighbor-interface::extra-spacing-height grob)
 498       (cons -0.1 0.1)))
 499
 500 (define-public (pure-from-neighbor-interface::extra-spacing-height grob)
 501   (let* ((height (ly:grob-pure-height grob grob 0 INFINITY-INT))
 502          (from-neighbors (interval-union
 503                             height
 504                             (ly:axis-group-interface::pure-height
 505                               grob
 506                               0
 507                               INFINITY-INT))))
 508     (coord-operation - from-neighbors height)))
 509
 510 ;; If there are neighbors, we place the height at their midpoint
 511 ;; to avoid protrusion of this pure height out of the vertical
 512 ;; axis group on either side.  This will minimize the impact of the
 513 ;; grob on pure minimum translations.
 514
 515 ;; TODO - there is a double call to axis-group-interface::pure-height
 516 ;; here and then in the extra-spacing-height function above. Can/should this
 517 ;; be rolled into one?
 518 (define-public (pure-from-neighbor-interface::pure-height grob beg end)
 519   (let* ((height (ly:axis-group-interface::pure-height
 520                   grob
 521                   0
 522                   INFINITY-INT))
 523          (c (interval-center height)))
 524     (if (interval-empty? height) empty-interval (cons c c))))
 525
 526 ;; Minimizes the impact of the height on vertical spacing while allowing
 527 ;; it to appear in horizontal skylines of paper columns if necessary.
 528 (define-public pure-from-neighbor-interface::height-if-pure
 529   (ly:make-unpure-pure-container #f pure-from-neighbor-interface::pure-height))
 530
 531 (define-public (pure-from-neighbor-interface::account-for-span-bar grob)
 532   (let* ((esh (pure-from-neighbor-interface::extra-spacing-height grob))
 533          (hsb (ly:grob-property grob 'has-span-bar))
 534          (ii (interval-intersection esh (cons -1.01 1.01))))
 535     (if (pair? hsb)
 536         (cons (car (if (and (car hsb)
 537                        (ly:grob-property grob 'allow-span-bar))
 538                        esh ii))
 539               (cdr (if (cdr hsb) esh ii)))
 540         ii)))
 541
 542 (define-public (pure-from-neighbor-interface::extra-spacing-height-including-staff grob)
 543   (let ((esh (pure-from-neighbor-interface::extra-spacing-height grob))
 544         (to-staff (coord-operation -
 545                                    (interval-widen
 546                                      '(0 . 0)
 547                                      (ly:staff-symbol-staff-radius grob))
 548                                    (ly:grob::stencil-height grob))))
 549     (interval-union esh to-staff)))
 550
 551
 552 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 553 ;; Tuplets
 554
 555 (define-public (tuplet-number::calc-direction grob)
 556   (ly:tuplet-bracket::calc-direction (ly:grob-object grob 'bracket)))
 557
 558 (define-public (tuplet-number::calc-denominator-text grob)
 559   (number->string (ly:event-property (event-cause grob) 'denominator)))
 560
 561 (define-public (tuplet-number::calc-fraction-text grob)
 562   (let ((ev (event-cause grob)))
 563
 564     (format #f "~a:~a"
 565             (ly:event-property ev 'denominator)
 566             (ly:event-property ev 'numerator))))
 567
 568 ;; a formatter function, which is simply a wrapper around an existing
 569 ;; tuplet formatter function. It takes the value returned by the given
 570 ;; function and appends a note of given length.
 571 (define-public ((tuplet-number::append-note-wrapper function note) grob)
 572   (let ((txt (if function (function grob) #f)))
 573
 574     (if txt
 575         (markup txt #:fontsize -5 #:note note UP)
 576         (markup #:fontsize -5 #:note note UP))))
 577
 578 ;; Print a tuplet denominator with a different number than the one derived from
 579 ;; the actual tuplet fraction
 580 (define-public ((tuplet-number::non-default-tuplet-denominator-text denominator)
 581                 grob)
 582   (number->string (if denominator
 583                       denominator
 584                       (ly:event-property (event-cause grob) 'denominator))))
 585
 586 ;; Print a tuplet fraction with different numbers than the ones derived from
 587 ;; the actual tuplet fraction
 588 (define-public ((tuplet-number::non-default-tuplet-fraction-text
 589                  denominator numerator) grob)
 590   (let* ((ev (event-cause grob))
 591          (den (if denominator denominator (ly:event-property ev 'denominator)))
 592          (num (if numerator numerator (ly:event-property ev 'numerator))))
 593
 594     (format #f "~a:~a" den num)))
 595
 596 ;; Print a tuplet fraction with note durations appended to the numerator and the
 597 ;; denominator
 598 (define-public ((tuplet-number::fraction-with-notes
 599                  denominatornote numeratornote) grob)
 600   (let* ((ev (event-cause grob))
 601          (denominator (ly:event-property ev 'denominator))
 602          (numerator (ly:event-property ev 'numerator)))
 603
 604     ((tuplet-number::non-default-fraction-with-notes
 605       denominator denominatornote numerator numeratornote) grob)))
 606
 607 ;; Print a tuplet fraction with note durations appended to the numerator and the
 608 ;; denominator
 609 (define-public ((tuplet-number::non-default-fraction-with-notes
 610                  denominator denominatornote numerator numeratornote) grob)
 611   (let* ((ev (event-cause grob))
 612          (den (if denominator denominator (ly:event-property ev 'denominator)))
 613          (num (if numerator numerator (ly:event-property ev 'numerator))))
 614
 615     (make-concat-markup (list
 616                          (make-simple-markup (format #f "~a" den))
 617                          (markup #:fontsize -5 #:note denominatornote UP)
 618                          (make-simple-markup " : ")
 619                          (make-simple-markup (format #f "~a" num))
 620                          (markup #:fontsize -5 #:note numeratornote UP)))))
 621
 622
 623 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 624 ;; Color
 625
 626 (define-public (color? x)
 627   (and (list? x)
 628        (= 3 (length x))
 629        (apply eq? #t (map number? x))
 630        (apply eq? #t (map (lambda (y) (<= 0 y 1)) x))))
 631
 632 (define-public (rgb-color r g b) (list r g b))
 633
 634 ; predefined colors
 635 (define-public black       '(0.0 0.0 0.0))
 636 (define-public white       '(1.0 1.0 1.0))
 637 (define-public red         '(1.0 0.0 0.0))
 638 (define-public green       '(0.0 1.0 0.0))
 639 (define-public blue        '(0.0 0.0 1.0))
 640 (define-public cyan        '(0.0 1.0 1.0))
 641 (define-public magenta     '(1.0 0.0 1.0))
 642 (define-public yellow      '(1.0 1.0 0.0))
 643
 644 (define-public grey        '(0.5 0.5 0.5))
 645 (define-public darkred     '(0.5 0.0 0.0))
 646 (define-public darkgreen   '(0.0 0.5 0.0))
 647 (define-public darkblue    '(0.0 0.0 0.5))
 648 (define-public darkcyan    '(0.0 0.5 0.5))
 649 (define-public darkmagenta '(0.5 0.0 0.5))
 650 (define-public darkyellow  '(0.5 0.5 0.0))
 651
 652
 653 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 654 ;; key signature
 655
 656 (define-public (key-signature-interface::alteration-positions
 657                 entry c0-position grob)
 658   (let ((step (car entry))
 659         (alter (cdr entry)))
 660     (if (pair? step)
 661         (list (+ (cdr step) (* (car step) 7) c0-position))
 662         (let* ((c-position (modulo c0-position 7))
 663                (positions
 664                 (if (< alter 0)
 665                     ;; See (flat|sharp)-positions in define-grob-properties.scm
 666                     (ly:grob-property grob 'flat-positions '(3))
 667                     (ly:grob-property grob 'sharp-positions '(3))))
 668                (p (list-ref positions
 669                             (if (< c-position (length positions))
 670                                 c-position 0)))
 671                (max-position (if (pair? p) (cdr p) p))
 672                (min-position (if (pair? p) (car p) (- max-position 6)))
 673                (first-position (+ (modulo (- (+ c-position step)
 674                                              min-position)
 675                                           7)
 676                                   min-position)))
 677           (define (prepend x l) (if (> x max-position)
 678                                     l
 679                                     (prepend (+ x 7) (cons x l))))
 680           (prepend first-position '())))))
 681
 682 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 683 ;; annotations
 684
 685 (define-public (numbered-footnotes int)
 686   (markup #:tiny (number->string (+ 1 int))))
 687
 688 (define-public (symbol-footnotes int)
 689   (define (helper symbols out idx n)
 690     (if (< n 1)
 691         out
 692         (helper symbols
 693                 (string-append out (list-ref symbols idx))
 694                 idx
 695                 (- n 1))))
 696   (markup #:tiny (helper '("*" "†" "‡" "§" "¶")
 697                           ""
 698                           (remainder int 5)
 699                           (+ 1 (quotient int 5)))))
 700
 701 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 702 ;; accidentals
 703
 704 (define-public (accidental-interface::calc-alteration grob)
 705   (ly:pitch-alteration (ly:event-property (event-cause grob) 'pitch)))
 706
 707 (define-public (accidental-interface::glyph-name grob)
 708   (assoc-get (ly:grob-property grob 'alteration)
 709              standard-alteration-glyph-name-alist))
 710
 711 (define-public accidental-interface::height
 712   (ly:make-unpure-pure-container
 713     ly:accidental-interface::height
 714     ly:accidental-interface::pure-height))
 715
 716 (define-public cancellation-glyph-name-alist
 717   '((0 . "accidentals.natural")))
 718
 719 (define-public standard-alteration-glyph-name-alist
 720   '(
 721     ;; ordered for optimal performance.
 722     (0 . "accidentals.natural")
 723     (-1/2 . "accidentals.flat")
 724     (1/2 . "accidentals.sharp")
 725
 726     (1 . "accidentals.doublesharp")
 727     (-1 . "accidentals.flatflat")
 728
 729     (3/4 . "accidentals.sharp.slashslash.stemstemstem")
 730     (1/4 . "accidentals.sharp.slashslash.stem")
 731     (-1/4 . "accidentals.mirroredflat")
 732     (-3/4 . "accidentals.mirroredflat.flat")))
 733
 734 ;; FIXME: standard vs default, alteration-FOO vs FOO-alteration
 735 (define-public alteration-default-glyph-name-alist
 736   standard-alteration-glyph-name-alist)
 737
 738 (define-public makam-alteration-glyph-name-alist
 739   '((1 . "accidentals.doublesharp")
 740     (8/9 . "accidentals.sharp.slashslashslash.stemstem")
 741     (5/9 . "accidentals.sharp.slashslashslash.stem")
 742     (4/9 . "accidentals.sharp")
 743     (1/9 . "accidentals.sharp.slashslash.stem")
 744     (0 . "accidentals.natural")
 745     (-1/9 . "accidentals.mirroredflat")
 746     (-4/9 . "accidentals.flat.slash")
 747     (-5/9 . "accidentals.flat")
 748     (-8/9 . "accidentals.flat.slashslash")
 749     (-1 . "accidentals.flatflat")))
 750
 751 (define-public alteration-hufnagel-glyph-name-alist
 752   '((-1/2 . "accidentals.hufnagelM1")
 753     (0 . "accidentals.vaticana0")
 754     (1/2 . "accidentals.mensural1")))
 755
 756 (define-public alteration-medicaea-glyph-name-alist
 757   '((-1/2 . "accidentals.medicaeaM1")
 758     (0 . "accidentals.vaticana0")
 759     (1/2 . "accidentals.mensural1")))
 760
 761 (define-public alteration-vaticana-glyph-name-alist
 762   '((-1/2 . "accidentals.vaticanaM1")
 763     (0 . "accidentals.vaticana0")
 764     (1/2 . "accidentals.mensural1")))
 765
 766 (define-public alteration-mensural-glyph-name-alist
 767   '((-1/2 . "accidentals.mensuralM1")
 768     (0 . "accidentals.vaticana0")
 769     (1/2 . "accidentals.mensural1")))
 770
 771 (define-public alteration-kievan-glyph-name-alist
 772  '((-1/2 . "accidentals.kievanM1")
 773    (1/2 . "accidentals.kievan1")))
 774
 775 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 776 ;; * Pitch Trill Heads
 777 ;; * Parentheses
 778
 779 (define-public (parentheses-item::calc-parenthesis-stencils grob)
 780   (let* ((font (ly:grob-default-font grob))
 781          (lp (ly:font-get-glyph font "accidentals.leftparen"))
 782          (rp (ly:font-get-glyph font "accidentals.rightparen")))
 783
 784     (list lp rp)))
 785
 786 (define-public (parentheses-item::calc-angled-bracket-stencils grob)
 787   (let* ((parent (ly:grob-parent grob Y))
 788          (y-extent (ly:grob-extent parent parent Y))
 789          (half-thickness 0.05) ; should it be a property?
 790          (width 0.5) ; should it be a property?
 791          (angularity 1.5)  ; makes angle brackets
 792          (white-padding 0.1) ; should it be a property?
 793          (lp (ly:stencil-aligned-to
 794                  (ly:stencil-aligned-to
 795                    (make-parenthesis-stencil y-extent
 796                                              half-thickness
 797                                              (- width)
 798                                              angularity)
 799                    Y CENTER)
 800                  X RIGHT))
 801          (lp-x-extent
 802            (interval-widen (ly:stencil-extent lp X) white-padding))
 803          (rp (ly:stencil-aligned-to
 804                  (ly:stencil-aligned-to
 805                    (make-parenthesis-stencil y-extent
 806                                              half-thickness
 807                                              width
 808                                              angularity)
 809                    Y CENTER)
 810                  X LEFT))
 811           (rp-x-extent
 812             (interval-widen (ly:stencil-extent rp X) white-padding)))
 813     (set! lp (ly:make-stencil (ly:stencil-expr lp)
 814                               lp-x-extent
 815                               (ly:stencil-extent lp Y)))
 816     (set! rp (ly:make-stencil (ly:stencil-expr rp)
 817                               rp-x-extent
 818                               (ly:stencil-extent rp Y)))
 819     (list (stencil-whiteout lp)
 820           (stencil-whiteout rp))))
 821
 822 (define (parenthesize-elements grob . rest)
 823   (let* ((refp (if (null? rest)
 824                    grob
 825                    (car rest)))
 826          (elts (ly:grob-object grob 'elements))
 827          (x-ext (ly:relative-group-extent elts refp X))
 828          (stencils (ly:grob-property grob 'stencils))
 829          (lp (car stencils))
 830          (rp (cadr stencils))
 831          (padding (ly:grob-property grob 'padding 0.1)))
 832
 833     (ly:stencil-add
 834      (ly:stencil-translate-axis lp (- (car x-ext) padding) X)
 835      (ly:stencil-translate-axis rp (+ (cdr x-ext) padding) X))))
 836
 837
 838 (define-public (parentheses-item::print me)
 839   (let* ((elts (ly:grob-object me 'elements))
 840          (y-ref (ly:grob-common-refpoint-of-array me elts Y))
 841          (x-ref (ly:grob-common-refpoint-of-array me elts X))
 842          (stencil (parenthesize-elements me x-ref))
 843          (elt-y-ext (ly:relative-group-extent elts y-ref Y))
 844          (y-center (interval-center elt-y-ext)))
 845
 846     (ly:stencil-translate
 847      stencil
 848      (cons
 849       (- (ly:grob-relative-coordinate me x-ref X))
 850       (- y-center (ly:grob-relative-coordinate me y-ref Y))))))
 851
 852
 853 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 854 ;; offset callbacks
 855
 856 (define-public (pure-chain-offset-callback grob start end prev-offset)
 857   "Sometimes, a chained offset callback is unpure and there is
 858    no way to write a pure function that estimates its behavior.
 859    In this case, we use a pure equivalent that will simply pass
 860    the previous calculated offset value."
 861   prev-offset)
 862
 863 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 864 ;;
 865
 866 (define-public (chain-grob-member-functions grob value . funcs)
 867   (for-each
 868    (lambda (func)
 869      (set! value (func grob value)))
 870    funcs)
 871
 872   value)
 873
 874
 875 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 876 ;; falls/doits
 877
 878 (define-public (bend::print spanner)
 879   (define (close  a b)
 880     (< (abs (- a b)) 0.01))
 881
 882   (let* ((delta-y (* 0.5 (ly:grob-property spanner 'delta-position)))
 883          (left-span (ly:spanner-bound spanner LEFT))
 884          (dots (if (and (grob::has-interface left-span 'note-head-interface)
 885                         (ly:grob? (ly:grob-object left-span 'dot)))
 886                    (ly:grob-object left-span 'dot) #f))
 887
 888          (right-span (ly:spanner-bound spanner RIGHT))
 889          (thickness (* (ly:grob-property spanner 'thickness)
 890                        (ly:output-def-lookup (ly:grob-layout spanner)
 891                                              'line-thickness)))
 892          (padding (ly:grob-property spanner 'padding 0.5))
 893          (common (ly:grob-common-refpoint right-span
 894                                           (ly:grob-common-refpoint spanner
 895                                                                    left-span X)
 896                                           X))
 897          (common-y (ly:grob-common-refpoint spanner left-span Y))
 898          (minimum-length (ly:grob-property spanner 'minimum-length 0.5))
 899
 900          (left-x (+ padding
 901                     (max
 902                      (interval-end (ly:grob-robust-relative-extent
 903                                     left-span common X))
 904                      (if
 905                       (and dots
 906                            (close
 907                             (ly:grob-relative-coordinate dots common-y Y)
 908                             (ly:grob-relative-coordinate spanner common-y Y)))
 909                       (interval-end
 910                        (ly:grob-robust-relative-extent dots common X))
 911                       (- INFINITY-INT)))))
 912          (right-x (max (- (interval-start
 913                            (ly:grob-robust-relative-extent right-span common X))
 914                           padding)
 915                        (+ left-x minimum-length)))
 916          (self-x (ly:grob-relative-coordinate spanner common X))
 917          (dx (- right-x left-x))
 918          (exp (list 'path thickness
 919                     `(quote
 920                       (rmoveto
 921                        ,(- left-x self-x) 0
 922
 923                        rcurveto
 924                        ,(/ dx 3)
 925                        0
 926                        ,dx ,(* 0.66 delta-y)
 927                        ,dx ,delta-y)))))
 928
 929     (ly:make-stencil
 930      exp
 931      (cons (- left-x self-x) (- right-x self-x))
 932      (cons (min 0 delta-y)
 933            (max 0 delta-y)))))
 934
 935
 936 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 937 ;; grace spacing
 938
 939 (define-public (grace-spacing::calc-shortest-duration grob)
 940   (let* ((cols (ly:grob-object grob 'columns))
 941          (get-difference
 942           (lambda (idx)
 943             (ly:moment-sub (ly:grob-property
 944                             (ly:grob-array-ref cols (1+ idx)) 'when)
 945                            (ly:grob-property
 946                             (ly:grob-array-ref cols idx) 'when))))
 947
 948          (moment-min (lambda (x y)
 949                        (cond
 950                         ((and x y)
 951                          (if (ly:moment<? x y)
 952                              x
 953                              y))
 954                         (x x)
 955                         (y y)))))
 956
 957     (fold moment-min #f (map get-difference
 958                              (iota (1- (ly:grob-array-length cols)))))))
 959
 960
 961 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 962 ;; fingering
 963
 964 (define-public (fingering::calc-text grob)
 965   (let ((event (event-cause grob)))
 966     (or (ly:event-property event 'text #f)
 967         (number->string (ly:event-property event 'digit) 10))))
 968
 969 (define-public (string-number::calc-text grob)
 970   (let ((event (event-cause grob)))
 971     (or (ly:event-property event 'text #f)
 972         (number->string (ly:event-property event 'string-number) 10))))
 973
 974 (define-public (stroke-finger::calc-text grob)
 975   (let ((event (event-cause grob)))
 976     (or (ly:event-property event 'text #f)
 977         (vector-ref (ly:grob-property grob 'digit-names)
 978                     (1- (max 1
 979                              (min 5 (ly:event-property event 'digit))))))))
 980
 981
 982 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 983 ;; dynamics
 984
 985 (define-public (hairpin::calc-grow-direction grob)
 986   (if (ly:in-event-class? (event-cause grob) 'decrescendo-event)
 987       START
 988       STOP))
 989
 990 (define-public (dynamic-text-spanner::before-line-breaking grob)
 991   "Monitor left bound of @code{DynamicTextSpanner} for absolute dynamics.
 992 If found, ensure @code{DynamicText} does not collide with spanner text by
 993 changing @code{'attach-dir} and @code{'padding}.  Reads the
 994 @code{'right-padding} property of @code{DynamicText} to fine tune space
 995 between the two text elements."
 996   (let ((left-bound (ly:spanner-bound grob LEFT)))
 997     (if (grob::has-interface left-bound 'dynamic-text-interface)
 998         (let* ((details (ly:grob-property grob 'bound-details))
 999                (left-details (ly:assoc-get 'left details))
1000                (my-padding (ly:assoc-get 'padding left-details))
1001                (script-padding (ly:grob-property left-bound 'right-padding 0)))
1002
1003           (and (number? my-padding)
1004                (ly:grob-set-nested-property! grob
1005                                              '(bound-details left attach-dir)
1006                                              RIGHT)
1007                (ly:grob-set-nested-property! grob
1008                                              '(bound-details left padding)
1009                                              (+ my-padding script-padding)))))))
1010
1011 (define-public ((elbowed-hairpin coords mirrored?) grob)
1012   "Create hairpin based on a list of @var{coords} in @code{(cons x y)}
1013 form.  @code{x} is the portion of the width consumed for a given line
1014 and @code{y} is the portion of the height.  For example,
1015 @code{'((0.3 . 0.7) (0.8 . 0.9) (1.0 . 1.0))} means that at the point
1016 where the hairpin has consumed 30% of its width, it must
1017 be at 70% of its height.  Once it is to 80% width, it
1018 must be at 90% height.  It finishes at
1019 100% width and 100% height.  @var{mirrored?} indicates if the hairpin
1020 is mirrored over the Y-axis or if just the upper part is drawn.
1021 Returns a function that accepts a hairpin grob as an argument
1022 and draws the stencil based on its coordinates.
1023 @lilypond[verbatim,quote]
1024 #(define simple-hairpin
1025   (elbowed-hairpin '((1.0 . 1.0)) #t))
1026
1027 \\relative c' {
1028   \\override Hairpin #'stencil = #simple-hairpin
1029   a\\p\\< a a a\\f
1030 }
1031 @end lilypond
1032 "
1033   (define (pair-to-list pair)
1034     (list (car pair) (cdr pair)))
1035   (define (normalize-coords goods x y)
1036     (map
1037       (lambda (coord)
1038         (cons (* x (car coord)) (* y (cdr coord))))
1039       goods))
1040   (define (my-c-p-s points thick decresc?)
1041     (make-connected-path-stencil
1042       points
1043       thick
1044       (if decresc? -1.0 1.0)
1045       1.0
1046       #f
1047       #f))
1048   ; outer let to trigger suicide
1049   (let ((sten (ly:hairpin::print grob)))
1050     (if (grob::is-live? grob)
1051       (let* ((decresc? (eq? (ly:grob-property grob 'grow-direction) LEFT))
1052              (thick (ly:grob-property grob 'thickness 0.1))
1053              (thick (* thick (layout-line-thickness grob)))
1054              (xex (ly:stencil-extent sten X))
1055              (lenx (interval-length xex))
1056              (yex (ly:stencil-extent sten Y))
1057              (leny (interval-length yex))
1058              (xtrans (+ (car xex) (if decresc? lenx 0)))
1059              (ytrans (car yex))
1060              (uplist (map pair-to-list
1061                           (normalize-coords coords lenx (/ leny 2))))
1062              (downlist (map pair-to-list
1063                             (normalize-coords coords lenx (/ leny -2)))))
1064       (ly:stencil-translate
1065         (ly:stencil-add
1066           (my-c-p-s uplist thick decresc?)
1067           (if mirrored? (my-c-p-s downlist thick decresc?) empty-stencil))
1068         (cons xtrans ytrans)))
1069       '())))
1070
1071 (define-public flared-hairpin
1072   (elbowed-hairpin '((0.95 . 0.4) (1.0 . 1.0)) #t))
1073
1074 (define-public constante-hairpin
1075   (elbowed-hairpin '((1.0 . 0.0) (1.0 . 1.0)) #f))
1076
1077 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1078 ;; lyrics
1079
1080 (define-public (lyric-text::print grob)
1081   "Allow interpretation of tildes as lyric tieing marks."
1082
1083   (let ((text (ly:grob-property grob 'text)))
1084
1085     (grob-interpret-markup grob (if (string? text)
1086                                     (make-tied-lyric-markup text)
1087                                     text))))
1088
1089 (define-public ((grob::calc-property-by-copy prop) grob)
1090   (ly:event-property (event-cause grob) prop))
1091
1092 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1093 ;; general inheritance
1094
1095 (define-public ((grob::inherit-parent-property axis property . default) grob)
1096   "@var{grob} callback generator for inheriting a @var{property} from
1097 an @var{axis} parent, defaulting to @var{default} if there is no
1098 parent or the parent has no setting."
1099   (let ((parent (ly:grob-parent grob axis)))
1100     (cond
1101      ((ly:grob? parent)
1102       (apply ly:grob-property parent property default))
1103      ((pair? default) (car default))
1104      (else '()))))
1105
1106 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1107 ;; fret boards
1108
1109 (define-public (fret-board::calc-stencil grob)
1110   (grob-interpret-markup
1111    grob
1112    (make-fret-diagram-verbose-markup
1113     (ly:grob-property grob 'dot-placement-list))))
1114
1115
1116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1117 ;; slurs
1118
1119 (define-public slur::height
1120   (ly:make-unpure-pure-container
1121     ly:slur::height
1122     ly:slur::pure-height))
1123
1124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1125 ;; scripts
1126
1127 (define-public (script-interface::calc-x-offset grob)
1128   (ly:grob-property grob 'positioning-done)
1129   (let* ((shift (ly:grob-property grob 'toward-stem-shift 0.0))
1130          (note-head-location
1131           (ly:self-alignment-interface::centered-on-x-parent grob))
1132          (note-head-grob (ly:grob-parent grob X))
1133          (stem-grob (ly:grob-object note-head-grob 'stem)))
1134
1135     (+ note-head-location
1136        ;; If the property 'toward-stem-shift is defined and the script
1137        ;; has the same direction as the stem, move the script accordingly.
1138        ;; Since scripts can also be over skips, we need to check whether
1139        ;; the grob has a stem at all.
1140        (if (ly:grob? stem-grob)
1141            (let ((dir1 (ly:grob-property grob 'direction))
1142                  (dir2 (ly:grob-property stem-grob 'direction)))
1143              (if (equal? dir1 dir2)
1144                  (let* ((common-refp (ly:grob-common-refpoint grob stem-grob X))
1145                         (stem-location
1146                          (ly:grob-relative-coordinate stem-grob common-refp X)))
1147                    (* shift (- stem-location note-head-location)))
1148                  0.0))
1149            0.0))))
1150
1151
1152 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1153 ;; instrument names
1154
1155 (define-public (system-start-text::print grob)
1156   (let* ((left-bound (ly:spanner-bound grob LEFT))
1157          (left-mom (ly:grob-property left-bound 'when))
1158          (name (if (moment<=? left-mom ZERO-MOMENT)
1159                    (ly:grob-property grob 'long-text)
1160                    (ly:grob-property grob 'text))))
1161
1162     (if (and (markup? name)
1163              (!= (ly:item-break-dir left-bound) CENTER))
1164
1165         (grob-interpret-markup grob name)
1166         (ly:grob-suicide! grob))))
1167
1168 (define-public (system-start-text::calc-x-offset grob)
1169   (let* ((left-bound (ly:spanner-bound grob LEFT))
1170          (left-mom (ly:grob-property left-bound 'when))
1171          (layout (ly:grob-layout grob))
1172          (indent (ly:output-def-lookup layout
1173                                        (if (moment<=? left-mom ZERO-MOMENT)
1174                                            'indent
1175                                            'short-indent)
1176                                        0.0))
1177          (system (ly:grob-system grob))
1178          (my-extent (ly:grob-extent grob system X))
1179          (elements (ly:grob-object system 'elements))
1180          (common (ly:grob-common-refpoint-of-array system elements X))
1181          (total-ext empty-interval)
1182          (align-x (ly:grob-property grob 'self-alignment-X 0))
1183          (padding (min 0 (- (interval-length my-extent) indent)))
1184          (right-padding (- padding
1185                            (/ (* padding (1+ align-x)) 2))))
1186
1187     ;; compensate for the variation in delimiter extents by
1188     ;; calculating an X-offset correction based on united extents
1189     ;; of all delimiters in this system
1190     (let unite-delims ((l (ly:grob-array-length elements)))
1191       (if (> l 0)
1192           (let ((elt (ly:grob-array-ref elements (1- l))))
1193
1194             (if (grob::has-interface elt 'system-start-delimiter-interface)
1195                 (let ((dims (ly:grob-extent elt common X)))
1196                   (if (interval-sane? dims)
1197                       (set! total-ext (interval-union total-ext dims)))))
1198             (unite-delims (1- l)))))
1199
1200     (+
1201      (ly:side-position-interface::x-aligned-side grob)
1202      right-padding
1203      (- (interval-length total-ext)))))
1204
1205 (define-public (system-start-text::calc-y-offset grob)
1206
1207   (define (live-elements-list me)
1208     (let ((elements (ly:grob-object me 'elements)))
1209
1210       (filter! grob::is-live?
1211                (ly:grob-array->list elements))))
1212
1213   (let* ((left-bound (ly:spanner-bound grob LEFT))
1214          (live-elts (live-elements-list grob))
1215          (system (ly:grob-system grob))
1216          (extent empty-interval))
1217
1218     (if (and (pair? live-elts)
1219              (interval-sane? (ly:grob-extent grob system Y)))
1220         (let get-extent ((lst live-elts))
1221           (if (pair? lst)
1222               (let ((axis-group (car lst)))
1223
1224                 (if (and (ly:spanner? axis-group)
1225                          (equal? (ly:spanner-bound axis-group LEFT)
1226                                  left-bound))
1227                     (set! extent (add-point extent
1228                                             (ly:grob-relative-coordinate
1229                                              axis-group system Y))))
1230                 (get-extent (cdr lst)))))
1231         ;; no live axis group(s) for this instrument name -> remove from system
1232         (ly:grob-suicide! grob))
1233
1234     (+
1235      (ly:self-alignment-interface::y-aligned-on-self grob)
1236      (interval-center extent))))
1237
1238
1239 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1240 ;; axis group interface
1241
1242 (define-public axis-group-interface::height
1243   (ly:make-unpure-pure-container
1244     ly:axis-group-interface::height
1245     ly:axis-group-interface::pure-height))
1246
1247 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1248 ;; ambitus
1249
1250 (define-public (ambitus::print grob)
1251   (let ((heads (ly:grob-object grob 'note-heads)))
1252
1253     (if (and (ly:grob-array? heads)
1254              (= (ly:grob-array-length heads) 2))
1255         (let* ((common (ly:grob-common-refpoint-of-array grob heads Y))
1256                (head-down (ly:grob-array-ref heads 0))
1257                (head-up (ly:grob-array-ref heads 1))
1258                (gap (ly:grob-property grob 'gap 0.35))
1259                (point-min (+ (interval-end (ly:grob-extent head-down common Y))
1260                              gap))
1261                (point-max (- (interval-start (ly:grob-extent head-up common Y))
1262                              gap)))
1263
1264           (if (< point-min point-max)
1265               (let* ((layout (ly:grob-layout grob))
1266                      (line-thick (ly:output-def-lookup layout 'line-thickness))
1267                      (blot (ly:output-def-lookup layout 'blot-diameter))
1268                      (grob-thick (ly:grob-property grob 'thickness 2))
1269                      (width (* line-thick grob-thick))
1270                      (x-ext (symmetric-interval (/ width 2)))
1271                      (y-ext (cons point-min point-max))
1272                      (line (ly:round-filled-box x-ext y-ext blot))
1273                      (y-coord (ly:grob-relative-coordinate grob common Y)))
1274
1275                 (ly:stencil-translate-axis line (- y-coord) Y))
1276               empty-stencil))
1277         (begin
1278           (ly:grob-suicide! grob)
1279           (list)))))
1280
1281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1282 ;;  laissez-vibrer tie
1283 ;;
1284 ;;  needed so we can make laissez-vibrer a pure print
1285 ;;
1286 (define-public (laissez-vibrer::print grob)
1287  (ly:tie::print grob))
1288
1289 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1290 ;; volta-bracket
1291
1292 (define-public (volta-bracket-interface::pure-height grob start end)
1293   (let ((edge-height (ly:grob-property grob 'edge-height)))
1294     (if (number-pair? edge-height)
1295         (let ((smaller (min (car edge-height) (cdr edge-height)))
1296               (larger (max (car edge-height) (cdr edge-height))))
1297           (interval-union '(0 . 0) (cons smaller larger)))
1298         '(0 . 0))))