aboutsummaryrefslogblamecommitdiffstats
path: root/tools/check-c-style.sh
blob: 4330b1479f6154ef4752787ea86e7f3a5129f16f (plain) (tree)

























                                                                              



















                                                                              












                                                                        









                                                 
#!/bin/sh
fail=0

( . "${tools_dir}"/check-misc.sh ) || fail=$?

if grep -n '^ *GError *\*[[:alpha:]_][[:alnum:]_]* *;' "$@"
then
  echo "^^^ The above files contain uninitialized GError*s - they should be"
  echo "    initialized to NULL"
  fail=1
fi

# The first regex finds function calls like foo() (as opposed to foo ()).
#   It attempts to ignore string constants (may cause false negatives).
# The second and third ignore block comments (gtkdoc uses foo() as markup).
# The fourth ignores cpp so you can
#   #define foo(bar) (_real_foo (__FUNC__, bar)) (cpp insists on foo() style).
if grep -n '^[^"]*[[:lower:]](' "$@" \
  | grep -v '^[-[:alnum:]_./]*:[[:digit:]]*: *\*' \
  | grep -v '^[-[:alnum:]_./]*:[[:digit:]]*: */\*' \
  | grep -v '^[-[:alnum:]_./]*:[[:digit:]]*: *#'
then
  echo "^^^ Our coding style is to use function calls like foo (), not foo()"
  fail=1
fi

if grep -En '[(][[:alnum:]_]+ ?\*[)][(]?[[:alpha:]_]' "$@"; then
  echo "^^^ Our coding style is to have a space between a cast and the "
  echo "    thing being cast"
  fail=1
fi

# this only spots casts
if grep -En '[(][[:alnum:]_]+\*+[)]' "$@"; then
  echo "^^^ Our coding style is to have a space before the * of pointer types"
  echo "    (regex 1)"
  fail=1
fi
# ... and this only spots variable declarations and function return types
if grep -En '^ *(static |const |)* *[[:alnum:]_]+\*+([[:alnum:]_]|;|$)' \
    "$@"; then
  echo "^^^ Our coding style is to have a space before the * of pointer types"
  echo "    (regex 2)"
  fail=1
fi

if grep -n 'g_hash_table_destroy' "$@"; then
  echo "^^^ Our coding style is to use g_hash_table_unref"
  fail=1
fi

for p in "" "ptr_" "byte_"; do
  if grep -En "g_${p}array_free \(([^ ,]+), TRUE\)" "$@"; then
    echo "^^^ Our coding style is to use g_${p}array_unref in the case "
    echo "    the underlying C array is not used"
    fail=1
  fi
done

if test -n "$CHECK_FOR_LONG_LINES"
then
  if egrep -n '.{80,}' "$@"
  then
    echo "^^^ The above files contain long lines"
    fail=1
  fi
fi

exit $fail