1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2000--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
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.
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.
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/>.
20 ;;; Markup commands and markup-list commands definitions.
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.
28 ;;; (define-markup-command (command-name layout props args...)
30 ;;; [ #:category category ]
31 ;;; [ #:properties property-bindings ]
32 ;;; documentation-string
37 ;;; the name of the markup command
40 ;;; arguments that are automatically passed to the command when it
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)
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.
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.
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
67 ;;; For instance, if a command expects a number, then a markup, the
68 ;;; signature would be: (number? markup?)
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.
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
86 ;;; Thus, using the following property bindings:
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)))
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.)
99 ;;; documentation-string
100 ;;; the command documentation string (used to generate manuals)
103 ;;; the command body. The function is supposed to return a stencil.
105 ;;; Each markup command definition shall have a documentation string
106 ;;; with description, syntax and example.
108 (use-modules (ice-9 regex))
110 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
112 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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)))
118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
120 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
122 (define-markup-command (draw-line layout props dest)
125 #:properties ((thickness 1))
127 @cindex drawing lines within text
130 @lilypond[verbatim,quote]
132 \\draw-line #'(4 . 4)
133 \\override #'(thickness . 5)
134 \\draw-line #'(-3 . 0)
137 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
141 (make-line-stencil th 0 0 x y)))
143 (define-markup-command (draw-dashed-line layout props dest)
146 #:properties ((thickness 1)
152 @cindex drawing dashed lines within text
156 If @code{full-length} is set to #t (default) the dashed-line extends to the
157 whole length given by @var{dest}, without white space at beginning or end.
158 @code{off} will then be altered to fit.
159 To insist on the given (or default) values of @code{on}, @code{off} use
160 @code{\\override #'(full-length . #f)}
161 Manual settings for @code{on},@code{off} and @code{phase} are possible.
162 @lilypond[verbatim,quote]
164 \\draw-dashed-line #'(5.1 . 2.3)
165 \\override #'(on . 0.3)
166 \\override #'(off . 0.5)
167 \\draw-dashed-line #'(5.1 . 2.3)
170 (let* ((line-thickness (ly:output-def-lookup layout 'line-thickness))
171 ;; Calculate the thickness to be used.
172 (th (* line-thickness thickness))
173 (half-thick (/ th 2))
174 ;; Get the extensions in x- and y-direction.
177 ;; Calculate the length of the dashed line.
178 (line-length (sqrt (+ (expt x 2) (expt y 2)))))
180 (if (and full-length (not (= (+ on off) 0)))
182 ;; Add double-thickness to avoid overlapping.
183 (set! off (+ (* 2 th) off))
184 (let* (;; Make a guess how often the off/on-pair should be printed
185 ;; after the initial `on´.
186 ;; Assume a minimum of 1 to avoid division by zero.
187 (guess (max 1 (round (/ (- line-length on) (+ off on)))))
188 ;; Not sure about the value or why corr is necessary at all,
189 ;; but it seems to be necessary.
191 (/ line-thickness 10)
193 ;; Calculate a new value for off to fit the
195 (new-off (/ (- line-length corr (* (1+ guess) on)) guess))
199 ;; Settings for (= on 0). Resulting in a dotted line.
201 ;; If line-length isn't shorter than `th´, change the given
202 ;; value for `off´ to fit the line-length.
203 ((and (= on 0) (< th line-length))
206 ;; If the line-length is shorter than `th´, it makes no
207 ;; sense to adjust `off´. The rounded edges of the lines
208 ;; would prevent any nice output.
210 ;; This will result in a single dot for very short lines.
211 ((and (= on 0) (>= th line-length))
214 ;; Settings for (not (= on 0)). Resulting in a dashed line.
216 ;; If line-length isn't shorter than one go of on-off-on,
217 ;; change the given value for `off´ to fit the line-length.
218 ((< (+ (* 2 on) off) line-length)
220 ;; If the line-length is too short, but greater than
221 ;; (* 4 th) set on/off to (/ line-length 3)
222 ((< (* 4 th) line-length)
223 (set! on (/ line-length 3))
224 (set! off (/ line-length 3)))
225 ;; If the line-length is shorter than (* 4 th), it makes
226 ;; no sense trying to adjust on/off. The rounded edges of
227 ;; the lines would prevent any nice output.
228 ;; Simply set `on´ to line-length.
230 (set! on line-length))))))
232 ;; If `on´ or `off´ is negative, or the sum of `on' and `off' equals zero a
233 ;; ghostscript-error occurs while calling
234 ;; (ly:make-stencil (list 'dashed-line th on off x y phase) x-ext y-ext)
235 ;; Better be paranoid.
236 (if (or (= (+ on off) 0)
240 (ly:warning "Can't print a line - setting on/off to default")
244 ;; To give the lines produced by \draw-line and \draw-dashed-line the same
245 ;; length, half-thick has to be added to the stencil-extensions.
247 (list 'dashed-line th on off x y phase)
248 (interval-widen (ordered-cons 0 x) half-thick)
249 (interval-widen (ordered-cons 0 y) half-thick))))
251 (define-markup-command (draw-dotted-line layout props dest)
254 #:properties ((thickness 1)
258 @cindex drawing dotted lines within text
262 The dotted-line always extends to the whole length given by @var{dest}, without
263 white space at beginning or end.
264 Manual settings for @code{off} are possible to get larger or smaller space
266 The given (or default) value of @code{off} will be altered to fit the
268 @lilypond[verbatim,quote]
270 \\draw-dotted-line #'(5.1 . 2.3)
271 \\override #'(thickness . 2)
272 \\override #'(off . 0.2)
273 \\draw-dotted-line #'(5.1 . 2.3)
277 (let ((new-props (prepend-alist-chain 'on 0
278 (prepend-alist-chain 'full-length #t props))))
280 (interpret-markup layout
282 (markup #:draw-dashed-line dest))))
284 (define-markup-command (draw-hline layout props)
287 #:properties ((draw-line-markup)
291 @cindex drawing a line across a page
293 Draws a line across a page, where the property @code{span-factor}
294 controls what fraction of the page is taken up.
295 @lilypond[verbatim,quote]
299 \\override #'(span-factor . 1/3)
304 (interpret-markup layout
306 (markup #:draw-line (cons (* line-width
310 (define-markup-command (draw-circle layout props radius thickness filled)
311 (number? number? boolean?)
314 @cindex drawing circles within text
316 A circle of radius @var{radius} and thickness @var{thickness},
319 @lilypond[verbatim,quote]
321 \\draw-circle #2 #0.5 ##f
323 \\draw-circle #2 #0 ##t
326 (make-circle-stencil radius thickness filled))
328 (define-markup-command (triangle layout props filled)
331 #:properties ((thickness 0.1)
335 @cindex drawing triangles within text
337 A triangle, either filled or empty.
339 @lilypond[verbatim,quote]
346 (let ((ex (* (magstep font-size) 0.8 baseline-skip)))
355 (cons 0 (* .86 ex)))))
357 (define-markup-command (circle layout props arg)
360 #:properties ((thickness 1)
362 (circle-padding 0.2))
364 @cindex circling text
366 Draw a circle around @var{arg}. Use @code{thickness},
367 @code{circle-padding} and @code{font-size} properties to determine line
368 thickness and padding around the markup.
370 @lilypond[verbatim,quote]
377 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
379 (pad (* (magstep font-size) circle-padding))
380 (m (interpret-markup layout props arg)))
381 (circle-stencil m th pad)))
383 (define-markup-command (ellipse layout props arg)
386 #:properties ((thickness 1)
391 @cindex drawing ellipse around text
393 Draw an ellipse around @var{arg}. Use @code{thickness},
394 @code{x-padding}, @code{y-padding} and @code{font-size} properties to determine
395 line thickness and padding around the markup.
397 @lilypond[verbatim,quote]
404 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
406 (pad-x (* (magstep font-size) x-padding))
407 (pad-y (* (magstep font-size) y-padding))
408 (m (interpret-markup layout props arg)))
409 (ellipse-stencil m th pad-x pad-y)))
411 (define-markup-command (oval layout props arg)
414 #:properties ((thickness 1)
419 @cindex drawing oval around text
421 Draw an oval around @var{arg}. Use @code{thickness},
422 @code{x-padding}, @code{x-padding} and @code{font-size} properties to determine
423 line thickness and padding around the markup.
425 @lilypond[verbatim,quote]
432 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
434 (pad-x (* (magstep font-size) x-padding))
435 (pad-y (* (magstep font-size) y-padding))
436 (m (interpret-markup layout props arg)))
437 (oval-stencil m th pad-x pad-y)))
439 (define-markup-command (with-url layout props url arg)
443 @cindex inserting URL links into text
445 Add a link to URL @var{url} around @var{arg}. This only works in
448 @lilypond[verbatim,quote]
450 \\with-url #\"http://lilypond.org/\" {
451 LilyPond ... \\italic {
452 music notation for everyone
457 (let* ((stil (interpret-markup layout props arg))
458 (xextent (ly:stencil-extent stil X))
459 (yextent (ly:stencil-extent stil Y))
460 (old-expr (ly:stencil-expr stil))
461 (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent))))
463 (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil)))
465 (define-markup-command (page-link layout props page-number arg)
469 @cindex referencing page numbers in text
471 Add a link to the page @var{page-number} around @var{arg}. This only works
474 @lilypond[verbatim,quote]
476 \\page-link #2 { \\italic { This links to page 2... } }
479 (let* ((stil (interpret-markup layout props arg))
480 (xextent (ly:stencil-extent stil X))
481 (yextent (ly:stencil-extent stil Y))
482 (old-expr (ly:stencil-expr stil))
483 (link-expr (list 'page-link page-number `(quote ,xextent) `(quote ,yextent))))
485 (ly:stencil-add (ly:make-stencil link-expr xextent yextent) stil)))
487 (define-markup-command (with-link layout props label arg)
491 @cindex referencing page labels in text
493 Add a link to the page holding label @var{label} around @var{arg}. This
494 only works in the PDF backend.
496 @lilypond[verbatim,quote]
498 \\with-link #'label {
499 \\italic { This links to the page containing the label... }
503 (let* ((arg-stencil (interpret-markup layout props arg))
504 (x-ext (ly:stencil-extent arg-stencil X))
505 (y-ext (ly:stencil-extent arg-stencil Y)))
508 `(delay-stencil-evaluation
509 ,(delay (let* ((table (ly:output-def-lookup layout 'label-page-table))
510 (page-number (if (list? table)
511 (assoc-get label table)
513 (list 'page-link page-number
514 `(quote ,x-ext) `(quote ,y-ext)))))
520 (define-markup-command (beam layout props width slope thickness)
521 (number? number? number?)
524 @cindex drawing beams within text
526 Create a beam with the specified parameters.
527 @lilypond[verbatim,quote]
532 (let* ((y (* slope width))
533 (yext (cons (min 0 y) (max 0 y)))
534 (half (/ thickness 2)))
539 width (+ (* width slope) (/ thickness -2))
540 width (+ (* width slope) (/ thickness 2))
542 ,(ly:output-def-lookup layout 'blot-diameter)
545 (cons (+ (- half) (car yext))
546 (+ half (cdr yext))))))
548 (define-markup-command (underline layout props arg)
551 #:properties ((thickness 1) (offset 2))
553 @cindex underlining text
555 Underline @var{arg}. Looks at @code{thickness} to determine line
556 thickness, and @code{offset} to determine line y-offset.
558 @lilypond[verbatim,quote]
559 \\markup \\fill-line {
560 \\underline \"underlined\"
561 \\override #'(offset . 5)
562 \\override #'(thickness . 1)
563 \\underline \"underlined\"
564 \\override #'(offset . 1)
565 \\override #'(thickness . 5)
566 \\underline \"underlined\"
569 (let* ((thick (ly:output-def-lookup layout 'line-thickness))
570 (underline-thick (* thickness thick))
571 (markup (interpret-markup layout props arg))
572 (x1 (car (ly:stencil-extent markup X)))
573 (x2 (cdr (ly:stencil-extent markup X)))
574 (y (* thick (- offset)))
575 (line (make-line-stencil underline-thick x1 y x2 y)))
576 (ly:stencil-add markup line)))
578 (define-markup-command (box layout props arg)
581 #:properties ((thickness 1)
585 @cindex enclosing text within a box
587 Draw a box round @var{arg}. Looks at @code{thickness},
588 @code{box-padding} and @code{font-size} properties to determine line
589 thickness and padding around the markup.
591 @lilypond[verbatim,quote]
593 \\override #'(box-padding . 0.5)
598 (let* ((th (* (ly:output-def-lookup layout 'line-thickness)
600 (pad (* (magstep font-size) box-padding))
601 (m (interpret-markup layout props arg)))
602 (box-stencil m th pad)))
604 (define-markup-command (filled-box layout props xext yext blot)
605 (number-pair? number-pair? number?)
608 @cindex drawing solid boxes within text
609 @cindex drawing boxes with rounded corners
611 Draw a box with rounded corners of dimensions @var{xext} and
612 @var{yext}. For example,
614 \\filled-box #'(-.3 . 1.8) #'(-.3 . 1.8) #0
616 creates a box extending horizontally from -0.3 to 1.8 and
617 vertically from -0.3 up to 1.8, with corners formed from a
618 circle of diameter@tie{}0 (i.e., sharp corners).
620 @lilypond[verbatim,quote]
622 \\filled-box #'(0 . 4) #'(0 . 4) #0
623 \\filled-box #'(0 . 2) #'(-4 . 2) #0.4
624 \\filled-box #'(1 . 8) #'(0 . 7) #0.2
626 \\filled-box #'(-4.5 . -2.5) #'(3.5 . 5.5) #0.7
632 (define-markup-command (rounded-box layout props arg)
635 #:properties ((thickness 1)
639 "@cindex enclosing text in a box with rounded corners
640 @cindex drawing boxes with rounded corners around text
641 Draw a box with rounded corners around @var{arg}. Looks at @code{thickness},
642 @code{box-padding} and @code{font-size} properties to determine line
643 thickness and padding around the markup; the @code{corner-radius} property
644 makes it possible to define another shape for the corners (default is 1).
646 @lilypond[quote,verbatim,relative=2]
654 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
656 (pad (* (magstep font-size) box-padding))
657 (m (interpret-markup layout props arg)))
658 (ly:stencil-add (rounded-box-stencil m th pad corner-radius)
661 (define-markup-command (rotate layout props ang arg)
665 @cindex rotating text
667 Rotate object with @var{ang} degrees around its center.
669 @lilypond[verbatim,quote]
679 (let* ((stil (interpret-markup layout props arg)))
680 (ly:stencil-rotate stil ang 0 0)))
682 (define-markup-command (whiteout layout props arg)
686 @cindex adding a white background to text
688 Provide a white background for @var{arg}.
690 @lilypond[verbatim,quote]
693 \\filled-box #'(-1 . 10) #'(-3 . 4) #1
697 (stencil-whiteout (interpret-markup layout props arg)))
699 (define-markup-command (pad-markup layout props amount arg)
704 @cindex putting space around text
706 Add space around a markup object.
707 Identical to @code{pad-around}.
709 @lilypond[verbatim,quote]
722 (let* ((m (interpret-markup layout props arg))
723 (x (interval-widen (ly:stencil-extent m X) amount))
724 (y (interval-widen (ly:stencil-extent m Y) amount)))
725 (ly:stencil-add (make-transparent-box-stencil x y)
728 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
730 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
732 (define-markup-command (strut layout props)
736 @cindex creating vertical spaces in text
738 Create a box of the same height as the space in the current font."
739 (let ((m (ly:text-interface::interpret-markup layout props " ")))
740 (ly:make-stencil (ly:stencil-expr m)
742 (ly:stencil-extent m X)
745 (define-markup-command (hspace layout props amount)
749 @cindex creating horizontal spaces in text
751 Create an invisible object taking up horizontal space @var{amount}.
753 @lilypond[verbatim,quote]
762 (ly:make-stencil "" (cons 0 amount) empty-interval))
764 (define-markup-command (vspace layout props amount)
768 @cindex creating vertical spaces in text
770 Create an invisible object taking up vertical space
771 of @var{amount} multiplied by 3.
773 @lilypond[verbatim,quote]
784 (let ((amount (* amount 3.0)))
785 (ly:make-stencil "" empty-interval (cons 0 amount))))
788 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
789 ;; importing graphics.
790 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
792 (define-markup-command (stencil layout props stil)
796 @cindex importing stencils into text
798 Use a stencil as markup.
800 @lilypond[verbatim,quote]
802 \\stencil #(make-circle-stencil 2 0 #t)
808 (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)"))
810 (define (get-postscript-bbox string)
811 "Extract the bbox from STRING, or return #f if not present."
813 ((match (regexp-exec bbox-regexp string)))
817 (string->number (match:substring match x)))
822 (define-markup-command (epsfile layout props axis size file-name)
823 (number? number? string?)
826 @cindex inlining an Encapsulated PostScript image
828 Inline an EPS image. The image is scaled along @var{axis} to
831 @lilypond[verbatim,quote]
833 \\general-align #Y #DOWN {
834 \\epsfile #X #20 #\"context-example.eps\"
835 \\epsfile #Y #20 #\"context-example.eps\"
839 (if (ly:get-option 'safe)
840 (interpret-markup layout props "not allowed in safe")
841 (eps-file->stencil axis size file-name)
844 (define-markup-command (postscript layout props str)
848 @cindex inserting PostScript directly into text
849 This inserts @var{str} directly into the output as a PostScript
852 @lilypond[verbatim,quote]
856 0.4 0.6 0.5 0 361 arc
858 1.0 0.6 0.5 0 361 arc
863 \\with-dimensions #'(-0.2 . 1.6) #'(0 . 1.2)
864 \\postscript #ringsps
876 gsave currentpoint translate
884 (define-markup-command (path layout props thickness commands) (number? list?)
886 #:properties ((line-cap-style 'round)
887 (line-join-style 'round)
890 @cindex paths, drawing
891 @cindex drawing paths
892 Draws a path with line thickness @var{thickness} according to the
893 directions given in @var{commands}. @var{commands} is a list of
894 lists where the @code{car} of each sublist is a drawing command and
895 the @code{cdr} comprises the associated arguments for each command.
897 Line-cap styles and line-join styles may be customized by
898 overriding the @code{line-cap-style} and @code{line-join-style}
899 properties, respectively. Available line-cap styles are
900 @code{'butt}, @code{'round}, and @code{'square}. Available
901 line-join styles are @code{'miter}, @code{'round}, and
904 The property @code{filled} specifies whether or not the path is
907 There are seven commands available to use in the list
908 @code{commands}: @code{moveto}, @code{rmoveto}, @code{lineto},
909 @code{rlineto}, @code{curveto}, @code{rcurveto}, and
910 @code{closepath}. Note that the commands that begin with @emph{r}
911 are the relative variants of the other three commands.
913 The commands @code{moveto}, @code{rmoveto}, @code{lineto}, and
914 @code{rlineto} take 2 arguments; they are the X and Y coordinates
915 for the destination point.
917 The commands @code{curveto} and @code{rcurveto} create cubic
918 Bézier curves, and take 6 arguments; the first two are the X and Y
919 coordinates for the first control point, the second two are the X
920 and Y coordinates for the second control point, and the last two
921 are the X and Y coordinates for the destination point.
923 The @code{closepath} command takes zero arguments and closes the
924 current subpath in the active path.
926 Note that a sequence of commands @emph{must} begin with a
927 @code{moveto} or @code{rmoveto} to work with the SVG output.
929 @lilypond[verbatim,quote]
935 (curveto -5 -5 -5 5 -1 0)
939 \\path #0.25 #samplePath
942 (let* ((half-thickness (/ thickness 2))
943 (current-point '(0 . 0))
944 (set-point (lambda (lst) (set! current-point lst)))
945 (relative? (lambda (x)
946 (string-prefix? "r" (symbol->string (car x)))))
947 ;; For calculating extents, we want to modify the command
948 ;; list so that all coordinates are absolute.
949 (new-commands (map (lambda (x)
951 ;; for rmoveto, rlineto
952 ((and (relative? x) (= 3 (length x)))
954 (+ (car current-point)
956 (+ (cdr current-point)
962 ((and (relative? x) (= 7 (length x)))
963 (let* ((old-cp current-point)
970 (list (+ (car old-cp) (second x))
971 (+ (cdr old-cp) (third x))
972 (+ (car old-cp) (fourth x))
973 (+ (cdr old-cp) (fifth x))
976 ;; for moveto, lineto
978 (set-point (cons (second x)
983 (set-point (cons (sixth x)
986 ;; keep closepath for filtering;
987 ;; see `without-closepath'.
990 ;; path-min-max does not accept 0-arg lists,
991 ;; and since closepath does not affect extents, filter
992 ;; out those commands here.
993 (without-closepath (filter (lambda (x)
994 (not (equal? 'closepath (car x))))
996 (extents (path-min-max
997 ;; set the origin to the first moveto
998 (list (list-ref (car without-closepath) 0)
999 (list-ref (car without-closepath) 1))
1001 (X-extent (cons (list-ref extents 0) (list-ref extents 1)))
1002 (Y-extent (cons (list-ref extents 2) (list-ref extents 3)))
1003 (command-list (fold-right append '() commands)))
1005 ;; account for line thickness
1006 (set! X-extent (interval-widen X-extent half-thickness))
1007 (set! Y-extent (interval-widen Y-extent half-thickness))
1010 `(path ,thickness `(,@',command-list)
1011 ',line-cap-style ',line-join-style ,filled)
1015 (define-markup-list-command (score-lines layout props score)
1017 "This is the same as the @code{\\score} markup but delivers its
1018 systems as a list of lines. Its @var{score} argument is entered in
1019 braces like it would be for @code{\\score}."
1020 (let ((output (ly:score-embedded-format score layout)))
1022 (if (ly:music-output? output)
1024 (lambda (paper-system)
1025 ;; shift such that the refpoint of the bottom staff of
1026 ;; the first system is the baseline of the score
1027 (ly:stencil-translate-axis
1028 (paper-system-stencil paper-system)
1029 (- (car (paper-system-staff-extents paper-system)))
1031 (vector->list (ly:paper-score-paper-systems output)))
1033 (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?"))
1036 (define-markup-command (score layout props score)
1039 #:properties ((baseline-skip))
1041 @cindex inserting music into text
1043 Inline an image of music. The reference point (usually the middle
1044 staff line) of the lowest staff in the top system is placed on the
1047 @lilypond[verbatim,quote]
1051 \\new Staff \\relative c' {
1054 \\mark \\markup { Allegro }
1060 \\new Staff \\relative c {
1066 f,( bes d bes d bes)
1074 \\override RehearsalMark
1075 #'break-align-symbols = #'(time-signature key-signature)
1076 \\override RehearsalMark
1077 #'self-alignment-X = #LEFT
1081 \\override TimeSignature
1082 #'break-align-anchor-alignment = #LEFT
1088 (stack-stencils Y DOWN baseline-skip
1089 (score-lines-markup-list layout props score)))
1091 (define-markup-command (null layout props)
1095 @cindex creating empty text objects
1097 An empty markup with extents of a single point.
1099 @lilypond[verbatim,quote]
1106 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1107 ;; basic formatting.
1108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1110 (define-markup-command (simple layout props str)
1114 @cindex simple text strings
1116 A simple text string; @code{\\markup @{ foo @}} is equivalent with
1117 @code{\\markup @{ \\simple #\"foo\" @}}.
1119 Note: for creating standard text markup or defining new markup commands,
1120 the use of @code{\\simple} is unnecessary.
1122 @lilypond[verbatim,quote]
1124 \\simple #\"simple\"
1126 \\simple #\"strings\"
1129 (interpret-markup layout props str))
1131 (define-markup-command (tied-lyric layout props str)
1134 #:properties ((word-space))
1136 @cindex simple text strings with tie characters
1138 Like simple-markup, but use tie characters for @q{~} tilde symbols.
1140 @lilypond[verbatim,quote]
1142 \\tied-lyric #\"Siam navi~all'onde~algenti Lasciate~in abbandono\"
1143 \\tied-lyric #\"Impetuosi venti I nostri~affetti sono\"
1144 \\tied-lyric #\"Ogni diletto~e scoglio Tutta la vita~e~un mar.\"
1147 (define (replace-ties tie str)
1148 (if (string-contains str "~")
1150 ((half-space (/ word-space 2))
1151 (parts (string-split str #\~))
1152 (tie-str (markup #:hspace half-space
1154 #:hspace half-space))
1155 (joined (list-join parts tie-str)))
1156 (make-concat-markup joined))
1159 (define short-tie-regexp (make-regexp "~[^.]~"))
1160 (define (match-short str) (regexp-exec short-tie-regexp str))
1162 (define (replace-short str mkp)
1163 (let ((match (match-short str)))
1165 (make-concat-markup (list
1167 (replace-ties "ties.lyric.default" str)))
1168 (let ((new-str (match:suffix match))
1169 (new-mkp (make-concat-markup (list
1171 (replace-ties "ties.lyric.default"
1172 (match:prefix match))
1173 (replace-ties "ties.lyric.short"
1174 (match:substring match))))))
1175 (replace-short new-str new-mkp)))))
1177 (interpret-markup layout
1179 (replace-short str (markup))))
1181 (define-public empty-markup
1182 (make-simple-markup ""))
1184 ;; helper for justifying lines.
1185 (define (get-fill-space word-count line-width word-space text-widths)
1186 "Calculate the necessary paddings between each two adjacent texts.
1187 The lengths of all texts are stored in @var{text-widths}.
1188 The normal formula for the padding between texts a and b is:
1189 padding = line-width/(word-count - 1) - (length(a) + length(b))/2
1190 The first and last padding have to be calculated specially using the
1191 whole length of the first or last text.
1192 All paddings are checked to be at least word-space, to ensure that
1194 Return a list of paddings."
1196 ((null? text-widths) '())
1198 ;; special case first padding
1199 ((= (length text-widths) word-count)
1201 (- (- (/ line-width (1- word-count)) (car text-widths))
1202 (/ (car (cdr text-widths)) 2))
1203 (get-fill-space word-count line-width word-space (cdr text-widths))))
1204 ;; special case last padding
1205 ((= (length text-widths) 2)
1206 (list (- (/ line-width (1- word-count))
1207 (+ (/ (car text-widths) 2) (car (cdr text-widths)))) 0))
1209 (let ((default-padding
1210 (- (/ line-width (1- word-count))
1211 (/ (+ (car text-widths) (car (cdr text-widths))) 2))))
1213 (if (> word-space default-padding)
1216 (get-fill-space word-count line-width word-space (cdr text-widths)))))))
1218 (define-markup-command (fill-line layout props args)
1221 #:properties ((text-direction RIGHT)
1224 "Put @var{markups} in a horizontal line of width @var{line-width}.
1225 The markups are spaced or flushed to fill the entire line.
1226 If there are no arguments, return an empty stencil.
1228 @lilypond[verbatim,quote]
1232 Words evenly spaced across the page
1236 \\line { Text markups }
1238 \\italic { evenly spaced }
1240 \\line { across the page }
1245 (let* ((orig-stencils (interpret-markup-list layout props args))
1248 (if (ly:stencil-empty? stc)
1250 stc)) orig-stencils))
1253 (if (ly:stencil-empty? stc)
1255 (interval-length (ly:stencil-extent stc X))))
1257 (text-width (apply + text-widths))
1258 (word-count (length stencils))
1259 (line-width (or line-width (ly:output-def-lookup layout 'line-width)))
1264 (/ (- line-width text-width) 2)
1265 (/ (- line-width text-width) 2)))
1268 (- line-width text-width)))
1270 (get-fill-space word-count line-width word-space text-widths))))
1272 (line-contents (if (= word-count 1)
1279 (if (null? (remove ly:stencil-empty? orig-stencils))
1282 (if (= text-direction LEFT)
1283 (set! line-contents (reverse line-contents)))
1285 (stack-stencils-padding-list
1286 X RIGHT fill-space line-contents))
1287 (if (> word-count 1)
1288 ;; shift s.t. stencils align on the left edge, even if
1289 ;; first stencil had negative X-extent (e.g. center-column)
1290 ;; (if word-count = 1, X-extents are already normalized in
1291 ;; the definition of line-contents)
1293 (ly:stencil-translate-axis
1295 (- (car (ly:stencil-extent (car stencils) X)))
1299 (define-markup-command (line layout props args)
1302 #:properties ((word-space)
1303 (text-direction RIGHT))
1304 "Put @var{args} in a horizontal line. The property @code{word-space}
1305 determines the space between markups in @var{args}.
1307 @lilypond[verbatim,quote]
1314 (let ((stencils (interpret-markup-list layout props args)))
1315 (if (= text-direction LEFT)
1316 (set! stencils (reverse stencils)))
1317 (stack-stencil-line word-space stencils)))
1319 (define-markup-command (concat layout props args)
1323 @cindex concatenating text
1324 @cindex ligatures in text
1326 Concatenate @var{args} in a horizontal line, without spaces in between.
1327 Strings and simple markups are concatenated on the input level, allowing
1328 ligatures. For example, @code{\\concat @{ \"f\" \\simple #\"i\" @}} is
1329 equivalent to @code{\"fi\"}.
1331 @lilypond[verbatim,quote]
1340 (define (concat-string-args arg-list)
1341 (fold-right (lambda (arg result-list)
1342 (let ((result (if (pair? result-list)
1345 (if (and (pair? arg) (eqv? (car arg) simple-markup))
1346 (set! arg (cadr arg)))
1347 (if (and (string? result) (string? arg))
1348 (cons (string-append arg result) (cdr result-list))
1349 (cons arg result-list))))
1353 (interpret-markup layout
1354 (prepend-alist-chain 'word-space 0 props)
1356 (make-override-lines-markup-list
1358 (chain-assoc-get 'word-space props))
1359 (if (markup-command-list? args)
1361 (concat-string-args args))))))
1363 (define (wordwrap-stencils stencils
1364 justify base-space line-width text-dir)
1365 "Perform simple wordwrap, return stencil of each line."
1366 (define space (if justify
1367 ;; justify only stretches lines.
1370 (define (stencil-len s)
1371 (interval-end (ly:stencil-extent s X)))
1372 (define (maybe-shift line)
1373 (if (= text-dir LEFT)
1374 (ly:stencil-translate-axis
1376 (- line-width (stencil-len line))
1379 (if (null? stencils)
1381 (let loop ((lines '())
1384 ((line (first todo))
1386 (word-list (list (first todo))))
1389 (let ((new (if (= text-dir LEFT)
1390 (ly:stencil-stack (car todo) X RIGHT line space)
1391 (ly:stencil-stack line X RIGHT (car todo) space))))
1393 ((<= (stencil-len new) line-width)
1394 (word-loop new (cdr todo)
1395 (cons (car todo) word-list)))
1398 ;; This depends on stencil stacking being
1399 ;; associative so that stacking
1400 ;; left-to-right and right-to-left leads to
1402 (if (= text-dir LEFT)
1404 (reverse! word-list)))
1405 (len (stencil-len line))
1406 (stretch (- line-width len))
1409 (stack-stencils X RIGHT (1+ space) word-list))
1412 ;; Uh oh, nothing to fill.
1413 (loop (cons (maybe-shift line) lines) todo)
1415 (stack-stencils X RIGHT
1416 (+ space (/ stretch spaces))
1420 (else ;; not justify
1421 (loop (cons (maybe-shift line) lines) todo)))))
1424 ;; Now we have the last line assembled with space
1425 ;; which is compressed. We want to use the
1426 ;; uncompressed version instead if it fits, and the
1427 ;; justified version if it doesn't.
1429 ;; This depends on stencil stacking being
1430 ;; associative so that stacking
1431 ;; left-to-right and right-to-left leads to
1433 (if (= text-dir LEFT)
1435 (reverse! word-list)))
1436 (big-line (stack-stencils X RIGHT base-space word-list))
1437 (big-len (stencil-len big-line))
1438 (len (stencil-len line)))
1441 (if (> big-len line-width)
1442 (stack-stencils X RIGHT
1445 (* (- big-len line-width)
1447 (* (- line-width len)
1451 (maybe-shift big-line))))))
1452 (else ;; not justify
1453 (reverse! lines (list (maybe-shift line)))))))))
1456 (define-markup-list-command (wordwrap-internal layout props justify args)
1457 (boolean? markup-list?)
1458 #:properties ((line-width #f)
1460 (text-direction RIGHT))
1461 "Internal markup list command used to define @code{\\justify} and @code{\\wordwrap}."
1462 (wordwrap-stencils (interpret-markup-list layout props args)
1466 (ly:output-def-lookup layout 'line-width))
1469 (define-markup-command (justify layout props args)
1472 #:properties ((baseline-skip)
1473 wordwrap-internal-markup-list)
1475 @cindex justifying text
1477 Like @code{\\wordwrap}, but with lines stretched to justify the margins.
1478 Use @code{\\override #'(line-width . @var{X})} to set the line width;
1479 @var{X}@tie{}is the number of staff spaces.
1481 @lilypond[verbatim,quote]
1484 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1485 do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1486 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1487 laboris nisi ut aliquip ex ea commodo consequat.
1491 (stack-lines DOWN 0.0 baseline-skip
1492 (wordwrap-internal-markup-list layout props #t args)))
1494 (define-markup-command (wordwrap layout props args)
1497 #:properties ((baseline-skip)
1498 wordwrap-internal-markup-list)
1499 "Simple wordwrap. Use @code{\\override #'(line-width . @var{X})} to set
1500 the line width, where @var{X} is the number of staff spaces.
1502 @lilypond[verbatim,quote]
1505 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1506 do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1507 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1508 laboris nisi ut aliquip ex ea commodo consequat.
1512 (stack-lines DOWN 0.0 baseline-skip
1513 (wordwrap-internal-markup-list layout props #f args)))
1515 (define-markup-list-command (wordwrap-string-internal layout props justify arg)
1517 #:properties ((line-width)
1519 (text-direction RIGHT))
1520 "Internal markup list command used to define @code{\\justify-string} and
1521 @code{\\wordwrap-string}."
1522 (let* ((para-strings (regexp-split
1523 (string-regexp-substitute
1525 (string-regexp-substitute "\r\n" "\n" arg))
1526 "\n[ \t\n]*\n[ \t\n]*"))
1527 (list-para-words (map (lambda (str)
1528 (regexp-split str "[ \t\n]+"))
1530 (para-lines (map (lambda (words)
1533 (interpret-markup layout props x))
1535 (wordwrap-stencils stencils
1537 line-width text-direction)))
1539 (concatenate para-lines)))
1541 (define-markup-command (wordwrap-string layout props arg)
1544 #:properties ((baseline-skip)
1545 wordwrap-string-internal-markup-list)
1546 "Wordwrap a string. Paragraphs may be separated with double newlines.
1548 @lilypond[verbatim,quote]
1550 \\override #'(line-width . 40)
1551 \\wordwrap-string #\"Lorem ipsum dolor sit amet, consectetur
1552 adipisicing elit, sed do eiusmod tempor incididunt ut labore
1553 et dolore magna aliqua.
1556 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1557 laboris nisi ut aliquip ex ea commodo consequat.
1560 Excepteur sint occaecat cupidatat non proident, sunt in culpa
1561 qui officia deserunt mollit anim id est laborum\"
1564 (stack-lines DOWN 0.0 baseline-skip
1565 (wordwrap-string-internal-markup-list layout props #f arg)))
1567 (define-markup-command (justify-string layout props arg)
1570 #:properties ((baseline-skip)
1571 wordwrap-string-internal-markup-list)
1572 "Justify a string. Paragraphs may be separated with double newlines
1574 @lilypond[verbatim,quote]
1576 \\override #'(line-width . 40)
1577 \\justify-string #\"Lorem ipsum dolor sit amet, consectetur
1578 adipisicing elit, sed do eiusmod tempor incididunt ut labore
1579 et dolore magna aliqua.
1582 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1583 laboris nisi ut aliquip ex ea commodo consequat.
1586 Excepteur sint occaecat cupidatat non proident, sunt in culpa
1587 qui officia deserunt mollit anim id est laborum\"
1590 (stack-lines DOWN 0.0 baseline-skip
1591 (wordwrap-string-internal-markup-list layout props #t arg)))
1593 (define-markup-command (wordwrap-field layout props symbol)
1596 "Wordwrap the data which has been assigned to @var{symbol}.
1598 @lilypond[verbatim,quote]
1600 title = \"My title\"
1601 myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1602 elit, sed do eiusmod tempor incididunt ut labore et dolore
1603 magna aliqua. Ut enim ad minim veniam, quis nostrud
1604 exercitation ullamco laboris nisi ut aliquip ex ea commodo
1609 bookTitleMarkup = \\markup {
1611 \\fill-line { \\fromproperty #'header:title }
1613 \\wordwrap-field #'header:myText
1622 (let* ((m (chain-assoc-get symbol props)))
1624 (wordwrap-string-markup layout props m)
1627 (define-markup-command (justify-field layout props symbol)
1630 "Justify the data which has been assigned to @var{symbol}.
1632 @lilypond[verbatim,quote]
1634 title = \"My title\"
1635 myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1636 elit, sed do eiusmod tempor incididunt ut labore et dolore magna
1637 aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
1638 laboris nisi ut aliquip ex ea commodo consequat.\"
1642 bookTitleMarkup = \\markup {
1644 \\fill-line { \\fromproperty #'header:title }
1646 \\justify-field #'header:myText
1655 (let* ((m (chain-assoc-get symbol props)))
1657 (justify-string-markup layout props m)
1660 (define-markup-command (combine layout props arg1 arg2)
1664 @cindex merging text
1666 Print two markups on top of each other.
1668 Note: @code{\\combine} cannot take a list of markups enclosed in
1669 curly braces as an argument; the follow example will not compile:
1672 \\combine @{ a list @}
1675 @lilypond[verbatim,quote]
1678 \\override #'(thickness . 2)
1680 \\draw-line #'(0 . 4)
1681 \\arrow-head #Y #DOWN ##f
1684 (let* ((s1 (interpret-markup layout props arg1))
1685 (s2 (interpret-markup layout props arg2)))
1686 (ly:stencil-add s1 s2)))
1689 ;; TODO: should extract baseline-skip from each argument somehow..
1691 (define-markup-command (column layout props args)
1694 #:properties ((baseline-skip))
1696 @cindex stacking text in a column
1698 Stack the markups in @var{args} vertically. The property
1699 @code{baseline-skip} determines the space between markups
1702 @lilypond[verbatim,quote]
1711 (let ((arg-stencils (interpret-markup-list layout props args)))
1712 (stack-lines -1 0.0 baseline-skip arg-stencils)))
1714 (define-markup-command (dir-column layout props args)
1717 #:properties ((direction)
1720 @cindex changing direction of text columns
1722 Make a column of @var{args}, going up or down, depending on the
1723 setting of the @code{direction} layout property.
1725 @lilypond[verbatim,quote]
1727 \\override #`(direction . ,UP) {
1737 \\override #'(direction . 1) {
1744 (stack-lines (if (number? direction) direction -1)
1747 (interpret-markup-list layout props args)))
1749 (define (general-column align-dir baseline mols)
1750 "Stack @var{mols} vertically, aligned to @var{align-dir} horizontally."
1752 (let* ((aligned-mols (map (lambda (x) (ly:stencil-aligned-to x X align-dir)) mols))
1753 (stacked-stencil (stack-lines -1 0.0 baseline aligned-mols))
1754 (stacked-extent (ly:stencil-extent stacked-stencil X)))
1755 (ly:stencil-translate-axis stacked-stencil (- (car stacked-extent)) X )))
1757 (define-markup-command (center-column layout props args)
1760 #:properties ((baseline-skip))
1762 @cindex centering a column of text
1764 Put @code{args} in a centered column.
1766 @lilypond[verbatim,quote]
1775 (general-column CENTER baseline-skip (interpret-markup-list layout props args)))
1777 (define-markup-command (left-column layout props args)
1780 #:properties ((baseline-skip))
1782 @cindex text columns, left-aligned
1784 Put @code{args} in a left-aligned column.
1786 @lilypond[verbatim,quote]
1795 (general-column LEFT baseline-skip (interpret-markup-list layout props args)))
1797 (define-markup-command (right-column layout props args)
1800 #:properties ((baseline-skip))
1802 @cindex text columns, right-aligned
1804 Put @code{args} in a right-aligned column.
1806 @lilypond[verbatim,quote]
1815 (general-column RIGHT baseline-skip (interpret-markup-list layout props args)))
1817 (define-markup-command (vcenter layout props arg)
1821 @cindex vertically centering text
1823 Align @code{arg} to its Y@tie{}center.
1825 @lilypond[verbatim,quote]
1833 (let* ((mol (interpret-markup layout props arg)))
1834 (ly:stencil-aligned-to mol Y CENTER)))
1836 (define-markup-command (center-align layout props arg)
1840 @cindex horizontally centering text
1842 Align @code{arg} to its X@tie{}center.
1844 @lilypond[verbatim,quote]
1854 (let* ((mol (interpret-markup layout props arg)))
1855 (ly:stencil-aligned-to mol X CENTER)))
1857 (define-markup-command (right-align layout props arg)
1861 @cindex right aligning text
1863 Align @var{arg} on its right edge.
1865 @lilypond[verbatim,quote]
1875 (let* ((m (interpret-markup layout props arg)))
1876 (ly:stencil-aligned-to m X RIGHT)))
1878 (define-markup-command (left-align layout props arg)
1882 @cindex left aligning text
1884 Align @var{arg} on its left edge.
1886 @lilypond[verbatim,quote]
1896 (let* ((m (interpret-markup layout props arg)))
1897 (ly:stencil-aligned-to m X LEFT)))
1899 (define-markup-command (general-align layout props axis dir arg)
1900 (integer? number? markup?)
1903 @cindex controlling general text alignment
1905 Align @var{arg} in @var{axis} direction to the @var{dir} side.
1907 @lilypond[verbatim,quote]
1911 \\general-align #X #LEFT
1916 \\general-align #X #CENTER
1922 \\general-align #Y #UP
1929 \\general-align #Y #3.2
1936 (let* ((m (interpret-markup layout props arg)))
1937 (ly:stencil-aligned-to m axis dir)))
1939 (define-markup-command (halign layout props dir arg)
1943 @cindex setting horizontal text alignment
1945 Set horizontal alignment. If @var{dir} is @w{@code{-1}}, then it is
1946 left-aligned, while @code{+1} is right. Values in between interpolate
1947 alignment accordingly.
1949 @lilypond[verbatim,quote]
1974 (let* ((m (interpret-markup layout props arg)))
1975 (ly:stencil-aligned-to m X dir)))
1977 (define-markup-command (with-dimensions layout props x y arg)
1978 (number-pair? number-pair? markup?)
1981 @cindex setting extent of text objects
1983 Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}."
1984 (let* ((expr (ly:stencil-expr (interpret-markup layout props arg))))
1986 (make-transparent-box-stencil x y)
1988 `(delay-stencil-evaluation ,(delay expr))
1991 (define-markup-command (pad-around layout props amount arg)
1994 "Add padding @var{amount} all around @var{arg}.
1996 @lilypond[verbatim,quote]
2009 (let* ((m (interpret-markup layout props arg))
2010 (x (interval-widen (ly:stencil-extent m X) amount))
2011 (y (interval-widen (ly:stencil-extent m Y) amount)))
2012 (ly:stencil-add (make-transparent-box-stencil x y)
2015 (define-markup-command (pad-x layout props amount arg)
2019 @cindex padding text horizontally
2021 Add padding @var{amount} around @var{arg} in the X@tie{}direction.
2023 @lilypond[verbatim,quote]
2036 (let* ((m (interpret-markup layout props arg))
2037 (x (ly:stencil-extent m X))
2038 (y (ly:stencil-extent m Y)))
2039 (ly:make-stencil (ly:stencil-expr m)
2040 (interval-widen x amount)
2043 (define-markup-command (put-adjacent layout props axis dir arg1 arg2)
2044 (integer? ly:dir? markup? markup?)
2046 "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}."
2047 (let ((m1 (interpret-markup layout props arg1))
2048 (m2 (interpret-markup layout props arg2)))
2049 (ly:stencil-combine-at-edge m1 axis dir m2 0.0)))
2051 (define-markup-command (transparent layout props arg)
2054 "Make @var{arg} transparent.
2056 @lilypond[verbatim,quote]
2063 (let* ((m (interpret-markup layout props arg))
2064 (x (ly:stencil-extent m X))
2065 (y (ly:stencil-extent m Y)))
2066 (ly:make-stencil (list 'transparent-stencil (ly:stencil-expr m)) x y)))
2068 (define-markup-command (pad-to-box layout props x-ext y-ext arg)
2069 (number-pair? number-pair? markup?)
2071 "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space.
2073 @lilypond[verbatim,quote]
2080 \\pad-to-box #'(0 . 10) #'(0 . 3) {
2086 (ly:stencil-add (make-transparent-box-stencil x-ext y-ext)
2087 (interpret-markup layout props arg)))
2089 (define-markup-command (hcenter-in layout props length arg)
2092 "Center @var{arg} horizontally within a box of extending
2093 @var{length}/2 to the left and right.
2095 @lilypond[quote,verbatim]
2098 \\set Staff.instrumentName = \\markup {
2105 \\set Staff.instrumentName = \\markup {
2114 (interpret-markup layout props
2115 (make-pad-to-box-markup
2116 (cons (/ length -2) (/ length 2))
2118 (make-center-align-markup arg))))
2120 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2122 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2124 (define-markup-command (property-recursive layout props symbol)
2127 "Print out a warning when a header field markup contains some recursive
2129 (ly:warning "Recursive definition of property ~a detected!" symbol)
2132 (define-markup-command (fromproperty layout props symbol)
2135 "Read the @var{symbol} from property settings, and produce a stencil
2136 from the markup contained within. If @var{symbol} is not defined, it
2137 returns an empty markup.
2139 @lilypond[verbatim,quote]
2141 myTitle = \"myTitle\"
2145 \\fromproperty #'header:myTitle
2152 (let ((m (chain-assoc-get symbol props)))
2154 ;; prevent infinite loops by clearing the interpreted property:
2155 (interpret-markup layout (cons (list (cons symbol `(,property-recursive-markup ,symbol))) props) m)
2158 (define-markup-command (on-the-fly layout props procedure arg)
2159 (procedure? markup?)
2161 "Apply the @var{procedure} markup command to @var{arg}.
2162 @var{procedure} should take a single argument."
2163 (let ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg))))
2164 (set-object-property! anonymous-with-signature
2167 (interpret-markup layout props (list anonymous-with-signature arg))))
2169 (define-markup-command (footnote layout props mkup note)
2172 "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
2174 @lilypond[verbatim,quote]
2177 \\override #'(padding . 0.2)
2181 The footnote will not be annotated automatically."
2182 (ly:stencil-combine-at-edge
2183 (interpret-markup layout props mkup)
2187 `(footnote (gensym "footnote") #f ,(interpret-markup layout props note))
2192 (define-markup-command (auto-footnote layout props mkup note)
2195 #:properties ((raise 0.5)
2197 "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
2199 @lilypond[verbatim,quote]
2202 \\override #'(padding . 0.2)
2206 The footnote will be annotated automatically."
2207 (let* ((markup-stencil (interpret-markup layout props mkup))
2208 (footnote-hash (gensym "footnote"))
2210 (gauge-stencil (interpret-markup
2213 ((ly:output-def-lookup
2215 'footnote-numbering-function)
2217 (x-ext (ly:stencil-extent gauge-stencil X))
2218 (y-ext (ly:stencil-extent gauge-stencil Y))
2220 `(delay-stencil-evaluation
2224 (ly:output-def-lookup layout
2225 'number-footnote-table))
2226 (footnote-stencil (if (list? table)
2227 (assoc-get footnote-hash
2230 (footnote-stencil (if (ly:stencil? footnote-stencil)
2233 (ly:programming-error
2234 "Cannot find correct footnote for a markup object.")
2236 (gap (- (interval-length x-ext)
2238 (ly:stencil-extent footnote-stencil X))))
2239 (y-trans (- (+ (cdr y-ext)
2241 (cdr (ly:stencil-extent footnote-stencil
2243 (ly:stencil-translate footnote-stencil
2244 (cons gap y-trans)))))))
2245 (main-stencil (ly:stencil-combine-at-edge
2249 (ly:make-stencil footnote-number x-ext y-ext)
2254 `(footnote ,footnote-hash #t ,(interpret-markup layout props note))
2258 (define-markup-command (override layout props new-prop arg)
2262 @cindex overriding properties within text markup
2264 Add the argument @var{new-prop} to the property list. Properties
2265 may be any property supported by @rinternals{font-interface},
2266 @rinternals{text-interface} and
2267 @rinternals{instrument-specific-markup-interface}.
2269 @lilypond[verbatim,quote]
2277 \\override #'(baseline-skip . 4) {
2286 (interpret-markup layout (cons (list new-prop) props) arg))
2288 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2290 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2292 (define-markup-command (verbatim-file layout props name)
2295 "Read the contents of file @var{name}, and include it verbatim.
2297 @lilypond[verbatim,quote]
2299 \\verbatim-file #\"simple.ly\"
2302 (interpret-markup layout props
2303 (if (ly:get-option 'safe)
2304 "verbatim-file disabled in safe mode"
2305 (let* ((str (ly:gulp-file name))
2306 (lines (string-split str #\nl)))
2307 (make-typewriter-markup
2308 (make-column-markup lines))))))
2310 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2312 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2315 (define-markup-command (smaller layout props arg)
2318 "Decrease the font size relative to the current setting.
2320 @lilypond[verbatim,quote]
2333 (interpret-markup layout props
2334 `(,fontsize-markup -1 ,arg)))
2336 (define-markup-command (larger layout props arg)
2339 "Increase the font size relative to the current setting.
2341 @lilypond[verbatim,quote]
2349 (interpret-markup layout props
2350 `(,fontsize-markup 1 ,arg)))
2352 (define-markup-command (finger layout props arg)
2355 "Set @var{arg} as small numbers.
2357 @lilypond[verbatim,quote]
2364 (interpret-markup layout
2365 (cons '((font-size . -5) (font-encoding . fetaText)) props)
2368 (define-markup-command (abs-fontsize layout props size arg)
2371 "Use @var{size} as the absolute font size to display @var{arg}.
2372 Adjusts @code{baseline-skip} and @code{word-space} accordingly.
2374 @lilypond[verbatim,quote]
2376 default text font size
2378 \\abs-fontsize #16 { text font size 16 }
2380 \\abs-fontsize #12 { text font size 12 }
2383 (let* ((ref-size (ly:output-def-lookup layout 'text-font-size 12))
2384 (text-props (list (ly:output-def-lookup layout 'text-font-defaults)))
2385 (ref-word-space (chain-assoc-get 'word-space text-props 0.6))
2386 (ref-baseline (chain-assoc-get 'baseline-skip text-props 3))
2387 (magnification (/ size ref-size)))
2391 `((baseline-skip . ,(* magnification ref-baseline))
2392 (word-space . ,(* magnification ref-word-space))
2393 (font-size . ,(magnification->font-size magnification)))
2397 (define-markup-command (fontsize layout props increment arg)
2400 #:properties ((font-size 0)
2403 "Add @var{increment} to the font-size. Adjusts @code{baseline-skip}
2406 @lilypond[verbatim,quote]
2417 `((baseline-skip . ,(* baseline-skip (magstep increment)))
2418 (word-space . ,(* word-space (magstep increment)))
2419 (font-size . ,(+ font-size increment)))
2423 (define-markup-command (magnify layout props sz arg)
2427 @cindex magnifying text
2429 Set the font magnification for its argument. In the following
2430 example, the middle@tie{}A is 10% larger:
2433 A \\magnify #1.1 @{ A @} A
2436 Note: Magnification only works if a font name is explicitly selected.
2437 Use @code{\\fontsize} otherwise.
2439 @lilypond[verbatim,quote]
2450 (prepend-alist-chain 'font-size (magnification->font-size sz) props)
2453 (define-markup-command (bold layout props arg)
2456 "Switch to bold font-series.
2458 @lilypond[verbatim,quote]
2466 (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
2468 (define-markup-command (sans layout props arg)
2471 "Switch to the sans serif font family.
2473 @lilypond[verbatim,quote]
2482 (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
2484 (define-markup-command (number layout props arg)
2487 "Set font family to @code{number}, which yields the font used for
2488 time signatures and fingerings. This font contains numbers and
2489 some punctuation; it has no letters.
2491 @lilypond[verbatim,quote]
2494 0 1 2 3 4 5 6 7 8 9 . ,
2498 (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2500 (define-markup-command (roman layout props arg)
2503 "Set font family to @code{roman}.
2505 @lilypond[verbatim,quote]
2511 text in roman font family
2518 (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
2520 (define-markup-command (huge layout props arg)
2523 "Set font size to +2.
2525 @lilypond[verbatim,quote]
2533 (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
2535 (define-markup-command (large layout props arg)
2538 "Set font size to +1.
2540 @lilypond[verbatim,quote]
2548 (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
2550 (define-markup-command (normalsize layout props arg)
2553 "Set font size to default.
2555 @lilypond[verbatim,quote]
2568 (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
2570 (define-markup-command (small layout props arg)
2573 "Set font size to -1.
2575 @lilypond[verbatim,quote]
2583 (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
2585 (define-markup-command (tiny layout props arg)
2588 "Set font size to -2.
2590 @lilypond[verbatim,quote]
2598 (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
2600 (define-markup-command (teeny layout props arg)
2603 "Set font size to -3.
2605 @lilypond[verbatim,quote]
2613 (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
2615 (define-markup-command (fontCaps layout props arg)
2618 "Set @code{font-shape} to @code{caps}
2620 Note: @code{\\fontCaps} requires the installation and selection of
2621 fonts which support the @code{caps} font shape."
2622 (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
2625 (define-markup-command (smallCaps layout props arg)
2628 "Emit @var{arg} as small caps.
2630 Note: @code{\\smallCaps} does not support accented characters.
2632 @lilypond[verbatim,quote]
2641 (define (char-list->markup chars lower)
2642 (let ((final-string (string-upcase (reverse-list->string chars))))
2644 (markup #:fontsize -2 final-string)
2646 (define (make-small-caps rest-chars currents current-is-lower prev-result)
2647 (if (null? rest-chars)
2649 (reverse! (cons (char-list->markup currents current-is-lower)
2651 (let* ((ch (car rest-chars))
2652 (is-lower (char-lower-case? ch)))
2653 (if (or (and current-is-lower is-lower)
2654 (and (not current-is-lower) (not is-lower)))
2655 (make-small-caps (cdr rest-chars)
2659 (make-small-caps (cdr rest-chars)
2662 (if (null? currents)
2664 (cons (char-list->markup
2665 currents current-is-lower)
2667 (interpret-markup layout props
2669 (make-small-caps (string->list arg) (list) #f (list))
2672 (define-markup-command (caps layout props arg)
2675 "Copy of the @code{\\smallCaps} command.
2677 @lilypond[verbatim,quote]
2686 (interpret-markup layout props (make-smallCaps-markup arg)))
2688 (define-markup-command (dynamic layout props arg)
2691 "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m},
2692 @b{z}, @b{p}, and @b{r}. When producing phrases, like
2693 @q{pi@`{u}@tie{}@b{f}}, the normal words (like @q{pi@`{u}}) should be
2694 done in a different font. The recommended font for this is bold and italic.
2695 @lilypond[verbatim,quote]
2703 layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2705 (define-markup-command (text layout props arg)
2708 "Use a text font instead of music symbol or music alphabet font.
2710 @lilypond[verbatim,quote]
2723 (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
2726 (define-markup-command (italic layout props arg)
2729 "Use italic @code{font-shape} for @var{arg}.
2731 @lilypond[verbatim,quote]
2739 (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
2741 (define-markup-command (typewriter layout props arg)
2744 "Use @code{font-family} typewriter for @var{arg}.
2746 @lilypond[verbatim,quote]
2755 layout (prepend-alist-chain 'font-family 'typewriter props) arg))
2757 (define-markup-command (upright layout props arg)
2760 "Set @code{font-shape} to @code{upright}. This is the opposite
2763 @lilypond[verbatim,quote]
2777 layout (prepend-alist-chain 'font-shape 'upright props) arg))
2779 (define-markup-command (medium layout props arg)
2782 "Switch to medium font-series (in contrast to bold).
2784 @lilypond[verbatim,quote]
2797 (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
2800 (define-markup-command (normal-text layout props arg)
2803 "Set all font related properties (except the size) to get the default
2804 normal text font, no matter what font was used earlier.
2806 @lilypond[verbatim,quote]
2808 \\huge \\bold \\sans \\caps {
2820 (interpret-markup layout
2821 (cons '((font-family . roman) (font-shape . upright)
2822 (font-series . medium) (font-encoding . latin1))
2826 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2828 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2830 (define-markup-command (musicglyph layout props glyph-name)
2833 "@var{glyph-name} is converted to a musical symbol; for example,
2834 @code{\\musicglyph #\"accidentals.natural\"} selects the natural sign from
2835 the music font. See @ruser{The Feta font} for a complete listing of
2836 the possible glyphs.
2838 @lilypond[verbatim,quote]
2841 \\musicglyph #\"rests.2\"
2842 \\musicglyph #\"clefs.G_change\"
2845 (let* ((font (ly:paper-get-font layout
2846 (cons '((font-encoding . fetaMusic)
2850 (glyph (ly:font-get-glyph font glyph-name)))
2851 (if (null? (ly:stencil-expr glyph))
2852 (ly:warning (_ "Cannot find glyph ~a") glyph-name))
2856 (define-markup-command (doublesharp layout props)
2859 "Draw a double sharp symbol.
2861 @lilypond[verbatim,quote]
2866 (interpret-markup layout props (markup #:musicglyph (assoc-get 1 standard-alteration-glyph-name-alist ""))))
2868 (define-markup-command (sesquisharp layout props)
2871 "Draw a 3/2 sharp symbol.
2873 @lilypond[verbatim,quote]
2878 (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist ""))))
2880 (define-markup-command (sharp layout props)
2883 "Draw a sharp symbol.
2885 @lilypond[verbatim,quote]
2890 (interpret-markup layout props (markup #:musicglyph (assoc-get 1/2 standard-alteration-glyph-name-alist ""))))
2892 (define-markup-command (semisharp layout props)
2895 "Draw a semisharp symbol.
2897 @lilypond[verbatim,quote]
2902 (interpret-markup layout props (markup #:musicglyph (assoc-get 1/4 standard-alteration-glyph-name-alist ""))))
2904 (define-markup-command (natural layout props)
2907 "Draw a natural symbol.
2909 @lilypond[verbatim,quote]
2914 (interpret-markup layout props (markup #:musicglyph (assoc-get 0 standard-alteration-glyph-name-alist ""))))
2916 (define-markup-command (semiflat layout props)
2919 "Draw a semiflat symbol.
2921 @lilypond[verbatim,quote]
2926 (interpret-markup layout props (markup #:musicglyph (assoc-get -1/4 standard-alteration-glyph-name-alist ""))))
2928 (define-markup-command (flat layout props)
2931 "Draw a flat symbol.
2933 @lilypond[verbatim,quote]
2938 (interpret-markup layout props (markup #:musicglyph (assoc-get -1/2 standard-alteration-glyph-name-alist ""))))
2940 (define-markup-command (sesquiflat layout props)
2943 "Draw a 3/2 flat symbol.
2945 @lilypond[verbatim,quote]
2950 (interpret-markup layout props (markup #:musicglyph (assoc-get -3/4 standard-alteration-glyph-name-alist ""))))
2952 (define-markup-command (doubleflat layout props)
2955 "Draw a double flat symbol.
2957 @lilypond[verbatim,quote]
2962 (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist ""))))
2964 (define-markup-command (with-color layout props color arg)
2968 @cindex coloring text
2970 Draw @var{arg} in color specified by @var{color}.
2972 @lilypond[verbatim,quote]
2984 (let ((stil (interpret-markup layout props arg)))
2985 (ly:make-stencil (list 'color color (ly:stencil-expr stil))
2986 (ly:stencil-extent stil X)
2987 (ly:stencil-extent stil Y))))
2989 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2991 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2993 (define-markup-command (arrow-head layout props axis dir filled)
2994 (integer? ly:dir? boolean?)
2996 "Produce an arrow head in specified direction and axis.
2997 Use the filled head if @var{filled} is specified.
2998 @lilypond[verbatim,quote]
3001 \\general-align #Y #DOWN {
3002 \\arrow-head #Y #UP ##t
3003 \\arrow-head #Y #DOWN ##f
3005 \\arrow-head #X #RIGHT ##f
3006 \\arrow-head #X #LEFT ##f
3012 ((name (format #f "arrowheads.~a.~a~a"
3019 (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
3023 (define-markup-command (lookup layout props glyph-name)
3026 "Lookup a glyph by name.
3028 @lilypond[verbatim,quote]
3030 \\override #'(font-encoding . fetaBraces) {
3031 \\lookup #\"brace200\"
3034 \\lookup #\"brace180\"
3038 (ly:font-get-glyph (ly:paper-get-font layout props)
3041 (define-markup-command (char layout props num)
3044 "Produce a single character. Characters encoded in hexadecimal
3045 format require the prefix @code{#x}.
3047 @lilypond[verbatim,quote]
3049 \\char #65 \\char ##x00a9
3052 (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num)))
3054 (define number->mark-letter-vector (make-vector 25 #\A))
3059 (if (= i (- (char->integer #\I) (char->integer #\A)))
3061 (vector-set! number->mark-letter-vector j
3062 (integer->char (+ i (char->integer #\A)))))
3064 (define number->mark-alphabet-vector (list->vector
3065 (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
3067 (define (number->markletter-string vec n)
3068 "Double letters for big marks."
3069 (let* ((lst (vector-length vec)))
3072 (string-append (number->markletter-string vec (1- (quotient n lst)))
3073 (number->markletter-string vec (remainder n lst)))
3074 (make-string 1 (vector-ref vec n)))))
3076 (define-markup-command (markletter layout props num)
3079 "Make a markup letter for @var{num}. The letters start with A
3080 to@tie{}Z (skipping letter@tie{}I), and continue with double letters.
3082 @lilypond[verbatim,quote]
3089 (ly:text-interface::interpret-markup layout props
3090 (number->markletter-string number->mark-letter-vector num)))
3092 (define-markup-command (markalphabet layout props num)
3095 "Make a markup letter for @var{num}. The letters start with A to@tie{}Z
3096 and continue with double letters.
3098 @lilypond[verbatim,quote]
3105 (ly:text-interface::interpret-markup layout props
3106 (number->markletter-string number->mark-alphabet-vector num)))
3108 (define-public (horizontal-slash-interval num forward number-interval mag)
3110 (cond ;; ((= num 6) (interval-widen number-interval (* mag 0.5)))
3111 ;; ((= num 5) (interval-widen number-interval (* mag 0.5)))
3112 (else (interval-widen number-interval (* mag 0.25))))
3113 (cond ((= num 6) (interval-widen number-interval (* mag 0.5)))
3114 ;; ((= num 5) (interval-widen number-interval (* mag 0.5)))
3115 (else (interval-widen number-interval (* mag 0.25))))
3118 (define-public (adjust-slash-stencil num forward stencil mag)
3121 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
3123 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
3125 ;; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.07))))
3127 ;; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
3130 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.15))))
3132 ;; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
3137 (define (slashed-digit-internal layout props num forward font-size thickness)
3138 (let* ((mag (magstep font-size))
3140 (ly:output-def-lookup layout 'line-thickness)
3142 ;; backward slashes might use slope and point in the other direction!
3143 (dy (* mag (if forward 0.4 -0.4)))
3144 (number-stencil (interpret-markup layout
3145 (prepend-alist-chain 'font-encoding 'fetaText props)
3146 (number->string num)))
3147 (num-x (horizontal-slash-interval num forward (ly:stencil-extent number-stencil X) mag))
3148 (center (interval-center (ly:stencil-extent number-stencil Y)))
3149 ;; Use the real extents of the slash, not the whole number,
3150 ;; because we might translate the slash later on!
3151 (num-y (interval-widen (cons center center) (abs dy)))
3152 (is-sane (and (interval-sane? num-x) (interval-sane? num-y)))
3153 (slash-stencil (if is-sane
3154 (make-line-stencil thickness
3155 (car num-x) (- (interval-center num-y) dy)
3156 (cdr num-x) (+ (interval-center num-y) dy))
3158 (if (ly:stencil? slash-stencil)
3160 ;; for some numbers we need to shift the slash/backslash up or
3161 ;; down to make the slashed digit look better
3162 (set! slash-stencil (adjust-slash-stencil num forward slash-stencil mag))
3163 (set! number-stencil
3164 (ly:stencil-add number-stencil slash-stencil)))
3165 (ly:warning "Unable to create slashed digit ~a" num))
3169 (define-markup-command (slashed-digit layout props num)
3172 #:properties ((font-size 0)
3175 @cindex slashed digits
3177 A feta number, with slash. This is for use in the context of
3178 figured bass notation.
3179 @lilypond[verbatim,quote]
3183 \\override #'(thickness . 3)
3187 (slashed-digit-internal layout props num #t font-size thickness))
3189 (define-markup-command (backslashed-digit layout props num)
3192 #:properties ((font-size 0)
3195 @cindex backslashed digits
3197 A feta number, with backslash. This is for use in the context of
3198 figured bass notation.
3199 @lilypond[verbatim,quote]
3201 \\backslashed-digit #5
3203 \\override #'(thickness . 3)
3204 \\backslashed-digit #7
3207 (slashed-digit-internal layout props num #f font-size thickness))
3210 (define eyeglassespath
3211 '((moveto 0.42 0.77)
3212 (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
3213 (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
3214 (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
3215 (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
3218 (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
3219 (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
3220 (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
3221 (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
3223 (moveto 1.025 0.935)
3224 (rcurveto 0 0.182 -0.148 0.33 -0.33 0.33)
3225 (rcurveto -0.182 0 -0.33 -0.148 -0.33 -0.33)
3228 (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)
3231 (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)))
3233 (define-markup-command (eyeglasses layout props)
3236 "Prints out eyeglasses, indicating strongly to look at the conductor.
3237 @lilypond[verbatim,quote]
3238 \\markup { \\eyeglasses }
3240 (interpret-markup layout props
3241 (make-override-markup '(line-cap-style . butt)
3242 (make-path-markup 0.15 eyeglassespath))))
3244 (define-markup-command (left-brace layout props size)
3248 A feta brace in point size @var{size}.
3250 @lilypond[verbatim,quote]
3257 (let* ((font (ly:paper-get-font layout
3258 (cons '((font-encoding . fetaBraces)
3261 (glyph-count (1- (ly:otf-glyph-count font)))
3262 (scale (ly:output-def-lookup layout 'output-scale))
3263 (scaled-size (/ (ly:pt size) scale))
3265 (ly:font-get-glyph font (string-append "brace"
3266 (number->string n)))))
3267 (get-y-from-brace (lambda (brace)
3269 (ly:stencil-extent (glyph brace) Y))))
3270 (find-brace (binary-search 0 glyph-count get-y-from-brace scaled-size))
3271 (glyph-found (glyph find-brace)))
3273 (if (or (null? (ly:stencil-expr glyph-found))
3274 (< scaled-size (interval-length (ly:stencil-extent (glyph 0) Y)))
3275 (> scaled-size (interval-length
3276 (ly:stencil-extent (glyph glyph-count) Y))))
3278 (ly:warning (_ "no brace found for point size ~S ") size)
3279 (ly:warning (_ "defaulting to ~S pt")
3280 (/ (* scale (interval-length
3281 (ly:stencil-extent glyph-found Y)))
3285 (define-markup-command (right-brace layout props size)
3289 A feta brace in point size @var{size}, rotated 180 degrees.
3291 @lilypond[verbatim,quote]
3298 (interpret-markup layout props (markup #:rotate 180 #:left-brace size)))
3300 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3301 ;; the note command.
3302 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3304 ;; TODO: better syntax.
3306 (define-markup-command (note-by-number layout props log dot-count dir)
3307 (number? number? number?)
3309 #:properties ((font-size 0)
3313 @cindex notes within text by log and dot-count
3315 Construct a note symbol, with stem and flag. By using fractional values for
3316 @var{dir}, longer or shorter stems can be obtained.
3317 Supports all note-head-styles.
3318 Supported flag-styles are @code{default}, @code{old-straight-flag},
3319 @code{modern-straight-flag} and @code{flat-flag}.
3321 @lilypond[verbatim,quote]
3323 \\note-by-number #3 #0 #DOWN
3325 \\note-by-number #1 #2 #0.8
3328 (define (get-glyph-name-candidates dir log style)
3329 (map (lambda (dir-name)
3330 (format #f "noteheads.~a~a" dir-name
3331 (if (and (symbol? style)
3332 (not (equal? 'default style)))
3333 (select-head-glyph style (min log 2))
3335 (list (if (= dir UP) "u" "d")
3338 (define (get-glyph-name font cands)
3341 (if (ly:stencil-empty? (ly:font-get-glyph font (car cands)))
3342 (get-glyph-name font (cdr cands))
3345 (define (buildflags flag-stencil remain curr-stencil spacing)
3346 ;; Function to recursively create a stencil with @code{remain} flags
3347 ;; from the single-flag stencil @code{curr-stencil}, which is already
3348 ;; translated to the position of the previous flag position.
3350 ;; Copy and paste from /scm/flag-styles.scm
3352 (let* ((translated-stencil
3353 (ly:stencil-translate-axis curr-stencil spacing Y))
3354 (new-stencil (ly:stencil-add flag-stencil translated-stencil)))
3355 (buildflags new-stencil (- remain 1) translated-stencil spacing))
3358 (define (straight-flag-mrkp flag-thickness flag-spacing
3359 upflag-angle upflag-length
3360 downflag-angle downflag-length
3362 ;; Create a stencil for a straight flag. @var{flag-thickness} and
3363 ;; @var{flag-spacing} are given in staff spaces, @var{upflag-angle} and
3364 ;; @var{downflag-angle} are given in degrees, and @var{upflag-length} and
3365 ;; @var{downflag-length} are given in staff spaces.
3367 ;; All lengths are scaled according to the font size of the note.
3369 ;; From /scm/flag-styles.scm, modified to fit here.
3371 (let* ((stem-up (> dir 0))
3372 ;; scale with the note size
3373 (factor (magstep font-size))
3374 (stem-thickness (* factor 0.1))
3375 (line-thickness (ly:output-def-lookup layout 'line-thickness))
3376 (half-stem-thickness (/ (* stem-thickness line-thickness) 2))
3377 (raw-length (if stem-up upflag-length downflag-length))
3378 (angle (if stem-up upflag-angle downflag-angle))
3379 (flag-length (+ (* raw-length factor) half-stem-thickness))
3380 (flag-end (if (= angle 0)
3381 (cons flag-length (* half-stem-thickness dir))
3382 (polar->rectangular flag-length angle)))
3383 (thickness (* flag-thickness factor))
3384 (thickness-offset (cons 0 (* -1 thickness dir)))
3385 (spacing (* -1 flag-spacing factor dir))
3386 (start (cons (- half-stem-thickness) (* half-stem-thickness dir)))
3387 ;; The points of a round-filled-polygon need to be given in
3388 ;; clockwise order, otherwise the polygon will be enlarged by
3393 (offset-add flag-end thickness-offset)
3394 (offset-add start thickness-offset))
3396 (offset-add start thickness-offset)
3397 (offset-add flag-end thickness-offset)
3399 (stencil (ly:round-filled-polygon points half-stem-thickness))
3400 ;; Log for 1/8 is 3, so we need to subtract 3
3401 (flag-stencil (buildflags stencil (- log 3) stencil spacing)))
3404 (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
3406 (size-factor (magstep font-size))
3407 (blot (ly:output-def-lookup layout 'blot-diameter))
3409 (let ((result (get-glyph-name font
3410 (get-glyph-name-candidates
3411 (sign dir) log style))))
3412 (if (string-null? result)
3413 ;; If no glyph name can be found, select default heads.
3414 ;; Though this usually means an unsupported style has been
3415 ;; chosen, it also prevents unrelated 'style settings from
3416 ;; other grobs (e.g., TextSpanner and TimeSignature) leaking
3418 (get-glyph-name font
3419 (get-glyph-name-candidates
3420 (sign dir) log 'default))
3422 (head-glyph (ly:font-get-glyph font head-glyph-name))
3423 (ancient-flags? (or (eq? style 'mensural) (eq? style 'neomensural)))
3424 (attach-indices (ly:note-head::stem-attachment font head-glyph-name))
3425 (stem-length (* size-factor (max 3 (- log 1))))
3426 ;; With ancient-flags we want a tighter stem
3427 (stem-thickness (* size-factor (if ancient-flags? 0.1 0.13)))
3428 (stemy (* dir stem-length))
3429 (attach-off (cons (interval-index
3430 (ly:stencil-extent head-glyph X)
3431 (* (sign dir) (car attach-indices)))
3432 ;; fixme, this is inconsistent between X & Y.
3435 (ly:stencil-extent head-glyph Y)
3436 (cdr attach-indices)))))
3437 ;; For a tighter stem (with ancient-flags) the stem-width has to be
3439 (stem-X-corr (if ancient-flags? (* 0.5 dir stem-thickness) 0))
3440 (stem-glyph (and (> log 0)
3441 (ly:round-filled-box
3442 (ordered-cons (+ stem-X-corr (car attach-off))
3443 (+ stem-X-corr (car attach-off)
3444 (* (- (sign dir)) stem-thickness)))
3445 (cons (min stemy (cdr attach-off))
3446 (max stemy (cdr attach-off)))
3447 (/ stem-thickness 3))))
3448 (dot (ly:font-get-glyph font "dots.dot"))
3449 (dotwid (interval-length (ly:stencil-extent dot X)))
3450 (dots (and (> dot-count 0)
3451 (apply ly:stencil-add
3453 (ly:stencil-translate-axis
3454 dot (* 2 x dotwid) X))
3455 (iota dot-count)))))
3456 ;; Straight-flags. Values taken from /scm/flag-style.scm
3457 (modern-straight-flag (straight-flag-mrkp 0.55 1 -18 1.1 22 1.2 dir))
3458 (old-straight-flag (straight-flag-mrkp 0.55 1 -45 1.2 45 1.4 dir))
3459 (flat-flag (straight-flag-mrkp 0.55 1.0 0 1.0 0 1.0 dir))
3460 ;; Calculate a corrective to avoid a gap between
3461 ;; straight-flags and the stem.
3462 (flag-style-Y-corr (if (or (eq? flag-style 'modern-straight-flag)
3463 (eq? flag-style 'old-straight-flag)
3464 (eq? flag-style 'flat-flag))
3465 (/ blot 10 (* -1 dir))
3467 (flaggl (and (> log 2)
3468 (ly:stencil-translate
3469 (cond ((eq? flag-style 'modern-straight-flag)
3470 modern-straight-flag)
3471 ((eq? flag-style 'old-straight-flag)
3473 ((eq? flag-style 'flat-flag)
3476 (ly:font-get-glyph font
3477 (format #f (if ancient-flags?
3478 "flags.mensural~a2~a"
3480 (if (> dir 0) "u" "d")
3482 (cons (+ (car attach-off)
3483 ;; For tighter stems (with ancient-flags) the
3484 ;; flag has to be adjusted different.
3485 (if (and (not ancient-flags?) (< dir 0))
3488 (+ stemy flag-style-Y-corr))))))
3490 ;; If there is a flag on an upstem and the stem is short, move the dots
3491 ;; to avoid the flag. 16th notes get a special case because their flags
3492 ;; hang lower than any other flags.
3493 ;; Not with ancient flags or straight-flags.
3494 (if (and dots (> dir 0) (> log 2)
3495 (or (eq? flag-style 'default) (null? flag-style))
3496 (not ancient-flags?)
3497 (or (< dir 1.15) (and (= log 4) (< dir 1.3))))
3498 (set! dots (ly:stencil-translate-axis dots 0.5 X)))
3500 (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
3501 (if (ly:stencil? stem-glyph)
3502 (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
3503 (set! stem-glyph head-glyph))
3504 (if (ly:stencil? dots)
3507 (ly:stencil-translate-axis
3509 (+ (cdr (ly:stencil-extent head-glyph X)) dotwid)
3515 (let ((divisor (log 2)))
3516 (lambda (z) (inexact->exact (/ (log z) divisor)))))
3518 (define (parse-simple-duration duration-string)
3519 "Parse the `duration-string', e.g. ''4..'' or ''breve.'',
3520 and return a (log dots) list."
3521 (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)")
3523 (if (and match (string=? duration-string (match:substring match 0)))
3524 (let ((len (match:substring match 1))
3525 (dots (match:substring match 2)))
3526 (list (cond ((string=? len "breve") -1)
3527 ((string=? len "longa") -2)
3528 ((string=? len "maxima") -3)
3529 (else (log2 (string->number len))))
3530 (if dots (string-length dots) 0)))
3531 (ly:error (_ "not a valid duration string: ~a") duration-string))))
3533 (define-markup-command (note layout props duration dir)
3536 #:properties (note-by-number-markup)
3538 @cindex notes within text by string
3540 This produces a note with a stem pointing in @var{dir} direction, with
3541 the @var{duration} for the note head type and augmentation dots. For
3542 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
3543 a shortened down stem.
3545 @lilypond[verbatim,quote]
3547 \\override #'(style . cross) {
3551 \\note #\"breve\" #0
3554 (let ((parsed (parse-simple-duration duration)))
3555 (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
3557 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3558 ;; the rest command.
3559 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3561 (define-markup-command (rest-by-number layout props log dot-count)
3564 #:properties ((font-size 0)
3566 (multi-measure-rest #f))
3568 @cindex rests or multi-measure-rests within text by log and dot-count
3570 A rest or multi-measure-rest symbol.
3572 @lilypond[verbatim,quote]
3574 \\rest-by-number #3 #2
3576 \\rest-by-number #0 #1
3578 \\override #'(multi-measure-rest . #t)
3579 \\rest-by-number #0 #0
3583 (define (get-glyph-name-candidates log style)
3584 (let* (;; Choose the style-string to be added.
3585 ;; If no glyph exists, select others for the specified styles
3586 ;; otherwise defaulting.
3589 ;; 'baroque needs to be special-cased, otherwise
3590 ;; `select-head-glyph´ would catch neomensural-glyphs for
3591 ;; this style, if (< log 0).
3592 (eq? style 'baroque)
3593 (string-append (number->string log) ""))
3594 ((eq? style 'petrucci)
3595 (string-append (number->string log) "mensural"))
3596 ;; In other cases `select-head-glyph´ from output-lib.scm
3597 ;; works for rest-glyphs, too.
3598 ((and (symbol? style) (not (eq? style 'default)))
3599 (select-head-glyph style log))
3601 ;; Choose ledgered glyphs for whole and half rest.
3602 ;; Except for the specified styles, logs and MultiMeasureRests.
3604 (if (and (or (list? style)
3606 '(neomensural mensural petrucci))))
3607 (not multi-measure-rest)
3608 (or (= log 0) (= log 1)))
3611 (format #f "rests.~a~a" style-strg ledger-style-rests)))
3613 (define (get-glyph-name font cands)
3614 (if (ly:stencil-empty? (ly:font-get-glyph font cands))
3619 (ly:paper-get-font layout
3620 (cons '((font-encoding . fetaMusic)) props)))
3623 (get-glyph-name font
3624 (get-glyph-name-candidates log style))))
3625 (if (string-null? result)
3626 ;; If no glyph name can be found, select default rests. Though
3627 ;; this usually means an unsupported style has been chosen, it
3628 ;; also prevents unrelated 'style settings from other grobs
3629 ;; (e.g., TextSpanner and TimeSignature) leaking into markup.
3630 (get-glyph-name font (get-glyph-name-candidates log 'default))
3632 (rest-glyph (ly:font-get-glyph font rest-glyph-name))
3633 (dot (ly:font-get-glyph font "dots.dot"))
3634 (dot-width (interval-length (ly:stencil-extent dot X)))
3635 (dots (and (> dot-count 0)
3636 (apply ly:stencil-add
3638 (ly:stencil-translate-axis
3639 dot (* 2 x dot-width) X))
3640 (iota dot-count))))))
3642 ;; Apart from mensural-, neomensural- and petrucci-style ledgered
3643 ;; glyphs are taken for whole and half rests.
3644 ;; If they are dotted, move the dots in X-direction to avoid collision.
3648 (not (member style '(neomensural mensural petrucci))))
3649 (set! dots (ly:stencil-translate-axis dots dot-width X)))
3651 ;; Add dots to the rest-glyph.
3653 ;; Not sure how to vertical align dots.
3654 ;; For now the dots are centered for half, whole or longer rests.
3655 ;; Otherwise placed near the top of the rest.
3657 ;; Dots for rests with (< log 0) dots are allowed, but not
3658 ;; if multi-measure-rest is set #t.
3659 (if (and (not multi-measure-rest) dots)
3662 (ly:stencil-translate
3665 (+ (cdr (ly:stencil-extent rest-glyph X)) dot-width)
3667 (interval-center (ly:stencil-extent rest-glyph Y))
3668 (- (interval-end (ly:stencil-extent rest-glyph Y))
3669 (/ (* 2 dot-width) 3)))))
3673 (define-markup-command (rest layout props duration)
3676 #:properties ((style '())
3677 (multi-measure-rest #f)
3678 (multi-measure-rest-number #t)
3681 @cindex rests or multi-measure-rests within text by string
3683 This produces a rest, with the @var{duration} for the rest type and
3685 @code{\"breve\"}, @code{\"longa\"} and @code{\"maxima\"} are valid
3688 Printing MultiMeasureRests could be enabled with
3689 @code{\\override #'(multi-measure-rest . #t)}
3690 If MultiMeasureRests are taken, the MultiMeasureRestNumber is printed above.
3691 This is enabled for all styles using default-glyphs.
3692 Could be disabled with @code{\\override #'(multi-measure-rest-number . #f)}
3694 @lilypond[verbatim,quote]
3700 \\override #'(multi-measure-rest . #t)
3704 \\override #'(multi-measure-rest-number . #f)
3709 ;; Get the number of mmr-glyphs.
3710 ;; Store them in a list.
3711 ;; example: (mmr-numbers 25) -> '(3 0 0 1)
3712 (define (mmr-numbers nmbr)
3713 (let* ((8-bar-glyph (floor (/ nmbr 8)))
3714 (8-remainder (remainder nmbr 8))
3715 (4-bar-glyph (floor (/ 8-remainder 4)))
3716 (4-remainder (remainder nmbr 4))
3717 (2-bar-glyph (floor (/ 4-remainder 2)))
3718 (2-remainder (remainder 4-remainder 2))
3719 (1-bar-glyph (floor (/ 2-remainder 1))))
3720 (list 8-bar-glyph 4-bar-glyph 2-bar-glyph 1-bar-glyph)))
3722 ;; Get the correct mmr-glyphs.
3723 ;; Store them in a list.
3725 ;; (get-mmr-glyphs '(1 0 1 0) '("rests.M3" "rests.M2" "rests.M1" "rests.0"))
3726 ;; -> ("rests.M3" "rests.M1")
3727 (define (get-mmr-glyphs lst1 lst2)
3728 (define (helper l1 l2 l3)
3733 (append (make-list (car l1) (car l2)) l3))))
3734 (helper lst1 lst2 '()))
3736 ;; If duration is not valid, print a warning and return empty-stencil
3737 (if (or (and (not (integer? (car (parse-simple-duration duration))))
3738 (not multi-measure-rest))
3739 (and (= (string-length (car (string-split duration #\. ))) 1)
3740 (= (string->number (car (string-split duration #\. ))) 0)))
3742 (ly:warning (_ "not a valid duration string: ~a - ignoring") duration)
3745 ;; For simple rests:
3746 ;; Get a (log dots) list.
3747 (parsed (parse-simple-duration duration))
3748 ;; Create the rest-stencil
3750 (rest-by-number-markup layout props (car parsed) (cadr parsed)))
3751 ;; For MultiMeasureRests:
3752 ;; Get the duration-part of duration
3753 (dur-part-string (car (string-split duration #\. )))
3754 ;; Get the duration of MMR:
3755 ;; If not a number (eg. "maxima") calculate it.
3757 (or (string->number dur-part-string) (expt 2 (abs (car parsed)))))
3758 ;; Get a list of the correct number of each mmr-glyph.
3759 (count-mmr-glyphs-list (mmr-numbers mmr-duration))
3760 ;; Create a list of mmr-stencils,
3761 ;; translating the glyph for a whole rest.
3765 (let ((single-mmr-stil
3766 (rest-by-number-markup layout props (* -1 x) 0)))
3768 (ly:stencil-translate-axis
3770 ;; Ugh, hard-coded, why 1?
3774 (get-mmr-glyphs count-mmr-glyphs-list (reverse (iota 4)))))
3775 ;; Adjust the space between the mmr-glyphs,
3776 ;; if not default-glyphs are used.
3777 (word-space (if (member style
3778 '(neomensural mensural petrucci))
3779 (/ (* word-space 2) 3)
3781 ;; Create the final mmr-stencil
3782 ;; via `stack-stencil-line´ from /scm/markup.scm
3783 (mmr-stil (stack-stencil-line word-space mmr-stils-list)))
3785 ;; Print the number above a multi-measure-rest
3786 ;; Depends on duration, style and multi-measure-rest-number set #t
3787 (if (and multi-measure-rest
3788 multi-measure-rest-number
3790 (not (member style '(neomensural mensural petrucci))))
3791 (let* ((mmr-stil-x-center
3792 (interval-center (ly:stencil-extent mmr-stil X)))
3796 #:override '(font-encoding . fetaText)
3797 (number->string mmr-duration)))
3799 (interpret-markup layout props duration-markup))
3800 (mmr-number-stil-x-center
3801 (interval-center (ly:stencil-extent mmr-number-stil X))))
3803 (set! mmr-stil (ly:stencil-combine-at-edge
3806 (ly:stencil-translate-axis
3808 (- mmr-stil-x-center mmr-number-stil-x-center)
3812 (if multi-measure-rest
3816 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3818 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3820 (define-markup-command (fermata layout props) ()
3822 #:properties ((direction UP))
3823 "Create a fermata glyph. When @var{direction} is @code{DOWN}, use
3824 an inverted glyph. Note that within music, one would usually use the
3825 @code{\\fermata} articulation instead of a markup.
3827 @lilypond[verbatim,quote]
3828 { c1^\\markup \\fermata d1_\\markup \\fermata }
3830 \\markup { \\fermata \\override #`(direction . ,DOWN) \\fermata }
3833 (interpret-markup layout props
3834 (if (eqv? direction DOWN)
3835 (markup #:musicglyph "scripts.dfermata")
3836 (markup #:musicglyph "scripts.ufermata"))))
3838 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3840 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3842 (define-markup-command (lower layout props amount arg)
3846 @cindex lowering text
3848 Lower @var{arg} by the distance @var{amount}.
3849 A negative @var{amount} indicates raising; see also @code{\\raise}.
3851 @lilypond[verbatim,quote]
3859 (ly:stencil-translate-axis (interpret-markup layout props arg)
3862 (define-markup-command (translate-scaled layout props offset arg)
3863 (number-pair? markup?)
3865 #:properties ((font-size 0))
3867 @cindex translating text
3868 @cindex scaling text
3870 Translate @var{arg} by @var{offset}, scaling the offset by the
3873 @lilypond[verbatim,quote]
3876 * \\translate #'(2 . 3) translate
3878 * \\translate-scaled #'(2 . 3) translate-scaled
3882 (let* ((factor (magstep font-size))
3883 (scaled (cons (* factor (car offset))
3884 (* factor (cdr offset)))))
3885 (ly:stencil-translate (interpret-markup layout props arg)
3888 (define-markup-command (raise layout props amount arg)
3892 @cindex raising text
3894 Raise @var{arg} by the distance @var{amount}.
3895 A negative @var{amount} indicates lowering, see also @code{\\lower}.
3897 The argument to @code{\\raise} is the vertical displacement amount,
3898 measured in (global) staff spaces. @code{\\raise} and @code{\\super}
3899 raise objects in relation to their surrounding markups.
3901 If the text object itself is positioned above or below the staff, then
3902 @code{\\raise} cannot be used to move it, since the mechanism that
3903 positions it next to the staff cancels any shift made with
3904 @code{\\raise}. For vertical positioning, use the @code{padding}
3905 and/or @code{extra-offset} properties.
3907 @lilypond[verbatim,quote]
3916 (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
3918 (define-markup-command (fraction layout props arg1 arg2)
3921 #:properties ((font-size 0))
3923 @cindex creating text fractions
3925 Make a fraction of two markups.
3926 @lilypond[verbatim,quote]
3932 (let* ((m1 (interpret-markup layout props arg1))
3933 (m2 (interpret-markup layout props arg2))
3934 (factor (magstep font-size))
3935 (boxdimen (cons (* factor -0.05) (* factor 0.05)))
3936 (padding (* factor 0.2))
3937 (baseline (* factor 0.6))
3938 (offset (* factor 0.75)))
3939 (set! m1 (ly:stencil-aligned-to m1 X CENTER))
3940 (set! m2 (ly:stencil-aligned-to m2 X CENTER))
3941 (let* ((x1 (ly:stencil-extent m1 X))
3942 (x2 (ly:stencil-extent m2 X))
3943 (line (ly:round-filled-box (interval-union x1 x2) boxdimen 0.0))
3944 ;; should stack mols separately, to maintain LINE on baseline
3945 (stack (stack-lines DOWN padding baseline (list m1 line m2))))
3947 (ly:stencil-aligned-to stack Y CENTER))
3949 (ly:stencil-aligned-to stack X LEFT))
3950 ;; should have EX dimension
3952 (ly:stencil-translate-axis stack offset Y))))
3954 (define-markup-command (normal-size-super layout props arg)
3957 #:properties ((font-size 0))
3959 @cindex setting superscript in standard font size
3961 Set @var{arg} in superscript with a normal font size.
3963 @lilypond[verbatim,quote]
3966 \\normal-size-super {
3967 superscript in standard size
3971 (ly:stencil-translate-axis
3972 (interpret-markup layout props arg)
3973 (* 1.0 (magstep font-size)) Y))
3975 (define-markup-command (super layout props arg)
3978 #:properties ((font-size 0))
3980 @cindex superscript text
3982 Set @var{arg} in superscript.
3984 @lilypond[verbatim,quote]
3994 (ly:stencil-translate-axis
3997 (cons `((font-size . ,(- font-size 3))) props)
3999 (* 1.0 (magstep font-size)) ; original font-size
4002 (define-markup-command (translate layout props offset arg)
4003 (number-pair? markup?)
4006 @cindex translating text
4008 Translate @var{arg} relative to its surroundings. @var{offset}
4009 is a pair of numbers representing the displacement in the X and Y axis.
4011 @lilypond[verbatim,quote]
4014 \\translate #'(2 . 3)
4015 \\line { translated two spaces right, three up }
4018 (ly:stencil-translate (interpret-markup layout props arg)
4021 (define-markup-command (sub layout props arg)
4024 #:properties ((font-size 0))
4026 @cindex subscript text
4028 Set @var{arg} in subscript.
4030 @lilypond[verbatim,quote]
4041 (ly:stencil-translate-axis
4044 (cons `((font-size . ,(- font-size 3))) props)
4046 (* -0.75 (magstep font-size)) ; original font-size
4049 (define-markup-command (normal-size-sub layout props arg)
4052 #:properties ((font-size 0))
4054 @cindex setting subscript in standard font size
4056 Set @var{arg} in subscript with a normal font size.
4058 @lilypond[verbatim,quote]
4062 subscript in standard size
4066 (ly:stencil-translate-axis
4067 (interpret-markup layout props arg)
4068 (* -0.75 (magstep font-size))
4071 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4073 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4075 (define-markup-command (hbracket layout props arg)
4079 @cindex placing horizontal brackets around text
4081 Draw horizontal brackets around @var{arg}.
4083 @lilypond[verbatim,quote]
4092 (let ((th 0.1) ;; todo: take from GROB.
4093 (m (interpret-markup layout props arg)))
4094 (bracketify-stencil m X th (* 2.5 th) th)))
4096 (define-markup-command (bracket layout props arg)
4100 @cindex placing vertical brackets around text
4102 Draw vertical brackets around @var{arg}.
4104 @lilypond[verbatim,quote]
4111 (let ((th 0.1) ;; todo: take from GROB.
4112 (m (interpret-markup layout props arg)))
4113 (bracketify-stencil m Y th (* 2.5 th) th)))
4115 (define-markup-command (parenthesize layout props arg)
4118 #:properties ((angularity 0)
4124 @cindex placing parentheses around text
4126 Draw parentheses around @var{arg}. This is useful for parenthesizing
4127 a column containing several lines of text.
4129 @lilypond[verbatim,quote]
4138 \\override #'(angularity . 2) {
4149 (let* ((markup (interpret-markup layout props arg))
4150 (scaled-width (* size width))
4152 (* (chain-assoc-get 'line-thickness props 0.1)
4155 (min (* size 0.5 scaled-thickness)
4156 (* (/ 4 3.0) scaled-width)))
4157 (padding (chain-assoc-get 'padding props half-thickness)))
4158 (parenthesize-stencil
4159 markup half-thickness scaled-width angularity padding)))
4162 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4163 ;; Delayed markup evaluation
4164 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4166 (define-markup-command (page-ref layout props label gauge default)
4167 (symbol? markup? markup?)
4170 @cindex referencing page numbers in text
4172 Reference to a page number. @var{label} is the label set on the referenced
4173 page (using the @code{\\label} command), @var{gauge} a markup used to estimate
4174 the maximum width of the page number, and @var{default} the value to display
4175 when @var{label} is not found."
4176 (let* ((gauge-stencil (interpret-markup layout props gauge))
4177 (x-ext (ly:stencil-extent gauge-stencil X))
4178 (y-ext (ly:stencil-extent gauge-stencil Y)))
4180 (make-transparent-box-stencil x-ext y-ext))
4182 `(delay-stencil-evaluation
4183 ,(delay (ly:stencil-expr
4184 (let* ((table (ly:output-def-lookup layout 'label-page-table))
4185 (page-number (if (list? table)
4186 (assoc-get label table)
4188 (page-markup (if page-number (format #f "~a" page-number) default))
4189 (page-stencil (interpret-markup layout props page-markup))
4190 (gap (- (interval-length x-ext)
4191 (interval-length (ly:stencil-extent page-stencil X)))))
4192 (interpret-markup layout props
4193 (markup #:hspace gap page-markup))))))
4197 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4199 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4201 (define-markup-command (scale layout props factor-pair arg)
4202 (number-pair? markup?)
4205 @cindex scaling markup
4206 @cindex mirroring markup
4208 Scale @var{arg}. @var{factor-pair} is a pair of numbers
4209 representing the scaling-factor in the X and Y axes.
4210 Negative values may be used to produce mirror images.
4212 @lilypond[verbatim,quote]
4222 (let ((stil (interpret-markup layout props arg))
4223 (sx (car factor-pair))
4224 (sy (cdr factor-pair)))
4225 (ly:stencil-scale stil sx sy)))
4227 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4229 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4231 (define-markup-command (pattern layout props count axis space pattern)
4232 (integer? integer? number? markup?)
4235 Prints @var{count} times a @var{pattern} markup.
4236 Patterns are spaced apart by @var{space}.
4237 Patterns are distributed on @var{axis}.
4239 @lilypond[verbatim, quote]
4241 \"Horizontally repeated :\"
4242 \\pattern #7 #X #2 \\flat
4244 \"Vertically repeated :\"
4245 \\pattern #3 #Y #0.5 \\flat
4248 (let ((pattern-width (interval-length
4249 (ly:stencil-extent (interpret-markup layout props pattern) X)))
4250 (new-props (prepend-alist-chain 'word-space 0 (prepend-alist-chain 'baseline-skip 0 props))))
4251 (let loop ((i (1- count)) (patterns (markup)))
4257 (markup patterns pattern)
4258 (markup #:column (patterns pattern))))
4261 (markup patterns pattern #:hspace space)
4262 (markup #:column (patterns pattern #:vspace space))))))))
4264 (define-markup-command (fill-with-pattern layout props space dir pattern left right)
4265 (number? ly:dir? markup? markup? markup?)
4267 #:properties ((word-space)
4270 Put @var{left} and @var{right} in a horizontal line of width @code{line-width}
4271 with a line of markups @var{pattern} in between.
4272 Patterns are spaced apart by @var{space}.
4273 Patterns are aligned to the @var{dir} markup.
4275 @lilypond[verbatim, quote]
4278 \\fill-with-pattern #1 #RIGHT . first right
4279 \\fill-with-pattern #1 #RIGHT . second right
4281 \"center-aligned :\"
4282 \\fill-with-pattern #1.5 #CENTER - left right
4285 \\override #'(line-width . 50)
4286 \\fill-with-pattern #2 #LEFT : left first
4287 \\override #'(line-width . 50)
4288 \\fill-with-pattern #2 #LEFT : left second
4291 (let* ((pattern-x-extent (ly:stencil-extent (interpret-markup layout props pattern) X))
4292 (pattern-width (interval-length pattern-x-extent))
4293 (left-width (interval-length (ly:stencil-extent (interpret-markup layout props left) X)))
4294 (right-width (interval-length (ly:stencil-extent (interpret-markup layout props right) X)))
4295 (middle-width (max 0 (- line-width (+ (+ left-width right-width) (* word-space 2)))))
4296 (period (+ space pattern-width))
4297 (count (truncate (/ (- middle-width pattern-width) period)))
4298 (x-offset (+ (* (- (- middle-width (* count period)) pattern-width) (/ (1+ dir) 2)) (abs (car pattern-x-extent)))))
4299 (interpret-markup layout props
4301 #:with-dimensions (cons 0 middle-width) '(0 . 0)
4302 #:translate (cons x-offset 0)
4303 #:pattern (1+ count) X space pattern
4306 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4308 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4310 (define-markup-command (replace layout props replacements arg)
4314 Used to automatically replace a string by another in the markup @var{arg}.
4315 Each pair of the alist @var{replacements} specifies what should be replaced.
4316 The @code{key} is the string to be replaced by the @code{value} string.
4318 @lilypond[verbatim, quote]
4319 \\markup \\replace #'((\"thx\" . \"Thanks!\")) thx
4323 (internal-add-text-replacements
4328 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4329 ;; Markup list commands
4330 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4332 (define-public (space-lines baseline stils)
4333 (let space-stil ((stils stils)
4337 (let* ((stil (car stils))
4338 (dy-top (max (- (/ baseline 1.5)
4339 (interval-bound (ly:stencil-extent stil Y) UP))
4341 (dy-bottom (max (+ (/ baseline 3.0)
4342 (interval-bound (ly:stencil-extent stil Y) DOWN))
4344 (new-stil (ly:make-stencil
4345 (ly:stencil-expr stil)
4346 (ly:stencil-extent stil X)
4347 (cons (- (interval-bound (ly:stencil-extent stil Y) DOWN)
4349 (+ (interval-bound (ly:stencil-extent stil Y) UP)
4351 (space-stil (cdr stils) (cons new-stil result))))))
4353 (define-markup-list-command (justified-lines layout props args)
4355 #:properties ((baseline-skip)
4356 wordwrap-internal-markup-list)
4358 @cindex justifying lines of text
4360 Like @code{\\justify}, but return a list of lines instead of a single markup.
4361 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width;
4362 @var{X}@tie{}is the number of staff spaces."
4363 (space-lines baseline-skip
4364 (interpret-markup-list layout props
4365 (make-wordwrap-internal-markup-list #t args))))
4367 (define-markup-list-command (wordwrap-lines layout props args)
4369 #:properties ((baseline-skip)
4370 wordwrap-internal-markup-list)
4371 "Like @code{\\wordwrap}, but return a list of lines instead of a single markup.
4372 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width,
4373 where @var{X} is the number of staff spaces."
4374 (space-lines baseline-skip
4375 (interpret-markup-list layout props
4376 (make-wordwrap-internal-markup-list #f args))))
4378 (define-markup-list-command (column-lines layout props args)
4380 #:properties ((baseline-skip))
4381 "Like @code{\\column}, but return a list of lines instead of a single markup.
4382 @code{baseline-skip} determines the space between each markup in @var{args}."
4383 (space-lines baseline-skip
4384 (interpret-markup-list layout props args)))
4386 (define-markup-list-command (override-lines layout props new-prop args)
4387 (pair? markup-list?)
4388 "Like @code{\\override}, for markup lists."
4389 (interpret-markup-list layout (cons (list new-prop) props) args))
4391 (define-markup-list-command (map-markup-commands layout props compose args)
4392 (procedure? markup-list?)
4393 "This applies the function @var{compose} to every markup in
4394 @var{args} (including elements of markup list command calls) in order
4395 to produce a new markup list. Since the return value from a markup
4396 list command call is not a markup list but rather a list of stencils,
4397 this requires passing those stencils off as the results of individual
4398 markup calls. That way, the results should work out as long as no
4399 markups rely on side effects."
4400 (let ((key (make-symbol "key")))
4404 ;; if `compose' does not actually interpret its markup
4405 ;; argument, we still need to return a list of stencils,
4406 ;; created from the single returned stencil
4408 (interpret-markup layout props
4410 (make-on-the-fly-markup
4411 (lambda (layout props m)
4412 ;; here all effects of `compose' on the
4413 ;; properties should be visible, so we
4414 ;; call interpret-markup-list at this
4415 ;; point of time and harvest its
4418 (interpret-markup-list
4419 layout props args)))
4420 (make-null-markup))))))
4421 (lambda (key stencils)
4424 (interpret-markup layout props
4425 (compose (make-stencil-markup sten))))