t/codingstd/c_struct.t

   1 #! perl
   2 # Copyright (C) 2006-2009, Parrot Foundation.
   3 # $Id$
   4
   5 use strict;
   6 use warnings;
   7 use lib qw( . lib ../lib ../../lib );
   8 use Test::More tests => 1;
   9 use Parrot::Distribution;
  10
  11 =head1 NAME
  12
  13 t/codingstd/c_struct.t - checks for struct tags in C source and headers
  14
  15 =head1 SYNOPSIS
  16
  17     # test all files
  18     % prove t/codingstd/c_struct.t
  19
  20     # test specific files
  21     % perl t/codingstd/c_struct.t src/foo.c include/parrot/bar.h
  22
  23 =head1 DESCRIPTION
  24
  25 Checks that all C source files use struct tags, as defined in PDD07.
  26
  27 =head1 SEE ALSO
  28
  29 L<docs/pdds/pdd07_codingstd.pod>
  30
  31 =cut
  32
  33 my $DIST = Parrot::Distribution->new;
  34 my @files = @ARGV ? <@ARGV> : $DIST->get_c_language_files();
  35 my @struct;
  36
  37 for my $file (@files) {
  38     my $path = ref $file ? $file->path : $file;
  39
  40     open my $fh, '<', $path
  41         or die "Cannot open '$path' for reading: $!\n";
  42
  43     my $count   = 0;
  44     my $message = qq<  $path:>;
  45     while (<$fh>) {
  46
  47         # we're only interested in lines with structs
  48         next unless /\btypedef\s+struct\s+{/;
  49
  50         $count++;
  51         $message .= " $.";
  52     }
  53     push @struct => "$message\n"
  54         if $count;
  55     close $fh;
  56 }
  57
  58 # L<PDD07/Code Structure/=item Structure types must have tags>
  59 ok( !scalar(@struct), "structure types must have tags" )
  60     or diag( "struct without tag found in " . scalar @struct . " files:\n@struct" );
  61
  62 # Local Variables:
  63 #   mode: cperl
  64 #   cperl-indent-level: 4
  65 #   fill-column: 100
  66 # End:
  67 # vim: expandtab shiftwidth=4: