[perl5.git] / lib / Pod / Find.pm

#############################################################################  
# Pod/Find.pm -- finds files containing POD documentation
#
# Author: Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de>
# 
# Copyright (C) 1999-2000 by Marek Rouchal (and borrowing code
# from Nick Ing-Simmon's PodToHtml). All rights reserved.
# This file is part of "PodParser". Pod::Find is free software;
# you can redistribute it and/or modify it under the same terms
# as Perl itself.
#############################################################################

package Pod::Find;

use vars qw($VERSION);
$VERSION = 0.22;   ## Current version of this package
require  5.005;   ## requires this Perl version or later
use Carp;

#############################################################################

=head1 NAME

Pod::Find - find POD documents in directory trees

=head1 SYNOPSIS

  use Pod::Find qw(pod_find simplify_name);
  my %pods = pod_find({ -verbose => 1, -inc => 1 });
  foreach(keys %pods) {
     print "found library POD `$pods{$_}' in $_\n";
  }

  print "podname=",simplify_name('a/b/c/mymodule.pod'),"\n";

  $location = pod_where( { -inc => 1 }, "Pod::Find" );

=head1 DESCRIPTION

B<Pod::Find> provides a set of functions to locate POD files.  Note that
no function is exported by default to avoid pollution of your namespace,
so be sure to specify them in the B<use> statement if you need them:

  use Pod::Find qw(pod_find);

=cut

use strict;
#use diagnostics;
use Exporter;
use File::Spec;
use File::Find;
use Cwd;

use vars qw(@ISA @EXPORT_OK $VERSION);
@ISA = qw(Exporter);
@EXPORT_OK = qw(&pod_find &simplify_name &pod_where &contains_pod);

# package global variables
my $SIMPLIFY_RX;

=head2 C<pod_find( { %opts } , @directories )>

The function B<pod_find> searches for POD documents in a given set of
files and/or directories. It returns a hash with the file names as keys
and the POD name as value. The POD name is derived from the file name
and its position in the directory tree.

E.g. when searching in F<$HOME/perl5lib>, the file
F<$HOME/perl5lib/MyModule.pm> would get the POD name I<MyModule>,
whereas F<$HOME/perl5lib/Myclass/Subclass.pm> would be
I<Myclass::Subclass>. The name information can be used for POD
translators.

Only text files containing at least one valid POD command are found.

A warning is printed if more than one POD file with the same POD name
is found, e.g. F<CPAN.pm> in different directories. This usually
indicates duplicate occurrences of modules in the I<@INC> search path.

B<OPTIONS> The first argument for B<pod_find> may be a hash reference
with options. The rest are either directories that are searched
recursively or files.  The POD names of files are the plain basenames
with any Perl-like extension (.pm, .pl, .pod) stripped.

=over 4

=item C<-verbose =E<gt> 1>

Print progress information while scanning.

=item C<-perl =E<gt> 1>

Apply Perl-specific heuristics to find the correct PODs. This includes
stripping Perl-like extensions, omitting subdirectories that are numeric
but do I<not> match the current Perl interpreter's version id, suppressing
F<site_perl> as a module hierarchy name etc.

=item C<-script =E<gt> 1>

Search for PODs in the current Perl interpreter's installation 
B<scriptdir>. This is taken from the local L<Config|Config> module.

=item C<-inc =E<gt> 1>

Search for PODs in the current Perl interpreter's I<@INC> paths. This
automatically considers paths specified in the C<PERL5LIB> environment
as this is prepended to I<@INC> by the Perl interpreter itself.

=back

=cut

