winapi_extract 17.1 KB
Newer Older
1 2
#!/usr/bin/perl -w

3
# Copyright 2002 Patrik Stridvall
4 5 6 7 8 9 10 11 12 13 14 15 16
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
18
#
19 20 21 22 23 24 25 26 27

use strict;

BEGIN {
    $0 =~ m%^(.*?/?tools)/winapi/winapi_extract$%;
    require "$1/winapi/setup.pm";
}

use config qw(
28
    files_skip files_filter get_spec_files
29
    $current_dir $wine_dir $winapi_dir
30
);
31
use output qw($output);
32 33
use winapi_extract_options qw($options);

34 35 36 37 38 39
if($options->progress) {
    $output->enable_progress;
} else {
    $output->disable_progress;
}

40
use c_parser;
41 42
use function;
use type;
43 44

use winapi_function;
45

46
use vars qw($win16api $win32api @winapis);
47
if ($options->implemented || $options->stub_statistics || $options->winetest) {
48 49 50 51
    require winapi;
    import winapi qw($win16api $win32api @winapis);
}

52
my %module2entries;
53
my %module2spec_file;
54
if($options->winetest) {
55 56
    local $_;

57
    foreach my $spec_file (get_spec_files("winelib")) {
58 59
	my $entries = [];

Patrik Stridvall's avatar
Patrik Stridvall committed
60 61 62 63
	my $module = $spec_file;
	$module =~ s/^.*?([^\/]*)\.spec$/$1/;

	my $type = "win32";
64

65
	open(IN, "< $wine_dir/$spec_file") || die "Error: Can't open $wine_dir/$spec_file: $!\n";
66 67 68 69 70 71

	my $header = 1;
	my $lookahead = 0;
	while($lookahead || defined($_ = <IN>)) {
	    $lookahead = 0;

72
	    s/^\s*?(.*?)\s*$/$1/; # remove whitespace at beginning and end of line
73 74 75
	    s/^(.*?)\s*#.*$/$1/;  # remove comments
	    /^$/ && next;         # skip empty lines

76
	    if($header)  {
77
	        if(/^(?:\d+|@)/) {
78
		    $header = 0;
79
		    $lookahead = 1;
80 81 82 83
		}
		next;
	    }

84
	    if(/^(\d+|@)\s+stdcall\s+(\w+)\s*\(\s*([^\)]*)\s*\)/) {
85 86 87 88 89
		my $ordinal = $1;
		my $name = $2;
		my @args = split(/\s+/, $3);

		push @$entries, [$name, "undef", \@args];
90 91 92
	    }
	}
	close(IN);
93

Patrik Stridvall's avatar
Patrik Stridvall committed
94
	$module2spec_file{$module} = $spec_file;
95
	$module2entries{$module} = $entries;
96 97 98 99 100
    }
}

my %specifications;

101
sub documentation_specifications($) {
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
    my $function = shift;

    my @debug_channels = @{$function->debug_channels};
    my $documentation = $function->documentation;
    my $documentation_line = $function->documentation_line;
    my $return_type = $function->return_type;
    my $linkage = $function->linkage;
    my $internal_name = $function->internal_name;

    if($linkage eq "static") {
	return;
    }

    local $_;
    foreach (split(/\n/, $documentation)) {
	if(/^\s*\*\s*(\S+)\s*[\(\[]\s*(\w+)\s*\.\s*(\S+)\s*[\)\]]/) {
	    my $external_name = $1;
	    my $module = lc($2);
	    my $ordinal = $3;

	    if($ordinal eq "@") {
		if(1 || !exists($specifications{$module}{unfixed}{$external_name})) {
		    $specifications{$module}{unfixed}{$external_name}{ordinal} = $ordinal;
		    $specifications{$module}{unfixed}{$external_name}{external_name} = $external_name;
		    $specifications{$module}{unfixed}{$external_name}{function} = $function;
		} else {
		    $output->write("$external_name ($module.$ordinal) already exists\n");
		}
	    } elsif($ordinal =~ /^\d+$/) {
		if(1 || !exists($specifications{$module}{fixed}{$ordinal})) {
		    $specifications{$module}{fixed}{$ordinal}{ordinal} = $ordinal;
		    $specifications{$module}{fixed}{$ordinal}{external_name} = $external_name;
		    $specifications{$module}{fixed}{$ordinal}{function} = $function;
		    } else {
			$output->write("$external_name ($module.$ordinal) already exists\n");
		    }
	    } elsif($ordinal eq "init") {
		if(!exists($specifications{$module}{init})) {
		    $specifications{$module}{init}{function} = $function;
		} else {
		    $output->write("$external_name ($module.$ordinal) already exists\n");
		}
	    } else {
		if(!exists($specifications{$module}{unknown}{$external_name})) {
		    $specifications{$module}{unknown}{$external_name}{ordinal} = $ordinal;
		    $specifications{$module}{unknown}{$external_name}{external_name} = $external_name;
		    $specifications{$module}{unknown}{$external_name}{function} = $function;
		} else {
		    $output->write("$external_name ($module.$ordinal) already exists\n");
		}
	    }
153

154 155 156 157 158 159 160
	    if($options->debug) {
		$output->write("$external_name ($module.$ordinal)\n");
	    }
	}
    }
}

