REGRESSION (r236481): Move soft-linking of LocalAuthentication.framework out of Local...
[WebKit-https.git] / Tools / Scripts / check-for-webkit-framework-include-consistency
1 #!/usr/bin/env ruby
2
3 # Copyright (C) 2010, 2013 Apple Inc. 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 APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18 # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24 # THE POSSIBILITY OF SUCH DAMAGE.
25
26
27 base_directory = ENV['TARGET_BUILD_DIR'] or throw "Unable to find TARGET_BUILD_DIR in the environment!"
28
29 Dir.chdir base_directory
30
31 $PERMITTED_INCLUDE_TYPES = { :public => [ :public ], :private => [ :public, :private ] }
32
33 $HEADER_NAMES_TO_TYPE = { }
34 $HEADERS_BY_TYPE = { :public => [], :private => [] }
35
36 $error_printed = false
37
38 def print_error msg
39   $error_printed = true
40   STDERR.puts "error: #{msg}"
41 end
42
43 def build_header_maps
44   all_headers = `find #{ENV['PUBLIC_HEADERS_FOLDER_PATH']} #{ENV['PRIVATE_HEADERS_FOLDER_PATH']} -type f -name '*.h'`.split
45
46   all_headers.each do |header|
47     if /\/Headers\/(.*)/.match(header)
48       $HEADER_NAMES_TO_TYPE[$1] = :public
49       $HEADERS_BY_TYPE[:public] << header
50     elsif /\/PrivateHeaders\/(.*)/.match(header)
51       # If the same header exists both as a public header and as a private header, assume that it
52       # has been promoted to public, and the private instance is stale.
53       # FIXME: This can be improved by checking time stamps.
54       $HEADER_NAMES_TO_TYPE[$1] = :private if !$HEADER_NAMES_TO_TYPE[$1]
55       $HEADERS_BY_TYPE[:private] << header
56     else
57       print_error "Unknown header type: #{header}"
58     end
59   end
60 end
61
62 def resolve_include(header, included_header, permitted_types)
63   # Ignore includes that aren't in the typical framework style.
64   return unless /<([^\/]+)\/(.*)>/.match(included_header)
65
66   framework, included_header_name = [$1, $2]
67
68   # Ignore includes that aren't related to other WebKit headers.
69   return unless framework =~ /^Web/
70   
71   # A header of any type including a WebCore header is a recipe for disaster.
72   if framework == "WebCore"
73     print_error "#{header} included #{included_header}!"
74     return
75   end
76
77   # iOS we want to keep the WAK headers private, even if a public header includes them,
78   # so we are going to not show warnings for WAK headers.
79   return if (framework == "WebKitLegacy") and included_header_name =~ /^WAK/
80
81   header_type = $HEADER_NAMES_TO_TYPE[included_header_name]
82
83   if not header_type
84     print_error "#{header} included #{included_header} but I could not find a header of that name!"
85   elsif not permitted_types.member?(header_type)
86     print_error "#{header} included #{included_header} which is #{header_type}!"
87   end
88 end
89
90 def verify_includes(header, permitted_types)
91   File.open(header) do |file|
92     file.each_line do |line|
93       if /#(include|import) (.*)/.match(line)
94         resolve_include(header, $2, permitted_types)
95       end
96     end
97   end
98 end
99
100 build_header_maps
101
102 $HEADERS_BY_TYPE.each do |header_type, headers|
103   permitted_types = $PERMITTED_INCLUDE_TYPES[header_type]
104   headers.each do |header|
105     verify_includes header, permitted_types
106   end
107 end
108
109 exit 1 if $error_printed