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 'text-font-size (* 12 (/ sz (* 20 pt))))
  36
  37     (module-define! m 'outputscale ss)
  38     (module-define! m 'fonts (make-cmr-tree (/  sz (* 20 pt))))
  39     (module-define! m 'staffheight sz)
  40     (module-define! m 'staff-space ss)
  41     (module-define! m 'staffspace ss)
  42
  43     ;; !! synchronize with feta-params.mf
  44     (module-define! m 'linethickness lt)
  45     (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
  46     (module-define! m 'blotdiameter (* 0.35 pt))
  47     (module-define! m 'interscoreline (* 4 mm))))
  48
  49 (define-public (set-global-staff-size sz)
  50   "Set the default staff size, where SZ is thought to be in PT."
  51   (let* ((old-mod (current-module))
  52          (pap (eval '$defaultpaper old-mod))
  53          (in-layout? (or (module-defined? old-mod 'is-paper)
  54                          (module-defined? old-mod 'is-layout)))
  55
  56          ; maybe not necessary.
  57          ; but let's be paranoid. Maybe someone still refers to the
  58          ; old one.
  59          (new-paper (ly:output-def-clone pap))
  60
  61          (new-scope (ly:output-def-scope new-paper)))
  62
  63     (if in-layout?
  64         (ly:warn "Not in toplevel scope"))
  65     (set-current-module new-scope)
  66     (layout-set-staff-size (* sz (eval 'pt new-scope)))
  67     (set-current-module old-mod)
  68     (module-define! old-mod '$defaultpaper new-paper)))
  69
  70 (define-public paper-alist
  71   '(("a6" . (cons (* 105 mm) (* 148.95 mm)))
  72     ("a5" . (cons (* 148.95 mm) (* 210 mm)))
  73     ("a4" . (cons (* 210 mm) (* 297.9 mm)))
  74     ("a3" . (cons (* 297.9 mm) (* 420 mm)))
  75     ("legal" . (cons (* 8.5 in) (* 14.0 in)))
  76     ("letter" . (cons (* 8.5 in) (* 11.0 in)))
  77     ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
  78
  79 ;; todo: take dimension arguments.
  80
  81 (define (set-paper-dimensions m w h)
  82   "M is a module (i.e. layout->scope_ )"
  83   (let* ((mm (eval 'mm m)))
  84     (module-define! m 'hsize w)
  85     (module-define! m 'vsize h)
  86     (module-define! m 'linewidth (- w (* 20 mm)))
  87     (module-define! m 'indent (/ w 14))
  88
  89     ;; page layout - what to do with (printer specific!) margin settings?
  90     (module-define! m 'topmargin (* 5 mm))
  91     (module-define! m 'bottommargin (* 6 mm))
  92     (module-define! m 'headsep (* 4 mm))
  93     (module-define! m 'footsep (* 4 mm))
  94     (module-define! m 'leftmargin #f)
  95     (module-define! m 'firstpagenumber 1)
  96     (module-define! m 'printfirstpagenumber #f)
  97     (module-define! m 'rightmargin (* 10 mm))))
  98
  99 (define (internal-set-paper-size module name landscape?)
 100   (define (swap x)
 101     (cons (cdr x) (car x)))
 102
 103   (let* ((entry (assoc name paper-alist))
 104          (is-paper? (module-defined? module 'is-paper))
 105          (mm (eval 'mm module)))
 106
 107     (cond
 108      ((not is-paper?)
 109       (ly:warning "This is not a \\layout {} object, ~S"
 110                    module))
 111      ((pair? entry)
 112
 113       (set! entry (eval (cdr entry) module))
 114       (if landscape?
 115           (set! entry (swap entry)))
 116       (set-paper-dimensions module (car entry) (cdr entry))
 117
 118       (module-define! module 'papersizename name)
 119
 120       (if landscape?
 121           (module-define! module 'landscape #t)))
 122      (else
 123       (ly:warn (string-append "Unknown papersize: " name))))))
 124
 125 (define-public (set-default-paper-size name . rest)
 126   (internal-set-paper-size
 127    (ly:output-def-scope (eval '$defaultpaper (current-module)))
 128    name
 129    (memq 'landscape rest)))
 130
 131 (define-public (set-paper-size name . rest)
 132   (if (module-defined? (current-module) 'is-paper)
 133       (internal-set-paper-size (current-module) name
 134                                (memq 'landscape rest))
 135
 136       ;;; TODO: should raise (generic) exception with throw, and catch
 137       ;;; that in parse-scm.cc
 138       (ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))
 139
 140 (define-public (scale-layout pap scale)
 141   (let* ((new-pap (ly:output-def-clone pap))
 142          (dim-vars (ly:output-def-lookup pap 'dimension-variables))
 143          (old-scope (ly:output-def-scope pap))
 144          (scope (ly:output-def-scope new-pap)))
 145
 146     (for-each
 147      (lambda (v)
 148        (let* ((var (module-variable old-scope v))
 149               (val (if (variable? var) (variable-ref var) #f)))
 150
 151          (if (number? val)
 152              (module-define! scope v
 153                              (/ val scale))
 154
 155              ;; spurious warnings, eg. for hsize, vsize.
 156              ;; (ly:warn "not a number, ~S = ~S " v  val)
 157              )))
 158
 159      dim-vars)
 160
 161     new-pap))