doc/tools/find-templateInComments

   1 #!/usr/bin/perl -w
   2 use strict;
   3 use File::Find ();
   4
   5 # -----------------------------------------------------------------------------
   6 #
   7 # Script
   8 #     find-templateInComments
   9 #
  10 # Description
  11 #     Search for *.[CH] files with '<xxx>' tags within the first comment block
  12 #     These likely need to be quoted as '\<xxx\>' for Doxygen.
  13 #     - print filename and lineNumber
  14 #
  15 # -----------------------------------------------------------------------------
  16
  17 my $re_filespec = qr{^.+\.[CH]$};
  18
  19 # for the convenience of &wanted calls, including -eval statements:
  20 ## use vars qw( *name *dir *prune );
  21 ## *name   = *File::Find::name;
  22 ## *dir    = *File::Find::dir;
  23 ## *prune  = *File::Find::prune;
  24
  25 sub wanted {
  26     unless ( lstat($_) and -f _ and -r _ and not -l _ and /$re_filespec/ ) {
  27         return;
  28     }
  29
  30     local @ARGV = $_;
  31     while (<>) {
  32         if (m{^\s*/\*} ... m{\*/})
  33         {
  34             if (m{\<\s*\w+\s*\>}) {
  35                 print "$File::Find::name  line=$.\n";
  36             }
  37
  38             if (m{\*/}) {
  39                 last;
  40             }
  41         }
  42     }
  43
  44     close ARGV;
  45 }
  46
  47
  48 ## Traverse desired filesystems
  49 for my $dir (@ARGV) {
  50     no warnings 'File::Find';
  51     warn "(**) checking '$dir' ...\n";
  52     File::Find::find( { wanted => \&wanted }, $dir );
  53 }
  54