<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[243569] trunk/Source/WebKit</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/243569">243569</a></dd>
<dt>Author</dt> <dd>wenson_hsieh@apple.com</dd>
<dt>Date</dt> <dd>2019-03-27 16:34:04 -0700 (Wed, 27 Mar 2019)</dd>
</dl>

<h3>Log Message</h3>
<pre>Need a way to include WebKitAdditions code in WebKit API headers
https://bugs.webkit.org/show_bug.cgi?id=196173

Reviewed by Tim Horton.

Introduce a mechanism that allows us to insert code from WebKitAdditions into public or private SDK headers
using `#import`s of the form:

```
#if USE(APPLE_INTERNAL_SDK)
#import <WebKitAdditions/WKWebViewConfigurationAdditions.h>
#endif
```

The resulting header in the built products directory will contain the contents of the imported file inserted in
place of the `#if USE(APPLE_INTERNAL_SDK) … #endif` block; however, when building with the Apple internal SDK,
the additions header content will be imported by the usual means.

* mac/postprocess-framework-headers.sh:
* mac/replace-webkit-additions-includes.py: Added.

Add a step when post-processing framework headers to replace instances of `#if USE(APPLE_INTERNAL_SDK) … #endif`
with the text content of the additions files. The replacement script first searches in the built products
directory for the matching additions file, and falls back to the SDK if no matching file is found. If neither
are present (e.g. a build using the public SDK), then the block is simply replaced by the empty string.

