[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[patch] export functions from layout-page-layout.scm
|
From: |
Nicolas Sceaux |
|
Subject: |
[patch] export functions from layout-page-layout.scm |
|
Date: |
Sat, 16 Sep 2006 13:57:01 +0200 |
|
User-agent: |
Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (darwin) |
Hi,
The attached patch exports some of the utility function names in
scm/layout-page-layout.scm, so that they should be called by user
defined page breaking functions.
Make web runs fine, and the page breaking regression tests seem to look
as expected. May I commit?
nicolas
Index: ChangeLog
===================================================================
RCS file: /cvsroot/lilypond/lilypond/ChangeLog,v
retrieving revision 1.5299
diff -u -r1.5299 ChangeLog
--- ChangeLog 15 Sep 2006 18:04:16 -0000 1.5299
+++ ChangeLog 16 Sep 2006 11:15:25 -0000
@@ -1,3 +1,18 @@
+2006-09-16 Nicolas Sceaux <address@hidden>
+
+ * scm/layout-page-layout.scm: export utility function names to
+ enable custom page breaking function writing. Tabify.
+ (line-next-space): use ?-suffix only for predicates
+ (page-maximum-space-to-fill): new function. Return the space
+ between first and bottom system of a page, to give to
+ space-systems.
+ (space-systems): use a space-to-fill argument (for instance as
+ computed by page-maximum-space-to-fill) instead of computing
+ internaly this space with the page height. That way, the caller
+ can adjust the space to use.
+ (make-page-from-systems, walk-paths): compute space to fill before
+ calling space-systems.
+
2006-09-15 Mats Bengtsson <address@hidden>
* ly/engraver-init.ly: Make FiguredBass accepted in GrandStaff and
Index: scm/layout-page-dump.scm
===================================================================
RCS file: /cvsroot/lilypond/lilypond/scm/layout-page-dump.scm,v
retrieving revision 1.1
diff -u -r1.1 layout-page-dump.scm
--- scm/layout-page-dump.scm 15 Jul 2006 10:34:29 -0000 1.1
+++ scm/layout-page-dump.scm 16 Sep 2006 11:15:27 -0000
@@ -10,7 +10,9 @@
#:use-module (scm paper-system)
#:use-module (scm page)
#:use-module (lily)
- #:export (write-page-breaks))
+ #:export (write-page-breaks
+ ;; utilisties for writing other page dump functions
+ record-tweaks dump-all-tweaks))
(define (record-tweaks what property-pairs tweaks)
Index: scm/layout-page-layout.scm
===================================================================
RCS file: /cvsroot/lilypond/lilypond/scm/layout-page-layout.scm,v
retrieving revision 1.21
diff -u -r1.21 layout-page-layout.scm
--- scm/layout-page-layout.scm 4 Sep 2006 05:31:28 -0000 1.21
+++ scm/layout-page-layout.scm 16 Sep 2006 11:15:27 -0000
@@ -3,7 +3,7 @@
;;;; source file of the GNU LilyPond music typesetter
;;;;
;;;; (c) 2004--2006 Jan Nieuwenhuizen <address@hidden>
-;;;; Han-Wen Nienhuys <address@hidden>
+;;;; Han-Wen Nienhuys <address@hidden>
(define-module (scm layout-page-layout)
#:use-module (srfi srfi-1)
@@ -13,7 +13,13 @@
#:use-module (scm page)
#:use-module (scm layout-page-dump)
#:use-module (lily)
- #:export (post-process-pages optimal-page-breaks make-page-from-systems))
+ #:export (post-process-pages optimal-page-breaks make-page-from-systems
+ ;; utilities for writing custom page breaking functions
+ line-next-space line-next-padding
+ line-minimum-distance line-ideal-distance
+ first-line-position
+ line-ideal-relative-position line-minimum-relative-position
+ page-maximum-space-to-fill space-systems))
(define (post-process-pages layout pages)
(if (ly:output-def-lookup layout 'write-page-layout #f)
@@ -25,18 +31,18 @@
(define (line-next-space line next-line layout)
"Return space to use between `line' and `next-line'.
`next-line' can be #f, meaning that `line' is the last line."
- (let* ((title? (paper-system-title? line))
- (next-title? (and next-line (paper-system-title? next-line))))
- (cond ((and title? next-title?)
- (ly:output-def-lookup layout 'between-title-space))
- (title?
- (ly:output-def-lookup layout 'after-title-space))
- (next-title?
- (ly:output-def-lookup layout 'before-title-space))
- (else
- (ly:prob-property
- line 'next-space
- (ly:output-def-lookup layout 'between-system-space))))))
+ (let* ((title (paper-system-title? line))
+ (next-title (and next-line (paper-system-title? next-line))))
+ (cond ((and title next-title)
+ (ly:output-def-lookup layout 'between-title-space))
+ (title
+ (ly:output-def-lookup layout 'after-title-space))
+ (next-title
+ (ly:output-def-lookup layout 'before-title-space))
+ (else
+ (ly:prob-property
+ line 'next-space
+ (ly:output-def-lookup layout 'between-system-space))))))
(define (line-next-padding line next-line layout)
"Return padding to use between `line' and `next-line'.
@@ -51,22 +57,22 @@
reference position. If next-line is #f, return #f."
(and next-line
(max 0 (- (+ (interval-end (paper-system-extent next-line Y))
- (if ignore-padding 0 (line-next-padding line next-line
layout)))
- (interval-start (paper-system-extent line Y))))))
+ (if ignore-padding 0 (line-next-padding line next-line
layout)))
+ (interval-start (paper-system-extent line Y))))))
(define (line-ideal-distance line next-line layout ignore-padding)
"Ideal distance between `line' reference position and `next-line'
reference position. If next-line is #f, return #f."
(and next-line
(+ (max 0 (- (+ (interval-end (paper-system-staff-extents next-line))
- (if ignore-padding 0 (line-next-padding line next-line
layout)))
- (interval-start (paper-system-staff-extents line))))
- (line-next-space line next-line layout))))
+ (if ignore-padding 0 (line-next-padding line next-line
layout)))
+ (interval-start (paper-system-staff-extents line))))
+ (line-next-space line next-line layout))))
(define (first-line-position line layout)
"Position of the first line on page"
(max (+ (ly:output-def-lookup layout 'page-top-space)
- (interval-end (paper-system-staff-extents line)))
+ (interval-end (paper-system-staff-extents line)))
(interval-end (paper-system-extent line Y))))
(define (line-ideal-relative-position line prev-line layout ignore-padding)
@@ -77,7 +83,7 @@
(first-line-position line layout)
;; not the first line on page
(max (line-minimum-distance prev-line line layout ignore-padding)
- (line-ideal-distance prev-line line layout ignore-padding))))
+ (line-ideal-distance prev-line line layout ignore-padding))))
(define (line-minimum-relative-position line prev-line layout ignore-padding)
"Return position of `line', relative to `prev-line' position.
@@ -88,8 +94,70 @@
;; not the first line on page
(line-minimum-distance prev-line line layout ignore-padding)))
+(define (page-maximum-space-to-fill page lines paper)
+ "Return the space between the first line top position and the last line
+ bottom position. This constitutes the maximum space to fill on `page'
+ with `lines'."
+ (let ((last-line (car (last-pair lines))))
+ (- (page-printable-height page)
+ (first-line-position (first lines) paper)
+ (ly:prob-property last-line
+ 'bottom-space 0.0)
+ (- (interval-start (paper-system-extent last-line Y))))))
+
+;;;
+;;; Utilities for distributing systems on a page
+;;;
+
+(define (space-systems space-to-fill lines ragged paper ignore-padding)
+ "Compute lines positions on page: return force and line positions as a pair.
+ force is #f if lines do not fit on page."
+ (let* ((empty-stencil (ly:make-stencil '() '(0 . 0) '(0 . 0)))
+ (empty-prob (ly:make-prob 'paper-system (list `(stencil .
,empty-stencil))))
+ (cdr-lines (append (cdr lines)
+ (if (<= (length lines) 1)
+ (list empty-prob)
+ '())))
+ (springs (map (lambda (prev-line line)
+ (list (line-ideal-distance prev-line line paper
ignore-padding)
+ (/ 1.0 (line-next-space prev-line line paper))))
+ lines
+ cdr-lines))
+ (rods (map (let ((i -1))
+ (lambda (prev-line line)
+ (set! i (1+ i))
+ (list i (1+ i)
+ (line-minimum-distance prev-line line paper
ignore-padding))))
+ lines
+ cdr-lines))
+ (space-result
+ (ly:solve-spring-rod-problem springs rods space-to-fill ragged)))
+ (cons (car space-result)
+ (map (let ((topskip (first-line-position (first lines) paper)))
+ (lambda (y)
+ (+ y topskip)))
+ (cdr space-result)))))
+
+(define (make-page-from-systems paper-book lines page-number ragged last)
+ "Return a new page, filled with `lines'."
+ (let* ((page (make-page paper-book
+ 'lines lines
+ 'page-number page-number
+ 'is-last last))
+ (posns (if (null? lines)
+ (list)
+ (let* ((paper (ly:paper-book-paper paper-book))
+ (space-to-fill (page-maximum-space-to-fill
+ page lines paper))
+ (spacing (space-systems space-to-fill lines ragged
paper #f)))
+ (if (or (not (car spacing)) (inf? (car spacing)))
+ (cdr (space-systems space-to-fill lines ragged paper
#t))
+ (cdr spacing))))))
+ (page-set-property! page 'configuration posns)
+ page))
+
;;;
-;;; Page breaking functions
+;;; Page breaking function
;;;
;; Optimal distribution of
@@ -109,77 +177,23 @@
done))
(define (combine-penalties force user best-paths
- inter-system-space force-equalization-factor)
+ inter-system-space force-equalization-factor)
(let* ((prev-force (if (null? best-paths)
- 0.0
- (page-force (car best-paths))))
- (prev-penalty (if (null? best-paths)
- 0.0
- (page-penalty (car best-paths))))
+ 0.0
+ (page-force (car best-paths))))
+ (prev-penalty (if (null? best-paths)
+ 0.0
+ (page-penalty (car best-paths))))
(relative-force (/ force inter-system-space))
(abs-relative-force (abs relative-force)))
(+ (* abs-relative-force (+ abs-relative-force 1))
prev-penalty
(* force-equalization-factor (/ (abs (- prev-force force))
- inter-system-space))
+ inter-system-space))
user)))
-(define (space-systems page-height lines ragged paper ignore-padding)
- "Compute lines positions on page: return force and line positions as a pair.
- force is #f if lines do not fit on page."
- (let* ((empty-stencil (ly:make-stencil '() '(0 . 0) '(0 . 0)))
- (empty-prob (ly:make-prob 'paper-system (list `(stencil .
,empty-stencil))))
- (cdr-lines (append (cdr lines)
- (if (<= (length lines) 1)
- (list empty-prob)
- '())))
- (springs (map (lambda (prev-line line)
- (list (line-ideal-distance prev-line line paper
ignore-padding)
- (/ 1.0 (line-next-space prev-line line paper))))
- lines
- cdr-lines))
- (rods (map (let ((i -1))
- (lambda (prev-line line)
- (set! i (1+ i))
- (list i (1+ i)
- (line-minimum-distance prev-line line paper
ignore-padding))))
- lines
- cdr-lines))
- (last-line (car (last-pair lines)))
- (topskip (first-line-position (first lines) paper))
- (space-to-fill (- page-height
- topskip
- (ly:prob-property last-line
- 'bottom-space 0.0)
- (- (interval-start (paper-system-extent
- last-line Y)))))
- (space-result
- (ly:solve-spring-rod-problem springs rods space-to-fill ragged)))
- (cons (car space-result)
- (map (lambda (y)
- (+ y topskip))
- (cdr space-result)))))
-
-(define (make-page-from-systems paper-book lines page-number ragged last)
- (let*
- ((page (make-page
- paper-book
- 'lines lines
- 'page-number page-number
- 'is-last last))
- (height (page-printable-height page))
- (posns (if (> (length lines) 0)
- (let* ((paper (ly:paper-book-paper paper-book))
- (spacing (space-systems height lines ragged paper #f)))
- (if (inf? (car spacing))
- (cdr (space-systems height lines ragged paper #t))
- (cdr spacing)))
- '())))
- (page-set-property! page 'configuration posns)
- page))
-
(define (walk-paths done-lines best-paths current-lines last current-best
- paper-book page-alist)
+ paper-book page-alist)
"Return the best optimal-page-break-node that contains
CURRENT-LINES. DONE-LINES.reversed ++ CURRENT-LINES is a consecutive
ascending range of lines, and BEST-PATHS contains the optimal breaks
@@ -187,76 +201,76 @@
CURRENT-BEST is the best result sofar, or #f."
(let* ((paper (ly:paper-book-paper paper-book))
- (this-page (make-page
- paper-book
- 'is-last last
- 'page-number (if (null? best-paths)
- (ly:output-def-lookup paper
'first-page-number)
- (1+ (page-page-number (first
best-paths))))))
- (ragged-all (eq? #t (ly:output-def-lookup paper 'ragged-bottom)))
- (ragged-last (eq? #t (ly:output-def-lookup paper
'ragged-last-bottom)))
- (ragged (or ragged-all (and ragged-last last)))
- (height (page-printable-height this-page))
- (vertical-spacing (space-systems height current-lines ragged paper
#f))
- (satisfied-constraints (car vertical-spacing))
- (force (if satisfied-constraints
- (if (and last ragged-last)
- 0.0
- satisfied-constraints)
- 10000))
- (positions (cdr vertical-spacing))
- (get-break-penalty (lambda (sys)
- (ly:prob-property sys 'penalty 0.0)))
- (user-nobreak-penalties (- (apply + (filter negative?
- (map get-break-penalty
- (cdr
current-lines))))))
- (user-penalty (+ (max (get-break-penalty (car current-lines)) 0.0)
- user-nobreak-penalties))
- (total-penalty (combine-penalties
- force user-penalty best-paths
- (ly:output-def-lookup paper 'between-system-space)
- (ly:output-def-lookup paper
'verticalequalizationfactor 0.3)))
- (new-best (if (or (not current-best)
- (and satisfied-constraints
- (< total-penalty (page-penalty current-best))))
- (begin
- (map (lambda (x)
- (page-set-property! this-page
- (car x)
- (cdr x)))
- (list (cons 'prev (if (null? best-paths)
- #f
- (car best-paths)))
- (cons 'lines current-lines)
- (cons 'force force)
- (cons 'configuration positions)
- (cons 'penalty total-penalty)))
- this-page)
- current-best)))
+ (this-page (make-page
+ paper-book
+ 'is-last last
+ 'page-number (if (null? best-paths)
+ (ly:output-def-lookup paper
'first-page-number)
+ (1+ (page-page-number (first
best-paths))))))
+ (ragged-all (eq? #t (ly:output-def-lookup paper 'ragged-bottom)))
+ (ragged-last (eq? #t (ly:output-def-lookup paper 'ragged-last-bottom)))
+ (ragged (or ragged-all (and ragged-last last)))
+ (space-to-fill (page-maximum-space-to-fill this-page current-lines
paper))
+ (vertical-spacing (space-systems space-to-fill current-lines ragged
paper #f))
+ (satisfied-constraints (car vertical-spacing))
+ (force (if satisfied-constraints
+ (if (and last ragged-last)
+ 0.0
+ satisfied-constraints)
+ 10000))
+ (positions (cdr vertical-spacing))
+ (get-break-penalty (lambda (sys)
+ (ly:prob-property sys 'penalty 0.0)))
+ (user-nobreak-penalties (- (apply + (filter negative?
+ (map get-break-penalty
+ (cdr
current-lines))))))
+ (user-penalty (+ (max (get-break-penalty (car current-lines)) 0.0)
+ user-nobreak-penalties))
+ (total-penalty (combine-penalties
+ force user-penalty best-paths
+ (ly:output-def-lookup paper 'between-system-space)
+ (ly:output-def-lookup paper
'verticalequalizationfactor 0.3)))
+ (new-best (if (or (not current-best)
+ (and satisfied-constraints
+ (< total-penalty (page-penalty current-best))))
+ (begin
+ (map (lambda (x)
+ (page-set-property! this-page
+ (car x)
+ (cdr x)))
+ (list (cons 'prev (if (null? best-paths)
+ #f
+ (car best-paths)))
+ (cons 'lines current-lines)
+ (cons 'force force)
+ (cons 'configuration positions)
+ (cons 'penalty total-penalty)))
+ this-page)
+ current-best)))
(if #f ;; debug
- (display
- (list
- "\nuser pen " user-penalty
- "\nsatisfied-constraints" satisfied-constraints
- "\nlast? " last "ragged?" ragged
- "\nis-better " is-better " total-penalty " total-penalty "\n"
- "\nconfig " positions
- "\nforce " force
- "\nlines: " current-lines "\n")))
+ (display
+ (list
+ "\nuser pen " user-penalty
+ "\nsatisfied-constraints" satisfied-constraints
+ "\nlast? " last "ragged?" ragged
+ "\nis-better " is-better " total-penalty " total-penalty "\n"
+ "\nconfig " positions
+ "\nforce " force
+ "\nlines: " current-lines "\n")))
(if #f ; debug
- (display (list "\nnew-best is " (page-lines new-best)
- "\ncontinuation of "
- (if (null? best-paths)
- "start"
- (page-lines (car best-paths))))))
+ (display (list "\nnew-best is " (page-lines new-best)
+ "\ncontinuation of "
+ (if (null? best-paths)
+ "start"
+ (page-lines (car best-paths))))))
(if (and (pair? done-lines)
- ;; if this page is too full, adding another line won't help
- satisfied-constraints)
- (walk-paths (cdr done-lines) (cdr best-paths)
- (cons (car done-lines) current-lines)
- last new-best
- paper-book page-alist)
- new-best)))
+ ;; if this page is too full, adding another line won't help
+ satisfied-constraints)
+ (walk-paths (cdr done-lines) (cdr best-paths)
+ (cons (car done-lines) current-lines)
+ last new-best
+ paper-book page-alist)
+ new-best)))
(define (walk-lines done best-paths todo paper-book page-alist)
"Return the best page breaking as a single
@@ -266,36 +280,36 @@
(if (null? todo)
(car best-paths)
(let* ((this-line (car todo))
- (last (null? (cdr todo)))
- (next (walk-paths done best-paths (list this-line) last #f
- paper-book page-alist)))
- (walk-lines (cons this-line done)
- (cons next best-paths)
- (cdr todo)
- paper-book
- page-alist))))
+ (last (null? (cdr todo)))
+ (next (walk-paths done best-paths (list this-line) last #f
+ paper-book page-alist)))
+ (walk-lines (cons this-line done)
+ (cons next best-paths)
+ (cdr todo)
+ paper-book
+ page-alist))))
(define-public (optimal-page-breaks paper-book)
"Return pages as a list starting with 1st page. Each page is a 'page Prob."
(let* ((paper (ly:paper-book-paper paper-book))
(lines (ly:paper-book-systems paper-book))
- (page-alist (layout->page-init paper))
- (force-equalization-factor (ly:output-def-lookup
- paper 'verticalequalizationfactor 0.3)))
+ (page-alist (layout->page-init paper))
+ (force-equalization-factor (ly:output-def-lookup
+ paper 'verticalequalizationfactor 0.3)))
(ly:message (_ "Calculating page breaks..."))
(let* ((best-break-node (walk-lines '() '() lines paper-book page-alist))
- (break-nodes (get-path best-break-node '())))
+ (break-nodes (get-path best-break-node '())))
(page-set-property! (car (last-pair break-nodes)) 'is-last #t)
(if #f; (ly:get-option 'verbose)
- (begin
- (display (list
- "\nbreaks: " (map (lambda (node)
- (ly:prob-property (car (page-lines
node))
- 'number))
- break-nodes)
- "\nsystems " (map page-lines break-nodes)
- "\npenalties " (map page-penalty break-nodes)
- "\nconfigs " (map page-configuration break-nodes)))))
+ (begin
+ (display (list
+ "\nbreaks: " (map (lambda (node)
+ (ly:prob-property (car (page-lines
node))
+ 'number))
+ break-nodes)
+ "\nsystems " (map page-lines break-nodes)
+ "\npenalties " (map page-penalty break-nodes)
+ "\nconfigs " (map page-configuration break-nodes)))))
;; construct page stencils.
(for-each page-stencil break-nodes)
(post-process-pages paper break-nodes)
- [patch] export functions from layout-page-layout.scm,
Nicolas Sceaux <=