admin/reformat_all.sh

   1 #!/bin/bash
   2 #
   3 # This file is part of the GROMACS molecular simulation package.
   4 #
   5 # Copyright (c) 2014, 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 function usage() {
  37     echo "usage: reformat_all.sh [-f|--force]"
  38     echo "           [--filter=(uncrustify|copyright|includesort)]"
  39     echo "           [--pattern=<pattern>] [<action>] [-B=<build dir>]"
  40     echo "<action>: (list-files|uncrustify*|copyright|includesort) (*=default)"
  41 }
  42
  43 filter=default
  44 force=
  45 patterns=()
  46 action=uncrustify
  47 for arg in "$@" ; do
  48     if [[ "$arg" == "list-files" || "$arg" == "uncrustify" ||
  49           "$arg" == "copyright" || "$arg" == "includesort" ]] ; then
  50         action=$arg
  51     elif [[ "$arg" == --filter=* ]] ; then
  52         filter=${arg#--filter=}
  53     elif [[ "$arg" == --pattern=* ]] ; then
  54         patterns[${#patterns[@]}]=${arg#--pattern=}
  55     elif [[ "$arg" == -B=* ]] ; then
  56         builddir=${arg#-B=}
  57     elif [[ "$arg" == "-f" || "$arg" == "--force" ]] ; then
  58         force=1
  59     else
  60         echo "Unknown option: $arg"
  61         echo
  62         usage
  63         exit 2
  64     fi
  65 done
  66
  67 if [[ ! "$force" && "$action" != "list-files" ]] ; then
  68     if ! git diff-files --quiet ; then
  69         echo "Modified files found in work tree. Use -f to override."
  70         exit 1
  71     fi
  72 fi
  73
  74 case "$action" in
  75     list-files)
  76         command=cat
  77         ;;
  78     uncrustify)
  79         # Check that uncrustify is present
  80         if [ -z "$UNCRUSTIFY" ] ; then
  81             echo "Please set the path to uncrustify using UNCRUSTIFY."
  82             echo "Note that you need a custom version of uncrustify."
  83             echo "See comments in the script file for how to get one."
  84             exit 2
  85         fi
  86         if ! which "$UNCRUSTIFY" 1>/dev/null ; then
  87             echo "Uncrustify not found: $UNCRUSTIFY"
  88             exit 2
  89         fi
  90         command="xargs $UNCRUSTIFY -c admin/uncrustify.cfg --no-backup"
  91         ;;
  92     copyright)
  93         command="xargs admin/copyright.py --check"
  94         ;;
  95     includesort)
  96         if [ -z "${builddir}" ] ; then
  97             echo "Build directory must be set with -B for includesort."
  98             exit 2
  99         fi
 100         command="docs/doxygen/includesorter.py -S . -B ${builddir} -F -"
 101         ;;
 102     *)
 103         echo "Unknown action: $action"
 104         exit 2
 105 esac
 106
 107 if [[ "$filter" == "default" ]] ; then
 108     filter=$action
 109 fi
 110
 111 case "$filter" in
 112     includesort)
 113         filter_re="(uncrustify|includesort)"
 114         ;;
 115     uncrustify)
 116         filter_re="(uncrustify|uncrustify_only)"
 117         ;;
 118     copyright)
 119         filter_re="(uncrustify|copyright|includesort)"
 120         ;;
 121     *)
 122         echo "Unknown filter mode: $filter"
 123         echo
 124         usage
 125         exit 2
 126 esac
 127
 128 cd `git rev-parse --show-toplevel`
 129
 130 if ! git ls-files "${patterns[@]}" | git check-attr --stdin filter | \
 131     sed -nEe "/${filter_re}$/ {s/:.*//;p;}" | $command ; then
 132     echo "The reformatting command failed! Please check the output."
 133     exit 1
 134 fi