scm/output-ps.scm

   1 ;;;; output-ps.scm -- implement Scheme output interface for PostScript
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;;                 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8 ;;;; Note: currently misused as testbed for titles with markup, see
   9 ;;;;       input/test/title-markup.ly
  10 ;;;;
  11 ;;;; TODO:
  12 ;;;;   * %% Papersize in (header ...)
  13 ;;;;   * text setting, kerning.
  14 ;;;;   * document output-interface
  15
  16 (debug-enable 'backtrace)
  17
  18 (define-module (scm output-ps)
  19   #:re-export (quote)
  20   #:export (define-fonts
  21              unknown
  22              output-paper-def
  23              output-scopes
  24              select-font
  25              blank
  26              dot
  27              beam
  28              bracket
  29              dashed-slur
  30              char
  31              dashed-line
  32              zigzag-line
  33              symmetric-x-triangle
  34              ez-ball
  35              comment
  36              end-output
  37              experimental-on
  38              repeat-slash
  39              header-end
  40              header
  41              placebox
  42              bezier-sandwich
  43              start-system
  44              stop-system
  45              stop-last-system
  46              horizontal-line
  47              filledbox
  48              round-filled-box
  49              text
  50              tuplet
  51              polygon
  52              draw-line
  53              between-system-string
  54              define-origin
  55              no-origin
  56              start-page
  57              stop-page
  58              ))
  59
  60 (use-modules (guile)
  61              (ice-9 regex)
  62              (srfi srfi-1)
  63              (srfi srfi-13)
  64              (lily))
  65
  66 ;;; Global vars
  67 (define page-count 0)
  68 (define page-number 0)
  69
  70 ;;; helper functions, not part of output interface
  71 (define (escape-parentheses s)
  72   (regexp-substitute/global #f "(^|[^\\])([\\(\\)])" s 'pre 1 "\\" 2 'post))
  73
  74 (define (offset-add a b)
  75   (cons (+ (car a) (car b))
  76         (+ (cdr a) (cdr b))))
  77
  78 (define (ps-encoding text)
  79   (escape-parentheses text))
  80
  81 ;; FIXME: lily-def
  82 (define (ps-string-def prefix key val)
  83   (string-append "/" prefix (symbol->string key) " ("
  84                  (escape-parentheses val)
  85                  ") def\n"))
  86
  87 (define (ps-number-def prefix key val)
  88   (let ((s (if (integer? val)
  89                (ly:number->string val)
  90                (ly:number->string (exact->inexact val)))))
  91     (string-append "/" prefix (symbol->string key) " " s " def\n")))
  92
  93 (define (tex-font? fontname)
  94   (equal? (substring fontname 0 2) "cm"))
  95
  96
  97 ;;;
  98 ;;; Lily output interface, PostScript implementation --- cleanup and docme
  99 ;;;
 100
 101 ;;; Output-interface functions
 102 (define (beam width slope thick blot)
 103   (string-append
 104    (ly:numbers->string (list slope width thick blot)) " draw_beam" ))
 105
 106 ;; two beziers
 107 (define (bezier-sandwich l thick)
 108   (string-append
 109    (string-join (map ly:number-pair->string l) " ")
 110    " "
 111    (ly:number->string thick)
 112    " draw_bezier_sandwich"))
 113
 114 (define (bracket arch_angle arch_width arch_height  height arch_thick thick)
 115   (string-append
 116    (ly:numbers->string
 117     (list arch_angle arch_width arch_height height arch_thick thick))
 118    " draw_bracket"))
 119
 120 (define (char font i)
 121   (string-append
 122     (font-command font) " setfont "
 123    "(\\" (ly:inexact->string i 8) ") show" ))
 124
 125 (define (comment s)
 126   (string-append "% " s "\n"))
 127
 128 (define (dashed-line thick on off dx dy)
 129   (string-append
 130    (ly:number->string dx) " "
 131    (ly:number->string dy) " "
 132    (ly:number->string thick)
 133    " [ "
 134    (ly:number->string on) " "
 135    (ly:number->string off)
 136    " ] 0 draw_dashed_line"))
 137
 138 ;; what the heck is this interface ?
 139 (define (dashed-slur thick dash l)
 140   (string-append
 141    (string-join (map ly:number-pair->string l) " ")
 142    " "
 143    (ly:number->string thick)
 144    " [ "
 145    (ly:number->string dash)
 146    " "
 147    ;;UGH.  10 ?
 148    (ly:number->string (* 10 thick))
 149    " ] 0 draw_dashed_slur"))
 150
 151 ;; FIXME -- now that we can have ENCODING == #f, this can be
 152 ;; simplified, esp OVERRIDE-CODING-COMMAND
 153 (define (font-command font . override-coding-command)
 154   (let* ((name (ly:font-filename font))
 155          (magnify (ly:font-magnification font))
 156          (coding-alist (ly:font-encoding-alist font))
 157          (input-encoding (assoc-get 'input-name coding-alist))
 158          (font-encoding (assoc-get 'output-name coding-alist))
 159          (coding-command (if (not (null? override-coding-command))
 160                              (car override-coding-command)
 161                              (if font-encoding
 162                                  (get-coding-command font-encoding)
 163                                  #f))))
 164
 165     (string-append
 166      "magfont" (string-encode-integer (hashq  name 1000000))
 167      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify))))
 168      (if (or (not font-encoding) (equal? input-encoding font-encoding)) ""
 169          (string-append "e" coding-command)))))
 170
 171 (define (define-fonts paper font-list)
 172
 173   (define (define-font command fontname scaling)
 174     (string-append
 175      "/" command " { /" fontname " findfont "
 176      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
 177
 178   (define (reencode-font plain encoding command)
 179     (let ((coding-vector (get-coding-command encoding)))
 180       (string-append
 181        plain " " coding-vector " /" command " reencode-font\n"
 182        "/" command "{ /" command " findfont 1 scalefont } bind def\n")))
 183
 184   (define (guess-ps-fontname basename)
 185     "We do not have the FontName, try to guess is from basename."
 186     (cond
 187      ((tex-font? basename)
 188       ;; FIXME: we need proper Fontmap for the bluesky CM*, EC* fonts.
 189       ;; Only the fonts that we trace in mf/ are in our own FontMap.
 190       (string-append basename ".pfb"))
 191      (else (string-append basename ".pfa"))
 192      ))
 193
 194   (define (font-load-command paper font)
 195     (let* ((specced-font-name (ly:font-name font))
 196            (fontname (if specced-font-name
 197                          specced-font-name
 198                          (guess-ps-fontname (ly:font-filename font))))
 199
 200            (coding-alist (ly:font-encoding-alist font))
 201            (input-encoding (assoc-get 'input-name coding-alist))
 202            (font-encoding (assoc-get 'output-name coding-alist))
 203            (command (font-command font))
 204            ;; FIXME -- see (font-command )
 205            (plain (if font-encoding (get-coding-command font-encoding)
 206                       command))
 207            (designsize (ly:font-design-size font))
 208            (magnification (* (ly:font-magnification font)))
 209            (ops (ly:paper-lookup paper 'outputscale))
 210            (scaling (* ops magnification designsize)))
 211
 212       (string-append
 213        (define-font plain fontname scaling)
 214        (if (or (equal? input-encoding font-encoding)
 215                ;; guh
 216                (equal? font-encoding "fetaBraces")
 217                (equal? font-encoding "fetaNumber")
 218                (equal? font-encoding "fetaMusic")
 219                (equal? font-encoding "parmesanMusic"))
 220                ""
 221            (reencode-font plain input-encoding command)))))
 222
 223   (define (font-load-encoding encoding)
 224     (let ((filename (get-coding-filename encoding)))
 225       (ly:kpathsea-gulp-file filename)))
 226
 227   (let* ((encoding-list (map (lambda (x)
 228                                (assoc-get 'input-name
 229                                           (ly:font-encoding-alist x)))
 230                              font-list))
 231          (encodings (uniq-list (sort-list (filter string? encoding-list)
 232                                           string<?))))
 233
 234     (string-append
 235      (apply string-append (map font-load-encoding encodings))
 236      (apply string-append
 237             (map (lambda (x) (font-load-command paper x)) font-list)))))
 238
 239 (define (define-origin file line col) "")
 240
 241 (define (dot x y radius)
 242   (string-append
 243    " "
 244    (ly:numbers->string
 245     (list x y radius)) " draw_dot"))
 246
 247 (define (draw-line thick x1 y1 x2 y2)
 248   (string-append
 249    "1 setlinecap 1 setlinejoin "
 250    (ly:number->string thick) " setlinewidth "
 251    (ly:number->string x1) " "
 252    (ly:number->string y1) " moveto "
 253    (ly:number->string x2) " "
 254    (ly:number->string y2) " lineto stroke"))
 255
 256 (define (end-output)
 257   "\nend-lilypond-output\n")
 258
 259 (define (ez-ball ch letter-col ball-col)
 260   (string-append
 261    " (" ch ") "
 262    (ly:numbers->string (list letter-col ball-col))
 263    " /Helvetica-Bold " ;; ugh
 264    " draw_ez_ball"))
 265
 266 (define (filledbox breapth width depth height)
 267   (string-append (ly:numbers->string (list breapth width depth height))
 268                  " draw_box"))
 269
 270 (define (header creator time-stamp page-count-)
 271   (set! page-count page-count-)
 272   (set! page-number 0)
 273   (string-append
 274    "%!PS-Adobe-3.0\n"
 275    "%%Creator: " creator " " time-stamp "\n"
 276    "%%Pages: " (number->string page-count) "\n"
 277    "%%PageOrder: Ascend\n"
 278    ;; FIXME: TODO get from paper
 279    ;; "%%DocumentPaperSizes: a6\n"
 280    ;;(string-append "GNU LilyPond (" (lilypond-version) "), ")
 281    ;;      (strftime "%c" (localtime (current-time))))
 282    ;; FIXME: duplicated in every backend
 283    (ps-string-def
 284     "lilypond" 'tagline
 285     (string-append "Engraved by LilyPond (version " (lilypond-version) ")"))))
 286
 287 (define (header-end)
 288   (string-append
 289    (ly:gulp-file "lilyponddefs.ps")
 290    (ly:gulp-file "music-drawing-routines.ps")))
 291
 292 (define (horizontal-line x1 x2 th)
 293   (draw-line th x1  0 x2 0))
 294
 295 (define (lily-def key val)
 296   (let ((prefix "lilypondpaper"))
 297     (if (string=?
 298          (substring key 0 (min (string-length prefix) (string-length key)))
 299          prefix)
 300         (string-append "/" key " {" val "} bind def\n")
 301         (string-append "/" key " (" val ") def\n"))))
 302
 303 (define (no-origin) "")
 304
 305 ;; FIXME: duplictates output-scopes, duplicated in other backends
 306 ;; FIXME: silly interface name
 307 (define (output-paper-def pd)
 308   (let ((prefix "lilypondpaper"))
 309
 310     (define (scope-entry->string key var)
 311       (if (variable-bound? var)
 312           (let ((val (variable-ref var)))
 313             (cond
 314              ((string? val) (ps-string-def prefix key val))
 315              ((number? val) (ps-number-def prefix key val))
 316              (else "")))
 317           ""))
 318
 319     (apply
 320      string-append
 321      (module-map scope-entry->string (ly:output-def-scope pd)))))
 322
 323 ;; FIXME: duplicated in other output backends
 324 ;; FIXME: silly interface name
 325 (define (output-scopes paper scopes fields basename)
 326   (let ((prefix "lilypond"))
 327
 328     ;; FIXME: duplicates output-paper's scope-entry->string, mostly
 329     (define (scope-entry->string key var)
 330       (if (variable-bound? var)
 331           (let ((val (variable-ref var)))
 332             (if (and (memq key fields) (string? val))
 333                 (header-to-file basename key val))
 334             (cond
 335              ((string? val) (ps-string-def prefix key val))
 336              ((number? val) (ps-number-def prefix key val))
 337              (else "")))
 338           ""))
 339
 340     (define (output-scope scope)
 341       (apply string-append (module-map scope-entry->string scope)))
 342
 343     (string-append (apply string-append (map output-scope scopes)))))
 344
 345 ;; hmm, looks like recursing call is always last statement, does guile
 346 ;; think so too?
 347 (define (output-stencil port expr offset)
 348   (if (pair? expr)
 349       (let ((head (car expr)))
 350         (cond
 351          ((ly:input-location? head)
 352           (display (apply define-origin (ly:input-location head)) port)
 353           (output-stencil port (cadr expr) offset))
 354          ((eq? head 'no-origin)
 355           (display (expression->string head) port)
 356           (output-stencil port (cadr expr) offset))
 357          ((eq? head 'translate-stencil)
 358           (output-stencil port (caddr expr) (offset-add offset (cadr expr))))
 359          ((eq? head 'combine-stencil)
 360           (output-stencil port (cadr expr) offset)
 361           (output-stencil port (caddr expr) offset))
 362          (else
 363           (display (placebox (car offset) (cdr offset)
 364                              (expression->string expr)) port))))))
 365
 366 (define (placebox x y s)
 367   (string-append
 368    (ly:number->string x) " " (ly:number->string y) " { " s " } place-box\n"))
 369
 370 (define (polygon points blotdiameter)
 371   (string-append
 372    (ly:numbers->string points) " "
 373    (ly:number->string (/ (length points) 2)) " "
 374    (ly:number->string blotdiameter)
 375    " draw_polygon"))
 376
 377 (define (repeat-slash wid slope thick)
 378   (string-append
 379    (ly:numbers->string (list wid slope thick))
 380    " draw_repeat_slash"))
 381
 382 (define (round-filled-box x y width height blotdiam)
 383    (string-append
 384     (ly:numbers->string
 385      (list x y width height blotdiam)) " draw_round_box"))
 386
 387 (define (new-start-system origin dim)
 388   (string-append
 389    "\n" (ly:number-pair->string origin) " start-system\n"
 390    "{\n"
 391    "set-ps-scale-to-lily-scale\n"))
 392
 393 (define (stem breapth width depth height)
 394   (string-append
 395    (ly:numbers->string (list breapth width depth height))
 396    " draw_box" ))
 397
 398 (define (stop-system)
 399   "} stop-system\n")
 400
 401 (define stop-last-system stop-system)
 402
 403 (define (symmetric-x-triangle thick w h)
 404   (string-append
 405    (ly:numbers->string (list h w thick))
 406    " draw_symmetric_x_triangle"))
 407
 408 (define (text font s)
 409   (string-append (font-command font) " setfont "
 410                  "(" (ps-encoding s) ") show"))
 411
 412 (define (unknown)
 413   "\n unknown\n")
 414
 415 (define (zigzag-line centre? zzw zzh thick dx dy)
 416   (string-append
 417     (if centre? "true" "false") " "
 418     (ly:number->string zzw) " "
 419     (ly:number->string zzh) " "
 420     (ly:number->string thick) " "
 421     "0 0 "
 422     (ly:number->string dx) " "
 423     (ly:number->string dy)
 424     " draw_zigzag_line"))
 425
 426 (define (start-page)
 427   (set! page-number (+ page-number 1))
 428   (string-append
 429    "%%Page: " (number->string page-number) " " (number->string page-count) "\n"
 430   "start-page\n"))
 431
 432 (define (stop-page last?)
 433   (if last?
 434       "\nstop-last-page\n"
 435       "\nstop-page\n"))