SM0 She11

Full Path (server): /usr/share/perl5/pod

📄 a2p.pod [E] [D]
📄 perl.pod [E] [D]
📄 perl5004delta.pod [E] [D]
📄 perl5005delta.pod [E] [D]
📄 perl5100delta.pod [E] [D]
📄 perl5101delta.pod [E] [D]
📄 perl5120delta.pod [E] [D]
📄 perl5121delta.pod [E] [D]
📄 perl5122delta.pod [E] [D]
📄 perl5123delta.pod [E] [D]
📄 perl5124delta.pod [E] [D]
📄 perl5140delta.pod [E] [D]
📄 perl5141delta.pod [E] [D]
📄 perl5142delta.pod [E] [D]
📄 perl5143delta.pod [E] [D]
📄 perl5160delta.pod [E] [D]
📄 perl5161delta.pod [E] [D]
📄 perl5162delta.pod [E] [D]
📄 perl5163delta.pod [E] [D]
📄 perl561delta.pod [E] [D]
📄 perl56delta.pod [E] [D]
📄 perl581delta.pod [E] [D]
📄 perl582delta.pod [E] [D]
📄 perl583delta.pod [E] [D]
📄 perl584delta.pod [E] [D]
📄 perl585delta.pod [E] [D]
📄 perl586delta.pod [E] [D]
📄 perl587delta.pod [E] [D]
📄 perl588delta.pod [E] [D]
📄 perl589delta.pod [E] [D]
📄 perl58delta.pod [E] [D]
📄 perlaix.pod [E] [D]
📄 perlamiga.pod [E] [D]
📄 perlapi.pod [E] [D]
📄 perlapio.pod [E] [D]
📄 perlartistic.pod [E] [D]
📄 perlbeos.pod [E] [D]
📄 perlbook.pod [E] [D]
📄 perlboot.pod [E] [D]
📄 perlbot.pod [E] [D]
📄 perlbs2000.pod [E] [D]
📄 perlcall.pod [E] [D]
📄 perlce.pod [E] [D]
📄 perlcheat.pod [E] [D]
📄 perlclib.pod [E] [D]
📄 perlcn.pod [E] [D]
📄 perlcommunity.pod [E] [D]
📄 perlcygwin.pod [E] [D]
📄 perldata.pod [E] [D]
📄 perldbmfilter.pod [E] [D]
📄 perldebguts.pod [E] [D]
📄 perldebtut.pod [E] [D]
📄 perldebug.pod [E] [D]
📄 perldelta.pod [E] [D]
📄 perldgux.pod [E] [D]
📄 perldiag.pod [E] [D]
📄 perldos.pod [E] [D]
📄 perldsc.pod [E] [D]
📄 perldtrace.pod [E] [D]
📄 perlebcdic.pod [E] [D]
📄 perlembed.pod [E] [D]
📄 perlepoc.pod [E] [D]
📄 perlexperiment.pod [E] [D]
📄 perlfaq.pod [E] [D]
📄 perlfaq1.pod [E] [D]
📄 perlfaq2.pod [E] [D]
📄 perlfaq3.pod [E] [D]
📄 perlfaq4.pod [E] [D]
📄 perlfaq5.pod [E] [D]
📄 perlfaq6.pod [E] [D]
📄 perlfaq7.pod [E] [D]
📄 perlfaq8.pod [E] [D]
📄 perlfaq9.pod [E] [D]
📄 perlfork.pod [E] [D]
📄 perlform.pod [E] [D]
📄 perlfreebsd.pod [E] [D]
📄 perlfunc.pod [E] [D]
📄 perlgit.pod [E] [D]
📄 perlglossary.pod [E] [D]
📄 perlgpl.pod [E] [D]
📄 perlguts.pod [E] [D]
📄 perlhack.pod [E] [D]
📄 perlhacktips.pod [E] [D]
📄 perlhacktut.pod [E] [D]
📄 perlhaiku.pod [E] [D]
📄 perlhist.pod [E] [D]
📄 perlhpux.pod [E] [D]
📄 perlhurd.pod [E] [D]
📄 perlintern.pod [E] [D]
📄 perlinterp.pod [E] [D]
📄 perlintro.pod [E] [D]
📄 perliol.pod [E] [D]
📄 perlipc.pod [E] [D]
📄 perlirix.pod [E] [D]
📄 perljp.pod [E] [D]
📄 perlko.pod [E] [D]
📄 perllexwarn.pod [E] [D]
📄 perllinux.pod [E] [D]
📄 perllocale.pod [E] [D]
📄 perllol.pod [E] [D]
📄 perlmacos.pod [E] [D]
📄 perlmacosx.pod [E] [D]
📄 perlmod.pod [E] [D]
📄 perlmodinstall.pod [E] [D]
📄 perlmodlib.pod [E] [D]
📄 perlmodstyle.pod [E] [D]
📄 perlmpeix.pod [E] [D]
📄 perlmroapi.pod [E] [D]
📄 perlnetware.pod [E] [D]
📄 perlnewmod.pod [E] [D]
📄 perlnumber.pod [E] [D]
📄 perlobj.pod [E] [D]
📄 perlootut.pod [E] [D]
📄 perlop.pod [E] [D]
📄 perlopenbsd.pod [E] [D]
📄 perlopentut.pod [E] [D]
📄 perlos2.pod [E] [D]
📄 perlos390.pod [E] [D]
📄 perlos400.pod [E] [D]
📄 perlpacktut.pod [E] [D]
📄 perlperf.pod [E] [D]
📄 perlplan9.pod [E] [D]
📄 perlpod.pod [E] [D]
📄 perlpodspec.pod [E] [D]
📄 perlpolicy.pod [E] [D]
📄 perlport.pod [E] [D]
📄 perlpragma.pod [E] [D]
📄 perlqnx.pod [E] [D]
📄 perlre.pod [E] [D]
📄 perlreapi.pod [E] [D]
📄 perlrebackslash.pod [E] [D]
📄 perlrecharclass.pod [E] [D]
📄 perlref.pod [E] [D]
📄 perlreftut.pod [E] [D]
📄 perlreguts.pod [E] [D]
📄 perlrequick.pod [E] [D]
📄 perlreref.pod [E] [D]
📄 perlretut.pod [E] [D]
📄 perlriscos.pod [E] [D]
📄 perlrun.pod [E] [D]
📄 perlsec.pod [E] [D]
📄 perlsolaris.pod [E] [D]
📄 perlsource.pod [E] [D]
📄 perlstyle.pod [E] [D]
📄 perlsub.pod [E] [D]
📄 perlsymbian.pod [E] [D]
📄 perlsyn.pod [E] [D]
📄 perlthrtut.pod [E] [D]
📄 perltie.pod [E] [D]
📄 perltoc.pod [E] [D]
📄 perltodo.pod [E] [D]
📄 perltooc.pod [E] [D]
📄 perltoot.pod [E] [D]
📄 perltrap.pod [E] [D]
📄 perltru64.pod [E] [D]
📄 perltw.pod [E] [D]
📄 perlunicode.pod [E] [D]
📄 perlunifaq.pod [E] [D]
📄 perluniintro.pod [E] [D]
📄 perluniprops.pod [E] [D]
📄 perlunitut.pod [E] [D]
📄 perlutil.pod [E] [D]
📄 perluts.pod [E] [D]
📄 perlvar.pod [E] [D]
📄 perlvmesa.pod [E] [D]
📄 perlvms.pod [E] [D]
📄 perlvos.pod [E] [D]
📄 perlwin32.pod [E] [D]
📄 perlxs.pod [E] [D]
📄 perlxstut.pod [E] [D]
📄 perlxstypemap.pod [E] [D]

