1
;;;; paper.scm -- manipulate the paper block.
1
;;;; paper.scm -- manipulate the paper and layout block.
3
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."
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."
10
18
(let* ((m (current-module))
23
;; linear interpolation.
15
(module-define! m 'fonts (make-font-tree (/ sz (* 20 pt))))
36
(module-define! m 'text-font-size (* 12 (/ sz (* 20 pt))))
17
(module-define! m 'staffheight sz)
18
(module-define! m 'staff-space ss)
19
(module-define! m 'staffspace ss)
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)
22
48
;; !! synchronize with feta-params.mf
23
(module-define! m 'linethickness (+ (* 0.3 pt) (* 0.04 ss)))
24
(module-define! m 'outputscale ss)
25
(module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
26
(module-define! m 'blotdiameter (* 0.35 pt))
27
(module-define! m 'interscoreline (* 4 mm))))
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))
29
(define-public (set-global-staff-size sz)
54
(define-safe-public (set-global-staff-size sz)
30
55
"Set the default staff size, where SZ is thought to be in PT."
31
56
(let* ((old-mod (current-module))
32
57
(pap (eval '$defaultpaper old-mod))
35
;; Huh? Why is it necessary to clone object?
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
36
64
(new-paper (ly:output-def-clone pap))
37
66
(new-scope (ly:output-def-scope new-paper)))
69
(ly:warning (_ "Not in toplevel scope")))
39
70
(set-current-module new-scope)
40
(paper-set-staff-size (* sz (eval 'pt new-scope)))
71
(layout-set-staff-size (* sz (eval 'pt new-scope)))
41
72
(set-current-module old-mod)
42
73
(module-define! old-mod '$defaultpaper new-paper)))
45
'(("a6" . (cons (* 105 mm) (* 148.95 mm)))
46
("a5" . (cons (* 148.95 mm) (* 210 mm)))
47
("a4" . (cons (* 210 mm) (* 297.9 mm)))
48
("a3" . (cons (* 297.9 mm) (* 420 mm)))
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)))
49
85
("legal" . (cons (* 8.5 in) (* 14.0 in)))
50
86
("letter" . (cons (* 8.5 in) (* 11.0 in)))
51
("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
87
("11x17" . (cons (* 11.0 in) (* 17.0 in)))
53
90
;; todo: take dimension arguments.
55
92
(define (set-paper-dimensions m w h)
56
"M is a module (i.e. paper->scope_ )"
93
"M is a module (i.e. layout->scope_ )"
57
94
(let* ((mm (eval 'mm m)))
58
(module-define! m 'hsize w)
59
(module-define! m 'vsize h)
60
(module-define! m 'linewidth (- w (* 20 mm)))
95
(module-define! m 'paper-width w)
96
(module-define! m 'paper-height h)
97
(module-define! m 'line-width (- w (* 20 mm)))
61
98
(module-define! m 'indent (/ w 14))
63
100
;; page layout - what to do with (printer specific!) margin settings?
64
(module-define! m 'top-margin (* 5 mm))
65
(module-define! m 'bottom-margin (* 6 mm))
66
(module-define! m 'head-sep (* 4 mm))
67
(module-define! m 'foot-sep (* 4 mm))))
71
(define (internal-set-paper-size module name)
104
(define (internal-set-paper-size module name landscape?)
106
(cons (cdr x) (car x)))
72
108
(let* ((entry (assoc name paper-alist))
73
(is-paper? (module-defined? module '$is-paper))
109
(is-paper? (module-defined? module 'is-paper))
74
110
(mm (eval 'mm module)))
78
(ly:warning "This is not a \\paper {} object:")
114
(ly:warning (_ "This is not a \\layout {} object, ~S" module)))
81
(set! entry (eval (cdr entry) module))
82
(set-paper-dimensions module (car entry) (cdr entry))
83
(module-define! module 'papersize name)
84
(module-define! module 'papersizename name)
85
(set-paper-dimensions module (car entry) (cdr entry)))
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)))
87
(ly:warn (string-append "Unknown papersize: " name))))
91
(define-public (set-default-paper-size name)
92
(internal-set-paper-size (ly:output-def-scope (eval '$defaultpaper (current-module)))
95
(define-public (set-paper-size name)
96
(if (module-defined? (current-module) '$is-paper)
97
(internal-set-paper-size (current-module) name)
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))
99
140
;;; TODO: should raise (generic) exception with throw, and catch
100
141
;;; that in parse-scm.cc
101
(ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))
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 paper-width, paper-height.
160
;; (ly:warning (_ "not a number, ~S = ~S " v val))