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