161
my %module_pseudo_stub;
162

163
sub statements_pseudo_stub($) {
164 165
    my $function = shift;

166
    my $pseudo_stub = 0;
167 168 169
    my $statements = $function->statements;
    if(defined($statements) && $statements =~ /FIXME[^;]*stub/s) {
	if($options->win16) {
170
	    my $external_name16 = $function->external_name16;
171
	    foreach my $module16 ($function->modules16) {
172
		$module_pseudo_stub{$module16}{$external_name16}++;
173
		$pseudo_stub = 1;
174 175 176
	    }
	}
	if($options->win32) {
177
	    my $external_name32 = $function->external_name32;
178
	    foreach my $module32 ($function->modules32) {
179
		$module_pseudo_stub{$module32}{$external_name32}++;
180
		$pseudo_stub = 1;
181 182 183
	    }
	}
    }
184 185

    return $pseudo_stub;
186 187
}

188 189 190 191 192 193 194
my @h_files = ();
if($options->headers) {
    @h_files = $options->h_files;
    @h_files = files_skip(@h_files);
    @h_files = files_filter("winelib", @h_files);
}

195
my @c_files = ();
196
if($options->pseudo_implemented || $options->pseudo_stub_statistics) {
197 198 199 200
    @c_files = $options->c_files;
    @c_files = files_skip(@c_files);
    @c_files = files_filter("winelib", @c_files);
}
201 202 203

my $progress_output;
my $progress_current = 0;
204
my $progress_max = scalar(@h_files) + scalar(@c_files);
205

