]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/fret-diagrams.scm
Use a `define-builtin-markup-command' macro for builtin markups, which
[lilypond.git] / scm / fret-diagrams.scm
index d3e5edb0cd192e4878d926520fb57f9942d9f951..a682a824be38baaa5d87f3c0f978e4028dd138b3 100644 (file)
@@ -2,9 +2,7 @@
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c) 2004 Carl D. Sorensen <c_sorensen@byu.edu>
-
-
+;;;; (c) 2004--2006 Carl D. Sorensen <c_sorensen@byu.edu>
 
 (define (fret-parse-marking-list marking-list fret-count)
    (let* ((fret-range (list 1 fret-count))
@@ -23,7 +21,8 @@
                      ((eq? my-code 'place-fret)
                         (set! dot-list (cons* (cdr my-item) dot-list))))
                  (parse-item (cdr mylist)))))
-               ; calculate fret-range
+      
+      ;; calculate fret-range
                (let ((maxfret 0) (minfret 99))
                     (let updatemax ((fret-list dot-list))
                         (if (null?  fret-list)
@@ -42,7 +41,9 @@
                (acons 'barre-list barre-list
                (acons 'dot-list dot-list
                (acons 'xo-list xo-list '()))))))
-   
+
+
+
 (define (subtract-base-fret base-fret dot-list)
 "Subtract @var{base-fret} from every fret in @var{dot-list}"  
   (if (null? dot-list)
@@ -60,19 +61,12 @@ with magnification @varr{mag} of the string @var{text}."
                    (prepend-alist-chain  'font-family 'sans props))))
         (interpret-markup layout my-props text)))
 
-(define (sans-serif-stencil-white layout props mag text)
-"create a stencil with white text in sans-serif font based on @var{layout} and @var{props}
-with magnification @varr{mag} of the string @var{text}."
-  (let* ((text-stencil (sans-serif-stencil layout props mag text))
-         (x-extent  (ly:stencil-extent text-stencil X))
-         (y-extent  (ly:stencil-extent text-stencil Y))
-         (c  `(white-text ,(* 2 mag) ,text))) ;urg -- workaround for using ps font
-    (ly:make-stencil c  x-extent y-extent)))  ;urg -- extent is not from ps font, but we hope it's close
-
 
 (define (draw-strings string-count fret-range th size)
-"Draw the strings (vertical 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}. "
+"Draw the strings (vertical 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}. "
   (let* ((fret-count (+ (- (cadr fret-range) (car fret-range)) 1))
          (sl (* (+ fret-count 1) size))
          (sth (* size th))
@@ -89,8 +83,9 @@ with magnification @varr{mag} of the string @var{text}."
          gap 0))))
 
 (define (draw-fret-lines fret-count string-count th size)
- "Draw @var{fret-count} frets (horizontal lines) for a fret diagram with @var{string-count} strings.
-   Line thickness is given by @var{th}, fret & string spacing by @var{size}. "
+ "Draw @var{fret-count} frets (horizontal lines) for a fret diagram
+with @var{string-count} strings.  Line thickness is given by @var{th},
+fret & string spacing by @var{size}. "
    (let* ((fret-length (* (- string-count 1) size))
           (sth (* size th))
           (half-thickness (* sth 0.5))
@@ -122,8 +117,10 @@ with magnification @varr{mag} of the string @var{text}."
  
  
 (define (draw-frets layout props fret-range string-count th size)
- "Draw the frets (horizontal 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}. "
+ "Draw the frets (horizontal 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}. "
   (let* ((fret-count (+ (- (cadr fret-range) (car fret-range)) 1))
          (fret-length (* (- string-count 1) size))
          (half-thickness (* th 0.5))
@@ -136,28 +133,21 @@ with magnification @varr{mag} of the string @var{text}."
                  (- size th) 0))) 
                  
 
-(define (centered-stencil stencil)
- "Center stencil @var{stencil} in both the X and Y directions"
- (let* ((output-stencil stencil))
-;     (if (= (cadr (ly:version)) 3)
-        (begin
-          (ly:stencil-align-to! output-stencil Y 0)
-          (ly:stencil-align-to! output-stencil X 0)
-          output-stencil)))
-;       (ly:stencil-align-to (ly:stencil-align-to text-stencil X 0) Y 0))))
-
-(define (draw-dots layout props string-count fret-range size finger-code dot-position dot-radius dot-list)
+(define (draw-dots layout props string-count fret-range size finger-code 
+                    dot-position dot-radius dot-thickness dot-list)
   "Make dots for fret diagram."
+
   (let* ((scale-dot-radius (* size dot-radius))
+         (scale-dot-thick (* size dot-thickness))
          (dot-color (chain-assoc-get 'dot-color props 'black))
 ;         (finger-xoffset (chain-assoc-get 'finger-xoffset props -0.25))
 ;         (finger-yoffset (chain-assoc-get 'finger-yoffset props (- size)))
          (finger-xoffset -0.25)
-         (finger-yoffset (- size))
+         (finger-yoffset (- (* size 0.5)))
 ;         (dot-label-font-mag (* scale-dot-radius (chain-assoc-get 'dot-label-font-mag props 1.0)))
          (dot-label-font-mag scale-dot-radius)
 ;         (string-label-font-mag (* size (chain-assoc-get 'label-font-mag props 0.7)))
-         (string-label-font-mag (* size 0.7))
+         (string-label-font-mag (* size 0.6))
          (fret-count (+ (- (cadr fret-range) (car fret-range) 1)))
          (mypair (car dot-list))
          (restlist (cdr dot-list))
@@ -169,46 +159,51 @@ with magnification @varr{mag} of the string @var{text}."
          (finger (caddr mypair))
          (finger (if (number? finger) (number->string finger) finger))
          (dotstencil  (if (eq? dot-color 'white)
-                          (begin
-                          (ly:make-stencil (list 'white-dot 0 0 scale-dot-radius) extent extent))
-                          (ly:make-stencil (list 'dot 0 0 scale-dot-radius ) extent extent)))
-         (positioned-dot (ly:stencil-translate-axis
-                           (ly:stencil-translate-axis dotstencil xpos X)
-                           ypos Y))
+                          (ly:stencil-add 
+                              (make-circle-stencil scale-dot-radius scale-dot-thick #t)
+                              (ly:stencil-in-color
+                                    (make-circle-stencil 
+                                        (- scale-dot-radius (* 0.5 scale-dot-thick)) 0  #t)
+                                    1 1 1))
+                          (make-circle-stencil scale-dot-radius scale-dot-thick #t))) 
+         (positioned-dot (begin
+                           ;(display dotstencil)
+                           (ly:stencil-translate-axis
+                             (ly:stencil-translate-axis dotstencil xpos X)
+                           ypos Y)))
+
          (labeled-dot-stencil 
                  (if (or (eq? finger '())(eq? finger-code 'none))
                      positioned-dot
-                 (if (eq? finger-code 'in-dot)
-                    (let*  ((dot-proc (if (eq? dot-color 'white) 'white-dot 'dot)))
-                     (ly:stencil-add 
-                        (ly:stencil-translate-axis 
-                          (ly:stencil-translate-axis 
-                              (if (eq? dot-color 'white)
-                              (centered-stencil (sans-serif-stencil layout props dot-label-font-mag finger))
-                              (centered-stencil (sans-serif-stencil-white layout props 
-                                                 dot-label-font-mag  finger)))
-                               xpos X)
-                              ypos Y)
-                        (ly:stencil-translate-axis
-                           (ly:stencil-translate-axis 
-                              (ly:make-stencil (list dot-proc 0 0 scale-dot-radius) extent extent)
+                     (if (eq? finger-code 'in-dot)
+                         (let*  ((finger-label (centered-stencil 
+                                           (sans-serif-stencil layout props
+                                                  dot-label-font-mag finger))))
+                         (ly:stencil-translate-axis 
+                            (ly:stencil-translate-axis 
+                             (ly:stencil-add 
+                                dotstencil
+                                (if (eq? dot-color 'white)
+                                     finger-label
+                                     (ly:stencil-in-color finger-label 1 1 1))) 
                                xpos X)
-                           ypos Y)))
+                              ypos Y))
                  (if (eq? finger-code 'below-string) 
                      (ly:stencil-add 
                          positioned-dot
                          (ly:stencil-translate-axis 
                              (ly:stencil-translate-axis 
                                  (centered-stencil (sans-serif-stencil layout props 
-                                                        string-label-font-mag finger)) xpos  X)
-                             (* size finger-yoffset) Y))
+                                                        string-label-font-mag finger))
+                              xpos  X)
+                          (* size finger-yoffset) Y))
                      ;unknown finger-code
                      positioned-dot)))))
     (if (null? restlist) 
         labeled-dot-stencil
         (ly:stencil-add 
             (draw-dots layout props string-count fret-range size finger-code 
-                          dot-position dot-radius restlist)
+                          dot-position dot-radius dot-thickness restlist)
             labeled-dot-stencil))))
 
 (define (draw-xo layout props string-count fret-range size xo-list) 
@@ -231,8 +226,9 @@ with magnification @varr{mag} of the string @var{text}."
             glyph-stencil))))
 
 (define (make-bezier-sandwich-list left right bottom height thickness)
-" Make the argument list for a horizontal bezier sandwich from @var{left} to @var{right} with a bottom at @var{bottom}, 
-  a height of @var{height}, and a thickness of @var{thickness}."
+" Make the argument list for a horizontal bezier sandwich from
+@var{left} to @var{right} with a bottom at @var{bottom}, a height of
+@var{height}, and a thickness of @var{thickness}."
    (let* ((width (+ (- right left) 1))
           (x1 (+ (* width thickness) left))
           (x2 (- right (* width thickness)))
@@ -248,25 +244,26 @@ with magnification @varr{mag} of the string @var{text}."
    (if (not (null? barre-list))
      (let* ((string1 (caar barre-list))
             (string2 (cadar barre-list))
-            (fret    (caddar barre-list))
+            (fret (caddar barre-list))
             (barre-type (chain-assoc-get 'barre-type props 'curved))
             (scale-dot-radius (* size dot-radius))
             (barre-vertical-offset (chain-assoc-get 'barre-vertical-offset props 0.5))
-            ; 2 is 1 for empty fret at bottom of figure + 1 for interval (top-fret - fret + 1) -- not an arbitrary constant
-            (dot-center-y (* size (- (+ 2 (- (cadr fret-range) fret))dot-position) ))
-            (bottom (+  dot-center-y (* barre-vertical-offset scale-dot-radius)))
+            ;; 2 is 1 for empty fret at bottom of figure + 1 for interval (top-fret - fret + 1) -- not an arbitrary constant
+            (dot-center-y (* size
+                            (- (+ 2 (- (cadr fret-range) fret)) dot-position)))
+            (bottom (+ dot-center-y (* barre-vertical-offset scale-dot-radius)))
             (left (* size (- string-count string1)))
             (right (* size (- string-count string2)))
-;            (bezier-thick (chain-assoc-get 'bezier-thickness props 0.1))
+;;            (bezier-thick (chain-assoc-get 'bezier-thickness props 0.1))
             (bezier-thick 0.1)
-;            (bezier-height (chain-assoc-get 'bezier-height props 0.5))
+;;            (bezier-height (chain-assoc-get 'bezier-height props 0.5))
             (bezier-height 0.5)
             (bezier-list (make-bezier-sandwich-list left right bottom (* size bezier-height) (* size bezier-thick)))
             (barre-stencil (if (eq? barre-type 'straight)
                               (ly:make-stencil (list 'draw-line (* size dot-radius) left dot-center-y right dot-center-y)
                                                (cons left right)
                                                (cons (- dot-center-y scale-dot-radius) (+ dot-center-y scale-dot-radius))) 
-                              (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick) )
+                              (ly:make-stencil (list 'bezier-sandwich `(quote ,bezier-list) (* size bezier-thick))
                                   (cons left right)
                                   (cons bottom (+ bottom (* size bezier-height)))))))
         (if (not (null? (cdr barre-list)))
@@ -274,7 +271,6 @@ with magnification @varr{mag} of the string @var{text}."
                  (draw-barre layout props string-count fret-range size finger-code 
                       dot-position dot-radius (cdr barre-list)))
             barre-stencil ))))
-
   
 (define (stepmag mag)
 "Calculate the font step necessary to get a desired magnification"
@@ -284,7 +280,7 @@ with magnification @varr{mag} of the string @var{text}."
    "Label the base fret on a fret diagram"
    (let* ((base-fret (car fret-range))
 ;          (label-font-mag (chain-assoc-get 'label-font-mag props 0.7))
-          (label-font-mag 0.7)
+          (label-font-mag 0.5)
 ;          (label-vertical-offset (chain-assoc-get 'fret-label-vertical-offset props -0.2))
           (label-vertical-offset -0.2)
          (number-type (chain-assoc-get 'number-type props 'roman-lower))
@@ -299,14 +295,14 @@ with magnification @varr{mag} of the string @var{text}."
            (sans-serif-stencil layout props (* size label-font-mag) label-text) 
                        (* size (+ fret-count label-vertical-offset)) Y)))
  
-(def-markup-command (fret-diagram-verbose layout props marking-list)
+(define-builtin-markup-command (fret-diagram-verbose layout props marking-list)
   (list?)
   "Make a fret diagram containing the symbols indicated in @var{marking-list}
   
   For example,
   
 @example
-   \\markup \\fret-diagram #'((mute 6) (mute 5) (open 4)
+   \\markup \\fret-diagram-verbose #'((mute 6) (mute 5) (open 4)
         (place-fret 3 2) (place-fret 2 3) (place-fret 1 2))
 @end example 
   
@@ -324,11 +320,19 @@ Place a small 'o' at the top of string @var{string-number}
 Place a barre indicator (much like a tie) from string @var{start-string}to string @var{end-string} at fret @var{fret-number}
 
 @item (place-fret string-number fret-number finger-value)
-Place a fret playing indication on string @var{string-number} at fret @var{fret-number} with an optional 
-fingering label @var{finger-value}.  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 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.
+
+Place a fret playing indication on string @var{string-number} at fret
+@var{fret-number} with an optional fingering label @var{finger-value}.
+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 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.
+
+
+
+
 @end table
 "
    (make-fret-diagram layout props marking-list))
@@ -350,13 +354,13 @@ part of the place-fret element is present, @var{finger-value} will be displayed
          (default-dot-position (if (eq? finger-code 'in-dot) (- 0.95 default-dot-radius) 0.6))  ; move up to make room for bigger if labeled
          (dot-radius (chain-assoc-get 'dot-radius props default-dot-radius))  ; needed for both draw-dots and draw-barre
          (dot-position (chain-assoc-get 'dot-position props default-dot-position)) ; needed for both draw-dots and draw-barre
-         (th (* (ly:output-def-lookup layout 'linethickness)
+         (th (* (ly:output-def-lookup layout 'line-thickness)
                 (chain-assoc-get 'thickness props 0.5))) ; needed for both draw-frets and draw-strings
                 
          (alignment (chain-assoc-get 'align-dir props -0.4)) ; needed only here
 ;         (xo-padding (* th (chain-assoc-get 'padding props 2))) ; needed only here
-         (label-space 0.25)
-         (xo-padding (* th 2))
+         (label-space (* 0.25 size))
+         (xo-padding (* th size 5))
          (label-dir (chain-assoc-get 'label-dir props RIGHT))
          (parameters (fret-parse-marking-list marking-list fret-count))
          (dot-list (cdr (assoc 'dot-list parameters)))
@@ -373,9 +377,9 @@ part of the place-fret element is present, @var{finger-value} will be displayed
                                     fret-diagram-stencil)))
          (if (not (null? dot-list))
              (set! fret-diagram-stencil (ly:stencil-add
+                                    fret-diagram-stencil
                                     (draw-dots layout props string-count fret-range size finger-code 
-                                          dot-position dot-radius dot-list)
-                                    fret-diagram-stencil)))
+                                          dot-position dot-radius th dot-list))))
          (if (not (null? xo-list))
              (set! fret-diagram-stencil (ly:stencil-combine-at-edge
                                     fret-diagram-stencil Y UP
@@ -384,10 +388,10 @@ part of the place-fret element is present, @var{finger-value} will be displayed
              (set! fret-diagram-stencil
                    (ly:stencil-combine-at-edge fret-diagram-stencil X label-dir
                                               (label-fret layout props string-count fret-range size) label-space 0)))
-         (ly:stencil-align-to! fret-diagram-stencil X alignment)
-         fret-diagram-stencil))
+         (ly:stencil-aligned-to fret-diagram-stencil X alignment)
+        ))
          
-(def-markup-command (fret-diagram layout props definition-string)
+(define-builtin-markup-command (fret-diagram layout props definition-string)
   (string?)
   "  
 Example
@@ -507,7 +511,7 @@ Note:  There is no limit to the number of fret indications per string.
                  
 (define (get-numeric-from-key keystring)
  "Get the numeric value from a key  of the form k:val"
-    (string->number (substring keystring 2  (string-length keystring) )))
+    (string->number (substring keystring 2 (string-length keystring))))
   
 (define (numerify mylist)
  "Convert string values to numeric or character"
@@ -518,13 +522,13 @@ Note:  There is no limit to the number of fret indications per string.
                 (cons* numeric-value (numerify (cdr mylist)))
                 (cons* (car (string->list (car mylist))) (numerify (cdr mylist)))))))
            
-(def-markup-command (fret-diagram-terse layout props definition-string)
+(define-builtin-markup-command (fret-diagram-terse layout props definition-string)
   (string?)
   "Make a fret diagram markup using terse string-based syntax.
 
 Example
 @example
- \\markup \\fret-diagram #\"x;x;o;2;3;2;\" 
+ \\markup \\fret-diagram-terse #\"x;x;o;2;3;2;\" 
 @end example
 for a D chord diagram.