]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/output-ps.scm
Run `make grand-replace'.
[lilypond.git] / scm / output-ps.scm
index 9db2c4fc7a496348f56b9eccae16f45705a8a8dd..3766fa6a4ea5f2b1790fff9b5b784894b7bc1332 100644 (file)
-;;;; ps.scm -- implement Scheme output routines for PostScript
+;;;; output-ps.scm -- implement Scheme output interface for PostScript
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
-;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 1998--2008 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;                 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-
-(debug-enable 'backtrace)
-
-
-(define-module (scm output-ps))
-(define this-module (current-module))
-
-(use-modules
- (guile)
- (ice-9 regex)
- (lily))
-
-
-
-;;; Lily output interface --- cleanup and docme
-
-;; TODO: fucks up if outputting strings with parentheses.
-
-;; Module entry
-(define-public (ps-output-expression expr port)
-  (display (eval expr this-module) port))
-
-
-;; Global vars
-
-;; alist containing fontname -> fontcommand assoc (both strings)
-(define font-name-alist '())
-
-
-;; Interface functions
-(define (beam width slope thick blot)
-  (string-append
-   (numbers->string (list slope width thick blot)) " draw_beam" ))
+;;;; Note: currently misused as testbed for titles with markup, see
+;;;;       input/test/title-markup.ly
+;;;; 
+;;;; TODO:
+;;;;   * %% Papersize in (header ...)
+;;;;   * text setting, kerning.
+;;;;   * document output-interface
+
+(define-module (scm output-ps)
+  #:re-export (quote)
+
+  ;; JUNK this -- see lily.scm: ly:all-output-backend-commands
+  #:export (unknown
+           bezier-sandwich
+           char
+           circle
+           comment
+           dashed-line
+           dashed-slur
+           dot
+           draw-line
+            ellipse
+           embedded-ps
+           named-glyph
+           no-origin
+            oval
+           placebox
+           polygon
+           repeat-slash
+           resetcolor
+           resetrotation
+           round-filled-box
+           setcolor
+           setrotation
+           text
+           ))
+
+
+(use-modules (guile)
+            (ice-9 regex)
+            (srfi srfi-1)
+            (srfi srfi-13)
+            (scm framework-ps)
+            (lily))
+
+;;; helper functions, not part of output interface
+;;;
+
+
+;; ice-9 format uses a lot of memory
+;; using simple-format almost halves lilypond cell usage
+
+(define (str4 num)
+  (if (or (nan? num) (inf? num))
+      (begin
+       (ly:warning (_ "Found infinity or nan in output. Substituting 0.0"))
+       (if (ly:get-option 'strict-infinity-checking)
+           (exit 1))
+       "0.0")
+      (ly:number->string num)))
+
+(define (number-pair->string4 numpair)
+  (ly:format "~4l" numpair)) 
+
+;;;
+;;; Lily output interface, PostScript implementation --- cleanup and docme
+;;;
 
 ;; two beziers
-(define (bezier-sandwich l thick)
-  (string-append 
-   (apply string-append (map number-pair->string l))
-   (ly:number->string thick)
-   " draw_bezier_sandwich "))
-
-(define (bracket arch_angle arch_width arch_height  height arch_thick thick)
-  (string-append
-   (numbers->string
-    (list arch_angle arch_width arch_height height arch_thick thick))
-   " draw_bracket"))
-
-(define (symmetric-x-triangle thick w h)
-  (string-append
-   (numbers->string (list h w thick))
-   " draw_symmetric_x_triangle"))
-
-
-(define (char i)
-  (string-append 
-   "(\\" (inexact->string i 8) ") show " ))
-
-
-(define (comment s)
-  (string-append "% " s "\n"))
-
-
-(define (dashed-line thick on off dx dy)
-  (string-append 
-   (ly:number->string dx)
-   " "
-   (ly:number->string dy)
-   " "
-   (ly:number->string thick)
-   " [ "
-   (ly:number->string on)
-   " "
-   (ly:number->string off)
-   " ] 0 draw_dashed_line"))
+(define (bezier-sandwich lst thick)
+  (ly:format "~l ~4f draw_bezier_sandwich" 
+            (map number-pair->string4 lst)
+         thick))
+
+(define (char font i)
+  (ly:format "~a (\\~a) show"
+   (ps-font-command font)
+   (ly:inexact->string i 8)))
+
+(define (circle radius thick fill)
+  (ly:format
+   "~a ~4f ~4f draw_circle"
+   (if fill
+     "true"
+     "false")
+   radius thick))
+
+(define (dashed-line thick on off dx dy phase)
+  (ly:format "~4f ~4f ~4f [ ~4f ~4f ] ~4f draw_dashed_line"
+   dx
+   dy
+   thick
+   on
+   off
+   phase))
 
 ;; what the heck is this interface ?
-(define (dashed-slur thick dash l)
-  (string-append 
-   (apply string-append (map number-pair->string l)) 
-   (ly:number->string thick) 
-   " [ "
-   (ly:number->string dash)
-   " "
-   ;;UGH.  10 ?
-   (ly:number->string (* 10 thick))
-   " ] 0 draw_dashed_slur"))
-
-(define lily-traced-cm-fonts
-  (map symbol->string
-       '(cmbx14
-        cmbx17
-        cmbxti12
-        cmbxti14
-        cmbxti7
-        cmbxti8
-        cmcsc12
-        cmcsc7
-        cmtt17)))
-  
-(define (define-fonts internal-external-name-mag-pairs)
-  
-  (define (font-load-command name-mag command)
-
-    ;; frobnicate NAME to jibe with external definitions.
-    (define (possibly-capitalize-font-name name)
-      (cond
-       ((and (equal? (substring name 0 2) "cm")
-            (not (member name lily-traced-cm-fonts)))
-       (string-upcase name))
-       ((equal? (substring name 0 4) "feta")
-       (regexp-substitute/global #f "feta([a-z-]*)([0-9]+)" name 'pre "GNU-LilyPond-feta" 1 "-" 2 'post))
-       (else name)))
-    
-    (string-append
-     "/" command
-     " { /"
-     ;; Ugh, the Bluesky type1 fonts for computer modern use capitalized 
-     ;; postscript font names.
-     (possibly-capitalize-font-name (car name-mag))
-     " findfont "
-     "20 " (ly:number->string (cdr name-mag)) " mul "
-     "output-scale div scalefont setfont } bind def "
-     "\n"))
-
-  (define (ps-encoded-fontswitch name-mag-pair)
-    (let* ((key (car name-mag-pair))
-          (value (cdr name-mag-pair)))
-      (cons key
-           (cons value
-                 (string-append "lilyfont"
-                                (car value)
-                                "-"
-                                (number->string (cdr value)))))))
-      
-  (set! font-name-alist (map ps-encoded-fontswitch
-                            internal-external-name-mag-pairs))
-
-  (apply string-append
-        (map (lambda (x) (font-load-command (car x) (cdr x)))
-             (map cdr font-name-alist))))
-
-(define (define-origin file line col) "")
+(define (dashed-slur thick on off l)
+  (ly:format "~l ~4f [ ~4f ~4f ] 0 draw_dashed_slur"
+         (let ((control-points (append (cddr l) (list (car l) (cadr l)))))
+           (map number-pair->string4 control-points))
+         thick
+         on
+         off))
 
 (define (dot x y radius)
-  (string-append
-   " "
-   (numbers->string
-    (list x y radius)) " draw_dot"))
-
-(define (zigzag-line centre? zzw zzh thick dx dy)
-  (string-append
-    (if centre? "true" "false")
-    " "
-    (ly:number->string zzw)
-    " "
-    (ly:number->string zzh)
-    " "
-    (ly:number->string thick)
-    " 0 0 "
-    (ly:number->string dx)
-    " "
-    (ly:number->string dy)
-    " draw_zigzag_line "))
+  (ly:format " ~4l draw_dot" (list radius x y)))
 
 (define (draw-line thick x1 y1 x2 y2)
-  (string-append 
-  "    1 setlinecap
-       1 setlinejoin "
-  (ly:number->string thick)
-       " setlinewidth "
-   (ly:number->string x1)
-   " "
-   (ly:number->string y1)
-   " moveto "
-   (ly:number->string x2)
-   " "
-   (ly:number->string y2)
-   " lineto stroke"))
-
-(define (polygon points blotdiameter)
-  (string-append
-   " "
-   (numbers->string points)
-   (ly:number->string (/ (length points) 2))
-   (ly:number->string blotdiameter)
-   " draw_polygon"))
-
-(define (end-output)
-  "\nend-lilypond-output\n")
-
-(define (ez-ball ch letter-col ball-col)
-  (string-append
-   " (" ch ") "
-   (numbers->string (list letter-col ball-col))
-   " /Helvetica-Bold " ;; ugh
-   " draw_ez_ball"))
-
-(define (filledbox breapth width depth height) 
-  (string-append (numbers->string (list breapth width depth height))
-                " draw_box"))
-
-(define (horizontal-line x1 x2 th)
-  (draw-line th x1  0 x2 0))
-
-(define (fontify name-mag-pair exp)
-
-  (define (select-font name-mag-pair)
-    (let* ((c (assoc name-mag-pair font-name-alist)))
-      (if (eq? c #f)
-         (begin
-           (display "FAILED\n")
-           (display (object-type (car name-mag-pair)))
-           (display (object-type (caaar font-name-alist)))
-           (ly:warn (string-append
-                     "Programming error: No such font known "
-                     (car name-mag-pair) " "
-                     (ly:number->string (cdr name-mag-pair))))
-           
-           ;; Upon error, issue no command
-           "")
-         (string-append " " (cddr c) " "))))
-  
-  (string-append (select-font name-mag-pair) exp))
-
-(define (header creator generate) 
-  (string-append
-   "%!PS-Adobe-3.0\n"
-   "%%Creator: " creator generate "\n"))
-
-(define (header-end)
-  (string-append
-   ;; URG: now we can't use scm output without Lily
-   (ly:gulp-file "lilyponddefs.ps")
-   "{exch pop //systemdict /run get exec}\n\n"
-   (ly:gulp-file "music-drawing-routines.ps")
-   "{ exch pop //systemdict /run get exec }\n\n"
-   ;; ps-testing wreaks havoc when used with lilypond-book.
-   ;;  -- is this still true with new modules system?
-;;   (if (defined? 'ps-testing) "\n /testing true def" "")
-  ;   "\n /testing true def"
-   ))
-
-(define (lily-def key val)
-  (let ((prefix "lilypondpaper"))
-    (if (string=?
-        (substring key 0 (min (string-length prefix) (string-length key)))
-        prefix)
-       (string-append "/" key " {" val "} bind def\n")
-       (string-append "/" key " (" val ") def\n"))))
-
-(define (no-origin) "")
+  (ly:format "~4f ~4f ~4f ~4f ~4f draw_line"
+         (- x2 x1) (- y2 y1)
+         x1 y1 thick))
+
+(define (ellipse x-radius y-radius thick fill)
+  (ly:format
+   "~a ~4f ~4f ~4f draw_ellipse"
+   (if fill
+     "true"
+     "false")
+   x-radius y-radius thick))
+
+(define (embedded-ps string)
+  string)
+
+(define (glyph-string postscript-font-name
+                     size
+                     cid?
+                     w-x-y-named-glyphs)
+
+  (define (glyph-spec w x y g)
+    (let ((prefix (if (string? g) "/" "")))
+      (ly:format "~4f ~4f ~a~a"
+                (+ w x)  y
+                prefix g)))
   
-(define (placebox x y s) 
-  (string-append 
-   (ly:number->string x) " " (ly:number->string y) " {" s "} place-box\n"))
-
-(define (repeat-slash wid slope thick)
-  (string-append
-   (numbers->string (list wid slope thick))
-   " draw_repeat_slash"))
-
-(define (round-filled-box x y width height blotdiam)
-   (string-append
-    " "
-    (numbers->string
-     (list x y width height blotdiam)) " draw_round_box"))
-
-(define (start-system width height)
-  (string-append
-   "\n" (ly:number->string height)
-   " start-system\n"
-   "{\n"
-   "set-ps-scale-to-lily-scale"))
-
-(define (stem breapth width depth height) 
-  (string-append
-   (numbers->string (list breapth width depth height))
-   " draw_box" ))
-
-(define (stop-last-system)
-  (stop-system))
+  (ly:format 
+   (if cid?
+"/~a /CIDFont findresource ~a output-scale div scalefont setfont
+~a
+~a print_glyphs"
+
+"/~a ~a output-scale div selectfont
+~a
+~a print_glyphs")
+         postscript-font-name
+         size
+         (string-join (map (lambda (x) (apply glyph-spec x))
+                           (reverse w-x-y-named-glyphs)) "\n")
+         (length w-x-y-named-glyphs)))
+
+
+(define (grob-cause offset grob)
+  (if (ly:get-option 'point-and-click)
+      (let* ((cause (ly:grob-property grob 'cause))
+            (music-origin (if (ly:stream-event? cause)
+                              (ly:event-property cause 'origin))))
+       (if (ly:input-location? music-origin)
+           (let* ((location (ly:input-file-line-char-column music-origin))
+                  (raw-file (car location))
+                  (file (if (is-absolute? raw-file)
+                            raw-file
+                            (string-append (ly-getcwd) "/" raw-file)))
+                  (x-ext (ly:grob-extent grob grob X))
+                  (y-ext (ly:grob-extent grob grob Y)))
+
+             (if (and (< 0 (interval-length x-ext))
+                      (< 0 (interval-length y-ext)))
+                 (ly:format "~4f ~4f ~4f ~4f (textedit://~a:~a:~a:~a) mark_URI\n"
+                            (+ (car offset) (car x-ext))
+                            (+ (cdr offset) (car y-ext))
+                            (+ (car offset) (cdr x-ext))
+                            (+ (cdr offset) (cdr y-ext))
+
+                            ;; TODO
+                            ;;full escaping.
+
+                            ;; backslash is interpreted by GS.
+                            (ly:string-substitute "\\" "/" 
+                                                  (ly:string-substitute " " "%20" file))
+                            (cadr location)
+                            (caddr location)
+                            (cadddr location))
+                 ""))
+           ""))
+      ""))
+
+(define (named-glyph font glyph)
+  (ly:format "~a /~a glyphshow " ;;Why is there a space at the end?
+            (ps-font-command font)
+            glyph))
+
+(define (no-origin)
+  "")
+
+(define (oval x-radius y-radius thick fill)
+  (ly:format
+   "~a ~4f ~4f ~4f draw_oval"
+   (if fill
+     "true"
+     "false")
+   x-radius y-radius thick))
 
-(define (stop-system)
-  "}\nstop-system\n")
+(define (placebox x y s) 
+  (ly:format
+"~4f ~4f moveto
+~a\n" x y s))
+
+(define (polygon points blot-diameter filled?)
+  (ly:format "~a ~4l ~a ~4f draw_polygon"
+            (if filled? "true" "false")
+            points
+            (- (/ (length points) 2) 1)
+            blot-diameter))
+
+(define (repeat-slash width slope beam-thickness)
+  (define (euclidean-length x y)
+    (sqrt (+ (* x x) (* y y))))
+
+  (let ((x-width (euclidean-length beam-thickness (/ beam-thickness slope)))
+       (height (* width slope)))
+    (ly:format "~4l draw_repeat_slash"
+            (list x-width width height))))
+
+
+(define (round-filled-box left right bottom top blotdiam)
+  (let* ((halfblot (/ blotdiam 2))
+        (x (- halfblot left))
+        (width (- right (+ halfblot x)))
+        (y (- halfblot bottom))
+        (height (- top (+ halfblot y))))
+    (ly:format  "~4l draw_round_box"
+               (list width height x y blotdiam))))
+
+;; save current color on stack and set new color
+(define (setcolor r g b)
+  (ly:format "gsave ~4l setrgbcolor\n"
+             (list r g b)))
+
+;; restore color from stack
+(define (resetcolor) "grestore\n")
+
+;; rotation around given point
+(define (setrotation ang x y)
+  (ly:format "gsave ~4l translate ~a rotate ~4l translate\n"
+            (list x y)
+            ang
+            (list (* -1 x) (* -1 y))))
+
+(define (resetrotation ang x y)
+  "grestore  ")
+
+
+(define (text font s)
+  ;; (ly:warning (_ "TEXT backend-command encountered in Pango backend"))
+  ;; (ly:warning (_ "Arguments: ~a ~a"" font str))
+  
+  (let* ((space-length (cdar (ly:text-dimension font " ")))
+        (space-move (string-append (number->string space-length)
+                                   ;; how much precision do we need here?
+                                   " 0.0 rmoveto "))
+        (out-vec (decode-byte-string s)))
 
-(define (text s)
-  (string-append "(" s ") show "))
+    (string-append
+     (ps-font-command font) " "
+     (string-join
+      (vector->list
+       (vector-for-each
+       
+       (lambda (sym)
+         (if (eq? sym 'space)
+             space-move
+             (string-append "/" (symbol->string sym) " glyphshow")))
+       out-vec))))))
 
 (define (unknown) 
   "\n unknown\n")
 
-;; top-of-file, wtf?
-(define (top-of-file)
-  (header (string-append "GNU LilyPond (" (lilypond-version) "), ")
-          (strftime "%c" (localtime (current-time))))
-  ;;; ugh
-  (ps-string-def
-   "lilypond" 'tagline
-   (string-append "Engraved by LilyPond (" (lilpond-version) ")")))
-
-(define (output-paper-def pd)
-  (apply
-   string-append
-   (module-map
-    (lambda (sym var)
-      (let ((val (variable-ref var))
-           (key (symbol->string sym)))
-       
-       (cond
-        ((string? val)
-         (ps-string-def "lilypondpaper" sym val))
-        ((number? val)
-         (ps-number-def "lilypondpaper" sym
-                        (if (integer? val)
-                            (number->string val)
-                            (number->string (exact->inexact val)))))
-        (else ""))))
-      
-    (ly:output-def-scope pd))))
-
-
-(define (ps-string-def a b c)
-  (string-append "/" a (symbol->string b) " (" c ") def\n"))
-
-(define (ps-number-def a b c)
-  (string-append "/" a (symbol->string b) " " c " def\n"))
-
-(define (output-scopes scopes fields basename)
-  (define (output-scope scope)
-    (apply
-     string-append
-     (module-map
-      (lambda (sym var)
-       (let ((val (variable-ref var))
-             (tex-key (symbol->string sym)))
-        
-         (if (memq sym fields)
-             (header-to-file basename sym val))
-         
-         (cond
-          ((string? val)
-           (ps-string-def "lilypond" sym val))
-          
-          ((number? val)
-           (ps-number-def "lilypond" sym
-                          (if (integer? val)
-                              (number->string val)
-                              (number->string (exact->inexact val)))))
-          (else ""))))
-      scope)))
+(define (url-link url x y)
+  (ly:format "~a ~a currentpoint vector_add  ~a ~a currentpoint vector_add (~a) mark_URI"
+            (car x)
+            (car y)
+            (cdr x)
+            (cdr y)
+            url))
+
+(define (utf-8-string pango-font-description string)
+  (ly:warning (_ "utf-8-string encountered in PS backend")))
+
+(define (path thickness exps)
+  (define (convert-path-exps exps)
+    (if (pair? exps)
+       (let*
+           ((head (car exps))
+            (rest (cdr exps))
+            (arity 
+             (cond
+              ((memq head '(rmoveto rlineto lineto moveto)) 2)
+              ((memq head '(rcurveto curveto)) 6)
+              (else 1)))
+            (args (take rest arity))
+            )
+
+         ;; WARNING: this is a vulnerability: a user can output arbitrary PS code here.
+         (cons (ly:format
+                       "~l ~a "
+                       args 
+                       head)
+               (convert-path-exps (drop rest arity))))
+       '()))
+    
+    
+  (ly:format
+   "1 setlinecap ~a setlinewidth\n~l stroke"
+   thickness
+   (convert-path-exps exps) ))
   
-  (apply string-append
-   (map output-scope scopes)) )
-