| blob | 21921e352c66a0f882c819637642f399df960cfd |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; This file is part of GNU Emacs.
7 ;; Author: Dale R. Worley <worley@world.std.com>
8 ;; Keywords: unix, tools
10 ;; This software was created by Dale R. Worley and is
11 ;; distributed free of charge. It is placed in the public domain and
12 ;; permission is granted to anyone to use, duplicate, modify and redistribute
13 ;; it provided that this notice is attached.
15 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
16 ;; with respect to this software. The entire risk as to the quality and
17 ;; performance of this software is with the user. IN NO EVENT WILL DALE
18 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
19 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
20 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
21 ;; DAMAGES.
23 ;;; Commentary:
25 ;;; Code:
27 ;; There aren't really global variables, just dynamic bindings
39 ;;; Macros
42 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
43 Differs from `save-excursion' in that it doesn't save the point and mark."
52 "Defines SYMBOL as an advertised variable.
53 Performs a defvar, then executes `make-variable-buffer-local' on
54 the variable. Also sets the `preserved' property, so that
55 `kill-all-local-variables' (called by major-mode setting commands)
56 won't destroy Emerge control variables."
62 ;; Add entries to minor-mode-alist so that emerge modes show correctly
71 minor-mode-alist)))
73 ;; We need to define this function so describe-mode can describe Emerge mode.
75 "Emerge mode is used by the Emerge file-merging package.
76 It is entered only through one of the functions:
77 `emerge-files'
78 `emerge-files-with-ancestor'
79 `emerge-buffers'
80 `emerge-buffers-with-ancestor'
81 `emerge-files-command'
82 `emerge-files-with-ancestor-command'
83 `emerge-files-remote'
84 `emerge-files-with-ancestor-remote'
86 Commands:
94 "Return string describing the version of Emerge.
95 When called interactively, displays the version."
99 emacs-version))
103 ;;; Emerge configuration variables
106 "Merge diffs under Emacs control."
109 ;; Commands that produce difference files
110 ;; All that can be configured is the name of the programs to execute
111 ;; (emerge-diff-program and emerge-diff3-program) and the options
112 ;; to be provided (emerge-diff-options). The order in which the file names
113 ;; are given is fixed.
114 ;; The file names are always expanded (see expand-file-name) before being
115 ;; passed to diff, thus they need not be invoked under a shell that
116 ;; understands `~'.
117 ;; The code which processes the diff/diff3 output depends on all the
118 ;; finicky details of their output, including the somewhat strange
119 ;; way they number lines of a file.
121 "Name of the program which compares two files."
125 "Name of the program which compares three files.
126 Its arguments are the ancestor file and the two variant files."
130 "Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
136 "Pattern to match lines produced by diff that describe differences.
137 This is as opposed to lines from the source files."
142 "Regexp that matches normal output lines from `emerge-diff-program'.
143 Lines that do not match are assumed to be error messages."
148 "Regexp that matches normal output lines from `emerge-diff3-program'.
149 Lines that do not match are assumed to be error messages."
154 "Name of the program that checks in RCS revisions."
158 "Name of the program that checks out RCS revisions."
163 "Non-nil if Emerge should process local-variables lists in merge buffers.
164 \(You can explicitly request processing the local-variables
165 by executing `(hack-local-variables)'.)"
169 "If non-nil: `emerge-execute-line' makes no output if an input was deleted.
170 It concludes that an input version has been deleted when an ancestor entry
171 is present, only one A or B entry is present, and an output entry is present.
172 If nil: In such circumstances, the A or B file that is present will be
173 copied to the designated output file."
178 "Flag placed above the highlighted block of code. Must end with newline.
179 Must be set before Emerge is loaded, or emerge-new-flags must be run
180 after setting."
184 "Flag placed below the highlighted block of code. Must end with newline.
185 Must be set before Emerge is loaded, or emerge-new-flags must be run
186 after setting."
190 ;; Hook variables
193 "Hook to run in the merge buffer after the merge has been set up."
197 "Hook to run after a difference has been selected.
198 The variable `n' holds the (internal) number of the difference."
202 "Hook to run after a difference has been unselected.
203 The variable `n' holds the (internal) number of the difference."
207 ;; Variables to control the default directories of the arguments to
208 ;; Emerge commands.
211 "If nil, default dir for filenames in emerge is `default-directory'.
212 If non-nil, filenames complete in the directory of the last argument of the
213 same type to an `emerge-files...' command."
246 ;; The flags used to mark differences in the buffers.
248 ;; These function definitions need to be up here, because they are used
249 ;; during loading.
251 "Function to be called after `emerge-{before,after}-flag'.
252 This is called after these functions are changed to compute values that
253 depend on the flags."
264 "Return the number of matches in STRING for REGEXP."
270 count))
272 ;; Calculate dependent variables
276 "Number of lines that we want to show above and below the flags when we are
277 displaying a difference."
283 "Prefix to put on Emerge temporary file names.
284 Do not start with `~/' or `~USERNAME/'."
289 "Mode for Emerge temporary files."
295 "Template for `emerge-combine-versions' to combine the two versions.
296 The template is inserted as a string, with the following interpolations:
297 %a the A version of the difference
298 %b the B version of the difference
299 %% the character `%'
300 Don't forget to end the template with a newline.
301 Note that this variable can be made local to a particular merge buffer by
302 giving a prefix argument to `emerge-set-combine-versions-template'."
306 ;; Build keymaps
309 "Keymap of Emerge commands.
310 Directly available in `fast' mode;
314 "Local keymap used in Emerge `fast' mode.
327 "Command prefix for Emerge commands in `edit' mode.
328 Must be set before Emerge is loaded."
332 ;; This function sets up the fixed keymaps. It is executed when the first
333 ;; Emerge is done to allow the user maximum time to set up the global keymap.
335 ;; Set up the basic keymap
338 ; - to negative-argument
379 ;; Allow emerge-basic-keymap to be referenced indirectly
381 ;; Set up the fast mode keymap
383 ;; Allow prefixed commands to work in fast mode
385 ;; Allow emerge-fast-keymap to be referenced indirectly
387 ;; Suppress write-file and save-buffer
469 ;; Variables which control each merge. They are local to the merge buffer.
471 ;; Mode variables
485 "The buffer in which the ancestor variant is stored,
490 buffer-read-only
491 buffer-auto-save-file-name)
492 "Variables and properties of a buffer which are saved, modified and restored
503 "Vector of differences between the variants, and markers in the buffers to
504 show where they are. Each difference is represented by a vector of seven
505 elements. The first two are markers to the beginning and end of the difference
506 section in the A buffer, the second two are markers for the B buffer, the third
508 that difference in the merge buffer.
509 A section of a buffer is described by two markers, one to the beginning of
510 the first line of the section, and one to the beginning of the first line
511 after the section. (If the section is empty, both markers point to the same
512 point.) If the section is part of the selected difference, then the markers
513 are moved into the flags, so the user can edit the section without disturbing
514 the markers.
516 A the merge buffer currently contains the A variant
517 B the merge buffer currently contains the B variant
518 default-A the merge buffer contains the A variant by default,
519 but this difference hasn't been selected yet, so
520 change-default commands can alter it
521 default-B the merge buffer contains the B variant by default,
522 but this difference hasn't been selected yet, so
523 change-default commands can alter it
524 prefer-A in a three-file merge, the A variant is the preferred
525 choice
526 prefer-B in a three-file merge, the B variant is the preferred
533 "The local keymap for the merge buffer, with the emerge commands defined in
534 it. Used to save the local keymap during fast mode, when the local keymap is
539 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
542 "*If non-nil, differences for which there is a preference are automatically
545 "Hooks to run in the merge buffer after the merge has been finished.
546 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
547 command.
552 ;;; Setup functions for two-file mode.
555 output-file)
562 ;; Record the directories of the files
567 ;; Make sure the entire files are seen, and they reflect what is on disk
569 buffer-A
574 startup-hooks
576 startup-hooks))
577 ;; Verify that the file matches the buffer
580 buffer-B
585 startup-hooks
587 startup-hooks))
588 ;; Verify that the file matches the buffer
591 output-file)))
593 ;; Start up Emerge on two files
595 output-file)
600 ;; create the merge buffer from buffer A, so it inherits buffer A's
601 ;; default directory, etc.
603 buffer-A
606 merge-buffer
632 ;; Generate the Emerge difference list between two files
636 emerge-diff-buffer
640 emerge-diff-program emerge-diff-options
643 t))
646 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
652 diff-buffer
661 a-begin)))
669 b-begin))))
670 ;; fix the beginning and end numbers, because diff is somewhat
671 ;; strange about how it numbers lines
682 ;; (string-equal diff-type "c")
687 b-begin b-end
689 list)))))
692 ;; Set up buffer of diff/diff3 error messages.
696 emerge-diff-error-buffer
701 ;;; Top-level and setup functions for three-file mode.
704 &optional startup-hooks quit-hooks
705 output-file)
715 ;; Record the directories of the files
721 ;; Make sure the entire files are seen, and they reflect what is on disk
723 buffer-A
728 startup-hooks
730 startup-hooks))
731 ;; Verify that the file matches the buffer
734 buffer-B
739 startup-hooks
741 startup-hooks))
742 ;; Verify that the file matches the buffer
745 buffer-ancestor
750 startup-hooks
752 startup-hooks))
753 ;; Verify that the file matches the buffer
756 buffer-ancestor file-ancestor
757 startup-hooks quit-hooks output-file)))
759 ;; Start up Emerge on two files with an ancestor
761 buffer-ancestor file-ancestor
762 &optional startup-hooks quit-hooks
763 output-file)
769 ;; create the merge buffer from buffer A, so it inherits buffer A's
770 ;; default directory, etc.
772 buffer-A
775 merge-buffer
803 ;; Generate the Emerge difference list between two files with an ancestor
807 emerge-diff-buffer
811 emerge-diff3-program emerge-diff-options
815 t))
818 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
824 diff-buffer
826 ;; leave point after matched line
829 ;; if the A and B files are the same, ignore the difference
843 list))))))
847 ;; This save-excursion allows emerge-get-diff3-group to be called for the
848 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
849 ;; appear in any order. The reason this is necessary is that Gnu diff3
850 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
855 ;; treatment depends on whether it is an "a" group or a "c" group
857 ;; it is a "c" group
859 ;; it has two numbers
864 ;; it has one number
868 ;; it is an "a" group
873 ;;; Functions to start Emerge on files
875 ;;;###autoload
877 quit-hooks)
878 "Run Emerge on two files."
883 nil nil t))
887 f f nil)))))
891 file-A file-B startup-hooks
892 quit-hooks
893 file-out))
895 ;;;###autoload
898 "Run Emerge on two files, giving another file as the ancestor."
903 nil nil t))
906 nil f t)
909 f f nil)))))
913 file-A file-B file-ancestor startup-hooks
914 quit-hooks
915 file-out))
917 ;; Write the merge buffer out in place of the file the A buffer is visiting.
919 ;; if merge was successful was given, save to disk
923 ;;; Functions to start Emerge on buffers
925 ;;;###autoload
927 "Run Emerge on two buffers."
932 buffer-A
935 buffer-B
942 startup-hooks)
943 quit-hooks
944 nil)))
946 ;;;###autoload
948 &optional startup-hooks
949 quit-hooks)
950 "Run Emerge on two buffers, giving another buffer as the ancestor."
957 buffer-A
960 buffer-B
963 buffer-ancestor
969 emerge-file-ancestor
975 startup-hooks)
976 quit-hooks
977 nil)))
979 ;;; Functions to start Emerge from the command line
981 ;;;###autoload
988 file-a file-b nil
991 ;;;###autoload
994 ;; check for a -a flag, for filemerge compatibility
996 ;; arguments are "-a ancestor file-a file-b file-out"
1003 ;; arguments are "file-a file-b ancestor file-out"
1010 file-a file-b file-anc nil
1017 ;;; Functions to start Emerge via remote request
1019 ;;;###autoload
1023 file-a file-b nil
1025 file-out)
1028 ;;;###autoload
1032 file-a file-b file-anc nil
1034 file-out)
1042 ;;; Functions to start Emerge on RCS versions
1044 ;;;###autoload
1047 "Emerge two RCS revisions of a file."
1054 emerge-last-revision-B revision-B)
1056 file revision-A revision-B startup-hooks
1061 quit-hooks)
1062 quit-hooks)))
1064 ;;;###autoload
1066 revision-B ancestor
1067 &optional
1068 startup-hooks quit-hooks)
1069 "Emerge two RCS revisions of a file, with another revision as ancestor."
1077 emerge-last-revision-B revision-B
1078 emerge-last-revision-ancestor ancestor)
1080 file revision-A revision-B ancestor startup-hooks
1086 quit-hooks))
1087 quit-hooks)))
1090 startup-hooks quit-hooks output-file)
1095 ;; Get the revisions into buffers
1097 buffer-A
1101 t)
1105 buffer-B
1109 t)
1112 ;; Do the merge
1114 buffer-B emerge-file-B
1118 startup-hooks)
1120 quit-hooks)
1121 nil)))
1124 ancestor
1125 &optional startup-hooks
1126 quit-hooks output-file)
1133 ;; Get the revisions into buffers
1135 buffer-A
1139 revision-A file)
1140 t)
1144 buffer-B
1148 t)
1152 buffer-ancestor
1156 t)
1159 ;; Do the merge
1161 buffer-A emerge-file-A buffer-B emerge-file-B
1162 buffer-ancestor emerge-ancestor
1167 startup-hooks)
1169 quit-hooks)
1170 output-file)))
1172 ;;; Function to start Emerge based on a line in a file
1175 "Run Emerge using files named in current text line.
1176 Looks in that line for whitespace-separated entries of these forms:
1177 a=file1
1178 b=file2
1179 ancestor=file3
1180 output=file4
1181 to specify the files to use in Emerge.
1183 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1184 is present:
1185 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1186 it is assumed that the file in question has been deleted, and it is
1187 not copied to the output file.
1188 Otherwise, the A or B file present is copied to the output file."
1192 ;; Stop if at end of buffer (even though we might be in a line, if
1193 ;; the line does not end with newline)
1196 ;; Go to the beginning of the line
1198 ;; Skip any initial whitespace
1201 ;; Process the entire line
1203 ;; Get the next entry
1205 ;; Break apart the tab (before =) and the filename (after =)
1209 ;; Move point after the entry
1211 ;; Store the filename in the right variable
1231 ;; If the match on the entry pattern failed
1233 ;; Make sure that file-A and file-B are present
1238 ;; Go to the beginning of the next line, so next execution will use
1239 ;; next line in buffer.
1241 ;; Execute the correct command
1243 ;; Merge of two files with ancestor
1247 file-ancestor file-out
1248 nil
1249 ;; When done, return to this buffer.
1254 ;; Merge of two files without ancestor
1258 nil
1259 ;; When done, return to this buffer.
1264 ;; There is an output file (or there would have been an error above),
1265 ;; but only one input file.
1266 ;; The file appears to have been deleted in one version; do nothing.
1269 ;; The file should be copied from the version that contains it
1275 ;;; Sample function for creating information for emerge-execute-line
1278 "Regexp describing files to be processed by `emerge-merge-directories'."
1282 ;;;###autoload
1290 ;; Check that we're not on a line
1293 ;; Turn null strings into nil to indicate directories not used.
1298 ;; Canonicalize the directory names
1315 ;; Set the mark to where we start
1317 ;; Find out what files are in the directories.
1325 emerge-merge-directories-filename-regexp)))
1330 ;; Remove duplicates from all-files.
1336 ;; Generate the control lines for the various files.
1357 ;;; Common setup routines
1359 ;; Set up the window configuration. If POS is given, set the points to
1360 ;; the beginnings of the buffers.
1362 ;; Make sure we are not in the minibuffer window when we try to delete
1363 ;; all other windows.
1381 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1389 ;; Set up the keymap in the merge buffer
1391 ;; Set up fixed keymaps if necessary
1394 ;; Save the old local map
1396 ;; Construct the edit keymap
1400 ;; Install the Emerge commands
1405 ;; Create the additional menu bar items.
1413 ;; Suppress write-file and save-buffer
1415 'emerge-query-write-file
1416 emerge-edit-keymap)
1418 'emerge-query-save-buffer
1419 emerge-edit-keymap)
1427 "Record certain properties of the buffers being merged.
1428 Must be called in the merge buffer. Remembers read-only, modified,
1429 auto-save, and saves them in buffer local variables. Sets the buffers
1430 read-only and turns off `auto-save-mode'.
1431 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1432 ;; force auto-save, because we will turn off auto-saving in buffers for the
1433 ;; duration
1435 ;; remember and alter buffer characteristics
1438 emerge-A-buffer
1442 emerge-merging-values))))
1445 emerge-B-buffer
1449 emerge-merging-values)))))
1452 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1457 A-values))
1460 B-values))))
1462 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1463 ;; Return DESIRED-LINE.
1466 desired-line)
1469 B-buffer
1470 merge-buffer
1471 lineno-list)
1476 ;; Record current line number in each buffer
1477 ;; so we don't have to count from the beginning.
1484 a-begin-marker
1485 a-end-marker
1486 b-begin-marker
1487 b-end-marker
1488 merge-begin-marker
1489 merge-end-marker
1495 ;; place markers at the appropriate places in the buffers
1497 A-buffer
1503 B-buffer
1511 offset)
1512 merge-buffer))
1516 offset)
1517 merge-buffer))
1518 ;; record all the markers for this difference
1520 b-begin-marker b-end-marker
1521 merge-begin-marker merge-end-marker
1522 state)
1523 marker-list)))
1525 ;; convert the list of difference information into a vector for
1526 ;; fast access
1529 ;; If we have an ancestor, select all B variants that we prefer
1541 ;; Process the local-variables list at the end of the merged file, if
1542 ;; requested.
1550 ;;; Common exit routines
1553 ;; clear screen format
1555 ;; delete A, B, and ancestor buffers, if they haven't been changed
1563 ;; Write merge buffer to file
1567 ;;; Commands
1570 "Bring the highlighted region of all three merge buffers into view.
1571 This brings the buffers into view if they are in windows.
1572 With an argument, reestablish the default three-window display."
1574 ;; If there is an argument, rebuild the window structure
1577 emerge-merge-buffer))
1578 ;; Redisplay whatever buffers are showing, if there is a selected difference
1614 ;;; Window scrolling operations
1615 ;; These operations are designed to scroll all three windows the same amount,
1616 ;; so as to keep the text in them aligned.
1618 ;; Perform some operation on all three windows (if they are showing).
1619 ;; Catches all errors on the operation in the A and B windows, but not
1620 ;; in the merge window. Usually, errors come from scrolling off the
1621 ;; beginning or end of the buffer, and this gives a nice error message:
1622 ;; End of buffer is reported in the merge buffer, but if the scroll was
1623 ;; possible in the A or B windows, it is performed there before the error
1624 ;; is reported.
1647 "Scroll up 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-up
1654 ;; calculate argument to scroll-up
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 down all three merge buffers, if they are in windows.
1675 With argument N, scroll N lines; otherwise scroll by nearly
1676 the height of the merge window.
1677 `C-u -' alone as argument scrolls half the height of the merge window."
1680 'scroll-down
1681 ;; calculate argument to scroll-down
1682 ;; if there is an explicit argument
1684 ;; use it
1686 ;; if not, see if we can determine a default amount (the window height)
1689 ;; no window, use nil
1690 nil
1693 ;; the window was found
1695 ;; C-u as argument means half of default amount
1697 ;; no argument means default amount
1698 default-amount)))))))
1701 "Scroll left all three merge buffers, if they are in windows.
1702 If an argument is given, that is how many columns are scrolled, else nearly
1703 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1704 width of the A and B windows."
1707 'scroll-left
1708 ;; calculate argument to scroll-left
1709 ;; if there is an explicit argument
1711 ;; use it
1713 ;; if not, see if we can determine a default amount
1714 ;; (half the window width)
1717 ;; no window, use nil
1718 nil
1721 ;; the window was found
1723 ;; C-u as argument means half of default amount
1725 ;; no argument means default amount
1726 default-amount)))))))
1729 "Scroll right all three merge buffers, if they are in windows.
1730 If an argument is given, that is how many columns are scrolled, else nearly
1731 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1732 width of the A and B windows."
1735 'scroll-right
1736 ;; calculate argument to scroll-right
1737 ;; if there is an explicit argument
1739 ;; use it
1741 ;; if not, see if we can determine a default amount
1742 ;; (half the window width)
1745 ;; no window, use nil
1746 nil
1749 ;; the window was found
1751 ;; C-u as argument means half of default amount
1753 ;; no argument means default amount
1754 default-amount)))))))
1757 "Reset horizontal scrolling in Emerge.
1758 This resets the horizontal scrolling of all three merge buffers
1759 to the left margin, if they are in windows."
1763 nil))
1765 ;; Attempt to show the region nicely.
1766 ;; If there are min-lines lines above and below the region, then don't do
1767 ;; anything.
1768 ;; If not, recenter the region to make it so.
1769 ;; If that isn't possible, remove context lines balancedly from top and bottom
1770 ;; so the entire region shows.
1771 ;; If that isn't possible, show the top of the region.
1772 ;; BEG must be at the beginning of a line.
1774 ;; First test whether the entire region is visible with
1775 ;; emerge-min-visible-lines above and below it
1779 beg)
1784 ;; We failed that test, see if it fits at all
1785 ;; Meanwhile positioning it correctly in case it doesn't fit
1789 ;; Determine the number of lines that the region occupies
1795 ;; And position the beginning on the right line
1798 lines))
1803 "Advance to the next difference."
1817 "Go to the previous difference."
1831 "Go to the N-th difference."
1841 "Abort the Emerge session."
1846 "Finish the Emerge session and exit Emerge.
1847 Prefix argument means to abort rather than successfully finish.
1848 The difference depends on how the merge was started,
1849 but usually means to not write over one of the original files, or to signal
1850 to some process which invoked Emerge a failure code.
1852 Unselects the selected difference, if any, restores the read-only and modified
1853 flags of the merged file buffers, restores the local keymap of the merge
1854 buffer, and sets off various emerge flags. Using Emerge commands in this
1855 buffer after this will cause serious problems."
1860 "Do you really want to successfully finish this merge? "
1865 ;; Perform the quit operations.
1870 ;; null out the difference markers so they don't slow down future editing
1871 ;; operations
1879 emerge-difference-list)
1880 ;; allow them to be garbage collected
1882 ;; restore the local map
1884 ;; turn off all the emerge modes
1890 ;; restore mode line
1896 "Select the A variant of this difference.
1897 Refuses to function if this difference has been edited, i.e., if it
1898 is neither the A nor the B variant.
1899 A prefix argument forces the variant to be selected
1900 even if the difference has been edited."
1913 ;; Actually select the A variant
1916 emerge-merge-buffer
1925 "Select the B variant of this difference.
1926 Refuses to function if this difference has been edited, i.e., if it
1927 is neither the A nor the B variant.
1928 A prefix argument forces the variant to be selected
1929 even if the difference has been edited."
1942 ;; Actually select the B variant
1945 emerge-merge-buffer
1954 "Make the A variant the default from here down.
1955 This selects the A variant for all differences from here down in the buffer
1956 which are still defaulted, i.e., which the user has not selected and for
1957 which there is no preference."
1976 "Make the B variant the default from here down.
1977 This selects the B variant for all differences from here down in the buffer
1978 which are still defaulted, i.e., which the user has not selected and for
1979 which there is no preference."
1998 "Set fast mode, for Emerge.
1999 In this mode ordinary Emacs commands are disabled, and Emerge commands
2011 "Set edit mode, for Emerge.
2012 In this mode ordinary Emacs commands are available, and Emerge commands
2024 "Toggle Auto-Advance mode, for Emerge.
2025 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2026 advance to the next difference.
2027 With a positive argument, turn on Auto-Advance mode.
2028 With a negative argument, turn off Auto-Advance mode."
2034 "Auto-advance set"
2039 "Toggle Skip-Prefers mode, for Emerge.
2040 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2041 to automatically skip over differences for which there is a preference.
2042 With a positive argument, turn on Skip-Prefers mode.
2043 With a negative argument, turn off Skip-Prefers mode."
2049 "Skip-prefers set"
2054 "Put the A variant of this difference in the kill ring."
2061 ;; so further kills don't append
2062 this-command)
2068 "Put the B variant of this difference in the kill ring."
2075 ;; so further kills don't append
2076 this-command)
2082 "Insert the A variant of this difference at the point.
2083 Leaves point after text, mark before.
2084 With prefix argument, puts point before, mark after."
2100 "Insert the B variant of this difference at the point.
2101 Leaves point after text, mark before.
2102 With prefix argument, puts point before, mark after."
2118 "Leaves the point before this difference and the mark after it.
2119 With prefix argument, puts mark before, point after."
2134 "Show the names of the buffers or files being operated on by Emerge.
2135 Use C-u l to reset the windows afterward."
2178 "Join the selected difference with the following one.
2179 With a prefix argument, join with the preceding one."
2182 ;; adjust n to be first difference to join
2185 ;; n and n+1 are the differences to join
2186 ;; check that they are both differences
2189 ;; remove the flags
2191 ;; decrement total number of differences
2193 ;; build new differences vector
2213 ps)
2220 ;; set the current difference correctly
2222 ;; fix the mode line
2224 ;; reinsert the flags
2229 "Split the current difference where the points are in the three windows."
2232 ;; check that this is a valid difference
2234 ;; get the point values and old difference
2241 ;; check location of the points, give error if they aren't in the
2242 ;; differences
2252 ;; remove the flags
2254 ;; increment total number of differences
2256 ;; build new differences vector
2268 A-point
2270 B-point
2272 merge-point
2284 ;; set the current difference correctly
2286 ;; fix the mode line
2288 ;; reinsert the flags
2293 "Trim lines off top and bottom of difference that are the same.
2294 If lines are the same in both the A and the B versions, strip them off.
2295 \(This can happen when the A and B versions have common lines that the
2296 ancestor version does not share.)"
2298 ;; make sure we are in a real difference
2300 ;; remove the flags
2309 size success sa sb sm)
2310 ;; move down the tops of the difference regions as much as possible
2311 ;; Try advancing comparing 1000 chars at a time.
2312 ;; When that fails, go 500 chars at a time, and so on.
2332 ;; move up the bottoms of the difference regions as much as possible
2333 ;; Try advancing comparing 1000 chars at a time.
2334 ;; When that fails, go 500 chars at a time, and so on.
2343 bottom-a)))
2346 bottom-b)))
2354 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2355 ;; of the difference regions. Move them to the beginning of lines, as
2356 ;; appropriate.
2377 ;; put the flags back in, recenter the display
2381 ;; FIXME the manual advertised this as working in the A or B buffers,
2382 ;; but it does not, because all the buffer locals are nil there.
2383 ;; It would work to call it from the merge buffer and specify that one
2384 ;; wants to use the value of point in the A or B buffer.
2385 ;; But with the prefix argument already in use, there is no easy way
2386 ;; to have it ask for a buffer.
2388 "Find the difference containing the current position of the point.
2389 If there is no containing difference and the prefix argument is positive,
2390 it finds the nearest following difference. A negative prefix argument finds
2391 the nearest previous difference."
2400 "Find the difference containing point, in the merge buffer.
2401 If there is no containing difference and the prefix argument is positive,
2402 it finds the nearest following difference. A negative prefix argument finds
2403 the nearest previous difference."
2405 ;; search for the point in the merge buffer, using the markers
2406 ;; for the beginning and end of the differences in the merge buffer
2410 "Find the difference containing point, in the A buffer.
2411 This command must be executed in the merge buffer.
2412 If there is no containing difference and the prefix argument is positive,
2413 it finds the nearest following difference. A negative prefix argument finds
2414 the nearest previous difference."
2416 ;; search for the point in the A buffer, using the markers
2417 ;; for the beginning and end of the differences in the A buffer
2423 "Find the difference containing point, in the B buffer.
2424 This command must be executed in the merge buffer.
2425 If there is no containing difference and the prefix argument is positive,
2426 it finds the nearest following difference. A negative prefix argument finds
2427 the nearest previous difference."
2429 ;; search for the point in the B buffer, using the markers
2430 ;; for the beginning and end of the differences in the B buffer
2437 ;; find first difference containing or after the current position
2445 emerge-number-of-differences))
2447 ;; whether the found difference contains the current position
2450 begin))
2451 location)))
2453 ;; numeric value of prefix argument
2457 ;; if the point is in a difference, select it
2459 ;; if the arg is nil and the point is not in a difference, error
2461 ;; if the arg is positive, select the following difference
2464 index
2466 ;; if the arg is negative, select the preceding difference
2473 "Display the current line numbers.
2474 This function displays the line numbers of the points in the A, B, and
2475 merge buffers."
2488 merge-line A-line B-line)))
2501 temp))
2504 "Set `emerge-combine-versions-template' to STRING.
2505 This value controls how `emerge-combine-versions' combines the two versions.
2506 With prefix argument, `emerge-combine-versions-template' is made local to this
2507 merge buffer. Localization is permanent for any particular merge buffer."
2514 "emerge-set-combine-versions-template set locally"
2518 "Copy region into `emerge-combine-versions-template'.
2519 This controls how `emerge-combine-versions' will combine the two versions.
2520 With prefix argument, `emerge-combine-versions-template' is made local to this
2521 merge buffer. Localization is permanent for any particular merge buffer."
2528 "emerge-set-combine-versions-template set locally."
2532 "Combine versions using the template in `emerge-combine-versions-template'.
2533 Refuses to function if this difference has been edited, i.e., if it is
2534 neither the A nor the B variant.
2535 An argument forces the variant to be selected even if the difference has
2536 been edited."
2541 "Combine the two versions using the template in register REG.
2542 See documentation of the variable `emerge-combine-versions-template'
2543 for how the template is interpreted.
2544 Refuses to function if this difference has been edited, i.e., if it is
2545 neither the A nor the B variant.
2546 An argument forces the variant to be selected even if the difference has
2547 been edited."
2558 A-begin A-end B-begin B-end)
2564 A-begin A-end B-begin B-end)
2566 emerge-merge-buffer
2594 "Set the major mode in a merge buffer.
2595 Overrides any change that the mode might make to the mode line or local
2596 keymap. Leaves merge in fast mode."
2611 ;;; Support routines
2613 ;; Select a difference by placing the visual flags around the appropriate
2614 ;; group of lines in the A, B, and merge buffers
2624 after-index)
2627 buffer
2633 ;; insert the flag before the difference
2635 before-index))
2636 here)
2638 ;; insert the flag itself
2641 ;; Put the marker(s) referring to this position 1 character before the
2642 ;; end of the flag, so it won't be damaged by the user.
2643 ;; This gets a bit tricky, as there could be a number of markers
2644 ;; that have to be moved.
2658 ;; insert the flag after the difference
2660 after-index))
2663 ;; insert the flag itself
2665 ;; Put the marker(s) referring to this position 1 character after the
2666 ;; beginning of the flag, so it won't be damaged by the user.
2667 ;; This gets a bit tricky, as there could be a number of markers
2668 ;; that have to be moved.
2683 ;; Unselect a difference by removing the visual flags in the buffers.
2696 buffer
2698 ;; remove the flags, if they're there
2702 ;; the flag isn't there
2708 ;; the flag isn't there
2712 ;; Select a difference, removing any flags that exist now.
2732 ;; Perform tests to see whether user should be allowed to select a version
2733 ;; of this difference:
2734 ;; a valid difference has been selected; and
2735 ;; the difference text in the merge buffer is:
2736 ;; the A version (execute a-version), or
2737 ;; the B version (execute b-version), or
2738 ;; empty (execute neither-version), or
2739 ;; argument FORCE is true (execute neither-version)
2740 ;; Otherwise, signal an error.
2753 emerge-merge-buffer merge-begin
2754 merge-end)
2757 emerge-merge-buffer merge-begin
2758 merge-end)
2764 ;; Read a file name, handling all of the various defaulting rules.
2767 A-file must-match)
2768 ;; `prompt' should not have trailing ": ", so that it can be modified
2769 ;; according to context.
2770 ;; If alternative-default-dir is non-nil, it should be used as the default
2771 ;; directory instead if default-directory, if emerge-default-last-directories
2772 ;; is set.
2773 ;; If default-file is set, it should be used as the default value.
2774 ;; If A-file is set, and its directory is different from
2775 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2776 ;; the default file should be the last part of A-file in the default
2777 ;; directory. (Overriding default-file.)
2779 ;; If this is not the A-file argument (shown by non-nil A-file), and
2780 ;; if emerge-default-last-directories is set, and
2781 ;; the default directory exists but is not the same as the directory of the
2782 ;; A-file,
2783 ;; then make the default file have the same name as the A-file, but in
2784 ;; the default directory.
2786 A-file
2787 alternative-default-dir
2792 alternative-default-dir
2796 ;; If there is a default file, use it.
2799 ;; If emerge-default-last-directories is set, use the
2800 ;; directory from the same argument of the last call of
2801 ;; Emerge as the default for this argument.
2803 alternative-default-dir)
2807 ;; If emerge-default-last-directories is set, use the
2808 ;; directory from the same argument of the last call of
2809 ;; Emerge as the default for this argument.
2811 alternative-default-dir)
2814 ;; Revise the mode line to display which difference we have selected
2820 emerge-number-of-differences
2822 (< emerge-current-difference
2823 emerge-number-of-differences))
2825 emerge-current-difference)
2835 ;; compare two regions in two buffers for containing the same text
2837 ;; first check that the two regions are the same length
2839 nil
2842 ;; bite off and compare no more than 1000 characters at a time
2845 buffer-x
2849 buffer-y
2856 t)))
2858 ;; Construct a unique buffer name.
2859 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2860 ;; prefix<3>suffix, etc.
2869 ;; Verify that we have a difference selected.
2875 ;;; Functions for saving and restoring a batch of variables
2877 ;; These functions save (get the values of) and restore (set the values of)
2878 ;; a list of variables. The argument is a list of symbols (the names of
2879 ;; the variables). A list element can also be a list of two functions,
2880 ;; the first of which (when called with no arguments) gets the value, and
2881 ;; the second (when called with a value as an argument) sets the value.
2882 ;; A "function" is anything that funcall can handle as an argument.
2888 vars))
2900 ;; Make a temporary file that only we have access to.
2901 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2909 f))
2911 ;;; Functions that query the user before he can write out the current buffer.
2914 "Ask the user whether to write out an incomplete merge.
2915 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2916 for details of the querying process."
2921 "Ask the user whether to save an incomplete merge.
2922 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2923 for details of the querying process."
2928 "Ask the user whether to save or write out the incomplete merge.
2929 If answer is yes, call COMMAND interactively. During the call, the flags
2930 around the current difference are removed."
2932 ;; He really wants to do it -- unselect the difference for the duration
2937 ;; call-interactively takes the value of current-prefix-arg as the
2938 ;; prefix argument value to be passed to the command. Thus, we have
2939 ;; to do nothing special to make sure the prefix argument is
2940 ;; transmitted to the command.
2947 ;; He's being smart and not doing it
2950 ;; Make sure the current buffer (for a file) has the same contents as the
2951 ;; file on disk, and attempt to remedy the situation if not.
2952 ;; Signal an error if we can't make them the same, or the user doesn't want
2953 ;; to do what is necessary to make them the same.
2955 ;; First check if the file has been modified since the buffer visited it.
2958 ;; If buffer is not obsolete and is modified, offer to save
2962 ;; If buffer is not obsolete and is not modified, do nothing
2963 nil)
2965 ;; If buffer is obsolete and is modified, give error
2967 ;; If buffer is obsolete and is not modified, offer to revert
2971 \f
2972 ;; Utilities that might have value outside of Emerge.
2974 ;; Set up the mode in the current buffer to duplicate the mode in another
2975 ;; buffer.
2977 ;; Set the major mode
2980 ;; Define a key, even if a prefix of it is defined
2982 "Like `define-key', but forcibly creates prefix characters as needed.
2983 If some prefix of KEY has a non-prefix definition, it is redefined."
2984 ;; Find out if a prefix of key is defined
2986 ;; If so, undefine it
2989 ;; Now define the key
2992 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2993 ;;;;; as the major mode
2994 ;;(defun describe-mode (&optional minor)
2995 ;; "Display documentation of current major mode.
2996 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2997 ;;display documentation of active minor modes as well.
2998 ;;For this to work correctly for a minor mode, the mode's indicator variable
2999 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
3000 ;;describes the minor mode."
3001 ;; (interactive)
3002 ;; (with-output-to-temp-buffer "*Help*"
3003 ;; (princ mode-name)
3004 ;; (princ " Mode:\n")
3005 ;; (princ (documentation major-mode))
3006 ;; (let ((minor-modes minor-mode-alist)
3007 ;; (locals (buffer-local-variables)))
3008 ;; (while minor-modes
3009 ;; (let* ((minor-mode (car (car minor-modes)))
3010 ;; (indicator (car (cdr (car minor-modes))))
3011 ;; (local-binding (assq minor-mode locals)))
3012 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
3013 ;; ;; bound locally in this buffer, non-nil, and has a function
3014 ;; ;; definition.
3015 ;; (if (and local-binding
3016 ;; (cdr local-binding)
3017 ;; (fboundp minor-mode))
3018 ;; (progn
3019 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3020 ;; minor-mode indicator))
3021 ;; (princ (documentation minor-mode)))))
3022 ;; (setq minor-modes (cdr minor-modes))))
3023 ;; (save-excursion
3024 ;; (set-buffer standard-output)
3025 ;; (help-mode))
3026 ;; (help-print-return-message)))
3028 ;; This goes with the redefinition of describe-mode.
3029 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3030 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3032 ;; substitute-key-definition should work now.
3033 ;;;; Function to shadow a definition in a keymap with definitions in another.
3034 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3035 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3036 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3037 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3038 ;;including those whose definition is OLDDEF."
3039 ;; ;; loop through all keymaps accessible from keymap
3040 ;; (let ((maps (accessible-keymaps keymap)))
3041 ;; (while maps
3042 ;; (let ((prefix (car (car maps)))
3043 ;; (map (cdr (car maps))))
3044 ;; ;; examine a keymap
3045 ;; (if (arrayp map)
3046 ;; ;; array keymap
3047 ;; (let ((len (length map))
3048 ;; (i 0))
3049 ;; (while (< i len)
3050 ;; (if (eq (aref map i) olddef)
3051 ;; ;; set the shadowing definition
3052 ;; (let ((key (concat prefix (char-to-string i))))
3053 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3054 ;; (setq i (1+ i))))
3055 ;; ;; sparse keymap
3056 ;; (while map
3057 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3058 ;; ;; set the shadowing definition
3059 ;; (let ((key
3060 ;; (concat prefix (char-to-string (car (car map))))))
3061 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3062 ;; (setq map (cdr map)))))
3063 ;; (setq maps (cdr maps)))))
3065 ;; Define a key if it (or a prefix) is not already defined in the map.
3067 ;; look up the present definition of the key
3070 ;; if it is "too long", look up the valid prefix
3072 ;; if the prefix isn't defined, define it
3074 ;; if there is no present definition, define it
3078 ;; Ordinary substitute-key-definition should do this now.
3079 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3080 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3081 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3082 ;;\(`copy-keymap' will suffice.)"
3083 ;; ;; Loop through all keymaps accessible from keymap
3084 ;; (let ((maps (accessible-keymaps keymap)))
3085 ;; (while maps
3086 ;; ;; Substitute in this keymap
3087 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3088 ;; (setq maps (cdr maps)))))
3090 ;; Show the name of the file in the buffer.
3092 "Displays the name of the file loaded into the current buffer.
3093 If the name won't fit on one line, the minibuffer is expanded to hold it,
3094 and the command waits for a keystroke from the user. If the keystroke is
3095 SPC, it is ignored; if it is anything else, it is processed as a command."
3116 ;; Improved auto-save file names.
3117 ;; This function fixes many problems with the standard auto-save file names:
3118 ;; Auto-save files for non-file buffers get put in the default directory
3119 ;; for the buffer, whether that makes sense or not.
3120 ;; Auto-save files for file buffers get put in the directory of the file,
3121 ;; regardless of whether we can write into it or not.
3122 ;; Auto-save files for non-file buffers don't use the process id, so if a
3123 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3124 ;; each other.
3125 ;; To use this function, do:
3126 ;; (fset 'make-auto-save-file-name
3127 ;; (symbol-function 'emerge-make-auto-save-file-name))
3129 "Return file name to use for auto-saves of current buffer.
3130 Does not consider `auto-save-visited-file-name';
3131 that is checked before calling this function.
3132 You can redefine this for customization.
3133 See also `auto-save-file-name-p'."
3135 ;; if buffer has a file, try the format <file directory>/#<file name>#
3137 "#"
3141 ;; the file is writable, so use it
3142 f
3143 ;; the file isn't writable, so use the format
3144 ;; ~/#&<file name>&<hash of directory>#
3146 "/#&"
3148 "&"
3152 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3154 "/#%"
3155 ;; quote / into \! and \ into \\
3157 "%"
3161 ;; Hash a string into five characters more-or-less suitable for use in a file
3162 ;; name. (Allowed characters are ! through ~, except /.)
3178 ;; Quote any /s in a string by replacing them with \!.
3179 ;; Also, replace any \s by \\, to make it one-to-one.
3191 s)
3193 ;; Metacharacters that have to be protected from the shell when executing
3194 ;; a diff/diff3 command.
3197 More precisely, a [...] regexp to match any one such character."
3201 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3209 s)
3213 ;; arch-tag: a575f092-6e44-400e-b8a2-4124e9377585
3214 ;;; emerge.el ends here