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