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