1 ;;; cus-face.el -- Support for Custom faces.
3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Maintainer: Hrvoje Niksic <hniksic@xemacs.org>
7 ;; Keywords: help, faces
9 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
15 ;; This file should probably be dissolved, and code moved to faces.el,
22 ;; To elude the warnings for font functions.
29 (defun custom-declare-face (face spec doc &rest args)
30 "Like `defface', but FACE is evaluated as a normal argument."
31 ;; (when (fboundp 'pureload)
32 ;; (error "Attempt to declare a face during dump"))
33 ;; #### should we possibly reset force-face here?
34 (unless (get face 'face-defface-spec)
35 (put face 'face-defface-spec spec)
36 (unless (find-face face)
37 ;; If the user has already created the face, respect that.
38 (let ((value (or (get face 'saved-face) spec))
39 (frames (relevant-custom-frames))
41 ;; Create global face.
42 (make-empty-face face)
43 (face-display-set face value nil '(custom))
44 ;; Create frame local faces
46 (setq frame (car frames)
48 (face-display-set face value frame '(custom)))
49 (init-face-from-resources face)))
50 (when (and doc (null (face-doc-string face)))
51 (set-face-doc-string face doc))
52 (custom-handle-all-keywords face args 'custom-face)
53 (run-hooks 'custom-define-hook))
58 ;; Consider adding the stuff in the XML font model here.
59 (defconst custom-face-attributes
60 '((:foreground (color :tag "Foreground"
62 :help-echo "Set foreground color.")
63 set-face-foreground face-foreground-name)
64 (:background (color :tag "Background"
66 :help-echo "Set background color.")
67 set-face-background face-background-name)
68 (:size (editable-field :format "Size: %v"
70 Text size (e.g. 9pt or 2mm).")
71 custom-set-face-font-size custom-face-font-size)
72 (:family (editable-field :format "Font Family: %v"
74 Name of font family to use (e.g. times).")
75 custom-set-face-font-family custom-face-font-family)
76 (:background-pixmap (editable-field :format "Background pixmap: %v"
78 Name of background pixmap file.")
79 set-face-background-pixmap custom-face-background-pixmap)
80 (:dim (toggle :format "%[Dim%]: %v\n"
81 :help-echo "Control whether the text should be dimmed.")
82 set-face-dim-p face-dim-p)
83 (:bold (toggle :format "%[Bold%]: %v\n"
84 :help-echo "Control whether a bold font should be used.")
85 custom-set-face-bold custom-face-bold)
86 (:italic (toggle :format "%[Italic%]: %v\n"
88 Control whether an italic font should be used.")
89 custom-set-face-italic custom-face-italic)
90 (:underline (toggle :format "%[Underline%]: %v\n"
92 Control whether the text should be underlined.")
93 set-face-underline-p face-underline-p)
94 (:strikethru (toggle :format "%[Strikethru%]: %v\n"
96 Control whether the text should be strikethru.")
97 set-face-strikethru-p face-strikethru-p)
98 (:inverse-video (toggle :format "%[Inverse Video%]: %v\n"
100 Control whether the text should be inverted. Works only on TTY-s")
101 set-face-reverse-p face-reverse-p))
102 "Alist of face attributes.
104 The elements are lists of the form (KEY TYPE SET GET) where:
105 KEY is a symbol identifying the attribute.
106 TYPE is a widget type for editing the attribute.
107 SET is a function for setting the attribute value.
108 GET is a function for getting the attribute value.
110 The SET function should take three arguments: the face to modify, the
111 value of the attribute, and optionally the frame where the face should
114 The GET function should take two arguments, the face to examine, and
115 optionally the frame where the face should be examined.")
117 (defun face-custom-attributes-set (face frame tags &rest atts)
118 "For FACE on FRAME set the attributes [KEYWORD VALUE]....
119 Each keyword should be listed in `custom-face-attributes'.
121 If FRAME is nil, set the default face."
123 (let* ((name (nth 0 atts))
125 (fun (nth 2 (assq name custom-face-attributes))))
126 (setq atts (cdr (cdr atts)))
128 (funcall fun face value frame tags)
131 (defun face-custom-attributes-get (face frame)
132 "For FACE on FRAME get the attributes [KEYWORD VALUE]....
133 Each keyword should be listed in `custom-face-attributes'.
135 If FRAME is nil, use the default face."
137 ;; Attempt to get `font.el' from w3.
140 (let ((atts custom-face-attributes)
147 ;; This may fail if w3 doesn't exist.
149 (let ((answer (funcall get face frame)))
150 (unless (equal answer (funcall get 'default frame))
151 (when (widget-apply (nth 1 att) :match answer)
152 (setq result (cons (nth 0 att) (cons answer result)))))))
156 (defsubst custom-face-get-spec (symbol)
157 (or (get symbol 'customized-face)
158 (get symbol 'saved-face)
159 (get symbol 'face-defface-spec)
160 ;; Attempt to construct it.
161 (list (list t (face-custom-attributes-get
162 symbol (selected-frame))))))
164 (defun custom-set-face-bold (face value &optional frame tags)
165 "Set the bold property of FACE to VALUE."
167 (make-face-bold face frame tags)
168 (make-face-unbold face frame tags)))
170 ;; Really, we should get rid of these font.el dependencies... They
171 ;; are still presenting a problem with dumping the faces (font.el is
172 ;; too bloated for us to dump). I am thinking about hacking up
173 ;; font-like functionality myself for the sake of this file. It will
174 ;; probably be to-the-point and more efficient.
176 (defun custom-face-bold (face &rest args)
177 "Return non-nil if the font of FACE is bold."
178 (let* ((font (apply 'face-font-name face args))
180 (fontobj (font-create-object font)))
181 (font-bold-p fontobj)))
183 (defun custom-set-face-italic (face value &optional frame tags)
184 "Set the italic property of FACE to VALUE."
186 (make-face-italic face frame tags)
187 (make-face-unitalic face frame tags)))
189 (defun custom-face-italic (face &rest args)
190 "Return non-nil if the font of FACE is italic."
191 (let* ((font (apply 'face-font-name face args))
193 (fontobj (font-create-object font)))
194 (font-italic-p fontobj)))
196 (defun custom-face-background-pixmap (face &rest args)
197 "Return the name of the background pixmap file used for FACE."
198 (let ((image (apply 'specifier-instance
199 (face-background-pixmap face) args)))
201 (image-instance-file-name image))))
203 ;; This consistently fails to dtrt
204 ;;(defun custom-set-face-font-size (face size &optional locale tags)
205 ;; "Set the font of FACE to SIZE."
206 ;; ;; #### should this call have tags in it?
207 ;; (let* ((font (apply 'face-font-name face (list locale)))
209 ;; (fontobj (font-create-object font)))
210 ;; (set-font-size fontobj size)
211 ;; (apply 'font-set-face-font face fontobj locale tags)))
213 ;; From Jan Vroonhof -- see faces.el
214 (defun custom-set-face-font-size (face size &optional locale tags)
215 "Set the font of FACE to SIZE."
216 (make-face-size face size locale tags))
218 (defun custom-face-font-size (face &rest args)
219 "Return the size of the font of FACE as a string."
220 (let* ((font (apply 'face-font-name face args))
222 (fontobj (font-create-object font)))
223 (format "%s" (font-size fontobj))))
225 ;; Jan suggests this may not dtrt
226 ;;(defun custom-set-face-font-family (face family &optional locale tags)
227 ;; "Set the font of FACE to FAMILY."
228 ;; ;; #### should this call have tags in it?
229 ;; (let* ((font (apply 'face-font-name face (list locale)))
231 ;; (fontobj (font-create-object font)))
232 ;; (set-font-family fontobj family)
233 ;; (apply 'font-set-face-font face fontobj locale tags)))
235 ;; From Jan Vroonhof -- see faces.el
236 (defun custom-set-face-font-family (face family &optional locale tags)
237 "Set the font of FACE to FAMILY."
238 (make-face-family face family locale tags))
240 (defun custom-face-font-family (face &rest args)
241 "Return the name of the font family of FACE."
242 (let* ((font (apply 'face-font-name face args))
244 (fontobj (font-create-object font)))
245 (font-family fontobj)))
248 (defun custom-set-face-update-spec (face display plist)
249 "Customize the FACE for display types matching DISPLAY, merging
250 in the new items from PLIST."
251 (let ((spec (face-spec-update-all-matching (custom-face-get-spec face)
253 (put face 'customized-face spec)
254 (face-spec-set face spec nil '(custom))))
259 (defun custom-set-faces (&rest args)
260 "Initialize faces according to user preferences.
261 This asociates the setting with the USER theme.
262 The arguments should be a list where each entry has the form:
264 (FACE SPEC [NOW [COMMENT]])
266 SPEC will be stored as the saved value for FACE. If NOW is present
267 and non-nil, FACE will also be created according to SPEC.
268 COMMENT is a string comment about FACE.
270 See `defface' for the format of SPEC."
271 (apply #'custom-theme-set-faces 'user args))
274 (defun custom-theme-set-faces (theme &rest args)
275 "Initialize faces according to settings specified by args.
276 Records the settings as belonging to THEME.
278 See `custom-set-faces' for a description of the arguments ARGS."
279 (custom-check-theme theme)
280 (let ((immediate (get theme 'theme-immediate)))
282 (let ((entry (car args)))
284 (let ((face (nth 0 entry))
287 (comment (nth 3 entry)))
288 (put face 'saved-face spec)
289 (custom-push-theme 'theme-face face theme 'set spec)
290 (put face 'saved-face-comment comment)
291 (when (or now immediate)
292 (put face 'force-face (if now 'rogue 'immediate)))
293 (when (or now immediate (find-face face))
294 (put face 'face-comment comment)
295 (unless (find-face face)
296 (make-empty-face face))
297 (face-spec-set face spec nil '(custom)))
298 (setq args (cdr args)))
299 ;; Old format, a plist of FACE SPEC pairs.
300 (let ((face (nth 0 args))
302 (put face 'saved-face spec)
303 (custom-push-theme 'theme-face face theme 'set spec))
304 (setq args (cdr (cdr args))))))))
307 (defun custom-theme-face-value (face theme)
308 "Return spec of FACE in THEME if the THEME modifies the
309 FACE. Nil otherwise."
310 (car-safe (custom-theme-value theme (get face 'theme-face))))
312 (defun custom-theme-reset-internal-face (face to-theme)
313 (let ((spec (custom-theme-face-value face to-theme))
315 (setq was-in-theme spec)
316 (setq spec (or spec (get face 'standard-value)))
318 (put face 'save-face was-in-theme)
319 (when (or (get face 'force-face) (find-face face))
320 (unless (find-face face)
321 (make-empty-face face))
322 (face-spec-set face spec)))
326 (defun custom-theme-reset-faces (theme &rest args)
327 (custom-check-theme theme)
328 "Reset the value of the face to values previously defined.
329 Associate this setting with THEME.
331 ARGS is a list of lists of the form
335 This means reset face to its value in to-theme."
336 (mapc #'(lambda (arg)
337 (apply #'custom-theme-reset-internal-face arg)
338 (custom-push-theme (car arg) 'theme-face theme 'reset (cadr arg)))
342 (defun custom-reset-faces (&rest args)
343 "Reset the value of the face to values previously defined.
344 Associate this setting with the 'user' theme.
346 ARGS is defined as for `custom-theme-reset-faces'."
347 (apply #'custom-theme-reset-faces 'user args))
354 ;; cus-face.el ends here