scm/font.scm

   1 ;;;; font.scm -- construct font trees
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7 ;; As an excercise, do it with records.
   8 ;; Should use GOOPS, really.
   9
  10 ;; TODO:
  11 ;;
  12 ;; lookup-font should be written in  C.
  13 ;;
  14 ;; should dump tree to .texi as internal documentation
  15 ;;
  16 ;; * should extract design sizes from fonts: fonts should
  17 ;; be read off the disk, on demand, something like:
  18 ;;
  19 ;; cmr -> ((font-load "cmr6") (font-load "cmr8")  .. )
  20 ;;
  21
  22 (define-class <Font-tree-element>
  23   ())
  24
  25
  26 (define-class <Font-tree-leaf> (<Font-tree-element>)
  27   (default-size #:init-keyword #:default-size)
  28   (size-vector  #:init-keyword #:size-vector))
  29
  30 (define-class <Font-tree-node> (<Font-tree-element>)
  31   (qualifier #:init-keyword #:qualifier  #:accessor font-qualifier)
  32   (default #:init-keyword #:default #:accessor font-default)
  33   (children #:init-keyword #:children #:accessor font-children))
  34
  35 (define (make-font-tree-leaf size size-font-vector)
  36   (make <Font-tree-leaf> #:default-size size #:size-vector size-font-vector))
  37
  38 (define (make-font-tree-node
  39          qualifier default)
  40   (make <Font-tree-node>
  41     #:qualifier qualifier
  42     #:default default
  43     #:children (make-hash-table 11)))
  44
  45 (define-method (display (leaf <Font-tree-leaf>) port)
  46   (map (lambda (x) (display x port))
  47        (list
  48         "Font-size-family: \n"
  49         (slot-ref leaf 'default-size)
  50         (slot-ref leaf 'size-vector) )))
  51
  52 (define-method (display (node <Font-tree-node>) port)
  53
  54   (map
  55    (lambda (x)
  56      (display x port))
  57
  58    (list
  59     "Font_node { \nqual: "
  60     (font-qualifier node)
  61     "(def: "
  62     (font-default node)
  63     ") {\n"))
  64   (for-each
  65    (lambda (x)
  66      (display "\n")
  67      (display (car x) port)
  68      (display "=" port)
  69      (display (cdr x) port))
  70    (hash-table->alist (font-children node)))
  71   (display "} } \n"))
  72
  73
  74 (define default-qualifier-order
  75   '(font-encoding font-family font-shape font-series))
  76
  77 (define-method (add-font (node <Font-tree-node>) fprops size-family)
  78   (define (assoc-delete key alist)
  79     (assoc-remove! (list-copy alist) key))
  80   (define (make-node fprops size-family)
  81     (if (null? fprops)
  82         (make-font-tree-leaf (car size-family) (cdr size-family))
  83         (let*
  84             ((qual (next-qualifier default-qualifier-order fprops)))
  85           (make-font-tree-node qual
  86                                (assoc-get qual fprops)))))
  87
  88   (define (next-qualifier order props)
  89     (cond
  90      ((and (null? props) (null? order))
  91       #f)
  92      ((null? props) (car order))
  93      ((null? order) (caar props))
  94      (else
  95       (if (assoc-get (car order) props)
  96           (car order)
  97           (next-qualifier (cdr order) props)))))
  98
  99
 100   (let*
 101       ((q (font-qualifier node))
 102        (d (font-default node))
 103        (v (assoc-get q fprops d))
 104        (new-fprops (assoc-delete q fprops))
 105        (child (hashq-ref (slot-ref node 'children)
 106                          v #f)))
 107
 108
 109     (if (not child)
 110         (begin
 111           (set! child (make-node new-fprops size-family))
 112           (hashq-set! (slot-ref node 'children) v child)))
 113     (if (pair? new-fprops)
 114         (add-font child new-fprops size-family))))
 115
 116
 117 (define-method (add-font (node <Font-tree-leaf>) fprops size-family)
 118   (throw "must add to node, not leaf"))
 119
 120
 121 (define-method (g-lookup-font (node <Font-tree-node>) alist-chain)
 122   (let*
 123       ((qual (font-qualifier node))
 124        (def (font-default node))
 125        (val (chain-assoc-get qual alist-chain def))
 126        (desired-child (hashq-ref (font-children node) val)))
 127
 128     (if desired-child
 129         (g-lookup-font desired-child alist-chain)
 130         (g-lookup-font (hashq-ref (font-children node) def) alist-chain))))
 131
 132
 133 (define-method (g-lookup-font (node <Font-tree-leaf>) alist-chain)
 134   node)
 135
 136 ;; two step call  is handy for debugging.
 137 (define (lookup-font node alist-chain)
 138   (g-lookup-font node alist-chain))
 139
 140                                         ;
 141                                         ; Each size family is a vector of fonts, loaded with a delay.
 142                                         ; The vector should be sorted according to ascending design size.
 143                                         ;
 144
 145 (define-public (add-music-fonts node factor)
 146   (for-each
 147    (lambda (x)
 148      (add-font node
 149                (list (cons 'font-encoding (car x)))
 150                (cons (* factor (cadr x))
 151                      (caddr x))))
 152    `(
 153      (fetaNumber 14
 154                  #(
 155                   ,(delay  (ly:font-load "bigcheese11"))
 156                   ,(delay  (ly:font-load "bigcheese13"))
 157                   ,(delay  (ly:font-load "bigcheese14"))
 158                   ,(delay  (ly:font-load "bigcheese16"))
 159                   ,(delay  (ly:font-load "bigcheese18"))
 160                   ,(delay  (ly:font-load "bigcheese20"))
 161                   ,(delay  (ly:font-load "bigcheese23"))
 162                   ,(delay  (ly:font-load "bigcheese26"))))
 163
 164      (fetaDynamic 20.0  #(
 165                   ,(delay  (ly:font-load "bigcheese11"))
 166                   ,(delay  (ly:font-load "bigcheese13"))
 167                   ,(delay  (ly:font-load "bigcheese14"))
 168                   ,(delay  (ly:font-load "bigcheese16"))
 169                   ,(delay  (ly:font-load "bigcheese18"))
 170                   ,(delay  (ly:font-load "bigcheese20"))
 171                   ,(delay  (ly:font-load "bigcheese23"))
 172                   ,(delay  (ly:font-load "bigcheese26"))))
 173
 174      (fetaMusic 20.0
 175                 #(
 176                   ,(delay  (ly:font-load "bigcheese11"))
 177                   ,(delay  (ly:font-load "bigcheese13"))
 178                   ,(delay  (ly:font-load "bigcheese14"))
 179                   ,(delay  (ly:font-load "bigcheese16"))
 180                   ,(delay  (ly:font-load "bigcheese18"))
 181                   ,(delay  (ly:font-load "bigcheese20"))
 182                   ,(delay  (ly:font-load "bigcheese23"))
 183                   ,(delay  (ly:font-load "bigcheese26"))))
 184
 185      (fetaBraces 15 #(,(delay
 186                          (ly:make-virtual-font
 187                           (ly:font-load "feta-braces-a")
 188                           (ly:font-load "feta-braces-b")
 189                           (ly:font-load "feta-braces-c")
 190                           (ly:font-load "feta-braces-d")
 191                           (ly:font-load "feta-braces-e")
 192                           (ly:font-load "feta-braces-f")
 193                           (ly:font-load "feta-braces-g")
 194                           (ly:font-load "feta-braces-h")
 195                           (ly:font-load "feta-braces-i"))))))))
 196
 197 (define-public (add-cmr-fonts node factor)
 198   (add-font node '((font-encoding . TeX-math))
 199             `(,(* factor 10) . #(,(delay (ly:font-load "msam10")))))
 200   (for-each
 201    (lambda (x)
 202      (add-font node `((font-encoding . TeX-text)
 203                       (font-series . ,(vector-ref (car x) 2))
 204                       (font-shape . ,(vector-ref (car x) 1))
 205                       (font-family . ,(vector-ref (car x) 0)))
 206                (cons (* factor (cadr x))
 207                      (cddr x))))
 208    `((#(roman upright medium)
 209       . (10.0 . #(,(delay (ly:font-load "cmr6"))
 210                   ,(delay (ly:font-load "cmr8"))
 211                   ,(delay (ly:font-load "cmr10"))
 212                   ,(delay (ly:font-load "cmr17")))))
 213      (#(roman upright bold)
 214       . (10.0 . #(,(delay (ly:font-load "cmbx6"))
 215                   ,(delay (ly:font-load "cmbx8"))
 216                   ,(delay (ly:font-load "cmbx10"))
 217                   ,(delay (ly:font-load "cmbx12")))))
 218      (#(roman italic medium)
 219       . (10.0 . #(,(delay (ly:font-load "cmti7"))
 220                   ,(delay (ly:font-load "cmti10"))
 221                   ,(delay (ly:font-load "cmti12")))))
 222      (#(roman italic bold)
 223       . (10.0 . #(,(delay (ly:font-load "cmbxti8"))
 224                   ,(delay (ly:font-load "cmbxti10"))
 225                   ,(delay (ly:font-load "cmbxti14")))))
 226      (#(roman caps medium)
 227       . (10.0 . #(,(delay (ly:font-load "cmcsc10")))))
 228      (#(roman upright bold-narrow )
 229       . (10.0 . #(,(delay (ly:font-load "cmb10")))))
 230      (#(sans upright medium)
 231       . (10.0  . #(,(delay (ly:font-load "cmss8"))
 232                    ,(delay (ly:font-load "cmss10"))
 233                    ,(delay (ly:font-load "cmss12"))
 234                    ,(delay (ly:font-load "cmss17")))))
 235      (#(typewriter upright medium)
 236       . (10.0 . #(,(delay (ly:font-load "cmtt8"))
 237                   ,(delay (ly:font-load "cmtt10"))
 238                   ,(delay (ly:font-load "cmtt12"))))))))
 239
 240 ;; Debian lmodern font support.
 241 (define-public (add-cork-lm-fonts node factor)
 242   (for-each
 243    (lambda (x)
 244      (add-font node `((font-encoding . cork-lm)
 245                       (font-series . ,(vector-ref (car x) 2))
 246                       (font-shape . ,(vector-ref (car x) 1))
 247                       (font-family . ,(vector-ref (car x) 0)))
 248                (cons (* factor (cadr x)) (cddr x))))
 249    `((#(roman upright medium)
 250       . (10.0 . #(,(delay (ly:font-load "lmr6"))
 251                   ,(delay (ly:font-load "lmr8"))
 252                   ,(delay (ly:font-load "lmr10"))
 253                   ,(delay (ly:font-load "lmr17")))))
 254      (#(roman upright bold)
 255       . (10.0 . #(,(delay (ly:font-load "lmbx6"))
 256                   ,(delay (ly:font-load "lmbx8"))
 257                   ,(delay (ly:font-load "lmbx10"))
 258                   ,(delay (ly:font-load "lmbx12")))))
 259      (#(roman italic medium)
 260       . (10.0 . #(,(delay (ly:font-load "lmri7"))
 261                   ,(delay (ly:font-load "lmri10"))
 262                   ,(delay (ly:font-load "lmri12")))))
 263      (#(roman italic bold)
 264       . (10.0 . #(,(delay (ly:font-load "lmbxi10")))))
 265      (#(roman caps medium)
 266       . (10.0 . #(,(delay (ly:font-load "lmcsc10")))))
 267      (#(roman upright bold-narrow )
 268       . (10.0 . #(,(delay (ly:font-load "lmb10")))))
 269      (#(sans upright medium)
 270       . (10.0  . #(,(delay (ly:font-load "lmss8"))
 271                    ,(delay (ly:font-load "lmss10"))
 272                    ,(delay (ly:font-load "lmss12"))
 273                    ,(delay (ly:font-load "lmss17")))))
 274      (#(sans upright bold)
 275       . (10.0  . #(,(delay (ly:font-load "lmssbx10")))))
 276
 277      (#(typewriter upright medium)
 278       . (10.0 . #(,(delay (ly:font-load "lmtt8"))
 279                   ,(delay (ly:font-load "lmtt10"))
 280                   ,(delay (ly:font-load "lmtt12"))))))))
 281
 282 ;; ec-fonts-mftraced font support.
 283 (define-public (add-ec-fonts node factor)
 284   (for-each
 285    (lambda (x) (add-font node
 286                          `((font-encoding . Extended-TeX-Font-Encoding---Latin)
 287                            (font-series . ,(vector-ref (car x) 2))
 288                            (font-shape . ,(vector-ref (car x) 1))
 289                            (font-family . ,(vector-ref (car x) 0)))
 290                          (cons (* factor (cadr x)) (cddr x))))
 291
 292    `((#(roman upright medium)
 293       . (10.0 . #(,(delay (ly:font-load "ecrm6"))
 294                   ,(delay (ly:font-load "ecrm8"))
 295                   ,(delay (ly:font-load "ecrm10"))
 296                   ,(delay (ly:font-load "ecrm17")))))
 297      (#(roman upright bold)
 298       . (10.0 . #(,(delay (ly:font-load "ecbx6"))
 299                   ,(delay (ly:font-load "ecbx8"))
 300                   ,(delay (ly:font-load "ecbx10"))
 301                   ,(delay (ly:font-load "ecbx12")))))
 302      (#(roman italic medium)
 303       . (10.0 . #(,(delay (ly:font-load "ecti7"))
 304                   ,(delay (ly:font-load "ecti10"))
 305                   ,(delay (ly:font-load "ecti12")))))
 306      (#(roman italic bold)
 307       . (10.0 . #(,(delay (ly:font-load "ecbi8"))
 308                   ,(delay (ly:font-load "ecbi10"))
 309                   ,(delay (ly:font-load "ecbi14")))))
 310      (#(roman caps medium)
 311       . (10.0 . #(,(delay (ly:font-load "eccc10")))))
 312      (#(roman slanted-caps medium)
 313       . (10.0 . #(,(delay (ly:font-load "ecsc10")))))
 314      (#(roman upright bold-narrow )
 315       . (10.0 . #(,(delay (ly:font-load "ecrb10")))))
 316      (#(sans upright medium)
 317       . (10.0  . #(,(delay (ly:font-load "ecss8"))
 318                    ,(delay (ly:font-load "ecss10"))
 319                    ,(delay (ly:font-load "ecss12"))
 320                    ,(delay (ly:font-load "ecss17")))))
 321      (#(typewriter upright medium)
 322       . (10.0 . #(,(delay (ly:font-load "ectt8"))
 323                   ,(delay (ly:font-load "ectt10"))
 324                   ,(delay (ly:font-load "ectt12"))))))))
 325
 326 ;; (display (make-font-tree 1.0))
 327
 328 ;; Century Schoolbook fonts file names on Debian/Sid
 329 (define-public (add-century-schoolbook-fonts node factor)
 330   (add-font node
 331             '((font-family . roman)
 332               (font-shape . upright)
 333               (font-series . medium)
 334               (font-encoding . latin1))
 335             `(10.0 . #(,(delay (ly:font-load "uncr8a")))))
 336   (add-font node
 337             '((font-family . roman)
 338               (font-shape . italic)
 339               (font-series . medium)
 340               (font-encoding . latin1))
 341             `(10.0 . #(,(delay (ly:font-load "uncri8a")))))
 342   (add-font node
 343             '((font-family . roman)
 344               (font-shape . upright)
 345               (font-series . bold)
 346               (font-encoding . latin1))
 347             `(10.0 . #(,(delay (ly:font-load "uncb8a")))))
 348   (add-font node
 349             '((font-family . roman)
 350               (font-shape . italic)
 351               (font-series . bold)
 352               (font-encoding . latin1))
 353             `(10.0 . #(,(delay (ly:font-load "uncbi8a"))))))
 354
 355 (define-public (make-cmr-tree factor)
 356   (let ((n (make-font-tree-node 'font-encoding 'fetaMusic)))
 357     (add-music-fonts n factor)
 358     (add-cmr-fonts n factor)
 359     (if (ly:kpathsea-find-file "lmr10.pfb")
 360         (add-cork-lm-fonts n factor))
 361     (if (ly:kpathsea-find-file "ecrm10.pfa")
 362         (add-ec-fonts n factor))
 363     n))
 364
 365 (define-public (make-century-schoolbook-tree factor)
 366   (let ((n (make-font-tree-node 'font-encoding 'fetaMusic)))
 367     (add-music-fonts n factor)
 368     (add-century-schoolbook-fonts n factor)
 369     n))
 370
 371 (define-public (magstep x)
 372   (exp (* (/ x 6) (log 2))))