;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; Copyright (C) 2004--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;;;; it under the terms of the GNU General Public License as published by
;;;; You should have received a copy of the GNU General Public License
;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+; for define-safe-public when byte-compiling using Guile V2
+(use-modules (scm safe-utility-defs))
+
(define-public (set-paper-dimension-variables mod)
(module-define! mod 'dimension-variables
'(blot-diameter
bottom-margin
cm
+ footnote-footer-padding
+ footnote-padding
horizontal-shift
in
indent
))
(define-public (layout-set-absolute-staff-size sz)
- "Function to be called inside a \\layout{} block to set the staff
-size. SZ is in points"
+ "Set the absolute staff size inside of a @code{\\layout@{@}} block.
+@var{sz} is in points."
(layout-set-absolute-staff-size-in-module (current-module) sz))
(define-public (layout-set-staff-size sz)
- "Function to be called inside a \\layout{} block to set the staff
-size. SZ is in points"
+ "Set the staff size inside of a @code{\\layout@{@}} block.
+@var{sz} is in points."
(layout-set-absolute-staff-size (* (eval 'pt (current-module)) sz)))
;; don't use decimals.
;; ISO 216 has a tolerance of +- 2mm
+ ;; TODO Autogenerate the following list so it appears under the
+ ;; 'Predefined paper sizes' node in notation-appendices.itely
+ ;; currently the list below has been copied and formatted manually.
+ ;; Therefore, please add any new entries to the *itely file as well.
+
'(("a10" . (cons (* 26 mm) (* 37 mm)))
("a9" . (cons (* 37 mm) (* 52 mm)))
("a8" . (cons (* 52 mm) (* 74 mm)))
("c1" . (cons (* 648 mm) (* 917 mm)))
("c0" . (cons (* 917 mm) (* 1297 mm)))
;; Below are North American paper sizes
+ ("junior-legal" . (cons (* 8.0 in) (* 5.0 in)))
("legal" . (cons (* 8.5 in) (* 14.0 in)))
("letter" . (cons (* 8.5 in) (* 11.0 in)))
;; Ledger (17x11) is a 90 degree rotation of Tabloid
+ ("17x11" . (cons (* 17.0 in) (* 11.0 in)))
+ ("ledger" . (cons (* 17.0 in) (* 11.0 in)))
+ ;; Tabloid (11x17)
("11x17" . (cons (* 11.0 in) (* 17.0 in)))
+ ("tabloid" . (cons (* 11.0 in) (* 17.0 in)))
;; government-letter by IEEE Printer Working Group, for children's writing
("government-letter" . (cons (* 8 in) (* 10.5 in)))
("government-legal" . (cons (* 8.5 in) (* 13.0 in)))
))
;; todo: take dimension arguments.
-
-(define (set-paper-dimensions m w h)
+(define (lookup-paper-name module name landscape?)
+ "Look up @var{name} and return a number pair of width and height,
+where @var{landscape?} specifies whether the dimensions should be swapped
+unless explicitly overriden in the name."
+ (let* ((swapped?
+ (cond ((string-suffix? "landscape" name)
+ (set! name
+ (string-trim-right (string-drop-right name 9)))
+ #t)
+ ((string-suffix? "portrait" name)
+ (set! name
+ (string-trim-right (string-drop-right name 8)))
+ #f)
+ (else landscape?)))
+ (is-paper? (module-defined? module 'is-paper))
+ (entry (and is-paper?
+ (eval-carefully (assoc-get name paper-alist)
+ module
+ #f))))
+ (and entry is-paper?
+ (if swapped? (cons (cdr entry) (car entry)) entry))))
+
+(define (set-paper-dimensions m w h landscape?)
"M is a module (i.e. layout->scope_ )"
(let*
;; page layout - what to do with (printer specific!) margin settings?
- ((paper-default (eval-carefully
- (assoc-get
- (ly:get-option 'paper-size)
- paper-alist
- #f
- #t)
- m
- (cons w h)))
- ;; Horizontal margins, marked with 'preserve, are stored
+ ((paper-default (or (lookup-paper-name
+ m (ly:get-option 'paper-size) landscape?)
+ (cons w h)))
+ ;; Horizontal margins, marked with #t in the cddr, are stored
;; in renamed variables because they must not be overwritten.
+ ;; The cadr indicates whether a value is a vertical dimension.
;; Output_def::normalize () needs to know
;; whether the user set the value or not.
- (scaleable-values `((("left-margin" . ,w) . preserve)
- (("right-margin" . ,w) . preserve)
- (("inner-margin" . ,w) . preserve)
- (("outer-margin" . ,w) . preserve)
- (("binding-offset" . ,w) . '())
- (("top-margin" . ,h) . '())
- (("bottom-margin" . ,h) . '())
- (("indent" . ,w) . '())
- (("short-indent" . ,w) . '())))
+ (scaleable-values '(("left-margin" #f . #t)
+ ("right-margin" #f . #t)
+ ("inner-margin" #f . #t)
+ ("outer-margin" #f . #t)
+ ("binding-offset" #f . #f)
+ ("top-margin" #t . #f)
+ ("bottom-margin" #t . #f)
+ ("indent" #f . #f)
+ ("short-indent" #f . #f)))
(scaled-values
(map
(lambda (entry)
(let ((entry-symbol
(string->symbol
- (string-append (caar entry) "-default")))
- (orientation (cdar entry)))
- (if paper-default
- (cons (if (eq? (cdr entry) 'preserve)
- (string-append (caar entry) "-default-scaled")
- (caar entry))
- (round (* orientation
- (/ (eval-carefully entry-symbol m 0)
- (if (= orientation w)
- (car paper-default)
- (cdr paper-default))))))
- entry)))
- scaleable-values)))
+ (string-append (car entry) "-default")))
+ (vertical? (cadr entry)))
+ (cons (if (cddr entry)
+ (string-append (car entry) "-default-scaled")
+ (car entry))
+ (round (* (if vertical? h w)
+ (/ (eval-carefully entry-symbol m 0)
+ ((if vertical? cdr car)
+ paper-default)))))))
+ scaleable-values)))
(module-define! m 'paper-width w)
(module-define! m 'paper-height h)
scaled-values)))
(define (internal-set-paper-size module name landscape?)
- (define (swap x)
- (cons (cdr x) (car x)))
-
- (let* ((entry (assoc-get name paper-alist))
- (is-paper? (module-defined? module 'is-paper))
- (mm (eval 'mm module)))
-
+ (let* ((entry (lookup-paper-name module name landscape?))
+ (is-paper? (module-defined? module 'is-paper)))
(cond
((not is-paper?)
(ly:warning (_ "This is not a \\layout {} object, ~S") module))
(entry
-
- (set! entry (eval entry module))
- (if landscape?
- (set! entry (swap entry)))
- (set-paper-dimensions module (car entry) (cdr entry))
-
+ (set-paper-dimensions module (car entry) (cdr entry) landscape?)
+
(module-define! module 'papersizename name)
(module-define! module 'landscape
(if landscape? #t #f)))
(ly:warning (_ "Unknown paper size: ~a") name)))))
(define-safe-public (set-default-paper-size name . rest)
- (internal-set-paper-size
- (ly:output-def-scope (eval '$defaultpaper (current-module)))
- name
- (memq 'landscape rest)))
+ (let* ((pap (module-ref (current-module) '$defaultpaper))
+ (new-paper (ly:output-def-clone pap))
+ (new-scope (ly:output-def-scope new-paper)))
+ (internal-set-paper-size
+ new-scope
+ name
+ (memq 'landscape rest))
+ (module-set! (current-module) '$defaultpaper new-paper)))
(define-public (set-paper-size name . rest)
(if (module-defined? (current-module) 'is-paper)
projects / lilypond.git / blobdiff