scm/define-markup-commands.scm

   1 ;;;; define-markup-commands.scm -- markup commands
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2000--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 ;;; markup commands
  10 ;;;  * each markup function should have a doc string with
  11 ;;     syntax, description and example.
  12
  13 (use-modules (ice-9 regex))
  14
  15 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  16 ;; utility functions
  17 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  18
  19 (define-public empty-stencil (ly:make-stencil '() '(1 . -1) '(1 . -1)))
  20 (define-public point-stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
  21
  22
  23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24 ;; geometric shapes
  25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  26
  27 (def-markup-command (draw-circle layout props radius thickness fill)
  28   (number? number? boolean?)
  29   "A circle of radius @var{radius}, thickness @var{thickness} and
  30 optionally filled."
  31   (make-circle-stencil radius thickness fill))
  32
  33 (def-markup-command (triangle layout props filled) (boolean?)
  34   "A triangle, filled or not"
  35   (let*
  36       ((th (chain-assoc-get 'thickness props  0.1))
  37        (size (chain-assoc-get 'font-size props 0))
  38        (ex (* (magstep size)
  39               0.8
  40               (chain-assoc-get 'baseline-skip props 2))))
  41
  42     (ly:make-stencil
  43      `(polygon '(0.0 0.0
  44                      ,ex 0.0
  45                      ,(* 0.5 ex)
  46                      ,(* 0.86 ex))
  47            ,th
  48            ,filled)
  49
  50      (cons 0 ex)
  51      (cons 0 (* .86 ex))
  52      )))
  53
  54 (def-markup-command (circle layout props arg) (markup?)
  55   "Draw a circle around @var{arg}.  Use @code{thickness},
  56 @code{circle-padding} and @code{font-size} properties to determine line
  57 thickness and padding around the markup."
  58   (let* ((th (chain-assoc-get 'thickness props  0.1))
  59          (size (chain-assoc-get 'font-size props 0))
  60          (pad
  61           (* (magstep size)
  62              (chain-assoc-get 'circle-padding props 0.2)))
  63          (m (interpret-markup layout props arg)))
  64     (circle-stencil m th pad)))
  65
  66 (def-markup-command (with-url layout props url arg) (string? markup?)
  67   "Add a link to URL @var{url} around @var{arg}. This only works in
  68 the PDF backend."
  69   (let* ((stil (interpret-markup layout props arg))
  70          (xextent (ly:stencil-extent stil X))
  71          (yextent (ly:stencil-extent stil Y))
  72          (old-expr (ly:stencil-expr stil))
  73          (url-expr (list 'url-link url `(quote ,xextent) `(quote ,yextent))))
  74     (ly:stencil-add (ly:make-stencil url-expr xextent yextent) stil)))
  75
  76
  77 (def-markup-command (beam layout props width slope thickness)
  78   (number? number? number?)
  79   "Create a beam with the specified parameters."
  80   (let* ((y (* slope width))
  81          (yext (cons (min 0 y) (max 0 y)))
  82          (half (/ thickness 2)))
  83
  84     (ly:make-stencil
  85      `(polygon ',(list
  86                   0 (/ thickness -2)
  87                     width (+ (* width slope)  (/ thickness -2))
  88                     width (+ (* width slope)  (/ thickness 2))
  89                     0 (/ thickness 2))
  90                ,(ly:output-def-lookup layout 'blotdiameter)
  91                #t)
  92      (cons 0 width)
  93      (cons (+ (- half) (car yext))
  94            (+ half (cdr yext))))))
  95
  96 (def-markup-command (box layout props arg) (markup?)
  97   "Draw a box round @var{arg}.  Looks at @code{thickness},
  98 @code{box-padding} and @code{font-size} properties to determine line
  99 thickness and padding around the markup."
 100   (let* ((th (chain-assoc-get 'thickness props  0.1))
 101          (size (chain-assoc-get 'font-size props 0))
 102          (pad (* (magstep size)
 103                  (chain-assoc-get 'box-padding props 0.2)))
 104          (m (interpret-markup layout props arg)))
 105     (box-stencil m th pad)))
 106
 107 (def-markup-command (filled-box layout props xext yext blot)
 108   (number-pair? number-pair? number?)
 109   "Draw a box with rounded corners of dimensions @var{xext} and @var{yext}."
 110   (ly:round-filled-box
 111    xext yext blot))
 112
 113 (def-markup-command (whiteout layout props arg) (markup?)
 114   "Provide a white underground for @var{arg}"
 115   (let* ((stil (interpret-markup layout props
 116                                  (make-with-color-markup black arg)))
 117          (white
 118           (interpret-markup layout props
 119                             (make-with-color-markup
 120                              white
 121                              (make-filled-box-markup
 122                               (ly:stencil-extent stil X)
 123                               (ly:stencil-extent stil Y)
 124                               0.0)))))
 125
 126     (ly:stencil-add white stil)))
 127
 128 (def-markup-command (pad-markup layout props padding arg) (number? markup?)
 129   "Add space around a markup object."
 130
 131   (let*
 132       ((stil (interpret-markup layout props arg))
 133        (xext (ly:stencil-extent stil X))
 134        (yext (ly:stencil-extent stil Y)))
 135
 136     (ly:make-stencil
 137      (ly:stencil-expr stil)
 138      (interval-widen xext padding)
 139      (interval-widen yext padding))))
 140
 141 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 142 ;; space
 143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 144
 145 ;;FIXME: is this working?
 146 (def-markup-command (strut layout props) ()
 147   "Create a box of the same height as the space in the current font."
 148   (let ((m (Text_interface::interpret_markup layout props " ")))
 149     (ly:make-stencil (ly:stencil-expr m)
 150                      '(1000 . -1000)
 151                      (ly:stencil-extent m X)
 152                      )))
 153
 154
 155 ;; todo: fix negative space
 156 (def-markup-command (hspace layout props amount) (number?)
 157   "This produces a invisible object taking horizontal space.
 158 @example
 159 \\markup @{ A \\hspace #2.0 B @}
 160 @end example
 161 will put extra space between A and B, on top of the space that is
 162 normally inserted before elements on a line.
 163 "
 164   (if (> amount 0)
 165       (ly:make-stencil "" (cons 0 amount) '(-1 . 1))
 166       (ly:make-stencil "" (cons amount amount) '(-1 . 1))))
 167
 168
 169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 170 ;; importing graphics.
 171 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 172
 173 (def-markup-command (stencil layout props stil) (ly:stencil?)
 174   "Stencil as markup"
 175   stil)
 176
 177 (define bbox-regexp
 178   (make-regexp "%%BoundingBox:[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)[ \t]+([0-9-]+)"))
 179
 180 (define (get-postscript-bbox string)
 181   "Extract the bbox from STRING, or return #f if not present."
 182   (let*
 183       ((match (regexp-exec bbox-regexp string)))
 184
 185     (if match
 186         (map (lambda (x)
 187                (string->number (match:substring match x)))
 188              (cdr (iota 5)))
 189
 190         #f)))
 191
 192 (def-markup-command (epsfile layout props file-name) (string?)
 193   "Inline an EPS image. The image is scaled such that 10 PS units is
 194 one staff-space."
 195
 196   (if (ly:get-option 'safe)
 197       (interpret-markup layout props "not allowed in safe")
 198       (let*
 199           ((contents (ly:gulp-file file-name))
 200            (bbox (get-postscript-bbox contents))
 201            (scaled-bbox
 202             (if bbox
 203                 (map (lambda (x) (/ x 10)) bbox)
 204                 (begin
 205                   (ly:warning (_ "can't find bounding box of `~a'")
 206                            file-name)
 207                   '()))))
 208
 209
 210         (if bbox
 211
 212             (ly:make-stencil
 213              (list
 214               'embedded-ps
 215               (string-append
 216
 217                ; adobe 5002.
 218                "BeginEPSF "
 219                "0.1 0.1 scale "
 220                (format "\n%%BeginDocument: ~a\n" file-name)
 221                contents
 222                "%%EndDocument\n"
 223                "EndEPSF\n"
 224                ))
 225              (cons (list-ref scaled-bbox 0) (list-ref scaled-bbox 2))
 226              (cons (list-ref scaled-bbox 1) (list-ref scaled-bbox 3)))
 227
 228             (ly:make-stencil "" '(0 . 0) '(0 . 0))))))
 229
 230
 231 (def-markup-command (postscript layout props str) (string?)
 232   "This inserts @var{str} directly into the output as a PostScript
 233 command string.  Due to technicalities of the output backends,
 234 different scales should be used for the @TeX{} and PostScript backend,
 235 selected with @code{-f}.
 236
 237
 238 For the TeX backend, the following string prints a rotated text
 239
 240 @cindex rotated text
 241
 242 @verbatim
 243 0 0 moveto /ecrm10 findfont
 244 1.75 scalefont setfont 90 rotate (hello) show
 245 @end verbatim
 246
 247 @noindent
 248 The magical constant 1.75 scales from LilyPond units (staff spaces) to
 249 TeX dimensions.
 250
 251 For the postscript backend, use the following
 252
 253 @verbatim
 254 gsave /ecrm10 findfont
 255  10.0 output-scale div
 256  scalefont setfont 90 rotate (hello) show grestore
 257 @end verbatim
 258 "
 259   ;; FIXME
 260   (ly:make-stencil
 261    (list 'embedded-ps str)
 262    '(0 . 0) '(0 . 0)))
 263
 264
 265 (def-markup-command (score layout props score) (ly:score?)
 266   "Inline an image of music."
 267   (let* ((output (ly:score-embedded-format score layout)))
 268
 269     (if (ly:music-output? output)
 270         (paper-system-stencil
 271          (vector-ref (ly:paper-score-paper-systems output) 0))
 272         (begin
 273           (ly:warning (_"no systems found in \\score markup, does it have a \\layout block?"))
 274           empty-stencil))))
 275
 276 (def-markup-command (null layout props) ()
 277   "An empty markup with extents of a single point"
 278
 279   point-stencil)
 280
 281 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 282 ;; basic formatting.
 283 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 284
 285 (def-markup-command (simple layout props str) (string?)
 286   "A simple text string; @code{\\markup @{ foo @}} is equivalent with
 287 @code{\\markup @{ \\simple #\"foo\" @}}."
 288   (interpret-markup layout props str))
 289
 290
 291 ;; TODO: use font recoding.
 292 ;;                    (make-line-markup
 293 ;;                     (map make-word-markup (string-tokenize str)))))
 294
 295 (define-public empty-markup
 296   (make-simple-markup ""))
 297
 298 ;; helper for justifying lines.
 299 (define (get-fill-space word-count line-width text-widths)
 300   "Calculate the necessary paddings between each two adjacent texts.
 301         The lengths of all texts are stored in @var{text-widths}.
 302         The normal formula for the padding between texts a and b is:
 303         padding = line-width/(word-count - 1) - (length(a) + length(b))/2
 304         The first and last padding have to be calculated specially using the
 305         whole length of the first or last text.
 306         Return a list of paddings.
 307 "
 308   (cond
 309    ((null? text-widths) '())
 310
 311    ;; special case first padding
 312    ((= (length text-widths) word-count)
 313     (cons
 314      (- (- (/ line-width (1- word-count)) (car text-widths))
 315         (/ (car (cdr text-widths)) 2))
 316      (get-fill-space word-count line-width (cdr text-widths))))
 317    ;; special case last padding
 318    ((= (length text-widths) 2)
 319     (list (- (/ line-width (1- word-count))
 320              (+ (/ (car text-widths) 2) (car (cdr text-widths)))) 0))
 321    (else
 322     (cons
 323      (- (/ line-width (1- word-count))
 324         (/ (+ (car text-widths) (car (cdr text-widths))) 2))
 325      (get-fill-space word-count line-width (cdr text-widths))))))
 326
 327 (def-markup-command (fill-line layout props markups)
 328   (markup-list?)
 329   "Put @var{markups} in a horizontal line of width @var{line-width}.
 330    The markups are spaced/flushed to fill the entire line.
 331    If there are no arguments, return an empty stencil."
 332
 333   (let* ((orig-stencils
 334           (map (lambda (x) (interpret-markup layout props x))
 335                markups))
 336          (stencils
 337           (map (lambda (stc)
 338                  (if (ly:stencil-empty? stc)
 339                      point-stencil
 340                      stc)) orig-stencils))
 341          (text-widths
 342           (map (lambda (stc)
 343                  (if (ly:stencil-empty? stc)
 344                      0.0
 345                      (interval-length (ly:stencil-extent stc X))))
 346                stencils))
 347          (text-width (apply + text-widths))
 348          (text-dir (chain-assoc-get 'text-direction props RIGHT))
 349          (word-count (length stencils))
 350          (word-space (chain-assoc-get 'word-space props))
 351          (line-width (chain-assoc-get 'linewidth props))
 352          (fill-space
 353                 (cond
 354                         ((= word-count 1)
 355                                 (list
 356                                         (/ (- line-width text-width) 2)
 357                                         (/ (- line-width text-width) 2)))
 358                         ((= word-count 2)
 359                                 (list
 360                                         (- line-width text-width)))
 361                         (else
 362                                 (get-fill-space word-count line-width text-widths))))
 363          (fill-space-normal
 364           (map (lambda (x)
 365                  (if (< x word-space)
 366                      word-space
 367                      x))
 368                fill-space))
 369
 370          (line-stencils (if (= word-count 1)
 371                             (list
 372                              point-stencil
 373                              (car stencils)
 374                              point-stencil)
 375                             stencils)))
 376
 377     (if (= text-dir LEFT)
 378         (set! line-stencils (reverse line-stencils)))
 379
 380     (if (null? (remove ly:stencil-empty? orig-stencils))
 381         empty-stencil
 382         (stack-stencils-padding-list X
 383                                      RIGHT fill-space-normal line-stencils))))
 384
 385 (def-markup-command (line layout props args) (markup-list?)
 386   "Put @var{args} in a horizontal line.  The property @code{word-space}
 387 determines the space between each markup in @var{args}."
 388   (let*
 389       ((stencils (map (lambda (m) (interpret-markup layout props m)) args))
 390        (space    (chain-assoc-get 'word-space props))
 391        (text-dir (chain-assoc-get 'text-direction props RIGHT))
 392        )
 393
 394
 395     (if (= text-dir LEFT)
 396         (set! stencils (reverse stencils)))
 397
 398
 399     (stack-stencil-line
 400      space
 401      (remove ly:stencil-empty? stencils))))
 402
 403
 404 (define (wordwrap-stencils stencils
 405                            justify base-space line-width text-dir)
 406
 407   "Perform simple wordwrap, return stencil of each line."
 408
 409   (define space (if justify
 410
 411                     ;; justify only stretches lines.
 412                     (* 0.7 base-space)
 413                     base-space))
 414
 415   (define (take-list width space stencils
 416                      accumulator accumulated-width)
 417     "Return (head-list . tail) pair, with head-list fitting into width"
 418     (if (null? stencils)
 419         (cons accumulator stencils)
 420         (let*
 421             ((first (car stencils))
 422              (first-wid (cdr (ly:stencil-extent (car stencils) X)))
 423              (newwid (+ space first-wid accumulated-width))
 424              )
 425
 426           (if
 427            (or (null? accumulator)
 428                (< newwid width))
 429
 430            (take-list width space
 431                       (cdr stencils)
 432                       (cons first accumulator)
 433                       newwid)
 434              (cons accumulator stencils))
 435            )))
 436
 437     (let loop
 438         ((lines '())
 439          (todo stencils))
 440
 441       (let*
 442           ((line-break (take-list line-width space todo
 443                                  '() 0.0))
 444            (line-stencils (car line-break))
 445            (space-left (- line-width (apply + (map (lambda (x) (cdr (ly:stencil-extent x X)))
 446                                               line-stencils))))
 447
 448            (line-word-space (cond
 449                              ((not justify) space)
 450
 451                              ;; don't stretch last line of paragraph.
 452                              ;; hmmm . bug - will overstretch the last line in some case.
 453                              ((null? (cdr line-break))
 454                               base-space)
 455                              ((null? line-stencils) 0.0)
 456                              ((null? (cdr line-stencils)) 0.0)
 457                              (else (/ space-left (1- (length line-stencils))))))
 458
 459            (line (stack-stencil-line
 460                   line-word-space
 461                   (if (= text-dir RIGHT)
 462                       (reverse line-stencils)
 463                       line-stencils))))
 464
 465         (if (pair? (cdr line-break))
 466             (loop (cons line lines)
 467                   (cdr line-break))
 468
 469             (begin
 470               (if (= text-dir LEFT)
 471                   (set! line
 472                         (ly:stencil-translate-axis line
 473                                                    (- line-width (interval-end (ly:stencil-extent line X)))
 474                                                    X)))
 475               (reverse (cons line lines))
 476
 477             )))
 478
 479       ))
 480
 481
 482 (define (wordwrap-markups layout props args justify)
 483   (let*
 484       ((baseline-skip (chain-assoc-get 'baseline-skip props))
 485        (line-width (chain-assoc-get 'linewidth props))
 486        (word-space (chain-assoc-get 'word-space props))
 487        (text-dir (chain-assoc-get 'text-direction props RIGHT))
 488        (lines (wordwrap-stencils
 489                (remove ly:stencil-empty?
 490                        (map (lambda (m) (interpret-markup layout props m)) args))
 491                justify word-space line-width
 492                text-dir)
 493                ))
 494
 495     (stack-lines DOWN 0.0 baseline-skip lines)))
 496
 497 (def-markup-command (justify layout props args) (markup-list?)
 498   "Like wordwrap, but with lines stretched to justify the margins.
 499 Use @code{\\override #'(linewidth . X)} to set linewidth, where X
 500 is the number of staff spaces."
 501
 502   (wordwrap-markups layout props args #t))
 503
 504 (def-markup-command (wordwrap layout props args) (markup-list?)
 505   "Simple wordwrap.  Use @code{\\override #'(linewidth . X)} to set
 506 linewidth, where X is the number of staff spaces."
 507
 508   (wordwrap-markups layout props args #f))
 509
 510 (define (wordwrap-string layout props justify arg)
 511   (let*
 512       ((baseline-skip (chain-assoc-get 'baseline-skip props))
 513        (line-width (chain-assoc-get 'linewidth props))
 514        (word-space (chain-assoc-get 'word-space props))
 515        (para-strings (regexp-split arg "\n[ \t\n]*\n[ \t\n]*"))
 516
 517        (text-dir (chain-assoc-get 'text-direction props RIGHT))
 518        (list-para-words (map (lambda (str)
 519                                (regexp-split str "[ \t\n]+"))
 520                              para-strings))
 521        (para-lines (map (lambda (words)
 522                           (let*
 523                               ((stencils
 524                                 (remove
 525                                  ly:stencil-empty? (map
 526                                       (lambda (x)
 527                                         (interpret-markup layout props x))
 528                                       words)))
 529                                (lines (wordwrap-stencils stencils
 530                                                          justify word-space
 531                                                          line-width text-dir
 532                                                          )))
 533
 534                             lines))
 535
 536                         list-para-words)))
 537
 538     (stack-lines DOWN 0.0 baseline-skip (apply append para-lines))))
 539
 540
 541 (def-markup-command (wordwrap-string layout props arg) (string?)
 542   "Wordwrap a string. Paragraphs may be separated with double newlines"
 543   (wordwrap-string layout props  #f arg))
 544
 545 (def-markup-command (justify-string layout props arg) (string?)
 546   "Justify a string. Paragraphs may be separated with double newlines"
 547   (wordwrap-string layout props #t arg))
 548
 549
 550 (def-markup-command (wordwrap-field layout props symbol) (symbol?)
 551    (let* ((m (chain-assoc-get symbol props)))
 552      (if (string? m)
 553       (interpret-markup layout props
 554        (list wordwrap-string-markup m))
 555       (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 556
 557 (def-markup-command (justify-field layout props symbol) (symbol?)
 558    (let* ((m (chain-assoc-get symbol props)))
 559      (if (string? m)
 560       (interpret-markup layout props
 561        (list justify-string-markup m))
 562       (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 563
 564
 565
 566 (def-markup-command (combine layout props m1 m2) (markup? markup?)
 567   "Print two markups on top of each other."
 568   (let* ((s1 (interpret-markup layout props m1))
 569          (s2 (interpret-markup layout props m2)))
 570     (ly:stencil-add s1 s2)))
 571
 572 ;;
 573 ;; TODO: should extract baseline-skip from each argument somehow..
 574 ;;
 575 (def-markup-command (column layout props args) (markup-list?)
 576   "Stack the markups in @var{args} vertically.  The property
 577 @code{baseline-skip} determines the space between each markup in @var{args}."
 578   (stack-lines
 579    -1 0.0 (chain-assoc-get 'baseline-skip props)
 580    (remove ly:stencil-empty?
 581            (map (lambda (m) (interpret-markup layout props m)) args))))
 582
 583 (def-markup-command (dir-column layout props args) (markup-list?)
 584   "Make a column of args, going up or down, depending on the setting
 585 of the @code{#'direction} layout property."
 586   (let* ((dir (chain-assoc-get 'direction props)))
 587     (stack-lines
 588      (if (number? dir) dir -1)
 589      0.0
 590      (chain-assoc-get 'baseline-skip props)
 591      (map (lambda (x) (interpret-markup layout props x)) args))))
 592
 593 (def-markup-command (center-align layout props args) (markup-list?)
 594   "Put @code{args} in a centered column. "
 595   (let* ((mols (map (lambda (x) (interpret-markup layout props x)) args))
 596          (cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols)))
 597     (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) cmols)))
 598
 599 (def-markup-command (vcenter layout props arg) (markup?)
 600   "Align @code{arg} to its Y center. "
 601   (let* ((mol (interpret-markup layout props arg)))
 602     (ly:stencil-aligned-to mol Y CENTER)))
 603
 604 (def-markup-command (hcenter layout props arg) (markup?)
 605   "Align @code{arg} to its X center. "
 606   (let* ((mol (interpret-markup layout props arg)))
 607     (ly:stencil-aligned-to mol X CENTER)))
 608
 609 (def-markup-command (right-align layout props arg) (markup?)
 610   "Align @var{arg} on its right edge. "
 611   (let* ((m (interpret-markup layout props arg)))
 612     (ly:stencil-aligned-to m X RIGHT)))
 613
 614 (def-markup-command (left-align layout props arg) (markup?)
 615   "Align @var{arg} on its left edge. "
 616   (let* ((m (interpret-markup layout props arg)))
 617     (ly:stencil-aligned-to m X LEFT)))
 618
 619 (def-markup-command (general-align layout props axis dir arg)  (integer? number? markup?)
 620   "Align @var{arg} in @var{axis} direction to the @var{dir} side."
 621   (let* ((m (interpret-markup layout props arg)))
 622     (ly:stencil-aligned-to m axis dir)))
 623
 624 (def-markup-command (halign layout props dir arg) (number? markup?)
 625   "Set horizontal alignment. If @var{dir} is @code{-1}, then it is
 626 left-aligned, while @code{+1} is right. Values in between interpolate
 627 alignment accordingly."
 628   (let* ((m (interpret-markup layout props arg)))
 629     (ly:stencil-aligned-to m X dir)))
 630
 631
 632 (def-markup-command (pad-around layout props amount arg) (number? markup?)
 633
 634   "Add padding @var{amount} all around @var{arg}. "
 635
 636   (let*
 637       ((m (interpret-markup layout props arg))
 638        (x (ly:stencil-extent m X))
 639        (y (ly:stencil-extent m Y)))
 640
 641
 642     (ly:make-stencil (ly:stencil-expr m)
 643                      (interval-widen x amount)
 644                      (interval-widen y amount))
 645    ))
 646 (def-markup-command (put-adjacent layout props arg1 axis dir arg2) (markup? integer? ly:dir?  markup?)
 647
 648   "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}.  "
 649
 650   (let* ((m1 (interpret-markup layout props arg1))
 651          (m2 (interpret-markup layout props arg2)))
 652
 653     (ly:stencil-combine-at-edge m1 axis dir m2 0.0 0.0)
 654   ))
 655
 656 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 657 ;; property
 658 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 659
 660 (def-markup-command (fromproperty layout props symbol) (symbol?)
 661   "Read the @var{symbol} from property settings, and produce a stencil
 662   from the markup contained within. If @var{symbol} is not defined, it
 663   returns an empty markup"
 664   (let* ((m (chain-assoc-get symbol props)))
 665     (if (markup? m)
 666         (interpret-markup layout props m)
 667         (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 668
 669
 670 (def-markup-command (on-the-fly layout props procedure arg) (symbol? markup?)
 671   "Apply the @var{procedure} markup command to
 672 @var{arg}. @var{procedure} should take a single argument."
 673   (let* ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg))))
 674     (set-object-property! anonymous-with-signature
 675                           'markup-signature
 676                           (list markup?))
 677     (interpret-markup layout props (list anonymous-with-signature arg))))
 678
 679
 680
 681 (def-markup-command (override layout props new-prop arg) (pair? markup?)
 682   "Add the first argument in to the property list.  Properties may be
 683 any sort of property supported by @internalsref{font-interface} and
 684 @internalsref{text-interface}, for example
 685
 686 @verbatim
 687 \\override #'(font-family . married) \"bla\"
 688 @end verbatim
 689
 690 "
 691   (interpret-markup layout (cons (list new-prop) props) arg))
 692
 693 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 694 ;; fonts.
 695 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 696
 697
 698 (def-markup-command (bigger layout props arg) (markup?)
 699   "Increase the font size relative to current setting"
 700   (interpret-markup layout props
 701    `(,fontsize-markup 1 ,arg)))
 702
 703 (def-markup-command (smaller layout props arg) (markup?)
 704   "Decrease the font size relative to current setting"
 705   (interpret-markup layout props
 706    `(,fontsize-markup -1 ,arg)))
 707
 708 (def-markup-command larger (markup?) bigger-markup)
 709
 710 (def-markup-command (finger layout props arg) (markup?)
 711   "Set the argument as small numbers."
 712   (interpret-markup layout
 713                     (cons '((font-size . -5) (font-encoding . fetaNumber)) props)
 714                     arg))
 715
 716
 717 (def-markup-command (fontsize layout props increment arg) (number? markup?)
 718   "Add @var{increment} to the font-size. Adjust baseline skip accordingly."
 719
 720   (let* ((fs (chain-assoc-get 'font-size props 0))
 721          (bs (chain-assoc-get 'baseline-skip props 2))
 722          (entries (list
 723                    (cons 'baseline-skip (* bs (magstep increment)))
 724                    (cons 'font-size (+ fs increment )))))
 725
 726     (interpret-markup layout (cons entries props) arg)))
 727
 728
 729
 730 ;; FIXME -> should convert to font-size.
 731 (def-markup-command (magnify layout props sz arg) (number? markup?)
 732   "Set the font magnification for the its argument. In the following
 733 example, the middle A will be 10% larger:
 734 @example
 735 A \\magnify #1.1 @{ A @} A
 736 @end example
 737
 738 Note: magnification only works if a font-name is explicitly selected.
 739 Use @code{\\fontsize} otherwise."
 740   (interpret-markup
 741    layout
 742    (prepend-alist-chain 'font-magnification sz props)
 743    arg))
 744
 745 (def-markup-command (bold layout props arg) (markup?)
 746   "Switch to bold font-series"
 747   (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
 748
 749 (def-markup-command (sans layout props arg) (markup?)
 750   "Switch to the sans serif family"
 751   (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
 752
 753 (def-markup-command (number layout props arg) (markup?)
 754   "Set font family to @code{number}, which yields the font used for
 755 time signatures and fingerings.  This font only contains numbers and
 756 some punctuation. It doesn't have any letters.  "
 757   (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
 758
 759 (def-markup-command (roman layout props arg) (markup?)
 760   "Set font family to @code{roman}."
 761   (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
 762
 763 (def-markup-command (huge layout props arg) (markup?)
 764   "Set font size to +2."
 765   (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
 766
 767 (def-markup-command (large layout props arg) (markup?)
 768   "Set font size to +1."
 769   (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
 770
 771 (def-markup-command (normalsize layout props arg) (markup?)
 772   "Set font size to default."
 773   (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
 774
 775 (def-markup-command (small layout props arg) (markup?)
 776   "Set font size to -1."
 777   (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
 778
 779 (def-markup-command (tiny layout props arg) (markup?)
 780   "Set font size to -2."
 781   (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
 782
 783 (def-markup-command (teeny layout props arg) (markup?)
 784   "Set font size to -3."
 785   (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
 786
 787 (def-markup-command (caps layout props arg) (markup?)
 788   "Set @code{font-shape} to @code{caps}."
 789   (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
 790
 791 (def-markup-command (dynamic layout props arg) (markup?)
 792   "Use the dynamic font.  This font only contains @b{s}, @b{f}, @b{m},
 793 @b{z}, @b{p}, and @b{r}.  When producing phrases, like ``pi@`{u} @b{f}'', the
 794 normal words (like ``pi@`{u}'') should be done in a different font.  The
 795 recommend font for this is bold and italic"
 796   (interpret-markup
 797    layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
 798
 799 (def-markup-command (text layout props arg) (markup?)
 800   "Use a text font instead of music symbol or music alphabet font."
 801
 802   ;; ugh - latin1
 803   (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
 804                     arg))
 805
 806
 807 (def-markup-command (italic layout props arg) (markup?)
 808   "Use italic @code{font-shape} for @var{arg}. "
 809   (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
 810
 811 (def-markup-command (typewriter layout props arg) (markup?)
 812   "Use @code{font-family} typewriter for @var{arg}."
 813   (interpret-markup
 814    layout (prepend-alist-chain 'font-family 'typewriter props) arg))
 815
 816 (def-markup-command (upright layout props arg) (markup?)
 817   "Set font shape to @code{upright}.  This is the opposite of @code{italic}."
 818   (interpret-markup
 819    layout (prepend-alist-chain 'font-shape 'upright props) arg))
 820
 821 (def-markup-command (medium layout props arg) (markup?)
 822   "Switch to medium font-series (in contrast to bold)."
 823   (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
 824                     arg))
 825
 826 (def-markup-command (normal-text layout props arg) (markup?)
 827   "Set all font related properties (except the size) to get the default normal text font, no matter what font was used earlier."
 828   ;; ugh - latin1
 829   (interpret-markup layout
 830                     (cons '((font-family . roman) (font-shape . upright)
 831                             (font-series . medium) (font-encoding . latin1))
 832                           props)
 833                     arg))
 834
 835 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 836 ;; symbols.
 837 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 838
 839 (def-markup-command (doublesharp layout props) ()
 840   "Draw a double sharp symbol."
 841
 842   (interpret-markup layout props (markup #:musicglyph "accidentals.4")))
 843
 844 (def-markup-command (sesquisharp layout props) ()
 845   "Draw a 3/2 sharp symbol."
 846   (interpret-markup layout props (markup #:musicglyph "accidentals.3")))
 847
 848 (def-markup-command (sharp layout props) ()
 849   "Draw a sharp symbol."
 850   (interpret-markup layout props (markup #:musicglyph "accidentals.2")))
 851
 852 (def-markup-command (semisharp layout props) ()
 853   "Draw a semi sharp symbol."
 854   (interpret-markup layout props (markup #:musicglyph "accidentals.1")))
 855
 856 (def-markup-command (natural layout props) ()
 857   "Draw a natural symbol."
 858   (interpret-markup layout props (markup #:musicglyph "accidentals.0")))
 859
 860 (def-markup-command (semiflat layout props) ()
 861   "Draw a semiflat."
 862   (interpret-markup layout props (markup #:musicglyph "accidentals.M1")))
 863
 864 (def-markup-command (flat layout props) ()
 865   "Draw a flat symbol."
 866   (interpret-markup layout props (markup #:musicglyph "accidentals.M2")))
 867
 868 (def-markup-command (sesquiflat layout props) ()
 869   "Draw a 3/2 flat symbol."
 870   (interpret-markup layout props (markup #:musicglyph "accidentals.M3")))
 871
 872 (def-markup-command (doubleflat layout props) ()
 873   "Draw a double flat symbol."
 874   (interpret-markup layout props (markup #:musicglyph "accidentals.M4")))
 875
 876 (def-markup-command (with-color layout props color arg) (color? markup?)
 877   "Draw @var{arg} in color specified by @var{color}"
 878
 879   (let* ((stil (interpret-markup layout props arg)))
 880
 881     (ly:make-stencil (list 'color color (ly:stencil-expr stil))
 882                      (ly:stencil-extent stil X)
 883                      (ly:stencil-extent stil Y))))
 884
 885 \f
 886 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 887 ;; glyphs
 888 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 889
 890
 891 (def-markup-command (arrow-head layout props axis direction filled)
 892   (integer? ly:dir? boolean?)
 893   "produce an arrow head in specified direction and axis. Use the filled head if @var{filled} is  specified."
 894   (let*
 895       ((name (format "arrowheads.~a.~a~a"
 896                      (if filled
 897                          "close"
 898                          "open")
 899                      axis
 900                      direction)))
 901     (ly:font-get-glyph
 902      (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
 903                                      props))
 904      name)))
 905
 906 (def-markup-command (musicglyph layout props glyph-name) (string?)
 907   "This is converted to a musical symbol, e.g. @code{\\musicglyph
 908 #\"accidentals.0\"} will select the natural sign from the music font.
 909 See @usermanref{The Feta font} for  a complete listing of the possible glyphs."
 910   (ly:font-get-glyph
 911    (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
 912                                    props))
 913    glyph-name))
 914
 915 (def-markup-command (lookup layout props glyph-name) (string?)
 916   "Lookup a glyph by name."
 917   (ly:font-get-glyph (ly:paper-get-font layout props)
 918                      glyph-name))
 919
 920 (def-markup-command (char layout props num) (integer?)
 921   "Produce a single character, e.g. @code{\\char #65} produces the
 922 letter 'A'."
 923   (ly:get-glyph (ly:paper-get-font layout props) num))
 924
 925
 926 (define number->mark-letter-vector (make-vector 25 #\A))
 927
 928 (do ((i 0 (1+ i))
 929      (j 0 (1+ j)))
 930     ((>= i 26))
 931   (if (= i (- (char->integer #\I) (char->integer #\A)))
 932       (set! i (1+ i)))
 933   (vector-set! number->mark-letter-vector j
 934                (integer->char (+ i (char->integer #\A)))))
 935
 936 (define number->mark-alphabet-vector (list->vector
 937   (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
 938
 939 (define (number->markletter-string vec n)
 940   "Double letters for big marks."
 941   (let* ((lst (vector-length vec)))
 942
 943     (if (>= n lst)
 944         (string-append (number->markletter-string vec (1- (quotient n lst)))
 945                        (number->markletter-string vec (remainder n lst)))
 946         (make-string 1 (vector-ref vec n)))))
 947
 948 (def-markup-command (markletter layout props num) (integer?)
 949   "Make a markup letter for @var{num}.  The letters start with A to Z
 950  (skipping I), and continues with double letters."
 951   (Text_interface::interpret_markup layout props
 952     (number->markletter-string number->mark-letter-vector num)))
 953
 954 (def-markup-command (markalphabet layout props num) (integer?)
 955    "Make a markup letter for @var{num}.  The letters start with A to Z
 956  and continues with double letters."
 957    (Text_interface::interpret_markup layout props
 958      (number->markletter-string number->mark-alphabet-vector num)))
 959
 960 \f
 961 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 962 ;; the note command.
 963 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 964
 965
 966 ;; TODO: better syntax.
 967
 968 (def-markup-command (note-by-number layout props log dot-count dir) (number? number? number?)
 969   "Construct a note symbol, with stem.  By using fractional values for
 970 @var{dir}, you can obtain longer or shorter stems."
 971   (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)))
 972          (size (chain-assoc-get 'font-size props 0))
 973          (stem-length (* (magstep size) (max 3 (- log 1))))
 974          (head-glyph (ly:font-get-glyph
 975                       font
 976                       (string-append "noteheads.s" (number->string (min log 2)))))
 977          (stem-thickness 0.13)
 978          (stemy (* dir stem-length))
 979          (attachx (if (> dir 0)
 980                       (- (cdr (ly:stencil-extent head-glyph X)) stem-thickness)
 981                       0))
 982          (attachy (* dir 0.28))
 983          (stem-glyph (and (> log 0)
 984                           (ly:round-filled-box
 985                            (cons attachx (+ attachx  stem-thickness))
 986                            (cons (min stemy attachy)
 987                                  (max stemy attachy))
 988                            (/ stem-thickness 3))))
 989          (dot (ly:font-get-glyph font "dots.dot"))
 990          (dotwid (interval-length (ly:stencil-extent dot X)))
 991          (dots (and (> dot-count 0)
 992                     (apply ly:stencil-add
 993                            (map (lambda (x)
 994                                   (ly:stencil-translate-axis
 995                                    dot  (* (+ 1 (* 2 x)) dotwid) X))
 996                                 (iota dot-count 1)))))
 997          (flaggl (and (> log 2)
 998                       (ly:stencil-translate
 999                        (ly:font-get-glyph font
1000                                           (string-append "flags."
1001                                                          (if (> dir 0) "u" "d")
1002                                                          (number->string log)))
1003                        (cons (+ attachx (/ stem-thickness 2)) stemy)))))
1004     (if flaggl
1005         (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
1006     (if (ly:stencil? stem-glyph)
1007         (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
1008         (set! stem-glyph head-glyph))
1009     (if (ly:stencil? dots)
1010         (set! stem-glyph
1011               (ly:stencil-add
1012                (ly:stencil-translate-axis
1013                 dots
1014                 (+ (if (and (> dir 0) (> log 2))
1015                        (* 1.5 dotwid)
1016                        0)
1017                    ;; huh ? why not necessary?
1018                    ;;(cdr (ly:stencil-extent head-glyph X))
1019                    dotwid)
1020                 X)
1021                stem-glyph)))
1022     stem-glyph))
1023
1024 (define-public log2
1025   (let ((divisor (log 2)))
1026     (lambda (z) (inexact->exact (/ (log z) divisor)))))
1027
1028 (define (parse-simple-duration duration-string)
1029   "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list."
1030   (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string)))
1031     (if (and match (string=? duration-string (match:substring match 0)))
1032         (let ((len  (match:substring match 1))
1033               (dots (match:substring match 2)))
1034           (list (cond ((string=? len "breve") -1)
1035                       ((string=? len "longa") -2)
1036                       ((string=? len "maxima") -3)
1037                       (else (log2 (string->number len))))
1038                 (if dots (string-length dots) 0)))
1039         (ly:error (_ "not a valid duration string: ~a") duration-string))))
1040
1041 (def-markup-command (note layout props duration dir) (string? number?)
1042   "This produces a note with a stem pointing in @var{dir} direction, with
1043 the @var{duration} for the note head type and augmentation dots. For
1044 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
1045 a shortened down stem."
1046   (let ((parsed (parse-simple-duration duration)))
1047     (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
1048
1049 \f
1050 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1051 ;; translating.
1052 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1053
1054 (def-markup-command (lower layout props amount arg) (number? markup?)
1055   "
1056 Lower @var{arg}, by the distance @var{amount}.
1057 A negative @var{amount} indicates raising, see also @code{\raise}.
1058 "
1059   (ly:stencil-translate-axis (interpret-markup layout props arg)
1060                              (- amount) Y))
1061
1062
1063 (def-markup-command (raise layout props amount arg) (number? markup?)
1064   "
1065 Raise @var{arg}, by the distance @var{amount}.
1066 A negative @var{amount} indicates lowering, see also @code{\\lower}.
1067 @c
1068 @lilypond[verbatim,fragment,relative=1]
1069  c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }}
1070 @end lilypond
1071 The argument to @code{\\raise} is the vertical displacement amount,
1072 measured in (global) staff spaces.  @code{\\raise} and @code{\\super}
1073 raise objects in relation to their surrounding markups.
1074
1075 If the text object itself is positioned above or below the staff, then
1076 @code{\\raise} cannot be used to move it, since the mechanism that
1077 positions it next to the staff cancels any shift made with
1078 @code{\\raise}. For vertical positioning, use the @code{padding}
1079 and/or @code{extra-offset} properties. "
1080   (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
1081
1082 (def-markup-command (fraction layout props arg1 arg2) (markup? markup?)
1083   "Make a fraction of two markups."
1084   (let* ((m1 (interpret-markup layout props arg1))
1085          (m2 (interpret-markup layout props arg2)))
1086     (set! m1 (ly:stencil-aligned-to m1 X CENTER))
1087     (set! m2 (ly:stencil-aligned-to m2 X CENTER))
1088     (let* ((x1 (ly:stencil-extent m1 X))
1089            (x2 (ly:stencil-extent m2 X))
1090            (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
1091            ;; should stack mols separately, to maintain LINE on baseline
1092            (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
1093       (set! stack
1094             (ly:stencil-aligned-to stack Y CENTER))
1095       (set! stack
1096             (ly:stencil-aligned-to stack X LEFT))
1097       ;; should have EX dimension
1098       ;; empirical anyway
1099       (ly:stencil-translate-axis stack 0.75 Y))))
1100
1101
1102
1103
1104
1105 (def-markup-command (normal-size-super layout props arg) (markup?)
1106   "Set @var{arg} in superscript with a normal font size."
1107   (ly:stencil-translate-axis
1108    (interpret-markup layout props arg)
1109    (* 0.5 (chain-assoc-get 'baseline-skip props)) Y))
1110
1111 (def-markup-command (super layout props arg) (markup?)
1112   "
1113 @cindex raising text
1114 @cindex lowering text
1115 @cindex moving text
1116 @cindex translating text
1117
1118 @cindex @code{\\super}
1119
1120
1121 Raising and lowering texts can be done with @code{\\super} and
1122 @code{\\sub}:
1123
1124 @lilypond[verbatim,fragment,relative=1]
1125  c1^\\markup { E \"=\" mc \\super \"2\" }
1126 @end lilypond
1127
1128 "
1129   (ly:stencil-translate-axis
1130    (interpret-markup
1131     layout
1132     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1133     arg)
1134    (* 0.5 (chain-assoc-get 'baseline-skip props))
1135    Y))
1136
1137 (def-markup-command (translate layout props offset arg) (number-pair? markup?)
1138   "This translates an object. Its first argument is a cons of numbers
1139 @example
1140 A \\translate #(cons 2 -3) @{ B C @} D
1141 @end example
1142 This moves `B C' 2 spaces to the right, and 3 down, relative to its
1143 surroundings. This command cannot be used to move isolated scripts
1144 vertically, for the same reason that @code{\\raise} cannot be used for
1145 that.
1146
1147 "
1148   (ly:stencil-translate (interpret-markup  layout props arg)
1149                         offset))
1150
1151 (def-markup-command (sub layout props arg) (markup?)
1152   "Set @var{arg} in subscript."
1153   (ly:stencil-translate-axis
1154    (interpret-markup
1155     layout
1156     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1157     arg)
1158    (* -0.5 (chain-assoc-get 'baseline-skip props))
1159    Y))
1160
1161 (def-markup-command (normal-size-sub layout props arg) (markup?)
1162   "Set @var{arg} in subscript, in a normal font size."
1163   (ly:stencil-translate-axis
1164    (interpret-markup layout props arg)
1165    (* -0.5 (chain-assoc-get 'baseline-skip props))
1166    Y))
1167 \f
1168 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1169 ;; brackets.
1170 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1171
1172 (def-markup-command (hbracket layout props arg) (markup?)
1173   "Draw horizontal brackets around @var{arg}."
1174   (let ((th 0.1) ;; todo: take from GROB.
1175         (m (interpret-markup layout props arg)))
1176     (bracketify-stencil m X th (* 2.5 th) th)))
1177
1178 (def-markup-command (bracket layout props arg) (markup?)
1179   "Draw vertical brackets around @var{arg}."
1180   (let ((th 0.1) ;; todo: take from GROB.
1181         (m (interpret-markup layout props arg)))
1182     (bracketify-stencil m Y th (* 2.5 th) th)))
1183
1184 (def-markup-command (bracketed-y-column layout props indices args)
1185   (list? markup-list?)
1186   "Make a column of the markups in @var{args}, putting brackets around
1187 the elements marked in @var{indices}, which is a list of numbers."
1188   (define (sublist lst start stop)
1189     (take (drop lst start) (- (1+ stop) start)))
1190
1191   (define (stencil-list-extent ss axis)
1192     (cons
1193      (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
1194      (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
1195
1196
1197   (define (stack-stencils-vertically stencils bskip last-stencil)
1198     (cond
1199      ((null? stencils) '())
1200      ((not (ly:stencil? last-stencil))
1201       (cons (car stencils)
1202             (stack-stencils-vertically (cdr stencils) bskip (car stencils))))
1203      (else
1204       (let* ((orig (car stencils))
1205              (dir (chain-assoc-get 'direction  props DOWN))
1206              (new (ly:stencil-moved-to-edge last-stencil Y dir
1207                                             orig
1208                                             0.1 bskip)))
1209
1210         (cons new (stack-stencils-vertically (cdr stencils) bskip new))))))
1211
1212   (define (make-brackets stencils indices acc)
1213     (if (and stencils
1214              (pair? indices)
1215              (pair? (cdr indices)))
1216         (let* ((encl (sublist stencils (car indices) (cadr indices)))
1217                (x-ext (stencil-list-extent encl X))
1218                (y-ext (stencil-list-extent encl Y))
1219                (thick 0.10)
1220                (pad 0.35)
1221                (protusion (* 2.5 thick))
1222                (lb
1223                 (ly:stencil-translate-axis
1224                  (ly:bracket Y y-ext thick protusion)
1225                  (- (car x-ext) pad) X))
1226                (rb (ly:stencil-translate-axis
1227                     (ly:bracket Y y-ext thick (- protusion))
1228                     (+ (cdr x-ext) pad) X)))
1229
1230           (make-brackets
1231            stencils (cddr indices)
1232            (append
1233             (list lb rb)
1234             acc)))
1235         acc))
1236
1237   (let* ((stencils
1238           (map (lambda (x)
1239                  (interpret-markup
1240                   layout
1241                   props
1242                   x)) args))
1243          (leading
1244           (chain-assoc-get 'baseline-skip props))
1245          (stacked (stack-stencils-vertically
1246                    (remove ly:stencil-empty? stencils) 1.25 #f))
1247          (brackets (make-brackets stacked indices '())))
1248
1249     (apply ly:stencil-add
1250            (append stacked brackets))))
1251 \f
1252
1253 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1254 ;; size indications arrow
1255 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1256