Mercurial > emacs
annotate lispref/modes.texi @ 71920:f9d6b4067f37
Fix in `tumme-get-comment'.
author | Mathias Dahl <mathias.dahl@gmail.com> |
---|---|
date | Sun, 16 Jul 2006 08:14:01 +0000 |
parents | ce0ef9a0bb1f |
children | 6bc43bba870c |
rev | line source |
---|---|
6451 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
64889
e836425ee789
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64874
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002, |
68648
067115a6e738
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68084
diff
changeset
|
4 @c 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
6451 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/modes | |
52197
a0b65ecec014
*** empty log message ***
John Paul Wallington <jpw@pobox.com>
parents:
52195
diff
changeset
|
7 @node Modes, Documentation, Keymaps, Top |
6451 | 8 @chapter Major and Minor Modes |
9 @cindex mode | |
10 | |
11 A @dfn{mode} is a set of definitions that customize Emacs and can be | |
12 turned on and off while you edit. There are two varieties of modes: | |
13 @dfn{major modes}, which are mutually exclusive and used for editing | |
14 particular kinds of text, and @dfn{minor modes}, which provide features | |
15 that users can enable individually. | |
16 | |
17 This chapter describes how to write both major and minor modes, how to | |
18 indicate them in the mode line, and how they run hooks supplied by the | |
19 user. For related topics such as keymaps and syntax tables, see | |
20 @ref{Keymaps}, and @ref{Syntax Tables}. | |
21 | |
22 @menu | |
62345 | 23 * Hooks:: How to use hooks; how to write code that provides hooks. |
6451 | 24 * Major Modes:: Defining major modes. |
25 * Minor Modes:: Defining minor modes. | |
26 * 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
|
27 * Imenu:: How a mode can provide a menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
28 of definitions in the buffer. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
29 * Font Lock Mode:: How modes can highlight text according to syntax. |
55414 | 30 * Desktop Save Mode:: How modes can have buffer state saved between |
31 Emacs sessions. | |
6451 | 32 @end menu |
33 | |
62345 | 34 @node Hooks |
35 @section Hooks | |
36 @cindex hooks | |
37 | |
38 A @dfn{hook} is a variable where you can store a function or functions | |
39 to be called on a particular occasion by an existing program. Emacs | |
40 provides hooks for the sake of customization. Most often, hooks are set | |
41 up in the init file (@pxref{Init File}), but Lisp programs can set them also. | |
42 @xref{Standard Hooks}, for a list of standard hook variables. | |
43 | |
44 @cindex normal hook | |
45 Most of the hooks in Emacs are @dfn{normal hooks}. These variables | |
46 contain lists of functions to be called with no arguments. When the | |
47 hook name ends in @samp{-hook}, that tells you it is normal. We try to | |
48 make all hooks normal, as much as possible, so that you can use them in | |
49 a uniform way. | |
50 | |
51 Every major mode function is supposed to run a normal hook called the | |
52 @dfn{mode hook} as the last step of initialization. This makes it easy | |
53 for a user to customize the behavior of the mode, by overriding the | |
54 buffer-local variable assignments already made by the mode. Most | |
55 minor modes also run a mode hook at their end. But hooks are used in | |
56 other contexts too. For example, the hook @code{suspend-hook} runs | |
57 just before Emacs suspends itself (@pxref{Suspending Emacs}). | |
58 | |
59 The recommended way to add a hook function to a normal hook is by | |
60 calling @code{add-hook} (see below). The hook functions may be any of | |
61 the valid kinds of functions that @code{funcall} accepts (@pxref{What | |
62 Is a Function}). Most normal hook variables are initially void; | |
63 @code{add-hook} knows how to deal with this. You can add hooks either | |
64 globally or buffer-locally with @code{add-hook}. | |
65 | |
66 @cindex abnormal hook | |
67 If the hook variable's name does not end with @samp{-hook}, that | |
68 indicates it is probably an @dfn{abnormal hook}. Then you should look at its | |
69 documentation to see how to use the hook properly. | |
70 | |
71 If the variable's name ends in @samp{-functions} or @samp{-hooks}, | |
72 then the value is a list of functions, but it is abnormal in that either | |
73 these functions are called with arguments or their values are used in | |
74 some way. You can use @code{add-hook} to add a function to the list, | |
75 but you must take care in writing the function. (A few of these | |
76 variables, notably those ending in @samp{-hooks}, are actually | |
77 normal hooks which were named before we established the convention of | |
78 using @samp{-hook} for them.) | |
79 | |
80 If the variable's name ends in @samp{-function}, then its value | |
81 is just a single function, not a list of functions. | |
82 | |
83 Here's an example that uses a mode hook to turn on Auto Fill mode when | |
84 in Lisp Interaction mode: | |
85 | |
86 @example | |
87 (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) | |
88 @end example | |
89 | |
90 At the appropriate time, Emacs uses the @code{run-hooks} function to | |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
91 run particular hooks. |
62345 | 92 |
93 @defun run-hooks &rest hookvars | |
94 This function takes one or more normal hook variable names as | |
95 arguments, and runs each hook in turn. Each argument should be a | |
96 symbol that is a normal hook variable. These arguments are processed | |
97 in the order specified. | |
98 | |
99 If a hook variable has a non-@code{nil} value, that value may be a | |
100 function or a list of functions. (The former option is considered | |
101 obsolete.) If the value is a function (either a lambda expression or | |
102 a symbol with a function definition), it is called. If it is a list | |
103 that isn't a function, its elements are called, consecutively. All | |
104 the hook functions are called with no arguments. | |
105 @end defun | |
106 | |
107 @defun run-hook-with-args hook &rest args | |
108 This function is the way to run an abnormal hook and always call all | |
109 of the hook functions. It calls each of the hook functions one by | |
110 one, passing each of them the arguments @var{args}. | |
111 @end defun | |
112 | |
113 @defun run-hook-with-args-until-failure hook &rest args | |
114 This function is the way to run an abnormal hook until one of the hook | |
115 functions fails. It calls each of the hook functions, passing each of | |
116 them the arguments @var{args}, until some hook function returns | |
117 @code{nil}. It then stops and returns @code{nil}. If none of the | |
118 hook functions return @code{nil}, it returns a non-@code{nil} value. | |
119 @end defun | |
120 | |
121 @defun run-hook-with-args-until-success hook &rest args | |
122 This function is the way to run an abnormal hook until a hook function | |
123 succeeds. It calls each of the hook functions, passing each of them | |
124 the arguments @var{args}, until some hook function returns | |
125 non-@code{nil}. Then it stops, and returns whatever was returned by | |
126 the last hook function that was called. If all hook functions return | |
127 @code{nil}, it returns @code{nil} as well. | |
128 @end defun | |
129 | |
130 @defun add-hook hook function &optional append local | |
131 This function is the handy way to add function @var{function} to hook | |
132 variable @var{hook}. You can use it for abnormal hooks as well as for | |
133 normal hooks. @var{function} can be any Lisp function that can accept | |
134 the proper number of arguments for @var{hook}. For example, | |
135 | |
136 @example | |
137 (add-hook 'text-mode-hook 'my-text-hook-function) | |
138 @end example | |
139 | |
140 @noindent | |
141 adds @code{my-text-hook-function} to the hook called @code{text-mode-hook}. | |
142 | |
143 If @var{function} is already present in @var{hook} (comparing using | |
144 @code{equal}), then @code{add-hook} does not add it a second time. | |
145 | |
146 It is best to design your hook functions so that the order in which they | |
147 are executed does not matter. Any dependence on the order is ``asking | |
148 for trouble''. However, the order is predictable: normally, | |
149 @var{function} goes at the front of the hook list, so it will be | |
150 executed first (barring another @code{add-hook} call). If the optional | |
151 argument @var{append} is non-@code{nil}, the new hook function goes at | |
152 the end of the hook list and will be executed last. | |
153 | |
154 @code{add-hook} can handle the cases where @var{hook} is void or its | |
155 value is a single function; it sets or changes the value to a list of | |
156 functions. | |
157 | |
158 If @var{local} is non-@code{nil}, that says to add @var{function} to | |
159 the buffer-local hook list instead of to the global hook list. If | |
160 needed, this makes the hook buffer-local and adds @code{t} to the | |
161 buffer-local value. The latter acts as a flag to run the hook | |
162 functions in the default value as well as in the local value. | |
163 @end defun | |
164 | |
165 @defun remove-hook hook function &optional local | |
166 This function removes @var{function} from the hook variable | |
167 @var{hook}. It compares @var{function} with elements of @var{hook} | |
168 using @code{equal}, so it works for both symbols and lambda | |
169 expressions. | |
170 | |
171 If @var{local} is non-@code{nil}, that says to remove @var{function} | |
172 from the buffer-local hook list instead of from the global hook list. | |
173 @end defun | |
174 | |
6451 | 175 @node Major Modes |
176 @section Major Modes | |
177 @cindex major mode | |
178 | |
179 Major modes specialize Emacs for editing particular kinds of text. | |
43677
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
180 Each buffer has only one major mode at a time. For each major mode |
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
181 there is a function to switch to that mode in the current buffer; its |
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
182 name should end in @samp{-mode}. These functions work by setting |
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
183 buffer-local variable bindings and other data associated with the |
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
184 buffer, such as a local keymap. The effect lasts until you switch |
8d02880abeaa
(Major Modes): Explain major mode functions, how they work, and how
Richard M. Stallman <rms@gnu.org>
parents:
43264
diff
changeset
|
185 to another major mode in the same buffer. |
6451 | 186 |
62345 | 187 @menu |
188 * Major Mode Basics:: | |
189 * Major Mode Conventions:: Coding conventions for keymaps, etc. | |
190 * Example Major Modes:: Text mode and Lisp modes. | |
191 * Auto Major Mode:: How Emacs chooses the major mode automatically. | |
192 * Mode Help:: Finding out how to use a mode. | |
193 * Derived Modes:: Defining a new major mode based on another major | |
194 mode. | |
195 * Generic Modes:: Defining a simple major mode that supports | |
196 comment syntax and Font Lock mode. | |
197 * Mode Hooks:: Hooks run at the end of major mode functions. | |
198 @end menu | |
199 | |
200 @node Major Mode Basics | |
201 @subsection Major Mode Basics | |
202 @cindex Fundamental mode | |
203 | |
6451 | 204 The least specialized major mode is called @dfn{Fundamental mode}. |
205 This mode has no mode-specific definitions or variable settings, so each | |
206 Emacs command behaves in its default manner, and each option is in its | |
207 default state. All other major modes redefine various keys and options. | |
208 For example, Lisp Interaction mode provides special key bindings for | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
209 @kbd{C-j} (@code{eval-print-last-sexp}), @key{TAB} |
6451 | 210 (@code{lisp-indent-line}), and other keys. |
211 | |
212 When you need to write several editing commands to help you perform a | |
213 specialized editing task, creating a new major mode is usually a good | |
214 idea. In practice, writing a major mode is easy (in contrast to | |
215 writing a minor mode, which is often difficult). | |
216 | |
217 If the new mode is similar to an old one, it is often unwise to modify | |
218 the old one to serve two purposes, since it may become harder to use and | |
219 maintain. Instead, copy and rename an existing major mode definition | |
220 and alter the copy---or define a @dfn{derived mode} (@pxref{Derived | |
221 Modes}). For example, Rmail Edit mode, which is in | |
25875 | 222 @file{emacs/lisp/mail/rmailedit.el}, is a major mode that is very similar to |
223 Text mode except that it provides two additional commands. Its | |
224 definition is distinct from that of Text mode, but uses that of Text mode. | |
6451 | 225 |
28603
cb9db16dba12
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27390
diff
changeset
|
226 Even if the new mode is not an obvious derivative of any other mode, |
39793
1d5b7d31671f
Recommend the use of define-derived-mode (and nil argument).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38200
diff
changeset
|
227 it is convenient to use @code{define-derived-mode} with a @code{nil} |
1d5b7d31671f
Recommend the use of define-derived-mode (and nil argument).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38200
diff
changeset
|
228 parent argument, since it automatically enforces the most important |
1d5b7d31671f
Recommend the use of define-derived-mode (and nil argument).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38200
diff
changeset
|
229 coding conventions for you. |
28603
cb9db16dba12
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27390
diff
changeset
|
230 |
46914
56bbdfd75143
Mention define-generic-mode.
Richard M. Stallman <rms@gnu.org>
parents:
45714
diff
changeset
|
231 For a very simple programming language major mode that handles |
62259 | 232 comments and fontification, you can use @code{define-generic-mode}. |
233 @xref{Generic Modes}. | |
46914
56bbdfd75143
Mention define-generic-mode.
Richard M. Stallman <rms@gnu.org>
parents:
45714
diff
changeset
|
234 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
235 Rmail Edit mode offers an example of changing the major mode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
236 temporarily for a buffer, so it can be edited in a different way (with |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
237 ordinary Emacs commands rather than Rmail commands). In such cases, the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
238 temporary major mode usually provides a command to switch back to the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
239 buffer's usual mode (Rmail mode, in this case). You might be tempted to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
240 present the temporary redefinitions inside a recursive edit and restore |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
241 the usual ones when the user exits; but this is a bad idea because it |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
242 constrains the user's options when it is done in more than one buffer: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
243 recursive edits must be exited most-recently-entered first. Using an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
244 alternative major mode avoids this limitation. @xref{Recursive |
6451 | 245 Editing}. |
246 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
247 The standard GNU Emacs Lisp library directory tree contains the code |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
248 for several major modes, in files such as @file{text-mode.el}, |
6451 | 249 @file{texinfo.el}, @file{lisp-mode.el}, @file{c-mode.el}, and |
25875 | 250 @file{rmail.el}. They are found in various subdirectories of the |
251 @file{lisp} directory. You can study these libraries to see how modes | |
252 are written. Text mode is perhaps the simplest major mode aside from | |
6451 | 253 Fundamental mode. Rmail mode is a complicated and specialized mode. |
254 | |
255 @node Major Mode Conventions | |
256 @subsection Major Mode Conventions | |
257 | |
258 The code for existing major modes follows various coding conventions, | |
259 including conventions for local keymap and syntax table initialization, | |
260 global names, and hooks. Please follow these conventions when you | |
38200
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
261 define a new major mode. |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
262 |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
263 This list of conventions is only partial, because each major mode |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
264 should aim for consistency in general with other Emacs major modes. |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
265 This makes Emacs as a whole more coherent. It is impossible to list |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
266 here all the possible points where this issue might come up; if the |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
267 Emacs developers point out an area where your major mode deviates from |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
268 the usual conventions, please make it compatible. |
6451 | 269 |
270 @itemize @bullet | |
271 @item | |
272 Define a command whose name ends in @samp{-mode}, with no arguments, | |
273 that switches to the new mode in the current buffer. This command | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
274 should set up the keymap, syntax table, and buffer-local variables in an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
275 existing buffer, without changing the buffer's contents. |
6451 | 276 |
277 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
278 Write a documentation string for this command that describes the |
6451 | 279 special commands available in this mode. @kbd{C-h m} |
280 (@code{describe-mode}) in your mode will display this string. | |
281 | |
282 The documentation string may include the special documentation | |
283 substrings, @samp{\[@var{command}]}, @samp{\@{@var{keymap}@}}, and | |
24934 | 284 @samp{\<@var{keymap}>}, which enable the documentation to adapt |
6451 | 285 automatically to the user's own key bindings. @xref{Keys in |
286 Documentation}. | |
287 | |
288 @item | |
289 The major mode command should start by calling | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
290 @code{kill-all-local-variables}. This is what gets rid of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
291 buffer-local variables of the major mode previously in effect. |
6451 | 292 |
293 @item | |
294 The major mode command should set the variable @code{major-mode} to the | |
295 major mode command symbol. This is how @code{describe-mode} discovers | |
296 which documentation to print. | |
297 | |
298 @item | |
299 The major mode command should set the variable @code{mode-name} to the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
300 ``pretty'' name of the mode, as a string. This string appears in the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
301 mode line. |
6451 | 302 |
303 @item | |
304 @cindex functions in modes | |
305 Since all global names are in the same name space, all the global | |
306 variables, constants, and functions that are part of the mode should | |
307 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
|
308 of it if the name is long). @xref{Coding Conventions}. |
6451 | 309 |
310 @item | |
38200
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
311 In a major mode for editing some kind of structured text, such as a |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
312 programming language, indentation of text according to structure is |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
313 probably useful. So the mode should set @code{indent-line-function} |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
314 to a suitable function, and probably customize other variables |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
315 for indentation. |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
316 |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
317 @item |
6451 | 318 @cindex keymaps in modes |
319 The major mode should usually have its own keymap, which is used as the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
320 local keymap in all buffers in that mode. The major mode command should |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
321 call @code{use-local-map} to install this local map. @xref{Active |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
322 Keymaps}, for more information. |
6451 | 323 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
324 This keymap should be stored permanently in a global variable named |
6451 | 325 @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
|
326 mode sets this variable. |
6451 | 327 |
12803
6dcd5ad16790
Make Major Mode Conventions xref to Tips for Defining.
Richard M. Stallman <rms@gnu.org>
parents:
12234
diff
changeset
|
328 @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
|
329 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
|
330 |
6451 | 331 @item |
17278
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
332 The key sequences bound in a major mode keymap should usually start with |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
333 @kbd{C-c}, followed by a control character, a digit, or @kbd{@{}, |
17278
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
334 @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
|
335 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
|
336 reserved for users. |
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
337 |
56768
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
338 A major mode can also rebind the keys @kbd{M-n}, @kbd{M-p} and |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
339 @kbd{M-s}. The bindings for @kbd{M-n} and @kbd{M-p} should normally |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
340 be some kind of ``moving forward and backward,'' but this does not |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
341 necessarily mean cursor motion. |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
342 |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
343 It is legitimate for a major mode to rebind a standard key sequence if |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
344 it provides a command that does ``the same job'' in a way better |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
345 suited to the text this mode is used for. For example, a major mode |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
346 for editing a programming language might redefine @kbd{C-M-a} to |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
347 ``move to the beginning of a function'' in a way that works better for |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
348 that language. |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
349 |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
350 It is also legitimate for a major mode to rebind a standard key |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
351 sequence whose standard meaning is rarely useful in that mode. For |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
352 instance, minibuffer modes rebind @kbd{M-r}, whose standard meaning is |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
353 rarely of any use in the minibuffer. Major modes such as Dired or |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
354 Rmail that do not allow self-insertion of text can reasonably redefine |
560751ade8e5
(Major Mode Conventions): Discuss rebinding of standard key bindings.
Richard M. Stallman <rms@gnu.org>
parents:
55831
diff
changeset
|
355 letters and other printing characters as special commands. |
17278
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
356 |
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
357 @item |
38161
45d64a431eea
(Major Mode Conventions): Major modes should not change RET.
Richard M. Stallman <rms@gnu.org>
parents:
36347
diff
changeset
|
358 Major modes must not define @key{RET} to do anything other than insert |
45d64a431eea
(Major Mode Conventions): Major modes should not change RET.
Richard M. Stallman <rms@gnu.org>
parents:
36347
diff
changeset
|
359 a newline. The command to insert a newline and then indent is |
38200
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
360 @kbd{C-j}. Please keep this distinction uniform for all major modes. |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
361 |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
362 @item |
54041 | 363 Major modes should not alter options that are primarily a matter of user |
38200
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
364 preference, such as whether Auto-Fill mode is enabled. Leave this to |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
365 each user to decide. However, a major mode should customize other |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
366 variables so that Auto-Fill mode will work usefully @emph{if} the user |
6c286c714f74
(Major Mode Conventions): Say not to change meaning of RET, and not to
Richard M. Stallman <rms@gnu.org>
parents:
38161
diff
changeset
|
367 decides to use it. |
38161
45d64a431eea
(Major Mode Conventions): Major modes should not change RET.
Richard M. Stallman <rms@gnu.org>
parents:
36347
diff
changeset
|
368 |
45d64a431eea
(Major Mode Conventions): Major modes should not change RET.
Richard M. Stallman <rms@gnu.org>
parents:
36347
diff
changeset
|
369 @item |
6451 | 370 @cindex syntax tables in modes |
371 The mode may have its own syntax table or may share one with other | |
372 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
|
373 a variable named @code{@var{modename}-mode-syntax-table}. @xref{Syntax |
6451 | 374 Tables}. |
375 | |
376 @item | |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
377 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
|
378 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
|
379 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
|
380 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
381 @item |
6451 | 382 @cindex abbrev tables in modes |
383 The mode may have its own abbrev table or may share one with other | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
384 related modes. If it has its own abbrev table, it should store this |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
385 in a variable named @code{@var{modename}-mode-abbrev-table}. If the |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
386 major mode command defines any abbrevs itself, it should pass @code{t} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
387 for the @var{system-flag} argument to @code{define-abbrev}. |
62345 | 388 @xref{Defining Abbrevs}. |
6451 | 389 |
390 @item | |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
391 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
|
392 setting up a buffer-local value for the variable |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
393 @code{font-lock-defaults} (@pxref{Font Lock Mode}). |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
394 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
395 @item |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
396 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
|
397 sections of a buffer, by setting up a buffer-local value for the |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63133
diff
changeset
|
398 variable @code{imenu-generic-expression}, for the two variables |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
399 @code{imenu-prev-index-position-function} and |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
400 @code{imenu-extract-index-name-function}, or for the variable |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
401 @code{imenu-create-index-function} (@pxref{Imenu}). |
16432
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
402 |
6f58503776e5
Explain what major modes can do for imenu and font-lock.
Richard M. Stallman <rms@gnu.org>
parents:
16056
diff
changeset
|
403 @item |
61853
7f8f03acf7fe
(Major Mode Conventions): Explain customizing ElDoc mode.
Richard M. Stallman <rms@gnu.org>
parents:
61678
diff
changeset
|
404 The mode can specify a local value for |
7f8f03acf7fe
(Major Mode Conventions): Explain customizing ElDoc mode.
Richard M. Stallman <rms@gnu.org>
parents:
61678
diff
changeset
|
405 @code{eldoc-documentation-function} to tell ElDoc mode how to handle |
7f8f03acf7fe
(Major Mode Conventions): Explain customizing ElDoc mode.
Richard M. Stallman <rms@gnu.org>
parents:
61678
diff
changeset
|
406 this mode. |
7f8f03acf7fe
(Major Mode Conventions): Explain customizing ElDoc mode.
Richard M. Stallman <rms@gnu.org>
parents:
61678
diff
changeset
|
407 |
7f8f03acf7fe
(Major Mode Conventions): Explain customizing ElDoc mode.
Richard M. Stallman <rms@gnu.org>
parents:
61678
diff
changeset
|
408 @item |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
409 Use @code{defvar} or @code{defcustom} to set mode-related variables, so |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
410 that they are not reinitialized if they already have a value. (Such |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
411 reinitialization could discard customizations made by the user.) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
412 |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
413 @item |
6451 | 414 @cindex buffer-local variables in modes |
415 To make a buffer-local binding for an Emacs customization variable, use | |
416 @code{make-local-variable} in the major mode command, not | |
417 @code{make-variable-buffer-local}. The latter function would make the | |
418 variable local to every buffer in which it is subsequently set, which | |
419 would affect buffers that do not use this mode. It is undesirable for a | |
420 mode to have such global effects. @xref{Buffer-Local Variables}. | |
421 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
422 With rare exceptions, the only reasonable way to use |
25875 | 423 @code{make-variable-buffer-local} in a Lisp package is for a variable |
424 which is used only within that package. Using it on a variable used by | |
425 other packages would interfere with them. | |
6451 | 426 |
427 @item | |
428 @cindex mode hook | |
429 @cindex major mode hook | |
430 Each major mode should have a @dfn{mode hook} named | |
431 @code{@var{modename}-mode-hook}. The major mode command should run that | |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
432 hook, with @code{run-mode-hooks}, as the very last thing it |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
433 does. @xref{Mode Hooks}. |
6451 | 434 |
435 @item | |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
436 The major mode command may start by calling some other major mode |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
437 command (called the @dfn{parent mode}) and then alter some of its |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
438 settings. A mode that does this is called a @dfn{derived mode}. The |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
439 recommended way to define one is to use @code{define-derived-mode}, |
62872
f13e9e778c14
(Major Mode Conventions): A derived mode only needs to put the call to
Luc Teirlinck <teirllm@auburn.edu>
parents:
62857
diff
changeset
|
440 but this is not required. Such a mode should call the parent mode |
f13e9e778c14
(Major Mode Conventions): A derived mode only needs to put the call to
Luc Teirlinck <teirllm@auburn.edu>
parents:
62857
diff
changeset
|
441 command inside a @code{delay-mode-hooks} form. (Using |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
442 @code{define-derived-mode} does this automatically.) @xref{Derived |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
443 Modes}, and @ref{Mode Hooks}. |
6451 | 444 |
445 @item | |
446 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
|
447 this mode to any other major mode, this mode can set up a buffer-local |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
448 value for @code{change-major-mode-hook} (@pxref{Creating Buffer-Local}). |
6451 | 449 |
450 @item | |
451 If this mode is appropriate only for specially-prepared text, then the | |
452 major mode command symbol should have a property named @code{mode-class} | |
453 with value @code{special}, put on as follows: | |
454 | |
51021
59fa0bb3f282
Index mode-class using @kindex.
Richard M. Stallman <rms@gnu.org>
parents:
50693
diff
changeset
|
455 @kindex mode-class @r{(property)} |
6451 | 456 @cindex @code{special} |
457 @example | |
458 (put 'funny-mode 'mode-class 'special) | |
459 @end example | |
460 | |
461 @noindent | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
462 This tells Emacs that new buffers created while the current buffer is |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
463 in Funny mode should not inherit Funny mode, in case |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
464 @code{default-major-mode} is @code{nil}. Modes such as Dired, Rmail, |
6451 | 465 and Buffer List use this feature. |
466 | |
467 @item | |
468 If you want to make the new mode the default for files with certain | |
469 recognizable names, add an element to @code{auto-mode-alist} to select | |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
470 the mode for those file names (@pxref{Auto Major Mode}). If you |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
471 define the mode command to autoload, you should add this element in |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
472 the same file that calls @code{autoload}. If you use an autoload |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
473 cookie for the mode command, you can also use an autoload cookie for |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
474 the form that adds the element (@pxref{autoload cookie}). If you do |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
475 not autoload the mode command, it is sufficient to add the element in |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
476 the file that contains the mode definition. |
6451 | 477 |
478 @item | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
479 In the comments that document the file, you should provide a sample |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
480 @code{autoload} form and an example of how to add to |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
481 @code{auto-mode-alist}, that users can include in their init files |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
482 (@pxref{Init File}). |
6451 | 483 |
484 @item | |
485 @cindex mode loading | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
486 The top-level forms in the file defining the mode should be written so |
6451 | 487 that they may be evaluated more than once without adverse consequences. |
488 Even if you never load the file more than once, someone else will. | |
489 @end itemize | |
490 | |
491 @node Example Major Modes | |
492 @subsection Major Mode Examples | |
493 | |
494 Text mode is perhaps the simplest mode besides Fundamental mode. | |
495 Here are excerpts from @file{text-mode.el} that illustrate many of | |
496 the conventions listed above: | |
497 | |
498 @smallexample | |
499 @group | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
500 ;; @r{Create the syntax table for this mode.} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
501 (defvar text-mode-syntax-table |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
502 (let ((st (make-syntax-table))) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
503 (modify-syntax-entry ?\" ". " st) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
504 (modify-syntax-entry ?\\ ". " st) |
71638 | 505 ;; Add `p' so M-c on `hello' leads to `Hello', not `hello'. |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
506 (modify-syntax-entry ?' "w p" st) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
507 st) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
508 "Syntax table used while in `text-mode'.") |
6451 | 509 @end group |
510 | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
511 ;; @r{Create the keymap for this mode.} |
6451 | 512 @group |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
513 (defvar text-mode-map |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
514 (let ((map (make-sparse-keymap))) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
515 (define-key map "\e\t" 'ispell-complete-word) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
516 (define-key map "\es" 'center-line) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
517 (define-key map "\eS" 'center-paragraph) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
518 map) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
519 "Keymap for `text-mode'. |
71638 | 520 Many other modes, such as Mail mode, Outline mode |
521 and Indented Text mode, inherit all the commands | |
522 defined in this map.") | |
6451 | 523 @end group |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
524 @end smallexample |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
525 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
526 Here is how the actual mode command is defined now: |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
527 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
528 @smallexample |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
529 @group |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
530 (define-derived-mode text-mode nil "Text" |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
531 "Major mode for editing text written for humans to read. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
532 In this mode, paragraphs are delimited only by blank or white lines. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
533 You can thus get the full benefit of adaptive filling |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
534 (see the variable `adaptive-fill-mode'). |
59963
2bc848857427
(Example Major Modes): Fix typos.
Lute Kamstra <lute@gnu.org>
parents:
59942
diff
changeset
|
535 \\@{text-mode-map@} |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
536 Turning on Text mode runs the normal hook `text-mode-hook'." |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
537 @end group |
6451 | 538 @group |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
539 (make-local-variable 'text-mode-variant) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
540 (setq text-mode-variant t) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
541 ;; @r{These two lines are a feature added recently.} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
542 (set (make-local-variable 'require-final-newline) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
543 mode-require-final-newline) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
544 (set (make-local-variable 'indent-line-function) 'indent-relative)) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
545 @end group |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
546 @end smallexample |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
547 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
548 But here is how it was defined formerly, before |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
549 @code{define-derived-mode} existed: |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
550 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
551 @smallexample |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
552 @group |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
553 ;; @r{This isn't needed nowadays, since @code{define-derived-mode} does it.} |
6451 | 554 (defvar text-mode-abbrev-table nil |
555 "Abbrev table used while in text mode.") | |
556 (define-abbrev-table 'text-mode-abbrev-table ()) | |
557 @end group | |
558 | |
559 @group | |
560 (defun text-mode () | |
25950
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25875
diff
changeset
|
561 "Major mode for editing text intended for humans to read... |
6451 | 562 Special commands: \\@{text-mode-map@} |
563 @end group | |
564 @group | |
565 Turning on text-mode runs the hook `text-mode-hook'." | |
566 (interactive) | |
567 (kill-all-local-variables) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
568 (use-local-map text-mode-map) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
569 @end group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
570 @group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
571 (setq local-abbrev-table text-mode-abbrev-table) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
572 (set-syntax-table text-mode-syntax-table) |
6451 | 573 @end group |
574 @group | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
575 ;; @r{These four lines are absent from the current version} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
576 ;; @r{not because this is done some other way, but rather} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
577 ;; @r{because nowadays Text mode uses the normal definition of paragraphs.} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
578 (make-local-variable 'paragraph-start) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
579 (setq paragraph-start (concat "[ \t]*$\\|" page-delimiter)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
580 (make-local-variable 'paragraph-separate) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
581 (setq paragraph-separate paragraph-start) |
25875 | 582 (make-local-variable 'indent-line-function) |
583 (setq indent-line-function 'indent-relative-maybe) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
584 @end group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
585 @group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
586 (setq mode-name "Text") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
587 (setq major-mode 'text-mode) |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
588 (run-mode-hooks 'text-mode-hook)) ; @r{Finally, this permits the user to} |
6451 | 589 ; @r{customize the mode with a hook.} |
590 @end group | |
591 @end smallexample | |
592 | |
593 @cindex @file{lisp-mode.el} | |
594 The three Lisp modes (Lisp mode, Emacs Lisp mode, and Lisp | |
595 Interaction mode) have more features than Text mode and the code is | |
596 correspondingly more complicated. Here are excerpts from | |
597 @file{lisp-mode.el} that illustrate how these modes are written. | |
598 | |
599 @cindex syntax table example | |
600 @smallexample | |
601 @group | |
602 ;; @r{Create mode-specific table variables.} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
603 (defvar lisp-mode-syntax-table nil "") |
6451 | 604 (defvar lisp-mode-abbrev-table nil "") |
605 @end group | |
606 | |
607 @group | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
608 (defvar emacs-lisp-mode-syntax-table |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
609 (let ((table (make-syntax-table))) |
6451 | 610 (let ((i 0)) |
611 @end group | |
612 | |
613 @group | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
614 ;; @r{Set syntax of chars up to @samp{0} to say they are} |
6451 | 615 ;; @r{part of symbol names but not words.} |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
616 ;; @r{(The digit @samp{0} is @code{48} in the @acronym{ASCII} character set.)} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
617 (while (< i ?0) |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
618 (modify-syntax-entry i "_ " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
619 (setq i (1+ i))) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
620 ;; @r{@dots{} similar code follows for other character ranges.} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
621 @end group |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
622 @group |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
623 ;; @r{Then set the syntax codes for characters that are special in Lisp.} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
624 (modify-syntax-entry ? " " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
625 (modify-syntax-entry ?\t " " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
626 (modify-syntax-entry ?\f " " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
627 (modify-syntax-entry ?\n "> " table) |
6451 | 628 @end group |
629 @group | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
630 ;; @r{Give CR the same syntax as newline, for selective-display.} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
631 (modify-syntax-entry ?\^m "> " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
632 (modify-syntax-entry ?\; "< " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
633 (modify-syntax-entry ?` "' " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
634 (modify-syntax-entry ?' "' " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
635 (modify-syntax-entry ?, "' " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
636 @end group |
6451 | 637 @group |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
638 ;; @r{@dots{}likewise for many other characters@dots{}} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
639 (modify-syntax-entry ?\( "() " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
640 (modify-syntax-entry ?\) ")( " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
641 (modify-syntax-entry ?\[ "(] " table) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
642 (modify-syntax-entry ?\] ")[ " table)) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
643 table)) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
644 @end group |
59963
2bc848857427
(Example Major Modes): Fix typos.
Lute Kamstra <lute@gnu.org>
parents:
59942
diff
changeset
|
645 @group |
6451 | 646 ;; @r{Create an abbrev table for lisp-mode.} |
647 (define-abbrev-table 'lisp-mode-abbrev-table ()) | |
648 @end group | |
649 @end smallexample | |
650 | |
651 Much code is shared among the three Lisp modes. The following | |
652 function sets various variables; it is called by each of the major Lisp | |
653 mode functions: | |
654 | |
655 @smallexample | |
656 @group | |
657 (defun lisp-mode-variables (lisp-syntax) | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
658 (when lisp-syntax |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
659 (set-syntax-table lisp-mode-syntax-table)) |
6451 | 660 (setq local-abbrev-table lisp-mode-abbrev-table) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
661 @dots{} |
6451 | 662 @end group |
663 @end smallexample | |
664 | |
665 Functions such as @code{forward-paragraph} use the value of the | |
666 @code{paragraph-start} variable. Since Lisp code is different from | |
667 ordinary text, the @code{paragraph-start} variable needs to be set | |
668 specially to handle Lisp. Also, comments are indented in a special | |
669 fashion in Lisp and the Lisp modes need their own mode-specific | |
670 @code{comment-indent-function}. The code to set these variables is the | |
671 rest of @code{lisp-mode-variables}. | |
672 | |
673 @smallexample | |
674 @group | |
675 (make-local-variable 'paragraph-start) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
676 (setq paragraph-start (concat page-delimiter "\\|$" )) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
677 (make-local-variable 'paragraph-separate) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
678 (setq paragraph-separate paragraph-start) |
6451 | 679 @dots{} |
680 @end group | |
681 @group | |
682 (make-local-variable 'comment-indent-function) | |
683 (setq comment-indent-function 'lisp-comment-indent)) | |
25875 | 684 @dots{} |
6451 | 685 @end group |
686 @end smallexample | |
687 | |
688 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
|
689 example, Lisp mode binds @kbd{C-c C-z} to @code{run-lisp}, but the other |
6451 | 690 Lisp modes do not. However, all Lisp modes have some commands in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
691 common. The following code sets up the common commands: |
6451 | 692 |
693 @smallexample | |
694 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
695 (defvar shared-lisp-mode-map () |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
696 "Keymap for commands shared by all sorts of Lisp modes.") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
698 ;; @r{Putting this @code{if} after the @code{defvar} is an older style.} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
699 (if shared-lisp-mode-map |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
700 () |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
701 (setq shared-lisp-mode-map (make-sparse-keymap)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
702 (define-key shared-lisp-mode-map "\e\C-q" 'indent-sexp) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
703 (define-key shared-lisp-mode-map "\177" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
704 'backward-delete-char-untabify)) |
6451 | 705 @end group |
706 @end smallexample | |
707 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
708 @noindent |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
709 And here is the code to set up the keymap for Lisp mode: |
6451 | 710 |
711 @smallexample | |
712 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
713 (defvar lisp-mode-map () |
25950
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25875
diff
changeset
|
714 "Keymap for ordinary Lisp mode...") |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
715 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
716 (if lisp-mode-map |
6451 | 717 () |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
718 (setq lisp-mode-map (make-sparse-keymap)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
719 (set-keymap-parent lisp-mode-map shared-lisp-mode-map) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
720 (define-key lisp-mode-map "\e\C-x" 'lisp-eval-defun) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
721 (define-key lisp-mode-map "\C-c\C-z" 'run-lisp)) |
6451 | 722 @end group |
723 @end smallexample | |
724 | |
725 Finally, here is the complete major mode function definition for | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
726 Lisp mode. |
6451 | 727 |
728 @smallexample | |
729 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
730 (defun lisp-mode () |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
731 "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp. |
6451 | 732 Commands: |
733 Delete converts tabs to spaces as it moves back. | |
734 Blank lines separate paragraphs. Semicolons start comments. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
735 \\@{lisp-mode-map@} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
736 Note that `run-lisp' may be used either to start an inferior Lisp job |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
737 or to switch back to an existing one. |
6451 | 738 @end group |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
739 |
6451 | 740 @group |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
741 Entry to this mode calls the value of `lisp-mode-hook' |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
742 if that value is non-nil." |
6451 | 743 (interactive) |
744 (kill-all-local-variables) | |
745 @end group | |
746 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
747 (use-local-map lisp-mode-map) ; @r{Select the mode's keymap.} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
748 (setq major-mode 'lisp-mode) ; @r{This is how @code{describe-mode}} |
6451 | 749 ; @r{finds out what to describe.} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
750 (setq mode-name "Lisp") ; @r{This goes into the mode line.} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
751 (lisp-mode-variables t) ; @r{This defines various variables.} |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
752 (make-local-variable 'comment-start-skip) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
753 (setq comment-start-skip |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
754 "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(;+\\|#|\\) *") |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
755 (make-local-variable 'font-lock-keywords-case-fold-search) |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
756 (setq font-lock-keywords-case-fold-search t) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
757 @end group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
758 @group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
759 (setq imenu-case-fold-search t) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
760 (set-syntax-table lisp-mode-syntax-table) |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
761 (run-mode-hooks 'lisp-mode-hook)) ; @r{This permits the user to use a} |
6451 | 762 ; @r{hook to customize the mode.} |
763 @end group | |
764 @end smallexample | |
765 | |
766 @node Auto Major Mode | |
767 @subsection How Emacs Chooses a Major Mode | |
768 | |
769 Based on information in the file name or in the file itself, Emacs | |
770 automatically selects a major mode for the new buffer when a file is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
771 visited. It also processes local variables specified in the file text. |
6451 | 772 |
773 @deffn Command fundamental-mode | |
774 Fundamental mode is a major mode that is not specialized for anything | |
775 in particular. Other major modes are defined in effect by comparison | |
776 with this one---their definitions say what to change, starting from | |
777 Fundamental mode. The @code{fundamental-mode} function does @emph{not} | |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
778 run any mode hooks; you're not supposed to customize it. (If you want Emacs |
6451 | 779 to behave differently in Fundamental mode, change the @emph{global} |
780 state of Emacs.) | |
781 @end deffn | |
782 | |
783 @deffn Command normal-mode &optional find-file | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
784 This function establishes the proper major mode and buffer-local variable |
62345 | 785 bindings for the current buffer. First it calls @code{set-auto-mode} |
786 (see below), then it runs @code{hack-local-variables} to parse, and | |
787 bind or evaluate as appropriate, the file's local variables | |
788 (@pxref{File Local Variables}). | |
6451 | 789 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
790 If the @var{find-file} argument to @code{normal-mode} is non-@code{nil}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 @code{normal-mode} assumes that the @code{find-file} function is calling |
62345 | 792 it. In this case, it may process local variables in the @samp{-*-} |
793 line or at the end of the file. The variable | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
794 @code{enable-local-variables} controls whether to do so. @xref{File |
62345 | 795 Variables, , Local Variables in Files, emacs, The GNU Emacs Manual}, |
796 for the syntax of the local variables section of a file. | |
6451 | 797 |
12098 | 798 If you run @code{normal-mode} interactively, the argument |
6451 | 799 @var{find-file} is normally @code{nil}. In this case, |
62345 | 800 @code{normal-mode} unconditionally processes any file local variables. |
801 | |
802 If @code{normal-mode} processes the local variables list and this list | |
803 specifies a major mode, that mode overrides any mode chosen by | |
804 @code{set-auto-mode}. If neither @code{set-auto-mode} nor | |
805 @code{hack-local-variables} specify a major mode, the buffer stays in | |
806 the major mode determined by @code{default-major-mode} (see below). | |
6451 | 807 |
808 @cindex file mode specification error | |
12098 | 809 @code{normal-mode} uses @code{condition-case} around the call to the |
6451 | 810 major mode function, so errors are caught and reported as a @samp{File |
811 mode specification error}, followed by the original error message. | |
812 @end deffn | |
813 | |
62345 | 814 @defun set-auto-mode &optional keep-mode-if-same |
6451 | 815 @cindex visited file mode |
816 This function selects the major mode that is appropriate for the | |
62345 | 817 current buffer. It bases its decision (in order of precedence) on |
818 the @w{@samp{-*-}} line, on the @w{@samp{#!}} line (using | |
819 @code{interpreter-mode-alist}), on the text at the beginning of the | |
820 buffer (using @code{magic-mode-alist}), and finally on the visited | |
821 file name (using @code{auto-mode-alist}). @xref{Choosing Modes, , How | |
822 Major Modes are Chosen, emacs, The GNU Emacs Manual}. However, this | |
823 function does not look for the @samp{mode:} local variable near the | |
824 end of a file; the @code{hack-local-variables} function does that. | |
825 If @code{enable-local-variables} is @code{nil}, @code{set-auto-mode} | |
826 does not check the @w{@samp{-*-}} line for a mode tag either. | |
827 | |
828 If @var{keep-mode-if-same} is non-@code{nil}, this function does not | |
829 call the mode command if the buffer is already in the proper major | |
830 mode. For instance, @code{set-visited-file-name} sets this to | |
831 @code{t} to avoid killing buffer local variables that the user may | |
832 have set. | |
6451 | 833 @end defun |
834 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
835 @defopt default-major-mode |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
836 This variable holds the default major mode for new buffers. The |
6451 | 837 standard value is @code{fundamental-mode}. |
838 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
839 If the value of @code{default-major-mode} is @code{nil}, Emacs uses |
62345 | 840 the (previously) current buffer's major mode as the default major mode |
841 of a new buffer. However, if that major mode symbol has a @code{mode-class} | |
6451 | 842 property with value @code{special}, then it is not used for new buffers; |
843 Fundamental mode is used instead. The modes that have this property are | |
844 those such as Dired and Rmail that are useful only with text that has | |
845 been specially prepared. | |
846 @end defopt | |
847 | |
12067 | 848 @defun set-buffer-major-mode buffer |
849 This function sets the major mode of @var{buffer} to the value of | |
62345 | 850 @code{default-major-mode}; if that variable is @code{nil}, it uses the |
851 current buffer's major mode (if that is suitable). As an exception, | |
852 if @var{buffer}'s name is @samp{*scratch*}, it sets the mode to | |
853 @code{initial-major-mode}. | |
12067 | 854 |
855 The low-level primitives for creating buffers do not use this function, | |
12098 | 856 but medium-level commands such as @code{switch-to-buffer} and |
857 @code{find-file-noselect} use it whenever they create buffers. | |
12067 | 858 @end defun |
859 | |
62345 | 860 @defopt initial-major-mode |
6451 | 861 @cindex @samp{*scratch*} |
862 The value of this variable determines the major mode of the initial | |
863 @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
|
864 mode command. The default value is @code{lisp-interaction-mode}. |
62345 | 865 @end defopt |
866 | |
867 @defvar interpreter-mode-alist | |
868 This variable specifies major modes to use for scripts that specify a | |
869 command interpreter in a @samp{#!} line. Its value is an alist with | |
870 elements of the form @code{(@var{interpreter} . @var{mode})}; for | |
871 example, @code{("perl" . perl-mode)} is one element present by | |
872 default. The element says to use mode @var{mode} if the file | |
64974
94eca817f666
(Auto Major Mode): interpreter-mode-alist is not a regexp.
Richard M. Stallman <rms@gnu.org>
parents:
64889
diff
changeset
|
873 specifies an interpreter which matches @var{interpreter}. |
62345 | 874 @end defvar |
875 | |
876 @defvar magic-mode-alist | |
877 This variable's value is an alist with elements of the form | |
878 @code{(@var{regexp} . @var{function})}, where @var{regexp} is a | |
879 regular expression and @var{function} is a function or @code{nil}. | |
880 After visiting a file, @code{set-auto-mode} calls @var{function} if | |
881 the text at the beginning of the buffer matches @var{regexp} and | |
882 @var{function} is non-@code{nil}; if @var{function} is @code{nil}, | |
883 @code{auto-mode-alist} gets to decide the mode. | |
6451 | 884 @end defvar |
885 | |
886 @defvar auto-mode-alist | |
887 This variable contains an association list of file name patterns | |
62345 | 888 (regular expressions) and corresponding major mode commands. Usually, |
889 the file name patterns test for suffixes, such as @samp{.el} and | |
890 @samp{.c}, but this need not be the case. An ordinary element of the | |
891 alist looks like @code{(@var{regexp} . @var{mode-function})}. | |
6451 | 892 |
893 For example, | |
894 | |
895 @smallexample | |
896 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
897 (("\\`/tmp/fol/" . text-mode) |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
898 ("\\.texinfo\\'" . texinfo-mode) |
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
899 ("\\.texi\\'" . texinfo-mode) |
6451 | 900 @end group |
901 @group | |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
902 ("\\.el\\'" . emacs-lisp-mode) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
903 ("\\.c\\'" . c-mode) |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
904 ("\\.h\\'" . c-mode) |
6451 | 905 @dots{}) |
906 @end group | |
907 @end smallexample | |
908 | |
909 When you visit a file whose expanded file name (@pxref{File Name | |
62345 | 910 Expansion}), with version numbers and backup suffixes removed using |
911 @code{file-name-sans-versions} (@pxref{File Name Components}), matches | |
912 a @var{regexp}, @code{set-auto-mode} calls the corresponding | |
913 @var{mode-function}. This feature enables Emacs to select the proper | |
914 major mode for most files. | |
6451 | 915 |
916 If an element of @code{auto-mode-alist} has the form @code{(@var{regexp} | |
917 @var{function} t)}, then after calling @var{function}, Emacs searches | |
918 @code{auto-mode-alist} again for a match against the portion of the file | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
919 name that did not match before. This feature is useful for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
920 uncompression packages: an entry of the form @code{("\\.gz\\'" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
921 @var{function} t)} can uncompress the file and then put the uncompressed |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
922 file in the proper mode according to the name sans @samp{.gz}. |
6451 | 923 |
924 Here is an example of how to prepend several pattern pairs to | |
925 @code{auto-mode-alist}. (You might use this sort of expression in your | |
25875 | 926 init file.) |
6451 | 927 |
928 @smallexample | |
929 @group | |
930 (setq auto-mode-alist | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
931 (append |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
932 ;; @r{File name (within directory) starts with a dot.} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
933 '(("/\\.[^/]*\\'" . fundamental-mode) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
934 ;; @r{File name has no dot.} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
935 ("[^\\./]*\\'" . fundamental-mode) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
936 ;; @r{File name ends in @samp{.C}.} |
8505
d3f7cadf8c95
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
8016
diff
changeset
|
937 ("\\.C\\'" . c++-mode)) |
6451 | 938 auto-mode-alist)) |
939 @end group | |
940 @end smallexample | |
941 @end defvar | |
942 | |
943 @node Mode Help | |
944 @subsection Getting Help about a Major Mode | |
945 @cindex mode help | |
946 @cindex help for major mode | |
947 @cindex documentation for major mode | |
948 | |
949 The @code{describe-mode} function is used to provide information | |
950 about major modes. It is normally called with @kbd{C-h m}. The | |
951 @code{describe-mode} function uses the value of @code{major-mode}, | |
952 which is why every major mode function needs to set the | |
953 @code{major-mode} variable. | |
954 | |
955 @deffn Command describe-mode | |
956 This function displays the documentation of the current major mode. | |
957 | |
958 The @code{describe-mode} function calls the @code{documentation} | |
959 function using the value of @code{major-mode} as an argument. Thus, it | |
960 displays the documentation string of the major mode function. | |
961 (@xref{Accessing Documentation}.) | |
962 @end deffn | |
963 | |
964 @defvar major-mode | |
65369
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65320
diff
changeset
|
965 This buffer-local variable holds the symbol for the current buffer's |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65320
diff
changeset
|
966 major mode. This symbol should have a function definition that is the |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65320
diff
changeset
|
967 command to switch to that major mode. The @code{describe-mode} |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65320
diff
changeset
|
968 function uses the documentation string of the function as the |
822218f80ae4
2005-09-08 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
65320
diff
changeset
|
969 documentation of the major mode. |
6451 | 970 @end defvar |
971 | |
972 @node Derived Modes | |
973 @subsection Defining Derived Modes | |
61930 | 974 @cindex derived mode |
6451 | 975 |
976 It's often useful to define a new major mode in terms of an existing | |
977 one. An easy way to do this is to use @code{define-derived-mode}. | |
978 | |
62345 | 979 @defmac define-derived-mode variant parent name docstring keyword-args@dots{} body@dots{} |
6451 | 980 This construct defines @var{variant} as a major mode command, using |
62345 | 981 @var{name} as the string form of the mode name. @var{variant} and |
982 @var{parent} should be unquoted symbols. | |
6451 | 983 |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
984 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
|
985 @var{parent}, then override certain aspects of that parent mode: |
6451 | 986 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
987 @itemize @bullet |
6451 | 988 @item |
62345 | 989 The new mode has its own sparse keymap, named |
990 @code{@var{variant}-map}. @code{define-derived-mode} | |
991 makes the parent mode's keymap the parent of the new map, unless | |
992 @code{@var{variant}-map} is already set and already has a parent. | |
6451 | 993 |
994 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
995 The new mode has its own syntax table, kept in the variable |
62345 | 996 @code{@var{variant}-syntax-table}, unless you override this using the |
997 @code{:syntax-table} keyword (see below). @code{define-derived-mode} | |
998 makes the parent mode's syntax-table the parent of | |
999 @code{@var{variant}-syntax-table}, unless the latter is already set | |
62488
5d20851e7295
(Derived Modes): Correct references to non-existing variable
Luc Teirlinck <teirllm@auburn.edu>
parents:
62434
diff
changeset
|
1000 and already has a parent different from the standard syntax table. |
6451 | 1001 |
1002 @item | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1003 The new mode has its own abbrev table, kept in the variable |
62345 | 1004 @code{@var{variant}-abbrev-table}, unless you override this using the |
1005 @code{:abbrev-table} keyword (see below). | |
6451 | 1006 |
1007 @item | |
62345 | 1008 The new mode has its own mode hook, @code{@var{variant}-hook}. It |
1009 runs this hook, after running the hooks of its ancestor modes, with | |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1010 @code{run-mode-hooks}, as the last thing it does. @xref{Mode Hooks}. |
6451 | 1011 @end itemize |
1012 | |
1013 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
|
1014 @var{parent} with @var{body}. The command @var{variant} |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1015 evaluates the forms in @var{body} after setting up all its usual |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1016 overrides, just before running the mode hooks. |
6451 | 1017 |
62345 | 1018 You can also specify @code{nil} for @var{parent}. This gives the new |
1019 mode no parent. Then @code{define-derived-mode} behaves as described | |
1020 above, but, of course, omits all actions connected with @var{parent}. | |
1021 | |
1022 The argument @var{docstring} specifies the documentation string for | |
1023 the new mode. @code{define-derived-mode} adds some general | |
1024 information about the mode's hook, followed by the mode's keymap, at | |
1025 the end of this docstring. If you omit @var{docstring}, | |
1026 @code{define-derived-mode} generates a documentation string. | |
1027 | |
1028 The @var{keyword-args} are pairs of keywords and values. The values | |
1029 are evaluated. The following keywords are currently supported: | |
1030 | |
1031 @table @code | |
1032 @item :syntax-table | |
1033 You can use this to explicitly specify a syntax table for the new | |
1034 mode. If you specify a @code{nil} value, the new mode uses the same | |
62488
5d20851e7295
(Derived Modes): Correct references to non-existing variable
Luc Teirlinck <teirllm@auburn.edu>
parents:
62434
diff
changeset
|
1035 syntax table as @var{parent}, or the standard syntax table if |
62345 | 1036 @var{parent} is @code{nil}. (Note that this does @emph{not} follow |
1037 the convention used for non-keyword arguments that a @code{nil} value | |
1038 is equivalent with not specifying the argument.) | |
1039 | |
1040 @item :abbrev-table | |
1041 You can use this to explicitly specify an abbrev table for the new | |
1042 mode. If you specify a @code{nil} value, the new mode uses the same | |
62355
742fd00f9af6
(Derived Modes): Correct typos. Add pxref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62345
diff
changeset
|
1043 abbrev table as @var{parent}, or @code{fundamental-mode-abbrev-table} |
742fd00f9af6
(Derived Modes): Correct typos. Add pxref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62345
diff
changeset
|
1044 if @var{parent} is @code{nil}. (Again, a @code{nil} value is |
62345 | 1045 @emph{not} equivalent to not specifying this keyword.) |
62594
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1046 |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1047 @item :group |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1048 If this is specified, the value should be the customization group for |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1049 this mode. (Not all major modes have one.) Only the (still |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1050 experimental and unadvertised) command @code{customize-mode} currently |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1051 uses this. @code{define-derived-mode} does @emph{not} automatically |
47219b2b8b6f
(Derived Modes): Clarify :group keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62539
diff
changeset
|
1052 define the specified customization group. |
62345 | 1053 @end table |
6451 | 1054 |
1055 Here is a hypothetical example: | |
1056 | |
1057 @example | |
1058 (define-derived-mode hypertext-mode | |
1059 text-mode "Hypertext" | |
1060 "Major mode for hypertext. | |
1061 \\@{hypertext-mode-map@}" | |
1062 (setq case-fold-search nil)) | |
1063 | |
1064 (define-key hypertext-mode-map | |
1065 [down-mouse-3] 'do-hyper-link) | |
1066 @end example | |
40928
ebfea94f75d4
Don't write explicit (interactive) in defining a derived mode.
Richard M. Stallman <rms@gnu.org>
parents:
39793
diff
changeset
|
1067 |
ebfea94f75d4
Don't write explicit (interactive) in defining a derived mode.
Richard M. Stallman <rms@gnu.org>
parents:
39793
diff
changeset
|
1068 Do not write an @code{interactive} spec in the definition; |
ebfea94f75d4
Don't write explicit (interactive) in defining a derived mode.
Richard M. Stallman <rms@gnu.org>
parents:
39793
diff
changeset
|
1069 @code{define-derived-mode} does that automatically. |
6451 | 1070 @end defmac |
1071 | |
61930 | 1072 @node Generic Modes |
1073 @subsection Generic Modes | |
1074 @cindex generic mode | |
1075 | |
1076 @dfn{Generic modes} are simple major modes with basic support for | |
1077 comment syntax and Font Lock mode. They are primarily useful for | |
1078 configuration files. To define a generic mode, use the macro | |
1079 @code{define-generic-mode}. See the file @file{generic-x.el} for some | |
1080 examples of the use of @code{define-generic-mode}. | |
1081 | |
62259 | 1082 @defmac define-generic-mode mode comment-list keyword-list font-lock-list auto-mode-list function-list &optional docstring |
61930 | 1083 This macro creates a new generic mode. The argument @var{mode} (an |
1084 unquoted symbol) is the major mode command. The optional argument | |
1085 @var{docstring} is the documentation for the mode command. If you do | |
1086 not supply it, @code{define-generic-mode} uses a default documentation | |
1087 string instead. | |
1088 | |
1089 @var{comment-list} is a list in which each element is either a | |
1090 character, a string of one or two characters, or a cons cell. A | |
1091 character or a string is set up in the mode's syntax table as a | |
1092 ``comment starter.'' If the entry is a cons cell, the @sc{car} is set | |
1093 up as a ``comment starter'' and the @sc{cdr} as a ``comment ender.'' | |
1094 (Use @code{nil} for the latter if you want comments to end at the end | |
1095 of the line.) Note that the syntax table has limitations about what | |
1096 comment starters and enders are actually possible. @xref{Syntax | |
1097 Tables}. | |
1098 | |
1099 @var{keyword-list} is a list of keywords to highlight with | |
1100 @code{font-lock-keyword-face}. Each keyword should be a string. | |
1101 @var{font-lock-list} is a list of additional expressions to highlight. | |
1102 Each element of this list should have the same form as an element of | |
1103 @code{font-lock-keywords}. @xref{Search-based Fontification}. | |
1104 | |
1105 @var{auto-mode-list} is a list of regular expressions to add to the | |
1106 variable @code{auto-mode-alist}. These regular expressions are added | |
1107 when Emacs runs the macro expansion. | |
1108 | |
1109 @var{function-list} is a list of functions to call to do some | |
1110 additional setup. The mode command calls these functions just before | |
62259 | 1111 it runs the mode hook variable @code{@var{mode}-hook}. |
61930 | 1112 @end defmac |
1113 | |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1114 @node Mode Hooks |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1115 @subsection Mode Hooks |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1116 |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1117 The two last things a major mode function should do is run its mode |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1118 hook and finally the mode independent normal hook |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1119 @code{after-change-major-mode-hook}. If the major mode is a derived |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1120 mode, that is if it calls another major mode (the parent mode) in its |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1121 body, then the parent's mode hook is run just before the derived |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1122 mode's hook. Neither the parent's mode hook nor |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1123 @code{after-change-major-mode-hook} are run at the end of the actual |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1124 call to the parent mode. This applies recursively if the parent mode |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1125 has itself a parent. That is, the mode hooks of all major modes |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1126 called directly or indirectly by the major mode function are all run |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1127 in sequence at the end, just before |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1128 @code{after-change-major-mode-hook}. |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1129 |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1130 These conventions are new in Emacs 22, and some major modes |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1131 implemented by users do not follow them yet. So if you put a function |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1132 onto @code{after-change-major-mode-hook}, keep in mind that some modes |
62876
91cd19004788
(Mode Hooks): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62872
diff
changeset
|
1133 will fail to run it. If a user complains about that, you can respond, |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1134 ``That major mode fails to follow Emacs conventions, and that's why it |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1135 fails to work. Please fix the major mode.'' In most cases, that is |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1136 good enough, so go ahead and use @code{after-change-major-mode-hook}. |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1137 However, if a certain feature needs to be completely reliable, |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1138 it should not use @code{after-change-major-mode-hook} as of yet. |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1139 |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1140 When you defined a major mode using @code{define-derived-mode}, it |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1141 automatically makes sure these conventions are followed. If you |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1142 define a major mode ``from scratch'', not using |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1143 @code{define-derived-mode}, make sure the major mode command follows |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1144 these and other conventions. @xref{Major Mode Conventions}. You use |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1145 these functions to do it properly. |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1146 |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1147 @defun run-mode-hooks &rest hookvars |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1148 Major modes should run their mode hook using this function. It is |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1149 similar to @code{run-hooks} (@pxref{Hooks}), but it also runs |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1150 @code{after-change-major-mode-hook}. |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1151 |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1152 When the call to this function is dynamically inside a |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1153 @code{delay-mode-hooks} form, this function does not run any hooks. |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1154 Instead, it arranges for the next call to @code{run-mode-hooks} to run |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1155 @var{hookvars}. |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1156 @end defun |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1157 |
66145
9d237c376071
(Mode Hooks, Defining Minor Modes):
Juri Linkov <juri@jurta.org>
parents:
65369
diff
changeset
|
1158 @defmac delay-mode-hooks body@dots{} |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1159 This macro executes @var{body} like @code{progn}, but all calls to |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1160 @code{run-mode-hooks} inside @var{body} delay running their hooks. |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1161 They will be run by the first call to @code{run-mode-hooks} after exit |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1162 from @code{delay-mode-hooks}. This is the proper way for a major mode |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1163 command to invoke its parent mode. |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1164 @end defmac |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1165 |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1166 @defvar after-change-major-mode-hook |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1167 Every major mode function should run this normal hook at its very end. |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1168 It normally does not need to do so explicitly. Indeed, a major mode |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1169 function should normally run its mode hook with @code{run-mode-hooks} |
62857
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1170 as the very last thing it does, and the last thing |
9f2d0e4a66d0
(Mode Hooks): Explain that after-change-major-mode-hook is
Richard M. Stallman <rms@gnu.org>
parents:
62652
diff
changeset
|
1171 @code{run-mode-hooks} does is run @code{after-change-major-mode-hook}. |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1172 @end defvar |
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
1173 |
6451 | 1174 @node Minor Modes |
1175 @section Minor Modes | |
1176 @cindex minor mode | |
1177 | |
1178 A @dfn{minor mode} provides features that users may enable or disable | |
1179 independently of the choice of major mode. Minor modes can be enabled | |
1180 individually or in combination. Minor modes would be better named | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1181 ``generally available, optional feature modes,'' except that such a name |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1182 would be unwieldy. |
6451 | 1183 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1184 A minor mode is not usually meant as a variation of a single major mode. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1185 Usually they are general and can apply to many major modes. For |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1186 example, Auto Fill mode works with any major mode that permits text |
6451 | 1187 insertion. To be general, a minor mode must be effectively independent |
1188 of the things major modes do. | |
1189 | |
1190 A minor mode is often much more difficult to implement than a major | |
1191 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
|
1192 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
|
1193 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
|
1194 minor modes in effect. |
6451 | 1195 |
1196 Often the biggest problem in implementing a minor mode is finding a | |
1197 way to insert the necessary hook into the rest of Emacs. Minor mode | |
12098 | 1198 keymaps make this easier than it used to be. |
6451 | 1199 |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1200 @defvar minor-mode-list |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1201 The value of this variable is a list of all minor mode commands. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1202 @end defvar |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1203 |
6451 | 1204 @menu |
1205 * Minor Mode Conventions:: Tips for writing a minor mode. | |
1206 * Keymaps and Minor Modes:: How a minor mode can have its own keymap. | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1207 * Defining Minor Modes:: A convenient facility for defining minor modes. |
6451 | 1208 @end menu |
1209 | |
1210 @node Minor Mode Conventions | |
1211 @subsection Conventions for Writing Minor Modes | |
1212 @cindex minor mode conventions | |
1213 @cindex conventions for writing minor modes | |
1214 | |
1215 There are conventions for writing minor modes just as there are for | |
1216 major modes. Several of the major mode conventions apply to minor | |
1217 modes as well: those regarding the name of the mode initialization | |
66935
1af402fe3e48
(Minor Mode Conventions): Use custom-set-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66933
diff
changeset
|
1218 function, the names of global symbols, the use of a hook at the end of |
1af402fe3e48
(Minor Mode Conventions): Use custom-set-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66933
diff
changeset
|
1219 the initialization function, and the use of keymaps and other tables. |
6451 | 1220 |
1221 In addition, there are several conventions that are specific to | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1222 minor modes. (The easiest way to follow all the conventions is to use |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1223 the macro @code{define-minor-mode}; @ref{Defining Minor Modes}.) |
6451 | 1224 |
1225 @itemize @bullet | |
1226 @item | |
1227 @cindex mode variable | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1228 Make a variable whose name ends in @samp{-mode} to control the minor |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1229 mode. We call this the @dfn{mode variable}. The minor mode command |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1230 should set this variable (@code{nil} to disable; anything else to |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1231 enable). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1232 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1233 If possible, implement the mode so that setting the variable |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1234 automatically enables or disables the mode. Then the minor mode command |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1235 does not need to do anything except set the variable. |
6451 | 1236 |
1237 This variable is used in conjunction with the @code{minor-mode-alist} to | |
1238 display the minor mode name in the mode line. It can also enable | |
1239 or disable a minor mode keymap. Individual commands or hooks can also | |
1240 check the variable's value. | |
1241 | |
1242 If you want the minor mode to be enabled separately in each buffer, | |
1243 make the variable buffer-local. | |
1244 | |
1245 @item | |
1246 Define a command whose name is the same as the mode variable. | |
1247 Its job is to enable and disable the mode by setting the variable. | |
1248 | |
1249 The command should accept one optional argument. If the argument is | |
51794
8a7816e7f5bd
(Minor Mode Conventions): Specify only some kinds
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1250 @code{nil}, it should toggle the mode (turn it on if it is off, and |
8a7816e7f5bd
(Minor Mode Conventions): Specify only some kinds
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1251 off if it is on). It should turn the mode on if the argument is a |
8a7816e7f5bd
(Minor Mode Conventions): Specify only some kinds
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1252 positive integer, the symbol @code{t}, or a list whose @sc{car} is one |
8a7816e7f5bd
(Minor Mode Conventions): Specify only some kinds
Richard M. Stallman <rms@gnu.org>
parents:
51703
diff
changeset
|
1253 of those. It should turn the mode off if the argument is a negative |
55831
3d0a4333d97a
(Minor Mode Conventions): (-) has no special meaning
Richard M. Stallman <rms@gnu.org>
parents:
55687
diff
changeset
|
1254 integer or zero, the symbol @code{-}, or a list whose @sc{car} is a |
3d0a4333d97a
(Minor Mode Conventions): (-) has no special meaning
Richard M. Stallman <rms@gnu.org>
parents:
55687
diff
changeset
|
1255 negative integer or zero. The meaning of other arguments is not |
3d0a4333d97a
(Minor Mode Conventions): (-) has no special meaning
Richard M. Stallman <rms@gnu.org>
parents:
55687
diff
changeset
|
1256 specified. |
6451 | 1257 |
12098 | 1258 Here is an example taken from the definition of @code{transient-mark-mode}. |
1259 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
|
1260 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
|
1261 enable or disable the minor mode based on the raw prefix argument value. |
6451 | 1262 |
1263 @smallexample | |
1264 @group | |
12098 | 1265 (setq transient-mark-mode |
1266 (if (null arg) (not transient-mark-mode) | |
6451 | 1267 (> (prefix-numeric-value arg) 0))) |
1268 @end group | |
1269 @end smallexample | |
1270 | |
1271 @item | |
1272 Add an element to @code{minor-mode-alist} for each minor mode | |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1273 (@pxref{Definition of minor-mode-alist}), if you want to indicate the |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1274 minor mode in the mode line. This element should be a list of the |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1275 following form: |
6451 | 1276 |
1277 @smallexample | |
1278 (@var{mode-variable} @var{string}) | |
1279 @end smallexample | |
1280 | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1281 Here @var{mode-variable} is the variable that controls enabling of the |
6451 | 1282 minor mode, and @var{string} is a short string, starting with a space, |
1283 to represent the mode in the mode line. These strings must be short so | |
1284 that there is room for several of them at once. | |
1285 | |
1286 When you add an element to @code{minor-mode-alist}, use @code{assq} to | |
1287 check for an existing element, to avoid duplication. For example: | |
1288 | |
1289 @smallexample | |
1290 @group | |
25875 | 1291 (unless (assq 'leif-mode minor-mode-alist) |
1292 (setq minor-mode-alist | |
1293 (cons '(leif-mode " Leif") minor-mode-alist))) | |
1294 @end group | |
1295 @end smallexample | |
1296 | |
1297 @noindent | |
1298 or like this, using @code{add-to-list} (@pxref{Setting Variables}): | |
1299 | |
1300 @smallexample | |
1301 @group | |
1302 (add-to-list 'minor-mode-alist '(leif-mode " Leif")) | |
6451 | 1303 @end group |
1304 @end smallexample | |
1305 @end itemize | |
1306 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1307 Global minor modes distributed with Emacs should if possible support |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1308 enabling and disabling via Custom (@pxref{Customization}). To do this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1309 the first step is to define the mode variable with @code{defcustom}, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1310 specify @code{:type boolean}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1311 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1312 If just setting the variable is not sufficient to enable the mode, you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1313 should also specify a @code{:set} method which enables the mode by |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1314 invoking the mode command. Note in the variable's documentation string that |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1315 setting the variable other than via Custom may not take effect. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1316 |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1317 Also mark the definition with an autoload cookie (@pxref{autoload cookie}), |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1318 and specify a @code{:require} so that customizing the variable will load |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1319 the library that defines the mode. This will copy suitable definitions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1320 into @file{loaddefs.el} so that users can use @code{customize-option} to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1321 enable the mode. For example: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1322 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1323 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1324 @group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1325 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1326 ;;;###autoload |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1327 (defcustom msb-mode nil |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1328 "Toggle msb-mode. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1329 Setting this variable directly does not take effect; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1330 use either \\[customize] or the function `msb-mode'." |
66933
6b323e275ccb
(Minor Mode Conventions): Use custom-set-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66145
diff
changeset
|
1331 :set 'custom-set-minor-mode |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1332 :initialize 'custom-initialize-default |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1333 :version "20.4" |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1334 :type 'boolean |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1335 :group 'msb |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1336 :require 'msb) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1337 @end group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1338 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1339 |
6451 | 1340 @node Keymaps and Minor Modes |
1341 @subsection Keymaps and Minor Modes | |
1342 | |
12098 | 1343 Each minor mode can have its own keymap, which is active when the mode |
1344 is enabled. To set up a keymap for a minor mode, add an element to the | |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1345 alist @code{minor-mode-map-alist}. @xref{Definition of minor-mode-map-alist}. |
6451 | 1346 |
1347 @cindex @code{self-insert-command}, minor modes | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1348 One use of minor mode keymaps is to modify the behavior of certain |
6451 | 1349 self-inserting characters so that they do something else as well as |
1350 self-insert. In general, this is the only way to do that, since the | |
1351 facilities for customizing @code{self-insert-command} are limited to | |
1352 special cases (designed for abbrevs and Auto Fill mode). (Do not try | |
1353 substituting your own definition of @code{self-insert-command} for the | |
1354 standard one. The editor command loop handles this function specially.) | |
1355 | |
17278
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
1356 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
|
1357 followed by a punctuation character @emph{other than} @kbd{@{}, |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1358 @kbd{@}}, @kbd{<}, @kbd{>}, @kbd{:}, and @kbd{;}. (Those few punctuation |
17278
8ed8412c1ce7
Document key binding conventions for major modes and minor modes.
Richard M. Stallman <rms@gnu.org>
parents:
16432
diff
changeset
|
1359 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
|
1360 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1361 @node Defining Minor Modes |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1362 @subsection Defining Minor Modes |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1363 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1364 The macro @code{define-minor-mode} offers a convenient way of |
60220
77336d5f9a37
(Defining Minor Modes): define-minor-mode can be used to define global
Lute Kamstra <lute@gnu.org>
parents:
59996
diff
changeset
|
1365 implementing a mode in one self-contained definition. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1366 |
66145
9d237c376071
(Mode Hooks, Defining Minor Modes):
Juri Linkov <juri@jurta.org>
parents:
65369
diff
changeset
|
1367 @defmac define-minor-mode mode doc [init-value [lighter [keymap]]] keyword-args@dots{} body@dots{} |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1368 This macro defines a new minor mode whose name is @var{mode} (a |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1369 symbol). It defines a command named @var{mode} to toggle the minor |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1370 mode, with @var{doc} as its documentation string. It also defines a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1371 variable named @var{mode}, which is set to @code{t} or @code{nil} by |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1372 enabling or disabling the mode. The variable is initialized to |
64845
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1373 @var{init-value}. Except in unusual circumstances (see below), this |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1374 value must be @code{nil}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1375 |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1376 The string @var{lighter} says what to display in the mode line |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1377 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
|
1378 in the mode line. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1379 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1380 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
|
1381 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
|
1382 specifying bindings in this form: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1383 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1384 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1385 (@var{key-sequence} . @var{definition}) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1386 @end example |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1387 |
60230
d3a84cca7e73
(Defining Minor Modes): Explain that INIT-VALUE, LIGHTER, and KEYMAP
Lute Kamstra <lute@gnu.org>
parents:
60220
diff
changeset
|
1388 The above three arguments @var{init-value}, @var{lighter}, and |
d3a84cca7e73
(Defining Minor Modes): Explain that INIT-VALUE, LIGHTER, and KEYMAP
Lute Kamstra <lute@gnu.org>
parents:
60220
diff
changeset
|
1389 @var{keymap} can be (partially) omitted when @var{keyword-args} are |
d3a84cca7e73
(Defining Minor Modes): Explain that INIT-VALUE, LIGHTER, and KEYMAP
Lute Kamstra <lute@gnu.org>
parents:
60220
diff
changeset
|
1390 used. The @var{keyword-args} consist of keywords followed by |
d3a84cca7e73
(Defining Minor Modes): Explain that INIT-VALUE, LIGHTER, and KEYMAP
Lute Kamstra <lute@gnu.org>
parents:
60220
diff
changeset
|
1391 corresponding values. A few keywords have special meanings: |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1392 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1393 @table @code |
61322
8ac9a1a8591f
(Defining Minor Modes): Document :group keyword argument and its
Lute Kamstra <lute@gnu.org>
parents:
61034
diff
changeset
|
1394 @item :group @var{group} |
8ac9a1a8591f
(Defining Minor Modes): Document :group keyword argument and its
Lute Kamstra <lute@gnu.org>
parents:
61034
diff
changeset
|
1395 Custom group name to use in all generated @code{defcustom} forms. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
1396 Defaults to @var{mode} without the possible trailing @samp{-mode}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
1397 @strong{Warning:} don't use this default group name unless you have |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
1398 written a @code{defgroup} to define that group properly. @xref{Group |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
1399 Definitions}. |
61322
8ac9a1a8591f
(Defining Minor Modes): Document :group keyword argument and its
Lute Kamstra <lute@gnu.org>
parents:
61034
diff
changeset
|
1400 |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1401 @item :global @var{global} |
62329
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1402 If non-@code{nil} specifies that the minor mode should be global. By |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1403 default, minor modes defined with @code{define-minor-mode} are |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1404 buffer-local. |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1405 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1406 @item :init-value @var{init-value} |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1407 This is equivalent to specifying @var{init-value} positionally. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1408 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1409 @item :lighter @var{lighter} |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1410 This is equivalent to specifying @var{lighter} positionally. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1411 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1412 @item :keymap @var{keymap} |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1413 This is equivalent to specifying @var{keymap} positionally. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1414 @end table |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1415 |
64453
5bf18d0546ae
(Defining Minor Modes): Delete duplicate words.
Juri Linkov <juri@jurta.org>
parents:
63583
diff
changeset
|
1416 Any other keyword arguments are passed directly to the |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1417 @code{defcustom} generated for the variable @var{mode}. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1418 |
62434
893818a65dc5
(Defining Minor Modes): Mention the mode hook.
Lute Kamstra <lute@gnu.org>
parents:
62355
diff
changeset
|
1419 The command named @var{mode} first performs the standard actions such |
893818a65dc5
(Defining Minor Modes): Mention the mode hook.
Lute Kamstra <lute@gnu.org>
parents:
62355
diff
changeset
|
1420 as setting the variable named @var{mode} and then executes the |
893818a65dc5
(Defining Minor Modes): Mention the mode hook.
Lute Kamstra <lute@gnu.org>
parents:
62355
diff
changeset
|
1421 @var{body} forms, if any. It finishes by running the mode hook |
893818a65dc5
(Defining Minor Modes): Mention the mode hook.
Lute Kamstra <lute@gnu.org>
parents:
62355
diff
changeset
|
1422 variable @code{@var{mode}-hook}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1423 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1424 |
64845
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1425 The initial value must be @code{nil} except in cases where (1) the |
68084 | 1426 mode is preloaded in Emacs, or (2) it is painless for loading to |
64845
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1427 enable the mode even though the user did not request it. For |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1428 instance, if the mode has no effect unless something else is enabled, |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1429 and will always be loaded by that time, enabling it by default is |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1430 harmless. But these are unusual circumstances. Normally, the |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1431 initial value must be @code{nil}. |
583d71cf38e2
(Defining Minor Modes): Explain when init-value can be non-nil.
Richard M. Stallman <rms@gnu.org>
parents:
64650
diff
changeset
|
1432 |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1433 @findex easy-mmode-define-minor-mode |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1434 The name @code{easy-mmode-define-minor-mode} is an alias |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1435 for this macro. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1436 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1437 Here is an example of using @code{define-minor-mode}: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1438 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1439 @smallexample |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1440 (define-minor-mode hungry-mode |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1441 "Toggle Hungry mode. |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1442 With no argument, this command toggles the mode. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1443 Non-null prefix argument turns on the mode. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1444 Null prefix argument turns off the mode. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1445 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1446 When Hungry mode is enabled, the control delete key |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1447 gobbles all preceding whitespace except the last. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1448 See the command \\[hungry-electric-delete]." |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1449 ;; The initial value. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1450 nil |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1451 ;; The indicator for the mode line. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1452 " Hungry" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1453 ;; The minor mode bindings. |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1454 '(("\C-\^?" . hungry-electric-delete)) |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1455 :group 'hunger) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1456 @end smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1457 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1458 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1459 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
|
1460 @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
|
1461 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
|
1462 @code{hungry-mode-map} which holds the keymap that is active when the |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1463 mode is enabled. It initializes the keymap with a key binding for |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1464 @kbd{C-@key{DEL}}. It puts the variable @code{hungry-mode} into |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1465 custom group @code{hunger}. There are no @var{body} forms---many |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1466 minor modes don't need any. |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1467 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1468 Here's an equivalent way to write it: |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1469 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1470 @smallexample |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1471 (define-minor-mode hungry-mode |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1472 "Toggle Hungry mode. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1473 With no argument, this command toggles the mode. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1474 Non-null prefix argument turns on the mode. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1475 Null prefix argument turns off the mode. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1476 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1477 When Hungry mode is enabled, the control delete key |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1478 gobbles all preceding whitespace except the last. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1479 See the command \\[hungry-electric-delete]." |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1480 ;; The initial value. |
64650
82d9ac62ed1d
(Defining Minor Modes): The keyword for the initial value is
Luc Teirlinck <teirllm@auburn.edu>
parents:
64453
diff
changeset
|
1481 :init-value nil |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1482 ;; The indicator for the mode line. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1483 :lighter " Hungry" |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1484 ;; The minor mode bindings. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1485 :keymap |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1486 '(("\C-\^?" . hungry-electric-delete) |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1487 ("\C-\M-\^?" |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1488 . (lambda () |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1489 (interactive) |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1490 (hungry-electric-delete t)))) |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1491 :group 'hunger) |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
1492 @end smallexample |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
1493 |
66145
9d237c376071
(Mode Hooks, Defining Minor Modes):
Juri Linkov <juri@jurta.org>
parents:
65369
diff
changeset
|
1494 @defmac define-global-minor-mode global-mode mode turn-on keyword-args@dots{} |
62329
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1495 This defines a global minor mode named @var{global-mode} whose meaning |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1496 is to enable the buffer-local minor mode @var{mode} in every buffer. |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1497 To turn on the minor mode in a buffer, it uses the function |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1498 @var{turn-on}; to turn off the minor mode, it calls @code{mode} with |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1499 @minus{}1 as argument. |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1500 |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1501 Use @code{:group @var{group}} in @var{keyword-args} to specify the |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1502 custom group for the mode variable of the global minor mode. |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1503 @end defmac |
37b336c94e15
(Defining Minor Modes): Define define-global-minor-mode.
Richard M. Stallman <rms@gnu.org>
parents:
62259
diff
changeset
|
1504 |
6451 | 1505 @node Mode Line Format |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1506 @section Mode-Line Format |
6451 | 1507 @cindex mode line |
1508 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1509 Each Emacs window (aside from minibuffer windows) typically has a mode |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1510 line at the bottom, which displays status information about the buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1511 displayed in the window. The mode line contains information about the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1512 buffer, such as its name, associated file, depth of recursive editing, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1513 and major and minor modes. A window can also have a @dfn{header |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1514 line}, which is much like the mode line but appears at the top of the |
60450
abf7b131c9ab
(Mode Line Format): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60230
diff
changeset
|
1515 window. |
6451 | 1516 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1517 This section describes how to control the contents of the mode line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1518 and header line. We include it in this chapter because much of the |
6451 | 1519 information displayed in the mode line relates to the enabled major and |
1520 minor modes. | |
1521 | |
62345 | 1522 @menu |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1523 * Base: Mode Line Basics. Basic ideas of mode line control. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1524 * Data: Mode Line Data. The data structure that controls the mode line. |
67909
a01ca682e5e1
(Mode Line Format): Correct typo in menu.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67900
diff
changeset
|
1525 * Top: Mode Line Top. The top level variable, mode-line-format. |
62345 | 1526 * Mode Line Variables:: Variables used in that data structure. |
1527 * %-Constructs:: Putting information into a mode line. | |
1528 * Properties in Mode:: Using text properties in the mode line. | |
1529 * Header Lines:: Like a mode line, but at the top. | |
1530 * Emulating Mode Line:: Formatting text as the mode line would. | |
1531 @end menu | |
1532 | |
1533 @node Mode Line Basics | |
1534 @subsection Mode Line Basics | |
1535 | |
6451 | 1536 @code{mode-line-format} is a buffer-local variable that holds a |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1537 @dfn{mode line construct}, a kind of template, which controls the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1538 display the mode line of the current buffer. All windows for the same |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1539 buffer use the same @code{mode-line-format}, so their mode lines |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1540 appear the same---except for scrolling percentages, and line and |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1541 column numbers, since those depend on point and on how the window is |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1542 scrolled. The value of @code{header-line-format} specifies the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1543 buffer's header line in the same way, with a mode line construct. |
6451 | 1544 |
42296
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1545 For efficiency, Emacs does not recompute the mode line and header |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1546 line of a window in every redisplay. It does so when circumstances |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1547 appear to call for it---for instance, if you change the window |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1548 configuration, switch buffers, narrow or widen the buffer, scroll, or |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1549 change the buffer's modification status. If you modify any of the |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1550 variables referenced by @code{mode-line-format} (@pxref{Mode Line |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1551 Variables}), or any other variables and data structures that affect |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1552 how text is displayed (@pxref{Display}), you may want to force an |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1553 update of the mode line so as to display the new information or |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1554 display it in the new way. |
6451 | 1555 |
1556 @c Emacs 19 feature | |
52859
bc7fbf233421
(Mode Line Format): Mention force-mode-line-update's argument.
Lute Kamstra <lute@gnu.org>
parents:
52841
diff
changeset
|
1557 @defun force-mode-line-update &optional all |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1558 Force redisplay of the current buffer's mode line and header line. |
42296
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1559 The next redisplay will update the mode line and header line based on |
52859
bc7fbf233421
(Mode Line Format): Mention force-mode-line-update's argument.
Lute Kamstra <lute@gnu.org>
parents:
52841
diff
changeset
|
1560 the latest values of all relevant variables. With optional |
bc7fbf233421
(Mode Line Format): Mention force-mode-line-update's argument.
Lute Kamstra <lute@gnu.org>
parents:
52841
diff
changeset
|
1561 non-@code{nil} @var{all}, force redisplay of all mode lines and header |
bc7fbf233421
(Mode Line Format): Mention force-mode-line-update's argument.
Lute Kamstra <lute@gnu.org>
parents:
52841
diff
changeset
|
1562 lines. |
42296
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1563 |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1564 This function also forces recomputation of the menu bar menus |
7b9a0bcca3c2
Explain mode line redisplay better.
Richard M. Stallman <rms@gnu.org>
parents:
41938
diff
changeset
|
1565 and the frame title. |
6451 | 1566 @end defun |
1567 | |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1568 The selected window's mode line is usually displayed in a different |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1569 color using the face @code{mode-line}. Other windows' mode lines |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
1570 appear in the face @code{mode-line-inactive} instead. @xref{Faces}. |
6451 | 1571 |
1572 @node Mode Line Data | |
1573 @subsection The Data Structure of the Mode Line | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1574 @cindex mode-line construct |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1575 |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1576 The mode-line contents are controlled by a data structure called a |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1577 @dfn{mode-line construct}, made up of lists, strings, symbols, and |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1578 numbers kept in buffer-local variables. Each data type has a specific |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1579 meaning for the mode-line appearance, as described below. The same |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1580 data structure is used for constructing frame titles (@pxref{Frame |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1581 Titles}) and header lines (@pxref{Header Lines}). |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1582 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1583 A mode-line construct may be as simple as a fixed string of text, |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1584 but it usually specifies how to combine fixed strings with variables' |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1585 values to construct the text. Many of these variables are themselves |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1586 defined to have mode-line constructs as their values. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1587 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1588 Here are the meanings of various data types as mode-line constructs: |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1589 |
6451 | 1590 @table @code |
1591 @cindex percent symbol in mode line | |
1592 @item @var{string} | |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1593 A string as a mode-line construct appears verbatim in the mode line |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1594 except for @dfn{@code{%}-constructs} in it. These stand for |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1595 substitution of other data; see @ref{%-Constructs}. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1596 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1597 If the string has @code{face} properties, they are copied into the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1598 mode line contents too (@pxref{Properties in Mode}). Any characters |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1599 in the mode line which have no @code{face} properties are displayed, |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1600 by default, in the face @code{mode-line} or @code{mode-line-inactive} |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1601 (@pxref{Standard Faces,,, emacs, The GNU Emacs Manual}). |
6451 | 1602 |
1603 @item @var{symbol} | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1604 A symbol as a mode-line construct stands for its value. The value of |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1605 @var{symbol} is used as a mode-line construct, in place of @var{symbol}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1606 However, the symbols @code{t} and @code{nil} are ignored, as is any |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1607 symbol whose value is void. |
6451 | 1608 |
1609 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
|
1610 displayed verbatim: the @code{%}-constructs are not recognized. |
6451 | 1611 |
52663
5f70316d2ec5
(Mode Line Data): Explain when symbols in mode-line
Lute Kamstra <lute@gnu.org>
parents:
52628
diff
changeset
|
1612 Unless @var{symbol} is marked as ``risky'' (i.e., it has a |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1613 non-@code{nil} @code{risky-local-variable} property), all text |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1614 properties specified in @var{symbol}'s value are ignored. This |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1615 includes the text properties of strings in @var{symbol}'s value, as |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1616 well as all @code{:eval} and @code{:propertize} forms in it. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1617 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1618 @item (@var{string} @var{rest}@dots{}) |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1619 @itemx (@var{list} @var{rest}@dots{}) |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1620 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
|
1621 elements recursively and concatenate the results. This is the most |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1622 common form of mode-line construct. |
6451 | 1623 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1624 @item (:eval @var{form}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1625 A list whose first element is the symbol @code{:eval} says to evaluate |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1626 @var{form}, and use the result as a string to display. Make sure this |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1627 evaluation cannot load any files, as doing so could cause infinite |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1628 recursion. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1629 |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1630 @item (:propertize @var{elt} @var{props}@dots{}) |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1631 A list whose first element is the symbol @code{:propertize} says to |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1632 process the mode-line construct @var{elt} recursively, then add the text |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1633 properties specified by @var{props} to the result. The argument |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1634 @var{props} should consist of zero or more pairs @var{text-property} |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59963
diff
changeset
|
1635 @var{value}. (This feature is new as of Emacs 22.1.) |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1636 |
6451 | 1637 @item (@var{symbol} @var{then} @var{else}) |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1638 A list whose first element is a symbol that is not a keyword specifies |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1639 a conditional. Its meaning depends on the value of @var{symbol}. If |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1640 @var{symbol} has a non-@code{nil} value, the second element, |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1641 @var{then}, is processed recursively as a mode-line element. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1642 Otherwise, the third element, @var{else}, is processed recursively. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1643 You may omit @var{else}; then the mode-line element displays nothing |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
1644 if the value of @var{symbol} is @code{nil} or void. |
6451 | 1645 |
1646 @item (@var{width} @var{rest}@dots{}) | |
1647 A list whose first element is an integer specifies truncation or | |
1648 padding of the results of @var{rest}. The remaining elements | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1649 @var{rest} are processed recursively as mode-line constructs and |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1650 concatenated together. When @var{width} is positive, the result is |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1651 space filled on the right if its width is less than @var{width}. When |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1652 @var{width} is negative, the result is truncated on the right to |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1653 @minus{}@var{width} columns if its width exceeds @minus{}@var{width}. |
6451 | 1654 |
1655 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
|
1656 the top of the window is to use a list like this: @code{(-3 "%p")}. |
6451 | 1657 @end table |
1658 | |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1659 @node Mode Line Top |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1660 @subsection The Top Level of Mode Line Control |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1661 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1662 The variable in overall control of the mode line is |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1663 @code{mode-line-format}. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1664 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1665 @defvar mode-line-format |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1666 The value of this variable is a mode-line construct that controls the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1667 contents of the mode-line. It is always buffer-local in all buffers. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1668 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1669 If you set this variable to @code{nil} in a buffer, that buffer does |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1670 not have a mode line. (A window that is just one line tall never |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1671 displays a mode line.) |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1672 @end defvar |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1673 |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1674 The default value of @code{mode-line-format} is designed to use the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1675 values of other variables such as @code{mode-line-position} and |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1676 @code{mode-line-modes} (which in turn incorporates the values of the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1677 variables @code{mode-name} and @code{minor-mode-alist}). Very few |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1678 modes need to alter @code{mode-line-format} itself. For most |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1679 purposes, it is sufficient to alter some of the variables that |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1680 @code{mode-line-format} either directly or indirectly refers to. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1681 |
6451 | 1682 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
|
1683 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
|
1684 Line Variables}), rather than duplicating their contents or displaying |
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1685 the information in another fashion. This way, customizations made by |
12098 | 1686 the user or by Lisp programs (such as @code{display-time} and major |
1687 modes) via changes to those variables remain effective. | |
6451 | 1688 |
1689 @cindex Shell mode @code{mode-line-format} | |
1690 Here is an example of a @code{mode-line-format} that might be | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1691 useful for @code{shell-mode}, since it contains the host name and default |
6451 | 1692 directory. |
1693 | |
1694 @example | |
1695 @group | |
1696 (setq mode-line-format | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1697 (list "-" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1698 'mode-line-mule-info |
6451 | 1699 'mode-line-modified |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1700 'mode-line-frame-identification |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1701 "%b--" |
6451 | 1702 @end group |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1703 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1704 ;; @r{Note that this is evaluated while making the list.} |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1705 ;; @r{It makes a mode-line construct which is just a string.} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1706 (getenv "HOST") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1707 @end group |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1708 ":" |
6451 | 1709 'default-directory |
1710 " " | |
1711 'global-mode-string | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1712 " %[(" |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1713 '(:eval (mode-line-mode-name)) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1714 'mode-line-process |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1715 'minor-mode-alist |
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
1716 "%n" |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1717 ")%]--" |
6451 | 1718 @group |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1719 '(which-func-mode ("" which-func-format "--")) |
12098 | 1720 '(line-number-mode "L%l--") |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1721 '(column-number-mode "C%c--") |
52663
5f70316d2ec5
(Mode Line Data): Explain when symbols in mode-line
Lute Kamstra <lute@gnu.org>
parents:
52628
diff
changeset
|
1722 '(-3 "%p") |
6451 | 1723 "-%-")) |
1724 @end group | |
1725 @end example | |
1726 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1727 @noindent |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1728 (The variables @code{line-number-mode}, @code{column-number-mode} |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1729 and @code{which-func-mode} enable particular minor modes; as usual, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1730 these variable names are also the minor mode command names.) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1731 |
6451 | 1732 @node Mode Line Variables |
1733 @subsection Variables Used in the Mode Line | |
1734 | |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1735 This section describes variables incorporated by the standard value |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1736 of @code{mode-line-format} into the text of the mode line. There is |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1737 nothing inherently special about these variables; any other variables |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1738 could have the same effects on the mode line if |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1739 @code{mode-line-format}'s value were changed to use them. However, |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1740 various parts of Emacs set these variables on the understanding that |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1741 they will control parts of the mode line; therefore, practically |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1742 speaking, it is essential for the mode line to use them. |
6451 | 1743 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1744 @defvar mode-line-mule-info |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1745 This variable holds the value of the mode-line construct that displays |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1746 information about the language environment, buffer coding system, and |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1747 current input method. @xref{Non-ASCII Characters}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1748 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1749 |
6451 | 1750 @defvar mode-line-modified |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1751 This variable holds the value of the mode-line construct that displays |
6451 | 1752 whether the current buffer is modified. |
1753 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1754 The default value of @code{mode-line-modified} is @code{("%1*%1+")}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1755 This means that the mode line displays @samp{**} if the buffer is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1756 modified, @samp{--} if the buffer is not modified, @samp{%%} if the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1757 buffer is read only, and @samp{%*} if the buffer is read only and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1758 modified. |
6451 | 1759 |
1760 Changing this variable does not force an update of the mode line. | |
1761 @end defvar | |
1762 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1763 @defvar mode-line-frame-identification |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1764 This variable identifies the current frame. The default value is |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1765 @code{" "} if you are using a window system which can show multiple |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1766 frames, or @code{"-%F "} on an ordinary terminal which shows only one |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1767 frame at a time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1768 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1769 |
6451 | 1770 @defvar mode-line-buffer-identification |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1771 This variable identifies the buffer being displayed in the window. Its |
22267
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1772 default value is @code{("%12b")}, which displays the buffer name, padded |
dfac7398266b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1773 with spaces to at least 12 columns. |
6451 | 1774 @end defvar |
1775 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1776 @defvar mode-line-position |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1777 This variable indicates the position in the buffer. Here is a |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1778 simplified version of its default value. The actual default value |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1779 also specifies addition of the @code{help-echo} text property. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1780 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1781 @example |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1782 @group |
52663
5f70316d2ec5
(Mode Line Data): Explain when symbols in mode-line
Lute Kamstra <lute@gnu.org>
parents:
52628
diff
changeset
|
1783 ((-3 "%p") |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1784 (size-indication-mode (8 " of %I")) |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1785 @end group |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1786 @group |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1787 (line-number-mode |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1788 ((column-number-mode |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1789 (10 " (%l,%c)") |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1790 (6 " L%l"))) |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1791 ((column-number-mode |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1792 (5 " C%c"))))) |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1793 @end group |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1794 @end example |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1795 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1796 This means that @code{mode-line-position} displays at least the buffer |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1797 percentage and possibly the buffer size, the line number and the column |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1798 number. |
6451 | 1799 @end defvar |
1800 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1801 @defvar vc-mode |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1802 The variable @code{vc-mode}, buffer-local in each buffer, records |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1803 whether the buffer's visited file is maintained with version control, |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1804 and, if so, which kind. Its value is a string that appears in the mode |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1805 line, or @code{nil} for no version control. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1806 @end defvar |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1807 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1808 @defvar mode-line-modes |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1809 This variable displays the buffer's major and minor modes. Here is a |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1810 simplified version of its default value. The real default value also |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1811 specifies addition of text properties. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1812 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1813 @example |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1814 @group |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1815 ("%[(" mode-name |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1816 mode-line-process minor-mode-alist |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1817 "%n" ")%]--") |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1818 @end group |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1819 @end example |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1820 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1821 So @code{mode-line-modes} normally also displays the recursive editing |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1822 level, information on the process status and whether narrowing is in |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1823 effect. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1824 @end defvar |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1825 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1826 The following three variables are used in @code{mode-line-modes}: |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1827 |
6451 | 1828 @defvar mode-name |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1829 This buffer-local variable holds the ``pretty'' name of the current |
6451 | 1830 buffer's major mode. Each major mode should set this variable so that the |
1831 mode name will appear in the mode line. | |
1832 @end defvar | |
1833 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1834 @defvar mode-line-process |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1835 This buffer-local variable contains the mode-line information on process |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1836 status in modes used for communicating with subprocesses. It is |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1837 displayed immediately following the major mode name, with no intervening |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1838 space. For example, its value in the @samp{*shell*} buffer is |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1839 @code{(":%s")}, which allows the shell to display its status along |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1840 with the major mode as: @samp{(Shell:run)}. Normally this variable |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1841 is @code{nil}. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1842 @end defvar |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1843 |
6451 | 1844 @defvar minor-mode-alist |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
1845 @anchor{Definition of minor-mode-alist} |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1846 This variable holds an association list whose elements specify how the |
6451 | 1847 mode line should indicate that a minor mode is active. Each element of |
1848 the @code{minor-mode-alist} should be a two-element list: | |
1849 | |
1850 @example | |
1851 (@var{minor-mode-variable} @var{mode-line-string}) | |
1852 @end example | |
1853 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1854 More generally, @var{mode-line-string} can be any mode-line spec. It |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1855 appears in the mode line when the value of @var{minor-mode-variable} |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1856 is non-@code{nil}, and not otherwise. These strings should begin with |
6451 | 1857 spaces so that they don't run together. Conventionally, the |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1858 @var{minor-mode-variable} for a specific mode is set to a |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1859 non-@code{nil} value when that minor mode is activated. |
6451 | 1860 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1861 @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
|
1862 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
|
1863 enabled separately in each buffer. |
6451 | 1864 @end defvar |
1865 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1866 @defvar global-mode-string |
55508
44124e158456
(Mode Line Variables): Fix description of global-mode-string, which is now after
Juanma Barranquero <lekktu@gmail.com>
parents:
55414
diff
changeset
|
1867 This variable holds a mode-line spec that, by default, appears in the |
44124e158456
(Mode Line Variables): Fix description of global-mode-string, which is now after
Juanma Barranquero <lekktu@gmail.com>
parents:
55414
diff
changeset
|
1868 mode line just after the @code{which-func-mode} minor mode if set, |
44124e158456
(Mode Line Variables): Fix description of global-mode-string, which is now after
Juanma Barranquero <lekktu@gmail.com>
parents:
55414
diff
changeset
|
1869 else after @code{mode-line-modes}. The command @code{display-time} |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1870 sets @code{global-mode-string} to refer to the variable |
55508
44124e158456
(Mode Line Variables): Fix description of global-mode-string, which is now after
Juanma Barranquero <lekktu@gmail.com>
parents:
55414
diff
changeset
|
1871 @code{display-time-string}, which holds a string containing the time |
44124e158456
(Mode Line Variables): Fix description of global-mode-string, which is now after
Juanma Barranquero <lekktu@gmail.com>
parents:
55414
diff
changeset
|
1872 and load information. |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1873 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1874 The @samp{%M} construct substitutes the value of |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1875 @code{global-mode-string}, but that is obsolete, since the variable is |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1876 included in the mode line from @code{mode-line-format}. |
25875 | 1877 @end defvar |
1878 | |
1879 The variable @code{default-mode-line-format} is where | |
1880 @code{mode-line-format} usually gets its value: | |
1881 | |
6451 | 1882 @defvar default-mode-line-format |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1883 This variable holds the default @code{mode-line-format} for buffers |
6451 | 1884 that do not override it. This is the same as @code{(default-value |
1885 'mode-line-format)}. | |
1886 | |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1887 Here is a simplified version of the default value of |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1888 @code{default-mode-line-format}. The real default value also |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1889 specifies addition of text properties. |
6451 | 1890 |
1891 @example | |
1892 @group | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1893 ("-" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1894 mode-line-mule-info |
6451 | 1895 mode-line-modified |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1896 mode-line-frame-identification |
6451 | 1897 mode-line-buffer-identification |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1898 @end group |
6451 | 1899 " " |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1900 mode-line-position |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1901 (vc-mode vc-mode) |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1902 " " |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1903 @group |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1904 mode-line-modes |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
1905 (which-func-mode ("" which-func-format "--")) |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
1906 (global-mode-string ("--" global-mode-string)) |
6451 | 1907 "-%-") |
1908 @end group | |
1909 @end example | |
1910 @end defvar | |
1911 | |
1912 @node %-Constructs | |
1913 @subsection @code{%}-Constructs in the Mode Line | |
1914 | |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1915 Strings used as mode-line constructs can use certain |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1916 @code{%}-constructs to substitute various kinds of data. Here is a |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1917 list of the defined @code{%}-constructs, and what they mean. In any |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1918 construct except @samp{%%}, you can add a decimal integer after the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1919 @samp{%} to specify a minimum field width. If the width is less, the |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
1920 field is padded with spaces to the right. |
6451 | 1921 |
1922 @table @code | |
1923 @item %b | |
1924 The current buffer name, obtained with the @code{buffer-name} function. | |
1925 @xref{Buffer Names}. | |
1926 | |
25875 | 1927 @item %c |
1928 The current column number of point. | |
1929 | |
70928
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1930 @item %e |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1931 When Emacs is nearly out of memory for Lisp objects, a brief message |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1932 saying so. Otherwise, this is empty. |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1933 |
6451 | 1934 @item %f |
1935 The visited file name, obtained with the @code{buffer-file-name} | |
1936 function. @xref{Buffer File Name}. | |
1937 | |
12067 | 1938 @item %F |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1939 The title (only on a window system) or the name of the selected frame. |
64874
aa029c72e536
(%-Constructs): Fix xref.
Richard M. Stallman <rms@gnu.org>
parents:
64845
diff
changeset
|
1940 @xref{Basic Parameters}. |
12067 | 1941 |
52463
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1942 @item %i |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1943 The size of the accessible part of the current buffer; basically |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1944 @code{(- (point-max) (point-min))}. |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1945 |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1946 @item %I |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1947 Like @samp{%i}, but the size is printed in a more readable way by using |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1948 @samp{k} for 10^3, @samp{M} for 10^6, @samp{G} for 10^9, etc., to |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1949 abbreviate. |
be54b19bb668
(%-Constructs): Document new `%i' and `%I' constructs.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
1950 |
12067 | 1951 @item %l |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1952 The current line number of point, counting within the accessible portion |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
1953 of the buffer. |
12067 | 1954 |
25875 | 1955 @item %n |
1956 @samp{Narrow} when narrowing is in effect; nothing otherwise (see | |
1957 @code{narrow-to-region} in @ref{Narrowing}). | |
1958 | |
1959 @item %p | |
1960 The percentage of the buffer text above the @strong{top} of window, or | |
1961 @samp{Top}, @samp{Bottom} or @samp{All}. Note that the default | |
1962 mode-line specification truncates this to three characters. | |
1963 | |
1964 @item %P | |
1965 The percentage of the buffer text that is above the @strong{bottom} of | |
1966 the window (which includes the text visible in the window, as well as | |
1967 the text above the top), plus @samp{Top} if the top of the buffer is | |
1968 visible on screen; or @samp{Bottom} or @samp{All}. | |
1969 | |
1970 @item %s | |
1971 The status of the subprocess belonging to the current buffer, obtained with | |
1972 @code{process-status}. @xref{Process Information}. | |
1973 | |
1974 @item %t | |
1975 Whether the visited file is a text file or a binary file. This is a | |
1976 meaningful distinction only on certain operating systems (@pxref{MS-DOS | |
1977 File Types}). | |
1978 | |
70928
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1979 @item %z |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1980 The mnemonics of buffer, terminal, and keyboard coding systems. |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1981 |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1982 @item %Z |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1983 Like @samp{%z}, but including the end-of-line format. |
76fee807f4c0
(%-Constructs): Add %e, %z, %Z.
Juri Linkov <juri@jurta.org>
parents:
70289
diff
changeset
|
1984 |
6451 | 1985 @item %* |
1986 @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1987 @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* | |
1988 @samp{-} otherwise. @xref{Buffer Modification}. | |
1989 | |
1990 @item %+ | |
12067 | 1991 @samp{*} if the buffer is modified (see @code{buffer-modified-p}); @* |
1992 @samp{%} if the buffer is read only (see @code{buffer-read-only}); @* | |
1993 @samp{-} otherwise. This differs from @samp{%*} only for a modified | |
1994 read-only buffer. @xref{Buffer Modification}. | |
1995 | |
1996 @item %& | |
7253
6ba87aed7836
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
1997 @samp{*} if the buffer is modified, and @samp{-} otherwise. |
6451 | 1998 |
1999 @item %[ | |
2000 An indication of the depth of recursive editing levels (not counting | |
2001 minibuffer levels): one @samp{[} for each editing level. | |
2002 @xref{Recursive Editing}. | |
2003 | |
2004 @item %] | |
2005 One @samp{]} for each recursive editing level (not counting minibuffer | |
2006 levels). | |
2007 | |
25875 | 2008 @item %- |
2009 Dashes sufficient to fill the remainder of the mode line. | |
2010 | |
6451 | 2011 @item %% |
2012 The character @samp{%}---this is how to include a literal @samp{%} in a | |
2013 string in which @code{%}-constructs are allowed. | |
2014 @end table | |
2015 | |
2016 The following two @code{%}-constructs are still supported, but they are | |
2017 obsolete, since you can get the same results with the variables | |
2018 @code{mode-name} and @code{global-mode-string}. | |
2019 | |
2020 @table @code | |
2021 @item %m | |
2022 The value of @code{mode-name}. | |
2023 | |
2024 @item %M | |
68727
d842e198bb96
(%-Constructs): Remove obsolete info about `global-mode-string'.
Juanma Barranquero <lekktu@gmail.com>
parents:
68648
diff
changeset
|
2025 The value of @code{global-mode-string}. |
6451 | 2026 @end table |
2027 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2028 @node Properties in Mode |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2029 @subsection Properties in the Mode Line |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2030 @cindex text properties in the mode line |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2031 |
60450
abf7b131c9ab
(Mode Line Format): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60230
diff
changeset
|
2032 Certain text properties are meaningful in the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2033 mode line. The @code{face} property affects the appearance of text; the |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
2034 @code{help-echo} property associates help strings with the text, and |
29102 | 2035 @code{local-map} can make the text mouse-sensitive. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2036 |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2037 There are four ways to specify text properties for text in the mode |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2038 line: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2039 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2040 @enumerate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2041 @item |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2042 Put a string with a text property directly into the mode-line data |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2043 structure. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2044 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2045 @item |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2046 Put a text property on a mode-line %-construct such as @samp{%12b}; then |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2047 the expansion of the %-construct will have that same text property. |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2048 |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2049 @item |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2050 Use a @code{(:propertize @var{elt} @var{props}@dots{})} construct to |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2051 give @var{elt} a text property specified by @var{props}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2052 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2053 @item |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2054 Use a list containing @code{:eval @var{form}} in the mode-line data |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2055 structure, and make @var{form} evaluate to a string that has a text |
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2056 property. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2057 @end enumerate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2058 |
29102 | 2059 You use the @code{local-map} property to specify a keymap. Like any |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2060 keymap, it can bind character keys and function keys; but that has no |
25875 | 2061 effect, since it is impossible to move point into the mode line. This |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2062 keymap can only take real effect for mouse clicks. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2063 |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2064 When the mode line refers to a variable which does not have a |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2065 non-@code{nil} @code{risky-local-variable} property, any text |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2066 properties given or specified within that variable's values are |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2067 ignored. This is because such properties could otherwise specify |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2068 functions to be called, and those functions could come from file |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2069 local variables. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2070 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2071 @node Header Lines |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2072 @subsection Window Header Lines |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2073 @cindex header line (of a window) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2074 @cindex window header line |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2075 |
60450
abf7b131c9ab
(Mode Line Format): Get rid of "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents:
60230
diff
changeset
|
2076 A window can have a @dfn{header line} at the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2077 top, just as it can have a mode line at the bottom. The header line |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2078 feature works just like the mode-line feature, except that it's |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2079 controlled by different variables. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2080 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2081 @defvar header-line-format |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2082 This variable, local in every buffer, specifies how to display the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2083 header line, for windows displaying the buffer. The format of the value |
26783 | 2084 is the same as for @code{mode-line-format} (@pxref{Mode Line Data}). |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2085 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2086 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2087 @defvar default-header-line-format |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2088 This variable holds the default @code{header-line-format} for buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2089 that do not override it. This is the same as @code{(default-value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2090 'header-line-format)}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2091 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2092 It is normally @code{nil}, so that ordinary buffers have no header line. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2093 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2094 |
67900
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
2095 A window that is just one line tall never displays a header line. A |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
2096 window that is two lines tall cannot display both a mode line and a |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
2097 header line at once; if it has a mode line, then it does not display a |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
2098 header line. |
1d5d6f907447
(Mode Line Top): New node.
Richard M. Stallman <rms@gnu.org>
parents:
67572
diff
changeset
|
2099 |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2100 @node Emulating Mode Line |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2101 @subsection Emulating Mode-Line Formatting |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2102 |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2103 You can use the function @code{format-mode-line} to compute |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2104 the text that would appear in a mode line or header line |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
2105 based on a certain mode-line specification. |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2106 |
59516
f50d20947c20
(Emulating Mode Line): Update format-mode-line entry.
Kim F. Storm <storm@cua.dk>
parents:
59492
diff
changeset
|
2107 @defun format-mode-line format &optional face window buffer |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2108 This function formats a line of text according to @var{format} as if |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2109 it were generating the mode line for @var{window}, but instead of |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2110 displaying the text in the mode line or the header line, it returns |
59389
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2111 the text as a string. The argument @var{window} defaults to the |
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2112 selected window. If @var{buffer} is non-@code{nil}, all the |
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2113 information used is taken from @var{buffer}; by default, it comes from |
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2114 @var{window}'s buffer. |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2115 |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2116 The value string normally has text properties that correspond to the |
59492
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2117 faces, keymaps, etc., that the mode line would have. And any character |
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2118 for which no @code{face} property is specified gets a default |
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2119 value which is usually @var{face}. (If @var{face} is @code{t}, |
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2120 that stands for either @code{mode-line} if @var{window} is selected, |
62539
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
2121 otherwise @code{mode-line-inactive}. If @var{face} is @code{nil} or |
14e404c9c65f
(Hooks): Delete confusing and unnecessary sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62488
diff
changeset
|
2122 omitted, that stands for no face property.) |
59492
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2123 |
59516
f50d20947c20
(Emulating Mode Line): Update format-mode-line entry.
Kim F. Storm <storm@cua.dk>
parents:
59492
diff
changeset
|
2124 However, if @var{face} is an integer, the value has no text properties. |
59389
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2125 |
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2126 For example, @code{(format-mode-line header-line-format)} returns the |
f1eb5a3ef974
(Emulating Mode Line): format-mode-line requires 1 arg.
Richard M. Stallman <rms@gnu.org>
parents:
59138
diff
changeset
|
2127 text that would appear in the selected window's header line (@code{""} |
59492
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2128 if it has no header line). @code{(format-mode-line header-line-format |
59516
f50d20947c20
(Emulating Mode Line): Update format-mode-line entry.
Kim F. Storm <storm@cua.dk>
parents:
59492
diff
changeset
|
2129 'header-line)} returns the same text, with each character |
59492
8732f8552b7d
(Emulating Mode Line): Doc FACE arg in format-header-line.
Richard M. Stallman <rms@gnu.org>
parents:
59389
diff
changeset
|
2130 carrying the face that it will have in the header line itself. |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2131 @end defun |
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2132 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2133 @node Imenu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2134 @section Imenu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2135 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2136 @cindex Imenu |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2137 @dfn{Imenu} is a feature that lets users select a definition or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2138 section in the buffer, from a menu which lists all of them, to go |
52001
b96d92c96bd1
(Imenu): Add xref to Emacs Manual node on Imenu.
Richard M. Stallman <rms@gnu.org>
parents:
51917
diff
changeset
|
2139 directly to that location in the buffer. Imenu works by constructing |
b96d92c96bd1
(Imenu): Add xref to Emacs Manual node on Imenu.
Richard M. Stallman <rms@gnu.org>
parents:
51917
diff
changeset
|
2140 a buffer index which lists the names and buffer positions of the |
25875 | 2141 definitions, or other named portions of the buffer; then the user can |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2142 choose one of them and move point to it. Major modes can add a menu |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2143 bar item to use Imenu using @code{imenu-add-to-menubar}. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2144 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2145 @defun imenu-add-to-menubar name |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2146 This function defines a local menu bar item named @var{name} |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2147 to run Imenu. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2148 @end defun |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2149 |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2150 The user-level commands for using Imenu are described in the Emacs |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2151 Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2152 explains how to customize Imenu's method of finding definitions or |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2153 buffer portions for a particular major mode. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2154 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2155 The usual and simplest way is to set the variable |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2156 @code{imenu-generic-expression}: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2157 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2158 @defvar imenu-generic-expression |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2159 This variable, if non-@code{nil}, is a list that specifies regular |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2160 expressions for finding definitions for Imenu. Simple elements of |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2161 @code{imenu-generic-expression} look like this: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2162 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2163 @example |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2164 (@var{menu-title} @var{regexp} @var{index}) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2165 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2166 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2167 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
|
2168 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
|
2169 @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
|
2170 @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
|
2171 in the top level of the buffer index. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2172 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2173 The second item in the list, @var{regexp}, is a regular expression |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2174 (@pxref{Regular Expressions}); anything in the buffer that it matches |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2175 is considered a definition, something to mention in the buffer index. |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2176 The third item, @var{index}, is a non-negative integer that indicates |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2177 which subexpression in @var{regexp} matches the definition's name. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2178 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2179 An element can also look like this: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2180 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2181 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2182 (@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
|
2183 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2184 |
70088
c6bf77b3c5b8
(Imenu): Clarify what special items do.
Richard M. Stallman <rms@gnu.org>
parents:
69499
diff
changeset
|
2185 Each match for this element creates an index item, and when the index |
c6bf77b3c5b8
(Imenu): Clarify what special items do.
Richard M. Stallman <rms@gnu.org>
parents:
69499
diff
changeset
|
2186 item is selected by the user, it calls @var{function} with arguments |
c6bf77b3c5b8
(Imenu): Clarify what special items do.
Richard M. Stallman <rms@gnu.org>
parents:
69499
diff
changeset
|
2187 consisting of the item name, the buffer position, and @var{arguments}. |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2188 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2189 For Emacs Lisp mode, @code{imenu-generic-expression} could look like |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2190 this: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2191 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2192 @c should probably use imenu-syntax-alist and \\sw rather than [-A-Za-z0-9+] |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2193 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2194 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2195 ((nil "^\\s-*(def\\(un\\|subst\\|macro\\|advice\\)\ |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2196 \\s-+\\([-A-Za-z0-9+]+\\)" 2) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2197 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2198 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2199 ("*Vars*" "^\\s-*(def\\(var\\|const\\)\ |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2200 \\s-+\\([-A-Za-z0-9+]+\\)" 2) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2201 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2202 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2203 ("*Types*" |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2204 "^\\s-*\ |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2205 (def\\(type\\|struct\\|class\\|ine-condition\\)\ |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2206 \\s-+\\([-A-Za-z0-9+]+\\)" 2)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2207 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2208 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2209 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2210 Setting this variable makes it buffer-local in the current buffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2211 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2212 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2213 @defvar imenu-case-fold-search |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2214 This variable controls whether matching against the regular |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2215 expressions in the value of @code{imenu-generic-expression} is |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2216 case-sensitive: @code{t}, the default, means matching should ignore |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2217 case. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2218 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2219 Setting this variable makes it buffer-local in the current buffer. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2220 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2221 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2222 @defvar imenu-syntax-alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2223 This variable is an alist of syntax table modifiers to use while |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2224 processing @code{imenu-generic-expression}, to override the syntax table |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2225 of the current buffer. Each element should have this form: |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2226 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2227 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2228 (@var{characters} . @var{syntax-description}) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2229 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2230 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2231 The @sc{car}, @var{characters}, can be either a character or a string. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2232 The element says to give that character or characters the syntax |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2233 specified by @var{syntax-description}, which is passed to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2234 @code{modify-syntax-entry} (@pxref{Syntax Table Functions}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2235 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2236 This feature is typically used to give word syntax to characters which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2237 normally have symbol syntax, and thus to simplify |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2238 @code{imenu-generic-expression} and speed up matching. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2239 For example, Fortran mode uses it this way: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2240 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2241 @example |
52001
b96d92c96bd1
(Imenu): Add xref to Emacs Manual node on Imenu.
Richard M. Stallman <rms@gnu.org>
parents:
51917
diff
changeset
|
2242 (setq imenu-syntax-alist '(("_$" . "w"))) |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2243 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2244 |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2245 The @code{imenu-generic-expression} regular expressions can then use |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2246 @samp{\\sw+} instead of @samp{\\(\\sw\\|\\s_\\)+}. Note that this |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2247 technique may be inconvenient when the mode needs to limit the initial |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2248 character of a name to a smaller set of characters than are allowed in |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2249 the rest of a name. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2250 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2251 Setting this variable makes it buffer-local in the current buffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2252 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2253 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2254 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
|
2255 variables @code{imenu-prev-index-position-function} and |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2256 @code{imenu-extract-index-name-function}: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2257 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2258 @defvar imenu-prev-index-position-function |
27332
5cfe77eaff45
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
2259 If this variable is non-@code{nil}, its value should be a function that |
25875 | 2260 finds the next ``definition'' to put in the buffer index, scanning |
2261 backward in the buffer from point. It should return @code{nil} if it | |
48700 | 2262 doesn't find another ``definition'' before point. Otherwise it should |
68084 | 2263 leave point at the place it finds a ``definition'' and return any |
25875 | 2264 non-@code{nil} value. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2265 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2266 Setting this variable makes it buffer-local in the current buffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2267 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2268 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2269 @defvar imenu-extract-index-name-function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2270 If this variable is non-@code{nil}, its value should be a function to |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2271 return the name for a definition, assuming point is in that definition |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2272 as the @code{imenu-prev-index-position-function} function would leave |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2273 it. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2274 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2275 Setting this variable makes it buffer-local in the current buffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2276 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2277 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2278 The last way to customize Imenu for a major mode is to set the |
25875 | 2279 variable @code{imenu-create-index-function}: |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2280 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2281 @defvar imenu-create-index-function |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2282 This variable specifies the function to use for creating a buffer |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2283 index. The function should take no arguments, and return an index |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2284 alist for the current buffer. It is called within |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2285 @code{save-excursion}, so where it leaves point makes no difference. |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2286 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2287 The index alist can have three types of elements. Simple elements |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2288 look like this: |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2289 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2290 @example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2291 (@var{index-name} . @var{index-position}) |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2292 @end example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2293 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2294 Selecting a simple element has the effect of moving to position |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2295 @var{index-position} in the buffer. Special elements look like this: |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2296 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2297 @example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2298 (@var{index-name} @var{index-position} @var{function} @var{arguments}@dots{}) |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2299 @end example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2300 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2301 Selecting a special element performs: |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2302 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2303 @example |
52800
d738115b4197
(Faces for Font Lock): Fix typo.
Lute Kamstra <lute@gnu.org>
parents:
52744
diff
changeset
|
2304 (funcall @var{function} |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2305 @var{index-name} @var{index-position} @var{arguments}@dots{}) |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2306 @end example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2307 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2308 A nested sub-alist element looks like this: |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2309 |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2310 @example |
52802
675fbfca3a2a
(Imenu): Mention imenu-create-index-function's default value.
Lute Kamstra <lute@gnu.org>
parents:
52800
diff
changeset
|
2311 (@var{menu-title} @var{sub-alist}) |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2312 @end example |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2313 |
52802
675fbfca3a2a
(Imenu): Mention imenu-create-index-function's default value.
Lute Kamstra <lute@gnu.org>
parents:
52800
diff
changeset
|
2314 It creates the submenu @var{menu-title} specified by @var{sub-alist}. |
675fbfca3a2a
(Imenu): Mention imenu-create-index-function's default value.
Lute Kamstra <lute@gnu.org>
parents:
52800
diff
changeset
|
2315 |
675fbfca3a2a
(Imenu): Mention imenu-create-index-function's default value.
Lute Kamstra <lute@gnu.org>
parents:
52800
diff
changeset
|
2316 The default value of @code{imenu-create-index-function} is |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63133
diff
changeset
|
2317 @code{imenu-default-create-index-function}. This function calls the |
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63133
diff
changeset
|
2318 value of @code{imenu-prev-index-position-function} and the value of |
52744
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2319 @code{imenu-extract-index-name-function} to produce the index alist. |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2320 However, if either of these two variables is @code{nil}, the default |
c81c292a982b
(Major Mode Conventions): Mention third way to set up Imenu.
Lute Kamstra <lute@gnu.org>
parents:
52663
diff
changeset
|
2321 function uses @code{imenu-generic-expression} instead. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2322 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2323 Setting this variable makes it buffer-local in the current buffer. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2324 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2325 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2326 @node Font Lock Mode |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2327 @section Font Lock Mode |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2328 @cindex Font Lock Mode |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2329 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2330 @dfn{Font Lock mode} is a feature that automatically attaches |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2331 @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
|
2332 syntactic role. How it parses the buffer depends on the major mode; |
25875 | 2333 most major modes define syntactic criteria for which faces to use in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2334 which contexts. This section explains how to customize Font Lock for a |
25875 | 2335 particular major mode. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2336 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2337 Font Lock mode finds text to highlight in two ways: through |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2338 syntactic parsing based on the syntax table, and through searching |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2339 (usually for regular expressions). Syntactic fontification happens |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2340 first; it finds comments and string constants and highlights them. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2341 Search-based fontification happens second. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2342 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2343 @menu |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2344 * Font Lock Basics:: Overview of customizing Font Lock. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2345 * Search-based Fontification:: Fontification based on regexps. |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2346 * Customizing Keywords:: Customizing search-based fontification. |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2347 * Other Font Lock Variables:: Additional customization facilities. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2348 * Levels of Font Lock:: Each mode can define alternative levels |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2349 so that the user can select more or less. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2350 * Precalculated Fontification:: How Lisp programs that produce the buffer |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2351 contents can also specify how to fontify it. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2352 * Faces for Font Lock:: Special faces specifically for Font Lock. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2353 * Syntactic Font Lock:: Fontification based on syntax tables. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2354 * Setting Syntax Properties:: Defining character syntax based on context |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2355 using the Font Lock mechanism. |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
2356 * Multiline Font Lock:: How to coerce Font Lock into properly |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
2357 highlighting multiline constructs. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2358 @end menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2359 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2360 @node Font Lock Basics |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2361 @subsection Font Lock Basics |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2362 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2363 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
|
2364 text. But major modes should not set any of these variables directly. |
24934 | 2365 Instead, they should set @code{font-lock-defaults} as a buffer-local |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2366 variable. The value assigned to this variable is used, if and when Font |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2367 Lock mode is enabled, to set all the other variables. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2368 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2369 @defvar font-lock-defaults |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2370 This variable is set by major modes, as a buffer-local variable, to |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2371 specify how to fontify text in that mode. It automatically becomes |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2372 buffer-local when you set it. The value should look like this: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2373 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2374 @example |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2375 (@var{keywords} [@var{keywords-only} [@var{case-fold} |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2376 [@var{syntax-alist} [@var{syntax-begin} @var{other-vars}@dots{}]]]]) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2377 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2378 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2379 The first element, @var{keywords}, indirectly specifies the value of |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2380 @code{font-lock-keywords} which directs search-based fontification. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2381 It can be a symbol, a variable or a function whose value is the list |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2382 to use for @code{font-lock-keywords}. It can also be a list of |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2383 several such symbols, one for each possible level of fontification. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2384 The first symbol specifies how to do level 1 fontification, the second |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2385 symbol how to do level 2, and so on. @xref{Levels of Font Lock}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2386 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2387 The second element, @var{keywords-only}, specifies the value of the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2388 variable @code{font-lock-keywords-only}. If this is non-@code{nil}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2389 syntactic fontification (of strings and comments) is not performed. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2390 @xref{Syntactic Font Lock}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2391 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2392 The third element, @var{case-fold}, specifies the value of |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2393 @code{font-lock-keywords-case-fold-search}. If it is non-@code{nil}, |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2394 Font Lock mode ignores case when searching as directed by |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2395 @code{font-lock-keywords}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2396 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2397 If the fourth element, @var{syntax-alist}, is non-@code{nil}, it |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2398 should be a list of cons cells of the form @code{(@var{char-or-string} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2399 . @var{string})}. These are used to set up a syntax table for |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2400 syntactic fontification (@pxref{Syntax Table Functions}). The |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2401 resulting syntax table is stored in @code{font-lock-syntax-table}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2402 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2403 The fifth element, @var{syntax-begin}, specifies the value of |
62652
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2404 @code{font-lock-beginning-of-syntax-function}. We recommend setting |
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2405 this variable to @code{nil} and using @code{syntax-begin-function} |
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2406 instead. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2407 |
25875 | 2408 All the remaining elements (if any) are collectively called |
2409 @var{other-vars}. Each of these elements should have the form | |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2410 @code{(@var{variable} . @var{value})}---which means, make |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2411 @var{variable} buffer-local and then set it to @var{value}. You can |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2412 use these @var{other-vars} to set other variables that affect |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2413 fontification, aside from those you can control with the first five |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2414 elements. @xref{Other Font Lock Variables}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2415 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2416 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2417 @node Search-based Fontification |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2418 @subsection Search-based Fontification |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2419 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2420 The most important variable for customizing Font Lock mode is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2421 @code{font-lock-keywords}. It specifies the search criteria for |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2422 search-based fontification. You should specify the value of this |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2423 variable with @var{keywords} in @code{font-lock-defaults}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2424 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2425 @defvar font-lock-keywords |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2426 This variable's value is a list of the keywords to highlight. Be |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2427 careful when composing regular expressions for this list; a poorly |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2428 written pattern can dramatically slow things down! |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2429 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2430 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2431 Each element of @code{font-lock-keywords} specifies how to find |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2432 certain cases of text, and how to highlight those cases. Font Lock mode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2433 processes the elements of @code{font-lock-keywords} one by one, and for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2434 each element, it finds and handles all matches. Ordinarily, once |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2435 part of the text has been fontified already, this cannot be overridden |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2436 by a subsequent match in the same text; but you can specify different |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2437 behavior using the @var{override} element of a @var{subexp-highlighter}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2438 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2439 Each element of @code{font-lock-keywords} should have one of these |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2440 forms: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2441 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2442 @table @code |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2443 @item @var{regexp} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2444 Highlight all matches for @var{regexp} using |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2445 @code{font-lock-keyword-face}. For example, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2446 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2447 @example |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2448 ;; @r{Highlight occurrences of the word @samp{foo}} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2449 ;; @r{using @code{font-lock-keyword-face}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2450 "\\<foo\\>" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2451 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2452 |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2453 The function @code{regexp-opt} (@pxref{Regexp Functions}) is useful |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2454 for calculating optimal regular expressions to match a number of |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2455 different keywords. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2456 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2457 @item @var{function} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2458 Find text by calling @var{function}, and highlight the matches |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2459 it finds using @code{font-lock-keyword-face}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2460 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2461 When @var{function} is called, it receives one argument, the limit of |
55687
4d4340e24361
(Search-based Fontification): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
55508
diff
changeset
|
2462 the search; it should begin searching at point, and not search beyond the |
41938
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2463 limit. It should return non-@code{nil} if it succeeds, and set the |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2464 match data to describe the match that was found. Returning @code{nil} |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2465 indicates failure of the search. |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2466 |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2467 Fontification will call @var{function} repeatedly with the same limit, |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2468 and with point where the previous invocation left it, until |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2469 @var{function} fails. On failure, @var{function} need not reset point |
f8c0a921c536
Improve doc of font-lock-keywords.
Richard M. Stallman <rms@gnu.org>
parents:
40928
diff
changeset
|
2470 in any particular way. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2471 |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2472 @item (@var{matcher} . @var{subexp}) |
24934 | 2473 In this kind of element, @var{matcher} is either a regular |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2474 expression or a function, as described above. The @sc{cdr}, |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2475 @var{subexp}, specifies which subexpression of @var{matcher} should be |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2476 highlighted (instead of the entire text that @var{matcher} matched). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2477 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2478 @example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2479 ;; @r{Highlight the @samp{bar} in each occurrence of @samp{fubar},} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2480 ;; @r{using @code{font-lock-keyword-face}.} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2481 ("fu\\(bar\\)" . 1) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2482 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2483 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2484 If you use @code{regexp-opt} to produce the regular expression |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63133
diff
changeset
|
2485 @var{matcher}, you can use @code{regexp-opt-depth} (@pxref{Regexp |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2486 Functions}) to calculate the value for @var{subexp}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2487 |
53430
7abfe409def6
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
52978
diff
changeset
|
2488 @item (@var{matcher} . @var{facespec}) |
61678
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2489 In this kind of element, @var{facespec} is an expression whose value |
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2490 specifies the face to use for highlighting. In the simplest case, |
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2491 @var{facespec} is a Lisp variable (a symbol) whose value is a face |
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2492 name. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2493 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2494 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2495 ;; @r{Highlight occurrences of @samp{fubar},} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2496 ;; @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
|
2497 ("fubar" . fubar-face) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2498 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2499 |
61678
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2500 However, @var{facespec} can also evaluate to a list of this form: |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2501 |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2502 @example |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2503 (face @var{face} @var{prop1} @var{val1} @var{prop2} @var{val2}@dots{}) |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2504 @end example |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2505 |
61678
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2506 @noindent |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2507 to specify the face @var{face} and various additional text properties |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2508 to put on the text that matches. If you do this, be sure to add the |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2509 other text property names that you set in this way to the value of |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2510 @code{font-lock-extra-managed-props} so that the properties will also |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2511 be cleared out when they are no longer appropriate. Alternatively, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2512 you can set the variable @code{font-lock-unfontify-region-function} to |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2513 a function that clears these properties. @xref{Other Font Lock |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2514 Variables}. |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2515 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2516 @item (@var{matcher} . @var{subexp-highlighter}) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2517 In this kind of element, @var{subexp-highlighter} is a list |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2518 which specifies how to highlight matches found by @var{matcher}. |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2519 It has the form: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2520 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2521 @example |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2522 (@var{subexp} @var{facespec} [[@var{override} [@var{laxmatch}]]) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2523 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2524 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2525 The @sc{car}, @var{subexp}, is an integer specifying which subexpression |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2526 of the match to fontify (0 means the entire matching text). The second |
61678
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2527 subelement, @var{facespec}, is an expression whose value specifies the |
3c8535295b32
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
61377
diff
changeset
|
2528 face, as described above. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2529 |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2530 The last two values in @var{subexp-highlighter}, @var{override} and |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2531 @var{laxmatch}, are optional flags. If @var{override} is @code{t}, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2532 this element can override existing fontification made by previous |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2533 elements of @code{font-lock-keywords}. If it is @code{keep}, then |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2534 each character is fontified if it has not been fontified already by |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2535 some other element. If it is @code{prepend}, the face specified by |
53430
7abfe409def6
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
52978
diff
changeset
|
2536 @var{facespec} is added to the beginning of the @code{font-lock-face} |
7abfe409def6
(Search-based Fontification): Explain that
Richard M. Stallman <rms@gnu.org>
parents:
52978
diff
changeset
|
2537 property. If it is @code{append}, the face is added to the end of the |
52187
a39b6df244a7
(Emulating Mode Line): New node.
Richard M. Stallman <rms@gnu.org>
parents:
52001
diff
changeset
|
2538 @code{font-lock-face} property. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2539 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2540 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
|
2541 if there is no subexpression numbered @var{subexp} in @var{matcher}. |
25975
e368b754fe25
Add patch from rms around line 1870.
Gerd Moellmann <gerd@gnu.org>
parents:
25950
diff
changeset
|
2542 Obviously, fontification of the subexpression numbered @var{subexp} will |
e368b754fe25
Add patch from rms around line 1870.
Gerd Moellmann <gerd@gnu.org>
parents:
25950
diff
changeset
|
2543 not occur. However, fontification of other subexpressions (and other |
e368b754fe25
Add patch from rms around line 1870.
Gerd Moellmann <gerd@gnu.org>
parents:
25950
diff
changeset
|
2544 regexps) will continue. If @var{laxmatch} is @code{nil}, and the |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
2545 specified subexpression is missing, then an error is signaled which |
25975
e368b754fe25
Add patch from rms around line 1870.
Gerd Moellmann <gerd@gnu.org>
parents:
25950
diff
changeset
|
2546 terminates search-based fontification. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2547 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2548 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
|
2549 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2550 @smallexample |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2551 ;; @r{Highlight occurrences of either @samp{foo} or @samp{bar}, using} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2552 ;; @r{@code{foo-bar-face}, even if they have already been highlighted.} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2553 ;; @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
|
2554 ("foo\\|bar" 0 foo-bar-face t) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2555 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
2556 ;; @r{Highlight the first subexpression within each occurrence} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2557 ;; @r{that the function @code{fubar-match} finds,} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2558 ;; @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
|
2559 (fubar-match 1 fubar-face) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2560 @end smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2561 |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2562 @item (@var{matcher} . @var{anchored-highlighter}) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2563 In this kind of element, @var{anchored-highlighter} specifies how to |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2564 highlight text that follows a match found by @var{matcher}. So a |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2565 match found by @var{matcher} acts as the anchor for further searches |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2566 specified by @var{anchored-highlighter}. @var{anchored-highlighter} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2567 is a list of the following form: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2568 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2569 @example |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2570 (@var{anchored-matcher} @var{pre-form} @var{post-form} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2571 @var{subexp-highlighters}@dots{}) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2572 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2573 |
61377
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2574 Here, @var{anchored-matcher}, like @var{matcher}, is either a regular |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2575 expression or a function. After a match of @var{matcher} is found, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2576 point is at the end of the match. Now, Font Lock evaluates the form |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2577 @var{pre-form}. Then it searches for matches of |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2578 @var{anchored-matcher} and uses @var{subexp-highlighters} to highlight |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2579 these. A @var{subexp-highlighter} is as described above. Finally, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2580 Font Lock evaluates @var{post-form}. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2581 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2582 The forms @var{pre-form} and @var{post-form} can be used to initialize |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2583 before, and cleanup after, @var{anchored-matcher} is used. Typically, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2584 @var{pre-form} is used to move point to some position relative to the |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2585 match of @var{matcher}, before starting with @var{anchored-matcher}. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2586 @var{post-form} might be used to move back, before resuming with |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2587 @var{matcher}. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2588 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2589 After Font Lock evaluates @var{pre-form}, it does not search for |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2590 @var{anchored-matcher} beyond the end of the line. However, if |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2591 @var{pre-form} returns a buffer position that is greater than the |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2592 position of point after @var{pre-form} is evaluated, then the position |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2593 returned by @var{pre-form} is used as the limit of the search instead. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2594 It is generally a bad idea to return a position greater than the end |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2595 of the line; in other words, the @var{anchored-matcher} search should |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2596 not span lines. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2597 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2598 For example, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2599 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2600 @smallexample |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2601 ;; @r{Highlight occurrences of the word @samp{item} following} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2602 ;; @r{an occurrence of the word @samp{anchor} (on the same line)} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2603 ;; @r{in the value of @code{item-face}.} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2604 ("\\<anchor\\>" "\\<item\\>" nil nil (0 item-face)) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2605 @end smallexample |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2606 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2607 Here, @var{pre-form} and @var{post-form} are @code{nil}. Therefore |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2608 searching for @samp{item} starts at the end of the match of |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2609 @samp{anchor}, and searching for subsequent instances of @samp{anchor} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2610 resumes from where searching for @samp{item} concluded. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2611 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2612 @item (@var{matcher} @var{highlighters}@dots{}) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2613 This sort of element specifies several @var{highlighter} lists for a |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2614 single @var{matcher}. A @var{highlighter} list can be of the type |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2615 @var{subexp-highlighter} or @var{anchored-highlighter} as described |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2616 above. |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2617 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2618 For example, |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2619 |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2620 @smallexample |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2621 ;; @r{Highlight occurrences of the word @samp{anchor} in the value} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2622 ;; @r{of @code{anchor-face}, and subsequent occurrences of the word} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2623 ;; @r{@samp{item} (on the same line) in the value of @code{item-face}.} |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2624 ("\\<anchor\\>" (0 anchor-face) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2625 ("\\<item\\>" nil nil (0 item-face))) |
d719a3a92aa5
(Search-based Fontification): Fix cross references.
Lute Kamstra <lute@gnu.org>
parents:
61322
diff
changeset
|
2626 @end smallexample |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2627 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2628 @item (eval . @var{form}) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2629 Here @var{form} is an expression to be evaluated the first time |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2630 this value of @code{font-lock-keywords} is used in a buffer. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2631 Its value should have one of the forms described in this table. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2632 @end table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2633 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2634 @strong{Warning:} Do not design an element of @code{font-lock-keywords} |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
2635 to match text which spans lines; this does not work reliably. |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
2636 For details, see @xref{Multiline Font Lock}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2637 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2638 You can use @var{case-fold} in @code{font-lock-defaults} to specify |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2639 the value of @code{font-lock-keywords-case-fold-search} which says |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2640 whether search-based fontification should be case-insensitive. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2641 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2642 @defvar font-lock-keywords-case-fold-search |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2643 Non-@code{nil} means that regular expression matching for the sake of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2644 @code{font-lock-keywords} should be case-insensitive. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2645 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2646 |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2647 @node Customizing Keywords |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2648 @subsection Customizing Search-Based Fontification |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2649 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2650 You can use @code{font-lock-add-keywords} to add additional |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2651 search-based fontification rules to a major mode, and |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2652 @code{font-lock-remove-keywords} to removes rules. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2653 |
67572
3ee5685f7930
(Customizing Keywords): Rename `append' to `how'.
Romain Francoise <romain@orebokech.com>
parents:
66935
diff
changeset
|
2654 @defun font-lock-add-keywords mode keywords &optional how |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2655 This function adds highlighting @var{keywords}, for the current buffer |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2656 or for major mode @var{mode}. The argument @var{keywords} should be a |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2657 list with the same format as the variable @code{font-lock-keywords}. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2658 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2659 If @var{mode} is a symbol which is a major mode command name, such as |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2660 @code{c-mode}, the effect is that enabling Font Lock mode in |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2661 @var{mode} will add @var{keywords} to @code{font-lock-keywords}. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2662 Calling with a non-@code{nil} value of @var{mode} is correct only in |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2663 your @file{~/.emacs} file. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2664 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2665 If @var{mode} is @code{nil}, this function adds @var{keywords} to |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2666 @code{font-lock-keywords} in the current buffer. This way of calling |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2667 @code{font-lock-add-keywords} is usually used in mode hook functions. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2668 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2669 By default, @var{keywords} are added at the beginning of |
67572
3ee5685f7930
(Customizing Keywords): Rename `append' to `how'.
Romain Francoise <romain@orebokech.com>
parents:
66935
diff
changeset
|
2670 @code{font-lock-keywords}. If the optional argument @var{how} is |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2671 @code{set}, they are used to replace the value of |
67572
3ee5685f7930
(Customizing Keywords): Rename `append' to `how'.
Romain Francoise <romain@orebokech.com>
parents:
66935
diff
changeset
|
2672 @code{font-lock-keywords}. If @var{how} is any other non-@code{nil} |
3ee5685f7930
(Customizing Keywords): Rename `append' to `how'.
Romain Francoise <romain@orebokech.com>
parents:
66935
diff
changeset
|
2673 value, they are added at the end of @code{font-lock-keywords}. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2674 |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2675 Some modes provide specialized support you can use in additional |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2676 highlighting patterns. See the variables |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2677 @code{c-font-lock-extra-types}, @code{c++-font-lock-extra-types}, |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
63133
diff
changeset
|
2678 and @code{java-font-lock-extra-types}, for example. |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2679 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2680 @strong{Warning:} major mode functions must not call |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2681 @code{font-lock-add-keywords} under any circumstances, either directly |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2682 or indirectly, except through their mode hooks. (Doing so would lead |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2683 to incorrect behavior for some minor modes.) They should set up their |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2684 rules for search-based fontification by setting |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2685 @code{font-lock-keywords}. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2686 @end defun |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2687 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2688 @defun font-lock-remove-keywords mode keywords |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2689 This function removes @var{keywords} from @code{font-lock-keywords} |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2690 for the current buffer or for major mode @var{mode}. As in |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2691 @code{font-lock-add-keywords}, @var{mode} should be a major mode |
67572
3ee5685f7930
(Customizing Keywords): Rename `append' to `how'.
Romain Francoise <romain@orebokech.com>
parents:
66935
diff
changeset
|
2692 command name or @code{nil}. All the caveats and requirements for |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2693 @code{font-lock-add-keywords} apply here too. |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2694 @end defun |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2695 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2696 For example, this code |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2697 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2698 @smallexample |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2699 (font-lock-add-keywords 'c-mode |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2700 '(("\\<\\(FIXME\\):" 1 font-lock-warning-face prepend) |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2701 ("\\<\\(and\\|or\\|not\\)\\>" . font-lock-keyword-face))) |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2702 @end smallexample |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2703 |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2704 @noindent |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2705 adds two fontification patterns for C mode: one to fontify the word |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2706 @samp{FIXME}, even in comments, and another to fontify the words |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2707 @samp{and}, @samp{or} and @samp{not} as keywords. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2708 |
63133
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2709 @noindent |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2710 That example affects only C mode proper. To add the same patterns to |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2711 C mode @emph{and} all modes derived from it, do this instead: |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2712 |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2713 @smallexample |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2714 (add-hook 'c-mode-hook |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2715 (lambda () |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2716 (font-lock-add-keywords nil |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2717 '(("\\<\\(FIXME\\):" 1 font-lock-warning-face prepend) |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2718 ("\\<\\(and\\|or\\|not\\)\\>" . |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2719 font-lock-keyword-face))))) |
2244564c10de
(Mode Line Data): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
62876
diff
changeset
|
2720 @end smallexample |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2721 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2722 @node Other Font Lock Variables |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2723 @subsection Other Font Lock Variables |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2724 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2725 This section describes additional variables that a major mode can |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2726 set by means of @var{other-vars} in @code{font-lock-defaults} |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2727 (@pxref{Font Lock Basics}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2728 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2729 @defvar font-lock-mark-block-function |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2730 If this variable is non-@code{nil}, it should be a function that is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2731 called with no arguments, to choose an enclosing range of text for |
61034
38d95bf39f6e
(Other Font Lock Variables): font-lock-fontify-block is now bound to M-o M-o.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60784
diff
changeset
|
2732 refontification for the command @kbd{M-o M-o} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2733 (@code{font-lock-fontify-block}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2734 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2735 The function should report its choice by placing the region around it. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2736 A good choice is a range of text large enough to give proper results, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2737 but not too large so that refontification becomes slow. Typical values |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2738 are @code{mark-defun} for programming modes or @code{mark-paragraph} for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2739 textual modes. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2740 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2741 |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2742 @defvar font-lock-extra-managed-props |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2743 This variable specifies additional properties (other than |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2744 @code{font-lock-face}) that are being managed by Font Lock mode. It |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2745 is used by @code{font-lock-default-unfontify-region}, which normally |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2746 only manages the @code{font-lock-face} property. If you want Font |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2747 Lock to manage other properties as well, you must specify them in a |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2748 @var{facespec} in @code{font-lock-keywords} as well as add them to |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2749 this list. @xref{Search-based Fontification}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2750 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2751 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2752 @defvar font-lock-fontify-buffer-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2753 Function to use for fontifying the buffer. The default value is |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2754 @code{font-lock-default-fontify-buffer}. |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2755 @end defvar |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2756 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2757 @defvar font-lock-unfontify-buffer-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2758 Function to use for unfontifying the buffer. This is used when |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2759 turning off Font Lock mode. The default value is |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2760 @code{font-lock-default-unfontify-buffer}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2761 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2762 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2763 @defvar font-lock-fontify-region-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2764 Function to use for fontifying a region. It should take two |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2765 arguments, the beginning and end of the region, and an optional third |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2766 argument @var{verbose}. If @var{verbose} is non-@code{nil}, the |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2767 function should print status messages. The default value is |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2768 @code{font-lock-default-fontify-region}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2769 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2770 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2771 @defvar font-lock-unfontify-region-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2772 Function to use for unfontifying a region. It should take two |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2773 arguments, the beginning and end of the region. The default value is |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2774 @code{font-lock-default-unfontify-region}. |
52956
667459455d3c
Document the existance of font-lock-syntactic-face-function and
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52859
diff
changeset
|
2775 @end defvar |
667459455d3c
Document the existance of font-lock-syntactic-face-function and
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52859
diff
changeset
|
2776 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2777 @ignore |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2778 @defvar font-lock-inhibit-thing-lock |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2779 List of Font Lock mode related modes that should not be turned on. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2780 Currently, valid mode names are @code{fast-lock-mode}, |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2781 @code{jit-lock-mode} and @code{lazy-lock-mode}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2782 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2783 @end ignore |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2784 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2785 @node Levels of Font Lock |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2786 @subsection Levels of Font Lock |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2787 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2788 Many major modes offer three different levels of fontification. You |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2789 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
|
2790 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
|
2791 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
|
2792 chosen level's symbol value is used to initialize |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2793 @code{font-lock-keywords}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2794 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2795 Here are the conventions for how to define the levels of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2796 fontification: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2797 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2798 @itemize @bullet |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2799 @item |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2800 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
|
2801 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
|
2802 the most important and top-level components are fontified. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2803 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2804 @item |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2805 Level 2: in addition to level 1, highlight all language keywords, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2806 including type names that act like keywords, as well as named constant |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2807 values. The idea is that all keywords (either syntactic or semantic) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2808 should be fontified appropriately. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2809 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2810 @item |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2811 Level 3: in addition to level 2, highlight the symbols being defined in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2812 function and variable declarations, and all builtin function names, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2813 wherever they appear. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2814 @end itemize |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2815 |
45684
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2816 @node Precalculated Fontification |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2817 @subsection Precalculated Fontification |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2818 |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2819 In addition to using @code{font-lock-defaults} for search-based |
45684
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2820 fontification, you may use the special character property |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2821 @code{font-lock-face} (@pxref{Special Properties}). This property |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2822 acts just like the explicit @code{face} property, but its activation |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2823 is toggled when the user calls @kbd{M-x font-lock-mode}. Using |
52628
74d358d76ea8
(Mode Line Data): Document the :propertize construct.
Lute Kamstra <lute@gnu.org>
parents:
52463
diff
changeset
|
2824 @code{font-lock-face} is especially convenient for special modes |
45684
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2825 which construct their text programmatically, such as |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2826 @code{list-buffers} and @code{occur}. |
6f73f208b4ce
(Precalcuated Fontification): New node, describing `font-lock-face'.
Colin Walters <walters@gnu.org>
parents:
43677
diff
changeset
|
2827 |
45714
7057566fa4c1
(Precalcuated Fontification): Note how to use `font-lock-core-only'.
Colin Walters <walters@gnu.org>
parents:
45684
diff
changeset
|
2828 If your mode does not use any of the other machinery of Font Lock |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2829 (i.e. it only uses the @code{font-lock-face} property), it should not |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2830 set the variable @code{font-lock-defaults}. That way, it will not |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2831 cause loading of the @file{font-lock} library. |
45714
7057566fa4c1
(Precalcuated Fontification): Note how to use `font-lock-core-only'.
Colin Walters <walters@gnu.org>
parents:
45684
diff
changeset
|
2832 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2833 @node Faces for Font Lock |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2834 @subsection Faces for Font Lock |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2835 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2836 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
|
2837 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
|
2838 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
|
2839 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
|
2840 @code{font-lock-comment-face}. This means you can write |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2841 @code{font-lock-comment-face} in a context such as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2842 @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
|
2843 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2844 @table @code |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2845 @item font-lock-comment-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2846 @vindex font-lock-comment-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2847 Used (typically) for comments. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2848 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2849 @item font-lock-comment-delimiter-face |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2850 @vindex font-lock-comment-delimiter-face |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2851 Used (typically) for comments delimiters. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2852 |
59942
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2853 @item font-lock-doc-face |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2854 @vindex font-lock-doc-face |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2855 Used (typically) for documentation strings in the code. |
1f6a9cf44999
(Major Mode Conventions): Mention "system abbrevs".
Richard M. Stallman <rms@gnu.org>
parents:
59516
diff
changeset
|
2856 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2857 @item font-lock-string-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2858 @vindex font-lock-string-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2859 Used (typically) for string constants. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2860 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2861 @item font-lock-keyword-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2862 @vindex font-lock-keyword-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2863 Used (typically) for keywords---names that have special syntactic |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2864 significance, like @code{for} and @code{if} in C. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2865 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2866 @item font-lock-builtin-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2867 @vindex font-lock-builtin-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2868 Used (typically) for built-in function names. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2869 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2870 @item font-lock-function-name-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2871 @vindex font-lock-function-name-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2872 Used (typically) for the name of a function being defined or declared, |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48700
diff
changeset
|
2873 in a function definition or declaration. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2874 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2875 @item font-lock-variable-name-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2876 @vindex font-lock-variable-name-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2877 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
|
2878 in a variable definition or declaration. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2879 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2880 @item font-lock-type-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2881 @vindex font-lock-type-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2882 Used (typically) for names of user-defined data types, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2883 where they are defined and where they are used. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2884 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2885 @item font-lock-constant-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2886 @vindex font-lock-constant-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2887 Used (typically) for constant names. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2888 |
52800
d738115b4197
(Faces for Font Lock): Fix typo.
Lute Kamstra <lute@gnu.org>
parents:
52744
diff
changeset
|
2889 @item font-lock-preprocessor-face |
d738115b4197
(Faces for Font Lock): Fix typo.
Lute Kamstra <lute@gnu.org>
parents:
52744
diff
changeset
|
2890 @vindex font-lock-preprocessor-face |
51917
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2891 Used (typically) for preprocessor commands. |
3039afbb0746
(Major Mode Conventions): Explain about run-mode-hooks and about derived modes.
Richard M. Stallman <rms@gnu.org>
parents:
51794
diff
changeset
|
2892 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2893 @item font-lock-warning-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2894 @vindex font-lock-warning-face |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2895 Used (typically) for constructs that are peculiar, or that greatly |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2896 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
|
2897 @samp{;;;###autoload} cookies in Emacs Lisp, and for @code{#error} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2898 directives in C. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2899 @end table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17278
diff
changeset
|
2900 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2901 @node Syntactic Font Lock |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2902 @subsection Syntactic Font Lock |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2903 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2904 Syntactic fontification uses the syntax table to find comments and |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2905 string constants (@pxref{Syntax Tables}). It highlights them using |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2906 @code{font-lock-comment-face} and @code{font-lock-string-face} |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2907 (@pxref{Faces for Font Lock}). There are several variables that |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2908 affect syntactic fontification; you should set them by means of |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2909 @code{font-lock-defaults} (@pxref{Font Lock Basics}). |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2910 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2911 @defvar font-lock-keywords-only |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2912 Non-@code{nil} means Font Lock should not do syntactic fontification; |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2913 it should only fontify based on @code{font-lock-keywords}. The normal |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2914 way for a mode to set this variable to @code{t} is with |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2915 @var{keywords-only} in @code{font-lock-defaults}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2916 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2917 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2918 @defvar font-lock-syntax-table |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2919 This variable holds the syntax table to use for fontification of |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2920 comments and strings. Specify it using @var{syntax-alist} in |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2921 @code{font-lock-defaults}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2922 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2923 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2924 @defvar font-lock-beginning-of-syntax-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2925 If this variable is non-@code{nil}, it should be a function to move |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2926 point back to a position that is syntactically at ``top level'' and |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2927 outside of strings or comments. Font Lock uses this when necessary |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2928 to get the right results for syntactic fontification. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2929 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2930 This function is called with no arguments. It should leave point at |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2931 the beginning of any enclosing syntactic block. Typical values are |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2932 @code{beginning-of-line} (used when the start of the line is known to |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2933 be outside a syntactic block), or @code{beginning-of-defun} for |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2934 programming modes, or @code{backward-paragraph} for textual modes. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2935 |
62652
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2936 If the value is @code{nil}, Font Lock uses |
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2937 @code{syntax-begin-function} to move back outside of any comment, |
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2938 string, or sexp. This variable is semi-obsolete; we recommend setting |
e89d01c0c1c4
(Font Lock Basics, Syntactic Font Lock): Recommend
Lute Kamstra <lute@gnu.org>
parents:
62594
diff
changeset
|
2939 @code{syntax-begin-function} instead. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2940 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2941 Specify this variable using @var{syntax-begin} in |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2942 @code{font-lock-defaults}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2943 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2944 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2945 @defvar font-lock-syntactic-face-function |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2946 A function to determine which face to use for a given syntactic |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2947 element (a string or a comment). The function is called with one |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2948 argument, the parse state at point returned by |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2949 @code{parse-partial-sexp}, and should return a face. The default |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2950 value returns @code{font-lock-comment-face} for comments and |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2951 @code{font-lock-string-face} for strings. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2952 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2953 This can be used to highlighting different kinds of strings or |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2954 comments differently. It is also sometimes abused together with |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
2955 @code{font-lock-syntactic-keywords} to highlight constructs that span |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
2956 multiple lines, but this is too esoteric to document here. |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2957 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2958 Specify this variable using @var{other-vars} in |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2959 @code{font-lock-defaults}. |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2960 @end defvar |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2961 |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2962 @node Setting Syntax Properties |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2963 @subsection Setting Syntax Properties |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2964 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2965 Font Lock mode can be used to update @code{syntax-table} properties |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2966 automatically (@pxref{Syntax Properties}). This is useful in |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2967 languages for which a single syntax table by itself is not sufficient. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2968 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2969 @defvar font-lock-syntactic-keywords |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2970 This variable enables and controls updating @code{syntax-table} |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2971 properties by Font Lock. Its value should be a list of elements of |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2972 this form: |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2973 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2974 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2975 (@var{matcher} @var{subexp} @var{syntax} @var{override} @var{laxmatch}) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2976 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2977 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2978 The parts of this element have the same meanings as in the corresponding |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2979 sort of element of @code{font-lock-keywords}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2980 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2981 @example |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2982 (@var{matcher} @var{subexp} @var{facespec} @var{override} @var{laxmatch}) |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2983 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2984 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
2985 However, instead of specifying the value @var{facespec} to use for the |
50693
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2986 @code{face} property, it specifies the value @var{syntax} to use for |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2987 the @code{syntax-table} property. Here, @var{syntax} can be a string |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2988 (as taken by @code{modify-syntax-entry}), a syntax table, a cons cell |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2989 (as returned by @code{string-to-syntax}), or an expression whose value |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2990 is one of those two types. @var{override} cannot be @code{prepend} or |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2991 @code{append}. |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2992 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2993 For example, an element of the form: |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2994 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2995 @example |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2996 ("\\$\\(#\\)" 1 ".") |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2997 @end example |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2998 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
2999 highlights syntactically a hash character when following a dollar |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3000 character, with a SYNTAX of @code{"."} (meaning punctuation syntax). |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3001 Assuming that the buffer syntax table specifies hash characters to |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3002 have comment start syntax, the element will only highlight hash |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3003 characters that do not follow dollar characters as comments |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3004 syntactically. |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3005 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3006 An element of the form: |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3007 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3008 @example |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3009 ("\\('\\).\\('\\)" |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3010 (1 "\"") |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3011 (2 "\"")) |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3012 @end example |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3013 |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3014 highlights syntactically both single quotes which surround a single |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3015 character, with a SYNTAX of @code{"\""} (meaning string quote syntax). |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3016 Assuming that the buffer syntax table does not specify single quotes |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3017 to have quote syntax, the element will only highlight single quotes of |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3018 the form @samp{'@var{c}'} as strings syntactically. Other forms, such |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3019 as @samp{foo'bar} or @samp{'fubar'}, will not be highlighted as |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3020 strings. |
17c60796aa6a
(font-lock-syntactic-keywords): Fix/expand description.
Dave Love <fx@gnu.org>
parents:
49600
diff
changeset
|
3021 |
61906
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
3022 Major modes normally set this variable with @var{other-vars} in |
1210b12b4089
(Defining Minor Modes): Fix previous change.
Lute Kamstra <lute@gnu.org>
parents:
61853
diff
changeset
|
3023 @code{font-lock-defaults}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3024 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3025 |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3026 @node Multiline Font Lock |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3027 @subsection Multiline Font Lock Constructs |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3028 @cindex multiline font lock |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3029 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3030 Normally, elements of @code{font-lock-keywords} should not match |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3031 across multiple lines; that doesn't work reliably, because Font Lock |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3032 usually scans just part of the buffer, and it can miss a multi-line |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3033 construct that crosses the line boundary where the scan starts. (The |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3034 scan normally starts at the beginning of a line.) |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3035 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3036 Making elements that match multiline constructs work properly has |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3037 two aspects: correct @emph{identification} and correct |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3038 @emph{rehighlighting}. The first means that Font Lock finds all |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3039 multiline constructs. The second means that Font Lock will correctly |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3040 rehighlight all the relevant text when a multiline construct is |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3041 changed---for example, if some of the text that was previously part of |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3042 a multiline construct ceases to be part of it. The two aspects are |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3043 closely related, and often getting one of them to work will appear to |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3044 make the other also work. However, for reliable results you must |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3045 attend explicitly to both aspects. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3046 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3047 There are two ways to ensure correct identification of multiline |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3048 constructs: |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3049 |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3050 @itemize |
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3051 @item |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3052 Place a @code{font-lock-multiline} or @code{jit-lock-defer-multiline} |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3053 property on the construct when it is added to the buffer. |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3054 @item |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3055 Use @code{font-lock-fontify-region-function} hook to extend the scan |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3056 so that the scanned text never starts or ends in the middle of a |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3057 multiline construct. |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3058 @end itemize |
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3059 |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3060 There are three ways to do rehighlighting of multiline constructs: |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3061 |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3062 @itemize |
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3063 @item |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3064 Place a @code{font-lock-multiline} property on the construct. This |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3065 will rehighlight the whole construct if any part of it is changed. In |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3066 some cases you can do this automatically by setting the |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3067 @code{font-lock-multiline} variable. |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3068 @item |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3069 Use @code{jit-lock-contextually}. This will only rehighlight the part |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3070 of the construct that follows the actual change, and will do it after |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3071 a short delay. This only works if the highlighting of the various |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3072 parts of your multiline construct never depends on text in subsequent |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3073 lines. Since @code{jit-lock-contextually} is activated by default, |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3074 this can be an attractive solution. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3075 @item |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3076 Place a @code{jit-lock-defer-multiline} property on the construct. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3077 This works only if @code{jit-lock-contextually} is used, but it can |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3078 handle the case where highlighting depends on subsequent lines. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3079 @item |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3080 @end itemize |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3081 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3082 @menu |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3083 * Font Lock Multiline:: Marking multiline chunks with a text property |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3084 * Region to Fontify:: Controlling which region gets refontified |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3085 after a buffer change. |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3086 @end menu |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3087 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3088 @node Font Lock Multiline |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3089 @subsubsection Font Lock Multiline |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3090 |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3091 One way to ensure reliable rehighlighting of multiline Font Lock |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3092 constructs is to put on the text property @code{font-lock-multiline}. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3093 It should be present and non-@code{nil} for text that is part of a |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3094 multiline construct. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3095 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3096 When Font Lock is about to highlight a range of text, it first |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3097 extends the boundaries of the range as necessary so that they do not |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3098 fall within text marked with the @code{font-lock-multiline} property. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3099 Then it removes any @code{font-lock-multiline} properties from the |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3100 range, and highlights it. The highlighting specification (mostly |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3101 @code{font-lock-keywords}) must reinstall this property each time, |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3102 whenever it is appropriate. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3103 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3104 @strong{Warning:} don't use the @code{font-lock-multiline} property |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3105 on large ranges of text, because that will make rehighlighting slow. |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3106 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3107 @defvar font-lock-multiline |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3108 If the @code{font-lock-multiline} variable is set to @code{t}, Font |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3109 Lock will try to add the @code{font-lock-multiline} property |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3110 automatically on multiline constructs. This is not a universal |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3111 solution, however, since it slows down Font Lock somewhat. It can |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3112 miss some multiline constructs, or make the property larger or smaller |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3113 than necessary. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3114 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3115 For elements whose @var{matcher} is a function, the function should |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3116 ensure that submatch 0 covers the whole relevant multiline construct, |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3117 even if only a small subpart will be highlighted. It is often just as |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3118 easy to add the @code{font-lock-multiline} property by hand. |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3119 @end defvar |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3120 |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3121 The @code{font-lock-multiline} property is meant to ensure proper |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3122 refontification; it does not automatically identify new multiline |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3123 constructs. Identifying the requires that Font-Lock operate on large |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3124 enough chunks at a time. This will happen by accident on many cases, |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3125 which may give the impression that multiline constructs magically work. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3126 If you set the @code{font-lock-multiline} variable non-@code{nil}, |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3127 this impression will be even stronger, since the highlighting of those |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3128 constructs which are found will be properly updated from then on. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3129 But that does not work reliably. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3130 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3131 To find multiline constructs reliably, you must either manually |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3132 place the @code{font-lock-multiline} property on the text before |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3133 Font-Lock looks at it, or use |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3134 @code{font-lock-fontify-region-function}. |
70275
3d36e736dc2a
Improve the documentation of how to hilight multiline elements.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70223
diff
changeset
|
3135 |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3136 @node Region to Fontify |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3137 @subsubsection Region to Fontify after a Buffer Change |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3138 |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3139 When a buffer is changed, the region that Font Lock refontifies is |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3140 by default the smallest sequence of whole lines that spans the change. |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3141 While this works well most of the time, sometimes it doesn't---for |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3142 example, when a change alters the syntactic meaning of text on an |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3143 earlier line. |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3144 |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3145 You can enlarge (or even reduce) the region to fontify by setting |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3146 one the following variables: |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3147 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3148 @defvar font-lock-extend-region-function |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3149 This buffer-local variable is either @code{nil} or a function for |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3150 Font-Lock to call to determine the region to scan and fontify. |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3151 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3152 The function is given three parameters, the standard @var{beg}, |
70289
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3153 @var{end}, and @var{old-len} from after-change-functions |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3154 (@pxref{Change Hooks}). It should return either a cons of the |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3155 beginning and end buffer positions (in that order) of the region to |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3156 fontify, or @code{nil} (which means choose the region in the standard |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3157 way). This function needs to preserve point, the match-data, and the |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3158 current restriction. The region it returns may start or end in the |
608b16c56304
(Multiline Font Lock): Renamed from Multi line Font Lock Elements.
Richard M. Stallman <rms@gnu.org>
parents:
70275
diff
changeset
|
3159 middle of a line. |
70208
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3160 |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3161 Since this function is called after every buffer change, it should be |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3162 reasonably fast. |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3163 @end defvar |
d96cefbe70c2
Add documentation about font-lock-multiline.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
70088
diff
changeset
|
3164 |
55414 | 3165 @node Desktop Save Mode |
3166 @section Desktop Save Mode | |
3167 @cindex desktop save mode | |
3168 | |
3169 @dfn{Desktop Save Mode} is a feature to save the state of Emacs from | |
3170 one session to another. The user-level commands for using Desktop | |
3171 Save Mode are described in the GNU Emacs Manual (@pxref{Saving Emacs | |
3172 Sessions,,, emacs, the GNU Emacs Manual}). Modes whose buffers visit | |
3173 a file, don't have to do anything to use this feature. | |
3174 | |
3175 For buffers not visiting a file to have their state saved, the major | |
3176 mode must bind the buffer local variable @code{desktop-save-buffer} to | |
57213
3497eca006fe
Various minor changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents:
56768
diff
changeset
|
3177 a non-@code{nil} value. |
55414 | 3178 |
3179 @defvar desktop-save-buffer | |
3180 If this buffer-local variable is non-@code{nil}, the buffer will have | |
3181 its state saved in the desktop file at desktop save. If the value is | |
3182 a function, it is called at desktop save with argument | |
3183 @var{desktop-dirname}, and its value is saved in the desktop file along | |
3184 with the state of the buffer for which it was called. When file names | |
3185 are returned as part of the auxiliary information, they should be | |
3186 formatted using the call | |
3187 | |
3188 @example | |
3189 (desktop-file-name @var{file-name} @var{desktop-dirname}) | |
3190 @end example | |
3191 | |
3192 @end defvar | |
3193 | |
3194 For buffers not visiting a file to be restored, the major mode must | |
3195 define a function to do the job, and that function must be listed in | |
3196 the alist @code{desktop-buffer-mode-handlers}. | |
3197 | |
3198 @defvar desktop-buffer-mode-handlers | |
3199 Alist with elements | |
3200 | |
3201 @example | |
3202 (@var{major-mode} . @var{restore-buffer-function}) | |
3203 @end example | |
3204 | |
3205 The function @var{restore-buffer-function} will be called with | |
3206 argument list | |
3207 | |
3208 @example | |
3209 (@var{buffer-file-name} @var{buffer-name} @var{desktop-buffer-misc}) | |
3210 @end example | |
3211 | |
3212 and it should return the restored buffer. | |
3213 Here @var{desktop-buffer-misc} is the value returned by the function | |
3214 optionally bound to @code{desktop-save-buffer}. | |
3215 @end defvar | |
3216 | |
52401 | 3217 @ignore |
3218 arch-tag: 4c7bff41-36e6-4da6-9e7f-9b9289e27c8e | |
3219 @end ignore |