Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
73b0cd50 | 3 | @c Copyright (C) 1990-1995, 1998-2011 Free Software Foundation, Inc. |
b8d4c8d0 | 4 | @c See the file elisp.texi for copying conditions. |
6336d8c3 | 5 | @setfilename ../../info/display |
b8d4c8d0 GM |
6 | @node Display, System Interface, Processes, Top |
7 | @chapter Emacs Display | |
8 | ||
9 | This chapter describes a number of features related to the display | |
10 | that Emacs presents to the user. | |
11 | ||
12 | @menu | |
13 | * Refresh Screen:: Clearing the screen and redrawing everything on it. | |
14 | * Forcing Redisplay:: Forcing redisplay. | |
15 | * Truncation:: Folding or wrapping long text lines. | |
16 | * The Echo Area:: Displaying messages at the bottom of the screen. | |
17 | * Warnings:: Displaying warning messages for the user. | |
18 | * Invisible Text:: Hiding part of the buffer text. | |
19 | * Selective Display:: Hiding part of the buffer text (the old way). | |
20 | * Temporary Displays:: Displays that go away automatically. | |
21 | * Overlays:: Use overlays to highlight parts of the buffer. | |
22 | * Width:: How wide a character or string is on the screen. | |
23 | * Line Height:: Controlling the height of lines. | |
24 | * Faces:: A face defines a graphics style for text characters: | |
25 | font, colors, etc. | |
26 | * Fringes:: Controlling window fringes. | |
27 | * Scroll Bars:: Controlling vertical scroll bars. | |
28 | * Display Property:: Enabling special display features. | |
29 | * Images:: Displaying images in Emacs buffers. | |
30 | * Buttons:: Adding clickable buttons to Emacs buffers. | |
31 | * Abstract Display:: Emacs' Widget for Object Collections. | |
32 | * Blinking:: How Emacs shows the matching open parenthesis. | |
33 | * Usual Display:: The usual conventions for displaying nonprinting chars. | |
34 | * Display Tables:: How to specify other conventions. | |
35 | * Beeping:: Audible signal to the user. | |
36 | * Window Systems:: Which window system is being used. | |
37 | @end menu | |
38 | ||
39 | @node Refresh Screen | |
40 | @section Refreshing the Screen | |
41 | ||
42 | The function @code{redraw-frame} clears and redisplays the entire | |
43 | contents of a given frame (@pxref{Frames}). This is useful if the | |
44 | screen is corrupted. | |
45 | ||
46 | @c Emacs 19 feature | |
47 | @defun redraw-frame frame | |
48 | This function clears and redisplays frame @var{frame}. | |
49 | @end defun | |
50 | ||
51 | Even more powerful is @code{redraw-display}: | |
52 | ||
53 | @deffn Command redraw-display | |
54 | This function clears and redisplays all visible frames. | |
55 | @end deffn | |
56 | ||
20c63e44 RS |
57 | In Emacs, processing user input takes priority over redisplay. If |
58 | you call these functions when input is available, they don't redisplay | |
59 | immediately, but the requested redisplay does happen | |
60 | eventually---after all the input has been processed. | |
b8d4c8d0 | 61 | |
c4adeee0 CY |
62 | On text-only terminals, suspending and resuming Emacs normally also |
63 | refreshes the screen. Some terminal emulators record separate | |
64 | contents for display-oriented programs such as Emacs and for ordinary | |
65 | sequential display. If you are using such a terminal, you might want | |
66 | to inhibit the redisplay on resumption. | |
b8d4c8d0 | 67 | |
01f17ae2 | 68 | @defopt no-redraw-on-reenter |
b8d4c8d0 GM |
69 | @cindex suspend (cf. @code{no-redraw-on-reenter}) |
70 | @cindex resume (cf. @code{no-redraw-on-reenter}) | |
71 | This variable controls whether Emacs redraws the entire screen after it | |
72 | has been suspended and resumed. Non-@code{nil} means there is no need | |
73 | to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. | |
01f17ae2 | 74 | @end defopt |
b8d4c8d0 GM |
75 | |
76 | @node Forcing Redisplay | |
77 | @section Forcing Redisplay | |
78 | @cindex forcing redisplay | |
79 | ||
20c63e44 | 80 | Emacs normally tries to redisplay the screen whenever it waits for |
c4adeee0 CY |
81 | input. With the following function, you can request an immediate |
82 | attempt to redisplay, in the middle of Lisp code, without actually | |
83 | waiting for input. | |
20c63e44 RS |
84 | |
85 | @defun redisplay &optional force | |
86 | This function tries immediately to redisplay, provided there are no | |
c4adeee0 | 87 | pending input events. |
20c63e44 RS |
88 | |
89 | If the optional argument @var{force} is non-@code{nil}, it does all | |
90 | pending redisplay work even if input is available, with no | |
91 | pre-emption. | |
92 | ||
93 | The function returns @code{t} if it actually tried to redisplay, and | |
94 | @code{nil} otherwise. A value of @code{t} does not mean that | |
95 | redisplay proceeded to completion; it could have been pre-empted by | |
96 | newly arriving terminal input. | |
97 | @end defun | |
98 | ||
99 | @code{redisplay} with no argument tries immediately to redisplay, | |
100 | but has no effect on the usual rules for what parts of the screen to | |
101 | redisplay. By contrast, the following function adds certain windows | |
102 | to the pending redisplay work (as if their contents had completely | |
103 | changed), but doesn't immediately try to do any redisplay work. | |
104 | ||
105 | @defun force-window-update &optional object | |
106 | This function forces some or all windows to be updated on next | |
107 | redisplay. If @var{object} is a window, it requires eventual | |
108 | redisplay of that window. If @var{object} is a buffer or buffer name, | |
109 | it requires eventual redisplay of all windows displaying that buffer. | |
110 | If @var{object} is @code{nil} (or omitted), it requires eventual | |
111 | redisplay of all windows. | |
112 | @end defun | |
113 | ||
114 | @code{force-window-update} does not do a redisplay immediately. | |
115 | (Emacs will do that when it waits for input.) Rather, its effect is | |
116 | to put more work on the queue to be done by redisplay whenever there | |
117 | is a chance. | |
118 | ||
b8d4c8d0 GM |
119 | Emacs redisplay normally stops if input arrives, and does not happen |
120 | at all if input is available before it starts. Most of the time, this | |
121 | is exactly what you want. However, you can prevent preemption by | |
122 | binding @code{redisplay-dont-pause} to a non-@code{nil} value. | |
123 | ||
20c63e44 RS |
124 | @defvar redisplay-dont-pause |
125 | If this variable is non-@code{nil}, pending input does not | |
126 | prevent or halt redisplay; redisplay occurs, and finishes, | |
127 | regardless of whether input is available. | |
128 | @end defvar | |
129 | ||
b8d4c8d0 GM |
130 | @defvar redisplay-preemption-period |
131 | This variable specifies how many seconds Emacs waits between checks | |
132 | for new input during redisplay. (The default is 0.1 seconds.) If | |
133 | input has arrived when Emacs checks, it pre-empts redisplay and | |
134 | processes the available input before trying again to redisplay. | |
135 | ||
136 | If this variable is @code{nil}, Emacs does not check for input during | |
137 | redisplay, and redisplay cannot be preempted by input. | |
138 | ||
139 | This variable is only obeyed on graphical terminals. For | |
140 | text terminals, see @ref{Terminal Output}. | |
141 | @end defvar | |
142 | ||
b8d4c8d0 GM |
143 | @node Truncation |
144 | @section Truncation | |
145 | @cindex line wrapping | |
146 | @cindex line truncation | |
147 | @cindex continuation lines | |
148 | @cindex @samp{$} in display | |
149 | @cindex @samp{\} in display | |
150 | ||
151 | When a line of text extends beyond the right edge of a window, Emacs | |
152 | can @dfn{continue} the line (make it ``wrap'' to the next screen | |
153 | line), or @dfn{truncate} the line (limit it to one screen line). The | |
154 | additional screen lines used to display a long text line are called | |
155 | @dfn{continuation} lines. Continuation is not the same as filling; | |
156 | continuation happens on the screen only, not in the buffer contents, | |
157 | and it breaks a line precisely at the right margin, not at a word | |
158 | boundary. @xref{Filling}. | |
159 | ||
160 | On a graphical display, tiny arrow images in the window fringes | |
161 | indicate truncated and continued lines (@pxref{Fringes}). On a text | |
162 | terminal, a @samp{$} in the rightmost column of the window indicates | |
163 | truncation; a @samp{\} on the rightmost column indicates a line that | |
164 | ``wraps.'' (The display table can specify alternate characters to use | |
165 | for this; @pxref{Display Tables}). | |
166 | ||
167 | @defopt truncate-lines | |
c4adeee0 CY |
168 | If this buffer-local variable is non-@code{nil}, lines that extend |
169 | beyond the right edge of the window are truncated; otherwise, they are | |
170 | continued. As a special exception, the variable | |
171 | @code{truncate-partial-width-windows} takes precedence in | |
172 | @dfn{partial-width} windows (i.e., windows that do not occupy the | |
173 | entire frame width). | |
b8d4c8d0 GM |
174 | @end defopt |
175 | ||
b8d4c8d0 | 176 | @defopt truncate-partial-width-windows |
c4adeee0 CY |
177 | This variable controls line truncation in @dfn{partial-width} windows. |
178 | A partial-width window is one that does not occupy the entire frame | |
179 | width (@pxref{Splitting Windows}). If the value is @code{nil}, line | |
180 | truncation is determined by the variable @code{truncate-lines} (see | |
181 | above). If the value is an integer @var{n}, lines are truncated if | |
182 | the partial-width window has fewer than @var{n} columns, regardless of | |
183 | the value of @code{truncate-lines}; if the partial-width window has | |
184 | @var{n} or more columns, line truncation is determined by | |
185 | @code{truncate-lines}. For any other non-@code{nil} value, lines are | |
186 | truncated in every partial-width window, regardless of the value of | |
187 | @code{truncate-lines}. | |
b8d4c8d0 GM |
188 | @end defopt |
189 | ||
190 | When horizontal scrolling (@pxref{Horizontal Scrolling}) is in use in | |
191 | a window, that forces truncation. | |
192 | ||
c4f4682b | 193 | @defvar wrap-prefix |
c4adeee0 | 194 | If this buffer-local variable is non-@code{nil}, it defines a |
0c1cfe01 CY |
195 | ``prefix'' that is prepended to every continuation line at |
196 | display-time. (If lines are truncated, the wrap-prefix is never | |
197 | used.) It may be a string, an image, or a stretch-glyph; the value is | |
198 | interpreted in the same way as a @code{display} text property. | |
199 | @xref{Display Property}. | |
c4adeee0 CY |
200 | |
201 | A wrap-prefix may also be specified for regions of text, using the | |
0c1cfe01 CY |
202 | @code{wrap-prefix} text or overlay property. This takes precedence |
203 | over the @code{wrap-prefix} variable. @xref{Special Properties}. | |
c4f4682b MB |
204 | @end defvar |
205 | ||
206 | @defvar line-prefix | |
c4adeee0 | 207 | If this buffer-local variable is non-@code{nil}, it defines a |
0c1cfe01 CY |
208 | ``prefix'' that is prepended to every non-continuation line at |
209 | display-time. It may be a string, an image, or a stretch-glyph; the | |
210 | value is interpreted in the same way as a @code{display} text | |
211 | property. @xref{Display Property}. | |
c4f4682b MB |
212 | |
213 | A line-prefix may also be specified for regions of text using the | |
0c1cfe01 CY |
214 | @code{line-prefix} text or overlay property. This takes precedence |
215 | over the @code{line-prefix} variable. @xref{Special Properties}. | |
c4f4682b MB |
216 | @end defvar |
217 | ||
b8d4c8d0 | 218 | If your buffer contains @emph{very} long lines, and you use |
c4adeee0 CY |
219 | continuation to display them, computing the continuation lines can |
220 | make Emacs redisplay slow. The column computation and indentation | |
221 | functions also become slow. Then you might find it advisable to set | |
b8d4c8d0 GM |
222 | @code{cache-long-line-scans} to @code{t}. |
223 | ||
224 | @defvar cache-long-line-scans | |
225 | If this variable is non-@code{nil}, various indentation and motion | |
226 | functions, and Emacs redisplay, cache the results of scanning the | |
227 | buffer, and consult the cache to avoid rescanning regions of the buffer | |
228 | unless they are modified. | |
229 | ||
230 | Turning on the cache slows down processing of short lines somewhat. | |
231 | ||
232 | This variable is automatically buffer-local in every buffer. | |
233 | @end defvar | |
234 | ||
235 | @node The Echo Area | |
236 | @section The Echo Area | |
237 | @cindex error display | |
238 | @cindex echo area | |
239 | ||
240 | The @dfn{echo area} is used for displaying error messages | |
241 | (@pxref{Errors}), for messages made with the @code{message} primitive, | |
242 | and for echoing keystrokes. It is not the same as the minibuffer, | |
243 | despite the fact that the minibuffer appears (when active) in the same | |
244 | place on the screen as the echo area. The @cite{GNU Emacs Manual} | |
245 | specifies the rules for resolving conflicts between the echo area and | |
246 | the minibuffer for use of that screen space (@pxref{Minibuffer,, The | |
247 | Minibuffer, emacs, The GNU Emacs Manual}). | |
248 | ||
249 | You can write output in the echo area by using the Lisp printing | |
250 | functions with @code{t} as the stream (@pxref{Output Functions}), or | |
251 | explicitly. | |
252 | ||
253 | @menu | |
254 | * Displaying Messages:: Explicitly displaying text in the echo area. | |
255 | * Progress:: Informing user about progress of a long operation. | |
256 | * Logging Messages:: Echo area messages are logged for the user. | |
257 | * Echo Area Customization:: Controlling the echo area. | |
258 | @end menu | |
259 | ||
260 | @node Displaying Messages | |
261 | @subsection Displaying Messages in the Echo Area | |
262 | @cindex display message in echo area | |
263 | ||
264 | This section describes the functions for explicitly producing echo | |
265 | area messages. Many other Emacs features display messages there, too. | |
266 | ||
267 | @defun message format-string &rest arguments | |
268 | This function displays a message in the echo area. The argument | |
269 | @var{format-string} is similar to a C language @code{printf} format | |
270 | string. See @code{format} in @ref{Formatting Strings}, for the details | |
271 | on the conversion specifications. @code{message} returns the | |
272 | constructed string. | |
273 | ||
274 | In batch mode, @code{message} prints the message text on the standard | |
275 | error stream, followed by a newline. | |
276 | ||
277 | If @var{format-string}, or strings among the @var{arguments}, have | |
278 | @code{face} text properties, these affect the way the message is displayed. | |
279 | ||
280 | @c Emacs 19 feature | |
281 | If @var{format-string} is @code{nil} or the empty string, | |
282 | @code{message} clears the echo area; if the echo area has been | |
283 | expanded automatically, this brings it back to its normal size. | |
284 | If the minibuffer is active, this brings the minibuffer contents back | |
285 | onto the screen immediately. | |
286 | ||
287 | @example | |
288 | @group | |
289 | (message "Minibuffer depth is %d." | |
290 | (minibuffer-depth)) | |
291 | @print{} Minibuffer depth is 0. | |
292 | @result{} "Minibuffer depth is 0." | |
293 | @end group | |
294 | ||
295 | @group | |
296 | ---------- Echo Area ---------- | |
297 | Minibuffer depth is 0. | |
298 | ---------- Echo Area ---------- | |
299 | @end group | |
300 | @end example | |
301 | ||
302 | To automatically display a message in the echo area or in a pop-buffer, | |
303 | depending on its size, use @code{display-message-or-buffer} (see below). | |
304 | @end defun | |
305 | ||
306 | @defmac with-temp-message message &rest body | |
307 | This construct displays a message in the echo area temporarily, during | |
308 | the execution of @var{body}. It displays @var{message}, executes | |
309 | @var{body}, then returns the value of the last body form while restoring | |
310 | the previous echo area contents. | |
311 | @end defmac | |
312 | ||
313 | @defun message-or-box format-string &rest arguments | |
314 | This function displays a message like @code{message}, but may display it | |
315 | in a dialog box instead of the echo area. If this function is called in | |
316 | a command that was invoked using the mouse---more precisely, if | |
317 | @code{last-nonmenu-event} (@pxref{Command Loop Info}) is either | |
318 | @code{nil} or a list---then it uses a dialog box or pop-up menu to | |
319 | display the message. Otherwise, it uses the echo area. (This is the | |
320 | same criterion that @code{y-or-n-p} uses to make a similar decision; see | |
321 | @ref{Yes-or-No Queries}.) | |
322 | ||
323 | You can force use of the mouse or of the echo area by binding | |
324 | @code{last-nonmenu-event} to a suitable value around the call. | |
325 | @end defun | |
326 | ||
327 | @defun message-box format-string &rest arguments | |
328 | @anchor{message-box} | |
329 | This function displays a message like @code{message}, but uses a dialog | |
330 | box (or a pop-up menu) whenever that is possible. If it is impossible | |
331 | to use a dialog box or pop-up menu, because the terminal does not | |
332 | support them, then @code{message-box} uses the echo area, like | |
333 | @code{message}. | |
334 | @end defun | |
335 | ||
336 | @defun display-message-or-buffer message &optional buffer-name not-this-window frame | |
337 | This function displays the message @var{message}, which may be either a | |
338 | string or a buffer. If it is shorter than the maximum height of the | |
339 | echo area, as defined by @code{max-mini-window-height}, it is displayed | |
340 | in the echo area, using @code{message}. Otherwise, | |
341 | @code{display-buffer} is used to show it in a pop-up buffer. | |
342 | ||
343 | Returns either the string shown in the echo area, or when a pop-up | |
344 | buffer is used, the window used to display it. | |
345 | ||
346 | If @var{message} is a string, then the optional argument | |
347 | @var{buffer-name} is the name of the buffer used to display it when a | |
348 | pop-up buffer is used, defaulting to @samp{*Message*}. In the case | |
349 | where @var{message} is a string and displayed in the echo area, it is | |
350 | not specified whether the contents are inserted into the buffer anyway. | |
351 | ||
352 | The optional arguments @var{not-this-window} and @var{frame} are as for | |
353 | @code{display-buffer}, and only used if a buffer is displayed. | |
354 | @end defun | |
355 | ||
356 | @defun current-message | |
357 | This function returns the message currently being displayed in the | |
358 | echo area, or @code{nil} if there is none. | |
359 | @end defun | |
360 | ||
361 | @node Progress | |
362 | @subsection Reporting Operation Progress | |
363 | @cindex progress reporting | |
364 | ||
365 | When an operation can take a while to finish, you should inform the | |
366 | user about the progress it makes. This way the user can estimate | |
367 | remaining time and clearly see that Emacs is busy working, not hung. | |
368 | ||
369 | Functions listed in this section provide simple and efficient way of | |
370 | reporting operation progress. Here is a working example that does | |
371 | nothing useful: | |
372 | ||
373 | @smallexample | |
374 | (let ((progress-reporter | |
375 | (make-progress-reporter "Collecting mana for Emacs..." | |
376 | 0 500))) | |
377 | (dotimes (k 500) | |
378 | (sit-for 0.01) | |
379 | (progress-reporter-update progress-reporter k)) | |
380 | (progress-reporter-done progress-reporter)) | |
381 | @end smallexample | |
382 | ||
383 | @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time | |
384 | This function creates and returns a @dfn{progress reporter}---an | |
385 | object you will use as an argument for all other functions listed | |
386 | here. The idea is to precompute as much data as possible to make | |
387 | progress reporting very fast. | |
388 | ||
389 | When this progress reporter is subsequently used, it will display | |
390 | @var{message} in the echo area, followed by progress percentage. | |
391 | @var{message} is treated as a simple string. If you need it to depend | |
392 | on a filename, for instance, use @code{format} before calling this | |
393 | function. | |
394 | ||
395 | @var{min-value} and @var{max-value} arguments stand for starting and | |
396 | final states of your operation. For instance, if you scan a buffer, | |
397 | they should be the results of @code{point-min} and @code{point-max} | |
398 | correspondingly. It is required that @var{max-value} is greater than | |
399 | @var{min-value}. If you create progress reporter when some part of | |
400 | the operation has already been completed, then specify | |
401 | @var{current-value} argument. But normally you should omit it or set | |
402 | it to @code{nil}---it will default to @var{min-value} then. | |
403 | ||
404 | Remaining arguments control the rate of echo area updates. Progress | |
405 | reporter will wait for at least @var{min-change} more percents of the | |
406 | operation to be completed before printing next message. | |
407 | @var{min-time} specifies the minimum time in seconds to pass between | |
408 | successive prints. It can be fractional. Depending on Emacs and | |
409 | system capabilities, progress reporter may or may not respect this | |
410 | last argument or do it with varying precision. Default value for | |
411 | @var{min-change} is 1 (one percent), for @var{min-time}---0.2 | |
412 | (seconds.) | |
413 | ||
414 | This function calls @code{progress-reporter-update}, so the first | |
415 | message is printed immediately. | |
416 | @end defun | |
417 | ||
418 | @defun progress-reporter-update reporter value | |
419 | This function does the main work of reporting progress of your | |
420 | operation. It displays the message of @var{reporter}, followed by | |
421 | progress percentage determined by @var{value}. If percentage is zero, | |
422 | or close enough according to the @var{min-change} and @var{min-time} | |
423 | arguments, then it is omitted from the output. | |
424 | ||
425 | @var{reporter} must be the result of a call to | |
426 | @code{make-progress-reporter}. @var{value} specifies the current | |
427 | state of your operation and must be between @var{min-value} and | |
428 | @var{max-value} (inclusive) as passed to | |
429 | @code{make-progress-reporter}. For instance, if you scan a buffer, | |
430 | then @var{value} should be the result of a call to @code{point}. | |
431 | ||
432 | This function respects @var{min-change} and @var{min-time} as passed | |
433 | to @code{make-progress-reporter} and so does not output new messages | |
434 | on every invocation. It is thus very fast and normally you should not | |
435 | try to reduce the number of calls to it: resulting overhead will most | |
436 | likely negate your effort. | |
437 | @end defun | |
438 | ||
439 | @defun progress-reporter-force-update reporter value &optional new-message | |
440 | This function is similar to @code{progress-reporter-update} except | |
441 | that it prints a message in the echo area unconditionally. | |
442 | ||
443 | The first two arguments have the same meaning as for | |
444 | @code{progress-reporter-update}. Optional @var{new-message} allows | |
445 | you to change the message of the @var{reporter}. Since this functions | |
446 | always updates the echo area, such a change will be immediately | |
447 | presented to the user. | |
448 | @end defun | |
449 | ||
450 | @defun progress-reporter-done reporter | |
451 | This function should be called when the operation is finished. It | |
452 | prints the message of @var{reporter} followed by word ``done'' in the | |
453 | echo area. | |
454 | ||
455 | You should always call this function and not hope for | |
456 | @code{progress-reporter-update} to print ``100%.'' Firstly, it may | |
457 | never print it, there are many good reasons for this not to happen. | |
458 | Secondly, ``done'' is more explicit. | |
459 | @end defun | |
460 | ||
461 | @defmac dotimes-with-progress-reporter (var count [result]) message body@dots{} | |
462 | This is a convenience macro that works the same way as @code{dotimes} | |
463 | does, but also reports loop progress using the functions described | |
464 | above. It allows you to save some typing. | |
465 | ||
466 | You can rewrite the example in the beginning of this node using | |
467 | this macro this way: | |
468 | ||
469 | @example | |
470 | (dotimes-with-progress-reporter | |
471 | (k 500) | |
472 | "Collecting some mana for Emacs..." | |
473 | (sit-for 0.01)) | |
474 | @end example | |
475 | @end defmac | |
476 | ||
477 | @node Logging Messages | |
478 | @subsection Logging Messages in @samp{*Messages*} | |
479 | @cindex logging echo-area messages | |
480 | ||
481 | Almost all the messages displayed in the echo area are also recorded | |
482 | in the @samp{*Messages*} buffer so that the user can refer back to | |
483 | them. This includes all the messages that are output with | |
484 | @code{message}. | |
485 | ||
486 | @defopt message-log-max | |
487 | This variable specifies how many lines to keep in the @samp{*Messages*} | |
488 | buffer. The value @code{t} means there is no limit on how many lines to | |
489 | keep. The value @code{nil} disables message logging entirely. Here's | |
490 | how to display a message and prevent it from being logged: | |
491 | ||
492 | @example | |
493 | (let (message-log-max) | |
494 | (message @dots{})) | |
495 | @end example | |
496 | @end defopt | |
497 | ||
498 | To make @samp{*Messages*} more convenient for the user, the logging | |
499 | facility combines successive identical messages. It also combines | |
500 | successive related messages for the sake of two cases: question | |
501 | followed by answer, and a series of progress messages. | |
502 | ||
503 | A ``question followed by an answer'' means two messages like the | |
504 | ones produced by @code{y-or-n-p}: the first is @samp{@var{question}}, | |
505 | and the second is @samp{@var{question}...@var{answer}}. The first | |
506 | message conveys no additional information beyond what's in the second, | |
507 | so logging the second message discards the first from the log. | |
508 | ||
509 | A ``series of progress messages'' means successive messages like | |
510 | those produced by @code{make-progress-reporter}. They have the form | |
511 | @samp{@var{base}...@var{how-far}}, where @var{base} is the same each | |
512 | time, while @var{how-far} varies. Logging each message in the series | |
513 | discards the previous one, provided they are consecutive. | |
514 | ||
515 | The functions @code{make-progress-reporter} and @code{y-or-n-p} | |
516 | don't have to do anything special to activate the message log | |
517 | combination feature. It operates whenever two consecutive messages | |
518 | are logged that share a common prefix ending in @samp{...}. | |
519 | ||
520 | @node Echo Area Customization | |
521 | @subsection Echo Area Customization | |
522 | ||
523 | These variables control details of how the echo area works. | |
524 | ||
525 | @defvar cursor-in-echo-area | |
526 | This variable controls where the cursor appears when a message is | |
527 | displayed in the echo area. If it is non-@code{nil}, then the cursor | |
528 | appears at the end of the message. Otherwise, the cursor appears at | |
529 | point---not in the echo area at all. | |
530 | ||
531 | The value is normally @code{nil}; Lisp programs bind it to @code{t} | |
532 | for brief periods of time. | |
533 | @end defvar | |
534 | ||
535 | @defvar echo-area-clear-hook | |
536 | This normal hook is run whenever the echo area is cleared---either by | |
537 | @code{(message nil)} or for any other reason. | |
538 | @end defvar | |
539 | ||
01f17ae2 | 540 | @defopt echo-keystrokes |
b8d4c8d0 GM |
541 | This variable determines how much time should elapse before command |
542 | characters echo. Its value must be an integer or floating point number, | |
543 | which specifies the | |
544 | number of seconds to wait before echoing. If the user types a prefix | |
545 | key (such as @kbd{C-x}) and then delays this many seconds before | |
546 | continuing, the prefix key is echoed in the echo area. (Once echoing | |
547 | begins in a key sequence, all subsequent characters in the same key | |
548 | sequence are echoed immediately.) | |
549 | ||
550 | If the value is zero, then command input is not echoed. | |
01f17ae2 | 551 | @end defopt |
b8d4c8d0 GM |
552 | |
553 | @defvar message-truncate-lines | |
554 | Normally, displaying a long message resizes the echo area to display | |
555 | the entire message. But if the variable @code{message-truncate-lines} | |
556 | is non-@code{nil}, the echo area does not resize, and the message is | |
557 | truncated to fit it, as in Emacs 20 and before. | |
558 | @end defvar | |
559 | ||
560 | The variable @code{max-mini-window-height}, which specifies the | |
561 | maximum height for resizing minibuffer windows, also applies to the | |
562 | echo area (which is really a special use of the minibuffer window. | |
35539065 | 563 | @xref{Minibuffer Misc}.). |
b8d4c8d0 GM |
564 | |
565 | @node Warnings | |
566 | @section Reporting Warnings | |
567 | @cindex warnings | |
568 | ||
569 | @dfn{Warnings} are a facility for a program to inform the user of a | |
570 | possible problem, but continue running. | |
571 | ||
572 | @menu | |
573 | * Warning Basics:: Warnings concepts and functions to report them. | |
574 | * Warning Variables:: Variables programs bind to customize their warnings. | |
575 | * Warning Options:: Variables users set to control display of warnings. | |
576 | @end menu | |
577 | ||
578 | @node Warning Basics | |
579 | @subsection Warning Basics | |
580 | @cindex severity level | |
581 | ||
582 | Every warning has a textual message, which explains the problem for | |
583 | the user, and a @dfn{severity level} which is a symbol. Here are the | |
584 | possible severity levels, in order of decreasing severity, and their | |
585 | meanings: | |
586 | ||
587 | @table @code | |
588 | @item :emergency | |
589 | A problem that will seriously impair Emacs operation soon | |
590 | if you do not attend to it promptly. | |
591 | @item :error | |
592 | A report of data or circumstances that are inherently wrong. | |
593 | @item :warning | |
594 | A report of data or circumstances that are not inherently wrong, but | |
595 | raise suspicion of a possible problem. | |
596 | @item :debug | |
597 | A report of information that may be useful if you are debugging. | |
598 | @end table | |
599 | ||
600 | When your program encounters invalid input data, it can either | |
601 | signal a Lisp error by calling @code{error} or @code{signal} or report | |
602 | a warning with severity @code{:error}. Signaling a Lisp error is the | |
603 | easiest thing to do, but it means the program cannot continue | |
604 | processing. If you want to take the trouble to implement a way to | |
605 | continue processing despite the bad data, then reporting a warning of | |
606 | severity @code{:error} is the right way to inform the user of the | |
607 | problem. For instance, the Emacs Lisp byte compiler can report an | |
608 | error that way and continue compiling other functions. (If the | |
609 | program signals a Lisp error and then handles it with | |
610 | @code{condition-case}, the user won't see the error message; it could | |
611 | show the message to the user by reporting it as a warning.) | |
612 | ||
613 | @cindex warning type | |
614 | Each warning has a @dfn{warning type} to classify it. The type is a | |
615 | list of symbols. The first symbol should be the custom group that you | |
616 | use for the program's user options. For example, byte compiler | |
617 | warnings use the warning type @code{(bytecomp)}. You can also | |
618 | subcategorize the warnings, if you wish, by using more symbols in the | |
619 | list. | |
620 | ||
621 | @defun display-warning type message &optional level buffer-name | |
622 | This function reports a warning, using @var{message} as the message | |
623 | and @var{type} as the warning type. @var{level} should be the | |
624 | severity level, with @code{:warning} being the default. | |
625 | ||
626 | @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer | |
627 | for logging the warning. By default, it is @samp{*Warnings*}. | |
628 | @end defun | |
629 | ||
630 | @defun lwarn type level message &rest args | |
631 | This function reports a warning using the value of @code{(format | |
632 | @var{message} @var{args}...)} as the message. In other respects it is | |
633 | equivalent to @code{display-warning}. | |
634 | @end defun | |
635 | ||
636 | @defun warn message &rest args | |
637 | This function reports a warning using the value of @code{(format | |
638 | @var{message} @var{args}...)} as the message, @code{(emacs)} as the | |
639 | type, and @code{:warning} as the severity level. It exists for | |
640 | compatibility only; we recommend not using it, because you should | |
641 | specify a specific warning type. | |
642 | @end defun | |
643 | ||
644 | @node Warning Variables | |
645 | @subsection Warning Variables | |
646 | ||
647 | Programs can customize how their warnings appear by binding | |
648 | the variables described in this section. | |
649 | ||
650 | @defvar warning-levels | |
651 | This list defines the meaning and severity order of the warning | |
652 | severity levels. Each element defines one severity level, | |
653 | and they are arranged in order of decreasing severity. | |
654 | ||
655 | Each element has the form @code{(@var{level} @var{string} | |
656 | @var{function})}, where @var{level} is the severity level it defines. | |
657 | @var{string} specifies the textual description of this level. | |
658 | @var{string} should use @samp{%s} to specify where to put the warning | |
659 | type information, or it can omit the @samp{%s} so as not to include | |
660 | that information. | |
661 | ||
662 | The optional @var{function}, if non-@code{nil}, is a function to call | |
663 | with no arguments, to get the user's attention. | |
664 | ||
665 | Normally you should not change the value of this variable. | |
666 | @end defvar | |
667 | ||
668 | @defvar warning-prefix-function | |
669 | If non-@code{nil}, the value is a function to generate prefix text for | |
670 | warnings. Programs can bind the variable to a suitable function. | |
671 | @code{display-warning} calls this function with the warnings buffer | |
672 | current, and the function can insert text in it. That text becomes | |
673 | the beginning of the warning message. | |
674 | ||
675 | The function is called with two arguments, the severity level and its | |
676 | entry in @code{warning-levels}. It should return a list to use as the | |
677 | entry (this value need not be an actual member of | |
678 | @code{warning-levels}). By constructing this value, the function can | |
679 | change the severity of the warning, or specify different handling for | |
680 | a given severity level. | |
681 | ||
682 | If the variable's value is @code{nil} then there is no function | |
683 | to call. | |
684 | @end defvar | |
685 | ||
686 | @defvar warning-series | |
687 | Programs can bind this variable to @code{t} to say that the next | |
688 | warning should begin a series. When several warnings form a series, | |
689 | that means to leave point on the first warning of the series, rather | |
690 | than keep moving it for each warning so that it appears on the last one. | |
691 | The series ends when the local binding is unbound and | |
692 | @code{warning-series} becomes @code{nil} again. | |
693 | ||
694 | The value can also be a symbol with a function definition. That is | |
695 | equivalent to @code{t}, except that the next warning will also call | |
696 | the function with no arguments with the warnings buffer current. The | |
697 | function can insert text which will serve as a header for the series | |
698 | of warnings. | |
699 | ||
700 | Once a series has begun, the value is a marker which points to the | |
701 | buffer position in the warnings buffer of the start of the series. | |
702 | ||
703 | The variable's normal value is @code{nil}, which means to handle | |
704 | each warning separately. | |
705 | @end defvar | |
706 | ||
707 | @defvar warning-fill-prefix | |
708 | When this variable is non-@code{nil}, it specifies a fill prefix to | |
709 | use for filling each warning's text. | |
710 | @end defvar | |
711 | ||
712 | @defvar warning-type-format | |
713 | This variable specifies the format for displaying the warning type | |
714 | in the warning message. The result of formatting the type this way | |
715 | gets included in the message under the control of the string in the | |
716 | entry in @code{warning-levels}. The default value is @code{" (%s)"}. | |
717 | If you bind it to @code{""} then the warning type won't appear at | |
718 | all. | |
719 | @end defvar | |
720 | ||
721 | @node Warning Options | |
722 | @subsection Warning Options | |
723 | ||
724 | These variables are used by users to control what happens | |
725 | when a Lisp program reports a warning. | |
726 | ||
727 | @defopt warning-minimum-level | |
728 | This user option specifies the minimum severity level that should be | |
729 | shown immediately to the user. The default is @code{:warning}, which | |
730 | means to immediately display all warnings except @code{:debug} | |
731 | warnings. | |
732 | @end defopt | |
733 | ||
734 | @defopt warning-minimum-log-level | |
735 | This user option specifies the minimum severity level that should be | |
736 | logged in the warnings buffer. The default is @code{:warning}, which | |
737 | means to log all warnings except @code{:debug} warnings. | |
738 | @end defopt | |
739 | ||
740 | @defopt warning-suppress-types | |
741 | This list specifies which warning types should not be displayed | |
742 | immediately for the user. Each element of the list should be a list | |
743 | of symbols. If its elements match the first elements in a warning | |
744 | type, then that warning is not displayed immediately. | |
745 | @end defopt | |
746 | ||
747 | @defopt warning-suppress-log-types | |
748 | This list specifies which warning types should not be logged in the | |
749 | warnings buffer. Each element of the list should be a list of | |
750 | symbols. If it matches the first few elements in a warning type, then | |
751 | that warning is not logged. | |
752 | @end defopt | |
753 | ||
754 | @node Invisible Text | |
755 | @section Invisible Text | |
756 | ||
757 | @cindex invisible text | |
758 | You can make characters @dfn{invisible}, so that they do not appear on | |
759 | the screen, with the @code{invisible} property. This can be either a | |
760 | text property (@pxref{Text Properties}) or a property of an overlay | |
761 | (@pxref{Overlays}). Cursor motion also partly ignores these | |
762 | characters; if the command loop finds point within them, it moves | |
763 | point to the other side of them. | |
764 | ||
765 | In the simplest case, any non-@code{nil} @code{invisible} property makes | |
766 | a character invisible. This is the default case---if you don't alter | |
767 | the default value of @code{buffer-invisibility-spec}, this is how the | |
768 | @code{invisible} property works. You should normally use @code{t} | |
769 | as the value of the @code{invisible} property if you don't plan | |
770 | to set @code{buffer-invisibility-spec} yourself. | |
771 | ||
772 | More generally, you can use the variable @code{buffer-invisibility-spec} | |
773 | to control which values of the @code{invisible} property make text | |
774 | invisible. This permits you to classify the text into different subsets | |
775 | in advance, by giving them different @code{invisible} values, and | |
776 | subsequently make various subsets visible or invisible by changing the | |
777 | value of @code{buffer-invisibility-spec}. | |
778 | ||
779 | Controlling visibility with @code{buffer-invisibility-spec} is | |
780 | especially useful in a program to display the list of entries in a | |
781 | database. It permits the implementation of convenient filtering | |
782 | commands to view just a part of the entries in the database. Setting | |
783 | this variable is very fast, much faster than scanning all the text in | |
784 | the buffer looking for properties to change. | |
785 | ||
786 | @defvar buffer-invisibility-spec | |
787 | This variable specifies which kinds of @code{invisible} properties | |
788 | actually make a character invisible. Setting this variable makes it | |
789 | buffer-local. | |
790 | ||
791 | @table @asis | |
792 | @item @code{t} | |
793 | A character is invisible if its @code{invisible} property is | |
794 | non-@code{nil}. This is the default. | |
795 | ||
796 | @item a list | |
797 | Each element of the list specifies a criterion for invisibility; if a | |
798 | character's @code{invisible} property fits any one of these criteria, | |
799 | the character is invisible. The list can have two kinds of elements: | |
800 | ||
801 | @table @code | |
802 | @item @var{atom} | |
803 | A character is invisible if its @code{invisible} property value | |
804 | is @var{atom} or if it is a list with @var{atom} as a member. | |
805 | ||
806 | @item (@var{atom} . t) | |
807 | A character is invisible if its @code{invisible} property value is | |
808 | @var{atom} or if it is a list with @var{atom} as a member. Moreover, | |
809 | a sequence of such characters displays as an ellipsis. | |
810 | @end table | |
811 | @end table | |
812 | @end defvar | |
813 | ||
814 | Two functions are specifically provided for adding elements to | |
815 | @code{buffer-invisibility-spec} and removing elements from it. | |
816 | ||
817 | @defun add-to-invisibility-spec element | |
818 | This function adds the element @var{element} to | |
819 | @code{buffer-invisibility-spec}. If @code{buffer-invisibility-spec} | |
820 | was @code{t}, it changes to a list, @code{(t)}, so that text whose | |
821 | @code{invisible} property is @code{t} remains invisible. | |
822 | @end defun | |
823 | ||
824 | @defun remove-from-invisibility-spec element | |
825 | This removes the element @var{element} from | |
826 | @code{buffer-invisibility-spec}. This does nothing if @var{element} | |
827 | is not in the list. | |
828 | @end defun | |
829 | ||
830 | A convention for use of @code{buffer-invisibility-spec} is that a | |
831 | major mode should use the mode's own name as an element of | |
832 | @code{buffer-invisibility-spec} and as the value of the | |
833 | @code{invisible} property: | |
834 | ||
835 | @example | |
836 | ;; @r{If you want to display an ellipsis:} | |
837 | (add-to-invisibility-spec '(my-symbol . t)) | |
838 | ;; @r{If you don't want ellipsis:} | |
839 | (add-to-invisibility-spec 'my-symbol) | |
840 | ||
841 | (overlay-put (make-overlay beginning end) | |
842 | 'invisible 'my-symbol) | |
843 | ||
844 | ;; @r{When done with the overlays:} | |
845 | (remove-from-invisibility-spec '(my-symbol . t)) | |
846 | ;; @r{Or respectively:} | |
847 | (remove-from-invisibility-spec 'my-symbol) | |
848 | @end example | |
849 | ||
c4adeee0 CY |
850 | You can check for invisibility using the following function: |
851 | ||
852 | @defun invisible-p pos-or-prop | |
853 | If @var{pos-or-prop} is a marker or number, this function returns a | |
854 | non-@code{nil} value if the text at that position is invisible. | |
855 | ||
856 | If @var{pos-or-prop} is any other kind of Lisp object, that is taken | |
857 | to mean a possible value of the @code{invisible} text or overlay | |
858 | property. In that case, this function returns a non-@code{nil} value | |
859 | if that value would cause text to become invisible, based on the | |
860 | current value of @code{buffer-invisibility-spec}. | |
861 | @end defun | |
862 | ||
b8d4c8d0 GM |
863 | @vindex line-move-ignore-invisible |
864 | Ordinarily, functions that operate on text or move point do not care | |
865 | whether the text is invisible. The user-level line motion commands | |
c4adeee0 CY |
866 | ignore invisible newlines if @code{line-move-ignore-invisible} is |
867 | non-@code{nil} (the default), but only because they are explicitly | |
868 | programmed to do so. | |
b8d4c8d0 GM |
869 | |
870 | However, if a command ends with point inside or immediately before | |
871 | invisible text, the main editing loop moves point further forward or | |
872 | further backward (in the same direction that the command already moved | |
873 | it) until that condition is no longer true. Thus, if the command | |
874 | moved point back into an invisible range, Emacs moves point back to | |
875 | the beginning of that range, and then back one more character. If the | |
876 | command moved point forward into an invisible range, Emacs moves point | |
877 | forward up to the first visible character that follows the invisible | |
878 | text. | |
879 | ||
880 | Incremental search can make invisible overlays visible temporarily | |
881 | and/or permanently when a match includes invisible text. To enable | |
882 | this, the overlay should have a non-@code{nil} | |
883 | @code{isearch-open-invisible} property. The property value should be a | |
884 | function to be called with the overlay as an argument. This function | |
885 | should make the overlay visible permanently; it is used when the match | |
886 | overlaps the overlay on exit from the search. | |
887 | ||
888 | During the search, such overlays are made temporarily visible by | |
889 | temporarily modifying their invisible and intangible properties. If you | |
890 | want this to be done differently for a certain overlay, give it an | |
891 | @code{isearch-open-invisible-temporary} property which is a function. | |
892 | The function is called with two arguments: the first is the overlay, and | |
893 | the second is @code{nil} to make the overlay visible, or @code{t} to | |
894 | make it invisible again. | |
895 | ||
896 | @node Selective Display | |
897 | @section Selective Display | |
898 | @c @cindex selective display Duplicates selective-display | |
899 | ||
900 | @dfn{Selective display} refers to a pair of related features for | |
901 | hiding certain lines on the screen. | |
902 | ||
903 | The first variant, explicit selective display, is designed for use | |
904 | in a Lisp program: it controls which lines are hidden by altering the | |
905 | text. This kind of hiding in some ways resembles the effect of the | |
906 | @code{invisible} property (@pxref{Invisible Text}), but the two | |
907 | features are different and do not work the same way. | |
908 | ||
909 | In the second variant, the choice of lines to hide is made | |
910 | automatically based on indentation. This variant is designed to be a | |
911 | user-level feature. | |
912 | ||
913 | The way you control explicit selective display is by replacing a | |
914 | newline (control-j) with a carriage return (control-m). The text that | |
915 | was formerly a line following that newline is now hidden. Strictly | |
916 | speaking, it is temporarily no longer a line at all, since only | |
917 | newlines can separate lines; it is now part of the previous line. | |
918 | ||
919 | Selective display does not directly affect editing commands. For | |
920 | example, @kbd{C-f} (@code{forward-char}) moves point unhesitatingly | |
921 | into hidden text. However, the replacement of newline characters with | |
922 | carriage return characters affects some editing commands. For | |
923 | example, @code{next-line} skips hidden lines, since it searches only | |
924 | for newlines. Modes that use selective display can also define | |
925 | commands that take account of the newlines, or that control which | |
926 | parts of the text are hidden. | |
927 | ||
928 | When you write a selectively displayed buffer into a file, all the | |
929 | control-m's are output as newlines. This means that when you next read | |
930 | in the file, it looks OK, with nothing hidden. The selective display | |
931 | effect is seen only within Emacs. | |
932 | ||
933 | @defvar selective-display | |
934 | This buffer-local variable enables selective display. This means that | |
935 | lines, or portions of lines, may be made hidden. | |
936 | ||
937 | @itemize @bullet | |
938 | @item | |
939 | If the value of @code{selective-display} is @code{t}, then the character | |
940 | control-m marks the start of hidden text; the control-m, and the rest | |
941 | of the line following it, are not displayed. This is explicit selective | |
942 | display. | |
943 | ||
944 | @item | |
945 | If the value of @code{selective-display} is a positive integer, then | |
946 | lines that start with more than that many columns of indentation are not | |
947 | displayed. | |
948 | @end itemize | |
949 | ||
950 | When some portion of a buffer is hidden, the vertical movement | |
951 | commands operate as if that portion did not exist, allowing a single | |
952 | @code{next-line} command to skip any number of hidden lines. | |
953 | However, character movement commands (such as @code{forward-char}) do | |
954 | not skip the hidden portion, and it is possible (if tricky) to insert | |
955 | or delete text in an hidden portion. | |
956 | ||
957 | In the examples below, we show the @emph{display appearance} of the | |
958 | buffer @code{foo}, which changes with the value of | |
959 | @code{selective-display}. The @emph{contents} of the buffer do not | |
960 | change. | |
961 | ||
962 | @example | |
963 | @group | |
964 | (setq selective-display nil) | |
965 | @result{} nil | |
966 | ||
967 | ---------- Buffer: foo ---------- | |
968 | 1 on this column | |
969 | 2on this column | |
970 | 3n this column | |
971 | 3n this column | |
972 | 2on this column | |
973 | 1 on this column | |
974 | ---------- Buffer: foo ---------- | |
975 | @end group | |
976 | ||
977 | @group | |
978 | (setq selective-display 2) | |
979 | @result{} 2 | |
980 | ||
981 | ---------- Buffer: foo ---------- | |
982 | 1 on this column | |
983 | 2on this column | |
984 | 2on this column | |
985 | 1 on this column | |
986 | ---------- Buffer: foo ---------- | |
987 | @end group | |
988 | @end example | |
989 | @end defvar | |
990 | ||
01f17ae2 | 991 | @defopt selective-display-ellipses |
b8d4c8d0 GM |
992 | If this buffer-local variable is non-@code{nil}, then Emacs displays |
993 | @samp{@dots{}} at the end of a line that is followed by hidden text. | |
994 | This example is a continuation of the previous one. | |
995 | ||
996 | @example | |
997 | @group | |
998 | (setq selective-display-ellipses t) | |
999 | @result{} t | |
1000 | ||
1001 | ---------- Buffer: foo ---------- | |
1002 | 1 on this column | |
1003 | 2on this column ... | |
1004 | 2on this column | |
1005 | 1 on this column | |
1006 | ---------- Buffer: foo ---------- | |
1007 | @end group | |
1008 | @end example | |
1009 | ||
1010 | You can use a display table to substitute other text for the ellipsis | |
1011 | (@samp{@dots{}}). @xref{Display Tables}. | |
01f17ae2 | 1012 | @end defopt |
b8d4c8d0 GM |
1013 | |
1014 | @node Temporary Displays | |
1015 | @section Temporary Displays | |
1016 | ||
1017 | Temporary displays are used by Lisp programs to put output into a | |
1018 | buffer and then present it to the user for perusal rather than for | |
1019 | editing. Many help commands use this feature. | |
1020 | ||
1021 | @defspec with-output-to-temp-buffer buffer-name forms@dots{} | |
1022 | This function executes @var{forms} while arranging to insert any output | |
1023 | they print into the buffer named @var{buffer-name}, which is first | |
1024 | created if necessary, and put into Help mode. Finally, the buffer is | |
1025 | displayed in some window, but not selected. | |
1026 | ||
1027 | If the @var{forms} do not change the major mode in the output buffer, | |
1028 | so that it is still Help mode at the end of their execution, then | |
1029 | @code{with-output-to-temp-buffer} makes this buffer read-only at the | |
1030 | end, and also scans it for function and variable names to make them | |
1031 | into clickable cross-references. @xref{Docstring hyperlinks, , Tips | |
1032 | for Documentation Strings}, in particular the item on hyperlinks in | |
1033 | documentation strings, for more details. | |
1034 | ||
1035 | The string @var{buffer-name} specifies the temporary buffer, which | |
1036 | need not already exist. The argument must be a string, not a buffer. | |
1037 | The buffer is erased initially (with no questions asked), and it is | |
1038 | marked as unmodified after @code{with-output-to-temp-buffer} exits. | |
1039 | ||
1040 | @code{with-output-to-temp-buffer} binds @code{standard-output} to the | |
1041 | temporary buffer, then it evaluates the forms in @var{forms}. Output | |
1042 | using the Lisp output functions within @var{forms} goes by default to | |
1043 | that buffer (but screen display and messages in the echo area, although | |
1044 | they are ``output'' in the general sense of the word, are not affected). | |
1045 | @xref{Output Functions}. | |
1046 | ||
1047 | Several hooks are available for customizing the behavior | |
1048 | of this construct; they are listed below. | |
1049 | ||
1050 | The value of the last form in @var{forms} is returned. | |
1051 | ||
1052 | @example | |
1053 | @group | |
1054 | ---------- Buffer: foo ---------- | |
1055 | This is the contents of foo. | |
1056 | ---------- Buffer: foo ---------- | |
1057 | @end group | |
1058 | ||
1059 | @group | |
1060 | (with-output-to-temp-buffer "foo" | |
1061 | (print 20) | |
1062 | (print standard-output)) | |
1063 | @result{} #<buffer foo> | |
1064 | ||
1065 | ---------- Buffer: foo ---------- | |
1066 | 20 | |
1067 | ||
1068 | #<buffer foo> | |
1069 | ||
1070 | ---------- Buffer: foo ---------- | |
1071 | @end group | |
1072 | @end example | |
1073 | @end defspec | |
1074 | ||
01f17ae2 | 1075 | @defopt temp-buffer-show-function |
b8d4c8d0 GM |
1076 | If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
1077 | calls it as a function to do the job of displaying a help buffer. The | |
1078 | function gets one argument, which is the buffer it should display. | |
1079 | ||
1080 | It is a good idea for this function to run @code{temp-buffer-show-hook} | |
1081 | just as @code{with-output-to-temp-buffer} normally would, inside of | |
1082 | @code{save-selected-window} and with the chosen window and buffer | |
1083 | selected. | |
01f17ae2 | 1084 | @end defopt |
b8d4c8d0 GM |
1085 | |
1086 | @defvar temp-buffer-setup-hook | |
1087 | This normal hook is run by @code{with-output-to-temp-buffer} before | |
1088 | evaluating @var{body}. When the hook runs, the temporary buffer is | |
1089 | current. This hook is normally set up with a function to put the | |
1090 | buffer in Help mode. | |
1091 | @end defvar | |
1092 | ||
1093 | @defvar temp-buffer-show-hook | |
1094 | This normal hook is run by @code{with-output-to-temp-buffer} after | |
1095 | displaying the temporary buffer. When the hook runs, the temporary buffer | |
6733e827 | 1096 | is current, and the window it was displayed in is selected. |
b8d4c8d0 GM |
1097 | @end defvar |
1098 | ||
1099 | @defun momentary-string-display string position &optional char message | |
1100 | This function momentarily displays @var{string} in the current buffer at | |
1101 | @var{position}. It has no effect on the undo list or on the buffer's | |
1102 | modification status. | |
1103 | ||
1104 | The momentary display remains until the next input event. If the next | |
1105 | input event is @var{char}, @code{momentary-string-display} ignores it | |
1106 | and returns. Otherwise, that event remains buffered for subsequent use | |
1107 | as input. Thus, typing @var{char} will simply remove the string from | |
1108 | the display, while typing (say) @kbd{C-f} will remove the string from | |
1109 | the display and later (presumably) move point forward. The argument | |
1110 | @var{char} is a space by default. | |
1111 | ||
1112 | The return value of @code{momentary-string-display} is not meaningful. | |
1113 | ||
1114 | If the string @var{string} does not contain control characters, you can | |
1115 | do the same job in a more general way by creating (and then subsequently | |
1116 | deleting) an overlay with a @code{before-string} property. | |
1117 | @xref{Overlay Properties}. | |
1118 | ||
1119 | If @var{message} is non-@code{nil}, it is displayed in the echo area | |
1120 | while @var{string} is displayed in the buffer. If it is @code{nil}, a | |
1121 | default message says to type @var{char} to continue. | |
1122 | ||
1123 | In this example, point is initially located at the beginning of the | |
1124 | second line: | |
1125 | ||
1126 | @example | |
1127 | @group | |
1128 | ---------- Buffer: foo ---------- | |
1129 | This is the contents of foo. | |
1130 | @point{}Second line. | |
1131 | ---------- Buffer: foo ---------- | |
1132 | @end group | |
1133 | ||
1134 | @group | |
1135 | (momentary-string-display | |
1136 | "**** Important Message! ****" | |
1137 | (point) ?\r | |
1138 | "Type RET when done reading") | |
1139 | @result{} t | |
1140 | @end group | |
1141 | ||
1142 | @group | |
1143 | ---------- Buffer: foo ---------- | |
1144 | This is the contents of foo. | |
1145 | **** Important Message! ****Second line. | |
1146 | ---------- Buffer: foo ---------- | |
1147 | ||
1148 | ---------- Echo Area ---------- | |
1149 | Type RET when done reading | |
1150 | ---------- Echo Area ---------- | |
1151 | @end group | |
1152 | @end example | |
1153 | @end defun | |
1154 | ||
1155 | @node Overlays | |
1156 | @section Overlays | |
1157 | @cindex overlays | |
1158 | ||
1159 | You can use @dfn{overlays} to alter the appearance of a buffer's text on | |
1160 | the screen, for the sake of presentation features. An overlay is an | |
1161 | object that belongs to a particular buffer, and has a specified | |
1162 | beginning and end. It also has properties that you can examine and set; | |
1163 | these affect the display of the text within the overlay. | |
1164 | ||
b20ecfa1 EZ |
1165 | @cindex scalability of overlays |
1166 | The visual effect of an overlay is the same as of the corresponding | |
1167 | text property (@pxref{Text Properties}). However, due to a different | |
1168 | implementation, overlays generally don't scale well (many operations | |
1169 | take a time that is proportional to the number of overlays in the | |
1170 | buffer). If you need to affect the visual appearance of many portions | |
0c1cfe01 | 1171 | in the buffer, we recommend using text properties. |
b20ecfa1 | 1172 | |
b8d4c8d0 GM |
1173 | An overlay uses markers to record its beginning and end; thus, |
1174 | editing the text of the buffer adjusts the beginning and end of each | |
1175 | overlay so that it stays with the text. When you create the overlay, | |
1176 | you can specify whether text inserted at the beginning should be | |
1177 | inside the overlay or outside, and likewise for the end of the overlay. | |
1178 | ||
1179 | @menu | |
1180 | * Managing Overlays:: Creating and moving overlays. | |
1181 | * Overlay Properties:: How to read and set properties. | |
d24880de | 1182 | What properties do to the screen display. |
b8d4c8d0 GM |
1183 | * Finding Overlays:: Searching for overlays. |
1184 | @end menu | |
1185 | ||
1186 | @node Managing Overlays | |
1187 | @subsection Managing Overlays | |
1188 | ||
1189 | This section describes the functions to create, delete and move | |
1190 | overlays, and to examine their contents. Overlay changes are not | |
1191 | recorded in the buffer's undo list, since the overlays are not | |
1192 | part of the buffer's contents. | |
1193 | ||
1194 | @defun overlayp object | |
1195 | This function returns @code{t} if @var{object} is an overlay. | |
1196 | @end defun | |
1197 | ||
1198 | @defun make-overlay start end &optional buffer front-advance rear-advance | |
1199 | This function creates and returns an overlay that belongs to | |
1200 | @var{buffer} and ranges from @var{start} to @var{end}. Both @var{start} | |
1201 | and @var{end} must specify buffer positions; they may be integers or | |
1202 | markers. If @var{buffer} is omitted, the overlay is created in the | |
1203 | current buffer. | |
1204 | ||
1205 | The arguments @var{front-advance} and @var{rear-advance} specify the | |
1206 | marker insertion type for the start of the overlay and for the end of | |
1207 | the overlay, respectively. @xref{Marker Insertion Types}. If they | |
1208 | are both @code{nil}, the default, then the overlay extends to include | |
1209 | any text inserted at the beginning, but not text inserted at the end. | |
1210 | If @var{front-advance} is non-@code{nil}, text inserted at the | |
1211 | beginning of the overlay is excluded from the overlay. If | |
1212 | @var{rear-advance} is non-@code{nil}, text inserted at the end of the | |
1213 | overlay is included in the overlay. | |
1214 | @end defun | |
1215 | ||
1216 | @defun overlay-start overlay | |
1217 | This function returns the position at which @var{overlay} starts, | |
1218 | as an integer. | |
1219 | @end defun | |
1220 | ||
1221 | @defun overlay-end overlay | |
1222 | This function returns the position at which @var{overlay} ends, | |
1223 | as an integer. | |
1224 | @end defun | |
1225 | ||
1226 | @defun overlay-buffer overlay | |
1227 | This function returns the buffer that @var{overlay} belongs to. It | |
1228 | returns @code{nil} if @var{overlay} has been deleted. | |
1229 | @end defun | |
1230 | ||
1231 | @defun delete-overlay overlay | |
1232 | This function deletes @var{overlay}. The overlay continues to exist as | |
1233 | a Lisp object, and its property list is unchanged, but it ceases to be | |
1234 | attached to the buffer it belonged to, and ceases to have any effect on | |
1235 | display. | |
1236 | ||
1237 | A deleted overlay is not permanently disconnected. You can give it a | |
1238 | position in a buffer again by calling @code{move-overlay}. | |
1239 | @end defun | |
1240 | ||
1241 | @defun move-overlay overlay start end &optional buffer | |
1242 | This function moves @var{overlay} to @var{buffer}, and places its bounds | |
1243 | at @var{start} and @var{end}. Both arguments @var{start} and @var{end} | |
1244 | must specify buffer positions; they may be integers or markers. | |
1245 | ||
1246 | If @var{buffer} is omitted, @var{overlay} stays in the same buffer it | |
1247 | was already associated with; if @var{overlay} was deleted, it goes into | |
1248 | the current buffer. | |
1249 | ||
1250 | The return value is @var{overlay}. | |
1251 | ||
1252 | This is the only valid way to change the endpoints of an overlay. Do | |
1253 | not try modifying the markers in the overlay by hand, as that fails to | |
1254 | update other vital data structures and can cause some overlays to be | |
1255 | ``lost.'' | |
1256 | @end defun | |
1257 | ||
1258 | @defun remove-overlays &optional start end name value | |
1259 | This function removes all the overlays between @var{start} and | |
1260 | @var{end} whose property @var{name} has the value @var{value}. It can | |
1261 | move the endpoints of the overlays in the region, or split them. | |
1262 | ||
1263 | If @var{name} is omitted or @code{nil}, it means to delete all overlays in | |
1264 | the specified region. If @var{start} and/or @var{end} are omitted or | |
1265 | @code{nil}, that means the beginning and end of the buffer respectively. | |
1266 | Therefore, @code{(remove-overlays)} removes all the overlays in the | |
1267 | current buffer. | |
78427304 CY |
1268 | @end defun |
1269 | ||
1270 | @defun copy-overlay overlay | |
1271 | This function returns a copy of @var{overlay}. The copy has the same | |
1272 | endpoints and properties as @var{overlay}. However, the marker | |
1273 | insertion type for the start of the overlay and for the end of the | |
1274 | overlay are set to their default values (@pxref{Marker Insertion | |
1275 | Types}). | |
b8d4c8d0 GM |
1276 | @end defun |
1277 | ||
1278 | Here are some examples: | |
1279 | ||
1280 | @example | |
1281 | ;; @r{Create an overlay.} | |
1282 | (setq foo (make-overlay 1 10)) | |
1283 | @result{} #<overlay from 1 to 10 in display.texi> | |
1284 | (overlay-start foo) | |
1285 | @result{} 1 | |
1286 | (overlay-end foo) | |
1287 | @result{} 10 | |
1288 | (overlay-buffer foo) | |
1289 | @result{} #<buffer display.texi> | |
1290 | ;; @r{Give it a property we can check later.} | |
1291 | (overlay-put foo 'happy t) | |
1292 | @result{} t | |
1293 | ;; @r{Verify the property is present.} | |
1294 | (overlay-get foo 'happy) | |
1295 | @result{} t | |
1296 | ;; @r{Move the overlay.} | |
1297 | (move-overlay foo 5 20) | |
1298 | @result{} #<overlay from 5 to 20 in display.texi> | |
1299 | (overlay-start foo) | |
1300 | @result{} 5 | |
1301 | (overlay-end foo) | |
1302 | @result{} 20 | |
1303 | ;; @r{Delete the overlay.} | |
1304 | (delete-overlay foo) | |
1305 | @result{} nil | |
1306 | ;; @r{Verify it is deleted.} | |
1307 | foo | |
1308 | @result{} #<overlay in no buffer> | |
1309 | ;; @r{A deleted overlay has no position.} | |
1310 | (overlay-start foo) | |
1311 | @result{} nil | |
1312 | (overlay-end foo) | |
1313 | @result{} nil | |
1314 | (overlay-buffer foo) | |
1315 | @result{} nil | |
1316 | ;; @r{Undelete the overlay.} | |
1317 | (move-overlay foo 1 20) | |
1318 | @result{} #<overlay from 1 to 20 in display.texi> | |
1319 | ;; @r{Verify the results.} | |
1320 | (overlay-start foo) | |
1321 | @result{} 1 | |
1322 | (overlay-end foo) | |
1323 | @result{} 20 | |
1324 | (overlay-buffer foo) | |
1325 | @result{} #<buffer display.texi> | |
1326 | ;; @r{Moving and deleting the overlay does not change its properties.} | |
1327 | (overlay-get foo 'happy) | |
1328 | @result{} t | |
1329 | @end example | |
1330 | ||
1331 | Emacs stores the overlays of each buffer in two lists, divided | |
1332 | around an arbitrary ``center position.'' One list extends backwards | |
1333 | through the buffer from that center position, and the other extends | |
1334 | forwards from that center position. The center position can be anywhere | |
1335 | in the buffer. | |
1336 | ||
1337 | @defun overlay-recenter pos | |
1338 | This function recenters the overlays of the current buffer around | |
1339 | position @var{pos}. That makes overlay lookup faster for positions | |
1340 | near @var{pos}, but slower for positions far away from @var{pos}. | |
1341 | @end defun | |
1342 | ||
1343 | A loop that scans the buffer forwards, creating overlays, can run | |
1344 | faster if you do @code{(overlay-recenter (point-max))} first. | |
1345 | ||
1346 | @node Overlay Properties | |
1347 | @subsection Overlay Properties | |
1348 | ||
1349 | Overlay properties are like text properties in that the properties that | |
1350 | alter how a character is displayed can come from either source. But in | |
1351 | most respects they are different. @xref{Text Properties}, for comparison. | |
1352 | ||
1353 | Text properties are considered a part of the text; overlays and | |
1354 | their properties are specifically considered not to be part of the | |
1355 | text. Thus, copying text between various buffers and strings | |
1356 | preserves text properties, but does not try to preserve overlays. | |
1357 | Changing a buffer's text properties marks the buffer as modified, | |
1358 | while moving an overlay or changing its properties does not. Unlike | |
1359 | text property changes, overlay property changes are not recorded in | |
1360 | the buffer's undo list. | |
1361 | ||
f7a7f4eb RS |
1362 | Since more than one overlay can specify a property value for the |
1363 | same character, Emacs lets you specify a priority value of each | |
1364 | overlay. You should not make assumptions about which overlay will | |
1365 | prevail when there is a conflict and they have the same priority. | |
1366 | ||
b8d4c8d0 GM |
1367 | These functions read and set the properties of an overlay: |
1368 | ||
1369 | @defun overlay-get overlay prop | |
1370 | This function returns the value of property @var{prop} recorded in | |
1371 | @var{overlay}, if any. If @var{overlay} does not record any value for | |
1372 | that property, but it does have a @code{category} property which is a | |
1373 | symbol, that symbol's @var{prop} property is used. Otherwise, the value | |
1374 | is @code{nil}. | |
1375 | @end defun | |
1376 | ||
1377 | @defun overlay-put overlay prop value | |
1378 | This function sets the value of property @var{prop} recorded in | |
1379 | @var{overlay} to @var{value}. It returns @var{value}. | |
1380 | @end defun | |
1381 | ||
1382 | @defun overlay-properties overlay | |
1383 | This returns a copy of the property list of @var{overlay}. | |
1384 | @end defun | |
1385 | ||
1386 | See also the function @code{get-char-property} which checks both | |
1387 | overlay properties and text properties for a given character. | |
1388 | @xref{Examining Properties}. | |
1389 | ||
1390 | Many overlay properties have special meanings; here is a table | |
1391 | of them: | |
1392 | ||
1393 | @table @code | |
1394 | @item priority | |
1395 | @kindex priority @r{(overlay property)} | |
1396 | This property's value (which should be a nonnegative integer number) | |
f7a7f4eb RS |
1397 | determines the priority of the overlay. No priority, or @code{nil}, |
1398 | means zero. | |
1399 | ||
1400 | The priority matters when two or more overlays cover the same | |
1401 | character and both specify the same property; the one whose | |
1402 | @code{priority} value is larger overrides the other. For the | |
1403 | @code{face} property, the higher priority overlay's value does not | |
1404 | completely override the other value; instead, its face attributes | |
1405 | override the face attributes of the lower priority @code{face} | |
1406 | property. | |
b8d4c8d0 GM |
1407 | |
1408 | Currently, all overlays take priority over text properties. Please | |
1409 | avoid using negative priority values, as we have not yet decided just | |
1410 | what they should mean. | |
1411 | ||
1412 | @item window | |
1413 | @kindex window @r{(overlay property)} | |
1414 | If the @code{window} property is non-@code{nil}, then the overlay | |
1415 | applies only on that window. | |
1416 | ||
1417 | @item category | |
1418 | @kindex category @r{(overlay property)} | |
1419 | If an overlay has a @code{category} property, we call it the | |
1420 | @dfn{category} of the overlay. It should be a symbol. The properties | |
1421 | of the symbol serve as defaults for the properties of the overlay. | |
1422 | ||
1423 | @item face | |
1424 | @kindex face @r{(overlay property)} | |
1425 | This property controls the way text is displayed---for example, which | |
1426 | font and which colors. @xref{Faces}, for more information. | |
1427 | ||
1428 | In the simplest case, the value is a face name. It can also be a list; | |
1429 | then each element can be any of these possibilities: | |
1430 | ||
1431 | @itemize @bullet | |
1432 | @item | |
1433 | A face name (a symbol or string). | |
1434 | ||
1435 | @item | |
1436 | A property list of face attributes. This has the form (@var{keyword} | |
1437 | @var{value} @dots{}), where each @var{keyword} is a face attribute | |
1438 | name and @var{value} is a meaningful value for that attribute. With | |
1439 | this feature, you do not need to create a face each time you want to | |
1440 | specify a particular attribute for certain text. @xref{Face | |
1441 | Attributes}. | |
1442 | ||
1443 | @item | |
1444 | A cons cell, either of the form @code{(foreground-color . @var{color-name})} or | |
1445 | @code{(background-color . @var{color-name})}. These elements specify | |
1446 | just the foreground color or just the background color. | |
1447 | ||
1448 | @code{(foreground-color . @var{color-name})} has the same effect as | |
1449 | @code{(:foreground @var{color-name})}; likewise for the background. | |
1450 | @end itemize | |
1451 | ||
1452 | @item mouse-face | |
1453 | @kindex mouse-face @r{(overlay property)} | |
1454 | This property is used instead of @code{face} when the mouse is within | |
1455 | the range of the overlay. | |
1456 | ||
1457 | @item display | |
1458 | @kindex display @r{(overlay property)} | |
1459 | This property activates various features that change the | |
1460 | way text is displayed. For example, it can make text appear taller | |
1461 | or shorter, higher or lower, wider or narrower, or replaced with an image. | |
1462 | @xref{Display Property}. | |
1463 | ||
1464 | @item help-echo | |
1465 | @kindex help-echo @r{(overlay property)} | |
1466 | If an overlay has a @code{help-echo} property, then when you move the | |
1467 | mouse onto the text in the overlay, Emacs displays a help string in the | |
1468 | echo area, or in the tooltip window. For details see @ref{Text | |
1469 | help-echo}. | |
1470 | ||
1471 | @item modification-hooks | |
1472 | @kindex modification-hooks @r{(overlay property)} | |
1473 | This property's value is a list of functions to be called if any | |
1474 | character within the overlay is changed or if text is inserted strictly | |
1475 | within the overlay. | |
1476 | ||
1477 | The hook functions are called both before and after each change. | |
1478 | If the functions save the information they receive, and compare notes | |
1479 | between calls, they can determine exactly what change has been made | |
1480 | in the buffer text. | |
1481 | ||
1482 | When called before a change, each function receives four arguments: the | |
1483 | overlay, @code{nil}, and the beginning and end of the text range to be | |
1484 | modified. | |
1485 | ||
1486 | When called after a change, each function receives five arguments: the | |
1487 | overlay, @code{t}, the beginning and end of the text range just | |
1488 | modified, and the length of the pre-change text replaced by that range. | |
1489 | (For an insertion, the pre-change length is zero; for a deletion, that | |
1490 | length is the number of characters deleted, and the post-change | |
1491 | beginning and end are equal.) | |
1492 | ||
1493 | If these functions modify the buffer, they should bind | |
1494 | @code{inhibit-modification-hooks} to @code{t} around doing so, to | |
1495 | avoid confusing the internal mechanism that calls these hooks. | |
1496 | ||
1497 | Text properties also support the @code{modification-hooks} property, | |
1498 | but the details are somewhat different (@pxref{Special Properties}). | |
1499 | ||
1500 | @item insert-in-front-hooks | |
1501 | @kindex insert-in-front-hooks @r{(overlay property)} | |
1502 | This property's value is a list of functions to be called before and | |
1503 | after inserting text right at the beginning of the overlay. The calling | |
1504 | conventions are the same as for the @code{modification-hooks} functions. | |
1505 | ||
1506 | @item insert-behind-hooks | |
1507 | @kindex insert-behind-hooks @r{(overlay property)} | |
1508 | This property's value is a list of functions to be called before and | |
1509 | after inserting text right at the end of the overlay. The calling | |
1510 | conventions are the same as for the @code{modification-hooks} functions. | |
1511 | ||
1512 | @item invisible | |
1513 | @kindex invisible @r{(overlay property)} | |
1514 | The @code{invisible} property can make the text in the overlay | |
1515 | invisible, which means that it does not appear on the screen. | |
1516 | @xref{Invisible Text}, for details. | |
1517 | ||
1518 | @item intangible | |
1519 | @kindex intangible @r{(overlay property)} | |
1520 | The @code{intangible} property on an overlay works just like the | |
1521 | @code{intangible} text property. @xref{Special Properties}, for details. | |
1522 | ||
1523 | @item isearch-open-invisible | |
1524 | This property tells incremental search how to make an invisible overlay | |
1525 | visible, permanently, if the final match overlaps it. @xref{Invisible | |
1526 | Text}. | |
1527 | ||
1528 | @item isearch-open-invisible-temporary | |
1529 | This property tells incremental search how to make an invisible overlay | |
1530 | visible, temporarily, during the search. @xref{Invisible Text}. | |
1531 | ||
1532 | @item before-string | |
1533 | @kindex before-string @r{(overlay property)} | |
1534 | This property's value is a string to add to the display at the beginning | |
1535 | of the overlay. The string does not appear in the buffer in any | |
1536 | sense---only on the screen. | |
1537 | ||
1538 | @item after-string | |
1539 | @kindex after-string @r{(overlay property)} | |
1540 | This property's value is a string to add to the display at the end of | |
1541 | the overlay. The string does not appear in the buffer in any | |
1542 | sense---only on the screen. | |
1543 | ||
0c1cfe01 CY |
1544 | @item line-prefix |
1545 | This property specifies a display spec to prepend to each | |
1546 | non-continuation line at display-time. @xref{Truncation}. | |
1547 | ||
1548 | @itemx wrap-prefix | |
1549 | This property specifies a display spec to prepend to each continuation | |
1550 | line at display-time. @xref{Truncation}. | |
1551 | ||
b8d4c8d0 GM |
1552 | @item evaporate |
1553 | @kindex evaporate @r{(overlay property)} | |
1554 | If this property is non-@code{nil}, the overlay is deleted automatically | |
1555 | if it becomes empty (i.e., if its length becomes zero). If you give | |
1556 | an empty overlay a non-@code{nil} @code{evaporate} property, that deletes | |
1557 | it immediately. | |
1558 | ||
1559 | @item local-map | |
1560 | @cindex keymap of character (and overlays) | |
1561 | @kindex local-map @r{(overlay property)} | |
1562 | If this property is non-@code{nil}, it specifies a keymap for a portion | |
1563 | of the text. The property's value replaces the buffer's local map, when | |
1564 | the character after point is within the overlay. @xref{Active Keymaps}. | |
1565 | ||
1566 | @item keymap | |
1567 | @kindex keymap @r{(overlay property)} | |
1568 | The @code{keymap} property is similar to @code{local-map} but overrides the | |
1569 | buffer's local map (and the map specified by the @code{local-map} | |
1570 | property) rather than replacing it. | |
1571 | @end table | |
1572 | ||
32c94598 CY |
1573 | The @code{local-map} and @code{keymap} properties do not affect a |
1574 | string displayed by the @code{before-string}, @code{after-string}, or | |
1575 | @code{display} properties. This is only relevant for mouse clicks and | |
1576 | other mouse events that fall on the string, since point is never on | |
1577 | the string. To bind special mouse events for the string, assign it a | |
1578 | @code{local-map} or @code{keymap} text property. @xref{Special | |
1579 | Properties}. | |
1580 | ||
b8d4c8d0 GM |
1581 | @node Finding Overlays |
1582 | @subsection Searching for Overlays | |
1583 | ||
1584 | @defun overlays-at pos | |
1585 | This function returns a list of all the overlays that cover the | |
1586 | character at position @var{pos} in the current buffer. The list is in | |
1587 | no particular order. An overlay contains position @var{pos} if it | |
1588 | begins at or before @var{pos}, and ends after @var{pos}. | |
1589 | ||
1590 | To illustrate usage, here is a Lisp function that returns a list of the | |
1591 | overlays that specify property @var{prop} for the character at point: | |
1592 | ||
1593 | @smallexample | |
1594 | (defun find-overlays-specifying (prop) | |
1595 | (let ((overlays (overlays-at (point))) | |
1596 | found) | |
1597 | (while overlays | |
1598 | (let ((overlay (car overlays))) | |
1599 | (if (overlay-get overlay prop) | |
1600 | (setq found (cons overlay found)))) | |
1601 | (setq overlays (cdr overlays))) | |
1602 | found)) | |
1603 | @end smallexample | |
1604 | @end defun | |
1605 | ||
1606 | @defun overlays-in beg end | |
1607 | This function returns a list of the overlays that overlap the region | |
1608 | @var{beg} through @var{end}. ``Overlap'' means that at least one | |
1609 | character is contained within the overlay and also contained within the | |
1610 | specified region; however, empty overlays are included in the result if | |
c70a68db MR |
1611 | they are located at @var{beg}, strictly between @var{beg} and @var{end}, |
1612 | or at @var{end} when @var{end} denotes the position at the end of the | |
1613 | buffer. | |
b8d4c8d0 GM |
1614 | @end defun |
1615 | ||
1616 | @defun next-overlay-change pos | |
1617 | This function returns the buffer position of the next beginning or end | |
1618 | of an overlay, after @var{pos}. If there is none, it returns | |
1619 | @code{(point-max)}. | |
1620 | @end defun | |
1621 | ||
1622 | @defun previous-overlay-change pos | |
1623 | This function returns the buffer position of the previous beginning or | |
1624 | end of an overlay, before @var{pos}. If there is none, it returns | |
1625 | @code{(point-min)}. | |
1626 | @end defun | |
1627 | ||
1628 | As an example, here's a simplified (and inefficient) version of the | |
1629 | primitive function @code{next-single-char-property-change} | |
1630 | (@pxref{Property Search}). It searches forward from position | |
1631 | @var{pos} for the next position where the value of a given property | |
1632 | @code{prop}, as obtained from either overlays or text properties, | |
1633 | changes. | |
1634 | ||
1635 | @smallexample | |
1636 | (defun next-single-char-property-change (position prop) | |
1637 | (save-excursion | |
1638 | (goto-char position) | |
1639 | (let ((propval (get-char-property (point) prop))) | |
1640 | (while (and (not (eobp)) | |
1641 | (eq (get-char-property (point) prop) propval)) | |
1642 | (goto-char (min (next-overlay-change (point)) | |
1643 | (next-single-property-change (point) prop))))) | |
1644 | (point))) | |
1645 | @end smallexample | |
1646 | ||
1647 | @node Width | |
1648 | @section Width | |
1649 | ||
1650 | Since not all characters have the same width, these functions let you | |
1651 | check the width of a character. @xref{Primitive Indent}, and | |
1652 | @ref{Screen Lines}, for related functions. | |
1653 | ||
1654 | @defun char-width char | |
1655 | This function returns the width in columns of the character @var{char}, | |
1656 | if it were displayed in the current buffer and the selected window. | |
1657 | @end defun | |
1658 | ||
1659 | @defun string-width string | |
1660 | This function returns the width in columns of the string @var{string}, | |
1661 | if it were displayed in the current buffer and the selected window. | |
1662 | @end defun | |
1663 | ||
1664 | @defun truncate-string-to-width string width &optional start-column padding ellipsis | |
1665 | This function returns the part of @var{string} that fits within | |
1666 | @var{width} columns, as a new string. | |
1667 | ||
1668 | If @var{string} does not reach @var{width}, then the result ends where | |
1669 | @var{string} ends. If one multi-column character in @var{string} | |
1670 | extends across the column @var{width}, that character is not included in | |
1671 | the result. Thus, the result can fall short of @var{width} but cannot | |
1672 | go beyond it. | |
1673 | ||
1674 | The optional argument @var{start-column} specifies the starting column. | |
1675 | If this is non-@code{nil}, then the first @var{start-column} columns of | |
1676 | the string are omitted from the value. If one multi-column character in | |
1677 | @var{string} extends across the column @var{start-column}, that | |
1678 | character is not included. | |
1679 | ||
1680 | The optional argument @var{padding}, if non-@code{nil}, is a padding | |
1681 | character added at the beginning and end of the result string, to extend | |
1682 | it to exactly @var{width} columns. The padding character is used at the | |
1683 | end of the result if it falls short of @var{width}. It is also used at | |
1684 | the beginning of the result if one multi-column character in | |
1685 | @var{string} extends across the column @var{start-column}. | |
1686 | ||
1687 | If @var{ellipsis} is non-@code{nil}, it should be a string which will | |
1688 | replace the end of @var{str} (including any padding) if it extends | |
1689 | beyond @var{end-column}, unless the display width of @var{str} is | |
1690 | equal to or less than the display width of @var{ellipsis}. If | |
1691 | @var{ellipsis} is non-@code{nil} and not a string, it stands for | |
1692 | @code{"..."}. | |
1693 | ||
1694 | @example | |
1695 | (truncate-string-to-width "\tab\t" 12 4) | |
1696 | @result{} "ab" | |
1697 | (truncate-string-to-width "\tab\t" 12 4 ?\s) | |
1698 | @result{} " ab " | |
1699 | @end example | |
1700 | @end defun | |
1701 | ||
1702 | @node Line Height | |
1703 | @section Line Height | |
1704 | @cindex line height | |
1705 | ||
1706 | The total height of each display line consists of the height of the | |
1707 | contents of the line, plus optional additional vertical line spacing | |
1708 | above or below the display line. | |
1709 | ||
1710 | The height of the line contents is the maximum height of any | |
1711 | character or image on that display line, including the final newline | |
1712 | if there is one. (A display line that is continued doesn't include a | |
1713 | final newline.) That is the default line height, if you do nothing to | |
1714 | specify a greater height. (In the most common case, this equals the | |
1715 | height of the default frame font.) | |
1716 | ||
1717 | There are several ways to explicitly specify a larger line height, | |
1718 | either by specifying an absolute height for the display line, or by | |
1719 | specifying vertical space. However, no matter what you specify, the | |
1720 | actual line height can never be less than the default. | |
1721 | ||
1722 | @kindex line-height @r{(text property)} | |
1723 | A newline can have a @code{line-height} text or overlay property | |
1724 | that controls the total height of the display line ending in that | |
1725 | newline. | |
1726 | ||
1727 | If the property value is @code{t}, the newline character has no | |
1728 | effect on the displayed height of the line---the visible contents | |
1729 | alone determine the height. This is useful for tiling small images | |
1730 | (or image slices) without adding blank areas between the images. | |
1731 | ||
1732 | If the property value is a list of the form @code{(@var{height} | |
1733 | @var{total})}, that adds extra space @emph{below} the display line. | |
1734 | First Emacs uses @var{height} as a height spec to control extra space | |
1735 | @emph{above} the line; then it adds enough space @emph{below} the line | |
1736 | to bring the total line height up to @var{total}. In this case, the | |
1737 | other ways to specify the line spacing are ignored. | |
1738 | ||
1739 | Any other kind of property value is a height spec, which translates | |
1740 | into a number---the specified line height. There are several ways to | |
1741 | write a height spec; here's how each of them translates into a number: | |
1742 | ||
1743 | @table @code | |
1744 | @item @var{integer} | |
1745 | If the height spec is a positive integer, the height value is that integer. | |
1746 | @item @var{float} | |
1747 | If the height spec is a float, @var{float}, the numeric height value | |
1748 | is @var{float} times the frame's default line height. | |
1749 | @item (@var{face} . @var{ratio}) | |
1750 | If the height spec is a cons of the format shown, the numeric height | |
1751 | is @var{ratio} times the height of face @var{face}. @var{ratio} can | |
1752 | be any type of number, or @code{nil} which means a ratio of 1. | |
1753 | If @var{face} is @code{t}, it refers to the current face. | |
1754 | @item (nil . @var{ratio}) | |
1755 | If the height spec is a cons of the format shown, the numeric height | |
1756 | is @var{ratio} times the height of the contents of the line. | |
1757 | @end table | |
1758 | ||
1759 | Thus, any valid height spec determines the height in pixels, one way | |
1760 | or another. If the line contents' height is less than that, Emacs | |
1761 | adds extra vertical space above the line to achieve the specified | |
1762 | total height. | |
1763 | ||
1764 | If you don't specify the @code{line-height} property, the line's | |
1765 | height consists of the contents' height plus the line spacing. | |
1766 | There are several ways to specify the line spacing for different | |
1767 | parts of Emacs text. | |
1768 | ||
ed8ab760 CY |
1769 | On graphical terminals, you can specify the line spacing for all |
1770 | lines in a frame, using the @code{line-spacing} frame parameter | |
4e3b4528 SM |
1771 | (@pxref{Layout Parameters}). However, if the default value of |
1772 | @code{line-spacing} is non-@code{nil}, it overrides the | |
ed8ab760 CY |
1773 | frame's @code{line-spacing} parameter. An integer value specifies the |
1774 | number of pixels put below lines. A floating point number specifies | |
1775 | the spacing relative to the frame's default line height. | |
b8d4c8d0 GM |
1776 | |
1777 | @vindex line-spacing | |
1778 | You can specify the line spacing for all lines in a buffer via the | |
1779 | buffer-local @code{line-spacing} variable. An integer value specifies | |
ed8ab760 CY |
1780 | the number of pixels put below lines. A floating point number |
1781 | specifies the spacing relative to the default frame line height. This | |
1782 | overrides line spacings specified for the frame. | |
b8d4c8d0 GM |
1783 | |
1784 | @kindex line-spacing @r{(text property)} | |
1785 | Finally, a newline can have a @code{line-spacing} text or overlay | |
1786 | property that overrides the default frame line spacing and the buffer | |
1787 | local @code{line-spacing} variable, for the display line ending in | |
1788 | that newline. | |
1789 | ||
1790 | One way or another, these mechanisms specify a Lisp value for the | |
1791 | spacing of each line. The value is a height spec, and it translates | |
1792 | into a Lisp value as described above. However, in this case the | |
1793 | numeric height value specifies the line spacing, rather than the line | |
1794 | height. | |
1795 | ||
ed8ab760 CY |
1796 | On text-only terminals, the line spacing cannot be altered. |
1797 | ||
b8d4c8d0 GM |
1798 | @node Faces |
1799 | @section Faces | |
1800 | @cindex faces | |
1801 | ||
42a2a154 CY |
1802 | A @dfn{face} is a collection of graphical attributes for displaying |
1803 | text: font family, foreground color, background color, optional | |
1804 | underlining, and so on. Faces control how buffer text is displayed, | |
1805 | and how some parts of the frame, such as the mode-line, are displayed. | |
1806 | @xref{Standard Faces,,, emacs, The GNU Emacs Manual}, for the list of | |
1807 | faces Emacs normally comes with. | |
b8d4c8d0 GM |
1808 | |
1809 | @cindex face id | |
42a2a154 CY |
1810 | For most purposes, you refer to a face in Lisp programs using its |
1811 | @dfn{face name}. This is either a string or (equivalently) a Lisp | |
1812 | symbol whose name is equal to that string. | |
b8d4c8d0 GM |
1813 | |
1814 | @defun facep object | |
42a2a154 CY |
1815 | This function returns a non-@code{nil} value if @var{object} is a Lisp |
1816 | symbol or string that names a face. Otherwise, it returns @code{nil}. | |
b8d4c8d0 GM |
1817 | @end defun |
1818 | ||
42a2a154 CY |
1819 | Each face name is meaningful for all frames, and by default it has |
1820 | the same meaning in all frames. But you can arrange to give a | |
1821 | particular face name a special meaning in one frame if you wish. | |
b8d4c8d0 GM |
1822 | |
1823 | @menu | |
1824 | * Defining Faces:: How to define a face with @code{defface}. | |
1825 | * Face Attributes:: What is in a face? | |
1826 | * Attribute Functions:: Functions to examine and set face attributes. | |
1827 | * Displaying Faces:: How Emacs combines the faces specified for a character. | |
d466a866 | 1828 | * Face Remapping:: Remapping faces to alternative definitions. |
b8d4c8d0 GM |
1829 | * Face Functions:: How to define and examine faces. |
1830 | * Auto Faces:: Hook for automatic face assignment. | |
9185bf49 | 1831 | * Font Selection:: Finding the best available font for a face. |
b8d4c8d0 GM |
1832 | * Font Lookup:: Looking up the names of available fonts |
1833 | and information about them. | |
1834 | * Fontsets:: A fontset is a collection of fonts | |
1835 | that handle a range of character sets. | |
c2aa555a | 1836 | * Low-Level Font:: Lisp representation for character display fonts. |
b8d4c8d0 GM |
1837 | @end menu |
1838 | ||
1839 | @node Defining Faces | |
1840 | @subsection Defining Faces | |
1841 | ||
1842 | The way to define a new face is with @code{defface}. This creates a | |
1843 | kind of customization item (@pxref{Customization}) which the user can | |
1844 | customize using the Customization buffer (@pxref{Easy Customization,,, | |
1845 | emacs, The GNU Emacs Manual}). | |
1846 | ||
15688fce GM |
1847 | People are sometimes tempted to create variables whose values specify |
1848 | which faces to use (for example, Font-Lock does this). In the vast | |
1849 | majority of cases, this is not necessary, and simply using faces | |
1850 | directly is preferable. | |
1851 | ||
b8d4c8d0 | 1852 | @defmac defface face spec doc [keyword value]@dots{} |
42a2a154 CY |
1853 | This declares @var{face} as a customizable face whose default |
1854 | attributes are given by @var{spec}. You should not quote the symbol | |
1855 | @var{face}, and it should not end in @samp{-face} (that would be | |
1856 | redundant). The argument @var{doc} specifies the face documentation. | |
1857 | The keywords you can use in @code{defface} are the same as in | |
1858 | @code{defgroup} and @code{defcustom} (@pxref{Common Keywords}). | |
b8d4c8d0 GM |
1859 | |
1860 | When @code{defface} executes, it defines the face according to | |
1861 | @var{spec}, then uses any customizations that were read from the | |
1862 | init file (@pxref{Init File}) to override that specification. | |
1863 | ||
1864 | When you evaluate a @code{defface} form with @kbd{C-M-x} in Emacs | |
1865 | Lisp mode (@code{eval-defun}), a special feature of @code{eval-defun} | |
1866 | overrides any customizations of the face. This way, the face reflects | |
1867 | exactly what the @code{defface} says. | |
1868 | ||
1869 | The purpose of @var{spec} is to specify how the face should appear on | |
1870 | different kinds of terminals. It should be an alist whose elements | |
1871 | have the form @code{(@var{display} @var{atts})}. Each element's | |
1872 | @sc{car}, @var{display}, specifies a class of terminals. (The first | |
1873 | element, if its @sc{car} is @code{default}, is special---it specifies | |
1874 | defaults for the remaining elements). The element's @sc{cadr}, | |
1875 | @var{atts}, is a list of face attributes and their values; it | |
1876 | specifies what the face should look like on that kind of terminal. | |
1877 | The possible attributes are defined in the value of | |
1878 | @code{custom-face-attributes}. | |
1879 | ||
1880 | The @var{display} part of an element of @var{spec} determines which | |
1881 | frames the element matches. If more than one element of @var{spec} | |
1882 | matches a given frame, the first element that matches is the one used | |
1883 | for that frame. There are three possibilities for @var{display}: | |
1884 | ||
1885 | @table @asis | |
1886 | @item @code{default} | |
1887 | This element of @var{spec} doesn't match any frames; instead, it | |
1888 | specifies defaults that apply to all frames. This kind of element, if | |
1889 | used, must be the first element of @var{spec}. Each of the following | |
1890 | elements can override any or all of these defaults. | |
1891 | ||
1892 | @item @code{t} | |
1893 | This element of @var{spec} matches all frames. Therefore, any | |
1894 | subsequent elements of @var{spec} are never used. Normally | |
1895 | @code{t} is used in the last (or only) element of @var{spec}. | |
1896 | ||
1897 | @item a list | |
1898 | If @var{display} is a list, each element should have the form | |
1899 | @code{(@var{characteristic} @var{value}@dots{})}. Here | |
1900 | @var{characteristic} specifies a way of classifying frames, and the | |
1901 | @var{value}s are possible classifications which @var{display} should | |
1902 | apply to. Here are the possible values of @var{characteristic}: | |
1903 | ||
1904 | @table @code | |
1905 | @item type | |
1906 | The kind of window system the frame uses---either @code{graphic} (any | |
1907 | graphics-capable display), @code{x}, @code{pc} (for the MS-DOS console), | |
9e2a2647 DN |
1908 | @code{w32} (for MS Windows 9X/NT/2K/XP), or @code{tty} |
1909 | (a non-graphics-capable display). | |
b8d4c8d0 GM |
1910 | @xref{Window Systems, window-system}. |
1911 | ||
1912 | @item class | |
1913 | What kinds of colors the frame supports---either @code{color}, | |
1914 | @code{grayscale}, or @code{mono}. | |
1915 | ||
1916 | @item background | |
1917 | The kind of background---either @code{light} or @code{dark}. | |
1918 | ||
1919 | @item min-colors | |
1920 | An integer that represents the minimum number of colors the frame | |
1921 | should support. This matches a frame if its | |
1922 | @code{display-color-cells} value is at least the specified integer. | |
1923 | ||
1924 | @item supports | |
1925 | Whether or not the frame can display the face attributes given in | |
42a2a154 CY |
1926 | @var{value}@dots{} (@pxref{Face Attributes}). @xref{Display Face |
1927 | Attribute Testing}, for more information on exactly how this testing | |
1928 | is done. | |
b8d4c8d0 GM |
1929 | @end table |
1930 | ||
1931 | If an element of @var{display} specifies more than one @var{value} for a | |
1932 | given @var{characteristic}, any of those values is acceptable. If | |
1933 | @var{display} has more than one element, each element should specify a | |
1934 | different @var{characteristic}; then @emph{each} characteristic of the | |
1935 | frame must match one of the @var{value}s specified for it in | |
1936 | @var{display}. | |
1937 | @end table | |
1938 | @end defmac | |
1939 | ||
1940 | Here's how the standard face @code{region} is defined: | |
1941 | ||
1942 | @example | |
1943 | @group | |
1944 | (defface region | |
1945 | '((((class color) (min-colors 88) (background dark)) | |
1946 | :background "blue3") | |
1947 | @end group | |
1948 | (((class color) (min-colors 88) (background light)) | |
1949 | :background "lightgoldenrod2") | |
1950 | (((class color) (min-colors 16) (background dark)) | |
1951 | :background "blue3") | |
1952 | (((class color) (min-colors 16) (background light)) | |
1953 | :background "lightgoldenrod2") | |
1954 | (((class color) (min-colors 8)) | |
1955 | :background "blue" :foreground "white") | |
1956 | (((type tty) (class mono)) | |
1957 | :inverse-video t) | |
1958 | (t :background "gray")) | |
1959 | @group | |
1960 | "Basic face for highlighting the region." | |
1961 | :group 'basic-faces) | |
1962 | @end group | |
1963 | @end example | |
1964 | ||
1965 | Internally, @code{defface} uses the symbol property | |
42a2a154 CY |
1966 | @code{face-defface-spec} to record the specified face attributes. The |
1967 | attributes saved by the user with the customization buffer are | |
1968 | recorded in the symbol property @code{saved-face}; the attributes | |
1969 | customized by the user for the current session, but not saved, are | |
1970 | recorded in the symbol property @code{customized-face}. The | |
1971 | documentation string is recorded in the symbol property | |
1972 | @code{face-documentation}. | |
b8d4c8d0 GM |
1973 | |
1974 | @defopt frame-background-mode | |
1975 | This option, if non-@code{nil}, specifies the background type to use for | |
1976 | interpreting face definitions. If it is @code{dark}, then Emacs treats | |
1977 | all frames as if they had a dark background, regardless of their actual | |
1978 | background colors. If it is @code{light}, then Emacs treats all frames | |
1979 | as if they had a light background. | |
1980 | @end defopt | |
1981 | ||
1982 | @node Face Attributes | |
1983 | @subsection Face Attributes | |
1984 | @cindex face attributes | |
1985 | ||
1986 | The effect of using a face is determined by a fixed set of @dfn{face | |
42a2a154 CY |
1987 | attributes}. This table lists all the face attributes, their possible |
1988 | values, and their effects. You can specify more than one face for a | |
1989 | given piece of text; Emacs merges the attributes of all the faces to | |
1990 | determine how to display the text. @xref{Displaying Faces}. | |
1991 | ||
1992 | In addition to the values given below, each face attribute can also | |
1993 | have the value @code{unspecified}. This special value means the face | |
1994 | doesn't specify that attribute. In face merging, when the first face | |
1995 | fails to specify a particular attribute, the next face gets a chance. | |
1996 | However, the @code{default} face must specify all attributes. | |
1997 | ||
1998 | Some of these font attributes are meaningful only on certain kinds | |
1999 | of displays. If your display cannot handle a certain attribute, the | |
2000 | attribute is ignored. | |
b8d4c8d0 GM |
2001 | |
2002 | @table @code | |
2003 | @item :family | |
9185bf49 CY |
2004 | Font family name or fontset name (a string). If you specify a font |
2005 | family name, the wild-card characters @samp{*} and @samp{?} are | |
2006 | allowed. The function @code{font-family-list}, described below, | |
2007 | returns a list of available family names. @xref{Fontsets}, for | |
2008 | information about fontsets. | |
42a2a154 CY |
2009 | |
2010 | @item :foundry | |
9185bf49 CY |
2011 | The name of the @dfn{font foundry} in which the font family specified |
2012 | by the @code{:family} attribute is located (a string). The wild-card | |
2013 | characters @samp{*} and @samp{?} are allowed. | |
b8d4c8d0 GM |
2014 | |
2015 | @item :width | |
42a2a154 | 2016 | Relative proportionate character width, also known as the character |
b8d4c8d0 GM |
2017 | set width. This should be one of the symbols @code{ultra-condensed}, |
2018 | @code{extra-condensed}, @code{condensed}, @code{semi-condensed}, | |
2019 | @code{normal}, @code{semi-expanded}, @code{expanded}, | |
2020 | @code{extra-expanded}, or @code{ultra-expanded}. | |
2021 | ||
2022 | @item :height | |
23696fd7 CY |
2023 | The height of the font. In the simplest case, this is an integer in |
2024 | units of 1/10 point. | |
2025 | ||
2026 | The value can also be a floating point number or a function, which | |
2027 | specifies the height relative to an @dfn{underlying face} (i.e., a | |
2028 | face that has a lower priority in the list described in | |
2029 | @ref{Displaying Faces}). If the value is a floating point number, | |
2030 | that specifies the amount by which to scale the height of the | |
2031 | underlying face. If the value is a function, that function is called | |
2032 | with one argument, the height of the underlying face, and returns the | |
2033 | height of the new face. If the function is passed an integer | |
2034 | argument, it must return an integer. | |
42a2a154 CY |
2035 | |
2036 | The height of the default face must be specified using an integer; | |
2037 | floating point and function values are not allowed. | |
b8d4c8d0 GM |
2038 | |
2039 | @item :weight | |
42a2a154 | 2040 | Font weight---one of the symbols (from densest to faintest) |
b8d4c8d0 | 2041 | @code{ultra-bold}, @code{extra-bold}, @code{bold}, @code{semi-bold}, |
42a2a154 CY |
2042 | @code{normal}, @code{semi-light}, @code{light}, @code{extra-light}, or |
2043 | @code{ultra-light}. On text-only terminals that support | |
2044 | variable-brightness text, any weight greater than normal is displayed | |
2045 | as extra bright, and any weight less than normal is displayed as | |
2046 | half-bright. | |
b8d4c8d0 GM |
2047 | |
2048 | @item :slant | |
42a2a154 CY |
2049 | Font slant---one of the symbols @code{italic}, @code{oblique}, |
2050 | @code{normal}, @code{reverse-italic}, or @code{reverse-oblique}. On | |
2051 | text-only terminals that support variable-brightness text, slanted | |
2052 | text is displayed as half-bright. | |
b8d4c8d0 GM |
2053 | |
2054 | @item :foreground | |
2055 | Foreground color, a string. The value can be a system-defined color | |
42a2a154 CY |
2056 | name, or a hexadecimal color specification. @xref{Color Names}. On |
2057 | black-and-white displays, certain shades of gray are implemented by | |
2058 | stipple patterns. | |
b8d4c8d0 GM |
2059 | |
2060 | @item :background | |
42a2a154 CY |
2061 | Background color, a string. The value can be a system-defined color |
2062 | name, or a hexadecimal color specification. @xref{Color Names}. | |
b8d4c8d0 GM |
2063 | |
2064 | @item :underline | |
2065 | Whether or not characters should be underlined, and in what color. If | |
2066 | the value is @code{t}, underlining uses the foreground color of the | |
2067 | face. If the value is a string, underlining uses that color. The | |
2068 | value @code{nil} means do not underline. | |
2069 | ||
2070 | @item :overline | |
2071 | Whether or not characters should be overlined, and in what color. | |
2072 | The value is used like that of @code{:underline}. | |
2073 | ||
2074 | @item :strike-through | |
2075 | Whether or not characters should be strike-through, and in what | |
2076 | color. The value is used like that of @code{:underline}. | |
2077 | ||
b8d4c8d0 GM |
2078 | @item :box |
2079 | Whether or not a box should be drawn around characters, its color, the | |
42a2a154 CY |
2080 | width of the box lines, and 3D appearance. Here are the possible |
2081 | values of the @code{:box} attribute, and what they mean: | |
b8d4c8d0 GM |
2082 | |
2083 | @table @asis | |
2084 | @item @code{nil} | |
2085 | Don't draw a box. | |
2086 | ||
2087 | @item @code{t} | |
2088 | Draw a box with lines of width 1, in the foreground color. | |
2089 | ||
2090 | @item @var{color} | |
2091 | Draw a box with lines of width 1, in color @var{color}. | |
2092 | ||
2093 | @item @code{(:line-width @var{width} :color @var{color} :style @var{style})} | |
2094 | This way you can explicitly specify all aspects of the box. The value | |
2095 | @var{width} specifies the width of the lines to draw; it defaults to 1. | |
2096 | ||
2097 | The value @var{color} specifies the color to draw with. The default is | |
2098 | the foreground color of the face for simple boxes, and the background | |
2099 | color of the face for 3D boxes. | |
2100 | ||
2101 | The value @var{style} specifies whether to draw a 3D box. If it is | |
2102 | @code{released-button}, the box looks like a 3D button that is not being | |
2103 | pressed. If it is @code{pressed-button}, the box looks like a 3D button | |
2104 | that is being pressed. If it is @code{nil} or omitted, a plain 2D box | |
2105 | is used. | |
2106 | @end table | |
2107 | ||
42a2a154 CY |
2108 | @item :inverse-video |
2109 | Whether or not characters should be displayed in inverse video. The | |
2110 | value should be @code{t} (yes) or @code{nil} (no). | |
b8d4c8d0 | 2111 | |
42a2a154 CY |
2112 | @item :stipple |
2113 | The background stipple, a bitmap. | |
b8d4c8d0 | 2114 | |
42a2a154 CY |
2115 | The value can be a string; that should be the name of a file containing |
2116 | external-format X bitmap data. The file is found in the directories | |
2117 | listed in the variable @code{x-bitmap-file-path}. | |
b8d4c8d0 | 2118 | |
42a2a154 CY |
2119 | Alternatively, the value can specify the bitmap directly, with a list |
2120 | of the form @code{(@var{width} @var{height} @var{data})}. Here, | |
2121 | @var{width} and @var{height} specify the size in pixels, and | |
2122 | @var{data} is a string containing the raw bits of the bitmap, row by | |
2123 | row. Each row occupies @math{(@var{width} + 7) / 8} consecutive bytes | |
2124 | in the string (which should be a unibyte string for best results). | |
2125 | This means that each row always occupies at least one whole byte. | |
b8d4c8d0 | 2126 | |
42a2a154 | 2127 | If the value is @code{nil}, that means use no stipple pattern. |
b8d4c8d0 | 2128 | |
42a2a154 CY |
2129 | Normally you do not need to set the stipple attribute, because it is |
2130 | used automatically to handle certain shades of gray. | |
b8d4c8d0 | 2131 | |
42a2a154 | 2132 | @item :font |
9185bf49 CY |
2133 | The font used to display the face. Its value should be a font object. |
2134 | @xref{Font Selection}, for information about font objects. | |
42a2a154 CY |
2135 | |
2136 | When specifying this attribute using @code{set-face-attribute} | |
9185bf49 | 2137 | (@pxref{Attribute Functions}), you may also supply a font spec, a font |
42a2a154 | 2138 | entity, or a string. Emacs converts such values to an appropriate |
9185bf49 CY |
2139 | font object, and stores that font object as the actual attribute |
2140 | value. If you specify a string, the contents of the string should be | |
2141 | a font name (@pxref{Font X,, Font Specification Options, emacs, The | |
2142 | GNU Emacs Manual}); if the font name is an XLFD containing wildcards, | |
2143 | Emacs chooses the first font matching those wildcards. Specifying | |
2144 | this attribute also changes the values of the @code{:family}, | |
2145 | @code{:foundry}, @code{:width}, @code{:height}, @code{:weight}, and | |
2146 | @code{:slant} attributes. | |
b8d4c8d0 | 2147 | |
42a2a154 CY |
2148 | @item :inherit |
2149 | The name of a face from which to inherit attributes, or a list of face | |
2150 | names. Attributes from inherited faces are merged into the face like | |
2151 | an underlying face would be, with higher priority than underlying | |
23696fd7 CY |
2152 | faces (@pxref{Displaying Faces}). If a list of faces is used, |
2153 | attributes from faces earlier in the list override those from later | |
2154 | faces. | |
b8d4c8d0 GM |
2155 | @end table |
2156 | ||
42a2a154 CY |
2157 | For compatibility with Emacs 20, you can also specify values for two |
2158 | ``fake'' face attributes: @code{:bold} and @code{:italic}. Their | |
2159 | values must be either @code{t} or @code{nil}; a value of | |
2160 | @code{unspecified} is not allowed. Setting @code{:bold} to @code{t} | |
2161 | is equivalent to setting the @code{:weight} attribute to @code{bold}, | |
2162 | and setting it to @code{nil} is equivalent to setting @code{:weight} | |
2163 | to @code{normal}. Setting @code{:italic} to @code{t} is equivalent to | |
2164 | setting the @code{:slant} attribute to @code{italic}, and setting it | |
2165 | to @code{nil} is equivalent to setting @code{:slant} to @code{normal}. | |
2166 | ||
9185bf49 CY |
2167 | @defun font-family-list &optional frame |
2168 | This function returns a list of available font family names. The | |
2169 | optional argument @var{frame} specifies the frame on which the text is | |
2170 | to be displayed; if it is @code{nil}, the selected frame is used. | |
2171 | @end defun | |
2172 | ||
01f17ae2 | 2173 | @defopt underline-minimum-offset |
0c1cfe01 CY |
2174 | This variable specifies the minimum distance between the baseline and |
2175 | the underline, in pixels, when displaying underlined text. | |
01f17ae2 | 2176 | @end defopt |
0c1cfe01 | 2177 | |
01f17ae2 | 2178 | @defopt x-bitmap-file-path |
b8d4c8d0 GM |
2179 | This variable specifies a list of directories for searching |
2180 | for bitmap files, for the @code{:stipple} attribute. | |
01f17ae2 | 2181 | @end defopt |
b8d4c8d0 GM |
2182 | |
2183 | @defun bitmap-spec-p object | |
2184 | This returns @code{t} if @var{object} is a valid bitmap specification, | |
2185 | suitable for use with @code{:stipple} (see above). It returns | |
2186 | @code{nil} otherwise. | |
2187 | @end defun | |
2188 | ||
2189 | @node Attribute Functions | |
2190 | @subsection Face Attribute Functions | |
2191 | ||
2192 | This section describes the functions for accessing and modifying the | |
2193 | attributes of an existing face. | |
2194 | ||
2195 | @defun set-face-attribute face frame &rest arguments | |
42a2a154 | 2196 | This function sets one or more attributes of @var{face} for |
b8d4c8d0 GM |
2197 | @var{frame}. The attributes you specify this way override whatever |
2198 | the @code{defface} says. | |
2199 | ||
2200 | The extra arguments @var{arguments} specify the attributes to set, and | |
2201 | the values for them. They should consist of alternating attribute names | |
2202 | (such as @code{:family} or @code{:underline}) and corresponding values. | |
2203 | Thus, | |
2204 | ||
2205 | @example | |
2206 | (set-face-attribute 'foo nil | |
2207 | :width 'extended | |
2208 | :weight 'bold | |
2209 | :underline "red") | |
2210 | @end example | |
2211 | ||
2212 | @noindent | |
2213 | sets the attributes @code{:width}, @code{:weight} and @code{:underline} | |
2214 | to the corresponding values. | |
2215 | ||
2216 | If @var{frame} is @code{t}, this function sets the default attributes | |
2217 | for new frames. Default attribute values specified this way override | |
2218 | the @code{defface} for newly created frames. | |
2219 | ||
2220 | If @var{frame} is @code{nil}, this function sets the attributes for | |
2221 | all existing frames, and the default for new frames. | |
2222 | @end defun | |
2223 | ||
2224 | @defun face-attribute face attribute &optional frame inherit | |
42a2a154 CY |
2225 | This returns the value of the @var{attribute} attribute of @var{face} |
2226 | on @var{frame}. If @var{frame} is @code{nil}, that means the selected | |
2227 | frame (@pxref{Input Focus}). | |
b8d4c8d0 GM |
2228 | |
2229 | If @var{frame} is @code{t}, this returns whatever new-frames default | |
2230 | value you previously specified with @code{set-face-attribute} for the | |
2231 | @var{attribute} attribute of @var{face}. If you have not specified | |
2232 | one, it returns @code{nil}. | |
2233 | ||
2234 | If @var{inherit} is @code{nil}, only attributes directly defined by | |
2235 | @var{face} are considered, so the return value may be | |
2236 | @code{unspecified}, or a relative value. If @var{inherit} is | |
2237 | non-@code{nil}, @var{face}'s definition of @var{attribute} is merged | |
2238 | with the faces specified by its @code{:inherit} attribute; however the | |
2239 | return value may still be @code{unspecified} or relative. If | |
2240 | @var{inherit} is a face or a list of faces, then the result is further | |
2241 | merged with that face (or faces), until it becomes specified and | |
2242 | absolute. | |
2243 | ||
2244 | To ensure that the return value is always specified and absolute, use | |
2245 | a value of @code{default} for @var{inherit}; this will resolve any | |
2246 | unspecified or relative values by merging with the @code{default} face | |
2247 | (which is always completely specified). | |
2248 | ||
2249 | For example, | |
2250 | ||
2251 | @example | |
2252 | (face-attribute 'bold :weight) | |
2253 | @result{} bold | |
2254 | @end example | |
2255 | @end defun | |
2256 | ||
2257 | @defun face-attribute-relative-p attribute value | |
2258 | This function returns non-@code{nil} if @var{value}, when used as the | |
2259 | value of the face attribute @var{attribute}, is relative. This means | |
2260 | it would modify, rather than completely override, any value that comes | |
2261 | from a subsequent face in the face list or that is inherited from | |
2262 | another face. | |
2263 | ||
d466a866 CY |
2264 | @code{unspecified} is a relative value for all attributes. For |
2265 | @code{:height}, floating point and function values are also relative. | |
b8d4c8d0 GM |
2266 | |
2267 | For example: | |
2268 | ||
2269 | @example | |
2270 | (face-attribute-relative-p :height 2.0) | |
2271 | @result{} t | |
2272 | @end example | |
2273 | @end defun | |
2274 | ||
b3d50cff EZ |
2275 | @defun face-all-attributes face &optional frame |
2276 | This function returns an alist of attributes of @var{face}. The | |
2277 | elements of the result are name-value pairs of the form | |
2278 | @w{@code{(@var{attr-name} . @var{attr-value})}}. Optional argument | |
2279 | @var{frame} specifies the frame whose definition of @var{face} to | |
2280 | return; if omitted or @code{nil}, the returned value describes the | |
2281 | default attributes of @var{face} for newly created frames. | |
2282 | @end defun | |
2283 | ||
b8d4c8d0 GM |
2284 | @defun merge-face-attribute attribute value1 value2 |
2285 | If @var{value1} is a relative value for the face attribute | |
2286 | @var{attribute}, returns it merged with the underlying value | |
2287 | @var{value2}; otherwise, if @var{value1} is an absolute value for the | |
2288 | face attribute @var{attribute}, returns @var{value1} unchanged. | |
2289 | @end defun | |
2290 | ||
42a2a154 | 2291 | The following functions provide compatibility with Emacs 20 and |
d466a866 CY |
2292 | below. They work by calling @code{set-face-attribute}. Values of |
2293 | @code{t} and @code{nil} for their @var{frame} argument are handled | |
b8d4c8d0 GM |
2294 | just like @code{set-face-attribute} and @code{face-attribute}. |
2295 | ||
2296 | @defun set-face-foreground face color &optional frame | |
2297 | @defunx set-face-background face color &optional frame | |
d466a866 CY |
2298 | These functions set the @code{:foreground} attribute (or |
2299 | @code{:background} attribute, respectively) of @var{face} to | |
2300 | @var{color}. | |
b8d4c8d0 GM |
2301 | @end defun |
2302 | ||
2303 | @defun set-face-stipple face pattern &optional frame | |
d466a866 CY |
2304 | This function sets the @code{:stipple} attribute of @var{face} to |
2305 | @var{pattern}. | |
b8d4c8d0 GM |
2306 | @end defun |
2307 | ||
2308 | @defun set-face-font face font &optional frame | |
d466a866 | 2309 | This function sets the @code{:font} attribute of @var{face} to |
b8d4c8d0 GM |
2310 | @var{font}. |
2311 | @end defun | |
2312 | ||
2313 | @defun set-face-bold-p face bold-p &optional frame | |
d466a866 CY |
2314 | This function sets the @code{:weight} attribute of @var{face} to |
2315 | @var{normal} if @var{bold-p} is @code{nil}, and to @var{bold} | |
2316 | otherwise. | |
b8d4c8d0 GM |
2317 | @end defun |
2318 | ||
2319 | @defun set-face-italic-p face italic-p &optional frame | |
d466a866 CY |
2320 | This function sets the @code{:slant} attribute of @var{face} to |
2321 | @var{normal} if @var{italic-p} is @code{nil}, and to @var{italic} | |
2322 | otherwise. | |
b8d4c8d0 GM |
2323 | @end defun |
2324 | ||
2325 | @defun set-face-underline-p face underline &optional frame | |
d466a866 CY |
2326 | This function sets the @code{:underline} attribute of @var{face} to |
2327 | @var{underline}. | |
b8d4c8d0 GM |
2328 | @end defun |
2329 | ||
2330 | @defun set-face-inverse-video-p face inverse-video-p &optional frame | |
d466a866 CY |
2331 | This function sets the @code{:inverse-video} attribute of @var{face} |
2332 | to @var{inverse-video-p}. | |
b8d4c8d0 GM |
2333 | @end defun |
2334 | ||
2335 | @defun invert-face face &optional frame | |
2336 | This function swaps the foreground and background colors of face | |
2337 | @var{face}. | |
2338 | @end defun | |
2339 | ||
d466a866 CY |
2340 | The following functions examine the attributes of a face. If you |
2341 | don't specify @var{frame}, they refer to the selected frame; @code{t} | |
2342 | refers to the default data for new frames. They return the symbol | |
b8d4c8d0 GM |
2343 | @code{unspecified} if the face doesn't define any value for that |
2344 | attribute. | |
2345 | ||
2346 | @defun face-foreground face &optional frame inherit | |
2347 | @defunx face-background face &optional frame inherit | |
2348 | These functions return the foreground color (or background color, | |
2349 | respectively) of face @var{face}, as a string. | |
2350 | ||
2351 | If @var{inherit} is @code{nil}, only a color directly defined by the face is | |
2352 | returned. If @var{inherit} is non-@code{nil}, any faces specified by its | |
2353 | @code{:inherit} attribute are considered as well, and if @var{inherit} | |
2354 | is a face or a list of faces, then they are also considered, until a | |
2355 | specified color is found. To ensure that the return value is always | |
2356 | specified, use a value of @code{default} for @var{inherit}. | |
2357 | @end defun | |
2358 | ||
2359 | @defun face-stipple face &optional frame inherit | |
2360 | This function returns the name of the background stipple pattern of face | |
2361 | @var{face}, or @code{nil} if it doesn't have one. | |
2362 | ||
2363 | If @var{inherit} is @code{nil}, only a stipple directly defined by the | |
2364 | face is returned. If @var{inherit} is non-@code{nil}, any faces | |
2365 | specified by its @code{:inherit} attribute are considered as well, and | |
2366 | if @var{inherit} is a face or a list of faces, then they are also | |
2367 | considered, until a specified stipple is found. To ensure that the | |
2368 | return value is always specified, use a value of @code{default} for | |
2369 | @var{inherit}. | |
2370 | @end defun | |
2371 | ||
2372 | @defun face-font face &optional frame | |
2373 | This function returns the name of the font of face @var{face}. | |
2374 | @end defun | |
2375 | ||
2376 | @defun face-bold-p face &optional frame | |
d466a866 CY |
2377 | This function returns a non-@code{nil} value if the @code{:weight} |
2378 | attribute of @var{face} is bolder than normal (i.e., one of | |
2379 | @code{semi-bold}, @code{bold}, @code{extra-bold}, or | |
2380 | @code{ultra-bold}). Otherwise, it returns @code{nil}. | |
b8d4c8d0 GM |
2381 | @end defun |
2382 | ||
2383 | @defun face-italic-p face &optional frame | |
d466a866 CY |
2384 | This function returns a non-@code{nil} value if the @code{:slant} |
2385 | attribute of @var{face} is @code{italic} or @code{oblique}, and | |
b8d4c8d0 GM |
2386 | @code{nil} otherwise. |
2387 | @end defun | |
2388 | ||
2389 | @defun face-underline-p face &optional frame | |
2390 | This function returns the @code{:underline} attribute of face @var{face}. | |
2391 | @end defun | |
2392 | ||
2393 | @defun face-inverse-video-p face &optional frame | |
2394 | This function returns the @code{:inverse-video} attribute of face @var{face}. | |
2395 | @end defun | |
2396 | ||
2397 | @node Displaying Faces | |
2398 | @subsection Displaying Faces | |
2399 | ||
d466a866 CY |
2400 | Here is how Emacs determines the face to use for displaying any |
2401 | given piece of text: | |
b8d4c8d0 GM |
2402 | |
2403 | @itemize @bullet | |
2404 | @item | |
d466a866 CY |
2405 | If the text consists of a special glyph, the glyph can specify a |
2406 | particular face. @xref{Glyphs}. | |
b8d4c8d0 GM |
2407 | |
2408 | @item | |
d466a866 CY |
2409 | If the text lies within an active region, Emacs highlights it using |
2410 | the @code{region} face. @xref{Standard Faces,,, emacs, The GNU Emacs | |
2411 | Manual}. | |
b8d4c8d0 GM |
2412 | |
2413 | @item | |
d466a866 CY |
2414 | If the text lies within an overlay with a non-@code{nil} @code{face} |
2415 | property, Emacs applies the face or face attributes specified by that | |
2416 | property. If the overlay has a @code{mouse-face} property and the | |
2417 | mouse is ``near enough'' to the overlay, Emacs applies the face or | |
2418 | face attributes specified by the @code{mouse-face} property instead. | |
2419 | @xref{Overlay Properties}. | |
b8d4c8d0 | 2420 | |
d466a866 CY |
2421 | When multiple overlays cover one character, an overlay with higher |
2422 | priority overrides those with lower priority. @xref{Overlays}. | |
b8d4c8d0 GM |
2423 | |
2424 | @item | |
d466a866 CY |
2425 | If the text contains a @code{face} or @code{mouse-face} property, |
2426 | Emacs applies the specified faces and face attributes. @xref{Special | |
2427 | Properties}. (This is how Font Lock mode faces are applied. | |
2428 | @xref{Font Lock Mode}.) | |
b8d4c8d0 GM |
2429 | |
2430 | @item | |
d466a866 CY |
2431 | If the text lies within the mode line of the selected window, Emacs |
2432 | applies the @code{mode-line} face. For the mode line of a | |
2433 | non-selected window, Emacs applies the @code{mode-line-inactive} face. | |
2434 | For a header line, Emacs applies the @code{header-line} face. | |
b8d4c8d0 GM |
2435 | |
2436 | @item | |
d466a866 CY |
2437 | If any given attribute has not been specified during the preceding |
2438 | steps, Emacs applies the attribute of the @code{default} face. | |
b8d4c8d0 GM |
2439 | @end itemize |
2440 | ||
2441 | If these various sources together specify more than one face for a | |
2442 | particular character, Emacs merges the attributes of the various faces | |
d466a866 CY |
2443 | specified. For each attribute, Emacs tries using the above order |
2444 | (i.e., first the face of any special glyph; then the face for region | |
2445 | highlighting, if appropriate; then faces specified by overlays, then | |
2446 | faces specified by text properties, then the @code{mode-line} or | |
2447 | @code{mode-line-inactive} or @code{header-line} face, if appropriate, | |
2448 | and finally the @code{default} face). | |
b8d4c8d0 | 2449 | |
d466a866 CY |
2450 | @node Face Remapping |
2451 | @subsection Face Remapping | |
f2cec7a9 | 2452 | |
d466a866 CY |
2453 | The variable @code{face-remapping-alist} is used for buffer-local or |
2454 | global changes in the appearance of a face. For instance, it can be | |
2455 | used to make the @code{default} face a variable-pitch face within a | |
2456 | particular buffer. | |
f2cec7a9 | 2457 | |
d466a866 CY |
2458 | @defvar face-remapping-alist |
2459 | An alist whose elements have the form @code{(@var{face} | |
2460 | @var{remapping...})}. This causes Emacs to display text using the | |
2461 | face @var{face} using @var{remapping...} instead of @var{face}'s | |
2462 | ordinary definition. @var{remapping...} may be any face specification | |
2463 | suitable for a @code{face} text property: either a face name, or a | |
2464 | property list of attribute/value pairs. @xref{Special Properties}. | |
2465 | ||
2466 | If @code{face-remapping-alist} is buffer-local, its local value takes | |
2467 | effect only within that buffer. | |
f2cec7a9 MB |
2468 | |
2469 | Two points bear emphasizing: | |
2470 | ||
2471 | @enumerate | |
2472 | @item | |
2473 | The new definition @var{remapping...} is the complete | |
2474 | specification of how to display @var{face}---it entirely replaces, | |
2475 | rather than augmenting or modifying, the normal definition of that | |
2476 | face. | |
2477 | ||
2478 | @item | |
2479 | If @var{remapping...} recursively references the same face name | |
2480 | @var{face}, either directly remapping entry, or via the | |
0c1cfe01 CY |
2481 | @code{:inherit} attribute of some other face in @var{remapping...}, |
2482 | then that reference uses the normal definition of @var{face} in the | |
2483 | selected frame, instead of the ``remapped'' definition. | |
f2cec7a9 MB |
2484 | |
2485 | For instance, if the @code{mode-line} face is remapped using this | |
2486 | entry in @code{face-remapping-alist}: | |
2487 | @example | |
2488 | (mode-line italic mode-line) | |
2489 | @end example | |
2490 | @noindent | |
2491 | then the new definition of the @code{mode-line} face inherits from the | |
2492 | @code{italic} face, and the @emph{normal} (non-remapped) definition of | |
2493 | @code{mode-line} face. | |
2494 | @end enumerate | |
d466a866 | 2495 | @end defvar |
f2cec7a9 MB |
2496 | |
2497 | A typical use of the @code{face-remapping-alist} is to change a | |
2498 | buffer's @code{default} face; for example, the following changes a | |
2499 | buffer's @code{default} face to use the @code{variable-pitch} face, | |
2500 | with the height doubled: | |
2501 | ||
2502 | @example | |
2503 | (set (make-local-variable 'face-remapping-alist) | |
2504 | '((default variable-pitch :height 2.0))) | |
2505 | @end example | |
2506 | ||
d466a866 | 2507 | The following functions implement a higher-level interface to |
9d3d42fb MB |
2508 | @code{face-remapping-alist}, making it easier to use |
2509 | ``cooperatively''. They are mainly intended for buffer-local use, and | |
2510 | so all make @code{face-remapping-alist} variable buffer-local as a | |
d466a866 CY |
2511 | side-effect. They use entries in @code{face-remapping-alist} which |
2512 | have the general form: | |
9d3d42fb MB |
2513 | |
2514 | @example | |
2515 | (@var{face} @var{relative_specs_1} @var{relative_specs_2} @var{...} @var{base_specs}) | |
2516 | @end example | |
2517 | ||
0c1cfe01 CY |
2518 | Everything except @var{face} is a ``face spec'': a list of face names |
2519 | or face attribute-value pairs. All face specs are merged together, | |
2520 | with earlier values taking precedence. | |
9d3d42fb MB |
2521 | |
2522 | The @var{relative_specs_}n values are ``relative specs'', and are | |
e40a85cd MB |
2523 | added by @code{face-remap-add-relative} (and removed by |
2524 | @code{face-remap-remove-relative}. These are intended for face | |
9d3d42fb MB |
2525 | modifications (such as increasing the size). Typical users of these |
2526 | relative specs would be minor modes. | |
2527 | ||
2528 | @var{base_specs} is the lowest-priority value, and by default is just the | |
2529 | face name, which causes the global definition of that face to be used. | |
2530 | ||
2531 | A non-default value of @var{base_specs} may also be set using | |
e40a85cd | 2532 | @code{face-remap-set-base}. Because this @emph{overwrites} the |
9d3d42fb | 2533 | default base-spec value (which inherits the global face definition), |
e40a85cd | 2534 | it is up to the caller of @code{face-remap-set-base} to add such |
9d3d42fb | 2535 | inheritance if it is desired. A typical use of |
e40a85cd | 2536 | @code{face-remap-set-base} would be a major mode adding a face |
9d3d42fb MB |
2537 | remappings, e.g., of the default face. |
2538 | ||
2539 | ||
e40a85cd | 2540 | @defun face-remap-add-relative face &rest specs |
9d3d42fb MB |
2541 | This functions adds a face remapping entry of @var{face} to @var{specs} |
2542 | in the current buffer. | |
2543 | ||
2544 | It returns a ``cookie'' which can be used to later delete the remapping with | |
e40a85cd | 2545 | @code{face-remap-remove-relative}. |
9d3d42fb MB |
2546 | |
2547 | @var{specs} can be any value suitable for the @code{face} text | |
2548 | property, including a face name, a list of face names, or a | |
2549 | face-attribute property list. The attributes given by @var{specs} | |
2550 | will be merged with any other currently active face remappings of | |
2551 | @var{face}, and with the global definition of @var{face} (by default; | |
e40a85cd MB |
2552 | this may be changed using @code{face-remap-set-base}), with the most |
2553 | recently added relative remapping taking precedence. | |
9d3d42fb MB |
2554 | @end defun |
2555 | ||
e40a85cd | 2556 | @defun face-remap-remove-relative cookie |
9d3d42fb | 2557 | This function removes a face remapping previously added by |
e40a85cd MB |
2558 | @code{face-remap-add-relative}. @var{cookie} should be a return value |
2559 | from that function. | |
9d3d42fb MB |
2560 | @end defun |
2561 | ||
e40a85cd | 2562 | @defun face-remap-set-base face &rest specs |
9d3d42fb MB |
2563 | This function sets the ``base remapping'' of @var{face} in the current |
2564 | buffer to @var{specs}. If @var{specs} is empty, the default base | |
2565 | remapping is restored, which inherits from the global definition of | |
2566 | @var{face}; note that this is different from @var{specs} containing a | |
2567 | single value @code{nil}, which has the opposite result (the global | |
2568 | definition of @var{face} is ignored). | |
2569 | @end defun | |
2570 | ||
e40a85cd | 2571 | @defun face-remap-reset-base face |
9d3d42fb MB |
2572 | This function sets the ``base remapping'' of @var{face} to its default |
2573 | value, which inherits from @var{face}'s global definition. | |
2574 | @end defun | |
2575 | ||
9185bf49 CY |
2576 | @node Face Functions |
2577 | @subsection Functions for Working with Faces | |
2578 | ||
2579 | Here are additional functions for creating and working with faces. | |
2580 | ||
2581 | @defun make-face name | |
2582 | This function defines a new face named @var{name}, initially with all | |
2583 | attributes @code{nil}. It does nothing if there is already a face named | |
2584 | @var{name}. | |
2585 | @end defun | |
2586 | ||
2587 | @defun face-list | |
2588 | This function returns a list of all defined face names. | |
2589 | @end defun | |
2590 | ||
2591 | @defun copy-face old-face new-name &optional frame new-frame | |
2592 | This function defines a face named @var{new-name} as a copy of the existing | |
2593 | face named @var{old-face}. It creates the face @var{new-name} if that | |
2594 | doesn't already exist. | |
2595 | ||
2596 | If the optional argument @var{frame} is given, this function applies | |
2597 | only to that frame. Otherwise it applies to each frame individually, | |
2598 | copying attributes from @var{old-face} in each frame to @var{new-face} | |
2599 | in the same frame. | |
2600 | ||
2601 | If the optional argument @var{new-frame} is given, then @code{copy-face} | |
2602 | copies the attributes of @var{old-face} in @var{frame} to @var{new-name} | |
2603 | in @var{new-frame}. | |
2604 | @end defun | |
2605 | ||
2606 | @defun face-id face | |
2607 | This function returns the @dfn{face number} of face @var{face}. This | |
2608 | is a number that uniquely identifies a face at low levels within | |
2609 | Emacs. It is seldom necessary to refer to a face by its face number. | |
2610 | @end defun | |
2611 | ||
2612 | @defun face-documentation face | |
2613 | This function returns the documentation string of face @var{face}, or | |
2614 | @code{nil} if none was specified for it. | |
2615 | @end defun | |
2616 | ||
2617 | @defun face-equal face1 face2 &optional frame | |
2618 | This returns @code{t} if the faces @var{face1} and @var{face2} have the | |
2619 | same attributes for display. | |
2620 | @end defun | |
2621 | ||
2622 | @defun face-differs-from-default-p face &optional frame | |
2623 | This returns non-@code{nil} if the face @var{face} displays | |
2624 | differently from the default face. | |
2625 | @end defun | |
2626 | ||
2627 | @cindex face alias | |
2628 | A @dfn{face alias} provides an equivalent name for a face. You can | |
2629 | define a face alias by giving the alias symbol the @code{face-alias} | |
2630 | property, with a value of the target face name. The following example | |
2631 | makes @code{modeline} an alias for the @code{mode-line} face. | |
2632 | ||
2633 | @example | |
2634 | (put 'modeline 'face-alias 'mode-line) | |
2635 | @end example | |
2636 | ||
e7e2f529 GM |
2637 | @defun define-obsolete-face-alias obsolete-face current-face &optional when |
2638 | This function defines a face alias and marks it as obsolete, indicating | |
2639 | that it may be removed in future. The optional string @var{when} | |
2640 | indicates when the face was made obsolete (for example, a release number). | |
2641 | @end defun | |
2642 | ||
9185bf49 CY |
2643 | @node Auto Faces |
2644 | @subsection Automatic Face Assignment | |
2645 | @cindex automatic face assignment | |
2646 | @cindex faces, automatic choice | |
2647 | ||
2648 | This hook is used for automatically assigning faces to text in the | |
2649 | buffer. It is part of the implementation of Jit-Lock mode, used by | |
2650 | Font-Lock. | |
2651 | ||
2652 | @defvar fontification-functions | |
2653 | This variable holds a list of functions that are called by Emacs | |
c02f8fe2 AM |
2654 | redisplay as needed, just before doing redisplay. They are called even |
2655 | when Font Lock Mode isn't enabled. When Font Lock Mode is enabled, this | |
2656 | variable usually holds just one function, @code{jit-lock-function}. | |
9185bf49 CY |
2657 | |
2658 | The functions are called in the order listed, with one argument, a | |
c02f8fe2 AM |
2659 | buffer position @var{pos}. Collectively they should attempt to assign |
2660 | faces to the text in the current buffer starting at @var{pos}. | |
9185bf49 | 2661 | |
c02f8fe2 AM |
2662 | The functions should record the faces they assign by setting the |
2663 | @code{face} property. They should also add a non-@code{nil} | |
2664 | @code{fontified} property to all the text they have assigned faces to. | |
9185bf49 CY |
2665 | That property tells redisplay that faces have been assigned to that text |
2666 | already. | |
2667 | ||
c02f8fe2 | 2668 | It is probably a good idea for the functions to do nothing if the |
9185bf49 CY |
2669 | character after @var{pos} already has a non-@code{nil} @code{fontified} |
2670 | property, but this is not required. If one function overrides the | |
c02f8fe2 AM |
2671 | assignments made by a previous one, the properties after the last |
2672 | function finishes are the ones that really matter. | |
9185bf49 CY |
2673 | |
2674 | For efficiency, we recommend writing these functions so that they | |
2675 | usually assign faces to around 400 to 600 characters at each call. | |
2676 | @end defvar | |
2677 | ||
c2aa555a CY |
2678 | @node Font Selection |
2679 | @subsection Font Selection | |
9185bf49 CY |
2680 | |
2681 | Before Emacs can draw a character on a particular display, it must | |
2682 | select a @dfn{font} for that character@footnote{In this context, the | |
2683 | term @dfn{font} has nothing to do with Font Lock (@pxref{Font Lock | |
c2aa555a CY |
2684 | Mode}).}. Normally, Emacs automatically chooses a font based on the |
2685 | faces assigned to that character---specifically, the face attributes | |
2686 | @code{:family}, @code{:weight}, @code{:slant}, and @code{:width} | |
2687 | (@pxref{Face Attributes}). The choice of font also depends on the | |
2688 | character to be displayed; some fonts can only display a limited set | |
2689 | of characters. If no available font exactly fits the requirements, | |
2690 | Emacs looks for the @dfn{closest matching font}. The variables in | |
2691 | this section control how Emacs makes this selection. | |
9185bf49 | 2692 | |
01f17ae2 | 2693 | @defopt face-font-family-alternatives |
c2aa555a CY |
2694 | If a given family is specified but does not exist, this variable |
2695 | specifies alternative font families to try. Each element should have | |
2696 | this form: | |
9185bf49 | 2697 | |
c2aa555a CY |
2698 | @example |
2699 | (@var{family} @var{alternate-families}@dots{}) | |
2700 | @end example | |
b8d4c8d0 | 2701 | |
c2aa555a CY |
2702 | If @var{family} is specified but not available, Emacs will try the other |
2703 | families given in @var{alternate-families}, one by one, until it finds a | |
2704 | family that does exist. | |
01f17ae2 | 2705 | @end defopt |
b8d4c8d0 | 2706 | |
01f17ae2 | 2707 | @defopt face-font-selection-order |
c2aa555a CY |
2708 | If there is no font that exactly matches all desired face attributes |
2709 | (@code{:width}, @code{:height}, @code{:weight}, and @code{:slant}), | |
2710 | this variable specifies the order in which these attributes should be | |
2711 | considered when selecting the closest matching font. The value should | |
2712 | be a list containing those four attribute symbols, in order of | |
2713 | decreasing importance. The default is @code{(:width :height :weight | |
2714 | :slant)}. | |
b8d4c8d0 GM |
2715 | |
2716 | Font selection first finds the best available matches for the first | |
c2aa555a CY |
2717 | attribute in the list; then, among the fonts which are best in that |
2718 | way, it searches for the best matches in the second attribute, and so | |
2719 | on. | |
b8d4c8d0 GM |
2720 | |
2721 | The attributes @code{:weight} and @code{:width} have symbolic values in | |
2722 | a range centered around @code{normal}. Matches that are more extreme | |
2723 | (farther from @code{normal}) are somewhat preferred to matches that are | |
2724 | less extreme (closer to @code{normal}); this is designed to ensure that | |
2725 | non-normal faces contrast with normal ones, whenever possible. | |
2726 | ||
b8d4c8d0 GM |
2727 | One example of a case where this variable makes a difference is when the |
2728 | default font has no italic equivalent. With the default ordering, the | |
2729 | @code{italic} face will use a non-italic font that is similar to the | |
2730 | default one. But if you put @code{:slant} before @code{:height}, the | |
2731 | @code{italic} face will use an italic font, even if its height is not | |
2732 | quite right. | |
01f17ae2 | 2733 | @end defopt |
b8d4c8d0 | 2734 | |
01f17ae2 | 2735 | @defopt face-font-registry-alternatives |
b8d4c8d0 GM |
2736 | This variable lets you specify alternative font registries to try, if a |
2737 | given registry is specified and doesn't exist. Each element should have | |
2738 | this form: | |
2739 | ||
2740 | @example | |
2741 | (@var{registry} @var{alternate-registries}@dots{}) | |
2742 | @end example | |
2743 | ||
2744 | If @var{registry} is specified but not available, Emacs will try the | |
2745 | other registries given in @var{alternate-registries}, one by one, | |
2746 | until it finds a registry that does exist. | |
01f17ae2 | 2747 | @end defopt |
b8d4c8d0 GM |
2748 | |
2749 | Emacs can make use of scalable fonts, but by default it does not use | |
c2aa555a | 2750 | them. |
b8d4c8d0 | 2751 | |
01f17ae2 | 2752 | @defopt scalable-fonts-allowed |
b8d4c8d0 GM |
2753 | This variable controls which scalable fonts to use. A value of |
2754 | @code{nil}, the default, means do not use scalable fonts. @code{t} | |
2755 | means to use any scalable font that seems appropriate for the text. | |
2756 | ||
2757 | Otherwise, the value must be a list of regular expressions. Then a | |
2758 | scalable font is enabled for use if its name matches any regular | |
2759 | expression in the list. For example, | |
2760 | ||
2761 | @example | |
2762 | (setq scalable-fonts-allowed '("muleindian-2$")) | |
2763 | @end example | |
2764 | ||
2765 | @noindent | |
2766 | allows the use of scalable fonts with registry @code{muleindian-2}. | |
01f17ae2 | 2767 | @end defopt |
b8d4c8d0 GM |
2768 | |
2769 | @defvar face-font-rescale-alist | |
2770 | This variable specifies scaling for certain faces. Its value should | |
2771 | be a list of elements of the form | |
2772 | ||
2773 | @example | |
2774 | (@var{fontname-regexp} . @var{scale-factor}) | |
2775 | @end example | |
2776 | ||
2777 | If @var{fontname-regexp} matches the font name that is about to be | |
2778 | used, this says to choose a larger similar font according to the | |
2779 | factor @var{scale-factor}. You would use this feature to normalize | |
2780 | the font size if certain fonts are bigger or smaller than their | |
2781 | nominal heights and widths would suggest. | |
2782 | @end defvar | |
2783 | ||
b8d4c8d0 GM |
2784 | @node Font Lookup |
2785 | @subsection Looking Up Fonts | |
2786 | ||
803ee7b9 | 2787 | @defun x-list-fonts name &optional reference-face frame maximum width |
b8d4c8d0 | 2788 | This function returns a list of available font names that match |
c2aa555a CY |
2789 | @var{name}. @var{name} should be a string containing a font name in |
2790 | either the Fontconfig, GTK, or XLFD format (@pxref{Font X,, Font | |
2791 | Specification Options, emacs, The GNU Emacs Manual}). Within an XLFD | |
2792 | string, wildcard characters may be used: the @samp{*} character | |
2793 | matches any substring, and the @samp{?} character matches any single | |
2794 | character. Case is ignored when matching font names. | |
2795 | ||
2796 | If the optional arguments @var{reference-face} and @var{frame} are | |
2797 | specified, the returned list includes only fonts that are the same | |
2798 | size as @var{reference-face} (a face name) currently is on the frame | |
2799 | @var{frame}. | |
b8d4c8d0 GM |
2800 | |
2801 | The optional argument @var{maximum} sets a limit on how many fonts to | |
c2aa555a CY |
2802 | return. If it is non-@code{nil}, then the return value is truncated |
2803 | after the first @var{maximum} matching fonts. Specifying a small | |
2804 | value for @var{maximum} can make this function much faster, in cases | |
2805 | where many fonts match the pattern. | |
803ee7b9 CY |
2806 | |
2807 | The optional argument @var{width} specifies a desired font width. If | |
2808 | it is non-@code{nil}, the function only returns those fonts whose | |
2809 | characters are (on average) @var{width} times as wide as | |
2810 | @var{reference-face}. | |
b8d4c8d0 GM |
2811 | @end defun |
2812 | ||
2813 | @defun x-family-fonts &optional family frame | |
2814 | This function returns a list describing the available fonts for family | |
2815 | @var{family} on @var{frame}. If @var{family} is omitted or @code{nil}, | |
2816 | this list applies to all families, and therefore, it contains all | |
2817 | available fonts. Otherwise, @var{family} must be a string; it may | |
2818 | contain the wildcards @samp{?} and @samp{*}. | |
2819 | ||
2820 | The list describes the display that @var{frame} is on; if @var{frame} is | |
2821 | omitted or @code{nil}, it applies to the selected frame's display | |
2822 | (@pxref{Input Focus}). | |
2823 | ||
c2aa555a | 2824 | Each element in the list is a vector of the following form: |
b8d4c8d0 GM |
2825 | |
2826 | @example | |
2827 | [@var{family} @var{width} @var{point-size} @var{weight} @var{slant} | |
2828 | @var{fixed-p} @var{full} @var{registry-and-encoding}] | |
2829 | @end example | |
2830 | ||
2831 | The first five elements correspond to face attributes; if you | |
2832 | specify these attributes for a face, it will use this font. | |
2833 | ||
2834 | The last three elements give additional information about the font. | |
2835 | @var{fixed-p} is non-@code{nil} if the font is fixed-pitch. | |
2836 | @var{full} is the full name of the font, and | |
2837 | @var{registry-and-encoding} is a string giving the registry and | |
2838 | encoding of the font. | |
b8d4c8d0 GM |
2839 | @end defun |
2840 | ||
2841 | @defvar font-list-limit | |
2842 | This variable specifies maximum number of fonts to consider in font | |
2843 | matching. The function @code{x-family-fonts} will not return more than | |
2844 | that many fonts, and font selection will consider only that many fonts | |
2845 | when searching a matching font for face attributes. The default is | |
2846 | currently 100. | |
2847 | @end defvar | |
2848 | ||
2849 | @node Fontsets | |
2850 | @subsection Fontsets | |
2851 | ||
2852 | A @dfn{fontset} is a list of fonts, each assigned to a range of | |
2853 | character codes. An individual font cannot display the whole range of | |
2854 | characters that Emacs supports, but a fontset can. Fontsets have names, | |
2855 | just as fonts do, and you can use a fontset name in place of a font name | |
2856 | when you specify the ``font'' for a frame or a face. Here is | |
2857 | information about defining a fontset under Lisp program control. | |
2858 | ||
2859 | @defun create-fontset-from-fontset-spec fontset-spec &optional style-variant-p noerror | |
2860 | This function defines a new fontset according to the specification | |
2861 | string @var{fontset-spec}. The string should have this format: | |
2862 | ||
2863 | @smallexample | |
7b753744 | 2864 | @var{fontpattern}, @r{[}@var{charset}:@var{font}@r{]@dots{}} |
b8d4c8d0 GM |
2865 | @end smallexample |
2866 | ||
2867 | @noindent | |
2868 | Whitespace characters before and after the commas are ignored. | |
2869 | ||
2870 | The first part of the string, @var{fontpattern}, should have the form of | |
2871 | a standard X font name, except that the last two fields should be | |
2872 | @samp{fontset-@var{alias}}. | |
2873 | ||
2874 | The new fontset has two names, one long and one short. The long name is | |
2875 | @var{fontpattern} in its entirety. The short name is | |
2876 | @samp{fontset-@var{alias}}. You can refer to the fontset by either | |
2877 | name. If a fontset with the same name already exists, an error is | |
2878 | signaled, unless @var{noerror} is non-@code{nil}, in which case this | |
2879 | function does nothing. | |
2880 | ||
2881 | If optional argument @var{style-variant-p} is non-@code{nil}, that says | |
2882 | to create bold, italic and bold-italic variants of the fontset as well. | |
2883 | These variant fontsets do not have a short name, only a long one, which | |
2884 | is made by altering @var{fontpattern} to indicate the bold or italic | |
2885 | status. | |
2886 | ||
2887 | The specification string also says which fonts to use in the fontset. | |
2888 | See below for the details. | |
2889 | @end defun | |
2890 | ||
2891 | The construct @samp{@var{charset}:@var{font}} specifies which font to | |
2892 | use (in this fontset) for one particular character set. Here, | |
2893 | @var{charset} is the name of a character set, and @var{font} is the font | |
2894 | to use for that character set. You can use this construct any number of | |
2895 | times in the specification string. | |
2896 | ||
2897 | For the remaining character sets, those that you don't specify | |
2898 | explicitly, Emacs chooses a font based on @var{fontpattern}: it replaces | |
2899 | @samp{fontset-@var{alias}} with a value that names one character set. | |
2900 | For the @acronym{ASCII} character set, @samp{fontset-@var{alias}} is replaced | |
2901 | with @samp{ISO8859-1}. | |
2902 | ||
2903 | In addition, when several consecutive fields are wildcards, Emacs | |
2904 | collapses them into a single wildcard. This is to prevent use of | |
2905 | auto-scaled fonts. Fonts made by scaling larger fonts are not usable | |
2906 | for editing, and scaling a smaller font is not useful because it is | |
2907 | better to use the smaller font in its own size, which Emacs does. | |
2908 | ||
2909 | Thus if @var{fontpattern} is this, | |
2910 | ||
2911 | @example | |
2912 | -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24 | |
2913 | @end example | |
2914 | ||
2915 | @noindent | |
2916 | the font specification for @acronym{ASCII} characters would be this: | |
2917 | ||
2918 | @example | |
2919 | -*-fixed-medium-r-normal-*-24-*-ISO8859-1 | |
2920 | @end example | |
2921 | ||
2922 | @noindent | |
2923 | and the font specification for Chinese GB2312 characters would be this: | |
2924 | ||
2925 | @example | |
2926 | -*-fixed-medium-r-normal-*-24-*-gb2312*-* | |
2927 | @end example | |
2928 | ||
2929 | You may not have any Chinese font matching the above font | |
2930 | specification. Most X distributions include only Chinese fonts that | |
2931 | have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In | |
2932 | such a case, @samp{Fontset-@var{n}} can be specified as below: | |
2933 | ||
2934 | @smallexample | |
2935 | Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\ | |
2936 | chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-* | |
2937 | @end smallexample | |
2938 | ||
2939 | @noindent | |
2940 | Then, the font specifications for all but Chinese GB2312 characters have | |
2941 | @samp{fixed} in the @var{family} field, and the font specification for | |
2942 | Chinese GB2312 characters has a wild card @samp{*} in the @var{family} | |
2943 | field. | |
2944 | ||
d6eb4e25 KH |
2945 | @defun set-fontset-font name character font-spec &optional frame add |
2946 | This function modifies the existing fontset @var{name} to use the font | |
2947 | matching with @var{font-spec} for the character @var{character}. | |
b8d4c8d0 | 2948 | |
d6eb4e25 KH |
2949 | If @var{name} is @code{nil}, this function modifies the fontset of the |
2950 | selected frame or that of @var{frame} if @var{frame} is not | |
2951 | @code{nil}. | |
2952 | ||
2953 | If @var{name} is @code{t}, this function modifies the default | |
b8d4c8d0 GM |
2954 | fontset, whose short name is @samp{fontset-default}. |
2955 | ||
2956 | @var{character} may be a cons; @code{(@var{from} . @var{to})}, where | |
d15c8cce | 2957 | @var{from} and @var{to} are character codepoints. In that case, use |
d6eb4e25 | 2958 | @var{font-spec} for all characters in the range @var{from} and @var{to} |
b8d4c8d0 GM |
2959 | (inclusive). |
2960 | ||
2961 | @var{character} may be a charset. In that case, use | |
d6eb4e25 KH |
2962 | @var{font-spec} for all character in the charsets. |
2963 | ||
664d56b8 | 2964 | @var{character} may be a script name. In that case, use |
d6eb4e25 | 2965 | @var{font-spec} for all character in the charsets. |
b8d4c8d0 | 2966 | |
d6eb4e25 | 2967 | @var{font-spec} may be a cons; @code{(@var{family} . @var{registry})}, |
b8d4c8d0 GM |
2968 | where @var{family} is a family name of a font (possibly including a |
2969 | foundry name at the head), @var{registry} is a registry name of a font | |
2970 | (possibly including an encoding name at the tail). | |
2971 | ||
d6eb4e25 KH |
2972 | @var{font-spec} may be a font name string. |
2973 | ||
2974 | The optional argument @var{add}, if non-@code{nil}, specifies how to | |
2975 | add @var{font-spec} to the font specifications previously set. If it | |
2976 | is @code{prepend}, @var{font-spec} is prepended. If it is | |
2977 | @code{append}, @var{font-spec} is appended. By default, | |
2978 | @var{font-spec} overrides the previous settings. | |
2979 | ||
b8d4c8d0 | 2980 | For instance, this changes the default fontset to use a font of which |
d6eb4e25 | 2981 | family name is @samp{Kochi Gothic} for all characters belonging to |
b8d4c8d0 GM |
2982 | the charset @code{japanese-jisx0208}. |
2983 | ||
2984 | @smallexample | |
d6eb4e25 KH |
2985 | (set-fontset-font t 'japanese-jisx0208 |
2986 | (font-spec :family "Kochi Gothic")) | |
b8d4c8d0 GM |
2987 | @end smallexample |
2988 | @end defun | |
2989 | ||
2990 | @defun char-displayable-p char | |
2991 | This function returns @code{t} if Emacs ought to be able to display | |
2992 | @var{char}. More precisely, if the selected frame's fontset has a | |
2993 | font to display the character set that @var{char} belongs to. | |
2994 | ||
2995 | Fontsets can specify a font on a per-character basis; when the fontset | |
2996 | does that, this function's value may not be accurate. | |
2997 | @end defun | |
2998 | ||
c2aa555a CY |
2999 | @node Low-Level Font |
3000 | @subsection Low-Level Font Representation | |
3001 | ||
3002 | Normally, it is not necessary to manipulate fonts directly. In case | |
3003 | you need to do so, this section explains how. | |
3004 | ||
3005 | In Emacs Lisp, fonts are represented using three different Lisp | |
f19fea97 | 3006 | object types: @dfn{font objects}, @dfn{font specs}, and @dfn{font |
c2aa555a CY |
3007 | entities}. |
3008 | ||
3009 | @defun fontp object &optional type | |
3010 | Return @code{t} if @var{object} is a font object, font spec, or font | |
3011 | entity. Otherwise, return @code{nil}. | |
3012 | ||
3013 | The optional argument @var{type}, if non-@code{nil}, determines the | |
3014 | exact type of Lisp object to check for. In that case, @var{type} | |
3015 | should be one of @code{font-object}, @code{font-spec}, or | |
3016 | @code{font-entity}. | |
3017 | @end defun | |
3018 | ||
3019 | A font object is a Lisp object that represents a font that Emacs has | |
3020 | @dfn{opened}. Font objects cannot be modified in Lisp, but they can | |
0c1cfe01 | 3021 | be inspected. |
c2aa555a CY |
3022 | |
3023 | @defun font-at position &optional window string | |
3024 | Return the font object that is being used to display the character at | |
3025 | position @var{position} in the window @var{window}. If @var{window} | |
3026 | is @code{nil}, it defaults to the selected window. If @var{string} is | |
3027 | @code{nil}, @var{position} specifies a position in the current buffer; | |
3028 | otherwise, @var{string} should be a string, and @var{position} | |
3029 | specifies a position in that string. | |
3030 | @end defun | |
3031 | ||
3032 | A font spec is a Lisp object that contains a set of specifications | |
3033 | that can be used to find a font. More than one font may match the | |
3034 | specifications in a font spec. | |
3035 | ||
3036 | @defun font-spec &rest arguments | |
3037 | Return a new font spec using the specifications in @var{arguments}, | |
3038 | which should come in @code{property}-@code{value} pairs. The possible | |
3039 | specifications are as follows: | |
3040 | ||
3041 | @table @code | |
3042 | @item :name | |
3043 | The font name (a string), in either XLFD, Fontconfig, or GTK format. | |
3044 | @xref{Font X,, Font Specification Options, emacs, The GNU Emacs | |
3045 | Manual}. | |
3046 | ||
3047 | @item :family | |
3048 | @itemx :foundry | |
3049 | @itemx :weight | |
3050 | @itemx :slant | |
3051 | @itemx :width | |
3052 | These have the same meanings as the face attributes of the same name. | |
3053 | @xref{Face Attributes}. | |
3054 | ||
3055 | @item :size | |
3056 | The font size---either a non-negative integer that specifies the pixel | |
3057 | size, or a floating point number that specifies the point size. | |
3058 | ||
3059 | @item :adstyle | |
3060 | Additional typographic style information for the font, such as | |
3061 | @samp{sans}. The value should be a string or a symbol. | |
3062 | ||
3063 | @item :registry | |
3064 | The charset registry and encoding of the font, such as | |
3065 | @samp{iso8859-1}. The value should be a string or a symbol. | |
3066 | ||
3067 | @item :script | |
3068 | The script that the font must support (a symbol). | |
a908c79a CY |
3069 | |
3070 | @item :otf | |
3071 | The font must be an OpenType font that supports these OpenType | |
3072 | features, provided Emacs is compiled with support for @samp{libotf} (a | |
3073 | library for performing complex text layout in certain scripts). The | |
3074 | value must be a list of the form | |
3075 | ||
3076 | @smallexample | |
3077 | @code{(@var{script-tag} @var{langsys-tag} @var{gsub} @var{gpos})} | |
3078 | @end smallexample | |
3079 | ||
3080 | where @var{script-tag} is the OpenType script tag symbol; | |
3081 | @var{langsys-tag} is the OpenType language system tag symbol, or | |
3082 | @code{nil} to use the default language system; @code{gsub} is a list | |
3083 | of OpenType GSUB feature tag symbols, or @code{nil} if none is | |
3084 | required; and @code{gpos} is a list of OpenType GPOS feature tag | |
3085 | symbols, or @code{nil} if none is required. If @code{gsub} or | |
3086 | @code{gpos} is a list, a @code{nil} element in that list means that | |
3087 | the font must not match any of the remaining tag symbols. The | |
3088 | @code{gpos} element may be omitted. | |
c2aa555a CY |
3089 | @end table |
3090 | @end defun | |
3091 | ||
3092 | @defun font-put font-spec property value | |
3093 | Set the font property @var{property} in the font-spec @var{font-spec} | |
3094 | to @var{value}. | |
3095 | @end defun | |
3096 | ||
3097 | A font entity is a reference to a font that need not be open. Its | |
3098 | properties are intermediate between a font object and a font spec: | |
3099 | like a font object, and unlike a font spec, it refers to a single, | |
3100 | specific font. Unlike a font object, creating a font entity does not | |
3101 | load the contents of that font into computer memory. | |
3102 | ||
3103 | @defun find-font font-spec &optional frame | |
3104 | This function returns a font entity that best matches the font spec | |
3105 | @var{font-spec} on frame @var{frame}. If @var{frame} is @code{nil}, | |
3106 | it defaults to the selected frame. | |
3107 | @end defun | |
3108 | ||
3109 | @defun list-fonts font-spec &optional frame num prefer | |
3110 | This function returns a list of all font entities that match the font | |
3111 | spec @var{font-spec}. | |
3112 | ||
3113 | The optional argument @var{frame}, if non-@code{nil}, specifies the | |
3114 | frame on which the fonts are to be displayed. The optional argument | |
3115 | @var{num}, if non-@code{nil}, should be an integer that specifies the | |
3116 | maximum length of the returned list. The optional argument | |
3117 | @var{prefer}, if non-@code{nil}, should be another font spec, which is | |
3118 | used to control the order of the returned list; the returned font | |
3119 | entities are sorted in order of decreasing ``closeness'' to that font | |
3120 | spec. | |
3121 | @end defun | |
3122 | ||
0c1cfe01 CY |
3123 | If you call @code{set-face-attribute} and pass a font spec, font |
3124 | entity, or font name string as the value of the @code{:font} | |
3125 | attribute, Emacs opens the best ``matching'' font that is available | |
3126 | for display. It then stores the corresponding font object as the | |
3127 | actual value of the @code{:font} attribute for that face. | |
3128 | ||
c2aa555a CY |
3129 | The following functions can be used to obtain information about a |
3130 | font. For these functions, the @var{font} argument can be a font | |
3131 | object, a font entity, or a font spec. | |
3132 | ||
3133 | @defun font-get font property | |
3134 | This function returns the value of the font property @var{property} | |
3135 | for @var{font}. | |
3136 | ||
3137 | If @var{font} is a font spec and the font spec does not specify | |
3138 | @var{property}, the return value is @code{nil}. If @var{font} is a | |
3139 | font object or font entity, the value for the @var{:script} property | |
3140 | may be a list of scripts supported by the font. | |
3141 | @end defun | |
3142 | ||
3143 | @defun font-face-attributes font &optional frame | |
3144 | This function returns a list of face attributes corresponding to | |
3145 | @var{font}. The optional argument @var{frame} specifies the frame on | |
3146 | which the font is to be displayed. If it is @code{nil}, the selected | |
3147 | frame is used. The return value has the form | |
3148 | ||
3149 | @smallexample | |
3150 | (:family @var{family} :height @var{height} :weight @var{weight} | |
3151 | :slant @var{slant} :width @var{width}) | |
3152 | @end smallexample | |
3153 | ||
3154 | where the values of @var{family}, @var{height}, @var{weight}, | |
3155 | @var{slant}, and @var{width} are face attribute values. Some of these | |
3156 | key-attribute pairs may be omitted from the list if they are not | |
3157 | specified by @var{font}. | |
3158 | @end defun | |
3159 | ||
3160 | @defun font-xlfd-name font &optional fold-wildcards | |
3161 | This function returns the XLFD (X Logical Font Descriptor), a string, | |
3162 | matching @var{font}. @xref{Font X,, Font Specification Options, | |
3163 | emacs, The GNU Emacs Manual}, for information about XLFDs. If the | |
3164 | name is too long for an XLFD (which can contain at most 255 | |
3165 | characters), the function returns @code{nil}. | |
3166 | ||
3167 | If the optional argument @var{fold-wildcards} is non-@code{nil}, | |
3168 | consecutive wildcards in the XLFD are folded into one. | |
3169 | @end defun | |
3170 | ||
b8d4c8d0 GM |
3171 | @node Fringes |
3172 | @section Fringes | |
3173 | @cindex fringes | |
3174 | ||
3175 | The @dfn{fringes} of a window are thin vertical strips down the | |
3176 | sides that are used for displaying bitmaps that indicate truncation, | |
3177 | continuation, horizontal scrolling, and the overlay arrow. | |
3178 | ||
3179 | @menu | |
3180 | * Fringe Size/Pos:: Specifying where to put the window fringes. | |
3181 | * Fringe Indicators:: Displaying indicator icons in the window fringes. | |
3182 | * Fringe Cursors:: Displaying cursors in the right fringe. | |
3183 | * Fringe Bitmaps:: Specifying bitmaps for fringe indicators. | |
3184 | * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes. | |
3185 | * Overlay Arrow:: Display of an arrow to indicate position. | |
3186 | @end menu | |
3187 | ||
3188 | @node Fringe Size/Pos | |
3189 | @subsection Fringe Size and Position | |
3190 | ||
3191 | The following buffer-local variables control the position and width | |
3192 | of the window fringes. | |
3193 | ||
3194 | @defvar fringes-outside-margins | |
3195 | The fringes normally appear between the display margins and the window | |
3196 | text. If the value is non-@code{nil}, they appear outside the display | |
3197 | margins. @xref{Display Margins}. | |
3198 | @end defvar | |
3199 | ||
3200 | @defvar left-fringe-width | |
3201 | This variable, if non-@code{nil}, specifies the width of the left | |
3202 | fringe in pixels. A value of @code{nil} means to use the left fringe | |
3203 | width from the window's frame. | |
3204 | @end defvar | |
3205 | ||
3206 | @defvar right-fringe-width | |
3207 | This variable, if non-@code{nil}, specifies the width of the right | |
3208 | fringe in pixels. A value of @code{nil} means to use the right fringe | |
3209 | width from the window's frame. | |
3210 | @end defvar | |
3211 | ||
3212 | The values of these variables take effect when you display the | |
3213 | buffer in a window. If you change them while the buffer is visible, | |
3214 | you can call @code{set-window-buffer} to display it once again in the | |
4abe5bf6 EZ |
3215 | same window, to make the changes take effect. A buffer that does not |
3216 | specify values for these variables will use the default values | |
3217 | specified for the frame; see @ref{Layout Parameters}. | |
b8d4c8d0 GM |
3218 | |
3219 | @defun set-window-fringes window left &optional right outside-margins | |
3220 | This function sets the fringe widths of window @var{window}. | |
3221 | If @var{window} is @code{nil}, the selected window is used. | |
3222 | ||
3223 | The argument @var{left} specifies the width in pixels of the left | |
3224 | fringe, and likewise @var{right} for the right fringe. A value of | |
3225 | @code{nil} for either one stands for the default width. If | |
3226 | @var{outside-margins} is non-@code{nil}, that specifies that fringes | |
3227 | should appear outside of the display margins. | |
3228 | @end defun | |
3229 | ||
3230 | @defun window-fringes &optional window | |
3231 | This function returns information about the fringes of a window | |
3232 | @var{window}. If @var{window} is omitted or @code{nil}, the selected | |
3233 | window is used. The value has the form @code{(@var{left-width} | |
3234 | @var{right-width} @var{outside-margins})}. | |
3235 | @end defun | |
3236 | ||
3237 | ||
3238 | @node Fringe Indicators | |
3239 | @subsection Fringe Indicators | |
3240 | @cindex fringe indicators | |
3241 | @cindex indicators, fringe | |
3242 | ||
3243 | The @dfn{fringe indicators} are tiny icons Emacs displays in the | |
3244 | window fringe (on a graphic display) to indicate truncated or | |
3245 | continued lines, buffer boundaries, overlay arrow, etc. | |
3246 | ||
3247 | @defopt indicate-empty-lines | |
3248 | @cindex fringes, and empty line indication | |
3249 | When this is non-@code{nil}, Emacs displays a special glyph in the | |
3250 | fringe of each empty line at the end of the buffer, on graphical | |
3251 | displays. @xref{Fringes}. This variable is automatically | |
3252 | buffer-local in every buffer. | |
3253 | @end defopt | |
3254 | ||
01f17ae2 | 3255 | @defopt indicate-buffer-boundaries |
b8d4c8d0 GM |
3256 | This buffer-local variable controls how the buffer boundaries and |
3257 | window scrolling are indicated in the window fringes. | |
3258 | ||
3259 | Emacs can indicate the buffer boundaries---that is, the first and last | |
3260 | line in the buffer---with angle icons when they appear on the screen. | |
3261 | In addition, Emacs can display an up-arrow in the fringe to show | |
3262 | that there is text above the screen, and a down-arrow to show | |
3263 | there is text below the screen. | |
3264 | ||
3265 | There are three kinds of basic values: | |
3266 | ||
3267 | @table @asis | |
3268 | @item @code{nil} | |
3269 | Don't display any of these fringe icons. | |
3270 | @item @code{left} | |
3271 | Display the angle icons and arrows in the left fringe. | |
3272 | @item @code{right} | |
3273 | Display the angle icons and arrows in the right fringe. | |
3274 | @item any non-alist | |
3275 | Display the angle icons in the left fringe | |
3276 | and don't display the arrows. | |
3277 | @end table | |
3278 | ||
3279 | Otherwise the value should be an alist that specifies which fringe | |
3280 | indicators to display and where. Each element of the alist should | |
3281 | have the form @code{(@var{indicator} . @var{position})}. Here, | |
3282 | @var{indicator} is one of @code{top}, @code{bottom}, @code{up}, | |
3283 | @code{down}, and @code{t} (which covers all the icons not yet | |
3284 | specified), while @var{position} is one of @code{left}, @code{right} | |
3285 | and @code{nil}. | |
3286 | ||
3287 | For example, @code{((top . left) (t . right))} places the top angle | |
3288 | bitmap in left fringe, and the bottom angle bitmap as well as both | |
3289 | arrow bitmaps in right fringe. To show the angle bitmaps in the left | |
3290 | fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. | |
01f17ae2 | 3291 | @end defopt |
b8d4c8d0 | 3292 | |
b8d4c8d0 GM |
3293 | @defvar fringe-indicator-alist |
3294 | This buffer-local variable specifies the mapping from logical fringe | |
3295 | indicators to the actual bitmaps displayed in the window fringes. | |
3296 | ||
3297 | These symbols identify the logical fringe indicators: | |
3298 | ||
3299 | @table @asis | |
3300 | @item Truncation and continuation line indicators: | |
3301 | @code{truncation}, @code{continuation}. | |
3302 | ||
3303 | @item Buffer position indicators: | |
3304 | @code{up}, @code{down}, | |
3305 | @code{top}, @code{bottom}, | |
3306 | @code{top-bottom}. | |
3307 | ||
3308 | @item Empty line indicator: | |
3309 | @code{empty-line}. | |
3310 | ||
3311 | @item Overlay arrow indicator: | |
3312 | @code{overlay-arrow}. | |
3313 | ||
3314 | @item Unknown bitmap indicator: | |
3315 | @code{unknown}. | |
3316 | @end table | |
3317 | ||
3318 | The value is an alist where each element @code{(@var{indicator} . @var{bitmaps})} | |
3319 | specifies the fringe bitmaps used to display a specific logical | |
3320 | fringe indicator. | |
3321 | ||
3322 | Here, @var{indicator} specifies the logical indicator type, and | |
3323 | @var{bitmaps} is list of symbols @code{(@var{left} @var{right} | |
3324 | [@var{left1} @var{right1}])} which specifies the actual bitmap shown | |
3325 | in the left or right fringe for the logical indicator. | |
3326 | ||
3327 | The @var{left} and @var{right} symbols specify the bitmaps shown in | |
3328 | the left and/or right fringe for the specific indicator. The | |
3329 | @var{left1} or @var{right1} bitmaps are used only for the `bottom' and | |
3330 | `top-bottom indicators when the last (only) line in has no final | |
3331 | newline. Alternatively, @var{bitmaps} may be a single symbol which is | |
3332 | used in both left and right fringes. | |
3333 | ||
3334 | When @code{fringe-indicator-alist} has a buffer-local value, and there | |
3335 | is no bitmap defined for a logical indicator, or the bitmap is | |
4e3b4528 SM |
3336 | @code{t}, the corresponding value from the default value of |
3337 | @code{fringe-indicator-alist} is used. | |
b8d4c8d0 GM |
3338 | |
3339 | To completely hide a specific indicator, set the bitmap to @code{nil}. | |
3340 | @end defvar | |
3341 | ||
b8d4c8d0 GM |
3342 | Standard fringe bitmaps for indicators: |
3343 | @example | |
3344 | left-arrow right-arrow up-arrow down-arrow | |
3345 | left-curly-arrow right-curly-arrow | |
3346 | left-triangle right-triangle | |
3347 | top-left-angle top-right-angle | |
3348 | bottom-left-angle bottom-right-angle | |
3349 | left-bracket right-bracket | |
3350 | filled-rectangle hollow-rectangle | |
3351 | filled-square hollow-square | |
3352 | vertical-bar horizontal-bar | |
3353 | empty-line question-mark | |
3354 | @end example | |
3355 | ||
3356 | @node Fringe Cursors | |
3357 | @subsection Fringe Cursors | |
3358 | @cindex fringe cursors | |
3359 | @cindex cursor, fringe | |
3360 | ||
3361 | When a line is exactly as wide as the window, Emacs displays the | |
3362 | cursor in the right fringe instead of using two lines. Different | |
3363 | bitmaps are used to represent the cursor in the fringe depending on | |
3364 | the current buffer's cursor type. | |
3365 | ||
3366 | @table @asis | |
3367 | @item Logical cursor types: | |
3368 | @code{box} , @code{hollow}, @code{bar}, | |
3369 | @code{hbar}, @code{hollow-small}. | |
3370 | @end table | |
3371 | ||
3372 | The @code{hollow-small} type is used instead of @code{hollow} when the | |
3373 | normal @code{hollow-rectangle} bitmap is too tall to fit on a specific | |
3374 | display line. | |
3375 | ||
01f17ae2 | 3376 | @defopt overflow-newline-into-fringe |
b8d4c8d0 GM |
3377 | If this is non-@code{nil}, lines exactly as wide as the window (not |
3378 | counting the final newline character) are not continued. Instead, | |
3379 | when point is at the end of the line, the cursor appears in the right | |
3380 | fringe. | |
01f17ae2 | 3381 | @end defopt |
b8d4c8d0 GM |
3382 | |
3383 | @defvar fringe-cursor-alist | |
3384 | This variable specifies the mapping from logical cursor type to the | |
3385 | actual fringe bitmaps displayed in the right fringe. The value is an | |
3386 | alist where each element @code{(@var{cursor} . @var{bitmap})} specifies | |
3387 | the fringe bitmaps used to display a specific logical cursor type in | |
3388 | the fringe. Here, @var{cursor} specifies the logical cursor type and | |
3389 | @var{bitmap} is a symbol specifying the fringe bitmap to be displayed | |
3390 | for that logical cursor type. | |
3391 | ||
3392 | When @code{fringe-cursor-alist} has a buffer-local value, and there is | |
3393 | no bitmap defined for a cursor type, the corresponding value from the | |
4e3b4528 | 3394 | default value of @code{fringes-indicator-alist} is used. |
b8d4c8d0 GM |
3395 | @end defvar |
3396 | ||
3397 | Standard bitmaps for displaying the cursor in right fringe: | |
3398 | @example | |
3399 | filled-rectangle hollow-rectangle filled-square hollow-square | |
3400 | vertical-bar horizontal-bar | |
3401 | @end example | |
3402 | ||
3403 | ||
3404 | @node Fringe Bitmaps | |
3405 | @subsection Fringe Bitmaps | |
3406 | @cindex fringe bitmaps | |
3407 | @cindex bitmaps, fringe | |
3408 | ||
3409 | The @dfn{fringe bitmaps} are the actual bitmaps which represent the | |
3410 | logical fringe indicators for truncated or continued lines, buffer | |
3411 | boundaries, overlay arrow, etc. Fringe bitmap symbols have their own | |
3412 | name space. The fringe bitmaps are shared by all frames and windows. | |
3413 | You can redefine the built-in fringe bitmaps, and you can define new | |
3414 | fringe bitmaps. | |
3415 | ||
3416 | The way to display a bitmap in the left or right fringes for a given | |
3417 | line in a window is by specifying the @code{display} property for one | |
3418 | of the characters that appears in it. Use a display specification of | |
3419 | the form @code{(left-fringe @var{bitmap} [@var{face}])} or | |
3420 | @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display | |
3421 | Property}). Here, @var{bitmap} is a symbol identifying the bitmap you | |
3422 | want, and @var{face} (which is optional) is the name of the face whose | |
3423 | colors should be used for displaying the bitmap, instead of the | |
3424 | default @code{fringe} face. @var{face} is automatically merged with | |
3425 | the @code{fringe} face, so normally @var{face} need only specify the | |
3426 | foreground color for the bitmap. | |
3427 | ||
3428 | @defun fringe-bitmaps-at-pos &optional pos window | |
3429 | This function returns the fringe bitmaps of the display line | |
3430 | containing position @var{pos} in window @var{window}. The return | |
3431 | value has the form @code{(@var{left} @var{right} @var{ov})}, where @var{left} | |
3432 | is the symbol for the fringe bitmap in the left fringe (or @code{nil} | |
3433 | if no bitmap), @var{right} is similar for the right fringe, and @var{ov} | |
3434 | is non-@code{nil} if there is an overlay arrow in the left fringe. | |
3435 | ||
3436 | The value is @code{nil} if @var{pos} is not visible in @var{window}. | |
3437 | If @var{window} is @code{nil}, that stands for the selected window. | |
3438 | If @var{pos} is @code{nil}, that stands for the value of point in | |
3439 | @var{window}. | |
3440 | @end defun | |
3441 | ||
3442 | @node Customizing Bitmaps | |
3443 | @subsection Customizing Fringe Bitmaps | |
3444 | ||
3445 | @defun define-fringe-bitmap bitmap bits &optional height width align | |
3446 | This function defines the symbol @var{bitmap} as a new fringe bitmap, | |
3447 | or replaces an existing bitmap with that name. | |
3448 | ||
3449 | The argument @var{bits} specifies the image to use. It should be | |
3450 | either a string or a vector of integers, where each element (an | |
3451 | integer) corresponds to one row of the bitmap. Each bit of an integer | |
3452 | corresponds to one pixel of the bitmap, where the low bit corresponds | |
3453 | to the rightmost pixel of the bitmap. | |
3454 | ||
3455 | The height is normally the length of @var{bits}. However, you | |
3456 | can specify a different height with non-@code{nil} @var{height}. The width | |
3457 | is normally 8, but you can specify a different width with non-@code{nil} | |
3458 | @var{width}. The width must be an integer between 1 and 16. | |
3459 | ||
3460 | The argument @var{align} specifies the positioning of the bitmap | |
3461 | relative to the range of rows where it is used; the default is to | |
3462 | center the bitmap. The allowed values are @code{top}, @code{center}, | |
3463 | or @code{bottom}. | |
3464 | ||
3465 | The @var{align} argument may also be a list @code{(@var{align} | |
3466 | @var{periodic})} where @var{align} is interpreted as described above. | |
3467 | If @var{periodic} is non-@code{nil}, it specifies that the rows in | |
3468 | @code{bits} should be repeated enough times to reach the specified | |
3469 | height. | |
3470 | @end defun | |
3471 | ||
3472 | @defun destroy-fringe-bitmap bitmap | |
3473 | This function destroy the fringe bitmap identified by @var{bitmap}. | |
3474 | If @var{bitmap} identifies a standard fringe bitmap, it actually | |
3475 | restores the standard definition of that bitmap, instead of | |
3476 | eliminating it entirely. | |
3477 | @end defun | |
3478 | ||
3479 | @defun set-fringe-bitmap-face bitmap &optional face | |
3480 | This sets the face for the fringe bitmap @var{bitmap} to @var{face}. | |
3481 | If @var{face} is @code{nil}, it selects the @code{fringe} face. The | |
3482 | bitmap's face controls the color to draw it in. | |
3483 | ||
3484 | @var{face} is merged with the @code{fringe} face, so normally | |
3485 | @var{face} should specify only the foreground color. | |
3486 | @end defun | |
3487 | ||
3488 | @node Overlay Arrow | |
3489 | @subsection The Overlay Arrow | |
3490 | @c @cindex overlay arrow Duplicates variable names | |
3491 | ||
3492 | The @dfn{overlay arrow} is useful for directing the user's attention | |
3493 | to a particular line in a buffer. For example, in the modes used for | |
3494 | interface to debuggers, the overlay arrow indicates the line of code | |
3495 | about to be executed. This feature has nothing to do with | |
3496 | @dfn{overlays} (@pxref{Overlays}). | |
3497 | ||
3498 | @defvar overlay-arrow-string | |
3499 | This variable holds the string to display to call attention to a | |
3500 | particular line, or @code{nil} if the arrow feature is not in use. | |
3501 | On a graphical display the contents of the string are ignored; instead a | |
3502 | glyph is displayed in the fringe area to the left of the display area. | |
3503 | @end defvar | |
3504 | ||
3505 | @defvar overlay-arrow-position | |
3506 | This variable holds a marker that indicates where to display the overlay | |
3507 | arrow. It should point at the beginning of a line. On a non-graphical | |
3508 | display the arrow text | |
3509 | appears at the beginning of that line, overlaying any text that would | |
3510 | otherwise appear. Since the arrow is usually short, and the line | |
3511 | usually begins with indentation, normally nothing significant is | |
3512 | overwritten. | |
3513 | ||
3514 | The overlay-arrow string is displayed in any given buffer if the value | |
3515 | of @code{overlay-arrow-position} in that buffer points into that | |
3516 | buffer. Thus, it is possible to display multiple overlay arrow strings | |
3517 | by creating buffer-local bindings of @code{overlay-arrow-position}. | |
3518 | However, it is usually cleaner to use | |
3519 | @code{overlay-arrow-variable-list} to achieve this result. | |
3520 | @c !!! overlay-arrow-position: but the overlay string may remain in the display | |
3521 | @c of some other buffer until an update is required. This should be fixed | |
3522 | @c now. Is it? | |
3523 | @end defvar | |
3524 | ||
3525 | You can do a similar job by creating an overlay with a | |
3526 | @code{before-string} property. @xref{Overlay Properties}. | |
3527 | ||
3528 | You can define multiple overlay arrows via the variable | |
3529 | @code{overlay-arrow-variable-list}. | |
3530 | ||
3531 | @defvar overlay-arrow-variable-list | |
3532 | This variable's value is a list of variables, each of which specifies | |
3533 | the position of an overlay arrow. The variable | |
3534 | @code{overlay-arrow-position} has its normal meaning because it is on | |
3535 | this list. | |
3536 | @end defvar | |
3537 | ||
3538 | Each variable on this list can have properties | |
3539 | @code{overlay-arrow-string} and @code{overlay-arrow-bitmap} that | |
3540 | specify an overlay arrow string (for text-only terminals) or fringe | |
3541 | bitmap (for graphical terminals) to display at the corresponding | |
3542 | overlay arrow position. If either property is not set, the default | |
3543 | @code{overlay-arrow-string} or @code{overlay-arrow} fringe indicator | |
3544 | is used. | |
3545 | ||
3546 | @node Scroll Bars | |
3547 | @section Scroll Bars | |
3548 | @cindex scroll bars | |
3549 | ||
3550 | Normally the frame parameter @code{vertical-scroll-bars} controls | |
3551 | whether the windows in the frame have vertical scroll bars, and | |
3552 | whether they are on the left or right. The frame parameter | |
3553 | @code{scroll-bar-width} specifies how wide they are (@code{nil} | |
3554 | meaning the default). @xref{Layout Parameters}. | |
3555 | ||
3556 | @defun frame-current-scroll-bars &optional frame | |
3557 | This function reports the scroll bar type settings for frame | |
3558 | @var{frame}. The value is a cons cell | |
3559 | @code{(@var{vertical-type} .@: @var{horizontal-type})}, where | |
3560 | @var{vertical-type} is either @code{left}, @code{right}, or @code{nil} | |
3561 | (which means no scroll bar.) @var{horizontal-type} is meant to | |
3562 | specify the horizontal scroll bar type, but since they are not | |
3563 | implemented, it is always @code{nil}. | |
3564 | @end defun | |
3565 | ||
3566 | @vindex vertical-scroll-bar | |
3567 | You can enable or disable scroll bars for a particular buffer, | |
3568 | by setting the variable @code{vertical-scroll-bar}. This variable | |
3569 | automatically becomes buffer-local when set. The possible values are | |
3570 | @code{left}, @code{right}, @code{t}, which means to use the | |
3571 | frame's default, and @code{nil} for no scroll bar. | |
3572 | ||
3573 | You can also control this for individual windows. Call the function | |
3574 | @code{set-window-scroll-bars} to specify what to do for a specific window: | |
3575 | ||
3576 | @defun set-window-scroll-bars window width &optional vertical-type horizontal-type | |
3577 | This function sets the width and type of scroll bars for window | |
3578 | @var{window}. | |
3579 | ||
3580 | @var{width} specifies the scroll bar width in pixels (@code{nil} means | |
3581 | use the width specified for the frame). @var{vertical-type} specifies | |
3582 | whether to have a vertical scroll bar and, if so, where. The possible | |
3583 | values are @code{left}, @code{right} and @code{nil}, just like the | |
3584 | values of the @code{vertical-scroll-bars} frame parameter. | |
3585 | ||
3586 | The argument @var{horizontal-type} is meant to specify whether and | |
3587 | where to have horizontal scroll bars, but since they are not | |
3588 | implemented, it has no effect. If @var{window} is @code{nil}, the | |
3589 | selected window is used. | |
3590 | @end defun | |
3591 | ||
3592 | @defun window-scroll-bars &optional window | |
3593 | Report the width and type of scroll bars specified for @var{window}. | |
3594 | If @var{window} is omitted or @code{nil}, the selected window is used. | |
3595 | The value is a list of the form @code{(@var{width} | |
3596 | @var{cols} @var{vertical-type} @var{horizontal-type})}. The value | |
3597 | @var{width} is the value that was specified for the width (which may | |
3598 | be @code{nil}); @var{cols} is the number of columns that the scroll | |
3599 | bar actually occupies. | |
3600 | ||
3601 | @var{horizontal-type} is not actually meaningful. | |
3602 | @end defun | |
3603 | ||
3604 | If you don't specify these values for a window with | |
3605 | @code{set-window-scroll-bars}, the buffer-local variables | |
3606 | @code{scroll-bar-mode} and @code{scroll-bar-width} in the buffer being | |
3607 | displayed control the window's vertical scroll bars. The function | |
3608 | @code{set-window-buffer} examines these variables. If you change them | |
3609 | in a buffer that is already visible in a window, you can make the | |
3610 | window take note of the new values by calling @code{set-window-buffer} | |
3611 | specifying the same buffer that is already displayed. | |
3612 | ||
01f17ae2 | 3613 | @defopt scroll-bar-mode |
b8d4c8d0 GM |
3614 | This variable, always local in all buffers, controls whether and where |
3615 | to put scroll bars in windows displaying the buffer. The possible values | |
3616 | are @code{nil} for no scroll bar, @code{left} to put a scroll bar on | |
3617 | the left, and @code{right} to put a scroll bar on the right. | |
01f17ae2 | 3618 | @end defopt |
b8d4c8d0 GM |
3619 | |
3620 | @defun window-current-scroll-bars &optional window | |
3621 | This function reports the scroll bar type for window @var{window}. | |
3622 | If @var{window} is omitted or @code{nil}, the selected window is used. | |
3623 | The value is a cons cell | |
3624 | @code{(@var{vertical-type} .@: @var{horizontal-type})}. Unlike | |
3625 | @code{window-scroll-bars}, this reports the scroll bar type actually | |
3626 | used, once frame defaults and @code{scroll-bar-mode} are taken into | |
3627 | account. | |
3628 | @end defun | |
3629 | ||
3630 | @defvar scroll-bar-width | |
3631 | This variable, always local in all buffers, specifies the width of the | |
3632 | buffer's scroll bars, measured in pixels. A value of @code{nil} means | |
3633 | to use the value specified by the frame. | |
3634 | @end defvar | |
3635 | ||
3636 | @node Display Property | |
3637 | @section The @code{display} Property | |
3638 | @cindex display specification | |
3639 | @kindex display @r{(text property)} | |
3640 | ||
3641 | The @code{display} text property (or overlay property) is used to | |
3642 | insert images into text, and also control other aspects of how text | |
3643 | displays. The value of the @code{display} property should be a | |
3644 | display specification, or a list or vector containing several display | |
fb33e6a9 RS |
3645 | specifications. Display specifications in the same @code{display} |
3646 | property value generally apply in parallel to the text they cover. | |
3647 | ||
3648 | If several sources (overlays and/or a text property) specify values | |
3649 | for the @code{display} property, only one of the values takes effect, | |
3650 | following the rules of @code{get-char-property}. @xref{Examining | |
3651 | Properties}. | |
3652 | ||
3653 | The rest of this section describes several kinds of | |
3654 | display specifications and what they mean. | |
3655 | ||
3656 | @menu | |
3657 | * Replacing Specs:: Display specs that replace the text. | |
3658 | * Specified Space:: Displaying one space with a specified width. | |
3659 | * Pixel Specification:: Specifying space width or height in pixels. | |
3660 | * Other Display Specs:: Displaying an image; magnifying text; moving it | |
3661 | up or down on the page; adjusting the width | |
3662 | of spaces within text. | |
3663 | * Display Margins:: Displaying text or images to the side of the main text. | |
3664 | @end menu | |
3665 | ||
3666 | @node Replacing Specs | |
3667 | @subsection Display Specs That Replace The Text | |
4db6da64 | 3668 | |
9600ac7c | 3669 | Some kinds of @code{display} specifications specify something to |
fb33e6a9 RS |
3670 | display instead of the text that has the property. These are called |
3671 | @dfn{replacing} display specifications. Emacs does not allow the user | |
3672 | to interactively move point into the middle of buffer text that is | |
3673 | replaced in this way. | |
3674 | ||
3675 | If a list of display specifications includes more than one replacing | |
3676 | display specification, the first overrides the rest. Replacing | |
3677 | display specifications make most other display specifications | |
3678 | irrelevant, since those don't apply to the replacement. | |
3679 | ||
3680 | For replacing display specifications, ``the text that has the | |
3681 | property'' means all the consecutive characters that have the same | |
3682 | Lisp object as their @code{display} property; these characters are | |
3683 | replaced as a single unit. By contrast, characters that have similar | |
3684 | but distinct Lisp objects as their @code{display} properties are | |
3685 | handled separately. Here's a function that illustrates this point: | |
b8d4c8d0 GM |
3686 | |
3687 | @smallexample | |
3688 | (defun foo () | |
3689 | (goto-char (point-min)) | |
3690 | (dotimes (i 5) | |
3691 | (let ((string (concat "A"))) | |
3692 | (put-text-property (point) (1+ (point)) 'display string) | |
3693 | (forward-char 1) | |
3694 | (put-text-property (point) (1+ (point)) 'display string) | |
3695 | (forward-char 1)))) | |
3696 | @end smallexample | |
3697 | ||
3698 | @noindent | |
3699 | It gives each of the first ten characters in the buffer string | |
3700 | @code{"A"} as the @code{display} property, but they don't all get the | |
3701 | same string. The first two characters get the same string, so they | |
3702 | together are replaced with one @samp{A}. The next two characters get | |
3703 | a second string, so they together are replaced with one @samp{A}. | |
3704 | Likewise for each following pair of characters. Thus, the ten | |
3705 | characters appear as five A's. This function would have the same | |
3706 | results: | |
3707 | ||
3708 | @smallexample | |
3709 | (defun foo () | |
3710 | (goto-char (point-min)) | |
3711 | (dotimes (i 5) | |
3712 | (let ((string (concat "A"))) | |
9600ac7c | 3713 | (put-text-property (point) (+ 2 (point)) 'display string) |
b8d4c8d0 GM |
3714 | (put-text-property (point) (1+ (point)) 'display string) |
3715 | (forward-char 2)))) | |
3716 | @end smallexample | |
3717 | ||
3718 | @noindent | |
3719 | This illustrates that what matters is the property value for | |
3720 | each character. If two consecutive characters have the same | |
3721 | object as the @code{display} property value, it's irrelevant | |
3722 | whether they got this property from a single call to | |
3723 | @code{put-text-property} or from two different calls. | |
3724 | ||
b8d4c8d0 GM |
3725 | @node Specified Space |
3726 | @subsection Specified Spaces | |
3727 | @cindex spaces, specified height or width | |
3728 | @cindex variable-width spaces | |
3729 | ||
3730 | To display a space of specified width and/or height, use a display | |
3731 | specification of the form @code{(space . @var{props})}, where | |
3732 | @var{props} is a property list (a list of alternating properties and | |
3733 | values). You can put this property on one or more consecutive | |
3734 | characters; a space of the specified height and width is displayed in | |
3735 | place of @emph{all} of those characters. These are the properties you | |
3736 | can use in @var{props} to specify the weight of the space: | |
3737 | ||
3738 | @table @code | |
3739 | @item :width @var{width} | |
3740 | If @var{width} is an integer or floating point number, it specifies | |
3741 | that the space width should be @var{width} times the normal character | |
3742 | width. @var{width} can also be a @dfn{pixel width} specification | |
3743 | (@pxref{Pixel Specification}). | |
3744 | ||
3745 | @item :relative-width @var{factor} | |
3746 | Specifies that the width of the stretch should be computed from the | |
3747 | first character in the group of consecutive characters that have the | |
3748 | same @code{display} property. The space width is the width of that | |
3749 | character, multiplied by @var{factor}. | |
3750 | ||
3751 | @item :align-to @var{hpos} | |
3752 | Specifies that the space should be wide enough to reach @var{hpos}. | |
3753 | If @var{hpos} is a number, it is measured in units of the normal | |
3754 | character width. @var{hpos} can also be a @dfn{pixel width} | |
3755 | specification (@pxref{Pixel Specification}). | |
3756 | @end table | |
3757 | ||
3758 | You should use one and only one of the above properties. You can | |
3759 | also specify the height of the space, with these properties: | |
3760 | ||
3761 | @table @code | |
3762 | @item :height @var{height} | |
3763 | Specifies the height of the space. | |
3764 | If @var{height} is an integer or floating point number, it specifies | |
3765 | that the space height should be @var{height} times the normal character | |
3766 | height. The @var{height} may also be a @dfn{pixel height} specification | |
3767 | (@pxref{Pixel Specification}). | |
3768 | ||
3769 | @item :relative-height @var{factor} | |
3770 | Specifies the height of the space, multiplying the ordinary height | |
3771 | of the text having this display specification by @var{factor}. | |
3772 | ||
3773 | @item :ascent @var{ascent} | |
3774 | If the value of @var{ascent} is a non-negative number no greater than | |
3775 | 100, it specifies that @var{ascent} percent of the height of the space | |
3776 | should be considered as the ascent of the space---that is, the part | |
3777 | above the baseline. The ascent may also be specified in pixel units | |
3778 | with a @dfn{pixel ascent} specification (@pxref{Pixel Specification}). | |
3779 | ||
3780 | @end table | |
3781 | ||
3782 | Don't use both @code{:height} and @code{:relative-height} together. | |
3783 | ||
3784 | The @code{:width} and @code{:align-to} properties are supported on | |
3785 | non-graphic terminals, but the other space properties in this section | |
3786 | are not. | |
3787 | ||
3788 | @node Pixel Specification | |
3789 | @subsection Pixel Specification for Spaces | |
3790 | @cindex spaces, pixel specification | |
3791 | ||
3792 | The value of the @code{:width}, @code{:align-to}, @code{:height}, | |
3793 | and @code{:ascent} properties can be a special kind of expression that | |
3794 | is evaluated during redisplay. The result of the evaluation is used | |
3795 | as an absolute number of pixels. | |
3796 | ||
3797 | The following expressions are supported: | |
3798 | ||
3799 | @smallexample | |
3800 | @group | |
3801 | @var{expr} ::= @var{num} | (@var{num}) | @var{unit} | @var{elem} | @var{pos} | @var{image} | @var{form} | |
3802 | @var{num} ::= @var{integer} | @var{float} | @var{symbol} | |
3803 | @var{unit} ::= in | mm | cm | width | height | |
3804 | @end group | |
3805 | @group | |
3806 | @var{elem} ::= left-fringe | right-fringe | left-margin | right-margin | |
3807 | | scroll-bar | text | |
3808 | @var{pos} ::= left | center | right | |
3809 | @var{form} ::= (@var{num} . @var{expr}) | (@var{op} @var{expr} ...) | |
3810 | @var{op} ::= + | - | |
3811 | @end group | |
3812 | @end smallexample | |
3813 | ||
3814 | The form @var{num} specifies a fraction of the default frame font | |
3815 | height or width. The form @code{(@var{num})} specifies an absolute | |
3816 | number of pixels. If @var{num} is a symbol, @var{symbol}, its | |
3817 | buffer-local variable binding is used. | |
3818 | ||
3819 | The @code{in}, @code{mm}, and @code{cm} units specify the number of | |
3820 | pixels per inch, millimeter, and centimeter, respectively. The | |
3821 | @code{width} and @code{height} units correspond to the default width | |
3822 | and height of the current face. An image specification @code{image} | |
3823 | corresponds to the width or height of the image. | |
3824 | ||
3825 | The @code{left-fringe}, @code{right-fringe}, @code{left-margin}, | |
3826 | @code{right-margin}, @code{scroll-bar}, and @code{text} elements | |
3827 | specify to the width of the corresponding area of the window. | |
3828 | ||
3829 | The @code{left}, @code{center}, and @code{right} positions can be | |
3830 | used with @code{:align-to} to specify a position relative to the left | |
3831 | edge, center, or right edge of the text area. | |
3832 | ||
3833 | Any of the above window elements (except @code{text}) can also be | |
3834 | used with @code{:align-to} to specify that the position is relative to | |
3835 | the left edge of the given area. Once the base offset for a relative | |
3836 | position has been set (by the first occurrence of one of these | |
3837 | symbols), further occurrences of these symbols are interpreted as the | |
3838 | width of the specified area. For example, to align to the center of | |
3839 | the left-margin, use | |
3840 | ||
3841 | @example | |
3842 | :align-to (+ left-margin (0.5 . left-margin)) | |
3843 | @end example | |
3844 | ||
3845 | If no specific base offset is set for alignment, it is always relative | |
3846 | to the left edge of the text area. For example, @samp{:align-to 0} in a | |
3847 | header-line aligns with the first text column in the text area. | |
3848 | ||
3849 | A value of the form @code{(@var{num} . @var{expr})} stands for the | |
3850 | product of the values of @var{num} and @var{expr}. For example, | |
3851 | @code{(2 . in)} specifies a width of 2 inches, while @code{(0.5 . | |
3852 | @var{image})} specifies half the width (or height) of the specified | |
3853 | image. | |
3854 | ||
3855 | The form @code{(+ @var{expr} ...)} adds up the value of the | |
3856 | expressions. The form @code{(- @var{expr} ...)} negates or subtracts | |
3857 | the value of the expressions. | |
3858 | ||
3859 | @node Other Display Specs | |
3860 | @subsection Other Display Specifications | |
3861 | ||
3862 | Here are the other sorts of display specifications that you can use | |
3863 | in the @code{display} text property. | |
3864 | ||
3865 | @table @code | |
3866 | @item @var{string} | |
3867 | Display @var{string} instead of the text that has this property. | |
3868 | ||
3869 | Recursive display specifications are not supported---@var{string}'s | |
3870 | @code{display} properties, if any, are not used. | |
3871 | ||
3872 | @item (image . @var{image-props}) | |
3873 | This kind of display specification is an image descriptor (@pxref{Images}). | |
3874 | When used as a display specification, it means to display the image | |
3875 | instead of the text that has the display specification. | |
3876 | ||
3877 | @item (slice @var{x} @var{y} @var{width} @var{height}) | |
3878 | This specification together with @code{image} specifies a @dfn{slice} | |
3879 | (a partial area) of the image to display. The elements @var{y} and | |
3880 | @var{x} specify the top left corner of the slice, within the image; | |
3881 | @var{width} and @var{height} specify the width and height of the | |
3882 | slice. Integer values are numbers of pixels. A floating point number | |
3883 | in the range 0.0--1.0 stands for that fraction of the width or height | |
3884 | of the entire image. | |
3885 | ||
3886 | @item ((margin nil) @var{string}) | |
3887 | A display specification of this form means to display @var{string} | |
3888 | instead of the text that has the display specification, at the same | |
3889 | position as that text. It is equivalent to using just @var{string}, | |
3890 | but it is done as a special case of marginal display (@pxref{Display | |
3891 | Margins}). | |
3892 | ||
bdef6a77 EZ |
3893 | @item (left-fringe @var{bitmap} @r{[}@var{face}@r{]}) |
3894 | @itemx (right-fringe @var{bitmap} @r{[}@var{face}@r{]}) | |
3895 | This display specification on any character of a line of text causes | |
3896 | the specified @var{bitmap} be displayed in the left or right fringes | |
3897 | for that line. The optional @var{face} specifies the colors to be | |
3898 | used for the bitmap. @xref{Fringe Bitmaps}, for the details. | |
3899 | ||
b8d4c8d0 GM |
3900 | @item (space-width @var{factor}) |
3901 | This display specification affects all the space characters within the | |
3902 | text that has the specification. It displays all of these spaces | |
3903 | @var{factor} times as wide as normal. The element @var{factor} should | |
3904 | be an integer or float. Characters other than spaces are not affected | |
3905 | at all; in particular, this has no effect on tab characters. | |
3906 | ||
3907 | @item (height @var{height}) | |
3908 | This display specification makes the text taller or shorter. | |
3909 | Here are the possibilities for @var{height}: | |
3910 | ||
3911 | @table @asis | |
3912 | @item @code{(+ @var{n})} | |
3913 | This means to use a font that is @var{n} steps larger. A ``step'' is | |
3914 | defined by the set of available fonts---specifically, those that match | |
3915 | what was otherwise specified for this text, in all attributes except | |
3916 | height. Each size for which a suitable font is available counts as | |
3917 | another step. @var{n} should be an integer. | |
3918 | ||
3919 | @item @code{(- @var{n})} | |
3920 | This means to use a font that is @var{n} steps smaller. | |
3921 | ||
3922 | @item a number, @var{factor} | |
3923 | A number, @var{factor}, means to use a font that is @var{factor} times | |
3924 | as tall as the default font. | |
3925 | ||
3926 | @item a symbol, @var{function} | |
3927 | A symbol is a function to compute the height. It is called with the | |
3928 | current height as argument, and should return the new height to use. | |
3929 | ||
3930 | @item anything else, @var{form} | |
3931 | If the @var{height} value doesn't fit the previous possibilities, it is | |
3932 | a form. Emacs evaluates it to get the new height, with the symbol | |
3933 | @code{height} bound to the current specified font height. | |
3934 | @end table | |
3935 | ||
3936 | @item (raise @var{factor}) | |
3937 | This kind of display specification raises or lowers the text | |
3938 | it applies to, relative to the baseline of the line. | |
3939 | ||
3940 | @var{factor} must be a number, which is interpreted as a multiple of the | |
3941 | height of the affected text. If it is positive, that means to display | |
3942 | the characters raised. If it is negative, that means to display them | |
3943 | lower down. | |
3944 | ||
3945 | If the text also has a @code{height} display specification, that does | |
3946 | not affect the amount of raising or lowering, which is based on the | |
3947 | faces used for the text. | |
3948 | @end table | |
3949 | ||
3950 | @c We put all the `@code{(when ...)}' on one line to encourage | |
3951 | @c makeinfo's end-of-sentence heuristics to DTRT. Previously, the dot | |
3952 | @c was at eol; the info file ended up w/ two spaces rendered after it. | |
3953 | You can make any display specification conditional. To do that, | |
3954 | package it in another list of the form | |
3955 | @code{(when @var{condition} . @var{spec})}. | |
3956 | Then the specification @var{spec} applies only when | |
3957 | @var{condition} evaluates to a non-@code{nil} value. During the | |
3958 | evaluation, @code{object} is bound to the string or buffer having the | |
3959 | conditional @code{display} property. @code{position} and | |
3960 | @code{buffer-position} are bound to the position within @code{object} | |
3961 | and the buffer position where the @code{display} property was found, | |
3962 | respectively. Both positions can be different when @code{object} is a | |
3963 | string. | |
3964 | ||
3965 | @node Display Margins | |
3966 | @subsection Displaying in the Margins | |
3967 | @cindex display margins | |
3968 | @cindex margins, display | |
3969 | ||
fb33e6a9 RS |
3970 | A buffer can have blank areas called @dfn{display margins} on the |
3971 | left and on the right. Ordinary text never appears in these areas, | |
3972 | but you can put things into the display margins using the | |
3973 | @code{display} property. There is currently no way to make text or | |
3974 | images in the margin mouse-sensitive. | |
3975 | ||
3976 | The way to display something in the margins is to specify it in a | |
3977 | margin display specification in the @code{display} property of some | |
3978 | text. This is a replacing display specification, meaning that the | |
3979 | text you put it on does not get displayed; the margin display appears, | |
3980 | but that text does not. | |
3981 | ||
3982 | A margin display specification looks like @code{((margin | |
d25ed7db | 3983 | right-margin) @var{spec})} or @code{((margin left-margin) @var{spec})}. |
fb33e6a9 RS |
3984 | Here, @var{spec} is another display specification that says what to |
3985 | display in the margin. Typically it is a string of text to display, | |
3986 | or an image descriptor. | |
3987 | ||
3988 | To display something in the margin @emph{in association with} | |
3989 | certain buffer text, without altering or preventing the display of | |
3990 | that text, put a @code{before-string} property on the text and put the | |
3991 | margin display specification on the contents of the before-string. | |
b8d4c8d0 GM |
3992 | |
3993 | Before the display margins can display anything, you must give | |
3994 | them a nonzero width. The usual way to do that is to set these | |
3995 | variables: | |
3996 | ||
3997 | @defvar left-margin-width | |
3998 | This variable specifies the width of the left margin. | |
3999 | It is buffer-local in all buffers. | |
4000 | @end defvar | |
4001 | ||
4002 | @defvar right-margin-width | |
4003 | This variable specifies the width of the right margin. | |
4004 | It is buffer-local in all buffers. | |
4005 | @end defvar | |
4006 | ||
4007 | Setting these variables does not immediately affect the window. These | |
4008 | variables are checked when a new buffer is displayed in the window. | |
4009 | Thus, you can make changes take effect by calling | |
4010 | @code{set-window-buffer}. | |
4011 | ||
4012 | You can also set the margin widths immediately. | |
4013 | ||
4014 | @defun set-window-margins window left &optional right | |
4015 | This function specifies the margin widths for window @var{window}. | |
4016 | The argument @var{left} controls the left margin and | |
4017 | @var{right} controls the right margin (default @code{0}). | |
4018 | @end defun | |
4019 | ||
4020 | @defun window-margins &optional window | |
4021 | This function returns the left and right margins of @var{window} | |
4022 | as a cons cell of the form @code{(@var{left} . @var{right})}. | |
4023 | If @var{window} is @code{nil}, the selected window is used. | |
4024 | @end defun | |
4025 | ||
4026 | @node Images | |
4027 | @section Images | |
4028 | @cindex images in buffers | |
4029 | ||
4030 | To display an image in an Emacs buffer, you must first create an image | |
4031 | descriptor, then use it as a display specifier in the @code{display} | |
4032 | property of text that is displayed (@pxref{Display Property}). | |
4033 | ||
4034 | Emacs is usually able to display images when it is run on a | |
4035 | graphical terminal. Images cannot be displayed in a text terminal, on | |
4036 | certain graphical terminals that lack the support for this, or if | |
4037 | Emacs is compiled without image support. You can use the function | |
4038 | @code{display-images-p} to determine if images can in principle be | |
4039 | displayed (@pxref{Display Feature Testing}). | |
4040 | ||
4041 | @menu | |
4042 | * Image Formats:: Supported image formats. | |
4043 | * Image Descriptors:: How to specify an image for use in @code{:display}. | |
4044 | * XBM Images:: Special features for XBM format. | |
4045 | * XPM Images:: Special features for XPM format. | |
4046 | * GIF Images:: Special features for GIF format. | |
905a9adb | 4047 | * TIFF Images:: Special features for TIFF format. |
2833b3ff | 4048 | * PostScript Images:: Special features for PostScript format. |
16a91140 | 4049 | * ImageMagick Images:: Special features available through ImageMagick. |
b8d4c8d0 GM |
4050 | * Other Image Types:: Various other formats are supported. |
4051 | * Defining Images:: Convenient ways to define an image for later use. | |
4052 | * Showing Images:: Convenient ways to display an image once it is defined. | |
4053 | * Image Cache:: Internal mechanisms of image display. | |
4054 | @end menu | |
4055 | ||
4056 | @node Image Formats | |
4057 | @subsection Image Formats | |
4058 | @cindex image formats | |
4059 | @cindex image types | |
4060 | ||
4061 | Emacs can display a number of different image formats; some of them | |
4062 | are supported only if particular support libraries are installed on | |
00f113eb JB |
4063 | your machine. In some environments, Emacs can load support libraries |
4064 | on demand; if so, the variable @code{dynamic-library-alist} | |
4065 | (@pxref{Dynamic Libraries}) can be used to modify the set of known | |
4066 | names for these dynamic libraries (though it is not possible to add | |
4067 | new image formats). Note that image types @code{pbm} and @code{xbm} | |
4068 | do not depend on external libraries and are always available in Emacs. | |
b8d4c8d0 GM |
4069 | |
4070 | The supported image formats include XBM, XPM (this requires the | |
4071 | libraries @code{libXpm} version 3.4k and @code{libz}), GIF (requiring | |
4072 | @code{libungif} 4.1.0), PostScript, PBM, JPEG (requiring the | |
4073 | @code{libjpeg} library version v6a), TIFF (requiring @code{libtiff} | |
4074 | v3.4), PNG (requiring @code{libpng} 1.0.2), and SVG (requiring | |
4075 | @code{librsvg} 2.0.0). | |
4076 | ||
4077 | You specify one of these formats with an image type symbol. The image | |
4078 | type symbols are @code{xbm}, @code{xpm}, @code{gif}, @code{postscript}, | |
4079 | @code{pbm}, @code{jpeg}, @code{tiff}, @code{png}, and @code{svg}. | |
4080 | ||
4081 | @defvar image-types | |
4082 | This variable contains a list of those image type symbols that are | |
4083 | potentially supported in the current configuration. | |
4084 | @emph{Potentially} here means that Emacs knows about the image types, | |
4085 | not necessarily that they can be loaded (they could depend on | |
4086 | unavailable dynamic libraries, for example). | |
4087 | ||
4088 | To know which image types are really available, use | |
4089 | @code{image-type-available-p}. | |
4090 | @end defvar | |
4091 | ||
b8d4c8d0 GM |
4092 | @defun image-type-available-p type |
4093 | This function returns non-@code{nil} if image type @var{type} is | |
4094 | available, i.e., if images of this type can be loaded and displayed in | |
4095 | Emacs. @var{type} should be one of the types contained in | |
4096 | @code{image-types}. | |
4097 | ||
4098 | For image types whose support libraries are statically linked, this | |
4099 | function always returns @code{t}; for other image types, it returns | |
4100 | @code{t} if the dynamic library could be loaded, @code{nil} otherwise. | |
4101 | @end defun | |
4102 | ||
4103 | @node Image Descriptors | |
4104 | @subsection Image Descriptors | |
4105 | @cindex image descriptor | |
4106 | ||
4107 | An image description is a list of the form @code{(image . @var{props})}, | |
4108 | where @var{props} is a property list containing alternating keyword | |
4109 | symbols (symbols whose names start with a colon) and their values. | |
4110 | You can use any Lisp object as a property, but the only properties | |
4111 | that have any special meaning are certain symbols, all of them keywords. | |
4112 | ||
4113 | Every image descriptor must contain the property @code{:type | |
4114 | @var{type}} to specify the format of the image. The value of @var{type} | |
4115 | should be an image type symbol; for example, @code{xpm} for an image in | |
4116 | XPM format. | |
4117 | ||
4118 | Here is a list of other properties that are meaningful for all image | |
4119 | types: | |
4120 | ||
4121 | @table @code | |
4122 | @item :file @var{file} | |
4123 | The @code{:file} property says to load the image from file | |
4124 | @var{file}. If @var{file} is not an absolute file name, it is expanded | |
4125 | in @code{data-directory}. | |
4126 | ||
4127 | @item :data @var{data} | |
4128 | The @code{:data} property says the actual contents of the image. | |
4129 | Each image must use either @code{:data} or @code{:file}, but not both. | |
4130 | For most image types, the value of the @code{:data} property should be a | |
4131 | string containing the image data; we recommend using a unibyte string. | |
4132 | ||
4133 | Before using @code{:data}, look for further information in the section | |
4134 | below describing the specific image format. For some image types, | |
4135 | @code{:data} may not be supported; for some, it allows other data types; | |
4136 | for some, @code{:data} alone is not enough, so you need to use other | |
4137 | image properties along with @code{:data}. | |
4138 | ||
4139 | @item :margin @var{margin} | |
4140 | The @code{:margin} property specifies how many pixels to add as an | |
4141 | extra margin around the image. The value, @var{margin}, must be a | |
4142 | non-negative number, or a pair @code{(@var{x} . @var{y})} of such | |
4143 | numbers. If it is a pair, @var{x} specifies how many pixels to add | |
4144 | horizontally, and @var{y} specifies how many pixels to add vertically. | |
4145 | If @code{:margin} is not specified, the default is zero. | |
4146 | ||
4147 | @item :ascent @var{ascent} | |
4148 | The @code{:ascent} property specifies the amount of the image's | |
4149 | height to use for its ascent---that is, the part above the baseline. | |
4150 | The value, @var{ascent}, must be a number in the range 0 to 100, or | |
4151 | the symbol @code{center}. | |
4152 | ||
4153 | If @var{ascent} is a number, that percentage of the image's height is | |
4154 | used for its ascent. | |
4155 | ||
4156 | If @var{ascent} is @code{center}, the image is vertically centered | |
4157 | around a centerline which would be the vertical centerline of text drawn | |
4158 | at the position of the image, in the manner specified by the text | |
4159 | properties and overlays that apply to the image. | |
4160 | ||
4161 | If this property is omitted, it defaults to 50. | |
4162 | ||
4163 | @item :relief @var{relief} | |
4164 | The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle | |
4165 | around the image. The value, @var{relief}, specifies the width of the | |
4166 | shadow lines, in pixels. If @var{relief} is negative, shadows are drawn | |
4167 | so that the image appears as a pressed button; otherwise, it appears as | |
4168 | an unpressed button. | |
4169 | ||
4170 | @item :conversion @var{algorithm} | |
4171 | The @code{:conversion} property, if non-@code{nil}, specifies a | |
4172 | conversion algorithm that should be applied to the image before it is | |
4173 | displayed; the value, @var{algorithm}, specifies which algorithm. | |
4174 | ||
4175 | @table @code | |
4176 | @item laplace | |
4177 | @itemx emboss | |
4178 | Specifies the Laplace edge detection algorithm, which blurs out small | |
4179 | differences in color while highlighting larger differences. People | |
4180 | sometimes consider this useful for displaying the image for a | |
4181 | ``disabled'' button. | |
4182 | ||
4183 | @item (edge-detection :matrix @var{matrix} :color-adjust @var{adjust}) | |
4184 | Specifies a general edge-detection algorithm. @var{matrix} must be | |
4185 | either a nine-element list or a nine-element vector of numbers. A pixel | |
4186 | at position @math{x/y} in the transformed image is computed from | |
4187 | original pixels around that position. @var{matrix} specifies, for each | |
4188 | pixel in the neighborhood of @math{x/y}, a factor with which that pixel | |
4189 | will influence the transformed pixel; element @math{0} specifies the | |
4190 | factor for the pixel at @math{x-1/y-1}, element @math{1} the factor for | |
4191 | the pixel at @math{x/y-1} etc., as shown below: | |
4192 | @iftex | |
4193 | @tex | |
4194 | $$\pmatrix{x-1/y-1 & x/y-1 & x+1/y-1 \cr | |
4195 | x-1/y & x/y & x+1/y \cr | |
4196 | x-1/y+1& x/y+1 & x+1/y+1 \cr}$$ | |
4197 | @end tex | |
4198 | @end iftex | |
4199 | @ifnottex | |
4200 | @display | |
4201 | (x-1/y-1 x/y-1 x+1/y-1 | |
4202 | x-1/y x/y x+1/y | |
4203 | x-1/y+1 x/y+1 x+1/y+1) | |
4204 | @end display | |
4205 | @end ifnottex | |
4206 | ||
4207 | The resulting pixel is computed from the color intensity of the color | |
4208 | resulting from summing up the RGB values of surrounding pixels, | |
4209 | multiplied by the specified factors, and dividing that sum by the sum | |
4210 | of the factors' absolute values. | |
4211 | ||
4212 | Laplace edge-detection currently uses a matrix of | |
4213 | @iftex | |
4214 | @tex | |
4215 | $$\pmatrix{1 & 0 & 0 \cr | |
4216 | 0& 0 & 0 \cr | |
4217 | 9 & 9 & -1 \cr}$$ | |
4218 | @end tex | |
4219 | @end iftex | |
4220 | @ifnottex | |
4221 | @display | |
4222 | (1 0 0 | |
4223 | 0 0 0 | |
4224 | 9 9 -1) | |
4225 | @end display | |
4226 | @end ifnottex | |
4227 | ||
4228 | Emboss edge-detection uses a matrix of | |
4229 | @iftex | |
4230 | @tex | |
4231 | $$\pmatrix{ 2 & -1 & 0 \cr | |
4232 | -1 & 0 & 1 \cr | |
4233 | 0 & 1 & -2 \cr}$$ | |
4234 | @end tex | |
4235 | @end iftex | |
4236 | @ifnottex | |
4237 | @display | |
4238 | ( 2 -1 0 | |
4239 | -1 0 1 | |
4240 | 0 1 -2) | |
4241 | @end display | |
4242 | @end ifnottex | |
4243 | ||
4244 | @item disabled | |
4245 | Specifies transforming the image so that it looks ``disabled.'' | |
4246 | @end table | |
4247 | ||
4248 | @item :mask @var{mask} | |
4249 | If @var{mask} is @code{heuristic} or @code{(heuristic @var{bg})}, build | |
4250 | a clipping mask for the image, so that the background of a frame is | |
4251 | visible behind the image. If @var{bg} is not specified, or if @var{bg} | |
4252 | is @code{t}, determine the background color of the image by looking at | |
4253 | the four corners of the image, assuming the most frequently occurring | |
4254 | color from the corners is the background color of the image. Otherwise, | |
4255 | @var{bg} must be a list @code{(@var{red} @var{green} @var{blue})} | |
4256 | specifying the color to assume for the background of the image. | |
4257 | ||
4258 | If @var{mask} is @code{nil}, remove a mask from the image, if it has | |
4259 | one. Images in some formats include a mask which can be removed by | |
4260 | specifying @code{:mask nil}. | |
4261 | ||
4262 | @item :pointer @var{shape} | |
4263 | This specifies the pointer shape when the mouse pointer is over this | |
4264 | image. @xref{Pointer Shape}, for available pointer shapes. | |
4265 | ||
4266 | @item :map @var{map} | |
4267 | This associates an image map of @dfn{hot spots} with this image. | |
4268 | ||
4269 | An image map is an alist where each element has the format | |
4270 | @code{(@var{area} @var{id} @var{plist})}. An @var{area} is specified | |
4271 | as either a rectangle, a circle, or a polygon. | |
4272 | ||
4273 | A rectangle is a cons | |
4274 | @code{(rect . ((@var{x0} . @var{y0}) . (@var{x1} . @var{y1})))} | |
4275 | which specifies the pixel coordinates of the upper left and bottom right | |
4276 | corners of the rectangle area. | |
4277 | ||
4278 | A circle is a cons | |
4279 | @code{(circle . ((@var{x0} . @var{y0}) . @var{r}))} | |
4280 | which specifies the center and the radius of the circle; @var{r} may | |
4281 | be a float or integer. | |
4282 | ||
4283 | A polygon is a cons | |
4284 | @code{(poly . [@var{x0} @var{y0} @var{x1} @var{y1} ...])} | |
4285 | where each pair in the vector describes one corner in the polygon. | |
4286 | ||
4287 | When the mouse pointer lies on a hot-spot area of an image, the | |
4288 | @var{plist} of that hot-spot is consulted; if it contains a @code{help-echo} | |
4289 | property, that defines a tool-tip for the hot-spot, and if it contains | |
4290 | a @code{pointer} property, that defines the shape of the mouse cursor when | |
4291 | it is on the hot-spot. | |
4292 | @xref{Pointer Shape}, for available pointer shapes. | |
4293 | ||
4294 | When you click the mouse when the mouse pointer is over a hot-spot, an | |
4295 | event is composed by combining the @var{id} of the hot-spot with the | |
4296 | mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's | |
4297 | @var{id} is @code{area4}. | |
4298 | @end table | |
4299 | ||
4300 | @defun image-mask-p spec &optional frame | |
4301 | This function returns @code{t} if image @var{spec} has a mask bitmap. | |
4302 | @var{frame} is the frame on which the image will be displayed. | |
4303 | @var{frame} @code{nil} or omitted means to use the selected frame | |
4304 | (@pxref{Input Focus}). | |
4305 | @end defun | |
4306 | ||
4307 | @node XBM Images | |
4308 | @subsection XBM Images | |
4309 | @cindex XBM | |
4310 | ||
4311 | To use XBM format, specify @code{xbm} as the image type. This image | |
4312 | format doesn't require an external library, so images of this type are | |
4313 | always supported. | |
4314 | ||
4315 | Additional image properties supported for the @code{xbm} image type are: | |
4316 | ||
4317 | @table @code | |
4318 | @item :foreground @var{foreground} | |
4319 | The value, @var{foreground}, should be a string specifying the image | |
4320 | foreground color, or @code{nil} for the default color. This color is | |
4321 | used for each pixel in the XBM that is 1. The default is the frame's | |
4322 | foreground color. | |
4323 | ||
4324 | @item :background @var{background} | |
4325 | The value, @var{background}, should be a string specifying the image | |
4326 | background color, or @code{nil} for the default color. This color is | |
4327 | used for each pixel in the XBM that is 0. The default is the frame's | |
4328 | background color. | |
4329 | @end table | |
4330 | ||
4331 | If you specify an XBM image using data within Emacs instead of an | |
4332 | external file, use the following three properties: | |
4333 | ||
4334 | @table @code | |
4335 | @item :data @var{data} | |
4336 | The value, @var{data}, specifies the contents of the image. | |
4337 | There are three formats you can use for @var{data}: | |
4338 | ||
4339 | @itemize @bullet | |
4340 | @item | |
4341 | A vector of strings or bool-vectors, each specifying one line of the | |
4342 | image. Do specify @code{:height} and @code{:width}. | |
4343 | ||
4344 | @item | |
4345 | A string containing the same byte sequence as an XBM file would contain. | |
4346 | You must not specify @code{:height} and @code{:width} in this case, | |
4347 | because omitting them is what indicates the data has the format of an | |
4348 | XBM file. The file contents specify the height and width of the image. | |
4349 | ||
4350 | @item | |
4351 | A string or a bool-vector containing the bits of the image (plus perhaps | |
4352 | some extra bits at the end that will not be used). It should contain at | |
4353 | least @var{width} * @code{height} bits. In this case, you must specify | |
4354 | @code{:height} and @code{:width}, both to indicate that the string | |
4355 | contains just the bits rather than a whole XBM file, and to specify the | |
4356 | size of the image. | |
4357 | @end itemize | |
4358 | ||
4359 | @item :width @var{width} | |
4360 | The value, @var{width}, specifies the width of the image, in pixels. | |
4361 | ||
4362 | @item :height @var{height} | |
4363 | The value, @var{height}, specifies the height of the image, in pixels. | |
4364 | @end table | |
4365 | ||
4366 | @node XPM Images | |
4367 | @subsection XPM Images | |
4368 | @cindex XPM | |
4369 | ||
4370 | To use XPM format, specify @code{xpm} as the image type. The | |
4371 | additional image property @code{:color-symbols} is also meaningful with | |
4372 | the @code{xpm} image type: | |
4373 | ||
4374 | @table @code | |
4375 | @item :color-symbols @var{symbols} | |
4376 | The value, @var{symbols}, should be an alist whose elements have the | |
4377 | form @code{(@var{name} . @var{color})}. In each element, @var{name} is | |
4378 | the name of a color as it appears in the image file, and @var{color} | |
4379 | specifies the actual color to use for displaying that name. | |
4380 | @end table | |
4381 | ||
4382 | @node GIF Images | |
4383 | @subsection GIF Images | |
4384 | @cindex GIF | |
4385 | ||
4386 | For GIF images, specify image type @code{gif}. | |
4387 | ||
4388 | @table @code | |
4389 | @item :index @var{index} | |
4390 | You can use @code{:index} to specify one image from a GIF file that | |
4391 | contains more than one image. This property specifies use of image | |
4392 | number @var{index} from the file. If the GIF file doesn't contain an | |
4393 | image with index @var{index}, the image displays as a hollow box. | |
4394 | @end table | |
4395 | ||
4396 | @ignore | |
4397 | This could be used to implement limited support for animated GIFs. | |
4398 | For example, the following function displays a multi-image GIF file | |
4399 | at point-min in the current buffer, switching between sub-images | |
4400 | every 0.1 seconds. | |
4401 | ||
4402 | (defun show-anim (file max) | |
4403 | "Display multi-image GIF file FILE which contains MAX subimages." | |
4404 | (display-anim (current-buffer) file 0 max t)) | |
4405 | ||
4406 | (defun display-anim (buffer file idx max first-time) | |
4407 | (when (= idx max) | |
4408 | (setq idx 0)) | |
4409 | (let ((img (create-image file nil :image idx))) | |
c57008f6 | 4410 | (with-current-buffer buffer |
b8d4c8d0 GM |
4411 | (goto-char (point-min)) |
4412 | (unless first-time (delete-char 1)) | |
4413 | (insert-image img)) | |
4414 | (run-with-timer 0.1 nil 'display-anim buffer file (1+ idx) max nil))) | |
4415 | @end ignore | |
4416 | ||
905a9adb JR |
4417 | @node TIFF Images |
4418 | @subsection TIFF Images | |
4419 | @cindex TIFF | |
4420 | ||
4421 | For TIFF images, specify image type @code{tiff}. | |
4422 | ||
4423 | @table @code | |
4424 | @item :index @var{index} | |
4425 | You can use @code{:index} to specify one image from a TIFF file that | |
4426 | contains more than one image. This property specifies use of image | |
4427 | number @var{index} from the file. If the TIFF file doesn't contain an | |
4428 | image with index @var{index}, the image displays as a hollow box. | |
4429 | @end table | |
4430 | ||
2833b3ff CY |
4431 | @node PostScript Images |
4432 | @subsection PostScript Images | |
4433 | @cindex postscript images | |
4434 | ||
4435 | To use PostScript for an image, specify image type @code{postscript}. | |
4436 | This works only if you have Ghostscript installed. You must always use | |
4437 | these three properties: | |
4438 | ||
4439 | @table @code | |
4440 | @item :pt-width @var{width} | |
4441 | The value, @var{width}, specifies the width of the image measured in | |
4442 | points (1/72 inch). @var{width} must be an integer. | |
4443 | ||
4444 | @item :pt-height @var{height} | |
4445 | The value, @var{height}, specifies the height of the image in points | |
4446 | (1/72 inch). @var{height} must be an integer. | |
4447 | ||
4448 | @item :bounding-box @var{box} | |
4449 | The value, @var{box}, must be a list or vector of four integers, which | |
4450 | specifying the bounding box of the PostScript image, analogous to the | |
4451 | @samp{BoundingBox} comment found in PostScript files. | |
4452 | ||
4453 | @example | |
4454 | %%BoundingBox: 22 171 567 738 | |
4455 | @end example | |
4456 | @end table | |
4457 | ||
16a91140 JV |
4458 | @node ImageMagick Images |
4459 | @subsection ImageMagick Images | |
ca0d44e4 GM |
4460 | @cindex ImageMagick images |
4461 | @cindex images, support for more formats | |
4462 | ||
4463 | If you build Emacs with ImageMagick (@url{http://www.imagemagick.org}) | |
4464 | support, you can use the ImageMagick library to load many image formats. | |
4465 | ||
4466 | @findex imagemagick-types | |
4467 | The function @code{imagemagick-types} returns a list of image file | |
4468 | extensions that your installation of ImageMagick supports. To enable | |
4469 | support, you must call the function @code{imagemagick-register-types}. | |
4470 | ||
4471 | @vindex imagemagick-types-inhibit | |
4472 | The variable @code{imagemagick-types-inhibit} specifies a list of | |
4473 | image types that you do @emph{not} want ImageMagick to handle. There | |
4474 | may be overlap between image loaders in your Emacs installation, and | |
4475 | you may prefer to use a different one for a given image type (which | |
4476 | @c FIXME how is this priority determined? | |
4477 | loader will be used in practice depends on the priority of the loaders). | |
4478 | @c FIXME why are these uppercase when image-types is lower-case? | |
4479 | @c FIXME what are the possibe options? Are these actually file extensions? | |
4480 | For example, if you never want to use the ImageMagick loader to use | |
4481 | JPEG files, add @code{JPG} to this list. | |
4482 | ||
4483 | @vindex imagemagick-render-type | |
4484 | You can set the variable @code{imagemagick-render-type} to choose | |
4485 | between screen render methods for the ImageMagick loader. The options | |
4486 | are: @code{0}, a conservative method which works with older | |
4487 | @c FIXME details of this "newer method"? | |
4488 | @c Presumably it is faster but may be less "robust"? | |
4489 | ImageMagick versions (it is a bit slow, but robust); and @code{1}, | |
4490 | a newer ImageMagick method. | |
4491 | ||
4492 | Images loaded with ImageMagick support a few new display specifications: | |
16a91140 | 4493 | |
ca0d44e4 GM |
4494 | @table @code |
4495 | @item :width, :height | |
4496 | The @code{:width} and @code{:height} keywords are used for scaling the | |
4497 | image. If only one of them is specified, the other one will be | |
4498 | calculated so as to preserve the aspect ratio. If both are specified, | |
4499 | aspect ratio may not be preserved. | |
4500 | ||
4501 | @item :rotation | |
4502 | Specifies a rotation angle in degrees. | |
4503 | ||
4504 | @item :index | |
4505 | Specifies which image to view inside an image bundle file format, such | |
4506 | as TIFF or DJVM. You can use the @code{image-metadata} function to | |
4507 | retrieve the total number of images in an image bundle (this is | |
4508 | similar to how GIF files work). | |
4509 | @end table | |
16a91140 JV |
4510 | |
4511 | ||
b8d4c8d0 GM |
4512 | @node Other Image Types |
4513 | @subsection Other Image Types | |
4514 | @cindex PBM | |
4515 | ||
4516 | For PBM images, specify image type @code{pbm}. Color, gray-scale and | |
4517 | monochromatic images are supported. For mono PBM images, two additional | |
4518 | image properties are supported. | |
4519 | ||
4520 | @table @code | |
4521 | @item :foreground @var{foreground} | |
4522 | The value, @var{foreground}, should be a string specifying the image | |
4523 | foreground color, or @code{nil} for the default color. This color is | |
3696411e | 4524 | used for each pixel in the PBM that is 1. The default is the frame's |
b8d4c8d0 GM |
4525 | foreground color. |
4526 | ||
4527 | @item :background @var{background} | |
4528 | The value, @var{background}, should be a string specifying the image | |
4529 | background color, or @code{nil} for the default color. This color is | |
3696411e | 4530 | used for each pixel in the PBM that is 0. The default is the frame's |
b8d4c8d0 GM |
4531 | background color. |
4532 | @end table | |
4533 | ||
4534 | For JPEG images, specify image type @code{jpeg}. | |
4535 | ||
4536 | For TIFF images, specify image type @code{tiff}. | |
4537 | ||
4538 | For PNG images, specify image type @code{png}. | |
4539 | ||
4540 | For SVG images, specify image type @code{svg}. | |
4541 | ||
4542 | @node Defining Images | |
4543 | @subsection Defining Images | |
4544 | ||
4545 | The functions @code{create-image}, @code{defimage} and | |
4546 | @code{find-image} provide convenient ways to create image descriptors. | |
4547 | ||
4548 | @defun create-image file-or-data &optional type data-p &rest props | |
4549 | This function creates and returns an image descriptor which uses the | |
4550 | data in @var{file-or-data}. @var{file-or-data} can be a file name or | |
4551 | a string containing the image data; @var{data-p} should be @code{nil} | |
4552 | for the former case, non-@code{nil} for the latter case. | |
4553 | ||
4554 | The optional argument @var{type} is a symbol specifying the image type. | |
4555 | If @var{type} is omitted or @code{nil}, @code{create-image} tries to | |
4556 | determine the image type from the file's first few bytes, or else | |
4557 | from the file's name. | |
4558 | ||
4559 | The remaining arguments, @var{props}, specify additional image | |
4560 | properties---for example, | |
4561 | ||
4562 | @example | |
4563 | (create-image "foo.xpm" 'xpm nil :heuristic-mask t) | |
4564 | @end example | |
4565 | ||
4566 | The function returns @code{nil} if images of this type are not | |
4567 | supported. Otherwise it returns an image descriptor. | |
4568 | @end defun | |
4569 | ||
4570 | @defmac defimage symbol specs &optional doc | |
4571 | This macro defines @var{symbol} as an image name. The arguments | |
4572 | @var{specs} is a list which specifies how to display the image. | |
4573 | The third argument, @var{doc}, is an optional documentation string. | |
4574 | ||
4575 | Each argument in @var{specs} has the form of a property list, and each | |
4576 | one should specify at least the @code{:type} property and either the | |
4577 | @code{:file} or the @code{:data} property. The value of @code{:type} | |
4578 | should be a symbol specifying the image type, the value of | |
4579 | @code{:file} is the file to load the image from, and the value of | |
4580 | @code{:data} is a string containing the actual image data. Here is an | |
4581 | example: | |
4582 | ||
4583 | @example | |
4584 | (defimage test-image | |
4585 | ((:type xpm :file "~/test1.xpm") | |
4586 | (:type xbm :file "~/test1.xbm"))) | |
4587 | @end example | |
4588 | ||
4589 | @code{defimage} tests each argument, one by one, to see if it is | |
4590 | usable---that is, if the type is supported and the file exists. The | |
4591 | first usable argument is used to make an image descriptor which is | |
4592 | stored in @var{symbol}. | |
4593 | ||
4594 | If none of the alternatives will work, then @var{symbol} is defined | |
4595 | as @code{nil}. | |
4596 | @end defmac | |
4597 | ||
4598 | @defun find-image specs | |
4599 | This function provides a convenient way to find an image satisfying one | |
4600 | of a list of image specifications @var{specs}. | |
4601 | ||
4602 | Each specification in @var{specs} is a property list with contents | |
4603 | depending on image type. All specifications must at least contain the | |
4604 | properties @code{:type @var{type}} and either @w{@code{:file @var{file}}} | |
4605 | or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying | |
4606 | the image type, e.g.@: @code{xbm}, @var{file} is the file to load the | |
4607 | image from, and @var{data} is a string containing the actual image data. | |
4608 | The first specification in the list whose @var{type} is supported, and | |
4609 | @var{file} exists, is used to construct the image specification to be | |
4610 | returned. If no specification is satisfied, @code{nil} is returned. | |
4611 | ||
4612 | The image is looked for in @code{image-load-path}. | |
4613 | @end defun | |
4614 | ||
4615 | @defvar image-load-path | |
4616 | This variable's value is a list of locations in which to search for | |
4617 | image files. If an element is a string or a variable symbol whose | |
4618 | value is a string, the string is taken to be the name of a directory | |
4619 | to search. If an element is a variable symbol whose value is a list, | |
4620 | that is taken to be a list of directory names to search. | |
4621 | ||
4622 | The default is to search in the @file{images} subdirectory of the | |
4623 | directory specified by @code{data-directory}, then the directory | |
4624 | specified by @code{data-directory}, and finally in the directories in | |
4625 | @code{load-path}. Subdirectories are not automatically included in | |
4626 | the search, so if you put an image file in a subdirectory, you have to | |
4627 | supply the subdirectory name explicitly. For example, to find the | |
4628 | image @file{images/foo/bar.xpm} within @code{data-directory}, you | |
4629 | should specify the image as follows: | |
4630 | ||
4631 | @example | |
4632 | (defimage foo-image '((:type xpm :file "foo/bar.xpm"))) | |
4633 | @end example | |
4634 | @end defvar | |
4635 | ||
4636 | @defun image-load-path-for-library library image &optional path no-error | |
4637 | This function returns a suitable search path for images used by the | |
4638 | Lisp package @var{library}. | |
4639 | ||
4640 | The function searches for @var{image} first using @code{image-load-path}, | |
4641 | excluding @file{@code{data-directory}/images}, and then in | |
4642 | @code{load-path}, followed by a path suitable for @var{library}, which | |
4643 | includes @file{../../etc/images} and @file{../etc/images} relative to | |
4644 | the library file itself, and finally in | |
4645 | @file{@code{data-directory}/images}. | |
4646 | ||
4647 | Then this function returns a list of directories which contains first | |
4648 | the directory in which @var{image} was found, followed by the value of | |
4649 | @code{load-path}. If @var{path} is given, it is used instead of | |
4650 | @code{load-path}. | |
4651 | ||
4652 | If @var{no-error} is non-@code{nil} and a suitable path can't be | |
4653 | found, don't signal an error. Instead, return a list of directories as | |
4654 | before, except that @code{nil} appears in place of the image directory. | |
4655 | ||
4656 | Here is an example that uses a common idiom to provide compatibility | |
4657 | with versions of Emacs that lack the variable @code{image-load-path}: | |
4658 | ||
4659 | @example | |
4660 | (defvar image-load-path) ; shush compiler | |
4661 | (let* ((load-path (image-load-path-for-library | |
4662 | "mh-e" "mh-logo.xpm")) | |
4663 | (image-load-path (cons (car load-path) | |
4664 | (when (boundp 'image-load-path) | |
4665 | image-load-path)))) | |
4666 | (mh-tool-bar-folder-buttons-init)) | |
4667 | @end example | |
4668 | @end defun | |
4669 | ||
4670 | @node Showing Images | |
4671 | @subsection Showing Images | |
4672 | ||
4673 | You can use an image descriptor by setting up the @code{display} | |
4674 | property yourself, but it is easier to use the functions in this | |
4675 | section. | |
4676 | ||
4677 | @defun insert-image image &optional string area slice | |
4678 | This function inserts @var{image} in the current buffer at point. The | |
4679 | value @var{image} should be an image descriptor; it could be a value | |
4680 | returned by @code{create-image}, or the value of a symbol defined with | |
4681 | @code{defimage}. The argument @var{string} specifies the text to put | |
4682 | in the buffer to hold the image. If it is omitted or @code{nil}, | |
4683 | @code{insert-image} uses @code{" "} by default. | |
4684 | ||
4685 | The argument @var{area} specifies whether to put the image in a margin. | |
4686 | If it is @code{left-margin}, the image appears in the left margin; | |
4687 | @code{right-margin} specifies the right margin. If @var{area} is | |
4688 | @code{nil} or omitted, the image is displayed at point within the | |
4689 | buffer's text. | |
4690 | ||
4691 | The argument @var{slice} specifies a slice of the image to insert. If | |
4692 | @var{slice} is @code{nil} or omitted the whole image is inserted. | |
4693 | Otherwise, @var{slice} is a list @code{(@var{x} @var{y} @var{width} | |
4694 | @var{height})} which specifies the @var{x} and @var{y} positions and | |
4695 | @var{width} and @var{height} of the image area to insert. Integer | |
4696 | values are in units of pixels. A floating point number in the range | |
4697 | 0.0--1.0 stands for that fraction of the width or height of the entire | |
4698 | image. | |
4699 | ||
4700 | Internally, this function inserts @var{string} in the buffer, and gives | |
4701 | it a @code{display} property which specifies @var{image}. @xref{Display | |
4702 | Property}. | |
4703 | @end defun | |
4704 | ||
4705 | @defun insert-sliced-image image &optional string area rows cols | |
4706 | This function inserts @var{image} in the current buffer at point, like | |
4707 | @code{insert-image}, but splits the image into @var{rows}x@var{cols} | |
4708 | equally sized slices. | |
4709 | @end defun | |
4710 | ||
4711 | @defun put-image image pos &optional string area | |
4712 | This function puts image @var{image} in front of @var{pos} in the | |
4713 | current buffer. The argument @var{pos} should be an integer or a | |
4714 | marker. It specifies the buffer position where the image should appear. | |
4715 | The argument @var{string} specifies the text that should hold the image | |
4716 | as an alternative to the default. | |
4717 | ||
4718 | The argument @var{image} must be an image descriptor, perhaps returned | |
4719 | by @code{create-image} or stored by @code{defimage}. | |
4720 | ||
4721 | The argument @var{area} specifies whether to put the image in a margin. | |
4722 | If it is @code{left-margin}, the image appears in the left margin; | |
4723 | @code{right-margin} specifies the right margin. If @var{area} is | |
4724 | @code{nil} or omitted, the image is displayed at point within the | |
4725 | buffer's text. | |
4726 | ||
4727 | Internally, this function creates an overlay, and gives it a | |
4728 | @code{before-string} property containing text that has a @code{display} | |
4729 | property whose value is the image. (Whew!) | |
4730 | @end defun | |
4731 | ||
4732 | @defun remove-images start end &optional buffer | |
4733 | This function removes images in @var{buffer} between positions | |
4734 | @var{start} and @var{end}. If @var{buffer} is omitted or @code{nil}, | |
4735 | images are removed from the current buffer. | |
4736 | ||
4737 | This removes only images that were put into @var{buffer} the way | |
4738 | @code{put-image} does it, not images that were inserted with | |
4739 | @code{insert-image} or in other ways. | |
4740 | @end defun | |
4741 | ||
4742 | @defun image-size spec &optional pixels frame | |
4743 | This function returns the size of an image as a pair | |
4744 | @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image | |
4745 | specification. @var{pixels} non-@code{nil} means return sizes | |
4746 | measured in pixels, otherwise return sizes measured in canonical | |
4747 | character units (fractions of the width/height of the frame's default | |
4748 | font). @var{frame} is the frame on which the image will be displayed. | |
4749 | @var{frame} null or omitted means use the selected frame (@pxref{Input | |
4750 | Focus}). | |
4751 | @end defun | |
4752 | ||
4753 | @defvar max-image-size | |
4754 | This variable is used to define the maximum size of image that Emacs | |
4755 | will load. Emacs will refuse to load (and display) any image that is | |
4756 | larger than this limit. | |
4757 | ||
4758 | If the value is an integer, it directly specifies the maximum | |
4759 | image height and width, measured in pixels. If it is a floating | |
4760 | point number, it specifies the maximum image height and width | |
4761 | as a ratio to the frame height and width. If the value is | |
4762 | non-numeric, there is no explicit limit on the size of images. | |
4763 | ||
4764 | The purpose of this variable is to prevent unreasonably large images | |
4765 | from accidentally being loaded into Emacs. It only takes effect the | |
4766 | first time an image is loaded. Once an image is placed in the image | |
4767 | cache, it can always be displayed, even if the value of | |
4768 | @var{max-image-size} is subsequently changed (@pxref{Image Cache}). | |
4769 | @end defvar | |
4770 | ||
4771 | @node Image Cache | |
4772 | @subsection Image Cache | |
4773 | @cindex image cache | |
4774 | ||
0c1cfe01 CY |
4775 | Emacs caches images so that it can display them again more |
4776 | efficiently. When Emacs displays an image, it searches the image | |
4777 | cache for an existing image specification @code{equal} to the desired | |
4778 | specification. If a match is found, the image is displayed from the | |
110683ad CY |
4779 | cache. Otherwise, Emacs loads the image normally. |
4780 | ||
4781 | @defun image-flush spec &optional frame | |
4782 | This function removes the image with specification @var{spec} from the | |
4783 | image cache of frame @var{frame}. Image specifications are compared | |
4784 | using @code{equal}. If @var{frame} is @code{nil}, it defaults to the | |
4785 | selected frame. If @var{frame} is @code{t}, the image is flushed on | |
4786 | all existing frames. | |
4787 | ||
4788 | In Emacs' current implementation, each graphical terminal possesses an | |
4789 | image cache, which is shared by all the frames on that terminal | |
0c1cfe01 CY |
4790 | (@pxref{Multiple Terminals}). Thus, refreshing an image in one frame |
4791 | also refreshes it in all other frames on the same terminal. | |
b8d4c8d0 GM |
4792 | @end defun |
4793 | ||
110683ad CY |
4794 | One use for @code{image-flush} is to tell Emacs about a change in an |
4795 | image file. If an image specification contains a @code{:file} | |
4796 | property, the image is cached based on the file's contents when the | |
4797 | image is first displayed. Even if the file subsequently changes, | |
4798 | Emacs continues displaying the old version of the image. Calling | |
4799 | @code{image-flush} flushes the image from the cache, forcing Emacs to | |
4800 | re-read the file the next time it needs to display that image. | |
4801 | ||
4802 | Another use for @code{image-flush} is for memory conservation. If | |
4803 | your Lisp program creates a large number of temporary images over a | |
4804 | period much shorter than @code{image-cache-eviction-delay} (see | |
4805 | below), you can opt to flush unused images yourself, instead of | |
4806 | waiting for Emacs to do it automatically. | |
4807 | ||
a2bc5bdd | 4808 | @defun clear-image-cache &optional filter |
0c1cfe01 CY |
4809 | This function clears an image cache, removing all the images stored in |
4810 | it. If @var{filter} is omitted or @code{nil}, it clears the cache for | |
4811 | the selected frame. If @var{filter} is a frame, it clears the cache | |
4812 | for that frame. If @var{filter} is @code{t}, all image caches are | |
4813 | cleared. Otherwise, @var{filter} is taken to be a file name, and all | |
4814 | images associated with that file name are removed from all image | |
4815 | caches. | |
b8d4c8d0 GM |
4816 | @end defun |
4817 | ||
4818 | If an image in the image cache has not been displayed for a specified | |
4819 | period of time, Emacs removes it from the cache and frees the | |
4820 | associated memory. | |
4821 | ||
4822 | @defvar image-cache-eviction-delay | |
110683ad CY |
4823 | This variable specifies the number of seconds an image can remain in |
4824 | the cache without being displayed. When an image is not displayed for | |
4825 | this length of time, Emacs removes it from the image cache. | |
4826 | ||
4827 | Under some circumstances, if the number of images in the cache grows | |
4828 | too large, the actual eviction delay may be shorter than this. | |
b8d4c8d0 GM |
4829 | |
4830 | If the value is @code{nil}, Emacs does not remove images from the cache | |
4831 | except when you explicitly clear it. This mode can be useful for | |
4832 | debugging. | |
4833 | @end defvar | |
4834 | ||
4835 | @node Buttons | |
4836 | @section Buttons | |
4837 | @cindex buttons in buffers | |
4838 | @cindex clickable buttons in buffers | |
4839 | ||
4840 | The @emph{button} package defines functions for inserting and | |
4841 | manipulating clickable (with the mouse, or via keyboard commands) | |
4842 | buttons in Emacs buffers, such as might be used for help hyper-links, | |
4843 | etc. Emacs uses buttons for the hyper-links in help text and the like. | |
4844 | ||
4845 | A button is essentially a set of properties attached (via text | |
4846 | properties or overlays) to a region of text in an Emacs buffer. These | |
4847 | properties are called @dfn{button properties}. | |
4848 | ||
4849 | One of these properties (@code{action}) is a function, which will | |
4850 | be called when the user invokes it using the keyboard or the mouse. | |
4851 | The invoked function may then examine the button and use its other | |
4852 | properties as desired. | |
4853 | ||
4854 | In some ways the Emacs button package duplicates functionality offered | |
4855 | by the widget package (@pxref{Top, , Introduction, widget, The Emacs | |
4856 | Widget Library}), but the button package has the advantage that it is | |
4857 | much faster, much smaller, and much simpler to use (for elisp | |
4858 | programmers---for users, the result is about the same). The extra | |
4859 | speed and space savings are useful mainly if you need to create many | |
4860 | buttons in a buffer (for instance an @code{*Apropos*} buffer uses | |
4861 | buttons to make entries clickable, and may contain many thousands of | |
4862 | entries). | |
4863 | ||
4864 | @menu | |
4865 | * Button Properties:: Button properties with special meanings. | |
4866 | * Button Types:: Defining common properties for classes of buttons. | |
4867 | * Making Buttons:: Adding buttons to Emacs buffers. | |
4868 | * Manipulating Buttons:: Getting and setting properties of buttons. | |
4869 | * Button Buffer Commands:: Buffer-wide commands and bindings for buttons. | |
4870 | @end menu | |
4871 | ||
4872 | @node Button Properties | |
4873 | @subsection Button Properties | |
4874 | @cindex button properties | |
4875 | ||
4876 | Buttons have an associated list of properties defining their | |
4877 | appearance and behavior, and other arbitrary properties may be used | |
4878 | for application specific purposes. Some properties that have special | |
4879 | meaning to the button package include: | |
4880 | ||
4881 | @table @code | |
4882 | @item action | |
4883 | @kindex action @r{(button property)} | |
4884 | The function to call when the user invokes the button, which is passed | |
4885 | the single argument @var{button}. By default this is @code{ignore}, | |
4886 | which does nothing. | |
4887 | ||
4888 | @item mouse-action | |
4889 | @kindex mouse-action @r{(button property)} | |
4890 | This is similar to @code{action}, and when present, will be used | |
4891 | instead of @code{action} for button invocations resulting from | |
4892 | mouse-clicks (instead of the user hitting @key{RET}). If not | |
4893 | present, mouse-clicks use @code{action} instead. | |
4894 | ||
4895 | @item face | |
4896 | @kindex face @r{(button property)} | |
4897 | This is an Emacs face controlling how buttons of this type are | |
4898 | displayed; by default this is the @code{button} face. | |
4899 | ||
4900 | @item mouse-face | |
4901 | @kindex mouse-face @r{(button property)} | |
4902 | This is an additional face which controls appearance during | |
4903 | mouse-overs (merged with the usual button face); by default this is | |
4904 | the usual Emacs @code{highlight} face. | |
4905 | ||
4906 | @item keymap | |
4907 | @kindex keymap @r{(button property)} | |
4908 | The button's keymap, defining bindings active within the button | |
4909 | region. By default this is the usual button region keymap, stored | |
4910 | in the variable @code{button-map}, which defines @key{RET} and | |
4911 | @key{mouse-2} to invoke the button. | |
4912 | ||
4913 | @item type | |
4914 | @kindex type @r{(button property)} | |
4915 | The button-type of the button. When creating a button, this is | |
4916 | usually specified using the @code{:type} keyword argument. | |
4917 | @xref{Button Types}. | |
4918 | ||
4919 | @item help-echo | |
4920 | @kindex help-index @r{(button property)} | |
4921 | A string displayed by the Emacs tool-tip help system; by default, | |
4922 | @code{"mouse-2, RET: Push this button"}. | |
4923 | ||
4924 | @item follow-link | |
4925 | @kindex follow-link @r{(button property)} | |
4926 | The follow-link property, defining how a @key{Mouse-1} click behaves | |
2bad3299 | 4927 | on this button, @xref{Clickable Text}. |
b8d4c8d0 GM |
4928 | |
4929 | @item button | |
4930 | @kindex button @r{(button property)} | |
4931 | All buttons have a non-@code{nil} @code{button} property, which may be useful | |
4932 | in finding regions of text that comprise buttons (which is what the | |
4933 | standard button functions do). | |
4934 | @end table | |
4935 | ||
4936 | There are other properties defined for the regions of text in a | |
4937 | button, but these are not generally interesting for typical uses. | |
4938 | ||
4939 | @node Button Types | |
4940 | @subsection Button Types | |
4941 | @cindex button types | |
4942 | ||
4943 | Every button has a button @emph{type}, which defines default values | |
4944 | for the button's properties. Button types are arranged in a | |
4945 | hierarchy, with specialized types inheriting from more general types, | |
4946 | so that it's easy to define special-purpose types of buttons for | |
4947 | specific tasks. | |
4948 | ||
4949 | @defun define-button-type name &rest properties | |
1a256502 TTN |
4950 | Define a `button type' called @var{name} (a symbol). |
4951 | The remaining arguments | |
b8d4c8d0 GM |
4952 | form a sequence of @var{property value} pairs, specifying default |
4953 | property values for buttons with this type (a button's type may be set | |
4954 | by giving it a @code{type} property when creating the button, using | |
4955 | the @code{:type} keyword argument). | |
4956 | ||
4957 | In addition, the keyword argument @code{:supertype} may be used to | |
4958 | specify a button-type from which @var{name} inherits its default | |
4959 | property values. Note that this inheritance happens only when | |
4960 | @var{name} is defined; subsequent changes to a supertype are not | |
4961 | reflected in its subtypes. | |
4962 | @end defun | |
4963 | ||
4964 | Using @code{define-button-type} to define default properties for | |
4965 | buttons is not necessary---buttons without any specified type use the | |
4966 | built-in button-type @code{button}---but it is encouraged, since | |
4967 | doing so usually makes the resulting code clearer and more efficient. | |
4968 | ||
4969 | @node Making Buttons | |
4970 | @subsection Making Buttons | |
4971 | @cindex making buttons | |
4972 | ||
4973 | Buttons are associated with a region of text, using an overlay or | |
4974 | text properties to hold button-specific information, all of which are | |
4975 | initialized from the button's type (which defaults to the built-in | |
4976 | button type @code{button}). Like all Emacs text, the appearance of | |
4977 | the button is governed by the @code{face} property; by default (via | |
4978 | the @code{face} property inherited from the @code{button} button-type) | |
4979 | this is a simple underline, like a typical web-page link. | |
4980 | ||
4981 | For convenience, there are two sorts of button-creation functions, | |
4982 | those that add button properties to an existing region of a buffer, | |
4983 | called @code{make-...button}, and those that also insert the button | |
4984 | text, called @code{insert-...button}. | |
4985 | ||
4986 | The button-creation functions all take the @code{&rest} argument | |
4987 | @var{properties}, which should be a sequence of @var{property value} | |
4988 | pairs, specifying properties to add to the button; see @ref{Button | |
4989 | Properties}. In addition, the keyword argument @code{:type} may be | |
4990 | used to specify a button-type from which to inherit other properties; | |
4991 | see @ref{Button Types}. Any properties not explicitly specified | |
4992 | during creation will be inherited from the button's type (if the type | |
4993 | defines such a property). | |
4994 | ||
4995 | The following functions add a button using an overlay | |
4996 | (@pxref{Overlays}) to hold the button properties: | |
4997 | ||
4998 | @defun make-button beg end &rest properties | |
4999 | This makes a button from @var{beg} to @var{end} in the | |
5000 | current buffer, and returns it. | |
5001 | @end defun | |
5002 | ||
5003 | @defun insert-button label &rest properties | |
5004 | This insert a button with the label @var{label} at point, | |
5005 | and returns it. | |
5006 | @end defun | |
5007 | ||
5008 | The following functions are similar, but use Emacs text properties | |
5009 | (@pxref{Text Properties}) to hold the button properties, making the | |
5010 | button actually part of the text instead of being a property of the | |
5011 | buffer. Buttons using text properties do not create markers into the | |
5012 | buffer, which is important for speed when you use extremely large | |
4d265b4d GM |
5013 | numbers of buttons. (However, if there is an existing face text |
5014 | property at the site of the button, the button face may not be visible.) | |
5015 | Both functions return the position of the start of the new button: | |
b8d4c8d0 GM |
5016 | |
5017 | @defun make-text-button beg end &rest properties | |
5018 | This makes a button from @var{beg} to @var{end} in the current buffer, using | |
5019 | text properties. | |
5020 | @end defun | |
5021 | ||
5022 | @defun insert-text-button label &rest properties | |
5023 | This inserts a button with the label @var{label} at point, using text | |
5024 | properties. | |
5025 | @end defun | |
5026 | ||
5027 | @node Manipulating Buttons | |
5028 | @subsection Manipulating Buttons | |
5029 | @cindex manipulating buttons | |
5030 | ||
5031 | These are functions for getting and setting properties of buttons. | |
5032 | Often these are used by a button's invocation function to determine | |
5033 | what to do. | |
5034 | ||
5035 | Where a @var{button} parameter is specified, it means an object | |
5036 | referring to a specific button, either an overlay (for overlay | |
5037 | buttons), or a buffer-position or marker (for text property buttons). | |
5038 | Such an object is passed as the first argument to a button's | |
5039 | invocation function when it is invoked. | |
5040 | ||
5041 | @defun button-start button | |
5042 | Return the position at which @var{button} starts. | |
5043 | @end defun | |
5044 | ||
5045 | @defun button-end button | |
5046 | Return the position at which @var{button} ends. | |
5047 | @end defun | |
5048 | ||
5049 | @defun button-get button prop | |
5050 | Get the property of button @var{button} named @var{prop}. | |
5051 | @end defun | |
5052 | ||
5053 | @defun button-put button prop val | |
5054 | Set @var{button}'s @var{prop} property to @var{val}. | |
5055 | @end defun | |
5056 | ||
5057 | @defun button-activate button &optional use-mouse-action | |
5058 | Call @var{button}'s @code{action} property (i.e., invoke it). If | |
5059 | @var{use-mouse-action} is non-@code{nil}, try to invoke the button's | |
5060 | @code{mouse-action} property instead of @code{action}; if the button | |
5061 | has no @code{mouse-action} property, use @code{action} as normal. | |
5062 | @end defun | |
5063 | ||
5064 | @defun button-label button | |
5065 | Return @var{button}'s text label. | |
5066 | @end defun | |
5067 | ||
5068 | @defun button-type button | |
5069 | Return @var{button}'s button-type. | |
5070 | @end defun | |
5071 | ||
5072 | @defun button-has-type-p button type | |
5073 | Return @code{t} if @var{button} has button-type @var{type}, or one of | |
5074 | @var{type}'s subtypes. | |
5075 | @end defun | |
5076 | ||
5077 | @defun button-at pos | |
5078 | Return the button at position @var{pos} in the current buffer, or @code{nil}. | |
5079 | @end defun | |
5080 | ||
5081 | @defun button-type-put type prop val | |
5082 | Set the button-type @var{type}'s @var{prop} property to @var{val}. | |
5083 | @end defun | |
5084 | ||
5085 | @defun button-type-get type prop | |
5086 | Get the property of button-type @var{type} named @var{prop}. | |
5087 | @end defun | |
5088 | ||
5089 | @defun button-type-subtype-p type supertype | |
5090 | Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. | |
5091 | @end defun | |
5092 | ||
5093 | @node Button Buffer Commands | |
5094 | @subsection Button Buffer Commands | |
5095 | @cindex button buffer commands | |
5096 | ||
5097 | These are commands and functions for locating and operating on | |
5098 | buttons in an Emacs buffer. | |
5099 | ||
5100 | @code{push-button} is the command that a user uses to actually `push' | |
5101 | a button, and is bound by default in the button itself to @key{RET} | |
5102 | and to @key{mouse-2} using a region-specific keymap. Commands | |
5103 | that are useful outside the buttons itself, such as | |
5104 | @code{forward-button} and @code{backward-button} are additionally | |
5105 | available in the keymap stored in @code{button-buffer-map}; a mode | |
5106 | which uses buttons may want to use @code{button-buffer-map} as a | |
5107 | parent keymap for its keymap. | |
5108 | ||
5109 | If the button has a non-@code{nil} @code{follow-link} property, and | |
5110 | @var{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click | |
5111 | will also activate the @code{push-button} command. | |
2bad3299 | 5112 | @xref{Clickable Text}. |
b8d4c8d0 GM |
5113 | |
5114 | @deffn Command push-button &optional pos use-mouse-action | |
5115 | Perform the action specified by a button at location @var{pos}. | |
5116 | @var{pos} may be either a buffer position or a mouse-event. If | |
5117 | @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a | |
5118 | mouse-event (@pxref{Mouse Events}), try to invoke the button's | |
5119 | @code{mouse-action} property instead of @code{action}; if the button | |
5120 | has no @code{mouse-action} property, use @code{action} as normal. | |
5121 | @var{pos} defaults to point, except when @code{push-button} is invoked | |
5122 | interactively as the result of a mouse-event, in which case, the mouse | |
5123 | event's position is used. If there's no button at @var{pos}, do | |
5124 | nothing and return @code{nil}, otherwise return @code{t}. | |
5125 | @end deffn | |
5126 | ||
5127 | @deffn Command forward-button n &optional wrap display-message | |
5128 | Move to the @var{n}th next button, or @var{n}th previous button if | |
5129 | @var{n} is negative. If @var{n} is zero, move to the start of any | |
5130 | button at point. If @var{wrap} is non-@code{nil}, moving past either | |
5131 | end of the buffer continues from the other end. If | |
5132 | @var{display-message} is non-@code{nil}, the button's help-echo string | |
5133 | is displayed. Any button with a non-@code{nil} @code{skip} property | |
5134 | is skipped over. Returns the button found. | |
5135 | @end deffn | |
5136 | ||
5137 | @deffn Command backward-button n &optional wrap display-message | |
5138 | Move to the @var{n}th previous button, or @var{n}th next button if | |
5139 | @var{n} is negative. If @var{n} is zero, move to the start of any | |
5140 | button at point. If @var{wrap} is non-@code{nil}, moving past either | |
5141 | end of the buffer continues from the other end. If | |
5142 | @var{display-message} is non-@code{nil}, the button's help-echo string | |
5143 | is displayed. Any button with a non-@code{nil} @code{skip} property | |
5144 | is skipped over. Returns the button found. | |
5145 | @end deffn | |
5146 | ||
5147 | @defun next-button pos &optional count-current | |
5148 | @defunx previous-button pos &optional count-current | |
5149 | Return the next button after (for @code{next-button} or before (for | |
5150 | @code{previous-button}) position @var{pos} in the current buffer. If | |
5151 | @var{count-current} is non-@code{nil}, count any button at @var{pos} | |
5152 | in the search, instead of starting at the next button. | |
5153 | @end defun | |
5154 | ||
5155 | @node Abstract Display | |
5156 | @section Abstract Display | |
5157 | @cindex ewoc | |
5158 | @cindex display, abstract | |
5159 | @cindex display, arbitrary objects | |
5160 | @cindex model/view/controller | |
5161 | @cindex view part, model/view/controller | |
5162 | ||
5163 | The Ewoc package constructs buffer text that represents a structure | |
5164 | of Lisp objects, and updates the text to follow changes in that | |
5165 | structure. This is like the ``view'' component in the | |
5166 | ``model/view/controller'' design paradigm. | |
5167 | ||
5168 | An @dfn{ewoc} is a structure that organizes information required to | |
5169 | construct buffer text that represents certain Lisp data. The buffer | |
5170 | text of the ewoc has three parts, in order: first, fixed @dfn{header} | |
5171 | text; next, textual descriptions of a series of data elements (Lisp | |
5172 | objects that you specify); and last, fixed @dfn{footer} text. | |
5173 | Specifically, an ewoc contains information on: | |
5174 | ||
5175 | @itemize @bullet | |
5176 | @item | |
5177 | The buffer which its text is generated in. | |
5178 | ||
5179 | @item | |
5180 | The text's start position in the buffer. | |
5181 | ||
5182 | @item | |
5183 | The header and footer strings. | |
5184 | ||
5185 | @item | |
5186 | A doubly-linked chain of @dfn{nodes}, each of which contains: | |
5187 | ||
5188 | @itemize | |
5189 | @item | |
5190 | A @dfn{data element}, a single Lisp object. | |
5191 | ||
5192 | @item | |
5193 | Links to the preceding and following nodes in the chain. | |
5194 | @end itemize | |
5195 | ||
5196 | @item | |
5197 | A @dfn{pretty-printer} function which is responsible for | |
5198 | inserting the textual representation of a data | |
5199 | element value into the current buffer. | |
5200 | @end itemize | |
5201 | ||
5202 | Typically, you define an ewoc with @code{ewoc-create}, and then pass | |
5203 | the resulting ewoc structure to other functions in the Ewoc package to | |
5204 | build nodes within it, and display it in the buffer. Once it is | |
5205 | displayed in the buffer, other functions determine the correspondance | |
5206 | between buffer positions and nodes, move point from one node's textual | |
5207 | representation to another, and so forth. @xref{Abstract Display | |
5208 | Functions}. | |
5209 | ||
5210 | A node @dfn{encapsulates} a data element much the way a variable | |
5211 | holds a value. Normally, encapsulation occurs as a part of adding a | |
5212 | node to the ewoc. You can retrieve the data element value and place a | |
5213 | new value in its place, like so: | |
5214 | ||
5215 | @lisp | |
5216 | (ewoc-data @var{node}) | |
5217 | @result{} value | |
5218 | ||
5219 | (ewoc-set-data @var{node} @var{new-value}) | |
5220 | @result{} @var{new-value} | |
5221 | @end lisp | |
5222 | ||
5223 | @noindent | |
5224 | You can also use, as the data element value, a Lisp object (list or | |
5225 | vector) that is a container for the ``real'' value, or an index into | |
5226 | some other structure. The example (@pxref{Abstract Display Example}) | |
5227 | uses the latter approach. | |
5228 | ||
5229 | When the data changes, you will want to update the text in the | |
5230 | buffer. You can update all nodes by calling @code{ewoc-refresh}, or | |
5231 | just specific nodes using @code{ewoc-invalidate}, or all nodes | |
5232 | satisfying a predicate using @code{ewoc-map}. Alternatively, you can | |
5233 | delete invalid nodes using @code{ewoc-delete} or @code{ewoc-filter}, | |
5234 | and add new nodes in their place. Deleting a node from an ewoc deletes | |
5235 | its associated textual description from buffer, as well. | |
5236 | ||
5237 | @menu | |
5b594a58 GM |
5238 | * Abstract Display Functions:: Functions in the Ewoc package. |
5239 | * Abstract Display Example:: Example of using Ewoc. | |
b8d4c8d0 GM |
5240 | @end menu |
5241 | ||
5242 | @node Abstract Display Functions | |
5243 | @subsection Abstract Display Functions | |
5244 | ||
5245 | In this subsection, @var{ewoc} and @var{node} stand for the | |
5246 | structures described above (@pxref{Abstract Display}), while | |
5247 | @var{data} stands for an arbitrary Lisp object used as a data element. | |
5248 | ||
5249 | @defun ewoc-create pretty-printer &optional header footer nosep | |
5250 | This constructs and returns a new ewoc, with no nodes (and thus no data | |
5251 | elements). @var{pretty-printer} should be a function that takes one | |
5252 | argument, a data element of the sort you plan to use in this ewoc, and | |
5253 | inserts its textual description at point using @code{insert} (and never | |
5254 | @code{insert-before-markers}, because that would interfere with the | |
5255 | Ewoc package's internal mechanisms). | |
5256 | ||
5257 | Normally, a newline is automatically inserted after the header, | |
5258 | the footer and every node's textual description. If @var{nosep} | |
5259 | is non-@code{nil}, no newline is inserted. This may be useful for | |
5260 | displaying an entire ewoc on a single line, for example, or for | |
5261 | making nodes ``invisible'' by arranging for @var{pretty-printer} | |
5262 | to do nothing for those nodes. | |
5263 | ||
5264 | An ewoc maintains its text in the buffer that is current when | |
5265 | you create it, so switch to the intended buffer before calling | |
5266 | @code{ewoc-create}. | |
5267 | @end defun | |
5268 | ||
5269 | @defun ewoc-buffer ewoc | |
5270 | This returns the buffer where @var{ewoc} maintains its text. | |
5271 | @end defun | |
5272 | ||
5273 | @defun ewoc-get-hf ewoc | |
5274 | This returns a cons cell @code{(@var{header} . @var{footer})} | |
5275 | made from @var{ewoc}'s header and footer. | |
5276 | @end defun | |
5277 | ||
5278 | @defun ewoc-set-hf ewoc header footer | |
5279 | This sets the header and footer of @var{ewoc} to the strings | |
5280 | @var{header} and @var{footer}, respectively. | |
5281 | @end defun | |
5282 | ||
5283 | @defun ewoc-enter-first ewoc data | |
5284 | @defunx ewoc-enter-last ewoc data | |
5285 | These add a new node encapsulating @var{data}, putting it, respectively, | |
5286 | at the beginning or end of @var{ewoc}'s chain of nodes. | |
5287 | @end defun | |
5288 | ||
5289 | @defun ewoc-enter-before ewoc node data | |
5290 | @defunx ewoc-enter-after ewoc node data | |
5291 | These add a new node encapsulating @var{data}, adding it to | |
5292 | @var{ewoc} before or after @var{node}, respectively. | |
5293 | @end defun | |
5294 | ||
5295 | @defun ewoc-prev ewoc node | |
5296 | @defunx ewoc-next ewoc node | |
5297 | These return, respectively, the previous node and the next node of @var{node} | |
5298 | in @var{ewoc}. | |
5299 | @end defun | |
5300 | ||
5301 | @defun ewoc-nth ewoc n | |
5302 | This returns the node in @var{ewoc} found at zero-based index @var{n}. | |
5303 | A negative @var{n} means count from the end. @code{ewoc-nth} returns | |
5304 | @code{nil} if @var{n} is out of range. | |
5305 | @end defun | |
5306 | ||
5307 | @defun ewoc-data node | |
5308 | This extracts the data encapsulated by @var{node} and returns it. | |
5309 | @end defun | |
5310 | ||
5311 | @defun ewoc-set-data node data | |
5312 | This sets the data encapsulated by @var{node} to @var{data}. | |
5313 | @end defun | |
5314 | ||
5315 | @defun ewoc-locate ewoc &optional pos guess | |
5316 | This determines the node in @var{ewoc} which contains point (or | |
5317 | @var{pos} if specified), and returns that node. If @var{ewoc} has no | |
5318 | nodes, it returns @code{nil}. If @var{pos} is before the first node, | |
5319 | it returns the first node; if @var{pos} is after the last node, it returns | |
5320 | the last node. The optional third arg @var{guess} | |
5321 | should be a node that is likely to be near @var{pos}; this doesn't | |
5322 | alter the result, but makes the function run faster. | |
5323 | @end defun | |
5324 | ||
5325 | @defun ewoc-location node | |
5326 | This returns the start position of @var{node}. | |
5327 | @end defun | |
5328 | ||
5329 | @defun ewoc-goto-prev ewoc arg | |
5330 | @defunx ewoc-goto-next ewoc arg | |
5331 | These move point to the previous or next, respectively, @var{arg}th node | |
5332 | in @var{ewoc}. @code{ewoc-goto-prev} does not move if it is already at | |
5333 | the first node or if @var{ewoc} is empty, whereas @code{ewoc-goto-next} | |
5334 | moves past the last node, returning @code{nil}. Excepting this special | |
5335 | case, these functions return the node moved to. | |
5336 | @end defun | |
5337 | ||
5338 | @defun ewoc-goto-node ewoc node | |
5339 | This moves point to the start of @var{node} in @var{ewoc}. | |
5340 | @end defun | |
5341 | ||
5342 | @defun ewoc-refresh ewoc | |
5343 | This function regenerates the text of @var{ewoc}. It works by | |
5344 | deleting the text between the header and the footer, i.e., all the | |
5345 | data elements' representations, and then calling the pretty-printer | |
5346 | function for each node, one by one, in order. | |
5347 | @end defun | |
5348 | ||
5349 | @defun ewoc-invalidate ewoc &rest nodes | |
5350 | This is similar to @code{ewoc-refresh}, except that only @var{nodes} in | |
5351 | @var{ewoc} are updated instead of the entire set. | |
5352 | @end defun | |
5353 | ||
5354 | @defun ewoc-delete ewoc &rest nodes | |
5355 | This deletes each node in @var{nodes} from @var{ewoc}. | |
5356 | @end defun | |
5357 | ||
5358 | @defun ewoc-filter ewoc predicate &rest args | |
5359 | This calls @var{predicate} for each data element in @var{ewoc} and | |
5360 | deletes those nodes for which @var{predicate} returns @code{nil}. | |
5361 | Any @var{args} are passed to @var{predicate}. | |
5362 | @end defun | |
5363 | ||
5364 | @defun ewoc-collect ewoc predicate &rest args | |
5365 | This calls @var{predicate} for each data element in @var{ewoc} | |
5366 | and returns a list of those elements for which @var{predicate} | |
5367 | returns non-@code{nil}. The elements in the list are ordered | |
5368 | as in the buffer. Any @var{args} are passed to @var{predicate}. | |
5369 | @end defun | |
5370 | ||
5371 | @defun ewoc-map map-function ewoc &rest args | |
5372 | This calls @var{map-function} for each data element in @var{ewoc} and | |
5373 | updates those nodes for which @var{map-function} returns non-@code{nil}. | |
5374 | Any @var{args} are passed to @var{map-function}. | |
5375 | @end defun | |
5376 | ||
5377 | @node Abstract Display Example | |
5378 | @subsection Abstract Display Example | |
5379 | ||
5380 | Here is a simple example using functions of the ewoc package to | |
5381 | implement a ``color components display,'' an area in a buffer that | |
5382 | represents a vector of three integers (itself representing a 24-bit RGB | |
5383 | value) in various ways. | |
5384 | ||
5385 | @example | |
5386 | (setq colorcomp-ewoc nil | |
5387 | colorcomp-data nil | |
5388 | colorcomp-mode-map nil | |
5389 | colorcomp-labels ["Red" "Green" "Blue"]) | |
5390 | ||
5391 | (defun colorcomp-pp (data) | |
5392 | (if data | |
5393 | (let ((comp (aref colorcomp-data data))) | |
5394 | (insert (aref colorcomp-labels data) "\t: #x" | |
5395 | (format "%02X" comp) " " | |
5396 | (make-string (ash comp -2) ?#) "\n")) | |
5397 | (let ((cstr (format "#%02X%02X%02X" | |
5398 | (aref colorcomp-data 0) | |
5399 | (aref colorcomp-data 1) | |
5400 | (aref colorcomp-data 2))) | |
5401 | (samp " (sample text) ")) | |
5402 | (insert "Color\t: " | |
5403 | (propertize samp 'face `(foreground-color . ,cstr)) | |
5404 | (propertize samp 'face `(background-color . ,cstr)) | |
5405 | "\n")))) | |
5406 | ||
5407 | (defun colorcomp (color) | |
5408 | "Allow fiddling with COLOR in a new buffer. | |
5409 | The buffer is in Color Components mode." | |
5410 | (interactive "sColor (name or #RGB or #RRGGBB): ") | |
5411 | (when (string= "" color) | |
5412 | (setq color "green")) | |
5413 | (unless (color-values color) | |
5414 | (error "No such color: %S" color)) | |
5415 | (switch-to-buffer | |
5416 | (generate-new-buffer (format "originally: %s" color))) | |
5417 | (kill-all-local-variables) | |
5418 | (setq major-mode 'colorcomp-mode | |
5419 | mode-name "Color Components") | |
5420 | (use-local-map colorcomp-mode-map) | |
5421 | (erase-buffer) | |
5422 | (buffer-disable-undo) | |
5423 | (let ((data (apply 'vector (mapcar (lambda (n) (ash n -8)) | |
5424 | (color-values color)))) | |
5425 | (ewoc (ewoc-create 'colorcomp-pp | |
5426 | "\nColor Components\n\n" | |
5427 | (substitute-command-keys | |
5428 | "\n\\@{colorcomp-mode-map@}")))) | |
5429 | (set (make-local-variable 'colorcomp-data) data) | |
5430 | (set (make-local-variable 'colorcomp-ewoc) ewoc) | |
5431 | (ewoc-enter-last ewoc 0) | |
5432 | (ewoc-enter-last ewoc 1) | |
5433 | (ewoc-enter-last ewoc 2) | |
5434 | (ewoc-enter-last ewoc nil))) | |
5435 | @end example | |
5436 | ||
5437 | @cindex controller part, model/view/controller | |
5438 | This example can be extended to be a ``color selection widget'' (in | |
5439 | other words, the controller part of the ``model/view/controller'' | |
5440 | design paradigm) by defining commands to modify @code{colorcomp-data} | |
5441 | and to ``finish'' the selection process, and a keymap to tie it all | |
5442 | together conveniently. | |
5443 | ||
5444 | @smallexample | |
5445 | (defun colorcomp-mod (index limit delta) | |
5446 | (let ((cur (aref colorcomp-data index))) | |
5447 | (unless (= limit cur) | |
5448 | (aset colorcomp-data index (+ cur delta))) | |
5449 | (ewoc-invalidate | |
5450 | colorcomp-ewoc | |
5451 | (ewoc-nth colorcomp-ewoc index) | |
5452 | (ewoc-nth colorcomp-ewoc -1)))) | |
5453 | ||
5454 | (defun colorcomp-R-more () (interactive) (colorcomp-mod 0 255 1)) | |
5455 | (defun colorcomp-G-more () (interactive) (colorcomp-mod 1 255 1)) | |
5456 | (defun colorcomp-B-more () (interactive) (colorcomp-mod 2 255 1)) | |
5457 | (defun colorcomp-R-less () (interactive) (colorcomp-mod 0 0 -1)) | |
5458 | (defun colorcomp-G-less () (interactive) (colorcomp-mod 1 0 -1)) | |
5459 | (defun colorcomp-B-less () (interactive) (colorcomp-mod 2 0 -1)) | |
5460 | ||
5461 | (defun colorcomp-copy-as-kill-and-exit () | |
5462 | "Copy the color components into the kill ring and kill the buffer. | |
5463 | The string is formatted #RRGGBB (hash followed by six hex digits)." | |
5464 | (interactive) | |
5465 | (kill-new (format "#%02X%02X%02X" | |
5466 | (aref colorcomp-data 0) | |
5467 | (aref colorcomp-data 1) | |
5468 | (aref colorcomp-data 2))) | |
5469 | (kill-buffer nil)) | |
5470 | ||
5471 | (setq colorcomp-mode-map | |
5472 | (let ((m (make-sparse-keymap))) | |
5473 | (suppress-keymap m) | |
5474 | (define-key m "i" 'colorcomp-R-less) | |
5475 | (define-key m "o" 'colorcomp-R-more) | |
5476 | (define-key m "k" 'colorcomp-G-less) | |
5477 | (define-key m "l" 'colorcomp-G-more) | |
5478 | (define-key m "," 'colorcomp-B-less) | |
5479 | (define-key m "." 'colorcomp-B-more) | |
5480 | (define-key m " " 'colorcomp-copy-as-kill-and-exit) | |
5481 | m)) | |
5482 | @end smallexample | |
5483 | ||
5484 | Note that we never modify the data in each node, which is fixed when the | |
5485 | ewoc is created to be either @code{nil} or an index into the vector | |
5486 | @code{colorcomp-data}, the actual color components. | |
5487 | ||
5488 | @node Blinking | |
5489 | @section Blinking Parentheses | |
5490 | @cindex parenthesis matching | |
5491 | @cindex blinking parentheses | |
5492 | @cindex balancing parentheses | |
5493 | ||
5494 | This section describes the mechanism by which Emacs shows a matching | |
5495 | open parenthesis when the user inserts a close parenthesis. | |
5496 | ||
5497 | @defvar blink-paren-function | |
5498 | The value of this variable should be a function (of no arguments) to | |
5499 | be called whenever a character with close parenthesis syntax is inserted. | |
5500 | The value of @code{blink-paren-function} may be @code{nil}, in which | |
5501 | case nothing is done. | |
5502 | @end defvar | |
5503 | ||
5504 | @defopt blink-matching-paren | |
5505 | If this variable is @code{nil}, then @code{blink-matching-open} does | |
5506 | nothing. | |
5507 | @end defopt | |
5508 | ||
5509 | @defopt blink-matching-paren-distance | |
5510 | This variable specifies the maximum distance to scan for a matching | |
5511 | parenthesis before giving up. | |
5512 | @end defopt | |
5513 | ||
5514 | @defopt blink-matching-delay | |
5515 | This variable specifies the number of seconds for the cursor to remain | |
5516 | at the matching parenthesis. A fraction of a second often gives | |
5517 | good results, but the default is 1, which works on all systems. | |
5518 | @end defopt | |
5519 | ||
5520 | @deffn Command blink-matching-open | |
5521 | This function is the default value of @code{blink-paren-function}. It | |
5522 | assumes that point follows a character with close parenthesis syntax and | |
5523 | moves the cursor momentarily to the matching opening character. If that | |
5524 | character is not already on the screen, it displays the character's | |
5525 | context in the echo area. To avoid long delays, this function does not | |
5526 | search farther than @code{blink-matching-paren-distance} characters. | |
5527 | ||
5528 | Here is an example of calling this function explicitly. | |
5529 | ||
5530 | @smallexample | |
5531 | @group | |
5532 | (defun interactive-blink-matching-open () | |
5533 | @c Do not break this line! -- rms. | |
5534 | @c The first line of a doc string | |
5535 | @c must stand alone. | |
5536 | "Indicate momentarily the start of sexp before point." | |
5537 | (interactive) | |
5538 | @end group | |
5539 | @group | |
5540 | (let ((blink-matching-paren-distance | |
5541 | (buffer-size)) | |
5542 | (blink-matching-paren t)) | |
5543 | (blink-matching-open))) | |
5544 | @end group | |
5545 | @end smallexample | |
5546 | @end deffn | |
5547 | ||
5548 | @node Usual Display | |
5549 | @section Usual Display Conventions | |
5550 | ||
5551 | The usual display conventions define how to display each character | |
5552 | code. You can override these conventions by setting up a display table | |
5553 | (@pxref{Display Tables}). Here are the usual display conventions: | |
5554 | ||
5555 | @itemize @bullet | |
5556 | @item | |
5557 | Character codes 32 through 126 map to glyph codes 32 through 126. | |
5558 | Normally this means they display as themselves. | |
5559 | ||
5560 | @item | |
5561 | Character code 9 is a horizontal tab. It displays as whitespace | |
5562 | up to a position determined by @code{tab-width}. | |
5563 | ||
5564 | @item | |
5565 | Character code 10 is a newline. | |
5566 | ||
5567 | @item | |
5568 | All other codes in the range 0 through 31, and code 127, display in one | |
5569 | of two ways according to the value of @code{ctl-arrow}. If it is | |
5570 | non-@code{nil}, these codes map to sequences of two glyphs, where the | |
5571 | first glyph is the @acronym{ASCII} code for @samp{^}. (A display table can | |
5572 | specify a glyph to use instead of @samp{^}.) Otherwise, these codes map | |
5573 | just like the codes in the range 128 to 255. | |
5574 | ||
5575 | On MS-DOS terminals, Emacs arranges by default for the character code | |
5576 | 127 to be mapped to the glyph code 127, which normally displays as an | |
5577 | empty polygon. This glyph is used to display non-@acronym{ASCII} characters | |
5578 | that the MS-DOS terminal doesn't support. @xref{MS-DOS and MULE,,, | |
5579 | emacs, The GNU Emacs Manual}. | |
5580 | ||
5581 | @item | |
5582 | Character codes 128 through 255 map to sequences of four glyphs, where | |
5583 | the first glyph is the @acronym{ASCII} code for @samp{\}, and the others are | |
5584 | digit characters representing the character code in octal. (A display | |
5585 | table can specify a glyph to use instead of @samp{\}.) | |
5586 | ||
5587 | @item | |
0eb025fb EZ |
5588 | Multibyte character codes above 256 are displayed as themselves, or as |
5589 | a question mark or a hex code or an empty box if the terminal cannot | |
5590 | display that character. | |
b8d4c8d0 GM |
5591 | @end itemize |
5592 | ||
5593 | The usual display conventions apply even when there is a display | |
5594 | table, for any character whose entry in the active display table is | |
5595 | @code{nil}. Thus, when you set up a display table, you need only | |
5596 | specify the characters for which you want special behavior. | |
5597 | ||
5598 | These display rules apply to carriage return (character code 13), when | |
5599 | it appears in the buffer. But that character may not appear in the | |
5600 | buffer where you expect it, if it was eliminated as part of end-of-line | |
5601 | conversion (@pxref{Coding System Basics}). | |
5602 | ||
5603 | These variables affect the way certain characters are displayed on the | |
5604 | screen. Since they change the number of columns the characters occupy, | |
5605 | they also affect the indentation functions. These variables also affect | |
5606 | how the mode line is displayed; if you want to force redisplay of the | |
5607 | mode line using the new values, call the function | |
5608 | @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
5609 | ||
5610 | @defopt ctl-arrow | |
5611 | @cindex control characters in display | |
5612 | This buffer-local variable controls how control characters are | |
5613 | displayed. If it is non-@code{nil}, they are displayed as a caret | |
5614 | followed by the character: @samp{^A}. If it is @code{nil}, they are | |
5615 | displayed as a backslash followed by three octal digits: @samp{\001}. | |
5616 | @end defopt | |
5617 | ||
b8d4c8d0 GM |
5618 | @defopt tab-width |
5619 | The value of this buffer-local variable is the spacing between tab | |
5620 | stops used for displaying tab characters in Emacs buffers. The value | |
5621 | is in units of columns, and the default is 8. Note that this feature | |
5622 | is completely independent of the user-settable tab stops used by the | |
5623 | command @code{tab-to-tab-stop}. @xref{Indent Tabs}. | |
5624 | @end defopt | |
5625 | ||
5626 | @node Display Tables | |
5627 | @section Display Tables | |
5628 | ||
5629 | @cindex display table | |
5630 | You can use the @dfn{display table} feature to control how all possible | |
5631 | character codes display on the screen. This is useful for displaying | |
5632 | European languages that have letters not in the @acronym{ASCII} character | |
5633 | set. | |
5634 | ||
5635 | The display table maps each character code into a sequence of | |
5636 | @dfn{glyphs}, each glyph being a graphic that takes up one character | |
5637 | position on the screen. You can also define how to display each glyph | |
5638 | on your terminal, using the @dfn{glyph table}. | |
5639 | ||
5640 | Display tables affect how the mode line is displayed; if you want to | |
5641 | force redisplay of the mode line using a new display table, call | |
5642 | @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
5643 | ||
5644 | @menu | |
5645 | * Display Table Format:: What a display table consists of. | |
5646 | * Active Display Table:: How Emacs selects a display table to use. | |
5647 | * Glyphs:: How to define a glyph, and what glyphs mean. | |
5648 | @end menu | |
5649 | ||
5650 | @node Display Table Format | |
5651 | @subsection Display Table Format | |
5652 | ||
5653 | A display table is actually a char-table (@pxref{Char-Tables}) with | |
5654 | @code{display-table} as its subtype. | |
5655 | ||
5656 | @defun make-display-table | |
5657 | This creates and returns a display table. The table initially has | |
5658 | @code{nil} in all elements. | |
5659 | @end defun | |
5660 | ||
5661 | The ordinary elements of the display table are indexed by character | |
5662 | codes; the element at index @var{c} says how to display the character | |
5663 | code @var{c}. The value should be @code{nil} or a vector of the | |
5664 | glyphs to be output (@pxref{Glyphs}). @code{nil} says to display the | |
5665 | character @var{c} according to the usual display conventions | |
5666 | (@pxref{Usual Display}). | |
5667 | ||
5668 | @strong{Warning:} if you use the display table to change the display | |
5669 | of newline characters, the whole buffer will be displayed as one long | |
5670 | ``line.'' | |
5671 | ||
5672 | The display table also has six ``extra slots'' which serve special | |
5673 | purposes. Here is a table of their meanings; @code{nil} in any slot | |
5674 | means to use the default for that slot, as stated below. | |
5675 | ||
5676 | @table @asis | |
5677 | @item 0 | |
5678 | The glyph for the end of a truncated screen line (the default for this | |
5679 | is @samp{$}). @xref{Glyphs}. On graphical terminals, Emacs uses | |
5680 | arrows in the fringes to indicate truncation, so the display table has | |
5681 | no effect. | |
5682 | ||
5683 | @item 1 | |
5684 | The glyph for the end of a continued line (the default is @samp{\}). | |
5685 | On graphical terminals, Emacs uses curved arrows in the fringes to | |
5686 | indicate continuation, so the display table has no effect. | |
5687 | ||
5688 | @item 2 | |
5689 | The glyph for indicating a character displayed as an octal character | |
5690 | code (the default is @samp{\}). | |
5691 | ||
5692 | @item 3 | |
5693 | The glyph for indicating a control character (the default is @samp{^}). | |
5694 | ||
5695 | @item 4 | |
5696 | A vector of glyphs for indicating the presence of invisible lines (the | |
5697 | default is @samp{...}). @xref{Selective Display}. | |
5698 | ||
5699 | @item 5 | |
5700 | The glyph used to draw the border between side-by-side windows (the | |
5701 | default is @samp{|}). @xref{Splitting Windows}. This takes effect only | |
5702 | when there are no scroll bars; if scroll bars are supported and in use, | |
5703 | a scroll bar separates the two windows. | |
5704 | @end table | |
5705 | ||
5706 | For example, here is how to construct a display table that mimics the | |
5707 | effect of setting @code{ctl-arrow} to a non-@code{nil} value: | |
5708 | ||
5709 | @example | |
5710 | (setq disptab (make-display-table)) | |
5711 | (let ((i 0)) | |
5712 | (while (< i 32) | |
5713 | (or (= i ?\t) (= i ?\n) | |
5714 | (aset disptab i (vector ?^ (+ i 64)))) | |
5715 | (setq i (1+ i))) | |
5716 | (aset disptab 127 (vector ?^ ??))) | |
5717 | @end example | |
5718 | ||
5719 | @defun display-table-slot display-table slot | |
5720 | This function returns the value of the extra slot @var{slot} of | |
5721 | @var{display-table}. The argument @var{slot} may be a number from 0 to | |
5722 | 5 inclusive, or a slot name (symbol). Valid symbols are | |
5723 | @code{truncation}, @code{wrap}, @code{escape}, @code{control}, | |
5724 | @code{selective-display}, and @code{vertical-border}. | |
5725 | @end defun | |
5726 | ||
5727 | @defun set-display-table-slot display-table slot value | |
5728 | This function stores @var{value} in the extra slot @var{slot} of | |
5729 | @var{display-table}. The argument @var{slot} may be a number from 0 to | |
5730 | 5 inclusive, or a slot name (symbol). Valid symbols are | |
5731 | @code{truncation}, @code{wrap}, @code{escape}, @code{control}, | |
5732 | @code{selective-display}, and @code{vertical-border}. | |
5733 | @end defun | |
5734 | ||
5735 | @defun describe-display-table display-table | |
5736 | This function displays a description of the display table | |
5737 | @var{display-table} in a help buffer. | |
5738 | @end defun | |
5739 | ||
5740 | @deffn Command describe-current-display-table | |
5741 | This command displays a description of the current display table in a | |
5742 | help buffer. | |
5743 | @end deffn | |
5744 | ||
5745 | @node Active Display Table | |
5746 | @subsection Active Display Table | |
5747 | @cindex active display table | |
5748 | ||
5749 | Each window can specify a display table, and so can each buffer. When | |
5750 | a buffer @var{b} is displayed in window @var{w}, display uses the | |
5751 | display table for window @var{w} if it has one; otherwise, the display | |
5752 | table for buffer @var{b} if it has one; otherwise, the standard display | |
5753 | table if any. The display table chosen is called the @dfn{active} | |
5754 | display table. | |
5755 | ||
5756 | @defun window-display-table &optional window | |
5757 | This function returns @var{window}'s display table, or @code{nil} | |
5758 | if @var{window} does not have an assigned display table. The default | |
5759 | for @var{window} is the selected window. | |
5760 | @end defun | |
5761 | ||
5762 | @defun set-window-display-table window table | |
5763 | This function sets the display table of @var{window} to @var{table}. | |
5764 | The argument @var{table} should be either a display table or | |
5765 | @code{nil}. | |
5766 | @end defun | |
5767 | ||
5768 | @defvar buffer-display-table | |
5769 | This variable is automatically buffer-local in all buffers; its value in | |
5770 | a particular buffer specifies the display table for that buffer. If it | |
5771 | is @code{nil}, that means the buffer does not have an assigned display | |
5772 | table. | |
5773 | @end defvar | |
5774 | ||
5775 | @defvar standard-display-table | |
5776 | This variable's value is the default display table, used whenever a | |
5777 | window has no display table and neither does the buffer displayed in | |
5778 | that window. This variable is @code{nil} by default. | |
5779 | @end defvar | |
5780 | ||
5781 | If there is no display table to use for a particular window---that is, | |
5782 | if the window specifies none, its buffer specifies none, and | |
5783 | @code{standard-display-table} is @code{nil}---then Emacs uses the usual | |
5784 | display conventions for all character codes in that window. @xref{Usual | |
5785 | Display}. | |
5786 | ||
5787 | A number of functions for changing the standard display table | |
5788 | are defined in the library @file{disp-table}. | |
5789 | ||
5790 | @node Glyphs | |
5791 | @subsection Glyphs | |
5792 | ||
5793 | @cindex glyph | |
5794 | A @dfn{glyph} is a generalization of a character; it stands for an | |
5795 | image that takes up a single character position on the screen. Normally | |
5796 | glyphs come from vectors in the display table (@pxref{Display Tables}). | |
5797 | ||
5798 | A glyph is represented in Lisp as a @dfn{glyph code}. A glyph code | |
5799 | can be @dfn{simple} or it can be defined by the @dfn{glyph table}. A | |
5800 | simple glyph code is just a way of specifying a character and a face | |
5801 | to output it in. @xref{Faces}. | |
5802 | ||
5803 | The following functions are used to manipulate simple glyph codes: | |
5804 | ||
5805 | @defun make-glyph-code char &optional face | |
5806 | This function returns a simple glyph code representing char @var{char} | |
5807 | with face @var{face}. | |
5808 | @end defun | |
5809 | ||
5810 | @defun glyph-char glyph | |
5811 | This function returns the character of simple glyph code @var{glyph}. | |
5812 | @end defun | |
5813 | ||
5814 | @defun glyph-face glyph | |
5815 | This function returns face of simple glyph code @var{glyph}, or | |
5816 | @code{nil} if @var{glyph} has the default face (face-id 0). | |
d466a866 | 5817 | @xref{Face Functions}. |
b8d4c8d0 GM |
5818 | @end defun |
5819 | ||
5820 | On character terminals, you can set up a @dfn{glyph table} to define | |
5821 | the meaning of glyph codes (represented as small integers). | |
5822 | ||
5823 | @defvar glyph-table | |
5824 | The value of this variable is the current glyph table. It should be | |
5825 | @code{nil} or a vector whose @var{g}th element defines glyph code | |
5826 | @var{g}. | |
5827 | ||
5828 | If a glyph code is greater than or equal to the length of the glyph | |
5829 | table, that code is automatically simple. If @code{glyph-table} is | |
5830 | @code{nil} then all glyph codes are simple. | |
5831 | ||
5832 | The glyph table is used only on character terminals. On graphical | |
5833 | displays, all glyph codes are simple. | |
5834 | @end defvar | |
5835 | ||
5836 | Here are the meaningful types of elements in the glyph table: | |
5837 | ||
5838 | @table @asis | |
5839 | @item @var{string} | |
5840 | Send the characters in @var{string} to the terminal to output | |
5841 | this glyph code. | |
5842 | ||
5843 | @item @var{code} | |
5844 | Define this glyph code as an alias for glyph code @var{code} created | |
5845 | by @code{make-glyph-code}. You can use such an alias to define a | |
5846 | small-numbered glyph code which specifies a character with a face. | |
5847 | ||
5848 | @item @code{nil} | |
5849 | This glyph code is simple. | |
5850 | @end table | |
5851 | ||
5852 | @defun create-glyph string | |
5853 | This function returns a newly-allocated glyph code which is set up to | |
5854 | display by sending @var{string} to the terminal. | |
5855 | @end defun | |
5856 | ||
5857 | @node Beeping | |
5858 | @section Beeping | |
5859 | @c @cindex beeping "beep" is adjacent | |
5860 | @cindex bell | |
5861 | ||
5862 | This section describes how to make Emacs ring the bell (or blink the | |
5863 | screen) to attract the user's attention. Be conservative about how | |
5864 | often you do this; frequent bells can become irritating. Also be | |
5865 | careful not to use just beeping when signaling an error is more | |
5866 | appropriate. (@xref{Errors}.) | |
5867 | ||
5868 | @defun ding &optional do-not-terminate | |
5869 | @cindex keyboard macro termination | |
5870 | This function beeps, or flashes the screen (see @code{visible-bell} below). | |
5871 | It also terminates any keyboard macro currently executing unless | |
5872 | @var{do-not-terminate} is non-@code{nil}. | |
5873 | @end defun | |
5874 | ||
5875 | @defun beep &optional do-not-terminate | |
5876 | This is a synonym for @code{ding}. | |
5877 | @end defun | |
5878 | ||
5879 | @defopt visible-bell | |
5880 | This variable determines whether Emacs should flash the screen to | |
5881 | represent a bell. Non-@code{nil} means yes, @code{nil} means no. This | |
5882 | is effective on graphical displays, and on text-only terminals | |
5883 | provided the terminal's Termcap entry defines the visible bell | |
5884 | capability (@samp{vb}). | |
5885 | @end defopt | |
5886 | ||
5887 | @defvar ring-bell-function | |
5888 | If this is non-@code{nil}, it specifies how Emacs should ``ring the | |
5889 | bell.'' Its value should be a function of no arguments. If this is | |
5890 | non-@code{nil}, it takes precedence over the @code{visible-bell} | |
5891 | variable. | |
5892 | @end defvar | |
5893 | ||
5894 | @node Window Systems | |
5895 | @section Window Systems | |
5896 | ||
5897 | Emacs works with several window systems, most notably the X Window | |
5898 | System. Both Emacs and X use the term ``window,'' but use it | |
5899 | differently. An Emacs frame is a single window as far as X is | |
5900 | concerned; the individual Emacs windows are not known to X at all. | |
5901 | ||
5902 | @defvar window-system | |
77bb0476 EZ |
5903 | This frame-local variable tells Lisp programs what window system Emacs is using |
5904 | for displaying the frame. The possible values are | |
b8d4c8d0 GM |
5905 | |
5906 | @table @code | |
5907 | @item x | |
5908 | @cindex X Window System | |
77bb0476 | 5909 | Emacs is displaying the frame using X. |
b8d4c8d0 | 5910 | @item w32 |
77bb0476 | 5911 | Emacs is displaying the frame using native MS-Windows GUI. |
ca27c21b CY |
5912 | @item ns |
5913 | Emacs is displaying the frame using the Nextstep interface (used on | |
5914 | GNUstep and Mac OS X). | |
77bb0476 EZ |
5915 | @item pc |
5916 | Emacs is displaying the frame using MS-DOS direct screen writes. | |
b8d4c8d0 | 5917 | @item nil |
77bb0476 | 5918 | Emacs is displaying the frame on a character-based terminal. |
b8d4c8d0 GM |
5919 | @end table |
5920 | @end defvar | |
5921 | ||
4267d515 EZ |
5922 | @defvar initial-window-system |
5923 | This variable holds the value of @code{window-system} used for the | |
f721deda EZ |
5924 | first frame created by Emacs during startup. (When Emacs is invoked |
5925 | with the @option{--daemon} option, it does not create any initial | |
5926 | frames, so @code{initial-window-system} is @code{nil}. @xref{Initial | |
5927 | Options, daemon,, emacs, The GNU Emacs Manual}.) | |
4267d515 EZ |
5928 | @end defvar |
5929 | ||
77bb0476 EZ |
5930 | @defun window-system &optional frame |
5931 | This function returns a symbol whose name tells what window system is | |
5932 | used for displaying @var{frame} (which defaults to the currently | |
5933 | selected frame). The list of possible symbols it returns is the same | |
5934 | one documented for the variable @code{window-system} above. | |
5935 | @end defun | |
5936 | ||
89baa1df EZ |
5937 | Do @emph{not} use @code{window-system} and |
5938 | @code{initial-window-system} as predicates or boolean flag variables, | |
5939 | if you want to write code that works differently on text terminals and | |
5940 | graphic displays. That is because @code{window-system} is not a good | |
5941 | indicator of Emacs capabilities on a given display type. Instead, use | |
5942 | @code{display-graphic-p} or any of the other @code{display-*-p} | |
5943 | predicates described in @ref{Display Feature Testing}. | |
5944 | ||
b8d4c8d0 GM |
5945 | @defvar window-setup-hook |
5946 | This variable is a normal hook which Emacs runs after handling the | |
5947 | initialization files. Emacs runs this hook after it has completed | |
5948 | loading your init file, the default initialization file (if | |
5949 | any), and the terminal-specific Lisp code, and running the hook | |
5950 | @code{term-setup-hook}. | |
5951 | ||
5952 | This hook is used for internal purposes: setting up communication with | |
5953 | the window system, and creating the initial window. Users should not | |
5954 | interfere with it. | |
5955 | @end defvar |