Fix MM doc's use of "SUPER::"
[p5sagit/p5-mst-13.2.git] / lib / File / Find.pm
index c7b0051..1faea50 100644 (file)
@@ -2,46 +2,81 @@ package File::Find;
 require 5.000;
 require Exporter;
 use Config;
-use Cwd;
-use File::Basename;
+require Cwd;
+require File::Basename;
+
+
+=head1 NAME
+
+find - traverse a file tree
+
+finddepth - traverse a directory structure depth-first
+
+=head1 SYNOPSIS
+
+    use File::Find;
+    find(\&wanted, '/foo','/bar');
+    sub wanted { ... }
+    
+    use File::Find;
+    finddepth(\&wanted, '/foo','/bar');
+    sub wanted { ... }
+
+=head1 DESCRIPTION
+
+The wanted() function does whatever verifications you want.
+$File::Find::dir contains the current directory name, and $_ the
+current filename within that directory.  $File::Find::name contains
+C<"$File::Find::dir/$_">.  You are chdir()'d to $File::Find::dir when
+the function is called.  The function may set $File::Find::prune to
+prune the tree.
+
+File::Find assumes that you don't alter the $_ variable.  If you do then
+make sure you return it to its original value before exiting your function.
+
+This library is primarily for the C<find2perl> tool, which when fed, 
+
+    find2perl / -name .nfs\* -mtime +7 \
+       -exec rm -f {} \; -o -fstype nfs -prune
+
+produces something like:
+
+    sub wanted {
+        /^\.nfs.*$/ &&
+        (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
+        int(-M _) > 7 &&
+        unlink($_)
+        ||
+        ($nlink || (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_))) &&
+        $dev < 0 &&
+        ($File::Find::prune = 1);
+    }
+
+Set the variable $File::Find::dont_use_nlink if you're using AFS,
+since AFS cheats.
+
+C<finddepth> is just like C<find>, except that it does a depth-first
+search.
+
+Here's another interesting wanted function.  It will find all symlinks
+that don't resolve:
+
+    sub wanted {
+       -l && !-e && print "bogus link: $File::Find::name\n";
+    } 
+
+=cut
 
 @ISA = qw(Exporter);
