1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
#!/usr/bin/env perl
#***************************************************************************
# _ _ ____ _
# Project ___| | | | _ \| |
# / __| | | | |_) | |
# | (__| |_| | _ <| |___
# \___|\___/|_| \_\_____|
#
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at https://curl.se/docs/copyright.html.
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
# SPDX-License-Identifier: curl
#
###########################################################################
use strict;
use warnings;
# the DISABLE options that can be set by configure
my %disable;
# the DISABLE options that can be set by CMakeLists.txt
my %disable_cmake;
# the DISABLE options propagated via curl_config-cmake.h.in
my %disable_cmake_config_h;
# the DISABLE options that are used in C files
my %file;
# the DISABLE options that are documented
my %docs;
# we may get the directory root pointed out
my $root=$ARGV[0] || ".";
my $DOCS="CURL-DISABLE.md";
sub scanconf {
my ($f)=@_;
open S, "<$f";
while(<S>) {
if(/(CURL_DISABLE_[A-Z0-9_]+)/g) {
my ($sym)=($1);
if(not $sym =~ /^(CURL_DISABLE_TYPECHECK)$/) {
$disable{$sym} = 1;
}
}
}
close S;
}
sub scan_configure {
opendir(my $m, "$root/m4") || die "Cannot opendir $root/m4: $!";
my @m4 = grep { /\.m4$/ } readdir($m);
closedir $m;
scanconf("$root/configure.ac");
# scan all m4 files too
for my $e (@m4) {
scanconf("$root/m4/$e");
}
}
sub scanconf_cmake {
my ($hashr, $f)=@_;
open S, "<$f";
while(<S>) {
if(/(CURL_DISABLE_[A-Z0-9_]+)/g) {
my ($sym)=($1);
if(not $sym =~ /^(CURL_DISABLE_INSTALL|CURL_DISABLE_SRP|CURL_DISABLE_TYPECHECK)$/) {
$hashr->{$sym} = 1;
}
}
}
close S;
}
sub scan_cmake {
scanconf_cmake(\%disable_cmake, "$root/CMakeLists.txt");
}
sub scan_cmake_config_h {
scanconf_cmake(\%disable_cmake_config_h, "$root/lib/curl_config-cmake.h.in");
}
my %whitelisted = (
'CURL_DISABLE_DEPRECATION' => 1,
'CURL_DISABLE_TYPECHECK' => 1,
);
sub scan_file {
my ($source)=@_;
open F, "<$source";
while(<F>) {
while(s/(CURL_DISABLE_[A-Z0-9_]+)//) {
my ($sym)=($1);
if(!$whitelisted{$sym}) {
$file{$sym} = $source;
}
}
}
close F;
}
sub scan_dir {
my ($dir)=@_;
opendir(my $dh, $dir) || die "Cannot opendir $dir: $!";
my @cfiles = grep { /\.[ch]\z/ && -f "$dir/$_" } readdir($dh);
closedir $dh;
for my $f (sort @cfiles) {
scan_file("$dir/$f");
}
}
sub scan_sources {
scan_dir("$root/include/curl");
scan_dir("$root/src");
scan_dir("$root/lib");
scan_dir("$root/lib/vtls");
scan_dir("$root/lib/vauth");
}
sub scan_docs {
open F, "<$root/docs/$DOCS";
my $line = 0;
while(<F>) {
$line++;
if(/^## `(CURL_DISABLE_[A-Z0-9_]+)`/g) {
my ($sym)=($1);
if(not $sym =~ /^(CURL_DISABLE_TYPECHECK)$/) {
$docs{$sym} = $line;
}
}
}
close F;
}
scan_configure();
scan_cmake();
scan_cmake_config_h();
scan_sources();
scan_docs();
my $error = 0;
# Check the configure symbols for use in code
for my $s (sort keys %disable) {
if(!$file{$s}) {
printf "Present in configure.ac, not used by code: %s\n", $s;
$error++;
}
if(!$docs{$s}) {
printf "Present in configure.ac, not documented in $DOCS: %s\n", $s;
$error++;
}
}
# Check the CMakeLists.txt symbols for use in code
for my $s (sort keys %disable_cmake) {
if(!$file{$s}) {
printf "Present in CMakeLists.txt, not used by code: %s\n", $s;
$error++;
}
if(!$docs{$s}) {
printf "Present in CMakeLists.txt, not documented in $DOCS: %s\n", $s;
$error++;
}
}
# Check the CMakeLists.txt symbols for use in curl_config-cmake.h.in
for my $s (sort keys %disable_cmake) {
if(!$disable_cmake_config_h{$s}) {
printf "Present in CMakeLists.txt, not propagated via curl_config-cmake.h.in: %s\n", $s;
$error++;
}
}
# Check the code symbols for use in configure
for my $s (sort keys %file) {
if(!$disable{$s}) {
printf "Not set by configure: %s (%s)\n", $s, $file{$s};
$error++;
}
if(!$disable_cmake{$s}) {
printf "Not set by CMakeLists.txt: %s (%s)\n", $s, $file{$s};
$error++;
}
if(!$docs{$s}) {
printf "Used in code, not documented in $DOCS: %s\n", $s;
$error++;
}
}
# Check the documented symbols
for my $s (sort keys %docs) {
if(!$disable{$s}) {
printf "Documented but not in configure: %s\n", $s;
$error++;
}
if(!$disable_cmake{$s}) {
printf "Documented but not in CMakeLists.txt: %s\n", $s;
$error++;
}
if(!$file{$s}) {
printf "Documented, but not used by code: %s\n", $s;
$error++;
}
}
exit $error;
|