# return a hash of the POD files found
# first argument may be a hashref (options),
# rest is a list of directories to search recursively
sub pod_find
{
    my %opts;
    if(ref $_[0]) {
        %opts = %{shift()};
    }

    $opts{-verbose} ||= 0;
    $opts{-perl}    ||= 0;

    my (@search) = @_;

    if($opts{-script}) {
        require Config;
        push(@search, $Config::Config{scriptdir});
        $opts{-perl} = 1;
    }

    if($opts{-inc}) {
        push(@search, grep($_ ne '.',@INC));
        $opts{-perl} = 1;
    }

    if($opts{-perl}) {
        require Config;
        # this code simplifies the POD name for Perl modules:
        # * remove "site_perl"
        # * remove e.g. "i586-linux" (from 'archname')
        # * remove e.g. 5.00503
        # * remove pod/ if followed by *.pod (e.g. in pod/perlfunc.pod)
        $SIMPLIFY_RX =
          qq!^(?i:site(_perl)?/|\Q$Config::Config{archname}\E/|\\d+\\.\\d+([_.]?\\d+)?/|pod/(?=.*?\\.pod\\z))*!;

    }

    my %dirs_visited;
    my %pods;
    my %names;
    my $pwd = cwd();

    foreach my $try (@search) {
        unless(File::Spec->file_name_is_absolute($try)) {
            # make path absolute
            $try = File::Spec->catfile($pwd,$try);
        }
        # simplify path
        # on VMS canonpath will vmsify:[the.path], but File::Find::find
        # wants /unixy/paths
        $try = File::Spec->canonpath($try) if ($^O ne 'VMS');
        $try = VMS::Filespec::unixify($try) if ($^O eq 'VMS');
        my $name;
        if(-f $try) {
            if($name = _check_and_extract_name($try, $opts{-verbose})) {
                _check_for_duplicates($try, $name, \%names, \%pods);
            }
            next;
        }
        my $root_rx = qq!^\Q$try\E/!;
        File::Find::find( sub {
            my $item = $File::Find::name;
            if(-d) {
                if($dirs_visited{$item}) {
                    warn "Directory '$item' already seen, skipping.\n"
                        if($opts{-verbose});
                    $File::Find::prune = 1;
                    return;
                }
                else {
                    $dirs_visited{$item} = 1;
                }
                if($opts{-perl} && /^(\d+\.[\d_]+)\z/s && eval "$1" != $]) {
                    $File::Find::prune = 1;
                    warn "Perl $] version mismatch on $_, skipping.\n"
                        if($opts{-verbose});
                }
                return;
            }
            if($name = _check_and_extract_name($item, $opts{-verbose}, $root_rx)) {
                _check_for_duplicates($item, $name, \%names, \%pods);
            }
        }, $try); # end of File::Find::find
    }
    chdir $pwd;
    %pods;
}

sub _check_for_duplicates {
    my ($file, $name, $names_ref, $pods_ref) = @_;
    if($$names_ref{$name}) {
        warn "Duplicate POD found (shadowing?): $name ($file)\n";
        warn "    Already seen in ",
            join(' ', grep($$pods_ref{$_} eq $name, keys %$pods_ref)),"\n";
    }
    else {
        $$names_ref{$name} = 1;
    }
    $$pods_ref{$file} = $name;
}

sub _check_and_extract_name {
    my ($file, $verbose, $root_rx) = @_;

    # check extension or executable flag
    # this involves testing the .bat extension on Win32!
    unless(-f $file && -T _ && ($file =~ /\.(pod|pm|plx?)\z/i || -x _ )) {
      return undef;
    }

    return undef unless contains_pod($file,$verbose);

    # strip non-significant path components
    # TODO what happens on e.g. Win32?
    my $name = $file;
    if(defined $root_rx) {
        $name =~ s!$root_rx!!s;
        $name =~ s!$SIMPLIFY_RX!!os if(defined $SIMPLIFY_RX);
    }
    else {
        $name =~ s:^.*/::s;
    }
    _simplify($name);
    $name =~ s!/+!::!g; #/
    $name;
}

=head2 C<simplify_name( $str )>

The function B<simplify_name> is equivalent to B<basename>, but also
strips Perl-like extensions (.pm, .pl, .pod) and extensions like
F<.bat>, F<.cmd> on Win32 and OS/2, or F<.com> on VMS, respectively.

=cut

# basic simplification of the POD name:
# basename & strip extension
sub simplify_name {
    my ($str) = @_;
    # remove all path components
    $str =~ s:^.*/::s;
    _simplify($str);
    $str;
}

# internal sub only
sub _simplify {
    # strip Perl's own extensions
    $_[0] =~ s/\.(pod|pm|plx?)\z//i;
    # strip meaningless extensions on Win32 and OS/2
    $_[0] =~ s/\.(bat|exe|cmd)\z//i if($^O =~ /mswin|os2/i);
    # strip meaningless extensions on VMS
    $_[0] =~ s/\.(com)\z//i if($^O eq 'VMS');
}

# contribution from Tim Jenness <t.jenness@jach.hawaii.edu>

=head2 C<pod_where( { %opts }, $pod )>

Returns the location of a pod document given a search directory
and a module (e.g. C<File::Find>) or script (e.g. C<perldoc>) name.

Options:

=over 4

=item C<-inc =E<gt> 1>

Search @INC for the pod and also the C<scriptdir> defined in the
L<Config|Config> module.

=item C<-dirs =E<gt> [ $dir1, $dir2, ... ]>

Reference to an array of search directories. These are searched in order
before looking in C<@INC> (if B<-inc>). Current directory is used if
none are specified.

=item C<-verbose =E<gt> 1>

List directories as they are searched

=back

Returns the full path of the first occurence to the file.
Package names (eg 'A::B') are automatically converted to directory
names in the selected directory. (eg on unix 'A::B' is converted to
'A/B'). Additionally, '.pm', '.pl' and '.pod' are appended to the
search automatically if required.

A subdirectory F<pod/> is also checked if it exists in any of the given
search directories. This ensures that e.g. L<perlfunc|perlfunc> is
found.

It is assumed that if a module name is supplied, that that name
matches the file name. Pods are not opened to check for the 'NAME'
entry.

A check is made to make sure that the file that is found does 
contain some pod documentation.

=cut

sub pod_where {

  # default options
  my %options = (
         '-inc' => 0,
         '-verbose' => 0,
         '-dirs' => [ '.' ],
        );

  # Check for an options hash as first argument
  if (defined $_[0] && ref($_[0]) eq 'HASH') {
    my $opt = shift;

    # Merge default options with supplied options
    %options = (%options, %$opt);
  }

  # Check usage
  carp 'Usage: pod_where({options}, $pod)' unless (scalar(@_));

  # Read argument
  my $pod = shift;

  # Split on :: and then join the name together using File::Spec
  my @parts = split (/::/, $pod);

  # Get full directory list
  my @search_dirs = @{ $options{'-dirs'} };

  if ($options{'-inc'}) {

    require Config;

    # Add @INC
    push (@search_dirs, @INC) if $options{'-inc'};

    # Add location of pod documentation for perl man pages (eg perlfunc)
    # This is a pod directory in the private install tree
    #my $perlpoddir = File::Spec->catdir($Config::Config{'installprivlib'},
    #					'pod');
    #push (@search_dirs, $perlpoddir)
    #  if -d $perlpoddir;

    # Add location of binaries such as pod2text
    push (@search_dirs, $Config::Config{'scriptdir'})
      if -d $Config::Config{'scriptdir'};
  }

  # Loop over directories
  Dir: foreach my $dir ( @search_dirs ) {

    # Don't bother if cant find the directory
    if (-d $dir) {
      warn "Looking in directory $dir\n" 
        if $options{'-verbose'};

      # Now concatenate this directory with the pod we are searching for
      my $fullname = File::Spec->catfile($dir, @parts);
      warn "Filename is now $fullname\n"
        if $options{'-verbose'};

      # Loop over possible extensions
      foreach my $ext ('', '.pod', '.pm', '.pl') {
        my $fullext = $fullname . $ext;
        if (-f $fullext && 
         contains_pod($fullext, $options{'-verbose'}) ) {
          warn "FOUND: $fullext\n" if $options{'-verbose'};
          return $fullext;
        }
      }
    } else {
      warn "Directory $dir does not exist\n"
        if $options{'-verbose'};
      next Dir;
    }
    if(-d File::Spec->catdir($dir,'pod')) {
      $dir = File::Spec->catdir($dir,'pod');
      redo Dir;
    }
  }
  # No match;
  return undef;
}

=head2 C<contains_pod( $file , $verbose )>

Returns true if the supplied filename (not POD module) contains some pod
information.

=cut

sub contains_pod {
  my $file = shift;
  my $verbose = 0;
  $verbose = shift if @_;

  # check for one line of POD
  unless(open(POD,"<$file")) {
    warn "Error: $file is unreadable: $!\n";
    return undef;
  }
  
  local $/ = undef;
  my $pod = <POD>;
  close(POD) || die "Error closing $file: $!\n";
  unless($pod =~ /\n=(head\d|pod|over|item)\b/s) {
    warn "No POD in $file, skipping.\n"
      if($verbose);
    return 0;
  }

  return 1;
}

=head1 AUTHOR

Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>,
heavily borrowing code from Nick Ing-Simmons' PodToHtml.

Tim Jenness E<lt>t.jenness@jach.hawaii.eduE<gt> provided
C<pod_where> and C<contains_pod>.

=head1 SEE ALSO

L<Pod::Parser>, L<Pod::Checker>, L<perldoc>

=cut

1;
Commit	Line	Data
e2c3adef GS	1	#############################################################################
	2	# Pod/Find.pm -- finds files containing POD documentation
	3	#
	4	# Author: Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de>
	5	#
66aff6dd GS	6	# Copyright (C) 1999-2000 by Marek Rouchal (and borrowing code
66aff6dd GS	7	# from Nick Ing-Simmon's PodToHtml). All rights reserved.
e2c3adef GS	8	# This file is part of "PodParser". Pod::Find is free software;
	9	# you can redistribute it and/or modify it under the same terms
	10	# as Perl itself.
	11	#############################################################################
	12
	13	package Pod::Find;
	14
	15	use vars qw($VERSION);
88d01e8d	16	$VERSION = 0.22; ## Current version of this package
92e3d63a JH	17	require 5.005; ## requires this Perl version or later
92e3d63a JH	18	use Carp;
e2c3adef GS	19
	20	#############################################################################
	21
	22	=head1 NAME
	23
	24	Pod::Find - find POD documents in directory trees
	25
	26	=head1 SYNOPSIS
	27
	28	use Pod::Find qw(pod_find simplify_name);
	29	my %pods = pod_find({ -verbose => 1, -inc => 1 });
	30	foreach(keys %pods) {
	31	print "found library POD `$pods{$_}' in $_\n";
	32	}
	33
	34	print "podname=",simplify_name('a/b/c/mymodule.pod'),"\n";
	35
92e3d63a JH	36	$location = pod_where( { -inc => 1 }, "Pod::Find" );
92e3d63a JH	37
e2c3adef GS	38	=head1 DESCRIPTION
e2c3adef GS	39
92e3d63a JH	40	B<Pod::Find> provides a set of functions to locate POD files. Note that
	41	no function is exported by default to avoid pollution of your namespace,
	42	so be sure to specify them in the B<use> statement if you need them:
	43
	44	use Pod::Find qw(pod_find);
	45
	46	=cut
	47
	48	use strict;
	49	#use diagnostics;
	50	use Exporter;
	51	use File::Spec;
	52	use File::Find;
	53	use Cwd;
	54
	55	use vars qw(@ISA @EXPORT_OK $VERSION);
	56	@ISA = qw(Exporter);
	57	@EXPORT_OK = qw(&pod_find &simplify_name &pod_where &contains_pod);
	58
	59	# package global variables
	60	my $SIMPLIFY_RX;
	61
	62	=head2 C<pod_find( { %opts } , @directories )>
	63
	64	The function B<pod_find> searches for POD documents in a given set of
	65	files and/or directories. It returns a hash with the file names as keys
	66	and the POD name as value. The POD name is derived from the file name
	67	and its position in the directory tree.
e2c3adef GS	68
	69	E.g. when searching in F<$HOME/perl5lib>, the file
	70	F<$HOME/perl5lib/MyModule.pm> would get the POD name I<MyModule>,
	71	whereas F<$HOME/perl5lib/Myclass/Subclass.pm> would be
	72	I<Myclass::Subclass>. The name information can be used for POD
	73	translators.
	74
	75	Only text files containing at least one valid POD command are found.
	76
	77	A warning is printed if more than one POD file with the same POD name
	78	is found, e.g. F<CPAN.pm> in different directories. This usually
2773b013	79	indicates duplicate occurrences of modules in the I<@INC> search path.
e2c3adef	80
92e3d63a JH	81	B<OPTIONS> The first argument for B<pod_find> may be a hash reference
	82	with options. The rest are either directories that are searched
	83	recursively or files. The POD names of files are the plain basenames
	84	with any Perl-like extension (.pm, .pl, .pod) stripped.
e2c3adef GS	85
	86	=over 4
	87
92e3d63a	88	=item C<-verbose =E<gt> 1>
e2c3adef GS	89
	90	Print progress information while scanning.
	91
92e3d63a	92	=item C<-perl =E<gt> 1>
e2c3adef GS	93
	94	Apply Perl-specific heuristics to find the correct PODs. This includes
	95	stripping Perl-like extensions, omitting subdirectories that are numeric
	96	but do I<not> match the current Perl interpreter's version id, suppressing
	97	F<site_perl> as a module hierarchy name etc.
	98
