git.oblomov.eu Git - wine/blob - tools/winapi/winapi.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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17 #
  18
  19 package winapi;
  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($win16api $win32api @winapis);
  29
  30 use vars qw($win16api $win32api @winapis);
  31
  32 use config qw($current_dir $wine_dir $winapi_dir);
  33 use options qw($options);
  34 use output qw($output);
  35
  36 use vars qw($modules);
  37
  38 sub found_shared_internal_function($$);
  39 sub function_external_calling_convention_in_module($$$);
  40 sub function_internal_module($$);
  41 sub is_function_stub_in_module($$$);
  42 sub new($$$);
  43 sub parse_api_file($$);
  44 sub parse_spec_file($$);
  45
  46 sub import(@) {
  47     $Exporter::ExportLevel++;
  48     Exporter::import(@_);
  49     $Exporter::ExportLevel--;
  50
  51     if (defined($modules) && defined($win16api) && defined($win32api)) {
  52         return;
  53     }
  54
  55     require modules;
  56     import modules qw($modules);
  57
  58     my @spec_files16 = $modules->allowed_spec_files16;
  59     $win16api = 'winapi'->new("win16", \@spec_files16);
  60
  61     my @spec_files32 = $modules->allowed_spec_files32;
  62     $win32api = 'winapi'->new("win32", \@spec_files32);
  63
  64     @winapis = ($win16api, $win32api);
  65
  66     for my $internal_name ($win32api->all_internal_functions) {
  67         my $module16 = $win16api->function_internal_module($internal_name);
  68         my $module32 = $win16api->function_internal_module($internal_name);
  69         if(defined($module16) &&
  70            !$win16api->is_function_stub_in_module($module16, $internal_name) &&
  71            !$win32api->is_function_stub_in_module($module32, $internal_name))
  72         {
  73             $win16api->found_shared_internal_function($internal_name);
  74             $win32api->found_shared_internal_function($internal_name);
  75         }
  76     }
  77 }
  78
  79
  80 sub new($$$) {
  81     my $proto = shift;
  82     my $class = ref($proto) || $proto;
  83     my $self  = {};
  84     bless ($self, $class);
  85
  86     my $name = \${$self->{NAME}};
  87     my $function_forward = \%{$self->{FUNCTION_FORWARD}};
  88     my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
  89     my $function_module = \%{$self->{FUNCTION_MODULE}};
  90
  91     $$name = shift;
  92     my $refspec_files = shift;
  93
  94     foreach my $file (@$refspec_files) {
  95         $self->parse_spec_file("$wine_dir/$file");
  96     }
  97
  98     $self->parse_api_file("$$name.api");
  99
 100     foreach my $module (sort(keys(%$function_forward))) {
 101         foreach my $external_name (sort(keys(%{$$function_forward{$module}}))) {
 102             (my $forward_module, my $forward_external_name) = @{$$function_forward{$module}{$external_name}};
 103             my $forward_internal_name = $$function_internal_name{$forward_external_name};
 104             if(defined($forward_internal_name)) {
 105                 $$function_module{$forward_internal_name} .= " & $module";
 106             }
 107         }
 108     }
 109
 110     return $self;
 111 }
 112
 113 sub win16api() {
 114     return $win16api;
 115 }
 116
 117 sub win32api() {
 118     return $win32api;
 119 }
 120
 121 sub parse_api_file($$) {
 122     my $self = shift;
 123
 124     my $allowed_kind = \%{$self->{ALLOWED_KIND}};
 125     my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
 126     my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
 127     my $allowed_modules_unlimited = \%{$self->{ALLOWED_MODULES_UNLIMITED}};
 128     my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
 129     my $type_format = \%{$self->{TYPE_FORMAT}};
 130
 131     my $file = shift;
 132
 133     my $module;
 134     my $kind;
 135     my $format;
 136     my $forbidden = 0;
 137
 138     $output->lazy_progress("$file");
 139
 140     open(IN, "< $winapi_dir/$file") || die "$winapi_dir/$file: $!\n";
 141     $/ = "\n";
 142     my $linenum=0;
 143     while(<IN>) {
 144         $linenum++;
 145         s/^\s*?(.*?)\s*$/$1/; # remove whitespace at begin and end of line
 146         s/^(.*?)\s*#.*$/$1/;  # remove comments
 147         /^$/ && next;         # skip empty lines
 148
 149         if(/^%%(\S+)$/) {
 150             $module = $1;
 151             $module =~ s/\.dll$//; # FIXME: Kludge
 152         } elsif(!$modules->is_allowed_module($module)) {
 153             # Nothing
 154         } elsif(s/^%(\S+)\s*//) {
 155             $kind = $1;
 156             $format = undef;
 157             $forbidden = 0;
 158
 159             $$allowed_kind{$kind} = 1;
 160             if(/^--forbidden/) {
 161                 $forbidden = 1;
 162             } elsif(/^--format=(\".*?\"|\S*)/) {
 163                 $format = $1;
 164                 $format =~ s/^\"(.*?)\"$/$1/;
 165             }
 166
 167             if(!defined($format)) {
 168                 if($kind eq "long") {
 169                     $format  = "%d|%u|%x|%X|";
 170                     $format .= "%hd|%hu|%hx|%hX|";
 171                     $format .= "%ld|%lu|%lx|%lX|";
 172                     $format .= "%04x|%04X|0x%04x|0x%04X|";
 173                     $format .= "%08x|%08X|0x%08x|0x%08X|";
 174                     $format .= "%08lx|%08lX|0x%08lx|0x%08lX";
 175                 } elsif($kind eq "longlong") {
 176                     $format = "%lld";
 177                 } elsif($kind eq "ptr") {
 178                     $format = "%p";
 179                 } elsif($kind eq "segptr") {
 180                     $format = "%p";
 181                 } elsif($kind eq "str") {
 182                     $format = "%p|%s";
 183                 } elsif($kind eq "wstr") {
 184                     $format = "%p|%s";
 185                 } elsif($kind eq "word") {
 186                     $format  = "%d|%u|%x|%X|";
 187                     $format .= "%hd|%hu|%hx|%hX|";
 188                     $format .= "%04x|%04X|0x%04x|0x%04X";
 189                 } else {
 190                     $format = "<unknown>";
 191                 }
 192             }
 193         } elsif(defined($kind)) {
 194             my $type = $_;
 195             if ($type =~ /^long\b/)
 196             {
 197                 $output->write("$file:$linenum: type ($type) is not Win64 compatible\n");
 198             }
 199             if(!$forbidden) {
 200                 if(defined($module)) {
 201                     if($$allowed_modules_unlimited{$type}) {
 202                         $output->write("$file:$linenum: type ($type) already specified as an unlimited type\n");
 203                     } elsif(!$$allowed_modules{$type}{$module}) {
 204                         $$allowed_modules{$type}{$module} = 1;
 205                         $$allowed_modules_limited{$type} = 1;
 206                     } else {
 207                         $output->write("$file:$linenum: type ($type) already specified\n");
 208                     }
 209                 } else {
 210                     $$allowed_modules_unlimited{$type} = 1;
 211                 }
 212             } else {
 213                 $$allowed_modules_limited{$type} = 1;
 214             }
 215             if(defined($$translate_argument{$type}) && $$translate_argument{$type} ne $kind) {
 216                 $output->write("$file:$linenum: type ($type) respecified as different kind ($kind != $$translate_argument{$type})\n");
 217             } else {
 218                 $$translate_argument{$type} = $kind;
 219             }
 220
 221             $$type_format{$module}{$type} = $format;
 222         } else {
 223             $output->write("$file:$linenum: file must begin with %<type> statement\n");
 224             exit 1;
 225         }
 226     }
 227     close(IN);
 228 }
 229
 230 sub parse_spec_file($$) {
 231     my $self = shift;
 232
 233     my $function_internal_arguments = \%{$self->{FUNCTION_INTERNAL_ARGUMENTS}};
 234     my $function_external_arguments = \%{$self->{FUNCTION_EXTERNAL_ARGUMENTS}};
 235     my $function_internal_ordinal = \%{$self->{FUNCTION_INTERNAL_ORDINAL}};
 236     my $function_external_ordinal = \%{$self->{FUNCTION_EXTERNAL_ORDINAL}};
 237     my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
 238     my $function_external_calling_convention = \%{$self->{FUNCTION_EXTERNAL_CALLING_CONVENTION}};
 239     my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
 240     my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
 241     my $function_forward = \%{$self->{FUNCTION_FORWARD}};
 242     my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
 243     my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
 244     my $function_wine_extension = \%{$self->{FUNCTION_WINE_EXTENSION}};
 245     my $modules = \%{$self->{MODULES}};
 246     my $module_files = \%{$self->{MODULE_FILES}};
 247     my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
 248
 249     my $file = shift;
 250     $file =~ s%^\./%%;
 251
 252     my %ordinals;
 253     my $module;
 254     my $wine_extension = 0;
 255
 256     $output->lazy_progress("$file");
 257
 258     $module = $file;
 259     $module =~ s/^.*?([^\/]*)\.spec$/$1/;
 260
 261     open(IN, "< $file") || die "$file: $!\n";
 262     $/ = "\n";
 263     my $header = 1;
 264     my $lookahead = 0;
 265     while($lookahead || defined($_ = <IN>)) {
 266         $lookahead = 0;
 267         s/^\s*(.*?)\s*$/$1/;
 268         if(s/^(.*?)\s*\#\s*(.*)\s*$/$1/) {
 269             my $comment = $2;
 270             if ($comment =~ /^Wine/i) { # FIXME: Kludge
 271                 $wine_extension = 1;
 272             }
 273         }
 274         /^$/ && next;
 275
 276         if($header)  {
 277             if(/^\d+|@/) { $header = 0; $lookahead = 1; }
 278             next;
 279         }
 280
 281         my $ordinal;
 282         if(/^(\d+|@)\s+
 283            (pascal|stdcall|cdecl|varargs)\s+
 284            ((?:(?:-noname|-norelay|-i386|-ret16|-ret64|-register|-interrupt|-private)\s+)*)(\S+)\s*\(\s*(.*?)\s*\)\s*(\S*)$/x)
 285         {
 286             my $calling_convention = $2;
 287             my $flags = $3;
 288             my $external_name = $4;
 289             my $arguments = $5;
 290             my $internal_name = $6;
 291
 292             $ordinal = $1;
 293
 294             $flags =~ s/\s+/ /g;
 295
 296             $internal_name = $external_name if !$internal_name;
 297
 298             if($flags =~ /-noname/) {
 299                 # $external_name = "@";
 300             }
 301
 302             if($flags =~ /(?:-register|-interrupt)/) {
 303                 if($arguments) { $arguments .= " "; }
 304                 $arguments .= "ptr";
 305                 $calling_convention .= " -register";
 306             }
 307
 308             if ($internal_name =~ /^(.*?)\.(.*?)$/) {
 309                 my $forward_module = lc($1);
 310                 my $forward_name = $2;
 311
 312                 if (0) {
 313                     $calling_convention .= " -forward";
 314                 } else {
 315                     $calling_convention = "forward";
 316                 }
 317
 318                 $$function_forward{$module}{$external_name} = [$forward_module, $forward_name];
 319             }
 320
 321             if($external_name ne "@") {
 322                 $$module_external_calling_convention{$module}{$external_name} = $calling_convention;
 323             } else {
 324                 $$module_external_calling_convention{$module}{"\@$ordinal"} = $calling_convention;
 325             }
 326             if(!$$function_internal_name{$external_name}) {
 327                 $$function_internal_name{$external_name} = $internal_name;
 328             } else {
 329                 $$function_internal_name{$external_name} .= " & $internal_name";
 330             }
 331             if(!$$function_external_name{$internal_name}) {
 332                 $$function_external_name{$internal_name} = $external_name;
 333             } else {
 334                 $$function_external_name{$internal_name} .= " & $external_name";
 335             }
 336             $$function_internal_arguments{$internal_name} = $arguments;
 337             $$function_external_arguments{$external_name} = $arguments;
 338             if(!$$function_internal_ordinal{$internal_name}) {
 339                 $$function_internal_ordinal{$internal_name} = $ordinal;
 340             } else {
 341                 $$function_internal_ordinal{$internal_name} .= " & $ordinal";
 342             }
 343             if(!$$function_external_ordinal{$external_name}) {
 344                 $$function_external_ordinal{$external_name} = $ordinal;
 345             } else {
 346                 $$function_external_ordinal{$external_name} .= " & $ordinal";
 347             }
 348             $$function_internal_calling_convention{$internal_name} = $calling_convention;
 349             $$function_external_calling_convention{$external_name} = $calling_convention;
 350             if(!$$function_internal_module{$internal_name}) {
 351                 $$function_internal_module{$internal_name} = "$module";
 352             } else {
 353                 $$function_internal_module{$internal_name} .= " & $module";
 354             }
 355             if(!$$function_external_module{$external_name}) {
 356                 $$function_external_module{$external_name} = "$module";
 357             } else {
 358                 $$function_external_module{$external_name} .= " & $module";
 359             }
 360             $$function_wine_extension{$module}{$external_name} = $wine_extension;
 361
 362             if(0 && $options->spec_mismatch) {
 363                 if($external_name eq "@") {
 364                     if($internal_name !~ /^\U$module\E_$ordinal$/) {
 365                         $output->write("$file: $external_name: the internal name ($internal_name) mismatch\n");
 366                     }
 367                 } else {
 368                     my $name = $external_name;
 369
 370                     my $name1 = $name;
 371                     $name1 =~ s/^Zw/Nt/;
 372
 373                     my $name2 = $name;
 374                     $name2 =~ s/^(?:_|Rtl|k32|K32)//;
 375
 376                     my $name3 = $name;
 377                     $name3 =~ s/^INT_Int[0-9a-f]{2}Handler$/BUILTIN_DefaultIntHandler/;
 378
 379                     my $name4 = $name;
 380                     $name4 =~ s/^(VxDCall)\d$/$1/;
 381
 382                     # FIXME: This special case is becuase of a very ugly kludge that should be fixed IMHO
 383                     my $name5 = $name;
 384                     $name5 =~ s/^(.*?16)_(.*?)$/$1_fn$2/;
 385
 386                     if(uc($internal_name) ne uc($external_name) &&
 387                        $internal_name !~ /(\Q$name\E|\Q$name1\E|\Q$name2\E|\Q$name3\E|\Q$name4\E|\Q$name5\E)/)
 388                     {
 389                         $output->write("$file: $external_name: internal name ($internal_name) mismatch\n");
 390                     }
 391                 }
 392             }
 393         } elsif(/^(\d+|@)\s+stub(?:\s+(-noname|-norelay|-i386|-ret16|-ret64|-private))?\s+(\S+)$/) {
 394             $ordinal = $1;
 395
 396             my $flags = $2;
 397             my $external_name = $3;
 398
 399             $flags = "" if !defined($flags);
 400
 401             if($flags =~ /-noname/) {
 402                 # $external_name = "@";
 403             }
 404
 405             my $internal_name = $external_name;
 406
 407             if ($external_name ne "@") {
 408                 $$module_external_calling_convention{$module}{$external_name} = "stub";
 409             } else {
 410                 $$module_external_calling_convention{$module}{"\@$ordinal"} = "stub";
 411             }
 412             if(!$$function_internal_name{$external_name}) {
 413                 $$function_internal_name{$external_name} = $internal_name;
 414             } else {
 415                 $$function_internal_name{$external_name} .= " & $internal_name";
 416             }
 417             if(!$$function_external_name{$internal_name}) {
 418                 $$function_external_name{$internal_name} = $external_name;
 419             } else {
 420                 $$function_external_name{$internal_name} .= " & $external_name";
 421             }
 422             if(!$$function_internal_ordinal{$internal_name}) {
 423                 $$function_internal_ordinal{$internal_name} = $ordinal;
 424             } else {
 425                 $$function_internal_ordinal{$internal_name} .= " & $ordinal";
 426             }
 427             if(!$$function_external_ordinal{$external_name}) {
 428                 $$function_external_ordinal{$external_name} = $ordinal;
 429             } else {
 430                 $$function_external_ordinal{$external_name} .= " & $ordinal";
 431             }
 432             if(!$$function_internal_module{$internal_name}) {
 433                 $$function_internal_module{$internal_name} = "$module";
 434             } else { # if($$function_internal_module{$internal_name} !~ /$module/) {
 435                 $$function_internal_module{$internal_name} .= " & $module";
 436             }
 437             if(!$$function_external_module{$external_name}) {
 438                 $$function_external_module{$external_name} = "$module";
 439             } else { # if($$function_external_module{$external_name} !~ /$module/) {
 440                 $$function_external_module{$external_name} .= " & $module";
 441             }
 442         } elsif(/^(\d+|@)\s+extern(?:\s+(?:-norelay|-i386|-ret16|-ret64))?\s+(\S+)\s*(\S*)$/) {
 443             $ordinal = $1;
 444
 445             my $external_name = $2;
 446             my $internal_name = $3;
 447
 448             $internal_name = $external_name if !$internal_name;
 449
 450             if ($external_name ne "@") {
 451                 $$module_external_calling_convention{$module}{$external_name} = "extern";
 452             } else {
 453                 $$module_external_calling_convention{$module}{"\@$ordinal"} = "extern";
 454             }
 455         } elsif(/^(?:\d+|@)\s+(?:equate|variable)/) {
 456             # ignore
 457         } else {
 458             my $next_line = <IN>;
 459             if(!defined($next_line) || $next_line =~ /^\s*\d|@/) {
 460                 die "$file: $.: syntax error: '$_'\n";
 461             } else {
 462                 $_ .= $next_line;
 463                 $lookahead = 1;
 464             }
 465         }
 466
 467         if(defined($ordinal)) {
 468             if($ordinal ne "@" && $ordinals{$ordinal}) {
 469                 $output->write("$file: ordinal redefined: $_\n");
 470             }
 471             $ordinals{$ordinal}++;
 472         }
 473     }
 474     close(IN);
 475
 476     $$modules{$module}++;
 477
 478     $$module_files{$module} = $file;
 479 }
 480
 481 sub name($) {
 482     my $self = shift;
 483     my $name = \${$self->{NAME}};
 484
 485     return $$name;
 486 }
 487
 488 sub is_allowed_kind($$) {
 489     my $self = shift;
 490     my $allowed_kind = \%{$self->{ALLOWED_KIND}};
 491
 492     my $kind = shift;
 493     if(defined($kind)) {
 494         return $$allowed_kind{$kind};
 495     } else {
 496         return 0;
 497     }
 498
 499 }
 500
 501 sub allow_kind($$) {
 502     my $self = shift;
 503     my $allowed_kind = \%{$self->{ALLOWED_KIND}};
 504
 505     my $kind = shift;
 506
 507     $$allowed_kind{$kind}++;
 508 }
 509
 510 sub is_limited_type($$) {
 511     my $self = shift;
 512     my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
 513
 514     my $type = shift;
 515
 516     return $$allowed_modules_limited{$type};
 517 }
 518
 519 sub is_allowed_type_in_module($$) {
 520     my $self = shift;
 521     my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
 522     my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
 523
 524     my $type = shift;
 525     my @modules = split(/ \& /, shift);
 526
 527     if(!$$allowed_modules_limited{$type}) { return 1; }
 528
 529     foreach my $module (@modules) {
 530         if($$allowed_modules{$type}{$module}) { return 1; }
 531     }
 532
 533     return 0;
 534 }
 535
 536 sub allow_type_in_module($$) {
 537     my $self = shift;
 538     my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
 539
 540     my $type = shift;
 541     my @modules = split(/ \& /, shift);
 542
 543     foreach my $module (@modules) {
 544         $$allowed_modules{$type}{$module}++;
 545     }
 546 }
 547
 548 sub type_used_in_module($$) {
 549     my $self = shift;
 550     my $used_modules = \%{$self->{USED_MODULES}};
 551
 552     my $type = shift;
 553     my @modules = split(/ \& /, shift);
 554
 555     foreach my $module (@modules) {
 556         $$used_modules{$type}{$module} = 1;
 557     }
 558
 559     return ();
 560 }
 561
 562 sub types_not_used($) {
 563     my $self = shift;
 564     my $used_modules = \%{$self->{USED_MODULES}};
 565     my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
 566
 567     my $not_used;
 568     foreach my $type (sort(keys(%$allowed_modules))) {
 569         foreach my $module (sort(keys(%{$$allowed_modules{$type}}))) {
 570             if(!$$used_modules{$type}{$module}) {
 571                 $$not_used{$module}{$type} = 1;
 572             }
 573         }
 574     }
 575     return $not_used;
 576 }
 577
 578 sub types_unlimited_used_in_modules($) {
 579     my $self = shift;
 580
 581     my $used_modules = \%{$self->{USED_MODULES}};
 582     my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
 583     my $allowed_modules_unlimited = \%{$self->{ALLOWED_MODULES_UNLIMITED}};
 584
 585     my $used_types;
 586     foreach my $type (sort(keys(%$allowed_modules_unlimited))) {
 587         my $count = 0;
 588         my @modules = ();
 589         foreach my $module (sort(keys(%{$$used_modules{$type}}))) {
 590             $count++;
 591             push @modules, $module;
 592         }
 593         if($count) {
 594             foreach my $module (@modules) {
 595               $$used_types{$type}{$module} = 1;
 596             }
 597         }
 598     }
 599     return $used_types;
 600 }
 601
 602 sub translate_argument($$) {
 603     my $self = shift;
 604     my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
 605
 606     my $type = shift;
 607
 608     return $$translate_argument{$type};
 609 }
 610
 611 sub declare_argument($$$) {
 612     my $self = shift;
 613     my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
 614
 615     my $type = shift;
 616     my $kind = shift;
 617
 618     $$translate_argument{$type} = $kind;
 619 }
 620
 621 sub all_declared_types($) {
 622     my $self = shift;
 623     my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
 624
 625     return sort(keys(%$translate_argument));
 626 }
 627
 628 sub is_allowed_type_format($$$$) {
 629     my $self = shift;
 630     my $type_format = \%{$self->{TYPE_FORMAT}};
 631
 632     my $module = shift;
 633     my $type = shift;
 634     my $format = shift;
 635
 636     my $formats;
 637
 638     if(defined($module) && defined($type)) {
 639         local $_;
 640         foreach (split(/ & /, $module)) {
 641             if(defined($formats)) {
 642                 $formats .= "|";
 643             } else {
 644                 $formats = "";
 645             }
 646             if(defined($$type_format{$_}{$type})) {
 647                 $formats .= $$type_format{$_}{$type};
 648             }
 649         }
 650     }
 651
 652     if(defined($formats)) {
 653         local $_;
 654         foreach (split(/\|/, $formats)) {
 655             if($_ eq $format) {
 656                 return 1;
 657             }
 658         }
 659     }
 660
 661     return 0;
 662 }
 663
 664 sub all_modules($) {
 665     my $self = shift;
 666     my $modules = \%{$self->{MODULES}};
 667
 668     return sort(keys(%$modules));
 669 }
 670
 671 sub is_module($$) {
 672     my $self = shift;
 673     my $modules = \%{$self->{MODULES}};
 674
 675     my $name = shift;
 676
 677     return $$modules{$name};
 678 }
 679
 680 sub module_file($$) {
 681     my $self = shift;
 682
 683     my $module = shift;
 684
 685     my $module_files = \%{$self->{MODULE_FILES}};
 686
 687     return $$module_files{$module};
 688 }
 689
 690 sub all_internal_functions($) {
 691     my $self = shift;
 692     my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
 693
 694     return sort(keys(%$function_internal_calling_convention));
 695 }
 696
 697 sub all_internal_functions_in_module($$) {
 698     my $self = shift;
 699     my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
 700     my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
 701
 702     my $module = shift;
 703
 704     my @names;
 705     foreach my $name (keys(%$function_internal_calling_convention)) {
 706         if($$function_internal_module{$name} eq $module) {
 707             push @names, $name;
 708         }
 709     }
 710
 711     return sort(@names);
 712 }
 713
 714 sub all_external_functions($) {
 715     my $self = shift;
 716     my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
 717
 718     return sort(keys(%$function_external_name));
 719 }
 720
 721 sub all_external_functions_in_module($$) {
 722     my $self = shift;
 723     my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
 724     my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
 725
 726     my $module = shift;
 727
 728     my @names;
 729     foreach my $name (keys(%$function_external_name)) {
 730         if($$function_external_module{$name} eq $module) {
 731             push @names, $name;
 732         }
 733     }
 734
 735     return sort(@names);
 736 }
 737
 738 sub all_functions_in_module($$) {
 739     my $self = shift;
 740     my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
 741
 742     my $module = shift;
 743
 744     return sort(keys(%{$$module_external_calling_convention{$module}}));
 745 }
 746
 747 sub all_broken_forwards($) {
 748     my $self = shift;
 749     my $function_forward = \%{$self->{FUNCTION_FORWARD}};
 750
 751     my @broken_forwards = ();
 752     foreach my $module (sort(keys(%$function_forward))) {
 753         foreach my $external_name (sort(keys(%{$$function_forward{$module}}))) {
 754             (my $forward_module, my $forward_external_name) = @{$$function_forward{$module}{$external_name}};
 755
 756             my $forward_external_calling_convention =
 757                 $self->function_external_calling_convention_in_module($forward_module, $forward_external_name);
 758
 759             if(!defined($forward_external_calling_convention)) {
 760                 push @broken_forwards, [$module, $external_name, $forward_module, $forward_external_name];
 761             }
 762         }
 763     }
 764     return @broken_forwards;
 765 }
 766
 767
 768 sub function_internal_ordinal($$) {
 769     my $self = shift;
 770     my $function_internal_ordinal = \%{$self->{FUNCTION_INTERNAL_ORDINAL}};
 771
 772     my $name = shift;
 773
 774     return $$function_internal_ordinal{$name};
 775 }
 776
 777 sub function_external_ordinal($$) {
 778     my $self = shift;
 779     my $function_external_ordinal = \%{$self->{FUNCTION_EXTERNAL_ORDINAL}};
 780
 781     my $name = shift;
 782
 783     return $$function_external_ordinal{$name};
 784 }
 785
 786 sub function_internal_calling_convention($$) {
 787     my $self = shift;
 788     my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
 789
 790     my $name = shift;
 791
 792     return $$function_internal_calling_convention{$name};
 793 }
 794
 795 sub function_external_calling_convention($$) {
 796     my $self = shift;
 797     my $function_external_calling_convention = \%{$self->{FUNCTION_EXTERNAL_CALLING_CONVENTION}};
 798
 799     my $name = shift;
 800
 801     return $$function_external_calling_convention{$name};
 802 }
 803
 804 sub function_external_calling_convention_in_module($$$) {
 805     my $self = shift;
 806     my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
 807
 808     my $module = shift;
 809     my $name = shift;
 810
 811     return $$module_external_calling_convention{$module}{$name};
 812 }
 813
 814 sub function_internal_name($$) {
 815     my $self = shift;
 816     my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
 817
 818     my $name = shift;
 819
 820     return $$function_internal_name{$name};
 821 }
 822
 823 sub function_external_name($$) {
 824     my $self = shift;
 825     my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
 826
 827     my $name = shift;
 828
 829     return $$function_external_name{$name};
 830 }
 831
 832 sub function_forward_final_destination($$$) {
 833     my $self = shift;
 834
 835     my $function_forward = \%{$self->{FUNCTION_FORWARD}};
 836
 837     my $module = shift;
 838     my $name = shift;
 839
 840     my $forward_module = $module;
 841     my $forward_name = $name;
 842     while(defined(my $forward = $$function_forward{$forward_module}{$forward_name})) {
 843         ($forward_module, $forward_name) = @$forward;
 844     }
 845
 846     return ($forward_module, $forward_name);
 847 }
 848
 849 sub is_function($$) {
 850     my $self = shift;
 851     my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
 852
 853     my $name = shift;
 854
 855     return $$function_internal_calling_convention{$name};
 856 }
 857
 858 sub all_shared_internal_functions($$) {
 859     my $self = shift;
 860     my $function_shared = \%{$self->{FUNCTION_SHARED}};
 861
 862     return sort(keys(%$function_shared));
 863 }
 864
 865 sub is_shared_internal_function($$) {
 866     my $self = shift;
 867     my $function_shared = \%{$self->{FUNCTION_SHARED}};
 868
 869     my $name = shift;
 870
 871     return $$function_shared{$name};
 872 }
 873
 874 sub found_shared_internal_function($$) {
 875     my $self = shift;
 876     my $function_shared = \%{$self->{FUNCTION_SHARED}};
 877
 878     my $name = shift;
 879
 880     $$function_shared{$name} = 1;
 881 }
 882
 883 sub function_internal_arguments($$) {
 884     my $self = shift;
 885     my $function_internal_arguments = \%{$self->{FUNCTION_INTERNAL_ARGUMENTS}};
 886
 887     my $name = shift;
 888
 889     return $$function_internal_arguments{$name};
 890 }
 891
 892 sub function_external_arguments($$) {
 893     my $self = shift;
 894     my $function_external_arguments = \%{$self->{FUNCTION_EXTERNAL_ARGUMENTS}};
 895
 896     my $name = shift;
 897
 898     return $$function_external_arguments{$name};
 899 }
 900
 901 sub function_internal_module($$) {
 902     my $self = shift;
 903     my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
 904
 905     my $name = shift;
 906
 907     return $$function_internal_module{$name};
 908 }
 909
 910 sub function_external_module($$) {
 911     my $self = shift;
 912     my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
 913
 914     my $name = shift;
 915
 916     return $$function_external_module{$name};
 917 }
 918
 919 sub function_wine_extension($$$) {
 920     my $self = shift;
 921     my $function_wine_extension = \%{$self->{FUNCTION_WINE_EXTENSION}};
 922
 923     my $module = shift;
 924     my $name = shift;
 925
 926     return $$function_wine_extension{$module}{$name};
 927 }
 928
 929 sub is_function_stub($$$) {
 930     my $self = shift;
 931     my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
 932
 933     my $module = shift;
 934     my $name = shift;
 935
 936     if($$module_external_calling_convention{$module}{$name} eq "stub") {
 937         return 1;
 938     }
 939     return 0;
 940 }
 941
 942 sub is_function_stub_in_module($$$) {
 943     my $self = shift;
 944     my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
 945
 946     my $module = shift;
 947     my $name = shift;
 948
 949     if(!defined($$module_external_calling_convention{$module}{$name})) {
 950         return 0;
 951     }
 952     return $$module_external_calling_convention{$module}{$name} eq "stub";
 953 }
 954
 955 ########################################################################
 956 # class methods
 957 #
 958
 959 sub _get_all_module_internal_ordinal($$) {
 960     my $winapi = shift;
 961     my $internal_name = shift;
 962
 963     my @entries = ();
 964
 965     my @name = (); {
 966         my $name = $winapi->function_external_name($internal_name);
 967         if(defined($name)) {
 968             @name = split(/ & /, $name);
 969         }
 970     }
 971
 972     my @module = (); {
 973         my $module = $winapi->function_internal_module($internal_name);
 974         if(defined($module)) {
 975             @module = split(/ & /, $module);
 976         }
 977     }
 978
 979     my @ordinal = (); {
 980         my $ordinal = $winapi->function_internal_ordinal($internal_name);
 981         if(defined($ordinal)) {
 982             @ordinal = split(/ & /, $ordinal);
 983         }
 984     }
 985
 986     my $name;
 987     my $module;
 988     my $ordinal;
 989     while(defined($name = shift @name) &&
 990           defined($module = shift @module) &&
 991           defined($ordinal = shift @ordinal))
 992     {
 993         push @entries, [$name, $module, $ordinal];
 994     }
 995
 996     return @entries;
 997 }
 998
 999 sub get_all_module_internal_ordinal16($) {
1000     return _get_all_module_internal_ordinal($win16api, $_[0]);
1001 }
1002
1003 sub get_all_module_internal_ordinal32($) {
1004     return _get_all_module_internal_ordinal($win32api, $_[0]);
1005 }
1006
1007 sub get_all_module_internal_ordinal($) {
1008     my @entries = ();
1009     foreach my $winapi (@winapis) {
1010         push @entries, _get_all_module_internal_ordinal($winapi, $_[0]);
1011     }
1012
1013     return @entries;
1014 }
1015
1016 sub _get_all_module_external_ordinal($$) {
1017     my $winapi = shift;
1018     my $external_name = shift;
1019
1020     my @entries = ();
1021
1022     my @name = (); {
1023         my $name = $winapi->function_internal_name($external_name);
1024         if(defined($name)) {
1025             @name = split(/ & /, $name);
1026         }
1027     }
1028
1029     my @module = (); {
1030         my $module = $winapi->function_external_module($external_name);
1031         if(defined($module)) {
1032             @module = split(/ & /, $module);
1033         }
1034     }
1035
1036     my @ordinal = (); {
1037         my $ordinal = $winapi->function_external_ordinal($external_name);
1038         if(defined($ordinal)) {
1039             @ordinal = split(/ & /, $ordinal);
1040         }
1041     }
1042
1043     my $name;
1044     my $module;
1045     my $ordinal;
1046     while(defined($name = shift @name) &&
1047           defined($module = shift @module) &&
1048           defined($ordinal = shift @ordinal))
1049     {
1050         push @entries, [$name, $module, $ordinal];
1051     }
1052
1053     return @entries;
1054 }
1055
1056 sub get_all_module_external_ordinal16($) {
1057     return _get_all_module_external_ordinal($win16api, $_[0]);
1058 }
1059
1060 sub get_all_module_external_ordinal32($) {
1061     return _get_all_module_external_ordinal($win32api, $_[0]);
1062 }
1063
1064 sub get_all_module_external_ordinal($) {
1065     my @entries = ();
1066     foreach my $winapi (@winapis) {
1067         push @entries, _get_all_module_external_ordinal($winapi, $_[0]);
1068     }
1069
1070     return @entries;
1071 }
1072
1073 1;