5ef6aa9483f76cd18c610bb3d722bf2bdb0abdec
[WebKit-https.git] / Source / WebKit / 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::Path qw(mkpath);
34 use File::Spec::Functions;
35 use Getopt::Long;
36
37 my $srcRoot = realpath(File::Spec->catfile(dirname(abs_path($0)), "../.."));
38 my @platformPrefixes = ("ca", "cf", "cocoa", "Cocoa", "CoordinatedGraphics", "curl", "gtk", "ios", "mac", "soup", "win", "wpe");
39 my @frameworks = ("JavaScriptCore", "WebCore", "WebKit");
40 my @skippedPrefixes;
41 my @frameworkHeaders;
42 my $framework;
43 my $frameworkDirectoryName;
44 my %neededHeaders;
45 my $verbose = 0; # enable it for debugging purpose
46
47 my @incFromRoot;
48 my $outputDirectory;
49 my @platform;
50
51 my %options = (
52     'include-path=s' => \@incFromRoot,
53     'output=s' => \$outputDirectory,
54     'platform=s' => \@platform
55 );
56
57 GetOptions(%options);
58
59 foreach my $prefix (@platformPrefixes) {
60     push(@skippedPrefixes, $prefix) if grep($_ =~ "$prefix", @platform) == 0;
61 }
62
63 foreach (@frameworks) {
64     $framework = $_;
65     $frameworkDirectoryName = ($framework eq "WebKit") ? "WebKit2" : $framework;
66     @frameworkHeaders = ();
67     %neededHeaders = ();
68
69     foreach (@incFromRoot) { find(\&collectNeededHeaders, abs_path($_) ); };
70     find(\&collectFrameworkHeaderPaths, File::Spec->catfile($srcRoot, $frameworkDirectoryName));
71     createForwardingHeadersForFramework();
72 }
73
74 sub collectNeededHeaders {
75     my $filePath = $File::Find::name;
76     my $file = $_;
77     if ($filePath =~ '\.h$|\.cpp$|\.c$') {
78         open(FILE, "<$file") or die "Could not open $filePath.\n";
79         while (<FILE>) {
80            if (m/^#.*<$framework\/(.*\.h)/) {
81                $neededHeaders{$1} = 1;
82            }
83         }
84         close(FILE);
85     }
86 }
87
88 sub collectFrameworkHeaderPaths {
89     my $filePath = $File::Find::name;
90     my $file = $_;
91     if ($filePath =~ '\.h$' && $filePath !~ "ForwardingHeaders" && grep{$file eq $_} keys %neededHeaders) {
92         my $headerPath = substr($filePath, length(File::Spec->catfile($srcRoot, $frameworkDirectoryName)) + 1 );
93         push(@frameworkHeaders, $headerPath) unless (grep($headerPath =~ "$_/", @skippedPrefixes) || $headerPath =~ "config.h");
94     }
95 }
96
97 sub createForwardingHeadersForFramework {
98     my $targetDirectory = File::Spec->catfile($outputDirectory, $framework);
99     mkpath($targetDirectory);
100     foreach my $header (@frameworkHeaders) {
101         my $headerName = basename($header);
102
103         # If we found more headers with the same name, exit immediately.
104         my @headers = grep($_ =~ "/$headerName\$", @frameworkHeaders);
105         if (@headers != 1) {
106             print("ERROR: Can't create $headerName forwarding header, because there are more headers with the same name:\n");
107             foreach (@headers) { print " - $_\n" };
108             die();
109         }
110
111         my $forwardingHeaderPath = File::Spec->catfile($targetDirectory, $headerName);
112         my $expectedIncludeStatement = "#include \"$frameworkDirectoryName/$header\"";
113         my $foundIncludeStatement = 0;
114
115         $foundIncludeStatement = <EXISTING_HEADER> if open(EXISTING_HEADER, "<$forwardingHeaderPath");
116         chomp($foundIncludeStatement);
117
118         if (! $foundIncludeStatement || $foundIncludeStatement ne $expectedIncludeStatement) {
119             print "[Creating forwarding header for $framework/$header]\n" if $verbose;
120             open(FORWARDING_HEADER, ">$forwardingHeaderPath") or die "Could not open $forwardingHeaderPath.";
121             print FORWARDING_HEADER "$expectedIncludeStatement\n";
122             close(FORWARDING_HEADER);
123         }
124
125         close(EXISTING_HEADER);
126     }
127 }