| blob | 5435a840ac9b1ddb6c86ab100e9db17bd25500f7 |
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 `preserved' 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:
82 "Return string describing the version of Emerge.
83 When called interactively, displays the version."
87 emacs-version))
91 ;;; Emerge configuration variables
94 "Merge diffs under Emacs control."
97 ;; Commands that produce difference files
98 ;; All that can be configured is the name of the programs to execute
99 ;; (emerge-diff-program and emerge-diff3-program) and the options
100 ;; to be provided (emerge-diff-options). The order in which the file names
101 ;; are given is fixed.
102 ;; The file names are always expanded (see expand-file-name) before being
103 ;; passed to diff, thus they need not be invoked under a shell that
104 ;; understands `~'.
105 ;; The code which processes the diff/diff3 output depends on all the
106 ;; finicky details of their output, including the somewhat strange
107 ;; way they number lines of a file.
109 "Name of the program which compares two files."
113 "Name of the program which compares three files.
114 Its arguments are the ancestor file and the two variant files."
118 "Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
124 "Pattern to match lines produced by diff that describe differences.
125 This is as opposed to lines from the source files."
130 "Regexp that matches normal output lines from `emerge-diff-program'.
131 Lines that do not match are assumed to be error messages."
136 "Regexp that matches normal output lines from `emerge-diff3-program'.
137 Lines that do not match are assumed to be error messages."
142 "Name of the program that checks in RCS revisions."
146 "Name of the program that checks out RCS revisions."
151 "Non-nil if Emerge should process local-variables lists in merge buffers.
152 \(You can explicitly request processing the local-variables
153 by executing `(hack-local-variables)'.)"
157 "If non-nil: `emerge-execute-line' makes no output if an input was deleted.
158 It concludes that an input version has been deleted when an ancestor entry
159 is present, only one A or B entry is present, and an output entry is present.
160 If nil: In such circumstances, the A or B file that is present will be
161 copied to the designated output file."
166 "Flag placed above the highlighted block of code. Must end with newline.
167 Must be set before Emerge is loaded, or emerge-new-flags must be run
168 after setting."
172 "Flag placed below the highlighted block of code. Must end with newline.
173 Must be set before Emerge is loaded, or emerge-new-flags must be run
174 after setting."
178 ;; Hook variables
181 "Hook to run in the merge buffer after the merge has been set up."
185 "Hook to run after a difference has been selected.
186 The variable `n' holds the (internal) number of the difference."
190 "Hook to run after a difference has been unselected.
191 The variable `n' holds the (internal) number of the difference."
195 ;; Variables to control the default directories of the arguments to
196 ;; Emerge commands.
199 "If nil, default dir for filenames in emerge is `default-directory'.
200 If non-nil, filenames complete in the directory of the last argument of the
201 same type to an `emerge-files...' command."
234 ;; The flags used to mark differences in the buffers.
236 ;; These function definitions need to be up here, because they are used
237 ;; during loading.
239 "Function to be called after `emerge-{before,after}-flag'.
240 This is called after these functions are changed to compute values that
241 depend on the flags."
252 "Return the number of matches in STRING for REGEXP."
258 count))
260 ;; Calculate dependent variables
264 "Number of lines that we want to show above and below the flags when we are
265 displaying a difference."
271 "Prefix to put on Emerge temporary file names.
272 Do not start with `~/' or `~USERNAME/'."
277 "Mode for Emerge temporary files."
283 "Template for `emerge-combine-versions' to combine the two versions.
284 The template is inserted as a string, with the following interpolations:
285 %a the A version of the difference
286 %b the B version of the difference
287 %% the character `%'
288 Don't forget to end the template with a newline.
289 Note that this variable can be made local to a particular merge buffer by
290 giving a prefix argument to `emerge-set-combine-versions-template'."
294 ;; Build keymaps
297 "Keymap of Emerge commands.
298 Directly available in `fast' mode;
302 "Local keymap used in Emerge `fast' mode.
315 "Command prefix for Emerge commands in `edit' mode.
316 Must be set before Emerge is loaded."
320 ;; This function sets up the fixed keymaps. It is executed when the first
321 ;; Emerge is done to allow the user maximum time to set up the global keymap.
323 ;; Set up the basic keymap
326 ; - to negative-argument
367 ;; Allow emerge-basic-keymap to be referenced indirectly
369 ;; Set up the fast mode keymap
371 ;; Allow prefixed commands to work in fast mode
373 ;; Allow emerge-fast-keymap to be referenced indirectly
375 ;; Suppress write-file and save-buffer
457 ;; Variables which control each merge. They are local to the merge buffer.
459 ;; Mode variables
473 "The buffer in which the ancestor variant is stored,
478 buffer-read-only
479 buffer-auto-save-file-name)
480 "Variables and properties of a buffer which are saved, modified and restored
491 "Vector of differences between the variants, and markers in the buffers to
492 show where they are. Each difference is represented by a vector of seven
493 elements. The first two are markers to the beginning and end of the difference
494 section in the A buffer, the second two are markers for the B buffer, the third
496 that difference in the merge buffer.
497 A section of a buffer is described by two markers, one to the beginning of
498 the first line of the section, and one to the beginning of the first line
499 after the section. (If the section is empty, both markers point to the same
500 point.) If the section is part of the selected difference, then the markers
501 are moved into the flags, so the user can edit the section without disturbing
502 the markers.
504 A the merge buffer currently contains the A variant
505 B the merge buffer currently contains the B variant
506 default-A the merge buffer contains the A variant by default,
507 but this difference hasn't been selected yet, so
508 change-default commands can alter it
509 default-B the merge buffer contains the B variant by default,
510 but this difference hasn't been selected yet, so
511 change-default commands can alter it
512 prefer-A in a three-file merge, the A variant is the preferred
513 choice
514 prefer-B in a three-file merge, the B variant is the preferred
521 "The local keymap for the merge buffer, with the emerge commands defined in
522 it. Used to save the local keymap during fast mode, when the local keymap is
527 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
530 "*If non-nil, differences for which there is a preference are automatically
533 "Hooks to run in the merge buffer after the merge has been finished.
534 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
535 command.
540 ;;; Setup functions for two-file mode.
543 output-file)
550 ;; Record the directories of the files
555 ;; Make sure the entire files are seen, and they reflect what is on disk
557 buffer-A
562 startup-hooks
564 startup-hooks))
565 ;; Verify that the file matches the buffer
568 buffer-B
573 startup-hooks
575 startup-hooks))
576 ;; Verify that the file matches the buffer
579 output-file)))
581 ;; Start up Emerge on two files
583 output-file)
588 ;; create the merge buffer from buffer A, so it inherits buffer A's
589 ;; default directory, etc.
591 buffer-A
594 merge-buffer
620 ;; Generate the Emerge difference list between two files
624 emerge-diff-buffer
628 emerge-diff-program emerge-diff-options
631 t))
634 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
640 diff-buffer
649 a-begin)))
657 b-begin))))
658 ;; fix the beginning and end numbers, because diff is somewhat
659 ;; strange about how it numbers lines
670 ;; (string-equal diff-type "c")
675 b-begin b-end
677 list)))))
680 ;; Set up buffer of diff/diff3 error messages.
684 emerge-diff-error-buffer
689 ;;; Top-level and setup functions for three-file mode.
692 &optional startup-hooks quit-hooks
693 output-file)
703 ;; Record the directories of the files
709 ;; Make sure the entire files are seen, and they reflect what is on disk
711 buffer-A
716 startup-hooks
718 startup-hooks))
719 ;; Verify that the file matches the buffer
722 buffer-B
727 startup-hooks
729 startup-hooks))
730 ;; Verify that the file matches the buffer
733 buffer-ancestor
738 startup-hooks
740 startup-hooks))
741 ;; Verify that the file matches the buffer
744 buffer-ancestor file-ancestor
745 startup-hooks quit-hooks output-file)))
747 ;; Start up Emerge on two files with an ancestor
749 buffer-ancestor file-ancestor
750 &optional startup-hooks quit-hooks
751 output-file)
757 ;; create the merge buffer from buffer A, so it inherits buffer A's
758 ;; default directory, etc.
760 buffer-A
763 merge-buffer
791 ;; Generate the Emerge difference list between two files with an ancestor
795 emerge-diff-buffer
799 emerge-diff3-program emerge-diff-options
803 t))
806 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
812 diff-buffer
814 ;; leave point after matched line
817 ;; if the A and B files are the same, ignore the difference
831 list))))))
835 ;; This save-excursion allows emerge-get-diff3-group to be called for the
836 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
837 ;; appear in any order. The reason this is necessary is that Gnu diff3
838 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
843 ;; treatment depends on whether it is an "a" group or a "c" group
845 ;; it is a "c" group
847 ;; it has two numbers
852 ;; it has one number
856 ;; it is an "a" group
861 ;;; Functions to start Emerge on files
863 ;;;###autoload
865 quit-hooks)
866 "Run Emerge on two files."
871 nil nil t))
875 f f nil)))))
879 file-A file-B startup-hooks
880 quit-hooks
881 file-out))
883 ;;;###autoload
886 "Run Emerge on two files, giving another file as the ancestor."
891 nil nil t))
894 nil f t)
897 f f nil)))))
901 file-A file-B file-ancestor startup-hooks
902 quit-hooks
903 file-out))
905 ;; Write the merge buffer out in place of the file the A buffer is visiting.
907 ;; if merge was successful was given, save to disk
911 ;;; Functions to start Emerge on buffers
913 ;;;###autoload
915 "Run Emerge on two buffers."
920 buffer-A
923 buffer-B
930 startup-hooks)
931 quit-hooks
932 nil)))
934 ;;;###autoload
936 &optional startup-hooks
937 quit-hooks)
938 "Run Emerge on two buffers, giving another buffer as the ancestor."
945 buffer-A
948 buffer-B
951 buffer-ancestor
957 emerge-file-ancestor
963 startup-hooks)
964 quit-hooks
965 nil)))
967 ;;; Functions to start Emerge from the command line
969 ;;;###autoload
976 file-a file-b nil
979 ;;;###autoload
982 ;; check for a -a flag, for filemerge compatibility
984 ;; arguments are "-a ancestor file-a file-b file-out"
991 ;; arguments are "file-a file-b ancestor file-out"
998 file-a file-b file-anc nil
1005 ;;; Functions to start Emerge via remote request
1007 ;;;###autoload
1011 file-a file-b nil
1013 file-out)
1016 ;;;###autoload
1020 file-a file-b file-anc nil
1022 file-out)
1030 ;;; Functions to start Emerge on RCS versions
1032 ;;;###autoload
1035 "Emerge two RCS revisions of a file."
1042 emerge-last-revision-B revision-B)
1044 file revision-A revision-B startup-hooks
1049 quit-hooks)
1050 quit-hooks)))
1052 ;;;###autoload
1054 revision-B ancestor
1055 &optional
1056 startup-hooks quit-hooks)
1057 "Emerge two RCS revisions of a file, with another revision as ancestor."
1065 emerge-last-revision-B revision-B
1066 emerge-last-revision-ancestor ancestor)
1068 file revision-A revision-B ancestor startup-hooks
1074 quit-hooks))
1075 quit-hooks)))
1078 startup-hooks quit-hooks output-file)
1083 ;; Get the revisions into buffers
1085 buffer-A
1089 t)
1093 buffer-B
1097 t)
1100 ;; Do the merge
1102 buffer-B emerge-file-B
1106 startup-hooks)
1108 quit-hooks)
1109 nil)))
1112 ancestor
1113 &optional startup-hooks
1114 quit-hooks output-file)
1121 ;; Get the revisions into buffers
1123 buffer-A
1127 revision-A file)
1128 t)
1132 buffer-B
1136 t)
1140 buffer-ancestor
1144 t)
1147 ;; Do the merge
1149 buffer-A emerge-file-A buffer-B emerge-file-B
1150 buffer-ancestor emerge-ancestor
1155 startup-hooks)
1157 quit-hooks)
1158 output-file)))
1160 ;;; Function to start Emerge based on a line in a file
1163 "Run Emerge using files named in current text line.
1164 Looks in that line for whitespace-separated entries of these forms:
1165 a=file1
1166 b=file2
1167 ancestor=file3
1168 output=file4
1169 to specify the files to use in Emerge.
1171 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1172 is present:
1173 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1174 it is assumed that the file in question has been deleted, and it is
1175 not copied to the output file.
1176 Otherwise, the A or B file present is copied to the output file."
1180 ;; Stop if at end of buffer (even though we might be in a line, if
1181 ;; the line does not end with newline)
1184 ;; Go to the beginning of the line
1186 ;; Skip any initial whitespace
1189 ;; Process the entire line
1191 ;; Get the next entry
1193 ;; Break apart the tab (before =) and the filename (after =)
1197 ;; Move point after the entry
1199 ;; Store the filename in the right variable
1219 ;; If the match on the entry pattern failed
1221 ;; Make sure that file-A and file-B are present
1226 ;; Go to the beginning of the next line, so next execution will use
1227 ;; next line in buffer.
1229 ;; Execute the correct command
1231 ;; Merge of two files with ancestor
1235 file-ancestor file-out
1236 nil
1237 ;; When done, return to this buffer.
1242 ;; Merge of two files without ancestor
1246 nil
1247 ;; When done, return to this buffer.
1252 ;; There is an output file (or there would have been an error above),
1253 ;; but only one input file.
1254 ;; The file appears to have been deleted in one version; do nothing.
1257 ;; The file should be copied from the version that contains it
1263 ;;; Sample function for creating information for emerge-execute-line
1266 "Regexp describing files to be processed by `emerge-merge-directories'."
1270 ;;;###autoload
1278 ;; Check that we're not on a line
1281 ;; Turn null strings into nil to indicate directories not used.
1286 ;; Canonicalize the directory names
1303 ;; Set the mark to where we start
1305 ;; Find out what files are in the directories.
1313 emerge-merge-directories-filename-regexp)))
1318 ;; Remove duplicates from all-files.
1324 ;; Generate the control lines for the various files.
1345 ;;; Common setup routines
1347 ;; Set up the window configuration. If POS is given, set the points to
1348 ;; the beginnings of the buffers.
1350 ;; Make sure we are not in the minibuffer window when we try to delete
1351 ;; all other windows.
1369 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1377 ;; Set up the keymap in the merge buffer
1379 ;; Set up fixed keymaps if necessary
1382 ;; Save the old local map
1384 ;; Construct the edit keymap
1388 ;; Install the Emerge commands
1393 ;; Create the additional menu bar items.
1401 ;; Suppress write-file and save-buffer
1403 'emerge-query-write-file
1404 emerge-edit-keymap)
1406 'emerge-query-save-buffer
1407 emerge-edit-keymap)
1415 "Record certain properties of the buffers being merged.
1416 Must be called in the merge buffer. Remembers read-only, modified,
1417 auto-save, and saves them in buffer local variables. Sets the buffers
1418 read-only and turns off `auto-save-mode'.
1419 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1420 ;; force auto-save, because we will turn off auto-saving in buffers for the
1421 ;; duration
1423 ;; remember and alter buffer characteristics
1426 emerge-A-buffer
1430 emerge-merging-values))))
1433 emerge-B-buffer
1437 emerge-merging-values)))))
1440 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1445 A-values))
1448 B-values))))
1450 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1451 ;; Return DESIRED-LINE.
1454 desired-line)
1457 B-buffer
1458 merge-buffer
1459 lineno-list)
1464 ;; Record current line number in each buffer
1465 ;; so we don't have to count from the beginning.
1472 a-begin-marker
1473 a-end-marker
1474 b-begin-marker
1475 b-end-marker
1476 merge-begin-marker
1477 merge-end-marker
1483 ;; place markers at the appropriate places in the buffers
1485 A-buffer
1491 B-buffer
1499 offset)
1500 merge-buffer))
1504 offset)
1505 merge-buffer))
1506 ;; record all the markers for this difference
1508 b-begin-marker b-end-marker
1509 merge-begin-marker merge-end-marker
1510 state)
1511 marker-list)))
1513 ;; convert the list of difference information into a vector for
1514 ;; fast access
1517 ;; If we have an ancestor, select all B variants that we prefer
1529 ;; Process the local-variables list at the end of the merged file, if
1530 ;; requested.
1538 ;;; Common exit routines
1541 ;; clear screen format
1543 ;; delete A, B, and ancestor buffers, if they haven't been changed
1551 ;; Write merge buffer to file
1555 ;;; Commands
1558 "Bring the highlighted region of all three merge buffers into view.
1559 This brings the buffers into view if they are in windows.
1560 With an argument, reestablish the default three-window display."
1562 ;; If there is an argument, rebuild the window structure
1565 emerge-merge-buffer))
1566 ;; Redisplay whatever buffers are showing, if there is a selected difference
1602 ;;; Window scrolling operations
1603 ;; These operations are designed to scroll all three windows the same amount,
1604 ;; so as to keep the text in them aligned.
1606 ;; Perform some operation on all three windows (if they are showing).
1607 ;; Catches all errors on the operation in the A and B windows, but not
1608 ;; in the merge window. Usually, errors come from scrolling off the
1609 ;; beginning or end of the buffer, and this gives a nice error message:
1610 ;; End of buffer is reported in the merge buffer, but if the scroll was
1611 ;; possible in the A or B windows, it is performed there before the error
1612 ;; is reported.
1635 "Scroll up all three merge buffers, if they are in windows.
1636 With argument N, scroll N lines; otherwise scroll by nearly
1637 the height of the merge window.
1638 `C-u -' alone as argument scrolls half the height of the merge window."
1641 'scroll-up
1642 ;; calculate argument to scroll-up
1643 ;; if there is an explicit argument
1645 ;; use it
1647 ;; if not, see if we can determine a default amount (the window height)
1650 ;; no window, use nil
1651 nil
1654 ;; the window was found
1656 ;; C-u as argument means half of default amount
1658 ;; no argument means default amount
1659 default-amount)))))))
1662 "Scroll down all three merge buffers, if they are in windows.
1663 With argument N, scroll N lines; otherwise scroll by nearly
1664 the height of the merge window.
1665 `C-u -' alone as argument scrolls half the height of the merge window."
1668 'scroll-down
1669 ;; calculate argument to scroll-down
1670 ;; if there is an explicit argument
1672 ;; use it
1674 ;; if not, see if we can determine a default amount (the window height)
1677 ;; no window, use nil
1678 nil
1681 ;; the window was found
1683 ;; C-u as argument means half of default amount
1685 ;; no argument means default amount
1686 default-amount)))))))
1689 "Scroll left all three merge buffers, if they are in windows.
1690 If an argument is given, that is how many columns are scrolled, else nearly
1691 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1692 width of the A and B windows."
1695 'scroll-left
1696 ;; calculate argument to scroll-left
1697 ;; if there is an explicit argument
1699 ;; use it
1701 ;; if not, see if we can determine a default amount
1702 ;; (half the window width)
1705 ;; no window, use nil
1706 nil
1709 ;; the window was found
1711 ;; C-u as argument means half of default amount
1713 ;; no argument means default amount
1714 default-amount)))))))
1717 "Scroll right all three merge buffers, if they are in windows.
1718 If an argument is given, that is how many columns are scrolled, else nearly
1719 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1720 width of the A and B windows."
1723 'scroll-right
1724 ;; calculate argument to scroll-right
1725 ;; if there is an explicit argument
1727 ;; use it
1729 ;; if not, see if we can determine a default amount
1730 ;; (half the window width)
1733 ;; no window, use nil
1734 nil
1737 ;; the window was found
1739 ;; C-u as argument means half of default amount
1741 ;; no argument means default amount
1742 default-amount)))))))
1745 "Reset horizontal scrolling in Emerge.
1746 This resets the horizontal scrolling of all three merge buffers
1747 to the left margin, if they are in windows."
1751 nil))
1753 ;; Attempt to show the region nicely.
1754 ;; If there are min-lines lines above and below the region, then don't do
1755 ;; anything.
1756 ;; If not, recenter the region to make it so.
1757 ;; If that isn't possible, remove context lines balancedly from top and bottom
1758 ;; so the entire region shows.
1759 ;; If that isn't possible, show the top of the region.
1760 ;; BEG must be at the beginning of a line.
1762 ;; First test whether the entire region is visible with
1763 ;; emerge-min-visible-lines above and below it
1767 beg)
1772 ;; We failed that test, see if it fits at all
1773 ;; Meanwhile positioning it correctly in case it doesn't fit
1777 ;; Determine the number of lines that the region occupies
1783 ;; And position the beginning on the right line
1786 lines))
1791 "Advance to the next difference."
1805 "Go to the previous difference."
1819 "Go to the N-th difference."
1829 "Abort the Emerge session."
1834 "Finish the Emerge session and exit Emerge.
1835 Prefix argument means to abort rather than successfully finish.
1836 The difference depends on how the merge was started,
1837 but usually means to not write over one of the original files, or to signal
1838 to some process which invoked Emerge a failure code.
1840 Unselects the selected difference, if any, restores the read-only and modified
1841 flags of the merged file buffers, restores the local keymap of the merge
1842 buffer, and sets off various emerge flags. Using Emerge commands in this
1843 buffer after this will cause serious problems."
1848 "Do you really want to successfully finish this merge? "
1853 ;; Perform the quit operations.
1858 ;; null out the difference markers so they don't slow down future editing
1859 ;; operations
1867 emerge-difference-list)
1868 ;; allow them to be garbage collected
1870 ;; restore the local map
1872 ;; turn off all the emerge modes
1878 ;; restore mode line
1884 "Select the A variant of this difference.
1885 Refuses to function if this difference has been edited, i.e., if it
1886 is neither the A nor the B variant.
1887 A prefix argument forces the variant to be selected
1888 even if the difference has been edited."
1900 ;; Actually select the A variant
1903 emerge-merge-buffer
1912 "Select the B variant of this difference.
1913 Refuses to function if this difference has been edited, i.e., if it
1914 is neither the A nor the B variant.
1915 A prefix argument forces the variant to be selected
1916 even if the difference has been edited."
1928 ;; Actually select the B variant
1931 emerge-merge-buffer
1940 "Make the A variant the default from here down.
1941 This selects the A variant for all differences from here down in the buffer
1942 which are still defaulted, i.e., which the user has not selected and for
1943 which there is no preference."
1962 "Make the B variant the default from here down.
1963 This selects the B variant for all differences from here down in the buffer
1964 which are still defaulted, i.e., which the user has not selected and for
1965 which there is no preference."
1984 "Set fast mode, for Emerge.
1985 In this mode ordinary Emacs commands are disabled, and Emerge commands
1997 "Set edit mode, for Emerge.
1998 In this mode ordinary Emacs commands are available, and Emerge commands
2010 "Toggle Auto-Advance mode, for Emerge.
2011 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2012 advance to the next difference.
2013 With a positive argument, turn on Auto-Advance mode.
2014 With a negative argument, turn off Auto-Advance mode."
2020 "Auto-advance set"
2025 "Toggle Skip-Prefers mode, for Emerge.
2026 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2027 to automatically skip over differences for which there is a preference.
2028 With a positive argument, turn on Skip-Prefers mode.
2029 With a negative argument, turn off Skip-Prefers mode."
2035 "Skip-prefers set"
2040 "Put the A variant of this difference in the kill ring."
2047 ;; so further kills don't append
2048 this-command)
2053 "Put the B variant of this difference in the kill ring."
2060 ;; so further kills don't append
2061 this-command)
2066 "Insert the A variant of this difference at the point.
2067 Leaves point after text, mark before.
2068 With prefix argument, puts point before, mark after."
2084 "Insert the B variant of this difference at the point.
2085 Leaves point after text, mark before.
2086 With prefix argument, puts point before, mark after."
2102 "Leaves the point before this difference and the mark after it.
2103 With prefix argument, puts mark before, point after."
2118 "Show the names of the buffers or files being operated on by Emerge.
2119 Use C-u l to reset the windows afterward."
2161 "Join the selected difference with the following one.
2162 With a prefix argument, join with the preceding one."
2165 ;; adjust n to be first difference to join
2168 ;; n and n+1 are the differences to join
2169 ;; check that they are both differences
2172 ;; remove the flags
2174 ;; decrement total number of differences
2176 ;; build new differences vector
2196 ps)
2203 ;; set the current difference correctly
2205 ;; fix the mode line
2207 ;; reinsert the flags
2212 "Split the current difference where the points are in the three windows."
2215 ;; check that this is a valid difference
2217 ;; get the point values and old difference
2224 ;; check location of the points, give error if they aren't in the
2225 ;; differences
2235 ;; remove the flags
2237 ;; increment total number of differences
2239 ;; build new differences vector
2251 A-point
2253 B-point
2255 merge-point
2267 ;; set the current difference correctly
2269 ;; fix the mode line
2271 ;; reinsert the flags
2276 "Trim lines off top and bottom of difference that are the same.
2277 If lines are the same in both the A and the B versions, strip them off.
2278 \(This can happen when the A and B versions have common lines that the
2279 ancestor version does not share.)"
2281 ;; make sure we are in a real difference
2283 ;; remove the flags
2292 size success sa sb sm)
2293 ;; move down the tops of the difference regions as much as possible
2294 ;; Try advancing comparing 1000 chars at a time.
2295 ;; When that fails, go 500 chars at a time, and so on.
2315 ;; move up the bottoms of the difference regions as much as possible
2316 ;; Try advancing comparing 1000 chars at a time.
2317 ;; When that fails, go 500 chars at a time, and so on.
2326 bottom-a)))
2329 bottom-b)))
2337 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2338 ;; of the difference regions. Move them to the beginning of lines, as
2339 ;; appropriate.
2360 ;; put the flags back in, recenter the display
2364 ;; FIXME the manual advertised this as working in the A or B buffers,
2365 ;; but it does not, because all the buffer locals are nil there.
2366 ;; It would work to call it from the merge buffer and specify that one
2367 ;; wants to use the value of point in the A or B buffer.
2368 ;; But with the prefix argument already in use, there is no easy way
2369 ;; to have it ask for a buffer.
2371 "Find the difference containing the current position of the point.
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."
2383 "Find the difference containing point, in the merge buffer.
2384 If there is no containing difference and the prefix argument is positive,
2385 it finds the nearest following difference. A negative prefix argument finds
2386 the nearest previous difference."
2388 ;; search for the point in the merge buffer, using the markers
2389 ;; for the beginning and end of the differences in the merge buffer
2393 "Find the difference containing point, in the A buffer.
2394 This command must be executed in the merge buffer.
2395 If there is no containing difference and the prefix argument is positive,
2396 it finds the nearest following difference. A negative prefix argument finds
2397 the nearest previous difference."
2399 ;; search for the point in the A buffer, using the markers
2400 ;; for the beginning and end of the differences in the A buffer
2406 "Find the difference containing point, in the B buffer.
2407 This command must be executed in the merge buffer.
2408 If there is no containing difference and the prefix argument is positive,
2409 it finds the nearest following difference. A negative prefix argument finds
2410 the nearest previous difference."
2412 ;; search for the point in the B buffer, using the markers
2413 ;; for the beginning and end of the differences in the B buffer
2420 ;; find first difference containing or after the current position
2428 emerge-number-of-differences))
2430 ;; whether the found difference contains the current position
2433 begin))
2434 location)))
2436 ;; numeric value of prefix argument
2440 ;; if the point is in a difference, select it
2442 ;; if the arg is nil and the point is not in a difference, error
2444 ;; if the arg is positive, select the following difference
2447 index
2449 ;; if the arg is negative, select the preceding difference
2456 "Display the current line numbers.
2457 This function displays the line numbers of the points in the A, B, and
2458 merge buffers."
2465 emerge-current-difference)))
2472 merge-line A-line B-line)))
2477 ;; FIXME point-min rather than 1? widen?
2485 temp))
2488 "Set `emerge-combine-versions-template' to STRING.
2489 This value controls how `emerge-combine-versions' combines the two versions.
2490 With prefix argument, `emerge-combine-versions-template' is made local to this
2491 merge buffer. Localization is permanent for any particular merge buffer."
2498 "emerge-set-combine-versions-template set locally"
2502 "Copy region into `emerge-combine-versions-template'.
2503 This controls how `emerge-combine-versions' will combine the two versions.
2504 With prefix argument, `emerge-combine-versions-template' is made local to this
2505 merge buffer. Localization is permanent for any particular merge buffer."
2512 "emerge-set-combine-versions-template set locally."
2516 "Combine versions using the template in `emerge-combine-versions-template'.
2517 Refuses to function if this difference has been edited, i.e., if it is
2518 neither the A nor the B variant.
2519 An argument forces the variant to be selected even if the difference has
2520 been edited."
2525 "Combine the two versions using the template in register REG.
2526 See documentation of the variable `emerge-combine-versions-template'
2527 for how the template is interpreted.
2528 Refuses to function if this difference has been edited, i.e., if it is
2529 neither the A nor the B variant.
2530 An argument forces the variant to be selected even if the difference has
2531 been edited."
2542 A-begin A-end B-begin B-end)
2550 A-begin A-end B-begin B-end)
2552 emerge-merge-buffer
2580 "Set the major mode in a merge buffer.
2581 Overrides any change that the mode might make to the mode line or local
2582 keymap. Leaves merge in fast mode."
2597 ;;; Support routines
2599 ;; Select a difference by placing the visual flags around the appropriate
2600 ;; group of lines in the A, B, and merge buffers
2610 after-index)
2613 buffer
2619 ;; insert the flag before the difference
2621 before-index))
2622 here)
2624 ;; insert the flag itself
2627 ;; Put the marker(s) referring to this position 1 character before the
2628 ;; end of the flag, so it won't be damaged by the user.
2629 ;; This gets a bit tricky, as there could be a number of markers
2630 ;; that have to be moved.
2644 ;; insert the flag after the difference
2646 after-index))
2649 ;; insert the flag itself
2651 ;; Put the marker(s) referring to this position 1 character after the
2652 ;; beginning of the flag, so it won't be damaged by the user.
2653 ;; This gets a bit tricky, as there could be a number of markers
2654 ;; that have to be moved.
2669 ;; Unselect a difference by removing the visual flags in the buffers.
2682 buffer
2684 ;; remove the flags, if they're there
2688 ;; the flag isn't there
2694 ;; the flag isn't there
2698 ;; Select a difference, removing any flags that exist now.
2718 ;; Perform tests to see whether user should be allowed to select a version
2719 ;; of this difference:
2720 ;; a valid difference has been selected; and
2721 ;; the difference text in the merge buffer is:
2722 ;; the A version (execute a-version), or
2723 ;; the B version (execute b-version), or
2724 ;; empty (execute neither-version), or
2725 ;; argument FORCE is true (execute neither-version)
2726 ;; Otherwise, signal an error.
2739 emerge-merge-buffer merge-begin
2740 merge-end)
2743 emerge-merge-buffer merge-begin
2744 merge-end)
2750 ;; Read a file name, handling all of the various defaulting rules.
2753 A-file must-match)
2754 ;; `prompt' should not have trailing ": ", so that it can be modified
2755 ;; according to context.
2756 ;; If alternative-default-dir is non-nil, it should be used as the default
2757 ;; directory instead if default-directory, if emerge-default-last-directories
2758 ;; is set.
2759 ;; If default-file is set, it should be used as the default value.
2760 ;; If A-file is set, and its directory is different from
2761 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2762 ;; the default file should be the last part of A-file in the default
2763 ;; directory. (Overriding default-file.)
2765 ;; If this is not the A-file argument (shown by non-nil A-file), and
2766 ;; if emerge-default-last-directories is set, and
2767 ;; the default directory exists but is not the same as the directory of the
2768 ;; A-file,
2769 ;; then make the default file have the same name as the A-file, but in
2770 ;; the default directory.
2772 A-file
2773 alternative-default-dir
2778 alternative-default-dir
2782 ;; If there is a default file, use it.
2785 ;; If emerge-default-last-directories is set, use the
2786 ;; directory from the same argument of the last call of
2787 ;; Emerge as the default for this argument.
2789 alternative-default-dir)
2793 ;; If emerge-default-last-directories is set, use the
2794 ;; directory from the same argument of the last call of
2795 ;; Emerge as the default for this argument.
2797 alternative-default-dir)
2800 ;; Revise the mode line to display which difference we have selected
2806 emerge-number-of-differences
2808 (< emerge-current-difference
2809 emerge-number-of-differences))
2811 emerge-current-difference)
2821 ;; compare two regions in two buffers for containing the same text
2823 ;; first check that the two regions are the same length
2825 nil
2828 ;; bite off and compare no more than 1000 characters at a time
2831 buffer-x
2835 buffer-y
2842 t)))
2844 ;; Construct a unique buffer name.
2845 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2846 ;; prefix<3>suffix, etc.
2855 ;; Verify that we have a difference selected.
2861 ;;; Functions for saving and restoring a batch of variables
2863 ;; These functions save (get the values of) and restore (set the values of)
2864 ;; a list of variables. The argument is a list of symbols (the names of
2865 ;; the variables). A list element can also be a list of two functions,
2866 ;; the first of which (when called with no arguments) gets the value, and
2867 ;; the second (when called with a value as an argument) sets the value.
2868 ;; A "function" is anything that funcall can handle as an argument.
2874 vars))
2886 ;; Make a temporary file that only we have access to.
2887 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2895 f))
2897 ;;; Functions that query the user before he can write out the current buffer.
2900 "Ask the user whether to write out an incomplete merge.
2901 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2902 for details of the querying process."
2907 "Ask the user whether to save an incomplete merge.
2908 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2909 for details of the querying process."
2914 "Ask the user whether to save or write out the incomplete merge.
2915 If answer is yes, call COMMAND interactively. During the call, the flags
2916 around the current difference are removed."
2918 ;; He really wants to do it -- unselect the difference for the duration
2923 ;; call-interactively takes the value of current-prefix-arg as the
2924 ;; prefix argument value to be passed to the command. Thus, we have
2925 ;; to do nothing special to make sure the prefix argument is
2926 ;; transmitted to the command.
2933 ;; He's being smart and not doing it
2936 ;; Make sure the current buffer (for a file) has the same contents as the
2937 ;; file on disk, and attempt to remedy the situation if not.
2938 ;; Signal an error if we can't make them the same, or the user doesn't want
2939 ;; to do what is necessary to make them the same.
2941 ;; First check if the file has been modified since the buffer visited it.
2944 ;; If buffer is not obsolete and is modified, offer to save
2948 ;; If buffer is not obsolete and is not modified, do nothing
2949 nil)
2951 ;; If buffer is obsolete and is modified, give error
2953 ;; If buffer is obsolete and is not modified, offer to revert
2957 \f
2958 ;; Utilities that might have value outside of Emerge.
2960 ;; Set up the mode in the current buffer to duplicate the mode in another
2961 ;; buffer.
2963 ;; Set the major mode
2966 ;; Define a key, even if a prefix of it is defined
2968 "Like `define-key', but forcibly creates prefix characters as needed.
2969 If some prefix of KEY has a non-prefix definition, it is redefined."
2970 ;; Find out if a prefix of key is defined
2972 ;; If so, undefine it
2975 ;; Now define the key
2978 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2979 ;;;;; as the major mode
2980 ;;(defun describe-mode (&optional minor)
2981 ;; "Display documentation of current major mode.
2982 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2983 ;;display documentation of active minor modes as well.
2984 ;;For this to work correctly for a minor mode, the mode's indicator variable
2985 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2986 ;;describes the minor mode."
2987 ;; (interactive)
2988 ;; (with-output-to-temp-buffer "*Help*"
2989 ;; (princ mode-name)
2990 ;; (princ " Mode:\n")
2991 ;; (princ (documentation major-mode))
2992 ;; (let ((minor-modes minor-mode-alist)
2993 ;; (locals (buffer-local-variables)))
2994 ;; (while minor-modes
2995 ;; (let* ((minor-mode (car (car minor-modes)))
2996 ;; (indicator (car (cdr (car minor-modes))))
2997 ;; (local-binding (assq minor-mode locals)))
2998 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2999 ;; ;; bound locally in this buffer, non-nil, and has a function
3000 ;; ;; definition.
3001 ;; (if (and local-binding
3002 ;; (cdr local-binding)
3003 ;; (fboundp minor-mode))
3004 ;; (progn
3005 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3006 ;; minor-mode indicator))
3007 ;; (princ (documentation minor-mode)))))
3008 ;; (setq minor-modes (cdr minor-modes))))
3009 ;; (with-current-buffer standard-output
3010 ;; (help-mode))
3011 ;; (help-print-return-message)))
3013 ;; This goes with the redefinition of describe-mode.
3014 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3015 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3017 ;; substitute-key-definition should work now.
3018 ;;;; Function to shadow a definition in a keymap with definitions in another.
3019 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3020 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3021 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3022 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3023 ;;including those whose definition is OLDDEF."
3024 ;; ;; loop through all keymaps accessible from keymap
3025 ;; (let ((maps (accessible-keymaps keymap)))
3026 ;; (while maps
3027 ;; (let ((prefix (car (car maps)))
3028 ;; (map (cdr (car maps))))
3029 ;; ;; examine a keymap
3030 ;; (if (arrayp map)
3031 ;; ;; array keymap
3032 ;; (let ((len (length map))
3033 ;; (i 0))
3034 ;; (while (< i len)
3035 ;; (if (eq (aref map i) olddef)
3036 ;; ;; set the shadowing definition
3037 ;; (let ((key (concat prefix (char-to-string i))))
3038 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3039 ;; (setq i (1+ i))))
3040 ;; ;; sparse keymap
3041 ;; (while map
3042 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3043 ;; ;; set the shadowing definition
3044 ;; (let ((key
3045 ;; (concat prefix (char-to-string (car (car map))))))
3046 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3047 ;; (setq map (cdr map)))))
3048 ;; (setq maps (cdr maps)))))
3050 ;; Define a key if it (or a prefix) is not already defined in the map.
3052 ;; look up the present definition of the key
3055 ;; if it is "too long", look up the valid prefix
3057 ;; if the prefix isn't defined, define it
3059 ;; if there is no present definition, define it
3063 ;; Ordinary substitute-key-definition should do this now.
3064 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3065 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3066 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3067 ;;\(`copy-keymap' will suffice.)"
3068 ;; ;; Loop through all keymaps accessible from keymap
3069 ;; (let ((maps (accessible-keymaps keymap)))
3070 ;; (while maps
3071 ;; ;; Substitute in this keymap
3072 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3073 ;; (setq maps (cdr maps)))))
3075 ;; Show the name of the file in the buffer.
3077 "Displays the name of the file loaded into the current buffer.
3078 If the name won't fit on one line, the minibuffer is expanded to hold it,
3079 and the command waits for a keystroke from the user. If the keystroke is
3080 SPC, it is ignored; if it is anything else, it is processed as a command."
3100 ;; Improved auto-save file names.
3101 ;; This function fixes many problems with the standard auto-save file names:
3102 ;; Auto-save files for non-file buffers get put in the default directory
3103 ;; for the buffer, whether that makes sense or not.
3104 ;; Auto-save files for file buffers get put in the directory of the file,
3105 ;; regardless of whether we can write into it or not.
3106 ;; Auto-save files for non-file buffers don't use the process id, so if a
3107 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3108 ;; each other.
3109 ;; To use this function, do:
3110 ;; (fset 'make-auto-save-file-name
3111 ;; (symbol-function 'emerge-make-auto-save-file-name))
3113 "Return file name to use for auto-saves of current buffer.
3114 Does not consider `auto-save-visited-file-name';
3115 that is checked before calling this function.
3116 You can redefine this for customization.
3117 See also `auto-save-file-name-p'."
3119 ;; if buffer has a file, try the format <file directory>/#<file name>#
3121 "#"
3125 ;; the file is writable, so use it
3126 f
3127 ;; the file isn't writable, so use the format
3128 ;; ~/#&<file name>&<hash of directory>#
3130 "/#&"
3132 "&"
3136 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3138 "/#%"
3139 ;; quote / into \! and \ into \\
3141 "%"
3145 ;; Hash a string into five characters more-or-less suitable for use in a file
3146 ;; name. (Allowed characters are ! through ~, except /.)
3162 ;; Quote any /s in a string by replacing them with \!.
3163 ;; Also, replace any \s by \\, to make it one-to-one.
3175 s)
3177 ;; Metacharacters that have to be protected from the shell when executing
3178 ;; a diff/diff3 command.
3183 "Characters that must be quoted when used in a shell command line.
3184 More precisely, a [...] regexp to match any one such character."
3188 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3198 s))
3202 ;;; emerge.el ends here