2010-10-06 Balazs Kelemen <kbalazs@webkit.org>
[WebKit-https.git] / WebKitTools / Scripts / generate-forwarding-headers.pl
1 #!/usr/bin/perl -w
2 # Copyright (C) 2010 Andras Becsi (abecsi@inf.u-szeged.hu), University of Szeged
3 # All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 # 1. Redistributions of source code must retain the above copyright
9 #    notice, this list of conditions and the following disclaimer.
10 # 2. Redistributions in binary form must reproduce the above copyright
11 #    notice, this list of conditions and the following disclaimer in the
12 #    documentation and/or other materials provided with the distribution.
13 #
14 # THIS SOFTWARE IS PROVIDED BY UNIVERSITY OF SZEGED ``AS IS'' AND ANY
15 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 # PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL UNIVERSITY OF SZEGED OR
18 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #
26 # A script which searches for headers included by WebKit2 files
27 # and generates forwarding headers for these headers.
28
29 use strict;
30 use Cwd qw(abs_path realpath);
31 use File::Find;
32 use File::Basename;
33 use File::Spec::Functions;
34
35 my $srcRoot = realpath(File::Spec->catfile(dirname(abs_path($0)), "../.."));
36 my $incFromRoot = abs_path($ARGV[0]);
37 my @platformPrefixes = ("android", "brew", "cf", "chromium", "curl", "efl", "gtk", "haiku", "mac", "qt", "soup", "v8", "win", "wx");
38 my @frameworks = ( "JavaScriptCore", "WebCore", "WebKit2");
39 my @skippedPrefixes;
40 my @frameworkHeaders;
41 my $framework;
42 my %neededHeaders;
43
44 shift;
45 my $outputDirectory = $ARGV[0];
46 shift;
47 my $platform  = $ARGV[0];
48
49 foreach my $prefix (@platformPrefixes) {
50     push(@skippedPrefixes, $prefix) unless ($prefix =~ $platform);
51 }
52
53 foreach (@frameworks) {
54     $framework = $_;
55     find(\&collectNeededHeaders, $incFromRoot);
56     find(\&collectFameworkHeaderPaths, File::Spec->catfile($srcRoot, $framework));
57     createForwardingHeadersForFramework();
58 }
59
60 sub collectNeededHeaders {
61     my $filePath = $File::Find::name;
62     my $file = $_;
63     if ($filePath =~ '\.h$|\.cpp$') {
64         open(FILE, "<$file") or die "Could not open $filePath.\n";
65         while (<FILE>) {
66            if (m/^#.*<$framework\/(.*\.h)/) {
67                $neededHeaders{$1} = 1;
68            }
69         }
70         close(FILE);
71     }
72 }
73
74 sub collectFameworkHeaderPaths {
75     my $filePath = $File::Find::name;
76     my $file = $_;
77     if ($filePath =~ '\.h$' && $filePath !~ "ForwardingHeaders" && grep{$file eq $_} keys %neededHeaders) {
78         my $headerPath = substr($filePath, length("$srcRoot/$framework/"));
79         push(@frameworkHeaders, $headerPath) unless (grep($headerPath =~ "$_/", @skippedPrefixes));
80     }
81 }
82
83 sub createForwardingHeadersForFramework {
84     foreach my $header (@frameworkHeaders) {
85         my $forwardingHeaderPath = File::Spec->catfile($outputDirectory, $framework, basename($header));
86         my $expectedIncludeStatement = "#include \"$header\"";
87         my $foundIncludeStatement = 0;
88         $foundIncludeStatement = <EXISTING_HEADER> if open(EXISTING_HEADER, "<$forwardingHeaderPath");
89         chomp($foundIncludeStatement);
90         if (! $foundIncludeStatement || $foundIncludeStatement ne $expectedIncludeStatement) {
91             print "[Creating forwarding header for $framework/$header]\n";
92             open(FORWARDING_HEADER, ">$forwardingHeaderPath") or die "Could not open $forwardingHeaderPath.";
93             print FORWARDING_HEADER "$expectedIncludeStatement\n";
94             close(FORWARDING_HEADER);
95         }
96         close(EXISTING_HEADER);
97     }
98 }
99