tools/winapi_check/winapi_local.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 winapi_local;
  20
  21 use strict;
  22
  23 use nativeapi qw($nativeapi);
  24 use options qw($options);
  25 use output qw($output);
  26 use winapi qw($win16api $win32api @winapis);
  27
  28 sub check_function {
  29     my $function = shift;
  30
  31     my $return_type = $function->return_type;
  32     my $calling_convention = $function->calling_convention;
  33     my $calling_convention16 = $function->calling_convention16;
  34     my $calling_convention32 = $function->calling_convention32;
  35     my $internal_name = $function->internal_name;
  36     my $external_name16 = $function->external_name16;
  37     my $external_name32 = $function->external_name32;
  38     my $module16 = $function->module16;
  39     my $module32 = $function->module32;
  40     my $refargument_types = $function->argument_types;
  41
  42     if(!defined($refargument_types)) {
  43         return;
  44     }
  45
  46     if($options->win16 && $options->report_module($module16)) {
  47         _check_function($return_type,
  48                         $calling_convention, $external_name16,
  49                         $internal_name, $refargument_types,
  50                         $win16api);
  51     }
  52
  53     if($options->win32 && $options->report_module($module32)) {
  54         _check_function($return_type,
  55                         $calling_convention, $external_name32,
  56                         $internal_name, $refargument_types,
  57                         $win32api);
  58     }
  59 }
  60
  61 sub _check_function {
  62     my $return_type = shift;
  63     my $calling_convention = shift;
  64     my $external_name = shift;
  65     my $internal_name = shift;
  66     my $refargument_types = shift;
  67     my @argument_types = @$refargument_types;
  68     my $winapi = shift;
  69
  70     my $module = $winapi->function_internal_module($internal_name);
  71
  72     if($winapi->name eq "win16") {
  73         if($winapi->is_function_stub_in_module($module, $internal_name)) {
  74             if($options->implemented) {
  75                 $output->write("function implemented but declared as stub in .spec file\n");
  76             }
  77             return;
  78         } elsif($winapi->is_function_stub_in_module($module, $internal_name)) {
  79             if($options->implemented_win32) {
  80                 $output->write("32-bit variant of function implemented but declared as stub in .spec file\n");
  81             }
  82             return;
  83         }
  84     } elsif($winapi->is_function_stub_in_module($module, $internal_name)) {
  85         if($options->implemented) {
  86             $output->write("function implemented but declared as stub in .spec file\n");
  87         }
  88         return;
  89     }
  90
  91     my $forbidden_return_type = 0;
  92     my $implemented_return_kind;
  93     $winapi->type_used_in_module($return_type,$module);
  94     if(!defined($implemented_return_kind = $winapi->translate_argument($return_type))) {
  95         $winapi->declare_argument($return_type, "unknown");
  96         if($return_type ne "") {
  97             $output->write("no translation defined: " . $return_type . "\n");
  98         }
  99     } elsif(!$winapi->is_allowed_kind($implemented_return_kind) ||
 100             !$winapi->is_allowed_type_in_module($return_type, $module))
 101     {
 102         $forbidden_return_type = 1;
 103         $winapi->allow_kind($implemented_return_kind);
 104         $winapi->allow_type_in_module($return_type, $module);
 105         if($options->report_argument_forbidden($return_type)) {
 106             $output->write("return type is forbidden: $return_type ($implemented_return_kind)\n");
 107         }
 108     }
 109
 110     my $segmented = 0;
 111     if(defined($implemented_return_kind) && $implemented_return_kind =~ /^segptr|segstr$/) {
 112         $segmented = 1;
 113     }
 114
 115     my $implemented_calling_convention;
 116     if($winapi->name eq "win16") {
 117         if($calling_convention =~ /^__cdecl$/) {
 118             $implemented_calling_convention = "cdecl";
 119         } elsif($calling_convention =~ /^VFWAPIV|WINAPIV$/) {
 120             $implemented_calling_convention = "varargs";
 121         } elsif($calling_convention =~ /^__stdcall|VFWAPI|WINAPI|CALLBACK$/) {
 122             if($implemented_return_kind =~ /^s_word|word|void$/) {
 123                 $implemented_calling_convention = "pascal16";
 124             } else {
 125                 $implemented_calling_convention = "pascal";
 126             }
 127         } elsif($calling_convention =~ /^__asm$/) {
 128             $implemented_calling_convention = "asm";
 129         } else {
 130             $implemented_calling_convention = "cdecl";
 131         }
 132     } elsif($winapi->name eq "win32") {
 133         if($calling_convention =~ /^__cdecl$/) {
 134             $implemented_calling_convention = "cdecl";
 135         } elsif($calling_convention =~ /^VFWAPIV|WINAPIV$/) {
 136             $implemented_calling_convention = "varargs";
 137         } elsif($calling_convention =~ /^__stdcall|VFWAPI|WINAPI|CALLBACK$/) {
 138             if(defined($implemented_return_kind) && $implemented_return_kind =~ /^longlong$/) {
 139                 $implemented_calling_convention = "stdcall"; # FIXME: Check entry flags
 140             } else {
 141                 $implemented_calling_convention = "stdcall";
 142             }
 143         } elsif($calling_convention =~ /^__asm$/) {
 144             $implemented_calling_convention = "asm";
 145         } else {
 146             $implemented_calling_convention = "cdecl";
 147         }
 148     }
 149
 150     my $declared_calling_convention = $winapi->function_internal_calling_convention($internal_name);
 151     my @declared_argument_kinds = split(/\s+/, $winapi->function_internal_arguments($internal_name));
 152
 153     if($implemented_calling_convention ne $declared_calling_convention &&
 154        $implemented_calling_convention ne "asm" &&
 155        !($declared_calling_convention =~ /^pascal/ && $forbidden_return_type) &&
 156        !($implemented_calling_convention =~ /^cdecl|varargs$/ && $declared_calling_convention =~ /^cdecl|varargs$/))
 157     {
 158         if($options->calling_convention && (
 159             ($options->calling_convention_win16 && $winapi->name eq "win16") ||
 160             ($options->calling_convention_win32 && $winapi->name eq "win32")) &&
 161             !$nativeapi->is_function($internal_name))
 162         {
 163             $output->write("calling convention mismatch: $implemented_calling_convention != $declared_calling_convention\n");
 164         }
 165     }
 166
 167     if($declared_calling_convention eq "varargs") {
 168         if($#argument_types != -1 && $argument_types[$#argument_types] eq "...") {
 169             pop @argument_types;
 170         } else {
 171             $output->write("function not implemented as vararg\n");
 172         }
 173     } elsif($#argument_types != -1 && $argument_types[$#argument_types] eq "...") {
 174         if($#argument_types == 0 || $winapi->name eq "win16") {
 175             pop @argument_types;
 176         } else {
 177             $output->write("function not declared as vararg\n");
 178         }
 179     }
 180
 181     if($#argument_types != -1 && $argument_types[$#argument_types] eq "CONTEXT *" &&
 182        $internal_name !~ /^(Get|Set)ThreadContext$/) # FIXME: Kludge
 183     {
 184         $#argument_types--;
 185     }
 186
 187     if($internal_name =~ /^NTDLL__ftol|NTDLL__CIpow$/) { # FIXME: Kludge
 188         # ignore
 189     } else {
 190         my $n = 0;
 191         my @argument_kinds = map {
 192             my $type = $_;
 193             my $kind = "unknown";
 194             $winapi->type_used_in_module($type,$module);
 195             if($type eq "CONTEXT86 *") {
 196                 $kind = "context86";
 197             } elsif(!defined($kind = $winapi->translate_argument($type))) {
 198                 $winapi->declare_argument($type, "unknown");
 199                 $output->write("no translation defined: " . $type . "\n");
 200             } elsif(!$winapi->is_allowed_kind($kind) ||
 201                     !$winapi->is_allowed_type_in_module($type, $module))
 202             {
 203                 $winapi->allow_kind($kind);
 204                 $winapi->allow_type_in_module($type, $module);
 205                 if($options->report_argument_forbidden($type)) {
 206                     $output->write("argument " . ($n + 1) . " type is forbidden: " . $type . " (" . $kind . ")\n");
 207                 }
 208             }
 209
 210             # FIXME: Kludge
 211             if(defined($kind) && $kind eq "longlong") {
 212                 $n+=2;
 213                 ("long", "long");
 214             } else {
 215                 $n++;
 216                 $kind;
 217             }
 218         } @argument_types;
 219
 220         for my $n (0..$#argument_kinds) {
 221             if(!defined($argument_kinds[$n]) || !defined($declared_argument_kinds[$n])) { next; }
 222
 223             if($argument_kinds[$n] =~ /^segptr|segstr$/ ||
 224                $declared_argument_kinds[$n] =~ /^segptr|segstr$/)
 225             {
 226                 $segmented = 1;
 227             }
 228
 229             # FIXME: Kludge
 230             if(!defined($argument_types[$n])) {
 231                 $argument_types[$n] = "";
 232             }
 233
 234             if($argument_kinds[$n] eq "context86") {
 235                 # Nothing
 236             } elsif(!$winapi->is_allowed_kind($argument_kinds[$n]) ||
 237                !$winapi->is_allowed_type_in_module($argument_types[$n], $module))
 238             {
 239                 $winapi->allow_kind($argument_kinds[$n]);
 240                 $winapi->allow_type_in_module($argument_types[$n],, $module);
 241                 if($options->report_argument_forbidden($argument_types[$n])) {
 242                     $output->write("argument " . ($n + 1) . " type is forbidden: " .
 243                                    "$argument_types[$n] ($argument_kinds[$n])\n");
 244                 }
 245             } elsif($argument_kinds[$n] ne $declared_argument_kinds[$n]) {
 246                 if($options->report_argument_kind($argument_kinds[$n]) ||
 247                    $options->report_argument_kind($declared_argument_kinds[$n]))
 248                 {
 249                     $output->write("argument " . ($n + 1) . " type mismatch: " .
 250                              $argument_types[$n] . " ($argument_kinds[$n]) != " .
 251                              $declared_argument_kinds[$n] . "\n");
 252                 }
 253             }
 254         }
 255
 256         if($#argument_kinds != $#declared_argument_kinds &&
 257            $implemented_calling_convention ne "asm")
 258         {
 259             if($options->argument_count) {
 260                 $output->write("argument count differs: " .
 261                     ($#argument_types + 1) . " != " .
 262                     ($#declared_argument_kinds + 1) . "\n");
 263             }
 264         }
 265
 266     }
 267
 268     if($segmented && $options->shared_segmented && $winapi->is_shared_internal_function($internal_name)) {
 269         $output->write("function using segmented pointers shared between Win16 och Win32\n");
 270     }
 271 }
 272
 273 sub check_statements {
 274     my $functions = shift;
 275     my $function = shift;
 276
 277     my $module16 = $function->module16;
 278     my $module32 = $function->module32;
 279
 280     if($options->win16 && $options->report_module($module16)) {
 281         _check_statements($win16api, $functions, $function);
 282     }
 283
 284     if($options->win32 && $options->report_module($module32)) {
 285         _check_statements($win16api, $functions, $function);
 286     }
 287 }
 288
 289 sub _check_statements {
 290     my $winapi = shift;
 291     my $functions = shift;
 292     my $function = shift;
 293
 294     my $module = $function->module;
 295     my $internal_name = $function->internal_name;
 296
 297     my $first_debug_message = 1;
 298     local $_ = $function->statements;
 299     while(defined($_)) {
 300         if(s/(\w+)\s*(?:\(\s*(\w+)\s*\))?\s*\(\s*((?:\"[^\"]*\"|\([^\)]*\)|[^\)])*?)\s*\)//) {
 301             my $called_name = $1;
 302             my $channel = $2;
 303             my $called_arguments = $3;
 304             if($called_name =~ /^if|for|while|switch|sizeof$/) {
 305                 # Nothing
 306             } elsif($called_name =~ /^ERR|FIXME|MSG|TRACE|WARN$/) {
 307                 if($first_debug_message && $called_name =~ /^FIXME|TRACE$/) {
 308                     $first_debug_message = 0;
 309                     if($called_arguments =~ /^\"\((.*?)\)(.*?)\"\s*,\s*(.*?)$/) {
 310                         my $formating = $1;
 311                         my $extra = $2;
 312                         my $arguments = $3;
 313
 314                         my $format;
 315                         my $argument;
 316                         my $n = 0;
 317                         while($formating && ($formating =~ s/^([^,]*),?//, $format = $1, $format =~ s/^\s*(.*?)\s*$/$1/) &&
 318                               $arguments && ($arguments =~ s/^([^,]*),?//, $argument = $1, $argument =~ s/^\s*(.*?)\s*$/$1/))
 319                         {
 320                             my $type = @{$function->argument_types}[$n];
 321                             my $name = @{$function->argument_names}[$n];
 322
 323                             $n++;
 324
 325                             if(!defined($type)) { last; }
 326
 327                             $format =~ s/^\w+\s*[:=]?\s*//;
 328                             $format =~ s/\s*\{[^\{\}]*\}$//;
 329                             $format =~ s/\s*\[[^\[\]]*\]$//;
 330                             $format =~ s/^\'(.*?)\'$/$1/;
 331                             $format =~ s/^\\\"(.*?)\\\"$/$1/;
 332
 333                             if($options->debug_messages) {
 334                                 if($argument !~ /$name/) {
 335                                     $output->write("$called_name: argument $n is wrong ($name != '$argument')\n");
 336                                 } elsif(!$winapi->is_allowed_type_format($module, $type, $format)) {
 337                                     $output->write("$called_name: argument $n ($type $name) has illegal format ($format)\n");
 338                                 }
 339                             }
 340                         }
 341
 342                         if($options->debug_messages) {
 343                             my $count = $#{$function->argument_types} + 1;
 344                             if($n != $count) {
 345                                 $output->write("$called_name: argument count mismatch ($n != $count)\n");
 346                             }
 347                         }
 348                     }
 349                 }
 350             } elsif($options->cross_call) {
 351                 $$functions{$internal_name}->function_called($called_name);
 352                 if(!defined($$functions{$called_name})) {
 353                     $$functions{$called_name} = 'winapi_function'->new;
 354                 }
 355                 $$functions{$called_name}->function_called_by($internal_name);
 356             }
 357         } else {
 358             undef $_;
 359         }
 360     }
 361 }
 362
 363 sub check_file {
 364     my $file = shift;
 365     my $functions = shift;
 366
 367     if($options->cross_call) {
 368         my @names = sort(keys(%$functions));
 369         for my $name (@names) {
 370             my @called_names = $$functions{$name}->called_function_names;
 371             my @called_by_names = $$functions{$name}->called_by_function_names;
 372             my $module = $$functions{$name}->module;
 373
 374             if($options->cross_call_win32_win16) {
 375                 my $module16 = $$functions{$name}->module16;
 376                 my $module32 = $$functions{$name}->module32;
 377
 378                 if($#called_names >= 0 && (defined($module16) || defined($module32)) ) {
 379                     for my $called_name (@called_names) {
 380                         my $called_module16 = $$functions{$called_name}->module16;
 381                         my $called_module32 = $$functions{$called_name}->module32;
 382                         if(defined($module32) &&
 383                            defined($called_module16) && !defined($called_module32) &&
 384                            $name ne $called_name)
 385                         {
 386                             $output->write("$file: $module: $name: illegal call to $called_name (Win32 -> Win16)\n");
 387                         }
 388                     }
 389                 }
 390             }
 391
 392             if($options->cross_call_unicode_ascii) {
 393                 if($name =~ /W$/) {
 394                     for my $called_name (@called_names) {
 395                         if($called_name =~ /A$/) {
 396                             $output->write("$file: $module: $name: illegal call to $called_name (Unicode -> ASCII)\n");
 397                         }
 398                     }
 399                 }
 400             }
 401         }
 402     }
 403 }
 404
 405 1;