From f2bfef0b0c1709079661cbbc889e3f554a231b18 Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Wed, 27 Dec 2017 22:34:19 +0100
Subject: [PATCH] Initial import of fixme.sh

---
 doc/scripts/fixme.sh     | 162 +++++++++++++++++++++++++++++++++++++++
 doc/scripts/project.conf |   5 +-
 2 files changed, 166 insertions(+), 1 deletion(-)
 create mode 100755 doc/scripts/fixme.sh

diff --git a/doc/scripts/fixme.sh b/doc/scripts/fixme.sh
new file mode 100755
index 0000000..9080d37
--- /dev/null
+++ b/doc/scripts/fixme.sh
@@ -0,0 +1,162 @@
+#!/bin/sh
+#$Id$
+#Copyright (c) 2017 Pierre Pronchery <khorben@defora.org>
+#
+#Redistribution and use in source and binary forms, with or without
+#modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * 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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.
+
+
+
+#variables
+PROGNAME="fixme.sh"
+PROJECTCONF="../project.conf"
+#executables
+DATE="date"
+DEBUG="_debug"
+FIND="find"
+GREP="grep"
+SORT="sort -n"
+TR="tr"
+
+
+#functions
+#fixme
+_fixme()
+{
+	ret=0
+
+	$DATE
+	echo
+	while read line; do
+		case "$line" in
+			"["*)
+				break
+				;;
+			"subdirs="*)
+				subdirs=${line#subdirs=}
+				subdirs=$(echo "$subdirs" | $TR ',' ' ')
+				;;
+		esac
+	done < "$PROJECTCONF"
+	for subdir in $subdirs; do
+		[ -d "../$subdir" ] || continue
+		for filename in $($FIND "../$subdir" -type f | $SORT); do
+			callback=
+			case "$filename" in
+				*.c|*.h|*.js)
+					callback="_fixme_c"
+					;;
+				*.conf|*.sh)
+					callback="_fixme_sh"
+					;;
+			esac
+			[ -n "$callback" ] || continue
+			$callback "$filename" 2>&1
+			if [ $? -ne 0 ]; then
+				echo "$PROGNAME: $filename: FAIL" 1>&2
+				ret=2
+			fi
+		done
+	done
+	return $ret
+}
+
+_fixme_c()
+{
+	retc=0
+	filename="$1"
+
+	#warnings
+	$GREP -nH '/\(/\|\*\).*\(TODO\|XXX\)' "$filename"
+	#failures
+	$GREP -nH '/\(/\|\*\).*FIXME' "$filename" && retc=2
+	return $retc
+}
+
+_fixme_sh()
+{
+	retsh=0
+	filename="$1"
+	#XXX avoid matching the regexp
+	comment="#"
+
+	#warnings
+	$GREP -nH "$comment.*\\(TODO\\|XXX\\)" "$filename"
+	#failures
+	$GREP -nH "$comment.*FIXME" "$filename" && retsh=2
+	return $retsh
+}
+
+
+#debug
+_debug()
+{
+	echo "$@" 1>&3
+	"$@"
+	res=$?
+	#ignore errors when the command is not available
+	[ $res -eq 127 ]					&& return 0
+	return $res
+}
+
+
+#usage
+_usage()
+{
+	echo "Usage: $PROGNAME [-c] target..." 1>&2
+	return 1
+}
+
+
+#main
+clean=0
+while getopts "cO:P:" name; do
+	case "$name" in
+		c)
+			clean=1
+			;;
+		O)
+			export "${OPTARG%%=*}"="${OPTARG#*=}"
+			;;
+		P)
+			#XXX ignored for compatibility
+			;;
+		?)
+			_usage
+			exit $?
+			;;
+	esac
+done
+shift $((OPTIND - 1))
+if [ $# -lt 1 ]; then
+	_usage
+	exit $?
+fi
+
+#clean
+[ $clean -ne 0 ] && exit 0
+
+exec 3>&1
+while [ $# -gt 0 ]; do
+	target="$1"
+	shift
+
+	_fixme > "$target"					|| exit 2
+done
diff --git a/doc/scripts/project.conf b/doc/scripts/project.conf
index 6a84743..9017bf3 100644
--- a/doc/scripts/project.conf
+++ b/doc/scripts/project.conf
@@ -1,5 +1,5 @@
 #$Id$
-dist=Makefile,appbroker.sh,clint.sh,docbook.sh,gettext.sh,gtkdoc.sh,htmllint.sh,manual.css.xml,phplint.sh,pkgconfig.sh,platform.sh,pylint.sh,shlint.sh,subst.sh,xmllint.sh
+dist=Makefile,appbroker.sh,clint.sh,docbook.sh,fixme.sh,gettext.sh,gtkdoc.sh,htmllint.sh,manual.css.xml,phplint.sh,pkgconfig.sh,platform.sh,pylint.sh,shlint.sh,subst.sh,xmllint.sh
 
 [appbroker.sh]
 install=$(PREFIX)/share/doc/configure/scripts
@@ -10,6 +10,9 @@ install=$(PREFIX)/share/doc/configure/scripts
 [docbook.sh]
 install=$(PREFIX)/share/doc/configure/scripts
 
+[fixme.sh]
+install=$(PREFIX)/share/doc/configure/scripts
+
 [gettext.sh]
 install=$(PREFIX)/share/doc/configure/scripts