xref: /aosp_15_r20/external/webrtc/rtc_tools/header_usage.sh (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1*d9f75844SAndroid Build Coastguard Worker#!/bin/bash
2*d9f75844SAndroid Build Coastguard Worker
3*d9f75844SAndroid Build Coastguard Worker# Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
4*d9f75844SAndroid Build Coastguard Worker#
5*d9f75844SAndroid Build Coastguard Worker# Use of this source code is governed by a BSD-style license
6*d9f75844SAndroid Build Coastguard Worker# that can be found in the LICENSE file in the root of the source
7*d9f75844SAndroid Build Coastguard Worker# tree. An additional intellectual property rights grant can be found
8*d9f75844SAndroid Build Coastguard Worker# in the file PATENTS.  All contributing project authors may
9*d9f75844SAndroid Build Coastguard Worker# be found in the AUTHORS file in the root of the source tree.
10*d9f75844SAndroid Build Coastguard Worker
11*d9f75844SAndroid Build Coastguard Worker# This script is run in a git repository. It lists all header files,
12*d9f75844SAndroid Build Coastguard Worker# sorted by the number of other files where the file name of the file
13*d9f75844SAndroid Build Coastguard Worker# occurs. It is intentionally not limited to only source files, and
14*d9f75844SAndroid Build Coastguard Worker# there may be some false hits because we search only for the file
15*d9f75844SAndroid Build Coastguard Worker# part (sans directory). It is quite slow.
16*d9f75844SAndroid Build Coastguard Worker#
17*d9f75844SAndroid Build Coastguard Worker# Headers close to the top of the list are candidates for removal.
18*d9f75844SAndroid Build Coastguard Worker
19*d9f75844SAndroid Build Coastguard Worker# If the name includes at most one directory, keep name unchanged,
20*d9f75844SAndroid Build Coastguard Worker# otherwise strip directories. Needed to work with relative #includes
21*d9f75844SAndroid Build Coastguard Worker# which are used in some parts of the tree, while still avoiding,
22*d9f75844SAndroid Build Coastguard Worker# e.g., api/foo.h to match includes of pc/foo.h.
23*d9f75844SAndroid Build Coastguard Workersimplify_name () {
24*d9f75844SAndroid Build Coastguard Worker  if expr "$1" : '.*/.*/' > /dev/null ; then
25*d9f75844SAndroid Build Coastguard Worker    basename "$1"
26*d9f75844SAndroid Build Coastguard Worker  else
27*d9f75844SAndroid Build Coastguard Worker    echo "$1"
28*d9f75844SAndroid Build Coastguard Worker  fi
29*d9f75844SAndroid Build Coastguard Worker}
30*d9f75844SAndroid Build Coastguard Worker
31*d9f75844SAndroid Build Coastguard Workergit ls-files '*.h' '*.hpp' | while read header ; do
32*d9f75844SAndroid Build Coastguard Worker  name="$(simplify_name "${header}")"
33*d9f75844SAndroid Build Coastguard Worker  count="$(git grep -l -F  "${name}" \
34*d9f75844SAndroid Build Coastguard Worker           | grep -v -e '\.gn' -e '\.gyp'  \
35*d9f75844SAndroid Build Coastguard Worker           | wc -l)"
36*d9f75844SAndroid Build Coastguard Worker  echo "${count}" "${header}"
37*d9f75844SAndroid Build Coastguard Workerdone | sort -n
38