Merge branch 'jk/diff-convfilter-test-fix'
[git] / git-gui / lib / mergetool.tcl
1 # git-gui merge conflict resolution
2 # parts based on git-mergetool (c) 2006 Theodore Y. Ts'o
3
4 proc merge_resolve_one {stage} {
5         global current_diff_path
6
7         switch -- $stage {
8                 1 { set targetquestion [mc "Force resolution to the base version?"] }
9                 2 { set targetquestion [mc "Force resolution to this branch?"] }
10                 3 { set targetquestion [mc "Force resolution to the other branch?"] }
11         }
12
13         set op_question [strcat $targetquestion "\n" \
14 [mc "Note that the diff shows only conflicting changes.
15
16 %s will be overwritten.
17
18 This operation can be undone only by restarting the merge." \
19                 [short_path $current_diff_path]]]
20
21         if {[ask_popup $op_question] eq {yes}} {
22                 merge_load_stages $current_diff_path [list merge_force_stage $stage]
23         }
24 }
25
26 proc merge_stage_workdir {path {lno {}}} {
27         global current_diff_path diff_active
28         global current_diff_side ui_workdir
29
30         if {$diff_active} return
31
32         if {$path ne $current_diff_path || $ui_workdir ne $current_diff_side} {
33                 show_diff $path $ui_workdir $lno {} [list do_merge_stage_workdir $path]
34         } else {
35                 do_merge_stage_workdir $path
36         }
37 }
38
39 proc do_merge_stage_workdir {path} {
40         global current_diff_path is_conflict_diff
41
42         if {$path ne $current_diff_path} return;
43
44         if {$is_conflict_diff} {
45                 if {[ask_popup [mc "File %s seems to have unresolved conflicts, still stage?" \
46                                 [short_path $path]]] ne {yes}} {
47                         return
48                 }
49         }
50
51         merge_add_resolution $path
52 }
53
54 proc merge_add_resolution {path} {
55         global current_diff_path ui_workdir
56
57         set after [next_diff_after_action $ui_workdir $path {} {^_?U}]
58
59         update_index \
60                 [mc "Adding resolution for %s" [short_path $path]] \
61                 [list $path] \
62                 [concat $after [list ui_ready]]
63 }
64
65 proc merge_force_stage {stage} {
66         global current_diff_path merge_stages
67
68         if {$merge_stages($stage) ne {}} {
69                 git checkout-index -f --stage=$stage -- $current_diff_path
70         } else {
71                 file delete -- $current_diff_path
72         }
73
74         merge_add_resolution $current_diff_path
75 }
76
77 proc merge_load_stages {path cont} {
78         global merge_stages_fd merge_stages merge_stages_buf
79
80         if {[info exists merge_stages_fd]} {
81                 catch { kill_file_process $merge_stages_fd }
82                 catch { close $merge_stages_fd }
83         }
84
85         set merge_stages(0) {}
86         set merge_stages(1) {}
87         set merge_stages(2) {}
88         set merge_stages(3) {}
89         set merge_stages_buf {}
90
91         set merge_stages_fd [eval git_read ls-files -u -z -- $path]
92
93         fconfigure $merge_stages_fd -blocking 0 -translation binary -encoding binary
94         fileevent $merge_stages_fd readable [list read_merge_stages $merge_stages_fd $cont]
95 }
96
97 proc read_merge_stages {fd cont} {
98         global merge_stages_buf merge_stages_fd merge_stages
99
100         append merge_stages_buf [read $fd]
101         set pck [split $merge_stages_buf "\0"]
102         set merge_stages_buf [lindex $pck end]
103
104         if {[eof $fd] && $merge_stages_buf ne {}} {
105                 lappend pck {}
106                 set merge_stages_buf {}
107         }
108
109         foreach p [lrange $pck 0 end-1] {
110                 set fcols [split $p "\t"]
111                 set cols  [split [lindex $fcols 0] " "]
112                 set stage [lindex $cols 2]
113                 
114                 set merge_stages($stage) [lrange $cols 0 1]
115         }
116
117         if {[eof $fd]} {
118                 close $fd
119                 unset merge_stages_fd
120                 eval $cont
121         }
122 }
123
124 proc merge_resolve_tool {} {
125         global current_diff_path
126
127         merge_load_stages $current_diff_path [list merge_resolve_tool2]
128 }
129
130 proc merge_resolve_tool2 {} {
131         global current_diff_path merge_stages
132
133         # Validate the stages
134         if {$merge_stages(2) eq {} ||
135             [lindex $merge_stages(2) 0] eq {120000} ||
136             [lindex $merge_stages(2) 0] eq {160000} ||
137             $merge_stages(3) eq {} ||
138             [lindex $merge_stages(3) 0] eq {120000} ||
139             [lindex $merge_stages(3) 0] eq {160000}
140         } {
141                 error_popup [mc "Cannot resolve deletion or link conflicts using a tool"]
142                 return
143         }
144
145         if {![file exists $current_diff_path]} {
146                 error_popup [mc "Conflict file does not exist"]
147                 return
148         }
149
150         # Determine the tool to use
151         set tool [get_config merge.tool]
152         if {$tool eq {}} { set tool meld }
153
154         set merge_tool_path [get_config "mergetool.$tool.path"]
155         if {$merge_tool_path eq {}} {
156                 switch -- $tool {
157                 emerge { set merge_tool_path "emacs" }
158                 araxis { set merge_tool_path "compare" }
159                 default { set merge_tool_path $tool }
160                 }
161         }
162
163         # Make file names
164         set filebase [file rootname $current_diff_path]
165         set fileext  [file extension $current_diff_path]
166         set basename [lindex [file split $current_diff_path] end]
167
168         set MERGED   $current_diff_path
169         set BASE     "./$MERGED.BASE$fileext"
170         set LOCAL    "./$MERGED.LOCAL$fileext"
171         set REMOTE   "./$MERGED.REMOTE$fileext"
172         set BACKUP   "./$MERGED.BACKUP$fileext"
173
174         set base_stage $merge_stages(1)
175
176         # Build the command line
177         switch -- $tool {
178         kdiff3 {
179                 if {$base_stage ne {}} {
180                         set cmdline [list "$merge_tool_path" --auto --L1 "$MERGED (Base)" \
181                                 --L2 "$MERGED (Local)" --L3 "$MERGED (Remote)" -o "$MERGED" "$BASE" "$LOCAL" "$REMOTE"]
182                 } else {
183                         set cmdline [list "$merge_tool_path" --auto --L1 "$MERGED (Local)" \
184                                 --L2 "$MERGED (Remote)" -o "$MERGED" "$LOCAL" "$REMOTE"]
185                 }
186         }
187         tkdiff {
188                 if {$base_stage ne {}} {
189                         set cmdline [list "$merge_tool_path" -a "$BASE" -o "$MERGED" "$LOCAL" "$REMOTE"]
190                 } else {
191                         set cmdline [list "$merge_tool_path" -o "$MERGED" "$LOCAL" "$REMOTE"]
192                 }
193         }
194         meld {
195                 set cmdline [list "$merge_tool_path" "$LOCAL" "$MERGED" "$REMOTE"]
196         }
197         gvimdiff {
198                 set cmdline [list "$merge_tool_path" -f "$LOCAL" "$MERGED" "$REMOTE"]
199         }
200         xxdiff {
201                 if {$base_stage ne {}} {
202                         set cmdline [list "$merge_tool_path" -X --show-merged-pane \
203                                             -R {Accel.SaveAsMerged: "Ctrl-S"} \
204                                             -R {Accel.Search: "Ctrl+F"} \
205                                             -R {Accel.SearchForward: "Ctrl-G"} \
206                                             --merged-file "$MERGED" "$LOCAL" "$BASE" "$REMOTE"]
207                 } else {
208                         set cmdline [list "$merge_tool_path" -X --show-merged-pane \
209                                             -R {Accel.SaveAsMerged: "Ctrl-S"} \
210                                             -R {Accel.Search: "Ctrl+F"} \
211                                             -R {Accel.SearchForward: "Ctrl-G"} \
212                                             --merged-file "$MERGED" "$LOCAL" "$REMOTE"]
213                 }
214         }
215         opendiff {
216                 if {$base_stage ne {}} {
217                         set cmdline [list "$merge_tool_path" "$LOCAL" "$REMOTE" -ancestor "$BASE" -merge "$MERGED"]
218                 } else {
219                         set cmdline [list "$merge_tool_path" "$LOCAL" "$REMOTE" -merge "$MERGED"]
220                 }
221         }
222         ecmerge {
223                 if {$base_stage ne {}} {
224                         set cmdline [list "$merge_tool_path" "$BASE" "$LOCAL" "$REMOTE" --default --mode=merge3 --to="$MERGED"]
225                 } else {
226                         set cmdline [list "$merge_tool_path" "$LOCAL" "$REMOTE" --default --mode=merge2 --to="$MERGED"]
227                 }
228         }
229         emerge {
230                 if {$base_stage ne {}} {
231                         set cmdline [list "$merge_tool_path" -f emerge-files-with-ancestor-command \
232                                         "$LOCAL" "$REMOTE" "$BASE" "$basename"]
233                 } else {
234                         set cmdline [list "$merge_tool_path" -f emerge-files-command \
235                                         "$LOCAL" "$REMOTE" "$basename"]
236                 }
237         }
238         winmerge {
239                 if {$base_stage ne {}} {
240                         # This tool does not support 3-way merges.
241                         # Use the 'conflict file' resolution feature instead.
242                         set cmdline [list "$merge_tool_path" -e -ub "$MERGED"]
243                 } else {
244                         set cmdline [list "$merge_tool_path" -e -ub -wl \
245                                 -dl "Theirs File" -dr "Mine File" "$REMOTE" "$LOCAL" "$MERGED"]
246                 }
247         }
248         araxis {
249                 if {$base_stage ne {}} {
250                         set cmdline [list "$merge_tool_path" -wait -merge -3 -a1 \
251                                 -title1:"'$MERGED (Base)'" -title2:"'$MERGED (Local)'" \
252                                 -title3:"'$MERGED (Remote)'" \
253                                 "$BASE" "$LOCAL" "$REMOTE" "$MERGED"]
254                 } else {
255                         set cmdline [list "$merge_tool_path" -wait -2 \
256                                  -title1:"'$MERGED (Local)'" -title2:"'$MERGED (Remote)'" \
257                                  "$LOCAL" "$REMOTE" "$MERGED"]
258                 }
259         }
260         p4merge {
261                 set cmdline [list "$merge_tool_path" "$BASE" "$REMOTE" "$LOCAL" "$MERGED"]
262         }
263         vimdiff {
264                 error_popup [mc "Not a GUI merge tool: '%s'" $tool]
265                 return
266         }
267         default {
268                 error_popup [mc "Unsupported merge tool '%s'" $tool]
269                 return
270         }
271         }
272
273         merge_tool_start $cmdline $MERGED $BACKUP [list $BASE $LOCAL $REMOTE]
274 }
275
276 proc delete_temp_files {files} {
277         foreach fname $files {
278                 file delete $fname
279         }
280 }
281
282 proc merge_tool_get_stages {target stages} {
283         global merge_stages
284
285         set i 1
286         foreach fname $stages {
287                 if {$merge_stages($i) eq {}} {
288                         file delete $fname
289                         catch { close [open $fname w] }
290                 } else {
291                         # A hack to support autocrlf properly
292                         git checkout-index -f --stage=$i -- $target
293                         file rename -force -- $target $fname
294                 }
295                 incr i
296         }
297 }
298
299 proc merge_tool_start {cmdline target backup stages} {
300         global merge_stages mtool_target mtool_tmpfiles mtool_fd mtool_mtime
301
302         if {[info exists mtool_fd]} {
303                 if {[ask_popup [mc "Merge tool is already running, terminate it?"]] eq {yes}} {
304                         catch { kill_file_process $mtool_fd }
305                         catch { close $mtool_fd }
306                         unset mtool_fd
307
308                         set old_backup [lindex $mtool_tmpfiles end]
309                         file rename -force -- $old_backup $mtool_target
310                         delete_temp_files $mtool_tmpfiles
311                 } else {
312                         return
313                 }
314         }
315
316         # Save the original file
317         file rename -force -- $target $backup
318
319         # Get the blobs; it destroys $target
320         if {[catch {merge_tool_get_stages $target $stages} err]} {
321                 file rename -force -- $backup $target
322                 delete_temp_files $stages
323                 error_popup [mc "Error retrieving versions:\n%s" $err]
324                 return
325         }
326
327         # Restore the conflict file
328         file copy -force -- $backup $target
329
330         # Initialize global state
331         set mtool_target $target
332         set mtool_mtime [file mtime $target]
333         set mtool_tmpfiles $stages
334
335         lappend mtool_tmpfiles $backup
336
337         # Force redirection to avoid interpreting output on stderr
338         # as an error, and launch the tool
339         lappend cmdline {2>@1}
340
341         if {[catch { set mtool_fd [_open_stdout_stderr $cmdline] } err]} {
342                 delete_temp_files $mtool_tmpfiles
343                 error_popup [mc "Could not start the merge tool:\n\n%s" $err]
344                 return
345         }
346
347         ui_status [mc "Running merge tool..."]
348
349         fconfigure $mtool_fd -blocking 0 -translation binary -encoding binary
350         fileevent $mtool_fd readable [list read_mtool_output $mtool_fd]
351 }
352
353 proc read_mtool_output {fd} {
354         global mtool_fd mtool_tmpfiles
355
356         read $fd
357         if {[eof $fd]} {
358                 unset mtool_fd
359
360                 fconfigure $fd -blocking 1
361                 merge_tool_finish $fd
362         }
363 }
364
365 proc merge_tool_finish {fd} {
366         global mtool_tmpfiles mtool_target mtool_mtime
367
368         set backup [lindex $mtool_tmpfiles end]
369         set failed 0
370
371         # Check the return code
372         if {[catch {close $fd} err]} {
373                 set failed 1
374                 if {$err ne {child process exited abnormally}} {
375                         error_popup [strcat [mc "Merge tool failed."] "\n\n$err"]
376                 }
377         }
378
379         # Finish
380         if {$failed} {
381                 file rename -force -- $backup $mtool_target
382                 delete_temp_files $mtool_tmpfiles
383                 ui_status [mc "Merge tool failed."]
384         } else {
385                 if {[is_config_true merge.keepbackup]} {
386                         file rename -force -- $backup "$mtool_target.orig"
387                 }
388
389                 delete_temp_files $mtool_tmpfiles
390
391                 reshow_diff
392         }
393 }