Editing: perlmroapi.pod

=head1 NAME

perlmroapi - Perl method resolution plugin interface

=head1 DESCRIPTION

As of Perl 5.10.1 there is a new interface for plugging and using method
resolution orders other than the default (linear depth first search).
The C3 method resolution order added in 5.10.0 has been re-implemented as
a plugin, without changing its Perl-space interface.

Each plugin should register itself by providing
the following structure

struct mro_alg {
        AV *(*resolve)(pTHX_ HV *stash, U32 level);
        const char *name;
        U16 length;
        U16 kflags;
        U32 hash;
    };

and calling C<Perl_mro_register>:

Perl_mro_register(aTHX_ &my_mro_alg);

=over 4

=item resolve

Pointer to the linearisation function, described below.

=item name

Name of the MRO, either in ISO-8859-1 or UTF-8.

=item length

Length of the name.

=item kflags

If the name is given in UTF-8, set this to C<HVhek_UTF8>. The value is passed
direct as the parameter I<kflags> to C<hv_common()>.

=item hash

A precomputed hash value for the MRO's name, or 0.

=back

=head1 Callbacks

The C<resolve> function is called to generate a linearised ISA for the
given stash, using this MRO. It is called with a pointer to the stash, and
a I<level> of 0. The core always sets I<level> to 0 when it calls your
function - the parameter is provided to allow your implementation to track
depth if it needs to recurse.

The function should return a reference to an array containing the parent
classes in order. The names of the classes should be the result of calling
C<HvENAME()> on the stash. In those cases where C<HvENAME()> returns null,
C<HvNAME()> should be used instead.

The caller is responsible for incrementing the reference count of the array
returned if it wants to keep the structure. Hence, if you have created a
temporary value that you keep no pointer to, C<sv_2mortal()> to ensure that
it is disposed of correctly. If you have cached your return value, then
return a pointer to it without changing the reference count.

=head1 Caching

Computing MROs can be expensive. The implementation provides a cache, in
which you can store a single C<SV *>, or anything that can be cast to
C<SV *>, such as C<AV *>. To read your private value, use the macro
C<MRO_GET_PRIVATE_DATA()>, passing it the C<mro_meta> structure from the
stash, and a pointer to your C<mro_alg> structure:

meta = HvMROMETA(stash);
    private_sv = MRO_GET_PRIVATE_DATA(meta, &my_mro_alg);

To set your private value, call C<Perl_mro_set_private_data()>:

Perl_mro_set_private_data(aTHX_ meta, &c3_alg, private_sv);

The private data cache will take ownership of a reference to private_sv,
much the same way that C<hv_store()> takes ownership of a reference to the
value that you pass it.

=head1 Examples

For examples of MRO implementations, see C<S_mro_get_linear_isa_c3()>
and the C<BOOT:> section of F<mro/mro.xs>, and C<S_mro_get_linear_isa_dfs()>
in F<mro.c>

=head1 AUTHORS

The implementation of the C3 MRO and switchable MROs within the perl core was
written by Brandon L Black. Nicholas Clark created the pluggable interface, 
refactored Brandon's implementation to work with it, and wrote this document.

=cut