tools/winapi_check/modules.pm

   1 #
   2 # Copyright 1999, 2000, 2001 Patrik Stridvall
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17 #
  18
  19 package modules;
  20
  21 use strict;
  22
  23 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
  24 require Exporter;
  25
  26 @ISA = qw(Exporter);
  27 @EXPORT = qw();
  28 @EXPORT_OK = qw($modules);
  29
  30 use vars qw($modules);
  31
  32 use config qw(
  33     file_type files_skip
  34     file_directory
  35     get_c_files get_spec_files
  36     $current_dir $wine_dir
  37     $winapi_check_dir
  38 );
  39 use options qw($options);
  40 use output qw($output);
  41
  42 sub import(@) {
  43     $Exporter::ExportLevel++;
  44     Exporter::import(@_);
  45     $Exporter::ExportLevel--;
  46
  47     if (defined($modules)) {
  48         return;
  49     }
  50
  51     $modules = 'modules'->new;
  52 }
  53
  54 sub get_spec_file_type($) {
  55     my $file = shift;
  56
  57     my $module;
  58     my $type;
  59
  60     $module = $file;
  61     $module =~ s%^.*?([^/]+)\.spec$%$1%;
  62
  63     open(IN, "< $file") || die "$file: $!\n";
  64     local $/ = "\n";
  65     my $header = 1;
  66     my $lookahead = 0;
  67     while($lookahead || defined($_ = <IN>)) {
  68         $lookahead = 0;
  69         s/^\s*(.*?)\s*$/$1/;
  70         s/^(.*?)\s*#.*$/$1/;
  71         /^$/ && next;
  72
  73         if($header)  {
  74             if(/^(?:\d+|@)/) { $header = 0; $lookahead = 1; }
  75             next;
  76         }
  77
  78         if(/^(\d+|@)\s+pascal(?:16)?/) {
  79             $type = "win16";
  80             last;
  81         }
  82     }
  83     close(IN);
  84
  85     if(!defined($type)) {
  86         $type = "win32";
  87     }
  88
  89     return ($type, $module);
  90 }
  91
  92 sub find_spec_files($) {
  93     my $self = shift;
  94
  95     my $dir2spec_file = \%{$self->{DIR2SPEC_FILE}};
  96     my $spec_file2dir = \%{$self->{SPEC_FILE2DIR}};
  97
  98     $output->progress("modules");
  99
 100     my $spec_file_found = {};
 101     my $allowed_dir;
 102     my $spec_file;
 103
 104     my @spec_files = <{dlls/*/*.spec,dlls/*/*/*.spec}>;
 105
 106     foreach $spec_file (@spec_files) {
 107         $spec_file =~ /(.*)\/.*\.spec/;
 108
 109         $allowed_dir = $1;
 110
 111         $$spec_file_found{$spec_file}++;
 112         $$spec_file2dir{$spec_file}{$allowed_dir}++;
 113         $$dir2spec_file{$allowed_dir}{$spec_file}++;
 114     }
 115
 116     return $spec_file_found;
 117 }
 118
 119 sub read_spec_files($$) {
 120     my $self = shift;
 121
 122     my $spec_file_found = shift;
 123
 124     my $dir2spec_file = \%{$self->{DIR2SPEC_FILE}};
 125     my $spec_files16 = \@{$self->{SPEC_FILES16}};
 126     my $spec_files32 = \@{$self->{SPEC_FILES32}};
 127     my $spec_file2module = \%{$self->{SPEC_FILE2MODULE}};
 128     my $module2spec_file = \%{$self->{MODULE2SPEC_FILE}};
 129
 130     my @spec_files;
 131     if($wine_dir eq ".") {
 132         @spec_files = get_spec_files("winelib");
 133     } else {
 134         my %spec_files = ();
 135         foreach my $dir ($options->directories) {
 136             $dir = "$current_dir/$dir";
 137             $dir =~ s%/\.$%%;
 138             foreach my $spec_file (sort(keys(%{$$dir2spec_file{$dir}}))) {
 139                 $spec_files{$spec_file}++;
 140             }
 141         }
 142         @spec_files = sort(keys(%spec_files));
 143     }
 144
 145     @$spec_files16 = ();
 146     @$spec_files32 = ();
 147     foreach my $spec_file (@spec_files) {
 148         (my $type, my $module) = get_spec_file_type("$wine_dir/$spec_file");
 149
 150         $$spec_file2module{$spec_file} = $module;
 151         $$module2spec_file{$module} = $spec_file;
 152
 153         if($type eq "win16") {
 154             push @$spec_files16, $spec_file;
 155         } elsif($type eq "win32") {
 156             push @$spec_files32, $spec_file;
 157         } else {
 158             $output->write("$spec_file: unknown type '$type'\n");
 159         }
 160     }
 161
 162     foreach my $spec_file (@spec_files) {
 163         if(!$$spec_file_found{$spec_file} && $spec_file !~ m%tests/[^/]+$%) {
 164             $output->write("modules: $spec_file: exists but is not specified\n");
 165         }
 166     }
 167 }
 168
 169 sub new($) {
 170     my $proto = shift;
 171     my $class = ref($proto) || $proto;
 172     my $self  = {};
 173     bless ($self, $class);
 174
 175     my $spec_file_found = $self->find_spec_files();
 176     $self->read_spec_files($spec_file_found);
 177
 178     return $self;
 179 }
 180
 181 sub all_modules($) {
 182     my $self = shift;
 183
 184     my $module2spec_file = \%{$self->{MODULE2SPEC_FILE}};
 185
 186     return sort(keys(%$module2spec_file));
 187 }
 188
 189 sub is_allowed_module($$) {
 190     my $self = shift;
 191
 192     my $module2spec_file = \%{$self->{MODULE2SPEC_FILE}};
 193
 194     my $module = shift;
 195
 196     return defined($$module2spec_file{$module});
 197 }
 198
 199 sub is_allowed_module_in_file($$$) {
 200     my $self = shift;
 201
 202     my $dir2spec_file = \%{$self->{DIR2SPEC_FILE}};
 203     my $spec_file2module = \%{$self->{SPEC_FILE2MODULE}};
 204
 205     my $module = shift;
 206     my $file = shift;
 207     $file =~ s/^\.\///;
 208
 209     my $dir = $file;
 210     $dir =~ s/\/[^\/]*$//;
 211
 212     if($dir =~ m%^include%) {
 213         return 1;
 214     }
 215
 216     foreach my $spec_file (sort(keys(%{$$dir2spec_file{$dir}}))) {
 217         if($$spec_file2module{$spec_file} eq $module) {
 218             return 1;
 219         }
 220     }
 221
 222     return 0;
 223 }
 224
 225 sub allowed_modules_in_file($$) {
 226     my $self = shift;
 227
 228     my $dir2spec_file = \%{$self->{DIR2SPEC_FILE}};
 229     my $spec_file2module = \%{$self->{SPEC_FILE2MODULE}};
 230
 231     my $file = shift;
 232     $file =~ s/^\.\///;
 233
 234     my $dir = $file;
 235     $dir =~ s/\/[^\/]*$//;
 236
 237     my %allowed_modules = ();
 238     foreach my $spec_file (sort(keys(%{$$dir2spec_file{$dir}}))) {
 239         my $module = $$spec_file2module{$spec_file};
 240         $allowed_modules{$module}++;
 241     }
 242
 243     my $module = join(" & ", sort(keys(%allowed_modules)));
 244
 245     return $module;
 246 }
 247
 248 sub allowed_dirs_for_module($$) {
 249    my $self = shift;
 250
 251    my $module2spec_file = \%{$self->{MODULE2SPEC_FILE}};
 252    my $spec_file2dir = \%{$self->{SPEC_FILE2DIR}};
 253
 254    my $module = shift;
 255
 256    my $spec_file = $$module2spec_file{$module};
 257
 258    return sort(keys(%{$$spec_file2dir{$spec_file}}));
 259 }
 260
 261 sub allowed_spec_files16($) {
 262     my $self = shift;
 263
 264     my $spec_files16 = \@{$self->{SPEC_FILES16}};
 265
 266     return @$spec_files16;
 267 }
 268
 269 sub allowed_spec_files32($) {
 270     my $self = shift;
 271
 272     my $spec_files32 = \@{$self->{SPEC_FILES32}};
 273
 274     return @$spec_files32;
 275 }
 276
 277 sub found_module_in_dir($$$) {
 278     my $self = shift;
 279
 280     my $module = shift;
 281     my $dir = shift;
 282
 283     my $used_module_dirs = \%{$self->{USED_MODULE_DIRS}};
 284
 285     $dir = "$current_dir/$dir";
 286     $dir =~ s%/\.$%%;
 287
 288     $$used_module_dirs{$module}{$dir}++;
 289 }
 290
 291 sub complete_modules($$) {
 292     my $self = shift;
 293
 294     my $c_files = shift;
 295
 296     my %dirs;
 297
 298     foreach my $file (@$c_files) {
 299         my $dir = file_directory("$current_dir/$file");
 300         $dirs{$dir}++;
 301     }
 302
 303     my @c_files = get_c_files("winelib");
 304     @c_files = files_skip(@c_files);
 305     foreach my $file (@c_files) {
 306         my $dir = file_directory($file);
 307         if(exists($dirs{$dir})) {
 308             $dirs{$dir}--;
 309         }
 310     }
 311
 312     my @complete_modules = ();
 313     foreach my $module ($self->all_modules) {
 314         my $index = -1;
 315         my @dirs = $self->allowed_dirs_for_module($module);
 316         foreach my $dir (@dirs) {
 317             if(exists($dirs{$dir}) && $dirs{$dir} == 0) {
 318                 $index++;
 319             }
 320         }
 321         if($index == $#dirs) {
 322             push @complete_modules, $module;
 323         }
 324     }
 325
 326     return @complete_modules;
 327 }
 328
 329 sub global_report($) {
 330     my $self = shift;
 331
 332     my $dir2spec_file = \%{$self->{DIR2SPEC_FILE}};
 333     my $module2spec_file = \%{$self->{MODULE2SPEC_FILE}};
 334     my $used_module_dirs = \%{$self->{USED_MODULE_DIRS}};
 335
 336     my @messages;
 337     foreach my $dir ($options->directories) {
 338         $dir = "$current_dir/$dir";
 339         $dir =~ s%/\.$%%;
 340         foreach my $module ($self->all_modules) {
 341             if(!$$used_module_dirs{$module}{$dir}) {
 342                 my $spec_file = $$module2spec_file{$module};
 343                 push @messages, "modules: $spec_file: directory ($dir) is not used\n";
 344             }
 345         }
 346     }
 347
 348     foreach my $message (sort(@messages)) {
 349         $output->write($message);
 350     }
 351 }
 352
 353 1;