diff --git a/scripts/Android.bp b/scripts/Android.bp index 97f6ab424..7baaadb77 100644 --- a/scripts/Android.bp +++ b/scripts/Android.bp @@ -254,3 +254,8 @@ python_test_host { "modify_permissions_allowlist.py", ], } + +sh_binary_host { + name: "keep-flagged-apis", + src: "keep-flagged-apis.sh", +} diff --git a/scripts/keep-flagged-apis.sh b/scripts/keep-flagged-apis.sh new file mode 100755 index 000000000..9c48fdbad --- /dev/null +++ b/scripts/keep-flagged-apis.sh @@ -0,0 +1,46 @@ +#!/bin/bash -e +# +# Copyright 2023 Google Inc. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Convert a list of flags in the input file to a list of metalava options +# that will keep the APIs for those flags will hiding all other flagged +# APIs. + +FLAGS="$1" + +FLAGGED="android.annotation.FlaggedApi" + +# Convert the list of feature flags in the input file to Metalava options +# of the form `--revert-annotation !android.annotation.FlaggedApi("")` +# to prevent the annotated APIs from being hidden, i.e. include the annotated +# APIs in the SDK snapshots. This also preserves the line comments, they will +# be ignored by Metalava but might be useful when debugging. +while read -r line; do + key=$(echo "$line" | cut -d= -f1) + value=$(echo "$line" | cut -d= -f2) + + # Skip if value is not true and line does not start with '#' + if [[ ( $value != "true" ) && ( $line =~ ^[^#] )]]; then + continue + fi + + # Escape and quote the key for sed + escaped_key=$(echo "$key" | sed "s/'/\\\'/g; s/ /\\ /g") + + echo $line | sed "s|^[^#].*$|--revert-annotation '!$FLAGGED(\"$escaped_key\")'|" +done < "$FLAGS" + +# Revert all flagged APIs, unless listed above. +echo "--revert-annotation $FLAGGED"