;;;; clef.scm -- Clef settings
;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;; 
;;;; (c)  2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>


;; (name . (glyph clef-position octavation))
;;
;; -- the name clefOctavation is misleading. The value 7 is 1 octave,
;; not 7 Octaves.
(define supported-clefs
  '(("treble" . ("clefs-G" -2 0))
    ("violin" . ("clefs-G" -2 0))
    ("G" . ("clefs-G" -2 0))
    ("G2" . ("clefs-G" -2 0))
    ("french" . ("clefs-G" -4 0))
    ("soprano" . ("clefs-C" -4 0))
    ("mezzosoprano" . ("clefs-C" -2 0))
    ("alto" . ("clefs-C" 0 0))
    ("C" . ("clefs-C" 0 0))
    ("tenor" . ("clefs-C" 2 0))
    ("baritone" . ("clefs-C" 4 0))
    ("varbaritone" . ("clefs-F" 0 0))
    ("bass" . ("clefs-F" 2 0))
    ("F" . ("clefs-F" 2 0))
    ("subbass" . ("clefs-F" 4 0))
    ("percussion" . ("clefs-percussion" 0 0))
    ("tab" . ("clefs-tab" 0 0))

    ;; should move mensural stuff to separate file? 
    ("vaticana-do1" . ("clefs-vaticana-do" -1 0))
    ("vaticana-do2" . ("clefs-vaticana-do" 1 0))
    ("vaticana-do3" . ("clefs-vaticana-do" 3 0))
    ("vaticana-fa1" . ("clefs-vaticana-fa" -1 0))
    ("vaticana-fa2" . ("clefs-vaticana-fa" 1 0))
    ("medicaea-do1" . ("clefs-medicaea-do" -1 0))
    ("medicaea-do2" . ("clefs-medicaea-do" 1 0))
    ("medicaea-do3" . ("clefs-medicaea-do" 3 0))
    ("medicaea-fa1" . ("clefs-medicaea-fa" -1 0))
    ("medicaea-fa2" . ("clefs-medicaea-fa" 1 0))
    ("hufnagel-do1" . ("clefs-hufnagel-do" -1 0))
    ("hufnagel-do2" . ("clefs-hufnagel-do" 1 0))
    ("hufnagel-do3" . ("clefs-hufnagel-do" 3 0))
    ("hufnagel-fa1" . ("clefs-hufnagel-fa" -1 0))
    ("hufnagel-fa2" . ("clefs-hufnagel-fa" 1 0))
    ("hufnagel-do-fa" . ("clefs-hufnagel-do-fa" 4 0))
    ("mensural-c1" . ("clefs-mensural-c" -2 0))
    ("mensural-c2" . ("clefs-mensural-c" 0 0))
    ("mensural-c3" . ("clefs-mensural-c" 2 0))
    ("mensural-c4" . ("clefs-mensural-c" 4 0))
    ("mensural-f" . ("clefs-mensural-f" 2 0))
    ("mensural-g" . ("clefs-mensural-g" -2 0))
    ("neomensural-c1" . ("clefs-neomensural-c" -4 0))
    ("neomensural-c2" . ("clefs-neomensural-c" -2 0))
    ("neomensural-c3" . ("clefs-neomensural-c" 0 0))
    ("neomensural-c4" . ("clefs-neomensural-c" 2 0))
    ("petrucci-c1" . ("clefs-petrucci-c1" -4 0))
    ("petrucci-c2" . ("clefs-petrucci-c2" -2 0))
    ("petrucci-c3" . ("clefs-petrucci-c3" 0 0))
    ("petrucci-c4" . ("clefs-petrucci-c4" 2 0))
    ("petrucci-c5" . ("clefs-petrucci-c5" 4 0))
    ("petrucci-f" . ("clefs-petrucci-f" 2 0))
    ("petrucci-g" . ("clefs-petrucci-g" -2 0))))

;; "an alist mapping GLYPHNAME to the position of the middle C for
;; that symbol"
(define c0-pitch-alist
  '(("clefs-G" . -4)
    ("clefs-C" . 0)
    ("clefs-F" . 4)
    ("clefs-percussion" . 0)
    ("clefs-tab" . 0 )
    ("clefs-vaticana-do" . 0)
    ("clefs-vaticana-fa" . 4)
    ("clefs-medicaea-do" . 0)
    ("clefs-medicaea-fa" . 4)
    ("clefs-hufnagel-do" . 0)
    ("clefs-hufnagel-fa" . 4)
    ("clefs-hufnagel-do-fa" . 0)
    ("clefs-mensural-c" . 0)
    ("clefs-mensural-f" . 4)
    ("clefs-mensural-g" . -4)
    ("clefs-neomensural-c" . 0)
    ("clefs-petrucci-c1" . 0)
    ("clefs-petrucci-c2" . 0)
    ("clefs-petrucci-c3" . 0)
    ("clefs-petrucci-c4" . 0)
    ("clefs-petrucci-c5" . 0)
    ("clefs-petrucci-f" . 4)
    ("clefs-petrucci-g" . -4)))

(define-public (make-clef-set clef-name)
  "Generate the clef setting commands for a clef with name CL."
  (define (make-prop-set props)
    (let ((m (make-music 'PropertySet)))
      (map (lambda (x) (set! (ly:music-property m (car x)) (cdr x))) props)
      m))
  (let ((e '())
	(c0 0)
	(oct 0)
	(match (string-match "^(.*)([_^])([0-9]+)$" clef-name)))
    (if match
	(begin
	  (set! clef-name (match:substring match 1))
	  (set! oct
		(* (if (equal? (match:substring match 2) "^") -1 1)
		   (- (string->number (match:substring match 3)) 1)))))
    (set! e (assoc clef-name supported-clefs))
    (if (pair? e)
	(let* ((musics (map make-prop-set  
			    `(((symbol . clefGlyph) (value . ,(cadr e)))
			      ((symbol . middleCPosition)
			       (value . ,(+ oct
					    (caddr e)
					    (cdr (assoc (cadr e) c0-pitch-alist)))))
			      ((symbol . clefPosition) (value . ,(caddr e)))
			      ((symbol . clefOctavation) (value . ,(- oct))))))
	       (seq (make-music 'SequentialMusic
				'elements musics))
	       (csp (make-music 'ContextSpeccedMusic)))
	  (context-spec-music seq 'Staff))
	(begin
	  (ly:warn "Unknown clef type `~a'
See scm/lily.scm for supported clefs" clef-name)
	  (make-music 'Music)))))

