Mercurial > emacs
annotate lispref/advice.texi @ 61977:4039ddc27a88
(function-key-map): Call substitute-key-definition
before the keymap size keymap is increased by a lot of define-key
calls.
author | Dan Nicolaescu <dann@ics.uci.edu> |
---|---|
date | Sun, 01 May 2005 16:37:19 +0000 |
parents | dd9ce828300e |
children | a489093cf10b e4694597cbf4 |
rev | line source |
---|---|
21681 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39216
diff
changeset
|
3 @c Copyright (C) 1998, 1999 Free Software Foundation, Inc. |
21681 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/advising | |
6 @node Advising Functions, Debugging, Byte Compilation, Top | |
7 @chapter Advising Emacs Lisp Functions | |
8 @cindex advising functions | |
9 | |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
10 The @dfn{advice} feature lets you add to the existing definition of |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
11 a function, by @dfn{advising the function}. This is a clean method |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
12 for a library to customize functions defined within Emacs---cleaner |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
13 than redefining the whole function. |
21681 | 14 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
15 @cindex piece of advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
16 Each function can have multiple @dfn{pieces of advice}, separately |
39169 | 17 defined. Each defined piece of advice can be @dfn{enabled} or |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
18 @dfn{disabled} explicitly. All the enabled pieces of advice for any given |
39169 | 19 function actually take effect when you @dfn{activate} advice for that |
20 function, or when you define or redefine the function. Note that | |
21 enabling a piece of advice and activating advice for a function | |
22 are not the same thing. | |
21681 | 23 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
24 @strong{Usage Note:} Advice is useful for altering the behavior of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
25 existing calls to an existing function. If you want the new behavior |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
26 for new calls, or for key bindings, it is cleaner to define a new |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
27 function (or a new command) which uses the existing function. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
28 |
21681 | 29 @menu |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
30 * Simple Advice:: A simple example to explain the basics of advice. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
31 * Defining Advice:: Detailed description of @code{defadvice}. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
32 * Around-Advice:: Wrapping advice around a function's definition. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
33 * Computed Advice:: ...is to @code{defadvice} as @code{fset} is to @code{defun}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
34 * Activation of Advice:: Advice doesn't do anything until you activate it. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
35 * Enabling Advice:: You can enable or disable each piece of advice. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
36 * Preactivation:: Preactivation is a way of speeding up the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
37 loading of compiled advice. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
38 * Argument Access in Advice:: How advice can access the function's arguments. |
51651
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
39 * Advising Primitives:: Accessing arguments when advising a primitive. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
40 * Combined Definition:: How advice is implemented. |
21681 | 41 @end menu |
42 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
43 @node Simple Advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
44 @section A Simple Advice Example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
45 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
46 The command @code{next-line} moves point down vertically one or more |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
47 lines; it is the standard binding of @kbd{C-n}. When used on the last |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
48 line of the buffer, this command inserts a newline to create a line to |
34103 | 49 move to if @code{next-line-add-newlines} is non-@code{nil} (its default |
50 is @code{nil}.) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
51 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
52 Suppose you wanted to add a similar feature to @code{previous-line}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
53 which would insert a new line at the beginning of the buffer for the |
57740
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
54 command to move to (when @code{next-line-add-newlines} is |
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
55 non-@code{nil}). How could you do this? |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
56 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
57 You could do it by redefining the whole function, but that is not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
58 modular. The advice feature provides a cleaner alternative: you can |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
59 effectively add your code to the existing function definition, without |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
60 actually changing or even seeing that definition. Here is how to do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
61 this: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
62 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
63 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
64 (defadvice previous-line (before next-line-at-end (arg)) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
65 "Insert an empty line when moving up from the top line." |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
66 (if (and next-line-add-newlines (= arg 1) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
67 (save-excursion (beginning-of-line) (bobp))) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
68 (progn |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
69 (beginning-of-line) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
70 (newline)))) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
71 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
72 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
73 This expression defines a @dfn{piece of advice} for the function |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
74 @code{previous-line}. This piece of advice is named |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
75 @code{next-line-at-end}, and the symbol @code{before} says that it is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
76 @dfn{before-advice} which should run before the regular definition of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
77 @code{previous-line}. @code{(arg)} specifies how the advice code can |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
78 refer to the function's arguments. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
79 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
80 When this piece of advice runs, it creates an additional line, in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
81 situation where that is appropriate, but does not move point to that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
82 line. This is the correct way to write the advice, because the normal |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
83 definition will run afterward and will move back to the newly inserted |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
84 line. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
85 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
86 Defining the advice doesn't immediately change the function |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
87 @code{previous-line}. That happens when you @dfn{activate} the advice, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
88 like this: |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
89 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
90 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
91 (ad-activate 'previous-line) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
92 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
93 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
94 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
95 This is what actually begins to use the advice that has been defined so |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
96 far for the function @code{previous-line}. Henceforth, whenever that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
97 function is run, whether invoked by the user with @kbd{C-p} or |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
98 @kbd{M-x}, or called from Lisp, it runs the advice first, and its |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
99 regular definition second. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
100 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
101 This example illustrates before-advice, which is one @dfn{class} of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
102 advice: it runs before the function's base definition. There are two |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
103 other advice classes: @dfn{after-advice}, which runs after the base |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
104 definition, and @dfn{around-advice}, which lets you specify an |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
105 expression to wrap around the invocation of the base definition. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
106 |
21681 | 107 @node Defining Advice |
108 @section Defining Advice | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
109 @cindex defining advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
110 @cindex advice, defining |
21681 | 111 |
112 To define a piece of advice, use the macro @code{defadvice}. A call | |
113 to @code{defadvice} has the following syntax, which is based on the | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
114 syntax of @code{defun} and @code{defmacro}, but adds more: |
21681 | 115 |
116 @findex defadvice | |
117 @example | |
118 (defadvice @var{function} (@var{class} @var{name} | |
119 @r{[}@var{position}@r{]} @r{[}@var{arglist}@r{]} | |
120 @var{flags}...) | |
121 @r{[}@var{documentation-string}@r{]} | |
122 @r{[}@var{interactive-form}@r{]} | |
123 @var{body-forms}...) | |
124 @end example | |
125 | |
126 @noindent | |
127 Here, @var{function} is the name of the function (or macro or special | |
128 form) to be advised. From now on, we will write just ``function'' when | |
129 describing the entity being advised, but this always includes macros and | |
130 special forms. | |
131 | |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
132 In place of the argument list in an ordinary definition, an advice |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
133 definition calls for several different pieces of information. |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
134 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
135 @cindex class of advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
136 @cindex before-advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
137 @cindex after-advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
138 @cindex around-advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
139 @var{class} specifies the @dfn{class} of the advice---one of @code{before}, |
21681 | 140 @code{after}, or @code{around}. Before-advice runs before the function |
141 itself; after-advice runs after the function itself; around-advice is | |
142 wrapped around the execution of the function itself. After-advice and | |
143 around-advice can override the return value by setting | |
144 @code{ad-return-value}. | |
145 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
146 @defvar ad-return-value |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
147 While advice is executing, after the function's original definition has |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
148 been executed, this variable holds its return value, which will |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
149 ultimately be returned to the caller after finishing all the advice. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
150 After-advice and around-advice can arrange to return some other value |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
151 by storing it in this variable. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
152 @end defvar |
21681 | 153 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
154 The argument @var{name} is the name of the advice, a non-@code{nil} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
155 symbol. The advice name uniquely identifies one piece of advice, within all |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
156 the pieces of advice in a particular class for a particular |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
157 @var{function}. The name allows you to refer to the piece of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
158 advice---to redefine it, or to enable or disable it. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
159 |
21681 | 160 The optional @var{position} specifies where, in the current list of |
161 advice of the specified @var{class}, this new advice should be placed. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
162 It should be either @code{first}, @code{last} or a number that specifies |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
163 a zero-based position (@code{first} is equivalent to 0). If no position |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
164 is specified, the default is @code{first}. Position values outside the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
165 range of existing positions in this class are mapped to the beginning or |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
166 the end of the range, whichever is closer. The @var{position} value is |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
167 ignored when redefining an existing piece of advice. |
21681 | 168 |
169 The optional @var{arglist} can be used to define the argument list for | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
170 the sake of advice. This becomes the argument list of the combined |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
171 definition that is generated in order to run the advice (@pxref{Combined |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
172 Definition}). Therefore, the advice expressions can use the argument |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
173 variables in this list to access argument values. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
174 |
25875 | 175 The argument list used in advice need not be the same as the argument |
176 list used in the original function, but must be compatible with it, so | |
177 that it can handle the ways the function is actually called. If two | |
178 pieces of advice for a function both specify an argument list, they must | |
179 specify the same argument list. | |
21681 | 180 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
181 @xref{Argument Access in Advice}, for more information about argument |
25875 | 182 lists and advice, and a more flexible way for advice to access the |
183 arguments. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
184 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
185 The remaining elements, @var{flags}, are symbols that specify further |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
186 information about how to use this piece of advice. Here are the valid |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
187 symbols and their meanings: |
21681 | 188 |
189 @table @code | |
190 @item activate | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
191 Activate the advice for @var{function} now. Changes in a function's |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
192 advice always take effect the next time you activate advice for the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
193 function; this flag says to do so, for @var{function}, immediately after |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
194 defining this piece of advice. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
195 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
196 @cindex forward advice |
39169 | 197 This flag has no immediate effect if @var{function} itself is not defined yet (a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
198 situation known as @dfn{forward advice}), because it is impossible to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
199 activate an undefined function's advice. However, defining |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
200 @var{function} will automatically activate its advice. |
21681 | 201 |
202 @item protect | |
203 Protect this piece of advice against non-local exits and errors in | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
204 preceding code and advice. Protecting advice places it as a cleanup in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
205 an @code{unwind-protect} form, so that it will execute even if the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
206 previous code gets an error or uses @code{throw}. @xref{Cleanups}. |
21681 | 207 |
208 @item compile | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
209 Compile the combined definition that is used to run the advice. This |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
210 flag is ignored unless @code{activate} is also specified. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
211 @xref{Combined Definition}. |
21681 | 212 |
213 @item disable | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
214 Initially disable this piece of advice, so that it will not be used |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
215 unless subsequently explicitly enabled. @xref{Enabling Advice}. |
21681 | 216 |
217 @item preactivate | |
218 Activate advice for @var{function} when this @code{defadvice} is | |
219 compiled or macroexpanded. This generates a compiled advised definition | |
220 according to the current advice state, which will be used during | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
221 activation if appropriate. @xref{Preactivation}. |
21681 | 222 |
223 This is useful only if this @code{defadvice} is byte-compiled. | |
224 @end table | |
225 | |
226 The optional @var{documentation-string} serves to document this piece of | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
227 advice. When advice is active for @var{function}, the documentation for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
228 @var{function} (as returned by @code{documentation}) combines the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
229 documentation strings of all the advice for @var{function} with the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
230 documentation string of its original function definition. |
21681 | 231 |
232 The optional @var{interactive-form} form can be supplied to change the | |
233 interactive behavior of the original function. If more than one piece | |
234 of advice has an @var{interactive-form}, then the first one (the one | |
235 with the smallest position) found among all the advice takes precedence. | |
236 | |
237 The possibly empty list of @var{body-forms} specifies the body of the | |
238 advice. The body of an advice can access or change the arguments, the | |
239 return value, the binding environment, and perform any other kind of | |
240 side effect. | |
241 | |
242 @strong{Warning:} When you advise a macro, keep in mind that macros are | |
243 expanded when a program is compiled, not when a compiled program is run. | |
244 All subroutines used by the advice need to be available when the byte | |
245 compiler expands the macro. | |
246 | |
26178 | 247 @deffn Command ad-unadvise function |
248 This command deletes the advice from @var{function}. | |
249 @end deffn | |
250 | |
251 @deffn Command ad-unadvise-all | |
252 This command deletes all pieces of advice from all functions. | |
253 @end deffn | |
254 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
255 @node Around-Advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
256 @section Around-Advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
257 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
258 Around-advice lets you ``wrap'' a Lisp expression ``around'' the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
259 original function definition. You specify where the original function |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
260 definition should go by means of the special symbol @code{ad-do-it}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
261 Where this symbol occurs inside the around-advice body, it is replaced |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
262 with a @code{progn} containing the forms of the surrounded code. Here |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
263 is an example: |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
264 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
265 @example |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
266 (defadvice foo (around foo-around) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
267 "Ignore case in `foo'." |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
268 (let ((case-fold-search t)) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
269 ad-do-it)) |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
270 @end example |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
271 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
272 @noindent |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
273 Its effect is to make sure that case is ignored in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
274 searches when the original definition of @code{foo} is run. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
275 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
276 @defvar ad-do-it |
57740
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
277 This is not really a variable, rather a place-holder that looks like a |
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
278 variable. You use it in around-advice to specify the place to run the |
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
279 function's original definition and other ``earlier'' around-advice. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
280 @end defvar |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
281 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
282 If the around-advice does not use @code{ad-do-it}, then it does not run |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
283 the original function definition. This provides a way to override the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
284 original definition completely. (It also overrides lower-positioned |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
285 pieces of around-advice). |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
286 |
25223 | 287 If the around-advice uses @code{ad-do-it} more than once, the original |
288 definition is run at each place. In this way, around-advice can execute | |
289 the original definition (and lower-positioned pieces of around-advice) | |
290 several times. Another way to do that is by using @code{ad-do-it} | |
291 inside of a loop. | |
292 | |
21681 | 293 @node Computed Advice |
294 @section Computed Advice | |
295 | |
296 The macro @code{defadvice} resembles @code{defun} in that the code for | |
297 the advice, and all other information about it, are explicitly stated in | |
298 the source code. You can also create advice whose details are computed, | |
299 using the function @code{ad-add-advice}. | |
300 | |
301 @defun ad-add-advice function advice class position | |
302 Calling @code{ad-add-advice} adds @var{advice} as a piece of advice to | |
303 @var{function} in class @var{class}. The argument @var{advice} has | |
304 this form: | |
305 | |
306 @example | |
307 (@var{name} @var{protected} @var{enabled} @var{definition}) | |
308 @end example | |
309 | |
310 Here @var{protected} and @var{enabled} are flags, and @var{definition} | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
311 is the expression that says what the advice should do. If @var{enabled} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
312 is @code{nil}, this piece of advice is initially disabled |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
313 (@pxref{Enabling Advice}). |
21681 | 314 |
315 If @var{function} already has one or more pieces of advice in the | |
316 specified @var{class}, then @var{position} specifies where in the list | |
317 to put the new piece of advice. The value of @var{position} can either | |
318 be @code{first}, @code{last}, or a number (counting from 0 at the | |
319 beginning of the list). Numbers outside the range are mapped to the | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
320 beginning or the end of the range, whichever is closer. The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
321 @var{position} value is ignored when redefining an existing piece of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
322 advice. |
21681 | 323 |
324 If @var{function} already has a piece of @var{advice} with the same | |
325 name, then the position argument is ignored and the old advice is | |
326 replaced with the new one. | |
327 @end defun | |
328 | |
329 @node Activation of Advice | |
330 @section Activation of Advice | |
331 @cindex activating advice | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
332 @cindex advice, activating |
21681 | 333 |
334 By default, advice does not take effect when you define it---only when | |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
335 you @dfn{activate} advice for the function that was advised. However, |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
336 the advice will be activated automatically if you define or redefine |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
337 the function later. You can request the activation of advice for a |
51883
0eb7f2196a0c
Minor cleanups of previous changes.
Richard M. Stallman <rms@gnu.org>
parents:
51753
diff
changeset
|
338 function when you define the advice, by specifying the @code{activate} |
0eb7f2196a0c
Minor cleanups of previous changes.
Richard M. Stallman <rms@gnu.org>
parents:
51753
diff
changeset
|
339 flag in the @code{defadvice}. But normally you activate the advice |
0eb7f2196a0c
Minor cleanups of previous changes.
Richard M. Stallman <rms@gnu.org>
parents:
51753
diff
changeset
|
340 for a function by calling the function @code{ad-activate} or one of |
0eb7f2196a0c
Minor cleanups of previous changes.
Richard M. Stallman <rms@gnu.org>
parents:
51753
diff
changeset
|
341 the other activation commands listed below. |
21681 | 342 |
343 Separating the activation of advice from the act of defining it permits | |
344 you to add several pieces of advice to one function efficiently, without | |
345 redefining the function over and over as each advice is added. More | |
346 importantly, it permits defining advice for a function before that | |
347 function is actually defined. | |
348 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
349 When a function's advice is first activated, the function's original |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
350 definition is saved, and all enabled pieces of advice for that function |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
351 are combined with the original definition to make a new definition. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
352 (Pieces of advice that are currently disabled are not used; see |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
353 @ref{Enabling Advice}.) This definition is installed, and optionally |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
354 byte-compiled as well, depending on conditions described below. |
21681 | 355 |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
356 In all of the commands to activate advice, if @var{compile} is |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
357 @code{t} (or anything but @code{nil} or a negative number), the |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
358 command also compiles the combined definition which implements the |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
359 advice. If it is @code{nil} or a negative number, what happens |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
360 depends on @code{ad-default-compilation-action} as described below. |
21681 | 361 |
362 @deffn Command ad-activate function &optional compile | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25223
diff
changeset
|
363 This command activates all the advice defined for @var{function}. |
21681 | 364 @end deffn |
365 | |
57740
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
366 Activating advice does nothing if @var{function}'s advice is already |
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
367 active. But if there is new advice, added since the previous time you |
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
368 activated advice for @var{function}, it activates the new advice. |
21681 | 369 |
370 @deffn Command ad-deactivate function | |
371 This command deactivates the advice for @var{function}. | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
372 @cindex deactivating advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
373 @cindex advice, deactivating |
21681 | 374 @end deffn |
375 | |
26178 | 376 @deffn Command ad-update function &optional compile |
377 This command activates the advice for @var{function} | |
378 if its advice is already activated. This is useful | |
379 if you change the advice. | |
380 @end deffn | |
381 | |
21681 | 382 @deffn Command ad-activate-all &optional compile |
383 This command activates the advice for all functions. | |
384 @end deffn | |
385 | |
386 @deffn Command ad-deactivate-all | |
387 This command deactivates the advice for all functions. | |
388 @end deffn | |
389 | |
26178 | 390 @deffn Command ad-update-all &optional compile |
391 This command activates the advice for all functions | |
392 whose advice is already activated. This is useful | |
393 if you change the advice of some functions. | |
394 @end deffn | |
395 | |
21681 | 396 @deffn Command ad-activate-regexp regexp &optional compile |
397 This command activates all pieces of advice whose names match | |
398 @var{regexp}. More precisely, it activates all advice for any function | |
399 which has at least one piece of advice that matches @var{regexp}. | |
400 @end deffn | |
401 | |
402 @deffn Command ad-deactivate-regexp regexp | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
403 This command deactivates all pieces of advice whose names match |
21681 | 404 @var{regexp}. More precisely, it deactivates all advice for any |
405 function which has at least one piece of advice that matches | |
406 @var{regexp}. | |
407 @end deffn | |
408 | |
409 @deffn Command ad-update-regexp regexp &optional compile | |
410 This command activates pieces of advice whose names match @var{regexp}, | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
411 but only those for functions whose advice is already activated. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
412 @cindex reactivating advice |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
413 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
414 Reactivating a function's advice is useful for putting into effect all |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
415 the changes that have been made in its advice (including enabling and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
416 disabling specific pieces of advice; @pxref{Enabling Advice}) since the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
417 last time it was activated. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
418 @end deffn |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
419 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
420 @deffn Command ad-start-advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
421 Turn on automatic advice activation when a function is defined or |
51883
0eb7f2196a0c
Minor cleanups of previous changes.
Richard M. Stallman <rms@gnu.org>
parents:
51753
diff
changeset
|
422 redefined. This is the default mode. |
21681 | 423 @end deffn |
424 | |
425 @deffn Command ad-stop-advice | |
426 Turn off automatic advice activation when a function is defined or | |
427 redefined. | |
428 @end deffn | |
429 | |
430 @defopt ad-default-compilation-action | |
431 This variable controls whether to compile the combined definition | |
432 that results from activating advice for a function. | |
26178 | 433 |
27301
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
434 A value of @code{always} specifies to compile unconditionally. |
57740
b73dae8c28d0
(Simple Advice): Clarify what job the example does.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
435 A value of @code{never} specifies never compile the advice. |
26178 | 436 |
437 A value of @code{maybe} specifies to compile if the byte-compiler is | |
438 already loaded. A value of @code{like-original} specifies to compile | |
27301
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
439 the advice if the original definition of the advised function is |
26178 | 440 compiled or a built-in function. |
441 | |
442 This variable takes effect only if the @var{compile} argument of | |
60261
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
443 @code{ad-activate} (or any of the above functions) did not force |
dd9ce828300e
(Advising Functions): Don't imply one part of Emacs
Richard M. Stallman <rms@gnu.org>
parents:
57740
diff
changeset
|
444 compilation. |
21681 | 445 @end defopt |
446 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
447 If the advised definition was constructed during ``preactivation'' |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
448 (@pxref{Preactivation}), then that definition must already be compiled, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
449 because it was constructed during byte-compilation of the file that |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
450 contained the @code{defadvice} with the @code{preactivate} flag. |
21681 | 451 |
452 @node Enabling Advice | |
453 @section Enabling and Disabling Advice | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
454 @cindex enabling advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
455 @cindex advice, enabling and disabling |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
456 @cindex disabling advice |
21681 | 457 |
458 Each piece of advice has a flag that says whether it is enabled or | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
459 not. By enabling or disabling a piece of advice, you can turn it on |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
460 and off without having to undefine and redefine it. For example, here is |
21681 | 461 how to disable a particular piece of advice named @code{my-advice} for |
462 the function @code{foo}: | |
463 | |
464 @example | |
465 (ad-disable-advice 'foo 'before 'my-advice) | |
466 @end example | |
467 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
468 This function by itself only changes the enable flag for a piece of |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
469 advice. To make the change take effect in the advised definition, you |
21681 | 470 must activate the advice for @code{foo} again: |
471 | |
472 @example | |
473 (ad-activate 'foo) | |
474 @end example | |
475 | |
476 @deffn Command ad-disable-advice function class name | |
477 This command disables the piece of advice named @var{name} in class | |
478 @var{class} on @var{function}. | |
479 @end deffn | |
480 | |
481 @deffn Command ad-enable-advice function class name | |
482 This command enables the piece of advice named @var{name} in class | |
483 @var{class} on @var{function}. | |
484 @end deffn | |
485 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
486 You can also disable many pieces of advice at once, for various |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
487 functions, using a regular expression. As always, the changes take real |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
488 effect only when you next reactivate advice for the functions in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
489 question. |
21681 | 490 |
491 @deffn Command ad-disable-regexp regexp | |
492 This command disables all pieces of advice whose names match | |
493 @var{regexp}, in all classes, on all functions. | |
494 @end deffn | |
495 | |
496 @deffn Command ad-enable-regexp regexp | |
497 This command enables all pieces of advice whose names match | |
498 @var{regexp}, in all classes, on all functions. | |
499 @end deffn | |
500 | |
501 @node Preactivation | |
502 @section Preactivation | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
503 @cindex preactivating advice |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
504 @cindex advice, preactivating |
21681 | 505 |
506 Constructing a combined definition to execute advice is moderately | |
507 expensive. When a library advises many functions, this can make loading | |
508 the library slow. In that case, you can use @dfn{preactivation} to | |
509 construct suitable combined definitions in advance. | |
510 | |
511 To use preactivation, specify the @code{preactivate} flag when you | |
512 define the advice with @code{defadvice}. This @code{defadvice} call | |
513 creates a combined definition which embodies this piece of advice | |
514 (whether enabled or not) plus any other currently enabled advice for the | |
515 same function, and the function's own definition. If the | |
516 @code{defadvice} is compiled, that compiles the combined definition | |
517 also. | |
518 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
519 When the function's advice is subsequently activated, if the enabled |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
520 advice for the function matches what was used to make this combined |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
521 definition, then the existing combined definition is used, thus avoiding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
522 the need to construct one. Thus, preactivation never causes wrong |
21681 | 523 results---but it may fail to do any good, if the enabled advice at the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
524 time of activation doesn't match what was used for preactivation. |
21681 | 525 |
526 Here are some symptoms that can indicate that a preactivation did not | |
527 work properly, because of a mismatch. | |
528 | |
529 @itemize @bullet | |
530 @item | |
531 Activation of the advised | |
532 function takes longer than usual. | |
533 @item | |
534 The byte-compiler gets | |
535 loaded while an advised function gets activated. | |
536 @item | |
537 @code{byte-compile} is included in the value of @code{features} even | |
538 though you did not ever explicitly use the byte-compiler. | |
539 @end itemize | |
540 | |
541 Compiled preactivated advice works properly even if the function itself | |
542 is not defined until later; however, the function needs to be defined | |
543 when you @emph{compile} the preactivated advice. | |
544 | |
545 There is no elegant way to find out why preactivated advice is not being | |
546 used. What you can do is to trace the function | |
547 @code{ad-cache-id-verification-code} (with the function | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
548 @code{trace-function-background}) before the advised function's advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
549 is activated. After activation, check the value returned by |
21681 | 550 @code{ad-cache-id-verification-code} for that function: @code{verified} |
551 means that the preactivated advice was used, while other values give | |
552 some information about why they were considered inappropriate. | |
553 | |
554 @strong{Warning:} There is one known case that can make preactivation | |
555 fail, in that a preconstructed combined definition is used even though | |
556 it fails to match the current state of advice. This can happen when two | |
557 packages define different pieces of advice with the same name, in the | |
558 same class, for the same function. But you should avoid that anyway. | |
559 | |
560 @node Argument Access in Advice | |
561 @section Argument Access in Advice | |
562 | |
563 The simplest way to access the arguments of an advised function in the | |
564 body of a piece of advice is to use the same names that the function | |
565 definition uses. To do this, you need to know the names of the argument | |
566 variables of the original function. | |
567 | |
568 While this simple method is sufficient in many cases, it has a | |
569 disadvantage: it is not robust, because it hard-codes the argument names | |
570 into the advice. If the definition of the original function changes, | |
571 the advice might break. | |
572 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
573 Another method is to specify an argument list in the advice itself. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
574 This avoids the need to know the original function definition's argument |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
575 names, but it has a limitation: all the advice on any particular |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
576 function must use the same argument list, because the argument list |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
577 actually used for all the advice comes from the first piece of advice |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
578 for that function. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21681
diff
changeset
|
579 |
21681 | 580 A more robust method is to use macros that are translated into the |
581 proper access forms at activation time, i.e., when constructing the | |
582 advised definition. Access macros access actual arguments by position | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
583 regardless of how these actual arguments get distributed onto the |
21681 | 584 argument variables of a function. This is robust because in Emacs Lisp |
585 the meaning of an argument is strictly determined by its position in the | |
586 argument list. | |
587 | |
588 @defmac ad-get-arg position | |
589 This returns the actual argument that was supplied at @var{position}. | |
590 @end defmac | |
591 | |
592 @defmac ad-get-args position | |
593 This returns the list of actual arguments supplied starting at | |
594 @var{position}. | |
595 @end defmac | |
596 | |
597 @defmac ad-set-arg position value | |
598 This sets the value of the actual argument at @var{position} to | |
599 @var{value} | |
600 @end defmac | |
601 | |
602 @defmac ad-set-args position value-list | |
603 This sets the list of actual arguments starting at @var{position} to | |
604 @var{value-list}. | |
605 @end defmac | |
606 | |
607 Now an example. Suppose the function @code{foo} is defined as | |
608 | |
609 @example | |
610 (defun foo (x y &optional z &rest r) ...) | |
611 @end example | |
612 | |
613 @noindent | |
614 and is then called with | |
615 | |
616 @example | |
617 (foo 0 1 2 3 4 5 6) | |
618 @end example | |
619 | |
620 @noindent | |
621 which means that @var{x} is 0, @var{y} is 1, @var{z} is 2 and @var{r} is | |
622 @code{(3 4 5 6)} within the body of @code{foo}. Here is what | |
623 @code{ad-get-arg} and @code{ad-get-args} return in this case: | |
624 | |
625 @example | |
626 (ad-get-arg 0) @result{} 0 | |
627 (ad-get-arg 1) @result{} 1 | |
628 (ad-get-arg 2) @result{} 2 | |
629 (ad-get-arg 3) @result{} 3 | |
630 (ad-get-args 2) @result{} (2 3 4 5 6) | |
631 (ad-get-args 4) @result{} (4 5 6) | |
632 @end example | |
633 | |
634 Setting arguments also makes sense in this example: | |
635 | |
636 @example | |
637 (ad-set-arg 5 "five") | |
638 @end example | |
639 | |
640 @noindent | |
641 has the effect of changing the sixth argument to @code{"five"}. If this | |
642 happens in advice executed before the body of @code{foo} is run, then | |
643 @var{r} will be @code{(3 4 "five" 6)} within that body. | |
644 | |
645 Here is an example of setting a tail of the argument list: | |
646 | |
647 @example | |
648 (ad-set-args 0 '(5 4 3 2 1 0)) | |
649 @end example | |
650 | |
651 @noindent | |
652 If this happens in advice executed before the body of @code{foo} is run, | |
653 then within that body, @var{x} will be 5, @var{y} will be 4, @var{z} | |
654 will be 3, and @var{r} will be @code{(2 1 0)} inside the body of | |
655 @code{foo}. | |
656 | |
657 These argument constructs are not really implemented as Lisp macros. | |
658 Instead they are implemented specially by the advice mechanism. | |
659 | |
51651
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
660 @node Advising Primitives |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
661 @section Advising Primitives |
21681 | 662 |
51651
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
663 Advising a primitive function (also called a ``subr'') is risky. |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
664 Some primitive functions are used by the advice mechanism; advising |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
665 them could cause an infinite recursion. Also, many primitive |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
666 functions are called directly from C code. Calls to the primitive |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
667 from Lisp code will take note of the advice, but calls from C code |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
668 will ignore the advice. |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
669 |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
670 When the advice facility constructs the combined definition, it needs |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
671 to know the argument list of the original function. This is not |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
672 always possible for primitive functions. When advice cannot determine |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
673 the argument list, it uses @code{(&rest ad-subr-args)}, which always |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
674 works but is inefficient because it constructs a list of the argument |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
675 values. You can use @code{ad-define-subr-args} to declare the proper |
a81c039e79f9
(Advising Primitives): Renamed from Subr Arguments.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
676 argument names for a primitive function: |
21681 | 677 |
678 @defun ad-define-subr-args function arglist | |
679 This function specifies that @var{arglist} should be used as the | |
680 argument list for function @var{function}. | |
681 @end defun | |
682 | |
683 For example, | |
684 | |
685 @example | |
686 (ad-define-subr-args 'fset '(sym newdef)) | |
687 @end example | |
688 | |
689 @noindent | |
690 specifies the argument list for the function @code{fset}. | |
691 | |
692 @node Combined Definition | |
693 @section The Combined Definition | |
694 | |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
695 Suppose that a function has @var{n} pieces of before-advice |
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
696 (numbered from 0 through @var{n}@minus{}1), @var{m} pieces of |
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
697 around-advice and @var{k} pieces of after-advice. Assuming no piece |
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
698 of advice is protected, the combined definition produced to implement |
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
699 the advice for a function looks like this: |
21681 | 700 |
701 @example | |
702 (lambda @var{arglist} | |
703 @r{[} @r{[}@var{advised-docstring}@r{]} @r{[}(interactive ...)@r{]} @r{]} | |
704 (let (ad-return-value) | |
705 @r{before-0-body-form}... | |
706 .... | |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
707 @r{before-@var{n}@minus{}1-body-form}... |
21681 | 708 @r{around-0-body-form}... |
709 @r{around-1-body-form}... | |
710 .... | |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
711 @r{around-@var{m}@minus{}1-body-form}... |
21681 | 712 (setq ad-return-value |
713 @r{apply original definition to @var{arglist}}) | |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
714 @r{end-of-around-@var{m}@minus{}1-body-form}... |
21681 | 715 .... |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
716 @r{end-of-around-1-body-form}... |
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
717 @r{end-of-around-0-body-form}... |
21681 | 718 @r{after-0-body-form}... |
719 .... | |
39216
54660f1e0e30
Clarify n-1, etc. in example.
Richard M. Stallman <rms@gnu.org>
parents:
39191
diff
changeset
|
720 @r{after-@var{k}@minus{}1-body-form}... |
21681 | 721 ad-return-value)) |
722 @end example | |
723 | |
724 Macros are redefined as macros, which means adding @code{macro} to | |
725 the beginning of the combined definition. | |
726 | |
727 The interactive form is present if the original function or some piece | |
728 of advice specifies one. When an interactive primitive function is | |
39191 | 729 advised, advice uses a special method: it calls the primitive with |
21681 | 730 @code{call-interactively} so that it will read its own arguments. |
731 In this case, the advice cannot access the arguments. | |
732 | |
733 The body forms of the various advice in each class are assembled | |
734 according to their specified order. The forms of around-advice @var{l} | |
735 are included in one of the forms of around-advice @var{l} @minus{} 1. | |
736 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39216
diff
changeset
|
737 The innermost part of the around advice onion is |
21681 | 738 |
739 @display | |
740 apply original definition to @var{arglist} | |
741 @end display | |
742 | |
743 @noindent | |
744 whose form depends on the type of the original function. The variable | |
745 @code{ad-return-value} is set to whatever this returns. The variable is | |
746 visible to all pieces of advice, which can access and modify it before | |
747 it is actually returned from the advised function. | |
748 | |
749 The semantic structure of advised functions that contain protected | |
750 pieces of advice is the same. The only difference is that | |
751 @code{unwind-protect} forms ensure that the protected advice gets | |
752 executed even if some previous piece of advice had an error or a | |
753 non-local exit. If any around-advice is protected, then the whole | |
754 around-advice onion is protected as a result. | |
52401 | 755 |
756 @ignore | |
757 arch-tag: 80c135c2-f1c3-4f8d-aa85-f8d8770d307f | |
758 @end ignore |