1 ;;; ediff-mult.el --- support for multi-file/multi-buffer processing in Ediff
3 ;; Copyright (C) 1995-2011 Free Software Foundation, Inc.
5 ;; 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 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
25 ;; Users are encouraged to add functionality to this file.
26 ;; The present file contains all the infrastructure needed for that.
28 ;; Generally, to implement a new multisession capability within Ediff,
29 ;; you need to tell it
31 ;; 1. How to display the session group buffer.
32 ;; This function must indicate which Ediff sessions are active (+) and
33 ;; which are finished (-).
34 ;; See ediff-redraw-directory-group-buffer for an example.
35 ;; In all likelihood, ediff-redraw-directory-group-buffer can be used
36 ;; directly or after a small modification.
37 ;; 2. What action to take when the user clicks button 2 or types v,e, or
38 ;; RET. See ediff-filegroup-action.
39 ;; 3. Provide a list of pairs or triples of file names (or buffers,
40 ;; depending on the particular Ediff operation you want to invoke)
41 ;; in the following format:
42 ;; (HEADER (nil nil (obj1 nil) (obj2 nil) (obj3 nil))
44 ;; The function ediff-make-new-meta-list-element can be used to create
45 ;; 2nd and subsequent elements of that list (i.e., after the
46 ;; description header). See ediff-make-new-meta-list-element for the
47 ;; explanation of the two nil placeholders in such elements.
49 ;; There is API for extracting the components of the members of the
50 ;; above list. Search for `API for ediff-meta-list' for details.
52 ;; HEADER must be a list of SIX elements (nil or string):
53 ;; (regexp metaobj1 metaobj2 metaobj3 merge-save-buffer
54 ;; comparison-function)
55 ;; The function ediff-redraw-registry-buffer displays the
56 ;; 1st - 4th of these in the registry buffer.
57 ;; For some jobs some of the members of the header might be nil.
58 ;; The meaning of metaobj1, metaobj2, and metaobj3 depend on the job.
59 ;; Typically these are directories where the files to be compared are
61 ;; Also, keep in mind that the function ediff-prepare-meta-buffer
62 ;; (which see) prepends the session group buffer to the descriptor, so
63 ;; the descriptor becomes 7-long.
64 ;; Ediff expects that your function (in 2 above) will arrange to
65 ;; replace this prepended nil (via setcar) with the actual ediff
66 ;; control buffer associated with an appropriate Ediff session.
67 ;; This is arranged through internal startup hooks that can be passed
68 ;; to any of Ediff major entries (such as ediff-files, epatch, etc.).
69 ;; See how this is done in ediff-filegroup-action.
71 ;; Session descriptions are of the form
72 ;; (nil nil (obj1 . nil) (obj2 . nil) (obj3 . nil))
73 ;; which describe the objects relevant to the session.
74 ;; Use ediff-make-new-meta-list-element to create these things.
75 ;; Usually obj1/2/3 are names of files, but they may also be other
76 ;; things for some jobs. For instance, obj3 is nil for jobs that
77 ;; involve only two files. For patch jobs, obj2 and obj3 are markers
78 ;; that specify the patch corresponding to the file
79 ;; (whose name is obj1).
80 ;; The nil's are placeholders, which are used internally by ediff.
81 ;; 4. Write a function that makes a call to ediff-prepare-meta-buffer
82 ;; passing all this info.
83 ;; You may be able to use ediff-directories-internal as a template.
84 ;; 5. If you intend to add several related pieces of functionality,
85 ;; you may want to keep the function in 4 as an internal version
86 ;; and then write several top-level interactive functions that call it
87 ;; with different parameters.
88 ;; See how ediff-directories, ediff-merge-directories, and
89 ;; ediff-merge-directories-with-ancestor all use
90 ;; ediff-directories-internal.
92 ;; A useful addition here could be session groups selected by patterns
93 ;; (which are different in each directory). For instance, one may want to
94 ;; compare files of the form abc{something}.c to files old{something}.d
95 ;; which may be in the same or different directories. Or, one may want to
96 ;; compare all files of the form {something} to files of the form {something}~.
98 ;; Implementing this requires writing a collating function, which should pair
99 ;; up appropriate files. It will also require a generalization of the
100 ;; functions that do the layout of the meta- and differences buffers and of
101 ;; ediff-filegroup-action.
106 (provide 'ediff-mult
)
108 (defgroup ediff-mult nil
109 "Multi-file and multi-buffer processing in Ediff."
116 (require 'ediff-ptch
)
120 (require 'ediff-init
)
123 (ediff-defvar-local ediff-meta-buffer nil
"")
124 (ediff-defvar-local ediff-parent-meta-buffer nil
"")
125 ;; the registry buffer
126 (defvar ediff-registry-buffer nil
)
128 (defconst ediff-meta-buffer-brief-message
"Ediff Session Group Panel: %s
130 Type ? to show useful commands in this buffer
134 (defconst ediff-meta-buffer-verbose-message
"Ediff Session Group Panel: %s
136 Useful commands (type ? to hide them and free up screen):
137 button2, v, or RET over session record: start that Ediff session
138 M:\tin sessions invoked from here, brings back this group panel
139 R:\tdisplay the registry of active Ediff sessions
140 h:\tmark session for hiding (toggle)
141 x:\thide marked sessions; with prefix arg: unhide
142 m:\tmark session for a non-hiding operation (toggle)
143 uh/um:\tunmark all sessions marked for hiding/operation
145 p,DEL:\tprevious session
146 E:\tbrowse Ediff on-line manual
147 T:\ttoggle truncation of long file names
148 q:\tquit this session group
151 (ediff-defvar-local ediff-meta-buffer-map nil
152 "The keymap for the meta buffer.")
153 (defvar ediff-dir-diffs-buffer-map
(make-sparse-keymap)
154 "The keymap to be installed in the buffer showing differences between
157 ;; Variable specifying the action to take when the use invokes ediff in the
158 ;; meta buffer. This is usually ediff-registry-action or ediff-filegroup-action
159 (ediff-defvar-local ediff-meta-action-function nil
"")
160 ;; Tells ediff-update-meta-buffer how to redraw it
161 (ediff-defvar-local ediff-meta-redraw-function nil
"")
162 ;; Tells ediff-filegroup-action and similar procedures how to invoke Ediff for
163 ;; the sessions in a given session group
164 (ediff-defvar-local ediff-session-action-function nil
"")
166 (ediff-defvar-local ediff-metajob-name nil
"")
168 ;; buffer used to collect custom diffs from individual sessions in the group
169 (ediff-defvar-local ediff-meta-diff-buffer nil
"")
171 ;; t means recurse into subdirs when deciding which files have same contents
172 (ediff-defvar-local ediff-recurse-to-subdirectories nil
"")
174 ;; history var to use for filtering groups of files
175 (defvar ediff-filtering-regexp-history nil
"")
177 (defcustom ediff-default-filtering-regexp nil
178 "The default regular expression used as a filename filter in multifile comparisons.
179 Should be a sexp. For instance (car ediff-filtering-regexp-history) or nil."
183 ;; This has the form ((meta-buf regexp dir1 dir2 dir3 merge-auto-store-dir)
184 ;; (ctl-buf session-status (file1 . eq-status) (file2 . eq-status) (file3
185 ;; . eq-status)) (ctl-buf session-status (file1 . eq-status) (file2
186 ;; . eq-status)) ...)
187 ;; If ctl-buf is nil, the file-pair hasn't processed yet. If it is
188 ;; killed-buffer object, the file pair has been processed. If it is a live
189 ;; buffer, this means ediff is still working on the pair.
190 ;; Eq-status of a file is t if the file equals some other file in the same
192 (ediff-defvar-local ediff-meta-list nil
"")
194 (ediff-defvar-local ediff-meta-session-number nil
"")
197 ;; the difference list between directories in a directory session group
198 (ediff-defvar-local ediff-dir-difference-list nil
"")
199 (ediff-defvar-local ediff-dir-diffs-buffer nil
"")
201 ;; The registry of Ediff sessions. A list of control buffers.
202 (defvar ediff-session-registry nil
)
204 (defcustom ediff-meta-truncate-filenames t
205 "If non-nil, truncate long file names in the session group buffers.
206 This can be toggled with `ediff-toggle-filename-truncation'."
210 (defcustom ediff-meta-mode-hook nil
211 "Hooks run just after setting up meta mode."
215 (defcustom ediff-registry-setup-hook nil
216 "Hooks run just after the registry control panel is set up."
220 (defcustom ediff-before-session-group-setup-hooks nil
221 "Hooks to run before Ediff arranges the window for group-level operations.
222 It is used by commands such as `ediff-directories'.
223 This hook can be used to save the previous window config, which can be restored
224 on `ediff-quit', `ediff-suspend', or `ediff-quit-session-group-hook'."
227 (defcustom ediff-after-session-group-setup-hook nil
228 "Hooks run just after a meta-buffer controlling a session group, such as
229 ediff-directories, is run."
232 (defcustom ediff-quit-session-group-hook nil
233 "Hooks run just before exiting a session group."
236 (defcustom ediff-show-registry-hook nil
237 "Hooks run just after the registry buffer is shown."
240 (defcustom ediff-show-session-group-hook
'(delete-other-windows)
241 "Hooks run just after a session group buffer is shown."
244 (defcustom ediff-meta-buffer-keymap-setup-hook nil
245 "Hooks run just after setting up the `ediff-meta-buffer-map'.
246 This keymap controls key bindings in the meta buffer and is a local variable.
247 This means that you can set different bindings for different kinds of meta
252 ;; Buffer holding the multi-file patch. Local to the meta buffer
253 (ediff-defvar-local ediff-meta-patchbufer nil
"")
255 ;;; API for ediff-meta-list
257 ;; A meta-list is either ediff-meta-list, which contains a header and the list
258 ;; of ediff sessions or ediff-dir-difference-list, which is a header followed
259 ;; by the list of differences among the directories (i.e., files that are not
260 ;; in all directories). The header is the same in all meta lists, but the rest
262 ;; Structure of the meta-list:
263 ;; (HEADER SESSION1 SESSION2 ...)
264 ;; HEADER: (GROUP-BUF REGEXP OBJA OBJB OBJC SAVE-DIR COMPARISON-FUNC)
265 ;; OBJA - first directory
266 ;; OBJB - second directory
267 ;; OBJC - third directory
268 ;; SESSION1/2/... are described below
269 ;; group buffer/regexp
270 (defsubst ediff-get-group-buffer
(meta-list)
271 (nth 0 (car meta-list
)))
273 (defsubst ediff-get-group-regexp
(meta-list)
274 (nth 1 (car meta-list
)))
276 (defsubst ediff-get-group-objA
(meta-list)
277 (nth 2 (car meta-list
)))
278 (defsubst ediff-get-group-objB
(meta-list)
279 (nth 3 (car meta-list
)))
280 (defsubst ediff-get-group-objC
(meta-list)
281 (nth 4 (car meta-list
)))
282 (defsubst ediff-get-group-merge-autostore-dir
(meta-list)
283 (nth 5 (car meta-list
)))
284 (defsubst ediff-get-group-comparison-func
(meta-list)
285 (nth 6 (car meta-list
)))
287 ;; ELT is a session meta descriptor (what is being preserved as
289 ;; The structure is: (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
290 ;; STATUS is ?I (hidden or invalid), ?* (marked for operation), ?H (hidden)
292 ;; OBJA/B/C is (FILENAME EQSTATUS)
293 ;; EQSTATUS is ?= or nil (?= means that this file is equal to some other
294 ;; file in this session)
296 (defsubst ediff-get-session-buffer
(elt)
298 (defsubst ediff-get-session-status
(elt)
300 (defsubst ediff-set-session-status
(session-info new-status
)
301 (setcar (cdr session-info
) new-status
))
303 (defsubst ediff-get-session-objA
(elt)
305 (defsubst ediff-get-session-objB
(elt)
307 (defsubst ediff-get-session-objC
(elt)
309 ;; Take the "name" component of the object into account. ObjA/C/B is of the form
310 ;; (name . equality-indicator)
311 (defsubst ediff-get-session-objA-name
(elt)
313 (defsubst ediff-get-session-objB-name
(elt)
315 (defsubst ediff-get-session-objC-name
(elt)
317 ;; equality indicators
318 (defsubst ediff-get-file-eqstatus
(elt)
320 (defsubst ediff-set-file-eqstatus
(elt value
)
321 (setcar (cdr elt
) value
))
323 ;; Create a new element for the meta list out of obj1/2/3, which usually are
326 ;; The first nil in such an element is later replaced with the session buffer.
327 ;; The second nil is reserved for session status.
329 ;; Also, session objects A/B/C are turned into lists of the form (obj nil).
330 ;; This nil is a placeholder for eq-indicator. It is either nil or =.
331 ;; If it is discovered that this file is = to some other
332 ;; file in the same session, eq-indicator is changed to `='.
333 ;; Currently, the eq-indicator is used only for 2 and 3-file jobs.
334 (defun ediff-make-new-meta-list-element (obj1 obj2 obj3
)
335 (list nil nil
(list obj1 nil
) (list obj2 nil
) (list obj3 nil
)))
337 ;; Constructs a meta list header.
338 ;; OBJA, OBJB, OBJC are usually directories involved, but can be different for
339 ;; different jobs. For instance, multifile patch has only OBJA, which is the
341 (defun ediff-make-new-meta-list-header (regexp
345 (list regexp objA objB objC merge-auto-store-dir comparison-func
))
347 ;; The activity marker is either or + (active session, i.e., ediff is currently
348 ;; run in it), or - (finished session, i.e., we've ran ediff in it and then
349 ;; exited). Return nil, if session is neither active nor finished
350 (defun ediff-get-session-activity-marker (session)
351 (let ((session-buf (ediff-get-session-buffer session
)))
352 (cond ((null session-buf
) nil
) ; virgin session
353 ((ediff-buffer-live-p session-buf
) ?
+) ;active session
356 ;; checks if the session is a meta session
357 (defun ediff-meta-session-p (session-info)
358 (and (stringp (ediff-get-session-objA-name session-info
))
359 (file-directory-p (ediff-get-session-objA-name session-info
))
360 (stringp (ediff-get-session-objB-name session-info
))
361 (file-directory-p (ediff-get-session-objB-name session-info
))
362 (if (stringp (ediff-get-session-objC-name session-info
))
363 (file-directory-p (ediff-get-session-objC-name session-info
)) t
)))
366 (ediff-defvar-local ediff-verbose-help-enabled nil
367 "If t, display redundant help in ediff-directories and other meta buffers.
368 Toggled by ediff-toggle-verbose-help-meta-buffer" )
370 ;; Toggle verbose help in meta-buffers
371 ;; TODO: Someone who understands all this can make it better.
372 (defun ediff-toggle-verbose-help-meta-buffer ()
373 "Toggle showing tediously verbose help in meta buffers."
375 (setq ediff-verbose-help-enabled
(not ediff-verbose-help-enabled
))
376 (ediff-update-meta-buffer (current-buffer) 'must-redraw
))
378 ;; set up the keymap in the meta buffer
379 (defun ediff-setup-meta-map ()
380 (setq ediff-meta-buffer-map
(make-sparse-keymap))
381 (suppress-keymap ediff-meta-buffer-map
)
382 (define-key ediff-meta-buffer-map
"?" 'ediff-toggle-verbose-help-meta-buffer
)
383 (define-key ediff-meta-buffer-map
"q" 'ediff-quit-meta-buffer
)
384 (define-key ediff-meta-buffer-map
"T" 'ediff-toggle-filename-truncation
)
385 (define-key ediff-meta-buffer-map
"R" 'ediff-show-registry
)
386 (define-key ediff-meta-buffer-map
"E" 'ediff-documentation
)
387 (define-key ediff-meta-buffer-map
"v" ediff-meta-action-function
)
388 (define-key ediff-meta-buffer-map
"\C-m" ediff-meta-action-function
)
389 (define-key ediff-meta-buffer-map
" " 'ediff-next-meta-item
)
390 (define-key ediff-meta-buffer-map
"n" 'ediff-next-meta-item
)
391 (define-key ediff-meta-buffer-map
"\C-?" 'ediff-previous-meta-item
)
392 (define-key ediff-meta-buffer-map
"p" 'ediff-previous-meta-item
)
393 (define-key ediff-meta-buffer-map
[delete] 'ediff-previous-meta-item)
394 (define-key ediff-meta-buffer-map [backspace] 'ediff-previous-meta-item)
396 (let ((menu-map (make-sparse-keymap "Ediff-Meta")))
397 (define-key ediff-meta-buffer-map [menu-bar ediff-meta-mode]
398 (cons "Ediff-Meta" menu-map))
399 (define-key menu-map [ediff-quit-meta-buffer]
400 '(menu-item "Quit" ediff-quit-meta-buffer
401 :help "Quit the meta buffer"))
402 (define-key menu-map [ediff-toggle-filename-truncation]
403 '(menu-item "Truncate filenames" ediff-toggle-filename-truncation
404 :help "Toggle truncation of long file names in session group buffers"
405 :button (:toggle . ediff-meta-truncate-filenames)))
406 (define-key menu-map [ediff-show-registry]
407 '(menu-item "Display Ediff Registry" ediff-show-registry
408 :help "Display Ediff's registry"))
409 (define-key menu-map [ediff-documentation]
410 '(menu-item "Show Manual" ediff-documentation
411 :help "Display Ediff's manual"))
413 (or (ediff-one-filegroup-metajob)
415 (define-key ediff-meta-buffer-map "=" nil)
416 (define-key ediff-meta-buffer-map "==" 'ediff-meta-mark-equal-files)
417 (define-key ediff-meta-buffer-map "=m" 'ediff-meta-mark-equal-files)
418 (define-key ediff-meta-buffer-map "=h" 'ediff-meta-mark-equal-files)))
421 (define-key menu-map [ediff-next-meta-item]
422 '(menu-item "Next" ediff-next-meta-item
423 :help "Move to the next item in Ediff registry or session group buffer"))
424 (define-key menu-map [ediff-previous-meta-item]
425 '(menu-item "Previous" ediff-previous-meta-item
426 :help "Move to the previous item in Ediff registry or session group buffer")))
429 (if ediff-no-emacs-help-in-control-buffer
430 (define-key ediff-meta-buffer-map "\C-h" 'ediff-previous-meta-item))
431 (if (featurep 'emacs)
432 (define-key ediff-meta-buffer-map [mouse-2] ediff-meta-action-function)
433 (define-key ediff-meta-buffer-map [button2] ediff-meta-action-function))
435 (use-local-map ediff-meta-buffer-map)
436 ;; modify ediff-meta-buffer-map here
437 (run-hooks 'ediff-meta-buffer-keymap-setup-hook))
440 (defun ediff-meta-mode ()
441 "This mode controls all operations on Ediff session groups.
442 It is entered through one of the following commands:
447 `ediff-merge-directories'
449 `ediff-merge-directories-with-ancestor'
450 `edirs-merge-with-ancestor'
451 `ediff-directory-revisions'
453 `ediff-merge-directory-revisions'
454 `edir-merge-revisions'
455 `ediff-merge-directory-revisions-with-ancestor'
456 `edir-merge-revisions-with-ancestor'
459 \\{ediff-meta-buffer-map}"
460 ;; FIXME: Use define-derived-mode.
461 (kill-all-local-variables)
462 (setq major-mode 'ediff-meta-mode)
463 (setq mode-name "MetaEdiff")
464 ;; don't use run-mode-hooks here!
465 (run-hooks 'ediff-meta-mode-hook))
468 ;; the keymap for the buffer showing directory differences
469 (suppress-keymap ediff-dir-diffs-buffer-map)
470 (define-key ediff-dir-diffs-buffer-map "q" 'ediff-bury-dir-diffs-buffer)
471 (define-key ediff-dir-diffs-buffer-map " " 'next-line)
472 (define-key ediff-dir-diffs-buffer-map "n" 'next-line)
473 (define-key ediff-dir-diffs-buffer-map "\C-?" 'previous-line)
474 (define-key ediff-dir-diffs-buffer-map "p" 'previous-line)
475 (define-key ediff-dir-diffs-buffer-map "C" 'ediff-dir-diff-copy-file)
476 (if (featurep 'emacs)
477 (define-key ediff-dir-diffs-buffer-map [mouse-2] 'ediff-dir-diff-copy-file)
478 (define-key ediff-dir-diffs-buffer-map [button2] 'ediff-dir-diff-copy-file))
479 (define-key ediff-dir-diffs-buffer-map [delete] 'previous-line
)
480 (define-key ediff-dir-diffs-buffer-map
[backspace] 'previous-line)
482 (defun ediff-next-meta-item (count)
483 "Move to the next item in Ediff registry or session group buffer.
484 Moves in circular fashion. With numeric prefix arg, skip this many items."
486 (or count (setq count 1))
489 (setq count (1- count))
490 (ediff-next-meta-item1)
491 (setq overl (ediff-get-meta-overlay-at-pos (point)))
492 ;; skip invisible ones
493 (while (and overl (ediff-overlay-get overl 'invisible))
494 (ediff-next-meta-item1)
495 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
497 ;; Move to the next meta item
498 (defun ediff-next-meta-item1 ()
500 (setq pos (ediff-next-meta-overlay-start (point)))
501 (if pos (goto-char pos))
502 (if (eq ediff-metajob-name 'ediff-registry)
503 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
504 (search-forward "*Ediff" nil t))
505 (skip-chars-backward "a-zA-Z*"))
506 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
507 (backward-char 1)))))
510 (defun ediff-previous-meta-item (count)
511 "Move to the previous item in Ediff registry or session group buffer.
512 Moves in circular fashion. With numeric prefix arg, skip this many items."
514 (or count (setq count 1))
517 (setq count (1- count))
518 (ediff-previous-meta-item1)
519 (setq overl (ediff-get-meta-overlay-at-pos (point)))
520 ;; skip invisible ones
521 (while (and overl (ediff-overlay-get overl 'invisible))
522 (ediff-previous-meta-item1)
523 (setq overl (ediff-get-meta-overlay-at-pos (point)))))))
525 (defun ediff-previous-meta-item1 ()
527 (setq pos (ediff-previous-meta-overlay-start (point)))
529 ;;; (while (ediff-get-session-status
530 ;;; (ediff-get-meta-info (current-buffer) pos 'noerror))
531 ;;; (setq pos (ediff-previous-meta-overlay-start pos)))
533 (if pos (goto-char pos))
534 (if (eq ediff-metajob-name 'ediff-registry)
535 (if (and (ediff-get-meta-info (current-buffer) pos 'noerror)
536 (search-forward "*Ediff" nil t))
537 (skip-chars-backward "a-zA-Z*"))
538 (if (> (skip-chars-forward "-+?H* \t0-9") 0)
542 (defsubst ediff-add-slash-if-directory (dir file)
543 (if (file-directory-p (concat dir file))
544 (file-name-as-directory file)
547 (defun ediff-toggle-filename-truncation ()
548 "Toggle truncation of long file names in session group buffers.
549 Set `ediff-meta-truncate-filenames' variable if you want to change the default
552 (setq ediff-meta-truncate-filenames (not ediff-meta-truncate-filenames))
553 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
556 ;; These are used to encode membership of files in directory1/2/3
557 ;; Membership code of a file is a product of codes for the directories where
559 (defvar ediff-membership-code1 2)
560 (defvar ediff-membership-code2 3)
561 (defvar ediff-membership-code3 5)
562 (defvar ediff-product-of-memcodes (* ediff-membership-code1
563 ediff-membership-code2
564 ediff-membership-code3))
566 ;; DIR1, DIR2, DIR3 are directories. DIR3 can be nil.
567 ;; OUTPUT-DIR is a directory for auto-storing the results of merge jobs.
569 ;; REGEXP is nil or a filter regexp; only file names that match the regexp
571 ;; If a file is a directory in dir1 but not dir2 (or vice versa), it is not
572 ;; included in the intersection. However, a regular file that is a dir in dir3
573 ;; is included, since dir3 files are supposed to be ancestors for merging.
574 ;; If COMPARISON-FUNC is given, use it. Otherwise, use string=
576 ;; Returns a list of the form:
577 ;; (COMMON-PART DIFF-LIST)
578 ;; COMMON-PART is car and DIFF-LIST is cdr.
580 ;; COMMON-PART is of the form:
581 ;; (META-HEADER (f1 f2 f3) (f1 f2 f3) ...)
582 ;; f3 can be nil if intersecting only 2 directories.
583 ;; Each triple (f1 f2 f3) represents the files to be compared in the
584 ;; corresponding ediff subsession.
586 ;; DIFF-LIST is of the form:
587 ;; (META-HEADER (file . num) (file . num)...)
588 ;; where num encodes the set of dirs where the file is found:
589 ;; 2 - only dir1; 3 - only dir2; 5 - only dir3; 6 - dir1&2; 10 - dir1&3; etc.
591 ;; Contains the meta info about this ediff operation
592 ;; (regexp dir1 dir2 dir3 merge-auto-store-dir comparison-func)
593 ;; Later the meta-buffer is prepended to this list.
595 ;; Some operations might use a different meta header. For instance,
596 ;; ediff-multifile-patch doesn't have dir2 and dir3, and regexp,
597 ;; comparison-func don't apply.
599 (defun ediff-intersect-directories (jobname
602 dir3 merge-autostore-dir comparison-func)
603 (setq comparison-func (or comparison-func 'string=))
604 (let (lis1 lis2 lis3 common auxdir1 auxdir2 auxdir3 common-part difflist)
606 (setq auxdir1 (file-name-as-directory dir1)
607 lis1 (directory-files auxdir1 nil regexp)
608 lis1 (delete "." lis1)
609 lis1 (delete ".." lis1)
612 (ediff-add-slash-if-directory auxdir1 elt))
614 auxdir2 (file-name-as-directory dir2)
615 lis2 (directory-files auxdir2 nil regexp)
616 lis2 (delete "." lis2)
617 lis2 (delete ".." lis2)
620 (ediff-add-slash-if-directory auxdir2 elt))
624 (setq auxdir3 (file-name-as-directory dir3)
625 lis3 (directory-files auxdir3 nil regexp)
626 lis3 (delete "." lis3)
627 lis3 (delete ".." lis3)
630 (ediff-add-slash-if-directory auxdir3 elt))
633 (if (ediff-nonempty-string-p merge-autostore-dir)
634 (setq merge-autostore-dir
635 (file-name-as-directory merge-autostore-dir)))
636 (setq common (ediff-intersection lis1 lis2 comparison-func))
638 ;; In merge with ancestor jobs, we don't intersect with lis3.
639 ;; If there is no ancestor, we'll offer to merge without the ancestor.
640 ;; So, we intersect with lis3 only when we are doing 3-way file comparison
641 (if (and lis3 (ediff-comparison-metajob3 jobname))
642 (setq common (ediff-intersection common lis3 comparison-func)))
644 ;; copying is needed because sort sorts via side effects
645 (setq common (sort (ediff-copy-list common) 'string-lessp))
647 ;; compute difference list
648 (setq difflist (ediff-set-difference
649 (ediff-union (ediff-union lis1 lis2 comparison-func)
654 difflist (delete "." difflist)
655 ;; copying is needed because sort sorts via side effects
656 difflist (sort (ediff-copy-list (delete ".." difflist))
659 (setq difflist (mapcar (lambda (elt) (cons elt 1)) difflist))
661 ;; check for files belonging to lis1/2/3
662 ;; Each elt is of the norm (file . number)
663 ;; Number encodes the directories to which file belongs.
664 ;; It is a product of a subset of ediff-membership-code1=2,
665 ;; ediff-membership-code2=3, and ediff-membership-code3=5.
666 ;; If file belongs to dir 1 only, the membership code is 2.
667 ;; If it is in dir1 and dir3, then the membership code is 2*5=10;
668 ;; if it is in dir1 and dir2, then the membership code is 2*3=6, etc.
670 (if (member (car elt) lis1)
671 (setcdr elt (* (cdr elt) ediff-membership-code1)))
672 (if (member (car elt) lis2)
673 (setcdr elt (* (cdr elt) ediff-membership-code2)))
674 (if (member (car elt) lis3)
675 (setcdr elt (* (cdr elt) ediff-membership-code3)))
679 ;; diff metalist header
680 (ediff-make-new-meta-list-header regexp
681 auxdir1 auxdir2 auxdir3
689 (ediff-make-new-meta-list-header regexp
690 auxdir1 auxdir2 auxdir3
695 (ediff-make-new-meta-list-element
696 (expand-file-name (concat auxdir1 elt))
697 (expand-file-name (concat auxdir2 elt))
700 ;; The following is done because: In merging with
701 ;; ancestor, we don't intersect with lis3. So, it is
702 ;; possible that elt is a file in auxdir1/2 but a
703 ;; directory in auxdir3 Or elt may not exist in auxdir3 at
704 ;; all. In the first case, we add a slash at the end. In
705 ;; the second case, we insert nil.
706 (setq elt (ediff-add-slash-if-directory auxdir3 elt))
707 (if (file-exists-p (concat auxdir3 elt))
708 (expand-file-name (concat auxdir3 elt)))))))
711 (cons common-part difflist)
714 ;; find directory files that are under revision. Include subdirectories, since
715 ;; we may visit them recursively. DIR1 is the directory to inspect.
716 ;; MERGE-AUTOSTORE-DIR is the directory where to auto-store the results of
717 ;; merges. Can be nil.
718 (defun ediff-get-directory-files-under-revision (jobname
720 &optional merge-autostore-dir)
721 (let (lis1 elt common auxdir1)
722 (setq auxdir1 (file-name-as-directory dir1)
723 lis1 (directory-files auxdir1 nil regexp))
725 (if (ediff-nonempty-string-p merge-autostore-dir)
726 (setq merge-autostore-dir
727 (file-name-as-directory merge-autostore-dir)))
732 ;; take files under revision control
733 (cond ((file-directory-p (concat auxdir1 elt))
735 (cons (ediff-add-slash-if-directory auxdir1 elt) common)))
736 ((and (featurep 'vc-hooks) (vc-backend (concat auxdir1 elt)))
737 (setq common (cons elt common)))
738 ;; The following two are needed only if vc-hooks isn't loaded.
739 ;; They won't recognize CVS files.
740 ((file-exists-p (concat auxdir1 elt ",v"))
741 (setq common (cons elt common)))
742 ((file-exists-p (concat auxdir1 "RCS/" elt ",v"))
743 (setq common (cons elt common)))
747 (setq common (delete "./" common)
748 common (delete "../" common)
749 common (delete "RCS" common)
750 common (delete "CVS" common)
753 ;; copying is needed because sort sorts via side effects
754 (setq common (sort (ediff-copy-list common) 'string-lessp))
758 ;; header -- has 6 elements. Meta buffer is prepended later by
759 ;; ediff-prepare-meta-buffer
760 (ediff-make-new-meta-list-header regexp
762 merge-autostore-dir nil)
763 (mapcar (lambda (elt) (ediff-make-new-meta-list-element
764 (expand-file-name (concat auxdir1 elt)) nil nil))
769 ;; If file groups selected by patterns will ever be implemented, this
770 ;; comparison function might become useful.
771 ;;;; uses external variables PAT1 PAT2 to compare str1/2
772 ;;;; patterns must be of the form ???*???? where ??? are strings of chars
773 ;;;; containing no *.
774 ;;(defun ediff-pattern= (str1 str2)
775 ;; (let (pos11 pos12 pos21 pos22 len1 len2)
777 ;; len (length epat1)
779 ;; (while (and (< pos11 len) (not (= (aref epat1 pos11) ?*)))
780 ;; (setq pos11 (1+ pos11)))
781 ;; (while (and (> pos12 0) (not (= (aref epat1 (1- pos12)) ?*)))
782 ;; (setq pos12 (1- pos12)))
785 ;; len (length epat2)
787 ;; (while (and (< pos21 len) (not (= (aref epat2 pos21) ?*)))
788 ;; (setq pos21 (1+ pos21)))
789 ;; (while (and (> pos22 0) (not (= (aref epat2 (1- pos22)) ?*)))
790 ;; (setq pos22 (1- pos22)))
792 ;; (if (and (> (length str1) pos12) (>= pos12 pos11) (> pos11 -1)
793 ;; (> (length str2) pos22) (>= pos22 pos21) (> pos21 -1))
794 ;; (string= (substring str1 pos11 pos12)
795 ;; (substring str2 pos21 pos22)))
799 ;; Prepare meta-buffer in accordance with the argument-function and
800 ;; redraw-function. Must return the created meta-buffer.
801 (defun ediff-prepare-meta-buffer (action-func meta-list
802 meta-buffer-name redraw-function
803 jobname &optional startup-hooks)
804 (let* ((meta-buffer-name
805 (ediff-unique-buffer-name meta-buffer-name "*"))
806 (meta-buffer (get-buffer-create meta-buffer-name)))
807 (ediff-with-current-buffer meta-buffer
812 (setq ediff-meta-action-function action-func
813 ediff-meta-redraw-function redraw-function
814 ediff-metajob-name jobname
815 ediff-meta-buffer meta-buffer)
817 ;; comes after ediff-meta-action-function is set
818 (ediff-setup-meta-map)
820 (if (eq ediff-metajob-name 'ediff-registry)
822 (setq ediff-registry-buffer meta-buffer
823 ediff-meta-list meta-list)
824 ;; this func is used only from registry buffer, not from other
827 ediff-meta-buffer-map "M" 'ediff-show-meta-buff-from-registry))
828 ;; Initialize the meta list -- we don't do this for registry.
829 (setq ediff-meta-list
830 ;; add meta-buffer to the list header
831 (cons (cons meta-buffer (car meta-list))
834 (or (eq meta-buffer ediff-registry-buffer)
835 (setq ediff-session-registry
836 (cons meta-buffer ediff-session-registry)))
838 ;; redraw-function uses ediff-meta-list
839 (funcall redraw-function ediff-meta-list)
841 ;; set read-only/non-modified
842 (setq buffer-read-only t)
843 (set-buffer-modified-p nil)
845 (run-hooks 'startup-hooks)
847 ;; Arrange to show directory contents differences
848 ;; Must be after run startup-hooks, since ediff-dir-difference-list is
849 ;; set inside these hooks
850 (if (eq action-func 'ediff-filegroup-action)
852 ;; put meta buffer in (car ediff-dir-difference-list)
853 (setq ediff-dir-difference-list
854 (cons (cons meta-buffer (car ediff-dir-difference-list))
855 (cdr ediff-dir-difference-list)))
857 (or (ediff-one-filegroup-metajob jobname)
858 (ediff-draw-dir-diffs ediff-dir-difference-list))
860 ediff-meta-buffer-map "h" 'ediff-mark-for-hiding-at-pos)
861 (define-key ediff-meta-buffer-map "x" 'ediff-hide-marked-sessions)
863 ediff-meta-buffer-map "m" 'ediff-mark-for-operation-at-pos)
864 (define-key ediff-meta-buffer-map "u" nil)
866 ediff-meta-buffer-map "um" 'ediff-unmark-all-for-operation)
868 ediff-meta-buffer-map "uh" 'ediff-unmark-all-for-hiding)
870 (define-key ediff-meta-buffer-map
871 [menu-bar ediff-meta-mode ediff-hide-marked-sessions]
872 '(menu-item "Hide marked" ediff-hide-marked-sessions
873 :help "Hide marked sessions. With prefix arg, unhide"))
875 (define-key ediff-meta-buffer-map
876 [menu-bar ediff-meta-mode ediff-mark-for-hiding-at-pos]
877 '(menu-item "Mark for hiding" ediff-mark-for-hiding-at-pos
878 :help "Mark session for hiding. With prefix arg, unmark"))
880 (define-key ediff-meta-buffer-map
881 [menu-bar ediff-meta-mode ediff-mark-for-operation-at-pos]
882 '(menu-item "Mark for group operation" ediff-mark-for-operation-at-pos
883 :help "Mark session for a group operation. With prefix arg, unmark"))
885 (define-key ediff-meta-buffer-map
886 [menu-bar ediff-meta-mode ediff-unmark-all-for-hiding]
887 '(menu-item "Unmark all for hiding" ediff-unmark-all-for-hiding
888 :help "Unmark all sessions marked for hiding"))
890 (define-key ediff-meta-buffer-map
891 [menu-bar ediff-meta-mode ediff-unmark-all-for-operation]
892 '(menu-item "Unmark all for group operation" ediff-unmark-all-for-operation
893 :help "Unmark all sessions marked for operation"))
895 (cond ((ediff-collect-diffs-metajob jobname)
896 (define-key ediff-meta-buffer-map
897 [menu-bar ediff-meta-mode ediff-collect-custom-diffs]
898 '(menu-item "Collect diffs" ediff-collect-custom-diffs
899 :help "Collect custom diffs of marked sessions in buffer `*Ediff Multifile Diffs*'"))
901 ediff-meta-buffer-map "P" 'ediff-collect-custom-diffs))
902 ((ediff-patch-metajob jobname)
903 (define-key ediff-meta-buffer-map
904 [menu-bar ediff-meta-mode ediff-meta-show-patch]
905 '(menu-item "Show multi-file patch" ediff-meta-show-patch
906 :help "Show the multi-file patch associated with this group session"))
908 ediff-meta-buffer-map "P" 'ediff-meta-show-patch)))
909 (define-key ediff-meta-buffer-map "^" 'ediff-up-meta-hierarchy)
910 (define-key ediff-meta-buffer-map "D" 'ediff-show-dir-diffs)
912 (define-key ediff-meta-buffer-map
913 [menu-bar ediff-meta-mode ediff-up-meta-hierarchy]
914 '(menu-item "Go to parent session" ediff-up-meta-hierarchy
915 :help "Go to the parent session group buffer"))
917 (define-key ediff-meta-buffer-map
918 [menu-bar ediff-meta-mode ediff-show-dir-diffs]
919 '(menu-item "Diff directories" ediff-show-dir-diffs
920 :help "Display differences among the directories involved in session group"))))
922 (if (eq ediff-metajob-name 'ediff-registry)
923 (run-hooks 'ediff-registry-setup-hook)
924 (run-hooks 'ediff-after-session-group-setup-hook))
925 ) ; eval in meta-buffer
928 ;; Insert the activity marker for session SESSION in the meta buffer at point
929 ;; The activity marker is either SPC (untouched session), or + (active session,
930 ;; i.e., ediff is currently run in it), or - (finished session, i.e., we've ran
931 ;; ediff in it and then exited)
932 (defun ediff-insert-session-activity-marker-in-meta-buffer (session)
934 (cond ((ediff-get-session-activity-marker session))
938 ;; Insert session status at point. Status is either ?H (marked for hiding), or
939 ;; ?I (hidden or invalid), or ?* (meaning marked for an operation; currently,
940 ;; such op can only be checking for equality)), or SPC (meaning neither marked
942 (defun ediff-insert-session-status-in-meta-buffer (session)
944 (cond ((ediff-get-session-status session)) ; session has status: ?H, ?I, ?*
945 ;; normal session, no marks or hidings
948 ;; If NEW-MARKER is non-nil, use it to substitute the current activity marker
949 ;; in the meta buffer. If nil, use SPC
950 (defun ediff-replace-session-activity-marker-in-meta-buffer (point new-marker)
951 (let* ((overl (ediff-get-meta-overlay-at-pos point))
952 (session-info (ediff-overlay-get overl 'ediff-meta-info))
953 (activity-marker (ediff-get-session-activity-marker session-info))
955 (or new-marker activity-marker (setq new-marker ?\s))
956 (goto-char (ediff-overlay-start overl))
957 (if (eq (char-after (point)) new-marker)
958 () ; if marker shown in buffer is the same as new-marker, do nothing
961 (set-buffer-modified-p nil))))
963 ;; If NEW-STATUS is non-nil, use it to substitute the current status marker in
964 ;; the meta buffer. If nil, use SPC
965 (defun ediff-replace-session-status-in-meta-buffer (point new-status)
966 (let* ((overl (ediff-get-meta-overlay-at-pos point))
967 (session-info (ediff-overlay-get overl 'ediff-meta-info))
968 (status (ediff-get-session-status session-info))
970 (setq new-status (or new-status status ?\s))
971 (goto-char (ediff-overlay-start overl))
972 (forward-char 1) ; status is the second char in session record
973 (if (eq (char-after (point)) new-status)
974 () ; if marker shown in buffer is the same as new-marker, do nothing
977 (set-buffer-modified-p nil))))
979 ;; insert all file info in meta buffer for a given session
980 (defun ediff-insert-session-info-in-meta-buffer (session-info sessionNum)
981 (let ((f1 (ediff-get-session-objA session-info))
982 (f2 (ediff-get-session-objB session-info))
983 (f3 (ediff-get-session-objC session-info))
985 (hidden (eq (ediff-get-session-status session-info) ?I)))
986 ;; insert activity marker, i.e., SPC, - or +
987 (ediff-insert-session-activity-marker-in-meta-buffer session-info)
988 ;; insert session status, i.e., *, H
989 (ediff-insert-session-status-in-meta-buffer session-info)
990 (insert " Session " (int-to-string sessionNum) ":\n")
991 (ediff-meta-insert-file-info1 f1)
992 (ediff-meta-insert-file-info1 f2)
993 (ediff-meta-insert-file-info1 f3)
994 (ediff-set-meta-overlay pt (point) session-info sessionNum hidden)))
997 ;; this is a setup function for ediff-directories
998 ;; must return meta-buffer
999 (defun ediff-redraw-directory-group-buffer (meta-list)
1000 ;; extract directories
1001 (let ((meta-buf (ediff-get-group-buffer meta-list))
1004 regexp elt merge-autostore-dir
1005 point tmp-list buffer-read-only)
1006 (ediff-with-current-buffer meta-buf
1007 (setq point (point))
1009 ;; delete phony overlays that used to represent sessions before the buff
1011 (if (featurep 'xemacs)
1012 (map-extents 'delete-extent)
1013 (mapc 'delete-overlay (overlays-in 1 1)))
1015 (setq regexp (ediff-get-group-regexp meta-list)
1017 (ediff-get-group-merge-autostore-dir meta-list))
1019 (if ediff-verbose-help-enabled
1021 (insert (format ediff-meta-buffer-verbose-message
1022 (ediff-abbrev-jobname ediff-metajob-name)))
1024 (cond ((ediff-collect-diffs-metajob)
1026 " P:\tcollect custom diffs of all marked sessions\n"))
1027 ((ediff-patch-metajob)
1029 " P:\tshow patch appropriately for the context (session or group)\n")))
1031 " ^:\tshow parent session group\n")
1032 (or (ediff-one-filegroup-metajob)
1034 " D:\tshow differences among directories\n"
1035 " ==:\tfor each session, show which files are identical\n"
1036 " =h:\tlike ==, but also marks sessions for hiding\n"
1037 " =m:\tlike ==, but also marks sessions for operation\n\n")))
1038 (insert (format ediff-meta-buffer-brief-message
1039 (ediff-abbrev-jobname ediff-metajob-name))))
1042 (if (and (stringp regexp) (> (length regexp) 0))
1044 (format "*** Filter-through regular expression: %s\n" regexp)))
1045 (ediff-insert-dirs-in-meta-buffer meta-list)
1046 (if (and ediff-autostore-merges (ediff-merge-metajob)
1047 (ediff-nonempty-string-p merge-autostore-dir))
1049 "\nMerge results are automatically stored in:\n\t%s\n"
1050 merge-autostore-dir)))
1052 Size Last modified Name
1053 ----------------------------------------------
1057 ;; discard info on directories and regexp
1058 (setq meta-list (cdr meta-list)
1060 (while (and tmp-list empty)
1061 (if (and (car tmp-list)
1062 (not (eq (ediff-get-session-status (car tmp-list)) ?I)))
1064 (setq tmp-list (cdr tmp-list)))
1068 " ****** ****** This session group has no members\n"))
1070 ;; now organize file names like this:
1071 ;; use-mark sizeA dateA sizeB dateB filename
1072 ;; make sure directories are displayed with a trailing slash.
1074 (setq elt (car meta-list)
1075 meta-list (cdr meta-list)
1076 sessionNum (1+ sessionNum))
1077 (if (eq (ediff-get-session-status elt) ?I)
1079 (ediff-insert-session-info-in-meta-buffer elt sessionNum)))
1080 (set-buffer-modified-p nil)
1084 (defun ediff-update-markers-in-dir-meta-buffer (meta-list)
1085 (let ((meta-buf (ediff-get-group-buffer meta-list))
1086 session-info point overl buffer-read-only)
1087 (ediff-with-current-buffer meta-buf
1088 (setq point (point))
1089 (goto-char (point-min))
1090 (ediff-next-meta-item1)
1092 (setq session-info (ediff-get-meta-info meta-buf (point) 'no-error)
1093 overl (ediff-get-meta-overlay-at-pos (point)))
1096 (cond ((eq (ediff-get-session-status session-info) ?I)
1098 (if overl (ediff-overlay-put overl 'invisible t)))
1099 ((and (eq (ediff-get-session-status session-info) ?H)
1100 overl (ediff-overlay-get overl 'invisible))
1102 (ediff-overlay-put overl 'invisible nil))
1103 (t (ediff-replace-session-activity-marker-in-meta-buffer
1105 (ediff-get-session-activity-marker session-info))
1106 (ediff-replace-session-status-in-meta-buffer
1108 (ediff-get-session-status session-info))))))
1109 (ediff-next-meta-item1) ; advance to the next item
1111 (set-buffer-modified-p nil)
1115 (defun ediff-update-session-marker-in-dir-meta-buffer (session-num)
1116 (let (buffer-meta-overlays session-info overl buffer-read-only)
1118 (if (featurep 'xemacs)
1120 (lambda (ext maparg)
1122 (ediff-overlay-get ext 'ediff-meta-info)
1123 (eq (ediff-overlay-get ext 'ediff-meta-session-number)
1126 ;; Emacs doesn't have map-extents, so try harder
1127 ;; Splice overlay lists to get all buffer overlays
1128 (setq buffer-meta-overlays (overlay-lists)
1129 buffer-meta-overlays (append (car buffer-meta-overlays)
1130 (cdr buffer-meta-overlays)))
1136 (ediff-overlay-get overl 'ediff-meta-info)
1137 (eq (ediff-overlay-get
1138 overl 'ediff-meta-session-number)
1141 buffer-meta-overlays)))))
1144 "Bug in ediff-update-session-marker-in-dir-meta-buffer: no overlay with given number %S"
1146 (setq session-info (ediff-overlay-get overl 'ediff-meta-info))
1147 (goto-char (ediff-overlay-start overl))
1148 (ediff-replace-session-activity-marker-in-meta-buffer
1150 (ediff-get-session-activity-marker session-info))
1151 (ediff-replace-session-status-in-meta-buffer
1153 (ediff-get-session-status session-info)))
1154 (ediff-next-meta-item1))
1158 ;; Check if this is a problematic session.
1159 ;; Return nil if not. Otherwise, return symbol representing the problem
1160 ;; At present, problematic sessions occur only in -with-ancestor comparisons
1161 ;; when the ancestor is a directory rather than a file, or when there is no
1162 ;; suitable ancestor file in the ancestor directory
1163 (defun ediff-problematic-session-p (session)
1164 (let ((f1 (ediff-get-session-objA-name session))
1165 (f2 (ediff-get-session-objB-name session))
1166 (f3 (ediff-get-session-objC-name session)))
1167 (cond ((and (stringp f1) (not (file-directory-p f1))
1168 (stringp f2) (not (file-directory-p f2))
1169 ;; either invalid file name or a directory
1170 (or (not (stringp f3)) (file-directory-p f3))
1171 (ediff-ancestor-metajob))
1172 ;; more may be added later
1176 (defun ediff-meta-insert-file-info1 (fileinfo)
1177 (let ((fname (car fileinfo))
1178 (feq (ediff-get-file-eqstatus fileinfo))
1179 (max-filename-width (if ediff-meta-truncate-filenames
1180 (- (window-width) 41)
1182 file-modtime file-size)
1183 (cond ((not (stringp fname)) (setq file-size -2)) ; file doesn't exits
1184 ((ediff-listable-file fname)
1185 (if (file-exists-p fname)
1186 ;; set real size and modtime
1187 (setq file-size (ediff-file-size fname)
1188 file-modtime (ediff-file-modtime fname))
1189 (setq file-size -2))) ; file doesn't exist
1190 ( t (setq file-size -1))) ; remote file
1195 (if feq "=" " ") ; equality indicator
1196 (format "%10s" (cond ((= file-size -1) "--")
1197 ((< file-size -1) "--")
1199 (cond ((= file-size -1) "*remote file*")
1200 ((< file-size -1) "*file doesn't exist*")
1201 (t (ediff-format-date (decode-time file-modtime))))
1203 ;; dir names in meta lists have training slashes, so we just
1204 ;; abbreviate the file name, if file exists
1205 (if (and (not (stringp fname)) (< file-size -1))
1206 "-------" ; file doesn't exist
1207 (ediff-truncate-string-left
1208 (ediff-abbreviate-file-name fname)
1209 max-filename-width)))))))
1211 (defconst ediff-months '((1 . "Jan") (2 . "Feb") (3 . "Mar") (4 . "Apr")
1212 (5 . "May") (6 . "Jun") (7 . "Jul") (8 . "Aug")
1213 (9 . "Sep") (10 . "Oct") (11 . "Nov") (12 . "Dec"))
1214 "Months' associative array.")
1216 ;; returns 2char string
1217 (defsubst ediff-fill-leading-zero (num)
1220 (number-to-string num)))
1222 ;; TIME is like the output of decode-time
1223 (defun ediff-format-date (time)
1224 (format "%s %2d %4d %s:%s:%s"
1225 (cdr (assoc (nth 4 time) ediff-months)) ; month
1228 (ediff-fill-leading-zero (nth 2 time)) ; hour
1229 (ediff-fill-leading-zero (nth 1 time)) ; min
1230 (ediff-fill-leading-zero (nth 0 time)) ; sec
1233 ;; Draw the directories
1234 (defun ediff-insert-dirs-in-meta-buffer (meta-list)
1235 (let* ((dir1 (ediff-abbreviate-file-name (ediff-get-group-objA meta-list)))
1236 (dir2 (ediff-get-group-objB meta-list))
1237 (dir2 (if (stringp dir2) (ediff-abbreviate-file-name dir2)))
1238 (dir3 (ediff-get-group-objC meta-list))
1239 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3))))
1240 (insert "*** Directory A: " dir1 "\n")
1241 (if dir2 (insert "*** Directory B: " dir2 "\n"))
1242 (if dir3 (insert "*** Directory C: " dir3 "\n"))
1245 (defun ediff-draw-dir-diffs (diff-list &optional buf-name)
1246 (if (null diff-list) (error "Lost difference info on these directories"))
1249 (ediff-unique-buffer-name "*Ediff File Group Differences" "*")))
1250 (let* ((regexp (ediff-get-group-regexp diff-list))
1251 (dir1 (ediff-abbreviate-file-name (ediff-get-group-objA diff-list)))
1252 (dir2 (ediff-abbreviate-file-name (ediff-get-group-objB diff-list)))
1253 (dir3 (ediff-get-group-objC diff-list))
1254 (dir3 (if (stringp dir3) (ediff-abbreviate-file-name dir3)))
1255 (meta-buf (ediff-get-group-buffer diff-list))
1256 (underline (make-string 26 ?-))
1257 file membership-code saved-point
1259 ;; skip the directory part
1260 (setq diff-list (cdr diff-list))
1261 (setq ediff-dir-diffs-buffer (get-buffer-create buf-name))
1262 (ediff-with-current-buffer ediff-dir-diffs-buffer
1263 (setq saved-point (point))
1264 (use-local-map ediff-dir-diffs-buffer-map)
1266 (setq ediff-meta-buffer meta-buf)
1267 (insert "\t\t*** Directory Differences ***\n")
1270 C,button2: over file name -- copy this file to directory that doesn't have it
1273 p,DEL: previous line\n\n")
1275 (insert (format "\n*** Directory A: %s\n" dir1))
1276 (if dir2 (insert (format "*** Directory B: %s\n" dir2)))
1277 (if dir3 (insert (format "*** Directory C: %s\n" dir3)))
1278 (if (and (stringp regexp) (> (length regexp) 0))
1280 (format "*** Filter-through regular expression: %s\n" regexp)))
1282 (insert (format "\n%-27s%-26s" "Directory A" "Directory B"))
1284 (insert (format " %-25s\n" "Directory C"))
1286 (insert (format "%s%s" underline underline))
1288 (insert (format "%s\n\n" underline))
1291 (if (null diff-list)
1292 (insert "\n\t*** No differences ***\n"))
1295 (setq file (car (car diff-list))
1296 membership-code (cdr (car diff-list))
1297 diff-list (cdr diff-list))
1298 (if (= (mod membership-code ediff-membership-code1) 0) ; dir1
1299 (let ((beg (point)))
1300 (insert (format "%-27s"
1301 (ediff-truncate-string-left
1302 (ediff-abbreviate-file-name
1303 (if (file-directory-p (concat dir1 file))
1304 (file-name-as-directory file)
1307 ;; format of meta info in the dir-diff-buffer:
1308 ;; (filename-tail filename-full otherdir1 otherdir2 otherdir3)
1309 (ediff-set-meta-overlay
1311 (list meta-buf file (concat dir1 file) dir1 dir2 dir3)))
1312 (insert (format "%-27s" "---")))
1313 (if (= (mod membership-code ediff-membership-code2) 0) ; dir2
1314 (let ((beg (point)))
1315 (insert (format "%-26s"
1316 (ediff-truncate-string-left
1317 (ediff-abbreviate-file-name
1318 (if (file-directory-p (concat dir2 file))
1319 (file-name-as-directory file)
1322 (ediff-set-meta-overlay
1324 (list meta-buf file (concat dir2 file) dir1 dir2 dir3)))
1325 (insert (format "%-26s" "---")))
1327 (if (= (mod membership-code ediff-membership-code3) 0) ; dir3
1328 (let ((beg (point)))
1329 (insert (format " %-25s"
1330 (ediff-truncate-string-left
1331 (ediff-abbreviate-file-name
1332 (if (file-directory-p (concat dir3 file))
1333 (file-name-as-directory file)
1336 (ediff-set-meta-overlay
1338 (list meta-buf file (concat dir3 file) dir1 dir2 dir3)))
1339 (insert (format " %-25s" "---"))))
1341 (setq buffer-read-only t)
1342 (set-buffer-modified-p nil)
1343 (goto-char saved-point)) ; end eval in diff buffer
1346 (defun ediff-bury-dir-diffs-buffer ()
1347 "Bury the directory difference buffer. Display the meta buffer instead."
1349 ;; ediff-meta-buffer is set in ediff-draw-dir-diffs so the directory
1350 ;; difference buffer remembers the meta buffer
1351 (let ((buf ediff-meta-buffer)
1353 (ediff-kill-buffer-carefully ediff-dir-diffs-buffer)
1354 (if (setq wind (ediff-get-visible-buffer-window buf))
1355 (select-window wind)
1356 (set-window-buffer (selected-window) buf))))
1358 ;; executes in dir session group buffer
1359 ;; show buffer differences
1360 (defun ediff-show-dir-diffs ()
1361 "Display differences among the directories involved in session group."
1363 (if (ediff-one-filegroup-metajob)
1364 (error "This command is inapplicable in the present context"))
1365 (or (ediff-buffer-live-p ediff-dir-diffs-buffer)
1366 (ediff-draw-dir-diffs ediff-dir-difference-list))
1367 (let ((buf ediff-dir-diffs-buffer))
1369 (set-window-buffer (selected-window) buf)
1370 (goto-char (point-min))))
1372 ;; Format of meta info in dir-diff-buffer:
1373 ;; (filename-tail filename-full otherdir1 otherdir2)
1374 (defun ediff-dir-diff-copy-file ()
1375 "Copy file described at point to directories where this file is missing."
1377 (let* ((pos (ediff-event-point last-command-event))
1378 (info (ediff-get-meta-info (current-buffer) pos 'noerror))
1379 (meta-buf (car info))
1380 (file-tail (nth 1 info))
1381 (file-abs (nth 2 info))
1382 (otherdir1 (nth 3 info))
1383 (otherfile1 (if otherdir1 (concat otherdir1 file-tail)))
1384 (otherdir2 (nth 4 info))
1385 (otherfile2 (if otherdir2 (concat otherdir2 file-tail)))
1386 (otherdir3 (nth 5 info))
1387 (otherfile3 (if otherdir3 (concat otherdir3 file-tail)))
1388 meta-list dir-diff-list
1391 (error "No file suitable for copying described at this location"))
1392 (ediff-with-current-buffer meta-buf
1393 (setq meta-list ediff-meta-list
1394 dir-diff-list ediff-dir-difference-list))
1396 ;; copy file to directories where it doesn't exist, update
1397 ;; ediff-dir-difference-list and redisplay
1399 (lambda (otherfile-struct)
1400 (let ((otherfile (car otherfile-struct))
1401 (file-mem-code (cdr otherfile-struct)))
1403 (or (file-exists-p otherfile)
1405 (format "Copy %s to %s? " file-abs otherfile))
1406 (let* ((file-diff-record (assoc file-tail dir-diff-list))
1408 (* (cdr file-diff-record) file-mem-code)))
1409 (copy-file file-abs otherfile)
1410 (setcdr file-diff-record new-mem-code)
1411 (ediff-draw-dir-diffs dir-diff-list (buffer-name))
1413 ;; if file is in all three dirs or in two dirs and only
1414 ;; two dirs are involved, delete this file's record
1415 (if (or (= new-mem-code ediff-product-of-memcodes)
1416 (and (> new-mem-code ediff-membership-code3)
1418 (delq file-diff-record dir-diff-list))
1421 ;; 2,3,5 are numbers used to encode membership of a file in
1422 ;; dir1/2/3. See ediff-intersect-directories.
1423 (list (cons otherfile1 2) (cons otherfile2 3) (cons otherfile3 5)))
1425 (if (and (file-exists-p otherfile1)
1426 (file-exists-p otherfile2)
1427 (or (not otherfile3) (file-exists-p otherfile3)))
1428 ;; update ediff-meta-list by direct modification
1430 (list (ediff-make-new-meta-list-element
1431 (expand-file-name otherfile1)
1432 (expand-file-name otherfile2)
1434 (expand-file-name otherfile3)))))
1436 (ediff-update-meta-buffer meta-buf 'must-redraw)
1439 (defun ediff-up-meta-hierarchy ()
1440 "Go to the parent session group buffer."
1442 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
1443 (ediff-show-meta-buffer
1444 ediff-parent-meta-buffer ediff-meta-session-number)
1445 (error "This session group has no parent")))
1448 ;; argument is ignored
1449 (defun ediff-redraw-registry-buffer (&optional ignore)
1450 (ediff-with-current-buffer ediff-registry-buffer
1451 (let ((point (point))
1452 elt bufAname bufBname bufCname cur-diff total-diffs pt
1453 job-name meta-list registry-list buffer-read-only)
1455 ;; delete phony overlays that used to represent sessions before the buff
1457 (if (featurep 'xemacs)
1458 (map-extents 'delete-extent)
1459 (mapc 'delete-overlay (overlays-in 1 1)))
1461 (insert "This is a registry of all active Ediff sessions.
1464 button2, `v', RET over a session record: switch to that session
1465 M over a session record: display the associated session group
1466 R in any Ediff session: display session registry
1468 p,DEL: previous session
1469 E: browse Ediff on-line manual
1473 \t\tActive Ediff Sessions:
1474 \t\t----------------------
1477 ;; purge registry list from dead buffers
1479 (if (not (ediff-buffer-live-p elt))
1480 (setq ediff-session-registry
1481 (delq elt ediff-session-registry))))
1482 ediff-session-registry)
1484 (if (null ediff-session-registry)
1485 (insert " ******* No active Ediff sessions *******\n"))
1487 (setq registry-list ediff-session-registry)
1488 (while registry-list
1489 (setq elt (car registry-list)
1490 registry-list (cdr registry-list))
1492 (if (ediff-buffer-live-p elt)
1493 (if (ediff-with-current-buffer elt
1494 (setq job-name ediff-metajob-name
1495 meta-list ediff-meta-list)
1496 (and ediff-metajob-name
1497 (not (eq ediff-metajob-name 'ediff-registry))))
1500 (insert (format " *group*\t%s: %s\n"
1502 (ediff-abbrev-jobname job-name)))
1503 (insert (format "\t\t %s %s %s\n"
1504 (ediff-abbreviate-file-name
1505 (ediff-get-group-objA meta-list))
1506 (ediff-abbreviate-file-name
1508 (ediff-get-group-objB meta-list))
1509 (ediff-get-group-objB meta-list)
1511 (ediff-abbreviate-file-name
1513 (ediff-get-group-objC meta-list))
1514 (ediff-get-group-objC meta-list)
1516 (ediff-set-meta-overlay pt (point) elt))
1518 (ediff-with-current-buffer elt
1519 (setq bufAname (if (ediff-buffer-live-p ediff-buffer-A)
1520 (buffer-name ediff-buffer-A)
1521 "!!!killed buffer!!!")
1522 bufBname (if (ediff-buffer-live-p ediff-buffer-B)
1523 (buffer-name ediff-buffer-B)
1524 "!!!killed buffer!!!")
1525 bufCname (cond ((not (ediff-3way-job))
1527 ((ediff-buffer-live-p ediff-buffer-C)
1528 (buffer-name ediff-buffer-C))
1529 (t "!!!killed buffer!!!")))
1530 (setq total-diffs (format "%-4d" ediff-number-of-differences)
1532 (cond ((= ediff-current-difference -1) " _")
1533 ((= ediff-current-difference
1534 ediff-number-of-differences)
1537 "%4d" (1+ ediff-current-difference))))
1538 job-name ediff-job-name))
1539 ;; back in the meta buf
1541 (insert cur-diff "/" total-diffs "\t"
1543 (format ": %s" (ediff-abbrev-jobname job-name)))
1545 "\n\t\t " bufAname " " bufBname " " bufCname "\n")
1546 (ediff-set-meta-overlay pt (point) elt))))
1548 (set-buffer-modified-p nil)
1552 ;; Sets overlay around a meta record with 'ediff-meta-info property PROP
1553 ;; If optional SESSION-NUMBER, make it a property of the overlay,
1554 ;; ediff-meta-session-number
1555 ;; PROP is either the ctl or meta buffer (used when we work with the registry)
1556 ;; or a session meta descriptor of the form
1557 ;; (SESSION-CTL-BUFFER STATUS OBJA OBJB OBJC)
1558 (defun ediff-set-meta-overlay (b e prop &optional session-number hidden)
1560 (setq overl (ediff-make-overlay b e))
1561 (if (featurep 'emacs)
1562 (ediff-overlay-put overl 'mouse-face 'highlight)
1563 (ediff-overlay-put overl 'highlight t))
1564 (ediff-overlay-put overl 'ediff-meta-info prop)
1565 (ediff-overlay-put overl 'invisible hidden)
1566 (ediff-overlay-put overl 'follow-link t)
1567 (if (numberp session-number)
1568 (ediff-overlay-put overl 'ediff-meta-session-number session-number))))
1570 (defun ediff-mark-for-hiding-at-pos (unmark)
1571 "Mark session for hiding. With prefix arg, unmark."
1573 (let* ((pos (ediff-event-point last-command-event))
1574 (meta-buf (ediff-event-buffer last-command-event))
1575 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1576 (info (ediff-get-meta-info meta-buf pos))
1577 (session-number (ediff-get-session-number-at-pos pos)))
1578 (ediff-mark-session-for-hiding info unmark)
1579 (ediff-next-meta-item 1)
1581 (ediff-update-meta-buffer meta-buf nil session-number))
1584 ;; Returns whether session was marked or unmarked
1585 (defun ediff-mark-session-for-hiding (info unmark)
1586 (let ((session-buf (ediff-get-session-buffer info))
1588 (cond ((eq unmark 'mark) (setq unmark nil))
1589 ((eq (ediff-get-session-status info) ?H) (setq unmark t))
1590 (unmark ; says unmark, but the marker is different from H
1593 (unmark (ediff-set-session-status info nil))
1594 ;;; (if (ediff-buffer-live-p session-buf)
1595 ;;; (error "Can't hide active session, %s" (buffer-name session-buf)))
1596 (t (ediff-set-session-status info ?H))))
1600 (defun ediff-mark-for-operation-at-pos (unmark)
1601 "Mark session for a group operation. With prefix arg, unmark."
1603 (let* ((pos (ediff-event-point last-command-event))
1604 (meta-buf (ediff-event-buffer last-command-event))
1605 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1606 (info (ediff-get-meta-info meta-buf pos))
1607 (session-number (ediff-get-session-number-at-pos pos)))
1608 (ediff-mark-session-for-operation info unmark)
1609 (ediff-next-meta-item 1)
1611 (ediff-update-meta-buffer meta-buf nil session-number))
1615 ;; returns whether session was unmarked.
1616 ;; remember: this is a toggle op
1617 (defun ediff-mark-session-for-operation (info unmark)
1619 (cond ((eq unmark 'mark) (setq unmark nil))
1620 ((eq (ediff-get-session-status info) ?*) (setq unmark t))
1621 (unmark ; says unmark, but the marker is different from *
1624 (unmark (ediff-set-session-status info nil))
1625 (t (ediff-set-session-status info ?*))))
1629 (defun ediff-hide-marked-sessions (unhide)
1630 "Hide marked sessions. With prefix arg, unhide."
1632 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1633 (meta-list (cdr ediff-meta-list))
1634 (from (if unhide ?I ?H))
1635 (to (if unhide ?H ?I))
1637 active-sessions-exist session-buf elt)
1639 (setq elt (car meta-list)
1640 meta-list (cdr meta-list)
1641 session-buf (ediff-get-session-buffer elt))
1643 (if (eq (ediff-get-session-status elt) from)
1645 (setq numMarked (1+ numMarked))
1646 (if (and (eq to ?I) (buffer-live-p session-buf))
1647 ;; shouldn't hide active sessions
1648 (setq active-sessions-exist t)
1649 (ediff-set-session-status elt to)))))
1651 (ediff-update-meta-buffer grp-buf 'must-redraw)
1654 (message "Nothing to reveal...")
1655 (message "Nothing to hide...")))
1656 (if active-sessions-exist
1657 (message "Note: Ediff didn't hide active sessions!"))
1660 ;; Apply OPERATION to marked sessions. Operation expects one argument of type
1661 ;; meta-list member (not the first one), i.e., a regular session description.
1662 ;; Returns number of marked sessions on which operation was performed
1663 (defun ediff-operate-on-marked-sessions (operation)
1664 (let ((grp-buf (ediff-get-group-buffer ediff-meta-list))
1665 (meta-list (cdr ediff-meta-list))
1669 (diff-buffer ediff-meta-diff-buffer)
1672 (setq elt (car meta-list)
1673 meta-list (cdr meta-list)
1674 sessionNum (1+ sessionNum))
1675 (cond ((eq (ediff-get-session-status elt) marksym)
1677 (setq numMarked (1+ numMarked))
1678 (funcall operation elt sessionNum)))
1679 ;; The following goes into a session represented by a subdirectory
1680 ;; and applies operation to marked sessions there
1681 ((and (ediff-meta-session-p elt)
1682 (ediff-buffer-live-p
1683 (setq session-buf (ediff-get-session-buffer elt))))
1686 (ediff-with-current-buffer session-buf
1687 ;; pass meta-diff along
1688 (setq ediff-meta-diff-buffer diff-buffer)
1689 ;; collect diffs in child group
1690 (ediff-operate-on-marked-sessions operation)))))))
1691 (ediff-update-meta-buffer grp-buf 'must-redraw) ; just in case
1695 (defun ediff-append-custom-diff (session sessionNum)
1696 (or (ediff-collect-diffs-metajob)
1697 (error "Can't compute multifile patch in this context"))
1698 (let ((session-buf (ediff-get-session-buffer session))
1699 (meta-diff-buff ediff-meta-diff-buffer)
1700 (metajob ediff-metajob-name)
1701 tmp-buf custom-diff-buf)
1702 (if (ediff-buffer-live-p session-buf)
1703 (ediff-with-current-buffer session-buf
1704 (if (eq ediff-control-buffer session-buf) ; individual session
1706 (ediff-compute-custom-diffs-maybe)
1707 (setq custom-diff-buf ediff-custom-diff-buffer)))))
1709 (or (ediff-buffer-live-p meta-diff-buff)
1710 (error "Ediff: something wrong--killed multiple diff's buffer"))
1712 (cond ((ediff-buffer-live-p custom-diff-buf)
1713 ;; for live session buffers we do them first because the user may
1714 ;; have changed them with respect to the underlying files
1715 (with-current-buffer meta-diff-buff
1716 (goto-char (point-max))
1717 (insert-buffer-substring custom-diff-buf)
1719 ;; if ediff session is not live, run diff directly on the files
1720 ((memq metajob '(ediff-directories
1721 ediff-merge-directories
1722 ediff-merge-directories-with-ancestor))
1723 ;; get diffs by calling shell command on ediff-custom-diff-program
1724 (with-current-buffer
1725 (setq tmp-buf (get-buffer-create ediff-tmp-buffer))
1730 (shell-quote-argument ediff-custom-diff-program)
1731 ediff-custom-diff-options
1732 (shell-quote-argument (ediff-get-session-objA-name session))
1733 (shell-quote-argument (ediff-get-session-objB-name session))
1737 (with-current-buffer meta-diff-buff
1738 (goto-char (point-max))
1739 (insert-buffer-substring tmp-buf)
1742 (ediff-kill-buffer-carefully meta-diff-buff)
1743 (error "Session %d compares versions of file. Such session must be active to enable multifile patch collection" sessionNum )))
1746 (defun ediff-collect-custom-diffs ()
1747 "Collect custom diffs of marked sessions in buffer `*Ediff Multifile Diffs*'.
1748 This operation is defined only for `ediff-directories' and
1749 `ediff-directory-revisions', since its intent is to produce
1750 multifile patches. For `ediff-directory-revisions', we insist that
1751 all marked sessions must be active."
1753 (let ((coding-system-for-read ediff-coding-system-for-read))
1754 (or (ediff-buffer-live-p ediff-meta-diff-buffer)
1755 (setq ediff-meta-diff-buffer
1757 (ediff-unique-buffer-name "*Ediff Multifile Diffs" "*"))))
1758 (ediff-with-current-buffer ediff-meta-diff-buffer
1759 (setq buffer-read-only nil)
1761 (if (> (ediff-operate-on-marked-sessions 'ediff-append-custom-diff) 0)
1764 (display-buffer ediff-meta-diff-buffer 'not-this-window)
1765 (ediff-with-current-buffer ediff-meta-diff-buffer
1766 (set-buffer-modified-p nil)
1767 (setq buffer-read-only t))
1768 (if (fboundp 'diff-mode)
1769 (with-current-buffer ediff-meta-diff-buffer
1772 (message "No marked sessions found"))))
1774 (defun ediff-meta-show-patch ()
1775 "Show the multi-file patch associated with this group session."
1777 (let* ((pos (ediff-event-point last-command-event))
1778 (meta-buf (ediff-event-buffer last-command-event))
1779 (info (ediff-get-meta-info meta-buf pos 'noerror))
1780 (patchbuffer ediff-meta-patchbufer))
1781 (if (ediff-buffer-live-p patchbuffer)
1782 (ediff-with-current-buffer patchbuffer
1787 (ediff-get-session-objB-name info)
1788 (ediff-get-session-objC-name info)))
1789 (set-buffer (get-buffer-create ediff-tmp-buffer))
1791 (insert-buffer-substring patchbuffer)
1792 (goto-char (point-min))
1793 (display-buffer ediff-tmp-buffer 'not-this-window)
1795 (error "The patch buffer wasn't found"))))
1798 ;; This function executes in meta buffer. It knows where event happened.
1799 (defun ediff-filegroup-action ()
1800 "Execute appropriate action for a selected session."
1802 (let* ((pos (ediff-event-point last-command-event))
1803 (meta-buf (ediff-event-buffer last-command-event))
1804 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
1805 (info (ediff-get-meta-info meta-buf pos))
1806 (session-buf (ediff-get-session-buffer info))
1807 (session-number (ediff-get-session-number-at-pos pos meta-buf))
1808 (default-regexp (eval ediff-default-filtering-regexp))
1809 merge-autostore-dir file1 file2 file3 regexp)
1811 (setq file1 (ediff-get-session-objA-name info)
1812 file2 (ediff-get-session-objB-name info)
1813 file3 (ediff-get-session-objC-name info))
1815 ;; make sure we don't start on hidden sessions
1816 ;; ?H means marked for hiding. ?I means invalid (hidden).
1817 (if (memq (ediff-get-session-status info) '(?I))
1820 (if (y-or-n-p "This session is marked as hidden, unmark? ")
1822 (ediff-set-session-status info nil)
1823 (ediff-update-meta-buffer meta-buf nil session-number))
1824 (error "Aborted"))))
1826 (ediff-with-current-buffer meta-buf
1827 (setq merge-autostore-dir
1828 (ediff-get-group-merge-autostore-dir ediff-meta-list))
1829 (goto-char pos) ; if the user clicked on session--move point there
1830 ;; First handle sessions involving directories (which are themselves
1832 ;; After that handle individual sessions
1833 (cond ((ediff-meta-session-p info)
1834 ;; do ediff/ediff-merge on subdirectories
1835 (if (ediff-buffer-live-p session-buf)
1836 (ediff-show-meta-buffer session-buf)
1839 (if (stringp default-regexp)
1841 "Filter through regular expression (default %s): "
1843 "Filter through regular expression: ")
1845 'ediff-filtering-regexp-history
1846 (eval ediff-default-filtering-regexp)))
1847 (ediff-directories-internal
1848 file1 file2 file3 regexp
1849 ediff-session-action-function
1851 ;; make it update (car info) after startup
1853 ;; child session group should know its parent
1854 (setq ediff-parent-meta-buffer
1855 (quote ,ediff-meta-buffer)
1856 ediff-meta-session-number
1858 ;; and parent will know its child
1859 (setcar (quote ,info) ediff-meta-buffer))))))
1861 ;; Do ediff-revision on a subdirectory
1862 ((and (ediff-one-filegroup-metajob)
1863 (ediff-revision-metajob)
1864 (file-directory-p file1))
1865 (if (ediff-buffer-live-p session-buf)
1866 (ediff-show-meta-buffer session-buf)
1867 (setq regexp (read-string "Filter through regular expression: "
1868 nil 'ediff-filtering-regexp-history))
1869 (ediff-directory-revisions-internal
1871 ediff-session-action-function ediff-metajob-name
1872 ;; make it update (car info) after startup
1874 ;; child session group should know its parent and
1876 (setq ediff-parent-meta-buffer
1877 (quote ,ediff-meta-buffer)
1878 ediff-meta-session-number
1880 ;; and parent will know its child
1881 (setcar (quote ,info) ediff-meta-buffer))))))
1883 ;; From here on---only individual session handlers
1885 ;; handle an individual session with a live control buffer
1886 ((ediff-buffer-live-p session-buf)
1887 (ediff-with-current-buffer session-buf
1888 (setq ediff-mouse-pixel-position (mouse-pixel-position))
1889 (ediff-recenter 'no-rehighlight)))
1891 ((ediff-problematic-session-p info)
1894 "This session has no ancestor. Merge without the ancestor? ")
1897 ;; provide startup hooks
1900 'ediff-after-quit-hook-internal
1902 (if (ediff-buffer-live-p ,(current-buffer))
1903 (ediff-show-meta-buffer
1904 ,(current-buffer) ,session-number)))
1906 (setq ediff-meta-buffer ,(current-buffer)
1907 ediff-meta-session-number
1909 (setq ediff-merge-store-file
1910 ,(if (ediff-nonempty-string-p
1911 merge-autostore-dir)
1914 ediff-merge-filename-prefix
1915 (file-name-nondirectory file1))
1917 ;; make ediff-startup pass
1918 ;; ediff-control-buffer back to the meta
1921 (quote ,info) ediff-control-buffer))))
1923 ((ediff-one-filegroup-metajob) ; needs 1 file arg
1924 (funcall ediff-session-action-function
1926 ;; provide startup hooks
1929 'ediff-after-quit-hook-internal
1931 (if (ediff-buffer-live-p
1933 (ediff-show-meta-buffer
1937 (setq ediff-meta-buffer ,(current-buffer)
1938 ediff-meta-session-number
1940 (setq ediff-merge-store-file
1941 ,(if (ediff-nonempty-string-p
1942 merge-autostore-dir)
1945 ediff-merge-filename-prefix
1946 (file-name-nondirectory file1))) )
1947 ;; make ediff-startup pass
1948 ;; ediff-control-buffer back to the meta
1951 (quote ,info) ediff-control-buffer)))))
1952 ((not (ediff-metajob3)) ; need 2 file args
1953 (funcall ediff-session-action-function
1955 ;; provide startup hooks
1958 'ediff-after-quit-hook-internal
1960 (if (ediff-buffer-live-p
1962 (ediff-show-meta-buffer
1966 (setq ediff-meta-buffer ,(current-buffer)
1967 ediff-meta-session-number
1969 (setq ediff-merge-store-file
1970 ,(if (ediff-nonempty-string-p
1971 merge-autostore-dir)
1974 ediff-merge-filename-prefix
1975 (file-name-nondirectory file1))) )
1976 ;; make ediff-startup pass
1977 ;; ediff-control-buffer back to the meta
1980 (quote ,info) ediff-control-buffer)))))
1981 ((ediff-metajob3) ; need 3 file args
1982 (funcall ediff-session-action-function
1984 ;; arrange startup hooks
1987 'ediff-after-quit-hook-internal
1989 (if (ediff-buffer-live-p
1991 (ediff-show-meta-buffer
1995 (setq ediff-merge-store-file
1996 ,(if (ediff-nonempty-string-p
1997 merge-autostore-dir)
2000 ediff-merge-filename-prefix
2001 (file-name-nondirectory file1))) )
2002 (setq ediff-meta-buffer , (current-buffer)
2003 ediff-meta-session-number
2005 ;; this arranges that ediff-startup will pass
2006 ;; the value of ediff-control-buffer back to
2007 ;; the meta level, to the record in the meta
2008 ;; list containing the information about the
2009 ;; session associated with that
2010 ;; ediff-control-buffer
2012 (quote ,info) ediff-control-buffer)))))
2014 ) ; eval in meta-buf
2017 (defun ediff-registry-action ()
2018 "Switch to a selected session."
2020 (let* ((pos (ediff-event-point last-command-event))
2021 (buf (ediff-event-buffer last-command-event))
2022 (ctl-buf (ediff-get-meta-info buf pos)))
2024 (if (ediff-buffer-live-p ctl-buf)
2025 ;; check if this is ediff-control-buffer or ediff-meta-buffer
2026 (if (ediff-with-current-buffer ctl-buf
2027 (eq (key-binding "q") 'ediff-quit-meta-buffer))
2028 ;; it's a meta-buffer -- last action should just display it
2029 (ediff-show-meta-buffer ctl-buf t)
2030 ;; it's a session buffer -- invoke go back to session
2031 (ediff-with-current-buffer ctl-buf
2032 (setq ediff-mouse-pixel-position (mouse-pixel-position))
2033 (ediff-recenter 'no-rehighlight)))
2035 (message "You've selected a stale session --- try again")
2036 (ediff-update-registry))
2037 (ediff-with-current-buffer buf
2042 ;; If session number is t, means don't update meta buffer
2043 (defun ediff-show-meta-buffer (&optional meta-buf session-number)
2044 "Show the session group buffer."
2046 (run-hooks 'ediff-before-directory-setup-hooks)
2047 (let (wind frame silent)
2048 (if meta-buf (setq silent t))
2050 (setq meta-buf (or meta-buf ediff-meta-buffer))
2051 (cond ((not (bufferp meta-buf))
2052 (error "This Ediff session is not part of a session group"))
2053 ((not (ediff-buffer-live-p meta-buf))
2055 "Can't find this session's group panel -- session itself is ok")))
2057 (cond ((numberp session-number)
2058 (ediff-update-meta-buffer meta-buf nil session-number))
2059 ;; if session-number is t, don't update
2061 (t (ediff-cleanup-meta-buffer meta-buf)))
2063 (ediff-with-current-buffer meta-buf
2065 (cond ((setq wind (ediff-get-visible-buffer-window meta-buf))
2068 "Already showing the group panel for this session"))
2069 (set-window-buffer wind meta-buf)
2070 (select-window wind))
2071 ((window-live-p (setq wind ediff-window-C)) ;in merge--merge buf
2072 (set-window-buffer ediff-window-C meta-buf)
2073 (select-window wind))
2074 ((window-live-p (setq wind ediff-window-A))
2075 (set-window-buffer ediff-window-A meta-buf)
2076 (select-window wind))
2077 ((window-live-p (setq wind ediff-window-B))
2078 (set-window-buffer ediff-window-B meta-buf)
2079 (select-window wind))
2082 (ediff-get-visible-buffer-window ediff-registry-buffer))
2083 (ediff-window-display-p))
2084 (select-window wind)
2086 (set-window-buffer (selected-window) meta-buf))
2087 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
2088 (set-window-buffer (selected-window) meta-buf)))
2090 (if (and (ediff-window-display-p)
2092 (setq wind (ediff-get-visible-buffer-window meta-buf))))
2094 (setq frame (window-frame wind))
2096 (ediff-reset-mouse frame)))
2097 (sit-for 0) ; sometimes needed to synch the display and ensure that the
2098 ; point ends up after the just completed session
2099 (run-hooks 'ediff-show-session-group-hook)
2102 (defun ediff-show-current-session-meta-buffer ()
2104 (ediff-show-meta-buffer nil ediff-meta-session-number))
2106 (defun ediff-show-meta-buff-from-registry ()
2107 "Display the session group buffer for a selected session group."
2109 (let* ((pos (ediff-event-point last-command-event))
2110 (meta-buf (ediff-event-buffer last-command-event))
2111 (info (ediff-get-meta-info meta-buf pos))
2112 (meta-or-session-buf info))
2113 (ediff-with-current-buffer meta-or-session-buf
2114 (ediff-show-meta-buffer nil t))))
2117 (defun ediff-show-registry ()
2118 "Display Ediff's registry."
2120 (ediff-update-registry)
2121 (if (not (ediff-buffer-live-p ediff-registry-buffer))
2122 (error "No active Ediff sessions or corrupted session registry"))
2124 ;; for some reason, point moves in ediff-registry-buffer, so we preserve it
2126 (ediff-with-current-buffer ediff-registry-buffer
2129 (ediff-get-visible-buffer-window ediff-registry-buffer))
2130 (message "Already showing the registry")
2131 (set-window-buffer wind ediff-registry-buffer)
2132 (select-window wind))
2133 ((window-live-p ediff-window-C)
2134 (set-window-buffer ediff-window-C ediff-registry-buffer)
2135 (select-window ediff-window-C))
2136 ((window-live-p ediff-window-A)
2137 (set-window-buffer ediff-window-A ediff-registry-buffer)
2138 (select-window ediff-window-A))
2139 ((window-live-p ediff-window-B)
2140 (set-window-buffer ediff-window-B ediff-registry-buffer)
2141 (select-window ediff-window-B))
2143 (ediff-get-visible-buffer-window ediff-meta-buffer))
2144 (ediff-window-display-p))
2145 (select-window wind)
2147 (set-window-buffer (selected-window) ediff-registry-buffer))
2148 (t (ediff-skip-unsuitable-frames 'ok-unsplittable)
2149 (set-window-buffer (selected-window) ediff-registry-buffer)))
2151 (if (ediff-window-display-p)
2155 (ediff-get-visible-buffer-window ediff-registry-buffer)))
2157 (ediff-reset-mouse frame)))
2158 (run-hooks 'ediff-show-registry-hook)
2162 (defalias 'eregistry 'ediff-show-registry)
2164 ;; If meta-buf doesn't exist, it is created. In that case, id doesn't have a
2166 ;; Check if META-BUF exists before calling this function
2167 ;; Optional MUST-REDRAW, if non-nil, would force redrawing of the whole meta
2168 ;; buffer. Otherwise, it will just go over the buffer and update activity marks
2169 ;; and session status.
2170 ;; SESSION-NUMBER, if specified, says which session caused the update.
2171 (defun ediff-update-meta-buffer (meta-buf &optional must-redraw session-number)
2172 (if (ediff-buffer-live-p meta-buf)
2173 (ediff-with-current-buffer meta-buf
2175 (cond (must-redraw ; completely redraw the meta buffer
2176 (funcall ediff-meta-redraw-function ediff-meta-list))
2177 ((numberp session-number) ; redraw only for the given session
2178 (ediff-update-session-marker-in-dir-meta-buffer
2180 (t ; update what changed only, but scan the entire meta buffer
2181 (ediff-update-markers-in-dir-meta-buffer ediff-meta-list)))
2182 (setq overl (ediff-get-meta-overlay-at-pos (point)))
2183 ;; skip the invisible sessions
2184 (while (and overl (ediff-overlay-get overl 'invisible))
2185 (ediff-next-meta-item1)
2186 (setq overl (ediff-get-meta-overlay-at-pos (point))))
2189 (defun ediff-update-registry ()
2190 (ediff-with-current-buffer (current-buffer)
2191 (if (ediff-buffer-live-p ediff-registry-buffer)
2192 (ediff-redraw-registry-buffer)
2193 (ediff-prepare-meta-buffer
2194 'ediff-registry-action
2195 ediff-session-registry
2197 'ediff-redraw-registry-buffer
2201 ;; If meta-buf exists, it is redrawn along with parent.
2202 ;; Otherwise, nothing happens.
2203 (defun ediff-cleanup-meta-buffer (meta-buffer)
2204 (if (ediff-buffer-live-p meta-buffer)
2205 (ediff-with-current-buffer meta-buffer
2206 (ediff-update-meta-buffer meta-buffer)
2207 (if (ediff-buffer-live-p ediff-parent-meta-buffer)
2208 (ediff-update-meta-buffer
2209 ediff-parent-meta-buffer nil ediff-meta-session-number)))))
2211 ;; t if no session is in progress
2212 (defun ediff-safe-to-quit (meta-buffer)
2213 (if (ediff-buffer-live-p meta-buffer)
2214 (let ((lis ediff-meta-list)
2217 ;;(ediff-update-meta-buffer meta-buffer)
2218 (ediff-with-current-buffer meta-buffer
2219 (setq lis (cdr lis)) ; discard the description part of meta-list
2220 (while (and cont lis)
2221 (if (ediff-buffer-live-p
2222 (ediff-get-group-buffer lis)) ; in progress
2224 (setq lis (cdr lis)))
2227 (defun ediff-quit-meta-buffer ()
2228 "If the group has no active session, delete the meta buffer.
2229 If no session is in progress, ask to confirm before deleting meta buffer.
2230 Otherwise, bury the meta buffer.
2231 If this is a session registry buffer then just bury it."
2233 (let* ((buf (current-buffer))
2234 (dir-diffs-buffer ediff-dir-diffs-buffer)
2235 (meta-diff-buffer ediff-meta-diff-buffer)
2236 (session-number ediff-meta-session-number)
2237 (parent-buf ediff-parent-meta-buffer)
2238 (dont-show-registry (eq buf ediff-registry-buffer)))
2239 (if dont-show-registry
2241 ;;(ediff-cleanup-meta-buffer buf)
2242 (cond ((and (ediff-safe-to-quit buf)
2243 (y-or-n-p "Quit this session group? "))
2244 (run-hooks 'ediff-quit-session-group-hook)
2246 (ediff-dispose-of-meta-buffer buf))
2247 ((ediff-safe-to-quit buf)
2251 "This session group has active sessions---cannot exit")))
2252 (ediff-update-meta-buffer parent-buf nil session-number)
2253 (ediff-kill-buffer-carefully dir-diffs-buffer)
2254 (ediff-kill-buffer-carefully meta-diff-buffer)
2255 (if (ediff-buffer-live-p parent-buf)
2257 (setq dont-show-registry t)
2258 (ediff-show-meta-buffer parent-buf session-number)))
2260 (or dont-show-registry
2261 (ediff-show-registry))))
2263 (defun ediff-dispose-of-meta-buffer (buf)
2264 (setq ediff-session-registry (delq buf ediff-session-registry))
2265 (ediff-with-current-buffer buf
2266 (if (ediff-buffer-live-p ediff-dir-diffs-buffer)
2267 (kill-buffer ediff-dir-diffs-buffer)))
2271 ;; Obtain information on a meta record where the user clicked or typed
2272 ;; BUF is the buffer where this happened and POINT is the position
2273 ;; If optional NOERROR arg is given, don't report error and return nil if no
2274 ;; meta info is found on line.
2275 (defun ediff-get-meta-info (buf point &optional noerror)
2276 (let (result olist tmp)
2277 (if (and point (ediff-buffer-live-p buf))
2278 (ediff-with-current-buffer buf
2279 (if (featurep 'xemacs)
2281 (if (setq tmp (extent-at point buf 'ediff-meta-info))
2282 (ediff-overlay-get tmp 'ediff-meta-info)))
2284 (mapcar (lambda (elt)
2285 (unless (overlay-get elt 'invisible)
2286 (overlay-get elt 'ediff-meta-info)))
2287 (overlays-at point)))
2288 (while (and olist (null (car olist)))
2289 (setq olist (cdr olist)))
2290 (setq result (car olist)))))
2293 (ediff-update-registry)
2294 (error "No session info in this line")))))
2297 (defun ediff-get-meta-overlay-at-pos (point)
2298 (if (featurep 'xemacs)
2299 (extent-at point (current-buffer) 'ediff-meta-info)
2300 (let* ((overl-list (overlays-at point))
2301 (overl (car overl-list)))
2302 (while (and overl (null (overlay-get overl 'ediff-meta-info)))
2303 (setq overl-list (cdr overl-list)
2304 overl (car overl-list)))
2307 (defun ediff-get-session-number-at-pos (point &optional meta-buffer)
2308 (setq meta-buffer (if (ediff-buffer-live-p meta-buffer)
2311 (ediff-with-current-buffer meta-buffer
2313 (ediff-get-meta-overlay-at-pos point) 'ediff-meta-session-number)))
2316 ;; Return location of the next meta overlay after point
2317 (defun ediff-next-meta-overlay-start (point)
2319 (goto-char (point-min))
2320 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2321 (if (featurep 'xemacs)
2324 (setq overl (next-extent overl))
2325 (setq overl (next-extent (current-buffer))))
2327 (extent-start-position overl)
2331 ;; note: end of current overlay is the beginning of the next one
2333 (next-overlay-change point))))))
2336 (defun ediff-previous-meta-overlay-start (point)
2338 (goto-char (point-max))
2339 (let ((overl (ediff-get-meta-overlay-at-pos point)))
2340 (if (featurep 'xemacs)
2343 (setq overl (previous-extent overl))
2344 (setq overl (previous-extent (current-buffer))))
2346 (extent-start-position overl)
2348 (if overl (setq point (overlay-start overl)))
2349 ;; to get to the beginning of prev overlay
2351 ;; trick to overcome an emacs bug--doesn't always find previous
2352 ;; overlay change correctly
2353 (setq point (1- point)))
2354 (setq point (previous-overlay-change point))
2355 ;; If we are not over an overlay after subtracting 1, it means we are
2356 ;; in the description area preceding session records. In this case,
2357 ;; goto the top of the registry buffer.
2358 (or (car (overlays-at point))
2359 (setq point (point-min)))
2362 ;; this is the action invoked when the user selects a patch from the meta
2364 (defun ediff-patch-file-form-meta (file &optional startup-hooks)
2365 (let* ((pos (ediff-event-point last-command-event))
2366 (meta-buf (ediff-event-buffer last-command-event))
2367 ;; ediff-get-meta-info gives error if meta-buf or pos are invalid
2368 (info (ediff-get-meta-info meta-buf pos))
2369 (meta-patchbuf ediff-meta-patchbufer)
2370 session-buf beg-marker end-marker)
2372 (if (or (file-directory-p file) (string-match "/dev/null" file))
2373 (error "`%s' is not an ordinary file" (file-name-as-directory file)))
2374 (setq session-buf (ediff-get-session-buffer info)
2375 beg-marker (ediff-get-session-objB-name info)
2376 end-marker (ediff-get-session-objC-name info))
2378 (or (ediff-buffer-live-p session-buf) ; either an active patch session
2379 (null session-buf) ; or it is a virgin session
2381 "Patch has already been applied to this file -- can't repeat!"))
2383 (ediff-with-current-buffer meta-patchbuf
2386 (narrow-to-region beg-marker end-marker)
2387 (ediff-patch-file-internal meta-patchbuf file startup-hooks)))))
2390 (defun ediff-unmark-all-for-operation ()
2391 "Unmark all sessions marked for operation."
2393 (let ((list (cdr ediff-meta-list))
2395 (while (setq elt (car list))
2396 (ediff-mark-session-for-operation elt 'unmark)
2397 (setq list (cdr list))))
2398 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2400 (defun ediff-unmark-all-for-hiding ()
2401 "Unmark all sessions marked for hiding."
2403 (let ((list (cdr ediff-meta-list))
2405 (while (setq elt (car list))
2406 (ediff-mark-session-for-hiding elt 'unmark)
2407 (setq list (cdr list))))
2408 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2411 ;; ACTION is ?h, ?m, ?=: to mark for hiding, mark for operation, or simply
2412 ;; indicate which are equal files
2413 (defun ediff-meta-mark-equal-files (&optional action)
2414 "Run through the session list and mark identical files.
2415 This is used only for sessions that involve 2 or 3 files at the same time.
2416 ACTION is an optional argument that can be ?h, ?m, ?=, to mark for hiding, mark
2417 for operation, or simply indicate which are equal files. If it is nil, then
2418 `(ediff-last-command-char)' is used to decide which action to take."
2421 (setq action (ediff-last-command-char)))
2422 (let ((list (cdr ediff-meta-list))
2423 marked1 marked2 marked3
2424 fileinfo1 fileinfo2 fileinfo3 elt)
2425 (message "Comparing files...")
2426 (while (setq elt (car list))
2427 (setq fileinfo1 (ediff-get-session-objA elt)
2428 fileinfo2 (ediff-get-session-objB elt)
2429 fileinfo3 (ediff-get-session-objC elt))
2430 (ediff-set-file-eqstatus fileinfo1 nil)
2431 (ediff-set-file-eqstatus fileinfo2 nil)
2432 (ediff-set-file-eqstatus fileinfo3 nil)
2437 (or (ediff-mark-if-equal fileinfo1 fileinfo2)
2439 (if (ediff-metajob3)
2441 (or (ediff-mark-if-equal fileinfo1 fileinfo3)
2443 (or (ediff-mark-if-equal fileinfo2 fileinfo3)
2444 (setq marked3 nil))))
2445 (if (and marked1 marked2 marked3)
2446 (cond ((eq action ?h)
2447 (ediff-mark-session-for-hiding elt 'mark))
2449 (ediff-mark-session-for-operation elt 'mark))
2451 (setq list (cdr list)))
2452 (message "Comparing files... Done"))
2453 (setq ediff-recurse-to-subdirectories nil)
2454 (ediff-update-meta-buffer (current-buffer) 'must-redraw))
2456 ;; mark files 1 and 2 as equal, if they are.
2457 ;; returns t, if something was marked
2458 (defun ediff-mark-if-equal (fileinfo1 fileinfo2)
2459 (let ((f1 (car fileinfo1))
2460 (f2 (car fileinfo2)))
2461 (if (and (stringp f1) (stringp f2) (ediff-same-contents f1 f2))
2463 (ediff-set-file-eqstatus fileinfo1 t)
2464 (ediff-set-file-eqstatus fileinfo2 t)
2471 ;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
2472 ;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
2473 ;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
2476 ;;; ediff-mult.el ends here