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    `((fetaNumber 10
 153                  #(,(delay (ly:font-load "feta-nummer4"))
 154                    ,(delay (ly:font-load "feta-nummer6"))
 155                    ,(delay (ly:font-load "feta-nummer8"))
 156                    ,(delay (ly:font-load "feta-nummer10"))
 157                    ,(delay (ly:font-load "feta-nummer12"))
 158                    ,(delay (ly:font-load "feta-nummer16"))))
 159      (fetaDynamic 14.0  #(,(delay (ly:font-load "feta-din6"))
 160                           ,(delay (ly:font-load "feta-din8"))
 161                           ,(delay (ly:font-load "feta-din10"))
 162                           ,(delay (ly:font-load "feta-din12"))
 163                           ,(delay (ly:font-load "feta-din14"))
 164                           ,(delay (ly:font-load "feta-din17"))))
 165
 166      (fetaMusic 20.0
 167                 #(,(delay (ly:make-virtual-font
 168                            (ly:font-load "feta11")
 169                            (ly:font-load "parmesan11")))
 170                   ,(delay (ly:make-virtual-font
 171                            (ly:font-load "feta13")
 172                            (ly:font-load "parmesan13")))
 173                   ,(delay (ly:make-virtual-font
 174                            (ly:font-load "feta14")
 175                            (ly:font-load "parmesan14")))
 176                   ,(delay (ly:make-virtual-font
 177                            (ly:font-load "feta16")
 178                            (ly:font-load "parmesan16")))
 179                   ,(delay (ly:make-virtual-font
 180                            (ly:font-load "feta18")
 181                            (ly:font-load "parmesan18")))
 182                   ,(delay (ly:make-virtual-font
 183                            (ly:font-load "feta20")
 184                            (ly:font-load "parmesan20")))
 185                   ,(delay (ly:make-virtual-font (ly:font-load "bigcheese20")))
 186                   ,(delay (ly:make-virtual-font
 187                            (ly:font-load "feta23")
 188                            (ly:font-load "parmesan23")))
 189                   ,(delay (ly:make-virtual-font
 190                            (ly:font-load "feta26")
 191                            (ly:font-load "parmesan26")))))
 192
 193
 194      (fetaBraces 15 #(,(delay
 195                          (ly:make-virtual-font
 196                           (ly:font-load "feta-braces-a")
 197                           (ly:font-load "feta-braces-b")
 198                           (ly:font-load "feta-braces-c")
 199                           (ly:font-load "feta-braces-d")
 200                           (ly:font-load "feta-braces-e")
 201                           (ly:font-load "feta-braces-f")
 202                           (ly:font-load "feta-braces-g")
 203                           (ly:font-load "feta-braces-h")
 204                           (ly:font-load "feta-braces-i"))))))))
 205
 206 (define-public (add-cmr-fonts node factor)
 207   (add-font node '((font-encoding . TeX-math))
 208             `(,(* factor 10) . #(,(delay (ly:font-load "msam10")))))
 209   (for-each
 210    (lambda (x)
 211      (add-font node `((font-encoding . TeX-text)
 212                       (font-series . ,(vector-ref (car x) 2))
 213                       (font-shape . ,(vector-ref (car x) 1))
 214                       (font-family . ,(vector-ref (car x) 0)))
 215                (cons (* factor (cadr x))
 216                      (cddr x))))
 217    `((#(roman upright medium)
 218       . (10.0 . #(,(delay (ly:font-load "cmr6"))
 219                   ,(delay (ly:font-load "cmr8"))
 220                   ,(delay (ly:font-load "cmr10"))
 221                   ,(delay (ly:font-load "cmr17")))))
 222      (#(roman upright bold)
 223       . (10.0 . #(,(delay (ly:font-load "cmbx6"))
 224                   ,(delay (ly:font-load "cmbx8"))
 225                   ,(delay (ly:font-load "cmbx10"))
 226                   ,(delay (ly:font-load "cmbx12")))))
 227      (#(roman italic medium)
 228       . (10.0 . #(,(delay (ly:font-load "cmti7"))
 229                   ,(delay (ly:font-load "cmti10"))
 230                   ,(delay (ly:font-load "cmti12")))))
 231      (#(roman italic bold)
 232       . (10.0 . #(,(delay (ly:font-load "cmbxti8"))
 233                   ,(delay (ly:font-load "cmbxti10"))
 234                   ,(delay (ly:font-load "cmbxti14")))))
 235      (#(roman caps medium)
 236       . (10.0 . #(,(delay (ly:font-load "cmcsc10")))))
 237      (#(roman upright bold-narrow )
 238       . (10.0 . #(,(delay (ly:font-load "cmb10")))))
 239      (#(sans upright medium)
 240       . (10.0  . #(,(delay (ly:font-load "cmss8"))
 241                    ,(delay (ly:font-load "cmss10"))
 242                    ,(delay (ly:font-load "cmss12"))
 243                    ,(delay (ly:font-load "cmss17")))))
 244      (#(typewriter upright medium)
 245       . (10.0 . #(,(delay (ly:font-load "cmtt8"))
 246                   ,(delay (ly:font-load "cmtt10"))
 247                   ,(delay (ly:font-load "cmtt12"))))))))
 248
 249 ;; Debian lmodern font support.
 250 (define-public (add-cork-lm-fonts node factor)
 251   (for-each
 252    (lambda (x)
 253      (add-font node `((font-encoding . cork-lm)
 254                       (font-series . ,(vector-ref (car x) 2))
 255                       (font-shape . ,(vector-ref (car x) 1))
 256                       (font-family . ,(vector-ref (car x) 0)))
 257                (cons (* factor (cadr x)) (cddr x))))
 258    `((#(roman upright medium)
 259       . (10.0 . #(,(delay (ly:font-load "lmr6"))
 260                   ,(delay (ly:font-load "lmr8"))
 261                   ,(delay (ly:font-load "lmr10"))
 262                   ,(delay (ly:font-load "lmr17")))))
 263      (#(roman upright bold)
 264       . (10.0 . #(,(delay (ly:font-load "lmbx6"))
 265                   ,(delay (ly:font-load "lmbx8"))
 266                   ,(delay (ly:font-load "lmbx10"))
 267                   ,(delay (ly:font-load "lmbx12")))))
 268      (#(roman italic medium)
 269       . (10.0 . #(,(delay (ly:font-load "lmri7"))
 270                   ,(delay (ly:font-load "lmri10"))
 271                   ,(delay (ly:font-load "lmri12")))))
 272      (#(roman italic bold)
 273       . (10.0 . #(,(delay (ly:font-load "lmbxi10")))))
 274      (#(roman caps medium)
 275       . (10.0 . #(,(delay (ly:font-load "lmcsc10")))))
 276      (#(roman upright bold-narrow )
 277       . (10.0 . #(,(delay (ly:font-load "lmb10")))))
 278      (#(sans upright medium)
 279       . (10.0  . #(,(delay (ly:font-load "lmss8"))
 280                    ,(delay (ly:font-load "lmss10"))
 281                    ,(delay (ly:font-load "lmss12"))
 282                    ,(delay (ly:font-load "lmss17")))))
 283      (#(sans upright bold)
 284       . (10.0  . #(,(delay (ly:font-load "lmssbx10")))))
 285
 286      (#(typewriter upright medium)
 287       . (10.0 . #(,(delay (ly:font-load "lmtt8"))
 288                   ,(delay (ly:font-load "lmtt10"))
 289                   ,(delay (ly:font-load "lmtt12"))))))))
 290
 291 ;; ec-fonts-mftraced font support.
 292 (define-public (add-ec-fonts node factor)
 293   (for-each
 294    (lambda (x) (add-font node
 295                          `((font-encoding . Extended-TeX-Font-Encoding---Latin)
 296                            (font-series . ,(vector-ref (car x) 2))
 297                            (font-shape . ,(vector-ref (car x) 1))
 298                            (font-family . ,(vector-ref (car x) 0)))
 299                          (cons (* factor (cadr x)) (cddr x))))
 300
 301    `((#(roman upright medium)
 302       . (10.0 . #(,(delay (ly:font-load "ecrm6"))
 303                   ,(delay (ly:font-load "ecrm8"))
 304                   ,(delay (ly:font-load "ecrm10"))
 305                   ,(delay (ly:font-load "ecrm17")))))
 306      (#(roman upright bold)
 307       . (10.0 . #(,(delay (ly:font-load "ecbx6"))
 308                   ,(delay (ly:font-load "ecbx8"))
 309                   ,(delay (ly:font-load "ecbx10"))
 310                   ,(delay (ly:font-load "ecbx12")))))
 311      (#(roman italic medium)
 312       . (10.0 . #(,(delay (ly:font-load "ecti7"))
 313                   ,(delay (ly:font-load "ecti10"))
 314                   ,(delay (ly:font-load "ecti12")))))
 315      (#(roman italic bold)
 316       . (10.0 . #(,(delay (ly:font-load "ecbi8"))
 317                   ,(delay (ly:font-load "ecbi10"))
 318                   ,(delay (ly:font-load "ecbi14")))))
 319      (#(roman caps medium)
 320       . (10.0 . #(,(delay (ly:font-load "eccc10")))))
 321      (#(roman slanted-caps medium)
 322       . (10.0 . #(,(delay (ly:font-load "ecsc10")))))
 323      (#(roman upright bold-narrow )
 324       . (10.0 . #(,(delay (ly:font-load "ecrb10")))))
 325      (#(sans upright medium)
 326       . (10.0  . #(,(delay (ly:font-load "ecss8"))
 327                    ,(delay (ly:font-load "ecss10"))
 328                    ,(delay (ly:font-load "ecss12"))
 329                    ,(delay (ly:font-load "ecss17")))))
 330      (#(typewriter upright medium)
 331       . (10.0 . #(,(delay (ly:font-load "ectt8"))
 332                   ,(delay (ly:font-load "ectt10"))
 333                   ,(delay (ly:font-load "ectt12"))))))))
 334
 335 ;; (display (make-font-tree 1.0))
 336
 337 ;; Century Schoolbook fonts file names on Debian/Sid
 338 (define-public (add-century-schoolbook-fonts node factor)
 339   (add-font node
 340             '((font-family . roman)
 341               (font-shape . upright)
 342               (font-series . medium)
 343               (font-encoding . latin1))
 344             `(10.0 . #(,(delay (ly:font-load "uncr8a")))))
 345   (add-font node
 346             '((font-family . roman)
 347               (font-shape . italic)
 348               (font-series . medium)
 349               (font-encoding . latin1))
 350             `(10.0 . #(,(delay (ly:font-load "uncri8a")))))
 351   (add-font node
 352             '((font-family . roman)
 353               (font-shape . upright)
 354               (font-series . bold)
 355               (font-encoding . latin1))
 356             `(10.0 . #(,(delay (ly:font-load "uncb8a")))))
 357   (add-font node
 358             '((font-family . roman)
 359               (font-shape . italic)
 360               (font-series . bold)
 361               (font-encoding . latin1))
 362             `(10.0 . #(,(delay (ly:font-load "uncbi8a"))))))
 363
 364 (define-public (make-cmr-tree factor)
 365   (let ((n (make-font-tree-node 'font-encoding 'fetaMusic)))
 366     (add-music-fonts n factor)
 367     (add-cmr-fonts n factor)
 368     (if (ly:kpathsea-find-file "lmr10.pfb")
 369         (add-cork-lm-fonts n factor))
 370     (if (ly:kpathsea-find-file "ecrm10.pfa")
 371         (add-ec-fonts n factor))
 372     n))
 373
 374 (define-public (make-century-schoolbook-tree factor)
 375   (let ((n (make-font-tree-node 'font-encoding 'fetaMusic)))
 376     (add-music-fonts n factor)
 377     (add-century-schoolbook-fonts n factor)
 378     n))
 379
 380 (define-public (magstep x)
 381   (exp (* (/ x 6) (log 2))))