| blob | 250df827d13e0ae6816dbfbfcf14c4d35a5c677b |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; Author: Dale R. Worley <drw@math.mit.edu>
6 ;; Version: 5fsf
7 ;; Keywords: unix, tools
9 ;; This software was created by Dale R. Worley and is
10 ;; distributed free of charge. It is placed in the public domain and
11 ;; permission is granted to anyone to use, duplicate, modify and redistribute
12 ;; it provided that this notice is attached.
14 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
15 ;; with respect to this software. The entire risk as to the quality and
16 ;; performance of this software is with the user. IN NO EVENT WILL DALE
17 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
18 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
19 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
20 ;; DAMAGES.
22 ;;; Code:
24 ;;;###autoload
26 ;;;###autoload
29 ;;;###autoload
32 ;;;###autoload
35 ;;;###autoload
38 ;;;###autoload
41 ;;;###autoload
44 ;;;###autoload
47 ;;;###autoload
51 ;;; Macros
54 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
55 Differs from `save-excursion' in that it doesn't save the point and mark."
64 "Defines SYMBOL as an advertised variable.
65 Performs a defvar, then executes `make-variable-buffer-local' on
66 the variable. Also sets the `preserved' property, so that
67 `kill-all-local-variables' (called by major-mode setting commands)
68 won't destroy Emerge control variables."
74 ;; Add entries to minor-mode-alist so that emerge modes show correctly
83 minor-mode-alist)))
85 ;; We need to define this function so describe-mode can describe Emerge mode.
87 "Emerge mode is used by the Emerge file-merging package.
88 It is entered only through one of the functions:
89 `emerge-files'
90 `emerge-files-with-ancestor'
91 `emerge-buffers'
92 `emerge-buffers-with-ancestor'
93 `emerge-files-command'
94 `emerge-files-with-ancestor-command'
95 `emerge-files-remote'
96 `emerge-files-with-ancestor-remote'
98 Commands:
107 "Return string describing the version of Emerge.
108 When called interactively, displays the version."
112 emerge-version))
114 ;;; Emerge configuration variables
116 ;; Commands that produce difference files
117 ;; All that can be configured is the name of the programs to execute
118 ;; (emerge-diff-program and emerge-diff3-program) and the options
119 ;; to be provided (emerge-diff-options). The order in which the file names
120 ;; are given is fixed.
121 ;; The file names are always expanded (see expand-file-name) before being
122 ;; passed to diff, thus they need not be invoked under a shell that
123 ;; understands `~'.
124 ;; The code which processes the diff/diff3 output depends on all the
125 ;; finicky details of their output, including the somewhat strange
126 ;; way they number lines of a file.
130 "*Name of the program which compares three files.
136 "*Pattern to match lines produced by diff that describe differences.
140 "*Regexp that matches normal output lines from `emerge-diff-program'.
144 "*Regexp that matches normal output lines from `emerge-diff3-program'.
153 "*Non-nil if Emerge should process local-variables lists in merge buffers.
154 \(You can explicitly request processing the 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
164 "*Flag placed above the highlighted block of code. Must end with newline.
165 Must be set before Emerge is loaded, or emerge-new-flags must be run
168 "*Flag placed below the highlighted block of code. Must end with newline.
169 Must be set before Emerge is loaded, or emerge-new-flags must be run
172 ;; Hook variables
177 "*Hook to run after a difference has been selected.
180 "*Hook to run after a difference has been unselected.
183 ;; Variables to control the default directories of the arguments to
184 ;; Emerge commands.
187 "*If nil, default dir for filenames in emerge is `default-directory'.
188 If non-nil, filenames complete in the directory of the last argument of the
220 ;; The flags used to mark differences in the buffers.
222 ;; These function definitions need to be up here, because they are used
223 ;; during loading.
225 "Function to be called after `emerge-{before,after}-flag'.
226 This is called after these functions are changed to compute values that
227 depend on the flags."
238 "Return the number of matches in STRING for REGEXP."
244 count))
246 ;; Calculate dependent variables
250 "*Number of lines that we want to show above and below the flags when we are
255 d)
257 env
262 "*Prefix to put on Emerge temporary file names.
270 "*Template for `emerge-combine-versions' to combine the two versions.
271 The template is inserted as a string, with the following interpolations:
272 %a the A version of the difference
273 %b the B version of the difference
274 %% the character `%'
275 Don't forget to end the template with a newline.
276 Note that this variable can be made local to a particular merge buffer by
279 ;; Build keymaps
282 "Keymap of Emerge commands.
283 Directly available in `fast' mode;
287 "Local keymap used in Emerge `fast' mode.
300 "*Command prefix for Emerge commands in `edit' mode.
303 ;; This function sets up the fixed keymaps. It is executed when the first
304 ;; Emerge is done to allow the user maximum time to set up the global keymap.
306 ;; Set up the basic keymap
309 ; - to negative-argument
350 ;; Allow emerge-basic-keymap to be referenced indirectly
352 ;; Set up the fast mode keymap
354 ;; Allow prefixed commands to work in fast mode
356 ;; Allow emerge-fast-keymap to be referenced indirectly
358 ;; Suppress write-file and save-buffer
440 ;; Variables which control each merge. They are local to the merge buffer.
442 ;; Mode variables
456 "The buffer in which the ancestor variant is stored,
461 buffer-read-only
462 buffer-auto-save-file-name)
463 "Variables and properties of a buffer which are saved, modified and restored
474 "Vector of differences between the variants, and markers in the buffers to
475 show where they are. Each difference is represented by a vector of seven
476 elements. The first two are markers to the beginning and end of the difference
477 section in the A buffer, the second two are markers for the B buffer, the third
479 that difference in the merge buffer.
480 A section of a buffer is described by two markers, one to the beginning of
481 the first line of the section, and one to the beginning of the first line
482 after the section. (If the section is empty, both markers point to the same
483 point.) If the section is part of the selected difference, then the markers
484 are moved into the flags, so the user can edit the section without disturbing
485 the markers.
487 A the merge buffer currently contains the A variant
488 B the merge buffer currently contains the B variant
489 default-A the merge buffer contains the A variant by default,
490 but this difference hasn't been selected yet, so
491 change-default commands can alter it
492 default-B the merge buffer contains the B variant by default,
493 but this difference hasn't been selected yet, so
494 change-default commands can alter it
495 prefer-A in a three-file merge, the A variant is the preferred
496 choice
497 prefer-B in a three-file merge, the B variant is the preferred
504 "The local keymap for the merge buffer, with the emerge commands defined in
505 it. Used to save the local keymap during fast mode, when the local keymap is
510 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
513 "*If non-nil, differences for which there is a preference are automatically
516 "Hooks to run in the merge buffer after the merge has been finished.
517 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
518 command.
523 ;;; Setup functions for two-file mode.
526 output-file)
533 ;; Record the directories of the files
538 ;; Make sure the entire files are seen, and they reflect what is on disk
540 buffer-A
545 startup-hooks
547 startup-hooks))
548 ;; Verify that the file matches the buffer
551 buffer-B
556 startup-hooks
558 startup-hooks))
559 ;; Verify that the file matches the buffer
562 output-file)))
564 ;; Start up Emerge on two files
566 output-file)
571 ;; create the merge buffer from buffer A, so it inherits buffer A's
572 ;; default directory, etc.
574 buffer-A
577 merge-buffer
603 ;; Generate the Emerge difference list between two files
607 emerge-diff-buffer
611 emerge-diff-program emerge-diff-options
614 t))
617 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
623 diff-buffer
632 a-begin)))
640 b-begin))))
641 ;; fix the beginning and end numbers, because diff is somewhat
642 ;; strange about how it numbers lines
653 ;; (string-equal diff-type "c")
658 b-begin b-end
660 list)))))
663 ;; Set up buffer of diff/diff3 error messages.
667 emerge-diff-error-buffer
672 ;;; Top-level and setup functions for three-file mode.
675 &optional startup-hooks quit-hooks
676 output-file)
686 ;; Record the directories of the files
692 ;; Make sure the entire files are seen, and they reflect what is on disk
694 buffer-A
699 startup-hooks
701 startup-hooks))
702 ;; Verify that the file matches the buffer
705 buffer-B
710 startup-hooks
712 startup-hooks))
713 ;; Verify that the file matches the buffer
716 buffer-ancestor
721 startup-hooks
723 startup-hooks))
724 ;; Verify that the file matches the buffer
727 buffer-ancestor file-ancestor
728 startup-hooks quit-hooks output-file)))
730 ;; Start up Emerge on two files with an ancestor
732 buffer-ancestor file-ancestor
733 &optional startup-hooks quit-hooks
734 output-file)
740 ;; create the merge buffer from buffer A, so it inherits buffer A's
741 ;; default directory, etc.
743 buffer-A
746 merge-buffer
774 ;; Generate the Emerge difference list between two files with an ancestor
778 emerge-diff-buffer
782 emerge-diff3-program emerge-diff-options
786 t))
789 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
795 diff-buffer
797 ;; leave point after matched line
800 ;; if the A and B files are the same, ignore the difference
814 list))))))
818 ;; This save-excursion allows emerge-get-diff3-group to be called for the
819 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
820 ;; appear in any order. The reason this is necessary is that Gnu diff3
821 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
826 ;; treatment depends on whether it is an "a" group or a "c" group
828 ;; it is a "c" group
830 ;; it has two numbers
835 ;; it has one number
839 ;; it is an "a" group
844 ;;; Functions to start Emerge on files
846 ;;;###autoload
848 quit-hooks)
849 "Run Emerge on two files."
854 nil nil))
858 f f)))))
860 file-A file-B startup-hooks
863 quit-hooks)
864 quit-hooks)
865 file-out))
867 ;;;###autoload
870 "Run Emerge on two files, giving another file as the ancestor."
875 nil nil))
878 nil f)
881 f f)))))
883 file-A file-B file-ancestor startup-hooks
886 quit-hooks)
887 quit-hooks)
888 file-out))
890 ;; Write the merge buffer out in place of the file the A buffer is visiting.
892 ;; if merge was successful was given, save to disk
896 ;;; Functions to start Emerge on buffers
898 ;;;###autoload
900 "Run Emerge on two buffers."
905 buffer-A
908 buffer-B
915 startup-hooks)
916 quit-hooks
917 nil)))
919 ;;;###autoload
921 &optional startup-hooks
922 quit-hooks)
923 "Run Emerge on two buffers, giving another buffer as the ancestor."
930 buffer-A
933 buffer-B
936 buffer-ancestor
942 emerge-file-ancestor
948 startup-hooks)
949 quit-hooks
950 nil)))
952 ;;; Functions to start Emerge from the command line
954 ;;;###autoload
961 file-a file-b nil
964 ;;;###autoload
967 ;; check for a -a flag, for filemerge compatibility
969 ;; arguments are "-a ancestor file-a file-b file-out"
976 ;; arguments are "file-a file-b ancestor file-out"
983 file-a file-b file-anc nil
990 ;;; Functions to start Emerge via remote request
992 ;;;###autoload
996 file-a file-b nil
998 file-out)
1001 ;;;###autoload
1005 file-a file-b file-anc nil
1007 file-out)
1015 ;;; Functions to start Emerge on RCS versions
1017 ;;;###autoload
1020 "Emerge two RCS revisions of a file."
1027 emerge-last-revision-B revision-B)
1029 file revision-A revision-B startup-hooks
1034 quit-hooks)
1035 quit-hooks)))
1037 ;;;###autoload
1039 revision-B ancestor
1040 &optional
1041 startup-hooks quit-hooks)
1042 "Emerge two RCS revisions of a file, with another revision as ancestor."
1050 emerge-last-revision-B revision-B
1051 emerge-last-revision-ancestor ancestor)
1053 file revision-A revision-B ancestor startup-hooks
1059 quit-hooks))
1060 quit-hooks)))
1063 startup-hooks quit-hooks output-file)
1068 ;; Get the revisions into buffers
1070 buffer-A
1074 t)
1078 buffer-B
1082 t)
1085 ;; Do the merge
1087 buffer-B emerge-file-B
1091 startup-hooks)
1093 quit-hooks)
1094 nil)))
1097 ancestor
1098 &optional startup-hooks
1099 quit-hooks output-file)
1106 ;; Get the revisions into buffers
1108 buffer-A
1112 revision-A file)
1113 t)
1117 buffer-B
1121 t)
1125 buffer-ancestor
1129 t)
1132 ;; Do the merge
1134 buffer-A emerge-file-A buffer-B emerge-file-B
1135 buffer-ancestor emerge-ancestor
1140 startup-hooks)
1142 quit-hooks)
1143 output-file)))
1145 ;;; Function to start Emerge based on a line in a file
1148 "Run Emerge using files named in current text line.
1149 Looks in that line for whitespace-separated entries of these forms:
1150 a=file1
1151 b=file2
1152 ancestor=file3
1153 output=file4
1154 to specify the files to use in Emerge.
1156 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1157 is present:
1158 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1159 it is assumed that the file in question has been deleted, and it is
1160 not copied to the output file.
1161 Otherwise, the A or B file present is copied to the output file."
1165 ;; Stop if at end of buffer (even though we might be in a line, if
1166 ;; the line does not end with newline)
1169 ;; Go to the beginning of the line
1171 ;; Skip any initial whitespace
1174 ;; Process the entire line
1176 ;; Get the next entry
1178 ;; Break apart the tab (before =) and the filename (after =)
1182 ;; Move point after the entry
1184 ;; Store the filename in the right variable
1204 ;; If the match on the entry pattern failed
1206 ;; Make sure that file-A and file-B are present
1211 ;; Go to the beginning of the next line, so next execution will use
1212 ;; next line in buffer.
1214 ;; Execute the correct command
1216 ;; Merge of two files with ancestor
1220 file-ancestor file-out
1221 nil
1222 ;; When done, return to this buffer.
1227 ;; Merge of two files without ancestor
1231 nil
1232 ;; When done, return to this buffer.
1237 ;; There is an output file (or there would have been an error above),
1238 ;; but only one input file.
1239 ;; The file appears to have been deleted in one version; do nothing.
1242 ;; The file should be copied from the version that contains it
1248 ;;; Sample function for creating information for emerge-execute-line
1253 ;;;###autoload
1261 ;; Check that we're not on a line
1264 ;; Turn null strings into nil to indicate directories not used.
1269 ;; Canonicalize the directory names
1286 ;; Set the mark to where we start
1288 ;; Find out what files are in the directories.
1296 emerge-merge-directories-filename-regexp)))
1301 ;; Remove duplicates from all-files.
1307 ;; Generate the control lines for the various files.
1328 ;;; Common setup routines
1330 ;; Set up the window configuration. If POS is given, set the points to
1331 ;; the beginnings of the buffers.
1333 ;; Make sure we are not in the minibuffer window when we try to delete
1334 ;; all other windows.
1352 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1360 ;; Set up the keymap in the merge buffer
1362 ;; Set up fixed keymaps if necessary
1365 ;; Save the old local map
1367 ;; Construct the edit keymap
1371 ;; Install the Emerge commands
1376 ;; Create the additional menu bar items.
1384 ;; Suppress write-file and save-buffer
1386 'emerge-query-write-file
1387 emerge-edit-keymap)
1389 'emerge-query-save-buffer
1390 emerge-edit-keymap)
1400 "Record certain properties of the buffers being merged.
1401 Must be called in the merge buffer. Remembers read-only, modified,
1402 auto-save, and saves them in buffer local variables. Sets the buffers
1403 read-only and turns off `auto-save-mode'.
1404 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1405 ;; force auto-save, because we will turn off auto-saving in buffers for the
1406 ;; duration
1408 ;; remember and alter buffer characteristics
1411 emerge-A-buffer
1415 emerge-merging-values))))
1418 emerge-B-buffer
1422 emerge-merging-values)))))
1425 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1430 A-values))
1433 B-values))))
1435 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1436 ;; Return DESIRED-LINE.
1439 desired-line)
1442 B-buffer
1443 merge-buffer
1444 lineno-list)
1449 ;; Record current line number in each buffer
1450 ;; so we don't have to count from the beginning.
1457 a-begin-marker
1458 a-end-marker
1459 b-begin-marker
1460 b-end-marker
1461 merge-begin-marker
1462 merge-end-marker
1468 ;; place markers at the appropriate places in the buffers
1470 A-buffer
1476 B-buffer
1484 offset)
1485 merge-buffer))
1489 offset)
1490 merge-buffer))
1491 ;; record all the markers for this difference
1493 b-begin-marker b-end-marker
1494 merge-begin-marker merge-end-marker
1495 state)
1496 marker-list)))
1498 ;; convert the list of difference information into a vector for
1499 ;; fast access
1502 ;; If we have an ancestor, select all B variants that we prefer
1514 ;; Process the local-variables list at the end of the merged file, if
1515 ;; requested.
1523 ;;; Common exit routines
1526 ;; clear screen format
1528 ;; delete A, B, and ancestor buffers, if they haven't been changed
1536 ;; Write merge buffer to file
1540 ;;; Commands
1543 "Bring the highlighted region of all three merge buffers into view.
1544 This brings the buffers into view if they are in windows.
1545 With an argument, reestablish the default three-window display."
1547 ;; If there is an argument, rebuild the window structure
1550 emerge-merge-buffer))
1551 ;; Redisplay whatever buffers are showing, if there is a selected difference
1587 ;;; Window scrolling operations
1588 ;; These operations are designed to scroll all three windows the same amount,
1589 ;; so as to keep the text in them aligned.
1591 ;; Perform some operation on all three windows (if they are showing).
1592 ;; Catches all errors on the operation in the A and B windows, but not
1593 ;; in the merge window. Usually, errors come from scrolling off the
1594 ;; beginning or end of the buffer, and this gives a nice error message:
1595 ;; End of buffer is reported in the merge buffer, but if the scroll was
1596 ;; possible in the A or B windows, it is performed there before the error
1597 ;; is reported.
1620 "Scroll up all three merge buffers, if they are in windows.
1621 With argument N, scroll N lines; otherwise scroll by nearly
1622 the height of the merge window.
1623 `C-u -' alone as argument scrolls half the height of the merge window."
1626 'scroll-up
1627 ;; calculate argument to scroll-up
1628 ;; if there is an explicit argument
1630 ;; use it
1632 ;; if not, see if we can determine a default amount (the window height)
1635 ;; no window, use nil
1636 nil
1639 ;; the window was found
1641 ;; C-u as argument means half of default amount
1643 ;; no argument means default amount
1644 default-amount)))))))
1647 "Scroll down all three merge buffers, if they are in windows.
1648 With argument N, scroll N lines; otherwise scroll by nearly
1649 the height of the merge window.
1650 `C-u -' alone as argument scrolls half the height of the merge window."
1653 'scroll-down
1654 ;; calculate argument to scroll-down
1655 ;; if there is an explicit argument
1657 ;; use it
1659 ;; if not, see if we can determine a default amount (the window height)
1662 ;; no window, use nil
1663 nil
1666 ;; the window was found
1668 ;; C-u as argument means half of default amount
1670 ;; no argument means default amount
1671 default-amount)))))))
1674 "Scroll left all three merge buffers, if they are in windows.
1675 If an argument is given, that is how many columns are scrolled, else nearly
1676 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1677 width of the A and B windows."
1680 'scroll-left
1681 ;; calculate argument to scroll-left
1682 ;; if there is an explicit argument
1684 ;; use it
1686 ;; if not, see if we can determine a default amount
1687 ;; (half the window width)
1690 ;; no window, use nil
1691 nil
1694 ;; the window was found
1696 ;; C-u as argument means half of default amount
1698 ;; no argument means default amount
1699 default-amount)))))))
1702 "Scroll right all three merge buffers, if they are in windows.
1703 If an argument is given, that is how many columns are scrolled, else nearly
1704 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1705 width of the A and B windows."
1708 'scroll-right
1709 ;; calculate argument to scroll-right
1710 ;; if there is an explicit argument
1712 ;; use it
1714 ;; if not, see if we can determine a default amount
1715 ;; (half the window width)
1718 ;; no window, use nil
1719 nil
1722 ;; the window was found
1724 ;; C-u as argument means half of default amount
1726 ;; no argument means default amount
1727 default-amount)))))))
1730 "Reset horizontal scrolling in Emerge.
1731 This resets the horizontal scrolling of all three merge buffers
1732 to the left margin, if they are in windows."
1736 nil))
1738 ;; Attempt to show the region nicely.
1739 ;; If there are min-lines lines above and below the region, then don't do
1740 ;; anything.
1741 ;; If not, recenter the region to make it so.
1742 ;; If that isn't possible, remove context lines balancedly from top and botton
1743 ;; so the entire region shows.
1744 ;; If that isn't possible, show the top of the region.
1745 ;; BEG must be at the beginning of a line.
1747 ;; First test whether the entire region is visible with
1748 ;; emerge-min-visible-lines above and below it
1752 beg)
1757 ;; We failed that test, see if it fits at all
1758 ;; Meanwhile positioning it correctly in case it doesn't fit
1762 ;; Determine the number of lines that the region occupies
1768 ;; And position the beginning on the right line
1771 lines))
1776 "Advance to the next difference."
1790 "Go to the previous difference."
1804 "Go to the N-th difference."
1814 "Abort the Emerge session."
1819 "Finish the Emerge session and exit Emerge.
1820 Prefix argument means to abort rather than successfully finish.
1821 The difference depends on how the merge was started,
1822 but usually means to not write over one of the original files, or to signal
1823 to some process which invoked Emerge a failure code.
1825 Unselects the selected difference, if any, restores the read-only and modified
1826 flags of the merged file buffers, restores the local keymap of the merge
1827 buffer, and sets off various emerge flags. Using Emerge commands in this
1828 buffer after this will cause serious problems."
1833 "Do you really want to successfully finish this merge? "
1838 ;; Perform the quit operations.
1843 ;; null out the difference markers so they don't slow down future editing
1844 ;; operations
1852 emerge-difference-list)
1853 ;; allow them to be garbage collected
1855 ;; restore the local map
1857 ;; turn off all the emerge modes
1863 ;; restore mode line
1869 "Select the A variant of this difference.
1870 Refuses to function if this difference has been edited, i.e., if it
1871 is neither the A nor the B variant.
1872 A prefix argument forces the variant to be selected
1873 even if the difference has been edited."
1886 ;; Actually select the A variant
1889 emerge-merge-buffer
1898 "Select the B variant of this difference.
1899 Refuses to function if this difference has been edited, i.e., if it
1900 is neither the A nor the B variant.
1901 A prefix argument forces the variant to be selected
1902 even if the difference has been edited."
1915 ;; Actually select the B variant
1918 emerge-merge-buffer
1927 "Make the A variant the default from here down.
1928 This selects the A variant for all differences from here down in the buffer
1929 which are still defaulted, i.e., which the user has not selected and for
1930 which there is no preference."
1949 "Make the B variant the default from here down.
1950 This selects the B variant for all differences from here down in the buffer
1951 which are still defaulted, i.e., which the user has not selected and for
1952 which there is no preference."
1971 "Set fast mode, for Emerge.
1972 In this mode ordinary Emacs commands are disabled, and Emerge commands
1981 ;; force mode line redisplay
1985 "Set edit mode, for Emerge.
1986 In this mode ordinary Emacs commands are available, and Emerge commands
1995 ;; force mode line redisplay
1999 "Toggle Auto-Advance mode, for Emerge.
2000 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2001 advance to the next difference.
2002 With a positive argument, turn on Auto-Advance mode.
2003 With a negative argument, turn off Auto-Advance mode."
2009 "Auto-advance set"
2011 ;; force mode line redisplay
2015 "Toggle Skip-Prefers mode, for Emerge.
2016 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2017 to automatically skip over differences for which there is a preference.
2018 With a positive argument, turn on Skip-Prefers mode.
2019 With a negative argument, turn off Skip-Prefers mode."
2025 "Skip-prefers set"
2027 ;; force mode line redisplay
2031 "Put the A variant of this difference in the kill ring."
2038 ;; so further kills don't append
2039 this-command)
2045 "Put the B variant of this difference in the kill ring."
2052 ;; so further kills don't append
2053 this-command)
2059 "Insert the A variant of this difference at the point.
2060 Leaves point after text, mark before.
2061 With prefix argument, puts point before, mark after."
2077 "Insert the B variant of this difference at the point.
2078 Leaves point after text, mark before.
2079 With prefix argument, puts point before, mark after."
2095 "Leaves the point before this difference and the mark after it.
2096 With prefix argument, puts mark before, point after."
2111 "Show the names of the buffers or files being operated on by Emerge.
2112 Use C-u l to reset the windows afterward."
2152 "Join the selected difference with the following one.
2153 With a prefix argument, join with the preceding one."
2156 ;; adjust n to be first difference to join
2159 ;; n and n+1 are the differences to join
2160 ;; check that they are both differences
2163 ;; remove the flags
2165 ;; decrement total number of differences
2167 ;; build new differences vector
2187 ps)
2194 ;; set the current difference correctly
2196 ;; fix the mode line
2198 ;; reinsert the flags
2203 "Split the current difference where the points are in the three windows."
2206 ;; check that this is a valid difference
2208 ;; get the point values and old difference
2215 ;; check location of the points, give error if they aren't in the
2216 ;; differences
2226 ;; remove the flags
2228 ;; increment total number of differences
2230 ;; build new differences vector
2242 A-point
2244 B-point
2246 merge-point
2258 ;; set the current difference correctly
2260 ;; fix the mode line
2262 ;; reinsert the flags
2267 "Trim lines off top and bottom of difference that are the same.
2268 If lines are the same in both the A and the B versions, strip them off.
2269 \(This can happen when the A and B versions have common lines that the
2270 ancestor version does not share.)"
2272 ;; make sure we are in a real difference
2274 ;; remove the flags
2283 size success sa sb sm)
2284 ;; move down the tops of the difference regions as much as possible
2285 ;; Try advancing comparing 1000 chars at a time.
2286 ;; When that fails, go 500 chars at a time, and so on.
2306 ;; move up the bottoms of the difference regions as much as possible
2307 ;; Try advancing comparing 1000 chars at a time.
2308 ;; When that fails, go 500 chars at a time, and so on.
2317 bottom-a)))
2320 bottom-b)))
2328 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2329 ;; of the difference regions. Move them to the beginning of lines, as
2330 ;; appropriate.
2351 ;; put the flags back in, recenter the display
2356 "Find the difference containing the current position of the point.
2357 If there is no containing difference and the prefix argument is positive,
2358 it finds the nearest following difference. A negative prefix argument finds
2359 the nearest previous difference."
2368 "Find the difference containing point, in the merge buffer.
2369 If there is no containing difference and the prefix argument is positive,
2370 it finds the nearest following difference. A negative prefix argument finds
2371 the nearest previous difference."
2373 ;; search for the point in the merge buffer, using the markers
2374 ;; for the beginning and end of the differences in the merge buffer
2378 "Find the difference containing point, in the A buffer.
2379 This command must be executed in the merge buffer.
2380 If there is no containing difference and the prefix argument is positive,
2381 it finds the nearest following difference. A negative prefix argument finds
2382 the nearest previous difference."
2384 ;; search for the point in the A buffer, using the markers
2385 ;; for the beginning and end of the differences in the A buffer
2391 "Find the difference containing point, in the B buffer.
2392 This command must be executed in the merge buffer.
2393 If there is no containing difference and the prefix argument is positive,
2394 it finds the nearest following difference. A negative prefix argument finds
2395 the nearest previous difference."
2397 ;; search for the point in the B buffer, using the markers
2398 ;; for the beginning and end of the differences in the B buffer
2405 ;; find first difference containing or after the current position
2413 emerge-number-of-differences))
2415 ;; whether the found difference contains the current position
2418 begin))
2419 location)))
2421 ;; numeric value of prefix argument
2425 ;; if the point is in a difference, select it
2427 ;; if the arg is nil and the point is not in a difference, error
2429 ;; if the arg is positive, select the following difference
2432 index
2434 ;; if the arg is negative, select the preceding difference
2441 "Display the current line numbers.
2442 This function displays the line numbers of the points in the A, B, and
2443 merge buffers."
2456 merge-line A-line B-line)))
2469 temp))
2472 "Set `emerge-combine-versions-template' to STRING.
2473 This value controls how `emerge-combine-versions' combines the two versions.
2474 With prefix argument, `emerge-combine-versions-template' is made local to this
2475 merge buffer. Localization is permanent for any particular merge buffer."
2482 "emerge-set-combine-versions-template set locally"
2486 "Copy region into `emerge-combine-versions-template'.
2487 This controls how `emerge-combine-versions' will combine the two versions.
2488 With prefix argument, `emerge-combine-versions-template' is made local to this
2489 merge buffer. Localization is permanent for any particular merge buffer."
2496 "emerge-set-combine-versions-template set locally."
2500 "Combine versions using the template in `emerge-combine-versions-template'.
2501 Refuses to function if this difference has been edited, i.e., if it is
2502 neither the A nor the B variant.
2503 An argument forces the variant to be selected even if the difference has
2504 been edited."
2509 "Combine the two versions using the template in register REG.
2510 See documentation of the variable `emerge-combine-versions-template'
2511 for how the template is interpreted.
2512 Refuses to function if this difference has been edited, i.e., if it is
2513 neither the A nor the B variant.
2514 An argument forces the variant to be selected even if the difference has
2515 been edited."
2526 A-begin A-end B-begin B-end)
2532 A-begin A-end B-begin B-end)
2534 emerge-merge-buffer
2562 "Set the major mode in a merge buffer.
2563 Overrides any change that the mode might make to the mode line or local
2564 keymap. Leaves merge in fast mode."
2579 ;;; Support routines
2581 ;; Select a difference by placing the visual flags around the appropriate
2582 ;; group of lines in the A, B, and merge buffers
2592 after-index)
2595 buffer
2601 ;; insert the flag before the difference
2603 before-index))
2604 here)
2606 ;; insert the flag itself
2609 ;; Put the marker(s) referring to this position 1 character before the
2610 ;; end of the flag, so it won't be damaged by the user.
2611 ;; This gets a bit tricky, as there could be a number of markers
2612 ;; that have to be moved.
2626 ;; insert the flag after the difference
2628 after-index))
2631 ;; insert the flag itself
2633 ;; Put the marker(s) referring to this position 1 character after the
2634 ;; beginning of the flag, so it won't be damaged by the user.
2635 ;; This gets a bit tricky, as there could be a number of markers
2636 ;; that have to be moved.
2651 ;; Unselect a difference by removing the visual flags in the buffers.
2664 buffer
2666 ;; remove the flags, if they're there
2670 ;; the flag isn't there
2676 ;; the flag isn't there
2680 ;; Select a difference, removing any flags that exist now.
2700 ;; Perform tests to see whether user should be allowed to select a version
2701 ;; of this difference:
2702 ;; a valid difference has been selected; and
2703 ;; the difference text in the merge buffer is:
2704 ;; the A version (execute a-version), or
2705 ;; the B version (execute b-version), or
2706 ;; empty (execute neither-version), or
2707 ;; argument FORCE is true (execute neither-version)
2708 ;; Otherwise, signal an error.
2721 emerge-merge-buffer merge-begin
2722 merge-end)
2725 emerge-merge-buffer merge-begin
2726 merge-end)
2732 ;; Read a file name, handling all of the various defaulting rules.
2735 A-file)
2736 ;; `prompt' should not have trailing ": ", so that it can be modified
2737 ;; according to context.
2738 ;; If alternative-default-dir is non-nil, it should be used as the default
2739 ;; directory instead if default-directory, if emerge-default-last-directories
2740 ;; is set.
2741 ;; If default-file is set, it should be used as the default value.
2742 ;; If A-file is set, and its directory is different from
2743 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2744 ;; the default file should be the last part of A-file in the default
2745 ;; directory. (Overriding default-file.)
2747 ;; If this is not the A-file argument (shown by non-nil A-file), and
2748 ;; if emerge-default-last-directories is set, and
2749 ;; the default directory exists but is not the same as the directory of the
2750 ;; A-file,
2751 ;; then make the default file have the same name as the A-file, but in
2752 ;; the default directory.
2754 A-file
2755 alternative-default-dir
2760 alternative-default-dir
2764 ;; If there is a default file, use it.
2767 ;; If emerge-default-last-directories is set, use the
2768 ;; directory from the same argument of the last call of
2769 ;; Emerge as the default for this argument.
2771 alternative-default-dir)
2775 ;; If emerge-default-last-directories is set, use the
2776 ;; directory from the same argument of the last call of
2777 ;; Emerge as the default for this argument.
2779 alternative-default-dir)
2782 ;; Revise the mode line to display which difference we have selected
2788 emerge-number-of-differences
2790 (< emerge-current-difference
2791 emerge-number-of-differences))
2793 emerge-current-difference)
2801 ;; Force mode-line redisplay
2804 ;; compare two regions in two buffers for containing the same text
2806 ;; first check that the two regions are the same length
2808 nil
2811 ;; bite off and compare no more than 1000 characters at a time
2814 buffer-x
2818 buffer-y
2825 t)))
2827 ;; Construct a unique buffer name.
2828 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2829 ;; prefix<3>suffix, etc.
2838 ;; Verify that we have a difference selected.
2844 ;;; Functions for saving and restoring a batch of variables
2846 ;; These functions save (get the values of) and restore (set the values of)
2847 ;; a list of variables. The argument is a list of symbols (the names of
2848 ;; the variables). A list element can also be a list of two functions,
2849 ;; the first of which (when called with no arguments) gets the value, and
2850 ;; the second (when called with a value as an argment) sets the value.
2851 ;; A "function" is anything that funcall can handle as an argument.
2857 vars))
2869 ;; Make a temporary file that only we have access to.
2870 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2873 ;; create the file
2876 f))
2878 ;;; Functions that query the user before he can write out the current buffer.
2881 "Ask the user whether to write out an incomplete merge.
2882 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2883 for details of the querying process."
2888 "Ask the user whether to save an incomplete merge.
2889 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2890 for details of the querying process."
2895 "Ask the user whether to save or write out the incomplete merge.
2896 If answer is yes, call COMMAND interactively. During the call, the flags
2897 around the current difference are removed."
2899 ;; He really wants to do it -- unselect the difference for the duration
2904 ;; call-interactively takes the value of current-prefix-arg as the
2905 ;; prefix argument value to be passed to the command. Thus, we have
2906 ;; to do nothing special to make sure the prefix argument is
2907 ;; transmitted to the command.
2914 ;; He's being smart and not doing it
2917 ;; Make sure the current buffer (for a file) has the same contents as the
2918 ;; file on disk, and attempt to remedy the situation if not.
2919 ;; Signal an error if we can't make them the same, or the user doesn't want
2920 ;; to do what is necessary to make them the same.
2922 ;; First check if the file has been modified since the buffer visited it.
2925 ;; If buffer is not obsolete and is modified, offer to save
2929 ;; If buffer is not obsolete and is not modified, do nothing
2930 nil)
2932 ;; If buffer is obsolete and is modified, give error
2934 ;; If buffer is obsolete and is not modified, offer to revert
2938 \f
2939 ;; Utilities that might have value outside of Emerge.
2941 ;; Set up the mode in the current buffer to duplicate the mode in another
2942 ;; buffer.
2944 ;; Set the major mode
2947 ;; Define a key, even if a prefix of it is defined
2949 "Like `define-key', but forcibly creates prefix characters as needed.
2950 If some prefix of KEY has a non-prefix definition, it is redefined."
2951 ;; Find out if a prefix of key is defined
2953 ;; If so, undefine it
2956 ;; Now define the key
2959 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2960 ;;;;; as the major mode
2961 ;;(defun describe-mode (&optional minor)
2962 ;; "Display documentation of current major mode.
2963 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2964 ;;display documentation of active minor modes as well.
2965 ;;For this to work correctly for a minor mode, the mode's indicator variable
2966 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2967 ;;describes the minor mode."
2968 ;; (interactive)
2969 ;; (with-output-to-temp-buffer "*Help*"
2970 ;; (princ mode-name)
2971 ;; (princ " Mode:\n")
2972 ;; (princ (documentation major-mode))
2973 ;; (let ((minor-modes minor-mode-alist)
2974 ;; (locals (buffer-local-variables)))
2975 ;; (while minor-modes
2976 ;; (let* ((minor-mode (car (car minor-modes)))
2977 ;; (indicator (car (cdr (car minor-modes))))
2978 ;; (local-binding (assq minor-mode locals)))
2979 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2980 ;; ;; bound locally in this buffer, non-nil, and has a function
2981 ;; ;; definition.
2982 ;; (if (and local-binding
2983 ;; (cdr local-binding)
2984 ;; (fboundp minor-mode))
2985 ;; (progn
2986 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
2987 ;; minor-mode indicator))
2988 ;; (princ (documentation minor-mode)))))
2989 ;; (setq minor-modes (cdr minor-modes))))
2990 ;; (print-help-return-message)))
2992 ;; This goes with the redefinition of describe-mode.
2993 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
2994 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
2996 ;; substitute-key-definition should work now.
2997 ;;;; Function to shadow a definition in a keymap with definitions in another.
2998 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
2999 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3000 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3001 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3002 ;;including those whose definition is OLDDEF."
3003 ;; ;; loop through all keymaps accessible from keymap
3004 ;; (let ((maps (accessible-keymaps keymap)))
3005 ;; (while maps
3006 ;; (let ((prefix (car (car maps)))
3007 ;; (map (cdr (car maps))))
3008 ;; ;; examine a keymap
3009 ;; (if (arrayp map)
3010 ;; ;; array keymap
3011 ;; (let ((len (length map))
3012 ;; (i 0))
3013 ;; (while (< i len)
3014 ;; (if (eq (aref map i) olddef)
3015 ;; ;; set the shadowing definition
3016 ;; (let ((key (concat prefix (char-to-string i))))
3017 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3018 ;; (setq i (1+ i))))
3019 ;; ;; sparse keymap
3020 ;; (while map
3021 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3022 ;; ;; set the shadowing definition
3023 ;; (let ((key
3024 ;; (concat prefix (char-to-string (car (car map))))))
3025 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3026 ;; (setq map (cdr map)))))
3027 ;; (setq maps (cdr maps)))))
3029 ;; Define a key if it (or a prefix) is not already defined in the map.
3031 ;; look up the present definition of the key
3034 ;; if it is "too long", look up the valid prefix
3036 ;; if the prefix isn't defined, define it
3038 ;; if there is no present definition, define it
3042 ;; Ordinary substitute-key-definition should do this now.
3043 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3044 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3045 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3046 ;;\(`copy-keymap' will suffice.)"
3047 ;; ;; Loop through all keymaps accessible from keymap
3048 ;; (let ((maps (accessible-keymaps keymap)))
3049 ;; (while maps
3050 ;; ;; Substitute in this keymap
3051 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3052 ;; (setq maps (cdr maps)))))
3054 ;; Show the name of the file in the buffer.
3056 "Displays the name of the file loaded into the current buffer.
3057 If the name won't fit on one line, the minibuffer is expanded to hold it,
3058 and the command waits for a keystroke from the user. If the keystroke is
3059 SPC, it is ignored; if it is anything else, it is processed as a command."
3077 ;; Improved auto-save file names.
3078 ;; This function fixes many problems with the standard auto-save file names:
3079 ;; Auto-save files for non-file buffers get put in the default directory
3080 ;; for the buffer, whether that makes sense or not.
3081 ;; Auto-save files for file buffers get put in the directory of the file,
3082 ;; regardless of whether we can write into it or not.
3083 ;; Auto-save files for non-file buffers don't use the process id, so if a
3084 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3085 ;; each other.
3086 ;; To use this function, do:
3087 ;; (fset 'make-auto-save-file-name
3088 ;; (symbol-function 'emerge-make-auto-save-file-name))
3090 "Return file name to use for auto-saves of current buffer.
3091 Does not consider `auto-save-visited-file-name';
3092 that is checked before calling this function.
3093 You can redefine this for customization.
3094 See also `auto-save-file-name-p'."
3096 ;; if buffer has a file, try the format <file directory>/#<file name>#
3098 "#"
3102 ;; the file is writable, so use it
3103 f
3104 ;; the file isn't writable, so use the format
3105 ;; ~/#&<file name>&<hash of directory>#
3107 "/#&"
3109 "&"
3113 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3115 "/#%"
3116 ;; quote / into \! and \ into \\
3118 "%"
3122 ;; Hash a string into five characters more-or-less suitable for use in a file
3123 ;; name. (Allowed characters are ! through ~, except /.)
3139 ;; Quote any /s in a string by replacing them with \!.
3140 ;; Also, replace any \s by \\, to make it one-to-one.
3152 s)
3154 ;; Metacharacters that have to be protected from the shell when executing
3155 ;; a diff/diff3 command.
3160 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3168 s)
3172 ;;; emerge.el ends here