GNOME.org
 

[nautilus-actions] tools/check-headers.sh: checks for completeness of header files

commit 76a8b5c1e71b41c27510965c84b153d4c606ca46
Author: Pierre Wieser <pwieser trychlos org>
Date:   Sun Jan 16 17:25:15 2011 +0100

    tools/check-headers.sh: checks for completeness of header files

 ChangeLog               |   17 +++
 Makefile.am             |    1 +
 configure.ac            |    1 +
 src/test/.gitignore     |    1 -
 src/test/Makefile.am    |    9 --
 src/test/test-include.c |   11 --
 tools/.gitignore        |    2 +
 tools/Makefile.am       |   46 +++++++
 tools/check-header.c    |    2 +
 tools/check-headers.sh  |  309 +++++++++++++++++++++++++++++++++++++++++++++++
 10 files changed, 378 insertions(+), 21 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6632501..6c05870 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2011-01-16 Pierre Wieser <pwieser trychlos org>
+
+	Add a script to check completeness of header files.
+
+	* tools/.gitignore:
+	* tools/Makefile.am:
+	* tools/check-headers.sh: New files.
+
+	* src/test/test-include.c:
+	Renamed as tools/check-header.c and set it as ignored by git.
+
+	* src/test/.gitignore:
+	* src/test/Makefile.am: Updated accordingly.
+
+	* Makefile.am:
+	* configure.ac: configure in tools/.
+
 2011-01-14 Pierre Wieser <pwieser trychlos org>
 
 	* src/utils/nautilus-actions-new.c:
diff --git a/Makefile.am b/Makefile.am
index 9612083..daf3337 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -35,6 +35,7 @@ SUBDIRS = \
 	po									\
 	data								\
 	docs								\
+	tools								\
 	$(NULL)
 
 # a foo directory so that make distcheck has a vpath which is prefixed
diff --git a/configure.ac b/configure.ac
index 2e9f992..7a653da 100644
--- a/configure.ac
+++ b/configure.ac
@@ -65,6 +65,7 @@ AC_CONFIG_FILES([
 	src/nact/Makefile
 	src/test/Makefile
 	src/utils/Makefile
+	tools/Makefile
 	po/Makefile.in
 ])
 
diff --git a/src/test/.gitignore b/src/test/.gitignore
index 03dd33a..8b89352 100644
--- a/src/test/.gitignore
+++ b/src/test/.gitignore
@@ -1,4 +1,3 @@
-test-include
 test-parse-uris
 test-reader
 test-virtuals
diff --git a/src/test/Makefile.am b/src/test/Makefile.am
index 8766762..8d6d8d0 100644
--- a/src/test/Makefile.am
+++ b/src/test/Makefile.am
@@ -29,7 +29,6 @@
 noinst_PROGRAMS = \
 	test-reader											\
 	test-iface											\
-	test-include										\
 	test-parse-uris										\
 	test-virtuals										\
 	test-virtuals-without-test							\
@@ -66,14 +65,6 @@ test_iface_LDADD = \
 	$(NAUTILUS_ACTIONS_LIBS)							\
 	$(NULL)
 
-test_include_SOURCES = \
-	test-include.c										\
-	$(NULL)
-
-test_include_LDADD = \
-	$(NAUTILUS_ACTIONS_LIBS)							\
-	$(NULL)
-
 test_parse_uris_SOURCES = \
 	test-parse-uris.c									\
 	$(NULL)
