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