1 ;;;; output-lib.scm -- implement Scheme output helper functions
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 ;;; Tablature functions, by Jiba (jiba@tuxfamily.org)
11 ;; The TabNoteHead stem attachment function.
12 (define (tablature-stem-attachment-function style duration)
15 ;; The TabNoteHead tablatureFormat callback.
16 ;; Compute the text grob-property
17 (define-public (fret-number-tablature-format string tuning pitch)
19 (- (ly:pitch-semitones pitch)
21 ;; remove 1 because list index starts at 0 and guitar string at 1.
24 ;; The 5-string banjo has got a extra string, the fifth (duh), wich
25 ;; starts at the fifth fret on the neck. Frets on the fifth string
26 ;; are referred to relative to the other frets:
27 ;; the "first fret" on the fifth string is really the sixth fret
29 ;; We solve this by defining a new fret-number-tablature function:
30 (define-public (fret-number-tablature-format-banjo string tuning pitch)
31 (let ((fret (- (ly:pitch-semitones pitch) (list-ref tuning (- string 1)))))
33 ((and (> fret 0) (= string 5))
37 (define-public (hammer-print-function grob)
38 (let* ((note-collums (ly:grob-property grob 'note-columns))
39 (note-column1 (cadr note-collums))
40 (note-column2 (car note-collums))
41 (note1 (car (ly:grob-property note-column1 'note-heads)))
42 (note2 (car (ly:grob-property note-column2 'note-heads)))
43 (text1 (ly:grob-property note1 'text))
44 (text2 (ly:grob-property note2 'text))
45 (fret1 (if (string? text1) (string->number text1) 0))
46 (fret2 (if (string? text2) (string->number text2) 0))
55 ;; FIXME: a hammer is not a slur.
57 (ly:make-stencil '() '(0 . 0) '(0 . 0)))
58 (layout (ly:grob-layout grob))
59 (text (interpret-markup
61 (ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))
64 (let ((x (/ (- (cdr (ly:stencil-extent slur 0))
65 (/ (cdr (ly:stencil-extent text 0)) 2.0))
68 (ly:stencil-set-extent! text 0 (cons x x))
69 (ly:stencil-align-to! text 0 1)))))
71 ;; (ly:stencil-combine-at-edge slur 1 1 text -0.6)
75 (define-public guitar-tuning '(4 -1 -5 -10 -15 -20))
76 (define-public bass-tuning '(-17 -22 -27 -32))
78 ;; tunings for 5-string banjo
79 (define-public banjo-open-g-tuning '(2 -1 -5 -10 7))
80 (define-public banjo-c-tuning '(2 -1 -5 -12 7))
81 (define-public banjo-modal-tuning '(2 0 -5 -10 7))
82 (define-public banjo-open-d-tuning '(2 -3 -6 -10 9))
83 (define-public banjo-open-dm-tuning '(2 -3 -6 -10 9))
84 ;; convert 5-string banjo tunings to 4-string tunings by
85 ;; removing the 5th string
88 ;; \set TabStaff.stringTunings = #(four-string-banjo banjo-open-g-tuning)
89 (define-public (four-string-banjo tuning)
90 (reverse (cdr (reverse tuning))))
92 ;;; end of tablature functions
95 (define-public (make-stencil-boxer line-thick x-padding y-padding callback)
96 "Makes a routine that adds a box around the grob parsed as argument"
97 (define (stencil-boxer grob)
98 (let* ((mol (callback grob))
99 (x-ext (interval-widen (ly:stencil-extent mol 0) x-padding))
100 (y-ext (interval-widen (ly:stencil-extent mol 1) y-padding))
101 (x-rule (make-filled-box-stencil (interval-widen x-ext line-thick)
102 (cons 0 line-thick)))
103 (y-rule (make-filled-box-stencil (cons 0 line-thick) y-ext)))
105 (set! mol (ly:stencil-combine-at-edge mol 0 1 y-rule x-padding))
106 (set! mol (ly:stencil-combine-at-edge mol 0 -1 y-rule x-padding))
107 (set! mol (ly:stencil-combine-at-edge mol 1 1 x-rule 0))
108 (set! mol (ly:stencil-combine-at-edge mol 1 -1 x-rule 0))
112 (define-public (arg->string arg)
113 (cond ((number? arg) (ly:inexact->string arg 10))
114 ((string? arg) (string-append "\"" arg "\""))
115 ((symbol? arg) (string-append "\"" (symbol->string arg) "\""))))
117 (define-public (func name . args)
123 (map (lambda (x) (string-append " " (arg->string x))) args)))
126 ;;(define (mm-to-pt x)
127 ;; (* (/ 72.27 25.40) x))
129 ;; do nothing in .scm output
131 (define-public (ly:numbers->string lst)
132 (string-join (map ly:number->string lst) " "))
134 (define (number->octal-string x)
135 (let* ((n (inexact->exact x))
136 (n64 (quotient n 64))
137 (n8 (quotient (- n (* n64 64)) 8)))
141 (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
143 (define-public (ly:inexact->string x radix)
144 (let ((n (inexact->exact x)))
145 (number->string n radix)))
147 (define-public (ly:number-pair->string c)
148 (string-append (ly:number->string (car c)) " "
149 (ly:number->string (cdr c))))
154 (make-string 1 (integer->char (+ (char->integer #\A) i)))))
156 (define (scm-scm action-name)
160 (define-public (find-notehead-symbol duration style)
162 ((xcircle) "2xcircle")
163 ((harmonic) "0harmonic")
165 ;; Oops, I actually would not call this "baroque", but, for
166 ;; backwards compatibility to 1.4, this is supposed to take
167 ;; brevis, longa and maxima from the neo-mensural font and all
168 ;; other note heads from the default font. -- jr
170 (string-append (number->string duration) "neomensural")
171 (number->string duration)))
173 (string-append (number->string duration) (symbol->string style)))
175 (string-append (number->string duration) (symbol->string style)))
177 ;; The default font in mf/feta-bolletjes.mf defines a brevis, but
178 ;; neither a longa nor a maxima. Hence let us, for the moment,
179 ;; take these from the neo-mensural font. TODO: mf/feta-bolletjes
180 ;; should define at least a longa for the default font. The longa
181 ;; should look exactly like the brevis of the default font, but
182 ;; with a stem exactly like that of the quarter note. -- jr
184 (string-append (number->string duration) "neomensural")
185 (number->string duration)))
187 (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
188 (symbol->string style)
189 (string-append (number->string (max 0 duration))
190 (symbol->string style))))))
192 ;; TODO junk completely?
193 (define (note-head-style->attachment-coordinates grob axis)
194 "Return pair (X . Y), containing multipliers for the note head
195 bounding box, where to attach the stem. e.g.: X==0 means horizontally
196 centered, X==1 is at the right, X == -1 is at the left."
200 (define-public (string-encode-integer i)
203 ((< i 0) (string-append "n" (string-encode-integer (- i))))
205 (make-string 1 (integer->char (+ 65 (modulo i 26))))
206 (string-encode-integer (quotient i 26))))))
208 (define-public ((every-nth-bar-number-visible n) barnum) (= 0 (modulo barnum n)))
210 (define-public ((modulo-bar-number-visible n m) barnum) (and (> barnum 1) (= m (modulo barnum n))))
212 (define-public ((set-bar-number-visibility n) tr)
213 (let* ((bn (ly:context-property tr 'currentBarNumber)))
214 (ly:context-set-property! tr 'barNumberVisibility (modulo-bar-number-visible n (modulo bn n)))))
216 (define-public (default-bar-number-visibility barnum) (> barnum 1))
218 ;; See documentation of Item::visibility_lambda_
219 (define-safe-public (begin-of-line-visible d) (if (= d 1) '(#f . #f) '(#t . #t)))
220 (define-safe-public (end-of-line-visible d) (if (= d -1) '(#f . #f) '(#t . #t)))
221 (define-safe-public (spanbar-begin-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
223 (define-safe-public (all-visible d) '(#f . #f))
224 (define-safe-public (all-invisible d) '(#t . #t))
225 (define-safe-public (begin-of-line-invisible d) (if (= d 1) '(#t . #t) '(#f . #f)))
226 (define-safe-public (end-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
229 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
233 ;; How should a bar line behave at a break?
235 ;; Why prepend `default-' to every scm identifier?
236 (define-public (default-break-barline glyph dir)
237 (let ((result (assoc glyph
238 '((":|:" . (":|" . "|:"))
239 ("||:" . ("||" . "|:"))
241 ("||:" . ("||" . "|:"))
243 ("|:" . ("|" . "|:"))
246 ;; hmm... should we end with a bar line here?
247 (".|" . ("|" . ".|"))
250 (".|." . (".|." . ()))
253 ("empty" . (() . ()))
254 ("brace" . (() . "brace"))
255 ("bracket" . (() . "bracket")) ))))
257 (if (equal? result #f)
258 (ly:warn "Unknown bar glyph: `~S'" glyph)
259 (index-cell (cdr result) dir))))
261 (define-public (shift-right-at-line-begin g)
262 "Shift an item to the right, but only at the start of the line."
263 (if (and (ly:item? g) (equal? (ly:item-break-dir g) RIGHT))
264 (ly:grob-translate-axis! g 3.5 X)))
267 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
270 (define-public color? list?)
273 (define-public black '(0.0 0.0 0.0))
274 (define-public white '(1.0 1.0 1.0))
275 (define-public red '(1.0 0.0 0.0))
276 (define-public green '(0.0 1.0 0.0))
277 (define-public blue '(0.0 0.0 1.0))
278 (define-public cyan '(1.0 1.0 0.0))
279 (define-public magenta '(1.0 0.0 1.0))
280 (define-public yellow '(0.0 1.0 1.0))
282 (define-public grey '(0.5 0.5 0.5))
283 (define-public darkred '(0.5 0.0 0.0))
284 (define-public darkgreen '(0.0 0.5 0.0))
285 (define-public darkblue '(0.0 0.0 0.5))
286 (define-public darkcyan '(0.5 0.5 0.0))
287 (define-public darkmagenta '(0.5 0.0 0.5))
288 (define-public darkyellow '(0.0 0.5 0.5))