.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Aspect::Advice::Before 3pm"
.TH Aspect::Advice::Before 3pm "2023-07-02" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Aspect::Advice::Before \- Execute code before a function is called
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Aspect;
\&  
\&  before {
\&  
\&      # Trace all calls to your module
\&      print STDERR "Called my function " . $_\->sub_name . "\en";
\&  
\&      # Shortcut calls to foo() to always be true
\&      if ( $_\->short_name eq \*(Aqfoo\*(Aq ) {
\&          return $_\->return_value(1);
\&      }
\&  
\&      # Add an extra flag to bar() but call as normal
\&      if ( $_\->short_name eq \*(Aqbar\*(Aq ) {
\&          $_\->args( $_\->args, \*(Aqflag\*(Aq );
\&      }
\&
\&  } call qr/^ MyModule::\ew+ $/
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`before\*(C'\fR advice type is used to execute advice code prior to entry
into a target function. It is implemented by \fBAspect::Advice::Before\fR.
.PP
As well as creating side effects that run before the main code, the
\&\f(CW\*(C`before\*(C'\fR advice type is particularly useful for changing parameters or
shortcutting calls to functions entirely and replacing the value they
would normally return with a different value.
.PP
Please note that the \f(CW\*(C`highest\*(C'\fR pointcut (Aspect::Pointcut::Highest) is
incompatible with \f(CW\*(C`before\*(C'\fR. Creating a \f(CW\*(C`before\*(C'\fR advice with a pointcut
tree that contains a \f(CW\*(C`highest\*(C'\fR pointcut will result in an exception.
.PP
If speed is important to your program then \f(CW\*(C`before\*(C'\fR is particular
interesting as the \f(CW\*(C`before\*(C'\fR implementation is the only one that can take
advantage of tail calls via Perl's \f(CW\*(C`goto\*(C'\fR function, where the rest of the
advice types need the more costly Sub::Uplevel to keep \fBcaller()\fR returning
correctly.
.SH "AUTHORS"
.IX Header "AUTHORS"
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010 \- 2013 Adam Kennedy.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.