NAME

File::PM2File - find the absolute file for a program module, loaded or unloaded

SYNOPSIS

 #######
 # Direct class interface
 #
 ($abs_file, $inc_path, $require) = File::PM2File->pm2file($pm);
 $abs_file                        = File::PM2File->pm2file($pm);

 ($abs_file, $inc_path)           = File::PM2File->find_in_include($file_relative, [\@path]);
 $abs_file                        = File::PM2File->find_in_include($file_relative, [\@path]);

 $file                            = File::PM2File->pm2require($pm);

 #########
 # class interface where the PM2FILE methods are inherited by another class
 #
 use vars (@ISA);    
 use File::PM2File;   
 @ISA = qw(File::PM2File);

 ($abs_file, $inc_path, $require) = __PACKAGE__->pm2file($pm);
 $abs_file                        = __PACKAGE__->pm2file($pm);

 ($abs_file, $inc_path)           = __PACKAGE__->find_in_include($file_relative, [\@path]);
 $abs_file                        = __PACKAGE__->find_in_include($file_relative, [\@path]);

 $file                            = __PACKAGE__->pm2require($pm);


 #######
 # Subroutine interface
 #  
 use File::PM2File qw(pm2file find_in_include pm2require);  

 ($abs_file, $inc_path, $require) = pm2file($pm);
 $abs_file                        = pm2file($pm);

 ($abs_file, $inc_path)           = find_in_include($file_relative, [\@path]);
 $abs_file                        = find_in_include($file_relative, [\@path]);

 $file                            = pm2require($pm);

From time to time, an program needs to know the abolute file for a program module that has not been loaded. The File::PM2File module provides methods to find this information. For loaded files, using the hash %INC may perform better than using the methods in this module.

METHODS/SUBROUTINES

find_in_include method/subroutine

($abs_file, $inc_path) = File::PM2File->find_in_include($file_relative, [\@path])

($abs_file, $inc_path) = find_in_include($file_relative, [\@path])

The find_in_include method/subroutine looks for the $file_relative in one of the directories in the the @path (@INC path if @path not supplied) in the order listed. The file $file_relative may include relative directories. When find_in_include finds the file, it returns the absolute file $file_absolute and the directory $path where it found $file_relative.

pm2file method/subroutine

($abs_file, $inc_path, $require_file) = File::PM2File->pm2file($pm)

($abs_file, $inc_path, $require_file) = pm2file($pm)

The pm2file method returns the absolute file, the directory in @INC, and the relative $require_file for a the program module $pm_file.

pm2require method/subroutine

$file = File::PM2File->pm2require($pm_file)

$file = pm2require($pm_file)

The pm2require method/subroutine returns the file suitable for use in a Perl require given the $pm file.

REQUIREMENTS

Coming soon.

DEMONSTRATION

~~~~~~ Demonstration overview ~~~~~

Perl code begins with the prompt

=>

The selected results from executing the Perl Code follow on the next lines. For example,

=> 2 + 2
4

~~~~~~ The demonstration follows ~~~~~

=>     use File::Spec;

=>     use File::Package;
=>     my $fp = 'File::Package';

=>     my $pm = 'File::PM2File';
=>     my $loaded = '';
=> my $errors = $fp->load_package( 'File::PM2File' )
=> $errors
''

=> $pm->pm2require( "$pm")
'File\PM2File.pm'

=>     #######
=>     # Use the test file as an example since no its absolue path
=>     #
=>     # Calculate the absolute file, relative file, and include directory
=>     #    
=>     my $relative_file = File::Spec->catfile('t', 'File', 'PM2File.pm'); 

=>     my $restore_dir = cwd();
=>     chdir File::Spec->updir();
=>     chdir File::Spec->updir();
=>     my $include_dir = cwd();
=>     chdir $restore_dir;
=>     if( $^O eq 'MSWin32') {
=>         $include_dir =~ s=/=\\=g;
=>     }

=>     my $absolute_file = File::Spec->catfile($include_dir, 't', 'File', 'PM2File.pm');
=>     $absolute_file =~ s=.t$=.pm=;

