1 ;;;; paper.scm -- manipulate the paper block.
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 (define-public (paper-set-staff-size sz)
9 "Function to be called inside a \\paper{} block to set the staff size."
10 (let* ((m (current-module))
15 (module-define! m 'fonts (make-cmr-tree (/ sz (* 20 pt))))
16 (module-define! m 'staffheight sz)
17 (module-define! m 'staff-space ss)
18 (module-define! m 'staffspace ss)
21 ;; !! synchronize with feta-params.mf
22 (module-define! m 'linethickness (+ (* 0.3 pt) (* 0.04 ss)))
23 (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
24 (module-define! m 'blotdiameter (* 0.35 pt))
25 (module-define! m 'interscoreline (* 4 mm))
27 (module-define! m 'dimension-variables
28 '(pt mm cm in staffheight staff-space
29 linewidth indent hsize vsize
30 staffspace linethickness ledgerlinethickness
31 blotdiameter interscoreline))
34 (define-public (set-global-staff-size sz)
35 "Set the default staff size, where SZ is thought to be in PT."
36 (let* ((old-mod (current-module))
37 (pap (eval '$defaultpaper old-mod))
38 (is-paper? (module-defined? old-mod '$defaultpaper))
41 ;; Huh? Why is it necessary to clone object?
42 (new-paper (ly:output-def-clone pap))
43 (new-scope (ly:output-def-scope new-paper)))
45 (ly:warn "Not in toplevel scope"))
46 (set-current-module new-scope)
47 (paper-set-staff-size (* sz (eval 'pt new-scope)))
48 (set-current-module old-mod)
49 (module-define! old-mod '$defaultpaper new-paper)))
52 '(("a6" . (cons (* 105 mm) (* 148.95 mm)))
53 ("a5" . (cons (* 148.95 mm) (* 210 mm)))
54 ("a4" . (cons (* 210 mm) (* 297.9 mm)))
55 ("a3" . (cons (* 297.9 mm) (* 420 mm)))
56 ("legal" . (cons (* 8.5 in) (* 14.0 in)))
57 ("letter" . (cons (* 8.5 in) (* 11.0 in)))
58 ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
60 ;; todo: take dimension arguments.
62 (define (set-paper-dimensions m w h)
63 "M is a module (i.e. paper->scope_ )"
64 (let* ((mm (eval 'mm m)))
65 (module-define! m 'hsize w)
66 (module-define! m 'vsize h)
67 (module-define! m 'linewidth (- w (* 20 mm)))
68 (module-define! m 'indent (/ w 14))
70 ;; page layout - what to do with (printer specific!) margin settings?
71 (module-define! m 'top-margin (* 5 mm))
72 (module-define! m 'bottom-margin (* 6 mm))
73 (module-define! m 'head-sep (* 4 mm))
74 (module-define! m 'foot-sep (* 4 mm))))
78 (define (internal-set-paper-size module name)
79 (let* ((entry (assoc name paper-alist))
80 (is-paper? (module-defined? module '$is-paper))
81 (mm (eval 'mm module)))
85 (ly:warning "This is not a \\paper {} object:")
88 (set! entry (eval (cdr entry) module))
89 (set-paper-dimensions module (car entry) (cdr entry))
90 (module-define! module 'papersize name)
91 (module-define! module 'papersizename name)
92 (set-paper-dimensions module (car entry) (cdr entry)))
94 (ly:warn (string-append "Unknown papersize: " name))))
98 (define-public (set-default-paper-size name)
99 (internal-set-paper-size (ly:output-def-scope (eval '$defaultpaper (current-module)))
102 (define-public (set-paper-size name)
103 (if (module-defined? (current-module) '$is-paper)
104 (internal-set-paper-size (current-module) name)
106 ;;; TODO: should raise (generic) exception with throw, and catch
107 ;;; that in parse-scm.cc
108 (ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))
110 (define-public (scale-paper pap bookpap)
112 ((scale (ly:bookpaper-outputscale bookpap))
113 (new-pap (ly:output-def-clone pap))
114 (dim-vars (ly:paper-lookup pap 'dimension-variables))
115 (scope (ly:output-def-scope new-pap)))
119 (module-define! scope v
120 (/ (ly:paper-lookup pap v) scale)))