t/Makefile: check helper scripts for non-portable shell commands too
[git/git-svn.git] / git-add--interactive.perl
blob1fadd69f8809f91337a27b98f244a3cf7183b23f
1 #!/usr/bin/perl
3 use 5.008;
4 use strict;
5 use warnings;
6 use Git;
8 binmode(STDOUT, ":raw");
10 my $repo = Git->repository();
12 my $menu_use_color = $repo->get_colorbool('color.interactive');
13 my ($prompt_color, $header_color, $help_color) =
14 $menu_use_color ? (
15 $repo->get_color('color.interactive.prompt', 'bold blue'),
16 $repo->get_color('color.interactive.header', 'bold'),
17 $repo->get_color('color.interactive.help', 'red bold'),
18 ) : ();
19 my $error_color = ();
20 if ($menu_use_color) {
21 my $help_color_spec = ($repo->config('color.interactive.help') or
22 'red bold');
23 $error_color = $repo->get_color('color.interactive.error',
24 $help_color_spec);
27 my $diff_use_color = $repo->get_colorbool('color.diff');
28 my ($fraginfo_color) =
29 $diff_use_color ? (
30 $repo->get_color('color.diff.frag', 'cyan'),
31 ) : ();
32 my ($diff_plain_color) =
33 $diff_use_color ? (
34 $repo->get_color('color.diff.plain', ''),
35 ) : ();
36 my ($diff_old_color) =
37 $diff_use_color ? (
38 $repo->get_color('color.diff.old', 'red'),
39 ) : ();
40 my ($diff_new_color) =
41 $diff_use_color ? (
42 $repo->get_color('color.diff.new', 'green'),
43 ) : ();
45 my $normal_color = $repo->get_color("", "reset");
47 my $diff_algorithm = $repo->config('diff.algorithm');
49 my $use_readkey = 0;
50 my $use_termcap = 0;
51 my %term_escapes;
53 sub ReadMode;
54 sub ReadKey;
55 if ($repo->config_bool("interactive.singlekey")) {
56 eval {
57 require Term::ReadKey;
58 Term::ReadKey->import;
59 $use_readkey = 1;
61 if (!$use_readkey) {
62 print STDERR "missing Term::ReadKey, disabling interactive.singlekey\n";
64 eval {
65 require Term::Cap;
66 my $termcap = Term::Cap->Tgetent;
67 foreach (values %$termcap) {
68 $term_escapes{$_} = 1 if /^\e/;
70 $use_termcap = 1;
74 sub colored {
75 my $color = shift;
76 my $string = join("", @_);
78 if (defined $color) {
79 # Put a color code at the beginning of each line, a reset at the end
80 # color after newlines that are not at the end of the string
81 $string =~ s/(\n+)(.)/$1$color$2/g;
82 # reset before newlines
83 $string =~ s/(\n+)/$normal_color$1/g;
84 # codes at beginning and end (if necessary):
85 $string =~ s/^/$color/;
86 $string =~ s/$/$normal_color/ unless $string =~ /\n$/;
88 return $string;
91 # command line options
92 my $patch_mode;
93 my $patch_mode_revision;
95 sub apply_patch;
96 sub apply_patch_for_checkout_commit;
97 sub apply_patch_for_stash;
99 my %patch_modes = (
100 'stage' => {
101 DIFF => 'diff-files -p',
102 APPLY => sub { apply_patch 'apply --cached', @_; },
103 APPLY_CHECK => 'apply --cached',
104 VERB => 'Stage',
105 TARGET => '',
106 PARTICIPLE => 'staging',
107 FILTER => 'file-only',
108 IS_REVERSE => 0,
110 'stash' => {
111 DIFF => 'diff-index -p HEAD',
112 APPLY => sub { apply_patch 'apply --cached', @_; },
113 APPLY_CHECK => 'apply --cached',
114 VERB => 'Stash',
115 TARGET => '',
116 PARTICIPLE => 'stashing',
117 FILTER => undef,
118 IS_REVERSE => 0,
120 'reset_head' => {
121 DIFF => 'diff-index -p --cached',
122 APPLY => sub { apply_patch 'apply -R --cached', @_; },
123 APPLY_CHECK => 'apply -R --cached',
124 VERB => 'Unstage',
125 TARGET => '',
126 PARTICIPLE => 'unstaging',
127 FILTER => 'index-only',
128 IS_REVERSE => 1,
130 'reset_nothead' => {
131 DIFF => 'diff-index -R -p --cached',
132 APPLY => sub { apply_patch 'apply --cached', @_; },
133 APPLY_CHECK => 'apply --cached',
134 VERB => 'Apply',
135 TARGET => ' to index',
136 PARTICIPLE => 'applying',
137 FILTER => 'index-only',
138 IS_REVERSE => 0,
140 'checkout_index' => {
141 DIFF => 'diff-files -p',
142 APPLY => sub { apply_patch 'apply -R', @_; },
143 APPLY_CHECK => 'apply -R',
144 VERB => 'Discard',
145 TARGET => ' from worktree',
146 PARTICIPLE => 'discarding',
147 FILTER => 'file-only',
148 IS_REVERSE => 1,
150 'checkout_head' => {
151 DIFF => 'diff-index -p',
152 APPLY => sub { apply_patch_for_checkout_commit '-R', @_ },
153 APPLY_CHECK => 'apply -R',
154 VERB => 'Discard',
155 TARGET => ' from index and worktree',
156 PARTICIPLE => 'discarding',
157 FILTER => undef,
158 IS_REVERSE => 1,
160 'checkout_nothead' => {
161 DIFF => 'diff-index -R -p',
162 APPLY => sub { apply_patch_for_checkout_commit '', @_ },
163 APPLY_CHECK => 'apply',
164 VERB => 'Apply',
165 TARGET => ' to index and worktree',
166 PARTICIPLE => 'applying',
167 FILTER => undef,
168 IS_REVERSE => 0,
172 my %patch_mode_flavour = %{$patch_modes{stage}};
174 sub run_cmd_pipe {
175 if ($^O eq 'MSWin32') {
176 my @invalid = grep {m/[":*]/} @_;
177 die "$^O does not support: @invalid\n" if @invalid;
178 my @args = map { m/ /o ? "\"$_\"": $_ } @_;
179 return qx{@args};
180 } else {
181 my $fh = undef;
182 open($fh, '-|', @_) or die;
183 return <$fh>;
187 my ($GIT_DIR) = run_cmd_pipe(qw(git rev-parse --git-dir));
189 if (!defined $GIT_DIR) {
190 exit(1); # rev-parse would have already said "not a git repo"
192 chomp($GIT_DIR);
194 my %cquote_map = (
195 "b" => chr(8),
196 "t" => chr(9),
197 "n" => chr(10),
198 "v" => chr(11),
199 "f" => chr(12),
200 "r" => chr(13),
201 "\\" => "\\",
202 "\042" => "\042",
205 sub unquote_path {
206 local ($_) = @_;
207 my ($retval, $remainder);
208 if (!/^\042(.*)\042$/) {
209 return $_;
211 ($_, $retval) = ($1, "");
212 while (/^([^\\]*)\\(.*)$/) {
213 $remainder = $2;
214 $retval .= $1;
215 for ($remainder) {
216 if (/^([0-3][0-7][0-7])(.*)$/) {
217 $retval .= chr(oct($1));
218 $_ = $2;
219 last;
221 if (/^([\\\042btnvfr])(.*)$/) {
222 $retval .= $cquote_map{$1};
223 $_ = $2;
224 last;
226 # This is malformed -- just return it as-is for now.
227 return $_[0];
229 $_ = $remainder;
231 $retval .= $_;
232 return $retval;
235 sub refresh {
236 my $fh;
237 open $fh, 'git update-index --refresh |'
238 or die;
239 while (<$fh>) {
240 ;# ignore 'needs update'
242 close $fh;
245 sub list_untracked {
246 map {
247 chomp $_;
248 unquote_path($_);
250 run_cmd_pipe(qw(git ls-files --others --exclude-standard --), @ARGV);
253 my $status_fmt = '%12s %12s %s';
254 my $status_head = sprintf($status_fmt, 'staged', 'unstaged', 'path');
257 my $initial;
258 sub is_initial_commit {
259 $initial = system('git rev-parse HEAD -- >/dev/null 2>&1') != 0
260 unless defined $initial;
261 return $initial;
265 sub get_empty_tree {
266 return '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
269 sub get_diff_reference {
270 my $ref = shift;
271 if (defined $ref and $ref ne 'HEAD') {
272 return $ref;
273 } elsif (is_initial_commit()) {
274 return get_empty_tree();
275 } else {
276 return 'HEAD';
280 # Returns list of hashes, contents of each of which are:
281 # VALUE: pathname
282 # BINARY: is a binary path
283 # INDEX: is index different from HEAD?
284 # FILE: is file different from index?
285 # INDEX_ADDDEL: is it add/delete between HEAD and index?
286 # FILE_ADDDEL: is it add/delete between index and file?
287 # UNMERGED: is the path unmerged
289 sub list_modified {
290 my ($only) = @_;
291 my (%data, @return);
292 my ($add, $del, $adddel, $file);
293 my @tracked = ();
295 if (@ARGV) {
296 @tracked = map {
297 chomp $_;
298 unquote_path($_);
299 } run_cmd_pipe(qw(git ls-files --), @ARGV);
300 return if (!@tracked);
303 my $reference = get_diff_reference($patch_mode_revision);
304 for (run_cmd_pipe(qw(git diff-index --cached
305 --numstat --summary), $reference,
306 '--', @tracked)) {
307 if (($add, $del, $file) =
308 /^([-\d]+) ([-\d]+) (.*)/) {
309 my ($change, $bin);
310 $file = unquote_path($file);
311 if ($add eq '-' && $del eq '-') {
312 $change = 'binary';
313 $bin = 1;
315 else {
316 $change = "+$add/-$del";
318 $data{$file} = {
319 INDEX => $change,
320 BINARY => $bin,
321 FILE => 'nothing',
324 elsif (($adddel, $file) =
325 /^ (create|delete) mode [0-7]+ (.*)$/) {
326 $file = unquote_path($file);
327 $data{$file}{INDEX_ADDDEL} = $adddel;
331 for (run_cmd_pipe(qw(git diff-files --numstat --summary --raw --), @tracked)) {
332 if (($add, $del, $file) =
333 /^([-\d]+) ([-\d]+) (.*)/) {
334 $file = unquote_path($file);
335 my ($change, $bin);
336 if ($add eq '-' && $del eq '-') {
337 $change = 'binary';
338 $bin = 1;
340 else {
341 $change = "+$add/-$del";
343 $data{$file}{FILE} = $change;
344 if ($bin) {
345 $data{$file}{BINARY} = 1;
348 elsif (($adddel, $file) =
349 /^ (create|delete) mode [0-7]+ (.*)$/) {
350 $file = unquote_path($file);
351 $data{$file}{FILE_ADDDEL} = $adddel;
353 elsif (/^:[0-7]+ [0-7]+ [0-9a-f]+ [0-9a-f]+ (.) (.*)$/) {
354 $file = unquote_path($2);
355 if (!exists $data{$file}) {
356 $data{$file} = +{
357 INDEX => 'unchanged',
358 BINARY => 0,
361 if ($1 eq 'U') {
362 $data{$file}{UNMERGED} = 1;
367 for (sort keys %data) {
368 my $it = $data{$_};
370 if ($only) {
371 if ($only eq 'index-only') {
372 next if ($it->{INDEX} eq 'unchanged');
374 if ($only eq 'file-only') {
375 next if ($it->{FILE} eq 'nothing');
378 push @return, +{
379 VALUE => $_,
380 %$it,
383 return @return;
386 sub find_unique {
387 my ($string, @stuff) = @_;
388 my $found = undef;
389 for (my $i = 0; $i < @stuff; $i++) {
390 my $it = $stuff[$i];
391 my $hit = undef;
392 if (ref $it) {
393 if ((ref $it) eq 'ARRAY') {
394 $it = $it->[0];
396 else {
397 $it = $it->{VALUE};
400 eval {
401 if ($it =~ /^$string/) {
402 $hit = 1;
405 if (defined $hit && defined $found) {
406 return undef;
408 if ($hit) {
409 $found = $i + 1;
412 return $found;
415 # inserts string into trie and updates count for each character
416 sub update_trie {
417 my ($trie, $string) = @_;
418 foreach (split //, $string) {
419 $trie = $trie->{$_} ||= {COUNT => 0};
420 $trie->{COUNT}++;
424 # returns an array of tuples (prefix, remainder)
425 sub find_unique_prefixes {
426 my @stuff = @_;
427 my @return = ();
429 # any single prefix exceeding the soft limit is omitted
430 # if any prefix exceeds the hard limit all are omitted
431 # 0 indicates no limit
432 my $soft_limit = 0;
433 my $hard_limit = 3;
435 # build a trie modelling all possible options
436 my %trie;
437 foreach my $print (@stuff) {
438 if ((ref $print) eq 'ARRAY') {
439 $print = $print->[0];
441 elsif ((ref $print) eq 'HASH') {
442 $print = $print->{VALUE};
444 update_trie(\%trie, $print);
445 push @return, $print;
448 # use the trie to find the unique prefixes
449 for (my $i = 0; $i < @return; $i++) {
450 my $ret = $return[$i];
451 my @letters = split //, $ret;
452 my %search = %trie;
453 my ($prefix, $remainder);
454 my $j;
455 for ($j = 0; $j < @letters; $j++) {
456 my $letter = $letters[$j];
457 if ($search{$letter}{COUNT} == 1) {
458 $prefix = substr $ret, 0, $j + 1;
459 $remainder = substr $ret, $j + 1;
460 last;
462 else {
463 my $prefix = substr $ret, 0, $j;
464 return ()
465 if ($hard_limit && $j + 1 > $hard_limit);
467 %search = %{$search{$letter}};
469 if (ord($letters[0]) > 127 ||
470 ($soft_limit && $j + 1 > $soft_limit)) {
471 $prefix = undef;
472 $remainder = $ret;
474 $return[$i] = [$prefix, $remainder];
476 return @return;
479 # filters out prefixes which have special meaning to list_and_choose()
480 sub is_valid_prefix {
481 my $prefix = shift;
482 return (defined $prefix) &&
483 !($prefix =~ /[\s,]/) && # separators
484 !($prefix =~ /^-/) && # deselection
485 !($prefix =~ /^\d+/) && # selection
486 ($prefix ne '*') && # "all" wildcard
487 ($prefix ne '?'); # prompt help
490 # given a prefix/remainder tuple return a string with the prefix highlighted
491 # for now use square brackets; later might use ANSI colors (underline, bold)
492 sub highlight_prefix {
493 my $prefix = shift;
494 my $remainder = shift;
496 if (!defined $prefix) {
497 return $remainder;
500 if (!is_valid_prefix($prefix)) {
501 return "$prefix$remainder";
504 if (!$menu_use_color) {
505 return "[$prefix]$remainder";
508 return "$prompt_color$prefix$normal_color$remainder";
511 sub error_msg {
512 print STDERR colored $error_color, @_;
515 sub list_and_choose {
516 my ($opts, @stuff) = @_;
517 my (@chosen, @return);
518 my $i;
519 my @prefixes = find_unique_prefixes(@stuff) unless $opts->{LIST_ONLY};
521 TOPLOOP:
522 while (1) {
523 my $last_lf = 0;
525 if ($opts->{HEADER}) {
526 if (!$opts->{LIST_FLAT}) {
527 print " ";
529 print colored $header_color, "$opts->{HEADER}\n";
531 for ($i = 0; $i < @stuff; $i++) {
532 my $chosen = $chosen[$i] ? '*' : ' ';
533 my $print = $stuff[$i];
534 my $ref = ref $print;
535 my $highlighted = highlight_prefix(@{$prefixes[$i]})
536 if @prefixes;
537 if ($ref eq 'ARRAY') {
538 $print = $highlighted || $print->[0];
540 elsif ($ref eq 'HASH') {
541 my $value = $highlighted || $print->{VALUE};
542 $print = sprintf($status_fmt,
543 $print->{INDEX},
544 $print->{FILE},
545 $value);
547 else {
548 $print = $highlighted || $print;
550 printf("%s%2d: %s", $chosen, $i+1, $print);
551 if (($opts->{LIST_FLAT}) &&
552 (($i + 1) % ($opts->{LIST_FLAT}))) {
553 print "\t";
554 $last_lf = 0;
556 else {
557 print "\n";
558 $last_lf = 1;
561 if (!$last_lf) {
562 print "\n";
565 return if ($opts->{LIST_ONLY});
567 print colored $prompt_color, $opts->{PROMPT};
568 if ($opts->{SINGLETON}) {
569 print "> ";
571 else {
572 print ">> ";
574 my $line = <STDIN>;
575 if (!$line) {
576 print "\n";
577 $opts->{ON_EOF}->() if $opts->{ON_EOF};
578 last;
580 chomp $line;
581 last if $line eq '';
582 if ($line eq '?') {
583 $opts->{SINGLETON} ?
584 singleton_prompt_help_cmd() :
585 prompt_help_cmd();
586 next TOPLOOP;
588 for my $choice (split(/[\s,]+/, $line)) {
589 my $choose = 1;
590 my ($bottom, $top);
592 # Input that begins with '-'; unchoose
593 if ($choice =~ s/^-//) {
594 $choose = 0;
596 # A range can be specified like 5-7 or 5-.
597 if ($choice =~ /^(\d+)-(\d*)$/) {
598 ($bottom, $top) = ($1, length($2) ? $2 : 1 + @stuff);
600 elsif ($choice =~ /^\d+$/) {
601 $bottom = $top = $choice;
603 elsif ($choice eq '*') {
604 $bottom = 1;
605 $top = 1 + @stuff;
607 else {
608 $bottom = $top = find_unique($choice, @stuff);
609 if (!defined $bottom) {
610 error_msg "Huh ($choice)?\n";
611 next TOPLOOP;
614 if ($opts->{SINGLETON} && $bottom != $top) {
615 error_msg "Huh ($choice)?\n";
616 next TOPLOOP;
618 for ($i = $bottom-1; $i <= $top-1; $i++) {
619 next if (@stuff <= $i || $i < 0);
620 $chosen[$i] = $choose;
623 last if ($opts->{IMMEDIATE} || $line eq '*');
625 for ($i = 0; $i < @stuff; $i++) {
626 if ($chosen[$i]) {
627 push @return, $stuff[$i];
630 return @return;
633 sub singleton_prompt_help_cmd {
634 print colored $help_color, <<\EOF ;
635 Prompt help:
636 1 - select a numbered item
637 foo - select item based on unique prefix
638 - (empty) select nothing
642 sub prompt_help_cmd {
643 print colored $help_color, <<\EOF ;
644 Prompt help:
645 1 - select a single item
646 3-5 - select a range of items
647 2-3,6-9 - select multiple ranges
648 foo - select item based on unique prefix
649 -... - unselect specified items
650 * - choose all items
651 - (empty) finish selecting
655 sub status_cmd {
656 list_and_choose({ LIST_ONLY => 1, HEADER => $status_head },
657 list_modified());
658 print "\n";
661 sub say_n_paths {
662 my $did = shift @_;
663 my $cnt = scalar @_;
664 print "$did ";
665 if (1 < $cnt) {
666 print "$cnt paths\n";
668 else {
669 print "one path\n";
673 sub update_cmd {
674 my @mods = list_modified('file-only');
675 return if (!@mods);
677 my @update = list_and_choose({ PROMPT => 'Update',
678 HEADER => $status_head, },
679 @mods);
680 if (@update) {
681 system(qw(git update-index --add --remove --),
682 map { $_->{VALUE} } @update);
683 say_n_paths('updated', @update);
685 print "\n";
688 sub revert_cmd {
689 my @update = list_and_choose({ PROMPT => 'Revert',
690 HEADER => $status_head, },
691 list_modified());
692 if (@update) {
693 if (is_initial_commit()) {
694 system(qw(git rm --cached),
695 map { $_->{VALUE} } @update);
697 else {
698 my @lines = run_cmd_pipe(qw(git ls-tree HEAD --),
699 map { $_->{VALUE} } @update);
700 my $fh;
701 open $fh, '| git update-index --index-info'
702 or die;
703 for (@lines) {
704 print $fh $_;
706 close($fh);
707 for (@update) {
708 if ($_->{INDEX_ADDDEL} &&
709 $_->{INDEX_ADDDEL} eq 'create') {
710 system(qw(git update-index --force-remove --),
711 $_->{VALUE});
712 print "note: $_->{VALUE} is untracked now.\n";
716 refresh();
717 say_n_paths('reverted', @update);
719 print "\n";
722 sub add_untracked_cmd {
723 my @add = list_and_choose({ PROMPT => 'Add untracked' },
724 list_untracked());
725 if (@add) {
726 system(qw(git update-index --add --), @add);
727 say_n_paths('added', @add);
729 print "\n";
732 sub run_git_apply {
733 my $cmd = shift;
734 my $fh;
735 open $fh, '| git ' . $cmd . " --recount --allow-overlap";
736 print $fh @_;
737 return close $fh;
740 sub parse_diff {
741 my ($path) = @_;
742 my @diff_cmd = split(" ", $patch_mode_flavour{DIFF});
743 if (defined $diff_algorithm) {
744 splice @diff_cmd, 1, 0, "--diff-algorithm=${diff_algorithm}";
746 if (defined $patch_mode_revision) {
747 push @diff_cmd, get_diff_reference($patch_mode_revision);
749 my @diff = run_cmd_pipe("git", @diff_cmd, "--", $path);
750 my @colored = ();
751 if ($diff_use_color) {
752 @colored = run_cmd_pipe("git", @diff_cmd, qw(--color --), $path);
754 my (@hunk) = { TEXT => [], DISPLAY => [], TYPE => 'header' };
756 for (my $i = 0; $i < @diff; $i++) {
757 if ($diff[$i] =~ /^@@ /) {
758 push @hunk, { TEXT => [], DISPLAY => [],
759 TYPE => 'hunk' };
761 push @{$hunk[-1]{TEXT}}, $diff[$i];
762 push @{$hunk[-1]{DISPLAY}},
763 ($diff_use_color ? $colored[$i] : $diff[$i]);
765 return @hunk;
768 sub parse_diff_header {
769 my $src = shift;
771 my $head = { TEXT => [], DISPLAY => [], TYPE => 'header' };
772 my $mode = { TEXT => [], DISPLAY => [], TYPE => 'mode' };
773 my $deletion = { TEXT => [], DISPLAY => [], TYPE => 'deletion' };
775 for (my $i = 0; $i < @{$src->{TEXT}}; $i++) {
776 my $dest =
777 $src->{TEXT}->[$i] =~ /^(old|new) mode (\d+)$/ ? $mode :
778 $src->{TEXT}->[$i] =~ /^deleted file/ ? $deletion :
779 $head;
780 push @{$dest->{TEXT}}, $src->{TEXT}->[$i];
781 push @{$dest->{DISPLAY}}, $src->{DISPLAY}->[$i];
783 return ($head, $mode, $deletion);
786 sub hunk_splittable {
787 my ($text) = @_;
789 my @s = split_hunk($text);
790 return (1 < @s);
793 sub parse_hunk_header {
794 my ($line) = @_;
795 my ($o_ofs, $o_cnt, $n_ofs, $n_cnt) =
796 $line =~ /^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@/;
797 $o_cnt = 1 unless defined $o_cnt;
798 $n_cnt = 1 unless defined $n_cnt;
799 return ($o_ofs, $o_cnt, $n_ofs, $n_cnt);
802 sub split_hunk {
803 my ($text, $display) = @_;
804 my @split = ();
805 if (!defined $display) {
806 $display = $text;
808 # If there are context lines in the middle of a hunk,
809 # it can be split, but we would need to take care of
810 # overlaps later.
812 my ($o_ofs, undef, $n_ofs) = parse_hunk_header($text->[0]);
813 my $hunk_start = 1;
815 OUTER:
816 while (1) {
817 my $next_hunk_start = undef;
818 my $i = $hunk_start - 1;
819 my $this = +{
820 TEXT => [],
821 DISPLAY => [],
822 TYPE => 'hunk',
823 OLD => $o_ofs,
824 NEW => $n_ofs,
825 OCNT => 0,
826 NCNT => 0,
827 ADDDEL => 0,
828 POSTCTX => 0,
829 USE => undef,
832 while (++$i < @$text) {
833 my $line = $text->[$i];
834 my $display = $display->[$i];
835 if ($line =~ /^ /) {
836 if ($this->{ADDDEL} &&
837 !defined $next_hunk_start) {
838 # We have seen leading context and
839 # adds/dels and then here is another
840 # context, which is trailing for this
841 # split hunk and leading for the next
842 # one.
843 $next_hunk_start = $i;
845 push @{$this->{TEXT}}, $line;
846 push @{$this->{DISPLAY}}, $display;
847 $this->{OCNT}++;
848 $this->{NCNT}++;
849 if (defined $next_hunk_start) {
850 $this->{POSTCTX}++;
852 next;
855 # add/del
856 if (defined $next_hunk_start) {
857 # We are done with the current hunk and
858 # this is the first real change for the
859 # next split one.
860 $hunk_start = $next_hunk_start;
861 $o_ofs = $this->{OLD} + $this->{OCNT};
862 $n_ofs = $this->{NEW} + $this->{NCNT};
863 $o_ofs -= $this->{POSTCTX};
864 $n_ofs -= $this->{POSTCTX};
865 push @split, $this;
866 redo OUTER;
868 push @{$this->{TEXT}}, $line;
869 push @{$this->{DISPLAY}}, $display;
870 $this->{ADDDEL}++;
871 if ($line =~ /^-/) {
872 $this->{OCNT}++;
874 else {
875 $this->{NCNT}++;
879 push @split, $this;
880 last;
883 for my $hunk (@split) {
884 $o_ofs = $hunk->{OLD};
885 $n_ofs = $hunk->{NEW};
886 my $o_cnt = $hunk->{OCNT};
887 my $n_cnt = $hunk->{NCNT};
889 my $head = ("@@ -$o_ofs" .
890 (($o_cnt != 1) ? ",$o_cnt" : '') .
891 " +$n_ofs" .
892 (($n_cnt != 1) ? ",$n_cnt" : '') .
893 " @@\n");
894 my $display_head = $head;
895 unshift @{$hunk->{TEXT}}, $head;
896 if ($diff_use_color) {
897 $display_head = colored($fraginfo_color, $head);
899 unshift @{$hunk->{DISPLAY}}, $display_head;
901 return @split;
904 sub find_last_o_ctx {
905 my ($it) = @_;
906 my $text = $it->{TEXT};
907 my ($o_ofs, $o_cnt) = parse_hunk_header($text->[0]);
908 my $i = @{$text};
909 my $last_o_ctx = $o_ofs + $o_cnt;
910 while (0 < --$i) {
911 my $line = $text->[$i];
912 if ($line =~ /^ /) {
913 $last_o_ctx--;
914 next;
916 last;
918 return $last_o_ctx;
921 sub merge_hunk {
922 my ($prev, $this) = @_;
923 my ($o0_ofs, $o0_cnt, $n0_ofs, $n0_cnt) =
924 parse_hunk_header($prev->{TEXT}[0]);
925 my ($o1_ofs, $o1_cnt, $n1_ofs, $n1_cnt) =
926 parse_hunk_header($this->{TEXT}[0]);
928 my (@line, $i, $ofs, $o_cnt, $n_cnt);
929 $ofs = $o0_ofs;
930 $o_cnt = $n_cnt = 0;
931 for ($i = 1; $i < @{$prev->{TEXT}}; $i++) {
932 my $line = $prev->{TEXT}[$i];
933 if ($line =~ /^\+/) {
934 $n_cnt++;
935 push @line, $line;
936 next;
939 last if ($o1_ofs <= $ofs);
941 $o_cnt++;
942 $ofs++;
943 if ($line =~ /^ /) {
944 $n_cnt++;
946 push @line, $line;
949 for ($i = 1; $i < @{$this->{TEXT}}; $i++) {
950 my $line = $this->{TEXT}[$i];
951 if ($line =~ /^\+/) {
952 $n_cnt++;
953 push @line, $line;
954 next;
956 $ofs++;
957 $o_cnt++;
958 if ($line =~ /^ /) {
959 $n_cnt++;
961 push @line, $line;
963 my $head = ("@@ -$o0_ofs" .
964 (($o_cnt != 1) ? ",$o_cnt" : '') .
965 " +$n0_ofs" .
966 (($n_cnt != 1) ? ",$n_cnt" : '') .
967 " @@\n");
968 @{$prev->{TEXT}} = ($head, @line);
971 sub coalesce_overlapping_hunks {
972 my (@in) = @_;
973 my @out = ();
975 my ($last_o_ctx, $last_was_dirty);
977 for (grep { $_->{USE} } @in) {
978 if ($_->{TYPE} ne 'hunk') {
979 push @out, $_;
980 next;
982 my $text = $_->{TEXT};
983 my ($o_ofs) = parse_hunk_header($text->[0]);
984 if (defined $last_o_ctx &&
985 $o_ofs <= $last_o_ctx &&
986 !$_->{DIRTY} &&
987 !$last_was_dirty) {
988 merge_hunk($out[-1], $_);
990 else {
991 push @out, $_;
993 $last_o_ctx = find_last_o_ctx($out[-1]);
994 $last_was_dirty = $_->{DIRTY};
996 return @out;
999 sub reassemble_patch {
1000 my $head = shift;
1001 my @patch;
1003 # Include everything in the header except the beginning of the diff.
1004 push @patch, (grep { !/^[-+]{3}/ } @$head);
1006 # Then include any headers from the hunk lines, which must
1007 # come before any actual hunk.
1008 while (@_ && $_[0] !~ /^@/) {
1009 push @patch, shift;
1012 # Then begin the diff.
1013 push @patch, grep { /^[-+]{3}/ } @$head;
1015 # And then the actual hunks.
1016 push @patch, @_;
1018 return @patch;
1021 sub color_diff {
1022 return map {
1023 colored((/^@/ ? $fraginfo_color :
1024 /^\+/ ? $diff_new_color :
1025 /^-/ ? $diff_old_color :
1026 $diff_plain_color),
1027 $_);
1028 } @_;
1031 sub edit_hunk_manually {
1032 my ($oldtext) = @_;
1034 my $hunkfile = $repo->repo_path . "/addp-hunk-edit.diff";
1035 my $fh;
1036 open $fh, '>', $hunkfile
1037 or die "failed to open hunk edit file for writing: " . $!;
1038 print $fh "# Manual hunk edit mode -- see bottom for a quick guide\n";
1039 print $fh @$oldtext;
1040 my $participle = $patch_mode_flavour{PARTICIPLE};
1041 my $is_reverse = $patch_mode_flavour{IS_REVERSE};
1042 my ($remove_plus, $remove_minus) = $is_reverse ? ('-', '+') : ('+', '-');
1043 print $fh <<EOF;
1044 # ---
1045 # To remove '$remove_minus' lines, make them ' ' lines (context).
1046 # To remove '$remove_plus' lines, delete them.
1047 # Lines starting with # will be removed.
1049 # If the patch applies cleanly, the edited hunk will immediately be
1050 # marked for $participle. If it does not apply cleanly, you will be given
1051 # an opportunity to edit again. If all lines of the hunk are removed,
1052 # then the edit is aborted and the hunk is left unchanged.
1054 close $fh;
1056 chomp(my $editor = run_cmd_pipe(qw(git var GIT_EDITOR)));
1057 system('sh', '-c', $editor.' "$@"', $editor, $hunkfile);
1059 if ($? != 0) {
1060 return undef;
1063 open $fh, '<', $hunkfile
1064 or die "failed to open hunk edit file for reading: " . $!;
1065 my @newtext = grep { !/^#/ } <$fh>;
1066 close $fh;
1067 unlink $hunkfile;
1069 # Abort if nothing remains
1070 if (!grep { /\S/ } @newtext) {
1071 return undef;
1074 # Reinsert the first hunk header if the user accidentally deleted it
1075 if ($newtext[0] !~ /^@/) {
1076 unshift @newtext, $oldtext->[0];
1078 return \@newtext;
1081 sub diff_applies {
1082 return run_git_apply($patch_mode_flavour{APPLY_CHECK} . ' --check',
1083 map { @{$_->{TEXT}} } @_);
1086 sub _restore_terminal_and_die {
1087 ReadMode 'restore';
1088 print "\n";
1089 exit 1;
1092 sub prompt_single_character {
1093 if ($use_readkey) {
1094 local $SIG{TERM} = \&_restore_terminal_and_die;
1095 local $SIG{INT} = \&_restore_terminal_and_die;
1096 ReadMode 'cbreak';
1097 my $key = ReadKey 0;
1098 ReadMode 'restore';
1099 if ($use_termcap and $key eq "\e") {
1100 while (!defined $term_escapes{$key}) {
1101 my $next = ReadKey 0.5;
1102 last if (!defined $next);
1103 $key .= $next;
1105 $key =~ s/\e/^[/;
1107 print "$key" if defined $key;
1108 print "\n";
1109 return $key;
1110 } else {
1111 return <STDIN>;
1115 sub prompt_yesno {
1116 my ($prompt) = @_;
1117 while (1) {
1118 print colored $prompt_color, $prompt;
1119 my $line = prompt_single_character;
1120 return 0 if $line =~ /^n/i;
1121 return 1 if $line =~ /^y/i;
1125 sub edit_hunk_loop {
1126 my ($head, $hunk, $ix) = @_;
1127 my $text = $hunk->[$ix]->{TEXT};
1129 while (1) {
1130 $text = edit_hunk_manually($text);
1131 if (!defined $text) {
1132 return undef;
1134 my $newhunk = {
1135 TEXT => $text,
1136 TYPE => $hunk->[$ix]->{TYPE},
1137 USE => 1,
1138 DIRTY => 1,
1140 if (diff_applies($head,
1141 @{$hunk}[0..$ix-1],
1142 $newhunk,
1143 @{$hunk}[$ix+1..$#{$hunk}])) {
1144 $newhunk->{DISPLAY} = [color_diff(@{$text})];
1145 return $newhunk;
1147 else {
1148 prompt_yesno(
1149 'Your edited hunk does not apply. Edit again '
1150 . '(saying "no" discards!) [y/n]? '
1151 ) or return undef;
1156 sub help_patch_cmd {
1157 my $verb = lc $patch_mode_flavour{VERB};
1158 my $target = $patch_mode_flavour{TARGET};
1159 print colored $help_color, <<EOF ;
1160 y - $verb this hunk$target
1161 n - do not $verb this hunk$target
1162 q - quit; do not $verb this hunk or any of the remaining ones
1163 a - $verb this hunk and all later hunks in the file
1164 d - do not $verb this hunk or any of the later hunks in the file
1165 g - select a hunk to go to
1166 / - search for a hunk matching the given regex
1167 j - leave this hunk undecided, see next undecided hunk
1168 J - leave this hunk undecided, see next hunk
1169 k - leave this hunk undecided, see previous undecided hunk
1170 K - leave this hunk undecided, see previous hunk
1171 s - split the current hunk into smaller hunks
1172 e - manually edit the current hunk
1173 ? - print help
1177 sub apply_patch {
1178 my $cmd = shift;
1179 my $ret = run_git_apply $cmd, @_;
1180 if (!$ret) {
1181 print STDERR @_;
1183 return $ret;
1186 sub apply_patch_for_checkout_commit {
1187 my $reverse = shift;
1188 my $applies_index = run_git_apply 'apply '.$reverse.' --cached --check', @_;
1189 my $applies_worktree = run_git_apply 'apply '.$reverse.' --check', @_;
1191 if ($applies_worktree && $applies_index) {
1192 run_git_apply 'apply '.$reverse.' --cached', @_;
1193 run_git_apply 'apply '.$reverse, @_;
1194 return 1;
1195 } elsif (!$applies_index) {
1196 print colored $error_color, "The selected hunks do not apply to the index!\n";
1197 if (prompt_yesno "Apply them to the worktree anyway? ") {
1198 return run_git_apply 'apply '.$reverse, @_;
1199 } else {
1200 print colored $error_color, "Nothing was applied.\n";
1201 return 0;
1203 } else {
1204 print STDERR @_;
1205 return 0;
1209 sub patch_update_cmd {
1210 my @all_mods = list_modified($patch_mode_flavour{FILTER});
1211 error_msg "ignoring unmerged: $_->{VALUE}\n"
1212 for grep { $_->{UNMERGED} } @all_mods;
1213 @all_mods = grep { !$_->{UNMERGED} } @all_mods;
1215 my @mods = grep { !($_->{BINARY}) } @all_mods;
1216 my @them;
1218 if (!@mods) {
1219 if (@all_mods) {
1220 print STDERR "Only binary files changed.\n";
1221 } else {
1222 print STDERR "No changes.\n";
1224 return 0;
1226 if ($patch_mode) {
1227 @them = @mods;
1229 else {
1230 @them = list_and_choose({ PROMPT => 'Patch update',
1231 HEADER => $status_head, },
1232 @mods);
1234 for (@them) {
1235 return 0 if patch_update_file($_->{VALUE});
1239 # Generate a one line summary of a hunk.
1240 sub summarize_hunk {
1241 my $rhunk = shift;
1242 my $summary = $rhunk->{TEXT}[0];
1244 # Keep the line numbers, discard extra context.
1245 $summary =~ s/@@(.*?)@@.*/$1 /s;
1246 $summary .= " " x (20 - length $summary);
1248 # Add some user context.
1249 for my $line (@{$rhunk->{TEXT}}) {
1250 if ($line =~ m/^[+-].*\w/) {
1251 $summary .= $line;
1252 last;
1256 chomp $summary;
1257 return substr($summary, 0, 80) . "\n";
1261 # Print a one-line summary of each hunk in the array ref in
1262 # the first argument, starting with the index in the 2nd.
1263 sub display_hunks {
1264 my ($hunks, $i) = @_;
1265 my $ctr = 0;
1266 $i ||= 0;
1267 for (; $i < @$hunks && $ctr < 20; $i++, $ctr++) {
1268 my $status = " ";
1269 if (defined $hunks->[$i]{USE}) {
1270 $status = $hunks->[$i]{USE} ? "+" : "-";
1272 printf "%s%2d: %s",
1273 $status,
1274 $i + 1,
1275 summarize_hunk($hunks->[$i]);
1277 return $i;
1280 sub patch_update_file {
1281 my $quit = 0;
1282 my ($ix, $num);
1283 my $path = shift;
1284 my ($head, @hunk) = parse_diff($path);
1285 ($head, my $mode, my $deletion) = parse_diff_header($head);
1286 for (@{$head->{DISPLAY}}) {
1287 print;
1290 if (@{$mode->{TEXT}}) {
1291 unshift @hunk, $mode;
1293 if (@{$deletion->{TEXT}}) {
1294 foreach my $hunk (@hunk) {
1295 push @{$deletion->{TEXT}}, @{$hunk->{TEXT}};
1296 push @{$deletion->{DISPLAY}}, @{$hunk->{DISPLAY}};
1298 @hunk = ($deletion);
1301 $num = scalar @hunk;
1302 $ix = 0;
1304 while (1) {
1305 my ($prev, $next, $other, $undecided, $i);
1306 $other = '';
1308 if ($num <= $ix) {
1309 $ix = 0;
1311 for ($i = 0; $i < $ix; $i++) {
1312 if (!defined $hunk[$i]{USE}) {
1313 $prev = 1;
1314 $other .= ',k';
1315 last;
1318 if ($ix) {
1319 $other .= ',K';
1321 for ($i = $ix + 1; $i < $num; $i++) {
1322 if (!defined $hunk[$i]{USE}) {
1323 $next = 1;
1324 $other .= ',j';
1325 last;
1328 if ($ix < $num - 1) {
1329 $other .= ',J';
1331 if ($num > 1) {
1332 $other .= ',g';
1334 for ($i = 0; $i < $num; $i++) {
1335 if (!defined $hunk[$i]{USE}) {
1336 $undecided = 1;
1337 last;
1340 last if (!$undecided);
1342 if ($hunk[$ix]{TYPE} eq 'hunk' &&
1343 hunk_splittable($hunk[$ix]{TEXT})) {
1344 $other .= ',s';
1346 if ($hunk[$ix]{TYPE} eq 'hunk') {
1347 $other .= ',e';
1349 for (@{$hunk[$ix]{DISPLAY}}) {
1350 print;
1352 print colored $prompt_color, $patch_mode_flavour{VERB},
1353 ($hunk[$ix]{TYPE} eq 'mode' ? ' mode change' :
1354 $hunk[$ix]{TYPE} eq 'deletion' ? ' deletion' :
1355 ' this hunk'),
1356 $patch_mode_flavour{TARGET},
1357 " [y,n,q,a,d,/$other,?]? ";
1358 my $line = prompt_single_character;
1359 if ($line) {
1360 if ($line =~ /^y/i) {
1361 $hunk[$ix]{USE} = 1;
1363 elsif ($line =~ /^n/i) {
1364 $hunk[$ix]{USE} = 0;
1366 elsif ($line =~ /^a/i) {
1367 while ($ix < $num) {
1368 if (!defined $hunk[$ix]{USE}) {
1369 $hunk[$ix]{USE} = 1;
1371 $ix++;
1373 next;
1375 elsif ($other =~ /g/ && $line =~ /^g(.*)/) {
1376 my $response = $1;
1377 my $no = $ix > 10 ? $ix - 10 : 0;
1378 while ($response eq '') {
1379 my $extra = "";
1380 $no = display_hunks(\@hunk, $no);
1381 if ($no < $num) {
1382 $extra = " (<ret> to see more)";
1384 print "go to which hunk$extra? ";
1385 $response = <STDIN>;
1386 if (!defined $response) {
1387 $response = '';
1389 chomp $response;
1391 if ($response !~ /^\s*\d+\s*$/) {
1392 error_msg "Invalid number: '$response'\n";
1393 } elsif (0 < $response && $response <= $num) {
1394 $ix = $response - 1;
1395 } else {
1396 error_msg "Sorry, only $num hunks available.\n";
1398 next;
1400 elsif ($line =~ /^d/i) {
1401 while ($ix < $num) {
1402 if (!defined $hunk[$ix]{USE}) {
1403 $hunk[$ix]{USE} = 0;
1405 $ix++;
1407 next;
1409 elsif ($line =~ /^q/i) {
1410 for ($i = 0; $i < $num; $i++) {
1411 if (!defined $hunk[$i]{USE}) {
1412 $hunk[$i]{USE} = 0;
1415 $quit = 1;
1416 last;
1418 elsif ($line =~ m|^/(.*)|) {
1419 my $regex = $1;
1420 if ($1 eq "") {
1421 print colored $prompt_color, "search for regex? ";
1422 $regex = <STDIN>;
1423 if (defined $regex) {
1424 chomp $regex;
1427 my $search_string;
1428 eval {
1429 $search_string = qr{$regex}m;
1431 if ($@) {
1432 my ($err,$exp) = ($@, $1);
1433 $err =~ s/ at .*git-add--interactive line \d+, <STDIN> line \d+.*$//;
1434 error_msg "Malformed search regexp $exp: $err\n";
1435 next;
1437 my $iy = $ix;
1438 while (1) {
1439 my $text = join ("", @{$hunk[$iy]{TEXT}});
1440 last if ($text =~ $search_string);
1441 $iy++;
1442 $iy = 0 if ($iy >= $num);
1443 if ($ix == $iy) {
1444 error_msg "No hunk matches the given pattern\n";
1445 last;
1448 $ix = $iy;
1449 next;
1451 elsif ($line =~ /^K/) {
1452 if ($other =~ /K/) {
1453 $ix--;
1455 else {
1456 error_msg "No previous hunk\n";
1458 next;
1460 elsif ($line =~ /^J/) {
1461 if ($other =~ /J/) {
1462 $ix++;
1464 else {
1465 error_msg "No next hunk\n";
1467 next;
1469 elsif ($line =~ /^k/) {
1470 if ($other =~ /k/) {
1471 while (1) {
1472 $ix--;
1473 last if (!$ix ||
1474 !defined $hunk[$ix]{USE});
1477 else {
1478 error_msg "No previous hunk\n";
1480 next;
1482 elsif ($line =~ /^j/) {
1483 if ($other !~ /j/) {
1484 error_msg "No next hunk\n";
1485 next;
1488 elsif ($other =~ /s/ && $line =~ /^s/) {
1489 my @split = split_hunk($hunk[$ix]{TEXT}, $hunk[$ix]{DISPLAY});
1490 if (1 < @split) {
1491 print colored $header_color, "Split into ",
1492 scalar(@split), " hunks.\n";
1494 splice (@hunk, $ix, 1, @split);
1495 $num = scalar @hunk;
1496 next;
1498 elsif ($other =~ /e/ && $line =~ /^e/) {
1499 my $newhunk = edit_hunk_loop($head, \@hunk, $ix);
1500 if (defined $newhunk) {
1501 splice @hunk, $ix, 1, $newhunk;
1504 else {
1505 help_patch_cmd($other);
1506 next;
1508 # soft increment
1509 while (1) {
1510 $ix++;
1511 last if ($ix >= $num ||
1512 !defined $hunk[$ix]{USE});
1517 @hunk = coalesce_overlapping_hunks(@hunk);
1519 my $n_lofs = 0;
1520 my @result = ();
1521 for (@hunk) {
1522 if ($_->{USE}) {
1523 push @result, @{$_->{TEXT}};
1527 if (@result) {
1528 my @patch = reassemble_patch($head->{TEXT}, @result);
1529 my $apply_routine = $patch_mode_flavour{APPLY};
1530 &$apply_routine(@patch);
1531 refresh();
1534 print "\n";
1535 return $quit;
1538 sub diff_cmd {
1539 my @mods = list_modified('index-only');
1540 @mods = grep { !($_->{BINARY}) } @mods;
1541 return if (!@mods);
1542 my (@them) = list_and_choose({ PROMPT => 'Review diff',
1543 IMMEDIATE => 1,
1544 HEADER => $status_head, },
1545 @mods);
1546 return if (!@them);
1547 my $reference = is_initial_commit() ? get_empty_tree() : 'HEAD';
1548 system(qw(git diff -p --cached), $reference, '--',
1549 map { $_->{VALUE} } @them);
1552 sub quit_cmd {
1553 print "Bye.\n";
1554 exit(0);
1557 sub help_cmd {
1558 print colored $help_color, <<\EOF ;
1559 status - show paths with changes
1560 update - add working tree state to the staged set of changes
1561 revert - revert staged set of changes back to the HEAD version
1562 patch - pick hunks and update selectively
1563 diff - view diff between HEAD and index
1564 add untracked - add contents of untracked files to the staged set of changes
1568 sub process_args {
1569 return unless @ARGV;
1570 my $arg = shift @ARGV;
1571 if ($arg =~ /--patch(?:=(.*))?/) {
1572 if (defined $1) {
1573 if ($1 eq 'reset') {
1574 $patch_mode = 'reset_head';
1575 $patch_mode_revision = 'HEAD';
1576 $arg = shift @ARGV or die "missing --";
1577 if ($arg ne '--') {
1578 $patch_mode_revision = $arg;
1579 $patch_mode = ($arg eq 'HEAD' ?
1580 'reset_head' : 'reset_nothead');
1581 $arg = shift @ARGV or die "missing --";
1583 } elsif ($1 eq 'checkout') {
1584 $arg = shift @ARGV or die "missing --";
1585 if ($arg eq '--') {
1586 $patch_mode = 'checkout_index';
1587 } else {
1588 $patch_mode_revision = $arg;
1589 $patch_mode = ($arg eq 'HEAD' ?
1590 'checkout_head' : 'checkout_nothead');
1591 $arg = shift @ARGV or die "missing --";
1593 } elsif ($1 eq 'stage' or $1 eq 'stash') {
1594 $patch_mode = $1;
1595 $arg = shift @ARGV or die "missing --";
1596 } else {
1597 die "unknown --patch mode: $1";
1599 } else {
1600 $patch_mode = 'stage';
1601 $arg = shift @ARGV or die "missing --";
1603 die "invalid argument $arg, expecting --"
1604 unless $arg eq "--";
1605 %patch_mode_flavour = %{$patch_modes{$patch_mode}};
1607 elsif ($arg ne "--") {
1608 die "invalid argument $arg, expecting --";
1612 sub main_loop {
1613 my @cmd = ([ 'status', \&status_cmd, ],
1614 [ 'update', \&update_cmd, ],
1615 [ 'revert', \&revert_cmd, ],
1616 [ 'add untracked', \&add_untracked_cmd, ],
1617 [ 'patch', \&patch_update_cmd, ],
1618 [ 'diff', \&diff_cmd, ],
1619 [ 'quit', \&quit_cmd, ],
1620 [ 'help', \&help_cmd, ],
1622 while (1) {
1623 my ($it) = list_and_choose({ PROMPT => 'What now',
1624 SINGLETON => 1,
1625 LIST_FLAT => 4,
1626 HEADER => '*** Commands ***',
1627 ON_EOF => \&quit_cmd,
1628 IMMEDIATE => 1 }, @cmd);
1629 if ($it) {
1630 eval {
1631 $it->[1]->();
1633 if ($@) {
1634 print "$@";
1640 process_args();
1641 refresh();
1642 if ($patch_mode) {
1643 patch_update_cmd();
1645 else {
1646 status_cmd();
1647 main_loop();