admin/uncrustify.sh

   1 #!/bin/bash
   2 #
   3 # This file is part of the GROMACS molecular simulation package.
   4 #
   5 # Copyright (c) 2013,2014,2015,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 on modified files and
  37 # reports/applies the necessary changes.
  38 #
  39 # See `uncrustify.sh -h` for a brief usage, and docs/dev-manual/code-formatting.rst
  40 # for more details.
  41
  42 # Parse command-line arguments
  43 function usage() {
  44     echo "usage: uncrustify.sh [-f|--force] [--rev=REV]"
  45     echo "           [--uncrustify=(off|check)]"
  46     echo "           [--warnings=<file>] [<action>]"
  47     echo "<action>: (check*|diff|update)[-(index|workdir*)] (*=default)"
  48 }
  49
  50 action="check-workdir"
  51 declare -a diffargs
  52 baserev="HEAD"
  53 force=
  54 uncrustify_mode=check
  55 warning_file=
  56 for arg in "$@" ; do
  57     if [[ "$arg" == "check-index" || "$arg" == "check-workdir" || \
  58           "$arg" == "diff-index" || "$arg" == "diff-workdir" || \
  59           "$arg" == "update-index" || "$arg" == "update-workdir" ]]
  60     then
  61         action=$arg
  62     elif [[ "$arg" == "check" || "$arg" == "diff" || "$arg" == "update" ]] ; then
  63         action=$arg-workdir
  64     elif [[ "$action" == diff-* ]] ; then
  65         diffargs+=("$arg")
  66     elif [[ "$arg" == --uncrustify=* ]] ; then
  67         uncrustify_mode=${arg#--uncrustify=}
  68         if [[ "$uncrustify_mode" != "off" && "$uncrustify_mode" != "check" ]] ; then
  69             echo "Unknown option: $arg"
  70             echo
  71             usage
  72             exit 2
  73         fi
  74     elif [[ "$arg" == "-f" || "$arg" == "--force" ]] ; then
  75         force=1
  76     elif [[ "$arg" == --rev=* ]] ; then
  77         baserev=${arg#--rev=}
  78     elif [[ "$arg" == --warnings=* ]] ; then
  79         warning_file=${arg#--warnings=}
  80     elif [[ "$arg" == "-h" || "$arg" == "--help" ]] ; then
  81         usage
  82         exit 0
  83     else
  84         echo "Unknown option: $arg"
  85         echo
  86         usage
  87         exit 2
  88     fi
  89 done
  90
  91 # Check that uncrustify is present
  92 if [[ "$uncrustify_mode" != "off" ]]
  93 then
  94     if [ -z "$UNCRUSTIFY" ]
  95     then
  96         UNCRUSTIFY=`git config hooks.uncrustifypath`
  97     fi
  98     if [ -z "$UNCRUSTIFY" ]
  99     then
 100         echo "Please set the path to uncrustify using UNCRUSTIFY or"
 101         echo "git config hooks.uncrustifypath."
 102         echo "Note that you need a custom version of uncrustify."
 103         echo "See docs/dev-manual/uncrustify.rst for how to get one."
 104         exit 2
 105     fi
 106     if ! which "$UNCRUSTIFY" 1>/dev/null
 107     then
 108         echo "Uncrustify not found: $UNCRUSTIFY"
 109         exit 2
 110     fi
 111 fi
 112
 113 # Switch to the root of the source tree and check the config file
 114 srcdir=`git rev-parse --show-toplevel`
 115 pushd $srcdir >/dev/null
 116 admin_dir=$srcdir/admin
 117 cfg_file=$admin_dir/uncrustify.cfg
 118 if [ ! -f "$cfg_file" ]
 119 then
 120     echo "Uncrustify configuration file not found: $cfg_file"
 121     exit 2
 122 fi
 123
 124 # Actual processing starts: create a temporary directory
 125 tmpdir=`mktemp -d -t gmxuncrust.XXXXXX`
 126
 127 # Produce a list of changed files
 128 # Only include files that have proper filter set in .gitattributes
 129 internal_diff_args=
 130 if [[ $action == *-index ]]
 131 then
 132     internal_diff_args="--cached"
 133 fi
 134 git diff-index $internal_diff_args --diff-filter=ACMR $baserev >$tmpdir/difflist
 135 cut -f2 <$tmpdir/difflist | \
 136     git check-attr --stdin filter | \
 137     sed -e 's/.*: filter: //' | \
 138     paste $tmpdir/difflist - | \
 139     grep -E '(complete_formatting|uncrustify|copyright|includesort)$' >$tmpdir/filtered
 140 cut -f2 <$tmpdir/filtered >$tmpdir/filelist_all
 141 grep -E '(uncrustify)$' <$tmpdir/filtered | \
 142     cut -f2 >$tmpdir/filelist_uncrustify
 143 git diff-files --name-only | grep -Ff $tmpdir/filelist_all >$tmpdir/localmods
 144
 145 # Extract changed files to a temporary directory
 146 mkdir $tmpdir/org
 147 if [[ $action == *-index ]] ; then
 148     git checkout-index --prefix=$tmpdir/org/ --stdin <$tmpdir/filelist_all
 149 else
 150     rsync --files-from=$tmpdir/filelist_all $srcdir $tmpdir/org
 151 fi
 152 # Duplicate the original files to a separate directory, where all changes will
 153 # be made.
 154 cp -r $tmpdir/org $tmpdir/new
 155
 156 # Create output file for what was done (in case no messages get written)
 157 touch $tmpdir/messages
 158
 159 # Run uncrustify on the temporary directory
 160 cd $tmpdir/new
 161 if [[ $uncrustify_mode != "off" ]] ; then
 162     if ! $UNCRUSTIFY -c $cfg_file -F $tmpdir/filelist_uncrustify --no-backup >$tmpdir/uncrustify.out 2>&1 ; then
 163         echo "Reformatting failed. Check uncrustify output below for errors:"
 164         cat $tmpdir/uncrustify.out
 165         rm -rf $tmpdir
 166         exit 2
 167     fi
 168     # Find the changed files if necessary
 169     if [[ $action != diff-* ]] ; then
 170         msg="needs uncrustify"
 171         if [[ $action == update-* ]] ; then
 172             msg="uncrustified"
 173         fi
 174         git diff --no-index --name-only ../org/ . | \
 175             awk -v msg="$msg" '{sub(/.\//,""); print $0 ": " msg}' >> $tmpdir/messages
 176     fi
 177     # TODO: Consider checking whether rerunning uncrustify causes additional changes
 178 fi
 179
 180 cd $tmpdir
 181
 182 # If a diff was requested, show it and we are done
 183 if [[ $action == diff-* ]] ; then
 184     git diff --no-index --no-prefix "${diffargs[@]}" org/ new/
 185     rm -rf $tmpdir
 186     exit 0
 187 fi
 188
 189 # Find the changed files
 190 git diff --no-index --name-only --exit-code org/ new/ | \
 191     sed -e 's#new/##' > $tmpdir/changed
 192 changes=
 193 if [[ -s $tmpdir/changed ]]
 194 then
 195     changes=1
 196 fi
 197
 198 # Check if changed files have changed outside the index
 199 if grep -Ff $tmpdir/localmods $tmpdir/changed > $tmpdir/conflicts
 200 then
 201     awk '{print $0 ": has changes in work tree"}' $tmpdir/conflicts \
 202         >> $tmpdir/messages
 203     if [[ ! $force && $action == update-* ]] ; then
 204         echo "Modified files found in work tree, skipping update. Use -f to override."
 205         echo "The following would have been done:"
 206         sort $tmpdir/messages
 207         rm -rf $tmpdir
 208         exit 2
 209     fi
 210 fi
 211
 212 # Update the index/work tree if requested
 213 if [[ $action == update-index ]] ; then
 214     grep -Ff $tmpdir/changed $tmpdir/filtered > $tmpdir/tohash
 215     cd $tmpdir/new
 216     IFS='
 217 '
 218     for change in `cut -f2 $tmpdir/tohash | \
 219                    git --git-dir=$srcdir/.git hash-object -w --stdin-paths --no-filters | \
 220                    paste - $tmpdir/tohash`
 221     do
 222         # NOTE: the patterns below contain literal tabs
 223         sha1=${change%% *}
 224         rest=${change#* }
 225         mode=${rest:8:6}
 226         path=${rest#*   }
 227         path=${path%%   *}
 228         # Contains a literal tab
 229         echo "$mode $sha1       $path" >> $tmpdir/toindex
 230     done
 231     unset IFS
 232     git --git-dir=$srcdir/.git update-index --index-info < $tmpdir/toindex
 233 elif [[ $action == update-workdir ]] ; then
 234     rsync --files-from=$tmpdir/changed $tmpdir/new/ $srcdir/
 235 fi
 236
 237 # Get back to the original directory
 238 popd >/dev/null
 239
 240 # Report what was done
 241 sort $tmpdir/messages | tee $warning_file
 242
 243 rm -rf $tmpdir
 244 exit $changes