[Libreoffice-commits] .: Branch 'libreoffice-3-3' - bin/fix-trailing-whitespace.pl git-hooks/pre-commit

Jan Holesovsky kendy at kemper.freedesktop.org
Wed Nov 10 16:08:39 PST 2010


 bin/fix-trailing-whitespace.pl |   75 ------------
 git-hooks/pre-commit           |  242 +++++++++++++++++++++++++++--------------
 2 files changed, 163 insertions(+), 154 deletions(-)

New commits:
commit 34f84ab45258b066c868c361628e3f8e6eeb414d
Author: Jan Holesovsky <kendy at suse.cz>
Date:   Thu Nov 11 00:41:12 2010 +0100

    git-hooks: Rewrote most of the pre-commit hook in perl.
    
    This was to incorporate the changes from fix-trailing-whitespace.pl,
    otherwise we had problems with locating that script :-(  Separate
    fix-trailing-whitespace.pl is not necessary any more, removed that.
    
    Some pieces still stay as a bigger shell pieces, I did not care enough
    to change those - feel free to improve it, please.

diff --git a/bin/fix-trailing-whitespace.pl b/bin/fix-trailing-whitespace.pl
deleted file mode 100755
index 06614dd..0000000
--- a/bin/fix-trailing-whitespace.pl
+++ /dev/null
@@ -1,75 +0,0 @@
-#!/usr/bin/perl -w
-
-# Reads a patch, and according to what it sees there, it fixes trailing
-# whitespace in the files it touches.  To be used in conjuction with
-# git diff-index, so it assumes that the patch is 'correct' (but has some
-# basic checks to avoid shooting into the leg)
-#
-# The patch has to be ready for -p0 application
-#
-# Usage: git diff-index -p --no-prefix --cached HEAD | fix-trailing-whitespace.pl
-
-use strict;
-use File::Temp qw/ :mktemp  /;
-use File::Copy;
-
-my $patch = $1;
-my $file = "";
-my %lines = ();
-my $line_no = 0;
-my $line_max = -1;
-
-# $1 - file to fix
-# $2 - list of lines containing whitespace errors
-sub fix_whitespace($%) {
-    my ( $file, $lines ) = @_;
-
-    # usually we have nothing to do ;-)
-    return if ( keys( %lines ) == 0 ||
-                $file eq "" ||
-                !( $file =~ /\.(c|cpp|cxx|h|hrc|hxx|idl|inl|java|map|mk|MK|pl|pm|pmk|py|sdi|sh|src|tab)/ ) );
-
-    open( IN, "$file" ) || die "Cannot open $file for reading";
-    my ( $out, $tmpfile ) = mkstemp( "/tmp/whitespace-fixing-XXXXXX" );
-
-    my $line_no = 1;
-    while ( my $line = <IN> ) {
-        if ( $lines{$line_no} && $line =~ /^(.*[^ \t])[ \t]+$/ ) {
-            print $out "$1\n";
-        }
-        elsif ( $lines{$line_no} && $line =~ /^[ \t]+$/ ) {
-            print $out "\n";
-        }
-        else {
-            print $out $line;
-        }
-        ++$line_no;
-    }
-    close( $out );
-    close( IN );
-
-    move( $tmpfile, $file ) or die "Cannot move '$tmpfile' to '$file'";
-    print "$file\n"
-}
-
-# go through the patch and collect lines to fix
-while ( my $line = <STDIN> ) {
-    if ( $line =~ /^\+\+\+ (.*)/ ) {
-        fix_whitespace( $file, \%lines );
-        $file = $1;
-        %lines = ();
-        $line_no = 0;
-        $line_max = -1;
-    }
-    elsif ( $line =~ /^@@ -[0-9]+,[0-9]+ \+([0-9]+),([0-9]+) @@/ ) {
-        $line_no = $1;
-        $line_max = $line_no + $2;
-    }
-    elsif ( ( $line_no < $line_max ) && ( $line =~ /^[ +]/ ) ) {
-        if ( $line =~ /^\+.*[ \t]$/ ) {
-            $lines{$line_no} = 1;
-        }
-        ++$line_no;
-    }
-}
-fix_whitespace( $file, \%lines );
diff --git a/git-hooks/pre-commit b/git-hooks/pre-commit
index 6d3cf3a..5a9a4b4 100755
--- a/git-hooks/pre-commit
+++ b/git-hooks/pre-commit
@@ -1,102 +1,186 @@
-#!/bin/sh
-#
-# An example hook script to verify what is about to be committed.
+#!/usr/bin/perl -w
+
+# A hook script to verify what is about to be committed.
 # Called by "git commit" with no arguments.  The hook should
-# exit with non-zero status after issuing an appropriate message if
-# it wants to stop the commit.
-#
-# To enable this hook, rename this file to "pre-commit".
+# exit with non-zero status after issuing an appropriate message
+# if it wants to stop the commit.
+
+use strict;
+use File::Temp qw/ :mktemp  /;
+use File::Copy;
+
+$ENV{LC_ALL} = "C";
+
+# attempt to fix whitespace in one file
+# $1 - file to fix
+# $2 - list of lines containing whitespace errors
+sub fix_whitespace($$) {
+    my ( $file, $lines ) = @_;
+
+    # usually we have nothing to do ;-)
+    return if ( keys( %{$lines} ) == 0 ||
+                $file eq "" ||
+                !( $file =~ /\.(c|cpp|cxx|h|hrc|hxx|idl|inl|java|map|mk|MK|pl|pm|pmk|py|sdi|sh|src|tab)/ ) );
+
+    open( IN, "$file" ) || die "Cannot open $file for reading";
+    my ( $out, $tmpfile ) = mkstemp( "/tmp/whitespace-fixing-XXXXXX" );
+
+    my $line_no = 1;
+    while ( my $line = <IN> ) {
+        if ( $lines->{$line_no} && $line =~ /^(.*[^ \t])[ \t]+$/ ) {
+            print $out "$1\n";
+        }
+        elsif ( $lines->{$line_no} && $line =~ /^[ \t]+$/ ) {
+            print $out "\n";
+        }
+        else {
+            print $out $line;
+        }
+        ++$line_no;
+    }
+    close( $out );
+    close( IN );
+
+    move( $tmpfile, $file ) or die "Cannot move '$tmpfile' to '$file'";
+
+    system( "git add $file" );
+    print "Fixed whitespace in '$file'\n";
+}
+
+# go through the patch and collect lines to fix
+sub check_and_fix_whitespace($)
+{
+    my ( $head ) = @_;
+
+    my $file = "";
+    my %lines = ();
+    my $line_no = 0;
+    my $line_max = -1;
+
+    open( IN, "git diff-index -p --no-prefix --cached $head -- |" ) || die "Cannot get git diff-index";
+    while ( my $line = <IN> ) {
+        if ( $line =~ /^\+\+\+ (.*)/ ) {
+            fix_whitespace( $file, \%lines );
+            $file = $1;
+            %lines = ();
+            $line_no = 0;
+            $line_max = -1;
+        }
+        elsif ( $line =~ /^@@ -[0-9]+,[0-9]+ \+([0-9]+),([0-9]+) @@/ ) {
+            $line_no = $1;
+            $line_max = $line_no + $2;
+        }
+        elsif ( ( $line_no < $line_max ) && ( $line =~ /^[ +]/ ) ) {
+            if ( $line =~ /^\+.*[ \t]$/ ) {
+                $lines{$line_no} = 1;
+            }
+            ++$line_no;
+        }
+    }
+    fix_whitespace( $file, \%lines );
+    close( IN );
+}
 
-export LANG=POSIX
+# Do the work :-)
 
-if git rev-parse --verify HEAD >/dev/null 2>&1
-then
-    against=HEAD
-else
-    # Initial commit: diff against an empty tree object
-    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
-fi
+# Initial commit: diff against an empty tree object
+my $against="4b825dc642cb6eb9a060e54bf8d69288fbee4904";
+if ( system( "git rev-parse --verify HEAD >/dev/null 2>&1" ) == 0 ) {
+    $against="HEAD"
+}
 
 # If you want to allow non-ascii filenames set this variable to true.
-allownonascii=$(git config hooks.allownonascii)
+my $allownonascii=`git config hooks.allownonascii`;
 
 # Cross platform projects tend to avoid non-ascii filenames; prevent
 # them from being added to the repository. We exploit the fact that the
 # printable range starts at the space character and ends with tilde.
-if [ "$allownonascii" != "true" ] &&
+if ( $allownonascii ne "true" &&
     # Note that the use of brackets around a tr range is ok here, (it's
     # even required, for portability to Solaris 10's /usr/bin/tr), since
     # the square bracket bytes happen to fall in the designated range.
-    test "$(git diff --cached --name-only --diff-filter=A -z $against |
-      LC_ALL=C tr -d '[ -~]\0')"
-then
-    echo "Error: Attempt to add a non-ascii file name."
-    echo
-    echo "This can cause problems if you want to work"
-    echo "with people on other platforms."
-    echo
-    echo "To be portable it is advisable to rename the file ..."
-    echo
-    echo "If you know what you are doing you can disable this"
-    echo "check using:"
-    echo
-    echo "  git config hooks.allownonascii true"
-    echo
-    exit 1
-fi
+    `git diff --cached --name-only --diff-filter=A -z $against | \
+     LC_ALL=C tr -d '[ -~]\\0'` ne "" )
+{
+    print <<EOM;
+Error: Attempt to add a non-ascii file name."
+
+This can cause problems if you want to work"
+with people on other platforms."
+
+To be portable it is advisable to rename the file ..."
+
+If you know what you are doing you can disable this"
+check using:"
+
+  git config hooks.allownonascii true"
+
+EOM
+    exit( 1 );
+}
 
 # be strict about tabs - we don't want them at all, setup your editor
 # correctly ;-)
