| blob | d84812a2032fc5e67e51d689ac65c0e57fc6d2c7 |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; Author: Dale R. Worley <drw@math.mit.edu>
6 ;; Version: 5fsf
7 ;; Keywords: unix, tools
9 ;; This software was created by Dale R. Worley and is
10 ;; distributed free of charge. It is placed in the public domain and
11 ;; permission is granted to anyone to use, duplicate, modify and redistribute
12 ;; it provided that this notice is attached.
14 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
15 ;; with respect to this software. The entire risk as to the quality and
16 ;; performance of this software is with the user. IN NO EVENT WILL DALE
17 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
18 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
19 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
20 ;; DAMAGES.
22 ;;; Code:
24 ;;; Macros
27 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
28 Differs from `save-excursion' in that it doesn't save the point and mark."
37 "Defines SYMBOL as an advertised variable.
38 Performs a defvar, then executes `make-variable-buffer-local' on
39 the variable. Also sets the `preserved' property, so that
40 `kill-all-local-variables' (called by major-mode setting commands)
41 won't destroy Emerge control variables."
47 ;; Add entries to minor-mode-alist so that emerge modes show correctly
55 minor-mode-alist)))
57 ;; We need to define this function so describe-mode can describe Emerge mode.
59 "Emerge mode is used by the Emerge file-merging package.
60 It is entered only through one of the functions:
61 `emerge-files'
62 `emerge-files-with-ancestor'
63 `emerge-buffers'
64 `emerge-buffers-with-ancestor'
65 `emerge-files-command'
66 `emerge-files-with-ancestor-command'
67 `emerge-files-remote'
68 `emerge-files-with-ancestor-remote'
70 Commands:
79 "Return string describing the version of Emerge.
80 When called interactively, displays the version."
84 emerge-version))
86 ;;; Emerge configuration variables
88 ;; Commands that produce difference files
89 ;; All that can be configured is the name of the programs to execute
90 ;; (emerge-diff-program and emerge-diff3-program) and the options
91 ;; to be provided (emerge-diff-options). The order in which the file names
92 ;; are given is fixed.
93 ;; The file names are always expanded (see expand-file-name) before being
94 ;; passed to diff, thus they need not be invoked under a shell that
95 ;; understands `~'.
96 ;; The code which processes the diff/diff3 output depends on all the
97 ;; finicky details of their output, including the somewhat strange
98 ;; way they number lines of a file.
102 "*Name of the program which compares three files.
108 "*Pattern to match lines produced by diff that describe differences.
112 "*Regexp that matches normal output lines from `emerge-diff-program'.
116 "*Regexp that matches normal output lines from `emerge-diff3-program'.
125 "*Non-nil if Emerge should process local-variables lists in merge buffers.
126 \(You can explicitly request processing the local-variables
129 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
130 It concludes that an input version has been deleted when an ancestor entry
131 is present, only one A or B entry is present, and an output entry is present.
132 If nil: In such circumstances, the A or B file that is present will be
135 ;; Hook variables
140 "*Hook to run after a difference has been selected.
143 "*Hook to run after a difference has been unselected.
146 ;; Variables to control the default directories of the arguments to
147 ;; Emerge commands.
150 "*If nil, default dir for filenames in emerge is `default-directory'.
151 If non-nil, filenames complete in the directory of the last argument of the
169 ;; The flags used to mark differences in the buffers.
171 ;; These function definitions need to be up here, because they are used
172 ;; during loading.
174 "Function to be called after `emerge-{before,after}-flag'.
175 This is called after these functions are changed to compute values that
176 depend on the flags."
187 "Return the number of matches in STRING for REGEXP."
193 count))
196 "*Flag placed above the highlighted block of code. Must end with newline.
197 Must be set before Emerge is loaded, or emerge-new-flags must be run
200 "*Flag placed below the highlighted block of code. Must end with newline.
201 Must be set before Emerge is loaded, or emerge-new-flags must be run
204 ;; Calculate dependent variables
208 "*Number of lines that we want to show above and below the flags when we are
213 d)
215 env
220 "*Prefix to put on Emerge temporary file names.
228 "*Template for `emerge-combine-versions' to combine the two versions.
229 The template is inserted as a string, with the following interpolations:
230 %a the A version of the difference
231 %b the B version of the difference
232 %% the character `%'
233 Don't forget to end the template with a newline.
234 Note that this variable can be made local to a particular merge buffer by
237 ;; Build keymaps
240 "Keymap of Emerge commands.
241 Directly available in `fast' mode;
245 "Local keymap used in Emerge `fast' mode.
249 "*Command prefix for Emerge commands in `edit' mode.
252 ;; This function sets up the fixed keymaps. It is executed when the first
253 ;; Emerge is done to allow the user maximum time to set up the global keymap.
255 ;; Set up the basic keymap
258 ; - to negative-argument
299 ;; Allow emerge-basic-keymap to be referenced indirectly
301 ;; Set up the fast mode keymap
303 ;; Allow prefixed commands to work in fast mode
305 ;; Allow emerge-fast-keymap to be referenced indirectly
307 ;; Suppress write-file and save-buffer
313 ;; Variables which control each merge. They are local to the merge buffer.
315 ;; Mode variables
329 "The buffer in which the ancestor variant is stored,
334 buffer-read-only
335 buffer-auto-save-file-name)
336 "Variables and properties of a buffer which are saved, modified and restored
347 "Vector of differences between the variants, and markers in the buffers to
348 show where they are. Each difference is represented by a vector of seven
349 elements. The first two are markers to the beginning and end of the difference
350 section in the A buffer, the second two are markers for the B buffer, the third
352 that difference in the merge buffer.
353 A section of a buffer is described by two markers, one to the beginning of
354 the first line of the section, and one to the beginning of the first line
355 after the section. (If the section is empty, both markers point to the same
356 point.) If the section is part of the selected difference, then the markers
357 are moved into the flags, so the user can edit the section without disturbing
358 the markers.
360 A the merge buffer currently contains the A variant
361 B the merge buffer currently contains the B variant
362 default-A the merge buffer contains the A variant by default,
363 but this difference hasn't been selected yet, so
364 change-default commands can alter it
365 default-B the merge buffer contains the B variant by default,
366 but this difference hasn't been selected yet, so
367 change-default commands can alter it
368 prefer-A in a three-file merge, the A variant is the preferred
369 choice
370 prefer-B in a three-file merge, the B variant is the preferred
377 "The local keymap for the merge buffer, with the emerge commands defined in
378 it. Used to save the local keymap during fast mode, when the local keymap is
383 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
386 "*If non-nil, differences for which there is a preference are automatically
389 "Hooks to run in the merge buffer after the merge has been finished.
390 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
391 command.
396 ;;; Setup functions for two-file mode.
399 output-file)
406 ;; Record the directories of the files
411 ;; Make sure the entire files are seen, and they reflect what is on disk
413 buffer-A
418 startup-hooks
420 startup-hooks))
421 ;; Verify that the file matches the buffer
424 buffer-B
429 startup-hooks
431 startup-hooks))
432 ;; Verify that the file matches the buffer
435 output-file)))
437 ;; Start up Emerge on two files
439 output-file)
444 ;; create the merge buffer from buffer A, so it inherits buffer A's
445 ;; default directory, etc.
447 buffer-A
450 merge-buffer
476 ;; Generate the Emerge difference list between two files
480 emerge-diff-buffer
484 emerge-diff-program emerge-diff-options
487 t))
490 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
496 diff-buffer
505 a-begin)))
513 b-begin))))
514 ;; fix the beginning and end numbers, because diff is somewhat
515 ;; strange about how it numbers lines
526 ;; (string-equal diff-type "c")
531 b-begin b-end
533 list)))))
536 ;; Set up buffer of diff/diff3 error messages.
540 emerge-diff-error-buffer
545 ;;; Top-level and setup functions for three-file mode.
548 &optional startup-hooks quit-hooks
549 output-file)
559 ;; Record the directories of the files
565 ;; Make sure the entire files are seen, and they reflect what is on disk
567 buffer-A
572 startup-hooks
574 startup-hooks))
575 ;; Verify that the file matches the buffer
578 buffer-B
583 startup-hooks
585 startup-hooks))
586 ;; Verify that the file matches the buffer
589 buffer-ancestor
594 startup-hooks
596 startup-hooks))
597 ;; Verify that the file matches the buffer
600 buffer-ancestor file-ancestor
601 startup-hooks quit-hooks output-file)))
603 ;; Start up Emerge on two files with an ancestor
605 buffer-ancestor file-ancestor
606 &optional startup-hooks quit-hooks
607 output-file)
613 ;; create the merge buffer from buffer A, so it inherits buffer A's
614 ;; default directory, etc.
616 buffer-A
619 merge-buffer
647 ;; Generate the Emerge difference list between two files with an ancestor
651 emerge-diff-buffer
655 emerge-diff3-program emerge-diff-options
659 t))
662 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
668 diff-buffer
670 ;; leave point after matched line
673 ;; if the A and B files are the same, ignore the difference
687 list))))))
691 ;; This save-excursion allows emerge-get-diff3-group to be called for the
692 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
693 ;; appear in any order. The reason this is necessary is that Gnu diff3
694 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
699 ;; treatment depends on whether it is an "a" group or a "c" group
701 ;; it is a "c" group
703 ;; it has two numbers
708 ;; it has one number
712 ;; it is an "a" group
717 ;;; Functions to start Emerge on files
719 ;;;###autoload
721 quit-hooks)
722 "Run Emerge on two files."
727 nil nil))
731 f f)))))
733 file-A file-B startup-hooks
736 quit-hooks)
737 quit-hooks)
738 file-out))
740 ;;;###autoload
743 "Run Emerge on two files, giving another file as the ancestor."
748 nil nil))
751 nil f)
754 f f)))))
756 file-A file-B file-ancestor startup-hooks
759 quit-hooks)
760 quit-hooks)
761 file-out))
763 ;; Write the merge buffer out in place of the file the A buffer is visiting.
765 ;; if merge was successful was given, save to disk
769 ;;; Functions to start Emerge on buffers
771 ;;;###autoload
773 "Run Emerge on two buffers."
778 buffer-A
781 buffer-B
788 startup-hooks)
789 quit-hooks
790 nil)))
792 ;;;###autoload
794 &optional startup-hooks
795 quit-hooks)
796 "Run Emerge on two buffers, giving another buffer as the ancestor."
803 buffer-A
806 buffer-B
809 buffer-ancestor
815 emerge-file-ancestor
821 startup-hooks)
822 quit-hooks
823 nil)))
825 ;;; Functions to start Emerge from the command line
827 ;;;###autoload
834 file-a file-b nil
837 ;;;###autoload
840 ;; check for a -a flag, for filemerge compatibility
842 ;; arguments are "-a ancestor file-a file-b file-out"
849 ;; arguments are "file-a file-b ancestor file-out"
856 file-a file-b file-anc nil
863 ;;; Functions to start Emerge via remote request
865 ;;;###autoload
869 file-a file-b nil
871 file-out)
874 ;;;###autoload
878 file-a file-b file-anc nil
880 file-out)
888 ;;; Functions to start Emerge on RCS versions
892 "Emerge two RCS revisions of a file."
899 emerge-last-revision-B revision-B)
901 file revision-A revision-B startup-hooks
906 quit-hooks)
907 quit-hooks)))
910 revision-B ancestor
911 &optional
912 startup-hooks quit-hooks)
913 "Emerge two RCS revisions of a file, with another revision as ancestor."
921 emerge-last-revision-B revision-B
922 emerge-last-revision-ancestor ancestor)
924 file revision-A revision-B ancestor startup-hooks
930 quit-hooks))
931 quit-hooks)))
934 startup-hooks quit-hooks output-file)
939 ;; Get the revisions into buffers
941 buffer-A
945 t)
949 buffer-B
953 t)
956 ;; Do the merge
958 buffer-B emerge-file-B
962 startup-hooks)
964 quit-hooks)
965 nil)))
968 ancestor
969 &optional startup-hooks
970 quit-hooks output-file)
977 ;; Get the revisions into buffers
979 buffer-A
983 revision-A file)
984 t)
988 buffer-B
992 t)
996 buffer-ancestor
1000 t)
1003 ;; Do the merge
1005 buffer-A emerge-file-A buffer-B emerge-file-B
1006 buffer-ancestor emerge-ancestor
1011 startup-hooks)
1013 quit-hooks)
1014 output-file)))
1016 ;;; Function to start Emerge based on a line in a file
1019 "Run Emerge using files named in current text line.
1020 Looks in that line for whitespace-separated entries of these forms:
1021 a=file1
1022 b=file2
1023 ancestor=file3
1024 output=file4
1025 to specify the files to use in Emerge.
1027 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1028 is present:
1029 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1030 it is assumed that the file in question has been deleted, and it is
1031 not copied to the output file.
1032 Otherwise, the A or B file present is copied to the output file."
1036 ;; Stop if at end of buffer (even though we might be in a line, if
1037 ;; the line does not end with newline)
1040 ;; Go to the beginning of the line
1042 ;; Skip any initial whitespace
1045 ;; Process the entire line
1047 ;; Get the next entry
1049 ;; Break apart the tab (before =) and the filename (after =)
1053 ;; Move point after the entry
1055 ;; Store the filename in the right variable
1075 ;; If the match on the entry pattern failed
1077 ;; Make sure that file-A and file-B are present
1082 ;; Go to the beginning of the next line, so next execution will use
1083 ;; next line in buffer.
1085 ;; Execute the correct command
1087 ;; Merge of two files with ancestor
1091 file-ancestor file-out
1092 nil
1093 ;; When done, return to this buffer.
1098 ;; Merge of two files without ancestor
1102 nil
1103 ;; When done, return to this buffer.
1108 ;; There is an output file (or there would have been an error above),
1109 ;; but only one input file.
1110 ;; The file appears to have been deleted in one version; do nothing.
1113 ;; The file should be copied from the version that contains it
1119 ;;; Sample function for creating information for emerge-execute-line
1131 ;; Check that we're not on a line
1134 ;; Turn null strings into nil to indicate directories not used.
1139 ;; Canonicalize the directory names
1156 ;; Set the mark to where we start
1158 ;; Find out what files are in the directories.
1166 emerge-merge-directories-filename-regexp)))
1171 ;; Remove duplicates from all-files.
1177 ;; Generate the control lines for the various files.
1198 ;;; Common setup routines
1200 ;; Set up the window configuration. If POS is given, set the points to
1201 ;; the beginnings of the buffers.
1203 ;; Make sure we are not in the minibuffer window when we try to delete
1204 ;; all other windows.
1222 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1230 ;; Set up the keymap in the merge buffer
1232 ;; Set up fixed keymaps if necessary
1235 ;; Save the old local map
1237 ;; Construct the edit keymap
1241 ;; Install the Emerge commands
1244 ;; Suppress write-file and save-buffer
1246 'emerge-query-write-file
1247 emerge-edit-keymap)
1249 'emerge-query-save-buffer
1250 emerge-edit-keymap)
1260 "Record certain properties of the buffers being merged.
1261 Must be called in the merge buffer. Remembers read-only, modified,
1262 auto-save, and saves them in buffer local variables. Sets the buffers
1263 read-only and turns off `auto-save-mode'.
1264 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1265 ;; force auto-save, because we will turn off auto-saving in buffers for the
1266 ;; duration
1268 ;; remember and alter buffer characteristics
1271 emerge-A-buffer
1275 emerge-merging-values))))
1278 emerge-B-buffer
1282 emerge-merging-values)))))
1285 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1290 A-values))
1293 B-values))))
1296 B-buffer
1297 merge-buffer
1298 lineno-list)
1303 A-buffer
1309 B-buffer
1315 a-begin-marker
1316 a-end-marker
1317 b-begin-marker
1318 b-end-marker
1319 merge-begin-marker
1320 merge-end-marker
1326 ;; place markers at the appropriate places in the buffers
1328 A-buffer
1334 B-buffer
1342 offset)
1343 merge-buffer))
1347 offset)
1348 merge-buffer))
1349 ;; record all the markers for this difference
1351 b-begin-marker b-end-marker
1352 merge-begin-marker merge-end-marker
1353 state)
1354 marker-list)))
1356 ;; convert the list of difference information into a vector for
1357 ;; fast access
1360 ;; If we have an ancestor, select all B variants that we prefer
1372 ;; Process the local-variables list at the end of the merged file, if
1373 ;; requested.
1381 ;;; Common exit routines
1384 ;; clear screen format
1386 ;; delete A, B, and ancestor buffers, if they haven't been changed
1394 ;; Write merge buffer to file
1398 ;;; Commands
1401 "Bring the highlighted region of all three merge buffers into view.
1402 This brings the buffers into view if they are in windows.
1403 With an argument, reestablish the default three-window display."
1405 ;; If there is an argument, rebuild the window structure
1408 emerge-merge-buffer))
1409 ;; Redisplay whatever buffers are showing, if there is a selected difference
1445 ;;; Window scrolling operations
1446 ;; These operations are designed to scroll all three windows the same amount,
1447 ;; so as to keep the text in them aligned.
1449 ;; Perform some operation on all three windows (if they are showing).
1450 ;; Catches all errors on the operation in the A and B windows, but not
1451 ;; in the merge window. Usually, errors come from scrolling off the
1452 ;; beginning or end of the buffer, and this gives a nice error message:
1453 ;; End of buffer is reported in the merge buffer, but if the scroll was
1454 ;; possible in the A or B windows, it is performed there before the error
1455 ;; is reported.
1478 "Scroll up all three merge buffers, if they are in windows.
1479 With argument N, scroll N lines; otherwise scroll by nearly
1480 the height of the merge window.
1481 `C-u -' alone as argument scrolls half the height of the merge window."
1484 'scroll-up
1485 ;; calculate argument to scroll-up
1486 ;; if there is an explicit argument
1488 ;; use it
1490 ;; if not, see if we can determine a default amount (the window height)
1493 ;; no window, use nil
1494 nil
1497 ;; the window was found
1499 ;; C-u as argument means half of default amount
1501 ;; no argument means default amount
1502 default-amount)))))))
1505 "Scroll down all three merge buffers, if they are in windows.
1506 With argument N, scroll N lines; otherwise scroll by nearly
1507 the height of the merge window.
1508 `C-u -' alone as argument scrolls half the height of the merge window."
1511 'scroll-down
1512 ;; calculate argument to scroll-down
1513 ;; if there is an explicit argument
1515 ;; use it
1517 ;; if not, see if we can determine a default amount (the window height)
1520 ;; no window, use nil
1521 nil
1524 ;; the window was found
1526 ;; C-u as argument means half of default amount
1528 ;; no argument means default amount
1529 default-amount)))))))
1532 "Scroll left all three merge buffers, if they are in windows.
1533 If an argument is given, that is how many columns are scrolled, else nearly
1534 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1535 width of the A and B windows."
1538 'scroll-left
1539 ;; calculate argument to scroll-left
1540 ;; if there is an explicit argument
1542 ;; use it
1544 ;; if not, see if we can determine a default amount
1545 ;; (half the window width)
1548 ;; no window, use nil
1549 nil
1552 ;; the window was found
1554 ;; C-u as argument means half of default amount
1556 ;; no argument means default amount
1557 default-amount)))))))
1560 "Scroll right all three merge buffers, if they are in windows.
1561 If an argument is given, that is how many columns are scrolled, else nearly
1562 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1563 width of the A and B windows."
1566 'scroll-right
1567 ;; calculate argument to scroll-right
1568 ;; if there is an explicit argument
1570 ;; use it
1572 ;; if not, see if we can determine a default amount
1573 ;; (half the window width)
1576 ;; no window, use nil
1577 nil
1580 ;; the window was found
1582 ;; C-u as argument means half of default amount
1584 ;; no argument means default amount
1585 default-amount)))))))
1588 "Reset horizontal scrolling in Emerge.
1589 This resets the horizontal scrolling of all three merge buffers
1590 to the left margin, if they are in windows."
1594 nil))
1596 ;; Attempt to show the region nicely.
1597 ;; If there are min-lines lines above and below the region, then don't do
1598 ;; anything.
1599 ;; If not, recenter the region to make it so.
1600 ;; If that isn't possible, remove context lines balancedly from top and botton
1601 ;; so the entire region shows.
1602 ;; If that isn't possible, show the top of the region.
1603 ;; BEG must be at the beginning of a line.
1605 ;; First test whether the entire region is visible with
1606 ;; emerge-min-visible-lines above and below it
1610 beg)
1615 ;; We failed that test, see if it fits at all
1616 ;; Meanwhile positioning it correctly in case it doesn't fit
1620 ;; Determine the number of lines that the region occupies
1626 ;; And position the beginning on the right line
1629 lines))
1634 "Advance to the next difference."
1648 "Go to the previous difference."
1662 "Go to the N-th difference."
1672 "Abort the Emerge session."
1677 "Finish the Emerge session and exit Emerge.
1678 Prefix argument means to abort rather than successfully finish.
1679 The difference depends on how the merge was started,
1680 but usually means to not write over one of the original files, or to signal
1681 to some process which invoked Emerge a failure code.
1683 Unselects the selected difference, if any, restores the read-only and modified
1684 flags of the merged file buffers, restores the local keymap of the merge
1685 buffer, and sets off various emerge flags. Using Emerge commands in this
1686 buffer after this will cause serious problems."
1691 "Do you really want to successfully finish this merge? "
1696 ;; Perform the quit operations.
1701 ;; null out the difference markers so they don't slow down future editing
1702 ;; operations
1710 emerge-difference-list)
1711 ;; allow them to be garbage collected
1713 ;; restore the local map
1715 ;; turn off all the emerge modes
1721 ;; restore mode line
1727 "Select the A variant of this difference.
1728 Refuses to function if this difference has been edited, i.e., if it
1729 is neither the A nor the B variant.
1730 A prefix argument forces the variant to be selected
1731 even if the difference has been edited."
1744 ;; Actually select the A variant
1747 emerge-merge-buffer
1756 "Select the B variant of this difference.
1757 Refuses to function if this difference has been edited, i.e., if it
1758 is neither the A nor the B variant.
1759 A prefix argument forces the variant to be selected
1760 even if the difference has been edited."
1773 ;; Actually select the B variant
1776 emerge-merge-buffer
1785 "Make the A variant the default from here down.
1786 This selects the A variant for all differences from here down in the buffer
1787 which are still defaulted, i.e., which the user has not selected and for
1788 which there is no preference."
1807 "Make the B variant the default from here down.
1808 This selects the B variant for all differences from here down in the buffer
1809 which are still defaulted, i.e., which the user has not selected and for
1810 which there is no preference."
1829 "Set fast mode, for Emerge.
1830 In this mode ordinary Emacs commands are disabled, and Emerge commands
1839 ;; force mode line redisplay
1843 "Set edit mode, for Emerge.
1844 In this mode ordinary Emacs commands are available, and Emerge commands
1853 ;; force mode line redisplay
1857 "Toggle Auto-Advance mode, for Emerge.
1858 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
1859 advance to the next difference.
1860 With a positive argument, turn on Auto-Advance mode.
1861 With a negative argument, turn off Auto-Advance mode."
1867 "Auto-advance set"
1869 ;; force mode line redisplay
1873 "Toggle Skip-Prefers mode, for Emerge.
1874 This mode causes `emerge-next-difference' and `emerge-previous-difference'
1875 to automatically skip over differences for which there is a preference.
1876 With a positive argument, turn on Skip-Prefers mode.
1877 With a negative argument, turn off Skip-Prefers mode."
1883 "Skip-prefers set"
1885 ;; force mode line redisplay
1889 "Put the A variant of this difference in the kill ring."
1896 ;; so further kills don't append
1897 this-command)
1903 "Put the B variant of this difference in the kill ring."
1910 ;; so further kills don't append
1911 this-command)
1917 "Insert the A variant of this difference at the point.
1918 Leaves point after text, mark before.
1919 With prefix argument, puts point before, mark after."
1935 "Insert the B variant of this difference at the point.
1936 Leaves point after text, mark before.
1937 With prefix argument, puts point before, mark after."
1953 "Leaves the point before this difference and the mark after it.
1954 With prefix argument, puts mark before, point after."
1969 "Show the names of the buffers or files being operated on by Emerge.
1970 Use C-u l to reset the windows afterward."
2010 "Join the selected difference with the following one.
2011 With a prefix argument, join with the preceding one."
2014 ;; adjust n to be first difference to join
2017 ;; n and n+1 are the differences to join
2018 ;; check that they are both differences
2021 ;; remove the flags
2023 ;; decrement total number of differences
2025 ;; build new differences vector
2045 ps)
2052 ;; set the current difference correctly
2054 ;; fix the mode line
2056 ;; reinsert the flags
2061 "Split the current difference where the points are in the three windows."
2064 ;; check that this is a valid difference
2066 ;; get the point values and old difference
2073 ;; check location of the points, give error if they aren't in the
2074 ;; differences
2084 ;; remove the flags
2086 ;; increment total number of differences
2088 ;; build new differences vector
2100 A-point
2102 B-point
2104 merge-point
2116 ;; set the current difference correctly
2118 ;; fix the mode line
2120 ;; reinsert the flags
2125 "Trim lines off top and bottom of difference that are the same.
2126 If lines are the same in both the A and the B versions, strip them off.
2127 \(This can happen when the A and B versions have common lines that the
2128 ancestor version does not share.)"
2130 ;; make sure we are in a real difference
2132 ;; remove the flags
2141 size success sa sb sm)
2142 ;; move down the tops of the difference regions as much as possible
2143 ;; Try advancing comparing 1000 chars at a time.
2144 ;; When that fails, go 500 chars at a time, and so on.
2164 ;; move up the bottoms of the difference regions as much as possible
2165 ;; Try advancing comparing 1000 chars at a time.
2166 ;; When that fails, go 500 chars at a time, and so on.
2175 bottom-a)))
2178 bottom-b)))
2186 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2187 ;; of the difference regions. Move them to the beginning of lines, as
2188 ;; appropriate.
2209 ;; put the flags back in, recenter the display
2214 "Find the difference containing the current position of the point.
2215 If there is no containing difference and the prefix argument is positive,
2216 it finds the nearest following difference. A negative prefix argument finds
2217 the nearest previous difference."
2225 "Find the difference containing point, in the merge buffer.
2226 If there is no containing difference and the prefix argument is positive,
2227 it finds the nearest following difference. A negative prefix argument finds
2228 the nearest previous difference."
2230 ;; search for the point in the merge buffer, using the markers
2231 ;; for the beginning and end of the differences in the merge buffer
2235 "Find the difference containing point, in the A buffer.
2236 This command must be executed in the merge buffer.
2237 If there is no containing difference and the prefix argument is positive,
2238 it finds the nearest following difference. A negative prefix argument finds
2239 the nearest previous difference."
2241 ;; search for the point in the A buffer, using the markers
2242 ;; for the beginning and end of the differences in the A buffer
2248 "Find the difference containing point, in the B buffer.
2249 This command must be executed in the merge buffer.
2250 If there is no containing difference and the prefix argument is positive,
2251 it finds the nearest following difference. A negative prefix argument finds
2252 the nearest previous difference."
2254 ;; search for the point in the B buffer, using the markers
2255 ;; for the beginning and end of the differences in the B buffer
2262 ;; find first difference containing or after the current position
2270 emerge-number-of-differences))
2272 ;; whether the found difference contains the current position
2275 begin))
2276 location)))
2278 ;; numeric value of prefix argument
2282 ;; if the point is in a difference, select it
2284 ;; if the arg is nil and the point is not in a difference, error
2286 ;; if the arg is positive, select the following difference
2289 index
2291 ;; if the arg is negative, select the preceding difference
2298 "Display the current line numbers.
2299 This function displays the line numbers of the points in the A, B, and
2300 merge buffers."
2313 merge-line A-line B-line)))
2326 temp))
2329 "Copy region into `emerge-combine-versions-template'.
2330 This controls how `emerge-combine-versions' will combine the two versions.
2331 With prefix argument, `emerge-combine-versions' is made local to this
2332 merge buffer. Localization is permanent for any particular merge buffer."
2339 "emerge-set-combine-versions-template set locally."
2343 "Combine versions using the template in `emerge-combine-versions-template'.
2344 Refuses to function if this difference has been edited, i.e., if it is
2345 neither the A nor the B variant.
2346 An argument forces the variant to be selected even if the difference has
2347 been edited."
2352 "Combine the two versions using the template in register REG.
2353 See documentation of the variable `emerge-combine-versions-template'
2354 for how the template is interpreted.
2355 Refuses to function if this difference has been edited, i.e., if it is
2356 neither the A nor the B variant.
2357 An argument forces the variant to be selected even if the difference has
2358 been edited."
2369 A-begin A-end B-begin B-end)
2375 A-begin A-end B-begin B-end)
2377 emerge-merge-buffer
2405 "Set the major mode in a merge buffer.
2406 Overrides any change that the mode might make to the mode line or local
2407 keymap. Leaves merge in fast mode."
2422 ;;; Support routines
2424 ;; Select a difference by placing the visual flags around the appropriate
2425 ;; group of lines in the A, B, and merge buffers
2435 after-index)
2438 buffer
2444 ;; insert the flag before the difference
2446 before-index))
2447 here)
2449 ;; insert the flag itself
2452 ;; Put the marker(s) referring to this position 1 character before the
2453 ;; end of the flag, so it won't be damaged by the user.
2454 ;; This gets a bit tricky, as there could be a number of markers
2455 ;; that have to be moved.
2469 ;; insert the flag after the difference
2471 after-index))
2474 ;; insert the flag itself
2476 ;; Put the marker(s) referring to this position 1 character after the
2477 ;; beginning of the flag, so it won't be damaged by the user.
2478 ;; This gets a bit tricky, as there could be a number of markers
2479 ;; that have to be moved.
2494 ;; Unselect a difference by removing the visual flags in the buffers.
2507 buffer
2509 ;; remove the flags, if they're there
2513 ;; the flag isn't there
2519 ;; the flag isn't there
2523 ;; Select a difference, removing any flags that exist now.
2543 ;; Perform tests to see whether user should be allowed to select a version
2544 ;; of this difference:
2545 ;; a valid difference has been selected; and
2546 ;; the difference text in the merge buffer is:
2547 ;; the A version (execute a-version), or
2548 ;; the B version (execute b-version), or
2549 ;; empty (execute neither-version), or
2550 ;; argument FORCE is true (execute neither-version)
2551 ;; Otherwise, signal an error.
2564 emerge-merge-buffer merge-begin
2565 merge-end)
2568 emerge-merge-buffer merge-begin
2569 merge-end)
2575 ;; Read a file name, handling all of the various defaulting rules.
2578 A-file)
2579 ;; `prompt' should not have trailing ": ", so that it can be modified
2580 ;; according to context.
2581 ;; If alternative-default-dir is non-nil, it should be used as the default
2582 ;; directory instead if default-directory, if emerge-default-last-directories
2583 ;; is set.
2584 ;; If default-file is set, it should be used as the default value.
2585 ;; If A-file is set, and its directory is different from
2586 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2587 ;; the default file should be the last part of A-file in the default
2588 ;; directory. (Overriding default-file.)
2590 ;; If this is not the A-file argument (shown by non-nil A-file), and
2591 ;; if emerge-default-last-directories is set, and
2592 ;; the default directory exists but is not the same as the directory of the
2593 ;; A-file,
2594 ;; then make the default file have the same name as the A-file, but in
2595 ;; the default directory.
2597 A-file
2598 alternative-default-dir
2603 alternative-default-dir
2607 ;; If there is a default file, use it.
2610 ;; If emerge-default-last-directories is set, use the
2611 ;; directory from the same argument of the last call of
2612 ;; Emerge as the default for this argument.
2614 alternative-default-dir)
2618 ;; If emerge-default-last-directories is set, use the
2619 ;; directory from the same argument of the last call of
2620 ;; Emerge as the default for this argument.
2622 alternative-default-dir)
2625 ;; Revise the mode line to display which difference we have selected
2631 emerge-number-of-differences
2633 (< emerge-current-difference
2634 emerge-number-of-differences))
2636 emerge-current-difference)
2644 ;; Force mode-line redisplay
2647 ;; compare two regions in two buffers for containing the same text
2649 ;; first check that the two regions are the same length
2651 nil
2654 ;; bite off and compare no more than 1000 characters at a time
2657 buffer-x
2661 buffer-y
2668 t)))
2670 ;; Construct a unique buffer name.
2671 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2672 ;; prefix<3>suffix, etc.
2681 ;; Verify that we have a difference selected.
2687 ;;; Functions for saving and restoring a batch of variables
2689 ;; These functions save (get the values of) and restore (set the values of)
2690 ;; a list of variables. The argument is a list of symbols (the names of
2691 ;; the variables). A list element can also be a list of two functions,
2692 ;; the first of which (when called with no arguments) gets the value, and
2693 ;; the second (when called with a value as an argment) sets the value.
2694 ;; A "function" is anything that funcall can handle as an argument.
2700 vars))
2712 ;; Make a temporary file that only we have access to.
2713 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2716 ;; create the file
2719 f))
2721 ;;; Functions that query the user before he can write out the current buffer.
2724 "Ask the user whether to write out an incomplete merge.
2725 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2726 for details of the querying process."
2731 "Ask the user whether to save an incomplete merge.
2732 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2733 for details of the querying process."
2738 "Ask the user whether to save or write out the incomplete merge.
2739 If answer is yes, call COMMAND interactively. During the call, the flags
2740 around the current difference are removed."
2742 ;; He really wants to do it -- unselect the difference for the duration
2747 ;; call-interactively takes the value of current-prefix-arg as the
2748 ;; prefix argument value to be passed to the command. Thus, we have
2749 ;; to do nothing special to make sure the prefix argument is
2750 ;; transmitted to the command.
2757 ;; He's being smart and not doing it
2760 ;; Make sure the current buffer (for a file) has the same contents as the
2761 ;; file on disk, and attempt to remedy the situation if not.
2762 ;; Signal an error if we can't make them the same, or the user doesn't want
2763 ;; to do what is necessary to make them the same.
2765 ;; First check if the file has been modified since the buffer visited it.
2768 ;; If buffer is not obsolete and is modified, offer to save
2772 ;; If buffer is not obsolete and is not modified, do nothing
2773 nil)
2775 ;; If buffer is obsolete and is modified, give error
2777 ;; If buffer is obsolete and is not modified, offer to revert
2781 \f
2782 ;; Utilities that might have value outside of Emerge.
2784 ;; Set up the mode in the current buffer to duplicate the mode in another
2785 ;; buffer.
2787 ;; Set the major mode
2790 ;; Define a key, even if a prefix of it is defined
2792 "Like `define-key', but forcibly creates prefix characters as needed.
2793 If some prefix of KEY has a non-prefix definition, it is redefined."
2794 ;; Find out if a prefix of key is defined
2796 ;; If so, undefine it
2799 ;; Now define the key
2802 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2803 ;;;;; as the major mode
2804 ;;(defun describe-mode (&optional minor)
2805 ;; "Display documentation of current major mode.
2806 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2807 ;;display documentation of active minor modes as well.
2808 ;;For this to work correctly for a minor mode, the mode's indicator variable
2809 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2810 ;;describes the minor mode."
2811 ;; (interactive)
2812 ;; (with-output-to-temp-buffer "*Help*"
2813 ;; (princ mode-name)
2814 ;; (princ " Mode:\n")
2815 ;; (princ (documentation major-mode))
2816 ;; (let ((minor-modes minor-mode-alist)
2817 ;; (locals (buffer-local-variables)))
2818 ;; (while minor-modes
2819 ;; (let* ((minor-mode (car (car minor-modes)))
2820 ;; (indicator (car (cdr (car minor-modes))))
2821 ;; (local-binding (assq minor-mode locals)))
2822 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2823 ;; ;; bound locally in this buffer, non-nil, and has a function
2824 ;; ;; definition.
2825 ;; (if (and local-binding
2826 ;; (cdr local-binding)
2827 ;; (fboundp minor-mode))
2828 ;; (progn
2829 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
2830 ;; minor-mode indicator))
2831 ;; (princ (documentation minor-mode)))))
2832 ;; (setq minor-modes (cdr minor-modes))))
2833 ;; (print-help-return-message)))
2835 ;; This goes with the redefinition of describe-mode.
2836 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
2837 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
2839 ;; substitute-key-definition should work now.
2840 ;;;; Function to shadow a definition in a keymap with definitions in another.
2841 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
2842 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
2843 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
2844 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
2845 ;;including those whose definition is OLDDEF."
2846 ;; ;; loop through all keymaps accessible from keymap
2847 ;; (let ((maps (accessible-keymaps keymap)))
2848 ;; (while maps
2849 ;; (let ((prefix (car (car maps)))
2850 ;; (map (cdr (car maps))))
2851 ;; ;; examine a keymap
2852 ;; (if (arrayp map)
2853 ;; ;; array keymap
2854 ;; (let ((len (length map))
2855 ;; (i 0))
2856 ;; (while (< i len)
2857 ;; (if (eq (aref map i) olddef)
2858 ;; ;; set the shadowing definition
2859 ;; (let ((key (concat prefix (char-to-string i))))
2860 ;; (emerge-define-key-if-possible shadowmap key newdef)))
2861 ;; (setq i (1+ i))))
2862 ;; ;; sparse keymap
2863 ;; (while map
2864 ;; (if (eq (cdr-safe (car-safe map)) olddef)
2865 ;; ;; set the shadowing definition
2866 ;; (let ((key
2867 ;; (concat prefix (char-to-string (car (car map))))))
2868 ;; (emerge-define-key-if-possible shadowmap key newdef)))
2869 ;; (setq map (cdr map)))))
2870 ;; (setq maps (cdr maps)))))
2872 ;; Define a key if it (or a prefix) is not already defined in the map.
2874 ;; look up the present definition of the key
2877 ;; if it is "too long", look up the valid prefix
2879 ;; if the prefix isn't defined, define it
2881 ;; if there is no present definition, define it
2885 ;; Ordinary substitute-key-definition should do this now.
2886 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
2887 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
2888 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
2889 ;;\(`copy-keymap' will suffice.)"
2890 ;; ;; Loop through all keymaps accessible from keymap
2891 ;; (let ((maps (accessible-keymaps keymap)))
2892 ;; (while maps
2893 ;; ;; Substitute in this keymap
2894 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
2895 ;; (setq maps (cdr maps)))))
2897 ;; Show the name of the file in the buffer.
2899 "Displays the name of the file loaded into the current buffer.
2900 If the name won't fit on one line, the minibuffer is expanded to hold it,
2901 and the command waits for a keystroke from the user. If the keystroke is
2902 SPC, it is ignored; if it is anything else, it is processed as a command."
2920 ;; Improved auto-save file names.
2921 ;; This function fixes many problems with the standard auto-save file names:
2922 ;; Auto-save files for non-file buffers get put in the default directory
2923 ;; for the buffer, whether that makes sense or not.
2924 ;; Auto-save files for file buffers get put in the directory of the file,
2925 ;; regardless of whether we can write into it or not.
2926 ;; Auto-save files for non-file buffers don't use the process id, so if a
2927 ;; user runs more than on Emacs, they can make auto-save files that overwrite
2928 ;; each other.
2929 ;; To use this function, do:
2930 ;; (fset 'make-auto-save-file-name
2931 ;; (symbol-function 'emerge-make-auto-save-file-name))
2933 "Return file name to use for auto-saves of current buffer.
2934 Does not consider `auto-save-visited-file-name';
2935 that is checked before calling this function.
2936 You can redefine this for customization.
2937 See also `auto-save-file-name-p'."
2939 ;; if buffer has a file, try the format <file directory>/#<file name>#
2941 "#"
2945 ;; the file is writable, so use it
2946 f
2947 ;; the file isn't writable, so use the format
2948 ;; ~/#&<file name>&<hash of directory>#
2950 "/#&"
2952 "&"
2956 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
2958 "/#%"
2959 ;; quote / into \! and \ into \\
2961 "%"
2965 ;; Hash a string into five characters more-or-less suitable for use in a file
2966 ;; name. (Allowed characters are ! through ~, except /.)
2982 ;; Quote any /s in a string by replacing them with \!.
2983 ;; Also, replace any \s by \\, to make it one-to-one.
2995 s)
2997 ;; Metacharacters that have to be protected from the shell when executing
2998 ;; a diff/diff3 command.
3003 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3011 s)
3015 ;;; emerge.el ends here