2 Internally markup is stored as lists, whose head is a function.
4 (FUNCTION ARG1 ARG2 ... )
6 When the markup is formatted, then FUNCTION is called as follows
8 (FUNCTION GROB PROPS ARG1 ARG2 ... )
10 GROB is the current grob, PROPS is a list of alists, and ARG1.. are
11 the rest of the arguments.
13 The function should return a molecule (i.e. a formatted, ready to
20 1. It should be named COMMAND-markup
22 2. It should have an object property set that describes it's
23 signature. This is to allow the parser to figure out how many
26 (set-object-property! COMMAND-markup scm0-markup1)
28 (insert in the list below).
30 3. The command is now available in markup mode, e.g.
33 \markup { .... \COMMAND #1 argument ... }
38 At present, markup functions must be defined in this
39 file. Implementing user-access for markup functions is an excercise
50 ;; each markup function should have a doc string with
51 ;; syntax, description and example.
54 (define-public (simple-markup paper props . rest)
55 (Text_item::interpret_markup paper props (car rest)))
57 (define-public (stack-molecule-line space molecules)
59 (if (pair? (cdr molecules))
61 (tail (stack-molecule-line space (cdr molecules)))
62 (head (car molecules))
63 (xoff (+ space (cdr (ly:molecule-get-extent head X))))
68 (ly:molecule-translate-axis tail xoff X))
74 (define-public (line-markup paper props . rest)
75 "A horizontal line of markups. Syntax:
80 (cdr (chain-assoc 'word-space props))
81 (map (lambda (x) (interpret-markup paper props x)) (car rest)))
85 (define-public (combine-markup paper props . rest)
87 (interpret-markup paper props (car rest))
88 (interpret-markup paper props (cadr rest))))
90 (define (font-markup qualifier value)
91 (lambda (paper props . rest)
92 (interpret-markup paper (cons (cons `(,qualifier . ,value) (car props)) (cdr props)) (car rest))
97 (define-public (set-property-markup qualifier)
98 (lambda (paper props . rest )
99 (interpret-markup paper
100 (cons (cons `(,qualifier . ,(car rest))
101 (car props)) (cdr props))
105 (define-public (finger-markup paper props . rest)
106 (interpret-markup paper
107 (cons (list '(font-relative-size . -3)
108 '(font-family . number))
112 (define-public fontsize-markup (set-property-markup 'font-relative-size))
113 (define-public magnify-markup (set-property-markup 'font-magnification))
115 (define-public bold-markup
116 (font-markup 'font-series 'bold))
117 (define-public number-markup
118 (font-markup 'font-family 'number))
119 (define-public roman-markup
120 (font-markup 'font-family 'roman))
123 (define-public huge-markup
124 (font-markup 'font-relative-size 2))
125 (define-public large-markup
126 (font-markup 'font-relative-size 1))
127 (define-public small-markup
128 (font-markup 'font-relative-size -1))
129 (define-public tiny-markup
130 (font-markup 'font-relative-size -2))
131 (define-public teeny-markup
132 (font-markup 'font-relative-size -3))
133 (define-public dynamic-markup
134 (font-markup 'font-family 'dynamic))
135 (define-public italic-markup
136 (font-markup 'font-shape 'italic))
137 (define-public typewriter-markup
138 (font-markup 'font-family 'typewriter))
141 ;; TODO: baseline-skip should come from the font.
142 (define-public (column-markup paper props . rest)
144 -1 0.0 (cdr (chain-assoc 'baseline-skip props))
145 (map (lambda (x) (interpret-markup paper props x)) (car rest)))
148 (define-public (dir-column-markup paper props . rest)
149 "Make a column of args, going up or down, depending on DIRECTION."
152 (dir (cdr (chain-assoc 'direction props)))
155 (if (number? dir) dir -1)
156 0.0 (cdr (chain-assoc 'baseline-skip props))
157 (map (lambda (x) (interpret-markup paper props x)) (car rest)))
160 (define-public (center-markup paper props . rest)
163 (mols (map (lambda (x) (interpret-markup paper props x)) (car rest)))
164 (cmols (map (lambda (x) (ly:molecule-align-to! x X CENTER)) mols))
168 -1 0.0 (cdr (chain-assoc 'baseline-skip props))
172 (define-public (right-align-markup paper props . rest)
173 (let* ((m (interpret-markup paper props (car rest))))
174 (ly:molecule-align-to! m X RIGHT)
177 (define-public (halign-markup paper props . rest)
178 "Set horizontal alignment. Syntax: haling A MARKUP. A=-1 is LEFT,
179 A=1 is right, values in between vary alignment accordingly."
180 (let* ((m (interpret-markup paper props (cadr rest))))
181 (ly:molecule-align-to! m X (car rest))
184 (define-public (left-align-markup paper props . rest)
185 (let* ((m (interpret-markup paper props (car rest))))
186 (ly:molecule-align-to! m X RIGHT)
189 (define-public (musicglyph-markup paper props . rest)
190 (ly:find-glyph-by-name
191 (ly:paper-get-font paper (cons '((font-name . ()) (font-family . music)) props))
196 (define-public (lookup-markup paper props . rest)
197 "Lookup a glyph by name."
198 (ly:find-glyph-by-name
199 (ly:paper-get-font paper props)
203 (define-public (char-markup paper props . rest)
204 "Syntax: \\char NUMBER. "
205 (ly:get-glyph (ly:paper-get-font paper props) (car rest))
208 (define-public (raise-markup paper props . rest)
209 "Syntax: \\raise AMOUNT MARKUP. "
210 (ly:molecule-translate-axis (interpret-markup
216 (define-public (fraction-markup paper props . rest)
217 "Make a fraction of two markups.
219 Syntax: \\fraction MARKUP1 MARKUP2."
222 ((m1 (interpret-markup paper props (car rest)))
223 (m2 (interpret-markup paper props (cadr rest))))
225 (ly:molecule-align-to! m1 X CENTER)
226 (ly:molecule-align-to! m2 X CENTER)
229 ((x1 (ly:molecule-get-extent m1 X))
230 (x2 (ly:molecule-get-extent m2 X))
231 (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
233 ;; should stack mols separately, to maintain LINE on baseline
234 (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
236 (ly:molecule-align-to! stack Y CENTER)
237 (ly:molecule-align-to! stack X LEFT)
238 ;; should have EX dimension
240 (ly:molecule-translate-axis stack 0.75 Y)
244 (define-public (note-markup paper props . rest)
245 "Syntax: \\note #LOG #DOTS #DIR. By using fractional values
246 for DIR, you can obtain longer or shorter stems."
251 (dot-count (cadr rest))
253 (font (ly:paper-get-font paper (cons '((font-family . music)) props)))
254 (stemlen (max 3 (- log 1)))
256 (ly:find-glyph-by-name font (string-append "noteheads-" (number->string (min log 2)))))
259 (stemy (* dir stemlen))
260 (attachx (if (> dir 0) (- (cdr (ly:molecule-get-extent headgl X)) stemth)
262 (attachy (* dir 0.28))
263 (stemgl (if (> log 0)
265 (cons attachx (+ attachx stemth))
266 (cons (min stemy attachy)
270 (dot (ly:find-glyph-by-name font "dots-dot"))
271 (dotwid (interval-length (ly:molecule-get-extent dot X)))
272 (dots (if (> dot-count 0)
273 (apply ly:molecule-add
275 (ly:molecule-translate-axis
276 dot (* (+ 1 (* 2 x)) dotwid) X) )
280 (flaggl (if (> log 2)
281 (ly:molecule-translate
282 (ly:find-glyph-by-name
284 (string-append "flags-"
285 (if (> dir 0) "u" "d")
288 (cons (+ attachx (/ stemth 2)) stemy))
293 (set! stemgl (ly:molecule-add flaggl stemgl)))
295 (if (ly:molecule? stemgl)
296 (set! stemgl (ly:molecule-add stemgl headgl))
300 (if (ly:molecule? dots)
303 (ly:molecule-translate-axis
306 (if (and (> dir 0) (> log 2))
308 ;; huh ? why not necessary?
309 ;(cdr (ly:molecule-get-extent headgl X))
320 (define-public (normal-size-super-markup paper props . rest)
321 (ly:molecule-translate-axis (interpret-markup
324 (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
328 (define-public (super-markup paper props . rest)
329 "Syntax: \\super MARKUP. "
330 (ly:molecule-translate-axis (interpret-markup
332 (cons '((font-relative-size . -2)) props) (car rest))
333 (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
337 (define-public (translate-markup paper props . rest)
338 "Syntax: \\translate OFFSET MARKUP. "
339 (ly:molecule-translate (interpret-markup paper props (cadr rest))
344 (define-public (sub-markup paper props . rest)
345 "Syntax: \\sub MARKUP."
346 (ly:molecule-translate-axis (interpret-markup
348 (cons '((font-relative-size . -2)) props)
350 (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
354 (define-public (normal-size-sub-markup paper props . rest)
355 (ly:molecule-translate-axis (interpret-markup
358 (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
362 (define-public (hbracket-markup paper props . rest)
363 "Horizontal brackets around its single argument. Syntax \\hbracket MARKUP."
367 (th 0.1) ;; todo: take from GROB.
368 (m (interpret-markup paper props (car rest)))
371 (bracketify-molecule m X th (* 2.5 th) th)
374 (define-public (bracket-markup paper props . rest)
375 "Vertical brackets around its single argument. Syntax \\bracket MARKUP."
378 (th 0.1) ;; todo: take from GROB.
379 (m (interpret-markup paper props (car rest)))
382 (bracketify-molecule m Y th (* 2.5 th) th)
385 ;; todo: fix negative space
386 (define (hspace-markup paper props . rest)
387 "Syntax: \\hspace NUMBER."
389 ((amount (car rest)))
391 (ly:make-molecule "" (cons 0 amount) '(-1 . 1) )
392 (ly:make-molecule "" (cons amount amount) '(-1 . 1)))
395 (define-public (override-markup paper props . rest)
396 "Tack the 1st arg in REST onto PROPS, e.g.
398 \override #'(font-family . married) \"bla\"
402 (interpret-markup paper (cons (list (car rest)) props)
405 (define-public (smaller-markup paper props . rest)
406 "Syntax: \\smaller MARKUP"
409 (fs (cdr (chain-assoc 'font-relative-size props)))
410 (entry (cons 'font-relative-size (- fs 1)))
413 paper (cons (list entry) props)
417 (define-public (bigger-markup paper props . rest)
418 "Syntax: \\bigger MARKUP"
421 (fs (cdr (chain-assoc 'font-relative-size props)))
422 (entry (cons 'font-relative-size (+ fs 1)))
425 paper (cons (list entry) props)
429 (define-public (box-markup paper props . rest)
430 "Syntax: \\box MARKUP"
435 (m (interpret-markup paper props (car rest)))
437 (box-molecule m th pad)
441 (define-public (strut-markup paper props . rest)
444 A box of the same height as the space.
448 ((m (Text_item::interpret_markup paper props " ")))
450 (ly:molecule-set-extent! m 0 '(1000 . -1000))
453 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
456 (define (markup-signature-to-keyword sig)
457 " (A B C) -> a0-b1-c2 "
460 (string->symbol (string-join
464 (set! count (+ count 1))
467 ;; for reasons I don't get,
468 ;; (case func ((markup?) .. )
471 ((eq? func markup?) "markup")
472 ((eq? func markup-list?) "markup-list")
475 (number->string (- count 1))
484 (define (markup-function? x)
485 (object-property x 'markup-signature)
488 (define (markup-list? arg)
489 (define (markup-list-inner? l)
492 (and (markup? (car l)) (markup-list-inner? (cdr l)))
495 (and (list? arg) (markup-list-inner? arg)))
497 (define (markup-argument-list? signature arguments)
498 "Typecheck argument list."
499 (if (and (pair? signature) (pair? arguments))
500 (and ((car signature) (car arguments))
501 (markup-argument-list? (cdr signature) (cdr arguments)))
502 (and (null? signature) (null? arguments)))
506 (define (markup-argument-list-error signature arguments number)
507 "return (ARG-NR TYPE-EXPECTED ARG-FOUND) if an error is detected, or
508 #f is no error found.
510 (if (and (pair? signature) (pair? arguments))
511 (if (not ((car signature) (car arguments)))
512 (list number (type-name (car signature)) (car arguments))
513 (markup-argument-list-error (cdr signature) (cdr arguments) (+ 1 number)))
518 ;; full recursive typecheck.
520 (define (markup-typecheck? arg)
523 (markup-function? (car arg))
524 (markup-argument-list?
525 (object-property (car arg) 'markup-signature)
531 ;; typecheck, and throw an error when something amiss.
533 (define (markup-thrower-typecheck arg)
537 (throw 'markup-format "Not a pair" arg)
539 ((not (markup-function? (car arg)))
540 (throw 'markup-format "Not a markup function " (car arg)))
543 ((not (markup-argument-list?
544 (object-property (car arg) 'markup-signature)
546 (throw 'markup-format "Arguments failed typecheck for " arg)))
551 ;; good enough if you only use make-XXX-markup functions.
553 (define (cheap-markup? x)
556 (markup-function? (car x))))
560 ;; replace by markup-thrower-typecheck for more detailed diagnostics.
562 (define markup? cheap-markup?)
564 (define markup-functions-and-signatures
568 (cons teeny-markup (list markup?))
569 (cons tiny-markup (list markup?))
570 (cons small-markup (list markup?))
571 (cons dynamic-markup (list markup?))
572 (cons large-markup (list markup?))
574 (cons huge-markup (list markup?))
577 (cons smaller-markup (list markup?))
578 (cons bigger-markup (list markup?))
579 ; (cons char-number-markup (list string?))
582 (cons sub-markup (list markup?))
583 (cons normal-size-sub-markup (list markup?))
585 (cons super-markup (list markup?))
586 (cons normal-size-super-markup (list markup?))
588 (cons finger-markup (list markup?))
589 (cons bold-markup (list markup?))
590 (cons italic-markup (list markup?))
591 (cons typewriter-markup (list markup?))
592 (cons roman-markup (list markup?))
593 (cons number-markup (list markup?))
594 (cons hbracket-markup (list markup?))
595 (cons bracket-markup (list markup?))
596 (cons note-markup (list integer? integer? ly:dir?))
597 (cons fraction-markup (list markup? markup?))
599 (cons column-markup (list markup-list?))
600 (cons dir-column-markup (list markup-list?))
601 (cons center-markup (list markup-list?))
602 (cons line-markup (list markup-list?))
604 (cons right-align-markup (list markup?))
605 (cons left-align-markup (list markup?))
606 (cons halign-markup (list number? markup?))
608 (cons combine-markup (list markup? markup?))
609 (cons simple-markup (list string?))
610 (cons musicglyph-markup (list scheme?))
611 (cons translate-markup (list number-pair? markup?))
612 (cons override-markup (list pair? markup?))
613 (cons char-markup (list integer?))
614 (cons lookup-markup (list string?))
616 (cons hspace-markup (list number?))
618 (cons raise-markup (list number? markup?))
619 (cons magnify-markup (list number? markup?))
620 (cons fontsize-markup (list number? markup?))
622 (cons box-markup (list markup?))
623 (cons strut-markup '())
627 (define markup-module (current-module))
630 (set-object-property! (car x) 'markup-signature (cdr x))
631 (set-object-property! (car x) 'markup-keyword (markup-signature-to-keyword (cdr x)))
633 markup-functions-and-signatures)
635 (define-public markup-function-list (map car markup-functions-and-signatures))
640 ;; make-FOO-markup function that typechecks its arguments.
642 ;; TODO: should construct a message says
643 ;; Invalid argument 4 : expecting a BLADIBLA, found: (list-ref 4 args)
645 ;; right now, you get the entire argument list.
648 (define (make-markup-maker entry)
650 ((foo-markup (car entry))
651 (signature (cons 'list (cdr entry)))
652 (name (symbol->string (procedure-name foo-markup)))
653 (make-name (string-append "make-" name))
656 `(define (,(string->symbol make-name) . args)
659 (arglen (length args))
660 (siglen (length ,signature))
662 (if (and (> 0 siglen) (> 0 arglen))
663 (markup-argument-list-error ,signature args 1)))
667 (if (or (not (= arglen siglen)) (< siglen 0) (< 0 arglen))
668 (scm-error 'markup-format ,make-name "Expect ~A arguments for ~A. Found ~A: ~S"
669 (list (length ,signature)
674 (scm-error 'markup-format ,make-name "Invalid argument in position ~A\n Expect: ~A\nFound: ~S." error-msg #f)
676 (cons ,foo-markup args)
683 (define (make-markup markup-function make-name signature args)
685 " Construct a markup object from MARKUP-FUNCTION and ARGS. Typecheck
686 against SIGNATURE, reporting MAKE-NAME as the user-invoked function.
690 ((arglen (length args))
691 (siglen (length signature))
693 (if (and (> siglen 0) (> arglen 0))
694 (markup-argument-list-error signature args 1)
698 (if (or (not (= arglen siglen)) (< siglen 0) (< arglen 0))
699 (scm-error 'markup-format make-name "Expect ~A arguments for ~A. Found ~A: ~S"
706 (scm-error 'markup-format make-name "Invalid argument in position ~A\nExpect: ~A\nFound: ~S." error-msg #f)
708 (cons markup-function args)
711 (define (make-markup-maker entry)
713 (name (symbol->string (procedure-name (car entry))))
714 (make-name (string-append "make-" name))
715 (signature (object-property (car entry) 'markup-signature))
718 `(define-public (,(string->symbol make-name) . args)
719 (make-markup ,(car entry) ,make-name ,(cons 'list signature) args)
724 (cons 'begin (map make-markup-maker markup-functions-and-signatures))
729 ;; TODO: add module argument so user-defined markups can also be
732 (define-public (lookup-markup-command code)
734 ((sym (string->symbol (string-append code "-markup")))
735 (var (module-local-variable markup-module sym))
739 (cons (variable-ref var) (object-property (variable-ref var) 'markup-keyword))
744 (define-public brew-new-markup-molecule Text_item::brew_molecule)
746 (define-public empty-markup (make-simple-markup ""))
748 (define-public interpret-markup Text_item::interpret_markup)
754 (define (markup-join markups sep)
755 "Return line-markup of MARKUPS, joining them with markup SEP"
757 (make-line-markup (list-insert-separator markups sep))
761 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
764 (define (typecheck-with-error x)
767 (lambda () (markup? x))
768 (lambda (key message arg)
769 (display "\nERROR: markup format error: \n")
772 (write arg (current-output-port))
776 ;; test make-foo-markup functions
781 (display (make-line-markup (list (make-simple-markup "FOO"))))
783 (make-line-markup (make-simple-markup "FOO"))
784 (make-line-markup (make-simple-markup "FOO") (make-simple-markup "foo"))
785 (make-raise-markup "foo" (make-simple-markup "foo"))
791 ;; test typecheckers. Not wholly useful, because errors are detected
792 ;; in other places than they're made.
797 ;; To get error messages, see above to install the alternate
798 ;; typecheck routine for markup?.
802 (display (typecheck-with-error `(,simple-markup "foobar")))
803 (display (typecheck-with-error `(,simple-markup "foobar")))
804 (display (typecheck-with-error `(,simple-markup 1)))
806 (typecheck-with-error `(,line-markup ((,simple-markup "foobar"))
807 (,simple-markup 1))))
809 (typecheck-with-error `(,line-markup (,simple-markup "foobar")
810 (,simple-markup "bla"))))