| blob | e08e566ee2a20fa0fe6da1192219b99b00642c10 |
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 ;; Version: 5fsf
9 ;; Keywords: unix, tools
11 ;; This software was created by Dale R. Worley and is
12 ;; distributed free of charge. It is placed in the public domain and
13 ;; permission is granted to anyone to use, duplicate, modify and redistribute
14 ;; it provided that this notice is attached.
16 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
17 ;; with respect to this software. The entire risk as to the quality and
18 ;; performance of this software is with the user. IN NO EVENT WILL DALE
19 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
20 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
21 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
22 ;; DAMAGES.
24 ;;; Commentary:
26 ;;; Code:
28 ;;;###autoload
30 ;;;###autoload
33 ;;;###autoload
36 ;;;###autoload
39 ;;;###autoload
42 ;;;###autoload
45 ;;;###autoload
48 ;;;###autoload
51 ;;;###autoload
55 ;;; Macros
58 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
59 Differs from `save-excursion' in that it doesn't save the point and mark."
68 "Defines SYMBOL as an advertised variable.
69 Performs a defvar, then executes `make-variable-buffer-local' on
70 the variable. Also sets the `preserved' property, so that
71 `kill-all-local-variables' (called by major-mode setting commands)
72 won't destroy Emerge control variables."
78 ;; Add entries to minor-mode-alist so that emerge modes show correctly
87 minor-mode-alist)))
89 ;; We need to define this function so describe-mode can describe Emerge mode.
91 "Emerge mode is used by the Emerge file-merging package.
92 It is entered only through one of the functions:
93 `emerge-files'
94 `emerge-files-with-ancestor'
95 `emerge-buffers'
96 `emerge-buffers-with-ancestor'
97 `emerge-files-command'
98 `emerge-files-with-ancestor-command'
99 `emerge-files-remote'
100 `emerge-files-with-ancestor-remote'
102 Commands:
111 "Return string describing the version of Emerge.
112 When called interactively, displays the version."
116 emerge-version))
118 ;;; Emerge configuration variables
121 "Merge diffs under Emacs control."
124 ;; Commands that produce difference files
125 ;; All that can be configured is the name of the programs to execute
126 ;; (emerge-diff-program and emerge-diff3-program) and the options
127 ;; to be provided (emerge-diff-options). The order in which the file names
128 ;; are given is fixed.
129 ;; The file names are always expanded (see expand-file-name) before being
130 ;; passed to diff, thus they need not be invoked under a shell that
131 ;; understands `~'.
132 ;; The code which processes the diff/diff3 output depends on all the
133 ;; finicky details of their output, including the somewhat strange
134 ;; way they number lines of a file.
136 "*Name of the program which compares two files."
140 "*Name of the program which compares three files.
141 Its arguments are the ancestor file and the two variant files."
145 "*Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
151 "*Pattern to match lines produced by diff that describe differences.
152 This is as opposed to lines from the source files."
157 "*Regexp that matches normal output lines from `emerge-diff-program'.
158 Lines that do not match are assumed to be error messages."
163 "*Regexp that matches normal output lines from `emerge-diff3-program'.
164 Lines that do not match are assumed to be error messages."
169 "*Name of the program that checks in RCS revisions."
173 "*Name of the program that checks out RCS revisions."
178 "*Non-nil if Emerge should process local-variables lists in merge buffers.
179 \(You can explicitly request processing the local-variables
180 by executing `(hack-local-variables)'.)"
184 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
185 It concludes that an input version has been deleted when an ancestor entry
186 is present, only one A or B entry is present, and an output entry is present.
187 If nil: In such circumstances, the A or B file that is present will be
188 copied to the designated output file."
193 "*Flag placed above the highlighted block of code. Must end with newline.
194 Must be set before Emerge is loaded, or emerge-new-flags must be run
195 after setting."
199 "*Flag placed below the highlighted block of code. Must end with newline.
200 Must be set before Emerge is loaded, or emerge-new-flags must be run
201 after setting."
205 ;; Hook variables
208 "*Hook to run in the merge buffer after the merge has been set up."
212 "*Hook to run after a difference has been selected.
213 The variable `n' holds the (internal) number of the difference."
217 "*Hook to run after a difference has been unselected.
218 The variable `n' holds the (internal) number of the difference."
222 ;; Variables to control the default directories of the arguments to
223 ;; Emerge commands.
226 "*If nil, default dir for filenames in emerge is `default-directory'.
227 If non-nil, filenames complete in the directory of the last argument of the
228 same type to an `emerge-files...' command."
261 ;; The flags used to mark differences in the buffers.
263 ;; These function definitions need to be up here, because they are used
264 ;; during loading.
266 "Function to be called after `emerge-{before,after}-flag'.
267 This is called after these functions are changed to compute values that
268 depend on the flags."
279 "Return the number of matches in STRING for REGEXP."
285 count))
287 ;; Calculate dependent variables
291 "*Number of lines that we want to show above and below the flags when we are
292 displaying a difference."
298 "*Prefix to put on Emerge temporary file names.
299 Do not start with `~/' or `~USERNAME/'."
304 "*Mode for Emerge temporary files."
310 "*Template for `emerge-combine-versions' to combine the two versions.
311 The template is inserted as a string, with the following interpolations:
312 %a the A version of the difference
313 %b the B version of the difference
314 %% the character `%'
315 Don't forget to end the template with a newline.
316 Note that this variable can be made local to a particular merge buffer by
317 giving a prefix argument to `emerge-set-combine-versions-template'."
321 ;; Build keymaps
324 "Keymap of Emerge commands.
325 Directly available in `fast' mode;
329 "Local keymap used in Emerge `fast' mode.
342 "*Command prefix for Emerge commands in `edit' mode.
343 Must be set before Emerge is loaded."
347 ;; This function sets up the fixed keymaps. It is executed when the first
348 ;; Emerge is done to allow the user maximum time to set up the global keymap.
350 ;; Set up the basic keymap
353 ; - to negative-argument
394 ;; Allow emerge-basic-keymap to be referenced indirectly
396 ;; Set up the fast mode keymap
398 ;; Allow prefixed commands to work in fast mode
400 ;; Allow emerge-fast-keymap to be referenced indirectly
402 ;; Suppress write-file and save-buffer
484 ;; Variables which control each merge. They are local to the merge buffer.
486 ;; Mode variables
500 "The buffer in which the ancestor variant is stored,
505 buffer-read-only
506 buffer-auto-save-file-name)
507 "Variables and properties of a buffer which are saved, modified and restored
518 "Vector of differences between the variants, and markers in the buffers to
519 show where they are. Each difference is represented by a vector of seven
520 elements. The first two are markers to the beginning and end of the difference
521 section in the A buffer, the second two are markers for the B buffer, the third
523 that difference in the merge buffer.
524 A section of a buffer is described by two markers, one to the beginning of
525 the first line of the section, and one to the beginning of the first line
526 after the section. (If the section is empty, both markers point to the same
527 point.) If the section is part of the selected difference, then the markers
528 are moved into the flags, so the user can edit the section without disturbing
529 the markers.
531 A the merge buffer currently contains the A variant
532 B the merge buffer currently contains the B variant
533 default-A the merge buffer contains the A variant by default,
534 but this difference hasn't been selected yet, so
535 change-default commands can alter it
536 default-B the merge buffer contains the B variant by default,
537 but this difference hasn't been selected yet, so
538 change-default commands can alter it
539 prefer-A in a three-file merge, the A variant is the preferred
540 choice
541 prefer-B in a three-file merge, the B variant is the preferred
548 "The local keymap for the merge buffer, with the emerge commands defined in
549 it. Used to save the local keymap during fast mode, when the local keymap is
554 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
557 "*If non-nil, differences for which there is a preference are automatically
560 "Hooks to run in the merge buffer after the merge has been finished.
561 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
562 command.
567 ;;; Setup functions for two-file mode.
570 output-file)
577 ;; Record the directories of the files
582 ;; Make sure the entire files are seen, and they reflect what is on disk
584 buffer-A
589 startup-hooks
591 startup-hooks))
592 ;; Verify that the file matches the buffer
595 buffer-B
600 startup-hooks
602 startup-hooks))
603 ;; Verify that the file matches the buffer
606 output-file)))
608 ;; Start up Emerge on two files
610 output-file)
615 ;; create the merge buffer from buffer A, so it inherits buffer A's
616 ;; default directory, etc.
618 buffer-A
621 merge-buffer
647 ;; Generate the Emerge difference list between two files
651 emerge-diff-buffer
655 emerge-diff-program emerge-diff-options
658 t))
661 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
667 diff-buffer
676 a-begin)))
684 b-begin))))
685 ;; fix the beginning and end numbers, because diff is somewhat
686 ;; strange about how it numbers lines
697 ;; (string-equal diff-type "c")
702 b-begin b-end
704 list)))))
707 ;; Set up buffer of diff/diff3 error messages.
711 emerge-diff-error-buffer
716 ;;; Top-level and setup functions for three-file mode.
719 &optional startup-hooks quit-hooks
720 output-file)
730 ;; Record the directories of the files
736 ;; Make sure the entire files are seen, and they reflect what is on disk
738 buffer-A
743 startup-hooks
745 startup-hooks))
746 ;; Verify that the file matches the buffer
749 buffer-B
754 startup-hooks
756 startup-hooks))
757 ;; Verify that the file matches the buffer
760 buffer-ancestor
765 startup-hooks
767 startup-hooks))
768 ;; Verify that the file matches the buffer
771 buffer-ancestor file-ancestor
772 startup-hooks quit-hooks output-file)))
774 ;; Start up Emerge on two files with an ancestor
776 buffer-ancestor file-ancestor
777 &optional startup-hooks quit-hooks
778 output-file)
784 ;; create the merge buffer from buffer A, so it inherits buffer A's
785 ;; default directory, etc.
787 buffer-A
790 merge-buffer
818 ;; Generate the Emerge difference list between two files with an ancestor
822 emerge-diff-buffer
826 emerge-diff3-program emerge-diff-options
830 t))
833 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
839 diff-buffer
841 ;; leave point after matched line
844 ;; if the A and B files are the same, ignore the difference
858 list))))))
862 ;; This save-excursion allows emerge-get-diff3-group to be called for the
863 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
864 ;; appear in any order. The reason this is necessary is that Gnu diff3
865 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
870 ;; treatment depends on whether it is an "a" group or a "c" group
872 ;; it is a "c" group
874 ;; it has two numbers
879 ;; it has one number
883 ;; it is an "a" group
888 ;;; Functions to start Emerge on files
890 ;;;###autoload
892 quit-hooks)
893 "Run Emerge on two files."
898 nil nil t))
902 f f nil)))))
906 file-A file-B startup-hooks
907 quit-hooks
908 file-out))
910 ;;;###autoload
913 "Run Emerge on two files, giving another file as the ancestor."
918 nil nil t))
921 nil f t)
924 f f nil)))))
928 file-A file-B file-ancestor startup-hooks
929 quit-hooks
930 file-out))
932 ;; Write the merge buffer out in place of the file the A buffer is visiting.
934 ;; if merge was successful was given, save to disk
938 ;;; Functions to start Emerge on buffers
940 ;;;###autoload
942 "Run Emerge on two buffers."
947 buffer-A
950 buffer-B
957 startup-hooks)
958 quit-hooks
959 nil)))
961 ;;;###autoload
963 &optional startup-hooks
964 quit-hooks)
965 "Run Emerge on two buffers, giving another buffer as the ancestor."
972 buffer-A
975 buffer-B
978 buffer-ancestor
984 emerge-file-ancestor
990 startup-hooks)
991 quit-hooks
992 nil)))
994 ;;; Functions to start Emerge from the command line
996 ;;;###autoload
1003 file-a file-b nil
1006 ;;;###autoload
1009 ;; check for a -a flag, for filemerge compatibility
1011 ;; arguments are "-a ancestor file-a file-b file-out"
1018 ;; arguments are "file-a file-b ancestor file-out"
1025 file-a file-b file-anc nil
1032 ;;; Functions to start Emerge via remote request
1034 ;;;###autoload
1038 file-a file-b nil
1040 file-out)
1043 ;;;###autoload
1047 file-a file-b file-anc nil
1049 file-out)
1057 ;;; Functions to start Emerge on RCS versions
1059 ;;;###autoload
1062 "Emerge two RCS revisions of a file."
1069 emerge-last-revision-B revision-B)
1071 file revision-A revision-B startup-hooks
1076 quit-hooks)
1077 quit-hooks)))
1079 ;;;###autoload
1081 revision-B ancestor
1082 &optional
1083 startup-hooks quit-hooks)
1084 "Emerge two RCS revisions of a file, with another revision as ancestor."
1092 emerge-last-revision-B revision-B
1093 emerge-last-revision-ancestor ancestor)
1095 file revision-A revision-B ancestor startup-hooks
1101 quit-hooks))
1102 quit-hooks)))
1105 startup-hooks quit-hooks output-file)
1110 ;; Get the revisions into buffers
1112 buffer-A
1116 t)
1120 buffer-B
1124 t)
1127 ;; Do the merge
1129 buffer-B emerge-file-B
1133 startup-hooks)
1135 quit-hooks)
1136 nil)))
1139 ancestor
1140 &optional startup-hooks
1141 quit-hooks output-file)
1148 ;; Get the revisions into buffers
1150 buffer-A
1154 revision-A file)
1155 t)
1159 buffer-B
1163 t)
1167 buffer-ancestor
1171 t)
1174 ;; Do the merge
1176 buffer-A emerge-file-A buffer-B emerge-file-B
1177 buffer-ancestor emerge-ancestor
1182 startup-hooks)
1184 quit-hooks)
1185 output-file)))
1187 ;;; Function to start Emerge based on a line in a file
1190 "Run Emerge using files named in current text line.
1191 Looks in that line for whitespace-separated entries of these forms:
1192 a=file1
1193 b=file2
1194 ancestor=file3
1195 output=file4
1196 to specify the files to use in Emerge.
1198 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1199 is present:
1200 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1201 it is assumed that the file in question has been deleted, and it is
1202 not copied to the output file.
1203 Otherwise, the A or B file present is copied to the output file."
1207 ;; Stop if at end of buffer (even though we might be in a line, if
1208 ;; the line does not end with newline)
1211 ;; Go to the beginning of the line
1213 ;; Skip any initial whitespace
1216 ;; Process the entire line
1218 ;; Get the next entry
1220 ;; Break apart the tab (before =) and the filename (after =)
1224 ;; Move point after the entry
1226 ;; Store the filename in the right variable
1246 ;; If the match on the entry pattern failed
1248 ;; Make sure that file-A and file-B are present
1253 ;; Go to the beginning of the next line, so next execution will use
1254 ;; next line in buffer.
1256 ;; Execute the correct command
1258 ;; Merge of two files with ancestor
1262 file-ancestor file-out
1263 nil
1264 ;; When done, return to this buffer.
1269 ;; Merge of two files without ancestor
1273 nil
1274 ;; When done, return to this buffer.
1279 ;; There is an output file (or there would have been an error above),
1280 ;; but only one input file.
1281 ;; The file appears to have been deleted in one version; do nothing.
1284 ;; The file should be copied from the version that contains it
1290 ;;; Sample function for creating information for emerge-execute-line
1293 "Regexp describing files to be processed by `emerge-merge-directories'."
1297 ;;;###autoload
1305 ;; Check that we're not on a line
1308 ;; Turn null strings into nil to indicate directories not used.
1313 ;; Canonicalize the directory names
1330 ;; Set the mark to where we start
1332 ;; Find out what files are in the directories.
1340 emerge-merge-directories-filename-regexp)))
1345 ;; Remove duplicates from all-files.
1351 ;; Generate the control lines for the various files.
1372 ;;; Common setup routines
1374 ;; Set up the window configuration. If POS is given, set the points to
1375 ;; the beginnings of the buffers.
1377 ;; Make sure we are not in the minibuffer window when we try to delete
1378 ;; all other windows.
1396 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1404 ;; Set up the keymap in the merge buffer
1406 ;; Set up fixed keymaps if necessary
1409 ;; Save the old local map
1411 ;; Construct the edit keymap
1415 ;; Install the Emerge commands
1420 ;; Create the additional menu bar items.
1428 ;; Suppress write-file and save-buffer
1430 'emerge-query-write-file
1431 emerge-edit-keymap)
1433 'emerge-query-save-buffer
1434 emerge-edit-keymap)
1444 "Record certain properties of the buffers being merged.
1445 Must be called in the merge buffer. Remembers read-only, modified,
1446 auto-save, and saves them in buffer local variables. Sets the buffers
1447 read-only and turns off `auto-save-mode'.
1448 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1449 ;; force auto-save, because we will turn off auto-saving in buffers for the
1450 ;; duration
1452 ;; remember and alter buffer characteristics
1455 emerge-A-buffer
1459 emerge-merging-values))))
1462 emerge-B-buffer
1466 emerge-merging-values)))))
1469 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1474 A-values))
1477 B-values))))
1479 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1480 ;; Return DESIRED-LINE.
1483 desired-line)
1486 B-buffer
1487 merge-buffer
1488 lineno-list)
1493 ;; Record current line number in each buffer
1494 ;; so we don't have to count from the beginning.
1501 a-begin-marker
1502 a-end-marker
1503 b-begin-marker
1504 b-end-marker
1505 merge-begin-marker
1506 merge-end-marker
1512 ;; place markers at the appropriate places in the buffers
1514 A-buffer
1520 B-buffer
1528 offset)
1529 merge-buffer))
1533 offset)
1534 merge-buffer))
1535 ;; record all the markers for this difference
1537 b-begin-marker b-end-marker
1538 merge-begin-marker merge-end-marker
1539 state)
1540 marker-list)))
1542 ;; convert the list of difference information into a vector for
1543 ;; fast access
1546 ;; If we have an ancestor, select all B variants that we prefer
1558 ;; Process the local-variables list at the end of the merged file, if
1559 ;; requested.
1567 ;;; Common exit routines
1570 ;; clear screen format
1572 ;; delete A, B, and ancestor buffers, if they haven't been changed
1580 ;; Write merge buffer to file
1584 ;;; Commands
1587 "Bring the highlighted region of all three merge buffers into view.
1588 This brings the buffers into view if they are in windows.
1589 With an argument, reestablish the default three-window display."
1591 ;; If there is an argument, rebuild the window structure
1594 emerge-merge-buffer))
1595 ;; Redisplay whatever buffers are showing, if there is a selected difference
1631 ;;; Window scrolling operations
1632 ;; These operations are designed to scroll all three windows the same amount,
1633 ;; so as to keep the text in them aligned.
1635 ;; Perform some operation on all three windows (if they are showing).
1636 ;; Catches all errors on the operation in the A and B windows, but not
1637 ;; in the merge window. Usually, errors come from scrolling off the
1638 ;; beginning or end of the buffer, and this gives a nice error message:
1639 ;; End of buffer is reported in the merge buffer, but if the scroll was
1640 ;; possible in the A or B windows, it is performed there before the error
1641 ;; is reported.
1664 "Scroll up all three merge buffers, if they are in windows.
1665 With argument N, scroll N lines; otherwise scroll by nearly
1666 the height of the merge window.
1667 `C-u -' alone as argument scrolls half the height of the merge window."
1670 'scroll-up
1671 ;; calculate argument to scroll-up
1672 ;; if there is an explicit argument
1674 ;; use it
1676 ;; if not, see if we can determine a default amount (the window height)
1679 ;; no window, use nil
1680 nil
1683 ;; the window was found
1685 ;; C-u as argument means half of default amount
1687 ;; no argument means default amount
1688 default-amount)))))))
1691 "Scroll down all three merge buffers, if they are in windows.
1692 With argument N, scroll N lines; otherwise scroll by nearly
1693 the height of the merge window.
1694 `C-u -' alone as argument scrolls half the height of the merge window."
1697 'scroll-down
1698 ;; calculate argument to scroll-down
1699 ;; if there is an explicit argument
1701 ;; use it
1703 ;; if not, see if we can determine a default amount (the window height)
1706 ;; no window, use nil
1707 nil
1710 ;; the window was found
1712 ;; C-u as argument means half of default amount
1714 ;; no argument means default amount
1715 default-amount)))))))
1718 "Scroll left all three merge buffers, if they are in windows.
1719 If an argument is given, that is how many columns are scrolled, else nearly
1720 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1721 width of the A and B windows."
1724 'scroll-left
1725 ;; calculate argument to scroll-left
1726 ;; if there is an explicit argument
1728 ;; use it
1730 ;; if not, see if we can determine a default amount
1731 ;; (half the window width)
1734 ;; no window, use nil
1735 nil
1738 ;; the window was found
1740 ;; C-u as argument means half of default amount
1742 ;; no argument means default amount
1743 default-amount)))))))
1746 "Scroll right all three merge buffers, if they are in windows.
1747 If an argument is given, that is how many columns are scrolled, else nearly
1748 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1749 width of the A and B windows."
1752 'scroll-right
1753 ;; calculate argument to scroll-right
1754 ;; if there is an explicit argument
1756 ;; use it
1758 ;; if not, see if we can determine a default amount
1759 ;; (half the window width)
1762 ;; no window, use nil
1763 nil
1766 ;; the window was found
1768 ;; C-u as argument means half of default amount
1770 ;; no argument means default amount
1771 default-amount)))))))
1774 "Reset horizontal scrolling in Emerge.
1775 This resets the horizontal scrolling of all three merge buffers
1776 to the left margin, if they are in windows."
1780 nil))
1782 ;; Attempt to show the region nicely.
1783 ;; If there are min-lines lines above and below the region, then don't do
1784 ;; anything.
1785 ;; If not, recenter the region to make it so.
1786 ;; If that isn't possible, remove context lines balancedly from top and bottom
1787 ;; so the entire region shows.
1788 ;; If that isn't possible, show the top of the region.
1789 ;; BEG must be at the beginning of a line.
1791 ;; First test whether the entire region is visible with
1792 ;; emerge-min-visible-lines above and below it
1796 beg)
1801 ;; We failed that test, see if it fits at all
1802 ;; Meanwhile positioning it correctly in case it doesn't fit
1806 ;; Determine the number of lines that the region occupies
1812 ;; And position the beginning on the right line
1815 lines))
1820 "Advance to the next difference."
1834 "Go to the previous difference."
1848 "Go to the N-th difference."
1858 "Abort the Emerge session."
1863 "Finish the Emerge session and exit Emerge.
1864 Prefix argument means to abort rather than successfully finish.
1865 The difference depends on how the merge was started,
1866 but usually means to not write over one of the original files, or to signal
1867 to some process which invoked Emerge a failure code.
1869 Unselects the selected difference, if any, restores the read-only and modified
1870 flags of the merged file buffers, restores the local keymap of the merge
1871 buffer, and sets off various emerge flags. Using Emerge commands in this
1872 buffer after this will cause serious problems."
1877 "Do you really want to successfully finish this merge? "
1882 ;; Perform the quit operations.
1887 ;; null out the difference markers so they don't slow down future editing
1888 ;; operations
1896 emerge-difference-list)
1897 ;; allow them to be garbage collected
1899 ;; restore the local map
1901 ;; turn off all the emerge modes
1907 ;; restore mode line
1913 "Select the A variant of this difference.
1914 Refuses to function if this difference has been edited, i.e., if it
1915 is neither the A nor the B variant.
1916 A prefix argument forces the variant to be selected
1917 even if the difference has been edited."
1930 ;; Actually select the A variant
1933 emerge-merge-buffer
1942 "Select the B variant of this difference.
1943 Refuses to function if this difference has been edited, i.e., if it
1944 is neither the A nor the B variant.
1945 A prefix argument forces the variant to be selected
1946 even if the difference has been edited."
1959 ;; Actually select the B variant
1962 emerge-merge-buffer
1971 "Make the A variant the default from here down.
1972 This selects the A variant for all differences from here down in the buffer
1973 which are still defaulted, i.e., which the user has not selected and for
1974 which there is no preference."
1993 "Make the B variant the default from here down.
1994 This selects the B variant for all differences from here down in the buffer
1995 which are still defaulted, i.e., which the user has not selected and for
1996 which there is no preference."
2015 "Set fast mode, for Emerge.
2016 In this mode ordinary Emacs commands are disabled, and Emerge commands
2028 "Set edit mode, for Emerge.
2029 In this mode ordinary Emacs commands are available, and Emerge commands
2041 "Toggle Auto-Advance mode, for Emerge.
2042 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2043 advance to the next difference.
2044 With a positive argument, turn on Auto-Advance mode.
2045 With a negative argument, turn off Auto-Advance mode."
2051 "Auto-advance set"
2056 "Toggle Skip-Prefers mode, for Emerge.
2057 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2058 to automatically skip over differences for which there is a preference.
2059 With a positive argument, turn on Skip-Prefers mode.
2060 With a negative argument, turn off Skip-Prefers mode."
2066 "Skip-prefers set"
2071 "Put the A variant of this difference in the kill ring."
2078 ;; so further kills don't append
2079 this-command)
2085 "Put the B variant of this difference in the kill ring."
2092 ;; so further kills don't append
2093 this-command)
2099 "Insert the A variant of this difference at the point.
2100 Leaves point after text, mark before.
2101 With prefix argument, puts point before, mark after."
2117 "Insert the B variant of this difference at the point.
2118 Leaves point after text, mark before.
2119 With prefix argument, puts point before, mark after."
2135 "Leaves the point before this difference and the mark after it.
2136 With prefix argument, puts mark before, point after."
2151 "Show the names of the buffers or files being operated on by Emerge.
2152 Use C-u l to reset the windows afterward."
2195 "Join the selected difference with the following one.
2196 With a prefix argument, join with the preceding one."
2199 ;; adjust n to be first difference to join
2202 ;; n and n+1 are the differences to join
2203 ;; check that they are both differences
2206 ;; remove the flags
2208 ;; decrement total number of differences
2210 ;; build new differences vector
2230 ps)
2237 ;; set the current difference correctly
2239 ;; fix the mode line
2241 ;; reinsert the flags
2246 "Split the current difference where the points are in the three windows."
2249 ;; check that this is a valid difference
2251 ;; get the point values and old difference
2258 ;; check location of the points, give error if they aren't in the
2259 ;; differences
2269 ;; remove the flags
2271 ;; increment total number of differences
2273 ;; build new differences vector
2285 A-point
2287 B-point
2289 merge-point
2301 ;; set the current difference correctly
2303 ;; fix the mode line
2305 ;; reinsert the flags
2310 "Trim lines off top and bottom of difference that are the same.
2311 If lines are the same in both the A and the B versions, strip them off.
2312 \(This can happen when the A and B versions have common lines that the
2313 ancestor version does not share.)"
2315 ;; make sure we are in a real difference
2317 ;; remove the flags
2326 size success sa sb sm)
2327 ;; move down the tops of the difference regions as much as possible
2328 ;; Try advancing comparing 1000 chars at a time.
2329 ;; When that fails, go 500 chars at a time, and so on.
2349 ;; move up the bottoms of the difference regions as much as possible
2350 ;; Try advancing comparing 1000 chars at a time.
2351 ;; When that fails, go 500 chars at a time, and so on.
2360 bottom-a)))
2363 bottom-b)))
2371 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2372 ;; of the difference regions. Move them to the beginning of lines, as
2373 ;; appropriate.
2394 ;; put the flags back in, recenter the display
2399 "Find the difference containing the current position of the point.
2400 If there is no containing difference and the prefix argument is positive,
2401 it finds the nearest following difference. A negative prefix argument finds
2402 the nearest previous difference."
2411 "Find the difference containing point, in the merge buffer.
2412 If there is no containing difference and the prefix argument is positive,
2413 it finds the nearest following difference. A negative prefix argument finds
2414 the nearest previous difference."
2416 ;; search for the point in the merge buffer, using the markers
2417 ;; for the beginning and end of the differences in the merge buffer
2421 "Find the difference containing point, in the A buffer.
2422 This command must be executed in the merge buffer.
2423 If there is no containing difference and the prefix argument is positive,
2424 it finds the nearest following difference. A negative prefix argument finds
2425 the nearest previous difference."
2427 ;; search for the point in the A buffer, using the markers
2428 ;; for the beginning and end of the differences in the A buffer
2434 "Find the difference containing point, in the B buffer.
2435 This command must be executed in the merge buffer.
2436 If there is no containing difference and the prefix argument is positive,
2437 it finds the nearest following difference. A negative prefix argument finds
2438 the nearest previous difference."
2440 ;; search for the point in the B buffer, using the markers
2441 ;; for the beginning and end of the differences in the B buffer
2448 ;; find first difference containing or after the current position
2456 emerge-number-of-differences))
2458 ;; whether the found difference contains the current position
2461 begin))
2462 location)))
2464 ;; numeric value of prefix argument
2468 ;; if the point is in a difference, select it
2470 ;; if the arg is nil and the point is not in a difference, error
2472 ;; if the arg is positive, select the following difference
2475 index
2477 ;; if the arg is negative, select the preceding difference
2484 "Display the current line numbers.
2485 This function displays the line numbers of the points in the A, B, and
2486 merge buffers."
2499 merge-line A-line B-line)))
2512 temp))
2515 "Set `emerge-combine-versions-template' to STRING.
2516 This value controls how `emerge-combine-versions' combines the two versions.
2517 With prefix argument, `emerge-combine-versions-template' is made local to this
2518 merge buffer. Localization is permanent for any particular merge buffer."
2525 "emerge-set-combine-versions-template set locally"
2529 "Copy region into `emerge-combine-versions-template'.
2530 This controls how `emerge-combine-versions' will combine the two versions.
2531 With prefix argument, `emerge-combine-versions-template' is made local to this
2532 merge buffer. Localization is permanent for any particular merge buffer."
2539 "emerge-set-combine-versions-template set locally."
2543 "Combine versions using the template in `emerge-combine-versions-template'.
2544 Refuses to function if this difference has been edited, i.e., if it is
2545 neither the A nor the B variant.
2546 An argument forces the variant to be selected even if the difference has
2547 been edited."
2552 "Combine the two versions using the template in register REG.
2553 See documentation of the variable `emerge-combine-versions-template'
2554 for how the template is interpreted.
2555 Refuses to function if this difference has been edited, i.e., if it is
2556 neither the A nor the B variant.
2557 An argument forces the variant to be selected even if the difference has
2558 been edited."
2569 A-begin A-end B-begin B-end)
2575 A-begin A-end B-begin B-end)
2577 emerge-merge-buffer
2605 "Set the major mode in a merge buffer.
2606 Overrides any change that the mode might make to the mode line or local
2607 keymap. Leaves merge in fast mode."
2622 ;;; Support routines
2624 ;; Select a difference by placing the visual flags around the appropriate
2625 ;; group of lines in the A, B, and merge buffers
2635 after-index)
2638 buffer
2644 ;; insert the flag before the difference
2646 before-index))
2647 here)
2649 ;; insert the flag itself
2652 ;; Put the marker(s) referring to this position 1 character before the
2653 ;; end of the flag, so it won't be damaged by the user.
2654 ;; This gets a bit tricky, as there could be a number of markers
2655 ;; that have to be moved.
2669 ;; insert the flag after the difference
2671 after-index))
2674 ;; insert the flag itself
2676 ;; Put the marker(s) referring to this position 1 character after the
2677 ;; beginning of the flag, so it won't be damaged by the user.
2678 ;; This gets a bit tricky, as there could be a number of markers
2679 ;; that have to be moved.
2694 ;; Unselect a difference by removing the visual flags in the buffers.
2707 buffer
2709 ;; remove the flags, if they're there
2713 ;; the flag isn't there
2719 ;; the flag isn't there
2723 ;; Select a difference, removing any flags that exist now.
2743 ;; Perform tests to see whether user should be allowed to select a version
2744 ;; of this difference:
2745 ;; a valid difference has been selected; and
2746 ;; the difference text in the merge buffer is:
2747 ;; the A version (execute a-version), or
2748 ;; the B version (execute b-version), or
2749 ;; empty (execute neither-version), or
2750 ;; argument FORCE is true (execute neither-version)
2751 ;; Otherwise, signal an error.
2764 emerge-merge-buffer merge-begin
2765 merge-end)
2768 emerge-merge-buffer merge-begin
2769 merge-end)
2775 ;; Read a file name, handling all of the various defaulting rules.
2778 A-file must-match)
2779 ;; `prompt' should not have trailing ": ", so that it can be modified
2780 ;; according to context.
2781 ;; If alternative-default-dir is non-nil, it should be used as the default
2782 ;; directory instead if default-directory, if emerge-default-last-directories
2783 ;; is set.
2784 ;; If default-file is set, it should be used as the default value.
2785 ;; If A-file is set, and its directory is different from
2786 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2787 ;; the default file should be the last part of A-file in the default
2788 ;; directory. (Overriding default-file.)
2790 ;; If this is not the A-file argument (shown by non-nil A-file), and
2791 ;; if emerge-default-last-directories is set, and
2792 ;; the default directory exists but is not the same as the directory of the
2793 ;; A-file,
2794 ;; then make the default file have the same name as the A-file, but in
2795 ;; the default directory.
2797 A-file
2798 alternative-default-dir
2803 alternative-default-dir
2807 ;; If there is a default file, use it.
2810 ;; If emerge-default-last-directories is set, use the
2811 ;; directory from the same argument of the last call of
2812 ;; Emerge as the default for this argument.
2814 alternative-default-dir)
2818 ;; If emerge-default-last-directories is set, use the
2819 ;; directory from the same argument of the last call of
2820 ;; Emerge as the default for this argument.
2822 alternative-default-dir)
2825 ;; Revise the mode line to display which difference we have selected
2831 emerge-number-of-differences
2833 (< emerge-current-difference
2834 emerge-number-of-differences))
2836 emerge-current-difference)
2846 ;; compare two regions in two buffers for containing the same text
2848 ;; first check that the two regions are the same length
2850 nil
2853 ;; bite off and compare no more than 1000 characters at a time
2856 buffer-x
2860 buffer-y
2867 t)))
2869 ;; Construct a unique buffer name.
2870 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2871 ;; prefix<3>suffix, etc.
2880 ;; Verify that we have a difference selected.
2886 ;;; Functions for saving and restoring a batch of variables
2888 ;; These functions save (get the values of) and restore (set the values of)
2889 ;; a list of variables. The argument is a list of symbols (the names of
2890 ;; the variables). A list element can also be a list of two functions,
2891 ;; the first of which (when called with no arguments) gets the value, and
2892 ;; the second (when called with a value as an argument) sets the value.
2893 ;; A "function" is anything that funcall can handle as an argument.
2899 vars))
2911 ;; Make a temporary file that only we have access to.
2912 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2920 f))
2922 ;;; Functions that query the user before he can write out the current buffer.
2925 "Ask the user whether to write out an incomplete merge.
2926 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2927 for details of the querying process."
2932 "Ask the user whether to save an incomplete merge.
2933 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2934 for details of the querying process."
2939 "Ask the user whether to save or write out the incomplete merge.
2940 If answer is yes, call COMMAND interactively. During the call, the flags
2941 around the current difference are removed."
2943 ;; He really wants to do it -- unselect the difference for the duration
2948 ;; call-interactively takes the value of current-prefix-arg as the
2949 ;; prefix argument value to be passed to the command. Thus, we have
2950 ;; to do nothing special to make sure the prefix argument is
2951 ;; transmitted to the command.
2958 ;; He's being smart and not doing it
2961 ;; Make sure the current buffer (for a file) has the same contents as the
2962 ;; file on disk, and attempt to remedy the situation if not.
2963 ;; Signal an error if we can't make them the same, or the user doesn't want
2964 ;; to do what is necessary to make them the same.
2966 ;; First check if the file has been modified since the buffer visited it.
2969 ;; If buffer is not obsolete and is modified, offer to save
2973 ;; If buffer is not obsolete and is not modified, do nothing
2974 nil)
2976 ;; If buffer is obsolete and is modified, give error
2978 ;; If buffer is obsolete and is not modified, offer to revert
2982 \f
2983 ;; Utilities that might have value outside of Emerge.
2985 ;; Set up the mode in the current buffer to duplicate the mode in another
2986 ;; buffer.
2988 ;; Set the major mode
2991 ;; Define a key, even if a prefix of it is defined
2993 "Like `define-key', but forcibly creates prefix characters as needed.
2994 If some prefix of KEY has a non-prefix definition, it is redefined."
2995 ;; Find out if a prefix of key is defined
2997 ;; If so, undefine it
3000 ;; Now define the key
3003 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
3004 ;;;;; as the major mode
3005 ;;(defun describe-mode (&optional minor)
3006 ;; "Display documentation of current major mode.
3007 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
3008 ;;display documentation of active minor modes as well.
3009 ;;For this to work correctly for a minor mode, the mode's indicator variable
3010 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
3011 ;;describes the minor mode."
3012 ;; (interactive)
3013 ;; (with-output-to-temp-buffer "*Help*"
3014 ;; (princ mode-name)
3015 ;; (princ " Mode:\n")
3016 ;; (princ (documentation major-mode))
3017 ;; (let ((minor-modes minor-mode-alist)
3018 ;; (locals (buffer-local-variables)))
3019 ;; (while minor-modes
3020 ;; (let* ((minor-mode (car (car minor-modes)))
3021 ;; (indicator (car (cdr (car minor-modes))))
3022 ;; (local-binding (assq minor-mode locals)))
3023 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
3024 ;; ;; bound locally in this buffer, non-nil, and has a function
3025 ;; ;; definition.
3026 ;; (if (and local-binding
3027 ;; (cdr local-binding)
3028 ;; (fboundp minor-mode))
3029 ;; (progn
3030 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3031 ;; minor-mode indicator))
3032 ;; (princ (documentation minor-mode)))))
3033 ;; (setq minor-modes (cdr minor-modes))))
3034 ;; (save-excursion
3035 ;; (set-buffer standard-output)
3036 ;; (help-mode))
3037 ;; (print-help-return-message)))
3039 ;; This goes with the redefinition of describe-mode.
3040 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3041 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3043 ;; substitute-key-definition should work now.
3044 ;;;; Function to shadow a definition in a keymap with definitions in another.
3045 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3046 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3047 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3048 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3049 ;;including those whose definition is OLDDEF."
3050 ;; ;; loop through all keymaps accessible from keymap
3051 ;; (let ((maps (accessible-keymaps keymap)))
3052 ;; (while maps
3053 ;; (let ((prefix (car (car maps)))
3054 ;; (map (cdr (car maps))))
3055 ;; ;; examine a keymap
3056 ;; (if (arrayp map)
3057 ;; ;; array keymap
3058 ;; (let ((len (length map))
3059 ;; (i 0))
3060 ;; (while (< i len)
3061 ;; (if (eq (aref map i) olddef)
3062 ;; ;; set the shadowing definition
3063 ;; (let ((key (concat prefix (char-to-string i))))
3064 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3065 ;; (setq i (1+ i))))
3066 ;; ;; sparse keymap
3067 ;; (while map
3068 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3069 ;; ;; set the shadowing definition
3070 ;; (let ((key
3071 ;; (concat prefix (char-to-string (car (car map))))))
3072 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3073 ;; (setq map (cdr map)))))
3074 ;; (setq maps (cdr maps)))))
3076 ;; Define a key if it (or a prefix) is not already defined in the map.
3078 ;; look up the present definition of the key
3081 ;; if it is "too long", look up the valid prefix
3083 ;; if the prefix isn't defined, define it
3085 ;; if there is no present definition, define it
3089 ;; Ordinary substitute-key-definition should do this now.
3090 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3091 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3092 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3093 ;;\(`copy-keymap' will suffice.)"
3094 ;; ;; Loop through all keymaps accessible from keymap
3095 ;; (let ((maps (accessible-keymaps keymap)))
3096 ;; (while maps
3097 ;; ;; Substitute in this keymap
3098 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3099 ;; (setq maps (cdr maps)))))
3101 ;; Show the name of the file in the buffer.
3103 "Displays the name of the file loaded into the current buffer.
3104 If the name won't fit on one line, the minibuffer is expanded to hold it,
3105 and the command waits for a keystroke from the user. If the keystroke is
3106 SPC, it is ignored; if it is anything else, it is processed as a command."
3124 ;; Improved auto-save file names.
3125 ;; This function fixes many problems with the standard auto-save file names:
3126 ;; Auto-save files for non-file buffers get put in the default directory
3127 ;; for the buffer, whether that makes sense or not.
3128 ;; Auto-save files for file buffers get put in the directory of the file,
3129 ;; regardless of whether we can write into it or not.
3130 ;; Auto-save files for non-file buffers don't use the process id, so if a
3131 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3132 ;; each other.
3133 ;; To use this function, do:
3134 ;; (fset 'make-auto-save-file-name
3135 ;; (symbol-function 'emerge-make-auto-save-file-name))
3137 "Return file name to use for auto-saves of current buffer.
3138 Does not consider `auto-save-visited-file-name';
3139 that is checked before calling this function.
3140 You can redefine this for customization.
3141 See also `auto-save-file-name-p'."
3143 ;; if buffer has a file, try the format <file directory>/#<file name>#
3145 "#"
3149 ;; the file is writable, so use it
3150 f
3151 ;; the file isn't writable, so use the format
3152 ;; ~/#&<file name>&<hash of directory>#
3154 "/#&"
3156 "&"
3160 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3162 "/#%"
3163 ;; quote / into \! and \ into \\
3165 "%"
3169 ;; Hash a string into five characters more-or-less suitable for use in a file
3170 ;; name. (Allowed characters are ! through ~, except /.)
3186 ;; Quote any /s in a string by replacing them with \!.
3187 ;; Also, replace any \s by \\, to make it one-to-one.
3199 s)
3201 ;; Metacharacters that have to be protected from the shell when executing
3202 ;; a diff/diff3 command.
3205 More precisely, a [...] regexp to match any one such character."
3209 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3217 s)
3221 ;;; emerge.el ends here