scm/paper.scm

   1 ;;;; paper.scm -- manipulate the paper block.
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7
   8 (define-public (paper-set-staff-size sz)
   9   "Function to be called inside a \\paper{} block to set the staff size."
  10   (let* ((m (current-module))
  11          (ss (/ sz 4))
  12          (pt (eval 'pt m))
  13
  14
  15          ;; linear interpolation.
  16          (x1 (* 4.125 pt))
  17          (x0 (* 5 pt))
  18          (f1 (* 0.47 pt))
  19          (f0 (* 0.50 pt))
  20          (lt (/
  21               (+
  22                (* f1 (- ss x0))
  23                (* f0 (- x1 ss)))
  24               (- x1 x0)))
  25
  26          (mm (eval 'mm m)))
  27
  28     (module-define! m 'outputscale ss)
  29     (module-define! m 'fonts (make-cmr-tree (/  sz (* 20 pt))))
  30     (module-define! m 'staffheight sz)
  31     (module-define! m 'staff-space ss)
  32     (module-define! m 'staffspace ss)
  33
  34     ;; !! synchronize with feta-params.mf
  35     (module-define! m 'linethickness lt)
  36     (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
  37     (module-define! m 'blotdiameter (* 0.35 pt))
  38     (module-define! m 'interscoreline (* 4 mm))
  39
  40     (module-define! m 'dimension-variables
  41                     '(pt mm cm in staffheight staff-space
  42                          linewidth indent hsize vsize
  43                          staffspace linethickness ledgerlinethickness
  44                          blotdiameter interscoreline leftmargin rightmargin))
  45     ))
  46
  47 (define-public (set-global-staff-size sz)
  48   "Set the default staff size, where SZ is thought to be in PT."
  49   (let* ((old-mod (current-module))
  50          (pap (eval '$defaultbookpaper old-mod))
  51          (in-paper? (or (module-defined? old-mod 'is-bookpaper)
  52                         (module-defined? old-mod 'is-paper)))
  53
  54          ; maybe not necessary.
  55          ; but let's be paranoid. Maybe someone still refers to the
  56          ; old one.
  57          (new-paper (ly:output-def-clone pap))
  58
  59          (new-scope (ly:output-def-scope new-paper)))
  60
  61     (if in-paper?
  62         (ly:warn "Not in toplevel scope"))
  63     (set-current-module new-scope)
  64     (paper-set-staff-size (* sz (eval 'pt new-scope)))
  65     (set-current-module old-mod)
  66     (module-define! old-mod '$defaultbookpaper new-paper)))
  67
  68 (define paper-alist
  69   '(("a6" . (cons (* 105 mm) (* 148.95 mm)))
  70     ("a5" . (cons (* 148.95 mm) (* 210 mm)))
  71     ("a4" . (cons (* 210 mm) (* 297.9 mm)))
  72     ("a3" . (cons (* 297.9 mm) (* 420 mm)))
  73     ("legal" . (cons (* 8.5 in) (* 14.0 in)))
  74     ("letter" . (cons (* 8.5 in) (* 11.0 in)))
  75     ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
  76
  77 ;; todo: take dimension arguments.
  78
  79 (define (set-paper-dimensions m w h)
  80   "M is a module (i.e. paper->scope_ )"
  81   (let* ((mm (eval 'mm m)))
  82     (module-define! m 'hsize w)
  83     (module-define! m 'vsize h)
  84     (module-define! m 'linewidth (- w (* 20 mm)))
  85     (module-define! m 'indent (/ w 14))
  86
  87     ;; page layout - what to do with (printer specific!) margin settings?
  88     (module-define! m 'topmargin (* 5 mm))
  89     (module-define! m 'bottommargin (* 6 mm))
  90     (module-define! m 'headsep (* 4 mm))
  91     (module-define! m 'footsep (* 4 mm))
  92     (module-define! m 'leftmargin #f)
  93     (module-define! m 'rightmargin (* 10 mm))))
  94
  95 (define (internal-set-paper-size module name)
  96   (let* ((entry (assoc name paper-alist))
  97          (is-bookpaper? (module-defined? module 'is-bookpaper))
  98          (mm (eval 'mm module)))
  99
 100     (cond
 101      ((not is-bookpaper?)
 102       (ly:warning "This is not a \\paper {} object, ~S"
 103                    module))
 104      ((pair? entry)
 105       (set! entry (eval  (cdr entry) module))
 106           (set-paper-dimensions module (car entry) (cdr entry))
 107           (module-define! module 'papersize name)
 108           (module-define! module 'papersizename name)
 109           (set-paper-dimensions module (car entry) (cdr entry)))
 110      (else
 111       (ly:warn (string-append "Unknown papersize: " name))))
 112
 113     ))
 114
 115 (define-public (set-default-paper-size name)
 116   (internal-set-paper-size (ly:output-def-scope (eval '$defaultbookpaper (current-module)))
 117                            name))
 118
 119 (define-public (set-paper-size name)
 120   (if (module-defined? (current-module) 'is-paper)
 121       (internal-set-paper-size (current-module) name)
 122
 123       ;;; TODO: should raise (generic) exception with throw, and catch
 124       ;;; that in parse-scm.cc
 125       (ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))
 126
 127 (define-public (scale-paper pap scale)
 128   (let*
 129       ((new-pap (ly:output-def-clone pap))
 130        (dim-vars (ly:output-def-lookup pap 'dimension-variables))
 131        (scope (ly:output-def-scope new-pap)))
 132
 133     (for-each
 134      (lambda (v)
 135        (define val (ly:output-def-lookup pap v))
 136        (if (number? val)
 137            (module-define! scope v
 138                            (/ val scale))
 139
 140            ;; spurious warnings, eg. for hsize, vsize.
 141 ;          (ly:warn "not a number, ~S = ~S " v  val)
 142            ))
 143
 144      dim-vars)
 145
 146     new-pap
 147   ))