1 ;;; ediff-mult.el --- support for multi-file/multi-buffer processing in Ediff
3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 01, 02, 05 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; Users are encouraged to add functionality to this file.
27 ;; The present file contains all the infrastructure needed for that.
29 ;; Generally, to implement a new multisession capability within Ediff,
30 ;; you need to tell it
32 ;; 1. How to display the session group buffer.
33 ;; This function must indicate which Ediff sessions are active (+) and
34 ;; which are finished (-).
35 ;; See ediff-redraw-directory-group-buffer for an example.
36 ;; In all likelihood, ediff-redraw-directory-group-buffer can be used
37 ;; directly or after a small modification.
38 ;; 2. What action to take when the user clicks button 2 or types v,e, or
39 ;; RET. See ediff-filegroup-action.
40 ;; 3. Provide a list of pairs or triples of file names (or buffers,
41 ;; depending on the particular Ediff operation you want to invoke)
42 ;; in the following format:
43 ;; (HEADER (nil nil (obj1 nil) (obj2 nil) (obj3 nil))
45 ;; The function ediff-make-new-meta-list-element can be used to create
46 ;; 2nd and subsequent elements of that list (i.e., after the
47 ;; description header). See ediff-make-new-meta-list-element for the
48 ;; explanation of the two nil placeholders in such elements.
50 ;; There is API for extracting the components of the members of the
51 ;; above list. Search for `API for ediff-meta-list' for details.
53 ;; HEADER must be a list of SIX elements (nil or string):
54 ;; (regexp metaobj1 metaobj2 metaobj3 merge-save-buffer
55 ;; comparison-function)
56 ;; The function ediff-redraw-registry-buffer displays the
57 ;; 1st - 4th of these in the registry buffer.
58 ;; For some jobs some of the members of the header might be nil.
59 ;; The meaning of metaobj1, metaobj2, and metaobj3 depend on the job.
60 ;; Typically these are directories where the files to be compared are
62 ;; Also, keep in mind that the function ediff-prepare-meta-buffer
63 ;; (which see) prepends the session group buffer to the descriptor, so
64 ;; the descriptor becomes 7-long.
65 ;; Ediff expects that your function (in 2 above) will arrange to
66 ;; replace this prepended nil (via setcar) with the actual ediff
67 ;; control buffer associated with an appropriate Ediff session.
68 ;; This is arranged through internal startup hooks that can be passed
69 ;; to any of Ediff major entries (such as ediff-files, epatch, etc.).
70 ;; See how this is done in ediff-filegroup-action.
72 ;; Session descriptions are of the form
73 ;; (nil nil (obj1 . nil) (obj2 . nil) (obj3 . nil))
74 ;; which describe the objects relevant to the session.
75 ;; Use ediff-make-new-meta-list-element to create these things.
76 ;; Usually obj1/2/3 are names of files, but they may also be other
77 ;; things for some jobs. For instance, obj3 is nil for jobs that
78 ;; involve only two files. For patch jobs, obj2 and obj3 are markers
79 ;; that specify the patch corresponding to the file
80 ;; (whose name is obj1).
81 ;; The nil's are placeholders, which are used internally by ediff.
82 ;; 4. Write a function that makes a call to ediff-prepare-meta-buffer
83 ;; passing all this info.
84 ;; You may be able to use ediff-directories-internal as a template.
85 ;; 5. If you intend to add several related pieces of functionality,
86 ;; you may want to keep the function in 4 as an internal version
87 ;; and then write several top-level interactive functions that call it
88 ;; with different parameters.
89 ;; See how ediff-directories, ediff-merge-directories, and
90 ;; ediff-merge-directories-with-ancestor all use
91 ;; ediff-directories-internal.
93 ;; A useful addition here could be session groups selected by patterns
94 ;; (which are different in each directory). For instance, one may want to
95 ;; compare files of the form abc{something}.c to files old{something}.d
96 ;; which may be in the same or different directories. Or, one may want to
97 ;; compare all files of the form {something} to files of the form {something}~.
99 ;; Implementing this requires writing a collating function, which should pair
100 ;; up appropriate files. It will also require a generalization of the
101 ;; functions that do the layout of the meta- and differences buffers and of
102 ;; ediff-filegroup-action.
106 (provide 'ediff-mult
)
108 (defgroup ediff-mult nil
109 "Multi-file and multi-buffer processing in Ediff"
116 (let ((load-path (cons (expand-file-name ".") load-path
)))
117 (or (featurep 'ediff-init
)
118 (load "ediff-init.el" nil nil
'nosuffix
))
119 (or (featurep 'ediff-util
)
120 (load "ediff-util.el" nil nil
'nosuffix
))
124 (require 'ediff-init
)
125 (require 'ediff-util
)
128 (ediff-defvar-local ediff-meta-buffer nil
"")
129 (ediff-defvar-local ediff-parent-meta-buffer nil
"")
130 ;; the registry buffer
131 (defvar ediff-registry-buffer nil
)
133 (defconst ediff-meta-buffer-message
"This is an Ediff Session Group Panel: %s
136 button2, v, or RET over session record: start that Ediff session
137 M:\tin sessions invoked from here, brings back this group panel
138 R:\tdisplay the registry of active Ediff sessions
139 h:\tmark session for hiding (toggle)
140 x:\thide marked sessions; with prefix arg: unhide
141 m:\tmark session for a non-hiding operation (toggle)
142 uh/um:\tunmark all sessions marked for hiding/operation
144 p,DEL:\tprevious session
145 E:\tbrowse Ediff on-line manual
146 T:\ttoggle truncation of long file names
147 q:\tquit this session group
150 (ediff-defvar-local ediff-meta-buffer-map nil
151 "The keymap for the meta buffer.")
152 (defvar ediff-dir-diffs-buffer-map
(make-sparse-keymap)
153 "The keymap to be installed in the buffer showing differences between
156 ;; Variable specifying the action to take when the use invokes ediff in the
157 ;; meta buffer. This is usually ediff-registry-action or ediff-filegroup-action
158 (ediff-defvar-local ediff-meta-action-function nil
"")
159 ;; Tells ediff-update-meta-buffer how to redraw it
160 (ediff-defvar-local ediff-meta-redraw-function nil
"")
161 ;; Tells ediff-filegroup-action and similar procedures how to invoke Ediff for
162 ;; the sessions in a given session group
163 (ediff-defvar-local ediff-session-action-function nil
"")
165 (ediff-defvar-local ediff-metajob-name nil
"")
167 ;; buffer used to collect custom diffs from individual sessions in the group
168 (ediff-defvar-local ediff-meta-diff-buffer nil
"")
170 ;; t means recurse into subdirs when deciding which files have same contents
171 (ediff-defvar-local ediff-recurse-to-subdirectories nil
"")
173 ;; history var to use for filtering groups of files
174 (defvar ediff-filtering-regexp-history nil
"")
176 (defcustom ediff-default-filtering-regexp nil
177 "The default regular expression used as a filename filter in multifile comparisons.
178 Should be a sexp. For instance (car ediff-filtering-regexp-history) or nil."
182 ;; This has the form ((meta-buf regexp dir1 dir2 dir3 merge-auto-store-dir)
183 ;; (ctl-buf session-status (file1 . eq-status) (file2 . eq-status) (file3
184 ;; . eq-status)) (ctl-buf session-status (file1 . eq-status) (file2
185 ;; . eq-status)) ...)
186 ;; If ctl-buf is nil, the file-pair hasn't processed yet. If it is
187 ;; killed-buffer object, the file pair has been processed. If it is a live
188 ;; buffer, this means ediff is still working on the pair.
189 ;; Eq-status of a file is t if the file equals some other file in the same
191 (ediff-defvar-local ediff-meta-list nil
"")
193 (ediff-defvar-local ediff-meta-session-number nil
"")
196 ;; the difference list between directories in a directory session group
197 (ediff-defvar-local ediff-dir-difference-list nil
"")
198 (ediff-defvar-local ediff-dir-diffs-buffer nil
"")
200 ;; The registry of Ediff sessions. A list of control buffers.
201 (defvar ediff-session-registry nil
)
203 (defcustom ediff-meta-truncate-filenames t
204 "*If non-nil, truncate long file names in the session group buffers.
205 This can be toggled with `ediff-toggle-filename-truncation'."
208 (defcustom ediff-registry-setup-hook nil
209 "*Hooks run just after the registry control panel is set up."
213 (defcustom ediff-before-session-group-setup-hooks nil
214 "*Hooks to run before Ediff arranges the window for group-level operations.
215 It is used by commands such as ediff-directories.
216 This hook can be used to save the previous window config, which can be restored
217 on ediff-quit, ediff-suspend, or ediff-quit-session-group-hook."
220 (defcustom ediff-after-session-group-setup-hook nil
221 "*Hooks run just after a meta-buffer controlling a session group, such as
222 ediff-directories, is run."
225 (defcustom ediff-quit-session-group-hook nil
226 "*Hooks run just before exiting a session group."
229 (defcustom ediff-show-registry-hook nil
230 "*Hooks run just after the registry buffer is shown."
233 (defcustom ediff-show-session-group-hook
'(delete-other-windows)
234 "*Hooks run just after a session group buffer is shown."
237 (defcustom ediff-meta-buffer-keymap-setup-hook nil
238 "*Hooks run just after setting up the ediff-meta-buffer-map.
239 This keymap controls key bindings in the meta buffer and is a local variable.
240 This means that you can set different bindings for different kinds of meta
245 ;; Buffer holding the multi-file patch. Local to the meta buffer
246 (ediff-defvar-local ediff-meta-patchbufer nil
"")
248 ;;; API for ediff-meta-list
250 ;; A meta-list is either ediff-meta-list, which contains a header and the list
251 ;; of ediff sessions or ediff-dir-difference-list, which is a header followed
252 ;; by the list of differences among the directories (i.e., files that are not
253 ;; in all directories). The header is the same in all meta lists, but the rest
255 ;; Structure of the meta-list:
256 ;; (HEADER SESSION1 SESSION2 ...)
257 ;; HEADER: (GROUP-BUF REGEXP OBJA OBJB OBJC SAVE-DIR COMPARISON-FUNC)
258 ;; OBJA - first directory
259 ;; OBJB - second directory
260 ;; OBJC - third directory
261 ;; SESSION1/2/... are described below
262 ;; group buffer/regexp
263 (defsubst ediff-get-group-buffer
(meta-list)
264 (nth 0 (car meta-list
)))
266 (defsubst ediff-get-group-regexp
(meta-list)
267 (nth 1 (car meta-list
)))
269 (defsubst ediff-get-group-objA
(meta-list)
270 (nth 2 (car meta-list
)))
271 (defsubst ediff-get-group-objB
(meta-list)
272 (nth 3 (car meta-list
)))
273 (defsubst ediff-get-group-objC
(meta-list)
274 (nth 4 (car meta-list
)))
275 (defsubst ediff-get-group-merge-autostore-dir
(meta-list)
276 (nth 5 (car meta-list
)))
277 (defsubst ediff-get-group-comparison-func
(meta-list)
278 (nth 6 (car meta-list
)))
280 ;; ELT is a session meta descriptor (what is being preserved as
282 ;; The structure is: (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
283 ;; STATUS is ?I (hidden or invalid), ?* (marked for operation), ?H (hidden)
285 ;; OBJA/B/C is (FILENAME EQSTATUS)
286 ;; EQSTATUS is ?= or nil (?= means that this file is equal to some other
287 ;; file in this session)
289 (defsubst ediff-get-session-buffer
(elt)
291 (defsubst ediff-get-session-status
(elt)
293 (defsubst ediff-set-session-status
(session-info new-status
)
294 (setcar (cdr session-info
) new-status
))
296 (defsubst ediff-get-session-objA
(elt)
298 (defsubst ediff-get-session-objB
(elt)
300 (defsubst ediff-get-session-objC
(elt)
302 ;; Take the "name" component of the object into acount. ObjA/C/B is of the form
303 ;; (name . equality-indicator)
304 (defsubst ediff-get-session-objA-name
(elt)
306 (defsubst ediff-get-session-objB-name
(elt)
308 (defsubst ediff-get-session-objC-name
(elt)
310 ;; equality indicators
311 (defsubst ediff-get-file-eqstatus
(elt)
313 (defsubst ediff-set-file-eqstatus
(elt value
)
314 (setcar (cdr elt
) value
))
316 ;; Create a new element for the meta list out of obj1/2/3, which usually are
319 ;; The first nil in such an element is later replaced with the session buffer.
320 ;; The second nil is reserved for session status.
322 ;; Also, session objects A/B/C are turned into lists of the form (obj nil).
323 ;; This nil is a placeholder for eq-indicator. It is either nil or =.
324 ;; If it is discovered that this file is = to some other
325 ;; file in the same session, eq-indicator is changed to `='.
326 ;; Curently, the eq-indicator is used only for 2 and 3-file jobs.
327 (defun ediff-make-new-meta-list-element (obj1 obj2 obj3
)
328 (list nil nil
(list obj1 nil
) (list obj2 nil
) (list obj3 nil
)))
330 ;; Constructs a meta list header.
331 ;; OBJA, OBJB, OBJC are usually directories involved, but can be different for
332 ;; different jobs. For instance, multifile patch has only OBJA, which is the
334 (defun ediff-make-new-meta-list-header (regexp
338 (list regexp objA objB objC merge-auto-store-dir comparison-func
))
340 ;; The activity marker is either or + (active session, i.e., ediff is currently
341 ;; run in it), or - (finished session, i.e., we've ran ediff in it and then
342 ;; exited). Return nil, if session is neither active nor finished
343 (defun ediff-get-session-activity-marker (session)
344 (let ((session-buf (ediff-get-session-buffer session
)))
345 (cond ((null session-buf
) nil
) ; virgin session
346 ((ediff-buffer-live-p session-buf
) ?
+) ;active session
349 ;; checks if the session is a meta session
350 (defun ediff-meta-session-p (session-info)
351 (and (stringp (ediff-get-session-objA-name session-info
))
352 (file-directory-p (ediff-get-session-objA-name session-info
))
353 (stringp (ediff-get-session-objB-name session-info
))
354 (file-directory-p (ediff-get-session-objB-name session-info
))
355 (if (stringp (ediff-get-session-objC-name session-info
))
356 (file-directory-p (ediff-get-session-objC-name session-info
)) t
)))
358 ;; set up the keymap in the meta buffer
359 (defun ediff-setup-meta-map()
360 (setq ediff-meta-buffer-map
(make-sparse-keymap))
361 (suppress-keymap ediff-meta-buffer-map
)
362 (define-key ediff-meta-buffer-map
"q" 'ediff-quit-meta-buffer
)
363 (define-key ediff-meta-buffer-map
"T" 'ediff-toggle-filename-truncation
)
364 (define-key ediff-meta-buffer-map
"R" 'ediff-show-registry
)
365 (define-key ediff-meta-buffer-map
"E" 'ediff-documentation
)
366 (define-key ediff-meta-buffer-map
"v" ediff-meta-action-function
)
367 (define-key ediff-meta-buffer-map
"\C-m" ediff-meta-action-function
)
368 (define-key ediff-meta-buffer-map
" " 'ediff-next-meta-item
)
369 (define-key ediff-meta-buffer-map
"n" 'ediff-next-meta-item
)
370 (define-key ediff-meta-buffer-map
"\C-?" 'ediff-previous-meta-item
)
371 (define-key ediff-meta-buffer-map
"p" 'ediff-previous-meta-item
)
372 (define-key ediff-meta-buffer-map
[delete] 'ediff-previous-meta-item)
373 (define-key ediff-meta-buffer-map [backspace] 'ediff-previous-meta-item)
374 (or (ediff-one-filegroup-metajob)
376 (define-key ediff-meta-buffer-map "=" nil)
377 (define-key ediff-meta-buffer-map "==" 'ediff-meta-mark-equal-files)
378 (define-key ediff-meta-buffer-map "=m" 'ediff-meta-mark-equal-files)
379 (define-key ediff-meta-buffer-map "=h" 'ediff-meta-mark-equal-files)))
380 (if ediff-no-emacs-help-in-control-buffer
381 (define-key ediff-meta-buffer-map "\C-h" 'ediff-previous-meta-item))
383 (define-key ediff-meta-buffer-map [mouse-2] ediff-meta-action-function)
384 (define-key ediff-meta-buffer-map [button2] ediff-meta-action-function))
386 (use-local-map ediff-meta-buffer-map)
387 ;; modify ediff-meta-buffer-map here
388 (run-hooks 'ediff-meta-buffer-keymap-setup-hook))
391 (defun ediff-meta-mode ()
392 "This mode controls all operations on Ediff session groups.
393 It is entered through one of the following commands:
398 `ediff-merge-directories'
400 `ediff-merge-directories-with-ancestor'
401 `edirs-merge-with-ancestor'
402 `ediff-directory-revisions'
404 `ediff-merge-directory-revisions'
405 `edir-merge-revisions'
406 `ediff-merge-directory-revisions-with-ancestor'
407 `edir-merge-revisions-with-ancestor'
410 \\{ediff-meta-buffer-map}"
411 (kill-all-local-variables)
412 (setq major-mode 'ediff-meta-mode)
413 (setq mode-name "MetaEdiff"))
416 ;; the keymap for the buffer showing directory differences
417 (suppress-keymap ediff-dir-diffs-buffer-map)
418 (define-key ediff-dir-diffs-buffer-map "q" 'ediff-bury-dir-diffs-buffer)
419 (define-key ediff-dir-diffs-buffer-map " " 'next-line)
420 (define-key ediff-dir-diffs-buffer-map "n" 'next-line)
421 (define-key ediff-dir-diffs-buffer-map "\C-?" 'previous-line)
422 (define-key ediff-dir-diffs-buffer-map "p" 'previous-line)
423 (define-key ediff-dir-diffs-buffer-map "C" 'ediff-dir-diff-copy-file)
425 (define-key ediff-dir-diffs-buffer-map [mouse-2] 'ediff-dir-diff-copy-file)
426 (define-key ediff-dir-diffs-buffer-map [button2] 'ediff-dir-diff-copy-file))
427 (define-key ediff-dir-diffs-buffer-map [delete] 'previous-line
)
428 (define-key ediff-dir-diffs-buffer-map
[backspace] 'previous-line)
430 (defun ediff-next-meta-item (count)
431 "Move to the next item in Ediff registry or session group buffer.
432 Moves in circular fashion. With numeric prefix arg, skip this many items."
434 (or count (setq count 1))
437 (setq count (1- count))
438 (ediff-next-meta-item1)
439 (setq overl (ediff-get-meta-overlay-at-pos (point)))
440 ;; skip invisible ones
441 (while (and overl (ediff-overlay-get overl 'invisible))
442 (ediff-next-meta-item1)
443 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
445 ;; Move to the next meta item
446 (defun ediff-next-meta-item1 ()
448 (setq pos (ediff-next-meta-overlay-start (point)))
449 (if pos (goto-char pos))
450 (if (eq ediff-metajob-name 'ediff-registry)
451 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
452 (search-forward "*Ediff" nil t))
453 (skip-chars-backward "a-zA-Z*"))
454 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
455 (backward-char 1)))))
458 (defun ediff-previous-meta-item (count)
459 "Move to the previous item in Ediff registry or session group buffer.
460 Moves in circular fashion. With numeric prefix arg, skip this many items."
462 (or count (setq count 1))
465 (setq count (1- count))
466 (ediff-previous-meta-item1)
467 (setq overl (ediff-get-meta-overlay-at-pos (point)))
468 ;; skip invisible ones
469 (while (and overl (ediff-overlay-get overl 'invisible))
470 (ediff-previous-meta-item1)
471 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
473 (defun ediff-previous-meta-item1 ()
475 (setq pos (ediff-previous-meta-overlay-start (point)))
477 ;;; (while (ediff-get-session-status
478 ;;; (ediff-get-meta-info (current-buffer) pos 'noerror))
479 ;;; (setq pos (ediff-previous-meta-overlay-start pos)))
481 (if pos (goto-char pos))
482 (if (eq ediff-metajob-name 'ediff-registry)
483 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
484 (search-forward "*Ediff" nil t))
485 (skip-chars-backward "a-zA-Z*"))
486 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
490 (defsubst ediff-add-slash-if-directory (dir file)
491 (if (file-directory-p (concat dir file))
492 (file-name-as-directory file)
495 (defun ediff-toggle-filename-truncation ()
496 "Toggle truncation of long file names in session group buffers.
497 Set `ediff-meta-truncate-filenames' variable if you want to change the default
500 (setq ediff-meta-truncate-filenames (not ediff-meta-truncate-filenames))
501 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
504 ;; These are used to encode membership of files in directory1/2/3
505 ;; Membership code of a file is a product of codes for the directories where
507 (defvar ediff-membership-code1 2)
508 (defvar ediff-membership-code2 3)
509 (defvar ediff-membership-code3 5)
510 (defvar ediff-product-of-memcodes (* ediff-membership-code1
511 ediff-membership-code2
512 ediff-membership-code3))
514 ;; DIR1, DIR2, DIR3 are directories. DIR3 can be nil.
515 ;; OUTPUT-DIR is a directory for auto-storing the results of merge jobs.
517 ;; REGEXP is nil or a filter regexp; only file names that match the regexp
519 ;; If a file is a directory in dir1 but not dir2 (or vice versa), it is not
520 ;; included in the intersection. However, a regular file that is a dir in dir3
521 ;; is included, since dir3 files are supposed to be ancestors for merging.
522 ;; If COMPARISON-FUNC is given, use it. Otherwise, use string=
524 ;; Returns a list of the form:
525 ;; (COMMON-PART DIFF-LIST)
526 ;; COMMON-PART is car and DIFF-LIST is cdr.
528 ;; COMMON-PART is of the form:
529 ;; (META-HEADER (f1 f2 f3) (f1 f2 f3) ...)
530 ;; f3 can be nil if intersecting only 2 directories.
531 ;; Each triple (f1 f2 f3) represents the files to be compared in the
532 ;; corresponding ediff subsession.
534 ;; DIFF-LIST is of the form:
535 ;; (META-HEADER (file . num) (file . num)...)
536 ;; where num encodes the set of dirs where the file is found:
537 ;; 2 - only dir1; 3 - only dir2; 5 - only dir3; 6 - dir1&2; 10 - dir1&3; etc.
539 ;; Contains the meta info about this ediff operation
540 ;; (regexp dir1 dir2 dir3 merge-auto-store-dir comparison-func)
541 ;; Later the meta-buffer is prepended to this list.
543 ;; Some operations might use a different meta header. For instance,
544 ;; ediff-multifile-patch doesn't have dir2 and dir3, and regexp,
545 ;; comparison-func don't apply.
547 (defun ediff-intersect-directories (jobname
550 dir3 merge-autostore-dir comparison-func)
551 (setq comparison-func (or comparison-func 'string=))
552 (let (lis1 lis2 lis3 common auxdir1 auxdir2 auxdir3 common-part difflist)
554 (setq auxdir1 (file-name-as-directory dir1)
555 lis1 (directory-files auxdir1 nil regexp)
556 lis1 (delete "." lis1)
557 lis1 (delete ".." lis1)
560 (ediff-add-slash-if-directory auxdir1 elt))
562 auxdir2 (file-name-as-directory dir2)
563 lis2 (directory-files auxdir2 nil regexp)
564 lis2 (delete "." lis2)
565 lis2 (delete ".." lis2)
568 (ediff-add-slash-if-directory auxdir2 elt))
572 (setq auxdir3 (file-name-as-directory dir3)
573 lis3 (directory-files auxdir3 nil regexp)
574 lis3 (delete "." lis3)
575 lis3 (delete ".." lis3)
578 (ediff-add-slash-if-directory auxdir3 elt))
581 (if (ediff-nonempty-string-p merge-autostore-dir)
582 (setq merge-autostore-dir
583 (file-name-as-directory merge-autostore-dir)))
584 (setq common (ediff-intersection lis1 lis2 comparison-func))
586 ;; In merge with ancestor jobs, we don't intersect with lis3.
587 ;; If there is no ancestor, we'll offer to merge without the ancestor.
588 ;; So, we intersect with lis3 only when we are doing 3-way file comparison
589 (if (and lis3 (ediff-comparison-metajob3 jobname))
590 (setq common (ediff-intersection common lis3 comparison-func)))
592 ;; copying is needed because sort sorts via side effects
593 (setq common (sort (ediff-copy-list common) 'string-lessp))
595 ;; compute difference list
596 (setq difflist (ediff-set-difference
597 (ediff-union (ediff-union lis1 lis2 comparison-func)
602 difflist (delete "." difflist)
603 ;; copying is needed because sort sorts via side effects
604 difflist (sort (ediff-copy-list (delete ".." difflist))
607 (setq difflist (mapcar (lambda (elt) (cons elt 1)) difflist))
609 ;; check for files belonging to lis1/2/3
610 ;; Each elt is of the norm (file . number)
611 ;; Number encodes the directories to which file belongs.
612 ;; It is a product of a subset of ediff-membership-code1=2,
613 ;; ediff-membership-code2=3, and ediff-membership-code3=5.
614 ;; If file belongs to dir 1 only, the membership code is 2.
615 ;; If it is in dir1 and dir3, then the membership code is 2*5=10;
616 ;; if it is in dir1 and dir2, then the membership code is 2*3=6, etc.
617 (mapcar (lambda (elt)
618 (if (member (car elt) lis1)
619 (setcdr elt (* (cdr elt) ediff-membership-code1)))
620 (if (member (car elt) lis2)
621 (setcdr elt (* (cdr elt) ediff-membership-code2)))
622 (if (member (car elt) lis3)
623 (setcdr elt (* (cdr elt) ediff-membership-code3)))
627 ;; diff metalist header
628 (ediff-make-new-meta-list-header regexp
629 auxdir1 auxdir2 auxdir3
637 (ediff-make-new-meta-list-header regexp
638 auxdir1 auxdir2 auxdir3
643 (ediff-make-new-meta-list-element
648 ;; The following is done because: In merging with
649 ;; ancestor, we don't intersect with lis3. So, it is
650 ;; possible that elt is a file in auxdir1/2 but a
651 ;; directory in auxdir3 Or elt may not exist in auxdir3 at
652 ;; all. In the first case, we add a slash at the end. In
653 ;; the second case, we insert nil.
654 (setq elt (ediff-add-slash-if-directory auxdir3 elt))
655 (if (file-exists-p (concat auxdir3 elt))
656 (concat auxdir3 elt))))))
659 (cons common-part difflist)
662 ;; find directory files that are under revision. Include subdirectories, since
663 ;; we may visit them recursively. DIR1 is the directory to inspect.
664 ;; MERGE-AUTOSTORE-DIR is the directory where to auto-store the results of
665 ;; merges. Can be nil.
666 (defun ediff-get-directory-files-under-revision (jobname
668 &optional merge-autostore-dir)
669 (let (lis1 elt common auxdir1)
670 (setq auxdir1 (file-name-as-directory dir1)
671 lis1 (directory-files auxdir1 nil regexp))
673 (if (ediff-nonempty-string-p merge-autostore-dir)
674 (setq merge-autostore-dir
675 (file-name-as-directory merge-autostore-dir)))
680 ;; take files under revision control
681 (cond ((file-directory-p (concat auxdir1 elt))
683 (cons (ediff-add-slash-if-directory auxdir1 elt) common)))
684 ((and (featurep 'vc-hooks) (vc-backend (concat auxdir1 elt)))
685 (setq common (cons elt common)))
686 ;; The following two are needed only if vc-hooks isn't loaded.
687 ;; They won't recognize CVS files.
688 ((file-exists-p (concat auxdir1 elt ",v"))
689 (setq common (cons elt common)))
690 ((file-exists-p (concat auxdir1 "RCS/" elt ",v"))
691 (setq common (cons elt common)))
695 (setq common (delete "./" common)
696 common (delete "../" common)
697 common (delete "RCS" common)
698 common (delete "CVS" common)
701 ;; copying is needed because sort sorts via side effects
702 (setq common (sort (ediff-copy-list common) 'string-lessp))
706 ;; header -- has 6 elements. Meta buffer is prepended later by
707 ;; ediff-prepare-meta-buffer
708 (ediff-make-new-meta-list-header regexp
710 merge-autostore-dir nil)
711 (mapcar (lambda (elt) (ediff-make-new-meta-list-element
712 (concat auxdir1 elt) nil nil))
717 ;; If file groups selected by patterns will ever be implemented, this
718 ;; comparison function might become useful.
719 ;;;; uses external variables PAT1 PAT2 to compare str1/2
720 ;;;; patterns must be of the form ???*???? where ??? are strings of chars
721 ;;;; containing no *.
722 ;;(defun ediff-pattern= (str1 str2)
723 ;; (let (pos11 pos12 pos21 pos22 len1 len2)
725 ;; len (length epat1)
727 ;; (while (and (< pos11 len) (not (= (aref epat1 pos11) ?*)))
728 ;; (setq pos11 (1+ pos11)))
729 ;; (while (and (> pos12 0) (not (= (aref epat1 (1- pos12)) ?*)))
730 ;; (setq pos12 (1- pos12)))
733 ;; len (length epat2)
735 ;; (while (and (< pos21 len) (not (= (aref epat2 pos21) ?*)))
736 ;; (setq pos21 (1+ pos21)))
737 ;; (while (and (> pos22 0) (not (= (aref epat2 (1- pos22)) ?*)))
738 ;; (setq pos22 (1- pos22)))
740 ;; (if (and (> (length str1) pos12) (>= pos12 pos11) (> pos11 -1)
741 ;; (> (length str2) pos22) (>= pos22 pos21) (> pos21 -1))
742 ;; (string= (substring str1 pos11 pos12)
743 ;; (substring str2 pos21 pos22)))
747 ;; Prepare meta-buffer in accordance with the argument-function and
748 ;; redraw-function. Must return the created meta-buffer.
749 (defun ediff-prepare-meta-buffer (action-func meta-list
750 meta-buffer-name redraw-function
751 jobname &optional startup-hooks)
752 (let* ((meta-buffer-name
753 (ediff-unique-buffer-name meta-buffer-name "*"))
754 (meta-buffer (get-buffer-create meta-buffer-name)))
755 (ediff-with-current-buffer meta-buffer
760 (setq ediff-meta-action-function action-func
761 ediff-meta-redraw-function redraw-function
762 ediff-metajob-name jobname
763 ediff-meta-buffer meta-buffer)
765 ;; comes after ediff-meta-action-function is set
766 (ediff-setup-meta-map)
768 (if (eq ediff-metajob-name 'ediff-registry)
770 (setq ediff-registry-buffer meta-buffer
771 ediff-meta-list meta-list)
772 ;; this func is used only from registry buffer, not from other
775 ediff-meta-buffer-map "M" 'ediff-show-meta-buff-from-registry))
776 ;; Initialize the meta list -- we don't do this for registry.
777 (setq ediff-meta-list
778 ;; add meta-buffer to the list header
779 (cons (cons meta-buffer (car meta-list))
782 (or (eq meta-buffer ediff-registry-buffer)
783 (setq ediff-session-registry
784 (cons meta-buffer ediff-session-registry)))
786 ;; redraw-function uses ediff-meta-list
787 (funcall redraw-function ediff-meta-list)
789 ;; set read-only/non-modified
790 (setq buffer-read-only t)
791 (set-buffer-modified-p nil)
793 (run-hooks 'startup-hooks)
795 ;; Arrange to show directory contents differences
796 ;; Must be after run startup-hooks, since ediff-dir-difference-list is
797 ;; set inside these hooks
798 (if (eq action-func 'ediff-filegroup-action)
800 ;; put meta buffer in (car ediff-dir-difference-list)
801 (setq ediff-dir-difference-list
802 (cons (cons meta-buffer (car ediff-dir-difference-list))
803 (cdr ediff-dir-difference-list)))
805 (or (ediff-one-filegroup-metajob jobname)
806 (ediff-draw-dir-diffs ediff-dir-difference-list))
808 ediff-meta-buffer-map "h" 'ediff-mark-for-hiding-at-pos)
809 (define-key ediff-meta-buffer-map "x" 'ediff-hide-marked-sessions)
811 ediff-meta-buffer-map "m" 'ediff-mark-for-operation-at-pos)
812 (define-key ediff-meta-buffer-map "u" nil)
814 ediff-meta-buffer-map "um" 'ediff-unmark-all-for-operation)
816 ediff-meta-buffer-map "uh" 'ediff-unmark-all-for-hiding)
817 (cond ((ediff-collect-diffs-metajob jobname)
819 ediff-meta-buffer-map "P" 'ediff-collect-custom-diffs))
820 ((ediff-patch-metajob jobname)
822 ediff-meta-buffer-map "P" 'ediff-meta-show-patch)))
823 (define-key ediff-meta-buffer-map "^" 'ediff-up-meta-hierarchy)
824 (define-key ediff-meta-buffer-map "D" 'ediff-show-dir-diffs)))
826 (if (eq ediff-metajob-name 'ediff-registry)
827 (run-hooks 'ediff-registry-setup-hook)
828 (run-hooks 'ediff-after-session-group-setup-hook))
829 ) ; eval in meta-buffer
832 ;; Insert the activity marker for session SESSION in the meta buffer at point
833 ;; The activity marker is either SPC (untouched session), or + (active session,
834 ;; i.e., ediff is currently run in it), or - (finished session, i.e., we've ran
835 ;; ediff in it and then exited)
836 (defun ediff-insert-session-activity-marker-in-meta-buffer (session)
838 (cond ((ediff-get-session-activity-marker session))
842 ;; Insert session status at point. Status is either ?H (marked for hiding), or
843 ;; ?I (hidden or invalid), or ?* (meaning marked for an operation; currently,
844 ;; such op can only be checking for equality)), or SPC (meaning neither marked
846 (defun ediff-insert-session-status-in-meta-buffer (session)
848 (cond ((ediff-get-session-status session)) ; session has status: ?H, ?I, ?*
849 ;; normal session, no marks or hidings
852 ;; If NEW-MARKER is non-nil, use it to substitute the current activity marker
853 ;; in the meta buffer. If nil, use SPC
854 (defun ediff-replace-session-activity-marker-in-meta-buffer (point new-marker)
855 (let* ((overl (ediff-get-meta-overlay-at-pos point))
856 (session-info (ediff-overlay-get overl 'ediff-meta-info))
857 (activity-marker (ediff-get-session-activity-marker session-info))
859 (or new-marker activity-marker (setq new-marker ?\ ))
860 (goto-char (ediff-overlay-start overl))
861 (if (eq (char-after (point)) new-marker)
862 () ; if marker shown in buffer is the same as new-marker, do nothing
865 (set-buffer-modified-p nil))))
867 ;; If NEW-STATUS is non-nil, use it to substitute the current status marker in
868 ;; the meta buffer. If nil, use SPC
869 (defun ediff-replace-session-status-in-meta-buffer (point new-status)
870 (let* ((overl (ediff-get-meta-overlay-at-pos point))
871 (session-info (ediff-overlay-get overl 'ediff-meta-info))
872 (status (ediff-get-session-status session-info))
874 (setq new-status (or new-status status ?\ ))
875 (goto-char (ediff-overlay-start overl))
876 (forward-char 1) ; status is the second char in session record
877 (if (eq (char-after (point)) new-status)
878 () ; if marker shown in buffer is the same as new-marker, do nothing
881 (set-buffer-modified-p nil))))
883 ;; insert all file info in meta buffer for a given session
884 (defun ediff-insert-session-info-in-meta-buffer (session-info sessionNum)
885 (let ((f1 (ediff-get-session-objA session-info))
886 (f2 (ediff-get-session-objB session-info))
887 (f3 (ediff-get-session-objC session-info))
889 (hidden (eq (ediff-get-session-status session-info) ?I)))
890 ;; insert activity marker, i.e., SPC, - or +
891 (ediff-insert-session-activity-marker-in-meta-buffer session-info)
892 ;; insert session status, i.e., *, H
893 (ediff-insert-session-status-in-meta-buffer session-info)
894 (insert " Session " (int-to-string sessionNum) ":\n")
895 (ediff-meta-insert-file-info1 f1)
896 (ediff-meta-insert-file-info1 f2)
897 (ediff-meta-insert-file-info1 f3)
898 (ediff-set-meta-overlay pt (point) session-info sessionNum hidden)))
901 ;; this is a setup function for ediff-directories
902 ;; must return meta-buffer
903 (defun ediff-redraw-directory-group-buffer (meta-list)
904 ;; extract directories
905 (let ((meta-buf (ediff-get-group-buffer meta-list))
908 regexp elt merge-autostore-dir
909 point tmp-list buffer-read-only)
910 (ediff-with-current-buffer meta-buf
913 ;; delete phony overlays that used to represent sessions before the buff
915 (ediff-cond-compile-for-xemacs-or-emacs
916 (map-extents 'delete-extent) ; xemacs
917 (mapcar 'delete-overlay (overlays-in 1 1)) ; emacs
920 (insert (format ediff-meta-buffer-message
921 (ediff-abbrev-jobname ediff-metajob-name)))
923 (setq regexp (ediff-get-group-regexp meta-list)
925 (ediff-get-group-merge-autostore-dir meta-list))
927 (cond ((ediff-collect-diffs-metajob)
929 " P:\tcollect custom diffs of all marked sessions\n"))
930 ((ediff-patch-metajob)
932 " P:\tshow patch appropriately for the context (session or group)\n")))
934 " ^:\tshow parent session group\n")
935 (or (ediff-one-filegroup-metajob)
937 " D:\tshow differences among directories\n"
938 " ==:\tfor each session, show which files are identical\n"
939 " =h:\tlike ==, but also marks those sessions for hiding\n"
940 " =m:\tlike ==, but also marks those sessions for operation\n\n"))
943 (if (and (stringp regexp) (> (length regexp) 0))
945 (format "*** Filter-through regular expression: %s\n" regexp)))
946 (ediff-insert-dirs-in-meta-buffer meta-list)
947 (if (and ediff-autostore-merges (ediff-merge-metajob)
948 (ediff-nonempty-string-p merge-autostore-dir))
950 "\nMerge results are automatically stored in:\n\t%s\n"
951 merge-autostore-dir)))
953 Size Last modified Name
954 ----------------------------------------------
958 ;; discard info on directories and regexp
959 (setq meta-list (cdr meta-list)
961 (while (and tmp-list empty)
962 (if (and (car tmp-list)
963 (not (eq (ediff-get-session-status (car tmp-list)) ?I)))
965 (setq tmp-list (cdr tmp-list)))
969 " ****** ****** This session group has no members\n"))
971 ;; now organize file names like this:
972 ;; use-mark sizeA dateA sizeB dateB filename
973 ;; make sure directories are displayed with a trailing slash.
975 (setq elt (car meta-list)
976 meta-list (cdr meta-list)
977 sessionNum (1+ sessionNum))
978 (if (eq (ediff-get-session-status elt) ?I)
980 (ediff-insert-session-info-in-meta-buffer elt sessionNum)))
981 (set-buffer-modified-p nil)
985 (defun ediff-update-markers-in-dir-meta-buffer (meta-list)
986 (let ((meta-buf (ediff-get-group-buffer meta-list))
987 session-info point overl buffer-read-only)
988 (ediff-with-current-buffer meta-buf
990 (goto-char (point-min))
991 (ediff-next-meta-item1)
993 (setq session-info (ediff-get-meta-info meta-buf (point) 'no-error)
994 overl (ediff-get-meta-overlay-at-pos (point)))
997 (cond ((eq (ediff-get-session-status session-info) ?I)
999 (if overl (ediff-overlay-put overl 'invisible t)))
1000 ((and (eq (ediff-get-session-status session-info) ?H)
1001 overl (ediff-overlay-get overl 'invisible))
1003 (ediff-overlay-put overl 'invisible nil))
1004 (t (ediff-replace-session-activity-marker-in-meta-buffer
1006 (ediff-get-session-activity-marker session-info))
1007 (ediff-replace-session-status-in-meta-buffer
1009 (ediff-get-session-status session-info))))))
1010 (ediff-next-meta-item1) ; advance to the next item
1012 (set-buffer-modified-p nil)
1016 (defun ediff-update-session-marker-in-dir-meta-buffer (session-num)
1017 (let (buffer-meta-overlays session-info overl buffer-read-only)
1019 (ediff-cond-compile-for-xemacs-or-emacs
1020 (map-extents ; xemacs
1021 (lambda (ext maparg)
1023 (ediff-overlay-get ext 'ediff-meta-info)
1024 (eq (ediff-overlay-get ext 'ediff-meta-session-number)
1027 ;; Emacs doesn't have map-extents, so try harder
1028 ;; Splice overlay lists to get all buffer overlays
1030 (setq buffer-meta-overlays (overlay-lists)
1031 buffer-meta-overlays (append (car buffer-meta-overlays)
1032 (cdr buffer-meta-overlays)))
1038 (ediff-overlay-get overl 'ediff-meta-info)
1039 (eq (ediff-overlay-get
1040 overl 'ediff-meta-session-number)
1043 buffer-meta-overlays))))
1047 "Bug in ediff-update-session-marker-in-dir-meta-buffer: no overlay with given number %S"
1049 (setq session-info (ediff-overlay-get overl 'ediff-meta-info))
1050 (goto-char (ediff-overlay-start overl))
1051 (ediff-replace-session-activity-marker-in-meta-buffer
1053 (ediff-get-session-activity-marker session-info))
1054 (ediff-replace-session-status-in-meta-buffer
1056 (ediff-get-session-status session-info)))
1057 (ediff-next-meta-item1))
1061 ;; Check if this is a problematic session.
1062 ;; Return nil if not. Otherwise, return symbol representing the problem
1063 ;; At present, problematic sessions occur only in -with-ancestor comparisons
1064 ;; when the ancestor is a directory rather than a file, or when there is no
1065 ;; suitable ancestor file in the ancestor directory
1066 (defun ediff-problematic-session-p (session)
1067 (let ((f1 (ediff-get-session-objA-name session))
1068 (f2 (ediff-get-session-objB-name session))
1069 (f3 (ediff-get-session-objC-name session)))
1070 (cond ((and (stringp f1) (not (file-directory-p f1))
1071 (stringp f2) (not (file-directory-p f2))
1072 ;; either invalid file name or a directory
1073 (or (not (stringp f3)) (file-directory-p f3))
1074 (ediff-ancestor-metajob))
1075 ;; more may be added later
1079 (defun ediff-meta-insert-file-info1 (fileinfo)
1080 (let ((fname (car fileinfo))
1081 (feq (ediff-get-file-eqstatus fileinfo))
1082 (max-filename-width (if ediff-meta-truncate-filenames
1083 (- (window-width) 41)
1085 file-modtime file-size)
1086 (cond ((not (stringp fname)) (setq file-size -2)) ; file doesn't exits
1087 ((ediff-listable-file fname)
1088 (if (file-exists-p fname)
1089 ;; set real size and modtime
1090 (setq file-size (ediff-file-size fname)
1091 file-modtime (ediff-file-modtime fname))
1092 (setq file-size -2))) ; file doesn't exist
1093 ( t (setq file-size -1))) ; remote file
1098 (if feq "=" " ") ; equality indicator
1099 (format "%10s" (cond ((= file-size -1) "--")
1100 ((< file-size -1) "--")
1102 (cond ((= file-size -1) "*remote file*")
1103 ((< file-size -1) "*file doesn't exist*")
1104 (t (ediff-format-date (decode-time file-modtime))))
1106 ;; dir names in meta lists have training slashes, so we just
1107 ;; abbreviate the file name, if file exists
1108 (if (and (not (stringp fname)) (< file-size -1))
1109 "-------" ; file doesn't exist
1110 (ediff-truncate-string-left
1111 (ediff-abbreviate-file-name fname)
1112 max-filename-width)))))))
1114 (defconst ediff-months '((1 . "Jan") (2 . "Feb") (3 . "Mar") (4 . "Apr")
1115 (5 . "May") (6 . "Jun") (7 . "Jul") (8 . "Aug")
1116 (9 . "Sep") (10 . "Oct") (11 . "Nov") (12 . "Dec"))
1117 "Months' associative array.")
1119 ;; returns 2char string
1120 (defsubst ediff-fill-leading-zero (num)
1123 (number-to-string num)))
1125 ;; TIME is like the output of decode-time
1126 (defun ediff-format-date (time)
1127 (format "%s %2d %4d %s:%s:%s"
1128 (cdr (assoc (nth 4 time) ediff-months)) ; month
1131 (ediff-fill-leading-zero (nth 2 time)) ; hour
1132 (ediff-fill-leading-zero (nth 1 time)) ; min
1133 (ediff-fill-leading-zero (nth 0 time)) ; sec
1136 ;; Draw the directories
1137 (defun ediff-insert-dirs-in-meta-buffer (meta-list)
1138 (let* ((dir1 (ediff-abbreviate-file-name (ediff-get-group-objA meta-list)))
1139 (dir2 (ediff-get-group-objB meta-list))
1140 (dir2 (if (stringp dir2) (ediff-abbreviate-file-name dir2)))
1141 (dir3 (ediff-get-group-objC meta-list))
1142 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3))))
1143 (insert "*** Directory A: " dir1 "\n")
1144 (if dir2 (insert "*** Directory B: " dir2 "\n"))
1145 (if dir3 (insert "*** Directory C: " dir3 "\n"))
1148 (defun ediff-draw-dir-diffs (diff-list &optional buf-name)
1149 (if (null diff-list) (error "Lost difference info on these directories"))
1152 (ediff-unique-buffer-name "*Ediff File Group Differences" "*")))
1153 (let* ((regexp (ediff-get-group-regexp diff-list))
1154 (dir1 (ediff-abbreviate-file-name (ediff-get-group-objA diff-list)))
1155 (dir2 (ediff-abbreviate-file-name (ediff-get-group-objB diff-list)))
1156 (dir3 (ediff-get-group-objC diff-list))
1157 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3)))
1158 (meta-buf (ediff-get-group-buffer diff-list))
1159 (underline (make-string 26 ?-))
1160 file membership-code saved-point
1162 ;; skip the directory part
1163 (setq diff-list (cdr diff-list))
1164 (setq ediff-dir-diffs-buffer (get-buffer-create buf-name))
1165 (ediff-with-current-buffer ediff-dir-diffs-buffer
1166 (setq saved-point (point))
1167 (use-local-map ediff-dir-diffs-buffer-map)
1169 (setq ediff-meta-buffer meta-buf)
1170 (insert "\t\t*** Directory Differences ***\n")
1173 C,button2: over file name -- copy this file to directory that doesn't have it
1176 p,DEL: previous line\n\n")
1178 (insert (format "\n*** Directory A: %s\n" dir1))
1179 (if dir2 (insert (format "*** Directory B: %s\n" dir2)))
1180 (if dir3 (insert (format "*** Directory C: %s\n" dir3)))
1181 (if (and (stringp regexp) (> (length regexp) 0))
1183 (format "*** Filter-through regular expression: %s\n" regexp)))
1185 (insert (format "\n%-27s%-26s" "Directory A" "Directory B"))
1187 (insert (format " %-25s\n" "Directory C"))
1189 (insert (format "%s%s" underline underline))
1191 (insert (format "%s\n\n" underline))
1194 (if (null diff-list)
1195 (insert "\n\t*** No differences ***\n"))
1198 (setq file (car (car diff-list))
1199 membership-code (cdr (car diff-list))
1200 diff-list (cdr diff-list))
1201 (if (= (mod membership-code ediff-membership-code1) 0) ; dir1
1202 (let ((beg (point)))
1203 (insert (format "%-27s"
1204 (ediff-truncate-string-left
1205 (ediff-abbreviate-file-name
1206 (if (file-directory-p (concat dir1 file))
1207 (file-name-as-directory file)
1210 ;; format of meta info in the dir-diff-buffer:
1211 ;; (filename-tail filename-full otherdir1 otherdir2 otherdir3)
1212 (ediff-set-meta-overlay
1214 (list meta-buf file (concat dir1 file) dir1 dir2 dir3)))
1215 (insert (format "%-27s" "---")))
1216 (if (= (mod membership-code ediff-membership-code2) 0) ; dir2
1217 (let ((beg (point)))
1218 (insert (format "%-26s"
1219 (ediff-truncate-string-left
1220 (ediff-abbreviate-file-name
1221 (if (file-directory-p (concat dir2 file))
1222 (file-name-as-directory file)
1225 (ediff-set-meta-overlay
1227 (list meta-buf file (concat dir2 file) dir1 dir2 dir3)))
1228 (insert (format "%-26s" "---")))
1230 (if (= (mod membership-code ediff-membership-code3) 0) ; dir3
1231 (let ((beg (point)))
1232 (insert (format " %-25s"
1233 (ediff-truncate-string-left
1234 (ediff-abbreviate-file-name
1235 (if (file-directory-p (concat dir3 file))
1236 (file-name-as-directory file)
1239 (ediff-set-meta-overlay
1241 (list meta-buf file (concat dir3 file) dir1 dir2 dir3)))
1242 (insert (format " %-25s" "---"))))
1244 (setq buffer-read-only t)
1245 (set-buffer-modified-p nil)
1246 (goto-char saved-point)) ; end eval in diff buffer
1249 (defun ediff-bury-dir-diffs-buffer ()
1250 "Bury the directory difference buffer. Display the meta buffer instead."
1252 ;; ediff-meta-buffer is set in ediff-draw-dir-diffs so the directory
1253 ;; difference buffer remembers the meta buffer
1254 (let ((buf ediff-meta-buffer)
1256 (ediff-kill-buffer-carefully ediff-dir-diffs-buffer)
1257 (if (setq wind (ediff-get-visible-buffer-window buf))
1258 (select-window wind)
1259 (set-window-buffer (selected-window) buf))))
1261 ;; executes in dir session group buffer
1262 ;; show buffer differences
1263 (defun ediff-show-dir-diffs ()
1264 "Display differences among the directories involved in session group."
1266 (if (ediff-one-filegroup-metajob)
1267 (error "This command is inapplicable in the present context"))
1268 (or (ediff-buffer-live-p ediff-dir-diffs-buffer)
1269 (ediff-draw-dir-diffs ediff-dir-difference-list))
1270 (let ((buf ediff-dir-diffs-buffer))
1272 (set-window-buffer (selected-window) buf)
1273 (goto-char (point-min))))
1275 ;; Format of meta info in dir-diff-buffer:
1276 ;; (filename-tail filename-full otherdir1 otherdir2)
1277 (defun ediff-dir-diff-copy-file ()
1278 "Copy file described at point to directories where this file is missing."
1280 (let* ((pos (ediff-event-point last-command-event))
1281 (info (ediff-get-meta-info (current-buffer) pos 'noerror))
1282 (meta-buf (car info))
1283 (file-tail (nth 1 info))
1284 (file-abs (nth 2 info))
1285 (otherdir1 (nth 3 info))
1286 (otherfile1 (if otherdir1 (concat otherdir1 file-tail)))
1287 (otherdir2 (nth 4 info))
1288 (otherfile2 (if otherdir2 (concat otherdir2 file-tail)))
1289 (otherdir3 (nth 5 info))
1290 (otherfile3 (if otherdir3 (concat otherdir3 file-tail)))
1291 meta-list dir-diff-list
1294 (error "No file suitable for copying described at this location"))
1295 (ediff-with-current-buffer meta-buf
1296 (setq meta-list ediff-meta-list
1297 dir-diff-list ediff-dir-difference-list))
1299 ;; copy file to directories where it doesn't exist, update
1300 ;; ediff-dir-difference-list and redisplay
1302 (lambda (otherfile-struct)
1303 (let ((otherfile (car otherfile-struct))
1304 (file-mem-code (cdr otherfile-struct)))
1306 (or (file-exists-p otherfile)
1308 (format "Copy %s to %s ? " file-abs otherfile))
1309 (let* ((file-diff-record (assoc file-tail dir-diff-list))
1311 (* (cdr file-diff-record) file-mem-code)))
1312 (copy-file file-abs otherfile)
1313 (setcdr file-diff-record new-mem-code)
1314 (ediff-draw-dir-diffs dir-diff-list (buffer-name))
1316 ;; if file is in all three dirs or in two dirs and only
1317 ;; two dirs are involved, delete this file's record
1318 (if (or (= new-mem-code ediff-product-of-memcodes)
1319 (and (> new-mem-code ediff-membership-code3)
1321 (delq file-diff-record dir-diff-list))
1324 ;; 2,3,5 are numbers used to encode membership of a file in
1325 ;; dir1/2/3. See ediff-intersect-directories.
1326 (list (cons otherfile1 2) (cons otherfile2 3) (cons otherfile3 5)))
1328 (if (and (file-exists-p otherfile1)
1329 (file-exists-p otherfile2)
1330 (or (not otherfile3) (file-exists-p otherfile3)))
1331 ;; update ediff-meta-list by direct modification
1333 (list (ediff-make-new-meta-list-element
1334 otherfile1 otherfile2 otherfile3)))
1336 (ediff-update-meta-buffer meta-buf 'must-redraw)
1339 (defun ediff-up-meta-hierarchy ()
1340 "Go to the parent session group buffer."
1342 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
1343 (ediff-show-meta-buffer
1344 ediff-parent-meta-buffer ediff-meta-session-number)
1345 (error "This session group has no parent")))
1348 ;; argument is ignored
1349 (defun ediff-redraw-registry-buffer (&optional ignore)
1350 (ediff-with-current-buffer ediff-registry-buffer
1351 (let ((point (point))
1352 elt bufAname bufBname bufCname cur-diff total-diffs pt
1353 job-name meta-list registry-list buffer-read-only)
1355 ;; delete phony overlays that used to represent sessions before the buff
1357 (ediff-cond-compile-for-xemacs-or-emacs
1358 (map-extents 'delete-extent) ; xemacs
1359 (mapcar 'delete-overlay (overlays-in 1 1)) ; emacs
1362 (insert "This is a registry of all active Ediff sessions.
1365 button2, `v', RET over a session record: switch to that session
1366 M over a session record: display the associated session group
1367 R in any Ediff session: display session registry
1369 p,DEL: previous session
1370 E: browse Ediff on-line manual
1374 \t\tActive Ediff Sessions:
1375 \t\t----------------------
1378 ;; purge registry list from dead buffers
1379 (mapcar (lambda (elt)
1380 (if (not (ediff-buffer-live-p elt))
1381 (setq ediff-session-registry
1382 (delq elt ediff-session-registry))))
1383 ediff-session-registry)
1385 (if (null ediff-session-registry)
1386 (insert " ******* No active Ediff sessions *******\n"))
1388 (setq registry-list ediff-session-registry)
1389 (while registry-list
1390 (setq elt (car registry-list)
1391 registry-list (cdr registry-list))
1393 (if (ediff-buffer-live-p elt)
1394 (if (ediff-with-current-buffer elt
1395 (setq job-name ediff-metajob-name
1396 meta-list ediff-meta-list)
1397 (and ediff-metajob-name
1398 (not (eq ediff-metajob-name 'ediff-registry))))
1401 (insert (format " *group*\t%s: %s\n"
1403 (ediff-abbrev-jobname job-name)))
1404 (insert (format "\t\t %s %s %s\n"
1405 (ediff-abbreviate-file-name
1406 (ediff-get-group-objA meta-list))
1407 (ediff-abbreviate-file-name
1409 (ediff-get-group-objB meta-list))
1410 (ediff-get-group-objB meta-list)
1412 (ediff-abbreviate-file-name
1414 (ediff-get-group-objC meta-list))
1415 (ediff-get-group-objC meta-list)
1417 (ediff-set-meta-overlay pt (point) elt))
1419 (ediff-with-current-buffer elt
1420 (setq bufAname (if (ediff-buffer-live-p ediff-buffer-A)
1421 (buffer-name ediff-buffer-A)
1422 "!!!killed buffer!!!")
1423 bufBname (if (ediff-buffer-live-p ediff-buffer-B)
1424 (buffer-name ediff-buffer-B)
1425 "!!!killed buffer!!!")
1426 bufCname (cond ((not (ediff-3way-job))
1428 ((ediff-buffer-live-p ediff-buffer-C)
1429 (buffer-name ediff-buffer-C))
1430 (t "!!!killed buffer!!!")))
1431 (setq total-diffs (format "%-4d" ediff-number-of-differences)
1433 (cond ((= ediff-current-difference -1) " _")
1434 ((= ediff-current-difference
1435 ediff-number-of-differences)
1438 "%4d" (1+ ediff-current-difference))))
1439 job-name ediff-job-name))
1440 ;; back in the meta buf
1442 (insert cur-diff "/" total-diffs "\t"
1444 (format ": %s" (ediff-abbrev-jobname job-name)))
1446 "\n\t\t " bufAname " " bufBname " " bufCname "\n")
1447 (ediff-set-meta-overlay pt (point) elt))))
1449 (set-buffer-modified-p nil)
1453 ;; Sets overlay around a meta record with 'ediff-meta-info property PROP
1454 ;; If optional SESSION-NUMBER, make it a property of the overlay,
1455 ;; ediff-meta-session-number
1456 ;; PROP is either the ctl or meta buffer (used when we work with the registry)
1457 ;; or a session meta descriptor of the form
1458 ;; (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
1459 (defun ediff-set-meta-overlay (b e prop &optional session-number hidden)
1461 (setq overl (ediff-make-overlay b e))
1463 (ediff-overlay-put overl 'mouse-face 'highlight)
1464 (ediff-overlay-put overl 'highlight t))
1465 (ediff-overlay-put overl 'ediff-meta-info prop)
1466 (ediff-overlay-put overl 'invisible hidden)
1467 (if (numberp session-number)
1468 (ediff-overlay-put overl 'ediff-meta-session-number session-number))))
1470 (defun ediff-mark-for-hiding-at-pos (unmark)
1471 "Mark session for hiding. With prefix arg, unmark."
1473 (let* ((pos (ediff-event-point last-command-event))
1474 (meta-buf (ediff-event-buffer last-command-event))
1475 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1476 (info (ediff-get-meta-info meta-buf pos))
1477 (session-number (ediff-get-session-number-at-pos pos)))
1478 (ediff-mark-session-for-hiding info unmark)
1479 (ediff-next-meta-item 1)
1481 (ediff-update-meta-buffer meta-buf nil session-number))
1484 ;; Returns whether session was marked or unmarked
1485 (defun ediff-mark-session-for-hiding (info unmark)
1486 (let ((session-buf (ediff-get-session-buffer info))
1488 (cond ((eq unmark 'mark) (setq unmark nil))
1489 ((eq (ediff-get-session-status info) ?H) (setq unmark t))
1490 (unmark ; says unmark, but the marker is different from H
1493 (unmark (ediff-set-session-status info nil))
1494 ;;; (if (ediff-buffer-live-p session-buf)
1495 ;;; (error "Can't hide active session, %s" (buffer-name session-buf)))
1496 (t (ediff-set-session-status info ?H))))
1500 (defun ediff-mark-for-operation-at-pos (unmark)
1501 "Mark session for a group operation. With prefix arg, unmark."
1503 (let* ((pos (ediff-event-point last-command-event))
1504 (meta-buf (ediff-event-buffer last-command-event))
1505 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1506 (info (ediff-get-meta-info meta-buf pos))
1507 (session-number (ediff-get-session-number-at-pos pos)))
1508 (ediff-mark-session-for-operation info unmark)
1509 (ediff-next-meta-item 1)
1511 (ediff-update-meta-buffer meta-buf nil session-number))
1515 ;; returns whether session was unmarked.
1516 ;; remember: this is a toggle op
1517 (defun ediff-mark-session-for-operation (info unmark)
1519 (cond ((eq unmark 'mark) (setq unmark nil))
1520 ((eq (ediff-get-session-status info) ?*) (setq unmark t))
1521 (unmark ; says unmark, but the marker is different from *
1524 (unmark (ediff-set-session-status info nil))
1525 (t (ediff-set-session-status info ?*))))
1529 (defun ediff-hide-marked-sessions (unhide)
1530 "Hide marked sessions. With prefix arg, unhide."
1532 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1533 (meta-list (cdr ediff-meta-list))
1534 (from (if unhide ?I ?H))
1535 (to (if unhide ?H ?I))
1537 active-sessions-exist session-buf elt)
1539 (setq elt (car meta-list)
1540 meta-list (cdr meta-list)
1541 session-buf (ediff-get-session-buffer elt))
1543 (if (eq (ediff-get-session-status elt) from)
1545 (setq numMarked (1+ numMarked))
1546 (if (and (eq to ?I) (buffer-live-p session-buf))
1547 ;; shouldn't hide active sessions
1548 (setq active-sessions-exist t)
1549 (ediff-set-session-status elt to)))))
1551 (ediff-update-meta-buffer grp-buf 'must-redraw)
1554 (message "Nothing to reveal...")
1555 (message "Nothing to hide...")))
1556 (if active-sessions-exist
1557 (message "Note: Ediff didn't hide active sessions!"))
1560 ;; Apply OPERATION to marked sessions. Operation expects one argument of type
1561 ;; meta-list member (not the first one), i.e., a regular session description.
1562 ;; Returns number of marked sessions on which operation was performed
1563 (defun ediff-operate-on-marked-sessions (operation)
1564 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1565 (meta-list (cdr ediff-meta-list))
1569 (diff-buffer ediff-meta-diff-buffer)
1572 (setq elt (car meta-list)
1573 meta-list (cdr meta-list)
1574 sessionNum (1+ sessionNum))
1575 (cond ((eq (ediff-get-session-status elt) marksym)
1577 (setq numMarked (1+ numMarked))
1578 (funcall operation elt sessionNum)))
1579 ;; The following goes into a session represented by a subdirectory
1580 ;; and applies operation to marked sessions there
1581 ((and (ediff-meta-session-p elt)
1582 (ediff-buffer-live-p
1583 (setq session-buf (ediff-get-session-buffer elt))))
1586 (ediff-with-current-buffer session-buf
1587 ;; pass meta-diff along
1588 (setq ediff-meta-diff-buffer diff-buffer)
1589 ;; collect diffs in child group
1590 (ediff-operate-on-marked-sessions operation)))))))
1591 (ediff-update-meta-buffer grp-buf 'must-redraw) ; just in case
1595 (defun ediff-append-custom-diff (session sessionNum)
1596 (or (ediff-collect-diffs-metajob)
1597 (error "Can't compute multifile patch in this context"))
1598 (let ((session-buf (ediff-get-session-buffer session))
1599 (meta-diff-buff ediff-meta-diff-buffer)
1600 (metajob ediff-metajob-name)
1601 tmp-buf custom-diff-buf)
1602 (if (ediff-buffer-live-p session-buf)
1603 (ediff-with-current-buffer session-buf
1604 (if (eq ediff-control-buffer session-buf) ; individual session
1606 (ediff-compute-custom-diffs-maybe)
1607 (setq custom-diff-buf ediff-custom-diff-buffer)))))
1609 (or (ediff-buffer-live-p meta-diff-buff)
1610 (error "Ediff: something wrong--killed multiple diff's buffer"))
1612 (cond ((ediff-buffer-live-p custom-diff-buf)
1613 ;; for live session buffers we do them first because the user may
1614 ;; have changed them with respect to the underlying files
1616 (set-buffer meta-diff-buff)
1617 (goto-char (point-max))
1618 (insert-buffer custom-diff-buf)
1620 ;; if ediff session is not live, run diff directly on the files
1621 ((memq metajob '(ediff-directories
1622 ediff-merge-directories
1623 ediff-merge-directories-with-ancestor))
1624 ;; get diffs by calling shell command on ediff-custom-diff-program
1626 (set-buffer (setq tmp-buf (get-buffer-create ediff-tmp-buffer)))
1629 (format "%s %s %s %s"
1630 ediff-custom-diff-program ediff-custom-diff-options
1631 (ediff-get-session-objA-name session)
1632 (ediff-get-session-objB-name session))
1635 (set-buffer meta-diff-buff)
1636 (goto-char (point-max))
1637 (insert-buffer tmp-buf)
1640 (ediff-kill-buffer-carefully meta-diff-buff)
1641 (error "Session %d compares versions of file. Such session must be active to enable multifile patch collection" sessionNum )))
1644 (defun ediff-collect-custom-diffs ()
1645 "Collect custom diffs of marked sessions in buffer `*Ediff Multifile Diffs*'.
1646 This operation is defined only for `ediff-directories' and
1647 `ediff-directory-revisions', since its intent is to produce
1648 multifile patches. For `ediff-directory-revisions', we insist that
1649 all marked sessions must be active."
1651 (or (ediff-buffer-live-p ediff-meta-diff-buffer)
1652 (setq ediff-meta-diff-buffer
1654 (ediff-unique-buffer-name "*Ediff Multifile Diffs" "*"))))
1655 (ediff-with-current-buffer ediff-meta-diff-buffer
1656 (setq buffer-read-only nil)
1658 (if (> (ediff-operate-on-marked-sessions 'ediff-append-custom-diff) 0)
1661 (display-buffer ediff-meta-diff-buffer 'not-this-window)
1662 (ediff-with-current-buffer ediff-meta-diff-buffer
1663 (set-buffer-modified-p nil)
1664 (setq buffer-read-only t)))
1666 (message "No marked sessions found")))
1668 (defun ediff-meta-show-patch ()
1669 "Show the multi-file patch associated with this group session."
1671 (let* ((pos (ediff-event-point last-command-event))
1672 (meta-buf (ediff-event-buffer last-command-event))
1673 (info (ediff-get-meta-info meta-buf pos 'noerror))
1674 (patchbuffer ediff-meta-patchbufer))
1675 (if (ediff-buffer-live-p patchbuffer)
1676 (ediff-with-current-buffer patchbuffer
1681 (ediff-get-session-objB-name info)
1682 (ediff-get-session-objC-name info)))
1683 (set-buffer (get-buffer-create ediff-tmp-buffer))
1685 (insert-buffer patchbuffer)
1686 (display-buffer ediff-tmp-buffer 'not-this-window)
1688 (error "The patch buffer wasn't found"))))
1691 ;; This function executes in meta buffer. It knows where event happened.
1692 (defun ediff-filegroup-action ()
1693 "Execute appropriate action for a selected session."
1695 (let* ((pos (ediff-event-point last-command-event))
1696 (meta-buf (ediff-event-buffer last-command-event))
1697 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1698 (info (ediff-get-meta-info meta-buf pos))
1699 (session-buf (ediff-get-session-buffer info))
1700 (session-number (ediff-get-session-number-at-pos pos meta-buf))
1701 (default-regexp (eval ediff-default-filtering-regexp))
1702 merge-autostore-dir file1 file2 file3 regexp)
1704 (setq file1 (ediff-get-session-objA-name info)
1705 file2 (ediff-get-session-objB-name info)
1706 file3 (ediff-get-session-objC-name info))
1708 ;; make sure we don't start on hidden sessions
1709 ;; ?H means marked for hiding. ?I means invalid (hidden).
1710 (if (memq (ediff-get-session-status info) '(?I))
1713 (if (y-or-n-p "This session is marked as hidden, unmark? ")
1715 (ediff-set-session-status info nil)
1716 (ediff-update-meta-buffer meta-buf nil session-number))
1717 (error "Aborted"))))
1719 (ediff-with-current-buffer meta-buf
1720 (setq merge-autostore-dir
1721 (ediff-get-group-merge-autostore-dir ediff-meta-list))
1722 (goto-char pos) ; if the user clicked on session--move point there
1723 ;; First handle sessions involving directories (which are themselves
1725 ;; After that handle individual sessions
1726 (cond ((ediff-meta-session-p info)
1727 ;; do ediff/ediff-merge on subdirectories
1728 (if (ediff-buffer-live-p session-buf)
1729 (ediff-show-meta-buffer session-buf)
1732 (if (stringp default-regexp)
1734 "Filter through regular expression (default %s): "
1736 "Filter through regular expression: ")
1738 'ediff-filtering-regexp-history
1739 (eval ediff-default-filtering-regexp)))
1740 (ediff-directories-internal
1741 file1 file2 file3 regexp
1742 ediff-session-action-function
1744 ;; make it update (car info) after startup
1746 ;; child session group should know its parent
1747 (setq ediff-parent-meta-buffer
1748 (quote ,ediff-meta-buffer)
1749 ediff-meta-session-number
1751 ;; and parent will know its child
1752 (setcar (quote ,info) ediff-meta-buffer))))))
1754 ;; Do ediff-revision on a subdirectory
1755 ((and (ediff-one-filegroup-metajob)
1756 (ediff-revision-metajob)
1757 (file-directory-p file1))
1758 (if (ediff-buffer-live-p session-buf)
1759 (ediff-show-meta-buffer session-buf)
1760 (setq regexp (read-string "Filter through regular expression: "
1761 nil 'ediff-filtering-regexp-history))
1762 (ediff-directory-revisions-internal
1764 ediff-session-action-function ediff-metajob-name
1765 ;; make it update (car info) after startup
1767 ;; child session group should know its parent and
1769 (setq ediff-parent-meta-buffer
1770 (quote ,ediff-meta-buffer)
1771 ediff-meta-session-number
1773 ;; and parent will know its child
1774 (setcar (quote ,info) ediff-meta-buffer))))))
1776 ;; From here on---only individual session handlers
1778 ;; handle an individual session with a live control buffer
1779 ((ediff-buffer-live-p session-buf)
1780 (ediff-with-current-buffer session-buf
1781 (setq ediff-mouse-pixel-position (mouse-pixel-position))
1782 (ediff-recenter 'no-rehighlight)))
1784 ((ediff-problematic-session-p info)
1787 "This session has no ancestor. Merge without the ancestor? ")
1790 ;; provide startup hooks
1793 'ediff-after-quit-hook-internal
1795 (if (ediff-buffer-live-p ,(current-buffer))
1796 (ediff-show-meta-buffer
1797 ,(current-buffer) ,session-number)))
1799 (setq ediff-meta-buffer ,(current-buffer)
1800 ediff-meta-session-number
1802 (setq ediff-merge-store-file
1803 ,(if (ediff-nonempty-string-p
1804 merge-autostore-dir)
1807 ediff-merge-filename-prefix
1808 (file-name-nondirectory file1))
1810 ;; make ediff-startup pass
1811 ;; ediff-control-buffer back to the meta
1814 (quote ,info) ediff-control-buffer))))
1816 ((ediff-one-filegroup-metajob) ; needs 1 file arg
1817 (funcall ediff-session-action-function
1819 ;; provide startup hooks
1822 'ediff-after-quit-hook-internal
1824 (if (ediff-buffer-live-p
1826 (ediff-show-meta-buffer
1830 (setq ediff-meta-buffer ,(current-buffer)
1831 ediff-meta-session-number
1833 (setq ediff-merge-store-file
1834 ,(if (ediff-nonempty-string-p
1835 merge-autostore-dir)
1838 ediff-merge-filename-prefix
1839 (file-name-nondirectory file1))) )
1840 ;; make ediff-startup pass
1841 ;; ediff-control-buffer back to the meta
1844 (quote ,info) ediff-control-buffer)))))
1845 ((not (ediff-metajob3)) ; need 2 file args
1846 (funcall ediff-session-action-function
1848 ;; provide startup hooks
1851 'ediff-after-quit-hook-internal
1853 (if (ediff-buffer-live-p
1855 (ediff-show-meta-buffer
1859 (setq ediff-meta-buffer ,(current-buffer)
1860 ediff-meta-session-number
1862 (setq ediff-merge-store-file
1863 ,(if (ediff-nonempty-string-p
1864 merge-autostore-dir)
1867 ediff-merge-filename-prefix
1868 (file-name-nondirectory file1))) )
1869 ;; make ediff-startup pass
1870 ;; ediff-control-buffer back to the meta
1873 (quote ,info) ediff-control-buffer)))))
1874 ((ediff-metajob3) ; need 3 file args
1875 (funcall ediff-session-action-function
1877 ;; arrange startup hooks
1880 'ediff-after-quit-hook-internal
1882 (if (ediff-buffer-live-p
1884 (ediff-show-meta-buffer
1888 (setq ediff-merge-store-file
1889 ,(if (ediff-nonempty-string-p
1890 merge-autostore-dir)
1893 ediff-merge-filename-prefix
1894 (file-name-nondirectory file1))) )
1895 (setq ediff-meta-buffer , (current-buffer)
1896 ediff-meta-session-number
1898 ;; this arranges that ediff-startup will pass
1899 ;; the value of ediff-control-buffer back to
1900 ;; the meta level, to the record in the meta
1901 ;; list containing the information about the
1902 ;; session associated with that
1903 ;; ediff-control-buffer
1905 (quote ,info) ediff-control-buffer)))))
1907 ) ; eval in meta-buf
1910 (defun ediff-registry-action ()
1911 "Switch to a selected session."
1913 (let* ((pos (ediff-event-point last-command-event))
1914 (buf (ediff-event-buffer last-command-event))
1915 (ctl-buf (ediff-get-meta-info buf pos)))
1917 (if (ediff-buffer-live-p ctl-buf)
1918 ;; check if this is ediff-control-buffer or ediff-meta-buffer
1919 (if (ediff-with-current-buffer ctl-buf
1920 (eq (key-binding "q") 'ediff-quit-meta-buffer))
1921 ;; it's a meta-buffer -- last action should just display it
1922 (ediff-show-meta-buffer ctl-buf t)
1923 ;; it's a session buffer -- invoke go back to session
1924 (ediff-with-current-buffer ctl-buf
1925 (setq ediff-mouse-pixel-position (mouse-pixel-position))
1926 (ediff-recenter 'no-rehighlight)))
1928 (message "You've selected a stale session --- try again")
1929 (ediff-update-registry))
1930 (ediff-with-current-buffer buf
1935 ;; If session number is t, means don't update meta buffer
1936 (defun ediff-show-meta-buffer (&optional meta-buf session-number)
1937 "Show the session group buffer."
1939 (run-hooks 'ediff-before-directory-setup-hooks)
1940 (let (wind frame silent)
1941 (if meta-buf (setq silent t))
1943 (setq meta-buf (or meta-buf ediff-meta-buffer))
1944 (cond ((not (bufferp meta-buf))
1945 (error "This Ediff session is not part of a session group"))
1946 ((not (ediff-buffer-live-p meta-buf))
1948 "Can't find this session's group panel -- session itself is ok")))
1950 (cond ((numberp session-number)
1951 (ediff-update-meta-buffer meta-buf nil session-number))
1952 ;; if session-number is t, don't update
1954 (t (ediff-cleanup-meta-buffer meta-buf)))
1956 (ediff-with-current-buffer meta-buf
1958 (cond ((setq wind (ediff-get-visible-buffer-window meta-buf))
1961 "Already showing the group panel for this session"))
1962 (set-window-buffer wind meta-buf)
1963 (select-window wind))
1964 ((window-live-p (setq wind ediff-window-C)) ;in merge--merge buf
1965 (set-window-buffer ediff-window-C meta-buf)
1966 (select-window wind))
1967 ((window-live-p (setq wind ediff-window-A))
1968 (set-window-buffer ediff-window-A meta-buf)
1969 (select-window wind))
1970 ((window-live-p (setq wind ediff-window-B))
1971 (set-window-buffer ediff-window-B meta-buf)
1972 (select-window wind))
1975 (ediff-get-visible-buffer-window ediff-registry-buffer))
1976 (ediff-window-display-p))
1977 (select-window wind)
1979 (set-window-buffer (selected-window) meta-buf))
1980 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
1981 (set-window-buffer (selected-window) meta-buf)))
1983 (if (and (ediff-window-display-p)
1985 (setq wind (ediff-get-visible-buffer-window meta-buf))))
1987 (setq frame (window-frame wind))
1989 (ediff-reset-mouse frame)))
1990 (sit-for 0) ; sometimes needed to synch the display and ensure that the
1991 ; point ends up after the just completed session
1992 (run-hooks 'ediff-show-session-group-hook)
1995 (defun ediff-show-current-session-meta-buffer ()
1997 (ediff-show-meta-buffer nil ediff-meta-session-number))
1999 (defun ediff-show-meta-buff-from-registry ()
2000 "Display the session group buffer for a selected session group."
2002 (let* ((pos (ediff-event-point last-command-event))
2003 (meta-buf (ediff-event-buffer last-command-event))
2004 (info (ediff-get-meta-info meta-buf pos))
2005 (meta-or-session-buf info))
2006 (ediff-with-current-buffer meta-or-session-buf
2007 (ediff-show-meta-buffer nil t))))
2010 (defun ediff-show-registry ()
2011 "Display Ediff's registry."
2013 (ediff-update-registry)
2014 (if (not (ediff-buffer-live-p ediff-registry-buffer))
2015 (error "No active Ediff sessions or corrupted session registry"))
2017 ;; for some reason, point moves in ediff-registry-buffer, so we preserve it
2019 (ediff-with-current-buffer ediff-registry-buffer
2022 (ediff-get-visible-buffer-window ediff-registry-buffer))
2023 (message "Already showing the registry")
2024 (set-window-buffer wind ediff-registry-buffer)
2025 (select-window wind))
2026 ((window-live-p ediff-window-C)
2027 (set-window-buffer ediff-window-C ediff-registry-buffer)
2028 (select-window ediff-window-C))
2029 ((window-live-p ediff-window-A)
2030 (set-window-buffer ediff-window-A ediff-registry-buffer)
2031 (select-window ediff-window-A))
2032 ((window-live-p ediff-window-B)
2033 (set-window-buffer ediff-window-B ediff-registry-buffer)
2034 (select-window ediff-window-B))
2036 (ediff-get-visible-buffer-window ediff-meta-buffer))
2037 (ediff-window-display-p))
2038 (select-window wind)
2040 (set-window-buffer (selected-window) ediff-registry-buffer))
2041 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
2042 (set-window-buffer (selected-window) ediff-registry-buffer)))
2044 (if (ediff-window-display-p)
2048 (ediff-get-visible-buffer-window ediff-registry-buffer)))
2050 (ediff-reset-mouse frame)))
2051 (run-hooks 'ediff-show-registry-hook)
2055 (defalias 'eregistry 'ediff-show-registry)
2057 ;; If meta-buf doesn't exist, it is created. In that case, id doesn't have a
2059 ;; Check if META-BUF exists before calling this function
2060 ;; Optional MUST-REDRAW, if non-nil, would force redrawal of the whole meta
2061 ;; buffer. Otherwise, it will just go over the buffer and update activity marks
2062 ;; and session status.
2063 ;; SESSION-NUMBER, if specified, says which session caused the update.
2064 (defun ediff-update-meta-buffer (meta-buf &optional must-redraw session-number)
2065 (if (ediff-buffer-live-p meta-buf)
2066 (ediff-with-current-buffer meta-buf
2068 (cond (must-redraw ; completely redraw the meta buffer
2069 (funcall ediff-meta-redraw-function ediff-meta-list))
2070 ((numberp session-number) ; redraw only for the given session
2071 (ediff-update-session-marker-in-dir-meta-buffer
2073 (t ; update what changed only, but scan the entire meta buffer
2074 (ediff-update-markers-in-dir-meta-buffer ediff-meta-list)))
2075 (setq overl (ediff-get-meta-overlay-at-pos (point)))
2076 ;; skip the invisible sessions
2077 (while (and overl (ediff-overlay-get overl 'invisible))
2078 (ediff-next-meta-item1)
2079 (setq overl (ediff-get-meta-overlay-at-pos (point))))
2082 (defun ediff-update-registry ()
2083 (ediff-with-current-buffer (current-buffer)
2084 (if (ediff-buffer-live-p ediff-registry-buffer)
2085 (ediff-redraw-registry-buffer)
2086 (ediff-prepare-meta-buffer
2087 'ediff-registry-action
2088 ediff-session-registry
2090 'ediff-redraw-registry-buffer
2094 ;; If meta-buf exists, it is redrawn along with parent.
2095 ;; Otherwise, nothing happens.
2096 (defun ediff-cleanup-meta-buffer (meta-buffer)
2097 (if (ediff-buffer-live-p meta-buffer)
2098 (ediff-with-current-buffer meta-buffer
2099 (ediff-update-meta-buffer meta-buffer)
2100 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
2101 (ediff-update-meta-buffer
2102 ediff-parent-meta-buffer nil ediff-meta-session-number)))))
2104 ;; t if no session is in progress
2105 (defun ediff-safe-to-quit (meta-buffer)
2106 (if (ediff-buffer-live-p meta-buffer)
2107 (let ((lis ediff-meta-list)
2110 ;;(ediff-update-meta-buffer meta-buffer)
2111 (ediff-with-current-buffer meta-buffer
2112 (setq lis (cdr lis)) ; discard the description part of meta-list
2113 (while (and cont lis)
2114 (if (ediff-buffer-live-p
2115 (ediff-get-group-buffer lis)) ; in progress
2117 (setq lis (cdr lis)))
2120 (defun ediff-quit-meta-buffer ()
2121 "If the group has no active session, delete the meta buffer.
2122 If no session is in progress, ask to confirm before deleting meta buffer.
2123 Otherwise, bury the meta buffer.
2124 If this is a session registry buffer then just bury it."
2126 (let* ((buf (current-buffer))
2127 (dir-diffs-buffer ediff-dir-diffs-buffer)
2128 (meta-diff-buffer ediff-meta-diff-buffer)
2129 (session-number ediff-meta-session-number)
2130 (parent-buf ediff-parent-meta-buffer)
2131 (dont-show-registry (eq buf ediff-registry-buffer)))
2132 (if dont-show-registry
2134 ;;(ediff-cleanup-meta-buffer buf)
2135 (cond ((and (ediff-safe-to-quit buf)
2136 (y-or-n-p "Quit this session group? "))
2137 (run-hooks 'ediff-quit-session-group-hook)
2139 (ediff-dispose-of-meta-buffer buf))
2140 ((ediff-safe-to-quit buf)
2144 "This session group has active sessions---cannot exit")))
2145 (ediff-update-meta-buffer parent-buf nil session-number)
2146 (ediff-kill-buffer-carefully dir-diffs-buffer)
2147 (ediff-kill-buffer-carefully meta-diff-buffer)
2148 (if (ediff-buffer-live-p parent-buf)
2150 (setq dont-show-registry t)
2151 (ediff-show-meta-buffer parent-buf session-number)))
2153 (or dont-show-registry
2154 (ediff-show-registry))))
2156 (defun ediff-dispose-of-meta-buffer (buf)
2157 (setq ediff-session-registry (delq buf ediff-session-registry))
2158 (ediff-with-current-buffer buf
2159 (if (ediff-buffer-live-p ediff-dir-diffs-buffer)
2160 (kill-buffer ediff-dir-diffs-buffer)))
2164 ;; Obtain information on a meta record where the user clicked or typed
2165 ;; BUF is the buffer where this happened and POINT is the position
2166 ;; If optional NOERROR arg is given, don't report error and return nil if no
2167 ;; meta info is found on line.
2168 (defun ediff-get-meta-info (buf point &optional noerror)
2169 (let (result olist tmp)
2170 (if (and point (ediff-buffer-live-p buf))
2171 (ediff-with-current-buffer buf
2172 (ediff-cond-compile-for-xemacs-or-emacs
2173 (setq result ; xemacs
2174 (if (setq tmp (extent-at point buf 'ediff-meta-info))
2175 (ediff-overlay-get tmp 'ediff-meta-info)))
2177 (setq olist (overlays-at point))
2179 (mapcar (lambda (elt)
2180 (unless (overlay-get elt 'invisible)
2181 (overlay-get elt 'ediff-meta-info)))
2183 (while (and olist (null (car olist)))
2184 (setq olist (cdr olist)))
2185 (setq result (car olist)))
2192 (ediff-update-registry)
2193 (error "No session info in this line")))))
2196 (defun ediff-get-meta-overlay-at-pos (point)
2197 (ediff-cond-compile-for-xemacs-or-emacs
2198 (extent-at point (current-buffer) 'ediff-meta-info) ; xemacs
2200 (let* ((overl-list (overlays-at point))
2201 (overl (car overl-list)))
2202 (while (and overl (null (overlay-get overl 'ediff-meta-info)))
2203 (setq overl-list (cdr overl-list)
2204 overl (car overl-list)))
2209 (defsubst ediff-get-session-number-at-pos (point &optional meta-buffer)
2210 (setq meta-buffer (if (ediff-buffer-live-p meta-buffer)
2213 (ediff-with-current-buffer meta-buffer
2215 (ediff-get-meta-overlay-at-pos point) 'ediff-meta-session-number)))
2218 ;; Return location of the next meta overlay after point
2219 (defun ediff-next-meta-overlay-start (point)
2221 (goto-char (point-min))
2222 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2223 (ediff-cond-compile-for-xemacs-or-emacs
2226 (setq overl (next-extent overl))
2227 (setq overl (next-extent (current-buffer))))
2229 (extent-start-position overl)
2233 ;; note: end of current overlay is the beginning of the next one
2235 (next-overlay-change point))
2241 (defun ediff-previous-meta-overlay-start (point)
2243 (goto-char (point-max))
2244 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2245 (ediff-cond-compile-for-xemacs-or-emacs
2248 (setq overl (previous-extent overl))
2249 (setq overl (previous-extent (current-buffer))))
2251 (extent-start-position overl)
2254 (if overl (setq point (overlay-start overl)))
2255 ;; to get to the beginning of prev overlay
2257 ;; trick to overcome an emacs bug--doesn't always find previous
2258 ;; overlay change correctly
2259 (setq point (1- point)))
2260 (setq point (previous-overlay-change point))
2261 ;; If we are not over an overlay after subtracting 1, it means we are
2262 ;; in the description area preceding session records. In this case,
2263 ;; goto the top of the registry buffer.
2264 (or (car (overlays-at point))
2265 (setq point (point-min)))
2270 ;; this is the action invoked when the user selects a patch from the meta
2272 (defun ediff-patch-file-form-meta (file &optional startup-hooks)
2273 (let* ((pos (ediff-event-point last-command-event))
2274 (meta-buf (ediff-event-buffer last-command-event))
2275 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
2276 (info (ediff-get-meta-info meta-buf pos))
2277 (meta-patchbuf ediff-meta-patchbufer)
2278 session-buf beg-marker end-marker)
2280 (if (or (file-directory-p file) (string-match "/dev/null" file))
2281 (error "`%s' is not an ordinary file" (file-name-as-directory file)))
2282 (setq session-buf (ediff-get-session-buffer info)
2283 beg-marker (ediff-get-session-objB-name info)
2284 end-marker (ediff-get-session-objC-name info))
2286 (or (ediff-buffer-live-p session-buf) ; either an active patch session
2287 (null session-buf) ; or it is a virgin session
2289 "Patch has already been applied to this file -- can't repeat!"))
2291 (ediff-with-current-buffer meta-patchbuf
2294 (narrow-to-region beg-marker end-marker)
2295 (ediff-patch-file-internal meta-patchbuf file startup-hooks)))))
2298 (defun ediff-unmark-all-for-operation ()
2299 "Unmark all sessions marked for operation."
2301 (let ((list (cdr ediff-meta-list))
2303 (while (setq elt (car list))
2304 (ediff-mark-session-for-operation elt 'unmark)
2305 (setq list (cdr list))))
2306 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2308 (defun ediff-unmark-all-for-hiding ()
2309 "Unmark all sessions marked for hiding."
2311 (let ((list (cdr ediff-meta-list))
2313 (while (setq elt (car list))
2314 (ediff-mark-session-for-hiding elt 'unmark)
2315 (setq list (cdr list))))
2316 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2319 ;; ACTION is ?h, ?m, ?=: to mark for hiding, mark for operation, or simply
2320 ;; indicate which are equal files
2321 (defun ediff-meta-mark-equal-files (&optional action)
2322 "Run through the session list and mark identical files.
2323 This is used only for sessions that involve 2 or 3 files at the same time.
2324 ACTION is an optional argument that can be ?h, ?m, ?=, to mark for hiding, mark
2325 for operation, or simply indicate which are equal files. If it is nil, then
2326 last-command-char is used to decide which action to take."
2329 (setq action last-command-char))
2330 (let ((list (cdr ediff-meta-list))
2331 marked1 marked2 marked3
2332 fileinfo1 fileinfo2 fileinfo3 elt)
2333 (message "Comparing files ...")
2334 (while (setq elt (car list))
2335 (setq fileinfo1 (ediff-get-session-objA elt)
2336 fileinfo2 (ediff-get-session-objB elt)
2337 fileinfo3 (ediff-get-session-objC elt))
2338 (ediff-set-file-eqstatus fileinfo1 nil)
2339 (ediff-set-file-eqstatus fileinfo2 nil)
2340 (ediff-set-file-eqstatus fileinfo3 nil)
2345 (or (ediff-mark-if-equal fileinfo1 fileinfo2)
2347 (if (ediff-metajob3)
2349 (or (ediff-mark-if-equal fileinfo1 fileinfo3)
2351 (or (ediff-mark-if-equal fileinfo2 fileinfo3)
2352 (setq marked3 nil))))
2353 (if (and marked1 marked2 marked3)
2354 (cond ((eq action ?h)
2355 (ediff-mark-session-for-hiding elt 'mark))
2357 (ediff-mark-session-for-operation elt 'mark))
2359 (setq list (cdr list)))
2360 (message "Comparing files ... Done"))
2361 (setq ediff-recurse-to-subdirectories nil)
2362 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2364 ;; mark files 1 and 2 as equal, if they are.
2365 ;; returns t, if something was marked
2366 (defun ediff-mark-if-equal (fileinfo1 fileinfo2)
2367 (let ((f1 (car fileinfo1))
2368 (f2 (car fileinfo2)))
2369 (if (and (stringp f1) (stringp f2) (ediff-same-contents f1 f2))
2371 (ediff-set-file-eqstatus fileinfo1 t)
2372 (ediff-set-file-eqstatus fileinfo2 t)
2378 ;;; Local Variables:
2379 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
2380 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
2381 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
2384 ;;; arch-tag: c8a76898-f96f-4d9c-be9d-129134017188
2385 ;;; ediff-mult.el ends here