+;;;; define-markup-commands.scm -- markup commands
+;;;;
+;;;; source file of the GNU LilyPond music typesetter
+;;;;
+;;;; (c) 2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; Jan Nieuwenhuizen <janneke@gnu.org>
-
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; markup commands
-;; TODO:
-;; each markup function should have a doc string with
-;; syntax, description and example.
-;;
+;;; TODO:
+;;; * each markup function should have a doc string with
+;; syntax, description and example.
+(def-markup-command (word paper props str) (string?)
+ "A single word."
+ (interpret-markup paper props str))
+
(def-markup-command (simple paper props str) (string?)
"A simple text-string; @code{\\markup @{ foo @}} is equivalent with
-@code{\\markup @{ \\simple #\"foo\" @}}.
-"
- (interpret-markup paper props str))
+@code{\\markup @{ \\simple #\"foo\" @}}."
+ (interpret-markup paper props
+ (make-line-markup
+ (map make-word-markup (string-tokenize str)))))
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; fonts
+(define-public empty-markup
+ (make-simple-markup ""))
+;;(def-markup-command (fill-line paper props line-width markups)
+;; (number? markup-list?)
+;; no parser tag -- should make number? markuk-list? thingy
+(def-markup-command (fill-line paper props markups)
+ (markup-list?)
+ "Put @var{markups} in a horizontal line of width @var{line-width}.
+ The markups are spaced/flushed to fill the entire line."
+
+ (let* ((stencils (map (lambda (x) (interpret-markup paper props x))
+ markups))
+ (text-width (apply + (map interval-length
+ (map (lambda (x)
+ (ly:stencil-extent x X))
+ stencils))))
+ (word-count (length markups))
+ (word-space (chain-assoc-get 'word-space props))
+ (line-width (chain-assoc-get 'linewidth props))
+ (fill-space (if (< line-width text-width)
+ word-space
+ (/ (- line-width text-width)
+ (if (= word-count 1) 2 (- word-count 1)))))
+ (line-stencils (if (= word-count 1)
+ (map (lambda (x) (interpret-markup paper props x))
+ (list (make-word-markup "")
+ (car markups)
+ (make-word-markup "")))
+ stencils)))
+ (stack-stencil-line fill-space line-stencils)))
+
(define (font-markup qualifier value)
(lambda (paper props arg)
(interpret-markup paper
(prepend-alist-chain qualifier value props)
arg)))
-
-
-(define-public empty-markup
- (make-simple-markup ""))
-
(def-markup-command (line paper props args) (markup-list?)
- "Put @var{args} in a horizontal line. The property @code{word-space} determines
-the space between each markup in @var{args}.
-"
- (stack-molecule-line
- (cdr (chain-assoc 'word-space props))
+ "Put @var{args} in a horizontal line. The property @code{word-space}
+determines the space between each markup in @var{args}."
+ (stack-stencil-line
+ (chain-assoc-get 'word-space props)
(map (lambda (m) (interpret-markup paper props m)) args)))
(def-markup-command (combine paper props m1 m2) (markup? markup?)
"Print two markups on top of each other."
- (ly:molecule-add
+ (ly:stencil-add
(interpret-markup paper props m1)
(interpret-markup paper props m2)))
-
(def-markup-command (finger paper props arg) (markup?)
"Set the argument as small numbers."
(interpret-markup paper
- (cons '((font-size . -4) (font-family . number)) props)
+ (cons '((font-size . -5) (font-family . number)) props)
arg))
-
(def-markup-command (fontsize paper props mag arg) (number? markup?)
"This sets the relative font size, eg.
@example
"Set font size to -3."
(interpret-markup paper (prepend-alist-chain 'font-size -3 props) arg))
+(def-markup-command (caps paper props arg) (markup?)
+ "Set font shape to @code{caps}."
+ (interpret-markup paper (prepend-alist-chain 'font-shape 'caps props) arg))
+
+(def-markup-command (latin-i paper props arg) (markup?)
+ "TEST latin1 encoding."
+ (interpret-markup paper (prepend-alist-chain 'font-shape 'latin1 props) arg))
+
(def-markup-command (dynamic paper props arg) (markup?)
- "Use the dynamic font. This font only contains s, f, m, z, p, and
-r. When producing phrases, like ``piu f'', the normal words (like
-``piu'') should be done in a different font.
-The recommend font for this is bold and italic
-"
- (interpret-markup paper (prepend-alist-chain 'font-family 'dynamic props) arg))
+ "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m},
+@b{z}, @b{p}, and @b{r}. When producing phrases, like ``piu @b{f}'', the
+normal words (like ``piu'') should be done in a different font. The
+recommend font for this is bold and italic"
+ (interpret-markup
+ paper (prepend-alist-chain 'font-family 'dynamic props) arg))
(def-markup-command (italic paper props arg) (markup?)
+ "Use italic @code{font-shape} for @var{arg}. "
(interpret-markup paper (prepend-alist-chain 'font-shape 'italic props) arg))
(def-markup-command (typewriter paper props arg) (markup?)
- (interpret-markup paper (prepend-alist-chain 'font-family 'typewriter props) arg))
+ "Use @code{font-family} typewriter for @var{arg}."
+ (interpret-markup
+ paper (prepend-alist-chain 'font-family 'typewriter props) arg))
+
+(def-markup-command (upright paper props arg) (markup?)
+ "Set font shape to @code{upright}."
+ (interpret-markup
+ paper (prepend-alist-chain 'font-shape 'upright props) arg))
(def-markup-command (doublesharp paper props) ()
+ "Draw a double sharp symbol."
+
(interpret-markup paper props (markup #:musicglyph "accidentals-4")))
-(def-markup-command (threeqsharp paper props) ()
+(def-markup-command (sesquisharp paper props) ()
+ "Draw a 3/2 sharp symbol."
(interpret-markup paper props (markup #:musicglyph "accidentals-3")))
+
(def-markup-command (sharp paper props) ()
+ "Draw a sharp symbol."
(interpret-markup paper props (markup #:musicglyph "accidentals-2")))
(def-markup-command (semisharp paper props) ()
+ "Draw a semi sharp symbol."
(interpret-markup paper props (markup #:musicglyph "accidentals-1")))
(def-markup-command (natural paper props) ()
+ "Draw a natural symbol."
+
(interpret-markup paper props (markup #:musicglyph "accidentals-0")))
(def-markup-command (semiflat paper props) ()
+ "Draw a semiflat."
(interpret-markup paper props (markup #:musicglyph "accidentals--1")))
(def-markup-command (flat paper props) ()
+ "Draw a flat symbol."
+
(interpret-markup paper props (markup #:musicglyph "accidentals--2")))
-(def-markup-command (threeqflat paper props) ()
+(def-markup-command (sesquiflat paper props) ()
+ "Draw a 3/2 flat symbol."
+
(interpret-markup paper props (markup #:musicglyph "accidentals--3")))
(def-markup-command (doubleflat paper props) ()
+ "Draw a double flat symbol."
+
(interpret-markup paper props (markup #:musicglyph "accidentals--4")))
(def-markup-command (column paper props args) (markup-list?)
+ "Stack the markups in @var{args} vertically."
(stack-lines
- -1 0.0 (cdr (chain-assoc 'baseline-skip props))
+ -1 0.0 (chain-assoc-get 'baseline-skip props)
(map (lambda (m) (interpret-markup paper props m)) args)))
(def-markup-command (dir-column paper props args) (markup-list?)
"Make a column of args, going up or down, depending on the setting
-of the #'direction layout property."
- (let* ((dir (cdr (chain-assoc 'direction props))))
+of the @code{#'direction} layout property."
+ (let* ((dir (chain-assoc-get 'direction props)))
(stack-lines
(if (number? dir) dir -1)
0.0
- (cdr (chain-assoc 'baseline-skip props))
+ (chain-assoc-get 'baseline-skip props)
(map (lambda (x) (interpret-markup paper props x)) args))))
-(def-markup-command (center paper props args) (markup-list?)
+(def-markup-command (center-align paper props args) (markup-list?)
+ "Put @code{args} in a centered column. "
(let* ((mols (map (lambda (x) (interpret-markup paper props x)) args))
- (cmols (map (lambda (x) (ly:molecule-align-to! x X CENTER)) mols)))
- (stack-lines -1 0.0 (cdr (chain-assoc 'baseline-skip props)) mols)))
+ (cmols (map (lambda (x) (ly:stencil-align-to! x X CENTER)) mols)))
+ (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) mols)))
(def-markup-command (right-align paper props arg) (markup?)
(let* ((m (interpret-markup paper props arg)))
- (ly:molecule-align-to! m X RIGHT)
+ (ly:stencil-align-to! m X RIGHT)
m))
(def-markup-command (left-align paper props arg) (markup?)
+ "Align @var{arg} on its left edge. "
+
(let* ((m (interpret-markup paper props arg)))
- (ly:molecule-align-to! m X LEFT)
+ (ly:stencil-align-to! m X LEFT)
m))
(def-markup-command (halign paper props dir arg) (number? markup?)
- "Set horizontal alignment. @var{dir} = -1 is left, @var{dir} = 1 is
-right, values in between vary alignment accordingly."
+ "Set horizontal alignment. If @var{dir} is -1, then it is
+left-aligned, while+1 is right. Values in between interpolate alignment
+accordingly."
(let* ((m (interpret-markup paper props arg)))
- (ly:molecule-align-to! m X dir)
+ (ly:stencil-align-to! m X dir)
m))
(def-markup-command (musicglyph paper props glyph-name) (string?)
See @usermanref{The Feta font} for a complete listing of the possible glyphs.
"
(ly:find-glyph-by-name
- (ly:paper-get-font paper (cons '((font-name . ())
- (font-shape . *)
- (font-series . *)
- (font-family . music))
+ (ly:paper-get-font paper (cons '((font-encoding . music))
props))
glyph-name))
This raises @var{arg}, by the distance @var{amount}.
A negative @var{amount} indicates lowering:
@c
-@lilypond[verbatim,fragment,relative=1,quote]
+@lilypond[verbatim,fragment,relative=1]
c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }}
@end lilypond
The argument to @code{\\raise} is the vertical displacement amount,
and/or @code{extra-offset} properties. "
- (ly:molecule-translate-axis (interpret-markup paper props arg)
+ (ly:stencil-translate-axis (interpret-markup paper props arg)
amount Y))
(def-markup-command (fraction paper props arg1 arg2) (markup? markup?)
- "Make a fraction of two markups.
-
-Syntax: \\fraction MARKUP1 MARKUP2."
+ "Make a fraction of two markups."
+
(let* ((m1 (interpret-markup paper props arg1))
(m2 (interpret-markup paper props arg2)))
- (ly:molecule-align-to! m1 X CENTER)
- (ly:molecule-align-to! m2 X CENTER)
- (let* ((x1 (ly:molecule-get-extent m1 X))
- (x2 (ly:molecule-get-extent m2 X))
+ (ly:stencil-align-to! m1 X CENTER)
+ (ly:stencil-align-to! m2 X CENTER)
+ (let* ((x1 (ly:stencil-extent m1 X))
+ (x2 (ly:stencil-extent m2 X))
(line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
;; should stack mols separately, to maintain LINE on baseline
(stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
- (ly:molecule-align-to! stack Y CENTER)
- (ly:molecule-align-to! stack X LEFT)
+ (ly:stencil-align-to! stack Y CENTER)
+ (ly:stencil-align-to! stack X LEFT)
;; should have EX dimension
;; empirical anyway
- (ly:molecule-translate-axis stack 0.75 Y))))
+ (ly:stencil-translate-axis stack 0.75 Y))))
;; TODO: better syntax.
(def-markup-command (note-by-number paper props log dot-count dir) (number? number? number?)
- "Syntax: \\note-by-number #LOG #DOTS #DIR. By using fractional values
-for DIR, you can obtain longer or shorter stems."
- (let* ((font (ly:paper-get-font paper (cons '((font-family . music)) props)))
+ "Construct a note symbol, with stem. By using fractional values for
+@var{dir}, you can obtain longer or shorter stems."
+
+ (let* ((font (ly:paper-get-font paper (cons '((font-encoding . music)) props)))
(stemlen (max 3 (- log 1)))
(headgl (ly:find-glyph-by-name
font
(stemth 0.13)
(stemy (* dir stemlen))
(attachx (if (> dir 0)
- (- (cdr (ly:molecule-get-extent headgl X)) stemth)
+ (- (cdr (ly:stencil-extent headgl X)) stemth)
0))
(attachy (* dir 0.28))
(stemgl (and (> log 0)
(max stemy attachy))
(/ stemth 3))))
(dot (ly:find-glyph-by-name font "dots-dot"))
- (dotwid (interval-length (ly:molecule-get-extent dot X)))
+ (dotwid (interval-length (ly:stencil-extent dot X)))
(dots (and (> dot-count 0)
- (apply ly:molecule-add
+ (apply ly:stencil-add
(map (lambda (x)
- (ly:molecule-translate-axis
+ (ly:stencil-translate-axis
dot (* (+ 1 (* 2 x)) dotwid) X) )
(iota dot-count 1)))))
(flaggl (and (> log 2)
- (ly:molecule-translate
+ (ly:stencil-translate
(ly:find-glyph-by-name font
(string-append "flags-"
(if (> dir 0) "u" "d")
(number->string log)))
(cons (+ attachx (/ stemth 2)) stemy)))))
(if flaggl
- (set! stemgl (ly:molecule-add flaggl stemgl)))
- (if (ly:molecule? stemgl)
- (set! stemgl (ly:molecule-add stemgl headgl))
+ (set! stemgl (ly:stencil-add flaggl stemgl)))
+ (if (ly:stencil? stemgl)
+ (set! stemgl (ly:stencil-add stemgl headgl))
(set! stemgl headgl))
- (if (ly:molecule? dots)
+ (if (ly:stencil? dots)
(set! stemgl
- (ly:molecule-add
- (ly:molecule-translate-axis dots
+ (ly:stencil-add
+ (ly:stencil-translate-axis dots
(+ (if (and (> dir 0) (> log 2))
(* 1.5 dotwid)
0)
;; huh ? why not necessary?
- ;;(cdr (ly:molecule-get-extent headgl X))
+ ;;(cdr (ly:stencil-extent headgl X))
dotwid)
X)
stemgl)))
(def-markup-command (normal-size-super paper props arg) (markup?)
"A superscript which does not use a smaller font."
- (ly:molecule-translate-axis (interpret-markup
+
+ (ly:stencil-translate-axis (interpret-markup
paper
props arg)
- (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
+ (* 0.5 (chain-assoc-get 'baseline-skip props))
Y))
(def-markup-command (super paper props arg) (markup?)
"
- (ly:molecule-translate-axis
+ (ly:stencil-translate-axis
(interpret-markup
paper
(cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
arg)
- (* 0.5 (cdr (chain-assoc 'baseline-skip props)))
+ (* 0.5 (chain-assoc-get 'baseline-skip props))
Y))
(def-markup-command (translate paper props offset arg) (number-pair? markup?)
that.
. "
- (ly:molecule-translate (interpret-markup paper props arg)
+ (ly:stencil-translate (interpret-markup paper props arg)
offset))
(def-markup-command (sub paper props arg) (markup?)
- "Syntax: \\sub MARKUP."
- (ly:molecule-translate-axis
+ "Set @var{arg} in subscript."
+
+ (ly:stencil-translate-axis
(interpret-markup
paper
(cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
arg)
- (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
+ (* -0.5 (chain-assoc-get 'baseline-skip props))
Y))
(def-markup-command (normal-size-sub paper props arg) (markup?)
- (ly:molecule-translate-axis
+ "Set @var{arg} in subscript, in a normal font size."
+
+ (ly:stencil-translate-axis
(interpret-markup paper props arg)
- (* -0.5 (cdr (chain-assoc 'baseline-skip props)))
+ (* -0.5 (chain-assoc-get 'baseline-skip props))
Y))
(def-markup-command (hbracket paper props arg) (markup?)
- "Horizontal brackets around @var{arg}."
+ "Draw horizontal brackets around @var{arg}."
(let ((th 0.1) ;; todo: take from GROB.
(m (interpret-markup paper props arg)))
- (bracketify-molecule m X th (* 2.5 th) th)))
+ (bracketify-stencil m X th (* 2.5 th) th)))
(def-markup-command (bracket paper props arg) (markup?)
- "Vertical brackets around @var{arg}."
+ "Draw vertical brackets around @var{arg}."
(let ((th 0.1) ;; todo: take from GROB.
(m (interpret-markup paper props arg)))
- (bracketify-molecule m Y th (* 2.5 th) th)))
+ (bracketify-stencil m Y th (* 2.5 th) th)))
;; todo: fix negative space
(def-markup-command (hspace paper props amount) (number?)
normally inserted before elements on a line.
"
(if (> amount 0)
- (ly:make-molecule "" (cons 0 amount) '(-1 . 1) )
- (ly:make-molecule "" (cons amount amount) '(-1 . 1))))
+ (ly:make-stencil "" (cons 0 amount) '(-1 . 1) )
+ (ly:make-stencil "" (cons amount amount) '(-1 . 1))))
(def-markup-command (override paper props new-prop arg) (pair? markup?)
"Add the first argument in to the property list. Properties may be
(def-markup-command (smaller paper props arg) (markup?)
"Decrease the font size relative to current setting"
(let* ((fs (chain-assoc-get 'font-size props 0))
- (entry (cons 'font-size (- fs 1))))
+ (entry (cons 'font-size (- fs 1))))
(interpret-markup paper (cons (list entry) props) arg)))
(let ((th 0.1)
(pad 0.2)
(m (interpret-markup paper props arg)))
- (box-molecule m th pad)))
+ (box-stencil m th pad)))
(def-markup-command (strut paper props) ()
"
(let ((m (Text_item::interpret_markup paper props " ")))
- (ly:molecule-set-extent! m X '(1000 . -1000))
+ (ly:stencil-set-extent! m X '(1000 . -1000))
m))
(define number->mark-letter-vector (make-vector 25 #\A))
(def-markup-command (markletter paper props num) (integer?)
- "Make a markup letter for @var{num}. The letters start with A to Z
-(skipping I), and continues with double letters."
+ "Make a markup letter for @var{num}. The letters start with A to Z
+ (skipping I), and continues with double letters."
+
+ (Text_item::interpret_markup paper props (number->markletter-string num)))
+
+
+
+
+(def-markup-command (bracketed-y-column paper props indices args)
+ (list? markup-list?)
+ "Make a column of the markups in @var{args}, putting brackets around
+the elements marked in @var{indices}, which is a list of numbers."
+
+ (define (sublist l start stop)
+ (take (drop l start) (- (1+ stop) start)) )
+
+ (define (stencil-list-extent ss axis)
+ (cons
+ (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
+ (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
+
+ (define (stack-stencils stencils bskip last-stencil)
+ (cond
+ ((null? stencils) '())
+ ((not last-stencil)
+ (cons (car stencils)
+ (stack-stencils (cdr stencils) bskip (car stencils))))
+ (else
+ (let*
+ ((orig (car stencils))
+ (dir (chain-assoc-get 'direction props DOWN))
+ (new (ly:stencil-moved-to-edge last-stencil Y dir
+ orig
+ 0.1 bskip))
+ )
+
+ (cons new (stack-stencils (cdr stencils) bskip new))))
+ ))
+
+ (define (make-brackets stencils indices acc)
+ (if (and stencils
+ (pair? indices)
+ (pair? (cdr indices)))
+ (let*
+ ((encl (sublist stencils (car indices) (cadr indices)))
+ (x-ext (stencil-list-extent encl X))
+ (y-ext (stencil-list-extent encl Y))
+ (thick 0.10)
+ (pad 0.35)
+ (protusion (* 2.5 thick))
+ (lb
+ (ly:stencil-translate-axis
+ (ly:bracket Y y-ext thick protusion)
+ (- (car x-ext) pad) X))
+ (rb (ly:stencil-translate-axis
+ (ly:bracket Y y-ext thick (- protusion))
+ (+ (cdr x-ext) pad) X))
+ )
+
+ (make-brackets
+ stencils (cddr indices)
+ (append
+ (list lb rb)
+ acc)))
+ acc))
+
+ (let*
+ ((stencils
+ (map (lambda (x)
+ (interpret-markup
+ paper
+ props
+ x)) args))
+ (leading
+ (chain-assoc-get 'baseline-skip props))
+ (stacked (stack-stencils stencils 1.25 #f))
+ (brackets (make-brackets stacked indices '()))
+ )
- (Text_item::interpret_markup paper props (number->markletter-string num)))
+ (apply ly:stencil-add
+ (append stacked brackets)
+ )))
+
+
+
+
+
+
+
projects / lilypond.git / blobdiff