comparison lispref/advice.texi @ 90043:e24e2e78deda

Revision: [e-mail]--gnu-2004/emacs--unicode--0--patch-69 Merge from emacs--cvs-trunk--0 Patches applied: * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-643 - [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-649 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-650 Merge from gnus--rel--5.10 * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-651 - [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-655 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-656 Update from CVS: lisp/man.el (Man-xref-normal-file): Fix help-echo. * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-657 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-658 Merge from gnus--rel--5.10 * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-659 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-660 Merge from gnus--rel--5.10 * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-661 - [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-667 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-668 Merge from gnus--rel--5.10 * [e-mail]--gnu-2004/gnus--rel--5.10--patch-61 - [e-mail]--gnu-2004/gnus--rel--5.10--patch-68 Update from CVS

90042:003d95404d71

move to if @code{next-line-add-newlines} is non-@code{nil} (its default
is @code{nil}.)

  Suppose you wanted to add a similar feature to @code{previous-line},
which would insert a new line at the beginning of the buffer for the
command to move to.  How could you do this?

  You could do it by redefining the whole function, but that is not
modular.  The advice feature provides a cleaner alternative: you can
effectively add your code to the existing function definition, without
actually changing or even seeing that definition.  Here is how to do

@noindent
Its effect is to make sure that case is ignored in
searches when the original definition of @code{foo} is run.

@defvar ad-do-it
This is not really a variable, but it is somewhat used like one
in around-advice.  It specifies the place to run the function's
original definition and other ``earlier'' around-advice.
@end defvar

If the around-advice does not use @code{ad-do-it}, then it does not run
the original function definition.  This provides a way to override the
original definition completely.  (It also overrides lower-positioned

@deffn Command ad-activate function &optional compile
This command activates all the advice defined for @var{function}.
@end deffn

To activate advice for a function whose advice is already active is not
a no-op.  It is a useful operation which puts into effect any changes in
that function's advice since the previous activation of advice for that
function.

@deffn Command ad-deactivate function
This command deactivates the advice for @var{function}.
@cindex deactivating advice
@cindex advice, deactivating

@defopt ad-default-compilation-action
This variable controls whether to compile the combined definition
that results from activating advice for a function.

A value of @code{always} specifies to compile unconditionally.
A value of @code{nil} specifies never compile the advice.

A value of @code{maybe} specifies to compile if the byte-compiler is
already loaded.  A value of @code{like-original} specifies to compile
the advice if the original definition of the advised function is
compiled or a built-in function.

90043:e24e2e78deda

move to if @code{next-line-add-newlines} is non-@code{nil} (its default
is @code{nil}.)

  Suppose you wanted to add a similar feature to @code{previous-line},
which would insert a new line at the beginning of the buffer for the
command to move to (when @code{next-line-add-newlines} is
non-@code{nil}).  How could you do this?

  You could do it by redefining the whole function, but that is not
modular.  The advice feature provides a cleaner alternative: you can
effectively add your code to the existing function definition, without
actually changing or even seeing that definition.  Here is how to do

@noindent
Its effect is to make sure that case is ignored in
searches when the original definition of @code{foo} is run.

@defvar ad-do-it
This is not really a variable, rather a place-holder that looks like a
variable.  You use it in around-advice to specify the place to run the
function's original definition and other ``earlier'' around-advice.
@end defvar

If the around-advice does not use @code{ad-do-it}, then it does not run
the original function definition.  This provides a way to override the
original definition completely.  (It also overrides lower-positioned

@deffn Command ad-activate function &optional compile
This command activates all the advice defined for @var{function}.
@end deffn

  Activating advice does nothing if @var{function}'s advice is already
active.  But if there is new advice, added since the previous time you
activated advice for @var{function}, it activates the new advice.

@deffn Command ad-deactivate function
This command deactivates the advice for @var{function}.
@cindex deactivating advice
@cindex advice, deactivating

@defopt ad-default-compilation-action
This variable controls whether to compile the combined definition
that results from activating advice for a function.

A value of @code{always} specifies to compile unconditionally.
A value of @code{never} specifies never compile the advice.

A value of @code{maybe} specifies to compile if the byte-compiler is
already loaded.  A value of @code{like-original} specifies to compile
the advice if the original definition of the advised function is
compiled or a built-in function.