1 ;;;; define-markup-commands.scm -- markup commands
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2000--2004 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.
15 (def-markup-command (simple paper props str) (string?)
16 "A simple text string; @code{\\markup @{ foo @}} is equivalent with
17 @code{\\markup @{ \\simple #\"foo\" @}}."
18 (interpret-markup paper props str))
20 (def-markup-command (encoded-simple paper props sym str) (symbol? string?)
21 "A text string, encoded with encoding @var{sym}. "
22 (Text_item::interpret_string paper
25 ;; TODO: use font recoding.
27 ;; (map make-word-markup (string-tokenize str)))))
29 (define-public empty-markup
30 (make-simple-markup ""))
32 ;;(def-markup-command (fill-line paper props line-width markups)
33 ;; (number? markup-list?)
34 ;; no parser tag -- should make number? markuk-list? thingy
35 (def-markup-command (fill-line paper props markups)
37 "Put @var{markups} in a horizontal line of width @var{line-width}.
38 The markups are spaced/flushed to fill the entire line."
40 (let* ((stencils (map (lambda (x) (interpret-markup paper props x))
42 (text-width (apply + (map interval-length
44 (ly:stencil-extent x X))
46 (word-count (length markups))
47 (word-space (chain-assoc-get 'word-space props))
48 (line-width (chain-assoc-get 'linewidth props))
49 (fill-space (if (< line-width text-width)
51 (/ (- line-width text-width)
52 (if (= word-count 1) 2 (- word-count 1)))))
53 (line-stencils (if (= word-count 1)
54 (map (lambda (x) (interpret-markup paper props x))
55 (list (make-simple-markup "")
57 (make-simple-markup "")))
59 (stack-stencil-line fill-space line-stencils)))
61 (define (font-markup qualifier value)
62 (lambda (paper props arg)
63 (interpret-markup paper
64 (prepend-alist-chain qualifier value props)
67 (def-markup-command (line paper props args) (markup-list?)
68 "Put @var{args} in a horizontal line. The property @code{word-space}
69 determines the space between each markup in @var{args}."
71 (chain-assoc-get 'word-space props)
72 (map (lambda (m) (interpret-markup paper props m)) args)))
74 (def-markup-command (combine paper props m1 m2) (markup? markup?)
75 "Print two markups on top of each other."
77 (interpret-markup paper props m1)
78 (interpret-markup paper props m2)))
80 (def-markup-command (finger paper props arg) (markup?)
81 "Set the argument as small numbers."
82 (interpret-markup paper
83 (cons '((font-size . -5) (font-family . number)) props)
86 (def-markup-command (fontsize paper props mag arg) (number? markup?)
87 "This sets the relative font size, e.g.
89 A \\fontsize #2 @{ B C @} D
93 This will enlarge the B and the C by two steps.
97 (prepend-alist-chain 'font-size mag props)
100 (def-markup-command (magnify paper props sz arg) (number? markup?)
101 "This sets the font magnification for the its argument. In the following
102 example, the middle A will be 10% larger:
104 A \\magnify #1.1 @{ A @} A
107 Note: magnification only works if a font-name is explicitly selected.
108 Use @code{\\fontsize} otherwise."
112 (prepend-alist-chain 'font-magnification sz props)
115 (def-markup-command (bold paper props arg) (markup?)
116 "Switch to bold font-series"
117 (interpret-markup paper (prepend-alist-chain 'font-series 'bold props) arg))
119 (def-markup-command (sans paper props arg) (markup?)
120 "Switch to the sans-serif family"
121 (interpret-markup paper (prepend-alist-chain 'font-family 'sans props) arg))
123 (def-markup-command (number paper props arg) (markup?)
124 "Set font family to @code{number}, which yields the font used for
125 time signatures and fingerings. This font only contains numbers and
126 some punctuation. It doesn't have any letters. "
127 (interpret-markup paper (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
129 (def-markup-command (roman paper props arg) (markup?)
130 "Set font family to @code{roman}."
131 (interpret-markup paper (prepend-alist-chain 'font-family 'roman props) arg))
133 (def-markup-command (huge paper props arg) (markup?)
134 "Set font size to +2."
135 (interpret-markup paper (prepend-alist-chain 'font-size 2 props) arg))
137 (def-markup-command (large paper props arg) (markup?)
138 "Set font size to +1."
139 (interpret-markup paper (prepend-alist-chain 'font-size 1 props) arg))
141 (def-markup-command (normalsize paper props arg) (markup?)
142 "Set font size to default."
143 (interpret-markup paper (prepend-alist-chain 'font-size 0 props) arg))
145 (def-markup-command (small paper props arg) (markup?)
146 "Set font size to -1."
147 (interpret-markup paper (prepend-alist-chain 'font-size -1 props) arg))
149 (def-markup-command (tiny paper props arg) (markup?)
150 "Set font size to -2."
151 (interpret-markup paper (prepend-alist-chain 'font-size -2 props) arg))
153 (def-markup-command (teeny paper props arg) (markup?)
154 "Set font size to -3."
155 (interpret-markup paper (prepend-alist-chain 'font-size -3 props) arg))
157 (def-markup-command (caps paper props arg) (markup?)
158 "Set font shape to @code{caps}."
159 (interpret-markup paper (prepend-alist-chain 'font-shape 'caps props) arg))
161 (def-markup-command (latin-i paper props arg) (markup?)
162 "TEST latin1 encoding."
163 (interpret-markup paper (prepend-alist-chain 'font-shape 'latin1 props) arg))
165 (def-markup-command (dynamic paper props arg) (markup?)
166 "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m},
167 @b{z}, @b{p}, and @b{r}. When producing phrases, like ``pi@`{u} @b{f}'', the
168 normal words (like ``pi@`{u}'') should be done in a different font. The
169 recommend font for this is bold and italic"
171 paper (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
173 (def-markup-command (italic paper props arg) (markup?)
174 "Use italic @code{font-shape} for @var{arg}. "
175 (interpret-markup paper (prepend-alist-chain 'font-shape 'italic props) arg))
177 (def-markup-command (typewriter paper props arg) (markup?)
178 "Use @code{font-family} typewriter for @var{arg}."
180 paper (prepend-alist-chain 'font-family 'typewriter props) arg))
182 (def-markup-command (upright paper props arg) (markup?)
183 "Set font shape to @code{upright}."
185 paper (prepend-alist-chain 'font-shape 'upright props) arg))
187 (def-markup-command (doublesharp paper props) ()
188 "Draw a double sharp symbol."
190 (interpret-markup paper props (markup #:musicglyph "accidentals-4")))
191 (def-markup-command (sesquisharp paper props) ()
192 "Draw a 3/2 sharp symbol."
193 (interpret-markup paper props (markup #:musicglyph "accidentals-3")))
195 (def-markup-command (sharp paper props) ()
196 "Draw a sharp symbol."
197 (interpret-markup paper props (markup #:musicglyph "accidentals-2")))
198 (def-markup-command (semisharp paper props) ()
199 "Draw a semi sharp symbol."
200 (interpret-markup paper props (markup #:musicglyph "accidentals-1")))
201 (def-markup-command (natural paper props) ()
202 "Draw a natural symbol."
204 (interpret-markup paper props (markup #:musicglyph "accidentals-0")))
205 (def-markup-command (semiflat paper props) ()
207 (interpret-markup paper props (markup #:musicglyph "accidentals--1")))
208 (def-markup-command (flat paper props) ()
209 "Draw a flat symbol."
211 (interpret-markup paper props (markup #:musicglyph "accidentals--2")))
212 (def-markup-command (sesquiflat paper props) ()
213 "Draw a 3/2 flat symbol."
215 (interpret-markup paper props (markup #:musicglyph "accidentals--3")))
216 (def-markup-command (doubleflat paper props) ()
217 "Draw a double flat symbol."
219 (interpret-markup paper props (markup #:musicglyph "accidentals--4")))
222 (def-markup-command (column paper props args) (markup-list?)
223 "Stack the markups in @var{args} vertically."
225 -1 0.0 (chain-assoc-get 'baseline-skip props)
226 (map (lambda (m) (interpret-markup paper props m)) args)))
228 (def-markup-command (dir-column paper props args) (markup-list?)
229 "Make a column of args, going up or down, depending on the setting
230 of the @code{#'direction} layout property."
231 (let* ((dir (chain-assoc-get 'direction props)))
233 (if (number? dir) dir -1)
235 (chain-assoc-get 'baseline-skip props)
236 (map (lambda (x) (interpret-markup paper props x)) args))))
238 (def-markup-command (center-align paper props args) (markup-list?)
239 "Put @code{args} in a centered column. "
240 (let* ((mols (map (lambda (x) (interpret-markup paper props x)) args))
241 (cmols (map (lambda (x) (ly:stencil-align-to! x X CENTER)) mols)))
242 (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) mols)))
244 (def-markup-command (vcenter paper props arg) (markup?)
245 "Align @code{arg} to its center. "
246 (let* ((mol (interpret-markup paper props arg)))
247 (ly:stencil-align-to! mol Y CENTER)
250 (def-markup-command (right-align paper props arg) (markup?)
251 (let* ((m (interpret-markup paper props arg)))
252 (ly:stencil-align-to! m X RIGHT)
255 (def-markup-command (left-align paper props arg) (markup?)
256 "Align @var{arg} on its left edge. "
258 (let* ((m (interpret-markup paper props arg)))
259 (ly:stencil-align-to! m X LEFT)
262 (def-markup-command (halign paper props dir arg) (number? markup?)
263 "Set horizontal alignment. If @var{dir} is -1, then it is
264 left-aligned, while+1 is right. Values in between interpolate alignment
268 (let* ((m (interpret-markup paper props arg)))
269 (ly:stencil-align-to! m X dir)
272 (def-markup-command (musicglyph paper props glyph-name) (string?)
273 "This is converted to a musical symbol, e.g. @code{\\musicglyph
274 #\"accidentals-0\"} will select the natural sign from the music font.
275 See @usermanref{The Feta font} for a complete listing of the possible glyphs.
277 (ly:find-glyph-by-name
278 (ly:paper-get-font paper (cons '((font-encoding . fetaMusic))
283 (def-markup-command (lookup paper props glyph-name) (string?)
284 "Lookup a glyph by name."
285 (ly:find-glyph-by-name (ly:paper-get-font paper props)
288 (def-markup-command (char paper props num) (integer?)
289 "This produces a single character, e.g. @code{\\char #65} produces the
291 (ly:get-glyph (ly:paper-get-font paper props) num))
293 (def-markup-command (raise paper props amount arg) (number? markup?)
295 This raises @var{arg}, by the distance @var{amount}.
296 A negative @var{amount} indicates lowering:
298 @lilypond[verbatim,fragment,relative=1]
299 c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }}
301 The argument to @code{\\raise} is the vertical displacement amount,
302 measured in (global) staff spaces. @code{\\raise} and @code{\\super}
303 raise objects in relation to their surrounding markups.
305 If the text object itself is positioned above or below the staff, then
306 @code{\\raise} cannot be used to move it, since the mechanism that
307 positions it next to the staff cancels any shift made with
308 @code{\\raise}. For vertical positioning, use the @code{padding}
309 and/or @code{extra-offset} properties. "
312 (ly:stencil-translate-axis (interpret-markup paper props arg)
315 (def-markup-command (fraction paper props arg1 arg2) (markup? markup?)
316 "Make a fraction of two markups."
318 (let* ((m1 (interpret-markup paper props arg1))
319 (m2 (interpret-markup paper props arg2)))
320 (ly:stencil-align-to! m1 X CENTER)
321 (ly:stencil-align-to! m2 X CENTER)
322 (let* ((x1 (ly:stencil-extent m1 X))
323 (x2 (ly:stencil-extent m2 X))
324 (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
325 ;; should stack mols separately, to maintain LINE on baseline
326 (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
327 (ly:stencil-align-to! stack Y CENTER)
328 (ly:stencil-align-to! stack X LEFT)
329 ;; should have EX dimension
331 (ly:stencil-translate-axis stack 0.75 Y))))
334 ;; TODO: better syntax.
336 (def-markup-command (note-by-number paper props log dot-count dir) (number? number? number?)
337 "Construct a note symbol, with stem. By using fractional values for
338 @var{dir}, you can obtain longer or shorter stems."
340 (let* ((font (ly:paper-get-font paper (cons '((font-encoding . fetaMusic)) props)))
341 (stemlen (max 3 (- log 1)))
342 (headgl (ly:find-glyph-by-name
344 (string-append "noteheads-" (number->string (min log 2)))))
346 (stemy (* dir stemlen))
347 (attachx (if (> dir 0)
348 (- (cdr (ly:stencil-extent headgl X)) stemth)
350 (attachy (* dir 0.28))
351 (stemgl (and (> log 0)
353 (cons attachx (+ attachx stemth))
354 (cons (min stemy attachy)
357 (dot (ly:find-glyph-by-name font "dots-dot"))
358 (dotwid (interval-length (ly:stencil-extent dot X)))
359 (dots (and (> dot-count 0)
360 (apply ly:stencil-add
362 (ly:stencil-translate-axis
363 dot (* (+ 1 (* 2 x)) dotwid) X) )
364 (iota dot-count 1)))))
365 (flaggl (and (> log 2)
366 (ly:stencil-translate
367 (ly:find-glyph-by-name font
368 (string-append "flags-"
369 (if (> dir 0) "u" "d")
370 (number->string log)))
371 (cons (+ attachx (/ stemth 2)) stemy)))))
373 (set! stemgl (ly:stencil-add flaggl stemgl)))
374 (if (ly:stencil? stemgl)
375 (set! stemgl (ly:stencil-add stemgl headgl))
376 (set! stemgl headgl))
377 (if (ly:stencil? dots)
380 (ly:stencil-translate-axis dots
381 (+ (if (and (> dir 0) (> log 2))
384 ;; huh ? why not necessary?
385 ;;(cdr (ly:stencil-extent headgl X))
391 (use-modules (ice-9 regex))
394 (let ((divisor (log 2)))
395 (lambda (z) (inexact->exact (/ (log z) divisor)))))
397 (define (parse-simple-duration duration-string)
398 "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list."
399 (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string)))
400 (if (and match (string=? duration-string (match:substring match 0)))
401 (let ((len (match:substring match 1))
402 (dots (match:substring match 2)))
403 (list (cond ((string=? len "breve") -1)
404 ((string=? len "longa") -2)
405 ((string=? len "maxima") -3)
406 (else (log2 (string->number len))))
407 (if dots (string-length dots) 0)))
408 (error "This is not a valid duration string:" duration-string))))
410 (def-markup-command (note paper props duration dir) (string? number?)
411 "This produces a note with a stem pointing in @var{dir} direction, with
412 the @var{duration} for the note head type and augmentation dots. For
413 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
414 a shortened down stem."
416 (let ((parsed (parse-simple-duration duration)))
417 (note-by-number-markup paper props (car parsed) (cadr parsed) dir)))
419 (def-markup-command (normal-size-super paper props arg) (markup?)
420 "A superscript which does not use a smaller font."
422 (ly:stencil-translate-axis (interpret-markup
425 (* 0.5 (chain-assoc-get 'baseline-skip props))
428 (def-markup-command (super paper props arg) (markup?)
431 @cindex lowering text
433 @cindex translating text
435 @cindex @code{\\super}
438 Raising and lowering texts can be done with @code{\\super} and
441 @lilypond[verbatim,fragment,relative=1]
442 c1^\\markup { E \"=\" mc \\super \"2\" }
447 (ly:stencil-translate-axis
450 (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
452 (* 0.5 (chain-assoc-get 'baseline-skip props))
455 (def-markup-command (translate paper props offset arg) (number-pair? markup?)
456 "This translates an object. Its first argument is a cons of numbers
458 A \\translate #(cons 2 -3) @{ B C @} D
460 This moves `B C' 2 spaces to the right, and 3 down, relative to its
461 surroundings. This command cannot be used to move isolated scripts
462 vertically, for the same reason that @code{\\raise} cannot be used for
466 (ly:stencil-translate (interpret-markup paper props arg)
469 (def-markup-command (sub paper props arg) (markup?)
470 "Set @var{arg} in subscript."
472 (ly:stencil-translate-axis
475 (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
477 (* -0.5 (chain-assoc-get 'baseline-skip props))
480 (def-markup-command (normal-size-sub paper props arg) (markup?)
481 "Set @var{arg} in subscript, in a normal font size."
483 (ly:stencil-translate-axis
484 (interpret-markup paper props arg)
485 (* -0.5 (chain-assoc-get 'baseline-skip props))
488 (def-markup-command (hbracket paper props arg) (markup?)
489 "Draw horizontal brackets around @var{arg}."
490 (let ((th 0.1) ;; todo: take from GROB.
491 (m (interpret-markup paper props arg)))
492 (bracketify-stencil m X th (* 2.5 th) th)))
494 (def-markup-command (bracket paper props arg) (markup?)
495 "Draw vertical brackets around @var{arg}."
496 (let ((th 0.1) ;; todo: take from GROB.
497 (m (interpret-markup paper props arg)))
498 (bracketify-stencil m Y th (* 2.5 th) th)))
500 ;; todo: fix negative space
501 (def-markup-command (hspace paper props amount) (number?)
502 "This produces a invisible object taking horizontal space.
504 \\markup @{ A \\hspace #2.0 B @}
506 will put extra space between A and B, on top of the space that is
507 normally inserted before elements on a line.
510 (ly:make-stencil "" (cons 0 amount) '(-1 . 1) )
511 (ly:make-stencil "" (cons amount amount) '(-1 . 1))))
513 (def-markup-command (override paper props new-prop arg) (pair? markup?)
514 "Add the first argument in to the property list. Properties may be
515 any sort of property supported by @internalsref{font-interface} and
516 @internalsref{text-interface}, for example
519 \\override #'(font-family . married) \"bla\"
523 (interpret-markup paper (cons (list new-prop) props) arg))
525 (def-markup-command (smaller paper props arg) (markup?)
526 "Decrease the font size relative to current setting"
527 (let* ((fs (chain-assoc-get 'font-size props 0))
528 (entry (cons 'font-size (- fs 1))))
529 (interpret-markup paper (cons (list entry) props) arg)))
532 (def-markup-command (bigger paper props arg) (markup?)
533 "Increase the font size relative to current setting"
534 (let* ((fs (chain-assoc-get 'font-size props 0))
535 (entry (cons 'font-size (+ fs 1))))
536 (interpret-markup paper (cons (list entry) props) arg)))
538 (def-markup-command larger (markup?)
541 (def-markup-command (box paper props arg) (markup?)
542 "Draw a box round @var{arg}"
546 (m (interpret-markup paper props arg)))
547 (box-stencil m th pad)))
549 (def-markup-command (strut paper props) ()
551 "Create a box of the same height as the space in the current font.
553 FIXME: is this working?
556 (let ((m (Text_item::interpret_markup paper props " ")))
557 (ly:stencil-set-extent! m X '(1000 . -1000))
560 (define number->mark-letter-vector (make-vector 25 #\A))
565 (if (= i (- (char->integer #\I) (char->integer #\A)))
567 (vector-set! number->mark-letter-vector j
568 (integer->char (+ i (char->integer #\A)))))
570 (define (number->markletter-string n)
571 "Double letters for big marks."
573 ((l (vector-length number->mark-letter-vector)))
576 (string-append (number->markletter-string (1- (quotient n l)))
577 (number->markletter-string (remainder n l)))
578 (make-string 1 (vector-ref number->mark-letter-vector n)))))
581 (def-markup-command (markletter paper props num) (integer?)
582 "Make a markup letter for @var{num}. The letters start with A to Z
583 (skipping I), and continues with double letters."
585 (Text_item::interpret_markup paper props (number->markletter-string num)))
590 (def-markup-command (bracketed-y-column paper props indices args)
592 "Make a column of the markups in @var{args}, putting brackets around
593 the elements marked in @var{indices}, which is a list of numbers."
595 (define (sublist l start stop)
596 (take (drop l start) (- (1+ stop) start)) )
598 (define (stencil-list-extent ss axis)
600 (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
601 (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
603 (define (stack-stencils stencils bskip last-stencil)
605 ((null? stencils) '())
608 (stack-stencils (cdr stencils) bskip (car stencils))))
611 ((orig (car stencils))
612 (dir (chain-assoc-get 'direction props DOWN))
613 (new (ly:stencil-moved-to-edge last-stencil Y dir
618 (cons new (stack-stencils (cdr stencils) bskip new))))
621 (define (make-brackets stencils indices acc)
624 (pair? (cdr indices)))
626 ((encl (sublist stencils (car indices) (cadr indices)))
627 (x-ext (stencil-list-extent encl X))
628 (y-ext (stencil-list-extent encl Y))
631 (protusion (* 2.5 thick))
633 (ly:stencil-translate-axis
634 (ly:bracket Y y-ext thick protusion)
635 (- (car x-ext) pad) X))
636 (rb (ly:stencil-translate-axis
637 (ly:bracket Y y-ext thick (- protusion))
638 (+ (cdr x-ext) pad) X))
642 stencils (cddr indices)
656 (chain-assoc-get 'baseline-skip props))
657 (stacked (stack-stencils stencils 1.25 #f))
658 (brackets (make-brackets stacked indices '()))
661 (apply ly:stencil-add
662 (append stacked brackets)