Move version control related files to the "vc" subdirectory.
[bpt/emacs.git] / lisp / vc / emerge.el
CommitLineData
737e3892 1;;; emerge.el --- merge diffs under Emacs control
151e4b9c 2
737e3892
RS
3;;; The author has placed this file in the public domain.
4
e8af40ee
PJ
5;; This file is part of GNU Emacs.
6
c0932fbc 7;; Author: Dale R. Worley <worley@world.std.com>
737e3892 8;; Keywords: unix, tools
151e4b9c
RS
9
10;; This software was created by Dale R. Worley and is
11;; distributed free of charge. It is placed in the public domain and
12;; permission is granted to anyone to use, duplicate, modify and redistribute
13;; it provided that this notice is attached.
14
15;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
16;; with respect to this software. The entire risk as to the quality and
17;; performance of this software is with the user. IN NO EVENT WILL DALE
18;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
19;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
20;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
21;; DAMAGES.
22
e8af40ee
PJ
23;;; Commentary:
24
737e3892 25;;; Code:
3b4a6e27 26
3945a3a3
JB
27;; There aren't really global variables, just dynamic bindings
28(defvar A-begin)
29(defvar A-end)
30(defvar B-begin)
31(defvar B-end)
32(defvar diff)
33(defvar diff-vector)
34(defvar merge-begin)
35(defvar merge-end)
36(defvar template)
37(defvar valid-diff)
bbf40036 38
3b4a6e27
JB
39;;; Macros
40
41(defmacro emerge-eval-in-buffer (buffer &rest forms)
42 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
737e3892 43Differs from `save-excursion' in that it doesn't save the point and mark."
8a946354 44 `(let ((StartBuffer (current-buffer)))
3b4a6e27 45 (unwind-protect
8a946354
SS
46 (progn
47 (set-buffer ,buffer)
48 ,@forms)
49 (set-buffer StartBuffer))))
3b4a6e27 50
71296446
JB
51(defmacro emerge-defvar-local (var value doc)
52 "Defines SYMBOL as an advertised variable.
737e3892
RS
53Performs a defvar, then executes `make-variable-buffer-local' on
54the variable. Also sets the `preserved' property, so that
71296446 55`kill-all-local-variables' (called by major-mode setting commands)
737e3892 56won't destroy Emerge control variables."
8a946354
SS
57 `(progn
58 (defvar ,var ,value ,doc)
59 (make-variable-buffer-local ',var)
60 (put ',var 'preserved t)))
3b4a6e27
JB
61
62;; Add entries to minor-mode-alist so that emerge modes show correctly
ff5f6ddd
RS
63(defvar emerge-minor-modes-list
64 '((emerge-mode " Emerge")
65 (emerge-fast-mode " F")
66 (emerge-edit-mode " E")
67 (emerge-auto-advance " A")
68 (emerge-skip-prefers " S")))
3b4a6e27
JB
69(if (not (assq 'emerge-mode minor-mode-alist))
70 (setq minor-mode-alist (append emerge-minor-modes-list
71 minor-mode-alist)))
72
73;; We need to define this function so describe-mode can describe Emerge mode.
74(defun emerge-mode ()
737e3892
RS
75 "Emerge mode is used by the Emerge file-merging package.
76It is entered only through one of the functions:
77 `emerge-files'
78 `emerge-files-with-ancestor'
79 `emerge-buffers'
80 `emerge-buffers-with-ancestor'
81 `emerge-files-command'
82 `emerge-files-with-ancestor-command'
83 `emerge-files-remote'
84 `emerge-files-with-ancestor-remote'
3b4a6e27
JB
85
86Commands:
87\\{emerge-basic-keymap}
737e3892
RS
88Commands must be prefixed by \\<emerge-fast-keymap>\\[emerge-basic-keymap] in `edit' mode,
89but can be invoked directly in `fast' mode.")
3b4a6e27 90
623a8830 91(define-obsolete-variable-alias 'emerge-version 'emacs-version "23.2")
3b4a6e27
JB
92
93(defun emerge-version ()
737e3892
RS
94 "Return string describing the version of Emerge.
95When called interactively, displays the version."
3b4a6e27 96 (interactive)
32226619 97 (if (called-interactively-p 'interactive)
623a8830
GM
98 (message "Emerge version %s" emacs-version)
99 emacs-version))
100
101(make-obsolete 'emerge-version 'emacs-version "23.2")
3b4a6e27
JB
102
103;;; Emerge configuration variables
104
33933d45
AS
105(defgroup emerge nil
106 "Merge diffs under Emacs control."
107 :group 'tools)
108
3b4a6e27
JB
109;; Commands that produce difference files
110;; All that can be configured is the name of the programs to execute
111;; (emerge-diff-program and emerge-diff3-program) and the options
112;; to be provided (emerge-diff-options). The order in which the file names
113;; are given is fixed.
114;; The file names are always expanded (see expand-file-name) before being
71296446 115;; passed to diff, thus they need not be invoked under a shell that
737e3892 116;; understands `~'.
3b4a6e27
JB
117;; The code which processes the diff/diff3 output depends on all the
118;; finicky details of their output, including the somewhat strange
119;; way they number lines of a file.
33933d45 120(defcustom emerge-diff-program "diff"
9201cc28 121 "Name of the program which compares two files."
33933d45
AS
122 :type 'string
123 :group 'emerge)
124(defcustom emerge-diff3-program "diff3"
9201cc28 125 "Name of the program which compares three files.
33933d45
AS
126Its arguments are the ancestor file and the two variant files."
127 :type 'string
128 :group 'emerge)
129(defcustom emerge-diff-options ""
9201cc28 130 "Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
33933d45
AS
131 :type 'string
132 :group 'emerge)
133(defcustom emerge-match-diff-line
134 (let ((x "\\([0-9]+\\)\\(\\|,\\([0-9]+\\)\\)"))
135 (concat "^" x "\\([acd]\\)" x "$"))
9201cc28 136 "Pattern to match lines produced by diff that describe differences.
33933d45
AS
137This is as opposed to lines from the source files."
138 :type 'regexp
139 :group 'emerge)
140(defcustom emerge-diff-ok-lines-regexp
3b4a6e27 141 "^\\([0-9,]+[acd][0-9,]+$\\|[<>] \\|---\\)"
9201cc28 142 "Regexp that matches normal output lines from `emerge-diff-program'.
33933d45
AS
143Lines that do not match are assumed to be error messages."
144 :type 'regexp
145 :group 'emerge)
146(defcustom emerge-diff3-ok-lines-regexp
3b4a6e27 147 "^\\([1-3]:\\|====\\| \\)"
9201cc28 148 "Regexp that matches normal output lines from `emerge-diff3-program'.
33933d45
AS
149Lines that do not match are assumed to be error messages."
150 :type 'regexp
151 :group 'emerge)
152
153(defcustom emerge-rcs-ci-program "ci"
9201cc28 154 "Name of the program that checks in RCS revisions."
33933d45
AS
155 :type 'string
156 :group 'emerge)
157(defcustom emerge-rcs-co-program "co"
9201cc28 158 "Name of the program that checks out RCS revisions."
33933d45
AS
159 :type 'string
160 :group 'emerge)
161
162(defcustom emerge-process-local-variables nil
9201cc28 163 "Non-nil if Emerge should process local-variables lists in merge buffers.
737e3892 164\(You can explicitly request processing the local-variables
33933d45
AS
165by executing `(hack-local-variables)'.)"
166 :type 'boolean
167 :group 'emerge)
168(defcustom emerge-execute-line-deletions nil
9201cc28 169 "If non-nil: `emerge-execute-line' makes no output if an input was deleted.
737e3892
RS
170It concludes that an input version has been deleted when an ancestor entry
171is present, only one A or B entry is present, and an output entry is present.
151e4b9c 172If nil: In such circumstances, the A or B file that is present will be
33933d45
AS
173copied to the designated output file."
174 :type 'boolean
175 :group 'emerge)
151e4b9c 176
33933d45 177(defcustom emerge-before-flag "vvvvvvvvvvvvvvvvvvvv\n"
9201cc28 178 "Flag placed above the highlighted block of code. Must end with newline.
ff5f6ddd 179Must be set before Emerge is loaded, or emerge-new-flags must be run
33933d45
AS
180after setting."
181 :type 'string
182 :group 'emerge)
183(defcustom emerge-after-flag "^^^^^^^^^^^^^^^^^^^^\n"
9201cc28 184 "Flag placed below the highlighted block of code. Must end with newline.
ff5f6ddd 185Must be set before Emerge is loaded, or emerge-new-flags must be run
33933d45
AS
186after setting."
187 :type 'string
188 :group 'emerge)
ff5f6ddd 189
151e4b9c
RS
190;; Hook variables
191
33933d45 192(defcustom emerge-startup-hook nil
9201cc28 193 "Hook to run in the merge buffer after the merge has been set up."
33933d45
AS
194 :type 'hook
195 :group 'emerge)
196(defcustom emerge-select-hook nil
9201cc28 197 "Hook to run after a difference has been selected.
33933d45
AS
198The variable `n' holds the (internal) number of the difference."
199 :type 'hook
200 :group 'emerge)
201(defcustom emerge-unselect-hook nil
9201cc28 202 "Hook to run after a difference has been unselected.
33933d45
AS
203The variable `n' holds the (internal) number of the difference."
204 :type 'hook
205 :group 'emerge)
151e4b9c
RS
206
207;; Variables to control the default directories of the arguments to
208;; Emerge commands.
209
33933d45 210(defcustom emerge-default-last-directories nil
9201cc28 211 "If nil, default dir for filenames in emerge is `default-directory'.
151e4b9c 212If non-nil, filenames complete in the directory of the last argument of the
33933d45
AS
213same type to an `emerge-files...' command."
214 :type 'boolean
215 :group 'emerge)
151e4b9c
RS
216
217(defvar emerge-last-dir-A nil
737e3892 218 "Last directory for the first file of an `emerge-files...' command.")
151e4b9c 219(defvar emerge-last-dir-B nil
737e3892 220 "Last directory for the second file of an `emerge-files...' command.")
151e4b9c 221(defvar emerge-last-dir-ancestor nil
737e3892 222 "Last directory for the ancestor file of an `emerge-files...' command.")
151e4b9c 223(defvar emerge-last-dir-output nil
737e3892 224 "Last directory for the output file of an `emerge-files...' command.")
151e4b9c 225(defvar emerge-last-revision-A nil
737e3892 226 "Last RCS revision used for first file of an `emerge-revisions...' command.")
151e4b9c 227(defvar emerge-last-revision-B nil
737e3892 228 "Last RCS revision used for second file of an `emerge-revisions...' command.")
151e4b9c 229(defvar emerge-last-revision-ancestor nil
737e3892 230 "Last RCS revision used for ancestor file of an `emerge-revisions...' command.")
151e4b9c 231
ff5f6ddd
RS
232(defvar emerge-before-flag-length)
233(defvar emerge-before-flag-lines)
234(defvar emerge-before-flag-match)
235(defvar emerge-after-flag-length)
236(defvar emerge-after-flag-lines)
237(defvar emerge-after-flag-match)
238(defvar emerge-diff-buffer)
239(defvar emerge-diff-error-buffer)
240(defvar emerge-prefix-argument)
241(defvar emerge-file-out)
242(defvar emerge-exit-func)
243(defvar emerge-globalized-difference-list)
244(defvar emerge-globalized-number-of-differences)
245
3b4a6e27
JB
246;; The flags used to mark differences in the buffers.
247
248;; These function definitions need to be up here, because they are used
249;; during loading.
250(defun emerge-new-flags ()
737e3892
RS
251 "Function to be called after `emerge-{before,after}-flag'.
252This is called after these functions are changed to compute values that
253depend on the flags."
3b4a6e27
JB
254 (setq emerge-before-flag-length (length emerge-before-flag))
255 (setq emerge-before-flag-lines
737e3892 256 (emerge-count-matches-string emerge-before-flag "\n"))
3b4a6e27
JB
257 (setq emerge-before-flag-match (regexp-quote emerge-before-flag))
258 (setq emerge-after-flag-length (length emerge-after-flag))
259 (setq emerge-after-flag-lines
737e3892 260 (emerge-count-matches-string emerge-after-flag "\n"))
3b4a6e27 261 (setq emerge-after-flag-match (regexp-quote emerge-after-flag)))
737e3892
RS
262
263(defun emerge-count-matches-string (string regexp)
3b4a6e27
JB
264 "Return the number of matches in STRING for REGEXP."
265 (let ((i 0)
266 (count 0))
267 (while (string-match regexp string i)
268 (setq count (1+ count))
269 (setq i (match-end 0)))
270 count))
271
3b4a6e27
JB
272;; Calculate dependent variables
273(emerge-new-flags)
274
33933d45 275(defcustom emerge-min-visible-lines 3
9201cc28 276 "Number of lines that we want to show above and below the flags when we are
33933d45
AS
277displaying a difference."
278 :type 'integer
279 :group 'emerge)
3b4a6e27 280
33933d45 281(defcustom emerge-temp-file-prefix
e4a6b88e 282 (expand-file-name "emerge" temporary-file-directory)
9201cc28 283 "Prefix to put on Emerge temporary file names.
e4a6b88e 284Do not start with `~/' or `~USERNAME/'."
33933d45
AS
285 :type 'string
286 :group 'emerge)
3b4a6e27 287
33933d45 288(defcustom emerge-temp-file-mode 384 ; u=rw only
9201cc28 289 "Mode for Emerge temporary files."
33933d45
AS
290 :type 'integer
291 :group 'emerge)
3b4a6e27 292
33933d45 293(defcustom emerge-combine-versions-template
504621b9 294 "#ifdef NEW\n%b#else /* not NEW */\n%a#endif /* not NEW */\n"
9201cc28 295 "Template for `emerge-combine-versions' to combine the two versions.
3b4a6e27
JB
296The template is inserted as a string, with the following interpolations:
297 %a the A version of the difference
298 %b the B version of the difference
737e3892 299 %% the character `%'
3b4a6e27
JB
300Don't forget to end the template with a newline.
301Note that this variable can be made local to a particular merge buffer by
33933d45
AS
302giving a prefix argument to `emerge-set-combine-versions-template'."
303 :type 'string
304 :group 'emerge)
3b4a6e27
JB
305
306;; Build keymaps
307
308(defvar emerge-basic-keymap nil
309 "Keymap of Emerge commands.
737e3892
RS
310Directly available in `fast' mode;
311must be prefixed by \\<emerge-fast-keymap>\\[emerge-basic-keymap] in `edit' mode.")
3b4a6e27
JB
312
313(defvar emerge-fast-keymap nil
737e3892 314 "Local keymap used in Emerge `fast' mode.
3b4a6e27
JB
315Makes Emerge commands directly available.")
316
ff5f6ddd
RS
317(defvar emerge-options-menu
318 (make-sparse-keymap "Options"))
319
320(defvar emerge-merge-menu
321 (make-sparse-keymap "Merge"))
322
323(defvar emerge-move-menu
324 (make-sparse-keymap "Move"))
325
33933d45 326(defcustom emerge-command-prefix "\C-c\C-c"
9201cc28 327 "Command prefix for Emerge commands in `edit' mode.
33933d45
AS
328Must be set before Emerge is loaded."
329 :type 'string
330 :group 'emerge)
3b4a6e27
JB
331
332;; This function sets up the fixed keymaps. It is executed when the first
333;; Emerge is done to allow the user maximum time to set up the global keymap.
334(defun emerge-setup-fixed-keymaps ()
335 ;; Set up the basic keymap
336 (setq emerge-basic-keymap (make-keymap))
337 (suppress-keymap emerge-basic-keymap) ; this sets 0..9 to digit-argument and
338 ; - to negative-argument
339 (define-key emerge-basic-keymap "p" 'emerge-previous-difference)
340 (define-key emerge-basic-keymap "n" 'emerge-next-difference)
341 (define-key emerge-basic-keymap "a" 'emerge-select-A)
342 (define-key emerge-basic-keymap "b" 'emerge-select-B)
343 (define-key emerge-basic-keymap "j" 'emerge-jump-to-difference)
661d3230 344 (define-key emerge-basic-keymap "." 'emerge-find-difference)
3b4a6e27 345 (define-key emerge-basic-keymap "q" 'emerge-quit)
adca3f58 346 (define-key emerge-basic-keymap "\C-]" 'emerge-abort)
3b4a6e27
JB
347 (define-key emerge-basic-keymap "f" 'emerge-fast-mode)
348 (define-key emerge-basic-keymap "e" 'emerge-edit-mode)
349 (define-key emerge-basic-keymap "s" nil)
350 (define-key emerge-basic-keymap "sa" 'emerge-auto-advance)
351 (define-key emerge-basic-keymap "ss" 'emerge-skip-prefers)
352 (define-key emerge-basic-keymap "l" 'emerge-recenter)
353 (define-key emerge-basic-keymap "d" nil)
354 (define-key emerge-basic-keymap "da" 'emerge-default-A)
355 (define-key emerge-basic-keymap "db" 'emerge-default-B)
356 (define-key emerge-basic-keymap "c" nil)
357 (define-key emerge-basic-keymap "ca" 'emerge-copy-as-kill-A)
358 (define-key emerge-basic-keymap "cb" 'emerge-copy-as-kill-B)
359 (define-key emerge-basic-keymap "i" nil)
360 (define-key emerge-basic-keymap "ia" 'emerge-insert-A)
361 (define-key emerge-basic-keymap "ib" 'emerge-insert-B)
362 (define-key emerge-basic-keymap "m" 'emerge-mark-difference)
363 (define-key emerge-basic-keymap "v" 'emerge-scroll-up)
364 (define-key emerge-basic-keymap "^" 'emerge-scroll-down)
365 (define-key emerge-basic-keymap "<" 'emerge-scroll-left)
366 (define-key emerge-basic-keymap ">" 'emerge-scroll-right)
367 (define-key emerge-basic-keymap "|" 'emerge-scroll-reset)
368 (define-key emerge-basic-keymap "x" nil)
369 (define-key emerge-basic-keymap "x1" 'emerge-one-line-window)
3b4a6e27
JB
370 (define-key emerge-basic-keymap "xc" 'emerge-combine-versions)
371 (define-key emerge-basic-keymap "xC" 'emerge-combine-versions-register)
3b4a6e27
JB
372 (define-key emerge-basic-keymap "xf" 'emerge-file-names)
373 (define-key emerge-basic-keymap "xj" 'emerge-join-differences)
374 (define-key emerge-basic-keymap "xl" 'emerge-line-numbers)
375 (define-key emerge-basic-keymap "xm" 'emerge-set-merge-mode)
376 (define-key emerge-basic-keymap "xs" 'emerge-split-difference)
377 (define-key emerge-basic-keymap "xt" 'emerge-trim-difference)
378 (define-key emerge-basic-keymap "xx" 'emerge-set-combine-versions-template)
379 ;; Allow emerge-basic-keymap to be referenced indirectly
380 (fset 'emerge-basic-keymap emerge-basic-keymap)
381 ;; Set up the fast mode keymap
382 (setq emerge-fast-keymap (copy-keymap emerge-basic-keymap))
383 ;; Allow prefixed commands to work in fast mode
384 (define-key emerge-fast-keymap emerge-command-prefix 'emerge-basic-keymap)
385 ;; Allow emerge-fast-keymap to be referenced indirectly
386 (fset 'emerge-fast-keymap emerge-fast-keymap)
387 ;; Suppress write-file and save-buffer
96473b34
AS
388 (define-key emerge-fast-keymap [remap write-file] 'emerge-query-write-file)
389 (define-key emerge-fast-keymap [remap save-buffer] 'emerge-query-save-buffer)
ff5f6ddd
RS
390
391 (define-key emerge-basic-keymap [menu-bar] (make-sparse-keymap))
392
623a8830
GM
393 (define-key emerge-fast-keymap [menu-bar emerge-options]
394 (cons "Merge-Options" emerge-options-menu))
ff5f6ddd
RS
395 (define-key emerge-fast-keymap [menu-bar merge]
396 (cons "Merge" emerge-merge-menu))
397 (define-key emerge-fast-keymap [menu-bar move]
398 (cons "Move" emerge-move-menu))
399
400 (define-key emerge-move-menu [emerge-scroll-reset]
401 '("Scroll Reset" . emerge-scroll-reset))
402 (define-key emerge-move-menu [emerge-scroll-right]
403 '("Scroll Right" . emerge-scroll-right))
404 (define-key emerge-move-menu [emerge-scroll-left]
405 '("Scroll Left" . emerge-scroll-left))
406 (define-key emerge-move-menu [emerge-scroll-down]
407 '("Scroll Down" . emerge-scroll-down))
408 (define-key emerge-move-menu [emerge-scroll-up]
409 '("Scroll Up" . emerge-scroll-up))
410 (define-key emerge-move-menu [emerge-recenter]
411 '("Recenter" . emerge-recenter))
412 (define-key emerge-move-menu [emerge-mark-difference]
413 '("Mark Difference" . emerge-mark-difference))
414 (define-key emerge-move-menu [emerge-jump-to-difference]
415 '("Jump To Difference" . emerge-jump-to-difference))
416 (define-key emerge-move-menu [emerge-find-difference]
417 '("Find Difference" . emerge-find-difference))
418 (define-key emerge-move-menu [emerge-previous-difference]
419 '("Previous Difference" . emerge-previous-difference))
420 (define-key emerge-move-menu [emerge-next-difference]
421 '("Next Difference" . emerge-next-difference))
422
423
424 (define-key emerge-options-menu [emerge-one-line-window]
425 '("One Line Window" . emerge-one-line-window))
426 (define-key emerge-options-menu [emerge-set-merge-mode]
623a8830 427 '("Set Merge Mode..." . emerge-set-merge-mode))
ff5f6ddd
RS
428 (define-key emerge-options-menu [emerge-set-combine-template]
429 '("Set Combine Template..." . emerge-set-combine-template))
430 (define-key emerge-options-menu [emerge-default-B]
431 '("Default B" . emerge-default-B))
432 (define-key emerge-options-menu [emerge-default-A]
433 '("Default A" . emerge-default-A))
434 (define-key emerge-options-menu [emerge-skip-prefers]
623a8830
GM
435 '(menu-item "Skip Prefers" emerge-skip-prefers
436 :button (:toggle . emerge-skip-prefers)))
ff5f6ddd 437 (define-key emerge-options-menu [emerge-auto-advance]
623a8830
GM
438 '(menu-item "Auto Advance" emerge-auto-advance
439 :button (:toggle . emerge-auto-advance)))
ff5f6ddd 440 (define-key emerge-options-menu [emerge-edit-mode]
623a8830 441 '(menu-item "Edit Mode" emerge-edit-mode :enable (not emerge-edit-mode)))
ff5f6ddd 442 (define-key emerge-options-menu [emerge-fast-mode]
623a8830 443 '(menu-item "Fast Mode" emerge-fast-mode :enable (not emerge-fast-mode)))
ff5f6ddd
RS
444
445 (define-key emerge-merge-menu [emerge-abort] '("Abort" . emerge-abort))
446 (define-key emerge-merge-menu [emerge-quit] '("Quit" . emerge-quit))
447 (define-key emerge-merge-menu [emerge-split-difference]
448 '("Split Difference" . emerge-split-difference))
449 (define-key emerge-merge-menu [emerge-join-differences]
450 '("Join Differences" . emerge-join-differences))
451 (define-key emerge-merge-menu [emerge-trim-difference]
452 '("Trim Difference" . emerge-trim-difference))
453 (define-key emerge-merge-menu [emerge-combine-versions]
454 '("Combine Versions" . emerge-combine-versions))
455 (define-key emerge-merge-menu [emerge-copy-as-kill-B]
456 '("Copy B as Kill" . emerge-copy-as-kill-B))
457 (define-key emerge-merge-menu [emerge-copy-as-kill-A]
458 '("Copy A as Kill" . emerge-copy-as-kill-A))
459 (define-key emerge-merge-menu [emerge-insert-B]
460 '("Insert B" . emerge-insert-B))
461 (define-key emerge-merge-menu [emerge-insert-A]
462 '("Insert A" . emerge-insert-A))
463 (define-key emerge-merge-menu [emerge-select-B]
464 '("Select B" . emerge-select-B))
465 (define-key emerge-merge-menu [emerge-select-A]
466 '("Select A" . emerge-select-A)))
467
3b4a6e27
JB
468
469;; Variables which control each merge. They are local to the merge buffer.
470
471;; Mode variables
472(emerge-defvar-local emerge-mode nil
473 "Indicator for emerge-mode.")
474(emerge-defvar-local emerge-fast-mode nil
475 "Indicator for emerge-mode fast submode.")
476(emerge-defvar-local emerge-edit-mode nil
477 "Indicator for emerge-mode edit submode.")
478(emerge-defvar-local emerge-A-buffer nil
479 "The buffer in which the A variant is stored.")
480(emerge-defvar-local emerge-B-buffer nil
481 "The buffer in which the B variant is stored.")
482(emerge-defvar-local emerge-merge-buffer nil
483 "The buffer in which the merged file is manipulated.")
484(emerge-defvar-local emerge-ancestor-buffer nil
485 "The buffer in which the ancestor variant is stored,
486or nil if there is none.")
487
488(defconst emerge-saved-variables
489 '((buffer-modified-p set-buffer-modified-p)
490 buffer-read-only
491 buffer-auto-save-file-name)
492 "Variables and properties of a buffer which are saved, modified and restored
493during a merge.")
494(defconst emerge-merging-values '(nil t nil)
495 "Values to be assigned to emerge-saved-variables during a merge.")
496
497(emerge-defvar-local emerge-A-buffer-values nil
498 "Remembers emerge-saved-variables for emerge-A-buffer.")
499(emerge-defvar-local emerge-B-buffer-values nil
500 "Remembers emerge-saved-variables for emerge-B-buffer.")
501
502(emerge-defvar-local emerge-difference-list nil
503 "Vector of differences between the variants, and markers in the buffers to
504show where they are. Each difference is represented by a vector of seven
505elements. The first two are markers to the beginning and end of the difference
506section in the A buffer, the second two are markers for the B buffer, the third
507two are markers for the merge buffer, and the last element is the \"state\" of
508that difference in the merge buffer.
509 A section of a buffer is described by two markers, one to the beginning of
510the first line of the section, and one to the beginning of the first line
511after the section. (If the section is empty, both markers point to the same
512point.) If the section is part of the selected difference, then the markers
513are moved into the flags, so the user can edit the section without disturbing
514the markers.
515 The \"states\" are:
516 A the merge buffer currently contains the A variant
517 B the merge buffer currently contains the B variant
518 default-A the merge buffer contains the A variant by default,
519 but this difference hasn't been selected yet, so
520 change-default commands can alter it
521 default-B the merge buffer contains the B variant by default,
522 but this difference hasn't been selected yet, so
523 change-default commands can alter it
eb8c3be9 524 prefer-A in a three-file merge, the A variant is the preferred
3b4a6e27 525 choice
eb8c3be9 526 prefer-B in a three-file merge, the B variant is the preferred
3b4a6e27
JB
527 choice")
528(emerge-defvar-local emerge-current-difference -1
529 "The difference that is currently selected.")
530(emerge-defvar-local emerge-number-of-differences nil
531 "Number of differences found.")
532(emerge-defvar-local emerge-edit-keymap nil
533 "The local keymap for the merge buffer, with the emerge commands defined in
534it. Used to save the local keymap during fast mode, when the local keymap is
535replaced by emerge-fast-keymap.")
536(emerge-defvar-local emerge-old-keymap nil
537 "The original local keymap for the merge buffer.")
538(emerge-defvar-local emerge-auto-advance nil
539 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
540the next difference.")
541(emerge-defvar-local emerge-skip-prefers nil
542 "*If non-nil, differences for which there is a preference are automatically
543skipped.")
737e3892 544(emerge-defvar-local emerge-quit-hook nil
3b4a6e27 545 "Hooks to run in the merge buffer after the merge has been finished.
737e3892 546`emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
3b4a6e27 547command.
737e3892 548This is *not* a user option, since Emerge uses it for its own processing.")
3b4a6e27 549(emerge-defvar-local emerge-output-description nil
737e3892 550 "Describes output destination of emerge, for `emerge-file-names'.")
3b4a6e27
JB
551
552;;; Setup functions for two-file mode.
553
554(defun emerge-files-internal (file-A file-B &optional startup-hooks quit-hooks
8a946354 555 output-file)
151e4b9c 556 (if (not (file-readable-p file-A))
737e3892 557 (error "File `%s' does not exist or is not readable" file-A))
151e4b9c 558 (if (not (file-readable-p file-B))
737e3892 559 (error "File `%s' does not exist or is not readable" file-B))
3b4a6e27
JB
560 (let ((buffer-A (find-file-noselect file-A))
561 (buffer-B (find-file-noselect file-B)))
151e4b9c
RS
562 ;; Record the directories of the files
563 (setq emerge-last-dir-A (file-name-directory file-A))
564 (setq emerge-last-dir-B (file-name-directory file-B))
565 (if output-file
566 (setq emerge-last-dir-output (file-name-directory output-file)))
3b4a6e27 567 ;; Make sure the entire files are seen, and they reflect what is on disk
71296446 568 (emerge-eval-in-buffer
151e4b9c
RS
569 buffer-A
570 (widen)
737e3892
RS
571 (let ((temp (file-local-copy file-A)))
572 (if temp
573 (setq file-A temp
574 startup-hooks
8a946354 575 (cons `(lambda () (delete-file ,file-A))
737e3892 576 startup-hooks))
8a946354
SS
577 ;; Verify that the file matches the buffer
578 (emerge-verify-file-buffer))))
151e4b9c
RS
579 (emerge-eval-in-buffer
580 buffer-B
581 (widen)
737e3892
RS
582 (let ((temp (file-local-copy file-B)))
583 (if temp
584 (setq file-B temp
585 startup-hooks
8a946354 586 (cons `(lambda () (delete-file ,file-B))
737e3892 587 startup-hooks))
8a946354
SS
588 ;; Verify that the file matches the buffer
589 (emerge-verify-file-buffer))))
3b4a6e27
JB
590 (emerge-setup buffer-A file-A buffer-B file-B startup-hooks quit-hooks
591 output-file)))
592
593;; Start up Emerge on two files
594(defun emerge-setup (buffer-A file-A buffer-B file-B startup-hooks quit-hooks
595 output-file)
596 (setq file-A (expand-file-name file-A))
597 (setq file-B (expand-file-name file-B))
598 (setq output-file (and output-file (expand-file-name output-file)))
599 (let* ((merge-buffer-name (emerge-unique-buffer-name "*merge" "*"))
600 ;; create the merge buffer from buffer A, so it inherits buffer A's
601 ;; default directory, etc.
602 (merge-buffer (emerge-eval-in-buffer
603 buffer-A
604 (get-buffer-create merge-buffer-name))))
605 (emerge-eval-in-buffer
606 merge-buffer
607 (emerge-copy-modes buffer-A)
608 (setq buffer-read-only nil)
609 (auto-save-mode 1)
610 (setq emerge-mode t)
611 (setq emerge-A-buffer buffer-A)
612 (setq emerge-B-buffer buffer-B)
613 (setq emerge-ancestor-buffer nil)
614 (setq emerge-merge-buffer merge-buffer)
615 (setq emerge-output-description
616 (if output-file
617 (concat "Output to file: " output-file)
618 (concat "Output to buffer: " (buffer-name merge-buffer))))
de3cc816 619 (save-excursion (insert-buffer-substring emerge-A-buffer))
3b4a6e27
JB
620 (emerge-set-keys)
621 (setq emerge-difference-list (emerge-make-diff-list file-A file-B))
622 (setq emerge-number-of-differences (length emerge-difference-list))
623 (setq emerge-current-difference -1)
737e3892 624 (setq emerge-quit-hook quit-hooks)
151e4b9c
RS
625 (emerge-remember-buffer-characteristics)
626 (emerge-handle-local-variables))
3b4a6e27
JB
627 (emerge-setup-windows buffer-A buffer-B merge-buffer t)
628 (emerge-eval-in-buffer merge-buffer
737e3892 629 (run-hooks 'startup-hooks 'emerge-startup-hook)
3b4a6e27
JB
630 (setq buffer-read-only t))))
631
632;; Generate the Emerge difference list between two files
633(defun emerge-make-diff-list (file-A file-B)
634 (setq emerge-diff-buffer (get-buffer-create "*emerge-diff*"))
635 (emerge-eval-in-buffer
636 emerge-diff-buffer
637 (erase-buffer)
638 (shell-command
639 (format "%s %s %s %s"
151e4b9c
RS
640 emerge-diff-program emerge-diff-options
641 (emerge-protect-metachars file-A)
642 (emerge-protect-metachars file-B))
3b4a6e27 643 t))
661d3230 644 (emerge-prepare-error-list emerge-diff-ok-lines-regexp)
3b4a6e27
JB
645 (emerge-convert-diffs-to-markers
646 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
647 (emerge-extract-diffs emerge-diff-buffer)))
648
649(defun emerge-extract-diffs (diff-buffer)
650 (let (list)
651 (emerge-eval-in-buffer
652 diff-buffer
653 (goto-char (point-min))
654 (while (re-search-forward emerge-match-diff-line nil t)
027a4b6b
JB
655 (let* ((a-begin (string-to-number (buffer-substring (match-beginning 1)
656 (match-end 1))))
3b4a6e27
JB
657 (a-end (let ((b (match-beginning 3))
658 (e (match-end 3)))
659 (if b
027a4b6b 660 (string-to-number (buffer-substring b e))
3b4a6e27
JB
661 a-begin)))
662 (diff-type (buffer-substring (match-beginning 4) (match-end 4)))
027a4b6b
JB
663 (b-begin (string-to-number (buffer-substring (match-beginning 5)
664 (match-end 5))))
3b4a6e27
JB
665 (b-end (let ((b (match-beginning 7))
666 (e (match-end 7)))
667 (if b
027a4b6b 668 (string-to-number (buffer-substring b e))
3b4a6e27
JB
669 b-begin))))
670 ;; fix the beginning and end numbers, because diff is somewhat
671 ;; strange about how it numbers lines
672 (if (string-equal diff-type "a")
673 (progn
674 (setq b-end (1+ b-end))
675 (setq a-begin (1+ a-begin))
676 (setq a-end a-begin))
677 (if (string-equal diff-type "d")
678 (progn
679 (setq a-end (1+ a-end))
680 (setq b-begin (1+ b-begin))
681 (setq b-end b-begin))
682 ;; (string-equal diff-type "c")
683 (progn
684 (setq a-end (1+ a-end))
685 (setq b-end (1+ b-end)))))
686 (setq list (cons (vector a-begin a-end
687 b-begin b-end
688 'default-A)
689 list)))))
690 (nreverse list)))
691
692;; Set up buffer of diff/diff3 error messages.
693(defun emerge-prepare-error-list (ok-regexp)
694 (setq emerge-diff-error-buffer (get-buffer-create "*emerge-diff-errors*"))
695 (emerge-eval-in-buffer
696 emerge-diff-error-buffer
697 (erase-buffer)
de3cc816 698 (save-excursion (insert-buffer-substring emerge-diff-buffer))
3b4a6e27
JB
699 (delete-matching-lines ok-regexp)))
700
701;;; Top-level and setup functions for three-file mode.
702
703(defun emerge-files-with-ancestor-internal (file-A file-B file-ancestor
737e3892
RS
704 &optional startup-hooks quit-hooks
705 output-file)
151e4b9c 706 (if (not (file-readable-p file-A))
737e3892 707 (error "File `%s' does not exist or is not readable" file-A))
151e4b9c 708 (if (not (file-readable-p file-B))
737e3892 709 (error "File `%s' does not exist or is not readable" file-B))
151e4b9c 710 (if (not (file-readable-p file-ancestor))
737e3892 711 (error "File `%s' does not exist or is not readable" file-ancestor))
3b4a6e27
JB
712 (let ((buffer-A (find-file-noselect file-A))
713 (buffer-B (find-file-noselect file-B))
714 (buffer-ancestor (find-file-noselect file-ancestor)))
151e4b9c
RS
715 ;; Record the directories of the files
716 (setq emerge-last-dir-A (file-name-directory file-A))
717 (setq emerge-last-dir-B (file-name-directory file-B))
718 (setq emerge-last-dir-ancestor (file-name-directory file-ancestor))
719 (if output-file
720 (setq emerge-last-dir-output (file-name-directory output-file)))
3b4a6e27 721 ;; Make sure the entire files are seen, and they reflect what is on disk
151e4b9c
RS
722 (emerge-eval-in-buffer
723 buffer-A
724 (widen)
737e3892
RS
725 (let ((temp (file-local-copy file-A)))
726 (if temp
727 (setq file-A temp
728 startup-hooks
8a946354 729 (cons `(lambda () (delete-file ,file-A))
737e3892 730 startup-hooks))
8a946354
SS
731 ;; Verify that the file matches the buffer
732 (emerge-verify-file-buffer))))
151e4b9c
RS
733 (emerge-eval-in-buffer
734 buffer-B
735 (widen)
737e3892
RS
736 (let ((temp (file-local-copy file-B)))
737 (if temp
738 (setq file-B temp
739 startup-hooks
8a946354 740 (cons `(lambda () (delete-file ,file-B))
737e3892 741 startup-hooks))
8a946354
SS
742 ;; Verify that the file matches the buffer
743 (emerge-verify-file-buffer))))
151e4b9c
RS
744 (emerge-eval-in-buffer
745 buffer-ancestor
746 (widen)
737e3892
RS
747 (let ((temp (file-local-copy file-ancestor)))
748 (if temp
749 (setq file-ancestor temp
750 startup-hooks
8a946354 751 (cons `(lambda () (delete-file ,file-ancestor))
737e3892 752 startup-hooks))
8a946354
SS
753 ;; Verify that the file matches the buffer
754 (emerge-verify-file-buffer))))
3b4a6e27
JB
755 (emerge-setup-with-ancestor buffer-A file-A buffer-B file-B
756 buffer-ancestor file-ancestor
757 startup-hooks quit-hooks output-file)))
758
759;; Start up Emerge on two files with an ancestor
760(defun emerge-setup-with-ancestor (buffer-A file-A buffer-B file-B
761 buffer-ancestor file-ancestor
762 &optional startup-hooks quit-hooks
763 output-file)
764 (setq file-A (expand-file-name file-A))
765 (setq file-B (expand-file-name file-B))
766 (setq file-ancestor (expand-file-name file-ancestor))
767 (setq output-file (and output-file (expand-file-name output-file)))
768 (let* ((merge-buffer-name (emerge-unique-buffer-name "*merge" "*"))
769 ;; create the merge buffer from buffer A, so it inherits buffer A's
770 ;; default directory, etc.
771 (merge-buffer (emerge-eval-in-buffer
772 buffer-A
773 (get-buffer-create merge-buffer-name))))
774 (emerge-eval-in-buffer
775 merge-buffer
776 (emerge-copy-modes buffer-A)
777 (setq buffer-read-only nil)
778 (auto-save-mode 1)
779 (setq emerge-mode t)
780 (setq emerge-A-buffer buffer-A)
781 (setq emerge-B-buffer buffer-B)
782 (setq emerge-ancestor-buffer buffer-ancestor)
783 (setq emerge-merge-buffer merge-buffer)
784 (setq emerge-output-description
785 (if output-file
786 (concat "Output to file: " output-file)
787 (concat "Output to buffer: " (buffer-name merge-buffer))))
de3cc816 788 (save-excursion (insert-buffer-substring emerge-A-buffer))
3b4a6e27
JB
789 (emerge-set-keys)
790 (setq emerge-difference-list
791 (emerge-make-diff3-list file-A file-B file-ancestor))
792 (setq emerge-number-of-differences (length emerge-difference-list))
793 (setq emerge-current-difference -1)
737e3892 794 (setq emerge-quit-hook quit-hooks)
3b4a6e27 795 (emerge-remember-buffer-characteristics)
151e4b9c
RS
796 (emerge-select-prefer-Bs)
797 (emerge-handle-local-variables))
3b4a6e27
JB
798 (emerge-setup-windows buffer-A buffer-B merge-buffer t)
799 (emerge-eval-in-buffer merge-buffer
737e3892 800 (run-hooks 'startup-hooks 'emerge-startup-hook)
3b4a6e27
JB
801 (setq buffer-read-only t))))
802
803;; Generate the Emerge difference list between two files with an ancestor
804(defun emerge-make-diff3-list (file-A file-B file-ancestor)
805 (setq emerge-diff-buffer (get-buffer-create "*emerge-diff*"))
806 (emerge-eval-in-buffer
807 emerge-diff-buffer
808 (erase-buffer)
809 (shell-command
810 (format "%s %s %s %s %s"
811 emerge-diff3-program emerge-diff-options
151e4b9c 812 (emerge-protect-metachars file-A)
4a6e3980 813 (emerge-protect-metachars file-ancestor)
151e4b9c 814 (emerge-protect-metachars file-B))
3b4a6e27 815 t))
661d3230 816 (emerge-prepare-error-list emerge-diff3-ok-lines-regexp)
3b4a6e27
JB
817 (emerge-convert-diffs-to-markers
818 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
819 (emerge-extract-diffs3 emerge-diff-buffer)))
820
821(defun emerge-extract-diffs3 (diff-buffer)
822 (let (list)
823 (emerge-eval-in-buffer
824 diff-buffer
825 (while (re-search-forward "^====\\(.?\\)$" nil t)
826 ;; leave point after matched line
827 (beginning-of-line 2)
828 (let ((agreement (buffer-substring (match-beginning 1) (match-end 1))))
829 ;; if the A and B files are the same, ignore the difference
4a6e3980 830 (if (not (string-equal agreement "2"))
3b4a6e27 831 (setq list
71296446 832 (cons
4a6e3980 833 (let (group-1 group-3 pos)
737e3892 834 (setq pos (point))
4a6e3980 835 (setq group-1 (emerge-get-diff3-group "1"))
737e3892
RS
836 (goto-char pos)
837 (setq group-3 (emerge-get-diff3-group "3"))
4a6e3980 838 (vector (car group-1) (car (cdr group-1))
3b4a6e27 839 (car group-3) (car (cdr group-3))
4a6e3980 840 (cond ((string-equal agreement "1") 'prefer-A)
3b4a6e27
JB
841 ((string-equal agreement "3") 'prefer-B)
842 (t 'default-A))))
843 list))))))
844 (nreverse list)))
845
846(defun emerge-get-diff3-group (file)
847 ;; This save-excursion allows emerge-get-diff3-group to be called for the
848 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
849 ;; appear in any order. The reason this is necessary is that Gnu diff3
850 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
851 (save-excursion
852 (re-search-forward
853 (concat "^" file ":\\([0-9]+\\)\\(,\\([0-9]+\\)\\)?\\([ac]\\)$"))
854 (beginning-of-line 2)
855 ;; treatment depends on whether it is an "a" group or a "c" group
856 (if (string-equal (buffer-substring (match-beginning 4) (match-end 4)) "c")
857 ;; it is a "c" group
858 (if (match-beginning 2)
859 ;; it has two numbers
027a4b6b 860 (list (string-to-number
3b4a6e27 861 (buffer-substring (match-beginning 1) (match-end 1)))
027a4b6b 862 (1+ (string-to-number
3b4a6e27
JB
863 (buffer-substring (match-beginning 3) (match-end 3)))))
864 ;; it has one number
027a4b6b 865 (let ((x (string-to-number
3b4a6e27
JB
866 (buffer-substring (match-beginning 1) (match-end 1)))))
867 (list x (1+ x))))
868 ;; it is an "a" group
027a4b6b 869 (let ((x (1+ (string-to-number
3b4a6e27
JB
870 (buffer-substring (match-beginning 1) (match-end 1))))))
871 (list x x)))))
872
873;;; Functions to start Emerge on files
874
737e3892 875;;;###autoload
3b4a6e27
JB
876(defun emerge-files (arg file-A file-B file-out &optional startup-hooks
877 quit-hooks)
878 "Run Emerge on two files."
879 (interactive
880 (let (f)
881 (list current-prefix-arg
151e4b9c 882 (setq f (emerge-read-file-name "File A to merge" emerge-last-dir-A
90371ec9
RS
883 nil nil t))
884 (emerge-read-file-name "File B to merge" emerge-last-dir-B nil f t)
3b4a6e27 885 (and current-prefix-arg
151e4b9c 886 (emerge-read-file-name "Output file" emerge-last-dir-output
90371ec9 887 f f nil)))))
43d3039d 888 (if file-out
8a946354 889 (add-hook 'quit-hooks `(lambda () (emerge-files-exit ,file-out))))
3b4a6e27
JB
890 (emerge-files-internal
891 file-A file-B startup-hooks
43d3039d 892 quit-hooks
3b4a6e27
JB
893 file-out))
894
737e3892 895;;;###autoload
3b4a6e27
JB
896(defun emerge-files-with-ancestor (arg file-A file-B file-ancestor file-out
897 &optional startup-hooks quit-hooks)
898 "Run Emerge on two files, giving another file as the ancestor."
899 (interactive
900 (let (f)
901 (list current-prefix-arg
151e4b9c 902 (setq f (emerge-read-file-name "File A to merge" emerge-last-dir-A
90371ec9
RS
903 nil nil t))
904 (emerge-read-file-name "File B to merge" emerge-last-dir-B nil f t)
151e4b9c 905 (emerge-read-file-name "Ancestor file" emerge-last-dir-ancestor
90371ec9 906 nil f t)
3b4a6e27 907 (and current-prefix-arg
151e4b9c 908 (emerge-read-file-name "Output file" emerge-last-dir-output
90371ec9 909 f f nil)))))
43d3039d 910 (if file-out
8a946354 911 (add-hook 'quit-hooks `(lambda () (emerge-files-exit ,file-out))))
3b4a6e27
JB
912 (emerge-files-with-ancestor-internal
913 file-A file-B file-ancestor startup-hooks
43d3039d 914 quit-hooks
3b4a6e27
JB
915 file-out))
916
917;; Write the merge buffer out in place of the file the A buffer is visiting.
918(defun emerge-files-exit (file-out)
919 ;; if merge was successful was given, save to disk
920 (if (not emerge-prefix-argument)
921 (emerge-write-and-delete file-out)))
922
923;;; Functions to start Emerge on buffers
924
737e3892 925;;;###autoload
3b4a6e27
JB
926(defun emerge-buffers (buffer-A buffer-B &optional startup-hooks quit-hooks)
927 "Run Emerge on two buffers."
928 (interactive "bBuffer A to merge: \nbBuffer B to merge: ")
929 (let ((emerge-file-A (emerge-make-temp-file "A"))
930 (emerge-file-B (emerge-make-temp-file "B")))
931 (emerge-eval-in-buffer
932 buffer-A
933 (write-region (point-min) (point-max) emerge-file-A nil 'no-message))
934 (emerge-eval-in-buffer
935 buffer-B
936 (write-region (point-min) (point-max) emerge-file-B nil 'no-message))
937 (emerge-setup (get-buffer buffer-A) emerge-file-A
938 (get-buffer buffer-B) emerge-file-B
8a946354
SS
939 (cons `(lambda ()
940 (delete-file ,emerge-file-A)
941 (delete-file ,emerge-file-B))
3b4a6e27
JB
942 startup-hooks)
943 quit-hooks
944 nil)))
945
737e3892 946;;;###autoload
3b4a6e27 947(defun emerge-buffers-with-ancestor (buffer-A buffer-B buffer-ancestor
8a946354
SS
948 &optional startup-hooks
949 quit-hooks)
3b4a6e27
JB
950 "Run Emerge on two buffers, giving another buffer as the ancestor."
951 (interactive
952 "bBuffer A to merge: \nbBuffer B to merge: \nbAncestor buffer: ")
953 (let ((emerge-file-A (emerge-make-temp-file "A"))
954 (emerge-file-B (emerge-make-temp-file "B"))
955 (emerge-file-ancestor (emerge-make-temp-file "anc")))
956 (emerge-eval-in-buffer
957 buffer-A
958 (write-region (point-min) (point-max) emerge-file-A nil 'no-message))
959 (emerge-eval-in-buffer
960 buffer-B
961 (write-region (point-min) (point-max) emerge-file-B nil 'no-message))
962 (emerge-eval-in-buffer
963 buffer-ancestor
964 (write-region (point-min) (point-max) emerge-file-ancestor nil
965 'no-message))
966 (emerge-setup-with-ancestor (get-buffer buffer-A) emerge-file-A
967 (get-buffer buffer-B) emerge-file-B
968 (get-buffer buffer-ancestor)
969 emerge-file-ancestor
8a946354
SS
970 (cons `(lambda ()
971 (delete-file ,emerge-file-A)
972 (delete-file ,emerge-file-B)
973 (delete-file
974 ,emerge-file-ancestor))
3b4a6e27
JB
975 startup-hooks)
976 quit-hooks
977 nil)))
978
979;;; Functions to start Emerge from the command line
980
737e3892 981;;;###autoload
3b4a6e27
JB
982(defun emerge-files-command ()
983 (let ((file-a (nth 0 command-line-args-left))
984 (file-b (nth 1 command-line-args-left))
985 (file-out (nth 2 command-line-args-left)))
986 (setq command-line-args-left (nthcdr 3 command-line-args-left))
987 (emerge-files-internal
988 file-a file-b nil
8a946354 989 (list `(lambda () (emerge-command-exit ,file-out))))))
3b4a6e27 990
737e3892 991;;;###autoload
3b4a6e27
JB
992(defun emerge-files-with-ancestor-command ()
993 (let (file-a file-b file-anc file-out)
994 ;; check for a -a flag, for filemerge compatibility
995 (if (string= (car command-line-args-left) "-a")
996 ;; arguments are "-a ancestor file-a file-b file-out"
997 (progn
998 (setq file-a (nth 2 command-line-args-left))
999 (setq file-b (nth 3 command-line-args-left))
1000 (setq file-anc (nth 1 command-line-args-left))
1001 (setq file-out (nth 4 command-line-args-left))
1002 (setq command-line-args-left (nthcdr 5 command-line-args-left)))
8a946354
SS
1003 ;; arguments are "file-a file-b ancestor file-out"
1004 (setq file-a (nth 0 command-line-args-left))
1005 (setq file-b (nth 1 command-line-args-left))
1006 (setq file-anc (nth 2 command-line-args-left))
1007 (setq file-out (nth 3 command-line-args-left))
1008 (setq command-line-args-left (nthcdr 4 command-line-args-left)))
3b4a6e27
JB
1009 (emerge-files-with-ancestor-internal
1010 file-a file-b file-anc nil
8a946354 1011 (list `(lambda () (emerge-command-exit ,file-out))))))
71296446 1012
3b4a6e27
JB
1013(defun emerge-command-exit (file-out)
1014 (emerge-write-and-delete file-out)
1015 (kill-emacs (if emerge-prefix-argument 1 0)))
1016
1017;;; Functions to start Emerge via remote request
1018
737e3892 1019;;;###autoload
3b4a6e27
JB
1020(defun emerge-files-remote (file-a file-b file-out)
1021 (setq emerge-file-out file-out)
1022 (emerge-files-internal
1023 file-a file-b nil
8a946354 1024 (list `(lambda () (emerge-remote-exit ,file-out ',emerge-exit-func)))
3b4a6e27
JB
1025 file-out)
1026 (throw 'client-wait nil))
1027
737e3892 1028;;;###autoload
3b4a6e27
JB
1029(defun emerge-files-with-ancestor-remote (file-a file-b file-anc file-out)
1030 (setq emerge-file-out file-out)
1031 (emerge-files-with-ancestor-internal
1032 file-a file-b file-anc nil
8a946354 1033 (list `(lambda () (emerge-remote-exit ,file-out ',emerge-exit-func)))
3b4a6e27
JB
1034 file-out)
1035 (throw 'client-wait nil))
1036
ff5f6ddd 1037(defun emerge-remote-exit (file-out emerge-exit-func)
3b4a6e27
JB
1038 (emerge-write-and-delete file-out)
1039 (kill-buffer emerge-merge-buffer)
ff5f6ddd 1040 (funcall emerge-exit-func (if emerge-prefix-argument 1 0)))
3b4a6e27 1041
151e4b9c
RS
1042;;; Functions to start Emerge on RCS versions
1043
9343c8ee 1044;;;###autoload
151e4b9c
RS
1045(defun emerge-revisions (arg file revision-A revision-B
1046 &optional startup-hooks quit-hooks)
1047 "Emerge two RCS revisions of a file."
1048 (interactive
1049 (list current-prefix-arg
1050 (read-file-name "File to merge: " nil nil 'confirm)
1051 (read-string "Revision A to merge: " emerge-last-revision-A)
1052 (read-string "Revision B to merge: " emerge-last-revision-B)))
1053 (setq emerge-last-revision-A revision-A
1054 emerge-last-revision-B revision-B)
1055 (emerge-revisions-internal
1056 file revision-A revision-B startup-hooks
1057 (if arg
8a946354
SS
1058 (cons `(lambda ()
1059 (shell-command
1060 ,(format "%s %s" emerge-rcs-ci-program file)))
151e4b9c 1061 quit-hooks)
8a946354 1062 quit-hooks)))
151e4b9c 1063
9343c8ee 1064;;;###autoload
151e4b9c 1065(defun emerge-revisions-with-ancestor (arg file revision-A
8a946354
SS
1066 revision-B ancestor
1067 &optional
1068 startup-hooks quit-hooks)
737e3892 1069 "Emerge two RCS revisions of a file, with another revision as ancestor."
151e4b9c
RS
1070 (interactive
1071 (list current-prefix-arg
1072 (read-file-name "File to merge: " nil nil 'confirm)
1073 (read-string "Revision A to merge: " emerge-last-revision-A)
1074 (read-string "Revision B to merge: " emerge-last-revision-B)
1075 (read-string "Ancestor: " emerge-last-revision-ancestor)))
1076 (setq emerge-last-revision-A revision-A
1077 emerge-last-revision-B revision-B
1078 emerge-last-revision-ancestor ancestor)
1079 (emerge-revision-with-ancestor-internal
1080 file revision-A revision-B ancestor startup-hooks
1081 (if arg
1082 (let ((cmd ))
8a946354
SS
1083 (cons `(lambda ()
1084 (shell-command
1085 ,(format "%s %s" emerge-rcs-ci-program file)))
151e4b9c 1086 quit-hooks))
8a946354 1087 quit-hooks)))
151e4b9c
RS
1088
1089(defun emerge-revisions-internal (file revision-A revision-B &optional
8a946354 1090 startup-hooks quit-hooks output-file)
151e4b9c
RS
1091 (let ((buffer-A (get-buffer-create (format "%s,%s" file revision-A)))
1092 (buffer-B (get-buffer-create (format "%s,%s" file revision-B)))
1093 (emerge-file-A (emerge-make-temp-file "A"))
1094 (emerge-file-B (emerge-make-temp-file "B")))
1095 ;; Get the revisions into buffers
1096 (emerge-eval-in-buffer
1097 buffer-A
1098 (erase-buffer)
1099 (shell-command
1100 (format "%s -q -p%s %s" emerge-rcs-co-program revision-A file)
1101 t)
1102 (write-region (point-min) (point-max) emerge-file-A nil 'no-message)
1103 (set-buffer-modified-p nil))
1104 (emerge-eval-in-buffer
1105 buffer-B
1106 (erase-buffer)
1107 (shell-command
1108 (format "%s -q -p%s %s" emerge-rcs-co-program revision-B file)
1109 t)
1110 (write-region (point-min) (point-max) emerge-file-B nil 'no-message)
1111 (set-buffer-modified-p nil))
1112 ;; Do the merge
1113 (emerge-setup buffer-A emerge-file-A
1114 buffer-B emerge-file-B
8a946354
SS
1115 (cons `(lambda ()
1116 (delete-file ,emerge-file-A)
1117 (delete-file ,emerge-file-B))
151e4b9c 1118 startup-hooks)
8a946354 1119 (cons `(lambda () (emerge-files-exit ,file))
151e4b9c
RS
1120 quit-hooks)
1121 nil)))
1122
1123(defun emerge-revision-with-ancestor-internal (file revision-A revision-B
8a946354
SS
1124 ancestor
1125 &optional startup-hooks
1126 quit-hooks output-file)
151e4b9c
RS
1127 (let ((buffer-A (get-buffer-create (format "%s,%s" file revision-A)))
1128 (buffer-B (get-buffer-create (format "%s,%s" file revision-B)))
1129 (buffer-ancestor (get-buffer-create (format "%s,%s" file ancestor)))
1130 (emerge-file-A (emerge-make-temp-file "A"))
1131 (emerge-file-B (emerge-make-temp-file "B"))
1132 (emerge-ancestor (emerge-make-temp-file "ancestor")))
1133 ;; Get the revisions into buffers
1134 (emerge-eval-in-buffer
1135 buffer-A
1136 (erase-buffer)
1137 (shell-command
1138 (format "%s -q -p%s %s" emerge-rcs-co-program
1139 revision-A file)
1140 t)
1141 (write-region (point-min) (point-max) emerge-file-A nil 'no-message)
1142 (set-buffer-modified-p nil))
1143 (emerge-eval-in-buffer
1144 buffer-B
1145 (erase-buffer)
1146 (shell-command
1147 (format "%s -q -p%s %s" emerge-rcs-co-program revision-B file)
1148 t)
1149 (write-region (point-min) (point-max) emerge-file-B nil 'no-message)
1150 (set-buffer-modified-p nil))
1151 (emerge-eval-in-buffer
1152 buffer-ancestor
1153 (erase-buffer)
1154 (shell-command
1155 (format "%s -q -p%s %s" emerge-rcs-co-program ancestor file)
1156 t)
1157 (write-region (point-min) (point-max) emerge-ancestor nil 'no-message)
1158 (set-buffer-modified-p nil))
1159 ;; Do the merge
1160 (emerge-setup-with-ancestor
1161 buffer-A emerge-file-A buffer-B emerge-file-B
1162 buffer-ancestor emerge-ancestor
8a946354
SS
1163 (cons `(lambda ()
1164 (delete-file ,emerge-file-A)
1165 (delete-file ,emerge-file-B)
1166 (delete-file ,emerge-ancestor))
151e4b9c 1167 startup-hooks)
8a946354 1168 (cons `(lambda () (emerge-files-exit ,file))
151e4b9c
RS
1169 quit-hooks)
1170 output-file)))
1171
1172;;; Function to start Emerge based on a line in a file
1173
1174(defun emerge-execute-line ()
737e3892
RS
1175 "Run Emerge using files named in current text line.
1176Looks in that line for whitespace-separated entries of these forms:
151e4b9c
RS
1177 a=file1
1178 b=file2
1179 ancestor=file3
1180 output=file4
737e3892 1181to specify the files to use in Emerge.
151e4b9c 1182
737e3892 1183In addition, if only one of `a=file' or `b=file' is present, and `output=file'
151e4b9c 1184is present:
737e3892 1185If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
151e4b9c
RS
1186it is assumed that the file in question has been deleted, and it is
1187not copied to the output file.
1188Otherwise, the A or B file present is copied to the output file."
1189 (interactive)
1190 (let (file-A file-B file-ancestor file-out
1191 (case-fold-search t))
1192 ;; Stop if at end of buffer (even though we might be in a line, if
1193 ;; the line does not end with newline)
1194 (if (eobp)
1195 (error "At end of buffer"))
1196 ;; Go to the beginning of the line
1197 (beginning-of-line)
1198 ;; Skip any initial whitespace
1199 (if (looking-at "[ \t]*")
1200 (goto-char (match-end 0)))
1201 ;; Process the entire line
1202 (while (not (eolp))
1203 ;; Get the next entry
1204 (if (looking-at "\\([a-z]+\\)=\\([^ \t\n]+\\)[ \t]*")
1205 ;; Break apart the tab (before =) and the filename (after =)
1206 (let ((tag (downcase
1207 (buffer-substring (match-beginning 1) (match-end 1))))
1208 (file (buffer-substring (match-beginning 2) (match-end 2))))
1209 ;; Move point after the entry
1210 (goto-char (match-end 0))
1211 ;; Store the filename in the right variable
1212 (cond
8a946354
SS
1213 ((string-equal tag "a")
1214 (if file-A
1215 (error "This line has two `A' entries"))
1216 (setq file-A file))
1217 ((string-equal tag "b")
1218 (if file-B
1219 (error "This line has two `B' entries"))
1220 (setq file-B file))
1221 ((or (string-equal tag "anc") (string-equal tag "ancestor"))
1222 (if file-ancestor
1223 (error "This line has two `ancestor' entries"))
1224 (setq file-ancestor file))
1225 ((or (string-equal tag "out") (string-equal tag "output"))
1226 (if file-out
1227 (error "This line has two `output' entries"))
1228 (setq file-out file))
1229 (t
1230 (error "Unrecognized entry"))))
1231 ;; If the match on the entry pattern failed
1232 (error "Unparsable entry")))
151e4b9c
RS
1233 ;; Make sure that file-A and file-B are present
1234 (if (not (or (and file-A file-B) file-out))
737e3892 1235 (error "Must have both `A' and `B' entries"))
151e4b9c 1236 (if (not (or file-A file-B))
737e3892 1237 (error "Must have `A' or `B' entry"))
151e4b9c
RS
1238 ;; Go to the beginning of the next line, so next execution will use
1239 ;; next line in buffer.
1240 (beginning-of-line 2)
1241 ;; Execute the correct command
1242 (cond
8a946354
SS
1243 ;; Merge of two files with ancestor
1244 ((and file-A file-B file-ancestor)
1245 (message "Merging %s and %s..." file-A file-B)
1246 (emerge-files-with-ancestor (not (not file-out)) file-A file-B
1247 file-ancestor file-out
1248 nil
1249 ;; When done, return to this buffer.
1250 (list
1251 `(lambda ()
1252 (switch-to-buffer ,(current-buffer))
1253 (message "Merge done.")))))
1254 ;; Merge of two files without ancestor
1255 ((and file-A file-B)
1256 (message "Merging %s and %s..." file-A file-B)
1257 (emerge-files (not (not file-out)) file-A file-B file-out
1258 nil
1259 ;; When done, return to this buffer.
71296446 1260 (list
8a946354
SS
1261 `(lambda ()
1262 (switch-to-buffer ,(current-buffer))
1263 (message "Merge done.")))))
1264 ;; There is an output file (or there would have been an error above),
1265 ;; but only one input file.
1266 ;; The file appears to have been deleted in one version; do nothing.
1267 ((and file-ancestor emerge-execute-line-deletions)
1268 (message "No action."))
1269 ;; The file should be copied from the version that contains it
1270 (t (let ((input-file (or file-A file-B)))
1271 (message "Copying...")
1272 (copy-file input-file file-out)
1273 (message "%s copied to %s." input-file file-out))))))
151e4b9c
RS
1274
1275;;; Sample function for creating information for emerge-execute-line
1276
33933d45
AS
1277(defcustom emerge-merge-directories-filename-regexp "[^.]"
1278 "Regexp describing files to be processed by `emerge-merge-directories'."
1279 :type 'regexp
1280 :group 'emerge)
151e4b9c 1281
9343c8ee 1282;;;###autoload
151e4b9c 1283(defun emerge-merge-directories (a-dir b-dir ancestor-dir output-dir)
71296446 1284 (interactive
151e4b9c
RS
1285 (list
1286 (read-file-name "A directory: " nil nil 'confirm)
1287 (read-file-name "B directory: " nil nil 'confirm)
1288 (read-file-name "Ancestor directory (null for none): " nil nil 'confirm)
1289 (read-file-name "Output directory (null for none): " nil nil 'confirm)))
1290 ;; Check that we're not on a line
1291 (if (not (and (bolp) (eolp)))
1292 (error "There is text on this line"))
1293 ;; Turn null strings into nil to indicate directories not used.
1294 (if (and ancestor-dir (string-equal ancestor-dir ""))
1295 (setq ancestor-dir nil))
1296 (if (and output-dir (string-equal output-dir ""))
1297 (setq output-dir nil))
1298 ;; Canonicalize the directory names
1299 (setq a-dir (expand-file-name a-dir))
1300 (if (not (string-equal (substring a-dir -1) "/"))
1301 (setq a-dir (concat a-dir "/")))
1302 (setq b-dir (expand-file-name b-dir))
1303 (if (not (string-equal (substring b-dir -1) "/"))
1304 (setq b-dir (concat b-dir "/")))
1305 (if ancestor-dir
1306 (progn
1307 (setq ancestor-dir (expand-file-name ancestor-dir))
1308 (if (not (string-equal (substring ancestor-dir -1) "/"))
1309 (setq ancestor-dir (concat ancestor-dir "/")))))
1310 (if output-dir
1311 (progn
1312 (setq output-dir (expand-file-name output-dir))
1313 (if (not (string-equal (substring output-dir -1) "/"))
1314 (setq output-dir (concat output-dir "/")))))
1315 ;; Set the mark to where we start
1316 (push-mark)
1317 ;; Find out what files are in the directories.
1318 (let* ((a-dir-files
1319 (directory-files a-dir nil emerge-merge-directories-filename-regexp))
1320 (b-dir-files
1321 (directory-files b-dir nil emerge-merge-directories-filename-regexp))
1322 (ancestor-dir-files
1323 (and ancestor-dir
1324 (directory-files ancestor-dir nil
1325 emerge-merge-directories-filename-regexp)))
1326 (all-files (sort (nconc (copy-sequence a-dir-files)
1327 (copy-sequence b-dir-files)
1328 (copy-sequence ancestor-dir-files))
1329 (function string-lessp))))
1330 ;; Remove duplicates from all-files.
1331 (let ((p all-files))
1332 (while p
1333 (if (and (cdr p) (string-equal (car p) (car (cdr p))))
1334 (setcdr p (cdr (cdr p)))
1335 (setq p (cdr p)))))
1336 ;; Generate the control lines for the various files.
1337 (while all-files
1338 (let ((f (car all-files)))
1339 (setq all-files (cdr all-files))
1340 (if (and a-dir-files (string-equal (car a-dir-files) f))
1341 (progn
1342 (insert "A=" a-dir f "\t")
1343 (setq a-dir-files (cdr a-dir-files))))
1344 (if (and b-dir-files (string-equal (car b-dir-files) f))
1345 (progn
1346 (insert "B=" b-dir f "\t")
1347 (setq b-dir-files (cdr b-dir-files))))
1348 (if (and ancestor-dir-files (string-equal (car ancestor-dir-files) f))
1349 (progn
1350 (insert "ancestor=" ancestor-dir f "\t")
1351 (setq ancestor-dir-files (cdr ancestor-dir-files))))
1352 (if output-dir
1353 (insert "output=" output-dir f "\t"))
1354 (backward-delete-char 1)
1355 (insert "\n")))))
1356
3b4a6e27
JB
1357;;; Common setup routines
1358
1359;; Set up the window configuration. If POS is given, set the points to
1360;; the beginnings of the buffers.
1361(defun emerge-setup-windows (buffer-A buffer-B merge-buffer &optional pos)
1362 ;; Make sure we are not in the minibuffer window when we try to delete
1363 ;; all other windows.
1364 (if (eq (selected-window) (minibuffer-window))
1365 (other-window 1))
1366 (delete-other-windows)
1367 (switch-to-buffer merge-buffer)
1368 (emerge-refresh-mode-line)
1369 (split-window-vertically)
1370 (split-window-horizontally)
1371 (switch-to-buffer buffer-A)
1372 (if pos
1373 (goto-char (point-min)))
1374 (other-window 1)
1375 (switch-to-buffer buffer-B)
1376 (if pos
1377 (goto-char (point-min)))
1378 (other-window 1)
1379 (if pos
1380 (goto-char (point-min)))
1381 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1382 (if (/= 0 (emerge-eval-in-buffer emerge-diff-error-buffer (buffer-size)))
1383 (progn
1384 (ding)
1385 (message "Errors found in diff/diff3 output. Merge buffer is %s."
1386 (buffer-name emerge-merge-buffer))
1387 (switch-to-buffer emerge-diff-error-buffer))))
1388
1389;; Set up the keymap in the merge buffer
1390(defun emerge-set-keys ()
1391 ;; Set up fixed keymaps if necessary
1392 (if (not emerge-basic-keymap)
1393 (emerge-setup-fixed-keymaps))
1394 ;; Save the old local map
1395 (setq emerge-old-keymap (current-local-map))
1396 ;; Construct the edit keymap
1397 (setq emerge-edit-keymap (if emerge-old-keymap
1398 (copy-keymap emerge-old-keymap)
1399 (make-sparse-keymap)))
1400 ;; Install the Emerge commands
1401 (emerge-force-define-key emerge-edit-keymap emerge-command-prefix
1402 'emerge-basic-keymap)
ff5f6ddd
RS
1403 (define-key emerge-edit-keymap [menu-bar] (make-sparse-keymap))
1404
1405 ;; Create the additional menu bar items.
623a8830
GM
1406 (define-key emerge-edit-keymap [menu-bar emerge-options]
1407 (cons "Merge-Options" emerge-options-menu))
ff5f6ddd
RS
1408 (define-key emerge-edit-keymap [menu-bar merge]
1409 (cons "Merge" emerge-merge-menu))
1410 (define-key emerge-edit-keymap [menu-bar move]
1411 (cons "Move" emerge-move-menu))
1412
3b4a6e27 1413 ;; Suppress write-file and save-buffer
737e3892
RS
1414 (substitute-key-definition 'write-file
1415 'emerge-query-write-file
1416 emerge-edit-keymap)
1417 (substitute-key-definition 'save-buffer
1418 'emerge-query-save-buffer
1419 emerge-edit-keymap)
96473b34
AS
1420 (define-key emerge-edit-keymap [remap write-file] 'emerge-query-write-file)
1421 (define-key emerge-edit-keymap [remap save-buffer] 'emerge-query-save-buffer)
3b4a6e27
JB
1422 (use-local-map emerge-fast-keymap)
1423 (setq emerge-edit-mode nil)
1424 (setq emerge-fast-mode t))
1425
1426(defun emerge-remember-buffer-characteristics ()
737e3892
RS
1427 "Record certain properties of the buffers being merged.
1428Must be called in the merge buffer. Remembers read-only, modified,
1429auto-save, and saves them in buffer local variables. Sets the buffers
1430read-only and turns off `auto-save-mode'.
1431These characteristics are restored by `emerge-restore-buffer-characteristics'."
3b4a6e27
JB
1432 ;; force auto-save, because we will turn off auto-saving in buffers for the
1433 ;; duration
1434 (do-auto-save)
1435 ;; remember and alter buffer characteristics
1436 (setq emerge-A-buffer-values
1437 (emerge-eval-in-buffer
1438 emerge-A-buffer
1439 (prog1
1440 (emerge-save-variables emerge-saved-variables)
1441 (emerge-restore-variables emerge-saved-variables
1442 emerge-merging-values))))
1443 (setq emerge-B-buffer-values
1444 (emerge-eval-in-buffer
1445 emerge-B-buffer
1446 (prog1
1447 (emerge-save-variables emerge-saved-variables)
1448 (emerge-restore-variables emerge-saved-variables
1449 emerge-merging-values)))))
1450
1451(defun emerge-restore-buffer-characteristics ()
c9ec040a 1452 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
3b4a6e27
JB
1453 (let ((A-values emerge-A-buffer-values)
1454 (B-values emerge-B-buffer-values))
1455 (emerge-eval-in-buffer emerge-A-buffer
1456 (emerge-restore-variables emerge-saved-variables
1457 A-values))
1458 (emerge-eval-in-buffer emerge-B-buffer
1459 (emerge-restore-variables emerge-saved-variables
1460 B-values))))
1461
4d4cd289
RS
1462;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1463;; Return DESIRED-LINE.
1464(defun emerge-goto-line (desired-line current-line)
1465 (forward-line (- desired-line current-line))
d9021674 1466 desired-line)
4d4cd289 1467
3b4a6e27
JB
1468(defun emerge-convert-diffs-to-markers (A-buffer
1469 B-buffer
1470 merge-buffer
1471 lineno-list)
1472 (let* (marker-list
1473 (A-point-min (emerge-eval-in-buffer A-buffer (point-min)))
1474 (offset (1- A-point-min))
3b4a6e27 1475 (B-point-min (emerge-eval-in-buffer B-buffer (point-min)))
4d4cd289
RS
1476 ;; Record current line number in each buffer
1477 ;; so we don't have to count from the beginning.
d9021674
KH
1478 (a-line 1)
1479 (b-line 1))
4d4cd289
RS
1480 (emerge-eval-in-buffer A-buffer (goto-char (point-min)))
1481 (emerge-eval-in-buffer B-buffer (goto-char (point-min)))
3b4a6e27
JB
1482 (while lineno-list
1483 (let* ((list-element (car lineno-list))
1484 a-begin-marker
1485 a-end-marker
1486 b-begin-marker
1487 b-end-marker
151e4b9c
RS
1488 merge-begin-marker
1489 merge-end-marker
3b4a6e27
JB
1490 (a-begin (aref list-element 0))
1491 (a-end (aref list-element 1))
1492 (b-begin (aref list-element 2))
1493 (b-end (aref list-element 3))
1494 (state (aref list-element 4)))
1495 ;; place markers at the appropriate places in the buffers
1496 (emerge-eval-in-buffer
1497 A-buffer
d9021674 1498 (setq a-line (emerge-goto-line a-begin a-line))
3b4a6e27 1499 (setq a-begin-marker (point-marker))
d9021674 1500 (setq a-line (emerge-goto-line a-end a-line))
3b4a6e27
JB
1501 (setq a-end-marker (point-marker)))
1502 (emerge-eval-in-buffer
1503 B-buffer
d9021674 1504 (setq b-line (emerge-goto-line b-begin b-line))
3b4a6e27 1505 (setq b-begin-marker (point-marker))
d9021674 1506 (setq b-line (emerge-goto-line b-end b-line))
3b4a6e27
JB
1507 (setq b-end-marker (point-marker)))
1508 (setq merge-begin-marker (set-marker
1509 (make-marker)
1510 (- (marker-position a-begin-marker)
1511 offset)
1512 merge-buffer))
1513 (setq merge-end-marker (set-marker
1514 (make-marker)
1515 (- (marker-position a-end-marker)
1516 offset)
1517 merge-buffer))
1518 ;; record all the markers for this difference
1519 (setq marker-list (cons (vector a-begin-marker a-end-marker
1520 b-begin-marker b-end-marker
1521 merge-begin-marker merge-end-marker
1522 state)
1523 marker-list)))
1524 (setq lineno-list (cdr lineno-list)))
1525 ;; convert the list of difference information into a vector for
1526 ;; fast access
1527 (setq emerge-difference-list (apply 'vector (nreverse marker-list)))))
1528
71296446 1529;; If we have an ancestor, select all B variants that we prefer
3b4a6e27
JB
1530(defun emerge-select-prefer-Bs ()
1531 (let ((n 0))
1532 (while (< n emerge-number-of-differences)
1533 (if (eq (aref (aref emerge-difference-list n) 6) 'prefer-B)
1534 (progn
1535 (emerge-unselect-and-select-difference n t)
1536 (emerge-select-B)
1537 (aset (aref emerge-difference-list n) 6 'prefer-B)))
1538 (setq n (1+ n))))
1539 (emerge-unselect-and-select-difference -1))
1540
151e4b9c
RS
1541;; Process the local-variables list at the end of the merged file, if
1542;; requested.
1543(defun emerge-handle-local-variables ()
1544 (if emerge-process-local-variables
1545 (condition-case err
4a6e3980 1546 (hack-local-variables)
151e4b9c
RS
1547 (error (message "Local-variables error in merge buffer: %s"
1548 (prin1-to-string err))))))
1549
3b4a6e27
JB
1550;;; Common exit routines
1551
1552(defun emerge-write-and-delete (file-out)
1553 ;; clear screen format
1554 (delete-other-windows)
1555 ;; delete A, B, and ancestor buffers, if they haven't been changed
1556 (if (not (buffer-modified-p emerge-A-buffer))
1557 (kill-buffer emerge-A-buffer))
1558 (if (not (buffer-modified-p emerge-B-buffer))
1559 (kill-buffer emerge-B-buffer))
1560 (if (and emerge-ancestor-buffer
1561 (not (buffer-modified-p emerge-ancestor-buffer)))
1562 (kill-buffer emerge-ancestor-buffer))
1563 ;; Write merge buffer to file
737e3892
RS
1564 (and file-out
1565 (write-file file-out)))
3b4a6e27
JB
1566
1567;;; Commands
1568
1569(defun emerge-recenter (&optional arg)
737e3892
RS
1570 "Bring the highlighted region of all three merge buffers into view.
1571This brings the buffers into view if they are in windows.
1572With an argument, reestablish the default three-window display."
3b4a6e27
JB
1573 (interactive "P")
1574 ;; If there is an argument, rebuild the window structure
1575 (if arg
1576 (emerge-setup-windows emerge-A-buffer emerge-B-buffer
1577 emerge-merge-buffer))
1578 ;; Redisplay whatever buffers are showing, if there is a selected difference
1579 (if (and (>= emerge-current-difference 0)
1580 (< emerge-current-difference emerge-number-of-differences))
1581 (let* ((merge-buffer emerge-merge-buffer)
1582 (buffer-A emerge-A-buffer)
1583 (buffer-B emerge-B-buffer)
f405e887
RS
1584 (window-A (get-buffer-window buffer-A 'visible))
1585 (window-B (get-buffer-window buffer-B 'visible))
3b4a6e27
JB
1586 (merge-window (get-buffer-window merge-buffer))
1587 (diff-vector
1588 (aref emerge-difference-list emerge-current-difference)))
1589 (if window-A (progn
1590 (select-window window-A)
1591 (emerge-position-region
1592 (- (aref diff-vector 0)
1593 (1- emerge-before-flag-length))
1594 (+ (aref diff-vector 1)
1595 (1- emerge-after-flag-length))
1596 (1+ (aref diff-vector 0)))))
1597 (if window-B (progn
1598 (select-window window-B)
1599 (emerge-position-region
1600 (- (aref diff-vector 2)
1601 (1- emerge-before-flag-length))
1602 (+ (aref diff-vector 3)
1603 (1- emerge-after-flag-length))
1604 (1+ (aref diff-vector 2)))))
1605 (if merge-window (progn
1606 (select-window merge-window)
1607 (emerge-position-region
1608 (- (aref diff-vector 4)
1609 (1- emerge-before-flag-length))
1610 (+ (aref diff-vector 5)
1611 (1- emerge-after-flag-length))
1612 (1+ (aref diff-vector 4))))))))
1613
1614;;; Window scrolling operations
1615;; These operations are designed to scroll all three windows the same amount,
1616;; so as to keep the text in them aligned.
1617
1618;; Perform some operation on all three windows (if they are showing).
1619;; Catches all errors on the operation in the A and B windows, but not
1620;; in the merge window. Usually, errors come from scrolling off the
1621;; beginning or end of the buffer, and this gives a nice error message:
1622;; End of buffer is reported in the merge buffer, but if the scroll was
1623;; possible in the A or B windows, it is performed there before the error
1624;; is reported.
1625(defun emerge-operate-on-windows (operation arg)
1626 (let* ((merge-buffer emerge-merge-buffer)
1627 (buffer-A emerge-A-buffer)
1628 (buffer-B emerge-B-buffer)
f405e887
RS
1629 (window-A (get-buffer-window buffer-A 'visible))
1630 (window-B (get-buffer-window buffer-B 'visible))
3b4a6e27
JB
1631 (merge-window (get-buffer-window merge-buffer)))
1632 (if window-A (progn
1633 (select-window window-A)
1634 (condition-case nil
1635 (funcall operation arg)
1636 (error))))
1637 (if window-B (progn
1638 (select-window window-B)
1639 (condition-case nil
1640 (funcall operation arg)
1641 (error))))
1642 (if merge-window (progn
1643 (select-window merge-window)
1644 (funcall operation arg)))))
1645
1646(defun emerge-scroll-up (&optional arg)
1647 "Scroll up all three merge buffers, if they are in windows.
737e3892
RS
1648With argument N, scroll N lines; otherwise scroll by nearly
1649the height of the merge window.
1650`C-u -' alone as argument scrolls half the height of the merge window."
3b4a6e27
JB
1651 (interactive "P")
1652 (emerge-operate-on-windows
71296446 1653 'scroll-up
3b4a6e27
JB
1654 ;; calculate argument to scroll-up
1655 ;; if there is an explicit argument
1656 (if (and arg (not (equal arg '-)))
1657 ;; use it
1658 (prefix-numeric-value arg)
1659 ;; if not, see if we can determine a default amount (the window height)
1660 (let ((merge-window (get-buffer-window emerge-merge-buffer)))
1661 (if (null merge-window)
1662 ;; no window, use nil
1663 nil
1664 (let ((default-amount
1665 (- (window-height merge-window) 1 next-screen-context-lines)))
1666 ;; the window was found
1667 (if arg
1668 ;; C-u as argument means half of default amount
1669 (/ default-amount 2)
1670 ;; no argument means default amount
1671 default-amount)))))))
1672
1673(defun emerge-scroll-down (&optional arg)
1674 "Scroll down all three merge buffers, if they are in windows.
737e3892
RS
1675With argument N, scroll N lines; otherwise scroll by nearly
1676the height of the merge window.
1677`C-u -' alone as argument scrolls half the height of the merge window."
3b4a6e27
JB
1678 (interactive "P")
1679 (emerge-operate-on-windows
1680 'scroll-down
1681 ;; calculate argument to scroll-down
1682 ;; if there is an explicit argument
1683 (if (and arg (not (equal arg '-)))
1684 ;; use it
1685 (prefix-numeric-value arg)
1686 ;; if not, see if we can determine a default amount (the window height)
1687 (let ((merge-window (get-buffer-window emerge-merge-buffer)))
1688 (if (null merge-window)
1689 ;; no window, use nil
1690 nil
1691 (let ((default-amount
1692 (- (window-height merge-window) 1 next-screen-context-lines)))
1693 ;; the window was found
1694 (if arg
1695 ;; C-u as argument means half of default amount
1696 (/ default-amount 2)
1697 ;; no argument means default amount
1698 default-amount)))))))
1699
1700(defun emerge-scroll-left (&optional arg)
1701 "Scroll left all three merge buffers, if they are in windows.
737e3892 1702If an argument is given, that is how many columns are scrolled, else nearly
151e4b9c 1703the width of the A and B windows. `C-u -' alone as argument scrolls half the
3b4a6e27
JB
1704width of the A and B windows."
1705 (interactive "P")
1706 (emerge-operate-on-windows
1707 'scroll-left
1708 ;; calculate argument to scroll-left
1709 ;; if there is an explicit argument
1710 (if (and arg (not (equal arg '-)))
1711 ;; use it
1712 (prefix-numeric-value arg)
1713 ;; if not, see if we can determine a default amount
1714 ;; (half the window width)
1715 (let ((merge-window (get-buffer-window emerge-merge-buffer)))
1716 (if (null merge-window)
1717 ;; no window, use nil
1718 nil
1719 (let ((default-amount
1720 (- (/ (window-width merge-window) 2) 3)))
1721 ;; the window was found
1722 (if arg
1723 ;; C-u as argument means half of default amount
1724 (/ default-amount 2)
1725 ;; no argument means default amount
1726 default-amount)))))))
1727
1728(defun emerge-scroll-right (&optional arg)
1729 "Scroll right all three merge buffers, if they are in windows.
737e3892 1730If an argument is given, that is how many columns are scrolled, else nearly
151e4b9c 1731the width of the A and B windows. `C-u -' alone as argument scrolls half the
3b4a6e27
JB
1732width of the A and B windows."
1733 (interactive "P")
1734 (emerge-operate-on-windows
1735 'scroll-right
1736 ;; calculate argument to scroll-right
1737 ;; if there is an explicit argument
1738 (if (and arg (not (equal arg '-)))
1739 ;; use it
1740 (prefix-numeric-value arg)
1741 ;; if not, see if we can determine a default amount
1742 ;; (half the window width)
1743 (let ((merge-window (get-buffer-window emerge-merge-buffer)))
1744 (if (null merge-window)
1745 ;; no window, use nil
1746 nil
1747 (let ((default-amount
1748 (- (/ (window-width merge-window) 2) 3)))
1749 ;; the window was found
1750 (if arg
1751 ;; C-u as argument means half of default amount
1752 (/ default-amount 2)
1753 ;; no argument means default amount
1754 default-amount)))))))
1755
1756(defun emerge-scroll-reset ()
737e3892
RS
1757 "Reset horizontal scrolling in Emerge.
1758This resets the horizontal scrolling of all three merge buffers
1759to the left margin, if they are in windows."
3b4a6e27
JB
1760 (interactive)
1761 (emerge-operate-on-windows
1762 (function (lambda (x) (set-window-hscroll (selected-window) 0)))
1763 nil))
1764
1765;; Attempt to show the region nicely.
1766;; If there are min-lines lines above and below the region, then don't do
1767;; anything.
1768;; If not, recenter the region to make it so.
a7acbbe4 1769;; If that isn't possible, remove context lines balancedly from top and bottom
3b4a6e27
JB
1770;; so the entire region shows.
1771;; If that isn't possible, show the top of the region.
1772;; BEG must be at the beginning of a line.
1773(defun emerge-position-region (beg end pos)
1774 ;; First test whether the entire region is visible with
1775 ;; emerge-min-visible-lines above and below it
1776 (if (not (and (<= (progn
1777 (move-to-window-line emerge-min-visible-lines)
1778 (point))
1779 beg)
1780 (<= end (progn
1781 (move-to-window-line
1782 (- (1+ emerge-min-visible-lines)))
1783 (point)))))
1784 ;; We failed that test, see if it fits at all
1785 ;; Meanwhile positioning it correctly in case it doesn't fit
1786 (progn
1787 (set-window-start (selected-window) beg)
151e4b9c 1788 (if (pos-visible-in-window-p end)
3b4a6e27
JB
1789 ;; Determine the number of lines that the region occupies
1790 (let ((lines 0))
1791 (while (> end (progn
1792 (move-to-window-line lines)
1793 (point)))
1794 (setq lines (1+ lines)))
1795 ;; And position the beginning on the right line
1796 (goto-char beg)
1797 (recenter (/ (1+ (- (1- (window-height (selected-window)))
1798 lines))
1799 2))))))
1800 (goto-char pos))
1801
1802(defun emerge-next-difference ()
1803 "Advance to the next difference."
1804 (interactive)
1805 (if (< emerge-current-difference emerge-number-of-differences)
1806 (let ((n (1+ emerge-current-difference)))
1807 (while (and emerge-skip-prefers
1808 (< n emerge-number-of-differences)
1809 (memq (aref (aref emerge-difference-list n) 6)
1810 '(prefer-A prefer-B)))
1811 (setq n (1+ n)))
1812 (let ((buffer-read-only nil))
1813 (emerge-unselect-and-select-difference n)))
1814 (error "At end")))
1815
1816(defun emerge-previous-difference ()
1817 "Go to the previous difference."
1818 (interactive)
1819 (if (> emerge-current-difference -1)
1820 (let ((n (1- emerge-current-difference)))
1821 (while (and emerge-skip-prefers
1822 (> n -1)
1823 (memq (aref (aref emerge-difference-list n) 6)
1824 '(prefer-A prefer-B)))
1825 (setq n (1- n)))
1826 (let ((buffer-read-only nil))
1827 (emerge-unselect-and-select-difference n)))
1828 (error "At beginning")))
1829
1830(defun emerge-jump-to-difference (difference-number)
1831 "Go to the N-th difference."
1832 (interactive "p")
1833 (let ((buffer-read-only nil))
1834 (setq difference-number (1- difference-number))
1835 (if (and (>= difference-number -1)
1836 (< difference-number (1+ emerge-number-of-differences)))
1837 (emerge-unselect-and-select-difference difference-number)
1838 (error "Bad difference number"))))
1839
737e3892
RS
1840(defun emerge-abort ()
1841 "Abort the Emerge session."
1842 (interactive)
1843 (emerge-quit t))
1844
3b4a6e27 1845(defun emerge-quit (arg)
737e3892
RS
1846 "Finish the Emerge session and exit Emerge.
1847Prefix argument means to abort rather than successfully finish.
1848The difference depends on how the merge was started,
3b4a6e27
JB
1849but usually means to not write over one of the original files, or to signal
1850to some process which invoked Emerge a failure code.
1851
1852Unselects the selected difference, if any, restores the read-only and modified
1853flags of the merged file buffers, restores the local keymap of the merge
1854buffer, and sets off various emerge flags. Using Emerge commands in this
1855buffer after this will cause serious problems."
1856 (interactive "P")
1857 (if (prog1
1858 (y-or-n-p
1859 (if (not arg)
1860 "Do you really want to successfully finish this merge? "
1861 "Do you really want to abort this merge? "))
1862 (message ""))
1863 (emerge-really-quit arg)))
1864
1865;; Perform the quit operations.
1866(defun emerge-really-quit (arg)
1867 (setq buffer-read-only nil)
1868 (emerge-unselect-and-select-difference -1)
1869 (emerge-restore-buffer-characteristics)
1870 ;; null out the difference markers so they don't slow down future editing
1871 ;; operations
82af6312
JB
1872 (mapc (function (lambda (d)
1873 (set-marker (aref d 0) nil)
1874 (set-marker (aref d 1) nil)
1875 (set-marker (aref d 2) nil)
1876 (set-marker (aref d 3) nil)
1877 (set-marker (aref d 4) nil)
1878 (set-marker (aref d 5) nil)))
3b4a6e27
JB
1879 emerge-difference-list)
1880 ;; allow them to be garbage collected
1881 (setq emerge-difference-list nil)
1882 ;; restore the local map
1883 (use-local-map emerge-old-keymap)
1884 ;; turn off all the emerge modes
1885 (setq emerge-mode nil)
1886 (setq emerge-fast-mode nil)
1887 (setq emerge-edit-mode nil)
1888 (setq emerge-auto-advance nil)
1889 (setq emerge-skip-prefers nil)
1890 ;; restore mode line
1891 (kill-local-variable 'mode-line-buffer-identification)
1892 (let ((emerge-prefix-argument arg))
737e3892 1893 (run-hooks 'emerge-quit-hook)))
3b4a6e27
JB
1894
1895(defun emerge-select-A (&optional force)
71296446 1896 "Select the A variant of this difference.
737e3892
RS
1897Refuses to function if this difference has been edited, i.e., if it
1898is neither the A nor the B variant.
1899A prefix argument forces the variant to be selected
1900even if the difference has been edited."
3b4a6e27
JB
1901 (interactive "P")
1902 (let ((operate
1903 (function (lambda ()
1904 (emerge-select-A-edit merge-begin merge-end A-begin A-end)
1905 (if emerge-auto-advance
1906 (emerge-next-difference)))))
1907 (operate-no-change
1908 (function (lambda ()
1909 (if emerge-auto-advance
1910 (emerge-next-difference))))))
1911 (emerge-select-version force operate-no-change operate operate)))
1912
1913;; Actually select the A variant
1914(defun emerge-select-A-edit (merge-begin merge-end A-begin A-end)
1915 (emerge-eval-in-buffer
1916 emerge-merge-buffer
1917 (delete-region merge-begin merge-end)
1918 (goto-char merge-begin)
1919 (insert-buffer-substring emerge-A-buffer A-begin A-end)
1920 (goto-char merge-begin)
1921 (aset diff-vector 6 'A)
1922 (emerge-refresh-mode-line)))
1923
1924(defun emerge-select-B (&optional force)
737e3892
RS
1925 "Select the B variant of this difference.
1926Refuses to function if this difference has been edited, i.e., if it
1927is neither the A nor the B variant.
1928A prefix argument forces the variant to be selected
1929even if the difference has been edited."
3b4a6e27
JB
1930 (interactive "P")
1931 (let ((operate
1932 (function (lambda ()
1933 (emerge-select-B-edit merge-begin merge-end B-begin B-end)
1934 (if emerge-auto-advance
1935 (emerge-next-difference)))))
1936 (operate-no-change
1937 (function (lambda ()
1938 (if emerge-auto-advance
1939 (emerge-next-difference))))))
1940 (emerge-select-version force operate operate-no-change operate)))
1941
1942;; Actually select the B variant
1943(defun emerge-select-B-edit (merge-begin merge-end B-begin B-end)
1944 (emerge-eval-in-buffer
1945 emerge-merge-buffer
1946 (delete-region merge-begin merge-end)
1947 (goto-char merge-begin)
1948 (insert-buffer-substring emerge-B-buffer B-begin B-end)
1949 (goto-char merge-begin)
1950 (aset diff-vector 6 'B)
1951 (emerge-refresh-mode-line)))
1952
1953(defun emerge-default-A ()
737e3892
RS
1954 "Make the A variant the default from here down.
1955This selects the A variant for all differences from here down in the buffer
3b4a6e27
JB
1956which are still defaulted, i.e., which the user has not selected and for
1957which there is no preference."
1958 (interactive)
1959 (let ((buffer-read-only nil))
1960 (let ((selected-difference emerge-current-difference)
1961 (n (max emerge-current-difference 0)))
1962 (while (< n emerge-number-of-differences)
1963 (let ((diff-vector (aref emerge-difference-list n)))
1964 (if (eq (aref diff-vector 6) 'default-B)
1965 (progn
1966 (emerge-unselect-and-select-difference n t)
1967 (emerge-select-A)
1968 (aset diff-vector 6 'default-A))))
1969 (setq n (1+ n))
e00fcc05 1970 (if (zerop (% n 10))
3b4a6e27
JB
1971 (message "Setting default to A...%d" n)))
1972 (emerge-unselect-and-select-difference selected-difference)))
ff5f6ddd 1973 (message "Default choice is now A"))
3b4a6e27
JB
1974
1975(defun emerge-default-B ()
737e3892
RS
1976 "Make the B variant the default from here down.
1977This selects the B variant for all differences from here down in the buffer
3b4a6e27
JB
1978which are still defaulted, i.e., which the user has not selected and for
1979which there is no preference."
1980 (interactive)
1981 (let ((buffer-read-only nil))
1982 (let ((selected-difference emerge-current-difference)
1983 (n (max emerge-current-difference 0)))
1984 (while (< n emerge-number-of-differences)
1985 (let ((diff-vector (aref emerge-difference-list n)))
1986 (if (eq (aref diff-vector 6) 'default-A)
1987 (progn
1988 (emerge-unselect-and-select-difference n t)
1989 (emerge-select-B)
1990 (aset diff-vector 6 'default-B))))
1991 (setq n (1+ n))
e00fcc05 1992 (if (zerop (% n 10))
3b4a6e27
JB
1993 (message "Setting default to B...%d" n)))
1994 (emerge-unselect-and-select-difference selected-difference)))
ff5f6ddd 1995 (message "Default choice is now B"))
3b4a6e27
JB
1996
1997(defun emerge-fast-mode ()
737e3892
RS
1998 "Set fast mode, for Emerge.
1999In this mode ordinary Emacs commands are disabled, and Emerge commands
2000need not be prefixed with \\<emerge-fast-keymap>\\[emerge-basic-keymap]."
3b4a6e27
JB
2001 (interactive)
2002 (setq buffer-read-only t)
2003 (use-local-map emerge-fast-keymap)
2004 (setq emerge-mode t)
2005 (setq emerge-fast-mode t)
2006 (setq emerge-edit-mode nil)
2007 (message "Fast mode set")
ec165e56 2008 (force-mode-line-update))
3b4a6e27
JB
2009
2010(defun emerge-edit-mode ()
737e3892
RS
2011 "Set edit mode, for Emerge.
2012In this mode ordinary Emacs commands are available, and Emerge commands
2013must be prefixed with \\<emerge-fast-keymap>\\[emerge-basic-keymap]."
3b4a6e27
JB
2014 (interactive)
2015 (setq buffer-read-only nil)
2016 (use-local-map emerge-edit-keymap)
2017 (setq emerge-mode t)
2018 (setq emerge-fast-mode nil)
2019 (setq emerge-edit-mode t)
2020 (message "Edit mode set")
ec165e56 2021 (force-mode-line-update))
3b4a6e27
JB
2022
2023(defun emerge-auto-advance (arg)
737e3892
RS
2024 "Toggle Auto-Advance mode, for Emerge.
2025This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2026advance to the next difference.
2027With a positive argument, turn on Auto-Advance mode.
2028With a negative argument, turn off Auto-Advance mode."
3b4a6e27
JB
2029 (interactive "P")
2030 (setq emerge-auto-advance (if (null arg)
2031 (not emerge-auto-advance)
2032 (> (prefix-numeric-value arg) 0)))
c880b9d5 2033 (message (if emerge-auto-advance
3b4a6e27
JB
2034 "Auto-advance set"
2035 "Auto-advance cleared"))
ec165e56 2036 (force-mode-line-update))
3b4a6e27
JB
2037
2038(defun emerge-skip-prefers (arg)
737e3892
RS
2039 "Toggle Skip-Prefers mode, for Emerge.
2040This mode causes `emerge-next-difference' and `emerge-previous-difference'
2041to automatically skip over differences for which there is a preference.
2042With a positive argument, turn on Skip-Prefers mode.
2043With a negative argument, turn off Skip-Prefers mode."
3b4a6e27
JB
2044 (interactive "P")
2045 (setq emerge-skip-prefers (if (null arg)
2046 (not emerge-skip-prefers)
2047 (> (prefix-numeric-value arg) 0)))
2048 (message (if emerge-skip-prefers
2049 "Skip-prefers set"
2050 "Skip-prefers cleared"))
ec165e56 2051 (force-mode-line-update))
3b4a6e27
JB
2052
2053(defun emerge-copy-as-kill-A ()
2054 "Put the A variant of this difference in the kill ring."
2055 (interactive)
2056 (emerge-validate-difference)
2057 (let* ((diff-vector
2058 (aref emerge-difference-list emerge-current-difference))
2059 (A-begin (1+ (aref diff-vector 0)))
2060 (A-end (1- (aref diff-vector 1)))
2061 ;; so further kills don't append
2062 this-command)
7fdbcd83 2063 (with-current-buffer emerge-A-buffer
3b4a6e27
JB
2064 (copy-region-as-kill A-begin A-end))))
2065
2066(defun emerge-copy-as-kill-B ()
2067 "Put the B variant of this difference in the kill ring."
2068 (interactive)
2069 (emerge-validate-difference)
2070 (let* ((diff-vector
2071 (aref emerge-difference-list emerge-current-difference))
2072 (B-begin (1+ (aref diff-vector 2)))
2073 (B-end (1- (aref diff-vector 3)))
2074 ;; so further kills don't append
2075 this-command)
7fdbcd83 2076 (with-current-buffer emerge-B-buffer
3b4a6e27
JB
2077 (copy-region-as-kill B-begin B-end))))
2078
2079(defun emerge-insert-A (arg)
2080 "Insert the A variant of this difference at the point.
2081Leaves point after text, mark before.
2082With prefix argument, puts point before, mark after."
2083 (interactive "P")
2084 (emerge-validate-difference)
2085 (let* ((diff-vector
2086 (aref emerge-difference-list emerge-current-difference))
2087 (A-begin (1+ (aref diff-vector 0)))
2088 (A-end (1- (aref diff-vector 1)))
2089 (opoint (point))
2090 (buffer-read-only nil))
2091 (insert-buffer-substring emerge-A-buffer A-begin A-end)
2092 (if (not arg)
2093 (set-mark opoint)
2094 (set-mark (point))
2095 (goto-char opoint))))
2096
2097(defun emerge-insert-B (arg)
2098 "Insert the B variant of this difference at the point.
2099Leaves point after text, mark before.
2100With prefix argument, puts point before, mark after."
2101 (interactive "P")
2102 (emerge-validate-difference)
2103 (let* ((diff-vector
2104 (aref emerge-difference-list emerge-current-difference))
2105 (B-begin (1+ (aref diff-vector 2)))
2106 (B-end (1- (aref diff-vector 3)))
2107 (opoint (point))
2108 (buffer-read-only nil))
2109 (insert-buffer-substring emerge-B-buffer B-begin B-end)
2110 (if (not arg)
2111 (set-mark opoint)
2112 (set-mark (point))
2113 (goto-char opoint))))
2114
2115(defun emerge-mark-difference (arg)
2116 "Leaves the point before this difference and the mark after it.
2117With prefix argument, puts mark before, point after."
2118 (interactive "P")
2119 (emerge-validate-difference)
2120 (let* ((diff-vector
2121 (aref emerge-difference-list emerge-current-difference))
2122 (merge-begin (1+ (aref diff-vector 4)))
2123 (merge-end (1- (aref diff-vector 5))))
2124 (if (not arg)
2125 (progn
2126 (goto-char merge-begin)
2127 (set-mark merge-end))
2128 (goto-char merge-end)
2129 (set-mark merge-begin))))
2130
2131(defun emerge-file-names ()
2132 "Show the names of the buffers or files being operated on by Emerge.
737e3892 2133Use C-u l to reset the windows afterward."
3b4a6e27
JB
2134 (interactive)
2135 (delete-other-windows)
737e3892 2136 (let ((temp-buffer-show-function
3b4a6e27
JB
2137 (function (lambda (buf)
2138 (split-window-vertically)
2139 (switch-to-buffer buf)
2140 (other-window 1)))))
2141 (with-output-to-temp-buffer "*Help*"
2142 (emerge-eval-in-buffer emerge-A-buffer
2143 (if buffer-file-name
2144 (progn
2145 (princ "File A is: ")
2146 (princ buffer-file-name))
2147 (progn
2148 (princ "Buffer A is: ")
2149 (princ (buffer-name))))
2150 (princ "\n"))
2151 (emerge-eval-in-buffer emerge-B-buffer
2152 (if buffer-file-name
2153 (progn
2154 (princ "File B is: ")
2155 (princ buffer-file-name))
2156 (progn
2157 (princ "Buffer B is: ")
2158 (princ (buffer-name))))
2159 (princ "\n"))
2160 (if emerge-ancestor-buffer
2161 (emerge-eval-in-buffer emerge-ancestor-buffer
2162 (if buffer-file-name
2163 (progn
2164 (princ "Ancestor file is: ")
2165 (princ buffer-file-name))
2166 (progn
2167 (princ "Ancestor buffer is: ")
2168 (princ (buffer-name))))
2169 (princ "\n")))
62f72ce0 2170 (princ emerge-output-description)
7fdbcd83 2171 (with-current-buffer standard-output
62f72ce0 2172 (help-mode)))))
3b4a6e27
JB
2173
2174(defun emerge-join-differences (arg)
737e3892 2175 "Join the selected difference with the following one.
eb8c3be9 2176With a prefix argument, join with the preceding one."
3b4a6e27
JB
2177 (interactive "P")
2178 (let ((n emerge-current-difference))
2179 ;; adjust n to be first difference to join
2180 (if arg
2181 (setq n (1- n)))
2182 ;; n and n+1 are the differences to join
2183 ;; check that they are both differences
2184 (if (or (< n 0) (>= n (1- emerge-number-of-differences)))
2185 (error "Incorrect differences to join"))
2186 ;; remove the flags
2187 (emerge-unselect-difference emerge-current-difference)
2188 ;; decrement total number of differences
2189 (setq emerge-number-of-differences (1- emerge-number-of-differences))
2190 ;; build new differences vector
2191 (let ((i 0)
2192 (new-differences (make-vector emerge-number-of-differences nil)))
2193 (while (< i emerge-number-of-differences)
2194 (aset new-differences i
2195 (cond
2196 ((< i n) (aref emerge-difference-list i))
2197 ((> i n) (aref emerge-difference-list (1+ i)))
2198 (t (let ((prev (aref emerge-difference-list i))
2199 (next (aref emerge-difference-list (1+ i))))
2200 (vector (aref prev 0)
2201 (aref next 1)
2202 (aref prev 2)
2203 (aref next 3)
2204 (aref prev 4)
2205 (aref next 5)
2206 (let ((ps (aref prev 6))
2207 (ns (aref next 6)))
2208 (cond
2209 ((eq ps ns)
2210 ps)
2211 ((and (or (eq ps 'B) (eq ps 'prefer-B))
2212 (or (eq ns 'B) (eq ns 'prefer-B)))
2213 'B)
2214 (t 'A))))))))
2215 (setq i (1+ i)))
2216 (setq emerge-difference-list new-differences))
2217 ;; set the current difference correctly
2218 (setq emerge-current-difference n)
2219 ;; fix the mode line
2220 (emerge-refresh-mode-line)
2221 ;; reinsert the flags
2222 (emerge-select-difference emerge-current-difference)
2223 (emerge-recenter)))
2224
2225(defun emerge-split-difference ()
2226 "Split the current difference where the points are in the three windows."
2227 (interactive)
2228 (let ((n emerge-current-difference))
2229 ;; check that this is a valid difference
2230 (emerge-validate-difference)
2231 ;; get the point values and old difference
2232 (let ((A-point (emerge-eval-in-buffer emerge-A-buffer
2233 (point-marker)))
2234 (B-point (emerge-eval-in-buffer emerge-B-buffer
2235 (point-marker)))
2236 (merge-point (point-marker))
2237 (old-diff (aref emerge-difference-list n)))
2238 ;; check location of the points, give error if they aren't in the
2239 ;; differences
2240 (if (or (< A-point (aref old-diff 0))
2241 (> A-point (aref old-diff 1)))
2242 (error "Point outside of difference in A buffer"))
2243 (if (or (< B-point (aref old-diff 2))
2244 (> B-point (aref old-diff 3)))
2245 (error "Point outside of difference in B buffer"))
2246 (if (or (< merge-point (aref old-diff 4))
2247 (> merge-point (aref old-diff 5)))
2248 (error "Point outside of difference in merge buffer"))
2249 ;; remove the flags
2250 (emerge-unselect-difference emerge-current-difference)
2251 ;; increment total number of differences
2252 (setq emerge-number-of-differences (1+ emerge-number-of-differences))
2253 ;; build new differences vector
2254 (let ((i 0)
2255 (new-differences (make-vector emerge-number-of-differences nil)))
2256 (while (< i emerge-number-of-differences)
2257 (aset new-differences i
2258 (cond
2259 ((< i n)
2260 (aref emerge-difference-list i))
2261 ((> i (1+ n))
2262 (aref emerge-difference-list (1- i)))
2263 ((= i n)
2264 (vector (aref old-diff 0)
2265 A-point
2266 (aref old-diff 2)
2267 B-point
2268 (aref old-diff 4)
2269 merge-point
2270 (aref old-diff 6)))
2271 (t
2272 (vector (copy-marker A-point)
2273 (aref old-diff 1)
2274 (copy-marker B-point)
2275 (aref old-diff 3)
2276 (copy-marker merge-point)
2277 (aref old-diff 5)
2278 (aref old-diff 6)))))
2279 (setq i (1+ i)))
2280 (setq emerge-difference-list new-differences))
2281 ;; set the current difference correctly
2282 (setq emerge-current-difference n)
2283 ;; fix the mode line
2284 (emerge-refresh-mode-line)
2285 ;; reinsert the flags
2286 (emerge-select-difference emerge-current-difference)
2287 (emerge-recenter))))
2288
2289(defun emerge-trim-difference ()
737e3892
RS
2290 "Trim lines off top and bottom of difference that are the same.
2291If lines are the same in both the A and the B versions, strip them off.
2292\(This can happen when the A and B versions have common lines that the
2293ancestor version does not share.)"
3b4a6e27
JB
2294 (interactive)
2295 ;; make sure we are in a real difference
2296 (emerge-validate-difference)
2297 ;; remove the flags
2298 (emerge-unselect-difference emerge-current-difference)
2299 (let* ((diff (aref emerge-difference-list emerge-current-difference))
2300 (top-a (marker-position (aref diff 0)))
2301 (bottom-a (marker-position (aref diff 1)))
2302 (top-b (marker-position (aref diff 2)))
2303 (bottom-b (marker-position (aref diff 3)))
2304 (top-m (marker-position (aref diff 4)))
2305 (bottom-m (marker-position (aref diff 5)))
2306 size success sa sb sm)
2307 ;; move down the tops of the difference regions as much as possible
2308 ;; Try advancing comparing 1000 chars at a time.
2309 ;; When that fails, go 500 chars at a time, and so on.
2310 (setq size 1000)
2311 (while (> size 0)
2312 (setq success t)
2313 (while success
2314 (setq size (min size (- bottom-a top-a) (- bottom-b top-b)
2315 (- bottom-m top-m)))
2316 (setq sa (emerge-eval-in-buffer emerge-A-buffer
2317 (buffer-substring top-a
2318 (+ size top-a))))
2319 (setq sb (emerge-eval-in-buffer emerge-B-buffer
2320 (buffer-substring top-b
2321 (+ size top-b))))
2322 (setq sm (buffer-substring top-m (+ size top-m)))
2323 (setq success (and (> size 0) (equal sa sb) (equal sb sm)))
2324 (if success
2325 (setq top-a (+ top-a size)
2326 top-b (+ top-b size)
2327 top-m (+ top-m size))))
2328 (setq size (/ size 2)))
2329 ;; move up the bottoms of the difference regions as much as possible
2330 ;; Try advancing comparing 1000 chars at a time.
2331 ;; When that fails, go 500 chars at a time, and so on.
2332 (setq size 1000)
2333 (while (> size 0)
2334 (setq success t)
2335 (while success
2336 (setq size (min size (- bottom-a top-a) (- bottom-b top-b)
2337 (- bottom-m top-m)))
2338 (setq sa (emerge-eval-in-buffer emerge-A-buffer
2339 (buffer-substring (- bottom-a size)
2340 bottom-a)))
2341 (setq sb (emerge-eval-in-buffer emerge-B-buffer
2342 (buffer-substring (- bottom-b size)
2343 bottom-b)))
2344 (setq sm (buffer-substring (- bottom-m size) bottom-m))
2345 (setq success (and (> size 0) (equal sa sb) (equal sb sm)))
2346 (if success
2347 (setq bottom-a (- bottom-a size)
2348 bottom-b (- bottom-b size)
2349 bottom-m (- bottom-m size))))
2350 (setq size (/ size 2)))
2351 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2352 ;; of the difference regions. Move them to the beginning of lines, as
2353 ;; appropriate.
2354 (emerge-eval-in-buffer emerge-A-buffer
2355 (goto-char top-a)
2356 (beginning-of-line)
2357 (aset diff 0 (point-marker))
2358 (goto-char bottom-a)
2359 (beginning-of-line 2)
2360 (aset diff 1 (point-marker)))
2361 (emerge-eval-in-buffer emerge-B-buffer
2362 (goto-char top-b)
2363 (beginning-of-line)
2364 (aset diff 2 (point-marker))
2365 (goto-char bottom-b)
2366 (beginning-of-line 2)
2367 (aset diff 3 (point-marker)))
2368 (goto-char top-m)
2369 (beginning-of-line)
2370 (aset diff 4 (point-marker))
2371 (goto-char bottom-m)
2372 (beginning-of-line 2)
2373 (aset diff 5 (point-marker))
2374 ;; put the flags back in, recenter the display
2375 (emerge-select-difference emerge-current-difference)
2376 (emerge-recenter)))
2377
623a8830
GM
2378;; FIXME the manual advertised this as working in the A or B buffers,
2379;; but it does not, because all the buffer locals are nil there.
2380;; It would work to call it from the merge buffer and specify that one
2381;; wants to use the value of point in the A or B buffer.
2382;; But with the prefix argument already in use, there is no easy way
2383;; to have it ask for a buffer.
3b4a6e27
JB
2384(defun emerge-find-difference (arg)
2385 "Find the difference containing the current position of the point.
2386If there is no containing difference and the prefix argument is positive,
2387it finds the nearest following difference. A negative prefix argument finds
661d3230 2388the nearest previous difference."
8bfce8a7 2389 (interactive "P")
661d3230
RS
2390 (cond ((eq (current-buffer) emerge-A-buffer)
2391 (emerge-find-difference-A arg))
2392 ((eq (current-buffer) emerge-B-buffer)
2393 (emerge-find-difference-B arg))
2394 (t (emerge-find-difference-merge arg))))
2395
2396(defun emerge-find-difference-merge (arg)
2397 "Find the difference containing point, in the merge buffer.
2398If there is no containing difference and the prefix argument is positive,
2399it finds the nearest following difference. A negative prefix argument finds
3b4a6e27
JB
2400the nearest previous difference."
2401 (interactive "P")
2402 ;; search for the point in the merge buffer, using the markers
2403 ;; for the beginning and end of the differences in the merge buffer
2404 (emerge-find-difference1 arg (point) 4 5))
2405
2406(defun emerge-find-difference-A (arg)
661d3230 2407 "Find the difference containing point, in the A buffer.
737e3892 2408This command must be executed in the merge buffer.
3b4a6e27
JB
2409If there is no containing difference and the prefix argument is positive,
2410it finds the nearest following difference. A negative prefix argument finds
2411the nearest previous difference."
2412 (interactive "P")
2413 ;; search for the point in the A buffer, using the markers
2414 ;; for the beginning and end of the differences in the A buffer
2415 (emerge-find-difference1 arg
2416 (emerge-eval-in-buffer emerge-A-buffer (point))
2417 0 1))
2418
2419(defun emerge-find-difference-B (arg)
661d3230 2420 "Find the difference containing point, in the B buffer.
737e3892 2421This command must be executed in the merge buffer.
3b4a6e27
JB
2422If there is no containing difference and the prefix argument is positive,
2423it finds the nearest following difference. A negative prefix argument finds
2424the nearest previous difference."
2425 (interactive "P")
2426 ;; search for the point in the B buffer, using the markers
2427 ;; for the beginning and end of the differences in the B buffer
2428 (emerge-find-difference1 arg
2429 (emerge-eval-in-buffer emerge-B-buffer (point))
2430 2 3))
2431
2432(defun emerge-find-difference1 (arg location begin end)
2433 (let* ((index
2434 ;; find first difference containing or after the current position
2435 (catch 'search
2436 (let ((n 0))
2437 (while (< n emerge-number-of-differences)
2438 (let ((diff-vector (aref emerge-difference-list n)))
2439 (if (<= location (marker-position (aref diff-vector end)))
2440 (throw 'search n)))
2441 (setq n (1+ n))))
2442 emerge-number-of-differences))
2443 (contains
2444 ;; whether the found difference contains the current position
2445 (and (< index emerge-number-of-differences)
2446 (<= (marker-position (aref (aref emerge-difference-list index)
2447 begin))
2448 location)))
2449 (arg-value
2450 ;; numeric value of prefix argument
2451 (prefix-numeric-value arg)))
2452 (emerge-unselect-and-select-difference
2453 (cond
2454 ;; if the point is in a difference, select it
2455 (contains index)
2456 ;; if the arg is nil and the point is not in a difference, error
2457 ((null arg) (error "No difference contains point"))
2458 ;; if the arg is positive, select the following difference
2459 ((> arg-value 0)
2460 (if (< index emerge-number-of-differences)
2461 index
2462 (error "No difference contains or follows point")))
eb8c3be9 2463 ;; if the arg is negative, select the preceding difference
3b4a6e27
JB
2464 (t
2465 (if (> index 0)
2466 (1- index)
eb8c3be9 2467 (error "No difference contains or precedes point")))))))
3b4a6e27
JB
2468
2469(defun emerge-line-numbers ()
737e3892
RS
2470 "Display the current line numbers.
2471This function displays the line numbers of the points in the A, B, and
3b4a6e27
JB
2472merge buffers."
2473 (interactive)
2474 (let* ((valid-diff
2475 (and (>= emerge-current-difference 0)
2476 (< emerge-current-difference emerge-number-of-differences)))
2477 (diff (and valid-diff
2478 (aref emerge-difference-list emerge-current-difference)))
2479 (merge-line (emerge-line-number-in-buf 4 5))
2480 (A-line (emerge-eval-in-buffer emerge-A-buffer
2481 (emerge-line-number-in-buf 0 1)))
2482 (B-line (emerge-eval-in-buffer emerge-B-buffer
2483 (emerge-line-number-in-buf 2 3))))
2484 (message "At lines: merge = %d, A = %d, B = %d"
2485 merge-line A-line B-line)))
2486
2487(defun emerge-line-number-in-buf (begin-marker end-marker)
2488 (let (temp)
2489 (setq temp (save-excursion
2490 (beginning-of-line)
2491 (1+ (count-lines 1 (point)))))
2492 (if valid-diff
2493 (progn
2494 (if (> (point) (aref diff begin-marker))
2495 (setq temp (- temp emerge-before-flag-lines)))
2496 (if (> (point) (aref diff end-marker))
2497 (setq temp (- temp emerge-after-flag-lines)))))
2498 temp))
2499
ff5f6ddd
RS
2500(defun emerge-set-combine-template (string &optional localize)
2501 "Set `emerge-combine-versions-template' to STRING.
2502This value controls how `emerge-combine-versions' combines the two versions.
2503With prefix argument, `emerge-combine-versions-template' is made local to this
2504merge buffer. Localization is permanent for any particular merge buffer."
2505 (interactive "s\nP")
2506 (if localize
2507 (make-local-variable 'emerge-combine-versions-template))
2508 (setq emerge-combine-versions-template string)
2509 (message
2510 (if (assq 'emerge-combine-versions-template (buffer-local-variables))
2511 "emerge-set-combine-versions-template set locally"
2512 "emerge-set-combine-versions-template set")))
2513
3b4a6e27 2514(defun emerge-set-combine-versions-template (start end &optional localize)
737e3892
RS
2515 "Copy region into `emerge-combine-versions-template'.
2516This controls how `emerge-combine-versions' will combine the two versions.
ff5f6ddd 2517With prefix argument, `emerge-combine-versions-template' is made local to this
3b4a6e27
JB
2518merge buffer. Localization is permanent for any particular merge buffer."
2519 (interactive "r\nP")
2520 (if localize
2521 (make-local-variable 'emerge-combine-versions-template))
2522 (setq emerge-combine-versions-template (buffer-substring start end))
2523 (message
2524 (if (assq 'emerge-combine-versions-template (buffer-local-variables))
2525 "emerge-set-combine-versions-template set locally."
2526 "emerge-set-combine-versions-template set.")))
2527
2528(defun emerge-combine-versions (&optional force)
737e3892 2529 "Combine versions using the template in `emerge-combine-versions-template'.
3b4a6e27
JB
2530Refuses to function if this difference has been edited, i.e., if it is
2531neither the A nor the B variant.
737e3892 2532An argument forces the variant to be selected even if the difference has
3b4a6e27
JB
2533been edited."
2534 (interactive "P")
2535 (emerge-combine-versions-internal emerge-combine-versions-template force))
2536
2537(defun emerge-combine-versions-register (char &optional force)
2538 "Combine the two versions using the template in register REG.
737e3892 2539See documentation of the variable `emerge-combine-versions-template'
3b4a6e27
JB
2540for how the template is interpreted.
2541Refuses to function if this difference has been edited, i.e., if it is
2542neither the A nor the B variant.
737e3892 2543An argument forces the variant to be selected even if the difference has
3b4a6e27
JB
2544been edited."
2545 (interactive "cRegister containing template: \nP")
2546 (let ((template (get-register char)))
2547 (if (not (stringp template))
2548 (error "Register does not contain text"))
2549 (emerge-combine-versions-internal template force)))
2550
2551(defun emerge-combine-versions-internal (template force)
2552 (let ((operate
2553 (function (lambda ()
2554 (emerge-combine-versions-edit merge-begin merge-end
2555 A-begin A-end B-begin B-end)
2556 (if emerge-auto-advance
2557 (emerge-next-difference))))))
2558 (emerge-select-version force operate operate operate)))
2559
2560(defun emerge-combine-versions-edit (merge-begin merge-end
2561 A-begin A-end B-begin B-end)
2562 (emerge-eval-in-buffer
2563 emerge-merge-buffer
2564 (delete-region merge-begin merge-end)
2565 (goto-char merge-begin)
2566 (let ((i 0))
2567 (while (< i (length template))
2568 (let ((c (aref template i)))
2569 (if (= c ?%)
2570 (progn
2571 (setq i (1+ i))
71296446 2572 (setq c
3b4a6e27
JB
2573 (condition-case nil
2574 (aref template i)
2575 (error ?%)))
2576 (cond ((= c ?a)
2577 (insert-buffer-substring emerge-A-buffer A-begin A-end))
71296446 2578 ((= c ?b)
3b4a6e27 2579 (insert-buffer-substring emerge-B-buffer B-begin B-end))
71296446 2580 ((= c ?%)
737e3892
RS
2581 (insert ?%))
2582 (t
2583 (insert c))))
3b4a6e27
JB
2584 (insert c)))
2585 (setq i (1+ i))))
2586 (goto-char merge-begin)
2587 (aset diff-vector 6 'combined)
2588 (emerge-refresh-mode-line)))
2589
2590(defun emerge-set-merge-mode (mode)
737e3892
RS
2591 "Set the major mode in a merge buffer.
2592Overrides any change that the mode might make to the mode line or local
2593keymap. Leaves merge in fast mode."
3b4a6e27
JB
2594 (interactive
2595 (list (intern (completing-read "New major mode for merge buffer: "
2596 obarray 'commandp t nil))))
2597 (funcall mode)
2598 (emerge-refresh-mode-line)
2599 (if emerge-fast-mode
2600 (emerge-fast-mode)
2601 (emerge-edit-mode)))
2602
2603(defun emerge-one-line-window ()
2604 (interactive)
2605 (let ((window-min-height 1))
2606 (shrink-window (- (window-height) 2))))
2607
2608;;; Support routines
2609
2610;; Select a difference by placing the visual flags around the appropriate
2611;; group of lines in the A, B, and merge buffers
2612(defun emerge-select-difference (n)
151e4b9c
RS
2613 (let ((emerge-globalized-difference-list emerge-difference-list)
2614 (emerge-globalized-number-of-differences emerge-number-of-differences))
2615 (emerge-place-flags-in-buffer emerge-A-buffer n 0 1)
2616 (emerge-place-flags-in-buffer emerge-B-buffer n 2 3)
2617 (emerge-place-flags-in-buffer nil n 4 5))
737e3892 2618 (run-hooks 'emerge-select-hook))
151e4b9c
RS
2619
2620(defun emerge-place-flags-in-buffer (buffer difference before-index
2621 after-index)
2622 (if buffer
2623 (emerge-eval-in-buffer
2624 buffer
2625 (emerge-place-flags-in-buffer1 difference before-index after-index))
2626 (emerge-place-flags-in-buffer1 difference before-index after-index)))
2627
2628(defun emerge-place-flags-in-buffer1 (difference before-index after-index)
3b4a6e27 2629 (let ((buffer-read-only nil))
151e4b9c
RS
2630 ;; insert the flag before the difference
2631 (let ((before (aref (aref emerge-globalized-difference-list difference)
2632 before-index))
2633 here)
2634 (goto-char before)
2635 ;; insert the flag itself
2636 (insert-before-markers emerge-before-flag)
2637 (setq here (point))
2638 ;; Put the marker(s) referring to this position 1 character before the
2639 ;; end of the flag, so it won't be damaged by the user.
2640 ;; This gets a bit tricky, as there could be a number of markers
2641 ;; that have to be moved.
2642 (set-marker before (1- before))
2643 (let ((n (1- difference)) after-marker before-marker diff-list)
2644 (while (and
2645 (>= n 0)
2646 (progn
2647 (setq diff-list (aref emerge-globalized-difference-list n)
2648 after-marker (aref diff-list after-index))
2649 (= after-marker here)))
2650 (set-marker after-marker (1- after-marker))
2651 (setq before-marker (aref diff-list before-index))
2652 (if (= before-marker here)
2653 (setq before-marker (1- before-marker)))
2654 (setq n (1- n)))))
2655 ;; insert the flag after the difference
2656 (let* ((after (aref (aref emerge-globalized-difference-list difference)
2657 after-index))
2658 (here (marker-position after)))
2659 (goto-char here)
2660 ;; insert the flag itself
2661 (insert emerge-after-flag)
2662 ;; Put the marker(s) referring to this position 1 character after the
2663 ;; beginning of the flag, so it won't be damaged by the user.
2664 ;; This gets a bit tricky, as there could be a number of markers
2665 ;; that have to be moved.
2666 (set-marker after (1+ after))
2667 (let ((n (1+ difference)) before-marker after-marker diff-list)
2668 (while (and
2669 (< n emerge-globalized-number-of-differences)
2670 (progn
2671 (setq diff-list (aref emerge-globalized-difference-list n)
2672 before-marker (aref diff-list before-index))
2673 (= before-marker here)))
2674 (set-marker before-marker (1+ before-marker))
2675 (setq after-marker (aref diff-list after-index))
2676 (if (= after-marker here)
2677 (setq after-marker (1+ after-marker)))
2678 (setq n (1+ n)))))))
3b4a6e27
JB
2679
2680;; Unselect a difference by removing the visual flags in the buffers.
2681(defun emerge-unselect-difference (n)
2682 (let ((diff-vector (aref emerge-difference-list n)))
2683 (emerge-remove-flags-in-buffer emerge-A-buffer
2684 (aref diff-vector 0) (aref diff-vector 1))
2685 (emerge-remove-flags-in-buffer emerge-B-buffer
2686 (aref diff-vector 2) (aref diff-vector 3))
2687 (emerge-remove-flags-in-buffer emerge-merge-buffer
151e4b9c 2688 (aref diff-vector 4) (aref diff-vector 5)))
737e3892 2689 (run-hooks 'emerge-unselect-hook))
3b4a6e27
JB
2690
2691(defun emerge-remove-flags-in-buffer (buffer before after)
2692 (emerge-eval-in-buffer
2693 buffer
2694 (let ((buffer-read-only nil))
151e4b9c
RS
2695 ;; remove the flags, if they're there
2696 (goto-char (- before (1- emerge-before-flag-length)))
3b4a6e27
JB
2697 (if (looking-at emerge-before-flag-match)
2698 (delete-char emerge-before-flag-length)
2699 ;; the flag isn't there
2700 (ding)
737e3892 2701 (message "Trouble removing flag"))
151e4b9c 2702 (goto-char (1- after))
3b4a6e27
JB
2703 (if (looking-at emerge-after-flag-match)
2704 (delete-char emerge-after-flag-length)
2705 ;; the flag isn't there
2706 (ding)
737e3892 2707 (message "Trouble removing flag")))))
3b4a6e27 2708
151e4b9c 2709;; Select a difference, removing any flags that exist now.
3b4a6e27
JB
2710(defun emerge-unselect-and-select-difference (n &optional suppress-display)
2711 (if (and (>= emerge-current-difference 0)
2712 (< emerge-current-difference emerge-number-of-differences))
2713 (emerge-unselect-difference emerge-current-difference))
2714 (if (and (>= n 0) (< n emerge-number-of-differences))
2715 (progn
2716 (emerge-select-difference n)
2717 (let* ((diff-vector (aref emerge-difference-list n))
2718 (selection-type (aref diff-vector 6)))
2719 (if (eq selection-type 'default-A)
2720 (aset diff-vector 6 'A)
2721 (if (eq selection-type 'default-B)
2722 (aset diff-vector 6 'B))))))
2723 (setq emerge-current-difference n)
2724 (if (not suppress-display)
2725 (progn
2726 (emerge-recenter)
2727 (emerge-refresh-mode-line))))
2728
2729;; Perform tests to see whether user should be allowed to select a version
2730;; of this difference:
2731;; a valid difference has been selected; and
2732;; the difference text in the merge buffer is:
2733;; the A version (execute a-version), or
2734;; the B version (execute b-version), or
2735;; empty (execute neither-version), or
2736;; argument FORCE is true (execute neither-version)
2737;; Otherwise, signal an error.
2738(defun emerge-select-version (force a-version b-version neither-version)
2739 (emerge-validate-difference)
2740 (let ((buffer-read-only nil))
2741 (let* ((diff-vector
2742 (aref emerge-difference-list emerge-current-difference))
2743 (A-begin (1+ (aref diff-vector 0)))
2744 (A-end (1- (aref diff-vector 1)))
2745 (B-begin (1+ (aref diff-vector 2)))
2746 (B-end (1- (aref diff-vector 3)))
2747 (merge-begin (1+ (aref diff-vector 4)))
2748 (merge-end (1- (aref diff-vector 5))))
2749 (if (emerge-compare-buffers emerge-A-buffer A-begin A-end
2750 emerge-merge-buffer merge-begin
2751 merge-end)
2752 (funcall a-version)
2753 (if (emerge-compare-buffers emerge-B-buffer B-begin B-end
2754 emerge-merge-buffer merge-begin
2755 merge-end)
2756 (funcall b-version)
2757 (if (or force (= merge-begin merge-end))
2758 (funcall neither-version)
151e4b9c
RS
2759 (error "This difference region has been edited")))))))
2760
2761;; Read a file name, handling all of the various defaulting rules.
2762
2763(defun emerge-read-file-name (prompt alternative-default-dir default-file
90371ec9 2764 A-file must-match)
737e3892 2765 ;; `prompt' should not have trailing ": ", so that it can be modified
151e4b9c
RS
2766 ;; according to context.
2767 ;; If alternative-default-dir is non-nil, it should be used as the default
2768 ;; directory instead if default-directory, if emerge-default-last-directories
2769 ;; is set.
2770 ;; If default-file is set, it should be used as the default value.
2771 ;; If A-file is set, and its directory is different from
2772 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2773 ;; the default file should be the last part of A-file in the default
2774 ;; directory. (Overriding default-file.)
2775 (cond
2776 ;; If this is not the A-file argument (shown by non-nil A-file), and
2777 ;; if emerge-default-last-directories is set, and
2778 ;; the default directory exists but is not the same as the directory of the
2779 ;; A-file,
2780 ;; then make the default file have the same name as the A-file, but in
2781 ;; the default directory.
2782 ((and emerge-default-last-directories
2783 A-file
2784 alternative-default-dir
2785 (not (string-equal alternative-default-dir
2786 (file-name-directory A-file))))
2787 (read-file-name (format "%s (default %s): "
2788 prompt (file-name-nondirectory A-file))
2789 alternative-default-dir
2790 (concat alternative-default-dir
2791 (file-name-nondirectory A-file))
90371ec9 2792 (and must-match 'confirm)))
151e4b9c
RS
2793 ;; If there is a default file, use it.
2794 (default-file
2795 (read-file-name (format "%s (default %s): " prompt default-file)
2796 ;; If emerge-default-last-directories is set, use the
2797 ;; directory from the same argument of the last call of
2798 ;; Emerge as the default for this argument.
2799 (and emerge-default-last-directories
2800 alternative-default-dir)
90371ec9 2801 default-file (and must-match 'confirm)))
151e4b9c
RS
2802 (t
2803 (read-file-name (concat prompt ": ")
2804 ;; If emerge-default-last-directories is set, use the
2805 ;; directory from the same argument of the last call of
2806 ;; Emerge as the default for this argument.
2807 (and emerge-default-last-directories
2808 alternative-default-dir)
90371ec9 2809 nil (and must-match 'confirm)))))
3b4a6e27
JB
2810
2811;; Revise the mode line to display which difference we have selected
2812
2813(defun emerge-refresh-mode-line ()
2814 (setq mode-line-buffer-identification
2815 (list (format "Emerge: %%b diff %d of %d%s"
2816 (1+ emerge-current-difference)
2817 emerge-number-of-differences
2818 (if (and (>= emerge-current-difference 0)
2819 (< emerge-current-difference
2820 emerge-number-of-differences))
2821 (cdr (assq (aref (aref emerge-difference-list
2822 emerge-current-difference)
2823 6)
2824 '((A . " - A")
2825 (B . " - B")
2826 (prefer-A . " - A*")
2827 (prefer-B . " - B*")
2828 (combined . " - comb"))))
2829 ""))))
ec165e56 2830 (force-mode-line-update))
3b4a6e27
JB
2831
2832;; compare two regions in two buffers for containing the same text
2833(defun emerge-compare-buffers (buffer-x x-begin x-end buffer-y y-begin y-end)
2834 ;; first check that the two regions are the same length
2835 (if (not (and (= (- x-end x-begin) (- y-end y-begin))))
2836 nil
2837 (catch 'exit
2838 (while (< x-begin x-end)
2839 ;; bite off and compare no more than 1000 characters at a time
2840 (let* ((compare-length (min (- x-end x-begin) 1000))
71296446 2841 (x-string (emerge-eval-in-buffer
3b4a6e27
JB
2842 buffer-x
2843 (buffer-substring x-begin
2844 (+ x-begin compare-length))))
2845 (y-string (emerge-eval-in-buffer
2846 buffer-y
2847 (buffer-substring y-begin
2848 (+ y-begin compare-length)))))
2849 (if (not (string-equal x-string y-string))
2850 (throw 'exit nil)
2851 (setq x-begin (+ x-begin compare-length))
2852 (setq y-begin (+ y-begin compare-length)))))
2853 t)))
2854
2855;; Construct a unique buffer name.
71296446 2856;; The first one tried is prefixsuffix, then prefix<2>suffix,
3b4a6e27
JB
2857;; prefix<3>suffix, etc.
2858(defun emerge-unique-buffer-name (prefix suffix)
2859 (if (null (get-buffer (concat prefix suffix)))
2860 (concat prefix suffix)
2861 (let ((n 2))
2862 (while (get-buffer (format "%s<%d>%s" prefix n suffix))
2863 (setq n (1+ n)))
2864 (format "%s<%d>%s" prefix n suffix))))
2865
2866;; Verify that we have a difference selected.
2867(defun emerge-validate-difference ()
2868 (if (not (and (>= emerge-current-difference 0)
2869 (< emerge-current-difference emerge-number-of-differences)))
2870 (error "No difference selected")))
2871
2872;;; Functions for saving and restoring a batch of variables
2873
2874;; These functions save (get the values of) and restore (set the values of)
2875;; a list of variables. The argument is a list of symbols (the names of
2876;; the variables). A list element can also be a list of two functions,
2877;; the first of which (when called with no arguments) gets the value, and
a7acbbe4 2878;; the second (when called with a value as an argument) sets the value.
3b4a6e27
JB
2879;; A "function" is anything that funcall can handle as an argument.
2880
2881(defun emerge-save-variables (vars)
2882 (mapcar (function (lambda (v) (if (symbolp v)
2883 (symbol-value v)
2884 (funcall (car v)))))
2885 vars))
2886
2887(defun emerge-restore-variables (vars values)
2888 (while vars
2889 (let ((var (car vars))
2890 (value (car values)))
2891 (if (symbolp var)
2892 (set var value)
2893 (funcall (car (cdr var)) value)))
2894 (setq vars (cdr vars))
2895 (setq values (cdr values))))
2896
2897;; Make a temporary file that only we have access to.
2898;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2899(defun emerge-make-temp-file (prefix)
78c56e70
GM
2900 (let (f (old-modes (default-file-modes)))
2901 (unwind-protect
2902 (progn
2903 (set-default-file-modes emerge-temp-file-mode)
2904 (setq f (make-temp-file (concat emerge-temp-file-prefix prefix))))
2905 (set-default-file-modes old-modes))
3b4a6e27
JB
2906 f))
2907
2908;;; Functions that query the user before he can write out the current buffer.
2909
2910(defun emerge-query-write-file ()
737e3892
RS
2911 "Ask the user whether to write out an incomplete merge.
2912If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
3b4a6e27
JB
2913for details of the querying process."
2914 (interactive)
2915 (emerge-query-and-call 'write-file))
2916
2917(defun emerge-query-save-buffer ()
737e3892
RS
2918 "Ask the user whether to save an incomplete merge.
2919If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
3b4a6e27
JB
2920for details of the querying process."
2921 (interactive)
2922 (emerge-query-and-call 'save-buffer))
2923
2924(defun emerge-query-and-call (command)
737e3892
RS
2925 "Ask the user whether to save or write out the incomplete merge.
2926If answer is yes, call COMMAND interactively. During the call, the flags
3b4a6e27
JB
2927around the current difference are removed."
2928 (if (yes-or-no-p "Do you really write to write out this unfinished merge? ")
2929 ;; He really wants to do it -- unselect the difference for the duration
2930 (progn
2931 (if (and (>= emerge-current-difference 0)
2932 (< emerge-current-difference emerge-number-of-differences))
2933 (emerge-unselect-difference emerge-current-difference))
2934 ;; call-interactively takes the value of current-prefix-arg as the
2935 ;; prefix argument value to be passed to the command. Thus, we have
2936 ;; to do nothing special to make sure the prefix argument is
2937 ;; transmitted to the command.
2938 (call-interactively command)
2939 (if (and (>= emerge-current-difference 0)
2940 (< emerge-current-difference emerge-number-of-differences))
2941 (progn
2942 (emerge-select-difference emerge-current-difference)
2943 (emerge-recenter))))
2944 ;; He's being smart and not doing it
2945 (message "Not written")))
2946
2947;; Make sure the current buffer (for a file) has the same contents as the
2948;; file on disk, and attempt to remedy the situation if not.
2949;; Signal an error if we can't make them the same, or the user doesn't want
2950;; to do what is necessary to make them the same.
2951(defun emerge-verify-file-buffer ()
2952 ;; First check if the file has been modified since the buffer visited it.
2953 (if (verify-visited-file-modtime (current-buffer))
2954 (if (buffer-modified-p)
2955 ;; If buffer is not obsolete and is modified, offer to save
2956 (if (yes-or-no-p (format "Save file %s? " buffer-file-name))
2957 (save-buffer)
2958 (error "Buffer out of sync for file %s" buffer-file-name))
2959 ;; If buffer is not obsolete and is not modified, do nothing
2960 nil)
2961 (if (buffer-modified-p)
2962 ;; If buffer is obsolete and is modified, give error
2963 (error "Buffer out of sync for file %s" buffer-file-name)
2964 ;; If buffer is obsolete and is not modified, offer to revert
2965 (if (yes-or-no-p (format "Revert file %s? " buffer-file-name))
2966 (revert-buffer t t)
2967 (error "Buffer out of sync for file %s" buffer-file-name)))))
2968\f
2969;; Utilities that might have value outside of Emerge.
2970
2971;; Set up the mode in the current buffer to duplicate the mode in another
2972;; buffer.
2973(defun emerge-copy-modes (buffer)
2974 ;; Set the major mode
2975 (funcall (emerge-eval-in-buffer buffer major-mode)))
2976
2977;; Define a key, even if a prefix of it is defined
2978(defun emerge-force-define-key (keymap key definition)
737e3892
RS
2979 "Like `define-key', but forcibly creates prefix characters as needed.
2980If some prefix of KEY has a non-prefix definition, it is redefined."
3b4a6e27
JB
2981 ;; Find out if a prefix of key is defined
2982 (let ((v (lookup-key keymap key)))
2983 ;; If so, undefine it
2984 (if (integerp v)
2985 (define-key keymap (substring key 0 v) nil)))
2986 ;; Now define the key
2987 (define-key keymap key definition))
2988
737e3892
RS
2989;;;;; Improvements to describe-mode, so that it describes minor modes as well
2990;;;;; as the major mode
2991;;(defun describe-mode (&optional minor)
2992;; "Display documentation of current major mode.
2993;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2994;;display documentation of active minor modes as well.
2995;;For this to work correctly for a minor mode, the mode's indicator variable
2996;;\(listed in `minor-mode-alist') must also be a function whose documentation
2997;;describes the minor mode."
2998;; (interactive)
2999;; (with-output-to-temp-buffer "*Help*"
3000;; (princ mode-name)
3001;; (princ " Mode:\n")
3002;; (princ (documentation major-mode))
3003;; (let ((minor-modes minor-mode-alist)
3004;; (locals (buffer-local-variables)))
3005;; (while minor-modes
3006;; (let* ((minor-mode (car (car minor-modes)))
3007;; (indicator (car (cdr (car minor-modes))))
3008;; (local-binding (assq minor-mode locals)))
3009;; ;; Document a minor mode if it is listed in minor-mode-alist,
3010;; ;; bound locally in this buffer, non-nil, and has a function
3011;; ;; definition.
3012;; (if (and local-binding
3013;; (cdr local-binding)
3014;; (fboundp minor-mode))
3015;; (progn
3016;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3017;; minor-mode indicator))
3018;; (princ (documentation minor-mode)))))
3019;; (setq minor-modes (cdr minor-modes))))
7fdbcd83 3020;; (with-current-buffer standard-output
62f72ce0 3021;; (help-mode))
d5d105e8 3022;; (help-print-return-message)))
737e3892
RS
3023
3024;; This goes with the redefinition of describe-mode.
3025;;;; Adjust things so that keyboard macro definitions are documented correctly.
3026;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3027
3028;; substitute-key-definition should work now.
3029;;;; Function to shadow a definition in a keymap with definitions in another.
3030;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3031;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3032;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3033;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3034;;including those whose definition is OLDDEF."
3035;; ;; loop through all keymaps accessible from keymap
3036;; (let ((maps (accessible-keymaps keymap)))
3037;; (while maps
3038;; (let ((prefix (car (car maps)))
3039;; (map (cdr (car maps))))
3040;; ;; examine a keymap
3041;; (if (arrayp map)
3042;; ;; array keymap
3043;; (let ((len (length map))
3044;; (i 0))
3045;; (while (< i len)
3046;; (if (eq (aref map i) olddef)
3047;; ;; set the shadowing definition
3048;; (let ((key (concat prefix (char-to-string i))))
3049;; (emerge-define-key-if-possible shadowmap key newdef)))
3050;; (setq i (1+ i))))
3051;; ;; sparse keymap
3052;; (while map
3053;; (if (eq (cdr-safe (car-safe map)) olddef)
3054;; ;; set the shadowing definition
3055;; (let ((key
3056;; (concat prefix (char-to-string (car (car map))))))
3057;; (emerge-define-key-if-possible shadowmap key newdef)))
3058;; (setq map (cdr map)))))
3059;; (setq maps (cdr maps)))))
3b4a6e27
JB
3060
3061;; Define a key if it (or a prefix) is not already defined in the map.
3062(defun emerge-define-key-if-possible (keymap key definition)
3063 ;; look up the present definition of the key
3064 (let ((present (lookup-key keymap key)))
3065 (if (integerp present)
3066 ;; if it is "too long", look up the valid prefix
3067 (if (not (lookup-key keymap (substring key 0 present)))
3068 ;; if the prefix isn't defined, define it
3069 (define-key keymap key definition))
3070 ;; if there is no present definition, define it
3071 (if (not present)
3072 (define-key keymap key definition)))))
3073
737e3892
RS
3074;; Ordinary substitute-key-definition should do this now.
3075;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3076;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3077;;Make sure that subordinate keymaps aren't shared with other keymaps!
3078;;\(`copy-keymap' will suffice.)"
3079;; ;; Loop through all keymaps accessible from keymap
3080;; (let ((maps (accessible-keymaps keymap)))
3081;; (while maps
3082;; ;; Substitute in this keymap
3083;; (substitute-key-definition olddef newdef (cdr (car maps)))
3084;; (setq maps (cdr maps)))))
3b4a6e27
JB
3085
3086;; Show the name of the file in the buffer.
3087(defun emerge-show-file-name ()
3088 "Displays the name of the file loaded into the current buffer.
3089If the name won't fit on one line, the minibuffer is expanded to hold it,
3090and the command waits for a keystroke from the user. If the keystroke is
3091SPC, it is ignored; if it is anything else, it is processed as a command."
3092 (interactive)
3093 (let ((name (buffer-file-name)))
3094 (or name
3095 (setq name "Buffer has no file name."))
3096 (save-window-excursion
3097 (select-window (minibuffer-window))
784fda4f
JPW
3098 (unwind-protect
3099 (progn
3100 (erase-buffer)
3101 (insert name)
eaf9b564
GM
3102 (while (and (not (pos-visible-in-window-p))
3103 (not (window-full-height-p)))
3104 (enlarge-window 1))
784fda4f
JPW
3105 (let* ((echo-keystrokes 0)
3106 (c (read-event)))
737e3892 3107 (if (not (eq c 32))
784fda4f
JPW
3108 (setq unread-command-events (list c)))))
3109 (erase-buffer)))))
3b4a6e27 3110
c9ec040a 3111;; Improved auto-save file names.
3b4a6e27
JB
3112;; This function fixes many problems with the standard auto-save file names:
3113;; Auto-save files for non-file buffers get put in the default directory
3114;; for the buffer, whether that makes sense or not.
3115;; Auto-save files for file buffers get put in the directory of the file,
3116;; regardless of whether we can write into it or not.
3117;; Auto-save files for non-file buffers don't use the process id, so if a
3118;; user runs more than on Emacs, they can make auto-save files that overwrite
3119;; each other.
3120;; To use this function, do:
3121;; (fset 'make-auto-save-file-name
3122;; (symbol-function 'emerge-make-auto-save-file-name))
3123(defun emerge-make-auto-save-file-name ()
3124 "Return file name to use for auto-saves of current buffer.
737e3892
RS
3125Does not consider `auto-save-visited-file-name';
3126that is checked before calling this function.
3b4a6e27 3127You can redefine this for customization.
737e3892 3128See also `auto-save-file-name-p'."
3b4a6e27
JB
3129 (if buffer-file-name
3130 ;; if buffer has a file, try the format <file directory>/#<file name>#
3131 (let ((f (concat (file-name-directory buffer-file-name)
3132 "#"
3133 (file-name-nondirectory buffer-file-name)
3134 "#")))
3135 (if (file-writable-p f)
3136 ;; the file is writable, so use it
3137 f
3138 ;; the file isn't writable, so use the format
3139 ;; ~/#&<file name>&<hash of directory>#
3140 (concat (getenv "HOME")
3141 "/#&"
3142 (file-name-nondirectory buffer-file-name)
3143 "&"
737e3892 3144 (emerge-hash-string-into-string
3b4a6e27
JB
3145 (file-name-directory buffer-file-name))
3146 "#")))
3147 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3148 (expand-file-name (concat (getenv "HOME")
3149 "/#%"
3150 ;; quote / into \! and \ into \\
737e3892 3151 (emerge-unslashify-name (buffer-name))
3b4a6e27
JB
3152 "%"
3153 (make-temp-name "")
3154 "#"))))
3155
3156;; Hash a string into five characters more-or-less suitable for use in a file
3157;; name. (Allowed characters are ! through ~, except /.)
737e3892 3158(defun emerge-hash-string-into-string (s)
3b4a6e27
JB
3159 (let ((bins (vector 0 0 0 0 0))
3160 (i 0))
3161 (while (< i (length s))
3162 (aset bins (% i 5) (% (+ (* (aref bins (% i 5)) 35)
3163 (aref s i))
3164 65536))
3165 (setq i (1+ i)))
3166 (mapconcat (function (lambda (b)
3167 (setq b (+ (% b 93) ?!))
3168 (if (>= b ?/)
3169 (setq b (1+ b)))
3170 (char-to-string b)))
3171 bins "")))
3172
3173;; Quote any /s in a string by replacing them with \!.
3174;; Also, replace any \s by \\, to make it one-to-one.
737e3892 3175(defun emerge-unslashify-name (s)
3b4a6e27
JB
3176 (let ((limit 0))
3177 (while (string-match "[/\\]" s limit)
3178 (setq s (concat (substring s 0 (match-beginning 0))
3179 (if (string= (substring s (match-beginning 0)
3180 (match-end 0))
3181 "/")
3182 "\\!"
3183 "\\\\")
3184 (substring s (match-end 0))))
3185 (setq limit (1+ (match-end 0)))))
3186 s)
3187
151e4b9c
RS
3188;; Metacharacters that have to be protected from the shell when executing
3189;; a diff/diff3 command.
33933d45 3190(defcustom emerge-metachars "[ \t\n!\"#$&'()*;<=>?[\\^`{|~]"
737e3892 3191 "Characters that must be quoted with \\ when used in a shell command line.
33933d45
AS
3192More precisely, a [...] regexp to match any one such character."
3193 :type 'regexp
3194 :group 'emerge)
151e4b9c
RS
3195
3196;; Quote metacharacters (using \) when executing a diff/diff3 command.
3197(defun emerge-protect-metachars (s)
3198 (let ((limit 0))
3199 (while (string-match emerge-metachars s limit)
3200 (setq s (concat (substring s 0 (match-beginning 0))
3201 "\\"
3202 (substring s (match-beginning 0))))
3203 (setq limit (1+ (match-end 0)))))
3204 s)
3b4a6e27 3205
737e3892
RS
3206(provide 'emerge)
3207
cbee283d 3208;; arch-tag: a575f092-6e44-400e-b8a2-4124e9377585
737e3892 3209;;; emerge.el ends here