| blob | b8b085f64e54ceb6068d8873efc16c925441ce7a |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; Author: Dale R. Worley <worley@world.std.com>
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
257 d)
259 env
264 "*Prefix to put on Emerge temporary file names.
272 "*Template for `emerge-combine-versions' to combine the two versions.
273 The template is inserted as a string, with the following interpolations:
274 %a the A version of the difference
275 %b the B version of the difference
276 %% the character `%'
277 Don't forget to end the template with a newline.
278 Note that this variable can be made local to a particular merge buffer by
281 ;; Build keymaps
284 "Keymap of Emerge commands.
285 Directly available in `fast' mode;
289 "Local keymap used in Emerge `fast' mode.
302 "*Command prefix for Emerge commands in `edit' mode.
305 ;; This function sets up the fixed keymaps. It is executed when the first
306 ;; Emerge is done to allow the user maximum time to set up the global keymap.
308 ;; Set up the basic keymap
311 ; - to negative-argument
352 ;; Allow emerge-basic-keymap to be referenced indirectly
354 ;; Set up the fast mode keymap
356 ;; Allow prefixed commands to work in fast mode
358 ;; Allow emerge-fast-keymap to be referenced indirectly
360 ;; Suppress write-file and save-buffer
442 ;; Variables which control each merge. They are local to the merge buffer.
444 ;; Mode variables
458 "The buffer in which the ancestor variant is stored,
463 buffer-read-only
464 buffer-auto-save-file-name)
465 "Variables and properties of a buffer which are saved, modified and restored
476 "Vector of differences between the variants, and markers in the buffers to
477 show where they are. Each difference is represented by a vector of seven
478 elements. The first two are markers to the beginning and end of the difference
479 section in the A buffer, the second two are markers for the B buffer, the third
481 that difference in the merge buffer.
482 A section of a buffer is described by two markers, one to the beginning of
483 the first line of the section, and one to the beginning of the first line
484 after the section. (If the section is empty, both markers point to the same
485 point.) If the section is part of the selected difference, then the markers
486 are moved into the flags, so the user can edit the section without disturbing
487 the markers.
489 A the merge buffer currently contains the A variant
490 B the merge buffer currently contains the B variant
491 default-A the merge buffer contains the A variant by default,
492 but this difference hasn't been selected yet, so
493 change-default commands can alter it
494 default-B the merge buffer contains the B variant by default,
495 but this difference hasn't been selected yet, so
496 change-default commands can alter it
497 prefer-A in a three-file merge, the A variant is the preferred
498 choice
499 prefer-B in a three-file merge, the B variant is the preferred
506 "The local keymap for the merge buffer, with the emerge commands defined in
507 it. Used to save the local keymap during fast mode, when the local keymap is
512 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
515 "*If non-nil, differences for which there is a preference are automatically
518 "Hooks to run in the merge buffer after the merge has been finished.
519 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
520 command.
525 ;;; Setup functions for two-file mode.
528 output-file)
535 ;; Record the directories of the files
540 ;; Make sure the entire files are seen, and they reflect what is on disk
542 buffer-A
547 startup-hooks
549 startup-hooks))
550 ;; Verify that the file matches the buffer
553 buffer-B
558 startup-hooks
560 startup-hooks))
561 ;; Verify that the file matches the buffer
564 output-file)))
566 ;; Start up Emerge on two files
568 output-file)
573 ;; create the merge buffer from buffer A, so it inherits buffer A's
574 ;; default directory, etc.
576 buffer-A
579 merge-buffer
605 ;; Generate the Emerge difference list between two files
609 emerge-diff-buffer
613 emerge-diff-program emerge-diff-options
616 t))
619 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
625 diff-buffer
634 a-begin)))
642 b-begin))))
643 ;; fix the beginning and end numbers, because diff is somewhat
644 ;; strange about how it numbers lines
655 ;; (string-equal diff-type "c")
660 b-begin b-end
662 list)))))
665 ;; Set up buffer of diff/diff3 error messages.
669 emerge-diff-error-buffer
674 ;;; Top-level and setup functions for three-file mode.
677 &optional startup-hooks quit-hooks
678 output-file)
688 ;; Record the directories of the files
694 ;; Make sure the entire files are seen, and they reflect what is on disk
696 buffer-A
701 startup-hooks
703 startup-hooks))
704 ;; Verify that the file matches the buffer
707 buffer-B
712 startup-hooks
714 startup-hooks))
715 ;; Verify that the file matches the buffer
718 buffer-ancestor
723 startup-hooks
725 startup-hooks))
726 ;; Verify that the file matches the buffer
729 buffer-ancestor file-ancestor
730 startup-hooks quit-hooks output-file)))
732 ;; Start up Emerge on two files with an ancestor
734 buffer-ancestor file-ancestor
735 &optional startup-hooks quit-hooks
736 output-file)
742 ;; create the merge buffer from buffer A, so it inherits buffer A's
743 ;; default directory, etc.
745 buffer-A
748 merge-buffer
776 ;; Generate the Emerge difference list between two files with an ancestor
780 emerge-diff-buffer
784 emerge-diff3-program emerge-diff-options
788 t))
791 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
797 diff-buffer
799 ;; leave point after matched line
802 ;; if the A and B files are the same, ignore the difference
816 list))))))
820 ;; This save-excursion allows emerge-get-diff3-group to be called for the
821 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
822 ;; appear in any order. The reason this is necessary is that Gnu diff3
823 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
828 ;; treatment depends on whether it is an "a" group or a "c" group
830 ;; it is a "c" group
832 ;; it has two numbers
837 ;; it has one number
841 ;; it is an "a" group
846 ;;; Functions to start Emerge on files
848 ;;;###autoload
850 quit-hooks)
851 "Run Emerge on two files."
856 nil nil t))
860 f f nil)))))
864 file-A file-B startup-hooks
865 quit-hooks
866 file-out))
868 ;;;###autoload
871 "Run Emerge on two files, giving another file as the ancestor."
876 nil nil t))
879 nil f t)
882 f f nil)))))
886 file-A file-B file-ancestor startup-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 bottom
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
1984 "Set edit mode, for Emerge.
1985 In this mode ordinary Emacs commands are available, and Emerge commands
1997 "Toggle Auto-Advance mode, for Emerge.
1998 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
1999 advance to the next difference.
2000 With a positive argument, turn on Auto-Advance mode.
2001 With a negative argument, turn off Auto-Advance mode."
2007 "Auto-advance set"
2012 "Toggle Skip-Prefers mode, for Emerge.
2013 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2014 to automatically skip over differences for which there is a preference.
2015 With a positive argument, turn on Skip-Prefers mode.
2016 With a negative argument, turn off Skip-Prefers mode."
2022 "Skip-prefers set"
2027 "Put the A variant of this difference in the kill ring."
2034 ;; so further kills don't append
2035 this-command)
2041 "Put the B variant of this difference in the kill ring."
2048 ;; so further kills don't append
2049 this-command)
2055 "Insert the A variant of this difference at the point.
2056 Leaves point after text, mark before.
2057 With prefix argument, puts point before, mark after."
2073 "Insert the B variant of this difference at the point.
2074 Leaves point after text, mark before.
2075 With prefix argument, puts point before, mark after."
2091 "Leaves the point before this difference and the mark after it.
2092 With prefix argument, puts mark before, point after."
2107 "Show the names of the buffers or files being operated on by Emerge.
2108 Use C-u l to reset the windows afterward."
2151 "Join the selected difference with the following one.
2152 With a prefix argument, join with the preceding one."
2155 ;; adjust n to be first difference to join
2158 ;; n and n+1 are the differences to join
2159 ;; check that they are both differences
2162 ;; remove the flags
2164 ;; decrement total number of differences
2166 ;; build new differences vector
2186 ps)
2193 ;; set the current difference correctly
2195 ;; fix the mode line
2197 ;; reinsert the flags
2202 "Split the current difference where the points are in the three windows."
2205 ;; check that this is a valid difference
2207 ;; get the point values and old difference
2214 ;; check location of the points, give error if they aren't in the
2215 ;; differences
2225 ;; remove the flags
2227 ;; increment total number of differences
2229 ;; build new differences vector
2241 A-point
2243 B-point
2245 merge-point
2257 ;; set the current difference correctly
2259 ;; fix the mode line
2261 ;; reinsert the flags
2266 "Trim lines off top and bottom of difference that are the same.
2267 If lines are the same in both the A and the B versions, strip them off.
2268 \(This can happen when the A and B versions have common lines that the
2269 ancestor version does not share.)"
2271 ;; make sure we are in a real difference
2273 ;; remove the flags
2282 size success sa sb sm)
2283 ;; move down the tops of the difference regions as much as possible
2284 ;; Try advancing comparing 1000 chars at a time.
2285 ;; When that fails, go 500 chars at a time, and so on.
2305 ;; move up the bottoms of the difference regions as much as possible
2306 ;; Try advancing comparing 1000 chars at a time.
2307 ;; When that fails, go 500 chars at a time, and so on.
2316 bottom-a)))
2319 bottom-b)))
2327 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2328 ;; of the difference regions. Move them to the beginning of lines, as
2329 ;; appropriate.
2350 ;; put the flags back in, recenter the display
2355 "Find the difference containing the current position of the point.
2356 If there is no containing difference and the prefix argument is positive,
2357 it finds the nearest following difference. A negative prefix argument finds
2358 the nearest previous difference."
2367 "Find the difference containing point, in the merge buffer.
2368 If there is no containing difference and the prefix argument is positive,
2369 it finds the nearest following difference. A negative prefix argument finds
2370 the nearest previous difference."
2372 ;; search for the point in the merge buffer, using the markers
2373 ;; for the beginning and end of the differences in the merge buffer
2377 "Find the difference containing point, in the A buffer.
2378 This command must be executed in the merge buffer.
2379 If there is no containing difference and the prefix argument is positive,
2380 it finds the nearest following difference. A negative prefix argument finds
2381 the nearest previous difference."
2383 ;; search for the point in the A buffer, using the markers
2384 ;; for the beginning and end of the differences in the A buffer
2390 "Find the difference containing point, in the B buffer.
2391 This command must be executed in the merge buffer.
2392 If there is no containing difference and the prefix argument is positive,
2393 it finds the nearest following difference. A negative prefix argument finds
2394 the nearest previous difference."
2396 ;; search for the point in the B buffer, using the markers
2397 ;; for the beginning and end of the differences in the B buffer
2404 ;; find first difference containing or after the current position
2412 emerge-number-of-differences))
2414 ;; whether the found difference contains the current position
2417 begin))
2418 location)))
2420 ;; numeric value of prefix argument
2424 ;; if the point is in a difference, select it
2426 ;; if the arg is nil and the point is not in a difference, error
2428 ;; if the arg is positive, select the following difference
2431 index
2433 ;; if the arg is negative, select the preceding difference
2440 "Display the current line numbers.
2441 This function displays the line numbers of the points in the A, B, and
2442 merge buffers."
2455 merge-line A-line B-line)))
2468 temp))
2471 "Set `emerge-combine-versions-template' to STRING.
2472 This value controls how `emerge-combine-versions' combines the two versions.
2473 With prefix argument, `emerge-combine-versions-template' is made local to this
2474 merge buffer. Localization is permanent for any particular merge buffer."
2481 "emerge-set-combine-versions-template set locally"
2485 "Copy region into `emerge-combine-versions-template'.
2486 This controls how `emerge-combine-versions' will combine the two versions.
2487 With prefix argument, `emerge-combine-versions-template' is made local to this
2488 merge buffer. Localization is permanent for any particular merge buffer."
2495 "emerge-set-combine-versions-template set locally."
2499 "Combine versions using the template in `emerge-combine-versions-template'.
2500 Refuses to function if this difference has been edited, i.e., if it is
2501 neither the A nor the B variant.
2502 An argument forces the variant to be selected even if the difference has
2503 been edited."
2508 "Combine the two versions using the template in register REG.
2509 See documentation of the variable `emerge-combine-versions-template'
2510 for how the template is interpreted.
2511 Refuses to function if this difference has been edited, i.e., if it is
2512 neither the A nor the B variant.
2513 An argument forces the variant to be selected even if the difference has
2514 been edited."
2525 A-begin A-end B-begin B-end)
2531 A-begin A-end B-begin B-end)
2533 emerge-merge-buffer
2561 "Set the major mode in a merge buffer.
2562 Overrides any change that the mode might make to the mode line or local
2563 keymap. Leaves merge in fast mode."
2578 ;;; Support routines
2580 ;; Select a difference by placing the visual flags around the appropriate
2581 ;; group of lines in the A, B, and merge buffers
2591 after-index)
2594 buffer
2600 ;; insert the flag before the difference
2602 before-index))
2603 here)
2605 ;; insert the flag itself
2608 ;; Put the marker(s) referring to this position 1 character before the
2609 ;; end of the flag, so it won't be damaged by the user.
2610 ;; This gets a bit tricky, as there could be a number of markers
2611 ;; that have to be moved.
2625 ;; insert the flag after the difference
2627 after-index))
2630 ;; insert the flag itself
2632 ;; Put the marker(s) referring to this position 1 character after the
2633 ;; beginning of the flag, so it won't be damaged by the user.
2634 ;; This gets a bit tricky, as there could be a number of markers
2635 ;; that have to be moved.
2650 ;; Unselect a difference by removing the visual flags in the buffers.
2663 buffer
2665 ;; remove the flags, if they're there
2669 ;; the flag isn't there
2675 ;; the flag isn't there
2679 ;; Select a difference, removing any flags that exist now.
2699 ;; Perform tests to see whether user should be allowed to select a version
2700 ;; of this difference:
2701 ;; a valid difference has been selected; and
2702 ;; the difference text in the merge buffer is:
2703 ;; the A version (execute a-version), or
2704 ;; the B version (execute b-version), or
2705 ;; empty (execute neither-version), or
2706 ;; argument FORCE is true (execute neither-version)
2707 ;; Otherwise, signal an error.
2720 emerge-merge-buffer merge-begin
2721 merge-end)
2724 emerge-merge-buffer merge-begin
2725 merge-end)
2731 ;; Read a file name, handling all of the various defaulting rules.
2734 A-file must-match)
2735 ;; `prompt' should not have trailing ": ", so that it can be modified
2736 ;; according to context.
2737 ;; If alternative-default-dir is non-nil, it should be used as the default
2738 ;; directory instead if default-directory, if emerge-default-last-directories
2739 ;; is set.
2740 ;; If default-file is set, it should be used as the default value.
2741 ;; If A-file is set, and its directory is different from
2742 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2743 ;; the default file should be the last part of A-file in the default
2744 ;; directory. (Overriding default-file.)
2746 ;; If this is not the A-file argument (shown by non-nil A-file), and
2747 ;; if emerge-default-last-directories is set, and
2748 ;; the default directory exists but is not the same as the directory of the
2749 ;; A-file,
2750 ;; then make the default file have the same name as the A-file, but in
2751 ;; the default directory.
2753 A-file
2754 alternative-default-dir
2759 alternative-default-dir
2763 ;; If there is a default file, use it.
2766 ;; If emerge-default-last-directories is set, use the
2767 ;; directory from the same argument of the last call of
2768 ;; Emerge as the default for this argument.
2770 alternative-default-dir)
2774 ;; If emerge-default-last-directories is set, use the
2775 ;; directory from the same argument of the last call of
2776 ;; Emerge as the default for this argument.
2778 alternative-default-dir)
2781 ;; Revise the mode line to display which difference we have selected
2787 emerge-number-of-differences
2789 (< emerge-current-difference
2790 emerge-number-of-differences))
2792 emerge-current-difference)
2802 ;; compare two regions in two buffers for containing the same text
2804 ;; first check that the two regions are the same length
2806 nil
2809 ;; bite off and compare no more than 1000 characters at a time
2812 buffer-x
2816 buffer-y
2823 t)))
2825 ;; Construct a unique buffer name.
2826 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2827 ;; prefix<3>suffix, etc.
2836 ;; Verify that we have a difference selected.
2842 ;;; Functions for saving and restoring a batch of variables
2844 ;; These functions save (get the values of) and restore (set the values of)
2845 ;; a list of variables. The argument is a list of symbols (the names of
2846 ;; the variables). A list element can also be a list of two functions,
2847 ;; the first of which (when called with no arguments) gets the value, and
2848 ;; the second (when called with a value as an argument) sets the value.
2849 ;; A "function" is anything that funcall can handle as an argument.
2855 vars))
2867 ;; Make a temporary file that only we have access to.
2868 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2871 ;; create the file
2874 f))
2876 ;;; Functions that query the user before he can write out the current buffer.
2879 "Ask the user whether to write out an incomplete merge.
2880 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2881 for details of the querying process."
2886 "Ask the user whether to save an incomplete merge.
2887 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2888 for details of the querying process."
2893 "Ask the user whether to save or write out the incomplete merge.
2894 If answer is yes, call COMMAND interactively. During the call, the flags
2895 around the current difference are removed."
2897 ;; He really wants to do it -- unselect the difference for the duration
2902 ;; call-interactively takes the value of current-prefix-arg as the
2903 ;; prefix argument value to be passed to the command. Thus, we have
2904 ;; to do nothing special to make sure the prefix argument is
2905 ;; transmitted to the command.
2912 ;; He's being smart and not doing it
2915 ;; Make sure the current buffer (for a file) has the same contents as the
2916 ;; file on disk, and attempt to remedy the situation if not.
2917 ;; Signal an error if we can't make them the same, or the user doesn't want
2918 ;; to do what is necessary to make them the same.
2920 ;; First check if the file has been modified since the buffer visited it.
2923 ;; If buffer is not obsolete and is modified, offer to save
2927 ;; If buffer is not obsolete and is not modified, do nothing
2928 nil)
2930 ;; If buffer is obsolete and is modified, give error
2932 ;; If buffer is obsolete and is not modified, offer to revert
2936 \f
2937 ;; Utilities that might have value outside of Emerge.
2939 ;; Set up the mode in the current buffer to duplicate the mode in another
2940 ;; buffer.
2942 ;; Set the major mode
2945 ;; Define a key, even if a prefix of it is defined
2947 "Like `define-key', but forcibly creates prefix characters as needed.
2948 If some prefix of KEY has a non-prefix definition, it is redefined."
2949 ;; Find out if a prefix of key is defined
2951 ;; If so, undefine it
2954 ;; Now define the key
2957 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2958 ;;;;; as the major mode
2959 ;;(defun describe-mode (&optional minor)
2960 ;; "Display documentation of current major mode.
2961 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2962 ;;display documentation of active minor modes as well.
2963 ;;For this to work correctly for a minor mode, the mode's indicator variable
2964 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2965 ;;describes the minor mode."
2966 ;; (interactive)
2967 ;; (with-output-to-temp-buffer "*Help*"
2968 ;; (princ mode-name)
2969 ;; (princ " Mode:\n")
2970 ;; (princ (documentation major-mode))
2971 ;; (let ((minor-modes minor-mode-alist)
2972 ;; (locals (buffer-local-variables)))
2973 ;; (while minor-modes
2974 ;; (let* ((minor-mode (car (car minor-modes)))
2975 ;; (indicator (car (cdr (car minor-modes))))
2976 ;; (local-binding (assq minor-mode locals)))
2977 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2978 ;; ;; bound locally in this buffer, non-nil, and has a function
2979 ;; ;; definition.
2980 ;; (if (and local-binding
2981 ;; (cdr local-binding)
2982 ;; (fboundp minor-mode))
2983 ;; (progn
2984 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
2985 ;; minor-mode indicator))
2986 ;; (princ (documentation minor-mode)))))
2987 ;; (setq minor-modes (cdr minor-modes))))
2988 ;; (save-excursion
2989 ;; (set-buffer standard-output)
2990 ;; (help-mode))
2991 ;; (print-help-return-message)))
2993 ;; This goes with the redefinition of describe-mode.
2994 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
2995 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
2997 ;; substitute-key-definition should work now.
2998 ;;;; Function to shadow a definition in a keymap with definitions in another.
2999 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3000 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3001 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3002 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3003 ;;including those whose definition is OLDDEF."
3004 ;; ;; loop through all keymaps accessible from keymap
3005 ;; (let ((maps (accessible-keymaps keymap)))
3006 ;; (while maps
3007 ;; (let ((prefix (car (car maps)))
3008 ;; (map (cdr (car maps))))
3009 ;; ;; examine a keymap
3010 ;; (if (arrayp map)
3011 ;; ;; array keymap
3012 ;; (let ((len (length map))
3013 ;; (i 0))
3014 ;; (while (< i len)
3015 ;; (if (eq (aref map i) olddef)
3016 ;; ;; set the shadowing definition
3017 ;; (let ((key (concat prefix (char-to-string i))))
3018 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3019 ;; (setq i (1+ i))))
3020 ;; ;; sparse keymap
3021 ;; (while map
3022 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3023 ;; ;; set the shadowing definition
3024 ;; (let ((key
3025 ;; (concat prefix (char-to-string (car (car map))))))
3026 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3027 ;; (setq map (cdr map)))))
3028 ;; (setq maps (cdr maps)))))
3030 ;; Define a key if it (or a prefix) is not already defined in the map.
3032 ;; look up the present definition of the key
3035 ;; if it is "too long", look up the valid prefix
3037 ;; if the prefix isn't defined, define it
3039 ;; if there is no present definition, define it
3043 ;; Ordinary substitute-key-definition should do this now.
3044 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3045 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3046 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3047 ;;\(`copy-keymap' will suffice.)"
3048 ;; ;; Loop through all keymaps accessible from keymap
3049 ;; (let ((maps (accessible-keymaps keymap)))
3050 ;; (while maps
3051 ;; ;; Substitute in this keymap
3052 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3053 ;; (setq maps (cdr maps)))))
3055 ;; Show the name of the file in the buffer.
3057 "Displays the name of the file loaded into the current buffer.
3058 If the name won't fit on one line, the minibuffer is expanded to hold it,
3059 and the command waits for a keystroke from the user. If the keystroke is
3060 SPC, it is ignored; if it is anything else, it is processed as a command."
3078 ;; Improved auto-save file names.
3079 ;; This function fixes many problems with the standard auto-save file names:
3080 ;; Auto-save files for non-file buffers get put in the default directory
3081 ;; for the buffer, whether that makes sense or not.
3082 ;; Auto-save files for file buffers get put in the directory of the file,
3083 ;; regardless of whether we can write into it or not.
3084 ;; Auto-save files for non-file buffers don't use the process id, so if a
3085 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3086 ;; each other.
3087 ;; To use this function, do:
3088 ;; (fset 'make-auto-save-file-name
3089 ;; (symbol-function 'emerge-make-auto-save-file-name))
3091 "Return file name to use for auto-saves of current buffer.
3092 Does not consider `auto-save-visited-file-name';
3093 that is checked before calling this function.
3094 You can redefine this for customization.
3095 See also `auto-save-file-name-p'."
3097 ;; if buffer has a file, try the format <file directory>/#<file name>#
3099 "#"
3103 ;; the file is writable, so use it
3104 f
3105 ;; the file isn't writable, so use the format
3106 ;; ~/#&<file name>&<hash of directory>#
3108 "/#&"
3110 "&"
3114 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3116 "/#%"
3117 ;; quote / into \! and \ into \\
3119 "%"
3123 ;; Hash a string into five characters more-or-less suitable for use in a file
3124 ;; name. (Allowed characters are ! through ~, except /.)
3140 ;; Quote any /s in a string by replacing them with \!.
3141 ;; Also, replace any \s by \\, to make it one-to-one.
3153 s)
3155 ;; Metacharacters that have to be protected from the shell when executing
3156 ;; a diff/diff3 command.
3161 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3169 s)
3173 ;;; emerge.el ends here