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