2 # Copyright 1999, 2000, 2001 Patrik Stridvall
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.
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.
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
23 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
28 @EXPORT_OK = qw($win16api $win32api @winapis);
30 use vars qw($win16api $win32api @winapis);
32 use config qw($current_dir $wine_dir $winapi_dir);
33 use modules qw($modules);
34 use options qw($options);
35 use output qw($output);
37 my @spec_files16 = $modules->allowed_spec_files16;
38 $win16api = 'winapi'->new("win16", \@spec_files16);
40 my @spec_files32 = $modules->allowed_spec_files32;
41 $win32api = 'winapi'->new("win32", \@spec_files32);
43 @winapis = ($win16api, $win32api);
45 for my $internal_name ($win32api->all_internal_functions) {
46 my $module16 = $win16api->function_internal_module($internal_name);
47 my $module32 = $win16api->function_internal_module($internal_name);
48 if(defined($module16) &&
49 !$win16api->is_function_stub_in_module($module16, $internal_name) &&
50 !$win32api->is_function_stub_in_module($module32, $internal_name))
52 $win16api->found_shared_internal_function($internal_name);
53 $win32api->found_shared_internal_function($internal_name);
59 my $class = ref($proto) || $proto;
61 bless ($self, $class);
63 my $name = \${$self->{NAME}};
64 my $function_forward = \%{$self->{FUNCTION_FORWARD}};
65 my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
66 my $function_module = \%{$self->{FUNCTION_MODULE}};
69 my $refspec_files = shift;
71 foreach my $file (@$refspec_files) {
72 $self->parse_spec_file("$wine_dir/$file");
75 $self->parse_api_file("$$name.api");
77 foreach my $module (sort(keys(%$function_forward))) {
78 foreach my $external_name (sort(keys(%{$$function_forward{$module}}))) {
79 (my $forward_module, my $forward_external_name) = @{$$function_forward{$module}{$external_name}};
80 my $forward_internal_name = $$function_internal_name{$forward_external_name};
81 if(defined($forward_internal_name)) {
82 $$function_module{$forward_internal_name} .= " & $module";
101 my $allowed_kind = \%{$self->{ALLOWED_KIND}};
102 my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
103 my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
104 my $allowed_modules_unlimited = \%{$self->{ALLOWED_MODULES_UNLIMITED}};
105 my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
106 my $type_format = \%{$self->{TYPE_FORMAT}};
116 $output->lazy_progress("$file");
118 open(IN, "< $winapi_dir/$file") || die "$winapi_dir/$file: $!\n";
121 s/^\s*?(.*?)\s*$/$1/; # remove whitespace at begin and end of line
122 s/^(.*?)\s*#.*$/$1/; # remove comments
123 /^$/ && next; # skip empty lines
127 $module =~ s/\.dll$//; # FIXME: Kludge
128 } elsif(!$modules->is_allowed_module($module)) {
130 } elsif(s/^%(\S+)\s*//) {
136 $$allowed_kind{$kind} = 1;
139 } elsif(/^--extension/) {
141 } elsif(/^--format=(\".*?\"|\S*)/) {
143 $format =~ s/^\"(.*?)\"$/$1/;
146 if(!defined($format)) {
147 if($kind eq "long") {
148 $format = "%d|%u|%x|%X|";
149 $format .= "%hd|%hu|%hx|%hX|";
150 $format .= "%ld|%lu|%lx|%lX|";
151 $format .= "%04x|%04X|0x%04x|0x%04X|";
152 $format .= "%08x|%08X|0x%08x|0x%08X|";
153 $format .= "%08lx|%08lX|0x%08lx|0x%08lX";
154 } elsif($kind eq "longlong") {
156 } elsif($kind eq "ptr") {
158 } elsif($kind eq "segptr") {
160 } elsif($kind eq "str") {
162 } elsif($kind eq "wstr") {
164 } elsif($kind eq "word") {
165 $format = "%d|%u|%x|%X|";
166 $format .= "%hd|%hu|%hx|%hX|";
167 $format .= "%04x|%04X|0x%04x|0x%04X";
169 $format = "<unknown>";
172 } elsif(defined($kind)) {
175 if(defined($module)) {
176 if($$allowed_modules_unlimited{$type}) {
177 $output->write("$file: type ($type) already specificed as an unlimited type\n");
178 } elsif(!$$allowed_modules{$type}{$module}) {
179 $$allowed_modules{$type}{$module} = 1;
180 $$allowed_modules_limited{$type} = 1;
182 $output->write("$file: type ($type) already specificed\n");
185 $$allowed_modules_unlimited{$type} = 1;
188 $$allowed_modules_limited{$type} = 1;
190 if(defined($$translate_argument{$type}) && $$translate_argument{$type} ne $kind) {
191 $output->write("$file: type ($type) respecified as different kind ($kind != $$translate_argument{$type})\n");
193 $$translate_argument{$type} = $kind;
196 $$type_format{$module}{$type} = $format;
198 $output->write("$file: file must begin with %<type> statement\n");
205 sub parse_spec_file {
208 my $function_internal_arguments = \%{$self->{FUNCTION_INTERNAL_ARGUMENTS}};
209 my $function_external_arguments = \%{$self->{FUNCTION_EXTERNAL_ARGUMENTS}};
210 my $function_internal_ordinal = \%{$self->{FUNCTION_INTERNAL_ORDINAL}};
211 my $function_external_ordinal = \%{$self->{FUNCTION_EXTERNAL_ORDINAL}};
212 my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
213 my $function_external_calling_convention = \%{$self->{FUNCTION_EXTERNAL_CALLING_CONVENTION}};
214 my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
215 my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
216 my $function_forward = \%{$self->{FUNCTION_FORWARD}};
217 my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
218 my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
219 my $modules = \%{$self->{MODULES}};
220 my $module_files = \%{$self->{MODULE_FILES}};
221 my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
229 $output->lazy_progress("$file");
232 $module =~ s/^.*?([^\/]*)\.spec$/$1/;
235 open(IN, "< $file") || die "$file: $!\n";
239 while($lookahead || defined($_ = <IN>)) {
246 if(/^\d+|@/) { $header = 0; $lookahead = 1; }
252 (pascal|pascal16|stdcall|cdecl|varargs)\s+
253 ((?:(?:-noimport|-norelay|-i386|-ret64|-register|-interrupt)\s+)*)(\S+)\s*\(\s*(.*?)\s*\)\s*(\S+)$/x)
255 my $calling_convention = $2;
257 my $external_name = $4;
259 my $internal_name = $6;
265 if($flags =~ /(?:-register|-interrupt)/) {
266 if($arguments) { $arguments .= " "; }
270 if($external_name ne "@") {
271 $$module_external_calling_convention{$module}{$external_name} = $calling_convention;
273 $$module_external_calling_convention{$module}{"\@$ordinal"} = $calling_convention;
275 if(!$$function_internal_name{$external_name}) {
276 $$function_internal_name{$external_name} = $internal_name;
278 $$function_internal_name{$external_name} .= " & $internal_name";
280 if(!$$function_external_name{$internal_name}) {
281 $$function_external_name{$internal_name} = $external_name;
283 $$function_external_name{$internal_name} .= " & $external_name";
285 $$function_internal_arguments{$internal_name} = $arguments;
286 $$function_external_arguments{$external_name} = $arguments;
287 if(!$$function_internal_ordinal{$internal_name}) {
288 $$function_internal_ordinal{$internal_name} = $ordinal;
290 $$function_internal_ordinal{$internal_name} .= " & $ordinal";
292 if(!$$function_external_ordinal{$external_name}) {
293 $$function_external_ordinal{$external_name} = $ordinal;
295 $$function_external_ordinal{$external_name} .= " & $ordinal";
297 $$function_internal_calling_convention{$internal_name} = $calling_convention;
298 $$function_external_calling_convention{$external_name} = $calling_convention;
299 if(!$$function_internal_module{$internal_name}) {
300 $$function_internal_module{$internal_name} = "$module";
302 $$function_internal_module{$internal_name} .= " & $module";
304 if(!$$function_external_module{$external_name}) {
305 $$function_external_module{$external_name} = "$module";
307 $$function_external_module{$external_name} .= " & $module";
310 if(0 && $options->spec_mismatch) {
311 if($external_name eq "@") {
312 if($internal_name !~ /^\U$module\E_$ordinal$/) {
313 $output->write("$file: $external_name: the internal name ($internal_name) mismatch\n");
316 my $name = $external_name;
322 $name2 =~ s/^(?:_|Rtl|k32|K32)//;
325 $name3 =~ s/^INT_Int[0-9a-f]{2}Handler$/BUILTIN_DefaultIntHandler/;
328 $name4 =~ s/^(VxDCall)\d$/$1/;
330 # FIXME: This special case is becuase of a very ugly kludge that should be fixed IMHO
332 $name5 =~ s/^(.*?16)_(.*?)$/$1_fn$2/;
334 if(uc($internal_name) ne uc($external_name) &&
335 $internal_name !~ /(\Q$name\E|\Q$name1\E|\Q$name2\E|\Q$name3\E|\Q$name4\E|\Q$name5\E)/)
337 $output->write("$file: $external_name: internal name ($internal_name) mismatch\n");
341 } elsif(/^(\d+|@)\s+stub(?:\s+(?:-noimport|-norelay|-i386|-ret64))?\s+(\S+)$/) {
342 my $external_name = $2;
346 my $internal_name = $external_name;
348 if ($external_name ne "@") {
349 $$module_external_calling_convention{$module}{$external_name} = "stub";
351 $$module_external_calling_convention{$module}{"\@$ordinal"} = "stub";
353 if(!$$function_internal_name{$external_name}) {
354 $$function_internal_name{$external_name} = $internal_name;
356 $$function_internal_name{$external_name} .= " & $internal_name";
358 if(!$$function_external_name{$internal_name}) {
359 $$function_external_name{$internal_name} = $external_name;
361 $$function_external_name{$internal_name} .= " & $external_name";
363 if(!$$function_internal_ordinal{$internal_name}) {
364 $$function_internal_ordinal{$internal_name} = $ordinal;
366 $$function_internal_ordinal{$internal_name} .= " & $ordinal";
368 if(!$$function_external_ordinal{$external_name}) {
369 $$function_external_ordinal{$external_name} = $ordinal;
371 $$function_external_ordinal{$external_name} .= " & $ordinal";
373 if(!$$function_internal_module{$internal_name}) {
374 $$function_internal_module{$internal_name} = "$module";
375 } else { # if($$function_internal_module{$internal_name} !~ /$module/) {
376 $$function_internal_module{$internal_name} .= " & $module";
378 if(!$$function_external_module{$external_name}) {
379 $$function_external_module{$external_name} = "$module";
380 } else { # if($$function_external_module{$external_name} !~ /$module/) {
381 $$function_external_module{$external_name} .= " & $module";
383 } elsif(/^(\d+|@)\s+forward(?:\s+(?:-noimport|-norelay|-i386|-ret64))?\s+(\S+)\s+(\S+)\.(\S+)$/) {
386 my $external_name = $2;
387 my $forward_module = lc($3);
388 my $forward_name = $4;
390 if ($external_name ne "@") {
391 $$module_external_calling_convention{$module}{$external_name} = "forward";
393 $$module_external_calling_convention{$module}{"\@$ordinal"} = "forward";
395 $$function_forward{$module}{$external_name} = [$forward_module, $forward_name];
396 } elsif(/^(\d+|@)\s+extern\s+(\S+)\s+(\S+)$/) {
399 my $external_name = $2;
400 my $internal_name = $3;
402 if ($external_name ne "@") {
403 $$module_external_calling_convention{$module}{$external_name} = "extern";
405 $$module_external_calling_convention{$module}{"\@$ordinal"} = "extern";
407 } elsif(/^(\d+|@)\s+(equate|variable)/) {
410 my $next_line = <IN>;
411 if(!defined($next_line) || $next_line =~ /^\s*\d|@/) {
412 die "$file: $.: syntax error: '$_'\n";
419 if(defined($ordinal)) {
420 if($ordinal ne "@" && $ordinals{$ordinal}) {
421 $output->write("$file: ordinal redefined: $_\n");
423 $ordinals{$ordinal}++;
428 $$modules{$module}++;
430 $$module_files{$module} = $file;
435 my $name = \${$self->{NAME}};
440 sub is_allowed_kind {
442 my $allowed_kind = \%{$self->{ALLOWED_KIND}};
446 return $$allowed_kind{$kind};
455 my $allowed_kind = \%{$self->{ALLOWED_KIND}};
459 $$allowed_kind{$kind}++;
462 sub is_limited_type {
464 my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
468 return $$allowed_modules_limited{$type};
471 sub is_allowed_type_in_module {
473 my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
474 my $allowed_modules_limited = \%{$self->{ALLOWED_MODULES_LIMITED}};
477 my @modules = split(/ \& /, shift);
479 if(!$$allowed_modules_limited{$type}) { return 1; }
481 foreach my $module (@modules) {
482 if($$allowed_modules{$type}{$module}) { return 1; }
488 sub allow_type_in_module {
490 my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
493 my @modules = split(/ \& /, shift);
495 foreach my $module (@modules) {
496 $$allowed_modules{$type}{$module}++;
500 sub type_used_in_module {
502 my $used_modules = \%{$self->{USED_MODULES}};
505 my @modules = split(/ \& /, shift);
507 foreach my $module (@modules) {
508 $$used_modules{$type}{$module} = 1;
516 my $used_modules = \%{$self->{USED_MODULES}};
517 my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
520 foreach my $type (sort(keys(%$allowed_modules))) {
521 foreach my $module (sort(keys(%{$$allowed_modules{$type}}))) {
522 if(!$$used_modules{$type}{$module}) {
523 $$not_used{$module}{$type} = 1;
530 sub types_unlimited_used_in_modules {
533 my $used_modules = \%{$self->{USED_MODULES}};
534 my $allowed_modules = \%{$self->{ALLOWED_MODULES}};
535 my $allowed_modules_unlimited = \%{$self->{ALLOWED_MODULES_UNLIMITED}};
538 foreach my $type (sort(keys(%$allowed_modules_unlimited))) {
541 foreach my $module (sort(keys(%{$$used_modules{$type}}))) {
543 push @modules, $module;
546 foreach my $module (@modules) {
547 $$used_types{$type}{$module} = 1;
554 sub translate_argument {
556 my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
560 return $$translate_argument{$type};
563 sub declare_argument {
565 my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
570 $$translate_argument{$type} = $kind;
573 sub all_declared_types {
575 my $translate_argument = \%{$self->{TRANSLATE_ARGUMENT}};
577 return sort(keys(%$translate_argument));
580 sub is_allowed_type_format {
582 my $type_format = \%{$self->{TYPE_FORMAT}};
590 if(defined($module) && defined($type)) {
592 foreach (split(/ & /, $module)) {
593 if(defined($formats)) {
598 if(defined($$type_format{$_}{$type})) {
599 $formats .= $$type_format{$_}{$type};
604 if(defined($formats)) {
606 foreach (split(/\|/, $formats)) {
618 my $modules = \%{$self->{MODULES}};
620 return sort(keys(%$modules));
625 my $modules = \%{$self->{MODULES}};
629 return $$modules{$name};
637 my $module_files = \%{$self->{MODULE_FILES}};
639 return $$module_files{$module};
642 sub all_internal_functions {
644 my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
646 return sort(keys(%$function_internal_calling_convention));
649 sub all_internal_functions_in_module {
651 my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
652 my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
657 foreach my $name (keys(%$function_internal_calling_convention)) {
658 if($$function_internal_module{$name} eq $module) {
666 sub all_external_functions {
668 my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
670 return sort(keys(%$function_external_name));
673 sub all_external_functions_in_module {
675 my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
676 my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
681 foreach my $name (keys(%$function_external_name)) {
682 if($$function_external_module{$name} eq $module) {
690 sub all_functions_in_module {
692 my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
696 return sort(keys(%{$$module_external_calling_convention{$module}}));
699 sub all_broken_forwards {
701 my $function_forward = \%{$self->{FUNCTION_FORWARD}};
703 my @broken_forwards = ();
704 foreach my $module (sort(keys(%$function_forward))) {
705 foreach my $external_name (sort(keys(%{$$function_forward{$module}}))) {
706 (my $forward_module, my $forward_external_name) = @{$$function_forward{$module}{$external_name}};
708 my $forward_external_calling_convention =
709 $self->function_external_calling_convention_in_module($forward_module, $forward_external_name);
711 if(!defined($forward_external_calling_convention)) {
712 push @broken_forwards, [$module, $external_name, $forward_module, $forward_external_name];
716 return @broken_forwards;
720 sub function_internal_ordinal {
722 my $function_internal_ordinal = \%{$self->{FUNCTION_INTERNAL_ORDINAL}};
726 return $$function_internal_ordinal{$name};
729 sub function_external_ordinal {
731 my $function_external_ordinal = \%{$self->{FUNCTION_EXTERNAL_ORDINAL}};
735 return $$function_external_ordinal{$name};
738 sub function_internal_calling_convention {
740 my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
744 return $$function_internal_calling_convention{$name};
747 sub function_external_calling_convention {
749 my $function_external_calling_convention = \%{$self->{FUNCTION_EXTERNAL_CALLING_CONVENTION}};
753 return $$function_external_calling_convention{$name};
756 sub function_external_calling_convention_in_module {
758 my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
763 return $$module_external_calling_convention{$module}{$name};
766 sub function_internal_name {
768 my $function_internal_name = \%{$self->{FUNCTION_INTERNAL_NAME}};
772 return $$function_internal_name{$name};
775 sub function_external_name {
777 my $function_external_name = \%{$self->{FUNCTION_EXTERNAL_NAME}};
781 return $$function_external_name{$name};
784 sub function_forward_final_destination {
787 my $function_forward = \%{$self->{FUNCTION_FORWARD}};
792 my $forward_module = $module;
793 my $forward_name = $name;
794 while(defined(my $forward = $$function_forward{$forward_module}{$forward_name})) {
795 ($forward_module, $forward_name) = @$forward;
798 return ($forward_module, $forward_name);
803 my $function_internal_calling_convention = \%{$self->{FUNCTION_INTERNAL_CALLING_CONVENTION}};
807 return $$function_internal_calling_convention{$name};
810 sub all_shared_internal_functions {
812 my $function_shared = \%{$self->{FUNCTION_SHARED}};
814 return sort(keys(%$function_shared));
817 sub is_shared_internal_function {
819 my $function_shared = \%{$self->{FUNCTION_SHARED}};
823 return $$function_shared{$name};
826 sub found_shared_internal_function {
828 my $function_shared = \%{$self->{FUNCTION_SHARED}};
832 $$function_shared{$name} = 1;
835 sub function_internal_arguments {
837 my $function_internal_arguments = \%{$self->{FUNCTION_INTERNAL_ARGUMENTS}};
841 return $$function_internal_arguments{$name};
844 sub function_external_arguments {
846 my $function_external_arguments = \%{$self->{FUNCTION_EXTERNAL_ARGUMENTS}};
850 return $$function_external_arguments{$name};
853 sub function_internal_module {
855 my $function_internal_module = \%{$self->{FUNCTION_INTERNAL_MODULE}};
859 return $$function_internal_module{$name};
862 sub function_external_module {
864 my $function_external_module = \%{$self->{FUNCTION_EXTERNAL_MODULE}};
868 return $$function_external_module{$name};
871 sub is_function_stub {
873 my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
874 my $modules = \%{$self->{MODULES}};
879 foreach my $module (keys(%$modules)) {
880 if($$module_external_calling_convention{$module}{$name} eq "stub") {
888 sub is_function_stub_in_module {
890 my $module_external_calling_convention = \%{$self->{MODULE_EXTERNAL_CALLING_CONVENTION}};
895 if(!defined($$module_external_calling_convention{$module}{$name})) {
898 return $$module_external_calling_convention{$module}{$name} eq "stub";
901 ########################################################################
905 sub _get_all_module_internal_ordinal {
907 my $internal_name = shift;
912 my $name = $winapi->function_external_name($internal_name);
914 @name = split(/ & /, $name);
919 my $module = $winapi->function_internal_module($internal_name);
920 if(defined($module)) {
921 @module = split(/ & /, $module);
926 my $ordinal = $winapi->function_internal_ordinal($internal_name);
927 if(defined($ordinal)) {
928 @ordinal = split(/ & /, $ordinal);
935 while(defined($name = shift @name) &&
936 defined($module = shift @module) &&
937 defined($ordinal = shift @ordinal))
939 push @entries, [$name, $module, $ordinal];
945 sub get_all_module_internal_ordinal16 {
946 return _get_all_module_internal_ordinal($win16api, @_);
949 sub get_all_module_internal_ordinal32 {
950 return _get_all_module_internal_ordinal($win32api, @_);
953 sub get_all_module_internal_ordinal {
955 foreach my $winapi (@winapis) {
956 push @entries, _get_all_module_internal_ordinal($winapi, @_);
962 sub _get_all_module_external_ordinal {
964 my $external_name = shift;
969 my $name = $winapi->function_internal_name($external_name);
971 @name = split(/ & /, $name);
976 my $module = $winapi->function_external_module($external_name);
977 if(defined($module)) {
978 @module = split(/ & /, $module);
983 my $ordinal = $winapi->function_external_ordinal($external_name);
984 if(defined($ordinal)) {
985 @ordinal = split(/ & /, $ordinal);
992 while(defined($name = shift @name) &&
993 defined($module = shift @module) &&
994 defined($ordinal = shift @ordinal))
996 push @entries, [$name, $module, $ordinal];
1002 sub get_all_module_external_ordinal16 {
1003 return _get_all_module_external_ordinal($win16api, @_);
1006 sub get_all_module_external_ordinal32 {
1007 return _get_all_module_external_ordinal($win32api, @_);
1010 sub get_all_module_external_ordinal {
1012 foreach my $winapi (@winapis) {
1013 push @entries, _get_all_module_external_ordinal($winapi, @_);