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