Source/WebKit/mac/replace-webkit-additions-includes.py

#!/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 Exception as ex:
        try:
            file_in_sdk_root = open(os.path.join(sdk_root_directory, additions_path), "r")
            return file_in_sdk_root.read()
        except Exception as ex:
            return ""


def is_supported_os():
    os_version_string = os.environ.get("MACOSX_DEPLOYMENT_TARGET")
    if os_version_string is not None:
        os_version = float('.'.join(os_version_string.split('.')[:2]))
        return os_version >= 13.0
    os_version_string = os.environ.get("IPHONEOS_DEPLOYMENT_TARGET")
    if os_version_string is not None:
        os_version = float('.'.join(os_version_string.split('.')[:2]))
        return os_version >= 16.0
    os_version_string = os.environ.get("WATCHOS_DEPLOYMENT_TARGET")
    if os_version_string is not None:
        os_version = float('.'.join(os_version_string.split('.')[:2]))
        return os_version >= 9.0
    os_version_string = os.environ.get("TVOS_DEPLOYMENT_TARGET")
    if os_version_string is not None:
        os_version = float('.'.join(os_version_string.split('.')[:2]))
        return os_version >= 16.0
    return True


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

    # We currently only support WebKitAdditions in Framework headers on macOS 13+ and iOS 16+.
    should_do_replacement = is_supported_os()

    # API_WEBKIT_ADDITIONS is intentionally not defined anywhere so that we never try to build this code. It is only
    # meant to be used by this script to identify where to introduce replacement in API headers from WebKitAdditions.
    additions_import_pattern = re.compile(r"\#if ENABLE\(API_WEBKIT_ADDITIONS\)\n#import <WebKitAdditions/(.*)>\n#endif")
    try:
        with open(header_path, "r") as header:
            header_contents = header.read()
            match = additions_import_pattern.search(header_contents)
            while match:
                if should_do_replacement:
                    header_contents = header_contents[:match.start()] + read_content_from_webkit_additions(built_products_directory, sdk_root_directory, match.groups()[0]) + header_contents[match.end():]
                else:
                    header_contents = header_contents[:match.start()] + header_contents[match.end():]
                match = additions_import_pattern.search(header_contents)
            try:
                with open(header_path, "w") as header:
                    header.write(header_contents)
            except Exception as ex:
                print("(%s): failed to write to file: %s" % (argv[0], header_path))
                return 1
        return 0
    except Exception as ex:
        print("(%s): failed to read file: %s" % (argv[0], header_path))
        return 1


if __name__ == "__main__":
    sys.exit(main(sys.argv))