scm/font.scm

   1 ;;;
   2 ;;; font.scm -- implement Font stuff
   3 ;;;
   4 ;;; source file of the GNU LilyPond music typesetter
   5 ;;;
   6 ;;; (c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
   7 ;;;
   8
   9 (define style-to-font-alist
  10   `(
  11 ))
  12
  13 (define (font-field name font-descr)
  14       (list-ref
  15        font-descr
  16        (cond
  17         ((eq? name 'font-relative-size)  0)
  18         ((eq? name 'font-series) 1)
  19         ((eq? name 'font-shape) 2)
  20         ((eq? name 'font-family) 3)
  21         ((eq? name 'font-design-size) 4)
  22         (else (ly-warning "unknown font field name"))
  23         )
  24        ))
  25
  26
  27
  28 ;; most of these routines have been reimplemented in C++
  29
  30 ;; TODO TODO . (should not use filtering?)
  31 ;; this is bad, since we generate garbage every font-lookup.
  32 ;; otoh, if the qualifiers is narrow enough , we don't generate much garbage.
  33
  34 (define (filter-field field-name value font-descr-alist)
  35   "return those descriptions from FONT-DESCR-LIST whose FIELD-NAME matches VALUE"
  36       (filter-list
  37        (lambda (x) (let* (field-value (font-field field-name (car x)))
  38                      (or (eq? field-value '*) (eq? value field-value))))
  39        font-descr-alist)
  40       )
  41
  42 (define paper-style-sheet-alist
  43   `(
  44     ((* * * braces *) . ("feta-braces0"
  45                          "feta-braces1"
  46                          "feta-braces2"
  47                          "feta-braces3"
  48                          "feta-braces4"
  49                          "feta-braces5"
  50                          "feta-braces6"
  51                          "feta-braces7"
  52                          "feta-braces8") )))
  53
  54 ;; FIXME: what about this comment?:
  55
  56 ;; font-lookup seems a  little inefficient -- walking this entire list
  57 ;; for a single font.
  58 ;;
  59 ;;   should really have name/pt size at the front of the list.
  60 ;;   (also tried to vary the order of this list, with little effect)
  61 ;;
  62 ;; (font-relative-size font-series font-shape font-family
  63 ;; font-design-size)
  64
  65 (define paper20-style-sheet-alist
  66   '(
  67     ;; why are font file names strings, not symbols?
  68     ((3 medium upright number 13) . "feta-nummer13")
  69     ((2 medium upright number 13) . "feta-nummer13")
  70     ((1 medium upright number 11) . "feta-nummer11")
  71     ((0 medium upright number 10) . "feta-nummer10")
  72     ((-1 medium upright number 8) . "feta-nummer8")
  73     ((-2 medium upright number 7) . "feta-nummer7")
  74     ((-3 medium upright number 6) . "feta-nummer6")
  75     ((-4 medium upright number 5) . "feta-nummer5")
  76     ((-5 medium upright number 4) . "feta-nummer4")
  77
  78     ((4 medium upright roman 17) . "cmr17")
  79     ((3 medium upright roman 17) . "cmr17")
  80     ((2 medium upright roman 12) . "cmr12")
  81     ((1 medium upright roman 12) . "cmr12")
  82     ((0 medium upright roman 10) . "cmr10")
  83     ((-1 medium upright roman 8) . "cmr8" )
  84     ((-2 medium upright roman 7) . "cmr7" )
  85     ((-3 medium upright roman 6) . "cmr6" )
  86     ((-4 medium upright roman 5) . "cmr5" )
  87     ((-5 medium upright roman 5) . "cmr5" )
  88
  89     ((3 medium italic roman 12) . "cmti12")
  90     ((2 medium italic roman 12) . "cmti12")
  91     ((1 medium italic roman 12) . "cmti12") ;;; ugh. Should add magnification here!
  92     ((0 medium italic roman 10) . "cmti12")
  93     ((-1 medium italic roman 8) . "cmti10")
  94     ((-2 medium italic roman 7) . "cmti8")
  95     ((-3 medium italic roman 7) . "cmti7")
  96
  97     ;;; cmbx17 is sauter, not commonly available as Type1.
  98     ((4 bold upright roman 17) . "cmr17")
  99     ((3 bold upright roman 17) . "cmr17")
 100
 101     ((2 bold upright roman 14) . "cmbx14")
 102     ((1 bold upright roman 12) . "cmbx12")
 103     ((0 bold upright roman 10) . "cmbx10")
 104     ((-1 bold upright roman 8) . "cmbx8")
 105     ((-2 bold upright roman 7) . "cmbx7")
 106
 107     ((2 bold italic roman 12) . "cmbxti12")
 108     ((1 bold italic roman 12) . "cmbxti12")
 109     ((0 bold italic roman 10) . "cmbxti10")
 110
 111     ((-1 bold italic roman 8) . "cmbxti8")
 112     ((-2 bold italic roman 7) . "cmbxti7")
 113
 114     ((4 medium upright typewriter 17) . "cmtt17")
 115     ((3 medium upright typewriter 17) . "cmtt17")
 116     ((2 medium upright typewriter 12) . "cmtt12")
 117     ((1 medium upright typewriter 12) . "cmtt12")
 118     ((0 medium upright typewriter 10) . "cmtt10")
 119     ((-1 medium upright typewriter 8) . "cmtt8" )
 120     ((-2 medium upright typewriter 7) . "cmtt7" )
 121     ((-3 medium upright typewriter 6) . "cmtt6" )
 122     ((-4 medium upright typewriter 5) . "cmtt5" )
 123     ((-5 medium upright typewriter 5) . "cmtt5" )
 124
 125     ((3 medium caps roman 12) . "cmcsc12")
 126     ((2 medium caps roman 12) . "cmcsc12")
 127     ((1 medium caps roman 12) . "cmcsc12")
 128     ((0 medium caps roman 10) . "cmcsc10")
 129     ((-1 medium caps roman 8) . "cmcsc8")
 130     ((-2 medium caps roman 7) . "cmcsc7")
 131     ((-3 medium caps roman 7) . "cmcsc7")
 132
 133     ((3 * * dynamic 19) . "feta-din19")
 134     ((2 * * dynamic 19) . "feta-din19")
 135     ((1 * * dynamic 17) . "feta-din17")
 136     ((0 * * dynamic 14) . "feta-din14")
 137     ((-1 * * dynamic 12) . "feta-din12")
 138     ((-2 * * dynamic 9) . "feta-din9")
 139     ((-3 * * dynamic 8) . "feta-din8")
 140     ((-4 * * dynamic 7) . "feta-din7")
 141     ((-5 * * dynamic 6) . "feta-din6")
 142
 143     ((2 * * music 26) . ("feta26" "parmesan26"))
 144     ((1 * * music 23) . ("feta23" "parmesan23"))
 145     ((0 * * music 20) . ("feta20" "parmesan20"))
 146     ((-1 * * music 16) . ("feta16" "parmesan16"))
 147     ((-2 * * music 13) . ("feta13" "parmesan13"))
 148     ((-3 * * music 11) . ("feta11" "parmesan11"))
 149     ((-4 * * music 11) . ("feta11" "parmesan11"))
 150
 151     ((2 * * ancient 26) . ("feta26" "parmesan26"))
 152     ((1 * * ancient 23) . ("feta23" "parmesan23"))
 153     ((0 * * ancient 20) . ("feta20" "parmesan20"))
 154     ((-1 * * ancient 16) . ("feta16" "parmesan16"))
 155     ((-2 * * ancient 13) . ("feta13" "parmesan13"))
 156     ((-3 * * ancient 11) . ("feta11" "parmesan11"))
 157     ((-4 * * ancient 11) . ("feta11" "parmesan11"))
 158
 159     ((0 * * math 10) . "msam10")
 160     ((-1 * * math 10) . "msam10")
 161     ((-2 * * math 10) . "msam10")
 162     ((-3 * * math 10) . "msam10")
 163    ))
 164
 165 ;;
 166 (define (change-relative-size font-desc decrement)
 167   "return a FONT-DESCR with relative size decremented by DECREMENT"
 168
 169   (if (number? (car font-desc))
 170       (cons (- (car font-desc) decrement) (cdr font-desc))
 171       font-desc)
 172   )
 173
 174 (define (change-rhs-size font-desc from to )
 175   (cons (car font-desc)
 176         (regexp-substitute/global #f from (cdr font-desc) 'pre to 'post))
 177
 178   )
 179
 180 ;;
 181 (define (map-alist-keys func list)
 182   "map a  function FUNC over the keys of an alist LIST, leaving the vals. "
 183   (if (null?  list)
 184       '()
 185       (cons (cons (func (caar list)) (cdar list))
 186             (map-alist-keys func (cdr list)))
 187       ))
 188
 189
 190 ;;
 191 (define (map-alist-vals func list)
 192   "map a function FUNC over the vals of  LIST, leaving the keys."
 193   (if (null?  list)
 194       '()
 195       (cons (cons  (caar list) (func (cdar list)))
 196             (map-alist-vals func (cdr list)))
 197       ))
 198
 199 (define (change-style-sheet-relative-size sheet x)
 200   (map-alist-keys (lambda (descr) (change-relative-size descr  x)) sheet))
 201
 202
 203 ;; make style sheet for each paper version.
 204 (define font-list-alist
 205   (map-alist-vals (lambda (x) (change-style-sheet-relative-size
 206                                paper20-style-sheet-alist x))
 207                   '((paper11 . -3)
 208                     (paper13 . -2)
 209                     (paper16 . -1)
 210                     (paper20 . 0)
 211                     (paper23 . 1)
 212                     (paper26 . 2)
 213                     ))
 214   )
 215
 216 ;;
 217 ;; make a kludged up paper-19 style sheet. Broken by virtual fonts.
 218 ;;
 219 (if #f
 220     (set! font-list-alist
 221       (cons
 222        (cons
 223         'paper19
 224         (map (lambda (x) (change-rhs-size x "20" "19"))
 225              paper20-style-sheet-alist))
 226        font-list-alist)))
 227
 228 (define-public (make-style-sheet sym)
 229   `((fonts . ,(append paper-style-sheet-alist
 230                       (cdr (assoc sym font-list-alist))))
 231     (font-defaults
 232      . ((font-family . music)
 233         (font-relative-size . 0)
 234         (font-shape . upright)
 235         (font-series . medium)
 236         ))
 237     (style-alist
 238      . ((finger . ((font-family . number) (font-relative-size . -3)))
 239         (volta . ((font-family . number) (font-relative-size . -2)))
 240         (tuplet . ((font-family . roman) (font-shape . italic) (font-relative-size . -1)))
 241
 242         (timesig . ((font-family . number) ))
 243         (timesig-symbol . ((font-family . music) ))
 244
 245         (mmrest . ((font-family . number) ))
 246         (mmrest-symbol . ((font-family . music) ))
 247
 248         (mark-number . ((font-family . number) (font-relative-size . 1)))
 249         (mark-letter . ((font-family . roman)
 250                         (font-series . bold)
 251                         (font-shape . upright)
 252                         (font-relative-size . 2)))
 253
 254         (script . ((font-family . roman) (font-relative-size . -1)))
 255         (large . ((font-family . roman) (font-relative-size . 1)))
 256         (Large . ((font-series . bold) (font-family . roman)
 257                   (font-relative-size . 2)))
 258         (dynamic . ((font-family . dynamic) (font-relative-size . 0)))
 259         ))
 260     (properties-to-font .
 261                         ,Font_interface::properties_to_font_name)
 262
 263     (markup-to-properties . ,markup-to-properties)
 264     (abbreviation-alist
 265      . ((columns . ((axis . 0)))
 266         (lines . ((axis . 1)))
 267         (roman . ((font-family . roman)))
 268         (music . ((font-family . music) (lookup . name)))
 269         (finger . ((font-style . finger)))
 270         (bold . ((font-series . bold)))
 271         (upright . ((font-shape . upright)))
 272         (italic . ((font-shape . italic)))
 273         (named . ((lookup . name)))
 274         (overstrike . ((extent . (0 . 0))))
 275         (super . ((raise . 1) (font-relative-size . -1) (extent . (0 . 0))))
 276         (sub . ((raise . -1) (font-relative-size . -1) (extent . (0 . 0))))
 277         (text . ((lookup . value)))
 278         )
 279      )
 280
 281     )
 282   )
 283
 284 (define (qualifiers-to-fontnames  qualifiers font-descr-alist)
 285   " reduce the font list by successively applying a font-qualifier."
 286   (if (null? qualifiers)
 287       font-descr-alist
 288
 289       (qualifiers-to-fontnames
 290        (cdr qualifiers)
 291        (filter-field (caar qualifiers) (cdar qualifiers) font-descr-alist)
 292       )
 293   ))
 294
 295 (define (wild-eq? x y)
 296   (or (eq? x y)
 297       (eq? x '*)
 298       (eq? y '*)))
 299
 300 (define (font-qualifies? qualifiers font-desc)
 301   "does FONT-DESC satisfy QUALIFIERS?"
 302   (if (null? qualifiers) #t
 303       (if (wild-eq? (font-field (caar qualifiers) font-desc) (cdar qualifiers))
 304           (font-qualifies? (cdr qualifiers) font-desc)
 305           #f)))
 306
 307 (define (find-first-font qualifiers fonts)
 308   (if (null? fonts)
 309       ""
 310       (if (font-qualifies? qualifiers (caar fonts))
 311           (cdar fonts)
 312           (find-first-font qualifiers (cdr fonts))
 313         )
 314       ))
 315
 316
 317 (define (select-unique-font qualifiers fonts)
 318   "return a single font from FONTS (or a default, if none found)
 319 and warn if the selected font is not unique.
 320 "
 321   (let*  (
 322           (err (current-error-port))
 323           )
 324
 325
 326   (if (not (= (length fonts) 1))
 327       (begin
 328         (display "\ncouldn't find unique font satisfying " err)
 329         (write qualifiers err)
 330         (display " found " err)
 331         (if (null? fonts)
 332             (display "none" err)
 333             (write (map cdr  fonts) err))
 334         ))
 335
 336   (if (null? fonts)
 337       "cmr10"
 338       (cdar fonts))     ; return the topmost.
 339
 340   ))
 341
 342
 343 (define (chain-assoc x alist-list)
 344   (if (null? alist-list)
 345       #f
 346       (let* ((handle (assoc x (car alist-list))))
 347         (if (pair? handle)
 348             handle
 349             (chain-assoc x (cdr alist-list))))))
 350
 351 ;; TODO
 352 ;; the C++ version  in font-interface.cc is usually used.
 353 ;;
 354 ;; FIXME: this has silently been broken by the introduction
 355 ;;        of wildcards in the font list.
 356 (define (properties-to-font-name fonts properties-alist-list)
 357   (let*  (
 358           ;; change order to change priorities of qualifiers.
 359           (q-order '(font-family font-series font-shape
 360                                font-design-size font-relative-size))
 361           (rawqualifiers (map (lambda (x)
 362                                 (chain-assoc x properties-alist-list))
 363                               q-order))
 364           (qualifiers (filter-list pair? rawqualifiers))
 365           (selected (find-first-font qualifiers fonts))
 366           (err (current-error-port)))
 367
 368     (if (equal? selected "")
 369         (begin
 370           (display "\ncouldn't find any font satisfying " err)
 371           (write qualifiers err)
 372           "cmr10"
 373           )
 374         selected)       ; return the topmost.
 375     ))
 376
 377 (define (markup-to-properties sheet markup)
 378   ;; (display "markup: `")
 379   ;; (write markup)
 380   ;; (display "'\n")
 381
 382   (if (pair? markup)
 383       ;; This is hairy.  We want to allow:
 384       ;;    ((foo bar) "text")
 385       ;;    ((foo (bar . 1)) "text")
 386       ;;    ((foo . (0 . 1)))
 387
 388       (if (and (symbol? (car markup))
 389                (or (not (pair? (cdr markup)))
 390                    (number? (cadr markup))))
 391           (if (equal? '() (cdr markup))
 392               (markup-to-properties sheet (car markup))
 393               (list markup))
 394
 395           (if (equal? '() (cdr markup))
 396               (markup-to-properties sheet (car markup))
 397               (append (markup-to-properties sheet (car markup))
 398                       (markup-to-properties sheet (cdr markup)))))
 399
 400       ;; markup is single abbreviation
 401       (let ((entry (assoc markup
 402                           ;; assoc-chain?
 403                           (append (cdr (assoc 'abbreviation-alist sheet))
 404                                   (cdr (assoc 'style-alist sheet))))))
 405         (if entry
 406             (cdr entry)
 407             (list (cons markup #t))))))
 408
 409
 410 ; fixme, how's this supposed to work?
 411 ; and why don't we import font-setting from elt?
 412 (define (style-to-font-name sheet style)
 413   (let* ((entry (assoc style style-to-font-alist))
 414          (qualifiers (if entry (cdr entry) '()))
 415          (font (find-first-font qualifiers sheet))
 416          (err (current-error-port))
 417          )
 418
 419     (if (equal? font "")
 420         (begin
 421           (display "\ncouldn't find any font satisfying " err)
 422           (write qualifiers err)
 423           "cmr10"
 424           )
 425         font)   ; return the topmost.
 426     ))
 427
 428 (if #f (begin
 429          (define (test-module)
 430            (display (filter-list pair? '(1 2 (1 2) (1 .2)))
 431                     (display (filter-field 'font-name 'cmbx paper20-style-sheet-alist))
 432
 433                     (display (qualifiers-to-fontname '((font-name . cmbx)) paper20-style-sheet-alist))
 434                     (display (style-to-font-name 'paper20 'large))
 435                     )
 436            )
 437          )
 438
 439
 440 )