123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245 |
- use strict;
- use warnings;
- use vars qw($Cpreprocessor);
- my $rc = eval {
- require configurehelp;
- configurehelp->import(qw(
- $Cpreprocessor
- ));
- 1;
- };
- if (!$rc) {
- $Cpreprocessor = 'cpp';
- }
- my $root=$ARGV[0] || ".";
- my $i = ($ARGV[1]) ? "-I$ARGV[1] " : '';
- my $verbose=0;
- my $summary=0;
- my $misses=0;
- my @manrefs;
- my @syms;
- my %doc;
- my %rem;
- sub scanenum {
- my ($file) = @_;
- open my $h_in, "-|", "$Cpreprocessor $i$file" || die "Cannot preprocess $file";
- while ( <$h_in> ) {
- if ( /enum\s+(\S+\s+)?{/ .. /}/ ) {
- s/^\s+//;
- next unless /^CURL/;
- chomp;
- s/[,\s].*//;
- push @syms, $_;
- }
- }
- close $h_in || die "Error preprocessing $file";
- }
- sub scanheader {
- my ($f)=@_;
- open my $h, "<", "$f";
- while(<$h>) {
- if (/^#define ((LIB|)CURL[A-Za-z0-9_]*)/) {
- push @syms, $1;
- }
- }
- close $h;
- }
- sub scanallheaders {
- my $d = "$root/include/curl";
- opendir(my $dh, $d) ||
- die "Can't opendir: $!";
- my @headers = grep { /.h\z/ } readdir($dh);
- closedir $dh;
- foreach my $h (@headers) {
- scanenum("$d/$h");
- scanheader("$d/$h");
- }
- }
- sub checkmanpage {
- my ($m) = @_;
- open(my $mh, "<", "$m");
- my $line = 1;
- while(<$mh>) {
-
- $_ =~ s/(^|[^A-Z0-9])[*_]+/ /;
-
- while(s/\W(CURL(AUTH|E|H|MOPT|OPT|SHOPT|UE|M|SSH|SSLBACKEND|HEADER|FORM|FTP|PIPE|MIMEOPT|GSSAPI|ALTSVC|PROTO|PROXY|UPART|USESSL|_READFUNC|_WRITEFUNC|_CSELECT|_FORMADD|_IPRESOLVE|_REDIR|_RTSPREQ|_TIMECOND|_VERSION)_[a-zA-Z0-9_]+)//) {
- my $s = $1;
-
- if($s !~ /^(CURLE_OBSOLETE|CURLOPT_TEMPLATE)/) {
- push @manrefs, "$1:$m:$line";
- }
- }
- $line++;
- }
- close($mh);
- }
- sub scanman_md_dir {
- my ($d) = @_;
- opendir(my $dh, $d) ||
- die "Can't opendir: $!";
- my @mans = grep { /.md\z/ } readdir($dh);
- closedir $dh;
- for my $m (@mans) {
- checkmanpage("$d/$m");
- }
- }
- scanallheaders();
- scanman_md_dir("$root/docs/libcurl");
- scanman_md_dir("$root/docs/libcurl/opts");
- open my $s, "<", "$root/docs/libcurl/symbols-in-versions";
- while(<$s>) {
- if(/(^[^ \n]+) +(.*)/) {
- my ($sym, $rest)=($1, $2);
- if($doc{$sym}) {
- print "Detected duplicate symbol: $sym\n";
- $misses++;
- next;
- }
- $doc{$sym}=$sym;
- my @a=split(/ +/, $rest);
- if($a[2]) {
-
-
- $rem{$sym}=$a[2];
- }
- }
- }
- close $s;
- my $ignored=0;
- for my $e (sort @syms) {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- if($e =~ /(OBSOLETE|^CURL_EXTERN|^CURLINC_|_LAST\z|_LASTENTRY\z|^CURL_TEMP_)/) {
- $ignored++;
- next;
- }
- if($doc{$e}) {
- if($verbose) {
- print $e."\n";
- }
- $doc{$e}="used";
- next;
- }
- else {
- print $e."\n";
- $misses++;
- }
- }
- my $anyremoved;
- for my $e (sort keys %doc) {
- if(($doc{$e} ne "used") && !$rem{$e}) {
- if(!$anyremoved++) {
- print "Missing symbols mentioned in symbols-in-versions\n";
- print "Add them to a header, or mark them as removed.\n";
- }
- print "$e\n";
- $misses++;
- }
- }
- my %warned;
- for my $r (@manrefs) {
- if($r =~ /^([^:]+):(.*)/) {
- my ($sym, $file)=($1, $2);
- if(!$doc{$sym} && !$warned{$sym, $file}) {
- print "$file: $sym is not a public symbol\n";
- $warned{$sym, $file} = 1;
- }
- }
- }
- if($summary) {
- print "Summary:\n";
- printf "%d symbols in headers (out of which %d are ignored)\n", scalar(@syms),
- $ignored;
- printf "%d symbols in headers are interesting\n",
- scalar(@syms)- $ignored;
- printf "%d symbols are listed in symbols-in-versions\n (out of which %d are listed as removed)\n", scalar(keys %doc), scalar(keys %rem);
- printf "%d symbols in symbols-in-versions should match the ones in headers\n", scalar(keys %doc) - scalar(keys %rem);
- }
- if($misses) {
- exit 0;
- }
- else {
- print "OK\n";
- }
|