Blame lib/ExtUtils/Helpers.pm

Packit b7b64d
package ExtUtils::Helpers;
Packit b7b64d
$ExtUtils::Helpers::VERSION = '0.026';
Packit b7b64d
use strict;
Packit b7b64d
use warnings FATAL => 'all';
Packit b7b64d
use Exporter 5.57 'import';
Packit b7b64d
Packit b7b64d
use Config;
Packit b7b64d
use File::Basename qw/basename/;
Packit b7b64d
use File::Spec::Functions qw/splitpath canonpath abs2rel splitdir/;
Packit b7b64d
use Text::ParseWords 3.24 ();
Packit b7b64d
Packit b7b64d
our @EXPORT_OK = qw/make_executable split_like_shell man1_pagename man3_pagename detildefy/;
Packit b7b64d
Packit b7b64d
BEGIN {
Packit b7b64d
	my %impl_for = ( MSWin32 => 'Windows', VMS => 'VMS');
Packit b7b64d
	my $package = 'ExtUtils::Helpers::' . ($impl_for{$^O} || 'Unix');
Packit b7b64d
	my $impl = $impl_for{$^O} || 'Unix';
Packit b7b64d
	require "ExtUtils/Helpers/$impl.pm";
Packit b7b64d
	"ExtUtils::Helpers::$impl"->import();
Packit b7b64d
}
Packit b7b64d
Packit b7b64d
sub split_like_shell {
Packit b7b64d
	my ($string) = @_;
Packit b7b64d
Packit b7b64d
	return if not defined $string;
Packit b7b64d
	$string =~ s/^\s+|\s+$//g;
Packit b7b64d
	return if not length $string;
Packit b7b64d
Packit b7b64d
	return Text::ParseWords::shellwords($string);
Packit b7b64d
}
Packit b7b64d
Packit b7b64d
sub man1_pagename {
Packit b7b64d
	my $filename = shift;
Packit b7b64d
	return basename($filename).".$Config{man1ext}";
Packit b7b64d
}
Packit b7b64d
Packit b7b64d
my %separator = (
Packit b7b64d
	MSWin32 => '.',
Packit b7b64d
	VMS => '__',
Packit b7b64d
	os2 => '.',
Packit b7b64d
	cygwin => '.',
Packit b7b64d
);
Packit b7b64d
my $separator = $separator{$^O} || '::';
Packit b7b64d
Packit b7b64d
sub man3_pagename {
Packit b7b64d
	my ($filename, $base) = @_;
Packit b7b64d
	$base ||= 'lib';
Packit b7b64d
	my ($vols, $dirs, $file) = splitpath(canonpath(abs2rel($filename, $base)));
Packit b7b64d
	$file = basename($file, qw/.pm .pod/);
Packit b7b64d
	my @dirs = grep { length } splitdir($dirs);
Packit b7b64d
	return join $separator, @dirs, "$file.$Config{man3ext}";
Packit b7b64d
}
Packit b7b64d
Packit b7b64d
1;
Packit b7b64d
Packit b7b64d
# ABSTRACT: Various portability utilities for module builders
Packit b7b64d
Packit b7b64d
__END__
Packit b7b64d
Packit b7b64d
=pod
Packit b7b64d
Packit b7b64d
=encoding utf-8
Packit b7b64d
Packit b7b64d
=head1 NAME
Packit b7b64d
Packit b7b64d
ExtUtils::Helpers - Various portability utilities for module builders
Packit b7b64d
Packit b7b64d
=head1 VERSION
Packit b7b64d
Packit b7b64d
version 0.026
Packit b7b64d
Packit b7b64d
=head1 SYNOPSIS
Packit b7b64d
Packit b7b64d
 use ExtUtils::Helpers qw/make_executable split_like_shell/;
Packit b7b64d
Packit b7b64d
 unshift @ARGV, split_like_shell($ENV{PROGRAM_OPTS});
Packit b7b64d
 write_script_to('Build');
Packit b7b64d
 make_executable('Build');
Packit b7b64d
Packit b7b64d
=head1 DESCRIPTION
Packit b7b64d
Packit b7b64d
This module provides various portable helper functions for module building modules.
Packit b7b64d
Packit b7b64d
=head1 FUNCTIONS
Packit b7b64d
Packit b7b64d
=head2 make_executable($filename)
Packit b7b64d
Packit b7b64d
This makes a perl script executable.
Packit b7b64d
Packit b7b64d
=head2 split_like_shell($string)
Packit b7b64d
Packit b7b64d
This function splits a string the same way as the local platform does.
Packit b7b64d
Packit b7b64d
=head2 detildefy($path)
Packit b7b64d
Packit b7b64d
This function substitutes a tilde at the start of a path with the users homedir in an appropriate manner.
Packit b7b64d
Packit b7b64d
=head2 man1_pagename($filename)
Packit b7b64d
Packit b7b64d
Returns the man page filename for a script.
Packit b7b64d
Packit b7b64d
=head2 man3_pagename($filename, $basedir)
Packit b7b64d
Packit b7b64d
Returns the man page filename for a Perl library.
Packit b7b64d
Packit b7b64d
=head1 ACKNOWLEDGEMENTS
Packit b7b64d
Packit b7b64d
Olivier Mengué and Christian Walde made C<make_executable> work on Windows.
Packit b7b64d
Packit b7b64d
=head1 AUTHORS
Packit b7b64d
Packit b7b64d
=over 4
Packit b7b64d
Packit b7b64d
=item *
Packit b7b64d
Packit b7b64d
Ken Williams <kwilliams@cpan.org>
Packit b7b64d
Packit b7b64d
=item *
Packit b7b64d
Packit b7b64d
Leon Timmermans <leont@cpan.org>
Packit b7b64d
Packit b7b64d
=back
Packit b7b64d
Packit b7b64d
=head1 COPYRIGHT AND LICENSE
Packit b7b64d
Packit b7b64d
This software is copyright (c) 2004 by Ken Williams, Leon Timmermans.
Packit b7b64d
Packit b7b64d
This is free software; you can redistribute it and/or modify it under
Packit b7b64d
the same terms as the Perl 5 programming language system itself.
Packit b7b64d
Packit b7b64d
=cut