.\" 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::Modular 3pm"
.TH Aspect::Modular 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::Modular \- First generation base class for reusable aspects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # Subclassing to create a reusable aspect
\&  package Aspect::Library::ConstructorTracer;
\&  
\&  use strict;
\&  use base \*(AqAspect::Modular\*(Aq;
\&  use Aspect::Advice::After ();
\&  
\&  sub get_advice {
\&     my $self     = shift;
\&     my $pointcut = shift;
\&     return Aspect::Advice::After\->new(
\&         lexical  => $self\->lexical,
\&         pointcut => $pointcut,
\&         code     => sub {
\&             print \*(AqCreated object: \*(Aq . shift\->return_value . "\en";
\&         },
\&     );
\&  }
\&
\&  # Using the new aspect
\&  package main;
\&  
\&  use Aspect;
\&  
\&  # Print message when constructing new Person
\&  aspect ConstructorTracer => call \*(AqPerson::new\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
All reusable aspect inherit from this class.
.PP
Such aspects are created in user code, using the \f(CW\*(C`aspect()\*(C'\fR sub exported
by Aspect. You call \f(CW\*(C`aspect()\*(C'\fR with the class name of the
reusable aspect (it must exist in the package \f(CW\*(C`Aspect::Library\*(C'\fR), and any
parameters (pointcuts, class names, code to run, etc.) the specific aspect
may require.
.PP
The Wormhole aspect, for example, expects 2
pointcut specs for the wormhole source and target, while the
Profiler aspect expects a pointcut object,
to select the subs to be profiled.
.PP
You create a reusable aspect by subclassing this class, and providing one
\&\fItemplate method\fR: \f(CW\*(C`get_advice()\*(C'\fR. It is called with all the parameters
that were sent when user code created the aspect, and is expected to
return Aspect::Advice object/s, that will be installed while the
reusable aspect is still in scope. If the \f(CW\*(C`aspect()\*(C'\fR sub is called in
void context, the reusable aspect is installed until class reloading or
interpreter shutdown.
.PP
Typical things a reusable aspect may want to do:
.IP "\(bu" 4
Install advice on pointcuts specified by the caller
.IP "\(bu" 4
Push (vs. \s-1OOP\s0 pull) subs and base classes into classes specified by
the caller
.SH "AUTHORS"
.IX Header "AUTHORS"
Adam Kennedy <adamk@cpan.org>
.PP
Marcel Grünauer <marcel@cpan.org>
.PP
Ran Eilam <eilara@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2001 by Marcel Grünauer
.PP
Some parts copyright 2009 \- 2013 Adam Kennedy.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.