From 2db5ea9160a67c2693b8fae23cdd8da1159bc56f Mon Sep 17 00:00:00 2001
From: Micah Cowan <micah@cowan.name>
Date: Thu, 15 May 2008 21:17:34 -0700
Subject: [PATCH] Added Steven Schubiger's paramcheck.pl, but not for
 distribution.

---
 util/paramcheck.pl | 158 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 158 insertions(+)
 create mode 100755 util/paramcheck.pl

diff --git a/util/paramcheck.pl b/util/paramcheck.pl
new file mode 100755
index 00000000..83ad20c1
--- /dev/null
+++ b/util/paramcheck.pl
@@ -0,0 +1,158 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+
+use FindBin qw($Bin);
+use File::Spec ();
+
+my @args = ([
+    File::Spec->catfile($Bin, '..', 'src', 'main.c'),
+    qr/static \s+? struct \s+? cmdline_option \s+? option_data\[\] \s+? = \s+? \{ (.*?) \}\;/sx,
+    [ qw(long_name short_name type data argtype) ],
+], [
+    File::Spec->catfile($Bin, '..', 'src', 'init.c'),
+    qr/commands\[\] \s+? = \s+? \{ (.*?) \}\;/sx,
+    [ qw(name place action) ],
+]);
+
+{
+    my (@lines, @opts, $source);
+    foreach my $arg (@args) {
+        my ($file, $regex, $names) = @$arg;
+        $source = read_file($file);
+        @lines = extract_opts_chunk($source, $regex);
+        push @opts, extract_opts(\@lines, $names);
+    }
+    walk_opts(@opts);
+}
+
+sub read_file
+{
+    my ($file) = @_;
+    open(my $fh, '<', $file) or die "Cannot open $file: $!";
+    return do { local $/; <$fh> };
+}
+
+sub extract_opts_chunk
+{
+    my ($source, $regex) = @_;
+    my ($opts) = $source =~ $regex;
+    return map { /\S/ && !/^\#/ ? $_ : () } split /(?<=\})/, $opts;
+}
+
+sub extract_opts
+{
+    my ($lines, $names) = @_;
+    my ($is_deprecated, @opts);
+    foreach my $line (@$lines) {
+        my ($args) = $line =~ /\{ \s+? (.*?) \s+? \}/sx;
+        next unless defined $args;
+        my @args = map { tr/'"//d; $_ }
+                   map { /\((.*?)\)/ ? $1 : $_ }
+                   split /\,\s+/, $args;
+        my $opt = { map { $_ => shift @args } @$names };
+        ($opt->{line}) = $line =~ /.*? (\{.*)/;
+        $opts[-1]->{is_deprecated} = 1 if $line =~ /deprecated/i;
+        push @opts, $opt;
+    }
+    return \@opts;
+}
+
+sub walk_opts
+{
+    emit_no_corresponding_cmds(@_);
+    print "\n";
+    emit_no_matching_long_cmds(@_);
+    print "\n";
+    emit_no_corresponding_opts(@_);
+    print "\n";
+    emit_deprecated_opts(@_);
+    print "\n";
+    emit_deprecated_cmds(@_);
+    print "\n";
+}
+
+sub emit_no_corresponding_cmds
+{
+    my ($opts) = @_;
+    print <<EOT;
+No corresponding commands
+=========================
+EOT
+    foreach my $opt (@$opts) {
+        unless ($opt->{type} =~ /^(?:OPT_BOOLEAN|OPT_VALUE)$/
+             && $opt->{argtype} == -1)
+        {
+            print $opt->{line}, "\n";
+        }
+    }
+}
+
+sub emit_no_matching_long_cmds
+{
+    my ($opts) = @_;
+    print <<EOT;
+Non-matching commands
+=====================
+EOT
+    foreach my $opt (@$opts) {
+        my $long_name = $opt->{long_name};
+        $long_name =~ tr/-//d;
+        unless ($long_name eq $opt->{data}) {
+            print $opt->{line}, "\n";
+        }
+    }
+}
+
+sub emit_no_corresponding_opts
+{
+    my ($opts, $cmds) = @_;
+    print <<EOT;
+No corresponding options
+========================
+EOT
+    foreach my $cmd (@$cmds) {
+        my $found = 0;
+        foreach my $opt (@$opts) {
+            my $long_name = $opt->{long_name};
+            $long_name =~ tr/-//d;
+            if ($cmd->{name} eq $opt->{data}
+             || $cmd->{name} eq $long_name) {
+                $found = 1;
+                last;
+            }
+        }
+        unless ($found) {
+            print $cmd->{line}, "\n";
+        }
+    }
+}
+
+sub emit_deprecated_opts
+{
+    my ($opts) = @_;
+    print <<EOT;
+Deprecated options
+==================
+EOT
+    foreach my $opt (@$opts) {
+        if ($opt->{is_deprecated}) {
+            print $opt->{line}, "\n";
+        }
+    }
+}
+
+sub emit_deprecated_cmds
+{
+    my ($opts, $cmds) = @_;
+    print <<EOT;
+Deprecated commands
+===================
+EOT
+    foreach my $cmd (@$cmds) {
+        if ($cmd->{is_deprecated}) {
+            print $cmd->{line}, "\n";
+        }
+    }
+}
-- 
2.39.2