Mercurial > emacs

annotate lispref/advice.texi @ 81615:059caeb1f502

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