=>     ######
=>     # Put base directory as the first in the @INC path
=>     #
=>     my @restore_inc = @INC;
=>     unshift @INC, $include_dir;    

=>     ######
=>     # Use the method under Test to find the absolute file and include directory
=>     #
=>     my @actual =  $pm->find_in_include( $relative_file );

=>     @INC = @restore_inc;
=> [@actual]
[
          'E:\User\SoftwareDiamonds\installation\t\File\PM2File.pm',
          'E:\User\SoftwareDiamonds\installation'
        ]

=> @actual = $pm->pm2file( 't::File::PM2File' )
=> [@actual]
[
          'E:\User\SoftwareDiamonds\installation\t\File\PM2File.pm',
          'E:\User\SoftwareDiamonds\installation',
          't\File\PM2File.pm'
        ]

QUALITY ASSURANCE

Running the test script 'PM2File.t' found in the "File-PM2File-$VERSION.tar.gz" distribution file verifies the requirements for this module.

All testing software and documentation stems from the Software Test Description (STD) program module 't::File::PM2File', found in the distribution file "File-PM2File-$VERSION.tar.gz".

The 't::File::PM2File' STD POD contains a tracebility matix between the requirements established above for this module, and the test steps identified by a 'ok' number from running the 'PM2File.t' test script.

The t::File::PM2File' STD program module '__DATA__' section contains the data to perform the following:

• to generate the test script 'PM2File.t'

• generate the tailored STD POD in the 't::File::PM2File' module,

• generate the 'PM2File.d' demo script,

• replace the POD demonstration section herein with the demo script 'PM2File.d' output, and

• run the test script using Test::Harness with or without the verbose option,

To perform all the above, prepare and run the automation software as follows:

• Install "Test_STDmaker-$VERSION.tar.gz" from one of the respositories only if it has not been installed:

  • http://www.softwarediamonds/packages/

  • http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/

• manually place the script tmake.pl in "Test_STDmaker-$VERSION.tar.gz' in the site operating system executable path only if it is not in the executable path

• place the 't::File::PM2File' at the same level in the directory struture as the directory holding the 'File::PM2File' module

• execute the following in any directory:

  tmake -test_verbose -replace -run -pm=t::File::PM2File

NOTES

FILES

The installation of the "File-PM2File-$VERSION.tar.gz" distribution file installs the 'Docs::Site_SVD::File_PM2File' SVD program module.

The __DATA__ data section of the 'Docs::Site_SVD::File_PM2File' contains all the necessary data to generate the POD section of 'Docs::Site_SVD::File_PM2File' and the "File-PM2File-$VERSION.tar.gz" distribution file.

To make use of the 'Docs::Site_SVD::File_PM2File' SVD program module, perform the following:

• install "ExtUtils-SVDmaker-$VERSION.tar.gz" from one of the respositories only if it has not been installed:

  • http://www.softwarediamonds/packages/

  • http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/

• manually place the script vmake.pl in "ExtUtils-SVDmaker-$VERSION.tar.gz' in the site operating system executable path only if it is not in the executable path

• Make any appropriate changes to the __DATA__ section of the 'Docs::Site_SVD::File_PM2File' module. For example, any changes to 'File::PM2File' will impact the at least 'Changes' field.

• Execute the following:

  vmake readme_html all -pm=Docs::Site_SVD::File_PM2File

AUTHOR

The holder of the copyright and maintainer is

<support@SoftwareDiamonds.com>

COPYRIGHT NOTICE

Copyrighted (c) 2002 Software Diamonds

All Rights Reserved

BINDING REQUIREMENTS NOTICE

Binding requirements are indexed with the pharse 'shall[dd]' where dd is an unique number for each header section. This conforms to standard federal government practices, 490A ("3.2.3.6" in STD490A). In accordance with the License, Software Diamonds is not liable for any requirement, binding or otherwise.

LICENSE

Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

SOFTWARE DIAMONDS, http::www.softwarediamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.

cpanm File::PM2File

perl -MCPAN -e shell
install File::PM2File