Correct help blurb in checkout -p and friends
[git/jnareb-git.git] / git-add--interactive.perl
blob406beb5c507b6fc0e9bc855cfab784b7570342ab
1 #!/usr/bin/perl -w
3 use strict;
4 use Git;
6 binmode(STDOUT, ":raw");
8 my $repo = Git->repository();
10 my $menu_use_color = $repo->get_colorbool('color.interactive');
11 my ($prompt_color, $header_color, $help_color) =
12 $menu_use_color ? (
13 $repo->get_color('color.interactive.prompt', 'bold blue'),
14 $repo->get_color('color.interactive.header', 'bold'),
15 $repo->get_color('color.interactive.help', 'red bold'),
16 ) : ();
17 my $error_color = ();
18 if ($menu_use_color) {
19 my $help_color_spec = ($repo->config('color.interactive.help') or
20 'red bold');
21 $error_color = $repo->get_color('color.interactive.error',
22 $help_color_spec);
25 my $diff_use_color = $repo->get_colorbool('color.diff');
26 my ($fraginfo_color) =
27 $diff_use_color ? (
28 $repo->get_color('color.diff.frag', 'cyan'),
29 ) : ();
30 my ($diff_plain_color) =
31 $diff_use_color ? (
32 $repo->get_color('color.diff.plain', ''),
33 ) : ();
34 my ($diff_old_color) =
35 $diff_use_color ? (
36 $repo->get_color('color.diff.old', 'red'),
37 ) : ();
38 my ($diff_new_color) =
39 $diff_use_color ? (
40 $repo->get_color('color.diff.new', 'green'),
41 ) : ();
43 my $normal_color = $repo->get_color("", "reset");
45 my $use_readkey = 0;
46 sub ReadMode;
47 sub ReadKey;
48 if ($repo->config_bool("interactive.singlekey")) {
49 eval {
50 require Term::ReadKey;
51 Term::ReadKey->import;
52 $use_readkey = 1;
56 sub colored {
57 my $color = shift;
58 my $string = join("", @_);
60 if (defined $color) {
61 # Put a color code at the beginning of each line, a reset at the end
62 # color after newlines that are not at the end of the string
63 $string =~ s/(\n+)(.)/$1$color$2/g;
64 # reset before newlines
65 $string =~ s/(\n+)/$normal_color$1/g;
66 # codes at beginning and end (if necessary):
67 $string =~ s/^/$color/;
68 $string =~ s/$/$normal_color/ unless $string =~ /\n$/;
70 return $string;
73 # command line options
74 my $patch_mode;
75 my $patch_mode_revision;
77 sub apply_patch;
78 sub apply_patch_for_checkout_commit;
79 sub apply_patch_for_stash;
81 my %patch_modes = (
82 'stage' => {
83 DIFF => 'diff-files -p',
84 APPLY => sub { apply_patch 'apply --cached', @_; },
85 APPLY_CHECK => 'apply --cached',
86 VERB => 'Stage',
87 TARGET => '',
88 PARTICIPLE => 'staging',
89 FILTER => 'file-only',
90 IS_REVERSE => 0,
92 'stash' => {
93 DIFF => 'diff-index -p HEAD',
94 APPLY => sub { apply_patch 'apply --cached', @_; },
95 APPLY_CHECK => 'apply --cached',
96 VERB => 'Stash',
97 TARGET => '',
98 PARTICIPLE => 'stashing',
99 FILTER => undef,
100 IS_REVERSE => 0,
102 'reset_head' => {
103 DIFF => 'diff-index -p --cached',
104 APPLY => sub { apply_patch 'apply -R --cached', @_; },
105 APPLY_CHECK => 'apply -R --cached',
106 VERB => 'Unstage',
107 TARGET => '',
108 PARTICIPLE => 'unstaging',
109 FILTER => 'index-only',
110 IS_REVERSE => 1,
112 'reset_nothead' => {
113 DIFF => 'diff-index -R -p --cached',
114 APPLY => sub { apply_patch 'apply --cached', @_; },
115 APPLY_CHECK => 'apply --cached',
116 VERB => 'Apply',
117 TARGET => ' to index',
118 PARTICIPLE => 'applying',
119 FILTER => 'index-only',
120 IS_REVERSE => 0,
122 'checkout_index' => {
123 DIFF => 'diff-files -p',
124 APPLY => sub { apply_patch 'apply -R', @_; },
125 APPLY_CHECK => 'apply -R',
126 VERB => 'Discard',
127 TARGET => ' from worktree',
128 PARTICIPLE => 'discarding',
129 FILTER => 'file-only',
130 IS_REVERSE => 1,
132 'checkout_head' => {
133 DIFF => 'diff-index -p',
134 APPLY => sub { apply_patch_for_checkout_commit '-R', @_ },
135 APPLY_CHECK => 'apply -R',
136 VERB => 'Discard',
137 TARGET => ' from index and worktree',
138 PARTICIPLE => 'discarding',
139 FILTER => undef,
140 IS_REVERSE => 1,
142 'checkout_nothead' => {
143 DIFF => 'diff-index -R -p',
144 APPLY => sub { apply_patch_for_checkout_commit '', @_ },
145 APPLY_CHECK => 'apply',
146 VERB => 'Apply',
147 TARGET => ' to index and worktree',
148 PARTICIPLE => 'applying',
149 FILTER => undef,
150 IS_REVERSE => 0,
154 my %patch_mode_flavour = %{$patch_modes{stage}};
156 sub run_cmd_pipe {
157 if ($^O eq 'MSWin32' || $^O eq 'msys') {
158 my @invalid = grep {m/[":*]/} @_;
159 die "$^O does not support: @invalid\n" if @invalid;
160 my @args = map { m/ /o ? "\"$_\"": $_ } @_;
161 return qx{@args};
162 } else {
163 my $fh = undef;
164 open($fh, '-|', @_) or die;
165 return <$fh>;
169 my ($GIT_DIR) = run_cmd_pipe(qw(git rev-parse --git-dir));
171 if (!defined $GIT_DIR) {
172 exit(1); # rev-parse would have already said "not a git repo"
174 chomp($GIT_DIR);
176 my %cquote_map = (
177 "b" => chr(8),
178 "t" => chr(9),
179 "n" => chr(10),
180 "v" => chr(11),
181 "f" => chr(12),
182 "r" => chr(13),
183 "\\" => "\\",
184 "\042" => "\042",
187 sub unquote_path {
188 local ($_) = @_;
189 my ($retval, $remainder);
190 if (!/^\042(.*)\042$/) {
191 return $_;
193 ($_, $retval) = ($1, "");
194 while (/^([^\\]*)\\(.*)$/) {
195 $remainder = $2;
196 $retval .= $1;
197 for ($remainder) {
198 if (/^([0-3][0-7][0-7])(.*)$/) {
199 $retval .= chr(oct($1));
200 $_ = $2;
201 last;
203 if (/^([\\\042btnvfr])(.*)$/) {
204 $retval .= $cquote_map{$1};
205 $_ = $2;
206 last;
208 # This is malformed -- just return it as-is for now.
209 return $_[0];
211 $_ = $remainder;
213 $retval .= $_;
214 return $retval;
217 sub refresh {
218 my $fh;
219 open $fh, 'git update-index --refresh |'
220 or die;
221 while (<$fh>) {
222 ;# ignore 'needs update'
224 close $fh;
227 sub list_untracked {
228 map {
229 chomp $_;
230 unquote_path($_);
232 run_cmd_pipe(qw(git ls-files --others --exclude-standard --), @ARGV);
235 my $status_fmt = '%12s %12s %s';
236 my $status_head = sprintf($status_fmt, 'staged', 'unstaged', 'path');
239 my $initial;
240 sub is_initial_commit {
241 $initial = system('git rev-parse HEAD -- >/dev/null 2>&1') != 0
242 unless defined $initial;
243 return $initial;
247 sub get_empty_tree {
248 return '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
251 # Returns list of hashes, contents of each of which are:
252 # VALUE: pathname
253 # BINARY: is a binary path
254 # INDEX: is index different from HEAD?
255 # FILE: is file different from index?
256 # INDEX_ADDDEL: is it add/delete between HEAD and index?
257 # FILE_ADDDEL: is it add/delete between index and file?
259 sub list_modified {
260 my ($only) = @_;
261 my (%data, @return);
262 my ($add, $del, $adddel, $file);
263 my @tracked = ();
265 if (@ARGV) {
266 @tracked = map {
267 chomp $_;
268 unquote_path($_);
269 } run_cmd_pipe(qw(git ls-files --), @ARGV);
270 return if (!@tracked);
273 my $reference;
274 if (defined $patch_mode_revision and $patch_mode_revision ne 'HEAD') {
275 $reference = $patch_mode_revision;
276 } elsif (is_initial_commit()) {
277 $reference = get_empty_tree();
278 } else {
279 $reference = 'HEAD';
281 for (run_cmd_pipe(qw(git diff-index --cached
282 --numstat --summary), $reference,
283 '--', @tracked)) {
284 if (($add, $del, $file) =
285 /^([-\d]+) ([-\d]+) (.*)/) {
286 my ($change, $bin);
287 $file = unquote_path($file);
288 if ($add eq '-' && $del eq '-') {
289 $change = 'binary';
290 $bin = 1;
292 else {
293 $change = "+$add/-$del";
295 $data{$file} = {
296 INDEX => $change,
297 BINARY => $bin,
298 FILE => 'nothing',
301 elsif (($adddel, $file) =
302 /^ (create|delete) mode [0-7]+ (.*)$/) {
303 $file = unquote_path($file);
304 $data{$file}{INDEX_ADDDEL} = $adddel;
308 for (run_cmd_pipe(qw(git diff-files --numstat --summary --), @tracked)) {
309 if (($add, $del, $file) =
310 /^([-\d]+) ([-\d]+) (.*)/) {
311 $file = unquote_path($file);
312 if (!exists $data{$file}) {
313 $data{$file} = +{
314 INDEX => 'unchanged',
315 BINARY => 0,
318 my ($change, $bin);
319 if ($add eq '-' && $del eq '-') {
320 $change = 'binary';
321 $bin = 1;
323 else {
324 $change = "+$add/-$del";
326 $data{$file}{FILE} = $change;
327 if ($bin) {
328 $data{$file}{BINARY} = 1;
331 elsif (($adddel, $file) =
332 /^ (create|delete) mode [0-7]+ (.*)$/) {
333 $file = unquote_path($file);
334 $data{$file}{FILE_ADDDEL} = $adddel;
338 for (sort keys %data) {
339 my $it = $data{$_};
341 if ($only) {
342 if ($only eq 'index-only') {
343 next if ($it->{INDEX} eq 'unchanged');
345 if ($only eq 'file-only') {
346 next if ($it->{FILE} eq 'nothing');
349 push @return, +{
350 VALUE => $_,
351 %$it,
354 return @return;
357 sub find_unique {
358 my ($string, @stuff) = @_;
359 my $found = undef;
360 for (my $i = 0; $i < @stuff; $i++) {
361 my $it = $stuff[$i];
362 my $hit = undef;
363 if (ref $it) {
364 if ((ref $it) eq 'ARRAY') {
365 $it = $it->[0];
367 else {
368 $it = $it->{VALUE};
371 eval {
372 if ($it =~ /^$string/) {
373 $hit = 1;
376 if (defined $hit && defined $found) {
377 return undef;
379 if ($hit) {
380 $found = $i + 1;
383 return $found;
386 # inserts string into trie and updates count for each character
387 sub update_trie {
388 my ($trie, $string) = @_;
389 foreach (split //, $string) {
390 $trie = $trie->{$_} ||= {COUNT => 0};
391 $trie->{COUNT}++;
395 # returns an array of tuples (prefix, remainder)
396 sub find_unique_prefixes {
397 my @stuff = @_;
398 my @return = ();
400 # any single prefix exceeding the soft limit is omitted
401 # if any prefix exceeds the hard limit all are omitted
402 # 0 indicates no limit
403 my $soft_limit = 0;
404 my $hard_limit = 3;
406 # build a trie modelling all possible options
407 my %trie;
408 foreach my $print (@stuff) {
409 if ((ref $print) eq 'ARRAY') {
410 $print = $print->[0];
412 elsif ((ref $print) eq 'HASH') {
413 $print = $print->{VALUE};
415 update_trie(\%trie, $print);
416 push @return, $print;
419 # use the trie to find the unique prefixes
420 for (my $i = 0; $i < @return; $i++) {
421 my $ret = $return[$i];
422 my @letters = split //, $ret;
423 my %search = %trie;
424 my ($prefix, $remainder);
425 my $j;
426 for ($j = 0; $j < @letters; $j++) {
427 my $letter = $letters[$j];
428 if ($search{$letter}{COUNT} == 1) {
429 $prefix = substr $ret, 0, $j + 1;
430 $remainder = substr $ret, $j + 1;
431 last;
433 else {
434 my $prefix = substr $ret, 0, $j;
435 return ()
436 if ($hard_limit && $j + 1 > $hard_limit);
438 %search = %{$search{$letter}};
440 if (ord($letters[0]) > 127 ||
441 ($soft_limit && $j + 1 > $soft_limit)) {
442 $prefix = undef;
443 $remainder = $ret;
445 $return[$i] = [$prefix, $remainder];
447 return @return;
450 # filters out prefixes which have special meaning to list_and_choose()
451 sub is_valid_prefix {
452 my $prefix = shift;
453 return (defined $prefix) &&
454 !($prefix =~ /[\s,]/) && # separators
455 !($prefix =~ /^-/) && # deselection
456 !($prefix =~ /^\d+/) && # selection
457 ($prefix ne '*') && # "all" wildcard
458 ($prefix ne '?'); # prompt help
461 # given a prefix/remainder tuple return a string with the prefix highlighted
462 # for now use square brackets; later might use ANSI colors (underline, bold)
463 sub highlight_prefix {
464 my $prefix = shift;
465 my $remainder = shift;
467 if (!defined $prefix) {
468 return $remainder;
471 if (!is_valid_prefix($prefix)) {
472 return "$prefix$remainder";
475 if (!$menu_use_color) {
476 return "[$prefix]$remainder";
479 return "$prompt_color$prefix$normal_color$remainder";
482 sub error_msg {
483 print STDERR colored $error_color, @_;
486 sub list_and_choose {
487 my ($opts, @stuff) = @_;
488 my (@chosen, @return);
489 my $i;
490 my @prefixes = find_unique_prefixes(@stuff) unless $opts->{LIST_ONLY};
492 TOPLOOP:
493 while (1) {
494 my $last_lf = 0;
496 if ($opts->{HEADER}) {
497 if (!$opts->{LIST_FLAT}) {
498 print " ";
500 print colored $header_color, "$opts->{HEADER}\n";
502 for ($i = 0; $i < @stuff; $i++) {
503 my $chosen = $chosen[$i] ? '*' : ' ';
504 my $print = $stuff[$i];
505 my $ref = ref $print;
506 my $highlighted = highlight_prefix(@{$prefixes[$i]})
507 if @prefixes;
508 if ($ref eq 'ARRAY') {
509 $print = $highlighted || $print->[0];
511 elsif ($ref eq 'HASH') {
512 my $value = $highlighted || $print->{VALUE};
513 $print = sprintf($status_fmt,
514 $print->{INDEX},
515 $print->{FILE},
516 $value);
518 else {
519 $print = $highlighted || $print;
521 printf("%s%2d: %s", $chosen, $i+1, $print);
522 if (($opts->{LIST_FLAT}) &&
523 (($i + 1) % ($opts->{LIST_FLAT}))) {
524 print "\t";
525 $last_lf = 0;
527 else {
528 print "\n";
529 $last_lf = 1;
532 if (!$last_lf) {
533 print "\n";
536 return if ($opts->{LIST_ONLY});
538 print colored $prompt_color, $opts->{PROMPT};
539 if ($opts->{SINGLETON}) {
540 print "> ";
542 else {
543 print ">> ";
545 my $line = <STDIN>;
546 if (!$line) {
547 print "\n";
548 $opts->{ON_EOF}->() if $opts->{ON_EOF};
549 last;
551 chomp $line;
552 last if $line eq '';
553 if ($line eq '?') {
554 $opts->{SINGLETON} ?
555 singleton_prompt_help_cmd() :
556 prompt_help_cmd();
557 next TOPLOOP;
559 for my $choice (split(/[\s,]+/, $line)) {
560 my $choose = 1;
561 my ($bottom, $top);
563 # Input that begins with '-'; unchoose
564 if ($choice =~ s/^-//) {
565 $choose = 0;
567 # A range can be specified like 5-7 or 5-.
568 if ($choice =~ /^(\d+)-(\d*)$/) {
569 ($bottom, $top) = ($1, length($2) ? $2 : 1 + @stuff);
571 elsif ($choice =~ /^\d+$/) {
572 $bottom = $top = $choice;
574 elsif ($choice eq '*') {
575 $bottom = 1;
576 $top = 1 + @stuff;
578 else {
579 $bottom = $top = find_unique($choice, @stuff);
580 if (!defined $bottom) {
581 error_msg "Huh ($choice)?\n";
582 next TOPLOOP;
585 if ($opts->{SINGLETON} && $bottom != $top) {
586 error_msg "Huh ($choice)?\n";
587 next TOPLOOP;
589 for ($i = $bottom-1; $i <= $top-1; $i++) {
590 next if (@stuff <= $i || $i < 0);
591 $chosen[$i] = $choose;
594 last if ($opts->{IMMEDIATE} || $line eq '*');
596 for ($i = 0; $i < @stuff; $i++) {
597 if ($chosen[$i]) {
598 push @return, $stuff[$i];
601 return @return;
604 sub singleton_prompt_help_cmd {
605 print colored $help_color, <<\EOF ;
606 Prompt help:
607 1 - select a numbered item
608 foo - select item based on unique prefix
609 - (empty) select nothing
613 sub prompt_help_cmd {
614 print colored $help_color, <<\EOF ;
615 Prompt help:
616 1 - select a single item
617 3-5 - select a range of items
618 2-3,6-9 - select multiple ranges
619 foo - select item based on unique prefix
620 -... - unselect specified items
621 * - choose all items
622 - (empty) finish selecting
626 sub status_cmd {
627 list_and_choose({ LIST_ONLY => 1, HEADER => $status_head },
628 list_modified());
629 print "\n";
632 sub say_n_paths {
633 my $did = shift @_;
634 my $cnt = scalar @_;
635 print "$did ";
636 if (1 < $cnt) {
637 print "$cnt paths\n";
639 else {
640 print "one path\n";
644 sub update_cmd {
645 my @mods = list_modified('file-only');
646 return if (!@mods);
648 my @update = list_and_choose({ PROMPT => 'Update',
649 HEADER => $status_head, },
650 @mods);
651 if (@update) {
652 system(qw(git update-index --add --remove --),
653 map { $_->{VALUE} } @update);
654 say_n_paths('updated', @update);
656 print "\n";
659 sub revert_cmd {
660 my @update = list_and_choose({ PROMPT => 'Revert',
661 HEADER => $status_head, },
662 list_modified());
663 if (@update) {
664 if (is_initial_commit()) {
665 system(qw(git rm --cached),
666 map { $_->{VALUE} } @update);
668 else {
669 my @lines = run_cmd_pipe(qw(git ls-tree HEAD --),
670 map { $_->{VALUE} } @update);
671 my $fh;
672 open $fh, '| git update-index --index-info'
673 or die;
674 for (@lines) {
675 print $fh $_;
677 close($fh);
678 for (@update) {
679 if ($_->{INDEX_ADDDEL} &&
680 $_->{INDEX_ADDDEL} eq 'create') {
681 system(qw(git update-index --force-remove --),
682 $_->{VALUE});
683 print "note: $_->{VALUE} is untracked now.\n";
687 refresh();
688 say_n_paths('reverted', @update);
690 print "\n";
693 sub add_untracked_cmd {
694 my @add = list_and_choose({ PROMPT => 'Add untracked' },
695 list_untracked());
696 if (@add) {
697 system(qw(git update-index --add --), @add);
698 say_n_paths('added', @add);
700 print "\n";
703 sub run_git_apply {
704 my $cmd = shift;
705 my $fh;
706 open $fh, '| git ' . $cmd;
707 print $fh @_;
708 return close $fh;
711 sub parse_diff {
712 my ($path) = @_;
713 my @diff_cmd = split(" ", $patch_mode_flavour{DIFF});
714 if (defined $patch_mode_revision) {
715 push @diff_cmd, $patch_mode_revision;
717 my @diff = run_cmd_pipe("git", @diff_cmd, "--", $path);
718 my @colored = ();
719 if ($diff_use_color) {
720 @colored = run_cmd_pipe("git", @diff_cmd, qw(--color --), $path);
722 my (@hunk) = { TEXT => [], DISPLAY => [], TYPE => 'header' };
724 for (my $i = 0; $i < @diff; $i++) {
725 if ($diff[$i] =~ /^@@ /) {
726 push @hunk, { TEXT => [], DISPLAY => [],
727 TYPE => 'hunk' };
729 push @{$hunk[-1]{TEXT}}, $diff[$i];
730 push @{$hunk[-1]{DISPLAY}},
731 ($diff_use_color ? $colored[$i] : $diff[$i]);
733 return @hunk;
736 sub parse_diff_header {
737 my $src = shift;
739 my $head = { TEXT => [], DISPLAY => [], TYPE => 'header' };
740 my $mode = { TEXT => [], DISPLAY => [], TYPE => 'mode' };
741 my $deletion = { TEXT => [], DISPLAY => [], TYPE => 'deletion' };
743 for (my $i = 0; $i < @{$src->{TEXT}}; $i++) {
744 my $dest =
745 $src->{TEXT}->[$i] =~ /^(old|new) mode (\d+)$/ ? $mode :
746 $src->{TEXT}->[$i] =~ /^deleted file/ ? $deletion :
747 $head;
748 push @{$dest->{TEXT}}, $src->{TEXT}->[$i];
749 push @{$dest->{DISPLAY}}, $src->{DISPLAY}->[$i];
751 return ($head, $mode, $deletion);
754 sub hunk_splittable {
755 my ($text) = @_;
757 my @s = split_hunk($text);
758 return (1 < @s);
761 sub parse_hunk_header {
762 my ($line) = @_;
763 my ($o_ofs, $o_cnt, $n_ofs, $n_cnt) =
764 $line =~ /^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@/;
765 $o_cnt = 1 unless defined $o_cnt;
766 $n_cnt = 1 unless defined $n_cnt;
767 return ($o_ofs, $o_cnt, $n_ofs, $n_cnt);
770 sub split_hunk {
771 my ($text, $display) = @_;
772 my @split = ();
773 if (!defined $display) {
774 $display = $text;
776 # If there are context lines in the middle of a hunk,
777 # it can be split, but we would need to take care of
778 # overlaps later.
780 my ($o_ofs, undef, $n_ofs) = parse_hunk_header($text->[0]);
781 my $hunk_start = 1;
783 OUTER:
784 while (1) {
785 my $next_hunk_start = undef;
786 my $i = $hunk_start - 1;
787 my $this = +{
788 TEXT => [],
789 DISPLAY => [],
790 TYPE => 'hunk',
791 OLD => $o_ofs,
792 NEW => $n_ofs,
793 OCNT => 0,
794 NCNT => 0,
795 ADDDEL => 0,
796 POSTCTX => 0,
797 USE => undef,
800 while (++$i < @$text) {
801 my $line = $text->[$i];
802 my $display = $display->[$i];
803 if ($line =~ /^ /) {
804 if ($this->{ADDDEL} &&
805 !defined $next_hunk_start) {
806 # We have seen leading context and
807 # adds/dels and then here is another
808 # context, which is trailing for this
809 # split hunk and leading for the next
810 # one.
811 $next_hunk_start = $i;
813 push @{$this->{TEXT}}, $line;
814 push @{$this->{DISPLAY}}, $display;
815 $this->{OCNT}++;
816 $this->{NCNT}++;
817 if (defined $next_hunk_start) {
818 $this->{POSTCTX}++;
820 next;
823 # add/del
824 if (defined $next_hunk_start) {
825 # We are done with the current hunk and
826 # this is the first real change for the
827 # next split one.
828 $hunk_start = $next_hunk_start;
829 $o_ofs = $this->{OLD} + $this->{OCNT};
830 $n_ofs = $this->{NEW} + $this->{NCNT};
831 $o_ofs -= $this->{POSTCTX};
832 $n_ofs -= $this->{POSTCTX};
833 push @split, $this;
834 redo OUTER;
836 push @{$this->{TEXT}}, $line;
837 push @{$this->{DISPLAY}}, $display;
838 $this->{ADDDEL}++;
839 if ($line =~ /^-/) {
840 $this->{OCNT}++;
842 else {
843 $this->{NCNT}++;
847 push @split, $this;
848 last;
851 for my $hunk (@split) {
852 $o_ofs = $hunk->{OLD};
853 $n_ofs = $hunk->{NEW};
854 my $o_cnt = $hunk->{OCNT};
855 my $n_cnt = $hunk->{NCNT};
857 my $head = ("@@ -$o_ofs" .
858 (($o_cnt != 1) ? ",$o_cnt" : '') .
859 " +$n_ofs" .
860 (($n_cnt != 1) ? ",$n_cnt" : '') .
861 " @@\n");
862 my $display_head = $head;
863 unshift @{$hunk->{TEXT}}, $head;
864 if ($diff_use_color) {
865 $display_head = colored($fraginfo_color, $head);
867 unshift @{$hunk->{DISPLAY}}, $display_head;
869 return @split;
872 sub find_last_o_ctx {
873 my ($it) = @_;
874 my $text = $it->{TEXT};
875 my ($o_ofs, $o_cnt) = parse_hunk_header($text->[0]);
876 my $i = @{$text};
877 my $last_o_ctx = $o_ofs + $o_cnt;
878 while (0 < --$i) {
879 my $line = $text->[$i];
880 if ($line =~ /^ /) {
881 $last_o_ctx--;
882 next;
884 last;
886 return $last_o_ctx;
889 sub merge_hunk {
890 my ($prev, $this) = @_;
891 my ($o0_ofs, $o0_cnt, $n0_ofs, $n0_cnt) =
892 parse_hunk_header($prev->{TEXT}[0]);
893 my ($o1_ofs, $o1_cnt, $n1_ofs, $n1_cnt) =
894 parse_hunk_header($this->{TEXT}[0]);
896 my (@line, $i, $ofs, $o_cnt, $n_cnt);
897 $ofs = $o0_ofs;
898 $o_cnt = $n_cnt = 0;
899 for ($i = 1; $i < @{$prev->{TEXT}}; $i++) {
900 my $line = $prev->{TEXT}[$i];
901 if ($line =~ /^\+/) {
902 $n_cnt++;
903 push @line, $line;
904 next;
907 last if ($o1_ofs <= $ofs);
909 $o_cnt++;
910 $ofs++;
911 if ($line =~ /^ /) {
912 $n_cnt++;
914 push @line, $line;
917 for ($i = 1; $i < @{$this->{TEXT}}; $i++) {
918 my $line = $this->{TEXT}[$i];
919 if ($line =~ /^\+/) {
920 $n_cnt++;
921 push @line, $line;
922 next;
924 $ofs++;
925 $o_cnt++;
926 if ($line =~ /^ /) {
927 $n_cnt++;
929 push @line, $line;
931 my $head = ("@@ -$o0_ofs" .
932 (($o_cnt != 1) ? ",$o_cnt" : '') .
933 " +$n0_ofs" .
934 (($n_cnt != 1) ? ",$n_cnt" : '') .
935 " @@\n");
936 @{$prev->{TEXT}} = ($head, @line);
939 sub coalesce_overlapping_hunks {
940 my (@in) = @_;
941 my @out = ();
943 my ($last_o_ctx, $last_was_dirty);
945 for (grep { $_->{USE} } @in) {
946 if ($_->{TYPE} ne 'hunk') {
947 push @out, $_;
948 next;
950 my $text = $_->{TEXT};
951 my ($o_ofs) = parse_hunk_header($text->[0]);
952 if (defined $last_o_ctx &&
953 $o_ofs <= $last_o_ctx &&
954 !$_->{DIRTY} &&
955 !$last_was_dirty) {
956 merge_hunk($out[-1], $_);
958 else {
959 push @out, $_;
961 $last_o_ctx = find_last_o_ctx($out[-1]);
962 $last_was_dirty = $_->{DIRTY};
964 return @out;
967 sub reassemble_patch {
968 my $head = shift;
969 my @patch;
971 # Include everything in the header except the beginning of the diff.
972 push @patch, (grep { !/^[-+]{3}/ } @$head);
974 # Then include any headers from the hunk lines, which must
975 # come before any actual hunk.
976 while (@_ && $_[0] !~ /^@/) {
977 push @patch, shift;
980 # Then begin the diff.
981 push @patch, grep { /^[-+]{3}/ } @$head;
983 # And then the actual hunks.
984 push @patch, @_;
986 return @patch;
989 sub color_diff {
990 return map {
991 colored((/^@/ ? $fraginfo_color :
992 /^\+/ ? $diff_new_color :
993 /^-/ ? $diff_old_color :
994 $diff_plain_color),
995 $_);
996 } @_;
999 sub edit_hunk_manually {
1000 my ($oldtext) = @_;
1002 my $hunkfile = $repo->repo_path . "/addp-hunk-edit.diff";
1003 my $fh;
1004 open $fh, '>', $hunkfile
1005 or die "failed to open hunk edit file for writing: " . $!;
1006 print $fh "# Manual hunk edit mode -- see bottom for a quick guide\n";
1007 print $fh @$oldtext;
1008 my $participle = $patch_mode_flavour{PARTICIPLE};
1009 my $is_reverse = $patch_mode_flavour{IS_REVERSE};
1010 my ($remove_plus, $remove_minus) = $is_reverse ? ('-', '+') : ('+', '-');
1011 print $fh <<EOF;
1012 # ---
1013 # To remove '$remove_minus' lines, make them ' ' lines (context).
1014 # To remove '$remove_plus' lines, delete them.
1015 # Lines starting with # will be removed.
1017 # If the patch applies cleanly, the edited hunk will immediately be
1018 # marked for $participle. If it does not apply cleanly, you will be given
1019 # an opportunity to edit again. If all lines of the hunk are removed,
1020 # then the edit is aborted and the hunk is left unchanged.
1022 close $fh;
1024 chomp(my $editor = run_cmd_pipe(qw(git var GIT_EDITOR)));
1025 system('sh', '-c', $editor.' "$@"', $editor, $hunkfile);
1027 if ($? != 0) {
1028 return undef;
1031 open $fh, '<', $hunkfile
1032 or die "failed to open hunk edit file for reading: " . $!;
1033 my @newtext = grep { !/^#/ } <$fh>;
1034 close $fh;
1035 unlink $hunkfile;
1037 # Abort if nothing remains
1038 if (!grep { /\S/ } @newtext) {
1039 return undef;
1042 # Reinsert the first hunk header if the user accidentally deleted it
1043 if ($newtext[0] !~ /^@/) {
1044 unshift @newtext, $oldtext->[0];
1046 return \@newtext;
1049 sub diff_applies {
1050 my $fh;
1051 return run_git_apply($patch_mode_flavour{APPLY_CHECK} . ' --recount --check',
1052 map { @{$_->{TEXT}} } @_);
1055 sub _restore_terminal_and_die {
1056 ReadMode 'restore';
1057 print "\n";
1058 exit 1;
1061 sub prompt_single_character {
1062 if ($use_readkey) {
1063 local $SIG{TERM} = \&_restore_terminal_and_die;
1064 local $SIG{INT} = \&_restore_terminal_and_die;
1065 ReadMode 'cbreak';
1066 my $key = ReadKey 0;
1067 ReadMode 'restore';
1068 print "$key" if defined $key;
1069 print "\n";
1070 return $key;
1071 } else {
1072 return <STDIN>;
1076 sub prompt_yesno {
1077 my ($prompt) = @_;
1078 while (1) {
1079 print colored $prompt_color, $prompt;
1080 my $line = prompt_single_character;
1081 return 0 if $line =~ /^n/i;
1082 return 1 if $line =~ /^y/i;
1086 sub edit_hunk_loop {
1087 my ($head, $hunk, $ix) = @_;
1088 my $text = $hunk->[$ix]->{TEXT};
1090 while (1) {
1091 $text = edit_hunk_manually($text);
1092 if (!defined $text) {
1093 return undef;
1095 my $newhunk = {
1096 TEXT => $text,
1097 TYPE => $hunk->[$ix]->{TYPE},
1098 USE => 1,
1099 DIRTY => 1,
1101 if (diff_applies($head,
1102 @{$hunk}[0..$ix-1],
1103 $newhunk,
1104 @{$hunk}[$ix+1..$#{$hunk}])) {
1105 $newhunk->{DISPLAY} = [color_diff(@{$text})];
1106 return $newhunk;
1108 else {
1109 prompt_yesno(
1110 'Your edited hunk does not apply. Edit again '
1111 . '(saying "no" discards!) [y/n]? '
1112 ) or return undef;
1117 sub help_patch_cmd {
1118 my $verb = lc $patch_mode_flavour{VERB};
1119 my $target = $patch_mode_flavour{TARGET};
1120 print colored $help_color, <<EOF ;
1121 y - $verb this hunk$target
1122 n - do not $verb this hunk$target
1123 q - quit; do not $verb this hunk nor any of the remaining ones
1124 a - $verb this hunk and all later hunks in the file
1125 d - do not $verb this hunk nor any of the later hunks in the file
1126 g - select a hunk to go to
1127 / - search for a hunk matching the given regex
1128 j - leave this hunk undecided, see next undecided hunk
1129 J - leave this hunk undecided, see next hunk
1130 k - leave this hunk undecided, see previous undecided hunk
1131 K - leave this hunk undecided, see previous hunk
1132 s - split the current hunk into smaller hunks
1133 e - manually edit the current hunk
1134 ? - print help
1138 sub apply_patch {
1139 my $cmd = shift;
1140 my $ret = run_git_apply $cmd . ' --recount', @_;
1141 if (!$ret) {
1142 print STDERR @_;
1144 return $ret;
1147 sub apply_patch_for_checkout_commit {
1148 my $reverse = shift;
1149 my $applies_index = run_git_apply 'apply '.$reverse.' --cached --recount --check', @_;
1150 my $applies_worktree = run_git_apply 'apply '.$reverse.' --recount --check', @_;
1152 if ($applies_worktree && $applies_index) {
1153 run_git_apply 'apply '.$reverse.' --cached --recount', @_;
1154 run_git_apply 'apply '.$reverse.' --recount', @_;
1155 return 1;
1156 } elsif (!$applies_index) {
1157 print colored $error_color, "The selected hunks do not apply to the index!\n";
1158 if (prompt_yesno "Apply them to the worktree anyway? ") {
1159 return run_git_apply 'apply '.$reverse.' --recount', @_;
1160 } else {
1161 print colored $error_color, "Nothing was applied.\n";
1162 return 0;
1164 } else {
1165 print STDERR @_;
1166 return 0;
1170 sub patch_update_cmd {
1171 my @all_mods = list_modified($patch_mode_flavour{FILTER});
1172 my @mods = grep { !($_->{BINARY}) } @all_mods;
1173 my @them;
1175 if (!@mods) {
1176 if (@all_mods) {
1177 print STDERR "Only binary files changed.\n";
1178 } else {
1179 print STDERR "No changes.\n";
1181 return 0;
1183 if ($patch_mode) {
1184 @them = @mods;
1186 else {
1187 @them = list_and_choose({ PROMPT => 'Patch update',
1188 HEADER => $status_head, },
1189 @mods);
1191 for (@them) {
1192 return 0 if patch_update_file($_->{VALUE});
1196 # Generate a one line summary of a hunk.
1197 sub summarize_hunk {
1198 my $rhunk = shift;
1199 my $summary = $rhunk->{TEXT}[0];
1201 # Keep the line numbers, discard extra context.
1202 $summary =~ s/@@(.*?)@@.*/$1 /s;
1203 $summary .= " " x (20 - length $summary);
1205 # Add some user context.
1206 for my $line (@{$rhunk->{TEXT}}) {
1207 if ($line =~ m/^[+-].*\w/) {
1208 $summary .= $line;
1209 last;
1213 chomp $summary;
1214 return substr($summary, 0, 80) . "\n";
1218 # Print a one-line summary of each hunk in the array ref in
1219 # the first argument, starting wih the index in the 2nd.
1220 sub display_hunks {
1221 my ($hunks, $i) = @_;
1222 my $ctr = 0;
1223 $i ||= 0;
1224 for (; $i < @$hunks && $ctr < 20; $i++, $ctr++) {
1225 my $status = " ";
1226 if (defined $hunks->[$i]{USE}) {
1227 $status = $hunks->[$i]{USE} ? "+" : "-";
1229 printf "%s%2d: %s",
1230 $status,
1231 $i + 1,
1232 summarize_hunk($hunks->[$i]);
1234 return $i;
1237 sub patch_update_file {
1238 my $quit = 0;
1239 my ($ix, $num);
1240 my $path = shift;
1241 my ($head, @hunk) = parse_diff($path);
1242 ($head, my $mode, my $deletion) = parse_diff_header($head);
1243 for (@{$head->{DISPLAY}}) {
1244 print;
1247 if (@{$mode->{TEXT}}) {
1248 unshift @hunk, $mode;
1250 if (@{$deletion->{TEXT}}) {
1251 foreach my $hunk (@hunk) {
1252 push @{$deletion->{TEXT}}, @{$hunk->{TEXT}};
1253 push @{$deletion->{DISPLAY}}, @{$hunk->{DISPLAY}};
1255 @hunk = ($deletion);
1258 $num = scalar @hunk;
1259 $ix = 0;
1261 while (1) {
1262 my ($prev, $next, $other, $undecided, $i);
1263 $other = '';
1265 if ($num <= $ix) {
1266 $ix = 0;
1268 for ($i = 0; $i < $ix; $i++) {
1269 if (!defined $hunk[$i]{USE}) {
1270 $prev = 1;
1271 $other .= ',k';
1272 last;
1275 if ($ix) {
1276 $other .= ',K';
1278 for ($i = $ix + 1; $i < $num; $i++) {
1279 if (!defined $hunk[$i]{USE}) {
1280 $next = 1;
1281 $other .= ',j';
1282 last;
1285 if ($ix < $num - 1) {
1286 $other .= ',J';
1288 if ($num > 1) {
1289 $other .= ',g';
1291 for ($i = 0; $i < $num; $i++) {
1292 if (!defined $hunk[$i]{USE}) {
1293 $undecided = 1;
1294 last;
1297 last if (!$undecided);
1299 if ($hunk[$ix]{TYPE} eq 'hunk' &&
1300 hunk_splittable($hunk[$ix]{TEXT})) {
1301 $other .= ',s';
1303 if ($hunk[$ix]{TYPE} eq 'hunk') {
1304 $other .= ',e';
1306 for (@{$hunk[$ix]{DISPLAY}}) {
1307 print;
1309 print colored $prompt_color, $patch_mode_flavour{VERB},
1310 ($hunk[$ix]{TYPE} eq 'mode' ? ' mode change' :
1311 $hunk[$ix]{TYPE} eq 'deletion' ? ' deletion' :
1312 ' this hunk'),
1313 $patch_mode_flavour{TARGET},
1314 " [y,n,q,a,d,/$other,?]? ";
1315 my $line = prompt_single_character;
1316 if ($line) {
1317 if ($line =~ /^y/i) {
1318 $hunk[$ix]{USE} = 1;
1320 elsif ($line =~ /^n/i) {
1321 $hunk[$ix]{USE} = 0;
1323 elsif ($line =~ /^a/i) {
1324 while ($ix < $num) {
1325 if (!defined $hunk[$ix]{USE}) {
1326 $hunk[$ix]{USE} = 1;
1328 $ix++;
1330 next;
1332 elsif ($other =~ /g/ && $line =~ /^g(.*)/) {
1333 my $response = $1;
1334 my $no = $ix > 10 ? $ix - 10 : 0;
1335 while ($response eq '') {
1336 my $extra = "";
1337 $no = display_hunks(\@hunk, $no);
1338 if ($no < $num) {
1339 $extra = " (<ret> to see more)";
1341 print "go to which hunk$extra? ";
1342 $response = <STDIN>;
1343 if (!defined $response) {
1344 $response = '';
1346 chomp $response;
1348 if ($response !~ /^\s*\d+\s*$/) {
1349 error_msg "Invalid number: '$response'\n";
1350 } elsif (0 < $response && $response <= $num) {
1351 $ix = $response - 1;
1352 } else {
1353 error_msg "Sorry, only $num hunks available.\n";
1355 next;
1357 elsif ($line =~ /^d/i) {
1358 while ($ix < $num) {
1359 if (!defined $hunk[$ix]{USE}) {
1360 $hunk[$ix]{USE} = 0;
1362 $ix++;
1364 next;
1366 elsif ($line =~ /^q/i) {
1367 while ($ix < $num) {
1368 if (!defined $hunk[$ix]{USE}) {
1369 $hunk[$ix]{USE} = 0;
1371 $ix++;
1373 $quit = 1;
1374 next;
1376 elsif ($line =~ m|^/(.*)|) {
1377 my $regex = $1;
1378 if ($1 eq "") {
1379 print colored $prompt_color, "search for regex? ";
1380 $regex = <STDIN>;
1381 if (defined $regex) {
1382 chomp $regex;
1385 my $search_string;
1386 eval {
1387 $search_string = qr{$regex}m;
1389 if ($@) {
1390 my ($err,$exp) = ($@, $1);
1391 $err =~ s/ at .*git-add--interactive line \d+, <STDIN> line \d+.*$//;
1392 error_msg "Malformed search regexp $exp: $err\n";
1393 next;
1395 my $iy = $ix;
1396 while (1) {
1397 my $text = join ("", @{$hunk[$iy]{TEXT}});
1398 last if ($text =~ $search_string);
1399 $iy++;
1400 $iy = 0 if ($iy >= $num);
1401 if ($ix == $iy) {
1402 error_msg "No hunk matches the given pattern\n";
1403 last;
1406 $ix = $iy;
1407 next;
1409 elsif ($line =~ /^K/) {
1410 if ($other =~ /K/) {
1411 $ix--;
1413 else {
1414 error_msg "No previous hunk\n";
1416 next;
1418 elsif ($line =~ /^J/) {
1419 if ($other =~ /J/) {
1420 $ix++;
1422 else {
1423 error_msg "No next hunk\n";
1425 next;
1427 elsif ($line =~ /^k/) {
1428 if ($other =~ /k/) {
1429 while (1) {
1430 $ix--;
1431 last if (!$ix ||
1432 !defined $hunk[$ix]{USE});
1435 else {
1436 error_msg "No previous hunk\n";
1438 next;
1440 elsif ($line =~ /^j/) {
1441 if ($other !~ /j/) {
1442 error_msg "No next hunk\n";
1443 next;
1446 elsif ($other =~ /s/ && $line =~ /^s/) {
1447 my @split = split_hunk($hunk[$ix]{TEXT}, $hunk[$ix]{DISPLAY});
1448 if (1 < @split) {
1449 print colored $header_color, "Split into ",
1450 scalar(@split), " hunks.\n";
1452 splice (@hunk, $ix, 1, @split);
1453 $num = scalar @hunk;
1454 next;
1456 elsif ($other =~ /e/ && $line =~ /^e/) {
1457 my $newhunk = edit_hunk_loop($head, \@hunk, $ix);
1458 if (defined $newhunk) {
1459 splice @hunk, $ix, 1, $newhunk;
1462 else {
1463 help_patch_cmd($other);
1464 next;
1466 # soft increment
1467 while (1) {
1468 $ix++;
1469 last if ($ix >= $num ||
1470 !defined $hunk[$ix]{USE});
1475 @hunk = coalesce_overlapping_hunks(@hunk);
1477 my $n_lofs = 0;
1478 my @result = ();
1479 for (@hunk) {
1480 if ($_->{USE}) {
1481 push @result, @{$_->{TEXT}};
1485 if (@result) {
1486 my $fh;
1487 my @patch = reassemble_patch($head->{TEXT}, @result);
1488 my $apply_routine = $patch_mode_flavour{APPLY};
1489 &$apply_routine(@patch);
1490 refresh();
1493 print "\n";
1494 return $quit;
1497 sub diff_cmd {
1498 my @mods = list_modified('index-only');
1499 @mods = grep { !($_->{BINARY}) } @mods;
1500 return if (!@mods);
1501 my (@them) = list_and_choose({ PROMPT => 'Review diff',
1502 IMMEDIATE => 1,
1503 HEADER => $status_head, },
1504 @mods);
1505 return if (!@them);
1506 my $reference = is_initial_commit() ? get_empty_tree() : 'HEAD';
1507 system(qw(git diff -p --cached), $reference, '--',
1508 map { $_->{VALUE} } @them);
1511 sub quit_cmd {
1512 print "Bye.\n";
1513 exit(0);
1516 sub help_cmd {
1517 print colored $help_color, <<\EOF ;
1518 status - show paths with changes
1519 update - add working tree state to the staged set of changes
1520 revert - revert staged set of changes back to the HEAD version
1521 patch - pick hunks and update selectively
1522 diff - view diff between HEAD and index
1523 add untracked - add contents of untracked files to the staged set of changes
1527 sub process_args {
1528 return unless @ARGV;
1529 my $arg = shift @ARGV;
1530 if ($arg =~ /--patch(?:=(.*))?/) {
1531 if (defined $1) {
1532 if ($1 eq 'reset') {
1533 $patch_mode = 'reset_head';
1534 $patch_mode_revision = 'HEAD';
1535 $arg = shift @ARGV or die "missing --";
1536 if ($arg ne '--') {
1537 $patch_mode_revision = $arg;
1538 $patch_mode = ($arg eq 'HEAD' ?
1539 'reset_head' : 'reset_nothead');
1540 $arg = shift @ARGV or die "missing --";
1542 } elsif ($1 eq 'checkout') {
1543 $arg = shift @ARGV or die "missing --";
1544 if ($arg eq '--') {
1545 $patch_mode = 'checkout_index';
1546 } else {
1547 $patch_mode_revision = $arg;
1548 $patch_mode = ($arg eq 'HEAD' ?
1549 'checkout_head' : 'checkout_nothead');
1550 $arg = shift @ARGV or die "missing --";
1552 } elsif ($1 eq 'stage' or $1 eq 'stash') {
1553 $patch_mode = $1;
1554 $arg = shift @ARGV or die "missing --";
1555 } else {
1556 die "unknown --patch mode: $1";
1558 } else {
1559 $patch_mode = 'stage';
1560 $arg = shift @ARGV or die "missing --";
1562 die "invalid argument $arg, expecting --"
1563 unless $arg eq "--";
1564 %patch_mode_flavour = %{$patch_modes{$patch_mode}};
1566 elsif ($arg ne "--") {
1567 die "invalid argument $arg, expecting --";
1571 sub main_loop {
1572 my @cmd = ([ 'status', \&status_cmd, ],
1573 [ 'update', \&update_cmd, ],
1574 [ 'revert', \&revert_cmd, ],
1575 [ 'add untracked', \&add_untracked_cmd, ],
1576 [ 'patch', \&patch_update_cmd, ],
1577 [ 'diff', \&diff_cmd, ],
1578 [ 'quit', \&quit_cmd, ],
1579 [ 'help', \&help_cmd, ],
1581 while (1) {
1582 my ($it) = list_and_choose({ PROMPT => 'What now',
1583 SINGLETON => 1,
1584 LIST_FLAT => 4,
1585 HEADER => '*** Commands ***',
1586 ON_EOF => \&quit_cmd,
1587 IMMEDIATE => 1 }, @cmd);
1588 if ($it) {
1589 eval {
1590 $it->[1]->();
1592 if ($@) {
1593 print "$@";
1599 process_args();
1600 refresh();
1601 if ($patch_mode) {
1602 patch_update_cmd();
1604 else {
1605 status_cmd();
1606 main_loop();