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 '() '(1 . -1) '(1 . -1)))
115 (define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
121 (define-markup-command (draw-line layout props dest)
124 #:properties ((thickness 1))
126 @cindex drawing lines within text
129 @lilypond[verbatim,quote]
131 \\draw-line #'(4 . 4)
132 \\override #'(thickness . 5)
133 \\draw-line #'(-3 . 0)
136 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
140 (make-line-stencil th 0 0 x y)))
142 (define-markup-command (draw-hline layout props)
145 #:properties ((draw-line-markup)
149 @cindex drawing a line across a page
151 Draws a line across a page, where the property @code{span-factor}
152 controls what fraction of the page is taken up.
153 @lilypond[verbatim,quote]
157 \\override #'(span-factor . 1/3)
162 (interpret-markup layout
164 (markup #:draw-line (cons (* line-width
168 (define-markup-command (draw-circle layout props radius thickness filled)
169 (number? number? boolean?)
172 @cindex drawing circles within text
174 A circle of radius @var{radius} and thickness @var{thickness},
177 @lilypond[verbatim,quote]
179 \\draw-circle #2 #0.5 ##f
181 \\draw-circle #2 #0 ##t
184 (make-circle-stencil radius thickness filled))
186 (define-markup-command (triangle layout props filled)
189 #:properties ((thickness 0.1)
193 @cindex drawing triangles within text
195 A triangle, either filled or empty.
197 @lilypond[verbatim,quote]
204 (let ((ex (* (magstep font-size) 0.8 baseline-skip)))
213 (cons 0 (* .86 ex)))))
215 (define-markup-command (circle layout props arg)
218 #:properties ((thickness 1)
220 (circle-padding 0.2))
222 @cindex circling text
224 Draw a circle around @var{arg}. Use @code{thickness},
225 @code{circle-padding} and @code{font-size} properties to determine line
226 thickness and padding around the markup.
228 @lilypond[verbatim,quote]
235 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
237 (pad (* (magstep font-size) circle-padding))
238 (m (interpret-markup layout props arg)))
239 (circle-stencil m th pad)))
241 (define-markup-command (with-url layout props url arg)
245 @cindex inserting URL links into text
247 Add a link to URL @var{url} around @var{arg}. This only works in
250 @lilypond[verbatim,quote]
252 \\with-url #\"http://lilypond.org/web/\" {
253 LilyPond ... \\italic {
254 music notation for everyone
259 (let* ((stil (interpret-markup layout props arg))
260 (xextent (ly:stencil-extent stil X))
261 (yextent (ly:stencil-extent stil Y))
262 (old-expr (ly:stencil-expr stil))
263 (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent))))
265 (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil)))
267 (define-markup-command (page-link layout props page-number arg)
271 @cindex referencing page numbers in text
273 Add a link to the page @var{page-number} around @var{arg}. This only works
276 @lilypond[verbatim,quote]
278 \\page-link #2 { \\italic { This links to page 2... } }
281 (let* ((stil (interpret-markup layout props arg))
282 (xextent (ly:stencil-extent stil X))
283 (yextent (ly:stencil-extent stil Y))
284 (old-expr (ly:stencil-expr stil))
285 (link-expr (list 'page-link page-number `(quote ,xextent) `(quote ,yextent))))
287 (ly:stencil-add (ly:make-stencil link-expr xextent yextent) stil)))
289 (define-markup-command (with-link layout props label arg)
293 @cindex referencing page labels in text
295 Add a link to the page holding label @var{label} around @var{arg}. This
296 only works in the PDF backend.
298 @lilypond[verbatim,quote]
300 \\with-link #'label {
301 \\italic { This links to the page containing the label... }
305 (let* ((arg-stencil (interpret-markup layout props arg))
306 (x-ext (ly:stencil-extent arg-stencil X))
307 (y-ext (ly:stencil-extent arg-stencil Y)))
309 `(delay-stencil-evaluation
310 ,(delay (ly:stencil-expr
311 (let* ((table (ly:output-def-lookup layout 'label-page-table))
312 (page-number (if (list? table)
313 (assoc-get label table)
315 (link-expr (list 'page-link page-number
316 `(quote ,x-ext) `(quote ,y-ext))))
317 (ly:stencil-add (ly:make-stencil link-expr x-ext y-ext)
323 (define-markup-command (beam layout props width slope thickness)
324 (number? number? number?)
327 @cindex drawing beams within text
329 Create a beam with the specified parameters.
330 @lilypond[verbatim,quote]
335 (let* ((y (* slope width))
336 (yext (cons (min 0 y) (max 0 y)))
337 (half (/ thickness 2)))
342 width (+ (* width slope) (/ thickness -2))
343 width (+ (* width slope) (/ thickness 2))
345 ,(ly:output-def-lookup layout 'blot-diameter)
348 (cons (+ (- half) (car yext))
349 (+ half (cdr yext))))))
351 (define-markup-command (underline layout props arg)
354 #:properties ((thickness 1) (offset 2))
356 @cindex underlining text
358 Underline @var{arg}. Looks at @code{thickness} to determine line
359 thickness, and @code{offset} to determine line y-offset.
361 @lilypond[verbatim,quote]
362 \\markup \\fill-line {
363 \\underline \"underlined\"
364 \\override #'(offset . 5)
365 \\override #'(thickness . 1)
366 \\underline \"underlined\"
367 \\override #'(offset . 1)
368 \\override #'(thickness . 5)
369 \\underline \"underlined\"
372 (let* ((thick (ly:output-def-lookup layout 'line-thickness))
373 (underline-thick (* thickness thick))
374 (markup (interpret-markup layout props arg))
375 (x1 (car (ly:stencil-extent markup X)))
376 (x2 (cdr (ly:stencil-extent markup X)))
377 (y (* thick (- offset)))
378 (line (make-line-stencil underline-thick x1 y x2 y)))
379 (ly:stencil-add markup line)))
381 (define-markup-command (box layout props arg)
384 #:properties ((thickness 1)
388 @cindex enclosing text within a box
390 Draw a box round @var{arg}. Looks at @code{thickness},
391 @code{box-padding} and @code{font-size} properties to determine line
392 thickness and padding around the markup.
394 @lilypond[verbatim,quote]
396 \\override #'(box-padding . 0.5)
401 (let* ((th (* (ly:output-def-lookup layout 'line-thickness)
403 (pad (* (magstep font-size) box-padding))
404 (m (interpret-markup layout props arg)))
405 (box-stencil m th pad)))
407 (define-markup-command (filled-box layout props xext yext blot)
408 (number-pair? number-pair? number?)
411 @cindex drawing solid boxes within text
412 @cindex drawing boxes with rounded corners
414 Draw a box with rounded corners of dimensions @var{xext} and
415 @var{yext}. For example,
417 \\filled-box #'(-.3 . 1.8) #'(-.3 . 1.8) #0
419 creates a box extending horizontally from -0.3 to 1.8 and
420 vertically from -0.3 up to 1.8, with corners formed from a
421 circle of diameter@tie{}0 (i.e., sharp corners).
423 @lilypond[verbatim,quote]
425 \\filled-box #'(0 . 4) #'(0 . 4) #0
426 \\filled-box #'(0 . 2) #'(-4 . 2) #0.4
427 \\filled-box #'(1 . 8) #'(0 . 7) #0.2
429 \\filled-box #'(-4.5 . -2.5) #'(3.5 . 5.5) #0.7
435 (define-markup-command (rounded-box layout props arg)
438 #:properties ((thickness 1)
442 "@cindex enclosing text in a box with rounded corners
443 @cindex drawing boxes with rounded corners around text
444 Draw a box with rounded corners around @var{arg}. Looks at @code{thickness},
445 @code{box-padding} and @code{font-size} properties to determine line
446 thickness and padding around the markup; the @code{corner-radius} property
447 makes it possible to define another shape for the corners (default is 1).
449 @lilypond[quote,verbatim,relative=2]
457 (let ((th (* (ly:output-def-lookup layout 'line-thickness)
459 (pad (* (magstep font-size) box-padding))
460 (m (interpret-markup layout props arg)))
461 (ly:stencil-add (rounded-box-stencil m th pad corner-radius)
464 (define-markup-command (rotate layout props ang arg)
468 @cindex rotating text
470 Rotate object with @var{ang} degrees around its center.
472 @lilypond[verbatim,quote]
482 (let* ((stil (interpret-markup layout props arg)))
483 (ly:stencil-rotate stil ang 0 0)))
485 (define-markup-command (whiteout layout props arg)
489 @cindex adding a white background to text
491 Provide a white background for @var{arg}.
493 @lilypond[verbatim,quote]
496 \\filled-box #'(-1 . 10) #'(-3 . 4) #1
500 (stencil-whiteout (interpret-markup layout props arg)))
502 (define-markup-command (pad-markup layout props amount arg)
507 @cindex putting space around text
509 Add space around a markup object.
511 @lilypond[verbatim,quote]
525 ((stil (interpret-markup layout props arg))
526 (xext (ly:stencil-extent stil X))
527 (yext (ly:stencil-extent stil Y)))
530 (ly:stencil-expr stil)
531 (interval-widen xext amount)
532 (interval-widen yext amount))))
534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
536 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
538 (define-markup-command (strut layout props)
542 @cindex creating vertical spaces in text
544 Create a box of the same height as the space in the current font."
545 (let ((m (ly:text-interface::interpret-markup layout props " ")))
546 (ly:make-stencil (ly:stencil-expr m)
548 (ly:stencil-extent m X)
551 ;; todo: fix negative space
552 (define-markup-command (hspace layout props amount)
555 #:properties ((word-space))
557 @cindex creating horizontal spaces in text
559 Create an invisible object taking up horizontal space @var{amount}.
561 @lilypond[verbatim,quote]
570 (let ((corrected-space (- amount word-space)))
571 (if (> corrected-space 0)
572 (ly:make-stencil "" (cons 0 corrected-space) '(0 . 0))
573 (ly:make-stencil "" (cons corrected-space corrected-space) '(0 . 0)))))
575 ;; todo: fix negative space
576 (define-markup-command (vspace layout props amount)
580 @cindex creating vertical spaces in text
582 Create an invisible object taking up vertical space
583 of @var{amount} multiplied by 3.
585 @lilypond[verbatim,quote]
596 (let ((amount (* amount 3.0)))
598 (ly:make-stencil "" (cons 0 0) (cons 0 amount))
599 (ly:make-stencil "" (cons 0 0) (cons amount amount)))))
602 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
603 ;; importing graphics.
604 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
606 (define-markup-command (stencil layout props stil)
610 @cindex importing stencils into text
612 Use a stencil as markup.
614 @lilypond[verbatim,quote]
616 \\stencil #(make-circle-stencil 2 0 #t)
622 (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)"))
624 (define (get-postscript-bbox string)
625 "Extract the bbox from STRING, or return #f if not present."
627 ((match (regexp-exec bbox-regexp string)))
631 (string->number (match:substring match x)))
636 (define-markup-command (epsfile layout props axis size file-name)
637 (number? number? string?)
640 @cindex inlining an Encapsulated PostScript image
642 Inline an EPS image. The image is scaled along @var{axis} to
645 @lilypond[verbatim,quote]
647 \\general-align #Y #DOWN {
648 \\epsfile #X #20 #\"context-example.eps\"
649 \\epsfile #Y #20 #\"context-example.eps\"
653 (if (ly:get-option 'safe)
654 (interpret-markup layout props "not allowed in safe")
655 (eps-file->stencil axis size file-name)
658 (define-markup-command (postscript layout props str)
662 @cindex inserting PostScript directly into text
663 This inserts @var{str} directly into the output as a PostScript
666 @lilypond[verbatim,quote]
670 0.4 0.6 0.5 0 361 arc
672 1.0 0.6 0.5 0 361 arc
677 \\with-dimensions #'(-0.2 . 1.6) #'(0 . 1.2)
678 \\postscript #ringsps
690 gsave currentpoint translate
698 (define-markup-command (path layout props thickness commands) (number? list?)
700 #:properties ((line-cap-style 'round)
701 (line-join-style 'round)
704 @cindex paths, drawing
705 @cindex drawing paths
706 Draws a path with line thickness @var{thickness} according to the
707 directions given in @var{commands}. @var{commands} is a list of
708 lists where the @code{car} of each sublist is a drawing command and
709 the @code{cdr} comprises the associated arguments for each command.
711 Line-cap styles and line-join styles may be customized by
712 overriding the @code{line-cap-style} and @code{line-join-style}
713 properties, respectively. Available line-cap styles are
714 @code{'butt}, @code{'round}, and @code{'square}. Available
715 line-join styles are @code{'miter}, @code{'round}, and
718 The property @code{filled} specifies whether or not the path is
721 There are seven commands available to use in the list
722 @code{commands}: @code{moveto}, @code{rmoveto}, @code{lineto},
723 @code{rlineto}, @code{curveto}, @code{rcurveto}, and
724 @code{closepath}. Note that the commands that begin with @emph{r}
725 are the relative variants of the other three commands.
727 The commands @code{moveto}, @code{rmoveto}, @code{lineto}, and
728 @code{rlineto} take 2 arguments; they are the X and Y coordinates
729 for the destination point.
731 The commands @code{curveto} and @code{rcurveto} create cubic
732 Bézier curves, and take 6 arguments; the first two are the X and Y
733 coordinates for the first control point, the second two are the X
734 and Y coordinates for the second control point, and the last two
735 are the X and Y coordinates for the destination point.
737 The @code{closepath} command takes zero arguments and closes the
738 current subpath in the active path.
740 Note that a sequence of commands @emph{must} begin with a
741 @code{moveto} or @code{rmoveto} to work with the SVG output.
743 @lilypond[verbatim,quote]
749 (curveto -5 -5 -5 5 -1 0)
753 \\path #0.25 #samplePath
756 (let* ((half-thickness (/ thickness 2))
757 (current-point '(0 . 0))
758 (set-point (lambda (lst) (set! current-point lst)))
759 (relative? (lambda (x)
760 (string-prefix? "r" (symbol->string (car x)))))
761 ;; For calculating extents, we want to modify the command
762 ;; list so that all coordinates are absolute.
763 (new-commands (map (lambda (x)
765 ;; for rmoveto, rlineto
766 ((and (relative? x) (eq? 3 (length x)))
768 (+ (car current-point)
770 (+ (cdr current-point)
776 ((and (relative? x) (eq? 7 (length x)))
777 (let* ((old-cp current-point)
784 (list (+ (car old-cp) (second x))
785 (+ (cdr old-cp) (third x))
786 (+ (car old-cp) (fourth x))
787 (+ (cdr old-cp) (fifth x))
790 ;; for moveto, lineto
792 (set-point (cons (second x)
797 (set-point (cons (sixth x)
800 ;; keep closepath for filtering;
801 ;; see `without-closepath'.
804 ;; path-min-max does not accept 0-arg lists,
805 ;; and since closepath does not affect extents, filter
806 ;; out those commands here.
807 (without-closepath (filter (lambda (x)
808 (not (equal? 'closepath (car x))))
810 (extents (path-min-max
811 ;; set the origin to the first moveto
812 (list (list-ref (car without-closepath) 0)
813 (list-ref (car without-closepath) 1))
815 (X-extent (cons (list-ref extents 0) (list-ref extents 1)))
816 (Y-extent (cons (list-ref extents 2) (list-ref extents 3)))
817 (command-list (fold-right append '() commands)))
819 ;; account for line thickness
820 (set! X-extent (interval-widen X-extent half-thickness))
821 (set! Y-extent (interval-widen Y-extent half-thickness))
824 `(path ,thickness `(,@',command-list)
825 ',line-cap-style ',line-join-style ,filled)
829 (define-markup-command (score layout props score)
832 #:properties ((baseline-skip))
834 @cindex inserting music into text
836 Inline an image of music.
838 @lilypond[verbatim,quote]
842 \\new Staff \\relative c' {
845 \\mark \\markup { Allegro }
851 \\new Staff \\relative c {
865 \\override RehearsalMark
866 #'break-align-symbols = #'(time-signature key-signature)
867 \\override RehearsalMark
868 #'self-alignment-X = #LEFT
872 \\override TimeSignature
873 #'break-align-anchor-alignment = #LEFT
879 (let ((output (ly:score-embedded-format score layout)))
881 (if (ly:music-output? output)
882 (stack-stencils Y DOWN baseline-skip
883 (map paper-system-stencil
885 (ly:paper-score-paper-systems output))))
887 (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?"))
890 (define-markup-command (null layout props)
894 @cindex creating empty text objects
896 An empty markup with extents of a single point.
898 @lilypond[verbatim,quote]
905 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
907 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
909 (define-markup-command (simple layout props str)
913 @cindex simple text strings
915 A simple text string; @code{\\markup @{ foo @}} is equivalent with
916 @code{\\markup @{ \\simple #\"foo\" @}}.
918 Note: for creating standard text markup or defining new markup commands,
919 the use of @code{\\simple} is unnecessary.
921 @lilypond[verbatim,quote]
925 \\simple #\"strings\"
928 (interpret-markup layout props str))
930 (define-markup-command (tied-lyric layout props str)
933 #:properties ((word-space))
935 @cindex simple text strings with tie characters
937 Like simple-markup, but use tie characters for @q{~} tilde symbols.
939 @lilypond[verbatim,quote]
941 \\tied-lyric #\"Siam navi~all'onde~algenti Lasciate~in abbandono\"
942 \\tied-lyric #\"Impetuosi venti I nostri~affetti sono\"
943 \\tied-lyric #\"Ogni diletto~e scoglio Tutta la vita~e~un mar.\"
946 (define (replace-ties tie str)
947 (if (string-contains str "~")
949 ((half-space (/ word-space 2))
950 (parts (string-split str #\~))
951 (tie-str (markup #:hspace half-space
953 #:hspace half-space))
954 (joined (list-join parts tie-str)))
955 (make-concat-markup joined))
958 (define short-tie-regexp (make-regexp "~[^.]~"))
959 (define (match-short str) (regexp-exec short-tie-regexp str))
961 (define (replace-short str mkp)
962 (let ((match (match-short str)))
964 (make-concat-markup (list
966 (replace-ties "ties.lyric.default" str)))
967 (let ((new-str (match:suffix match))
968 (new-mkp (make-concat-markup (list
970 (replace-ties "ties.lyric.default"
971 (match:prefix match))
972 (replace-ties "ties.lyric.short"
973 (match:substring match))))))
974 (replace-short new-str new-mkp)))))
976 (interpret-markup layout
978 (replace-short str (markup))))
980 (define-public empty-markup
981 (make-simple-markup ""))
983 ;; helper for justifying lines.
984 (define (get-fill-space word-count line-width word-space text-widths)
985 "Calculate the necessary paddings between each two adjacent texts.
986 The lengths of all texts are stored in @var{text-widths}.
987 The normal formula for the padding between texts a and b is:
988 padding = line-width/(word-count - 1) - (length(a) + length(b))/2
989 The first and last padding have to be calculated specially using the
990 whole length of the first or last text.
991 All paddings are checked to be at least word-space, to ensure that
993 Return a list of paddings."
995 ((null? text-widths) '())
997 ;; special case first padding
998 ((= (length text-widths) word-count)
1000 (- (- (/ line-width (1- word-count)) (car text-widths))
1001 (/ (car (cdr text-widths)) 2))
1002 (get-fill-space word-count line-width word-space (cdr text-widths))))
1003 ;; special case last padding
1004 ((= (length text-widths) 2)
1005 (list (- (/ line-width (1- word-count))
1006 (+ (/ (car text-widths) 2) (car (cdr text-widths)))) 0))
1008 (let ((default-padding
1009 (- (/ line-width (1- word-count))
1010 (/ (+ (car text-widths) (car (cdr text-widths))) 2))))
1012 (if (> word-space default-padding)
1015 (get-fill-space word-count line-width word-space (cdr text-widths)))))))
1017 (define-markup-command (fill-line layout props args)
1020 #:properties ((text-direction RIGHT)
1023 "Put @var{markups} in a horizontal line of width @var{line-width}.
1024 The markups are spaced or flushed to fill the entire line.
1025 If there are no arguments, return an empty stencil.
1027 @lilypond[verbatim,quote]
1031 Words evenly spaced across the page
1035 \\line { Text markups }
1037 \\italic { evenly spaced }
1039 \\line { across the page }
1044 (let* ((orig-stencils (interpret-markup-list layout props args))
1047 (if (ly:stencil-empty? stc)
1049 stc)) orig-stencils))
1052 (if (ly:stencil-empty? stc)
1054 (interval-length (ly:stencil-extent stc X))))
1056 (text-width (apply + text-widths))
1057 (word-count (length stencils))
1058 (line-width (or line-width (ly:output-def-lookup layout 'line-width)))
1063 (/ (- line-width text-width) 2)
1064 (/ (- line-width text-width) 2)))
1067 (- line-width text-width)))
1069 (get-fill-space word-count line-width word-space text-widths))))
1071 (line-contents (if (= word-count 1)
1078 (if (null? (remove ly:stencil-empty? orig-stencils))
1081 (if (= text-direction LEFT)
1082 (set! line-contents (reverse line-contents)))
1084 (stack-stencils-padding-list
1085 X RIGHT fill-space line-contents))
1086 (if (> word-count 1)
1087 ;; shift s.t. stencils align on the left edge, even if
1088 ;; first stencil had negative X-extent (e.g. center-column)
1089 ;; (if word-count = 1, X-extents are already normalized in
1090 ;; the definition of line-contents)
1092 (ly:stencil-translate-axis
1094 (- (car (ly:stencil-extent (car stencils) X)))
1098 (define-markup-command (line layout props args)
1101 #:properties ((word-space)
1102 (text-direction RIGHT))
1103 "Put @var{args} in a horizontal line. The property @code{word-space}
1104 determines the space between markups in @var{args}.
1106 @lilypond[verbatim,quote]
1113 (let ((stencils (interpret-markup-list layout props args)))
1114 (if (= text-direction LEFT)
1115 (set! stencils (reverse stencils)))
1118 (remove ly:stencil-empty? stencils))))
1120 (define-markup-command (concat layout props args)
1124 @cindex concatenating text
1125 @cindex ligatures in text
1127 Concatenate @var{args} in a horizontal line, without spaces in between.
1128 Strings and simple markups are concatenated on the input level, allowing
1129 ligatures. For example, @code{\\concat @{ \"f\" \\simple #\"i\" @}} is
1130 equivalent to @code{\"fi\"}.
1132 @lilypond[verbatim,quote]
1141 (define (concat-string-args arg-list)
1142 (fold-right (lambda (arg result-list)
1143 (let ((result (if (pair? result-list)
1146 (if (and (pair? arg) (eqv? (car arg) simple-markup))
1147 (set! arg (cadr arg)))
1148 (if (and (string? result) (string? arg))
1149 (cons (string-append arg result) (cdr result-list))
1150 (cons arg result-list))))
1154 (interpret-markup layout
1155 (prepend-alist-chain 'word-space 0 props)
1156 (make-line-markup (if (markup-command-list? args)
1158 (concat-string-args args)))))
1160 (define (wordwrap-stencils stencils
1161 justify base-space line-width text-dir)
1162 "Perform simple wordwrap, return stencil of each line."
1163 (define space (if justify
1164 ;; justify only stretches lines.
1167 (define (take-list width space stencils
1168 accumulator accumulated-width)
1169 "Return (head-list . tail) pair, with head-list fitting into width"
1170 (if (null? stencils)
1171 (cons accumulator stencils)
1172 (let* ((first (car stencils))
1173 (first-wid (cdr (ly:stencil-extent (car stencils) X)))
1174 (newwid (+ space first-wid accumulated-width)))
1175 (if (or (null? accumulator)
1177 (take-list width space
1179 (cons first accumulator)
1181 (cons accumulator stencils)))))
1182 (let loop ((lines '())
1184 (let* ((line-break (take-list line-width space todo
1186 (line-stencils (car line-break))
1187 (space-left (- line-width
1188 (apply + (map (lambda (x) (cdr (ly:stencil-extent x X)))
1190 (line-word-space (cond ((not justify) space)
1191 ;; don't stretch last line of paragraph.
1192 ;; hmmm . bug - will overstretch the last line in some case.
1193 ((null? (cdr line-break))
1195 ((null? line-stencils) 0.0)
1196 ((null? (cdr line-stencils)) 0.0)
1197 (else (/ space-left (1- (length line-stencils))))))
1198 (line (stack-stencil-line line-word-space
1199 (if (= text-dir RIGHT)
1200 (reverse line-stencils)
1202 (if (pair? (cdr line-break))
1203 (loop (cons line lines)
1206 (if (= text-dir LEFT)
1208 (ly:stencil-translate-axis
1210 (- line-width (interval-end (ly:stencil-extent line X)))
1212 (reverse (cons line lines)))))))
1214 (define-markup-list-command (wordwrap-internal layout props justify args)
1215 (boolean? markup-list?)
1216 #:properties ((line-width #f)
1218 (text-direction RIGHT))
1219 "Internal markup list command used to define @code{\\justify} and @code{\\wordwrap}."
1220 (wordwrap-stencils (remove ly:stencil-empty?
1221 (interpret-markup-list layout props args))
1225 (ly:output-def-lookup layout 'line-width))
1228 (define-markup-command (justify layout props args)
1231 #:properties ((baseline-skip)
1232 wordwrap-internal-markup-list)
1234 @cindex justifying text
1236 Like @code{\\wordwrap}, but with lines stretched to justify the margins.
1237 Use @code{\\override #'(line-width . @var{X})} to set the line width;
1238 @var{X}@tie{}is the number of staff spaces.
1240 @lilypond[verbatim,quote]
1243 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1244 do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1245 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1246 laboris nisi ut aliquip ex ea commodo consequat.
1250 (stack-lines DOWN 0.0 baseline-skip
1251 (wordwrap-internal-markup-list layout props #t args)))
1253 (define-markup-command (wordwrap layout props args)
1256 #:properties ((baseline-skip)
1257 wordwrap-internal-markup-list)
1258 "Simple wordwrap. Use @code{\\override #'(line-width . @var{X})} to set
1259 the line width, where @var{X} is the number of staff spaces.
1261 @lilypond[verbatim,quote]
1264 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed
1265 do eiusmod tempor incididunt ut labore et dolore magna aliqua.
1266 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1267 laboris nisi ut aliquip ex ea commodo consequat.
1271 (stack-lines DOWN 0.0 baseline-skip
1272 (wordwrap-internal-markup-list layout props #f args)))
1274 (define-markup-list-command (wordwrap-string-internal layout props justify arg)
1276 #:properties ((line-width)
1278 (text-direction RIGHT))
1279 "Internal markup list command used to define @code{\\justify-string} and
1280 @code{\\wordwrap-string}."
1281 (let* ((para-strings (regexp-split
1282 (string-regexp-substitute
1284 (string-regexp-substitute "\r\n" "\n" arg))
1285 "\n[ \t\n]*\n[ \t\n]*"))
1286 (list-para-words (map (lambda (str)
1287 (regexp-split str "[ \t\n]+"))
1289 (para-lines (map (lambda (words)
1291 (remove ly:stencil-empty?
1293 (interpret-markup layout props x))
1295 (wordwrap-stencils stencils
1297 line-width text-direction)))
1299 (apply append para-lines)))
1301 (define-markup-command (wordwrap-string layout props arg)
1304 #:properties ((baseline-skip)
1305 wordwrap-string-internal-markup-list)
1306 "Wordwrap a string. Paragraphs may be separated with double newlines.
1308 @lilypond[verbatim,quote]
1310 \\override #'(line-width . 40)
1311 \\wordwrap-string #\"Lorem ipsum dolor sit amet, consectetur
1312 adipisicing elit, sed do eiusmod tempor incididunt ut labore
1313 et dolore magna aliqua.
1316 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1317 laboris nisi ut aliquip ex ea commodo consequat.
1320 Excepteur sint occaecat cupidatat non proident, sunt in culpa
1321 qui officia deserunt mollit anim id est laborum\"
1324 (stack-lines DOWN 0.0 baseline-skip
1325 (wordwrap-string-internal-markup-list layout props #f arg)))
1327 (define-markup-command (justify-string layout props arg)
1330 #:properties ((baseline-skip)
1331 wordwrap-string-internal-markup-list)
1332 "Justify a string. Paragraphs may be separated with double newlines
1334 @lilypond[verbatim,quote]
1336 \\override #'(line-width . 40)
1337 \\justify-string #\"Lorem ipsum dolor sit amet, consectetur
1338 adipisicing elit, sed do eiusmod tempor incididunt ut labore
1339 et dolore magna aliqua.
1342 Ut enim ad minim veniam, quis nostrud exercitation ullamco
1343 laboris nisi ut aliquip ex ea commodo consequat.
1346 Excepteur sint occaecat cupidatat non proident, sunt in culpa
1347 qui officia deserunt mollit anim id est laborum\"
1350 (stack-lines DOWN 0.0 baseline-skip
1351 (wordwrap-string-internal-markup-list layout props #t arg)))
1353 (define-markup-command (wordwrap-field layout props symbol)
1356 "Wordwrap the data which has been assigned to @var{symbol}.
1358 @lilypond[verbatim,quote]
1360 title = \"My title\"
1361 myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1362 elit, sed do eiusmod tempor incididunt ut labore et dolore
1363 magna aliqua. Ut enim ad minim veniam, quis nostrud
1364 exercitation ullamco laboris nisi ut aliquip ex ea commodo
1369 bookTitleMarkup = \\markup {
1371 \\fill-line { \\fromproperty #'header:title }
1373 \\wordwrap-field #'header:myText
1382 (let* ((m (chain-assoc-get symbol props)))
1384 (wordwrap-string-markup layout props m)
1387 (define-markup-command (justify-field layout props symbol)
1390 "Justify the data which has been assigned to @var{symbol}.
1392 @lilypond[verbatim,quote]
1394 title = \"My title\"
1395 myText = \"Lorem ipsum dolor sit amet, consectetur adipisicing
1396 elit, sed do eiusmod tempor incididunt ut labore et dolore magna
1397 aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
1398 laboris nisi ut aliquip ex ea commodo consequat.\"
1402 bookTitleMarkup = \\markup {
1404 \\fill-line { \\fromproperty #'header:title }
1406 \\justify-field #'header:myText
1415 (let* ((m (chain-assoc-get symbol props)))
1417 (justify-string-markup layout props m)
1420 (define-markup-command (combine layout props arg1 arg2)
1424 @cindex merging text
1426 Print two markups on top of each other.
1428 Note: @code{\\combine} cannot take a list of markups enclosed in
1429 curly braces as an argument; the follow example will not compile:
1432 \\combine @{ a list @}
1435 @lilypond[verbatim,quote]
1438 \\override #'(thickness . 2)
1440 \\draw-line #'(0 . 4)
1441 \\arrow-head #Y #DOWN ##f
1444 (let* ((s1 (interpret-markup layout props arg1))
1445 (s2 (interpret-markup layout props arg2)))
1446 (ly:stencil-add s1 s2)))
1449 ;; TODO: should extract baseline-skip from each argument somehow..
1451 (define-markup-command (column layout props args)
1454 #:properties ((baseline-skip))
1456 @cindex stacking text in a column
1458 Stack the markups in @var{args} vertically. The property
1459 @code{baseline-skip} determines the space between markups
1462 @lilypond[verbatim,quote]
1471 (let ((arg-stencils (interpret-markup-list layout props args)))
1472 (stack-lines -1 0.0 baseline-skip
1473 (remove ly:stencil-empty? arg-stencils))))
1475 (define-markup-command (dir-column layout props args)
1478 #:properties ((direction)
1481 @cindex changing direction of text columns
1483 Make a column of @var{args}, going up or down, depending on the
1484 setting of the @code{direction} layout property.
1486 @lilypond[verbatim,quote]
1488 \\override #`(direction . ,UP) {
1498 \\override #'(direction . 1) {
1505 (stack-lines (if (number? direction) direction -1)
1508 (interpret-markup-list layout props args)))
1510 (define (general-column align-dir baseline mols)
1511 "Stack @var{mols} vertically, aligned to @var{align-dir} horizontally."
1513 (let* ((aligned-mols (map (lambda (x) (ly:stencil-aligned-to x X align-dir)) mols))
1514 (stacked-stencil (stack-lines -1 0.0 baseline aligned-mols))
1515 (stacked-extent (ly:stencil-extent stacked-stencil X)))
1516 (ly:stencil-translate-axis stacked-stencil (- (car stacked-extent)) X )))
1518 (define-markup-command (center-column layout props args)
1521 #:properties ((baseline-skip))
1523 @cindex centering a column of text
1525 Put @code{args} in a centered column.
1527 @lilypond[verbatim,quote]
1536 (general-column CENTER baseline-skip (interpret-markup-list layout props args)))
1538 (define-markup-command (left-column layout props args)
1541 #:properties ((baseline-skip))
1543 @cindex text columns, left-aligned
1545 Put @code{args} in a left-aligned column.
1547 @lilypond[verbatim,quote]
1556 (general-column LEFT baseline-skip (interpret-markup-list layout props args)))
1558 (define-markup-command (right-column layout props args)
1561 #:properties ((baseline-skip))
1563 @cindex text columns, right-aligned
1565 Put @code{args} in a right-aligned column.
1567 @lilypond[verbatim,quote]
1576 (general-column RIGHT baseline-skip (interpret-markup-list layout props args)))
1578 (define-markup-command (vcenter layout props arg)
1582 @cindex vertically centering text
1584 Align @code{arg} to its Y@tie{}center.
1586 @lilypond[verbatim,quote]
1594 (let* ((mol (interpret-markup layout props arg)))
1595 (ly:stencil-aligned-to mol Y CENTER)))
1597 (define-markup-command (center-align layout props arg)
1601 @cindex horizontally centering text
1603 Align @code{arg} to its X@tie{}center.
1605 @lilypond[verbatim,quote]
1615 (let* ((mol (interpret-markup layout props arg)))
1616 (ly:stencil-aligned-to mol X CENTER)))
1618 (define-markup-command (right-align layout props arg)
1622 @cindex right aligning text
1624 Align @var{arg} on its right edge.
1626 @lilypond[verbatim,quote]
1636 (let* ((m (interpret-markup layout props arg)))
1637 (ly:stencil-aligned-to m X RIGHT)))
1639 (define-markup-command (left-align layout props arg)
1643 @cindex left aligning text
1645 Align @var{arg} on its left edge.
1647 @lilypond[verbatim,quote]
1657 (let* ((m (interpret-markup layout props arg)))
1658 (ly:stencil-aligned-to m X LEFT)))
1660 (define-markup-command (general-align layout props axis dir arg)
1661 (integer? number? markup?)
1664 @cindex controlling general text alignment
1666 Align @var{arg} in @var{axis} direction to the @var{dir} side.
1668 @lilypond[verbatim,quote]
1672 \\general-align #X #LEFT
1677 \\general-align #X #CENTER
1683 \\general-align #Y #UP
1690 \\general-align #Y #3.2
1697 (let* ((m (interpret-markup layout props arg)))
1698 (ly:stencil-aligned-to m axis dir)))
1700 (define-markup-command (halign layout props dir arg)
1704 @cindex setting horizontal text alignment
1706 Set horizontal alignment. If @var{dir} is @w{@code{-1}}, then it is
1707 left-aligned, while @code{+1} is right. Values in between interpolate
1708 alignment accordingly.
1710 @lilypond[verbatim,quote]
1735 (let* ((m (interpret-markup layout props arg)))
1736 (ly:stencil-aligned-to m X dir)))
1738 (define-markup-command (with-dimensions layout props x y arg)
1739 (number-pair? number-pair? markup?)
1742 @cindex setting extent of text objects
1744 Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}."
1745 (let* ((m (interpret-markup layout props arg)))
1746 (ly:make-stencil (ly:stencil-expr m) x y)))
1748 (define-markup-command (pad-around layout props amount arg)
1751 "Add padding @var{amount} all around @var{arg}.
1753 @lilypond[verbatim,quote]
1766 (let* ((m (interpret-markup layout props arg))
1767 (x (ly:stencil-extent m X))
1768 (y (ly:stencil-extent m Y)))
1769 (ly:make-stencil (ly:stencil-expr m)
1770 (interval-widen x amount)
1771 (interval-widen y amount))))
1773 (define-markup-command (pad-x layout props amount arg)
1777 @cindex padding text horizontally
1779 Add padding @var{amount} around @var{arg} in the X@tie{}direction.
1781 @lilypond[verbatim,quote]
1794 (let* ((m (interpret-markup layout props arg))
1795 (x (ly:stencil-extent m X))
1796 (y (ly:stencil-extent m Y)))
1797 (ly:make-stencil (ly:stencil-expr m)
1798 (interval-widen x amount)
1801 (define-markup-command (put-adjacent layout props axis dir arg1 arg2)
1802 (integer? ly:dir? markup? markup?)
1804 "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}."
1805 (let ((m1 (interpret-markup layout props arg1))
1806 (m2 (interpret-markup layout props arg2)))
1807 (ly:stencil-combine-at-edge m1 axis dir m2 0.0)))
1809 (define-markup-command (transparent layout props arg)
1812 "Make @var{arg} transparent.
1814 @lilypond[verbatim,quote]
1821 (let* ((m (interpret-markup layout props arg))
1822 (x (ly:stencil-extent m X))
1823 (y (ly:stencil-extent m Y)))
1824 (ly:make-stencil "" x y)))
1826 (define-markup-command (pad-to-box layout props x-ext y-ext arg)
1827 (number-pair? number-pair? markup?)
1829 "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space.
1831 @lilypond[verbatim,quote]
1838 \\pad-to-box #'(0 . 10) #'(0 . 3) {
1844 (let* ((m (interpret-markup layout props arg))
1845 (x (ly:stencil-extent m X))
1846 (y (ly:stencil-extent m Y)))
1847 (ly:make-stencil (ly:stencil-expr m)
1848 (interval-union x-ext x)
1849 (interval-union y-ext y))))
1851 (define-markup-command (hcenter-in layout props length arg)
1854 "Center @var{arg} horizontally within a box of extending
1855 @var{length}/2 to the left and right.
1857 @lilypond[quote,verbatim]
1860 \\set Staff.instrumentName = \\markup {
1867 \\set Staff.instrumentName = \\markup {
1876 (interpret-markup layout props
1877 (make-pad-to-box-markup
1878 (cons (/ length -2) (/ length 2))
1880 (make-center-align-markup arg))))
1882 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1884 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1886 (define-markup-command (property-recursive layout props symbol)
1889 "Print out a warning when a header field markup contains some recursive
1891 (ly:warning "Recursive definition of property ~a detected!" symbol)
1894 (define-markup-command (fromproperty layout props symbol)
1897 "Read the @var{symbol} from property settings, and produce a stencil
1898 from the markup contained within. If @var{symbol} is not defined, it
1899 returns an empty markup.
1901 @lilypond[verbatim,quote]
1903 myTitle = \"myTitle\"
1907 \\fromproperty #'header:myTitle
1914 (let ((m (chain-assoc-get symbol props)))
1916 ;; prevent infinite loops by clearing the interpreted property:
1917 (interpret-markup layout (cons (list (cons symbol `(,property-recursive-markup ,symbol))) props) m)
1920 (define-markup-command (on-the-fly layout props procedure arg)
1921 (procedure? markup?)
1923 "Apply the @var{procedure} markup command to @var{arg}.
1924 @var{procedure} should take a single argument."
1925 (let ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg))))
1926 (set-object-property! anonymous-with-signature
1929 (interpret-markup layout props (list anonymous-with-signature arg))))
1931 (define-markup-command (footnote layout props mkup note)
1934 "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
1936 @lilypond[verbatim,quote]
1939 \\override #'(padding . 0.2)
1943 The footnote will not be annotated automatically."
1944 (ly:stencil-combine-at-edge
1945 (interpret-markup layout props mkup)
1949 `(footnote (gensym "footnote") #f ,(interpret-markup layout props note))
1954 (define-markup-command (auto-footnote layout props mkup note)
1957 #:properties ((raise 0.5)
1959 "Have footnote @var{note} act as an annotation to the markup @var{mkup}.
1961 @lilypond[verbatim,quote]
1964 \\override #'(padding . 0.2)
1968 The footnote will be annotated automatically."
1969 (let* ((markup-stencil (interpret-markup layout props mkup))
1970 (footnote-hash (gensym "footnote"))
1972 (gauge-stencil (interpret-markup
1975 ((ly:output-def-lookup
1977 'footnote-numbering-function)
1979 (x-ext (ly:stencil-extent gauge-stencil X))
1980 (y-ext (ly:stencil-extent gauge-stencil Y))
1982 `(delay-stencil-evaluation
1986 (ly:output-def-lookup layout
1987 'number-footnote-table))
1988 (footnote-stencil (if (list? table)
1989 (assoc-get footnote-hash
1992 (footnote-stencil (if (ly:stencil? footnote-stencil)
1995 (ly:programming-error
1996 "Cannot find correct footnote for a markup object.")
1998 (gap (- (interval-length x-ext)
2000 (ly:stencil-extent footnote-stencil X))))
2001 (y-trans (- (+ (cdr y-ext)
2003 (cdr (ly:stencil-extent footnote-stencil
2005 (ly:stencil-translate footnote-stencil
2006 (cons gap y-trans)))))))
2007 (main-stencil (ly:stencil-combine-at-edge
2011 (ly:make-stencil footnote-number x-ext y-ext)
2016 `(footnote ,footnote-hash #t ,(interpret-markup layout props note))
2020 (define-markup-command (override layout props new-prop arg)
2024 @cindex overriding properties within text markup
2026 Add the argument @var{new-prop} to the property list. Properties
2027 may be any property supported by @rinternals{font-interface},
2028 @rinternals{text-interface} and
2029 @rinternals{instrument-specific-markup-interface}.
2031 @lilypond[verbatim,quote]
2039 \\override #'(baseline-skip . 4) {
2048 (interpret-markup layout (cons (list new-prop) props) arg))
2050 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2052 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2054 (define-markup-command (verbatim-file layout props name)
2057 "Read the contents of file @var{name}, and include it verbatim.
2059 @lilypond[verbatim,quote]
2061 \\verbatim-file #\"simple.ly\"
2064 (interpret-markup layout props
2065 (if (ly:get-option 'safe)
2066 "verbatim-file disabled in safe mode"
2067 (let* ((str (ly:gulp-file name))
2068 (lines (string-split str #\nl)))
2069 (make-typewriter-markup
2070 (make-column-markup lines))))))
2072 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2074 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2077 (define-markup-command (smaller layout props arg)
2080 "Decrease the font size relative to the current setting.
2082 @lilypond[verbatim,quote]
2095 (interpret-markup layout props
2096 `(,fontsize-markup -1 ,arg)))
2098 (define-markup-command (larger layout props arg)
2101 "Increase the font size relative to the current setting.
2103 @lilypond[verbatim,quote]
2111 (interpret-markup layout props
2112 `(,fontsize-markup 1 ,arg)))
2114 (define-markup-command (finger layout props arg)
2117 "Set @var{arg} as small numbers.
2119 @lilypond[verbatim,quote]
2126 (interpret-markup layout
2127 (cons '((font-size . -5) (font-encoding . fetaText)) props)
2130 (define-markup-command (abs-fontsize layout props size arg)
2133 "Use @var{size} as the absolute font size to display @var{arg}.
2134 Adjusts @code{baseline-skip} and @code{word-space} accordingly.
2136 @lilypond[verbatim,quote]
2138 default text font size
2140 \\abs-fontsize #16 { text font size 16 }
2142 \\abs-fontsize #12 { text font size 12 }
2145 (let* ((ref-size (ly:output-def-lookup layout 'text-font-size 12))
2146 (text-props (list (ly:output-def-lookup layout 'text-font-defaults)))
2147 (ref-word-space (chain-assoc-get 'word-space text-props 0.6))
2148 (ref-baseline (chain-assoc-get 'baseline-skip text-props 3))
2149 (magnification (/ size ref-size)))
2153 `((baseline-skip . ,(* magnification ref-baseline))
2154 (word-space . ,(* magnification ref-word-space))
2155 (font-size . ,(magnification->font-size magnification)))
2159 (define-markup-command (fontsize layout props increment arg)
2162 #:properties ((font-size 0)
2165 "Add @var{increment} to the font-size. Adjusts @code{baseline-skip}
2168 @lilypond[verbatim,quote]
2179 `((baseline-skip . ,(* baseline-skip (magstep increment)))
2180 (word-space . ,(* word-space (magstep increment)))
2181 (font-size . ,(+ font-size increment)))
2185 (define-markup-command (magnify layout props sz arg)
2189 @cindex magnifying text
2191 Set the font magnification for its argument. In the following
2192 example, the middle@tie{}A is 10% larger:
2195 A \\magnify #1.1 @{ A @} A
2198 Note: Magnification only works if a font name is explicitly selected.
2199 Use @code{\\fontsize} otherwise.
2201 @lilypond[verbatim,quote]
2212 (prepend-alist-chain 'font-size (magnification->font-size sz) props)
2215 (define-markup-command (bold layout props arg)
2218 "Switch to bold font-series.
2220 @lilypond[verbatim,quote]
2228 (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
2230 (define-markup-command (sans layout props arg)
2233 "Switch to the sans serif font family.
2235 @lilypond[verbatim,quote]
2244 (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
2246 (define-markup-command (number layout props arg)
2249 "Set font family to @code{number}, which yields the font used for
2250 time signatures and fingerings. This font contains numbers and
2251 some punctuation; it has no letters.
2253 @lilypond[verbatim,quote]
2256 0 1 2 3 4 5 6 7 8 9 . ,
2260 (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2262 (define-markup-command (roman layout props arg)
2265 "Set font family to @code{roman}.
2267 @lilypond[verbatim,quote]
2273 text in roman font family
2280 (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
2282 (define-markup-command (huge layout props arg)
2285 "Set font size to +2.
2287 @lilypond[verbatim,quote]
2295 (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
2297 (define-markup-command (large layout props arg)
2300 "Set font size to +1.
2302 @lilypond[verbatim,quote]
2310 (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
2312 (define-markup-command (normalsize layout props arg)
2315 "Set font size to default.
2317 @lilypond[verbatim,quote]
2330 (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
2332 (define-markup-command (small layout props arg)
2335 "Set font size to -1.
2337 @lilypond[verbatim,quote]
2345 (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
2347 (define-markup-command (tiny layout props arg)
2350 "Set font size to -2.
2352 @lilypond[verbatim,quote]
2360 (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
2362 (define-markup-command (teeny layout props arg)
2365 "Set font size to -3.
2367 @lilypond[verbatim,quote]
2375 (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
2377 (define-markup-command (fontCaps layout props arg)
2380 "Set @code{font-shape} to @code{caps}
2382 Note: @code{\\fontCaps} requires the installation and selection of
2383 fonts which support the @code{caps} font shape."
2384 (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
2387 (define-markup-command (smallCaps layout props arg)
2390 "Emit @var{arg} as small caps.
2392 Note: @code{\\smallCaps} does not support accented characters.
2394 @lilypond[verbatim,quote]
2403 (define (char-list->markup chars lower)
2404 (let ((final-string (string-upcase (reverse-list->string chars))))
2406 (markup #:fontsize -2 final-string)
2408 (define (make-small-caps rest-chars currents current-is-lower prev-result)
2409 (if (null? rest-chars)
2411 (reverse! (cons (char-list->markup currents current-is-lower)
2413 (let* ((ch (car rest-chars))
2414 (is-lower (char-lower-case? ch)))
2415 (if (or (and current-is-lower is-lower)
2416 (and (not current-is-lower) (not is-lower)))
2417 (make-small-caps (cdr rest-chars)
2421 (make-small-caps (cdr rest-chars)
2424 (if (null? currents)
2426 (cons (char-list->markup
2427 currents current-is-lower)
2429 (interpret-markup layout props
2431 (make-small-caps (string->list arg) (list) #f (list))
2434 (define-markup-command (caps layout props arg)
2437 "Copy of the @code{\\smallCaps} command.
2439 @lilypond[verbatim,quote]
2448 (interpret-markup layout props (make-smallCaps-markup arg)))
2450 (define-markup-command (dynamic layout props arg)
2453 "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m},
2454 @b{z}, @b{p}, and @b{r}. When producing phrases, like
2455 @q{pi@`{u}@tie{}@b{f}}, the normal words (like @q{pi@`{u}}) should be
2456 done in a different font. The recommended font for this is bold and italic.
2457 @lilypond[verbatim,quote]
2465 layout (prepend-alist-chain 'font-encoding 'fetaText props) arg))
2467 (define-markup-command (text layout props arg)
2470 "Use a text font instead of music symbol or music alphabet font.
2472 @lilypond[verbatim,quote]
2485 (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
2488 (define-markup-command (italic layout props arg)
2491 "Use italic @code{font-shape} for @var{arg}.
2493 @lilypond[verbatim,quote]
2501 (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
2503 (define-markup-command (typewriter layout props arg)
2506 "Use @code{font-family} typewriter for @var{arg}.
2508 @lilypond[verbatim,quote]
2517 layout (prepend-alist-chain 'font-family 'typewriter props) arg))
2519 (define-markup-command (upright layout props arg)
2522 "Set @code{font-shape} to @code{upright}. This is the opposite
2525 @lilypond[verbatim,quote]
2539 layout (prepend-alist-chain 'font-shape 'upright props) arg))
2541 (define-markup-command (medium layout props arg)
2544 "Switch to medium font-series (in contrast to bold).
2546 @lilypond[verbatim,quote]
2559 (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
2562 (define-markup-command (normal-text layout props arg)
2565 "Set all font related properties (except the size) to get the default
2566 normal text font, no matter what font was used earlier.
2568 @lilypond[verbatim,quote]
2570 \\huge \\bold \\sans \\caps {
2582 (interpret-markup layout
2583 (cons '((font-family . roman) (font-shape . upright)
2584 (font-series . medium) (font-encoding . latin1))
2588 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2590 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2592 (define-markup-command (musicglyph layout props glyph-name)
2595 "@var{glyph-name} is converted to a musical symbol; for example,
2596 @code{\\musicglyph #\"accidentals.natural\"} selects the natural sign from
2597 the music font. See @ruser{The Feta font} for a complete listing of
2598 the possible glyphs.
2600 @lilypond[verbatim,quote]
2603 \\musicglyph #\"rests.2\"
2604 \\musicglyph #\"clefs.G_change\"
2607 (let* ((font (ly:paper-get-font layout
2608 (cons '((font-encoding . fetaMusic)
2612 (glyph (ly:font-get-glyph font glyph-name)))
2613 (if (null? (ly:stencil-expr glyph))
2614 (ly:warning (_ "Cannot find glyph ~a") glyph-name))
2618 (define-markup-command (doublesharp layout props)
2621 "Draw a double sharp symbol.
2623 @lilypond[verbatim,quote]
2628 (interpret-markup layout props (markup #:musicglyph (assoc-get 1 standard-alteration-glyph-name-alist ""))))
2630 (define-markup-command (sesquisharp layout props)
2633 "Draw a 3/2 sharp symbol.
2635 @lilypond[verbatim,quote]
2640 (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist ""))))
2642 (define-markup-command (sharp layout props)
2645 "Draw a sharp symbol.
2647 @lilypond[verbatim,quote]
2652 (interpret-markup layout props (markup #:musicglyph (assoc-get 1/2 standard-alteration-glyph-name-alist ""))))
2654 (define-markup-command (semisharp layout props)
2657 "Draw a semisharp symbol.
2659 @lilypond[verbatim,quote]
2664 (interpret-markup layout props (markup #:musicglyph (assoc-get 1/4 standard-alteration-glyph-name-alist ""))))
2666 (define-markup-command (natural layout props)
2669 "Draw a natural symbol.
2671 @lilypond[verbatim,quote]
2676 (interpret-markup layout props (markup #:musicglyph (assoc-get 0 standard-alteration-glyph-name-alist ""))))
2678 (define-markup-command (semiflat layout props)
2681 "Draw a semiflat symbol.
2683 @lilypond[verbatim,quote]
2688 (interpret-markup layout props (markup #:musicglyph (assoc-get -1/4 standard-alteration-glyph-name-alist ""))))
2690 (define-markup-command (flat layout props)
2693 "Draw a flat symbol.
2695 @lilypond[verbatim,quote]
2700 (interpret-markup layout props (markup #:musicglyph (assoc-get -1/2 standard-alteration-glyph-name-alist ""))))
2702 (define-markup-command (sesquiflat layout props)
2705 "Draw a 3/2 flat symbol.
2707 @lilypond[verbatim,quote]
2712 (interpret-markup layout props (markup #:musicglyph (assoc-get -3/4 standard-alteration-glyph-name-alist ""))))
2714 (define-markup-command (doubleflat layout props)
2717 "Draw a double flat symbol.
2719 @lilypond[verbatim,quote]
2724 (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist ""))))
2726 (define-markup-command (with-color layout props color arg)
2730 @cindex coloring text
2732 Draw @var{arg} in color specified by @var{color}.
2734 @lilypond[verbatim,quote]
2746 (let ((stil (interpret-markup layout props arg)))
2747 (ly:make-stencil (list 'color color (ly:stencil-expr stil))
2748 (ly:stencil-extent stil X)
2749 (ly:stencil-extent stil Y))))
2751 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2753 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2755 (define-markup-command (arrow-head layout props axis dir filled)
2756 (integer? ly:dir? boolean?)
2758 "Produce an arrow head in specified direction and axis.
2759 Use the filled head if @var{filled} is specified.
2760 @lilypond[verbatim,quote]
2763 \\general-align #Y #DOWN {
2764 \\arrow-head #Y #UP ##t
2765 \\arrow-head #Y #DOWN ##f
2767 \\arrow-head #X #RIGHT ##f
2768 \\arrow-head #X #LEFT ##f
2774 ((name (format #f "arrowheads.~a.~a~a"
2781 (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
2785 (define-markup-command (lookup layout props glyph-name)
2788 "Lookup a glyph by name.
2790 @lilypond[verbatim,quote]
2792 \\override #'(font-encoding . fetaBraces) {
2793 \\lookup #\"brace200\"
2796 \\lookup #\"brace180\"
2800 (ly:font-get-glyph (ly:paper-get-font layout props)
2803 (define-markup-command (char layout props num)
2806 "Produce a single character. Characters encoded in hexadecimal
2807 format require the prefix @code{#x}.
2809 @lilypond[verbatim,quote]
2811 \\char #65 \\char ##x00a9
2814 (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num)))
2816 (define number->mark-letter-vector (make-vector 25 #\A))
2821 (if (= i (- (char->integer #\I) (char->integer #\A)))
2823 (vector-set! number->mark-letter-vector j
2824 (integer->char (+ i (char->integer #\A)))))
2826 (define number->mark-alphabet-vector (list->vector
2827 (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
2829 (define (number->markletter-string vec n)
2830 "Double letters for big marks."
2831 (let* ((lst (vector-length vec)))
2834 (string-append (number->markletter-string vec (1- (quotient n lst)))
2835 (number->markletter-string vec (remainder n lst)))
2836 (make-string 1 (vector-ref vec n)))))
2838 (define-markup-command (markletter layout props num)
2841 "Make a markup letter for @var{num}. The letters start with A to@tie{}Z
2842 (skipping letter@tie{}I), and continue with double letters.
2844 @lilypond[verbatim,quote]
2851 (ly:text-interface::interpret-markup layout props
2852 (number->markletter-string number->mark-letter-vector num)))
2854 (define-markup-command (markalphabet layout props num)
2857 "Make a markup letter for @var{num}. The letters start with A to@tie{}Z
2858 and continue with double letters.
2860 @lilypond[verbatim,quote]
2867 (ly:text-interface::interpret-markup layout props
2868 (number->markletter-string number->mark-alphabet-vector num)))
2870 (define-public (horizontal-slash-interval num forward number-interval mag)
2872 (cond ;((= num 6) (interval-widen number-interval (* mag 0.5)))
2873 ;((= num 5) (interval-widen number-interval (* mag 0.5)))
2874 (else (interval-widen number-interval (* mag 0.25))))
2875 (cond ((= num 6) (interval-widen number-interval (* mag 0.5)))
2876 ;((= num 5) (interval-widen number-interval (* mag 0.5)))
2877 (else (interval-widen number-interval (* mag 0.25))))
2880 (define-public (adjust-slash-stencil num forward stencil mag)
2883 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
2885 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2))))
2887 ;(ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.07))))
2889 ; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
2892 (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.15))))
2894 ; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15))))
2899 (define (slashed-digit-internal layout props num forward font-size thickness)
2900 (let* ((mag (magstep font-size))
2902 (ly:output-def-lookup layout 'line-thickness)
2904 ; backward slashes might use slope and point in the other direction!
2905 (dy (* mag (if forward 0.4 -0.4)))
2906 (number-stencil (interpret-markup layout
2907 (prepend-alist-chain 'font-encoding 'fetaText props)
2908 (number->string num)))
2909 (num-x (horizontal-slash-interval num forward (ly:stencil-extent number-stencil X) mag))
2910 (center (interval-center (ly:stencil-extent number-stencil Y)))
2911 ; Use the real extents of the slash, not the whole number, because we
2912 ; might translate the slash later on!
2913 (num-y (interval-widen (cons center center) (abs dy)))
2914 (is-sane (and (interval-sane? num-x) (interval-sane? num-y)))
2915 (slash-stencil (if is-sane
2916 (make-line-stencil thickness
2917 (car num-x) (- (interval-center num-y) dy)
2918 (cdr num-x) (+ (interval-center num-y) dy))
2920 (if (ly:stencil? slash-stencil)
2922 ; for some numbers we need to shift the slash/backslash up or down to make
2923 ; the slashed digit look better
2924 (set! slash-stencil (adjust-slash-stencil num forward slash-stencil mag))
2925 (set! number-stencil
2926 (ly:stencil-add number-stencil slash-stencil)))
2927 (ly:warning "Unable to create slashed digit ~a" num))
2931 (define-markup-command (slashed-digit layout props num)
2934 #:properties ((font-size 0)
2937 @cindex slashed digits
2939 A feta number, with slash. This is for use in the context of
2940 figured bass notation.
2941 @lilypond[verbatim,quote]
2945 \\override #'(thickness . 3)
2949 (slashed-digit-internal layout props num #t font-size thickness))
2951 (define-markup-command (backslashed-digit layout props num)
2954 #:properties ((font-size 0)
2957 @cindex backslashed digits
2959 A feta number, with backslash. This is for use in the context of
2960 figured bass notation.
2961 @lilypond[verbatim,quote]
2963 \\backslashed-digit #5
2965 \\override #'(thickness . 3)
2966 \\backslashed-digit #7
2969 (slashed-digit-internal layout props num #f font-size thickness))
2972 (define eyeglassespath
2973 '((moveto 0.42 0.77)
2974 (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
2975 (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
2976 (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
2977 (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
2980 (rcurveto 0 0.304 -0.246 0.55 -0.55 0.55)
2981 (rcurveto -0.304 0 -0.55 -0.246 -0.55 -0.55)
2982 (rcurveto 0 -0.304 0.246 -0.55 0.55 -0.55)
2983 (rcurveto 0.304 0 0.55 0.246 0.55 0.55)
2985 (moveto 1.025 0.935)
2986 (rcurveto 0 0.182 -0.148 0.33 -0.33 0.33)
2987 (rcurveto -0.182 0 -0.33 -0.148 -0.33 -0.33)
2990 (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)
2993 (rcurveto 0.132 0.286 0.55 0.44 0.385 -0.33)))
2995 (define-markup-command (eyeglasses layout props)
2998 "Prints out eyeglasses, indicating strongly to look at the conductor.
2999 @lilypond[verbatim,quote]
3000 \\markup { \\eyeglasses }
3002 (interpret-markup layout props
3003 (make-override-markup '(line-cap-style . butt)
3004 (make-path-markup 0.15 eyeglassespath))))
3006 (define-markup-command (left-brace layout props size)
3010 A feta brace in point size @var{size}.
3012 @lilypond[verbatim,quote]
3019 (let* ((font (ly:paper-get-font layout
3020 (cons '((font-encoding . fetaBraces)
3023 (glyph-count (1- (ly:otf-glyph-count font)))
3024 (scale (ly:output-def-lookup layout 'output-scale))
3025 (scaled-size (/ (ly:pt size) scale))
3027 (ly:font-get-glyph font (string-append "brace"
3028 (number->string n)))))
3029 (get-y-from-brace (lambda (brace)
3031 (ly:stencil-extent (glyph brace) Y))))
3032 (find-brace (binary-search 0 glyph-count get-y-from-brace scaled-size))
3033 (glyph-found (glyph find-brace)))
3035 (if (or (null? (ly:stencil-expr glyph-found))
3036 (< scaled-size (interval-length (ly:stencil-extent (glyph 0) Y)))
3037 (> scaled-size (interval-length
3038 (ly:stencil-extent (glyph glyph-count) Y))))
3040 (ly:warning (_ "no brace found for point size ~S ") size)
3041 (ly:warning (_ "defaulting to ~S pt")
3042 (/ (* scale (interval-length
3043 (ly:stencil-extent glyph-found Y)))
3047 (define-markup-command (right-brace layout props size)
3051 A feta brace in point size @var{size}, rotated 180 degrees.
3053 @lilypond[verbatim,quote]
3060 (interpret-markup layout props (markup #:rotate 180 #:left-brace size)))
3062 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3063 ;; the note command.
3064 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3066 ;; TODO: better syntax.
3068 (define-markup-command (note-by-number layout props log dot-count dir)
3069 (number? number? number?)
3071 #:properties ((font-size 0)
3074 @cindex notes within text by log and dot-count
3076 Construct a note symbol, with stem. By using fractional values for
3077 @var{dir}, longer or shorter stems can be obtained.
3079 @lilypond[verbatim,quote]
3081 \\note-by-number #3 #0 #DOWN
3083 \\note-by-number #1 #2 #0.8
3086 (define (get-glyph-name-candidates dir log style)
3087 (map (lambda (dir-name)
3088 (format #f "noteheads.~a~a" dir-name
3089 (if (and (symbol? style)
3090 (not (equal? 'default style)))
3091 (select-head-glyph style (min log 2))
3093 (list (if (= dir UP) "u" "d")
3096 (define (get-glyph-name font cands)
3099 (if (ly:stencil-empty? (ly:font-get-glyph font (car cands)))
3100 (get-glyph-name font (cdr cands))
3103 (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
3105 (size-factor (magstep font-size))
3106 (stem-length (* size-factor (max 3 (- log 1))))
3108 (let ((result (get-glyph-name font (get-glyph-name-candidates
3109 (sign dir) log style))))
3110 (if (string-null? result)
3111 ;; If no glyph name can be found, select default heads. Though
3112 ;; this usually means an unsupported style has been chosen, it
3113 ;; also prevents unrelated 'style settings from other grobs
3114 ;; (e.g., TextSpanner and TimeSignature) leaking into markup.
3115 (get-glyph-name font (get-glyph-name-candidates
3116 (sign dir) log 'default))
3118 (head-glyph (ly:font-get-glyph font head-glyph-name))
3119 (attach-indices (ly:note-head::stem-attachment font head-glyph-name))
3120 (stem-thickness (* size-factor 0.13))
3121 (stemy (* dir stem-length))
3122 (attach-off (cons (interval-index
3123 (ly:stencil-extent head-glyph X)
3124 (* (sign dir) (car attach-indices)))
3125 (* (sign dir) ; fixme, this is inconsistent between X & Y.
3127 (ly:stencil-extent head-glyph Y)
3128 (cdr attach-indices)))))
3129 (stem-glyph (and (> log 0)
3130 (ly:round-filled-box
3131 (ordered-cons (car attach-off)
3133 (* (- (sign dir)) stem-thickness)))
3134 (cons (min stemy (cdr attach-off))
3135 (max stemy (cdr attach-off)))
3136 (/ stem-thickness 3))))
3138 (dot (ly:font-get-glyph font "dots.dot"))
3139 (dotwid (interval-length (ly:stencil-extent dot X)))
3140 (dots (and (> dot-count 0)
3141 (apply ly:stencil-add
3143 (ly:stencil-translate-axis
3144 dot (* 2 x dotwid) X))
3145 (iota dot-count)))))
3146 (flaggl (and (> log 2)
3147 (ly:stencil-translate
3148 (ly:font-get-glyph font
3149 (string-append "flags."
3150 (if (> dir 0) "u" "d")
3151 (number->string log)))
3152 (cons (+ (car attach-off) (if (< dir 0)
3156 ;; If there is a flag on an upstem and the stem is short, move the dots
3157 ;; to avoid the flag. 16th notes get a special case because their flags
3158 ;; hang lower than any other flags.
3159 (if (and dots (> dir 0) (> log 2)
3160 (or (< dir 1.15) (and (= log 4) (< dir 1.3))))
3161 (set! dots (ly:stencil-translate-axis dots 0.5 X)))
3163 (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
3164 (if (ly:stencil? stem-glyph)
3165 (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
3166 (set! stem-glyph head-glyph))
3167 (if (ly:stencil? dots)
3170 (ly:stencil-translate-axis
3172 (+ (cdr (ly:stencil-extent head-glyph X)) dotwid)
3178 (let ((divisor (log 2)))
3179 (lambda (z) (inexact->exact (/ (log z) divisor)))))
3181 (define (parse-simple-duration duration-string)
3182 "Parse the `duration-string', e.g. ''4..'' or ''breve.'',
3183 and return a (log dots) list."
3184 (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)")
3186 (if (and match (string=? duration-string (match:substring match 0)))
3187 (let ((len (match:substring match 1))
3188 (dots (match:substring match 2)))
3189 (list (cond ((string=? len "breve") -1)
3190 ((string=? len "longa") -2)
3191 ((string=? len "maxima") -3)
3192 (else (log2 (string->number len))))
3193 (if dots (string-length dots) 0)))
3194 (ly:error (_ "not a valid duration string: ~a") duration-string))))
3196 (define-markup-command (note layout props duration dir)
3199 #:properties (note-by-number-markup)
3201 @cindex notes within text by string
3203 This produces a note with a stem pointing in @var{dir} direction, with
3204 the @var{duration} for the note head type and augmentation dots. For
3205 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
3206 a shortened down stem.
3208 @lilypond[verbatim,quote]
3210 \\override #'(style . cross) {
3214 \\note #\"breve\" #0
3217 (let ((parsed (parse-simple-duration duration)))
3218 (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
3220 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3222 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3224 (define-markup-command (lower layout props amount arg)
3228 @cindex lowering text
3230 Lower @var{arg} by the distance @var{amount}.
3231 A negative @var{amount} indicates raising; see also @code{\\raise}.
3233 @lilypond[verbatim,quote]
3241 (ly:stencil-translate-axis (interpret-markup layout props arg)
3244 (define-markup-command (translate-scaled layout props offset arg)
3245 (number-pair? markup?)
3247 #:properties ((font-size 0))
3249 @cindex translating text
3250 @cindex scaling text
3252 Translate @var{arg} by @var{offset}, scaling the offset by the
3255 @lilypond[verbatim,quote]
3258 * \\translate #'(2 . 3) translate
3260 * \\translate-scaled #'(2 . 3) translate-scaled
3264 (let* ((factor (magstep font-size))
3265 (scaled (cons (* factor (car offset))
3266 (* factor (cdr offset)))))
3267 (ly:stencil-translate (interpret-markup layout props arg)
3270 (define-markup-command (raise layout props amount arg)
3274 @cindex raising text
3276 Raise @var{arg} by the distance @var{amount}.
3277 A negative @var{amount} indicates lowering, see also @code{\\lower}.
3279 The argument to @code{\\raise} is the vertical displacement amount,
3280 measured in (global) staff spaces. @code{\\raise} and @code{\\super}
3281 raise objects in relation to their surrounding markups.
3283 If the text object itself is positioned above or below the staff, then
3284 @code{\\raise} cannot be used to move it, since the mechanism that
3285 positions it next to the staff cancels any shift made with
3286 @code{\\raise}. For vertical positioning, use the @code{padding}
3287 and/or @code{extra-offset} properties.
3289 @lilypond[verbatim,quote]
3298 (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
3300 (define-markup-command (fraction layout props arg1 arg2)
3303 #:properties ((font-size 0))
3305 @cindex creating text fractions
3307 Make a fraction of two markups.
3308 @lilypond[verbatim,quote]
3314 (let* ((m1 (interpret-markup layout props arg1))
3315 (m2 (interpret-markup layout props arg2))
3316 (factor (magstep font-size))
3317 (boxdimen (cons (* factor -0.05) (* factor 0.05)))
3318 (padding (* factor 0.2))
3319 (baseline (* factor 0.6))
3320 (offset (* factor 0.75)))
3321 (set! m1 (ly:stencil-aligned-to m1 X CENTER))
3322 (set! m2 (ly:stencil-aligned-to m2 X CENTER))
3323 (let* ((x1 (ly:stencil-extent m1 X))
3324 (x2 (ly:stencil-extent m2 X))
3325 (line (ly:round-filled-box (interval-union x1 x2) boxdimen 0.0))
3326 ;; should stack mols separately, to maintain LINE on baseline
3327 (stack (stack-lines DOWN padding baseline (list m1 line m2))))
3329 (ly:stencil-aligned-to stack Y CENTER))
3331 (ly:stencil-aligned-to stack X LEFT))
3332 ;; should have EX dimension
3334 (ly:stencil-translate-axis stack offset Y))))
3336 (define-markup-command (normal-size-super layout props arg)
3339 #:properties ((baseline-skip))
3341 @cindex setting superscript in standard font size
3343 Set @var{arg} in superscript with a normal font size.
3345 @lilypond[verbatim,quote]
3348 \\normal-size-super {
3349 superscript in standard size
3353 (ly:stencil-translate-axis
3354 (interpret-markup layout props arg)
3355 (* 0.5 baseline-skip) Y))
3357 (define-markup-command (super layout props arg)
3360 #:properties ((font-size 0)
3363 @cindex superscript text
3365 Set @var{arg} in superscript.
3367 @lilypond[verbatim,quote]
3377 (ly:stencil-translate-axis
3380 (cons `((font-size . ,(- font-size 3))) props)
3382 (* 0.5 baseline-skip)
3385 (define-markup-command (translate layout props offset arg)
3386 (number-pair? markup?)
3389 @cindex translating text
3391 Translate @var{arg} relative to its surroundings. @var{offset}
3392 is a pair of numbers representing the displacement in the X and Y axis.
3394 @lilypond[verbatim,quote]
3397 \\translate #'(2 . 3)
3398 \\line { translated two spaces right, three up }
3401 (ly:stencil-translate (interpret-markup layout props arg)
3404 (define-markup-command (sub layout props arg)
3407 #:properties ((font-size 0)
3410 @cindex subscript text
3412 Set @var{arg} in subscript.
3414 @lilypond[verbatim,quote]
3425 (ly:stencil-translate-axis
3428 (cons `((font-size . ,(- font-size 3))) props)
3430 (* -0.5 baseline-skip)
3433 (define-markup-command (normal-size-sub layout props arg)
3436 #:properties ((baseline-skip))
3438 @cindex setting subscript in standard font size
3440 Set @var{arg} in subscript with a normal font size.
3442 @lilypond[verbatim,quote]
3446 subscript in standard size
3450 (ly:stencil-translate-axis
3451 (interpret-markup layout props arg)
3452 (* -0.5 baseline-skip)
3455 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3457 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3459 (define-markup-command (hbracket layout props arg)
3463 @cindex placing horizontal brackets around text
3465 Draw horizontal brackets around @var{arg}.
3467 @lilypond[verbatim,quote]
3476 (let ((th 0.1) ;; todo: take from GROB.
3477 (m (interpret-markup layout props arg)))
3478 (bracketify-stencil m X th (* 2.5 th) th)))
3480 (define-markup-command (bracket layout props arg)
3484 @cindex placing vertical brackets around text
3486 Draw vertical brackets around @var{arg}.
3488 @lilypond[verbatim,quote]
3495 (let ((th 0.1) ;; todo: take from GROB.
3496 (m (interpret-markup layout props arg)))
3497 (bracketify-stencil m Y th (* 2.5 th) th)))
3499 (define-markup-command (parenthesize layout props arg)
3502 #:properties ((angularity 0)
3508 @cindex placing parentheses around text
3510 Draw parentheses around @var{arg}. This is useful for parenthesizing
3511 a column containing several lines of text.
3513 @lilypond[verbatim,quote]
3522 \\override #'(angularity . 2) {
3533 (let* ((markup (interpret-markup layout props arg))
3534 (scaled-width (* size width))
3536 (* (chain-assoc-get 'line-thickness props 0.1)
3539 (min (* size 0.5 scaled-thickness)
3540 (* (/ 4 3.0) scaled-width)))
3541 (padding (chain-assoc-get 'padding props half-thickness)))
3542 (parenthesize-stencil
3543 markup half-thickness scaled-width angularity padding)))
3546 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3547 ;; Delayed markup evaluation
3548 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3550 (define-markup-command (page-ref layout props label gauge default)
3551 (symbol? markup? markup?)
3554 @cindex referencing page numbers in text
3556 Reference to a page number. @var{label} is the label set on the referenced
3557 page (using the @code{\\label} command), @var{gauge} a markup used to estimate
3558 the maximum width of the page number, and @var{default} the value to display
3559 when @var{label} is not found."
3560 (let* ((gauge-stencil (interpret-markup layout props gauge))
3561 (x-ext (ly:stencil-extent gauge-stencil X))
3562 (y-ext (ly:stencil-extent gauge-stencil Y)))
3564 `(delay-stencil-evaluation
3565 ,(delay (ly:stencil-expr
3566 (let* ((table (ly:output-def-lookup layout 'label-page-table))
3567 (page-number (if (list? table)
3568 (assoc-get label table)
3570 (page-markup (if page-number (format #f "~a" page-number) default))
3571 (page-stencil (interpret-markup layout props page-markup))
3572 (gap (- (interval-length x-ext)
3573 (interval-length (ly:stencil-extent page-stencil X)))))
3574 (interpret-markup layout props
3575 (markup #:concat (#:hspace gap page-markup)))))))
3579 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3581 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3583 (define-markup-command (scale layout props factor-pair arg)
3584 (number-pair? markup?)
3587 @cindex scaling markup
3588 @cindex mirroring markup
3590 Scale @var{arg}. @var{factor-pair} is a pair of numbers
3591 representing the scaling-factor in the X and Y axes.
3592 Negative values may be used to produce mirror images.
3594 @lilypond[verbatim,quote]
3604 (let ((stil (interpret-markup layout props arg))
3605 (sx (car factor-pair))
3606 (sy (cdr factor-pair)))
3607 (ly:stencil-scale stil sx sy)))
3609 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3611 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3613 (define-markup-command (pattern layout props count axis space pattern)
3614 (integer? integer? number? markup?)
3617 Prints @var{count} times a @var{pattern} markup.
3618 Patterns are spaced apart by @var{space}.
3619 Patterns are distributed on @var{axis}.
3621 @lilypond[verbatim, quote]
3623 \"Horizontally repeated :\"
3624 \\pattern #7 #X #2 \\flat
3626 \"Vertically repeated :\"
3627 \\pattern #3 #Y #0.5 \\flat
3630 (let ((pattern-width (interval-length
3631 (ly:stencil-extent (interpret-markup layout props pattern) X)))
3632 (new-props (prepend-alist-chain 'word-space 0 (prepend-alist-chain 'baseline-skip 0 props))))
3633 (let loop ((i (1- count)) (patterns (markup)))
3639 (markup patterns pattern)
3640 (markup #:column (patterns pattern))))
3643 (markup patterns pattern #:hspace space)
3644 (markup #:column (patterns pattern #:vspace space))))))))
3646 (define-markup-command (fill-with-pattern layout props space dir pattern left right)
3647 (number? ly:dir? markup? markup? markup?)
3649 #:properties ((word-space)
3652 Put @var{left} and @var{right} in a horizontal line of width @code{line-width}
3653 with a line of markups @var{pattern} in between.
3654 Patterns are spaced apart by @var{space}.
3655 Patterns are aligned to the @var{dir} markup.
3657 @lilypond[verbatim, quote]
3660 \\fill-with-pattern #1 #RIGHT . first right
3661 \\fill-with-pattern #1 #RIGHT . second right
3663 \"center-aligned :\"
3664 \\fill-with-pattern #1.5 #CENTER - left right
3667 \\override #'(line-width . 50)
3668 \\fill-with-pattern #2 #LEFT : left first
3669 \\override #'(line-width . 50)
3670 \\fill-with-pattern #2 #LEFT : left second
3673 (let* ((pattern-x-extent (ly:stencil-extent (interpret-markup layout props pattern) X))
3674 (pattern-width (interval-length pattern-x-extent))
3675 (left-width (interval-length (ly:stencil-extent (interpret-markup layout props left) X)))
3676 (right-width (interval-length (ly:stencil-extent (interpret-markup layout props right) X)))
3677 (middle-width (max 0 (- line-width (+ (+ left-width right-width) (* word-space 2)))))
3678 (period (+ space pattern-width))
3679 (count (truncate (/ (- middle-width pattern-width) period)))
3680 (x-offset (+ (* (- (- middle-width (* count period)) pattern-width) (/ (1+ dir) 2)) (abs (car pattern-x-extent)))))
3681 (interpret-markup layout props
3683 #:with-dimensions (cons 0 middle-width) '(0 . 0)
3684 #:translate (cons x-offset 0)
3685 #:pattern (1+ count) X space pattern
3688 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3690 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3692 (define-markup-command (replace layout props replacements arg)
3696 Used to automatically replace a string by another in the markup @var{arg}.
3697 Each pair of the alist @var{replacements} specifies what should be replaced.
3698 The @code{key} is the string to be replaced by the @code{value} string.
3700 @lilypond[verbatim, quote]
3701 \\markup \\replace #'((\"thx\" . \"Thanks!\")) thx
3705 (internal-add-text-replacements
3710 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3711 ;; Markup list commands
3712 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3714 (define-public (space-lines baseline stils)
3715 (let space-stil ((stils stils)
3719 (let* ((stil (car stils))
3720 (dy-top (max (- (/ baseline 1.5)
3721 (interval-bound (ly:stencil-extent stil Y) UP))
3723 (dy-bottom (max (+ (/ baseline 3.0)
3724 (interval-bound (ly:stencil-extent stil Y) DOWN))
3726 (new-stil (ly:make-stencil
3727 (ly:stencil-expr stil)
3728 (ly:stencil-extent stil X)
3729 (cons (- (interval-bound (ly:stencil-extent stil Y) DOWN)
3731 (+ (interval-bound (ly:stencil-extent stil Y) UP)
3733 (space-stil (cdr stils) (cons new-stil result))))))
3735 (define-markup-list-command (justified-lines layout props args)
3737 #:properties ((baseline-skip)
3738 wordwrap-internal-markup-list)
3740 @cindex justifying lines of text
3742 Like @code{\\justify}, but return a list of lines instead of a single markup.
3743 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width;
3744 @var{X}@tie{}is the number of staff spaces."
3745 (space-lines baseline-skip
3746 (interpret-markup-list layout props
3747 (make-wordwrap-internal-markup-list #t args))))
3749 (define-markup-list-command (wordwrap-lines layout props args)
3751 #:properties ((baseline-skip)
3752 wordwrap-internal-markup-list)
3753 "Like @code{\\wordwrap}, but return a list of lines instead of a single markup.
3754 Use @code{\\override-lines #'(line-width . @var{X})} to set the line width,
3755 where @var{X} is the number of staff spaces."
3756 (space-lines baseline-skip
3757 (interpret-markup-list layout props
3758 (make-wordwrap-internal-markup-list #f args))))
3760 (define-markup-list-command (column-lines layout props args)
3762 #:properties ((baseline-skip))
3763 "Like @code{\\column}, but return a list of lines instead of a single markup.
3764 @code{baseline-skip} determines the space between each markup in @var{args}."
3765 (space-lines baseline-skip
3766 (interpret-markup-list layout props args)))
3768 (define-markup-list-command (override-lines layout props new-prop args)
3769 (pair? markup-list?)
3770 "Like @code{\\override}, for markup lists."
3771 (interpret-markup-list layout (cons (list new-prop) props) args))