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--2005 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 (use-modules (ice-9 regex)
  51              (ice-9 string-fun)
  52              (ice-9 format)
  53              (guile)
  54              (srfi srfi-13)
  55              (scm framework-tex)
  56              (lily))
  57
  58
  59
  60 ;;;;;;;;
  61 ;;;;;;;; DOCUMENT ME!
  62 ;;;;;;;;
  63
  64
  65 (define (char font i)
  66   (string-append "\\" (tex-font-command font)
  67                  "\\char" (ly:inexact->string i 10) " "))
  68
  69 (define (unknown)
  70   "%\n\\unknown\n")
  71
  72 (define (url-link url x y)
  73   "")
  74
  75
  76 (define (blank)
  77   "")
  78
  79 (define (dot x y radius)
  80   (embedded-ps (list 'dot x y radius)))
  81
  82
  83 (define (embedded-ps string)
  84   (embedded-ps (list 'embedded-ps string)))
  85
  86 (define (white-dot x y radius)
  87   (embedded-ps (list 'white-dot x y radius)))
  88
  89 (define (beam width slope thick blot)
  90   (embedded-ps (list 'beam  width slope thick blot)))
  91
  92 (define (bracket arch_angle arch_width arch_height height arch_thick thick)
  93   (embedded-ps (list 'bracket  arch_angle arch_width arch_height height arch_thick thick)))
  94
  95 (define (dashed-slur thick on off lst)
  96   (embedded-ps (list 'dashed-slur thick on off `(quote ,lst))))
  97
  98 (define (named-glyph font name)
  99   (let* ((info (ly:otf-font-glyph-info font name))
 100          (subfont (assoc-get 'subfont info))
 101          (subidx  (assoc-get 'subfont-index info)))
 102
 103     ;;(stderr "INFO: ~S\n" info)
 104     ;;(stderr "FONT: ~S\n" font)
 105     (if (and subfont subidx)
 106         (string-append "\\" (tex-font-command-raw
 107                              subfont
 108                              (ly:font-magnification font))
 109                        "\\char" (number->string subidx))
 110
 111         (begin
 112           (ly:warn "Can't find ~a in ~a" name font)
 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 lst b)
 122   (embedded-ps (list 'ez-ball c lst 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 lst thick)
 143   (embedded-ps (list 'bezier-sandwich `(quote ,lst) 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   (format
 165    "\\hbox{\\~a{}~a}" (tex-font-command font)
 166    (sanitize-tex-string s)))
 167
 168 (define (white-text scale s)
 169   (embedded-ps (list 'white-text scale s)))
 170
 171 (define (polygon points blotdiameter)
 172   (embedded-ps (list 'polygon `(quote ,points) blotdiameter)))
 173
 174 (define (draw-line thick fx fy tx ty)
 175   (embedded-ps (list 'draw-line thick fx fy tx ty)))
 176
 177 ;; no-origin not yet supported by Xdvi
 178 (define (no-origin) "")
 179
 180 (define (grob-cause offset grob)
 181   (if (procedure? point-and-click)
 182       (let* ((cause (ly:grob-property grob 'cause))
 183              (music-origin (if (ly:music? cause)
 184                                (ly:music-property cause 'origin)))
 185              (location (if (ly:input-location? music-origin)
 186                            (ly:input-file-line-column music-origin))))
 187         (if (pair? location)
 188              ;;; \\string ?
 189             (string-append "\\special{src:"
 190                            (apply point-and-click location) "}")
 191             ""))
 192       ""))