scm/stencil.scm

   1 ;;;; stencil.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2003--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7 (define-public (stack-stencils axis dir padding stils)
   8   "Stack stencils STILS in direction AXIS, DIR, using PADDING."
   9   (cond
  10    ((null? stils) empty-stencil)
  11    ((null? (cdr stils)) (car stils))
  12    (else (ly:stencil-combine-at-edge
  13           (car stils) axis dir (stack-stencils axis dir padding (cdr stils))
  14           padding))))
  15
  16 (define-public (stack-stencils-padding-list axis dir padding stils)
  17   "Stack stencils STILS in direction AXIS, DIR, using a list of PADDING."
  18   (cond
  19    ((null? stils) empty-stencil)
  20    ((null? (cdr stils)) (car stils))
  21    (else (ly:stencil-combine-at-edge
  22           (car stils)
  23           axis dir
  24           (stack-stencils-padding-list axis dir (cdr padding) (cdr stils))
  25           (car padding)))))
  26
  27 (define-public (centered-stencil stencil)
  28   "Center stencil @var{stencil} in both the X and Y directions"
  29   (ly:stencil-aligned-to (ly:stencil-aligned-to stencil X CENTER) Y CENTER))
  30
  31 (define-public (stack-lines dir padding baseline stils)
  32   "Stack vertically with a baseline-skip."
  33   (define result empty-stencil)
  34   (define last-y #f)
  35   (do
  36       ((last-stencil #f (car p))
  37        (p stils (cdr p)))
  38
  39       ((null? p))
  40
  41     (if (number? last-y)
  42         (begin
  43           (let* ((dy (max (+ (* dir (interval-bound (ly:stencil-extent last-stencil Y) dir))
  44                              padding
  45                              (* (- dir) (interval-bound (ly:stencil-extent (car p) Y) (- dir))))
  46                           baseline))
  47                  (y (+ last-y  (* dir dy))))
  48
  49
  50
  51             (set! result
  52                   (ly:stencil-add result (ly:stencil-translate-axis (car p) y Y)))
  53             (set! last-y y)))
  54         (begin
  55           (set! last-y 0)
  56           (set! result (car p)))))
  57
  58   result)
  59
  60
  61 (define-public (bracketify-stencil stil axis thick protusion padding)
  62   "Add brackets around STIL, producing a new stencil."
  63
  64   (let* ((ext (ly:stencil-extent stil axis))
  65          (lb (ly:bracket axis ext thick (- protusion)))
  66          (rb (ly:bracket axis ext thick protusion)))
  67     (set! stil
  68           (ly:stencil-combine-at-edge stil (other-axis axis) 1 lb padding))
  69     (set! stil
  70           (ly:stencil-combine-at-edge stil (other-axis axis) -1 rb padding))
  71     stil))
  72
  73 (define-public (make-filled-box-stencil xext yext)
  74   "Make a filled box."
  75
  76   (ly:make-stencil
  77       (list 'round-filled-box (- (car xext)) (cdr xext)
  78                        (- (car yext)) (cdr yext) 0.0)
  79       xext yext))
  80
  81 (define-public (make-circle-stencil radius thickness fill)
  82   "Make a circle of radius @var{radius} and thickness @var{thickness}"
  83   (ly:make-stencil
  84    (list 'circle radius thickness fill)
  85    (cons (- radius) radius)
  86    (cons (- radius) radius)))
  87
  88 (define-public (box-grob-stencil grob)
  89   "Make a box of exactly the extents of the grob.  The box precisely
  90 encloses the contents.
  91 "
  92   (let* ((xext (ly:grob-extent grob grob 0))
  93          (yext (ly:grob-extent grob grob 1))
  94          (thick 0.1))
  95
  96     (ly:stencil-add
  97      (make-filled-box-stencil xext (cons (- (car yext) thick) (car yext)))
  98      (make-filled-box-stencil xext (cons (cdr yext) (+ (cdr yext) thick)))
  99      (make-filled-box-stencil (cons (cdr xext) (+ (cdr xext) thick)) yext)
 100      (make-filled-box-stencil (cons (- (car xext) thick) (car xext)) yext))))
 101
 102 ;; TODO merge this and prev function.
 103 (define-public (box-stencil stencil thickness padding)
 104   "Add a box around STENCIL, producing a new stencil."
 105   (let* ((x-ext (interval-widen (ly:stencil-extent stencil 0) padding))
 106          (y-ext (interval-widen (ly:stencil-extent stencil 1) padding))
 107          (y-rule (make-filled-box-stencil (cons 0 thickness) y-ext))
 108          (x-rule (make-filled-box-stencil
 109                   (interval-widen x-ext thickness) (cons 0 thickness))))
 110     (set! stencil (ly:stencil-combine-at-edge stencil X 1 y-rule padding))
 111     (set! stencil (ly:stencil-combine-at-edge stencil X -1 y-rule padding))
 112     (set! stencil (ly:stencil-combine-at-edge stencil Y 1 x-rule 0.0))
 113     (set! stencil (ly:stencil-combine-at-edge stencil Y -1 x-rule 0.0))
 114     stencil))
 115
 116 (define-public (circle-stencil stencil thickness padding)
 117   "Add a circle around STENCIL, producing a new stencil."
 118   (let* ((x-ext (ly:stencil-extent stencil 0))
 119          (y-ext (ly:stencil-extent stencil 1))
 120          (diameter (max (- (cdr x-ext) (car x-ext))
 121                         (- (cdr y-ext) (car y-ext))))
 122          (radius (+ (/ diameter 2) padding thickness))
 123          (circle (make-circle-stencil radius thickness #f)))
 124
 125     (ly:stencil-add
 126      stencil
 127      (ly:stencil-translate circle
 128                            (cons
 129                             (interval-center x-ext)
 130                             (interval-center y-ext))))))
 131
 132 (define-public (rounded-box-stencil stencil thickness padding blot)
 133    "Add a rounded box around STENCIL, producing a new stencil."
 134
 135   (let* ((xext (interval-widen (ly:stencil-extent stencil 0) padding))
 136          (yext (interval-widen (ly:stencil-extent stencil 1) padding))
 137    (min-ext (min (-(cdr xext) (car xext)) (-(cdr yext) (car yext))))
 138    (ideal-blot (min blot (/ min-ext 2)))
 139    (ideal-thickness (min thickness (/ min-ext 2)))
 140          (outer (ly:round-filled-box
 141             (interval-widen xext ideal-thickness)
 142             (interval-widen yext ideal-thickness)
 143                ideal-blot))
 144          (inner (ly:make-stencil (list 'color (x11-color 'white)
 145             (ly:stencil-expr (ly:round-filled-box
 146                xext yext (- ideal-blot ideal-thickness)))))))
 147     (set! stencil (ly:stencil-add outer inner))
 148     stencil))
 149
 150
 151 (define-public (fontify-text font-metric text)
 152   "Set TEXT with font FONT-METRIC, returning a stencil."
 153   (let* ((b (ly:text-dimension font-metric text)))
 154     (ly:make-stencil
 155      `(text ,font-metric ,text) (car b) (cdr b))))
 156
 157 (define-public (fontify-text-white scale font-metric text)
 158   "Set TEXT with scale factor SCALE"
 159   (let* ((b (ly:text-dimension font-metric text))
 160          ;;urg -- workaround for using ps font
 161          (c `(white-text ,(* 2 scale) ,text)))
 162     ;;urg -- extent is not from ps font, but we hope it's close
 163     (ly:make-stencil c (car b) (cdr b))))
 164
 165 (define-public (stencil-with-color stencil color)
 166   (ly:make-stencil
 167    (list 'color color (ly:stencil-expr stencil))
 168    (ly:stencil-extent stencil X)
 169    (ly:stencil-extent stencil Y)))
 170
 171 (define-public (stencil-whiteout stencil)
 172   (let*
 173       ((x-ext (ly:stencil-extent stencil X))
 174        (y-ext (ly:stencil-extent stencil Y))
 175
 176        )
 177
 178     (ly:stencil-add
 179      (stencil-with-color (ly:round-filled-box x-ext y-ext 0.0)
 180                          white)
 181      stencil)
 182     ))
 183
 184 (define-public (dimension-arrows destination)
 185   "Draw twosided arrow from here to @var{destination}"
 186
 187   (let*
 188       ((e_x 1+0i)
 189        (e_y 0+1i)
 190        (rotate (lambda (z ang)
 191                  (* (make-polar 1 ang)
 192                     z)))
 193        (complex-to-offset (lambda (z)
 194                             (list (real-part z) (imag-part z))))
 195
 196        (z-dest (+ (* e_x (car destination)) (* e_y (cdr destination))))
 197        (e_z (/ z-dest (magnitude z-dest)))
 198        (triangle-points '(-1+0.25i
 199                           0
 200                           -1-0.25i))
 201        (p1s (map (lambda (z)
 202                    (+ z-dest (rotate z (angle z-dest))))
 203                  triangle-points))
 204        (p2s (map (lambda (z)
 205                    (rotate z (angle (- z-dest))))
 206                    triangle-points))
 207        (null (cons 0 0))
 208        (arrow-1
 209         (ly:make-stencil
 210          `(polygon (quote ,(concatenate (map complex-to-offset p1s)))
 211                    0.0
 212                    #t) null null))
 213        (arrow-2
 214         (ly:make-stencil
 215          `(polygon (quote ,(concatenate (map complex-to-offset p2s)))
 216                    0.0
 217                    #t) null null ) )
 218        (thickness 0.1)
 219        (shorten-line 0.5)
 220        (start (complex-to-offset (/ (* e_z shorten-line) 2)))
 221        (end (complex-to-offset (- z-dest (/ (* e_z shorten-line) 2))))
 222
 223        (line (ly:make-stencil
 224               `(draw-line ,thickness
 225                           ,(car start) ,(cadr start)
 226                           ,(car end) ,(cadr end)
 227                           )
 228               (cons (min 0 (car destination))
 229                     (min 0 (cdr destination)))
 230               (cons (max 0 (car destination))
 231                     (max 0 (cdr destination)))))
 232
 233        (result (ly:stencil-add arrow-2 arrow-1 line)))
 234
 235
 236     result))
 237
 238 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 239 ;; ANNOTATIONS
 240 ;;
 241 ;; annotations are arrows indicating the numerical value of
 242 ;; spacing variables
 243 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 244
 245 (define*-public (annotate-y-interval layout name extent is-length
 246                                      #:key (color darkblue))
 247   (let ((text-props (cons '((font-size . -3)
 248                             (font-family . typewriter))
 249                           (layout-extract-page-properties layout)))
 250         (annotation #f))
 251     (define (center-stencil-on-extent stil)
 252       (ly:stencil-translate (ly:stencil-aligned-to stil Y CENTER)
 253                             (cons 0 (interval-center extent))))
 254     ;; do something sensible for 0,0 intervals.
 255     (set! extent (interval-widen extent 0.001))
 256     (if (not (interval-sane? extent))
 257         (set! annotation (interpret-markup
 258                           layout text-props
 259                           (make-simple-markup (simple-format #f "~a: NaN/inf" name))))
 260         (let ((text-stencil (interpret-markup
 261                              layout text-props
 262                              (markup #:whiteout #:simple name)))
 263               (dim-stencil (interpret-markup
 264                             layout text-props
 265                             (markup #:whiteout
 266                                     #:simple (cond
 267                                               ((interval-empty? extent)
 268                                                (format "empty"))
 269                                               (is-length
 270                                                (ly:format "~$" (interval-length extent)))
 271                                               (else
 272                                                (ly:format "(~$,~$)"
 273                                                        (car extent) (cdr extent)))))))
 274               (arrows (ly:stencil-translate-axis
 275                        (dimension-arrows (cons 0 (interval-length extent)))
 276                        (interval-start extent) Y)))
 277           (set! annotation
 278                 (center-stencil-on-extent text-stencil))
 279           (set! annotation
 280                 (ly:stencil-combine-at-edge arrows X RIGHT annotation 0.5))
 281           (set! annotation
 282                 (ly:stencil-combine-at-edge annotation X LEFT
 283                                             (center-stencil-on-extent dim-stencil)
 284                                             0.5))
 285           (set! annotation
 286                 (ly:make-stencil (list 'color color (ly:stencil-expr annotation))
 287                                  (ly:stencil-extent annotation X)
 288                                  (cons 10000 -10000)))))
 289     annotation))
 290
 291
 292 (define-public (eps-file->stencil axis size file-name)
 293   (let*
 294       ((contents (ly:gulp-file file-name))
 295        (bbox (get-postscript-bbox (car (string-split contents #\nul))))
 296        (bbox-size (if (= axis X)
 297                       (- (list-ref bbox 2) (list-ref bbox 0))
 298                       (- (list-ref bbox 3) (list-ref bbox 1))
 299                       ))
 300        (factor (if (< 0 bbox-size)
 301                    (exact->inexact (/ size bbox-size))
 302                    0))
 303        (scaled-bbox
 304         (map (lambda (x) (* factor x)) bbox))
 305        (clip-rect-string (ly:format
 306                           "~a ~a ~a ~a rectclip"
 307                           (list-ref bbox 0)
 308                           (list-ref bbox 1)
 309                           (- (list-ref bbox 2) (list-ref bbox 0))
 310                           (- (list-ref bbox 3) (list-ref bbox 1)))))
 311
 312
 313     (if bbox
 314         (ly:make-stencil
 315          (list
 316           'embedded-ps
 317           (string-append
 318            (ly:format
 319            "
 320 gsave
 321 currentpoint translate
 322 BeginEPSF
 323 ~a dup scale
 324 ~a
 325 %%BeginDocument: ~a
 326 "          factor clip-rect-string
 327
 328            file-name
 329            )
 330            contents
 331            "%%EndDocument
 332 EndEPSF
 333 grestore
 334 "))
 335
 336          (cons (list-ref scaled-bbox 0) (list-ref scaled-bbox 2))
 337          (cons (list-ref scaled-bbox 1) (list-ref scaled-bbox 3)))
 338
 339         (ly:make-stencil "" '(0 . 0) '(0 . 0)))
 340     ))
 341
 342 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 343 ;; output signatures.
 344
 345 (define-public (write-system-signatures basename paper-systems count)
 346   (if (pair? paper-systems)
 347       (begin
 348         (let*
 349             ((outname (simple-format #f "~a-~a.signature" basename count)) )
 350
 351           (ly:message "Writing ~a" outname)
 352           (write-system-signature outname (car paper-systems))
 353           (write-system-signatures basename (cdr paper-systems) (1+ count))))))
 354
 355 (use-modules (scm paper-system))
 356 (define-public (write-system-signature filename paper-system)
 357   (define (float? x)
 358     (and (number? x) (inexact? x)))
 359
 360   (define system-grob
 361     (paper-system-system-grob paper-system))
 362
 363   (define output (open-output-file filename))
 364
 365   ;; todo: optionally use a command line flag? Or just junk this?
 366   (define compare-expressions #f)
 367   (define (strip-floats expr)
 368     "Replace floats by #f"
 369     (cond
 370      ((float? expr) #f)
 371      ((ly:font-metric? expr) (ly:font-name expr))
 372      ((pair? expr) (cons (strip-floats (car expr))
 373                          (strip-floats (cdr expr))))
 374      (else expr)))
 375
 376   (define (fold-false-pairs expr)
 377     "Try to remove lists of #f as much as possible."
 378     (if (pair? expr)
 379         (let*
 380             ((first (car expr))
 381              (rest (fold-false-pairs (cdr expr))))
 382
 383           (if first
 384               (cons (fold-false-pairs first) rest)
 385               rest))
 386         expr))
 387
 388   (define (raw-string expr)
 389     "escape quotes and slashes for python consumption"
 390     (regexp-substitute/global #f "[@\n]" (simple-format #f "~a" expr) 'pre " " 'post))
 391
 392   (define (raw-pair expr)
 393     (simple-format #f "~a ~a"
 394             (car expr) (cdr expr)))
 395
 396   (define (found-grob expr)
 397     (let*
 398         ((grob (car expr))
 399          (rest (cdr expr))
 400          (collected '())
 401          (cause (event-cause grob))
 402          (input (if (ly:stream-event? cause) (ly:event-property cause 'origin) #f))
 403          (location (if (ly:input-location? input) (ly:input-file-line-char-column input) '()))
 404
 405          ;; todo: use stencil extent if available.
 406          (x-ext (ly:grob-extent grob system-grob X))
 407          (y-ext (ly:grob-extent grob system-grob Y))
 408          (expression-skeleton
 409           (if compare-expressions
 410               (interpret-for-signature
 411                #f (lambda (e)
 412                     (set! collected (cons e collected)))
 413                rest)
 414              "")))
 415
 416       (simple-format output
 417               "~a@~a@~a@~a@~a\n"
 418               (cdr (assq 'name (ly:grob-property grob 'meta) ))
 419               (raw-string location)
 420               (raw-pair (if (interval-empty? x-ext) '(1 . -1) x-ext))
 421               (raw-pair (if (interval-empty? y-ext) '(1 . -1) y-ext))
 422               (raw-string collected))
 423       ))
 424
 425   (define (interpret-for-signature escape collect expr)
 426     (define (interpret expr)
 427       (let*
 428           ((head (if (pair? expr)
 429                      (car expr)
 430                      #f)))
 431
 432         (cond
 433          ((eq? head 'grob-cause) (escape (cdr expr)))
 434          ((eq? head 'color) (interpret (caddr expr)))
 435          ((eq? head 'rotate-stencil) (interpret (caddr expr)))
 436          ((eq? head 'translate-stencil) (interpret (caddr expr)))
 437          ((eq? head 'combine-stencil)
 438           (for-each (lambda (e) (interpret e))  (cdr expr)))
 439          (else
 440           (collect (fold-false-pairs (strip-floats expr))))
 441
 442          )))
 443
 444     (interpret expr))
 445
 446   (if (ly:grob? system-grob)
 447       (begin
 448         (display (simple-format #f "# Output signature\n# Generated by LilyPond ~a\n" (lilypond-version))
 449                  output)
 450         (interpret-for-signature found-grob (lambda (x) #f)
 451                                  (ly:stencil-expr
 452                                   (paper-system-stencil paper-system)))))
 453
 454   ;; should be superfluous, but leaking "too many open files"?
 455   (close-port output))
 456