X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-markup-commands.scm;h=71407e60cd31f2645f379f44d55d01cbefeb86be;hb=a113820bb91e69cc1ff86d61bad6778a5fd2ade9;hp=10ecd85d9ab1282b8588c8c6cbf29abe4de84b34;hpb=ed8702ba953fe9dd62927c6312b36b369f022f93;p=lilypond.git diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index 10ecd85d9a..71407e60cd 100644 --- a/scm/define-markup-commands.scm +++ b/scm/define-markup-commands.scm @@ -1,71 +1,847 @@ +;;;; define-markup-commands.scm -- markup commands +;;;; +;;;; source file of the GNU LilyPond music typesetter +;;;; +;;;; (c) 2000--2006 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; markup commands -;; TODO: -;; each markup function should have a doc string with -;; syntax, description and example. -;; +;;; * each markup function should have a doc string with +;; syntax, description and example. + +(use-modules (ice-9 regex)) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; utility functions +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(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) + (number? number? boolean?) + "A circle of radius @var{radius}, thickness @var{thickness} and +optionally filled." + (make-circle-stencil radius thickness fill)) + +(define-markup-command (triangle layout props filled) (boolean?) + "A triangle, filled or not" + (let* + ((th (chain-assoc-get 'thickness props 0.1)) + (size (chain-assoc-get 'font-size props 0)) + (ex (* (magstep size) + 0.8 + (chain-assoc-get 'baseline-skip props 2)))) + + (ly:make-stencil + `(polygon '(0.0 0.0 + ,ex 0.0 + ,(* 0.5 ex) + ,(* 0.86 ex)) + ,th + ,filled) + + (cons 0 ex) + (cons 0 (* .86 ex)) + ))) + +(define-markup-command (circle layout props arg) (markup?) + "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)) + (size (chain-assoc-get 'font-size props 0)) + (pad + (* (magstep size) + (chain-assoc-get 'circle-padding props 0.2))) + (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." + (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))) + + +(define-markup-command (beam layout props width slope thickness) + (number? number? number?) + "Create a beam with the specified parameters." + (let* ((y (* slope width)) + (yext (cons (min 0 y) (max 0 y))) + (half (/ thickness 2))) + + (ly:make-stencil + `(polygon ',(list + 0 (/ thickness -2) + width (+ (* width slope) (/ thickness -2)) + width (+ (* width slope) (/ thickness 2)) + 0 (/ thickness 2)) + ,(ly:output-def-lookup layout 'blot-diameter) + #t) + (cons 0 width) + (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}, +@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)) + (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) + (number-pair? number-pair? number?) + "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 +vertically from -0.3 up to 1.8, with corners formed from a +circle of diameter 0 (ie 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." + (let* ((stil (interpret-markup layout props arg))) + (ly:stencil-rotate stil ang 0 0))) + + +(define-markup-command (whiteout layout props arg) (markup?) + "Provide a white underground for @var{arg}" + (let* ((stil (interpret-markup layout props arg)) + (white + (interpret-markup layout props + (make-with-color-markup + white + (make-filled-box-markup + (ly:stencil-extent stil X) + (ly:stencil-extent stil Y) + 0.0))))) + + (ly:stencil-add white stil))) + +(define-markup-command (pad-markup layout props padding arg) (number? markup?) + "Add space around a markup object." + + (let* + ((stil (interpret-markup layout props arg)) + (xext (ly:stencil-extent stil X)) + (yext (ly:stencil-extent stil Y))) + + (ly:make-stencil + (ly:stencil-expr stil) + (interval-widen xext padding) + (interval-widen yext padding)))) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; 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." + (let ((m (ly:text-interface::interpret-markup layout props " "))) + (ly:make-stencil (ly:stencil-expr m) + '(1000 . -1000) + (ly:stencil-extent m X) + ))) -(def-markup-command (simple paper props str) (string?) - "A simple text-string; @code{\\markup @{ foo @}} is equivalent with -@code{\\markup @{ \\simple #\"foo\" @}}. +;; todo: fix negative space +(define-markup-command (hspace layout props amount) (number?) + "This produces a invisible object taking horizontal space. +@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. " - (interpret-markup paper props str)) + (if (> amount 0) + (ly:make-stencil "" (cons 0 amount) '(-1 . 1)) + (ly:make-stencil "" (cons amount amount) '(-1 . 1)))) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; importing graphics. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; fonts -(define (font-markup qualifier value) - (lambda (paper props arg) - (interpret-markup paper - (prepend-alist-chain qualifier value props) - arg))) +(define-markup-command (stencil layout props stil) (ly:stencil?) + "Stencil as markup" + stil) + +(define bbox-regexp + (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)")) + +(define (get-postscript-bbox string) + "Extract the bbox from STRING, or return #f if not present." + (let* + ((match (regexp-exec bbox-regexp string))) + + (if match + (map (lambda (x) + (string->number (match:substring match x))) + (cdr (iota 5))) + + #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}." + (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 +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 + (format " +gsave currentpoint translate +0.1 setlinewidth + ~a +grestore +" + str)) + '(0 . 0) '(0 . 0))) + + +(define-markup-command (score layout props score) (ly:score?) + "Inline an image of music." + (let* ((output (ly:score-embedded-format score layout))) + + (if (ly:music-output? output) + (paper-system-stencil + (vector-ref (ly:paper-score-paper-systems output) 0)) + (begin + (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" + + point-stencil) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; basic formatting. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + + + +(define-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)) + +(define-markup-command (tied-lyric layout props str) (string?) + + "Like simple-markup, but use tie characters for ~ tilde symbols." + + (if (string-contains str "~") + (let* + ((parts (string-split str #\~)) + (tie-str (ly:wide-char->utf-8 #x203f)) + (joined (list-join parts tie-str)) + (join-stencil (interpret-markup layout props tie-str)) + ) + + (interpret-markup layout + (prepend-alist-chain + 'word-space + (/ (interval-length (ly:stencil-extent join-stencil X)) -3.5) + props) + (make-line-markup joined))) + ;(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 "")) -(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}. +;; helper for justifying lines. +(define (get-fill-space word-count line-width text-widths) + "Calculate the necessary paddings between each two adjacent texts. + The lengths of all texts are stored in @var{text-widths}. + The normal formula for the padding between texts a and b is: + 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. " - (stack-molecule-line - (cdr (chain-assoc 'word-space props)) - (map (lambda (m) (interpret-markup paper props m)) args))) + (cond + ((null? text-widths) '()) + + ;; special case first padding + ((= (length text-widths) word-count) + (cons + (- (- (/ line-width (1- word-count)) (car text-widths)) + (/ (car (cdr text-widths)) 2)) + (get-fill-space word-count line-width (cdr text-widths)))) + ;; special case last padding + ((= (length text-widths) 2) + (list (- (/ line-width (1- word-count)) + (+ (/ (car text-widths) 2) (car (cdr text-widths)))) 0)) + (else + (cons + (- (/ line-width (1- word-count)) + (/ (+ (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) + (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-widths + (map (lambda (stc) + (if (ly:stencil-empty? stc) + 0.0 + (interval-length (ly:stencil-extent stc X)))) + stencils)) + (text-width (apply + text-widths)) + (text-dir (chain-assoc-get 'text-direction props RIGHT)) + (word-count (length stencils)) + (word-space (chain-assoc-get 'word-space props 1)) + (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))) + (fill-space + (cond + ((= word-count 1) + (list + (/ (- line-width text-width) 2) + (/ (- line-width text-width) 2))) + ((= word-count 2) + (list + (- line-width text-width))) + (else + (get-fill-space word-count line-width text-widths)))) + (fill-space-normal + (map (lambda (x) + (if (< x word-space) + word-space + x)) + fill-space)) + + (line-stencils (if (= word-count 1) + (list + point-stencil + (car stencils) + point-stencil) + stencils))) + + (if (= text-dir LEFT) + (set! line-stencils (reverse line-stencils))) + + (if (null? (remove ly:stencil-empty? orig-stencils)) + empty-stencil + (stack-stencils-padding-list X + RIGHT fill-space-normal line-stencils)))) + +(define-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)) + (space (chain-assoc-get 'word-space props)) + (text-dir (chain-assoc-get 'text-direction props RIGHT)) + ) + + (if (= text-dir LEFT) + (set! stencils (reverse stencils))) + + + (stack-stencil-line + space + (remove ly:stencil-empty? stencils)))) + -(def-markup-command (combine paper props m1 m2) (markup? markup?) +(define (wordwrap-stencils stencils + justify base-space line-width text-dir) + + "Perform simple wordwrap, return stencil of each line." + + (define space (if justify + + ;; justify only stretches lines. + (* 0.7 base-space) + base-space)) + + (define (take-list width space stencils + accumulator accumulated-width) + "Return (head-list . tail) pair, with head-list fitting into width" + (if (null? stencils) + (cons accumulator stencils) + (let* + ((first (car stencils)) + (first-wid (cdr (ly:stencil-extent (car stencils) X))) + (newwid (+ space first-wid accumulated-width)) + ) + + (if + (or (null? accumulator) + (< newwid width)) + + (take-list width space + (cdr stencils) + (cons first accumulator) + newwid) + (cons accumulator stencils)) + ))) + + (let loop + ((lines '()) + (todo stencils)) + + (let* + ((line-break (take-list line-width space todo + '() 0.0)) + (line-stencils (car line-break)) + (space-left (- line-width (apply + (map (lambda (x) (cdr (ly:stencil-extent x X))) + line-stencils)))) + + (line-word-space (cond + ((not justify) space) + + ;; don't stretch last line of paragraph. + ;; hmmm . bug - will overstretch the last line in some case. + ((null? (cdr line-break)) + base-space) + ((null? line-stencils) 0.0) + ((null? (cdr line-stencils)) 0.0) + (else (/ space-left (1- (length line-stencils)))))) + + (line (stack-stencil-line + line-word-space + (if (= text-dir RIGHT) + (reverse line-stencils) + line-stencils)))) + + (if (pair? (cdr line-break)) + (loop (cons line lines) + (cdr line-break)) + + (begin + (if (= text-dir LEFT) + (set! line + (ly:stencil-translate-axis line + (- line-width (interval-end (ly:stencil-extent line X))) + X))) + (reverse (cons line lines)) + + ))) + + )) + + +(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)) + (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) + )) + + (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-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." + + (wordwrap-markups layout props args #f)) + +(define (wordwrap-string layout props justify arg) + (let* + ((baseline-skip (chain-assoc-get 'baseline-skip props)) + (line-width (chain-assoc-get 'line-width props)) + (word-space (chain-assoc-get 'word-space props)) + + (para-strings (regexp-split + (string-regexp-substitute "\r" "\n" + (string-regexp-substitute "\r\n" "\n" arg)) + "\n[ \t\n]*\n[ \t\n]*")) + + (text-dir (chain-assoc-get 'text-direction props RIGHT)) + (list-para-words (map (lambda (str) + (regexp-split str "[ \t\n]+")) + para-strings)) + (para-lines (map (lambda (words) + (let* + ((stencils + (remove + ly:stencil-empty? (map + (lambda (x) + (interpret-markup layout props x)) + words))) + (lines (wordwrap-stencils stencils + justify word-space + line-width text-dir + ))) + + lines)) + + list-para-words))) + + (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" + (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" + (wordwrap-string layout props #t arg)) + + +(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-markup-command (combine layout props m1 m2) (markup? markup?) "Print two markups on top of each other." - (ly:molecule-add - (interpret-markup paper props m1) - (interpret-markup paper props m2))) + (let* ((s1 (interpret-markup layout props m1)) + (s2 (interpret-markup layout props m2))) + (ly:stencil-add s1 s2))) +;; +;; 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}." -(def-markup-command (finger paper props arg) (markup?) - "Set the argument as small numbers." - (interpret-markup paper - (cons '((font-size . -4) (font-family . number)) props) - arg)) + (let* + ((arg-stencils (map (lambda (m) (interpret-markup layout props m)) args)) + (skip (chain-assoc-get 'baseline-skip props))) + + (stack-lines + -1 0.0 skip + (remove ly:stencil-empty? arg-stencils)))) + + +(define-markup-command (dir-column layout props args) (markup-list?) + "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)))) + +(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)) + (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. " + (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. " + (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. " + (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. " + (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." + (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 +alignment accordingly." + (let* ((m (interpret-markup layout props arg))) + (ly:stencil-aligned-to m X dir))) + + + +(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}." + + (let* ((m (interpret-markup layout props arg))) + (ly:make-stencil (ly:stencil-expr m) x y))) -(def-markup-command (fontsize paper props mag arg) (number? markup?) - "This sets the relative font size, eg. -@example -A \\fontsize #2 @{ B C @} D -@end example +(define-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)) + (y (ly:stencil-extent m Y))) + + + (ly:make-stencil (ly:stencil-expr m) + (interval-widen x amount) + (interval-widen y amount)) + )) + + +(define-markup-command (pad-x layout props amount arg) (number? markup?) + + "Add padding @var{amount} around @var{arg} in the X-direction. " + (let* + ((m (interpret-markup layout props arg)) + (x (ly:stencil-extent m X)) + (y (ly:stencil-extent m Y))) + + + (ly:make-stencil (ly:stencil-expr m) + (interval-widen x amount) + 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}. " + + (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) + )) + +(define-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) + (number-pair? number-pair? markup?) + "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space" + + (let* + ((m (interpret-markup layout props arg)) + (x (ly:stencil-extent m X)) + (y (ly:stencil-extent m Y))) + + (ly:make-stencil (ly:stencil-expr m) + (interval-union x-ext x) + (interval-union y-ext y)))) + + +(define-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." + + (interpret-markup layout props + (make-pad-to-box-markup + (cons (/ length -2) (/ length 2)) + '(0 . 0) + (make-hcenter-markup arg)))) + + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; property +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(define-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))))) + + +(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." + (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-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 + +@verbatim +\\override #'(font-family . married) \"bla\" +@end verbatim -This will enlarge the B and the C by two steps. " + (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" + (interpret-markup - paper - (prepend-alist-chain 'font-size mag props) - arg)) + layout props + (if (ly:get-option 'safe) + "verbatim-file disabled in safe mode" + (let* + ((str (ly:gulp-file name)) + (lines (string-split str #\nl))) + + (make-typewriter-markup + (make-column-markup lines))) + ))) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; fonts. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + + +(define-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" + (interpret-markup layout props + `(,fontsize-markup -1 ,arg))) + +(define-markup-command larger (markup?) bigger-markup) + +(define-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." -(def-markup-command (magnify paper props sz arg) (number? markup?) - "This sets the font magnification for the its argument. In the following + (let* ((fs (chain-assoc-get 'font-size props 0)) + (bs (chain-assoc-get 'baseline-skip props 2)) + (entries (list + (cons 'baseline-skip (* bs (magstep increment))) + (cons 'font-size (+ fs increment ))))) + + (interpret-markup layout (cons entries props) arg))) + + + +;; 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 @@ -73,286 +849,523 @@ A \\magnify #1.1 @{ A @} A 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?) +(define-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)) +(define-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?) +(define-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?) +(define-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?) +(define-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?) +(define-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?) +(define-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?) +(define-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?) +(define-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?) +(define-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 (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 +(define-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?) + "Turn @code{text}, which should be a string, to small caps. +@example +\\markup \\smallCaps \"Text between double quotes\" +@end example " - (interpret-markup paper (prepend-alist-chain 'font-family 'dynamic props) arg)) - -(def-markup-command (italic paper props arg) (markup?) - (interpret-markup paper (prepend-alist-chain 'font-shape 'italic props) arg)) - -(def-markup-command (typewriter paper props arg) (markup?) - (interpret-markup paper (prepend-alist-chain 'font-family 'typewriter props) arg)) - -(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?) - (stack-lines - -1 0.0 (cdr (chain-assoc 'baseline-skip props)) - (map (lambda (m) (interpret-markup paper props m)) args))) - -(def-markup-command (dir-column paper props args) (markup-list?) - "Make a column of args, going up or down, depending on the setting -of the #'direction layout property." - (let* ((dir (cdr (chain-assoc 'direction props)))) - (stack-lines - (if (number? dir) dir -1) - 0.0 - (cdr (chain-assoc 'baseline-skip props)) - (map (lambda (x) (interpret-markup paper props x)) args)))) + (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?) + (interpret-markup layout props (make-smallCaps-markup arg))) + +(define-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 + layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg)) -(def-markup-command (center paper props args) (markup-list?) - (let* ((mols (map (lambda (x) (interpret-markup paper props x)) args)) - (cmols (map (lambda (x) (ly:molecule-align-to! x X CENTER)) mols))) - (stack-lines -1 0.0 (cdr (chain-assoc 'baseline-skip props)) mols))) +(define-markup-command (text layout props arg) (markup?) + "Use a text font instead of music symbol or music alphabet font." -(def-markup-command (right-align paper props arg) (markup?) - (let* ((m (interpret-markup paper props arg))) - (ly:molecule-align-to! m X RIGHT) - m)) + ;; ugh - latin1 + (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props) + arg)) -(def-markup-command (left-align paper props arg) (markup?) - (let* ((m (interpret-markup paper props arg))) - (ly:molecule-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." +(define-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)) - - (let* ((m (interpret-markup paper props arg))) - (ly:molecule-align-to! m X dir) - m)) +(define-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?) + "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)." + (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." + ;; ugh - latin1 + (interpret-markup layout + (cons '((font-family . roman) (font-shape . upright) + (font-series . medium) (font-encoding . latin1)) + props) + arg)) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; symbols. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(def-markup-command (musicglyph paper props glyph-name) (string?) +(define-markup-command (doublesharp layout props) () + "Draw a double sharp symbol." + + (interpret-markup layout props (markup #:musicglyph "accidentals.4"))) + +(define-markup-command (sesquisharp layout props) () + "Draw a 3/2 sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.3"))) + +(define-markup-command (sharp layout props) () + "Draw a sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.2"))) + +(define-markup-command (semisharp layout props) () + "Draw a semi sharp symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.1"))) + +(define-markup-command (natural layout props) () + "Draw a natural symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.0"))) + +(define-markup-command (semiflat layout props) () + "Draw a semiflat." + (interpret-markup layout props (markup #:musicglyph "accidentals.M1"))) + +(define-markup-command (flat layout props) () + "Draw a flat symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.M2"))) + +(define-markup-command (sesquiflat layout props) () + "Draw a 3/2 flat symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.M3"))) + +(define-markup-command (doubleflat layout props) () + "Draw a double flat symbol." + (interpret-markup layout props (markup #:musicglyph "accidentals.M4"))) + +(define-markup-command (with-color layout props color arg) (color? markup?) + "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) + (integer? ly:dir? boolean?) + "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 + "close" + "open") + axis + direction))) + (ly:font-get-glyph + (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) + props)) + name))) + +(define-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)) +#\"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:font-get-glyph + (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) + props)) glyph-name)) - -(def-markup-command (lookup paper props glyph-name) (string?) +(define-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 +(define-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)) -(def-markup-command (raise paper 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] - 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. + (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num))) -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. " +(define number->mark-letter-vector (make-vector 25 #\A)) - - (ly:molecule-translate-axis (interpret-markup paper props arg) - amount Y)) - -(def-markup-command (fraction paper props arg1 arg2) (markup? markup?) - "Make a fraction of two markups. - -Syntax: \\fraction MARKUP1 MARKUP2." - (let* ((m1 (interpret-markup paper props arg1)) - (m2 (interpret-markup paper props arg2))) - (ly:molecule-align-to! m1 X CENTER) - (ly:molecule-align-to! m2 X CENTER) - (let* ((x1 (ly:molecule-get-extent m1 X)) - (x2 (ly:molecule-get-extent m2 X)) - (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0)) - ;; should stack mols separately, to maintain LINE on baseline - (stack (stack-lines -1 0.2 0.6 (list m1 line m2)))) - (ly:molecule-align-to! stack Y CENTER) - (ly:molecule-align-to! stack X LEFT) - ;; should have EX dimension - ;; empirical anyway - (ly:molecule-translate-axis stack 0.75 Y)))) +(do ((i 0 (1+ i)) + (j 0 (1+ j))) + ((>= i 26)) + (if (= i (- (char->integer #\I) (char->integer #\A))) + (set! i (1+ i))) + (vector-set! number->mark-letter-vector j + (integer->char (+ i (char->integer #\A))))) + +(define number->mark-alphabet-vector (list->vector + (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26)))) + +(define (number->markletter-string vec n) + "Double letters for big marks." + (let* ((lst (vector-length vec))) + + (if (>= n lst) + (string-append (number->markletter-string vec (1- (quotient n lst))) + (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." + (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." + (ly:text-interface::interpret-markup layout props + (number->markletter-string number->mark-alphabet-vector num))) + + + +(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" + (let* + ((mag (magstep (chain-assoc-get 'font-size props 0))) + (thickness + (* mag + (chain-assoc-get 'thickness props 0.16))) + (dy (* mag 0.15)) + (number-stencil (interpret-markup layout + (prepend-alist-chain 'font-encoding 'fetaNumber props) + (number->string num))) + (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))) + )) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; the note command. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; 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)) - (attachx (if (> dir 0) - (- (cdr (ly:molecule-get-extent headgl X)) stemth) - 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:molecule-get-extent dot X))) +(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 +@var{dir}, you can obtain longer or shorter stems." + + (define (get-glyph-name-candidates dir log style) + (map (lambda (dir-name) + (format "noteheads.~a~a~a" dir-name (min log 2) + (if (and (symbol? style) + (not (equal? 'default style))) + (symbol->string style) + ""))) + (list (if (= dir UP) "u" "d") + "s"))) + + (define (get-glyph-name font cands) + (if (null? cands) + "" + (if (ly:stencil-empty? (ly:font-get-glyph font (car cands))) + (get-glyph-name font (cdr cands)) + (car cands)))) + + (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props))) + (size-factor (magstep (chain-assoc-get 'font-size props 0))) + (style (chain-assoc-get 'style props '())) + (stem-length (* size-factor (max 3 (- log 1)))) + (head-glyph-name (get-glyph-name font (get-glyph-name-candidates (sign dir) log style))) + (head-glyph (ly:font-get-glyph font head-glyph-name)) + (attach-indices (ly:note-head::stem-attachment font head-glyph-name)) + (stem-thickness (* size-factor 0.13)) + (stemy (* dir stem-length)) + (attach-off (cons (interval-index + (ly:stencil-extent head-glyph X) + (* (sign dir) (car attach-indices))) + (* (sign dir) ; fixme, this is inconsistent between X & Y. + (interval-index + (ly:stencil-extent head-glyph Y) + (cdr attach-indices))))) + (stem-glyph (and (> log 0) + (ly:round-filled-box + (ordered-cons (car attach-off) + (+ (car attach-off) (* (- (sign dir)) stem-thickness))) + (cons (min stemy (cdr attach-off)) + (max stemy (cdr attach-off))) + (/ 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:molecule-add + (apply ly:stencil-add (map (lambda (x) - (ly:molecule-translate-axis - dot (* (+ 1 (* 2 x)) dotwid) X) ) + (ly:stencil-translate-axis + dot (* (+ 1 (* 2 x)) dotwid) X)) (iota dot-count 1))))) (flaggl (and (> log 2) - (ly:molecule-translate - (ly:find-glyph-by-name font - (string-append "flags-" - (if (> dir 0) "u" "d") - (number->string log))) - (cons (+ attachx (/ stemth 2)) stemy))))) + (ly:stencil-translate + (ly:font-get-glyph font + (string-append "flags." + (if (> dir 0) "u" "d") + (number->string log))) + (cons (+ (car attach-off) (/ stem-thickness 2)) stemy))))) (if flaggl - (set! stemgl (ly:molecule-add flaggl stemgl))) - (if (ly:molecule? stemgl) - (set! stemgl (ly:molecule-add stemgl headgl)) - (set! stemgl headgl)) - (if (ly:molecule? dots) - (set! stemgl - (ly:molecule-add - (ly:molecule-translate-axis dots - (+ (if (and (> dir 0) (> log 2)) - (* 1.5 dotwid) - 0) - ;; huh ? why not necessary? - ;;(cdr (ly:molecule-get-extent headgl X)) - dotwid) - X) - stemgl))) - stemgl)) - -(use-modules (ice-9 regex)) + (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! 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-extent head-glyph X)) + dotwid) + X) + stem-glyph))) + stem-glyph)) (define-public log2 (let ((divisor (log 2))) (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)) (dots (match:substring match 2))) - (list (cond ((string=? len "breve") -1) - ((string=? len "longa") -2) + (list (cond ((string=? len "breve") -1) + ((string=? len "longa") -2) ((string=? len "maxima") -3) (else (log2 (string->number len)))) (if dots (string-length dots) 0))) - (error "This is not a valid duration string:" duration-string)))) + (ly:error (_ "not a valid duration string: ~a") duration-string)))) -(def-markup-command (note paper props duration dir) (string? number?) +(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 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." - (ly:molecule-translate-axis (interpret-markup - paper - props arg) - (* 0.5 (cdr (chain-assoc 'baseline-skip props))) - Y)) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; translating. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(def-markup-command (super paper props arg) (markup?) +(define-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}. +" + (ly:stencil-translate-axis (interpret-markup layout props arg) + (- amount) Y)) + + +(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}." + + (let* + ((factor (magstep (chain-assoc-get 'font-size props 0))) + (scaled (cons (* factor (car offset)) + (* factor (cdr offset))))) + + (ly:stencil-translate (interpret-markup layout props arg) + scaled))) + +(define-markup-command (raise layout props amount arg) (number? markup?) + " +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. + +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. " + (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." + (let* ((m1 (interpret-markup layout props arg1)) + (m2 (interpret-markup layout props arg2))) + (set! m1 (ly:stencil-aligned-to m1 X CENTER)) + (set! m2 (ly:stencil-aligned-to m2 X CENTER)) + (let* ((x1 (ly:stencil-extent m1 X)) + (x2 (ly:stencil-extent m2 X)) + (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0)) + ;; should stack mols separately, to maintain LINE on baseline + (stack (stack-lines -1 0.2 0.6 (list m1 line m2)))) + (set! stack + (ly:stencil-aligned-to stack Y CENTER)) + (set! stack + (ly:stencil-aligned-to stack X LEFT)) + ;; should have EX dimension + ;; empirical anyway + (ly:stencil-translate-axis stack 0.75 Y)))) + + + + + +(define-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 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 @@ -370,16 +1383,15 @@ Raising and lowering texts can be done with @code{\\super} and @end lilypond " - - (ly:molecule-translate-axis + (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?) +(define-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 @@ -389,122 +1401,119 @@ surroundings. This command cannot be used to move isolated scripts vertically, for the same reason that @code{\\raise} cannot be used for that. -. " - (ly:molecule-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." - (ly:molecule-translate-axis +(define-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?) - (ly:molecule-translate-axis - (interpret-markup paper props arg) - (* -0.5 (cdr (chain-assoc 'baseline-skip props))) +(define-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 layout props arg) + (* -0.5 (chain-assoc-get 'baseline-skip props)) Y)) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; brackets. +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(def-markup-command (hbracket paper props arg) (markup?) - "Horizontal brackets around @var{arg}." +(define-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))) - (bracketify-molecule m X th (* 2.5 th) th))) + (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}." +(define-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))) - (bracketify-molecule m Y th (* 2.5 th) th))) - -;; todo: fix negative space -(def-markup-command (hspace paper props amount) (number?) - "This produces a invisible object taking horizontal space. -@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. -" - (if (> amount 0) - (ly:make-molecule "" (cons 0 amount) '(-1 . 1) ) - (ly:make-molecule "" (cons amount amount) '(-1 . 1)))) + (m (interpret-markup layout props arg))) + (bracketify-stencil m Y th (* 2.5 th) th))) -(def-markup-command (override paper 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 - -@verbatim -\\override #'(font-family . married) \"bla\" -@end verbatim +(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. " - (interpret-markup paper (cons (list new-prop) props) arg)) - -(def-markup-command (smaller paper props arg) (markup?) - "Decrease the font size relative to current setting" - (let* ((fs (chain-assoc-get 'font-size props 0)) - (entry (cons 'font-size (- fs 1)))) - (interpret-markup paper (cons (list entry) props) arg))) - - -(def-markup-command (bigger paper 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))) - -(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))) - (box-molecule m th pad))) - -(def-markup-command (strut paper props) () +;; +;; DROPME? This command is a relic from the old figured bass implementation. +;; - "Create a box of the same height as the space in the current font. + (define (sublist lst start stop) + (take (drop lst start) (- (1+ stop) start))) -FIXME: is this working? -" + (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)))) - (let ((m (Text_item::interpret_markup paper props " "))) - (ly:molecule-set-extent! m X '(1000 . -1000)) - m)) -(define number->mark-letter-vector (make-vector 25 #\A)) + (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)))) + -(do ((i 0 (1+ i)) - (j 0 (1+ j))) - ((>= i 26)) - (if (= i (- (char->integer #\I) (char->integer #\A))) - (set! i (1+ i))) - (vector-set! number->mark-letter-vector j - (integer->char (+ i (char->integer #\A))))) - -(define (number->markletter-string n) - "Double letters for big marks." - (let* - ((l (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))))) - - -(def-markup-command (markletter paper props num) (integer?) - "Make a markup letter for @var{num}. The letters start with A to Z -(skipping I), and continues with double letters." - - (Text_item::interpret_markup paper props (number->markletter-string num))) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; size indications arrow +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;