2 ;; page.scm -- implement Page stuff.
4 ;; source file of the GNU LilyPond music typesetter
6 ;; (c) 2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 (define-module (scm page)
34 (define (annotate? layout)
35 (eq? #t (ly:output-def-lookup layout 'annotate-spacing)))
38 (define page-module (current-module))
40 (define (make-page paper-book . args)
42 ((p (apply ly:make-prob (append
43 (list 'page (layout->page-init (ly:paper-book-paper paper-book))
44 'paper-book paper-book)
47 (page-set-property! p 'head-stencil (page-header p))
48 (page-set-property! p 'foot-stencil (page-footer p))
52 (define page-property ly:prob-property)
53 (define page-set-property! ly:prob-set-property!)
54 (define (page-property? page sym)
55 (eq? #t (page-property page sym)))
56 (define (page? x) (ly:prob-type? x 'page))
64 (string->symbol (format "page-~a" j))
66 (page-property pg j))))
68 '(page-number prev lines force penalty lines))
70 (define (page-system-numbers page)
71 (map (lambda (ps) (ly:prob-property ps 'number))
74 (define (page-translate-systems page)
82 (if (not (number? (ly:prob-property sys 'Y-offset)))
83 (ly:prob-set-property! sys 'Y-offset off))))
85 (zip (page-property page 'lines)
86 (page-property page 'configuration))))
88 (define (annotate-top-space first-system layout header-stencil stencil)
89 (let* ((top-margin (ly:output-def-lookup layout 'top-margin))
90 (sym (if (paper-system-title? first-system)
93 (spacing-spec (ly:output-def-lookup layout sym))
94 (X-offset (ly:prob-property first-system 'X-offset 5))
95 (header-extent (ly:stencil-extent header-stencil Y)))
98 (ly:stencil-add stencil
99 (ly:stencil-translate-axis
100 (annotate-spacing-spec layout
109 (define (annotate-page layout stencil)
110 (let ((top-margin (ly:output-def-lookup layout 'top-margin))
111 (paper-height (ly:output-def-lookup layout 'paper-height))
112 (bottom-margin (ly:output-def-lookup layout 'bottom-margin))
113 (add-stencil (lambda (y)
115 (ly:stencil-add stencil
116 (ly:stencil-translate-axis y 6 X))))))
118 (ly:stencil-translate-axis
119 (annotate-y-interval layout "paper-height"
120 (cons (- paper-height) 0)
124 (ly:stencil-translate-axis
125 (annotate-y-interval layout "top-margin"
126 (cons (- top-margin) 0)
130 (ly:stencil-translate-axis
131 (annotate-y-interval layout "bottom-margin"
132 (cons (- paper-height) (- bottom-margin paper-height))
137 (define (annotate-space-left page)
139 ((paper-book (page-property page 'paper-book))
140 (layout (ly:paper-book-paper paper-book))
141 (arrow (annotate-y-interval layout
144 (page-property page 'bottom-edge)
145 (let ((foot (page-property page 'foot-stencil)))
146 (if (and (ly:stencil? foot)
147 (not (ly:stencil-empty? foot)))
148 (car (ly:stencil-extent foot Y))
150 (page-property page 'bottom-system-edge))
153 (set! arrow (ly:stencil-translate-axis arrow 8 X))
158 (define (page-header-or-footer page dir)
160 ((paper-book (page-property page 'paper-book))
161 (layout (ly:paper-book-paper paper-book))
162 (scopes (ly:paper-book-scopes paper-book))
163 (number (page-page-number page))
164 (is-last-bookpart (page-property page 'is-last-bookpart))
165 (is-bookpart-last-page (page-property page 'is-bookpart-last-page))
169 (header-proc (ly:output-def-lookup layout sym)))
171 (if (procedure? header-proc)
172 (header-proc layout scopes number is-last-bookpart is-bookpart-last-page)
176 (define (page-header page)
177 (page-header-or-footer page UP))
179 (define (page-footer page)
180 (page-header-or-footer page DOWN))
182 (define (layout->page-init layout)
183 "Alist of settings for page layout"
185 ((paper-height (ly:output-def-lookup layout 'paper-height))
186 (paper-width (ly:output-def-lookup layout 'paper-width))
187 (lmargin (ly:output-def-lookup layout 'left-margin #f))
188 (left-margin (if lmargin
191 (ly:output-def-lookup layout 'line-width)) 2)))
192 (bottom-edge (- paper-height
193 (ly:output-def-lookup layout 'bottom-margin)) )
194 (top-margin (ly:output-def-lookup layout 'top-margin))
197 `((paper-height . ,paper-height)
198 (paper-width . ,paper-width)
199 (left-margin . ,left-margin)
200 (top-margin . ,top-margin)
201 (bottom-edge . ,bottom-edge)
204 (define (make-page-stencil page)
205 "Construct a stencil representing the page from PAGE."
208 (page-translate-systems page)
210 ((paper-book (page-property page 'paper-book))
211 (prop (lambda (sym) (page-property page sym)))
212 (layout (ly:paper-book-paper paper-book))
213 (scopes (ly:paper-book-scopes paper-book))
214 (lines (page-lines page))
215 (number (page-page-number page))
217 ;; TODO: naming paper-height/paper-width not analogous to TeX.
219 (system-xoffset (ly:output-def-lookup layout 'horizontal-shift 0.0))
220 (system-separator-markup (ly:output-def-lookup layout 'system-separator-markup))
221 (system-separator-stencil (if (markup? system-separator-markup)
222 (interpret-markup layout
223 (layout-extract-page-properties layout)
224 system-separator-markup)
227 (page-stencil (ly:make-stencil '()))
231 (add-to-page (lambda (stencil x y)
233 (ly:stencil-add page-stencil
234 (ly:stencil-translate stencil
237 (- 0 y (prop 'top-margin)))
242 (let* ((stencil (paper-system-stencil system))
243 (y (ly:prob-property system 'Y-offset))
244 (is-title (paper-system-title?
247 (ly:prob-property system 'X-offset 0.0)
249 (if (and (ly:stencil? system-separator-stencil)
251 (not (paper-system-title? system))
252 (not (paper-system-title? last-system)))
254 system-separator-stencil
257 (car (paper-system-staff-extents last-system)))
259 (cdr (paper-system-staff-extents system))))))
260 (set! last-system system)
262 (head (prop 'head-stencil))
263 (foot (prop 'foot-stencil))
268 (not (ly:stencil-empty? head)))
270 ;; Ensure that the top of the header just touches the top margin.
271 (set! head (ly:stencil-translate-axis head
272 (- 0 (cdr (ly:stencil-extent head Y)) (prop 'top-margin)) Y))
273 (set! page-stencil (ly:stencil-add page-stencil head))))
280 (set! page-stencil (annotate-top-space (car lines) layout head page-stencil))
282 (for-each (lambda (sys next-sys)
283 (paper-system-annotate sys next-sys layout))
285 (append (cdr lines) (list #f)))
286 (paper-system-annotate-last (car (last-pair lines)) layout)))
288 (map add-system lines)
291 (ly:prob-set-property! page 'bottom-system-edge
292 (car (ly:stencil-extent page-stencil Y)))
293 (ly:prob-set-property! page 'space-left
294 (+ (prop 'bottom-edge)
295 (prop 'bottom-system-edge)
296 (if (and (ly:stencil? foot)
297 (not (ly:stencil-empty? foot)))
298 (car (ly:stencil-extent foot Y))
301 (if (annotate? layout)
303 (ly:stencil-add page-stencil
304 (annotate-space-left page))))
306 (if (and (ly:stencil? foot)
307 (not (ly:stencil-empty? foot)))
311 (ly:stencil-translate
314 (+ (- (prop 'bottom-edge))
315 (- (car (ly:stencil-extent foot Y)))))))))
318 (ly:stencil-translate page-stencil (cons (prop 'left-margin) 0)))
321 (if (annotate? layout)
322 (set! page-stencil (annotate-page layout page-stencil)))
327 (define-public (page-stencil page)
328 (if (not (ly:stencil? (page-property page 'stencil)))
330 ;; todo: make tweakable.
331 ;; via property + callbacks.
333 (page-set-property! page 'stencil (make-page-stencil page)))
334 (page-property page 'stencil))
336 (define (calc-printable-height page)
337 "Printable area for music and titles; matches default-page-make-stencil."
339 ((paper-book (page-property page 'paper-book))
340 (layout (ly:paper-book-paper paper-book))
341 (h (- (ly:output-def-lookup layout 'paper-height)
342 (ly:output-def-lookup layout 'top-margin)
343 (ly:output-def-lookup layout 'bottom-margin)))
345 (head (page-property page 'head-stencil))
346 (foot (page-property page 'foot-stencil))
348 (- h (if (ly:stencil? head)
349 (interval-length (ly:stencil-extent head Y))
351 (if (ly:stencil? foot)
352 (interval-length (ly:stencil-extent foot Y))
355 ;; (display (list "\n available" available head foot))
358 (define (page-printable-height page)
359 (if (not (number? (page-property page 'printable-height)))
360 (page-set-property! page 'printable-height (calc-printable-height page)))
362 (page-property page 'printable-height))