Document git-var -l listing also configuration variables
[git/debian.git] / git-annotate.perl
blob9df72a1662c47790a7d97309e40dc1051e5f7fcc
1 #!/usr/bin/perl
2 # Copyright 2006, Ryan Anderson <ryan@michonline.com>
4 # GPL v2 (See COPYING)
6 # This file is licensed under the GPL v2, or a later version
7 # at the discretion of Linus Torvalds.
9 use warnings;
10 use strict;
11 use Getopt::Long;
12 use POSIX qw(strftime gmtime);
14 sub usage() {
15 print STDERR 'Usage: ${\basename $0} [-s] [-S revs-file] file [ revision ]
16 -l, --long
17 Show long rev (Defaults off)
18 -t, --time
19 Show raw timestamp (Defaults off)
20 -r, --rename
21 Follow renames (Defaults on).
22 -S, --rev-file revs-file
23 Use revs from revs-file instead of calling git-rev-list
24 -h, --help
25 This message.
28 exit(1);
31 our ($help, $longrev, $rename, $rawtime, $starting_rev, $rev_file) = (0, 0, 1);
33 my $rc = GetOptions( "long|l" => \$longrev,
34 "time|t" => \$rawtime,
35 "help|h" => \$help,
36 "rename|r" => \$rename,
37 "rev-file|S=s" => \$rev_file);
38 if (!$rc or $help) {
39 usage();
42 my $filename = shift @ARGV;
43 if (@ARGV) {
44 $starting_rev = shift @ARGV;
47 my @stack = (
49 'rev' => defined $starting_rev ? $starting_rev : "HEAD",
50 'filename' => $filename,
54 our @filelines = ();
56 if (defined $starting_rev) {
57 @filelines = git_cat_file($starting_rev, $filename);
58 } else {
59 open(F,"<",$filename)
60 or die "Failed to open filename: $!";
62 while(<F>) {
63 chomp;
64 push @filelines, $_;
66 close(F);
70 our %revs;
71 our @revqueue;
72 our $head;
74 my $revsprocessed = 0;
75 while (my $bound = pop @stack) {
76 my @revisions = git_rev_list($bound->{'rev'}, $bound->{'filename'});
77 foreach my $revinst (@revisions) {
78 my ($rev, @parents) = @$revinst;
79 $head ||= $rev;
81 if (!defined($rev)) {
82 $rev = "";
84 $revs{$rev}{'filename'} = $bound->{'filename'};
85 if (scalar @parents > 0) {
86 $revs{$rev}{'parents'} = \@parents;
87 next;
90 if (!$rename) {
91 next;
94 my $newbound = find_parent_renames($rev, $bound->{'filename'});
95 if ( exists $newbound->{'filename'} && $newbound->{'filename'} ne $bound->{'filename'}) {
96 push @stack, $newbound;
97 $revs{$rev}{'parents'} = [$newbound->{'rev'}];
101 push @revqueue, $head;
102 init_claim( defined $starting_rev ? $head : 'dirty');
103 unless (defined $starting_rev) {
104 my $diff = open_pipe("git","diff","-R", "HEAD", "--",$filename)
105 or die "Failed to call git diff to check for dirty state: $!";
107 _git_diff_parse($diff, $head, "dirty", (
108 'author' => gitvar_name("GIT_AUTHOR_IDENT"),
109 'author_date' => sprintf("%s +0000",time()),
112 close($diff);
114 handle_rev();
117 my $i = 0;
118 foreach my $l (@filelines) {
119 my ($output, $rev, $committer, $date);
120 if (ref $l eq 'ARRAY') {
121 ($output, $rev, $committer, $date) = @$l;
122 if (!$longrev && length($rev) > 8) {
123 $rev = substr($rev,0,8);
125 } else {
126 $output = $l;
127 ($rev, $committer, $date) = ('unknown', 'unknown', 'unknown');
130 printf("%s\t(%10s\t%10s\t%d)%s\n", $rev, $committer,
131 format_date($date), ++$i, $output);
134 sub init_claim {
135 my ($rev) = @_;
136 for (my $i = 0; $i < @filelines; $i++) {
137 $filelines[$i] = [ $filelines[$i], '', '', '', 1];
138 # line,
139 # rev,
140 # author,
141 # date,
142 # 1 <-- belongs to the original file.
144 $revs{$rev}{'lines'} = \@filelines;
148 sub handle_rev {
149 my $i = 0;
150 my %seen;
151 while (my $rev = shift @revqueue) {
152 next if $seen{$rev}++;
154 my %revinfo = git_commit_info($rev);
156 foreach my $p (@{$revs{$rev}{'parents'}}) {
158 git_diff_parse($p, $rev, %revinfo);
159 push @revqueue, $p;
163 if (scalar @{$revs{$rev}{parents}} == 0) {
164 # We must be at the initial rev here, so claim everything that is left.
165 for (my $i = 0; $i < @{$revs{$rev}{lines}}; $i++) {
166 if (ref ${$revs{$rev}{lines}}[$i] eq '' || ${$revs{$rev}{lines}}[$i][1] eq '') {
167 claim_line($i, $rev, $revs{$rev}{lines}, %revinfo);
175 sub git_rev_list {
176 my ($rev, $file) = @_;
178 my $revlist;
179 if ($rev_file) {
180 open($revlist, '<' . $rev_file)
181 or die "Failed to open $rev_file : $!";
182 } else {
183 $revlist = open_pipe("git-rev-list","--parents","--remove-empty",$rev,"--",$file)
184 or die "Failed to exec git-rev-list: $!";
187 my @revs;
188 while(my $line = <$revlist>) {
189 chomp $line;
190 my ($rev, @parents) = split /\s+/, $line;
191 push @revs, [ $rev, @parents ];
193 close($revlist);
195 printf("0 revs found for rev %s (%s)\n", $rev, $file) if (@revs == 0);
196 return @revs;
199 sub find_parent_renames {
200 my ($rev, $file) = @_;
202 my $patch = open_pipe("git-diff-tree", "-M50", "-r","--name-status", "-z","$rev")
203 or die "Failed to exec git-diff: $!";
205 local $/ = "\0";
206 my %bound;
207 my $junk = <$patch>;
208 while (my $change = <$patch>) {
209 chomp $change;
210 my $filename = <$patch>;
211 chomp $filename;
213 if ($change =~ m/^[AMD]$/ ) {
214 next;
215 } elsif ($change =~ m/^R/ ) {
216 my $oldfilename = $filename;
217 $filename = <$patch>;
218 chomp $filename;
219 if ( $file eq $filename ) {
220 my $parent = git_find_parent($rev, $oldfilename);
221 @bound{'rev','filename'} = ($parent, $oldfilename);
222 last;
226 close($patch);
228 return \%bound;
232 sub git_find_parent {
233 my ($rev, $filename) = @_;
235 my $revparent = open_pipe("git-rev-list","--remove-empty", "--parents","--max-count=1","$rev","--",$filename)
236 or die "Failed to open git-rev-list to find a single parent: $!";
238 my $parentline = <$revparent>;
239 chomp $parentline;
240 my ($revfound,$parent) = split m/\s+/, $parentline;
242 close($revparent);
244 return $parent;
248 # Get a diff between the current revision and a parent.
249 # Record the commit information that results.
250 sub git_diff_parse {
251 my ($parent, $rev, %revinfo) = @_;
253 my $diff = open_pipe("git-diff-tree","-M","-p",$rev,$parent,"--",
254 $revs{$rev}{'filename'}, $revs{$parent}{'filename'})
255 or die "Failed to call git-diff for annotation: $!";
257 _git_diff_parse($diff, $parent, $rev, %revinfo);
259 close($diff);
262 sub _git_diff_parse {
263 my ($diff, $parent, $rev, %revinfo) = @_;
265 my ($ri, $pi) = (0,0);
266 my $slines = $revs{$rev}{'lines'};
267 my @plines;
269 my $gotheader = 0;
270 my ($remstart);
271 my ($hunk_start, $hunk_index);
272 while(<$diff>) {
273 chomp;
274 if (m/^@@ -(\d+),(\d+) \+(\d+),(\d+)/) {
275 $remstart = $1;
276 # Adjust for 0-based arrays
277 $remstart--;
278 # Reinit hunk tracking.
279 $hunk_start = $remstart;
280 $hunk_index = 0;
281 $gotheader = 1;
283 for (my $i = $ri; $i < $remstart; $i++) {
284 $plines[$pi++] = $slines->[$i];
285 $ri++;
287 next;
288 } elsif (!$gotheader) {
289 next;
292 if (m/^\+(.*)$/) {
293 my $line = $1;
294 $plines[$pi++] = [ $line, '', '', '', 0 ];
295 next;
297 } elsif (m/^-(.*)$/) {
298 my $line = $1;
299 if (get_line($slines, $ri) eq $line) {
300 # Found a match, claim
301 claim_line($ri, $rev, $slines, %revinfo);
302 } else {
303 die sprintf("Sync error: %d/%d\n|%s\n|%s\n%s => %s\n",
304 $ri, $hunk_start + $hunk_index,
305 $line,
306 get_line($slines, $ri),
307 $rev, $parent);
309 $ri++;
311 } elsif (m/^\\/) {
313 # Skip \No newline at end of file.
314 # But this can be internationalized, so only look
315 # for an initial \
317 } else {
318 if (substr($_,1) ne get_line($slines,$ri) ) {
319 die sprintf("Line %d (%d) does not match:\n|%s\n|%s\n%s => %s\n",
320 $hunk_start + $hunk_index, $ri,
321 substr($_,1),
322 get_line($slines,$ri),
323 $rev, $parent);
325 $plines[$pi++] = $slines->[$ri++];
327 $hunk_index++;
329 for (my $i = $ri; $i < @{$slines} ; $i++) {
330 push @plines, $slines->[$ri++];
333 $revs{$parent}{lines} = \@plines;
334 return;
337 sub get_line {
338 my ($lines, $index) = @_;
340 return ref $lines->[$index] ne '' ? $lines->[$index][0] : $lines->[$index];
343 sub git_cat_file {
344 my ($rev, $filename) = @_;
345 return () unless defined $rev && defined $filename;
347 my $blob = git_ls_tree($rev, $filename);
348 die "Failed to find a blob for $filename in rev $rev\n" if !defined $blob;
350 my $catfile = open_pipe("git","cat-file", "blob", $blob)
351 or die "Failed to git-cat-file blob $blob (rev $rev, file $filename): " . $!;
353 my @lines;
354 while(<$catfile>) {
355 chomp;
356 push @lines, $_;
358 close($catfile);
360 return @lines;
363 sub git_ls_tree {
364 my ($rev, $filename) = @_;
366 my $lstree = open_pipe("git","ls-tree",$rev,$filename)
367 or die "Failed to call git ls-tree: $!";
369 my ($mode, $type, $blob, $tfilename);
370 while(<$lstree>) {
371 chomp;
372 ($mode, $type, $blob, $tfilename) = split(/\s+/, $_, 4);
373 last if ($tfilename eq $filename);
375 close($lstree);
377 return $blob if ($tfilename eq $filename);
378 die "git-ls-tree failed to find blob for $filename";
384 sub claim_line {
385 my ($floffset, $rev, $lines, %revinfo) = @_;
386 my $oline = get_line($lines, $floffset);
387 @{$lines->[$floffset]} = ( $oline, $rev,
388 $revinfo{'author'}, $revinfo{'author_date'} );
389 #printf("Claiming line %d with rev %s: '%s'\n",
390 # $floffset, $rev, $oline) if 1;
393 sub git_commit_info {
394 my ($rev) = @_;
395 my $commit = open_pipe("git-cat-file", "commit", $rev)
396 or die "Failed to call git-cat-file: $!";
398 my %info;
399 while(<$commit>) {
400 chomp;
401 last if (length $_ == 0);
403 if (m/^author (.*) <(.*)> (.*)$/) {
404 $info{'author'} = $1;
405 $info{'author_email'} = $2;
406 $info{'author_date'} = $3;
407 } elsif (m/^committer (.*) <(.*)> (.*)$/) {
408 $info{'committer'} = $1;
409 $info{'committer_email'} = $2;
410 $info{'committer_date'} = $3;
413 close($commit);
415 return %info;
418 sub format_date {
419 if ($rawtime) {
420 return $_[0];
422 my ($timestamp, $timezone) = split(' ', $_[0]);
423 my $minutes = abs($timezone);
424 $minutes = int($minutes / 100) * 60 + ($minutes % 100);
425 if ($timezone < 0) {
426 $minutes = -$minutes;
428 my $t = $timestamp + $minutes * 60;
429 return strftime("%Y-%m-%d %H:%M:%S " . $timezone, gmtime($t));
432 # Copied from git-send-email.perl - We need a Git.pm module..
433 sub gitvar {
434 my ($var) = @_;
435 my $fh;
436 my $pid = open($fh, '-|');
437 die "$!" unless defined $pid;
438 if (!$pid) {
439 exec('git-var', $var) or die "$!";
441 my ($val) = <$fh>;
442 close $fh or die "$!";
443 chomp($val);
444 return $val;
447 sub gitvar_name {
448 my ($name) = @_;
449 my $val = gitvar($name);
450 my @field = split(/\s+/, $val);
451 return join(' ', @field[0...(@field-4)]);
454 sub open_pipe {
455 if ($^O eq '##INSERT_ACTIVESTATE_STRING_HERE##') {
456 return open_pipe_activestate(@_);
457 } else {
458 return open_pipe_normal(@_);
462 sub open_pipe_activestate {
463 tie *fh, "Git::ActiveStatePipe", @_;
464 return *fh;
467 sub open_pipe_normal {
468 my (@execlist) = @_;
470 my $pid = open my $kid, "-|";
471 defined $pid or die "Cannot fork: $!";
473 unless ($pid) {
474 exec @execlist;
475 die "Cannot exec @execlist: $!";
478 return $kid;
481 package Git::ActiveStatePipe;
482 use strict;
484 sub TIEHANDLE {
485 my ($class, @params) = @_;
486 my $cmdline = join " ", @params;
487 my @data = qx{$cmdline};
488 bless { i => 0, data => \@data }, $class;
491 sub READLINE {
492 my $self = shift;
493 if ($self->{i} >= scalar @{$self->{data}}) {
494 return undef;
496 return $self->{'data'}->[ $self->{i}++ ];
499 sub CLOSE {
500 my $self = shift;
501 delete $self->{data};
502 delete $self->{i};
505 sub EOF {
506 my $self = shift;
507 return ($self->{i} >= scalar @{$self->{data}});