doc/tools/find-placeholderDescription

   1 #!/usr/bin/perl -w
   2 use strict;
   3 use File::Find ();
   4
   5 # -----------------------------------------------------------------------------
   6 #
   7 # Script
   8 #     find-placeholderDescription
   9 #
  10 # Description
  11 #     Search for *.[H] files with a Description that looks like it is
  12 #     a placeholder
  13 #     eg, Foam::className
  14 #
  15 #     - print filename '#' and the description
  16 #
  17 # -----------------------------------------------------------------------------
  18
  19 my $minLength   = 16;
  20 my $re_filespec = qr{^.+\.[H]$};
  21
  22 # for the convenience of &wanted calls, including -eval statements:
  23 ## use vars qw( *name *dir *prune );
  24 ## *name   = *File::Find::name;
  25 ## *dir    = *File::Find::dir;
  26 ## *prune  = *File::Find::prune;
  27
  28 sub wanted {
  29     unless ( lstat($_) and -f _ and -r _ and not -l _ and /$re_filespec/ ) {
  30         return;
  31     }
  32
  33     my ( $tag, $description );
  34
  35     local @ARGV = $_;
  36     while (<>) {
  37         my $name;
  38
  39         ## examine the class/typedef name
  40         if (/^(Class|Typedef)\s*$/) {
  41             $_ = <>;
  42             ($tag) = split;
  43         }
  44         if (/^Description\s*$/) {
  45             $_ = <>;
  46             ( $description = $_ ) =~ s{^\s+|\s+$}{}g;
  47
  48             # remove trailing punctuation as being noise
  49             $description =~ s{\s*[.,:]+$}{};
  50             last;
  51         }
  52     }
  53
  54     $description ||= '';
  55
  56     ## we have 'Class/Typedef' tag
  57     if ( defined $tag ) {
  58         # description looks like a class name
  59         if (
  60             $description =~ m{^\w+(::\w+)+$}
  61         ) {
  62             print "$File::Find::name   # $description\n";
  63         }
  64     }
  65 }
  66
  67 ## Traverse desired filesystems
  68 for my $dir (@ARGV) {
  69     no warnings 'File::Find';
  70     warn "(**) checking '$dir' ...\n";
  71     File::Find::find( { wanted => \&wanted }, $dir );
  72 }
  73