3 # A hook script to verify what is about to be committed.
4 # Called by "git commit" with no arguments. The hook should
5 # exit with non-zero status after issuing an appropriate message
6 # if it wants to stop the commit.
9 use lib
"solenv/clang-format";
15 sub check_whitespaces
($)
18 my $src_limited = "c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|MK|pmk|pl|pm|sdi|sh|src|tab|ui|xcu|xml|xsl";
19 my $src_full = "c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|mk|MK|pmk|pl|pm|sdi|sh|src|tab|ui|xcu|xml|xsl";
23 my $reported_filename = "";
27 my ($why, $line, $file_filter) = @_;
28 if (!defined $file_filter || $filename =~ /\.($file_filter)$/)
33 print STDERR
"* You have some suspicious patch lines:\n";
37 if ($reported_filename ne $filename)
39 print STDERR
"* In $filename\n";
40 $reported_filename = $filename;
42 print STDERR
"* $why (line $lineno)\n";
43 print STDERR
"$filename:$lineno:$line\n";
46 open( FILES
, "git-diff-index -p -M --cached $h |" ) || die "Cannot run git diff-index.";
49 if (m
|^diff
--git a
/(.*) b/\
1$|)
54 if (/^@@ -\S+ \+(\d+)/)
70 bad_line
("trailing whitespace", $_ , $src_limited);
74 bad_line
("DOS lineends", $_ , $src_limited);
78 bad_line
("indent with Tab", $_, $src_limited);
82 bad_line
("unresolved merge conflict", $src_full);
86 bad_line
("temporary debug in commit", $_, $src_limited);
88 if (/<property name="use_markup">True<\/property
>/)
90 bad_line
("use font attributes instead of use-markup", $_, "ui");
92 if (/<property name="tooltip_markup"/ )
94 bad_line
("use tooltip_text instead of tooltip_markup", $_, "ui");
96 if ((/translatable="yes"/) and not(/context=/))
98 bad_line
("translatable .ui file line without context", $_, "ui");
100 if ((/<interface/) and not(/domain=/))
102 bad_line
(".ui file without translation domain", $_, "ui");
114 my $author = `git var GIT_AUTHOR_IDENT`;
116 if ($author =~ /^Your Name <you\@example.com>/)
118 print("ERROR: You have a suspicious author identity: '$author'\n");
125 if (! -e
"solenv/clang-format/ClangFormat.pm")
127 # Commit happens in a submodule.
132 ClangFormat
->import();
135 my $src = ClangFormat
::get_extension_regex
();
137 my $blacklist_names = ClangFormat
::get_blacklist
();
138 my $clang_format = ClangFormat
::find
();
140 # Get a list of non-deleted changed files.
141 open (FILES
, "git diff-index --cached --diff-filter=AM --name-only $h |") || die "Cannot run git diff.";
142 while (my $filename = <FILES
>)
145 if ($filename =~ /\.($src)$/ and !exists($blacklist_names->{$filename}))
147 if (!defined($clang_format))
149 my $version = ClangFormat
::get_wanted_version
();
150 my $opt_lo = ClangFormat
::get_own_directory
();
152 print("\nWARNING: Commit touches new (non-blacklisted) files, but no clang-format"
154 print(" found (via CLANG_FORMAT or PATH env vars, or in ${opt_lo}).\n\n");
156 my $platform = "linux64";
157 my $download = "wget";
160 $platform = "win.exe";
162 elsif ($^O
eq "darwin")
165 $download = "curl -O";
168 print("To get a suitable binary, please do:\n\n");
169 print("mkdir -p $opt_lo\n");
170 print("cd $opt_lo\n");
171 print("$download https://dev-www.libreoffice.org/bin/clang-format-$version-$platform\n");
172 print("cp clang-format-$version-$platform clang-format\n");
173 print("chmod +x clang-format\n\n");
175 print("(Or read solenv/clang-format/README on how to build it yourself.\n");
178 if (!ClangFormat
::check_style
($clang_format, $filename))
180 push @bad_names, $filename;
186 if (scalar @bad_names)
188 my $autostyle = `git config libreoffice.autostyle`;
190 if ($autostyle ne "true")
192 print("\nThe above differences were found between the code to commit \n");
193 print("and the clang-format rules. You can apply these changes with:\n");
194 print("\n$clang_format -i " . join(" ", @bad_names) . "\n\n");
195 print("Aborting commit. Apply changes and commit again or skip checking\n");
196 print("with --no-verify (not recommended).\n");
201 # 'git config libreoffice.autostyle true' was invoked to run
202 # clang-format automatically.
203 print("\nThe above differences were found between the code to commit \n");
204 print("and the clang-format rules. Fixing these now automatically.\n");
205 print("Running '$clang_format -i " . join(" ", @bad_names) . "' for you...\n");
206 system("$clang_format -i " . join(" ", @bad_names));
207 # TODO this stages all local modifications, staging originally
209 system("git add " . join(" ", @bad_names));
217 # Initial commit: diff against an empty tree object
218 my $against="4b825dc642cb6eb9a060e54bf8d69288fbee4904";
219 if ( system( "git rev-parse --verify HEAD >/dev/null 2>&1" ) == 0 )
224 # If you want to allow non-ascii filenames set this variable to true.
225 my $allownonascii=`git config hooks.allownonascii`;
227 # Cross platform projects tend to avoid non-ascii filenames; prevent
228 # them from being added to the repository. We exploit the fact that the
229 # printable range starts at the space character and ends with tilde.
230 if ( $allownonascii ne "true" &&
231 # Note that the use of brackets around a tr range is ok here, (it's
232 # even required, for portability to Solaris 10's /usr/bin/tr), since
233 # the square bracket bytes happen to fall in the designated range.
234 `git diff --cached --name-only --diff-filter=A -z $against | \
235 LC_ALL=C tr -d '[ -~]\\0'` ne "" )
238 Error: Attempt to add a non-ascii file name.
240 This can cause problems if you want to work
241 with people on other platforms.
243 To be portable it is advisable to rename the file ...
245 If you know what you are doing you can disable this
248 git config hooks.allownonascii true
255 open( FILES
, "git diff --cached --name-only --diff-filter=A -z $against |" ) || die "Cannot run git diff-index.";
258 if (/\.ui$/) # .ui files can get large
266 my $size = `git cat-file -s :$_`;
267 # For now let's say large is 500KB
269 if ($size > $limit * 1024)
271 print "Error: Attempt to add a large file: $_, pleasy try to fit into $limit KB.\n";
276 # fix whitespace in code
277 check_whitespaces
( $against);
280 check_style
($against);
282 # catch missing author info
287 # vi:set shiftwidth=4 expandtab: