scm/paper.scm

   1 ;;;; paper.scm -- manipulate the paper and layout block.
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7 (define-public (set-paper-dimension-variables mod)
   8   (module-define! mod 'dimension-variables
   9                   '(pt mm cm in staffheight staff-space
  10                        betweensystemspace betweensystempadding
  11                        linewidth indent hsize vsize
  12                        staffspace linethickness ledgerlinethickness
  13                        blotdiameter interscoreline leftmargin rightmargin)))
  14
  15 (define-public (layout-set-staff-size sz)
  16   "Function to be called inside a \\layout{} block to set the staff size."
  17   (let* ((m (current-module))
  18          (ss (/ sz 4))
  19          (pt (eval 'pt m))
  20
  21
  22          ;; linear interpolation.
  23          (x1 (* 4.125 pt))
  24          (x0 (* 5 pt))
  25          (f1 (* 0.47 pt))
  26          (f0 (* 0.50 pt))
  27          (lt (/
  28               (+
  29                (* f1 (- ss x0))
  30                (* f0 (- x1 ss)))
  31               (- x1 x0)))
  32
  33          (mm (eval 'mm m)))
  34
  35     (module-define! m 'outputscale ss)
  36     (module-define! m 'fonts (make-cmr-tree (/  sz (* 20 pt))))
  37     (module-define! m 'staffheight sz)
  38     (module-define! m 'staff-space ss)
  39     (module-define! m 'staffspace ss)
  40
  41     ;; !! synchronize with feta-params.mf
  42     (module-define! m 'linethickness lt)
  43     (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
  44     (module-define! m 'blotdiameter (* 0.35 pt))
  45     (module-define! m 'interscoreline (* 4 mm))))
  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 '$defaultpaper old-mod))
  51          (in-layout? (or (module-defined? old-mod 'is-paper)
  52                          (module-defined? old-mod 'is-layout)))
  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-layout?
  62         (ly:warn "Not in toplevel scope"))
  63     (set-current-module new-scope)
  64     (layout-set-staff-size (* sz (eval 'pt new-scope)))
  65     (set-current-module old-mod)
  66     (module-define! old-mod '$defaultpaper 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. layout->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 'firstpagenumber 1)
  94     (module-define! m 'printfirstpagenumber #f)
  95     (module-define! m 'rightmargin (* 10 mm))))
  96
  97 (define (internal-set-paper-size module name landscape?)
  98   (define (swap x)
  99     (cons (cdr x) (car x)))
 100
 101   (let* ((entry (assoc name paper-alist))
 102          (is-paper? (module-defined? module 'is-paper))
 103          (mm (eval 'mm module)))
 104
 105     (cond
 106      ((not is-paper?)
 107       (ly:warning "This is not a \\layout {} object, ~S"
 108                    module))
 109      ((pair? entry)
 110
 111       (set! entry (eval (cdr entry) module))
 112       (if landscape?
 113           (set! entry (swap entry)))
 114       (set-paper-dimensions module (car entry) (cdr entry))
 115
 116
 117       (module-define! module 'papersize name)
 118
 119       ;; FIXME: if this name-play is on purpose, please document.  Why
 120       ;; is it not used troughout?  Should this be removed, or
 121       ;; should 'papersize be removed?
 122
 123       ;; setting \paper{ papersize = "a6" } gives funny results.
 124
 125       (module-define! module 'papersizename name)
 126
 127       (if landscape?
 128           (module-define! module 'landscape #t)))
 129      (else
 130       (ly:warn (string-append "Unknown papersize: " name))))))
 131
 132 (define-public (set-default-paper-size name . rest)
 133   (internal-set-paper-size
 134    (ly:output-def-scope (eval '$defaultpaper (current-module)))
 135    name
 136    (memq 'landscape rest)))
 137
 138 (define-public (set-paper-size name . rest)
 139   (if (module-defined? (current-module) 'is-paper)
 140       (internal-set-paper-size (current-module) name
 141                                (memq 'landscape rest))
 142
 143       ;;; TODO: should raise (generic) exception with throw, and catch
 144       ;;; that in parse-scm.cc
 145       (ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))
 146
 147 (define-public (scale-layout pap scale)
 148   (let* ((new-pap (ly:output-def-clone pap))
 149          (dim-vars (ly:output-def-lookup pap 'dimension-variables))
 150          (old-scope (ly:output-def-scope pap))
 151          (scope (ly:output-def-scope new-pap)))
 152
 153     (for-each
 154      (lambda (v)
 155        (let* ((var (module-variable old-scope v))
 156               (val (if (variable? var) (variable-ref var) #f)))
 157
 158          (if (number? val)
 159              (module-define! scope v
 160                              (/ val scale))
 161
 162              ;; spurious warnings, eg. for hsize, vsize.
 163              ;; (ly:warn "not a number, ~S = ~S " v  val)
 164              )))
 165
 166      dim-vars)
 167
 168     new-pap))