scm/framework-ps.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;
   5 ;;;; LilyPond is free software: you can redistribute it and/or modify
   6 ;;;; it under the terms of the GNU General Public License as published by
   7 ;;;; the Free Software Foundation, either version 3 of the License, or
   8 ;;;; (at your option) any later version.
   9 ;;;;
  10 ;;;; LilyPond is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;;; GNU General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU General Public License
  16 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 (define-module (scm framework-ps))
  19
  20 ;;; this is still too big a mess.
  21
  22 (use-modules (ice-9 string-fun)
  23              (guile)
  24              (scm page)
  25              (scm paper-system)
  26              (srfi srfi-1)
  27              (srfi srfi-13)
  28              (scm clip-region)
  29              (lily))
  30
  31 (define format ergonomic-simple-format)
  32
  33 (define framework-ps-module (current-module))
  34
  35 ;;(define pdebug stderr)
  36 (define (pdebug . rest) #f)
  37
  38 (define-public (ps-font-command font)
  39   (let* ((name (ly:font-file-name font))
  40          (magnify (ly:font-magnification font)))
  41     (string-append
  42      "magfont"
  43      (ly:string-substitute
  44       " " "_"
  45       (ly:string-substitute
  46        "/" "_"
  47        (ly:string-substitute
  48         "%" "_" name)))
  49      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  50
  51 (define (ps-define-pango-pf pango-pf font-name scaling)
  52   "")
  53
  54 (define (ps-define-font font font-name scaling)
  55   (if (ly:bigpdfs)
  56       (string-append
  57        "/" (ps-font-command font) "-N"
  58        " { /" font-name "-N"
  59        " " (ly:number->string scaling) " output-scale div selectfont }"
  60        " bind def\n"
  61        "/" (ps-font-command font) "-S"
  62        " { /" font-name "-S"
  63        " " (ly:number->string scaling) " output-scale div selectfont }"
  64        " bind def\n"
  65        "/" (ps-font-command font) "-O"
  66        " { /" font-name "-O"
  67        " " (ly:number->string scaling) " output-scale div selectfont }"
  68        " bind def\n"
  69        "/help" font-name " {\n  gsave\n  1 setgray\n  /"
  70        font-name "-N"
  71        " 0.001 selectfont 0 0 moveto <01> show\n  /"
  72        font-name "-S"
  73        " 0.001 selectfont 0 0 moveto <01> show\n  /"
  74        font-name "-O"
  75        " 0.001 selectfont 0 0 moveto <01> show\n  grestore\n} def\n")
  76       (string-append
  77        "/" (ps-font-command font)
  78        " { /" font-name
  79        " " (ly:number->string scaling) " output-scale div selectfont }"
  80        " bind def\n")))
  81
  82 ;; FIXME: duplicated in other output backends
  83 ;; FIXME: silly interface name
  84 (define (output-variables layout)
  85   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  86   (define (value->string val)
  87     (cond
  88      ((string? val) (string-append "(" val ")"))
  89      ((symbol? val) (symbol->string val))
  90      ((number? val) (number->string val))
  91      (else "")))
  92
  93   (define (output-entry ps-key ly-key)
  94     (string-append
  95      "/" ps-key " "
  96      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  97
  98   (string-append
  99    "/lily-output-units "
 100    (number->string (/ (ly:bp 1))) " def %% millimeter\n"
 101    (output-entry "staff-line-thickness" 'line-thickness)
 102    (output-entry "line-width" 'line-width)
 103    (output-entry "paper-size" 'papersizename)
 104    (output-entry "staff-height" 'staff-height)  ;junkme.
 105    "/output-scale "
 106    (number->string (ly:output-def-lookup layout 'output-scale)) " def\n"
 107    (output-entry "page-height" 'paper-height)
 108    (output-entry "page-width" 'paper-width)
 109    (if (ly:get-option 'strokeadjust) "true setstrokeadjust\n" "")
 110    ))
 111
 112 (define (dump-page outputter page page-number page-count landscape?)
 113   (ly:outputter-dump-string
 114    outputter
 115    (string-append
 116     (format #f "%%Page: ~a ~a\n" page-number page-number)
 117     "%%BeginPageSetup\n"
 118     (if landscape?
 119         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 120         "")
 121     "%%EndPageSetup\n"
 122     "\n"
 123     "gsave 0 paper-height translate set-ps-scale-to-lily-scale\n"
 124     "/helpEmmentaler-Brace where {pop helpEmmentaler-Brace} if\n"
 125     "/helpEmmentaler-11 where {pop helpEmmentaler-11} if\n"
 126     "/helpEmmentaler-13 where {pop helpEmmentaler-13} if\n"
 127     "/helpEmmentaler-14 where {pop helpEmmentaler-14} if\n"
 128     "/helpEmmentaler-16 where {pop helpEmmentaler-16} if\n"
 129     "/helpEmmentaler-18 where {pop helpEmmentaler-18} if\n"
 130     "/helpEmmentaler-20 where {pop helpEmmentaler-20} if\n"
 131     "/helpEmmentaler-23 where {pop helpEmmentaler-23} if\n"
 132     "/helpEmmentaler-26 where {pop helpEmmentaler-26} if\n"))
 133   (ly:outputter-dump-stencil outputter page)
 134   (ly:outputter-dump-string outputter "stroke grestore\nshowpage\n"))
 135
 136 (define (supplies-or-needs paper load-fonts?)
 137   (define (extract-names font)
 138     (if (ly:pango-font? font)
 139         (map car (ly:pango-font-physical-fonts font))
 140         (list (ly:font-name font))))
 141
 142   (let* ((fonts (ly:paper-fonts paper))
 143          (names (append-map extract-names fonts)))
 144     (string-concatenate
 145      (map (lambda (f)
 146             (format #f
 147                     (if load-fonts?
 148                         "%%DocumentSuppliedResources: font ~a\n"
 149                         "%%DocumentNeededResources: font ~a\n")
 150                     f))
 151           (uniq-list (sort names string<?))))))
 152
 153 (define (eps-header paper bbox load-fonts?)
 154   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 155                  "%%Creator: LilyPond " (lilypond-version) "\n"
 156                  "%%BoundingBox: "
 157                  (string-join (map ly:number->string bbox) " ") "\n"
 158                  "%%Orientation: "
 159                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 160                      "Landscape\n"
 161                      "Portrait\n")
 162                  (supplies-or-needs paper load-fonts?)
 163                  "%%EndComments\n"))
 164
 165 (define (ps-document-media paper)
 166   (let* ((w (/ (*
 167                 (ly:output-def-lookup paper 'output-scale)
 168                 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
 169          (h (/ (*
 170                 (ly:output-def-lookup paper 'paper-height)
 171                 (ly:output-def-lookup paper 'output-scale))
 172                (ly:bp 1)))
 173          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
 174     (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
 175                (ly:output-def-lookup paper 'papersizename)
 176                (if landscape? h w)
 177                (if landscape? w h)
 178                80   ;; weight
 179                "()" ;; color
 180                "()" ;; type
 181                )))
 182
 183 (define (file-header paper page-count load-fonts?)
 184   (string-append "%!PS-Adobe-3.0\n"
 185                  "%%Creator: LilyPond " (lilypond-version) "\n"
 186                  "%%Pages: " (number->string page-count) "\n"
 187                  "%%PageOrder: Ascend\n"
 188                  "%%Orientation: "
 189                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 190                      "Landscape\n"
 191                      "Portrait\n")
 192                  (ps-document-media paper)
 193                  (supplies-or-needs paper load-fonts?)
 194                  "%%EndComments\n"))
 195
 196 (define (procset file-name)
 197   (format #f
 198           "%%BeginResource: procset (~a) 1 0
 199 ~a
 200 %%EndResource
 201 "
 202           file-name (cached-file-contents file-name)))
 203
 204 (define (embed-document file-name)
 205   (format #f "%%BeginDocument: ~a
 206 ~a
 207 %%EndDocument
 208 "
 209           file-name (cached-file-contents file-name)))
 210
 211 (define (setup-variables paper)
 212   (string-append
 213    "\n"
 214    (define-fonts paper ps-define-font ps-define-pango-pf)
 215    (output-variables paper)))
 216
 217 (define (cff-font? font)
 218   (let* ((cff-string (ly:otf-font-table-data font "CFF ")))
 219     (> (string-length cff-string) 0)))
 220
 221 (define-public (ps-embed-cff body font-set-name version)
 222   (let* ((binary-data
 223           (string-append
 224            (format #f "/~a ~s StartData " font-set-name (string-length body))
 225            body))
 226          (header
 227           (format #f
 228                   "%%BeginResource: font ~a
 229 %!PS-Adobe-3.0 Resource-FontSet
 230 %%DocumentNeededResources: ProcSet (FontSetInit)
 231 %%Title: (FontSet/~a)
 232 %%Version: ~s
 233 %%EndComments
 234 %%IncludeResource: ProcSet (FontSetInit)
 235 %%BeginResource: FontSet (~a)
 236 /FontSetInit /ProcSet findresource begin
 237 %%BeginData: ~s Binary Bytes
 238 "
 239                   font-set-name font-set-name version font-set-name
 240                   (string-length binary-data)))
 241          (footer "\n%%EndData
 242 %%EndResource
 243 %%EndResource\n"))
 244     (string-append header
 245                    binary-data
 246                    footer)))
 247
 248 (define (write-preamble paper load-fonts? port)
 249   (define (internal-font? font-name-filename)
 250     (let* ((font (car font-name-filename))
 251            (file-name (caddr font-name-filename))
 252            (font-file-name (ly:find-file (format #f "~a.otf" file-name))))
 253       (and font
 254            (cff-font? font)
 255            font-file-name
 256            (string-contains font-file-name
 257                             (ly:get-option 'datadir)))))
 258
 259   (define (load-font-via-GS font-name-filename)
 260     (define (is-collection-font? file-name)
 261       (let ((port (open-file file-name "rb")))
 262         (if (eq? (read-char port) #\t)
 263             (if (eq? (read-char port) #\t)
 264                 (if (eq? (read-char port) #\c)
 265                     (if (eq? (read-char port) #\f)
 266                         #t
 267                         #f)
 268                     #f)
 269                 #f)
 270             #f)))
 271
 272     (define (ps-load-file file-name)
 273       (if (string? file-name)
 274           (if (string-contains file-name (ly:get-option 'datadir))
 275               (begin
 276                 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
 277                                                       "" file-name))
 278                 (format #f
 279                         "lilypond-datadir (~a) concatstrings (r) file .loadfont\n"
 280                         file-name))
 281               (format #f "(~a) (r) file .loadfont\n" file-name))
 282           (format #f "% cannot find font file: ~a\n" file-name)))
 283
 284     (let* ((font (car font-name-filename))
 285            (name (cadr font-name-filename))
 286            (file-name (caddr font-name-filename))
 287            (font-index (cadddr font-name-filename))
 288            (bare-file-name (ly:find-file file-name)))
 289       (cond
 290        ((and (number? font-index)
 291              (!= font-index 0))
 292         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because its font-index (~a) is not zero.")
 293                     name font-index)
 294         (load-font font-name-filename))
 295        ((and (string? bare-file-name)
 296              (eq? (ly:get-font-format bare-file-name font-index) 'CFF)
 297              (is-collection-font? bare-file-name))
 298         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because it is an OpenType/CFF (OTC) font.")
 299                     name)
 300         (load-font font-name-filename))
 301        ((and (string? bare-file-name)
 302              (eq? (ly:get-font-format bare-file-name font-index) 'TrueType)
 303              (not (ly:has-glyph-names? bare-file-name font-index)))
 304         (ly:warning (_ "Font ~a cannot be used via Ghostscript because it is a TrueType font that does not have glyph names.")
 305                     name)
 306         (load-font font-name-filename))
 307        (else
 308         (cons name
 309               (if (mac-font? bare-file-name)
 310                   (handle-mac-font name bare-file-name)
 311                   (cond
 312                    ((and font (cff-font? font))
 313                     (ps-load-file (ly:find-file
 314                                    (format #f "~a.otf" file-name))))
 315                    ((string? bare-file-name)
 316                     (ps-load-file file-name))
 317                    (else
 318                     (ly:warning (_ "cannot embed ~S=~S") name file-name)
 319                     ""))))))))
 320
 321   (define (dir-join a b)
 322     (if (equal? a "")
 323         b
 324         (string-append a "/" b)))
 325
 326   (define (dir-listing dir-name)
 327     (define (dir-helper dir lst)
 328       (let ((e (readdir dir)))
 329         (if (eof-object? e)
 330             lst
 331             (dir-helper dir (cons e lst)))))
 332     (reverse (dir-helper (opendir dir-name) '())))
 333
 334   (define (handle-mac-font name file-name)
 335     (let* ((dir-name (tmpnam))
 336            (files '())
 337            (status 0)
 338            (embed #f)
 339            (cwd (getcwd)))
 340       (mkdir dir-name #o700)
 341       (chdir dir-name)
 342       (set! status (ly:system (list "fondu" "-force" file-name)))
 343       (chdir cwd)
 344       (set! files (dir-listing dir-name))
 345       (for-each
 346        (lambda (f)
 347          (let* ((full-name (dir-join dir-name f)))
 348            (if (and (not embed)
 349                     (equal? 'regular (stat:type (stat full-name)))
 350                     (equal? name (ly:ttf-ps-name full-name)))
 351                (set! embed (font-file-as-ps-string name full-name 0)))
 352            (if (or (equal? "." f)
 353                    (equal? ".." f))
 354                #t
 355                (delete-file full-name))))
 356        files)
 357       (rmdir dir-name)
 358       (if (not embed)
 359           (begin
 360             (set! embed "% failed\n")
 361             (ly:warning (_ "cannot extract file matching ~a from ~a")
 362                         name file-name)))
 363       embed))
 364
 365   (define (font-file-as-ps-string name file-name font-index)
 366     (let ((font-format (ly:get-font-format file-name font-index)))
 367       (cond
 368        ((eq? font-format (string->symbol "Type 1"))
 369         ;; Type 1 (PFA and PFB) fonts
 370         (ly:type1->pfa file-name))
 371        ((eq? font-format 'TrueType)
 372         ;; TrueType fonts (TTF) and TrueType Collection (TTC)
 373         (ly:ttf->pfa file-name font-index))
 374        ((eq? font-format 'CFF)
 375         ;; OpenType/CFF fonts (OTF) and OpenType/CFF Collection (OTC)
 376         (ps-embed-cff (ly:otf->cff file-name font-index) name 0))
 377        (else
 378         (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
 379         ""))))
 380
 381   (define (mac-font? bare-file-name)
 382     (and (eq? PLATFORM 'darwin)
 383          bare-file-name
 384          (or (string-endswith bare-file-name ".dfont")
 385              (= (stat:size (stat bare-file-name)) 0))))
 386
 387   (define (load-font font-psname-filename-fontindex)
 388     (let* ((font (list-ref font-psname-filename-fontindex 0))
 389            (name (list-ref font-psname-filename-fontindex 1))
 390            (file-name (list-ref font-psname-filename-fontindex 2))
 391            (font-index (list-ref font-psname-filename-fontindex 3))
 392            (bare-file-name (ly:find-file file-name)))
 393       (cons name
 394             (cond ((mac-font? bare-file-name)
 395                    (handle-mac-font name bare-file-name))
 396                   ((and font (cff-font? font))
 397                    (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 398                                  name
 399                                  0))
 400                   (bare-file-name (font-file-as-ps-string
 401                                    name bare-file-name font-index))
 402                   (else
 403                    (ly:warning (_ "do not know how to embed font ~s ~s ~s")
 404                                name file-name font))))))
 405
 406   (define (load-fonts paper)
 407     (let* ((fonts (ly:paper-fonts paper))
 408
 409            ;; todo - doc format of list.
 410            (all-font-names
 411             (map
 412              (lambda (font)
 413                (cond ((string? (ly:font-file-name font))
 414                       (list (list font
 415                                   (ly:font-name font)
 416                                   (ly:font-file-name font)
 417                                   #f)))
 418                      ((ly:pango-font? font)
 419                       (map (lambda (psname-filename-fontindex)
 420                              (list #f
 421                                    (list-ref psname-filename-fontindex 0)
 422                                    (list-ref psname-filename-fontindex 1)
 423                                    (list-ref psname-filename-fontindex 2)))
 424                            (ly:pango-font-physical-fonts font)))
 425                      (else
 426                       (ly:font-sub-fonts font))))
 427              fonts))
 428            (font-names (uniq-list
 429                         (sort (concatenate all-font-names)
 430                               (lambda (x y) (string<? (cadr x) (cadr y))))))
 431
 432            ;; slightly spaghetti-ish: deciding what to load where
 433            ;; is smeared out.
 434            (font-loader
 435             (lambda (name)
 436               (cond ((ly:get-option 'gs-load-fonts)
 437                      (load-font-via-GS name))
 438                     ((ly:get-option 'gs-load-lily-fonts)
 439                      (if (or (string-contains (caddr name)
 440                                               (ly:get-option 'datadir))
 441                              (internal-font? name))
 442                          (load-font-via-GS name)
 443                          (load-font name)))
 444                     (else
 445                      (load-font name)))))
 446            (pfas (map font-loader font-names)))
 447       pfas))
 448
 449
 450   (display "%%BeginProlog\n" port)
 451   (format
 452    port
 453    "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
 454    (ly:get-option 'datadir))
 455   (if load-fonts?
 456       (for-each (lambda (f)
 457                   (format port "\n%%BeginFont: ~a\n" (car f))
 458                   (display (cdr f) port)
 459                   (display "%%EndFont\n" port))
 460                 (load-fonts paper)))
 461   (if (ly:bigpdfs)
 462       (display (procset "encodingdefs.ps") port))
 463   (display (setup-variables paper) port)
 464
 465   ;; adobe note 5002: should initialize variables before loading routines.
 466   (display (procset "music-drawing-routines.ps") port)
 467   (display (procset "lilyponddefs.ps") port)
 468   (display "%%EndProlog\n" port)
 469   (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
 470
 471 (define (ps-quote str)
 472   (fold
 473    (lambda (replacement-list result)
 474      (string-join
 475       (string-split
 476        result
 477        (car replacement-list))
 478       (cadr replacement-list)))
 479    str
 480    '((#\\ "\\\\") (#\( "\\(") (#\) "\\)"))))
 481
 482 ;;; Create DOCINFO pdfmark containing metadata
 483 ;;; header fields with pdf prefix override those without the prefix
 484 (define (handle-metadata header port)
 485   (define (metadata-encode val)
 486     ;; First, call ly:encode-string-for-pdf to encode the string (latin1 or
 487     ;; utf-16be), then escape all parentheses and backslashes
 488     ;; FIXME guile-2.0: use (string->utf16 str 'big) instead
 489
 490     (ps-quote (ly:encode-string-for-pdf val)))
 491   (define (metadata-lookup-output overridevar fallbackvar field)
 492     (let* ((overrideval (ly:modules-lookup (list header) overridevar))
 493            (fallbackval (ly:modules-lookup (list header) fallbackvar))
 494            (val (if overrideval overrideval fallbackval)))
 495       (if val
 496           (format port "/~a (~a)\n" field (metadata-encode (markup->string val (list header)))))))
 497
 498   (if (module? header)
 499       (begin
 500        (display "mark " port)
 501        (metadata-lookup-output 'pdfauthor 'author "Author")
 502        (format port "/Creator (LilyPond ~a)\n" (lilypond-version))
 503        (metadata-lookup-output 'pdftitle 'title "Title")
 504        (metadata-lookup-output 'pdfsubject 'subject "Subject")
 505        (metadata-lookup-output 'pdfkeywords 'keywords "Keywords")
 506        (metadata-lookup-output 'pdfmodDate 'modDate "ModDate")
 507        (metadata-lookup-output 'pdfsubtitle 'subtitle "Subtitle")
 508        (metadata-lookup-output 'pdfcomposer 'composer "Composer")
 509        (metadata-lookup-output 'pdfarranger 'arranger "Arranger")
 510        (metadata-lookup-output 'pdfpoet 'poet "Poet")
 511        (metadata-lookup-output 'pdfcopyright 'copyright "Copyright")
 512        (display "/DOCINFO pdfmark\n\n" port)))
 513
 514   (if (ly:get-option 'embed-source-code)
 515       (let ((source-list (delete-duplicates
 516                           (remove (lambda (str)
 517                                     (or
 518                                      (string-contains str
 519                                        (ly:get-option 'datadir))
 520                                      (string=? str
 521                                        "<included string>")))
 522                             (ly:source-files)))))
 523          (display "\n/pdfmark where
 524 {pop} {userdict /pdfmark /cleartomark load put} ifelse" port)
 525          (for-each (lambda (fname idx)
 526                      (format port "\n
 527 mark /_objdef {ly~a_stream} /type /stream   /OBJ pdfmark
 528 mark {ly~a_stream} << /Type /EmbeddedFile>> /PUT pdfmark
 529 mark {ly~a_stream} (~a) /PUT pdfmark
 530 mark /Name (LilyPond source file ~a)
 531 /FS << /Type /Filespec /F (~a) /EF << /F {ly~a_stream} >> >> /EMBED pdfmark
 532 mark {ly~a_stream} /CLOSE pdfmark
 533 \n"
 534                 idx idx idx
 535                 (ps-quote (ly:gulp-file fname))
 536                   idx fname idx idx))
 537           source-list (iota (length source-list))))))
 538
 539 (define-public (output-framework basename book scopes fields)
 540   (let* ((port-tmp (make-tmpfile))
 541          (tmp-name (port-filename port-tmp))
 542          (outputter (ly:make-paper-outputter
 543                      port-tmp
 544                      'ps))
 545          (paper (ly:paper-book-paper book))
 546          (header (ly:paper-book-header book))
 547          (systems (ly:paper-book-systems book))
 548          (page-stencils (map page-stencil (ly:paper-book-pages book)))
 549          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 550          (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
 551          (page-count (length page-stencils))
 552          (port (ly:outputter-port outputter)))
 553     (if (ly:get-option 'clip-systems)
 554         (clip-system-EPSes basename book))
 555     (if (ly:get-option 'dump-signatures)
 556         (write-system-signatures basename (ly:paper-book-systems book) 1))
 557     (output-scopes scopes fields basename)
 558     (display (file-header paper page-count #t) port)
 559     ;; don't do BeginDefaults PageMedia: A4
 560     ;; not necessary and wrong
 561     (write-preamble paper #t port)
 562     (handle-metadata header port)
 563     (for-each
 564      (lambda (page)
 565        (set! page-number (1+ page-number))
 566        (dump-page outputter page page-number page-count landscape?))
 567      page-stencils)
 568     (display "%%Trailer\n%%EOF\n" port)
 569     (ly:outputter-close outputter)
 570     (postprocess-output book framework-ps-module (ly:output-formats)
 571                         basename tmp-name #f)))
 572
 573 (define-public (dump-stencil-as-EPS paper dump-me filename
 574                                     load-fonts)
 575   (let* ((xext (ly:stencil-extent dump-me X))
 576          (yext (ly:stencil-extent dump-me Y))
 577          (padding (ly:get-option 'eps-box-padding))
 578          (left-overshoot (if (number? padding)
 579                              (* -1 padding (ly:output-def-lookup paper 'mm))
 580                              #f))
 581          (bbox
 582           (map
 583            (lambda (x)
 584              (if (or (nan? x) (inf? x)
 585                      ;; FIXME: huh?
 586                      (equal? (format #f "~S" x) "+#.#")
 587                      (equal? (format #f "~S" x) "-#.#"))
 588                  0.0 x))
 589
 590            ;; the left-overshoot is to make sure that
 591            ;; bar numbers stick out of margin uniformly.
 592            ;;
 593            (list
 594             (if (number? left-overshoot)
 595                 (min left-overshoot (car xext))
 596                 (car xext))
 597             (car yext) (cdr xext) (cdr yext)))))
 598     (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)))
 599
 600 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
 601                                               load-fonts
 602                                               bbox)
 603   "Create an EPS file from stencil @var{dump-me} to @var{filename}.
 604 @var{bbox} has format @code{(left-x, lower-y, right-x, upper-y)}.  If
 605 @var{load-fonts} set, include fonts inline."
 606   (define (to-rounded-bp-box box)
 607     "Convert box to 1/72 inch with rounding to enlarge the box."
 608     (let* ((scale (ly:output-def-lookup paper 'output-scale))
 609            (strip-non-number (lambda (x)
 610                                (if (or (nan? x)
 611                                        (inf? x))
 612                                    0.0
 613                                    x)))
 614            (directed-round (lambda (x rounder)
 615                              (inexact->exact
 616                               (rounder (/ (* (strip-non-number x) scale)
 617                                           (ly:bp 1)))))))
 618       (list (directed-round (car box) floor)
 619             (directed-round (cadr box) floor)
 620             (directed-round (max (1+ (car box)) (caddr box)) ceiling)
 621             (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling))))
 622
 623   (let* ((outputter (ly:make-paper-outputter
 624                      ;; FIXME: better wrap open/open-file,
 625                      ;; content-mangling is always bad.
 626                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 627                      (open-file (format #f "~a.eps" filename) "wb")
 628                      'ps))
 629          (port (ly:outputter-port outputter))
 630          (rounded-bbox (to-rounded-bp-box bbox))
 631          (port (ly:outputter-port outputter))
 632          (header (eps-header paper rounded-bbox load-fonts)))
 633     (display header port)
 634     (write-preamble paper load-fonts port)
 635     (display "/mark_page_link { pop pop pop pop pop } bind def\n" port)
 636     (display "gsave set-ps-scale-to-lily-scale\n" port)
 637     (display "/helpEmmentaler-Brace where {pop helpEmmentaler-Brace} if\n" port)
 638     (display "/helpEmmentaler-11 where {pop helpEmmentaler-11} if\n" port)
 639     (display "/helpEmmentaler-13 where {pop helpEmmentaler-13} if\n" port)
 640     (display "/helpEmmentaler-14 where {pop helpEmmentaler-14} if\n" port)
 641     (display "/helpEmmentaler-16 where {pop helpEmmentaler-16} if\n" port)
 642     (display "/helpEmmentaler-18 where {pop helpEmmentaler-18} if\n" port)
 643     (display "/helpEmmentaler-20 where {pop helpEmmentaler-20} if\n" port)
 644     (display "/helpEmmentaler-23 where {pop helpEmmentaler-23} if\n" port)
 645     (display "/helpEmmentaler-26 where {pop helpEmmentaler-26} if\n" port)
 646     (ly:outputter-dump-stencil outputter dump-me)
 647     (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
 648     (ly:outputter-close outputter)))
 649
 650 (define (clip-systems-to-region basename paper systems region do-pdf do-png)
 651   (let* ((extents-system-pairs
 652           (filtered-map (lambda (paper-system)
 653                           (let* ((x-ext (system-clipped-x-extent
 654                                          (paper-system-system-grob paper-system)
 655                                          region)))
 656                             (if x-ext
 657                                 (cons x-ext paper-system)
 658                                 #f)))
 659                         systems))
 660          (count 0))
 661     (for-each
 662      (lambda (ext-system-pair)
 663        (let* ((xext (car ext-system-pair))
 664               (paper-system (cdr ext-system-pair))
 665               (yext (paper-system-extent paper-system Y))
 666               (bbox (list (car xext) (car yext)
 667                           (cdr xext) (cdr yext)))
 668               (filename (if (< 0 count)
 669                             (format #f "~a-~a" basename count)
 670                             basename)))
 671          (set! count (1+ count))
 672          (dump-stencil-as-EPS-with-bbox paper
 673                                         (paper-system-stencil paper-system)
 674                                         filename
 675                                         (ly:get-option 'include-eps-fonts)
 676                                         bbox)
 677          (if do-pdf
 678              (postscript->pdf 0 0 filename (format #f "~a.eps" filename) #t))
 679          (if do-png
 680              (postscript->png (ly:get-option 'resolution) 0 0
 681                               filename (format #f "~a.eps" filename) #t))))
 682      extents-system-pairs)))
 683
 684 (define-public (clip-system-EPSes basename paper-book)
 685   (define do-pdf
 686     (member "pdf" (ly:output-formats)))
 687   (define do-png
 688     (member "png" (ly:output-formats)))
 689
 690   (define (clip-score-systems basename systems)
 691     (let* ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
 692            (regions (ly:output-def-lookup layout 'clip-regions)))
 693       (for-each
 694        (lambda (region)
 695          (clip-systems-to-region
 696           (format #f "~a-from-~a-to-~a-clip"
 697                   basename
 698                   (rhythmic-location->file-string (car region))
 699                   (rhythmic-location->file-string (cdr region)))
 700           layout systems region
 701           do-pdf do-png))
 702        regions)))
 703
 704   ;; partition in system lists sharing their layout blocks
 705   (let* ((systems (ly:paper-book-systems paper-book))
 706          (count 0)
 707          (score-system-list '()))
 708     (fold
 709      (lambda (system last-system)
 710        (if (not (and last-system
 711                      (equal? (paper-system-layout last-system)
 712                              (paper-system-layout system))))
 713            (set! score-system-list (cons '() score-system-list)))
 714        (if (paper-system-layout system)
 715            (set-car! score-system-list (cons system (car score-system-list))))
 716        ;; pass value.
 717        system)
 718      #f
 719      systems)
 720     (for-each (lambda (system-list)
 721                 ;; filter out headers and top-level markup
 722                 (if (pair? system-list)
 723                     (clip-score-systems
 724                      (if (> count 0)
 725                          (format #f "~a-~a" basename count)
 726                          basename)
 727                      system-list)))
 728               score-system-list)))
 729
 730 (define-public (output-preview-framework basename book scopes fields)
 731   (let* ((paper (ly:paper-book-paper book))
 732          (systems (relevant-book-systems book))
 733          (to-dump-systems (relevant-dump-systems systems)))
 734     (dump-stencil-as-EPS paper
 735                          (stack-stencils Y DOWN 0.0
 736                                          (map paper-system-stencil
 737                                               (reverse to-dump-systems)))
 738                          (format #f "~a.preview" basename)
 739                          #t)
 740     (postprocess-output book framework-ps-module
 741                         (cons "png" (ly:output-formats))
 742                         (format #f "~a.preview" basename)
 743                         (format #f "~a.preview.eps" basename)
 744                         #t
 745                         )))
 746
 747 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 748
 749 (define (output-width-height defs)
 750   (let* ((landscape (ly:output-def-lookup defs 'landscape))
 751          (output-scale (ly:output-def-lookup defs 'output-scale))
 752          (convert (lambda (x)
 753                     (* x output-scale (/ (ly:bp 1)))))
 754          (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
 755          (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
 756          (w (if landscape paper-height paper-width))
 757          (h (if landscape paper-width paper-height)))
 758     (cons w h)))
 759
 760 (define (output-resolution defs)
 761   (let ((defs-resolution (ly:output-def-lookup defs 'pngresolution)))
 762     (if (number? defs-resolution)
 763         defs-resolution
 764         (ly:get-option 'resolution))))
 765
 766 (define-public (convert-to-pdf book base-name tmp-name is-eps)
 767   (let* ((defs (ly:paper-book-paper book))
 768          (width-height (output-width-height defs))
 769          (width (car width-height))
 770          (height (cdr width-height)))
 771     (postscript->pdf width height base-name tmp-name is-eps)))
 772
 773 (define-public (convert-to-png book base-name tmp-name is-eps)
 774   (let* ((defs (ly:paper-book-paper book))
 775          (resolution (output-resolution defs))
 776          (width-height (output-width-height defs))
 777          (width (car width-height))
 778          (height (cdr width-height)))
 779     (postscript->png resolution width height base-name tmp-name is-eps)))
 780
 781 (define-public (convert-to-ps book base-name tmp-name is-eps)
 782   (postscript->ps base-name tmp-name is-eps))
 783
 784 (define-public (output-classic-framework basename book scopes fields)
 785   (ly:error (_ "\nThe PostScript backend does not support the
 786 system-by-system output.  For that, use the EPS backend instead,
 787
 788   lilypond -dbackend=eps FILE
 789
 790 If you have cut & pasted a lilypond fragment from a webpage, be sure
 791 to only remove anything before
 792
 793   %% ****************************************************************
 794   %% Start cut-&-pastable-section
 795   %% ****************************************************************
 796 ")))