| MRO-Compat documentation | Contained in the MRO-Compat distribution. |
MRO::Compat - mro::* interface compatibility for Perls < 5.9.5
package FooClass; use base qw/X Y Z/;
package X; use base qw/ZZZ/;
package Y; use base qw/ZZZ/;
package Z; use base qw/ZZZ/;
package main;
use MRO::Compat;
my $linear = mro::get_linear_isa('FooClass');
print join(q{, }, @$linear);
# Prints: "FooClass, X, ZZZ, Y, Z"
The "mro" namespace provides several utilities for dealing with method resolution order and method caching in general in Perl 5.9.5 and higher.
This module provides those interfaces for earlier versions of Perl (back to 5.6.0 anyways).
It is a harmless no-op to use this module on 5.9.5+. That is to say, code which properly uses MRO::Compat will work unmodified on both older Perls and 5.9.5+.
If you're writing a piece of software that would like to use the parts of 5.9.5+'s mro:: interfaces that are supported here, and you want compatibility with older Perls, this is the module for you.
Some parts of this code will work better and/or faster with Class::C3::XS installed (which is an optional prereq of Class::C3, which is in turn a prereq of this package), but it's not a requirement.
This module never exports any functions. All calls must
be fully qualified with the mro:: prefix.
The interface documentation here serves only as a quick reference of what the function basically does, and what differences between MRO::Compat and 5.9.5+ one should look out for. The main docs in 5.9.5's mro are the real interface docs, and contain a lot of other useful information.
Returns an arrayref which is the linearized "ISA" of the given class.
Uses whichever MRO is currently in effect for that class by default,
or the given MRO (either c3 or dfs if specified as $type).
The linearized ISA of a class is a single ordered list of all of the classes that would be visited in the process of resolving a method on the given class, starting with itself. It does not include any duplicate entries.
Note that UNIVERSAL (and any members of UNIVERSAL's MRO) are not
part of the MRO of a class, even though all classes implicitly inherit
methods from UNIVERSAL and its parents.
This allows the use mro 'dfs' and
use mro 'c3' syntaxes, providing you
use MRO::Compat first. Please see the
USING C3 section for additional details.
Sets the mro of $classname to one of the types
dfs or c3. Please see the USING C3
section for additional details.
Returns the MRO of the given class (either c3 or dfs).
It considers any Class::C3-using class to have C3 MRO even before Class::C3::initialize() is called.
Returns an arrayref of classes who are subclasses of the given classname. In other words, classes in whose @ISA hierarchy we appear, no matter how indirectly.
This is much slower on pre-5.9.5 Perls with MRO::Compat than it is on 5.9.5+, as it has to search the entire package namespace.
Returns a boolean status indicating whether or not
the given classname is either UNIVERSAL itself,
or one of UNIVERSAL's parents by @ISA inheritance.
Any class for which this function returns true is "universal" in the sense that all classes potentially inherit methods from it.
Increments PL_sub_generation, which invalidates method
caching in all packages.
Please note that this is rarely necessary, unless you are dealing with a situation which is known to confuse Perl's method caching.
Invalidates the method cache of any classes dependent on the
given class. In MRO::Compat on pre-5.9.5 Perls, this is
an alias for mro::invalidate_all_method_caches above, as
pre-5.9.5 Perls have no other way to do this. It will still
enforce the requirement that you pass it a classname, for
compatibility.
Please note that this is rarely necessary, unless you are dealing with a situation which is known to confuse Perl's method caching.
Returns an integer which is incremented every time a local
method of or the @ISA of the given package changes on
Perl 5.9.5+. On earlier Perls with this MRO::Compat module,
it will probably increment a lot more often than necessary.
While this module makes the 5.9.5+ syntaxes
use mro 'c3' and mro::set_mro("Foo", 'c3') available
on older Perls, it does so merely by passing off the work
to Class::C3.
It does not remove the need for you to call
Class::C3::initialize(), Class::C3::reinitialize(), and/or
Class::C3::uninitialize() at the appropriate times
as documented in the Class::C3 docs. These three functions
are always provided by MRO::Compat, either via Class::C3
itself on older Perls, or directly as no-ops on 5.9.5+.
mro
Brandon L. Black, <blblack@gmail.com>
Copyright 2007-2008 Brandon L. Black <blblack@gmail.com>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| MRO-Compat documentation | Contained in the MRO-Compat distribution. |
package MRO::Compat; use strict; use warnings; require 5.006_000; # Keep this < 1.00, so people can tell the fake # mro.pm from the real one our $VERSION = '0.11'; BEGIN { # Alias our private functions over to # the mro:: namespace and load # Class::C3 if Perl < 5.9.5 if($] < 5.009_005) { $mro::VERSION # to fool Module::Install when generating META.yml = $VERSION; $INC{'mro.pm'} = __FILE__; *mro::import = \&__import; *mro::get_linear_isa = \&__get_linear_isa; *mro::set_mro = \&__set_mro; *mro::get_mro = \&__get_mro; *mro::get_isarev = \&__get_isarev; *mro::is_universal = \&__is_universal; *mro::method_changed_in = \&__method_changed_in; *mro::invalidate_all_method_caches = \&__invalidate_all_method_caches; require Class::C3; if($Class::C3::XS::VERSION && $Class::C3::XS::VERSION > 0.03) { *mro::get_pkg_gen = \&__get_pkg_gen_c3xs; } else { *mro::get_pkg_gen = \&__get_pkg_gen_pp; } } # Load mro.pm and provide no-op Class::C3::.*initialize() funcs for 5.9.5+ else { require mro; no warnings 'redefine'; *Class::C3::initialize = sub { 1 }; *Class::C3::reinitialize = sub { 1 }; *Class::C3::uninitialize = sub { 1 }; } }
sub __get_linear_isa_dfs { no strict 'refs'; my $classname = shift; my @lin = ($classname); my %stored; foreach my $parent (@{"$classname\::ISA"}) { my $plin = __get_linear_isa_dfs($parent); foreach (@$plin) { next if exists $stored{$_}; push(@lin, $_); $stored{$_} = 1; } } return \@lin; } sub __get_linear_isa { my ($classname, $type) = @_; die "mro::get_mro requires a classname" if !defined $classname; $type ||= __get_mro($classname); if($type eq 'dfs') { return __get_linear_isa_dfs($classname); } elsif($type eq 'c3') { return [Class::C3::calculateMRO($classname)]; } die "type argument must be 'dfs' or 'c3'"; }
sub __import { if($_[1]) { goto &Class::C3::import if $_[1] eq 'c3'; __set_mro(scalar(caller), $_[1]); } }
sub __set_mro { my ($classname, $type) = @_; if(!defined $classname || !$type) { die q{Usage: mro::set_mro($classname, $type)}; } if($type eq 'c3') { eval "package $classname; use Class::C3"; die $@ if $@; } elsif($type eq 'dfs') { # In the dfs case, check whether we need to undo C3 if(defined $Class::C3::MRO{$classname}) { Class::C3::_remove_method_dispatch_table($classname); } delete $Class::C3::MRO{$classname}; } else { die qq{Invalid mro type "$type"}; } return; }
sub __get_mro { my $classname = shift; die "mro::get_mro requires a classname" if !defined $classname; return 'c3' if exists $Class::C3::MRO{$classname}; return 'dfs'; }
sub __get_all_pkgs_with_isas { no strict 'refs'; no warnings 'recursion'; my @retval; my $search = shift; my $pfx; my $isa; if(defined $search) { $isa = \@{"$search\::ISA"}; $pfx = "$search\::"; } else { $search = 'main'; $isa = \@main::ISA; $pfx = ''; } push(@retval, $search) if scalar(@$isa); foreach my $cand (keys %{"$search\::"}) { if($cand =~ s/::$//) { next if $cand eq $search; # skip self-reference (main?) push(@retval, @{__get_all_pkgs_with_isas($pfx . $cand)}); } } return \@retval; } sub __get_isarev_recurse { no strict 'refs'; my ($class, $all_isas, $level) = @_; die "Recursive inheritance detected" if $level > 100; my %retval; foreach my $cand (@$all_isas) { my $found_me; foreach (@{"$cand\::ISA"}) { if($_ eq $class) { $found_me = 1; last; } } if($found_me) { $retval{$cand} = 1; map { $retval{$_} = 1 } @{__get_isarev_recurse($cand, $all_isas, $level+1)}; } } return [keys %retval]; } sub __get_isarev { my $classname = shift; die "mro::get_isarev requires a classname" if !defined $classname; __get_isarev_recurse($classname, __get_all_pkgs_with_isas(), 0); }
sub __is_universal { my $classname = shift; die "mro::is_universal requires a classname" if !defined $classname; my $lin = __get_linear_isa('UNIVERSAL'); foreach (@$lin) { return 1 if $classname eq $_; } return 0; }
sub __invalidate_all_method_caches { # Super secret mystery code :) @f845a9c1ac41be33::ISA = @f845a9c1ac41be33::ISA; return; }
sub __method_changed_in { my $classname = shift; die "mro::method_changed_in requires a classname" if !defined $classname; __invalidate_all_method_caches(); }
{ my $__pkg_gen = 2; sub __get_pkg_gen_pp { my $classname = shift; die "mro::get_pkg_gen requires a classname" if !defined $classname; return $__pkg_gen++; } } sub __get_pkg_gen_c3xs { my $classname = shift; die "mro::get_pkg_gen requires a classname" if !defined $classname; return Class::C3::XS::_plsubgen(); }
1;