-;;
-;; page.scm -- implement Page stuff.
-;;
-;; source file of the GNU LilyPond music typesetter
-;;
-;; (c) 2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
-;;
+;;;; This file is part of LilyPond, the GNU music typesetter.
+;;;;
+;;;; Copyright (C) 2006--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
(define-module (scm page)
#:export (make-page
- page-property
- page-set-property!
- page-prev
- page-height
- page-lines
- page-force
- page-penalty
- page-configuration
- page-lines
- page-page-number
- page-system-numbers
- page-stencil
- page?
- ))
+ page-property
+ page-set-property!
+ page-prev
+ page-printable-height
+ layout->page-init
+ page-force
+ page-penalty
+ page-configuration
+ page-lines
+ page-page-number
+ page-system-numbers
+ page-stencil
+ page-free-height
+ page?
+ ))
(use-modules (lily)
- (scm paper-system)
- (srfi srfi-1))
+ (scm paper-system)
+ (srfi srfi-1))
(define (annotate? layout)
- (eq? #t (ly:output-def-lookup layout 'annotatespacing)))
+ (eq? #t (ly:output-def-lookup layout 'annotate-spacing)))
(define page-module (current-module))
-(define (make-page . args)
- (apply ly:make-prob (append
- (list 'page '())
- args)))
+(define (make-page paper-book . args)
+ (let*
+ ((p (apply ly:make-prob (append
+ (list 'page (layout->page-init (ly:paper-book-paper paper-book))
+ 'paper-book paper-book)
+ args))))
+
+ (page-set-property! p 'head-stencil (page-header p))
+ (page-set-property! p 'foot-stencil (page-footer p))
+
+ p))
(define page-property ly:prob-property)
+(define page-set-property! ly:prob-set-property!)
(define (page-property? page sym)
(eq? #t (page-property page sym)))
-
(define (page? x) (ly:prob-type? x 'page))
-(define page-set-property! ly:prob-set-property!)
-;; define accessors.
+;; define accessors.
(for-each
(lambda (j)
(module-define!
page-module
- (string->symbol (format "page-~a" j))
+ (string->symbol (format #f "page-~a" j))
(lambda (pg)
(page-property pg j))))
-
- '(page-number prev lines force penalty configuration lines))
-
-(define (page-system-numbers node)
- (map (lambda (ps) (ly:prob-property ps 'number))
- (page-lines node)))
+ '(page-number prev lines force penalty lines))
+(define (page-system-numbers page)
+ (map (lambda (ps) (ly:prob-property ps 'number))
+ (page-lines page)))
+
+(define (page-translate-systems page)
+ (for-each
+
+ (lambda (sys off)
+ (if (not (number? (ly:prob-property sys 'Y-offset)))
+ (ly:prob-set-property! sys 'Y-offset off)))
+
+ (page-property page 'lines)
+ (page-property page 'configuration)))
+
+(define (annotate-top-space first-system layout header-stencil stencil)
+ (let* ((top-margin (ly:output-def-lookup layout 'top-margin))
+ (sym (if (paper-system-title? first-system)
+ 'top-markup-spacing
+ 'top-system-spacing))
+ (spacing-spec (ly:output-def-lookup layout sym))
+ (X-offset (ly:prob-property first-system 'X-offset 5))
+ (header-extent (ly:stencil-extent header-stencil Y)))
+
+ (set! stencil
+ (ly:stencil-add stencil
+ (ly:stencil-translate-axis
+ (annotate-spacing-spec layout
+ (symbol->string sym)
+ spacing-spec
+ (- top-margin)
+ (car header-extent)
+ #:base-color red)
+ X-offset X)))
+ stencil))
-(define (annotate-page stencil layout)
- (let*
- ((topmargin (ly:output-def-lookup layout 'topmargin))
- (vsize (ly:output-def-lookup layout 'vsize))
- (bottommargin (ly:output-def-lookup layout 'bottommargin))
- (add-stencil (lambda (y)
- (set! stencil
- (ly:stencil-add stencil y))
- )))
+(define (annotate-page layout stencil)
+ (let ((top-margin (ly:output-def-lookup layout 'top-margin))
+ (paper-height (ly:output-def-lookup layout 'paper-height))
+ (bottom-margin (ly:output-def-lookup layout 'bottom-margin))
+ (add-stencil (lambda (y)
+ (set! stencil
+ (ly:stencil-add stencil
+ (ly:stencil-translate-axis y 6 X))))))
(add-stencil
- (ly:stencil-translate-axis
- (annotate-y-interval layout "vsize"
- (cons (- vsize) 0)
- #t)
+ (ly:stencil-translate-axis
+ (annotate-y-interval layout "paper-height"
+ (cons (- paper-height) 0)
+ #t)
1 X))
-
-
(add-stencil
- (ly:stencil-translate-axis
- (annotate-y-interval layout "topmargin"
- (cons (- topmargin) 0)
- #t)
+ (ly:stencil-translate-axis
+ (annotate-y-interval layout "top-margin"
+ (cons (- top-margin) 0)
+ #t)
2 X))
-
(add-stencil
- (ly:stencil-translate-axis
- (annotate-y-interval layout "bottommargin"
- (cons (- vsize) (- bottommargin vsize))
- #t)
+ (ly:stencil-translate-axis
+ (annotate-y-interval layout "bottom-margin"
+ (cons (- paper-height) (- bottom-margin paper-height))
+ #t)
2 X))
-
stencil))
-(define (annotate-space-left page-stencil layout bottom-edge)
+(define (annotate-space-left page)
(let*
- ((arrow (annotate-y-interval layout
- "space left"
- (cons (- bottom-edge) (car (ly:stencil-extent page-stencil Y)))
- #t)))
-
+ ((paper-book (page-property page 'paper-book))
+ (layout (ly:paper-book-paper paper-book))
+ (arrow (annotate-y-interval layout
+ "space left"
+ (cons (- 0.0
+ (page-property page 'bottom-edge)
+ (let ((foot (page-property page 'foot-stencil)))
+ (if (and (ly:stencil? foot)
+ (not (ly:stencil-empty? foot)))
+ (car (ly:stencil-extent foot Y))
+ 0.0)))
+ (page-property page 'bottom-system-edge))
+ #t)))
+
(set! arrow (ly:stencil-translate-axis arrow 8 X))
- (ly:stencil-add page-stencil arrow)))
-
-\f
-
-
-(define (page-headfoot layout scopes number
- sym separation-symbol dir last?)
-
- "Create a stencil including separating space."
-
- (let* ((header-proc (ly:output-def-lookup layout sym))
- (sep (ly:output-def-lookup layout separation-symbol))
- (stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
- (head-stencil
- (if (procedure? header-proc)
- (header-proc layout scopes number last?)
- #f))
- )
-
- (if (and (number? sep)
- (ly:stencil? head-stencil)
- (not (ly:stencil-empty? head-stencil)))
-
- (begin
- (set! head-stencil
- (ly:stencil-combine-at-edge
- stencil Y dir head-stencil
- sep 0.0))
-
-
- ;; add arrow markers
- (if (annotate? layout)
- (set! head-stencil
- (ly:stencil-add
- (ly:stencil-translate-axis
- (annotate-y-interval layout
- (symbol->string separation-symbol)
- (cons (min 0 (* dir sep))
- (max 0 (* dir sep)))
- #t)
- (/ (ly:output-def-lookup layout 'linewidth) 2)
- X)
- (if (= dir UP)
- (ly:stencil-translate-axis
- (annotate-y-interval layout
- "pagetopspace"
- (cons
- (- (min 0 (* dir sep))
- (ly:output-def-lookup layout 'pagetopspace))
- (min 0 (* dir sep)))
- #t)
- (+ 7 (interval-center (ly:stencil-extent head-stencil X))) X)
- empty-stencil
- )
- head-stencil
- ))
- )))
-
- head-stencil))
+
+ arrow))
+
(define (page-header-or-footer page dir)
- (let*
- ((p-book (page-property page 'paper-book))
- (layout (ly:paper-book-paper p-book))
- (scopes (ly:paper-book-scopes p-book))
- (lines (page-lines page))
- (offsets (page-configuration page))
+ (let*
+ ((paper-book (page-property page 'paper-book))
+ (layout (ly:paper-book-paper paper-book))
+ (scopes (ly:paper-book-scopes paper-book))
(number (page-page-number page))
- (last? (page-property page 'is-last))
+ (is-last-bookpart (page-property page 'is-last-bookpart))
+ (is-bookpart-last-page (page-property page 'is-bookpart-last-page))
+ (sym (if (= dir UP)
+ 'make-header
+ 'make-footer))
+ (header-proc (ly:output-def-lookup layout sym)))
- )
-
- (page-headfoot layout scopes number
- (if (= dir UP)
- 'make-header
- 'make-footer)
- (if (= dir UP)
- 'headsep
- 'footsep)
- dir last?)))
+ (if (procedure? header-proc)
+ (header-proc layout scopes number is-last-bookpart is-bookpart-last-page)
+ #f)))
-(define (page-footer page)
- (page-header-or-footer page UP))
(define (page-header page)
+ (page-header-or-footer page UP))
+
+(define (page-footer page)
(page-header-or-footer page DOWN))
+(define (layout->page-init layout)
+ "Alist of settings for page layout"
+ (let*
+ ((paper-height (ly:output-def-lookup layout 'paper-height))
+ (paper-width (ly:output-def-lookup layout 'paper-width))
+ (left-margin (ly:output-def-lookup layout 'left-margin))
+ (right-margin (ly:output-def-lookup layout 'right-margin))
+ (bottom-edge (- paper-height
+ (ly:output-def-lookup layout 'bottom-margin)) )
+ (top-margin (ly:output-def-lookup layout 'top-margin))
+ )
+
+ `((paper-height . ,paper-height)
+ (paper-width . ,paper-width)
+ (left-margin . ,left-margin)
+ (right-margin . ,right-margin)
+ (top-margin . ,top-margin)
+ (bottom-edge . ,bottom-edge)
+ )))
+
(define (make-page-stencil page)
- "Construct a stencil representing the page from LINES.
+ "Construct a stencil representing the page from PAGE."
- Offsets is a list of increasing numbers. They must be negated to
-create offsets.
- "
+ (page-translate-systems page)
(let*
- ((p-book (page-property page 'paper-book))
- (layout (ly:paper-book-paper p-book))
- (scopes (ly:paper-book-scopes p-book))
+ ((paper-book (page-property page 'paper-book))
+ (prop (lambda (sym) (page-property page sym)))
+ (layout (ly:paper-book-paper paper-book))
+ (scopes (ly:paper-book-scopes paper-book))
(lines (page-lines page))
- (offsets (page-configuration page))
(number (page-page-number page))
- (last? (page-property page 'is-last))
- (topmargin (ly:output-def-lookup layout 'topmargin))
+ ;; TODO: naming paper-height/paper-width not analogous to TeX.
- ;; TODO: naming vsize/hsize not analogous to TeX.
-
- (vsize (ly:output-def-lookup layout 'vsize))
- (hsize (ly:output-def-lookup layout 'hsize))
-
- (system-xoffset (ly:output-def-lookup layout 'horizontalshift 0.0))
- (system-separator-markup (ly:output-def-lookup layout 'systemSeparatorMarkup))
+ (system-xoffset (ly:output-def-lookup layout 'horizontal-shift 0.0))
+ (system-separator-markup (ly:output-def-lookup layout 'system-separator-markup))
(system-separator-stencil (if (markup? system-separator-markup)
- (interpret-markup layout
- (layout-extract-page-properties layout)
- system-separator-markup)
- #f))
- (lmargin (ly:output-def-lookup layout 'leftmargin))
- (leftmargin (if lmargin
- lmargin
- (/ (- hsize
- (ly:output-def-lookup layout 'linewidth)) 2)))
-
- (rightmargin (ly:output-def-lookup layout 'rightmargin))
- (bottom-edge (- vsize
- (ly:output-def-lookup layout 'bottommargin)))
-
- (head (page-header page))
-
- (foot (page-footer page))
-
- (head-height (if (ly:stencil? head)
- (interval-length (ly:stencil-extent head Y))
- 0.0))
-
- (height-proc (ly:output-def-lookup layout 'page-music-height))
-
- (page-stencil (ly:make-stencil '()
- (cons leftmargin hsize)
- (cons (- topmargin) 0)))
+ (interpret-markup layout
+ (layout-extract-page-properties layout)
+ system-separator-markup)
+ #f))
+
+ (page-stencil empty-stencil)
+
(last-system #f)
(last-y 0.0)
- (add-to-page (lambda (stencil y)
- (set! page-stencil
- (ly:stencil-add page-stencil
- (ly:stencil-translate stencil
- (cons
- system-xoffset
- (- 0 head-height y topmargin))
-
- )))))
+ (add-to-page (lambda (stencil x y)
+ (set! page-stencil
+ (ly:stencil-add page-stencil
+ (ly:stencil-translate stencil
+ (cons
+ (+ system-xoffset x)
+ (- 0 y (prop 'top-margin)))
+
+ )))))
(add-system
- (lambda (stencil-position)
- (let* ((system (car stencil-position))
- (stencil (paper-system-stencil system))
- (y (cadr stencil-position))
- (is-title (paper-system-title?
- (car stencil-position))))
- (add-to-page stencil y)
- (if (and (ly:stencil? system-separator-stencil)
- last-system
- (not (paper-system-title? system))
- (not (paper-system-title? last-system)))
- (add-to-page
- system-separator-stencil
- (average (- last-y
- (car (paper-system-staff-extents last-system)))
- (- y
- (cdr (paper-system-staff-extents system))))))
- (set! last-system system)
- (set! last-y y))))
+ (lambda (system)
+ (let* ((stencil (paper-system-stencil system))
+ (extra-offset (ly:prob-property system 'extra-offset '(0 . 0)))
+ (x (+ (ly:prob-property system 'X-offset 0.0)
+ (car extra-offset)))
+ (y (+ (ly:prob-property system 'Y-offset 0.0)
+ (cdr extra-offset)))
+ (is-title (paper-system-title?
+ system)))
+ (add-to-page stencil x y)
+ (if (and (ly:stencil? system-separator-stencil)
+ last-system
+ (not (paper-system-title? system))
+ (not (paper-system-title? last-system)))
+ (add-to-page
+ system-separator-stencil
+ 0
+ (average (- last-y
+ (car (paper-system-staff-extents last-system)))
+ (- y
+ (cdr (paper-system-staff-extents system))))))
+ (set! last-system system)
+ (set! last-y y))))
+ (head (prop 'head-stencil))
+ (foot (prop 'foot-stencil))
)
+ (if (and
+ (ly:stencil? head)
+ (not (ly:stencil-empty? head)))
+ (begin
+ ;; Ensure that the top of the header just touches the top margin.
+ (set! head (ly:stencil-translate-axis head
+ (- 0 (cdr (ly:stencil-extent head Y)) (prop 'top-margin)) Y))
+ (set! page-stencil (ly:stencil-add page-stencil head))))
+
+ (if (and
+ (annotate? layout)
+ (pair? lines))
+
+ (begin
+ (set! page-stencil (annotate-top-space (car lines) layout head page-stencil))
+
+ (for-each (lambda (sys next-sys)
+ (paper-system-annotate sys next-sys layout))
+ lines
+ (append (cdr lines) (list #f)))
+ (paper-system-annotate-last (car (last-pair lines)) layout)))
+
+ (for-each add-system lines)
+
+
+ (ly:prob-set-property! page 'bottom-system-edge
+ (car (ly:stencil-extent page-stencil Y)))
+ (ly:prob-set-property! page 'space-left
+ (+ (prop 'bottom-edge)
+ (prop 'bottom-system-edge)
+ (if (and (ly:stencil? foot)
+ (not (ly:stencil-empty? foot)))
+ (car (ly:stencil-extent foot Y))
+ 0.0)))
(if (annotate? layout)
- (begin
- (for-each (lambda (sys) (paper-system-annotate sys layout))
- lines)
- (paper-system-annotate-last (car (last-pair lines)) layout)))
-
-
- (if #f
- (display (list
- "leftmargin " leftmargin "rightmargin " rightmargin
- )))
-
- (set! page-stencil (ly:stencil-combine-at-edge
- page-stencil Y DOWN
- (if (and
- (ly:stencil? head)
- (not (ly:stencil-empty? head)))
- head
- (ly:make-stencil "" (cons 0 0) (cons 0 0)))
- 0. 0.))
-
- (map add-system (zip lines offsets))
+ (set! page-stencil
+ (ly:stencil-add page-stencil
+ (annotate-space-left page))))
- (if (annotate? layout)
- (set!
- page-stencil
- (annotate-space-left page-stencil layout
- (- bottom-edge
- (if (ly:stencil? foot)
- (interval-length (ly:stencil-extent foot Y))
- 0)))
- ))
-
-
(if (and (ly:stencil? foot)
- (not (ly:stencil-empty? foot)))
- (set! page-stencil
- (ly:stencil-add
- page-stencil
- (ly:stencil-translate
- foot
- (cons 0
- (+ (- bottom-edge)
- (- (car (ly:stencil-extent foot Y)))))))))
-
- (set! page-stencil
- (ly:stencil-translate page-stencil (cons leftmargin 0)))
+ (not (ly:stencil-empty? foot)))
+ (set! page-stencil
+ (ly:stencil-add
+ page-stencil
+ (ly:stencil-translate
+ foot
+ (cons 0
+ (+ (- (prop 'bottom-edge))
+ (- (car (ly:stencil-extent foot Y)))))))))
+
+ (if (ly:output-def-lookup layout 'two-sided #f)
+ (set! page-stencil
+ (ly:stencil-translate page-stencil
+ (cons (prop (if (even? number)
+ 'left-margin
+ 'right-margin))
+ 0)))
+ (set! page-stencil
+ (ly:stencil-translate page-stencil (cons (prop 'left-margin) 0))))
;; annotation.
(if (annotate? layout)
- (set! page-stencil (annotate-page layout page-stencil)))
-
+ (set! page-stencil (annotate-page layout page-stencil)))
page-stencil))
-
-(define (page-stencil page)
+(define-public (page-stencil page)
(if (not (ly:stencil? (page-property page 'stencil)))
;; todo: make tweakable.
;; via property + callbacks.
-
+
(page-set-property! page 'stencil (make-page-stencil page)))
(page-property page 'stencil))
-(define (page-height page)
+(define (calc-printable-height page)
"Printable area for music and titles; matches default-page-make-stencil."
(let*
- ((p-book (page-property page 'paper-book))
- (layout (ly:paper-book-paper p-book))
- (scopes (ly:paper-book-scopes p-book))
- (number (page-page-number page))
- (last? (page-property page 'is-last))
- (h (- (ly:output-def-lookup layout 'vsize)
- (ly:output-def-lookup layout 'topmargin)
- (ly:output-def-lookup layout 'bottommargin)))
-
- (head (page-headfoot layout scopes number 'make-header 'headsep UP last?))
- (foot (page-headfoot layout scopes number 'make-footer 'footsep DOWN last?))
+ ((paper-book (page-property page 'paper-book))
+ (layout (ly:paper-book-paper paper-book))
+ (h (- (ly:output-def-lookup layout 'paper-height)
+ (ly:output-def-lookup layout 'top-margin)
+ (ly:output-def-lookup layout 'bottom-margin)))
+
+ (head (page-property page 'head-stencil))
+ (foot (page-property page 'foot-stencil))
(available
- (- h (if (ly:stencil? head)
- (interval-length (ly:stencil-extent head Y))
- 0)
- (if (ly:stencil? foot)
- (interval-length (ly:stencil-extent foot Y))
- 0))))
-
+ (- h (if (ly:stencil? head)
+ (interval-length (ly:stencil-extent head Y))
+ 0)
+ (if (ly:stencil? foot)
+ (interval-length (ly:stencil-extent foot Y))
+ 0))))
+
;; (display (list "\n available" available head foot))
available))
+
+(define (page-printable-height page)
+ (if (not (number? (page-property page 'printable-height)))
+ (page-set-property! page 'printable-height (calc-printable-height page)))
+
+ (page-property page 'printable-height))
projects / lilypond.git / blobdiff