| blob | 9c25ec43321006a6307a97ff4f9e865040c0845c |
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
625 emerge-diff-options
628 t))
631 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
637 diff-buffer
646 a-begin)))
654 b-begin))))
655 ;; fix the beginning and end numbers, because diff is somewhat
656 ;; strange about how it numbers lines
667 ;; (string-equal diff-type "c")
672 b-begin b-end
674 list)))))
677 ;; Set up buffer of diff/diff3 error messages.
681 emerge-diff-error-buffer
686 ;;; Top-level and setup functions for three-file mode.
689 &optional startup-hooks quit-hooks
690 output-file)
700 ;; Record the directories of the files
706 ;; Make sure the entire files are seen, and they reflect what is on disk
708 buffer-A
713 startup-hooks
715 startup-hooks))
716 ;; Verify that the file matches the buffer
719 buffer-B
724 startup-hooks
726 startup-hooks))
727 ;; Verify that the file matches the buffer
730 buffer-ancestor
735 startup-hooks
737 startup-hooks))
738 ;; Verify that the file matches the buffer
741 buffer-ancestor file-ancestor
742 startup-hooks quit-hooks output-file)))
744 ;; Start up Emerge on two files with an ancestor
746 buffer-ancestor file-ancestor
747 &optional startup-hooks quit-hooks
748 output-file)
754 ;; create the merge buffer from buffer A, so it inherits buffer A's
755 ;; default directory, etc.
757 buffer-A
760 merge-buffer
788 ;; Generate the Emerge difference list between two files with an ancestor
792 emerge-diff-buffer
797 emerge-diff-options
801 t))
804 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
810 diff-buffer
812 ;; leave point after matched line
815 ;; if the A and B files are the same, ignore the difference
829 list))))))
833 ;; This save-excursion allows emerge-get-diff3-group to be called for the
834 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
835 ;; appear in any order. The reason this is necessary is that Gnu diff3
836 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
841 ;; treatment depends on whether it is an "a" group or a "c" group
843 ;; it is a "c" group
845 ;; it has two numbers
850 ;; it has one number
854 ;; it is an "a" group
859 ;;; Functions to start Emerge on files
861 ;;;###autoload
863 quit-hooks)
864 "Run Emerge on two files."
869 nil nil t))
873 f f nil)))))
877 file-A file-B startup-hooks
878 quit-hooks
879 file-out))
881 ;;;###autoload
884 "Run Emerge on two files, giving another file as the ancestor."
889 nil nil t))
892 nil f t)
895 f f nil)))))
899 file-A file-B file-ancestor startup-hooks
900 quit-hooks
901 file-out))
903 ;; Write the merge buffer out in place of the file the A buffer is visiting.
905 ;; if merge was successful was given, save to disk
909 ;;; Functions to start Emerge on buffers
911 ;;;###autoload
913 "Run Emerge on two buffers."
918 buffer-A
921 buffer-B
928 startup-hooks)
929 quit-hooks
930 nil)))
932 ;;;###autoload
934 &optional startup-hooks
935 quit-hooks)
936 "Run Emerge on two buffers, giving another buffer as the ancestor."
943 buffer-A
946 buffer-B
949 buffer-ancestor
955 emerge-file-ancestor
961 startup-hooks)
962 quit-hooks
963 nil)))
965 ;;; Functions to start Emerge from the command line
967 ;;;###autoload
974 file-a file-b nil
977 ;;;###autoload
980 ;; check for a -a flag, for filemerge compatibility
982 ;; arguments are "-a ancestor file-a file-b file-out"
989 ;; arguments are "file-a file-b ancestor file-out"
996 file-a file-b file-anc nil
1003 ;;; Functions to start Emerge via remote request
1005 ;;;###autoload
1009 file-a file-b nil
1011 file-out)
1014 ;;;###autoload
1018 file-a file-b file-anc nil
1020 file-out)
1028 ;;; Functions to start Emerge on RCS versions
1030 ;;;###autoload
1033 "Emerge two RCS revisions of a file."
1040 emerge-last-revision-B revision-B)
1042 file revision-A revision-B startup-hooks
1047 quit-hooks)
1048 quit-hooks)))
1050 ;;;###autoload
1052 revision-B ancestor
1053 &optional
1054 startup-hooks quit-hooks)
1055 "Emerge two RCS revisions of a file, with another revision as ancestor."
1063 emerge-last-revision-B revision-B
1064 emerge-last-revision-ancestor ancestor)
1066 file revision-A revision-B ancestor startup-hooks
1072 quit-hooks))
1073 quit-hooks)))
1076 startup-hooks quit-hooks _output-file)
1081 ;; Get the revisions into buffers
1083 buffer-A
1087 t)
1091 buffer-B
1095 t)
1098 ;; Do the merge
1100 buffer-B emerge-file-B
1104 startup-hooks)
1106 quit-hooks)
1107 nil)))
1110 ancestor
1111 &optional startup-hooks
1112 quit-hooks output-file)
1119 ;; Get the revisions into buffers
1121 buffer-A
1125 revision-A file)
1126 t)
1130 buffer-B
1134 t)
1138 buffer-ancestor
1142 t)
1145 ;; Do the merge
1147 buffer-A emerge-file-A buffer-B emerge-file-B
1148 buffer-ancestor emerge-ancestor
1153 startup-hooks)
1155 quit-hooks)
1156 output-file)))
1158 ;;; Function to start Emerge based on a line in a file
1161 "Run Emerge using files named in current text line.
1162 Looks in that line for whitespace-separated entries of these forms:
1163 a=file1
1164 b=file2
1165 ancestor=file3
1166 output=file4
1167 to specify the files to use in Emerge.
1169 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1170 is present:
1171 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1172 it is assumed that the file in question has been deleted, and it is
1173 not copied to the output file.
1174 Otherwise, the A or B file present is copied to the output file."
1178 ;; Stop if at end of buffer (even though we might be in a line, if
1179 ;; the line does not end with newline)
1182 ;; Go to the beginning of the line
1184 ;; Skip any initial whitespace
1187 ;; Process the entire line
1189 ;; Get the next entry
1191 ;; Break apart the tab (before =) and the filename (after =)
1195 ;; Move point after the entry
1197 ;; Store the filename in the right variable
1217 ;; If the match on the entry pattern failed
1219 ;; Make sure that file-A and file-B are present
1224 ;; Go to the beginning of the next line, so next execution will use
1225 ;; next line in buffer.
1227 ;; Execute the correct command
1229 ;; Merge of two files with ancestor
1233 file-ancestor file-out
1234 nil
1235 ;; When done, return to this buffer.
1240 ;; Merge of two files without ancestor
1244 nil
1245 ;; When done, return to this buffer.
1250 ;; There is an output file (or there would have been an error above),
1251 ;; but only one input file.
1252 ;; The file appears to have been deleted in one version; do nothing.
1255 ;; The file should be copied from the version that contains it
1261 ;;; Sample function for creating information for emerge-execute-line
1264 "Regexp describing files to be processed by `emerge-merge-directories'."
1268 ;;;###autoload
1276 ;; Check that we're not on a line
1279 ;; Turn null strings into nil to indicate directories not used.
1284 ;; Canonicalize the directory names
1301 ;; Set the mark to where we start
1303 ;; Find out what files are in the directories.
1311 emerge-merge-directories-filename-regexp)))
1316 ;; Remove duplicates from all-files.
1322 ;; Generate the control lines for the various files.
1343 ;;; Common setup routines
1345 ;; Set up the window configuration. If POS is given, set the points to
1346 ;; the beginnings of the buffers.
1348 ;; Make sure we are not in the minibuffer window when we try to delete
1349 ;; all other windows.
1367 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1375 ;; Set up the keymap in the merge buffer
1377 ;; Set up fixed keymaps if necessary
1380 ;; Save the old local map
1382 ;; Construct the edit keymap
1386 ;; Install the Emerge commands
1391 ;; Create the additional menu bar items.
1399 ;; Suppress write-file and save-buffer
1401 'emerge-query-write-file
1402 emerge-edit-keymap)
1404 'emerge-query-save-buffer
1405 emerge-edit-keymap)
1413 "Record certain properties of the buffers being merged.
1414 Must be called in the merge buffer. Remembers read-only, modified,
1415 auto-save, and saves them in buffer local variables. Sets the buffers
1416 read-only and turns off `auto-save-mode'.
1417 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1418 ;; force auto-save, because we will turn off auto-saving in buffers for the
1419 ;; duration
1421 ;; remember and alter buffer characteristics
1424 emerge-A-buffer
1428 emerge-merging-values))))
1431 emerge-B-buffer
1435 emerge-merging-values)))))
1438 "Restore characteristics saved by `emerge-remember-buffer-characteristics'."
1443 A-values))
1446 B-values))))
1448 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1449 ;; Return DESIRED-LINE.
1452 desired-line)
1455 B-buffer
1456 merge-buffer
1457 lineno-list)
1462 ;; Record current line number in each buffer
1463 ;; so we don't have to count from the beginning.
1470 a-begin-marker
1471 a-end-marker
1472 b-begin-marker
1473 b-end-marker
1474 merge-begin-marker
1475 merge-end-marker
1481 ;; place markers at the appropriate places in the buffers
1483 A-buffer
1489 B-buffer
1497 offset)
1498 merge-buffer))
1502 offset)
1503 merge-buffer))
1504 ;; record all the markers for this difference
1506 b-begin-marker b-end-marker
1507 merge-begin-marker merge-end-marker
1508 state)
1509 marker-list)))
1511 ;; convert the list of difference information into a vector for
1512 ;; fast access
1515 ;; If we have an ancestor, select all B variants that we prefer
1527 ;; Process the local-variables list at the end of the merged file, if
1528 ;; requested.
1536 ;;; Common exit routines
1539 ;; clear screen format
1541 ;; delete A, B, and ancestor buffers, if they haven't been changed
1549 ;; Write merge buffer to file
1553 ;;; Commands
1556 "Bring the highlighted region of all three merge buffers into view.
1557 This brings the buffers into view if they are in windows.
1558 With an argument, reestablish the default three-window display."
1560 ;; If there is an argument, rebuild the window structure
1563 emerge-merge-buffer))
1564 ;; Redisplay whatever buffers are showing, if there is a selected difference
1600 ;;; Window scrolling operations
1601 ;; These operations are designed to scroll all three windows the same amount,
1602 ;; so as to keep the text in them aligned.
1604 ;; Perform some operation on all three windows (if they are showing).
1605 ;; Catches all errors on the operation in the A and B windows, but not
1606 ;; in the merge window. Usually, errors come from scrolling off the
1607 ;; beginning or end of the buffer, and this gives a nice error message:
1608 ;; End of buffer is reported in the merge buffer, but if the scroll was
1609 ;; possible in the A or B windows, it is performed there before the error
1610 ;; is reported.
1633 "Scroll up all three merge buffers, if they are in windows.
1634 With argument N, scroll N lines; otherwise scroll by nearly
1635 the height of the merge window.
1636 `C-u -' alone as argument scrolls half the height of the merge window."
1639 'scroll-up
1640 ;; calculate argument to scroll-up
1641 ;; if there is an explicit argument
1643 ;; use it
1645 ;; if not, see if we can determine a default amount (the window height)
1648 ;; no window, use nil
1649 nil
1652 ;; the window was found
1654 ;; C-u as argument means half of default amount
1656 ;; no argument means default amount
1657 default-amount)))))))
1660 "Scroll down all three merge buffers, if they are in windows.
1661 With argument N, scroll N lines; otherwise scroll by nearly
1662 the height of the merge window.
1663 `C-u -' alone as argument scrolls half the height of the merge window."
1666 'scroll-down
1667 ;; calculate argument to scroll-down
1668 ;; if there is an explicit argument
1670 ;; use it
1672 ;; if not, see if we can determine a default amount (the window height)
1675 ;; no window, use nil
1676 nil
1679 ;; the window was found
1681 ;; C-u as argument means half of default amount
1683 ;; no argument means default amount
1684 default-amount)))))))
1687 "Scroll left all three merge buffers, if they are in windows.
1688 If an argument is given, that is how many columns are scrolled, else nearly
1689 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1690 width of the A and B windows."
1693 'scroll-left
1694 ;; calculate argument to scroll-left
1695 ;; if there is an explicit argument
1697 ;; use it
1699 ;; if not, see if we can determine a default amount
1700 ;; (half the window width)
1703 ;; no window, use nil
1704 nil
1707 ;; the window was found
1709 ;; C-u as argument means half of default amount
1711 ;; no argument means default amount
1712 default-amount)))))))
1715 "Scroll right all three merge buffers, if they are in windows.
1716 If an argument is given, that is how many columns are scrolled, else nearly
1717 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1718 width of the A and B windows."
1721 'scroll-right
1722 ;; calculate argument to scroll-right
1723 ;; if there is an explicit argument
1725 ;; use it
1727 ;; if not, see if we can determine a default amount
1728 ;; (half the window width)
1731 ;; no window, use nil
1732 nil
1735 ;; the window was found
1737 ;; C-u as argument means half of default amount
1739 ;; no argument means default amount
1740 default-amount)))))))
1743 "Reset horizontal scrolling in Emerge.
1744 This resets the horizontal scrolling of all three merge buffers
1745 to the left margin, if they are in windows."
1749 nil))
1751 ;; Attempt to show the region nicely.
1752 ;; If there are min-lines lines above and below the region, then don't do
1753 ;; anything.
1754 ;; If not, recenter the region to make it so.
1755 ;; If that isn't possible, remove context lines evenly from top and bottom
1756 ;; so the entire region shows.
1757 ;; If that isn't possible, show the top of the region.
1758 ;; BEG must be at the beginning of a line.
1760 ;; First test whether the entire region is visible with
1761 ;; emerge-min-visible-lines above and below it
1765 beg)
1770 ;; We failed that test, see if it fits at all
1771 ;; Meanwhile positioning it correctly in case it doesn't fit
1775 ;; Determine the number of lines that the region occupies
1781 ;; And position the beginning on the right line
1784 lines))
1789 "Advance to the next difference."
1803 "Go to the previous difference."
1817 "Go to the N-th difference."
1827 "Abort the Emerge session."
1832 "Finish the Emerge session and exit Emerge.
1833 Prefix argument means to abort rather than successfully finish.
1834 The difference depends on how the merge was started,
1835 but usually means to not write over one of the original files, or to signal
1836 to some process which invoked Emerge a failure code.
1838 Unselects the selected difference, if any, restores the read-only and modified
1839 flags of the merged file buffers, restores the local keymap of the merge
1840 buffer, and sets off various emerge flags. Using Emerge commands in this
1841 buffer after this will cause serious problems."
1846 "Do you really want to successfully finish this merge? "
1851 ;; Perform the quit operations.
1856 ;; null out the difference markers so they don't slow down future editing
1857 ;; operations
1865 emerge-difference-list)
1866 ;; allow them to be garbage collected
1868 ;; restore the local map
1870 ;; turn off all the emerge modes
1876 ;; restore mode line
1882 "Select the A variant of this difference.
1883 Refuses to function if this difference has been edited, i.e., if it
1884 is neither the A nor the B variant.
1885 A prefix argument forces the variant to be selected
1886 even if the difference has been edited."
1898 ;; Actually select the A variant
1901 emerge-merge-buffer
1910 "Select the B variant of this difference.
1911 Refuses to function if this difference has been edited, i.e., if it
1912 is neither the A nor the B variant.
1913 A prefix argument forces the variant to be selected
1914 even if the difference has been edited."
1926 ;; Actually select the B variant
1929 emerge-merge-buffer
1938 "Make the A variant the default from here down.
1939 This selects the A variant for all differences from here down in the buffer
1940 which are still defaulted, i.e., which the user has not selected and for
1941 which there is no preference."
1960 "Make the B variant the default from here down.
1961 This selects the B variant for all differences from here down in the buffer
1962 which are still defaulted, i.e., which the user has not selected and for
1963 which there is no preference."
1982 "Set fast mode, for Emerge.
1983 In this mode ordinary Emacs commands are disabled, and Emerge commands
1995 "Set edit mode, for Emerge.
1996 In this mode ordinary Emacs commands are available, and Emerge commands
2008 "Toggle Auto-Advance mode, for Emerge.
2009 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2010 advance to the next difference.
2011 With a positive argument, turn on Auto-Advance mode.
2012 With a negative argument, turn off Auto-Advance mode."
2018 "Auto-advance set"
2023 "Toggle Skip-Prefers mode, for Emerge.
2024 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2025 to automatically skip over differences for which there is a preference.
2026 With a positive argument, turn on Skip-Prefers mode.
2027 With a negative argument, turn off Skip-Prefers mode."
2033 "Skip-prefers set"
2038 "Put the A variant of this difference in the kill ring."
2045 ;; so further kills don't append
2046 this-command)
2051 "Put the B variant of this difference in the kill ring."
2058 ;; so further kills don't append
2059 this-command)
2064 "Insert the A variant of this difference at the point.
2065 Leaves point after text, mark before.
2066 With prefix argument, puts point before, mark after."
2082 "Insert the B variant of this difference at the point.
2083 Leaves point after text, mark before.
2084 With prefix argument, puts point before, mark after."
2100 "Leaves the point before this difference and the mark after it.
2101 With prefix argument, puts mark before, point after."
2116 "Show the names of the buffers or files being operated on by Emerge.
2117 Use C-u l to reset the windows afterward."
2159 "Join the selected difference with the following one.
2160 With a prefix argument, join with the preceding one."
2163 ;; adjust n to be first difference to join
2166 ;; n and n+1 are the differences to join
2167 ;; check that they are both differences
2170 ;; remove the flags
2172 ;; decrement total number of differences
2174 ;; build new differences vector
2194 ps)
2201 ;; set the current difference correctly
2203 ;; fix the mode line
2205 ;; reinsert the flags
2210 "Split the current difference where the points are in the three windows."
2213 ;; check that this is a valid difference
2215 ;; get the point values and old difference
2222 ;; check location of the points, give error if they aren't in the
2223 ;; differences
2233 ;; remove the flags
2235 ;; increment total number of differences
2237 ;; build new differences vector
2249 A-point
2251 B-point
2253 merge-point
2265 ;; set the current difference correctly
2267 ;; fix the mode line
2269 ;; reinsert the flags
2274 "Trim lines off top and bottom of difference that are the same.
2275 If lines are the same in both the A and the B versions, strip them off.
2276 \(This can happen when the A and B versions have common lines that the
2277 ancestor version does not share.)"
2279 ;; make sure we are in a real difference
2281 ;; remove the flags
2290 size success sa sb sm)
2291 ;; move down the tops of the difference regions as much as possible
2292 ;; Try advancing comparing 1000 chars at a time.
2293 ;; When that fails, go 500 chars at a time, and so on.
2313 ;; move up the bottoms of the difference regions as much as possible
2314 ;; Try advancing comparing 1000 chars at a time.
2315 ;; When that fails, go 500 chars at a time, and so on.
2324 bottom-a)))
2327 bottom-b)))
2335 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2336 ;; of the difference regions. Move them to the beginning of lines, as
2337 ;; appropriate.
2358 ;; put the flags back in, recenter the display
2362 ;; FIXME the manual advertised this as working in the A or B buffers,
2363 ;; but it does not, because all the buffer locals are nil there.
2364 ;; It would work to call it from the merge buffer and specify that one
2365 ;; wants to use the value of point in the A or B buffer.
2366 ;; But with the prefix argument already in use, there is no easy way
2367 ;; to have it ask for a buffer.
2369 "Find the difference containing the current position of the point.
2370 If there is no containing difference and the prefix argument is positive,
2371 it finds the nearest following difference. A negative prefix argument finds
2372 the nearest previous difference."
2381 "Find the difference containing point, in the merge buffer.
2382 If there is no containing difference and the prefix argument is positive,
2383 it finds the nearest following difference. A negative prefix argument finds
2384 the nearest previous difference."
2386 ;; search for the point in the merge buffer, using the markers
2387 ;; for the beginning and end of the differences in the merge buffer
2391 "Find the difference containing point, in the A buffer.
2392 This command must be executed in the merge buffer.
2393 If there is no containing difference and the prefix argument is positive,
2394 it finds the nearest following difference. A negative prefix argument finds
2395 the nearest previous difference."
2397 ;; search for the point in the A buffer, using the markers
2398 ;; for the beginning and end of the differences in the A buffer
2404 "Find the difference containing point, in the B buffer.
2405 This command must be executed in the merge buffer.
2406 If there is no containing difference and the prefix argument is positive,
2407 it finds the nearest following difference. A negative prefix argument finds
2408 the nearest previous difference."
2410 ;; search for the point in the B buffer, using the markers
2411 ;; for the beginning and end of the differences in the B buffer
2418 ;; find first difference containing or after the current position
2426 emerge-number-of-differences))
2428 ;; whether the found difference contains the current position
2431 begin))
2432 location)))
2434 ;; numeric value of prefix argument
2438 ;; if the point is in a difference, select it
2440 ;; if the arg is nil and the point is not in a difference, error
2442 ;; if the arg is positive, select the following difference
2445 index
2447 ;; if the arg is negative, select the preceding difference
2454 "Display the current line numbers.
2455 This function displays the line numbers of the points in the A, B, and
2456 merge buffers."
2463 emerge-current-difference)))
2470 merge-line A-line B-line)))
2475 ;; FIXME point-min rather than 1? widen?
2483 temp))
2486 "Set `emerge-combine-versions-template' to STRING.
2487 This value controls how `emerge-combine-versions' combines the two versions.
2488 With prefix argument, `emerge-combine-versions-template' is made local to this
2489 merge buffer. Localization is permanent for any particular merge buffer."
2496 "emerge-set-combine-versions-template set locally"
2500 "Copy region into `emerge-combine-versions-template'.
2501 This controls how `emerge-combine-versions' will combine the two versions.
2502 With prefix argument, `emerge-combine-versions-template' is made local to this
2503 merge buffer. Localization is permanent for any particular merge buffer."
2510 "emerge-set-combine-versions-template set locally."
2514 "Combine versions using the template in `emerge-combine-versions-template'.
2515 Refuses to function if this difference has been edited, i.e., if it is
2516 neither the A nor the B variant.
2517 An argument forces the variant to be selected even if the difference has
2518 been edited."
2523 "Combine the two versions using the template in register REG.
2524 See documentation of the variable `emerge-combine-versions-template'
2525 for how the template is interpreted.
2526 Refuses to function if this difference has been edited, i.e., if it is
2527 neither the A nor the B variant.
2528 An argument forces the variant to be selected even if the difference has
2529 been edited.
2531 Interactively, reads the register using `register-read-with-preview'."
2534 current-prefix-arg))
2544 A-begin A-end B-begin B-end)
2552 A-begin A-end B-begin B-end)
2554 emerge-merge-buffer
2582 "Set the major mode in a merge buffer.
2583 Overrides any change that the mode might make to the mode line or local
2584 keymap. Leaves merge in fast mode."
2599 ;;; Support routines
2601 ;; Select a difference by placing the visual flags around the appropriate
2602 ;; group of lines in the A, B, and merge buffers
2612 after-index)
2615 buffer
2621 ;; insert the flag before the difference
2623 before-index))
2624 here)
2626 ;; insert the flag itself
2629 ;; Put the marker(s) referring to this position 1 character before the
2630 ;; end of the flag, so it won't be damaged by the user.
2631 ;; This gets a bit tricky, as there could be a number of markers
2632 ;; that have to be moved.
2646 ;; insert the flag after the difference
2648 after-index))
2651 ;; insert the flag itself
2653 ;; Put the marker(s) referring to this position 1 character after the
2654 ;; beginning of the flag, so it won't be damaged by the user.
2655 ;; This gets a bit tricky, as there could be a number of markers
2656 ;; that have to be moved.
2671 ;; Unselect a difference by removing the visual flags in the buffers.
2684 buffer
2686 ;; remove the flags, if they're there
2690 ;; the flag isn't there
2696 ;; the flag isn't there
2700 ;; Select a difference, removing any flags that exist now.
2720 ;; Perform tests to see whether user should be allowed to select a version
2721 ;; of this difference:
2722 ;; a valid difference has been selected; and
2723 ;; the difference text in the merge buffer is:
2724 ;; the A version (execute a-version), or
2725 ;; the B version (execute b-version), or
2726 ;; empty (execute neither-version), or
2727 ;; argument FORCE is true (execute neither-version)
2728 ;; Otherwise, signal an error.
2741 emerge-merge-buffer merge-begin
2742 merge-end)
2745 emerge-merge-buffer merge-begin
2746 merge-end)
2752 ;; Read a file name, handling all of the various defaulting rules.
2755 A-file must-match)
2756 ;; `prompt' should not have trailing ": ", so that it can be modified
2757 ;; according to context.
2758 ;; If alternative-default-dir is non-nil, it should be used as the default
2759 ;; directory instead if default-directory, if emerge-default-last-directories
2760 ;; is set.
2761 ;; If default-file is set, it should be used as the default value.
2762 ;; If A-file is set, and its directory is different from
2763 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2764 ;; the default file should be the last part of A-file in the default
2765 ;; directory. (Overriding default-file.)
2767 ;; If this is not the A-file argument (shown by non-nil A-file), and
2768 ;; if emerge-default-last-directories is set, and
2769 ;; the default directory exists but is not the same as the directory of the
2770 ;; A-file,
2771 ;; then make the default file have the same name as the A-file, but in
2772 ;; the default directory.
2774 A-file
2775 alternative-default-dir
2780 alternative-default-dir
2784 ;; If there is a default file, use it.
2787 ;; If emerge-default-last-directories is set, use the
2788 ;; directory from the same argument of the last call of
2789 ;; Emerge as the default for this argument.
2791 alternative-default-dir)
2795 ;; If emerge-default-last-directories is set, use the
2796 ;; directory from the same argument of the last call of
2797 ;; Emerge as the default for this argument.
2799 alternative-default-dir)
2802 ;; Revise the mode line to display which difference we have selected
2808 emerge-number-of-differences
2810 (< emerge-current-difference
2811 emerge-number-of-differences))
2813 emerge-current-difference)
2823 ;; compare two regions in two buffers for containing the same text
2825 ;; first check that the two regions are the same length
2827 nil
2830 ;; bite off and compare no more than 1000 characters at a time
2833 buffer-x
2837 buffer-y
2844 t)))
2846 ;; Construct a unique buffer name.
2847 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2848 ;; prefix<3>suffix, etc.
2857 ;; Verify that we have a difference selected.
2863 ;;; Functions for saving and restoring a batch of variables
2865 ;; These functions save (get the values of) and restore (set the values of)
2866 ;; a list of variables. The argument is a list of symbols (the names of
2867 ;; the variables). A list element can also be a list of two functions,
2868 ;; the first of which (when called with no arguments) gets the value, and
2869 ;; the second (when called with a value as an argument) sets the value.
2870 ;; A "function" is anything that funcall can handle as an argument.
2876 vars))
2888 ;; When the pointless option emerge-temp-file-prefix goes,
2889 ;; make this function obsolete too, and just use make-temp-file.
2891 "Make a private temporary file based on `emerge-temp-file-prefix'."
2894 ;;; Functions that query the user before he can write out the current buffer.
2897 "Ask the user whether to write out an incomplete merge.
2898 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2899 for details of the querying process."
2904 "Ask the user whether to save an incomplete merge.
2905 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2906 for details of the querying process."
2911 "Ask the user whether to save or write out the incomplete merge.
2912 If answer is yes, call COMMAND interactively. During the call, the flags
2913 around the current difference are removed."
2915 ;; He really wants to do it -- unselect the difference for the duration
2920 ;; call-interactively takes the value of current-prefix-arg as the
2921 ;; prefix argument value to be passed to the command. Thus, we have
2922 ;; to do nothing special to make sure the prefix argument is
2923 ;; transmitted to the command.
2930 ;; He's being smart and not doing it
2933 ;; Make sure the current buffer (for a file) has the same contents as the
2934 ;; file on disk, and attempt to remedy the situation if not.
2935 ;; Signal an error if we can't make them the same, or the user doesn't want
2936 ;; to do what is necessary to make them the same.
2938 ;; First check if the file has been modified since the buffer visited it.
2941 ;; If buffer is not obsolete and is modified, offer to save
2945 ;; If buffer is not obsolete and is not modified, do nothing
2946 nil)
2948 ;; If buffer is obsolete and is modified, give error
2950 ;; If buffer is obsolete and is not modified, offer to revert
2954 \f
2955 ;; Utilities that might have value outside of Emerge.
2957 ;; Set up the mode in the current buffer to duplicate the mode in another
2958 ;; buffer.
2960 ;; Set the major mode
2963 ;; Define a key, even if a prefix of it is defined
2965 "Like `define-key', but forcibly creates prefix characters as needed.
2966 If some prefix of KEY has a non-prefix definition, it is redefined."
2967 ;; Find out if a prefix of key is defined
2969 ;; If so, undefine it
2972 ;; Now define the key
2975 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2976 ;;;;; as the major mode
2977 ;;(defun describe-mode (&optional minor)
2978 ;; "Display documentation of current major mode.
2979 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2980 ;;display documentation of active minor modes as well.
2981 ;;For this to work correctly for a minor mode, the mode's indicator variable
2982 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2983 ;;describes the minor mode."
2984 ;; (interactive)
2985 ;; (with-output-to-temp-buffer "*Help*"
2986 ;; (princ mode-name)
2987 ;; (princ " Mode:\n")
2988 ;; (princ (documentation major-mode))
2989 ;; (let ((minor-modes minor-mode-alist)
2990 ;; (locals (buffer-local-variables)))
2991 ;; (while minor-modes
2992 ;; (let* ((minor-mode (car (car minor-modes)))
2993 ;; (indicator (car (cdr (car minor-modes))))
2994 ;; (local-binding (assq minor-mode locals)))
2995 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2996 ;; ;; bound locally in this buffer, non-nil, and has a function
2997 ;; ;; definition.
2998 ;; (if (and local-binding
2999 ;; (cdr local-binding)
3000 ;; (fboundp minor-mode))
3001 ;; (progn
3002 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3003 ;; minor-mode indicator))
3004 ;; (princ (documentation minor-mode)))))
3005 ;; (setq minor-modes (cdr minor-modes))))
3006 ;; (with-current-buffer standard-output
3007 ;; (help-mode))
3008 ;; (help-print-return-message)))
3010 ;; This goes with the redefinition of describe-mode.
3011 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3012 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3014 ;; substitute-key-definition should work now.
3015 ;;;; Function to shadow a definition in a keymap with definitions in another.
3016 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3017 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3018 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3019 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3020 ;;including those whose definition is OLDDEF."
3021 ;; ;; loop through all keymaps accessible from keymap
3022 ;; (let ((maps (accessible-keymaps keymap)))
3023 ;; (while maps
3024 ;; (let ((prefix (car (car maps)))
3025 ;; (map (cdr (car maps))))
3026 ;; ;; examine a keymap
3027 ;; (if (arrayp map)
3028 ;; ;; array keymap
3029 ;; (let ((len (length map))
3030 ;; (i 0))
3031 ;; (while (< i len)
3032 ;; (if (eq (aref map i) olddef)
3033 ;; ;; set the shadowing definition
3034 ;; (let ((key (concat prefix (char-to-string i))))
3035 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3036 ;; (setq i (1+ i))))
3037 ;; ;; sparse keymap
3038 ;; (while map
3039 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3040 ;; ;; set the shadowing definition
3041 ;; (let ((key
3042 ;; (concat prefix (char-to-string (car (car map))))))
3043 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3044 ;; (setq map (cdr map)))))
3045 ;; (setq maps (cdr maps)))))
3047 ;; Define a key if it (or a prefix) is not already defined in the map.
3049 ;; look up the present definition of the key
3052 ;; if it is "too long", look up the valid prefix
3054 ;; if the prefix isn't defined, define it
3056 ;; if there is no present definition, define it
3060 ;; Ordinary substitute-key-definition should do this now.
3061 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3062 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3063 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3064 ;;\(`copy-keymap' will suffice.)"
3065 ;; ;; Loop through all keymaps accessible from keymap
3066 ;; (let ((maps (accessible-keymaps keymap)))
3067 ;; (while maps
3068 ;; ;; Substitute in this keymap
3069 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3070 ;; (setq maps (cdr maps)))))
3072 ;; Show the name of the file in the buffer.
3074 "Displays the name of the file loaded into the current buffer.
3075 If the name won't fit on one line, the minibuffer is expanded to hold it,
3076 and the command waits for a keystroke from the user. If the keystroke is
3077 SPC, it is ignored; if it is anything else, it is processed as a command."
3097 ;; Improved auto-save file names.
3098 ;; This function fixes many problems with the standard auto-save file names:
3099 ;; Auto-save files for non-file buffers get put in the default directory
3100 ;; for the buffer, whether that makes sense or not.
3101 ;; Auto-save files for file buffers get put in the directory of the file,
3102 ;; regardless of whether we can write into it or not.
3103 ;; Auto-save files for non-file buffers don't use the process id, so if a
3104 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3105 ;; each other.
3106 ;; To use this function, do:
3107 ;; (fset 'make-auto-save-file-name
3108 ;; (symbol-function 'emerge-make-auto-save-file-name))
3110 "Return file name to use for auto-saves of current buffer.
3111 Does not consider `auto-save-visited-file-name';
3112 that is checked before calling this function.
3113 You can redefine this for customization.
3114 See also `auto-save-file-name-p'."
3116 ;; if buffer has a file, try the format <file directory>/#<file name>#
3118 "#"
3122 ;; the file is writable, so use it
3123 f
3124 ;; the file isn't writable, so use the format
3125 ;; ~/#&<file name>&<hash of directory>#
3127 "/#&"
3129 "&"
3133 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3135 "/#%"
3136 ;; quote / into \! and \ into \\
3138 "%"
3142 ;; Hash a string into five characters more-or-less suitable for use in a file
3143 ;; name. (Allowed characters are ! through ~, except /.)
3159 ;; Quote any /s in a string by replacing them with \!.
3160 ;; Also, replace any \s by \\, to make it one-to-one.
3172 s)
3174 ;; Metacharacters that have to be protected from the shell when executing
3175 ;; a diff/diff3 command.
3177 "Obsolete, emerge now uses `shell-quote-argument'."
3184 ;;; emerge.el ends here