206
foreach my $file (@h_files, @c_files) {
207
    my %functions;
208 209 210

    $progress_current++;

211
    {
212
	open(IN, "< $file") || die "Error: Can't open $file: $!\n";
213 214 215 216 217 218 219 220 221 222 223 224
	local $/ = undef;
	$_ = <IN>;
	close(IN);
    }

    my $max_line = 0;
    {
      local $_ = $_;
      while(s/^.*?\n//) { $max_line++; }
      if($_) { $max_line++; }
    }

225
    my $parser = new c_parser($file);
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

    my $function;
    my $line;

    my $update_output = sub {
	my $progress = "";
	my $prefix = "";

	$progress .= "$file (file $progress_current of $progress_max)";
	$prefix .= "$file:";

	if(defined($function)) {
	    my $name = $function->name;
	    my $begin_line = $function->begin_line;
	    my $begin_column = $function->begin_column;

	    $progress .= ": function $name";
	    $prefix .= "$begin_line.$begin_column: function $name: ";
244
	} else {
245
	    $prefix .= " "; 
246
	}
247 248 249 250 251 252 253

	if(defined($line)) {
	    $progress .= ": line $line of $max_line";
	}

	$output->progress($progress);
	$output->prefix($prefix);
254 255
    };

256 257
    &$update_output();

258
    my $found_function = sub {
259 260 261 262 263
	$function = shift;

	my $name = $function->name;
	$functions{$name} = $function;

264 265 266
	if ($function->statements) {
	    &$update_output();
	}
267 268

	my $old_function;
269
	if($options->implemented || $options->stub_statistics) {
270 271 272 273
	    $old_function = 'winapi_function'->new;
	} else {
	    $old_function = 'function'->new;
	}
274

275
	$old_function->file($function->file);
276
	$old_function->debug_channels([]); # FIXME: Not complete
277

278 279
	$old_function->documentation_line(0); # FIXME: Not complete
	$old_function->documentation(""); # FIXME: Not complete
280

281 282 283 284 285 286 287 288 289 290 291 292 293 294
	$old_function->function_line($function->begin_line());
	$old_function->linkage($function->linkage);
	$old_function->return_type($function->return_type);
	$old_function->calling_convention($function->calling_convention);
	$old_function->internal_name($function->name);
	if (defined($function->argument_types)) {
	    $old_function->argument_types([@{$function->argument_types}]);
	}
	if (defined($function->argument_names)) {
	    $old_function->argument_names([@{$function->argument_names}]);
	}
	$old_function->argument_documentations([]); # FIXME: Not complete
	$old_function->statements_line($function->statements_line);
	$old_function->statements($function->statements);
295

296
	if($options->winetest) {
297
	    documentation_specifications($old_function);
298 299
	}

300 301 302 303 304 305
	if ($function->statements) {
	    $function = undef;
	    &$update_output();
	} else {
	    $function = undef;
	}
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329

	my $pseudo_stub = 0;
	if ($options->pseudo_implemented || $options->pseudo_stub_statistics) {
	    $pseudo_stub = statements_pseudo_stub($old_function);
	}

	my $module = $old_function->module;
	my $external_name = $old_function->external_name;
	my $statements = $old_function->statements;
	if ($options->pseudo_implemented && $module && $external_name && $statements) {
	    my @external_names = split(/\s*&\s*/, $external_name);
	    my @modules = split(/\s*&\s*/, $module);

	    my @external_names2;
	    while(defined(my $external_name = shift @external_names) &&
		  defined(my $module = shift @modules))
	    {
		if ($pseudo_stub) {
		    $output->write("$module.$external_name: pseudo implemented\n");
		} else {
		    $output->write("$module.$external_name: implemented\n");
		}
	    }
	}
330
    };
331
    $parser->set_found_function_callback($found_function);
332

333 334 335 336 337 338 339
    my $found_line = sub {
	$line = shift;

	&$update_output;
    };
    $parser->set_found_line_callback($found_line);

340 341 342
    my $found_type = sub {
	my $type = shift;

343 344 345 346 347 348 349
	&$update_output();
	
	my $kind = $type->kind;
	my $_name = $type->_name;
	my $name = $type->name;
	
	foreach my $field ($type->fields) {
350 351
	    my $field_type_name = $field->type_name;
	    my $field_name = $field->name;
352

353
	    if ($options->struct && $kind =~ /^(?:struct|union)$/) {
354
		if ($name) {
355
		    $output->write("$name:$field_type_name:$field_name\n");
356
		} else {
357
		    $output->write("$kind $_name:$field_type_name:$field_name\n");
358 359 360 361 362
		}
	    }
	}

	return 1;
363
    };
364
    $parser->set_found_type_callback($found_type);
365

366 367 368 369 370 371
    {
	my $line = 1;
	my $column = 0;
	if(!$parser->parse_c_file(\$_, \$line, \$column)) {
	    $output->write("can't parse file\n");
	}
372
    }
373 374

    $output->prefix("");
375 376
}

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

if($options->implemented && !$options->pseudo_implemented) {
    foreach my $winapi (@winapis) {
	my $type = $winapi->name;

	if($type eq "win16" && !$options->win16) { next; }
	if($type eq "win32" && !$options->win32) { next; }

	foreach my $module ($winapi->all_modules) {
	    foreach my $external_name ($winapi->all_functions_in_module($module)) {
		 my $external_calling_convention =
		     $winapi->function_external_calling_convention_in_module($module, $external_name);

		 if($external_calling_convention eq "forward") {
		     (my $forward_module, my $forward_external_name) =
			 $winapi->function_forward_final_destination($module, $external_name);

		     my $forward_external_calling_convention =
			 $winapi->function_external_calling_convention_in_module($forward_module, $forward_external_name);

		     if(!defined($forward_external_calling_convention)) {
			 next;
		     }

		     $external_calling_convention = $forward_external_calling_convention;
		 }

		 if ($external_calling_convention ne "stub") {
		     $output->write("*.spec: $module.$external_name: implemented\n");
		 }
	    }
	}
    }
}

412
sub output_function($$$$$) {
413 414
    local *OUT = shift;
    my $type = shift;
415 416
    my $ordinal = shift;
    my $external_name = shift;
417 418
    my $function = shift;

419
    my $internal_name = $function->internal_name;
420 421 422

    my $return_kind;
    my $calling_convention;
423
    my $refargument_kinds;
424
    if($type eq "win16") {
425 426
	$return_kind = $function->return_kind16 || "undef";
	$calling_convention = $function->calling_convention16 || "undef";
427
	$refargument_kinds = $function->argument_kinds16;
428 429 430
    } elsif($type eq "win32") {
	$return_kind = $function->return_kind32 || "undef";
	$calling_convention = $function->calling_convention32 || "undef";
431
	$refargument_kinds = $function->argument_kinds32;
432
    }
433

434 435 436 437 438 439
    if(defined($refargument_kinds)) {
	my @argument_kinds = map { $_ || "undef"; } @$refargument_kinds;
	print OUT "$ordinal $calling_convention $external_name(@argument_kinds) $internal_name\n";
    } else {
	print OUT "$ordinal $calling_convention $external_name() $internal_name # FIXME: arguments undefined\n";
    }
440 441
}

442 443
if($options->stub_statistics) {
    foreach my $winapi (@winapis) {
Patrik Stridvall's avatar
Patrik Stridvall committed
444 445 446 447
	my $type = $winapi->name;

	if($type eq "win16" && !$options->win16) { next; }
	if($type eq "win32" && !$options->win32) { next; }
448

449 450 451 452 453
 	my %module_counts;
         foreach my $module ($winapi->all_modules) {
             foreach my $external_name ($winapi->all_functions_in_module($module)) {
		 my $external_calling_convention =
		     $winapi->function_external_calling_convention_in_module($module, $external_name);
454
		 if($external_calling_convention !~ /^(?:forward|stub)$/) {
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
		     if($module_pseudo_stub{$module}{$external_name}) {
			 $external_calling_convention = "pseudo_stub";
		     }
		 } elsif($external_calling_convention eq "forward") {
		     (my $forward_module, my $forward_external_name) =
			 $winapi->function_forward_final_destination($module, $external_name);

		     my $forward_external_calling_convention =
			 $winapi->function_external_calling_convention_in_module($forward_module, $forward_external_name);

		     if(!defined($forward_external_calling_convention)) {
			 next;
		     }

		     if($forward_external_calling_convention ne "stub" &&
			$module_pseudo_stub{$forward_module}{$forward_external_name})
		     {
			 $forward_external_calling_convention = "pseudo_stub";
		     }

		     $external_calling_convention = "forward_$forward_external_calling_convention";
		 }

		 $module_counts{$module}{$external_calling_convention}++;
	     }
	 }
481 482

	foreach my $module ($winapi->all_modules) {
483 484 485 486 487 488 489 490 491 492 493 494 495
 	    my $pseudo_stubs = $module_counts{$module}{pseudo_stub} || 0;
 	    my $real_stubs = $module_counts{$module}{stub} || 0;
 	    my $forward_pseudo_stubs = $module_counts{$module}{forward_pseudo_stub} || 0;
 	    my $forward_real_stubs = $module_counts{$module}{forward_stub} || 0;

 	    my $forwards = 0;
 	    my $total = 0;
	    foreach my $calling_convention (keys(%{$module_counts{$module}})) {
		my $count = $module_counts{$module}{$calling_convention};
		if($calling_convention =~ /^forward/) {
		    $forwards += $count;
		}
		$total += $count;
496 497
	    }

498 499
	    if($total > 0) {
		my $stubs = $real_stubs + $pseudo_stubs;
500

501 502 503 504
		$output->write("*.c: $module: ");
		$output->write("$stubs of $total functions are stubs ($real_stubs real, $pseudo_stubs pseudo) " .
			       "and $forwards are forwards\n");
	    }
505

506 507
	    if($forwards > 0) {
		my $forward_stubs = $forward_real_stubs + $forward_pseudo_stubs;
508

509 510 511 512
		$output->write("*.c: $module: ");
		$output->write("$forward_stubs of $forwards forwarded functions are stubs " .
			       "($forward_real_stubs real, $forward_pseudo_stubs pseudo)\n");
	    }
513
	}
514
    }
515 516
}

517
if($options->winetest) {
Patrik Stridvall's avatar
Patrik Stridvall committed
518 519
    foreach my $module ($win32api->all_modules) {
	my $type = "win32";
520

Patrik Stridvall's avatar
Patrik Stridvall committed
521 522 523
        my $package = $module;
	$package =~ s/\.dll$//;
        $package =~ s/\./_/g;
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543

	my @entries;

	foreach my $external_name (sort(keys(%{$specifications{$module}{unknown}}))) {
	    my $entry = $specifications{$module}{unknown}{$external_name};
	    push @entries, $entry;
	}

	foreach my $ordinal (sort {$a <=> $b} keys(%{$specifications{$module}{fixed}})) {
	    my $entry = $specifications{$module}{fixed}{$ordinal};
	    push @entries, $entry;
	}

	foreach my $external_name (sort(keys(%{$specifications{$module}{unfixed}}))) {
	    my $entry = $specifications{$module}{unfixed}{$external_name};
	    push @entries, $entry;
	}

	my $n = 0;
	foreach my $entry (@entries) {
544 545 546
	    my $external_name = $entry->{external_name};
	    my $ordinal = $entry->{ordinal};
	    my $function = $entry->{function};
547

Patrik Stridvall's avatar
Patrik Stridvall committed
548 549 550
	    my $return_kind = $function->return_kind32 || "undef";
	    my $calling_convention = $function->calling_convention32 || "undef";
	    my $refargument_kinds = $function->argument_kinds32;
551 552 553 554 555 556 557 558 559 560

	    my @argument_kinds;
	    if(defined($refargument_kinds)) {
		@argument_kinds = map { $_ || "undef"; } @$refargument_kinds;
	    }

	    next if $calling_convention ne "stdcall";
	    next if $external_name eq "\@";

	    if($n == 0) {
561
                open(OUT, "> $wine_dir/programs/winetest/include/${package}.pm") || die "Error: Can't open $wine_dir/programs/winetest/include/${package}.pm: $!\n";
562

Patrik Stridvall's avatar
Patrik Stridvall committed
563
                print OUT "package ${package};\n";
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
                print OUT "\n";

                print OUT "use strict;\n";
                print OUT "\n";

                print OUT "require Exporter;\n";
                print OUT "\n";

                print OUT "use wine;\n";
                print OUT "use vars qw(\@ISA \@EXPORT \@EXPORT_OK);\n";
                print OUT "\n";

                print OUT "\@ISA = qw(Exporter);\n";
                print OUT "\@EXPORT = qw();\n";
                print OUT "\@EXPORT_OK = qw();\n";
                print OUT "\n";

                print OUT "my \$module_declarations = {\n";
	    } elsif($n > 0) {
		print OUT ",\n";
	    }

	    print OUT "    \"\Q$external_name\E\" => [\"$return_kind\",  [";
	    my $m = 0;
	    foreach my $argument_kind (@argument_kinds) {
		if($m > 0) {
		    print OUT ", ";
		}
		print OUT "\"$argument_kind\"";
		$m++;
	    }
	    print OUT "]]";
	    $n++;
	}

	if($n > 0) {
	    print OUT "\n";
	    print OUT "};\n";
	    print OUT "\n";
Patrik Stridvall's avatar
Patrik Stridvall committed
603
            print OUT "&wine::declare(\"$module\",\%\$module_declarations);\n";
604 605 606 607 608 609
            print OUT "push \@EXPORT, map { \"&\" . \$_; } sort(keys(\%\$module_declarations));\n";
	    print OUT "1;\n";
            close(OUT);
	}
    }
}