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
 516        (para-strings (regexp-split
 517                       (string-regexp-substitute "\r" "" arg)
 518                       "\n[ \t\n]*\n[ \t\n]*"))
 519
 520        (text-dir (chain-assoc-get 'text-direction props RIGHT))
 521        (list-para-words (map (lambda (str)
 522                                (regexp-split str "[ \t\n]+"))
 523                              para-strings))
 524        (para-lines (map (lambda (words)
 525                           (let*
 526                               ((stencils
 527                                 (remove
 528                                  ly:stencil-empty? (map
 529                                       (lambda (x)
 530                                         (interpret-markup layout props x))
 531                                       words)))
 532                                (lines (wordwrap-stencils stencils
 533                                                          justify word-space
 534                                                          line-width text-dir
 535                                                          )))
 536
 537                             lines))
 538
 539                         list-para-words)))
 540
 541     (stack-lines DOWN 0.0 baseline-skip (apply append para-lines))))
 542
 543
 544 (def-markup-command (wordwrap-string layout props arg) (string?)
 545   "Wordwrap a string. Paragraphs may be separated with double newlines"
 546   (wordwrap-string layout props  #f arg))
 547
 548 (def-markup-command (justify-string layout props arg) (string?)
 549   "Justify a string. Paragraphs may be separated with double newlines"
 550   (wordwrap-string layout props #t arg))
 551
 552
 553 (def-markup-command (wordwrap-field layout props symbol) (symbol?)
 554    (let* ((m (chain-assoc-get symbol props)))
 555      (if (string? m)
 556       (interpret-markup layout props
 557        (list wordwrap-string-markup m))
 558       (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 559
 560 (def-markup-command (justify-field layout props symbol) (symbol?)
 561    (let* ((m (chain-assoc-get symbol props)))
 562      (if (string? m)
 563       (interpret-markup layout props
 564        (list justify-string-markup m))
 565       (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 566
 567
 568
 569 (def-markup-command (combine layout props m1 m2) (markup? markup?)
 570   "Print two markups on top of each other."
 571   (let* ((s1 (interpret-markup layout props m1))
 572          (s2 (interpret-markup layout props m2)))
 573     (ly:stencil-add s1 s2)))
 574
 575 ;;
 576 ;; TODO: should extract baseline-skip from each argument somehow..
 577 ;;
 578 (def-markup-command (column layout props args) (markup-list?)
 579   "Stack the markups in @var{args} vertically.  The property
 580 @code{baseline-skip} determines the space between each markup in @var{args}."
 581   (stack-lines
 582    -1 0.0 (chain-assoc-get 'baseline-skip props)
 583    (remove ly:stencil-empty?
 584            (map (lambda (m) (interpret-markup layout props m)) args))))
 585
 586 (def-markup-command (dir-column layout props args) (markup-list?)
 587   "Make a column of args, going up or down, depending on the setting
 588 of the @code{#'direction} layout property."
 589   (let* ((dir (chain-assoc-get 'direction props)))
 590     (stack-lines
 591      (if (number? dir) dir -1)
 592      0.0
 593      (chain-assoc-get 'baseline-skip props)
 594      (map (lambda (x) (interpret-markup layout props x)) args))))
 595
 596 (def-markup-command (center-align layout props args) (markup-list?)
 597   "Put @code{args} in a centered column. "
 598   (let* ((mols (map (lambda (x) (interpret-markup layout props x)) args))
 599          (cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols)))
 600     (stack-lines -1 0.0 (chain-assoc-get 'baseline-skip props) cmols)))
 601
 602 (def-markup-command (vcenter layout props arg) (markup?)
 603   "Align @code{arg} to its Y center. "
 604   (let* ((mol (interpret-markup layout props arg)))
 605     (ly:stencil-aligned-to mol Y CENTER)))
 606
 607 (def-markup-command (hcenter layout props arg) (markup?)
 608   "Align @code{arg} to its X center. "
 609   (let* ((mol (interpret-markup layout props arg)))
 610     (ly:stencil-aligned-to mol X CENTER)))
 611
 612 (def-markup-command (right-align layout props arg) (markup?)
 613   "Align @var{arg} on its right edge. "
 614   (let* ((m (interpret-markup layout props arg)))
 615     (ly:stencil-aligned-to m X RIGHT)))
 616
 617 (def-markup-command (left-align layout props arg) (markup?)
 618   "Align @var{arg} on its left edge. "
 619   (let* ((m (interpret-markup layout props arg)))
 620     (ly:stencil-aligned-to m X LEFT)))
 621
 622 (def-markup-command (general-align layout props axis dir arg)  (integer? number? markup?)
 623   "Align @var{arg} in @var{axis} direction to the @var{dir} side."
 624   (let* ((m (interpret-markup layout props arg)))
 625     (ly:stencil-aligned-to m axis dir)))
 626
 627 (def-markup-command (halign layout props dir arg) (number? markup?)
 628   "Set horizontal alignment. If @var{dir} is @code{-1}, then it is
 629 left-aligned, while @code{+1} is right. Values in between interpolate
 630 alignment accordingly."
 631   (let* ((m (interpret-markup layout props arg)))
 632     (ly:stencil-aligned-to m X dir)))
 633
 634
 635 (def-markup-command (pad-around layout props amount arg) (number? markup?)
 636
 637   "Add padding @var{amount} all around @var{arg}. "
 638
 639   (let*
 640       ((m (interpret-markup layout props arg))
 641        (x (ly:stencil-extent m X))
 642        (y (ly:stencil-extent m Y)))
 643
 644
 645     (ly:make-stencil (ly:stencil-expr m)
 646                      (interval-widen x amount)
 647                      (interval-widen y amount))
 648    ))
 649
 650
 651 (def-markup-command (pad-x layout props amount arg) (number? markup?)
 652
 653   "Add padding @var{amount} around @var{arg} in the X-direction. "
 654   (let*
 655       ((m (interpret-markup layout props arg))
 656        (x (ly:stencil-extent m X))
 657        (y (ly:stencil-extent m Y)))
 658
 659
 660     (ly:make-stencil (ly:stencil-expr m)
 661                      (interval-widen x amount)
 662                      y)
 663    ))
 664
 665
 666 (def-markup-command (put-adjacent layout props arg1 axis dir arg2) (markup? integer? ly:dir?  markup?)
 667
 668   "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}.  "
 669
 670   (let* ((m1 (interpret-markup layout props arg1))
 671          (m2 (interpret-markup layout props arg2)))
 672
 673     (ly:stencil-combine-at-edge m1 axis dir m2 0.0 0.0)
 674   ))
 675
 676 (def-markup-command (transparent layout props arg) (markup?)
 677   "Make the argument transparent"
 678   (let*
 679       ((m (interpret-markup layout props arg))
 680        (x (ly:stencil-extent m X))
 681        (y (ly:stencil-extent m Y)))
 682
 683
 684
 685     (ly:make-stencil ""
 686                      x y)))
 687
 688
 689 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 690 ;; property
 691 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 692
 693 (def-markup-command (fromproperty layout props symbol) (symbol?)
 694   "Read the @var{symbol} from property settings, and produce a stencil
 695   from the markup contained within. If @var{symbol} is not defined, it
 696   returns an empty markup"
 697   (let* ((m (chain-assoc-get symbol props)))
 698     (if (markup? m)
 699         (interpret-markup layout props m)
 700         (ly:make-stencil '()  '(1 . -1) '(1 . -1)))))
 701
 702
 703 (def-markup-command (on-the-fly layout props procedure arg) (symbol? markup?)
 704   "Apply the @var{procedure} markup command to
 705 @var{arg}. @var{procedure} should take a single argument."
 706   (let* ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg))))
 707     (set-object-property! anonymous-with-signature
 708                           'markup-signature
 709                           (list markup?))
 710     (interpret-markup layout props (list anonymous-with-signature arg))))
 711
 712
 713
 714 (def-markup-command (override layout props new-prop arg) (pair? markup?)
 715   "Add the first argument in to the property list.  Properties may be
 716 any sort of property supported by @internalsref{font-interface} and
 717 @internalsref{text-interface}, for example
 718
 719 @verbatim
 720 \\override #'(font-family . married) \"bla\"
 721 @end verbatim
 722
 723 "
 724   (interpret-markup layout (cons (list new-prop) props) arg))
 725
 726 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 727 ;; fonts.
 728 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 729
 730
 731 (def-markup-command (bigger layout props arg) (markup?)
 732   "Increase the font size relative to current setting"
 733   (interpret-markup layout props
 734    `(,fontsize-markup 1 ,arg)))
 735
 736 (def-markup-command (smaller layout props arg) (markup?)
 737   "Decrease the font size relative to current setting"
 738   (interpret-markup layout props
 739    `(,fontsize-markup -1 ,arg)))
 740
 741 (def-markup-command larger (markup?) bigger-markup)
 742
 743 (def-markup-command (finger layout props arg) (markup?)
 744   "Set the argument as small numbers."
 745   (interpret-markup layout
 746                     (cons '((font-size . -5) (font-encoding . fetaNumber)) props)
 747                     arg))
 748
 749
 750 (def-markup-command (fontsize layout props increment arg) (number? markup?)
 751   "Add @var{increment} to the font-size. Adjust baseline skip accordingly."
 752
 753   (let* ((fs (chain-assoc-get 'font-size props 0))
 754          (bs (chain-assoc-get 'baseline-skip props 2))
 755          (entries (list
 756                    (cons 'baseline-skip (* bs (magstep increment)))
 757                    (cons 'font-size (+ fs increment )))))
 758
 759     (interpret-markup layout (cons entries props) arg)))
 760
 761
 762
 763 ;; FIXME -> should convert to font-size.
 764 (def-markup-command (magnify layout props sz arg) (number? markup?)
 765   "Set the font magnification for the its argument. In the following
 766 example, the middle A will be 10% larger:
 767 @example
 768 A \\magnify #1.1 @{ A @} A
 769 @end example
 770
 771 Note: magnification only works if a font-name is explicitly selected.
 772 Use @code{\\fontsize} otherwise."
 773   (interpret-markup
 774    layout
 775    (prepend-alist-chain 'font-magnification sz props)
 776    arg))
 777
 778 (def-markup-command (bold layout props arg) (markup?)
 779   "Switch to bold font-series"
 780   (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg))
 781
 782 (def-markup-command (sans layout props arg) (markup?)
 783   "Switch to the sans serif family"
 784   (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
 785
 786 (def-markup-command (number layout props arg) (markup?)
 787   "Set font family to @code{number}, which yields the font used for
 788 time signatures and fingerings.  This font only contains numbers and
 789 some punctuation. It doesn't have any letters.  "
 790   (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
 791
 792 (def-markup-command (roman layout props arg) (markup?)
 793   "Set font family to @code{roman}."
 794   (interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
 795
 796 (def-markup-command (huge layout props arg) (markup?)
 797   "Set font size to +2."
 798   (interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
 799
 800 (def-markup-command (large layout props arg) (markup?)
 801   "Set font size to +1."
 802   (interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
 803
 804 (def-markup-command (normalsize layout props arg) (markup?)
 805   "Set font size to default."
 806   (interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
 807
 808 (def-markup-command (small layout props arg) (markup?)
 809   "Set font size to -1."
 810   (interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
 811
 812 (def-markup-command (tiny layout props arg) (markup?)
 813   "Set font size to -2."
 814   (interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
 815
 816 (def-markup-command (teeny layout props arg) (markup?)
 817   "Set font size to -3."
 818   (interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
 819
 820 (def-markup-command (caps layout props arg) (markup?)
 821   "Set @code{font-shape} to @code{caps}."
 822   (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg))
 823
 824 (def-markup-command (dynamic layout props arg) (markup?)
 825   "Use the dynamic font.  This font only contains @b{s}, @b{f}, @b{m},
 826 @b{z}, @b{p}, and @b{r}.  When producing phrases, like ``pi@`{u} @b{f}'', the
 827 normal words (like ``pi@`{u}'') should be done in a different font.  The
 828 recommend font for this is bold and italic"
 829   (interpret-markup
 830    layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
 831
 832 (def-markup-command (text layout props arg) (markup?)
 833   "Use a text font instead of music symbol or music alphabet font."
 834
 835   ;; ugh - latin1
 836   (interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
 837                     arg))
 838
 839
 840 (def-markup-command (italic layout props arg) (markup?)
 841   "Use italic @code{font-shape} for @var{arg}. "
 842   (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
 843
 844 (def-markup-command (typewriter layout props arg) (markup?)
 845   "Use @code{font-family} typewriter for @var{arg}."
 846   (interpret-markup
 847    layout (prepend-alist-chain 'font-family 'typewriter props) arg))
 848
 849 (def-markup-command (upright layout props arg) (markup?)
 850   "Set font shape to @code{upright}.  This is the opposite of @code{italic}."
 851   (interpret-markup
 852    layout (prepend-alist-chain 'font-shape 'upright props) arg))
 853
 854 (def-markup-command (medium layout props arg) (markup?)
 855   "Switch to medium font-series (in contrast to bold)."
 856   (interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
 857                     arg))
 858
 859 (def-markup-command (normal-text layout props arg) (markup?)
 860   "Set all font related properties (except the size) to get the default normal text font, no matter what font was used earlier."
 861   ;; ugh - latin1
 862   (interpret-markup layout
 863                     (cons '((font-family . roman) (font-shape . upright)
 864                             (font-series . medium) (font-encoding . latin1))
 865                           props)
 866                     arg))
 867
 868 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 869 ;; symbols.
 870 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 871
 872 (def-markup-command (doublesharp layout props) ()
 873   "Draw a double sharp symbol."
 874
 875   (interpret-markup layout props (markup #:musicglyph "accidentals.4")))
 876
 877 (def-markup-command (sesquisharp layout props) ()
 878   "Draw a 3/2 sharp symbol."
 879   (interpret-markup layout props (markup #:musicglyph "accidentals.3")))
 880
 881 (def-markup-command (sharp layout props) ()
 882   "Draw a sharp symbol."
 883   (interpret-markup layout props (markup #:musicglyph "accidentals.2")))
 884
 885 (def-markup-command (semisharp layout props) ()
 886   "Draw a semi sharp symbol."
 887   (interpret-markup layout props (markup #:musicglyph "accidentals.1")))
 888
 889 (def-markup-command (natural layout props) ()
 890   "Draw a natural symbol."
 891   (interpret-markup layout props (markup #:musicglyph "accidentals.0")))
 892
 893 (def-markup-command (semiflat layout props) ()
 894   "Draw a semiflat."
 895   (interpret-markup layout props (markup #:musicglyph "accidentals.M1")))
 896
 897 (def-markup-command (flat layout props) ()
 898   "Draw a flat symbol."
 899   (interpret-markup layout props (markup #:musicglyph "accidentals.M2")))
 900
 901 (def-markup-command (sesquiflat layout props) ()
 902   "Draw a 3/2 flat symbol."
 903   (interpret-markup layout props (markup #:musicglyph "accidentals.M3")))
 904
 905 (def-markup-command (doubleflat layout props) ()
 906   "Draw a double flat symbol."
 907   (interpret-markup layout props (markup #:musicglyph "accidentals.M4")))
 908
 909 (def-markup-command (with-color layout props color arg) (color? markup?)
 910   "Draw @var{arg} in color specified by @var{color}"
 911
 912   (let* ((stil (interpret-markup layout props arg)))
 913
 914     (ly:make-stencil (list 'color color (ly:stencil-expr stil))
 915                      (ly:stencil-extent stil X)
 916                      (ly:stencil-extent stil Y))))
 917
 918 \f
 919 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 920 ;; glyphs
 921 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 922
 923
 924 (def-markup-command (arrow-head layout props axis direction filled)
 925   (integer? ly:dir? boolean?)
 926   "produce an arrow head in specified direction and axis. Use the filled head if @var{filled} is  specified."
 927   (let*
 928       ((name (format "arrowheads.~a.~a~a"
 929                      (if filled
 930                          "close"
 931                          "open")
 932                      axis
 933                      direction)))
 934     (ly:font-get-glyph
 935      (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
 936                                      props))
 937      name)))
 938
 939 (def-markup-command (musicglyph layout props glyph-name) (string?)
 940   "This is converted to a musical symbol, e.g. @code{\\musicglyph
 941 #\"accidentals.0\"} will select the natural sign from the music font.
 942 See @usermanref{The Feta font} for  a complete listing of the possible glyphs."
 943   (ly:font-get-glyph
 944    (ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
 945                                    props))
 946    glyph-name))
 947
 948 (def-markup-command (lookup layout props glyph-name) (string?)
 949   "Lookup a glyph by name."
 950   (ly:font-get-glyph (ly:paper-get-font layout props)
 951                      glyph-name))
 952
 953 (def-markup-command (char layout props num) (integer?)
 954   "Produce a single character, e.g. @code{\\char #65} produces the
 955 letter 'A'."
 956   (ly:get-glyph (ly:paper-get-font layout props) num))
 957
 958
 959 (define number->mark-letter-vector (make-vector 25 #\A))
 960
 961 (do ((i 0 (1+ i))
 962      (j 0 (1+ j)))
 963     ((>= i 26))
 964   (if (= i (- (char->integer #\I) (char->integer #\A)))
 965       (set! i (1+ i)))
 966   (vector-set! number->mark-letter-vector j
 967                (integer->char (+ i (char->integer #\A)))))
 968
 969 (define number->mark-alphabet-vector (list->vector
 970   (map (lambda (i) (integer->char (+ i (char->integer #\A)))) (iota 26))))
 971
 972 (define (number->markletter-string vec n)
 973   "Double letters for big marks."
 974   (let* ((lst (vector-length vec)))
 975
 976     (if (>= n lst)
 977         (string-append (number->markletter-string vec (1- (quotient n lst)))
 978                        (number->markletter-string vec (remainder n lst)))
 979         (make-string 1 (vector-ref vec n)))))
 980
 981 (def-markup-command (markletter layout props num) (integer?)
 982   "Make a markup letter for @var{num}.  The letters start with A to Z
 983  (skipping I), and continues with double letters."
 984   (Text_interface::interpret_markup layout props
 985     (number->markletter-string number->mark-letter-vector num)))
 986
 987 (def-markup-command (markalphabet layout props num) (integer?)
 988    "Make a markup letter for @var{num}.  The letters start with A to Z
 989  and continues with double letters."
 990    (Text_interface::interpret_markup layout props
 991      (number->markletter-string number->mark-alphabet-vector num)))
 992
 993 \f
 994 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 995 ;; the note command.
 996 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 997
 998
 999 ;; TODO: better syntax.
1000
1001 (def-markup-command (note-by-number layout props log dot-count dir) (number? number? number?)
1002   "Construct a note symbol, with stem.  By using fractional values for
1003 @var{dir}, you can obtain longer or shorter stems."
1004   (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)))
1005          (size (chain-assoc-get 'font-size props 0))
1006          (stem-length (* (magstep size) (max 3 (- log 1))))
1007          (head-glyph (ly:font-get-glyph
1008                       font
1009                       (string-append "noteheads.s" (number->string (min log 2)))))
1010          (stem-thickness 0.13)
1011          (stemy (* dir stem-length))
1012          (attachx (if (> dir 0)
1013                       (- (cdr (ly:stencil-extent head-glyph X)) stem-thickness)
1014                       0))
1015          (attachy (* dir 0.28))
1016          (stem-glyph (and (> log 0)
1017                           (ly:round-filled-box
1018                            (cons attachx (+ attachx  stem-thickness))
1019                            (cons (min stemy attachy)
1020                                  (max stemy attachy))
1021                            (/ stem-thickness 3))))
1022          (dot (ly:font-get-glyph font "dots.dot"))
1023          (dotwid (interval-length (ly:stencil-extent dot X)))
1024          (dots (and (> dot-count 0)
1025                     (apply ly:stencil-add
1026                            (map (lambda (x)
1027                                   (ly:stencil-translate-axis
1028                                    dot  (* (+ 1 (* 2 x)) dotwid) X))
1029                                 (iota dot-count 1)))))
1030          (flaggl (and (> log 2)
1031                       (ly:stencil-translate
1032                        (ly:font-get-glyph font
1033                                           (string-append "flags."
1034                                                          (if (> dir 0) "u" "d")
1035                                                          (number->string log)))
1036                        (cons (+ attachx (/ stem-thickness 2)) stemy)))))
1037     (if flaggl
1038         (set! stem-glyph (ly:stencil-add flaggl stem-glyph)))
1039     (if (ly:stencil? stem-glyph)
1040         (set! stem-glyph (ly:stencil-add stem-glyph head-glyph))
1041         (set! stem-glyph head-glyph))
1042     (if (ly:stencil? dots)
1043         (set! stem-glyph
1044               (ly:stencil-add
1045                (ly:stencil-translate-axis
1046                 dots
1047                 (+ (if (and (> dir 0) (> log 2))
1048                        (* 1.5 dotwid)
1049                        0)
1050                    ;; huh ? why not necessary?
1051                    ;;(cdr (ly:stencil-extent head-glyph X))
1052                    dotwid)
1053                 X)
1054                stem-glyph)))
1055     stem-glyph))
1056
1057 (define-public log2
1058   (let ((divisor (log 2)))
1059     (lambda (z) (inexact->exact (/ (log z) divisor)))))
1060
1061 (define (parse-simple-duration duration-string)
1062   "Parse the `duration-string', e.g. ''4..'' or ''breve.'', and return a (log dots) list."
1063   (let ((match (regexp-exec (make-regexp "(breve|longa|maxima|[0-9]+)(\\.*)") duration-string)))
1064     (if (and match (string=? duration-string (match:substring match 0)))
1065         (let ((len  (match:substring match 1))
1066               (dots (match:substring match 2)))
1067           (list (cond ((string=? len "breve") -1)
1068                       ((string=? len "longa") -2)
1069                       ((string=? len "maxima") -3)
1070                       (else (log2 (string->number len))))
1071                 (if dots (string-length dots) 0)))
1072         (ly:error (_ "not a valid duration string: ~a") duration-string))))
1073
1074 (def-markup-command (note layout props duration dir) (string? number?)
1075   "This produces a note with a stem pointing in @var{dir} direction, with
1076 the @var{duration} for the note head type and augmentation dots. For
1077 example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with
1078 a shortened down stem."
1079   (let ((parsed (parse-simple-duration duration)))
1080     (note-by-number-markup layout props (car parsed) (cadr parsed) dir)))
1081
1082 \f
1083 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1084 ;; translating.
1085 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1086
1087 (def-markup-command (lower layout props amount arg) (number? markup?)
1088   "
1089 Lower @var{arg}, by the distance @var{amount}.
1090 A negative @var{amount} indicates raising, see also @code{\raise}.
1091 "
1092   (ly:stencil-translate-axis (interpret-markup layout props arg)
1093                              (- amount) Y))
1094
1095
1096 (def-markup-command (raise layout props amount arg) (number? markup?)
1097   "
1098 Raise @var{arg}, by the distance @var{amount}.
1099 A negative @var{amount} indicates lowering, see also @code{\\lower}.
1100 @c
1101 @lilypond[verbatim,fragment,relative=1]
1102  c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }}
1103 @end lilypond
1104 The argument to @code{\\raise} is the vertical displacement amount,
1105 measured in (global) staff spaces.  @code{\\raise} and @code{\\super}
1106 raise objects in relation to their surrounding markups.
1107
1108 If the text object itself is positioned above or below the staff, then
1109 @code{\\raise} cannot be used to move it, since the mechanism that
1110 positions it next to the staff cancels any shift made with
1111 @code{\\raise}. For vertical positioning, use the @code{padding}
1112 and/or @code{extra-offset} properties. "
1113   (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y))
1114
1115 (def-markup-command (fraction layout props arg1 arg2) (markup? markup?)
1116   "Make a fraction of two markups."
1117   (let* ((m1 (interpret-markup layout props arg1))
1118          (m2 (interpret-markup layout props arg2)))
1119     (set! m1 (ly:stencil-aligned-to m1 X CENTER))
1120     (set! m2 (ly:stencil-aligned-to m2 X CENTER))
1121     (let* ((x1 (ly:stencil-extent m1 X))
1122            (x2 (ly:stencil-extent m2 X))
1123            (line (ly:round-filled-box (interval-union x1 x2) '(-0.05 . 0.05) 0.0))
1124            ;; should stack mols separately, to maintain LINE on baseline
1125            (stack (stack-lines -1 0.2 0.6 (list m1 line m2))))
1126       (set! stack
1127             (ly:stencil-aligned-to stack Y CENTER))
1128       (set! stack
1129             (ly:stencil-aligned-to stack X LEFT))
1130       ;; should have EX dimension
1131       ;; empirical anyway
1132       (ly:stencil-translate-axis stack 0.75 Y))))
1133
1134
1135
1136
1137
1138 (def-markup-command (normal-size-super layout props arg) (markup?)
1139   "Set @var{arg} in superscript with a normal font size."
1140   (ly:stencil-translate-axis
1141    (interpret-markup layout props arg)
1142    (* 0.5 (chain-assoc-get 'baseline-skip props)) Y))
1143
1144 (def-markup-command (super layout props arg) (markup?)
1145   "
1146 @cindex raising text
1147 @cindex lowering text
1148 @cindex moving text
1149 @cindex translating text
1150
1151 @cindex @code{\\super}
1152
1153
1154 Raising and lowering texts can be done with @code{\\super} and
1155 @code{\\sub}:
1156
1157 @lilypond[verbatim,fragment,relative=1]
1158  c1^\\markup { E \"=\" mc \\super \"2\" }
1159 @end lilypond
1160
1161 "
1162   (ly:stencil-translate-axis
1163    (interpret-markup
1164     layout
1165     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1166     arg)
1167    (* 0.5 (chain-assoc-get 'baseline-skip props))
1168    Y))
1169
1170 (def-markup-command (translate layout props offset arg) (number-pair? markup?)
1171   "This translates an object. Its first argument is a cons of numbers
1172 @example
1173 A \\translate #(cons 2 -3) @{ B C @} D
1174 @end example
1175 This moves `B C' 2 spaces to the right, and 3 down, relative to its
1176 surroundings. This command cannot be used to move isolated scripts
1177 vertically, for the same reason that @code{\\raise} cannot be used for
1178 that.
1179
1180 "
1181   (ly:stencil-translate (interpret-markup  layout props arg)
1182                         offset))
1183
1184 (def-markup-command (sub layout props arg) (markup?)
1185   "Set @var{arg} in subscript."
1186   (ly:stencil-translate-axis
1187    (interpret-markup
1188     layout
1189     (cons `((font-size . ,(- (chain-assoc-get 'font-size props 0) 3))) props)
1190     arg)
1191    (* -0.5 (chain-assoc-get 'baseline-skip props))
1192    Y))
1193
1194 (def-markup-command (normal-size-sub layout props arg) (markup?)
1195   "Set @var{arg} in subscript, in a normal font size."
1196   (ly:stencil-translate-axis
1197    (interpret-markup layout props arg)
1198    (* -0.5 (chain-assoc-get 'baseline-skip props))
1199    Y))
1200 \f
1201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1202 ;; brackets.
1203 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1204
1205 (def-markup-command (hbracket layout props arg) (markup?)
1206   "Draw horizontal brackets around @var{arg}."
1207   (let ((th 0.1) ;; todo: take from GROB.
1208         (m (interpret-markup layout props arg)))
1209     (bracketify-stencil m X th (* 2.5 th) th)))
1210
1211 (def-markup-command (bracket layout props arg) (markup?)
1212   "Draw vertical brackets around @var{arg}."
1213   (let ((th 0.1) ;; todo: take from GROB.
1214         (m (interpret-markup layout props arg)))
1215     (bracketify-stencil m Y th (* 2.5 th) th)))
1216
1217 (def-markup-command (bracketed-y-column layout props indices args)
1218   (list? markup-list?)
1219   "Make a column of the markups in @var{args}, putting brackets around
1220 the elements marked in @var{indices}, which is a list of numbers."
1221   (define (sublist lst start stop)
1222     (take (drop lst start) (- (1+ stop) start)))
1223
1224   (define (stencil-list-extent ss axis)
1225     (cons
1226      (apply min (map (lambda (x) (car (ly:stencil-extent x axis))) ss))
1227      (apply max (map (lambda (x) (cdr (ly:stencil-extent x axis))) ss))))
1228
1229
1230   (define (stack-stencils-vertically stencils bskip last-stencil)
1231     (cond
1232      ((null? stencils) '())
1233      ((not (ly:stencil? last-stencil))
1234       (cons (car stencils)
1235             (stack-stencils-vertically (cdr stencils) bskip (car stencils))))
1236      (else
1237       (let* ((orig (car stencils))
1238              (dir (chain-assoc-get 'direction  props DOWN))
1239              (new (ly:stencil-moved-to-edge last-stencil Y dir
1240                                             orig
1241                                             0.1 bskip)))
1242
1243         (cons new (stack-stencils-vertically (cdr stencils) bskip new))))))
1244
1245   (define (make-brackets stencils indices acc)
1246     (if (and stencils
1247              (pair? indices)
1248              (pair? (cdr indices)))
1249         (let* ((encl (sublist stencils (car indices) (cadr indices)))
1250                (x-ext (stencil-list-extent encl X))
1251                (y-ext (stencil-list-extent encl Y))
1252                (thick 0.10)
1253                (pad 0.35)
1254                (protusion (* 2.5 thick))
1255                (lb
1256                 (ly:stencil-translate-axis
1257                  (ly:bracket Y y-ext thick protusion)
1258                  (- (car x-ext) pad) X))
1259                (rb (ly:stencil-translate-axis
1260                     (ly:bracket Y y-ext thick (- protusion))
1261                     (+ (cdr x-ext) pad) X)))
1262
1263           (make-brackets
1264            stencils (cddr indices)
1265            (append
1266             (list lb rb)
1267             acc)))
1268         acc))
1269
1270   (let* ((stencils
1271           (map (lambda (x)
1272                  (interpret-markup
1273                   layout
1274                   props
1275                   x)) args))
1276          (leading
1277           (chain-assoc-get 'baseline-skip props))
1278          (stacked (stack-stencils-vertically
1279                    (remove ly:stencil-empty? stencils) 1.25 #f))
1280          (brackets (make-brackets stacked indices '())))
1281
1282     (apply ly:stencil-add
1283            (append stacked brackets))))
1284 \f
1285
1286 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1287 ;; size indications arrow
1288 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1289