Mercurial > hg > xemacs-beta
annotate lisp/fontcolor.el @ 5635:2fc3f2f35523
Put back compatibility alias for #'cl-puthash, used by 21.4's setf expansion
2012-01-02 Aidan Kehoe <kehoea@parhasard.net>
* obsolete.el (cl-puthash): Put back a compatibility alias for
this, setf-expansion of #'gethash calls it on 21.4, so it will
occur in packages for a while to come.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Mon, 02 Jan 2012 13:35:31 +0000 |
| parents | 308d34e9f07d |
| children |
| rev | line source |
|---|---|
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
1 ;;; fontcolor.el --- Lisp interface to fonts and colors |
| 428 | 2 |
| 3 ;; Copyright (C) 1994, 1997 Free Software Foundation, Inc. | |
| 4 ;; Copyright (C) 1995 Ben Wing | |
|
5080
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
5 ;; Copyright (C) 2010 Didier Verna |
| 428 | 6 |
| 7 ;; Author: Chuck Thompson <cthomp@xemacs.org> | |
| 8 ;; Author: Ben Wing <ben@xemacs.org> | |
| 9 ;; Maintainer: XEmacs Development Team | |
| 10 ;; Keywords: faces, internal, dumped | |
| 11 | |
| 12 ;; This file is part of XEmacs. | |
| 13 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
14 ;; XEmacs is free software: you can redistribute it and/or modify it |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
15 ;; under the terms of the GNU General Public License as published by the |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
16 ;; Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
17 ;; option) any later version. |
| 428 | 18 |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
19 ;; XEmacs is distributed in the hope that it will be useful, but WITHOUT |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
20 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
21 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
22 ;; for more details. |
| 428 | 23 |
| 24 ;; You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5178
diff
changeset
|
25 ;; along with XEmacs. If not, see <http://www.gnu.org/licenses/>. |
| 428 | 26 |
| 27 ;;; Synched up with: Not in FSF. | |
| 28 | |
| 29 ;;; Commentary: | |
| 30 | |
| 31 ;; This file is dumped with XEmacs. | |
| 32 | |
| 33 ;;; Code: | |
| 34 | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
35 (defun fontcolor-property-1 (function object domain &optional matchspec) |
| 428 | 36 (let ((instance (if matchspec |
| 37 (specifier-matching-instance object matchspec domain) | |
| 38 (specifier-instance object domain)))) | |
| 39 (and instance (funcall function instance)))) | |
| 40 | |
| 41 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; font specifiers | |
| 42 | |
| 43 (defun make-font-specifier (spec-list) | |
| 44 "Return a new `font' specifier object with the given specification list. | |
| 45 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 46 locale and a list of instantiators), a single instantiator, or a list | |
| 47 of instantiators. See `make-specifier' for more information about | |
| 442 | 48 specifiers. |
| 49 | |
| 50 Valid instantiators for font specifiers are: | |
| 51 | |
| 3111 | 52 -- a string naming a font; syntax is platform dependent. Some examples for |
| 53 a 14-point upright medium-weight Courier font: | |
| 54 X11 (and GTK1): \"-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*\" | |
| 55 Xft (and GTK2): \"Courier-14\" | |
| 56 MS-Windows: \"Courier:14:Western\" | |
| 442 | 57 -- a font instance (use that instance directly if the device matches, |
| 58 or use the string that generated it) | |
| 59 -- a vector of no elements (only on TTY's; this means to set no font | |
| 60 at all, thus using the \"natural\" font of the terminal's text) | |
| 61 -- a vector of one element (a face to inherit from) | |
| 62 " | |
| 428 | 63 (make-specifier-and-init 'font spec-list)) |
| 64 | |
| 65 (defun font-name (font &optional domain charset) | |
| 66 "Return the name of the FONT in the specified DOMAIN, if any. | |
| 67 FONT should be a font specifier object and DOMAIN is normally a window | |
| 68 and defaults to the selected window if omitted. This is equivalent | |
| 69 to using `specifier-instance' and applying `font-instance-name' to | |
| 70 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
71 (fontcolor-property-1 'font-instance-name font domain charset)) |
| 428 | 72 |
| 73 (defun font-ascent (font &optional domain charset) | |
| 74 "Return the ascent of the FONT in the specified DOMAIN, if any. | |
| 75 FONT should be a font specifier object and DOMAIN is normally a window | |
| 76 and defaults to the selected window if omitted. This is equivalent | |
| 77 to using `specifier-instance' and applying `font-instance-ascent' to | |
| 78 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
79 (fontcolor-property-1 'font-instance-ascent font domain charset)) |
| 428 | 80 |
| 81 (defun font-descent (font &optional domain charset) | |
| 82 "Return the descent of the FONT in the specified DOMAIN, if any. | |
| 83 FONT should be a font specifier object and DOMAIN is normally a window | |
| 84 and defaults to the selected window if omitted. This is equivalent | |
| 85 to using `specifier-instance' and applying `font-instance-descent' to | |
| 86 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
87 (fontcolor-property-1 'font-instance-descent font domain charset)) |
| 428 | 88 |
| 89 (defun font-width (font &optional domain charset) | |
| 90 "Return the width of the FONT in the specified DOMAIN, if any. | |
| 91 FONT should be a font specifier object and DOMAIN is normally a window | |
| 92 and defaults to the selected window if omitted. This is equivalent | |
| 93 to using `specifier-instance' and applying `font-instance-width' to | |
| 94 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
95 (fontcolor-property-1 'font-instance-width font domain charset)) |
| 428 | 96 |
| 97 (defun font-height (font &optional domain charset) | |
| 98 "Return the height of the FONT in the specified DOMAIN, if any. | |
| 99 FONT should be a font specifier object and DOMAIN is normally a window | |
| 100 and defaults to the selected window if omitted. This is equivalent | |
| 101 to using `specifier-instance' and applying `font-instance-height' to | |
| 102 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
103 (fontcolor-property-1 'font-instance-height font domain charset)) |
| 428 | 104 |
| 105 (defun font-proportional-p (font &optional domain charset) | |
| 106 "Return whether FONT is proportional in the specified DOMAIN, if known. | |
| 107 FONT should be a font specifier object and DOMAIN is normally a window | |
| 108 and defaults to the selected window if omitted. This is equivalent | |
| 109 to using `specifier-instance' and applying `font-instance-proportional-p' to | |
| 110 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
111 (fontcolor-property-1 'font-instance-proportional-p font domain charset)) |
| 428 | 112 |
| 113 (defun font-properties (font &optional domain charset) | |
| 114 "Return the properties of the FONT in the specified DOMAIN, if any. | |
| 115 FONT should be a font specifier object and DOMAIN is normally a window | |
| 116 and defaults to the selected window if omitted. This is equivalent | |
| 117 to using `specifier-instance' and applying `font-instance-properties' | |
| 118 to the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
119 (fontcolor-property-1 'font-instance-properties font domain charset)) |
| 428 | 120 |
| 121 (defun font-truename (font &optional domain charset) | |
| 122 "Return the truename of the FONT in the specified DOMAIN, if any. | |
| 123 FONT should be a font specifier object and DOMAIN is normally a window | |
| 124 and defaults to the selected window if omitted. This is equivalent | |
| 125 to using `specifier-instance' and applying `font-instance-truename' | |
| 126 to the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
127 (fontcolor-property-1 'font-instance-truename font domain charset)) |
| 428 | 128 |
| 129 (defun font-instance-height (font-instance) | |
| 130 "Return the height in pixels of FONT-INSTANCE. | |
| 131 The returned value is the maximum height for all characters in the font,\n\ | |
| 132 and is equivalent to the sum of the font instance's ascent and descent." | |
| 133 (+ (font-instance-ascent font-instance) | |
| 134 (font-instance-descent font-instance))) | |
| 135 | |
| 136 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers | |
| 137 | |
| 138 (defun make-color-specifier (spec-list) | |
| 139 "Return a new `color' specifier object with the given specification list. | |
| 140 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 141 locale and a list of instantiators), a single instantiator, or a list | |
| 142 of instantiators. See `make-specifier' for a detailed description of | |
| 442 | 143 how specifiers work. |
| 144 | |
| 145 Valid instantiators for color specifiers are: | |
| 146 | |
| 147 -- a string naming a color (e.g. under X this might be \"lightseagreen2\" | |
| 148 or \"#F534B2\") | |
| 149 -- a color instance (use that instance directly if the device matches, | |
| 150 or use the string that generated it) | |
| 151 -- a vector of no elements (only on TTY's; this means to set no color | |
| 152 at all, thus using the \"natural\" color of the terminal's text) | |
| 153 -- a vector of one or two elements: a face to inherit from, and | |
| 154 optionally a symbol naming which property of that face to inherit, | |
| 155 either `foreground' or `background' (if omitted, defaults to the same | |
| 156 property that this color specifier is used for; if this specifier is | |
| 157 not part of a face, the instantiator would not be valid)." | |
| 428 | 158 (make-specifier-and-init 'color spec-list)) |
| 159 | |
| 160 (defun color-name (color &optional domain) | |
| 161 "Return the name of the COLOR in the specified DOMAIN, if any. | |
| 162 COLOR should be a color specifier object and DOMAIN is normally a window | |
| 163 and defaults to the selected window if omitted. This is equivalent | |
| 164 to using `specifier-instance' and applying `color-instance-name' to | |
| 165 the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
166 (fontcolor-property-1 'color-instance-name color domain)) |
| 428 | 167 |
| 168 (defun color-rgb-components (color &optional domain) | |
| 169 "Return the RGB components of the COLOR in the specified DOMAIN, if any. | |
| 170 COLOR should be a color specifier object and DOMAIN is normally a window | |
| 171 and defaults to the selected window if omitted. This is equivalent | |
| 172 to using `specifier-instance' and applying `color-instance-rgb-components' | |
| 173 to the result. See `make-specifier' for more information about specifiers." | |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
174 (fontcolor-property-1 'color-instance-rgb-components color domain)) |
| 428 | 175 |
| 442 | 176 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; face-boolean specifiers |
| 177 | |
| 178 (defun make-face-boolean-specifier (spec-list) | |
| 179 "Return a new `face-boolean' specifier object with the given spec list. | |
| 180 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 181 locale and a list of instantiators), a single instantiator, or a list | |
| 182 of instantiators. See `make-specifier' for a detailed description of | |
| 183 how specifiers work. | |
| 184 | |
| 185 Valid instantiators for face-boolean specifiers are | |
| 186 | |
| 187 -- t or nil | |
| 4201 | 188 -- a vector of one, two or three elements: a face to inherit from, |
| 442 | 189 optionally a symbol naming the property of that face to inherit from |
| 190 (if omitted, defaults to the same property that this face-boolean | |
| 191 specifier is used for; if this specifier is not part of a face, | |
| 192 the instantiator would not be valid), and optionally a value which, | |
| 193 if non-nil, means to invert the sense of the inherited property." | |
| 4201 | 194 (make-specifier-and-init 'face-boolean spec-list)) |
| 442 | 195 |
|
5080
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
196 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; face-background-placement specifiers |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
197 |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
198 (defun make-face-background-placement-specifier (spec-list) |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
199 "Return a new `face-background-placement' specifier object. |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
200 SPEC-LIST can be a list of specifications (each of which is a cons of a |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
201 locale and a list of instantiators), a single instantiator, or a list |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
202 of instantiators. See `make-specifier' for a detailed description of |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
203 how specifiers work. |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
204 |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
205 Valid instantiators for face-background-placement specifiers are: |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
206 -- absolute or relative (symbols), |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
207 -- a vector of one element: a face to inherit from." |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
208 (make-specifier-and-init 'face-background-placement spec-list)) |
|
5502045ec510
The background-placement face property.
Didier Verna <didier@lrde.epita.fr>
parents:
4201
diff
changeset
|
209 |
|
5176
8b2f75cecb89
rename objects* (.c, .h and .el files) to fontcolor*
Ben Wing <ben@xemacs.org>
parents:
4201
diff
changeset
|
210 ;;; fontcolor.el ends here. |