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