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