scm/output-tex.scm

   1 ;;;; tex.scm -- implement Scheme output routines for TeX
   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
   9 ;; (debug-enable 'backtrace)
  10 (define-module (scm output-tex)
  11   #:re-export (quote)
  12   #:export (define-fonts
  13              font-command
  14              unknown
  15              output-paper-def
  16              output-scopes
  17              blank
  18              dot
  19              beam
  20              bracket
  21              dashed-slur
  22              char
  23              dashed-line
  24              zigzag-line
  25              symmetric-x-triangle
  26              ez-ball
  27              comment
  28              end-output
  29              experimental-on
  30              repeat-slash
  31              header-end
  32              header
  33              placebox
  34              bezier-sandwich
  35              start-system
  36              stop-system
  37              stop-last-system
  38              horizontal-line
  39              filledbox
  40              round-filled-box
  41              text
  42              tuplet
  43              polygon
  44              draw-line
  45              define-origin
  46              no-origin
  47              start-page
  48              stop-page
  49              ))
  50
  51 (use-modules (ice-9 regex)
  52              (ice-9 string-fun)
  53              (ice-9 format)
  54              (guile)
  55              (srfi srfi-13)
  56              (lily))
  57
  58 ;;;;;;;;
  59 ;;;;;;;; DOCUMENT ME!
  60 ;;;;;;;;
  61
  62
  63 (define (font-command font)
  64   (string-append
  65    "magfont"
  66    (string-encode-integer
  67     (hashq (ly:font-filename font) 1000000))
  68    "m"
  69    (string-encode-integer
  70     (inexact->exact (round (* 1000 (ly:font-magnification font)))))))
  71
  72 (define (define-fonts bookpaper)
  73   (string-append
  74    "\\def\\lilypondpaperunit{mm}" ;; UGH. FIXME.
  75    (tex-number-def "lilypondpaper" 'outputscale
  76                    (number->string (exact->inexact
  77                                     (ly:bookpaper-outputscale bookpaper))))
  78    (tex-string-def "lilypondpapersize" 'papersize
  79                    (eval 'papersize (ly:output-def-scope bookpaper)))
  80
  81    (apply string-append
  82           (map (lambda (x) (font-load-command bookpaper x))
  83                (ly:bookpaper-fonts bookpaper)
  84                ))))
  85
  86 (define (unknown)
  87   "%\n\\unknown\n")
  88
  89 (define (symbol->tex-key sym)
  90   (regexp-substitute/global
  91    #f "_" (output-tex-string (symbol->string sym)) 'pre "X" 'post) )
  92
  93 (define (string->param string)
  94   (string-append "{" string "}"))
  95
  96 (define (number->param number)
  97   (string->param (ly:number->string number)))
  98
  99 (define (number-pair->param o)
 100   (string-append (number->param (car o)) (number->param (cdr o))))
 101
 102 (define (tex-string-def prefix key str)
 103   (if (equal? "" (sans-surrounding-whitespace (output-tex-string str)))
 104       (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
 105       (string-append "\\def\\" prefix (symbol->tex-key key)
 106                      "{" (output-tex-string str) "}%\n")))
 107
 108 (define (tex-number-def prefix key number)
 109   (string-append
 110    "\\def\\" prefix (symbol->tex-key key) (string->param number) "%\n"))
 111
 112 (define (output-paper-def paper)
 113       (apply
 114        string-append
 115        (module-map
 116         (lambda (sym var)
 117           (let ((val (variable-ref var))
 118                 (key (symbol->tex-key sym)))
 119
 120             (cond
 121              ((string? val)
 122               (tex-string-def "lilypondpaper" sym val))
 123              ((number? val)
 124               (tex-number-def "lilypondpaper" sym
 125                               (if (integer? val)
 126                                   (number->string val)
 127                                   (number->string (exact->inexact val)))))
 128              (else ""))))
 129
 130         (ly:output-def-scope pd))))
 131
 132 (define (output-scopes paper scopes fields basename)
 133   (define (output-scope scope)
 134     (apply
 135      string-append
 136      (module-map
 137      (lambda (sym var)
 138        (let (;;(val (variable-ref var))
 139              (val (if (variable-bound? var) (variable-ref var) '""))
 140              (tex-key (symbol->string sym)))
 141
 142          (if (and (memq sym fields) (string? val))
 143              (header-to-file basename sym val))
 144
 145          (cond
 146           ((string? val)
 147            (tex-string-def "lilypond" sym val))
 148           ((number? val)
 149            (tex-number-def "lilypond" sym
 150                            (if (integer? val)
 151                                (number->string val)
 152                                (number->string (exact->inexact val)))))
 153           (else ""))))
 154      scope)))
 155
 156   (apply string-append
 157          (map output-scope scopes)))
 158
 159 (define (blank)
 160   "")
 161
 162 (define (dot x y radius)
 163   (embedded-ps (list 'dot x y radius)))
 164
 165 (define (beam width slope thick blot)
 166   (embedded-ps (list 'beam  width slope thick blot)))
 167
 168 (define (bracket arch_angle arch_width arch_height height arch_thick thick)
 169   (embedded-ps (list 'bracket  arch_angle arch_width arch_height height arch_thick thick)))
 170
 171 (define (dashed-slur thick dash l)
 172   (embedded-ps (list 'dashed-slur thick dash `(quote ,l))))
 173
 174 (define (char font i)
 175   (string-append "\\" (font-command font)
 176                  "\\char" (ly:inexact->string i 10) " "))
 177
 178 (define (dashed-line thick on off dx dy)
 179   (embedded-ps (list 'dashed-line  thick on off dx dy)))
 180
 181 (define (zigzag-line centre? zzw zzh thick dx dy)
 182   (embedded-ps (list 'zigzag-line centre? zzw zzh thick dx dy)))
 183
 184 (define (symmetric-x-triangle t w h)
 185   (embedded-ps (list 'symmetric-x-triangle t w h)))
 186
 187 (define (font-load-command bookpaper font)
 188   (string-append
 189    "\\font\\" (font-command font) "="
 190    (ly:font-filename font)
 191    " scaled "
 192    (ly:number->string (inexact->exact
 193                        (round (* 1000
 194                           (ly:font-magnification font)
 195                           (ly:bookpaper-outputscale bookpaper)))))
 196    "\n"))
 197
 198 (define (ez-ball c l b)
 199   (embedded-ps (list 'ez-ball  c  l b)))
 200
 201 (define (header-to-file fn key val)
 202   (set! key (symbol->string key))
 203   (if (not (equal? "-" fn))
 204       (set! fn (string-append fn "." key))
 205       )
 206   (display
 207    (format "writing header field `~a' to `~a'..."
 208            key
 209            (if (equal? "-" fn) "<stdout>" fn)
 210            )
 211    (current-error-port))
 212   (if (equal? fn "-")
 213       (display val)
 214       (display val (open-file fn "w"))
 215   )
 216   (display "\n" (current-error-port))
 217   ""
 218   )
 219
 220 (define (embedded-ps expr)
 221   (let ((ps-string
 222          (with-output-to-string
 223            (lambda () (ps-output-expression expr (current-output-port))))))
 224     (string-append "\\embeddedps{" ps-string "}")))
 225
 226 (define (comment s)
 227   (string-append "% " s "\n"))
 228
 229 (define (end-output)
 230   (begin
 231     ;; uncomment for some stats about lily memory
 232     ;; (display (gc-stats))
 233     (string-append
 234      "\\lilypondend\n"
 235      ;; Put GC stats here.
 236      )))
 237
 238 (define (repeat-slash w a t)
 239   (embedded-ps (list 'repeat-slash  w a t)))
 240
 241 (define (header-end)
 242   (string-append
 243    "\\def\\scaletounit{ "
 244    (number->string (cond
 245                      ((equal? (ly:unit) "mm") (/ 72.0  25.4))
 246                      ((equal? (ly:unit) "pt") (/ 72.0  72.27))
 247                      (else (error "unknown unit" (ly:unit)))
 248                      ))
 249    " mul }%\n"
 250    "\\ifx\\lilypondstart\\undefined\n"
 251    "  \\input lilyponddefs\n"
 252    "\\fi\n"
 253    "\\outputscale = \\lilypondpaperoutputscale\\lilypondpaperunit\n"
 254    "\\lilypondstart\n"
 255    "\\lilypondspecial\n"
 256    "\\lilypondpostscript\n"))
 257
 258 (define (header creator time-stamp bookpaper page-count classic?)
 259   (string-append
 260    "% Generated by " creator "\n"
 261    "% at " time-stamp "\n"
 262    (if classic?
 263        (tex-string-def "lilypond" 'classic "1")
 264        "")
 265    ;; FIXME: duplicated in every backend
 266    "\\def\\lilypondtagline{Engraved by LilyPond (version "
 267    (lilypond-version)")}\n"
 268
 269    ;; FIXME
 270    ;; this is -of course- severely broken, (--hwn)
 271    (tex-string-def  "lilypondpaper" 'linewidth
 272                     (ly:number->string (/ 18 0.175))) ; 18 cm.
 273    (tex-string-def  "lilypondpaper" 'interscoreline
 274                     (ly:number->string 0.0))
 275    ))
 276
 277 (define (output-tex-string s)
 278    (if (ly:get-option 'safe)
 279       (regexp-substitute/global #f "\\\\"
 280                                 (regexp-substitute/global #f "([{}])" "bla{}" 'pre  "\\" 1 'post )
 281                                 'pre "$\\backslash$" 'post)
 282
 283       s))
 284
 285 (define (lily-def key val)
 286   (let ((tex-key
 287          (regexp-substitute/global
 288               #f "_" (output-tex-string key) 'pre "X" 'post))
 289
 290         (tex-val (output-tex-string val)))
 291     (if (equal? (sans-surrounding-whitespace tex-val) "")
 292         (string-append "\\let\\" tex-key "\\undefined\n")
 293         (string-append "\\def\\" tex-key "{" tex-val "}%\n"))))
 294
 295 (define (number->dim x)
 296   (string-append
 297    ;;ugh ly:* in backend needs compatibility func for standalone output
 298    (ly:number->string x) " \\outputscale "))
 299
 300 (define (placebox x y s)
 301   (string-append
 302    "\\lyitem" (number->param x) (number->param y) (string->param s) "%\n"))
 303
 304 (define (bezier-sandwich l thick)
 305   (embedded-ps (list 'bezier-sandwich  `(quote ,l) thick)))
 306
 307 (define (start-system origin dim)
 308   (string-append
 309    "\\leavevmode\n"
 310    "\\lybox" (number-pair->param origin) (number-pair->param dim)
 311   "{%\n"))
 312
 313 (define (stop-system last?)
 314   (if last?
 315       "}%\n"
 316       ;; FIXME: still used by lilypond.py for --preview
 317       "}%\n%\n\\interscoreline\n%\n"))
 318
 319 ;; WTF is this in every backend?
 320 (define (horizontal-line x1 x2 th)
 321   (filledbox (- x1) (- x2 x1) (* .5 th) (* .5 th)))
 322
 323 (define (filledbox breapth width depth height)
 324   (if (and #f (defined? 'ps-testing))
 325       (embedded-ps
 326        (string-append (ly:numbers->string (list breapth width depth height))
 327                       " draw_box" ))
 328       (string-append "\\lyvrule{"
 329                      (ly:number->string (- breapth)) "}{"
 330                      (ly:number->string (+ breapth width)) "}{"
 331                      (ly:number->string depth) "}{"
 332                      (ly:number->string height) "}")))
 333
 334 (define (round-filled-box x y width height blotdiam)
 335   (embedded-ps (list 'round-filled-box  x y width height blotdiam)))
 336
 337 (define (text font s)
 338   (let*
 339       ((mapping #f)       ;; (assoc-get  'char-mapping (ly:font-encoding-alist font))))
 340
 341
 342        ;; TODO: we'd better do this for PS only
 343        ;; LaTeX gets in the way, and we need to remap
 344        ;; nonprintable chars.
 345
 346
 347        (input-enc-name #f) ;; (assoc-get 'input-name (ly:font-encoding-alist font) ))
 348        )
 349
 350     (string-append "\\hbox{\\" (font-command font)
 351                    (if (string? input-enc-name)
 352                        (string-append "\\inputencoding{" input-enc-name "}")
 353                        "{}")
 354                    (output-tex-string
 355                     (if (vector? mapping)
 356                         (reencode-string mapping s)
 357                         s))
 358                    "}")))
 359
 360
 361 (define (tuplet ht gapx dx dy thick dir)
 362   (embedded-ps (list 'tuplet  ht gapx dx dy thick dir)))
 363
 364 (define (polygon points blotdiameter)
 365   (embedded-ps (list 'polygon `(quote ,points) blotdiameter)))
 366
 367 (define (draw-line thick fx fy tx ty)
 368   (embedded-ps (list 'draw-line thick fx fy tx ty)))
 369
 370 (define (define-origin file line col)
 371   (if (procedure? point-and-click)
 372       (string-append "\\special{src:" ;;; \\string ?
 373                      (point-and-click line col file)
 374                      "}" )
 375       ""))
 376
 377 ;; no-origin not yet supported by Xdvi
 378 (define (no-origin) "")
 379
 380 (define (start-page)
 381   "\n\\vbox to 0pt{\n")
 382
 383 (define (stop-page last?)
 384   (if last?
 385       "\\vss\n}\n\\vfill\n"
 386       "\\vss\n}\n\\vfill\\lilypondpagebreak\n"))