X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-markup-commands.scm;h=9ddfa4982096cf906a1c99f26c5eacb8e111251e;hb=5bc67e225f0f7f25c658013c0757a36ccdb069a4;hp=f65cb8675f126f143f1e561af4f9e2a3d0a58c69;hpb=9dad21216e9f843ae1cfe9ffae916e6ee379e1a6;p=lilypond.git diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index f65cb8675f..9ddfa49820 100644 --- a/scm/define-markup-commands.scm +++ b/scm/define-markup-commands.scm @@ -2,7 +2,7 @@ ;;;; ;;;; source file of the GNU LilyPond music typesetter ;;;; -;;;; (c) 2000--2006 Han-Wen Nienhuys +;;;; (c) 2000--2007 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen @@ -19,19 +19,55 @@ (define-public empty-stencil (ly:make-stencil '() '(1 . -1) '(1 . -1))) (define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; geometric shapes ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (draw-circle layout props radius thickness fill) +(define-builtin-markup-command (draw-line layout props dest) + (number-pair?) + " +@cindex drawing lines within text + +A simple line. Uses the @code{thickness} property." + (let* + ((th (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) + (x (car dest)) + (y (cdr dest)) + (s (ly:make-stencil + `(draw-line + ,th + 0 0 + ,x ,y) + + (cons (min x 0) (max x 0)) + (cons (min y 0) (max y 0))))) + + s)) + +(define-builtin-markup-command (draw-circle layout props radius thickness fill) (number? number? boolean?) - "A circle of radius @var{radius}, thickness @var{thickness} and -optionally filled." + " +@cindex drawing circles within text + +A circle of radius @var{radius}, thickness @var{thickness} and +optionally filled. +@c +@lilypond[verbatim,quote] +\\markup { \\draw-circle #2 #0.5 ##f \\hspace #2 \\draw-circle #2 #0 ##t } +@end lilypond" (make-circle-stencil radius thickness fill)) -(define-markup-command (triangle layout props filled) (boolean?) - "A triangle, filled or not" +(define-builtin-markup-command (triangle layout props filled) (boolean?) + " +@cindex drawing triangles within text + +A triangle, either filled or empty. +@c +@lilypond[verbatim,quote] +\\markup { \\triangle ##f \\triangle ##t } +@end lilypond" (let* ((th (chain-assoc-get 'thickness props 0.1)) (size (chain-assoc-get 'font-size props 0)) @@ -51,12 +87,17 @@ optionally filled." (cons 0 (* .86 ex)) ))) -(define-markup-command (circle layout props arg) (markup?) - "Draw a circle around @var{arg}. Use @code{thickness}, +(define-builtin-markup-command (circle layout props arg) (markup?) + " +@cindex circling text + +Draw a circle around @var{arg}. Use @code{thickness}, @code{circle-padding} and @code{font-size} properties to determine line thickness and padding around the markup." - (let* ((th (chain-assoc-get 'thickness props 0.1)) + (let* ((th + (* (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) (size (chain-assoc-get 'font-size props 0)) (pad (* (magstep size) @@ -64,20 +105,33 @@ thickness and padding around the markup." (m (interpret-markup layout props arg))) (circle-stencil m th pad))) -(define-markup-command (with-url layout props url arg) (string? markup?) - "Add a link to URL @var{url} around @var{arg}. This only works in -the PDF backend." +(define-builtin-markup-command (with-url layout props url arg) (string? markup?) + " +@cindex inserting URL links into text + +Add a link to URL @var{url} around @var{arg}. This only works in +the PDF backend. +@lilypond[verbatim,quote] +\\markup { + \\with-url #\"http://lilypond.org/web/\" { + LilyPond ... \\italic \"music notation for everyone\" + } +} +@end lilypond" (let* ((stil (interpret-markup layout props arg)) (xextent (ly:stencil-extent stil X)) (yextent (ly:stencil-extent stil Y)) (old-expr (ly:stencil-expr stil)) (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent)))) - (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil))) + (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil))) -(define-markup-command (beam layout props width slope thickness) +(define-builtin-markup-command (beam layout props width slope thickness) (number? number? number?) - "Create a beam with the specified parameters." + " +@cindex drawing beams within text + +Create a beam with the specified parameters." (let* ((y (* slope width)) (yext (cons (min 0 y) (max 0 y))) (half (/ thickness 2))) @@ -94,44 +148,97 @@ the PDF backend." (cons (+ (- half) (car yext)) (+ half (cdr yext)))))) -(define-markup-command (box layout props arg) (markup?) - "Draw a box round @var{arg}. Looks at @code{thickness}, +(define-builtin-markup-command (underline layout props arg) (markup?) + " +@cindex underlining text + +Underline @var{arg}. Looks at @code{thickness} to determine line +thickness and y offset." + (let* ((thick (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) + (markup (interpret-markup layout props arg)) + (x1 (car (ly:stencil-extent markup X))) + (x2 (cdr (ly:stencil-extent markup X))) + (y (* thick -2)) + (line (ly:make-stencil + `(draw-line ,thick ,x1 ,y ,x2 ,y) + (cons (min x1 0) (max x2 0)) + (cons thick thick)))) + (ly:stencil-add markup line))) + +(define-builtin-markup-command (box layout props arg) (markup?) + " +@cindex enclosing text within a box + +Draw a box round @var{arg}. Looks at @code{thickness}, @code{box-padding} and @code{font-size} properties to determine line -thickness and padding around the markup." - - (let* ((th (chain-assoc-get 'thickness props 0.1)) +thickness and padding around the markup." + (let* ((th (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) (size (chain-assoc-get 'font-size props 0)) (pad (* (magstep size) (chain-assoc-get 'box-padding props 0.2))) (m (interpret-markup layout props arg))) (box-stencil m th pad))) -(define-markup-command (filled-box layout props xext yext blot) +(define-builtin-markup-command (filled-box layout props xext yext blot) (number-pair? number-pair? number?) - "Draw a box with rounded corners of dimensions @var{xext} and + " +@cindex drawing solid boxes within text +@cindex drawing boxes with rounded corners + +Draw a box with rounded corners of dimensions @var{xext} and @var{yext}. For example, @verbatim \\filled-box #'(-.3 . 1.8) #'(-.3 . 1.8) #0 @end verbatim -create a box extending horizontally from -0.3 to 1.8 and +creates a box extending horizontally from -0.3 to 1.8 and vertically from -0.3 up to 1.8, with corners formed from a -circle of diameter 0 (ie sharp corners)." +circle of diameter@tie{}0 (i.e. sharp corners)." (ly:round-filled-box xext yext blot)) -(define-markup-command (rotate layout props ang arg) (number? markup?) - "Rotate object with @var{ang} degrees around its center." +(define-builtin-markup-command (rounded-box layout props arg) (markup?) + "@cindex enclosing text in a bow with rounded corners + @cindex drawing boxes with rounded corners around text +Draw a box with rounded corners around @var{arg}. Looks at @code{thickness}, +@code{box-padding} and @code{font-size} properties to determine line +thickness and padding around the markup; the @code{corner-radius} property +makes possible to define another shape for the corners (default is 1)." + (let* ((th (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) + (rad (chain-assoc-get 'corner-radius props 1)) + (size (chain-assoc-get 'font-size props 0)) + (pad (* (magstep size) + (chain-assoc-get 'box-padding props 0.5))) + (m (interpret-markup layout props arg))) + (ly:stencil-add (rounded-box-stencil m th pad rad) + m))) + +(define-builtin-markup-command (rotate layout props ang arg) (number? markup?) + " +@cindex rotating text + +Rotate object with @var{ang} degrees around its center." (let* ((stil (interpret-markup layout props arg))) (ly:stencil-rotate stil ang 0 0))) +(define-builtin-markup-command (whiteout layout props arg) (markup?) + " +@cindex adding a white background to text -(define-markup-command (whiteout layout props arg) (markup?) - "Provide a white underground for @var{arg}" +Provide a white background for @var{arg}." (stencil-whiteout (interpret-markup layout props arg))) -(define-markup-command (pad-markup layout props padding arg) (number? markup?) - "Add space around a markup object." +(define-builtin-markup-command (pad-markup layout props padding arg) (number? markup?) + " +@cindex padding text +@cindex putting space around text +Add space around a markup object." (let* ((stil (interpret-markup layout props arg)) (xext (ly:stencil-extent stil X)) @@ -146,25 +253,31 @@ circle of diameter 0 (ie sharp corners)." ;; space ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;;FIXME: is this working? -(define-markup-command (strut layout props) () - "Create a box of the same height as the space in the current font." +(define-builtin-markup-command (strut layout props) () + " +@cindex creating vertical spaces in text + +Create a box of the same height as the space in the current font." (let ((m (ly:text-interface::interpret-markup layout props " "))) (ly:make-stencil (ly:stencil-expr m) - '(1000 . -1000) + '(0 . 0) (ly:stencil-extent m X) ))) - ;; todo: fix negative space -(define-markup-command (hspace layout props amount) (number?) - "This produces a invisible object taking horizontal space. +(define-builtin-markup-command (hspace layout props amount) (number?) + " +@cindex creating horizontal spaces in text + +This produces a invisible object taking horizontal space. For example, + @example \\markup @{ A \\hspace #2.0 B @} @end example -will put extra space between A and B, on top of the space that is -normally inserted before elements on a line. -" + +@noindent +puts extra space between A and@tie{}B, on top of the space that is +normally inserted before elements on a line." (if (> amount 0) (ly:make-stencil "" (cons 0 amount) '(-1 . 1)) (ly:make-stencil "" (cons amount amount) '(-1 . 1)))) @@ -174,8 +287,11 @@ normally inserted before elements on a line. ;; importing graphics. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (stencil layout props stil) (ly:stencil?) - "Stencil as markup" +(define-builtin-markup-command (stencil layout props stil) (ly:stencil?) + " +@cindex importing stencils into text + +Use a stencil as markup." stil) (define bbox-regexp @@ -193,44 +309,44 @@ normally inserted before elements on a line. #f))) -(define-markup-command (epsfile layout props axis size file-name) (number? number? string?) - "Inline an EPS image. The image is scaled along @var{axis} to -@var{size}." +(define-builtin-markup-command (epsfile layout props axis size file-name) (number? number? string?) + " +@cindex inlining an Encapsulated PostScript image +Inline an EPS image. The image is scaled along @var{axis} to +@var{size}." (if (ly:get-option 'safe) (interpret-markup layout props "not allowed in safe") (eps-file->stencil axis size file-name) )) -(define-markup-command (postscript layout props str) (string?) - "This inserts @var{str} directly into the output as a PostScript +(define-builtin-markup-command (postscript layout props str) (string?) + " +@cindex inserting PostScript directly into text + +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 -For the TeX backend, the following string prints a rotated text - -@cindex rotated text - -@verbatim +@example 0 0 moveto /ecrm10 findfont 1.75 scalefont setfont 90 rotate (hello) show -@end verbatim +@end example @noindent The magical constant 1.75 scales from LilyPond units (staff spaces) to -TeX dimensions. +@TeX{} dimensions. For the postscript backend, use the following -@verbatim +@example gsave /ecrm10 findfont 10.0 output-scale div scalefont setfont 90 rotate (hello) show grestore -@end verbatim -" - +@end example" ;; FIXME (ly:make-stencil (list 'embedded-ps @@ -243,9 +359,11 @@ grestore str)) '(0 . 0) '(0 . 0))) +(define-builtin-markup-command (score layout props score) (ly:score?) + " +@cindex inserting music into text -(define-markup-command (score layout props score) (ly:score?) - "Inline an image of music." +Inline an image of music." (let* ((output (ly:score-embedded-format score layout))) (if (ly:music-output? output) @@ -255,26 +373,30 @@ grestore (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?")) empty-stencil)))) -(define-markup-command (null layout props) () - "An empty markup with extents of a single point" +(define-builtin-markup-command (null layout props) () + " +@cindex creating empty text objects +An empty markup with extents of a single point." point-stencil) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; basic formatting. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(define-builtin-markup-command (simple layout props str) (string?) + " +@cindex simple text strings - -(define-markup-command (simple layout props str) (string?) - "A simple text string; @code{\\markup @{ foo @}} is equivalent with +A simple text string; @code{\\markup @{ foo @}} is equivalent with @code{\\markup @{ \\simple #\"foo\" @}}." (interpret-markup layout props str)) -(define-markup-command (tied-lyric layout props str) (string?) - - "Like simple-markup, but use tie characters for ~ tilde symbols." +(define-builtin-markup-command (tied-lyric layout props str) (string?) + " +@cindex simple text strings with tie characters +Like simple-markup, but use tie characters for @q{~} tilde symbols." (if (string-contains str "~") (let* ((parts (string-split str #\~)) @@ -292,11 +414,6 @@ grestore ;(map (lambda (s) (interpret-markup layout props s)) parts)) (interpret-markup layout props str))) - -;; TODO: use font recoding. -;; (make-line-markup -;; (map make-word-markup (string-tokenize str))))) - (define-public empty-markup (make-simple-markup "")) @@ -308,8 +425,7 @@ grestore padding = line-width/(word-count - 1) - (length(a) + length(b))/2 The first and last padding have to be calculated specially using the whole length of the first or last text. - Return a list of paddings. -" + Return a list of paddings." (cond ((null? text-widths) '()) @@ -329,15 +445,13 @@ grestore (/ (+ (car text-widths) (car (cdr text-widths))) 2)) (get-fill-space word-count line-width (cdr text-widths)))))) -(define-markup-command (fill-line layout props markups) +(define-builtin-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." +The markups are spaced or 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)) + (let* ((orig-stencils (interpret-markup-list layout props markups)) (stencils (map (lambda (stc) (if (ly:stencil-empty? stc) @@ -389,29 +503,31 @@ grestore (stack-stencils-padding-list X RIGHT fill-space-normal line-stencils)))) -(define-markup-command (line layout props args) (markup-list?) +(define-builtin-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}." (let* - ((stencils (map (lambda (m) (interpret-markup layout props m)) args)) + ((stencils (interpret-markup-list layout props args)) (space (chain-assoc-get 'word-space props)) (text-dir (chain-assoc-get 'text-direction props RIGHT)) ) (if (= text-dir LEFT) - (set! stencils (reverse stencils))) - + (set! stencils (reverse stencils))) (stack-stencil-line space (remove ly:stencil-empty? stencils)))) -(define-markup-command (concat layout props args) (markup-list?) - "Concatenate @var{args} in a horizontal line, without spaces inbetween. +(define-builtin-markup-command (concat layout props args) (markup-list?) + " +@cindex concatenating text +@cindex ligatures in text + +Concatenate @var{args} in a horizontal line, without spaces inbetween. Strings and simple markups are concatenated on the input level, allowing ligatures. For example, @code{\\concat @{ \"f\" \\simple #\"i\" @}} is equivalent to @code{\"fi\"}." - (define (concat-string-args arg-list) (fold-right (lambda (arg result-list) (let ((result (if (pair? result-list) @@ -427,13 +543,13 @@ equivalent to @code{\"fi\"}." (interpret-markup layout (prepend-alist-chain 'word-space 0 props) - (make-line-markup (concat-string-args args)))) + (make-line-markup (if (markup-command-list? args) + args + (concat-string-args args))))) (define (wordwrap-stencils stencils - justify base-space line-width text-dir) - - "Perform simple wordwrap, return stencil of each line." - + justify base-space line-width text-dir) + "Perform simple wordwrap, return stencil of each line." (define space (if justify ;; justify only stretches lines. @@ -506,36 +622,33 @@ equivalent to @code{\"fi\"}." )) - (define (wordwrap-markups layout props args justify) (let* - ((baseline-skip (chain-assoc-get 'baseline-skip props)) - (prop-line-width (chain-assoc-get 'line-width props #f)) + ((prop-line-width (chain-assoc-get 'line-width props #f)) (line-width (if prop-line-width prop-line-width (ly:output-def-lookup layout 'line-width))) (word-space (chain-assoc-get 'word-space props)) - (text-dir (chain-assoc-get 'text-direction props RIGHT)) - (lines (wordwrap-stencils - (remove ly:stencil-empty? - (map (lambda (m) (interpret-markup layout props m)) args)) - justify word-space line-width - text-dir) - )) + (text-dir (chain-assoc-get 'text-direction props RIGHT))) + (wordwrap-stencils (remove ly:stencil-empty? + (interpret-markup-list layout props args)) + justify word-space line-width + text-dir))) - (stack-lines DOWN 0.0 baseline-skip lines))) - -(define-markup-command (justify layout props args) (markup-list?) - "Like wordwrap, but with lines stretched to justify the margins. -Use @code{\\override #'(line-width . X)} to set line-width, where X -is the number of staff spaces." - - (wordwrap-markups layout props args #t)) +(define-builtin-markup-command (justify layout props args) (markup-list?) + " +@cindex justifying text -(define-markup-command (wordwrap layout props args) (markup-list?) - "Simple wordwrap. Use @code{\\override #'(line-width . X)} to set -line-width, where X is the number of staff spaces." +Like wordwrap, but with lines stretched to justify the margins. +Use @code{\\override #'(line-width . @var{X})} to set the line width; +@var{X}@tie{}is the number of staff spaces." + (stack-lines DOWN 0.0 (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #t))) - (wordwrap-markups layout props args #f)) +(define-builtin-markup-command (wordwrap layout props args) (markup-list?) + "Simple wordwrap. Use @code{\\override #'(line-width . @var{X})} to set +the line width, where @var{X} is the number of staff spaces." + (stack-lines DOWN 0.0 (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #f))) (define (wordwrap-string layout props justify arg) (let* @@ -571,34 +684,35 @@ line-width, where X is the number of staff spaces." (stack-lines DOWN 0.0 baseline-skip (apply append para-lines)))) - -(define-markup-command (wordwrap-string layout props arg) (string?) - "Wordwrap a string. Paragraphs may be separated with double newlines" +(define-builtin-markup-command (wordwrap-string layout props arg) (string?) + "Wordwrap a string. Paragraphs may be separated with double newlines." (wordwrap-string layout props #f arg)) -(define-markup-command (justify-string layout props arg) (string?) - "Justify a string. Paragraphs may be separated with double newlines" +(define-builtin-markup-command (justify-string layout props arg) (string?) + "Justify a string. Paragraphs may be separated with double newlines" (wordwrap-string layout props #t arg)) +(define-builtin-markup-command (wordwrap-field layout props symbol) (symbol?) + "Wordwrap the data which has been assigned to @var{symbol}." + (let* ((m (chain-assoc-get symbol props))) + (if (string? m) + (interpret-markup layout props + (list wordwrap-string-markup m)) + empty-stencil))) -(define-markup-command (wordwrap-field layout props symbol) (symbol?) - (let* ((m (chain-assoc-get symbol props))) - (if (string? m) - (interpret-markup layout props - (list wordwrap-string-markup m)) - (ly:make-stencil '() '(1 . -1) '(1 . -1))))) - -(define-markup-command (justify-field layout props symbol) (symbol?) - (let* ((m (chain-assoc-get symbol props))) - (if (string? m) - (interpret-markup layout props - (list justify-string-markup m)) - (ly:make-stencil '() '(1 . -1) '(1 . -1))))) - +(define-builtin-markup-command (justify-field layout props symbol) (symbol?) + "Justify the data which has been assigned to @var{symbol}." + (let* ((m (chain-assoc-get symbol props))) + (if (string? m) + (interpret-markup layout props + (list justify-string-markup m)) + empty-stencil))) +(define-builtin-markup-command (combine layout props m1 m2) (markup? markup?) + " +@cindex merging text -(define-markup-command (combine layout props m1 m2) (markup? markup?) - "Print two markups on top of each other." +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))) @@ -606,82 +720,103 @@ line-width, where X is the number of staff spaces." ;; ;; TODO: should extract baseline-skip from each argument somehow.. ;; -(define-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}." +(define-builtin-markup-command (column layout props args) (markup-list?) + " +@cindex stacking text in a column +Stack the markups in @var{args} vertically. The property +@code{baseline-skip} determines the space between each markup in @var{args}." (let* - ((arg-stencils (map (lambda (m) (interpret-markup layout props m)) args)) + ((arg-stencils (interpret-markup-list layout props args)) (skip (chain-assoc-get 'baseline-skip props))) - (stack-lines -1 0.0 skip (remove ly:stencil-empty? arg-stencils)))) +(define-builtin-markup-command (dir-column layout props args) (markup-list?) + " +@cindex changing direction of text columns -(define-markup-command (dir-column layout props args) (markup-list?) - "Make a column of args, going up or down, depending on the setting +Make a column of args, going up or down, depending on the setting of the @code{#'direction} layout property." (let* ((dir (chain-assoc-get 'direction props))) (stack-lines (if (number? dir) dir -1) 0.0 (chain-assoc-get 'baseline-skip props) - (map (lambda (x) (interpret-markup layout props x)) args)))) + (interpret-markup-list layout props args)))) -(define-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)) +(define-builtin-markup-command (center-align layout props args) (markup-list?) + " +@cindex centering a column of text + +Put @code{args} in a centered column." + (let* ((mols (interpret-markup-list layout props args)) (cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols))) (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) cmols))) -(define-markup-command (vcenter layout props arg) (markup?) - "Align @code{arg} to its Y center. " +(define-builtin-markup-command (vcenter layout props arg) (markup?) + " +@cindex vertically centering text + +Align @code{arg} to its Y@tie{}center." (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol Y CENTER))) -(define-markup-command (hcenter layout props arg) (markup?) - "Align @code{arg} to its X center. " +(define-builtin-markup-command (hcenter layout props arg) (markup?) + " +@cindex horizontally centering text + +Align @code{arg} to its X@tie{}center." (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol X CENTER))) -(define-markup-command (right-align layout props arg) (markup?) - "Align @var{arg} on its right edge. " +(define-builtin-markup-command (right-align layout props arg) (markup?) + " +@cindex right aligning text + +Align @var{arg} on its right edge." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X RIGHT))) -(define-markup-command (left-align layout props arg) (markup?) - "Align @var{arg} on its left edge. " +(define-builtin-markup-command (left-align layout props arg) (markup?) + " +@cindex left aligning text + +Align @var{arg} on its left edge." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X LEFT))) -(define-markup-command (general-align layout props axis dir arg) (integer? number? markup?) - "Align @var{arg} in @var{axis} direction to the @var{dir} side." +(define-builtin-markup-command (general-align layout props axis dir arg) (integer? number? markup?) + " +@cindex controlling general text alignment + +Align @var{arg} in @var{axis} direction to the @var{dir} side." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m axis dir))) -(define-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 +(define-builtin-markup-command (halign layout props dir arg) (number? markup?) + " +@cindex setting horizontal text alignment + +Set horizontal alignment. If @var{dir} is @code{-1}, then it is +left-aligned, while @code{+1} is right. Values inbetween interpolate alignment accordingly." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X dir))) +(define-builtin-markup-command (with-dimensions layout props x y arg) (number-pair? number-pair? markup?) + " +@cindex setting extent of text objects - -(define-markup-command (with-dimensions layout props x y arg) (number-pair? number-pair? markup?) - "Set the dimensions of @var{arg} to @var{x} and @var{y}." - +Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}." (let* ((m (interpret-markup layout props arg))) (ly:make-stencil (ly:stencil-expr m) x y))) - -(define-markup-command (pad-around layout props amount arg) (number? markup?) - - "Add padding @var{amount} all around @var{arg}. " - +(define-builtin-markup-command (pad-around layout props amount arg) (number? markup?) + "Add padding @var{amount} all around @var{arg}." (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) @@ -693,10 +828,11 @@ alignment accordingly." (interval-widen y amount)) )) +(define-builtin-markup-command (pad-x layout props amount arg) (number? markup?) + " +@cindex padding text horizontally -(define-markup-command (pad-x layout props amount arg) (number? markup?) - - "Add padding @var{amount} around @var{arg} in the X-direction. " +Add padding @var{amount} around @var{arg} in the X@tie{}direction." (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) @@ -708,33 +844,27 @@ alignment accordingly." y) )) - -(define-markup-command (put-adjacent layout props arg1 axis dir arg2) (markup? integer? ly:dir? markup?) - - "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}. " - +(define-builtin-markup-command (put-adjacent layout props arg1 axis dir arg2) (markup? integer? ly:dir? markup?) + "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}." (let* ((m1 (interpret-markup layout props arg1)) (m2 (interpret-markup layout props arg2))) - (ly:stencil-combine-at-edge m1 axis dir m2 0.0 0.0) + (ly:stencil-combine-at-edge m1 axis dir m2 0.0) )) -(define-markup-command (transparent layout props arg) (markup?) - "Make the argument transparent" +(define-builtin-markup-command (transparent layout props arg) (markup?) + "Make the argument transparent." (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) (y (ly:stencil-extent m Y))) - - - + (ly:make-stencil "" x y))) - -(define-markup-command (pad-to-box layout props x-ext y-ext arg) +(define-builtin-markup-command (pad-to-box layout props x-ext y-ext arg) (number-pair? number-pair? markup?) - "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space" + "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space." (let* ((m (interpret-markup layout props arg)) @@ -746,7 +876,7 @@ alignment accordingly." (interval-union y-ext y)))) -(define-markup-command (hcenter-in layout props length arg) +(define-builtin-markup-command (hcenter-in layout props length arg) (number? markup?) "Center @var{arg} horizontally within a box of extending @var{length}/2 to the left and right." @@ -757,50 +887,47 @@ alignment accordingly." '(0 . 0) (make-hcenter-markup arg)))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; property ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (fromproperty layout props symbol) (symbol?) +(define-builtin-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" +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))))) - + empty-stencil))) -(define-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." +(define-builtin-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)))) +(define-builtin-markup-command (override layout props new-prop arg) (pair? markup?) + " +@cindex overriding properties within text markup - -(define-markup-command (override layout props new-prop arg) (pair? markup?) - "Add the first argument in to the property list. Properties may be +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 -@verbatim +@example \\override #'(font-family . married) \"bla\" -@end verbatim - -" +@end example" (interpret-markup layout (cons (list new-prop) props) arg)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; files ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (verbatim-file layout props name) (string?) - "Read the contents of a file, and include verbatimly" +(define-builtin-markup-command (verbatim-file layout props name) (string?) + "Read the contents of a file, and include it verbatim." (interpret-markup layout props @@ -818,28 +945,26 @@ any sort of property supported by @internalsref{font-interface} and ;; fonts. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -(define-markup-command (bigger layout props arg) (markup?) - "Increase the font size relative to current setting" +(define-builtin-markup-command (bigger layout props arg) (markup?) + "Increase the font size relative to current setting." (interpret-markup layout props `(,fontsize-markup 1 ,arg))) -(define-markup-command (smaller layout props arg) (markup?) - "Decrease the font size relative to current setting" +(define-builtin-markup-command (smaller layout props arg) (markup?) + "Decrease the font size relative to current setting." (interpret-markup layout props `(,fontsize-markup -1 ,arg))) -(define-markup-command larger (markup?) bigger-markup) +(define-builtin-markup-command larger (markup?) bigger-markup) -(define-markup-command (finger layout props arg) (markup?) +(define-builtin-markup-command (finger layout props arg) (markup?) "Set the argument as small numbers." (interpret-markup layout (cons '((font-size . -5) (font-encoding . fetaNumber)) props) arg)) - -(define-markup-command (fontsize layout props increment arg) (number? markup?) - "Add @var{increment} to the font-size. Adjust baseline skip accordingly." +(define-builtin-markup-command (fontsize layout props increment arg) (number? markup?) + "Add @var{increment} to the font-size. Adjust baseline skip accordingly." (let* ((fs (chain-assoc-get 'font-size props 0)) (bs (chain-assoc-get 'baseline-skip props 2)) @@ -848,176 +973,151 @@ any sort of property supported by @internalsref{font-interface} and (cons 'font-size (+ fs increment ))))) (interpret-markup layout (cons entries props) arg))) - +(define-builtin-markup-command (magnify layout props sz arg) (number? markup?) + " +@cindex magnifying text + +Set the font magnification for its argument. In the following +example, the middle@tie{}A is 10% larger: -;; FIXME -> should convert to font-size. -(define-markup-command (magnify layout props sz arg) (number? markup?) - "Set the font magnification for the its argument. In the following -example, the middle A will be 10% larger: @example A \\magnify #1.1 @{ A @} A @end example -Note: magnification only works if a font-name is explicitly selected. +Note: Magnification only works if a font name is explicitly selected. Use @code{\\fontsize} otherwise." (interpret-markup layout - (prepend-alist-chain 'font-magnification sz props) + (prepend-alist-chain 'font-size (magnification->font-size sz) props) arg)) -(define-markup-command (bold layout props arg) (markup?) - "Switch to bold font-series" +(define-builtin-markup-command (bold layout props arg) (markup?) + "Switch to bold font-series." (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg)) -(define-markup-command (sans layout props arg) (markup?) - "Switch to the sans serif family" +(define-builtin-markup-command (sans layout props arg) (markup?) + "Switch to the sans serif family." (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg)) -(define-markup-command (number layout props arg) (markup?) +(define-builtin-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. " +some punctuation. It doesn't have any letters." (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg)) -(define-markup-command (roman layout props arg) (markup?) +(define-builtin-markup-command (roman layout props arg) (markup?) "Set font family to @code{roman}." (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg)) -(define-markup-command (huge layout props arg) (markup?) +(define-builtin-markup-command (huge layout props arg) (markup?) "Set font size to +2." (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg)) -(define-markup-command (large layout props arg) (markup?) +(define-builtin-markup-command (large layout props arg) (markup?) "Set font size to +1." (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg)) -(define-markup-command (normalsize layout props arg) (markup?) +(define-builtin-markup-command (normalsize layout props arg) (markup?) "Set font size to default." (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg)) -(define-markup-command (small layout props arg) (markup?) +(define-builtin-markup-command (small layout props arg) (markup?) "Set font size to -1." (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg)) -(define-markup-command (tiny layout props arg) (markup?) +(define-builtin-markup-command (tiny layout props arg) (markup?) "Set font size to -2." (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg)) -(define-markup-command (teeny layout props arg) (markup?) +(define-builtin-markup-command (teeny layout props arg) (markup?) "Set font size to -3." (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg)) -(define-markup-command (fontCaps layout props arg) (markup?) +(define-builtin-markup-command (fontCaps layout props arg) (markup?) "Set @code{font-shape} to @code{caps}." (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg)) ;; Poor man's caps -(define-markup-command (smallCaps layout props text) (markup?) +(define-builtin-markup-command (smallCaps layout props text) (markup?) "Turn @code{text}, which should be a string, to small caps. @example \\markup \\smallCaps \"Text between double quotes\" @end example -" - (define (make-small-caps-markup chars) - (cond ((null? chars) - (markup)) - ((char-whitespace? (car chars)) - (markup #:fontsize -2 #:simple (string-upcase (list->string (cdr chars))))) - (else - (markup #:hspace -1 - #:fontsize -2 #:simple (string-upcase (list->string chars)))))) - (define (make-not-small-caps-markup chars) - (cond ((null? chars) - (markup)) - ((char-whitespace? (car chars)) - (markup #:simple (list->string (cdr chars)))) - (else - (markup #:hspace -1 - #:simple (list->string chars))))) - (define (small-caps-aux done-markups current-chars rest-chars small? after-space?) - (cond ((null? rest-chars) - ;; the end of the string: build the markup - (make-line-markup (reverse! (cons ((if small? - make-small-caps-markup - make-not-small-caps-markup) - (reverse! current-chars)) - done-markups)))) - ((char-whitespace? (car rest-chars)) - ;; a space char. - (small-caps-aux done-markups current-chars (cdr rest-chars) small? #t)) - ((or (and small? (char-lower-case? (car rest-chars))) - (and (not small?) (not (char-lower-case? (car rest-chars))))) - ;; same case - ;; add the char to the current char list - (small-caps-aux done-markups - (cons (car rest-chars) - (if after-space? - (cons #\space current-chars) - current-chars)) - (cdr rest-chars) - small? - #f)) - (else - ;; case change - ;; make a markup with current chars, and start a new list with new char - (small-caps-aux (cons ((if small? - make-small-caps-markup - make-not-small-caps-markup) - (reverse! current-chars)) - done-markups) - (if after-space? - (list (car rest-chars) #\space) - (list (car rest-chars))) - (cdr rest-chars) - (not small?) - #f)))) - (interpret-markup layout props (small-caps-aux (list) - (list) - (cons #\space (string->list text)) - #f - #f))) - -(define-markup-command (caps layout props arg) (markup?) + +Note: @code{\\smallCaps} does not support accented characters." + (define (char-list->markup chars lower) + (let ((final-string (string-upcase (reverse-list->string chars)))) + (if lower + (markup #:fontsize -2 final-string) + final-string))) + (define (make-small-caps rest-chars currents current-is-lower prev-result) + (if (null? rest-chars) + (make-concat-markup + (reverse! (cons (char-list->markup currents current-is-lower) + prev-result))) + (let* ((ch (car rest-chars)) + (is-lower (char-lower-case? ch))) + (if (or (and current-is-lower is-lower) + (and (not current-is-lower) (not is-lower))) + (make-small-caps (cdr rest-chars) + (cons ch currents) + is-lower + prev-result) + (make-small-caps (cdr rest-chars) + (list ch) + is-lower + (if (null? currents) + prev-result + (cons (char-list->markup + currents current-is-lower) + prev-result))))))) + (interpret-markup layout props + (if (string? text) + (make-small-caps (string->list text) (list) #f (list)) + text))) + +(define-builtin-markup-command (caps layout props arg) (markup?) + "Emit @var{arg} as small caps." (interpret-markup layout props (make-smallCaps-markup arg))) -(define-markup-command (dynamic layout props arg) (markup?) +(define-builtin-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" +@b{z}, @b{p}, and @b{r}. When producing phrases, like +@q{pi@`{u}@tie{}@b{f}}, the normal words (like @q{pi@`{u}}) should be +done in a different font. The recommended font for this is bold and italic." (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg)) -(define-markup-command (text layout props arg) (markup?) +(define-builtin-markup-command (text layout props arg) (markup?) "Use a text font instead of music symbol or music alphabet font." ;; ugh - latin1 (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props) arg)) - -(define-markup-command (italic layout props arg) (markup?) - "Use italic @code{font-shape} for @var{arg}. " +(define-builtin-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)) -(define-markup-command (typewriter layout props arg) (markup?) +(define-builtin-markup-command (typewriter layout props arg) (markup?) "Use @code{font-family} typewriter for @var{arg}." (interpret-markup layout (prepend-alist-chain 'font-family 'typewriter props) arg)) -(define-markup-command (upright layout props arg) (markup?) +(define-builtin-markup-command (upright layout props arg) (markup?) "Set font shape to @code{upright}. This is the opposite of @code{italic}." (interpret-markup layout (prepend-alist-chain 'font-shape 'upright props) arg)) -(define-markup-command (medium layout props arg) (markup?) - "Switch to medium font-series (in contrast to bold)." +(define-builtin-markup-command (medium layout props arg) (markup?) + "Switch to medium font series (in contrast to bold)." (interpret-markup layout (prepend-alist-chain 'font-series 'medium props) arg)) -(define-markup-command (normal-text layout props arg) (markup?) - "Set all font related properties (except the size) to get the default normal text font, no matter what font was used earlier." +(define-builtin-markup-command (normal-text layout props arg) (markup?) + "Set all font related properties (except the size) to get the default +normal text font, no matter what font was used earlier." ;; ugh - latin1 (interpret-markup layout (cons '((font-family . roman) (font-shape . upright) @@ -1029,62 +1129,97 @@ recommend font for this is bold and italic" ;; symbols. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (doublesharp layout props) () - "Draw a double sharp symbol." - +(define-builtin-markup-command (doublesharp layout props) () + "Draw a double sharp symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\doublesharp } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1 standard-alteration-glyph-name-alist "")))) -(define-markup-command (sesquisharp layout props) () - "Draw a 3/2 sharp symbol." - (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist "")))) - +(define-builtin-markup-command (sesquisharp layout props) () + "Draw a 3/2 sharp symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\sesquisharp } +@end lilypond" + (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist "")))) -(define-markup-command (sharp layout props) () - "Draw a sharp symbol." +(define-builtin-markup-command (sharp layout props) () + "Draw a sharp symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\sharp } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1/2 standard-alteration-glyph-name-alist "")))) -(define-markup-command (semisharp layout props) () - "Draw a semi sharp symbol." +(define-builtin-markup-command (semisharp layout props) () + "Draw a semi sharp symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\semisharp } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1/4 standard-alteration-glyph-name-alist "")))) -(define-markup-command (natural layout props) () - "Draw a natural symbol." +(define-builtin-markup-command (natural layout props) () + "Draw a natural symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\natural } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 0 standard-alteration-glyph-name-alist "")))) -(define-markup-command (semiflat layout props) () - "Draw a semiflat." +(define-builtin-markup-command (semiflat layout props) () + "Draw a semiflat symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\semiflat } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1/4 standard-alteration-glyph-name-alist "")))) -(define-markup-command (flat layout props) () - "Draw a flat symbol." +(define-builtin-markup-command (flat layout props) () + "Draw a flat symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\flat } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1/2 standard-alteration-glyph-name-alist "")))) -(define-markup-command (sesquiflat layout props) () - "Draw a 3/2 flat symbol." +(define-builtin-markup-command (sesquiflat layout props) () + "Draw a 3/2 flat symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\sesquiflat } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -3/4 standard-alteration-glyph-name-alist "")))) -(define-markup-command (doubleflat layout props) () - "Draw a double flat symbol." +(define-builtin-markup-command (doubleflat layout props) () + "Draw a double flat symbol. +@c +@lilypond[verbatim,quote] +\\markup { \\doubleflat } +@end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist "")))) -(define-markup-command (with-color layout props color arg) (color? markup?) - "Draw @var{arg} in color specified by @var{color}" +(define-builtin-markup-command (with-color layout props color arg) (color? markup?) + " +@cindex coloring text +Draw @var{arg} in color specified by @var{color}." (let* ((stil (interpret-markup layout props arg))) (ly:make-stencil (list 'color color (ly:stencil-expr stil)) (ly:stencil-extent stil X) (ly:stencil-extent stil Y)))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; glyphs ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -(define-markup-command (arrow-head layout props axis direction filled) +(define-builtin-markup-command (arrow-head layout props axis direction filled) (integer? ly:dir? boolean?) - "produce an arrow head in specified direction and axis. Use the filled head if @var{filled} is specified." + "Produce an arrow head in specified direction and axis. +Use the filled head if @var{filled} is specified." (let* ((name (format "arrowheads.~a.~a~a" (if filled @@ -1097,24 +1232,24 @@ recommend font for this is bold and italic" props)) name))) -(define-markup-command (musicglyph layout props glyph-name) (string?) - "This is converted to a musical symbol, e.g. @code{\\musicglyph -#\"accidentals.natural\"} will select the natural sign from the music font. -See @usermanref{The Feta font} for a complete listing of the possible glyphs." +(define-builtin-markup-command (musicglyph layout props glyph-name) (string?) + "@var{glyph-name} is converted to a musical symbol; for example, +@code{\\musicglyph #\"accidentals.natural\"} selects the natural sign from +the music font. See @ruser{The Feta font} for a complete listing of +the possible glyphs." (ly:font-get-glyph (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)) glyph-name)) -(define-markup-command (lookup layout props glyph-name) (string?) +(define-builtin-markup-command (lookup layout props glyph-name) (string?) "Lookup a glyph by name." (ly:font-get-glyph (ly:paper-get-font layout props) glyph-name)) -(define-markup-command (char layout props num) (integer?) - "Produce a single character, e.g. @code{\\char #65} produces the -letter 'A'." - +(define-builtin-markup-command (char layout props num) (integer?) + "Produce a single character. For example, @code{\\char #65} produces the +letter @q{A}." (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num))) (define number->mark-letter-vector (make-vector 25 #\A)) @@ -1139,28 +1274,30 @@ letter 'A'." (number->markletter-string vec (remainder n lst))) (make-string 1 (vector-ref vec n))))) -(define-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." +(define-builtin-markup-command (markletter layout props num) (integer?) + "Make a markup letter for @var{num}. The letters start with A to@tie{}Z +(skipping letter@tie{}I), and continue with double letters." (ly:text-interface::interpret-markup layout props (number->markletter-string number->mark-letter-vector num))) -(define-markup-command (markalphabet layout props num) (integer?) - "Make a markup letter for @var{num}. The letters start with A to Z - and continues with double letters." +(define-builtin-markup-command (markalphabet layout props num) (integer?) + "Make a markup letter for @var{num}. The letters start with A to@tie{}Z +and continue with double letters." (ly:text-interface::interpret-markup layout props (number->markletter-string number->mark-alphabet-vector num))) +(define-builtin-markup-command (slashed-digit layout props num) (integer?) + " +@cindex slashed digits - -(define-markup-command (slashed-digit layout props num) (integer?) - "A feta number, with slash. This is for use in the context of -figured bass notation" +A feta number, with slash. This is for use in the context of +figured bass notation." (let* ((mag (magstep (chain-assoc-get 'font-size props 0))) (thickness (* mag - (chain-assoc-get 'thickness props 0.16))) + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1.6))) (dy (* mag 0.15)) (number-stencil (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) @@ -1168,40 +1305,53 @@ figured bass notation" (num-x (interval-widen (ly:stencil-extent number-stencil X) (* mag 0.2))) (num-y (ly:stencil-extent number-stencil Y)) - (slash-stencil - (ly:make-stencil - `(draw-line - ,thickness - ,(car num-x) ,(- (interval-center num-y) dy) - ,(cdr num-x) ,(+ (interval-center num-y) dy)) - num-x num-y - ))) - - (ly:stencil-add number-stencil - (cond - ((= num 5) (ly:stencil-translate slash-stencil - ;;(cons (* mag -0.05) (* mag 0.42)) - (cons (* mag -0.00) (* mag -0.07)) - - )) - ((= num 7) (ly:stencil-translate slash-stencil - ;;(cons (* mag -0.05) (* mag 0.42)) - (cons (* mag -0.00) (* mag -0.15)) - - )) - - (else slash-stencil))) - )) + (is-sane (and (interval-sane? num-x) (interval-sane? num-y))) + + (slash-stencil + (if is-sane + (ly:make-stencil + `(draw-line + ,thickness + ,(car num-x) ,(- (interval-center num-y) dy) + ,(cdr num-x) ,(+ (interval-center num-y) dy)) + num-x num-y) + #f))) + + (set! slash-stencil + (cond + ((not (ly:stencil? slash-stencil)) #f) + ((= num 5) (ly:stencil-translate slash-stencil + ;;(cons (* mag -0.05) (* mag 0.42)) + (cons (* mag -0.00) (* mag -0.07)) + + )) + ((= num 7) (ly:stencil-translate slash-stencil + ;;(cons (* mag -0.05) (* mag 0.42)) + (cons (* mag -0.00) (* mag -0.15)) + + )) + + (else slash-stencil))) + + (if slash-stencil + (set! number-stencil + (ly:stencil-add number-stencil slash-stencil)) + + (ly:warning "invalid number for slashed digit ~a" num)) + + number-stencil)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; the note command. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - ;; TODO: better syntax. -(define-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 +(define-builtin-markup-command (note-by-number layout props log dot-count dir) (number? number? number?) + " +@cindex notes within text by log and dot-count + +Construct a note symbol, with stem. By using fractional values for @var{dir}, you can obtain longer or shorter stems." (define (get-glyph-name-candidates dir log style) @@ -1251,8 +1401,8 @@ figured bass notation" (apply ly:stencil-add (map (lambda (x) (ly:stencil-translate-axis - dot (* (+ 1 (* 2 x)) dotwid) X)) - (iota dot-count 1))))) + dot (* 2 x dotwid) X)) + (iota dot-count))))) (flaggl (and (> log 2) (ly:stencil-translate (ly:font-get-glyph font @@ -1260,6 +1410,9 @@ figured bass notation" (if (> dir 0) "u" "d") (number->string log))) (cons (+ (car attach-off) (/ stem-thickness 2)) stemy))))) + + (if (and dots flaggl (> dir 0)) + (set! dots (ly:stencil-translate-axis dots 0.35 X))) (if flaggl (set! stem-glyph (ly:stencil-add flaggl stem-glyph))) (if (ly:stencil? stem-glyph) @@ -1270,12 +1423,7 @@ figured bass notation" (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-extent head-glyph X)) - dotwid) + (+ (cdr (ly:stencil-extent head-glyph X)) dotwid) X) stem-glyph))) stem-glyph)) @@ -1297,31 +1445,37 @@ figured bass notation" (if dots (string-length dots) 0))) (ly:error (_ "not a valid duration string: ~a") duration-string)))) -(define-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 +(define-builtin-markup-command (note layout props duration dir) (string? number?) + " +@cindex notes within text by string + +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 layout props (car parsed) (cadr parsed) dir))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; translating. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (lower layout props amount arg) (number? markup?) +(define-builtin-markup-command (lower layout props amount arg) (number? markup?) " -Lower @var{arg}, by the distance @var{amount}. -A negative @var{amount} indicates raising, see also @code{\\raise}. -" +@cindex lowering text + +Lower @var{arg} by the distance @var{amount}. +A negative @var{amount} indicates raising; see also @code{\\raise}." (ly:stencil-translate-axis (interpret-markup layout props arg) (- amount) Y)) +(define-builtin-markup-command (translate-scaled layout props offset arg) (number-pair? markup?) + " +@cindex translating text +@cindex scaling text -(define-markup-command (translate-scaled layout props offset arg) (number-pair? markup?) - "Translate @var{arg} by @var{offset}, scaling the offset by the @code{font-size}." - +Translate @var{arg} by @var{offset}, scaling the offset by the +@code{font-size}." (let* ((factor (magstep (chain-assoc-get 'font-size props 0))) (scaled (cons (* factor (car offset)) @@ -1330,14 +1484,13 @@ A negative @var{amount} indicates raising, see also @code{\\raise}. (ly:stencil-translate (interpret-markup layout props arg) scaled))) -(define-markup-command (raise layout props amount arg) (number? markup?) +(define-builtin-markup-command (raise layout props amount arg) (number? markup?) " -Raise @var{arg}, by the distance @var{amount}. +@cindex raising text + +Raise @var{arg} by the distance @var{amount}. A negative @var{amount} indicates lowering, see also @code{\\lower}. -@c -@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, measured in (global) staff spaces. @code{\\raise} and @code{\\super} raise objects in relation to their surrounding markups. @@ -1345,12 +1498,19 @@ raise objects in relation to their surrounding markups. If the text object itself is positioned above or below the staff, then @code{\\raise} cannot be used to move it, since the mechanism that positions it next to the staff cancels any shift made with -@code{\\raise}. For vertical positioning, use the @code{padding} -and/or @code{extra-offset} properties. " +@code{\\raise}. For vertical positioning, use the @code{padding} +and/or @code{extra-offset} properties. +@c +@lilypond[verbatim,quote] +\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" } } +@end lilypond" (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y)) -(define-markup-command (fraction layout props arg1 arg2) (markup? markup?) - "Make a fraction of two markups." +(define-builtin-markup-command (fraction layout props arg1 arg2) (markup? markup?) + " +@cindex creating text fractions + +Make a fraction of two markups." (let* ((m1 (interpret-markup layout props arg1)) (m2 (interpret-markup layout props arg2)) (factor (magstep (chain-assoc-get 'font-size props 0))) @@ -1373,34 +1533,25 @@ and/or @code{extra-offset} properties. " ;; empirical anyway (ly:stencil-translate-axis stack offset Y)))) +(define-builtin-markup-command (normal-size-super layout props arg) (markup?) + " +@cindex setting superscript in standard font size - - - -(define-markup-command (normal-size-super layout props arg) (markup?) - "Set @var{arg} in superscript with a normal font size." +Set @var{arg} in superscript with a normal font size." (ly:stencil-translate-axis (interpret-markup layout props arg) (* 0.5 (chain-assoc-get 'baseline-skip props)) Y)) -(define-markup-command (super layout props arg) (markup?) - " -@cindex raising text -@cindex lowering text -@cindex moving text -@cindex translating text - -@cindex @code{\\super} - +(define-builtin-markup-command (super layout props arg) (markup?) + " +@cindex superscript text Raising and lowering texts can be done with @code{\\super} and @code{\\sub}: - -@lilypond[verbatim,fragment,relative=1] - c1^\\markup { E \"=\" mc \\super \"2\" } -@end lilypond - -" +@c +@lilypond[verbatim,quote] +\\markup { E \"=\" \\concat { \"mc\" \\super \"2\" } } +@end lilypond" (ly:stencil-translate-axis (interpret-markup layout @@ -1409,22 +1560,28 @@ Raising and lowering texts can be done with @code{\\super} and (* 0.5 (chain-assoc-get 'baseline-skip props)) Y)) -(define-markup-command (translate layout props offset arg) (number-pair? markup?) - "This translates an object. Its first argument is a cons of numbers +(define-builtin-markup-command (translate layout props offset arg) (number-pair? markup?) + " +@cindex translating text + +This translates an object. Its first argument is a cons of numbers. + @example A \\translate #(cons 2 -3) @{ B C @} D @end example -This moves `B C' 2 spaces to the right, and 3 down, relative to its -surroundings. This command cannot be used to move isolated scripts -vertically, for the same reason that @code{\\raise} cannot be used for -that. -" +This moves @q{B C} 2@tie{}spaces to the right, and 3 down, relative to its +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 layout props arg) offset)) -(define-markup-command (sub layout props arg) (markup?) - "Set @var{arg} in subscript." +(define-builtin-markup-command (sub layout props arg) (markup?) + " +@cindex subscript text + +Set @var{arg} in subscript." (ly:stencil-translate-axis (interpret-markup layout @@ -1433,8 +1590,11 @@ that. (* -0.5 (chain-assoc-get 'baseline-skip props)) Y)) -(define-markup-command (normal-size-sub layout props arg) (markup?) - "Set @var{arg} in subscript, in a normal font size." +(define-builtin-markup-command (normal-size-sub layout props arg) (markup?) + " +@cindex setting subscript in standard font size + +Set @var{arg} in subscript, in a normal font size." (ly:stencil-translate-axis (interpret-markup layout props arg) (* -0.5 (chain-assoc-get 'baseline-skip props)) @@ -1444,94 +1604,91 @@ that. ;; brackets. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-markup-command (hbracket layout props arg) (markup?) - "Draw horizontal brackets around @var{arg}." +(define-builtin-markup-command (hbracket layout props arg) (markup?) + " +@cindex placing horizontal brackets around text + +Draw horizontal brackets around @var{arg}." (let ((th 0.1) ;; todo: take from GROB. (m (interpret-markup layout props arg))) (bracketify-stencil m X th (* 2.5 th) th))) -(define-markup-command (bracket layout props arg) (markup?) - "Draw vertical brackets around @var{arg}." +(define-builtin-markup-command (bracket layout props arg) (markup?) + " +@cindex placing vertical brackets around text + +Draw vertical brackets around @var{arg}." (let ((th 0.1) ;; todo: take from GROB. (m (interpret-markup layout props arg))) (bracketify-stencil m Y th (* 2.5 th) th))) - -(define-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. - -" -;; -;; DROPME? This command is a relic from the old figured bass implementation. -;; - - (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-vertically stencils bskip last-stencil) - (cond - ((null? stencils) '()) - ((not (ly:stencil? last-stencil)) - (cons (car stencils) - (stack-stencils-vertically (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-vertically (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-vertically - (remove ly:stencil-empty? stencils) 1.25 #f)) - (brackets (make-brackets stacked indices '()))) - - (apply ly:stencil-add - (append stacked brackets)))) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Delayed markup evaluation +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(define-builtin-markup-command (page-ref layout props label gauge default) + (symbol? markup? markup?) + " +@cindex referencing page numbers in text + +Reference to a page number. @var{label} is the label set on the referenced +page (using the @code{\\label} command), @var{gauge} a markup used to estimate +the maximum width of the page number, and @var{default} the value to display +when @var{label} is not found." + (let* ((gauge-stencil (interpret-markup layout props gauge)) + (x-ext (ly:stencil-extent gauge-stencil X)) + (y-ext (ly:stencil-extent gauge-stencil Y))) + (ly:make-stencil + `(delay-stencil-evaluation + ,(delay (ly:stencil-expr + (let* ((table (ly:output-def-lookup layout 'label-page-table)) + (label-page (and (list? table) (assoc label table))) + (page-number (and label-page (cdr label-page))) + (page-markup (if page-number (format "~a" page-number) default)) + (page-stencil (interpret-markup layout props page-markup)) + (gap (- (interval-length x-ext) + (interval-length (ly:stencil-extent page-stencil X))))) + (interpret-markup layout props + (markup #:concat (#:hspace gap page-markup))))))) + x-ext + y-ext))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; size indications arrow +;; Markup list commands ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(define-public (space-lines baseline-skip lines) + (map (lambda (line) + (stack-lines DOWN 0.0 (/ baseline-skip 2.0) + (list point-stencil + line + point-stencil))) + lines)) + +(define-builtin-markup-list-command (justified-lines layout props args) (markup-list?) + " +@cindex justifying lines of text + +Like @code{\\justify}, but return a list of lines instead of a single markup. +Use @code{\\override-lines #'(line-width . @var{X})} to set the line width; +@var{X}@tie{}is the number of staff spaces." + (space-lines (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #t))) + +(define-builtin-markup-list-command (wordwrap-lines layout props args) (markup-list?) + "Like @code{\\wordwrap}, but return a list of lines instead of a single markup. +Use @code{\\override-lines #'(line-width . @var{X})} to set the line width, +where @var{X} is the number of staff spaces." + (space-lines (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #f))) + +(define-builtin-markup-list-command (column-lines layout props args) (markup-list?) + "Like @code{\\column}, but return a list of lines instead of a single markup. +@code{baseline-skip} determines the space between each markup in @var{args}." + (space-lines (chain-assoc-get 'baseline-skip props) + (interpret-markup-list layout props args))) + +(define-builtin-markup-list-command (override-lines layout props new-prop args) + (pair? markup-list?) + "Like @code{\\override}, for markup lists." + (interpret-markup-list layout (cons (list new-prop) props) args))