|
0
|
1 ;;; advice.el --- an overloading mechanism for Emacs Lisp functions
|
|
|
2
|
|
|
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
|
|
|
4
|
|
|
5 ;; Author: Hans Chalupsky <hans@cs.buffalo.edu>
|
|
|
6 ;; Created: 12 Dec 1992
|
|
|
7 ;; Version: advice.el,v 2.14 1994/08/05 03:42:04 hans Exp
|
|
|
8 ;; Keywords: extensions, lisp, tools
|
|
|
9
|
|
|
10 ;; This file is part of XEmacs.
|
|
|
11
|
|
|
12 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
13 ;; under the terms of the GNU General Public License as published by
|
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
20 ;; General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
2
|
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
25 ;; 02111-1307, USA.
|
|
0
|
26
|
|
|
27 ;; LCD Archive Entry:
|
|
|
28 ;; advice|Hans Chalupsky|hans@cs.buffalo.edu|
|
|
|
29 ;; Overloading mechanism for Emacs Lisp functions|
|
|
|
30 ;; 1994/08/05 03:42:04|2.14|~/packages/advice.el.Z|
|
|
|
31
|
|
2
|
32 ;;; Synched up with: FSF 19.34 (In a fashion. Many comments are dated).
|
|
0
|
33
|
|
|
34 ;;; Commentary:
|
|
|
35
|
|
|
36 ;; NOTE: This documentation is slightly out of date. In particular, all the
|
|
|
37 ;; references to Emacs-18 are obsolete now, because it is not any longer
|
|
|
38 ;; supported by this version of Advice. An up-to-date version will soon be
|
|
|
39 ;; available as an info file (thanks to the kind help of Jack Vinson and
|
|
|
40 ;; David M. Smith).
|
|
|
41
|
|
|
42 ;; @ Introduction:
|
|
|
43 ;; ===============
|
|
|
44 ;; This package implements a full-fledged Lisp-style advice mechanism
|
|
|
45 ;; for Emacs Lisp. Advice is a clean and efficient way to modify the
|
|
|
46 ;; behavior of Emacs Lisp functions without having to keep personal
|
|
|
47 ;; modified copies of such functions around. A great number of such
|
|
|
48 ;; modifications can be achieved by treating the original function as a
|
|
|
49 ;; black box and specifying a different execution environment for it
|
|
|
50 ;; with a piece of advice. Think of a piece of advice as a kind of fancy
|
|
|
51 ;; hook that you can attach to any function/macro/subr.
|
|
|
52
|
|
|
53 ;; @ Highlights:
|
|
|
54 ;; =============
|
|
|
55 ;; - Clean definition of multiple, named before/around/after advices
|
|
|
56 ;; for functions, macros, subrs and special forms
|
|
|
57 ;; - Full control over the arguments an advised function will receive,
|
|
|
58 ;; the binding environment in which it will be executed, as well as the
|
|
|
59 ;; value it will return.
|
|
|
60 ;; - Allows re/definition of interactive behavior for functions and subrs
|
|
|
61 ;; - Every piece of advice can have its documentation string which will be
|
|
|
62 ;; combined with the original documentation of the advised function at
|
|
|
63 ;; call-time of `documentation' for proper command-key substitution.
|
|
|
64 ;; - The execution of every piece of advice can be protected against error
|
|
|
65 ;; and non-local exits in preceding code or advices.
|
|
|
66 ;; - Simple argument access either by name, or, more portable but as
|
|
|
67 ;; efficient, via access macros
|
|
|
68 ;; - Allows the specification of a different argument list for the advised
|
|
|
69 ;; version of a function.
|
|
|
70 ;; - Advised functions can be byte-compiled either at file-compile time
|
|
|
71 ;; (see preactivation) or activation time.
|
|
|
72 ;; - Separation of advice definition and activation
|
|
|
73 ;; - Forward advice is possible, that is
|
|
|
74 ;; as yet undefined or autoload functions can be advised without having to
|
|
|
75 ;; preload the file in which they are defined.
|
|
|
76 ;; - Forward redefinition is possible because around advice can be used to
|
|
|
77 ;; completely redefine a function.
|
|
|
78 ;; - A caching mechanism for advised definition provides for cheap deactivation
|
|
|
79 ;; and reactivation of advised functions.
|
|
|
80 ;; - Preactivation allows efficient construction and compilation of advised
|
|
|
81 ;; definitions at file compile time without giving up the flexibility of
|
|
|
82 ;; the advice mechanism.
|
|
|
83 ;; - En/disablement mechanism allows the use of different "views" of advised
|
|
|
84 ;; functions depending on what pieces of advice are currently en/disabled
|
|
|
85 ;; - Provides manipulation mechanisms for sets of advised functions via
|
|
|
86 ;; regular expressions that match advice names
|
|
|
87
|
|
|
88 ;; @ How to get Advice for Emacs-18:
|
|
|
89 ;; =================================
|
|
|
90 ;; `advice18.el', a version of Advice that also works in Emacs-18 is available
|
|
|
91 ;; either via anonymous ftp from `ftp.cs.buffalo.edu (128.205.32.9)' with
|
|
|
92 ;; pathname `/pub/Emacs/advice18.el', or from one of the Emacs Lisp archive
|
|
|
93 ;; sites, or send email to <hans@cs.buffalo.edu> and I'll mail it to you.
|
|
|
94
|
|
|
95 ;; @ Overview, or how to read this file:
|
|
|
96 ;; =====================================
|
|
|
97 ;; NOTE: This documentation is slightly out of date. In particular, all the
|
|
|
98 ;; references to Emacs-18 are obsolete now, because it is not any longer
|
|
|
99 ;; supported by this version of Advice. An up-to-date version will soon be
|
|
|
100 ;; available as an info file (thanks to the kind help of Jack Vinson and
|
|
|
101 ;; David M. Smith). Until then you can use `outline-mode' to help you read
|
|
|
102 ;; this documentation (set `outline-regexp' to `";; @+"').
|
|
|
103 ;;
|
|
|
104 ;; The four major sections of this file are:
|
|
|
105 ;;
|
|
|
106 ;; @ This initial information ...installation, customization etc.
|
|
|
107 ;; @ Advice documentation: ...general documentation
|
|
|
108 ;; @ Foo games: An advice tutorial ...teaches about Advice by example
|
|
|
109 ;; @ Advice implementation: ...actual code, yeah!!
|
|
|
110 ;;
|
|
|
111 ;; The latter three are actual headings which you can search for
|
|
|
112 ;; directly in case `outline-mode' doesn't work for you.
|
|
|
113
|
|
|
114 ;; @ Restrictions:
|
|
|
115 ;; ===============
|
|
|
116 ;; - Only works with Emacs 19.26 or later and XEmacs 19.12 or later.
|
|
|
117 ;; - Advised functions/macros/subrs will only exhibit their advised behavior
|
|
|
118 ;; when they are invoked via their function cell. This means that advice will
|
|
|
119 ;; not work for the following:
|
|
|
120 ;; + advised subrs that are called directly from other subrs or C-code
|
|
|
121 ;; + advised subrs that got replaced with their byte-code during
|
|
|
122 ;; byte-compilation (e.g., car)
|
|
|
123 ;; + advised macros which were expanded during byte-compilation before
|
|
|
124 ;; their advice was activated.
|
|
|
125
|
|
|
126 ;; @ Credits:
|
|
|
127 ;; ==========
|
|
|
128 ;; This package is an extension and generalization of packages such as
|
|
|
129 ;; insert-hooks.el written by Noah S. Friedman, and advise.el written by
|
|
|
130 ;; Raul J. Acevedo. Some ideas used in here come from these packages,
|
|
|
131 ;; others come from the various Lisp advice mechanisms I've come across
|
|
|
132 ;; so far, and a few are simply mine.
|
|
|
133
|
|
|
134 ;; @ Comments, suggestions, bug reports:
|
|
|
135 ;; =====================================
|
|
|
136 ;; If you find any bugs, have suggestions for new advice features, find the
|
|
|
137 ;; documentation wrong, confusing, incomplete, or otherwise unsatisfactory,
|
|
|
138 ;; have any questions about Advice, or have otherwise enlightening
|
|
|
139 ;; comments feel free to send me email at <hans@cs.buffalo.edu>.
|
|
|
140
|
|
|
141 ;; @ Safety Rules and Emergency Exits:
|
|
|
142 ;; ===================================
|
|
|
143 ;; Before we begin: CAUTION!!
|
|
|
144 ;; Advice provides you with a lot of rope to hang yourself on very
|
|
|
145 ;; easily accessible trees, so, here are a few important things you
|
|
|
146 ;; should know: Once Advice has been started with `ad-start-advice'
|
|
|
147 ;; (which happens automatically when you load this file), it
|
|
|
148 ;; generates an advised definition of the `documentation' function, and
|
|
|
149 ;; it will enable automatic advice activation when functions get defined.
|
|
|
150 ;; All of this can be undone at any time with `M-x ad-stop-advice'.
|
|
|
151 ;;
|
|
|
152 ;; If you experience any strange behavior/errors etc. that you attribute to
|
|
|
153 ;; Advice or to some ill-advised function do one of the following:
|
|
|
154
|
|
|
155 ;; - M-x ad-deactivate FUNCTION (if you have a definite suspicion what
|
|
|
156 ;; function gives you problems)
|
|
|
157 ;; - M-x ad-deactivate-all (if you don't have a clue what's going wrong)
|
|
|
158 ;; - M-x ad-stop-advice (if you think the problem is related to the
|
|
|
159 ;; advised functions used by Advice itself)
|
|
|
160 ;; - M-x ad-recover-normality (for real emergencies)
|
|
|
161 ;; - If none of the above solves your Advice-related problem go to another
|
|
|
162 ;; terminal, kill your Emacs process and send me some hate mail.
|
|
|
163
|
|
|
164 ;; The first three measures have restarts, i.e., once you've figured out
|
|
|
165 ;; the problem you can reactivate advised functions with either `ad-activate',
|
|
|
166 ;; `ad-activate-all', or `ad-start-advice'. `ad-recover-normality' unadvises
|
|
|
167 ;; everything so you won't be able to reactivate any advised functions, you'll
|
|
|
168 ;; have to stick with their standard incarnations for the rest of the session.
|
|
|
169
|
|
|
170 ;; IMPORTANT: With Advice loaded always do `M-x ad-deactivate-all' before
|
|
|
171 ;; you byte-compile a file, because advised special forms and macros can lead
|
|
|
172 ;; to unwanted compilation results. When you are done compiling use
|
|
|
173 ;; `M-x ad-activate-all' to go back to the advised state of all your
|
|
|
174 ;; advised functions.
|
|
|
175
|
|
|
176 ;; RELAX: Advice is pretty safe even if you are oblivious to the above.
|
|
|
177 ;; I use it extensively and haven't run into any serious trouble in a long
|
|
|
178 ;; time. Just wanted you to be warned.
|
|
|
179
|
|
|
180 ;; @ Customization:
|
|
|
181 ;; ================
|
|
|
182
|
|
|
183 ;; Look at the documentation of `ad-redefinition-action' for possible values
|
|
|
184 ;; of this variable. Its default value is `warn' which will print a warning
|
|
|
185 ;; message when an already defined advised function gets redefined with a
|
|
|
186 ;; new original definition and de/activated.
|
|
|
187
|
|
|
188 ;; Look at the documentation of `ad-default-compilation-action' for possible
|
|
|
189 ;; values of this variable. Its default value is `maybe' which will compile
|
|
|
190 ;; advised definitions during activation in case the byte-compiler is already
|
|
|
191 ;; loaded. Otherwise, it will leave them uncompiled.
|
|
|
192
|
|
|
193 ;; @ Motivation:
|
|
|
194 ;; =============
|
|
|
195 ;; Before I go on explaining how advice works, here are four simple examples
|
|
|
196 ;; how this package can be used. The first three are very useful, the last one
|
|
|
197 ;; is just a joke:
|
|
|
198
|
|
|
199 ;;(defadvice switch-to-buffer (before existing-buffers-only activate)
|
|
|
200 ;; "When called interactively switch to existing buffers only, unless
|
|
|
201 ;;when called with a prefix argument."
|
|
|
202 ;; (interactive
|
|
|
203 ;; (list (read-buffer "Switch to buffer: " (other-buffer)
|
|
|
204 ;; (null current-prefix-arg)))))
|
|
|
205 ;;
|
|
|
206 ;;(defadvice switch-to-buffer (around confirm-non-existing-buffers activate)
|
|
|
207 ;; "Switch to non-existing buffers only upon confirmation."
|
|
|
208 ;; (interactive "BSwitch to buffer: ")
|
|
|
209 ;; (if (or (get-buffer (ad-get-arg 0))
|
|
|
210 ;; (y-or-n-p (format "`%s' does not exist, create? " (ad-get-arg 0))))
|
|
|
211 ;; ad-do-it))
|
|
|
212 ;;
|
|
|
213 ;;(defadvice find-file (before existing-files-only activate)
|
|
|
214 ;; "Find existing files only"
|
|
|
215 ;; (interactive "fFind file: "))
|
|
|
216 ;;
|
|
|
217 ;;(defadvice car (around interactive activate)
|
|
|
218 ;; "Make `car' an interactive function."
|
|
|
219 ;; (interactive "xCar of list: ")
|
|
|
220 ;; ad-do-it
|
|
|
221 ;; (if (interactive-p)
|
|
|
222 ;; (message "%s" ad-return-value)))
|
|
|
223
|
|
|
224
|
|
|
225 ;; @ Advice documentation:
|
|
|
226 ;; =======================
|
|
|
227 ;; Below is general documentation of the various features of advice. For more
|
|
|
228 ;; concrete examples check the corresponding sections in the tutorial part.
|
|
|
229
|
|
|
230 ;; @@ Terminology:
|
|
|
231 ;; ===============
|
|
|
232 ;; - Emacs, Emacs-19: FSF's version of Emacs with major version 19
|
|
|
233 ;; - Lemacs: Lucid's version of Emacs with major version 19
|
|
|
234 ;; - XEmacs: New name of Lucid Emacs starting with 19.11
|
|
|
235 ;; - v18: Any Emacs with major version 18 or built as an extension to that
|
|
|
236 ;; (such as Epoch)
|
|
|
237 ;; - v19: Any Emacs with major version 19
|
|
|
238 ;; - jwz: Jamie Zawinski - former keeper of Lemacs and creator of the
|
|
|
239 ;; optimizing byte-compiler used in v19s.
|
|
|
240 ;; - Advice: The name of this package.
|
|
|
241 ;; - advices: Short for "pieces of advice".
|
|
|
242
|
|
|
243 ;; @@ Defining a piece of advice with `defadvice':
|
|
|
244 ;; ===============================================
|
|
|
245 ;; The main means of defining a piece of advice is the macro `defadvice',
|
|
|
246 ;; there is no interactive way of specifying a piece of advice. A call to
|
|
|
247 ;; `defadvice' has the following syntax which is similar to the syntax of
|
|
|
248 ;; `defun/defmacro':
|
|
|
249 ;;
|
|
|
250 ;; (defadvice <function> (<class> <name> [<position>] [<arglist>] {<flags>}*)
|
|
|
251 ;; [ [<documentation-string>] [<interactive-form>] ]
|
|
|
252 ;; {<body-form>}* )
|
|
|
253
|
|
|
254 ;; <function> is the name of the function/macro/subr to be advised.
|
|
|
255
|
|
|
256 ;; <class> is the class of the advice which has to be one of `before',
|
|
|
257 ;; `around', `after', `activation' or `deactivation' (the last two allow
|
|
|
258 ;; definition of special act/deactivation hooks).
|
|
|
259
|
|
|
260 ;; <name> is the name of the advice which has to be a non-nil symbol.
|
|
|
261 ;; Names uniquely identify a piece of advice in a certain advice class,
|
|
|
262 ;; hence, advices can be redefined by defining an advice with the same class
|
|
|
263 ;; and name. Advice names are global symbols, hence, the same name space
|
|
|
264 ;; conventions used for function names should be applied.
|
|
|
265
|
|
|
266 ;; An optional <position> specifies where in the current list of advices of
|
|
|
267 ;; the specified <class> this new advice will be placed. <position> has to
|
|
|
268 ;; be either `first', `last' or a number that specifies a zero-based
|
|
|
269 ;; position (`first' is equivalent to 0). If no position is specified
|
|
|
270 ;; `first' will be used as a default. If this call to `defadvice' redefines
|
|
|
271 ;; an already existing advice (see above) then the position argument will
|
|
|
272 ;; be ignored and the position of the already existing advice will be used.
|
|
|
273
|
|
|
274 ;; An optional <arglist> which has to be a list can be used to define the
|
|
|
275 ;; argument list of the advised function. This argument list should of
|
|
|
276 ;; course be compatible with the argument list of the original function,
|
|
|
277 ;; otherwise functions that call the advised function with the original
|
|
|
278 ;; argument list in mind will break. If more than one advice specify an
|
|
|
279 ;; argument list then the first one (the one with the smallest position)
|
|
|
280 ;; found in the list of before/around/after advices will be used.
|
|
|
281
|
|
|
282 ;; <flags> is a list of symbols that specify further information about the
|
|
|
283 ;; advice. All flags can be specified with unambiguous initial substrings.
|
|
|
284 ;; `activate': Specifies that the advice information of the advised
|
|
|
285 ;; function should be activated right after this advice has been
|
|
|
286 ;; defined. In forward advices `activate' will be ignored.
|
|
|
287 ;; `protect': Specifies that this advice should be protected against
|
|
|
288 ;; non-local exits and errors in preceding code/advices.
|
|
|
289 ;; `compile': Specifies that the advised function should be byte-compiled.
|
|
|
290 ;; This flag will be ignored unless `activate' is also specified.
|
|
|
291 ;; `disable': Specifies that the defined advice should be disabled, hence,
|
|
|
292 ;; it will not be used in an activation until somebody enables it.
|
|
|
293 ;; `preactivate': Specifies that the advised function should get preactivated
|
|
|
294 ;; at macro-expansion/compile time of this `defadvice'. This
|
|
|
295 ;; generates a compiled advised definition according to the
|
|
|
296 ;; current advice state which will be used during activation
|
|
|
297 ;; if appropriate. Only use this if the `defadvice' gets
|
|
|
298 ;; actually compiled (with a v18 byte-compiler put the `defadvice'
|
|
|
299 ;; into the body of a `defun' to accomplish proper compilation).
|
|
|
300
|
|
|
301 ;; An optional <documentation-string> can be supplied to document the advice.
|
|
|
302 ;; On call of the `documentation' function it will be combined with the
|
|
|
303 ;; documentation strings of the original function and other advices.
|
|
|
304
|
|
|
305 ;; An optional <interactive-form> form can be supplied to change/add
|
|
|
306 ;; interactive behavior of the original function. If more than one advice
|
|
|
307 ;; has an `(interactive ...)' specification then the first one (the one
|
|
|
308 ;; with the smallest position) found in the list of before/around/after
|
|
|
309 ;; advices will be used.
|
|
|
310
|
|
|
311 ;; A possibly empty list of <body-forms> specifies the body of the advice in
|
|
|
312 ;; an implicit progn. The body of an advice can access/change arguments,
|
|
|
313 ;; the return value, the binding environment, and can have all sorts of
|
|
|
314 ;; other side effects.
|
|
|
315
|
|
|
316 ;; @@ Assembling advised definitions:
|
|
|
317 ;; ==================================
|
|
|
318 ;; Suppose a function/macro/subr/special-form has N pieces of before advice,
|
|
|
319 ;; M pieces of around advice and K pieces of after advice. Assuming none of
|
|
|
320 ;; the advices is protected, its advised definition will look like this
|
|
|
321 ;; (body-form indices correspond to the position of the respective advice in
|
|
|
322 ;; that advice class):
|
|
|
323
|
|
|
324 ;; ([macro] lambda <arglist>
|
|
|
325 ;; [ [<advised-docstring>] [(interactive ...)] ]
|
|
|
326 ;; (let (ad-return-value)
|
|
|
327 ;; {<before-0-body-form>}*
|
|
|
328 ;; ....
|
|
|
329 ;; {<before-N-1-body-form>}*
|
|
|
330 ;; {<around-0-body-form>}*
|
|
|
331 ;; {<around-1-body-form>}*
|
|
|
332 ;; ....
|
|
|
333 ;; {<around-M-1-body-form>}*
|
|
|
334 ;; (setq ad-return-value
|
|
|
335 ;; <apply original definition to <arglist>>)
|
|
|
336 ;; {<other-around-M-1-body-form>}*
|
|
|
337 ;; ....
|
|
|
338 ;; {<other-around-1-body-form>}*
|
|
|
339 ;; {<other-around-0-body-form>}*
|
|
|
340 ;; {<after-0-body-form>}*
|
|
|
341 ;; ....
|
|
|
342 ;; {<after-K-1-body-form>}*
|
|
|
343 ;; ad-return-value))
|
|
|
344
|
|
|
345 ;; Macros and special forms will be redefined as macros, hence the optional
|
|
|
346 ;; [macro] in the beginning of the definition.
|
|
|
347
|
|
|
348 ;; <arglist> is either the argument list of the original function or the
|
|
|
349 ;; first argument list defined in the list of before/around/after advices.
|
|
|
350 ;; The values of <arglist> variables can be accessed/changed in the body of
|
|
|
351 ;; an advice by simply referring to them by their original name, however,
|
|
|
352 ;; more portable argument access macros are also provided (see below). For
|
|
|
353 ;; subrs/special-forms for which neither explicit argument list definitions
|
|
|
354 ;; are available, nor their documentation strings contain such definitions
|
|
|
355 ;; (as they do v19s), `(&rest ad-subr-args)' will be used.
|
|
|
356
|
|
|
357 ;; <advised-docstring> is an optional, special documentation string which will
|
|
|
358 ;; be expanded into a proper documentation string upon call of `documentation'.
|
|
|
359
|
|
|
360 ;; (interactive ...) is an optional interactive form either taken from the
|
|
|
361 ;; original function or from a before/around/after advice. For advised
|
|
|
362 ;; interactive subrs that do not have an interactive form specified in any
|
|
|
363 ;; advice we have to use (interactive) and then call the subr interactively
|
|
|
364 ;; if the advised function was called interactively, because the
|
|
|
365 ;; interactive specification of subrs is not accessible. This is the only
|
|
|
366 ;; case where changing the values of arguments will not have an affect
|
|
|
367 ;; because they will be reset by the interactive specification of the subr.
|
|
|
368 ;; If this is a problem one can always specify an interactive form in a
|
|
|
369 ;; before/around/after advice to gain control over argument values that
|
|
|
370 ;; were supplied interactively.
|
|
|
371 ;;
|
|
|
372 ;; Then the body forms of the various advices in the various classes of advice
|
|
|
373 ;; are assembled in order. The forms of around advice L are normally part of
|
|
|
374 ;; one of the forms of around advice L-1. An around advice can specify where
|
|
|
375 ;; the forms of the wrapped or surrounded forms should go with the special
|
|
|
376 ;; keyword `ad-do-it', which will be substituted with a `progn' containing the
|
|
|
377 ;; forms of the surrounded code.
|
|
|
378
|
|
|
379 ;; The innermost part of the around advice onion is
|
|
|
380 ;; <apply original definition to <arglist>>
|
|
|
381 ;; whose form depends on the type of the original function. The variable
|
|
|
382 ;; `ad-return-value' will be set to its result. This variable is visible to
|
|
|
383 ;; all pieces of advice which can access and modify it before it gets returned.
|
|
|
384 ;;
|
|
|
385 ;; The semantic structure of advised functions that contain protected pieces
|
|
|
386 ;; of advice is the same. The only difference is that `unwind-protect' forms
|
|
|
387 ;; make sure that the protected advice gets executed even if some previous
|
|
|
388 ;; piece of advice had an error or a non-local exit. If any around advice is
|
|
|
389 ;; protected then the whole around advice onion will be protected.
|
|
|
390
|
|
|
391 ;; @@ Argument access in advised functions:
|
|
|
392 ;; ========================================
|
|
|
393 ;; As already mentioned, the simplest way to access the arguments of an
|
|
|
394 ;; advised function in the body of an advice is to refer to them by name. To
|
|
|
395 ;; do that, the advice programmer needs to know either the names of the
|
|
|
396 ;; argument variables of the original function, or the names used in the
|
|
|
397 ;; argument list redefinition given in a piece of advice. While this simple
|
|
|
398 ;; method might be sufficient in many cases, it has the disadvantage that it
|
|
|
399 ;; is not very portable because it hardcodes the argument names into the
|
|
|
400 ;; advice. If the definition of the original function changes the advice
|
|
|
401 ;; might break even though the code might still be correct. Situations like
|
|
|
402 ;; that arise, for example, if one advises a subr like `eval-region' which
|
|
|
403 ;; gets redefined in a non-advice style into a function by the edebug
|
|
|
404 ;; package. If the advice assumes `eval-region' to be a subr it might break
|
|
|
405 ;; once edebug is loaded. Similar situations arise when one wants to use the
|
|
|
406 ;; same piece of advice across different versions of Emacs. Some subrs in a
|
|
|
407 ;; v18 Emacs are functions in v19 and vice versa, but for the most part the
|
|
|
408 ;; semantics remain the same, hence, the same piece of advice might be usable
|
|
|
409 ;; in both Emacs versions.
|
|
|
410
|
|
|
411 ;; As a solution to that advice provides argument list access macros that get
|
|
|
412 ;; translated into the proper access forms at activation time, i.e., when the
|
|
|
413 ;; advised definition gets constructed. Access macros access actual arguments
|
|
|
414 ;; by position regardless of how these actual argument get distributed onto
|
|
|
415 ;; the argument variables of a function. The rational behind this is that in
|
|
|
416 ;; Emacs Lisp the semantics of an argument is strictly determined by its
|
|
|
417 ;; position (there are no keyword arguments).
|
|
|
418
|
|
|
419 ;; Suppose the function `foo' is defined as
|
|
|
420 ;;
|
|
|
421 ;; (defun foo (x y &optional z &rest r) ....)
|
|
|
422 ;;
|
|
|
423 ;; and is then called with
|
|
|
424 ;;
|
|
|
425 ;; (foo 0 1 2 3 4 5 6)
|
|
|
426
|
|
|
427 ;; which means that X=0, Y=1, Z=2 and R=(3 4 5 6). The assumption is that
|
|
|
428 ;; the semantics of an actual argument is determined by its position. It is
|
|
|
429 ;; this semantics that has to be known by the advice programmer. Then s/he
|
|
|
430 ;; can access these arguments in a piece of advice with some of the
|
|
|
431 ;; following macros (the arrows indicate what value they will return):
|
|
|
432
|
|
|
433 ;; (ad-get-arg 0) -> 0
|
|
|
434 ;; (ad-get-arg 1) -> 1
|
|
|
435 ;; (ad-get-arg 2) -> 2
|
|
|
436 ;; (ad-get-arg 3) -> 3
|
|
|
437 ;; (ad-get-args 2) -> (2 3 4 5 6)
|
|
|
438 ;; (ad-get-args 4) -> (4 5 6)
|
|
|
439
|
|
|
440 ;; `(ad-get-arg <position>)' will return the actual argument that was supplied
|
|
|
441 ;; at <position>, `(ad-get-args <position>)' will return the list of actual
|
|
|
442 ;; arguments supplied starting at <position>. Note that these macros can be
|
|
|
443 ;; used without any knowledge about the form of the actual argument list of
|
|
|
444 ;; the original function.
|
|
|
445
|
|
|
446 ;; Similarly, `(ad-set-arg <position> <value-form>)' can be used to set the
|
|
|
447 ;; value of the actual argument at <position> to <value-form>. For example,
|
|
|
448 ;;
|
|
|
449 ;; (ad-set-arg 5 "five")
|
|
|
450 ;;
|
|
|
451 ;; will have the effect that R=(3 4 "five" 6) once the original function is
|
|
|
452 ;; called. `(ad-set-args <position> <value-list-form>)' can be used to set
|
|
|
453 ;; the list of actual arguments starting at <position> to <value-list-form>.
|
|
|
454 ;; For example,
|
|
|
455 ;;
|
|
|
456 ;; (ad-set-args 0 '(5 4 3 2 1 0))
|
|
|
457 ;;
|
|
|
458 ;; will have the effect that X=5, Y=4, Z=3 and R=(2 1 0) once the original
|
|
|
459 ;; function is called.
|
|
|
460
|
|
|
461 ;; All these access macros are text macros rather than real Lisp macros. When
|
|
|
462 ;; the advised definition gets constructed they get replaced with actual access
|
|
|
463 ;; forms depending on the argument list of the advised function, i.e., after
|
|
|
464 ;; that argument access is in most cases as efficient as using the argument
|
|
|
465 ;; variable names directly.
|
|
|
466
|
|
|
467 ;; @@@ Accessing argument bindings of arbitrary functions:
|
|
|
468 ;; =======================================================
|
|
|
469 ;; Some functions (such as `trace-function' defined in trace.el) need a
|
|
|
470 ;; method of accessing the names and bindings of the arguments of an
|
|
|
471 ;; arbitrary advised function. To do that within an advice one can use the
|
|
|
472 ;; special keyword `ad-arg-bindings' which is a text macro that will be
|
|
|
473 ;; substituted with a form that will evaluate to a list of binding
|
|
|
474 ;; specifications, one for every argument variable. These binding
|
|
|
475 ;; specifications can then be examined in the body of the advice. For
|
|
|
476 ;; example, somewhere in an advice we could do this:
|
|
|
477 ;;
|
|
|
478 ;; (let* ((bindings ad-arg-bindings)
|
|
|
479 ;; (firstarg (car bindings))
|
|
|
480 ;; (secondarg (car (cdr bindings))))
|
|
|
481 ;; ;; Print info about first argument
|
|
|
482 ;; (print (format "%s=%s (%s)"
|
|
|
483 ;; (ad-arg-binding-field firstarg 'name)
|
|
|
484 ;; (ad-arg-binding-field firstarg 'value)
|
|
|
485 ;; (ad-arg-binding-field firstarg 'type)))
|
|
|
486 ;; ....)
|
|
|
487 ;;
|
|
|
488 ;; The `type' of an argument is either `required', `optional' or `rest'.
|
|
|
489 ;; Wherever `ad-arg-bindings' appears a form will be inserted that evaluates
|
|
|
490 ;; to the list of bindings, hence, in order to avoid multiple unnecessary
|
|
|
491 ;; evaluations one should always bind it to some variable.
|
|
|
492
|
|
|
493 ;; @@@ Argument list mapping:
|
|
|
494 ;; ==========================
|
|
|
495 ;; Because `defadvice' allows the specification of the argument list of the
|
|
|
496 ;; advised function we need a mapping mechanism that maps this argument list
|
|
|
497 ;; onto that of the original function. For example, somebody might specify
|
|
|
498 ;; `(sym newdef)' as the argument list of `fset', while advice might use
|
|
|
499 ;; `(&rest ad-subr-args)' as the argument list of the original function
|
|
|
500 ;; (depending on what Emacs version is used). Hence SYM and NEWDEF have to
|
|
|
501 ;; be properly mapped onto the &rest variable when the original definition is
|
|
|
502 ;; called. Advice automatically takes care of that mapping, hence, the advice
|
|
|
503 ;; programmer can specify an argument list without having to know about the
|
|
|
504 ;; exact structure of the original argument list as long as the new argument
|
|
|
505 ;; list takes a compatible number/magnitude of actual arguments.
|
|
|
506
|
|
|
507 ;; @@@ Definition of subr argument lists:
|
|
|
508 ;; ======================================
|
|
|
509 ;; When advice constructs the advised definition of a function it has to
|
|
|
510 ;; know the argument list of the original function. For functions and macros
|
|
|
511 ;; the argument list can be determined from the actual definition, however,
|
|
|
512 ;; for subrs there is no such direct access available. In XEmacs and for some
|
|
|
513 ;; subrs in Emacs-19 the argument list of a subr can be determined from
|
|
|
514 ;; its documentation string, in a v18 Emacs even that is not possible. If
|
|
|
515 ;; advice cannot at all determine the argument list of a subr it uses
|
|
|
516 ;; `(&rest ad-subr-args)' which will always work but is inefficient because
|
|
|
517 ;; it conses up arguments. The macro `ad-define-subr-args' can be used by
|
|
|
518 ;; the advice programmer to explicitly tell advice about the argument list
|
|
|
519 ;; of a certain subr, for example,
|
|
|
520 ;;
|
|
|
521 ;; (ad-define-subr-args 'fset '(sym newdef))
|
|
|
522 ;;
|
|
|
523 ;; is used by advice itself to tell a v18 Emacs about the arguments of `fset'.
|
|
|
524 ;; The following can be used to undo such a definition:
|
|
|
525 ;;
|
|
|
526 ;; (ad-undefine-subr-args 'fset)
|
|
|
527 ;;
|
|
|
528 ;; The argument list definition is stored on the property list of the subr
|
|
|
529 ;; name symbol. When an argument list could be determined from the
|
|
|
530 ;; documentation string it will be cached under that property. The general
|
|
|
531 ;; mechanism for looking up the argument list of a subr is the following:
|
|
|
532 ;; 1) look for a definition stored on the property list
|
|
|
533 ;; 2) if that failed try to infer it from the documentation string and
|
|
|
534 ;; if successful cache it on the property list
|
|
|
535 ;; 3) otherwise use `(&rest ad-subr-args)'
|
|
|
536
|
|
|
537 ;; @@ Activation and deactivation:
|
|
|
538 ;; ===============================
|
|
|
539 ;; The definition of an advised function does not change until all its advice
|
|
|
540 ;; gets actually activated. Activation can either happen with the `activate'
|
|
|
541 ;; flag specified in the `defadvice', with an explicit call or interactive
|
|
|
542 ;; invocation of `ad-activate', or if forward advice is enabled (i.e., the
|
|
|
543 ;; value of `ad-activate-on-definition' is t) at the time an already advised
|
|
|
544 ;; function gets defined.
|
|
|
545
|
|
|
546 ;; When a function gets first activated its original definition gets saved,
|
|
|
547 ;; all defined and enabled pieces of advice will get combined with the
|
|
|
548 ;; original definition, the resulting definition might get compiled depending
|
|
|
549 ;; on some conditions described below, and then the function will get
|
|
|
550 ;; redefined with the advised definition. This also means that undefined
|
|
|
551 ;; functions cannot get activated even though they might be already advised.
|
|
|
552
|
|
|
553 ;; The advised definition will get compiled either if `ad-activate' was called
|
|
|
554 ;; interactively with a prefix argument, or called explicitly with its second
|
|
|
555 ;; argument as t, or, if `ad-default-compilation-action' justifies it according
|
|
|
556 ;; to the current system state. If the advised definition was
|
|
|
557 ;; constructed during "preactivation" (see below) then that definition will
|
|
|
558 ;; be already compiled because it was constructed during byte-compilation of
|
|
|
559 ;; the file that contained the `defadvice' with the `preactivate' flag.
|
|
|
560
|
|
|
561 ;; `ad-deactivate' can be used to back-define an advised function to its
|
|
|
562 ;; original definition. It can be called interactively or directly. Because
|
|
|
563 ;; `ad-activate' caches the advised definition the function can be
|
|
|
564 ;; reactivated via `ad-activate' with only minor overhead (it is checked
|
|
|
565 ;; whether the current advice state is consistent with the cached
|
|
|
566 ;; definition, see the section on caching below).
|
|
|
567
|
|
|
568 ;; `ad-activate-regexp' and `ad-deactivate-regexp' can be used to de/activate
|
|
|
569 ;; all currently advised function that have a piece of advice with a name that
|
|
|
570 ;; contains a match for a regular expression. These functions can be used to
|
|
|
571 ;; de/activate sets of functions depending on certain advice naming
|
|
|
572 ;; conventions.
|
|
|
573
|
|
|
574 ;; Finally, `ad-activate-all' and `ad-deactivate-all' can be used to
|
|
|
575 ;; de/activate all currently advised functions. These are useful to
|
|
|
576 ;; (temporarily) return to an un/advised state.
|
|
|
577
|
|
|
578 ;; @@@ Reasons for the separation of advice definition and activation:
|
|
|
579 ;; ===================================================================
|
|
|
580 ;; As already mentioned, advising happens in two stages:
|
|
|
581
|
|
|
582 ;; 1) definition of various pieces of advice
|
|
|
583 ;; 2) activation of all advice currently defined and enabled
|
|
|
584
|
|
|
585 ;; The advantage of this is that various pieces of advice can be defined
|
|
|
586 ;; before they get combined into an advised definition which avoids
|
|
|
587 ;; unnecessary constructions of intermediate advised definitions. The more
|
|
|
588 ;; important advantage is that it allows the implementation of forward advice.
|
|
|
589 ;; Advice information for a certain function accumulates as the value of the
|
|
|
590 ;; `advice-info' property of the function symbol. This accumulation is
|
|
|
591 ;; completely independent of the fact that that function might not yet be
|
|
|
592 ;; defined. The special forms `defun' and `defmacro' have been advised to
|
|
|
593 ;; check whether the function/macro they defined had advice information
|
|
|
594 ;; associated with it. If so and forward advice is enabled, the original
|
|
|
595 ;; definition will be saved, and then the advice will be activated. When a
|
|
|
596 ;; file is loaded in a v18 Emacs the functions/macros it defines are also
|
|
|
597 ;; defined with calls to `defun/defmacro'. Hence, we can forward advise
|
|
|
598 ;; functions/macros which will be defined later during a load/autoload of some
|
|
|
599 ;; file (for compiled files generated by jwz's byte-compiler in a v19 Emacs
|
|
|
600 ;; this is slightly more complicated but the basic idea is the same).
|
|
|
601
|
|
|
602 ;; @@ Enabling/disabling pieces or sets of advice:
|
|
|
603 ;; ===============================================
|
|
|
604 ;; A major motivation for the development of this advice package was to bring
|
|
|
605 ;; a little bit more structure into the function overloading chaos in Emacs
|
|
|
606 ;; Lisp. Many packages achieve some of their functionality by adding a little
|
|
|
607 ;; bit (or a lot) to the standard functionality of some Emacs Lisp function.
|
|
|
608 ;; ange-ftp is a very popular package that achieves its magic by overloading
|
|
|
609 ;; most Emacs Lisp functions that deal with files. A popular function that's
|
|
|
610 ;; overloaded by many packages is `expand-file-name'. The situation that one
|
|
|
611 ;; function is multiply overloaded can arise easily.
|
|
|
612
|
|
|
613 ;; Once in a while it would be desirable to be able to disable some/all
|
|
|
614 ;; overloads of a particular package while keeping all the rest. Ideally -
|
|
|
615 ;; at least in my opinion - these overloads would all be done with advice,
|
|
|
616 ;; I know I am dreaming right now... In that ideal case the enable/disable
|
|
|
617 ;; mechanism of advice could be used to achieve just that.
|
|
|
618
|
|
|
619 ;; Every piece of advice is associated with an enablement flag. When the
|
|
|
620 ;; advised definition of a particular function gets constructed (e.g., during
|
|
|
621 ;; activation) only the currently enabled pieces of advice will be considered.
|
|
|
622 ;; This mechanism allows one to have different "views" of an advised function
|
|
|
623 ;; dependent on what pieces of advice are currently enabled.
|
|
|
624
|
|
|
625 ;; Another motivation for this mechanism is that it allows one to define a
|
|
|
626 ;; piece of advice for some function yet keep it dormant until a certain
|
|
|
627 ;; condition is met. Until then activation of the function will not make use
|
|
|
628 ;; of that piece of advice. Once the condition is met the advice can be
|
|
|
629 ;; enabled and a reactivation of the function will add its functionality as
|
|
|
630 ;; part of the new advised definition. For example, the advices of `defun'
|
|
|
631 ;; etc. used by advice itself will stay disabled until `ad-start-advice' is
|
|
|
632 ;; called and some variables have the proper values. Hence, if somebody
|
|
|
633 ;; else advised these functions too and activates them the advices defined
|
|
|
634 ;; by advice will get used only if they are intended to be used.
|
|
|
635
|
|
|
636 ;; The main interface to this mechanism are the interactive functions
|
|
|
637 ;; `ad-enable-advice' and `ad-disable-advice'. For example, the following
|
|
|
638 ;; would disable a particular advice of the function `foo':
|
|
|
639 ;;
|
|
|
640 ;; (ad-disable-advice 'foo 'before 'my-advice)
|
|
|
641 ;;
|
|
|
642 ;; This call by itself only changes the flag, to get the proper effect in
|
|
|
643 ;; the advised definition too one has to activate `foo' with
|
|
|
644 ;;
|
|
|
645 ;; (ad-activate 'foo)
|
|
|
646 ;;
|
|
|
647 ;; or interactively. To disable whole sets of advices one can use a regular
|
|
|
648 ;; expression mechanism. For example, let us assume that ange-ftp actually
|
|
|
649 ;; used advice to overload all its functions, and that it used the
|
|
|
650 ;; "ange-ftp-" prefix for all its advice names, then we could temporarily
|
|
|
651 ;; disable all its advices with
|
|
|
652 ;;
|
|
|
653 ;; (ad-disable-regexp "^ange-ftp-")
|
|
|
654 ;;
|
|
|
655 ;; and the following call would put that actually into effect:
|
|
|
656 ;;
|
|
|
657 ;; (ad-activate-regexp "^ange-ftp-")
|
|
|
658 ;;
|
|
|
659 ;; A saver way would have been to use
|
|
|
660 ;;
|
|
|
661 ;; (ad-update-regexp "^ange-ftp-")
|
|
|
662 ;;
|
|
|
663 ;; instead which would have only reactivated currently actively advised
|
|
|
664 ;; functions, but not functions that were currently deactivated. All these
|
|
|
665 ;; functions can also be called interactively.
|
|
|
666
|
|
|
667 ;; A certain piece of advice is considered a match if its name contains a
|
|
|
668 ;; match for the regular expression. To enable ange-ftp again we would use
|
|
|
669 ;; `ad-enable-regexp' and then activate or update again.
|
|
|
670
|
|
|
671 ;; @@ Forward advice, automatic advice activation:
|
|
|
672 ;; ===============================================
|
|
|
673 ;; Because most Emacs Lisp packages are loaded on demand via an autoload
|
|
|
674 ;; mechanism it is essential to be able to "forward advise" functions.
|
|
|
675 ;; Otherwise, proper advice definition and activation would make it necessary
|
|
|
676 ;; to preload every file that defines a certain function before it can be
|
|
|
677 ;; advised, which would partly defeat the purpose of the advice mechanism.
|
|
|
678
|
|
|
679 ;; In the following, "forward advice" always implies its automatic activation
|
|
|
680 ;; once a function gets defined, and not just the accumulation of advice
|
|
|
681 ;; information for a possibly undefined function.
|
|
|
682
|
|
|
683 ;; Advice implements forward advice mainly via the following: 1) Separation
|
|
|
684 ;; of advice definition and activation that makes it possible to accumulate
|
|
|
685 ;; advice information without having the original function already defined,
|
|
|
686 ;; 2) special versions of the built-in functions `fset/defalias' which check
|
|
|
687 ;; for advice information whenever they define a function. If advice
|
|
|
688 ;; information was found then the advice will immediately get activated when
|
|
|
689 ;; the function gets defined.
|
|
|
690
|
|
|
691 ;; Automatic advice activation means, that whenever a function gets defined
|
|
|
692 ;; with either `defun', `defmacro', `fset' or by loading a byte-compiled
|
|
|
693 ;; file, and the function has some advice-info stored with it then that
|
|
|
694 ;; advice will get activated right away.
|
|
|
695
|
|
|
696 ;; @@@ Enabling automatic advice activation:
|
|
|
697 ;; =========================================
|
|
|
698 ;; Automatic advice activation is enabled by default. It can be disabled by
|
|
|
699 ;; doint `M-x ad-stop-advice' and enabled again with `M-x ad-start-advice'.
|
|
|
700
|
|
|
701 ;; @@ Caching of advised definitions:
|
|
|
702 ;; ==================================
|
|
|
703 ;; After an advised definition got constructed it gets cached as part of the
|
|
|
704 ;; advised function's advice-info so it can be reused, for example, after an
|
|
|
705 ;; intermediate deactivation. Because the advice-info of a function might
|
|
|
706 ;; change between the time of caching and reuse a cached definition gets
|
|
|
707 ;; a cache-id associated with it so it can be verified whether the cached
|
|
|
708 ;; definition is still valid (the main application of this is preactivation
|
|
|
709 ;; - see below).
|
|
|
710
|
|
|
711 ;; When an advised function gets activated and a verifiable cached definition
|
|
|
712 ;; is available, then that definition will be used instead of creating a new
|
|
|
713 ;; advised definition from scratch. If you want to make sure that a new
|
|
|
714 ;; definition gets constructed then you should use `ad-clear-cache' before you
|
|
|
715 ;; activate the advised function.
|
|
|
716
|
|
|
717 ;; @@ Preactivation:
|
|
|
718 ;; =================
|
|
|
719 ;; Constructing an advised definition is moderately expensive. In a situation
|
|
|
720 ;; where one package defines a lot of advised functions it might be
|
|
|
721 ;; prohibitively expensive to do all the advised definition construction at
|
|
|
722 ;; runtime. Preactivation is a mechanism that allows compile-time construction
|
|
|
723 ;; of compiled advised definitions that can be activated cheaply during
|
|
|
724 ;; runtime. Preactivation uses the caching mechanism to do that. Here's how it
|
|
|
725 ;; works:
|
|
|
726
|
|
|
727 ;; When the byte-compiler compiles a `defadvice' that has the `preactivate'
|
|
|
728 ;; flag specified, it uses the current original definition of the advised
|
|
|
729 ;; function plus the advice specified in this `defadvice' (even if it is
|
|
|
730 ;; specified as disabled) and all other currently enabled pieces of advice to
|
|
|
731 ;; construct an advised definition and an identifying cache-id and makes them
|
|
|
732 ;; part of the `defadvice' expansion which will then be compiled by the
|
|
|
733 ;; byte-compiler (to ensure that in a v18 emacs you have to put the
|
|
|
734 ;; `defadvice' inside a `defun' to get it compiled and then you have to call
|
|
|
735 ;; that compiled `defun' in order to actually execute the `defadvice'). When
|
|
|
736 ;; the file with the compiled, preactivating `defadvice' gets loaded the
|
|
|
737 ;; precompiled advised definition will be cached on the advised function's
|
|
|
738 ;; advice-info. When it gets activated (can be immediately on execution of the
|
|
|
739 ;; `defadvice' or any time later) the cache-id gets checked against the
|
|
|
740 ;; current state of advice and if it is verified the precompiled definition
|
|
|
741 ;; will be used directly (the verification is pretty cheap). If it couldn't get
|
|
|
742 ;; verified a new advised definition for that function will be built from
|
|
|
743 ;; scratch, hence, the efficiency added by the preactivation mechanism does
|
|
|
744 ;; not at all impair the flexibility of the advice mechanism.
|
|
|
745
|
|
|
746 ;; MORAL: In order get all the efficiency out of preactivation the advice
|
|
|
747 ;; state of an advised function at the time the file with the
|
|
|
748 ;; preactivating `defadvice' gets byte-compiled should be exactly
|
|
|
749 ;; the same as it will be when the advice of that function gets
|
|
|
750 ;; actually activated. If it is not there is a high chance that the
|
|
|
751 ;; cache-id will not match and hence a new advised definition will
|
|
|
752 ;; have to be constructed at runtime.
|
|
|
753
|
|
|
754 ;; Preactivation and forward advice do not contradict each other. It is
|
|
|
755 ;; perfectly ok to load a file with a preactivating `defadvice' before the
|
|
|
756 ;; original definition of the advised function is available. The constructed
|
|
|
757 ;; advised definition will be used once the original function gets defined and
|
|
|
758 ;; its advice gets activated. The only constraint is that at the time the
|
|
|
759 ;; file with the preactivating `defadvice' got compiled the original function
|
|
|
760 ;; definition was available.
|
|
|
761
|
|
|
762 ;; TIPS: Here are some indications that a preactivation did not work the way
|
|
|
763 ;; you intended it to work:
|
|
|
764 ;; - Activation of the advised function takes longer than usual/expected
|
|
|
765 ;; - The byte-compiler gets loaded while an advised function gets
|
|
|
766 ;; activated
|
|
|
767 ;; - `byte-compile' is part of the `features' variable even though you
|
|
|
768 ;; did not use the byte-compiler
|
|
|
769 ;; Right now advice does not provide an elegant way to find out whether
|
|
|
770 ;; and why a preactivation failed. What you can do is to trace the
|
|
|
771 ;; function `ad-cache-id-verification-code' (with the function
|
|
|
772 ;; `trace-function-background' defined in my trace.el package) before
|
|
|
773 ;; any of your advised functions get activated. After they got
|
|
|
774 ;; activated check whether all calls to `ad-cache-id-verification-code'
|
|
|
775 ;; returned `verified' as a result. Other values indicate why the
|
|
|
776 ;; verification failed which should give you enough information to
|
|
|
777 ;; fix your preactivation/compile/load/activation sequence.
|
|
|
778
|
|
|
779 ;; IMPORTANT: There is one case (that I am aware of) that can make
|
|
|
780 ;; preactivation fail, i.e., a preconstructed advised definition that does
|
|
|
781 ;; NOT match the current state of advice gets used nevertheless. That case
|
|
|
782 ;; arises if one package defines a certain piece of advice which gets used
|
|
|
783 ;; during preactivation, and another package incompatibly redefines that
|
|
|
784 ;; very advice (i.e., same function/class/name), and it is the second advice
|
|
|
785 ;; that is available when the preconstructed definition gets activated, and
|
|
|
786 ;; that was the only definition of that advice so far (`ad-add-advice'
|
|
|
787 ;; catches advice redefinitions and clears the cache in such a case).
|
|
|
788 ;; Catching that would make the cache verification too expensive.
|
|
|
789
|
|
|
790 ;; MORAL-II: Redefining somebody else's advice is BAAAAD (to speak with
|
|
|
791 ;; George Walker Bush), and why would you redefine your own advice anyway?
|
|
|
792 ;; Advice is a mechanism to facilitate function redefinition, not advice
|
|
|
793 ;; redefinition (wait until I write Meta-Advice :-). If you really have
|
|
|
794 ;; to undo somebody else's advice try to write a "neutralizing" advice.
|
|
|
795
|
|
|
796 ;; @@ Advising macros and special forms and other dangerous things:
|
|
|
797 ;; ================================================================
|
|
|
798 ;; Look at the corresponding tutorial sections for more information on
|
|
|
799 ;; these topics. Here it suffices to point out that the special treatment
|
|
|
800 ;; of macros and special forms by the byte-compiler can lead to problems
|
|
|
801 ;; when they get advised. Macros can create problems because they get
|
|
|
802 ;; expanded at compile time, hence, they might not have all the necessary
|
|
|
803 ;; runtime support and such advice cannot be de/activated or changed as
|
|
|
804 ;; it is possible for functions. Special forms create problems because they
|
|
|
805 ;; have to be advised "into" macros, i.e., an advised special form is a
|
|
|
806 ;; implemented as a macro, hence, in most cases the byte-compiler will
|
|
|
807 ;; not recognize it as a special form anymore which can lead to very strange
|
|
|
808 ;; results.
|
|
|
809 ;;
|
|
|
810 ;; MORAL: - Only advise macros or special forms when you are absolutely sure
|
|
|
811 ;; what you are doing.
|
|
|
812 ;; - As a safety measure, always do `ad-deactivate-all' before you
|
|
|
813 ;; byte-compile a file to make sure that even if some inconsiderate
|
|
|
814 ;; person advised some special forms you'll get proper compilation
|
|
|
815 ;; results. After compilation do `ad-activate-all' to get back to
|
|
|
816 ;; the previous state.
|
|
|
817
|
|
|
818 ;; @@ Adding a piece of advice with `ad-add-advice':
|
|
|
819 ;; =================================================
|
|
|
820 ;; The non-interactive function `ad-add-advice' can be used to add a piece of
|
|
|
821 ;; advice to some function without using `defadvice'. This is useful if advice
|
|
|
822 ;; has to be added somewhere by a function (also look at `ad-make-advice').
|
|
|
823
|
|
|
824 ;; @@ Activation/deactivation advices, file load hooks:
|
|
|
825 ;; ====================================================
|
|
|
826 ;; There are two special classes of advice called `activation' and
|
|
|
827 ;; `deactivation'. The body forms of these advices are not included into the
|
|
|
828 ;; advised definition of a function, rather they are assembled into a hook
|
|
|
829 ;; form which will be evaluated whenever the advice-info of the advised
|
|
|
830 ;; function gets activated or deactivated. One application of this mechanism
|
|
|
831 ;; is to define file load hooks for files that do not provide such hooks
|
|
|
832 ;; (v19s already come with a general file-load-hook mechanism, v18s don't).
|
|
|
833 ;; For example, suppose you want to print a message whenever `file-x' gets
|
|
|
834 ;; loaded, and suppose the last function defined in `file-x' is
|
|
|
835 ;; `file-x-last-fn'. Then we can define the following advice:
|
|
|
836 ;;
|
|
|
837 ;; (defadvice file-x-last-fn (activation file-x-load-hook)
|
|
|
838 ;; "Executed whenever file-x is loaded"
|
|
|
839 ;; (if load-in-progress (message "Loaded file-x")))
|
|
|
840 ;;
|
|
|
841 ;; This will constitute a forward advice for function `file-x-last-fn' which
|
|
|
842 ;; will get activated when `file-x' is loaded (only if forward advice is
|
|
|
843 ;; enabled of course). Because there are no "real" pieces of advice
|
|
|
844 ;; available for it, its definition will not be changed, but the activation
|
|
|
845 ;; advice will be run during its activation which is equivalent to having a
|
|
|
846 ;; file load hook for `file-x'.
|
|
|
847
|
|
|
848 ;; @@ Summary of main advice concepts:
|
|
|
849 ;; ===================================
|
|
|
850 ;; - Definition:
|
|
|
851 ;; A piece of advice gets defined with `defadvice' and added to the
|
|
|
852 ;; `advice-info' property of a function.
|
|
|
853 ;; - Enablement:
|
|
|
854 ;; Every piece of advice has an enablement flag associated with it. Only
|
|
|
855 ;; enabled advices are considered during construction of an advised
|
|
|
856 ;; definition.
|
|
|
857 ;; - Activation:
|
|
|
858 ;; Redefine an advised function with its advised definition. Constructs
|
|
|
859 ;; an advised definition from scratch if no verifiable cached advised
|
|
|
860 ;; definition is available and caches it.
|
|
|
861 ;; - Deactivation:
|
|
|
862 ;; Back-define an advised function to its original definition.
|
|
|
863 ;; - Update:
|
|
|
864 ;; Reactivate an advised function but only if its advice is currently
|
|
|
865 ;; active. This can be used to bring all currently advised function up
|
|
|
866 ;; to date with the current state of advice without also activating
|
|
|
867 ;; currently deactivated functions.
|
|
|
868 ;; - Caching:
|
|
|
869 ;; Is the saving of an advised definition and an identifying cache-id so
|
|
|
870 ;; it can be reused, for example, for activation after deactivation.
|
|
|
871 ;; - Preactivation:
|
|
|
872 ;; Is the construction of an advised definition according to the current
|
|
|
873 ;; state of advice during byte-compilation of a file with a preactivating
|
|
|
874 ;; `defadvice'. That advised definition can then rather cheaply be used
|
|
|
875 ;; during activation without having to construct an advised definition
|
|
|
876 ;; from scratch at runtime.
|
|
|
877
|
|
|
878 ;; @@ Summary of interactive advice manipulation functions:
|
|
|
879 ;; ========================================================
|
|
|
880 ;; The following interactive functions can be used to manipulate the state
|
|
|
881 ;; of advised functions (all of them support completion on function names,
|
|
|
882 ;; advice classes and advice names):
|
|
|
883
|
|
|
884 ;; - ad-activate to activate the advice of a FUNCTION
|
|
|
885 ;; - ad-deactivate to deactivate the advice of a FUNCTION
|
|
|
886 ;; - ad-update to activate the advice of a FUNCTION unless it was not
|
|
|
887 ;; yet activated or is currently deactivated.
|
|
|
888 ;; - ad-unadvise deactivates a FUNCTION and removes all of its advice
|
|
|
889 ;; information, hence, it cannot be activated again
|
|
|
890 ;; - ad-recover tries to redefine a FUNCTION to its original definition and
|
|
|
891 ;; discards all advice information (a low-level `ad-unadvise').
|
|
|
892 ;; Use only in emergencies.
|
|
|
893
|
|
|
894 ;; - ad-remove-advice removes a particular piece of advice of a FUNCTION.
|
|
|
895 ;; You still have to do call `ad-activate' or `ad-update' to
|
|
|
896 ;; activate the new state of advice.
|
|
|
897 ;; - ad-enable-advice enables a particular piece of advice of a FUNCTION.
|
|
|
898 ;; - ad-disable-advice disables a particular piece of advice of a FUNCTION.
|
|
|
899 ;; - ad-enable-regexp maps over all currently advised functions and enables
|
|
|
900 ;; every advice whose name contains a match for a regular
|
|
|
901 ;; expression.
|
|
|
902 ;; - ad-disable-regexp disables matching advices.
|
|
|
903
|
|
|
904 ;; - ad-activate-regexp activates all advised function with a matching advice
|
|
|
905 ;; - ad-deactivate-regexp deactivates all advised function with matching advice
|
|
|
906 ;; - ad-update-regexp updates all advised function with a matching advice
|
|
|
907 ;; - ad-activate-all activates all advised functions
|
|
|
908 ;; - ad-deactivate-all deactivates all advised functions
|
|
|
909 ;; - ad-update-all updates all advised functions
|
|
|
910 ;; - ad-unadvise-all unadvises all advised functions
|
|
|
911 ;; - ad-recover-all recovers all advised functions
|
|
|
912
|
|
|
913 ;; - ad-compile byte-compiles a function/macro if it is compilable.
|
|
|
914
|
|
|
915 ;; @@ Summary of forms with special meanings when used within an advice:
|
|
|
916 ;; =====================================================================
|
|
|
917 ;; ad-return-value name of the return value variable (get/settable)
|
|
|
918 ;; ad-subr-args name of &rest argument variable used for advised
|
|
|
919 ;; subrs whose actual argument list cannot be
|
|
|
920 ;; determined (get/settable)
|
|
|
921 ;; (ad-get-arg <pos>), (ad-get-args <pos>),
|
|
|
922 ;; (ad-set-arg <pos> <value>), (ad-set-args <pos> <value-list>)
|
|
|
923 ;; argument access text macros to get/set the values of
|
|
|
924 ;; actual arguments at a certain position
|
|
|
925 ;; ad-arg-bindings text macro that returns the actual names, values
|
|
|
926 ;; and types of the arguments as a list of bindings. The
|
|
|
927 ;; order of the bindings corresponds to the order of the
|
|
|
928 ;; arguments. The individual fields of every binding (name,
|
|
|
929 ;; value and type) can be accessed with the function
|
|
|
930 ;; `ad-arg-binding-field' (see example above).
|
|
|
931 ;; ad-do-it text macro that identifies the place where the original
|
|
|
932 ;; or wrapped definition should go in an around advice
|
|
|
933
|
|
|
934
|
|
|
935 ;; @ Foo games: An advice tutorial
|
|
|
936 ;; ===============================
|
|
|
937 ;; The following tutorial was created in Emacs 18.59. Left-justified
|
|
|
938 ;; s-expressions are input forms followed by one or more result forms.
|
|
|
939 ;; First we have to start the advice magic:
|
|
|
940 ;;
|
|
|
941 ;; (ad-start-advice)
|
|
|
942 ;; nil
|
|
|
943 ;;
|
|
|
944 ;; We start by defining an innocent looking function `foo' that simply
|
|
|
945 ;; adds 1 to its argument X:
|
|
|
946 ;;
|
|
|
947 ;; (defun foo (x)
|
|
|
948 ;; "Add 1 to X."
|
|
|
949 ;; (1+ x))
|
|
|
950 ;; foo
|
|
|
951 ;;
|
|
|
952 ;; (foo 3)
|
|
|
953 ;; 4
|
|
|
954 ;;
|
|
|
955 ;; @@ Defining a simple piece of advice:
|
|
|
956 ;; =====================================
|
|
|
957 ;; Now let's define the first piece of advice for `foo'. To do that we
|
|
|
958 ;; use the macro `defadvice' which takes a function name, a list of advice
|
|
|
959 ;; specifiers and a list of body forms as arguments. The first element of
|
|
|
960 ;; the advice specifiers is the class of the advice, the second is its name,
|
|
|
961 ;; the third its position and the rest are some flags. The class of our
|
|
|
962 ;; first advice is `before', its name is `fg-add2', its position among the
|
|
|
963 ;; currently defined before advices (none so far) is `first', and the advice
|
|
|
964 ;; will be `activate'ed immediately. Advice names are global symbols, hence,
|
|
|
965 ;; the name space conventions used for function names should be applied. All
|
|
|
966 ;; advice names in this tutorial will be prefixed with `fg' for `Foo Games'
|
|
|
967 ;; (because everybody has the right to be inconsistent all the function names
|
|
|
968 ;; used in this tutorial do NOT follow this convention).
|
|
|
969 ;;
|
|
|
970 ;; In the body of an advice we can refer to the argument variables of the
|
|
|
971 ;; original function by name. Here we add 1 to X so the effect of calling
|
|
|
972 ;; `foo' will be to actually add 2. All of the advice definitions below only
|
|
|
973 ;; have one body form for simplicity, but there is no restriction to that
|
|
|
974 ;; extent. Every piece of advice can have a documentation string which will
|
|
|
975 ;; be combined with the documentation of the original function.
|
|
|
976 ;;
|
|
|
977 ;; (defadvice foo (before fg-add2 first activate)
|
|
|
978 ;; "Add 2 to X."
|
|
|
979 ;; (setq x (1+ x)))
|
|
|
980 ;; foo
|
|
|
981 ;;
|
|
|
982 ;; (foo 3)
|
|
|
983 ;; 5
|
|
|
984 ;;
|
|
|
985 ;; @@ Specifying the position of an advice:
|
|
|
986 ;; ========================================
|
|
|
987 ;; Now we define the second before advice which will cancel the effect of
|
|
|
988 ;; the previous advice. This time we specify the position as 0 which is
|
|
|
989 ;; equivalent to `first'. A number can be used to specify the zero-based
|
|
|
990 ;; position of an advice among the list of advices in the same class. This
|
|
|
991 ;; time we already have one before advice hence the position specification
|
|
|
992 ;; actually has an effect. So, after the following definition the position
|
|
|
993 ;; of the previous advice will be 1 even though we specified it with `first'
|
|
|
994 ;; above, the reason for this is that the position argument is relative to
|
|
|
995 ;; the currently defined pieces of advice which by now has changed.
|
|
|
996 ;;
|
|
|
997 ;; (defadvice foo (before fg-cancel-add2 0 activate)
|
|
|
998 ;; "Again only add 1 to X."
|
|
|
999 ;; (setq x (1- x)))
|
|
|
1000 ;; foo
|
|
|
1001 ;;
|
|
|
1002 ;; (foo 3)
|
|
|
1003 ;; 4
|
|
|
1004 ;;
|
|
|
1005 ;; @@ Redefining a piece of advice:
|
|
|
1006 ;; ================================
|
|
|
1007 ;; Now we define an advice with the same class and same name but with a
|
|
|
1008 ;; different position. Defining an advice in a class in which an advice with
|
|
|
1009 ;; that name already exists is interpreted as a redefinition of that
|
|
|
1010 ;; particular advice, in which case the position argument will be ignored
|
|
|
1011 ;; and the previous position of the redefined piece of advice is used.
|
|
|
1012 ;; Advice flags can be specified with non-ambiguous initial substrings, hence,
|
|
|
1013 ;; from now on we'll use `act' instead of the verbose `activate'.
|
|
|
1014 ;;
|
|
|
1015 ;; (defadvice foo (before fg-cancel-add2 last act)
|
|
|
1016 ;; "Again only add 1 to X."
|
|
|
1017 ;; (setq x (1- x)))
|
|
|
1018 ;; foo
|
|
|
1019 ;;
|
|
|
1020 ;; @@ Assembly of advised documentation:
|
|
|
1021 ;; =====================================
|
|
|
1022 ;; The documentation strings of the various pieces of advice are assembled
|
|
|
1023 ;; in order which shows that advice `fg-cancel-add2' is still the first
|
|
|
1024 ;; `before' advice even though we specified position `last' above:
|
|
|
1025 ;;
|
|
|
1026 ;; (documentation 'foo)
|
|
|
1027 ;; "Add 1 to X.
|
|
|
1028 ;;
|
|
|
1029 ;; This function is advised with the following advice(s):
|
|
|
1030 ;;
|
|
|
1031 ;; fg-cancel-add2 (before):
|
|
|
1032 ;; Again only add 1 to X.
|
|
|
1033 ;;
|
|
|
1034 ;; fg-add2 (before):
|
|
|
1035 ;; Add 2 to X."
|
|
|
1036 ;;
|
|
|
1037 ;; @@ Advising interactive behavior:
|
|
|
1038 ;; =================================
|
|
|
1039 ;; We can make a function interactive (or change its interactive behavior)
|
|
|
1040 ;; by specifying an interactive form in one of the before or around
|
|
|
1041 ;; advices (there could also be body forms in this advice). The particular
|
|
|
1042 ;; definition always assigns 5 as an argument to X which gives us 6 as a
|
|
|
1043 ;; result when we call foo interactively:
|
|
|
1044 ;;
|
|
|
1045 ;; (defadvice foo (before fg-inter last act)
|
|
|
1046 ;; "Use 5 as argument when called interactively."
|
|
|
1047 ;; (interactive (list 5)))
|
|
|
1048 ;; foo
|
|
|
1049 ;;
|
|
|
1050 ;; (call-interactively 'foo)
|
|
|
1051 ;; 6
|
|
|
1052 ;;
|
|
|
1053 ;; If more than one advice have an interactive declaration, then the one of
|
|
|
1054 ;; the advice with the smallest position will be used (before advices go
|
|
|
1055 ;; before around and after advices), hence, the declaration below does
|
|
|
1056 ;; not have any effect:
|
|
|
1057 ;;
|
|
|
1058 ;; (defadvice foo (before fg-inter2 last act)
|
|
|
1059 ;; (interactive (list 6)))
|
|
|
1060 ;; foo
|
|
|
1061 ;;
|
|
|
1062 ;; (call-interactively 'foo)
|
|
|
1063 ;; 6
|
|
|
1064 ;;
|
|
|
1065 ;; Let's have a look at what the definition of `foo' looks like now
|
|
|
1066 ;; (indentation added by hand for legibility):
|
|
|
1067 ;;
|
|
|
1068 ;; (symbol-function 'foo)
|
|
|
1069 ;; (lambda (x)
|
|
|
1070 ;; "$ad-doc: foo$"
|
|
|
1071 ;; (interactive (list 5))
|
|
|
1072 ;; (let (ad-return-value)
|
|
|
1073 ;; (setq x (1- x))
|
|
|
1074 ;; (setq x (1+ x))
|
|
|
1075 ;; (setq ad-return-value (ad-Orig-foo x))
|
|
|
1076 ;; ad-return-value))
|
|
|
1077 ;;
|
|
|
1078 ;; @@ Around advices:
|
|
|
1079 ;; ==================
|
|
|
1080 ;; Now we'll try some `around' advices. An around advice is a wrapper around
|
|
|
1081 ;; the original definition. It can shadow or establish bindings for the
|
|
|
1082 ;; original definition, and it can look at and manipulate the value returned
|
|
|
1083 ;; by the original function. The position of the special keyword `ad-do-it'
|
|
|
1084 ;; specifies where the code of the original function will be executed. The
|
|
|
1085 ;; keyword can appear multiple times which will result in multiple calls of
|
|
|
1086 ;; the original function in the resulting advised code. Note, that if we don't
|
|
|
1087 ;; specify a position argument (i.e., `first', `last' or a number), then
|
|
|
1088 ;; `first' (or 0) is the default):
|
|
|
1089 ;;
|
|
|
1090 ;; (defadvice foo (around fg-times-2 act)
|
|
|
1091 ;; "First double X."
|
|
|
1092 ;; (let ((x (* x 2)))
|
|
|
1093 ;; ad-do-it))
|
|
|
1094 ;; foo
|
|
|
1095 ;;
|
|
|
1096 ;; (foo 3)
|
|
|
1097 ;; 7
|
|
|
1098 ;;
|
|
|
1099 ;; Around advices are assembled like onion skins where the around advice
|
|
|
1100 ;; with position 0 is the outermost skin and the advice at the last position
|
|
|
1101 ;; is the innermost skin which is directly wrapped around the call of the
|
|
|
1102 ;; original definition of the function. Hence, after the next `defadvice' we
|
|
|
1103 ;; will first multiply X by 2 then add 1 and then call the original
|
|
|
1104 ;; definition (i.e., add 1 again):
|
|
|
1105 ;;
|
|
|
1106 ;; (defadvice foo (around fg-add-1 last act)
|
|
|
1107 ;; "Add 1 to X."
|
|
|
1108 ;; (let ((x (1+ x)))
|
|
|
1109 ;; ad-do-it))
|
|
|
1110 ;; foo
|
|
|
1111 ;;
|
|
|
1112 ;; (foo 3)
|
|
|
1113 ;; 8
|
|
|
1114 ;;
|
|
|
1115 ;; Again, let's see what the definition of `foo' looks like so far:
|
|
|
1116 ;;
|
|
|
1117 ;; (symbol-function 'foo)
|
|
|
1118 ;; (lambda (x)
|
|
|
1119 ;; "$ad-doc: foo$"
|
|
|
1120 ;; (interactive (list 5))
|
|
|
1121 ;; (let (ad-return-value)
|
|
|
1122 ;; (setq x (1- x))
|
|
|
1123 ;; (setq x (1+ x))
|
|
|
1124 ;; (let ((x (* x 2)))
|
|
|
1125 ;; (let ((x (1+ x)))
|
|
|
1126 ;; (setq ad-return-value (ad-Orig-foo x))))
|
|
|
1127 ;; ad-return-value))
|
|
|
1128 ;;
|
|
|
1129 ;; @@ Controlling advice activation:
|
|
|
1130 ;; =================================
|
|
|
1131 ;; In every `defadvice' so far we have used the flag `activate' to activate
|
|
|
1132 ;; the advice immediately after its definition, and that's what we want in
|
|
|
1133 ;; most cases. However, if we define multiple pieces of advice for a single
|
|
|
1134 ;; function then activating every advice immediately is inefficient. A
|
|
|
1135 ;; better way to do this is to only activate the last defined advice.
|
|
|
1136 ;; For example:
|
|
|
1137 ;;
|
|
|
1138 ;; (defadvice foo (after fg-times-x)
|
|
|
1139 ;; "Multiply the result with X."
|
|
|
1140 ;; (setq ad-return-value (* ad-return-value x)))
|
|
|
1141 ;; foo
|
|
|
1142 ;;
|
|
|
1143 ;; This still yields the same result as before:
|
|
|
1144 ;; (foo 3)
|
|
|
1145 ;; 8
|
|
|
1146 ;;
|
|
|
1147 ;; Now we define another advice and activate which will also activate the
|
|
|
1148 ;; previous advice `fg-times-x'. Note the use of the special variable
|
|
|
1149 ;; `ad-return-value' in the body of the advice which is set to the result of
|
|
|
1150 ;; the original function. If we change its value then the value returned by
|
|
|
1151 ;; the advised function will be changed accordingly:
|
|
|
1152 ;;
|
|
|
1153 ;; (defadvice foo (after fg-times-x-again act)
|
|
|
1154 ;; "Again multiply the result with X."
|
|
|
1155 ;; (setq ad-return-value (* ad-return-value x)))
|
|
|
1156 ;; foo
|
|
|
1157 ;;
|
|
|
1158 ;; Now the advices have an effect:
|
|
|
1159 ;;
|
|
|
1160 ;; (foo 3)
|
|
|
1161 ;; 72
|
|
|
1162 ;;
|
|
|
1163 ;; @@ Protecting advice execution:
|
|
|
1164 ;; ===============================
|
|
|
1165 ;; Once in a while we define an advice to perform some cleanup action,
|
|
|
1166 ;; for example:
|
|
|
1167 ;;
|
|
|
1168 ;; (defadvice foo (after fg-cleanup last act)
|
|
|
1169 ;; "Do some cleanup."
|
|
|
1170 ;; (print "Let's clean up now!"))
|
|
|
1171 ;; foo
|
|
|
1172 ;;
|
|
|
1173 ;; However, in case of an error the cleanup won't be performed:
|
|
|
1174 ;;
|
|
|
1175 ;; (condition-case error
|
|
|
1176 ;; (foo t)
|
|
|
1177 ;; (error 'error-in-foo))
|
|
|
1178 ;; error-in-foo
|
|
|
1179 ;;
|
|
|
1180 ;; To make sure a certain piece of advice gets executed even if some error or
|
|
|
1181 ;; non-local exit occurred in any preceding code, we can protect it by using
|
|
|
1182 ;; the `protect' keyword. (if any of the around advices is protected then the
|
|
|
1183 ;; whole around advice onion will be protected):
|
|
|
1184 ;;
|
|
|
1185 ;; (defadvice foo (after fg-cleanup prot act)
|
|
|
1186 ;; "Do some protected cleanup."
|
|
|
1187 ;; (print "Let's clean up now!"))
|
|
|
1188 ;; foo
|
|
|
1189 ;;
|
|
|
1190 ;; Now the cleanup form will be executed even in case of an error:
|
|
|
1191 ;;
|
|
|
1192 ;; (condition-case error
|
|
|
1193 ;; (foo t)
|
|
|
1194 ;; (error 'error-in-foo))
|
|
|
1195 ;; "Let's clean up now!"
|
|
|
1196 ;; error-in-foo
|
|
|
1197 ;;
|
|
|
1198 ;; Again, let's see what `foo' looks like:
|
|
|
1199 ;;
|
|
|
1200 ;; (symbol-function 'foo)
|
|
|
1201 ;; (lambda (x)
|
|
|
1202 ;; "$ad-doc: foo$"
|
|
|
1203 ;; (interactive (list 5))
|
|
|
1204 ;; (let (ad-return-value)
|
|
|
1205 ;; (unwind-protect
|
|
|
1206 ;; (progn (setq x (1- x))
|
|
|
1207 ;; (setq x (1+ x))
|
|
|
1208 ;; (let ((x (* x 2)))
|
|
|
1209 ;; (let ((x (1+ x)))
|
|
|
1210 ;; (setq ad-return-value (ad-Orig-foo x))))
|
|
|
1211 ;; (setq ad-return-value (* ad-return-value x))
|
|
|
1212 ;; (setq ad-return-value (* ad-return-value x)))
|
|
|
1213 ;; (print "Let's clean up now!"))
|
|
|
1214 ;; ad-return-value))
|
|
|
1215 ;;
|
|
|
1216 ;; @@ Compilation of advised definitions:
|
|
|
1217 ;; ======================================
|
|
|
1218 ;; Finally, we can specify the `compile' keyword in a `defadvice' to say
|
|
|
1219 ;; that we want the resulting advised function to be byte-compiled
|
|
|
1220 ;; (`compile' will be ignored unless we also specified `activate'):
|
|
|
1221 ;;
|
|
|
1222 ;; (defadvice foo (after fg-cleanup prot act comp)
|
|
|
1223 ;; "Do some protected cleanup."
|
|
|
1224 ;; (print "Let's clean up now!"))
|
|
|
1225 ;; foo
|
|
|
1226 ;;
|
|
|
1227 ;; Now `foo' is byte-compiled:
|
|
|
1228 ;;
|
|
|
1229 ;; (symbol-function 'foo)
|
|
|
1230 ;; (lambda (x)
|
|
|
1231 ;; "$ad-doc: foo$"
|
|
|
1232 ;; (interactive (byte-code "....." [5] 1))
|
|
|
1233 ;; (byte-code "....." [ad-return-value x nil ((byte-code "....." [print "Let's clean up now!"] 2)) * 2 ad-Orig-foo] 6))
|
|
|
1234 ;;
|
|
|
1235 ;; (foo 3)
|
|
|
1236 ;; "Let's clean up now!"
|
|
|
1237 ;; 72
|
|
|
1238 ;;
|
|
|
1239 ;; @@ Enabling and disabling pieces of advice:
|
|
|
1240 ;; ===========================================
|
|
|
1241 ;; Once in a while it is desirable to temporarily disable a piece of advice
|
|
|
1242 ;; so that it won't be considered during activation, for example, if two
|
|
|
1243 ;; different packages advise the same function and one wants to temporarily
|
|
|
1244 ;; neutralize the effect of the advice of one of the packages.
|
|
|
1245 ;;
|
|
|
1246 ;; The following disables the after advice `fg-times-x' in the function `foo'.
|
|
|
1247 ;; All that does is to change a flag for this particular advice. All the
|
|
|
1248 ;; other information defining it will be left unchanged (e.g., its relative
|
|
|
1249 ;; position in this advice class, etc.).
|
|
|
1250 ;;
|
|
|
1251 ;; (ad-disable-advice 'foo 'after 'fg-times-x)
|
|
|
1252 ;; nil
|
|
|
1253 ;;
|
|
|
1254 ;; For this to have an effect we have to activate `foo':
|
|
|
1255 ;;
|
|
|
1256 ;; (ad-activate 'foo)
|
|
|
1257 ;; foo
|
|
|
1258 ;;
|
|
|
1259 ;; (foo 3)
|
|
|
1260 ;; "Let's clean up now!"
|
|
|
1261 ;; 24
|
|
|
1262 ;;
|
|
|
1263 ;; If we want to disable all multiplication advices in `foo' we can use a
|
|
|
1264 ;; regular expression that matches the names of such advices. Actually, any
|
|
|
1265 ;; advice name that contains a match for the regular expression will be
|
|
|
1266 ;; called a match. A special advice class `any' can be used to consider
|
|
|
1267 ;; all advice classes:
|
|
|
1268 ;;
|
|
|
1269 ;; (ad-disable-advice 'foo 'any "^fg-.*times")
|
|
|
1270 ;; nil
|
|
|
1271 ;;
|
|
|
1272 ;; (ad-activate 'foo)
|
|
|
1273 ;; foo
|
|
|
1274 ;;
|
|
|
1275 ;; (foo 3)
|
|
|
1276 ;; "Let's clean up now!"
|
|
|
1277 ;; 5
|
|
|
1278 ;;
|
|
|
1279 ;; To enable the disabled advice we could use either `ad-enable-advice'
|
|
|
1280 ;; similar to `ad-disable-advice', or as an alternative `ad-enable-regexp'
|
|
|
1281 ;; which will enable matching advices in ALL currently advised functions.
|
|
|
1282 ;; Hence, this can be used to dis/enable advices made by a particular
|
|
|
1283 ;; package to a set of functions as long as that package obeys standard
|
|
|
1284 ;; advice name conventions. We prefixed all advice names with `fg-', hence
|
|
|
1285 ;; the following will do the trick (`ad-enable-regexp' returns the number
|
|
|
1286 ;; of matched advices):
|
|
|
1287 ;;
|
|
|
1288 ;; (ad-enable-regexp "^fg-")
|
|
|
1289 ;; 9
|
|
|
1290 ;;
|
|
|
1291 ;; The following will activate all currently active advised functions that
|
|
|
1292 ;; contain some advice matched by the regular expression. This is a save
|
|
|
1293 ;; way to update the activation of advised functions whose advice changed
|
|
|
1294 ;; in some way or other without accidentally also activating currently
|
|
|
1295 ;; deactivated functions:
|
|
|
1296 ;;
|
|
|
1297 ;; (ad-update-regexp "^fg-")
|
|
|
1298 ;; nil
|
|
|
1299 ;;
|
|
|
1300 ;; (foo 3)
|
|
|
1301 ;; "Let's clean up now!"
|
|
|
1302 ;; 72
|
|
|
1303 ;;
|
|
|
1304 ;; Another use for the dis/enablement mechanism is to define a piece of advice
|
|
|
1305 ;; and keep it "dormant" until a particular condition is satisfied, i.e., until
|
|
|
1306 ;; then the advice will not be used during activation. The `disable' flag lets
|
|
|
1307 ;; one do that with `defadvice':
|
|
|
1308 ;;
|
|
|
1309 ;; (defadvice foo (before fg-1-more dis)
|
|
|
1310 ;; "Add yet 1 more."
|
|
|
1311 ;; (setq x (1+ x)))
|
|
|
1312 ;; foo
|
|
|
1313 ;;
|
|
|
1314 ;; (ad-activate 'foo)
|
|
|
1315 ;; foo
|
|
|
1316 ;;
|
|
|
1317 ;; (foo 3)
|
|
|
1318 ;; "Let's clean up now!"
|
|
|
1319 ;; 72
|
|
|
1320 ;;
|
|
|
1321 ;; (ad-enable-advice 'foo 'before 'fg-1-more)
|
|
|
1322 ;; nil
|
|
|
1323 ;;
|
|
|
1324 ;; (ad-activate 'foo)
|
|
|
1325 ;; foo
|
|
|
1326 ;;
|
|
|
1327 ;; (foo 3)
|
|
|
1328 ;; "Let's clean up now!"
|
|
|
1329 ;; 160
|
|
|
1330 ;;
|
|
|
1331 ;; @@ Caching:
|
|
|
1332 ;; ===========
|
|
|
1333 ;; Advised definitions get cached to allow efficient activation/deactivation
|
|
|
1334 ;; without having to reconstruct them if nothing in the advice-info of a
|
|
|
1335 ;; function has changed. The following idiom can be used to temporarily
|
|
|
1336 ;; deactivate functions that have a piece of advice defined by a certain
|
|
|
1337 ;; package (we save the old definition to check out caching):
|
|
|
1338 ;;
|
|
|
1339 ;; (setq old-definition (symbol-function 'foo))
|
|
|
1340 ;; (lambda (x) ....)
|
|
|
1341 ;;
|
|
|
1342 ;; (ad-deactivate-regexp "^fg-")
|
|
|
1343 ;; nil
|
|
|
1344 ;;
|
|
|
1345 ;; (foo 3)
|
|
|
1346 ;; 4
|
|
|
1347 ;;
|
|
|
1348 ;; (ad-activate-regexp "^fg-")
|
|
|
1349 ;; nil
|
|
|
1350 ;;
|
|
|
1351 ;; (eq old-definition (symbol-function 'foo))
|
|
|
1352 ;; t
|
|
|
1353 ;;
|
|
|
1354 ;; (foo 3)
|
|
|
1355 ;; "Let's clean up now!"
|
|
|
1356 ;; 160
|
|
|
1357 ;;
|
|
|
1358 ;; @@ Forward advice:
|
|
|
1359 ;; ==================
|
|
|
1360 ;; To enable automatic activation of forward advice we first have to set
|
|
|
1361 ;; `ad-activate-on-definition' to t and restart advice:
|
|
|
1362 ;;
|
|
|
1363 ;; (setq ad-activate-on-definition t)
|
|
|
1364 ;; t
|
|
|
1365 ;;
|
|
|
1366 ;; (ad-start-advice)
|
|
|
1367 ;; (ad-activate-defined-function)
|
|
|
1368 ;;
|
|
|
1369 ;; Let's define a piece of advice for an undefined function:
|
|
|
1370 ;;
|
|
|
1371 ;; (defadvice bar (before fg-sub-1-more act)
|
|
|
1372 ;; "Subtract one more from X."
|
|
|
1373 ;; (setq x (1- x)))
|
|
|
1374 ;; bar
|
|
|
1375 ;;
|
|
|
1376 ;; `bar' is not yet defined:
|
|
|
1377 ;; (fboundp 'bar)
|
|
|
1378 ;; nil
|
|
|
1379 ;;
|
|
|
1380 ;; Now we define it and the forward advice will get activated (only because
|
|
|
1381 ;; `ad-activate-on-definition' was t when we started advice above with
|
|
|
1382 ;; `ad-start-advice'):
|
|
|
1383 ;;
|
|
|
1384 ;; (defun bar (x)
|
|
|
1385 ;; "Subtract 1 from X."
|
|
|
1386 ;; (1- x))
|
|
|
1387 ;; bar
|
|
|
1388 ;;
|
|
|
1389 ;; (bar 4)
|
|
|
1390 ;; 2
|
|
|
1391 ;;
|
|
|
1392 ;; Redefinition will activate any available advice if the value of
|
|
|
1393 ;; `ad-redefinition-action' is either `warn', `accept' or `discard':
|
|
|
1394 ;;
|
|
|
1395 ;; (defun bar (x)
|
|
|
1396 ;; "Subtract 2 from X."
|
|
|
1397 ;; (- x 2))
|
|
|
1398 ;; bar
|
|
|
1399 ;;
|
|
|
1400 ;; (bar 4)
|
|
|
1401 ;; 1
|
|
|
1402 ;;
|
|
|
1403 ;; @@ Preactivation:
|
|
|
1404 ;; =================
|
|
|
1405 ;; Constructing advised definitions is moderately expensive, hence, it is
|
|
|
1406 ;; desirable to have a way to construct them at byte-compile time.
|
|
|
1407 ;; Preactivation is a mechanism that allows one to do that.
|
|
|
1408 ;;
|
|
|
1409 ;; (defun fie (x)
|
|
|
1410 ;; "Multiply X by 2."
|
|
|
1411 ;; (* x 2))
|
|
|
1412 ;; fie
|
|
|
1413 ;;
|
|
|
1414 ;; (defadvice fie (before fg-times-4 preact)
|
|
|
1415 ;; "Multiply X by 4."
|
|
|
1416 ;; (setq x (* x 2)))
|
|
|
1417 ;; fie
|
|
|
1418 ;;
|
|
|
1419 ;; This advice did not affect `fie'...
|
|
|
1420 ;;
|
|
|
1421 ;; (fie 2)
|
|
|
1422 ;; 4
|
|
|
1423 ;;
|
|
|
1424 ;; ...but it constructed a cached definition that will be used once `fie' gets
|
|
|
1425 ;; activated as long as its current advice state is the same as it was during
|
|
|
1426 ;; preactivation:
|
|
|
1427 ;;
|
|
|
1428 ;; (setq cached-definition (ad-get-cache-definition 'fie))
|
|
|
1429 ;; (lambda (x) ....)
|
|
|
1430 ;;
|
|
|
1431 ;; (ad-activate 'fie)
|
|
|
1432 ;; fie
|
|
|
1433 ;;
|
|
|
1434 ;; (eq cached-definition (symbol-function 'fie))
|
|
|
1435 ;; t
|
|
|
1436 ;;
|
|
|
1437 ;; (fie 2)
|
|
|
1438 ;; 8
|
|
|
1439 ;;
|
|
|
1440 ;; If you put a preactivating `defadvice' into a Lisp file that gets byte-
|
|
|
1441 ;; compiled then the constructed advised definition will get compiled by
|
|
|
1442 ;; the byte-compiler. For that to occur in a v18 emacs you have to put the
|
|
|
1443 ;; `defadvice' inside a `defun' because the v18 compiler does not compile
|
|
|
1444 ;; top-level forms other than `defun' or `defmacro', for example,
|
|
|
1445 ;;
|
|
|
1446 ;; (defun fg-defadvice-fum ()
|
|
|
1447 ;; (defadvice fum (before fg-times-4 preact act)
|
|
|
1448 ;; "Multiply X by 4."
|
|
|
1449 ;; (setq x (* x 2))))
|
|
|
1450 ;; fg-defadvice-fum
|
|
|
1451 ;;
|
|
|
1452 ;; So far, no `defadvice' for `fum' got executed, but when we compile
|
|
|
1453 ;; `fg-defadvice-fum' the `defadvice' will be expanded by the byte compiler.
|
|
|
1454 ;; In order for preactivation to be effective we have to have a proper
|
|
|
1455 ;; definition of `fum' around at preactivation time, hence, we define it now:
|
|
|
1456 ;;
|
|
|
1457 ;; (defun fum (x)
|
|
|
1458 ;; "Multiply X by 2."
|
|
|
1459 ;; (* x 2))
|
|
|
1460 ;; fum
|
|
|
1461 ;;
|
|
|
1462 ;; Now we compile the defining function which will construct an advised
|
|
|
1463 ;; definition during expansion of the `defadvice', compile it and store it
|
|
|
1464 ;; as part of the compiled `fg-defadvice-fum':
|
|
|
1465 ;;
|
|
|
1466 ;; (ad-compile-function 'fg-defadvice-fum)
|
|
|
1467 ;; (lambda nil (byte-code ...))
|
|
|
1468 ;;
|
|
|
1469 ;; `fum' is still completely unaffected:
|
|
|
1470 ;;
|
|
|
1471 ;; (fum 2)
|
|
|
1472 ;; 4
|
|
|
1473 ;;
|
|
|
1474 ;; (ad-get-advice-info 'fum)
|
|
|
1475 ;; nil
|
|
|
1476 ;;
|
|
|
1477 ;; (fg-defadvice-fum)
|
|
|
1478 ;; fum
|
|
|
1479 ;;
|
|
|
1480 ;; Now the advised version of `fum' is compiled because the compiled definition
|
|
|
1481 ;; constructed during preactivation was used, even though we did not specify
|
|
|
1482 ;; the `compile' flag:
|
|
|
1483 ;;
|
|
|
1484 ;; (symbol-function 'fum)
|
|
|
1485 ;; (lambda (x)
|
|
|
1486 ;; "$ad-doc: fum$"
|
|
|
1487 ;; (byte-code "....." [ad-return-value x nil * 2 ad-Orig-fum] 4))
|
|
|
1488 ;;
|
|
|
1489 ;; (fum 2)
|
|
|
1490 ;; 8
|
|
|
1491 ;;
|
|
|
1492 ;; A preactivated definition will only be used if it matches the current
|
|
|
1493 ;; function definition and advice information. If it does not match it
|
|
|
1494 ;; will simply be discarded and a new advised definition will be constructed
|
|
|
1495 ;; from scratch. For example, let's first remove all advice-info for `fum':
|
|
|
1496 ;;
|
|
|
1497 ;; (ad-unadvise 'fum)
|
|
|
1498 ;; (("fie") ("bar") ("foo") ...)
|
|
|
1499 ;;
|
|
|
1500 ;; And now define a new piece of advice:
|
|
|
1501 ;;
|
|
|
1502 ;; (defadvice fum (before fg-interactive act)
|
|
|
1503 ;; "Make fum interactive."
|
|
|
1504 ;; (interactive "nEnter x: "))
|
|
|
1505 ;; fum
|
|
|
1506 ;;
|
|
|
1507 ;; When we now try to use a preactivation it will not be used because the
|
|
|
1508 ;; current advice state is different from the one at preactivation time. This
|
|
|
1509 ;; is no tragedy, everything will work as expected just not as efficient,
|
|
|
1510 ;; because a new advised definition has to be constructed from scratch:
|
|
|
1511 ;;
|
|
|
1512 ;; (fg-defadvice-fum)
|
|
|
1513 ;; fum
|
|
|
1514 ;;
|
|
|
1515 ;; A new uncompiled advised definition got constructed:
|
|
|
1516 ;;
|
|
|
1517 ;; (ad-compiled-p (symbol-function 'fum))
|
|
|
1518 ;; nil
|
|
|
1519 ;;
|
|
|
1520 ;; (fum 2)
|
|
|
1521 ;; 8
|
|
|
1522 ;;
|
|
|
1523 ;; MORAL: To get all the efficiency out of preactivation the function
|
|
|
1524 ;; definition and advice state at preactivation time must be the same as the
|
|
|
1525 ;; state at activation time. Preactivation does work with forward advice, all
|
|
|
1526 ;; that's necessary is that the definition of the forward advised function is
|
|
|
1527 ;; available when the `defadvice' with the preactivation gets compiled.
|
|
|
1528 ;;
|
|
|
1529 ;; @@ Portable argument access:
|
|
|
1530 ;; ============================
|
|
|
1531 ;; So far, we always used the actual argument variable names to access an
|
|
|
1532 ;; argument in a piece of advice. For many advice applications this is
|
|
|
1533 ;; perfectly ok and keeps advices simple. However, it decreases portability
|
|
|
1534 ;; of advices because it assumes specific argument variable names. For example,
|
|
|
1535 ;; if one advises a subr such as `eval-region' which then gets redefined by
|
|
|
1536 ;; some package (e.g., edebug) into a function with different argument names,
|
|
|
1537 ;; then a piece of advice written for `eval-region' that was written with
|
|
|
1538 ;; the subr arguments in mind will break. Similar situations arise when one
|
|
|
1539 ;; switches between major Emacs versions, e.g., certain subrs in v18 are
|
|
|
1540 ;; functions in v19 and vice versa. Also, in v19s subr argument lists
|
|
|
1541 ;; are available and will be used, while they are not available in v18.
|
|
|
1542 ;;
|
|
|
1543 ;; Argument access text macros allow one to access arguments of an advised
|
|
|
1544 ;; function in a portable way without having to worry about all these
|
|
|
1545 ;; possibilities. These macros will be translated into the proper access forms
|
|
|
1546 ;; at activation time, hence, argument access will be as efficient as if
|
|
|
1547 ;; the arguments had been used directly in the definition of the advice.
|
|
|
1548 ;;
|
|
|
1549 ;; (defun fuu (x y z)
|
|
|
1550 ;; "Add 3 numbers."
|
|
|
1551 ;; (+ x y z))
|
|
|
1552 ;; fuu
|
|
|
1553 ;;
|
|
|
1554 ;; (fuu 1 1 1)
|
|
|
1555 ;; 3
|
|
|
1556 ;;
|
|
|
1557 ;; Argument access macros specify actual arguments at a certain position.
|
|
|
1558 ;; Position 0 access the first actual argument, position 1 the second etc.
|
|
|
1559 ;; For example, the following advice adds 1 to each of the 3 arguments:
|
|
|
1560 ;;
|
|
|
1561 ;; (defadvice fuu (before fg-add-1-to-all act)
|
|
|
1562 ;; "Adds 1 to all arguments."
|
|
|
1563 ;; (ad-set-arg 0 (1+ (ad-get-arg 0)))
|
|
|
1564 ;; (ad-set-arg 1 (1+ (ad-get-arg 1)))
|
|
|
1565 ;; (ad-set-arg 2 (1+ (ad-get-arg 2))))
|
|
|
1566 ;; fuu
|
|
|
1567 ;;
|
|
|
1568 ;; (fuu 1 1 1)
|
|
|
1569 ;; 6
|
|
|
1570 ;;
|
|
|
1571 ;; Now suppose somebody redefines `fuu' with a rest argument. Our advice
|
|
|
1572 ;; will still work because we used access macros (note, that automatic
|
|
|
1573 ;; advice activation is still in effect, hence, the redefinition of `fuu'
|
|
|
1574 ;; will automatically activate all its advice):
|
|
|
1575 ;;
|
|
|
1576 ;; (defun fuu (&rest numbers)
|
|
|
1577 ;; "Add NUMBERS."
|
|
|
1578 ;; (apply '+ numbers))
|
|
|
1579 ;; fuu
|
|
|
1580 ;;
|
|
|
1581 ;; (fuu 1 1 1)
|
|
|
1582 ;; 6
|
|
|
1583 ;;
|
|
|
1584 ;; (fuu 1 1 1 1 1 1)
|
|
|
1585 ;; 9
|
|
|
1586 ;;
|
|
|
1587 ;; What's important to notice is that argument access macros access actual
|
|
|
1588 ;; arguments regardless of how they got distributed onto argument variables.
|
|
|
1589 ;; In Emacs Lisp the semantics of an actual argument is determined purely
|
|
|
1590 ;; by position, hence, as long as nobody changes the semantics of what a
|
|
|
1591 ;; certain actual argument at a certain position means the access macros
|
|
|
1592 ;; will do the right thing.
|
|
|
1593 ;;
|
|
|
1594 ;; Because of &rest arguments we need a second kind of access macro that
|
|
|
1595 ;; can access all actual arguments starting from a certain position:
|
|
|
1596 ;;
|
|
|
1597 ;; (defadvice fuu (before fg-print-args act)
|
|
|
1598 ;; "Print all arguments."
|
|
|
1599 ;; (print (ad-get-args 0)))
|
|
|
1600 ;; fuu
|
|
|
1601 ;;
|
|
|
1602 ;; (fuu 1 2 3 4 5)
|
|
|
1603 ;; (1 2 3 4 5)
|
|
|
1604 ;; 18
|
|
|
1605 ;;
|
|
|
1606 ;; (defadvice fuu (before fg-set-args act)
|
|
|
1607 ;; "Swaps 2nd and 3rd arg and discards all the rest."
|
|
|
1608 ;; (ad-set-args 1 (list (ad-get-arg 2) (ad-get-arg 1))))
|
|
|
1609 ;; fuu
|
|
|
1610 ;;
|
|
|
1611 ;; (fuu 1 2 3 4 4 4 4 4 4)
|
|
|
1612 ;; (1 3 2)
|
|
|
1613 ;; 9
|
|
|
1614 ;;
|
|
|
1615 ;; (defun fuu (x y z)
|
|
|
1616 ;; "Add 3 numbers."
|
|
|
1617 ;; (+ x y z))
|
|
|
1618 ;;
|
|
|
1619 ;; (fuu 1 2 3)
|
|
|
1620 ;; (1 3 2)
|
|
|
1621 ;; 9
|
|
|
1622 ;;
|
|
|
1623 ;; @@ Defining the argument list of an advised function:
|
|
|
1624 ;; =====================================================
|
|
|
1625 ;; Once in a while it might be desirable to advise a function and additionally
|
|
|
1626 ;; give it an extra argument that controls the advised code, for example, one
|
|
|
1627 ;; might want to make an interactive function sensitive to a prefix argument.
|
|
|
1628 ;; For such cases `defadvice' allows the specification of an argument list
|
|
|
1629 ;; for the advised function. Similar to the redefinition of interactive
|
|
|
1630 ;; behavior, the first argument list specification found in the list of before/
|
|
|
1631 ;; around/after advices will be used. Of course, the specified argument list
|
|
|
1632 ;; should be downward compatible with the original argument list, otherwise
|
|
|
1633 ;; functions that call the advised function with the original argument list
|
|
|
1634 ;; in mind will break.
|
|
|
1635 ;;
|
|
|
1636 ;; (defun fii (x)
|
|
|
1637 ;; "Add 1 to X."
|
|
|
1638 ;; (1+ x))
|
|
|
1639 ;; fii
|
|
|
1640 ;;
|
|
|
1641 ;; Now we advise `fii' to use an optional second argument that controls the
|
|
|
1642 ;; amount of incrementation. A list following the (optional) position
|
|
|
1643 ;; argument of the advice will be interpreted as an argument list
|
|
|
1644 ;; specification. This means you cannot specify an empty argument list, and
|
|
|
1645 ;; why would you want to anyway?
|
|
|
1646 ;;
|
|
|
1647 ;; (defadvice fii (before fg-inc-x (x &optional incr) act)
|
|
|
1648 ;; "Increment X by INCR (default is 1)."
|
|
|
1649 ;; (setq x (+ x (1- (or incr 1)))))
|
|
|
1650 ;; fii
|
|
|
1651 ;;
|
|
|
1652 ;; (fii 3)
|
|
|
1653 ;; 4
|
|
|
1654 ;;
|
|
|
1655 ;; (fii 3 2)
|
|
|
1656 ;; 5
|
|
|
1657 ;;
|
|
|
1658 ;; @@ Specifying argument lists of subrs:
|
|
|
1659 ;; ======================================
|
|
|
1660 ;; The argument lists of subrs cannot be determined directly from Lisp.
|
|
|
1661 ;; This means that Advice has to use `(&rest ad-subr-args)' as the
|
|
|
1662 ;; argument list of the advised subr which is not very efficient. In XEmacs
|
|
|
1663 ;; subr argument lists can be determined from their documentation string, in
|
|
|
1664 ;; Emacs-19 this is the case for some but not all subrs. To accommodate
|
|
|
1665 ;; for the cases where the argument lists cannot be determined (e.g., in a
|
|
|
1666 ;; v18 Emacs) Advice comes with a specification mechanism that allows the
|
|
|
1667 ;; advice programmer to tell advice what the argument list of a certain subr
|
|
|
1668 ;; really is.
|
|
|
1669 ;;
|
|
|
1670 ;; In a v18 Emacs the following will return the &rest idiom:
|
|
|
1671 ;;
|
|
|
1672 ;; (ad-arglist (symbol-function 'car))
|
|
|
1673 ;; (&rest ad-subr-args)
|
|
|
1674 ;;
|
|
|
1675 ;; To tell advice what the argument list of `car' really is we
|
|
|
1676 ;; can do the following:
|
|
|
1677 ;;
|
|
|
1678 ;; (ad-define-subr-args 'car '(list))
|
|
|
1679 ;; ((list))
|
|
|
1680 ;;
|
|
|
1681 ;; Now `ad-arglist' will return the proper argument list (this method is
|
|
|
1682 ;; actually used by advice itself for the advised definition of `fset'):
|
|
|
1683 ;;
|
|
|
1684 ;; (ad-arglist (symbol-function 'car))
|
|
|
1685 ;; (list)
|
|
|
1686 ;;
|
|
|
1687 ;; The defined argument list will be stored on the property list of the
|
|
|
1688 ;; subr name symbol. When advice looks for a subr argument list it first
|
|
|
1689 ;; checks for a definition on the property list, if that fails it tries
|
|
|
1690 ;; to infer it from the documentation string and caches it on the property
|
|
|
1691 ;; list if it was successful, otherwise `(&rest ad-subr-args)' will be used.
|
|
|
1692 ;;
|
|
|
1693 ;; @@ Advising interactive subrs:
|
|
|
1694 ;; ==============================
|
|
|
1695 ;; For the most part there is no difference between advising functions and
|
|
|
1696 ;; advising subrs. There is one situation though where one might have to write
|
|
|
1697 ;; slightly different advice code for subrs than for functions. This case
|
|
|
1698 ;; arises when one wants to access subr arguments in a before/around advice
|
|
|
1699 ;; when the arguments were determined by an interactive call to the subr.
|
|
|
1700 ;; Advice cannot determine what `interactive' form determines the interactive
|
|
|
1701 ;; behavior of the subr, hence, when it calls the original definition in an
|
|
|
1702 ;; interactive subr invocation it has to use `call-interactively' to generate
|
|
|
1703 ;; the proper interactive behavior. Thus up to that call the arguments of the
|
|
|
1704 ;; interactive subr will be nil. For example, the following advice for
|
|
|
1705 ;; `kill-buffer' will not work in an interactive invocation...
|
|
|
1706 ;;
|
|
|
1707 ;; (defadvice kill-buffer (before fg-kill-buffer-hook first act preact comp)
|
|
|
1708 ;; (my-before-kill-buffer-hook (ad-get-arg 0)))
|
|
|
1709 ;; kill-buffer
|
|
|
1710 ;;
|
|
|
1711 ;; ...because the buffer argument will be nil in that case. The way out of
|
|
|
1712 ;; this dilemma is to provide an `interactive' specification that mirrors
|
|
|
1713 ;; the interactive behavior of the unadvised subr, for example, the following
|
|
|
1714 ;; will do the right thing even when `kill-buffer' is called interactively:
|
|
|
1715 ;;
|
|
|
1716 ;; (defadvice kill-buffer (before fg-kill-buffer-hook first act preact comp)
|
|
|
1717 ;; (interactive "bKill buffer: ")
|
|
|
1718 ;; (my-before-kill-buffer-hook (ad-get-arg 0)))
|
|
|
1719 ;; kill-buffer
|
|
|
1720 ;;
|
|
|
1721 ;; @@ Advising macros:
|
|
|
1722 ;; ===================
|
|
|
1723 ;; Advising macros is slightly different because there are two significant
|
|
|
1724 ;; time points in the invocation of a macro: Expansion and evaluation time.
|
|
|
1725 ;; For an advised macro instead of evaluating the original definition we
|
|
|
1726 ;; use `macroexpand', that is, changing argument values and binding
|
|
|
1727 ;; environments by pieces of advice has an affect during macro expansion
|
|
|
1728 ;; but not necessarily during evaluation. In particular, any side effects
|
|
|
1729 ;; of pieces of advice will occur during macro expansion. To also affect
|
|
|
1730 ;; the behavior during evaluation time one has to change the value of
|
|
|
1731 ;; `ad-return-value' in a piece of after advice. For example:
|
|
|
1732 ;;
|
|
|
1733 ;; (defmacro foom (x)
|
|
|
1734 ;; (` (list (, x))))
|
|
|
1735 ;; foom
|
|
|
1736 ;;
|
|
|
1737 ;; (foom '(a))
|
|
|
1738 ;; ((a))
|
|
|
1739 ;;
|
|
|
1740 ;; (defadvice foom (before fg-print-x act)
|
|
|
1741 ;; "Print the value of X."
|
|
|
1742 ;; (print x))
|
|
|
1743 ;; foom
|
|
|
1744 ;;
|
|
|
1745 ;; The following works as expected because evaluation immediately follows
|
|
|
1746 ;; macro expansion:
|
|
|
1747 ;;
|
|
|
1748 ;; (foom '(a))
|
|
|
1749 ;; (quote (a))
|
|
|
1750 ;; ((a))
|
|
|
1751 ;;
|
|
|
1752 ;; However, the printing happens during expansion (or byte-compile) time:
|
|
|
1753 ;;
|
|
|
1754 ;; (macroexpand '(foom '(a)))
|
|
|
1755 ;; (quote (a))
|
|
|
1756 ;; (list (quote (a)))
|
|
|
1757 ;;
|
|
|
1758 ;; If we want it to happen during evaluation time we have to do the
|
|
|
1759 ;; following (first remove the old advice):
|
|
|
1760 ;;
|
|
|
1761 ;; (ad-remove-advice 'foom 'before 'fg-print-x)
|
|
|
1762 ;; nil
|
|
|
1763 ;;
|
|
|
1764 ;; (defadvice foom (after fg-print-x act)
|
|
|
1765 ;; "Print the value of X."
|
|
|
1766 ;; (setq ad-return-value
|
|
|
1767 ;; (` (progn (print (, x))
|
|
|
1768 ;; (, ad-return-value)))))
|
|
|
1769 ;; foom
|
|
|
1770 ;;
|
|
|
1771 ;; (macroexpand '(foom '(a)))
|
|
|
1772 ;; (progn (print (quote (a))) (list (quote (a))))
|
|
|
1773 ;;
|
|
|
1774 ;; (foom '(a))
|
|
|
1775 ;; (a)
|
|
|
1776 ;; ((a))
|
|
|
1777 ;;
|
|
|
1778 ;; While this method might seem somewhat cumbersome, it is very general
|
|
|
1779 ;; because it allows one to influence macro expansion as well as evaluation.
|
|
|
1780 ;; In general, advising macros should be a rather rare activity anyway, in
|
|
|
1781 ;; particular, because compile-time macro expansion takes away a lot of the
|
|
|
1782 ;; flexibility and effectiveness of the advice mechanism. Macros that were
|
|
|
1783 ;; compile-time expanded before the advice was activated will of course never
|
|
|
1784 ;; exhibit the advised behavior.
|
|
|
1785 ;;
|
|
|
1786 ;; @@ Advising special forms:
|
|
|
1787 ;; ==========================
|
|
|
1788 ;; Now for something that should be even more rare than advising macros:
|
|
|
1789 ;; Advising special forms. Because special forms are irregular in their
|
|
|
1790 ;; argument evaluation behavior (e.g., `setq' evaluates the second but not
|
|
|
1791 ;; the first argument) they have to be advised into macros. A dangerous
|
|
|
1792 ;; consequence of this is that the byte-compiler will not recognize them
|
|
|
1793 ;; as special forms anymore (well, in most cases) and use their expansion
|
|
|
1794 ;; rather than the proper byte-code. Also, because the original definition
|
|
|
1795 ;; of a special form cannot be `funcall'ed, `eval' has to be used instead
|
|
|
1796 ;; which is less efficient.
|
|
|
1797 ;;
|
|
|
1798 ;; MORAL: Do not advise special forms unless you are completely sure about
|
|
|
1799 ;; what you are doing (some of the forward advice behavior is
|
|
|
1800 ;; implemented via advice of the special forms `defun' and `defmacro').
|
|
|
1801 ;; As a safety measure one should always do `ad-deactivate-all' before
|
|
|
1802 ;; one byte-compiles a file to avoid any interference of advised
|
|
|
1803 ;; special forms.
|
|
|
1804 ;;
|
|
|
1805 ;; Apart from the safety concerns advising special forms is not any different
|
|
|
1806 ;; from advising plain functions or subrs.
|
|
|
1807
|
|
|
1808
|
|
|
1809 ;;; Code:
|
|
|
1810
|
|
|
1811 ;; @ Advice implementation:
|
|
|
1812 ;; ========================
|
|
|
1813
|
|
|
1814 ;; @@ Compilation idiosyncrasies:
|
|
|
1815 ;; ==============================
|
|
|
1816
|
|
|
1817 ;; `defadvice' expansion needs quite a few advice functions and variables,
|
|
|
1818 ;; hence, I need to preload the file before it can be compiled. To avoid
|
|
|
1819 ;; interference of bogus compiled files I always preload the source file:
|
|
|
1820 (provide 'advice-preload)
|
|
|
1821 ;; During a normal load this is a noop:
|
|
|
1822 (require 'advice-preload "advice.el")
|
|
|
1823
|
|
|
1824
|
|
|
1825 (defmacro ad-xemacs-p ()
|
|
|
1826 ;;Expands into Non-nil constant if we run XEmacs.
|
|
|
1827 ;;Unselected conditional code will be optimized away during compilation.
|
|
|
1828 (string-match "XEmacs" emacs-version))
|
|
|
1829
|
|
|
1830
|
|
|
1831 ;; @@ Variable definitions:
|
|
|
1832 ;; ========================
|
|
|
1833
|
|
|
1834 (defconst ad-version "2.14")
|
|
|
1835
|
|
|
1836 ;;;###autoload
|
|
|
1837 (defvar ad-redefinition-action 'warn
|
|
|
1838 "*Defines what to do with redefinitions during Advice de/activation.
|
|
|
1839 Redefinition occurs if a previously activated function that already has an
|
|
|
1840 original definition associated with it gets redefined and then de/activated.
|
|
|
1841 In such a case we can either accept the current definition as the new
|
|
|
1842 original definition, discard the current definition and replace it with the
|
|
|
1843 old original, or keep it and raise an error. The values `accept', `discard',
|
|
|
1844 `error' or `warn' govern what will be done. `warn' is just like `accept' but
|
|
|
1845 it additionally prints a warning message. All other values will be
|
|
|
1846 interpreted as `error'.")
|
|
|
1847
|
|
|
1848 ;;;###autoload
|
|
|
1849 (defvar ad-default-compilation-action 'maybe
|
|
|
1850 "*Defines whether to compile advised definitions during activation.
|
|
|
1851 A value of `always' will result in unconditional compilation, `never' will
|
|
|
1852 always avoid compilation, `maybe' will compile if the byte-compiler is already
|
|
|
1853 loaded, and `like-original' will compile if the original definition of the
|
|
|
1854 advised function is compiled or a built-in function. Every other value will
|
|
|
1855 be interpreted as `maybe'. This variable will only be considered if the
|
|
|
1856 COMPILE argument of `ad-activate' was supplied as nil.")
|
|
|
1857
|
|
|
1858
|
|
|
1859 ;; @@ Some utilities:
|
|
|
1860 ;; ==================
|
|
|
1861
|
|
|
1862 ;; We don't want the local arguments to interfere with anything
|
|
|
1863 ;; referenced in the supplied functions => the cryptic casing:
|
|
|
1864 (defun ad-substitute-tree (sUbTrEe-TeSt fUnCtIoN tReE)
|
|
|
1865 ;;"Substitutes qualifying subTREEs with result of FUNCTION(subTREE).
|
|
|
1866 ;;Only proper subtrees are considered, for example, if TREE is (1 (2 (3)) 4)
|
|
|
1867 ;;then the subtrees will be 1 (2 (3)) 2 (3) 3 4, dotted structures are
|
|
|
1868 ;;allowed too. Once a qualifying subtree has been found its subtrees will
|
|
|
1869 ;;not be considered anymore. (ad-substitute-tree 'atom 'identity tree)
|
|
|
1870 ;;generates a copy of TREE."
|
|
|
1871 (cond ((consp tReE)
|
|
|
1872 (cons (if (funcall sUbTrEe-TeSt (car tReE))
|
|
|
1873 (funcall fUnCtIoN (car tReE))
|
|
|
1874 (if (consp (car tReE))
|
|
|
1875 (ad-substitute-tree sUbTrEe-TeSt fUnCtIoN (car tReE))
|
|
|
1876 (car tReE)))
|
|
|
1877 (ad-substitute-tree sUbTrEe-TeSt fUnCtIoN (cdr tReE))))
|
|
|
1878 ((funcall sUbTrEe-TeSt tReE)
|
|
|
1879 (funcall fUnCtIoN tReE))
|
|
|
1880 (t tReE)))
|
|
|
1881
|
|
|
1882 ;; this is just faster than `ad-substitute-tree':
|
|
|
1883 (defun ad-copy-tree (tree)
|
|
|
1884 ;;"Returns a copy of the list structure of TREE."
|
|
|
1885 (cond ((consp tree)
|
|
|
1886 (cons (ad-copy-tree (car tree))
|
|
|
1887 (ad-copy-tree (cdr tree))))
|
|
|
1888 (t tree)))
|
|
|
1889
|
|
|
1890 (defmacro ad-dolist (varform &rest body)
|
|
|
1891 "A Common-Lisp-style dolist iterator with the following syntax:
|
|
|
1892
|
|
|
1893 (ad-dolist (VAR INIT-FORM [RESULT-FORM])
|
|
|
1894 BODY-FORM...)
|
|
|
1895
|
|
|
1896 which will iterate over the list yielded by INIT-FORM binding VAR to the
|
|
|
1897 current head at every iteration. If RESULT-FORM is supplied its value will
|
|
|
1898 be returned at the end of the iteration, nil otherwise. The iteration can be
|
|
|
1899 exited prematurely with `(ad-do-return [VALUE])'."
|
|
|
1900 (let ((expansion
|
|
|
1901 (` (let ((ad-dO-vAr (, (car (cdr varform))))
|
|
|
1902 (, (car varform)))
|
|
|
1903 (while ad-dO-vAr
|
|
|
1904 (setq (, (car varform)) (car ad-dO-vAr))
|
|
|
1905 (,@ body)
|
|
|
1906 ;;work around a backquote bug:
|
|
|
1907 ;;(` ((,@ '(foo)) (bar))) => (append '(foo) '(((bar)))) wrong
|
|
|
1908 ;;(` ((,@ '(foo)) (, '(bar)))) => (append '(foo) (list '(bar)))
|
|
|
1909 (, '(setq ad-dO-vAr (cdr ad-dO-vAr))))
|
|
|
1910 (, (car (cdr (cdr varform))))))))
|
|
|
1911 ;;ok, this wastes some cons cells but only during compilation:
|
|
|
1912 (if (catch 'contains-return
|
|
|
1913 (ad-substitute-tree
|
|
|
1914 (function (lambda (subtree)
|
|
|
1915 (cond ((eq (car-safe subtree) 'ad-dolist))
|
|
|
1916 ((eq (car-safe subtree) 'ad-do-return)
|
|
|
1917 (throw 'contains-return t)))))
|
|
|
1918 'identity body)
|
|
|
1919 nil)
|
|
|
1920 (` (catch 'ad-dO-eXiT (, expansion)))
|
|
|
1921 expansion)))
|
|
|
1922
|
|
|
1923 (defmacro ad-do-return (value)
|
|
|
1924 (` (throw 'ad-dO-eXiT (, value))))
|
|
|
1925
|
|
|
1926 (if (not (get 'ad-dolist 'lisp-indent-hook))
|
|
|
1927 (put 'ad-dolist 'lisp-indent-hook 1))
|
|
|
1928
|
|
|
1929
|
|
|
1930 ;; @@ Save real definitions of subrs used by Advice:
|
|
|
1931 ;; =================================================
|
|
|
1932 ;; Advice depends on the real, unmodified functionality of various subrs,
|
|
|
1933 ;; we save them here so advised versions will not interfere (eventually,
|
|
|
1934 ;; we will save all subrs used in code generated by Advice):
|
|
|
1935
|
|
|
1936 (defmacro ad-save-real-definition (function)
|
|
|
1937 (let ((saved-function (intern (format "ad-real-%s" function))))
|
|
|
1938 ;; Make sure the compiler is loaded during macro expansion:
|
|
|
1939 (require 'byte-compile "bytecomp")
|
|
|
1940 (` (if (not (fboundp '(, saved-function)))
|
|
|
1941 (progn (fset '(, saved-function) (symbol-function '(, function)))
|
|
|
1942 ;; Copy byte-compiler properties:
|
|
|
1943 (,@ (if (get function 'byte-compile)
|
|
|
1944 (` ((put '(, saved-function) 'byte-compile
|
|
|
1945 '(, (get function 'byte-compile)))))))
|
|
|
1946 (,@ (if (get function 'byte-opcode)
|
|
|
1947 (` ((put '(, saved-function) 'byte-opcode
|
|
|
1948 '(, (get function 'byte-opcode))))))))))))
|
|
|
1949
|
|
|
1950 (defun ad-save-real-definitions ()
|
|
|
1951 ;; Macro expansion will hardcode the values of the various byte-compiler
|
|
|
1952 ;; properties into the compiled version of this function such that the
|
|
|
1953 ;; proper values will be available at runtime without loading the compiler:
|
|
|
1954 (ad-save-real-definition fset)
|
|
|
1955 (ad-save-real-definition documentation))
|
|
|
1956
|
|
|
1957 (ad-save-real-definitions)
|
|
|
1958
|
|
|
1959
|
|
|
1960 ;; @@ Advice info access fns:
|
|
|
1961 ;; ==========================
|
|
|
1962
|
|
|
1963 ;; Advice information for a particular function is stored on the
|
|
|
1964 ;; advice-info property of the function symbol. It is stored as an
|
|
|
1965 ;; alist of the following format:
|
|
|
1966 ;;
|
|
|
1967 ;; ((active . t/nil)
|
|
|
1968 ;; (before adv1 adv2 ...)
|
|
|
1969 ;; (around adv1 adv2 ...)
|
|
|
1970 ;; (after adv1 adv2 ...)
|
|
|
1971 ;; (activation adv1 adv2 ...)
|
|
|
1972 ;; (deactivation adv1 adv2 ...)
|
|
|
1973 ;; (origname . <symbol fbound to origdef>)
|
|
|
1974 ;; (cache . (<advised-definition> . <id>)))
|
|
|
1975
|
|
|
1976 ;; List of currently advised though not necessarily activated functions
|
|
|
1977 ;; (this list is maintained as a completion table):
|
|
|
1978 (defvar ad-advised-functions nil)
|
|
|
1979
|
|
|
1980 (defmacro ad-pushnew-advised-function (function)
|
|
|
1981 ;;"Add FUNCTION to `ad-advised-functions' unless its already there."
|
|
|
1982 (` (if (not (assoc (symbol-name (, function)) ad-advised-functions))
|
|
|
1983 (setq ad-advised-functions
|
|
|
1984 (cons (list (symbol-name (, function)))
|
|
|
1985 ad-advised-functions)))))
|
|
|
1986
|
|
|
1987 (defmacro ad-pop-advised-function (function)
|
|
|
1988 ;;"Remove FUNCTION from `ad-advised-functions'."
|
|
|
1989 (` (setq ad-advised-functions
|
|
|
1990 (delq (assoc (symbol-name (, function)) ad-advised-functions)
|
|
|
1991 ad-advised-functions))))
|
|
|
1992
|
|
|
1993 (defmacro ad-do-advised-functions (varform &rest body)
|
|
|
1994 ;;"`ad-dolist'-style iterator that maps over `ad-advised-functions'.
|
|
|
1995 ;; (ad-do-advised-functions (VAR [RESULT-FORM])
|
|
|
1996 ;; BODY-FORM...)
|
|
|
1997 ;;Also see `ad-dolist'. On each iteration VAR will be bound to the
|
|
|
1998 ;;name of an advised function (a symbol)."
|
|
|
1999 (` (ad-dolist ((, (car varform))
|
|
|
2000 ad-advised-functions
|
|
|
2001 (, (car (cdr varform))))
|
|
|
2002 (setq (, (car varform)) (intern (car (, (car varform)))))
|
|
|
2003 (,@ body))))
|
|
|
2004
|
|
|
2005 (if (not (get 'ad-do-advised-functions 'lisp-indent-hook))
|
|
|
2006 (put 'ad-do-advised-functions 'lisp-indent-hook 1))
|
|
|
2007
|
|
|
2008 (defmacro ad-get-advice-info (function)
|
|
|
2009 (` (get (, function) 'ad-advice-info)))
|
|
|
2010
|
|
|
2011 (defmacro ad-set-advice-info (function advice-info)
|
|
|
2012 (` (put (, function) 'ad-advice-info (, advice-info))))
|
|
|
2013
|
|
|
2014 (defmacro ad-copy-advice-info (function)
|
|
|
2015 (` (ad-copy-tree (get (, function) 'ad-advice-info))))
|
|
|
2016
|
|
|
2017 (defmacro ad-is-advised (function)
|
|
|
2018 ;;"Returns non-nil if FUNCTION has any advice info associated with it.
|
|
|
2019 ;;This does not mean that the advice is also active."
|
|
|
2020 (list 'ad-get-advice-info function))
|
|
|
2021
|
|
|
2022 (defun ad-initialize-advice-info (function)
|
|
|
2023 ;;"Initializes the advice info for FUNCTION.
|
|
|
2024 ;;Assumes that FUNCTION has not yet been advised."
|
|
|
2025 (ad-pushnew-advised-function function)
|
|
|
2026 (ad-set-advice-info function (list (cons 'active nil))))
|
|
|
2027
|
|
|
2028 (defmacro ad-get-advice-info-field (function field)
|
|
|
2029 ;;"Retrieves the value of the advice info FIELD of FUNCTION."
|
|
|
2030 (` (cdr (assq (, field) (ad-get-advice-info (, function))))))
|
|
|
2031
|
|
|
2032 (defun ad-set-advice-info-field (function field value)
|
|
|
2033 ;;"Destructively modifies VALUE of the advice info FIELD of FUNCTION."
|
|
|
2034 (and (ad-is-advised function)
|
|
|
2035 (cond ((assq field (ad-get-advice-info function))
|
|
|
2036 ;; A field with that name is already present:
|
|
|
2037 (rplacd (assq field (ad-get-advice-info function)) value))
|
|
|
2038 (t;; otherwise, create a new field with that name:
|
|
|
2039 (nconc (ad-get-advice-info function)
|
|
|
2040 (list (cons field value)))))))
|
|
|
2041
|
|
|
2042 ;; Don't make this a macro so we can use it as a predicate:
|
|
|
2043 (defun ad-is-active (function)
|
|
|
2044 ;;"non-nil if FUNCTION is advised and activated."
|
|
|
2045 (ad-get-advice-info-field function 'active))
|
|
|
2046
|
|
|
2047
|
|
|
2048 ;; @@ Access fns for single pieces of advice and related predicates:
|
|
|
2049 ;; =================================================================
|
|
|
2050
|
|
|
2051 (defun ad-make-advice (name protect enable definition)
|
|
|
2052 "Constructs single piece of advice to be stored in some advice-info.
|
|
|
2053 NAME should be a non-nil symbol, PROTECT and ENABLE should each be
|
|
|
2054 either t or nil, and DEFINITION should be a list of the form
|
|
|
2055 `(advice lambda ARGLIST [DOCSTRING] [INTERACTIVE-FORM] BODY...)'."
|
|
|
2056 (list name protect enable definition))
|
|
|
2057
|
|
|
2058 ;; ad-find-advice uses the alist structure directly ->
|
|
|
2059 ;; change if this data structure changes!!
|
|
|
2060 (defmacro ad-advice-name (advice)
|
|
|
2061 (list 'car advice))
|
|
|
2062 (defmacro ad-advice-protected (advice)
|
|
|
2063 (list 'nth 1 advice))
|
|
|
2064 (defmacro ad-advice-enabled (advice)
|
|
|
2065 (list 'nth 2 advice))
|
|
|
2066 (defmacro ad-advice-definition (advice)
|
|
|
2067 (list 'nth 3 advice))
|
|
|
2068
|
|
|
2069 (defun ad-advice-set-enabled (advice flag)
|
|
|
2070 (rplaca (cdr (cdr advice)) flag))
|
|
|
2071
|
|
|
2072 (defun ad-class-p (thing)
|
|
|
2073 (memq thing ad-advice-classes))
|
|
|
2074 (defun ad-name-p (thing)
|
|
|
2075 (and thing (symbolp thing)))
|
|
|
2076 (defun ad-position-p (thing)
|
|
|
2077 (or (natnump thing)
|
|
|
2078 (memq thing '(first last))))
|
|
|
2079
|
|
|
2080
|
|
|
2081 ;; @@ Advice access functions:
|
|
|
2082 ;; ===========================
|
|
|
2083
|
|
|
2084 ;; List of defined advice classes:
|
|
|
2085 (defvar ad-advice-classes '(before around after activation deactivation))
|
|
|
2086
|
|
|
2087 (defun ad-has-enabled-advice (function class)
|
|
|
2088 ;;"True if at least one of FUNCTION's advices in CLASS is enabled."
|
|
|
2089 (ad-dolist (advice (ad-get-advice-info-field function class))
|
|
|
2090 (if (ad-advice-enabled advice) (ad-do-return t))))
|
|
|
2091
|
|
|
2092 (defun ad-has-redefining-advice (function)
|
|
|
2093 ;;"True if FUNCTION's advice info defines at least 1 redefining advice.
|
|
|
2094 ;;Redefining advices affect the construction of an advised definition."
|
|
|
2095 (and (ad-is-advised function)
|
|
|
2096 (or (ad-has-enabled-advice function 'before)
|
|
|
2097 (ad-has-enabled-advice function 'around)
|
|
|
2098 (ad-has-enabled-advice function 'after))))
|
|
|
2099
|
|
|
2100 (defun ad-has-any-advice (function)
|
|
|
2101 ;;"True if the advice info of FUNCTION defines at least one advice."
|
|
|
2102 (and (ad-is-advised function)
|
|
|
2103 (ad-dolist (class ad-advice-classes nil)
|
|
|
2104 (if (ad-get-advice-info-field function class)
|
|
|
2105 (ad-do-return t)))))
|
|
|
2106
|
|
|
2107 (defun ad-get-enabled-advices (function class)
|
|
|
2108 ;;"Returns the list of enabled advices of FUNCTION in CLASS."
|
|
|
2109 (let (enabled-advices)
|
|
|
2110 (ad-dolist (advice (ad-get-advice-info-field function class))
|
|
|
2111 (if (ad-advice-enabled advice)
|
|
|
2112 (setq enabled-advices (cons advice enabled-advices))))
|
|
|
2113 (reverse enabled-advices)))
|
|
|
2114
|
|
|
2115
|
|
|
2116 ;; @@ Dealing with automatic advice activation via `fset/defalias':
|
|
|
2117 ;; ================================================================
|
|
|
2118
|
|
|
2119 ;; Since Emacs 19.26 the built-in versions of `fset' and `defalias'
|
|
|
2120 ;; take care of automatic advice activation, hence, we don't have to
|
|
|
2121 ;; hack it anymore by advising `fset/defun/defmacro/byte-code/etc'.
|
|
|
2122
|
|
|
2123 ;; The functionality of the new `fset' is as follows:
|
|
|
2124 ;;
|
|
|
2125 ;; fset(sym,newdef)
|
|
|
2126 ;; assign NEWDEF to SYM
|
|
|
2127 ;; if (get SYM 'ad-advice-info)
|
|
|
2128 ;; ad-activate(SYM, nil)
|
|
|
2129 ;; return (symbol-function SYM)
|
|
|
2130 ;;
|
|
|
2131 ;; Whether advised definitions created by automatic activations will be
|
|
|
2132 ;; compiled depends on the value of `ad-default-compilation-action'.
|
|
|
2133
|
|
|
2134 ;; Since calling `ad-activate' in the built-in definition of `fset' can
|
|
|
2135 ;; create major disasters we have to be a bit careful. One precaution is
|
|
|
2136 ;; to provide a dummy definition for `ad-activate' which can be used to
|
|
|
2137 ;; turn off automatic advice activation (e.g., when `ad-stop-advice' or
|
|
|
2138 ;; `ad-recover-normality' are called). Another is to avoid recursive calls
|
|
|
2139 ;; to `ad-activate-on' by using `ad-with-auto-activation-disabled' where
|
|
|
2140 ;; appropriate, especially in a safe version of `fset'.
|
|
|
2141
|
|
|
2142 ;; For now define `ad-activate' to the dummy definition:
|
|
|
2143 (defun ad-activate (function &optional compile)
|
|
|
2144 "Automatic advice activation is disabled. `ad-start-advice' enables it."
|
|
|
2145 nil)
|
|
|
2146
|
|
|
2147 ;; This is just a copy of the above:
|
|
|
2148 (defun ad-activate-off (function &optional compile)
|
|
|
2149 "Automatic advice activation is disabled. `ad-start-advice' enables it."
|
|
|
2150 nil)
|
|
|
2151
|
|
|
2152 ;; This will be t for top-level calls to `ad-activate-on':
|
|
|
2153 (defvar ad-activate-on-top-level t)
|
|
|
2154
|
|
|
2155 (defmacro ad-with-auto-activation-disabled (&rest body)
|
|
|
2156 (` (let ((ad-activate-on-top-level nil))
|
|
|
2157 (,@ body))))
|
|
|
2158
|
|
|
2159 (defun ad-safe-fset (symbol definition)
|
|
|
2160 ;; A safe `fset' which will never call `ad-activate' recursively.
|
|
|
2161 (ad-with-auto-activation-disabled
|
|
|
2162 (ad-real-fset symbol definition)))
|
|
|
2163
|
|
|
2164
|
|
|
2165 ;; @@ Access functions for original definitions:
|
|
|
2166 ;; ============================================
|
|
|
2167 ;; The advice-info of an advised function contains its `origname' which is
|
|
|
2168 ;; a symbol that is fbound to the original definition available at the first
|
|
|
2169 ;; proper activation of the function after a legal re/definition. If the
|
|
|
2170 ;; original was defined via fcell indirection then `origname' will be defined
|
|
|
2171 ;; just so. Hence, to get hold of the actual original definition of a function
|
|
|
2172 ;; we need to use `ad-real-orig-definition'.
|
|
|
2173
|
|
|
2174 (defun ad-make-origname (function)
|
|
|
2175 ;;"Makes name to be used to call the original FUNCTION."
|
|
|
2176 (intern (format "ad-Orig-%s" function)))
|
|
|
2177
|
|
|
2178 (defmacro ad-get-orig-definition (function)
|
|
|
2179 (` (let ((origname (ad-get-advice-info-field (, function) 'origname)))
|
|
|
2180 (if (fboundp origname)
|
|
|
2181 (symbol-function origname)))))
|
|
|
2182
|
|
|
2183 (defmacro ad-set-orig-definition (function definition)
|
|
|
2184 (` (ad-safe-fset
|
|
|
2185 (ad-get-advice-info-field function 'origname) (, definition))))
|
|
|
2186
|
|
|
2187 (defmacro ad-clear-orig-definition (function)
|
|
|
2188 (` (fmakunbound (ad-get-advice-info-field (, function) 'origname))))
|
|
|
2189
|
|
|
2190
|
|
|
2191 ;; @@ Interactive input functions:
|
|
|
2192 ;; ===============================
|
|
|
2193
|
|
|
2194 (defun ad-read-advised-function (&optional prompt predicate default)
|
|
|
2195 ;;"Reads name of advised function with completion from the minibuffer.
|
|
|
2196 ;;An optional PROMPT will be used to prompt for the function. PREDICATE
|
|
|
2197 ;;plays the same role as for `try-completion' (which see). DEFAULT will
|
|
|
2198 ;;be returned on empty input (defaults to the first advised function for
|
|
|
2199 ;;which PREDICATE returns non-nil)."
|
|
|
2200 (if (null ad-advised-functions)
|
|
|
2201 (error "ad-read-advised-function: There are no advised functions"))
|
|
|
2202 (setq default
|
|
|
2203 (or default
|
|
|
2204 (ad-do-advised-functions (function)
|
|
|
2205 (if (or (null predicate)
|
|
|
2206 (funcall predicate function))
|
|
|
2207 (ad-do-return function)))
|
|
|
2208 (error "ad-read-advised-function: %s"
|
|
|
2209 "There are no qualifying advised functions")))
|
|
|
2210 (let* ((ad-pReDiCaTe predicate)
|
|
|
2211 (function
|
|
|
2212 (completing-read
|
|
|
2213 (format "%s(default %s) " (or prompt "Function: ") default)
|
|
|
2214 ad-advised-functions
|
|
|
2215 (if predicate
|
|
|
2216 (function
|
|
|
2217 (lambda (function)
|
|
|
2218 ;; Oops, no closures - the joys of dynamic scoping:
|
|
|
2219 ;; `predicate' clashed with the `predicate' argument
|
|
|
2220 ;; of XEmacs' `completing-read'.....
|
|
|
2221 (funcall ad-pReDiCaTe (intern (car function))))))
|
|
|
2222 t)))
|
|
|
2223 (if (equal function "")
|
|
|
2224 (if (ad-is-advised default)
|
|
|
2225 default
|
|
|
2226 (error "ad-read-advised-function: `%s' is not advised" default))
|
|
|
2227 (intern function))))
|
|
|
2228
|
|
|
2229 (defvar ad-advice-class-completion-table
|
|
|
2230 (mapcar '(lambda (class) (list (symbol-name class)))
|
|
|
2231 ad-advice-classes))
|
|
|
2232
|
|
|
2233 (defun ad-read-advice-class (function &optional prompt default)
|
|
|
2234 ;;"Reads a legal advice class with completion from the minibuffer.
|
|
|
2235 ;;An optional PROMPT will be used to prompt for the class. DEFAULT will
|
|
|
2236 ;;be returned on empty input (defaults to the first non-empty advice
|
|
|
2237 ;;class of FUNCTION)."
|
|
|
2238 (setq default
|
|
|
2239 (or default
|
|
|
2240 (ad-dolist (class ad-advice-classes)
|
|
|
2241 (if (ad-get-advice-info-field function class)
|
|
|
2242 (ad-do-return class)))
|
|
|
2243 (error "ad-read-advice-class: `%s' has no advices" function)))
|
|
|
2244 (let ((class (completing-read
|
|
|
2245 (format "%s(default %s) " (or prompt "Class: ") default)
|
|
|
2246 ad-advice-class-completion-table nil t)))
|
|
|
2247 (if (equal class "")
|
|
|
2248 default
|
|
|
2249 (intern class))))
|
|
|
2250
|
|
|
2251 (defun ad-read-advice-name (function class &optional prompt)
|
|
|
2252 ;;"Reads name of existing advice of CLASS for FUNCTION with completion.
|
|
|
2253 ;;An optional PROMPT is used to prompt for the name."
|
|
|
2254 (let* ((name-completion-table
|
|
|
2255 (mapcar (function (lambda (advice)
|
|
|
2256 (list (symbol-name (ad-advice-name advice)))))
|
|
|
2257 (ad-get-advice-info-field function class)))
|
|
|
2258 (default
|
|
|
2259 (if (null name-completion-table)
|
|
|
2260 (error "ad-read-advice-name: `%s' has no %s advice"
|
|
|
2261 function class)
|
|
|
2262 (car (car name-completion-table))))
|
|
|
2263 (prompt (format "%s(default %s) " (or prompt "Name: ") default))
|
|
|
2264 (name (completing-read prompt name-completion-table nil t)))
|
|
|
2265 (if (equal name "")
|
|
|
2266 (intern default)
|
|
|
2267 (intern name))))
|
|
|
2268
|
|
|
2269 (defun ad-read-advice-specification (&optional prompt)
|
|
|
2270 ;;"Reads a complete function/class/name specification from minibuffer.
|
|
|
2271 ;;The list of read symbols will be returned. The optional PROMPT will
|
|
|
2272 ;;be used to prompt for the function."
|
|
|
2273 (let* ((function (ad-read-advised-function prompt))
|
|
|
2274 (class (ad-read-advice-class function))
|
|
|
2275 (name (ad-read-advice-name function class)))
|
|
|
2276 (list function class name)))
|
|
|
2277
|
|
|
2278 ;; Use previous regexp as a default:
|
|
|
2279 (defvar ad-last-regexp "")
|
|
|
2280
|
|
|
2281 (defun ad-read-regexp (&optional prompt)
|
|
|
2282 ;;"Reads a regular expression from the minibuffer."
|
|
|
2283 (let ((regexp (read-from-minibuffer
|
|
|
2284 (concat (or prompt "Regular expression: ")
|
|
|
2285 (if (equal ad-last-regexp "") ""
|
|
|
2286 (format "(default \"%s\") " ad-last-regexp))))))
|
|
|
2287 (setq ad-last-regexp
|
|
|
2288 (if (equal regexp "") ad-last-regexp regexp))))
|
|
|
2289
|
|
|
2290
|
|
|
2291 ;; @@ Finding, enabling, adding and removing pieces of advice:
|
|
|
2292 ;; ===========================================================
|
|
|
2293
|
|
|
2294 (defmacro ad-find-advice (function class name)
|
|
|
2295 ;;"Finds the first advice of FUNCTION in CLASS with NAME."
|
|
|
2296 (` (assq (, name) (ad-get-advice-info-field (, function) (, class)))))
|
|
|
2297
|
|
|
2298 (defun ad-advice-position (function class name)
|
|
|
2299 ;;"Returns position of first advice of FUNCTION in CLASS with NAME."
|
|
|
2300 (let* ((found-advice (ad-find-advice function class name))
|
|
|
2301 (advices (ad-get-advice-info-field function class)))
|
|
|
2302 (if found-advice
|
|
|
2303 (- (length advices) (length (memq found-advice advices))))))
|
|
|
2304
|
|
|
2305 (defun ad-find-some-advice (function class name)
|
|
|
2306 "Finds the first of FUNCTION's advices in CLASS matching NAME.
|
|
|
2307 NAME can be a symbol or a regular expression matching part of an advice name.
|
|
|
2308 If CLASS is `any' all legal advice classes will be checked."
|
|
|
2309 (if (ad-is-advised function)
|
|
|
2310 (let (found-advice)
|
|
|
2311 (ad-dolist (advice-class ad-advice-classes)
|
|
|
2312 (if (or (eq class 'any) (eq advice-class class))
|
|
|
2313 (setq found-advice
|
|
|
2314 (ad-dolist (advice (ad-get-advice-info-field
|
|
|
2315 function advice-class))
|
|
|
2316 (if (or (and (stringp name)
|
|
|
2317 (string-match
|
|
|
2318 name (symbol-name
|
|
|
2319 (ad-advice-name advice))))
|
|
|
2320 (eq name (ad-advice-name advice)))
|
|
|
2321 (ad-do-return advice)))))
|
|
|
2322 (if found-advice (ad-do-return found-advice))))))
|
|
|
2323
|
|
|
2324 (defun ad-enable-advice-internal (function class name flag)
|
|
|
2325 ;;"Sets enable FLAG of FUNCTION's advices in CLASS matching NAME.
|
|
|
2326 ;;If NAME is a string rather than a symbol then it's interpreted as a regular
|
|
|
2327 ;;expression and all advices whose name contain a match for it will be
|
|
|
2328 ;;affected. If CLASS is `any' advices in all legal advice classes will be
|
|
|
2329 ;;considered. The number of changed advices will be returned (or nil if
|
|
|
2330 ;;FUNCTION was not advised)."
|
|
|
2331 (if (ad-is-advised function)
|
|
|
2332 (let ((matched-advices 0))
|
|
|
2333 (ad-dolist (advice-class ad-advice-classes)
|
|
|
2334 (if (or (eq class 'any) (eq advice-class class))
|
|
|
2335 (ad-dolist (advice (ad-get-advice-info-field
|
|
|
2336 function advice-class))
|
|
|
2337 (cond ((or (and (stringp name)
|
|
|
2338 (string-match
|
|
|
2339 name (symbol-name (ad-advice-name advice))))
|
|
|
2340 (eq name (ad-advice-name advice)))
|
|
|
2341 (setq matched-advices (1+ matched-advices))
|
|
|
2342 (ad-advice-set-enabled advice flag))))))
|
|
|
2343 matched-advices)))
|
|
|
2344
|
|
|
2345 (defun ad-enable-advice (function class name)
|
|
|
2346 "Enables the advice of FUNCTION with CLASS and NAME."
|
|
|
2347 (interactive (ad-read-advice-specification "Enable advice of: "))
|
|
|
2348 (if (ad-is-advised function)
|
|
|
2349 (if (eq (ad-enable-advice-internal function class name t) 0)
|
|
|
2350 (error "ad-enable-advice: `%s' has no %s advice matching `%s'"
|
|
|
2351 function class name))
|
|
|
2352 (error "ad-enable-advice: `%s' is not advised" function)))
|
|
|
2353
|
|
|
2354 (defun ad-disable-advice (function class name)
|
|
|
2355 "Disables the advice of FUNCTION with CLASS and NAME."
|
|
|
2356 (interactive (ad-read-advice-specification "Disable advice of: "))
|
|
|
2357 (if (ad-is-advised function)
|
|
|
2358 (if (eq (ad-enable-advice-internal function class name nil) 0)
|
|
|
2359 (error "ad-disable-advice: `%s' has no %s advice matching `%s'"
|
|
|
2360 function class name))
|
|
|
2361 (error "ad-disable-advice: `%s' is not advised" function)))
|
|
|
2362
|
|
|
2363 (defun ad-enable-regexp-internal (regexp class flag)
|
|
|
2364 ;;"Sets enable FLAGs of all CLASS advices whose name contains a REGEXP match.
|
|
|
2365 ;;If CLASS is `any' all legal advice classes are considered. The number of
|
|
|
2366 ;;affected advices will be returned."
|
|
|
2367 (let ((matched-advices 0))
|
|
|
2368 (ad-do-advised-functions (advised-function)
|
|
|
2369 (setq matched-advices
|
|
|
2370 (+ matched-advices
|
|
|
2371 (or (ad-enable-advice-internal
|
|
|
2372 advised-function class regexp flag)
|
|
|
2373 0))))
|
|
|
2374 matched-advices))
|
|
|
2375
|
|
|
2376 (defun ad-enable-regexp (regexp)
|
|
|
2377 "Enables all advices with names that contain a match for REGEXP.
|
|
|
2378 All currently advised functions will be considered."
|
|
|
2379 (interactive
|
|
|
2380 (list (ad-read-regexp "Enable advices via regexp: ")))
|
|
|
2381 (let ((matched-advices (ad-enable-regexp-internal regexp 'any t)))
|
|
|
2382 (if (interactive-p)
|
|
|
2383 (message "%d matching advices enabled" matched-advices))
|
|
|
2384 matched-advices))
|
|
|
2385
|
|
|
2386 (defun ad-disable-regexp (regexp)
|
|
|
2387 "Disables all advices with names that contain a match for REGEXP.
|
|
|
2388 All currently advised functions will be considered."
|
|
|
2389 (interactive
|
|
|
2390 (list (ad-read-regexp "Disable advices via regexp: ")))
|
|
|
2391 (let ((matched-advices (ad-enable-regexp-internal regexp 'any nil)))
|
|
|
2392 (if (interactive-p)
|
|
|
2393 (message "%d matching advices disabled" matched-advices))
|
|
|
2394 matched-advices))
|
|
|
2395
|
|
|
2396 (defun ad-remove-advice (function class name)
|
|
|
2397 "Removes FUNCTION's advice with NAME from its advices in CLASS.
|
|
|
2398 If such an advice was found it will be removed from the list of advices
|
|
|
2399 in that CLASS."
|
|
|
2400 (interactive (ad-read-advice-specification "Remove advice of: "))
|
|
|
2401 (if (ad-is-advised function)
|
|
|
2402 (let* ((advice-to-remove (ad-find-advice function class name)))
|
|
|
2403 (if advice-to-remove
|
|
|
2404 (ad-set-advice-info-field
|
|
|
2405 function class
|
|
|
2406 (delq advice-to-remove (ad-get-advice-info-field function class)))
|
|
|
2407 (error "ad-remove-advice: `%s' has no %s advice `%s'"
|
|
|
2408 function class name)))
|
|
|
2409 (error "ad-remove-advice: `%s' is not advised" function)))
|
|
|
2410
|
|
|
2411 ;;;###autoload
|
|
|
2412 (defun ad-add-advice (function advice class position)
|
|
|
2413 "Adds a piece of ADVICE to FUNCTION's list of advices in CLASS.
|
|
|
2414 If FUNCTION already has one or more pieces of advice of the specified
|
|
|
2415 CLASS then POSITION determines where the new piece will go. The value
|
|
|
2416 of POSITION can either be `first', `last' or a number where 0 corresponds
|
|
|
2417 to `first'. Numbers outside the range will be mapped to the closest
|
|
|
2418 extreme position. If there was already a piece of ADVICE with the same
|
|
|
2419 name, then the position argument will be ignored and the old advice
|
|
|
2420 will be overwritten with the new one.
|
|
|
2421 If the FUNCTION was not advised already, then its advice info will be
|
|
|
2422 initialized. Redefining a piece of advice whose name is part of the cache-id
|
|
|
2423 will clear the cache."
|
|
|
2424 (cond ((not (ad-is-advised function))
|
|
|
2425 (ad-initialize-advice-info function)
|
|
|
2426 (ad-set-advice-info-field
|
|
|
2427 function 'origname (ad-make-origname function))))
|
|
|
2428 (let* ((previous-position
|
|
|
2429 (ad-advice-position function class (ad-advice-name advice)))
|
|
|
2430 (advices (ad-get-advice-info-field function class))
|
|
|
2431 ;; Determine a numerical position for the new advice:
|
|
|
2432 (position (cond (previous-position)
|
|
|
2433 ((eq position 'first) 0)
|
|
|
2434 ((eq position 'last) (length advices))
|
|
|
2435 ((numberp position)
|
|
|
2436 (max 0 (min position (length advices))))
|
|
|
2437 (t 0))))
|
|
|
2438 ;; Check whether we have to clear the cache:
|
|
|
2439 (if (memq (ad-advice-name advice) (ad-get-cache-class-id function class))
|
|
|
2440 (ad-clear-cache function))
|
|
|
2441 (if previous-position
|
|
|
2442 (setcar (nthcdr position advices) advice)
|
|
|
2443 (if (= position 0)
|
|
|
2444 (ad-set-advice-info-field function class (cons advice advices))
|
|
|
2445 (setcdr (nthcdr (1- position) advices)
|
|
|
2446 (cons advice (nthcdr position advices)))))))
|
|
|
2447
|
|
|
2448
|
|
|
2449 ;; @@ Accessing and manipulating function definitions:
|
|
|
2450 ;; ===================================================
|
|
|
2451
|
|
|
2452 (defmacro ad-macrofy (definition)
|
|
|
2453 ;;"Takes a lambda function DEFINITION and makes a macro out of it."
|
|
|
2454 (` (cons 'macro (, definition))))
|
|
|
2455
|
|
|
2456 (defmacro ad-lambdafy (definition)
|
|
|
2457 ;;"Takes a macro function DEFINITION and makes a lambda out of it."
|
|
|
2458 (` (cdr (, definition))))
|
|
|
2459
|
|
|
2460 ;; There is no way to determine whether some subr is a special form or not,
|
|
|
2461 ;; hence we need this list (which is probably out of date):
|
|
|
2462 (defvar ad-special-forms
|
|
|
2463 (mapcar 'symbol-function
|
|
|
2464 '(and catch cond condition-case defconst defmacro
|
|
|
2465 defun defvar function if interactive let let*
|
|
|
2466 or prog1 prog2 progn quote save-excursion
|
|
|
2467 save-restriction save-window-excursion setq
|
|
|
2468 setq-default unwind-protect while
|
|
|
2469 with-output-to-temp-buffer)))
|
|
|
2470
|
|
|
2471 (defmacro ad-special-form-p (definition)
|
|
|
2472 ;;"non-nil if DEFINITION is a special form."
|
|
|
2473 (list 'memq definition 'ad-special-forms))
|
|
|
2474
|
|
|
2475 (defmacro ad-interactive-p (definition)
|
|
|
2476 ;;"non-nil if DEFINITION can be called interactively."
|
|
|
2477 (list 'commandp definition))
|
|
|
2478
|
|
|
2479 (defmacro ad-subr-p (definition)
|
|
|
2480 ;;"non-nil if DEFINITION is a subr."
|
|
|
2481 (list 'subrp definition))
|
|
|
2482
|
|
|
2483 (defmacro ad-macro-p (definition)
|
|
|
2484 ;;"non-nil if DEFINITION is a macro."
|
|
|
2485 (` (eq (car-safe (, definition)) 'macro)))
|
|
|
2486
|
|
|
2487 (defmacro ad-lambda-p (definition)
|
|
|
2488 ;;"non-nil if DEFINITION is a lambda expression."
|
|
|
2489 (` (eq (car-safe (, definition)) 'lambda)))
|
|
|
2490
|
|
|
2491 ;; see ad-make-advice for the format of advice definitions:
|
|
|
2492 (defmacro ad-advice-p (definition)
|
|
|
2493 ;;"non-nil if DEFINITION is a piece of advice."
|
|
|
2494 (` (eq (car-safe (, definition)) 'advice)))
|
|
|
2495
|
|
|
2496 ;; Emacs/XEmacs cross-compatibility
|
|
|
2497 ;; (compiled-function-p is an obsolete function in Emacs):
|
|
|
2498 (if (and (not (fboundp 'byte-code-function-p))
|
|
|
2499 (fboundp 'compiled-function-p))
|
|
|
2500 (ad-safe-fset 'byte-code-function-p 'compiled-function-p))
|
|
|
2501
|
|
|
2502 (defmacro ad-compiled-p (definition)
|
|
|
2503 ;;"non-nil if DEFINITION is a compiled byte-code object."
|
|
|
2504 (` (or (byte-code-function-p (, definition))
|
|
|
2505 (and (ad-macro-p (, definition))
|
|
|
2506 (byte-code-function-p (ad-lambdafy (, definition)))))))
|
|
|
2507
|
|
|
2508 (defmacro ad-compiled-code (compiled-definition)
|
|
|
2509 ;;"Returns the byte-code object of a COMPILED-DEFINITION."
|
|
|
2510 (` (if (ad-macro-p (, compiled-definition))
|
|
|
2511 (ad-lambdafy (, compiled-definition))
|
|
|
2512 (, compiled-definition))))
|
|
|
2513
|
|
|
2514 (defun ad-lambda-expression (definition)
|
|
|
2515 ;;"Returns the lambda expression of a function/macro/advice DEFINITION."
|
|
|
2516 (cond ((ad-lambda-p definition)
|
|
|
2517 definition)
|
|
|
2518 ((ad-macro-p definition)
|
|
|
2519 (ad-lambdafy definition))
|
|
|
2520 ((ad-advice-p definition)
|
|
|
2521 (cdr definition))
|
|
|
2522 (t nil)))
|
|
|
2523
|
|
|
2524 (defun ad-arglist (definition &optional name)
|
|
|
2525 ;;"Returns the argument list of DEFINITION.
|
|
|
2526 ;;If DEFINITION could be from a subr then its NAME should be
|
|
|
2527 ;;supplied to make subr arglist lookup more efficient."
|
|
|
2528 (cond ((ad-compiled-p definition)
|
|
|
2529 ;; XEmacs fix:
|
|
|
2530 (if (fboundp 'compiled-function-arglist)
|
|
|
2531 (compiled-function-arglist (ad-compiled-code definition))
|
|
|
2532 (aref (ad-compiled-code definition) 0)))
|
|
|
2533 ((consp definition)
|
|
|
2534 (car (cdr (ad-lambda-expression definition))))
|
|
|
2535 ((ad-subr-p definition)
|
|
|
2536 (if name
|
|
|
2537 (ad-subr-arglist name)
|
|
|
2538 ;; otherwise get it from its printed representation:
|
|
|
2539 (setq name (format "%s" definition))
|
|
|
2540 (string-match "^#<subr \\([^>]+\\)>$" name)
|
|
|
2541 (ad-subr-arglist
|
|
|
2542 (intern (substring name (match-beginning 1) (match-end 1))))))))
|
|
|
2543
|
|
|
2544 ;; Store subr-args as `((arg1 arg2 ...))' so I can distinguish
|
|
|
2545 ;; a defined empty arglist `(nil)' from an undefined arglist:
|
|
|
2546 (defmacro ad-define-subr-args (subr arglist)
|
|
|
2547 (` (put (, subr) 'ad-subr-arglist (list (, arglist)))))
|
|
|
2548 (defmacro ad-undefine-subr-args (subr)
|
|
|
2549 (` (put (, subr) 'ad-subr-arglist nil)))
|
|
|
2550 (defmacro ad-subr-args-defined-p (subr)
|
|
|
2551 (` (get (, subr) 'ad-subr-arglist)))
|
|
|
2552 (defmacro ad-get-subr-args (subr)
|
|
|
2553 (` (car (get (, subr) 'ad-subr-arglist))))
|
|
|
2554
|
|
|
2555 (defun ad-subr-arglist (subr-name)
|
|
|
2556 ;;"Retrieve arglist of the subr with SUBR-NAME.
|
|
|
2557 ;;Either use the one stored under the `ad-subr-arglist' property,
|
|
|
2558 ;;or try to retrieve it from the docstring and cache it under
|
|
|
2559 ;;that property, or otherwise use `(&rest ad-subr-args)'."
|
|
|
2560 (cond ((ad-subr-args-defined-p subr-name)
|
|
|
2561 (ad-get-subr-args subr-name))
|
|
|
2562 ;; says jwz: Should use this for Lemacs 19.8 and above:
|
|
|
2563 ;;((fboundp 'subr-min-args)
|
|
|
2564 ;; ...)
|
|
|
2565 ;; says hans: I guess what Jamie means is that I should use the values
|
|
|
2566 ;; of `subr-min-args' and `subr-max-args' to construct the subr arglist
|
|
|
2567 ;; without having to look it up via parsing the docstring, e.g.,
|
|
|
2568 ;; values 1 and 2 would suggest `(arg1 &optional arg2)' as an
|
|
|
2569 ;; argument list. However, that won't work because there is no
|
|
|
2570 ;; way to distinguish a subr with args `(a &optional b &rest c)' from
|
|
|
2571 ;; one with args `(a &rest c)' using that mechanism. Also, the argument
|
|
|
2572 ;; names from the docstring are more meaningful. Hence, I'll stick with
|
|
|
2573 ;; the old way of doing things.
|
|
|
2574 (t (let ((doc (or (ad-real-documentation subr-name t) "")))
|
|
|
2575 (cond ((string-match
|
|
|
2576 "[\n\t ]*\narguments: ?\\((.*)\\)\n?\\'" doc)
|
|
|
2577 ;; this is the format used in XEmacs and in FSFmacs pre-19.24:
|
|
|
2578 ;; XEmacs 19.12+ uppercases the args like FSF...
|
|
|
2579 (ad-define-subr-args
|
|
|
2580 subr-name
|
|
|
2581 (car (read-from-string
|
|
|
2582 (downcase (substring doc
|
|
|
2583 (match-beginning 1)
|
|
|
2584 (match-end 1))))))
|
|
|
2585 (ad-get-subr-args subr-name))
|
|
|
2586 ((string-match "^\\(([^\)]+)\\)\n?\\'" doc)
|
|
|
2587 (ad-define-subr-args
|
|
|
2588 subr-name
|
|
|
2589 (cdr (car (read-from-string
|
|
|
2590 (downcase
|
|
|
2591 (substring doc
|
|
|
2592 (match-beginning 1)
|
|
|
2593 (match-end 1)))))))
|
|
|
2594 (ad-get-subr-args subr-name))
|
|
|
2595 (t '(&rest ad-subr-args)))))))
|
|
|
2596
|
|
|
2597 (defun ad-docstring (definition)
|
|
|
2598 ;;"Returns the unexpanded docstring of DEFINITION."
|
|
|
2599 (let ((docstring
|
|
|
2600 (if (ad-compiled-p definition)
|
|
|
2601 (ad-real-documentation definition t)
|
|
|
2602 (car (cdr (cdr (ad-lambda-expression definition)))))))
|
|
|
2603 (if (or (stringp docstring)
|
|
|
2604 (natnump docstring))
|
|
|
2605 docstring)))
|
|
|
2606
|
|
|
2607 (defun ad-interactive-form (definition)
|
|
|
2608 ;;"Returns the interactive form of DEFINITION."
|
|
|
2609 (cond ((ad-compiled-p definition)
|
|
|
2610 (and (commandp definition)
|
|
|
2611 (list 'interactive (aref (ad-compiled-code definition) 5))))
|
|
|
2612 ((or (ad-advice-p definition)
|
|
|
2613 (ad-lambda-p definition))
|
|
|
2614 (commandp (ad-lambda-expression definition)))))
|
|
|
2615
|
|
|
2616 (defun ad-body-forms (definition)
|
|
|
2617 ;;"Returns the list of body forms of DEFINITION."
|
|
|
2618 (cond ((ad-compiled-p definition)
|
|
|
2619 nil)
|
|
|
2620 ((consp definition)
|
|
|
2621 (nthcdr (+ (if (ad-docstring definition) 1 0)
|
|
|
2622 (if (ad-interactive-form definition) 1 0))
|
|
|
2623 (cdr (cdr (ad-lambda-expression definition)))))))
|
|
|
2624
|
|
|
2625 ;; Matches the docstring of an advised definition.
|
|
|
2626 ;; The first group of the regexp matches the function name:
|
|
|
2627 (defvar ad-advised-definition-docstring-regexp "^\\$ad-doc: \\(.+\\)\\$$")
|
|
|
2628
|
|
|
2629 (defun ad-make-advised-definition-docstring (function)
|
|
|
2630 ;; Makes an identifying docstring for the advised definition of FUNCTION.
|
|
|
2631 ;; Put function name into the documentation string so we can infer
|
|
|
2632 ;; the name of the advised function from the docstring. This is needed
|
|
|
2633 ;; to generate a proper advised docstring even if we are just given a
|
|
|
2634 ;; definition (also see the defadvice for `documentation'):
|
|
|
2635 (format "$ad-doc: %s$" (prin1-to-string function)))
|
|
|
2636
|
|
|
2637 (defun ad-advised-definition-p (definition)
|
|
|
2638 ;;"non-nil if DEFINITION was generated from advice information."
|
|
|
2639 (if (or (ad-lambda-p definition)
|
|
|
2640 (ad-macro-p definition)
|
|
|
2641 (ad-compiled-p definition))
|
|
|
2642 (let ((docstring (ad-docstring definition)))
|
|
|
2643 (and (stringp docstring)
|
|
|
2644 (string-match
|
|
|
2645 ad-advised-definition-docstring-regexp docstring)))))
|
|
|
2646
|
|
|
2647 (defun ad-definition-type (definition)
|
|
|
2648 ;;"Returns symbol that describes the type of DEFINITION."
|
|
|
2649 (if (ad-macro-p definition)
|
|
|
2650 'macro
|
|
|
2651 (if (ad-subr-p definition)
|
|
|
2652 (if (ad-special-form-p definition)
|
|
|
2653 'special-form
|
|
|
2654 'subr)
|
|
|
2655 (if (or (ad-lambda-p definition)
|
|
|
2656 (ad-compiled-p definition))
|
|
|
2657 'function
|
|
|
2658 (if (ad-advice-p definition)
|
|
|
2659 'advice)))))
|
|
|
2660
|
|
|
2661 (defun ad-has-proper-definition (function)
|
|
|
2662 ;;"True if FUNCTION is a symbol with a proper definition.
|
|
|
2663 ;;For that it has to be fbound with a non-autoload definition."
|
|
|
2664 (and (symbolp function)
|
|
|
2665 (fboundp function)
|
|
|
2666 (not (eq (car-safe (symbol-function function)) 'autoload))))
|
|
|
2667
|
|
|
2668 ;; The following two are necessary for the sake of packages such as
|
|
|
2669 ;; ange-ftp which redefine functions via fcell indirection:
|
|
|
2670 (defun ad-real-definition (function)
|
|
|
2671 ;;"Finds FUNCTION's definition at the end of function cell indirection."
|
|
|
2672 (if (ad-has-proper-definition function)
|
|
|
2673 (let ((definition (symbol-function function)))
|
|
|
2674 (if (symbolp definition)
|
|
|
2675 (ad-real-definition definition)
|
|
|
2676 definition))))
|
|
|
2677
|
|
|
2678 (defun ad-real-orig-definition (function)
|
|
|
2679 ;;"Finds FUNCTION's real original definition starting from its `origname'."
|
|
|
2680 (if (ad-is-advised function)
|
|
|
2681 (ad-real-definition (ad-get-advice-info-field function 'origname))))
|
|
|
2682
|
|
|
2683 (defun ad-is-compilable (function)
|
|
|
2684 ;;"True if FUNCTION has an interpreted definition that can be compiled."
|
|
|
2685 (and (ad-has-proper-definition function)
|
|
|
2686 (or (ad-lambda-p (symbol-function function))
|
|
|
2687 (ad-macro-p (symbol-function function)))
|
|
|
2688 (not (ad-compiled-p (symbol-function function)))))
|
|
|
2689
|
|
|
2690 (defun ad-compile-function (function)
|
|
|
2691 "Byte-compiles FUNCTION (or macro) if it is not yet compiled."
|
|
|
2692 (interactive "aByte-compile function: ")
|
|
|
2693 (if (ad-is-compilable function)
|
|
|
2694 ;; Need to turn off auto-activation
|
|
|
2695 ;; because `byte-compile' uses `fset':
|
|
|
2696 (ad-with-auto-activation-disabled
|
|
|
2697 (byte-compile function))))
|
|
|
2698
|
|
|
2699
|
|
|
2700 ;; @@ Constructing advised definitions:
|
|
|
2701 ;; ====================================
|
|
|
2702 ;;
|
|
|
2703 ;; Main design decisions about the form of advised definitions:
|
|
|
2704 ;;
|
|
|
2705 ;; A) How will original definitions be called?
|
|
|
2706 ;; B) What will argument lists of advised functions look like?
|
|
|
2707 ;;
|
|
|
2708 ;; Ad A)
|
|
|
2709 ;; I chose to use function indirection for all four types of original
|
|
|
2710 ;; definitions (functions, macros, subrs and special forms), i.e., create
|
|
|
2711 ;; a unique symbol `ad-Orig-<name>' which is fbound to the original
|
|
|
2712 ;; definition and call it according to type and arguments. Functions and
|
|
|
2713 ;; subrs that don't have any &rest arguments can be called directly in a
|
|
|
2714 ;; `(ad-Orig-<name> ....)' form. If they have a &rest argument we have to
|
|
|
2715 ;; use `apply'. Macros will be called with
|
|
|
2716 ;; `(macroexpand '(ad-Orig-<name> ....))', and special forms also need a
|
|
|
2717 ;; form like that with `eval' instead of `macroexpand'.
|
|
|
2718 ;;
|
|
|
2719 ;; Ad B)
|
|
|
2720 ;; Use original arguments where possible and `(&rest ad-subr-args)'
|
|
|
2721 ;; otherwise, even though this seems to be more complicated and less
|
|
|
2722 ;; uniform than a general `(&rest args)' approach. My reason to still
|
|
|
2723 ;; do it that way is that in most cases my approach leads to the more
|
|
|
2724 ;; efficient form for the advised function, and portability (e.g., to
|
|
|
2725 ;; make the same advice work regardless of whether something is a
|
|
|
2726 ;; function or a subr) can still be achieved with argument access macros.
|
|
|
2727
|
|
|
2728
|
|
|
2729 (defun ad-prognify (forms)
|
|
|
2730 (cond ((<= (length forms) 1)
|
|
|
2731 (car forms))
|
|
|
2732 (t (cons 'progn forms))))
|
|
|
2733
|
|
|
2734 ;; @@@ Accessing argument lists:
|
|
|
2735 ;; =============================
|
|
|
2736
|
|
|
2737 (defun ad-parse-arglist (arglist)
|
|
|
2738 ;;"Parses ARGLIST into its required, optional and rest parameters.
|
|
|
2739 ;;A three-element list is returned, where the 1st element is the list of
|
|
|
2740 ;;required arguments, the 2nd is the list of optional arguments, and the 3rd
|
|
|
2741 ;;is the name of an optional rest parameter (or nil)."
|
|
|
2742 (let* (required optional rest)
|
|
|
2743 (setq rest (car (cdr (memq '&rest arglist))))
|
|
|
2744 (if rest (setq arglist (reverse (cdr (memq '&rest (reverse arglist))))))
|
|
|
2745 (setq optional (cdr (memq '&optional arglist)))
|
|
|
2746 (if optional
|
|
|
2747 (setq required (reverse (cdr (memq '&optional (reverse arglist)))))
|
|
|
2748 (setq required arglist))
|
|
|
2749 (list required optional rest)))
|
|
|
2750
|
|
|
2751 (defun ad-retrieve-args-form (arglist)
|
|
|
2752 ;;"Generates a form which evaluates into names/values/types of ARGLIST.
|
|
|
2753 ;;When the form gets evaluated within a function with that argument list
|
|
|
2754 ;;it will result in a list with one entry for each argument, where the
|
|
|
2755 ;;first element of each entry is the name of the argument, the second
|
|
|
2756 ;;element is its actual current value, and the third element is either
|
|
|
2757 ;;`required', `optional' or `rest' depending on the type of the argument."
|
|
|
2758 (let* ((parsed-arglist (ad-parse-arglist arglist))
|
|
|
2759 (rest (nth 2 parsed-arglist)))
|
|
|
2760 (` (list
|
|
|
2761 (,@ (mapcar (function
|
|
|
2762 (lambda (req)
|
|
|
2763 (` (list '(, req) (, req) 'required))))
|
|
|
2764 (nth 0 parsed-arglist)))
|
|
|
2765 (,@ (mapcar (function
|
|
|
2766 (lambda (opt)
|
|
|
2767 (` (list '(, opt) (, opt) 'optional))))
|
|
|
2768 (nth 1 parsed-arglist)))
|
|
|
2769 (,@ (if rest (list (` (list '(, rest) (, rest) 'rest)))))
|
|
|
2770 ))))
|
|
|
2771
|
|
|
2772 (defun ad-arg-binding-field (binding field)
|
|
|
2773 (cond ((eq field 'name) (car binding))
|
|
|
2774 ((eq field 'value) (car (cdr binding)))
|
|
|
2775 ((eq field 'type) (car (cdr (cdr binding))))))
|
|
|
2776
|
|
|
2777 (defun ad-list-access (position list)
|
|
|
2778 (cond ((= position 0) list)
|
|
|
2779 ((= position 1) (list 'cdr list))
|
|
|
2780 (t (list 'nthcdr position list))))
|
|
|
2781
|
|
|
2782 (defun ad-element-access (position list)
|
|
|
2783 (cond ((= position 0) (list 'car list))
|
|
|
2784 ((= position 1) (` (car (cdr (, list)))))
|
|
|
2785 (t (list 'nth position list))))
|
|
|
2786
|
|
|
2787 (defun ad-access-argument (arglist index)
|
|
|
2788 ;;"Tells how to access ARGLIST's actual argument at position INDEX.
|
|
|
2789 ;;For a required/optional arg it simply returns it, if a rest argument has
|
|
|
2790 ;;to be accessed, it returns a list with the index and name."
|
|
|
2791 (let* ((parsed-arglist (ad-parse-arglist arglist))
|
|
|
2792 (reqopt-args (append (nth 0 parsed-arglist)
|
|
|
2793 (nth 1 parsed-arglist)))
|
|
|
2794 (rest-arg (nth 2 parsed-arglist)))
|
|
|
2795 (cond ((< index (length reqopt-args))
|
|
|
2796 (nth index reqopt-args))
|
|
|
2797 (rest-arg
|
|
|
2798 (list (- index (length reqopt-args)) rest-arg)))))
|
|
|
2799
|
|
|
2800 (defun ad-get-argument (arglist index)
|
|
|
2801 ;;"Returns form to access ARGLIST's actual argument at position INDEX."
|
|
|
2802 (let ((argument-access (ad-access-argument arglist index)))
|
|
|
2803 (cond ((consp argument-access)
|
|
|
2804 (ad-element-access
|
|
|
2805 (car argument-access) (car (cdr argument-access))))
|
|
|
2806 (argument-access))))
|
|
|
2807
|
|
|
2808 (defun ad-set-argument (arglist index value-form)
|
|
|
2809 ;;"Returns form to set ARGLIST's actual arg at INDEX to VALUE-FORM."
|
|
|
2810 (let ((argument-access (ad-access-argument arglist index)))
|
|
|
2811 (cond ((consp argument-access)
|
|
|
2812 ;; should this check whether there actually is something to set?
|
|
|
2813 (` (setcar (, (ad-list-access
|
|
|
2814 (car argument-access) (car (cdr argument-access))))
|
|
|
2815 (, value-form))))
|
|
|
2816 (argument-access
|
|
|
2817 (` (setq (, argument-access) (, value-form))))
|
|
|
2818 (t (error "ad-set-argument: No argument at position %d of `%s'"
|
|
|
2819 index arglist)))))
|
|
|
2820
|
|
|
2821 (defun ad-get-arguments (arglist index)
|
|
|
2822 ;;"Returns form to access all actual arguments starting at position INDEX."
|
|
|
2823 (let* ((parsed-arglist (ad-parse-arglist arglist))
|
|
|
2824 (reqopt-args (append (nth 0 parsed-arglist)
|
|
|
2825 (nth 1 parsed-arglist)))
|
|
|
2826 (rest-arg (nth 2 parsed-arglist))
|
|
|
2827 args-form)
|
|
|
2828 (if (< index (length reqopt-args))
|
|
|
2829 (setq args-form (` (list (,@ (nthcdr index reqopt-args))))))
|
|
|
2830 (if rest-arg
|
|
|
2831 (if args-form
|
|
|
2832 (setq args-form (` (nconc (, args-form) (, rest-arg))))
|
|
|
2833 (setq args-form (ad-list-access (- index (length reqopt-args))
|
|
|
2834 rest-arg))))
|
|
|
2835 args-form))
|
|
|
2836
|
|
|
2837 (defun ad-set-arguments (arglist index values-form)
|
|
|
2838 ;;"Makes form to assign elements of VALUES-FORM as actual ARGLIST args.
|
|
|
2839 ;;The assignment starts at position INDEX."
|
|
|
2840 (let ((values-index 0)
|
|
|
2841 argument-access set-forms)
|
|
|
2842 (while (setq argument-access (ad-access-argument arglist index))
|
|
|
2843 (if (symbolp argument-access)
|
|
|
2844 (setq set-forms
|
|
|
2845 (cons (ad-set-argument
|
|
|
2846 arglist index
|
|
|
2847 (ad-element-access values-index 'ad-vAlUeS))
|
|
|
2848 set-forms))
|
|
|
2849 (setq set-forms
|
|
|
2850 (cons (if (= (car argument-access) 0)
|
|
|
2851 (list 'setq
|
|
|
2852 (car (cdr argument-access))
|
|
|
2853 (ad-list-access values-index 'ad-vAlUeS))
|
|
|
2854 (list 'setcdr
|
|
|
2855 (ad-list-access (1- (car argument-access))
|
|
|
2856 (car (cdr argument-access)))
|
|
|
2857 (ad-list-access values-index 'ad-vAlUeS)))
|
|
|
2858 set-forms))
|
|
|
2859 ;; terminate loop
|
|
|
2860 (setq arglist nil))
|
|
|
2861 (setq index (1+ index))
|
|
|
2862 (setq values-index (1+ values-index)))
|
|
|
2863 (if (null set-forms)
|
|
|
2864 (error "ad-set-arguments: No argument at position %d of `%s'"
|
|
|
2865 index arglist)
|
|
|
2866 (if (= (length set-forms) 1)
|
|
|
2867 ;; For exactly one set-form we can use values-form directly,...
|
|
|
2868 (ad-substitute-tree
|
|
|
2869 (function (lambda (form) (eq form 'ad-vAlUeS)))
|
|
|
2870 (function (lambda (form) values-form))
|
|
|
2871 (car set-forms))
|
|
|
2872 ;; ...if we have more we have to bind it to a variable:
|
|
|
2873 (` (let ((ad-vAlUeS (, values-form)))
|
|
|
2874 (,@ (reverse set-forms))
|
|
|
2875 ;; work around the old backquote bug:
|
|
|
2876 (, 'ad-vAlUeS)))))))
|
|
|
2877
|
|
|
2878 (defun ad-insert-argument-access-forms (definition arglist)
|
|
|
2879 ;;"Expands arg-access text macros in DEFINITION according to ARGLIST."
|
|
|
2880 (ad-substitute-tree
|
|
|
2881 (function
|
|
|
2882 (lambda (form)
|
|
|
2883 (or (eq form 'ad-arg-bindings)
|
|
|
2884 (and (memq (car-safe form)
|
|
|
2885 '(ad-get-arg ad-get-args ad-set-arg ad-set-args))
|
|
|
2886 (integerp (car-safe (cdr form)))))))
|
|
|
2887 (function
|
|
|
2888 (lambda (form)
|
|
|
2889 (if (eq form 'ad-arg-bindings)
|
|
|
2890 (ad-retrieve-args-form arglist)
|
|
|
2891 (let ((accessor (car form))
|
|
|
2892 (index (car (cdr form)))
|
|
|
2893 (val (car (cdr (ad-insert-argument-access-forms
|
|
|
2894 (cdr form) arglist)))))
|
|
|
2895 (cond ((eq accessor 'ad-get-arg)
|
|
|
2896 (ad-get-argument arglist index))
|
|
|
2897 ((eq accessor 'ad-set-arg)
|
|
|
2898 (ad-set-argument arglist index val))
|
|
|
2899 ((eq accessor 'ad-get-args)
|
|
|
2900 (ad-get-arguments arglist index))
|
|
|
2901 ((eq accessor 'ad-set-args)
|
|
|
2902 (ad-set-arguments arglist index val)))))))
|
|
|
2903 definition))
|
|
|
2904
|
|
|
2905 ;; @@@ Mapping argument lists:
|
|
|
2906 ;; ===========================
|
|
|
2907 ;; Here is the problem:
|
|
|
2908 ;; Suppose function foo was called with (foo 1 2 3 4 5), and foo has the
|
|
|
2909 ;; argument list (x y &rest z), and we want to call the function bar which
|
|
|
2910 ;; has argument list (a &rest b) with a combination of x, y and z so that
|
|
|
2911 ;; the effect is just as if we had called (bar 1 2 3 4 5) directly.
|
|
|
2912 ;; The mapping should work for any two argument lists.
|
|
|
2913
|
|
|
2914 (defun ad-map-arglists (source-arglist target-arglist)
|
|
|
2915 "Makes `funcall/apply' form to map SOURCE-ARGLIST to TARGET-ARGLIST.
|
|
|
2916 The arguments supplied to TARGET-ARGLIST will be taken from SOURCE-ARGLIST just
|
|
|
2917 as if they had been supplied to a function with TARGET-ARGLIST directly.
|
|
|
2918 Excess source arguments will be neglected, missing source arguments will be
|
|
|
2919 supplied as nil. Returns a `funcall' or `apply' form with the second element
|
|
|
2920 being `function' which has to be replaced by an actual function argument.
|
|
|
2921 Example: `(ad-map-arglists '(a &rest args) '(w x y z))' will return
|
|
|
2922 `(funcall function a (car args) (car (cdr args)) (nth 2 args))'."
|
|
|
2923 (let* ((parsed-source-arglist (ad-parse-arglist source-arglist))
|
|
|
2924 (source-reqopt-args (append (nth 0 parsed-source-arglist)
|
|
|
2925 (nth 1 parsed-source-arglist)))
|
|
|
2926 (source-rest-arg (nth 2 parsed-source-arglist))
|
|
|
2927 (parsed-target-arglist (ad-parse-arglist target-arglist))
|
|
|
2928 (target-reqopt-args (append (nth 0 parsed-target-arglist)
|
|
|
2929 (nth 1 parsed-target-arglist)))
|
|
|
2930 (target-rest-arg (nth 2 parsed-target-arglist))
|
|
|
2931 (need-apply (and source-rest-arg target-rest-arg))
|
|
|
2932 (target-arg-index -1))
|
|
|
2933 ;; This produces ``error-proof'' target function calls with the exception
|
|
|
2934 ;; of a case like (&rest a) mapped onto (x &rest y) where the actual args
|
|
|
2935 ;; supplied to A might not be enough to supply the required target arg X
|
|
|
2936 (append (list (if need-apply 'apply 'funcall) 'function)
|
|
|
2937 (cond (need-apply
|
|
|
2938 ;; `apply' can take care of that directly:
|
|
|
2939 (append source-reqopt-args (list source-rest-arg)))
|
|
|
2940 (t (mapcar (function
|
|
|
2941 (lambda (arg)
|
|
|
2942 (setq target-arg-index (1+ target-arg-index))
|
|
|
2943 (ad-get-argument
|
|
|
2944 source-arglist target-arg-index)))
|
|
|
2945 (append target-reqopt-args
|
|
|
2946 (and target-rest-arg
|
|
|
2947 ;; If we have a rest arg gobble up
|
|
|
2948 ;; remaining source args:
|
|
|
2949 (nthcdr (length target-reqopt-args)
|
|
|
2950 source-reqopt-args)))))))))
|
|
|
2951
|
|
|
2952 (defun ad-make-mapped-call (source-arglist target-arglist target-function)
|
|
|
2953 ;;"Makes form to call TARGET-FUNCTION with args from SOURCE-ARGLIST."
|
|
|
2954 (let* ((mapped-form (ad-map-arglists source-arglist target-arglist)))
|
|
|
2955 (if (eq (car mapped-form) 'funcall)
|
|
|
2956 (cons target-function (cdr (cdr mapped-form)))
|
|
|
2957 (prog1 mapped-form
|
|
|
2958 (setcar (cdr mapped-form) (list 'quote target-function))))))
|
|
|
2959
|
|
|
2960 ;; @@@ Making an advised documentation string:
|
|
|
2961 ;; ===========================================
|
|
|
2962 ;; New policy: The documentation string for an advised function will be built
|
|
|
2963 ;; at the time the advised `documentation' function is called. This has the
|
|
|
2964 ;; following advantages:
|
|
|
2965 ;; 1) command-key substitutions will automatically be correct
|
|
|
2966 ;; 2) No wasted string space due to big advised docstrings in caches or
|
|
|
2967 ;; compiled files that contain preactivations
|
|
|
2968 ;; The overall overhead for this should be negligible because people normally
|
|
|
2969 ;; don't lookup documentation for the same function over and over again.
|
|
|
2970
|
|
|
2971 (defun ad-make-single-advice-docstring (advice class &optional style)
|
|
|
2972 (let ((advice-docstring (ad-docstring (ad-advice-definition advice))))
|
|
|
2973 (cond ((eq style 'plain)
|
|
|
2974 advice-docstring)
|
|
|
2975 ((eq style 'freeze)
|
|
|
2976 (format "Permanent %s-advice `%s':%s%s"
|
|
|
2977 class (ad-advice-name advice)
|
|
|
2978 (if advice-docstring "\n" "")
|
|
|
2979 (or advice-docstring "")))
|
|
|
2980 (t (format "%s-advice `%s':%s%s"
|
|
|
2981 (capitalize (symbol-name class)) (ad-advice-name advice)
|
|
|
2982 (if advice-docstring "\n" "")
|
|
|
2983 (or advice-docstring ""))))))
|
|
|
2984
|
|
|
2985 (defun ad-make-advised-docstring (function &optional style)
|
|
|
2986 ;;"Constructs a documentation string for the advised FUNCTION.
|
|
|
2987 ;;It concatenates the original documentation with the documentation
|
|
|
2988 ;;strings of the individual pieces of advice which will be formatted
|
|
|
2989 ;;according to STYLE. STYLE can be `plain' or `freeze', everything else
|
|
|
2990 ;;will be interpreted as `default'. The order of the advice documentation
|
|
|
2991 ;;strings corresponds to before/around/after and the individual ordering
|
|
|
2992 ;;in any of these classes."
|
|
|
2993 (let* ((origdef (ad-real-orig-definition function))
|
|
|
2994 (origtype (symbol-name (ad-definition-type origdef)))
|
|
|
2995 (origdoc
|
|
|
2996 ;; Retrieve raw doc, key substitution will be taken care of later:
|
|
|
2997 (ad-real-documentation origdef t))
|
|
|
2998 paragraphs advice-docstring)
|
|
|
2999 (if origdoc (setq paragraphs (list origdoc)))
|
|
|
3000 (if (not (eq style 'plain))
|
|
|
3001 (setq paragraphs (cons (concat "This " origtype " is advised.")
|
|
|
3002 paragraphs)))
|
|
|
3003 (ad-dolist (class ad-advice-classes)
|
|
|
3004 (ad-dolist (advice (ad-get-enabled-advices function class))
|
|
|
3005 (setq advice-docstring
|
|
|
3006 (ad-make-single-advice-docstring advice class style))
|
|
|
3007 (if advice-docstring
|
|
|
3008 (setq paragraphs (cons advice-docstring paragraphs)))))
|
|
|
3009 (if paragraphs
|
|
|
3010 ;; separate paragraphs with blank lines:
|
|
|
3011 (mapconcat 'identity (nreverse paragraphs) "\n\n"))))
|
|
|
3012
|
|
|
3013 (defun ad-make-plain-docstring (function)
|
|
|
3014 (ad-make-advised-docstring function 'plain))
|
|
|
3015 (defun ad-make-freeze-docstring (function)
|
|
|
3016 (ad-make-advised-docstring function 'freeze))
|
|
|
3017
|
|
|
3018 ;; @@@ Accessing overriding arglists and interactive forms:
|
|
|
3019 ;; ========================================================
|
|
|
3020
|
|
|
3021 (defun ad-advised-arglist (function)
|
|
|
3022 ;;"Finds first defined arglist in FUNCTION's redefining advices."
|
|
|
3023 (ad-dolist (advice (append (ad-get-enabled-advices function 'before)
|
|
|
3024 (ad-get-enabled-advices function 'around)
|
|
|
3025 (ad-get-enabled-advices function 'after)))
|
|
|
3026 (let ((arglist (ad-arglist (ad-advice-definition advice))))
|
|
|
3027 (if arglist
|
|
|
3028 ;; We found the first one, use it:
|
|
|
3029 (ad-do-return arglist)))))
|
|
|
3030
|
|
|
3031 (defun ad-advised-interactive-form (function)
|
|
|
3032 ;;"Finds first interactive form in FUNCTION's redefining advices."
|
|
|
3033 (ad-dolist (advice (append (ad-get-enabled-advices function 'before)
|
|
|
3034 (ad-get-enabled-advices function 'around)
|
|
|
3035 (ad-get-enabled-advices function 'after)))
|
|
|
3036 (let ((interactive-form
|
|
|
3037 (ad-interactive-form (ad-advice-definition advice))))
|
|
|
3038 (if interactive-form
|
|
|
3039 ;; We found the first one, use it:
|
|
|
3040 (ad-do-return interactive-form)))))
|
|
|
3041
|
|
|
3042 ;; @@@ Putting it all together:
|
|
|
3043 ;; ============================
|
|
|
3044
|
|
|
3045 (defun ad-make-advised-definition (function)
|
|
|
3046 ;;"Generates an advised definition of FUNCTION from its advice info."
|
|
|
3047 (if (and (ad-is-advised function)
|
|
|
3048 (ad-has-redefining-advice function))
|
|
|
3049 (let* ((origdef (ad-real-orig-definition function))
|
|
|
3050 (origname (ad-get-advice-info-field function 'origname))
|
|
|
3051 (orig-interactive-p (ad-interactive-p origdef))
|
|
|
3052 (orig-subr-p (ad-subr-p origdef))
|
|
|
3053 (orig-special-form-p (ad-special-form-p origdef))
|
|
|
3054 (orig-macro-p (ad-macro-p origdef))
|
|
|
3055 ;; Construct the individual pieces that we need for assembly:
|
|
|
3056 (orig-arglist (ad-arglist origdef function))
|
|
|
3057 (advised-arglist (or (ad-advised-arglist function)
|
|
|
3058 orig-arglist))
|
|
|
3059 (advised-interactive-form (ad-advised-interactive-form function))
|
|
|
3060 (interactive-form
|
|
|
3061 (cond (orig-macro-p nil)
|
|
|
3062 (advised-interactive-form)
|
|
|
3063 ((ad-interactive-form origdef))
|
|
|
3064 ;; Otherwise we must have a subr: make it interactive if
|
|
|
3065 ;; we have to and initialize required arguments in case
|
|
|
3066 ;; it is called interactively:
|
|
|
3067 (orig-interactive-p
|
|
|
3068 (let ((reqargs (car (ad-parse-arglist advised-arglist))))
|
|
|
3069 (if reqargs
|
|
|
3070 (` (interactive
|
|
|
3071 '(, (make-list (length reqargs) nil))))
|
|
|
3072 '(interactive))))))
|
|
|
3073 (orig-form
|
|
|
3074 (cond ((or orig-special-form-p orig-macro-p)
|
|
|
3075 ;; Special forms and macros will be advised into macros.
|
|
|
3076 ;; The trick is to construct an expansion for the advised
|
|
|
3077 ;; macro that does the correct thing when it gets eval'ed.
|
|
|
3078 ;; For macros we'll just use the expansion of the original
|
|
|
3079 ;; macro and return that. This way compiled advised macros
|
|
|
3080 ;; will be expanded into something useful. Note that after
|
|
|
3081 ;; advices have full control over whether they want to
|
|
|
3082 ;; evaluate the expansion (the value of `ad-return-value')
|
|
|
3083 ;; at macro expansion time or not. For special forms there
|
|
|
3084 ;; is no solution that interacts reasonably with the
|
|
|
3085 ;; compiler, hence we just evaluate the original at macro
|
|
|
3086 ;; expansion time and return the result. The moral of that
|
|
|
3087 ;; is that one should always deactivate advised special
|
|
|
3088 ;; forms before one byte-compiles a file.
|
|
|
3089 (` ((, (if orig-macro-p
|
|
|
3090 'macroexpand
|
|
|
3091 'eval))
|
|
|
3092 (cons '(, origname)
|
|
|
3093 (, (ad-get-arguments advised-arglist 0))))))
|
|
|
3094 ((and orig-subr-p
|
|
|
3095 orig-interactive-p
|
|
|
3096 (not advised-interactive-form))
|
|
|
3097 ;; Check whether we were called interactively
|
|
|
3098 ;; in order to do proper prompting:
|
|
|
3099 (` (if (interactive-p)
|
|
|
3100 (call-interactively '(, origname))
|
|
|
3101 (, (ad-make-mapped-call
|
|
|
3102 orig-arglist advised-arglist origname)))))
|
|
|
3103 ;; And now for normal functions and non-interactive subrs
|
|
|
3104 ;; (or subrs whose interactive behavior was advised):
|
|
|
3105 (t (ad-make-mapped-call
|
|
|
3106 advised-arglist orig-arglist origname)))))
|
|
|
3107
|
|
|
3108 ;; Finally, build the sucker:
|
|
|
3109 (ad-assemble-advised-definition
|
|
|
3110 (cond (orig-macro-p 'macro)
|
|
|
3111 (orig-special-form-p 'special-form)
|
|
|
3112 (t 'function))
|
|
|
3113 advised-arglist
|
|
|
3114 (ad-make-advised-definition-docstring function)
|
|
|
3115 interactive-form
|
|
|
3116 orig-form
|
|
|
3117 (ad-get-enabled-advices function 'before)
|
|
|
3118 (ad-get-enabled-advices function 'around)
|
|
|
3119 (ad-get-enabled-advices function 'after)))))
|
|
|
3120
|
|
|
3121 (defun ad-assemble-advised-definition
|
|
|
3122 (type args docstring interactive orig &optional befores arounds afters)
|
|
|
3123
|
|
|
3124 ;;"Assembles an original and its advices into an advised function.
|
|
|
3125 ;;It constructs a function or macro definition according to TYPE which has to
|
|
|
3126 ;;be either `macro', `function' or `special-form'. ARGS is the argument list
|
|
|
3127 ;;that has to be used, DOCSTRING if non-nil defines the documentation of the
|
|
|
3128 ;;definition, INTERACTIVE if non-nil is the interactive form to be used,
|
|
|
3129 ;;ORIG is a form that calls the body of the original unadvised function,
|
|
|
3130 ;;and BEFORES, AROUNDS and AFTERS are the lists of advices with which ORIG
|
|
|
3131 ;;should be modified. The assembled function will be returned."
|
|
|
3132
|
|
|
3133 (let (before-forms around-form around-form-protected after-forms definition)
|
|
|
3134 (ad-dolist (advice befores)
|
|
|
3135 (cond ((and (ad-advice-protected advice)
|
|
|
3136 before-forms)
|
|
|
3137 (setq before-forms
|
|
|
3138 (` ((unwind-protect
|
|
|
3139 (, (ad-prognify before-forms))
|
|
|
3140 (,@ (ad-body-forms
|
|
|
3141 (ad-advice-definition advice))))))))
|
|
|
3142 (t (setq before-forms
|
|
|
3143 (append before-forms
|
|
|
3144 (ad-body-forms (ad-advice-definition advice)))))))
|
|
|
3145
|
|
|
3146 (setq around-form (` (setq ad-return-value (, orig))))
|
|
|
3147 (ad-dolist (advice (reverse arounds))
|
|
|
3148 ;; If any of the around advices is protected then we
|
|
|
3149 ;; protect the complete around advice onion:
|
|
|
3150 (if (ad-advice-protected advice)
|
|
|
3151 (setq around-form-protected t))
|
|
|
3152 (setq around-form
|
|
|
3153 (ad-substitute-tree
|
|
|
3154 (function (lambda (form) (eq form 'ad-do-it)))
|
|
|
3155 (function (lambda (form) around-form))
|
|
|
3156 (ad-prognify (ad-body-forms (ad-advice-definition advice))))))
|
|
|
3157
|
|
|
3158 (setq after-forms
|
|
|
3159 (if (and around-form-protected before-forms)
|
|
|
3160 (` ((unwind-protect
|
|
|
3161 (, (ad-prognify before-forms))
|
|
|
3162 (, around-form))))
|
|
|
3163 (append before-forms (list around-form))))
|
|
|
3164 (ad-dolist (advice afters)
|
|
|
3165 (cond ((and (ad-advice-protected advice)
|
|
|
3166 after-forms)
|
|
|
3167 (setq after-forms
|
|
|
3168 (` ((unwind-protect
|
|
|
3169 (, (ad-prognify after-forms))
|
|
|
3170 (,@ (ad-body-forms
|
|
|
3171 (ad-advice-definition advice))))))))
|
|
|
3172 (t (setq after-forms
|
|
|
3173 (append after-forms
|
|
|
3174 (ad-body-forms (ad-advice-definition advice)))))))
|
|
|
3175
|
|
|
3176 (setq definition
|
|
|
3177 (` ((,@ (if (memq type '(macro special-form)) '(macro)))
|
|
|
3178 lambda
|
|
|
3179 (, args)
|
|
|
3180 (,@ (if docstring (list docstring)))
|
|
|
3181 (,@ (if interactive (list interactive)))
|
|
|
3182 (let (ad-return-value)
|
|
|
3183 (,@ after-forms)
|
|
|
3184 (, (if (eq type 'special-form)
|
|
|
3185 '(list 'quote ad-return-value)
|
|
|
3186 'ad-return-value))))))
|
|
|
3187
|
|
|
3188 (ad-insert-argument-access-forms definition args)))
|
|
|
3189
|
|
|
3190 ;; This is needed for activation/deactivation hooks:
|
|
|
3191 (defun ad-make-hook-form (function hook-name)
|
|
|
3192 ;;"Makes hook-form from FUNCTION's advice bodies in class HOOK-NAME."
|
|
|
3193 (let ((hook-forms
|
|
|
3194 (mapcar (function (lambda (advice)
|
|
|
3195 (ad-body-forms (ad-advice-definition advice))))
|
|
|
3196 (ad-get-enabled-advices function hook-name))))
|
|
|
3197 (if hook-forms
|
|
|
3198 (ad-prognify (apply 'append hook-forms)))))
|
|
|
3199
|
|
|
3200
|
|
|
3201 ;; @@ Caching:
|
|
|
3202 ;; ===========
|
|
|
3203 ;; Generating an advised definition of a function is moderately expensive,
|
|
|
3204 ;; hence, it makes sense to cache it so we can reuse it in appropriate
|
|
|
3205 ;; circumstances. Of course, it only makes sense to reuse a cached
|
|
|
3206 ;; definition if the current advice and function definition state is the
|
|
|
3207 ;; same as it was at the time when the cached definition was generated.
|
|
|
3208 ;; For that purpose we associate every cache with an id so we can verify
|
|
|
3209 ;; if it is still valid at a certain point in time. This id mechanism
|
|
|
3210 ;; makes it possible to preactivate advised functions, write the compiled
|
|
|
3211 ;; advised definitions to a file and reuse them during the actual
|
|
|
3212 ;; activation without having to risk that the resulting definition will be
|
|
|
3213 ;; incorrect, well, almost.
|
|
|
3214 ;;
|
|
|
3215 ;; A cache id is a list with six elements:
|
|
|
3216 ;; 1) the list of names of enabled before advices
|
|
|
3217 ;; 2) the list of names of enabled around advices
|
|
|
3218 ;; 3) the list of names of enabled after advices
|
|
|
3219 ;; 4) the type of the original function (macro, subr, etc.)
|
|
|
3220 ;; 5) the arglist of the original definition (or t if it was equal to the
|
|
|
3221 ;; arglist of the cached definition)
|
|
|
3222 ;; 6) t if the interactive form of the original definition was equal to the
|
|
|
3223 ;; interactive form of the cached definition
|
|
|
3224 ;;
|
|
|
3225 ;; Here's how a cache can get invalidated or be incorrect:
|
|
|
3226 ;; A) a piece of advice used in the cache gets redefined
|
|
|
3227 ;; B) the current list of enabled advices is different from the ones used
|
|
|
3228 ;; for the cache
|
|
|
3229 ;; C) the type of the original function changed, e.g., a function became a
|
|
|
3230 ;; macro, or a subr became a function
|
|
|
3231 ;; D) the arglist of the original function changed
|
|
|
3232 ;; E) the interactive form of the original function changed
|
|
|
3233 ;; F) a piece of advice used in the cache got redefined before the
|
|
|
3234 ;; defadvice with the cached definition got loaded: This is a PROBLEM!
|
|
|
3235 ;;
|
|
|
3236 ;; Cases A and B are the normal ones. A is taken care of by `ad-add-advice'
|
|
|
3237 ;; which clears the cache in such a case, B is easily checked during
|
|
|
3238 ;; verification at activation time.
|
|
|
3239 ;;
|
|
|
3240 ;; Cases C, D and E have to be considered if one is slightly paranoid, i.e.,
|
|
|
3241 ;; if one considers the case that the original function could be different
|
|
|
3242 ;; from the one available at caching time (e.g., for forward advice of
|
|
|
3243 ;; functions that get redefined by some packages - such as `eval-region' gets
|
|
|
3244 ;; redefined by edebug). All these cases can be easily checked during
|
|
|
3245 ;; verification. Element 4 of the id lets one check case C, element 5 takes
|
|
|
3246 ;; care of case D (using t in the equality case saves some space, because the
|
|
|
3247 ;; arglist can be recovered at validation time from the cached definition),
|
|
|
3248 ;; and element 6 takes care of case E which is only a problem if the original
|
|
|
3249 ;; was actually a function whose interactive form was not overridden by a
|
|
|
3250 ;; piece of advice.
|
|
|
3251 ;;
|
|
|
3252 ;; Case F is the only one which will lead to an incorrect advised function.
|
|
|
3253 ;; There is no way to avoid this without storing the complete advice definition
|
|
|
3254 ;; in the cache-id which is not feasible.
|
|
|
3255 ;;
|
|
|
3256 ;; The cache-id of a typical advised function with one piece of advice and
|
|
|
3257 ;; no arglist redefinition takes 7 conses which is a small price to pay for
|
|
|
3258 ;; the added efficiency. The validation itself is also pretty cheap, certainly
|
|
|
3259 ;; a lot cheaper than reconstructing an advised definition.
|
|
|
3260
|
|
|
3261 (defmacro ad-get-cache-definition (function)
|
|
|
3262 (` (car (ad-get-advice-info-field (, function) 'cache))))
|
|
|
3263
|
|
|
3264 (defmacro ad-get-cache-id (function)
|
|
|
3265 (` (cdr (ad-get-advice-info-field (, function) 'cache))))
|
|
|
3266
|
|
|
3267 (defmacro ad-set-cache (function definition id)
|
|
|
3268 (` (ad-set-advice-info-field
|
|
|
3269 (, function) 'cache (cons (, definition) (, id)))))
|
|
|
3270
|
|
|
3271 (defun ad-clear-cache (function)
|
|
|
3272 "Clears a previously cached advised definition of FUNCTION.
|
|
|
3273 Clear the cache if you want to force `ad-activate' to construct a new
|
|
|
3274 advised definition from scratch."
|
|
|
3275 (interactive
|
|
|
3276 (list (ad-read-advised-function "Clear cached definition of: ")))
|
|
|
3277 (ad-set-advice-info-field function 'cache nil))
|
|
|
3278
|
|
|
3279 (defun ad-make-cache-id (function)
|
|
|
3280 ;;"Generates an identifying image of the current advices of FUNCTION."
|
|
|
3281 (let ((original-definition (ad-real-orig-definition function))
|
|
|
3282 (cached-definition (ad-get-cache-definition function)))
|
|
|
3283 (list (mapcar (function (lambda (advice) (ad-advice-name advice)))
|
|
|
3284 (ad-get-enabled-advices function 'before))
|
|
|
3285 (mapcar (function (lambda (advice) (ad-advice-name advice)))
|
|
|
3286 (ad-get-enabled-advices function 'around))
|
|
|
3287 (mapcar (function (lambda (advice) (ad-advice-name advice)))
|
|
|
3288 (ad-get-enabled-advices function 'after))
|
|
|
3289 (ad-definition-type original-definition)
|
|
|
3290 (if (equal (ad-arglist original-definition function)
|
|
|
3291 (ad-arglist cached-definition))
|
|
|
3292 t
|
|
|
3293 (ad-arglist original-definition function))
|
|
|
3294 (if (eq (ad-definition-type original-definition) 'function)
|
|
|
3295 (equal (ad-interactive-form original-definition)
|
|
|
3296 (ad-interactive-form cached-definition))))))
|
|
|
3297
|
|
|
3298 (defun ad-get-cache-class-id (function class)
|
|
|
3299 ;;"Returns the part of FUNCTION's cache id that identifies CLASS."
|
|
|
3300 (let ((cache-id (ad-get-cache-id function)))
|
|
|
3301 (if (eq class 'before)
|
|
|
3302 (car cache-id)
|
|
|
3303 (if (eq class 'around)
|
|
|
3304 (nth 1 cache-id)
|
|
|
3305 (nth 2 cache-id)))))
|
|
|
3306
|
|
|
3307 (defun ad-verify-cache-class-id (cache-class-id advices)
|
|
|
3308 (ad-dolist (advice advices (null cache-class-id))
|
|
|
3309 (if (ad-advice-enabled advice)
|
|
|
3310 (if (eq (car cache-class-id) (ad-advice-name advice))
|
|
|
3311 (setq cache-class-id (cdr cache-class-id))
|
|
|
3312 (ad-do-return nil)))))
|
|
|
3313
|
|
|
3314 ;; There should be a way to monitor if and why a cache verification failed
|
|
|
3315 ;; in order to determine whether a certain preactivation could be used or
|
|
|
3316 ;; not. Right now the only way to find out is to trace
|
|
|
3317 ;; `ad-cache-id-verification-code'. The code it returns indicates where the
|
|
|
3318 ;; verification failed. Tracing `ad-verify-cache-class-id' might provide
|
|
|
3319 ;; some additional useful information.
|
|
|
3320
|
|
|
3321 (defun ad-cache-id-verification-code (function)
|
|
|
3322 (let ((cache-id (ad-get-cache-id function))
|
|
|
3323 (code 'before-advice-mismatch))
|
|
|
3324 (and (ad-verify-cache-class-id
|
|
|
3325 (car cache-id) (ad-get-advice-info-field function 'before))
|
|
|
3326 (setq code 'around-advice-mismatch)
|
|
|
3327 (ad-verify-cache-class-id
|
|
|
3328 (nth 1 cache-id) (ad-get-advice-info-field function 'around))
|
|
|
3329 (setq code 'after-advice-mismatch)
|
|
|
3330 (ad-verify-cache-class-id
|
|
|
3331 (nth 2 cache-id) (ad-get-advice-info-field function 'after))
|
|
|
3332 (setq code 'definition-type-mismatch)
|
|
|
3333 (let ((original-definition (ad-real-orig-definition function))
|
|
|
3334 (cached-definition (ad-get-cache-definition function)))
|
|
|
3335 (and (eq (nth 3 cache-id) (ad-definition-type original-definition))
|
|
|
3336 (setq code 'arglist-mismatch)
|
|
|
3337 (equal (if (eq (nth 4 cache-id) t)
|
|
|
3338 (ad-arglist original-definition function)
|
|
|
3339 (nth 4 cache-id) )
|
|
|
3340 (ad-arglist cached-definition))
|
|
|
3341 (setq code 'interactive-form-mismatch)
|
|
|
3342 (or (null (nth 5 cache-id))
|
|
|
3343 (equal (ad-interactive-form original-definition)
|
|
|
3344 (ad-interactive-form cached-definition)))
|
|
|
3345 (setq code 'verified))))
|
|
|
3346 code))
|
|
|
3347
|
|
|
3348 (defun ad-verify-cache-id (function)
|
|
|
3349 ;;"True if FUNCTION's cache-id is compatible with its current advices."
|
|
|
3350 (eq (ad-cache-id-verification-code function) 'verified))
|
|
|
3351
|
|
|
3352
|
|
|
3353 ;; @@ Preactivation:
|
|
|
3354 ;; =================
|
|
|
3355 ;; Preactivation can be used to generate compiled advised definitions
|
|
|
3356 ;; at compile time without having to give up the dynamic runtime flexibility
|
|
|
3357 ;; of the advice mechanism. Preactivation is a special feature of `defadvice',
|
|
|
3358 ;; it involves the following steps:
|
|
|
3359 ;; - remembering the function's current state (definition and advice-info)
|
|
|
3360 ;; - advising it with the defined piece of advice
|
|
|
3361 ;; - clearing its cache
|
|
|
3362 ;; - generating an interpreted advised definition by activating it, this will
|
|
|
3363 ;; make use of all its current active advice and its current definition
|
|
|
3364 ;; - saving the so generated cached definition and id
|
|
|
3365 ;; - resetting the function's advice and definition state to what it was
|
|
|
3366 ;; before the preactivation
|
|
|
3367 ;; - Returning the saved definition and its id to be used in the expansion of
|
|
|
3368 ;; `defadvice' to assign it as an initial cache, hence it will be compiled
|
|
|
3369 ;; at time the `defadvice' gets compiled.
|
|
|
3370 ;; Naturally, for preactivation to be effective it has to be applied/compiled
|
|
|
3371 ;; at the right time, i.e., when the current state of advices and function
|
|
|
3372 ;; definition exactly reflects the state at activation time. Should that not
|
|
|
3373 ;; be the case, the precompiled definition will just be discarded and a new
|
|
|
3374 ;; advised definition will be generated.
|
|
|
3375
|
|
|
3376 (defun ad-preactivate-advice (function advice class position)
|
|
|
3377 ;;"Preactivates FUNCTION and returns the constructed cache."
|
|
|
3378 (let* ((function-defined-p (fboundp function))
|
|
|
3379 (old-definition
|
|
|
3380 (if function-defined-p
|
|
|
3381 (symbol-function function)))
|
|
|
3382 (old-advice-info (ad-copy-advice-info function))
|
|
|
3383 (ad-advised-functions ad-advised-functions))
|
|
|
3384 (unwind-protect
|
|
|
3385 (progn
|
|
|
3386 (ad-add-advice function advice class position)
|
|
|
3387 (ad-enable-advice function class (ad-advice-name advice))
|
|
|
3388 (ad-clear-cache function)
|
|
|
3389 (ad-activate-on function -1)
|
|
|
3390 (if (and (ad-is-active function)
|
|
|
3391 (ad-get-cache-definition function))
|
|
|
3392 (list (ad-get-cache-definition function)
|
|
|
3393 (ad-get-cache-id function))))
|
|
|
3394 (ad-set-advice-info function old-advice-info)
|
|
|
3395 ;; Don't `fset' function to nil if it was previously unbound:
|
|
|
3396 (if function-defined-p
|
|
|
3397 (ad-safe-fset function old-definition)
|
|
|
3398 (fmakunbound function)))))
|
|
|
3399
|
|
|
3400
|
|
|
3401 ;; @@ Freezing:
|
|
|
3402 ;; ============
|
|
|
3403 ;; Freezing transforms a `defadvice' into a redefining `defun/defmacro'
|
|
|
3404 ;; for the advised function without keeping any advice information. This
|
|
|
3405 ;; feature was jwz's idea: It generates a dumpable function definition
|
|
|
3406 ;; whose documentation can be written to the DOC file, and the generated
|
|
|
3407 ;; code does not need any Advice runtime support. Of course, frozen advices
|
|
|
3408 ;; cannot be undone.
|
|
|
3409
|
|
|
3410 ;; Freezing only considers the advice of the particular `defadvice', other
|
|
|
3411 ;; already existing advices for the same function will be ignored. To ensure
|
|
|
3412 ;; proper interaction when an already advised function gets redefined with
|
|
|
3413 ;; a frozen advice, frozen advices always use the actual original definition
|
|
|
3414 ;; of the function, i.e., they are always at the core of the onion. E.g., if
|
|
|
3415 ;; an already advised function gets redefined with a frozen advice and then
|
|
|
3416 ;; unadvised, the frozen advice remains as the new definition of the function.
|
|
|
3417
|
|
|
3418 ;; While multiple freeze advices for a single function or freeze-advising
|
|
|
3419 ;; of an already advised function are possible, they are better avoided,
|
|
|
3420 ;; because definition/compile/load ordering is relevant, and it becomes
|
|
|
3421 ;; incomprehensible pretty quickly.
|
|
|
3422
|
|
|
3423 (defun ad-make-freeze-definition (function advice class position)
|
|
|
3424 (if (not (ad-has-proper-definition function))
|
|
|
3425 (error
|
|
|
3426 "ad-make-freeze-definition: `%s' is not yet defined"
|
|
|
3427 function))
|
|
|
3428 (let* ((name (ad-advice-name advice))
|
|
|
3429 ;; With a unique origname we can have multiple freeze advices
|
|
|
3430 ;; for the same function, each overloading the previous one:
|
|
|
3431 (unique-origname
|
|
|
3432 (intern (format "%s-%s-%s" (ad-make-origname function) class name)))
|
|
|
3433 (orig-definition
|
|
|
3434 ;; If FUNCTION is already advised, we'll use its current origdef
|
|
|
3435 ;; as the original definition of the frozen advice:
|
|
|
3436 (or (ad-get-orig-definition function)
|
|
|
3437 (symbol-function function)))
|
|
|
3438 (old-advice-info
|
|
|
3439 (if (ad-is-advised function)
|
|
|
3440 (ad-copy-advice-info function)))
|
|
|
3441 (real-docstring-fn
|
|
|
3442 (symbol-function 'ad-make-advised-definition-docstring))
|
|
|
3443 (real-origname-fn
|
|
|
3444 (symbol-function 'ad-make-origname))
|
|
|
3445 (frozen-definition
|
|
|
3446 (unwind-protect
|
|
|
3447 (progn
|
|
|
3448 ;; Make sure we construct a proper docstring:
|
|
|
3449 (ad-safe-fset 'ad-make-advised-definition-docstring
|
|
|
3450 'ad-make-freeze-docstring)
|
|
|
3451 ;; Make sure `unique-origname' is used as the origname:
|
|
|
3452 (ad-safe-fset 'ad-make-origname '(lambda (x) unique-origname))
|
|
|
3453 ;; No we reset all current advice information to nil and
|
|
|
3454 ;; generate an advised definition that's solely determined
|
|
|
3455 ;; by ADVICE and the current origdef of FUNCTION:
|
|
|
3456 (ad-set-advice-info function nil)
|
|
|
3457 (ad-add-advice function advice class position)
|
|
|
3458 ;; The following will provide proper real docstrings as
|
|
|
3459 ;; well as a definition that will make the compiler happy:
|
|
|
3460 (ad-set-orig-definition function orig-definition)
|
|
|
3461 (ad-make-advised-definition function))
|
|
|
3462 ;; Restore the old advice state:
|
|
|
3463 (ad-set-advice-info function old-advice-info)
|
|
|
3464 ;; Restore functions:
|
|
|
3465 (ad-safe-fset
|
|
|
3466 'ad-make-advised-definition-docstring real-docstring-fn)
|
|
|
3467 (ad-safe-fset 'ad-make-origname real-origname-fn))))
|
|
|
3468 (if frozen-definition
|
|
|
3469 (let* ((macro-p (ad-macro-p frozen-definition))
|
|
|
3470 (body (cdr (if macro-p
|
|
|
3471 (ad-lambdafy frozen-definition)
|
|
|
3472 frozen-definition))))
|
|
|
3473 (` (progn
|
|
|
3474 (if (not (fboundp '(, unique-origname)))
|
|
|
3475 (fset '(, unique-origname)
|
|
|
3476 ;; avoid infinite recursion in case the function
|
|
|
3477 ;; we want to freeze is already advised:
|
|
|
3478 (or (ad-get-orig-definition '(, function))
|
|
|
3479 (symbol-function '(, function)))))
|
|
|
3480 ((, (if macro-p 'defmacro 'defun))
|
|
|
3481 (, function)
|
|
|
3482 (,@ body))))))))
|
|
|
3483
|
|
|
3484
|
|
|
3485 ;; @@ Activation and definition handling:
|
|
|
3486 ;; ======================================
|
|
|
3487
|
|
|
3488 (defun ad-should-compile (function compile)
|
|
|
3489 ;;"Returns non-nil if the advised FUNCTION should be compiled.
|
|
|
3490 ;;If COMPILE is non-nil and not a negative number then it returns t.
|
|
|
3491 ;;If COMPILE is a negative number then it returns nil.
|
|
|
3492 ;;If COMPILE is nil then the result depends on the value of
|
|
|
3493 ;;`ad-default-compilation-action' (which see)."
|
|
|
3494 (if (integerp compile)
|
|
|
3495 (>= compile 0)
|
|
|
3496 (if compile
|
|
|
3497 compile
|
|
|
3498 (cond ((eq ad-default-compilation-action 'never)
|
|
|
3499 nil)
|
|
|
3500 ((eq ad-default-compilation-action 'always)
|
|
|
3501 t)
|
|
|
3502 ((eq ad-default-compilation-action 'like-original)
|
|
|
3503 (or (ad-subr-p (ad-get-orig-definition function))
|
|
|
3504 (ad-compiled-p (ad-get-orig-definition function))))
|
|
|
3505 ;; everything else means `maybe':
|
|
|
3506 (t (featurep 'byte-compile))))))
|
|
|
3507
|
|
|
3508 (defun ad-activate-advised-definition (function compile)
|
|
|
3509 ;;"Redefines FUNCTION with its advised definition from cache or scratch.
|
|
|
3510 ;;The resulting FUNCTION will be compiled if `ad-should-compile' returns t.
|
|
|
3511 ;;The current definition and its cache-id will be put into the cache."
|
|
|
3512 (let ((verified-cached-definition
|
|
|
3513 (if (ad-verify-cache-id function)
|
|
|
3514 (ad-get-cache-definition function))))
|
|
|
3515 (ad-safe-fset function
|
|
|
3516 (or verified-cached-definition
|
|
|
3517 (ad-make-advised-definition function)))
|
|
|
3518 (if (ad-should-compile function compile)
|
|
|
3519 (ad-compile-function function))
|
|
|
3520 (if verified-cached-definition
|
|
|
3521 (if (not (eq verified-cached-definition (symbol-function function)))
|
|
|
3522 ;; we must have compiled, cache the compiled definition:
|
|
|
3523 (ad-set-cache
|
|
|
3524 function (symbol-function function) (ad-get-cache-id function)))
|
|
|
3525 ;; We created a new advised definition, cache it with a proper id:
|
|
|
3526 (ad-clear-cache function)
|
|
|
3527 ;; ad-make-cache-id needs the new cached definition:
|
|
|
3528 (ad-set-cache function (symbol-function function) nil)
|
|
|
3529 (ad-set-cache
|
|
|
3530 function (symbol-function function) (ad-make-cache-id function)))))
|
|
|
3531
|
|
|
3532 (defun ad-handle-definition (function)
|
|
|
3533 "Handles re/definition of an advised FUNCTION during de/activation.
|
|
|
3534 If FUNCTION does not have an original definition associated with it and
|
|
|
3535 the current definition is usable, then it will be stored as FUNCTION's
|
|
|
3536 original definition. If no current definition is available (even in the
|
|
|
3537 case of undefinition) nothing will be done. In the case of redefinition
|
|
|
3538 the action taken depends on the value of `ad-redefinition-action' (which
|
|
|
3539 see). Redefinition occurs when FUNCTION already has an original definition
|
|
|
3540 associated with it but got redefined with a new definition and then
|
|
|
3541 de/activated. If you do not like the current redefinition action change
|
|
|
3542 the value of `ad-redefinition-action' and de/activate again."
|
|
|
3543 (let ((original-definition (ad-get-orig-definition function))
|
|
|
3544 (current-definition (if (ad-real-definition function)
|
|
|
3545 (symbol-function function))))
|
|
|
3546 (if original-definition
|
|
|
3547 (if current-definition
|
|
|
3548 (if (and (not (eq current-definition original-definition))
|
|
|
3549 ;; Redefinition with an advised definition from a
|
|
|
3550 ;; different function won't count as such:
|
|
|
3551 (not (ad-advised-definition-p current-definition)))
|
|
|
3552 ;; we have a redefinition:
|
|
|
3553 (if (not (memq ad-redefinition-action '(accept discard warn)))
|
|
|
3554 (error "ad-handle-definition (see its doc): `%s' %s"
|
|
|
3555 function "illegally redefined")
|
|
|
3556 (if (eq ad-redefinition-action 'discard)
|
|
|
3557 (ad-safe-fset function original-definition)
|
|
|
3558 (ad-set-orig-definition function current-definition)
|
|
|
3559 (if (eq ad-redefinition-action 'warn)
|
|
|
3560 (message "ad-handle-definition: `%s' got redefined"
|
|
|
3561 function))))
|
|
|
3562 ;; either advised def or correct original is in place:
|
|
|
3563 nil)
|
|
|
3564 ;; we have an undefinition, ignore it:
|
|
|
3565 nil)
|
|
|
3566 (if current-definition
|
|
|
3567 ;; we have a first definition, save it as original:
|
|
|
3568 (ad-set-orig-definition function current-definition)
|
|
|
3569 ;; we don't have anything noteworthy:
|
|
|
3570 nil))))
|
|
|
3571
|
|
|
3572
|
|
|
3573 ;; @@ The top-level advice interface:
|
|
|
3574 ;; ==================================
|
|
|
3575
|
|
|
3576 (defun ad-activate-on (function &optional compile)
|
|
|
3577 "Activates all the advice information of an advised FUNCTION.
|
|
|
3578 If FUNCTION has a proper original definition then an advised
|
|
|
3579 definition will be generated from FUNCTION's advice info and the
|
|
|
3580 definition of FUNCTION will be replaced with it. If a previously
|
|
|
3581 cached advised definition was available, it will be used.
|
|
|
3582 The optional COMPILE argument determines whether the resulting function
|
|
|
3583 or a compilable cached definition will be compiled. If it is negative
|
|
|
3584 no compilation will be performed, if it is positive or otherwise non-nil
|
|
|
3585 the resulting function will be compiled, if it is nil the behavior depends
|
|
|
3586 on the value of `ad-default-compilation-action' (which see).
|
|
|
3587 Activation of an advised function that has an advice info but no actual
|
|
|
3588 pieces of advice is equivalent to a call to `ad-unadvise'. Activation of
|
|
|
3589 an advised function that has actual pieces of advice but none of them are
|
|
|
3590 enabled is equivalent to a call to `ad-deactivate'. The current advised
|
|
|
3591 definition will always be cached for later usage."
|
|
|
3592 (interactive
|
|
|
3593 (list (ad-read-advised-function "Activate advice of: ")
|
|
|
3594 current-prefix-arg))
|
|
|
3595 (if ad-activate-on-top-level
|
|
|
3596 ;; avoid recursive calls to `ad-activate-on':
|
|
|
3597 (ad-with-auto-activation-disabled
|
|
|
3598 (if (not (ad-is-advised function))
|
|
|
3599 (error "ad-activate: `%s' is not advised" function)
|
|
|
3600 (ad-handle-definition function)
|
|
|
3601 ;; Just return for forward advised and not yet defined functions:
|
|
|
3602 (if (ad-get-orig-definition function)
|
|
|
3603 (if (not (ad-has-any-advice function))
|
|
|
3604 (ad-unadvise function)
|
|
|
3605 ;; Otherwise activate the advice:
|
|
|
3606 (cond ((ad-has-redefining-advice function)
|
|
|
3607 (ad-activate-advised-definition function compile)
|
|
|
3608 (ad-set-advice-info-field function 'active t)
|
|
|
3609 (eval (ad-make-hook-form function 'activation))
|
|
|
3610 function)
|
|
|
3611 ;; Here we are if we have all disabled advices:
|
|
|
3612 (t (ad-deactivate function)))))))))
|
|
|
3613
|
|
|
3614 (defun ad-deactivate (function)
|
|
|
3615 "Deactivates the advice of an actively advised FUNCTION.
|
|
|
3616 If FUNCTION has a proper original definition, then the current
|
|
|
3617 definition of FUNCTION will be replaced with it. All the advice
|
|
|
3618 information will still be available so it can be activated again with
|
|
|
3619 a call to `ad-activate'."
|
|
|
3620 (interactive
|
|
|
3621 (list (ad-read-advised-function "Deactivate advice of: " 'ad-is-active)))
|
|
|
3622 (if (not (ad-is-advised function))
|
|
|
3623 (error "ad-deactivate: `%s' is not advised" function)
|
|
|
3624 (cond ((ad-is-active function)
|
|
|
3625 (ad-handle-definition function)
|
|
|
3626 (if (not (ad-get-orig-definition function))
|
|
|
3627 (error "ad-deactivate: `%s' has no original definition"
|
|
|
3628 function)
|
|
|
3629 (ad-safe-fset function (ad-get-orig-definition function))
|
|
|
3630 (ad-set-advice-info-field function 'active nil)
|
|
|
3631 (eval (ad-make-hook-form function 'deactivation))
|
|
|
3632 function)))))
|
|
|
3633
|
|
|
3634 (defun ad-update (function &optional compile)
|
|
|
3635 "Update the advised definition of FUNCTION if its advice is active.
|
|
|
3636 See `ad-activate-on' for documentation on the optional COMPILE argument."
|
|
|
3637 (interactive
|
|
|
3638 (list (ad-read-advised-function
|
|
|
3639 "Update advised definition of: " 'ad-is-active)))
|
|
|
3640 (if (ad-is-active function)
|
|
|
3641 (ad-activate-on function compile)))
|
|
|
3642
|
|
|
3643 (defun ad-unadvise (function)
|
|
|
3644 "Deactivates FUNCTION and then removes all its advice information.
|
|
|
3645 If FUNCTION was not advised this will be a noop."
|
|
|
3646 (interactive
|
|
|
3647 (list (ad-read-advised-function "Unadvise function: ")))
|
|
|
3648 (cond ((ad-is-advised function)
|
|
|
3649 (if (ad-is-active function)
|
|
|
3650 (ad-deactivate function))
|
|
|
3651 (ad-clear-orig-definition function)
|
|
|
3652 (ad-set-advice-info function nil)
|
|
|
3653 (ad-pop-advised-function function))))
|
|
|
3654
|
|
|
3655 (defun ad-recover (function)
|
|
|
3656 "Tries to recover FUNCTION's original definition and unadvises it.
|
|
|
3657 This is more low-level than `ad-unadvise' because it does not do any
|
|
|
3658 deactivation which might run hooks and get into other trouble.
|
|
|
3659 Use in emergencies."
|
|
|
3660 ;; Use more primitive interactive behavior here: Accept any symbol that's
|
|
|
3661 ;; currently defined in obarray, not necessarily with a function definition:
|
|
|
3662 (interactive
|
|
|
3663 (list (intern
|
|
|
3664 (completing-read "Recover advised function: " obarray nil t))))
|
|
|
3665 (cond ((ad-is-advised function)
|
|
|
3666 (cond ((ad-get-orig-definition function)
|
|
|
3667 (ad-safe-fset function (ad-get-orig-definition function))
|
|
|
3668 (ad-clear-orig-definition function)))
|
|
|
3669 (ad-set-advice-info function nil)
|
|
|
3670 (ad-pop-advised-function function))))
|
|
|
3671
|
|
|
3672 (defun ad-activate-regexp (regexp &optional compile)
|
|
|
3673 "Activates functions with an advice name containing a REGEXP match.
|
|
|
3674 See `ad-activate-on' for documentation on the optional COMPILE argument."
|
|
|
3675 (interactive
|
|
|
3676 (list (ad-read-regexp "Activate via advice regexp: ")
|
|
|
3677 current-prefix-arg))
|
|
|
3678 (ad-do-advised-functions (function)
|
|
|
3679 (if (ad-find-some-advice function 'any regexp)
|
|
|
3680 (ad-activate-on function compile))))
|
|
|
3681
|
|
|
3682 (defun ad-deactivate-regexp (regexp)
|
|
|
3683 "Deactivates functions with an advice name containing REGEXP match."
|
|
|
3684 (interactive
|
|
|
3685 (list (ad-read-regexp "Deactivate via advice regexp: ")))
|
|
|
3686 (ad-do-advised-functions (function)
|
|
|
3687 (if (ad-find-some-advice function 'any regexp)
|
|
|
3688 (ad-deactivate function))))
|
|
|
3689
|
|
|
3690 (defun ad-update-regexp (regexp &optional compile)
|
|
|
3691 "Updates functions with an advice name containing a REGEXP match.
|
|
|
3692 See `ad-activate-on' for documentation on the optional COMPILE argument."
|
|
|
3693 (interactive
|
|
|
3694 (list (ad-read-regexp "Update via advice regexp: ")
|
|
|
3695 current-prefix-arg))
|
|
|
3696 (ad-do-advised-functions (function)
|
|
|
3697 (if (ad-find-some-advice function 'any regexp)
|
|
|
3698 (ad-update function compile))))
|
|
|
3699
|
|
|
3700 (defun ad-activate-all (&optional compile)
|
|
|
3701 "Activates all currently advised functions.
|
|
|
3702 See `ad-activate-on' for documentation on the optional COMPILE argument."
|
|
|
3703 (interactive "P")
|
|
|
3704 (ad-do-advised-functions (function)
|
|
|
3705 (ad-activate-on function compile)))
|
|
|
3706
|
|
|
3707 (defun ad-deactivate-all ()
|
|
|
3708 "Deactivates all currently advised functions."
|
|
|
3709 (interactive)
|
|
|
3710 (ad-do-advised-functions (function)
|
|
|
3711 (ad-deactivate function)))
|
|
|
3712
|
|
|
3713 (defun ad-update-all (&optional compile)
|
|
|
3714 "Updates all currently advised functions.
|
|
|
3715 With prefix argument compiles resulting advised definitions."
|
|
|
3716 (interactive "P")
|
|
|
3717 (ad-do-advised-functions (function)
|
|
|
3718 (ad-update function compile)))
|
|
|
3719
|
|
|
3720 (defun ad-unadvise-all ()
|
|
|
3721 "Unadvises all currently advised functions."
|
|
|
3722 (interactive)
|
|
|
3723 (ad-do-advised-functions (function)
|
|
|
3724 (ad-unadvise function)))
|
|
|
3725
|
|
|
3726 (defun ad-recover-all ()
|
|
|
3727 "Recovers all currently advised functions. Use in emergencies."
|
|
|
3728 (interactive)
|
|
|
3729 (ad-do-advised-functions (function)
|
|
|
3730 (condition-case nil
|
|
|
3731 (ad-recover function)
|
|
|
3732 (error nil))))
|
|
|
3733
|
|
|
3734
|
|
|
3735 ;; Completion alist of legal `defadvice' flags
|
|
|
3736 (defvar ad-defadvice-flags
|
|
|
3737 '(("protect") ("disable") ("activate")
|
|
|
3738 ("compile") ("preactivate") ("freeze")))
|
|
|
3739
|
|
|
3740 ;;;###autoload
|
|
|
3741 (defmacro defadvice (function args &rest body)
|
|
|
3742 "Defines a piece of advice for FUNCTION (a symbol).
|
|
|
3743 The syntax of `defadvice' is as follows:
|
|
|
3744
|
|
|
3745 (defadvice FUNCTION (CLASS NAME [POSITION] [ARGLIST] FLAG...)
|
|
|
3746 [DOCSTRING] [INTERACTIVE-FORM]
|
|
|
3747 BODY... )
|
|
|
3748
|
|
|
3749 FUNCTION ::= Name of the function to be advised.
|
|
|
3750 CLASS ::= `before' | `around' | `after' | `activation' | `deactivation'.
|
|
|
3751 NAME ::= Non-nil symbol that names this piece of advice.
|
|
|
3752 POSITION ::= `first' | `last' | NUMBER. Optional, defaults to `first',
|
|
|
3753 see also `ad-add-advice'.
|
|
|
3754 ARGLIST ::= An optional argument list to be used for the advised function
|
|
|
3755 instead of the argument list of the original. The first one found in
|
|
|
3756 before/around/after-advices will be used.
|
|
|
3757 FLAG ::= `protect'|`disable'|`activate'|`compile'|`preactivate'|`freeze'.
|
|
|
3758 All flags can be specified with unambiguous initial substrings.
|
|
|
3759 DOCSTRING ::= Optional documentation for this piece of advice.
|
|
|
3760 INTERACTIVE-FORM ::= Optional interactive form to be used for the advised
|
|
|
3761 function. The first one found in before/around/after-advices will be used.
|
|
|
3762 BODY ::= Any s-expression.
|
|
|
3763
|
|
|
3764 Semantics of the various flags:
|
|
|
3765 `protect': The piece of advice will be protected against non-local exits in
|
|
|
3766 any code that precedes it. If any around-advice of a function is protected
|
|
|
3767 then automatically all around-advices will be protected (the complete onion).
|
|
|
3768
|
|
|
3769 `activate': All advice of FUNCTION will be activated immediately if
|
|
|
3770 FUNCTION has been properly defined prior to this application of `defadvice'.
|
|
|
3771
|
|
|
3772 `compile': In conjunction with `activate' specifies that the resulting
|
|
|
3773 advised function should be compiled.
|
|
|
3774
|
|
|
3775 `disable': The defined advice will be disabled, hence, it will not be used
|
|
|
3776 during activation until somebody enables it.
|
|
|
3777
|
|
|
3778 `preactivate': Preactivates the advised FUNCTION at macro-expansion/compile
|
|
|
3779 time. This generates a compiled advised definition according to the current
|
|
|
3780 advice state that will be used during activation if appropriate. Only use
|
|
|
3781 this if the `defadvice' gets actually compiled.
|
|
|
3782
|
|
|
3783 `freeze': Expands the `defadvice' into a redefining `defun/defmacro' according
|
|
|
3784 to this particular single advice. No other advice information will be saved.
|
|
|
3785 Frozen advices cannot be undone, they behave like a hard redefinition of
|
|
|
3786 the advised function. `freeze' implies `activate' and `preactivate'. The
|
|
|
3787 documentation of the advised function can be dumped onto the `DOC' file
|
|
|
3788 during preloading.
|
|
|
3789
|
|
|
3790 Look at the file `advice.el' for comprehensive documentation."
|
|
|
3791 (if (not (ad-name-p function))
|
|
|
3792 (error "defadvice: Illegal function name: %s" function))
|
|
|
3793 (let* ((class (car args))
|
|
|
3794 (name (if (not (ad-class-p class))
|
|
|
3795 (error "defadvice: Illegal advice class: %s" class)
|
|
|
3796 (nth 1 args)))
|
|
|
3797 (position (if (not (ad-name-p name))
|
|
|
3798 (error "defadvice: Illegal advice name: %s" name)
|
|
|
3799 (setq args (nthcdr 2 args))
|
|
|
3800 (if (ad-position-p (car args))
|
|
|
3801 (prog1 (car args)
|
|
|
3802 (setq args (cdr args))))))
|
|
|
3803 (arglist (if (listp (car args))
|
|
|
3804 (prog1 (car args)
|
|
|
3805 (setq args (cdr args)))))
|
|
|
3806 (flags
|
|
|
3807 (mapcar
|
|
|
3808 (function
|
|
|
3809 (lambda (flag)
|
|
|
3810 (let ((completion
|
|
|
3811 (try-completion (symbol-name flag) ad-defadvice-flags)))
|
|
|
3812 (cond ((eq completion t) flag)
|
|
|
3813 ((assoc completion ad-defadvice-flags)
|
|
|
3814 (intern completion))
|
|
|
3815 (t (error "defadvice: Illegal or ambiguous flag: %s"
|
|
|
3816 flag))))))
|
|
|
3817 args))
|
|
|
3818 (advice (ad-make-advice
|
|
|
3819 name (memq 'protect flags)
|
|
|
3820 (not (memq 'disable flags))
|
|
|
3821 (` (advice lambda (, arglist) (,@ body)))))
|
|
|
3822 (preactivation (if (memq 'preactivate flags)
|
|
|
3823 (ad-preactivate-advice
|
|
|
3824 function advice class position))))
|
|
|
3825 ;; Now for the things to be done at evaluation time:
|
|
|
3826 (if (memq 'freeze flags)
|
|
|
3827 ;; jwz's idea: Freeze the advised definition into a dumpable
|
|
|
3828 ;; defun/defmacro whose docs can be written to the DOC file:
|
|
|
3829 (ad-make-freeze-definition function advice class position)
|
|
|
3830 ;; the normal case:
|
|
|
3831 (` (progn
|
|
|
3832 (ad-add-advice '(, function) '(, advice) '(, class) '(, position))
|
|
|
3833 (,@ (if preactivation
|
|
|
3834 (` ((ad-set-cache
|
|
|
3835 '(, function)
|
|
|
3836 ;; the function will get compiled:
|
|
|
3837 (, (cond ((ad-macro-p (car preactivation))
|
|
|
3838 (` (ad-macrofy
|
|
|
3839 (function
|
|
|
3840 (, (ad-lambdafy
|
|
|
3841 (car preactivation)))))))
|
|
|
3842 (t (` (function
|
|
|
3843 (, (car preactivation)))))))
|
|
|
3844 '(, (car (cdr preactivation))))))))
|
|
|
3845 (,@ (if (memq 'activate flags)
|
|
|
3846 (` ((ad-activate-on '(, function)
|
|
|
3847 (, (if (memq 'compile flags) t)))))))
|
|
|
3848 '(, function))))))
|
|
|
3849
|
|
|
3850
|
|
|
3851 ;; @@ Tools:
|
|
|
3852 ;; =========
|
|
|
3853
|
|
|
3854 (defmacro ad-with-originals (functions &rest body)
|
|
|
3855 "Binds FUNCTIONS to their original definitions and executes BODY.
|
|
|
3856 For any members of FUNCTIONS that are not currently advised the rebinding will
|
|
|
3857 be a noop. Any modifications done to the definitions of FUNCTIONS will be
|
|
|
3858 undone on exit of this macro."
|
|
|
3859 (let* ((index -1)
|
|
|
3860 ;; Make let-variables to store current definitions:
|
|
|
3861 (current-bindings
|
|
|
3862 (mapcar (function
|
|
|
3863 (lambda (function)
|
|
|
3864 (setq index (1+ index))
|
|
|
3865 (list (intern (format "ad-oRiGdEf-%d" index))
|
|
|
3866 (` (symbol-function '(, function))))))
|
|
|
3867 functions)))
|
|
|
3868 (` (let (, current-bindings)
|
|
|
3869 (unwind-protect
|
|
|
3870 (progn
|
|
|
3871 (,@ (progn
|
|
|
3872 ;; Make forms to redefine functions to their
|
|
|
3873 ;; original definitions if they are advised:
|
|
|
3874 (setq index -1)
|
|
|
3875 (mapcar
|
|
|
3876 (function
|
|
|
3877 (lambda (function)
|
|
|
3878 (setq index (1+ index))
|
|
|
3879 (` (ad-safe-fset
|
|
|
3880 '(, function)
|
|
|
3881 (or (ad-get-orig-definition '(, function))
|
|
|
3882 (, (car (nth index current-bindings))))))))
|
|
|
3883 functions)))
|
|
|
3884 (,@ body))
|
|
|
3885 (,@ (progn
|
|
|
3886 ;; Make forms to back-define functions to the definitions
|
|
|
3887 ;; they had outside this macro call:
|
|
|
3888 (setq index -1)
|
|
|
3889 (mapcar
|
|
|
3890 (function
|
|
|
3891 (lambda (function)
|
|
|
3892 (setq index (1+ index))
|
|
|
3893 (` (ad-safe-fset
|
|
|
3894 '(, function)
|
|
|
3895 (, (car (nth index current-bindings)))))))
|
|
|
3896 functions))))))))
|
|
|
3897
|
|
|
3898 (if (not (get 'ad-with-originals 'lisp-indent-hook))
|
|
|
3899 (put 'ad-with-originals 'lisp-indent-hook 1))
|
|
|
3900
|
|
|
3901
|
|
|
3902 ;; @@ Advising `documentation':
|
|
|
3903 ;; ============================
|
|
|
3904 ;; Use the advice mechanism to advise `documentation' to make it
|
|
|
3905 ;; generate proper documentation strings for advised definitions:
|
|
|
3906
|
|
|
3907 (defadvice documentation (after ad-advised-docstring first disable preact)
|
|
|
3908 "Builds an advised docstring if FUNCTION is advised."
|
|
|
3909 ;; Because we get the function name from the advised docstring
|
|
|
3910 ;; this will work for function names as well as for definitions:
|
|
|
3911 (if (and (stringp ad-return-value)
|
|
|
3912 (string-match
|
|
|
3913 ad-advised-definition-docstring-regexp ad-return-value))
|
|
|
3914 (let ((function
|
|
|
3915 (car (read-from-string
|
|
|
3916 ad-return-value (match-beginning 1) (match-end 1)))))
|
|
|
3917 (cond ((ad-is-advised function)
|
|
|
3918 (setq ad-return-value (ad-make-advised-docstring function))
|
|
|
3919 ;; Handle optional `raw' argument:
|
|
|
3920 (if (not (ad-get-arg 1))
|
|
|
3921 (setq ad-return-value
|
|
|
3922 (substitute-command-keys ad-return-value))))))))
|
|
|
3923
|
|
|
3924
|
|
|
3925 ;; @@ Starting, stopping and recovering from the advice package magic:
|
|
|
3926 ;; ===================================================================
|
|
|
3927
|
|
|
3928 (defun ad-start-advice ()
|
|
|
3929 "Starts the automatic advice handling magic."
|
|
|
3930 (interactive)
|
|
|
3931 ;; Advising `ad-activate' means death!!
|
|
|
3932 (ad-set-advice-info 'ad-activate nil)
|
|
|
3933 (ad-safe-fset 'ad-activate 'ad-activate-on)
|
|
|
3934 (ad-enable-advice 'documentation 'after 'ad-advised-docstring)
|
|
|
3935 (ad-activate-on 'documentation 'compile))
|
|
|
3936
|
|
|
3937 (defun ad-stop-advice ()
|
|
|
3938 "Stops the automatic advice handling magic.
|
|
|
3939 You should only need this in case of Advice-related emergencies."
|
|
|
3940 (interactive)
|
|
|
3941 ;; Advising `ad-activate' means death!!
|
|
|
3942 (ad-set-advice-info 'ad-activate nil)
|
|
|
3943 (ad-disable-advice 'documentation 'after 'ad-advised-docstring)
|
|
|
3944 (ad-update 'documentation)
|
|
|
3945 (ad-safe-fset 'ad-activate 'ad-activate-off))
|
|
|
3946
|
|
|
3947 (defun ad-recover-normality ()
|
|
|
3948 "Undoes all advice related redefinitions and unadvises everything.
|
|
|
3949 Use only in REAL emergencies."
|
|
|
3950 (interactive)
|
|
|
3951 ;; Advising `ad-activate' means death!!
|
|
|
3952 (ad-set-advice-info 'ad-activate nil)
|
|
|
3953 (ad-safe-fset 'ad-activate 'ad-activate-off)
|
|
|
3954 (ad-recover-all)
|
|
|
3955 (setq ad-advised-functions nil))
|
|
|
3956
|
|
2
|
3957 ;; Until the Advice-related changes to `data.c' are part of Lemacs we
|
|
|
3958 ;; have to load the old implementation of advice activation hooks:
|
|
|
3959 ;; XEmacs: Not sure what this is supposed to accomplish. There is no
|
|
|
3960 ;; ad-hooks.el. -sb
|
|
|
3961 ;(if (ad-lemacs-p)
|
|
|
3962 ; (require 'ad-hooks))
|
|
|
3963
|
|
0
|
3964 (ad-start-advice)
|
|
|
3965
|
|
|
3966 (provide 'advice)
|
|
|
3967
|
|
|
3968 ;;; advice.el ends here
|
