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--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8
   9 ;;; Tablature functions, by Jiba (jiba@tuxfamily.org)
  10
  11 ;; The TabNoteHead stem attachment function.
  12 (define (tablature-stem-attachment-function style duration)
  13   (cons 0.0 0.5))
  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                 ;; remove 1 because list index starts at 0 and guitar string at 1.
  22                 (- string 1)))))
  23
  24 ;; The 5-string banjo has got a extra string, the fifth (duh), wich
  25 ;; starts at the fifth fret on the neck. Frets on the fifth string
  26 ;; are referred to relative to the other frets:
  27 ;;   the "first fret" on the fifth string is really the sixth fret
  28 ;;   on the banjo neck.
  29 ;; We solve this by defining a new fret-number-tablature function:
  30 (define-public (fret-number-tablature-format-banjo string tuning pitch)
  31     (let ((fret (- (ly:pitch-semitones pitch) (list-ref tuning (- string 1)))))
  32         (number->string (cond
  33             ((and (> fret 0) (= string 5))
  34                 (+ fret 5))
  35             (else fret)))))
  36
  37 (define-public (hammer-print-function grob)
  38   (let* ((note-collums (ly:grob-property grob 'note-columns))
  39          (note-column1 (cadr note-collums))
  40          (note-column2 (car  note-collums))
  41          (note1 (car (ly:grob-property note-column1 'note-heads)))
  42          (note2 (car (ly:grob-property note-column2 'note-heads)))
  43          (text1 (ly:grob-property note1 'text))
  44          (text2 (ly:grob-property note2 'text))
  45          (fret1 (if (string? text1) (string->number text1) 0))
  46          (fret2 (if (string? text2) (string->number text2) 0))
  47          (letter (cond
  48                   ((< fret1 fret2) "H")
  49                   ((> fret1 fret2) "P")
  50                   (else ""))))
  51     (let* ((slur
  52             ;; (Slur::print grob)
  53
  54             ;;
  55             ;; FIXME: a hammer is not a slur.
  56             ;;
  57             (ly:make-stencil '() '(0 . 0) '(0 . 0)))
  58            (layout (ly:grob-layout grob))
  59            (text (interpret-markup
  60                   layout
  61                   (ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))
  62                   letter)))
  63
  64       (let ((x (/ (- (cdr (ly:stencil-extent slur 0))
  65                      (/ (cdr (ly:stencil-extent text 0)) 2.0))
  66                   -2.0)))
  67
  68         (set! text
  69               (ly:make-stencil (ly:stencil-expr text)
  70                                (cons x x)
  71                                (ly:stencil-extent text Y)))
  72
  73         (ly:stencil-aligned-to text X RIGHT)))))
  74
  75
  76 (define-public guitar-tuning '(4 -1 -5 -10 -15 -20))
  77 (define-public bass-tuning '(-17 -22 -27 -32))
  78
  79 ;; tunings for 5-string banjo
  80 (define-public banjo-open-g-tuning '(2 -1 -5 -10 7))
  81 (define-public banjo-c-tuning '(2 -1 -5 -12 7))
  82 (define-public banjo-modal-tuning '(2 0 -5 -10 7))
  83 (define-public banjo-open-d-tuning '(2 -3 -6 -10 9))
  84 (define-public banjo-open-dm-tuning '(2 -3 -6 -10 9))
  85 ;; convert 5-string banjo tunings to 4-string tunings by
  86 ;; removing the 5th string
  87 ;;
  88 ;; example:
  89 ;; \set TabStaff.stringTunings = #(four-string-banjo banjo-open-g-tuning)
  90 (define-public (four-string-banjo tuning)
  91   (reverse (cdr (reverse tuning))))
  92
  93 ;;; end of tablature functions
  94
  95 (define-public (make-stencil-boxer thickness padding callback)
  96   "Return function that adds a box around the grob passed as argument."
  97   (lambda (grob) (box-stencil (callback grob) thickness padding)))
  98
  99 (define-public (make-stencil-circler thickness padding callback)
 100   "Return function that adds a circle around the grob passed as argument."
 101   (lambda (grob) (circle-stencil (callback grob) thickness padding)))
 102
 103 (define-public (arg->string arg)
 104   (cond ((number? arg) (ly:inexact->string arg 10))
 105         ((string? arg) (string-append "\"" arg "\""))
 106         ((symbol? arg) (string-append "\"" (symbol->string arg) "\""))))
 107
 108 (define-public (print-circled-text-callback grob)
 109   (let* ((text (ly:grob-property grob 'text))
 110          (layout (ly:grob-layout grob))
 111          (defs (ly:output-def-lookup layout 'text-font-defaults))
 112          (props (ly:grob-alist-chain grob defs))
 113          (circle (Text_interface::interpret_markup
 114                   layout props (make-draw-circle-markup 0.8 0.1)))
 115          (text-stencil (Text_interface::interpret_markup layout props text)))
 116     (ly:stencil-add (centered-stencil text-stencil) circle)))
 117
 118
 119 ;;(define (mm-to-pt x)
 120 ;;  (* (/ 72.27 25.40) x))
 121
 122 ;; do nothing in .scm output
 123
 124 (define-public (ly:numbers->string lst)
 125   (string-join (map ly:number->string lst) " "))
 126
 127 (define (number->octal-string x)
 128   (let* ((n (inexact->exact x))
 129          (n64 (quotient n 64))
 130          (n8 (quotient (- n (* n64 64)) 8)))
 131     (string-append
 132      (number->string n64)
 133      (number->string n8)
 134      (number->string (remainder (- n (+ (* n64 64) (* n8 8))) 8)))))
 135
 136 (define-public (ly:inexact->string x radix)
 137   (let ((n (inexact->exact x)))
 138     (number->string n radix)))
 139
 140 (define-public (ly:number-pair->string c)
 141   (string-append (ly:number->string (car c)) " "
 142                  (ly:number->string (cdr c))))
 143
 144
 145 ;; silly, use alist?
 146 (define-public (find-notehead-symbol duration style)
 147   (case style
 148     ((xcircle) "2xcircle")
 149     ((harmonic) "0harmonic")
 150     ((baroque)
 151      ;; Oops, I actually would not call this "baroque", but, for
 152      ;; backwards compatibility to 1.4, this is supposed to take
 153      ;; brevis, longa and maxima from the neo-mensural font and all
 154      ;; other note heads from the default font.  -- jr
 155      (if (< duration 0)
 156          (string-append (number->string duration) "neomensural")
 157          (number->string duration)))
 158     ((mensural)
 159      (string-append (number->string duration) (symbol->string style)))
 160     ((neomensural)
 161      (string-append (number->string duration) (symbol->string style)))
 162     ((default)
 163      ;; The default font in mf/feta-bolletjes.mf defines a brevis, but
 164      ;; neither a longa nor a maxima.  Hence let us, for the moment,
 165      ;; take these from the neo-mensural font.  TODO: mf/feta-bolletjes
 166      ;; should define at least a longa for the default font.  The longa
 167      ;; should look exactly like the brevis of the default font, but
 168      ;; with a stem exactly like that of the quarter note. -- jr
 169      (if (< duration -1)
 170          (string-append (number->string duration) "neomensural")
 171          (number->string duration)))
 172     (else
 173      (if (string-match "vaticana*|hufnagel*|medicaea*" (symbol->string style))
 174          (symbol->string style)
 175          (string-append (number->string (max 0 duration))
 176                         (symbol->string style))))))
 177
 178 ;; TODO junk completely?
 179 (define (note-head-style->attachment-coordinates grob axis)
 180   "Return pair (X . Y), containing multipliers for the note head
 181 bounding box, where to attach the stem. e.g.: X==0 means horizontally
 182 centered, X==1 is at the right, X == -1 is at the left."
 183
 184   '(1.0 . 0.0))
 185
 186 (define-public (string-encode-integer i)
 187   (cond
 188    ((= i  0) "o")
 189    ((< i 0)   (string-append "n" (string-encode-integer (- i))))
 190    (else (string-append
 191           (make-string 1 (integer->char (+ 65 (modulo i 26))))
 192           (string-encode-integer (quotient i 26))))))
 193
 194 (define-public ((every-nth-bar-number-visible n) barnum) (= 0 (modulo barnum n)))
 195
 196 (define-public ((modulo-bar-number-visible n m) barnum) (and (> barnum 1) (= m (modulo barnum n))))
 197
 198 (define-public ((set-bar-number-visibility n) tr)
 199   (let* ((bn (ly:context-property tr 'currentBarNumber)))
 200     (ly:context-set-property! tr 'barNumberVisibility (modulo-bar-number-visible n (modulo bn n)))))
 201
 202 (define-public (default-bar-number-visibility barnum) (> barnum 1))
 203
 204 ;; See documentation of Item::visibility_lambda_
 205 (define-safe-public (begin-of-line-visible d) (if (= d 1) '(#f . #f) '(#t . #t)))
 206 (define-safe-public (end-of-line-visible d) (if (= d -1) '(#f . #f) '(#t . #t)))
 207 (define-safe-public (spanbar-begin-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 208
 209 (define-safe-public (all-visible d) '(#f . #f))
 210 (define-safe-public (all-invisible d) '(#t . #t))
 211 (define-safe-public (begin-of-line-invisible d) (if (= d 1) '(#t . #t) '(#f . #f)))
 212 (define-safe-public (center-invisible d) (if (= d 0) '(#t . #t) '(#f . #f)))
 213 (define-safe-public (end-of-line-invisible d) (if (= d -1) '(#t . #t) '(#f . #f)))
 214
 215
 216 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 217 ;; Bar lines.
 218
 219 ;;
 220 ;; How should a  bar line behave at a break?
 221 ;;
 222 ;; Why prepend `default-' to every scm identifier?
 223 (define-public (default-break-barline glyph dir)
 224   (let ((result (assoc glyph
 225                        '((":|:" . (":|" . "|:"))
 226                          ("||:" . ("||" . "|:"))
 227                          ("|" . ("|" . ()))
 228                          ("||:" . ("||" . "|:"))
 229                          ("|s" . (() . "|"))
 230                          ("|:" . ("|" . "|:"))
 231                          ("|." . ("|." . ()))
 232
 233                          ;; hmm... should we end with a bar line here?
 234                          (".|" . ("|" . ".|"))
 235                          (":|" . (":|" . ()))
 236                          ("||" . ("||" . ()))
 237                          (".|." . (".|." . ()))
 238                          ("" . ("" . ""))
 239                          (":" . (":" . ""))
 240                          ("empty" . (() . ()))
 241                          ("brace" . (() . "brace"))
 242                          ("bracket" . (() . "bracket"))  ))))
 243
 244     (if (equal? result #f)
 245         (ly:warn "Unknown bar glyph: `~S'" glyph)
 246         (index-cell (cdr result) dir))))
 247
 248 (define-public (shift-right-at-line-begin g)
 249   "Shift an item to the right, but only at the start of the line."
 250   (if (and (ly:item? g)  (equal? (ly:item-break-dir g) RIGHT))
 251       (ly:grob-translate-axis! g 3.5 X)))
 252
 253
 254 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 255 ;; Color
 256
 257 (define-public color? list?)
 258
 259 ; predefined colors
 260 (define-public black       '(0.0 0.0 0.0))
 261 (define-public white       '(1.0 1.0 1.0))
 262 (define-public red         '(1.0 0.0 0.0))
 263 (define-public green       '(0.0 1.0 0.0))
 264 (define-public blue        '(0.0 0.0 1.0))
 265 (define-public cyan        '(1.0 1.0 0.0))
 266 (define-public magenta     '(1.0 0.0 1.0))
 267 (define-public yellow      '(0.0 1.0 1.0))
 268
 269 (define-public grey        '(0.5 0.5 0.5))
 270 (define-public darkred     '(0.5 0.0 0.0))
 271 (define-public darkgreen   '(0.0 0.5 0.0))
 272 (define-public darkblue    '(0.0 0.0 0.5))
 273 (define-public darkcyan    '(0.5 0.5 0.0))
 274 (define-public darkmagenta '(0.5 0.0 0.5))
 275 (define-public darkyellow  '(0.0 0.5 0.5))