1 ;;;; define-markup-commands.scm -- markup commands
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
10 ;;; * each markup function should have a doc string with
11 ;; syntax, description and example.
13 (use-modules (ice-9 regex))
15 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
17 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
19 (define-public empty-stencil (ly:make-stencil '() '(1 . -1) '(1 . -1)))
20 (define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 (def-markup-command (draw-circle layout props radius thickness fill)
28 (number? number? boolean?)
29 "A circle of radius @var{radius}, thickness @var{thickness} and
31 (make-circle-stencil radius thickness fill))
33 (def-markup-command (triangle layout props filled) (boolean?)
34 "A triangle, filled or not"
36 ((th (chain-assoc-get 'thickness props 0.1))
37 (size (chain-assoc-get 'font-size props 0))
40 (chain-assoc-get 'baseline-skip props 2))))
54 (def-markup-command (circle layout props arg) (markup?)
55 "Draw a circle around @var{arg}. Use @code{thickness},
56 @code{circle-padding} and @code{font-size} properties to determine line
57 thickness and padding around the markup."
58 (let* ((th (chain-assoc-get 'thickness props 0.1))
59 (size (chain-assoc-get 'font-size props 0))
62 (chain-assoc-get 'circle-padding props 0.2)))
63 (m (interpret-markup layout props arg)))
64 (circle-stencil m th pad)))
66 (def-markup-command (with-url layout props url arg) (string? markup?)
67 "Add a link to URL @var{url} around @var{arg}. This only works in
69 (let* ((stil (interpret-markup layout props arg))
70 (xextent (ly:stencil-extent stil X))
71 (yextent (ly:stencil-extent stil Y))
72 (old-expr (ly:stencil-expr stil))
73 (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent))))
74 (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil)))
77 (def-markup-command (beam layout props width slope thickness)
78 (number? number? number?)
79 "Create a beam with the specified parameters."
80 (let* ((y (* slope width))
81 (yext (cons (min 0 y) (max 0 y)))
82 (half (/ thickness 2)))
87 width (+ (* width slope) (/ thickness -2))
88 width (+ (* width slope) (/ thickness 2))
90 ,(ly:output-def-lookup layout 'blotdiameter)
93 (cons (+ (- half) (car yext))
94 (+ half (cdr yext))))))
96 (def-markup-command (box layout props arg) (markup?)
97 "Draw a box round @var{arg}. Looks at @code{thickness},
98 @code{box-padding} and @code{font-size} properties to determine line
99 thickness and padding around the markup."
100 (let* ((th (chain-assoc-get 'thickness props 0.1))
101 (size (chain-assoc-get 'font-size props 0))
102 (pad (* (magstep size)
103 (chain-assoc-get 'box-padding props 0.2)))
104 (m (interpret-markup layout props arg)))
105 (box-stencil m th pad)))
107 (def-markup-command (filled-box layout props xext yext blot)
108 (number-pair? number-pair? number?)
109 "Draw a box with rounded corners of dimensions @var{xext} and @var{yext}."
113 (def-markup-command (whiteout layout props arg) (markup?)
114 "Provide a white underground for @var{arg}"
115 (let* ((stil (interpret-markup layout props
116 (make-with-color-markup black arg)))
118 (interpret-markup layout props
119 (make-with-color-markup
121 (make-filled-box-markup
122 (ly:stencil-extent stil X)
123 (ly:stencil-extent stil Y)
126 (ly:stencil-add white stil)))
128 (def-markup-command (pad-markup layout props padding arg) (number? markup?)
129 "Add space around a markup object."
132 ((stil (interpret-markup layout props arg))
133 (xext (ly:stencil-extent stil X))
134 (yext (ly:stencil-extent stil Y)))
137 (ly:stencil-expr stil)
138 (interval-widen xext padding)
139 (interval-widen yext padding))))
141 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
145 ;;FIXME: is this working?
146 (def-markup-command (strut layout props) ()
147 "Create a box of the same height as the space in the current font."
148 (let ((m (Text_interface::interpret_markup layout props " ")))
149 (ly:make-stencil (ly:stencil-expr m)
151 (ly:stencil-extent m X)
155 ;; todo: fix negative space
156 (def-markup-command (hspace layout props amount) (number?)
157 "This produces a invisible object taking horizontal space.
159 \\markup @{ A \\hspace #2.0 B @}
161 will put extra space between A and B, on top of the space that is
162 normally inserted before elements on a line.
165 (ly:make-stencil "" (cons 0 amount) '(-1 . 1))
166 (ly:make-stencil "" (cons amount amount) '(-1 . 1))))
169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
170 ;; importing graphics.
171 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
173 (def-markup-command (stencil layout props stil) (ly:stencil?)
178 (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)"))
180 (define (get-postscript-bbox string)
181 "Extract the bbox from STRING, or return #f if not present."
183 ((match (regexp-exec bbox-regexp string)))
187 (string->number (match:substring match x)))
192 (def-markup-command (epsfile layout props file-name) (string?)
193 "Inline an EPS image. The image is scaled such that 10 PS units is
196 (if (ly:get-option 'safe)
197 (interpret-markup layout props "not allowed in safe")
199 ((contents (ly:gulp-file file-name))
200 (bbox (get-postscript-bbox contents))
203 (map (lambda (x) (/ x 10)) bbox)
205 (ly:warning (_ "can't find bounding box of `~a'")
220 (format "\n%%BeginDocument: ~a\n" file-name)
225 (cons (list-ref scaled-bbox 0) (list-ref scaled-bbox 2))
226 (cons (list-ref scaled-bbox 1) (list-ref scaled-bbox 3)))
228 (ly:make-stencil "" '(0 . 0) '(0 . 0))))))
231 (def-markup-command (postscript layout props str) (string?)
232 "This inserts @var{str} directly into the output as a PostScript
233 command string. Due to technicalities of the output backends,
234 different scales should be used for the @TeX{} and PostScript backend,
235 selected with @code{-f}.
238 For the TeX backend, the following string prints a rotated text
243 0 0 moveto /ecrm10 findfont
244 1.75 scalefont setfont 90 rotate (hello) show
248 The magical constant 1.75 scales from LilyPond units (staff spaces) to
251 For the postscript backend, use the following
254 gsave /ecrm10 findfont
255 10.0 output-scale div
256 scalefont setfont 90 rotate (hello) show grestore
261 (list 'embedded-ps str)
265 (def-markup-command (score layout props score) (ly:score?)
266 "Inline an image of music."
267 (let* ((output (ly:score-embedded-format score layout)))
269 (if (ly:music-output? output)
270 (ly:paper-system-stencil
271 (vector-ref (ly:paper-score-paper-systems output) 0))
273 (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?"))
276 (def-markup-command (null layout props) ()
277 "An empty markup with extents of a single point"
281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
283 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
285 (def-markup-command (simple layout props str) (string?)
286 "A simple text string; @code{\\markup @{ foo @}} is equivalent with
287 @code{\\markup @{ \\simple #\"foo\" @}}."
288 (interpret-markup layout props str))
291 ;; TODO: use font recoding.
293 ;; (map make-word-markup (string-tokenize str)))))
295 (define-public empty-markup
296 (make-simple-markup ""))
298 ;; helper for justifying lines.
299 (define (get-fill-space word-count line-width text-widths)
300 "Calculate the necessary paddings between each two adjacent texts.
301 The lengths of all texts are stored in @var{text-widths}.
302 The normal formula for the padding between texts a and b is:
303 padding = line-width/(word-count - 1) - (length(a) + length(b))/2
304 The first and last padding have to be calculated specially using the
305 whole length of the first or last text.
306 Return a list of paddings.
309 ((null? text-widths) '())
311 ;; special case first padding
312 ((= (length text-widths) word-count)
314 (- (- (/ line-width (1- word-count)) (car text-widths))
315 (/ (car (cdr text-widths)) 2))
316 (get-fill-space word-count line-width (cdr text-widths))))
317 ;; special case last padding
318 ((= (length text-widths) 2)
319 (list (- (/ line-width (1- word-count))
320 (+ (/ (car text-widths) 2) (car (cdr text-widths)))) 0))
323 (- (/ line-width (1- word-count))
324 (/ (+ (car text-widths) (car (cdr text-widths))) 2))
325 (get-fill-space word-count line-width (cdr text-widths))))))
327 (def-markup-command (fill-line layout props markups)
329 "Put @var{markups} in a horizontal line of width @var{line-width}.
330 The markups are spaced/flushed to fill the entire line.
331 If there are no arguments, return an empty stencil."
333 (let* ((orig-stencils
334 (map (lambda (x) (interpret-markup layout props x))
338 (if (ly:stencil-empty? stc)
340 stc)) orig-stencils))
343 (if (ly:stencil-empty? stc)
345 (interval-length (ly:stencil-extent stc X))))
347 (text-width (apply + text-widths))
348 (text-dir (chain-assoc-get 'text-direction props RIGHT))
349 (word-count (length stencils))
350 (word-space (chain-assoc-get 'word-space props))
351 (line-width (chain-assoc-get 'linewidth props))
356 (/ (- line-width text-width) 2)
357 (/ (- line-width text-width) 2)))
360 (- line-width text-width)))
362 (get-fill-space word-count line-width text-widths))))
370 (line-stencils (if (= word-count 1)
377 (if (= text-dir LEFT)
378 (set! line-stencils (reverse line-stencils)))
380 (if (null? (remove ly:stencil-empty? orig-stencils))
382 (stack-stencils-padding-list X
383 RIGHT fill-space-normal line-stencils))))
385 (def-markup-command (line layout props args) (markup-list?)
386 "Put @var{args} in a horizontal line. The property @code{word-space}
387 determines the space between each markup in @var{args}."
389 ((stencils (map (lambda (m) (interpret-markup layout props m)) args))
390 (space (chain-assoc-get 'word-space props))
391 (text-dir (chain-assoc-get 'text-direction props RIGHT))
395 (if (= text-dir LEFT)
396 (set! stencils (reverse stencils)))
401 (remove ly:stencil-empty? stencils))))
404 (define (wordwrap-stencils stencils
405 justify base-space line-width text-dir)
407 "Perform simple wordwrap, return stencil of each line."
409 (define space (if justify
411 ;; justify only stretches lines.
415 (define (take-list width space stencils
416 accumulator accumulated-width)
417 "Return (head-list . tail) pair, with head-list fitting into width"
419 (cons accumulator stencils)
421 ((first (car stencils))
422 (first-wid (cdr (ly:stencil-extent (car stencils) X)))
423 (newwid (+ space first-wid accumulated-width))
427 (or (null? accumulator)
430 (take-list width space
432 (cons first accumulator)
434 (cons accumulator stencils))
442 ((line-break (take-list line-width space todo
444 (line-stencils (car line-break))
445 (space-left (- line-width (apply + (map (lambda (x) (cdr (ly:stencil-extent x X)))
448 (line-word-space (cond
449 ((not justify) space)
451 ;; don't stretch last line of paragraph.
452 ;; hmmm . bug - will overstretch the last line in some case.
453 ((null? (cdr line-break))
455 ((null? line-stencils) 0.0)
456 ((null? (cdr line-stencils)) 0.0)
457 (else (/ space-left (1- (length line-stencils))))))
459 (line (stack-stencil-line
461 (if (= text-dir RIGHT)
462 (reverse line-stencils)
465 (if (pair? (cdr line-break))
466 (loop (cons line lines)
470 (if (= text-dir LEFT)
472 (ly:stencil-translate-axis line
473 (- line-width (interval-end (ly:stencil-extent line X)))
475 (reverse (cons line lines))
482 (define (wordwrap-markups layout props args justify)
484 ((baseline-skip (chain-assoc-get 'baseline-skip props))
485 (line-width (chain-assoc-get 'linewidth props))
486 (word-space (chain-assoc-get 'word-space props))
487 (text-dir (chain-assoc-get 'text-direction props RIGHT))
488 (lines (wordwrap-stencils
489 (remove ly:stencil-empty?
490 (map (lambda (m) (interpret-markup layout props m)) args))
491 justify word-space line-width
495 (stack-lines DOWN 0.0 baseline-skip lines)))
497 (def-markup-command (justify layout props args) (markup-list?)
498 "Like wordwrap, but with lines stretched to justify the margins.
499 Use @code{\\override #'(linewidth . X)} to set linewidth, where X
500 is the number of staff spaces."
502 (wordwrap-markups layout props args #t))
504 (def-markup-command (wordwrap layout props args) (markup-list?)
505 "Simple wordwrap. Use @code{\\override #'(linewidth . X)} to set
506 linewidth, where X is the number of staff spaces."
508 (wordwrap-markups layout props args #f))
510 (define (wordwrap-string layout props justify arg)
512 ((baseline-skip (chain-assoc-get 'baseline-skip props))
513 (line-width (chain-assoc-get 'linewidth props))
514 (word-space (chain-assoc-get 'word-space props))
515 (para-strings (regexp-split arg "\n[ \t\n]*\n[ \t\n]*"))
517 (text-dir (chain-assoc-get 'text-direction props RIGHT))
518 (list-para-words (map (lambda (str)
519 (regexp-split str "[ \t\n]+"))
521 (para-lines (map (lambda (words)
525 ly:stencil-empty? (map
527 (interpret-markup layout props x))
529 (lines (wordwrap-stencils stencils
538 (stack-lines DOWN 0.0 baseline-skip (apply append para-lines))))
541 (def-markup-command (wordwrap-string layout props arg) (string?)
542 "Wordwrap a string. Paragraphs may be separated with double newlines"
543 (wordwrap-string layout props #f arg))
545 (def-markup-command (justify-string layout props arg) (string?)
546 "Justify a string. Paragraphs may be separated with double newlines"
547 (wordwrap-string layout props #t arg))
550 (def-markup-command (wordwrap-field layout props symbol) (symbol?)
551 (let* ((m (chain-assoc-get symbol props)))
553 (interpret-markup layout props
554 (list wordwrap-string-markup m))
555 (ly:make-stencil '() '(1 . -1) '(1 . -1)))))
557 (def-markup-command (justify-field layout props symbol) (symbol?)
558 (let* ((m (chain-assoc-get symbol props)))
560 (interpret-markup layout props
561 (list justify-string-markup m))
562 (ly:make-stencil '() '(1 . -1) '(1 . -1)))))
566 (def-markup-command (combine layout props m1 m2) (markup? markup?)
567 "Print two markups on top of each other."
568 (let* ((s1 (interpret-markup layout props m1))
569 (s2 (interpret-markup layout props m2)))
570 (ly:stencil-add s1 s2)))
573 ;; TODO: should extract baseline-skip from each argument somehow..
575 (def-markup-command (column layout props args) (markup-list?)
576 "Stack the markups in @var{args} vertically. The property
577 @code{baseline-skip} determines the space between each markup in @var{args}."
579 -1 0.0 (chain-assoc-get 'baseline-skip props)
580 (remove ly:stencil-empty?
581 (map (lambda (m) (interpret-markup layout props m)) args))))
583 (def-markup-command (dir-column layout props args) (markup-list?)
584 "Make a column of args, going up or down, depending on the setting
585 of the @code{#'direction} layout property."
586 (let* ((dir (chain-assoc-get 'direction props)))
588 (if (number? dir) dir -1)
590 (chain-assoc-get 'baseline-skip props)
591 (map (lambda (x) (interpret-markup layout props x)) args))))
593 (def-markup-command (center-align layout props args) (markup-list?)
594 "Put @code{args} in a centered column. "
595 (let* ((mols (map (lambda (x) (interpret-markup layout props x)) args))
596 (cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols)))
597 (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) cmols)))
599 (def-markup-command (vcenter layout props arg) (markup?)
600 "Align @code{arg} to its Y center. "
601 (let* ((mol (interpret-markup layout props arg)))
602 (ly:stencil-aligned-to mol Y CENTER)))
604 (def-markup-command (hcenter layout props arg) (markup?)
605 "Align @code{arg} to its X center. "
606 (let* ((mol (interpret-markup layout props arg)))
607 (ly:stencil-aligned-to mol X CENTER)))
609 (def-markup-command (right-align layout props arg) (markup?)
610 "Align @var{arg} on its right edge. "
611 (let* ((m (interpret-markup layout props arg)))
612 (ly:stencil-aligned-to m X RIGHT)))
614 (def-markup-command (left-align layout props arg) (markup?)
615 "Align @var{arg} on its left edge. "
616 (let* ((m (interpret-markup layout props arg)))
617 (ly:stencil-aligned-to m X LEFT)))
619 (def-markup-command (general-align layout props axis dir arg) (integer? number? markup?)
620 "Align @var{arg} in @var{axis} direction to the @var{dir} side."
621 (let* ((m (interpret-markup layout props arg)))
622 (ly:stencil-aligned-to m axis dir)))
624 (def-markup-command (halign layout props dir arg) (number? markup?)
625 "Set horizontal alignment. If @var{dir} is @code{-1}, then it is
626 left-aligned, while @code{+1} is right. Values in between interpolate
627 alignment accordingly."
628 (let* ((m (interpret-markup layout props arg)))
629 (ly:stencil-aligned-to m X dir)))
632 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
634 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
636 (def-markup-command (fromproperty layout props symbol) (symbol?)
637 "Read the @var{symbol} from property settings, and produce a stencil
638 from the markup contained within. If @var{symbol} is not defined, it
639 returns an empty markup"
640 (let* ((m (chain-assoc-get symbol props)))
642 (interpret-markup layout props m)
643 (ly:make-stencil '() '(1 . -1) '(1 . -1)))))
646 (def-markup-command (on-the-fly layout props procedure arg) (symbol? markup?)
647 "Apply the @var{procedure} markup command to
648 @var{arg}. @var{procedure} should take a single argument."
649 (let* ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg))))
650 (set-object-property! anonymous-with-signature
653 (interpret-markup layout props (list anonymous-with-signature arg))))
657 (def-markup-command (override layout props new-prop arg) (pair? markup?)
658 "Add the first argument in to the property list. Properties may be
659 any sort of property supported by @internalsref{font-interface} and
660 @internalsref{text-interface}, for example
663 \\override #'(font-family . married) \"bla\"
667 (interpret-markup layout (cons (list new-prop) props) arg))
669 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
671 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
674 (def-markup-command (bigger layout props arg) (markup?)
675 "Increase the font size relative to current setting"
676 (interpret-markup layout props
677 `(,fontsize-markup 1 ,arg)))
679 (def-markup-command (smaller layout props arg) (markup?)
680 "Decrease the font size relative to current setting"
681 (interpret-markup layout props
682 `(,fontsize-markup -1 ,arg)))
684 (def-markup-command larger (markup?) bigger-markup)
686 (def-markup-command (finger layout props arg) (markup?)
687 "Set the argument as small numbers."
688 (interpret-markup layout
689 (cons '((font-size . -5) (font-encoding . fetaNumber)) props)
693 (def-markup-command (fontsize layout props increment arg) (number? markup?)
694 "Add @var{increment} to the font-size. Adjust baseline skip accordingly."
696 (let* ((fs (chain-assoc-get 'font-size props 0))
697 (bs (chain-assoc-get 'baseline-skip props 2))
699 (cons 'baseline-skip (* bs (magstep increment)))
700 (cons 'font-size (+ fs increment )))))
702 (interpret-markup layout (cons entries props) arg)))
706 ;; FIXME -> should convert to font-size.
707 (def-markup-command (magnify layout props sz arg) (number? markup?)
708 "Set the font magnification for the its argument. In the following
709 example, the middle A will be 10% larger:
711 A \\magnify #1.1 @{ A @} A
714 Note: magnification only works if a font-name is explicitly selected.
715 Use @code{\\fontsize} otherwise."
718 (prepend-alist-chain 'font-magnification sz props)
721 (def-markup-command (bold layout props arg) (markup?)
722 "Switch to bold font-series"
723 (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
725 (def-markup-command (sans layout props arg) (markup?)
726 "Switch to the sans serif family"
727 (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
729 (def-markup-command (number layout props arg) (markup?)
730 "Set font family to @code{number}, which yields the font used for
731 time signatures and fingerings. This font only contains numbers and
732 some punctuation. It doesn't have any letters. "
733 (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
735 (def-markup-command (roman layout props arg) (markup?)
736 "Set font family to @code{roman}."
737 (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
739 (def-markup-command (huge layout props arg) (markup?)
740 "Set font size to +2."
741 (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
743 (def-markup-command (large layout props arg) (markup?)
744 "Set font size to +1."
745 (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
747 (def-markup-command (normalsize layout props arg) (markup?)
748 "Set font size to default."
749 (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
751 (def-markup-command (small layout props arg) (markup?)
752 "Set font size to -1."
753 (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
755 (def-markup-command (tiny layout props arg) (markup?)
756 "Set font size to -2."
757 (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
759 (def-markup-command (teeny layout props arg) (markup?)
760 "Set font size to -3."
761 (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
763 (def-markup-command (caps layout props arg) (markup?)
764 "Set @code{font-shape} to @code{caps}."
765 (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
767 (def-markup-command (dynamic layout props arg) (markup?)
768 "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m},
769 @b{z}, @b{p}, and @b{r}. When producing phrases, like ``pi@`{u} @b{f}'', the
770 normal words (like ``pi@`{u}'') should be done in a different font. The
771 recommend font for this is bold and italic"
773 layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
775 (def-markup-command (text layout props arg) (markup?)
776 "Use a text font instead of music symbol or music alphabet font."
779 (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
783 (def-markup-command (italic layout props arg) (markup?)
784 "Use italic @code{font-shape} for @var{arg}. "
785 (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
787 (def-markup-command (typewriter layout props arg) (markup?)
788 "Use @code{font-family} typewriter for @var{arg}."
790 layout (prepend-alist-chain 'font-family 'typewriter props) arg))
792 (def-markup-command (upright layout props arg) (markup?)
793 "Set font shape to @code{upright}. This is the opposite of @code{italic}."
795 layout (prepend-alist-chain 'font-shape 'upright props) arg))
797 (def-markup-command (medium layout props arg) (markup?)
798 "Switch to medium font-series (in contrast to bold)."
799 (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
802 (def-markup-command (normal-text layout props arg) (markup?)
803 "Set all font related properties (except the size) to get the default normal text font, no matter what font was used earlier."
805 (interpret-markup layout
806 (cons '((font-family . roman) (font-shape . upright)
807 (font-series . medium) (font-encoding . latin1))
811 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
813 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
815 (def-markup-command (doublesharp layout props) ()
816 "Draw a double sharp symbol."
818 (interpret-markup layout props (markup #:musicglyph "accidentals.4")))
820 (def-markup-command (sesquisharp layout props) ()
821 "Draw a 3/2 sharp symbol."
822 (interpret-markup layout props (markup #:musicglyph "accidentals.3")))
824 (def-markup-command (sharp layout props) ()
825 "Draw a sharp symbol."
826 (interpret-markup layout props (markup #:musicglyph "accidentals.2")))
828 (def-markup-command (semisharp layout props) ()
829 "Draw a semi sharp symbol."
830 (interpret-markup layout props (markup #:musicglyph "accidentals.1")))
832 (def-markup-command (natural layout props) ()
833 "Draw a natural symbol."
834 (interpret-markup layout props (markup #:musicglyph "accidentals.0")))
836 (def-markup-command (semiflat layout props) ()
838 (interpret-markup layout props (markup #:musicglyph "accidentals.M1")))
840 (def-markup-command (flat layout props) ()
841 "Draw a flat symbol."
842 (interpret-markup layout props (markup #:musicglyph "accidentals.M2")))
844 (def-markup-command (sesquiflat layout props) ()
845 "Draw a 3/2 flat symbol."
846 (interpret-markup layout props (markup #:musicglyph "accidentals.M3")))
848 (def-markup-command (doubleflat layout props) ()
849 "Draw a double flat symbol."
850 (interpret-markup layout props (markup #:musicglyph "accidentals.M4")))
852 (def-markup-command (with-color layout props color arg) (color? markup?)
853 "Draw @var{arg} in color specified by @var{color}"
855 (let* ((stil (interpret-markup layout props arg)))
857 (ly:make-stencil (list 'color color (ly:stencil-expr stil))
858 (ly:stencil-extent stil X)
859 (ly:stencil-extent stil Y))))
862 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
864 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
867 (def-markup-command (arrow-head layout props axis direction filled)
868 (integer? ly:dir? boolean?)
869 "produce an arrow head in specified direction and axis. Use the filled head if @var{filled} is specified."
871 ((name (format "arrowheads.~a.~a~a"
878 (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
882 (def-markup-command (musicglyph layout props glyph-name) (string?)
883 "This is converted to a musical symbol, e.g. @code{\\musicglyph
884 #\"accidentals.0\"} will select the natural sign from the music font.
885 See @usermanref{The Feta font} for a complete listing of the possible glyphs."
887 (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
891 (def-markup-command (lookup layout props glyph-name) (string?)
892 "Lookup a glyph by name."
893 (ly:font-get-glyph (ly:paper-get-font layout props)
896 (def-markup-command (char layout props num) (integer?)
897 "Produce a single character, e.g. @code{\\char #65} produces the
899 (ly:get-glyph (ly:paper-get-font layout props) num))
902 (define number->mark-letter-vector (make-vector 25 #\A))
907 (if (= i (- (char->integer #\I) (char->integer #\A)))
909 (vector-set! number->mark-letter-vector j
910 (integer->char (+ i (char->integer #\A)))))
912 (define number->mark-alphabet-vector (list->vector
913 (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
915 (define (number->markletter-string vec n)
916 "Double letters for big marks."
917 (let* ((lst (vector-length vec)))
920 (string-append (number->markletter-string vec (1- (quotient n lst)))
921 (number->markletter-string vec (remainder n lst)))
922 (make-string 1 (vector-ref vec n)))))
924 (def-markup-command (markletter layout props num) (integer?)
925 "Make a markup letter for @var{num}. The letters start with A to Z
926 (skipping I), and continues with double letters."
927 (Text_interface::interpret_markup layout props
928 (number->markletter-string number->mark-letter-vector num)))
930 (def-markup-command (markalphabet layout props num) (integer?)
931 "Make a markup letter for @var{num}. The letters start with A to Z
932 and continues with double letters."
933 (Text_interface::interpret_markup layout props
934 (number->markletter-string number->mark-alphabet-vector num)))
937 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
939 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
942 ;; TODO: better syntax.
944 (def-markup-command (note-by-number layout props log dot-count dir) (number? number? number?)
945 "Construct a note symbol, with stem. By using fractional values for
946 @var{dir}, you can obtain longer or shorter stems."
947 (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)))
948 (size (chain-assoc-get 'font-size props 0))
949 (stem-length (* (magstep size) (max 3 (- log 1))))
950 (head-glyph (ly:font-get-glyph
952 (string-append "noteheads.s" (number->string (min log 2)))))
953 (stem-thickness 0.13)
954 (stemy (* dir stem-length))
955 (attachx (if (> dir 0)
956 (- (cdr (ly:stencil-extent head-glyph X)) stem-thickness)
958 (attachy (* dir 0.28))
959 (stem-glyph (and (> log 0)
961 (cons attachx (+ attachx stem-thickness))
962 (cons (min stemy attachy)
964 (/ stem-thickness 3))))
965 (dot (ly:font-get-glyph font "dots.dot"))
966 (dotwid (interval-length (ly:stencil-extent dot X)))
967 (dots (and (> dot-count 0)
968 (apply ly:stencil-add
970 (ly:stencil-translate-axis
971 dot (* (+ 1 (* 2 x)) dotwid) X))
972 (iota dot-count 1)))))
973 (flaggl (and (> log 2)
974 (ly:stencil-translate
975 (ly:font-get-glyph font
976 (string-append "flags."
977 (if (> dir 0) "u" "d")
978 (number->string log)))
979 (cons (+ attachx (/ stem-thickness 2)) stemy)))))
981 (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
982 (if (ly:stencil? stem-glyph)
983 (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
984 (set! stem-glyph head-glyph))
985 (if (ly:stencil? dots)
988 (ly:stencil-translate-axis
990 (+ (if (and (> dir 0) (> log 2))
993 ;; huh ? why not necessary?
994 ;;(cdr (ly:stencil-extent head-glyph X))
1001 (let ((divisor (log 2)))
1002 (lambda (z) (inexact->exact (/ (log z) divisor)))))
1004 (define (parse-simple-duration duration-string)
1005 "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list."
1006 (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string)))
1007 (if (and match (string=? duration-string (match:substring match 0)))
1008 (let ((len (match:substring match 1))
1009 (dots (match:substring match 2)))
1010 (list (cond ((string=? len "breve") -1)
1011 ((string=? len "longa") -2)
1012 ((string=? len "maxima") -3)
1013 (else (log2 (string->number len))))
1014 (if dots (string-length dots) 0)))
1015 (ly:error (_ "not a valid duration string: ~a") duration-string))))
1017 (def-markup-command (note layout props duration dir) (string? number?)
1018 "This produces a note with a stem pointing in @var{dir} direction, with
1019 the @var{duration} for the note head type and augmentation dots. For
1020 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
1021 a shortened down stem."
1022 (let ((parsed (parse-simple-duration duration)))
1023 (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
1026 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1028 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1030 (def-markup-command (lower layout props amount arg) (number? markup?)
1032 Lower @var{arg}, by the distance @var{amount}.
1033 A negative @var{amount} indicates raising, see also @code{\raise}.
1035 (ly:stencil-translate-axis (interpret-markup layout props arg)
1039 (def-markup-command (raise layout props amount arg) (number? markup?)
1041 Raise @var{arg}, by the distance @var{amount}.
1042 A negative @var{amount} indicates lowering, see also @code{\\lower}.
1044 @lilypond[verbatim,fragment,relative=1]
1045 c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }}
1047 The argument to @code{\\raise} is the vertical displacement amount,
1048 measured in (global) staff spaces. @code{\\raise} and @code{\\super}
1049 raise objects in relation to their surrounding markups.
1051 If the text object itself is positioned above or below the staff, then
1052 @code{\\raise} cannot be used to move it, since the mechanism that
1053 positions it next to the staff cancels any shift made with
1054 @code{\\raise}. For vertical positioning, use the @code{padding}
1055 and/or @code{extra-offset} properties. "
1056 (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
1058 (def-markup-command (fraction layout props arg1 arg2) (markup? markup?)
1059 "Make a fraction of two markups."
1060 (let* ((m1 (interpret-markup layout props arg1))
1061 (m2 (interpret-markup layout props arg2)))
1062 (set! m1 (ly:stencil-aligned-to m1 X CENTER))
1063 (set! m2 (ly:stencil-aligned-to m2 X CENTER))
1064 (let* ((x1 (ly:stencil-extent m1 X))
1065 (x2 (ly:stencil-extent m2 X))
1066 (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
1067 ;; should stack mols separately, to maintain LINE on baseline
1068 (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
1070 (ly:stencil-aligned-to stack Y CENTER))
1072 (ly:stencil-aligned-to stack X LEFT))
1073 ;; should have EX dimension
1075 (ly:stencil-translate-axis stack 0.75 Y))))
1081 (def-markup-command (normal-size-super layout props arg) (markup?)
1082 "Set @var{arg} in superscript with a normal font size."
1083 (ly:stencil-translate-axis
1084 (interpret-markup layout props arg)
1085 (* 0.5 (chain-assoc-get 'baseline-skip props)) Y))
1087 (def-markup-command (super layout props arg) (markup?)
1089 @cindex raising text
1090 @cindex lowering text
1092 @cindex translating text
1094 @cindex @code{\\super}
1097 Raising and lowering texts can be done with @code{\\super} and
1100 @lilypond[verbatim,fragment,relative=1]
1101 c1^\\markup { E \"=\" mc \\super \"2\" }
1105 (ly:stencil-translate-axis
1108 (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1110 (* 0.5 (chain-assoc-get 'baseline-skip props))
1113 (def-markup-command (translate layout props offset arg) (number-pair? markup?)
1114 "This translates an object. Its first argument is a cons of numbers
1116 A \\translate #(cons 2 -3) @{ B C @} D
1118 This moves `B C' 2 spaces to the right, and 3 down, relative to its
1119 surroundings. This command cannot be used to move isolated scripts
1120 vertically, for the same reason that @code{\\raise} cannot be used for
1124 (ly:stencil-translate (interpret-markup layout props arg)
1127 (def-markup-command (sub layout props arg) (markup?)
1128 "Set @var{arg} in subscript."
1129 (ly:stencil-translate-axis
1132 (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1134 (* -0.5 (chain-assoc-get 'baseline-skip props))
1137 (def-markup-command (normal-size-sub layout props arg) (markup?)
1138 "Set @var{arg} in subscript, in a normal font size."
1139 (ly:stencil-translate-axis
1140 (interpret-markup layout props arg)
1141 (* -0.5 (chain-assoc-get 'baseline-skip props))
1144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1146 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1148 (def-markup-command (hbracket layout props arg) (markup?)
1149 "Draw horizontal brackets around @var{arg}."
1150 (let ((th 0.1) ;; todo: take from GROB.
1151 (m (interpret-markup layout props arg)))
1152 (bracketify-stencil m X th (* 2.5 th) th)))
1154 (def-markup-command (bracket layout props arg) (markup?)
1155 "Draw vertical brackets around @var{arg}."
1156 (let ((th 0.1) ;; todo: take from GROB.
1157 (m (interpret-markup layout props arg)))
1158 (bracketify-stencil m Y th (* 2.5 th) th)))
1160 (def-markup-command (bracketed-y-column layout props indices args)
1161 (list? markup-list?)
1162 "Make a column of the markups in @var{args}, putting brackets around
1163 the elements marked in @var{indices}, which is a list of numbers."
1164 (define (sublist lst start stop)
1165 (take (drop lst start) (- (1+ stop) start)))
1167 (define (stencil-list-extent ss axis)
1169 (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
1170 (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
1173 (define (stack-stencils-vertically stencils bskip last-stencil)
1175 ((null? stencils) '())
1176 ((not (ly:stencil? last-stencil))
1177 (cons (car stencils)
1178 (stack-stencils-vertically (cdr stencils) bskip (car stencils))))
1180 (let* ((orig (car stencils))
1181 (dir (chain-assoc-get 'direction props DOWN))
1182 (new (ly:stencil-moved-to-edge last-stencil Y dir
1186 (cons new (stack-stencils-vertically (cdr stencils) bskip new))))))
1188 (define (make-brackets stencils indices acc)
1191 (pair? (cdr indices)))
1192 (let* ((encl (sublist stencils (car indices) (cadr indices)))
1193 (x-ext (stencil-list-extent encl X))
1194 (y-ext (stencil-list-extent encl Y))
1197 (protusion (* 2.5 thick))
1199 (ly:stencil-translate-axis
1200 (ly:bracket Y y-ext thick protusion)
1201 (- (car x-ext) pad) X))
1202 (rb (ly:stencil-translate-axis
1203 (ly:bracket Y y-ext thick (- protusion))
1204 (+ (cdr x-ext) pad) X)))
1207 stencils (cddr indices)
1220 (chain-assoc-get 'baseline-skip props))
1221 (stacked (stack-stencils-vertically
1222 (remove ly:stencil-empty? stencils) 1.25 #f))
1223 (brackets (make-brackets stacked indices '())))
1225 (apply ly:stencil-add
1226 (append stacked brackets))))