/snap/gh/640/usr/share/perl/5.38.2
Edit: /snap/gh/640/usr/share/perl/5.38.2/deprecate.pm (5036B)
package deprecate;
use strict;
use warnings;
our $VERSION = 0.04;
# our %Config can ignore %Config::Config, e.g. for testing
our %Config;
unless (%Config) { require Config; *Config = \%Config::Config; }
# Debian-specific change: recommend the separate Debian packages of
# deprecated modules where available
our %DEBIAN_PACKAGES = (
#'Foo:Bar' => 'libfoo-bar-perl',
);
# This isn't a public API. It's internal to code maintained by the perl-porters
# If you would like it to be a public API, please send a patch with
# documentation and tests. Until then, it may change without warning.
sub __loaded_from_core {
my ($package, $file, $expect_leaf) = @_;
foreach my $pair ([qw(sitearchexp archlibexp)],
[qw(sitelibexp privlibexp)]) {
my ($site, $priv) = @Config{@$pair};
if ($^O eq 'VMS') {
for my $d ($site, $priv) { $d = VMS::Filespec::unixify($d) };
}
# Just in case anyone managed to configure with trailing /s
s!/*$!!g foreach $site, $priv;
next if $site eq $priv;
if (uc("$priv/$expect_leaf") eq uc($file)) {
return 1;
}
}
return 0;
}
sub import {
my ($package, $file) = caller;
my $expect_leaf = "$package.pm";
$expect_leaf =~ s!::!/!g;
if (__loaded_from_core($package, $file, $expect_leaf)) {
my $call_depth=1;
my @caller;
while (@caller = caller $call_depth++) {
last if $caller[7] # use/require
and $caller[6] eq $expect_leaf; # the package file
}
unless (@caller) {
require Carp;
Carp::cluck(<<"EOM");
Can't find use/require $expect_leaf in caller stack
EOM
return;
}
# This is fragile, because it
# is directly poking in the internals of warnings.pm
my ($call_file, $call_line, $callers_bitmask) = @caller[1,2,9];
if (defined $callers_bitmask
&& (vec($callers_bitmask, $warnings::Offsets{deprecated}, 1)
|| vec($callers_bitmask, $warnings::Offsets{all}, 1))) {
if (my $deb = $DEBIAN_PACKAGES{$package}) {
warn <<"EOM";
$package will be removed from the Perl core distribution in the next major release. Please install the separate $deb package. It is being used at $call_file, line $call_line.
EOM
} else {
warn <<"EOM";
$package will be removed from the Perl core distribution in the next major release. Please install it from CPAN. It is being used at $call_file, line $call_line.
EOM
}
}
}
}
1;
__END__
=head1 NAME
deprecate - Perl pragma for deprecating the inclusion of a module in core
=head1 SYNOPSIS
use deprecate; # warn about future absence if loaded from core
=head1 DESCRIPTION
This pragma simplifies the maintenance of dual-life modules that will no longer
be included in the Perl core in a future Perl release, but are still included
currently.
The purpose of the pragma is to alert users to the status of such a module by
issuing a warning that encourages them to install the module from CPAN, so that
a future upgrade to a perl which omits the module will not break their code.
This warning will only be issued if the module was loaded from a core library
directory, which allows the C