Source/JavaScriptCore/Scripts/postprocess-header-rule

#!/bin/bash
#
# Copyright (C) 2014-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.
#

if [[ -z "${SCRIPT_HEADER_VISIBILITY}" ]]; then
    exit 0
fi

# Source the per-build cache produced by generate-header-postprocess-config.sh
# in the Derived Sources aggregate target. The cache holds OSX_VERSION /
# IOS_VERSION / XROS_VERSION / WK_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED and
# similar constants that are stable within one build, so we can skip the
# expensive perl + JSON parsing of branch_config.json on every per-header
# invocation. The producer phase is wired up in JavaScriptCore.xcodeproj's
# Derived Sources aggregate target and is a target dependency of the
# JavaScriptCore framework, so the cache file is always present by the time
# this rule runs.
WK_HEADER_POSTPROCESS_CACHE_FILE="${SHARED_DERIVED_FILE_DIR}/JavaScriptCore-header-postprocess-config.sh"
if [[ ! -f "${WK_HEADER_POSTPROCESS_CACHE_FILE}" ]]; then
    echo "$0: ${WK_HEADER_POSTPROCESS_CACHE_FILE} not found." >&2
    echo "    The 'Generate Header Postprocess Config' phase in the Derived" >&2
    echo "    Sources aggregate target must run before this rule." >&2
    exit 1
fi
# shellcheck disable=SC1090
source "${WK_HEADER_POSTPROCESS_CACHE_FILE}"

# WebKitAdditions may set WK_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED=YES when
# postprocessing should be disabled based on the deployment target version
# (e.g. for a downlevel build).
if [ "${WK_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED}" == "YES" ]; then
    JSC_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED=YES;
fi

if [[ "${JSC_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED}" != "YES" ]]; then
    if [[ "${WK_PLATFORM_NAME}" == "macosx" ]]; then
        [[ -n ${OSX_VERSION} ]] || OSX_VERSION=${MACOSX_DEPLOYMENT_TARGET}
        [[ -n ${OSX_VERSION_NUMBER} ]] || OSX_VERSION_NUMBER=${TARGET_MAC_OS_X_VERSION_MAJOR}
        [[ -n ${XROS_VERSION} ]] || XROS_VERSION="NA"
        [[ -n ${XROS_VERSION_NUMBER} ]] || XROS_VERSION_NUMBER="0"
        [[ -n ${IOS_VERSION} ]] || IOS_VERSION="NA"
        [[ -n ${IOS_VERSION_NUMBER} ]] || IOS_VERSION_NUMBER="0"
    elif [[ "${WK_PLATFORM_NAME}" == "maccatalyst" ]]; then
        # On Mac Catalyst `LLVM_TARGET_TRIPLE_OS_VERSION` will be in the format `ios{major}.{minor}`.
        local ALIGNED_IOS_VERSION="${LLVM_TARGET_TRIPLE_OS_VERSION#ios}"
        [[ -n ${IOS_VERSION} ]] || IOS_VERSION=${ALIGNED_IOS_VERSION}
        [[ -n ${IOS_VERSION_NUMBER} ]] || IOS_VERSION_NUMBER=${ALIGNED_IOS_VERSION%%.*}
        [[ -n ${OSX_VERSION} ]] || OSX_VERSION="NA"
        [[ -n ${OSX_VERSION_NUMBER} ]] || OSX_VERSION_NUMBER="0"
        [[ -n ${XROS_VERSION} ]] || XROS_VERSION="NA"
        [[ -n ${XROS_VERSION_NUMBER} ]] || XROS_VERSION_NUMBER="0"
    elif [[ "${PLATFORM_NAME}" =~ "iphone" ]]; then
        [[ -n ${IOS_VERSION} ]] || IOS_VERSION=${IPHONEOS_DEPLOYMENT_TARGET}
        [[ -n ${IOS_VERSION_NUMBER} ]] || IOS_VERSION_NUMBER=${SDK_VERSION_MAJOR}
        [[ -n ${OSX_VERSION} ]] || OSX_VERSION="NA"
        [[ -n ${OSX_VERSION_NUMBER} ]] || OSX_VERSION_NUMBER="0"
        [[ -n ${XROS_VERSION} ]] || XROS_VERSION="NA"
        [[ -n ${XROS_VERSION_NUMBER} ]] || XROS_VERSION_NUMBER="0"
    elif [[ "${PLATFORM_NAME}" == xr* ]]; then
        [[ -n ${XROS_VERSION} ]] || XROS_VERSION=${XROS_DEPLOYMENT_TARGET}
        [[ -n ${XROS_VERSION_NUMBER} ]] || XROS_VERSION_NUMBER=${SDK_VERSION_MAJOR}
        [[ -n ${IOS_VERSION} ]] || IOS_VERSION="NA"
        [[ -n ${OSX_VERSION} ]] || OSX_VERSION="NA"
        [[ -n ${OSX_VERSION_NUMBER} ]] || OSX_VERSION_NUMBER="0"
        [[ -n ${IOS_VERSION_NUMBER} ]] || IOS_VERSION_NUMBER="0"
    fi

    SED_OPTIONS=()

    if [[ -n "$OSX_VERSION" && -n "$IOS_VERSION" && -n "$XROS_VERSION" ]]; then
        SED_OPTIONS+=(
            -e s/JSC_MAC_TBA/${OSX_VERSION}/g
            -e s/JSC_IOS_TBA/${IOS_VERSION}/g
            -e s/JSC_XROS_TBA/${XROS_VESRION}/g
            -e s/JSC_MAC_VERSION_TBA/${OSX_VERSION_NUMBER}/g
            -e s/JSC_IOS_VERSION_TBA/${IOS_VERSION_NUMBER}/g
            -e s/JSC_XROS_VERSION_TBA/${XROS_VERSION_NUMBER}/g
            -e s/JSC_API_AVAILABLE/API_AVAILABLE/
            -e s/JSC_API_DEPRECATED/API_DEPRECATED/
            -e "s/^JSC_CLASS_AVAILABLE/JS_EXPORT API_AVAILABLE/"
            -e "s/^JSC_CLASS_DEPRECATED/JS_EXPORT API_DEPRECATED/"
        )
    else
        SED_OPTIONS+=(
            -e 's/JSC_(API_|CLASS_)AVAILABLE\(.*\)\s*\)//g'
            -e 's/JSC_(API_|CLASS_)DEPRECATED(_WITH_REPLACEMENT)?\(.*\)\s*\)//g'
            -e 's/JSC_(MAC|IOS)_VERSION_TBA/0/g'
        )
    fi

    SED_OPTIONS+=(${OTHER_SED_OPTIONS[*]})
fi

UNIFDEF_OPTIONS=(-Bt)

if [[ "${JSC_FRAMEWORK_HEADER_POSTPROCESSING_DISABLED}" == "YES" ]]; then
    UNIFDEF_OPTIONS+=(-UJSC_FRAMEWORK_HEADER_POSTPROCESSING_ENABLED)
else
    UNIFDEF_OPTIONS+=(-DJSC_FRAMEWORK_HEADER_POSTPROCESSING_ENABLED)
fi

sed -E "${SED_OPTIONS[@]}" < "${INPUT_FILE_PATH}" |
    unifdef ${UNIFDEF_OPTIONS[@]} > "${SCRIPT_OUTPUT_FILE_0}"
exits=(${PIPESTATUS[@]})
[ ${exits[0]} -eq 0 -a ${exits[1]} -lt 2 ]