1 ;;;; paper.scm -- manipulate the paper and layout block.
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 (define-public (set-paper-dimension-variables mod)
8 (module-define! mod 'dimension-variables
9 '(pt mm cm in staffheight staff-space
11 betweensystemspace betweensystempadding
12 linewidth indent hsize vsize horizontalshift
13 staffspace linethickness ledgerlinethickness
14 blotdiameter interscoreline leftmargin rightmargin)))
16 (define-public (layout-set-staff-size sz)
17 "Function to be called inside a \\layout{} block to set the staff size."
18 (let* ((m (current-module))
23 ;; linear interpolation.
36 (module-define! m 'text-font-size (* 12 (/ sz (* 20 pt))))
38 (module-define! m 'outputscale ss)
39 (module-define! m 'fonts
41 (make-cmr-tree (/ sz (* 20 pt)))
42 (make-century-schoolbook-tree
44 (module-define! m 'staffheight sz)
45 (module-define! m 'staff-space ss)
46 (module-define! m 'staffspace ss)
48 ;; !! synchronize with feta-params.mf
49 (module-define! m 'linethickness lt)
50 (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
51 (module-define! m 'blotdiameter (* 0.4 pt))
52 (module-define! m 'interscoreline (* 4 mm))))
54 (define-safe-public (set-global-staff-size sz)
55 "Set the default staff size, where SZ is thought to be in PT."
56 (let* ((old-mod (current-module))
57 (pap (eval '$defaultpaper old-mod))
58 (in-layout? (or (module-defined? old-mod 'is-paper)
59 (module-defined? old-mod 'is-layout)))
61 ; maybe not necessary.
62 ; but let's be paranoid. Maybe someone still refers to the
64 (new-paper (ly:output-def-clone pap))
66 (new-scope (ly:output-def-scope new-paper)))
69 (ly:warning (_ "Not in toplevel scope")))
70 (set-current-module new-scope)
71 (layout-set-staff-size (* sz (eval 'pt new-scope)))
72 (set-current-module old-mod)
73 (module-define! old-mod '$defaultpaper new-paper)))
75 (define-public paper-alist
76 '(("a6" . (cons (* 105 mm) (* 148.95 mm)))
77 ("a5" . (cons (* 148.95 mm) (* 210 mm)))
78 ("a4" . (cons (* 210 mm) (* 297.9 mm)))
79 ("a3" . (cons (* 297.9 mm) (* 420 mm)))
80 ("legal" . (cons (* 8.5 in) (* 14.0 in)))
81 ("letter" . (cons (* 8.5 in) (* 11.0 in)))
82 ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
84 ;; todo: take dimension arguments.
86 (define (set-paper-dimensions m w h)
87 "M is a module (i.e. layout->scope_ )"
88 (let* ((mm (eval 'mm m)))
89 (module-define! m 'hsize w)
90 (module-define! m 'vsize h)
91 (module-define! m 'linewidth (- w (* 20 mm)))
92 (module-define! m 'indent (/ w 14))
94 ;; page layout - what to do with (printer specific!) margin settings?
95 (module-define! m 'topmargin (* 5 mm))
96 (module-define! m 'bottommargin (* 6 mm))
97 (module-define! m 'headsep (* 4 mm))
98 (module-define! m 'footsep (* 4 mm))
99 (module-define! m 'leftmargin #f)
100 (module-define! m 'firstpagenumber 1)
101 (module-define! m 'printfirstpagenumber #f)
102 (module-define! m 'rightmargin (* 10 mm))))
104 (define (internal-set-paper-size module name landscape?)
106 (cons (cdr x) (car x)))
108 (let* ((entry (assoc name paper-alist))
109 (is-paper? (module-defined? module 'is-paper))
110 (mm (eval 'mm module)))
114 (ly:warning (_ "This is not a \\layout {} object, ~S" module)))
117 (set! entry (eval (cdr entry) module))
119 (set! entry (swap entry)))
120 (set-paper-dimensions module (car entry) (cdr entry))
122 (module-define! module 'papersizename name)
125 (module-define! module 'landscape #t)))
127 (ly:warning (_ ("Unknown papersize: ~a" name)))))))
129 (define-safe-public (set-default-paper-size name . rest)
130 (internal-set-paper-size
131 (ly:output-def-scope (eval '$defaultpaper (current-module)))
133 (memq 'landscape rest)))
135 (define-public (set-paper-size name . rest)
136 (if (module-defined? (current-module) 'is-paper)
137 (internal-set-paper-size (current-module) name
138 (memq 'landscape rest))
140 ;;; TODO: should raise (generic) exception with throw, and catch
141 ;;; that in parse-scm.cc
142 (ly:warning (_ "Must use #(set-paper-size .. ) within \\paper { ... }"))))
144 (define-public (scale-layout pap scale)
145 (let* ((new-pap (ly:output-def-clone pap))
146 (dim-vars (ly:output-def-lookup pap 'dimension-variables))
147 (old-scope (ly:output-def-scope pap))
148 (scope (ly:output-def-scope new-pap)))
152 (let* ((var (module-variable old-scope v))
153 (val (if (variable? var) (variable-ref var) #f)))
156 (module-define! scope v
159 ;; spurious warnings, eg. for hsize, vsize.
160 ;; (ly:warning (_ "not a number, ~S = ~S " v val))