| blob | b3e411735e3fce23c05f265c7fc5e7582632863f |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; This file is part of GNU Emacs.
7 ;; Author: Dale R. Worley <worley@world.std.com>
8 ;; Version: 5fsf
9 ;; Keywords: unix, tools
11 ;; This software was created by Dale R. Worley and is
12 ;; distributed free of charge. It is placed in the public domain and
13 ;; permission is granted to anyone to use, duplicate, modify and redistribute
14 ;; it provided that this notice is attached.
16 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
17 ;; with respect to this software. The entire risk as to the quality and
18 ;; performance of this software is with the user. IN NO EVENT WILL DALE
19 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
20 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
21 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
22 ;; DAMAGES.
24 ;;; Commentary:
26 ;;; Code:
28 ;;;###autoload
30 ;;;###autoload
33 ;;;###autoload
36 ;;;###autoload
39 ;;;###autoload
42 ;;;###autoload
45 ;;;###autoload
48 ;;;###autoload
51 ;;;###autoload
55 ;;; Macros
58 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
59 Differs from `save-excursion' in that it doesn't save the point and mark."
68 "Defines SYMBOL as an advertised variable.
69 Performs a defvar, then executes `make-variable-buffer-local' on
70 the variable. Also sets the `preserved' property, so that
71 `kill-all-local-variables' (called by major-mode setting commands)
72 won't destroy Emerge control variables."
78 ;; Add entries to minor-mode-alist so that emerge modes show correctly
87 minor-mode-alist)))
89 ;; We need to define this function so describe-mode can describe Emerge mode.
91 "Emerge mode is used by the Emerge file-merging package.
92 It is entered only through one of the functions:
93 `emerge-files'
94 `emerge-files-with-ancestor'
95 `emerge-buffers'
96 `emerge-buffers-with-ancestor'
97 `emerge-files-command'
98 `emerge-files-with-ancestor-command'
99 `emerge-files-remote'
100 `emerge-files-with-ancestor-remote'
102 Commands:
111 "Return string describing the version of Emerge.
112 When called interactively, displays the version."
116 emerge-version))
118 ;;; Emerge configuration variables
121 "Merge diffs under Emacs control."
124 ;; Commands that produce difference files
125 ;; All that can be configured is the name of the programs to execute
126 ;; (emerge-diff-program and emerge-diff3-program) and the options
127 ;; to be provided (emerge-diff-options). The order in which the file names
128 ;; are given is fixed.
129 ;; The file names are always expanded (see expand-file-name) before being
130 ;; passed to diff, thus they need not be invoked under a shell that
131 ;; understands `~'.
132 ;; The code which processes the diff/diff3 output depends on all the
133 ;; finicky details of their output, including the somewhat strange
134 ;; way they number lines of a file.
136 "*Name of the program which compares two files."
140 "*Name of the program which compares three files.
141 Its arguments are the ancestor file and the two variant files."
145 "*Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
151 "*Pattern to match lines produced by diff that describe differences.
152 This is as opposed to lines from the source files."
157 "*Regexp that matches normal output lines from `emerge-diff-program'.
158 Lines that do not match are assumed to be error messages."
163 "*Regexp that matches normal output lines from `emerge-diff3-program'.
164 Lines that do not match are assumed to be error messages."
169 "*Name of the program that checks in RCS revisions."
173 "*Name of the program that checks out RCS revisions."
178 "*Non-nil if Emerge should process local-variables lists in merge buffers.
179 \(You can explicitly request processing the local-variables
180 by executing `(hack-local-variables)'.)"
184 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
185 It concludes that an input version has been deleted when an ancestor entry
186 is present, only one A or B entry is present, and an output entry is present.
187 If nil: In such circumstances, the A or B file that is present will be
188 copied to the designated output file."
193 "*Flag placed above the highlighted block of code. Must end with newline.
194 Must be set before Emerge is loaded, or emerge-new-flags must be run
195 after setting."
199 "*Flag placed below the highlighted block of code. Must end with newline.
200 Must be set before Emerge is loaded, or emerge-new-flags must be run
201 after setting."
205 ;; Hook variables
208 "*Hook to run in the merge buffer after the merge has been set up."
212 "*Hook to run after a difference has been selected.
213 The variable `n' holds the (internal) number of the difference."
217 "*Hook to run after a difference has been unselected.
218 The variable `n' holds the (internal) number of the difference."
222 ;; Variables to control the default directories of the arguments to
223 ;; Emerge commands.
226 "*If nil, default dir for filenames in emerge is `default-directory'.
227 If non-nil, filenames complete in the directory of the last argument of the
228 same type to an `emerge-files...' command."
261 ;; The flags used to mark differences in the buffers.
263 ;; These function definitions need to be up here, because they are used
264 ;; during loading.
266 "Function to be called after `emerge-{before,after}-flag'.
267 This is called after these functions are changed to compute values that
268 depend on the flags."
279 "Return the number of matches in STRING for REGEXP."
285 count))
287 ;; Calculate dependent variables
291 "*Number of lines that we want to show above and below the flags when we are
292 displaying a difference."
298 "*Prefix to put on Emerge temporary file names.
299 Do not start with `~/' or `~USERNAME/'."
304 "*Mode for Emerge temporary files."
310 "*Template for `emerge-combine-versions' to combine the two versions.
311 The template is inserted as a string, with the following interpolations:
312 %a the A version of the difference
313 %b the B version of the difference
314 %% the character `%'
315 Don't forget to end the template with a newline.
316 Note that this variable can be made local to a particular merge buffer by
317 giving a prefix argument to `emerge-set-combine-versions-template'."
321 ;; Build keymaps
324 "Keymap of Emerge commands.
325 Directly available in `fast' mode;
329 "Local keymap used in Emerge `fast' mode.
342 "*Command prefix for Emerge commands in `edit' mode.
343 Must be set before Emerge is loaded."
347 ;; This function sets up the fixed keymaps. It is executed when the first
348 ;; Emerge is done to allow the user maximum time to set up the global keymap.
350 ;; Set up the basic keymap
353 ; - to negative-argument
394 ;; Allow emerge-basic-keymap to be referenced indirectly
396 ;; Set up the fast mode keymap
398 ;; Allow prefixed commands to work in fast mode
400 ;; Allow emerge-fast-keymap to be referenced indirectly
402 ;; Suppress write-file and save-buffer
482 ;; Variables which control each merge. They are local to the merge buffer.
484 ;; Mode variables
498 "The buffer in which the ancestor variant is stored,
503 buffer-read-only
504 buffer-auto-save-file-name)
505 "Variables and properties of a buffer which are saved, modified and restored
516 "Vector of differences between the variants, and markers in the buffers to
517 show where they are. Each difference is represented by a vector of seven
518 elements. The first two are markers to the beginning and end of the difference
519 section in the A buffer, the second two are markers for the B buffer, the third
521 that difference in the merge buffer.
522 A section of a buffer is described by two markers, one to the beginning of
523 the first line of the section, and one to the beginning of the first line
524 after the section. (If the section is empty, both markers point to the same
525 point.) If the section is part of the selected difference, then the markers
526 are moved into the flags, so the user can edit the section without disturbing
527 the markers.
529 A the merge buffer currently contains the A variant
530 B the merge buffer currently contains the B variant
531 default-A the merge buffer contains the A variant by default,
532 but this difference hasn't been selected yet, so
533 change-default commands can alter it
534 default-B the merge buffer contains the B variant by default,
535 but this difference hasn't been selected yet, so
536 change-default commands can alter it
537 prefer-A in a three-file merge, the A variant is the preferred
538 choice
539 prefer-B in a three-file merge, the B variant is the preferred
546 "The local keymap for the merge buffer, with the emerge commands defined in
547 it. Used to save the local keymap during fast mode, when the local keymap is
552 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
555 "*If non-nil, differences for which there is a preference are automatically
558 "Hooks to run in the merge buffer after the merge has been finished.
559 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
560 command.
565 ;;; Setup functions for two-file mode.
568 output-file)
575 ;; Record the directories of the files
580 ;; Make sure the entire files are seen, and they reflect what is on disk
582 buffer-A
587 startup-hooks
589 startup-hooks))
590 ;; Verify that the file matches the buffer
593 buffer-B
598 startup-hooks
600 startup-hooks))
601 ;; Verify that the file matches the buffer
604 output-file)))
606 ;; Start up Emerge on two files
608 output-file)
613 ;; create the merge buffer from buffer A, so it inherits buffer A's
614 ;; default directory, etc.
616 buffer-A
619 merge-buffer
645 ;; Generate the Emerge difference list between two files
649 emerge-diff-buffer
653 emerge-diff-program emerge-diff-options
656 t))
659 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
665 diff-buffer
674 a-begin)))
682 b-begin))))
683 ;; fix the beginning and end numbers, because diff is somewhat
684 ;; strange about how it numbers lines
695 ;; (string-equal diff-type "c")
700 b-begin b-end
702 list)))))
705 ;; Set up buffer of diff/diff3 error messages.
709 emerge-diff-error-buffer
714 ;;; Top-level and setup functions for three-file mode.
717 &optional startup-hooks quit-hooks
718 output-file)
728 ;; Record the directories of the files
734 ;; Make sure the entire files are seen, and they reflect what is on disk
736 buffer-A
741 startup-hooks
743 startup-hooks))
744 ;; Verify that the file matches the buffer
747 buffer-B
752 startup-hooks
754 startup-hooks))
755 ;; Verify that the file matches the buffer
758 buffer-ancestor
763 startup-hooks
765 startup-hooks))
766 ;; Verify that the file matches the buffer
769 buffer-ancestor file-ancestor
770 startup-hooks quit-hooks output-file)))
772 ;; Start up Emerge on two files with an ancestor
774 buffer-ancestor file-ancestor
775 &optional startup-hooks quit-hooks
776 output-file)
782 ;; create the merge buffer from buffer A, so it inherits buffer A's
783 ;; default directory, etc.
785 buffer-A
788 merge-buffer
816 ;; Generate the Emerge difference list between two files with an ancestor
820 emerge-diff-buffer
824 emerge-diff3-program emerge-diff-options
828 t))
831 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
837 diff-buffer
839 ;; leave point after matched line
842 ;; if the A and B files are the same, ignore the difference
856 list))))))
860 ;; This save-excursion allows emerge-get-diff3-group to be called for the
861 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
862 ;; appear in any order. The reason this is necessary is that Gnu diff3
863 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
868 ;; treatment depends on whether it is an "a" group or a "c" group
870 ;; it is a "c" group
872 ;; it has two numbers
877 ;; it has one number
881 ;; it is an "a" group
886 ;;; Functions to start Emerge on files
888 ;;;###autoload
890 quit-hooks)
891 "Run Emerge on two files."
896 nil nil t))
900 f f nil)))))
904 file-A file-B startup-hooks
905 quit-hooks
906 file-out))
908 ;;;###autoload
911 "Run Emerge on two files, giving another file as the ancestor."
916 nil nil t))
919 nil f t)
922 f f nil)))))
926 file-A file-B file-ancestor startup-hooks
927 quit-hooks
928 file-out))
930 ;; Write the merge buffer out in place of the file the A buffer is visiting.
932 ;; if merge was successful was given, save to disk
936 ;;; Functions to start Emerge on buffers
938 ;;;###autoload
940 "Run Emerge on two buffers."
945 buffer-A
948 buffer-B
955 startup-hooks)
956 quit-hooks
957 nil)))
959 ;;;###autoload
961 &optional startup-hooks
962 quit-hooks)
963 "Run Emerge on two buffers, giving another buffer as the ancestor."
970 buffer-A
973 buffer-B
976 buffer-ancestor
982 emerge-file-ancestor
988 startup-hooks)
989 quit-hooks
990 nil)))
992 ;;; Functions to start Emerge from the command line
994 ;;;###autoload
1001 file-a file-b nil
1004 ;;;###autoload
1007 ;; check for a -a flag, for filemerge compatibility
1009 ;; arguments are "-a ancestor file-a file-b file-out"
1016 ;; arguments are "file-a file-b ancestor file-out"
1023 file-a file-b file-anc nil
1030 ;;; Functions to start Emerge via remote request
1032 ;;;###autoload
1036 file-a file-b nil
1038 file-out)
1041 ;;;###autoload
1045 file-a file-b file-anc nil
1047 file-out)
1055 ;;; Functions to start Emerge on RCS versions
1057 ;;;###autoload
1060 "Emerge two RCS revisions of a file."
1067 emerge-last-revision-B revision-B)
1069 file revision-A revision-B startup-hooks
1074 quit-hooks)
1075 quit-hooks)))
1077 ;;;###autoload
1079 revision-B ancestor
1080 &optional
1081 startup-hooks quit-hooks)
1082 "Emerge two RCS revisions of a file, with another revision as ancestor."
1090 emerge-last-revision-B revision-B
1091 emerge-last-revision-ancestor ancestor)
1093 file revision-A revision-B ancestor startup-hooks
1099 quit-hooks))
1100 quit-hooks)))
1103 startup-hooks quit-hooks output-file)
1108 ;; Get the revisions into buffers
1110 buffer-A
1114 t)
1118 buffer-B
1122 t)
1125 ;; Do the merge
1127 buffer-B emerge-file-B
1131 startup-hooks)
1133 quit-hooks)
1134 nil)))
1137 ancestor
1138 &optional startup-hooks
1139 quit-hooks output-file)
1146 ;; Get the revisions into buffers
1148 buffer-A
1152 revision-A file)
1153 t)
1157 buffer-B
1161 t)
1165 buffer-ancestor
1169 t)
1172 ;; Do the merge
1174 buffer-A emerge-file-A buffer-B emerge-file-B
1175 buffer-ancestor emerge-ancestor
1180 startup-hooks)
1182 quit-hooks)
1183 output-file)))
1185 ;;; Function to start Emerge based on a line in a file
1188 "Run Emerge using files named in current text line.
1189 Looks in that line for whitespace-separated entries of these forms:
1190 a=file1
1191 b=file2
1192 ancestor=file3
1193 output=file4
1194 to specify the files to use in Emerge.
1196 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1197 is present:
1198 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1199 it is assumed that the file in question has been deleted, and it is
1200 not copied to the output file.
1201 Otherwise, the A or B file present is copied to the output file."
1205 ;; Stop if at end of buffer (even though we might be in a line, if
1206 ;; the line does not end with newline)
1209 ;; Go to the beginning of the line
1211 ;; Skip any initial whitespace
1214 ;; Process the entire line
1216 ;; Get the next entry
1218 ;; Break apart the tab (before =) and the filename (after =)
1222 ;; Move point after the entry
1224 ;; Store the filename in the right variable
1244 ;; If the match on the entry pattern failed
1246 ;; Make sure that file-A and file-B are present
1251 ;; Go to the beginning of the next line, so next execution will use
1252 ;; next line in buffer.
1254 ;; Execute the correct command
1256 ;; Merge of two files with ancestor
1260 file-ancestor file-out
1261 nil
1262 ;; When done, return to this buffer.
1267 ;; Merge of two files without ancestor
1271 nil
1272 ;; When done, return to this buffer.
1277 ;; There is an output file (or there would have been an error above),
1278 ;; but only one input file.
1279 ;; The file appears to have been deleted in one version; do nothing.
1282 ;; The file should be copied from the version that contains it
1288 ;;; Sample function for creating information for emerge-execute-line
1291 "Regexp describing files to be processed by `emerge-merge-directories'."
1295 ;;;###autoload
1303 ;; Check that we're not on a line
1306 ;; Turn null strings into nil to indicate directories not used.
1311 ;; Canonicalize the directory names
1328 ;; Set the mark to where we start
1330 ;; Find out what files are in the directories.
1338 emerge-merge-directories-filename-regexp)))
1343 ;; Remove duplicates from all-files.
1349 ;; Generate the control lines for the various files.
1370 ;;; Common setup routines
1372 ;; Set up the window configuration. If POS is given, set the points to
1373 ;; the beginnings of the buffers.
1375 ;; Make sure we are not in the minibuffer window when we try to delete
1376 ;; all other windows.
1394 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1402 ;; Set up the keymap in the merge buffer
1404 ;; Set up fixed keymaps if necessary
1407 ;; Save the old local map
1409 ;; Construct the edit keymap
1413 ;; Install the Emerge commands
1418 ;; Create the additional menu bar items.
1426 ;; Suppress write-file and save-buffer
1428 'emerge-query-write-file
1429 emerge-edit-keymap)
1431 'emerge-query-save-buffer
1432 emerge-edit-keymap)
1440 "Record certain properties of the buffers being merged.
1441 Must be called in the merge buffer. Remembers read-only, modified,
1442 auto-save, and saves them in buffer local variables. Sets the buffers
1443 read-only and turns off `auto-save-mode'.
1444 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1445 ;; force auto-save, because we will turn off auto-saving in buffers for the
1446 ;; duration
1448 ;; remember and alter buffer characteristics
1451 emerge-A-buffer
1455 emerge-merging-values))))
1458 emerge-B-buffer
1462 emerge-merging-values)))))
1465 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1470 A-values))
1473 B-values))))
1475 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1476 ;; Return DESIRED-LINE.
1479 desired-line)
1482 B-buffer
1483 merge-buffer
1484 lineno-list)
1489 ;; Record current line number in each buffer
1490 ;; so we don't have to count from the beginning.
1497 a-begin-marker
1498 a-end-marker
1499 b-begin-marker
1500 b-end-marker
1501 merge-begin-marker
1502 merge-end-marker
1508 ;; place markers at the appropriate places in the buffers
1510 A-buffer
1516 B-buffer
1524 offset)
1525 merge-buffer))
1529 offset)
1530 merge-buffer))
1531 ;; record all the markers for this difference
1533 b-begin-marker b-end-marker
1534 merge-begin-marker merge-end-marker
1535 state)
1536 marker-list)))
1538 ;; convert the list of difference information into a vector for
1539 ;; fast access
1542 ;; If we have an ancestor, select all B variants that we prefer
1554 ;; Process the local-variables list at the end of the merged file, if
1555 ;; requested.
1563 ;;; Common exit routines
1566 ;; clear screen format
1568 ;; delete A, B, and ancestor buffers, if they haven't been changed
1576 ;; Write merge buffer to file
1580 ;;; Commands
1583 "Bring the highlighted region of all three merge buffers into view.
1584 This brings the buffers into view if they are in windows.
1585 With an argument, reestablish the default three-window display."
1587 ;; If there is an argument, rebuild the window structure
1590 emerge-merge-buffer))
1591 ;; Redisplay whatever buffers are showing, if there is a selected difference
1627 ;;; Window scrolling operations
1628 ;; These operations are designed to scroll all three windows the same amount,
1629 ;; so as to keep the text in them aligned.
1631 ;; Perform some operation on all three windows (if they are showing).
1632 ;; Catches all errors on the operation in the A and B windows, but not
1633 ;; in the merge window. Usually, errors come from scrolling off the
1634 ;; beginning or end of the buffer, and this gives a nice error message:
1635 ;; End of buffer is reported in the merge buffer, but if the scroll was
1636 ;; possible in the A or B windows, it is performed there before the error
1637 ;; is reported.
1660 "Scroll up all three merge buffers, if they are in windows.
1661 With argument N, scroll N lines; otherwise scroll by nearly
1662 the height of the merge window.
1663 `C-u -' alone as argument scrolls half the height of the merge window."
1666 'scroll-up
1667 ;; calculate argument to scroll-up
1668 ;; if there is an explicit argument
1670 ;; use it
1672 ;; if not, see if we can determine a default amount (the window height)
1675 ;; no window, use nil
1676 nil
1679 ;; the window was found
1681 ;; C-u as argument means half of default amount
1683 ;; no argument means default amount
1684 default-amount)))))))
1687 "Scroll down all three merge buffers, if they are in windows.
1688 With argument N, scroll N lines; otherwise scroll by nearly
1689 the height of the merge window.
1690 `C-u -' alone as argument scrolls half the height of the merge window."
1693 'scroll-down
1694 ;; calculate argument to scroll-down
1695 ;; if there is an explicit argument
1697 ;; use it
1699 ;; if not, see if we can determine a default amount (the window height)
1702 ;; no window, use nil
1703 nil
1706 ;; the window was found
1708 ;; C-u as argument means half of default amount
1710 ;; no argument means default amount
1711 default-amount)))))))
1714 "Scroll left all three merge buffers, if they are in windows.
1715 If an argument is given, that is how many columns are scrolled, else nearly
1716 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1717 width of the A and B windows."
1720 'scroll-left
1721 ;; calculate argument to scroll-left
1722 ;; if there is an explicit argument
1724 ;; use it
1726 ;; if not, see if we can determine a default amount
1727 ;; (half the window width)
1730 ;; no window, use nil
1731 nil
1734 ;; the window was found
1736 ;; C-u as argument means half of default amount
1738 ;; no argument means default amount
1739 default-amount)))))))
1742 "Scroll right all three merge buffers, if they are in windows.
1743 If an argument is given, that is how many columns are scrolled, else nearly
1744 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1745 width of the A and B windows."
1748 'scroll-right
1749 ;; calculate argument to scroll-right
1750 ;; if there is an explicit argument
1752 ;; use it
1754 ;; if not, see if we can determine a default amount
1755 ;; (half the window width)
1758 ;; no window, use nil
1759 nil
1762 ;; the window was found
1764 ;; C-u as argument means half of default amount
1766 ;; no argument means default amount
1767 default-amount)))))))
1770 "Reset horizontal scrolling in Emerge.
1771 This resets the horizontal scrolling of all three merge buffers
1772 to the left margin, if they are in windows."
1776 nil))
1778 ;; Attempt to show the region nicely.
1779 ;; If there are min-lines lines above and below the region, then don't do
1780 ;; anything.
1781 ;; If not, recenter the region to make it so.
1782 ;; If that isn't possible, remove context lines balancedly from top and bottom
1783 ;; so the entire region shows.
1784 ;; If that isn't possible, show the top of the region.
1785 ;; BEG must be at the beginning of a line.
1787 ;; First test whether the entire region is visible with
1788 ;; emerge-min-visible-lines above and below it
1792 beg)
1797 ;; We failed that test, see if it fits at all
1798 ;; Meanwhile positioning it correctly in case it doesn't fit
1802 ;; Determine the number of lines that the region occupies
1808 ;; And position the beginning on the right line
1811 lines))
1816 "Advance to the next difference."
1830 "Go to the previous difference."
1844 "Go to the N-th difference."
1854 "Abort the Emerge session."
1859 "Finish the Emerge session and exit Emerge.
1860 Prefix argument means to abort rather than successfully finish.
1861 The difference depends on how the merge was started,
1862 but usually means to not write over one of the original files, or to signal
1863 to some process which invoked Emerge a failure code.
1865 Unselects the selected difference, if any, restores the read-only and modified
1866 flags of the merged file buffers, restores the local keymap of the merge
1867 buffer, and sets off various emerge flags. Using Emerge commands in this
1868 buffer after this will cause serious problems."
1873 "Do you really want to successfully finish this merge? "
1878 ;; Perform the quit operations.
1883 ;; null out the difference markers so they don't slow down future editing
1884 ;; operations
1892 emerge-difference-list)
1893 ;; allow them to be garbage collected
1895 ;; restore the local map
1897 ;; turn off all the emerge modes
1903 ;; restore mode line
1909 "Select the A variant of this difference.
1910 Refuses to function if this difference has been edited, i.e., if it
1911 is neither the A nor the B variant.
1912 A prefix argument forces the variant to be selected
1913 even if the difference has been edited."
1926 ;; Actually select the A variant
1929 emerge-merge-buffer
1938 "Select the B variant of this difference.
1939 Refuses to function if this difference has been edited, i.e., if it
1940 is neither the A nor the B variant.
1941 A prefix argument forces the variant to be selected
1942 even if the difference has been edited."
1955 ;; Actually select the B variant
1958 emerge-merge-buffer
1967 "Make the A variant the default from here down.
1968 This selects the A variant for all differences from here down in the buffer
1969 which are still defaulted, i.e., which the user has not selected and for
1970 which there is no preference."
1989 "Make the B variant the default from here down.
1990 This selects the B variant for all differences from here down in the buffer
1991 which are still defaulted, i.e., which the user has not selected and for
1992 which there is no preference."
2011 "Set fast mode, for Emerge.
2012 In this mode ordinary Emacs commands are disabled, and Emerge commands
2024 "Set edit mode, for Emerge.
2025 In this mode ordinary Emacs commands are available, and Emerge commands
2037 "Toggle Auto-Advance mode, for Emerge.
2038 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2039 advance to the next difference.
2040 With a positive argument, turn on Auto-Advance mode.
2041 With a negative argument, turn off Auto-Advance mode."
2047 "Auto-advance set"
2052 "Toggle Skip-Prefers mode, for Emerge.
2053 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2054 to automatically skip over differences for which there is a preference.
2055 With a positive argument, turn on Skip-Prefers mode.
2056 With a negative argument, turn off Skip-Prefers mode."
2062 "Skip-prefers set"
2067 "Put the A variant of this difference in the kill ring."
2074 ;; so further kills don't append
2075 this-command)
2081 "Put the B variant of this difference in the kill ring."
2088 ;; so further kills don't append
2089 this-command)
2095 "Insert the A variant of this difference at the point.
2096 Leaves point after text, mark before.
2097 With prefix argument, puts point before, mark after."
2113 "Insert the B variant of this difference at the point.
2114 Leaves point after text, mark before.
2115 With prefix argument, puts point before, mark after."
2131 "Leaves the point before this difference and the mark after it.
2132 With prefix argument, puts mark before, point after."
2147 "Show the names of the buffers or files being operated on by Emerge.
2148 Use C-u l to reset the windows afterward."
2191 "Join the selected difference with the following one.
2192 With a prefix argument, join with the preceding one."
2195 ;; adjust n to be first difference to join
2198 ;; n and n+1 are the differences to join
2199 ;; check that they are both differences
2202 ;; remove the flags
2204 ;; decrement total number of differences
2206 ;; build new differences vector
2226 ps)
2233 ;; set the current difference correctly
2235 ;; fix the mode line
2237 ;; reinsert the flags
2242 "Split the current difference where the points are in the three windows."
2245 ;; check that this is a valid difference
2247 ;; get the point values and old difference
2254 ;; check location of the points, give error if they aren't in the
2255 ;; differences
2265 ;; remove the flags
2267 ;; increment total number of differences
2269 ;; build new differences vector
2281 A-point
2283 B-point
2285 merge-point
2297 ;; set the current difference correctly
2299 ;; fix the mode line
2301 ;; reinsert the flags
2306 "Trim lines off top and bottom of difference that are the same.
2307 If lines are the same in both the A and the B versions, strip them off.
2308 \(This can happen when the A and B versions have common lines that the
2309 ancestor version does not share.)"
2311 ;; make sure we are in a real difference
2313 ;; remove the flags
2322 size success sa sb sm)
2323 ;; move down the tops of the difference regions as much as possible
2324 ;; Try advancing comparing 1000 chars at a time.
2325 ;; When that fails, go 500 chars at a time, and so on.
2345 ;; move up the bottoms of the difference regions as much as possible
2346 ;; Try advancing comparing 1000 chars at a time.
2347 ;; When that fails, go 500 chars at a time, and so on.
2356 bottom-a)))
2359 bottom-b)))
2367 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2368 ;; of the difference regions. Move them to the beginning of lines, as
2369 ;; appropriate.
2390 ;; put the flags back in, recenter the display
2395 "Find the difference containing the current position of the point.
2396 If there is no containing difference and the prefix argument is positive,
2397 it finds the nearest following difference. A negative prefix argument finds
2398 the nearest previous difference."
2407 "Find the difference containing point, 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 merge buffer, using the markers
2413 ;; for the beginning and end of the differences in the merge buffer
2417 "Find the difference containing point, in the A buffer.
2418 This command must be executed in the merge buffer.
2419 If there is no containing difference and the prefix argument is positive,
2420 it finds the nearest following difference. A negative prefix argument finds
2421 the nearest previous difference."
2423 ;; search for the point in the A buffer, using the markers
2424 ;; for the beginning and end of the differences in the A buffer
2430 "Find the difference containing point, in the B buffer.
2431 This command must be executed in the merge buffer.
2432 If there is no containing difference and the prefix argument is positive,
2433 it finds the nearest following difference. A negative prefix argument finds
2434 the nearest previous difference."
2436 ;; search for the point in the B buffer, using the markers
2437 ;; for the beginning and end of the differences in the B buffer
2444 ;; find first difference containing or after the current position
2452 emerge-number-of-differences))
2454 ;; whether the found difference contains the current position
2457 begin))
2458 location)))
2460 ;; numeric value of prefix argument
2464 ;; if the point is in a difference, select it
2466 ;; if the arg is nil and the point is not in a difference, error
2468 ;; if the arg is positive, select the following difference
2471 index
2473 ;; if the arg is negative, select the preceding difference
2480 "Display the current line numbers.
2481 This function displays the line numbers of the points in the A, B, and
2482 merge buffers."
2495 merge-line A-line B-line)))
2508 temp))
2511 "Set `emerge-combine-versions-template' to STRING.
2512 This value controls how `emerge-combine-versions' combines the two versions.
2513 With prefix argument, `emerge-combine-versions-template' is made local to this
2514 merge buffer. Localization is permanent for any particular merge buffer."
2521 "emerge-set-combine-versions-template set locally"
2525 "Copy region into `emerge-combine-versions-template'.
2526 This controls how `emerge-combine-versions' will combine the two versions.
2527 With prefix argument, `emerge-combine-versions-template' is made local to this
2528 merge buffer. Localization is permanent for any particular merge buffer."
2535 "emerge-set-combine-versions-template set locally."
2539 "Combine versions using the template in `emerge-combine-versions-template'.
2540 Refuses to function if this difference has been edited, i.e., if it is
2541 neither the A nor the B variant.
2542 An argument forces the variant to be selected even if the difference has
2543 been edited."
2548 "Combine the two versions using the template in register REG.
2549 See documentation of the variable `emerge-combine-versions-template'
2550 for how the template is interpreted.
2551 Refuses to function if this difference has been edited, i.e., if it is
2552 neither the A nor the B variant.
2553 An argument forces the variant to be selected even if the difference has
2554 been edited."
2565 A-begin A-end B-begin B-end)
2571 A-begin A-end B-begin B-end)
2573 emerge-merge-buffer
2601 "Set the major mode in a merge buffer.
2602 Overrides any change that the mode might make to the mode line or local
2603 keymap. Leaves merge in fast mode."
2618 ;;; Support routines
2620 ;; Select a difference by placing the visual flags around the appropriate
2621 ;; group of lines in the A, B, and merge buffers
2631 after-index)
2634 buffer
2640 ;; insert the flag before the difference
2642 before-index))
2643 here)
2645 ;; insert the flag itself
2648 ;; Put the marker(s) referring to this position 1 character before the
2649 ;; end of the flag, so it won't be damaged by the user.
2650 ;; This gets a bit tricky, as there could be a number of markers
2651 ;; that have to be moved.
2665 ;; insert the flag after the difference
2667 after-index))
2670 ;; insert the flag itself
2672 ;; Put the marker(s) referring to this position 1 character after the
2673 ;; beginning of the flag, so it won't be damaged by the user.
2674 ;; This gets a bit tricky, as there could be a number of markers
2675 ;; that have to be moved.
2690 ;; Unselect a difference by removing the visual flags in the buffers.
2703 buffer
2705 ;; remove the flags, if they're there
2709 ;; the flag isn't there
2715 ;; the flag isn't there
2719 ;; Select a difference, removing any flags that exist now.
2739 ;; Perform tests to see whether user should be allowed to select a version
2740 ;; of this difference:
2741 ;; a valid difference has been selected; and
2742 ;; the difference text in the merge buffer is:
2743 ;; the A version (execute a-version), or
2744 ;; the B version (execute b-version), or
2745 ;; empty (execute neither-version), or
2746 ;; argument FORCE is true (execute neither-version)
2747 ;; Otherwise, signal an error.
2760 emerge-merge-buffer merge-begin
2761 merge-end)
2764 emerge-merge-buffer merge-begin
2765 merge-end)
2771 ;; Read a file name, handling all of the various defaulting rules.
2774 A-file must-match)
2775 ;; `prompt' should not have trailing ": ", so that it can be modified
2776 ;; according to context.
2777 ;; If alternative-default-dir is non-nil, it should be used as the default
2778 ;; directory instead if default-directory, if emerge-default-last-directories
2779 ;; is set.
2780 ;; If default-file is set, it should be used as the default value.
2781 ;; If A-file is set, and its directory is different from
2782 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2783 ;; the default file should be the last part of A-file in the default
2784 ;; directory. (Overriding default-file.)
2786 ;; If this is not the A-file argument (shown by non-nil A-file), and
2787 ;; if emerge-default-last-directories is set, and
2788 ;; the default directory exists but is not the same as the directory of the
2789 ;; A-file,
2790 ;; then make the default file have the same name as the A-file, but in
2791 ;; the default directory.
2793 A-file
2794 alternative-default-dir
2799 alternative-default-dir
2803 ;; If there is a default file, use it.
2806 ;; If emerge-default-last-directories is set, use the
2807 ;; directory from the same argument of the last call of
2808 ;; Emerge as the default for this argument.
2810 alternative-default-dir)
2814 ;; If emerge-default-last-directories is set, use the
2815 ;; directory from the same argument of the last call of
2816 ;; Emerge as the default for this argument.
2818 alternative-default-dir)
2821 ;; Revise the mode line to display which difference we have selected
2827 emerge-number-of-differences
2829 (< emerge-current-difference
2830 emerge-number-of-differences))
2832 emerge-current-difference)
2842 ;; compare two regions in two buffers for containing the same text
2844 ;; first check that the two regions are the same length
2846 nil
2849 ;; bite off and compare no more than 1000 characters at a time
2852 buffer-x
2856 buffer-y
2863 t)))
2865 ;; Construct a unique buffer name.
2866 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2867 ;; prefix<3>suffix, etc.
2876 ;; Verify that we have a difference selected.
2882 ;;; Functions for saving and restoring a batch of variables
2884 ;; These functions save (get the values of) and restore (set the values of)
2885 ;; a list of variables. The argument is a list of symbols (the names of
2886 ;; the variables). A list element can also be a list of two functions,
2887 ;; the first of which (when called with no arguments) gets the value, and
2888 ;; the second (when called with a value as an argument) sets the value.
2889 ;; A "function" is anything that funcall can handle as an argument.
2895 vars))
2907 ;; Make a temporary file that only we have access to.
2908 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2916 f))
2918 ;;; Functions that query the user before he can write out the current buffer.
2921 "Ask the user whether to write out an incomplete merge.
2922 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2923 for details of the querying process."
2928 "Ask the user whether to save an incomplete merge.
2929 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2930 for details of the querying process."
2935 "Ask the user whether to save or write out the incomplete merge.
2936 If answer is yes, call COMMAND interactively. During the call, the flags
2937 around the current difference are removed."
2939 ;; He really wants to do it -- unselect the difference for the duration
2944 ;; call-interactively takes the value of current-prefix-arg as the
2945 ;; prefix argument value to be passed to the command. Thus, we have
2946 ;; to do nothing special to make sure the prefix argument is
2947 ;; transmitted to the command.
2954 ;; He's being smart and not doing it
2957 ;; Make sure the current buffer (for a file) has the same contents as the
2958 ;; file on disk, and attempt to remedy the situation if not.
2959 ;; Signal an error if we can't make them the same, or the user doesn't want
2960 ;; to do what is necessary to make them the same.
2962 ;; First check if the file has been modified since the buffer visited it.
2965 ;; If buffer is not obsolete and is modified, offer to save
2969 ;; If buffer is not obsolete and is not modified, do nothing
2970 nil)
2972 ;; If buffer is obsolete and is modified, give error
2974 ;; If buffer is obsolete and is not modified, offer to revert
2978 \f
2979 ;; Utilities that might have value outside of Emerge.
2981 ;; Set up the mode in the current buffer to duplicate the mode in another
2982 ;; buffer.
2984 ;; Set the major mode
2987 ;; Define a key, even if a prefix of it is defined
2989 "Like `define-key', but forcibly creates prefix characters as needed.
2990 If some prefix of KEY has a non-prefix definition, it is redefined."
2991 ;; Find out if a prefix of key is defined
2993 ;; If so, undefine it
2996 ;; Now define the key
2999 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
3000 ;;;;; as the major mode
3001 ;;(defun describe-mode (&optional minor)
3002 ;; "Display documentation of current major mode.
3003 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
3004 ;;display documentation of active minor modes as well.
3005 ;;For this to work correctly for a minor mode, the mode's indicator variable
3006 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
3007 ;;describes the minor mode."
3008 ;; (interactive)
3009 ;; (with-output-to-temp-buffer "*Help*"
3010 ;; (princ mode-name)
3011 ;; (princ " Mode:\n")
3012 ;; (princ (documentation major-mode))
3013 ;; (let ((minor-modes minor-mode-alist)
3014 ;; (locals (buffer-local-variables)))
3015 ;; (while minor-modes
3016 ;; (let* ((minor-mode (car (car minor-modes)))
3017 ;; (indicator (car (cdr (car minor-modes))))
3018 ;; (local-binding (assq minor-mode locals)))
3019 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
3020 ;; ;; bound locally in this buffer, non-nil, and has a function
3021 ;; ;; definition.
3022 ;; (if (and local-binding
3023 ;; (cdr local-binding)
3024 ;; (fboundp minor-mode))
3025 ;; (progn
3026 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3027 ;; minor-mode indicator))
3028 ;; (princ (documentation minor-mode)))))
3029 ;; (setq minor-modes (cdr minor-modes))))
3030 ;; (save-excursion
3031 ;; (set-buffer standard-output)
3032 ;; (help-mode))
3033 ;; (print-help-return-message)))
3035 ;; This goes with the redefinition of describe-mode.
3036 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3037 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3039 ;; substitute-key-definition should work now.
3040 ;;;; Function to shadow a definition in a keymap with definitions in another.
3041 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3042 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3043 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3044 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3045 ;;including those whose definition is OLDDEF."
3046 ;; ;; loop through all keymaps accessible from keymap
3047 ;; (let ((maps (accessible-keymaps keymap)))
3048 ;; (while maps
3049 ;; (let ((prefix (car (car maps)))
3050 ;; (map (cdr (car maps))))
3051 ;; ;; examine a keymap
3052 ;; (if (arrayp map)
3053 ;; ;; array keymap
3054 ;; (let ((len (length map))
3055 ;; (i 0))
3056 ;; (while (< i len)
3057 ;; (if (eq (aref map i) olddef)
3058 ;; ;; set the shadowing definition
3059 ;; (let ((key (concat prefix (char-to-string i))))
3060 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3061 ;; (setq i (1+ i))))
3062 ;; ;; sparse keymap
3063 ;; (while map
3064 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3065 ;; ;; set the shadowing definition
3066 ;; (let ((key
3067 ;; (concat prefix (char-to-string (car (car map))))))
3068 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3069 ;; (setq map (cdr map)))))
3070 ;; (setq maps (cdr maps)))))
3072 ;; Define a key if it (or a prefix) is not already defined in the map.
3074 ;; look up the present definition of the key
3077 ;; if it is "too long", look up the valid prefix
3079 ;; if the prefix isn't defined, define it
3081 ;; if there is no present definition, define it
3085 ;; Ordinary substitute-key-definition should do this now.
3086 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3087 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3088 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3089 ;;\(`copy-keymap' will suffice.)"
3090 ;; ;; Loop through all keymaps accessible from keymap
3091 ;; (let ((maps (accessible-keymaps keymap)))
3092 ;; (while maps
3093 ;; ;; Substitute in this keymap
3094 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3095 ;; (setq maps (cdr maps)))))
3097 ;; Show the name of the file in the buffer.
3099 "Displays the name of the file loaded into the current buffer.
3100 If the name won't fit on one line, the minibuffer is expanded to hold it,
3101 and the command waits for a keystroke from the user. If the keystroke is
3102 SPC, it is ignored; if it is anything else, it is processed as a command."
3123 ;; Improved auto-save gfile names.
3124 ;; This function fixes many problems with the standard auto-save file names:
3125 ;; Auto-save files for non-file buffers get put in the default directory
3126 ;; for the buffer, whether that makes sense or not.
3127 ;; Auto-save files for file buffers get put in the directory of the file,
3128 ;; regardless of whether we can write into it or not.
3129 ;; Auto-save files for non-file buffers don't use the process id, so if a
3130 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3131 ;; each other.
3132 ;; To use this function, do:
3133 ;; (fset 'make-auto-save-file-name
3134 ;; (symbol-function 'emerge-make-auto-save-file-name))
3136 "Return file name to use for auto-saves of current buffer.
3137 Does not consider `auto-save-visited-file-name';
3138 that is checked before calling this function.
3139 You can redefine this for customization.
3140 See also `auto-save-file-name-p'."
3142 ;; if buffer has a file, try the format <file directory>/#<file name>#
3144 "#"
3148 ;; the file is writable, so use it
3149 f
3150 ;; the file isn't writable, so use the format
3151 ;; ~/#&<file name>&<hash of directory>#
3153 "/#&"
3155 "&"
3159 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3161 "/#%"
3162 ;; quote / into \! and \ into \\
3164 "%"
3168 ;; Hash a string into five characters more-or-less suitable for use in a file
3169 ;; name. (Allowed characters are ! through ~, except /.)
3185 ;; Quote any /s in a string by replacing them with \!.
3186 ;; Also, replace any \s by \\, to make it one-to-one.
3198 s)
3200 ;; Metacharacters that have to be protected from the shell when executing
3201 ;; a diff/diff3 command.
3204 More precisely, a [...] regexp to match any one such character."
3208 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3216 s)
3220 ;;; emerge.el ends here