maintainer/check-perl-protos

   1 #!/usr/bin/env perl
   2 #
   3 # Copyright (C) 2017-2024 Free Software Foundation, Inc.
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3, or (at your option)
   8 # any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 use warnings;
  19 use strict;
  20
  21 my @lines = <>;
  22 my %forwards = map { /^sub (\w+)\s*\((.*)\);$/ ? ("$1" => "$2") : () } @lines;
  23 my %subs = map { /^sub (\w+)\s*\((.*)\)$/ ? ("$1" => "$2") : () } @lines;
  24 my $error_count = 0;
  25
  26 # $subs{"foo"} = "$$";
  27 # $subs{"bar"} = "@";
  28 # $forwards{"bar"} = "\$";
  29
  30 # Check that every subroutine has a matching forward declaration with
  31 # the same prototype.
  32 foreach my $sub (keys (%subs))
  33   {
  34     # XXX: The location of the subroutine is not reported.
  35     if (grep { $sub eq $_ } keys (%forwards))
  36       {
  37         if ($forwards{$sub} ne $subs{$sub})
  38           {
  39             $error_count += 1;
  40             warn ("prototype mismatch for \"$sub\" subroutine\n");
  41           }
  42       }
  43     else
  44       {
  45         $error_count += 1;
  46         warn ("missing prototype for \"$sub\" subroutine\n");
  47       }
  48   }
  49
  50 exit (($error_count == 0) ? 0 : 1);