92e3d63a	99	=item C<-script =E<gt> 1>
e2c3adef GS	100
	101	Search for PODs in the current Perl interpreter's installation
	102	B<scriptdir>. This is taken from the local L<Config\|Config> module.
	103
92e3d63a	104	=item C<-inc =E<gt> 1>
e2c3adef	105
2773b013	106	Search for PODs in the current Perl interpreter's I<@INC> paths. This
92e3d63a JH	107	automatically considers paths specified in the C<PERL5LIB> environment
92e3d63a JH	108	as this is prepended to I<@INC> by the Perl interpreter itself.
e2c3adef GS	109
	110	=back
	111
e2c3adef GS	112	=cut
e2c3adef GS	113
66aff6dd GS	114	# return a hash of the POD files found
	115	# first argument may be a hashref (options),
	116	# rest is a list of directories to search recursively
e2c3adef GS	117	sub pod_find
	118	{
	119	my %opts;
	120	if(ref $_[0]) {
	121	%opts = %{shift()};
	122	}
	123
	124	$opts{-verbose} \|\|= 0;
	125	$opts{-perl} \|\|= 0;
	126
	127	my (@search) = @_;
	128
	129	if($opts{-script}) {
	130	require Config;
	131	push(@search, $Config::Config{scriptdir});
	132	$opts{-perl} = 1;
	133	}
	134
	135	if($opts{-inc}) {
	136	push(@search, grep($_ ne '.',@INC));
	137	$opts{-perl} = 1;
	138	}
	139
	140	if($opts{-perl}) {
	141	require Config;
	142	# this code simplifies the POD name for Perl modules:
	143	# * remove "site_perl"
2773b013	144	# * remove e.g. "i586-linux" (from 'archname')
e2c3adef GS	145	# * remove e.g. 5.00503
	146	# * remove pod/ if followed by *.pod (e.g. in pod/perlfunc.pod)
	147	$SIMPLIFY_RX =
dbd1b0a2	148	qq!^(?i:site(_perl)?/\|\Q$Config::Config{archname}\E/\|\\d+\\.\\d+([_.]?\\d+)?/\|pod/(?=.?\\.pod\\z))!;
66aff6dd	149
e2c3adef GS	150	}
	151
	152	my %dirs_visited;
	153	my %pods;
	154	my %names;
	155	my $pwd = cwd();
	156
	157	foreach my $try (@search) {
2773b013 GS	158	unless(File::Spec->file_name_is_absolute($try)) {
	159	# make path absolute
	160	$try = File::Spec->catfile($pwd,$try);
	161	}
	162	# simplify path
16be52b8 PP	163	# on VMS canonpath will vmsify:[the.path], but File::Find::find
	164	# wants /unixy/paths
	165	$try = File::Spec->canonpath($try) if ($^O ne 'VMS');
c4974618	166	$try = VMS::Filespec::unixify($try) if ($^O eq 'VMS');
e2c3adef GS	167	my $name;
	168	if(-f $try) {
	169	if($name = _check_and_extract_name($try, $opts{-verbose})) {
	170	_check_for_duplicates($try, $name, \%names, \%pods);
	171	}
	172	next;
	173	}
2773b013	174	my $root_rx = qq!^\Q$try\E/!;
e2c3adef	175	File::Find::find( sub {
2773b013 GS	176	my $item = $File::Find::name;
	177	if(-d) {
	178	if($dirs_visited{$item}) {
	179	warn "Directory '$item' already seen, skipping.\n"
	180	if($opts{-verbose});
	181	$File::Find::prune = 1;
	182	return;
	183	}
	184	else {
	185	$dirs_visited{$item} = 1;
	186	}
	187	if($opts{-perl} && /^(\d+\.[\d_]+)\z/s && eval "$1" != $]) {
e2c3adef GS	188	$File::Find::prune = 1;
e2c3adef GS	189	warn "Perl $] version mismatch on $_, skipping.\n"
2773b013 GS	190	if($opts{-verbose});
	191	}
	192	return;
	193	}
e2c3adef GS	194	if($name = _check_and_extract_name($item, $opts{-verbose}, $root_rx)) {
	195	_check_for_duplicates($item, $name, \%names, \%pods);
	196	}
2773b013	197	}, $try); # end of File::Find::find
e2c3adef GS	198	}
	199	chdir $pwd;
	200	%pods;
	201	}
	202
	203	sub _check_for_duplicates {
	204	my ($file, $name, $names_ref, $pods_ref) = @_;
	205	if($$names_ref{$name}) {
	206	warn "Duplicate POD found (shadowing?): $name ($file)\n";
2773b013 GS	207	warn " Already seen in ",
2773b013 GS	208	join(' ', grep($$pods_ref{$_} eq $name, keys %$pods_ref)),"\n";
e2c3adef GS	209	}
	210	else {
	211	$$names_ref{$name} = 1;
	212	}
	213	$$pods_ref{$file} = $name;
	214	}
	215
	216	sub _check_and_extract_name {
	217	my ($file, $verbose, $root_rx) = @_;
	218
2773b013 GS	219	# check extension or executable flag
2773b013 GS	220	# this involves testing the .bat extension on Win32!
92e3d63a JH	221	unless(-f $file && -T _ && ($file =~ /\.(pod\|pm\|plx?)\z/i \|\| -x _ )) {
92e3d63a JH	222	return undef;
e2c3adef GS	223	}
e2c3adef GS	224
92e3d63a	225	return undef unless contains_pod($file,$verbose);
e2c3adef GS	226
e2c3adef GS	227	# strip non-significant path components
92e3d63a	228	# TODO what happens on e.g. Win32?
e2c3adef GS	229	my $name = $file;
e2c3adef GS	230	if(defined $root_rx) {
fe6f1558 GS	231	$name =~ s!$root_rx!!s;
fe6f1558 GS	232	$name =~ s!$SIMPLIFY_RX!!os if(defined $SIMPLIFY_RX);
e2c3adef GS	233	}
e2c3adef GS	234	else {
fe6f1558	235	$name =~ s:^.*/::s;
e2c3adef	236	}
2773b013 GS	237	_simplify($name);
2773b013 GS	238	$name =~ s!/+!::!g; #/
e2c3adef GS	239	$name;
	240	}
	241