diff --git a/tools/.gitignore b/tools/.gitignore
new file mode 100644
index 0000000..dea23e9
--- /dev/null
+++ b/tools/.gitignore
@@ -0,0 +1,2 @@
+check-header
+check-header.c
diff --git a/tools/Makefile.am b/tools/Makefile.am
new file mode 100644
index 0000000..2ecd05e
--- /dev/null
+++ b/tools/Makefile.am
@@ -0,0 +1,46 @@
+# Nautilus-Actions
+# A Nautilus extension which offers configurable context menu actions.
+#
+# Copyright (C) 2005 The GNOME Foundation
+# Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+# Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
+#
+# This Program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This Program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this Library; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307, USA.
+#
+# Authors:
+#   Frederic Ruaudel <grumz grumz net>
+#   Rodrigo Moya <rodrigo gnome-db org>
+#   Pierre Wieser <pwieser trychlos org>
+#   ... and many others (see AUTHORS)
+
+noinst_PROGRAMS = \
+	check-header												\
+	$(NULL)
+
+AM_CPPFLAGS += \
+	-I $(top_srcdir)											\
+	-I $(top_srcdir)/src										\
+	$(NAUTILUS_ACTIONS_CFLAGS)									\
+	$(NULL)
+
+check_header_SOURCES = \
+	check-header.c												\
+	$(NULL)
+
+check_header_LDADD = \
+	$(top_builddir)/src/core/libna-core.la						\
+	$(NAUTILUS_ACTIONS_LIBS)									\
+	$(NULL)
diff --git a/tools/check-header.c b/tools/check-header.c
new file mode 100644
index 0000000..7bf9b0f
--- /dev/null
+++ b/tools/check-header.c
@@ -0,0 +1,2 @@
+#include <src/api/na-gconf-utils.h>
+int main( int argc, char **argv ){ return( 0 ); }
diff --git a/tools/check-headers.sh b/tools/check-headers.sh
new file mode 100755
index 0000000..4db6fda
--- /dev/null
+++ b/tools/check-headers.sh
@@ -0,0 +1,309 @@
+#!/bin/sh
+# Nautilus-Actions
+# A Nautilus extension which offers configurable context menu actions.
+#
+# Copyright (C) 2005 The GNOME Foundation
+# Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+# Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
+#
+# This Program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This Program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this Library; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307, USA.
+#
+# Authors:
+#   Frederic Ruaudel <grumz grumz net>
+#   Rodrigo Moya <rodrigo gnome-db org>
+#   Pierre Wieser <pwieser trychlos org>
+#   ... and many others (see AUTHORS)
+
+errs=0										# will be the exit code of the script
+my_cmd="${0}"								# e.g. "./make-ks.sh"
+my_parms="$*"								# e.g. "-host toaster"
+my_cmdline="${my_cmd} ${my_parms}"
+me="$(basename ${my_cmd})"					# e.g. "make-ks.sh"
+											# used in msg and msgerr functions
+my_tmproot="/tmp/$(echo ${me} | sed 's?\..*$??').$$"
+											# e.g. "/tmp/make-ks.1978"
+
+# These three functions must be defined using the name() syntax in order
+# to share traps with the caller process (cf. man (1) ksh).
+#
+trap_exit()
+{
+	clear_tmpfiles
+	[ "${opt_verbose}" = "yes" -o ${errs} -gt 0 ] && msg "exiting with code ${errs}"
+	exit ${errs}
+}
+
+trap_int()
+{
+	msg "quitting on keyboard interrupt"
+	let errs+=1
+	exit
+}
+
+trap_term()
+{
+	[ "${opt_verbose}" = "yes" ] && msg "quitting on TERM signal"
+	exit
+}
+
+# setup the different trap functions
+trap 'trap_term' TERM
+trap 'trap_int'  INT
+trap 'trap_exit' EXIT
+
+function clear_tmpfiles
+{
+	\rm -f ${my_tmproot}.*
+}
+
+function msg
+{
+	typeset _eol="\n"
+	[ $# -ge 2 ] && _eol="${2}"
+	printf "[%s] %s${_eol}" ${me} "${1}"
+	return 0
+}
+
+function msgerr
+{
+	msg "error: ${1}" 1>&2
+	return $?
+}
+
+function msgwarn
+{
+	msg "warning: ${1}" 1>&2
+	return $?
+}
+
+function msg_help
+{
+	msg_version
+	echo "
+ This script checks for header files consistency and completeness.
+ It ensures that each header files itself includes the set of prequisite
+ header files in order the tested header be auto-sufficent.
+
+ Usage: ${my_cmd} [options]
+   --[no]help                print this message, and exit [${opt_help_def}]
+   --[no]version             print script version, and exit [${opt_version_def}]
+   --[no]dummy               dummy execution [${opt_dummy_def}]
+   --[no]verbose             runs verbosely [${opt_verbose_def}]"
+}
+
+function msg_version
+{
+	pck_name=$(grep '^PACKAGE_NAME' Makefile | awk '{ print $3 }')
+	pck_version=$(grep '^PACKAGE_VERSION' Makefile | awk '{ print $3 }')
+	echo "
+ ${pck_name} v ${pck_version}
+ Copyright (C) 2011 Pierre Wieser."
+}
+
+# initialize common command-line options
+nbopt=$#
+opt_help=
+opt_help_def="no"
+opt_dummy=
+opt_dummy_def="yes"
+opt_version=
+opt_version_def="no"
+opt_verbose=
+opt_verbose_def="no"
+
+# a first loop over command line arguments to detect verbose mode
+while :
+do
+	# break when all arguments have been read
+	case $# in
+		0)
+			break
+			;;
+	esac
+
+	# get and try to interpret the next argument
+	_option=$1
+	shift
+
+	# make all options have two hyphens
+	_orig_option=${_option}
+	case ${_option} in
+		--*)
+			;;
+		-*)
+			_option=-${_option}
+				;;
+		esac
+
+	# now process options and their argument
+	case ${_option} in
+		--noverb | --noverbo | --noverbos | --noverbose)
+			opt_verbose="no"
+			;;
+		--verb | --verbo | --verbos | --verbose)
+			opt_verbose="yes"
+				;;
+	esac
+done
+
+[ "${opt_verbose}" = "yes" ] && msg "setting opt_verbose to 'yes'"
+
+# we have scanned all command-line arguments in order to detect an
+# opt_verbose option;
+# reset now arguments so that they can be scanned again in main script
+set -- ${my_parms}
+
+# interpreting command-line arguments
+opt_potfile=
+opt_potfile_def="po/POTFILES.in"
+
+# loop over command line arguments
+pos=0
+while :
+do
+	# break when all arguments have been read
+	case $# in
+		0)
+			break
+			;;
+	esac
+
+	# get and try to interpret the next argument
+	option=$1
+	shift
+
+	# make all options have two hyphens
+	orig_option=${option}
+	case ${option} in
+		--*)
+			;;
+		-*)
+			option=-${option}
+			;;
+	esac
+
+	# split and extract argument for options that take one
+	case ${option} in
+		--*=*)
+			optarg=$(echo ${option} | sed -e 's/^[^=]*=//')
+			option=$(echo ${option} | sed 's/=.*//')
+			;;
+		# these options take a mandatory argument
+		# since, we didn't find it in 'option', so it should be
+		# next word in the command line
+		#--p | -po | -pot | -potf | -potfi | -potfil | -potfile)
+		#	optarg=$1
+		#	shift
+		#	;;
+	esac
+
+	# now process options and their argument
+	case ${option} in
+		--d | --du | --dum | --dumm | --dummy)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_dummy to 'yes'"
+			opt_dummy="yes"
+			;;
+		--h | --he | --hel | --help)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_help to 'yes'"
+			opt_help="yes"
+			;;
+		--nod | --nodu | --nodum | --nodumm | --nodummy)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_dummy to 'no'"
+			opt_dummy="no"
+			;;
+		--noh | --nohe | --nohel | --nohelp)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_help to 'no'"
+			opt_help="no"
+			;;
+		--noverb | --noverbo | --noverbos | --noverbose)
+			;;
+		--novers | --noversi | --noversio | --noversion)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_version to 'no'"
+			opt_version="no"
+			;;
+		--verb | --verbo | --verbos | --verbose)
+			;;
+		--vers | --versi | --versio | --version)
+			[ "${opt_verbose}" = "yes" ] && msg "setting opt_version to 'yes'"
+			opt_version="yes"
+			;;
+		--*)
+			msgerr "unrecognized option: '${orig_option}'"
+			let errs+=1
+			;;
+		# positional parameters
+		*)
+			let pos+=1
+			#if [ ${pos} -eq 1 ]; then
+			#	[ "${opt_verbose}" = "yes" ] && msg "setting opt_output to '${option}'"
+			#	opt_output=${option}
+			#else
+				msgerr "unexpected positional parameter #${pos}: '${option}'"
+				let errs+=1
+			#fi
+			;;
+	esac
+done
+
+# set option defaults
+# does not work with /bin/sh ??
+#set | grep -e '^opt_' | cut -d= -f1 | while read _name; do
+#	if [ "$(echo ${_name} | sed 's/.*\(_def\)/\1/')" != "_def" ]; then
+#		_value="$(eval echo "$"${_name})"
+#		if [ "${_value}" = "" ]; then
+#			eval ${_name}="$(eval echo "$"${_name}_def)"
+#		fi
+#	fi
+#done
+
+opt_help=${opt_help:-${opt_help_def}}
+opt_dummy=${opt_dummy:-${opt_dummy_def}}
+opt_verbose=${opt_verbose:-${opt_verbose_def}}
+opt_version=${opt_version:-${opt_version_def}}
+
+if [ "${opt_help}" = "yes" -o ${nbopt} -eq 0 ]; then
+	msg_help
+	echo ""
+	exit
+fi
+
+if [ "${opt_version}" = "yes" ]; then
+	msg_version
+	echo ""
+	exit
+fi
+
+if [ ${errs} -gt 0 ]; then
+	msg "${errs} error(s) have been detected"
+	msg "try '${my_cmd} --help' for usage"
+	exit
+fi
+
+# ---------------------------------------------------------------------
+# MAIN CODE
+
+for f in $(git ls-files src | grep '\.h$' | grep -v '^src/test'); do
+	msg "checking for $f..." " "
+	tmpc=tools/check-header.c
+	cat <<! >${tmpc}
+#include <${f}>
+int main( int argc, char **argv ){ return( 0 ); }
+!
+	make -C tools check-header 1>/dev/null 2>&1 && tools/check-header 1>/dev/null 2>&1
+	[ $? -eq 0 ] && echo "OK" || { echo "NOT OK"; let errs+=1; }
+done
+
+exit
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]