-@EXPORT = qw(find finddepth $name $dir);
-
-# Usage:
-#      use File::Find;
-#
-#      find(\&wanted, '/foo','/bar');
-#
-#      sub wanted { ... }
-#              where wanted does whatever you want.  $dir contains the
-#              current directory name, and $_ the current filename within
-#              that directory.  $name contains "$dir/$_".  You are cd'ed
-#              to $dir when the function is called.  The function may
-#              set $prune to prune the tree.
-#
-# This library is primarily for find2perl, which, when fed
-#
-#   find2perl / -name .nfs\* -mtime +7 -exec rm -f {} \; -o -fstype nfs -prune
-#
-# spits out something like this
-#
-#      sub wanted {
-#          /^\.nfs.*$/ &&
-#          (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
-#          int(-M _) > 7 &&
-#          unlink($_)
-#          ||
-#          ($nlink || (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_))) &&
-#          $dev < 0 &&
-#          ($prune = 1);
-#      }
-#
-# Set the variable $dont_use_nlink if you're using AFS, since AFS cheats.
+@EXPORT = qw(find finddepth);
+
 
 sub find {
     my $wanted = shift;
-    my $cwd = fastcwd();
+    my $cwd = Cwd::cwd();
+    # Localize these rather than lexicalizing them for backwards
+    # compatibility.
+    local($topdir,$topdev,$topino,$topmode,$topnlink);
     foreach $topdir (@_) {
        (($topdev,$topino,$topmode,$topnlink) = stat($topdir))
          || (warn("Can't stat $topdir: $!\n"), next);
@@ -50,8 +85,10 @@ sub find {
                ($dir,$_) = ($topdir,'.');
                $name = $topdir;
                &$wanted;
-               ($fixtopdir = $topdir) =~ s,/$,, ;
-               $fixtopdir =~ s/\.dir$// if $Is_VMS; ;
+               my $fixtopdir = $topdir;
+               $fixtopdir =~ s,/$,, ;
+               $fixtopdir =~ s/\.dir$// if $Is_VMS;
+               $fixtopdir =~ s/\\dir$// if $Is_NT;
                &finddir($wanted,$fixtopdir,$topnlink);
            }
            else {
@@ -59,7 +96,7 @@ sub find {
            }
        }
        else {
-           unless (($dir,$_) = fileparse($topdir)) {
+           unless (($_,$dir) = File::Basename::fileparse($topdir)) {
                ($dir,$_) = ('.', $topdir);
            }
            $name = $topdir;
@@ -70,14 +107,15 @@ sub find {
 }
 
 sub finddir {
-    local($wanted,$dir,$nlink) = @_;
-    local($dev,$ino,$mode,$subcount);
-    local($name);
+    my($wanted, $nlink);
+    local($dir, $name);
+    ($wanted, $dir, $nlink) = @_;
 
-    # Get the list of files in the current directory.
+    my($dev, $ino, $mode, $subcount);
 
+    # Get the list of files in the current directory.
     opendir(DIR,'.') || (warn "Can't open $dir: $!\n", return);
-    local(@filenames) = readdir(DIR);
+    my(@filenames) = readdir(DIR);
     closedir(DIR);
 
     if ($nlink == 2 && !$dont_use_nlink) {  # This dir has no subdirectories.
@@ -101,8 +139,8 @@ sub finddir {
 
                # Get link count and check for directoriness.
 
-               ($dev,$ino,$mode,$nlink) = ($Is_VMS ? stat($_) : lstat($_))
-                   unless ($nlink || $dont_use_nlink);
+               ($dev,$ino,$mode,$nlink) = ($Is_VMS ? stat($_) : lstat($_));
+                   # unless ($nlink || $dont_use_nlink);
                
                if (-d _) {
 
@@ -110,6 +148,7 @@ sub finddir {
 
                    if (!$prune && chdir $_) {
                        $name =~ s/\.dir$// if $Is_VMS;
+                       $name =~ s/\\dir$// if $Is_NT;
                        &finddir($wanted,$name,$nlink);
                        chdir '..';
                    }
@@ -120,45 +159,24 @@ sub finddir {
     }
 }
 
-# Usage:
-#      use File::Find;
-#
-#      finddepth(\&wanted, '/foo','/bar');
-#
-#      sub wanted { ... }
-#              where wanted does whatever you want.  $dir contains the
-#              current directory name, and $_ the current filename within
-#              that directory.  $name contains "$dir/$_".  You are cd'ed
-#              to $dir when the function is called.  The function may
-#              set $prune to prune the tree.
-#
-# This library is primarily for find2perl, which, when fed
-#
-#   find2perl / -name .nfs\* -mtime +7 -exec rm -f {} \; -o -fstype nfs -prune
-#
-# spits out something like this
-#
-#      sub wanted {
-#          /^\.nfs.*$/ &&
-#          (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
-#          int(-M _) > 7 &&
-#          unlink($_)
-#          ||
-#          ($nlink || (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_))) &&
-#          $dev < 0 &&
-#          ($prune = 1);
-#      }
 
 sub finddepth {
     my $wanted = shift;
-    $cwd = fastcwd();;
+
+    $cwd = Cwd::fastcwd();;
+
+    # Localize these rather than lexicalizing them for backwards
+    # compatibility.
+    local($topdir, $topdev, $topino, $topmode, $topnlink);
     foreach $topdir (@_) {
        (($topdev,$topino,$topmode,$topnlink) = stat($topdir))
          || (warn("Can't stat $topdir: $!\n"), next);
        if (-d _) {
            if (chdir($topdir)) {
-               ($fixtopdir = $topdir) =~ s,/$,, ;
+               my $fixtopdir = $topdir;
+               $fixtopdir =~ s,/$,, ;
                $fixtopdir =~ s/\.dir$// if $Is_VMS;
+               $fixtopdir =~ s/\\dir$// if $Is_NT;
                &finddepthdir($wanted,$fixtopdir,$topnlink);
                ($dir,$_) = ($fixtopdir,'.');
                $name = $fixtopdir;
@@ -169,7 +187,7 @@ sub finddepth {
            }
        }
        else {
-           unless (($dir,$_) = fileparse($topdir)) {
+           unless (($_,$dir) = File::Basename::fileparse($topdir)) {
                ($dir,$_) = ('.', $topdir);
            }
            chdir $dir && &$wanted;
@@ -179,12 +197,12 @@ sub finddepth {
 }
 
 sub finddepthdir {
-    my($wanted,$dir,$nlink) = @_;
-    my($dev,$ino,$mode,$subcount);
-    my($name);
+    my($wanted, $nlink);
+    local($dir, $name);
+    ($wanted,$dir,$nlink) = @_;
+    my($dev, $ino, $mode, $subcount);
 
     # Get the list of files in the current directory.
-
     opendir(DIR,'.') || warn "Can't open $dir: $!\n";
     my(@filenames) = readdir(DIR);
     closedir(DIR);
@@ -203,7 +221,7 @@ sub finddepthdir {
        for (@filenames) {
            next if $_ eq '.';
            next if $_ eq '..';
-           $nlink = $prune = 0;
+           $nlink = 0;
            $name = "$dir/$_";
            if ($subcount > 0 || $dont_use_nlink) {    # Seen all the subdirs?
 
@@ -215,8 +233,9 @@ sub finddepthdir {
 
                    # It really is a directory, so do it recursively.
 
-                   if (!$prune && chdir $_) {
+                   if (chdir $_) {
                        $name =~ s/\.dir$// if $Is_VMS;
+                       $name =~ s/\\dir$// if $Is_NT;
                        &finddepthdir($wanted,$name,$nlink);
                        chdir '..';
                    }
@@ -228,10 +247,24 @@ sub finddepthdir {
     }
 }
 
-if ($Config{'osname'} eq 'VMS') {
+# Set dont_use_nlink in your hint file if your system's stat doesn't
+# report the number of links in a directory as an indication
+# of the number of files.
+# See, e.g. hints/machten.sh for MachTen 2.2.
+$dont_use_nlink = 1 if ($Config::Config{'dont_use_nlink'});
+
+# These are hard-coded for now, but may move to hint files.
+if ($^O eq 'VMS') {
   $Is_VMS = 1;
   $dont_use_nlink = 1;
 }
+if ($^O =~ m:^mswin32:i) {
+  $Is_NT = 1;
+  $dont_use_nlink = 1;
+}
+
+$dont_use_nlink = 1
+    if $^O eq 'os2' || $^O eq 'msdos' || $^O eq 'amigaos';
 
 1;