92e3d63a JH	242	=head2 C<simplify_name( $str )>
	243
	244	The function B<simplify_name> is equivalent to B<basename>, but also
	245	strips Perl-like extensions (.pm, .pl, .pod) and extensions like
2eec1a1e	246	F<.bat>, F<.cmd> on Win32 and OS/2, or F<.com> on VMS, respectively.
92e3d63a JH	247
	248	=cut
	249
e2c3adef GS	250	# basic simplification of the POD name:
	251	# basename & strip extension
	252	sub simplify_name {
	253	my ($str) = @_;
2773b013	254	# remove all path components
fe6f1558	255	$str =~ s:^.*/::s;
2773b013	256	_simplify($str);
e2c3adef GS	257	$str;
	258	}
	259
2773b013 GS	260	# internal sub only
	261	sub _simplify {
	262	# strip Perl's own extensions
	263	$_[0] =~ s/\.(pod\|pm\|plx?)\z//i;
	264	# strip meaningless extensions on Win32 and OS/2
dbd1b0a2	265	$_[0] =~ s/\.(bat\|exe\|cmd)\z//i if($^O =~ /mswin\|os2/i);
2eec1a1e PP	266	# strip meaningless extensions on VMS
2eec1a1e PP	267	$_[0] =~ s/\.(com)\z//i if($^O eq 'VMS');
2773b013 GS	268	}
2773b013 GS	269
92e3d63a JH	270	# contribution from Tim Jenness <t.jenness@jach.hawaii.edu>
	271
	272	=head2 C<pod_where( { %opts }, $pod )>
	273
	274	Returns the location of a pod document given a search directory
	275	and a module (e.g. C<File::Find>) or script (e.g. C<perldoc>) name.
	276
	277	Options:
	278
	279	=over 4
	280
	281	=item C<-inc =E<gt> 1>
	282
	283	Search @INC for the pod and also the C<scriptdir> defined in the
	284	L<Config\|Config> module.
	285
	286	=item C<-dirs =E<gt> [ $dir1, $dir2, ... ]>
	287
	288	Reference to an array of search directories. These are searched in order
	289	before looking in C<@INC> (if B<-inc>). Current directory is used if
	290	none are specified.
	291
	292	=item C<-verbose =E<gt> 1>
	293
	294	List directories as they are searched
	295
	296	=back
	297
	298	Returns the full path of the first occurence to the file.
	299	Package names (eg 'A::B') are automatically converted to directory
	300	names in the selected directory. (eg on unix 'A::B' is converted to
	301	'A/B'). Additionally, '.pm', '.pl' and '.pod' are appended to the
	302	search automatically if required.
	303
	304	A subdirectory F<pod/> is also checked if it exists in any of the given
	305	search directories. This ensures that e.g. L<perlfunc\|perlfunc> is
	306	found.
	307
	308	It is assumed that if a module name is supplied, that that name
	309	matches the file name. Pods are not opened to check for the 'NAME'
	310	entry.
	311
	312	A check is made to make sure that the file that is found does
	313	contain some pod documentation.
	314
	315	=cut
	316
	317	sub pod_where {
	318
	319	# default options
	320	my %options = (
	321	'-inc' => 0,
	322	'-verbose' => 0,
	323	'-dirs' => [ '.' ],
	324	);
	325
	326	# Check for an options hash as first argument
	327	if (defined $_[0] && ref($_[0]) eq 'HASH') {
	328	my $opt = shift;
	329
	330	# Merge default options with supplied options
	331	%options = (%options, %$opt);
	332	}
	333
334	# Check usage
335	carp 'Usage: pod_where({options}, $pod)' unless (scalar(@_));
336
337	# Read argument
338	my $pod = shift;
339
340	# Split on :: and then join the name together using File::Spec
341	my @parts = split (/::/, $pod);
342
343	# Get full directory list
344	my @search_dirs = @{ $options{'-dirs'} };
345
346	if ($options{'-inc'}) {
347
348	require Config;
349
350	# Add @INC
351	push (@search_dirs, @INC) if $options{'-inc'};
352
353	# Add location of pod documentation for perl man pages (eg perlfunc)
354	# This is a pod directory in the private install tree
355	#my $perlpoddir = File::Spec->catdir($Config::Config{'installprivlib'},
356	# 'pod');
357	#push (@search_dirs, $perlpoddir)
358	# if -d $perlpoddir;
359
360	# Add location of binaries such as pod2text
361	push (@search_dirs, $Config::Config{'scriptdir'})
362	if -d $Config::Config{'scriptdir'};
363	}
364
365	# Loop over directories
366	Dir: foreach my $dir ( @search_dirs ) {
367
368	# Don't bother if cant find the directory
369	if (-d $dir) {
370	warn "Looking in directory $dir\n"
371	if $options{'-verbose'};
372
373	# Now concatenate this directory with the pod we are searching for
374	my $fullname = File::Spec->catfile($dir, @parts);
375	warn "Filename is now $fullname\n"
376	if $options{'-verbose'};
377
378	# Loop over possible extensions
379	foreach my $ext ('', '.pod', '.pm', '.pl') {
380	my $fullext = $fullname . $ext;
381	if (-f $fullext &&
382	contains_pod($fullext, $options{'-verbose'}) ) {
383	warn "FOUND: $fullext\n" if $options{'-verbose'};
384	return $fullext;
385	}
386	}
387	} else {
388	warn "Directory $dir does not exist\n"
389	if $options{'-verbose'};
390	next Dir;
391	}
392	if(-d File::Spec->catdir($dir,'pod')) {
393	$dir = File::Spec->catdir($dir,'pod');
394	redo Dir;
395	}
396	}
397	# No match;
398	return undef;
399	}
400
401	=head2 C<contains_pod( $file , $verbose )>
402
403	Returns true if the supplied filename (not POD module) contains some pod
404	information.
405
406	=cut
407
408	sub contains_pod {
409	my $file = shift;
410	my $verbose = 0;
411	$verbose = shift if @_;
412
413	# check for one line of POD
414	unless(open(POD,"<$file")) {
415	warn "Error: $file is unreadable: $!\n";
416	return undef;
417	}
418
419	local $/ = undef;
420	my $pod = <POD>;
421	close(POD) \|\| die "Error closing $file: $!\n";
422	unless($pod =~ /\n=(head\d\|pod\|over\|item)\b/s) {
423	warn "No POD in $file, skipping.\n"
424	if($verbose);
425	return 0;
426	}
427
428	return 1;
429	}
430
431	=head1 AUTHOR
432
433	Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>,
434	heavily borrowing code from Nick Ing-Simmons' PodToHtml.
435
436	Tim Jenness E<lt>t.jenness@jach.hawaii.eduE<gt> provided
437	C<pod_where> and C<contains_pod>.
438
439	=head1 SEE ALSO
440
441	L<Pod::Parser>, L<Pod::Checker>, L<perldoc>
442
443	=cut
444
e2c3adef GS	445	1;
e2c3adef GS	446