| blob | af13665fc2ad9e358c3c0ffbb93fdee89be8b657 |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; This file is part of GNU Emacs.
7 ;; Author: Dale R. Worley <worley@world.std.com>
8 ;; Keywords: unix, vc, tools
10 ;; This software was created by Dale R. Worley and is
11 ;; distributed free of charge. It is placed in the public domain and
12 ;; permission is granted to anyone to use, duplicate, modify and redistribute
13 ;; it provided that this notice is attached.
15 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
16 ;; with respect to this software. The entire risk as to the quality and
17 ;; performance of this software is with the user. IN NO EVENT WILL DALE
18 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
19 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
20 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
21 ;; DAMAGES.
23 ;;; Commentary:
25 ;;; Code:
27 ;; There aren't really global variables, just dynamic bindings
37 ;;; Macros
40 "Defines SYMBOL as an advertised variable.
41 Performs a defvar, then executes `make-variable-buffer-local' on
42 the variable. Also sets the `permanent-local' property, so that
43 `kill-all-local-variables' (called by major-mode setting commands)
44 won't destroy Emerge control variables."
50 ;; Add entries to minor-mode-alist so that emerge modes show correctly
59 minor-mode-alist)))
61 ;; We need to define this function so describe-mode can describe Emerge mode.
63 "Emerge mode is used by the Emerge file-merging package.
64 It is entered only through one of the functions:
65 `emerge-files'
66 `emerge-files-with-ancestor'
67 `emerge-buffers'
68 `emerge-buffers-with-ancestor'
69 `emerge-files-command'
70 `emerge-files-with-ancestor-command'
71 `emerge-files-remote'
72 `emerge-files-with-ancestor-remote'
74 Commands:
79 ;;; Emerge configuration variables
82 "Merge diffs under Emacs control."
85 ;; Commands that produce difference files
86 ;; All that can be configured is the name of the programs to execute
87 ;; (emerge-diff-program and emerge-diff3-program) and the options
88 ;; to be provided (emerge-diff-options). The order in which the file names
89 ;; are given is fixed.
90 ;; The file names are always expanded (see expand-file-name) before being
91 ;; passed to diff, thus they need not be invoked under a shell that
92 ;; understands `~'.
93 ;; The code which processes the diff/diff3 output depends on all the
94 ;; finicky details of their output, including the somewhat strange
95 ;; way they number lines of a file.
97 "Name of the program which compares two files."
101 "Name of the program which compares three files.
102 Its arguments are the ancestor file and the two variant files."
106 "Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
112 "Pattern to match lines produced by diff that describe differences.
113 This is as opposed to lines from the source files."
118 "Regexp that matches normal output lines from `emerge-diff-program'.
119 Lines that do not match are assumed to be error messages."
124 "Regexp that matches normal output lines from `emerge-diff3-program'.
125 Lines that do not match are assumed to be error messages."
130 "Name of the program that checks in RCS revisions."
134 "Name of the program that checks out RCS revisions."
139 "Non-nil if Emerge should process local-variables lists in merge buffers.
140 \(You can explicitly request processing the local-variables
141 by executing `(hack-local-variables)'.)"
145 "If non-nil: `emerge-execute-line' makes no output if an input was deleted.
146 It concludes that an input version has been deleted when an ancestor entry
147 is present, only one A or B entry is present, and an output entry is present.
148 If nil: In such circumstances, the A or B file that is present will be
149 copied to the designated output file."
154 "Flag placed above the highlighted block of code. Must end with newline.
155 Must be set before Emerge is loaded, or emerge-new-flags must be run
156 after setting."
160 "Flag placed below the highlighted block of code. Must end with newline.
161 Must be set before Emerge is loaded, or emerge-new-flags must be run
162 after setting."
166 ;; Hook variables
169 "Hook to run in the merge buffer after the merge has been set up."
173 "Hook to run after a difference has been selected.
174 The variable `n' holds the (internal) number of the difference."
178 "Hook to run after a difference has been unselected.
179 The variable `n' holds the (internal) number of the difference."
183 ;; Variables to control the default directories of the arguments to
184 ;; Emerge commands.
187 "If nil, default dir for filenames in emerge is `default-directory'.
188 If non-nil, filenames complete in the directory of the last argument of the
189 same type to an `emerge-files...' command."
222 ;; The flags used to mark differences in the buffers.
224 ;; These function definitions need to be up here, because they are used
225 ;; during loading.
227 "Function to be called after `emerge-{before,after}-flag'.
228 This is called after these functions are changed to compute values that
229 depend on the flags."
240 "Return the number of matches in STRING for REGEXP."
246 count))
248 ;; Calculate dependent variables
252 "Number of lines that we want to show above and below the flags when we are
253 displaying a difference."
259 "Prefix to put on Emerge temporary file names.
260 Do not start with `~/' or `~USERNAME/'."
265 "Mode for Emerge temporary files."
271 "Template for `emerge-combine-versions' to combine the two versions.
272 The template is inserted as a string, with the following interpolations:
273 %a the A version of the difference
274 %b the B version of the difference
275 %% the character `%'
276 Don't forget to end the template with a newline.
277 Note that this variable can be made local to a particular merge buffer by
278 giving a prefix argument to `emerge-set-combine-versions-template'."
282 ;; Build keymaps
285 "Keymap of Emerge commands.
286 Directly available in `fast' mode;
290 "Local keymap used in Emerge `fast' mode.
303 "Command prefix for Emerge commands in `edit' mode.
304 Must be set before Emerge is loaded."
308 ;; This function sets up the fixed keymaps. It is executed when the first
309 ;; Emerge is done to allow the user maximum time to set up the global keymap.
311 ;; Set up the basic keymap
314 ; - to negative-argument
355 ;; Allow emerge-basic-keymap to be referenced indirectly
357 ;; Set up the fast mode keymap
359 ;; Allow prefixed commands to work in fast mode
361 ;; Allow emerge-fast-keymap to be referenced indirectly
363 ;; Suppress write-file and save-buffer
445 ;; Variables which control each merge. They are local to the merge buffer.
447 ;; Mode variables
461 "The buffer in which the ancestor variant is stored,
466 buffer-read-only
467 buffer-auto-save-file-name)
468 "Variables and properties of a buffer which are saved, modified and restored
479 "Vector of differences between the variants, and markers in the buffers to
480 show where they are. Each difference is represented by a vector of seven
481 elements. The first two are markers to the beginning and end of the difference
482 section in the A buffer, the second two are markers for the B buffer, the third
484 that difference in the merge buffer.
485 A section of a buffer is described by two markers, one to the beginning of
486 the first line of the section, and one to the beginning of the first line
487 after the section. (If the section is empty, both markers point to the same
488 point.) If the section is part of the selected difference, then the markers
489 are moved into the flags, so the user can edit the section without disturbing
490 the markers.
492 A the merge buffer currently contains the A variant
493 B the merge buffer currently contains the B variant
494 default-A the merge buffer contains the A variant by default,
495 but this difference hasn't been selected yet, so
496 change-default commands can alter it
497 default-B the merge buffer contains the B variant by default,
498 but this difference hasn't been selected yet, so
499 change-default commands can alter it
500 prefer-A in a three-file merge, the A variant is the preferred
501 choice
502 prefer-B in a three-file merge, the B variant is the preferred
509 "The local keymap for the merge buffer, with the emerge commands defined in
510 it. Used to save the local keymap during fast mode, when the local keymap is
515 "If non-nil, emerge-select-A and emerge-select-B automatically advance to
518 "If non-nil, differences for which there is a preference are automatically
521 "Hooks to run in the merge buffer after the merge has been finished.
522 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
523 command.
528 ;;; Setup functions for two-file mode.
531 output-file)
538 ;; Record the directories of the files
543 ;; Make sure the entire files are seen, and they reflect what is on disk
545 buffer-A
550 startup-hooks
552 startup-hooks))
553 ;; Verify that the file matches the buffer
556 buffer-B
561 startup-hooks
563 startup-hooks))
564 ;; Verify that the file matches the buffer
567 output-file)))
569 ;; Start up Emerge on two files
571 output-file)
576 ;; create the merge buffer from buffer A, so it inherits buffer A's
577 ;; default directory, etc.
579 buffer-A
582 merge-buffer
608 ;; Generate the Emerge difference list between two files
612 emerge-diff-buffer
616 emerge-diff-program emerge-diff-options
619 t))
622 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
628 diff-buffer
637 a-begin)))
645 b-begin))))
646 ;; fix the beginning and end numbers, because diff is somewhat
647 ;; strange about how it numbers lines
658 ;; (string-equal diff-type "c")
663 b-begin b-end
665 list)))))
668 ;; Set up buffer of diff/diff3 error messages.
672 emerge-diff-error-buffer
677 ;;; Top-level and setup functions for three-file mode.
680 &optional startup-hooks quit-hooks
681 output-file)
691 ;; Record the directories of the files
697 ;; Make sure the entire files are seen, and they reflect what is on disk
699 buffer-A
704 startup-hooks
706 startup-hooks))
707 ;; Verify that the file matches the buffer
710 buffer-B
715 startup-hooks
717 startup-hooks))
718 ;; Verify that the file matches the buffer
721 buffer-ancestor
726 startup-hooks
728 startup-hooks))
729 ;; Verify that the file matches the buffer
732 buffer-ancestor file-ancestor
733 startup-hooks quit-hooks output-file)))
735 ;; Start up Emerge on two files with an ancestor
737 buffer-ancestor file-ancestor
738 &optional startup-hooks quit-hooks
739 output-file)
745 ;; create the merge buffer from buffer A, so it inherits buffer A's
746 ;; default directory, etc.
748 buffer-A
751 merge-buffer
779 ;; Generate the Emerge difference list between two files with an ancestor
783 emerge-diff-buffer
787 emerge-diff3-program emerge-diff-options
791 t))
794 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
800 diff-buffer
802 ;; leave point after matched line
805 ;; if the A and B files are the same, ignore the difference
819 list))))))
823 ;; This save-excursion allows emerge-get-diff3-group to be called for the
824 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
825 ;; appear in any order. The reason this is necessary is that Gnu diff3
826 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
831 ;; treatment depends on whether it is an "a" group or a "c" group
833 ;; it is a "c" group
835 ;; it has two numbers
840 ;; it has one number
844 ;; it is an "a" group
849 ;;; Functions to start Emerge on files
851 ;;;###autoload
853 quit-hooks)
854 "Run Emerge on two files."
859 nil nil t))
863 f f nil)))))
867 file-A file-B startup-hooks
868 quit-hooks
869 file-out))
871 ;;;###autoload
874 "Run Emerge on two files, giving another file as the ancestor."
879 nil nil t))
882 nil f t)
885 f f nil)))))
889 file-A file-B file-ancestor startup-hooks
890 quit-hooks
891 file-out))
893 ;; Write the merge buffer out in place of the file the A buffer is visiting.
895 ;; if merge was successful was given, save to disk
899 ;;; Functions to start Emerge on buffers
901 ;;;###autoload
903 "Run Emerge on two buffers."
908 buffer-A
911 buffer-B
918 startup-hooks)
919 quit-hooks
920 nil)))
922 ;;;###autoload
924 &optional startup-hooks
925 quit-hooks)
926 "Run Emerge on two buffers, giving another buffer as the ancestor."
933 buffer-A
936 buffer-B
939 buffer-ancestor
945 emerge-file-ancestor
951 startup-hooks)
952 quit-hooks
953 nil)))
955 ;;; Functions to start Emerge from the command line
957 ;;;###autoload
964 file-a file-b nil
967 ;;;###autoload
970 ;; check for a -a flag, for filemerge compatibility
972 ;; arguments are "-a ancestor file-a file-b file-out"
979 ;; arguments are "file-a file-b ancestor file-out"
986 file-a file-b file-anc nil
993 ;;; Functions to start Emerge via remote request
995 ;;;###autoload
999 file-a file-b nil
1001 file-out)
1004 ;;;###autoload
1008 file-a file-b file-anc nil
1010 file-out)
1018 ;;; Functions to start Emerge on RCS versions
1020 ;;;###autoload
1023 "Emerge two RCS revisions of a file."
1030 emerge-last-revision-B revision-B)
1032 file revision-A revision-B startup-hooks
1037 quit-hooks)
1038 quit-hooks)))
1040 ;;;###autoload
1042 revision-B ancestor
1043 &optional
1044 startup-hooks quit-hooks)
1045 "Emerge two RCS revisions of a file, with another revision as ancestor."
1053 emerge-last-revision-B revision-B
1054 emerge-last-revision-ancestor ancestor)
1056 file revision-A revision-B ancestor startup-hooks
1062 quit-hooks))
1063 quit-hooks)))
1066 startup-hooks quit-hooks _output-file)
1071 ;; Get the revisions into buffers
1073 buffer-A
1077 t)
1081 buffer-B
1085 t)
1088 ;; Do the merge
1090 buffer-B emerge-file-B
1094 startup-hooks)
1096 quit-hooks)
1097 nil)))
1100 ancestor
1101 &optional startup-hooks
1102 quit-hooks output-file)
1109 ;; Get the revisions into buffers
1111 buffer-A
1115 revision-A file)
1116 t)
1120 buffer-B
1124 t)
1128 buffer-ancestor
1132 t)
1135 ;; Do the merge
1137 buffer-A emerge-file-A buffer-B emerge-file-B
1138 buffer-ancestor emerge-ancestor
1143 startup-hooks)
1145 quit-hooks)
1146 output-file)))
1148 ;;; Function to start Emerge based on a line in a file
1151 "Run Emerge using files named in current text line.
1152 Looks in that line for whitespace-separated entries of these forms:
1153 a=file1
1154 b=file2
1155 ancestor=file3
1156 output=file4
1157 to specify the files to use in Emerge.
1159 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1160 is present:
1161 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1162 it is assumed that the file in question has been deleted, and it is
1163 not copied to the output file.
1164 Otherwise, the A or B file present is copied to the output file."
1168 ;; Stop if at end of buffer (even though we might be in a line, if
1169 ;; the line does not end with newline)
1172 ;; Go to the beginning of the line
1174 ;; Skip any initial whitespace
1177 ;; Process the entire line
1179 ;; Get the next entry
1181 ;; Break apart the tab (before =) and the filename (after =)
1185 ;; Move point after the entry
1187 ;; Store the filename in the right variable
1207 ;; If the match on the entry pattern failed
1209 ;; Make sure that file-A and file-B are present
1214 ;; Go to the beginning of the next line, so next execution will use
1215 ;; next line in buffer.
1217 ;; Execute the correct command
1219 ;; Merge of two files with ancestor
1223 file-ancestor file-out
1224 nil
1225 ;; When done, return to this buffer.
1230 ;; Merge of two files without ancestor
1234 nil
1235 ;; When done, return to this buffer.
1240 ;; There is an output file (or there would have been an error above),
1241 ;; but only one input file.
1242 ;; The file appears to have been deleted in one version; do nothing.
1245 ;; The file should be copied from the version that contains it
1251 ;;; Sample function for creating information for emerge-execute-line
1254 "Regexp describing files to be processed by `emerge-merge-directories'."
1258 ;;;###autoload
1266 ;; Check that we're not on a line
1269 ;; Turn null strings into nil to indicate directories not used.
1274 ;; Canonicalize the directory names
1291 ;; Set the mark to where we start
1293 ;; Find out what files are in the directories.
1301 emerge-merge-directories-filename-regexp)))
1306 ;; Remove duplicates from all-files.
1312 ;; Generate the control lines for the various files.
1333 ;;; Common setup routines
1335 ;; Set up the window configuration. If POS is given, set the points to
1336 ;; the beginnings of the buffers.
1338 ;; Make sure we are not in the minibuffer window when we try to delete
1339 ;; all other windows.
1357 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1365 ;; Set up the keymap in the merge buffer
1367 ;; Set up fixed keymaps if necessary
1370 ;; Save the old local map
1372 ;; Construct the edit keymap
1376 ;; Install the Emerge commands
1381 ;; Create the additional menu bar items.
1389 ;; Suppress write-file and save-buffer
1391 'emerge-query-write-file
1392 emerge-edit-keymap)
1394 'emerge-query-save-buffer
1395 emerge-edit-keymap)
1403 "Record certain properties of the buffers being merged.
1404 Must be called in the merge buffer. Remembers read-only, modified,
1405 auto-save, and saves them in buffer local variables. Sets the buffers
1406 read-only and turns off `auto-save-mode'.
1407 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1408 ;; force auto-save, because we will turn off auto-saving in buffers for the
1409 ;; duration
1411 ;; remember and alter buffer characteristics
1414 emerge-A-buffer
1418 emerge-merging-values))))
1421 emerge-B-buffer
1425 emerge-merging-values)))))
1428 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1433 A-values))
1436 B-values))))
1438 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1439 ;; Return DESIRED-LINE.
1442 desired-line)
1445 B-buffer
1446 merge-buffer
1447 lineno-list)
1452 ;; Record current line number in each buffer
1453 ;; so we don't have to count from the beginning.
1460 a-begin-marker
1461 a-end-marker
1462 b-begin-marker
1463 b-end-marker
1464 merge-begin-marker
1465 merge-end-marker
1471 ;; place markers at the appropriate places in the buffers
1473 A-buffer
1479 B-buffer
1487 offset)
1488 merge-buffer))
1492 offset)
1493 merge-buffer))
1494 ;; record all the markers for this difference
1496 b-begin-marker b-end-marker
1497 merge-begin-marker merge-end-marker
1498 state)
1499 marker-list)))
1501 ;; convert the list of difference information into a vector for
1502 ;; fast access
1505 ;; If we have an ancestor, select all B variants that we prefer
1517 ;; Process the local-variables list at the end of the merged file, if
1518 ;; requested.
1526 ;;; Common exit routines
1529 ;; clear screen format
1531 ;; delete A, B, and ancestor buffers, if they haven't been changed
1539 ;; Write merge buffer to file
1543 ;;; Commands
1546 "Bring the highlighted region of all three merge buffers into view.
1547 This brings the buffers into view if they are in windows.
1548 With an argument, reestablish the default three-window display."
1550 ;; If there is an argument, rebuild the window structure
1553 emerge-merge-buffer))
1554 ;; Redisplay whatever buffers are showing, if there is a selected difference
1590 ;;; Window scrolling operations
1591 ;; These operations are designed to scroll all three windows the same amount,
1592 ;; so as to keep the text in them aligned.
1594 ;; Perform some operation on all three windows (if they are showing).
1595 ;; Catches all errors on the operation in the A and B windows, but not
1596 ;; in the merge window. Usually, errors come from scrolling off the
1597 ;; beginning or end of the buffer, and this gives a nice error message:
1598 ;; End of buffer is reported in the merge buffer, but if the scroll was
1599 ;; possible in the A or B windows, it is performed there before the error
1600 ;; is reported.
1623 "Scroll up all three merge buffers, if they are in windows.
1624 With argument N, scroll N lines; otherwise scroll by nearly
1625 the height of the merge window.
1626 `C-u -' alone as argument scrolls half the height of the merge window."
1629 'scroll-up
1630 ;; calculate argument to scroll-up
1631 ;; if there is an explicit argument
1633 ;; use it
1635 ;; if not, see if we can determine a default amount (the window height)
1638 ;; no window, use nil
1639 nil
1642 ;; the window was found
1644 ;; C-u as argument means half of default amount
1646 ;; no argument means default amount
1647 default-amount)))))))
1650 "Scroll down all three merge buffers, if they are in windows.
1651 With argument N, scroll N lines; otherwise scroll by nearly
1652 the height of the merge window.
1653 `C-u -' alone as argument scrolls half the height of the merge window."
1656 'scroll-down
1657 ;; calculate argument to scroll-down
1658 ;; if there is an explicit argument
1660 ;; use it
1662 ;; if not, see if we can determine a default amount (the window height)
1665 ;; no window, use nil
1666 nil
1669 ;; the window was found
1671 ;; C-u as argument means half of default amount
1673 ;; no argument means default amount
1674 default-amount)))))))
1677 "Scroll left all three merge buffers, if they are in windows.
1678 If an argument is given, that is how many columns are scrolled, else nearly
1679 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1680 width of the A and B windows."
1683 'scroll-left
1684 ;; calculate argument to scroll-left
1685 ;; if there is an explicit argument
1687 ;; use it
1689 ;; if not, see if we can determine a default amount
1690 ;; (half the window width)
1693 ;; no window, use nil
1694 nil
1697 ;; the window was found
1699 ;; C-u as argument means half of default amount
1701 ;; no argument means default amount
1702 default-amount)))))))
1705 "Scroll right all three merge buffers, if they are in windows.
1706 If an argument is given, that is how many columns are scrolled, else nearly
1707 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1708 width of the A and B windows."
1711 'scroll-right
1712 ;; calculate argument to scroll-right
1713 ;; if there is an explicit argument
1715 ;; use it
1717 ;; if not, see if we can determine a default amount
1718 ;; (half the window width)
1721 ;; no window, use nil
1722 nil
1725 ;; the window was found
1727 ;; C-u as argument means half of default amount
1729 ;; no argument means default amount
1730 default-amount)))))))
1733 "Reset horizontal scrolling in Emerge.
1734 This resets the horizontal scrolling of all three merge buffers
1735 to the left margin, if they are in windows."
1739 nil))
1741 ;; Attempt to show the region nicely.
1742 ;; If there are min-lines lines above and below the region, then don't do
1743 ;; anything.
1744 ;; If not, recenter the region to make it so.
1745 ;; If that isn't possible, remove context lines evenly from top and bottom
1746 ;; so the entire region shows.
1747 ;; If that isn't possible, show the top of the region.
1748 ;; BEG must be at the beginning of a line.
1750 ;; First test whether the entire region is visible with
1751 ;; emerge-min-visible-lines above and below it
1755 beg)
1760 ;; We failed that test, see if it fits at all
1761 ;; Meanwhile positioning it correctly in case it doesn't fit
1765 ;; Determine the number of lines that the region occupies
1771 ;; And position the beginning on the right line
1774 lines))
1779 "Advance to the next difference."
1793 "Go to the previous difference."
1807 "Go to the N-th difference."
1817 "Abort the Emerge session."
1822 "Finish the Emerge session and exit Emerge.
1823 Prefix argument means to abort rather than successfully finish.
1824 The difference depends on how the merge was started,
1825 but usually means to not write over one of the original files, or to signal
1826 to some process which invoked Emerge a failure code.
1828 Unselects the selected difference, if any, restores the read-only and modified
1829 flags of the merged file buffers, restores the local keymap of the merge
1830 buffer, and sets off various emerge flags. Using Emerge commands in this
1831 buffer after this will cause serious problems."
1836 "Do you really want to successfully finish this merge? "
1841 ;; Perform the quit operations.
1846 ;; null out the difference markers so they don't slow down future editing
1847 ;; operations
1855 emerge-difference-list)
1856 ;; allow them to be garbage collected
1858 ;; restore the local map
1860 ;; turn off all the emerge modes
1866 ;; restore mode line
1872 "Select the A variant of this difference.
1873 Refuses to function if this difference has been edited, i.e., if it
1874 is neither the A nor the B variant.
1875 A prefix argument forces the variant to be selected
1876 even if the difference has been edited."
1888 ;; Actually select the A variant
1891 emerge-merge-buffer
1900 "Select the B variant of this difference.
1901 Refuses to function if this difference has been edited, i.e., if it
1902 is neither the A nor the B variant.
1903 A prefix argument forces the variant to be selected
1904 even if the difference has been edited."
1916 ;; Actually select the B variant
1919 emerge-merge-buffer
1928 "Make the A variant the default from here down.
1929 This selects the A variant for all differences from here down in the buffer
1930 which are still defaulted, i.e., which the user has not selected and for
1931 which there is no preference."
1950 "Make the B variant the default from here down.
1951 This selects the B variant for all differences from here down in the buffer
1952 which are still defaulted, i.e., which the user has not selected and for
1953 which there is no preference."
1972 "Set fast mode, for Emerge.
1973 In this mode ordinary Emacs commands are disabled, and Emerge commands
1985 "Set edit mode, for Emerge.
1986 In this mode ordinary Emacs commands are available, and Emerge commands
1998 "Toggle Auto-Advance mode, for Emerge.
1999 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2000 advance to the next difference.
2001 With a positive argument, turn on Auto-Advance mode.
2002 With a negative argument, turn off Auto-Advance mode."
2008 "Auto-advance set"
2013 "Toggle Skip-Prefers mode, for Emerge.
2014 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2015 to automatically skip over differences for which there is a preference.
2016 With a positive argument, turn on Skip-Prefers mode.
2017 With a negative argument, turn off Skip-Prefers mode."
2023 "Skip-prefers set"
2028 "Put the A variant of this difference in the kill ring."
2035 ;; so further kills don't append
2036 this-command)
2041 "Put the B variant of this difference in the kill ring."
2048 ;; so further kills don't append
2049 this-command)
2054 "Insert the A variant of this difference at the point.
2055 Leaves point after text, mark before.
2056 With prefix argument, puts point before, mark after."
2072 "Insert the B variant of this difference at the point.
2073 Leaves point after text, mark before.
2074 With prefix argument, puts point before, mark after."
2090 "Leaves the point before this difference and the mark after it.
2091 With prefix argument, puts mark before, point after."
2106 "Show the names of the buffers or files being operated on by Emerge.
2107 Use C-u l to reset the windows afterward."
2149 "Join the selected difference with the following one.
2150 With a prefix argument, join with the preceding one."
2153 ;; adjust n to be first difference to join
2156 ;; n and n+1 are the differences to join
2157 ;; check that they are both differences
2160 ;; remove the flags
2162 ;; decrement total number of differences
2164 ;; build new differences vector
2184 ps)
2191 ;; set the current difference correctly
2193 ;; fix the mode line
2195 ;; reinsert the flags
2200 "Split the current difference where the points are in the three windows."
2203 ;; check that this is a valid difference
2205 ;; get the point values and old difference
2212 ;; check location of the points, give error if they aren't in the
2213 ;; differences
2223 ;; remove the flags
2225 ;; increment total number of differences
2227 ;; build new differences vector
2239 A-point
2241 B-point
2243 merge-point
2255 ;; set the current difference correctly
2257 ;; fix the mode line
2259 ;; reinsert the flags
2264 "Trim lines off top and bottom of difference that are the same.
2265 If lines are the same in both the A and the B versions, strip them off.
2266 \(This can happen when the A and B versions have common lines that the
2267 ancestor version does not share.)"
2269 ;; make sure we are in a real difference
2271 ;; remove the flags
2280 size success sa sb sm)
2281 ;; move down the tops of the difference regions as much as possible
2282 ;; Try advancing comparing 1000 chars at a time.
2283 ;; When that fails, go 500 chars at a time, and so on.
2303 ;; move up the bottoms of the difference regions as much as possible
2304 ;; Try advancing comparing 1000 chars at a time.
2305 ;; When that fails, go 500 chars at a time, and so on.
2314 bottom-a)))
2317 bottom-b)))
2325 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2326 ;; of the difference regions. Move them to the beginning of lines, as
2327 ;; appropriate.
2348 ;; put the flags back in, recenter the display
2352 ;; FIXME the manual advertised this as working in the A or B buffers,
2353 ;; but it does not, because all the buffer locals are nil there.
2354 ;; It would work to call it from the merge buffer and specify that one
2355 ;; wants to use the value of point in the A or B buffer.
2356 ;; But with the prefix argument already in use, there is no easy way
2357 ;; to have it ask for a buffer.
2359 "Find the difference containing the current position of the point.
2360 If there is no containing difference and the prefix argument is positive,
2361 it finds the nearest following difference. A negative prefix argument finds
2362 the nearest previous difference."
2371 "Find the difference containing point, in the merge buffer.
2372 If there is no containing difference and the prefix argument is positive,
2373 it finds the nearest following difference. A negative prefix argument finds
2374 the nearest previous difference."
2376 ;; search for the point in the merge buffer, using the markers
2377 ;; for the beginning and end of the differences in the merge buffer
2381 "Find the difference containing point, in the A buffer.
2382 This command must be executed in the merge buffer.
2383 If there is no containing difference and the prefix argument is positive,
2384 it finds the nearest following difference. A negative prefix argument finds
2385 the nearest previous difference."
2387 ;; search for the point in the A buffer, using the markers
2388 ;; for the beginning and end of the differences in the A buffer
2394 "Find the difference containing point, in the B buffer.
2395 This command must be executed in the merge buffer.
2396 If there is no containing difference and the prefix argument is positive,
2397 it finds the nearest following difference. A negative prefix argument finds
2398 the nearest previous difference."
2400 ;; search for the point in the B buffer, using the markers
2401 ;; for the beginning and end of the differences in the B buffer
2408 ;; find first difference containing or after the current position
2416 emerge-number-of-differences))
2418 ;; whether the found difference contains the current position
2421 begin))
2422 location)))
2424 ;; numeric value of prefix argument
2428 ;; if the point is in a difference, select it
2430 ;; if the arg is nil and the point is not in a difference, error
2432 ;; if the arg is positive, select the following difference
2435 index
2437 ;; if the arg is negative, select the preceding difference
2444 "Display the current line numbers.
2445 This function displays the line numbers of the points in the A, B, and
2446 merge buffers."
2453 emerge-current-difference)))
2460 merge-line A-line B-line)))
2465 ;; FIXME point-min rather than 1? widen?
2473 temp))
2476 "Set `emerge-combine-versions-template' to STRING.
2477 This value controls how `emerge-combine-versions' combines the two versions.
2478 With prefix argument, `emerge-combine-versions-template' is made local to this
2479 merge buffer. Localization is permanent for any particular merge buffer."
2486 "emerge-set-combine-versions-template set locally"
2490 "Copy region into `emerge-combine-versions-template'.
2491 This controls how `emerge-combine-versions' will combine the two versions.
2492 With prefix argument, `emerge-combine-versions-template' is made local to this
2493 merge buffer. Localization is permanent for any particular merge buffer."
2500 "emerge-set-combine-versions-template set locally."
2504 "Combine versions using the template in `emerge-combine-versions-template'.
2505 Refuses to function if this difference has been edited, i.e., if it is
2506 neither the A nor the B variant.
2507 An argument forces the variant to be selected even if the difference has
2508 been edited."
2513 "Combine the two versions using the template in register REG.
2514 See documentation of the variable `emerge-combine-versions-template'
2515 for how the template is interpreted.
2516 Refuses to function if this difference has been edited, i.e., if it is
2517 neither the A nor the B variant.
2518 An argument forces the variant to be selected even if the difference has
2519 been edited."
2530 A-begin A-end B-begin B-end)
2538 A-begin A-end B-begin B-end)
2540 emerge-merge-buffer
2568 "Set the major mode in a merge buffer.
2569 Overrides any change that the mode might make to the mode line or local
2570 keymap. Leaves merge in fast mode."
2585 ;;; Support routines
2587 ;; Select a difference by placing the visual flags around the appropriate
2588 ;; group of lines in the A, B, and merge buffers
2598 after-index)
2601 buffer
2607 ;; insert the flag before the difference
2609 before-index))
2610 here)
2612 ;; insert the flag itself
2615 ;; Put the marker(s) referring to this position 1 character before the
2616 ;; end of the flag, so it won't be damaged by the user.
2617 ;; This gets a bit tricky, as there could be a number of markers
2618 ;; that have to be moved.
2632 ;; insert the flag after the difference
2634 after-index))
2637 ;; insert the flag itself
2639 ;; Put the marker(s) referring to this position 1 character after the
2640 ;; beginning of the flag, so it won't be damaged by the user.
2641 ;; This gets a bit tricky, as there could be a number of markers
2642 ;; that have to be moved.
2657 ;; Unselect a difference by removing the visual flags in the buffers.
2670 buffer
2672 ;; remove the flags, if they're there
2676 ;; the flag isn't there
2682 ;; the flag isn't there
2686 ;; Select a difference, removing any flags that exist now.
2706 ;; Perform tests to see whether user should be allowed to select a version
2707 ;; of this difference:
2708 ;; a valid difference has been selected; and
2709 ;; the difference text in the merge buffer is:
2710 ;; the A version (execute a-version), or
2711 ;; the B version (execute b-version), or
2712 ;; empty (execute neither-version), or
2713 ;; argument FORCE is true (execute neither-version)
2714 ;; Otherwise, signal an error.
2727 emerge-merge-buffer merge-begin
2728 merge-end)
2731 emerge-merge-buffer merge-begin
2732 merge-end)
2738 ;; Read a file name, handling all of the various defaulting rules.
2741 A-file must-match)
2742 ;; `prompt' should not have trailing ": ", so that it can be modified
2743 ;; according to context.
2744 ;; If alternative-default-dir is non-nil, it should be used as the default
2745 ;; directory instead if default-directory, if emerge-default-last-directories
2746 ;; is set.
2747 ;; If default-file is set, it should be used as the default value.
2748 ;; If A-file is set, and its directory is different from
2749 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2750 ;; the default file should be the last part of A-file in the default
2751 ;; directory. (Overriding default-file.)
2753 ;; If this is not the A-file argument (shown by non-nil A-file), and
2754 ;; if emerge-default-last-directories is set, and
2755 ;; the default directory exists but is not the same as the directory of the
2756 ;; A-file,
2757 ;; then make the default file have the same name as the A-file, but in
2758 ;; the default directory.
2760 A-file
2761 alternative-default-dir
2766 alternative-default-dir
2770 ;; If there is a default file, use it.
2773 ;; If emerge-default-last-directories is set, use the
2774 ;; directory from the same argument of the last call of
2775 ;; Emerge as the default for this argument.
2777 alternative-default-dir)
2781 ;; If emerge-default-last-directories is set, use the
2782 ;; directory from the same argument of the last call of
2783 ;; Emerge as the default for this argument.
2785 alternative-default-dir)
2788 ;; Revise the mode line to display which difference we have selected
2794 emerge-number-of-differences
2796 (< emerge-current-difference
2797 emerge-number-of-differences))
2799 emerge-current-difference)
2809 ;; compare two regions in two buffers for containing the same text
2811 ;; first check that the two regions are the same length
2813 nil
2816 ;; bite off and compare no more than 1000 characters at a time
2819 buffer-x
2823 buffer-y
2830 t)))
2832 ;; Construct a unique buffer name.
2833 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2834 ;; prefix<3>suffix, etc.
2843 ;; Verify that we have a difference selected.
2849 ;;; Functions for saving and restoring a batch of variables
2851 ;; These functions save (get the values of) and restore (set the values of)
2852 ;; a list of variables. The argument is a list of symbols (the names of
2853 ;; the variables). A list element can also be a list of two functions,
2854 ;; the first of which (when called with no arguments) gets the value, and
2855 ;; the second (when called with a value as an argument) sets the value.
2856 ;; A "function" is anything that funcall can handle as an argument.
2862 vars))
2874 ;; Make a temporary file that only we have access to.
2875 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2883 f))
2885 ;;; Functions that query the user before he can write out the current buffer.
2888 "Ask the user whether to write out an incomplete merge.
2889 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2890 for details of the querying process."
2895 "Ask the user whether to save an incomplete merge.
2896 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2897 for details of the querying process."
2902 "Ask the user whether to save or write out the incomplete merge.
2903 If answer is yes, call COMMAND interactively. During the call, the flags
2904 around the current difference are removed."
2906 ;; He really wants to do it -- unselect the difference for the duration
2911 ;; call-interactively takes the value of current-prefix-arg as the
2912 ;; prefix argument value to be passed to the command. Thus, we have
2913 ;; to do nothing special to make sure the prefix argument is
2914 ;; transmitted to the command.
2921 ;; He's being smart and not doing it
2924 ;; Make sure the current buffer (for a file) has the same contents as the
2925 ;; file on disk, and attempt to remedy the situation if not.
2926 ;; Signal an error if we can't make them the same, or the user doesn't want
2927 ;; to do what is necessary to make them the same.
2929 ;; First check if the file has been modified since the buffer visited it.
2932 ;; If buffer is not obsolete and is modified, offer to save
2936 ;; If buffer is not obsolete and is not modified, do nothing
2937 nil)
2939 ;; If buffer is obsolete and is modified, give error
2941 ;; If buffer is obsolete and is not modified, offer to revert
2945 \f
2946 ;; Utilities that might have value outside of Emerge.
2948 ;; Set up the mode in the current buffer to duplicate the mode in another
2949 ;; buffer.
2951 ;; Set the major mode
2954 ;; Define a key, even if a prefix of it is defined
2956 "Like `define-key', but forcibly creates prefix characters as needed.
2957 If some prefix of KEY has a non-prefix definition, it is redefined."
2958 ;; Find out if a prefix of key is defined
2960 ;; If so, undefine it
2963 ;; Now define the key
2966 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2967 ;;;;; as the major mode
2968 ;;(defun describe-mode (&optional minor)
2969 ;; "Display documentation of current major mode.
2970 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2971 ;;display documentation of active minor modes as well.
2972 ;;For this to work correctly for a minor mode, the mode's indicator variable
2973 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2974 ;;describes the minor mode."
2975 ;; (interactive)
2976 ;; (with-output-to-temp-buffer "*Help*"
2977 ;; (princ mode-name)
2978 ;; (princ " Mode:\n")
2979 ;; (princ (documentation major-mode))
2980 ;; (let ((minor-modes minor-mode-alist)
2981 ;; (locals (buffer-local-variables)))
2982 ;; (while minor-modes
2983 ;; (let* ((minor-mode (car (car minor-modes)))
2984 ;; (indicator (car (cdr (car minor-modes))))
2985 ;; (local-binding (assq minor-mode locals)))
2986 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2987 ;; ;; bound locally in this buffer, non-nil, and has a function
2988 ;; ;; definition.
2989 ;; (if (and local-binding
2990 ;; (cdr local-binding)
2991 ;; (fboundp minor-mode))
2992 ;; (progn
2993 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
2994 ;; minor-mode indicator))
2995 ;; (princ (documentation minor-mode)))))
2996 ;; (setq minor-modes (cdr minor-modes))))
2997 ;; (with-current-buffer standard-output
2998 ;; (help-mode))
2999 ;; (help-print-return-message)))
3001 ;; This goes with the redefinition of describe-mode.
3002 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3003 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3005 ;; substitute-key-definition should work now.
3006 ;;;; Function to shadow a definition in a keymap with definitions in another.
3007 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3008 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3009 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3010 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3011 ;;including those whose definition is OLDDEF."
3012 ;; ;; loop through all keymaps accessible from keymap
3013 ;; (let ((maps (accessible-keymaps keymap)))
3014 ;; (while maps
3015 ;; (let ((prefix (car (car maps)))
3016 ;; (map (cdr (car maps))))
3017 ;; ;; examine a keymap
3018 ;; (if (arrayp map)
3019 ;; ;; array keymap
3020 ;; (let ((len (length map))
3021 ;; (i 0))
3022 ;; (while (< i len)
3023 ;; (if (eq (aref map i) olddef)
3024 ;; ;; set the shadowing definition
3025 ;; (let ((key (concat prefix (char-to-string i))))
3026 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3027 ;; (setq i (1+ i))))
3028 ;; ;; sparse keymap
3029 ;; (while map
3030 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3031 ;; ;; set the shadowing definition
3032 ;; (let ((key
3033 ;; (concat prefix (char-to-string (car (car map))))))
3034 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3035 ;; (setq map (cdr map)))))
3036 ;; (setq maps (cdr maps)))))
3038 ;; Define a key if it (or a prefix) is not already defined in the map.
3040 ;; look up the present definition of the key
3043 ;; if it is "too long", look up the valid prefix
3045 ;; if the prefix isn't defined, define it
3047 ;; if there is no present definition, define it
3051 ;; Ordinary substitute-key-definition should do this now.
3052 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3053 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3054 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3055 ;;\(`copy-keymap' will suffice.)"
3056 ;; ;; Loop through all keymaps accessible from keymap
3057 ;; (let ((maps (accessible-keymaps keymap)))
3058 ;; (while maps
3059 ;; ;; Substitute in this keymap
3060 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3061 ;; (setq maps (cdr maps)))))
3063 ;; Show the name of the file in the buffer.
3065 "Displays the name of the file loaded into the current buffer.
3066 If the name won't fit on one line, the minibuffer is expanded to hold it,
3067 and the command waits for a keystroke from the user. If the keystroke is
3068 SPC, it is ignored; if it is anything else, it is processed as a command."
3088 ;; Improved auto-save file names.
3089 ;; This function fixes many problems with the standard auto-save file names:
3090 ;; Auto-save files for non-file buffers get put in the default directory
3091 ;; for the buffer, whether that makes sense or not.
3092 ;; Auto-save files for file buffers get put in the directory of the file,
3093 ;; regardless of whether we can write into it or not.
3094 ;; Auto-save files for non-file buffers don't use the process id, so if a
3095 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3096 ;; each other.
3097 ;; To use this function, do:
3098 ;; (fset 'make-auto-save-file-name
3099 ;; (symbol-function 'emerge-make-auto-save-file-name))
3101 "Return file name to use for auto-saves of current buffer.
3102 Does not consider `auto-save-visited-file-name';
3103 that is checked before calling this function.
3104 You can redefine this for customization.
3105 See also `auto-save-file-name-p'."
3107 ;; if buffer has a file, try the format <file directory>/#<file name>#
3109 "#"
3113 ;; the file is writable, so use it
3114 f
3115 ;; the file isn't writable, so use the format
3116 ;; ~/#&<file name>&<hash of directory>#
3118 "/#&"
3120 "&"
3124 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3126 "/#%"
3127 ;; quote / into \! and \ into \\
3129 "%"
3133 ;; Hash a string into five characters more-or-less suitable for use in a file
3134 ;; name. (Allowed characters are ! through ~, except /.)
3150 ;; Quote any /s in a string by replacing them with \!.
3151 ;; Also, replace any \s by \\, to make it one-to-one.
3163 s)
3165 ;; Metacharacters that have to be protected from the shell when executing
3166 ;; a diff/diff3 command.
3171 "Characters that must be quoted when used in a shell command line.
3172 More precisely, a [...] regexp to match any one such character."
3176 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3186 s))
3190 ;;; emerge.el ends here