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 check-conflict-and-embed-cff
 249   (let ((font-list '()))
 250     (lambda (name file-name font-index)
 251       (if name
 252           (let* ((name-symbol (string->symbol name))
 253                  (args-filename-offset
 254                   (cons file-name (ly:get-cff-offset file-name font-index)))
 255                  (found-filename-offset (assq name-symbol font-list)))
 256             (if found-filename-offset
 257                 (begin
 258                   (if (equal? args-filename-offset (cdr found-filename-offset))
 259                       (ly:debug
 260                        (_ "CFF font `~a' already embedded, skipping.")
 261                        name)
 262                       (ly:warning
 263                        (_ "Different CFF fonts which have the same name `~a' has been detected. The font cannot be embedded.")
 264                        name))
 265                   "")
 266                 (begin
 267                   (ly:debug (_ "Embedding CFF font `~a'.") name)
 268                   (set! font-list
 269                         (acons name-symbol args-filename-offset font-list))
 270                   (ps-embed-cff (ly:otf->cff file-name font-index) name 0))))
 271           (begin
 272             (ly:debug (_ "Initializing embedded CFF font list."))
 273             (set! font-list '()))))))
 274
 275 (define (initialize-font-embedding)
 276   (check-conflict-and-embed-cff #f #f #f))
 277
 278 (define (write-preamble paper load-fonts? port)
 279   (define (internal-font? font-name-filename)
 280     (let* ((font (car font-name-filename))
 281            (file-name (caddr font-name-filename))
 282            (font-file-name (ly:find-file (format #f "~a.otf" file-name))))
 283       (and font
 284            (cff-font? font)
 285            font-file-name
 286            (string-contains font-file-name
 287                             (ly:get-option 'datadir)))))
 288
 289   (define (load-font-via-GS font-name-filename)
 290     (define (is-collection-font? file-name)
 291       (let* ((port (open-file file-name "rb"))
 292              (retval
 293               (if (eq? (read-char port) #\t)
 294                   (if (eq? (read-char port) #\t)
 295                       (if (eq? (read-char port) #\c)
 296                           (if (eq? (read-char port) #\f)
 297                               #t
 298                               #f)
 299                           #f)
 300                       #f)
 301                   #f)))
 302         (close-port port)
 303         retval))
 304
 305     (define (ps-load-file file-name)
 306       (if (string? file-name)
 307           (if (string-contains file-name (ly:get-option 'datadir))
 308               (begin
 309                 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
 310                                                       "" file-name))
 311                 (format #f
 312                         "lilypond-datadir (~a) concatstrings (r) file .loadfont\n"
 313                         file-name))
 314               (format #f "(~a) (r) file .loadfont\n" file-name))
 315           (format #f "% cannot find font file: ~a\n" file-name)))
 316
 317     (let* ((font (car font-name-filename))
 318            (name (cadr font-name-filename))
 319            (file-name (caddr font-name-filename))
 320            (font-index (cadddr font-name-filename))
 321            (bare-file-name (ly:find-file file-name)))
 322       (cond
 323        ((and (number? font-index)
 324              (!= font-index 0))
 325         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because its font-index (~a) is not zero.")
 326                     name font-index)
 327         (load-font font-name-filename))
 328        ((and (string? bare-file-name)
 329              (eq? (ly:get-font-format bare-file-name font-index) 'CFF)
 330              (is-collection-font? bare-file-name))
 331         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because it is an OpenType/CFF Collection (OTC) font.")
 332                     name)
 333         (load-font font-name-filename))
 334        ((and (string? bare-file-name)
 335              (eq? (ly:get-font-format bare-file-name font-index) 'TrueType)
 336              (not (ly:has-glyph-names? bare-file-name font-index)))
 337         (ly:warning (_ "Font ~a cannot be used via Ghostscript because it is a TrueType font that does not have glyph names.")
 338                     name)
 339         (load-font font-name-filename))
 340        (else
 341         (cons name
 342               (if (mac-font? bare-file-name)
 343                   (handle-mac-font name bare-file-name)
 344                   (cond
 345                    ((and font (cff-font? font))
 346                     (ps-load-file (ly:find-file
 347                                    (format #f "~a.otf" file-name))))
 348                    ((string? bare-file-name)
 349                     (ps-load-file file-name))
 350                    (else
 351                     (ly:warning (_ "cannot embed ~S=~S") name file-name)
 352                     ""))))))))
 353
 354   (define (dir-join a b)
 355     (if (equal? a "")
 356         b
 357         (string-append a "/" b)))
 358
 359   (define (dir-listing dir-name)
 360     (define (dir-helper dir lst)
 361       (let ((e (readdir dir)))
 362         (if (eof-object? e)
 363             lst
 364             (dir-helper dir (cons e lst)))))
 365     (reverse (dir-helper (opendir dir-name) '())))
 366
 367   (define (handle-mac-font name file-name)
 368     (let* ((dir-name (tmpnam))
 369            (files '())
 370            (status 0)
 371            (embed #f)
 372            (cwd (getcwd)))
 373       (mkdir dir-name #o700)
 374       (chdir dir-name)
 375       (set! status (ly:system (list "fondu" "-force" file-name)))
 376       (chdir cwd)
 377       (set! files (dir-listing dir-name))
 378       (for-each
 379        (lambda (f)
 380          (let* ((full-name (dir-join dir-name f)))
 381            (if (and (not embed)
 382                     (equal? 'regular (stat:type (stat full-name)))
 383                     (equal? name (ly:ttf-ps-name full-name)))
 384                (set! embed (font-file-as-ps-string name full-name 0)))
 385            (if (or (equal? "." f)
 386                    (equal? ".." f))
 387                #t
 388                (delete-file full-name))))
 389        files)
 390       (rmdir dir-name)
 391       (if (not embed)
 392           (begin
 393             (set! embed "% failed\n")
 394             (ly:warning (_ "cannot extract file matching ~a from ~a")
 395                         name file-name)))
 396       embed))
 397
 398   (define (font-file-as-ps-string name file-name font-index)
 399     (let ((font-format (ly:get-font-format file-name font-index)))
 400       (cond
 401        ((eq? font-format (string->symbol "Type 1"))
 402         ;; Type 1 (PFA and PFB) fonts
 403         (ly:type1->pfa file-name))
 404        ((eq? font-format 'TrueType)
 405         ;; TrueType fonts (TTF) and TrueType Collection (TTC)
 406         (ly:ttf->pfa file-name font-index))
 407        ((eq? font-format 'CFF)
 408         ;; OpenType/CFF fonts (OTF) and OpenType/CFF Collection (OTC)
 409         (check-conflict-and-embed-cff name file-name font-index))
 410        (else
 411         (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
 412         ""))))
 413
 414   (define (mac-font? bare-file-name)
 415     (and (eq? PLATFORM 'darwin)
 416          bare-file-name
 417          (or (string-endswith bare-file-name ".dfont")
 418              (= (stat:size (stat bare-file-name)) 0))))
 419
 420   (define (load-font font-psname-filename-fontindex)
 421     (let* ((font (list-ref font-psname-filename-fontindex 0))
 422            (name (list-ref font-psname-filename-fontindex 1))
 423            (file-name (list-ref font-psname-filename-fontindex 2))
 424            (font-index (list-ref font-psname-filename-fontindex 3))
 425            (bare-file-name (ly:find-file file-name)))
 426       (cons name
 427             (cond ((mac-font? bare-file-name)
 428                    (handle-mac-font name bare-file-name))
 429                   ((and font (cff-font? font))
 430                    (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 431                                  name
 432                                  0))
 433                   (bare-file-name (font-file-as-ps-string
 434                                    name bare-file-name font-index))
 435                   (else
 436                    (ly:warning (_ "do not know how to embed font ~s ~s ~s")
 437                                name file-name font))))))
 438
 439   (define (load-fonts paper)
 440     (let* ((fonts (ly:paper-fonts paper))
 441
 442            ;; todo - doc format of list.
 443            (all-font-names
 444             (map
 445              (lambda (font)
 446                (cond ((string? (ly:font-file-name font))
 447                       (list (list font
 448                                   (ly:font-name font)
 449                                   (ly:font-file-name font)
 450                                   #f)))
 451                      ((ly:pango-font? font)
 452                       (map (lambda (psname-filename-fontindex)
 453                              (list #f
 454                                    (list-ref psname-filename-fontindex 0)
 455                                    (list-ref psname-filename-fontindex 1)
 456                                    (list-ref psname-filename-fontindex 2)))
 457                            (ly:pango-font-physical-fonts font)))
 458                      (else
 459                       (ly:font-sub-fonts font))))
 460              fonts))
 461            (font-names (uniq-list
 462                         (sort (concatenate all-font-names)
 463                               (lambda (x y) (string<? (cadr x) (cadr y))))))
 464
 465            ;; slightly spaghetti-ish: deciding what to load where
 466            ;; is smeared out.
 467            (font-loader
 468             (lambda (name)
 469               (cond ((ly:get-option 'gs-load-fonts)
 470                      (load-font-via-GS name))
 471                     ((ly:get-option 'gs-load-lily-fonts)
 472                      (if (or (string-contains (caddr name)
 473                                               (ly:get-option 'datadir))
 474                              (internal-font? name))
 475                          (load-font-via-GS name)
 476                          (load-font name)))
 477                     (else
 478                      (load-font name)))))
 479            (pfas (map font-loader font-names)))
 480       pfas))
 481
 482
 483   (display "%%BeginProlog\n" port)
 484   (format
 485    port
 486    "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
 487    (ly:get-option 'datadir))
 488   (if load-fonts?
 489       (for-each (lambda (f)
 490                   (format port "\n%%BeginFont: ~a\n" (car f))
 491                   (display (cdr f) port)
 492                   (display "%%EndFont\n" port))
 493                 (load-fonts paper)))
 494   (if (ly:bigpdfs)
 495       (display (procset "encodingdefs.ps") port))
 496   (display (setup-variables paper) port)
 497
 498   ;; adobe note 5002: should initialize variables before loading routines.
 499   (display (procset "music-drawing-routines.ps") port)
 500   (display (procset "lilyponddefs.ps") port)
 501   (display "%%EndProlog\n" port)
 502   (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
 503
 504 (define (ps-quote str)
 505   (fold
 506    (lambda (replacement-list result)
 507      (string-join
 508       (string-split
 509        result
 510        (car replacement-list))
 511       (cadr replacement-list)))
 512    str
 513    '((#\\ "\\\\") (#\( "\\(") (#\) "\\)"))))
 514
 515 ;;; Create DOCINFO pdfmark containing metadata
 516 ;;; header fields with pdf prefix override those without the prefix
 517 (define (handle-metadata header port)
 518   (define (metadata-encode val)
 519     ;; First, call ly:encode-string-for-pdf to encode the string (latin1 or
 520     ;; utf-16be), then escape all parentheses and backslashes
 521     ;; FIXME guile-2.0: use (string->utf16 str 'big) instead
 522
 523     (ps-quote (ly:encode-string-for-pdf val)))
 524   (define (metadata-lookup-output overridevar fallbackvar field)
 525     (let* ((overrideval (ly:modules-lookup (list header) overridevar))
 526            (fallbackval (ly:modules-lookup (list header) fallbackvar))
 527            (val (if overrideval overrideval fallbackval)))
 528       (if val
 529           (format port "/~a (~a)\n" field (metadata-encode (markup->string val (list header)))))))
 530
 531   (if (module? header)
 532       (begin
 533        (display "mark " port)
 534        (metadata-lookup-output 'pdfauthor 'author "Author")
 535        (format port "/Creator (LilyPond ~a)\n" (lilypond-version))
 536        (metadata-lookup-output 'pdftitle 'title "Title")
 537        (metadata-lookup-output 'pdfsubject 'subject "Subject")
 538        (metadata-lookup-output 'pdfkeywords 'keywords "Keywords")
 539        (metadata-lookup-output 'pdfmodDate 'modDate "ModDate")
 540        (metadata-lookup-output 'pdfsubtitle 'subtitle "Subtitle")
 541        (metadata-lookup-output 'pdfcomposer 'composer "Composer")
 542        (metadata-lookup-output 'pdfarranger 'arranger "Arranger")
 543        (metadata-lookup-output 'pdfpoet 'poet "Poet")
 544        (metadata-lookup-output 'pdfcopyright 'copyright "Copyright")
 545        (display "/DOCINFO pdfmark\n\n" port)))
 546
 547   (if (ly:get-option 'embed-source-code)
 548       (let ((source-list (delete-duplicates
 549                           (remove (lambda (str)
 550                                     (or
 551                                      (string-contains str
 552                                        (ly:get-option 'datadir))
 553                                      (string=? str
 554                                        "<included string>")))
 555                             (ly:source-files)))))
 556          (display "\n/pdfmark where
 557 {pop} {userdict /pdfmark /cleartomark load put} ifelse" port)
 558          (for-each (lambda (fname idx)
 559                      (format port "\n
 560 mark /_objdef {ly~a_stream} /type /stream   /OBJ pdfmark
 561 mark {ly~a_stream} << /Type /EmbeddedFile>> /PUT pdfmark
 562 mark {ly~a_stream} (~a) /PUT pdfmark
 563 mark /Name (LilyPond source file ~a)
 564 /FS << /Type /Filespec /F (~a) /EF << /F {ly~a_stream} >> >> /EMBED pdfmark
 565 mark {ly~a_stream} /CLOSE pdfmark
 566 \n"
 567                 idx idx idx
 568                 (ps-quote (ly:gulp-file fname))
 569                   idx fname idx idx))
 570           source-list (iota (length source-list))))))
 571
 572 (define-public (output-framework basename book scopes fields)
 573   (let* ((port-tmp (make-tmpfile))
 574          (tmp-name (port-filename port-tmp))
 575          (outputter (ly:make-paper-outputter
 576                      port-tmp
 577                      'ps))
 578          (paper (ly:paper-book-paper book))
 579          (header (ly:paper-book-header book))
 580          (systems (ly:paper-book-systems book))
 581          (page-stencils (map page-stencil (ly:paper-book-pages book)))
 582          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 583          (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
 584          (page-count (length page-stencils))
 585          (port (ly:outputter-port outputter)))
 586     (initialize-font-embedding)
 587     (if (ly:get-option 'clip-systems)
 588         (clip-system-EPSes basename book))
 589     (if (ly:get-option 'dump-signatures)
 590         (write-system-signatures basename (ly:paper-book-systems book) 1))
 591     (output-scopes scopes fields basename)
 592     (display (file-header paper page-count #t) port)
 593     ;; don't do BeginDefaults PageMedia: A4
 594     ;; not necessary and wrong
 595     (write-preamble paper #t port)
 596     (handle-metadata header port)
 597     (for-each
 598      (lambda (page)
 599        (set! page-number (1+ page-number))
 600        (dump-page outputter page page-number page-count landscape?))
 601      page-stencils)
 602     (display "%%Trailer\n%%EOF\n" port)
 603     (ly:outputter-close outputter)
 604     (postprocess-output book framework-ps-module (ly:output-formats)
 605                         basename tmp-name #f)))
 606
 607 (define-public (dump-stencil-as-EPS paper dump-me filename
 608                                     load-fonts)
 609   (let* ((xext (ly:stencil-extent dump-me X))
 610          (yext (ly:stencil-extent dump-me Y))
 611          (padding (ly:get-option 'eps-box-padding))
 612          (left-overshoot (if (number? padding)
 613                              (* -1 padding (ly:output-def-lookup paper 'mm))
 614                              #f))
 615          (bbox
 616           (map
 617            (lambda (x)
 618              (if (or (nan? x) (inf? x)
 619                      ;; FIXME: huh?
 620                      (equal? (format #f "~S" x) "+#.#")
 621                      (equal? (format #f "~S" x) "-#.#"))
 622                  0.0 x))
 623
 624            ;; the left-overshoot is to make sure that
 625            ;; bar numbers stick out of margin uniformly.
 626            ;;
 627            (list
 628             (if (number? left-overshoot)
 629                 (min left-overshoot (car xext))
 630                 (car xext))
 631             (car yext) (cdr xext) (cdr yext)))))
 632     (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)))
 633
 634 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
 635                                               load-fonts
 636                                               bbox)
 637   "Create an EPS file from stencil @var{dump-me} to @var{filename}.
 638 @var{bbox} has format @code{(left-x, lower-y, right-x, upper-y)}.  If
 639 @var{load-fonts} set, include fonts inline."
 640   (define (to-rounded-bp-box box)
 641     "Convert box to 1/72 inch with rounding to enlarge the box."
 642     (let* ((scale (ly:output-def-lookup paper 'output-scale))
 643            (strip-non-number (lambda (x)
 644                                (if (or (nan? x)
 645                                        (inf? x))
 646                                    0.0
 647                                    x)))
 648            (directed-round (lambda (x rounder)
 649                              (inexact->exact
 650                               (rounder (/ (* (strip-non-number x) scale)
 651                                           (ly:bp 1)))))))
 652       (list (directed-round (car box) floor)
 653             (directed-round (cadr box) floor)
 654             (directed-round (max (1+ (car box)) (caddr box)) ceiling)
 655             (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling))))
 656
 657   (let* ((outputter (ly:make-paper-outputter
 658                      ;; FIXME: better wrap open/open-file,
 659                      ;; content-mangling is always bad.
 660                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 661                      (open-file (format #f "~a.eps" filename) "wb")
 662                      'ps))
 663          (port (ly:outputter-port outputter))
 664          (rounded-bbox (to-rounded-bp-box bbox))
 665          (port (ly:outputter-port outputter))
 666          (header (eps-header paper rounded-bbox load-fonts)))
 667     (initialize-font-embedding)
 668     (display header port)
 669     (write-preamble paper load-fonts port)
 670     (display "/mark_page_link { pop pop pop pop pop } bind def\n" port)
 671     (display "gsave set-ps-scale-to-lily-scale\n" port)
 672     (display "/helpEmmentaler-Brace where {pop helpEmmentaler-Brace} if\n" port)
 673     (display "/helpEmmentaler-11 where {pop helpEmmentaler-11} if\n" port)
 674     (display "/helpEmmentaler-13 where {pop helpEmmentaler-13} if\n" port)
 675     (display "/helpEmmentaler-14 where {pop helpEmmentaler-14} if\n" port)
 676     (display "/helpEmmentaler-16 where {pop helpEmmentaler-16} if\n" port)
 677     (display "/helpEmmentaler-18 where {pop helpEmmentaler-18} if\n" port)
 678     (display "/helpEmmentaler-20 where {pop helpEmmentaler-20} if\n" port)
 679     (display "/helpEmmentaler-23 where {pop helpEmmentaler-23} if\n" port)
 680     (display "/helpEmmentaler-26 where {pop helpEmmentaler-26} if\n" port)
 681     (ly:outputter-dump-stencil outputter dump-me)
 682     (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
 683     (ly:outputter-close outputter)))
 684
 685 (define (clip-systems-to-region basename paper systems region do-pdf do-png)
 686   (let* ((extents-system-pairs
 687           (filtered-map (lambda (paper-system)
 688                           (let* ((x-ext (system-clipped-x-extent
 689                                          (paper-system-system-grob paper-system)
 690                                          region)))
 691                             (if x-ext
 692                                 (cons x-ext paper-system)
 693                                 #f)))
 694                         systems))
 695          (count 0))
 696     (for-each
 697      (lambda (ext-system-pair)
 698        (let* ((xext (car ext-system-pair))
 699               (paper-system (cdr ext-system-pair))
 700               (yext (paper-system-extent paper-system Y))
 701               (bbox (list (car xext) (car yext)
 702                           (cdr xext) (cdr yext)))
 703               (filename (if (< 0 count)
 704                             (format #f "~a-~a" basename count)
 705                             basename)))
 706          (set! count (1+ count))
 707          (dump-stencil-as-EPS-with-bbox paper
 708                                         (paper-system-stencil paper-system)
 709                                         filename
 710                                         (ly:get-option 'include-eps-fonts)
 711                                         bbox)
 712          (if do-pdf
 713              (postscript->pdf 0 0 filename (format #f "~a.eps" filename) #t))
 714          (if do-png
 715              (postscript->png (ly:get-option 'resolution) 0 0
 716                               filename (format #f "~a.eps" filename) #t))))
 717      extents-system-pairs)))
 718
 719 (define-public (clip-system-EPSes basename paper-book)
 720   (define do-pdf
 721     (member "pdf" (ly:output-formats)))
 722   (define do-png
 723     (member "png" (ly:output-formats)))
 724
 725   (define (clip-score-systems basename systems)
 726     (let* ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
 727            (regions (ly:output-def-lookup layout 'clip-regions)))
 728       (for-each
 729        (lambda (region)
 730          (clip-systems-to-region
 731           (format #f "~a-from-~a-to-~a-clip"
 732                   basename
 733                   (rhythmic-location->file-string (car region))
 734                   (rhythmic-location->file-string (cdr region)))
 735           layout systems region
 736           do-pdf do-png))
 737        regions)))
 738
 739   ;; partition in system lists sharing their layout blocks
 740   (let* ((systems (ly:paper-book-systems paper-book))
 741          (count 0)
 742          (score-system-list '()))
 743     (fold
 744      (lambda (system last-system)
 745        (if (not (and last-system
 746                      (equal? (paper-system-layout last-system)
 747                              (paper-system-layout system))))
 748            (set! score-system-list (cons '() score-system-list)))
 749        (if (paper-system-layout system)
 750            (set-car! score-system-list (cons system (car score-system-list))))
 751        ;; pass value.
 752        system)
 753      #f
 754      systems)
 755     (for-each (lambda (system-list)
 756                 ;; filter out headers and top-level markup
 757                 (if (pair? system-list)
 758                     (clip-score-systems
 759                      (if (> count 0)
 760                          (format #f "~a-~a" basename count)
 761                          basename)
 762                      system-list)))
 763               score-system-list)))
 764
 765 (define-public (output-preview-framework basename book scopes fields)
 766   (let* ((paper (ly:paper-book-paper book))
 767          (systems (relevant-book-systems book))
 768          (to-dump-systems (relevant-dump-systems systems)))
 769     (dump-stencil-as-EPS paper
 770                          (stack-stencils Y DOWN 0.0
 771                                          (map paper-system-stencil
 772                                               (reverse to-dump-systems)))
 773                          (format #f "~a.preview" basename)
 774                          #t)
 775     (postprocess-output book framework-ps-module
 776                         (cons "png" (ly:output-formats))
 777                         (format #f "~a.preview" basename)
 778                         (format #f "~a.preview.eps" basename)
 779                         #t
 780                         )))
 781
 782 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 783
 784 (define (output-width-height defs)
 785   (let* ((landscape (ly:output-def-lookup defs 'landscape))
 786          (output-scale (ly:output-def-lookup defs 'output-scale))
 787          (convert (lambda (x)
 788                     (* x output-scale (/ (ly:bp 1)))))
 789          (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
 790          (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
 791          (w (if landscape paper-height paper-width))
 792          (h (if landscape paper-width paper-height)))
 793     (cons w h)))
 794
 795 (define (output-resolution defs)
 796   (let ((defs-resolution (ly:output-def-lookup defs 'pngresolution)))
 797     (if (number? defs-resolution)
 798         defs-resolution
 799         (ly:get-option 'resolution))))
 800
 801 (define-public (convert-to-pdf book base-name tmp-name is-eps)
 802   (let* ((defs (ly:paper-book-paper book))
 803          (width-height (output-width-height defs))
 804          (width (car width-height))
 805          (height (cdr width-height)))
 806     (postscript->pdf width height base-name tmp-name is-eps)))
 807
 808 (define-public (convert-to-png book base-name tmp-name is-eps)
 809   (let* ((defs (ly:paper-book-paper book))
 810          (resolution (output-resolution defs))
 811          (width-height (output-width-height defs))
 812          (width (car width-height))
 813          (height (cdr width-height)))
 814     (postscript->png resolution width height base-name tmp-name is-eps)))
 815
 816 (define-public (convert-to-ps book base-name tmp-name is-eps)
 817   (postscript->ps base-name tmp-name is-eps))
 818
 819 (define-public (output-classic-framework basename book scopes fields)
 820   (ly:error (_ "\nThe PostScript backend does not support the
 821 system-by-system output.  For that, use the EPS backend instead,
 822
 823   lilypond -dbackend=eps FILE
 824
 825 If you have cut & pasted a lilypond fragment from a webpage, be sure
 826 to only remove anything before
 827
 828   %% ****************************************************************
 829   %% Start cut-&-pastable-section
 830   %% ****************************************************************
 831 ")))