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--2003 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 (make-filled-box-molecule (widen-interval x-ext line-thick)
  83                               (cons 0 line-thick)))
  84     (y-rule (make-filled-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-public (arg->string arg)
  98   (cond ((number? arg) (inexact->string arg 10))
  99         ((string? arg) (string-append "\"" arg "\""))
 100         ((symbol? arg) (string-append "\"" (symbol->string arg) "\""))))
 101
 102 (define-public (func name . args)
 103   (string-append
 104    "(" name
 105    (if (null? args)
 106        ""
 107        (apply string-append
 108               (map (lambda (x) (string-append " " (arg->string x))) args)))
 109    ")\n"))
 110
 111 ;;(define (mm-to-pt x)
 112 ;;  (* (/ 72.27 25.40) x))
 113
 114 ;; do nothing in .scm output
 115 (define-public (comment s) "")
 116
 117 (define-public (numbers->string l)
 118   (apply string-append (map ly:number->string l)))
 119
 120 ; (define (chop-decimal x) (if (< (abs x) 0.001) 0.0 x))
 121
 122 (define (number->octal-string x)
 123   (let* ((n (inexact->exact x))
 124          (n64 (quotient n 64))
 125          (n8 (quotient (- n (* n64 64)) 8)))
 126     (string-append
 127      (number->string n64)
 128      (number->string n8)
 129      (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
 130
 131 (define-public (inexact->string x radix)
 132   (let ((n (inexact->exact x)))
 133     (number->string n radix)))
 134
 135
 136 (define-public (number-pair->string c)
 137   (string-append (number->string (car c)) " "
 138                  (number->string (cdr c)) " "))
 139
 140 (define (font i)
 141   (string-append
 142    "font"
 143    (make-string 1 (integer->char (+ (char->integer #\A) i)))))
 144
 145 (define (scm-scm action-name)
 146   1)
 147
 148
 149 ;; silly, use alist?
 150 (define-public (find-notehead-symbol duration style)
 151   (case style
 152    ((xcircle) "2xcircle")
 153    ((harmonic) "0neo_mensural")
 154    ((baroque)
 155     ;; Oops, I actually would not call this "baroque", but, for
 156     ;; backwards compatibility to 1.4, this is supposed to take
 157     ;; brevis, longa and maxima from the neo-mensural font and all
 158     ;; other note heads from the default font.  -- jr
 159     (if (< duration 0)
 160         (string-append (number->string duration) "neo_mensural")
 161         (number->string duration)))
 162    ((mensural)
 163     (string-append (number->string duration) (symbol->string style)))
 164    ((neo_mensural)
 165     (string-append (number->string duration) (symbol->string style)))
 166    ((default)
 167     ;; The default font in mf/feta-bolletjes.mf defines a brevis, but
 168     ;; neither a longa nor a maxima.  Hence let us, for the moment,
 169     ;; take these from the neo-mensural font.  TODO: mf/feta-bolletjes
 170     ;; should define at least a longa for the default font.  The longa
 171     ;; should look exactly like the brevis of the default font, but
 172     ;; with a stem exactly like that of the quarter note. -- jr
 173     (if (< duration -1)
 174         (string-append (number->string duration) "neo_mensural")
 175         (number->string duration)))
 176    (else
 177     (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
 178         (symbol->string style)
 179         (string-append (number->string (max 0 duration))
 180                        (symbol->string style))))))
 181
 182
 183 (define (note-head-style->attachment-coordinates style duration)
 184   "Return pair (X . Y), containing multipliers for the note head
 185 bounding box, where to attach the stem. e.g.: X==0 means horizontally
 186 centered, X==1 is at the right, X == -1 is at the left."
 187
 188
 189   (case style
 190     ((default)
 191      (if (< duration -1)
 192          '(0.0 . 0.6) ;; neo-mensural
 193          '(1.0 . 0.5) ;; default
 194          ))
 195     ((cross) '(1.0 . 0.75))
 196     ((mensural) '(0.0 . 0.6))
 197     ((neo_mensural) '(0.0 . 0.6))
 198     ((diamond) '(1.0 . 0.8))
 199     ((transparent) '(1.0 . 1.0))
 200     ((slash) '(1.0 . 1.0))
 201     ((harmonic) '(1.0 0.0))
 202
 203     ;;
 204     ;;UGH this needs to be changed: triangle is not point-symmetric, has different attachments
 205     ;;  for up/down stem
 206     ((triangle) '(0.75 . 0.15))
 207     ((baroque)
 208      (if (< duration 0)
 209          '(0.0 . 0.6) ;; neo-mensural
 210          '(1.0 . 0.5) ;; default
 211          ))
 212     (else
 213
 214      ;; this also works for easy notation.
 215      '(1.0 . 0.0)
 216      )))
 217
 218 (define-public (string-encode-integer i)
 219   (cond
 220    ((= i  0) "o")
 221    ((< i 0)   (string-append "n" (string-encode-integer (- i))))
 222    (else (string-append
 223           (make-string 1 (integer->char (+ 65 (modulo i 26))))
 224           (string-encode-integer (quotient i 26))))))
 225
 226
 227 (define-public ((every-nth-bar-number-visible n) barnum) (= 0 (modulo barnum n)))
 228
 229 (define-public ((modulo-bar-number-visible n m) barnum) (and (> barnum 1) (= m (modulo barnum n))))
 230
 231 (define-public ((set-bar-number-visibility n) tr)
 232   (let* ((bn (ly:get-context-property tr 'currentBarNumber)))
 233    (ly:set-context-property tr 'barNumberVisibility (modulo-bar-number-visible n (modulo bn n))))
 234 )
 235
 236 (define-public (default-bar-number-visibility barnum) (> barnum 1))
 237
 238 ;; See documentation of Item::visibility_lambda_
 239 (define-public (begin-of-line-visible d) (if (= d 1) '(#f . #f) '(#t . #t)))
 240 (define-public (end-of-line-visible d) (if (= d -1) '(#f . #f) '(#t . #t)))
 241 (define-public (spanbar-begin-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 242
 243 (define-public (all-visible d) '(#f . #f))
 244 (define-public (all-invisible d) '(#t . #t))
 245 (define-public (begin-of-line-invisible d) (if (= d 1) '(#t . #t) '(#f . #f)))
 246 (define-public (end-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 247
 248
 249 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 250 ;; Bar lines.
 251
 252 ;
 253 ; How should a  bar line behave at a break?
 254 ;
 255 ;; Why prepend `default-' to every scm identifier?
 256 (define-public (default-break-barline glyph dir)
 257    (let ((result (assoc glyph
 258                         '((":|:" . (":|" . "|:"))
 259                           ("||:" . ("||" . "|:"))
 260                           ("|" . ("|" . ()))
 261                           ("||:" . ("||" . "|:"))
 262                           ("|s" . (() . "|"))
 263                           ("|:" . ("|" . "|:"))
 264                           ("|." . ("|." . ()))
 265
 266                           ;; hmm... should we end with a barline here?
 267                           (".|" . ("|" . ".|"))
 268                           (":|" . (":|" . ()))
 269                           ("||" . ("||" . ()))
 270                           (".|." . (".|." . ()))
 271                           ("" . ("" . ""))
 272                           ("empty" . (() . ()))
 273                           ("brace" . (() . "brace"))
 274                           ("bracket" . (() . "bracket"))
 275                           )
 276                         )))
 277
 278      (if (equal? result #f)
 279          (ly:warn (string-append "Unknown bar glyph: `" glyph "'"))
 280          (index-cell (cdr result) dir))
 281      )
 282    )
 283