1 ;;;; paper.scm -- manipulate the paper and layout block.
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2006 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 staff-height staff-space
11 between-system-space between-system-padding
12 line-width indent paper-width paper-height horizontal-shift
13 staff-space line-thickness ledgerline-thickness
14 blot-diameter left-margin right-margin)))
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 'output-scale ss)
39 (module-define! m 'fonts
41 (make-cmr-tree (/ sz (* 20 pt)))
42 (make-century-schoolbook-tree
44 (module-define! m 'staff-height sz)
45 (module-define! m 'staff-space ss)
46 (module-define! m 'staff-space ss)
48 ;; !! synchronize with feta-params.mf
49 (module-define! m 'line-thickness lt)
50 (module-define! m 'ledgerline-thickness (+ (* 0.5 pt) (/ ss 10)))
51 (module-define! m 'blot-diameter (* 0.4 pt))
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
77 ;; don't use decimals.
78 ;; ISO 216 has a tolerance of +- 2mm
80 '(("a7" . (cons (* 74 mm) (* 105 mm)))
81 ("a6" . (cons (* 105 mm) (* 149 mm)))
82 ("a5" . (cons (* 149 mm) (* 210 mm)))
83 ("a4" . (cons (* 210 mm) (* 298 mm)))
84 ("a3" . (cons (* 298 mm) (* 420 mm)))
85 ("legal" . (cons (* 8.5 in) (* 14.0 in)))
86 ("letter" . (cons (* 8.5 in) (* 11.0 in)))
87 ("11x17" . (cons (* 11.0 in) (* 17.0 in)))
90 ;; todo: take dimension arguments.
92 (define (set-paper-dimensions m w h)
93 "M is a module (i.e. layout->scope_ )"
94 (let* ((mm (eval 'mm m)))
95 (module-define! m 'paper-width w)
96 (module-define! m 'paper-height h)
97 (module-define! m 'line-width (- w (* 20 mm)))
98 (module-define! m 'indent (/ w 14))
100 ;; page layout - what to do with (printer specific!) margin settings?
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)
123 (module-define! module 'landscape
124 (if landscape? #t #f)))
126 (ly:warning (_ "Unknown papersize: ~a" name))))))
128 (define-safe-public (set-default-paper-size name . rest)
129 (internal-set-paper-size
130 (ly:output-def-scope (eval '$defaultpaper (current-module)))
132 (memq 'landscape rest)))
134 (define-public (set-paper-size name . rest)
135 (if (module-defined? (current-module) 'is-paper)
136 (internal-set-paper-size (current-module) name
137 (memq 'landscape rest))
139 ;;; TODO: should raise (generic) exception with throw, and catch
140 ;;; that in parse-scm.cc
141 (ly:warning (_ "Must use #(set-paper-size .. ) within \\paper { ... }"))))
143 (define-public (scale-layout pap scale)
144 (let* ((new-pap (ly:output-def-clone pap))
145 (dim-vars (ly:output-def-lookup pap 'dimension-variables))
146 (old-scope (ly:output-def-scope pap))
147 (scope (ly:output-def-scope new-pap)))
151 (let* ((var (module-variable old-scope v))
152 (val (if (variable? var) (variable-ref var) #f)))
155 (module-define! scope v
158 ;; spurious warnings, eg. for paper-width, paper-height.
159 ;; (ly:warning (_ "not a number, ~S = ~S " v val))