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