| blob | f9821111e71b86266af95d327380d8831682eea5 |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; This file is part of GNU Emacs.
7 ;; Author: Dale R. Worley <worley@world.std.com>
8 ;; Version: 5fsf
9 ;; Keywords: unix, tools
11 ;; This software was created by Dale R. Worley and is
12 ;; distributed free of charge. It is placed in the public domain and
13 ;; permission is granted to anyone to use, duplicate, modify and redistribute
14 ;; it provided that this notice is attached.
16 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
17 ;; with respect to this software. The entire risk as to the quality and
18 ;; performance of this software is with the user. IN NO EVENT WILL DALE
19 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
20 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
21 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
22 ;; DAMAGES.
24 ;;; Commentary:
26 ;;; Code:
28 ;;;###autoload
30 ;;;###autoload (fset 'menu-bar-emerge-menu (symbol-value 'menu-bar-emerge-menu))
32 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-merge-directories]
33 ;;;###autoload '("Merge Directories..." . emerge-merge-directories))
34 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-revisions-with-ancestor]
35 ;;;###autoload '("Revisions with Ancestor..." . emerge-revisions-with-ancestor))
36 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-revisions]
37 ;;;###autoload '("Revisions..." . emerge-revisions))
38 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-files-with-ancestor]
39 ;;;###autoload '("Files with Ancestor..." . emerge-files-with-ancestor))
40 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-files]
41 ;;;###autoload '("Files..." . emerge-files))
42 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-buffers-with-ancestor]
43 ;;;###autoload '("Buffers with Ancestor..." . emerge-buffers-with-ancestor))
44 ;;;###autoload (define-key menu-bar-emerge-menu [emerge-buffers]
45 ;;;###autoload '("Buffers..." . emerge-buffers))
47 ;;; Macros
50 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
51 Differs from `save-excursion' in that it doesn't save the point and mark."
60 "Defines SYMBOL as an advertised variable.
61 Performs a defvar, then executes `make-variable-buffer-local' on
62 the variable. Also sets the `preserved' property, so that
63 `kill-all-local-variables' (called by major-mode setting commands)
64 won't destroy Emerge control variables."
70 ;; Add entries to minor-mode-alist so that emerge modes show correctly
79 minor-mode-alist)))
81 ;; We need to define this function so describe-mode can describe Emerge mode.
83 "Emerge mode is used by the Emerge file-merging package.
84 It is entered only through one of the functions:
85 `emerge-files'
86 `emerge-files-with-ancestor'
87 `emerge-buffers'
88 `emerge-buffers-with-ancestor'
89 `emerge-files-command'
90 `emerge-files-with-ancestor-command'
91 `emerge-files-remote'
92 `emerge-files-with-ancestor-remote'
94 Commands:
103 "Return string describing the version of Emerge.
104 When called interactively, displays the version."
108 emerge-version))
110 ;;; Emerge configuration variables
113 "Merge diffs under Emacs control."
116 ;; Commands that produce difference files
117 ;; All that can be configured is the name of the programs to execute
118 ;; (emerge-diff-program and emerge-diff3-program) and the options
119 ;; to be provided (emerge-diff-options). The order in which the file names
120 ;; are given is fixed.
121 ;; The file names are always expanded (see expand-file-name) before being
122 ;; passed to diff, thus they need not be invoked under a shell that
123 ;; understands `~'.
124 ;; The code which processes the diff/diff3 output depends on all the
125 ;; finicky details of their output, including the somewhat strange
126 ;; way they number lines of a file.
128 "*Name of the program which compares two files."
132 "*Name of the program which compares three files.
133 Its arguments are the ancestor file and the two variant files."
137 "*Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
143 "*Pattern to match lines produced by diff that describe differences.
144 This is as opposed to lines from the source files."
149 "*Regexp that matches normal output lines from `emerge-diff-program'.
150 Lines that do not match are assumed to be error messages."
155 "*Regexp that matches normal output lines from `emerge-diff3-program'.
156 Lines that do not match are assumed to be error messages."
161 "*Name of the program that checks in RCS revisions."
165 "*Name of the program that checks out RCS revisions."
170 "*Non-nil if Emerge should process local-variables lists in merge buffers.
171 \(You can explicitly request processing the local-variables
172 by executing `(hack-local-variables)'.)"
176 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
177 It concludes that an input version has been deleted when an ancestor entry
178 is present, only one A or B entry is present, and an output entry is present.
179 If nil: In such circumstances, the A or B file that is present will be
180 copied to the designated output file."
185 "*Flag placed above the highlighted block of code. Must end with newline.
186 Must be set before Emerge is loaded, or emerge-new-flags must be run
187 after setting."
191 "*Flag placed below the highlighted block of code. Must end with newline.
192 Must be set before Emerge is loaded, or emerge-new-flags must be run
193 after setting."
197 ;; Hook variables
200 "*Hook to run in the merge buffer after the merge has been set up."
204 "*Hook to run after a difference has been selected.
205 The variable `n' holds the (internal) number of the difference."
209 "*Hook to run after a difference has been unselected.
210 The variable `n' holds the (internal) number of the difference."
214 ;; Variables to control the default directories of the arguments to
215 ;; Emerge commands.
218 "*If nil, default dir for filenames in emerge is `default-directory'.
219 If non-nil, filenames complete in the directory of the last argument of the
220 same type to an `emerge-files...' command."
253 ;; The flags used to mark differences in the buffers.
255 ;; These function definitions need to be up here, because they are used
256 ;; during loading.
258 "Function to be called after `emerge-{before,after}-flag'.
259 This is called after these functions are changed to compute values that
260 depend on the flags."
271 "Return the number of matches in STRING for REGEXP."
277 count))
279 ;; Calculate dependent variables
283 "*Number of lines that we want to show above and below the flags when we are
284 displaying a difference."
290 "*Prefix to put on Emerge temporary file names.
291 Do not start with `~/' or `~USERNAME/'."
296 "*Mode for Emerge temporary files."
302 "*Template for `emerge-combine-versions' to combine the two versions.
303 The template is inserted as a string, with the following interpolations:
304 %a the A version of the difference
305 %b the B version of the difference
306 %% the character `%'
307 Don't forget to end the template with a newline.
308 Note that this variable can be made local to a particular merge buffer by
309 giving a prefix argument to `emerge-set-combine-versions-template'."
313 ;; Build keymaps
316 "Keymap of Emerge commands.
317 Directly available in `fast' mode;
321 "Local keymap used in Emerge `fast' mode.
334 "*Command prefix for Emerge commands in `edit' mode.
335 Must be set before Emerge is loaded."
339 ;; This function sets up the fixed keymaps. It is executed when the first
340 ;; Emerge is done to allow the user maximum time to set up the global keymap.
342 ;; Set up the basic keymap
345 ; - to negative-argument
386 ;; Allow emerge-basic-keymap to be referenced indirectly
388 ;; Set up the fast mode keymap
390 ;; Allow prefixed commands to work in fast mode
392 ;; Allow emerge-fast-keymap to be referenced indirectly
394 ;; Suppress write-file and save-buffer
474 ;; Variables which control each merge. They are local to the merge buffer.
476 ;; Mode variables
490 "The buffer in which the ancestor variant is stored,
495 buffer-read-only
496 buffer-auto-save-file-name)
497 "Variables and properties of a buffer which are saved, modified and restored
508 "Vector of differences between the variants, and markers in the buffers to
509 show where they are. Each difference is represented by a vector of seven
510 elements. The first two are markers to the beginning and end of the difference
511 section in the A buffer, the second two are markers for the B buffer, the third
513 that difference in the merge buffer.
514 A section of a buffer is described by two markers, one to the beginning of
515 the first line of the section, and one to the beginning of the first line
516 after the section. (If the section is empty, both markers point to the same
517 point.) If the section is part of the selected difference, then the markers
518 are moved into the flags, so the user can edit the section without disturbing
519 the markers.
521 A the merge buffer currently contains the A variant
522 B the merge buffer currently contains the B variant
523 default-A the merge buffer contains the A variant by default,
524 but this difference hasn't been selected yet, so
525 change-default commands can alter it
526 default-B the merge buffer contains the B variant by default,
527 but this difference hasn't been selected yet, so
528 change-default commands can alter it
529 prefer-A in a three-file merge, the A variant is the preferred
530 choice
531 prefer-B in a three-file merge, the B variant is the preferred
538 "The local keymap for the merge buffer, with the emerge commands defined in
539 it. Used to save the local keymap during fast mode, when the local keymap is
544 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
547 "*If non-nil, differences for which there is a preference are automatically
550 "Hooks to run in the merge buffer after the merge has been finished.
551 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
552 command.
557 ;;; Setup functions for two-file mode.
560 output-file)
567 ;; Record the directories of the files
572 ;; Make sure the entire files are seen, and they reflect what is on disk
574 buffer-A
579 startup-hooks
581 startup-hooks))
582 ;; Verify that the file matches the buffer
585 buffer-B
590 startup-hooks
592 startup-hooks))
593 ;; Verify that the file matches the buffer
596 output-file)))
598 ;; Start up Emerge on two files
600 output-file)
605 ;; create the merge buffer from buffer A, so it inherits buffer A's
606 ;; default directory, etc.
608 buffer-A
611 merge-buffer
637 ;; Generate the Emerge difference list between two files
641 emerge-diff-buffer
645 emerge-diff-program emerge-diff-options
648 t))
651 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
657 diff-buffer
666 a-begin)))
674 b-begin))))
675 ;; fix the beginning and end numbers, because diff is somewhat
676 ;; strange about how it numbers lines
687 ;; (string-equal diff-type "c")
692 b-begin b-end
694 list)))))
697 ;; Set up buffer of diff/diff3 error messages.
701 emerge-diff-error-buffer
706 ;;; Top-level and setup functions for three-file mode.
709 &optional startup-hooks quit-hooks
710 output-file)
720 ;; Record the directories of the files
726 ;; Make sure the entire files are seen, and they reflect what is on disk
728 buffer-A
733 startup-hooks
735 startup-hooks))
736 ;; Verify that the file matches the buffer
739 buffer-B
744 startup-hooks
746 startup-hooks))
747 ;; Verify that the file matches the buffer
750 buffer-ancestor
755 startup-hooks
757 startup-hooks))
758 ;; Verify that the file matches the buffer
761 buffer-ancestor file-ancestor
762 startup-hooks quit-hooks output-file)))
764 ;; Start up Emerge on two files with an ancestor
766 buffer-ancestor file-ancestor
767 &optional startup-hooks quit-hooks
768 output-file)
774 ;; create the merge buffer from buffer A, so it inherits buffer A's
775 ;; default directory, etc.
777 buffer-A
780 merge-buffer
808 ;; Generate the Emerge difference list between two files with an ancestor
812 emerge-diff-buffer
816 emerge-diff3-program emerge-diff-options
820 t))
823 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
829 diff-buffer
831 ;; leave point after matched line
834 ;; if the A and B files are the same, ignore the difference
848 list))))))
852 ;; This save-excursion allows emerge-get-diff3-group to be called for the
853 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
854 ;; appear in any order. The reason this is necessary is that Gnu diff3
855 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
860 ;; treatment depends on whether it is an "a" group or a "c" group
862 ;; it is a "c" group
864 ;; it has two numbers
869 ;; it has one number
873 ;; it is an "a" group
878 ;;; Functions to start Emerge on files
880 ;;;###autoload
882 quit-hooks)
883 "Run Emerge on two files."
888 nil nil t))
892 f f nil)))))
896 file-A file-B startup-hooks
897 quit-hooks
898 file-out))
900 ;;;###autoload
903 "Run Emerge on two files, giving another file as the ancestor."
908 nil nil t))
911 nil f t)
914 f f nil)))))
918 file-A file-B file-ancestor startup-hooks
919 quit-hooks
920 file-out))
922 ;; Write the merge buffer out in place of the file the A buffer is visiting.
924 ;; if merge was successful was given, save to disk
928 ;;; Functions to start Emerge on buffers
930 ;;;###autoload
932 "Run Emerge on two buffers."
937 buffer-A
940 buffer-B
947 startup-hooks)
948 quit-hooks
949 nil)))
951 ;;;###autoload
953 &optional startup-hooks
954 quit-hooks)
955 "Run Emerge on two buffers, giving another buffer as the ancestor."
962 buffer-A
965 buffer-B
968 buffer-ancestor
974 emerge-file-ancestor
980 startup-hooks)
981 quit-hooks
982 nil)))
984 ;;; Functions to start Emerge from the command line
986 ;;;###autoload
993 file-a file-b nil
996 ;;;###autoload
999 ;; check for a -a flag, for filemerge compatibility
1001 ;; arguments are "-a ancestor file-a file-b file-out"
1008 ;; arguments are "file-a file-b ancestor file-out"
1015 file-a file-b file-anc nil
1022 ;;; Functions to start Emerge via remote request
1024 ;;;###autoload
1028 file-a file-b nil
1030 file-out)
1033 ;;;###autoload
1037 file-a file-b file-anc nil
1039 file-out)
1047 ;;; Functions to start Emerge on RCS versions
1049 ;;;###autoload
1052 "Emerge two RCS revisions of a file."
1059 emerge-last-revision-B revision-B)
1061 file revision-A revision-B startup-hooks
1066 quit-hooks)
1067 quit-hooks)))
1069 ;;;###autoload
1071 revision-B ancestor
1072 &optional
1073 startup-hooks quit-hooks)
1074 "Emerge two RCS revisions of a file, with another revision as ancestor."
1082 emerge-last-revision-B revision-B
1083 emerge-last-revision-ancestor ancestor)
1085 file revision-A revision-B ancestor startup-hooks
1091 quit-hooks))
1092 quit-hooks)))
1095 startup-hooks quit-hooks output-file)
1100 ;; Get the revisions into buffers
1102 buffer-A
1106 t)
1110 buffer-B
1114 t)
1117 ;; Do the merge
1119 buffer-B emerge-file-B
1123 startup-hooks)
1125 quit-hooks)
1126 nil)))
1129 ancestor
1130 &optional startup-hooks
1131 quit-hooks output-file)
1138 ;; Get the revisions into buffers
1140 buffer-A
1144 revision-A file)
1145 t)
1149 buffer-B
1153 t)
1157 buffer-ancestor
1161 t)
1164 ;; Do the merge
1166 buffer-A emerge-file-A buffer-B emerge-file-B
1167 buffer-ancestor emerge-ancestor
1172 startup-hooks)
1174 quit-hooks)
1175 output-file)))
1177 ;;; Function to start Emerge based on a line in a file
1180 "Run Emerge using files named in current text line.
1181 Looks in that line for whitespace-separated entries of these forms:
1182 a=file1
1183 b=file2
1184 ancestor=file3
1185 output=file4
1186 to specify the files to use in Emerge.
1188 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1189 is present:
1190 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1191 it is assumed that the file in question has been deleted, and it is
1192 not copied to the output file.
1193 Otherwise, the A or B file present is copied to the output file."
1197 ;; Stop if at end of buffer (even though we might be in a line, if
1198 ;; the line does not end with newline)
1201 ;; Go to the beginning of the line
1203 ;; Skip any initial whitespace
1206 ;; Process the entire line
1208 ;; Get the next entry
1210 ;; Break apart the tab (before =) and the filename (after =)
1214 ;; Move point after the entry
1216 ;; Store the filename in the right variable
1236 ;; If the match on the entry pattern failed
1238 ;; Make sure that file-A and file-B are present
1243 ;; Go to the beginning of the next line, so next execution will use
1244 ;; next line in buffer.
1246 ;; Execute the correct command
1248 ;; Merge of two files with ancestor
1252 file-ancestor file-out
1253 nil
1254 ;; When done, return to this buffer.
1259 ;; Merge of two files without ancestor
1263 nil
1264 ;; When done, return to this buffer.
1269 ;; There is an output file (or there would have been an error above),
1270 ;; but only one input file.
1271 ;; The file appears to have been deleted in one version; do nothing.
1274 ;; The file should be copied from the version that contains it
1280 ;;; Sample function for creating information for emerge-execute-line
1283 "Regexp describing files to be processed by `emerge-merge-directories'."
1287 ;;;###autoload
1295 ;; Check that we're not on a line
1298 ;; Turn null strings into nil to indicate directories not used.
1303 ;; Canonicalize the directory names
1320 ;; Set the mark to where we start
1322 ;; Find out what files are in the directories.
1330 emerge-merge-directories-filename-regexp)))
1335 ;; Remove duplicates from all-files.
1341 ;; Generate the control lines for the various files.
1362 ;;; Common setup routines
1364 ;; Set up the window configuration. If POS is given, set the points to
1365 ;; the beginnings of the buffers.
1367 ;; Make sure we are not in the minibuffer window when we try to delete
1368 ;; all other windows.
1386 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1394 ;; Set up the keymap in the merge buffer
1396 ;; Set up fixed keymaps if necessary
1399 ;; Save the old local map
1401 ;; Construct the edit keymap
1405 ;; Install the Emerge commands
1410 ;; Create the additional menu bar items.
1418 ;; Suppress write-file and save-buffer
1420 'emerge-query-write-file
1421 emerge-edit-keymap)
1423 'emerge-query-save-buffer
1424 emerge-edit-keymap)
1432 "Record certain properties of the buffers being merged.
1433 Must be called in the merge buffer. Remembers read-only, modified,
1434 auto-save, and saves them in buffer local variables. Sets the buffers
1435 read-only and turns off `auto-save-mode'.
1436 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1437 ;; force auto-save, because we will turn off auto-saving in buffers for the
1438 ;; duration
1440 ;; remember and alter buffer characteristics
1443 emerge-A-buffer
1447 emerge-merging-values))))
1450 emerge-B-buffer
1454 emerge-merging-values)))))
1457 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1462 A-values))
1465 B-values))))
1467 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1468 ;; Return DESIRED-LINE.
1471 desired-line)
1474 B-buffer
1475 merge-buffer
1476 lineno-list)
1481 ;; Record current line number in each buffer
1482 ;; so we don't have to count from the beginning.
1489 a-begin-marker
1490 a-end-marker
1491 b-begin-marker
1492 b-end-marker
1493 merge-begin-marker
1494 merge-end-marker
1500 ;; place markers at the appropriate places in the buffers
1502 A-buffer
1508 B-buffer
1516 offset)
1517 merge-buffer))
1521 offset)
1522 merge-buffer))
1523 ;; record all the markers for this difference
1525 b-begin-marker b-end-marker
1526 merge-begin-marker merge-end-marker
1527 state)
1528 marker-list)))
1530 ;; convert the list of difference information into a vector for
1531 ;; fast access
1534 ;; If we have an ancestor, select all B variants that we prefer
1546 ;; Process the local-variables list at the end of the merged file, if
1547 ;; requested.
1555 ;;; Common exit routines
1558 ;; clear screen format
1560 ;; delete A, B, and ancestor buffers, if they haven't been changed
1568 ;; Write merge buffer to file
1572 ;;; Commands
1575 "Bring the highlighted region of all three merge buffers into view.
1576 This brings the buffers into view if they are in windows.
1577 With an argument, reestablish the default three-window display."
1579 ;; If there is an argument, rebuild the window structure
1582 emerge-merge-buffer))
1583 ;; Redisplay whatever buffers are showing, if there is a selected difference
1619 ;;; Window scrolling operations
1620 ;; These operations are designed to scroll all three windows the same amount,
1621 ;; so as to keep the text in them aligned.
1623 ;; Perform some operation on all three windows (if they are showing).
1624 ;; Catches all errors on the operation in the A and B windows, but not
1625 ;; in the merge window. Usually, errors come from scrolling off the
1626 ;; beginning or end of the buffer, and this gives a nice error message:
1627 ;; End of buffer is reported in the merge buffer, but if the scroll was
1628 ;; possible in the A or B windows, it is performed there before the error
1629 ;; is reported.
1652 "Scroll up all three merge buffers, if they are in windows.
1653 With argument N, scroll N lines; otherwise scroll by nearly
1654 the height of the merge window.
1655 `C-u -' alone as argument scrolls half the height of the merge window."
1658 'scroll-up
1659 ;; calculate argument to scroll-up
1660 ;; if there is an explicit argument
1662 ;; use it
1664 ;; if not, see if we can determine a default amount (the window height)
1667 ;; no window, use nil
1668 nil
1671 ;; the window was found
1673 ;; C-u as argument means half of default amount
1675 ;; no argument means default amount
1676 default-amount)))))))
1679 "Scroll down all three merge buffers, if they are in windows.
1680 With argument N, scroll N lines; otherwise scroll by nearly
1681 the height of the merge window.
1682 `C-u -' alone as argument scrolls half the height of the merge window."
1685 'scroll-down
1686 ;; calculate argument to scroll-down
1687 ;; if there is an explicit argument
1689 ;; use it
1691 ;; if not, see if we can determine a default amount (the window height)
1694 ;; no window, use nil
1695 nil
1698 ;; the window was found
1700 ;; C-u as argument means half of default amount
1702 ;; no argument means default amount
1703 default-amount)))))))
1706 "Scroll left all three merge buffers, if they are in windows.
1707 If an argument is given, that is how many columns are scrolled, else nearly
1708 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1709 width of the A and B windows."
1712 'scroll-left
1713 ;; calculate argument to scroll-left
1714 ;; if there is an explicit argument
1716 ;; use it
1718 ;; if not, see if we can determine a default amount
1719 ;; (half the window width)
1722 ;; no window, use nil
1723 nil
1726 ;; the window was found
1728 ;; C-u as argument means half of default amount
1730 ;; no argument means default amount
1731 default-amount)))))))
1734 "Scroll right all three merge buffers, if they are in windows.
1735 If an argument is given, that is how many columns are scrolled, else nearly
1736 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1737 width of the A and B windows."
1740 'scroll-right
1741 ;; calculate argument to scroll-right
1742 ;; if there is an explicit argument
1744 ;; use it
1746 ;; if not, see if we can determine a default amount
1747 ;; (half the window width)
1750 ;; no window, use nil
1751 nil
1754 ;; the window was found
1756 ;; C-u as argument means half of default amount
1758 ;; no argument means default amount
1759 default-amount)))))))
1762 "Reset horizontal scrolling in Emerge.
1763 This resets the horizontal scrolling of all three merge buffers
1764 to the left margin, if they are in windows."
1768 nil))
1770 ;; Attempt to show the region nicely.
1771 ;; If there are min-lines lines above and below the region, then don't do
1772 ;; anything.
1773 ;; If not, recenter the region to make it so.
1774 ;; If that isn't possible, remove context lines balancedly from top and bottom
1775 ;; so the entire region shows.
1776 ;; If that isn't possible, show the top of the region.
1777 ;; BEG must be at the beginning of a line.
1779 ;; First test whether the entire region is visible with
1780 ;; emerge-min-visible-lines above and below it
1784 beg)
1789 ;; We failed that test, see if it fits at all
1790 ;; Meanwhile positioning it correctly in case it doesn't fit
1794 ;; Determine the number of lines that the region occupies
1800 ;; And position the beginning on the right line
1803 lines))
1808 "Advance to the next difference."
1822 "Go to the previous difference."
1836 "Go to the N-th difference."
1846 "Abort the Emerge session."
1851 "Finish the Emerge session and exit Emerge.
1852 Prefix argument means to abort rather than successfully finish.
1853 The difference depends on how the merge was started,
1854 but usually means to not write over one of the original files, or to signal
1855 to some process which invoked Emerge a failure code.
1857 Unselects the selected difference, if any, restores the read-only and modified
1858 flags of the merged file buffers, restores the local keymap of the merge
1859 buffer, and sets off various emerge flags. Using Emerge commands in this
1860 buffer after this will cause serious problems."
1865 "Do you really want to successfully finish this merge? "
1870 ;; Perform the quit operations.
1875 ;; null out the difference markers so they don't slow down future editing
1876 ;; operations
1884 emerge-difference-list)
1885 ;; allow them to be garbage collected
1887 ;; restore the local map
1889 ;; turn off all the emerge modes
1895 ;; restore mode line
1901 "Select the A variant of this difference.
1902 Refuses to function if this difference has been edited, i.e., if it
1903 is neither the A nor the B variant.
1904 A prefix argument forces the variant to be selected
1905 even if the difference has been edited."
1918 ;; Actually select the A variant
1921 emerge-merge-buffer
1930 "Select the B variant of this difference.
1931 Refuses to function if this difference has been edited, i.e., if it
1932 is neither the A nor the B variant.
1933 A prefix argument forces the variant to be selected
1934 even if the difference has been edited."
1947 ;; Actually select the B variant
1950 emerge-merge-buffer
1959 "Make the A variant the default from here down.
1960 This selects the A variant for all differences from here down in the buffer
1961 which are still defaulted, i.e., which the user has not selected and for
1962 which there is no preference."
1981 "Make the B variant the default from here down.
1982 This selects the B variant for all differences from here down in the buffer
1983 which are still defaulted, i.e., which the user has not selected and for
1984 which there is no preference."
2003 "Set fast mode, for Emerge.
2004 In this mode ordinary Emacs commands are disabled, and Emerge commands
2016 "Set edit mode, for Emerge.
2017 In this mode ordinary Emacs commands are available, and Emerge commands
2029 "Toggle Auto-Advance mode, for Emerge.
2030 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2031 advance to the next difference.
2032 With a positive argument, turn on Auto-Advance mode.
2033 With a negative argument, turn off Auto-Advance mode."
2039 "Auto-advance set"
2044 "Toggle Skip-Prefers mode, for Emerge.
2045 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2046 to automatically skip over differences for which there is a preference.
2047 With a positive argument, turn on Skip-Prefers mode.
2048 With a negative argument, turn off Skip-Prefers mode."
2054 "Skip-prefers set"
2059 "Put the A variant of this difference in the kill ring."
2066 ;; so further kills don't append
2067 this-command)
2073 "Put the B variant of this difference in the kill ring."
2080 ;; so further kills don't append
2081 this-command)
2087 "Insert the A variant of this difference at the point.
2088 Leaves point after text, mark before.
2089 With prefix argument, puts point before, mark after."
2105 "Insert the B variant of this difference at the point.
2106 Leaves point after text, mark before.
2107 With prefix argument, puts point before, mark after."
2123 "Leaves the point before this difference and the mark after it.
2124 With prefix argument, puts mark before, point after."
2139 "Show the names of the buffers or files being operated on by Emerge.
2140 Use C-u l to reset the windows afterward."
2183 "Join the selected difference with the following one.
2184 With a prefix argument, join with the preceding one."
2187 ;; adjust n to be first difference to join
2190 ;; n and n+1 are the differences to join
2191 ;; check that they are both differences
2194 ;; remove the flags
2196 ;; decrement total number of differences
2198 ;; build new differences vector
2218 ps)
2225 ;; set the current difference correctly
2227 ;; fix the mode line
2229 ;; reinsert the flags
2234 "Split the current difference where the points are in the three windows."
2237 ;; check that this is a valid difference
2239 ;; get the point values and old difference
2246 ;; check location of the points, give error if they aren't in the
2247 ;; differences
2257 ;; remove the flags
2259 ;; increment total number of differences
2261 ;; build new differences vector
2273 A-point
2275 B-point
2277 merge-point
2289 ;; set the current difference correctly
2291 ;; fix the mode line
2293 ;; reinsert the flags
2298 "Trim lines off top and bottom of difference that are the same.
2299 If lines are the same in both the A and the B versions, strip them off.
2300 \(This can happen when the A and B versions have common lines that the
2301 ancestor version does not share.)"
2303 ;; make sure we are in a real difference
2305 ;; remove the flags
2314 size success sa sb sm)
2315 ;; move down the tops of the difference regions as much as possible
2316 ;; Try advancing comparing 1000 chars at a time.
2317 ;; When that fails, go 500 chars at a time, and so on.
2337 ;; move up the bottoms of the difference regions as much as possible
2338 ;; Try advancing comparing 1000 chars at a time.
2339 ;; When that fails, go 500 chars at a time, and so on.
2348 bottom-a)))
2351 bottom-b)))
2359 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2360 ;; of the difference regions. Move them to the beginning of lines, as
2361 ;; appropriate.
2382 ;; put the flags back in, recenter the display
2387 "Find the difference containing the current position of the point.
2388 If there is no containing difference and the prefix argument is positive,
2389 it finds the nearest following difference. A negative prefix argument finds
2390 the nearest previous difference."
2399 "Find the difference containing point, in the merge buffer.
2400 If there is no containing difference and the prefix argument is positive,
2401 it finds the nearest following difference. A negative prefix argument finds
2402 the nearest previous difference."
2404 ;; search for the point in the merge buffer, using the markers
2405 ;; for the beginning and end of the differences in the merge buffer
2409 "Find the difference containing point, in the A buffer.
2410 This command must be executed in the merge buffer.
2411 If there is no containing difference and the prefix argument is positive,
2412 it finds the nearest following difference. A negative prefix argument finds
2413 the nearest previous difference."
2415 ;; search for the point in the A buffer, using the markers
2416 ;; for the beginning and end of the differences in the A buffer
2422 "Find the difference containing point, in the B buffer.
2423 This command must be executed in the merge buffer.
2424 If there is no containing difference and the prefix argument is positive,
2425 it finds the nearest following difference. A negative prefix argument finds
2426 the nearest previous difference."
2428 ;; search for the point in the B buffer, using the markers
2429 ;; for the beginning and end of the differences in the B buffer
2436 ;; find first difference containing or after the current position
2444 emerge-number-of-differences))
2446 ;; whether the found difference contains the current position
2449 begin))
2450 location)))
2452 ;; numeric value of prefix argument
2456 ;; if the point is in a difference, select it
2458 ;; if the arg is nil and the point is not in a difference, error
2460 ;; if the arg is positive, select the following difference
2463 index
2465 ;; if the arg is negative, select the preceding difference
2472 "Display the current line numbers.
2473 This function displays the line numbers of the points in the A, B, and
2474 merge buffers."
2487 merge-line A-line B-line)))
2500 temp))
2503 "Set `emerge-combine-versions-template' to STRING.
2504 This value controls how `emerge-combine-versions' combines the two versions.
2505 With prefix argument, `emerge-combine-versions-template' is made local to this
2506 merge buffer. Localization is permanent for any particular merge buffer."
2513 "emerge-set-combine-versions-template set locally"
2517 "Copy region into `emerge-combine-versions-template'.
2518 This controls how `emerge-combine-versions' will combine the two versions.
2519 With prefix argument, `emerge-combine-versions-template' is made local to this
2520 merge buffer. Localization is permanent for any particular merge buffer."
2527 "emerge-set-combine-versions-template set locally."
2531 "Combine versions using the template in `emerge-combine-versions-template'.
2532 Refuses to function if this difference has been edited, i.e., if it is
2533 neither the A nor the B variant.
2534 An argument forces the variant to be selected even if the difference has
2535 been edited."
2540 "Combine the two versions using the template in register REG.
2541 See documentation of the variable `emerge-combine-versions-template'
2542 for how the template is interpreted.
2543 Refuses to function if this difference has been edited, i.e., if it is
2544 neither the A nor the B variant.
2545 An argument forces the variant to be selected even if the difference has
2546 been edited."
2557 A-begin A-end B-begin B-end)
2563 A-begin A-end B-begin B-end)
2565 emerge-merge-buffer
2593 "Set the major mode in a merge buffer.
2594 Overrides any change that the mode might make to the mode line or local
2595 keymap. Leaves merge in fast mode."
2610 ;;; Support routines
2612 ;; Select a difference by placing the visual flags around the appropriate
2613 ;; group of lines in the A, B, and merge buffers
2623 after-index)
2626 buffer
2632 ;; insert the flag before the difference
2634 before-index))
2635 here)
2637 ;; insert the flag itself
2640 ;; Put the marker(s) referring to this position 1 character before the
2641 ;; end of the flag, so it won't be damaged by the user.
2642 ;; This gets a bit tricky, as there could be a number of markers
2643 ;; that have to be moved.
2657 ;; insert the flag after the difference
2659 after-index))
2662 ;; insert the flag itself
2664 ;; Put the marker(s) referring to this position 1 character after the
2665 ;; beginning of the flag, so it won't be damaged by the user.
2666 ;; This gets a bit tricky, as there could be a number of markers
2667 ;; that have to be moved.
2682 ;; Unselect a difference by removing the visual flags in the buffers.
2695 buffer
2697 ;; remove the flags, if they're there
2701 ;; the flag isn't there
2707 ;; the flag isn't there
2711 ;; Select a difference, removing any flags that exist now.
2731 ;; Perform tests to see whether user should be allowed to select a version
2732 ;; of this difference:
2733 ;; a valid difference has been selected; and
2734 ;; the difference text in the merge buffer is:
2735 ;; the A version (execute a-version), or
2736 ;; the B version (execute b-version), or
2737 ;; empty (execute neither-version), or
2738 ;; argument FORCE is true (execute neither-version)
2739 ;; Otherwise, signal an error.
2752 emerge-merge-buffer merge-begin
2753 merge-end)
2756 emerge-merge-buffer merge-begin
2757 merge-end)
2763 ;; Read a file name, handling all of the various defaulting rules.
2766 A-file must-match)
2767 ;; `prompt' should not have trailing ": ", so that it can be modified
2768 ;; according to context.
2769 ;; If alternative-default-dir is non-nil, it should be used as the default
2770 ;; directory instead if default-directory, if emerge-default-last-directories
2771 ;; is set.
2772 ;; If default-file is set, it should be used as the default value.
2773 ;; If A-file is set, and its directory is different from
2774 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2775 ;; the default file should be the last part of A-file in the default
2776 ;; directory. (Overriding default-file.)
2778 ;; If this is not the A-file argument (shown by non-nil A-file), and
2779 ;; if emerge-default-last-directories is set, and
2780 ;; the default directory exists but is not the same as the directory of the
2781 ;; A-file,
2782 ;; then make the default file have the same name as the A-file, but in
2783 ;; the default directory.
2785 A-file
2786 alternative-default-dir
2791 alternative-default-dir
2795 ;; If there is a default file, use it.
2798 ;; If emerge-default-last-directories is set, use the
2799 ;; directory from the same argument of the last call of
2800 ;; Emerge as the default for this argument.
2802 alternative-default-dir)
2806 ;; If emerge-default-last-directories is set, use the
2807 ;; directory from the same argument of the last call of
2808 ;; Emerge as the default for this argument.
2810 alternative-default-dir)
2813 ;; Revise the mode line to display which difference we have selected
2819 emerge-number-of-differences
2821 (< emerge-current-difference
2822 emerge-number-of-differences))
2824 emerge-current-difference)
2834 ;; compare two regions in two buffers for containing the same text
2836 ;; first check that the two regions are the same length
2838 nil
2841 ;; bite off and compare no more than 1000 characters at a time
2844 buffer-x
2848 buffer-y
2855 t)))
2857 ;; Construct a unique buffer name.
2858 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2859 ;; prefix<3>suffix, etc.
2868 ;; Verify that we have a difference selected.
2874 ;;; Functions for saving and restoring a batch of variables
2876 ;; These functions save (get the values of) and restore (set the values of)
2877 ;; a list of variables. The argument is a list of symbols (the names of
2878 ;; the variables). A list element can also be a list of two functions,
2879 ;; the first of which (when called with no arguments) gets the value, and
2880 ;; the second (when called with a value as an argument) sets the value.
2881 ;; A "function" is anything that funcall can handle as an argument.
2887 vars))
2899 ;; Make a temporary file that only we have access to.
2900 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2908 f))
2910 ;;; Functions that query the user before he can write out the current buffer.
2913 "Ask the user whether to write out an incomplete merge.
2914 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2915 for details of the querying process."
2920 "Ask the user whether to save an incomplete merge.
2921 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2922 for details of the querying process."
2927 "Ask the user whether to save or write out the incomplete merge.
2928 If answer is yes, call COMMAND interactively. During the call, the flags
2929 around the current difference are removed."
2931 ;; He really wants to do it -- unselect the difference for the duration
2936 ;; call-interactively takes the value of current-prefix-arg as the
2937 ;; prefix argument value to be passed to the command. Thus, we have
2938 ;; to do nothing special to make sure the prefix argument is
2939 ;; transmitted to the command.
2946 ;; He's being smart and not doing it
2949 ;; Make sure the current buffer (for a file) has the same contents as the
2950 ;; file on disk, and attempt to remedy the situation if not.
2951 ;; Signal an error if we can't make them the same, or the user doesn't want
2952 ;; to do what is necessary to make them the same.
2954 ;; First check if the file has been modified since the buffer visited it.
2957 ;; If buffer is not obsolete and is modified, offer to save
2961 ;; If buffer is not obsolete and is not modified, do nothing
2962 nil)
2964 ;; If buffer is obsolete and is modified, give error
2966 ;; If buffer is obsolete and is not modified, offer to revert
2970 \f
2971 ;; Utilities that might have value outside of Emerge.
2973 ;; Set up the mode in the current buffer to duplicate the mode in another
2974 ;; buffer.
2976 ;; Set the major mode
2979 ;; Define a key, even if a prefix of it is defined
2981 "Like `define-key', but forcibly creates prefix characters as needed.
2982 If some prefix of KEY has a non-prefix definition, it is redefined."
2983 ;; Find out if a prefix of key is defined
2985 ;; If so, undefine it
2988 ;; Now define the key
2991 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2992 ;;;;; as the major mode
2993 ;;(defun describe-mode (&optional minor)
2994 ;; "Display documentation of current major mode.
2995 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2996 ;;display documentation of active minor modes as well.
2997 ;;For this to work correctly for a minor mode, the mode's indicator variable
2998 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2999 ;;describes the minor mode."
3000 ;; (interactive)
3001 ;; (with-output-to-temp-buffer "*Help*"
3002 ;; (princ mode-name)
3003 ;; (princ " Mode:\n")
3004 ;; (princ (documentation major-mode))
3005 ;; (let ((minor-modes minor-mode-alist)
3006 ;; (locals (buffer-local-variables)))
3007 ;; (while minor-modes
3008 ;; (let* ((minor-mode (car (car minor-modes)))
3009 ;; (indicator (car (cdr (car minor-modes))))
3010 ;; (local-binding (assq minor-mode locals)))
3011 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
3012 ;; ;; bound locally in this buffer, non-nil, and has a function
3013 ;; ;; definition.
3014 ;; (if (and local-binding
3015 ;; (cdr local-binding)
3016 ;; (fboundp minor-mode))
3017 ;; (progn
3018 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3019 ;; minor-mode indicator))
3020 ;; (princ (documentation minor-mode)))))
3021 ;; (setq minor-modes (cdr minor-modes))))
3022 ;; (save-excursion
3023 ;; (set-buffer standard-output)
3024 ;; (help-mode))
3025 ;; (print-help-return-message)))
3027 ;; This goes with the redefinition of describe-mode.
3028 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3029 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3031 ;; substitute-key-definition should work now.
3032 ;;;; Function to shadow a definition in a keymap with definitions in another.
3033 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3034 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3035 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3036 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3037 ;;including those whose definition is OLDDEF."
3038 ;; ;; loop through all keymaps accessible from keymap
3039 ;; (let ((maps (accessible-keymaps keymap)))
3040 ;; (while maps
3041 ;; (let ((prefix (car (car maps)))
3042 ;; (map (cdr (car maps))))
3043 ;; ;; examine a keymap
3044 ;; (if (arrayp map)
3045 ;; ;; array keymap
3046 ;; (let ((len (length map))
3047 ;; (i 0))
3048 ;; (while (< i len)
3049 ;; (if (eq (aref map i) olddef)
3050 ;; ;; set the shadowing definition
3051 ;; (let ((key (concat prefix (char-to-string i))))
3052 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3053 ;; (setq i (1+ i))))
3054 ;; ;; sparse keymap
3055 ;; (while map
3056 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3057 ;; ;; set the shadowing definition
3058 ;; (let ((key
3059 ;; (concat prefix (char-to-string (car (car map))))))
3060 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3061 ;; (setq map (cdr map)))))
3062 ;; (setq maps (cdr maps)))))
3064 ;; Define a key if it (or a prefix) is not already defined in the map.
3066 ;; look up the present definition of the key
3069 ;; if it is "too long", look up the valid prefix
3071 ;; if the prefix isn't defined, define it
3073 ;; if there is no present definition, define it
3077 ;; Ordinary substitute-key-definition should do this now.
3078 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3079 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3080 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3081 ;;\(`copy-keymap' will suffice.)"
3082 ;; ;; Loop through all keymaps accessible from keymap
3083 ;; (let ((maps (accessible-keymaps keymap)))
3084 ;; (while maps
3085 ;; ;; Substitute in this keymap
3086 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3087 ;; (setq maps (cdr maps)))))
3089 ;; Show the name of the file in the buffer.
3091 "Displays the name of the file loaded into the current buffer.
3092 If the name won't fit on one line, the minibuffer is expanded to hold it,
3093 and the command waits for a keystroke from the user. If the keystroke is
3094 SPC, it is ignored; if it is anything else, it is processed as a command."
3115 ;; Improved auto-save file names.
3116 ;; This function fixes many problems with the standard auto-save file names:
3117 ;; Auto-save files for non-file buffers get put in the default directory
3118 ;; for the buffer, whether that makes sense or not.
3119 ;; Auto-save files for file buffers get put in the directory of the file,
3120 ;; regardless of whether we can write into it or not.
3121 ;; Auto-save files for non-file buffers don't use the process id, so if a
3122 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3123 ;; each other.
3124 ;; To use this function, do:
3125 ;; (fset 'make-auto-save-file-name
3126 ;; (symbol-function 'emerge-make-auto-save-file-name))
3128 "Return file name to use for auto-saves of current buffer.
3129 Does not consider `auto-save-visited-file-name';
3130 that is checked before calling this function.
3131 You can redefine this for customization.
3132 See also `auto-save-file-name-p'."
3134 ;; if buffer has a file, try the format <file directory>/#<file name>#
3136 "#"
3140 ;; the file is writable, so use it
3141 f
3142 ;; the file isn't writable, so use the format
3143 ;; ~/#&<file name>&<hash of directory>#
3145 "/#&"
3147 "&"
3151 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3153 "/#%"
3154 ;; quote / into \! and \ into \\
3156 "%"
3160 ;; Hash a string into five characters more-or-less suitable for use in a file
3161 ;; name. (Allowed characters are ! through ~, except /.)
3177 ;; Quote any /s in a string by replacing them with \!.
3178 ;; Also, replace any \s by \\, to make it one-to-one.
3190 s)
3192 ;; Metacharacters that have to be protected from the shell when executing
3193 ;; a diff/diff3 command.
3196 More precisely, a [...] regexp to match any one such character."
3200 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3208 s)
3212 ;;; arch-tag: a575f092-6e44-400e-b8a2-4124e9377585
3213 ;;; emerge.el ends here