scm/page.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2006--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;
   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.
   9 ;;;;
  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.
  14 ;;;;
  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/>.
  17
  18 (define-module (scm page)
  19
  20   #:export (make-page
  21             page-property
  22             page-set-property!
  23             page-prev
  24             page-printable-height
  25             layout->page-init
  26             page-force
  27             page-penalty
  28             page-configuration
  29             page-lines
  30             page-page-number
  31             page-system-numbers
  32             page-stencil
  33             page-free-height
  34             page?
  35             ))
  36
  37 (use-modules (lily)
  38              (scm paper-system)
  39              (srfi srfi-1))
  40
  41
  42 (define (annotate? layout)
  43   (eq? #t (ly:output-def-lookup layout 'annotate-spacing)))
  44
  45
  46 (define page-module (current-module))
  47
  48 (define (make-page paper-book  . args)
  49   (let*
  50       ((p (apply ly:make-prob (append
  51                                (list 'page (layout->page-init (ly:paper-book-paper paper-book))
  52                                      'paper-book paper-book)
  53                                args))))
  54
  55     (page-set-property! p 'head-stencil (page-header p))
  56     (page-set-property! p 'foot-stencil (page-footer p))
  57
  58     p))
  59
  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))
  65
  66
  67 ;; define accessors.
  68 (for-each
  69  (lambda (j)
  70    (module-define!
  71     page-module
  72     (string->symbol (format #f "page-~a" j))
  73     (lambda (pg)
  74       (page-property pg j))))
  75
  76  '(page-number prev lines force penalty lines))
  77
  78 (define (page-system-numbers page)
  79   (map (lambda (ps) (ly:prob-property ps 'number))
  80        (page-lines page)))
  81
  82 (define (page-translate-systems page)
  83   (for-each
  84
  85    (lambda (sys-off)
  86      (let*
  87          ((sys (car sys-off))
  88           (off (cadr sys-off)))
  89
  90        (if (not (number? (ly:prob-property sys 'Y-offset)))
  91            (ly:prob-set-property! sys 'Y-offset off))))
  92
  93    (zip (page-property page 'lines)
  94         (page-property page 'configuration))))
  95
  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)
  99                   'top-markup-spacing
 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)))
 104
 105     (set! stencil
 106           (ly:stencil-add stencil
 107                           (ly:stencil-translate-axis
 108                            (annotate-spacing-spec layout
 109                                                   spacing-spec
 110                                                   (- top-margin)
 111                                                   (car header-extent)
 112                                                   #:base-color red)
 113                            X-offset X)))
 114     stencil))
 115
 116
 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)
 122                        (set! stencil
 123                              (ly:stencil-add stencil
 124                                              (ly:stencil-translate-axis y 6 X))))))
 125     (add-stencil
 126      (ly:stencil-translate-axis
 127       (annotate-y-interval layout "paper-height"
 128                            (cons (- paper-height) 0)
 129                            #t)
 130       1 X))
 131     (add-stencil
 132      (ly:stencil-translate-axis
 133       (annotate-y-interval layout "top-margin"
 134                            (cons (- top-margin) 0)
 135                            #t)
 136       2 X))
 137     (add-stencil
 138      (ly:stencil-translate-axis
 139       (annotate-y-interval layout "bottom-margin"
 140                            (cons (- paper-height) (- bottom-margin paper-height))
 141                            #t)
 142       2 X))
 143     stencil))
 144
 145 (define (annotate-space-left page)
 146   (let*
 147       ((paper-book (page-property page 'paper-book))
 148        (layout (ly:paper-book-paper paper-book))
 149        (arrow (annotate-y-interval layout
 150                                    "space left"
 151                                    (cons (- 0.0
 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))
 157                                                   0.0)))
 158                                          (page-property page  'bottom-system-edge))
 159                                    #t)))
 160
 161     (set! arrow (ly:stencil-translate-axis arrow 8 X))
 162
 163     arrow))
 164
 165
 166 (define (page-header-or-footer page dir)
 167   (let*
 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))
 174        (sym (if (= dir UP)
 175                 'make-header
 176                 'make-footer))
 177        (header-proc (ly:output-def-lookup layout sym)))
 178
 179     (if (procedure? header-proc)
 180         (header-proc layout scopes number is-last-bookpart is-bookpart-last-page)
 181         #f)))
 182
 183
 184 (define (page-header page)
 185   (page-header-or-footer page UP))
 186
 187 (define (page-footer page)
 188   (page-header-or-footer page DOWN))
 189
 190 (define (layout->page-init layout)
 191   "Alist of settings for page layout"
 192   (let*
 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))
 200        )
 201
 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)
 208       )))
 209
 210 (define (make-page-stencil page)
 211   "Construct a stencil representing the page from PAGE."
 212
 213
 214   (page-translate-systems page)
 215   (let*
 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))
 222
 223        ;; TODO: naming paper-height/paper-width not analogous to TeX.
 224
 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)
 231                                      #f))
 232
 233        (page-stencil (ly:make-stencil '()))
 234
 235        (last-system #f)
 236        (last-y 0.0)
 237        (add-to-page (lambda (stencil x y)
 238                       (set! page-stencil
 239                             (ly:stencil-add page-stencil
 240                                             (ly:stencil-translate stencil
 241                                                                   (cons
 242                                                                    (+ system-xoffset x)
 243                                                                    (- 0 y (prop 'top-margin)))
 244
 245                                                                   )))))
 246        (add-system
 247         (lambda (system)
 248           (let* ((stencil (paper-system-stencil system))
 249                  (y (ly:prob-property system 'Y-offset 0))
 250                  (is-title (paper-system-title?
 251                             system)))
 252             (add-to-page stencil
 253                          (ly:prob-property system 'X-offset 0.0)
 254                          y)
 255             (if (and (ly:stencil? system-separator-stencil)
 256                      last-system
 257                      (not (paper-system-title? system))
 258                      (not (paper-system-title? last-system)))
 259                 (add-to-page
 260                  system-separator-stencil
 261                  0
 262                  (average (- last-y
 263                              (car (paper-system-staff-extents last-system)))
 264                           (- y
 265                              (cdr (paper-system-staff-extents system))))))
 266             (set! last-system system)
 267             (set! last-y y))))
 268        (head (prop 'head-stencil))
 269        (foot (prop 'foot-stencil))
 270        )
 271
 272     (if (and
 273          (ly:stencil? head)
 274          (not (ly:stencil-empty? head)))
 275         (begin
 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))))
 280
 281     (if (and
 282          (annotate? layout)
 283          (pair? lines))
 284
 285         (begin
 286           (set! page-stencil (annotate-top-space (car lines) layout head page-stencil))
 287
 288           (for-each (lambda (sys next-sys)
 289                       (paper-system-annotate sys next-sys layout))
 290                     lines
 291                     (append (cdr lines) (list #f)))
 292           (paper-system-annotate-last (car (last-pair lines)) layout)))
 293
 294     (for-each add-system lines)
 295
 296
 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))
 305                                   0.0)))
 306
 307     (if (annotate? layout)
 308         (set! page-stencil
 309               (ly:stencil-add page-stencil
 310                               (annotate-space-left page))))
 311
 312     (if (and (ly:stencil? foot)
 313              (not (ly:stencil-empty? foot)))
 314         (set! page-stencil
 315               (ly:stencil-add
 316                page-stencil
 317                (ly:stencil-translate
 318                 foot
 319                 (cons 0
 320                       (+ (- (prop 'bottom-edge))
 321                          (- (car (ly:stencil-extent foot Y)))))))))
 322
 323     (if (ly:output-def-lookup layout 'two-sided #f)
 324         (set! page-stencil
 325               (ly:stencil-translate page-stencil
 326                                     (cons (prop (if (even? number)
 327                                                     'left-margin
 328                                                     'right-margin))
 329                                           0)))
 330         (set! page-stencil
 331               (ly:stencil-translate page-stencil (cons (prop 'left-margin) 0))))
 332
 333     ;; annotation.
 334     (if (annotate? layout)
 335         (set! page-stencil (annotate-page layout page-stencil)))
 336
 337     page-stencil))
 338
 339
 340 (define-public (page-stencil page)
 341   (if (not (ly:stencil? (page-property page 'stencil)))
 342
 343       ;; todo: make tweakable.
 344       ;; via property + callbacks.
 345
 346       (page-set-property! page 'stencil (make-page-stencil page)))
 347   (page-property page 'stencil))
 348
 349 (define (calc-printable-height page)
 350   "Printable area for music and titles; matches default-page-make-stencil."
 351   (let*
 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)))
 357
 358        (head (page-property page 'head-stencil))
 359        (foot (page-property page 'foot-stencil))
 360        (available
 361         (- h (if (ly:stencil? head)
 362                  (interval-length (ly:stencil-extent head Y))
 363                  0)
 364            (if (ly:stencil? foot)
 365                (interval-length (ly:stencil-extent foot Y))
 366                0))))
 367
 368     ;; (display (list "\n available" available head foot))
 369     available))
 370
 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)))
 374
 375   (page-property page 'printable-height))