]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/stencil.scm
Merge with master
[lilypond.git] / scm / stencil.scm
index b1aeb4f3e778f7d63bb71810df80bd9502a3caa4..463a082fd337e63e25230fc4fe89f70c3091206f 100644 (file)
@@ -1,28 +1,62 @@
-;;;; stenicil.scm -- 
+;;;; stencil.scm -- 
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  2003--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 2003--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
 (define-public (stack-stencils axis dir padding stils)
   "Stack stencils STILS in direction AXIS, DIR, using PADDING."
-  (if (null? stils)
-      '()
-      (if (pair? stils)
-         (ly:stencil-combine-at-edge
-          (car stils) axis dir (stack-stencils axis dir padding (cdr stils))
-          padding))))
+  (cond
+   ((null? stils) empty-stencil)
+   ((null? (cdr stils)) (car stils))
+   (else (ly:stencil-combine-at-edge
+         (car stils) axis dir (stack-stencils axis dir padding (cdr stils))
+         padding))))
+
+(define-public (stack-stencils-padding-list axis dir padding stils)
+  "Stack stencils STILS in direction AXIS, DIR, using a list of PADDING."
+  (cond
+   ((null? stils) empty-stencil)
+   ((null? (cdr stils)) (car stils))
+   (else (ly:stencil-combine-at-edge
+         (car stils)
+         axis dir
+         (stack-stencils-padding-list axis dir (cdr padding) (cdr stils))
+         (car padding)))))
+
+(define-public (centered-stencil stencil)
+  "Center stencil @var{stencil} in both the X and Y directions"
+  (ly:stencil-aligned-to (ly:stencil-aligned-to stencil X CENTER) Y CENTER))
 
 (define-public (stack-lines dir padding baseline stils)
   "Stack vertically with a baseline-skip."
-  (if (null? stils)
-      '()
-      (if (null? (cdr stils))
-         (car stils)
-         (ly:stencil-combine-at-edge
-          (car stils) Y dir 
-          (stack-lines dir padding baseline (cdr stils))
-          padding baseline))))
+  (define result empty-stencil)
+  (define last-y #f)
+  (do
+      ((last-stencil #f (car p))
+       (p stils (cdr p)))
+      
+      ((null? p))
+
+    (if (number? last-y)
+       (begin
+         (let* ((dy (max (+ (* dir (interval-bound (ly:stencil-extent last-stencil Y) dir))
+                            padding
+                            (* (- dir) (interval-bound (ly:stencil-extent (car p) Y) (- dir))))
+                         baseline))
+                (y (+ last-y  (* dir dy))))
+           
+                         
+           
+           (set! result
+                 (ly:stencil-add result (ly:stencil-translate-axis (car p) y Y)))
+           (set! last-y y)))
+       (begin
+         (set! last-y 0)
+         (set! result (car p)))))
+
+  result)
+    
 
 (define-public (bracketify-stencil stil axis thick protusion padding)
   "Add brackets around STIL, producing a new stencil."
   "Make a filled box."
   
   (ly:make-stencil
-      (list 'filledbox (- (car xext)) (cdr xext)
-                       (- (car yext)) (cdr yext))
+      (list 'round-filled-box (- (car xext)) (cdr xext)
+                       (- (car yext)) (cdr yext) 0.0)
       xext yext))
 
+(define-public (make-circle-stencil radius thickness fill)
+  "Make a circle of radius @var{radius} and thickness @var{thickness}"
+  (ly:make-stencil
+   (list 'circle radius thickness fill) 
+   (cons (- radius) radius)
+   (cons (- radius) radius)))
 
 (define-public (box-grob-stencil grob)
   "Make a box of exactly the extents of the grob.  The box precisely
@@ -52,37 +92,342 @@ encloses the contents.
   (let* ((xext (ly:grob-extent grob grob 0))
         (yext (ly:grob-extent grob grob 1))
         (thick 0.1))
-
+    
     (ly:stencil-add
      (make-filled-box-stencil xext (cons (- (car yext) thick) (car yext)))
-     (make-filled-box-stencil xext (cons  (cdr yext) (+ (cdr yext) thick)))
+     (make-filled-box-stencil xext (cons (cdr yext) (+ (cdr yext) thick)))
      (make-filled-box-stencil (cons (cdr xext) (+ (cdr xext) thick)) yext)
      (make-filled-box-stencil (cons (- (car xext) thick) (car xext)) yext))))
 
 ;; TODO merge this and prev function. 
-(define-public (box-stencil stil thick padding)
-  "Add a box around STIL, producing a new stencil."
-  (let* ((x-ext (interval-widen (ly:stencil-extent stil 0) padding))
-        (y-ext (interval-widen (ly:stencil-extent stil 1) padding))
-        (y-rule (make-filled-box-stencil (cons 0 thick) y-ext))
-        (x-rule (make-filled-box-stencil (interval-widen x-ext thick)
-                                          (cons 0 thick))))
-    
-    (set! stil (ly:stencil-combine-at-edge stil X 1 y-rule padding))
-    (set! stil (ly:stencil-combine-at-edge stil X -1 y-rule padding))
-    (set! stil (ly:stencil-combine-at-edge stil Y 1 x-rule 0.0))  
-    (set! stil (ly:stencil-combine-at-edge stil Y -1 x-rule 0.0))
-    
-    stil))
+(define-public (box-stencil stencil thickness padding)
+  "Add a box around STENCIL, producing a new stencil."
+  (let* ((x-ext (interval-widen (ly:stencil-extent stencil 0) padding))
+        (y-ext (interval-widen (ly:stencil-extent stencil 1) padding))
+        (y-rule (make-filled-box-stencil (cons 0 thickness) y-ext))
+        (x-rule (make-filled-box-stencil
+                 (interval-widen x-ext thickness) (cons 0 thickness))))
+    (set! stencil (ly:stencil-combine-at-edge stencil X 1 y-rule padding))
+    (set! stencil (ly:stencil-combine-at-edge stencil X -1 y-rule padding))
+    (set! stencil (ly:stencil-combine-at-edge stencil Y 1 x-rule 0.0))  
+    (set! stencil (ly:stencil-combine-at-edge stencil Y -1 x-rule 0.0))
+    stencil))
+
+(define-public (circle-stencil stencil thickness padding)
+  "Add a circle around STENCIL, producing a new stencil."
+  (let* ((x-ext (ly:stencil-extent stencil 0))
+        (y-ext (ly:stencil-extent stencil 1))
+        (diameter (max (- (cdr x-ext) (car x-ext))
+                       (- (cdr y-ext) (car y-ext))))
+        (radius (+ (/ diameter 2) padding thickness))
+        (circle (make-circle-stencil radius thickness #f)))
+
+    (ly:stencil-add
+     stencil
+     (ly:stencil-translate circle
+                          (cons
+                           (interval-center x-ext)
+                           (interval-center y-ext))))))
+
 
 (define-public (fontify-text font-metric text)
   "Set TEXT with font FONT-METRIC, returning a stencil."
-  (let* ((b  (ly:text-dimension font-metric text)))
+  (let* ((b (ly:text-dimension font-metric text)))
     (ly:make-stencil
      `(text ,font-metric ,text) (car b) (cdr b))))
      
-(define-public (fontify-text-white font-metric text)
-  "Set TEXT with font FONT-METRIC, in color white, returning a stencil."
-  (let* ((b  (ly:text-dimension font-metric text))
-         (c  `(white-text ,text)))
-    (ly:make-stencil c  (car b) (cdr b))))  ;urg -- extent is not from ps font, but we hope it's close
+(define-public (fontify-text-white scale font-metric text)
+  "Set TEXT with scale factor SCALE"
+  (let* ((b (ly:text-dimension font-metric text))
+        ;;urg -- workaround for using ps font
+         (c `(white-text ,(* 2 scale) ,text)))
+    ;;urg -- extent is not from ps font, but we hope it's close
+    (ly:make-stencil c (car b) (cdr b))))
+
+(define-public (stencil-with-color stencil color)
+  (ly:make-stencil
+   (list 'color color (ly:stencil-expr stencil))
+   (ly:stencil-extent stencil X)
+   (ly:stencil-extent stencil Y)))
+  
+(define-public (stencil-whiteout stencil)
+  (let*
+      ((x-ext (ly:stencil-extent stencil X))
+       (y-ext (ly:stencil-extent stencil Y))
+
+       )
+    
+    (ly:stencil-add
+     (stencil-with-color (ly:round-filled-box x-ext y-ext 0.0)
+                        white)
+     stencil)
+    ))
+
+(define-public (dimension-arrows destination) 
+  "Draw twosided arrow from here to @var{destination}"
+  
+  (let*
+      ((e_x 1+0i)
+       (e_y 0+1i)
+       (rotate (lambda (z ang)
+                (* (make-polar 1 ang)
+                   z)))
+       (complex-to-offset (lambda (z)
+                           (list (real-part z) (imag-part z))))
+       
+       (z-dest (+ (* e_x (car destination)) (* e_y (cdr destination))))
+       (e_z (/ z-dest (magnitude z-dest)))
+       (triangle-points '(-1+0.25i
+                         0
+                         -1-0.25i))
+       (p1s (map (lambda (z)
+                  (+ z-dest (rotate z (angle z-dest))))
+                triangle-points))
+       (p2s (map (lambda (z)
+                  (rotate z (angle (- z-dest))))
+                  triangle-points))
+       (null (cons 0 0)) 
+       (arrow-1  
+       (ly:make-stencil
+        `(polygon (quote ,(concatenate (map complex-to-offset p1s)))
+                  0.0
+                  #t) null null))
+       (arrow-2
+       (ly:make-stencil
+        `(polygon (quote ,(concatenate (map complex-to-offset p2s)))
+                  0.0
+                  #t) null null ) )
+       (thickness 0.1)
+       (shorten-line 0.5)
+       (start (complex-to-offset (/ (* e_z shorten-line) 2)))
+       (end (complex-to-offset (- z-dest (/ (* e_z shorten-line) 2))))
+       
+       (line (ly:make-stencil
+             `(draw-line ,thickness
+                         ,(car start) ,(cadr start)
+                         ,(car end) ,(cadr end)
+                         )
+             (cons (min 0 (car destination))
+                   (min 0 (cdr destination)))
+             (cons (max 0 (car destination))
+                   (max 0 (cdr destination)))))
+                   
+       (result (ly:stencil-add arrow-2 arrow-1 line)))
+
+
+    result))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; ANNOTATIONS
+;;
+;; annotations are arrows indicating the numerical value of
+;; spacing variables 
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(define*-public (annotate-y-interval layout name extent is-length
+                                     #:key (color darkblue))
+  (let ((text-props (cons '((font-size . -3)
+                           (font-family . typewriter))
+                         (layout-extract-page-properties layout)))
+       (annotation #f))
+    (define (center-stencil-on-extent stil)
+      (ly:stencil-translate (ly:stencil-aligned-to stil Y CENTER)
+                            (cons 0 (interval-center extent))))
+    ;; do something sensible for 0,0 intervals. 
+    (set! extent (interval-widen extent 0.001))
+    (if (not (interval-sane? extent))
+       (set! annotation (interpret-markup
+                         layout text-props
+                         (make-simple-markup (format "~a: NaN/inf" name))))
+       (let ((text-stencil (interpret-markup
+                            layout text-props
+                             (markup #:whiteout #:simple name)))
+              (dim-stencil (interpret-markup
+                            layout text-props
+                            (markup #:whiteout
+                                    #:simple (cond
+                                              ((interval-empty? extent)
+                                               (format "empty"))
+                                              (is-length
+                                               (format "~$" (interval-length extent)))
+                                              (else
+                                               (format "(~$,~$)"
+                                                       (car extent) (cdr extent)))))))
+             (arrows (ly:stencil-translate-axis 
+                      (dimension-arrows (cons 0 (interval-length extent)))
+                      (interval-start extent) Y)))
+         (set! annotation
+                (center-stencil-on-extent text-stencil))
+         (set! annotation
+               (ly:stencil-combine-at-edge arrows X RIGHT annotation 0.5))
+         (set! annotation
+               (ly:stencil-combine-at-edge annotation X LEFT
+                                            (center-stencil-on-extent dim-stencil)
+                                            0.5))
+         (set! annotation
+               (ly:make-stencil (list 'color color (ly:stencil-expr annotation))
+                                (ly:stencil-extent annotation X)
+                                (cons 10000 -10000)))))
+    annotation))
+
+
+(define-public (eps-file->stencil axis size file-name)
+  (let*
+      ((contents (ly:gulp-file file-name))
+       (bbox (get-postscript-bbox contents))
+       (bbox-size (if (= axis X)
+                     (- (list-ref bbox 2) (list-ref bbox 0))
+                     (- (list-ref bbox 3) (list-ref bbox 1))
+                     ))
+       (factor (exact->inexact (/ size bbox-size)))
+       (scaled-bbox
+       (map (lambda (x) (* factor x)) bbox)))
+
+    (if bbox
+       (ly:make-stencil
+        (list
+         'embedded-ps
+         (string-append
+          (format
+          "
+gsave
+currentpoint translate
+BeginEPSF
+~a ~a scale
+%%BeginDocument: ~a
+"         factor factor
+          file-name
+          )
+          contents
+          "%%EndDocument
+EndEPSF
+grestore
+"))
+       
+        (cons (list-ref scaled-bbox 0) (list-ref scaled-bbox 2))
+        (cons (list-ref scaled-bbox 1) (list-ref scaled-bbox 3)))
+       
+       (ly:make-stencil "" '(0 . 0) '(0 . 0)))
+    ))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; output signatures.
+
+(define-public (write-system-signatures basename paper-systems count)
+  (if (pair? paper-systems)
+      (begin
+       (let*
+           ((outname (format "~a-~a.signature" basename count)) )
+            
+         (ly:message "Writing ~a" outname)
+         (write-system-signature outname (car paper-systems))
+         (write-system-signatures basename (cdr paper-systems) (1+ count))))))
+
+
+(use-modules (scm paper-system))
+(define-public (write-system-signature filename paper-system)
+  (define (float? x)
+    (and (number? x) (inexact? x)))
+
+  (define system-grob
+    (paper-system-system-grob paper-system))
+  
+  (define output (open-output-file filename))
+  
+  (define (strip-floats expr)
+    "Replace floats by #f"
+    (cond
+     ((float? expr) #f)
+     ((ly:font-metric? expr) (ly:font-name expr))
+     ((pair? expr) (cons (strip-floats (car expr))
+                        (strip-floats (cdr expr))))
+     (else expr)))
+
+  (define (fold-false-pairs expr)
+    "Try to remove lists of #f as much as possible."
+    (if (pair? expr)
+       (let*
+           ((first (car expr))
+            (rest (fold-false-pairs (cdr expr))))
+
+         (if first
+             (cons (fold-false-pairs first) rest)
+             rest))
+       expr))
+  
+
+  (define (pythonic-string expr)
+    "escape quotes and slashes for python consumption"
+    (regexp-substitute/global #f "([\n\\\\'\"])" (format "~a" expr) 'pre "\\" 1 'post))
+
+  (define (pythonic-pair expr)
+    (format "(~a,~a)"
+           (car expr) (cdr expr)))
+
+
+  (define (raw-string expr)
+    "escape quotes and slashes for python consumption"
+    (regexp-substitute/global #f "[@\n]" (format "~a" expr) 'pre " " 'post))
+
+  (define (raw-pair expr)
+    (format "~a ~a"
+           (car expr) (cdr expr)))
+  
+  (define (found-grob expr)
+    (let*
+       ((grob (car expr))
+        (rest (cdr expr))
+        (collected '())
+        (cause (event-cause grob))
+        (input (if (ly:stream-event? cause) (ly:event-property cause 'origin) #f))
+        (location (if (ly:input-location? input) (ly:input-file-line-char-column input) '()))
+
+        (x-ext (ly:grob-extent grob system-grob X))
+        (y-ext (ly:grob-extent grob system-grob Y))
+        )
+
+      (interpret-for-signature #f (lambda (e)
+                                   (set! collected (cons e collected)))
+                              rest)
+
+      (format output
+             "~a@~a@~a@~a@~a\n"
+             (cdr (assq 'name (ly:grob-property grob 'meta) ))
+             (raw-string location)
+             (raw-pair (if (interval-empty? x-ext) '(1 . -1) x-ext))
+             (raw-pair (if (interval-empty? y-ext) '(1 . -1) y-ext))
+             (raw-string collected))
+      ))
+
+  (define (interpret-for-signature escape collect expr)
+    (define (interpret expr)
+      (let*
+         ((head (if (pair? expr)
+                    (car expr)
+                    #f)))
+
+       (cond
+        ((eq? head 'grob-cause) (escape (cdr expr)))
+        ((eq? head 'color) (interpret (caddr expr)))
+        ((eq? head 'rotate-stencil) (interpret (caddr expr)))
+        ((eq? head 'translate-stencil) (interpret (caddr expr)))
+        ((eq? head 'combine-stencil)
+         (for-each (lambda (e) (interpret e))  (cdr expr)))
+        (else
+         (collect (fold-false-pairs (strip-floats expr))))
+        
+        )))
+
+    (interpret expr))
+
+  (if (ly:grob? system-grob)
+      (begin
+       (display (format "# Output signature\n# Generated by LilyPond ~a\n" (lilypond-version))
+                output)
+       (interpret-for-signature found-grob (lambda (x) #f)
+                                (ly:stencil-expr
+                                 (paper-system-stencil paper-system)))))
+
+  ;; should be superfluous, but leaking "too many open files"?
+  (close-port output))
+