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,2016,2017,2019, 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, clang-format, 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/code-formatting.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=(complete_formatting|clangformat|uncrustify|copyright|includesort)]"
  45     echo "           [--pattern=<pattern>] [<action>] [-B=<build dir>]"
  46     echo "<action>: (list-files|uncrustify|clang-format*|copyright|includesort) (*=default)"
  47 }
  48
  49 filter=default
  50 force=
  51 patterns=()
  52 action=clang-format
  53 for arg in "$@" ; do
  54     if [[ "$arg" == "list-files" || "$arg" == "uncrustify" ||
  55           "$arg" == "clang-format" || "$arg" == "copyright" ||
  56           "$arg" == "includesort" ]] ; then
  57         action=$arg
  58     elif [[ "$arg" == --filter=* ]] ; then
  59         filter=${arg#--filter=}
  60     elif [[ "$arg" == --pattern=* ]] ; then
  61         patterns[${#patterns[@]}]=${arg#--pattern=}
  62     elif [[ "$arg" == -B=* ]] ; then
  63         builddir=${arg#-B=}
  64     elif [[ "$arg" == "-f" || "$arg" == "--force" ]] ; then
  65         force=1
  66     elif [[ "$arg" == "-h" || "$arg" == "--help" ]] ; then
  67         usage
  68         exit 0
  69     else
  70         echo "Unknown option: $arg"
  71         echo
  72         usage
  73         exit 2
  74     fi
  75 done
  76
  77 if [[ ! "$force" && "$action" != "list-files" ]] ; then
  78     if ! git diff-files --quiet ; then
  79         echo "Modified files found in work tree. Use -f to override."
  80         exit 1
  81     fi
  82 fi
  83
  84 case "$action" in
  85     list-files)
  86         command=cat
  87         ;;
  88     uncrustify)
  89         # Check that uncrustify is present
  90         if [ -z "$UNCRUSTIFY" ] ; then
  91             echo "Please set the path to uncrustify using UNCRUSTIFY."
  92             echo "Note that you need a custom version of uncrustify."
  93             echo "See comments in the script file for how to get one."
  94             exit 2
  95         fi
  96         if ! which "$UNCRUSTIFY" 1>/dev/null ; then
  97             echo "Uncrustify not found: $UNCRUSTIFY"
  98             exit 2
  99         fi
 100         command="xargs $UNCRUSTIFY -c admin/uncrustify.cfg --no-backup"
 101         ;;
 102     clang-format)
 103         if [ -z "$CLANG_FORMAT" ] ; then
 104             CLANG_FORMAT=clang-format
 105         fi
 106         if ! which "$CLANG_FORMAT" 1>/dev/null ; then
 107             echo "clang-format not found. Specify one with CLANG_FORMAT"
 108             exit 2
 109         fi
 110         command="xargs $CLANG_FORMAT -i"
 111         ;;
 112     copyright)
 113         command="xargs admin/copyright.py --check"
 114         ;;
 115     includesort)
 116         if [ -z "${builddir}" ] ; then
 117             echo "Build directory must be set with -B for includesort."
 118             exit 2
 119         fi
 120         command="docs/doxygen/includesorter.py -S . -B ${builddir} -F -"
 121         ;;
 122     *)
 123         echo "Unknown action: $action"
 124         exit 2
 125 esac
 126
 127 if [[ "$filter" == "default" ]] ; then
 128     if [[ "$action" == "clang-format" ]] ; then
 129         filter=complete_formatting
 130     else
 131         filter=$action
 132     fi
 133 fi
 134
 135 case "$filter" in
 136     includesort)
 137         filter_re="(complete_formatting|includesort)"
 138         ;;
 139     uncrustify)
 140         filter_re="(uncrustify)"
 141         ;;
 142     copyright)
 143         filter_re="(complete_formatting|copyright)"
 144         ;;
 145     clangformat)
 146         filter_re="(complete_formatting|clangformat)"
 147         ;;
 148     complete_formatting)
 149         filter_re="(complete_formatting|clangformat|includesort|copyright)"
 150         ;;
 151     *)
 152         echo "Unknown filter mode: $filter"
 153         echo
 154         usage
 155         exit 2
 156 esac
 157
 158 cd `git rev-parse --show-toplevel`
 159
 160 if ! git ls-files "${patterns[@]}" | git check-attr --stdin filter | \
 161     sed -nEe "/${filter_re}$/ {s/:.*//;p;}" | $command ; then
 162     echo "The reformatting command failed! Please check the output."
 163     exit 1
 164 fi