.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "CPANPLUS::Internals::Utils 3"
.TH CPANPLUS::Internals::Utils 3 2023-07-25 "perl v5.38.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
CPANPLUS::Internals::Utils \- convenience functions for CPANPLUS
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    my $bool = $cb\->_mkdir( dir => \*(Aqblah\*(Aq );
\&    my $bool = $cb\->_chdir( dir => \*(Aqblah\*(Aq );
\&    my $bool = $cb\->_rmdir( dir => \*(Aqblah\*(Aq );
\&
\&    my $bool = $cb\->_move( from => \*(Aq/some/file\*(Aq, to => \*(Aq/other/file\*(Aq );
\&    my $bool = $cb\->_move( from => \*(Aq/some/dir\*(Aq,  to => \*(Aq/other/dir\*(Aq );
\&
\&    my $cont = $cb\->_get_file_contents( file => \*(Aq/path/to/file\*(Aq );
\&
\&
\&    my $version = $cb\->_perl_version( perl => $^X );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`CPANPLUS::Internals::Utils\*(C'\fR holds a few convenience functions for
CPANPLUS libraries.
.SH METHODS
.IX Header "METHODS"
.ie n .SS "$cb\->_mkdir( dir => '/some/dir' )"
.el .SS "\f(CW$cb\fP\->_mkdir( dir => '/some/dir' )"
.IX Subsection "$cb->_mkdir( dir => '/some/dir' )"
\&\f(CW\*(C`_mkdir\*(C'\fR creates a full path to a directory.
.PP
Returns true on success, false on failure.
.ie n .SS "$cb\->_chdir( dir => '/some/dir' )"
.el .SS "\f(CW$cb\fP\->_chdir( dir => '/some/dir' )"
.IX Subsection "$cb->_chdir( dir => '/some/dir' )"
\&\f(CW\*(C`_chdir\*(C'\fR changes directory to a dir.
.PP
Returns true on success, false on failure.
.ie n .SS "$cb\->_rmdir( dir => '/some/dir' );"
.el .SS "\f(CW$cb\fP\->_rmdir( dir => '/some/dir' );"
.IX Subsection "$cb->_rmdir( dir => '/some/dir' );"
Removes a directory completely, even if it is non-empty.
.PP
Returns true on success, false on failure.
.ie n .SS "$cb\->_perl_version ( perl => 'some/perl/binary' );"
.el .SS "\f(CW$cb\fP\->_perl_version ( perl => 'some/perl/binary' );"
.IX Subsection "$cb->_perl_version ( perl => 'some/perl/binary' );"
\&\f(CW\*(C`_perl_version\*(C'\fR returns the version of a certain perl binary.
It does this by actually running a command.
.PP
Returns the perl version on success and false on failure.
.ie n .SS "$cb\->_version_to_number( version => $version );"
.el .SS "\f(CW$cb\fP\->_version_to_number( version => \f(CW$version\fP );"
.IX Subsection "$cb->_version_to_number( version => $version );"
Returns a proper module version, or '0.0' if none was available.
.ie n .SS $cb\->_whoami
.el .SS \f(CW$cb\fP\->_whoami
.IX Subsection "$cb->_whoami"
Returns the name of the subroutine you're currently in.
.ie n .SS "_get_file_contents( file => $file );"
.el .SS "_get_file_contents( file => \f(CW$file\fP );"
.IX Subsection "_get_file_contents( file => $file );"
Returns the contents of a file
.ie n .SS "$cb\->_move( from => $file|$dir, to => $target );"
.el .SS "\f(CW$cb\fP\->_move( from => \f(CW$file\fP|$dir, to => \f(CW$target\fP );"
.IX Subsection "$cb->_move( from => $file|$dir, to => $target );"
Moves a file or directory to the target.
.PP
Returns true on success, false on failure.
.ie n .SS "$cb\->_copy( from => $file|$dir, to => $target );"
.el .SS "\f(CW$cb\fP\->_copy( from => \f(CW$file\fP|$dir, to => \f(CW$target\fP );"
.IX Subsection "$cb->_copy( from => $file|$dir, to => $target );"
Moves a file or directory to the target.
.PP
Returns true on success, false on failure.
.ie n .SS "$cb\->_mode_plus_w( file => '/path/to/file' );"
.el .SS "\f(CW$cb\fP\->_mode_plus_w( file => '/path/to/file' );"
.IX Subsection "$cb->_mode_plus_w( file => '/path/to/file' );"
Sets the +w bit for the file.
.PP
Returns true on success, false on failure.
.ie n .SS "$uri = $cb\->_host_to_uri( scheme => SCHEME, host => HOST, path => PATH );"
.el .SS "\f(CW$uri\fP = \f(CW$cb\fP\->_host_to_uri( scheme => SCHEME, host => HOST, path => PATH );"
.IX Subsection "$uri = $cb->_host_to_uri( scheme => SCHEME, host => HOST, path => PATH );"
Turns a CPANPLUS::Config style \f(CW\*(C`host\*(C'\fR entry into an URI string.
.PP
Returns the uri on success, and false on failure
.ie n .SS "$cb\->_vcmp( VERSION, VERSION );"
.el .SS "\f(CW$cb\fP\->_vcmp( VERSION, VERSION );"
.IX Subsection "$cb->_vcmp( VERSION, VERSION );"
Normalizes the versions passed and does a '<=>' on them, returning the result.
.ie n .SS $cb\->_home_dir
.el .SS \f(CW$cb\fP\->_home_dir
.IX Subsection "$cb->_home_dir"
Returns the user's homedir, or \f(CW\*(C`cwd\*(C'\fR if it could not be found
.ie n .SS "$path = $cb\->_safe_path( path => $path );"
.el .SS "\f(CW$path\fP = \f(CW$cb\fP\->_safe_path( path => \f(CW$path\fP );"
.IX Subsection "$path = $cb->_safe_path( path => $path );"
Returns a path that's safe to us on Win32 and VMS.
.PP
Only cleans up the path on Win32 if the path exists.
.PP
On VMS, it encodes dots to _ using \f(CW\*(C`VMS::Filespec::vmsify\*(C'\fR
.ie n .SS "($pkg, $version, $ext) = $cb\->_split_package_string( package => PACKAGE_STRING );"
.el .SS "($pkg, \f(CW$version\fP, \f(CW$ext\fP) = \f(CW$cb\fP\->_split_package_string( package => PACKAGE_STRING );"
.IX Subsection "($pkg, $version, $ext) = $cb->_split_package_string( package => PACKAGE_STRING );"
Splits the name of a CPAN package string up into its package, version
and extension parts.
.PP
For example, \f(CW\*(C`Foo\-Bar\-1.2.tar.gz\*(C'\fR would return the following parts:
.PP
.Vb 3
\&    Package:    Foo\-Bar
\&    Version:    1.2
\&    Extension:  tar.gz
.Ve