-;;;; output-ps.scm -- implement Scheme output interface for PostScript
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
-;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
;;;; 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
- embedded-ps
- named-glyph
- no-origin
- placebox
- polygon
- repeat-slash
- resetcolor
- resetrotatino
- round-filled-box
- setcolor
- setrotation
- text
- zigzag-line))
-
+ #:re-export (quote))
(use-modules (guile)
- (ice-9 regex)
- (srfi srfi-1)
- (srfi srfi-13)
- (scm framework-ps)
- (lily))
+ (ice-9 regex)
+ (ice-9 optargs)
+ (srfi srfi-1)
+ (srfi srfi-13)
+ (scm framework-ps)
+ (lily))
;;; helper functions, not part of output interface
;;;
-(define (escape-parentheses s)
- (regexp-substitute/global #f "(^|[^\\])([\\(\\)])" s 'pre 1 "\\" 2 'post))
-
-(define (ps-encoding text)
- (escape-parentheses text))
-
-(define (round2 num)
- (/ (round (* 100 num)) 100))
-
-(define (round4 num)
- (/ (round (* 10000 num)) 10000))
+;; ice-9 format uses a lot of memory
+;; using simple-format almost halves lilypond cell usage
(define (str4 num)
- (format #f "~f" (round4 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)
- (format #f "~f ~f" (round4 (car numpair)) (round4 (cdr numpair))))
-
-(define (numbers->string4 numlist)
- (string-join (map str4 numlist) " "))
-
-;; FIXME: lily-def
-(define-public (ps-string-def prefix key val)
- (format #f "/ ~a~a (~a) def\n"
- prefix
- (symbol->string key)
- (escape-parentheses val)))
-
-(define (ps-number-def prefix key val)
- (let ((s (if (integer? val)
- (ly:number->string val)
- (ly:number->string (exact->inexact val)))))
- (format #f "/~a~a ~a def\n"
- prefix
- (symbol->string key) s)))
-
+ (ly:format "~4l" numpair))
;;;
;;; Lily output interface, PostScript implementation --- cleanup and docme
;;;
-;; two beziers
-(define (bezier-sandwich lst thick)
- (format #f "~a ~a draw_bezier_sandwich"
- (string-join (map number-pair->string4 lst) " ")
- (str4 thick)))
-
(define (char font i)
- (format #f "~a (\\~a) show"
- (ps-font-command font)
- (ly:inexact->string i 8)))
+ (ly:format "~a (\\~a) show"
+ (ps-font-command font)
+ (ly:inexact->string i 8)))
(define (circle radius thick fill)
- (format #f
- "~a ~f ~f draw_circle"
+ (ly:format
+ "~a ~4f ~4f draw_circle"
(if fill
- "true"
- "false")
- (round4 radius) (round4 thick)))
-
-(define (dashed-line thick on off dx dy)
- (format #f "~a ~a ~a [ ~a ~a ] 0 draw_dashed_line"
- (str4 dx)
- (str4 dy)
- (str4 thick)
- (str4 on)
- (str4 off)))
-
-;; what the heck is this interface ?
-(define (dashed-slur thick on off l)
- (format #f "~a ~a [ ~a ~a ] 0 draw_dashed_slur"
- (let ((control-points (append (cddr l) (list (car l) (cadr l)))))
- (string-join (map number-pair->string4 control-points) " "))
- (str4 thick)
- (str4 on)
- (str4 off)))
-
-(define (dot x y radius)
- (format #f " ~a draw_dot"
- (numbers->string4 (list radius x y))))
+ "true"
+ "false")
+ radius thick))
+
+(define (start-enclosing-id-node s)
+ "")
+
+(define (end-enclosing-id-node)
+ "")
+
+(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))
(define (draw-line thick x1 y1 x2 y2)
- (format #f "~a ~a ~a ~a ~a draw_line"
- (str4 (- x2 x1))
- (str4 (- y2 y1))
- (str4 x1)
- (str4 y1)
- (str4 thick)))
+ (ly:format "~4f ~4f ~4f ~4f ~4f draw_line"
+ (- x2 x1) (- y2 y1)
+ x1 y1 thick))
+
+(define (partial-ellipse x-radius y-radius start-angle end-angle thick connect fill)
+ (ly:format "~a ~a ~4f ~4f ~4f ~4f ~4f draw_partial_ellipse"
+ (if fill "true" "false")
+ (if connect "true" "false")
+ x-radius
+ y-radius
+ start-angle
+ end-angle
+ 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-string pango-font
+ postscript-font-name
+ size
+ cid?
+ w-x-y-named-glyphs)
- (define (glyph-spec w x y g)
+ (define (glyph-spec w h x y g) ; h not used
(let ((prefix (if (string? g) "/" "")))
- (format #f "~f ~f ~a~a"
- (round2 (+ w x))
- (round2 y)
- prefix g)))
-
- (format #f
- (if cid?
-"/~a /CIDFont findresource ~a output-scale div scalefont setfont
+ (ly:format "~4f ~4f ~4f ~a~a"
+ w x y
+ prefix g)))
+
+ (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 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)))
+ 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)
- (let* ((cause (ly:grob-property grob 'cause))
- (music-origin (if (ly:music? cause)
- (ly:music-property cause 'origin))))
- (if (not (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)))
- (format #f "~$ ~$ ~$ ~$ (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.
- (string-regexp-substitute "\\\\" "/"
- (string-regexp-substitute " " "%20" file))
- (cadr location)
- (caddr location)
- (cadddr location))
- "")))))
-
-(define (lily-def key val)
- (let ((prefix "lilypondlayout"))
- (if (string=?
- (substring key 0 (min (string-length prefix) (string-length key)))
- prefix)
- (format "/~a { ~a } bind def\n" key val)
- (format "/~a (~a) def\n" key val))))
+ (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)))
+ (point-and-click (ly:get-option 'point-and-click)))
+ (if (and
+ (ly:input-location? music-origin)
+ (cond ((boolean? point-and-click) point-and-click)
+ ((symbol? point-and-click)
+ (ly:in-event-class? cause point-and-click))
+ (else (any (lambda (t)
+ (ly:in-event-class? cause t))
+ point-and-click))))
+ (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))
+
+ ;; Backslashes are not valid
+ ;; file URI path separators.
+ (ly:string-percent-encode
+ (ly:string-substitute "\\" "/" file))
+
+ (cadr location)
+ (caddr location)
+ (1+ (cadddr location)))
+ ""))
+ ""))
+ ""))
(define (named-glyph font glyph)
- (format #f "~a /~a glyphshow " ;;Why is there a space at the end?
- (ps-font-command font)
- glyph))
+ (ly:format "~a /~a glyphshow " ;;Why is there a space at the end?
+ (ps-font-command font)
+ glyph))
(define (no-origin)
"")
-(define (placebox x y s)
- (format #f
-"~a ~a moveto
-~a\n"
- (str4 x)
- (str4 y)
- s))
+(define (placebox x y s)
+ (if (not (string-null? s))
+ (ly:format "~4f ~4f moveto ~a\n" x y s)
+ ""))
(define (polygon points blot-diameter filled?)
- (format #f "~a ~a ~a ~a draw_polygon"
- (if filled? "true" "false")
- (numbers->string4 points)
- (number->string (- (/ (length points) 2) 1))
- (str4 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)))
- (format #f "~a draw_repeat_slash"
- (numbers->string4 (list x-width width height)))))
-
-;; restore color from stack
-(define (resetcolor) "setrgbcolor\n")
-
+ (ly:format "~a ~4l ~a ~4f draw_polygon"
+ (if filled? "true" "false")
+ points
+ (- (/ (length points) 2) 1)
+ blot-diameter))
(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))))
- (format #f "~a draw_round_box"
- (numbers->string4
- (list width height x y blotdiam)))))
+ (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)
- (format #f "currentrgbcolor ~a setrgbcolor\n"
- (numbers->string4 (list 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)
- (format "gsave ~a translate ~a rotate ~a translate\n"
- (numbers->string4 (list x y))
- (number->string ang)
- (numbers->string4 (list (* -1 x) (* -1 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)))
-
- (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)
+(define (unknown)
"\n unknown\n")
(define (url-link url x y)
- (format #f "~$ ~$ ~$ ~$ (~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 (zigzag-line centre? zzw zzh thick dx dy)
- (format #f "~a ~a ~a ~a 0 0 ~a ~a draw_zigzag_line"
- (if centre? "true" "false")
- (str4 zzw)
- (str4 zzh)
- (str4 thick)
- (str4 dx)
- (str4 dy)))
+ (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 (page-link page-no x y)
+ (if (number? page-no)
+ (ly:format "~a ~a currentpoint vector_add ~a ~a currentpoint vector_add ~a mark_page_link"
+ (car x)
+ (car y)
+ (cdr x)
+ (cdr y)
+ page-no)
+ ""))
+
+(define* (path thickness exps #:optional (cap 'round) (join 'round) (fill? #f))
+ (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)
+ ((eq? head 'closepath) 0)
+ (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))))
+ '()))
+
+ (let ((cap-numeric (case cap ((butt) 0) ((round) 1) ((square) 2)
+ (else (begin
+ (ly:warning (_ "unknown line-cap-style: ~S")
+ (symbol->string cap))
+ 1))))
+ (join-numeric (case join ((miter) 0) ((round) 1) ((bevel) 2)
+ (else (begin
+ (ly:warning (_ "unknown line-join-style: ~S")
+ (symbol->string join))
+ 1)))))
+ (ly:format
+ "gsave currentpoint translate
+~a setlinecap ~a setlinejoin ~a setlinewidth
+~l gsave stroke grestore ~a grestore"
+ cap-numeric
+ join-numeric
+ thickness
+ (convert-path-exps exps)
+ (if fill? "fill" ""))))
+
+(define (setscale x y)
+ (ly:format "gsave ~4l scale\n"
+ (list x y)))
+
+(define (resetscale)
+ "grestore\n")