-;;;; fret-diagrams.scm --
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
+;;;; Copyright (C) 2004--2012 Carl D. Sorensen <c_sorensen@byu.edu>
;;;;
-;;;; (c) 2004--2009 Carl D. Sorensen <c_sorensen@byu.edu>
+;;;; 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 <http://www.gnu.org/licenses/>.
;
; Utility functions
(if (null? dot-list)
'()
(let ((this-list (car dot-list)))
- (cons* (list (car this-list) (- (second this-list) base-fret)
- (if (null? (cddr this-list))
- '()
- (third this-list)))
+ (cons* (list
+ ;; string
+ (car this-list)
+ ;; fret
+ (- (second this-list) base-fret)
+ ;; finger
+ (if (null? (cddr this-list))
+ '()
+ (third this-list))
+ ;; color modifier
+ (if (or (null? (cddr this-list))
+ (null? (cdddr this-list)))
+ '()
+ (fourth this-list)))
(subtract-base-fret base-fret (cdr dot-list))))))
(define (drop-paren item-list)
(define (merge-details key alist-list . default)
"Return @code{alist-list} entries for @code{key}, in one combined alist.
-There can be two @code{alist-list} entries for a given key. The first
+There can be two @code{alist-list} entries for a given key. The first
comes from the override-markup function, the second comes
from property settings during a regular override.
This is necessary because some details can be set in one
(thickness-factor (assoc-get 'string-thickness-factor details 0))
(alignment
(chain-assoc-get 'align-dir props -0.4)) ; needed only here
- (xo-padding
- (* size (assoc-get 'xo-padding details 0.2))) ; needed only here
+ (xo-padding (assoc-get 'xo-padding details 0.2)) ; needed only here
(parameters (fret-parse-marking-list marking-list my-fret-count))
(capo-fret (assoc-get 'capo-fret parameters 0))
(dot-list (assoc-get 'dot-list parameters))
"Draw the string lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
-@var{size}. Orientation is determined by @var{orientation}. "
+@var{size}. Orientation is determined by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
"Draw the fret lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
-@var{size}. Orientation is given by @var{orientation}."
+@var{size}. Orientation is given by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
(fret-stencil (car x))
(+ (* size end-string-coordinate) half-thickness)))
(x-extent (cons (car box-lower-left) (car box-upper-right)))
(y-extent (cons (cdr box-lower-left) (cdr box-upper-right))))
- (ly:make-stencil
- (list 'bezier-sandwich
- `(quote ,bezier-list)
- (* size bezier-thick))
+ (make-bezier-sandwich-stencil
+ bezier-list
+ (* size bezier-thick)
x-extent
y-extent)))
(let* ( (scale-dot-radius (* size dot-radius))
(scale-dot-thick (* size th))
- (dot-color (assoc-get 'dot-color details 'black))
+ (default-dot-color (assoc-get 'dot-color details 'black))
(finger-label-padding 0.3)
(dot-label-font-mag
(* scale-dot-radius
(extent (cons (- scale-dot-radius) scale-dot-radius))
(finger (caddr mypair))
(finger (if (number? finger) (number->string finger) finger))
+ (inverted-color (eq? 'inverted (cadddr mypair)))
+ (dot-color (if (or (and (eq? default-dot-color 'black) inverted-color)
+ (and (eq? default-dot-color 'white) (not inverted-color)))
+ 'white
+ 'black))
(dot-stencil (if (eq? dot-color 'white)
(ly:stencil-add
(make-circle-stencil
"Put open and mute string indications on diagram, as contained in
@var{xo-list}."
(let* ((xo-font-mag
- (* size (assoc-get
- 'xo-font-magnification details
+ (assoc-get 'xo-font-magnification details
(cond ((or (eq? orientation 'landscape)
(eq? orientation 'opposing-landscape))
0.4)
- (else 0.4)))))
+ (else 0.4))))
(mypair (car xo-list))
(restlist (cdr xo-list))
(glyph-string (if (eq? (car mypair) 'mute)
(fancy-format #f "~@r" base-fret))
((equal? 'arabic number-type)
(fancy-format #f "~d" base-fret))
+ ((equal? 'custom number-type)
+ (fancy-format #f
+ (assoc-get 'fret-label-custom-format
+ details "~a")
+ base-fret))
(else (fancy-format #f "~(~@r~)" base-fret))))
(label-stencil
(centered-stencil
(ly:stencil-translate
label-stencil
(stencil-coordinates
- (1+ (* size label-vertical-offset))
+ (* size (+ 1.0 label-vertical-offset))
(if (eq? label-dir LEFT)
(- label-outside-diagram)
(+ (* size (1- string-count)) label-outside-diagram))))))
`(,props . ,output-list))) ; ugh -- hard coded; proc is better
-(define-builtin-markup-command
+(define-markup-command
(fret-diagram-verbose layout props marking-list)
(pair?) ; argument type (list, but use pair? for speed)
- instrument-specific-markup ; markup type
- ((align-dir -0.4) ; properties and defaults
- (size 1.0)
- (fret-diagram-details)
- (thickness 0.5))
+ #:category instrument-specific-markup ; markup type
+ #:properties ((align-dir -0.4) ; properties and defaults
+ (size 1.0)
+ (fret-diagram-details)
+ (thickness 0.5))
"Make a fret diagram containing the symbols indicated in @var{marking-list}.
For example,
at fret location @var{fret-number}. Also, set fret @var{fret-number}
to be the lowest fret on the fret diagram.
-@item (place-fret @var{string-number} @var{fret-number} @var{finger-value})
+@item (place-fret @var{string-number} @var{fret-number} [@var{finger-value} [@var{color-modifier}]])
Place a fret playing indication on string @var{string-number} at fret
-@var{fret-number} with an optional fingering label @var{finger-value}.
+@var{fret-number} with an optional fingering label @var{finger-value},
+and an optional color modifier @var{color-modifier}.
By default, the fret playing indicator is a solid dot. This can be
-changed by setting the value of the variable @var{dot-color}. If the
-@var{finger} part of the @code{place-fret} element is present,
+globally changed by setting the value of the variable @var{dot-color}.
+Setting @var{color-modifier} to @code{inverted} inverts the dot color
+for a specific fingering.
+If the @var{finger} part of the @code{place-fret} element is present,
@var{finger-value} will be displayed according to the setting of the
variable @var{finger-code}. There is no limit to the number of fret
indications per string.
(make-fret-diagram layout props marking-list))
-(define-builtin-markup-command (fret-diagram layout props definition-string)
+(define-markup-command (fret-diagram layout props definition-string)
(string?) ; argument type
- instrument-specific-markup ; markup category
- (fret-diagram-verbose-markup) ; properties and defaults
+ #:category instrument-specific-markup ; markup category
+ #:properties (fret-diagram-verbose-markup) ; properties and defaults
"Make a (guitar) fret diagram. For example, say
@example
(fret-diagram-verbose-markup
layout (car definition-list) (cdr definition-list))))
-(define-builtin-markup-command
+(define-markup-command
(fret-diagram-terse layout props definition-string)
(string?) ; argument type
- instrument-specific-markup ; markup category
- (fret-diagram-verbose-markup) ; properties
+ #:category instrument-specific-markup ; markup category
+ #:properties (fret-diagram-verbose-markup) ; properties
"Make a fret diagram markup using terse string-based syntax.
Here is an example
should be separated by spaces.
@item
-Fingerings are given by following the fret number with a @code{-},
+Fingerings are given by following the fret number with a @w{@code{-},}
followed by the finger indicator, e.g. @samp{3-2} for playing the third
fret with the second finger.
@item
Where a barre indicator is desired, follow the fret (or fingering) symbol
-with @code{-(} to start a barre and @code{-)} to end the barre.
+with @w{@code{-(}} to start a barre and @w{@code{-)}} to end the barre.
@end itemize"
;; TODO -- change syntax to fret\string-finger