Mercurial > emacs
annotate lispref/modes.texi @ 17085:4dafa5431293
Change coding system name koi8 to koi8-r.
Remove prefix "coding-system-" from coding system symbol names.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 26 Feb 1997 12:27:06 +0000 |
parents | 6f58503776e5 |
children | 8ed8412c1ce7 |
rev | line source |
---|---|
6451 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/modes | |
6 @node Modes, Documentation, Keymaps, Top | |
7 @chapter Major and Minor Modes | |
8 @cindex mode | |
9 | |
10 A @dfn{mode} is a set of definitions that customize Emacs and can be | |
11 turned on and off while you edit. There are two varieties of modes: | |
12 @dfn{major modes}, which are mutually exclusive and used for editing | |
13 particular kinds of text, and @dfn{minor modes}, which provide features | |
14 that users can enable individually. | |
15 | |
16 This chapter describes how to write both major and minor modes, how to | |
17 indicate them in the mode line, and how they run hooks supplied by the | |
18 user. For related topics such as keymaps and syntax tables, see | |
19 @ref{Keymaps}, and @ref{Syntax Tables}. | |
20 | |
21 @menu | |
22 * Major Modes:: Defining major modes. | |
23 * Minor Modes:: Defining minor modes. | |
24 * Mode Line Format:: Customizing the text that appears in the mode line. | |
25 * Hooks:: How to use hooks; how to write code that provides hooks. | |
26 @end menu | |
27 | |
28 @node Major Modes | |
29 @section Major Modes | |
30 @cindex major mode | |
31 @cindex Fundamental mode | |
32 | |
33 Major modes specialize Emacs for editing particular kinds of text. | |
34 Each buffer has only one major mode at a time. | |
35 | |
36 The least specialized major mode is called @dfn{Fundamental mode}. | |
37 This mode has no mode-specific definitions or variable settings, so each | |
38 Emacs command behaves in its default manner, and each option is in its | |
39 default state. All other major modes redefine various keys and options. | |
40 For example, Lisp Interaction mode provides special key bindings for | |
41 @key{LFD} (@code{eval-print-last-sexp}), @key{TAB} | |
42 (@code{lisp-indent-line}), and other keys. | |
43 | |
44 When you need to write several editing commands to help you perform a | |
45 specialized editing task, creating a new major mode is usually a good | |
46 idea. In practice, writing a major mode is easy (in contrast to | |
47 writing a minor mode, which is often difficult). | |
48 | |
49 If the new mode is similar to an old one, it is often unwise to modify | |
50 the old one to serve two purposes, since it may become harder to use and | |
51 maintain. Instead, copy and rename an existing major mode definition | |
52 and alter the copy---or define a @dfn{derived mode} (@pxref{Derived | |
53 Modes}). For example, Rmail Edit mode, which is in | |
54 @file{emacs/lisp/rmailedit.el}, is a major mode that is very similar to | |
55 Text mode except that it provides three additional commands. Its | |
56 definition is distinct from that of Text mode, but was derived from it. | |
57 | |
58 Rmail Edit mode is an example of a case where one piece of text is put | |
59 temporarily into a different major mode so it can be edited in a | |
60 different way (with ordinary Emacs commands rather than Rmail). In such | |
61 cases, the temporary major mode usually has a command to switch back to | |
62 the buffer's usual mode (Rmail mode, in this case). You might be | |
63 tempted to present the temporary redefinitions inside a recursive edit | |
64 and restore the usual ones when the user exits; but this is a bad idea | |
65 because it constrains the user's options when it is done in more than | |
66 one buffer: recursive edits must be exited most-recently-entered first. | |
67 Using alternative major modes avoids this limitation. @xref{Recursive | |
68 Editing}. | |
69 | |
70 The standard GNU Emacs Lisp library directory contains the code for | |
71 several major modes, in files including @file{text-mode.el}, | |
72 @file{texinfo.el}, @file{lisp-mode.el}, @file{c-mode.el}, and | |
73 @file{rmail.el}. You can look at these libraries to see how modes are | |
74 written. Text mode is perhaps the simplest major mode aside from | |
75 Fundamental mode. Rmail mode is a complicated and specialized mode. | |
76 | |
77 @menu | |
78 * Major Mode Conventions:: Coding conventions for keymaps, etc. | |
79 * Example Major Modes:: Text mode and Lisp modes. | |
80 * Auto Major Mode:: How Emacs chooses the major mode automatically. | |
81 * Mode Help:: Finding out how to use a mode. | |
82 * Derived Modes:: Defining a new major mode based on another major | |
83 mode. | |
84 @end menu | |
85 | |
86 @node Major Mode Conventions | |
87 @subsection Major Mode Conventions | |
88 | |
89 The code for existing major modes follows various coding conventions, | |
90 including conventions for local keymap and syntax table initialization, | |
91 global names, and hooks. Please follow these conventions when you | |
92 define a new major mode: | |
93 | |
94 @itemize @bullet | |
95 @item | |
96 Define a command whose name ends in @samp{-mode}, with no arguments, | |
97 that switches to the new mode in the current buffer. This command | |
98 should set up the keymap, syntax table, and local variables in an | |
99 existing buffer without changing the buffer's text. | |
100 | |
101 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
102 Write a documentation string for this command that describes the |
6451 | 103 special commands available in this mode. @kbd{C-h m} |
104 (@code{describe-mode}) in your mode will display this string. | |
105 | |
106 The documentation string may include the special documentation | |
107 substrings, @samp{\[@var{command}]}, @samp{\@{@var{keymap}@}}, and | |
108 @samp{\<@var{keymap}>}, that enable the documentation to adapt | |
109 automatically to the user's own key bindings. @xref{Keys in | |
110 Documentation}. | |
111 | |
112 @item | |
113 The major mode command should start by calling | |
114 @code{kill-all-local-variables}. This is what gets rid of the local | |
115 variables of the major mode previously in effect. | |
116 | |
117 @item | |
118 The major mode command should set the variable @code{major-mode} to the | |
119 major mode command symbol. This is how @code{describe-mode} discovers | |
120 which documentation to print. | |
121 | |
122 @item | |
123 The major mode command should set the variable @code{mode-name} to the | |
124 ``pretty'' name of the mode, as a string. This appears in the mode | |
125 line. | |
126 | |
127 @item | |
128 @cindex functions in modes | |
129 Since all global names are in the same name space, all the global | |
130 variables, constants, and functions that are part of the mode should | |
131 have names that start with the major mode name (or with an abbreviation | |
132 of it if the name is long). @xref{Style Tips}. | |
133 | |
134 @item | |
135 @cindex keymaps in modes | |
136 The major mode should usually have its own keymap, which is used as the | |
137 local keymap in all buffers in that mode. The major mode function | |
138 should call @code{use-local-map} to install this local map. | |
139 @xref{Active Keymaps}, for more information. | |
140 | |
141 This keymap should be kept in a global variable named | |
142 @code{@var{modename}-mode-map}. Normally the library that defines the | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
143 mode sets this variable. |
6451 | 144 |
12803
6dcd5ad16790
Make Major Mode Conventions xref to Tips for Defining.
Richard M. Stallman <rms@gnu.org>
parents:
12234
diff
changeset
|
145 @xref{Tips for Defining}, for advice about how to write the code to set |
6dcd5ad16790
Make Major Mode Conventions xref to Tips for Defining.
Richard M. Stallman <rms@gnu.org>
parents:
12234
diff
changeset
|
146 up the mode's keymap variable. |
6dcd5ad16790
Make Major Mode Conventions xref to Tips for Defining.
Richard M. Stallman <rms@gnu.org>
parents:
12234
diff
changeset
|
147 |
6451 | 148 @item |
149 @cindex syntax tables in modes | |
150 The mode may have its own syntax table or may share one with other | |
151 related modes. If it has its own syntax table, it should store this in | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
152 a variable named @code{@var{modename}-mode-syntax-table}. @xref{Syntax |
6451 | 153 Tables}. |
154 | |
155 @item | |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
156 If the mode handles a language that has a syntax for comments, it should |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
157 set the variables that define the comment syntax. @xref{Options for |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
158 Comments,, Options Controlling Comments, emacs, The GNU Emacs Manual}. |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
159 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
160 @item |
6451 | 161 @cindex abbrev tables in modes |
162 The mode may have its own abbrev table or may share one with other | |
163 related modes. If it has its own abbrev table, it should store this in | |
164 a variable named @code{@var{modename}-mode-abbrev-table}. @xref{Abbrev | |
165 Tables}. | |
166 | |
167 @item | |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
168 @vindex font-lock-defaults |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
169 The mode should specify how to do highlighting for Font Lock mode, by |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
170 setting up a buffer-local value for the variable |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
171 @code{font-lock-defaults}. |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
172 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
173 @item |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
174 @vindex imenu-generic-expression |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
175 @vindex imenu-create-index-function |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
176 The mode should specify how Imenu should find the definitions or |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
177 sections of a buffer, by setting up a buffer-local value for the |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
178 variable @code{imenu-generic-expression} or |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
179 @code{imenu-create-index-function}. |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
180 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
181 @item |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
182 Use @code{defvar} to set mode-related variables, so that they are not |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
183 reinitialized if they already have a value. (Such reinitialization |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
184 could discard customizations made by the user.) |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
185 |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
186 @item |
6451 | 187 @cindex buffer-local variables in modes |
188 To make a buffer-local binding for an Emacs customization variable, use | |
189 @code{make-local-variable} in the major mode command, not | |
190 @code{make-variable-buffer-local}. The latter function would make the | |
191 variable local to every buffer in which it is subsequently set, which | |
192 would affect buffers that do not use this mode. It is undesirable for a | |
193 mode to have such global effects. @xref{Buffer-Local Variables}. | |
194 | |
195 It's ok to use @code{make-variable-buffer-local}, if you wish, for a | |
196 variable used only within a single Lisp package. | |
197 | |
198 @item | |
199 @cindex mode hook | |
200 @cindex major mode hook | |
201 Each major mode should have a @dfn{mode hook} named | |
202 @code{@var{modename}-mode-hook}. The major mode command should run that | |
203 hook, with @code{run-hooks}, as the very last thing it | |
204 does. @xref{Hooks}. | |
205 | |
206 @item | |
207 The major mode command may also run the hooks of some more basic modes. | |
208 For example, @code{indented-text-mode} runs @code{text-mode-hook} as | |
209 well as @code{indented-text-mode-hook}. It may run these other hooks | |
210 immediately before the mode's own hook (that is, after everything else), | |
211 or it may run them earlier. | |
212 | |
213 @item | |
214 If something special should be done if the user switches a buffer from | |
215 this mode to any other major mode, the mode can set a local value for | |
216 @code{change-major-mode-hook}. | |
217 | |
218 @item | |
219 If this mode is appropriate only for specially-prepared text, then the | |
220 major mode command symbol should have a property named @code{mode-class} | |
221 with value @code{special}, put on as follows: | |
222 | |
223 @cindex @code{mode-class} property | |
224 @cindex @code{special} | |
225 @example | |
226 (put 'funny-mode 'mode-class 'special) | |
227 @end example | |
228 | |
229 @noindent | |
230 This tells Emacs that new buffers created while the current buffer has | |
231 Funny mode should not inherit Funny mode. Modes such as Dired, Rmail, | |
232 and Buffer List use this feature. | |
233 | |
234 @item | |
235 If you want to make the new mode the default for files with certain | |
236 recognizable names, add an element to @code{auto-mode-alist} to select | |
237 the mode for those file names. If you define the mode command to | |
238 autoload, you should add this element in the same file that calls | |
239 @code{autoload}. Otherwise, it is sufficient to add the element in the | |
240 file that contains the mode definition. @xref{Auto Major Mode}. | |
241 | |
242 @item | |
243 @cindex @file{.emacs} customization | |
244 In the documentation, you should provide a sample @code{autoload} form | |
245 and an example of how to add to @code{auto-mode-alist}, that users can | |
246 include in their @file{.emacs} files. | |
247 | |
248 @item | |
249 @cindex mode loading | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
250 The top-level forms in the file defining the mode should be written so |
6451 | 251 that they may be evaluated more than once without adverse consequences. |
252 Even if you never load the file more than once, someone else will. | |
253 @end itemize | |
254 | |
255 @defvar change-major-mode-hook | |
256 This normal hook is run by @code{kill-all-local-variables} before it | |
257 does anything else. This gives major modes a way to arrange for | |
258 something special to be done if the user switches to a different major | |
259 mode. For best results, make this variable buffer-local, so that it | |
260 will disappear after doing its job and will not interfere with the | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
261 subsequent major mode. @xref{Hooks}. |
6451 | 262 @end defvar |
263 | |
264 @node Example Major Modes | |
265 @subsection Major Mode Examples | |
266 | |
267 Text mode is perhaps the simplest mode besides Fundamental mode. | |
268 Here are excerpts from @file{text-mode.el} that illustrate many of | |
269 the conventions listed above: | |
270 | |
271 @smallexample | |
272 @group | |
273 ;; @r{Create mode-specific tables.} | |
274 (defvar text-mode-syntax-table nil | |
275 "Syntax table used while in text mode.") | |
276 @end group | |
277 | |
278 @group | |
279 (if text-mode-syntax-table | |
280 () ; @r{Do not change the table if it is already set up.} | |
281 (setq text-mode-syntax-table (make-syntax-table)) | |
282 (modify-syntax-entry ?\" ". " text-mode-syntax-table) | |
283 (modify-syntax-entry ?\\ ". " text-mode-syntax-table) | |
284 (modify-syntax-entry ?' "w " text-mode-syntax-table)) | |
285 @end group | |
286 | |
287 @group | |
288 (defvar text-mode-abbrev-table nil | |
289 "Abbrev table used while in text mode.") | |
290 (define-abbrev-table 'text-mode-abbrev-table ()) | |
291 @end group | |
292 | |
293 @group | |
294 (defvar text-mode-map nil) ; @r{Create a mode-specific keymap.} | |
295 | |
296 (if text-mode-map | |
297 () ; @r{Do not change the keymap if it is already set up.} | |
298 (setq text-mode-map (make-sparse-keymap)) | |
299 (define-key text-mode-map "\t" 'tab-to-tab-stop) | |
300 (define-key text-mode-map "\es" 'center-line) | |
301 (define-key text-mode-map "\eS" 'center-paragraph)) | |
302 @end group | |
303 @end smallexample | |
304 | |
305 Here is the complete major mode function definition for Text mode: | |
306 | |
307 @smallexample | |
308 @group | |
309 (defun text-mode () | |
310 "Major mode for editing text intended for humans to read. | |
311 Special commands: \\@{text-mode-map@} | |
312 @end group | |
313 @group | |
314 Turning on text-mode runs the hook `text-mode-hook'." | |
315 (interactive) | |
316 (kill-all-local-variables) | |
317 @end group | |
318 @group | |
319 (use-local-map text-mode-map) ; @r{This provides the local keymap.} | |
320 (setq mode-name "Text") ; @r{This name goes into the mode line.} | |
321 (setq major-mode 'text-mode) ; @r{This is how @code{describe-mode}} | |
322 ; @r{finds the doc string to print.} | |
323 (setq local-abbrev-table text-mode-abbrev-table) | |
324 (set-syntax-table text-mode-syntax-table) | |
325 (run-hooks 'text-mode-hook)) ; @r{Finally, this permits the user to} | |
326 ; @r{customize the mode with a hook.} | |
327 @end group | |
328 @end smallexample | |
329 | |
330 @cindex @file{lisp-mode.el} | |
331 The three Lisp modes (Lisp mode, Emacs Lisp mode, and Lisp | |
332 Interaction mode) have more features than Text mode and the code is | |
333 correspondingly more complicated. Here are excerpts from | |
334 @file{lisp-mode.el} that illustrate how these modes are written. | |
335 | |
336 @cindex syntax table example | |
337 @smallexample | |
338 @group | |
339 ;; @r{Create mode-specific table variables.} | |
340 (defvar lisp-mode-syntax-table nil "") | |
341 (defvar emacs-lisp-mode-syntax-table nil "") | |
342 (defvar lisp-mode-abbrev-table nil "") | |
343 @end group | |
344 | |
345 @group | |
346 (if (not emacs-lisp-mode-syntax-table) ; @r{Do not change the table} | |
347 ; @r{if it is already set.} | |
348 (let ((i 0)) | |
349 (setq emacs-lisp-mode-syntax-table (make-syntax-table)) | |
350 @end group | |
351 | |
352 @group | |
353 ;; @r{Set syntax of chars up to 0 to class of chars that are} | |
354 ;; @r{part of symbol names but not words.} | |
355 ;; @r{(The number 0 is @code{48} in the @sc{ASCII} character set.)} | |
356 (while (< i ?0) | |
357 (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) | |
358 (setq i (1+ i))) | |
359 @dots{} | |
360 @end group | |
361 @group | |
362 ;; @r{Set the syntax for other characters.} | |
363 (modify-syntax-entry ? " " emacs-lisp-mode-syntax-table) | |
364 (modify-syntax-entry ?\t " " emacs-lisp-mode-syntax-table) | |
365 @dots{} | |
366 @end group | |
367 @group | |
368 (modify-syntax-entry ?\( "() " emacs-lisp-mode-syntax-table) | |
369 (modify-syntax-entry ?\) ")( " emacs-lisp-mode-syntax-table) | |
370 @dots{})) | |
371 ;; @r{Create an abbrev table for lisp-mode.} | |
372 (define-abbrev-table 'lisp-mode-abbrev-table ()) | |
373 @end group | |
374 @end smallexample | |
375 | |
376 Much code is shared among the three Lisp modes. The following | |
377 function sets various variables; it is called by each of the major Lisp | |
378 mode functions: | |
379 | |
380 @smallexample | |
381 @group | |
382 (defun lisp-mode-variables (lisp-syntax) | |
383 ;; @r{The @code{lisp-syntax} argument is @code{nil} in Emacs Lisp mode,} | |
384 ;; @r{and @code{t} in the other two Lisp modes.} | |
385 (cond (lisp-syntax | |
386 (if (not lisp-mode-syntax-table) | |
387 ;; @r{The Emacs Lisp mode syntax table always exists, but} | |
388 ;; @r{the Lisp Mode syntax table is created the first time a} | |
389 ;; @r{mode that needs it is called. This is to save space.} | |
390 @end group | |
391 @group | |
392 (progn (setq lisp-mode-syntax-table | |
393 (copy-syntax-table emacs-lisp-mode-syntax-table)) | |
394 ;; @r{Change some entries for Lisp mode.} | |
395 (modify-syntax-entry ?\| "\" " | |
396 lisp-mode-syntax-table) | |
397 (modify-syntax-entry ?\[ "_ " | |
398 lisp-mode-syntax-table) | |
399 (modify-syntax-entry ?\] "_ " | |
400 lisp-mode-syntax-table))) | |
401 @end group | |
402 @group | |
403 (set-syntax-table lisp-mode-syntax-table))) | |
404 (setq local-abbrev-table lisp-mode-abbrev-table) | |
405 @dots{}) | |
406 @end group | |
407 @end smallexample | |
408 | |
409 Functions such as @code{forward-paragraph} use the value of the | |
410 @code{paragraph-start} variable. Since Lisp code is different from | |
411 ordinary text, the @code{paragraph-start} variable needs to be set | |
412 specially to handle Lisp. Also, comments are indented in a special | |
413 fashion in Lisp and the Lisp modes need their own mode-specific | |
414 @code{comment-indent-function}. The code to set these variables is the | |
415 rest of @code{lisp-mode-variables}. | |
416 | |
417 @smallexample | |
418 @group | |
419 (make-local-variable 'paragraph-start) | |
12098 | 420 ;; @r{Having @samp{^} is not clean, but @code{page-delimiter}} |
421 ;; @r{has them too, and removing those is a pain.} | |
6451 | 422 (setq paragraph-start (concat "^$\\|" page-delimiter)) |
423 @dots{} | |
424 @end group | |
425 @group | |
426 (make-local-variable 'comment-indent-function) | |
427 (setq comment-indent-function 'lisp-comment-indent)) | |
428 @end group | |
429 @end smallexample | |
430 | |
431 Each of the different Lisp modes has a slightly different keymap. For | |
432 example, Lisp mode binds @kbd{C-c C-l} to @code{run-lisp}, but the other | |
433 Lisp modes do not. However, all Lisp modes have some commands in | |
434 common. The following function adds these common commands to a given | |
435 keymap. | |
436 | |
437 @smallexample | |
438 @group | |
439 (defun lisp-mode-commands (map) | |
440 (define-key map "\e\C-q" 'indent-sexp) | |
441 (define-key map "\177" 'backward-delete-char-untabify) | |
442 (define-key map "\t" 'lisp-indent-line)) | |
443 @end group | |
444 @end smallexample | |
445 | |
446 Here is an example of using @code{lisp-mode-commands} to initialize a | |
447 keymap, as part of the code for Emacs Lisp mode. First we declare a | |
448 variable with @code{defvar} to hold the mode-specific keymap. When this | |
449 @code{defvar} executes, it sets the variable to @code{nil} if it was | |
450 void. Then we set up the keymap if the variable is @code{nil}. | |
451 | |
452 This code avoids changing the keymap or the variable if it is already | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
453 set up. This lets the user customize the keymap. |
6451 | 454 |
455 @smallexample | |
456 @group | |
457 (defvar emacs-lisp-mode-map () "") | |
458 (if emacs-lisp-mode-map | |
459 () | |
460 (setq emacs-lisp-mode-map (make-sparse-keymap)) | |
461 (define-key emacs-lisp-mode-map "\e\C-x" 'eval-defun) | |
462 (lisp-mode-commands emacs-lisp-mode-map)) | |
463 @end group | |
464 @end smallexample | |
465 | |
466 Finally, here is the complete major mode function definition for | |
467 Emacs Lisp mode. | |
468 | |
469 @smallexample | |
470 @group | |
471 (defun emacs-lisp-mode () | |
472 "Major mode for editing Lisp code to run in Emacs. | |
473 Commands: | |
474 Delete converts tabs to spaces as it moves back. | |
475 Blank lines separate paragraphs. Semicolons start comments. | |
476 \\@{emacs-lisp-mode-map@} | |
477 @end group | |
478 @group | |
479 Entry to this mode runs the hook `emacs-lisp-mode-hook'." | |
480 (interactive) | |
481 (kill-all-local-variables) | |
482 (use-local-map emacs-lisp-mode-map) ; @r{This provides the local keymap.} | |
483 (set-syntax-table emacs-lisp-mode-syntax-table) | |
484 @end group | |
485 @group | |
486 (setq major-mode 'emacs-lisp-mode) ; @r{This is how @code{describe-mode}} | |
487 ; @r{finds out what to describe.} | |
488 (setq mode-name "Emacs-Lisp") ; @r{This goes into the mode line.} | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
489 (lisp-mode-variables nil) ; @r{This defines various variables.} |
6451 | 490 (run-hooks 'emacs-lisp-mode-hook)) ; @r{This permits the user to use a} |
491 ; @r{hook to customize the mode.} | |
492 @end group | |
493 @end smallexample | |
494 | |
495 @node Auto Major Mode | |
496 @subsection How Emacs Chooses a Major Mode | |
497 | |
498 Based on information in the file name or in the file itself, Emacs | |
499 automatically selects a major mode for the new buffer when a file is | |
500 visited. | |
501 | |
502 @deffn Command fundamental-mode | |
503 Fundamental mode is a major mode that is not specialized for anything | |
504 in particular. Other major modes are defined in effect by comparison | |
505 with this one---their definitions say what to change, starting from | |
506 Fundamental mode. The @code{fundamental-mode} function does @emph{not} | |
507 run any hooks; you're not supposed to customize it. (If you want Emacs | |
508 to behave differently in Fundamental mode, change the @emph{global} | |
509 state of Emacs.) | |
510 @end deffn | |
511 | |
512 @deffn Command normal-mode &optional find-file | |
12098 | 513 This function establishes the proper major mode and local variable |
6451 | 514 bindings for the current buffer. First it calls @code{set-auto-mode}, |
515 then it runs @code{hack-local-variables} to parse, and bind or | |
516 evaluate as appropriate, any local variables. | |
517 | |
12098 | 518 If the @var{find-file} argument to @code{normal-mode} is |
6451 | 519 non-@code{nil}, @code{normal-mode} assumes that the @code{find-file} |
520 function is calling it. In this case, it may process a local variables | |
12098 | 521 list at the end of the file and in the @samp{-*-} line. The variable |
522 @code{enable-local-variables} controls whether to do so. | |
6451 | 523 |
12098 | 524 If you run @code{normal-mode} interactively, the argument |
6451 | 525 @var{find-file} is normally @code{nil}. In this case, |
526 @code{normal-mode} unconditionally processes any local variables list. | |
527 @xref{File variables, , Local Variables in Files, emacs, The GNU Emacs | |
528 Manual}, for the syntax of the local variables section of a file. | |
529 | |
530 @cindex file mode specification error | |
12098 | 531 @code{normal-mode} uses @code{condition-case} around the call to the |
6451 | 532 major mode function, so errors are caught and reported as a @samp{File |
533 mode specification error}, followed by the original error message. | |
534 @end deffn | |
535 | |
536 @defopt enable-local-variables | |
537 This variable controls processing of local variables lists in files | |
538 being visited. A value of @code{t} means process the local variables | |
539 lists unconditionally; @code{nil} means ignore them; anything else means | |
540 ask the user what to do for each file. The default value is @code{t}. | |
541 @end defopt | |
542 | |
12098 | 543 @defvar ignored-local-variables |
544 This variable holds a list of variables that should not be | |
545 set by a local variables list. Any value specified | |
546 for one of these variables is ignored. | |
547 @end defvar | |
548 | |
549 In addition to this list, any variable whose name has a non-@code{nil} | |
550 @code{risky-local-variable} property is also ignored. | |
551 | |
6451 | 552 @defopt enable-local-eval |
553 This variable controls processing of @samp{Eval:} in local variables | |
554 lists in files being visited. A value of @code{t} means process them | |
555 unconditionally; @code{nil} means ignore them; anything else means ask | |
556 the user what to do for each file. The default value is @code{maybe}. | |
557 @end defopt | |
558 | |
559 @defun set-auto-mode | |
560 @cindex visited file mode | |
561 This function selects the major mode that is appropriate for the | |
562 current buffer. It may base its decision on the value of the @w{@samp{-*-}} | |
12888 | 563 line, on the visited file name (using @code{auto-mode-alist}), on the |
564 @w{@samp{#!}} line (using @code{interpreter-mode-alist}), or on the | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
565 value of a local variable. However, this function does not look for |
6451 | 566 the @samp{mode:} local variable near the end of a file; the |
567 @code{hack-local-variables} function does that. @xref{Choosing Modes, , | |
568 How Major Modes are Chosen, emacs, The GNU Emacs Manual}. | |
569 @end defun | |
570 | |
571 @defopt default-major-mode | |
572 This variable holds the default major mode for new buffers. The | |
573 standard value is @code{fundamental-mode}. | |
574 | |
575 If the value of @code{default-major-mode} is @code{nil}, Emacs uses | |
576 the (previously) current buffer's major mode for the major mode of a new | |
577 buffer. However, if the major mode symbol has a @code{mode-class} | |
578 property with value @code{special}, then it is not used for new buffers; | |
579 Fundamental mode is used instead. The modes that have this property are | |
580 those such as Dired and Rmail that are useful only with text that has | |
581 been specially prepared. | |
582 @end defopt | |
583 | |
12067 | 584 @defun set-buffer-major-mode buffer |
585 This function sets the major mode of @var{buffer} to the value of | |
586 @code{default-major-mode}. If that variable is @code{nil}, it uses | |
587 the current buffer's major mode (if that is suitable). | |
588 | |
589 The low-level primitives for creating buffers do not use this function, | |
12098 | 590 but medium-level commands such as @code{switch-to-buffer} and |
591 @code{find-file-noselect} use it whenever they create buffers. | |
12067 | 592 @end defun |
593 | |
6451 | 594 @defvar initial-major-mode |
595 @cindex @samp{*scratch*} | |
596 The value of this variable determines the major mode of the initial | |
597 @samp{*scratch*} buffer. The value should be a symbol that is a major | |
598 mode command name. The default value is @code{lisp-interaction-mode}. | |
599 @end defvar | |
600 | |
601 @defvar auto-mode-alist | |
602 This variable contains an association list of file name patterns | |
603 (regular expressions; @pxref{Regular Expressions}) and corresponding | |
604 major mode functions. Usually, the file name patterns test for | |
605 suffixes, such as @samp{.el} and @samp{.c}, but this need not be the | |
606 case. An ordinary element of the alist looks like @code{(@var{regexp} . | |
607 @var{mode-function})}. | |
608 | |
609 For example, | |
610 | |
611 @smallexample | |
612 @group | |
613 (("^/tmp/fol/" . text-mode) | |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
614 ("\\.texinfo\\'" . texinfo-mode) |
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
615 ("\\.texi\\'" . texinfo-mode) |
6451 | 616 @end group |
617 @group | |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
618 ("\\.el\\'" . emacs-lisp-mode) |
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
619 ("\\.c\\'" . c-mode) |
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
620 ("\\.h\\'" . c-mode) |
6451 | 621 @dots{}) |
622 @end group | |
623 @end smallexample | |
624 | |
625 When you visit a file whose expanded file name (@pxref{File Name | |
626 Expansion}) matches a @var{regexp}, @code{set-auto-mode} calls the | |
627 corresponding @var{mode-function}. This feature enables Emacs to select | |
628 the proper major mode for most files. | |
629 | |
630 If an element of @code{auto-mode-alist} has the form @code{(@var{regexp} | |
631 @var{function} t)}, then after calling @var{function}, Emacs searches | |
632 @code{auto-mode-alist} again for a match against the portion of the file | |
633 name that did not match before. | |
634 | |
635 This match-again feature is useful for uncompression packages: an entry | |
636 of the form @code{("\\.gz\\'" . @var{function})} can uncompress the file | |
637 and then put the uncompressed file in the proper mode according to the | |
638 name sans @samp{.gz}. | |
639 | |
640 Here is an example of how to prepend several pattern pairs to | |
641 @code{auto-mode-alist}. (You might use this sort of expression in your | |
642 @file{.emacs} file.) | |
643 | |
644 @smallexample | |
645 @group | |
646 (setq auto-mode-alist | |
647 (append | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
648 ;; @r{File name starts with a dot.} |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
649 '(("/\\.[^/]*\\'" . fundamental-mode) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
650 ;; @r{File name has no dot.} |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
651 ("[^\\./]*\\'" . fundamental-mode) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
652 ;; @r{File name ends in @samp{.C}.} |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
653 ("\\.C\\'" . c++-mode)) |
6451 | 654 auto-mode-alist)) |
655 @end group | |
656 @end smallexample | |
657 @end defvar | |
658 | |
659 @defvar interpreter-mode-alist | |
660 This variable specifes major modes to use for scripts that specify a | |
12888 | 661 command interpreter in an @samp{#!} line. Its value is a list of |
6451 | 662 elements of the form @code{(@var{interpreter} . @var{mode})}; for |
663 example, @code{("perl" . perl-mode)} is one element present by default. | |
664 The element says to use mode @var{mode} if the file specifies | |
665 @var{interpreter}. | |
666 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
667 This variable is applicable only when the @code{auto-mode-alist} does |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
668 not indicate which major mode to use. |
6451 | 669 @end defvar |
670 | |
671 @defun hack-local-variables &optional force | |
672 This function parses, and binds or evaluates as appropriate, any local | |
673 variables for the current buffer. | |
674 | |
675 The handling of @code{enable-local-variables} documented for | |
676 @code{normal-mode} actually takes place here. The argument @var{force} | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
677 usually comes from the argument @var{find-file} given to |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
678 @code{normal-mode}. |
6451 | 679 @end defun |
680 | |
681 @node Mode Help | |
682 @subsection Getting Help about a Major Mode | |
683 @cindex mode help | |
684 @cindex help for major mode | |
685 @cindex documentation for major mode | |
686 | |
687 The @code{describe-mode} function is used to provide information | |
688 about major modes. It is normally called with @kbd{C-h m}. The | |
689 @code{describe-mode} function uses the value of @code{major-mode}, | |
690 which is why every major mode function needs to set the | |
691 @code{major-mode} variable. | |
692 | |
693 @deffn Command describe-mode | |
694 This function displays the documentation of the current major mode. | |
695 | |
696 The @code{describe-mode} function calls the @code{documentation} | |
697 function using the value of @code{major-mode} as an argument. Thus, it | |
698 displays the documentation string of the major mode function. | |
699 (@xref{Accessing Documentation}.) | |
700 @end deffn | |
701 | |
702 @defvar major-mode | |
703 This variable holds the symbol for the current buffer's major mode. | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
704 This symbol should have a function definition that is the command to |
6451 | 705 switch to that major mode. The @code{describe-mode} function uses the |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
706 documentation string of the function as the documentation of the major |
6451 | 707 mode. |
708 @end defvar | |
709 | |
710 @node Derived Modes | |
711 @subsection Defining Derived Modes | |
712 | |
713 It's often useful to define a new major mode in terms of an existing | |
714 one. An easy way to do this is to use @code{define-derived-mode}. | |
715 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
716 @defmac define-derived-mode variant parent name docstring body@dots{} |
6451 | 717 This construct defines @var{variant} as a major mode command, using |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
718 @var{name} as the string form of the mode name. |
6451 | 719 |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
720 The new command @var{variant} is defined to call the function |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
721 @var{parent}, then override certain aspects of that parent mode: |
6451 | 722 |
723 @itemize @bullet | |
724 @item | |
725 The new mode has its own keymap, named @code{@var{variant}-map}. | |
726 @code{define-derived-mode} initializes this map to inherit from | |
727 @code{@var{parent}-map}, if it is not already set. | |
728 | |
729 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
730 The new mode has its own syntax table, kept in the variable |
6451 | 731 @code{@var{variant}-syntax-table}. |
732 @code{define-derived-mode} initializes this variable by copying | |
733 @code{@var{parent}-syntax-table}, if it is not already set. | |
734 | |
735 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
736 The new mode has its own abbrev table, kept in the variable |
6451 | 737 @code{@var{variant}-abbrev-table}. |
738 @code{define-derived-mode} initializes this variable by copying | |
739 @code{@var{parent}-abbrev-table}, if it is not already set. | |
740 | |
741 @item | |
742 The new mode has its own mode hook, @code{@var{variant}-hook}, | |
743 which it runs in standard fashion as the very last thing that it does. | |
744 (The new mode also runs the mode hook of @var{parent} as part | |
745 of calling @var{parent}.) | |
746 @end itemize | |
747 | |
748 In addition, you can specify how to override other aspects of | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
749 @var{parent} with @var{body}. The command @var{variant} |
6451 | 750 evaluates the forms in @var{body} after setting up all its usual |
751 overrides, just before running @code{@var{variant}-hook}. | |
752 | |
753 The argument @var{docstring} specifies the documentation string for the | |
754 new mode. If you omit @var{docstring}, @code{define-derived-mode} | |
755 generates a documentation string. | |
756 | |
757 Here is a hypothetical example: | |
758 | |
759 @example | |
760 (define-derived-mode hypertext-mode | |
761 text-mode "Hypertext" | |
762 "Major mode for hypertext. | |
763 \\@{hypertext-mode-map@}" | |
764 (setq case-fold-search nil)) | |
765 | |
766 (define-key hypertext-mode-map | |
767 [down-mouse-3] 'do-hyper-link) | |
768 @end example | |
769 @end defmac | |
770 | |
771 @node Minor Modes | |
772 @section Minor Modes | |
773 @cindex minor mode | |
774 | |
775 A @dfn{minor mode} provides features that users may enable or disable | |
776 independently of the choice of major mode. Minor modes can be enabled | |
777 individually or in combination. Minor modes would be better named | |
778 ``Generally available, optional feature modes'' except that such a name is | |
779 unwieldy. | |
780 | |
781 A minor mode is not usually a modification of single major mode. For | |
782 example, Auto Fill mode may be used in any major mode that permits text | |
783 insertion. To be general, a minor mode must be effectively independent | |
784 of the things major modes do. | |
785 | |
786 A minor mode is often much more difficult to implement than a major | |
787 mode. One reason is that you should be able to activate and deactivate | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
788 minor modes in any order. A minor mode should be able to have its |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
789 desired effect regardless of the major mode and regardless of the other |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
790 minor modes in effect. |
6451 | 791 |
792 Often the biggest problem in implementing a minor mode is finding a | |
793 way to insert the necessary hook into the rest of Emacs. Minor mode | |
12098 | 794 keymaps make this easier than it used to be. |
6451 | 795 |
796 @menu | |
797 * Minor Mode Conventions:: Tips for writing a minor mode. | |
798 * Keymaps and Minor Modes:: How a minor mode can have its own keymap. | |
799 @end menu | |
800 | |
801 @node Minor Mode Conventions | |
802 @subsection Conventions for Writing Minor Modes | |
803 @cindex minor mode conventions | |
804 @cindex conventions for writing minor modes | |
805 | |
806 There are conventions for writing minor modes just as there are for | |
807 major modes. Several of the major mode conventions apply to minor | |
808 modes as well: those regarding the name of the mode initialization | |
809 function, the names of global symbols, and the use of keymaps and | |
810 other tables. | |
811 | |
812 In addition, there are several conventions that are specific to | |
813 minor modes. | |
814 | |
815 @itemize @bullet | |
816 @item | |
817 @cindex mode variable | |
818 Make a variable whose name ends in @samp{-mode} to represent the minor | |
819 mode. Its value should enable or disable the mode (@code{nil} to | |
820 disable; anything else to enable.) We call this the @dfn{mode | |
821 variable}. | |
822 | |
823 This variable is used in conjunction with the @code{minor-mode-alist} to | |
824 display the minor mode name in the mode line. It can also enable | |
825 or disable a minor mode keymap. Individual commands or hooks can also | |
826 check the variable's value. | |
827 | |
828 If you want the minor mode to be enabled separately in each buffer, | |
829 make the variable buffer-local. | |
830 | |
831 @item | |
832 Define a command whose name is the same as the mode variable. | |
833 Its job is to enable and disable the mode by setting the variable. | |
834 | |
835 The command should accept one optional argument. If the argument is | |
836 @code{nil}, it should toggle the mode (turn it on if it is off, and off | |
837 if it is on). Otherwise, it should turn the mode on if the argument is | |
838 a positive integer, a symbol other than @code{nil} or @code{-}, or a | |
839 list whose @sc{car} is such an integer or symbol; it should turn the | |
840 mode off otherwise. | |
841 | |
12098 | 842 Here is an example taken from the definition of @code{transient-mark-mode}. |
843 It shows the use of @code{transient-mark-mode} as a variable that enables or | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
844 disables the mode's behavior, and also shows the proper way to toggle, |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
845 enable or disable the minor mode based on the raw prefix argument value. |
6451 | 846 |
847 @smallexample | |
848 @group | |
12098 | 849 (setq transient-mark-mode |
850 (if (null arg) (not transient-mark-mode) | |
6451 | 851 (> (prefix-numeric-value arg) 0))) |
852 @end group | |
853 @end smallexample | |
854 | |
855 @item | |
856 Add an element to @code{minor-mode-alist} for each minor mode | |
857 (@pxref{Mode Line Variables}). This element should be a list of the | |
858 following form: | |
859 | |
860 @smallexample | |
861 (@var{mode-variable} @var{string}) | |
862 @end smallexample | |
863 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
864 Here @var{mode-variable} is the variable that controls enabling of the |
6451 | 865 minor mode, and @var{string} is a short string, starting with a space, |
866 to represent the mode in the mode line. These strings must be short so | |
867 that there is room for several of them at once. | |
868 | |
869 When you add an element to @code{minor-mode-alist}, use @code{assq} to | |
870 check for an existing element, to avoid duplication. For example: | |
871 | |
872 @smallexample | |
873 @group | |
874 (or (assq 'leif-mode minor-mode-alist) | |
875 (setq minor-mode-alist | |
876 (cons '(leif-mode " Leif") minor-mode-alist))) | |
877 @end group | |
878 @end smallexample | |
879 @end itemize | |
880 | |
881 @node Keymaps and Minor Modes | |
882 @subsection Keymaps and Minor Modes | |
883 | |
12098 | 884 Each minor mode can have its own keymap, which is active when the mode |
885 is enabled. To set up a keymap for a minor mode, add an element to the | |
886 alist @code{minor-mode-map-alist}. @xref{Active Keymaps}. | |
6451 | 887 |
888 @cindex @code{self-insert-command}, minor modes | |
889 One use of minor mode keymaps is to modify the behavior of certain | |
890 self-inserting characters so that they do something else as well as | |
891 self-insert. In general, this is the only way to do that, since the | |
892 facilities for customizing @code{self-insert-command} are limited to | |
893 special cases (designed for abbrevs and Auto Fill mode). (Do not try | |
894 substituting your own definition of @code{self-insert-command} for the | |
895 standard one. The editor command loop handles this function specially.) | |
896 | |
897 @node Mode Line Format | |
898 @section Mode Line Format | |
899 @cindex mode line | |
900 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
901 Each Emacs window (aside from minibuffer windows) includes a mode line, |
6451 | 902 which displays status information about the buffer displayed in the |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
903 window. The mode line contains information about the buffer, such as its |
6451 | 904 name, associated file, depth of recursive editing, and the major and |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
905 minor modes. |
6451 | 906 |
907 This section describes how the contents of the mode line are | |
908 controlled. It is in the chapter on modes because much of the | |
909 information displayed in the mode line relates to the enabled major and | |
910 minor modes. | |
911 | |
912 @code{mode-line-format} is a buffer-local variable that holds a | |
913 template used to display the mode line of the current buffer. All | |
12098 | 914 windows for the same buffer use the same @code{mode-line-format} and |
915 their mode lines appear the same (except for scrolling percentages and | |
6451 | 916 line numbers). |
917 | |
918 The mode line of a window is normally updated whenever a different | |
919 buffer is shown in the window, or when the buffer's modified-status | |
920 changes from @code{nil} to @code{t} or vice-versa. If you modify any of | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
921 the variables referenced by @code{mode-line-format} (@pxref{Mode Line |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
922 Variables}), you may want to force an update of the mode line so as to |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
923 display the new information. |
6451 | 924 |
925 @c Emacs 19 feature | |
926 @defun force-mode-line-update | |
927 Force redisplay of the current buffer's mode line. | |
928 @end defun | |
929 | |
930 The mode line is usually displayed in inverse video; see | |
931 @code{mode-line-inverse-video} in @ref{Inverse Video}. | |
932 | |
933 @menu | |
934 * Mode Line Data:: The data structure that controls the mode line. | |
935 * Mode Line Variables:: Variables used in that data structure. | |
936 * %-Constructs:: Putting information into a mode line. | |
937 @end menu | |
938 | |
939 @node Mode Line Data | |
940 @subsection The Data Structure of the Mode Line | |
941 @cindex mode line construct | |
942 | |
943 The mode line contents are controlled by a data structure of lists, | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
944 strings, symbols, and numbers kept in the buffer-local variable |
6451 | 945 @code{mode-line-format}. The data structure is called a @dfn{mode line |
946 construct}, and it is built in recursive fashion out of simpler mode line | |
12067 | 947 constructs. The same data structure is used for constructing |
12098 | 948 frame titles (@pxref{Frame Titles}). |
6451 | 949 |
950 @defvar mode-line-format | |
951 The value of this variable is a mode line construct with overall | |
952 responsibility for the mode line format. The value of this variable | |
953 controls which other variables are used to form the mode line text, and | |
954 where they appear. | |
955 @end defvar | |
956 | |
957 A mode line construct may be as simple as a fixed string of text, but | |
958 it usually specifies how to use other variables to construct the text. | |
959 Many of these variables are themselves defined to have mode line | |
960 constructs as their values. | |
961 | |
962 The default value of @code{mode-line-format} incorporates the values | |
963 of variables such as @code{mode-name} and @code{minor-mode-alist}. | |
964 Because of this, very few modes need to alter @code{mode-line-format}. | |
965 For most purposes, it is sufficient to alter the variables referenced by | |
966 @code{mode-line-format}. | |
967 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
968 A mode line construct may be a list, a symbol, or a string. If the |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
969 value is a list, each element may be a list, a symbol, or a string. |
6451 | 970 |
971 @table @code | |
972 @cindex percent symbol in mode line | |
973 @item @var{string} | |
974 A string as a mode line construct is displayed verbatim in the mode line | |
12098 | 975 except for @dfn{@code{%}-constructs}. Decimal digits after the @samp{%} |
6451 | 976 specify the field width for space filling on the right (i.e., the data |
977 is left justified). @xref{%-Constructs}. | |
978 | |
979 @item @var{symbol} | |
980 A symbol as a mode line construct stands for its value. The value of | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
981 @var{symbol} is used as a mode line construct, in place of @var{symbol}. |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
982 However, the symbols @code{t} and @code{nil} are ignored; so is any |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
983 symbol whose value is void. |
6451 | 984 |
985 There is one exception: if the value of @var{symbol} is a string, it is | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
986 displayed verbatim: the @code{%}-constructs are not recognized. |
6451 | 987 |
988 @item (@var{string} @var{rest}@dots{}) @r{or} (@var{list} @var{rest}@dots{}) | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
989 A list whose first element is a string or list means to process all the |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
990 elements recursively and concatenate the results. This is the most |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
991 common form of mode line construct. |
6451 | 992 |
993 @item (@var{symbol} @var{then} @var{else}) | |
994 A list whose first element is a symbol is a conditional. Its meaning | |
995 depends on the value of @var{symbol}. If the value is non-@code{nil}, | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
996 the second element, @var{then}, is processed recursively as a mode line |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
997 element. But if the value of @var{symbol} is @code{nil}, the third |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
998 element, @var{else}, is processed recursively. You may omit @var{else}; |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
999 then the mode line element displays nothing if the value of @var{symbol} |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1000 is @code{nil}. |
6451 | 1001 |
1002 @item (@var{width} @var{rest}@dots{}) | |
1003 A list whose first element is an integer specifies truncation or | |
1004 padding of the results of @var{rest}. The remaining elements | |
1005 @var{rest} are processed recursively as mode line constructs and | |
1006 concatenated together. Then the result is space filled (if | |
1007 @var{width} is positive) or truncated (to @minus{}@var{width} columns, | |
1008 if @var{width} is negative) on the right. | |
1009 | |
1010 For example, the usual way to show what percentage of a buffer is above | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1011 the top of the window is to use a list like this: @code{(-3 "%p")}. |
6451 | 1012 @end table |
1013 | |
1014 If you do alter @code{mode-line-format} itself, the new value should | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1015 use the same variables that appear in the default value (@pxref{Mode |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1016 Line Variables}), rather than duplicating their contents or displaying |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1017 the information in another fashion. This way, customizations made by |
12098 | 1018 the user or by Lisp programs (such as @code{display-time} and major |
1019 modes) via changes to those variables remain effective. | |
6451 | 1020 |
1021 @cindex Shell mode @code{mode-line-format} | |
1022 Here is an example of a @code{mode-line-format} that might be | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1023 useful for @code{shell-mode}, since it contains the hostname and default |
6451 | 1024 directory. |
1025 | |
1026 @example | |
1027 @group | |
1028 (setq mode-line-format | |
1029 (list "" | |
1030 'mode-line-modified | |
1031 "%b--" | |
1032 @end group | |
1033 (getenv "HOST") ; @r{One element is not constant.} | |
1034 ":" | |
1035 'default-directory | |
1036 " " | |
1037 'global-mode-string | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1038 " %[(" |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1039 'mode-name |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1040 'mode-line-process |
6451 | 1041 'minor-mode-alist |
1042 "%n" | |
1043 ")%]----" | |
1044 @group | |
12098 | 1045 '(line-number-mode "L%l--") |
6451 | 1046 '(-3 . "%p") |
1047 "-%-")) | |
1048 @end group | |
1049 @end example | |
1050 | |
1051 @node Mode Line Variables | |
1052 @subsection Variables Used in the Mode Line | |
1053 | |
1054 This section describes variables incorporated by the | |
1055 standard value of @code{mode-line-format} into the text of the mode | |
1056 line. There is nothing inherently special about these variables; any | |
1057 other variables could have the same effects on the mode line if | |
1058 @code{mode-line-format} were changed to use them. | |
1059 | |
1060 @defvar mode-line-modified | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1061 This variable holds the value of the mode-line construct that displays |
6451 | 1062 whether the current buffer is modified. |
1063 | |
12098 | 1064 The default value of @code{mode-line-modified} is @code{("--%1*%1+-")}. |
1065 This means that the mode line displays @samp{--**-} if the buffer is | |
1066 modified, @samp{-----} if the buffer is not modified, @samp{--%%-} if | |
1067 the buffer is read only, and @samp{--%*--} if the buffer is read only | |
1068 and modified. | |
6451 | 1069 |
1070 Changing this variable does not force an update of the mode line. | |
1071 @end defvar | |
1072 | |
1073 @defvar mode-line-buffer-identification | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1074 This variable identifies the buffer being displayed in the window. Its |
12098 | 1075 default value is @code{("%F: %17b")}, which means that it usually |
1076 displays @samp{Emacs:} followed by seventeen characters of the buffer | |
1077 name. (In a terminal frame, it displays the frame name instead of | |
1078 @samp{Emacs}; this has the effect of showing the frame number.) You may | |
1079 want to change this in modes such as Rmail that do not behave like a | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1080 ``normal'' Emacs. |
6451 | 1081 @end defvar |
1082 | |
1083 @defvar global-mode-string | |
1084 This variable holds a mode line spec that appears in the mode line by | |
1085 default, just after the buffer name. The command @code{display-time} | |
1086 sets @code{global-mode-string} to refer to the variable | |
1087 @code{display-time-string}, which holds a string containing the time and | |
1088 load information. | |
1089 | |
1090 The @samp{%M} construct substitutes the value of | |
1091 @code{global-mode-string}, but this is obsolete, since the variable is | |
1092 included directly in the mode line. | |
1093 @end defvar | |
1094 | |
1095 @defvar mode-name | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1096 This buffer-local variable holds the ``pretty'' name of the current |
6451 | 1097 buffer's major mode. Each major mode should set this variable so that the |
1098 mode name will appear in the mode line. | |
1099 @end defvar | |
1100 | |
1101 @defvar minor-mode-alist | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1102 This variable holds an association list whose elements specify how the |
6451 | 1103 mode line should indicate that a minor mode is active. Each element of |
1104 the @code{minor-mode-alist} should be a two-element list: | |
1105 | |
1106 @example | |
1107 (@var{minor-mode-variable} @var{mode-line-string}) | |
1108 @end example | |
1109 | |
1110 More generally, @var{mode-line-string} can be any mode line spec. It | |
1111 appears in the mode line when the value of @var{minor-mode-variable} is | |
1112 non-@code{nil}, and not otherwise. These strings should begin with | |
1113 spaces so that they don't run together. Conventionally, the | |
1114 @var{minor-mode-variable} for a specific mode is set to a non-@code{nil} | |
1115 value when that minor mode is activated. | |
1116 | |
1117 The default value of @code{minor-mode-alist} is: | |
1118 | |
1119 @example | |
1120 @group | |
1121 minor-mode-alist | |
12098 | 1122 @result{} ((vc-mode vc-mode) |
1123 (abbrev-mode " Abbrev") | |
1124 (overwrite-mode overwrite-mode) | |
6451 | 1125 (auto-fill-function " Fill") |
12098 | 1126 (defining-kbd-macro " Def") |
1127 (isearch-mode isearch-mode)) | |
6451 | 1128 @end group |
1129 @end example | |
1130 | |
12098 | 1131 @code{minor-mode-alist} is not buffer-local. The variables mentioned |
6451 | 1132 in the alist should be buffer-local if the minor mode can be enabled |
1133 separately in each buffer. | |
1134 @end defvar | |
1135 | |
1136 @defvar mode-line-process | |
1137 This buffer-local variable contains the mode line information on process | |
1138 status in modes used for communicating with subprocesses. It is | |
1139 displayed immediately following the major mode name, with no intervening | |
1140 space. For example, its value in the @samp{*shell*} buffer is | |
1141 @code{(":@: %s")}, which allows the shell to display its status along | |
1142 with the major mode as: @samp{(Shell:@: run)}. Normally this variable | |
1143 is @code{nil}. | |
1144 @end defvar | |
1145 | |
1146 @defvar default-mode-line-format | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1147 This variable holds the default @code{mode-line-format} for buffers |
6451 | 1148 that do not override it. This is the same as @code{(default-value |
1149 'mode-line-format)}. | |
1150 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1151 The default value of @code{default-mode-line-format} is: |
6451 | 1152 |
1153 @example | |
1154 @group | |
1155 ("" | |
1156 mode-line-modified | |
1157 mode-line-buffer-identification | |
1158 " " | |
1159 global-mode-string | |
1160 " %[(" | |
1161 mode-name | |
1162 @end group | |
1163 @group | |
12098 | 1164 mode-line-process |
6451 | 1165 minor-mode-alist |
1166 "%n" | |
1167 ")%]----" | |
12098 | 1168 (line-number-mode "L%l--") |
6451 | 1169 (-3 . "%p") |
1170 "-%-") | |
1171 @end group | |
1172 @end example | |
1173 @end defvar | |
1174 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1175 @defvar vc-mode |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1176 The variable @code{vc-mode}, local in each buffer, records whether the |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1177 buffer's visited file is maintained with version control, and, if so, |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1178 which kind. Its value is @code{nil} for no version control, or a string |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1179 that appears in the mode line. |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1180 @end defvar |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1181 |
6451 | 1182 @node %-Constructs |
1183 @subsection @code{%}-Constructs in the Mode Line | |
1184 | |
1185 The following table lists the recognized @code{%}-constructs and what | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1186 they mean. In any construct except @samp{%%}, you can add a decimal |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1187 integer after the @samp{%} to specify how many characters to display. |
6451 | 1188 |
1189 @table @code | |
1190 @item %b | |
1191 The current buffer name, obtained with the @code{buffer-name} function. | |
1192 @xref{Buffer Names}. | |
1193 | |
1194 @item %f | |
1195 The visited file name, obtained with the @code{buffer-file-name} | |
1196 function. @xref{Buffer File Name}. | |
1197 | |
12067 | 1198 @item %F |
1199 The name of the selected frame. | |
1200 | |
1201 @item %c | |
1202 The current column number of point. | |
1203 | |
1204 @item %l | |
1205 The current line number of point. | |
1206 | |
6451 | 1207 @item %* |
1208 @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1209 @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* | |
1210 @samp{-} otherwise. @xref{Buffer Modification}. | |
1211 | |
1212 @item %+ | |
12067 | 1213 @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* |
1214 @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1215 @samp{-} otherwise. This differs from @samp{%*} only for a modified | |
1216 read-only buffer. @xref{Buffer Modification}. | |
1217 | |
1218 @item %& | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1219 @samp{*} if the buffer is modified, and @samp{-} otherwise. |
6451 | 1220 |
1221 @item %s | |
1222 The status of the subprocess belonging to the current buffer, obtained with | |
1223 @code{process-status}. @xref{Process Information}. | |
1224 | |
12067 | 1225 @item %t |
1226 Whether the visited file is a text file or a binary file. (This is a | |
1227 meaningful distinction only on certain operating systems.) | |
1228 | |
6451 | 1229 @item %p |
12067 | 1230 The percentage of the buffer text above the @strong{top} of window, or |
6451 | 1231 @samp{Top}, @samp{Bottom} or @samp{All}. |
1232 | |
1233 @item %P | |
1234 The percentage of the buffer text that is above the @strong{bottom} of | |
1235 the window (which includes the text visible in the window, as well as | |
1236 the text above the top), plus @samp{Top} if the top of the buffer is | |
1237 visible on screen; or @samp{Bottom} or @samp{All}. | |
1238 | |
1239 @item %n | |
1240 @samp{Narrow} when narrowing is in effect; nothing otherwise (see | |
1241 @code{narrow-to-region} in @ref{Narrowing}). | |
1242 | |
1243 @item %[ | |
1244 An indication of the depth of recursive editing levels (not counting | |
1245 minibuffer levels): one @samp{[} for each editing level. | |
1246 @xref{Recursive Editing}. | |
1247 | |
1248 @item %] | |
1249 One @samp{]} for each recursive editing level (not counting minibuffer | |
1250 levels). | |
1251 | |
1252 @item %% | |
1253 The character @samp{%}---this is how to include a literal @samp{%} in a | |
1254 string in which @code{%}-constructs are allowed. | |
1255 | |
1256 @item %- | |
1257 Dashes sufficient to fill the remainder of the mode line. | |
1258 @end table | |
1259 | |
1260 The following two @code{%}-constructs are still supported, but they are | |
1261 obsolete, since you can get the same results with the variables | |
1262 @code{mode-name} and @code{global-mode-string}. | |
1263 | |
1264 @table @code | |
1265 @item %m | |
1266 The value of @code{mode-name}. | |
1267 | |
1268 @item %M | |
1269 The value of @code{global-mode-string}. Currently, only | |
1270 @code{display-time} modifies the value of @code{global-mode-string}. | |
1271 @end table | |
1272 | |
1273 @node Hooks | |
1274 @section Hooks | |
1275 @cindex hooks | |
1276 | |
1277 A @dfn{hook} is a variable where you can store a function or functions | |
1278 to be called on a particular occasion by an existing program. Emacs | |
1279 provides hooks for the sake of customization. Most often, hooks are set | |
1280 up in the @file{.emacs} file, but Lisp programs can set them also. | |
1281 @xref{Standard Hooks}, for a list of standard hook variables. | |
1282 | |
1283 Most of the hooks in Emacs are @dfn{normal hooks}. These variables | |
16056
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1284 contain lists of functions to be called with no arguments. When the |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1285 hook name ends in @samp{-hook}, that tells you it is normal. We try to |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1286 make all hooks normal, as much as possible, so that you can use them in |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1287 a uniform way. |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1288 |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1289 Every major mode function is supposed to run a normal hook called the |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1290 @dfn{mode hook} as the last step of initialization. This makes it easy |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1291 for a user to customize the behavior of the mode, by overriding the |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1292 local variable assignments already made by the mode. But hooks are used |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1293 in other contexts too. For example, the hook @code{suspend-hook} runs |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1294 just before Emacs suspends itself (@pxref{Suspending Emacs}). |
6451 | 1295 |
1296 The recommended way to add a hook function to a normal hook is by | |
1297 calling @code{add-hook} (see below). The hook functions may be any of | |
1298 the valid kinds of functions that @code{funcall} accepts (@pxref{What Is | |
1299 a Function}). Most normal hook variables are initially void; | |
1300 @code{add-hook} knows how to deal with this. | |
1301 | |
16056
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1302 If the hook variable's name does not end with @samp{-hook}, that |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1303 indicates it is probably an abnormal hook; you should look at its |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1304 documentation to see how to use the hook properly. |
6451 | 1305 |
16056
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1306 If the variable's name ends in @samp{-functions} or @samp{-hooks}, |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1307 then the value is a list of functions, but it is abnormal in that either |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1308 these functions are called with arguments or their values are used in |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1309 some way. You can use @code{add-hook} to add a function to the list, |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1310 but you must take care in writing the function. (A few of these |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1311 variables are actually normal hooks which were named before we |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1312 established the convention of using @samp{-hook} for them.) |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1313 |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1314 If the variable's name ends in @samp{-function}, then its value |
bfe1d6597f08
Explain better about abnormal hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12888
diff
changeset
|
1315 is just a single function, not a list of functions. |
6451 | 1316 |
12098 | 1317 Here's an expression that uses a mode hook to turn on Auto Fill mode |
1318 when in Lisp Interaction mode: | |
6451 | 1319 |
1320 @example | |
1321 (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) | |
1322 @end example | |
1323 | |
1324 The next example shows how to use a hook to customize the way Emacs | |
1325 formats C code. (People often have strong personal preferences for one | |
1326 format or another.) Here the hook function is an anonymous lambda | |
1327 expression. | |
1328 | |
1329 @cindex lambda expression in hook | |
1330 @example | |
1331 @group | |
1332 (add-hook 'c-mode-hook | |
1333 (function (lambda () | |
1334 (setq c-indent-level 4 | |
1335 c-argdecl-indent 0 | |
1336 c-label-offset -4 | |
1337 @end group | |
1338 @group | |
1339 c-continued-statement-indent 0 | |
1340 c-brace-offset 0 | |
1341 comment-column 40)))) | |
1342 | |
1343 (setq c++-mode-hook c-mode-hook) | |
1344 @end group | |
1345 @end example | |
1346 | |
1347 At the appropriate time, Emacs uses the @code{run-hooks} function to | |
12098 | 1348 run particular hooks. This function calls the hook functions that have |
1349 been added with @code{add-hook}. | |
6451 | 1350 |
1351 @defun run-hooks &rest hookvar | |
1352 This function takes one or more hook variable names as arguments, and | |
1353 runs each hook in turn. Each @var{hookvar} argument should be a symbol | |
1354 that is a hook variable. These arguments are processed in the order | |
1355 specified. | |
1356 | |
1357 If a hook variable has a non-@code{nil} value, that value may be a | |
1358 function or a list of functions. If the value is a function (either a | |
1359 lambda expression or a symbol with a function definition), it is | |
1360 called. If it is a list, the elements are called, in order. | |
1361 The hook functions are called with no arguments. | |
1362 | |
12098 | 1363 For example, here's how @code{emacs-lisp-mode} runs its mode hook: |
6451 | 1364 |
1365 @example | |
1366 (run-hooks 'emacs-lisp-mode-hook) | |
1367 @end example | |
1368 @end defun | |
1369 | |
12067 | 1370 @defun add-hook hook function &optional append local |
6451 | 1371 This function is the handy way to add function @var{function} to hook |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1372 variable @var{hook}. The argument @var{function} may be any valid Lisp |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1373 function with the proper number of arguments. For example, |
6451 | 1374 |
1375 @example | |
1376 (add-hook 'text-mode-hook 'my-text-hook-function) | |
1377 @end example | |
1378 | |
1379 @noindent | |
1380 adds @code{my-text-hook-function} to the hook called @code{text-mode-hook}. | |
1381 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1382 You can use @code{add-hook} for abnormal hooks as well as for normal |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1383 hooks. |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1384 |
6451 | 1385 It is best to design your hook functions so that the order in which they |
1386 are executed does not matter. Any dependence on the order is ``asking | |
1387 for trouble.'' However, the order is predictable: normally, | |
1388 @var{function} goes at the front of the hook list, so it will be | |
1389 executed first (barring another @code{add-hook} call). | |
1390 | |
1391 If the optional argument @var{append} is non-@code{nil}, the new hook | |
1392 function goes at the end of the hook list and will be executed last. | |
1393 | |
12067 | 1394 If @var{local} is non-@code{nil}, that says to make the new hook |
1395 function local to the current buffer. Before you can do this, you must | |
1396 make the hook itself buffer-local by calling @code{make-local-hook} | |
1397 (@strong{not} @code{make-local-variable}). If the hook itself is not | |
1398 buffer-local, then the value of @var{local} makes no difference---the | |
1399 hook function is always global. | |
6451 | 1400 @end defun |
8929
d7dc9a5b8c70
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8505
diff
changeset
|
1401 |
12067 | 1402 @defun remove-hook hook function &optional local |
1403 This function removes @var{function} from the hook variable @var{hook}. | |
1404 | |
1405 If @var{local} is non-@code{nil}, that says to remove @var{function} | |
1406 from the local hook list instead of from the global hook list. If the | |
1407 hook itself is not buffer-local, then the value of @var{local} makes no | |
1408 difference. | |
1409 @end defun | |
8929
d7dc9a5b8c70
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8505
diff
changeset
|
1410 |
12067 | 1411 @defun make-local-hook hook |
1412 This function makes the hook variable @code{hook} local to the current | |
1413 buffer. When a hook variable is local, it can have local and global | |
1414 hook functions, and @code{run-hooks} runs all of them. | |
8929
d7dc9a5b8c70
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8505
diff
changeset
|
1415 |
12234
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1416 This function works by making @code{t} an element of the buffer-local |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1417 value. That serves as a flag to use the hook functions in the default |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1418 value of the hook variable as well as those in the local value. Since |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1419 @code{run-hooks} understands this flag, @code{make-local-hook} works |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1420 with all normal hooks. It works for only some non-normal hooks---those |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1421 whose callers have been updated to understand this meaning of @code{t}. |
2de6f5e4858d
Explain how make-local-hook works.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1422 |
12067 | 1423 Do not use @code{make-local-variable} directly for hook variables; it is |
1424 not sufficient. | |
1425 @end defun |