X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fpaper.scm;h=b036ceb179b2139ebfabfadbd9917e8575f8dac4;hb=abf0836f8aab813d08b6981413dc9f83eff0b70f;hp=0b5a60ec8d3371dd23275081dcddc0e164213681;hpb=c9390a3d527175be064c0e2cd612139ee8fe3d7a;p=lilypond.git diff --git a/scm/paper.scm b/scm/paper.scm index 0b5a60ec8d..b036ceb179 100644 --- a/scm/paper.scm +++ b/scm/paper.scm @@ -1,25 +1,43 @@ -;;;; paper.scm -- manipulate the paper and layout block. +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter +;;;; Copyright (C) 2004--2012 Han-Wen Nienhuys ;;;; -;;;; (c) 2004--2009 Han-Wen Nienhuys +;;;; LilyPond is free software: you can redistribute it and/or modify +;;;; it under the terms of the GNU General Public License as published by +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . + +; 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 - foot-separation - head-separation + footnote-footer-padding + footnote-padding horizontal-shift in indent + inner-margin + inner-margin-default-scaled ledger-line-thickness left-margin left-margin-default-scaled line-thickness line-width mm + outer-margin + outer-margin-default-scaled paper-height paper-width pt @@ -35,15 +53,15 @@ ;; !! synchronize with feta-params.mf (let* - ((x1 (* 4.125 pt)) - (x0 (* 5 pt)) - (f1 (* 0.47 pt)) - (f0 (* 0.50 pt))) + ((x1 (* 4.125 pt)) + (x0 (* 5 pt)) + (f1 (* 0.47 pt)) + (f0 (* 0.50 pt))) (/ (+ (* f1 (- staff-space x0)) - (* f0 (- x1 staff-space))) + (* f0 (- x1 staff-space))) (- x1 x0)))) (define-public (layout-set-absolute-staff-size-in-module module staff-height) @@ -54,7 +72,9 @@ (setm! (lambda (sym val) (module-define! module sym val)))) - (setm! 'text-font-size (* 12 factor)) + ;; Synchronized with the `text-font-size' + ;; binding in add-pango-fonts (see font.scm). + (setm! 'text-font-size (* 11 factor)) (setm! 'output-scale ss) (setm! 'fonts (make-century-schoolbook-tree factor)) @@ -71,13 +91,13 @@ )) (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))) @@ -89,9 +109,9 @@ size. SZ is in points" (in-layout? (or (module-defined? current-mod 'is-paper) (module-defined? current-mod 'is-layout))) - ; maybe not necessary. - ; but let's be paranoid. Maybe someone still refers to the - ; old one. + ;; maybe not necessary. + ;; but let's be paranoid. Maybe someone still refers to the + ;; old one. (new-paper (ly:output-def-clone pap)) (new-scope (ly:output-def-scope new-paper))) @@ -207,68 +227,68 @@ size. SZ is in points" ("pa10" . (cons (* 26 mm) (* 35 mm))) ;; F4 used in southeast Asia and Australia ("f4" . (cons (* 210 mm) (* 330 mm))) - )) + ;; Used for very small @lilypond examples in the Documentation + ;; based on a8 size but landscape not portrait + ("a8landscape" . (cons (* 74 mm) (* 52 mm))) + )) -; todo: take dimension arguments. +;; todo: take dimension arguments. (define (set-paper-dimensions m w h) "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 + ;; 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))) - (scaleable-values `(("left-margin" . ,w) - ("right-margin" . ,w) - ("top-margin" . ,h) - ("bottom-margin" . ,h) - ("head-separation" . ,h) - ("foot-separation" . ,h) - ("indent" . ,w) - ("short-indent" . ,w))) - (scaled-values - (map + m + (cons w h))) + ;; Horizontal margins, marked with 'preserve, are stored + ;; in renamed variables because they must not be overwritten. + ;; 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) . '()))) + (scaled-values + (map (lambda (entry) (let ((entry-symbol - (string->symbol - (string-append (car entry) "-default"))) - (orientation (cdr entry))) - (if paper-default - (cons (car entry) - (round (* orientation - (/ (eval-carefully entry-symbol m 0) - (if (= orientation w) - (car paper-default) - (cdr paper-default)))))) - entry))) + (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))) - (module-define! m 'paper-width w) - (module-define! m 'paper-height h) - ;; Left and right margin are stored in renamed variables because - ;; they must not be overwritten. - ;; Output_def::normalize () needs to know - ;; whether the user set the value or not. - (module-define! m 'left-margin-default-scaled - (assoc-get "left-margin" scaled-values 0 #t)) - (module-define! m 'right-margin-default-scaled - (assoc-get "right-margin" scaled-values 0 #t)) - ;; Sometimes, lilypond-book doesn't estimate a correct line-width. - ;; Therefore, we need to unset line-width. - (module-remove! m 'line-width) - (set! scaled-values (assoc-remove! - (assoc-remove! scaled-values "left-margin") - "right-margin")) - (for-each + (module-define! m 'paper-width w) + (module-define! m 'paper-height h) + ;; Sometimes, lilypond-book doesn't estimate a correct line-width. + ;; Therefore, we need to unset line-width. + (module-remove! m 'line-width) + + (for-each (lambda (value) - (let ((value-symbol (string->symbol (car value))) - (number (cdr value))) - (module-define! m value-symbol number))) + (let ((value-symbol (string->symbol (car value))) + (number (cdr value))) + (module-define! m value-symbol number))) scaled-values))) (define (internal-set-paper-size module name landscape?) @@ -310,11 +330,12 @@ size. SZ is in points" ;;; that in parse-scm.cc (ly:warning (_ "Must use #(set-paper-size .. ) within \\paper { ... }")))) -(define-public (scale-layout pap scale) - (let* ((new-pap (ly:output-def-clone pap)) - (dim-vars (ly:output-def-lookup pap 'dimension-variables)) - (old-scope (ly:output-def-scope pap)) - (scope (ly:output-def-scope new-pap))) +(define-public (scale-layout paper scale) + "Return a clone of the paper, scaled by the given scale factor." + (let* ((new-paper (ly:output-def-clone paper)) + (dim-vars (ly:output-def-lookup paper 'dimension-variables)) + (old-scope (ly:output-def-scope paper)) + (scope (ly:output-def-scope new-paper))) (for-each (lambda (v) @@ -322,13 +343,10 @@ size. SZ is in points" (val (if (variable? var) (variable-ref var) #f))) (if (number? val) - (module-define! scope v - (/ val scale)) - - ;; spurious warnings, eg. for paper-width, paper-height. - ;; (ly:warning (_ "not a number, ~S = ~S " v val)) + (module-define! scope v (/ val scale)) + ;; Cannot warn for non-numbers, eg. for paper-width, paper-height. ))) - dim-vars) - - new-pap)) + ;; Mark the clone. + (ly:output-def-set-variable! new-paper 'cloned #t) + new-paper))