admin/reformat_all.sh

   1 #!/bin/bash
   2 #
   3 # This file is part of the GROMACS molecular simulation package.
   4 #
   5 # Copyright (c) 2014,2015, by the GROMACS development team, led by
   6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7 # and including many others, as listed in the AUTHORS file in the
   8 # top-level source directory and at http://www.gromacs.org.
   9 #
  10 # GROMACS is free software; you can redistribute it and/or
  11 # modify it under the terms of the GNU Lesser General Public License
  12 # as published by the Free Software Foundation; either version 2.1
  13 # of the License, or (at your option) any later version.
  14 #
  15 # GROMACS is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 # Lesser General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU Lesser General Public
  21 # License along with GROMACS; if not, see
  22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24 #
  25 # If you want to redistribute modifications to GROMACS, please
  26 # consider that scientific software is very special. Version
  27 # control is crucial - bugs must be traceable. We will be happy to
  28 # consider code for inclusion in the official distribution, but
  29 # derived work must not be called official GROMACS. Details are found
  30 # in the README & COPYING files - if they are missing, get the
  31 # official version at http://www.gromacs.org.
  32 #
  33 # To help us fund GROMACS development, we humbly ask that you cite
  34 # the research papers on the package. Check out http://www.gromacs.org.
  35
  36 # This script runs uncrustify, copyright header checks, or include sorter on
  37 # all applicable files in the source tree.
  38 #
  39 # See `reformat_all.sh -h` for a brief usage, and docs/dev-manual/uncrustify.rst
  40 # for more details (docs/dev-manual/gmxtree.rst for include sorter).
  41
  42 function usage() {
  43     echo "usage: reformat_all.sh [-f|--force]"
  44     echo "           [--filter=(uncrustify|copyright|includesort)]"
  45     echo "           [--pattern=<pattern>] [<action>] [-B=<build dir>]"
  46     echo "<action>: (list-files|uncrustify*|copyright|includesort) (*=default)"
  47 }
  48
  49 filter=default
  50 force=
  51 patterns=()
  52 action=uncrustify
  53 for arg in "$@" ; do
  54     if [[ "$arg" == "list-files" || "$arg" == "uncrustify" ||
  55           "$arg" == "copyright" || "$arg" == "includesort" ]] ; then
  56         action=$arg
  57     elif [[ "$arg" == --filter=* ]] ; then
  58         filter=${arg#--filter=}
  59     elif [[ "$arg" == --pattern=* ]] ; then
  60         patterns[${#patterns[@]}]=${arg#--pattern=}
  61     elif [[ "$arg" == -B=* ]] ; then
  62         builddir=${arg#-B=}
  63     elif [[ "$arg" == "-f" || "$arg" == "--force" ]] ; then
  64         force=1
  65     elif [[ "$arg" == "-h" || "$arg" == "--help" ]] ; then
  66         usage
  67         exit 0
  68     else
  69         echo "Unknown option: $arg"
  70         echo
  71         usage
  72         exit 2
  73     fi
  74 done
  75
  76 if [[ ! "$force" && "$action" != "list-files" ]] ; then
  77     if ! git diff-files --quiet ; then
  78         echo "Modified files found in work tree. Use -f to override."
  79         exit 1
  80     fi
  81 fi
  82
  83 case "$action" in
  84     list-files)
  85         command=cat
  86         ;;
  87     uncrustify)
  88         # Check that uncrustify is present
  89         if [ -z "$UNCRUSTIFY" ] ; then
  90             echo "Please set the path to uncrustify using UNCRUSTIFY."
  91             echo "Note that you need a custom version of uncrustify."
  92             echo "See comments in the script file for how to get one."
  93             exit 2
  94         fi
  95         if ! which "$UNCRUSTIFY" 1>/dev/null ; then
  96             echo "Uncrustify not found: $UNCRUSTIFY"
  97             exit 2
  98         fi
  99         command="xargs $UNCRUSTIFY -c admin/uncrustify.cfg --no-backup"
 100         ;;
 101     copyright)
 102         command="xargs admin/copyright.py --check"
 103         ;;
 104     includesort)
 105         if [ -z "${builddir}" ] ; then
 106             echo "Build directory must be set with -B for includesort."
 107             exit 2
 108         fi
 109         command="docs/doxygen/includesorter.py -S . -B ${builddir} -F -"
 110         ;;
 111     *)
 112         echo "Unknown action: $action"
 113         exit 2
 114 esac
 115
 116 if [[ "$filter" == "default" ]] ; then
 117     filter=$action
 118 fi
 119
 120 case "$filter" in
 121     includesort)
 122         filter_re="(uncrustify|includesort)"
 123         ;;
 124     uncrustify)
 125         filter_re="(uncrustify|uncrustify_only)"
 126         ;;
 127     copyright)
 128         filter_re="(uncrustify|copyright|includesort)"
 129         ;;
 130     *)
 131         echo "Unknown filter mode: $filter"
 132         echo
 133         usage
 134         exit 2
 135 esac
 136
 137 cd `git rev-parse --show-toplevel`
 138
 139 if ! git ls-files "${patterns[@]}" | git check-attr --stdin filter | \
 140     sed -nEe "/${filter_re}$/ {s/:.*//;p;}" | $command ; then
 141     echo "The reformatting command failed! Please check the output."
 142     exit 1
 143 fi