xref: /aosp_15_r20/build/soong/scripts/keep-flagged-apis.sh (revision 333d2b3687b3a337dbcca9d65000bca186795e39)
1*333d2b36SAndroid Build Coastguard Worker#!/bin/bash -e
2*333d2b36SAndroid Build Coastguard Worker#
3*333d2b36SAndroid Build Coastguard Worker# Copyright 2023 Google Inc. All rights reserved.
4*333d2b36SAndroid Build Coastguard Worker#
5*333d2b36SAndroid Build Coastguard Worker# Licensed under the Apache License, Version 2.0 (the "License");
6*333d2b36SAndroid Build Coastguard Worker# you may not use this file except in compliance with the License.
7*333d2b36SAndroid Build Coastguard Worker# You may obtain a copy of the License at
8*333d2b36SAndroid Build Coastguard Worker#
9*333d2b36SAndroid Build Coastguard Worker#     http://www.apache.org/licenses/LICENSE-2.0
10*333d2b36SAndroid Build Coastguard Worker#
11*333d2b36SAndroid Build Coastguard Worker# Unless required by applicable law or agreed to in writing, software
12*333d2b36SAndroid Build Coastguard Worker# distributed under the License is distributed on an "AS IS" BASIS,
13*333d2b36SAndroid Build Coastguard Worker# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*333d2b36SAndroid Build Coastguard Worker# See the License for the specific language governing permissions and
15*333d2b36SAndroid Build Coastguard Worker# limitations under the License.
16*333d2b36SAndroid Build Coastguard Worker
17*333d2b36SAndroid Build Coastguard Worker# Convert a list of flags in the input file to a list of metalava options
18*333d2b36SAndroid Build Coastguard Worker# that will keep the APIs for those flags will hiding all other flagged
19*333d2b36SAndroid Build Coastguard Worker# APIs.
20*333d2b36SAndroid Build Coastguard Worker
21*333d2b36SAndroid Build Coastguard WorkerFLAGS="$1"
22*333d2b36SAndroid Build Coastguard Worker
23*333d2b36SAndroid Build Coastguard WorkerFLAGGED="android.annotation.FlaggedApi"
24*333d2b36SAndroid Build Coastguard Worker
25*333d2b36SAndroid Build Coastguard Worker# Convert the list of feature flags in the input file to Metalava options
26*333d2b36SAndroid Build Coastguard Worker# of the form `--revert-annotation !android.annotation.FlaggedApi("<flag>")`
27*333d2b36SAndroid Build Coastguard Worker# to prevent the annotated APIs from being hidden, i.e. include the annotated
28*333d2b36SAndroid Build Coastguard Worker# APIs in the SDK snapshots.
29*333d2b36SAndroid Build Coastguard Workerwhile read -r line; do
30*333d2b36SAndroid Build Coastguard Worker  # Escape and quote the key for sed
31*333d2b36SAndroid Build Coastguard Worker  escaped_line=$(echo "$line" | sed "s/'/\\\'/g; s/ /\\ /g")
32*333d2b36SAndroid Build Coastguard Worker
33*333d2b36SAndroid Build Coastguard Worker  echo "--revert-annotation '!$FLAGGED(\"$escaped_line\")'"
34*333d2b36SAndroid Build Coastguard Workerdone < "$FLAGS"
35*333d2b36SAndroid Build Coastguard Worker
36*333d2b36SAndroid Build Coastguard Worker# Revert all flagged APIs, unless listed above.
37*333d2b36SAndroid Build Coastguard Workerecho "--revert-annotation $FLAGGED"
38