scm/page.scm

   1 ;;
   2 ;; page.scm -- implement Page stuff.
   3 ;;
   4 ;; source file of the GNU LilyPond music typesetter
   5 ;;
   6 ;; (c) 2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 ;;
   8
   9 (define-module (scm page)
  10
  11   #:export (make-page
  12             page-property
  13             page-set-property!
  14             page-prev
  15             page-printable-height
  16             layout->page-init
  17             page-lines
  18             page-force
  19             page-penalty
  20             page-configuration
  21             page-lines
  22             page-page-number
  23             page-system-numbers
  24             page-stencil
  25             page-free-height
  26             page?
  27             ))
  28
  29 (use-modules (lily)
  30              (scm paper-system)
  31              (srfi srfi-1))
  32
  33
  34 (define (annotate? layout)
  35   (eq? #t (ly:output-def-lookup layout 'annotatespacing)))
  36
  37
  38 (define page-module (current-module))
  39
  40 (define (make-page init  . args)
  41   (let*
  42       ((p (apply ly:make-prob (append
  43                                (list 'page init)
  44                                args))))
  45
  46     (page-set-property! p 'head-stencil (page-header p))
  47     (page-set-property! p 'foot-stencil (page-footer p))
  48
  49     p))
  50
  51 (define page-property ly:prob-property)
  52 (define page-set-property! ly:prob-set-property!)
  53 (define (page-property? page sym)
  54   (eq? #t (page-property page sym)))
  55 (define (page? x)  (ly:prob-type? x 'page))
  56
  57
  58 ;; define accessors.
  59 (for-each
  60  (lambda (j)
  61    (module-define!
  62     page-module
  63     (string->symbol (format "page-~a" j))
  64     (lambda (pg)
  65       (page-property pg j))))
  66
  67  '(page-number prev lines force penalty lines))
  68
  69 (define (page-system-numbers page)
  70   (map (lambda (ps) (ly:prob-property ps 'number))
  71        (page-lines page)))
  72
  73 (define (page-translate-systems page)
  74   (for-each
  75
  76    (lambda (sys-off)
  77      (let*
  78          ((sys (car sys-off))
  79           (off (cadr sys-off)))
  80
  81        (if (not (number? (ly:prob-property sys 'Y-offset)))
  82            (ly:prob-set-property! sys 'Y-offset off))))
  83
  84    (zip (page-property page 'lines)
  85         (page-property page 'configuration))))
  86
  87 (define (annotate-page layout stencil)
  88   (let*
  89       ((topmargin (ly:output-def-lookup layout 'topmargin))
  90        (vsize (ly:output-def-lookup layout 'vsize))
  91        (bottommargin (ly:output-def-lookup layout 'bottommargin))
  92        (add-stencil (lambda (y)
  93                       (set! stencil
  94                             (ly:stencil-add stencil y))
  95                       )))
  96
  97     (add-stencil
  98      (ly:stencil-translate-axis
  99       (annotate-y-interval layout "vsize"
 100                            (cons (- vsize) 0)
 101                            #t)
 102       1 X))
 103
 104
 105     (add-stencil
 106      (ly:stencil-translate-axis
 107       (annotate-y-interval layout "topmargin"
 108                            (cons (- topmargin) 0)
 109                            #t)
 110       2 X))
 111
 112     (add-stencil
 113      (ly:stencil-translate-axis
 114       (annotate-y-interval layout "bottommargin"
 115                            (cons (- vsize) (- bottommargin vsize))
 116                            #t)
 117       2 X))
 118
 119     stencil))
 120
 121 (define (annotate-space-left page)
 122   (let*
 123       ((p-book (page-property page 'paper-book))
 124        (layout (ly:paper-book-paper p-book))
 125        (arrow (annotate-y-interval layout
 126                                    "space left"
 127                                    (cons (- (page-property page 'bottom-edge))
 128                                          (page-property page  'bottom-system-edge))
 129                                    #t)))
 130
 131     (set! arrow (ly:stencil-translate-axis arrow 8 X))
 132
 133     arrow))
 134
 135 \f
 136
 137
 138 (define (page-headfoot layout scopes number
 139                        sym separation-symbol dir last?)
 140
 141   "Create a stencil including separating space."
 142
 143   (let* ((header-proc (ly:output-def-lookup layout sym))
 144          (sep (ly:output-def-lookup layout separation-symbol))
 145          (stencil (ly:make-stencil "" '(0 . 0) '(0 . 0)))
 146          (head-stencil
 147           (if (procedure? header-proc)
 148               (header-proc layout scopes number last?)
 149               #f))
 150          )
 151
 152     (if (and (number? sep)
 153              (ly:stencil? head-stencil)
 154              (not (ly:stencil-empty? head-stencil)))
 155
 156         (begin
 157           (set! head-stencil
 158                 (ly:stencil-combine-at-edge
 159                  stencil Y dir head-stencil
 160                  sep 0.0))
 161
 162
 163           ;; add arrow markers
 164           (if (or (annotate? layout)
 165                   (ly:output-def-lookup layout 'annotateheaders #f))
 166               (set! head-stencil
 167                     (ly:stencil-add
 168                      (ly:stencil-translate-axis
 169                       (annotate-y-interval layout
 170                                            (symbol->string separation-symbol)
 171                                            (cons (min 0 (* dir sep))
 172                                                  (max 0 (* dir sep)))
 173                                            #t)
 174                       (/ (ly:output-def-lookup layout 'linewidth) 2)
 175                       X)
 176                      (if (= dir UP)
 177                          (ly:stencil-translate-axis
 178                           (annotate-y-interval layout
 179                                               "pagetopspace"
 180                                               (cons
 181                                                (- (min 0 (* dir sep))
 182                                                   (ly:output-def-lookup layout 'pagetopspace))
 183                                                (min 0 (* dir sep)))
 184                                               #t)
 185                           (+ 7 (interval-center (ly:stencil-extent head-stencil X))) X)
 186                          empty-stencil
 187                          )
 188                      head-stencil
 189                      ))
 190               )))
 191
 192     head-stencil))
 193
 194 (define (page-header-or-footer page dir)
 195     (let*
 196       ((p-book (page-property page 'paper-book))
 197        (layout (ly:paper-book-paper p-book))
 198        (scopes (ly:paper-book-scopes p-book))
 199        (lines (page-lines page))
 200        (number (page-page-number page))
 201        (last? (page-property page 'is-last))
 202        )
 203
 204       (page-headfoot layout scopes number
 205                 (if (= dir UP)
 206                     'make-header
 207                     'make-footer)
 208                 (if (= dir UP)
 209                     'headsep
 210                     'footsep)
 211                 dir last?)))
 212
 213 (define (page-header page)
 214   (page-header-or-footer page UP))
 215
 216 (define (page-footer page)
 217   (page-header-or-footer page DOWN))
 218
 219 (define (layout->page-init layout)
 220   "Alist of settings for page layout"
 221   (let*
 222       ((vsize (ly:output-def-lookup layout 'vsize))
 223        (hsize (ly:output-def-lookup layout 'hsize))
 224
 225        (lmargin (ly:output-def-lookup layout 'leftmargin))
 226        (leftmargin (if lmargin
 227                        lmargin
 228                        (/ (- hsize
 229                              (ly:output-def-lookup layout 'linewidth)) 2)))
 230
 231        (bottom-edge (- vsize
 232                        (ly:output-def-lookup layout 'bottommargin)))
 233        (top-margin (ly:output-def-lookup layout 'topmargin))
 234        )
 235
 236     `((vsize . ,vsize)
 237       (hsize . ,hsize)
 238       (left-margin . ,leftmargin)
 239       (top-margin . ,top-margin)
 240       (bottom-edge . ,bottom-edge)
 241       )))
 242
 243 (define (make-page-stencil page)
 244   "Construct a stencil representing the page from LINES.
 245
 246  Offsets is a list of increasing numbers. They must be negated to
 247 create offsets.
 248 "
 249
 250
 251
 252   (page-translate-systems page)
 253   (let*
 254       ((p-book (page-property page 'paper-book))
 255        (prop (lambda (sym) (page-property page sym)))
 256        (layout (ly:paper-book-paper p-book))
 257        (scopes (ly:paper-book-scopes p-book))
 258        (lines (page-lines page))
 259        (number (page-page-number page))
 260
 261        ;; TODO: naming vsize/hsize not analogous to TeX.
 262
 263
 264        (system-xoffset (ly:output-def-lookup layout 'horizontalshift 0.0))
 265        (system-separator-markup (ly:output-def-lookup layout 'systemSeparatorMarkup))
 266        (system-separator-stencil (if (markup? system-separator-markup)
 267                                      (interpret-markup layout
 268                                                        (layout-extract-page-properties layout)
 269                                                        system-separator-markup)
 270                                      #f))
 271
 272        (head-height (if (ly:stencil? (prop 'head-stencil))
 273                         (interval-length (ly:stencil-extent (prop 'head-stencil) Y))
 274                         0.0))
 275
 276        (page-stencil (ly:make-stencil
 277                       '()
 278                       (cons (prop 'left-margin) (prop 'hsize))
 279                       (cons (- (prop 'top-margin)) 0)))
 280
 281        (last-system #f)
 282        (last-y 0.0)
 283        (add-to-page (lambda (stencil x y)
 284                       (set! page-stencil
 285                             (ly:stencil-add page-stencil
 286                                             (ly:stencil-translate stencil
 287                                                                   (cons
 288                                                                    (+ system-xoffset x)
 289                                                                    (- 0 head-height y (prop 'top-margin)))
 290
 291                                                                   )))))
 292        (add-system
 293         (lambda (system)
 294           (let* ((stencil (paper-system-stencil system))
 295                  (y (ly:prob-property system 'Y-offset))
 296                  (is-title (paper-system-title?
 297                             system)))
 298             (add-to-page stencil
 299                          (ly:prob-property system 'X-offset 0.0)
 300                          y)
 301             (if (and (ly:stencil? system-separator-stencil)
 302                      last-system
 303                      (not (paper-system-title? system))
 304                      (not (paper-system-title? last-system)))
 305                 (add-to-page
 306                  system-separator-stencil
 307                  0
 308                  (average (- last-y
 309                              (car (paper-system-staff-extents last-system)))
 310                           (- y
 311                              (cdr (paper-system-staff-extents system))))))
 312             (set! last-system system)
 313             (set! last-y y))))
 314        (head (prop 'head-stencil))
 315        (foot (prop 'foot-stencil))
 316        )
 317
 318     (if (or (annotate? layout)
 319             (ly:output-def-lookup layout 'annotatesystems #f))
 320
 321         (begin
 322           (for-each (lambda (sys) (paper-system-annotate sys layout))
 323                     lines)
 324           (paper-system-annotate-last (car (last-pair lines)) layout)))
 325
 326     (set! page-stencil (ly:stencil-combine-at-edge
 327                         page-stencil Y DOWN
 328                         (if (and
 329                              (ly:stencil? head)
 330                              (not (ly:stencil-empty? head)))
 331                             head
 332                             (ly:make-stencil "" (cons 0 0) (cons 0 0)))
 333                             0. 0.))
 334
 335     (map add-system lines)
 336
 337     (ly:prob-set-property! page 'bottom-system-edge
 338                            (car (ly:stencil-extent page-stencil Y)))
 339     (ly:prob-set-property! page 'space-left
 340                            (car (ly:stencil-extent page-stencil Y)))
 341
 342     (if (annotate? layout)
 343         (set! page-stencil
 344               (ly:stencil-add page-stencil
 345                               (annotate-space-left page))))
 346
 347     (if (and (ly:stencil? foot)
 348              (not (ly:stencil-empty? foot)))
 349         (set! page-stencil
 350               (ly:stencil-add
 351                page-stencil
 352                (ly:stencil-translate
 353                 foot
 354                 (cons 0
 355                       (+ (- (prop 'bottom-edge))
 356                          (- (car (ly:stencil-extent foot Y)))))))))
 357
 358     (set! page-stencil
 359           (ly:stencil-translate page-stencil (cons (prop 'left-margin) 0)))
 360
 361     ;; annotation.
 362     (if (or (annotate? layout)
 363             (ly:output-def-lookup layout 'annotatepage #f))
 364         (set! page-stencil (annotate-page layout page-stencil)))
 365
 366     page-stencil))
 367
 368
 369 (define (page-stencil page)
 370   (if (not (ly:stencil? (page-property page 'stencil)))
 371
 372       ;; todo: make tweakable.
 373       ;; via property + callbacks.
 374
 375       (page-set-property! page 'stencil (make-page-stencil page)))
 376   (page-property page 'stencil))
 377
 378 (define (calc-printable-height page)
 379   "Printable area for music and titles; matches default-page-make-stencil."
 380   (let*
 381       ((p-book (page-property page 'paper-book))
 382        (layout (ly:paper-book-paper p-book))
 383        (scopes (ly:paper-book-scopes p-book))
 384        (number (page-page-number page))
 385        (last? (page-property page 'is-last))
 386        (h (- (ly:output-def-lookup layout 'vsize)
 387                (ly:output-def-lookup layout 'topmargin)
 388                (ly:output-def-lookup layout 'bottommargin)))
 389
 390        (head (page-property page 'head-stencil))
 391        (foot (page-property page 'foot-stencil))
 392        (available
 393         (- h (if (ly:stencil? head)
 394                  (interval-length (ly:stencil-extent head Y))
 395                  0)
 396            (if (ly:stencil? foot)
 397                (interval-length (ly:stencil-extent foot Y))
 398                0))))
 399
 400     ;; (display (list "\n available" available head foot))
 401     available))
 402
 403 (define (page-printable-height page)
 404   (if (not (number? (page-property page 'printable-height)))
 405       (page-set-property! page 'printable-height (calc-printable-height page)))
 406
 407   (page-property page 'printable-height))
 408