(read_content_from_webkit_additions):
(main):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKitChangeLog">trunk/Source/WebKit/ChangeLog</a></li>
<li><a href="#trunkSourceWebKitmacpostprocessframeworkheaderssh">trunk/Source/WebKit/mac/postprocess-framework-headers.sh</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunkSourceWebKitmacreplacewebkitadditionsincludespy">trunk/Source/WebKit/mac/replace-webkit-additions-includes.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKitChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/ChangeLog (243568 => 243569)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/ChangeLog    2019-03-27 23:32:34 UTC (rev 243568)
+++ trunk/Source/WebKit/ChangeLog       2019-03-27 23:34:04 UTC (rev 243569)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2019-03-27  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        Need a way to include WebKitAdditions code in WebKit API headers
+        https://bugs.webkit.org/show_bug.cgi?id=196173
+
+        Reviewed by Tim Horton.
+
+        Introduce a mechanism that allows us to insert code from WebKitAdditions into public or private SDK headers
+        using `#import`s of the form:
+
+        ```
+        #if USE(APPLE_INTERNAL_SDK)
+        #import <WebKitAdditions/WKWebViewConfigurationAdditions.h>
+        #endif
+        ```
+
+        The resulting header in the built products directory will contain the contents of the imported file inserted in
+        place of the `#if USE(APPLE_INTERNAL_SDK) … #endif` block; however, when building with the Apple internal SDK,
+        the additions header content will be imported by the usual means.
+
+        * mac/postprocess-framework-headers.sh:
+        * mac/replace-webkit-additions-includes.py: Added.
+
+        Add a step when post-processing framework headers to replace instances of `#if USE(APPLE_INTERNAL_SDK) … #endif`
+        with the text content of the additions files. The replacement script first searches in the built products
+        directory for the matching additions file, and falls back to the SDK if no matching file is found. If neither
+        are present (e.g. a build using the public SDK), then the block is simply replaced by the empty string.
+
+        (read_content_from_webkit_additions):
+        (main):
+
</ins><span class="cx"> 2019-03-27  Andy Estes  <aestes@apple.com>
</span><span class="cx"> 
</span><span class="cx">         REGRESSION (r242686): package-root creates roots with broken symlinks in WebKit.framework/XPCServices/
</span></span></pre></div>
<a id="trunkSourceWebKitmacpostprocessframeworkheaderssh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/mac/postprocess-framework-headers.sh (243568 => 243569)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/mac/postprocess-framework-headers.sh 2019-03-27 23:32:34 UTC (rev 243568)
+++ trunk/Source/WebKit/mac/postprocess-framework-headers.sh    2019-03-27 23:34:04 UTC (rev 243569)
</span><span class="lines">@@ -48,6 +48,14 @@
</span><span class="cx">     source "${DEFINITIONS_FILE}"
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+function replace_webkit_additions_includes () {
+    if [[ -z `grep '#import <WebKitAdditions/.*\.h>' "${1}"` ]]; then
+        return 0
+    fi
+    python "$(dirname $0)/replace-webkit-additions-includes.py" "${1}" "${BUILT_PRODUCTS_DIR}" "${SDKROOT}"
+    return $?
+}
+
</ins><span class="cx"> function rewrite_headers () {
</span><span class="cx">     if [[ "${WK_PLATFORM_NAME}" == "macosx" ]]; then
</span><span class="cx">         [[ -n ${OSX_VERSION} ]] || OSX_VERSION=${MACOSX_DEPLOYMENT_TARGET}
</span><span class="lines">@@ -81,6 +89,7 @@
</span><span class="cx">     for HEADER_PATH in "${1}/"*.h; do
</span><span class="cx">         if [[ "$HEADER_PATH" -nt $TIMESTAMP_PATH ]]; then
</span><span class="cx">             ditto "${HEADER_PATH}" "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}"
</span><ins>+            replace_webkit_additions_includes "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}"
</ins><span class="cx">             sed -i .tmp -E "${SED_OPTIONS[@]}" "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}" || exit $?
</span><span class="cx">             mv "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}" "$HEADER_PATH"
</span><span class="cx">         fi
</span></span></pre></div>
<a id="trunkSourceWebKitmacreplacewebkitadditionsincludespy"></a>
<div class="addfile"><h4>Added: trunk/Source/WebKit/mac/replace-webkit-additions-includes.py (0 => 243569)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/mac/replace-webkit-additions-includes.py                             (rev 0)
+++ trunk/Source/WebKit/mac/replace-webkit-additions-includes.py        2019-03-27 23:34:04 UTC (rev 243569)
</span><span class="lines">@@ -0,0 +1,88 @@
</span><ins>+#!/usr/bin/env python
+#
+# Copyright (C) 2019 Apple Inc. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+# THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+import os
+import re
+import sys
+
+
+def read_content_from_webkit_additions(built_products_directory, sdk_root_directory, filename):
+    additions_path = os.path.join("usr/local/include/WebKitAdditions", filename)
+    try:
+        file_in_build_directory = open(os.path.join(built_products_directory, additions_path), "r")
+        return file_in_build_directory.read()
+    except:
+        try:
+            file_in_sdk_root = open(os.path.join(sdk_root_directory, additions_path), "r")
+            return file_in_sdk_root.read()
+        except:
+            return ""
+
+
+def main(argv=None):
+    if not argv:
+        argv = sys.argv
+
+    if len(argv) != 4:
+        print("Usage: replace-webkit-additions-includes.py <header_path> <built_products_directory> <sdk_root_directory>")
+        return 1
+
+    header_path = argv[1]
+    built_products_directory = argv[2]
+    sdk_root_directory = argv[3]
+    if not len(header_path):
+        print("(%s): header path unspecified" % argv[0])
+        return 1
+
+    if not len(built_products_directory):
+        print("(%s): built products directory unspecified" % argv[0])
+        return 1
+
+    if not len(sdk_root_directory):
+        print("(%s): SDK root directory unspecified" % argv[0])
+        return 1
+
+    additions_import_pattern = re.compile(r"\#if USE\(APPLE_INTERNAL_SDK\)\n#import <WebKitAdditions/(.*\.h)>\n#endif")
+    try:
+        with open(header_path, "r") as header:
+            header_contents = header.read()
+            match = additions_import_pattern.search(header_contents)
+            while match:
+                header_contents = header_contents[:match.start()] + read_content_from_webkit_additions(built_products_directory, sdk_root_directory, match.groups()[0]) + header_contents[match.end():]
+                match = additions_import_pattern.search(header_contents)
+            try:
+                with open(header_path, "w") as header:
+                    header.write(header_contents)
+            except:
+                print("(%s): failed to write to file: %s" % (argv[0], header_path))
+                return 1
+        return 0
+    except:
+        print("(%s): failed to read file: %s" % (argv[0], header_path))
+        return 1
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv))
</ins><span class="cx">Property changes on: trunk/Source/WebKit/mac/replace-webkit-additions-includes.py
</span><span class="cx">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4>Added: svn:executable</h4></div>
<ins>+*
</ins><span class="cx">\ No newline at end of property
</span></div>

</body>
</html>