scm/paper.scm

   1 ;;;; paper.scm -- manipulate the paper block.
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7
   8 (define-public (paper-set-staff-size sz)
   9   "Function to be called inside a \\paper{} block to set the staff size."
  10   (let* ((m (current-module))
  11          (ss (/ sz 4))
  12          (pt (eval 'pt m))
  13          (mm (eval 'mm m)))
  14
  15     (module-define! m 'fonts (make-cmr-tree (/  sz (* 20 pt))))
  16
  17     (module-define! m 'staffheight sz)
  18     (module-define! m 'staff-space ss)
  19     (module-define! m 'staffspace ss)
  20
  21
  22     ;; !! synchronize with feta-params.mf
  23     (module-define! m 'linethickness (+ (* 0.3 pt) (* 0.04 ss)))
  24     (module-define! m 'outputscale ss)
  25     (module-define! m 'ledgerlinethickness (+ (* 0.5 pt) (/ ss 10)))
  26     (module-define! m 'blotdiameter (* 0.35 pt))
  27     (module-define! m 'interscoreline (* 4 mm))))
  28
  29 (define-public (set-global-staff-size sz)
  30   "Set the default staff size, where SZ is thought to be in PT."
  31   (let* ((old-mod (current-module))
  32          (pap (eval '$defaultpaper old-mod))
  33          (is-paper? (module-defined? old-mod '$defaultpaper))
  34
  35
  36          ;; Huh? Why is it necessary to clone object?
  37          (new-paper (ly:output-def-clone pap))
  38          (new-scope (ly:output-def-scope new-paper)))
  39     (if (not is-paper?)
  40         (ly:warn "Not in toplevel scope"))
  41     (set-current-module new-scope)
  42     (paper-set-staff-size (* sz (eval 'pt new-scope)))
  43     (set-current-module old-mod)
  44     (module-define! old-mod '$defaultpaper new-paper)))
  45
  46 (define paper-alist
  47   '(("a6" . (cons (* 105 mm) (* 148.95 mm)))
  48     ("a5" . (cons (* 148.95 mm) (* 210 mm)))
  49     ("a4" . (cons (* 210 mm) (* 297.9 mm)))
  50     ("a3" . (cons (* 297.9 mm) (* 420 mm)))
  51     ("legal" . (cons (* 8.5 in) (* 14.0 in)))
  52     ("letter" . (cons (* 8.5 in) (* 11.0 in)))
  53     ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))))
  54
  55 ;; todo: take dimension arguments.
  56
  57 (define (set-paper-dimensions m w h)
  58   "M is a module (i.e. paper->scope_ )"
  59   (let* ((mm (eval 'mm m)))
  60     (module-define! m 'hsize w)
  61     (module-define! m 'vsize h)
  62     (module-define! m 'linewidth (- w (* 20 mm)))
  63     (module-define! m 'indent (/ w 14))
  64
  65     ;; page layout - what to do with (printer specific!) margin settings?
  66     (module-define! m 'top-margin (* 5 mm))
  67     (module-define! m 'bottom-margin (* 6 mm))
  68     (module-define! m 'head-sep (* 4 mm))
  69     (module-define! m 'foot-sep (* 4 mm))))
  70
  71
  72
  73 (define (internal-set-paper-size module name)
  74   (let* ((entry (assoc name paper-alist))
  75          (is-paper? (module-defined? module '$is-paper))
  76          (mm (eval 'mm module)))
  77
  78     (cond
  79      ((not is-paper?)
  80       (ly:warning "This is not a \\paper {} object:")
  81       (display module))
  82      ((pair? entry)
  83       (set! entry (eval  (cdr entry) module))
  84           (set-paper-dimensions module (car entry) (cdr entry))
  85           (module-define! module 'papersize name)
  86           (module-define! module 'papersizename name)
  87           (set-paper-dimensions module (car entry) (cdr entry)))
  88      (else
  89       (ly:warn (string-append "Unknown papersize: " name))))
  90
  91     ))
  92
  93 (define-public (set-default-paper-size name)
  94   (internal-set-paper-size (ly:output-def-scope (eval '$defaultpaper (current-module)))
  95                            name))
  96
  97 (define-public (set-paper-size name)
  98   (if (module-defined? (current-module) '$is-paper)
  99       (internal-set-paper-size (current-module) name)
 100
 101       ;;; TODO: should raise (generic) exception with throw, and catch
 102       ;;; that in parse-scm.cc
 103       (ly:warn "Must use #(set-paper-size .. ) within \\paper { ... }")))