1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2006--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
18 (define-module (scm page)
42 (define (annotate? layout)
43 (eq? #t (ly:output-def-lookup layout 'annotate-spacing)))
46 (define page-module (current-module))
48 (define (make-page paper-book . args)
50 ((p (apply ly:make-prob (append
51 (list 'page (layout->page-init (ly:paper-book-paper paper-book))
52 'paper-book paper-book)
55 (page-set-property! p 'head-stencil (page-header p))
56 (page-set-property! p 'foot-stencil (page-footer p))
60 (define page-property ly:prob-property)
61 (define page-set-property! ly:prob-set-property!)
62 (define (page-property? page sym)
63 (eq? #t (page-property page sym)))
64 (define (page? x) (ly:prob-type? x 'page))
72 (string->symbol (format "page-~a" j))
74 (page-property pg j))))
76 '(page-number prev lines force penalty lines))
78 (define (page-system-numbers page)
79 (map (lambda (ps) (ly:prob-property ps 'number))
82 (define (page-translate-systems page)
90 (if (not (number? (ly:prob-property sys 'Y-offset)))
91 (ly:prob-set-property! sys 'Y-offset off))))
93 (zip (page-property page 'lines)
94 (page-property page 'configuration))))
96 (define (annotate-top-space first-system layout header-stencil stencil)
97 (let* ((top-margin (ly:output-def-lookup layout 'top-margin))
98 (sym (if (paper-system-title? first-system)
100 'top-system-spacing))
101 (spacing-spec (ly:output-def-lookup layout sym))
102 (X-offset (ly:prob-property first-system 'X-offset 5))
103 (header-extent (ly:stencil-extent header-stencil Y)))
106 (ly:stencil-add stencil
107 (ly:stencil-translate-axis
108 (annotate-spacing-spec layout
117 (define (annotate-page layout stencil)
118 (let ((top-margin (ly:output-def-lookup layout 'top-margin))
119 (paper-height (ly:output-def-lookup layout 'paper-height))
120 (bottom-margin (ly:output-def-lookup layout 'bottom-margin))
121 (add-stencil (lambda (y)
123 (ly:stencil-add stencil
124 (ly:stencil-translate-axis y 6 X))))))
126 (ly:stencil-translate-axis
127 (annotate-y-interval layout "paper-height"
128 (cons (- paper-height) 0)
132 (ly:stencil-translate-axis
133 (annotate-y-interval layout "top-margin"
134 (cons (- top-margin) 0)
138 (ly:stencil-translate-axis
139 (annotate-y-interval layout "bottom-margin"
140 (cons (- paper-height) (- bottom-margin paper-height))
145 (define (annotate-space-left page)
147 ((paper-book (page-property page 'paper-book))
148 (layout (ly:paper-book-paper paper-book))
149 (arrow (annotate-y-interval layout
152 (page-property page 'bottom-edge)
153 (let ((foot (page-property page 'foot-stencil)))
154 (if (and (ly:stencil? foot)
155 (not (ly:stencil-empty? foot)))
156 (car (ly:stencil-extent foot Y))
158 (page-property page 'bottom-system-edge))
161 (set! arrow (ly:stencil-translate-axis arrow 8 X))
166 (define (page-header-or-footer page dir)
168 ((paper-book (page-property page 'paper-book))
169 (layout (ly:paper-book-paper paper-book))
170 (scopes (ly:paper-book-scopes paper-book))
171 (number (page-page-number page))
172 (is-last-bookpart (page-property page 'is-last-bookpart))
173 (is-bookpart-last-page (page-property page 'is-bookpart-last-page))
177 (header-proc (ly:output-def-lookup layout sym)))
179 (if (procedure? header-proc)
180 (header-proc layout scopes number is-last-bookpart is-bookpart-last-page)
184 (define (page-header page)
185 (page-header-or-footer page UP))
187 (define (page-footer page)
188 (page-header-or-footer page DOWN))
190 (define (layout->page-init layout)
191 "Alist of settings for page layout"
193 ((paper-height (ly:output-def-lookup layout 'paper-height))
194 (paper-width (ly:output-def-lookup layout 'paper-width))
195 (left-margin (ly:output-def-lookup layout 'left-margin))
196 (right-margin (ly:output-def-lookup layout 'right-margin))
197 (bottom-edge (- paper-height
198 (ly:output-def-lookup layout 'bottom-margin)) )
199 (top-margin (ly:output-def-lookup layout 'top-margin))
202 `((paper-height . ,paper-height)
203 (paper-width . ,paper-width)
204 (left-margin . ,left-margin)
205 (right-margin . ,right-margin)
206 (top-margin . ,top-margin)
207 (bottom-edge . ,bottom-edge)
210 (define (make-page-stencil page)
211 "Construct a stencil representing the page from PAGE."
214 (page-translate-systems page)
216 ((paper-book (page-property page 'paper-book))
217 (prop (lambda (sym) (page-property page sym)))
218 (layout (ly:paper-book-paper paper-book))
219 (scopes (ly:paper-book-scopes paper-book))
220 (lines (page-lines page))
221 (number (page-page-number page))
223 ;; TODO: naming paper-height/paper-width not analogous to TeX.
225 (system-xoffset (ly:output-def-lookup layout 'horizontal-shift 0.0))
226 (system-separator-markup (ly:output-def-lookup layout 'system-separator-markup))
227 (system-separator-stencil (if (markup? system-separator-markup)
228 (interpret-markup layout
229 (layout-extract-page-properties layout)
230 system-separator-markup)
233 (page-stencil (ly:make-stencil '()))
237 (add-to-page (lambda (stencil x y)
239 (ly:stencil-add page-stencil
240 (ly:stencil-translate stencil
243 (- 0 y (prop 'top-margin)))
248 (let* ((stencil (paper-system-stencil system))
249 (y (ly:prob-property system 'Y-offset 0))
250 (is-title (paper-system-title?
253 (ly:prob-property system 'X-offset 0.0)
255 (if (and (ly:stencil? system-separator-stencil)
257 (not (paper-system-title? system))
258 (not (paper-system-title? last-system)))
260 system-separator-stencil
263 (car (paper-system-staff-extents last-system)))
265 (cdr (paper-system-staff-extents system))))))
266 (set! last-system system)
268 (head (prop 'head-stencil))
269 (foot (prop 'foot-stencil))
274 (not (ly:stencil-empty? head)))
276 ;; Ensure that the top of the header just touches the top margin.
277 (set! head (ly:stencil-translate-axis head
278 (- 0 (cdr (ly:stencil-extent head Y)) (prop 'top-margin)) Y))
279 (set! page-stencil (ly:stencil-add page-stencil head))))
286 (set! page-stencil (annotate-top-space (car lines) layout head page-stencil))
288 (for-each (lambda (sys next-sys)
289 (paper-system-annotate sys next-sys layout))
291 (append (cdr lines) (list #f)))
292 (paper-system-annotate-last (car (last-pair lines)) layout)))
294 (map add-system lines)
297 (ly:prob-set-property! page 'bottom-system-edge
298 (car (ly:stencil-extent page-stencil Y)))
299 (ly:prob-set-property! page 'space-left
300 (+ (prop 'bottom-edge)
301 (prop 'bottom-system-edge)
302 (if (and (ly:stencil? foot)
303 (not (ly:stencil-empty? foot)))
304 (car (ly:stencil-extent foot Y))
307 (if (annotate? layout)
309 (ly:stencil-add page-stencil
310 (annotate-space-left page))))
312 (if (and (ly:stencil? foot)
313 (not (ly:stencil-empty? foot)))
317 (ly:stencil-translate
320 (+ (- (prop 'bottom-edge))
321 (- (car (ly:stencil-extent foot Y)))))))))
323 (if (ly:output-def-lookup layout 'two-sided #f)
325 (ly:stencil-translate page-stencil
326 (cons (prop (if (even? number)
331 (ly:stencil-translate page-stencil (cons (prop 'left-margin) 0))))
334 (if (annotate? layout)
335 (set! page-stencil (annotate-page layout page-stencil)))
340 (define-public (page-stencil page)
341 (if (not (ly:stencil? (page-property page 'stencil)))
343 ;; todo: make tweakable.
344 ;; via property + callbacks.
346 (page-set-property! page 'stencil (make-page-stencil page)))
347 (page-property page 'stencil))
349 (define (calc-printable-height page)
350 "Printable area for music and titles; matches default-page-make-stencil."
352 ((paper-book (page-property page 'paper-book))
353 (layout (ly:paper-book-paper paper-book))
354 (h (- (ly:output-def-lookup layout 'paper-height)
355 (ly:output-def-lookup layout 'top-margin)
356 (ly:output-def-lookup layout 'bottom-margin)))
358 (head (page-property page 'head-stencil))
359 (foot (page-property page 'foot-stencil))
361 (- h (if (ly:stencil? head)
362 (interval-length (ly:stencil-extent head Y))
364 (if (ly:stencil? foot)
365 (interval-length (ly:stencil-extent foot Y))
368 ;; (display (list "\n available" available head foot))
371 (define (page-printable-height page)
372 (if (not (number? (page-property page 'printable-height)))
373 (page-set-property! page 'printable-height (calc-printable-height page)))
375 (page-property page 'printable-height))