2010-10-06 Victor Wang <victorw@chromium.org>
[WebKit-https.git] / WebKit2 / 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 @platformPrefixes = ("android", "brew", "cf", "chromium", "curl", "efl", "gtk", "haiku", "mac", "qt", "soup", "v8", "win", "wx");
37 my @frameworks = ( "JavaScriptCore", "WebCore", "WebKit2");
38 my @skippedPrefixes;
39 my @frameworkHeaders;
40 my $framework;
41 my %neededHeaders;
42
43 my $outputDirectory = $ARGV[0];
44 shift;
45 my $platform  = $ARGV[0];
46
47 foreach my $prefix (@platformPrefixes) {
48     push(@skippedPrefixes, $prefix) unless ($prefix =~ $platform);
49 }
50
51 foreach (@frameworks) {
52     $framework = $_;
53     find(\&collectNeededHeaders, File::Spec->catfile($srcRoot, "WebKit2"));
54     find(\&collectFameworkHeaderPaths, File::Spec->catfile($srcRoot, $framework));
55     createForwardingHeadersForFramework();
56 }
57
58 sub collectNeededHeaders {
59     my $filePath = $File::Find::name;
60     my $file = $_;
61     if ($filePath =~ '\.h$|\.cpp$') {
62         open(FILE, "<$file") or die "Could not open $filePath.\n";
63         while (<FILE>) {
64            if (m/^#.*<$framework\/(.*\.h)/) {
65                $neededHeaders{$1} = 1;
66            }
67         }
68         close(FILE);
69     }
70 }
71
72 sub collectFameworkHeaderPaths {
73     my $filePath = $File::Find::name;
74     my $file = $_;
75     if ($filePath =~ '\.h$' && $filePath !~ "ForwardingHeaders" && grep{$file eq $_} keys %neededHeaders) {
76         my $headerPath = substr($filePath, length("$srcRoot/$framework/"));
77         push(@frameworkHeaders, $headerPath) unless (grep($headerPath =~ "$_/", @skippedPrefixes));
78     }
79 }
80
81 sub createForwardingHeadersForFramework {
82     foreach my $header (@frameworkHeaders) {
83         my $forwardingHeaderPath = File::Spec->catfile($outputDirectory, $framework, basename($header));
84         my $expectedIncludeStatement = "#include \"$header\"";
85         my $foundIncludeStatement = 0;
86         $foundIncludeStatement = <EXISTING_HEADER> if open(EXISTING_HEADER, "<$forwardingHeaderPath");
87         chomp($foundIncludeStatement);
88         if (! $foundIncludeStatement || $foundIncludeStatement ne $expectedIncludeStatement) {
89             print "[Creating forwarding header for $framework/$header]\n";
90             open(FORWARDING_HEADER, ">$forwardingHeaderPath") or die "Could not open $forwardingHeaderPath.";
91             print FORWARDING_HEADER "$expectedIncludeStatement\n";
92             close(FORWARDING_HEADER);
93         }
94         close(EXISTING_HEADER);
95     }
96 }
97