1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2004--2015 Carl D. Sorensen <c_sorensen@byu.edu>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 (define (string-x-extent start-point end-point)
21 "Return the x-extent of a string that goes from start-point
23 (let ((x1 (car start-point))
29 (define (string-y-extent start-point end-point)
30 "Return the y-extent of a string that goes from start-point
32 (let ((y1 (cdr start-point))
39 (define (cons-fret new-value old-list)
40 "Put together a fret-list in the format desired by parse-string"
41 (if (eq? old-list '())
43 (cons* new-value old-list)))
45 (define (get-numeric-from-key keystring)
46 "Get the numeric value from a key of the form k:val"
47 (let* ((entry (substring keystring 2 (string-length keystring)))
48 (numeric-entry (string->number entry)))
49 ;; throw an error, if `entry' can't be transformed into a number
53 "Unhandled entry in fret-diagram \"~a\" in \"~a\""
57 (define (numerify mylist)
58 "Convert string values to numeric or character"
61 (let ((numeric-value (string->number (car mylist))))
63 (cons* numeric-value (numerify (cdr mylist)))
64 (cons* (car (string->list (car mylist)))
65 (numerify (cdr mylist)))))))
68 "Calculate the font step necessary to get a desired magnification"
69 (* 6 (/ (log mag) (log 2))))
71 (define (fret-count fret-range)
72 "Calculate the fret count for the diagram given the range of frets in the diagram."
73 (1+ (- (cdr fret-range) (car fret-range))))
75 (define (dot-has-color dot-settings)
76 "Return a color-name as symbol, if found in @var{dot-settings} otherwise @code{#f}"
77 (cond ((null? dot-settings)
79 ;; Don't bother the user with quote/unquote.
80 ;; We use the name-symbol for the color, looking up in 'x11-color-list'
81 ((member (car dot-settings) (map car x11-color-list))
83 (else (dot-has-color (cdr dot-settings)))))
85 (define (dot-is-inverted dot-settings)
86 "Return @code{'inverted}, if found in @var{dot-settings} otherwise @code{'()}"
87 (let ((inverted (member 'inverted dot-settings)))
92 (define (dot-is-parenthesized dot-settings)
93 "Return @code{'parenthesized}, if found in @var{dot-settings} otherwise @code{'()}"
94 (let ((parenthesized (member 'parenthesized dot-settings)))
99 ;; If @code{'default-paren-color} is not set, the parenthesis will take their
100 ;; color from the dot.
101 ;; Setting @code{'default-paren-color} will result in taking the color from
102 ;; `what-color', see below.
103 (define (default-paren-color dot-settings)
104 "Return @code{'default-paren-color}, if found in @var{dot-settings} otherwise @code{'()}"
105 (let ((default-color (member 'default-paren-color dot-settings)))
110 (define (subtract-base-fret base-fret dot-list)
111 "Subtract @var{base-fret} from every fret in @var{dot-list}"
114 (let ((this-list (car dot-list)))
119 (- (second this-list) base-fret)
120 ;; finger-number or markup
121 (if (and (not (null? (cddr this-list)))
122 (or (markup? (caddr this-list))
123 (number? (caddr this-list))))
127 (dot-is-inverted this-list)
129 (dot-is-parenthesized this-list)
132 (default-paren-color this-list)
134 (let ((colored (dot-has-color this-list)))
138 (subtract-base-fret base-fret (cdr dot-list))))))
140 (define (drop-paren item-list)
141 "Drop a final parentheses from a fret indication list
142 @code{item-list} resulting from a terse string specification of barre."
143 (if (> (length item-list) 0)
144 (let* ((max-index (- (length item-list) 1))
145 (last-element (car (list-tail item-list max-index))))
146 (if (or (equal? last-element ")") (equal? last-element "("))
147 (list-head item-list max-index)
151 (define (get-sub-list value master-list)
152 "Get a sub-list whose cadr is equal to @var{value} from @var{master-list}"
153 (if (eq? master-list '())
155 (let ((sublist (car master-list)))
156 (if (equal? (cadr sublist) value)
158 (get-sub-list value (cdr master-list))))))
160 (define (merge-details key alist-list . default)
161 "Return @code{alist-list} entries for @code{key}, in one combined alist.
162 There can be two @code{alist-list} entries for a given key. The first
163 comes from the override-markup function, the second comes
164 from property settings during a regular override.
165 This is necessary because some details can be set in one
166 place, while others are set in the other. Both details
167 lists must be merged into a single alist.
168 Return @code{default} (optional, else #f) if not
171 (define (helper key alist-list default)
172 (if (null? alist-list)
174 (let* ((entry (assoc-get key (car alist-list))))
176 (append entry (chain-assoc-get key (cdr alist-list) '()))
177 (helper key (cdr alist-list) default)))))
179 (helper key alist-list
180 (if (pair? default) (car default) #f)))
182 ;; Conversions between fret/string coordinate system and x-y coordinate
185 ;; Fret coordinates are measured down the fretboard from the nut,
188 ;; String coordinates are measured from the lowest string, starting at 0.
190 ;; The x-y origin is at the intersection of the nut and the lowest string.
192 ;; X coordinates are positive to the right.
193 ;; Y coordinates are positive up.
195 (define (negate-extent extent)
196 "Return the extent in an axis opposite to the axis of @code{extent}."
197 (cons (- (cdr extent)) (- (car extent))))
199 (define (stencil-fretboard-extent stencil fretboard-axis orientation)
200 "Return the extent of @code{stencil} in the @code{fretboard-axis}
202 (if (eq? fretboard-axis 'fret)
203 (cond ((eq? orientation 'landscape)
204 (ly:stencil-extent stencil X))
205 ((eq? orientation 'opposing-landscape)
206 (negate-extent (ly:stencil-extent stencil X)))
208 (negate-extent (ly:stencil-extent stencil Y))))
209 ;; else -- eq? fretboard-axis 'string
210 (cond ((eq? orientation 'landscape)
211 (ly:stencil-extent stencil Y))
212 ((eq? orientation 'opposing-landscape)
213 (negate-extent (ly:stencil-extent stencil Y)))
215 (ly:stencil-extent stencil Y)))))
218 (define (stencil-fretboard-offset stencil fretboard-axis orientation)
219 "Return a the stencil coordinates of the center of @code{stencil}
220 in the @code{fretboard-axis} direction."
221 (* 0.5 (interval-length
222 (stencil-fretboard-extent stencil fretboard-axis orientation))))
225 (define (string-thickness string thickness-factor)
226 (expt (1+ thickness-factor) (1- string)))
228 ;; Functions that create stencils used in the fret diagram
230 (define (sans-serif-stencil layout props mag text)
231 "Create a stencil in sans-serif font based on @var{layout} and @var{props}
232 with magnification @var{mag} of the string @var{text}."
235 'font-size (stepmag mag)
236 (prepend-alist-chain 'font-family 'sans props))))
237 (interpret-markup layout my-props text)))
239 ;; markup commands and associated functions
241 (define (fret-parse-marking-list marking-list my-fret-count)
242 "Parse a fret-diagram-verbose marking list into component sublists"
243 (let* ((fret-range (cons 1 my-fret-count))
249 (let parse-item ((mylist marking-list))
250 (if (not (null? mylist))
251 (let* ((my-item (car mylist)) (my-code (car my-item)))
253 ((or (eq? my-code 'open)(eq? my-code 'mute))
254 (set! xo-list (cons* my-item xo-list)))
255 ((eq? my-code 'barre)
256 (if (every number? (cdr my-item))
257 (set! barre-list (cons* (cdr my-item) barre-list))
259 "barre-indications should contain only numbers: ~a"
262 (set! capo-fret (cadr my-item)))
263 ((eq? my-code 'place-fret)
264 (set! dot-list (cons* (cdr my-item) dot-list))))
265 (parse-item (cdr mylist)))))
266 ;; calculate fret-range
268 (minfret (if (> capo-fret 0) capo-fret 99)))
269 (let updatemax ((fret-list dot-list)) ;CHANGE THIS TO HELPER FUNCTION?
270 (if (null? fret-list)
272 (let ((fretval (second (car fret-list))))
273 (if (> fretval maxfret) (set! maxfret fretval))
274 (if (< fretval minfret) (set! minfret fretval))
275 (updatemax (cdr fret-list)))))
276 ;; take frets of 'barre-settings into account
277 (if (not (null? barre-list))
278 (set! minfret (apply min minfret (map last barre-list))))
279 (if (or (> maxfret my-fret-count) (> capo-fret 1))
282 (let ((upfret (- (+ minfret my-fret-count) 1)))
283 (if (> maxfret upfret) maxfret upfret)))))
284 (if (not (zero? (apply min capo-fret (map cadr dot-list))))
285 (set! capo-fret (1+ (- capo-fret minfret))))
286 ;; subtract fret from dots
287 (set! dot-list (subtract-base-fret (- (car fret-range) 1) dot-list)))
288 (acons 'fret-range fret-range
289 (acons 'barre-list barre-list
290 (acons 'dot-list dot-list
291 (acons 'xo-list xo-list
292 (acons 'capo-fret capo-fret '())))))))
294 (define (make-fret-diagram layout props marking-list)
295 "Make a fret diagram markup"
297 ;; note: here we get items from props that are needed in this routine,
298 ;; or that are needed in more than one of the procedures
299 ;; called from this routine. If they're only used in one of the
300 ;; sub-procedure, they're obtained in that procedure
301 (size (chain-assoc-get 'size props 1.0)) ; needed for everything
302 ;;TODO -- get string-count directly from length of stringTunings;
303 ;; from FretBoard engraver, but not from markup call
304 (details (merge-details 'fret-diagram-details props '()))
306 (assoc-get 'string-count details 6)) ;; needed for everything
308 (assoc-get 'fret-count details 4)) ;; needed for everything
310 (assoc-get 'orientation details 'normal)) ;; needed for everything
313 'finger-code details 'none)) ;; needed for draw-dots and draw-barre
315 (if (eq? finger-code 'in-dot) 0.425 0.25)) ;; bigger dots if labeled
316 (default-dot-position
317 (if (eq? finger-code 'in-dot)
318 (- 0.95 default-dot-radius)
319 0.6)) ; move up to make room for bigger dot if labeled
322 'dot-radius details default-dot-radius))
323 ;; needed for draw-dots and draw-barre
326 'dot-position details default-dot-position))
327 ;; needed for draw-dots and draw-barre
329 (* (ly:output-def-lookup layout 'line-thickness)
330 (chain-assoc-get 'thickness props 0.5)))
331 ;; needed for draw-frets and draw-strings
333 (thickness-factor (assoc-get 'string-thickness-factor details 0))
334 (paren-padding (assoc-get 'paren-padding details 0.05))
336 (chain-assoc-get 'align-dir props -0.4)) ;; needed only here
337 (xo-padding (assoc-get 'xo-padding details 0.2)) ;; needed only here
338 (parameters (fret-parse-marking-list marking-list my-fret-count))
339 (capo-fret (assoc-get 'capo-fret parameters 0))
340 (dot-list (assoc-get 'dot-list parameters))
341 (xo-list (assoc-get 'xo-list parameters))
342 (fret-range (assoc-get 'fret-range parameters))
343 (my-fret-count (fret-count fret-range))
344 (barre-list (assoc-get 'barre-list parameters))
346 (assoc-get 'barre-type details 'curved))
347 (fret-diagram-stencil '()))
349 ;; Here are the fret diagram helper functions that depend on the
350 ;; fret diagram parameters. The functions are here because the
351 ;; diagram parameters are part of the lexical scope here.
353 (define (stencil-coordinates fret-coordinate string-coordinate)
354 "Return a pair @code{(x-coordinate . y-coordinate)}
355 in stencil coordinate system."
357 ((eq? orientation 'landscape)
358 (cons fret-coordinate
359 (- string-coordinate (1- string-count))))
360 ((eq? orientation 'opposing-landscape)
361 (cons (- fret-coordinate) (- string-coordinate)))
363 (cons string-coordinate (- fret-coordinate)))))
365 (define (stencil-coordinate-offset fret-offset string-offset)
366 "Return a pair @code{(x-offset . y-offset)}
367 for translation in stencil coordinate system."
369 ((eq? orientation 'landscape)
370 (cons fret-offset (- string-offset)))
371 ((eq? orientation 'opposing-landscape)
372 (cons (- fret-offset) string-offset))
374 (cons string-offset (- fret-offset)))))
378 (define (make-bezier-sandwich-list start stop base height
380 "Make the argument list for a bezier sandwich from
381 string coordinate @var{start} to string-coordinate @var{stop} with a
382 baseline at fret coordinate @var{base}, a height of
383 @var{height}, and a half thickness of @var{half-thickness}."
384 (let* ((width (+ (- stop start) 1))
385 (cp-left-width (+ (* width half-thickness) start))
386 (cp-right-width (- stop (* width half-thickness)))
387 (bottom-control-point-height
388 (- base (- height half-thickness)))
389 (top-control-point-height
392 (stencil-coordinates base start))
394 (stencil-coordinates base stop))
395 (left-upper-control-point
397 top-control-point-height cp-left-width))
398 (left-lower-control-point
400 bottom-control-point-height cp-left-width))
401 (right-upper-control-point
403 top-control-point-height cp-right-width))
404 (right-lower-control-point
406 bottom-control-point-height cp-right-width)))
408 ;; order of bezier control points is:
409 ;; left cp low, left cp low, right cp low, right end low
410 ;; right cp high, left cp high
414 left-lower-control-point
415 right-lower-control-point
418 right-upper-control-point
419 left-upper-control-point)))
421 (define (draw-strings)
422 "Draw the string lines for a fret diagram with
423 @var{string-count} strings and frets as indicated in @var{fret-range}.
424 Line thickness is given by @var{th}, fret & string spacing by
425 @var{size}. Orientation is determined by @var{orientation}."
429 (string-stencil (car x))
431 (string-stencil (car x))
434 (let* ((string-list (map 1+ (iota string-count))))
435 (helper string-list)))
437 (define (string-stencil string)
438 "Make a stencil for @code{string}, given the fret-diagram
440 (let* ((string-coordinate (- string-count string))
441 (current-string-thickness
442 (* th size (string-thickness string thickness-factor)))
443 (fret-half-thickness (* size th 0.5))
444 (half-string (* current-string-thickness 0.5))
447 (- fret-half-thickness)
448 (- (* size string-coordinate) half-string)))
451 (+ fret-half-thickness (* size (1+ (fret-count fret-range))))
452 (+ half-string (* size string-coordinate)))))
454 (string-x-extent start-coordinates end-coordinates)
455 (string-y-extent start-coordinates end-coordinates)
459 "Draw the fret lines for a fret diagram with
460 @var{string-count} strings and frets as indicated in @var{fret-range}.
461 Line thickness is given by @var{th}, fret & string spacing by
462 @var{size}. Orientation is given by @var{orientation}."
465 (fret-stencil (car x))
467 (fret-stencil (car x))
470 (let ((fret-list (iota (1+ my-fret-count))))
473 (define (fret-stencil fret)
474 "Make a stencil for @code{fret}, given the
475 fret-diagram overall parameters."
476 (let* ((low-string-half-thickness
480 (string-thickness string-count thickness-factor)))
481 (fret-half-thickness (* 0.5 size th))
485 (- fret-half-thickness low-string-half-thickness)))
489 (* size (1- string-count)))))
492 (car start-coordinates) (cdr start-coordinates)
493 (car end-coordinates) (cdr end-coordinates))))
495 (define (draw-barre barre-list)
496 "Create barre indications for a fret diagram"
497 (if (not (null? barre-list))
498 (let* ((string1 (caar barre-list))
499 (string2 (cadar barre-list))
500 (barre-fret (caddar barre-list))
501 (top-fret (cdr fret-range))
502 (low-fret (car fret-range))
503 (fret (1+ (- barre-fret low-fret)))
504 (barre-vertical-offset 0.5)
505 (dot-center-fret-coordinate (+ (1- fret) dot-position))
506 (barre-fret-coordinate
507 (+ dot-center-fret-coordinate
508 (* (- barre-vertical-offset 0.5) dot-radius)))
509 (barre-start-string-coordinate (- string-count string1))
510 (barre-end-string-coordinate (- string-count string2))
511 (scale-dot-radius (* size dot-radius))
512 (barre-type (assoc-get 'barre-type details 'curved))
515 ((eq? barre-type 'straight)
516 (make-straight-barre-stencil
517 barre-fret-coordinate
518 barre-start-string-coordinate
519 barre-end-string-coordinate
521 ((eq? barre-type 'curved)
522 (make-curved-barre-stencil
523 barre-fret-coordinate
524 barre-start-string-coordinate
525 barre-end-string-coordinate
526 scale-dot-radius)))))
527 (if (not (null? (cdr barre-list)))
530 (draw-barre (cdr barre-list)))
533 (define (make-straight-barre-stencil
535 start-string-coordinate
536 end-string-coordinate
538 "Create a straight barre stencil."
541 (* size fret-coordinate)
542 (* size start-string-coordinate)))
545 (* size fret-coordinate)
546 (* size end-string-coordinate))))
554 (define (make-curved-barre-stencil
556 start-string-coordinate
557 end-string-coordinate
559 "Create a curved barre stencil."
560 (let* ((bezier-thick 0.1)
563 (make-bezier-sandwich-list
564 (* size start-string-coordinate)
565 (* size end-string-coordinate)
566 (* size fret-coordinate)
567 (* size bezier-height)
568 (* size bezier-thick))))
569 (make-bezier-sandwich-stencil
571 (* size bezier-thick))))
573 (define (draw-dots dot-list)
574 "Make dots for fret diagram."
576 (let* ( (scale-dot-radius (* size dot-radius))
577 (scale-dot-thick (* size th))
578 (default-dot-color (assoc-get 'dot-color details))
579 (finger-label-padding 0.3)
582 (assoc-get 'dot-label-font-mag details 1.0)))
583 (string-label-font-mag
586 'string-label-font-mag details
587 (cond ((or (eq? orientation 'landscape)
588 (eq? orientation 'opposing-landscape))
591 (mypair (car dot-list))
592 (restlist (cdr dot-list))
593 (string (car mypair))
595 (fret-coordinate (* size (+ (1- fret) dot-position)))
596 (string-coordinate (* size (- string-count string)))
598 (stencil-coordinates fret-coordinate string-coordinate))
599 (extent (cons (- scale-dot-radius) scale-dot-radius))
600 (finger (caddr mypair))
601 (finger (if (number? finger) (number->string finger) finger))
603 (if (not (null? (dot-is-parenthesized mypair)))
604 (dot-is-parenthesized mypair)
607 (if (not (null? (default-paren-color mypair)))
608 (default-paren-color mypair)
611 (if (not (null? (dot-is-inverted mypair)))
612 (dot-is-inverted mypair)
616 (and (eq? default-dot-color 'white) (not inverted))))
620 (not (dot-has-color mypair))
621 (not (eq? default-dot-color 'white)))
622 (or default-dot-color 'black))
624 (or (dot-has-color mypair) 'black))
626 (or (dot-has-color mypair)
634 scale-dot-radius scale-dot-thick #t)
638 (- scale-dot-radius (* 0.5 scale-dot-thick))
640 (x11-color 'white)))))
642 (if dot-color-is-white?
643 (inverted-stil what-color)
646 scale-dot-radius scale-dot-thick #t)
650 (if (and parenthesis-color
651 (not (eq? default-dot-color 'white)))
652 (x11-color (or default-dot-color 'black))
655 (parenthesize-stencil
656 dot-stencil ;; stencil
657 (* size th 0.75) ;; half-thickness
658 (* 0.15 size) ;;width
660 paren-padding ;; padding
668 (ly:stencil-translate final-dot-stencil dot-coordinates))
671 ((or (eq? finger '())(eq? finger-code 'none))
673 ((eq? finger-code 'in-dot)
675 (if (not (null? finger))
677 layout props dot-label-font-mag finger)
680 (interval-length (ly:stencil-extent finger-stil X)))
682 (interval-length (ly:stencil-extent finger-stil Y)))
684 (/ (interval-length (ly:stencil-extent dot-stencil Y))
687 (/ dot-stencil-radius
688 ;; Calculate the radius of the circle through the
689 ;; corners of the box containing the finger-stil.
690 ;; Give it a little padding. The value, (* 2 th),
694 (+ (expt (/ finger-stil-length 2) 2)
695 (expt (/ finger-stil-height 2) 2)))
704 scale-factor scale-factor))))
705 (ly:stencil-translate
708 (if dot-color-is-white?
712 (stencil-with-color finger-label white)))
714 ((eq? finger-code 'below-string)
715 (let* ((label-stencil
718 layout props string-label-font-mag
721 (stencil-fretboard-offset
722 label-stencil 'fret orientation))
723 (label-fret-coordinate
725 (+ 1 my-fret-count finger-label-padding))
727 (label-string-coordinate string-coordinate)
730 label-fret-coordinate
731 label-string-coordinate)))
734 (ly:stencil-translate
736 label-translation))))
737 (else ;unknown finger-code
743 labeled-dot-stencil))))
745 (define (draw-thick-zero-fret)
746 "Draw a thick zeroth fret for a fret diagram whose base fret is 1."
747 (let* ((half-lowest-string-thickness
748 (* 0.5 th (string-thickness string-count thickness-factor)))
749 (half-thick (* 0.5 sth))
751 (* sth (assoc-get 'top-fret-thickness details 3.0)))
752 (start-string-coordinate (- half-lowest-string-thickness))
753 (end-string-coordinate (+ (* size (1- string-count)) half-thick))
754 (start-fret-coordinate half-thick)
755 (end-fret-coordinate (- half-thick top-fret-thick))
758 start-fret-coordinate start-string-coordinate))
761 end-fret-coordinate end-string-coordinate)))
763 ;; Put limits in order, or else the intervals are considered empty
764 (ordered-cons (car lower-left) (car upper-right))
765 (ordered-cons (cdr lower-left) (cdr upper-right))
768 (define (draw-xo xo-list)
769 "Put open and mute string indications on diagram, as contained in
772 (assoc-get 'xo-font-magnification details
773 (cond ((or (eq? orientation 'landscape)
774 (eq? orientation 'opposing-landscape))
777 (mypair (car xo-list))
778 (restlist (cdr xo-list))
779 (glyph-string (if (eq? (car mypair) 'mute)
780 (assoc-get 'mute-string details "X")
781 (assoc-get 'open-string details "O")))
782 (glyph-string-coordinate (* (- string-count (cadr mypair)) size))
786 layout props (* size xo-font-mag) glyph-string)))
787 (glyph-stencil-coordinates
788 (stencil-coordinates 0 glyph-string-coordinate))
790 (ly:stencil-translate
792 glyph-stencil-coordinates)))
797 (draw-xo restlist)))))
799 (define (draw-capo fret)
800 "Draw a capo indicator across the full width of the fret-board
803 (* size (assoc-get 'capo-thickness details 0.5)))
804 (half-thick (* capo-thick 0.5))
805 (last-string-position 0)
806 (first-string-position (* size (- string-count 1)))
807 (fret-position ( * size (1- (+ dot-position fret))))
811 first-string-position))
815 last-string-position)))
818 (car start-point) (cdr start-point)
819 (car end-point) (cdr end-point))))
821 (define (label-fret fret-range)
822 "Label the base fret on a fret diagram"
823 (let* ((base-fret (car fret-range))
824 (label-font-mag (assoc-get 'fret-label-font-mag details 0.5))
825 (label-space (* 0.5 size))
826 (label-dir (assoc-get 'label-dir details RIGHT))
827 (label-vertical-offset
828 (assoc-get 'fret-label-vertical-offset details 0))
829 (label-horizontal-offset
830 (assoc-get 'fret-label-horizontal-offset details 0))
832 (assoc-get 'number-type details 'roman-lower))
834 (number-format number-type base-fret
835 (assoc-get 'fret-label-custom-format
840 layout props (* size label-font-mag) label-text)))
842 (stencil-fretboard-offset
846 (label-outside-diagram
848 (* size label-horizontal-offset)
850 (ly:stencil-translate
853 (* size (+ 1.0 label-vertical-offset))
854 (if (eq? label-dir LEFT)
855 (- label-outside-diagram)
856 (+ (* size (1- string-count)) label-outside-diagram))))))
858 ;; Here is the body of make-fret-diagram
860 (set! fret-diagram-stencil
861 (ly:stencil-add (draw-strings) (draw-frets)))
862 (if (and (not (null? barre-list))
863 (not (eq? 'none barre-type)))
864 (set! fret-diagram-stencil
866 (draw-barre barre-list)
867 fret-diagram-stencil)))
868 (if (not (null? dot-list))
869 (set! fret-diagram-stencil
872 (draw-dots dot-list))))
873 (if (= (car fret-range) 1)
874 (set! fret-diagram-stencil
877 (draw-thick-zero-fret))))
878 (if (not (null? xo-list))
879 (let* ((diagram-fret-top
880 (car (stencil-fretboard-extent
884 (xo-stencil (draw-xo xo-list))
886 (stencil-fretboard-offset
887 xo-stencil 'fret orientation))
889 (stencil-coordinate-offset
894 (set! fret-diagram-stencil
897 (ly:stencil-translate
899 xo-stencil-offset)))))
901 (set! fret-diagram-stencil
904 (draw-capo capo-fret))))
905 (if (> (car fret-range) 1)
906 (set! fret-diagram-stencil
909 (label-fret fret-range))))
910 (ly:stencil-aligned-to fret-diagram-stencil X alignment)))
912 (define (fret-parse-definition-string props definition-string)
913 "Parse a fret diagram string and return a pair containing:
914 @var{props}, modified as necessary by the definition-string
915 a fret-indication list with the appropriate values"
916 (let* ((fret-count 4)
918 (fret-range (cons 1 fret-count))
924 (details (merge-details 'fret-diagram-details props '()))
925 ;; remove whitespace-characters from definition-string
926 (cleared-string (remove-whitespace definition-string))
927 (items (string-split cleared-string #\;)))
928 (let parse-item ((myitems items))
929 (if (not (null? (cdr myitems)))
930 (let ((test-string (car myitems)))
931 (case (car (string->list (substring test-string 0 1)))
932 ((#\s) (let ((size (get-numeric-from-key test-string)))
933 (set! props (prepend-alist-chain 'size size props))))
934 ((#\t) (let ((th (get-numeric-from-key test-string)))
935 (set! props (prepend-alist-chain 'thickness th props))))
936 ((#\f) (let* ((finger-code (get-numeric-from-key test-string))
937 (finger-id (case finger-code
940 ((2) 'below-string))))
942 (acons 'finger-code finger-id details))))
943 ((#\c) (set! output-list
948 (string-split (substring test-string 2) #\-)))
950 ((#\h) (let ((fret-count (get-numeric-from-key test-string)))
952 (acons 'fret-count fret-count details))))
953 ((#\w) (let ((string-count (get-numeric-from-key test-string)))
955 (acons 'string-count string-count details))))
956 ((#\d) (let ((dot-size (get-numeric-from-key test-string)))
958 (acons 'dot-radius dot-size details))))
959 ((#\p) (let ((dot-position (get-numeric-from-key test-string)))
961 (acons 'dot-position dot-position details))))
963 (let* ((this-list (string-split test-string #\-))
964 (fret-number (string->number (car this-list))))
965 ;; If none of the above applies, `fret-number' needs to be a
966 ;; number. Throw an error, if not.
967 (if (not fret-number)
969 "Unhandled entry in fret-diagrams \"~a\" in \"~a\""
972 (if (string->number (cadr this-list))
975 (cons 'place-fret (numerify this-list))
977 (if (equal? (cadr this-list) "x" )
980 (list 'mute fret-number)
984 (list 'open fret-number)
986 (parse-item (cdr myitems)))))
987 ;; add the modified details
989 (prepend-alist-chain 'fret-diagram-details details props))
990 `(,props . ,output-list))) ;ugh -- hard-coded spell -- procedure better
993 (fret-parse-terse-definition-string props definition-string)
994 "Parse a fret diagram string that uses terse syntax;
995 return a pair containing:
996 @var{props}, modified to include the string-count determined by the
997 definition-string, and
998 a fret-indication list with the appropriate values"
999 ;; TODO -- change syntax to fret\string-finger
1001 (let* ((details (merge-details 'fret-diagram-details props '()))
1002 (barre-start-list '())
1005 (items (string-split definition-string #\;))
1006 (string-count (- (length items) 1)))
1007 (let parse-item ((myitems items))
1008 (if (not (null? (cdr myitems)))
1009 (let* ((test-string (car myitems))
1010 (current-string (- (length myitems) 1))
1011 (indicators (string-split test-string #\ )))
1012 (let parse-indicators ((myindicators indicators))
1013 (if (not (eq? '() myindicators))
1014 (let* ((this-list (string-split (car myindicators) #\-))
1015 (max-element-index (- (length this-list) 1))
1017 (car (list-tail this-list max-element-index)))
1019 (if (string->number (car this-list))
1020 (string->number (car this-list))
1022 (if (equal? last-element "(")
1024 (set! barre-start-list
1025 (cons-fret (list current-string fret)
1028 (list-head this-list max-element-index))))
1029 (if (equal? last-element ")")
1031 (get-sub-list fret barre-start-list))
1032 (insert-index (- (length this-barre) 1)))
1034 (cons-fret (cons* 'barre
1040 (list-head this-list max-element-index))))
1047 (drop-paren (numerify this-list)))
1049 (if (equal? (car this-list) "x" )
1053 (list 'mute current-string)
1058 (list 'open current-string)
1060 (parse-indicators (cdr myindicators)))))
1061 (parse-item (cdr myitems)))))
1062 (set! details (acons 'string-count string-count details))
1063 (set! props (prepend-alist-chain 'fret-diagram-details details props))
1064 `(,props . ,output-list))) ; ugh -- hard coded; proc is better
1067 (define-markup-command
1068 (fret-diagram-verbose layout props marking-list)
1069 (pair?) ; argument type (list, but use pair? for speed)
1070 #:category instrument-specific-markup ; markup type
1071 #:properties ((align-dir -0.4) ; properties and defaults
1073 (fret-diagram-details)
1075 "Make a fret diagram containing the symbols indicated in @var{marking-list}.
1080 \\markup \\fret-diagram-verbose
1081 #'((mute 6) (mute 5) (open 4)
1082 (place-fret 3 2) (place-fret 2 3) (place-fret 1 2))
1086 produces a standard D@tie{}chord diagram without fingering indications.
1088 Possible elements in @var{marking-list}:
1091 @item (mute @var{string-number})
1092 Place a small @q{x} at the top of string @var{string-number}.
1094 @item (open @var{string-number})
1095 Place a small @q{o} at the top of string @var{string-number}.
1097 @item (barre @var{start-string} @var{end-string} @var{fret-number})
1098 Place a barre indicator (much like a tie) from string @var{start-string}
1099 to string @var{end-string} at fret @var{fret-number}.
1101 @item (capo @var{fret-number})
1102 Place a capo indicator (a large solid bar) across the entire fretboard
1103 at fret location @var{fret-number}. Also, set fret @var{fret-number}
1104 to be the lowest fret on the fret diagram.
1106 (place-fret @var{string-number}
1108 [@var{finger-value}]
1109 [@var{color-modifier}]
1111 [@code{'parenthesized} [@code{'default-paren-color}]])
1112 Place a fret playing indication on string @var{string-number} at fret
1113 @var{fret-number} with an optional fingering label @var{finger-value},
1114 an optional color modifier @var{color-modifier}, an optional color
1115 @var{color}, an optional parenthesis @code{'parenthesized} and an
1116 optional paranthesis color @code{'default-paren-color}.
1117 By default, the fret playing indicator is a solid dot. This can be
1118 globally changed by setting the value of the variable @var{dot-color}
1119 or for a single dot by setting the value of @var{color}. The dot can
1120 be parenthesized by adding @code{'parenthesized}. By default the
1121 color for the parenthesis is taken from the dot. Adding
1122 @code{'default-paren-color} will take the parenthesis-color from the
1123 global @var{dot-color}, as a fall-back black will be used.
1124 Setting @var{color-modifier} to @code{inverted} inverts the dot color
1125 for a specific fingering.
1126 The values for @var{string-number}, @var{fret-number}, and the optional
1127 @var{finger} should be entered first in that order.
1128 The order of the other optional arguments does not matter.
1129 If the @var{finger} part of the @code{place-fret} element is present,
1130 @var{finger-value} will be displayed according to the setting of the
1131 variable @var{finger-code}. There is no limit to the number of fret
1132 indications per string.
1135 (make-fret-diagram layout props marking-list))
1138 (define-markup-command (fret-diagram layout props definition-string)
1139 (string?) ; argument type
1140 #:category instrument-specific-markup ; markup category
1141 #:properties (fret-diagram-verbose-markup) ; properties and defaults
1142 "Make a (guitar) fret diagram. For example, say
1145 \\markup \\fret-diagram #\"s:0.75;6-x;5-x;4-o;3-2;2-3;1-2;\"
1149 for fret spacing 3/4 of staff space, D chord diagram
1151 Syntax rules for @var{definition-string}:
1155 Diagram items are separated by semicolons.
1162 @code{s:}@var{number} -- Set the fret spacing of the diagram (in staff
1167 @code{t:}@var{number} -- Set the line thickness (relative to normal
1172 @code{h:}@var{number} -- Set the height of the diagram in frets.
1176 @code{w:}@var{number} -- Set the width of the diagram in strings.
1180 @code{f:}@var{number} -- Set fingering label type
1181 (0@tie{}= none, 1@tie{}= in circle on string, 2@tie{}= below string).
1185 @code{d:}@var{number} -- Set radius of dot, in terms of fret spacing.
1189 @code{p:}@var{number} -- Set the position of the dot in the fret space.
1190 0.5 is centered; 1@tie{}is on lower fret bar, 0@tie{}is on upper fret bar.
1194 @code{c:}@var{string1}@code{-}@var{string2}@code{-}@var{fret} -- Include a
1195 barre mark from @var{string1} to @var{string2} on @var{fret}.
1198 @var{string}@code{-}@var{fret} -- Place a dot on @var{string} at @var{fret}.
1199 If @var{fret} is @samp{o}, @var{string} is identified as open.
1200 If @var{fret} is @samp{x}, @var{string} is identified as muted.
1203 @var{string}@code{-}@var{fret}@code{-}@var{fingering} -- Place a dot on
1204 @var{string} at @var{fret}, and label with @var{fingering} as defined
1205 by the @code{f:} code.
1209 Note: There is no limit to the number of fret indications per string.
1211 (let ((definition-list
1212 (fret-parse-definition-string props definition-string)))
1213 (fret-diagram-verbose-markup
1214 layout (car definition-list) (cdr definition-list))))
1216 (define-markup-command
1217 (fret-diagram-terse layout props definition-string)
1218 (string?) ; argument type
1219 #:category instrument-specific-markup ; markup category
1220 #:properties (fret-diagram-verbose-markup) ; properties
1221 "Make a fret diagram markup using terse string-based syntax.
1226 \\markup \\fret-diagram-terse #\"x;x;o;2;3;2;\"
1230 for a D@tie{}chord diagram.
1232 Syntax rules for @var{definition-string}:
1237 Strings are terminated by semicolons; the number of semicolons
1238 is the number of strings in the diagram.
1241 Mute strings are indicated by @samp{x}.
1244 Open strings are indicated by @samp{o}.
1247 A number indicates a fret indication at that fret.
1250 If there are multiple fret indicators desired on a string, they
1251 should be separated by spaces.
1254 Fingerings are given by following the fret number with a @w{@code{-},}
1255 followed by the finger indicator, e.g. @samp{3-2} for playing the third
1256 fret with the second finger.
1259 Where a barre indicator is desired, follow the fret (or fingering) symbol
1260 with @w{@code{-(}} to start a barre and @w{@code{-)}} to end the barre.
1263 ;; TODO -- change syntax to fret\string-finger
1264 (let ((definition-list
1265 (fret-parse-terse-definition-string props definition-string)))
1266 (fret-diagram-verbose-markup layout
1267 (car definition-list)
1268 (cdr definition-list))))