1 ;;; ediff-mult.el --- support for multi-file/multi-buffer processing in Ediff
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; Users are encouraged to add functionality to this file.
28 ;; The present file contains all the infrastructure needed for that.
30 ;; Generally, to implement a new multisession capability within Ediff,
31 ;; you need to tell it
33 ;; 1. How to display the session group buffer.
34 ;; This function must indicate which Ediff sessions are active (+) and
35 ;; which are finished (-).
36 ;; See ediff-redraw-directory-group-buffer for an example.
37 ;; In all likelihood, ediff-redraw-directory-group-buffer can be used
38 ;; directly or after a small modification.
39 ;; 2. What action to take when the user clicks button 2 or types v,e, or
40 ;; RET. See ediff-filegroup-action.
41 ;; 3. Provide a list of pairs or triples of file names (or buffers,
42 ;; depending on the particular Ediff operation you want to invoke)
43 ;; in the following format:
44 ;; (HEADER (nil nil (obj1 nil) (obj2 nil) (obj3 nil))
46 ;; The function ediff-make-new-meta-list-element can be used to create
47 ;; 2nd and subsequent elements of that list (i.e., after the
48 ;; description header). See ediff-make-new-meta-list-element for the
49 ;; explanation of the two nil placeholders in such elements.
51 ;; There is API for extracting the components of the members of the
52 ;; above list. Search for `API for ediff-meta-list' for details.
54 ;; HEADER must be a list of SIX elements (nil or string):
55 ;; (regexp metaobj1 metaobj2 metaobj3 merge-save-buffer
56 ;; comparison-function)
57 ;; The function ediff-redraw-registry-buffer displays the
58 ;; 1st - 4th of these in the registry buffer.
59 ;; For some jobs some of the members of the header might be nil.
60 ;; The meaning of metaobj1, metaobj2, and metaobj3 depend on the job.
61 ;; Typically these are directories where the files to be compared are
63 ;; Also, keep in mind that the function ediff-prepare-meta-buffer
64 ;; (which see) prepends the session group buffer to the descriptor, so
65 ;; the descriptor becomes 7-long.
66 ;; Ediff expects that your function (in 2 above) will arrange to
67 ;; replace this prepended nil (via setcar) with the actual ediff
68 ;; control buffer associated with an appropriate Ediff session.
69 ;; This is arranged through internal startup hooks that can be passed
70 ;; to any of Ediff major entries (such as ediff-files, epatch, etc.).
71 ;; See how this is done in ediff-filegroup-action.
73 ;; Session descriptions are of the form
74 ;; (nil nil (obj1 . nil) (obj2 . nil) (obj3 . nil))
75 ;; which describe the objects relevant to the session.
76 ;; Use ediff-make-new-meta-list-element to create these things.
77 ;; Usually obj1/2/3 are names of files, but they may also be other
78 ;; things for some jobs. For instance, obj3 is nil for jobs that
79 ;; involve only two files. For patch jobs, obj2 and obj3 are markers
80 ;; that specify the patch corresponding to the file
81 ;; (whose name is obj1).
82 ;; The nil's are placeholders, which are used internally by ediff.
83 ;; 4. Write a function that makes a call to ediff-prepare-meta-buffer
84 ;; passing all this info.
85 ;; You may be able to use ediff-directories-internal as a template.
86 ;; 5. If you intend to add several related pieces of functionality,
87 ;; you may want to keep the function in 4 as an internal version
88 ;; and then write several top-level interactive functions that call it
89 ;; with different parameters.
90 ;; See how ediff-directories, ediff-merge-directories, and
91 ;; ediff-merge-directories-with-ancestor all use
92 ;; ediff-directories-internal.
94 ;; A useful addition here could be session groups selected by patterns
95 ;; (which are different in each directory). For instance, one may want to
96 ;; compare files of the form abc{something}.c to files old{something}.d
97 ;; which may be in the same or different directories. Or, one may want to
98 ;; compare all files of the form {something} to files of the form {something}~.
100 ;; Implementing this requires writing a collating function, which should pair
101 ;; up appropriate files. It will also require a generalization of the
102 ;; functions that do the layout of the meta- and differences buffers and of
103 ;; ediff-filegroup-action.
108 (provide 'ediff-mult
)
110 (defgroup ediff-mult nil
111 "Multi-file and multi-buffer processing in Ediff."
118 (require 'ediff-init
)
119 (if (not (featurep 'ediff-util
))
120 (require 'ediff-util
))
121 (if (not (featurep 'ediff-ptch
))
122 (require 'ediff-ptch
))
127 (require 'ediff-init
)
130 (ediff-defvar-local ediff-meta-buffer nil
"")
131 (ediff-defvar-local ediff-parent-meta-buffer nil
"")
132 ;; the registry buffer
133 (defvar ediff-registry-buffer nil
)
135 (defconst ediff-meta-buffer-brief-message
"Ediff Session Group Panel: %s
137 Type ? to show useful commands in this buffer
141 (defconst ediff-meta-buffer-verbose-message
"Ediff Session Group Panel: %s
143 Useful commands (type ? to hide them and free up screen):
144 button2, v, or RET over session record: start that Ediff session
145 M:\tin sessions invoked from here, brings back this group panel
146 R:\tdisplay the registry of active Ediff sessions
147 h:\tmark session for hiding (toggle)
148 x:\thide marked sessions; with prefix arg: unhide
149 m:\tmark session for a non-hiding operation (toggle)
150 uh/um:\tunmark all sessions marked for hiding/operation
152 p,DEL:\tprevious session
153 E:\tbrowse Ediff on-line manual
154 T:\ttoggle truncation of long file names
155 q:\tquit this session group
158 (ediff-defvar-local ediff-meta-buffer-map nil
159 "The keymap for the meta buffer.")
160 (defvar ediff-dir-diffs-buffer-map
(make-sparse-keymap)
161 "The keymap to be installed in the buffer showing differences between
164 ;; Variable specifying the action to take when the use invokes ediff in the
165 ;; meta buffer. This is usually ediff-registry-action or ediff-filegroup-action
166 (ediff-defvar-local ediff-meta-action-function nil
"")
167 ;; Tells ediff-update-meta-buffer how to redraw it
168 (ediff-defvar-local ediff-meta-redraw-function nil
"")
169 ;; Tells ediff-filegroup-action and similar procedures how to invoke Ediff for
170 ;; the sessions in a given session group
171 (ediff-defvar-local ediff-session-action-function nil
"")
173 (ediff-defvar-local ediff-metajob-name nil
"")
175 ;; buffer used to collect custom diffs from individual sessions in the group
176 (ediff-defvar-local ediff-meta-diff-buffer nil
"")
178 ;; t means recurse into subdirs when deciding which files have same contents
179 (ediff-defvar-local ediff-recurse-to-subdirectories nil
"")
181 ;; history var to use for filtering groups of files
182 (defvar ediff-filtering-regexp-history nil
"")
184 (defcustom ediff-default-filtering-regexp nil
185 "The default regular expression used as a filename filter in multifile comparisons.
186 Should be a sexp. For instance (car ediff-filtering-regexp-history) or nil."
190 ;; This has the form ((meta-buf regexp dir1 dir2 dir3 merge-auto-store-dir)
191 ;; (ctl-buf session-status (file1 . eq-status) (file2 . eq-status) (file3
192 ;; . eq-status)) (ctl-buf session-status (file1 . eq-status) (file2
193 ;; . eq-status)) ...)
194 ;; If ctl-buf is nil, the file-pair hasn't processed yet. If it is
195 ;; killed-buffer object, the file pair has been processed. If it is a live
196 ;; buffer, this means ediff is still working on the pair.
197 ;; Eq-status of a file is t if the file equals some other file in the same
199 (ediff-defvar-local ediff-meta-list nil
"")
201 (ediff-defvar-local ediff-meta-session-number nil
"")
204 ;; the difference list between directories in a directory session group
205 (ediff-defvar-local ediff-dir-difference-list nil
"")
206 (ediff-defvar-local ediff-dir-diffs-buffer nil
"")
208 ;; The registry of Ediff sessions. A list of control buffers.
209 (defvar ediff-session-registry nil
)
211 (defcustom ediff-meta-truncate-filenames t
212 "*If non-nil, truncate long file names in the session group buffers.
213 This can be toggled with `ediff-toggle-filename-truncation'."
217 (defcustom ediff-meta-mode-hook nil
218 "*Hooks run just after setting up meta mode."
222 (defcustom ediff-registry-setup-hook nil
223 "*Hooks run just after the registry control panel is set up."
227 (defcustom ediff-before-session-group-setup-hooks nil
228 "*Hooks to run before Ediff arranges the window for group-level operations.
229 It is used by commands such as `ediff-directories'.
230 This hook can be used to save the previous window config, which can be restored
231 on `ediff-quit', `ediff-suspend', or `ediff-quit-session-group-hook'."
234 (defcustom ediff-after-session-group-setup-hook nil
235 "*Hooks run just after a meta-buffer controlling a session group, such as
236 ediff-directories, is run."
239 (defcustom ediff-quit-session-group-hook nil
240 "*Hooks run just before exiting a session group."
243 (defcustom ediff-show-registry-hook nil
244 "*Hooks run just after the registry buffer is shown."
247 (defcustom ediff-show-session-group-hook
'(delete-other-windows)
248 "*Hooks run just after a session group buffer is shown."
251 (defcustom ediff-meta-buffer-keymap-setup-hook nil
252 "*Hooks run just after setting up the `ediff-meta-buffer-map'.
253 This keymap controls key bindings in the meta buffer and is a local variable.
254 This means that you can set different bindings for different kinds of meta
259 ;; Buffer holding the multi-file patch. Local to the meta buffer
260 (ediff-defvar-local ediff-meta-patchbufer nil
"")
262 ;;; API for ediff-meta-list
264 ;; A meta-list is either ediff-meta-list, which contains a header and the list
265 ;; of ediff sessions or ediff-dir-difference-list, which is a header followed
266 ;; by the list of differences among the directories (i.e., files that are not
267 ;; in all directories). The header is the same in all meta lists, but the rest
269 ;; Structure of the meta-list:
270 ;; (HEADER SESSION1 SESSION2 ...)
271 ;; HEADER: (GROUP-BUF REGEXP OBJA OBJB OBJC SAVE-DIR COMPARISON-FUNC)
272 ;; OBJA - first directory
273 ;; OBJB - second directory
274 ;; OBJC - third directory
275 ;; SESSION1/2/... are described below
276 ;; group buffer/regexp
277 (defsubst ediff-get-group-buffer
(meta-list)
278 (nth 0 (car meta-list
)))
280 (defsubst ediff-get-group-regexp
(meta-list)
281 (nth 1 (car meta-list
)))
283 (defsubst ediff-get-group-objA
(meta-list)
284 (nth 2 (car meta-list
)))
285 (defsubst ediff-get-group-objB
(meta-list)
286 (nth 3 (car meta-list
)))
287 (defsubst ediff-get-group-objC
(meta-list)
288 (nth 4 (car meta-list
)))
289 (defsubst ediff-get-group-merge-autostore-dir
(meta-list)
290 (nth 5 (car meta-list
)))
291 (defsubst ediff-get-group-comparison-func
(meta-list)
292 (nth 6 (car meta-list
)))
294 ;; ELT is a session meta descriptor (what is being preserved as
296 ;; The structure is: (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
297 ;; STATUS is ?I (hidden or invalid), ?* (marked for operation), ?H (hidden)
299 ;; OBJA/B/C is (FILENAME EQSTATUS)
300 ;; EQSTATUS is ?= or nil (?= means that this file is equal to some other
301 ;; file in this session)
303 (defsubst ediff-get-session-buffer
(elt)
305 (defsubst ediff-get-session-status
(elt)
307 (defsubst ediff-set-session-status
(session-info new-status
)
308 (setcar (cdr session-info
) new-status
))
310 (defsubst ediff-get-session-objA
(elt)
312 (defsubst ediff-get-session-objB
(elt)
314 (defsubst ediff-get-session-objC
(elt)
316 ;; Take the "name" component of the object into acount. ObjA/C/B is of the form
317 ;; (name . equality-indicator)
318 (defsubst ediff-get-session-objA-name
(elt)
320 (defsubst ediff-get-session-objB-name
(elt)
322 (defsubst ediff-get-session-objC-name
(elt)
324 ;; equality indicators
325 (defsubst ediff-get-file-eqstatus
(elt)
327 (defsubst ediff-set-file-eqstatus
(elt value
)
328 (setcar (cdr elt
) value
))
330 ;; Create a new element for the meta list out of obj1/2/3, which usually are
333 ;; The first nil in such an element is later replaced with the session buffer.
334 ;; The second nil is reserved for session status.
336 ;; Also, session objects A/B/C are turned into lists of the form (obj nil).
337 ;; This nil is a placeholder for eq-indicator. It is either nil or =.
338 ;; If it is discovered that this file is = to some other
339 ;; file in the same session, eq-indicator is changed to `='.
340 ;; Curently, the eq-indicator is used only for 2 and 3-file jobs.
341 (defun ediff-make-new-meta-list-element (obj1 obj2 obj3
)
342 (list nil nil
(list obj1 nil
) (list obj2 nil
) (list obj3 nil
)))
344 ;; Constructs a meta list header.
345 ;; OBJA, OBJB, OBJC are usually directories involved, but can be different for
346 ;; different jobs. For instance, multifile patch has only OBJA, which is the
348 (defun ediff-make-new-meta-list-header (regexp
352 (list regexp objA objB objC merge-auto-store-dir comparison-func
))
354 ;; The activity marker is either or + (active session, i.e., ediff is currently
355 ;; run in it), or - (finished session, i.e., we've ran ediff in it and then
356 ;; exited). Return nil, if session is neither active nor finished
357 (defun ediff-get-session-activity-marker (session)
358 (let ((session-buf (ediff-get-session-buffer session
)))
359 (cond ((null session-buf
) nil
) ; virgin session
360 ((ediff-buffer-live-p session-buf
) ?
+) ;active session
363 ;; checks if the session is a meta session
364 (defun ediff-meta-session-p (session-info)
365 (and (stringp (ediff-get-session-objA-name session-info
))
366 (file-directory-p (ediff-get-session-objA-name session-info
))
367 (stringp (ediff-get-session-objB-name session-info
))
368 (file-directory-p (ediff-get-session-objB-name session-info
))
369 (if (stringp (ediff-get-session-objC-name session-info
))
370 (file-directory-p (ediff-get-session-objC-name session-info
)) t
)))
373 (ediff-defvar-local ediff-verbose-help-enabled nil
374 "If t, display redundant help in ediff-directories and other meta buffers.
375 Toggled by ediff-toggle-verbose-help-meta-buffer" )
377 ;; Toggle verbose help in meta-buffers
378 ;; TODO: Someone who understands all this can make it better.
379 (defun ediff-toggle-verbose-help-meta-buffer ()
380 "Toggle showing tediously verbose help in meta buffers."
382 (setq ediff-verbose-help-enabled
(not ediff-verbose-help-enabled
))
383 (ediff-update-meta-buffer (current-buffer) 'must-redraw
))
385 ;; set up the keymap in the meta buffer
386 (defun ediff-setup-meta-map ()
387 (setq ediff-meta-buffer-map
(make-sparse-keymap))
388 (suppress-keymap ediff-meta-buffer-map
)
389 (define-key ediff-meta-buffer-map
"?" 'ediff-toggle-verbose-help-meta-buffer
)
390 (define-key ediff-meta-buffer-map
"q" 'ediff-quit-meta-buffer
)
391 (define-key ediff-meta-buffer-map
"T" 'ediff-toggle-filename-truncation
)
392 (define-key ediff-meta-buffer-map
"R" 'ediff-show-registry
)
393 (define-key ediff-meta-buffer-map
"E" 'ediff-documentation
)
394 (define-key ediff-meta-buffer-map
"v" ediff-meta-action-function
)
395 (define-key ediff-meta-buffer-map
"\C-m" ediff-meta-action-function
)
396 (define-key ediff-meta-buffer-map
" " 'ediff-next-meta-item
)
397 (define-key ediff-meta-buffer-map
"n" 'ediff-next-meta-item
)
398 (define-key ediff-meta-buffer-map
"\C-?" 'ediff-previous-meta-item
)
399 (define-key ediff-meta-buffer-map
"p" 'ediff-previous-meta-item
)
400 (define-key ediff-meta-buffer-map
[delete] 'ediff-previous-meta-item)
401 (define-key ediff-meta-buffer-map [backspace] 'ediff-previous-meta-item)
402 (or (ediff-one-filegroup-metajob)
404 (define-key ediff-meta-buffer-map "=" nil)
405 (define-key ediff-meta-buffer-map "==" 'ediff-meta-mark-equal-files)
406 (define-key ediff-meta-buffer-map "=m" 'ediff-meta-mark-equal-files)
407 (define-key ediff-meta-buffer-map "=h" 'ediff-meta-mark-equal-files)))
408 (if ediff-no-emacs-help-in-control-buffer
409 (define-key ediff-meta-buffer-map "\C-h" 'ediff-previous-meta-item))
410 (if (featurep 'emacs)
411 (define-key ediff-meta-buffer-map [mouse-2] ediff-meta-action-function)
412 (define-key ediff-meta-buffer-map [button2] ediff-meta-action-function))
414 (use-local-map ediff-meta-buffer-map)
415 ;; modify ediff-meta-buffer-map here
416 (run-hooks 'ediff-meta-buffer-keymap-setup-hook))
419 (defun ediff-meta-mode ()
420 "This mode controls all operations on Ediff session groups.
421 It is entered through one of the following commands:
426 `ediff-merge-directories'
428 `ediff-merge-directories-with-ancestor'
429 `edirs-merge-with-ancestor'
430 `ediff-directory-revisions'
432 `ediff-merge-directory-revisions'
433 `edir-merge-revisions'
434 `ediff-merge-directory-revisions-with-ancestor'
435 `edir-merge-revisions-with-ancestor'
438 \\{ediff-meta-buffer-map}"
439 (kill-all-local-variables)
440 (setq major-mode 'ediff-meta-mode)
441 (setq mode-name "MetaEdiff")
442 ;; don't use run-mode-hooks here!
443 (run-hooks 'ediff-meta-mode-hook))
446 ;; the keymap for the buffer showing directory differences
447 (suppress-keymap ediff-dir-diffs-buffer-map)
448 (define-key ediff-dir-diffs-buffer-map "q" 'ediff-bury-dir-diffs-buffer)
449 (define-key ediff-dir-diffs-buffer-map " " 'next-line)
450 (define-key ediff-dir-diffs-buffer-map "n" 'next-line)
451 (define-key ediff-dir-diffs-buffer-map "\C-?" 'previous-line)
452 (define-key ediff-dir-diffs-buffer-map "p" 'previous-line)
453 (define-key ediff-dir-diffs-buffer-map "C" 'ediff-dir-diff-copy-file)
454 (if (featurep 'emacs)
455 (define-key ediff-dir-diffs-buffer-map [mouse-2] 'ediff-dir-diff-copy-file)
456 (define-key ediff-dir-diffs-buffer-map [button2] 'ediff-dir-diff-copy-file))
457 (define-key ediff-dir-diffs-buffer-map [delete] 'previous-line
)
458 (define-key ediff-dir-diffs-buffer-map
[backspace] 'previous-line)
460 (defun ediff-next-meta-item (count)
461 "Move to the next item in Ediff registry or session group buffer.
462 Moves in circular fashion. With numeric prefix arg, skip this many items."
464 (or count (setq count 1))
467 (setq count (1- count))
468 (ediff-next-meta-item1)
469 (setq overl (ediff-get-meta-overlay-at-pos (point)))
470 ;; skip invisible ones
471 (while (and overl (ediff-overlay-get overl 'invisible))
472 (ediff-next-meta-item1)
473 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
475 ;; Move to the next meta item
476 (defun ediff-next-meta-item1 ()
478 (setq pos (ediff-next-meta-overlay-start (point)))
479 (if pos (goto-char pos))
480 (if (eq ediff-metajob-name 'ediff-registry)
481 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
482 (search-forward "*Ediff" nil t))
483 (skip-chars-backward "a-zA-Z*"))
484 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
485 (backward-char 1)))))
488 (defun ediff-previous-meta-item (count)
489 "Move to the previous item in Ediff registry or session group buffer.
490 Moves in circular fashion. With numeric prefix arg, skip this many items."
492 (or count (setq count 1))
495 (setq count (1- count))
496 (ediff-previous-meta-item1)
497 (setq overl (ediff-get-meta-overlay-at-pos (point)))
498 ;; skip invisible ones
499 (while (and overl (ediff-overlay-get overl 'invisible))
500 (ediff-previous-meta-item1)
501 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
503 (defun ediff-previous-meta-item1 ()
505 (setq pos (ediff-previous-meta-overlay-start (point)))
507 ;;; (while (ediff-get-session-status
508 ;;; (ediff-get-meta-info (current-buffer) pos 'noerror))
509 ;;; (setq pos (ediff-previous-meta-overlay-start pos)))
511 (if pos (goto-char pos))
512 (if (eq ediff-metajob-name 'ediff-registry)
513 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
514 (search-forward "*Ediff" nil t))
515 (skip-chars-backward "a-zA-Z*"))
516 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
520 (defsubst ediff-add-slash-if-directory (dir file)
521 (if (file-directory-p (concat dir file))
522 (file-name-as-directory file)
525 (defun ediff-toggle-filename-truncation ()
526 "Toggle truncation of long file names in session group buffers.
527 Set `ediff-meta-truncate-filenames' variable if you want to change the default
530 (setq ediff-meta-truncate-filenames (not ediff-meta-truncate-filenames))
531 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
534 ;; These are used to encode membership of files in directory1/2/3
535 ;; Membership code of a file is a product of codes for the directories where
537 (defvar ediff-membership-code1 2)
538 (defvar ediff-membership-code2 3)
539 (defvar ediff-membership-code3 5)
540 (defvar ediff-product-of-memcodes (* ediff-membership-code1
541 ediff-membership-code2
542 ediff-membership-code3))
544 ;; DIR1, DIR2, DIR3 are directories. DIR3 can be nil.
545 ;; OUTPUT-DIR is a directory for auto-storing the results of merge jobs.
547 ;; REGEXP is nil or a filter regexp; only file names that match the regexp
549 ;; If a file is a directory in dir1 but not dir2 (or vice versa), it is not
550 ;; included in the intersection. However, a regular file that is a dir in dir3
551 ;; is included, since dir3 files are supposed to be ancestors for merging.
552 ;; If COMPARISON-FUNC is given, use it. Otherwise, use string=
554 ;; Returns a list of the form:
555 ;; (COMMON-PART DIFF-LIST)
556 ;; COMMON-PART is car and DIFF-LIST is cdr.
558 ;; COMMON-PART is of the form:
559 ;; (META-HEADER (f1 f2 f3) (f1 f2 f3) ...)
560 ;; f3 can be nil if intersecting only 2 directories.
561 ;; Each triple (f1 f2 f3) represents the files to be compared in the
562 ;; corresponding ediff subsession.
564 ;; DIFF-LIST is of the form:
565 ;; (META-HEADER (file . num) (file . num)...)
566 ;; where num encodes the set of dirs where the file is found:
567 ;; 2 - only dir1; 3 - only dir2; 5 - only dir3; 6 - dir1&2; 10 - dir1&3; etc.
569 ;; Contains the meta info about this ediff operation
570 ;; (regexp dir1 dir2 dir3 merge-auto-store-dir comparison-func)
571 ;; Later the meta-buffer is prepended to this list.
573 ;; Some operations might use a different meta header. For instance,
574 ;; ediff-multifile-patch doesn't have dir2 and dir3, and regexp,
575 ;; comparison-func don't apply.
577 (defun ediff-intersect-directories (jobname
580 dir3 merge-autostore-dir comparison-func)
581 (setq comparison-func (or comparison-func 'string=))
582 (let (lis1 lis2 lis3 common auxdir1 auxdir2 auxdir3 common-part difflist)
584 (setq auxdir1 (file-name-as-directory dir1)
585 lis1 (directory-files auxdir1 nil regexp)
586 lis1 (delete "." lis1)
587 lis1 (delete ".." lis1)
590 (ediff-add-slash-if-directory auxdir1 elt))
592 auxdir2 (file-name-as-directory dir2)
593 lis2 (directory-files auxdir2 nil regexp)
594 lis2 (delete "." lis2)
595 lis2 (delete ".." lis2)
598 (ediff-add-slash-if-directory auxdir2 elt))
602 (setq auxdir3 (file-name-as-directory dir3)
603 lis3 (directory-files auxdir3 nil regexp)
604 lis3 (delete "." lis3)
605 lis3 (delete ".." lis3)
608 (ediff-add-slash-if-directory auxdir3 elt))
611 (if (ediff-nonempty-string-p merge-autostore-dir)
612 (setq merge-autostore-dir
613 (file-name-as-directory merge-autostore-dir)))
614 (setq common (ediff-intersection lis1 lis2 comparison-func))
616 ;; In merge with ancestor jobs, we don't intersect with lis3.
617 ;; If there is no ancestor, we'll offer to merge without the ancestor.
618 ;; So, we intersect with lis3 only when we are doing 3-way file comparison
619 (if (and lis3 (ediff-comparison-metajob3 jobname))
620 (setq common (ediff-intersection common lis3 comparison-func)))
622 ;; copying is needed because sort sorts via side effects
623 (setq common (sort (ediff-copy-list common) 'string-lessp))
625 ;; compute difference list
626 (setq difflist (ediff-set-difference
627 (ediff-union (ediff-union lis1 lis2 comparison-func)
632 difflist (delete "." difflist)
633 ;; copying is needed because sort sorts via side effects
634 difflist (sort (ediff-copy-list (delete ".." difflist))
637 (setq difflist (mapcar (lambda (elt) (cons elt 1)) difflist))
639 ;; check for files belonging to lis1/2/3
640 ;; Each elt is of the norm (file . number)
641 ;; Number encodes the directories to which file belongs.
642 ;; It is a product of a subset of ediff-membership-code1=2,
643 ;; ediff-membership-code2=3, and ediff-membership-code3=5.
644 ;; If file belongs to dir 1 only, the membership code is 2.
645 ;; If it is in dir1 and dir3, then the membership code is 2*5=10;
646 ;; if it is in dir1 and dir2, then the membership code is 2*3=6, etc.
648 (if (member (car elt) lis1)
649 (setcdr elt (* (cdr elt) ediff-membership-code1)))
650 (if (member (car elt) lis2)
651 (setcdr elt (* (cdr elt) ediff-membership-code2)))
652 (if (member (car elt) lis3)
653 (setcdr elt (* (cdr elt) ediff-membership-code3)))
657 ;; diff metalist header
658 (ediff-make-new-meta-list-header regexp
659 auxdir1 auxdir2 auxdir3
667 (ediff-make-new-meta-list-header regexp
668 auxdir1 auxdir2 auxdir3
673 (ediff-make-new-meta-list-element
674 (expand-file-name (concat auxdir1 elt))
675 (expand-file-name (concat auxdir2 elt))
678 ;; The following is done because: In merging with
679 ;; ancestor, we don't intersect with lis3. So, it is
680 ;; possible that elt is a file in auxdir1/2 but a
681 ;; directory in auxdir3 Or elt may not exist in auxdir3 at
682 ;; all. In the first case, we add a slash at the end. In
683 ;; the second case, we insert nil.
684 (setq elt (ediff-add-slash-if-directory auxdir3 elt))
685 (if (file-exists-p (concat auxdir3 elt))
686 (expand-file-name (concat auxdir3 elt)))))))
689 (cons common-part difflist)
692 ;; find directory files that are under revision. Include subdirectories, since
693 ;; we may visit them recursively. DIR1 is the directory to inspect.
694 ;; MERGE-AUTOSTORE-DIR is the directory where to auto-store the results of
695 ;; merges. Can be nil.
696 (defun ediff-get-directory-files-under-revision (jobname
698 &optional merge-autostore-dir)
699 (let (lis1 elt common auxdir1)
700 (setq auxdir1 (file-name-as-directory dir1)
701 lis1 (directory-files auxdir1 nil regexp))
703 (if (ediff-nonempty-string-p merge-autostore-dir)
704 (setq merge-autostore-dir
705 (file-name-as-directory merge-autostore-dir)))
710 ;; take files under revision control
711 (cond ((file-directory-p (concat auxdir1 elt))
713 (cons (ediff-add-slash-if-directory auxdir1 elt) common)))
714 ((and (featurep 'vc-hooks) (vc-backend (concat auxdir1 elt)))
715 (setq common (cons elt common)))
716 ;; The following two are needed only if vc-hooks isn't loaded.
717 ;; They won't recognize CVS files.
718 ((file-exists-p (concat auxdir1 elt ",v"))
719 (setq common (cons elt common)))
720 ((file-exists-p (concat auxdir1 "RCS/" elt ",v"))
721 (setq common (cons elt common)))
725 (setq common (delete "./" common)
726 common (delete "../" common)
727 common (delete "RCS" common)
728 common (delete "CVS" common)
731 ;; copying is needed because sort sorts via side effects
732 (setq common (sort (ediff-copy-list common) 'string-lessp))
736 ;; header -- has 6 elements. Meta buffer is prepended later by
737 ;; ediff-prepare-meta-buffer
738 (ediff-make-new-meta-list-header regexp
740 merge-autostore-dir nil)
741 (mapcar (lambda (elt) (ediff-make-new-meta-list-element
742 (expand-file-name (concat auxdir1 elt)) nil nil))
747 ;; If file groups selected by patterns will ever be implemented, this
748 ;; comparison function might become useful.
749 ;;;; uses external variables PAT1 PAT2 to compare str1/2
750 ;;;; patterns must be of the form ???*???? where ??? are strings of chars
751 ;;;; containing no *.
752 ;;(defun ediff-pattern= (str1 str2)
753 ;; (let (pos11 pos12 pos21 pos22 len1 len2)
755 ;; len (length epat1)
757 ;; (while (and (< pos11 len) (not (= (aref epat1 pos11) ?*)))
758 ;; (setq pos11 (1+ pos11)))
759 ;; (while (and (> pos12 0) (not (= (aref epat1 (1- pos12)) ?*)))
760 ;; (setq pos12 (1- pos12)))
763 ;; len (length epat2)
765 ;; (while (and (< pos21 len) (not (= (aref epat2 pos21) ?*)))
766 ;; (setq pos21 (1+ pos21)))
767 ;; (while (and (> pos22 0) (not (= (aref epat2 (1- pos22)) ?*)))
768 ;; (setq pos22 (1- pos22)))
770 ;; (if (and (> (length str1) pos12) (>= pos12 pos11) (> pos11 -1)
771 ;; (> (length str2) pos22) (>= pos22 pos21) (> pos21 -1))
772 ;; (string= (substring str1 pos11 pos12)
773 ;; (substring str2 pos21 pos22)))
777 ;; Prepare meta-buffer in accordance with the argument-function and
778 ;; redraw-function. Must return the created meta-buffer.
779 (defun ediff-prepare-meta-buffer (action-func meta-list
780 meta-buffer-name redraw-function
781 jobname &optional startup-hooks)
782 (let* ((meta-buffer-name
783 (ediff-unique-buffer-name meta-buffer-name "*"))
784 (meta-buffer (get-buffer-create meta-buffer-name)))
785 (ediff-with-current-buffer meta-buffer
790 (setq ediff-meta-action-function action-func
791 ediff-meta-redraw-function redraw-function
792 ediff-metajob-name jobname
793 ediff-meta-buffer meta-buffer)
795 ;; comes after ediff-meta-action-function is set
796 (ediff-setup-meta-map)
798 (if (eq ediff-metajob-name 'ediff-registry)
800 (setq ediff-registry-buffer meta-buffer
801 ediff-meta-list meta-list)
802 ;; this func is used only from registry buffer, not from other
805 ediff-meta-buffer-map "M" 'ediff-show-meta-buff-from-registry))
806 ;; Initialize the meta list -- we don't do this for registry.
807 (setq ediff-meta-list
808 ;; add meta-buffer to the list header
809 (cons (cons meta-buffer (car meta-list))
812 (or (eq meta-buffer ediff-registry-buffer)
813 (setq ediff-session-registry
814 (cons meta-buffer ediff-session-registry)))
816 ;; redraw-function uses ediff-meta-list
817 (funcall redraw-function ediff-meta-list)
819 ;; set read-only/non-modified
820 (setq buffer-read-only t)
821 (set-buffer-modified-p nil)
823 (run-hooks 'startup-hooks)
825 ;; Arrange to show directory contents differences
826 ;; Must be after run startup-hooks, since ediff-dir-difference-list is
827 ;; set inside these hooks
828 (if (eq action-func 'ediff-filegroup-action)
830 ;; put meta buffer in (car ediff-dir-difference-list)
831 (setq ediff-dir-difference-list
832 (cons (cons meta-buffer (car ediff-dir-difference-list))
833 (cdr ediff-dir-difference-list)))
835 (or (ediff-one-filegroup-metajob jobname)
836 (ediff-draw-dir-diffs ediff-dir-difference-list))
838 ediff-meta-buffer-map "h" 'ediff-mark-for-hiding-at-pos)
839 (define-key ediff-meta-buffer-map "x" 'ediff-hide-marked-sessions)
841 ediff-meta-buffer-map "m" 'ediff-mark-for-operation-at-pos)
842 (define-key ediff-meta-buffer-map "u" nil)
844 ediff-meta-buffer-map "um" 'ediff-unmark-all-for-operation)
846 ediff-meta-buffer-map "uh" 'ediff-unmark-all-for-hiding)
847 (cond ((ediff-collect-diffs-metajob jobname)
849 ediff-meta-buffer-map "P" 'ediff-collect-custom-diffs))
850 ((ediff-patch-metajob jobname)
852 ediff-meta-buffer-map "P" 'ediff-meta-show-patch)))
853 (define-key ediff-meta-buffer-map "^" 'ediff-up-meta-hierarchy)
854 (define-key ediff-meta-buffer-map "D" 'ediff-show-dir-diffs)))
856 (if (eq ediff-metajob-name 'ediff-registry)
857 (run-hooks 'ediff-registry-setup-hook)
858 (run-hooks 'ediff-after-session-group-setup-hook))
859 ) ; eval in meta-buffer
862 ;; Insert the activity marker for session SESSION in the meta buffer at point
863 ;; The activity marker is either SPC (untouched session), or + (active session,
864 ;; i.e., ediff is currently run in it), or - (finished session, i.e., we've ran
865 ;; ediff in it and then exited)
866 (defun ediff-insert-session-activity-marker-in-meta-buffer (session)
868 (cond ((ediff-get-session-activity-marker session))
872 ;; Insert session status at point. Status is either ?H (marked for hiding), or
873 ;; ?I (hidden or invalid), or ?* (meaning marked for an operation; currently,
874 ;; such op can only be checking for equality)), or SPC (meaning neither marked
876 (defun ediff-insert-session-status-in-meta-buffer (session)
878 (cond ((ediff-get-session-status session)) ; session has status: ?H, ?I, ?*
879 ;; normal session, no marks or hidings
882 ;; If NEW-MARKER is non-nil, use it to substitute the current activity marker
883 ;; in the meta buffer. If nil, use SPC
884 (defun ediff-replace-session-activity-marker-in-meta-buffer (point new-marker)
885 (let* ((overl (ediff-get-meta-overlay-at-pos point))
886 (session-info (ediff-overlay-get overl 'ediff-meta-info))
887 (activity-marker (ediff-get-session-activity-marker session-info))
889 (or new-marker activity-marker (setq new-marker ?\s))
890 (goto-char (ediff-overlay-start overl))
891 (if (eq (char-after (point)) new-marker)
892 () ; if marker shown in buffer is the same as new-marker, do nothing
895 (set-buffer-modified-p nil))))
897 ;; If NEW-STATUS is non-nil, use it to substitute the current status marker in
898 ;; the meta buffer. If nil, use SPC
899 (defun ediff-replace-session-status-in-meta-buffer (point new-status)
900 (let* ((overl (ediff-get-meta-overlay-at-pos point))
901 (session-info (ediff-overlay-get overl 'ediff-meta-info))
902 (status (ediff-get-session-status session-info))
904 (setq new-status (or new-status status ?\s))
905 (goto-char (ediff-overlay-start overl))
906 (forward-char 1) ; status is the second char in session record
907 (if (eq (char-after (point)) new-status)
908 () ; if marker shown in buffer is the same as new-marker, do nothing
911 (set-buffer-modified-p nil))))
913 ;; insert all file info in meta buffer for a given session
914 (defun ediff-insert-session-info-in-meta-buffer (session-info sessionNum)
915 (let ((f1 (ediff-get-session-objA session-info))
916 (f2 (ediff-get-session-objB session-info))
917 (f3 (ediff-get-session-objC session-info))
919 (hidden (eq (ediff-get-session-status session-info) ?I)))
920 ;; insert activity marker, i.e., SPC, - or +
921 (ediff-insert-session-activity-marker-in-meta-buffer session-info)
922 ;; insert session status, i.e., *, H
923 (ediff-insert-session-status-in-meta-buffer session-info)
924 (insert " Session " (int-to-string sessionNum) ":\n")
925 (ediff-meta-insert-file-info1 f1)
926 (ediff-meta-insert-file-info1 f2)
927 (ediff-meta-insert-file-info1 f3)
928 (ediff-set-meta-overlay pt (point) session-info sessionNum hidden)))
931 ;; this is a setup function for ediff-directories
932 ;; must return meta-buffer
933 (defun ediff-redraw-directory-group-buffer (meta-list)
934 ;; extract directories
935 (let ((meta-buf (ediff-get-group-buffer meta-list))
938 regexp elt merge-autostore-dir
939 point tmp-list buffer-read-only)
940 (ediff-with-current-buffer meta-buf
943 ;; delete phony overlays that used to represent sessions before the buff
945 (if (featurep 'xemacs)
946 (map-extents 'delete-extent)
947 (mapc 'delete-overlay (overlays-in 1 1)))
949 (setq regexp (ediff-get-group-regexp meta-list)
951 (ediff-get-group-merge-autostore-dir meta-list))
953 (if ediff-verbose-help-enabled
955 (insert (format ediff-meta-buffer-verbose-message
956 (ediff-abbrev-jobname ediff-metajob-name)))
958 (cond ((ediff-collect-diffs-metajob)
960 " P:\tcollect custom diffs of all marked sessions\n"))
961 ((ediff-patch-metajob)
963 " P:\tshow patch appropriately for the context (session or group)\n")))
965 " ^:\tshow parent session group\n")
966 (or (ediff-one-filegroup-metajob)
968 " D:\tshow differences among directories\n"
969 " ==:\tfor each session, show which files are identical\n"
970 " =h:\tlike ==, but also marks sessions for hiding\n"
971 " =m:\tlike ==, but also marks sessions for operation\n\n")))
972 (insert (format ediff-meta-buffer-brief-message
973 (ediff-abbrev-jobname ediff-metajob-name))))
976 (if (and (stringp regexp) (> (length regexp) 0))
978 (format "*** Filter-through regular expression: %s\n" regexp)))
979 (ediff-insert-dirs-in-meta-buffer meta-list)
980 (if (and ediff-autostore-merges (ediff-merge-metajob)
981 (ediff-nonempty-string-p merge-autostore-dir))
983 "\nMerge results are automatically stored in:\n\t%s\n"
984 merge-autostore-dir)))
986 Size Last modified Name
987 ----------------------------------------------
991 ;; discard info on directories and regexp
992 (setq meta-list (cdr meta-list)
994 (while (and tmp-list empty)
995 (if (and (car tmp-list)
996 (not (eq (ediff-get-session-status (car tmp-list)) ?I)))
998 (setq tmp-list (cdr tmp-list)))
1002 " ****** ****** This session group has no members\n"))
1004 ;; now organize file names like this:
1005 ;; use-mark sizeA dateA sizeB dateB filename
1006 ;; make sure directories are displayed with a trailing slash.
1008 (setq elt (car meta-list)
1009 meta-list (cdr meta-list)
1010 sessionNum (1+ sessionNum))
1011 (if (eq (ediff-get-session-status elt) ?I)
1013 (ediff-insert-session-info-in-meta-buffer elt sessionNum)))
1014 (set-buffer-modified-p nil)
1018 (defun ediff-update-markers-in-dir-meta-buffer (meta-list)
1019 (let ((meta-buf (ediff-get-group-buffer meta-list))
1020 session-info point overl buffer-read-only)
1021 (ediff-with-current-buffer meta-buf
1022 (setq point (point))
1023 (goto-char (point-min))
1024 (ediff-next-meta-item1)
1026 (setq session-info (ediff-get-meta-info meta-buf (point) 'no-error)
1027 overl (ediff-get-meta-overlay-at-pos (point)))
1030 (cond ((eq (ediff-get-session-status session-info) ?I)
1032 (if overl (ediff-overlay-put overl 'invisible t)))
1033 ((and (eq (ediff-get-session-status session-info) ?H)
1034 overl (ediff-overlay-get overl 'invisible))
1036 (ediff-overlay-put overl 'invisible nil))
1037 (t (ediff-replace-session-activity-marker-in-meta-buffer
1039 (ediff-get-session-activity-marker session-info))
1040 (ediff-replace-session-status-in-meta-buffer
1042 (ediff-get-session-status session-info))))))
1043 (ediff-next-meta-item1) ; advance to the next item
1045 (set-buffer-modified-p nil)
1049 (defun ediff-update-session-marker-in-dir-meta-buffer (session-num)
1050 (let (buffer-meta-overlays session-info overl buffer-read-only)
1052 (if (featurep 'xemacs)
1054 (lambda (ext maparg)
1056 (ediff-overlay-get ext 'ediff-meta-info)
1057 (eq (ediff-overlay-get ext 'ediff-meta-session-number)
1060 ;; Emacs doesn't have map-extents, so try harder
1061 ;; Splice overlay lists to get all buffer overlays
1062 (setq buffer-meta-overlays (overlay-lists)
1063 buffer-meta-overlays (append (car buffer-meta-overlays)
1064 (cdr buffer-meta-overlays)))
1070 (ediff-overlay-get overl 'ediff-meta-info)
1071 (eq (ediff-overlay-get
1072 overl 'ediff-meta-session-number)
1075 buffer-meta-overlays)))))
1078 "Bug in ediff-update-session-marker-in-dir-meta-buffer: no overlay with given number %S"
1080 (setq session-info (ediff-overlay-get overl 'ediff-meta-info))
1081 (goto-char (ediff-overlay-start overl))
1082 (ediff-replace-session-activity-marker-in-meta-buffer
1084 (ediff-get-session-activity-marker session-info))
1085 (ediff-replace-session-status-in-meta-buffer
1087 (ediff-get-session-status session-info)))
1088 (ediff-next-meta-item1))
1092 ;; Check if this is a problematic session.
1093 ;; Return nil if not. Otherwise, return symbol representing the problem
1094 ;; At present, problematic sessions occur only in -with-ancestor comparisons
1095 ;; when the ancestor is a directory rather than a file, or when there is no
1096 ;; suitable ancestor file in the ancestor directory
1097 (defun ediff-problematic-session-p (session)
1098 (let ((f1 (ediff-get-session-objA-name session))
1099 (f2 (ediff-get-session-objB-name session))
1100 (f3 (ediff-get-session-objC-name session)))
1101 (cond ((and (stringp f1) (not (file-directory-p f1))
1102 (stringp f2) (not (file-directory-p f2))
1103 ;; either invalid file name or a directory
1104 (or (not (stringp f3)) (file-directory-p f3))
1105 (ediff-ancestor-metajob))
1106 ;; more may be added later
1110 (defun ediff-meta-insert-file-info1 (fileinfo)
1111 (let ((fname (car fileinfo))
1112 (feq (ediff-get-file-eqstatus fileinfo))
1113 (max-filename-width (if ediff-meta-truncate-filenames
1114 (- (window-width) 41)
1116 file-modtime file-size)
1117 (cond ((not (stringp fname)) (setq file-size -2)) ; file doesn't exits
1118 ((ediff-listable-file fname)
1119 (if (file-exists-p fname)
1120 ;; set real size and modtime
1121 (setq file-size (ediff-file-size fname)
1122 file-modtime (ediff-file-modtime fname))
1123 (setq file-size -2))) ; file doesn't exist
1124 ( t (setq file-size -1))) ; remote file
1129 (if feq "=" " ") ; equality indicator
1130 (format "%10s" (cond ((= file-size -1) "--")
1131 ((< file-size -1) "--")
1133 (cond ((= file-size -1) "*remote file*")
1134 ((< file-size -1) "*file doesn't exist*")
1135 (t (ediff-format-date (decode-time file-modtime))))
1137 ;; dir names in meta lists have training slashes, so we just
1138 ;; abbreviate the file name, if file exists
1139 (if (and (not (stringp fname)) (< file-size -1))
1140 "-------" ; file doesn't exist
1141 (ediff-truncate-string-left
1142 (ediff-abbreviate-file-name fname)
1143 max-filename-width)))))))
1145 (defconst ediff-months '((1 . "Jan") (2 . "Feb") (3 . "Mar") (4 . "Apr")
1146 (5 . "May") (6 . "Jun") (7 . "Jul") (8 . "Aug")
1147 (9 . "Sep") (10 . "Oct") (11 . "Nov") (12 . "Dec"))
1148 "Months' associative array.")
1150 ;; returns 2char string
1151 (defsubst ediff-fill-leading-zero (num)
1154 (number-to-string num)))
1156 ;; TIME is like the output of decode-time
1157 (defun ediff-format-date (time)
1158 (format "%s %2d %4d %s:%s:%s"
1159 (cdr (assoc (nth 4 time) ediff-months)) ; month
1162 (ediff-fill-leading-zero (nth 2 time)) ; hour
1163 (ediff-fill-leading-zero (nth 1 time)) ; min
1164 (ediff-fill-leading-zero (nth 0 time)) ; sec
1167 ;; Draw the directories
1168 (defun ediff-insert-dirs-in-meta-buffer (meta-list)
1169 (let* ((dir1 (ediff-abbreviate-file-name (ediff-get-group-objA meta-list)))
1170 (dir2 (ediff-get-group-objB meta-list))
1171 (dir2 (if (stringp dir2) (ediff-abbreviate-file-name dir2)))
1172 (dir3 (ediff-get-group-objC meta-list))
1173 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3))))
1174 (insert "*** Directory A: " dir1 "\n")
1175 (if dir2 (insert "*** Directory B: " dir2 "\n"))
1176 (if dir3 (insert "*** Directory C: " dir3 "\n"))
1179 (defun ediff-draw-dir-diffs (diff-list &optional buf-name)
1180 (if (null diff-list) (error "Lost difference info on these directories"))
1183 (ediff-unique-buffer-name "*Ediff File Group Differences" "*")))
1184 (let* ((regexp (ediff-get-group-regexp diff-list))
1185 (dir1 (ediff-abbreviate-file-name (ediff-get-group-objA diff-list)))
1186 (dir2 (ediff-abbreviate-file-name (ediff-get-group-objB diff-list)))
1187 (dir3 (ediff-get-group-objC diff-list))
1188 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3)))
1189 (meta-buf (ediff-get-group-buffer diff-list))
1190 (underline (make-string 26 ?-))
1191 file membership-code saved-point
1193 ;; skip the directory part
1194 (setq diff-list (cdr diff-list))
1195 (setq ediff-dir-diffs-buffer (get-buffer-create buf-name))
1196 (ediff-with-current-buffer ediff-dir-diffs-buffer
1197 (setq saved-point (point))
1198 (use-local-map ediff-dir-diffs-buffer-map)
1200 (setq ediff-meta-buffer meta-buf)
1201 (insert "\t\t*** Directory Differences ***\n")
1204 C,button2: over file name -- copy this file to directory that doesn't have it
1207 p,DEL: previous line\n\n")
1209 (insert (format "\n*** Directory A: %s\n" dir1))
1210 (if dir2 (insert (format "*** Directory B: %s\n" dir2)))
1211 (if dir3 (insert (format "*** Directory C: %s\n" dir3)))
1212 (if (and (stringp regexp) (> (length regexp) 0))
1214 (format "*** Filter-through regular expression: %s\n" regexp)))
1216 (insert (format "\n%-27s%-26s" "Directory A" "Directory B"))
1218 (insert (format " %-25s\n" "Directory C"))
1220 (insert (format "%s%s" underline underline))
1222 (insert (format "%s\n\n" underline))
1225 (if (null diff-list)
1226 (insert "\n\t*** No differences ***\n"))
1229 (setq file (car (car diff-list))
1230 membership-code (cdr (car diff-list))
1231 diff-list (cdr diff-list))
1232 (if (= (mod membership-code ediff-membership-code1) 0) ; dir1
1233 (let ((beg (point)))
1234 (insert (format "%-27s"
1235 (ediff-truncate-string-left
1236 (ediff-abbreviate-file-name
1237 (if (file-directory-p (concat dir1 file))
1238 (file-name-as-directory file)
1241 ;; format of meta info in the dir-diff-buffer:
1242 ;; (filename-tail filename-full otherdir1 otherdir2 otherdir3)
1243 (ediff-set-meta-overlay
1245 (list meta-buf file (concat dir1 file) dir1 dir2 dir3)))
1246 (insert (format "%-27s" "---")))
1247 (if (= (mod membership-code ediff-membership-code2) 0) ; dir2
1248 (let ((beg (point)))
1249 (insert (format "%-26s"
1250 (ediff-truncate-string-left
1251 (ediff-abbreviate-file-name
1252 (if (file-directory-p (concat dir2 file))
1253 (file-name-as-directory file)
1256 (ediff-set-meta-overlay
1258 (list meta-buf file (concat dir2 file) dir1 dir2 dir3)))
1259 (insert (format "%-26s" "---")))
1261 (if (= (mod membership-code ediff-membership-code3) 0) ; dir3
1262 (let ((beg (point)))
1263 (insert (format " %-25s"
1264 (ediff-truncate-string-left
1265 (ediff-abbreviate-file-name
1266 (if (file-directory-p (concat dir3 file))
1267 (file-name-as-directory file)
1270 (ediff-set-meta-overlay
1272 (list meta-buf file (concat dir3 file) dir1 dir2 dir3)))
1273 (insert (format " %-25s" "---"))))
1275 (setq buffer-read-only t)
1276 (set-buffer-modified-p nil)
1277 (goto-char saved-point)) ; end eval in diff buffer
1280 (defun ediff-bury-dir-diffs-buffer ()
1281 "Bury the directory difference buffer. Display the meta buffer instead."
1283 ;; ediff-meta-buffer is set in ediff-draw-dir-diffs so the directory
1284 ;; difference buffer remembers the meta buffer
1285 (let ((buf ediff-meta-buffer)
1287 (ediff-kill-buffer-carefully ediff-dir-diffs-buffer)
1288 (if (setq wind (ediff-get-visible-buffer-window buf))
1289 (select-window wind)
1290 (set-window-buffer (selected-window) buf))))
1292 ;; executes in dir session group buffer
1293 ;; show buffer differences
1294 (defun ediff-show-dir-diffs ()
1295 "Display differences among the directories involved in session group."
1297 (if (ediff-one-filegroup-metajob)
1298 (error "This command is inapplicable in the present context"))
1299 (or (ediff-buffer-live-p ediff-dir-diffs-buffer)
1300 (ediff-draw-dir-diffs ediff-dir-difference-list))
1301 (let ((buf ediff-dir-diffs-buffer))
1303 (set-window-buffer (selected-window) buf)
1304 (goto-char (point-min))))
1306 ;; Format of meta info in dir-diff-buffer:
1307 ;; (filename-tail filename-full otherdir1 otherdir2)
1308 (defun ediff-dir-diff-copy-file ()
1309 "Copy file described at point to directories where this file is missing."
1311 (let* ((pos (ediff-event-point last-command-event))
1312 (info (ediff-get-meta-info (current-buffer) pos 'noerror))
1313 (meta-buf (car info))
1314 (file-tail (nth 1 info))
1315 (file-abs (nth 2 info))
1316 (otherdir1 (nth 3 info))
1317 (otherfile1 (if otherdir1 (concat otherdir1 file-tail)))
1318 (otherdir2 (nth 4 info))
1319 (otherfile2 (if otherdir2 (concat otherdir2 file-tail)))
1320 (otherdir3 (nth 5 info))
1321 (otherfile3 (if otherdir3 (concat otherdir3 file-tail)))
1322 meta-list dir-diff-list
1325 (error "No file suitable for copying described at this location"))
1326 (ediff-with-current-buffer meta-buf
1327 (setq meta-list ediff-meta-list
1328 dir-diff-list ediff-dir-difference-list))
1330 ;; copy file to directories where it doesn't exist, update
1331 ;; ediff-dir-difference-list and redisplay
1333 (lambda (otherfile-struct)
1334 (let ((otherfile (car otherfile-struct))
1335 (file-mem-code (cdr otherfile-struct)))
1337 (or (file-exists-p otherfile)
1339 (format "Copy %s to %s? " file-abs otherfile))
1340 (let* ((file-diff-record (assoc file-tail dir-diff-list))
1342 (* (cdr file-diff-record) file-mem-code)))
1343 (copy-file file-abs otherfile)
1344 (setcdr file-diff-record new-mem-code)
1345 (ediff-draw-dir-diffs dir-diff-list (buffer-name))
1347 ;; if file is in all three dirs or in two dirs and only
1348 ;; two dirs are involved, delete this file's record
1349 (if (or (= new-mem-code ediff-product-of-memcodes)
1350 (and (> new-mem-code ediff-membership-code3)
1352 (delq file-diff-record dir-diff-list))
1355 ;; 2,3,5 are numbers used to encode membership of a file in
1356 ;; dir1/2/3. See ediff-intersect-directories.
1357 (list (cons otherfile1 2) (cons otherfile2 3) (cons otherfile3 5)))
1359 (if (and (file-exists-p otherfile1)
1360 (file-exists-p otherfile2)
1361 (or (not otherfile3) (file-exists-p otherfile3)))
1362 ;; update ediff-meta-list by direct modification
1364 (list (ediff-make-new-meta-list-element
1365 (expand-file-name otherfile1)
1366 (expand-file-name otherfile2)
1368 (expand-file-name otherfile3)))))
1370 (ediff-update-meta-buffer meta-buf 'must-redraw)
1373 (defun ediff-up-meta-hierarchy ()
1374 "Go to the parent session group buffer."
1376 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
1377 (ediff-show-meta-buffer
1378 ediff-parent-meta-buffer ediff-meta-session-number)
1379 (error "This session group has no parent")))
1382 ;; argument is ignored
1383 (defun ediff-redraw-registry-buffer (&optional ignore)
1384 (ediff-with-current-buffer ediff-registry-buffer
1385 (let ((point (point))
1386 elt bufAname bufBname bufCname cur-diff total-diffs pt
1387 job-name meta-list registry-list buffer-read-only)
1389 ;; delete phony overlays that used to represent sessions before the buff
1391 (if (featurep 'xemacs)
1392 (map-extents 'delete-extent)
1393 (mapc 'delete-overlay (overlays-in 1 1)))
1395 (insert "This is a registry of all active Ediff sessions.
1398 button2, `v', RET over a session record: switch to that session
1399 M over a session record: display the associated session group
1400 R in any Ediff session: display session registry
1402 p,DEL: previous session
1403 E: browse Ediff on-line manual
1407 \t\tActive Ediff Sessions:
1408 \t\t----------------------
1411 ;; purge registry list from dead buffers
1413 (if (not (ediff-buffer-live-p elt))
1414 (setq ediff-session-registry
1415 (delq elt ediff-session-registry))))
1416 ediff-session-registry)
1418 (if (null ediff-session-registry)
1419 (insert " ******* No active Ediff sessions *******\n"))
1421 (setq registry-list ediff-session-registry)
1422 (while registry-list
1423 (setq elt (car registry-list)
1424 registry-list (cdr registry-list))
1426 (if (ediff-buffer-live-p elt)
1427 (if (ediff-with-current-buffer elt
1428 (setq job-name ediff-metajob-name
1429 meta-list ediff-meta-list)
1430 (and ediff-metajob-name
1431 (not (eq ediff-metajob-name 'ediff-registry))))
1434 (insert (format " *group*\t%s: %s\n"
1436 (ediff-abbrev-jobname job-name)))
1437 (insert (format "\t\t %s %s %s\n"
1438 (ediff-abbreviate-file-name
1439 (ediff-get-group-objA meta-list))
1440 (ediff-abbreviate-file-name
1442 (ediff-get-group-objB meta-list))
1443 (ediff-get-group-objB meta-list)
1445 (ediff-abbreviate-file-name
1447 (ediff-get-group-objC meta-list))
1448 (ediff-get-group-objC meta-list)
1450 (ediff-set-meta-overlay pt (point) elt))
1452 (ediff-with-current-buffer elt
1453 (setq bufAname (if (ediff-buffer-live-p ediff-buffer-A)
1454 (buffer-name ediff-buffer-A)
1455 "!!!killed buffer!!!")
1456 bufBname (if (ediff-buffer-live-p ediff-buffer-B)
1457 (buffer-name ediff-buffer-B)
1458 "!!!killed buffer!!!")
1459 bufCname (cond ((not (ediff-3way-job))
1461 ((ediff-buffer-live-p ediff-buffer-C)
1462 (buffer-name ediff-buffer-C))
1463 (t "!!!killed buffer!!!")))
1464 (setq total-diffs (format "%-4d" ediff-number-of-differences)
1466 (cond ((= ediff-current-difference -1) " _")
1467 ((= ediff-current-difference
1468 ediff-number-of-differences)
1471 "%4d" (1+ ediff-current-difference))))
1472 job-name ediff-job-name))
1473 ;; back in the meta buf
1475 (insert cur-diff "/" total-diffs "\t"
1477 (format ": %s" (ediff-abbrev-jobname job-name)))
1479 "\n\t\t " bufAname " " bufBname " " bufCname "\n")
1480 (ediff-set-meta-overlay pt (point) elt))))
1482 (set-buffer-modified-p nil)
1486 ;; Sets overlay around a meta record with 'ediff-meta-info property PROP
1487 ;; If optional SESSION-NUMBER, make it a property of the overlay,
1488 ;; ediff-meta-session-number
1489 ;; PROP is either the ctl or meta buffer (used when we work with the registry)
1490 ;; or a session meta descriptor of the form
1491 ;; (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
1492 (defun ediff-set-meta-overlay (b e prop &optional session-number hidden)
1494 (setq overl (ediff-make-overlay b e))
1495 (if (featurep 'emacs)
1496 (ediff-overlay-put overl 'mouse-face 'highlight)
1497 (ediff-overlay-put overl 'highlight t))
1498 (ediff-overlay-put overl 'ediff-meta-info prop)
1499 (ediff-overlay-put overl 'invisible hidden)
1500 (ediff-overlay-put overl 'follow-link t)
1501 (if (numberp session-number)
1502 (ediff-overlay-put overl 'ediff-meta-session-number session-number))))
1504 (defun ediff-mark-for-hiding-at-pos (unmark)
1505 "Mark session for hiding. With prefix arg, unmark."
1507 (let* ((pos (ediff-event-point last-command-event))
1508 (meta-buf (ediff-event-buffer last-command-event))
1509 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1510 (info (ediff-get-meta-info meta-buf pos))
1511 (session-number (ediff-get-session-number-at-pos pos)))
1512 (ediff-mark-session-for-hiding info unmark)
1513 (ediff-next-meta-item 1)
1515 (ediff-update-meta-buffer meta-buf nil session-number))
1518 ;; Returns whether session was marked or unmarked
1519 (defun ediff-mark-session-for-hiding (info unmark)
1520 (let ((session-buf (ediff-get-session-buffer info))
1522 (cond ((eq unmark 'mark) (setq unmark nil))
1523 ((eq (ediff-get-session-status info) ?H) (setq unmark t))
1524 (unmark ; says unmark, but the marker is different from H
1527 (unmark (ediff-set-session-status info nil))
1528 ;;; (if (ediff-buffer-live-p session-buf)
1529 ;;; (error "Can't hide active session, %s" (buffer-name session-buf)))
1530 (t (ediff-set-session-status info ?H))))
1534 (defun ediff-mark-for-operation-at-pos (unmark)
1535 "Mark session for a group operation. With prefix arg, unmark."
1537 (let* ((pos (ediff-event-point last-command-event))
1538 (meta-buf (ediff-event-buffer last-command-event))
1539 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1540 (info (ediff-get-meta-info meta-buf pos))
1541 (session-number (ediff-get-session-number-at-pos pos)))
1542 (ediff-mark-session-for-operation info unmark)
1543 (ediff-next-meta-item 1)
1545 (ediff-update-meta-buffer meta-buf nil session-number))
1549 ;; returns whether session was unmarked.
1550 ;; remember: this is a toggle op
1551 (defun ediff-mark-session-for-operation (info unmark)
1553 (cond ((eq unmark 'mark) (setq unmark nil))
1554 ((eq (ediff-get-session-status info) ?*) (setq unmark t))
1555 (unmark ; says unmark, but the marker is different from *
1558 (unmark (ediff-set-session-status info nil))
1559 (t (ediff-set-session-status info ?*))))
1563 (defun ediff-hide-marked-sessions (unhide)
1564 "Hide marked sessions. With prefix arg, unhide."
1566 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1567 (meta-list (cdr ediff-meta-list))
1568 (from (if unhide ?I ?H))
1569 (to (if unhide ?H ?I))
1571 active-sessions-exist session-buf elt)
1573 (setq elt (car meta-list)
1574 meta-list (cdr meta-list)
1575 session-buf (ediff-get-session-buffer elt))
1577 (if (eq (ediff-get-session-status elt) from)
1579 (setq numMarked (1+ numMarked))
1580 (if (and (eq to ?I) (buffer-live-p session-buf))
1581 ;; shouldn't hide active sessions
1582 (setq active-sessions-exist t)
1583 (ediff-set-session-status elt to)))))
1585 (ediff-update-meta-buffer grp-buf 'must-redraw)
1588 (message "Nothing to reveal...")
1589 (message "Nothing to hide...")))
1590 (if active-sessions-exist
1591 (message "Note: Ediff didn't hide active sessions!"))
1594 ;; Apply OPERATION to marked sessions. Operation expects one argument of type
1595 ;; meta-list member (not the first one), i.e., a regular session description.
1596 ;; Returns number of marked sessions on which operation was performed
1597 (defun ediff-operate-on-marked-sessions (operation)
1598 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1599 (meta-list (cdr ediff-meta-list))
1603 (diff-buffer ediff-meta-diff-buffer)
1606 (setq elt (car meta-list)
1607 meta-list (cdr meta-list)
1608 sessionNum (1+ sessionNum))
1609 (cond ((eq (ediff-get-session-status elt) marksym)
1611 (setq numMarked (1+ numMarked))
1612 (funcall operation elt sessionNum)))
1613 ;; The following goes into a session represented by a subdirectory
1614 ;; and applies operation to marked sessions there
1615 ((and (ediff-meta-session-p elt)
1616 (ediff-buffer-live-p
1617 (setq session-buf (ediff-get-session-buffer elt))))
1620 (ediff-with-current-buffer session-buf
1621 ;; pass meta-diff along
1622 (setq ediff-meta-diff-buffer diff-buffer)
1623 ;; collect diffs in child group
1624 (ediff-operate-on-marked-sessions operation)))))))
1625 (ediff-update-meta-buffer grp-buf 'must-redraw) ; just in case
1629 (defun ediff-append-custom-diff (session sessionNum)
1630 (or (ediff-collect-diffs-metajob)
1631 (error "Can't compute multifile patch in this context"))
1632 (let ((session-buf (ediff-get-session-buffer session))
1633 (meta-diff-buff ediff-meta-diff-buffer)
1634 (metajob ediff-metajob-name)
1635 tmp-buf custom-diff-buf)
1636 (if (ediff-buffer-live-p session-buf)
1637 (ediff-with-current-buffer session-buf
1638 (if (eq ediff-control-buffer session-buf) ; individual session
1640 (ediff-compute-custom-diffs-maybe)
1641 (setq custom-diff-buf ediff-custom-diff-buffer)))))
1643 (or (ediff-buffer-live-p meta-diff-buff)
1644 (error "Ediff: something wrong--killed multiple diff's buffer"))
1646 (cond ((ediff-buffer-live-p custom-diff-buf)
1647 ;; for live session buffers we do them first because the user may
1648 ;; have changed them with respect to the underlying files
1650 (set-buffer meta-diff-buff)
1651 (goto-char (point-max))
1652 (insert-buffer-substring custom-diff-buf)
1654 ;; if ediff session is not live, run diff directly on the files
1655 ((memq metajob '(ediff-directories
1656 ediff-merge-directories
1657 ediff-merge-directories-with-ancestor))
1658 ;; get diffs by calling shell command on ediff-custom-diff-program
1660 (set-buffer (setq tmp-buf (get-buffer-create ediff-tmp-buffer)))
1665 (shell-quote-argument ediff-custom-diff-program)
1666 ediff-custom-diff-options
1667 (shell-quote-argument (ediff-get-session-objA-name session))
1668 (shell-quote-argument (ediff-get-session-objB-name session))
1673 (set-buffer meta-diff-buff)
1674 (goto-char (point-max))
1675 (insert-buffer-substring tmp-buf)
1678 (ediff-kill-buffer-carefully meta-diff-buff)
1679 (error "Session %d compares versions of file. Such session must be active to enable multifile patch collection" sessionNum )))
1682 (defun ediff-collect-custom-diffs ()
1683 "Collect custom diffs of marked sessions in buffer `*Ediff Multifile Diffs*'.
1684 This operation is defined only for `ediff-directories' and
1685 `ediff-directory-revisions', since its intent is to produce
1686 multifile patches. For `ediff-directory-revisions', we insist that
1687 all marked sessions must be active."
1689 (let ((coding-system-for-read ediff-coding-system-for-read))
1690 (or (ediff-buffer-live-p ediff-meta-diff-buffer)
1691 (setq ediff-meta-diff-buffer
1693 (ediff-unique-buffer-name "*Ediff Multifile Diffs" "*"))))
1694 (ediff-with-current-buffer ediff-meta-diff-buffer
1695 (setq buffer-read-only nil)
1697 (if (> (ediff-operate-on-marked-sessions 'ediff-append-custom-diff) 0)
1700 (display-buffer ediff-meta-diff-buffer 'not-this-window)
1701 (ediff-with-current-buffer ediff-meta-diff-buffer
1702 (set-buffer-modified-p nil)
1703 (setq buffer-read-only t))
1704 (if (fboundp 'diff-mode)
1705 (with-current-buffer ediff-meta-diff-buffer
1708 (message "No marked sessions found"))))
1710 (defun ediff-meta-show-patch ()
1711 "Show the multi-file patch associated with this group session."
1713 (let* ((pos (ediff-event-point last-command-event))
1714 (meta-buf (ediff-event-buffer last-command-event))
1715 (info (ediff-get-meta-info meta-buf pos 'noerror))
1716 (patchbuffer ediff-meta-patchbufer))
1717 (if (ediff-buffer-live-p patchbuffer)
1718 (ediff-with-current-buffer patchbuffer
1723 (ediff-get-session-objB-name info)
1724 (ediff-get-session-objC-name info)))
1725 (set-buffer (get-buffer-create ediff-tmp-buffer))
1727 (insert-buffer-substring patchbuffer)
1728 (goto-char (point-min))
1729 (display-buffer ediff-tmp-buffer 'not-this-window)
1731 (error "The patch buffer wasn't found"))))
1734 ;; This function executes in meta buffer. It knows where event happened.
1735 (defun ediff-filegroup-action ()
1736 "Execute appropriate action for a selected session."
1738 (let* ((pos (ediff-event-point last-command-event))
1739 (meta-buf (ediff-event-buffer last-command-event))
1740 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1741 (info (ediff-get-meta-info meta-buf pos))
1742 (session-buf (ediff-get-session-buffer info))
1743 (session-number (ediff-get-session-number-at-pos pos meta-buf))
1744 (default-regexp (eval ediff-default-filtering-regexp))
1745 merge-autostore-dir file1 file2 file3 regexp)
1747 (setq file1 (ediff-get-session-objA-name info)
1748 file2 (ediff-get-session-objB-name info)
1749 file3 (ediff-get-session-objC-name info))
1751 ;; make sure we don't start on hidden sessions
1752 ;; ?H means marked for hiding. ?I means invalid (hidden).
1753 (if (memq (ediff-get-session-status info) '(?I))
1756 (if (y-or-n-p "This session is marked as hidden, unmark? ")
1758 (ediff-set-session-status info nil)
1759 (ediff-update-meta-buffer meta-buf nil session-number))
1760 (error "Aborted"))))
1762 (ediff-with-current-buffer meta-buf
1763 (setq merge-autostore-dir
1764 (ediff-get-group-merge-autostore-dir ediff-meta-list))
1765 (goto-char pos) ; if the user clicked on session--move point there
1766 ;; First handle sessions involving directories (which are themselves
1768 ;; After that handle individual sessions
1769 (cond ((ediff-meta-session-p info)
1770 ;; do ediff/ediff-merge on subdirectories
1771 (if (ediff-buffer-live-p session-buf)
1772 (ediff-show-meta-buffer session-buf)
1775 (if (stringp default-regexp)
1777 "Filter through regular expression (default %s): "
1779 "Filter through regular expression: ")
1781 'ediff-filtering-regexp-history
1782 (eval ediff-default-filtering-regexp)))
1783 (ediff-directories-internal
1784 file1 file2 file3 regexp
1785 ediff-session-action-function
1787 ;; make it update (car info) after startup
1789 ;; child session group should know its parent
1790 (setq ediff-parent-meta-buffer
1791 (quote ,ediff-meta-buffer)
1792 ediff-meta-session-number
1794 ;; and parent will know its child
1795 (setcar (quote ,info) ediff-meta-buffer))))))
1797 ;; Do ediff-revision on a subdirectory
1798 ((and (ediff-one-filegroup-metajob)
1799 (ediff-revision-metajob)
1800 (file-directory-p file1))
1801 (if (ediff-buffer-live-p session-buf)
1802 (ediff-show-meta-buffer session-buf)
1803 (setq regexp (read-string "Filter through regular expression: "
1804 nil 'ediff-filtering-regexp-history))
1805 (ediff-directory-revisions-internal
1807 ediff-session-action-function ediff-metajob-name
1808 ;; make it update (car info) after startup
1810 ;; child session group should know its parent and
1812 (setq ediff-parent-meta-buffer
1813 (quote ,ediff-meta-buffer)
1814 ediff-meta-session-number
1816 ;; and parent will know its child
1817 (setcar (quote ,info) ediff-meta-buffer))))))
1819 ;; From here on---only individual session handlers
1821 ;; handle an individual session with a live control buffer
1822 ((ediff-buffer-live-p session-buf)
1823 (ediff-with-current-buffer session-buf
1824 (setq ediff-mouse-pixel-position (mouse-pixel-position))
1825 (ediff-recenter 'no-rehighlight)))
1827 ((ediff-problematic-session-p info)
1830 "This session has no ancestor. Merge without the ancestor? ")
1833 ;; provide startup hooks
1836 'ediff-after-quit-hook-internal
1838 (if (ediff-buffer-live-p ,(current-buffer))
1839 (ediff-show-meta-buffer
1840 ,(current-buffer) ,session-number)))
1842 (setq ediff-meta-buffer ,(current-buffer)
1843 ediff-meta-session-number
1845 (setq ediff-merge-store-file
1846 ,(if (ediff-nonempty-string-p
1847 merge-autostore-dir)
1850 ediff-merge-filename-prefix
1851 (file-name-nondirectory file1))
1853 ;; make ediff-startup pass
1854 ;; ediff-control-buffer back to the meta
1857 (quote ,info) ediff-control-buffer))))
1859 ((ediff-one-filegroup-metajob) ; needs 1 file arg
1860 (funcall ediff-session-action-function
1862 ;; provide startup hooks
1865 'ediff-after-quit-hook-internal
1867 (if (ediff-buffer-live-p
1869 (ediff-show-meta-buffer
1873 (setq ediff-meta-buffer ,(current-buffer)
1874 ediff-meta-session-number
1876 (setq ediff-merge-store-file
1877 ,(if (ediff-nonempty-string-p
1878 merge-autostore-dir)
1881 ediff-merge-filename-prefix
1882 (file-name-nondirectory file1))) )
1883 ;; make ediff-startup pass
1884 ;; ediff-control-buffer back to the meta
1887 (quote ,info) ediff-control-buffer)))))
1888 ((not (ediff-metajob3)) ; need 2 file args
1889 (funcall ediff-session-action-function
1891 ;; provide startup hooks
1894 'ediff-after-quit-hook-internal
1896 (if (ediff-buffer-live-p
1898 (ediff-show-meta-buffer
1902 (setq ediff-meta-buffer ,(current-buffer)
1903 ediff-meta-session-number
1905 (setq ediff-merge-store-file
1906 ,(if (ediff-nonempty-string-p
1907 merge-autostore-dir)
1910 ediff-merge-filename-prefix
1911 (file-name-nondirectory file1))) )
1912 ;; make ediff-startup pass
1913 ;; ediff-control-buffer back to the meta
1916 (quote ,info) ediff-control-buffer)))))
1917 ((ediff-metajob3) ; need 3 file args
1918 (funcall ediff-session-action-function
1920 ;; arrange startup hooks
1923 'ediff-after-quit-hook-internal
1925 (if (ediff-buffer-live-p
1927 (ediff-show-meta-buffer
1931 (setq ediff-merge-store-file
1932 ,(if (ediff-nonempty-string-p
1933 merge-autostore-dir)
1936 ediff-merge-filename-prefix
1937 (file-name-nondirectory file1))) )
1938 (setq ediff-meta-buffer , (current-buffer)
1939 ediff-meta-session-number
1941 ;; this arranges that ediff-startup will pass
1942 ;; the value of ediff-control-buffer back to
1943 ;; the meta level, to the record in the meta
1944 ;; list containing the information about the
1945 ;; session associated with that
1946 ;; ediff-control-buffer
1948 (quote ,info) ediff-control-buffer)))))
1950 ) ; eval in meta-buf
1953 (defun ediff-registry-action ()
1954 "Switch to a selected session."
1956 (let* ((pos (ediff-event-point last-command-event))
1957 (buf (ediff-event-buffer last-command-event))
1958 (ctl-buf (ediff-get-meta-info buf pos)))
1960 (if (ediff-buffer-live-p ctl-buf)
1961 ;; check if this is ediff-control-buffer or ediff-meta-buffer
1962 (if (ediff-with-current-buffer ctl-buf
1963 (eq (key-binding "q") 'ediff-quit-meta-buffer))
1964 ;; it's a meta-buffer -- last action should just display it
1965 (ediff-show-meta-buffer ctl-buf t)
1966 ;; it's a session buffer -- invoke go back to session
1967 (ediff-with-current-buffer ctl-buf
1968 (setq ediff-mouse-pixel-position (mouse-pixel-position))
1969 (ediff-recenter 'no-rehighlight)))
1971 (message "You've selected a stale session --- try again")
1972 (ediff-update-registry))
1973 (ediff-with-current-buffer buf
1978 ;; If session number is t, means don't update meta buffer
1979 (defun ediff-show-meta-buffer (&optional meta-buf session-number)
1980 "Show the session group buffer."
1982 (run-hooks 'ediff-before-directory-setup-hooks)
1983 (let (wind frame silent)
1984 (if meta-buf (setq silent t))
1986 (setq meta-buf (or meta-buf ediff-meta-buffer))
1987 (cond ((not (bufferp meta-buf))
1988 (error "This Ediff session is not part of a session group"))
1989 ((not (ediff-buffer-live-p meta-buf))
1991 "Can't find this session's group panel -- session itself is ok")))
1993 (cond ((numberp session-number)
1994 (ediff-update-meta-buffer meta-buf nil session-number))
1995 ;; if session-number is t, don't update
1997 (t (ediff-cleanup-meta-buffer meta-buf)))
1999 (ediff-with-current-buffer meta-buf
2001 (cond ((setq wind (ediff-get-visible-buffer-window meta-buf))
2004 "Already showing the group panel for this session"))
2005 (set-window-buffer wind meta-buf)
2006 (select-window wind))
2007 ((window-live-p (setq wind ediff-window-C)) ;in merge--merge buf
2008 (set-window-buffer ediff-window-C meta-buf)
2009 (select-window wind))
2010 ((window-live-p (setq wind ediff-window-A))
2011 (set-window-buffer ediff-window-A meta-buf)
2012 (select-window wind))
2013 ((window-live-p (setq wind ediff-window-B))
2014 (set-window-buffer ediff-window-B meta-buf)
2015 (select-window wind))
2018 (ediff-get-visible-buffer-window ediff-registry-buffer))
2019 (ediff-window-display-p))
2020 (select-window wind)
2022 (set-window-buffer (selected-window) meta-buf))
2023 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
2024 (set-window-buffer (selected-window) meta-buf)))
2026 (if (and (ediff-window-display-p)
2028 (setq wind (ediff-get-visible-buffer-window meta-buf))))
2030 (setq frame (window-frame wind))
2032 (ediff-reset-mouse frame)))
2033 (sit-for 0) ; sometimes needed to synch the display and ensure that the
2034 ; point ends up after the just completed session
2035 (run-hooks 'ediff-show-session-group-hook)
2038 (defun ediff-show-current-session-meta-buffer ()
2040 (ediff-show-meta-buffer nil ediff-meta-session-number))
2042 (defun ediff-show-meta-buff-from-registry ()
2043 "Display the session group buffer for a selected session group."
2045 (let* ((pos (ediff-event-point last-command-event))
2046 (meta-buf (ediff-event-buffer last-command-event))
2047 (info (ediff-get-meta-info meta-buf pos))
2048 (meta-or-session-buf info))
2049 (ediff-with-current-buffer meta-or-session-buf
2050 (ediff-show-meta-buffer nil t))))
2053 (defun ediff-show-registry ()
2054 "Display Ediff's registry."
2056 (ediff-update-registry)
2057 (if (not (ediff-buffer-live-p ediff-registry-buffer))
2058 (error "No active Ediff sessions or corrupted session registry"))
2060 ;; for some reason, point moves in ediff-registry-buffer, so we preserve it
2062 (ediff-with-current-buffer ediff-registry-buffer
2065 (ediff-get-visible-buffer-window ediff-registry-buffer))
2066 (message "Already showing the registry")
2067 (set-window-buffer wind ediff-registry-buffer)
2068 (select-window wind))
2069 ((window-live-p ediff-window-C)
2070 (set-window-buffer ediff-window-C ediff-registry-buffer)
2071 (select-window ediff-window-C))
2072 ((window-live-p ediff-window-A)
2073 (set-window-buffer ediff-window-A ediff-registry-buffer)
2074 (select-window ediff-window-A))
2075 ((window-live-p ediff-window-B)
2076 (set-window-buffer ediff-window-B ediff-registry-buffer)
2077 (select-window ediff-window-B))
2079 (ediff-get-visible-buffer-window ediff-meta-buffer))
2080 (ediff-window-display-p))
2081 (select-window wind)
2083 (set-window-buffer (selected-window) ediff-registry-buffer))
2084 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
2085 (set-window-buffer (selected-window) ediff-registry-buffer)))
2087 (if (ediff-window-display-p)
2091 (ediff-get-visible-buffer-window ediff-registry-buffer)))
2093 (ediff-reset-mouse frame)))
2094 (run-hooks 'ediff-show-registry-hook)
2098 (defalias 'eregistry 'ediff-show-registry)
2100 ;; If meta-buf doesn't exist, it is created. In that case, id doesn't have a
2102 ;; Check if META-BUF exists before calling this function
2103 ;; Optional MUST-REDRAW, if non-nil, would force redrawal of the whole meta
2104 ;; buffer. Otherwise, it will just go over the buffer and update activity marks
2105 ;; and session status.
2106 ;; SESSION-NUMBER, if specified, says which session caused the update.
2107 (defun ediff-update-meta-buffer (meta-buf &optional must-redraw session-number)
2108 (if (ediff-buffer-live-p meta-buf)
2109 (ediff-with-current-buffer meta-buf
2111 (cond (must-redraw ; completely redraw the meta buffer
2112 (funcall ediff-meta-redraw-function ediff-meta-list))
2113 ((numberp session-number) ; redraw only for the given session
2114 (ediff-update-session-marker-in-dir-meta-buffer
2116 (t ; update what changed only, but scan the entire meta buffer
2117 (ediff-update-markers-in-dir-meta-buffer ediff-meta-list)))
2118 (setq overl (ediff-get-meta-overlay-at-pos (point)))
2119 ;; skip the invisible sessions
2120 (while (and overl (ediff-overlay-get overl 'invisible))
2121 (ediff-next-meta-item1)
2122 (setq overl (ediff-get-meta-overlay-at-pos (point))))
2125 (defun ediff-update-registry ()
2126 (ediff-with-current-buffer (current-buffer)
2127 (if (ediff-buffer-live-p ediff-registry-buffer)
2128 (ediff-redraw-registry-buffer)
2129 (ediff-prepare-meta-buffer
2130 'ediff-registry-action
2131 ediff-session-registry
2133 'ediff-redraw-registry-buffer
2137 ;; If meta-buf exists, it is redrawn along with parent.
2138 ;; Otherwise, nothing happens.
2139 (defun ediff-cleanup-meta-buffer (meta-buffer)
2140 (if (ediff-buffer-live-p meta-buffer)
2141 (ediff-with-current-buffer meta-buffer
2142 (ediff-update-meta-buffer meta-buffer)
2143 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
2144 (ediff-update-meta-buffer
2145 ediff-parent-meta-buffer nil ediff-meta-session-number)))))
2147 ;; t if no session is in progress
2148 (defun ediff-safe-to-quit (meta-buffer)
2149 (if (ediff-buffer-live-p meta-buffer)
2150 (let ((lis ediff-meta-list)
2153 ;;(ediff-update-meta-buffer meta-buffer)
2154 (ediff-with-current-buffer meta-buffer
2155 (setq lis (cdr lis)) ; discard the description part of meta-list
2156 (while (and cont lis)
2157 (if (ediff-buffer-live-p
2158 (ediff-get-group-buffer lis)) ; in progress
2160 (setq lis (cdr lis)))
2163 (defun ediff-quit-meta-buffer ()
2164 "If the group has no active session, delete the meta buffer.
2165 If no session is in progress, ask to confirm before deleting meta buffer.
2166 Otherwise, bury the meta buffer.
2167 If this is a session registry buffer then just bury it."
2169 (let* ((buf (current-buffer))
2170 (dir-diffs-buffer ediff-dir-diffs-buffer)
2171 (meta-diff-buffer ediff-meta-diff-buffer)
2172 (session-number ediff-meta-session-number)
2173 (parent-buf ediff-parent-meta-buffer)
2174 (dont-show-registry (eq buf ediff-registry-buffer)))
2175 (if dont-show-registry
2177 ;;(ediff-cleanup-meta-buffer buf)
2178 (cond ((and (ediff-safe-to-quit buf)
2179 (y-or-n-p "Quit this session group? "))
2180 (run-hooks 'ediff-quit-session-group-hook)
2182 (ediff-dispose-of-meta-buffer buf))
2183 ((ediff-safe-to-quit buf)
2187 "This session group has active sessions---cannot exit")))
2188 (ediff-update-meta-buffer parent-buf nil session-number)
2189 (ediff-kill-buffer-carefully dir-diffs-buffer)
2190 (ediff-kill-buffer-carefully meta-diff-buffer)
2191 (if (ediff-buffer-live-p parent-buf)
2193 (setq dont-show-registry t)
2194 (ediff-show-meta-buffer parent-buf session-number)))
2196 (or dont-show-registry
2197 (ediff-show-registry))))
2199 (defun ediff-dispose-of-meta-buffer (buf)
2200 (setq ediff-session-registry (delq buf ediff-session-registry))
2201 (ediff-with-current-buffer buf
2202 (if (ediff-buffer-live-p ediff-dir-diffs-buffer)
2203 (kill-buffer ediff-dir-diffs-buffer)))
2207 ;; Obtain information on a meta record where the user clicked or typed
2208 ;; BUF is the buffer where this happened and POINT is the position
2209 ;; If optional NOERROR arg is given, don't report error and return nil if no
2210 ;; meta info is found on line.
2211 (defun ediff-get-meta-info (buf point &optional noerror)
2212 (let (result olist tmp)
2213 (if (and point (ediff-buffer-live-p buf))
2214 (ediff-with-current-buffer buf
2215 (if (featurep 'xemacs)
2217 (if (setq tmp (extent-at point buf 'ediff-meta-info))
2218 (ediff-overlay-get tmp 'ediff-meta-info)))
2220 (mapcar (lambda (elt)
2221 (unless (overlay-get elt 'invisible)
2222 (overlay-get elt 'ediff-meta-info)))
2223 (overlays-at point)))
2224 (while (and olist (null (car olist)))
2225 (setq olist (cdr olist)))
2226 (setq result (car olist)))))
2229 (ediff-update-registry)
2230 (error "No session info in this line")))))
2233 (defun ediff-get-meta-overlay-at-pos (point)
2234 (if (featurep 'xemacs)
2235 (extent-at point (current-buffer) 'ediff-meta-info)
2236 (let* ((overl-list (overlays-at point))
2237 (overl (car overl-list)))
2238 (while (and overl (null (overlay-get overl 'ediff-meta-info)))
2239 (setq overl-list (cdr overl-list)
2240 overl (car overl-list)))
2243 (defun ediff-get-session-number-at-pos (point &optional meta-buffer)
2244 (setq meta-buffer (if (ediff-buffer-live-p meta-buffer)
2247 (ediff-with-current-buffer meta-buffer
2249 (ediff-get-meta-overlay-at-pos point) 'ediff-meta-session-number)))
2252 ;; Return location of the next meta overlay after point
2253 (defun ediff-next-meta-overlay-start (point)
2255 (goto-char (point-min))
2256 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2257 (if (featurep 'xemacs)
2260 (setq overl (next-extent overl))
2261 (setq overl (next-extent (current-buffer))))
2263 (extent-start-position overl)
2267 ;; note: end of current overlay is the beginning of the next one
2269 (next-overlay-change point))))))
2272 (defun ediff-previous-meta-overlay-start (point)
2274 (goto-char (point-max))
2275 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2276 (if (featurep 'xemacs)
2279 (setq overl (previous-extent overl))
2280 (setq overl (previous-extent (current-buffer))))
2282 (extent-start-position overl)
2284 (if overl (setq point (overlay-start overl)))
2285 ;; to get to the beginning of prev overlay
2287 ;; trick to overcome an emacs bug--doesn't always find previous
2288 ;; overlay change correctly
2289 (setq point (1- point)))
2290 (setq point (previous-overlay-change point))
2291 ;; If we are not over an overlay after subtracting 1, it means we are
2292 ;; in the description area preceding session records. In this case,
2293 ;; goto the top of the registry buffer.
2294 (or (car (overlays-at point))
2295 (setq point (point-min)))
2298 ;; this is the action invoked when the user selects a patch from the meta
2300 (defun ediff-patch-file-form-meta (file &optional startup-hooks)
2301 (let* ((pos (ediff-event-point last-command-event))
2302 (meta-buf (ediff-event-buffer last-command-event))
2303 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
2304 (info (ediff-get-meta-info meta-buf pos))
2305 (meta-patchbuf ediff-meta-patchbufer)
2306 session-buf beg-marker end-marker)
2308 (if (or (file-directory-p file) (string-match "/dev/null" file))
2309 (error "`%s' is not an ordinary file" (file-name-as-directory file)))
2310 (setq session-buf (ediff-get-session-buffer info)
2311 beg-marker (ediff-get-session-objB-name info)
2312 end-marker (ediff-get-session-objC-name info))
2314 (or (ediff-buffer-live-p session-buf) ; either an active patch session
2315 (null session-buf) ; or it is a virgin session
2317 "Patch has already been applied to this file -- can't repeat!"))
2319 (ediff-with-current-buffer meta-patchbuf
2322 (narrow-to-region beg-marker end-marker)
2323 (ediff-patch-file-internal meta-patchbuf file startup-hooks)))))
2326 (defun ediff-unmark-all-for-operation ()
2327 "Unmark all sessions marked for operation."
2329 (let ((list (cdr ediff-meta-list))
2331 (while (setq elt (car list))
2332 (ediff-mark-session-for-operation elt 'unmark)
2333 (setq list (cdr list))))
2334 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2336 (defun ediff-unmark-all-for-hiding ()
2337 "Unmark all sessions marked for hiding."
2339 (let ((list (cdr ediff-meta-list))
2341 (while (setq elt (car list))
2342 (ediff-mark-session-for-hiding elt 'unmark)
2343 (setq list (cdr list))))
2344 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2347 ;; ACTION is ?h, ?m, ?=: to mark for hiding, mark for operation, or simply
2348 ;; indicate which are equal files
2349 (defun ediff-meta-mark-equal-files (&optional action)
2350 "Run through the session list and mark identical files.
2351 This is used only for sessions that involve 2 or 3 files at the same time.
2352 ACTION is an optional argument that can be ?h, ?m, ?=, to mark for hiding, mark
2353 for operation, or simply indicate which are equal files. If it is nil, then
2354 `last-command-char' is used to decide which action to take."
2357 (setq action last-command-char))
2358 (let ((list (cdr ediff-meta-list))
2359 marked1 marked2 marked3
2360 fileinfo1 fileinfo2 fileinfo3 elt)
2361 (message "Comparing files ...")
2362 (while (setq elt (car list))
2363 (setq fileinfo1 (ediff-get-session-objA elt)
2364 fileinfo2 (ediff-get-session-objB elt)
2365 fileinfo3 (ediff-get-session-objC elt))
2366 (ediff-set-file-eqstatus fileinfo1 nil)
2367 (ediff-set-file-eqstatus fileinfo2 nil)
2368 (ediff-set-file-eqstatus fileinfo3 nil)
2373 (or (ediff-mark-if-equal fileinfo1 fileinfo2)
2375 (if (ediff-metajob3)
2377 (or (ediff-mark-if-equal fileinfo1 fileinfo3)
2379 (or (ediff-mark-if-equal fileinfo2 fileinfo3)
2380 (setq marked3 nil))))
2381 (if (and marked1 marked2 marked3)
2382 (cond ((eq action ?h)
2383 (ediff-mark-session-for-hiding elt 'mark))
2385 (ediff-mark-session-for-operation elt 'mark))
2387 (setq list (cdr list)))
2388 (message "Comparing files ... Done"))
2389 (setq ediff-recurse-to-subdirectories nil)
2390 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2392 ;; mark files 1 and 2 as equal, if they are.
2393 ;; returns t, if something was marked
2394 (defun ediff-mark-if-equal (fileinfo1 fileinfo2)
2395 (let ((f1 (car fileinfo1))
2396 (f2 (car fileinfo2)))
2397 (if (and (stringp f1) (stringp f2) (ediff-same-contents f1 f2))
2399 (ediff-set-file-eqstatus fileinfo1 t)
2400 (ediff-set-file-eqstatus fileinfo2 t)
2406 ;;; Local Variables:
2407 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
2408 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
2409 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
2412 ;;; arch-tag: c8a76898-f96f-4d9c-be9d-129134017188
2413 ;;; ediff-mult.el ends here