Changeset 243569 in webkit

Timestamp:

Mar 27, 2019, 4:34:04 PM (7 years ago)

Author:

Wenson Hsieh

Message:

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 #imports 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):

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• mac/postprocess-framework-headers.sh (modified) (2 diffs)
• mac/replace-webkit-additions-includes.py (added)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+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):
+
 2019-03-27  Andy Estes  <aestes@apple.com>
 

trunk/Source/WebKit/mac/postprocess-framework-headers.sh

@@ -49 +49 @@
 }
 
+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 $?
+}
+
 function rewrite_headers () {
     if [[ "${WK_PLATFORM_NAME}" == "macosx" ]]; then
@@ -82 +90 @@
         if [[ "$HEADER_PATH" -nt $TIMESTAMP_PATH ]]; then
             ditto "${HEADER_PATH}" "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}"
+            replace_webkit_additions_includes "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}"
             sed -i .tmp -E "${SED_OPTIONS[@]}" "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}" || exit $?
             mv "${TARGET_TEMP_DIR}/${HEADER_PATH##*/}" "$HEADER_PATH"