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