t/codingstd/c_returns.t

   1 #! perl
   2 # Copyright (C) 2006-2009, Parrot Foundation.
   3 # $Id$
   4
   5 use strict;
   6 use warnings;
   7
   8 use lib qw( . lib ../lib ../../lib );
   9 use Test::More tests => 1;
  10 use Parrot::Distribution;
  11
  12 =head1 NAME
  13
  14 t/codingstd/c_returns.t - checks for possible use of C<return (foo);> from functions
  15
  16 =head1 SYNOPSIS
  17
  18     # test all files
  19     % prove t/codingstd/c_returns.t
  20
  21     # test specific files
  22     % perl t/codingstd/c_returns.t src/foo.c include/parrot/bar.h
  23
  24 =head1 DESCRIPTION
  25
  26 Checks that all C language source files return using C<return foo;> rather
  27 than C<return (foo);>
  28
  29 =head1 NOTES
  30
  31 This test was hacked from the C<check_returns> sub in
  32 C<tools/dev/check_source_standards.pl>, which is no longer part of the Parrot
  33 distribution.
  34
  35 =head1 SEE ALSO
  36
  37 L<docs/pdds/pdd07_codingstd.pod>
  38
  39 =cut
  40
  41 my $DIST = Parrot::Distribution->new;
  42 my @files = @ARGV ? <@ARGV> : $DIST->get_c_language_files();
  43 my @paren_return;
  44
  45 foreach my $file (@files) {
  46     my $path;
  47
  48     ## get the full path of the file
  49     # if we have command line arguments, the file is the full path
  50     if (@ARGV) {
  51         $path = $file;
  52     }
  53
  54     # otherwise, use the relevant Parrot:: path method
  55     else {
  56         $path = $file->path;
  57     }
  58
  59     my $buf = $DIST->slurp($path);
  60
  61     # look for instances of return(
  62     push @paren_return => "$path\n"
  63         if ( $buf =~ m/[^_.]return\(/ );
  64 }
  65
  66 ok( !scalar(@paren_return), 'Correctly formed return statement' )
  67     or diag( "Possible use of C<return(foo);> rather than C<return foo;> in "
  68         . scalar @paren_return
  69         . " files:\n@paren_return" );
  70
  71 # Local Variables:
  72 #   mode: cperl
  73 #   cperl-indent-level: 4
  74 #   fill-column: 100
  75 # End:
  76 # vim: expandtab shiftwidth=4: