]> git.donarmstrong.com Git - lilypond.git/blob - scm/define-markup-commands.scm
9ed4f9cc8301824433a9d39b7be0c59257c490cf
[lilypond.git] / scm / define-markup-commands.scm
1 ;;;; This file is part of LilyPond, the GNU music typesetter.
2 ;;;;
3 ;;;; Copyright (C) 2000--2015  Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
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 ;;; Markup commands and markup-list commands definitions.
21 ;;;
22 ;;; Markup commands which are part of LilyPond, are defined
23 ;;; in the (lily) module, which is the current module in this file,
24 ;;; using the `define-markup-command' macro.
25 ;;;
26 ;;; Usage:
27 ;;;
28 ;;; (define-markup-command (command-name layout props args...)
29 ;;;   args-signature
30 ;;;   [ #:category category ]
31 ;;;   [ #:properties property-bindings ]
32 ;;;   documentation-string
33 ;;;   ..body..)
34 ;;;
35 ;;; with:
36 ;;;   command-name
37 ;;;     the name of the markup command
38 ;;;
39 ;;;   layout and props
40 ;;;     arguments that are automatically passed to the command when it
41 ;;;     is interpreted.
42 ;;;     `layout' is an output def, which properties can be accessed
43 ;;;     using `ly:output-def-lookup'.
44 ;;;     `props' is a list of property settings which can be accessed
45 ;;;     using `chain-assoc-get' (more on that below)
46 ;;;
47 ;;;   args...
48 ;;;     the command arguments.
49 ;;;     There is no limitation on the order of command arguments.
50 ;;;     However, markup functions taking a markup as their last
51 ;;;     argument are somewhat special as you can apply them to a
52 ;;;     markup list, and the result is a markup list where the
53 ;;;     markup function (with the specified leading arguments) has
54 ;;;     been applied to every element of the original markup list.
55 ;;;
56 ;;;     Since replicating the leading arguments for applying a
57 ;;;     markup function to a markup list is cheap mostly for
58 ;;;     Scheme arguments, you avoid performance pitfalls by just
59 ;;;     using Scheme arguments for the leading arguments of markup
60 ;;;     functions that take a markup as their last argument.
61 ;;;
62 ;;;   args-signature
63 ;;;     the arguments signature, i.e., a list of type predicates which
64 ;;;     are used to type check the arguments, and also to define the general
65 ;;;     argument types (markup, markup-list, scheme) that the command is
66 ;;;     expecting.
67 ;;;     For instance, if a command expects a number, then a markup, the
68 ;;;     signature would be: (number? markup?)
69 ;;;
70 ;;;   category
71 ;;;     for documentation purpose, builtin markup commands are grouped by
72 ;;;     category.  This can be any symbol.  When documentation is generated,
73 ;;;     the symbol is converted to a capitalized string, where hyphens are
74 ;;;     replaced by spaces.
75 ;;;
76 ;;;   property-bindings
77 ;;;     this is used both for documentation generation, and to ease
78 ;;;     programming the command itself.  It is list of
79 ;;;        (property-name default-value)
80 ;;;     or (property-name)
81 ;;;     elements.  Each property is looked-up in the `props' argument, and
82 ;;;     the symbol naming the property is bound to its value.
83 ;;;     When the property is not found in `props', then the symbol is bound
84 ;;;     to the given default value.  When no default value is given, #f is
85 ;;;     used instead.
86 ;;;     Thus, using the following property bindings:
87 ;;;       ((thickness 0.1)
88 ;;;        (font-size 0))
89 ;;;     is equivalent to writing:
90 ;;;       (let ((thickness (chain-assoc-get 'thickness props 0.1))
91 ;;;             (font-size (chain-assoc-get 'font-size props 0)))
92 ;;;         ..body..)
93 ;;;     When a command `B' internally calls an other command `A', it may
94 ;;;     desirable to see in `B' documentation all the properties and
95 ;;;     default values used by `A'.  In that case, add `A-markup' to the
96 ;;;     property-bindings of B.  (This is used when generating
97 ;;;     documentation, but won't create bindings.)
98 ;;;
99 ;;;   documentation-string
100 ;;;     the command documentation string (used to generate manuals)
101 ;;;
102 ;;;   body
103 ;;;     the command body.  The function is supposed to return a stencil.
104 ;;;
105 ;;; Each markup command definition shall have a documentation string
106 ;;; with description, syntax and example.
107
108 (use-modules (ice-9 regex))
109
110 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
111 ;; utility functions
112 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
113
114 (define-public empty-stencil (ly:make-stencil '()
115                                               empty-interval empty-interval))
116 (define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
117
118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;; line has to come early since it is often used implicitly from the
120 ;; markup macro since \markup { a b c } -> \markup \line { a b c }
121 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
122
123 (define-markup-command (line layout props args)
124   (markup-list?)
125   #:category align
126   #:properties ((word-space)
127                 (text-direction RIGHT))
128   "Put @var{args} in a horizontal line.  The property @code{word-space}
129 determines the space between markups in @var{args}.
130
131 @lilypond[verbatim,quote]
132 \\markup {
133   \\line {
134     one two three
135   }
136 }
137 @end lilypond"
138   (let ((stencils (interpret-markup-list layout props args)))
139     (if (= text-direction LEFT)
140         (set! stencils (reverse stencils)))
141     (stack-stencil-line word-space stencils)))
142
143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
144 ;; geometric shapes
145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
146
147 (define-markup-command (draw-line layout props dest)
148   (number-pair?)
149   #:category graphic
150   #:properties ((thickness 1))
151   "
152 @cindex drawing lines within text
153
154 A simple line.
155 @lilypond[verbatim,quote]
156 \\markup {
157   \\draw-line #'(4 . 4)
158   \\override #'(thickness . 5)
159   \\draw-line #'(-3 . 0)
160 }
161 @end lilypond"
162   (let ((th (* (ly:output-def-lookup layout 'line-thickness)
163                thickness))
164         (x (car dest))
165         (y (cdr dest)))
166     (make-line-stencil th 0 0 x y)))
167
168 (define-markup-command (draw-dashed-line layout props dest)
169   (number-pair?)
170   #:category graphic
171   #:properties ((thickness 1)
172                 (on 1)
173                 (off 1)
174                 (phase 0)
175                 (full-length #t))
176   "
177 @cindex drawing dashed lines within text
178
179 A dashed line.
180
181 If @code{full-length} is set to #t (default) the dashed-line extends to the
182 whole length given by @var{dest}, without white space at beginning or end.
183 @code{off} will then be altered to fit.
184 To insist on the given (or default) values of @code{on}, @code{off} use
185 @code{\\override #'(full-length . #f)}
186 Manual settings for @code{on},@code{off} and @code{phase} are possible.
187 @lilypond[verbatim,quote]
188 \\markup {
189   \\draw-dashed-line #'(5.1 . 2.3)
190   \\override #'(on . 0.3)
191   \\override #'(off . 0.5)
192   \\draw-dashed-line #'(5.1 . 2.3)
193 }
194 @end lilypond"
195   (let* ((line-thickness (ly:output-def-lookup layout 'line-thickness))
196          ;; Calculate the thickness to be used.
197          (th (* line-thickness thickness))
198          (half-thick (/ th 2))
199          ;; Get the extensions in x- and y-direction.
200          (x (car dest))
201          (y (cdr dest))
202          ;; Calculate the length of the dashed line.
203          (line-length (sqrt (+ (expt x 2) (expt y 2)))))
204
205     (if (and full-length (not (= (+ on off) 0)))
206         (begin
207           ;; Add double-thickness to avoid overlapping.
208           (set! off (+ (* 2 th) off))
209           (let* (;; Make a guess how often the off/on-pair should be printed
210                  ;; after the initial `on´.
211                  ;; Assume a minimum of 1 to avoid division by zero.
212                  (guess (max 1 (round (/ (- line-length on) (+ off on)))))
213                  ;; Not sure about the value or why corr is necessary at all,
214                  ;; but it seems to be necessary.
215                  (corr (if (= on 0)
216                            (/ line-thickness 10)
217                            0))
218                  ;; Calculate a new value for off to fit the
219                  ;; line-length.
220                  (new-off (/ (- line-length corr (* (1+ guess) on)) guess))
221                  )
222             (cond
223
224              ;; Settings for (= on 0). Resulting in a dotted line.
225
226              ;; If line-length isn't shorter than `th´, change the given
227              ;; value for `off´ to fit the line-length.
228              ((and (= on 0) (< th line-length))
229               (set! off new-off))
230
231              ;; If the line-length is shorter than `th´, it makes no
232              ;; sense to adjust `off´. The rounded edges of the lines
233              ;; would prevent any nice output.
234              ;; Do nothing.
235              ;; This will result in a single dot for very short lines.
236              ((and (= on 0) (>= th line-length))
237               #f)
238
239              ;; Settings for (not (= on 0)). Resulting in a dashed line.
240
241              ;; If line-length isn't shorter than one go of on-off-on,
242              ;; change the given value for `off´ to fit the line-length.
243              ((< (+ (* 2 on) off) line-length)
244               (set! off new-off))
245              ;; If the line-length is too short, but greater than
246              ;; (* 4 th) set on/off to (/ line-length 3)
247              ((< (* 4 th) line-length)
248               (set! on (/ line-length 3))
249               (set! off (/ line-length 3)))
250              ;; If the line-length is shorter than (* 4 th), it makes
251              ;; no sense trying to adjust on/off. The rounded edges of
252              ;; the lines would prevent any nice output.
253              ;; Simply set `on´ to line-length.
254              (else
255               (set! on line-length))))))
256
257     ;; If `on´ or `off´ is negative, or the sum of `on' and `off' equals zero a
258     ;; ghostscript-error occurs while calling
259     ;; (ly:make-stencil (list 'dashed-line th on off x y phase) x-ext y-ext)
260     ;; Better be paranoid.
261     (if (or (= (+ on off) 0)
262             (negative? on)
263             (negative? off))
264         (begin
265           (ly:warning "Can't print a line - setting on/off to default")
266           (set! on 1)
267           (set! off 1)))
268
269     ;; To give the lines produced by \draw-line and \draw-dashed-line the same
270     ;; length, half-thick has to be added to the stencil-extensions.
271     (ly:make-stencil
272      (list 'dashed-line th on off x y phase)
273      (interval-widen (ordered-cons 0 x) half-thick)
274      (interval-widen (ordered-cons 0 y) half-thick))))
275
276 (define-markup-command (draw-dotted-line layout props dest)
277   (number-pair?)
278   #:category graphic
279   #:properties ((thickness 1)
280                 (off 1)
281                 (phase 0))
282   "
283 @cindex drawing dotted lines within text
284
285 A dotted line.
286
287 The dotted-line always extends to the whole length given by @var{dest}, without
288 white space at beginning or end.
289 Manual settings for @code{off} are possible to get larger or smaller space
290 between the dots.
291 The given (or default) value of @code{off} will be altered to fit the
292 line-length.
293 @lilypond[verbatim,quote]
294 \\markup {
295   \\draw-dotted-line #'(5.1 . 2.3)
296   \\override #'(thickness . 2)
297   \\override #'(off . 0.2)
298   \\draw-dotted-line #'(5.1 . 2.3)
299 }
300 @end lilypond"
301
302   (let ((new-props (prepend-alist-chain 'on 0
303                                         (prepend-alist-chain 'full-length #t props))))
304
305     (interpret-markup layout
306                       new-props
307                       (markup #:draw-dashed-line dest))))
308
309 (define-markup-command (draw-squiggle-line layout props sq-length dest eq-end?)
310   (number? number-pair? boolean?)
311   #:category graphic
312   #:properties ((thickness 0.5)
313                 (angularity 0)
314                 (height 0.5)
315                 (orientation 1))
316   "
317 @cindex drawing squiggled lines within text
318
319 A squiggled line.
320
321 If @code{eq-end?} is set to @code{#t}, it is ensured the squiggled line ends
322 with a bow in same direction as the starting one.  @code{sq-length} is the
323 length of the first bow.  @code{dest} is the end point of the squiggled line.
324 To match @code{dest} the squiggled line is scaled accordingly.
325 Its appearance may be customized by overrides for @code{thickness},
326 @code{angularity}, @code{height} and @code{orientation}.
327 @lilypond[verbatim,quote]
328 \\markup
329   \\column {
330     \\draw-squiggle-line #0.5 #'(6 . 0) ##t
331     \\override #'(orientation . -1)
332     \\draw-squiggle-line #0.5 #'(6 . 0) ##t
333     \\draw-squiggle-line #0.5 #'(6 . 0) ##f
334     \\override #'(height . 1)
335     \\draw-squiggle-line #0.5 #'(6 . 0) ##t
336     \\override #'(thickness . 5)
337     \\draw-squiggle-line #0.5 #'(6 . 0) ##t
338     \\override #'(angularity . 2)
339     \\draw-squiggle-line #0.5 #'(6 . 0) ##t
340   }
341 @end lilypond"
342   (let* ((line-thickness (ly:output-def-lookup layout 'line-thickness))
343          (thick (* thickness line-thickness))
344          (x (car dest))
345          (y (cdr dest))
346          (length-to-print (magnitude (make-rectangular x y)))
347          ;; Make a guess how many bows may be needed
348          (guess (max 1 (truncate (/ length-to-print sq-length))))
349          ;; If `eq-end?' is set #t, make sure squiggle-line starts and ends
350          ;; with a bow in same direction
351          (amount (if (and (even? guess) eq-end?) (1+ guess) guess))
352          ;; The lined-up bows needs to fit `length-to-print'
353          ;; Thus scale the length of first bow accordingly
354          ;; Other bows are copies
355          (guessed-squiggle-line-length (* amount sq-length))
356          (line-length-diff (- length-to-print guessed-squiggle-line-length))
357          (line-length-diff-for-each-squiggle
358            (/ line-length-diff amount))
359          (first-bow-length (+ sq-length line-length-diff-for-each-squiggle))
360          ;; Get first bows
361          ;; TODO two bows are created via `make-bow-stencil'
362          ;;      cheaper to use `ly:stencil-scale'?
363          (first-bow-end-coord
364            (cons
365              (/ (* first-bow-length x) length-to-print)
366              (/ (* first-bow-length y) length-to-print)))
367          (init-bow
368            (lambda (o)
369              (make-bow-stencil
370                '(0 . 0)
371                first-bow-end-coord
372                thick angularity height o)))
373          (init-bow-up (init-bow orientation))
374          (init-bow-down (init-bow (- orientation)))
375          ;; Get a list of starting-points for the bows
376          (list-of-starts
377            (map
378              (lambda (n)
379                (cons
380                  (* n (car first-bow-end-coord))
381                  (* n (cdr first-bow-end-coord))))
382              (iota amount))))
383     ;; The final stencil: lined-up bows
384     (apply ly:stencil-add
385       (map
386         ly:stencil-translate
387         (circular-list init-bow-up init-bow-down)
388         list-of-starts))))
389
390 (define-markup-command (draw-hline layout props)
391   ()
392   #:category graphic
393   #:properties ((draw-line-markup)
394                 (line-width)
395                 (span-factor 1))
396   "
397 @cindex drawing a line across a page
398
399 Draws a line across a page, where the property @code{span-factor}
400 controls what fraction of the page is taken up.
401 @lilypond[verbatim,quote]
402 \\markup {
403   \\column {
404     \\draw-hline
405     \\override #'(span-factor . 1/3)
406     \\draw-hline
407   }
408 }
409 @end lilypond"
410   (interpret-markup layout
411                     props
412                     (markup #:draw-line (cons (* line-width
413                                                  span-factor)
414                                               0))))
415
416 (define-markup-command (draw-circle layout props radius thickness filled)
417   (number? number? boolean?)
418   #:category graphic
419   "
420 @cindex drawing circles within text
421
422 A circle of radius @var{radius} and thickness @var{thickness},
423 optionally filled.
424
425 @lilypond[verbatim,quote]
426 \\markup {
427   \\draw-circle #2 #0.5 ##f
428   \\hspace #2
429   \\draw-circle #2 #0 ##t
430 }
431 @end lilypond"
432   (make-circle-stencil radius thickness filled))
433
434 (define-markup-command (triangle layout props filled)
435   (boolean?)
436   #:category graphic
437   #:properties ((thickness 0.1)
438                 (font-size 0)
439                 (baseline-skip 2))
440   "
441 @cindex drawing triangles within text
442
443 A triangle, either filled or empty.
444
445 @lilypond[verbatim,quote]
446 \\markup {
447   \\triangle ##t
448   \\hspace #2
449   \\triangle ##f
450 }
451 @end lilypond"
452   (let ((ex (* (magstep font-size) 0.8 baseline-skip)))
453     (ly:make-stencil
454      `(polygon '(0.0 0.0
455                      ,ex 0.0
456                      ,(* 0.5 ex)
457                      ,(* 0.86 ex))
458                ,thickness
459                ,filled)
460      (cons 0 ex)
461      (cons 0 (* .86 ex)))))
462
463 (define-markup-command (circle layout props arg)
464   (markup?)
465   #:category graphic
466   #:properties ((thickness 1)
467                 (font-size 0)
468                 (circle-padding 0.2))
469   "
470 @cindex circling text
471
472 Draw a circle around @var{arg}.  Use @code{thickness},
473 @code{circle-padding} and @code{font-size} properties to determine line
474 thickness and padding around the markup.
475
476 @lilypond[verbatim,quote]
477 \\markup {
478   \\circle {
479     Hi
480   }
481 }
482 @end lilypond"
483   (let ((th (* (ly:output-def-lookup layout 'line-thickness)
484                thickness))
485         (pad (* (magstep font-size) circle-padding))
486         (m (interpret-markup layout props arg)))
487     (circle-stencil m th pad)))
488
489 (define-markup-command (ellipse layout props arg)
490   (markup?)
491   #:category graphic
492   #:properties ((thickness 1)
493                 (font-size 0)
494                 (x-padding 0.2)
495                 (y-padding 0.2))
496   "
497 @cindex drawing ellipse around text
498
499 Draw an ellipse around @var{arg}.  Use @code{thickness},
500 @code{x-padding}, @code{y-padding} and @code{font-size} properties to determine
501 line thickness and padding around the markup.
502
503 @lilypond[verbatim,quote]
504 \\markup {
505   \\ellipse {
506     Hi
507   }
508 }
509 @end lilypond"
510   (let ((th (* (ly:output-def-lookup layout 'line-thickness)
511                thickness))
512         (pad-x (* (magstep font-size) x-padding))
513         (pad-y (* (magstep font-size) y-padding))
514         (m (interpret-markup layout props arg)))
515     (ellipse-stencil m th pad-x pad-y)))
516
517 (define-markup-command (oval layout props arg)
518   (markup?)
519   #:category graphic
520   #:properties ((thickness 1)
521                 (font-size 0)
522                 (x-padding 0.75)
523                 (y-padding 0.75))
524   "
525 @cindex drawing oval around text
526
527 Draw an oval around @var{arg}.  Use @code{thickness},
528 @code{x-padding}, @code{x-padding} and @code{font-size} properties to determine
529 line thickness and padding around the markup.
530
531 @lilypond[verbatim,quote]
532 \\markup {
533   \\oval {
534     Hi
535   }
536 }
537 @end lilypond"
538   (let ((th (* (ly:output-def-lookup layout 'line-thickness)
539                thickness))
540         (pad-x (* (magstep font-size) x-padding))
541         (pad-y (* (magstep font-size) y-padding))
542         (m (interpret-markup layout props arg)))
543     (oval-stencil m th pad-x pad-y)))
544
545 (define-markup-command (with-url layout props url arg)
546   (string? markup?)
547   #:category graphic
548   "
549 @cindex inserting URL links into text
550
551 Add a link to URL @var{url} around @var{arg}.  This only works in
552 the PDF backend.
553
554 @lilypond[verbatim,quote]
555 \\markup {
556   \\with-url #\"http://lilypond.org/\" {
557     LilyPond ... \\italic {
558       music notation for everyone
559     }
560   }
561 }
562 @end lilypond"
563   (let* ((stil (interpret-markup layout props arg))
564          (xextent (ly:stencil-extent stil X))
565          (yextent (ly:stencil-extent stil Y))
566          (old-expr (ly:stencil-expr stil))
567          (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent))))
568
569     (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil)))
570
571 (define-markup-command (page-link layout props page-number arg)
572   (number? markup?)
573   #:category other
574   "
575 @cindex referencing page numbers in text
576
577 Add a link to the page @var{page-number} around @var{arg}.  This only works
578 in the PDF backend.
579
580 @lilypond[verbatim,quote]
581 \\markup {
582   \\page-link #2  { \\italic { This links to page 2... } }
583 }
584 @end lilypond"
585   (let* ((stil (interpret-markup layout props arg))
586          (xextent (ly:stencil-extent stil X))
587          (yextent (ly:stencil-extent stil Y))
588          (old-expr (ly:stencil-expr stil))
589          (link-expr (list 'page-link page-number `(quote ,xextent) `(quote ,yextent))))
590
591     (ly:stencil-add (ly:make-stencil link-expr xextent yextent) stil)))
592
593 (define-public (book-first-page layout props)
594   "Return the @code{'first-page-number} of the entire book"
595   (define (ancestor layout)
596     "Return the topmost layout ancestor"
597     (let ((parent (ly:output-def-parent layout)))
598       (if (not (ly:output-def? parent))
599           layout
600           (ancestor parent))))
601   (ly:output-def-lookup (ancestor layout) 'first-page-number))
602
603 (define-markup-command (with-link layout props label arg)
604   (symbol? markup?)
605   #:category other
606   "
607 @cindex referencing page labels in text
608
609 Add a link to the page holding label @var{label} around @var{arg}.  This
610 only works in the PDF backend.
611
612 @lilypond[verbatim,quote]
613 \\markup {
614   \\with-link #'label {
615     \\italic { This links to the page containing the label... }
616   }
617 }
618 @end lilypond"
619   (let* ((arg-stencil (interpret-markup layout props arg))
620          (x-ext (ly:stencil-extent arg-stencil X))
621          (y-ext (ly:stencil-extent arg-stencil Y)))
622     (ly:stencil-add
623       (ly:make-stencil
624        `(delay-stencil-evaluation
625          ,(delay (let* ((table (ly:output-def-lookup layout 'label-page-table))
626                         (table-page-number
627                           (if (list? table)
628                               (assoc-get label table)
629                               #f))
630                         (first-page-number (book-first-page layout props))
631                         (current-page-number
632                           (if table-page-number
633                               (1+ (- table-page-number first-page-number))
634                               #f)))
635                  (list 'page-link current-page-number
636                        `(quote ,x-ext) `(quote ,y-ext)))))
637        x-ext
638        y-ext)
639       arg-stencil)))
640
641 (define-markup-command (beam layout props width slope thickness)
642   (number? number? number?)
643   #:category graphic
644   "
645 @cindex drawing beams within text
646
647 Create a beam with the specified parameters.
648 @lilypond[verbatim,quote]
649 \\markup {
650   \\beam #5 #1 #2
651 }
652 @end lilypond"
653   (let* ((y (* slope width))
654          (yext (cons (min 0 y) (max 0 y)))
655          (half (/ thickness 2)))
656
657     (ly:make-stencil
658      `(polygon ',(list
659                   0 (/ thickness -2)
660                   width (+ (* width slope)  (/ thickness -2))
661                   width (+ (* width slope)  (/ thickness 2))
662                   0 (/ thickness 2))
663                ,(ly:output-def-lookup layout 'blot-diameter)
664                #t)
665      (cons 0 width)
666      (cons (+ (- half) (car yext))
667            (+ half (cdr yext))))))
668
669 (define-markup-command (underline layout props arg)
670   (markup?)
671   #:category font
672   #:properties ((thickness 1) (offset 2))
673   "
674 @cindex underlining text
675
676 Underline @var{arg}.  Looks at @code{thickness} to determine line
677 thickness, and @code{offset} to determine line y-offset.
678
679 @lilypond[verbatim,quote]
680 \\markup \\fill-line {
681   \\underline \"underlined\"
682   \\override #'(offset . 5)
683   \\override #'(thickness . 1)
684   \\underline \"underlined\"
685   \\override #'(offset . 1)
686   \\override #'(thickness . 5)
687   \\underline \"underlined\"
688 }
689 @end lilypond"
690   (let* ((thick (ly:output-def-lookup layout 'line-thickness))
691          (underline-thick (* thickness thick))
692          (m (interpret-markup layout props arg))
693          (x1 (car (ly:stencil-extent m X)))
694          (x2 (cdr (ly:stencil-extent m X)))
695          (y (* thick (- offset)))
696          (line (make-line-stencil underline-thick x1 y x2 y)))
697     (ly:stencil-add m line)))
698
699 (define-markup-command (tie layout props arg)
700   (markup?)
701   #:category font
702   #:properties ((thickness 1)
703                 (offset 2)
704                 (direction UP)
705                 (shorten-pair '(0 . 0)))
706   "
707 @cindex tie-ing text
708
709 Adds a horizontal bow created with @code{make-tie-stencil} at bottom or top
710 of @var{arg}.  Looks at @code{thickness} to determine line thickness, and
711 @code{offset} to determine y-offset.  The added bow fits the extent of
712 @var{arg}, @code{shorten-pair} may be used to modify this.
713 @var{direction} may be set using an @code{override} or direction-modifiers or
714 @code{voiceOne}, etc.
715
716 @lilypond[verbatim,quote]
717 \\markup {
718   \\override #'(direction . 1)
719   \\tie \"above\"
720   \\override #'(direction . -1)
721   \\tie \"below\"
722 }
723 @end lilypond"
724   (let* ((line-thickness (ly:output-def-lookup layout 'line-thickness))
725          (thick (* thickness line-thickness))
726          (stil (interpret-markup layout props arg))
727          (x1 (car (ly:stencil-extent stil X)))
728          (x2 (cdr (ly:stencil-extent stil X)))
729          (y-ext (ly:stencil-extent stil Y))
730          (y (+ (* line-thickness offset direction)
731                ;; we put out zero for positive text-direction, to make it
732                ;; consistent with `underline-markup'
733                ;; TODO: this will be problematic for args like "Eng"
734                ;;       fix it here _and_ in `underline-markup'
735                (if (negative? direction) 0 (cdr y-ext))))
736          (tie
737            (make-tie-stencil
738              (cons (+ x1 (car shorten-pair) line-thickness) y)
739              (cons (- x2 (cdr shorten-pair) line-thickness) y)
740              thick
741              direction)))
742     (ly:stencil-add stil tie)))
743
744 (define-markup-command (undertie layout props arg)
745   (markup?)
746   #:category font
747   #:properties (tie-markup)
748   "
749 @cindex undertie-ing text
750
751 @lilypond[verbatim,quote]
752 \\markup \\line {
753   \\undertie \"undertied\"
754   \\override #'(offset . 5)
755   \\override #'(thickness . 1)
756   \\undertie \"undertied\"
757   \\override #'(offset . 1)
758   \\override #'(thickness . 5)
759   \\undertie \"undertied\"
760 }
761 @end lilypond"
762   (interpret-markup layout (prepend-alist-chain 'direction DOWN props)
763     (make-tie-markup arg)))
764
765 (define-markup-command (overtie layout props arg)
766   (markup?)
767   #:category font
768   #:properties (tie-markup)
769   "
770 @cindex overtie-ing text
771
772 Overtie @var{arg}.
773
774 @lilypond[verbatim,quote]
775 \\markup \\line {
776   \\overtie \"overtied\"
777   \\override #'(offset . 5)
778   \\override #'(thickness . 1)
779   \\overtie \"overtied\"
780   \\override #'(offset . 1)
781   \\override #'(thickness . 5)
782   \\overtie \"overtied\"
783 }
784 @end lilypond"
785   (interpret-markup layout (prepend-alist-chain 'direction UP props)
786     (make-tie-markup arg)))
787
788 (define-markup-command (box layout props arg)
789   (markup?)
790   #:category font
791   #:properties ((thickness 1)
792                 (font-size 0)
793                 (box-padding 0.2))
794   "
795 @cindex enclosing text within a box
796
797 Draw a box round @var{arg}.  Looks at @code{thickness},
798 @code{box-padding} and @code{font-size} properties to determine line
799 thickness and padding around the markup.
800
801 @lilypond[verbatim,quote]
802 \\markup {
803   \\override #'(box-padding . 0.5)
804   \\box
805   \\line { V. S. }
806 }
807 @end lilypond"
808   (let* ((th (* (ly:output-def-lookup layout 'line-thickness)
809                 thickness))
810          (pad (* (magstep font-size) box-padding))
811          (m (interpret-markup layout props arg)))
812     (box-stencil m th pad)))
813
814 (define-markup-command (filled-box layout props xext yext blot)
815   (number-pair? number-pair? number?)
816   #:category graphic
817   "
818 @cindex drawing solid boxes within text
819 @cindex drawing boxes with rounded corners
820
821 Draw a box with rounded corners of dimensions @var{xext} and
822 @var{yext}.  For example,
823 @verbatim
824 \\filled-box #'(-.3 . 1.8) #'(-.3 . 1.8) #0
825 @end verbatim
826 creates a box extending horizontally from -0.3 to 1.8 and
827 vertically from -0.3 up to 1.8, with corners formed from a
828 circle of diameter@tie{}0 (i.e., sharp corners).
829
830 @lilypond[verbatim,quote]
831 \\markup {
832   \\filled-box #'(0 . 4) #'(0 . 4) #0
833   \\filled-box #'(0 . 2) #'(-4 . 2) #0.4
834   \\filled-box #'(1 . 8) #'(0 . 7) #0.2
835   \\with-color #white
836   \\filled-box #'(-4.5 . -2.5) #'(3.5 . 5.5) #0.7
837 }
838 @end lilypond"
839   (ly:round-filled-box
840    xext yext blot))
841
842 (define-markup-command (rounded-box layout props arg)
843   (markup?)
844   #:category graphic
845   #:properties ((thickness 1)
846                 (corner-radius 1)
847                 (font-size 0)
848                 (box-padding 0.5))
849   "@cindex enclosing text in a box with rounded corners
850    @cindex drawing boxes with rounded corners around text
851 Draw a box with rounded corners around @var{arg}.  Looks at @code{thickness},
852 @code{box-padding} and @code{font-size} properties to determine line
853 thickness and padding around the markup; the @code{corner-radius} property
854 makes it possible to define another shape for the corners (default is 1).
855
856 @lilypond[quote,verbatim,relative=2]
857 c4^\\markup {
858   \\rounded-box {
859     Overtura
860   }
861 }
862 c,8. c16 c4 r
863 @end lilypond"
864   (let ((th (* (ly:output-def-lookup layout 'line-thickness)
865                thickness))
866         (pad (* (magstep font-size) box-padding))
867         (m (interpret-markup layout props arg)))
868     (ly:stencil-add (rounded-box-stencil m th pad corner-radius)
869                     m)))
870
871 (define-markup-command (rotate layout props ang arg)
872   (number? markup?)
873   #:category align
874   "
875 @cindex rotating text
876
877 Rotate object with @var{ang} degrees around its center.
878
879 @lilypond[verbatim,quote]
880 \\markup {
881   default
882   \\hspace #2
883   \\rotate #45
884   \\line {
885     rotated 45°
886   }
887 }
888 @end lilypond"
889   (let* ((stil (interpret-markup layout props arg)))
890     (ly:stencil-rotate stil ang 0 0)))
891
892 (define-markup-command (whiteout layout props arg)
893   (markup?)
894   #:category other
895   #:properties ((style 'box)
896                 (thickness '()))
897   "
898 @cindex adding a white background to text
899
900 Provide a white background for @var{arg}.  The shape of the white
901 background is determined by @code{style}.  The default
902 is @code{box} which produces a rectangle.  @code{rounded-box}
903 produces a rounded rectangle.  @code{outline} approximates the
904 outline of the markup.
905
906 @lilypond[verbatim,quote]
907 \\markup {
908   \\combine
909     \\filled-box #'(-1 . 15) #'(-3 . 4) #1
910     \\override #'(thickness . 1.5)
911     \\whiteout whiteout-box
912 }
913 \\markup {
914   \\combine
915     \\filled-box #'(-1 . 24) #'(-3 . 4) #1
916     \\override #'(style . rounded-box)
917     \\override #'(thickness . 3)
918     \\whiteout whiteout-rounded-box
919 }
920 \\markup {
921   \\combine
922     \\filled-box #'(-1 . 18) #'(-3 . 4) #1
923     \\override #'(style . outline)
924     \\override #'(thickness . 3)
925     \\whiteout whiteout-outline
926 }
927 @end lilypond"
928   (stencil-whiteout
929     (interpret-markup layout props arg)
930     style
931     thickness
932     (ly:output-def-lookup layout 'line-thickness)))
933
934 (define-markup-command (pad-markup layout props amount arg)
935   (number? markup?)
936   #:category align
937   "
938 @cindex padding text
939 @cindex putting space around text
940
941 Add space around a markup object.
942 Identical to @code{pad-around}.
943
944 @lilypond[verbatim,quote]
945 \\markup {
946   \\box {
947     default
948   }
949   \\hspace #2
950   \\box {
951     \\pad-markup #1 {
952       padded
953     }
954   }
955 }
956 @end lilypond"
957   (let* ((m (interpret-markup layout props arg))
958          (x (interval-widen (ly:stencil-extent m X) amount))
959          (y (interval-widen (ly:stencil-extent m Y) amount)))
960     (ly:stencil-add (make-transparent-box-stencil x y)
961                     m)))
962
963 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
964 ;; space
965 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
966
967 (define-markup-command (strut layout props)
968   ()
969   #:category other
970   "
971 @cindex creating vertical spaces in text
972
973 Create a box of the same height as the space in the current font."
974   (let ((m (ly:text-interface::interpret-markup layout props " ")))
975     (ly:make-stencil (ly:stencil-expr m)
976                      '(0 . 0)
977                      (ly:stencil-extent m X)
978                      )))
979
980 (define-markup-command (hspace layout props amount)
981   (number?)
982   #:category align
983   "
984 @cindex creating horizontal spaces in text
985
986 Create an invisible object taking up horizontal space @var{amount}.
987
988 @lilypond[verbatim,quote]
989 \\markup {
990   one
991   \\hspace #2
992   two
993   \\hspace #8
994   three
995 }
996 @end lilypond"
997   (ly:make-stencil "" (cons 0 amount) empty-interval))
998
999 (define-markup-command (vspace layout props amount)
1000   (number?)
1001   #:category align
1002   "
1003 @cindex creating vertical spaces in text
1004
1005 Create an invisible object taking up vertical space
1006 of @var{amount} multiplied by 3.
1007
1008 @lilypond[verbatim,quote]
1009 \\markup {
1010     \\center-column {
1011     one
1012     \\vspace #2
1013     two
1014     \\vspace #5
1015     three
1016   }
1017 }
1018 @end lilypond"
1019   (let ((amount (* amount 3.0)))
1020     (ly:make-stencil "" empty-interval (cons 0 amount))))
1021
1022
1023 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1024 ;; importing graphics.
1025 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1026
1027 (define-markup-command (stencil layout props stil)
1028   (ly:stencil?)
1029   #:category other
1030   "
1031 @cindex importing stencils into text
1032
1033 Use a stencil as markup.
1034
1035 @lilypond[verbatim,quote]
1036 \\markup {
1037   \\stencil #(make-circle-stencil 2 0 #t)
1038 }
1039 @end lilypond"
1040   stil)
1041
1042 (define bbox-regexp
1043   (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)"))
1044
1045 (define (get-postscript-bbox string)
1046   "Extract the bbox from STRING, or return #f if not present."
1047   (let*
1048       ((match (regexp-exec bbox-regexp string)))
1049
1050     (if match
1051         (map (lambda (x)
1052                (string->number (match:substring match x)))
1053              (cdr (iota 5)))
1054
1055         #f)))
1056
1057 (define-markup-command (epsfile layout props axis size file-name)
1058   (number? number? string?)
1059   #:category graphic
1060   "
1061 @cindex inlining an Encapsulated PostScript image
1062
1063 Inline an EPS image.  The image is scaled along @var{axis} to
1064 @var{size}.
1065
1066 @lilypond[verbatim,quote]
1067 \\markup {
1068   \\general-align #Y #DOWN {
1069     \\epsfile #X #20 #\"context-example.eps\"
1070     \\epsfile #Y #20 #\"context-example.eps\"
1071   }
1072 }
1073 @end lilypond"
1074   (if (ly:get-option 'safe)
1075       (interpret-markup layout props "not allowed in safe")
1076       (eps-file->stencil axis size file-name)
1077       ))
1078
1079 (define-markup-command (postscript layout props str)
1080   (string?)
1081   #:category graphic
1082   "
1083 @cindex inserting PostScript directly into text
1084 This inserts @var{str} directly into the output as a PostScript
1085 command string.
1086
1087 @lilypond[verbatim,quote]
1088 ringsps = #\"
1089   0.15 setlinewidth
1090   0.9 0.6 moveto
1091   0.4 0.6 0.5 0 361 arc
1092   stroke
1093   1.0 0.6 0.5 0 361 arc
1094   stroke
1095   \"
1096
1097 rings = \\markup {
1098   \\with-dimensions #'(-0.2 . 1.6) #'(0 . 1.2)
1099   \\postscript #ringsps
1100 }
1101
1102 \\relative c'' {
1103   c2^\\rings
1104   a2_\\rings
1105 }
1106 @end lilypond"
1107   ;; FIXME
1108   (ly:make-stencil
1109    (list 'embedded-ps
1110          (format #f "
1111 gsave currentpoint translate
1112 0.1 setlinewidth
1113  ~a
1114 grestore
1115 "
1116                  str))
1117    '(0 . 0) '(0 . 0)))
1118
1119 (define-markup-command (path layout props thickness commands) (number? list?)
1120   #:category graphic
1121   #:properties ((line-cap-style 'round)
1122                 (line-join-style 'round)
1123                 (filled #f))
1124   "
1125 @cindex paths, drawing
1126 @cindex drawing paths
1127 Draws a path with line @var{thickness} according to the
1128 directions given in @var{commands}.  @var{commands} is a list of
1129 lists where the @code{car} of each sublist is a drawing command and
1130 the @code{cdr} comprises the associated arguments for each command.
1131
1132 There are seven commands available to use in the list
1133 @code{commands}: @code{moveto}, @code{rmoveto}, @code{lineto},
1134 @code{rlineto}, @code{curveto}, @code{rcurveto}, and
1135 @code{closepath}.  Note that the commands that begin with @emph{r}
1136 are the relative variants of the other three commands.
1137
1138 The commands @code{moveto}, @code{rmoveto}, @code{lineto}, and
1139 @code{rlineto} take 2 arguments; they are the X and Y coordinates
1140 for the destination point.
1141
1142 The commands @code{curveto} and @code{rcurveto} create cubic
1143 Bézier curves, and take 6 arguments; the first two are the X and Y
1144 coordinates for the first control point, the second two are the X
1145 and Y coordinates for the second control point, and the last two
1146 are the X and Y coordinates for the destination point.
1147
1148 The @code{closepath} command takes zero arguments and closes the
1149 current subpath in the active path.
1150
1151 Note that a sequence of commands @emph{must} begin with a
1152 @code{moveto} or @code{rmoveto} to work with the SVG output.
1153
1154 Line-cap styles and line-join styles may be customized by
1155 overriding the @code{line-cap-style} and @code{line-join-style}
1156 properties, respectively.  Available line-cap styles are
1157 @code{'butt}, @code{'round}, and @code{'square}.  Available
1158 line-join styles are @code{'miter}, @code{'round}, and
1159 @code{'bevel}.
1160
1161 The property @code{filled} specifies whether or not the path is
1162 filled with color.
1163
1164 @lilypond[verbatim,quote]
1165 samplePath =
1166   #'((moveto 0 0)
1167      (lineto -1 1)
1168      (lineto 1 1)
1169      (lineto 1 -1)
1170      (curveto -5 -5 -5 5 -1 0)
1171      (closepath))
1172
1173 \\markup {
1174   \\path #0.25 #samplePath
1175
1176   \\override #'(line-join-style . miter) \\path #0.25 #samplePath
1177
1178   \\override #'(filled . #t) \\path #0.25 #samplePath
1179 }
1180 @end lilypond"
1181   (let* ((half-thickness (/ thickness 2))
1182          (current-point '(0 . 0))
1183          (set-point (lambda (lst) (set! current-point lst)))
1184          (relative? (lambda (x)
1185                       (string-prefix? "r" (symbol->string (car x)))))
1186          ;; For calculating extents, we want to modify the command
1187          ;; list so that all coordinates are absolute.
1188          (new-commands (map (lambda (x)
1189                               (cond
1190                                ;; for rmoveto, rlineto
1191                                ((and (relative? x) (= 3 (length x)))
1192                                 (let ((cp (cons
1193                                            (+ (car current-point)
1194                                               (second x))
1195                                            (+ (cdr current-point)
1196                                               (third x)))))
1197                                   (set-point cp)
1198                                   (list (car cp)
1199                                         (cdr cp))))
1200                                ;; for rcurveto
1201                                ((and (relative? x) (= 7 (length x)))
1202                                 (let* ((old-cp current-point)
1203                                        (cp (cons
1204                                             (+ (car old-cp)
1205                                                (sixth x))
1206                                             (+ (cdr old-cp)
1207                                                (seventh x)))))
1208                                   (set-point cp)
1209                                   (list (+ (car old-cp) (second x))
1210                                         (+ (cdr old-cp) (third x))
1211                                         (+ (car old-cp) (fourth x))
1212                                         (+ (cdr old-cp) (fifth x))
1213                                         (car cp)
1214                                         (cdr cp))))
1215                                ;; for moveto, lineto
1216                                ((= 3 (length x))
1217                                 (set-point (cons (second x)
1218                                                  (third x)))
1219                                 (drop x 1))
1220                                ;; for curveto
1221                                ((= 7 (length x))
1222                                 (set-point (cons (sixth x)
1223                                                  (seventh x)))
1224                                 (drop x 1))
1225                                ;; keep closepath for filtering;
1226                                ;; see `without-closepath'.
1227                                (else x)))
1228                             commands))
1229          ;; path-min-max does not accept 0-arg lists,
1230          ;; and since closepath does not affect extents, filter
1231          ;; out those commands here.
1232          (without-closepath (filter (lambda (x)
1233                                       (not (equal? 'closepath (car x))))
1234                                     new-commands))
1235          (extents (path-min-max
1236                    ;; set the origin to the first moveto
1237                    (list (list-ref (car without-closepath) 0)
1238                          (list-ref (car without-closepath) 1))
1239                    without-closepath))
1240          (X-extent (cons (list-ref extents 0) (list-ref extents 1)))
1241          (Y-extent (cons (list-ref extents 2) (list-ref extents 3)))
1242          (command-list (fold-right append '() commands)))
1243
1244     ;; account for line thickness
1245     (set! X-extent (interval-widen X-extent half-thickness))
1246     (set! Y-extent (interval-widen Y-extent half-thickness))
1247
1248     (ly:make-stencil
1249      `(path ,thickness `(,@',command-list)
1250             ',line-cap-style ',line-join-style ,filled)
1251      X-extent
1252      Y-extent)))
1253
1254 (define-markup-list-command (score-lines layout props score)
1255   (ly:score?)
1256   "This is the same as the @code{\\score} markup but delivers its
1257 systems as a list of lines.  Its @var{score} argument is entered in
1258 braces like it would be for @code{\\score}."
1259   (let ((output (ly:score-embedded-format score layout)))
1260
1261     (if (ly:music-output? output)
1262         (map
1263          (lambda (paper-system)
1264            ;; shift such that the refpoint of the bottom staff of
1265            ;; the first system is the baseline of the score
1266            (ly:stencil-translate-axis
1267             (paper-system-stencil paper-system)
1268             (- (car (paper-system-staff-extents paper-system)))
1269             Y))
1270          (vector->list (ly:paper-score-paper-systems output)))
1271         (begin
1272           (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?"))
1273           '()))))
1274
1275 (define-markup-command (score layout props score)
1276   (ly:score?)
1277   #:category music
1278   #:properties ((baseline-skip))
1279   "
1280 @cindex inserting music into text
1281
1282 Inline an image of music.  The reference point (usually the middle
1283 staff line) of the lowest staff in the top system is placed on the
1284 baseline.
1285
1286 @lilypond[verbatim,quote]
1287 \\markup {
1288   \\score {
1289     \\new PianoStaff <<
1290       \\new Staff \\relative c' {
1291         \\key f \\major
1292         \\time 3/4
1293         \\mark \\markup { Allegro }
1294         f2\\p( a4)
1295         c2( a4)
1296         bes2( g'4)
1297         f8( e) e4 r
1298       }
1299       \\new Staff \\relative c {
1300         \\clef bass
1301         \\key f \\major
1302         \\time 3/4
1303         f8( a c a c a
1304         f c' es c es c)
1305         f,( bes d bes d bes)
1306         f( g bes g bes g)
1307       }
1308     >>
1309     \\layout {
1310       indent = 0.0\\cm
1311       \\context {
1312         \\Score
1313         \\override RehearsalMark
1314           #'break-align-symbols = #'(time-signature key-signature)
1315         \\override RehearsalMark
1316           #'self-alignment-X = #LEFT
1317       }
1318       \\context {
1319         \\Staff
1320         \\override TimeSignature
1321           #'break-align-anchor-alignment = #LEFT
1322       }
1323     }
1324   }
1325 }
1326 @end lilypond"
1327   (stack-stencils Y DOWN baseline-skip
1328                   (score-lines-markup-list layout props score)))
1329
1330 (define-markup-command (null layout props)
1331   ()
1332   #:category other
1333   "
1334 @cindex creating empty text objects
1335
1336 An empty markup with extents of a single point.
1337
1338 @lilypond[verbatim,quote]
1339 \\markup {
1340   \\null
1341 }
1342 @end lilypond"
1343   point-stencil)
1344
1345 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1346 ;; basic formatting.
1347 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1348
1349 (define-markup-command (simple layout props str)
1350   (string?)
1351   #:category font
1352   "
1353 @cindex simple text strings
1354
1355 A simple text string; @code{\\markup @{ foo @}} is equivalent with
1356 @code{\\markup @{ \\simple #\"foo\" @}}.
1357
1358 Note: for creating standard text markup or defining new markup commands,
1359 the use of @code{\\simple} is unnecessary.
1360
1361 @lilypond[verbatim,quote]
1362 \\markup {
1363   \\simple #\"simple\"
1364   \\simple #\"text\"
1365   \\simple #\"strings\"
1366 }
1367 @end lilypond"
1368   (interpret-markup layout props str))
1369
1370 (define-markup-command (first-visible layout props args)
1371   (markup-list?)
1372   #:category other
1373   "Use the first markup in @var{args} that yields a non-empty stencil
1374 and ignore the rest.
1375
1376 @lilypond[verbatim,quote]
1377 \\markup {
1378   \\first-visible {
1379     \\fromproperty #'header:composer
1380     \\italic Unknown
1381   }
1382 }
1383 @end lilypond"
1384   (define (false-if-empty stencil)
1385     (if (ly:stencil-empty? stencil) #f stencil))
1386   (or
1387    (any
1388     (lambda (m)
1389       (if (markup? m)
1390           (false-if-empty (interpret-markup layout props m))
1391           (any false-if-empty (interpret-markup-list layout props (list m)))))
1392     args)
1393    empty-stencil))
1394
1395 (define-public empty-markup
1396   (make-simple-markup ""))
1397
1398 ;; helper for justifying lines.
1399 (define (get-fill-space
1400           word-count line-width word-space text-widths constant-space?)
1401   "Calculate the necessary paddings between adjacent texts in a
1402 single justified line.  The lengths of all texts are stored in
1403 @var{text-widths}.
1404 When @var{constant-space?} is @code{#t}, the formula for the padding
1405 between texts is:
1406 padding = (line-width - total-text-width)/(word-count - 1)
1407 When @var{constant-space?} is @code{#f}, the formula for the
1408 padding between interior texts a and b is:
1409 padding = line-width/(word-count - 1) - (length(a) + length(b))/2
1410 In this case, the first and last padding have to be calculated
1411 specially using the whole length of the first or last text.
1412 All paddings are checked to be at least word-space, to ensure that
1413 no texts collide.
1414 Return a list of paddings."
1415   (cond
1416     ((null? text-widths) '())
1417     (constant-space?
1418      (make-list
1419        (1- word-count)
1420        ;; Ensure that space between words cannot be
1421        ;; less than word-space.
1422        (max
1423          word-space
1424          (/ (- line-width (apply + text-widths))
1425             (1- word-count)))))
1426
1427     ;; special case first padding
1428     ((= (length text-widths) word-count)
1429      (cons
1430        (- (- (/ line-width (1- word-count)) (car text-widths))
1431           (/ (cadr text-widths) 2))
1432        (get-fill-space
1433          word-count line-width word-space (cdr text-widths)
1434                                           constant-space?)))
1435     ;; special case last padding
1436     ((= (length text-widths) 2)
1437      (list (- (/ line-width (1- word-count))
1438               (+ (/ (car text-widths) 2) (cadr text-widths)))
1439            0))
1440     (else
1441       (let ((default-padding
1442               (- (/ line-width (1- word-count))
1443                  (/ (+ (car text-widths) (cadr text-widths)) 2))))
1444         (cons
1445           (if (> word-space default-padding)
1446               word-space
1447               default-padding)
1448           (get-fill-space
1449             word-count line-width word-space (cdr text-widths)
1450                                              constant-space?))))))
1451
1452 (define (justify-line-helper
1453           layout props args text-direction word-space line-width constant-space?)
1454   "Return a stencil which spreads @var{args} along a line of width
1455 @var{line-width}.  If @var{constant-space?} is set to @code{#t}, the
1456 space between words is constant.  If @code{#f}, the distance between
1457 words varies according to their relative lengths."
1458   (let* ((orig-stencils (interpret-markup-list layout props args))
1459          (stencils
1460            (map (lambda (stc)
1461                   (if (ly:stencil-empty? stc X)
1462                       (ly:make-stencil (ly:stencil-expr stc)
1463                                        '(0 . 0) (ly:stencil-extent stc Y))
1464                       stc))
1465                 orig-stencils))
1466          (text-widths
1467            (map (lambda (stc)
1468                   (interval-length (ly:stencil-extent stc X)))
1469                 stencils))
1470          (text-width (apply + text-widths))
1471          (word-count (length stencils))
1472          (line-width (or line-width (ly:output-def-lookup layout 'line-width)))
1473          (fill-space
1474            (cond
1475              ((= word-count 1)
1476               (list
1477                 (/ (- line-width text-width) 2)
1478                 (/ (- line-width text-width) 2)))
1479              ((= word-count 2)
1480               (list
1481                 (- line-width text-width)))
1482              (else
1483                (get-fill-space
1484                  word-count line-width word-space text-widths
1485                                                   constant-space?))))
1486          (line-contents (if (= word-count 1)
1487                             (list
1488                               point-stencil
1489                               (car stencils)
1490                               point-stencil)
1491                             stencils)))
1492
1493     (if (null? (remove ly:stencil-empty? orig-stencils))
1494         empty-stencil
1495         (begin
1496           (if (= text-direction LEFT)
1497               (set! line-contents (reverse line-contents)))
1498           (set! line-contents
1499                 (stack-stencils-padding-list
1500                   X RIGHT fill-space line-contents))
1501           (if (> word-count 1)
1502               ;; shift s.t. stencils align on the left edge, even if
1503               ;; first stencil had negative X-extent (e.g. center-column)
1504               ;; (if word-count = 1, X-extents are already normalized in
1505               ;; the definition of line-contents)
1506               (set! line-contents
1507                     (ly:stencil-translate-axis
1508                       line-contents
1509                       (- (car (ly:stencil-extent (car stencils) X)))
1510                       X)))
1511           line-contents))))
1512
1513 (define-markup-command (fill-line layout props args)
1514   (markup-list?)
1515   #:category align
1516   #:properties ((text-direction RIGHT)
1517                 (word-space 0.6)
1518                 (line-width #f))
1519   "Put @var{markups} in a horizontal line of width @var{line-width}.
1520 The markups are spaced or flushed to fill the entire line.
1521 If there are no arguments, return an empty stencil.
1522
1523 @lilypond[verbatim,quote]
1524 \\markup {
1525   \\column {
1526     \\fill-line {
1527       Words evenly spaced across the page
1528     }
1529     \\null
1530     \\fill-line {
1531       \\line { Text markups }
1532       \\line {
1533         \\italic { evenly spaced }
1534       }
1535       \\line { across the page }
1536     }
1537   }
1538 }
1539 @end lilypond"
1540   (justify-line-helper
1541     layout props args text-direction word-space line-width #f))
1542
1543 (define-markup-command (justify-line layout props args)
1544   (markup-list?)
1545   #:category align
1546   #:properties ((text-direction RIGHT)
1547                 (word-space 0.6)
1548                 (line-width #f))
1549   "Put @var{markups} in a horizontal line of width @var{line-width}.
1550 The markups are spread to fill the entire line and separated by equal
1551 space.  If there are no arguments, return an empty stencil.
1552
1553 @lilypond[verbatim,quote]
1554 \\markup {
1555   \\justify-line {
1556     Space between neighboring words is constant
1557   }
1558 }
1559 @end lilypond"
1560   (justify-line-helper
1561     layout props args text-direction word-space line-width #t))
1562
1563 (define-markup-command (concat layout props args)
1564   (markup-list?)
1565   #:category align
1566   "
1567 @cindex concatenating text
1568 @cindex ligatures in text
1569
1570 Concatenate @var{args} in a horizontal line, without spaces in between.
1571 Strings and simple markups are concatenated on the input level, allowing
1572 ligatures.  For example, @code{\\concat @{ \"f\" \\simple #\"i\" @}} is
1573 equivalent to @code{\"fi\"}.
1574
1575 @lilypond[verbatim,quote]
1576 \\markup {
1577   \\concat {
1578     one
1579     two
1580     three
1581   }
1582 }
1583 @end lilypond"
1584   (define (concat-string-args arg-list)
1585     (fold-right (lambda (arg result-list)
1586                   (let ((result (and (pair? result-list)
1587                                      (car result-list))))
1588                     (cond ((not (pair? arg)))
1589                           ((eq? (car arg) simple-markup)
1590                            (set! arg (cadr arg)))
1591                           ((eq? (car arg) char-markup)
1592                            (set! arg (ly:wide-char->utf-8 (cadr arg)))))
1593                     (if (and (string? result) (string? arg))
1594                         (cons (string-append arg result) (cdr result-list))
1595                         (cons arg result-list))))
1596                 '()
1597                 arg-list))
1598
1599   (interpret-markup layout
1600                     (prepend-alist-chain 'word-space 0 props)
1601                     (make-line-markup
1602                      (make-override-lines-markup-list
1603                       (cons 'word-space
1604                             (chain-assoc-get 'word-space props))
1605                       (if (markup-command-list? args)
1606                           args
1607                           (concat-string-args args))))))
1608
1609 (define (wordwrap-stencils stencils
1610                            justify base-space line-width text-dir)
1611   "Perform simple wordwrap, return stencil of each line."
1612   (define space (if justify
1613                     ;; justify only stretches lines.
1614                     (* 0.7 base-space)
1615                     base-space))
1616   (define (stencil-len s)
1617     (interval-end (ly:stencil-extent s X)))
1618   (define (maybe-shift line)
1619     (if (= text-dir LEFT)
1620         (ly:stencil-translate-axis
1621          line
1622          (- line-width (stencil-len line))
1623          X)
1624         line))
1625   (if (null? stencils)
1626       '()
1627       (let loop ((lines '())
1628                  (todo stencils))
1629         (let word-loop
1630             ((line (first todo))
1631              (todo (cdr todo))
1632              (word-list (list (first todo))))
1633           (cond
1634            ((pair? todo)
1635             (let ((new (if (= text-dir LEFT)
1636                            (ly:stencil-stack (car todo) X RIGHT line space)
1637                            (ly:stencil-stack line X RIGHT (car todo) space))))
1638               (cond
1639                ((<= (stencil-len new) line-width)
1640                 (word-loop new (cdr todo)
1641                            (cons (car todo) word-list)))
1642                (justify
1643                 (let* ((word-list
1644                         ;; This depends on stencil stacking being
1645                         ;; associative so that stacking
1646                         ;; left-to-right and right-to-left leads to
1647                         ;; the same result
1648                         (if (= text-dir LEFT)
1649                             word-list
1650                             (reverse! word-list)))
1651                        (len (stencil-len line))
1652                        (stretch (- line-width len))
1653                        (spaces
1654                         (- (stencil-len
1655                             (stack-stencils X RIGHT (1+ space) word-list))
1656                            len)))
1657                   (if (zero? spaces)
1658                       ;; Uh oh, nothing to fill.
1659                       (loop (cons (maybe-shift line) lines) todo)
1660                       (loop (cons
1661                              (stack-stencils X RIGHT
1662                                              (+ space (/ stretch spaces))
1663                                              word-list)
1664                              lines)
1665                             todo))))
1666                (else ;; not justify
1667                 (loop (cons (maybe-shift line) lines) todo)))))
1668            ;; todo is null
1669            (justify
1670             ;; Now we have the last line assembled with space
1671             ;; which is compressed.  We want to use the
1672             ;; uncompressed version instead if it fits, and the
1673             ;; justified version if it doesn't.
1674             (let* ((word-list
1675                     ;; This depends on stencil stacking being
1676                     ;; associative so that stacking
1677                     ;; left-to-right and right-to-left leads to
1678                     ;; the same result
1679                     (if (= text-dir LEFT)
1680                         word-list
1681                         (reverse! word-list)))
1682                    (big-line (stack-stencils X RIGHT base-space word-list))
1683                    (big-len (stencil-len big-line))
1684                    (len (stencil-len line)))
1685               (reverse! lines
1686                         (list
1687                          (if (> big-len line-width)
1688                              (stack-stencils X RIGHT
1689                                              (/
1690                                               (+
1691                                                (* (- big-len line-width)
1692                                                   space)
1693                                                (* (- line-width len)
1694                                                   base-space))
1695                                               (- big-len len))
1696                                              word-list)
1697                              (maybe-shift big-line))))))
1698            (else ;; not justify
1699             (reverse! lines (list (maybe-shift line)))))))))
1700
1701
1702 (define-markup-list-command (wordwrap-internal layout props justify args)
1703   (boolean? markup-list?)
1704   #:properties ((line-width #f)
1705                 (word-space)
1706                 (text-direction RIGHT))
1707   "Internal markup list command used to define @code{\\justify} and @code{\\wordwrap}."
1708   (wordwrap-stencils (interpret-markup-list layout props args)
1709                      justify
1710                      word-space
1711                      (or line-width
1712                          (ly:output-def-lookup layout 'line-width))
1713                      text-direction))
1714
1715 (define-markup-command (justify layout props args)
1716   (markup-list?)
1717   #:category align
1718   #:properties ((baseline-skip)
1719                 wordwrap-internal-markup-list)
1720   "
1721 @cindex justifying text
1722
1723 Like @code{\\wordwrap}, but with lines stretched to justify the margins.
1724 Use @code{\\override #'(line-width . @var{X})} to set the line width;
1725 @var{X}@tie{}is the number of staff spaces.
1726
1727 @lilypond[verbatim,quote]
1728 \\markup {
1729   \\justify {
1730     Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1731     do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1732     Ut enim ad minim veniam, quis nostrud exercitation ullamco
1733     laboris nisi ut aliquip ex ea commodo consequat.
1734   }
1735 }
1736 @end lilypond"
1737   (stack-lines DOWN 0.0 baseline-skip
1738                (wordwrap-internal-markup-list layout props #t args)))
1739
1740 (define-markup-command (wordwrap layout props args)
1741   (markup-list?)
1742   #:category align
1743   #:properties ((baseline-skip)
1744                 wordwrap-internal-markup-list)
1745   "Simple wordwrap.  Use @code{\\override #'(line-width . @var{X})} to set
1746 the line width, where @var{X} is the number of staff spaces.
1747
1748 @lilypond[verbatim,quote]
1749 \\markup {
1750   \\wordwrap {
1751     Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1752     do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1753     Ut enim ad minim veniam, quis nostrud exercitation ullamco
1754     laboris nisi ut aliquip ex ea commodo consequat.
1755   }
1756 }
1757 @end lilypond"
1758   (stack-lines DOWN 0.0 baseline-skip
1759                (wordwrap-internal-markup-list layout props #f args)))
1760
1761 (define-markup-list-command (wordwrap-string-internal layout props justify arg)
1762   (boolean? string?)
1763   #:properties ((line-width)
1764                 (word-space)
1765                 (text-direction RIGHT))
1766   "Internal markup list command used to define @code{\\justify-string} and
1767 @code{\\wordwrap-string}."
1768   (let* ((para-strings (regexp-split
1769                         (string-regexp-substitute
1770                          "\r" "\n"
1771                          (string-regexp-substitute "\r\n" "\n" arg))
1772                         "\n[ \t\n]*\n[ \t\n]*"))
1773          (list-para-words (map (lambda (str)
1774                                  (regexp-split str "[ \t\n]+"))
1775                                para-strings))
1776          (para-lines (map (lambda (words)
1777                             (let* ((stencils
1778                                     (map (lambda (x)
1779                                            (interpret-markup layout props x))
1780                                          words)))
1781                               (wordwrap-stencils stencils
1782                                                  justify word-space
1783                                                  line-width text-direction)))
1784                           list-para-words)))
1785     (concatenate para-lines)))
1786
1787 (define-markup-command (wordwrap-string layout props arg)
1788   (string?)
1789   #:category align
1790   #:properties ((baseline-skip)
1791                 wordwrap-string-internal-markup-list)
1792   "Wordwrap a string.  Paragraphs may be separated with double newlines.
1793
1794 @lilypond[verbatim,quote]
1795 \\markup {
1796   \\override #'(line-width . 40)
1797   \\wordwrap-string #\"Lorem ipsum dolor sit amet, consectetur
1798       adipisicing elit, sed do eiusmod tempor incididunt ut labore
1799       et dolore magna aliqua.
1800
1801
1802       Ut enim ad minim veniam, quis nostrud exercitation ullamco
1803       laboris nisi ut aliquip ex ea commodo consequat.
1804
1805
1806       Excepteur sint occaecat cupidatat non proident, sunt in culpa
1807       qui officia deserunt mollit anim id est laborum\"
1808 }
1809 @end lilypond"
1810   (stack-lines DOWN 0.0 baseline-skip
1811                (wordwrap-string-internal-markup-list layout props #f arg)))
1812
1813 (define-markup-command (justify-string layout props arg)
1814   (string?)
1815   #:category align
1816   #:properties ((baseline-skip)
1817                 wordwrap-string-internal-markup-list)
1818   "Justify a string.  Paragraphs may be separated with double newlines
1819
1820 @lilypond[verbatim,quote]
1821 \\markup {
1822   \\override #'(line-width . 40)
1823   \\justify-string #\"Lorem ipsum dolor sit amet, consectetur
1824       adipisicing elit, sed do eiusmod tempor incididunt ut labore
1825       et dolore magna aliqua.
1826
1827
1828       Ut enim ad minim veniam, quis nostrud exercitation ullamco
1829       laboris nisi ut aliquip ex ea commodo consequat.
1830
1831
1832       Excepteur sint occaecat cupidatat non proident, sunt in culpa
1833       qui officia deserunt mollit anim id est laborum\"
1834 }
1835 @end lilypond"
1836   (stack-lines DOWN 0.0 baseline-skip
1837                (wordwrap-string-internal-markup-list layout props #t arg)))
1838
1839 (define-markup-command (wordwrap-field layout props symbol)
1840   (symbol?)
1841   #:category align
1842   "Wordwrap the data which has been assigned to @var{symbol}.
1843
1844 @lilypond[verbatim,quote]
1845 \\header {
1846   title = \"My title\"
1847   myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1848     elit, sed do eiusmod tempor incididunt ut labore et dolore
1849     magna aliqua.  Ut enim ad minim veniam, quis nostrud
1850     exercitation ullamco laboris nisi ut aliquip ex ea commodo
1851     consequat.\"
1852 }
1853
1854 \\paper {
1855   bookTitleMarkup = \\markup {
1856     \\column {
1857       \\fill-line { \\fromproperty #'header:title }
1858       \\null
1859       \\wordwrap-field #'header:myText
1860     }
1861   }
1862 }
1863
1864 \\markup {
1865   \\null
1866 }
1867 @end lilypond"
1868   (let* ((m (chain-assoc-get symbol props)))
1869     (if (string? m)
1870         (wordwrap-string-markup layout props m)
1871         empty-stencil)))
1872
1873 (define-markup-command (justify-field layout props symbol)
1874   (symbol?)
1875   #:category align
1876   "Justify the data which has been assigned to @var{symbol}.
1877
1878 @lilypond[verbatim,quote]
1879 \\header {
1880   title = \"My title\"
1881   myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1882     elit, sed do eiusmod tempor incididunt ut labore et dolore magna
1883     aliqua.  Ut enim ad minim veniam, quis nostrud exercitation ullamco
1884     laboris nisi ut aliquip ex ea commodo consequat.\"
1885 }
1886
1887 \\paper {
1888   bookTitleMarkup = \\markup {
1889     \\column {
1890       \\fill-line { \\fromproperty #'header:title }
1891       \\null
1892       \\justify-field #'header:myText
1893     }
1894   }
1895 }
1896
1897 \\markup {
1898   \\null
1899 }
1900 @end lilypond"
1901   (let* ((m (chain-assoc-get symbol props)))
1902     (if (string? m)
1903         (justify-string-markup layout props m)
1904         empty-stencil)))
1905
1906 (define-markup-command (combine layout props arg1 arg2)
1907   (markup? markup?)
1908   #:category align
1909   "
1910 @cindex merging text
1911
1912 Print two markups on top of each other.
1913
1914 Note: @code{\\combine} cannot take a list of markups enclosed in
1915 curly braces as an argument; for this purpose use @code{\\overlay} instead.
1916
1917 @lilypond[verbatim,quote]
1918 \\markup {
1919   \\fontsize #5
1920   \\override #'(thickness . 2)
1921   \\combine
1922     \\draw-line #'(0 . 4)
1923     \\arrow-head #Y #DOWN ##f
1924 }
1925 @end lilypond"
1926   (let* ((s1 (interpret-markup layout props arg1))
1927          (s2 (interpret-markup layout props arg2)))
1928     (ly:stencil-add s1 s2)))
1929
1930 (define-markup-command (overlay layout props args)
1931   (markup-list?)
1932   #:category align
1933   "
1934 @cindex merging text
1935
1936 Takes a list of markups combining them.
1937
1938 @lilypond[verbatim,quote]
1939 \\markup {
1940   \\fontsize #5
1941   \\override #'(thickness . 2)
1942   \\overlay {
1943     \\draw-line #'(0 . 4)
1944     \\arrow-head #Y #DOWN ##f
1945     \\translate #'(0 . 4)\\arrow-head #Y #UP ##f
1946   }
1947 }
1948 @end lilypond"
1949   (apply ly:stencil-add (interpret-markup-list layout props args)))
1950
1951 ;;
1952 ;; TODO: should extract baseline-skip from each argument somehow..
1953 ;;
1954 (define-markup-command (column layout props args)
1955   (markup-list?)
1956   #:category align
1957   #:properties ((baseline-skip))
1958   "
1959 @cindex stacking text in a column
1960
1961 Stack the markups in @var{args} vertically.  The property
1962 @code{baseline-skip} determines the space between markups
1963 in @var{args}.
1964
1965 @lilypond[verbatim,quote]
1966 \\markup {
1967   \\column {
1968     one
1969     two
1970     three
1971   }
1972 }
1973 @end lilypond"
1974   (let ((arg-stencils (interpret-markup-list layout props args)))
1975     (stack-lines -1 0.0 baseline-skip arg-stencils)))
1976
1977 (define-markup-command (dir-column layout props args)
1978   (markup-list?)
1979   #:category align
1980   #:properties ((direction)
1981                 (baseline-skip))
1982   "
1983 @cindex changing direction of text columns
1984
1985 Make a column of @var{args}, going up or down, depending on the
1986 setting of the @code{direction} layout property.
1987
1988 @lilypond[verbatim,quote]
1989 \\markup {
1990   \\override #`(direction . ,UP) {
1991     \\dir-column {
1992       going up
1993     }
1994   }
1995   \\hspace #1
1996   \\dir-column {
1997     going down
1998   }
1999   \\hspace #1
2000   \\override #'(direction . 1) {
2001     \\dir-column {
2002       going up
2003     }
2004   }
2005 }
2006 @end lilypond"
2007   (stack-lines (if (number? direction) direction -1)
2008                0.0
2009                baseline-skip
2010                (interpret-markup-list layout props args)))
2011
2012 (define (general-column align-dir baseline mols)
2013   "Stack @var{mols} vertically, aligned to  @var{align-dir} horizontally."
2014
2015   (let* ((aligned-mols (map (lambda (x) (ly:stencil-aligned-to x X align-dir)) mols))
2016          (stacked-stencil (stack-lines -1 0.0 baseline aligned-mols))
2017          (stacked-extent (ly:stencil-extent stacked-stencil X)))
2018     (ly:stencil-translate-axis stacked-stencil (- (car stacked-extent)) X )))
2019
2020 (define-markup-command (center-column layout props args)
2021   (markup-list?)
2022   #:category align
2023   #:properties ((baseline-skip))
2024   "
2025 @cindex centering a column of text
2026
2027 Put @code{args} in a centered column.
2028
2029 @lilypond[verbatim,quote]
2030 \\markup {
2031   \\center-column {
2032     one
2033     two
2034     three
2035   }
2036 }
2037 @end lilypond"
2038   (general-column CENTER baseline-skip (interpret-markup-list layout props args)))
2039
2040 (define-markup-command (left-column layout props args)
2041   (markup-list?)
2042   #:category align
2043   #:properties ((baseline-skip))
2044   "
2045 @cindex text columns, left-aligned
2046
2047 Put @code{args} in a left-aligned column.
2048
2049 @lilypond[verbatim,quote]
2050 \\markup {
2051   \\left-column {
2052     one
2053     two
2054     three
2055   }
2056 }
2057 @end lilypond"
2058   (general-column LEFT baseline-skip (interpret-markup-list layout props args)))
2059
2060 (define-markup-command (right-column layout props args)
2061   (markup-list?)
2062   #:category align
2063   #:properties ((baseline-skip))
2064   "
2065 @cindex text columns, right-aligned
2066
2067 Put @code{args} in a right-aligned column.
2068
2069 @lilypond[verbatim,quote]
2070 \\markup {
2071   \\right-column {
2072     one
2073     two
2074     three
2075   }
2076 }
2077 @end lilypond"
2078   (general-column RIGHT baseline-skip (interpret-markup-list layout props args)))
2079
2080 (define-markup-command (vcenter layout props arg)
2081   (markup?)
2082   #:category align
2083   "
2084 @cindex vertically centering text
2085
2086 Align @code{arg} to its Y@tie{}center.
2087
2088 @lilypond[verbatim,quote]
2089 \\markup {
2090   one
2091   \\vcenter
2092   two
2093   three
2094 }
2095 @end lilypond"
2096   (let* ((mol (interpret-markup layout props arg)))
2097     (ly:stencil-aligned-to mol Y CENTER)))
2098
2099 (define-markup-command (center-align layout props arg)
2100   (markup?)
2101   #:category align
2102   "
2103 @cindex horizontally centering text
2104
2105 Align @code{arg} to its X@tie{}center.
2106
2107 @lilypond[verbatim,quote]
2108 \\markup {
2109   \\column {
2110     one
2111     \\center-align
2112     two
2113     three
2114   }
2115 }
2116 @end lilypond"
2117   (let* ((mol (interpret-markup layout props arg)))
2118     (ly:stencil-aligned-to mol X CENTER)))
2119
2120 (define-markup-command (right-align layout props arg)
2121   (markup?)
2122   #:category align
2123   "
2124 @cindex right aligning text
2125
2126 Align @var{arg} on its right edge.
2127
2128 @lilypond[verbatim,quote]
2129 \\markup {
2130   \\column {
2131     one
2132     \\right-align
2133     two
2134     three
2135   }
2136 }
2137 @end lilypond"
2138   (let* ((m (interpret-markup layout props arg)))
2139     (ly:stencil-aligned-to m X RIGHT)))
2140
2141 (define-markup-command (left-align layout props arg)
2142   (markup?)
2143   #:category align
2144   "
2145 @cindex left aligning text
2146
2147 Align @var{arg} on its left edge.
2148
2149 @lilypond[verbatim,quote]
2150 \\markup {
2151   \\column {
2152     one
2153     \\left-align
2154     two
2155     three
2156   }
2157 }
2158 @end lilypond"
2159   (let* ((m (interpret-markup layout props arg)))
2160     (ly:stencil-aligned-to m X LEFT)))
2161
2162 (define-markup-command (general-align layout props axis dir arg)
2163   (integer? number? markup?)
2164   #:category align
2165   "
2166 @cindex controlling general text alignment
2167
2168 Align @var{arg} in @var{axis} direction to the @var{dir} side.
2169
2170 @lilypond[verbatim,quote]
2171 \\markup {
2172   \\column {
2173     one
2174     \\general-align #X #LEFT
2175     two
2176     three
2177     \\null
2178     one
2179     \\general-align #X #CENTER
2180     two
2181     three
2182     \\null
2183     \\line {
2184       one
2185       \\general-align #Y #UP
2186       two
2187       three
2188     }
2189     \\null
2190     \\line {
2191       one
2192       \\general-align #Y #3.2
2193       two
2194       three
2195     }
2196   }
2197 }
2198 @end lilypond"
2199   (let* ((m (interpret-markup layout props arg)))
2200     (ly:stencil-aligned-to m axis dir)))
2201
2202 (define-markup-command (halign layout props dir arg)
2203   (number? markup?)
2204   #:category align
2205   "
2206 @cindex setting horizontal text alignment
2207
2208 Set horizontal alignment.  If @var{dir} is @w{@code{-1}}, then it is
2209 left-aligned, while @code{+1} is right.  Values in between interpolate
2210 alignment accordingly.
2211
2212 @lilypond[verbatim,quote]
2213 \\markup {
2214   \\column {
2215     one
2216     \\halign #LEFT
2217     two
2218     three
2219     \\null
2220     one
2221     \\halign #CENTER
2222     two
2223     three
2224     \\null
2225     one
2226     \\halign #RIGHT
2227     two
2228     three
2229     \\null
2230     one
2231     \\halign #-5
2232     two
2233     three
2234   }
2235 }
2236 @end lilypond"
2237   (let* ((m (interpret-markup layout props arg)))
2238     (ly:stencil-aligned-to m X dir)))
2239
2240 (define-markup-command (with-dimensions layout props x y arg)
2241   (number-pair? number-pair? markup?)
2242   #:category other
2243   "
2244 @cindex setting extent of text objects
2245
2246 Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}."
2247   (let* ((expr (ly:stencil-expr (interpret-markup layout props arg))))
2248     (ly:stencil-add
2249      (make-transparent-box-stencil x y)
2250      (ly:make-stencil
2251       `(delay-stencil-evaluation ,(delay expr))
2252       x y))))
2253
2254 (define-markup-command (with-dimensions-from layout props arg1 arg2)
2255   (markup? markup?)
2256   #:category other
2257   "
2258 Print @var{arg2} with the dimensions of @var{arg1}."
2259   (let* ((stil1 (interpret-markup layout props arg1))
2260          (x (ly:stencil-extent stil1 0))
2261          (y (ly:stencil-extent stil1 1)))
2262     (interpret-markup layout props (markup #:with-dimensions x y arg2))))
2263
2264 (define-markup-command (pad-around layout props amount arg)
2265   (number? markup?)
2266   #:category align
2267   "Add padding @var{amount} all around @var{arg}.
2268
2269 @lilypond[verbatim,quote]
2270 \\markup {
2271   \\box {
2272     default
2273   }
2274   \\hspace #2
2275   \\box {
2276     \\pad-around #0.5 {
2277       padded
2278     }
2279   }
2280 }
2281 @end lilypond"
2282   (let* ((m (interpret-markup layout props arg))
2283          (x (interval-widen (ly:stencil-extent m X) amount))
2284          (y (interval-widen (ly:stencil-extent m Y) amount)))
2285     (ly:stencil-add (make-transparent-box-stencil x y)
2286                     m)))
2287
2288 (define-markup-command (pad-x layout props amount arg)
2289   (number? markup?)
2290   #:category align
2291   "
2292 @cindex padding text horizontally
2293
2294 Add padding @var{amount} around @var{arg} in the X@tie{}direction.
2295
2296 @lilypond[verbatim,quote]
2297 \\markup {
2298   \\box {
2299     default
2300   }
2301   \\hspace #4
2302   \\box {
2303     \\pad-x #2 {
2304       padded
2305     }
2306   }
2307 }
2308 @end lilypond"
2309   (let* ((m (interpret-markup layout props arg))
2310          (x (ly:stencil-extent m X))
2311          (y (ly:stencil-extent m Y)))
2312     (ly:make-stencil (ly:stencil-expr m)
2313                      (interval-widen x amount)
2314                      y)))
2315
2316 (define-markup-command (put-adjacent layout props axis dir arg1 arg2)
2317   (integer? ly:dir? markup? markup?)
2318   #:category align
2319   "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}."
2320   (let ((m1 (interpret-markup layout props arg1))
2321         (m2 (interpret-markup layout props arg2)))
2322     (ly:stencil-combine-at-edge m1 axis dir m2 0.0)))
2323
2324 (define-markup-command (transparent layout props arg)
2325   (markup?)
2326   #:category other
2327   "Make @var{arg} transparent.
2328
2329 @lilypond[verbatim,quote]
2330 \\markup {
2331   \\transparent {
2332     invisible text
2333   }
2334 }
2335 @end lilypond"
2336   (let* ((m (interpret-markup layout props arg))
2337          (x (ly:stencil-extent m X))
2338          (y (ly:stencil-extent m Y)))
2339     (ly:make-stencil (list 'transparent-stencil (ly:stencil-expr m)) x y)))
2340
2341 (define-markup-command (pad-to-box layout props x-ext y-ext arg)
2342   (number-pair? number-pair? markup?)
2343   #:category align
2344   "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space.
2345
2346 @lilypond[verbatim,quote]
2347 \\markup {
2348   \\box {
2349     default
2350   }
2351   \\hspace #4
2352   \\box {
2353     \\pad-to-box #'(0 . 10) #'(0 . 3) {
2354       padded
2355     }
2356   }
2357 }
2358 @end lilypond"
2359   (ly:stencil-add (make-transparent-box-stencil x-ext y-ext)
2360                   (interpret-markup layout props arg)))
2361
2362 (define-markup-command (hcenter-in layout props length arg)
2363   (number? markup?)
2364   #:category align
2365   "Center @var{arg} horizontally within a box of extending
2366 @var{length}/2 to the left and right.
2367
2368 @lilypond[quote,verbatim]
2369 \\new StaffGroup <<
2370   \\new Staff {
2371     \\set Staff.instrumentName = \\markup {
2372       \\hcenter-in #12
2373       Oboe
2374     }
2375     c''1
2376   }
2377   \\new Staff {
2378     \\set Staff.instrumentName = \\markup {
2379       \\hcenter-in #12
2380       Bassoon
2381     }
2382     \\clef tenor
2383     c'1
2384   }
2385 >>
2386 @end lilypond"
2387   (interpret-markup layout props
2388                     (make-pad-to-box-markup
2389                      (cons (/ length -2) (/ length 2))
2390                      '(0 . 0)
2391                      (make-center-align-markup arg))))
2392
2393 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2394 ;; property
2395 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2396
2397 (define-markup-command (property-recursive layout props symbol)
2398   (symbol?)
2399   #:category other
2400   "Print out a warning when a header field markup contains some recursive
2401 markup definition."
2402   (ly:warning "Recursive definition of property ~a detected!" symbol)
2403   empty-stencil)
2404
2405 (define-markup-command (fromproperty layout props symbol)
2406   (symbol?)
2407   #:category other
2408   "Read the @var{symbol} from property settings, and produce a stencil
2409 from the markup contained within.  If @var{symbol} is not defined, it
2410 returns an empty markup.
2411
2412 @lilypond[verbatim,quote]
2413 \\header {
2414   myTitle = \"myTitle\"
2415   title = \\markup {
2416     from
2417     \\italic
2418     \\fromproperty #'header:myTitle
2419   }
2420 }
2421 \\markup {
2422   \\null
2423 }
2424 @end lilypond"
2425   (let ((m (chain-assoc-get symbol props)))
2426     (if (markup? m)
2427         ;; prevent infinite loops by clearing the interpreted property:
2428         (interpret-markup layout (cons (list (cons symbol `(,property-recursive-markup ,symbol))) props) m)
2429         empty-stencil)))
2430
2431 (define-markup-command (on-the-fly layout props procedure arg)
2432   (procedure? markup?)
2433   #:category other
2434   "Apply the @var{procedure} markup command to @var{arg}.
2435 @var{procedure} takes the same arguments as @code{interpret-markup}
2436 and returns a stencil."
2437   (procedure layout props arg))
2438
2439 (define-markup-command (footnote layout props mkup note)
2440   (markup? markup?)
2441   #:category other
2442   "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
2443
2444 @lilypond[verbatim,quote]
2445 \\markup {
2446   \\auto-footnote a b
2447   \\override #'(padding . 0.2)
2448   \\auto-footnote c d
2449 }
2450 @end lilypond
2451 The footnote will not be annotated automatically."
2452   (ly:stencil-combine-at-edge
2453    (interpret-markup layout props mkup)
2454    X
2455    RIGHT
2456    (ly:make-stencil
2457     `(footnote (gensym "footnote") #f ,(interpret-markup layout props note))
2458     '(0 . 0)
2459     '(0 . 0))
2460    0.0))
2461
2462 (define-markup-command (auto-footnote layout props mkup note)
2463   (markup? markup?)
2464   #:category other
2465   #:properties ((raise 0.5)
2466                 (padding 0.0))
2467   "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
2468
2469 @lilypond[verbatim,quote]
2470 \\markup {
2471   \\auto-footnote a b
2472   \\override #'(padding . 0.2)
2473   \\auto-footnote c d
2474 }
2475 @end lilypond
2476 The footnote will be annotated automatically."
2477   (let* ((markup-stencil (interpret-markup layout props mkup))
2478          (footnote-hash (gensym "footnote"))
2479          (stencil-seed 0)
2480          (gauge-stencil (interpret-markup
2481                          layout
2482                          props
2483                          ((ly:output-def-lookup
2484                            layout
2485                            'footnote-numbering-function)
2486                           stencil-seed)))
2487          (x-ext (ly:stencil-extent gauge-stencil X))
2488          (y-ext (ly:stencil-extent gauge-stencil Y))
2489          (footnote-number
2490           `(delay-stencil-evaluation
2491             ,(delay
2492                (ly:stencil-expr
2493                 (let* ((table
2494                         (ly:output-def-lookup layout
2495                                               'number-footnote-table))
2496                        (footnote-stencil (if (list? table)
2497                                              (assoc-get footnote-hash
2498                                                         table)
2499                                              empty-stencil))
2500                        (footnote-stencil (if (ly:stencil? footnote-stencil)
2501                                              footnote-stencil
2502                                              (begin
2503                                                (ly:programming-error
2504                                                 "Cannot find correct footnote for a markup object.")
2505                                                empty-stencil)))
2506                        (gap (- (interval-length x-ext)
2507                                (interval-length
2508                                 (ly:stencil-extent footnote-stencil X))))
2509                        (y-trans (- (+ (cdr y-ext)
2510                                       raise)
2511                                    (cdr (ly:stencil-extent footnote-stencil
2512                                                            Y)))))
2513                   (ly:stencil-translate footnote-stencil
2514                                         (cons gap y-trans)))))))
2515          (main-stencil (ly:stencil-combine-at-edge
2516                         markup-stencil
2517                         X
2518                         RIGHT
2519                         (ly:make-stencil footnote-number x-ext y-ext)
2520                         padding)))
2521     (ly:stencil-add
2522      main-stencil
2523      (ly:make-stencil
2524       `(footnote ,footnote-hash #t ,(interpret-markup layout props note))
2525       '(0 . 0)
2526       '(0 . 0)))))
2527
2528 (define-markup-command (override layout props new-prop arg)
2529   (pair? markup?)
2530   #:category other
2531   "
2532 @cindex overriding properties within text markup
2533
2534 Add the argument @var{new-prop} to the property list.  Properties
2535 may be any property supported by @rinternals{font-interface},
2536 @rinternals{text-interface} and
2537 @rinternals{instrument-specific-markup-interface}.
2538
2539 @lilypond[verbatim,quote]
2540 \\markup {
2541   \\line {
2542     \\column {
2543       default
2544       baseline-skip
2545     }
2546     \\hspace #2
2547     \\override #'(baseline-skip . 4) {
2548       \\column {
2549         increased
2550         baseline-skip
2551       }
2552     }
2553   }
2554 }
2555 @end lilypond"
2556   (interpret-markup layout (cons (list new-prop) props) arg))
2557
2558 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2559 ;; files
2560 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2561
2562 (define-markup-command (verbatim-file layout props name)
2563   (string?)
2564   #:category other
2565   "Read the contents of file @var{name}, and include it verbatim.
2566
2567 @lilypond[verbatim,quote]
2568 \\markup {
2569   \\verbatim-file #\"simple.ly\"
2570 }
2571 @end lilypond"
2572   (interpret-markup layout props
2573                     (if  (ly:get-option 'safe)
2574                          "verbatim-file disabled in safe mode"
2575                          (let* ((str (ly:gulp-file name))
2576                                 (lines (string-split str #\nl)))
2577                            (make-typewriter-markup
2578                             (make-column-markup lines))))))
2579
2580 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2581 ;; fonts.
2582 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2583
2584
2585 (define-markup-command (smaller layout props arg)
2586   (markup?)
2587   #:category font
2588   "Decrease the font size relative to the current setting.
2589
2590 @lilypond[verbatim,quote]
2591 \\markup {
2592   \\fontsize #3.5 {
2593     some large text
2594     \\hspace #2
2595     \\smaller {
2596       a bit smaller
2597     }
2598     \\hspace #2
2599     more large text
2600   }
2601 }
2602 @end lilypond"
2603   (interpret-markup layout props
2604                     `(,fontsize-markup -1 ,arg)))
2605
2606 (define-markup-command (larger layout props arg)
2607   (markup?)
2608   #:category font
2609   "Increase the font size relative to the current setting.
2610
2611 @lilypond[verbatim,quote]
2612 \\markup {
2613   default
2614   \\hspace #2
2615   \\larger
2616   larger
2617 }
2618 @end lilypond"
2619   (interpret-markup layout props
2620                     `(,fontsize-markup 1 ,arg)))
2621
2622 (define-markup-command (finger layout props arg)
2623   (markup?)
2624   #:category font
2625   "Set @var{arg} as small numbers.
2626
2627 @lilypond[verbatim,quote]
2628 \\markup {
2629   \\finger {
2630     1 2 3 4 5
2631   }
2632 }
2633 @end lilypond"
2634   (interpret-markup layout
2635                     (cons '((font-size . -5) (font-encoding . fetaText)) props)
2636                     arg))
2637
2638 (define-markup-command (abs-fontsize layout props size arg)
2639   (number? markup?)
2640   #:category font
2641   "Use @var{size} as the absolute font size (in points) to display @var{arg}.
2642 Adjusts @code{baseline-skip} and @code{word-space} accordingly.
2643
2644 @lilypond[verbatim,quote]
2645 \\markup {
2646   default text font size
2647   \\hspace #2
2648   \\abs-fontsize #16 { text font size 16 }
2649   \\hspace #2
2650   \\abs-fontsize #12 { text font size 12 }
2651 }
2652 @end lilypond"
2653   (let* ((ref-size (ly:output-def-lookup layout 'text-font-size 12))
2654          (text-props (list (ly:output-def-lookup layout 'text-font-defaults)))
2655          (ref-word-space (chain-assoc-get 'word-space text-props 0.6))
2656          (ref-baseline (chain-assoc-get 'baseline-skip text-props 3))
2657          (magnification (/ size ref-size)))
2658     (interpret-markup
2659      layout
2660      (cons
2661       `((baseline-skip . ,(* magnification ref-baseline))
2662         (word-space . ,(* magnification ref-word-space))
2663         (font-size . ,(magnification->font-size magnification)))
2664       props)
2665      arg)))
2666
2667 (define-markup-command (fontsize layout props increment arg)
2668   (number? markup?)
2669   #:category font
2670   #:properties ((font-size 0)
2671                 (word-space 1)
2672                 (baseline-skip 2))
2673   "Add @var{increment} to the font-size.  Adjusts @code{baseline-skip}
2674 accordingly.
2675
2676 @lilypond[verbatim,quote]
2677 \\markup {
2678   default
2679   \\hspace #2
2680   \\fontsize #-1.5
2681   smaller
2682 }
2683 @end lilypond"
2684   (interpret-markup
2685    layout
2686    (cons
2687     `((baseline-skip . ,(* baseline-skip (magstep increment)))
2688       (word-space . ,(* word-space (magstep increment)))
2689       (font-size . ,(+ font-size increment)))
2690     props)
2691    arg))
2692
2693 (define-markup-command (magnify layout props sz arg)
2694   (number? markup?)
2695   #:category font
2696   "
2697 @cindex magnifying text
2698
2699 Set the font magnification for its argument.  In the following
2700 example, the middle@tie{}A is 10% larger:
2701
2702 @example
2703 A \\magnify #1.1 @{ A @} A
2704 @end example
2705
2706 Note: Magnification only works if a font name is explicitly selected.
2707 Use @code{\\fontsize} otherwise.
2708
2709 @lilypond[verbatim,quote]
2710 \\markup {
2711   default
2712   \\hspace #2
2713   \\magnify #1.5 {
2714     50% larger
2715   }
2716 }
2717 @end lilypond"
2718   (interpret-markup
2719    layout
2720    (prepend-alist-chain 'font-size (magnification->font-size sz) props)
2721    arg))
2722
2723 (define-markup-command (bold layout props arg)
2724   (markup?)
2725   #:category font
2726   "Switch to bold font-series.
2727
2728 @lilypond[verbatim,quote]
2729 \\markup {
2730   default
2731   \\hspace #2
2732   \\bold
2733   bold
2734 }
2735 @end lilypond"
2736   (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
2737
2738 (define-markup-command (sans layout props arg)
2739   (markup?)
2740   #:category font
2741   "Switch to the sans serif font family.
2742
2743 @lilypond[verbatim,quote]
2744 \\markup {
2745   default
2746   \\hspace #2
2747   \\sans {
2748     sans serif
2749   }
2750 }
2751 @end lilypond"
2752   (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
2753
2754 (define-markup-command (number layout props arg)
2755   (markup?)
2756   #:category font
2757   "Set font family to @code{number}, which yields the font used for
2758 time signatures and fingerings.  This font contains numbers and
2759 some punctuation; it has no letters.
2760
2761 @lilypond[verbatim,quote]
2762 \\markup {
2763   \\number {
2764     0 1 2 3 4 5 6 7 8 9 . ,
2765   }
2766 }
2767 @end lilypond"
2768   (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2769
2770 (define-markup-command (roman layout props arg)
2771   (markup?)
2772   #:category font
2773   "Set font family to @code{roman}.
2774
2775 @lilypond[verbatim,quote]
2776 \\markup {
2777   \\sans \\bold {
2778     sans serif, bold
2779     \\hspace #2
2780     \\roman {
2781       text in roman font family
2782     }
2783     \\hspace #2
2784     return to sans
2785   }
2786 }
2787 @end lilypond"
2788   (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
2789
2790 (define-markup-command (huge layout props arg)
2791   (markup?)
2792   #:category font
2793   "Set font size to +2.
2794
2795 @lilypond[verbatim,quote]
2796 \\markup {
2797   default
2798   \\hspace #2
2799   \\huge
2800   huge
2801 }
2802 @end lilypond"
2803   (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
2804
2805 (define-markup-command (large layout props arg)
2806   (markup?)
2807   #:category font
2808   "Set font size to +1.
2809
2810 @lilypond[verbatim,quote]
2811 \\markup {
2812   default
2813   \\hspace #2
2814   \\large
2815   large
2816 }
2817 @end lilypond"
2818   (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
2819
2820 (define-markup-command (normalsize layout props arg)
2821   (markup?)
2822   #:category font
2823   "Set font size to default.
2824
2825 @lilypond[verbatim,quote]
2826 \\markup {
2827   \\teeny {
2828     this is very small
2829     \\hspace #2
2830     \\normalsize {
2831       normal size
2832     }
2833     \\hspace #2
2834     teeny again
2835   }
2836 }
2837 @end lilypond"
2838   (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
2839
2840 (define-markup-command (small layout props arg)
2841   (markup?)
2842   #:category font
2843   "Set font size to -1.
2844
2845 @lilypond[verbatim,quote]
2846 \\markup {
2847   default
2848   \\hspace #2
2849   \\small
2850   small
2851 }
2852 @end lilypond"
2853   (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
2854
2855 (define-markup-command (tiny layout props arg)
2856   (markup?)
2857   #:category font
2858   "Set font size to -2.
2859
2860 @lilypond[verbatim,quote]
2861 \\markup {
2862   default
2863   \\hspace #2
2864   \\tiny
2865   tiny
2866 }
2867 @end lilypond"
2868   (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
2869
2870 (define-markup-command (teeny layout props arg)
2871   (markup?)
2872   #:category font
2873   "Set font size to -3.
2874
2875 @lilypond[verbatim,quote]
2876 \\markup {
2877   default
2878   \\hspace #2
2879   \\teeny
2880   teeny
2881 }
2882 @end lilypond"
2883   (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
2884
2885 (define-markup-command (fontCaps layout props arg)
2886   (markup?)
2887   #:category font
2888   "Set @code{font-shape} to @code{caps}
2889
2890 Note: @code{\\fontCaps} requires the installation and selection of
2891 fonts which support the @code{caps} font shape."
2892   (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
2893
2894 ;; Poor man's caps
2895 (define-markup-command (smallCaps layout props arg)
2896   (markup?)
2897   #:category font
2898   "Emit @var{arg} as small caps.
2899
2900 Note: @code{\\smallCaps} does not support accented characters.
2901
2902 @lilypond[verbatim,quote]
2903 \\markup {
2904   default
2905   \\hspace #2
2906   \\smallCaps {
2907     Text in small caps
2908   }
2909 }
2910 @end lilypond"
2911   (define (char-list->markup chars lower)
2912     (let ((final-string (string-upcase (reverse-list->string chars))))
2913       (if lower
2914           (markup #:fontsize -2 final-string)
2915           final-string)))
2916   (define (make-small-caps rest-chars currents current-is-lower prev-result)
2917     (if (null? rest-chars)
2918         (make-concat-markup
2919          (reverse! (cons (char-list->markup currents current-is-lower)
2920                          prev-result)))
2921         (let* ((ch (car rest-chars))
2922                (is-lower (char-lower-case? ch)))
2923           (if (or (and current-is-lower is-lower)
2924                   (and (not current-is-lower) (not is-lower)))
2925               (make-small-caps (cdr rest-chars)
2926                                (cons ch currents)
2927                                is-lower
2928                                prev-result)
2929               (make-small-caps (cdr rest-chars)
2930                                (list ch)
2931                                is-lower
2932                                (if (null? currents)
2933                                    prev-result
2934                                    (cons (char-list->markup
2935                                           currents current-is-lower)
2936                                          prev-result)))))))
2937   (interpret-markup layout props
2938                     (if (string? arg)
2939                         (make-small-caps (string->list arg) (list) #f (list))
2940                         arg)))
2941
2942 (define-markup-command (caps layout props arg)
2943   (markup?)
2944   #:category font
2945   "Copy of the @code{\\smallCaps} command.
2946
2947 @lilypond[verbatim,quote]
2948 \\markup {
2949   default
2950   \\hspace #2
2951   \\caps {
2952     Text in small caps
2953   }
2954 }
2955 @end lilypond"
2956   (interpret-markup layout props (make-smallCaps-markup arg)))
2957
2958 (define-markup-command (dynamic layout props arg)
2959   (markup?)
2960   #:category font
2961   "Use the dynamic font.  This font only contains @b{s}, @b{f}, @b{m},
2962 @b{z}, @b{p}, and @b{r}.  When producing phrases, like
2963 @q{pi@`{u}@tie{}@b{f}}, the normal words (like @q{pi@`{u}}) should be
2964 done in a different font.  The recommended font for this is bold and italic.
2965 @lilypond[verbatim,quote]
2966 \\markup {
2967   \\dynamic {
2968     sfzp
2969   }
2970 }
2971 @end lilypond"
2972   (interpret-markup
2973    layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2974
2975 (define-markup-command (text layout props arg)
2976   (markup?)
2977   #:category font
2978   "Use a text font instead of music symbol or music alphabet font.
2979
2980 @lilypond[verbatim,quote]
2981 \\markup {
2982   \\number {
2983     1, 2,
2984     \\text {
2985       three, four,
2986     }
2987     5
2988   }
2989 }
2990 @end lilypond"
2991
2992   ;; ugh - latin1
2993   (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
2994                     arg))
2995
2996 (define-markup-command (italic layout props arg)
2997   (markup?)
2998   #:category font
2999   "Use italic @code{font-shape} for @var{arg}.
3000
3001 @lilypond[verbatim,quote]
3002 \\markup {
3003   default
3004   \\hspace #2
3005   \\italic
3006   italic
3007 }
3008 @end lilypond"
3009   (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
3010
3011 (define-markup-command (typewriter layout props arg)
3012   (markup?)
3013   #:category font
3014   "Use @code{font-family} typewriter for @var{arg}.
3015
3016 @lilypond[verbatim,quote]
3017 \\markup {
3018   default
3019   \\hspace #2
3020   \\typewriter
3021   typewriter
3022 }
3023 @end lilypond"
3024   (interpret-markup
3025    layout (prepend-alist-chain 'font-family 'typewriter props) arg))
3026
3027 (define-markup-command (upright layout props arg)
3028   (markup?)
3029   #:category font
3030   "Set @code{font-shape} to @code{upright}.  This is the opposite
3031 of @code{italic}.
3032
3033 @lilypond[verbatim,quote]
3034 \\markup {
3035   \\italic {
3036     italic text
3037     \\hspace #2
3038     \\upright {
3039       upright text
3040     }
3041     \\hspace #2
3042     italic again
3043   }
3044 }
3045 @end lilypond"
3046   (interpret-markup
3047    layout (prepend-alist-chain 'font-shape 'upright props) arg))
3048
3049 (define-markup-command (medium layout props arg)
3050   (markup?)
3051   #:category font
3052   "Switch to medium font-series (in contrast to bold).
3053
3054 @lilypond[verbatim,quote]
3055 \\markup {
3056   \\bold {
3057     some bold text
3058     \\hspace #2
3059     \\medium {
3060       medium font series
3061     }
3062     \\hspace #2
3063     bold again
3064   }
3065 }
3066 @end lilypond"
3067   (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
3068                     arg))
3069
3070 (define-markup-command (normal-text layout props arg)
3071   (markup?)
3072   #:category font
3073   "Set all font related properties (except the size) to get the default
3074 normal text font, no matter what font was used earlier.
3075
3076 @lilypond[verbatim,quote]
3077 \\markup {
3078   \\huge \\bold \\sans \\caps {
3079     huge bold sans caps
3080     \\hspace #2
3081     \\normal-text {
3082       huge normal
3083     }
3084     \\hspace #2
3085     as before
3086   }
3087 }
3088 @end lilypond"
3089   ;; ugh - latin1
3090   (interpret-markup layout
3091                     (cons '((font-family . roman) (font-shape . upright)
3092                             (font-series . medium) (font-encoding . latin1))
3093                           props)
3094                     arg))
3095
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3097 ;; symbols.
3098 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3099
3100 (define-markup-command (musicglyph layout props glyph-name)
3101   (string?)
3102   #:category music
3103   "@var{glyph-name} is converted to a musical symbol; for example,
3104 @code{\\musicglyph #\"accidentals.natural\"} selects the natural sign from
3105 the music font.  See @ruser{The Feta font} for a complete listing of
3106 the possible glyphs.
3107
3108 @lilypond[verbatim,quote]
3109 \\markup {
3110   \\musicglyph #\"f\"
3111   \\musicglyph #\"rests.2\"
3112   \\musicglyph #\"clefs.G_change\"
3113 }
3114 @end lilypond"
3115   (let* ((font (ly:paper-get-font layout
3116                                   (cons '((font-encoding . fetaMusic)
3117                                           (font-name . #f))
3118
3119                                         props)))
3120          (glyph (ly:font-get-glyph font glyph-name)))
3121     (if (null? (ly:stencil-expr glyph))
3122         (ly:warning (_ "Cannot find glyph ~a") glyph-name))
3123
3124     glyph))
3125
3126 (define-markup-command (doublesharp layout props)
3127   ()
3128   #:category music
3129   "Draw a double sharp symbol.
3130
3131 @lilypond[verbatim,quote]
3132 \\markup {
3133   \\doublesharp
3134 }
3135 @end lilypond"
3136   (interpret-markup layout props (markup #:musicglyph (assoc-get 1 standard-alteration-glyph-name-alist ""))))
3137
3138 (define-markup-command (sesquisharp layout props)
3139   ()
3140   #:category music
3141   "Draw a 3/2 sharp symbol.
3142
3143 @lilypond[verbatim,quote]
3144 \\markup {
3145   \\sesquisharp
3146 }
3147 @end lilypond"
3148   (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist ""))))
3149
3150 (define-markup-command (sharp layout props)
3151   ()
3152   #:category music
3153   "Draw a sharp symbol.
3154
3155 @lilypond[verbatim,quote]
3156 \\markup {
3157   \\sharp
3158 }
3159 @end lilypond"
3160   (interpret-markup layout props (markup #:musicglyph (assoc-get 1/2 standard-alteration-glyph-name-alist ""))))
3161
3162 (define-markup-command (semisharp layout props)
3163   ()
3164   #:category music
3165   "Draw a semisharp symbol.
3166
3167 @lilypond[verbatim,quote]
3168 \\markup {
3169   \\semisharp
3170 }
3171 @end lilypond"
3172   (interpret-markup layout props (markup #:musicglyph (assoc-get 1/4 standard-alteration-glyph-name-alist ""))))
3173
3174 (define-markup-command (natural layout props)
3175   ()
3176   #:category music
3177   "Draw a natural symbol.
3178
3179 @lilypond[verbatim,quote]
3180 \\markup {
3181   \\natural
3182 }
3183 @end lilypond"
3184   (interpret-markup layout props (markup #:musicglyph (assoc-get 0 standard-alteration-glyph-name-alist ""))))
3185
3186 (define-markup-command (semiflat layout props)
3187   ()
3188   #:category music
3189   "Draw a semiflat symbol.
3190
3191 @lilypond[verbatim,quote]
3192 \\markup {
3193   \\semiflat
3194 }
3195 @end lilypond"
3196   (interpret-markup layout props (markup #:musicglyph (assoc-get -1/4 standard-alteration-glyph-name-alist ""))))
3197
3198 (define-markup-command (flat layout props)
3199   ()
3200   #:category music
3201   "Draw a flat symbol.
3202
3203 @lilypond[verbatim,quote]
3204 \\markup {
3205   \\flat
3206 }
3207 @end lilypond"
3208   (interpret-markup layout props (markup #:musicglyph (assoc-get -1/2 standard-alteration-glyph-name-alist ""))))
3209
3210 (define-markup-command (sesquiflat layout props)
3211   ()
3212   #:category music
3213   "Draw a 3/2 flat symbol.
3214
3215 @lilypond[verbatim,quote]
3216 \\markup {
3217   \\sesquiflat
3218 }
3219 @end lilypond"
3220   (interpret-markup layout props (markup #:musicglyph (assoc-get -3/4 standard-alteration-glyph-name-alist ""))))
3221
3222 (define-markup-command (doubleflat layout props)
3223   ()
3224   #:category music
3225   "Draw a double flat symbol.
3226
3227 @lilypond[verbatim,quote]
3228 \\markup {
3229   \\doubleflat
3230 }
3231 @end lilypond"
3232   (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist ""))))
3233
3234 (define-markup-command (with-color layout props color arg)
3235   (color? markup?)
3236   #:category other
3237   "
3238 @cindex coloring text
3239
3240 Draw @var{arg} in color specified by @var{color}.
3241
3242 @lilypond[verbatim,quote]
3243 \\markup {
3244   \\with-color #red
3245   red
3246   \\hspace #2
3247   \\with-color #green
3248   green
3249   \\hspace #2
3250   \\with-color #blue
3251   blue
3252 }
3253 @end lilypond"
3254   (let ((stil (interpret-markup layout props arg)))
3255     (ly:make-stencil (list 'color color (ly:stencil-expr stil))
3256                      (ly:stencil-extent stil X)
3257                      (ly:stencil-extent stil Y))))
3258
3259 (define-markup-command (tied-lyric layout props str)
3260   (string?)
3261   #:category music
3262   #:properties ((word-space))
3263   "
3264 @cindex simple text strings with tie characters
3265
3266 Like simple-markup, but use tie characters for @q{~} tilde symbols.
3267
3268 @lilypond[verbatim,quote]
3269 \\markup \\column {
3270   \\tied-lyric #\"Siam navi~all'onde~algenti Lasciate~in abbandono\"
3271   \\tied-lyric #\"Impetuosi venti I nostri~affetti sono\"
3272   \\tied-lyric #\"Ogni diletto~e scoglio Tutta la vita~e~un mar.\"
3273 }
3274 @end lilypond"
3275   (define (replace-ties tie str)
3276     (if (string-contains str "~")
3277         (let*
3278             ((half-space (/ word-space 2))
3279              (parts (string-split str #\~))
3280              (tie-str (markup #:hspace half-space
3281                               #:musicglyph tie
3282                               #:hspace half-space))
3283              (joined  (list-join parts tie-str)))
3284           (make-concat-markup joined))
3285         str))
3286
3287   (define short-tie-regexp (make-regexp "~[^.]~"))
3288   (define (match-short str) (regexp-exec short-tie-regexp str))
3289
3290   (define (replace-short str mkp)
3291     (let ((match (match-short str)))
3292       (if (not match)
3293           (make-concat-markup (list
3294                                mkp
3295                                (replace-ties "ties.lyric.default" str)))
3296           (let ((new-str (match:suffix match))
3297                 (new-mkp (make-concat-markup (list
3298                                               mkp
3299                                               (replace-ties "ties.lyric.default"
3300                                                             (match:prefix match))
3301                                               (replace-ties "ties.lyric.short"
3302                                                             (match:substring match))))))
3303             (replace-short new-str new-mkp)))))
3304
3305   (interpret-markup layout
3306                     props
3307                     (replace-short str (markup))))
3308
3309 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3310 ;; glyphs
3311 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3312
3313 (define-markup-command (arrow-head layout props axis dir filled)
3314   (integer? ly:dir? boolean?)
3315   #:category graphic
3316   "Produce an arrow head in specified direction and axis.
3317 Use the filled head if @var{filled} is specified.
3318 @lilypond[verbatim,quote]
3319 \\markup {
3320   \\fontsize #5 {
3321     \\general-align #Y #DOWN {
3322       \\arrow-head #Y #UP ##t
3323       \\arrow-head #Y #DOWN ##f
3324       \\hspace #2
3325       \\arrow-head #X #RIGHT ##f
3326       \\arrow-head #X #LEFT ##f
3327     }
3328   }
3329 }
3330 @end lilypond"
3331   (let*
3332       ((name (format #f "arrowheads.~a.~a~a"
3333                      (if filled
3334                          "close"
3335                          "open")
3336                      axis
3337                      dir)))
3338     (ly:font-get-glyph
3339      (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
3340                                      props))
3341      name)))
3342
3343 (define-markup-command (lookup layout props glyph-name)
3344   (string?)
3345   #:category other
3346   "Lookup a glyph by name.
3347
3348 @lilypond[verbatim,quote]
3349 \\markup {
3350   \\override #'(font-encoding . fetaBraces) {
3351     \\lookup #\"brace200\"
3352     \\hspace #2
3353     \\rotate #180
3354     \\lookup #\"brace180\"
3355   }
3356 }
3357 @end lilypond"
3358   (ly:font-get-glyph (ly:paper-get-font layout props)
3359                      glyph-name))
3360
3361 (define-markup-command (char layout props num)
3362   (integer?)
3363   #:category other
3364   "Produce a single character.  Characters encoded in hexadecimal
3365 format require the prefix @code{#x}.
3366
3367 @lilypond[verbatim,quote]
3368 \\markup {
3369   \\char #65 \\char ##x00a9
3370 }
3371 @end lilypond"
3372   (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num)))
3373
3374 (define number->mark-letter-vector (make-vector 25 #\A))
3375
3376 (do ((i 0 (1+ i))
3377      (j 0 (1+ j)))
3378     ((>= i 26))
3379   (if (= i (- (char->integer #\I) (char->integer #\A)))
3380       (set! i (1+ i)))
3381   (vector-set! number->mark-letter-vector j
3382                (integer->char (+ i (char->integer #\A)))))
3383
3384 (define number->mark-alphabet-vector (list->vector
3385                                       (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
3386
3387 (define (number->markletter-string vec n)
3388   "Double letters for big marks."
3389   (let* ((lst (vector-length vec)))
3390
3391     (if (>= n lst)
3392         (string-append (number->markletter-string vec (1- (quotient n lst)))
3393                        (number->markletter-string vec (remainder n lst)))
3394         (make-string 1 (vector-ref vec n)))))
3395
3396 (define-markup-command (markletter layout props num)
3397   (integer?)
3398   #:category other
3399   "Make a markup letter for @var{num}.  The letters start with A
3400 to@tie{}Z (skipping letter@tie{}I), and continue with double letters.
3401
3402 @lilypond[verbatim,quote]
3403 \\markup {
3404   \\markletter #8
3405   \\hspace #2
3406   \\markletter #26
3407 }
3408 @end lilypond"
3409   (ly:text-interface::interpret-markup layout props
3410                                        (number->markletter-string number->mark-letter-vector num)))
3411
3412 (define-markup-command (markalphabet layout props num)
3413   (integer?)
3414   #:category other
3415   "Make a markup letter for @var{num}.  The letters start with A to@tie{}Z
3416 and continue with double letters.
3417
3418 @lilypond[verbatim,quote]
3419 \\markup {
3420   \\markalphabet #8
3421   \\hspace #2
3422   \\markalphabet #26
3423 }
3424 @end lilypond"
3425   (ly:text-interface::interpret-markup layout props
3426                                        (number->markletter-string number->mark-alphabet-vector num)))
3427
3428 (define-public (horizontal-slash-interval num forward number-interval mag)
3429   (if forward
3430       (cond ;; ((= num 6) (interval-widen number-interval (* mag 0.5)))
3431        ;; ((= num 5) (interval-widen number-interval (* mag 0.5)))
3432        (else (interval-widen number-interval (* mag 0.25))))
3433       (cond ((= num 6) (interval-widen number-interval (* mag 0.5)))
3434             ;; ((= num 5) (interval-widen number-interval (* mag 0.5)))
3435             (else (interval-widen number-interval (* mag 0.25))))
3436       ))
3437
3438 (define-public (adjust-slash-stencil num forward stencil mag)
3439   (if forward
3440       (cond ((= num 2)
3441              (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
3442             ((= num 3)
3443              (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
3444             ;; ((= num 5)
3445             ;;     (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.07))))
3446             ;; ((= num 7)
3447             ;;     (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
3448             (else stencil))
3449       (cond ((= num 6)
3450              (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.15))))
3451             ;; ((= num 8)
3452             ;;     (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
3453             (else stencil))
3454       )
3455   )
3456
3457 (define (slashed-digit-internal layout props num forward font-size thickness)
3458   (let* ((mag (magstep font-size))
3459          (thickness (* mag
3460                        (ly:output-def-lookup layout 'line-thickness)
3461                        thickness))
3462          ;; backward slashes might use slope and point in the other direction!
3463          (dy (* mag (if forward 0.4 -0.4)))
3464          (number-stencil (interpret-markup layout
3465                                            (prepend-alist-chain 'font-encoding 'fetaText props)
3466                                            (number->string num)))
3467          (num-x (horizontal-slash-interval num forward (ly:stencil-extent number-stencil X) mag))
3468          (center (interval-center (ly:stencil-extent number-stencil Y)))
3469          ;; Use the real extents of the slash, not the whole number,
3470          ;; because we might translate the slash later on!
3471          (num-y (interval-widen (cons center center) (abs dy)))
3472          (is-sane (and (interval-sane? num-x) (interval-sane? num-y)))
3473          (slash-stencil (if is-sane
3474                             (make-line-stencil thickness
3475                                                (car num-x) (- (interval-center num-y) dy)
3476                                                (cdr num-x) (+ (interval-center num-y) dy))
3477                             #f)))
3478     (if (ly:stencil? slash-stencil)
3479         (begin
3480           ;; for some numbers we need to shift the slash/backslash up or
3481           ;; down to make the slashed digit look better
3482           (set! slash-stencil (adjust-slash-stencil num forward slash-stencil mag))
3483           (set! number-stencil
3484                 (ly:stencil-add number-stencil slash-stencil)))
3485         (ly:warning "Unable to create slashed digit ~a" num))
3486     number-stencil))
3487
3488
3489 (define-markup-command (slashed-digit layout props num)
3490   (integer?)
3491   #:category other
3492   #:properties ((font-size 0)
3493                 (thickness 1.6))
3494   "
3495 @cindex slashed digits
3496
3497 A feta number, with slash.  This is for use in the context of
3498 figured bass notation.
3499 @lilypond[verbatim,quote]
3500 \\markup {
3501   \\slashed-digit #5
3502   \\hspace #2
3503   \\override #'(thickness . 3)
3504   \\slashed-digit #7
3505 }
3506 @end lilypond"
3507   (slashed-digit-internal layout props num #t font-size thickness))
3508
3509 (define-markup-command (backslashed-digit layout props num)
3510   (integer?)
3511   #:category other
3512   #:properties ((font-size 0)
3513                 (thickness 1.6))
3514   "
3515 @cindex backslashed digits
3516
3517 A feta number, with backslash.  This is for use in the context of
3518 figured bass notation.
3519 @lilypond[verbatim,quote]
3520 \\markup {
3521   \\backslashed-digit #5
3522   \\hspace #2
3523   \\override #'(thickness . 3)
3524   \\backslashed-digit #7
3525 }
3526 @end lilypond"
3527   (slashed-digit-internal layout props num #f font-size thickness))
3528
3529 ;; eyeglasses
3530 (define eyeglassespath
3531   '((moveto 0.42 0.77)
3532     (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
3533     (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
3534     (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
3535     (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
3536     (closepath)
3537     (moveto 2.07 0.77)
3538     (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
3539     (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
3540     (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
3541     (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
3542     (closepath)
3543     (moveto 1.025 0.935)
3544     (rcurveto 0 0.182 -0.148 0.33 -0.33 0.33)
3545     (rcurveto -0.182 0 -0.33 -0.148 -0.33 -0.33)
3546     (moveto -0.68 0.77)
3547     (rlineto 0.66 1.43)
3548     (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)
3549     (moveto 2.07 0.77)
3550     (rlineto 0.66 1.43)
3551     (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)))
3552
3553 (define-markup-command (eyeglasses layout props)
3554   ()
3555   #:category other
3556   "Prints out eyeglasses, indicating strongly to look at the conductor.
3557 @lilypond[verbatim,quote]
3558 \\markup { \\eyeglasses }
3559 @end lilypond"
3560   (interpret-markup layout props
3561                     (make-override-markup '(line-cap-style . butt)
3562                                           (make-path-markup 0.15 eyeglassespath))))
3563
3564 (define-markup-command (left-brace layout props size)
3565   (number?)
3566   #:category other
3567   "
3568 A feta brace in point size @var{size}.
3569
3570 @lilypond[verbatim,quote]
3571 \\markup {
3572   \\left-brace #35
3573   \\hspace #2
3574   \\left-brace #45
3575 }
3576 @end lilypond"
3577   (let* ((font (ly:paper-get-font layout
3578                                   (cons '((font-encoding . fetaBraces)
3579                                           (font-name . #f))
3580                                         props)))
3581          (glyph-count (1- (ly:otf-glyph-count font)))
3582          (scale (ly:output-def-lookup layout 'output-scale))
3583          (scaled-size (/ (ly:pt size) scale))
3584          (glyph (lambda (n)
3585                   (ly:font-get-glyph font (string-append "brace"
3586                                                          (number->string n)))))
3587          (get-y-from-brace (lambda (brace)
3588                              (interval-length
3589                               (ly:stencil-extent (glyph brace) Y))))
3590          (find-brace (binary-search 0 glyph-count get-y-from-brace scaled-size))
3591          (glyph-found (glyph find-brace)))
3592
3593     (if (or (null? (ly:stencil-expr glyph-found))
3594             (< scaled-size (interval-length (ly:stencil-extent (glyph 0) Y)))
3595             (> scaled-size (interval-length
3596                             (ly:stencil-extent (glyph glyph-count) Y))))
3597         (begin
3598           (ly:warning (_ "no brace found for point size ~S ") size)
3599           (ly:warning (_ "defaulting to ~S pt")
3600                       (/ (* scale (interval-length
3601                                    (ly:stencil-extent glyph-found Y)))
3602                          (ly:pt 1)))))
3603     glyph-found))
3604
3605 (define-markup-command (right-brace layout props size)
3606   (number?)
3607   #:category other
3608   "
3609 A feta brace in point size @var{size}, rotated 180 degrees.
3610
3611 @lilypond[verbatim,quote]
3612 \\markup {
3613   \\right-brace #45
3614   \\hspace #2
3615   \\right-brace #35
3616 }
3617 @end lilypond"
3618   (interpret-markup layout props (markup #:rotate 180 #:left-brace size)))
3619
3620 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3621 ;; the note command.
3622 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3623
3624 ;; TODO: better syntax.
3625
3626 (define-markup-command (note-by-number layout props log dot-count dir)
3627   (number? number? number?)
3628   #:category music
3629   #:properties ((font-size 0)
3630                 (flag-style '())
3631                 (style '()))
3632   "
3633 @cindex notes within text by log and dot-count
3634
3635 Construct a note symbol, with stem and flag.  By using fractional values for
3636 @var{dir}, longer or shorter stems can be obtained.
3637 Supports all note-head-styles.  Ancient note-head-styles will get
3638 mensural-style-flags.  @code{flag-style} may be overridden independently.
3639 Supported flag-styles are @code{default}, @code{old-straight-flag},
3640 @code{modern-straight-flag}, @code{flat-flag}, @code{mensural} and
3641 @code{neomensural}.  The latter two flag-styles will both result in
3642 mensural-flags.  Both are supplied for convenience.
3643
3644 @lilypond[verbatim,quote]
3645 \\markup {
3646   \\note-by-number #3 #0 #DOWN
3647   \\hspace #2
3648   \\note-by-number #1 #2 #0.8
3649 }
3650 @end lilypond"
3651   (define (get-glyph-name-candidates dir log style)
3652     (map (lambda (dir-name)
3653            (format #f "noteheads.~a~a"
3654                    dir-name
3655                    (if (and (symbol? style)
3656                             (not (equal? 'default style)))
3657                        (select-head-glyph style (min log 2))
3658                        (min log 2))))
3659          (list (if (= dir UP) "u" "d")
3660                "s")))
3661
3662   (define (get-glyph-name font cands)
3663     (if (null? cands)
3664         ""
3665         (if (ly:stencil-empty? (ly:font-get-glyph font (car cands)))
3666             (get-glyph-name font (cdr cands))
3667             (car cands))))
3668
3669   (define (buildflags flag-stencil remain curr-stencil spacing)
3670     ;; Function to recursively create a stencil with @code{remain} flags
3671     ;; from the single-flag stencil @code{curr-stencil}, which is already
3672     ;; translated to the position of the previous flag position.
3673     ;;
3674     ;; Copy and paste from /scm/flag-styles.scm
3675     (if (> remain 0)
3676         (let* ((translated-stencil
3677                 (ly:stencil-translate-axis curr-stencil spacing Y))
3678                (new-stencil (ly:stencil-add flag-stencil translated-stencil)))
3679           (buildflags new-stencil (- remain 1) translated-stencil spacing))
3680         flag-stencil))
3681
3682   (define (straight-flag-mrkp flag-thickness flag-spacing
3683                               upflag-angle upflag-length
3684                               downflag-angle downflag-length
3685                               dir)
3686     ;; Create a stencil for a straight flag.  @var{flag-thickness} and
3687     ;; @var{flag-spacing} are given in staff spaces, @var{upflag-angle} and
3688     ;; @var{downflag-angle} are given in degrees, and @var{upflag-length} and
3689     ;; @var{downflag-length} are given in staff spaces.
3690     ;;
3691     ;; All lengths are scaled according to the font size of the note.
3692     ;;
3693     ;; From /scm/flag-styles.scm, modified to fit here.
3694
3695     (let* ((stem-up (> dir 0))
3696            ;; scale with the note size
3697            (factor (magstep font-size))
3698            (stem-thickness (* factor 0.1))
3699            (line-thickness (ly:output-def-lookup layout 'line-thickness))
3700            (half-stem-thickness (/ (* stem-thickness line-thickness) 2))
3701            (raw-length (if stem-up upflag-length downflag-length))
3702            (angle (if stem-up upflag-angle downflag-angle))
3703            (flag-length (+ (* raw-length factor) half-stem-thickness))
3704            (flag-end (if (= angle 0)
3705                          (cons flag-length (* half-stem-thickness dir))
3706                          (polar->rectangular flag-length angle)))
3707            (thickness (* flag-thickness factor))
3708            (thickness-offset (cons 0 (* -1 thickness dir)))
3709            (spacing (* -1 flag-spacing factor dir))
3710            (start (cons (- half-stem-thickness) (* half-stem-thickness dir)))
3711            (points (list start
3712                          flag-end
3713                          (offset-add flag-end thickness-offset)
3714                          (offset-add start thickness-offset)))
3715            (stencil (ly:round-filled-polygon points half-stem-thickness))
3716            ;; Log for 1/8 is 3, so we need to subtract 3
3717            (flag-stencil (buildflags stencil (- log 3) stencil spacing)))
3718       flag-stencil))
3719
3720   (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)
3721                                                  (font-name . #f))
3722                                                props)))
3723          (size-factor (magstep font-size))
3724          (blot (ly:output-def-lookup layout 'blot-diameter))
3725          (head-glyph-name
3726           (let ((result (get-glyph-name font
3727                                         (get-glyph-name-candidates
3728                                          (sign dir) log style))))
3729             (if (string-null? result)
3730                 ;; If no glyph name can be found, select default heads.
3731                 ;; Though this usually means an unsupported style has been
3732                 ;; chosen, it also prevents unrelated 'style settings from
3733                 ;; other grobs (e.g., TextSpanner and TimeSignature) leaking
3734                 ;; into markup.
3735                 (get-glyph-name font
3736                                 (get-glyph-name-candidates
3737                                  (sign dir) log 'default))
3738                 result)))
3739          (head-glyph (ly:font-get-glyph font head-glyph-name))
3740          (ancient-flags?
3741            (member style
3742                    '(mensural neomensural petrucci semipetrucci blackpetrucci)))
3743          (attach-indices (ly:note-head::stem-attachment font head-glyph-name))
3744          (stem-length (* size-factor (max 3 (- log 1))))
3745          ;; With ancient-flags we want a tighter stem
3746          (stem-thickness (* size-factor (if ancient-flags? 0.1 0.13)))
3747          (stemy (* dir stem-length))
3748          (attach-off (cons (interval-index
3749                             (ly:stencil-extent head-glyph X)
3750                             (* (sign dir) (car attach-indices)))
3751                            ;; fixme, this is inconsistent between X & Y.
3752                            (* (sign dir)
3753                               (interval-index
3754                                (ly:stencil-extent head-glyph Y)
3755                                (cdr attach-indices)))))
3756          ;; For a tighter stem (with ancient-flags) the stem-width has to be
3757          ;; adjusted.
3758          (stem-X-corr
3759            (if (or ancient-flags?
3760                    (member flag-style '(mensural neomensural)))
3761                    (* 0.5 dir stem-thickness) 0))
3762          (stem-glyph (and (> log 0)
3763                           (ly:round-filled-box
3764                            (ordered-cons (+ stem-X-corr (car attach-off))
3765                                          (+ stem-X-corr (car attach-off)
3766                                             (* (- (sign dir)) stem-thickness)))
3767                            (cons (min stemy (cdr attach-off))
3768                                  (max stemy (cdr attach-off)))
3769                            (/ stem-thickness 3))))
3770          (dot (ly:font-get-glyph font "dots.dot"))
3771          (dotwid (interval-length (ly:stencil-extent dot X)))
3772          (dots (and (> dot-count 0)
3773                     (apply ly:stencil-add
3774                            (map (lambda (x)
3775                                   (ly:stencil-translate-axis
3776                                    dot (* 2 x dotwid) X))
3777                                 (iota dot-count)))))
3778          ;; Straight-flags. Values taken from /scm/flag-style.scm
3779          (modern-straight-flag (straight-flag-mrkp 0.55 1 -18 1.1 22 1.2 dir))
3780          (old-straight-flag (straight-flag-mrkp 0.55 1 -45 1.2 45 1.4 dir))
3781          (flat-flag (straight-flag-mrkp 0.55 1.0 0 1.0 0 1.0 dir))
3782          ;; Calculate a corrective to avoid a gap between
3783          ;; straight-flags and the stem.
3784          (flag-style-Y-corr (if (or (eq? flag-style 'modern-straight-flag)
3785                                     (eq? flag-style 'old-straight-flag)
3786                                     (eq? flag-style 'flat-flag))
3787                                 (/ blot 10 (* -1 dir))
3788                                 0))
3789          (flaggl (and (> log 2)
3790                       (ly:stencil-translate
3791                        (cond ((eq? flag-style 'modern-straight-flag)
3792                               modern-straight-flag)
3793                              ((eq? flag-style 'old-straight-flag)
3794                               old-straight-flag)
3795                              ((eq? flag-style 'flat-flag)
3796                               flat-flag)
3797                              (else
3798                               (ly:font-get-glyph font
3799                                 (format #f
3800                                         (if (or (member flag-style
3801                                                         '(mensural neomensural))
3802                                                 (and ancient-flags?
3803                                                      (null? flag-style)))
3804                                             "flags.mensural~a2~a"
3805                                             "flags.~a~a")
3806                                         (if (> dir 0) "u" "d")
3807                                         log))))
3808                        (cons (+ (car attach-off)
3809                                 ;; For tighter stems (with ancient-flags) the
3810                                 ;; flag has to be adjusted different.
3811                                 (if (and (not ancient-flags?) (< dir 0))
3812                                     stem-thickness
3813                                     0))
3814                              (+ stemy flag-style-Y-corr))))))
3815
3816     ;; If there is a flag on an upstem and the stem is short, move the dots
3817     ;; to avoid the flag.  16th notes get a special case because their flags
3818     ;; hang lower than any other flags.
3819     ;; Not with ancient flags or straight-flags.
3820     (if (and dots (> dir 0) (> log 2)
3821              (or (eq? flag-style 'default) (null? flag-style))
3822              (not ancient-flags?)
3823              (or (< dir 1.15) (and (= log 4) (< dir 1.3))))
3824         (set! dots (ly:stencil-translate-axis dots 0.5 X)))
3825     (if flaggl
3826         (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
3827     (if (ly:stencil? stem-glyph)
3828         (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
3829         (set! stem-glyph head-glyph))
3830     (if (ly:stencil? dots)
3831         (set! stem-glyph
3832               (ly:stencil-add
3833                (ly:stencil-translate-axis
3834                 dots
3835                 (+ (cdr (ly:stencil-extent head-glyph X)) dotwid)
3836                 X)
3837                stem-glyph)))
3838     stem-glyph))
3839
3840 (define-public log2
3841   (let ((divisor (log 2)))
3842     (lambda (z) (inexact->exact (/ (log z) divisor)))))
3843
3844 (define (parse-simple-duration duration-string)
3845   "Parse the `duration-string', e.g. ''4..'' or ''breve.'',
3846 and return a (log dots) list."
3847   (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)")
3848                             duration-string)))
3849     (if (and match (string=? duration-string (match:substring match 0)))
3850         (let ((len (match:substring match 1))
3851               (dots (match:substring match 2)))
3852           (list (cond ((string=? len "breve") -1)
3853                       ((string=? len "longa") -2)
3854                       ((string=? len "maxima") -3)
3855                       (else (log2 (string->number len))))
3856                 (if dots (string-length dots) 0)))
3857         (ly:error (_ "not a valid duration string: ~a") duration-string))))
3858
3859 (define-markup-command (note layout props duration dir)
3860   (string? number?)
3861   #:category music
3862   #:properties (note-by-number-markup)
3863   "
3864 @cindex notes within text by string
3865
3866 This produces a note with a stem pointing in @var{dir} direction, with
3867 the @var{duration} for the note head type and augmentation dots.  For
3868 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
3869 a shortened down stem.
3870
3871 @lilypond[verbatim,quote]
3872 \\markup {
3873   \\override #'(style . cross) {
3874     \\note #\"4..\" #UP
3875   }
3876   \\hspace #2
3877   \\note #\"breve\" #0
3878 }
3879 @end lilypond"
3880   (let ((parsed (parse-simple-duration duration)))
3881     (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
3882
3883 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3884 ;; the rest command.
3885 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3886
3887 (define-markup-command (rest-by-number layout props log dot-count)
3888   (number? number?)
3889   #:category music
3890   #:properties ((font-size 0)
3891                 (style '())
3892                 (multi-measure-rest #f))
3893   "
3894 @cindex rests or multi-measure-rests within text by log and dot-count
3895
3896 A rest or multi-measure-rest symbol.
3897
3898 @lilypond[verbatim,quote]
3899 \\markup {
3900   \\rest-by-number #3 #2
3901   \\hspace #2
3902   \\rest-by-number #0 #1
3903   \\hspace #2
3904   \\override #'(multi-measure-rest . #t)
3905   \\rest-by-number #0 #0
3906 }
3907 @end lilypond"
3908
3909   (define (get-glyph-name-candidates log style)
3910     (let* (;; Choose the style-string to be added.
3911            ;; If no glyph exists, select others for the specified styles
3912            ;; otherwise defaulting.
3913            (style-strg
3914             (cond (
3915                    ;; 'baroque needs to be special-cased, otherwise
3916                    ;; `select-head-glyph´ would catch neomensural-glyphs for
3917                    ;; this style, if (< log 0).
3918                    (eq? style 'baroque)
3919                    (string-append (number->string log) ""))
3920                   ((eq? style 'petrucci)
3921                    (string-append (number->string log) "mensural"))
3922                   ;; In other cases `select-head-glyph´ from output-lib.scm
3923                   ;; works for rest-glyphs, too.
3924                   ((and (symbol? style) (not (eq? style 'default)))
3925                    (select-head-glyph style log))
3926                   (else log)))
3927            ;; Choose ledgered glyphs for whole and half rest.
3928            ;; Except for the specified styles, logs and MultiMeasureRests.
3929            (ledger-style-rests
3930             (if (and (or (list? style)
3931                          (not (member style
3932                                       '(neomensural mensural petrucci))))
3933                      (not multi-measure-rest)
3934                      (or (= log 0) (= log 1)))
3935                 "o"
3936                 "")))
3937       (format #f "rests.~a~a" style-strg ledger-style-rests)))
3938
3939   (define (get-glyph-name font cands)
3940     (if (ly:stencil-empty? (ly:font-get-glyph font cands))
3941         ""
3942         cands))
3943
3944   (let* ((font
3945           (ly:paper-get-font layout
3946                              (cons '((font-encoding . fetaMusic)
3947                                      (font-name . #f))
3948                                    props)))
3949          (rest-glyph-name
3950           (let ((result
3951                  (get-glyph-name font
3952                                  (get-glyph-name-candidates log style))))
3953             (if (string-null? result)
3954                 ;; If no glyph name can be found, select default rests.  Though
3955                 ;; this usually means an unsupported style has been chosen, it
3956                 ;; also prevents unrelated 'style settings from other grobs
3957                 ;; (e.g., TextSpanner and TimeSignature) leaking into markup.
3958                 (get-glyph-name font (get-glyph-name-candidates log 'default))
3959                 result)))
3960          (rest-glyph (ly:font-get-glyph font rest-glyph-name))
3961          (dot (ly:font-get-glyph font "dots.dot"))
3962          (dot-width (interval-length (ly:stencil-extent dot X)))
3963          (dots (and (> dot-count 0)
3964                     (apply ly:stencil-add
3965                            (map (lambda (x)
3966                                   (ly:stencil-translate-axis
3967                                    dot (* 2 x dot-width) X))
3968                                 (iota dot-count))))))
3969
3970     ;; Apart from mensural-, neomensural- and petrucci-style ledgered
3971     ;; glyphs are taken for whole and half rests.
3972     ;; If they are dotted, move the dots in X-direction to avoid collision.
3973     (if (and dots
3974              (< log 2)
3975              (>= log 0)
3976              (not (member style '(neomensural mensural petrucci))))
3977         (set! dots (ly:stencil-translate-axis dots dot-width X)))
3978
3979     ;; Add dots to the rest-glyph.
3980     ;;
3981     ;; Not sure how to vertical align dots.
3982     ;; For now the dots are centered for half, whole or longer rests.
3983     ;; Otherwise placed near the top of the rest.
3984     ;;
3985     ;; Dots for rests with (< log 0) dots are allowed, but not
3986     ;; if multi-measure-rest is set #t.
3987     (if (and (not multi-measure-rest) dots)
3988         (set! rest-glyph
3989               (ly:stencil-add
3990                (ly:stencil-translate
3991                 dots
3992                 (cons
3993                  (+ (cdr (ly:stencil-extent rest-glyph X)) dot-width)
3994                  (if (< log 2)
3995                      (interval-center (ly:stencil-extent rest-glyph Y))
3996                      (- (interval-end (ly:stencil-extent rest-glyph Y))
3997                         (/ (* 2 dot-width) 3)))))
3998                rest-glyph)))
3999     rest-glyph))
4000
4001 (define-markup-command (rest layout props duration)
4002   (string?)
4003   #:category music
4004   #:properties ((style '())
4005                 (multi-measure-rest #f)
4006                 (multi-measure-rest-number #t)
4007                 (word-space 0.6))
4008   "
4009 @cindex rests or multi-measure-rests within text by string
4010
4011 This produces a rest, with the @var{duration} for the rest type and
4012 augmentation dots.
4013 @code{\"breve\"}, @code{\"longa\"} and @code{\"maxima\"} are valid
4014 input-strings.
4015
4016 Printing MultiMeasureRests could be enabled with
4017 @code{\\override #'(multi-measure-rest . #t)}
4018 If MultiMeasureRests are taken, the MultiMeasureRestNumber is printed above.
4019 This is enabled for all styles using default-glyphs.
4020 Could be disabled with @code{\\override #'(multi-measure-rest-number . #f)}
4021
4022 @lilypond[verbatim,quote]
4023 \\markup {
4024   \\rest #\"4..\"
4025   \\hspace #2
4026   \\rest #\"breve\"
4027   \\hspace #2
4028   \\override #'(multi-measure-rest . #t)
4029   {
4030   \\rest #\"7\"
4031   \\hspace #2
4032   \\override #'(multi-measure-rest-number . #f)
4033   \\rest #\"7\"
4034   }
4035 }
4036 @end lilypond"
4037   ;; Get the number of mmr-glyphs.
4038   ;; Store them in a list.
4039   ;; example: (mmr-numbers 25) -> '(3 0 0 1)
4040   (define (mmr-numbers nmbr)
4041     (let* ((8-bar-glyph (floor (/ nmbr 8)))
4042            (8-remainder (remainder nmbr 8))
4043            (4-bar-glyph (floor (/ 8-remainder 4)))
4044            (4-remainder (remainder nmbr 4))
4045            (2-bar-glyph (floor (/ 4-remainder 2)))
4046            (2-remainder (remainder 4-remainder 2))
4047            (1-bar-glyph (floor (/ 2-remainder 1))))
4048       (list 8-bar-glyph 4-bar-glyph 2-bar-glyph 1-bar-glyph)))
4049
4050   ;; Get the correct mmr-glyphs.
4051   ;; Store them in a list.
4052   ;; example:
4053   ;; (get-mmr-glyphs '(1 0 1 0) '("rests.M3" "rests.M2" "rests.M1" "rests.0"))
4054   ;; -> ("rests.M3" "rests.M1")
4055   (define (get-mmr-glyphs lst1 lst2)
4056     (define (helper l1 l2 l3)
4057       (if (null? l1)
4058           (reverse l3)
4059           (helper (cdr l1)
4060                   (cdr l2)
4061                   (append (make-list (car l1) (car l2)) l3))))
4062     (helper lst1 lst2 '()))
4063
4064   ;; If duration is not valid, print a warning and return empty-stencil
4065   (if (or (and (not (integer? (car (parse-simple-duration duration))))
4066                (not multi-measure-rest))
4067           (and (= (string-length (car (string-split duration #\. ))) 1)
4068                (= (string->number (car (string-split duration #\. ))) 0)))
4069       (begin
4070         (ly:warning (_ "not a valid duration string: ~a - ignoring") duration)
4071         empty-stencil)
4072       (let* (
4073              ;; For simple rests:
4074              ;; Get a (log dots) list.
4075              (parsed (parse-simple-duration duration))
4076              ;; Create the rest-stencil
4077              (stil
4078               (rest-by-number-markup layout props (car parsed) (cadr parsed)))
4079              ;; For MultiMeasureRests:
4080              ;; Get the duration-part of duration
4081              (dur-part-string (car (string-split duration #\. )))
4082              ;; Get the duration of MMR:
4083              ;; If not a number (eg. "maxima") calculate it.
4084              (mmr-duration
4085               (or (string->number dur-part-string) (expt 2 (abs (car parsed)))))
4086              ;; Get a list of the correct number of each mmr-glyph.
4087              (count-mmr-glyphs-list (mmr-numbers mmr-duration))
4088              ;; Create a list of mmr-stencils,
4089              ;; translating the glyph for a whole rest.
4090              (mmr-stils-list
4091               (map
4092                (lambda (x)
4093                  (let ((single-mmr-stil
4094                         (rest-by-number-markup layout props (* -1 x) 0)))
4095                    (if (= x 0)
4096                        (ly:stencil-translate-axis
4097                         single-mmr-stil
4098                         ;; Ugh, hard-coded, why 1?
4099                         1
4100                         Y)
4101                        single-mmr-stil)))
4102                (get-mmr-glyphs count-mmr-glyphs-list (reverse (iota 4)))))
4103              ;; Adjust the space between the mmr-glyphs,
4104              ;; if not default-glyphs are used.
4105              (word-space (if (member style
4106                                      '(neomensural mensural petrucci))
4107                              (/ (* word-space 2) 3)
4108                              word-space))
4109              ;; Create the final mmr-stencil
4110              ;; via `stack-stencil-line´ from /scm/markup.scm
4111              (mmr-stil (stack-stencil-line word-space mmr-stils-list)))
4112
4113         ;; Print the number above a multi-measure-rest
4114         ;; Depends on duration, style and multi-measure-rest-number set #t
4115         (if (and multi-measure-rest
4116                  multi-measure-rest-number
4117                  (> mmr-duration 1)
4118                  (not (member style '(neomensural mensural petrucci))))
4119             (let* ((mmr-stil-x-center
4120                     (interval-center (ly:stencil-extent mmr-stil X)))
4121                    (duration-markup
4122                     (markup
4123                      #:fontsize -2
4124                      #:override '(font-encoding . fetaText)
4125                      (number->string mmr-duration)))
4126                    (mmr-number-stil
4127                     (interpret-markup layout props duration-markup))
4128                    (mmr-number-stil-x-center
4129                     (interval-center (ly:stencil-extent mmr-number-stil X))))
4130
4131               (set! mmr-stil (ly:stencil-combine-at-edge
4132                               mmr-stil
4133                               Y UP
4134                               (ly:stencil-translate-axis
4135                                mmr-number-stil
4136                                (- mmr-stil-x-center mmr-number-stil-x-center)
4137                                X)
4138                               ;; Ugh, hardcoded
4139                               0.8))))
4140         (if multi-measure-rest
4141             mmr-stil
4142             stil))))
4143
4144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4145 ;; fermata markup
4146 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4147
4148 (define-markup-command (fermata layout props) ()
4149   #:category music
4150   #:properties ((direction UP))
4151   "Create a fermata glyph.  When @var{direction} is @code{DOWN}, use
4152 an inverted glyph.  Note that within music, one would usually use the
4153 @code{\\fermata} articulation instead of a markup.
4154
4155 @lilypond[verbatim,quote]
4156  { c''1^\\markup \\fermata d''1_\\markup \\fermata }
4157
4158 \\markup { \\fermata \\override #`(direction . ,DOWN) \\fermata }
4159 @end lilypond
4160 "
4161   (interpret-markup layout props
4162                     (if (eqv? direction DOWN)
4163                         (markup #:musicglyph "scripts.dfermata")
4164                         (markup #:musicglyph "scripts.ufermata"))))
4165
4166 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4167 ;; translating.
4168 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4169
4170 (define-markup-command (lower layout props amount arg)
4171   (number? markup?)
4172   #:category align
4173   "
4174 @cindex lowering text
4175
4176 Lower @var{arg} by the distance @var{amount}.
4177 A negative @var{amount} indicates raising; see also @code{\\raise}.
4178
4179 @lilypond[verbatim,quote]
4180 \\markup {
4181   one
4182   \\lower #3
4183   two
4184   three
4185 }
4186 @end lilypond"
4187   (ly:stencil-translate-axis (interpret-markup layout props arg)
4188                              (- amount) Y))
4189
4190 (define-markup-command (translate-scaled layout props offset arg)
4191   (number-pair? markup?)
4192   #:category align
4193   #:properties ((font-size 0))
4194   "
4195 @cindex translating text
4196 @cindex scaling text
4197
4198 Translate @var{arg} by @var{offset}, scaling the offset by the
4199 @code{font-size}.
4200
4201 @lilypond[verbatim,quote]
4202 \\markup {
4203   \\fontsize #5 {
4204     * \\translate #'(2 . 3) translate
4205     \\hspace #2
4206     * \\translate-scaled #'(2 . 3) translate-scaled
4207   }
4208 }
4209 @end lilypond"
4210   (let* ((factor (magstep font-size))
4211          (scaled (cons (* factor (car offset))
4212                        (* factor (cdr offset)))))
4213     (ly:stencil-translate (interpret-markup layout props arg)
4214                           scaled)))
4215
4216 (define-markup-command (raise layout props amount arg)
4217   (number? markup?)
4218   #:category align
4219   "
4220 @cindex raising text
4221
4222 Raise @var{arg} by the distance @var{amount}.
4223 A negative @var{amount} indicates lowering, see also @code{\\lower}.
4224
4225 The argument to @code{\\raise} is the vertical displacement amount,
4226 measured in (global) staff spaces.  @code{\\raise} and @code{\\super}
4227 raise objects in relation to their surrounding markups.
4228
4229 If the text object itself is positioned above or below the staff, then
4230 @code{\\raise} cannot be used to move it, since the mechanism that
4231 positions it next to the staff cancels any shift made with
4232 @code{\\raise}.  For vertical positioning, use the @code{padding}
4233 and/or @code{extra-offset} properties.
4234
4235 @lilypond[verbatim,quote]
4236 \\markup {
4237   C
4238   \\small
4239   \\bold
4240   \\raise #1.0
4241   9/7+
4242 }
4243 @end lilypond"
4244   (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
4245
4246 (define-markup-command (fraction layout props arg1 arg2)
4247   (markup? markup?)
4248   #:category other
4249   #:properties ((font-size 0))
4250   "
4251 @cindex creating text fractions
4252
4253 Make a fraction of two markups.
4254 @lilypond[verbatim,quote]
4255 \\markup {
4256   π ≈
4257   \\fraction 355 113
4258 }
4259 @end lilypond"
4260   (let* ((m1 (interpret-markup layout props arg1))
4261          (m2 (interpret-markup layout props arg2))
4262          (factor (magstep font-size))
4263          (boxdimen (cons (* factor -0.05) (* factor 0.05)))
4264          (padding (* factor 0.2))
4265          (baseline (* factor 0.6))
4266          (offset (* factor 0.75)))
4267     (set! m1 (ly:stencil-aligned-to m1 X CENTER))
4268     (set! m2 (ly:stencil-aligned-to m2 X CENTER))
4269     (let* ((x1 (ly:stencil-extent m1 X))
4270            (x2 (ly:stencil-extent m2 X))
4271            (line (ly:round-filled-box (interval-union x1 x2) boxdimen 0.0))
4272            ;; should stack mols separately, to maintain LINE on baseline
4273            (stack (stack-lines DOWN padding baseline (list m1 line m2))))
4274       (set! stack
4275             (ly:stencil-aligned-to stack Y CENTER))
4276       (set! stack
4277             (ly:stencil-aligned-to stack X LEFT))
4278       ;; should have EX dimension
4279       ;; empirical anyway
4280       (ly:stencil-translate-axis stack offset Y))))
4281
4282 (define-markup-command (normal-size-super layout props arg)
4283   (markup?)
4284   #:category font
4285   #:properties ((font-size 0))
4286   "
4287 @cindex setting superscript in standard font size
4288
4289 Set @var{arg} in superscript with a normal font size.
4290
4291 @lilypond[verbatim,quote]
4292 \\markup {
4293   default
4294   \\normal-size-super {
4295     superscript in standard size
4296   }
4297 }
4298 @end lilypond"
4299   (ly:stencil-translate-axis
4300    (interpret-markup layout props arg)
4301    (* 1.0 (magstep font-size)) Y))
4302
4303 (define-markup-command (super layout props arg)
4304   (markup?)
4305   #:category font
4306   #:properties ((font-size 0))
4307   "
4308 @cindex superscript text
4309
4310 Set @var{arg} in superscript.
4311
4312 @lilypond[verbatim,quote]
4313 \\markup {
4314   E =
4315   \\concat {
4316     mc
4317     \\super
4318     2
4319   }
4320 }
4321 @end lilypond"
4322   (ly:stencil-translate-axis
4323    (interpret-markup
4324     layout
4325     (cons `((font-size . ,(- font-size 3))) props)
4326     arg)
4327    (* 1.0 (magstep font-size)) ; original font-size
4328    Y))
4329
4330 (define-markup-command (translate layout props offset arg)
4331   (number-pair? markup?)
4332   #:category align
4333   "
4334 @cindex translating text
4335
4336 Translate @var{arg} relative to its surroundings.  @var{offset}
4337 is a pair of numbers representing the displacement in the X and Y axis.
4338
4339 @lilypond[verbatim,quote]
4340 \\markup {
4341   *
4342   \\translate #'(2 . 3)
4343   \\line { translated two spaces right, three up }
4344 }
4345 @end lilypond"
4346   (ly:stencil-translate (interpret-markup layout props arg)
4347                         offset))
4348
4349 (define-markup-command (sub layout props arg)
4350   (markup?)
4351   #:category font
4352   #:properties ((font-size 0))
4353   "
4354 @cindex subscript text
4355
4356 Set @var{arg} in subscript.
4357
4358 @lilypond[verbatim,quote]
4359 \\markup {
4360   \\concat {
4361     H
4362     \\sub {
4363       2
4364     }
4365     O
4366   }
4367 }
4368 @end lilypond"
4369   (ly:stencil-translate-axis
4370    (interpret-markup
4371     layout
4372     (cons `((font-size . ,(- font-size 3))) props)
4373     arg)
4374    (* -0.75 (magstep font-size)) ; original font-size
4375    Y))
4376
4377 (define-markup-command (normal-size-sub layout props arg)
4378   (markup?)
4379   #:category font
4380   #:properties ((font-size 0))
4381   "
4382 @cindex setting subscript in standard font size
4383
4384 Set @var{arg} in subscript with a normal font size.
4385
4386 @lilypond[verbatim,quote]
4387 \\markup {
4388   default
4389   \\normal-size-sub {
4390     subscript in standard size
4391   }
4392 }
4393 @end lilypond"
4394   (ly:stencil-translate-axis
4395    (interpret-markup layout props arg)
4396    (* -0.75 (magstep font-size))
4397    Y))
4398
4399 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4400 ;; brackets.
4401 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4402
4403 (define-markup-command (hbracket layout props arg)
4404   (markup?)
4405   #:category graphic
4406   "
4407 @cindex placing horizontal brackets around text
4408
4409 Draw horizontal brackets around @var{arg}.
4410
4411 @lilypond[verbatim,quote]
4412 \\markup {
4413   \\hbracket {
4414     \\line {
4415       one two three
4416     }
4417   }
4418 }
4419 @end lilypond"
4420   (let ((th 0.1) ;; todo: take from GROB.
4421         (m (interpret-markup layout props arg)))
4422     (bracketify-stencil m X th (* 2.5 th) th)))
4423
4424 (define-markup-command (bracket layout props arg)
4425   (markup?)
4426   #:category graphic
4427   "
4428 @cindex placing vertical brackets around text
4429
4430 Draw vertical brackets around @var{arg}.
4431
4432 @lilypond[verbatim,quote]
4433 \\markup {
4434   \\bracket {
4435     \\note #\"2.\" #UP
4436   }
4437 }
4438 @end lilypond"
4439   (let ((th 0.1) ;; todo: take from GROB.
4440         (m (interpret-markup layout props arg)))
4441     (bracketify-stencil m Y th (* 2.5 th) th)))
4442
4443 (define-markup-command (parenthesize layout props arg)
4444   (markup?)
4445   #:category graphic
4446   #:properties ((angularity 0)
4447                 (padding)
4448                 (size 1)
4449                 (thickness 1)
4450                 (width 0.25))
4451   "
4452 @cindex placing parentheses around text
4453
4454 Draw parentheses around @var{arg}.  This is useful for parenthesizing
4455 a column containing several lines of text.
4456
4457 @lilypond[verbatim,quote]
4458 \\markup {
4459   \\line {
4460     \\parenthesize {
4461       \\column {
4462         foo
4463         bar
4464       }
4465     }
4466     \\override #'(angularity . 2) {
4467       \\parenthesize {
4468         \\column {
4469           bah
4470           baz
4471         }
4472       }
4473     }
4474   }
4475 }
4476 @end lilypond"
4477   (let* ((m (interpret-markup layout props arg))
4478          (scaled-width (* size width))
4479          (scaled-thickness
4480           (* (chain-assoc-get 'line-thickness props 0.1)
4481              thickness))
4482          (half-thickness
4483           (min (* size 0.5 scaled-thickness)
4484                (* (/ 4 3.0) scaled-width)))
4485          (padding (chain-assoc-get 'padding props half-thickness)))
4486     (parenthesize-stencil
4487      m half-thickness scaled-width angularity padding)))
4488
4489
4490 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4491 ;; Delayed markup evaluation
4492 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4493
4494 (define-markup-command (page-ref layout props label gauge default)
4495   (symbol? markup? markup?)
4496   #:category other
4497   "
4498 @cindex referencing page numbers in text
4499
4500 Reference to a page number.  @var{label} is the label set on the referenced
4501 page (using the @code{\\label} command), @var{gauge} a markup used to estimate
4502 the maximum width of the page number, and @var{default} the value to display
4503 when @var{label} is not found.
4504
4505 (If the current book or bookpart is set to use roman numerals for page numbers,
4506 the reference will be formatted accordingly -- in which case the @var{gauge}'s
4507 width may require additional tweaking.)"
4508   (let* ((gauge-stencil (interpret-markup layout props gauge))
4509          (x-ext (ly:stencil-extent gauge-stencil X))
4510          (y-ext (ly:stencil-extent gauge-stencil Y)))
4511    (ly:stencil-add
4512     (make-transparent-box-stencil x-ext y-ext))
4513     (ly:make-stencil
4514      `(delay-stencil-evaluation
4515        ,(delay (ly:stencil-expr
4516                 (let* ((table (ly:output-def-lookup layout 'label-page-table))
4517                        (page-number (if (list? table)
4518                                         (assoc-get label table)
4519                                         #f))
4520                        (number-type (ly:output-def-lookup layout 'page-number-type))
4521                        (page-markup (if page-number
4522                                         (number-format number-type page-number)
4523                                         default))
4524                        (page-stencil (interpret-markup layout props page-markup))
4525                        (gap (- (interval-length x-ext)
4526                                (interval-length (ly:stencil-extent page-stencil X)))))
4527                   (interpret-markup layout props
4528                                     (markup #:hspace gap page-markup))))))
4529      x-ext
4530      y-ext)))
4531
4532 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4533 ;; scaling
4534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4535
4536 (define-markup-command (scale layout props factor-pair arg)
4537   (number-pair? markup?)
4538   #:category graphic
4539   "
4540 @cindex scaling markup
4541 @cindex mirroring markup
4542
4543 Scale @var{arg}.  @var{factor-pair} is a pair of numbers
4544 representing the scaling-factor in the X and Y axes.
4545 Negative values may be used to produce mirror images.
4546
4547 @lilypond[verbatim,quote]
4548 \\markup {
4549   \\line {
4550     \\scale #'(2 . 1)
4551     stretched
4552     \\scale #'(1 . -1)
4553     mirrored
4554   }
4555 }
4556 @end lilypond"
4557   (let ((stil (interpret-markup layout props arg))
4558         (sx (car factor-pair))
4559         (sy (cdr factor-pair)))
4560     (ly:stencil-scale stil sx sy)))
4561
4562 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4563 ;; Repeating
4564 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4565
4566 (define-markup-command (pattern layout props count axis space pattern)
4567   (integer? integer? number? markup?)
4568   #:category other
4569   "
4570 Prints @var{count} times a @var{pattern} markup.
4571 Patterns are spaced apart by @var{space}.
4572 Patterns are distributed on @var{axis}.
4573
4574 @lilypond[verbatim, quote]
4575 \\markup \\column {
4576   \"Horizontally repeated :\"
4577   \\pattern #7 #X #2 \\flat
4578   \\null
4579   \"Vertically repeated :\"
4580   \\pattern #3 #Y #0.5 \\flat
4581 }
4582 @end lilypond"
4583   (let ((pattern-width (interval-length
4584                         (ly:stencil-extent (interpret-markup layout props pattern) X)))
4585         (new-props (prepend-alist-chain 'word-space 0 (prepend-alist-chain 'baseline-skip 0 props))))
4586     (let loop ((i (1- count)) (patterns (markup)))
4587       (if (zero? i)
4588           (interpret-markup
4589            layout
4590            new-props
4591            (if (= axis X)
4592                (markup patterns pattern)
4593                (markup #:column (patterns pattern))))
4594           (loop (1- i)
4595                 (if (= axis X)
4596                     (markup patterns pattern #:hspace space)
4597                     (markup #:column (patterns pattern #:vspace space))))))))
4598
4599 (define-markup-command (fill-with-pattern layout props space dir pattern left right)
4600   (number? ly:dir? markup? markup? markup?)
4601   #:category align
4602   #:properties ((word-space)
4603                 (line-width))
4604   "
4605 Put @var{left} and @var{right} in a horizontal line of width @code{line-width}
4606 with a line of markups @var{pattern} in between.
4607 Patterns are spaced apart by @var{space}.
4608 Patterns are aligned to the @var{dir} markup.
4609
4610 @lilypond[verbatim, quote]
4611 \\markup \\column {
4612   \"right-aligned :\"
4613   \\fill-with-pattern #1 #RIGHT . first right
4614   \\fill-with-pattern #1 #RIGHT . second right
4615   \\null
4616   \"center-aligned :\"
4617   \\fill-with-pattern #1.5 #CENTER - left right
4618   \\null
4619   \"left-aligned :\"
4620   \\override #'(line-width . 50)
4621   \\fill-with-pattern #2 #LEFT : left first
4622   \\override #'(line-width . 50)
4623   \\fill-with-pattern #2 #LEFT : left second
4624 }
4625 @end lilypond"
4626   (let* ((pattern-x-extent (ly:stencil-extent (interpret-markup layout props pattern) X))
4627          (pattern-width (interval-length pattern-x-extent))
4628          (left-width (interval-length (ly:stencil-extent (interpret-markup layout props left) X)))
4629          (right-width (interval-length (ly:stencil-extent (interpret-markup layout props right) X)))
4630          (middle-width (max 0 (- line-width (+ (+ left-width right-width) (* word-space 2)))))
4631          (period (+ space pattern-width))
4632          (count (truncate (/ (- middle-width pattern-width) period)))
4633          (x-offset (+ (* (- (- middle-width (* count period)) pattern-width) (/ (1+ dir) 2)) (abs (car pattern-x-extent)))))
4634     (interpret-markup layout props
4635                       (markup left
4636                               #:with-dimensions (cons 0 middle-width) '(0 . 0)
4637                               #:translate (cons x-offset 0)
4638                               #:pattern (1+ count) X space pattern
4639                               right))))
4640
4641 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4642 ;; Replacements
4643 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4644
4645 (define-markup-command (replace layout props replacements arg)
4646   (list? markup?)
4647   #:category font
4648   "
4649 Used to automatically replace a string by another in the markup @var{arg}.
4650 Each pair of the alist @var{replacements} specifies what should be replaced.
4651 The @code{key} is the string to be replaced by the @code{value} string.
4652
4653 @lilypond[verbatim, quote]
4654 \\markup \\replace #'((\"thx\" . \"Thanks!\")) thx
4655 @end lilypond"
4656   (interpret-markup
4657    layout
4658    (internal-add-text-replacements
4659     props
4660     replacements)
4661    (markup arg)))
4662
4663 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4664 ;; Markup list commands
4665 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4666
4667 (define-public (space-lines baseline stils)
4668   (let space-stil ((stils stils)
4669                    (result (list)))
4670     (if (null? stils)
4671         (reverse! result)
4672         (let* ((stil (car stils))
4673                (dy-top (max (- (/ baseline 1.5)
4674                                (interval-bound (ly:stencil-extent stil Y) UP))
4675                             0.0))
4676                (dy-bottom (max (+ (/ baseline 3.0)
4677                                   (interval-bound (ly:stencil-extent stil Y) DOWN))
4678                                0.0))
4679                (new-stil (ly:make-stencil
4680                           (ly:stencil-expr stil)
4681                           (ly:stencil-extent stil X)
4682                           (cons (- (interval-bound (ly:stencil-extent stil Y) DOWN)
4683                                    dy-bottom)
4684                                 (+ (interval-bound (ly:stencil-extent stil Y) UP)
4685                                    dy-top)))))
4686           (space-stil (cdr stils) (cons new-stil result))))))
4687
4688 (define-markup-list-command (justified-lines layout props args)
4689   (markup-list?)
4690   #:properties ((baseline-skip)
4691                 wordwrap-internal-markup-list)
4692   "
4693 @cindex justifying lines of text
4694
4695 Like @code{\\justify}, but return a list of lines instead of a single markup.
4696 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width;
4697 @var{X}@tie{}is the number of staff spaces."
4698   (space-lines baseline-skip
4699                (interpret-markup-list layout props
4700                                       (make-wordwrap-internal-markup-list #t args))))
4701
4702 (define-markup-list-command (wordwrap-lines layout props args)
4703   (markup-list?)
4704   #:properties ((baseline-skip)
4705                 wordwrap-internal-markup-list)
4706   "Like @code{\\wordwrap}, but return a list of lines instead of a single markup.
4707 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width,
4708 where @var{X} is the number of staff spaces."
4709   (space-lines baseline-skip
4710                (interpret-markup-list layout props
4711                                       (make-wordwrap-internal-markup-list #f args))))
4712
4713 (define-markup-list-command (column-lines layout props args)
4714   (markup-list?)
4715   #:properties ((baseline-skip))
4716   "Like @code{\\column}, but return a list of lines instead of a single markup.
4717 @code{baseline-skip} determines the space between each markup in @var{args}."
4718   (space-lines baseline-skip
4719                (interpret-markup-list layout props args)))
4720
4721 (define-markup-list-command (override-lines layout props new-prop args)
4722   (pair? markup-list?)
4723   "Like @code{\\override}, for markup lists."
4724   (interpret-markup-list layout (cons (list new-prop) props) args))
4725
4726 (define-markup-list-command (table layout props column-align lst)
4727   (number-list? markup-list?)
4728   #:properties ((padding 0)
4729                 (baseline-skip))
4730   "@cindex creating a table.
4731
4732 Returns a table.
4733
4734 @var{column-align} specifies how each column is aligned, possible values are
4735 -1, 0, 1.  The number of elements in @var{column-align} determines how many
4736 columns will be printed.
4737 The entries to print are given by @var{lst}, a markup-list.  If needed, the last
4738 row is filled up with @code{point-stencil}s.
4739 Overriding @code{padding} may be used to increase columns horizontal distance.
4740 Overriding @code{baseline-skip} to increase rows vertical distance.
4741 @lilypond[verbatim,quote]
4742 \\markuplist {
4743   \\override #'(padding . 2)
4744   \\table
4745     #'(0 1 0 -1)
4746     {
4747       \\underline { center-aligned right-aligned center-aligned left-aligned }
4748       one \\number 1 thousandth \\number 0.001
4749       eleven \\number 11 hundredth \\number 0.01
4750       twenty \\number 20 tenth \\number 0.1
4751       thousand \\number 1000 one \\number 1.0
4752     }
4753 }
4754 @end lilypond
4755 "
4756
4757   (define (split-lst initial-lst lngth result-lst)
4758     ;; split a list into a list of sublists of length lngth
4759     ;; eg. (split-lst '(1 2 3 4 5 6) 2 '())
4760     ;; -> ((1 2) (3 4) (5 6))
4761     (cond ((not (integer? (/ (length initial-lst) lngth)))
4762            (ly:warning
4763             "Can't split list of length ~a into ~a parts, returning empty list"
4764             (length initial-lst) lngth)
4765            '())
4766           ((null? initial-lst)
4767             (reverse result-lst))
4768           (else
4769             (split-lst
4770               (drop initial-lst lngth)
4771               lngth
4772               (cons (take initial-lst lngth) result-lst)))))
4773
4774   (define (dists-list init padding lst)
4775     ;; Returns a list, where each element of `lst' is
4776     ;; added to the sum of the previous elements of `lst' plus padding.
4777     ;; `init' will be the first element of the resulting list. The addition
4778     ;; starts with the values of `init', `padding' and `(car lst)'.
4779     ;; eg. (dists-list 0.01 0.1 '(1 2 3 4)))
4780     ;; -> (0.01 1.11 3.21 6.31 10.41)
4781     (if (or (not (number? init))
4782             (not (number? padding))
4783             (not (number-list? lst)))
4784         (begin
4785           (ly:warning
4786             "not fitting argument for `dists-list', return empty lst ")
4787           '())
4788         (reverse
4789           (fold (lambda (elem rl) (cons (+ elem padding (car rl)) rl))
4790                 (list init)
4791                 lst))))
4792
4793   (let* (;; get the number of columns
4794          (columns (length column-align))
4795          (init-stils (interpret-markup-list layout props lst))
4796          ;; If the given markup-list is the result of a markup-list call, their
4797          ;; length may not be easily predictable, thus we add point-stencils
4798          ;; to fill last row of the table.
4799          (rem (remainder (length init-stils) columns))
4800          (filled-stils
4801            (if (zero? rem)
4802                init-stils
4803                (append init-stils (make-list (- columns rem) point-stencil))))
4804          ;; get the stencils in sublists of length `columns'
4805          (stils
4806            (split-lst filled-stils columns '()))
4807          ;; procedure to return stencil-length
4808          ;; If it is nan, return 0
4809          (lengths-proc
4810            (lambda (m)
4811              (let ((lngth (interval-length (ly:stencil-extent m X))))
4812                (if (nan? lngth) 0 lngth))))
4813          ;; get the max width of each column in a list
4814          (columns-max-x-lengths
4815            (map
4816              (lambda (x)
4817                (apply max 0
4818                       (map
4819                         lengths-proc
4820                         (map (lambda (l) (list-ref l x)) stils))))
4821              (iota columns)))
4822          ;; create a list of (basic) distances, which each column should
4823          ;; moved, using `dists-list'. Some padding may be added.
4824          (dist-sequence
4825            (dists-list 0 padding columns-max-x-lengths))
4826          ;; Get all stencils of a row, moved accurately to build columns.
4827          ;; If the items of a column are aligned other than left, we need to
4828          ;; move them to avoid collisions:
4829          ;; center aligned: move all items half the width of the widest item
4830          ;; right aligned: move all items the full width of the widest item.
4831          ;; Added to the default-offset calculated in `dist-sequence'.
4832          ;; `stencils-for-row-proc' needs four arguments:
4833          ;;    stil    - a stencil
4834          ;;    dist    - a numerical value as basic offset in X direction
4835          ;;    column  - a numerical value for the column we're in
4836          ;;    x-align - a numerical value how current column should be
4837          ;;              aligned, where (-1, 0, 1) means (LEFT, CENTER, RIGHT)
4838          (stencils-for-row-proc
4839            (lambda (stil dist column x-align)
4840              (ly:stencil-translate-axis
4841                (ly:stencil-aligned-to stil X x-align)
4842                (cond ((member x-align '(0 1))
4843                       (let* (;; get the stuff for relevant column
4844                              (stuff-for-column
4845                                (map
4846                                  (lambda (s) (list-ref s column))
4847                                  stils))
4848                              ;; get length of every column-item
4849                              (lengths-for-column
4850                                (map lengths-proc stuff-for-column))
4851                              (widest
4852                                (apply max 0 lengths-for-column)))
4853                         (+ dist (/ widest (if (= x-align 0) 2 1)))))
4854                      (else dist))
4855                X)))
4856          ;; get a list of rows using `ly:stencil-add' on a list of stencils
4857          (rows
4858            (map
4859              (lambda (stil-list)
4860                (apply ly:stencil-add
4861                  (map
4862                    ;; the procedure creating the stencils:
4863                    stencils-for-row-proc
4864                    ;; the procedure's args:
4865                    stil-list
4866                    dist-sequence
4867                    (iota columns)
4868                    column-align)))
4869              stils)))
4870    (space-lines baseline-skip rows)))
4871
4872 (define-markup-list-command (map-markup-commands layout props compose args)
4873   (procedure? markup-list?)
4874   "This applies the function @var{compose} to every markup in
4875 @var{args} (including elements of markup list command calls) in order
4876 to produce a new markup list.  Since the return value from a markup
4877 list command call is not a markup list but rather a list of stencils,
4878 this requires passing those stencils off as the results of individual
4879 markup calls.  That way, the results should work out as long as no
4880 markups rely on side effects."
4881   (let ((key (make-symbol "key")))
4882     (catch
4883      key
4884      (lambda ()
4885        ;; if `compose' does not actually interpret its markup
4886        ;; argument, we still need to return a list of stencils,
4887        ;; created from the single returned stencil
4888        (list
4889         (interpret-markup layout props
4890                           (compose
4891                            (make-on-the-fly-markup
4892                             (lambda (layout props m)
4893                               ;; here all effects of `compose' on the
4894                               ;; properties should be visible, so we
4895                               ;; call interpret-markup-list at this
4896                               ;; point of time and harvest its
4897                               ;; stencils
4898                               (throw key
4899                                      (interpret-markup-list
4900                                       layout props args)))
4901                             (make-null-markup))))))
4902      (lambda (key stencils)
4903        (map
4904         (lambda (sten)
4905           (interpret-markup layout props
4906                             (compose (make-stencil-markup sten))))
4907         stencils)))))