-CHECK_EXTENSIONS='\.\(c\|cpp\|cxx\|h\|hrc\|hxx\|idl\|inl\|java\|map\|mk\|MK\|pmk\|pl\|pm\|sdi\|sh\|src\|tab\|xcu\|xml\)$'
-ERRORS="$(git diff-index --cached --name-only HEAD | while read FILE ; do
-              if echo "$FILE" | grep -qs "$CHECK_EXTENSIONS" ; then
-                  if git diff-index -p --cached HEAD -- "$FILE" | grep -qs $'^+ *\t' ; then
-                      echo "$FILE"
-                  fi
-              fi
-          done)"
-if test -n "$ERRORS" ; then
-    echo "Error: Your change in the following files introduces tabs in indentation:"
-    echo
-    echo "$ERRORS"
-    echo
-    echo "Please setup your editor not to use tabs, fix the files, and try again."
-    echo "We have had enough trouble with tabs in the past :-("
-    echo
-    exit 1
-fi
+my $check_ext = '\.(c|cpp|cxx|h|hrc|hxx|idl|inl|java|map|mk|MK|pmk|pl|pm|sdi|sh|src|tab|xcu|xml)$';
+my $err_ext = "";
+
+open( FILES, "git diff-index --cached --name-only $against |" ) || die "Cannot run git diff-index.";
+while ( my $file = <FILES> ) {
+    chomp( $file );
+    open( F, "git diff-index -p --cached $against -- '$file' |" );
+    while ( my $line = <F> ) {
+        if ( $line =~ /^\+ *\t/ ) {
+            $err_ext .= "$file\n";
+            last;
+        }
+    }
+    close( F );
+}
+close( FILES );
+
+if ( $err_ext ne "" ) {
+    print <<EOM;
+Error: Your change in the following files introduces tabs in indentation:
+
+$err_ext
+Please setup your editor not to use tabs, fix the files, and try again.
+We have had enough trouble with tabs in the past :-(
+
+EOM
+    exit( 1 );
+}
 
 # check for old licenses
-CHECK_LICENSES='^+.*\(Sun Industry Standards Source License Version\|GNU Lesser General Public License Version 2.1\)'
-ERRORS="$(git diff-index --cached --name-only HEAD | while read FILE ; do
-              if git diff-index -p --cached HEAD -- "$FILE" | grep -qs "$CHECK_LICENSES" ; then
-                  echo "$FILE"
-              fi
-          done)"
-if test -n "$ERRORS" ; then
-    echo "Error: Your change in the following files introduces old licenses:"
-    echo
-    echo "$ERRORS"
-    echo
-    echo "Please check with the author(s) that they agree with upgrading the"
-    echo "license to LGPL3, and change the license accondingly."
-    echo
-    exit 1
-fi
+my $check_licenses='^+.*\(Sun Industry Standards Source License Version\|GNU Lesser General Public License Version 2.1\)';
+my $err_licenses=`git diff-index --cached --name-only $against | while read FILE ; do \
+                      if git diff-index -p --cached $against -- "\$FILE" | grep -qs "$check_licenses" ; then \
+                          echo "\$FILE" \
+                      fi \
+                  done`;
+chomp( $err_licenses );
+if ( $err_licenses ne "" && $err_licenses ne "git-hooks/pre-commit" ) {
+    print <<EOM;
+Error: Your change in the following files introduces old licenses:
+
+$err_licenses
+
+Please check with the author(s) that they agree with upgrading the
+license to LGPL3, and change the license accondingly.
+
+EOM
+    exit( 1 );
+}
 
 # fix whitespace in code
-git diff-index -p --no-prefix --cached $against -- | bin/fix-trailing-whitespace.pl |
-    while read F ; do
-        git add $F
-        echo "Fixed whitespace in '$F'."
-    done
+check_and_fix_whitespace( $against );
 
 # check the rest of the files
-FILTER_PATCHES=`git diff-index --check --cached $against -- | sed '/\.\(diff\|patch\):/,/.*/d'`
-if [ -n "$FILTER_PATCHES" ] ; then
-    echo "$FILTER_PATCHES"
-    exit 1
-fi
+my $filter_patches=`git diff-index --check --cached $against -- | sed '/\.\(diff\|patch\):/,/.*/d'`;
+chomp( $filter_patches );
+if ( $filter_patches ne "" ) {
+    print "WARNING:\n\n$filter_patches\n";
+}
 
-exit 0
+# all OK
+exit( 0 );
 # vi:set shiftwidth=4 expandtab:


More information about the Libreoffice-commits mailing list