scm/framework-tex.scm

   1 ;;;; framework-tex.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7 (define-module (scm framework-tex)
   8   #:export (output-framework-tex
   9             output-classic-framework-tex))
  10
  11 (use-modules (ice-9 regex)
  12              (ice-9 string-fun)
  13              (ice-9 format)
  14              (guile)
  15              (srfi srfi-1)
  16              (srfi srfi-13)
  17              (srfi srfi-14)
  18              (lily))
  19
  20 (define (output-formats)
  21   (define formats (ly:output-formats))
  22   (set! formats (completize-formats formats))
  23   (if (member "ps" formats)
  24       (set! formats (cons "dvi" formats)))
  25   (if (member "dvi" formats)
  26       (set! formats (cons "tex" formats)))
  27
  28   (uniq-list formats))
  29
  30 (define framework-tex-module (current-module))
  31 (define-public (sanitize-tex-string s)
  32   (if (ly:get-option 'safe)
  33       (regexp-substitute/global
  34        #f "\\\\"
  35        (regexp-substitute/global #f "([{}])" s 'pre  "\\" 1 'post)
  36        'pre "$\\backslash$" 'post)
  37       s))
  38
  39 (define (symbol->tex-key sym)
  40   (regexp-substitute/global
  41    #f "_" (sanitize-tex-string (symbol->string sym)) 'pre "X" 'post))
  42
  43 (define (tex-number-def prefix key number)
  44   (string-append
  45    "\\def\\" prefix (symbol->tex-key key) "{" number "}%\n"))
  46
  47 (define-public (digits->letters str)
  48   (regexp-substitute/global
  49    #f "[-\\._]"
  50    (regexp-substitute/global
  51     #f "([0-9])" str
  52     'pre
  53     (lambda (match)
  54       (make-string
  55        1
  56        (integer->char
  57         (+ (char->integer #\A)
  58            (- (char->integer #\0))
  59            (char->integer (string-ref (match:substring match 1) 0)))
  60         )))
  61     'post)
  62    'pre ""
  63    'post))
  64
  65 (define-public (tex-font-command-raw name magnification)
  66   (string-append
  67    "magfont"
  68    (digits->letters (format "~a" name))
  69    "m"
  70    (string-encode-integer
  71     (inexact->exact (round (* 1000 magnification))))))
  72
  73 (define-public (tex-font-command font)
  74   (tex-font-command-raw
  75    (ly:font-file-name font) (ly:font-magnification font)))
  76
  77 (define (otf-font-load-command paper font)
  78   (let* ((sub-fonts (ly:font-sub-fonts font)))
  79     (string-append
  80      (apply string-append
  81             (map
  82              (lambda (sub-name)
  83                (format #f "\\font\\~a=~a scaled ~a%\n"
  84                        (tex-font-command-raw
  85                         sub-name (ly:font-magnification font))
  86                        sub-name
  87                        (ly:number->string
  88                         (inexact->exact
  89                          (round (* 1000
  90                                    (ly:font-magnification font)
  91                                    (ly:paper-outputscale paper)))))))
  92              sub-fonts)))))
  93
  94 (define (simple-font-load-command paper font)
  95    (format
  96     "\\font\\~a=~a scaled ~a%\n"
  97     (tex-font-command font)
  98     (ly:font-file-name font)
  99     (inexact->exact
 100      (round (* 1000
 101                (ly:font-magnification font)
 102                (ly:paper-outputscale paper))))))
 103
 104 (define (font-load-command paper font)
 105   (if (pair? (ly:font-sub-fonts font))
 106       (otf-font-load-command paper font)
 107       (simple-font-load-command paper font)))
 108
 109 (define (define-fonts paper)
 110   (string-append
 111    ;; UGH. FIXME.
 112    "\\def\\lilypondpaperunit{mm}%\n"
 113    (tex-number-def "lilypondpaper" 'outputscale
 114                    (number->string (exact->inexact
 115                                     (ly:paper-outputscale paper))))
 116    (tex-string-def "lilypondpaper" 'papersize
 117                    (eval 'papersizename (ly:output-def-scope paper)))
 118    ;; paper/layout?
 119    (tex-string-def "lilypondpaper" 'inputencoding
 120                    (eval 'inputencoding (ly:output-def-scope paper)))
 121
 122    (apply string-append
 123           (map (lambda (x) (font-load-command paper x))
 124                (ly:paper-fonts paper)))))
 125
 126 (define (tex-string-def prefix key str)
 127   (if (equal? "" (sans-surrounding-whitespace (sanitize-tex-string str)))
 128       (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
 129       (string-append "\\def\\" prefix (symbol->tex-key key)
 130                      "{" (sanitize-tex-string str) "}%\n")))
 131
 132 (define (header paper page-count classic?)
 133   (let ((scale (ly:output-def-lookup paper 'outputscale))
 134         (texpaper (string-append
 135                    (ly:output-def-lookup paper 'papersizename)
 136                    "paper"))
 137         (landscape? (eq? #t (ly:output-def-lookup paper 'landscape))))
 138     (string-append
 139      "% Generated by LilyPond "
 140      (lilypond-version) "\n"
 141      "% at " "time-stamp,FIXME" "\n"
 142      (if classic?
 143          (tex-string-def "lilypond" 'classic "1")
 144          "")
 145
 146      (if (ly:get-option 'safe)
 147          "\\nofiles\n"
 148          "")
 149
 150      (tex-string-def
 151       "lilypondpaper" 'linewidth
 152       (ly:number->string (* scale (ly:output-def-lookup paper 'linewidth))))
 153      "\\def\\lilyponddocumentclassoptions{"
 154      (sanitize-tex-string texpaper)
 155      (if landscape? ",landscape" "")
 156      "}%\n"
 157      (tex-string-def
 158       "lilypondpaper" 'interscoreline
 159       (ly:number->string
 160        (* scale (ly:output-def-lookup paper 'interscoreline)))))))
 161
 162 (define (header-end)
 163   (string-append
 164    "\\def\\scaletounit{ "
 165    (number->string lily-unit->bigpoint-factor)
 166    " mul }%\n"
 167    "\\ifx\\lilypondstart\\undefined\n"
 168    "  \\input lilyponddefs\n"
 169    "\\fi\n"
 170    "\\lilypondstart\n"
 171    "\\lilypondspecial\n"
 172    "\\lilypondpostscript\n"))
 173
 174 (define (dump-page putter page last? with-extents?)
 175   (ly:outputter-dump-string
 176    putter
 177    (format "\\lybox{~a}{~a}{%\n"
 178            (if with-extents?
 179                (interval-start (ly:stencil-extent page X))
 180                0.0)
 181            (if with-extents?
 182                (- (interval-start (ly:stencil-extent page Y)))
 183                0.0)))
 184   (ly:outputter-dump-stencil putter page)
 185   (ly:outputter-dump-string
 186    putter
 187    (if last?
 188        "}%\n\\vfill\n"
 189        "}%\n\\vfill\n\\lilypondpagebreak\n")))
 190
 191 (define-public (output-framework basename book scopes fields)
 192   (let* ((filename (format "~a.tex" basename))
 193          (outputter  (ly:make-paper-outputter filename "tex"))
 194          (paper (ly:paper-book-paper book))
 195          (pages (ly:paper-book-pages book))
 196          (last-page (car (last-pair pages)))
 197          (with-extents
 198           (eq? #t (ly:output-def-lookup paper 'dump-extents))))
 199     (for-each
 200      (lambda (x)
 201        (ly:outputter-dump-string outputter x))
 202      (list
 203       (header paper (length pages) #f)
 204       (define-fonts paper)
 205       (header-end)))
 206     (ly:outputter-dump-string outputter "\\lilypondnopagebreak\n")
 207     (for-each
 208      (lambda (page)
 209        (dump-page outputter page (eq? last-page page) with-extents))
 210      pages)
 211     (ly:outputter-dump-string outputter "\\lilypondend\n")
 212     (ly:outputter-close outputter)
 213     (postprocess-output book framework-tex-module filename
 214                         (output-formats))))
 215
 216 (define (dump-line putter line last?)
 217   (ly:outputter-dump-string
 218    putter
 219    (format "\\lybox{~a}{~a}{%\n"
 220            (ly:number->string
 221             (max 0 (interval-end (ly:paper-system-extent line X))))
 222            (ly:number->string
 223             (interval-length (ly:paper-system-extent line Y)))))
 224
 225   (ly:outputter-dump-stencil putter (ly:paper-system-stencil line))
 226   (ly:outputter-dump-string
 227    putter
 228    (if last?
 229        "}%\n"
 230        "}\\interscoreline\n")))
 231
 232 (define-public (output-classic-framework
 233                 basename book scopes fields)
 234   (let* ((filename (format "~a.tex" basename))
 235          (outputter  (ly:make-paper-outputter filename "tex"))
 236          (paper (ly:paper-book-paper book))
 237          (lines (ly:paper-book-systems book))
 238          (last-line (car (last-pair lines))))
 239     (for-each
 240      (lambda (x)
 241        (ly:outputter-dump-string outputter x))
 242      (list
 243       ;;FIXME
 244       (header paper (length lines) #f)
 245       "\\def\\lilypondclassic{1}%\n"
 246       (output-scopes scopes fields basename)
 247       (define-fonts paper)
 248       (header-end)))
 249
 250     (for-each
 251      (lambda (line) (dump-line outputter line (eq? line last-line))) lines)
 252     (ly:outputter-dump-string outputter "\\lilypondend\n")
 253     (ly:outputter-close outputter)
 254     (postprocess-output book framework-tex-module filename
 255                         (output-formats))
 256     ))
 257
 258 (define-public (output-preview-framework
 259                 basename book scopes fields)
 260   (let* ((filename (format "~a.tex" basename))
 261          (outputter  (ly:make-paper-outputter filename
 262                                               "tex"))
 263          (paper (ly:paper-book-paper book))
 264          (lines (ly:paper-book-systems book))
 265          (first-notes-index (list-index
 266                              (lambda (s) (not (ly:paper-system-title? s)))
 267                              lines)))
 268
 269     (for-each
 270      (lambda (x)
 271        (ly:outputter-dump-string outputter x))
 272      (list
 273
 274       ;;FIXME
 275       (header paper (length lines) #f)
 276       "\\def\\lilypondclassic{1}%\n"
 277       (output-scopes scopes fields basename)
 278       (define-fonts paper)
 279       (header-end)))
 280
 281     (for-each
 282      (lambda (lst)
 283        (dump-line outputter lst (not (ly:paper-system-title? lst))))
 284      (take lines (1+ first-notes-index)))
 285     (ly:outputter-dump-string outputter "\\lilypondend\n")
 286     (ly:outputter-close outputter)
 287     (postprocess-output book framework-tex-module filename
 288                         (output-formats))))
 289
 290 (define-public (convert-to-pdf book name)
 291   (let* ((defs (ly:paper-book-paper book))
 292          (papersizename (ly:output-def-lookup defs 'papersizename)))
 293     (postscript->pdf (if (string? papersizename) papersizename "a4")
 294                      (string-append (basename name ".tex") ".ps"))))
 295
 296 (define-public (convert-to-png book name)
 297   (let* ((defs (ly:paper-book-paper book))
 298          (resolution (ly:output-def-lookup defs 'pngresolution))
 299          (papersizename (ly:output-def-lookup defs 'papersizename)))
 300     (postscript->png
 301      (if (number? resolution)
 302          resolution
 303          (assoc
 304           'resolution
 305           (ly:get-option 'command-line-settings)))
 306
 307      (if (string? papersizename)
 308          papersizename
 309          "a4")
 310
 311      (string-append (basename name ".tex") ".ps"))))
 312
 313 (define-public (convert-to-ps book name)
 314   (let* ((paper (ly:paper-book-paper book))
 315          (preview? (string-contains name ".preview"))
 316          (papersizename (ly:output-def-lookup paper 'papersizename))
 317          (landscape? (eq? #t (ly:output-def-lookup paper 'landscape)))
 318          (base (basename name ".tex"))
 319          (ps-name (format "~a.ps"  base ".ps"))
 320          (cmd (string-append "dvips"
 321                              (if preview?
 322                                  " -E"
 323                                  (string-append
 324                                   " -t"
 325                                   ;; careful: papersizename is user-set.
 326                                   (sanitize-command-option papersizename)
 327                                   ""))
 328                              (if landscape? " -tlandscape" "")
 329                              (if (ly:kpathsea-find-file "lm.map")
 330                                  " -u+lm.map" "")
 331                              (if (ly:kpathsea-find-file "ecrm10.pfa")
 332                                  " -u+ec-mftrace.map" "")
 333                              " -u+lilypond.map -Ppdf" ""
 334                              " -o" ps-name
 335                              " " base)))
 336     (if (access? ps-name W_OK)
 337         (delete-file ps-name))
 338     (if (not (ly:get-option 'verbose))
 339         (begin
 340           (ly:message (_ "Converting to `~a'...") (string-append base ".ps"))
 341           (ly:progress "\n")))
 342     (ly:system cmd)))
 343
 344 (define-public (convert-to-dvi book name)
 345   (let* ((curr-extra-mem
 346           (string->number
 347            (regexp-substitute/global
 348             #f " *%.*\n?"
 349             (ly:kpathsea-expand-variable "$extra_mem_top")
 350             'pre "" 'post)))
 351          (base (basename name ".tex"))
 352          (cmd (format
 353                #f "latex \\\\nonstopmode \\\\input '~a'" name)))
 354
 355     ;; FIXME: latex 'foo bar' works, but \input 'foe bar' does not?
 356     (if (string-index name (char-set #\space #\ht #\newline #\cr))
 357         (ly:error (_"TeX file name must not contain whitespace: `~a'") name))
 358
 359     (setenv "extra_mem_top" (number->string (max curr-extra-mem 1024000)))
 360     (let ((dvi-name (string-append base ".dvi")))
 361       (if (access? dvi-name W_OK)
 362           (delete-file dvi-name)))
 363     (if (not (ly:get-option 'verbose))
 364         (begin
 365           (ly:message (_ "Converting to `~a'...") (string-append base ".dvi"))
 366           (ly:progress "\n")))
 367
 368     ;; FIXME: set in environment?
 369     (if (ly:get-option 'safe)
 370         (set! cmd (string-append "openout_any=p " cmd)))
 371
 372     (ly:system cmd)))
 373
 374 (define-public (convert-to-tex book name)
 375   #t)