scm/output-lib.scm

   1 ;;;; output-lib.scm -- implement Scheme output helper functions
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2002 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8 ; Tablature functions, by Jiba (jiba@tuxfamily.org)
   9
  10 ; The TabNoteHead stem attachment function.
  11 (define (tablature-stem-attachment-function style duration)
  12   (cons 0.0 0.5) ;; UGH!
  13 )
  14
  15 ; The TabNoteHead molecule callback.
  16 ; Create a text molecule
  17 (define-public (tablature-molecule-callback grob)
  18   (let ((molecule (fontify-text
  19                    (ly:get-default-font grob)
  20                    (ly:get-grob-property grob 'text)
  21                    )))
  22     molecule ; return the molecule.
  23     )
  24   )
  25
  26 ; The TabNoteHead tablatureFormat callback.
  27 ; Compute the text grob-property
  28 (define-public (fret-number-tablature-format string tuning pitch)
  29   (number->string
  30    (- (ly:pitch-semitones pitch)
  31       (list-ref tuning
  32                 (- string 1) ; remove 1 because list index starts at 0 and guitar string at 1.
  33                 )
  34       )
  35    )
  36   )
  37
  38 (define-public (hammer-molecule-callback grob)
  39   (let* ((note-collums (ly:get-grob-property grob 'note-columns))
  40          (note-column1 (cadr note-collums))
  41          (note-column2 (car  note-collums))
  42          (note1        (car (ly:get-grob-property note-column1 'note-heads)))
  43          (note2        (car (ly:get-grob-property note-column2 'note-heads)))
  44          (fret1        (string->number (ly:get-grob-property note1 'text)))
  45          (fret2        (string->number (ly:get-grob-property note2 'text)))
  46          (letter       (if (< fret1 fret2) "H"
  47                        (if (> fret1 fret2) "P"
  48                                            "")))
  49          )
  50     (let ((slur (Slur::brew_molecule grob))
  51           (text (fontify-text (ly:get-default-font grob) letter)))
  52
  53       (let ((x (/ (- (cdr (ly:molecule-get-extent slur 0))
  54                      (/ (cdr (ly:molecule-get-extent text 0)) 2.0)
  55                      )
  56                   -2.0)))
  57
  58         (ly:molecule-set-extent! text 0 (cons x x))
  59         (ly:molecule-align-to! text 0 1)
  60         )
  61
  62       (ly:molecule-combine-at-edge slur 1 1 text -0.6)
  63       )
  64     )
  65   )
  66
  67
  68
  69 (define-public guitar-tunings '(4 -1 -5 -10 -15 -20))
  70
  71 ; end of tablature functions
  72
  73
  74 (define-public (make-molecule-boxer line-thick x-padding y-padding callback)
  75    "Makes a routine that adds a box around the grob parsed as argument"
  76   (define (molecule-boxer grob)
  77   (let*
  78    (
  79     (mol    (callback grob))
  80     (x-ext (widen-interval (ly:molecule-get-extent mol 0) x-padding))
  81     (y-ext (widen-interval (ly:molecule-get-extent mol 1) y-padding))
  82     (x-rule (box-molecule (widen-interval x-ext line-thick)
  83                               (cons 0 line-thick)))
  84     (y-rule (box-molecule (cons 0 line-thick) y-ext))
  85     )
  86
  87     (set! mol (ly:molecule-combine-at-edge mol 0 1 y-rule x-padding))
  88     (set! mol (ly:molecule-combine-at-edge mol 0 -1  y-rule x-padding))
  89     (set! mol (ly:molecule-combine-at-edge mol 1 1  x-rule 0))
  90     (set! mol (ly:molecule-combine-at-edge mol 1 -1 x-rule 0))
  91
  92     mol
  93  ))
  94  molecule-boxer
  95  )
  96
  97 ;;(define (mm-to-pt x)
  98 ;;  (* (/ 72.27 25.40) x))
  99
 100 ;; do nothing in .scm output
 101 (define (comment s) "")
 102
 103 (define-public (numbers->string l)
 104   (apply string-append (map ly:number->string l)))
 105
 106 ; (define (chop-decimal x) (if (< (abs x) 0.001) 0.0 x))
 107
 108 (define (number->octal-string x)
 109   (let* ((n (inexact->exact x))
 110          (n64 (quotient n 64))
 111          (n8 (quotient (- n (* n64 64)) 8)))
 112     (string-append
 113      (number->string n64)
 114      (number->string n8)
 115      (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
 116
 117 (define-public (inexact->string x radix)
 118   (let ((n (inexact->exact x)))
 119     (number->string n radix)))
 120
 121
 122 (define-public (number-pair->string c)
 123   (string-append (number->string (car c)) " "
 124                  (number->string (cdr c)) " "))
 125
 126 (define (font i)
 127   (string-append
 128    "font"
 129    (make-string 1 (integer->char (+ (char->integer #\A) i)))))
 130
 131 (define (scm-scm action-name)
 132   1)
 133
 134
 135 ;; silly, use alist?
 136 (define-public (find-notehead-symbol duration style)
 137   (case style
 138    ((xcircle) "2xcircle")
 139    ((harmonic) "0neo_mensural")
 140    ((baroque)
 141     ;; Oops, I actually would not call this "baroque", but, for
 142     ;; backwards compatibility to 1.4, this is supposed to take
 143     ;; brevis, longa and maxima from the neo-mensural font and all
 144     ;; other note heads from the default font.  -- jr
 145     (if (< duration 0)
 146         (string-append (number->string duration) "neo_mensural")
 147         (number->string duration)))
 148    ((mensural)
 149     (string-append (number->string duration) (symbol->string style)))
 150    ((neo_mensural)
 151     (string-append (number->string duration) (symbol->string style)))
 152    ((default)
 153     ;; The default font in mf/feta-bolletjes.mf defines a brevis, but
 154     ;; neither a longa nor a maxima.  Hence let us, for the moment,
 155     ;; take these from the neo-mensural font.  TODO: mf/feta-bolletjes
 156     ;; should define at least a longa for the default font.  The longa
 157     ;; should look exactly like the brevis of the default font, but
 158     ;; with a stem exactly like that of the quarter note. -- jr
 159     (if (< duration -1)
 160         (string-append (number->string duration) "neo_mensural")
 161         (number->string duration)))
 162    (else
 163     (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
 164         (symbol->string style)
 165         (string-append (number->string (max 0 duration))
 166                        (symbol->string style))))))
 167
 168
 169 (define (note-head-style->attachment-coordinates style duration)
 170   "Return pair (X . Y), containing multipliers for the note head
 171 bounding box, where to attach the stem. e.g.: X==0 means horizontally
 172 centered, X==1 is at the right, X == -1 is at the left."
 173
 174   (case style
 175     ((default)
 176      (if (< duration -1)
 177          '(0.0 . 0.6) ;; neo-mensural
 178          '(1.0 . 0.5) ;; default
 179          ))
 180     ((cross) '(1.0 . 0.75))
 181     ((mensural) '(0.0 . 0.6))
 182     ((neo_mensural) '(0.0 . 0.6))
 183     ((diamond) '(1.0 . 0.8))
 184     ((transparent) '(1.0 . 1.0))
 185     ((slash) '(1.0 . 1.0))
 186     ((harmonic) '(1.0 0.0))
 187     ((triangle) '(0.75 . 0.15))
 188     ((baroque)
 189      (if (< duration 0)
 190          '(0.0 . 0.6) ;; neo-mensural
 191          '(1.0 . 0.5) ;; default
 192          ))
 193     (else
 194
 195      ;; this also works for easy notation.
 196      '(1.0 . 0.0)
 197      )))
 198
 199 (define-public (string-encode-integer i)
 200   (cond
 201    ((= i  0) "o")
 202    ((< i 0)   (string-append "n" (string-encode-integer (- i))))
 203    (else (string-append
 204           (make-string 1 (integer->char (+ 65 (modulo i 26))))
 205           (string-encode-integer (quotient i 26))))))
 206
 207
 208 (define-public ((every-nth-bar-number-visible n) barnum) (= 0 (modulo barnum n)))
 209
 210 (define-public ((modulo-bar-number-visible n m) barnum) (and (> barnum 1) (= m (modulo barnum n))))
 211
 212 (define-public ((set-bar-number-visibility n) tr)
 213   (let* ((bn (ly:get-context-property tr 'currentBarNumber)))
 214    (ly:set-context-property tr 'barNumberVisibility (modulo-bar-number-visible n (modulo bn n))))
 215 )
 216
 217 (define-public (default-bar-number-visibility barnum) (> barnum 1))
 218
 219 ;; See documentation of Item::visibility_lambda_
 220 (define-public (begin-of-line-visible d) (if (= d 1) '(#f . #f) '(#t . #t)))
 221 (define-public (end-of-line-visible d) (if (= d -1) '(#f . #f) '(#t . #t)))
 222 (define-public (spanbar-begin-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 223
 224 (define-public (all-visible d) '(#f . #f))
 225 (define-public (all-invisible d) '(#t . #t))
 226 (define-public (begin-of-line-invisible d) (if (= d 1) '(#t . #t) '(#f . #f)))
 227 (define-public (end-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 228
 229
 230 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 231 ;; Bar lines.
 232
 233 ;
 234 ; How should a  bar line behave at a break?
 235 ;
 236 ;; Why prepend `default-' to every scm identifier?
 237 (define-public (default-break-barline glyph dir)
 238    (let ((result (assoc glyph
 239                         '((":|:" . (":|" . "|:"))
 240                           ("||:" . ("||" . "|:"))
 241                           ("|" . ("|" . ()))
 242                           ("||:" . ("||" . "|:"))
 243                           ("|s" . (() . "|"))
 244                           ("|:" . ("|" . "|:"))
 245                           ("|." . ("|." . ()))
 246
 247                           ;; hmm... should we end with a barline here?
 248                           (".|" . ("|" . ".|"))
 249                           (":|" . (":|" . ()))
 250                           ("||" . ("||" . ()))
 251                           (".|." . (".|." . ()))
 252                           ("" . ("" . ""))
 253                           ("empty" . (() . ()))
 254                           ("brace" . (() . "brace"))
 255                           ("bracket" . (() . "bracket"))
 256                           )
 257                         )))
 258
 259      (if (equal? result #f)
 260          (ly:warn (string-append "Unknown bar glyph: `" glyph "'"))
 261          (index-cell (cdr result) dir))
 262      )
 263    )
 264