Commit | Line | Data |
---|---|---|
a44af9f2 RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
fd897522 GM |
3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 | @c Free Software Foundation, Inc. | |
a44af9f2 RS |
5 | @c See the file elisp.texi for copying conditions. |
6 | @setfilename ../info/modes | |
7 | @node Modes, Documentation, Keymaps, Top | |
8 | @chapter Major and Minor Modes | |
9 | @cindex mode | |
10 | ||
11 | A @dfn{mode} is a set of definitions that customize Emacs and can be | |
12 | turned on and off while you edit. There are two varieties of modes: | |
13 | @dfn{major modes}, which are mutually exclusive and used for editing | |
14 | particular kinds of text, and @dfn{minor modes}, which provide features | |
15 | that users can enable individually. | |
16 | ||
17 | This chapter describes how to write both major and minor modes, how to | |
18 | indicate them in the mode line, and how they run hooks supplied by the | |
19 | user. For related topics such as keymaps and syntax tables, see | |
20 | @ref{Keymaps}, and @ref{Syntax Tables}. | |
21 | ||
22 | @menu | |
23 | * Major Modes:: Defining major modes. | |
24 | * Minor Modes:: Defining minor modes. | |
25 | * Mode Line Format:: Customizing the text that appears in the mode line. | |
f9f59935 RS |
26 | * Imenu:: How a mode can provide a menu |
27 | of definitions in the buffer. | |
28 | * Font Lock Mode:: How modes can highlight text according to syntax. | |
a44af9f2 RS |
29 | * Hooks:: How to use hooks; how to write code that provides hooks. |
30 | @end menu | |
31 | ||
32 | @node Major Modes | |
33 | @section Major Modes | |
34 | @cindex major mode | |
35 | @cindex Fundamental mode | |
36 | ||
37 | Major modes specialize Emacs for editing particular kinds of text. | |
38 | Each buffer has only one major mode at a time. | |
39 | ||
40 | The least specialized major mode is called @dfn{Fundamental mode}. | |
41 | This mode has no mode-specific definitions or variable settings, so each | |
42 | Emacs command behaves in its default manner, and each option is in its | |
43 | default state. All other major modes redefine various keys and options. | |
44 | For example, Lisp Interaction mode provides special key bindings for | |
969fe9b5 | 45 | @kbd{C-j} (@code{eval-print-last-sexp}), @key{TAB} |
a44af9f2 RS |
46 | (@code{lisp-indent-line}), and other keys. |
47 | ||
48 | When you need to write several editing commands to help you perform a | |
49 | specialized editing task, creating a new major mode is usually a good | |
50 | idea. In practice, writing a major mode is easy (in contrast to | |
51 | writing a minor mode, which is often difficult). | |
52 | ||
53 | If the new mode is similar to an old one, it is often unwise to modify | |
54 | the old one to serve two purposes, since it may become harder to use and | |
55 | maintain. Instead, copy and rename an existing major mode definition | |
56 | and alter the copy---or define a @dfn{derived mode} (@pxref{Derived | |
57 | Modes}). For example, Rmail Edit mode, which is in | |
a40d4712 PR |
58 | @file{emacs/lisp/mail/rmailedit.el}, is a major mode that is very similar to |
59 | Text mode except that it provides two additional commands. Its | |
60 | definition is distinct from that of Text mode, but uses that of Text mode. | |
a44af9f2 | 61 | |
5858d11f | 62 | Even if the new mode is not an obvious derivative of any other mode, |
0b41c65c SM |
63 | it is convenient to use @code{define-derived-mode} with a @code{nil} |
64 | parent argument, since it automatically enforces the most important | |
65 | coding conventions for you. | |
5858d11f | 66 | |
969fe9b5 RS |
67 | Rmail Edit mode offers an example of changing the major mode |
68 | temporarily for a buffer, so it can be edited in a different way (with | |
1911e6e5 | 69 | ordinary Emacs commands rather than Rmail commands). In such cases, the |
8241495d | 70 | temporary major mode usually provides a command to switch back to the |
969fe9b5 RS |
71 | buffer's usual mode (Rmail mode, in this case). You might be tempted to |
72 | present the temporary redefinitions inside a recursive edit and restore | |
73 | the usual ones when the user exits; but this is a bad idea because it | |
74 | constrains the user's options when it is done in more than one buffer: | |
75 | recursive edits must be exited most-recently-entered first. Using an | |
76 | alternative major mode avoids this limitation. @xref{Recursive | |
a44af9f2 RS |
77 | Editing}. |
78 | ||
8241495d RS |
79 | The standard GNU Emacs Lisp library directory tree contains the code |
80 | for several major modes, in files such as @file{text-mode.el}, | |
a44af9f2 | 81 | @file{texinfo.el}, @file{lisp-mode.el}, @file{c-mode.el}, and |
a40d4712 PR |
82 | @file{rmail.el}. They are found in various subdirectories of the |
83 | @file{lisp} directory. You can study these libraries to see how modes | |
84 | are written. Text mode is perhaps the simplest major mode aside from | |
a44af9f2 RS |
85 | Fundamental mode. Rmail mode is a complicated and specialized mode. |
86 | ||
87 | @menu | |
88 | * Major Mode Conventions:: Coding conventions for keymaps, etc. | |
89 | * Example Major Modes:: Text mode and Lisp modes. | |
90 | * Auto Major Mode:: How Emacs chooses the major mode automatically. | |
91 | * Mode Help:: Finding out how to use a mode. | |
92 | * Derived Modes:: Defining a new major mode based on another major | |
93 | mode. | |
94 | @end menu | |
95 | ||
96 | @node Major Mode Conventions | |
97 | @subsection Major Mode Conventions | |
98 | ||
99 | The code for existing major modes follows various coding conventions, | |
100 | including conventions for local keymap and syntax table initialization, | |
101 | global names, and hooks. Please follow these conventions when you | |
008c5e26 RS |
102 | define a new major mode. |
103 | ||
104 | This list of conventions is only partial, because each major mode | |
105 | should aim for consistency in general with other Emacs major modes. | |
106 | This makes Emacs as a whole more coherent. It is impossible to list | |
107 | here all the possible points where this issue might come up; if the | |
108 | Emacs developers point out an area where your major mode deviates from | |
109 | the usual conventions, please make it compatible. | |
a44af9f2 RS |
110 | |
111 | @itemize @bullet | |
112 | @item | |
113 | Define a command whose name ends in @samp{-mode}, with no arguments, | |
114 | that switches to the new mode in the current buffer. This command | |
969fe9b5 RS |
115 | should set up the keymap, syntax table, and buffer-local variables in an |
116 | existing buffer, without changing the buffer's contents. | |
a44af9f2 RS |
117 | |
118 | @item | |
de9f0bd9 | 119 | Write a documentation string for this command that describes the |
a44af9f2 RS |
120 | special commands available in this mode. @kbd{C-h m} |
121 | (@code{describe-mode}) in your mode will display this string. | |
122 | ||
123 | The documentation string may include the special documentation | |
124 | substrings, @samp{\[@var{command}]}, @samp{\@{@var{keymap}@}}, and | |
86494bd5 | 125 | @samp{\<@var{keymap}>}, which enable the documentation to adapt |
a44af9f2 RS |
126 | automatically to the user's own key bindings. @xref{Keys in |
127 | Documentation}. | |
128 | ||
129 | @item | |
130 | The major mode command should start by calling | |
969fe9b5 RS |
131 | @code{kill-all-local-variables}. This is what gets rid of the |
132 | buffer-local variables of the major mode previously in effect. | |
a44af9f2 RS |
133 | |
134 | @item | |
135 | The major mode command should set the variable @code{major-mode} to the | |
136 | major mode command symbol. This is how @code{describe-mode} discovers | |
137 | which documentation to print. | |
138 | ||
139 | @item | |
140 | The major mode command should set the variable @code{mode-name} to the | |
969fe9b5 RS |
141 | ``pretty'' name of the mode, as a string. This string appears in the |
142 | mode line. | |
a44af9f2 RS |
143 | |
144 | @item | |
145 | @cindex functions in modes | |
146 | Since all global names are in the same name space, all the global | |
147 | variables, constants, and functions that are part of the mode should | |
148 | have names that start with the major mode name (or with an abbreviation | |
a4b12c74 | 149 | of it if the name is long). @xref{Coding Conventions}. |
a44af9f2 | 150 | |
008c5e26 RS |
151 | @item |
152 | In a major mode for editing some kind of structured text, such as a | |
153 | programming language, indentation of text according to structure is | |
154 | probably useful. So the mode should set @code{indent-line-function} | |
155 | to a suitable function, and probably customize other variables | |
156 | for indentation. | |
157 | ||
a44af9f2 RS |
158 | @item |
159 | @cindex keymaps in modes | |
160 | The major mode should usually have its own keymap, which is used as the | |
969fe9b5 RS |
161 | local keymap in all buffers in that mode. The major mode command should |
162 | call @code{use-local-map} to install this local map. @xref{Active | |
163 | Keymaps}, for more information. | |
a44af9f2 | 164 | |
969fe9b5 | 165 | This keymap should be stored permanently in a global variable named |
a44af9f2 | 166 | @code{@var{modename}-mode-map}. Normally the library that defines the |
de9f0bd9 | 167 | mode sets this variable. |
a44af9f2 | 168 | |
23ce41fc RS |
169 | @xref{Tips for Defining}, for advice about how to write the code to set |
170 | up the mode's keymap variable. | |
171 | ||
a4b12c74 RS |
172 | @item |
173 | The key sequences bound in a major mode keymap should usually start with | |
969fe9b5 | 174 | @kbd{C-c}, followed by a control character, a digit, or @kbd{@{}, |
a4b12c74 RS |
175 | @kbd{@}}, @kbd{<}, @kbd{>}, @kbd{:} or @kbd{;}. The other punctuation |
176 | characters are reserved for minor modes, and ordinary letters are | |
177 | reserved for users. | |
178 | ||
179 | It is reasonable for a major mode to rebind a key sequence with a | |
180 | standard meaning, if it implements a command that does ``the same job'' | |
181 | in a way that fits the major mode better. For example, a major mode for | |
182 | editing a programming language might redefine @kbd{C-M-a} to ``move to | |
183 | the beginning of a function'' in a way that works better for that | |
184 | language. | |
185 | ||
186 | Major modes such as Dired or Rmail that do not allow self-insertion of | |
187 | text can reasonably redefine letters and other printing characters as | |
188 | editing commands. Dired and Rmail both do this. | |
189 | ||
c2e903c0 RS |
190 | @item |
191 | Major modes must not define @key{RET} to do anything other than insert | |
192 | a newline. The command to insert a newline and then indent is | |
008c5e26 RS |
193 | @kbd{C-j}. Please keep this distinction uniform for all major modes. |
194 | ||
195 | @item | |
196 | Major modes should not alter options that are primary a matter of user | |
197 | preference, such as whether Auto-Fill mode is enabled. Leave this to | |
198 | each user to decide. However, a major mode should customize other | |
199 | variables so that Auto-Fill mode will work usefully @emph{if} the user | |
200 | decides to use it. | |
c2e903c0 | 201 | |
a44af9f2 RS |
202 | @item |
203 | @cindex syntax tables in modes | |
204 | The mode may have its own syntax table or may share one with other | |
205 | related modes. If it has its own syntax table, it should store this in | |
de9f0bd9 | 206 | a variable named @code{@var{modename}-mode-syntax-table}. @xref{Syntax |
a44af9f2 RS |
207 | Tables}. |
208 | ||
be9345cf RS |
209 | @item |
210 | If the mode handles a language that has a syntax for comments, it should | |
211 | set the variables that define the comment syntax. @xref{Options for | |
212 | Comments,, Options Controlling Comments, emacs, The GNU Emacs Manual}. | |
213 | ||
a44af9f2 RS |
214 | @item |
215 | @cindex abbrev tables in modes | |
216 | The mode may have its own abbrev table or may share one with other | |
217 | related modes. If it has its own abbrev table, it should store this in | |
218 | a variable named @code{@var{modename}-mode-abbrev-table}. @xref{Abbrev | |
219 | Tables}. | |
220 | ||
be9345cf | 221 | @item |
be9345cf RS |
222 | The mode should specify how to do highlighting for Font Lock mode, by |
223 | setting up a buffer-local value for the variable | |
969fe9b5 | 224 | @code{font-lock-defaults} (@pxref{Font Lock Mode}). |
be9345cf RS |
225 | |
226 | @item | |
be9345cf RS |
227 | The mode should specify how Imenu should find the definitions or |
228 | sections of a buffer, by setting up a buffer-local value for the | |
229 | variable @code{imenu-generic-expression} or | |
969fe9b5 | 230 | @code{imenu-create-index-function} (@pxref{Imenu}). |
be9345cf | 231 | |
de9f0bd9 | 232 | @item |
969fe9b5 RS |
233 | Use @code{defvar} or @code{defcustom} to set mode-related variables, so |
234 | that they are not reinitialized if they already have a value. (Such | |
235 | reinitialization could discard customizations made by the user.) | |
de9f0bd9 | 236 | |
a44af9f2 RS |
237 | @item |
238 | @cindex buffer-local variables in modes | |
239 | To make a buffer-local binding for an Emacs customization variable, use | |
240 | @code{make-local-variable} in the major mode command, not | |
241 | @code{make-variable-buffer-local}. The latter function would make the | |
242 | variable local to every buffer in which it is subsequently set, which | |
243 | would affect buffers that do not use this mode. It is undesirable for a | |
244 | mode to have such global effects. @xref{Buffer-Local Variables}. | |
245 | ||
b5bee757 | 246 | With rare exceptions, the only reasonable way to use |
a40d4712 PR |
247 | @code{make-variable-buffer-local} in a Lisp package is for a variable |
248 | which is used only within that package. Using it on a variable used by | |
249 | other packages would interfere with them. | |
a44af9f2 RS |
250 | |
251 | @item | |
252 | @cindex mode hook | |
253 | @cindex major mode hook | |
254 | Each major mode should have a @dfn{mode hook} named | |
255 | @code{@var{modename}-mode-hook}. The major mode command should run that | |
256 | hook, with @code{run-hooks}, as the very last thing it | |
a4b12c74 | 257 | does. @xref{Hooks}. |
a44af9f2 RS |
258 | |
259 | @item | |
260 | The major mode command may also run the hooks of some more basic modes. | |
261 | For example, @code{indented-text-mode} runs @code{text-mode-hook} as | |
262 | well as @code{indented-text-mode-hook}. It may run these other hooks | |
263 | immediately before the mode's own hook (that is, after everything else), | |
264 | or it may run them earlier. | |
265 | ||
266 | @item | |
267 | If something special should be done if the user switches a buffer from | |
f9f59935 | 268 | this mode to any other major mode, this mode can set up a buffer-local |
969fe9b5 | 269 | value for @code{change-major-mode-hook} (@pxref{Creating Buffer-Local}). |
a44af9f2 RS |
270 | |
271 | @item | |
272 | If this mode is appropriate only for specially-prepared text, then the | |
273 | major mode command symbol should have a property named @code{mode-class} | |
274 | with value @code{special}, put on as follows: | |
275 | ||
276 | @cindex @code{mode-class} property | |
277 | @cindex @code{special} | |
278 | @example | |
279 | (put 'funny-mode 'mode-class 'special) | |
280 | @end example | |
281 | ||
282 | @noindent | |
8241495d | 283 | This tells Emacs that new buffers created while the current buffer is in |
a44af9f2 RS |
284 | Funny mode should not inherit Funny mode. Modes such as Dired, Rmail, |
285 | and Buffer List use this feature. | |
286 | ||
287 | @item | |
288 | If you want to make the new mode the default for files with certain | |
289 | recognizable names, add an element to @code{auto-mode-alist} to select | |
290 | the mode for those file names. If you define the mode command to | |
291 | autoload, you should add this element in the same file that calls | |
292 | @code{autoload}. Otherwise, it is sufficient to add the element in the | |
293 | file that contains the mode definition. @xref{Auto Major Mode}. | |
294 | ||
295 | @item | |
a44af9f2 RS |
296 | In the documentation, you should provide a sample @code{autoload} form |
297 | and an example of how to add to @code{auto-mode-alist}, that users can | |
a40d4712 | 298 | include in their init files (@pxref{Init File}). |
a44af9f2 RS |
299 | |
300 | @item | |
301 | @cindex mode loading | |
de9f0bd9 | 302 | The top-level forms in the file defining the mode should be written so |
a44af9f2 RS |
303 | that they may be evaluated more than once without adverse consequences. |
304 | Even if you never load the file more than once, someone else will. | |
305 | @end itemize | |
306 | ||
a44af9f2 RS |
307 | @node Example Major Modes |
308 | @subsection Major Mode Examples | |
309 | ||
310 | Text mode is perhaps the simplest mode besides Fundamental mode. | |
311 | Here are excerpts from @file{text-mode.el} that illustrate many of | |
312 | the conventions listed above: | |
313 | ||
314 | @smallexample | |
315 | @group | |
316 | ;; @r{Create mode-specific tables.} | |
317 | (defvar text-mode-syntax-table nil | |
318 | "Syntax table used while in text mode.") | |
319 | @end group | |
320 | ||
321 | @group | |
322 | (if text-mode-syntax-table | |
323 | () ; @r{Do not change the table if it is already set up.} | |
324 | (setq text-mode-syntax-table (make-syntax-table)) | |
325 | (modify-syntax-entry ?\" ". " text-mode-syntax-table) | |
326 | (modify-syntax-entry ?\\ ". " text-mode-syntax-table) | |
327 | (modify-syntax-entry ?' "w " text-mode-syntax-table)) | |
328 | @end group | |
329 | ||
330 | @group | |
331 | (defvar text-mode-abbrev-table nil | |
332 | "Abbrev table used while in text mode.") | |
333 | (define-abbrev-table 'text-mode-abbrev-table ()) | |
334 | @end group | |
335 | ||
336 | @group | |
a40d4712 PR |
337 | (defvar text-mode-map nil ; @r{Create a mode-specific keymap.} |
338 | "Keymap for Text mode. | |
339 | Many other modes, such as Mail mode, Outline mode and Indented Text mode, | |
340 | inherit all the commands defined in this map.") | |
a44af9f2 RS |
341 | |
342 | (if text-mode-map | |
343 | () ; @r{Do not change the keymap if it is already set up.} | |
344 | (setq text-mode-map (make-sparse-keymap)) | |
a40d4712 | 345 | (define-key text-mode-map "\e\t" 'ispell-complete-word) |
a9f0a989 | 346 | (define-key text-mode-map "\t" 'indent-relative) |
a44af9f2 RS |
347 | (define-key text-mode-map "\es" 'center-line) |
348 | (define-key text-mode-map "\eS" 'center-paragraph)) | |
349 | @end group | |
350 | @end smallexample | |
351 | ||
352 | Here is the complete major mode function definition for Text mode: | |
353 | ||
354 | @smallexample | |
355 | @group | |
356 | (defun text-mode () | |
29b677db | 357 | "Major mode for editing text intended for humans to read... |
a44af9f2 RS |
358 | Special commands: \\@{text-mode-map@} |
359 | @end group | |
360 | @group | |
361 | Turning on text-mode runs the hook `text-mode-hook'." | |
362 | (interactive) | |
363 | (kill-all-local-variables) | |
969fe9b5 | 364 | (use-local-map text-mode-map) |
a44af9f2 RS |
365 | @end group |
366 | @group | |
a44af9f2 RS |
367 | (setq local-abbrev-table text-mode-abbrev-table) |
368 | (set-syntax-table text-mode-syntax-table) | |
969fe9b5 RS |
369 | @end group |
370 | @group | |
371 | (make-local-variable 'paragraph-start) | |
372 | (setq paragraph-start (concat "[ \t]*$\\|" page-delimiter)) | |
373 | (make-local-variable 'paragraph-separate) | |
374 | (setq paragraph-separate paragraph-start) | |
a40d4712 PR |
375 | (make-local-variable 'indent-line-function) |
376 | (setq indent-line-function 'indent-relative-maybe) | |
969fe9b5 RS |
377 | @end group |
378 | @group | |
379 | (setq mode-name "Text") | |
380 | (setq major-mode 'text-mode) | |
a44af9f2 RS |
381 | (run-hooks 'text-mode-hook)) ; @r{Finally, this permits the user to} |
382 | ; @r{customize the mode with a hook.} | |
383 | @end group | |
384 | @end smallexample | |
385 | ||
386 | @cindex @file{lisp-mode.el} | |
387 | The three Lisp modes (Lisp mode, Emacs Lisp mode, and Lisp | |
388 | Interaction mode) have more features than Text mode and the code is | |
389 | correspondingly more complicated. Here are excerpts from | |
390 | @file{lisp-mode.el} that illustrate how these modes are written. | |
391 | ||
392 | @cindex syntax table example | |
393 | @smallexample | |
394 | @group | |
395 | ;; @r{Create mode-specific table variables.} | |
396 | (defvar lisp-mode-syntax-table nil "") | |
397 | (defvar emacs-lisp-mode-syntax-table nil "") | |
398 | (defvar lisp-mode-abbrev-table nil "") | |
399 | @end group | |
400 | ||
401 | @group | |
402 | (if (not emacs-lisp-mode-syntax-table) ; @r{Do not change the table} | |
403 | ; @r{if it is already set.} | |
404 | (let ((i 0)) | |
405 | (setq emacs-lisp-mode-syntax-table (make-syntax-table)) | |
406 | @end group | |
407 | ||
408 | @group | |
409 | ;; @r{Set syntax of chars up to 0 to class of chars that are} | |
410 | ;; @r{part of symbol names but not words.} | |
8241495d | 411 | ;; @r{(The number 0 is @code{48} in the @sc{ascii} character set.)} |
a44af9f2 RS |
412 | (while (< i ?0) |
413 | (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) | |
414 | (setq i (1+ i))) | |
415 | @dots{} | |
416 | @end group | |
417 | @group | |
418 | ;; @r{Set the syntax for other characters.} | |
419 | (modify-syntax-entry ? " " emacs-lisp-mode-syntax-table) | |
420 | (modify-syntax-entry ?\t " " emacs-lisp-mode-syntax-table) | |
421 | @dots{} | |
422 | @end group | |
423 | @group | |
424 | (modify-syntax-entry ?\( "() " emacs-lisp-mode-syntax-table) | |
425 | (modify-syntax-entry ?\) ")( " emacs-lisp-mode-syntax-table) | |
426 | @dots{})) | |
427 | ;; @r{Create an abbrev table for lisp-mode.} | |
428 | (define-abbrev-table 'lisp-mode-abbrev-table ()) | |
429 | @end group | |
430 | @end smallexample | |
431 | ||
432 | Much code is shared among the three Lisp modes. The following | |
433 | function sets various variables; it is called by each of the major Lisp | |
434 | mode functions: | |
435 | ||
436 | @smallexample | |
437 | @group | |
438 | (defun lisp-mode-variables (lisp-syntax) | |
a44af9f2 | 439 | (cond (lisp-syntax |
969fe9b5 | 440 | (set-syntax-table lisp-mode-syntax-table))) |
a44af9f2 | 441 | (setq local-abbrev-table lisp-mode-abbrev-table) |
a9f0a989 | 442 | @dots{} |
a44af9f2 RS |
443 | @end group |
444 | @end smallexample | |
445 | ||
446 | Functions such as @code{forward-paragraph} use the value of the | |
447 | @code{paragraph-start} variable. Since Lisp code is different from | |
448 | ordinary text, the @code{paragraph-start} variable needs to be set | |
449 | specially to handle Lisp. Also, comments are indented in a special | |
450 | fashion in Lisp and the Lisp modes need their own mode-specific | |
451 | @code{comment-indent-function}. The code to set these variables is the | |
452 | rest of @code{lisp-mode-variables}. | |
453 | ||
454 | @smallexample | |
455 | @group | |
456 | (make-local-variable 'paragraph-start) | |
969fe9b5 RS |
457 | (setq paragraph-start (concat page-delimiter "\\|$" )) |
458 | (make-local-variable 'paragraph-separate) | |
459 | (setq paragraph-separate paragraph-start) | |
a44af9f2 RS |
460 | @dots{} |
461 | @end group | |
462 | @group | |
463 | (make-local-variable 'comment-indent-function) | |
464 | (setq comment-indent-function 'lisp-comment-indent)) | |
a40d4712 | 465 | @dots{} |
a44af9f2 RS |
466 | @end group |
467 | @end smallexample | |
468 | ||
469 | Each of the different Lisp modes has a slightly different keymap. For | |
f9f59935 | 470 | example, Lisp mode binds @kbd{C-c C-z} to @code{run-lisp}, but the other |
a44af9f2 | 471 | Lisp modes do not. However, all Lisp modes have some commands in |
969fe9b5 | 472 | common. The following code sets up the common commands: |
a44af9f2 RS |
473 | |
474 | @smallexample | |
475 | @group | |
969fe9b5 RS |
476 | (defvar shared-lisp-mode-map () |
477 | "Keymap for commands shared by all sorts of Lisp modes.") | |
478 | ||
479 | (if shared-lisp-mode-map | |
480 | () | |
481 | (setq shared-lisp-mode-map (make-sparse-keymap)) | |
482 | (define-key shared-lisp-mode-map "\e\C-q" 'indent-sexp) | |
483 | (define-key shared-lisp-mode-map "\177" | |
484 | 'backward-delete-char-untabify)) | |
a44af9f2 RS |
485 | @end group |
486 | @end smallexample | |
487 | ||
969fe9b5 RS |
488 | @noindent |
489 | And here is the code to set up the keymap for Lisp mode: | |
a44af9f2 RS |
490 | |
491 | @smallexample | |
492 | @group | |
969fe9b5 | 493 | (defvar lisp-mode-map () |
29b677db | 494 | "Keymap for ordinary Lisp mode...") |
969fe9b5 RS |
495 | |
496 | (if lisp-mode-map | |
a44af9f2 | 497 | () |
969fe9b5 RS |
498 | (setq lisp-mode-map (make-sparse-keymap)) |
499 | (set-keymap-parent lisp-mode-map shared-lisp-mode-map) | |
500 | (define-key lisp-mode-map "\e\C-x" 'lisp-eval-defun) | |
501 | (define-key lisp-mode-map "\C-c\C-z" 'run-lisp)) | |
a44af9f2 RS |
502 | @end group |
503 | @end smallexample | |
504 | ||
505 | Finally, here is the complete major mode function definition for | |
86494bd5 | 506 | Lisp mode. |
a44af9f2 RS |
507 | |
508 | @smallexample | |
509 | @group | |
969fe9b5 RS |
510 | (defun lisp-mode () |
511 | "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp. | |
a44af9f2 RS |
512 | Commands: |
513 | Delete converts tabs to spaces as it moves back. | |
514 | Blank lines separate paragraphs. Semicolons start comments. | |
969fe9b5 RS |
515 | \\@{lisp-mode-map@} |
516 | Note that `run-lisp' may be used either to start an inferior Lisp job | |
517 | or to switch back to an existing one. | |
a44af9f2 | 518 | @end group |
969fe9b5 | 519 | |
a44af9f2 | 520 | @group |
969fe9b5 RS |
521 | Entry to this mode calls the value of `lisp-mode-hook' |
522 | if that value is non-nil." | |
a44af9f2 RS |
523 | (interactive) |
524 | (kill-all-local-variables) | |
a44af9f2 RS |
525 | @end group |
526 | @group | |
969fe9b5 RS |
527 | (use-local-map lisp-mode-map) ; @r{Select the mode's keymap.} |
528 | (setq major-mode 'lisp-mode) ; @r{This is how @code{describe-mode}} | |
a44af9f2 | 529 | ; @r{finds out what to describe.} |
969fe9b5 RS |
530 | (setq mode-name "Lisp") ; @r{This goes into the mode line.} |
531 | (lisp-mode-variables t) ; @r{This defines various variables.} | |
532 | @end group | |
533 | @group | |
534 | (setq imenu-case-fold-search t) | |
535 | (set-syntax-table lisp-mode-syntax-table) | |
536 | (run-hooks 'lisp-mode-hook)) ; @r{This permits the user to use a} | |
a44af9f2 RS |
537 | ; @r{hook to customize the mode.} |
538 | @end group | |
539 | @end smallexample | |
540 | ||
541 | @node Auto Major Mode | |
542 | @subsection How Emacs Chooses a Major Mode | |
543 | ||
544 | Based on information in the file name or in the file itself, Emacs | |
545 | automatically selects a major mode for the new buffer when a file is | |
969fe9b5 | 546 | visited. It also processes local variables specified in the file text. |
a44af9f2 RS |
547 | |
548 | @deffn Command fundamental-mode | |
549 | Fundamental mode is a major mode that is not specialized for anything | |
550 | in particular. Other major modes are defined in effect by comparison | |
551 | with this one---their definitions say what to change, starting from | |
552 | Fundamental mode. The @code{fundamental-mode} function does @emph{not} | |
553 | run any hooks; you're not supposed to customize it. (If you want Emacs | |
554 | to behave differently in Fundamental mode, change the @emph{global} | |
555 | state of Emacs.) | |
556 | @end deffn | |
557 | ||
558 | @deffn Command normal-mode &optional find-file | |
969fe9b5 | 559 | This function establishes the proper major mode and buffer-local variable |
a44af9f2 RS |
560 | bindings for the current buffer. First it calls @code{set-auto-mode}, |
561 | then it runs @code{hack-local-variables} to parse, and bind or | |
969fe9b5 | 562 | evaluate as appropriate, the file's local variables. |
a44af9f2 | 563 | |
969fe9b5 RS |
564 | If the @var{find-file} argument to @code{normal-mode} is non-@code{nil}, |
565 | @code{normal-mode} assumes that the @code{find-file} function is calling | |
566 | it. In this case, it may process a local variables list at the end of | |
567 | the file and in the @samp{-*-} line. The variable | |
568 | @code{enable-local-variables} controls whether to do so. @xref{File | |
569 | variables, , Local Variables in Files, emacs, The GNU Emacs Manual}, for | |
570 | the syntax of the local variables section of a file. | |
a44af9f2 | 571 | |
bfe721d1 | 572 | If you run @code{normal-mode} interactively, the argument |
a44af9f2 RS |
573 | @var{find-file} is normally @code{nil}. In this case, |
574 | @code{normal-mode} unconditionally processes any local variables list. | |
a44af9f2 RS |
575 | |
576 | @cindex file mode specification error | |
bfe721d1 | 577 | @code{normal-mode} uses @code{condition-case} around the call to the |
a44af9f2 RS |
578 | major mode function, so errors are caught and reported as a @samp{File |
579 | mode specification error}, followed by the original error message. | |
580 | @end deffn | |
581 | ||
a44af9f2 RS |
582 | @defun set-auto-mode |
583 | @cindex visited file mode | |
584 | This function selects the major mode that is appropriate for the | |
585 | current buffer. It may base its decision on the value of the @w{@samp{-*-}} | |
76352dc1 RS |
586 | line, on the visited file name (using @code{auto-mode-alist}), on the |
587 | @w{@samp{#!}} line (using @code{interpreter-mode-alist}), or on the | |
969fe9b5 | 588 | file's local variables list. However, this function does not look for |
a44af9f2 RS |
589 | the @samp{mode:} local variable near the end of a file; the |
590 | @code{hack-local-variables} function does that. @xref{Choosing Modes, , | |
591 | How Major Modes are Chosen, emacs, The GNU Emacs Manual}. | |
592 | @end defun | |
593 | ||
594 | @defopt default-major-mode | |
969fe9b5 | 595 | This variable holds the default major mode for new buffers. The |
a44af9f2 RS |
596 | standard value is @code{fundamental-mode}. |
597 | ||
969fe9b5 | 598 | If the value of @code{default-major-mode} is @code{nil}, Emacs uses |
a44af9f2 | 599 | the (previously) current buffer's major mode for the major mode of a new |
f9f59935 | 600 | buffer. However, if that major mode symbol has a @code{mode-class} |
a44af9f2 RS |
601 | property with value @code{special}, then it is not used for new buffers; |
602 | Fundamental mode is used instead. The modes that have this property are | |
603 | those such as Dired and Rmail that are useful only with text that has | |
604 | been specially prepared. | |
605 | @end defopt | |
606 | ||
22697dac KH |
607 | @defun set-buffer-major-mode buffer |
608 | This function sets the major mode of @var{buffer} to the value of | |
609 | @code{default-major-mode}. If that variable is @code{nil}, it uses | |
610 | the current buffer's major mode (if that is suitable). | |
611 | ||
612 | The low-level primitives for creating buffers do not use this function, | |
bfe721d1 KH |
613 | but medium-level commands such as @code{switch-to-buffer} and |
614 | @code{find-file-noselect} use it whenever they create buffers. | |
22697dac KH |
615 | @end defun |
616 | ||
a44af9f2 RS |
617 | @defvar initial-major-mode |
618 | @cindex @samp{*scratch*} | |
619 | The value of this variable determines the major mode of the initial | |
620 | @samp{*scratch*} buffer. The value should be a symbol that is a major | |
f9f59935 | 621 | mode command. The default value is @code{lisp-interaction-mode}. |
a44af9f2 RS |
622 | @end defvar |
623 | ||
624 | @defvar auto-mode-alist | |
625 | This variable contains an association list of file name patterns | |
626 | (regular expressions; @pxref{Regular Expressions}) and corresponding | |
f9f59935 RS |
627 | major mode commands. Usually, the file name patterns test for suffixes, |
628 | such as @samp{.el} and @samp{.c}, but this need not be the case. An | |
629 | ordinary element of the alist looks like @code{(@var{regexp} . | |
a44af9f2 RS |
630 | @var{mode-function})}. |
631 | ||
632 | For example, | |
633 | ||
634 | @smallexample | |
635 | @group | |
969fe9b5 | 636 | (("\\`/tmp/fol/" . text-mode) |
24675e99 RS |
637 | ("\\.texinfo\\'" . texinfo-mode) |
638 | ("\\.texi\\'" . texinfo-mode) | |
a44af9f2 RS |
639 | @end group |
640 | @group | |
24675e99 RS |
641 | ("\\.el\\'" . emacs-lisp-mode) |
642 | ("\\.c\\'" . c-mode) | |
643 | ("\\.h\\'" . c-mode) | |
a44af9f2 RS |
644 | @dots{}) |
645 | @end group | |
646 | @end smallexample | |
647 | ||
648 | When you visit a file whose expanded file name (@pxref{File Name | |
649 | Expansion}) matches a @var{regexp}, @code{set-auto-mode} calls the | |
650 | corresponding @var{mode-function}. This feature enables Emacs to select | |
651 | the proper major mode for most files. | |
652 | ||
653 | If an element of @code{auto-mode-alist} has the form @code{(@var{regexp} | |
654 | @var{function} t)}, then after calling @var{function}, Emacs searches | |
655 | @code{auto-mode-alist} again for a match against the portion of the file | |
969fe9b5 RS |
656 | name that did not match before. This feature is useful for |
657 | uncompression packages: an entry of the form @code{("\\.gz\\'" | |
658 | @var{function} t)} can uncompress the file and then put the uncompressed | |
659 | file in the proper mode according to the name sans @samp{.gz}. | |
a44af9f2 RS |
660 | |
661 | Here is an example of how to prepend several pattern pairs to | |
662 | @code{auto-mode-alist}. (You might use this sort of expression in your | |
a40d4712 | 663 | init file.) |
a44af9f2 RS |
664 | |
665 | @smallexample | |
666 | @group | |
667 | (setq auto-mode-alist | |
668 | (append | |
f9f59935 | 669 | ;; @r{File name (within directory) starts with a dot.} |
24675e99 | 670 | '(("/\\.[^/]*\\'" . fundamental-mode) |
de9f0bd9 | 671 | ;; @r{File name has no dot.} |
24675e99 | 672 | ("[^\\./]*\\'" . fundamental-mode) |
de9f0bd9 | 673 | ;; @r{File name ends in @samp{.C}.} |
24675e99 | 674 | ("\\.C\\'" . c++-mode)) |
a44af9f2 RS |
675 | auto-mode-alist)) |
676 | @end group | |
677 | @end smallexample | |
678 | @end defvar | |
679 | ||
680 | @defvar interpreter-mode-alist | |
f9f59935 | 681 | This variable specifies major modes to use for scripts that specify a |
86494bd5 | 682 | command interpreter in a @samp{#!} line. Its value is a list of |
a44af9f2 RS |
683 | elements of the form @code{(@var{interpreter} . @var{mode})}; for |
684 | example, @code{("perl" . perl-mode)} is one element present by default. | |
685 | The element says to use mode @var{mode} if the file specifies | |
f9f59935 RS |
686 | an interpreter which matches @var{interpreter}. The value of |
687 | @var{interpreter} is actually a regular expression. | |
a44af9f2 | 688 | |
de9f0bd9 RS |
689 | This variable is applicable only when the @code{auto-mode-alist} does |
690 | not indicate which major mode to use. | |
a44af9f2 RS |
691 | @end defvar |
692 | ||
a44af9f2 RS |
693 | @node Mode Help |
694 | @subsection Getting Help about a Major Mode | |
695 | @cindex mode help | |
696 | @cindex help for major mode | |
697 | @cindex documentation for major mode | |
698 | ||
699 | The @code{describe-mode} function is used to provide information | |
700 | about major modes. It is normally called with @kbd{C-h m}. The | |
701 | @code{describe-mode} function uses the value of @code{major-mode}, | |
702 | which is why every major mode function needs to set the | |
703 | @code{major-mode} variable. | |
704 | ||
705 | @deffn Command describe-mode | |
706 | This function displays the documentation of the current major mode. | |
707 | ||
708 | The @code{describe-mode} function calls the @code{documentation} | |
709 | function using the value of @code{major-mode} as an argument. Thus, it | |
710 | displays the documentation string of the major mode function. | |
711 | (@xref{Accessing Documentation}.) | |
712 | @end deffn | |
713 | ||
714 | @defvar major-mode | |
715 | This variable holds the symbol for the current buffer's major mode. | |
de9f0bd9 | 716 | This symbol should have a function definition that is the command to |
a44af9f2 | 717 | switch to that major mode. The @code{describe-mode} function uses the |
de9f0bd9 | 718 | documentation string of the function as the documentation of the major |
a44af9f2 RS |
719 | mode. |
720 | @end defvar | |
721 | ||
722 | @node Derived Modes | |
723 | @subsection Defining Derived Modes | |
724 | ||
725 | It's often useful to define a new major mode in terms of an existing | |
726 | one. An easy way to do this is to use @code{define-derived-mode}. | |
727 | ||
de9f0bd9 | 728 | @defmac define-derived-mode variant parent name docstring body@dots{} |
a44af9f2 | 729 | This construct defines @var{variant} as a major mode command, using |
de9f0bd9 | 730 | @var{name} as the string form of the mode name. |
a44af9f2 | 731 | |
de9f0bd9 RS |
732 | The new command @var{variant} is defined to call the function |
733 | @var{parent}, then override certain aspects of that parent mode: | |
a44af9f2 RS |
734 | |
735 | @itemize @bullet | |
736 | @item | |
737 | The new mode has its own keymap, named @code{@var{variant}-map}. | |
738 | @code{define-derived-mode} initializes this map to inherit from | |
739 | @code{@var{parent}-map}, if it is not already set. | |
740 | ||
741 | @item | |
de9f0bd9 | 742 | The new mode has its own syntax table, kept in the variable |
a44af9f2 RS |
743 | @code{@var{variant}-syntax-table}. |
744 | @code{define-derived-mode} initializes this variable by copying | |
745 | @code{@var{parent}-syntax-table}, if it is not already set. | |
746 | ||
747 | @item | |
de9f0bd9 | 748 | The new mode has its own abbrev table, kept in the variable |
a44af9f2 RS |
749 | @code{@var{variant}-abbrev-table}. |
750 | @code{define-derived-mode} initializes this variable by copying | |
751 | @code{@var{parent}-abbrev-table}, if it is not already set. | |
752 | ||
753 | @item | |
754 | The new mode has its own mode hook, @code{@var{variant}-hook}, | |
755 | which it runs in standard fashion as the very last thing that it does. | |
756 | (The new mode also runs the mode hook of @var{parent} as part | |
757 | of calling @var{parent}.) | |
758 | @end itemize | |
759 | ||
760 | In addition, you can specify how to override other aspects of | |
de9f0bd9 | 761 | @var{parent} with @var{body}. The command @var{variant} |
a44af9f2 RS |
762 | evaluates the forms in @var{body} after setting up all its usual |
763 | overrides, just before running @code{@var{variant}-hook}. | |
764 | ||
765 | The argument @var{docstring} specifies the documentation string for the | |
766 | new mode. If you omit @var{docstring}, @code{define-derived-mode} | |
767 | generates a documentation string. | |
768 | ||
769 | Here is a hypothetical example: | |
770 | ||
771 | @example | |
772 | (define-derived-mode hypertext-mode | |
773 | text-mode "Hypertext" | |
774 | "Major mode for hypertext. | |
775 | \\@{hypertext-mode-map@}" | |
776 | (setq case-fold-search nil)) | |
777 | ||
778 | (define-key hypertext-mode-map | |
779 | [down-mouse-3] 'do-hyper-link) | |
780 | @end example | |
f140458b RS |
781 | |
782 | Do not write an @code{interactive} spec in the definition; | |
783 | @code{define-derived-mode} does that automatically. | |
a44af9f2 RS |
784 | @end defmac |
785 | ||
786 | @node Minor Modes | |
787 | @section Minor Modes | |
788 | @cindex minor mode | |
789 | ||
790 | A @dfn{minor mode} provides features that users may enable or disable | |
791 | independently of the choice of major mode. Minor modes can be enabled | |
792 | individually or in combination. Minor modes would be better named | |
969fe9b5 RS |
793 | ``generally available, optional feature modes,'' except that such a name |
794 | would be unwieldy. | |
a44af9f2 | 795 | |
8241495d RS |
796 | A minor mode is not usually meant as a variation of a single major mode. |
797 | Usually they are general and can apply to many major modes. For | |
969fe9b5 | 798 | example, Auto Fill mode works with any major mode that permits text |
a44af9f2 RS |
799 | insertion. To be general, a minor mode must be effectively independent |
800 | of the things major modes do. | |
801 | ||
802 | A minor mode is often much more difficult to implement than a major | |
803 | mode. One reason is that you should be able to activate and deactivate | |
de9f0bd9 RS |
804 | minor modes in any order. A minor mode should be able to have its |
805 | desired effect regardless of the major mode and regardless of the other | |
806 | minor modes in effect. | |
a44af9f2 RS |
807 | |
808 | Often the biggest problem in implementing a minor mode is finding a | |
809 | way to insert the necessary hook into the rest of Emacs. Minor mode | |
bfe721d1 | 810 | keymaps make this easier than it used to be. |
a44af9f2 RS |
811 | |
812 | @menu | |
813 | * Minor Mode Conventions:: Tips for writing a minor mode. | |
814 | * Keymaps and Minor Modes:: How a minor mode can have its own keymap. | |
2468d0c0 | 815 | * Defining Minor Modes:: A convenient facility for defining minor modes. |
a44af9f2 RS |
816 | @end menu |
817 | ||
818 | @node Minor Mode Conventions | |
819 | @subsection Conventions for Writing Minor Modes | |
820 | @cindex minor mode conventions | |
821 | @cindex conventions for writing minor modes | |
822 | ||
823 | There are conventions for writing minor modes just as there are for | |
824 | major modes. Several of the major mode conventions apply to minor | |
825 | modes as well: those regarding the name of the mode initialization | |
826 | function, the names of global symbols, and the use of keymaps and | |
827 | other tables. | |
828 | ||
829 | In addition, there are several conventions that are specific to | |
830 | minor modes. | |
831 | ||
832 | @itemize @bullet | |
833 | @item | |
834 | @cindex mode variable | |
969fe9b5 RS |
835 | Make a variable whose name ends in @samp{-mode} to control the minor |
836 | mode. We call this the @dfn{mode variable}. The minor mode command | |
837 | should set this variable (@code{nil} to disable; anything else to | |
1911e6e5 | 838 | enable). |
969fe9b5 | 839 | |
8241495d | 840 | If possible, implement the mode so that setting the variable |
969fe9b5 | 841 | automatically enables or disables the mode. Then the minor mode command |
1911e6e5 | 842 | does not need to do anything except set the variable. |
a44af9f2 RS |
843 | |
844 | This variable is used in conjunction with the @code{minor-mode-alist} to | |
845 | display the minor mode name in the mode line. It can also enable | |
846 | or disable a minor mode keymap. Individual commands or hooks can also | |
847 | check the variable's value. | |
848 | ||
849 | If you want the minor mode to be enabled separately in each buffer, | |
850 | make the variable buffer-local. | |
851 | ||
852 | @item | |
853 | Define a command whose name is the same as the mode variable. | |
854 | Its job is to enable and disable the mode by setting the variable. | |
855 | ||
856 | The command should accept one optional argument. If the argument is | |
857 | @code{nil}, it should toggle the mode (turn it on if it is off, and off | |
858 | if it is on). Otherwise, it should turn the mode on if the argument is | |
859 | a positive integer, a symbol other than @code{nil} or @code{-}, or a | |
860 | list whose @sc{car} is such an integer or symbol; it should turn the | |
861 | mode off otherwise. | |
862 | ||
bfe721d1 KH |
863 | Here is an example taken from the definition of @code{transient-mark-mode}. |
864 | It shows the use of @code{transient-mark-mode} as a variable that enables or | |
de9f0bd9 RS |
865 | disables the mode's behavior, and also shows the proper way to toggle, |
866 | enable or disable the minor mode based on the raw prefix argument value. | |
a44af9f2 RS |
867 | |
868 | @smallexample | |
869 | @group | |
bfe721d1 KH |
870 | (setq transient-mark-mode |
871 | (if (null arg) (not transient-mark-mode) | |
a44af9f2 RS |
872 | (> (prefix-numeric-value arg) 0))) |
873 | @end group | |
874 | @end smallexample | |
875 | ||
876 | @item | |
877 | Add an element to @code{minor-mode-alist} for each minor mode | |
969fe9b5 RS |
878 | (@pxref{Mode Line Variables}), if you want to indicate the minor mode in |
879 | the mode line. This element should be a list of the following form: | |
a44af9f2 RS |
880 | |
881 | @smallexample | |
882 | (@var{mode-variable} @var{string}) | |
883 | @end smallexample | |
884 | ||
de9f0bd9 | 885 | Here @var{mode-variable} is the variable that controls enabling of the |
a44af9f2 RS |
886 | minor mode, and @var{string} is a short string, starting with a space, |
887 | to represent the mode in the mode line. These strings must be short so | |
888 | that there is room for several of them at once. | |
889 | ||
890 | When you add an element to @code{minor-mode-alist}, use @code{assq} to | |
891 | check for an existing element, to avoid duplication. For example: | |
892 | ||
893 | @smallexample | |
894 | @group | |
a40d4712 PR |
895 | (unless (assq 'leif-mode minor-mode-alist) |
896 | (setq minor-mode-alist | |
897 | (cons '(leif-mode " Leif") minor-mode-alist))) | |
a44af9f2 RS |
898 | @end group |
899 | @end smallexample | |
a44af9f2 | 900 | |
a40d4712 PR |
901 | @noindent |
902 | or like this, using @code{add-to-list} (@pxref{Setting Variables}): | |
903 | ||
904 | @smallexample | |
905 | @group | |
906 | (add-to-list 'minor-mode-alist '(leif-mode " Leif")) | |
907 | @end group | |
908 | @end smallexample | |
909 | @end itemize | |
1911e6e5 | 910 | |
8241495d RS |
911 | Global minor modes distributed with Emacs should if possible support |
912 | enabling and disabling via Custom (@pxref{Customization}). To do this, | |
913 | the first step is to define the mode variable with @code{defcustom}, and | |
914 | specify @code{:type boolean}. | |
915 | ||
916 | If just setting the variable is not sufficient to enable the mode, you | |
917 | should also specify a @code{:set} method which enables the mode by | |
918 | invoke the mode command. Note in the variable's documentation string that | |
919 | setting the variable other than via Custom may not take effect. | |
920 | ||
921 | Also mark the definition with an autoload cookie (@pxref{Autoload}), | |
922 | and specify a @code{:require} so that customizing the variable will load | |
923 | the library that defines the mode. This will copy suitable definitions | |
924 | into @file{loaddefs.el} so that users can use @code{customize-option} to | |
925 | enable the mode. For example: | |
926 | ||
927 | @smallexample | |
928 | @group | |
929 | ||
930 | ;;;###autoload | |
931 | (defcustom msb-mode nil | |
932 | "Toggle msb-mode. | |
933 | Setting this variable directly does not take effect; | |
934 | use either \\[customize] or the function `msb-mode'." | |
935 | :set (lambda (symbol value) | |
936 | (msb-mode (or value 0))) | |
937 | :initialize 'custom-initialize-default | |
938 | :version "20.4" | |
939 | :type 'boolean | |
940 | :group 'msb | |
941 | :require 'msb) | |
942 | @end group | |
943 | @end smallexample | |
944 | ||
a44af9f2 RS |
945 | @node Keymaps and Minor Modes |
946 | @subsection Keymaps and Minor Modes | |
947 | ||
bfe721d1 KH |
948 | Each minor mode can have its own keymap, which is active when the mode |
949 | is enabled. To set up a keymap for a minor mode, add an element to the | |
950 | alist @code{minor-mode-map-alist}. @xref{Active Keymaps}. | |
a44af9f2 RS |
951 | |
952 | @cindex @code{self-insert-command}, minor modes | |
f9f59935 | 953 | One use of minor mode keymaps is to modify the behavior of certain |
a44af9f2 RS |
954 | self-inserting characters so that they do something else as well as |
955 | self-insert. In general, this is the only way to do that, since the | |
956 | facilities for customizing @code{self-insert-command} are limited to | |
957 | special cases (designed for abbrevs and Auto Fill mode). (Do not try | |
958 | substituting your own definition of @code{self-insert-command} for the | |
959 | standard one. The editor command loop handles this function specially.) | |
960 | ||
a4b12c74 RS |
961 | The key sequences bound in a minor mode should consist of @kbd{C-c} |
962 | followed by a punctuation character @emph{other than} @kbd{@{}, | |
8241495d | 963 | @kbd{@}}, @kbd{<}, @kbd{>}, @kbd{:}, and @kbd{;}. (Those few punctuation |
a4b12c74 RS |
964 | characters are reserved for major modes.) |
965 | ||
2468d0c0 DL |
966 | @node Defining Minor Modes |
967 | @subsection Defining Minor Modes | |
f9f59935 | 968 | |
2468d0c0 DL |
969 | The macro @code{define-minor-mode} offers a convenient way of |
970 | implementing a mode in one self-contained definition. It supports only | |
8241495d | 971 | buffer-local minor modes, not global ones. |
f9f59935 | 972 | |
2468d0c0 DL |
973 | @defmac define-minor-mode mode doc &optional init-value mode-indicator keymap body... |
974 | @tindex define-minor-mode | |
f9f59935 | 975 | This macro defines a new minor mode whose name is @var{mode} (a symbol). |
2468d0c0 DL |
976 | It defines a command named @var{mode} to toggle the minor |
977 | mode, with @var{doc} as its documentation string. It also defines a | |
978 | variable named @var{mode}, which is set to @code{t} or @code{nil} by | |
979 | enabling or disabling the mode. The variable is initialized to | |
980 | @var{init-value}. | |
f9f59935 | 981 | |
2468d0c0 DL |
982 | The command named @var{mode} finishes by executing the @var{body} forms, |
983 | if any, after it has performed the standard actions such as setting | |
984 | the variable named @var{mode}. | |
f9f59935 RS |
985 | |
986 | The string @var{mode-indicator} says what to display in the mode line | |
987 | when the mode is enabled; if it is @code{nil}, the mode is not displayed | |
988 | in the mode line. | |
989 | ||
990 | The optional argument @var{keymap} specifies the keymap for the minor mode. | |
991 | It can be a variable name, whose value is the keymap, or it can be an alist | |
992 | specifying bindings in this form: | |
993 | ||
994 | @example | |
995 | (@var{key-sequence} . @var{definition}) | |
996 | @end example | |
997 | @end defmac | |
998 | ||
2468d0c0 | 999 | Here is an example of using @code{define-minor-mode}: |
f9f59935 RS |
1000 | |
1001 | @smallexample | |
2468d0c0 | 1002 | (define-minor-mode hungry-mode |
969fe9b5 | 1003 | "Toggle Hungry mode. |
f9f59935 RS |
1004 | With no argument, this command toggles the mode. |
1005 | Non-null prefix argument turns on the mode. | |
1006 | Null prefix argument turns off the mode. | |
1007 | ||
1008 | When Hungry mode is enabled, the control delete key | |
1009 | gobbles all preceding whitespace except the last. | |
1010 | See the command \\[hungry-electric-delete]." | |
1011 | ;; The initial value. | |
1012 | nil | |
1013 | ;; The indicator for the mode line. | |
1014 | " Hungry" | |
1015 | ;; The minor mode bindings. | |
1016 | '(("\C-\^?" . hungry-electric-delete) | |
1017 | ("\C-\M-\^?" | |
1018 | . (lambda () | |
1019 | (interactive) | |
1020 | (hungry-electric-delete t))))) | |
1021 | @end smallexample | |
1022 | ||
1023 | @noindent | |
1024 | This defines a minor mode named ``Hungry mode'', a command named | |
1025 | @code{hungry-mode} to toggle it, a variable named @code{hungry-mode} | |
1026 | which indicates whether the mode is enabled, and a variable named | |
1027 | @code{hungry-mode-map} which holds the keymap that is active when the | |
1028 | mode is enabled. It initializes the keymap with key bindings for | |
1029 | @kbd{C-@key{DEL}} and @kbd{C-M-@key{DEL}}. | |
1030 | ||
2468d0c0 DL |
1031 | |
1032 | @findex easy-mmode-define-minor-mode | |
1033 | The name @code{easy-mmode-define-minor-mode} is an alias | |
1034 | for this macro. | |
1035 | ||
a44af9f2 RS |
1036 | @node Mode Line Format |
1037 | @section Mode Line Format | |
1038 | @cindex mode line | |
1039 | ||
8241495d RS |
1040 | Each Emacs window (aside from minibuffer windows) typically has a mode |
1041 | line at the bottom, which displays status information about the buffer | |
1042 | displayed in the window. The mode line contains information about the | |
1043 | buffer, such as its name, associated file, depth of recursive editing, | |
1044 | and major and minor modes. A window can also have a @dfn{header | |
1045 | line}, which is much like the mode line but appears at the top of the | |
1046 | window (starting in Emacs 21). | |
a44af9f2 | 1047 | |
8241495d RS |
1048 | This section describes how to control the contents of the mode line |
1049 | and header line. We include it in this chapter because much of the | |
a44af9f2 RS |
1050 | information displayed in the mode line relates to the enabled major and |
1051 | minor modes. | |
1052 | ||
1053 | @code{mode-line-format} is a buffer-local variable that holds a | |
1054 | template used to display the mode line of the current buffer. All | |
8241495d RS |
1055 | windows for the same buffer use the same @code{mode-line-format}, so |
1056 | their mode lines appear the same---except for scrolling percentages, and | |
1057 | line and column numbers, since those depend on point and on how the | |
1058 | window is scrolled. @code{header-line-format} is used likewise for | |
1059 | header lines. | |
1060 | ||
8e0f7b5b RS |
1061 | For efficiency, Emacs does not recompute the mode line and header |
1062 | line of a window in every redisplay. It does so when circumstances | |
1063 | appear to call for it---for instance, if you change the window | |
1064 | configuration, switch buffers, narrow or widen the buffer, scroll, or | |
1065 | change the buffer's modification status. If you modify any of the | |
1066 | variables referenced by @code{mode-line-format} (@pxref{Mode Line | |
1067 | Variables}), or any other variables and data structures that affect | |
1068 | how text is displayed (@pxref{Display}), you may want to force an | |
1069 | update of the mode line so as to display the new information or | |
1070 | display it in the new way. | |
a44af9f2 RS |
1071 | |
1072 | @c Emacs 19 feature | |
1073 | @defun force-mode-line-update | |
8241495d | 1074 | Force redisplay of the current buffer's mode line and header line. |
8e0f7b5b RS |
1075 | The next redisplay will update the mode line and header line based on |
1076 | the latest values of all relevant variables. | |
1077 | ||
1078 | This function also forces recomputation of the menu bar menus | |
1079 | and the frame title. | |
a44af9f2 RS |
1080 | @end defun |
1081 | ||
1082 | The mode line is usually displayed in inverse video; see | |
1083 | @code{mode-line-inverse-video} in @ref{Inverse Video}. | |
1084 | ||
1085 | @menu | |
1086 | * Mode Line Data:: The data structure that controls the mode line. | |
1087 | * Mode Line Variables:: Variables used in that data structure. | |
1088 | * %-Constructs:: Putting information into a mode line. | |
8241495d RS |
1089 | * Properties in Mode:: Using text properties in the mode line. |
1090 | * Header Lines:: Like a mode line, but at the top. | |
a44af9f2 RS |
1091 | @end menu |
1092 | ||
1093 | @node Mode Line Data | |
1094 | @subsection The Data Structure of the Mode Line | |
1095 | @cindex mode line construct | |
1096 | ||
1097 | The mode line contents are controlled by a data structure of lists, | |
a40d4712 PR |
1098 | strings, symbols, and numbers kept in buffer-local variables. The data |
1099 | structure is called a @dfn{mode line construct}, and it is built in | |
1100 | recursive fashion out of simpler mode line constructs. The same data | |
1101 | structure is used for constructing frame titles (@pxref{Frame Titles}) | |
1102 | and header lines (@pxref{Header Lines}). | |
a44af9f2 RS |
1103 | |
1104 | @defvar mode-line-format | |
1105 | The value of this variable is a mode line construct with overall | |
1106 | responsibility for the mode line format. The value of this variable | |
1107 | controls which other variables are used to form the mode line text, and | |
1108 | where they appear. | |
8241495d RS |
1109 | |
1110 | If you set this variable to @code{nil} in a buffer, that buffer does not | |
1111 | have a mode line. (This feature was added in Emacs 21.) | |
a44af9f2 RS |
1112 | @end defvar |
1113 | ||
1114 | A mode line construct may be as simple as a fixed string of text, but | |
1115 | it usually specifies how to use other variables to construct the text. | |
1116 | Many of these variables are themselves defined to have mode line | |
1117 | constructs as their values. | |
1118 | ||
1119 | The default value of @code{mode-line-format} incorporates the values | |
1120 | of variables such as @code{mode-name} and @code{minor-mode-alist}. | |
f9f59935 RS |
1121 | Because of this, very few modes need to alter @code{mode-line-format} |
1122 | itself. For most purposes, it is sufficient to alter some of the | |
1123 | variables that @code{mode-line-format} refers to. | |
a44af9f2 | 1124 | |
de9f0bd9 RS |
1125 | A mode line construct may be a list, a symbol, or a string. If the |
1126 | value is a list, each element may be a list, a symbol, or a string. | |
a44af9f2 | 1127 | |
8241495d RS |
1128 | The mode line can display various faces, if the strings that control |
1129 | it have the @code{face} property. @xref{Properties in Mode}. In | |
1130 | addition, the face @code{mode-line} is used as a default for the whole | |
1131 | mode line (@pxref{Standard Faces}). | |
1132 | ||
a44af9f2 RS |
1133 | @table @code |
1134 | @cindex percent symbol in mode line | |
1135 | @item @var{string} | |
1136 | A string as a mode line construct is displayed verbatim in the mode line | |
bfe721d1 | 1137 | except for @dfn{@code{%}-constructs}. Decimal digits after the @samp{%} |
a44af9f2 RS |
1138 | specify the field width for space filling on the right (i.e., the data |
1139 | is left justified). @xref{%-Constructs}. | |
1140 | ||
1141 | @item @var{symbol} | |
1142 | A symbol as a mode line construct stands for its value. The value of | |
de9f0bd9 | 1143 | @var{symbol} is used as a mode line construct, in place of @var{symbol}. |
8241495d | 1144 | However, the symbols @code{t} and @code{nil} are ignored, as is any |
de9f0bd9 | 1145 | symbol whose value is void. |
a44af9f2 RS |
1146 | |
1147 | There is one exception: if the value of @var{symbol} is a string, it is | |
de9f0bd9 | 1148 | displayed verbatim: the @code{%}-constructs are not recognized. |
a44af9f2 RS |
1149 | |
1150 | @item (@var{string} @var{rest}@dots{}) @r{or} (@var{list} @var{rest}@dots{}) | |
de9f0bd9 RS |
1151 | A list whose first element is a string or list means to process all the |
1152 | elements recursively and concatenate the results. This is the most | |
1153 | common form of mode line construct. | |
a44af9f2 | 1154 | |
8241495d RS |
1155 | @item (:eval @var{form}) |
1156 | A list whose first element is the symbol @code{:eval} says to evaluate | |
1157 | @var{form}, and use the result as a string to display. | |
1158 | (This feature is new as of Emacs 21.) | |
1159 | ||
a44af9f2 | 1160 | @item (@var{symbol} @var{then} @var{else}) |
8241495d RS |
1161 | A list whose first element is a symbol that is not a keyword specifies a |
1162 | conditional. Its meaning depends on the value of @var{symbol}. If the | |
1163 | value is non-@code{nil}, the second element, @var{then}, is processed | |
1164 | recursively as a mode line element. But if the value of @var{symbol} is | |
1165 | @code{nil}, the third element, @var{else}, is processed recursively. | |
1166 | You may omit @var{else}; then the mode line element displays nothing if | |
1167 | the value of @var{symbol} is @code{nil}. | |
a44af9f2 RS |
1168 | |
1169 | @item (@var{width} @var{rest}@dots{}) | |
1170 | A list whose first element is an integer specifies truncation or | |
1171 | padding of the results of @var{rest}. The remaining elements | |
1172 | @var{rest} are processed recursively as mode line constructs and | |
1173 | concatenated together. Then the result is space filled (if | |
1174 | @var{width} is positive) or truncated (to @minus{}@var{width} columns, | |
1175 | if @var{width} is negative) on the right. | |
1176 | ||
1177 | For example, the usual way to show what percentage of a buffer is above | |
de9f0bd9 | 1178 | the top of the window is to use a list like this: @code{(-3 "%p")}. |
a44af9f2 RS |
1179 | @end table |
1180 | ||
1181 | If you do alter @code{mode-line-format} itself, the new value should | |
de9f0bd9 RS |
1182 | use the same variables that appear in the default value (@pxref{Mode |
1183 | Line Variables}), rather than duplicating their contents or displaying | |
1184 | the information in another fashion. This way, customizations made by | |
bfe721d1 KH |
1185 | the user or by Lisp programs (such as @code{display-time} and major |
1186 | modes) via changes to those variables remain effective. | |
a44af9f2 RS |
1187 | |
1188 | @cindex Shell mode @code{mode-line-format} | |
1189 | Here is an example of a @code{mode-line-format} that might be | |
969fe9b5 | 1190 | useful for @code{shell-mode}, since it contains the host name and default |
a44af9f2 RS |
1191 | directory. |
1192 | ||
1193 | @example | |
1194 | @group | |
1195 | (setq mode-line-format | |
969fe9b5 RS |
1196 | (list "-" |
1197 | 'mode-line-mule-info | |
a44af9f2 | 1198 | 'mode-line-modified |
969fe9b5 | 1199 | 'mode-line-frame-identification |
a44af9f2 RS |
1200 | "%b--" |
1201 | @end group | |
f9f59935 RS |
1202 | @group |
1203 | ;; @r{Note that this is evaluated while making the list.} | |
1204 | ;; @r{It makes a mode line construct which is just a string.} | |
1205 | (getenv "HOST") | |
1206 | @end group | |
a44af9f2 RS |
1207 | ":" |
1208 | 'default-directory | |
1209 | " " | |
1210 | 'global-mode-string | |
de9f0bd9 | 1211 | " %[(" |
8241495d | 1212 | '(:eval (mode-line-mode-name)) |
de9f0bd9 | 1213 | 'mode-line-process |
a44af9f2 RS |
1214 | 'minor-mode-alist |
1215 | "%n" | |
969fe9b5 | 1216 | ")%]--" |
a44af9f2 | 1217 | @group |
969fe9b5 | 1218 | '(which-func-mode ("" which-func-format "--")) |
bfe721d1 | 1219 | '(line-number-mode "L%l--") |
969fe9b5 | 1220 | '(column-number-mode "C%c--") |
a44af9f2 RS |
1221 | '(-3 . "%p") |
1222 | "-%-")) | |
1223 | @end group | |
1224 | @end example | |
1225 | ||
1911e6e5 RS |
1226 | @noindent |
1227 | (The variables @code{line-number-mode}, @code{column-number-mode} | |
1228 | and @code{which-func-mode} enable particular minor modes; as usual, | |
1229 | these variable names are also the minor mode command names.) | |
1230 | ||
a44af9f2 RS |
1231 | @node Mode Line Variables |
1232 | @subsection Variables Used in the Mode Line | |
1233 | ||
1234 | This section describes variables incorporated by the | |
1235 | standard value of @code{mode-line-format} into the text of the mode | |
1236 | line. There is nothing inherently special about these variables; any | |
1237 | other variables could have the same effects on the mode line if | |
1238 | @code{mode-line-format} were changed to use them. | |
1239 | ||
969fe9b5 RS |
1240 | @defvar mode-line-mule-info |
1241 | This variable holds the value of the mode-line construct that displays | |
1242 | information about the language environment, buffer coding system, and | |
a9f0a989 | 1243 | current input method. @xref{Non-ASCII Characters}. |
969fe9b5 RS |
1244 | @end defvar |
1245 | ||
a44af9f2 | 1246 | @defvar mode-line-modified |
de9f0bd9 | 1247 | This variable holds the value of the mode-line construct that displays |
a44af9f2 RS |
1248 | whether the current buffer is modified. |
1249 | ||
969fe9b5 RS |
1250 | The default value of @code{mode-line-modified} is @code{("%1*%1+")}. |
1251 | This means that the mode line displays @samp{**} if the buffer is | |
1252 | modified, @samp{--} if the buffer is not modified, @samp{%%} if the | |
1253 | buffer is read only, and @samp{%*} if the buffer is read only and | |
1254 | modified. | |
a44af9f2 RS |
1255 | |
1256 | Changing this variable does not force an update of the mode line. | |
1257 | @end defvar | |
1258 | ||
969fe9b5 RS |
1259 | @defvar mode-line-frame-identification |
1260 | This variable identifies the current frame. The default value is | |
1261 | @code{" "} if you are using a window system which can show multiple | |
1262 | frames, or @code{"-%F "} on an ordinary terminal which shows only one | |
1263 | frame at a time. | |
1264 | @end defvar | |
1265 | ||
a44af9f2 | 1266 | @defvar mode-line-buffer-identification |
de9f0bd9 | 1267 | This variable identifies the buffer being displayed in the window. Its |
ebc6903b RS |
1268 | default value is @code{("%12b")}, which displays the buffer name, padded |
1269 | with spaces to at least 12 columns. | |
a44af9f2 RS |
1270 | @end defvar |
1271 | ||
1272 | @defvar global-mode-string | |
1273 | This variable holds a mode line spec that appears in the mode line by | |
1274 | default, just after the buffer name. The command @code{display-time} | |
1275 | sets @code{global-mode-string} to refer to the variable | |
1276 | @code{display-time-string}, which holds a string containing the time and | |
1277 | load information. | |
1278 | ||
1279 | The @samp{%M} construct substitutes the value of | |
f9f59935 RS |
1280 | @code{global-mode-string}, but that is obsolete, since the variable is |
1281 | included in the mode line from @code{mode-line-format}. | |
a44af9f2 RS |
1282 | @end defvar |
1283 | ||
1284 | @defvar mode-name | |
de9f0bd9 | 1285 | This buffer-local variable holds the ``pretty'' name of the current |
a44af9f2 RS |
1286 | buffer's major mode. Each major mode should set this variable so that the |
1287 | mode name will appear in the mode line. | |
1288 | @end defvar | |
1289 | ||
1290 | @defvar minor-mode-alist | |
de9f0bd9 | 1291 | This variable holds an association list whose elements specify how the |
a44af9f2 RS |
1292 | mode line should indicate that a minor mode is active. Each element of |
1293 | the @code{minor-mode-alist} should be a two-element list: | |
1294 | ||
1295 | @example | |
1296 | (@var{minor-mode-variable} @var{mode-line-string}) | |
1297 | @end example | |
1298 | ||
1299 | More generally, @var{mode-line-string} can be any mode line spec. It | |
1300 | appears in the mode line when the value of @var{minor-mode-variable} is | |
1301 | non-@code{nil}, and not otherwise. These strings should begin with | |
1302 | spaces so that they don't run together. Conventionally, the | |
1303 | @var{minor-mode-variable} for a specific mode is set to a non-@code{nil} | |
1304 | value when that minor mode is activated. | |
1305 | ||
1306 | The default value of @code{minor-mode-alist} is: | |
1307 | ||
1308 | @example | |
1309 | @group | |
1310 | minor-mode-alist | |
bfe721d1 KH |
1311 | @result{} ((vc-mode vc-mode) |
1312 | (abbrev-mode " Abbrev") | |
1313 | (overwrite-mode overwrite-mode) | |
a44af9f2 | 1314 | (auto-fill-function " Fill") |
bfe721d1 KH |
1315 | (defining-kbd-macro " Def") |
1316 | (isearch-mode isearch-mode)) | |
a44af9f2 RS |
1317 | @end group |
1318 | @end example | |
1319 | ||
f9f59935 RS |
1320 | @code{minor-mode-alist} itself is not buffer-local. Each variable |
1321 | mentioned in the alist should be buffer-local if its minor mode can be | |
1322 | enabled separately in each buffer. | |
a44af9f2 RS |
1323 | @end defvar |
1324 | ||
1325 | @defvar mode-line-process | |
1326 | This buffer-local variable contains the mode line information on process | |
1327 | status in modes used for communicating with subprocesses. It is | |
1328 | displayed immediately following the major mode name, with no intervening | |
1329 | space. For example, its value in the @samp{*shell*} buffer is | |
1911e6e5 | 1330 | @code{(":%s")}, which allows the shell to display its status along |
a40d4712 | 1331 | with the major mode as: @samp{(Shell:run)}. Normally this variable |
a44af9f2 RS |
1332 | is @code{nil}. |
1333 | @end defvar | |
1334 | ||
a40d4712 PR |
1335 | Some variables are used by @code{minor-mode-alist} to display |
1336 | a string for various minor modes when enabled. This is a typical | |
1337 | example: | |
1338 | ||
1339 | @defvar vc-mode | |
1340 | The variable @code{vc-mode}, buffer-local in each buffer, records | |
1341 | whether the buffer's visited file is maintained with version control, | |
1342 | and, if so, which kind. Its value is a string that appears in the mode | |
1343 | line, or @code{nil} for no version control. | |
1344 | @end defvar | |
1345 | ||
1346 | The variable @code{default-mode-line-format} is where | |
1347 | @code{mode-line-format} usually gets its value: | |
1348 | ||
a44af9f2 | 1349 | @defvar default-mode-line-format |
de9f0bd9 | 1350 | This variable holds the default @code{mode-line-format} for buffers |
a44af9f2 RS |
1351 | that do not override it. This is the same as @code{(default-value |
1352 | 'mode-line-format)}. | |
1353 | ||
f9f59935 | 1354 | The default value of @code{default-mode-line-format} is this list: |
a44af9f2 RS |
1355 | |
1356 | @example | |
1357 | @group | |
f9f59935 RS |
1358 | ("-" |
1359 | mode-line-mule-info | |
a44af9f2 | 1360 | mode-line-modified |
f9f59935 | 1361 | mode-line-frame-identification |
a44af9f2 | 1362 | mode-line-buffer-identification |
f9f59935 | 1363 | @end group |
a44af9f2 RS |
1364 | " " |
1365 | global-mode-string | |
f9f59935 | 1366 | @group |
a44af9f2 | 1367 | " %[(" |
a40d4712 | 1368 | ;; @r{@code{mode-line-mode-name} is a function} |
513331d3 | 1369 | ;; @r{that copies the mode name and adds text} |
a40d4712 | 1370 | ;; @r{properties to make it mouse-sensitive.} |
8241495d | 1371 | (:eval (mode-line-mode-name)) |
bfe721d1 | 1372 | mode-line-process |
a44af9f2 RS |
1373 | minor-mode-alist |
1374 | "%n" | |
f9f59935 RS |
1375 | ")%]--" |
1376 | @end group | |
1377 | @group | |
1378 | (which-func-mode ("" which-func-format "--")) | |
bfe721d1 | 1379 | (line-number-mode "L%l--") |
f9f59935 | 1380 | (column-number-mode "C%c--") |
a44af9f2 RS |
1381 | (-3 . "%p") |
1382 | "-%-") | |
1383 | @end group | |
1384 | @end example | |
1385 | @end defvar | |
1386 | ||
1387 | @node %-Constructs | |
1388 | @subsection @code{%}-Constructs in the Mode Line | |
1389 | ||
1390 | The following table lists the recognized @code{%}-constructs and what | |
de9f0bd9 RS |
1391 | they mean. In any construct except @samp{%%}, you can add a decimal |
1392 | integer after the @samp{%} to specify how many characters to display. | |
a44af9f2 RS |
1393 | |
1394 | @table @code | |
1395 | @item %b | |
1396 | The current buffer name, obtained with the @code{buffer-name} function. | |
1397 | @xref{Buffer Names}. | |
1398 | ||
a40d4712 PR |
1399 | @item %c |
1400 | The current column number of point. | |
1401 | ||
a44af9f2 RS |
1402 | @item %f |
1403 | The visited file name, obtained with the @code{buffer-file-name} | |
1404 | function. @xref{Buffer File Name}. | |
1405 | ||
22697dac | 1406 | @item %F |
969fe9b5 RS |
1407 | The title (only on a window system) or the name of the selected frame. |
1408 | @xref{Window Frame Parameters}. | |
22697dac | 1409 | |
22697dac | 1410 | @item %l |
8241495d RS |
1411 | The current line number of point, counting within the accessible portion |
1412 | of the buffer. | |
22697dac | 1413 | |
a40d4712 PR |
1414 | @item %n |
1415 | @samp{Narrow} when narrowing is in effect; nothing otherwise (see | |
1416 | @code{narrow-to-region} in @ref{Narrowing}). | |
1417 | ||
1418 | @item %p | |
1419 | The percentage of the buffer text above the @strong{top} of window, or | |
1420 | @samp{Top}, @samp{Bottom} or @samp{All}. Note that the default | |
1421 | mode-line specification truncates this to three characters. | |
1422 | ||
1423 | @item %P | |
1424 | The percentage of the buffer text that is above the @strong{bottom} of | |
1425 | the window (which includes the text visible in the window, as well as | |
1426 | the text above the top), plus @samp{Top} if the top of the buffer is | |
1427 | visible on screen; or @samp{Bottom} or @samp{All}. | |
1428 | ||
1429 | @item %s | |
1430 | The status of the subprocess belonging to the current buffer, obtained with | |
1431 | @code{process-status}. @xref{Process Information}. | |
1432 | ||
1433 | @item %t | |
1434 | Whether the visited file is a text file or a binary file. This is a | |
1435 | meaningful distinction only on certain operating systems (@pxref{MS-DOS | |
1436 | File Types}). | |
1437 | ||
a44af9f2 RS |
1438 | @item %* |
1439 | @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1440 | @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* | |
1441 | @samp{-} otherwise. @xref{Buffer Modification}. | |
1442 | ||
1443 | @item %+ | |
22697dac KH |
1444 | @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* |
1445 | @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1446 | @samp{-} otherwise. This differs from @samp{%*} only for a modified | |
1447 | read-only buffer. @xref{Buffer Modification}. | |
1448 | ||
1449 | @item %& | |
de9f0bd9 | 1450 | @samp{*} if the buffer is modified, and @samp{-} otherwise. |
a44af9f2 | 1451 | |
a44af9f2 RS |
1452 | @item %[ |
1453 | An indication of the depth of recursive editing levels (not counting | |
1454 | minibuffer levels): one @samp{[} for each editing level. | |
1455 | @xref{Recursive Editing}. | |
1456 | ||
1457 | @item %] | |
1458 | One @samp{]} for each recursive editing level (not counting minibuffer | |
1459 | levels). | |
1460 | ||
a40d4712 PR |
1461 | @item %- |
1462 | Dashes sufficient to fill the remainder of the mode line. | |
1463 | ||
a44af9f2 RS |
1464 | @item %% |
1465 | The character @samp{%}---this is how to include a literal @samp{%} in a | |
1466 | string in which @code{%}-constructs are allowed. | |
a44af9f2 RS |
1467 | @end table |
1468 | ||
1469 | The following two @code{%}-constructs are still supported, but they are | |
1470 | obsolete, since you can get the same results with the variables | |
1471 | @code{mode-name} and @code{global-mode-string}. | |
1472 | ||
1473 | @table @code | |
1474 | @item %m | |
1475 | The value of @code{mode-name}. | |
1476 | ||
1477 | @item %M | |
1478 | The value of @code{global-mode-string}. Currently, only | |
1479 | @code{display-time} modifies the value of @code{global-mode-string}. | |
1480 | @end table | |
1481 | ||
8241495d RS |
1482 | @node Properties in Mode |
1483 | @subsection Properties in the Mode Line | |
1484 | ||
1485 | Starting in Emacs 21, certain text properties are meaningful in the | |
1486 | mode line. The @code{face} property affects the appearance of text; the | |
1487 | @code{help-echo} property associate help strings with the text, and | |
ce75fd23 | 1488 | @code{local-map} can make the text mouse-sensitive. |
8241495d RS |
1489 | |
1490 | There are three ways to specify text properties for text in the mode | |
1491 | line: | |
1492 | ||
1493 | @enumerate | |
1494 | @item | |
ce75fd23 GM |
1495 | Put a string with the @code{local-map} property directly into the |
1496 | mode-line data structure. | |
8241495d RS |
1497 | |
1498 | @item | |
ce75fd23 GM |
1499 | Put a @code{local-map} property on a mode-line %-construct |
1500 | such as @samp{%12b}; then the expansion of the %-construct | |
1501 | will have that same text property. | |
8241495d RS |
1502 | |
1503 | @item | |
1504 | Use a list containing @code{:eval @var{form}} in the mode-line data | |
1505 | structure, and make @var{form} evaluate to a string that has a | |
ce75fd23 | 1506 | @code{local-map} property. |
8241495d RS |
1507 | @end enumerate |
1508 | ||
ce75fd23 | 1509 | You use the @code{local-map} property to specify a keymap. Like any |
8241495d | 1510 | keymap, it can bind character keys and function keys; but that has no |
a40d4712 | 1511 | effect, since it is impossible to move point into the mode line. This |
8241495d RS |
1512 | keymap can only take real effect for mouse clicks. |
1513 | ||
1514 | @node Header Lines | |
1515 | @subsection Window Header Lines | |
1516 | @cindex header line (of a window) | |
1517 | @cindex window header line | |
1518 | ||
1519 | Starting in Emacs 21, a window can have a @dfn{header line} at the | |
1520 | top, just as it can have a mode line at the bottom. The header line | |
1521 | feature works just like the mode line feature, except that it's | |
1522 | controlled by different variables. | |
1523 | ||
1524 | @tindex header-line-format | |
1525 | @defvar header-line-format | |
1526 | This variable, local in every buffer, specifies how to display the | |
1527 | header line, for windows displaying the buffer. The format of the value | |
13ede7fc | 1528 | is the same as for @code{mode-line-format} (@pxref{Mode Line Data}). |
8241495d RS |
1529 | @end defvar |
1530 | ||
1531 | @tindex default-header-line-format | |
1532 | @defvar default-header-line-format | |
1533 | This variable holds the default @code{header-line-format} for buffers | |
1534 | that do not override it. This is the same as @code{(default-value | |
1535 | 'header-line-format)}. | |
1536 | ||
1537 | It is normally @code{nil}, so that ordinary buffers have no header line. | |
1538 | @end defvar | |
1539 | ||
f9f59935 RS |
1540 | @node Imenu |
1541 | @section Imenu | |
1542 | ||
1543 | @cindex Imenu | |
969fe9b5 RS |
1544 | @dfn{Imenu} is a feature that lets users select a definition or |
1545 | section in the buffer, from a menu which lists all of them, to go | |
1546 | directly to that location in the buffer. Imenu works by constructing a | |
8241495d | 1547 | buffer index which lists the names and buffer positions of the |
a40d4712 PR |
1548 | definitions, or other named portions of the buffer; then the user can |
1549 | choose one of them and move point to it. This section explains how to | |
1550 | customize how Imenu finds the definitions or buffer portions for a | |
1551 | particular major mode. | |
969fe9b5 RS |
1552 | |
1553 | The usual and simplest way is to set the variable | |
1554 | @code{imenu-generic-expression}: | |
f9f59935 RS |
1555 | |
1556 | @defvar imenu-generic-expression | |
1557 | This variable, if non-@code{nil}, specifies regular expressions for | |
1558 | finding definitions for Imenu. In the simplest case, elements should | |
1559 | look like this: | |
1560 | ||
1561 | @example | |
1562 | (@var{menu-title} @var{regexp} @var{subexp}) | |
1563 | @end example | |
1564 | ||
1565 | Here, if @var{menu-title} is non-@code{nil}, it says that the matches | |
1566 | for this element should go in a submenu of the buffer index; | |
1567 | @var{menu-title} itself specifies the name for the submenu. If | |
1568 | @var{menu-title} is @code{nil}, the matches for this element go directly | |
1569 | in the top level of the buffer index. | |
1570 | ||
1571 | The second item in the list, @var{regexp}, is a regular expression | |
8241495d | 1572 | (@pxref{Regular Expressions}); anything in the buffer that it matches is |
a40d4712 PR |
1573 | considered a definition, something to mention in the buffer index. The |
1574 | third item, @var{subexp}, indicates which subexpression in @var{regexp} | |
8241495d | 1575 | matches the definition's name. |
f9f59935 RS |
1576 | |
1577 | An element can also look like this: | |
1578 | ||
1579 | @example | |
1580 | (@var{menu-title} @var{regexp} @var{index} @var{function} @var{arguments}@dots{}) | |
1581 | @end example | |
1582 | ||
1583 | Each match for this element creates a special index item which, if | |
a40d4712 PR |
1584 | selected by the user, calls @var{function} with arguments consisting of |
1585 | the item name, the buffer position, and @var{arguments}. | |
f9f59935 RS |
1586 | |
1587 | For Emacs Lisp mode, @var{pattern} could look like this: | |
1588 | ||
a9f0a989 | 1589 | @c should probably use imenu-syntax-alist and \\sw rather than [-A-Za-z0-9+] |
f9f59935 RS |
1590 | @example |
1591 | @group | |
1592 | ((nil "^\\s-*(def\\(un\\|subst\\|macro\\|advice\\)\ | |
1593 | \\s-+\\([-A-Za-z0-9+]+\\)" 2) | |
1594 | @end group | |
1595 | @group | |
1596 | ("*Vars*" "^\\s-*(def\\(var\\|const\\)\ | |
1597 | \\s-+\\([-A-Za-z0-9+]+\\)" 2) | |
1598 | @end group | |
1599 | @group | |
1600 | ("*Types*" | |
a9f0a989 RS |
1601 | "^\\s-*\ |
1602 | (def\\(type\\|struct\\|class\\|ine-condition\\)\ | |
f9f59935 RS |
1603 | \\s-+\\([-A-Za-z0-9+]+\\)" 2)) |
1604 | @end group | |
1605 | @end example | |
1606 | ||
969fe9b5 | 1607 | Setting this variable makes it buffer-local in the current buffer. |
f9f59935 RS |
1608 | @end defvar |
1609 | ||
1610 | @defvar imenu-case-fold-search | |
a9f0a989 RS |
1611 | This variable controls whether matching against |
1612 | @var{imenu-generic-expression} is case-sensitive: @code{t}, the default, | |
1613 | means matching should ignore case. | |
1614 | ||
1615 | Setting this variable makes it buffer-local in the current buffer. | |
1616 | @end defvar | |
1617 | ||
1618 | @defvar imenu-syntax-alist | |
1619 | This variable is an alist of syntax table modifiers to use while | |
1911e6e5 RS |
1620 | processing @code{imenu-generic-expression}, to override the syntax table |
1621 | of the current buffer. Each element should have this form: | |
a9f0a989 RS |
1622 | |
1623 | @example | |
1624 | (@var{characters} . @var{syntax-description}) | |
1625 | @end example | |
1626 | ||
1627 | The @sc{car}, @var{characters}, can be either a character or a string. | |
1628 | The element says to give that character or characters the syntax | |
1629 | specified by @var{syntax-description}, which is passed to | |
1630 | @code{modify-syntax-entry} (@pxref{Syntax Table Functions}). | |
1631 | ||
1632 | This feature is typically used to give word syntax to characters which | |
1633 | normally have symbol syntax, and thus to simplify | |
1634 | @code{imenu-generic-expression} and speed up matching. | |
1635 | For example, Fortran mode uses it this way: | |
1636 | ||
1637 | @example | |
1638 | (setq imenu-syntax-alist '(("_$" . "w"))) | |
1639 | @end example | |
1640 | ||
1641 | The @code{imenu-generic-expression} patterns can then use @samp{\\sw+} | |
1911e6e5 | 1642 | instead of @samp{\\(\\sw\\|\\s_\\)+}. Note that this technique may be |
8241495d | 1643 | inconvenient when the mode needs to limit the initial character |
ebc6903b RS |
1644 | of a name to a smaller set of characters than are allowed in the rest |
1645 | of a name. | |
f9f59935 | 1646 | |
969fe9b5 | 1647 | Setting this variable makes it buffer-local in the current buffer. |
f9f59935 RS |
1648 | @end defvar |
1649 | ||
1650 | Another way to customize Imenu for a major mode is to set the | |
1651 | variables @code{imenu-prev-index-position-function} and | |
969fe9b5 | 1652 | @code{imenu-extract-index-name-function}: |
f9f59935 RS |
1653 | |
1654 | @defvar imenu-prev-index-position-function | |
05aea714 | 1655 | If this variable is non-@code{nil}, its value should be a function that |
a40d4712 PR |
1656 | finds the next ``definition'' to put in the buffer index, scanning |
1657 | backward in the buffer from point. It should return @code{nil} if it | |
1658 | doesn't find another ``definition'' before point. Otherwise it shuould | |
1659 | leave point at the place it finds a ``definition,'' and return any | |
1660 | non-@code{nil} value. | |
f9f59935 | 1661 | |
969fe9b5 | 1662 | Setting this variable makes it buffer-local in the current buffer. |
f9f59935 RS |
1663 | @end defvar |
1664 | ||
1665 | @defvar imenu-extract-index-name-function | |
1666 | If this variable is non-@code{nil}, its value should be a function to | |
969fe9b5 RS |
1667 | return the name for a definition, assuming point is in that definition |
1668 | as the @code{imenu-prev-index-position-function} function would leave | |
1669 | it. | |
f9f59935 | 1670 | |
969fe9b5 | 1671 | Setting this variable makes it buffer-local in the current buffer. |
f9f59935 RS |
1672 | @end defvar |
1673 | ||
969fe9b5 | 1674 | The last way to customize Imenu for a major mode is to set the |
a40d4712 | 1675 | variable @code{imenu-create-index-function}: |
969fe9b5 | 1676 | |
f9f59935 RS |
1677 | @defvar imenu-create-index-function |
1678 | This variable specifies the function to use for creating a buffer index. | |
1679 | The function should take no arguments, and return an index for the | |
1680 | current buffer. It is called within @code{save-excursion}, so where it | |
1681 | leaves point makes no difference. | |
1682 | ||
1683 | The default value is a function that uses | |
1684 | @code{imenu-generic-expression} to produce the index alist. If you | |
1685 | specify a different function, then @code{imenu-generic-expression} is | |
1686 | not used. | |
1687 | ||
969fe9b5 | 1688 | Setting this variable makes it buffer-local in the current buffer. |
f9f59935 RS |
1689 | @end defvar |
1690 | ||
1691 | @defvar imenu-index-alist | |
1692 | This variable holds the index alist for the current buffer. | |
969fe9b5 | 1693 | Setting it makes it buffer-local in the current buffer. |
f9f59935 RS |
1694 | |
1695 | Simple elements in the alist look like @code{(@var{index-name} | |
1696 | . @var{index-position})}. Selecting a simple element has the effect of | |
1697 | moving to position @var{index-position} in the buffer. | |
1698 | ||
1699 | Special elements look like @code{(@var{index-name} @var{position} | |
1700 | @var{function} @var{arguments}@dots{})}. Selecting a special element | |
1701 | performs | |
1702 | ||
1703 | @example | |
1704 | (funcall @var{function} @var{index-name} @var{position} @var{arguments}@dots{}) | |
1705 | @end example | |
1706 | ||
1707 | A nested sub-alist element looks like @code{(@var{index-name} | |
1708 | @var{sub-alist})}. | |
1709 | @end defvar | |
1710 | ||
1711 | @node Font Lock Mode | |
1712 | @section Font Lock Mode | |
1713 | @cindex Font Lock Mode | |
1714 | ||
1715 | @dfn{Font Lock mode} is a feature that automatically attaches | |
1716 | @code{face} properties to certain parts of the buffer based on their | |
1717 | syntactic role. How it parses the buffer depends on the major mode; | |
a40d4712 | 1718 | most major modes define syntactic criteria for which faces to use in |
969fe9b5 | 1719 | which contexts. This section explains how to customize Font Lock for a |
a40d4712 | 1720 | particular major mode. |
f9f59935 RS |
1721 | |
1722 | Font Lock mode finds text to highlight in two ways: through syntactic | |
1723 | parsing based on the syntax table, and through searching (usually for | |
1724 | regular expressions). Syntactic fontification happens first; it finds | |
1725 | comments and string constants, and highlights them using | |
1726 | @code{font-lock-comment-face} and @code{font-lock-string-face} | |
a40d4712 | 1727 | (@pxref{Faces for Font Lock}). Search-based fontification follows. |
f9f59935 RS |
1728 | |
1729 | @menu | |
1730 | * Font Lock Basics:: | |
1731 | * Search-based Fontification:: | |
1732 | * Other Font Lock Variables:: | |
1733 | * Levels of Font Lock:: | |
1734 | * Faces for Font Lock:: | |
969fe9b5 | 1735 | * Syntactic Font Lock:: |
f9f59935 RS |
1736 | @end menu |
1737 | ||
1738 | @node Font Lock Basics | |
1739 | @subsection Font Lock Basics | |
1740 | ||
1741 | There are several variables that control how Font Lock mode highlights | |
1742 | text. But major modes should not set any of these variables directly. | |
86494bd5 | 1743 | Instead, they should set @code{font-lock-defaults} as a buffer-local |
969fe9b5 RS |
1744 | variable. The value assigned to this variable is used, if and when Font |
1745 | Lock mode is enabled, to set all the other variables. | |
f9f59935 RS |
1746 | |
1747 | @defvar font-lock-defaults | |
1748 | This variable is set by major modes, as a buffer-local variable, to | |
1749 | specify how to fontify text in that mode. The value should look like | |
1750 | this: | |
1751 | ||
1752 | @example | |
1753 | (@var{keywords} @var{keywords-only} @var{case-fold} | |
1754 | @var{syntax-alist} @var{syntax-begin} @var{other-vars}@dots{}) | |
1755 | @end example | |
1756 | ||
1757 | The first element, @var{keywords}, indirectly specifies the value of | |
1758 | @code{font-lock-keywords}. It can be a symbol, a variable whose value | |
a40d4712 | 1759 | is the list to use for @code{font-lock-keywords}. It can also be a list of |
f9f59935 RS |
1760 | several such symbols, one for each possible level of fontification. The |
1761 | first symbol specifies how to do level 1 fontification, the second | |
1762 | symbol how to do level 2, and so on. | |
1763 | ||
1764 | The second element, @var{keywords-only}, specifies the value of the | |
a9f0a989 | 1765 | variable @code{font-lock-keywords-only}. If this is non-@code{nil}, |
969fe9b5 | 1766 | syntactic fontification (of strings and comments) is not performed. |
f9f59935 RS |
1767 | |
1768 | The third element, @var{case-fold}, specifies the value of | |
1769 | @code{font-lock-case-fold-search}. If it is non-@code{nil}, Font Lock | |
969fe9b5 RS |
1770 | mode ignores case when searching as directed by |
1771 | @code{font-lock-keywords}. | |
f9f59935 RS |
1772 | |
1773 | If the fourth element, @var{syntax-alist}, is non-@code{nil}, it should be | |
1774 | a list of cons cells of the form @code{(@var{char-or-string} | |
1775 | . @var{string})}. These are used to set up a syntax table for | |
1776 | fontification (@pxref{Syntax Table Functions}). The resulting syntax | |
1777 | table is stored in @code{font-lock-syntax-table}. | |
1778 | ||
1779 | The fifth element, @var{syntax-begin}, specifies the value of | |
969fe9b5 | 1780 | @code{font-lock-beginning-of-syntax-function} (see below). |
f9f59935 | 1781 | |
a40d4712 PR |
1782 | All the remaining elements (if any) are collectively called |
1783 | @var{other-vars}. Each of these elements should have the form | |
1784 | @code{(@var{variable} . @var{value})}---which means, make @var{variable} | |
1785 | buffer-local and then set it to @var{value}. You can use these | |
1786 | @var{other-vars} to set other variables that affect fontification, | |
1787 | aside from those you can control with the first five elements. | |
f9f59935 RS |
1788 | @end defvar |
1789 | ||
1790 | @node Search-based Fontification | |
1791 | @subsection Search-based Fontification | |
1792 | ||
1793 | The most important variable for customizing Font Lock mode is | |
1794 | @code{font-lock-keywords}. It specifies the search criteria for | |
1795 | search-based fontification. | |
1796 | ||
1797 | @defvar font-lock-keywords | |
1798 | This variable's value is a list of the keywords to highlight. Be | |
969fe9b5 RS |
1799 | careful when composing regular expressions for this list; a poorly |
1800 | written pattern can dramatically slow things down! | |
f9f59935 RS |
1801 | @end defvar |
1802 | ||
1803 | Each element of @code{font-lock-keywords} specifies how to find | |
969fe9b5 RS |
1804 | certain cases of text, and how to highlight those cases. Font Lock mode |
1805 | processes the elements of @code{font-lock-keywords} one by one, and for | |
1806 | each element, it finds and handles all matches. Ordinarily, once | |
1807 | part of the text has been fontified already, this cannot be overridden | |
1808 | by a subsequent match in the same text; but you can specify different | |
1809 | behavior using the @var{override} element of a @var{highlighter}. | |
1810 | ||
1811 | Each element of @code{font-lock-keywords} should have one of these | |
1812 | forms: | |
f9f59935 RS |
1813 | |
1814 | @table @code | |
1815 | @item @var{regexp} | |
1816 | Highlight all matches for @var{regexp} using | |
1817 | @code{font-lock-keyword-face}. For example, | |
1818 | ||
1819 | @example | |
1820 | ;; @r{Highlight discrete occurrences of @samp{foo}} | |
1821 | ;; @r{using @code{font-lock-keyword-face}.} | |
1822 | "\\<foo\\>" | |
1823 | @end example | |
1824 | ||
969fe9b5 RS |
1825 | The function @code{regexp-opt} (@pxref{Syntax of Regexps}) is useful for |
1826 | calculating optimal regular expressions to match a number of different | |
1827 | keywords. | |
f9f59935 RS |
1828 | |
1829 | @item @var{function} | |
1830 | Find text by calling @var{function}, and highlight the matches | |
1831 | it finds using @code{font-lock-keyword-face}. | |
1832 | ||
1833 | When @var{function} is called, it receives one argument, the limit of | |
07f7b41c RS |
1834 | the search; it should searching at point, and not search beyond the |
1835 | limit. It should return non-@code{nil} if it succeeds, and set the | |
1836 | match data to describe the match that was found. Returning @code{nil} | |
1837 | indicates failure of the search. | |
1838 | ||
1839 | Fontification will call @var{function} repeatedly with the same limit, | |
1840 | and with point where the previous invocation left it, until | |
1841 | @var{function} fails. On failure, @var{function} need not reset point | |
1842 | in any particular way. | |
f9f59935 RS |
1843 | |
1844 | @item (@var{matcher} . @var{match}) | |
86494bd5 | 1845 | In this kind of element, @var{matcher} is either a regular |
f9f59935 RS |
1846 | expression or a function, as described above. The @sc{cdr}, |
1847 | @var{match}, specifies which subexpression of @var{matcher} should be | |
969fe9b5 | 1848 | highlighted (instead of the entire text that @var{matcher} matched). |
f9f59935 RS |
1849 | |
1850 | @example | |
8241495d | 1851 | ;; @r{Highlight the @samp{bar} in each occurrence of @samp{fubar},} |
f9f59935 RS |
1852 | ;; @r{using @code{font-lock-keyword-face}.} |
1853 | ("fu\\(bar\\)" . 1) | |
1854 | @end example | |
1855 | ||
969fe9b5 | 1856 | If you use @code{regexp-opt} to produce the regular expression |
f9f59935 RS |
1857 | @var{matcher}, then you can use @code{regexp-opt-depth} (@pxref{Syntax |
1858 | of Regexps}) to calculate the value for @var{match}. | |
1859 | ||
1860 | @item (@var{matcher} . @var{facename}) | |
1861 | In this kind of element, @var{facename} is an expression whose value | |
1862 | specifies the face name to use for highlighting. | |
1863 | ||
1864 | @example | |
1865 | ;; @r{Highlight occurrences of @samp{fubar},} | |
1866 | ;; @r{using the face which is the value of @code{fubar-face}.} | |
1867 | ("fubar" . fubar-face) | |
1868 | @end example | |
1869 | ||
1870 | @item (@var{matcher} . @var{highlighter}) | |
1871 | In this kind of element, @var{highlighter} is a list | |
1872 | which specifies how to highlight matches found by @var{matcher}. | |
1873 | It has the form | |
1874 | ||
1875 | @example | |
1876 | (@var{subexp} @var{facename} @var{override} @var{laxmatch}) | |
1877 | @end example | |
1878 | ||
1879 | The @sc{car}, @var{subexp}, is an integer specifying which subexpression | |
969fe9b5 RS |
1880 | of the match to fontify (0 means the entire matching text). The second |
1881 | subelement, @var{facename}, specifies the face, as described above. | |
f9f59935 RS |
1882 | |
1883 | The last two values in @var{highlighter}, @var{override} and | |
1884 | @var{laxmatch}, are flags. If @var{override} is @code{t}, this element | |
1885 | can override existing fontification made by previous elements of | |
1886 | @code{font-lock-keywords}. If it is @code{keep}, then each character is | |
1887 | fontified if it has not been fontified already by some other element. | |
1888 | If it is @code{prepend}, the face @var{facename} is added to the | |
1889 | beginning of the @code{face} property. If it is @code{append}, the face | |
1890 | @var{facename} is added to the end of the @code{face} property. | |
1891 | ||
1892 | If @var{laxmatch} is non-@code{nil}, it means there should be no error | |
1893 | if there is no subexpression numbered @var{subexp} in @var{matcher}. | |
99b62845 GM |
1894 | Obviously, fontification of the subexpression numbered @var{subexp} will |
1895 | not occur. However, fontification of other subexpressions (and other | |
1896 | regexps) will continue. If @var{laxmatch} is @code{nil}, and the | |
1897 | specified subexpression is missing, then an error is signalled which | |
1898 | terminates search-based fontification. | |
f9f59935 RS |
1899 | |
1900 | Here are some examples of elements of this kind, and what they do: | |
1901 | ||
1902 | @smallexample | |
1903 | ;; @r{Highlight occurrences of either @samp{foo} or @samp{bar},} | |
1904 | ;; @r{using @code{foo-bar-face}, even if they have already been highlighted.} | |
1905 | ;; @r{@code{foo-bar-face} should be a variable whose value is a face.} | |
1906 | ("foo\\|bar" 0 foo-bar-face t) | |
1907 | ||
8241495d | 1908 | ;; @r{Highlight the first subexpression within each occurrence} |
f9f59935 RS |
1909 | ;; @r{that the function @code{fubar-match} finds,} |
1910 | ;; @r{using the face which is the value of @code{fubar-face}.} | |
1911 | (fubar-match 1 fubar-face) | |
1912 | @end smallexample | |
1913 | ||
1914 | @item (@var{matcher} @var{highlighters}@dots{}) | |
1915 | This sort of element specifies several @var{highlighter} lists for a | |
1916 | single @var{matcher}. In order for this to be useful, each | |
1917 | @var{highlighter} should have a different value of @var{subexp}; that is, | |
1918 | each one should apply to a different subexpression of @var{matcher}. | |
1919 | ||
1920 | @ignore | |
1921 | @item (@var{matcher} . @var{anchored}) | |
1922 | In this kind of element, @var{anchored} acts much like a | |
1923 | @var{highlighter}, but it is more complex and can specify multiple | |
1924 | successive searches. | |
1925 | ||
1926 | For highlighting single items, typically only @var{highlighter} is | |
1927 | required. However, if an item or (typically) items are to be | |
1928 | highlighted following the instance of another item (the anchor) then | |
1929 | @var{anchored} may be required. | |
1930 | ||
1931 | It has this format: | |
1932 | ||
1933 | @example | |
1934 | (@var{submatcher} @var{pre-match-form} @var{post-match-form} @var{highlighters}@dots{}) | |
1935 | @end example | |
1936 | ||
1937 | @c I can't parse this text -- rms | |
1938 | where @var{submatcher} is much like @var{matcher}, with one | |
1939 | exception---see below. @var{pre-match-form} and @var{post-match-form} | |
1940 | are evaluated before the first, and after the last, instance | |
1941 | @var{anchored}'s @var{submatcher} is used. Therefore they can be used | |
a9f0a989 | 1942 | to initialize before, and cleanup after, @var{submatcher} is used. |
f9f59935 RS |
1943 | Typically, @var{pre-match-form} is used to move to some position |
1944 | relative to the original @var{submatcher}, before starting with | |
1945 | @var{anchored}'s @var{submatcher}. @var{post-match-form} might be used | |
1946 | to move, before resuming with @var{anchored}'s parent's @var{matcher}. | |
1947 | ||
1948 | For example, an element of the form highlights (if not already highlighted): | |
1949 | ||
1950 | @example | |
1951 | ("\\<anchor\\>" (0 anchor-face) ("\\<item\\>" nil nil (0 item-face))) | |
1952 | @end example | |
1953 | ||
1954 | Discrete occurrences of @samp{anchor} in the value of | |
1955 | @code{anchor-face}, and subsequent discrete occurrences of @samp{item} | |
1956 | (on the same line) in the value of @code{item-face}. (Here | |
1957 | @var{pre-match-form} and @var{post-match-form} are @code{nil}. | |
1958 | Therefore @samp{item} is initially searched for starting from the end of | |
1959 | the match of @samp{anchor}, and searching for subsequent instance of | |
1960 | @samp{anchor} resumes from where searching for @samp{item} concluded.) | |
1961 | ||
1962 | The above-mentioned exception is as follows. The limit of the | |
1963 | @var{submatcher} search defaults to the end of the line after | |
1964 | @var{pre-match-form} is evaluated. However, if @var{pre-match-form} | |
1965 | returns a position greater than the position after @var{pre-match-form} | |
1966 | is evaluated, that position is used as the limit of the search. It is | |
1967 | generally a bad idea to return a position greater than the end of the | |
1968 | line; in other words, the @var{submatcher} search should not span lines. | |
1969 | ||
1970 | @item (@var{matcher} @var{highlighters-or-anchoreds} ...) | |
1971 | @end ignore | |
1972 | ||
1973 | @item (eval . @var{form}) | |
969fe9b5 | 1974 | Here @var{form} is an expression to be evaluated the first time |
f9f59935 | 1975 | this value of @code{font-lock-keywords} is used in a buffer. |
969fe9b5 | 1976 | Its value should have one of the forms described in this table. |
f9f59935 RS |
1977 | @end table |
1978 | ||
1979 | @strong{Warning:} Do not design an element of @code{font-lock-keywords} | |
1980 | to match text which spans lines; this does not work reliably. While | |
1981 | @code{font-lock-fontify-buffer} handles multi-line patterns correctly, | |
1982 | updating when you edit the buffer does not, since it considers text one | |
1983 | line at a time. | |
1984 | ||
f9f59935 RS |
1985 | @node Other Font Lock Variables |
1986 | @subsection Other Font Lock Variables | |
1987 | ||
1988 | This section describes additional variables that a major mode | |
1989 | can set by means of @code{font-lock-defaults}. | |
1990 | ||
1991 | @defvar font-lock-keywords-only | |
1992 | Non-@code{nil} means Font Lock should not fontify comments or strings | |
969fe9b5 RS |
1993 | syntactically; it should only fontify based on |
1994 | @code{font-lock-keywords}. | |
f9f59935 RS |
1995 | @end defvar |
1996 | ||
1997 | @ignore | |
a9f0a989 | 1998 | Other variables include those for buffer-specialized fontification functions, |
f9f59935 RS |
1999 | `font-lock-fontify-buffer-function', `font-lock-unfontify-buffer-function', |
2000 | `font-lock-fontify-region-function', `font-lock-unfontify-region-function', | |
2001 | `font-lock-inhibit-thing-lock' and `font-lock-maximum-size'. | |
2002 | @end ignore | |
2003 | ||
2004 | @defvar font-lock-keywords-case-fold-search | |
969fe9b5 RS |
2005 | Non-@code{nil} means that regular expression matching for the sake of |
2006 | @code{font-lock-keywords} should be case-insensitive. | |
f9f59935 RS |
2007 | @end defvar |
2008 | ||
969fe9b5 RS |
2009 | @defvar font-lock-syntax-table |
2010 | This variable specifies the syntax table to use for fontification of | |
2011 | comments and strings. | |
2012 | @end defvar | |
f9f59935 | 2013 | |
969fe9b5 RS |
2014 | @defvar font-lock-beginning-of-syntax-function |
2015 | If this variable is non-@code{nil}, it should be a function to move | |
2016 | point back to a position that is syntactically at ``top level'' and | |
2017 | outside of strings or comments. Font Lock uses this when necessary | |
2018 | to get the right results for syntactic fontification. | |
f9f59935 RS |
2019 | |
2020 | This function is called with no arguments. It should leave point at the | |
2021 | beginning of any enclosing syntactic block. Typical values are | |
2022 | @code{beginning-of-line} (i.e., the start of the line is known to be | |
2023 | outside a syntactic block), or @code{beginning-of-defun} for programming | |
2024 | modes or @code{backward-paragraph} for textual modes (i.e., the | |
2025 | mode-dependent function is known to move outside a syntactic block). | |
2026 | ||
2027 | If the value is @code{nil}, the beginning of the buffer is used as a | |
969fe9b5 RS |
2028 | position outside of a syntactic block. This cannot be wrong, but it can |
2029 | be slow. | |
f9f59935 RS |
2030 | @end defvar |
2031 | ||
2032 | @defvar font-lock-mark-block-function | |
969fe9b5 RS |
2033 | If this variable is non-@code{nil}, it should be a function that is |
2034 | called with no arguments, to choose an enclosing range of text for | |
2035 | refontification for the command @kbd{M-g M-g} | |
2036 | (@code{font-lock-fontify-block}). | |
2037 | ||
2038 | The function should report its choice by placing the region around it. | |
2039 | A good choice is a range of text large enough to give proper results, | |
2040 | but not too large so that refontification becomes slow. Typical values | |
2041 | are @code{mark-defun} for programming modes or @code{mark-paragraph} for | |
2042 | textual modes. | |
f9f59935 RS |
2043 | @end defvar |
2044 | ||
2045 | @node Levels of Font Lock | |
2046 | @subsection Levels of Font Lock | |
2047 | ||
2048 | Many major modes offer three different levels of fontification. You | |
2049 | can define multiple levels by using a list of symbols for @var{keywords} | |
2050 | in @code{font-lock-defaults}. Each symbol specifies one level of | |
2051 | fontification; it is up to the user to choose one of these levels. The | |
2052 | chosen level's symbol value is used to initialize | |
2053 | @code{font-lock-keywords}. | |
2054 | ||
969fe9b5 RS |
2055 | Here are the conventions for how to define the levels of |
2056 | fontification: | |
2057 | ||
f9f59935 RS |
2058 | @itemize @bullet |
2059 | @item | |
2060 | Level 1: highlight function declarations, file directives (such as include or | |
2061 | import directives), strings and comments. The idea is speed, so only | |
2062 | the most important and top-level components are fontified. | |
2063 | ||
2064 | @item | |
969fe9b5 RS |
2065 | Level 2: in addition to level 1, highlight all language keywords, |
2066 | including type names that act like keywords, as well as named constant | |
2067 | values. The idea is that all keywords (either syntactic or semantic) | |
2068 | should be fontified appropriately. | |
f9f59935 RS |
2069 | |
2070 | @item | |
969fe9b5 RS |
2071 | Level 3: in addition to level 2, highlight the symbols being defined in |
2072 | function and variable declarations, and all builtin function names, | |
2073 | wherever they appear. | |
f9f59935 RS |
2074 | @end itemize |
2075 | ||
2076 | @node Faces for Font Lock | |
2077 | @subsection Faces for Font Lock | |
2078 | ||
2079 | You can make Font Lock mode use any face, but several faces are | |
2080 | defined specifically for Font Lock mode. Each of these symbols is both | |
2081 | a face name, and a variable whose default value is the symbol itself. | |
2082 | Thus, the default value of @code{font-lock-comment-face} is | |
2083 | @code{font-lock-comment-face}. This means you can write | |
2084 | @code{font-lock-comment-face} in a context such as | |
2085 | @code{font-lock-keywords} where a face-name-valued expression is used. | |
2086 | ||
2087 | @table @code | |
2088 | @item font-lock-comment-face | |
2089 | @vindex font-lock-comment-face | |
f9f59935 RS |
2090 | Used (typically) for comments. |
2091 | ||
2092 | @item font-lock-string-face | |
2093 | @vindex font-lock-string-face | |
f9f59935 RS |
2094 | Used (typically) for string constants. |
2095 | ||
2096 | @item font-lock-keyword-face | |
2097 | @vindex font-lock-keyword-face | |
f9f59935 RS |
2098 | Used (typically) for keywords---names that have special syntactic |
2099 | significance, like @code{for} and @code{if} in C. | |
2100 | ||
2101 | @item font-lock-builtin-face | |
2102 | @vindex font-lock-builtin-face | |
f9f59935 RS |
2103 | Used (typically) for built-in function names. |
2104 | ||
2105 | @item font-lock-function-name-face | |
2106 | @vindex font-lock-function-name-face | |
f9f59935 RS |
2107 | Used (typically) for the name of a function being defined or declared, |
2108 | in a function definition or declaration. | |
2109 | ||
2110 | @item font-lock-variable-name-face | |
2111 | @vindex font-lock-variable-name-face | |
f9f59935 RS |
2112 | Used (typically) for the name of a variable being defined or declared, |
2113 | in a variable definition or declaration. | |
2114 | ||
2115 | @item font-lock-type-face | |
2116 | @vindex font-lock-type-face | |
f9f59935 RS |
2117 | Used (typically) for names of user-defined data types, |
2118 | where they are defined and where they are used. | |
2119 | ||
2120 | @item font-lock-constant-face | |
2121 | @vindex font-lock-constant-face | |
f9f59935 RS |
2122 | Used (typically) for constant names. |
2123 | ||
2124 | @item font-lock-warning-face | |
2125 | @vindex font-lock-warning-face | |
f9f59935 RS |
2126 | Used (typically) for constructs that are peculiar, or that greatly |
2127 | change the meaning of other text. For example, this is used for | |
2128 | @samp{;;;###autoload} cookies in Emacs Lisp, and for @code{#error} | |
2129 | directives in C. | |
2130 | @end table | |
2131 | ||
969fe9b5 RS |
2132 | @node Syntactic Font Lock |
2133 | @subsection Syntactic Font Lock | |
2134 | ||
2135 | Font Lock mode can be used to update @code{syntax-table} properties | |
2136 | automatically. This is useful in languages for which a single syntax | |
2137 | table by itself is not sufficient. | |
2138 | ||
2139 | @defvar font-lock-syntactic-keywords | |
2140 | This variable enables and controls syntactic Font Lock. Its value | |
2141 | should be a list of elements of this form: | |
2142 | ||
2143 | @example | |
2144 | (@var{matcher} @var{subexp} @var{syntax} @var{override} @var{laxmatch}) | |
2145 | @end example | |
2146 | ||
2147 | The parts of this element have the same meanings as in the corresponding | |
2148 | sort of element of @code{font-lock-keywords}, | |
2149 | ||
2150 | @example | |
2151 | (@var{matcher} @var{subexp} @var{facename} @var{override} @var{laxmatch}) | |
2152 | @end example | |
2153 | ||
2154 | However, instead of specifying the value @var{facename} to use for the | |
2155 | @code{face} property, it specifies the value @var{syntax} to use for the | |
2156 | @code{syntax-table} property. Here, @var{syntax} can be a variable | |
2157 | whose value is a syntax table, a syntax entry of the form | |
2158 | @code{(@var{syntax-code} . @var{matching-char})}, or an expression whose | |
2159 | value is one of those two types. | |
2160 | @end defvar | |
2161 | ||
a44af9f2 RS |
2162 | @node Hooks |
2163 | @section Hooks | |
2164 | @cindex hooks | |
2165 | ||
2166 | A @dfn{hook} is a variable where you can store a function or functions | |
2167 | to be called on a particular occasion by an existing program. Emacs | |
2168 | provides hooks for the sake of customization. Most often, hooks are set | |
a40d4712 | 2169 | up in the init file (@pxref{Init File}), but Lisp programs can set them also. |
a44af9f2 RS |
2170 | @xref{Standard Hooks}, for a list of standard hook variables. |
2171 | ||
f9f59935 | 2172 | @cindex normal hook |
a44af9f2 | 2173 | Most of the hooks in Emacs are @dfn{normal hooks}. These variables |
dd73b091 RS |
2174 | contain lists of functions to be called with no arguments. When the |
2175 | hook name ends in @samp{-hook}, that tells you it is normal. We try to | |
2176 | make all hooks normal, as much as possible, so that you can use them in | |
2177 | a uniform way. | |
2178 | ||
2179 | Every major mode function is supposed to run a normal hook called the | |
2180 | @dfn{mode hook} as the last step of initialization. This makes it easy | |
2181 | for a user to customize the behavior of the mode, by overriding the | |
969fe9b5 RS |
2182 | buffer-local variable assignments already made by the mode. But hooks |
2183 | are used in other contexts too. For example, the hook | |
2184 | @code{suspend-hook} runs just before Emacs suspends itself | |
2185 | (@pxref{Suspending Emacs}). | |
a44af9f2 RS |
2186 | |
2187 | The recommended way to add a hook function to a normal hook is by | |
2188 | calling @code{add-hook} (see below). The hook functions may be any of | |
2189 | the valid kinds of functions that @code{funcall} accepts (@pxref{What Is | |
2190 | a Function}). Most normal hook variables are initially void; | |
2191 | @code{add-hook} knows how to deal with this. | |
2192 | ||
f9f59935 | 2193 | @cindex abnormal hook |
dd73b091 | 2194 | If the hook variable's name does not end with @samp{-hook}, that |
a40d4712 | 2195 | indicates it is probably an @dfn{abnormal hook}. Then you should look at its |
dd73b091 RS |
2196 | documentation to see how to use the hook properly. |
2197 | ||
2198 | If the variable's name ends in @samp{-functions} or @samp{-hooks}, | |
2199 | then the value is a list of functions, but it is abnormal in that either | |
2200 | these functions are called with arguments or their values are used in | |
2201 | some way. You can use @code{add-hook} to add a function to the list, | |
2202 | but you must take care in writing the function. (A few of these | |
2203 | variables are actually normal hooks which were named before we | |
2204 | established the convention of using @samp{-hook} for them.) | |
2205 | ||
2206 | If the variable's name ends in @samp{-function}, then its value | |
2207 | is just a single function, not a list of functions. | |
a44af9f2 | 2208 | |
969fe9b5 RS |
2209 | Here's an example that uses a mode hook to turn on Auto Fill mode when |
2210 | in Lisp Interaction mode: | |
a44af9f2 RS |
2211 | |
2212 | @example | |
2213 | (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) | |
a44af9f2 RS |
2214 | @end example |
2215 | ||
2216 | At the appropriate time, Emacs uses the @code{run-hooks} function to | |
bfe721d1 KH |
2217 | run particular hooks. This function calls the hook functions that have |
2218 | been added with @code{add-hook}. | |
a44af9f2 | 2219 | |
a40d4712 | 2220 | @defun run-hooks &rest hookvars |
a44af9f2 | 2221 | This function takes one or more hook variable names as arguments, and |
a40d4712 PR |
2222 | runs each hook in turn. Each argument should be a symbol that is a hook |
2223 | variable. These arguments are processed in the order specified. | |
a44af9f2 RS |
2224 | |
2225 | If a hook variable has a non-@code{nil} value, that value may be a | |
2226 | function or a list of functions. If the value is a function (either a | |
f9f59935 RS |
2227 | lambda expression or a symbol with a function definition), it is called. |
2228 | If it is a list, the elements are called, in order. The hook functions | |
2229 | are called with no arguments. Nowadays, storing a single function in | |
2230 | the hook variable is semi-obsolete; you should always use a list of | |
2231 | functions. | |
a44af9f2 | 2232 | |
bfe721d1 | 2233 | For example, here's how @code{emacs-lisp-mode} runs its mode hook: |
a44af9f2 RS |
2234 | |
2235 | @example | |
2236 | (run-hooks 'emacs-lisp-mode-hook) | |
2237 | @end example | |
2238 | @end defun | |
2239 | ||
a9f0a989 RS |
2240 | @defun run-hook-with-args hook &rest args |
2241 | This function is the way to run an abnormal hook which passes arguments | |
2242 | to the hook functions. It calls each of the hook functions, passing | |
2243 | each of them the arguments @var{args}. | |
2244 | @end defun | |
2245 | ||
2246 | @defun run-hook-with-args-until-failure hook &rest args | |
2247 | This function is the way to run an abnormal hook which passes arguments | |
2248 | to the hook functions, and stops as soon as any hook function fails. It | |
2249 | calls each of the hook functions, passing each of them the arguments | |
1911e6e5 | 2250 | @var{args}, until some hook function returns @code{nil}. Then it stops, |
a40d4712 PR |
2251 | and returns @code{nil} if some hook function returned @code{nil}. |
2252 | Otherwise it returns a non-@code{nil} value. | |
a9f0a989 RS |
2253 | @end defun |
2254 | ||
2255 | @defun run-hook-with-args-until-success hook &rest args | |
2256 | This function is the way to run an abnormal hook which passes arguments | |
2257 | to the hook functions, and stops as soon as any hook function succeeds. | |
2258 | It calls each of the hook functions, passing each of them the arguments | |
2259 | @var{args}, until some hook function returns non-@code{nil}. Then it | |
1911e6e5 RS |
2260 | stops, and returns whatever was returned by the last hook function |
2261 | that was called. | |
a9f0a989 RS |
2262 | @end defun |
2263 | ||
22697dac | 2264 | @defun add-hook hook function &optional append local |
a44af9f2 | 2265 | This function is the handy way to add function @var{function} to hook |
de9f0bd9 RS |
2266 | variable @var{hook}. The argument @var{function} may be any valid Lisp |
2267 | function with the proper number of arguments. For example, | |
a44af9f2 RS |
2268 | |
2269 | @example | |
2270 | (add-hook 'text-mode-hook 'my-text-hook-function) | |
2271 | @end example | |
2272 | ||
2273 | @noindent | |
2274 | adds @code{my-text-hook-function} to the hook called @code{text-mode-hook}. | |
2275 | ||
de9f0bd9 RS |
2276 | You can use @code{add-hook} for abnormal hooks as well as for normal |
2277 | hooks. | |
2278 | ||
a44af9f2 RS |
2279 | It is best to design your hook functions so that the order in which they |
2280 | are executed does not matter. Any dependence on the order is ``asking | |
2281 | for trouble.'' However, the order is predictable: normally, | |
2282 | @var{function} goes at the front of the hook list, so it will be | |
969fe9b5 RS |
2283 | executed first (barring another @code{add-hook} call). If the optional |
2284 | argument @var{append} is non-@code{nil}, the new hook function goes at | |
2285 | the end of the hook list and will be executed last. | |
22697dac KH |
2286 | |
2287 | If @var{local} is non-@code{nil}, that says to make the new hook | |
ad5101a6 DL |
2288 | function buffer-local in the current buffer and automatically calls |
2289 | @code{make-local-hook} to make the hook itself buffer-local. | |
a44af9f2 RS |
2290 | @end defun |
2291 | ||
22697dac | 2292 | @defun remove-hook hook function &optional local |
a44af9f2 | 2293 | This function removes @var{function} from the hook variable @var{hook}. |
c44d2ced | 2294 | |
22697dac | 2295 | If @var{local} is non-@code{nil}, that says to remove @var{function} |
969fe9b5 RS |
2296 | from the buffer-local hook list instead of from the global hook list. |
2297 | If the hook variable itself is not buffer-local, then the value of | |
2298 | @var{local} makes no difference. | |
22697dac | 2299 | @end defun |
c44d2ced | 2300 | |
22697dac | 2301 | @defun make-local-hook hook |
969fe9b5 RS |
2302 | This function makes the hook variable @code{hook} buffer-local in the |
2303 | current buffer. When a hook variable is buffer-local, it can have | |
2304 | buffer-local and global hook functions, and @code{run-hooks} runs all of | |
2305 | them. | |
c44d2ced | 2306 | |
a40d4712 PR |
2307 | This function works by adding @code{t} as an element of the buffer-local |
2308 | value. That serves as a flag to use the hook functions listed in the default | |
2309 | value of the hook variable, as well as those listed in the buffer-local value. | |
969fe9b5 RS |
2310 | Since @code{run-hooks} understands this flag, @code{make-local-hook} |
2311 | works with all normal hooks. It works for only some non-normal | |
2312 | hooks---those whose callers have been updated to understand this meaning | |
2313 | of @code{t}. | |
fc0cb073 | 2314 | |
22697dac KH |
2315 | Do not use @code{make-local-variable} directly for hook variables; it is |
2316 | not sufficient. | |
2317 | @end defun |