| blob | b17d11d34a43fd2f589a32fc48c8ebd595c4a3c1 |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; This file is part of GNU Emacs.
7 ;; Author: Dale R. Worley <worley@world.std.com>
8 ;; Keywords: unix, vc, tools
10 ;; This software was created by Dale R. Worley and is
11 ;; distributed free of charge. It is placed in the public domain and
12 ;; permission is granted to anyone to use, duplicate, modify and redistribute
13 ;; it provided that this notice is attached.
15 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
16 ;; with respect to this software. The entire risk as to the quality and
17 ;; performance of this software is with the user. IN NO EVENT WILL DALE
18 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
19 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
20 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
21 ;; DAMAGES.
23 ;;; Commentary:
25 ;;; Code:
27 ;; There aren't really global variables, just dynamic bindings
37 ;;; Macros
40 "Defines SYMBOL as an advertised variable.
41 Performs a defvar, then executes `make-variable-buffer-local' on
42 the variable. Also sets the `permanent-local' property, so that
43 `kill-all-local-variables' (called by major-mode setting commands)
44 won't destroy Emerge control variables."
50 ;; Add entries to minor-mode-alist so that emerge modes show correctly
59 minor-mode-alist)))
61 ;; We need to define this function so describe-mode can describe Emerge mode.
63 "Emerge mode is used by the Emerge file-merging package.
64 It is entered only through one of the functions:
65 `emerge-files'
66 `emerge-files-with-ancestor'
67 `emerge-buffers'
68 `emerge-buffers-with-ancestor'
69 `emerge-files-command'
70 `emerge-files-with-ancestor-command'
71 `emerge-files-remote'
72 `emerge-files-with-ancestor-remote'
74 Commands:
79 ;;; Emerge configuration variables
82 "Merge diffs under Emacs control."
85 ;; Commands that produce difference files
86 ;; All that can be configured is the name of the programs to execute
87 ;; (emerge-diff-program and emerge-diff3-program) and the options
88 ;; to be provided (emerge-diff-options). The order in which the file names
89 ;; are given is fixed.
90 ;; The file names are always expanded (see expand-file-name) before being
91 ;; passed to diff, thus they need not be invoked under a shell that
92 ;; understands `~'.
93 ;; The code which processes the diff/diff3 output depends on all the
94 ;; finicky details of their output, including the somewhat strange
95 ;; way they number lines of a file.
97 "Name of the program which compares two files."
101 "Name of the program which compares three files.
102 Its arguments are the ancestor file and the two variant files."
106 "Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
112 "Pattern to match lines produced by diff that describe differences.
113 This is as opposed to lines from the source files."
118 "Regexp that matches normal output lines from `emerge-diff-program'.
119 Lines that do not match are assumed to be error messages."
124 "Regexp that matches normal output lines from `emerge-diff3-program'.
125 Lines that do not match are assumed to be error messages."
130 "Name of the program that checks in RCS revisions."
134 "Name of the program that checks out RCS revisions."
139 "Non-nil if Emerge should process local-variables lists in merge buffers.
140 \(You can explicitly request processing the local-variables
141 by executing `(hack-local-variables)'.)"
145 "If non-nil: `emerge-execute-line' makes no output if an input was deleted.
146 It concludes that an input version has been deleted when an ancestor entry
147 is present, only one A or B entry is present, and an output entry is present.
148 If nil: In such circumstances, the A or B file that is present will be
149 copied to the designated output file."
154 "Flag placed above the highlighted block of code. Must end with newline.
155 Must be set before Emerge is loaded, or emerge-new-flags must be run
156 after setting."
160 "Flag placed below the highlighted block of code. Must end with newline.
161 Must be set before Emerge is loaded, or emerge-new-flags must be run
162 after setting."
166 ;; Hook variables
169 "Hook to run in the merge buffer after the merge has been set up."
173 "Hook to run after a difference has been selected.
174 The variable `n' holds the (internal) number of the difference."
178 "Hook to run after a difference has been unselected.
179 The variable `n' holds the (internal) number of the difference."
183 ;; Variables to control the default directories of the arguments to
184 ;; Emerge commands.
187 "If nil, default dir for filenames in emerge is `default-directory'.
188 If non-nil, filenames complete in the directory of the last argument of the
189 same type to an `emerge-files...' command."
222 ;; The flags used to mark differences in the buffers.
224 ;; These function definitions need to be up here, because they are used
225 ;; during loading.
227 "Function to be called after `emerge-{before,after}-flag'.
228 This is called after these functions are changed to compute values that
229 depend on the flags."
240 "Return the number of matches in STRING for REGEXP."
246 count))
248 ;; Calculate dependent variables
252 "Number of lines that we want to show above and below the flags when we are
253 displaying a difference."
259 "Prefix to put on Emerge temporary file names.
260 Do not start with `~/' or `~USERNAME/'."
265 "customize `temporary-file-directory' instead."
269 "Mode for Emerge temporary files."
274 "it has no effect, temporary files are always private."
279 "Template for `emerge-combine-versions' to combine the two versions.
280 The template is inserted as a string, with the following interpolations:
281 %a the A version of the difference
282 %b the B version of the difference
283 %% the character `%'
284 Don't forget to end the template with a newline.
285 Note that this variable can be made local to a particular merge buffer by
286 giving a prefix argument to `emerge-set-combine-versions-template'."
290 ;; Build keymaps
293 "Keymap of Emerge commands.
294 Directly available in `fast' mode;
298 "Local keymap used in Emerge `fast' mode.
311 "Command prefix for Emerge commands in `edit' mode.
312 Must be set before Emerge is loaded."
316 ;; This function sets up the fixed keymaps. It is executed when the first
317 ;; Emerge is done to allow the user maximum time to set up the global keymap.
319 ;; Set up the basic keymap
322 ; - to negative-argument
363 ;; Allow emerge-basic-keymap to be referenced indirectly
365 ;; Set up the fast mode keymap
367 ;; Allow prefixed commands to work in fast mode
369 ;; Allow emerge-fast-keymap to be referenced indirectly
371 ;; Suppress write-file and save-buffer
453 ;; Variables which control each merge. They are local to the merge buffer.
455 ;; Mode variables
469 "The buffer in which the ancestor variant is stored,
474 buffer-read-only
475 buffer-auto-save-file-name)
476 "Variables and properties of a buffer which are saved, modified and restored
487 "Vector of differences between the variants, and markers in the buffers to
488 show where they are. Each difference is represented by a vector of seven
489 elements. The first two are markers to the beginning and end of the difference
490 section in the A buffer, the second two are markers for the B buffer, the third
492 that difference in the merge buffer.
493 A section of a buffer is described by two markers, one to the beginning of
494 the first line of the section, and one to the beginning of the first line
495 after the section. (If the section is empty, both markers point to the same
496 point.) If the section is part of the selected difference, then the markers
497 are moved into the flags, so the user can edit the section without disturbing
498 the markers.
500 A the merge buffer currently contains the A variant
501 B the merge buffer currently contains the B variant
502 default-A the merge buffer contains the A variant by default,
503 but this difference hasn't been selected yet, so
504 change-default commands can alter it
505 default-B the merge buffer contains the B variant by default,
506 but this difference hasn't been selected yet, so
507 change-default commands can alter it
508 prefer-A in a three-file merge, the A variant is the preferred
509 choice
510 prefer-B in a three-file merge, the B variant is the preferred
517 "The local keymap for the merge buffer, with the emerge commands defined in
518 it. Used to save the local keymap during fast mode, when the local keymap is
523 "If non-nil, emerge-select-A and emerge-select-B automatically advance to
526 "If non-nil, differences for which there is a preference are automatically
529 "Hooks to run in the merge buffer after the merge has been finished.
530 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
531 command.
536 ;;; Setup functions for two-file mode.
539 output-file)
546 ;; Record the directories of the files
551 ;; Make sure the entire files are seen, and they reflect what is on disk
553 buffer-A
558 startup-hooks
560 startup-hooks))
561 ;; Verify that the file matches the buffer
564 buffer-B
569 startup-hooks
571 startup-hooks))
572 ;; Verify that the file matches the buffer
575 output-file)))
577 ;; Start up Emerge on two files
579 output-file)
584 ;; create the merge buffer from buffer A, so it inherits buffer A's
585 ;; default directory, etc.
587 buffer-A
590 merge-buffer
616 ;; Generate the Emerge difference list between two files
620 emerge-diff-buffer
624 emerge-diff-program emerge-diff-options
627 t))
630 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
636 diff-buffer
645 a-begin)))
653 b-begin))))
654 ;; fix the beginning and end numbers, because diff is somewhat
655 ;; strange about how it numbers lines
666 ;; (string-equal diff-type "c")
671 b-begin b-end
673 list)))))
676 ;; Set up buffer of diff/diff3 error messages.
680 emerge-diff-error-buffer
685 ;;; Top-level and setup functions for three-file mode.
688 &optional startup-hooks quit-hooks
689 output-file)
699 ;; Record the directories of the files
705 ;; Make sure the entire files are seen, and they reflect what is on disk
707 buffer-A
712 startup-hooks
714 startup-hooks))
715 ;; Verify that the file matches the buffer
718 buffer-B
723 startup-hooks
725 startup-hooks))
726 ;; Verify that the file matches the buffer
729 buffer-ancestor
734 startup-hooks
736 startup-hooks))
737 ;; Verify that the file matches the buffer
740 buffer-ancestor file-ancestor
741 startup-hooks quit-hooks output-file)))
743 ;; Start up Emerge on two files with an ancestor
745 buffer-ancestor file-ancestor
746 &optional startup-hooks quit-hooks
747 output-file)
753 ;; create the merge buffer from buffer A, so it inherits buffer A's
754 ;; default directory, etc.
756 buffer-A
759 merge-buffer
787 ;; Generate the Emerge difference list between two files with an ancestor
791 emerge-diff-buffer
795 emerge-diff3-program emerge-diff-options
799 t))
802 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
808 diff-buffer
810 ;; leave point after matched line
813 ;; if the A and B files are the same, ignore the difference
827 list))))))
831 ;; This save-excursion allows emerge-get-diff3-group to be called for the
832 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
833 ;; appear in any order. The reason this is necessary is that Gnu diff3
834 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
839 ;; treatment depends on whether it is an "a" group or a "c" group
841 ;; it is a "c" group
843 ;; it has two numbers
848 ;; it has one number
852 ;; it is an "a" group
857 ;;; Functions to start Emerge on files
859 ;;;###autoload
861 quit-hooks)
862 "Run Emerge on two files."
867 nil nil t))
871 f f nil)))))
875 file-A file-B startup-hooks
876 quit-hooks
877 file-out))
879 ;;;###autoload
882 "Run Emerge on two files, giving another file as the ancestor."
887 nil nil t))
890 nil f t)
893 f f nil)))))
897 file-A file-B file-ancestor startup-hooks
898 quit-hooks
899 file-out))
901 ;; Write the merge buffer out in place of the file the A buffer is visiting.
903 ;; if merge was successful was given, save to disk
907 ;;; Functions to start Emerge on buffers
909 ;;;###autoload
911 "Run Emerge on two buffers."
916 buffer-A
919 buffer-B
926 startup-hooks)
927 quit-hooks
928 nil)))
930 ;;;###autoload
932 &optional startup-hooks
933 quit-hooks)
934 "Run Emerge on two buffers, giving another buffer as the ancestor."
941 buffer-A
944 buffer-B
947 buffer-ancestor
953 emerge-file-ancestor
959 startup-hooks)
960 quit-hooks
961 nil)))
963 ;;; Functions to start Emerge from the command line
965 ;;;###autoload
972 file-a file-b nil
975 ;;;###autoload
978 ;; check for a -a flag, for filemerge compatibility
980 ;; arguments are "-a ancestor file-a file-b file-out"
987 ;; arguments are "file-a file-b ancestor file-out"
994 file-a file-b file-anc nil
1001 ;;; Functions to start Emerge via remote request
1003 ;;;###autoload
1007 file-a file-b nil
1009 file-out)
1012 ;;;###autoload
1016 file-a file-b file-anc nil
1018 file-out)
1026 ;;; Functions to start Emerge on RCS versions
1028 ;;;###autoload
1031 "Emerge two RCS revisions of a file."
1038 emerge-last-revision-B revision-B)
1040 file revision-A revision-B startup-hooks
1045 quit-hooks)
1046 quit-hooks)))
1048 ;;;###autoload
1050 revision-B ancestor
1051 &optional
1052 startup-hooks quit-hooks)
1053 "Emerge two RCS revisions of a file, with another revision as ancestor."
1061 emerge-last-revision-B revision-B
1062 emerge-last-revision-ancestor ancestor)
1064 file revision-A revision-B ancestor startup-hooks
1070 quit-hooks))
1071 quit-hooks)))
1074 startup-hooks quit-hooks _output-file)
1079 ;; Get the revisions into buffers
1081 buffer-A
1085 t)
1089 buffer-B
1093 t)
1096 ;; Do the merge
1098 buffer-B emerge-file-B
1102 startup-hooks)
1104 quit-hooks)
1105 nil)))
1108 ancestor
1109 &optional startup-hooks
1110 quit-hooks output-file)
1117 ;; Get the revisions into buffers
1119 buffer-A
1123 revision-A file)
1124 t)
1128 buffer-B
1132 t)
1136 buffer-ancestor
1140 t)
1143 ;; Do the merge
1145 buffer-A emerge-file-A buffer-B emerge-file-B
1146 buffer-ancestor emerge-ancestor
1151 startup-hooks)
1153 quit-hooks)
1154 output-file)))
1156 ;;; Function to start Emerge based on a line in a file
1159 "Run Emerge using files named in current text line.
1160 Looks in that line for whitespace-separated entries of these forms:
1161 a=file1
1162 b=file2
1163 ancestor=file3
1164 output=file4
1165 to specify the files to use in Emerge.
1167 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1168 is present:
1169 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1170 it is assumed that the file in question has been deleted, and it is
1171 not copied to the output file.
1172 Otherwise, the A or B file present is copied to the output file."
1176 ;; Stop if at end of buffer (even though we might be in a line, if
1177 ;; the line does not end with newline)
1180 ;; Go to the beginning of the line
1182 ;; Skip any initial whitespace
1185 ;; Process the entire line
1187 ;; Get the next entry
1189 ;; Break apart the tab (before =) and the filename (after =)
1193 ;; Move point after the entry
1195 ;; Store the filename in the right variable
1215 ;; If the match on the entry pattern failed
1217 ;; Make sure that file-A and file-B are present
1222 ;; Go to the beginning of the next line, so next execution will use
1223 ;; next line in buffer.
1225 ;; Execute the correct command
1227 ;; Merge of two files with ancestor
1231 file-ancestor file-out
1232 nil
1233 ;; When done, return to this buffer.
1238 ;; Merge of two files without ancestor
1242 nil
1243 ;; When done, return to this buffer.
1248 ;; There is an output file (or there would have been an error above),
1249 ;; but only one input file.
1250 ;; The file appears to have been deleted in one version; do nothing.
1253 ;; The file should be copied from the version that contains it
1259 ;;; Sample function for creating information for emerge-execute-line
1262 "Regexp describing files to be processed by `emerge-merge-directories'."
1266 ;;;###autoload
1274 ;; Check that we're not on a line
1277 ;; Turn null strings into nil to indicate directories not used.
1282 ;; Canonicalize the directory names
1299 ;; Set the mark to where we start
1301 ;; Find out what files are in the directories.
1309 emerge-merge-directories-filename-regexp)))
1314 ;; Remove duplicates from all-files.
1320 ;; Generate the control lines for the various files.
1341 ;;; Common setup routines
1343 ;; Set up the window configuration. If POS is given, set the points to
1344 ;; the beginnings of the buffers.
1346 ;; Make sure we are not in the minibuffer window when we try to delete
1347 ;; all other windows.
1365 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1373 ;; Set up the keymap in the merge buffer
1375 ;; Set up fixed keymaps if necessary
1378 ;; Save the old local map
1380 ;; Construct the edit keymap
1384 ;; Install the Emerge commands
1389 ;; Create the additional menu bar items.
1397 ;; Suppress write-file and save-buffer
1399 'emerge-query-write-file
1400 emerge-edit-keymap)
1402 'emerge-query-save-buffer
1403 emerge-edit-keymap)
1411 "Record certain properties of the buffers being merged.
1412 Must be called in the merge buffer. Remembers read-only, modified,
1413 auto-save, and saves them in buffer local variables. Sets the buffers
1414 read-only and turns off `auto-save-mode'.
1415 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1416 ;; force auto-save, because we will turn off auto-saving in buffers for the
1417 ;; duration
1419 ;; remember and alter buffer characteristics
1422 emerge-A-buffer
1426 emerge-merging-values))))
1429 emerge-B-buffer
1433 emerge-merging-values)))))
1436 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1441 A-values))
1444 B-values))))
1446 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1447 ;; Return DESIRED-LINE.
1450 desired-line)
1453 B-buffer
1454 merge-buffer
1455 lineno-list)
1460 ;; Record current line number in each buffer
1461 ;; so we don't have to count from the beginning.
1468 a-begin-marker
1469 a-end-marker
1470 b-begin-marker
1471 b-end-marker
1472 merge-begin-marker
1473 merge-end-marker
1479 ;; place markers at the appropriate places in the buffers
1481 A-buffer
1487 B-buffer
1495 offset)
1496 merge-buffer))
1500 offset)
1501 merge-buffer))
1502 ;; record all the markers for this difference
1504 b-begin-marker b-end-marker
1505 merge-begin-marker merge-end-marker
1506 state)
1507 marker-list)))
1509 ;; convert the list of difference information into a vector for
1510 ;; fast access
1513 ;; If we have an ancestor, select all B variants that we prefer
1525 ;; Process the local-variables list at the end of the merged file, if
1526 ;; requested.
1534 ;;; Common exit routines
1537 ;; clear screen format
1539 ;; delete A, B, and ancestor buffers, if they haven't been changed
1547 ;; Write merge buffer to file
1551 ;;; Commands
1554 "Bring the highlighted region of all three merge buffers into view.
1555 This brings the buffers into view if they are in windows.
1556 With an argument, reestablish the default three-window display."
1558 ;; If there is an argument, rebuild the window structure
1561 emerge-merge-buffer))
1562 ;; Redisplay whatever buffers are showing, if there is a selected difference
1598 ;;; Window scrolling operations
1599 ;; These operations are designed to scroll all three windows the same amount,
1600 ;; so as to keep the text in them aligned.
1602 ;; Perform some operation on all three windows (if they are showing).
1603 ;; Catches all errors on the operation in the A and B windows, but not
1604 ;; in the merge window. Usually, errors come from scrolling off the
1605 ;; beginning or end of the buffer, and this gives a nice error message:
1606 ;; End of buffer is reported in the merge buffer, but if the scroll was
1607 ;; possible in the A or B windows, it is performed there before the error
1608 ;; is reported.
1631 "Scroll up all three merge buffers, if they are in windows.
1632 With argument N, scroll N lines; otherwise scroll by nearly
1633 the height of the merge window.
1634 `C-u -' alone as argument scrolls half the height of the merge window."
1637 'scroll-up
1638 ;; calculate argument to scroll-up
1639 ;; if there is an explicit argument
1641 ;; use it
1643 ;; if not, see if we can determine a default amount (the window height)
1646 ;; no window, use nil
1647 nil
1650 ;; the window was found
1652 ;; C-u as argument means half of default amount
1654 ;; no argument means default amount
1655 default-amount)))))))
1658 "Scroll down all three merge buffers, if they are in windows.
1659 With argument N, scroll N lines; otherwise scroll by nearly
1660 the height of the merge window.
1661 `C-u -' alone as argument scrolls half the height of the merge window."
1664 'scroll-down
1665 ;; calculate argument to scroll-down
1666 ;; if there is an explicit argument
1668 ;; use it
1670 ;; if not, see if we can determine a default amount (the window height)
1673 ;; no window, use nil
1674 nil
1677 ;; the window was found
1679 ;; C-u as argument means half of default amount
1681 ;; no argument means default amount
1682 default-amount)))))))
1685 "Scroll left all three merge buffers, if they are in windows.
1686 If an argument is given, that is how many columns are scrolled, else nearly
1687 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1688 width of the A and B windows."
1691 'scroll-left
1692 ;; calculate argument to scroll-left
1693 ;; if there is an explicit argument
1695 ;; use it
1697 ;; if not, see if we can determine a default amount
1698 ;; (half the window width)
1701 ;; no window, use nil
1702 nil
1705 ;; the window was found
1707 ;; C-u as argument means half of default amount
1709 ;; no argument means default amount
1710 default-amount)))))))
1713 "Scroll right all three merge buffers, if they are in windows.
1714 If an argument is given, that is how many columns are scrolled, else nearly
1715 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1716 width of the A and B windows."
1719 'scroll-right
1720 ;; calculate argument to scroll-right
1721 ;; if there is an explicit argument
1723 ;; use it
1725 ;; if not, see if we can determine a default amount
1726 ;; (half the window width)
1729 ;; no window, use nil
1730 nil
1733 ;; the window was found
1735 ;; C-u as argument means half of default amount
1737 ;; no argument means default amount
1738 default-amount)))))))
1741 "Reset horizontal scrolling in Emerge.
1742 This resets the horizontal scrolling of all three merge buffers
1743 to the left margin, if they are in windows."
1747 nil))
1749 ;; Attempt to show the region nicely.
1750 ;; If there are min-lines lines above and below the region, then don't do
1751 ;; anything.
1752 ;; If not, recenter the region to make it so.
1753 ;; If that isn't possible, remove context lines evenly from top and bottom
1754 ;; so the entire region shows.
1755 ;; If that isn't possible, show the top of the region.
1756 ;; BEG must be at the beginning of a line.
1758 ;; First test whether the entire region is visible with
1759 ;; emerge-min-visible-lines above and below it
1763 beg)
1768 ;; We failed that test, see if it fits at all
1769 ;; Meanwhile positioning it correctly in case it doesn't fit
1773 ;; Determine the number of lines that the region occupies
1779 ;; And position the beginning on the right line
1782 lines))
1787 "Advance to the next difference."
1801 "Go to the previous difference."
1815 "Go to the N-th difference."
1825 "Abort the Emerge session."
1830 "Finish the Emerge session and exit Emerge.
1831 Prefix argument means to abort rather than successfully finish.
1832 The difference depends on how the merge was started,
1833 but usually means to not write over one of the original files, or to signal
1834 to some process which invoked Emerge a failure code.
1836 Unselects the selected difference, if any, restores the read-only and modified
1837 flags of the merged file buffers, restores the local keymap of the merge
1838 buffer, and sets off various emerge flags. Using Emerge commands in this
1839 buffer after this will cause serious problems."
1844 "Do you really want to successfully finish this merge? "
1849 ;; Perform the quit operations.
1854 ;; null out the difference markers so they don't slow down future editing
1855 ;; operations
1863 emerge-difference-list)
1864 ;; allow them to be garbage collected
1866 ;; restore the local map
1868 ;; turn off all the emerge modes
1874 ;; restore mode line
1880 "Select the A variant of this difference.
1881 Refuses to function if this difference has been edited, i.e., if it
1882 is neither the A nor the B variant.
1883 A prefix argument forces the variant to be selected
1884 even if the difference has been edited."
1896 ;; Actually select the A variant
1899 emerge-merge-buffer
1908 "Select the B variant of this difference.
1909 Refuses to function if this difference has been edited, i.e., if it
1910 is neither the A nor the B variant.
1911 A prefix argument forces the variant to be selected
1912 even if the difference has been edited."
1924 ;; Actually select the B variant
1927 emerge-merge-buffer
1936 "Make the A variant the default from here down.
1937 This selects the A variant for all differences from here down in the buffer
1938 which are still defaulted, i.e., which the user has not selected and for
1939 which there is no preference."
1958 "Make the B variant the default from here down.
1959 This selects the B variant for all differences from here down in the buffer
1960 which are still defaulted, i.e., which the user has not selected and for
1961 which there is no preference."
1980 "Set fast mode, for Emerge.
1981 In this mode ordinary Emacs commands are disabled, and Emerge commands
1993 "Set edit mode, for Emerge.
1994 In this mode ordinary Emacs commands are available, and Emerge commands
2006 "Toggle Auto-Advance mode, for Emerge.
2007 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2008 advance to the next difference.
2009 With a positive argument, turn on Auto-Advance mode.
2010 With a negative argument, turn off Auto-Advance mode."
2016 "Auto-advance set"
2021 "Toggle Skip-Prefers mode, for Emerge.
2022 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2023 to automatically skip over differences for which there is a preference.
2024 With a positive argument, turn on Skip-Prefers mode.
2025 With a negative argument, turn off Skip-Prefers mode."
2031 "Skip-prefers set"
2036 "Put the A variant of this difference in the kill ring."
2043 ;; so further kills don't append
2044 this-command)
2049 "Put the B variant of this difference in the kill ring."
2056 ;; so further kills don't append
2057 this-command)
2062 "Insert the A variant of this difference at the point.
2063 Leaves point after text, mark before.
2064 With prefix argument, puts point before, mark after."
2080 "Insert the B variant of this difference at the point.
2081 Leaves point after text, mark before.
2082 With prefix argument, puts point before, mark after."
2098 "Leaves the point before this difference and the mark after it.
2099 With prefix argument, puts mark before, point after."
2114 "Show the names of the buffers or files being operated on by Emerge.
2115 Use C-u l to reset the windows afterward."
2157 "Join the selected difference with the following one.
2158 With a prefix argument, join with the preceding one."
2161 ;; adjust n to be first difference to join
2164 ;; n and n+1 are the differences to join
2165 ;; check that they are both differences
2168 ;; remove the flags
2170 ;; decrement total number of differences
2172 ;; build new differences vector
2192 ps)
2199 ;; set the current difference correctly
2201 ;; fix the mode line
2203 ;; reinsert the flags
2208 "Split the current difference where the points are in the three windows."
2211 ;; check that this is a valid difference
2213 ;; get the point values and old difference
2220 ;; check location of the points, give error if they aren't in the
2221 ;; differences
2231 ;; remove the flags
2233 ;; increment total number of differences
2235 ;; build new differences vector
2247 A-point
2249 B-point
2251 merge-point
2263 ;; set the current difference correctly
2265 ;; fix the mode line
2267 ;; reinsert the flags
2272 "Trim lines off top and bottom of difference that are the same.
2273 If lines are the same in both the A and the B versions, strip them off.
2274 \(This can happen when the A and B versions have common lines that the
2275 ancestor version does not share.)"
2277 ;; make sure we are in a real difference
2279 ;; remove the flags
2288 size success sa sb sm)
2289 ;; move down the tops of the difference regions as much as possible
2290 ;; Try advancing comparing 1000 chars at a time.
2291 ;; When that fails, go 500 chars at a time, and so on.
2311 ;; move up the bottoms of the difference regions as much as possible
2312 ;; Try advancing comparing 1000 chars at a time.
2313 ;; When that fails, go 500 chars at a time, and so on.
2322 bottom-a)))
2325 bottom-b)))
2333 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2334 ;; of the difference regions. Move them to the beginning of lines, as
2335 ;; appropriate.
2356 ;; put the flags back in, recenter the display
2360 ;; FIXME the manual advertised this as working in the A or B buffers,
2361 ;; but it does not, because all the buffer locals are nil there.
2362 ;; It would work to call it from the merge buffer and specify that one
2363 ;; wants to use the value of point in the A or B buffer.
2364 ;; But with the prefix argument already in use, there is no easy way
2365 ;; to have it ask for a buffer.
2367 "Find the difference containing the current position of the point.
2368 If there is no containing difference and the prefix argument is positive,
2369 it finds the nearest following difference. A negative prefix argument finds
2370 the nearest previous difference."
2379 "Find the difference containing point, in the merge buffer.
2380 If there is no containing difference and the prefix argument is positive,
2381 it finds the nearest following difference. A negative prefix argument finds
2382 the nearest previous difference."
2384 ;; search for the point in the merge buffer, using the markers
2385 ;; for the beginning and end of the differences in the merge buffer
2389 "Find the difference containing point, in the A buffer.
2390 This command must be executed in the merge buffer.
2391 If there is no containing difference and the prefix argument is positive,
2392 it finds the nearest following difference. A negative prefix argument finds
2393 the nearest previous difference."
2395 ;; search for the point in the A buffer, using the markers
2396 ;; for the beginning and end of the differences in the A buffer
2402 "Find the difference containing point, in the B buffer.
2403 This command must be executed in the merge buffer.
2404 If there is no containing difference and the prefix argument is positive,
2405 it finds the nearest following difference. A negative prefix argument finds
2406 the nearest previous difference."
2408 ;; search for the point in the B buffer, using the markers
2409 ;; for the beginning and end of the differences in the B buffer
2416 ;; find first difference containing or after the current position
2424 emerge-number-of-differences))
2426 ;; whether the found difference contains the current position
2429 begin))
2430 location)))
2432 ;; numeric value of prefix argument
2436 ;; if the point is in a difference, select it
2438 ;; if the arg is nil and the point is not in a difference, error
2440 ;; if the arg is positive, select the following difference
2443 index
2445 ;; if the arg is negative, select the preceding difference
2452 "Display the current line numbers.
2453 This function displays the line numbers of the points in the A, B, and
2454 merge buffers."
2461 emerge-current-difference)))
2468 merge-line A-line B-line)))
2473 ;; FIXME point-min rather than 1? widen?
2481 temp))
2484 "Set `emerge-combine-versions-template' to STRING.
2485 This value controls how `emerge-combine-versions' combines the two versions.
2486 With prefix argument, `emerge-combine-versions-template' is made local to this
2487 merge buffer. Localization is permanent for any particular merge buffer."
2494 "emerge-set-combine-versions-template set locally"
2498 "Copy region into `emerge-combine-versions-template'.
2499 This controls how `emerge-combine-versions' will combine the two versions.
2500 With prefix argument, `emerge-combine-versions-template' is made local to this
2501 merge buffer. Localization is permanent for any particular merge buffer."
2508 "emerge-set-combine-versions-template set locally."
2512 "Combine versions using the template in `emerge-combine-versions-template'.
2513 Refuses to function if this difference has been edited, i.e., if it is
2514 neither the A nor the B variant.
2515 An argument forces the variant to be selected even if the difference has
2516 been edited."
2521 "Combine the two versions using the template in register REG.
2522 See documentation of the variable `emerge-combine-versions-template'
2523 for how the template is interpreted.
2524 Refuses to function if this difference has been edited, i.e., if it is
2525 neither the A nor the B variant.
2526 An argument forces the variant to be selected even if the difference has
2527 been edited.
2529 Interactively, reads the register using `register-read-with-preview'."
2532 current-prefix-arg))
2542 A-begin A-end B-begin B-end)
2550 A-begin A-end B-begin B-end)
2552 emerge-merge-buffer
2580 "Set the major mode in a merge buffer.
2581 Overrides any change that the mode might make to the mode line or local
2582 keymap. Leaves merge in fast mode."
2597 ;;; Support routines
2599 ;; Select a difference by placing the visual flags around the appropriate
2600 ;; group of lines in the A, B, and merge buffers
2610 after-index)
2613 buffer
2619 ;; insert the flag before the difference
2621 before-index))
2622 here)
2624 ;; insert the flag itself
2627 ;; Put the marker(s) referring to this position 1 character before the
2628 ;; end of the flag, so it won't be damaged by the user.
2629 ;; This gets a bit tricky, as there could be a number of markers
2630 ;; that have to be moved.
2644 ;; insert the flag after the difference
2646 after-index))
2649 ;; insert the flag itself
2651 ;; Put the marker(s) referring to this position 1 character after the
2652 ;; beginning of the flag, so it won't be damaged by the user.
2653 ;; This gets a bit tricky, as there could be a number of markers
2654 ;; that have to be moved.
2669 ;; Unselect a difference by removing the visual flags in the buffers.
2682 buffer
2684 ;; remove the flags, if they're there
2688 ;; the flag isn't there
2694 ;; the flag isn't there
2698 ;; Select a difference, removing any flags that exist now.
2718 ;; Perform tests to see whether user should be allowed to select a version
2719 ;; of this difference:
2720 ;; a valid difference has been selected; and
2721 ;; the difference text in the merge buffer is:
2722 ;; the A version (execute a-version), or
2723 ;; the B version (execute b-version), or
2724 ;; empty (execute neither-version), or
2725 ;; argument FORCE is true (execute neither-version)
2726 ;; Otherwise, signal an error.
2739 emerge-merge-buffer merge-begin
2740 merge-end)
2743 emerge-merge-buffer merge-begin
2744 merge-end)
2750 ;; Read a file name, handling all of the various defaulting rules.
2753 A-file must-match)
2754 ;; `prompt' should not have trailing ": ", so that it can be modified
2755 ;; according to context.
2756 ;; If alternative-default-dir is non-nil, it should be used as the default
2757 ;; directory instead if default-directory, if emerge-default-last-directories
2758 ;; is set.
2759 ;; If default-file is set, it should be used as the default value.
2760 ;; If A-file is set, and its directory is different from
2761 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2762 ;; the default file should be the last part of A-file in the default
2763 ;; directory. (Overriding default-file.)
2765 ;; If this is not the A-file argument (shown by non-nil A-file), and
2766 ;; if emerge-default-last-directories is set, and
2767 ;; the default directory exists but is not the same as the directory of the
2768 ;; A-file,
2769 ;; then make the default file have the same name as the A-file, but in
2770 ;; the default directory.
2772 A-file
2773 alternative-default-dir
2778 alternative-default-dir
2782 ;; If there is a default file, use it.
2785 ;; If emerge-default-last-directories is set, use the
2786 ;; directory from the same argument of the last call of
2787 ;; Emerge as the default for this argument.
2789 alternative-default-dir)
2793 ;; If emerge-default-last-directories is set, use the
2794 ;; directory from the same argument of the last call of
2795 ;; Emerge as the default for this argument.
2797 alternative-default-dir)
2800 ;; Revise the mode line to display which difference we have selected
2806 emerge-number-of-differences
2808 (< emerge-current-difference
2809 emerge-number-of-differences))
2811 emerge-current-difference)
2821 ;; compare two regions in two buffers for containing the same text
2823 ;; first check that the two regions are the same length
2825 nil
2828 ;; bite off and compare no more than 1000 characters at a time
2831 buffer-x
2835 buffer-y
2842 t)))
2844 ;; Construct a unique buffer name.
2845 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2846 ;; prefix<3>suffix, etc.
2855 ;; Verify that we have a difference selected.
2861 ;;; Functions for saving and restoring a batch of variables
2863 ;; These functions save (get the values of) and restore (set the values of)
2864 ;; a list of variables. The argument is a list of symbols (the names of
2865 ;; the variables). A list element can also be a list of two functions,
2866 ;; the first of which (when called with no arguments) gets the value, and
2867 ;; the second (when called with a value as an argument) sets the value.
2868 ;; A "function" is anything that funcall can handle as an argument.
2874 vars))
2886 ;; When the pointless option emerge-temp-file-prefix goes,
2887 ;; make this function obsolete too, and just use make-temp-file.
2889 "Make a private temporary file based on `emerge-temp-file-prefix'."
2892 ;;; Functions that query the user before he can write out the current buffer.
2895 "Ask the user whether to write out an incomplete merge.
2896 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2897 for details of the querying process."
2902 "Ask the user whether to save an incomplete merge.
2903 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2904 for details of the querying process."
2909 "Ask the user whether to save or write out the incomplete merge.
2910 If answer is yes, call COMMAND interactively. During the call, the flags
2911 around the current difference are removed."
2913 ;; He really wants to do it -- unselect the difference for the duration
2918 ;; call-interactively takes the value of current-prefix-arg as the
2919 ;; prefix argument value to be passed to the command. Thus, we have
2920 ;; to do nothing special to make sure the prefix argument is
2921 ;; transmitted to the command.
2928 ;; He's being smart and not doing it
2931 ;; Make sure the current buffer (for a file) has the same contents as the
2932 ;; file on disk, and attempt to remedy the situation if not.
2933 ;; Signal an error if we can't make them the same, or the user doesn't want
2934 ;; to do what is necessary to make them the same.
2936 ;; First check if the file has been modified since the buffer visited it.
2939 ;; If buffer is not obsolete and is modified, offer to save
2943 ;; If buffer is not obsolete and is not modified, do nothing
2944 nil)
2946 ;; If buffer is obsolete and is modified, give error
2948 ;; If buffer is obsolete and is not modified, offer to revert
2952 \f
2953 ;; Utilities that might have value outside of Emerge.
2955 ;; Set up the mode in the current buffer to duplicate the mode in another
2956 ;; buffer.
2958 ;; Set the major mode
2961 ;; Define a key, even if a prefix of it is defined
2963 "Like `define-key', but forcibly creates prefix characters as needed.
2964 If some prefix of KEY has a non-prefix definition, it is redefined."
2965 ;; Find out if a prefix of key is defined
2967 ;; If so, undefine it
2970 ;; Now define the key
2973 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2974 ;;;;; as the major mode
2975 ;;(defun describe-mode (&optional minor)
2976 ;; "Display documentation of current major mode.
2977 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2978 ;;display documentation of active minor modes as well.
2979 ;;For this to work correctly for a minor mode, the mode's indicator variable
2980 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2981 ;;describes the minor mode."
2982 ;; (interactive)
2983 ;; (with-output-to-temp-buffer "*Help*"
2984 ;; (princ mode-name)
2985 ;; (princ " Mode:\n")
2986 ;; (princ (documentation major-mode))
2987 ;; (let ((minor-modes minor-mode-alist)
2988 ;; (locals (buffer-local-variables)))
2989 ;; (while minor-modes
2990 ;; (let* ((minor-mode (car (car minor-modes)))
2991 ;; (indicator (car (cdr (car minor-modes))))
2992 ;; (local-binding (assq minor-mode locals)))
2993 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2994 ;; ;; bound locally in this buffer, non-nil, and has a function
2995 ;; ;; definition.
2996 ;; (if (and local-binding
2997 ;; (cdr local-binding)
2998 ;; (fboundp minor-mode))
2999 ;; (progn
3000 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3001 ;; minor-mode indicator))
3002 ;; (princ (documentation minor-mode)))))
3003 ;; (setq minor-modes (cdr minor-modes))))
3004 ;; (with-current-buffer standard-output
3005 ;; (help-mode))
3006 ;; (help-print-return-message)))
3008 ;; This goes with the redefinition of describe-mode.
3009 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3010 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3012 ;; substitute-key-definition should work now.
3013 ;;;; Function to shadow a definition in a keymap with definitions in another.
3014 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3015 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3016 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3017 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3018 ;;including those whose definition is OLDDEF."
3019 ;; ;; loop through all keymaps accessible from keymap
3020 ;; (let ((maps (accessible-keymaps keymap)))
3021 ;; (while maps
3022 ;; (let ((prefix (car (car maps)))
3023 ;; (map (cdr (car maps))))
3024 ;; ;; examine a keymap
3025 ;; (if (arrayp map)
3026 ;; ;; array keymap
3027 ;; (let ((len (length map))
3028 ;; (i 0))
3029 ;; (while (< i len)
3030 ;; (if (eq (aref map i) olddef)
3031 ;; ;; set the shadowing definition
3032 ;; (let ((key (concat prefix (char-to-string i))))
3033 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3034 ;; (setq i (1+ i))))
3035 ;; ;; sparse keymap
3036 ;; (while map
3037 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3038 ;; ;; set the shadowing definition
3039 ;; (let ((key
3040 ;; (concat prefix (char-to-string (car (car map))))))
3041 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3042 ;; (setq map (cdr map)))))
3043 ;; (setq maps (cdr maps)))))
3045 ;; Define a key if it (or a prefix) is not already defined in the map.
3047 ;; look up the present definition of the key
3050 ;; if it is "too long", look up the valid prefix
3052 ;; if the prefix isn't defined, define it
3054 ;; if there is no present definition, define it
3058 ;; Ordinary substitute-key-definition should do this now.
3059 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3060 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3061 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3062 ;;\(`copy-keymap' will suffice.)"
3063 ;; ;; Loop through all keymaps accessible from keymap
3064 ;; (let ((maps (accessible-keymaps keymap)))
3065 ;; (while maps
3066 ;; ;; Substitute in this keymap
3067 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3068 ;; (setq maps (cdr maps)))))
3070 ;; Show the name of the file in the buffer.
3072 "Displays the name of the file loaded into the current buffer.
3073 If the name won't fit on one line, the minibuffer is expanded to hold it,
3074 and the command waits for a keystroke from the user. If the keystroke is
3075 SPC, it is ignored; if it is anything else, it is processed as a command."
3095 ;; Improved auto-save file names.
3096 ;; This function fixes many problems with the standard auto-save file names:
3097 ;; Auto-save files for non-file buffers get put in the default directory
3098 ;; for the buffer, whether that makes sense or not.
3099 ;; Auto-save files for file buffers get put in the directory of the file,
3100 ;; regardless of whether we can write into it or not.
3101 ;; Auto-save files for non-file buffers don't use the process id, so if a
3102 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3103 ;; each other.
3104 ;; To use this function, do:
3105 ;; (fset 'make-auto-save-file-name
3106 ;; (symbol-function 'emerge-make-auto-save-file-name))
3108 "Return file name to use for auto-saves of current buffer.
3109 Does not consider `auto-save-visited-file-name';
3110 that is checked before calling this function.
3111 You can redefine this for customization.
3112 See also `auto-save-file-name-p'."
3114 ;; if buffer has a file, try the format <file directory>/#<file name>#
3116 "#"
3120 ;; the file is writable, so use it
3121 f
3122 ;; the file isn't writable, so use the format
3123 ;; ~/#&<file name>&<hash of directory>#
3125 "/#&"
3127 "&"
3131 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3133 "/#%"
3134 ;; quote / into \! and \ into \\
3136 "%"
3140 ;; Hash a string into five characters more-or-less suitable for use in a file
3141 ;; name. (Allowed characters are ! through ~, except /.)
3157 ;; Quote any /s in a string by replacing them with \!.
3158 ;; Also, replace any \s by \\, to make it one-to-one.
3170 s)
3172 ;; Metacharacters that have to be protected from the shell when executing
3173 ;; a diff/diff3 command.
3178 "Characters that must be quoted when used in a shell command line.
3179 More precisely, a [...] regexp to match any one such character."
3183 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3193 s))
3197 ;;; emerge.el ends here