t/codingstd/c_cppcomments.t

   1 #! perl
   2 # Copyright (C) 2001-2010, 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 use Parrot::Test::Util::Runloop;
  12
  13 =head1 NAME
  14
  15 t/codingstd/c_cppcomments.t - checks for C++ style comments
  16
  17 =head1 SYNOPSIS
  18
  19     # test all files
  20     % prove t/codingstd/c_cppcomments.t
  21
  22     # test specific files
  23     % perl t/codingstd/c_cppcoments.t src/foo.t include/parrot/bar.h
  24
  25 =head1 DESCRIPTION
  26
  27 Checks that no source file in the distribution uses C++ style comments.
  28
  29 =head1 SEE ALSO
  30
  31 L<docs/pdds/pdd07_codingstd.pod>
  32
  33 =cut
  34
  35 my @files;
  36 if ( @ARGV ) {
  37     @files = <@ARGV>;
  38 }
  39 else {
  40     my $DIST = Parrot::Distribution->new();
  41     @files = $DIST->get_c_language_files();
  42     @files = grep { $_->name !~ /.l$/ } @files;
  43 }
  44
  45 Parrot::Test::Util::Runloop->testloop(
  46     name        => 'no c++ comments',
  47     files       => [@files],
  48     per_file    => \&check_cppcomments,
  49     diag_prefix => 'C++ comments found'
  50 );
  51
  52 # TT # 414 (https://trac.parrot.org/parrot/ticket/414):
  53 # In the POD inside a C source code file, a hyperlink such as
  54 # https://trac.parrot.org will be inaccurately reported as a C++-style
  55 # comment.
  56 # Quick fix added
  57 sub check_cppcomments {
  58     my $buf = shift;
  59     $buf =~ s{ (?:
  60                    (?: ' (?: \\\\ | \\' | [^'] )* ' )  # remove ' string
  61                  | (?: " (?: \\\\ | \\" | [^"] )* " )  # remove " string
  62                  | /\* .*? \*/                         # remove C comment
  63                  | https?:\/\/                         # TT # 414 quick fix
  64                )
  65              }{}gsx;
  66
  67     return $buf !~ m{ ( .*? // .* ) }x;
  68 }
  69
  70 # Local Variables:
  71 #   mode: cperl
  72 #   cperl-indent-level: 4
  73 #   fill-column: 100
  74 # End:
  75 # vim: expandtab shiftwidth=4: