File Coverage

blib/lib/File/Vctools.pm

Criterion	Covered	Total	%
statement	14	14	100.0
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod	0	2	0.0
total	20	22	90.9

package File::Vctools;

use strict;
use warnings;
use 5.010;

use File::Spec;

require Exporter;

our @ISA         = qw(Exporter);
our %EXPORT_TAGS = ( all => [ qw(get_difftool get_mpath) ] );
our @EXPORT_OK   = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT      = qw();
our $VERSION     = '0.09';

# =============================================================================================
# This module is basically empty, its main purpose in life is to assemble all the different
# Vctool programs ('vc_status.pl', 'vc_checkout.pl', 'vc_apply.pl', etc...) all together
# in a nice CPAN-enabled package.
#
# But in addition to assembling the different Vctool programs, this file also...
#   - holds the actual version number of File::Vctools (our $VERSION)
#   - sets the minimum perl version to 5.10
#   - contains the POD documentation (in English) -- although there also exist documentations
#     in French (see 'Vctools_fr.pod') and in German (see 'Vctools_de.pod')
#   - exports two utility functions: 'get_difftool()' and 'get_mpath()'
# =============================================================================================

# probe 'diffnew.pl' in @INC and store the resulting full-path name in $difftool

my $difftool;

for (@INC) {
    my @dirs = File::Spec->splitdir($_);
    my $probetool = File::Spec->catdir(@dirs, 'Algorithm', 'diffnew.pl');

    if (-f $probetool) {
        $difftool = $probetool;
        last;
    }
}

# probe 'vc_status.pl' in @INC and store the directory in $mpath

my $mpath;

for (@INC) {
    my @dirs = File::Spec->splitdir($_);

    if (@dirs > 1 and $dirs[-1] eq 'lib') {
        my $probe = 'vc_status.pl';
        my $path_script = File::Spec->catdir(@dirs[0..$#dirs - 1], 'script');
        my $path_bin    = File::Spec->catdir(@dirs[0..$#dirs - 1], 'bin');

        if (-f File::Spec->catdir($path_script, $probe)) {
            $mpath = $path_script;
            last;
        }

        if (-f File::Spec->catdir($path_bin,    $probe)) {
            $mpath = $path_bin;
            last;
        }
    }
}

sub get_difftool { $difftool; }
sub get_mpath    { $mpath;    }

1;

__END__