scm/paper.scm

   1 ;;;; paper.scm -- manipulate the paper and layout block.
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7 (define-public (set-paper-dimension-variables mod)
   8   (module-define! mod 'dimension-variables
   9                   '(blot-diameter
  10                     bottom-margin
  11                     cm
  12                     foot-separation
  13                     head-separation
  14                     horizontal-shift
  15                     in
  16                     indent
  17                     ledger-line-thickness
  18                     left-margin
  19                     line-thickness
  20                     line-width
  21                     mm
  22                     paper-height
  23                     paper-width
  24                     pt
  25                     right-margin
  26                     short-indent
  27                     staff-height
  28                     staff-space
  29                     top-margin)))
  30
  31 (define (calc-line-thickness staff-space pt)
  32   ;; linear interpolation.
  33
  34   ;; !! synchronize with feta-params.mf
  35   (let*
  36     ((x1 (* 4.125 pt))
  37      (x0 (* 5 pt))
  38      (f1 (* 0.47 pt))
  39      (f0 (* 0.50 pt)))
  40
  41     (/
  42      (+
  43       (* f1 (- staff-space x0))
  44            (* f0 (- x1 staff-space)))
  45      (- x1 x0))))
  46
  47 (define-public (layout-set-absolute-staff-size-in-module module staff-height)
  48   (let*
  49       ((pt (eval 'pt module))
  50        (ss (/ staff-height 4))
  51        (factor (/ staff-height (* 20 pt)))
  52        (setm! (lambda (sym val)
  53                 (module-define! module sym val))))
  54
  55     (setm! 'text-font-size (* 12 factor))
  56
  57     (setm! 'output-scale ss)
  58     (setm! 'fonts (make-century-schoolbook-tree factor))
  59     (setm! 'staff-height staff-height)
  60     (setm! 'staff-space ss)
  61
  62     (setm! 'line-thickness (calc-line-thickness ss pt))
  63
  64     ;;  sync with feta
  65     (setm! 'ledger-line-thickness (+ (* 0.5 pt) (/ ss 10)))
  66
  67     ;;  sync with feta
  68     (setm! 'blot-diameter (* 0.4 pt))
  69     ))
  70
  71 (define-public (layout-set-absolute-staff-size sz)
  72   "Function to be called inside a \\layout{} block to set the staff
  73 size. SZ is in points"
  74   (layout-set-absolute-staff-size-in-module (current-module) sz))
  75
  76 (define-public (layout-set-staff-size sz)
  77   "Function to be called inside a \\layout{} block to set the staff
  78 size. SZ is in points"
  79
  80   (layout-set-absolute-staff-size (* (eval 'pt (current-module)) sz)))
  81
  82 (define-safe-public (set-global-staff-size sz)
  83   "Set the default staff size, where SZ is thought to be in PT."
  84   (let* ((current-mod (current-module))
  85          (parser (eval 'parser current-mod))
  86          (pap (ly:parser-lookup parser '$defaultpaper))
  87          (in-layout? (or (module-defined? current-mod 'is-paper)
  88                          (module-defined? current-mod 'is-layout)))
  89
  90          ; maybe not necessary.
  91          ; but let's be paranoid. Maybe someone still refers to the
  92          ; old one.
  93          (new-paper (ly:output-def-clone pap))
  94
  95          (new-scope (ly:output-def-scope new-paper)))
  96
  97     (if in-layout?
  98         (ly:warning (_ "set-global-staff-size: not in toplevel scope")))
  99
 100     (layout-set-absolute-staff-size-in-module new-scope
 101                                               (* sz (eval 'pt new-scope)))
 102     (module-define! current-mod '$defaultpaper new-paper)))
 103
 104 (define-public paper-alist
 105
 106   ;; don't use decimals.
 107   ;; ISO 216 has a tolerance of +- 2mm
 108
 109   '(("a10" . (cons (* 26 mm) (* 37 mm)))
 110     ("a9" . (cons (* 37 mm) (* 52 mm)))
 111     ("a8" . (cons (* 52 mm) (* 74 mm)))
 112     ("a7" . (cons (* 74 mm) (* 105 mm)))
 113     ("a6" . (cons (* 105 mm) (* 148 mm)))
 114     ("a5" . (cons (* 148 mm) (* 210 mm)))
 115     ("a4" . (cons (* 210 mm) (* 297 mm)))
 116     ("a3" . (cons (* 297 mm) (* 420 mm)))
 117     ("a2" . (cons (* 420 mm) (* 594 mm)))
 118     ("a1" . (cons (* 594 mm) (* 841 mm)))
 119     ("a0" . (cons (* 841 mm) (* 1189 mm)))
 120     ("b10" . (cons (* 31 mm) (* 44 mm)))
 121     ("b9" . (cons (* 44 mm) (* 62 mm)))
 122     ("b8" . (cons (* 62 mm) (* 88 mm)))
 123     ("b7" . (cons (* 88 mm) (* 125 mm)))
 124     ("b6" . (cons (* 125 mm) (* 176 mm)))
 125     ("b5" . (cons (* 176 mm) (* 250 mm)))
 126     ("b4" . (cons (* 250 mm) (* 353 mm)))
 127     ("b3" . (cons (* 353 mm) (* 500 mm)))
 128     ("b2" . (cons (* 500 mm) (* 707 mm)))
 129     ("b1" . (cons (* 707 mm) (* 1000 mm)))
 130     ("b0" . (cons (* 1000 mm) (* 1414 mm)))
 131     ;; Below are two extended sizes defined in DIn 476
 132     ("4a0" . (cons (* 1682 mm) (* 2378 mm)))
 133     ("2a0" . (cons (* 1189 mm) (* 1682 mm)))
 134     ;; Below are ISO 269 standard C series
 135     ("c10" . (cons (* 28 mm) (* 40 mm)))
 136     ("c9" . (cons (* 40 mm) (* 57 mm)))
 137     ("c8" . (cons (* 57 mm) (* 81 mm)))
 138     ("c7" . (cons (* 81 mm) (* 114 mm)))
 139     ("c6" . (cons (* 114 mm) (* 162 mm)))
 140     ("c5" . (cons (* 162 mm) (* 229 mm)))
 141     ("c4" . (cons (* 229 mm) (* 324 mm)))
 142     ("c3" . (cons (* 324 mm) (* 458 mm)))
 143     ("c2" . (cons (* 458 mm) (* 648 mm)))
 144     ("c1" . (cons (* 648 mm) (* 917 mm)))
 145     ("c0" . (cons (* 917 mm) (* 1297 mm)))
 146     ;; Below are North American paper sizes
 147     ("legal" . (cons (* 8.5 in) (* 14.0 in)))
 148     ("letter" . (cons (* 8.5 in) (* 11.0 in)))
 149     ;; Ledger (17x11) is a 90 degree rotation of Tabloid
 150     ("11x17" . (cons (* 11.0 in) (* 17.0 in)))
 151     ;; government-letter by IEEE Printer Working Group, for children's writing
 152     ("government-letter" . (cons (* 8 in) (* 10.5 in)))
 153     ("government-legal" . (cons (* 8.5 in) (* 13.0 in)))
 154     ("philippine-legal" . (cons (* 8.5 in) (* 13.0 in)))
 155     ;; ANSI sizes
 156     ("ansi a" . (cons (* 8.5 in) (* 11.0 in)))
 157     ("ansi b" . (cons (* 17.0 in) (* 11.0 in)))
 158     ("ansi c" . (cons (* 17.0 in) (* 22.0 in)))
 159     ("ansi d" . (cons (* 22.0 in) (* 34.0 in)))
 160     ("ansi e" . (cons (* 34.0 in) (* 44.0 in)))
 161     ("engineering f" . (cons (* 28.0 in) (* 40.0 in)))
 162     ;; G and H are very rare, and the lengths are variable up to 90 inches
 163     ;; North American Architectural sizes
 164     ("arch a" . (cons (* 9.0 in) (* 12.0 in)))
 165     ("arch b" . (cons (* 12.0 in) (* 18.0 in)))
 166     ("arch c" . (cons (* 18.0 in) (* 24.0 in)))
 167     ("arch d" . (cons (* 24.0 in) (* 36.0 in)))
 168     ("arch e" . (cons (* 36.0 in) (* 48.0 in)))
 169     ("arch e1" . (cons (* 30.0 in) (* 42.0 in)))
 170     ;; Other sizes
 171     ;; Some are antique sizes which are still using in UK
 172     ("statement" . (cons (* 5.5 in) (* 8.5 in)))
 173     ("half letter" . (cons (* 5.5 in) (* 8.5 in)))
 174     ("quarto" . (cons (* 8.0 in) (* 10.0 in)))
 175     ("octavo" . (cons (* 6.75 in) (* 10.5 in)))
 176     ("executive" . (cons (* 7.25 in) (* 10.5 in)))
 177     ("monarch" . (cons (* 7.25 in) (* 10.5 in)))
 178     ("foolscap" . (cons (* 8.27 in) (* 13.0 in)))
 179     ("folio" . (cons (* 8.27 in) (* 13.0 in)))
 180     ("super-b" . (cons (* 13.0 in) (* 19.0 in)))
 181     ("post" . (cons (* 15.5 in) (* 19.5 in)))
 182     ("crown" . (cons (* 15.0 in) (* 20.0 in)))
 183     ("large post" . (cons (* 16.5 in) (* 21.0 in)))
 184     ("demy" . (cons (* 17.5 in) (* 22.5 in)))
 185     ("medium" . (cons (* 18.0 in) (* 23.0 in)))
 186     ("broadsheet" . (cons (* 18.0 in) (* 24.0 in)))
 187     ("royal" . (cons (* 20.0 in) (* 25.0 in)))
 188     ("elephant" . (cons (* 23.0 in) (* 28.0 in)))
 189     ("double demy" . (cons (* 22.5 in) (* 35.0 in)))
 190     ("quad demy" . (cons (* 35.0 in) (* 45.0 in)))
 191     ("atlas" . (cons (* 26.0 in) (* 34.0 in)))
 192     ("imperial" . (cons (* 22.0 in) (* 30.0 in)))
 193     ("antiquarian" . (cons (* 31.0 in) (* 53.0 in)))
 194     ;; PA4 based sizes
 195     ("pa0" . (cons (* 840 mm) (* 1120 mm)))
 196     ("pa1" . (cons (* 560 mm) (* 840 mm)))
 197     ("pa2" . (cons (* 420 mm) (* 560 mm)))
 198     ("pa3" . (cons (* 280 mm) (* 420 mm)))
 199     ("pa4" . (cons (* 210 mm) (* 280 mm)))
 200     ("pa5" . (cons (* 140 mm) (* 210 mm)))
 201     ("pa6" . (cons (* 105 mm) (* 140 mm)))
 202     ("pa7" . (cons (* 70 mm) (* 105 mm)))
 203     ("pa8" . (cons (* 52 mm) (* 70 mm)))
 204     ("pa9" . (cons (* 35 mm) (* 52 mm)))
 205     ("pa10" . (cons (* 26 mm) (* 35 mm)))
 206     ;; F4 used in southeast Asia and Australia
 207     ("f4" . (cons (* 210 mm) (* 330 mm)))
 208    ))
 209
 210 ;; todo: take dimension arguments.
 211
 212 (define (set-paper-dimensions m w h)
 213   "M is a module (i.e. layout->scope_ )"
 214   (let* ((mm (eval 'mm m)))
 215     (module-define! m 'paper-width w)
 216     (module-define! m 'paper-height h)
 217     (module-define! m 'line-width (- w
 218                                      (ly:modules-lookup (list m) 'left-margin (* 10 mm))
 219                                      (ly:modules-lookup (list m) 'right-margin (* 10 mm))))
 220
 221     (module-define! m 'indent (/ w 14))
 222     (module-define! m 'short-indent 0)
 223
 224     ;; page layout - what to do with (printer specific!) margin settings?
 225
 226     ))
 227
 228 (define (internal-set-paper-size module name landscape?)
 229   (define (swap x)
 230     (cons (cdr x) (car x)))
 231
 232   (let* ((entry (assoc-get name paper-alist))
 233          (is-paper? (module-defined? module 'is-paper))
 234          (mm (eval 'mm module)))
 235
 236     (cond
 237      ((not is-paper?)
 238       (ly:warning (_ "This is not a \\layout {} object, ~S") module))
 239      (entry
 240
 241       (set! entry (eval entry module))
 242       (if landscape?
 243           (set! entry (swap entry)))
 244       (set-paper-dimensions module (car entry) (cdr entry))
 245
 246       (module-define! module 'papersizename name)
 247       (module-define! module 'landscape
 248                       (if landscape? #t #f)))
 249      (else
 250       (ly:warning (_ "Unknown paper size: ~a") name)))))
 251
 252 (define-safe-public (set-default-paper-size name . rest)
 253   (internal-set-paper-size
 254    (ly:output-def-scope (eval '$defaultpaper (current-module)))
 255    name
 256    (memq 'landscape rest)))
 257
 258 (define-public (set-paper-size name . rest)
 259   (if (module-defined? (current-module) 'is-paper)
 260       (internal-set-paper-size (current-module) name
 261                                (memq 'landscape rest))
 262
 263       ;;; TODO: should raise (generic) exception with throw, and catch
 264       ;;; that in parse-scm.cc
 265       (ly:warning (_ "Must use #(set-paper-size .. ) within \\paper { ... }"))))
 266
 267 (define-public (scale-layout pap scale)
 268   (let* ((new-pap (ly:output-def-clone pap))
 269          (dim-vars (ly:output-def-lookup pap 'dimension-variables))
 270          (old-scope (ly:output-def-scope pap))
 271          (scope (ly:output-def-scope new-pap)))
 272
 273     (for-each
 274      (lambda (v)
 275        (let* ((var (module-variable old-scope v))
 276               (val (if (variable? var) (variable-ref var) #f)))
 277
 278          (if (number? val)
 279              (module-define! scope v
 280                              (/ val scale))
 281
 282              ;; spurious warnings, eg. for paper-width, paper-height.
 283              ;; (ly:warning (_ "not a number, ~S = ~S " v  val))
 284              )))
 285
 286      dim-vars)
 287
 288     new-pap))