]> code.delx.au - gnu-emacs/blob - lisp/international/fontset.el
(create-fontset-from-fontset-spec): Typo in doc-string fixed.
[gnu-emacs] / lisp / international / fontset.el
1 ;;; fontset.el --- Commands for handling fontset.
2
3 ;; Copyright (C) 1995, 1997 Electrotechnical Laboratory, JAPAN.
4 ;; Licensed to the Free Software Foundation.
5
6 ;; Keywords: mule, multilingual, fontset
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Code:
26
27 ;; Set standard REGISTRY property of charset to find an appropriate
28 ;; font for each charset. This is used to generate a font name in a
29 ;; fontset. If the value contains a character `-', the string before
30 ;; that is embeded in `CHARSET_REGISTRY' field, and the string after
31 ;; that is embeded in `CHARSET_ENCODING' field. If the value does not
32 ;; contain `-', the whole string is embeded in `CHARSET_REGISTRY'
33 ;; field, and a wild card character `*' is embeded in
34 ;; `CHARSET_ENCODING' field.
35
36 (defvar x-charset-registries
37 '((ascii . "ISO8859-1")
38 (latin-iso8859-1 . "ISO8859-1")
39 (latin-iso8859-2 . "ISO8859-2")
40 (latin-iso8859-3 . "ISO8859-3")
41 (latin-iso8859-4 . "ISO8859-4")
42 (thai-tis620 . "TIS620")
43 (greek-iso8859-7 . "ISO8859-7")
44 (arabic-iso8859-6 . "ISO8859-6")
45 (hebrew-iso8859-8 . "ISO8859-8")
46 (katakana-jisx0201 . "JISX0201")
47 (latin-jisx0201 . "JISX0201")
48 (cyrillic-iso8859-5 . "ISO8859-5")
49 (latin-iso8859-9 . "ISO8859-9")
50 (japanese-jisx0208-1978 . "JISX0208.1978")
51 (chinese-gb2312 . "GB2312")
52 (japanese-jisx0208 . "JISX0208.1983")
53 (korean-ksc5601 . "KSC5601")
54 (japanese-jisx0212 . "JISX0212")
55 (chinese-cns11643-1 . "CNS11643.1992-1")
56 (chinese-cns11643-2 . "CNS11643.1992-2")
57 (chinese-cns11643-3 . "CNS11643.1992-3")
58 (chinese-cns11643-4 . "CNS11643.1992-4")
59 (chinese-cns11643-5 . "CNS11643.1992-5")
60 (chinese-cns11643-6 . "CNS11643.1992-6")
61 (chinese-cns11643-7 . "CNS11643.1992-7")
62 (chinese-big5-1 . "Big5")
63 (chinese-big5-2 . "Big5")
64 (chinese-sisheng . "sisheng_cwnn")
65 (vietnamese-viscii-lower . "VISCII1.1")
66 (vietnamese-viscii-upper . "VISCII1.1")
67 (arabic-digit . "MuleArabic-0")
68 (arabic-1-column . "MuleArabic-1")
69 (arabic-2-column . "MuleArabic-2")
70 (ipa . "MuleIPA")
71 (ethiopic . "Ethiopic-Unicode")
72 (ascii-right-to-left . "ISO8859-1")
73 (indian-is13194 . "IS13194-Devanagari")
74 (indian-2-column . "MuleIndian-2")
75 (indian-1-column . "MuleIndian-1")
76 (lao . "MuleLao-1")
77 (tibetan . "MuleTibetan-0")
78 (tibetan-1-column . "MuleTibetan-1")
79 ))
80
81 (let ((l x-charset-registries))
82 (while l
83 (condition-case nil
84 (put-charset-property (car (car l)) 'x-charset-registry (cdr (car l)))
85 (error nil))
86 (setq l (cdr l))))
87
88 ;; Set arguments in `font-encoding-alist' (which see).
89 (defun set-font-encoding (pattern charset encoding)
90 (let ((slot (assoc pattern font-encoding-alist)))
91 (if slot
92 (let ((place (assq charset (cdr slot))))
93 (if place
94 (setcdr place encoding)
95 (setcdr slot (cons (cons charset encoding) (cdr slot)))))
96 (setq font-encoding-alist
97 (cons (list pattern (cons charset encoding)) font-encoding-alist)))
98 ))
99
100 (set-font-encoding "ISO8859-1" 'ascii 0)
101 (set-font-encoding "JISX0201" 'latin-jisx0201 0)
102
103 ;; Setting for suppressing XLoadQueryFont on big fonts.
104 (setq x-pixel-size-width-font-regexp
105 "gb2312\\|jisx0208\\|ksc5601\\|cns11643\\|big5")
106
107 ;;; XLFD (X Logical Font Description) format handler.
108
109 ;; Define XLFD's field index numbers. ; field name
110 (defconst xlfd-regexp-foundry-subnum 0) ; FOUNDRY
111 (defconst xlfd-regexp-family-subnum 1) ; FAMILY_NAME
112 (defconst xlfd-regexp-weight-subnum 2) ; WEIGHT_NAME
113 (defconst xlfd-regexp-slant-subnum 3) ; SLANT
114 (defconst xlfd-regexp-swidth-subnum 4) ; SETWIDTH_NAME
115 (defconst xlfd-regexp-adstyle-subnum 5) ; ADD_STYLE_NAME
116 (defconst xlfd-regexp-pixelsize-subnum 6) ; PIXEL_SIZE
117 (defconst xlfd-regexp-pointsize-subnum 7) ; POINT_SIZE
118 (defconst xlfd-regexp-resx-subnum 8) ; RESOLUTION_X
119 (defconst xlfd-regexp-resy-subnum 9) ; RESOLUTION_Y
120 (defconst xlfd-regexp-spacing-subnum 10) ; SPACING
121 (defconst xlfd-regexp-avgwidth-subnum 11) ; AVERAGE_WIDTH
122 (defconst xlfd-regexp-registry-subnum 12) ; CHARSET_REGISTRY
123 (defconst xlfd-regexp-encoding-subnum 13) ; CHARSET_ENCODING
124
125 ;; Regular expression matching against a fontname which conforms to
126 ;; XLFD (X Logical Font Description). All fields in XLFD should be
127 ;; not be omitted (but can be a wild card) to be matched.
128 (defconst xlfd-tight-regexp
129 "^\
130 -\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)\
131 -\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)\
132 -\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)-\\([^-]*\\)$")
133
134 ;; List of field numbers of XLFD whose values are numeric.
135 (defconst xlfd-regexp-numeric-subnums
136 (list xlfd-regexp-pixelsize-subnum ;6
137 xlfd-regexp-pointsize-subnum ;7
138 xlfd-regexp-resx-subnum ;8
139 xlfd-regexp-resy-subnum ;9
140 xlfd-regexp-avgwidth-subnum ;11
141 ))
142
143 (defun x-decompose-font-name (pattern)
144 "Decompose PATTERN into XLFD's fields and return vector of the fields.
145 The length of the vector is 14.
146
147 If PATTERN doesn't conform to XLFD, try to get a full XLFD name from
148 X server and use the information of the full name to decompose
149 PATTERN. If no full XLFD name is gotten, return nil."
150 (let (xlfd-fields fontname)
151 (if (string-match xlfd-tight-regexp pattern)
152 (let ((i 0))
153 (setq xlfd-fields (make-vector 14 nil))
154 (while (< i 14)
155 (aset xlfd-fields i (match-string (1+ i) pattern))
156 (setq i (1+ i)))
157 xlfd-fields)
158 (setq fontname (condition-case nil
159 (x-resolve-font-name pattern)
160 (error)))
161 (if (and fontname
162 (string-match xlfd-tight-regexp fontname))
163 (let ((len (length pattern))
164 (i 0)
165 l)
166 (setq xlfd-fields (make-vector 14 nil))
167 (while (< i 14)
168 (aset xlfd-fields i
169 (cons (match-beginning (1+ i))
170 (match-string (1+ i) fontname)))
171 (setq i (1+ i)))
172 (setq i 0)
173 (while (< i len)
174 (let ((ch (aref pattern i)))
175 (if (= ch ??)
176 (setq pattern (concat (substring pattern 0 i)
177 "\\(.\\)"
178 (substring pattern (1+ i)))
179 len (+ len 4)
180 i (+ i 4))
181 (if (= ch ?*)
182 (setq pattern (concat (substring pattern 0 i)
183 "\\(.*\\)"
184 (substring pattern (1+ i)))
185 len (+ len 5)
186 i (+ i 5))
187 (setq i (1+ i))))))
188 (string-match pattern fontname)
189 (setq l (cdr (cdr (match-data))))
190 (setq i 0)
191 (while (< i 14)
192 (if (or (null l) (< (car (aref xlfd-fields i)) (car l)))
193 (progn
194 (aset xlfd-fields i (cdr (aref xlfd-fields i)))
195 (setq i (1+ i)))
196 (if (< (car (aref xlfd-fields i)) (car (cdr l)))
197 (progn
198 (aset xlfd-fields i "*")
199 (setq i (1+ i)))
200 (setq l (cdr (cdr l))))))
201 xlfd-fields)))))
202
203 ;; Replace consecutive wild-cards (`*') in NAME to one.
204 ;; Ex. (x-reduce-font-name "-*-*-*-iso8859-1") => "-*-iso8859-1"
205 (defsubst x-reduce-font-name (name)
206 (while (string-match "-\\*-\\(\\*-\\)+" name)
207 (setq name (replace-match "-*-" t t name)))
208 name)
209
210 (defun x-compose-font-name (xlfd-fields &optional reduce)
211 "Compose X's fontname from FIELDS.
212 FIELDS is a vector of XLFD fields.
213 If a field is nil, wild-card letter `*' is embedded.
214 Optional argument REDUCE non-nil means consecutive wild-cards are
215 reduced to be one."
216 (let ((name
217 (concat "-" (mapconcat (lambda (x) (or x "*")) xlfd-fields "-"))))
218 (if reduce
219 (x-reduce-font-name name)
220 name)))
221
222 (defun x-complement-fontset-spec (xlfd-fields fontlist)
223 "Complement FONTLIST for all charsets based on XLFD-FIELDS and return it.
224 XLFD-FIELDS is a vector of XLFD (X Logical Font Description) fields.
225 FONTLIST is an alist of cons of charset and fontname.
226
227 Fontnames for charsets not listed in FONTLIST are generated from
228 XLFD-FIELDS and a property of x-charset-registry of each charset
229 automatically."
230 (let ((charsets charset-list)
231 (style-ignored (copy-sequence xlfd-fields))
232 (size-ignored (copy-sequence xlfd-fields)))
233 (aset style-ignored xlfd-regexp-weight-subnum nil)
234 (aset style-ignored xlfd-regexp-slant-subnum nil)
235 (aset style-ignored xlfd-regexp-swidth-subnum nil)
236 (aset style-ignored xlfd-regexp-adstyle-subnum nil)
237 (aset size-ignored xlfd-regexp-pixelsize-subnum nil)
238 (aset size-ignored xlfd-regexp-pointsize-subnum nil)
239 (aset size-ignored xlfd-regexp-resx-subnum nil)
240 (aset size-ignored xlfd-regexp-resy-subnum nil)
241 (aset size-ignored xlfd-regexp-spacing-subnum nil)
242 (aset size-ignored xlfd-regexp-avgwidth-subnum nil)
243 (while charsets
244 (let ((charset (car charsets)))
245 (if (null (assq charset fontlist))
246 (let ((registry (get-charset-property charset
247 'x-charset-registry))
248 registry-val encoding-val fontname loose-fontname)
249 (if (string-match "-" registry)
250 ;; REGISTRY contains `CHARSET_ENCODING' field.
251 (setq registry-val (substring registry 0 (match-beginning 0))
252 encoding-val (substring registry (match-end 0)))
253 (setq registry-val (concat registry "*")
254 encoding-val "*"))
255 (aset xlfd-fields xlfd-regexp-registry-subnum registry-val)
256 (aset xlfd-fields xlfd-regexp-encoding-subnum encoding-val)
257 (aset style-ignored xlfd-regexp-registry-subnum registry-val)
258 (aset style-ignored xlfd-regexp-encoding-subnum encoding-val)
259 (aset size-ignored xlfd-regexp-registry-subnum registry-val)
260 (aset size-ignored xlfd-regexp-encoding-subnum encoding-val)
261 (setq fontname (x-compose-font-name xlfd-fields t))
262 (setq fontlist (cons (cons charset fontname) fontlist))
263 (or (assoc fontname alternative-fontname-alist)
264 (setq alternative-fontname-alist
265 (cons (list
266 fontname
267 (x-compose-font-name style-ignored t)
268 (x-compose-font-name size-ignored t)
269 (concat "*-" registry-val "-" encoding-val))
270 alternative-fontname-alist)))
271 )))
272 (setq charsets (cdr charsets))))
273
274 ;; Here's a trick for the charset latin-iso8859-1. If font for
275 ;; ascii also contains Latin-1 characters, use it also for
276 ;; latin-iso8859-1. This prevent loading a font for latin-iso8859-1
277 ;; by a different name.
278 (if (string-match (cdr (assq 'latin-iso8859-1 x-charset-registries))
279 (cdr (assq 'ascii fontlist)))
280 (setcdr (assq 'latin-iso8859-1 fontlist) (cdr (assq 'ascii fontlist))))
281 fontlist)
282
283 ;; Return a list to be appended to `x-fixed-font-alist' when
284 ;; `mouse-set-font' is called.
285 (defun generate-fontset-menu ()
286 (let ((fontsets global-fontset-alist)
287 fontset-name
288 l)
289 (while fontsets
290 (setq fontset-name (car (car fontsets)) fontsets (cdr fontsets))
291 (setq l (cons (list (fontset-plain-name fontset-name) fontset-name) l)))
292 (cons "Fontset" l)))
293
294 (defun fontset-plain-name (fontset)
295 "Return a plain and descriptive name of FONTSET."
296 (if (not (setq fontset (query-fontset fontset)))
297 (error "Invalid fontset: %s" fontset))
298 (let ((xlfd-fields (x-decompose-font-name fontset)))
299 (if xlfd-fields
300 (let ((weight (aref xlfd-fields xlfd-regexp-weight-subnum))
301 (slant (aref xlfd-fields xlfd-regexp-slant-subnum))
302 (swidth (aref xlfd-fields xlfd-regexp-swidth-subnum))
303 (size (aref xlfd-fields xlfd-regexp-pixelsize-subnum))
304 (charset (aref xlfd-fields xlfd-regexp-registry-subnum))
305 (nickname (aref xlfd-fields xlfd-regexp-encoding-subnum))
306 name)
307 (if (not (string= "fontset" charset))
308 fontset
309 (if (> (string-to-int size) 0)
310 (setq name (format "%s: %s-dot" nickname size))
311 (setq name nickname))
312 (cond ((string-match "^medium$" weight)
313 (setq name (concat name " " "medium")))
314 ((string-match "^bold$\\|^demibold$" weight)
315 (setq name (concat name " " weight))))
316 (cond ((string-match "^i$" slant)
317 (setq name (concat name " " "italic")))
318 ((string-match "^o$" slant)
319 (setq name (concat name " " "slant")))
320 ((string-match "^ri$" slant)
321 (setq name (concat name " " "reverse italic")))
322 ((string-match "^ro$" slant)
323 (setq name (concat name " " "reverse slant"))))
324 name))
325 fontset)))
326
327 (defun create-fontset-from-fontset-spec (fontset-spec &optional style noerror)
328 "Create a fontset from fontset specification string FONTSET-SPEC.
329 FONTSET-SPEC is a string of the format:
330 FONTSET-NAME,CHARSET-NAME0:FONT-NAME0,CHARSET-NAME1:FONT-NAME1, ...
331 Any number of SPACE, TAB, and NEWLINE can be put before and after commas.
332 If optional argument STYLE is specified, create a fontset of STYLE
333 by modifying FONTSET-SPEC appropriately. STYLE can be one of `bold',
334 `italic', and `bold-italic'.
335 If this function attempts to create already existing fontset, error is
336 signaled unless the optional 3rd argument NOERROR is non-nil."
337 (if (not (string-match "^[^,]+" fontset-spec))
338 (error "Invalid fontset spec: %s" fontset-spec))
339 (let ((idx (match-end 0))
340 (name (match-string 0 fontset-spec))
341 fontlist charset)
342 ;; At first, extract pairs of charset and fontname from FONTSET-SPEC.
343 (while (string-match "[, \t\n]*\\([^:]+\\):\\([^,]+\\)" fontset-spec idx)
344 (setq idx (match-end 0))
345 (setq charset (intern (match-string 1 fontset-spec)))
346 (if (charsetp charset)
347 (setq fontlist (cons (cons charset (match-string 2 fontset-spec))
348 fontlist))))
349
350 ;; If STYLE is specified, modify fontset name (NAME) and FONTLIST.
351 (let ((func (cdr (assq style '((bold . x-make-font-bold)
352 (italic . x-make-font-italic)
353 (bold-italic . x-make-font-bold-italic)))))
354 (l fontlist)
355 new-name)
356 (if (and func
357 (setq new-name (funcall func name)))
358 (progn
359 (setq name new-name)
360 (while l
361 (if (setq new-name (funcall func (cdr (car l))))
362 (setcdr (car l) new-name))
363 (setq l (cdr l))))))
364
365 ;; If NAME conforms to XLFD, complement FONTLIST for charsets not
366 ;; specified in FONTSET-SPEC.
367 (let ((xlfd-fields (x-decompose-font-name name)))
368 (if xlfd-fields
369 (setq fontlist
370 (x-complement-fontset-spec xlfd-fields fontlist))))
371
372 (if (and noerror (query-fontset name))
373 ;; Don't try to create an already existing fontset.
374 nil
375 ;; Create the fontset, and define the alias if appropriate.
376 (new-fontset name fontlist)
377 (if (and (not style)
378 (not (assoc name fontset-alias-alist))
379 (string-match "fontset-.*$" name))
380 (let ((alias (match-string 0 name)))
381 (or (rassoc alias fontset-alias-alist)
382 (setq fontset-alias-alist
383 (cons (cons name alias) fontset-alias-alist))))))))
384
385 \f
386 ;; Create standard fontset from 16 dots fonts which are the most widely
387 ;; installed fonts. Fonts for Chinese-GB, Korean, and Chinese-CNS are
388 ;; specified here because FAMILY of those fonts are not "fixed" in
389 ;; many cases.
390 (defvar standard-fontset-spec
391 "-*-fixed-medium-r-normal-*-16-*-*-*-*-*-fontset-standard,
392 chinese-gb2312:-*-medium-r-normal-*-16-*-gb2312*-*,
393 korean-ksc5601:-*-medium-r-normal-*-16-*-ksc5601*-*,
394 chinese-cns11643-1:-*-medium-r-normal-*-16-*-cns11643*-1,
395 chinese-cns11643-2:-*-medium-r-normal-*-16-*-cns11643*-2,
396 chinese-cns11643-3:-*-medium-r-normal-*-16-*-cns11643*-3,
397 chinese-cns11643-4:-*-medium-r-normal-*-16-*-cns11643*-4,
398 chinese-cns11643-5:-*-medium-r-normal-*-16-*-cns11643*-5,
399 chinese-cns11643-6:-*-medium-r-normal-*-16-*-cns11643*-6,
400 chinese-cns11643-7:-*-medium-r-normal-*-16-*-cns11643*-7"
401 "String of fontset spec of the standard fontset.
402 You have the biggest chance to display international characters
403 with correct glyphs by using the standard fontset.
404 See the documentation of `create-fontset-from-fontset-spec' for the format.")
405
406 ;; Create fontsets from X resources of the name `fontset-N (class
407 ;; Fontset-N)' where N is integer 0, 1, ...
408 ;; The values of the resources the string of the same format as
409 ;; `standard-fontset-spec'.
410
411 (defun create-fontset-from-x-resource ()
412 (let ((idx 0)
413 fontset-spec)
414 (while (setq fontset-spec (x-get-resource (concat "fontset-" idx)
415 (concat "Fontset-" idx)))
416 (create-fontset-from-fontset-spec fontset-spec nil 'noerror)
417 (setq idx (1+ idx)))))
418
419 (defsubst fontset-list ()
420 "Returns a list of all defined fontset names."
421 (mapcar 'car global-fontset-alist))
422
423 ;;
424 (provide 'fontset)
425
426 ;;; fontset.el ends here