lucaspalomodevelop/core
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/core.git synced 2026-03-13 00:07:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Scripts: add unused-functions.sh helper

Browse Source 
Processing is quite heavy but we don't need to run this all the time.
This commit is contained in:
Franco Fichtner 2025-04-24 09:27:41 +02:00
parent 30343809e9
commit 2d1c1fcebe
1 changed files with 71 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
Scripts/unused-functions.sh Executable file
View File

@ -0,0 +1,71 @@
#!/bin/sh
# Copyright (c) 2025 Franco Fichtner <franco@opnsense.org>
#
# 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 THE AUTHOR AND 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 THE AUTHOR OR 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.
PLUGINS="configure cron devices firewall interfaces run services syslog xmlprc_sync"
if [ -n "${1}" ]; then
cd "${1}"
fi
TESTDIR=src
DIRS=${TESTDIR}
NOTE="(did not check plugins)"
if [ -d ../plugins ]; then
DIRS="${DIRS} ../plugins"
NOTE="(cross-checked plugins)"
fi
grep -Eor '^function &?[^( ]+' ${TESTDIR} | tr ':' ' ' | tr -d '&' | while read FILE X FUNC; do
BASEDIR=$(dirname ${FILE})
BASEDIR=$(basename ${BASEDIR})
MODULE=$(basename ${FILE})
MODULE=${MODULE%.inc}
# exclude indirect plugin calls not otherwise referenced
if [ "${BASEDIR}" = "plugins.inc.d" ]; then
for PLUGIN in ${PLUGINS}; do
if [ "${FUNC}" = "${MODULE}_${PLUGIN}" ]; then
continue 2
fi
done
fi
# either by direct call xxx( or wrapped in single quotes
USED=$(grep -Fr -e "${FUNC}(" -e "'${FUNC}'" ${DIRS} | wc -l | awk '{ print $1 }')
if [ ${USED} -le 1 ]; then
echo "${FUNC}() appears unused" ${NOTE}
elif [ ${USED} -eq 2 ]; then
# XXX if a match happens in the same file it's probably already considered ;)
echo "${FUNC}() only used once, consider refactor"
else
USED=$((USED - 1))
#echo "${FUNC}() used ${USED} times"
fi
done