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
  11 ;; The public interface is tight.
  12 ;; It has to be, because user-code is evalled with this module.
  13
  14 ;; ***It should also be clean, well defined, documented and reviewed***
  15
  16 ;; To be reasonably safe, you probably do not want to use the TeX
  17 ;; backend anyway, but rather the PostScript backend.  You may want
  18 ;; to run gs in a uml sandbox too.
  19
  20
  21 (define-module (scm output-tex)
  22   #:re-export (quote)
  23
  24   ;; JUNK this -- see lily.scm: ly:all-output-backend-commands
  25   #:export (unknown
  26              blank
  27              dot
  28              white-dot
  29              beam
  30              bracket
  31              dashed-slur
  32              named-glyph
  33              dashed-line
  34              zigzag-line
  35              ez-ball
  36              comment
  37              repeat-slash
  38              placebox
  39              bezier-sandwich
  40              horizontal-line
  41              filledbox
  42              round-filled-box
  43              text
  44              white-text
  45              polygon
  46              draw-line
  47              no-origin
  48              grob-cause
  49              ))
  50
  51 (use-modules (ice-9 regex)
  52              (ice-9 string-fun)
  53              (ice-9 format)
  54              (guile)
  55              (srfi srfi-13)
  56              (scm framework-tex)
  57              (lily))
  58
  59
  60
  61 ;;;;;;;;
  62 ;;;;;;;; DOCUMENT ME!
  63 ;;;;;;;;
  64
  65
  66 (define (char font i)
  67   (string-append "\\" (tex-font-command font)
  68                  "\\char" (ly:inexact->string i 10) " "))
  69
  70 (define (unknown)
  71   "%\n\\unknown\n")
  72
  73
  74
  75 (define (blank)
  76   "")
  77
  78 (define (dot x y radius)
  79   (embedded-ps (list 'dot x y radius)))
  80
  81
  82 (define (embedded-ps string)
  83   (embedded-ps (list 'embedded-ps string)))
  84
  85 (define (white-dot x y radius)
  86   (embedded-ps (list 'white-dot x y radius)))
  87
  88 (define (beam width slope thick blot)
  89   (embedded-ps (list 'beam  width slope thick blot)))
  90
  91 (define (bracket arch_angle arch_width arch_height height arch_thick thick)
  92   (embedded-ps (list 'bracket  arch_angle arch_width arch_height height arch_thick thick)))
  93
  94 (define (dashed-slur thick dash l)
  95   (embedded-ps (list 'dashed-slur thick dash `(quote ,l))))
  96
  97 (define (named-glyph font name)
  98   (let* ((info (ly:otf-font-glyph-info font name))
  99          (subfont (assoc-get 'subfont info))
 100          (subidx  (assoc-get 'subfont-index info)))
 101
 102     ;;(stderr "INFO: ~S\n" info)
 103     ;;(stderr "FONT: ~S\n" font)
 104     (if (and subfont subidx)
 105         (string-append "\\" (tex-font-command-raw
 106                              subfont
 107                              (ly:font-magnification font))
 108                        "\\char" (number->string subidx))
 109
 110         (begin
 111           (ly:warn "Can't find ~a in ~a" name font)
 112           ""))
 113         ))
 114
 115 (define (dashed-line thick on off dx dy)
 116   (embedded-ps (list 'dashed-line  thick on off dx dy)))
 117
 118 (define (zigzag-line centre? zzw zzh thick dx dy)
 119   (embedded-ps (list 'zigzag-line centre? zzw zzh thick dx dy)))
 120
 121 (define (ez-ball c l b)
 122   (embedded-ps (list 'ez-ball c l b)))
 123
 124 (define (embedded-ps expr)
 125   (let ((ps-string
 126          (with-output-to-string
 127            (lambda () (ps-output-expression expr (current-output-port))))))
 128     (string-append "\\embeddedps{" ps-string "}")))
 129
 130 (define (repeat-slash w a t)
 131   (embedded-ps (list 'repeat-slash  w a t)))
 132
 133 (define (number->dim x)
 134   (string-append
 135    ;;ugh ly:* in backend needs compatibility func for standalone output
 136    (ly:number->string x) " \\outputscale "))
 137
 138 (define (placebox x y s)
 139   (string-append
 140    "\\lyitem{" (ly:number->string x) "}{" (ly:number->string y) "}{" s "}%\n"))
 141
 142 (define (bezier-sandwich l thick)
 143   (embedded-ps (list 'bezier-sandwich  `(quote ,l) thick)))
 144
 145 ;; WTF is this in every backend?
 146 (define (horizontal-line x1 x2 th)
 147   (filledbox (- x1) (- x2 x1) (* .5 th) (* .5 th)))
 148
 149 (define (filledbox breapth width depth height)
 150   (if (and #f (defined? 'ps-testing))
 151       (embedded-ps
 152        (string-append (ly:numbers->string (list breapth width depth height))
 153                       " draw_box" ))
 154       (string-append "\\lyvrule{"
 155                      (ly:number->string (- breapth)) "}{"
 156                      (ly:number->string (+ breapth width)) "}{"
 157                      (ly:number->string depth) "}{"
 158                      (ly:number->string height) "}")))
 159
 160 (define (round-filled-box x y width height blotdiam)
 161   (embedded-ps (list 'round-filled-box  x y width height blotdiam)))
 162
 163 (define (text font s)
 164   (let*
 165       ((mapping #f)       ;; (assoc-get  'char-mapping (ly:font-encoding-alist font))))
 166
 167
 168        ;; TODO: we'd better do this for PS only
 169        ;; LaTeX gets in the way, and we need to remap
 170        ;; nonprintable chars.
 171
 172        (input-enc-name #f) ;; (assoc-get 'input-name (ly:font-encoding-alist font) ))
 173        )
 174
 175     (string-append "\\hbox{\\" (tex-font-command font)
 176                    (if (string? input-enc-name)
 177                        (string-append "\\inputencoding{" input-enc-name "}")
 178                        "{}")
 179                    (sanitize-tex-string
 180                     (if (vector? mapping)
 181                         (reencode-string mapping s)
 182                         s))
 183                    "}")))
 184
 185 (define (white-text scale s)
 186    (embedded-ps (list 'white-text scale s)))
 187
 188 (define (polygon points blotdiameter)
 189   (embedded-ps (list 'polygon `(quote ,points) blotdiameter)))
 190
 191 (define (draw-line thick fx fy tx ty)
 192   (embedded-ps (list 'draw-line thick fx fy tx ty)))
 193
 194 ;; no-origin not yet supported by Xdvi
 195 (define (no-origin) "")
 196
 197 (define (grob-cause grob)
 198   (if (procedure? point-and-click)
 199       (let* ((cause (ly:grob-property grob 'cause))
 200              (music-origin (if (ly:music? cause)
 201                                (ly:music-property cause 'origin)))
 202              (location (if (ly:input-location? music-origin)
 203                            (ly:input-location music-origin))))
 204         (if (pair? location)
 205              ;;; \\string ?
 206             (string-append "\\special{src:"
 207                            (apply point-and-click location) "}")
 208             ""))
 209       ""))