X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-markup-commands.scm;h=c8e05e405eafed4213c79ef65fb35d9c96446cc1;hb=c9284cfe3b1fa3512f19c4e053077339c20d5662;hp=c0ceebe06cdabadc8737c5e166794313868cf7c8;hpb=537939d12b41820271a4e5506b8e786a66f676fc;p=lilypond.git diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index c0ceebe06c..c8e05e405e 100644 --- a/scm/define-markup-commands.scm +++ b/scm/define-markup-commands.scm @@ -1,57 +1,183 @@ +;;;; define-markup-commands.scm -- markup commands +;;;; +;;;; source file of the GNU LilyPond music typesetter +;;;; +;;;; (c) 2000--2004 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; 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. +(define-public empty-stencil (ly:make-stencil '() '(1 . -1) '(1 . -1))) +(define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0))) -(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)) +(def-markup-command (stencil layout props stil) (ly:stencil?) + "Stencil as markup" + stil) -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; fonts +(def-markup-command (score layout props score) (ly:score?) + "Inline an image of music." + (let* ((systems (ly:score-embedded-format score layout))) -(define (font-markup qualifier value) - (lambda (paper props arg) - (interpret-markup paper - (prepend-alist-chain qualifier value props) - arg))) + (if (= 0 (vector-length systems)) + (begin + (ly:warn "No systems found in \\score markup. Did you forget \\layout?") + empty-markup) + (begin + (let* ((stencil (ly:paper-system-stencil (vector-ref systems 0)))) + (ly:stencil-align-to! stencil Y CENTER) + stencil))))) +(def-markup-command (simple layout props str) (string?) + "A simple text string; @code{\\markup @{ foo @}} is equivalent with +@code{\\markup @{ \\simple #\"foo\" @}}." + (interpret-markup layout props str)) + +(def-markup-command (encoded-simple layout props sym str) (symbol? string?) + "A text string, encoded with encoding @var{sym}. See +@usermanref{Text encoding} for more information." + (Text_interface::interpret_string layout + props sym str)) + + +;; TODO: use font recoding. +;; (make-line-markup +;; (map make-word-markup (string-tokenize str))))) (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}. + +(def-markup-command (postscript layout props str) (string?) + + "This inserts @var{str} directly into the output as a PostScript +command string. Due to technicalities of the output backends, +different scales should be used for the @TeX{} and PostScript backend, +selected with @code{-f}. + + +For the TeX backend, the following string prints a rotated text + +@cindex rotated text + +@verbatim +0 0 moveto /ecrm10 findfont +1.75 scalefont setfont 90 rotate (hello) show +@end verbatim + +@noindent +The magical constant 1.75 scales from LilyPond units (staff spaces) to +TeX dimensions. + +For the postscript backend, use the following + +@verbatim +gsave /ecrm10 findfont + 10.0 output-scale div + scalefont setfont 90 rotate (hello) show grestore +@end verbatim +" + ;; FIXME + + (ly:make-stencil + (list 'embedded-ps str) + '(0 . 0) '(0 . 0) )) + +;;(def-markup-command (fill-line layout props line-width markups) +;; (number? markup-list?) +;; no parser tag -- should make number? markuk-list? thingy +(def-markup-command (fill-line layout 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. + If there are no arguments, return an empty stencil. " + + (let* ((orig-stencils + (map (lambda (x) (interpret-markup layout props x)) + markups)) + (stencils + (map (lambda (stc) + (if (ly:stencil-empty? stc) + point-stencil + stc)) orig-stencils)) + (text-width (apply + + (map (lambda (stc) + (if (ly:stencil-empty? stc) + 0.0 + (interval-length (ly:stencil-extent stc X)))) + stencils))) + (word-count (length stencils)) + (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) + (list + point-stencil + (car stencils) + point-stencil) + stencils))) + + (if (null? (remove ly:stencil-empty? orig-stencils)) + empty-stencil + (stack-stencils X RIGHT fill-space line-stencils)))) + +(define (font-markup qualifier value) + (lambda (layout props arg) + (interpret-markup layout + (prepend-alist-chain qualifier value props) + arg))) + + +(def-markup-command (line layout 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-stencil-line - (cdr (chain-assoc 'word-space props)) - (map (lambda (m) (interpret-markup paper props m)) args))) + (chain-assoc-get 'word-space props) + (map (lambda (m) (interpret-markup layout props m)) args))) -(def-markup-command (combine paper props m1 m2) (markup? markup?) - "Print two markups on top of each other." - (ly:stencil-add - (interpret-markup paper props m1) - (interpret-markup paper props m2))) +(def-markup-command (fromproperty layout props symbol) (symbol?) + "Read the @var{symbol} from property settings, and produce a stencil from the markup contained within. If @var{symbol} is not defined, it returns an empty markup" + (let* ((m (chain-assoc-get symbol props))) + + (if (markup? m) + (interpret-markup layout props m) + (ly:make-stencil '() '(1 . -1) '(1 . -1) )))) + + +(def-markup-command (on-the-fly layout props procedure arg) (symbol? markup?) + "Apply the @var{procedure} markup command to +@var{arg}. @var{procedure} should take a single argument." + (let* ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg)))) + + (set-object-property! anonymous-with-signature + 'markup-signature + (list markup?)) + + (interpret-markup layout props (list anonymous-with-signature arg)))) -(def-markup-command (finger paper props arg) (markup?) +(def-markup-command (combine layout props m1 m2) (markup? markup?) + "Print two markups on top of each other." + (let* ((s1 (interpret-markup layout props m1)) + (s2 (interpret-markup layout props m2))) + + (ly:stencil-add s1 s2))) + +(def-markup-command (finger layout props arg) (markup?) "Set the argument as small numbers." - (interpret-markup paper - (cons '((font-size . -4) (font-family . number)) props) + (interpret-markup layout + (cons '((font-size . -5) (font-encoding . fetaNumber)) props) arg)) - -(def-markup-command (fontsize paper props mag arg) (number? markup?) - "This sets the relative font size, eg. +(def-markup-command (fontsize layout props mag arg) (number? markup?) + "This sets the relative font size, e.g. @example A \\fontsize #2 @{ B C @} D @end example @@ -60,11 +186,11 @@ A \\fontsize #2 @{ B C @} D This will enlarge the B and the C by two steps. " (interpret-markup - paper + layout (prepend-alist-chain 'font-size mag props) arg)) -(def-markup-command (magnify paper props sz arg) (number? markup?) +(def-markup-command (magnify layout props sz arg) (number? markup?) "This sets the font magnification for the its argument. In the following example, the middle A will be 10% larger: @example @@ -75,166 +201,203 @@ Note: magnification only works if a font-name is explicitly selected. Use @code{\\fontsize} otherwise." (interpret-markup - paper + layout (prepend-alist-chain 'font-magnification sz props) arg)) -(def-markup-command (bold paper props arg) (markup?) +(def-markup-command (bold layout props arg) (markup?) "Switch to bold font-series" - (interpret-markup paper (prepend-alist-chain 'font-series 'bold props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg)) -(def-markup-command (sans paper props arg) (markup?) - "Switch to the sans-serif family" - (interpret-markup paper (prepend-alist-chain 'font-family 'sans props) arg)) +(def-markup-command (sans layout props arg) (markup?) + "Switch to the sans serif family" + (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg)) -(def-markup-command (number paper props arg) (markup?) +(def-markup-command (number layout props arg) (markup?) "Set font family to @code{number}, which yields the font used for time signatures and fingerings. This font only contains numbers and some punctuation. It doesn't have any letters. " - (interpret-markup paper (prepend-alist-chain 'font-family 'number props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg)) -(def-markup-command (roman paper props arg) (markup?) +(def-markup-command (roman layout props arg) (markup?) "Set font family to @code{roman}." - (interpret-markup paper (prepend-alist-chain 'font-family 'roman props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg)) -(def-markup-command (huge paper props arg) (markup?) +(def-markup-command (huge layout props arg) (markup?) "Set font size to +2." - (interpret-markup paper (prepend-alist-chain 'font-size 2 props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg)) -(def-markup-command (large paper props arg) (markup?) +(def-markup-command (large layout props arg) (markup?) "Set font size to +1." - (interpret-markup paper (prepend-alist-chain 'font-size 1 props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg)) -(def-markup-command (normalsize paper props arg) (markup?) +(def-markup-command (normalsize layout props arg) (markup?) "Set font size to default." - (interpret-markup paper (prepend-alist-chain 'font-size 0 props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg)) -(def-markup-command (small paper props arg) (markup?) +(def-markup-command (small layout props arg) (markup?) "Set font size to -1." - (interpret-markup paper (prepend-alist-chain 'font-size -1 props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg)) -(def-markup-command (tiny paper props arg) (markup?) +(def-markup-command (tiny layout props arg) (markup?) "Set font size to -2." - (interpret-markup paper (prepend-alist-chain 'font-size -2 props) arg)) + (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg)) -(def-markup-command (teeny paper props arg) (markup?) +(def-markup-command (teeny layout props arg) (markup?) "Set font size to -3." - (interpret-markup paper (prepend-alist-chain 'font-size -3 props) arg)) + (interpret-markup layout (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 (caps layout props arg) (markup?) + "Set @code{font-shape} to @code{caps}." + (interpret-markup layout (prepend-alist-chain 'font-shape 'caps 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 -" + ;(def-markup-command (latin-i layout props arg) (markup?) + ; "TEST latin1 encoding." + ; (interpret-markup layout (prepend-alist-chain 'font-shape 'latin1 props) arg)) + +(def-markup-command (dynamic layout props arg) (markup?) + "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 ``pi@`{u} @b{f}'', the +normal words (like ``pi@`{u}'') 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)) + layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg)) -(def-markup-command (italic paper props arg) (markup?) - (interpret-markup paper (prepend-alist-chain 'font-shape 'italic props) arg)) +(def-markup-command (italic layout props arg) (markup?) + "Use italic @code{font-shape} for @var{arg}. " + (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg)) -(def-markup-command (typewriter paper props arg) (markup?) +(def-markup-command (typewriter layout props arg) (markup?) + "Use @code{font-family} typewriter for @var{arg}." (interpret-markup - paper (prepend-alist-chain 'font-family 'typewriter props) arg)) + layout (prepend-alist-chain 'font-family 'typewriter props) arg)) -(def-markup-command (upright paper props arg) (markup?) +(def-markup-command (upright layout 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) () - (interpret-markup paper props (markup #:musicglyph "accidentals-4"))) -(def-markup-command (threeqsharp paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals-3"))) -(def-markup-command (sharp paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals-2"))) -(def-markup-command (semisharp paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals-1"))) -(def-markup-command (natural paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals-0"))) -(def-markup-command (semiflat paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals--1"))) -(def-markup-command (flat paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals--2"))) -(def-markup-command (threeqflat paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals--3"))) -(def-markup-command (doubleflat paper props) () - (interpret-markup paper props (markup #:musicglyph "accidentals--4"))) - - -(def-markup-command (column paper props args) (markup-list?) + layout (prepend-alist-chain 'font-shape 'upright props) arg)) + +(def-markup-command (doublesharp layout props) () + "Draw a double sharp symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals-4"))) +(def-markup-command (sesquisharp layout props) () + "Draw a 3/2 sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals-3"))) + +(def-markup-command (sharp layout props) () + "Draw a sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals-2"))) +(def-markup-command (semisharp layout props) () + "Draw a semi sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals-1"))) +(def-markup-command (natural layout props) () + "Draw a natural symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals-0"))) +(def-markup-command (semiflat layout props) () + "Draw a semiflat." + (interpret-markup layout props (markup #:musicglyph "accidentals--1"))) +(def-markup-command (flat layout props) () + "Draw a flat symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals--2"))) +(def-markup-command (sesquiflat layout props) () + "Draw a 3/2 flat symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals--3"))) +(def-markup-command (doubleflat layout props) () + "Draw a double flat symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals--4"))) + + +(def-markup-command (column layout props args) (markup-list?) + "Stack the markups in @var{args} vertically. The property +@code{baseline-skip} determines the space between each markup in @var{args}." (stack-lines - -1 0.0 (cdr (chain-assoc 'baseline-skip props)) - (map (lambda (m) (interpret-markup paper props m)) args))) + -1 0.0 (chain-assoc-get 'baseline-skip props) + (remove ly:stencil-empty? + (map (lambda (m) (interpret-markup layout props m)) args)))) -(def-markup-command (dir-column paper props args) (markup-list?) +(def-markup-command (dir-column layout 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)) - (map (lambda (x) (interpret-markup paper props x)) args)))) + (chain-assoc-get 'baseline-skip props) + (map (lambda (x) (interpret-markup layout props x)) args)))) -(def-markup-command (center paper props args) (markup-list?) - (let* ((mols (map (lambda (x) (interpret-markup paper props x)) args)) +(def-markup-command (center-align layout props args) (markup-list?) + "Put @code{args} in a centered column. " + (let* ((mols (map (lambda (x) (interpret-markup layout props x)) args)) (cmols (map (lambda (x) (ly:stencil-align-to! x X CENTER)) mols))) - (stack-lines -1 0.0 (cdr (chain-assoc 'baseline-skip props)) mols))) + (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) cmols))) -(def-markup-command (right-align paper props arg) (markup?) - (let* ((m (interpret-markup paper props arg))) +(def-markup-command (vcenter layout props arg) (markup?) + "Align @code{arg} to its center. " + (let* ((mol (interpret-markup layout props arg))) + (ly:stencil-align-to! mol Y CENTER) + mol)) + +(def-markup-command (right-align layout props arg) (markup?) + (let* ((m (interpret-markup layout props arg))) (ly:stencil-align-to! m X RIGHT) m)) -(def-markup-command (left-align paper props arg) (markup?) - (let* ((m (interpret-markup paper props arg))) +(def-markup-command (left-align layout props arg) (markup?) + "Align @var{arg} on its left edge. " + + (let* ((m (interpret-markup layout props arg))) (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." +(def-markup-command (general-align layout props axis dir arg) (integer? number? markup?) + "Align @var{arg} in @var{axis} direction to the @var{dir} side." + (let* ((m (interpret-markup layout props arg))) + + (ly:stencil-align-to! m axis dir) + m)) + +(def-markup-command (halign layout props dir arg) (number? markup?) + "Set horizontal alignment. If @var{dir} is @code{-1}, then it is +left-aligned, while @code{+1} is right. Values in between interpolate +alignment accordingly." - (let* ((m (interpret-markup paper props arg))) + (let* ((m (interpret-markup layout props arg))) (ly:stencil-align-to! m X dir) m)) -(def-markup-command (musicglyph paper props glyph-name) (string?) +(def-markup-command (musicglyph layout props glyph-name) (string?) "This is converted to a musical symbol, e.g. @code{\\musicglyph #\"accidentals-0\"} will select the natural sign from the music font. 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)) - props)) + (ly:font-get-glyph + (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) + props)) glyph-name)) -(def-markup-command (lookup paper props glyph-name) (string?) +(def-markup-command (lookup layout props glyph-name) (string?) "Lookup a glyph by name." - (ly:find-glyph-by-name (ly:paper-get-font paper props) - glyph-name)) + (ly:font-get-glyph (ly:paper-get-font layout props) + glyph-name)) -(def-markup-command (char paper props num) (integer?) - "This produces a single character, e.g. @code{\\char #65} produces the +(def-markup-command (char layout props num) (integer?) + "Produce a single character, e.g. @code{\\char #65} produces the letter 'A'." - (ly:get-glyph (ly:paper-get-font paper props) num)) + (ly:get-glyph (ly:paper-get-font layout props) num)) -(def-markup-command (raise paper props amount arg) (number? markup?) +(def-markup-command (raise layout props amount arg) (number? markup?) " 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, @@ -248,19 +411,18 @@ positions it next to the staff cancels any shift made with and/or @code{extra-offset} properties. " - (ly:stencil-translate-axis (interpret-markup paper props arg) - amount Y)) + (ly:stencil-translate-axis (interpret-markup layout props arg) + amount Y)) -(def-markup-command (fraction paper props arg1 arg2) (markup? markup?) - "Make a fraction of two markups. - -Syntax: \\fraction MARKUP1 MARKUP2." - (let* ((m1 (interpret-markup paper props arg1)) - (m2 (interpret-markup paper props arg2))) +(def-markup-command (fraction layout props arg1 arg2) (markup? markup?) + "Make a fraction of two markups." + + (let* ((m1 (interpret-markup layout props arg1)) + (m2 (interpret-markup layout props arg2))) (ly:stencil-align-to! m1 X CENTER) (ly:stencil-align-to! m2 X CENTER) - (let* ((x1 (ly:stencil-get-extent m1 X)) - (x2 (ly:stencil-get-extent m2 X)) + (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)))) @@ -273,28 +435,30 @@ Syntax: \\fraction MARKUP1 MARKUP2." ;; 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))) - (stemlen (max 3 (- log 1))) - (headgl (ly:find-glyph-by-name - font - (string-append "noteheads-" (number->string (min log 2))))) - (stemth 0.13) - (stemy (* dir stemlen)) +(def-markup-command (note-by-number layout props log dot-count dir) (number? number? number?) + "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 layout (cons '((font-encoding . fetaMusic)) props))) + (size (chain-assoc-get 'font-size props 0)) + (stem-length (* (magstep size) (max 3 (- log 1)))) + (head-glyph (ly:font-get-glyph + font + (string-append "noteheads-s" (number->string (min log 2))))) + (stem-thickness 0.13) + (stemy (* dir stem-length)) (attachx (if (> dir 0) - (- (cdr (ly:stencil-get-extent headgl X)) stemth) + (- (cdr (ly:stencil-extent head-glyph X)) stem-thickness) 0)) (attachy (* dir 0.28)) - (stemgl (and (> log 0) - (ly:round-filled-box - (cons attachx (+ attachx stemth)) - (cons (min stemy attachy) - (max stemy attachy)) - (/ stemth 3)))) - (dot (ly:find-glyph-by-name font "dots-dot")) - (dotwid (interval-length (ly:stencil-get-extent dot X))) + (stem-glyph (and (> log 0) + (ly:round-filled-box + (cons attachx (+ attachx stem-thickness)) + (cons (min stemy attachy) + (max stemy attachy)) + (/ stem-thickness 3)))) + (dot (ly:font-get-glyph font "dots-dot")) + (dotwid (interval-length (ly:stencil-extent dot X))) (dots (and (> dot-count 0) (apply ly:stencil-add (map (lambda (x) @@ -303,29 +467,29 @@ for DIR, you can obtain longer or shorter stems." (iota dot-count 1))))) (flaggl (and (> log 2) (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))))) + (ly:font-get-glyph font + (string-append "flags-" + (if (> dir 0) "u" "d") + (number->string log))) + (cons (+ attachx (/ stem-thickness 2)) stemy))))) (if flaggl - (set! stemgl (ly:stencil-add flaggl stemgl))) - (if (ly:stencil? stemgl) - (set! stemgl (ly:stencil-add stemgl headgl)) - (set! stemgl headgl)) + (set! stem-glyph (ly:stencil-add flaggl stem-glyph))) + (if (ly:stencil? stem-glyph) + (set! stem-glyph (ly:stencil-add stem-glyph head-glyph)) + (set! stem-glyph head-glyph)) (if (ly:stencil? dots) - (set! stemgl + (set! stem-glyph (ly:stencil-add (ly:stencil-translate-axis dots - (+ (if (and (> dir 0) (> log 2)) - (* 1.5 dotwid) - 0) - ;; huh ? why not necessary? - ;;(cdr (ly:stencil-get-extent headgl X)) - dotwid) - X) - stemgl))) - stemgl)) + (+ (if (and (> dir 0) (> log 2)) + (* 1.5 dotwid) + 0) + ;; huh ? why not necessary? + ;;(cdr (ly:stencil-extent head-glyph X)) + dotwid) + X) + stem-glyph))) + stem-glyph)) (use-modules (ice-9 regex)) @@ -334,7 +498,7 @@ for DIR, you can obtain longer or shorter stems." (lambda (z) (inexact->exact (/ (log z) divisor))))) (define (parse-simple-duration duration-string) - "Parse the `duration-string', eg ''4..'' or ''breve.'', and return a (log dots) list." + "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list." (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string))) (if (and match (string=? duration-string (match:substring match 0))) (let ((len (match:substring match 1)) @@ -346,24 +510,25 @@ for DIR, you can obtain longer or shorter stems." (if dots (string-length dots) 0))) (error "This is not a valid duration string:" duration-string)))) -(def-markup-command (note paper props duration dir) (string? number?) +(def-markup-command (note layout props duration dir) (string? number?) "This produces a note with a stem pointing in @var{dir} direction, with the @var{duration} for the note head type and augmentation dots. For example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with a shortened down stem." (let ((parsed (parse-simple-duration duration))) - (note-by-number-markup paper props (car parsed) (cadr parsed) dir))) + (note-by-number-markup layout props (car parsed) (cadr parsed) dir))) -(def-markup-command (normal-size-super paper props arg) (markup?) - "A superscript which does not use a smaller font." +(def-markup-command (normal-size-super layout props arg) (markup?) + "Set @var{arg} in superscript with a normal font size." + (ly:stencil-translate-axis (interpret-markup - paper - props arg) - (* 0.5 (cdr (chain-assoc 'baseline-skip props))) - Y)) + layout + props arg) + (* 0.5 (chain-assoc-get 'baseline-skip props)) + Y)) -(def-markup-command (super paper props arg) (markup?) +(def-markup-command (super layout props arg) (markup?) " @cindex raising text @cindex lowering text @@ -384,13 +549,13 @@ Raising and lowering texts can be done with @code{\\super} and (ly:stencil-translate-axis (interpret-markup - paper + layout (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?) +(def-markup-command (translate layout props offset arg) (number-pair? markup?) "This translates an object. Its first argument is a cons of numbers @example A \\translate #(cons 2 -3) @{ B C @} D @@ -400,40 +565,44 @@ surroundings. This command cannot be used to move isolated scripts vertically, for the same reason that @code{\\raise} cannot be used for that. -. " - (ly:stencil-translate (interpret-markup paper props arg) - offset)) +" + + (ly:stencil-translate (interpret-markup layout props arg) + offset)) -(def-markup-command (sub paper props arg) (markup?) - "Syntax: \\sub MARKUP." +(def-markup-command (sub layout props arg) (markup?) + "Set @var{arg} in subscript." + (ly:stencil-translate-axis (interpret-markup - paper + layout (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?) +(def-markup-command (normal-size-sub layout props arg) (markup?) + "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))) + (interpret-markup layout props arg) + (* -0.5 (chain-assoc-get 'baseline-skip props)) Y)) -(def-markup-command (hbracket paper props arg) (markup?) - "Horizontal brackets around @var{arg}." +(def-markup-command (hbracket layout props arg) (markup?) + "Draw horizontal brackets around @var{arg}." (let ((th 0.1) ;; todo: take from GROB. - (m (interpret-markup paper props arg))) + (m (interpret-markup layout props arg))) (bracketify-stencil m X th (* 2.5 th) th))) -(def-markup-command (bracket paper props arg) (markup?) - "Vertical brackets around @var{arg}." +(def-markup-command (bracket layout props arg) (markup?) + "Draw vertical brackets around @var{arg}." (let ((th 0.1) ;; todo: take from GROB. - (m (interpret-markup paper props arg))) + (m (interpret-markup layout props arg))) (bracketify-stencil m Y th (* 2.5 th) th))) ;; todo: fix negative space -(def-markup-command (hspace paper props amount) (number?) +(def-markup-command (hspace layout props amount) (number?) "This produces a invisible object taking horizontal space. @example \\markup @{ A \\hspace #2.0 B @} @@ -445,7 +614,7 @@ normally inserted before elements on a line. (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?) +(def-markup-command (override layout props new-prop arg) (pair? markup?) "Add the first argument in to the property list. Properties may be any sort of property supported by @internalsref{font-interface} and @internalsref{text-interface}, for example @@ -455,40 +624,39 @@ any sort of property supported by @internalsref{font-interface} and @end verbatim " - (interpret-markup paper (cons (list new-prop) props) arg)) + (interpret-markup layout (cons (list new-prop) props) arg)) -(def-markup-command (smaller paper props arg) (markup?) +(def-markup-command (smaller layout 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)))) - (interpret-markup paper (cons (list entry) props) arg))) + (entry (cons 'font-size (- fs 1)))) + (interpret-markup layout (cons (list entry) props) arg))) -(def-markup-command (bigger paper props arg) (markup?) +(def-markup-command (bigger layout props arg) (markup?) "Increase the font size relative to current setting" (let* ((fs (chain-assoc-get 'font-size props 0)) (entry (cons 'font-size (+ fs 1)))) - (interpret-markup paper (cons (list entry) props) arg))) + (interpret-markup layout (cons (list entry) props) arg))) (def-markup-command larger (markup?) bigger-markup) -(def-markup-command (box paper props arg) (markup?) - "Draw a box round @var{arg}" - - (let ((th 0.1) - (pad 0.2) - (m (interpret-markup paper props arg))) +(def-markup-command (box layout props arg) (markup?) + "Draw a box round @var{arg}. Looks at @code{thickness} and +@code{box-padding} properties to determine line thickness and padding +around the markup." + (let ((th (chain-assoc-get 'thickness props 0.1)) + (pad (chain-assoc-get 'box-padding props 0.2)) + (m (interpret-markup layout props arg))) (box-stencil m th pad))) -(def-markup-command (strut paper props) () +;;FIXME: is this working? +(def-markup-command (strut layout props) () - "Create a box of the same height as the space in the current font. - -FIXME: is this working? -" + "Create a box of the same height as the space in the current font." - (let ((m (Text_item::interpret_markup paper props " "))) + (let ((m (Text_interface::interpret_markup layout props " "))) (ly:stencil-set-extent! m X '(1000 . -1000)) m)) @@ -504,17 +672,84 @@ FIXME: is this working? (define (number->markletter-string n) "Double letters for big marks." - (let* - ((l (vector-length number->mark-letter-vector))) + (let* ((lst (vector-length number->mark-letter-vector))) - (if (>= n l) - (string-append (number->markletter-string (1- (quotient n l))) - (number->markletter-string (remainder n l))) - (make-string 1 (vector-ref number->mark-letter-vector n))))) + (if (>= n lst) + (string-append (number->markletter-string (1- (quotient n lst))) + (number->markletter-string (remainder n lst))) + (make-string 1 (vector-ref number->mark-letter-vector n))))) -(def-markup-command (markletter paper props num) (integer?) - "Make a markup letter for @var{num}. The letters start with A to Z +(def-markup-command (markletter layout props num) (integer?) + "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))) + + (Text_interface::interpret_markup layout props (number->markletter-string num))) + + +(def-markup-command (bracketed-y-column layout 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 lst start stop) + (take (drop lst 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 + layout + props + x)) args)) + (leading + (chain-assoc-get 'baseline-skip props)) + (stacked (stack-stencils stencils 1.25 #f)) + (brackets (make-brackets stacked indices '()))) + + (apply ly:stencil-add + (append stacked brackets))))