| blob | 8794ab45e55f8a7eb925e03e92f86857715a5359 |
1 ;;; emerge.el --- merge diffs under Emacs control
3 ;;; The author has placed this file in the public domain.
5 ;; Author: Dale R. Worley <worley@world.std.com>
6 ;; Version: 5fsf
7 ;; Keywords: unix, tools
9 ;; This software was created by Dale R. Worley and is
10 ;; distributed free of charge. It is placed in the public domain and
11 ;; permission is granted to anyone to use, duplicate, modify and redistribute
12 ;; it provided that this notice is attached.
14 ;; Dale R. Worley provides absolutely NO WARRANTY OF ANY KIND
15 ;; with respect to this software. The entire risk as to the quality and
16 ;; performance of this software is with the user. IN NO EVENT WILL DALE
17 ;; R. WORLEY BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE
18 ;; USE OF THIS SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM
19 ;; LOST DATA OR LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL
20 ;; DAMAGES.
22 ;;; Code:
24 ;;;###autoload
26 ;;;###autoload
29 ;;;###autoload
32 ;;;###autoload
35 ;;;###autoload
38 ;;;###autoload
41 ;;;###autoload
44 ;;;###autoload
47 ;;;###autoload
51 ;;; Macros
54 "Macro to switch to BUFFER, evaluate FORMS, returns to original buffer.
55 Differs from `save-excursion' in that it doesn't save the point and mark."
64 "Defines SYMBOL as an advertised variable.
65 Performs a defvar, then executes `make-variable-buffer-local' on
66 the variable. Also sets the `preserved' property, so that
67 `kill-all-local-variables' (called by major-mode setting commands)
68 won't destroy Emerge control variables."
74 ;; Add entries to minor-mode-alist so that emerge modes show correctly
83 minor-mode-alist)))
85 ;; We need to define this function so describe-mode can describe Emerge mode.
87 "Emerge mode is used by the Emerge file-merging package.
88 It is entered only through one of the functions:
89 `emerge-files'
90 `emerge-files-with-ancestor'
91 `emerge-buffers'
92 `emerge-buffers-with-ancestor'
93 `emerge-files-command'
94 `emerge-files-with-ancestor-command'
95 `emerge-files-remote'
96 `emerge-files-with-ancestor-remote'
98 Commands:
107 "Return string describing the version of Emerge.
108 When called interactively, displays the version."
112 emerge-version))
114 ;;; Emerge configuration variables
117 "Merge diffs under Emacs control."
120 ;; Commands that produce difference files
121 ;; All that can be configured is the name of the programs to execute
122 ;; (emerge-diff-program and emerge-diff3-program) and the options
123 ;; to be provided (emerge-diff-options). The order in which the file names
124 ;; are given is fixed.
125 ;; The file names are always expanded (see expand-file-name) before being
126 ;; passed to diff, thus they need not be invoked under a shell that
127 ;; understands `~'.
128 ;; The code which processes the diff/diff3 output depends on all the
129 ;; finicky details of their output, including the somewhat strange
130 ;; way they number lines of a file.
132 "*Name of the program which compares two files."
136 "*Name of the program which compares three files.
137 Its arguments are the ancestor file and the two variant files."
141 "*Options to pass to `emerge-diff-program' and `emerge-diff3-program'."
147 "*Pattern to match lines produced by diff that describe differences.
148 This is as opposed to lines from the source files."
153 "*Regexp that matches normal output lines from `emerge-diff-program'.
154 Lines that do not match are assumed to be error messages."
159 "*Regexp that matches normal output lines from `emerge-diff3-program'.
160 Lines that do not match are assumed to be error messages."
165 "*Name of the program that checks in RCS revisions."
169 "*Name of the program that checks out RCS revisions."
174 "*Non-nil if Emerge should process local-variables lists in merge buffers.
175 \(You can explicitly request processing the local-variables
176 by executing `(hack-local-variables)'.)"
180 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
181 It concludes that an input version has been deleted when an ancestor entry
182 is present, only one A or B entry is present, and an output entry is present.
183 If nil: In such circumstances, the A or B file that is present will be
184 copied to the designated output file."
189 "*Flag placed above the highlighted block of code. Must end with newline.
190 Must be set before Emerge is loaded, or emerge-new-flags must be run
191 after setting."
195 "*Flag placed below the highlighted block of code. Must end with newline.
196 Must be set before Emerge is loaded, or emerge-new-flags must be run
197 after setting."
201 ;; Hook variables
204 "*Hook to run in the merge buffer after the merge has been set up."
208 "*Hook to run after a difference has been selected.
209 The variable `n' holds the (internal) number of the difference."
213 "*Hook to run after a difference has been unselected.
214 The variable `n' holds the (internal) number of the difference."
218 ;; Variables to control the default directories of the arguments to
219 ;; Emerge commands.
222 "*If nil, default dir for filenames in emerge is `default-directory'.
223 If non-nil, filenames complete in the directory of the last argument of the
224 same type to an `emerge-files...' command."
257 ;; The flags used to mark differences in the buffers.
259 ;; These function definitions need to be up here, because they are used
260 ;; during loading.
262 "Function to be called after `emerge-{before,after}-flag'.
263 This is called after these functions are changed to compute values that
264 depend on the flags."
275 "Return the number of matches in STRING for REGEXP."
281 count))
283 ;; Calculate dependent variables
287 "*Number of lines that we want to show above and below the flags when we are
288 displaying a difference."
296 d)
298 env
303 "*Prefix to put on Emerge temporary file names.
304 Do not start with `~/' or `~user-name/'."
309 "*Mode for Emerge temporary files."
315 "*Template for `emerge-combine-versions' to combine the two versions.
316 The template is inserted as a string, with the following interpolations:
317 %a the A version of the difference
318 %b the B version of the difference
319 %% the character `%'
320 Don't forget to end the template with a newline.
321 Note that this variable can be made local to a particular merge buffer by
322 giving a prefix argument to `emerge-set-combine-versions-template'."
326 ;; Build keymaps
329 "Keymap of Emerge commands.
330 Directly available in `fast' mode;
334 "Local keymap used in Emerge `fast' mode.
347 "*Command prefix for Emerge commands in `edit' mode.
348 Must be set before Emerge is loaded."
352 ;; This function sets up the fixed keymaps. It is executed when the first
353 ;; Emerge is done to allow the user maximum time to set up the global keymap.
355 ;; Set up the basic keymap
358 ; - to negative-argument
399 ;; Allow emerge-basic-keymap to be referenced indirectly
401 ;; Set up the fast mode keymap
403 ;; Allow prefixed commands to work in fast mode
405 ;; Allow emerge-fast-keymap to be referenced indirectly
407 ;; Suppress write-file and save-buffer
489 ;; Variables which control each merge. They are local to the merge buffer.
491 ;; Mode variables
505 "The buffer in which the ancestor variant is stored,
510 buffer-read-only
511 buffer-auto-save-file-name)
512 "Variables and properties of a buffer which are saved, modified and restored
523 "Vector of differences between the variants, and markers in the buffers to
524 show where they are. Each difference is represented by a vector of seven
525 elements. The first two are markers to the beginning and end of the difference
526 section in the A buffer, the second two are markers for the B buffer, the third
528 that difference in the merge buffer.
529 A section of a buffer is described by two markers, one to the beginning of
530 the first line of the section, and one to the beginning of the first line
531 after the section. (If the section is empty, both markers point to the same
532 point.) If the section is part of the selected difference, then the markers
533 are moved into the flags, so the user can edit the section without disturbing
534 the markers.
536 A the merge buffer currently contains the A variant
537 B the merge buffer currently contains the B variant
538 default-A the merge buffer contains the A variant by default,
539 but this difference hasn't been selected yet, so
540 change-default commands can alter it
541 default-B the merge buffer contains the B variant by default,
542 but this difference hasn't been selected yet, so
543 change-default commands can alter it
544 prefer-A in a three-file merge, the A variant is the preferred
545 choice
546 prefer-B in a three-file merge, the B variant is the preferred
553 "The local keymap for the merge buffer, with the emerge commands defined in
554 it. Used to save the local keymap during fast mode, when the local keymap is
559 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
562 "*If non-nil, differences for which there is a preference are automatically
565 "Hooks to run in the merge buffer after the merge has been finished.
566 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
567 command.
572 ;;; Setup functions for two-file mode.
575 output-file)
582 ;; Record the directories of the files
587 ;; Make sure the entire files are seen, and they reflect what is on disk
589 buffer-A
594 startup-hooks
596 startup-hooks))
597 ;; Verify that the file matches the buffer
600 buffer-B
605 startup-hooks
607 startup-hooks))
608 ;; Verify that the file matches the buffer
611 output-file)))
613 ;; Start up Emerge on two files
615 output-file)
620 ;; create the merge buffer from buffer A, so it inherits buffer A's
621 ;; default directory, etc.
623 buffer-A
626 merge-buffer
652 ;; Generate the Emerge difference list between two files
656 emerge-diff-buffer
660 emerge-diff-program emerge-diff-options
663 t))
666 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
672 diff-buffer
681 a-begin)))
689 b-begin))))
690 ;; fix the beginning and end numbers, because diff is somewhat
691 ;; strange about how it numbers lines
702 ;; (string-equal diff-type "c")
707 b-begin b-end
709 list)))))
712 ;; Set up buffer of diff/diff3 error messages.
716 emerge-diff-error-buffer
721 ;;; Top-level and setup functions for three-file mode.
724 &optional startup-hooks quit-hooks
725 output-file)
735 ;; Record the directories of the files
741 ;; Make sure the entire files are seen, and they reflect what is on disk
743 buffer-A
748 startup-hooks
750 startup-hooks))
751 ;; Verify that the file matches the buffer
754 buffer-B
759 startup-hooks
761 startup-hooks))
762 ;; Verify that the file matches the buffer
765 buffer-ancestor
770 startup-hooks
772 startup-hooks))
773 ;; Verify that the file matches the buffer
776 buffer-ancestor file-ancestor
777 startup-hooks quit-hooks output-file)))
779 ;; Start up Emerge on two files with an ancestor
781 buffer-ancestor file-ancestor
782 &optional startup-hooks quit-hooks
783 output-file)
789 ;; create the merge buffer from buffer A, so it inherits buffer A's
790 ;; default directory, etc.
792 buffer-A
795 merge-buffer
823 ;; Generate the Emerge difference list between two files with an ancestor
827 emerge-diff-buffer
831 emerge-diff3-program emerge-diff-options
835 t))
838 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
844 diff-buffer
846 ;; leave point after matched line
849 ;; if the A and B files are the same, ignore the difference
863 list))))))
867 ;; This save-excursion allows emerge-get-diff3-group to be called for the
868 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
869 ;; appear in any order. The reason this is necessary is that Gnu diff3
870 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
875 ;; treatment depends on whether it is an "a" group or a "c" group
877 ;; it is a "c" group
879 ;; it has two numbers
884 ;; it has one number
888 ;; it is an "a" group
893 ;;; Functions to start Emerge on files
895 ;;;###autoload
897 quit-hooks)
898 "Run Emerge on two files."
903 nil nil t))
907 f f nil)))))
911 file-A file-B startup-hooks
912 quit-hooks
913 file-out))
915 ;;;###autoload
918 "Run Emerge on two files, giving another file as the ancestor."
923 nil nil t))
926 nil f t)
929 f f nil)))))
933 file-A file-B file-ancestor startup-hooks
934 quit-hooks
935 file-out))
937 ;; Write the merge buffer out in place of the file the A buffer is visiting.
939 ;; if merge was successful was given, save to disk
943 ;;; Functions to start Emerge on buffers
945 ;;;###autoload
947 "Run Emerge on two buffers."
952 buffer-A
955 buffer-B
962 startup-hooks)
963 quit-hooks
964 nil)))
966 ;;;###autoload
968 &optional startup-hooks
969 quit-hooks)
970 "Run Emerge on two buffers, giving another buffer as the ancestor."
977 buffer-A
980 buffer-B
983 buffer-ancestor
989 emerge-file-ancestor
995 startup-hooks)
996 quit-hooks
997 nil)))
999 ;;; Functions to start Emerge from the command line
1001 ;;;###autoload
1008 file-a file-b nil
1011 ;;;###autoload
1014 ;; check for a -a flag, for filemerge compatibility
1016 ;; arguments are "-a ancestor file-a file-b file-out"
1023 ;; arguments are "file-a file-b ancestor file-out"
1030 file-a file-b file-anc nil
1037 ;;; Functions to start Emerge via remote request
1039 ;;;###autoload
1043 file-a file-b nil
1045 file-out)
1048 ;;;###autoload
1052 file-a file-b file-anc nil
1054 file-out)
1062 ;;; Functions to start Emerge on RCS versions
1064 ;;;###autoload
1067 "Emerge two RCS revisions of a file."
1074 emerge-last-revision-B revision-B)
1076 file revision-A revision-B startup-hooks
1081 quit-hooks)
1082 quit-hooks)))
1084 ;;;###autoload
1086 revision-B ancestor
1087 &optional
1088 startup-hooks quit-hooks)
1089 "Emerge two RCS revisions of a file, with another revision as ancestor."
1097 emerge-last-revision-B revision-B
1098 emerge-last-revision-ancestor ancestor)
1100 file revision-A revision-B ancestor startup-hooks
1106 quit-hooks))
1107 quit-hooks)))
1110 startup-hooks quit-hooks output-file)
1115 ;; Get the revisions into buffers
1117 buffer-A
1121 t)
1125 buffer-B
1129 t)
1132 ;; Do the merge
1134 buffer-B emerge-file-B
1138 startup-hooks)
1140 quit-hooks)
1141 nil)))
1144 ancestor
1145 &optional startup-hooks
1146 quit-hooks output-file)
1153 ;; Get the revisions into buffers
1155 buffer-A
1159 revision-A file)
1160 t)
1164 buffer-B
1168 t)
1172 buffer-ancestor
1176 t)
1179 ;; Do the merge
1181 buffer-A emerge-file-A buffer-B emerge-file-B
1182 buffer-ancestor emerge-ancestor
1187 startup-hooks)
1189 quit-hooks)
1190 output-file)))
1192 ;;; Function to start Emerge based on a line in a file
1195 "Run Emerge using files named in current text line.
1196 Looks in that line for whitespace-separated entries of these forms:
1197 a=file1
1198 b=file2
1199 ancestor=file3
1200 output=file4
1201 to specify the files to use in Emerge.
1203 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1204 is present:
1205 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1206 it is assumed that the file in question has been deleted, and it is
1207 not copied to the output file.
1208 Otherwise, the A or B file present is copied to the output file."
1212 ;; Stop if at end of buffer (even though we might be in a line, if
1213 ;; the line does not end with newline)
1216 ;; Go to the beginning of the line
1218 ;; Skip any initial whitespace
1221 ;; Process the entire line
1223 ;; Get the next entry
1225 ;; Break apart the tab (before =) and the filename (after =)
1229 ;; Move point after the entry
1231 ;; Store the filename in the right variable
1251 ;; If the match on the entry pattern failed
1253 ;; Make sure that file-A and file-B are present
1258 ;; Go to the beginning of the next line, so next execution will use
1259 ;; next line in buffer.
1261 ;; Execute the correct command
1263 ;; Merge of two files with ancestor
1267 file-ancestor file-out
1268 nil
1269 ;; When done, return to this buffer.
1274 ;; Merge of two files without ancestor
1278 nil
1279 ;; When done, return to this buffer.
1284 ;; There is an output file (or there would have been an error above),
1285 ;; but only one input file.
1286 ;; The file appears to have been deleted in one version; do nothing.
1289 ;; The file should be copied from the version that contains it
1295 ;;; Sample function for creating information for emerge-execute-line
1298 "Regexp describing files to be processed by `emerge-merge-directories'."
1302 ;;;###autoload
1310 ;; Check that we're not on a line
1313 ;; Turn null strings into nil to indicate directories not used.
1318 ;; Canonicalize the directory names
1335 ;; Set the mark to where we start
1337 ;; Find out what files are in the directories.
1345 emerge-merge-directories-filename-regexp)))
1350 ;; Remove duplicates from all-files.
1356 ;; Generate the control lines for the various files.
1377 ;;; Common setup routines
1379 ;; Set up the window configuration. If POS is given, set the points to
1380 ;; the beginnings of the buffers.
1382 ;; Make sure we are not in the minibuffer window when we try to delete
1383 ;; all other windows.
1401 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1409 ;; Set up the keymap in the merge buffer
1411 ;; Set up fixed keymaps if necessary
1414 ;; Save the old local map
1416 ;; Construct the edit keymap
1420 ;; Install the Emerge commands
1425 ;; Create the additional menu bar items.
1433 ;; Suppress write-file and save-buffer
1435 'emerge-query-write-file
1436 emerge-edit-keymap)
1438 'emerge-query-save-buffer
1439 emerge-edit-keymap)
1449 "Record certain properties of the buffers being merged.
1450 Must be called in the merge buffer. Remembers read-only, modified,
1451 auto-save, and saves them in buffer local variables. Sets the buffers
1452 read-only and turns off `auto-save-mode'.
1453 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1454 ;; force auto-save, because we will turn off auto-saving in buffers for the
1455 ;; duration
1457 ;; remember and alter buffer characteristics
1460 emerge-A-buffer
1464 emerge-merging-values))))
1467 emerge-B-buffer
1471 emerge-merging-values)))))
1474 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1479 A-values))
1482 B-values))))
1484 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1485 ;; Return DESIRED-LINE.
1488 desired-line)
1491 B-buffer
1492 merge-buffer
1493 lineno-list)
1498 ;; Record current line number in each buffer
1499 ;; so we don't have to count from the beginning.
1506 a-begin-marker
1507 a-end-marker
1508 b-begin-marker
1509 b-end-marker
1510 merge-begin-marker
1511 merge-end-marker
1517 ;; place markers at the appropriate places in the buffers
1519 A-buffer
1525 B-buffer
1533 offset)
1534 merge-buffer))
1538 offset)
1539 merge-buffer))
1540 ;; record all the markers for this difference
1542 b-begin-marker b-end-marker
1543 merge-begin-marker merge-end-marker
1544 state)
1545 marker-list)))
1547 ;; convert the list of difference information into a vector for
1548 ;; fast access
1551 ;; If we have an ancestor, select all B variants that we prefer
1563 ;; Process the local-variables list at the end of the merged file, if
1564 ;; requested.
1572 ;;; Common exit routines
1575 ;; clear screen format
1577 ;; delete A, B, and ancestor buffers, if they haven't been changed
1585 ;; Write merge buffer to file
1589 ;;; Commands
1592 "Bring the highlighted region of all three merge buffers into view.
1593 This brings the buffers into view if they are in windows.
1594 With an argument, reestablish the default three-window display."
1596 ;; If there is an argument, rebuild the window structure
1599 emerge-merge-buffer))
1600 ;; Redisplay whatever buffers are showing, if there is a selected difference
1636 ;;; Window scrolling operations
1637 ;; These operations are designed to scroll all three windows the same amount,
1638 ;; so as to keep the text in them aligned.
1640 ;; Perform some operation on all three windows (if they are showing).
1641 ;; Catches all errors on the operation in the A and B windows, but not
1642 ;; in the merge window. Usually, errors come from scrolling off the
1643 ;; beginning or end of the buffer, and this gives a nice error message:
1644 ;; End of buffer is reported in the merge buffer, but if the scroll was
1645 ;; possible in the A or B windows, it is performed there before the error
1646 ;; is reported.
1669 "Scroll up all three merge buffers, if they are in windows.
1670 With argument N, scroll N lines; otherwise scroll by nearly
1671 the height of the merge window.
1672 `C-u -' alone as argument scrolls half the height of the merge window."
1675 'scroll-up
1676 ;; calculate argument to scroll-up
1677 ;; if there is an explicit argument
1679 ;; use it
1681 ;; if not, see if we can determine a default amount (the window height)
1684 ;; no window, use nil
1685 nil
1688 ;; the window was found
1690 ;; C-u as argument means half of default amount
1692 ;; no argument means default amount
1693 default-amount)))))))
1696 "Scroll down all three merge buffers, if they are in windows.
1697 With argument N, scroll N lines; otherwise scroll by nearly
1698 the height of the merge window.
1699 `C-u -' alone as argument scrolls half the height of the merge window."
1702 'scroll-down
1703 ;; calculate argument to scroll-down
1704 ;; if there is an explicit argument
1706 ;; use it
1708 ;; if not, see if we can determine a default amount (the window height)
1711 ;; no window, use nil
1712 nil
1715 ;; the window was found
1717 ;; C-u as argument means half of default amount
1719 ;; no argument means default amount
1720 default-amount)))))))
1723 "Scroll left all three merge buffers, if they are in windows.
1724 If an argument is given, that is how many columns are scrolled, else nearly
1725 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1726 width of the A and B windows."
1729 'scroll-left
1730 ;; calculate argument to scroll-left
1731 ;; if there is an explicit argument
1733 ;; use it
1735 ;; if not, see if we can determine a default amount
1736 ;; (half the window width)
1739 ;; no window, use nil
1740 nil
1743 ;; the window was found
1745 ;; C-u as argument means half of default amount
1747 ;; no argument means default amount
1748 default-amount)))))))
1751 "Scroll right all three merge buffers, if they are in windows.
1752 If an argument is given, that is how many columns are scrolled, else nearly
1753 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1754 width of the A and B windows."
1757 'scroll-right
1758 ;; calculate argument to scroll-right
1759 ;; if there is an explicit argument
1761 ;; use it
1763 ;; if not, see if we can determine a default amount
1764 ;; (half the window width)
1767 ;; no window, use nil
1768 nil
1771 ;; the window was found
1773 ;; C-u as argument means half of default amount
1775 ;; no argument means default amount
1776 default-amount)))))))
1779 "Reset horizontal scrolling in Emerge.
1780 This resets the horizontal scrolling of all three merge buffers
1781 to the left margin, if they are in windows."
1785 nil))
1787 ;; Attempt to show the region nicely.
1788 ;; If there are min-lines lines above and below the region, then don't do
1789 ;; anything.
1790 ;; If not, recenter the region to make it so.
1791 ;; If that isn't possible, remove context lines balancedly from top and bottom
1792 ;; so the entire region shows.
1793 ;; If that isn't possible, show the top of the region.
1794 ;; BEG must be at the beginning of a line.
1796 ;; First test whether the entire region is visible with
1797 ;; emerge-min-visible-lines above and below it
1801 beg)
1806 ;; We failed that test, see if it fits at all
1807 ;; Meanwhile positioning it correctly in case it doesn't fit
1811 ;; Determine the number of lines that the region occupies
1817 ;; And position the beginning on the right line
1820 lines))
1825 "Advance to the next difference."
1839 "Go to the previous difference."
1853 "Go to the N-th difference."
1863 "Abort the Emerge session."
1868 "Finish the Emerge session and exit Emerge.
1869 Prefix argument means to abort rather than successfully finish.
1870 The difference depends on how the merge was started,
1871 but usually means to not write over one of the original files, or to signal
1872 to some process which invoked Emerge a failure code.
1874 Unselects the selected difference, if any, restores the read-only and modified
1875 flags of the merged file buffers, restores the local keymap of the merge
1876 buffer, and sets off various emerge flags. Using Emerge commands in this
1877 buffer after this will cause serious problems."
1882 "Do you really want to successfully finish this merge? "
1887 ;; Perform the quit operations.
1892 ;; null out the difference markers so they don't slow down future editing
1893 ;; operations
1901 emerge-difference-list)
1902 ;; allow them to be garbage collected
1904 ;; restore the local map
1906 ;; turn off all the emerge modes
1912 ;; restore mode line
1918 "Select the A variant of this difference.
1919 Refuses to function if this difference has been edited, i.e., if it
1920 is neither the A nor the B variant.
1921 A prefix argument forces the variant to be selected
1922 even if the difference has been edited."
1935 ;; Actually select the A variant
1938 emerge-merge-buffer
1947 "Select the B variant of this difference.
1948 Refuses to function if this difference has been edited, i.e., if it
1949 is neither the A nor the B variant.
1950 A prefix argument forces the variant to be selected
1951 even if the difference has been edited."
1964 ;; Actually select the B variant
1967 emerge-merge-buffer
1976 "Make the A variant the default from here down.
1977 This selects the A variant for all differences from here down in the buffer
1978 which are still defaulted, i.e., which the user has not selected and for
1979 which there is no preference."
1998 "Make the B variant the default from here down.
1999 This selects the B variant for all differences from here down in the buffer
2000 which are still defaulted, i.e., which the user has not selected and for
2001 which there is no preference."
2020 "Set fast mode, for Emerge.
2021 In this mode ordinary Emacs commands are disabled, and Emerge commands
2033 "Set edit mode, for Emerge.
2034 In this mode ordinary Emacs commands are available, and Emerge commands
2046 "Toggle Auto-Advance mode, for Emerge.
2047 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2048 advance to the next difference.
2049 With a positive argument, turn on Auto-Advance mode.
2050 With a negative argument, turn off Auto-Advance mode."
2056 "Auto-advance set"
2061 "Toggle Skip-Prefers mode, for Emerge.
2062 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2063 to automatically skip over differences for which there is a preference.
2064 With a positive argument, turn on Skip-Prefers mode.
2065 With a negative argument, turn off Skip-Prefers mode."
2071 "Skip-prefers set"
2076 "Put the A variant of this difference in the kill ring."
2083 ;; so further kills don't append
2084 this-command)
2090 "Put the B variant of this difference in the kill ring."
2097 ;; so further kills don't append
2098 this-command)
2104 "Insert the A variant of this difference at the point.
2105 Leaves point after text, mark before.
2106 With prefix argument, puts point before, mark after."
2122 "Insert the B variant of this difference at the point.
2123 Leaves point after text, mark before.
2124 With prefix argument, puts point before, mark after."
2140 "Leaves the point before this difference and the mark after it.
2141 With prefix argument, puts mark before, point after."
2156 "Show the names of the buffers or files being operated on by Emerge.
2157 Use C-u l to reset the windows afterward."
2200 "Join the selected difference with the following one.
2201 With a prefix argument, join with the preceding one."
2204 ;; adjust n to be first difference to join
2207 ;; n and n+1 are the differences to join
2208 ;; check that they are both differences
2211 ;; remove the flags
2213 ;; decrement total number of differences
2215 ;; build new differences vector
2235 ps)
2242 ;; set the current difference correctly
2244 ;; fix the mode line
2246 ;; reinsert the flags
2251 "Split the current difference where the points are in the three windows."
2254 ;; check that this is a valid difference
2256 ;; get the point values and old difference
2263 ;; check location of the points, give error if they aren't in the
2264 ;; differences
2274 ;; remove the flags
2276 ;; increment total number of differences
2278 ;; build new differences vector
2290 A-point
2292 B-point
2294 merge-point
2306 ;; set the current difference correctly
2308 ;; fix the mode line
2310 ;; reinsert the flags
2315 "Trim lines off top and bottom of difference that are the same.
2316 If lines are the same in both the A and the B versions, strip them off.
2317 \(This can happen when the A and B versions have common lines that the
2318 ancestor version does not share.)"
2320 ;; make sure we are in a real difference
2322 ;; remove the flags
2331 size success sa sb sm)
2332 ;; move down the tops of the difference regions as much as possible
2333 ;; Try advancing comparing 1000 chars at a time.
2334 ;; When that fails, go 500 chars at a time, and so on.
2354 ;; move up the bottoms of the difference regions as much as possible
2355 ;; Try advancing comparing 1000 chars at a time.
2356 ;; When that fails, go 500 chars at a time, and so on.
2365 bottom-a)))
2368 bottom-b)))
2376 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2377 ;; of the difference regions. Move them to the beginning of lines, as
2378 ;; appropriate.
2399 ;; put the flags back in, recenter the display
2404 "Find the difference containing the current position of the point.
2405 If there is no containing difference and the prefix argument is positive,
2406 it finds the nearest following difference. A negative prefix argument finds
2407 the nearest previous difference."
2416 "Find the difference containing point, in the merge buffer.
2417 If there is no containing difference and the prefix argument is positive,
2418 it finds the nearest following difference. A negative prefix argument finds
2419 the nearest previous difference."
2421 ;; search for the point in the merge buffer, using the markers
2422 ;; for the beginning and end of the differences in the merge buffer
2426 "Find the difference containing point, in the A buffer.
2427 This command must be executed in the merge buffer.
2428 If there is no containing difference and the prefix argument is positive,
2429 it finds the nearest following difference. A negative prefix argument finds
2430 the nearest previous difference."
2432 ;; search for the point in the A buffer, using the markers
2433 ;; for the beginning and end of the differences in the A buffer
2439 "Find the difference containing point, in the B buffer.
2440 This command must be executed in the merge buffer.
2441 If there is no containing difference and the prefix argument is positive,
2442 it finds the nearest following difference. A negative prefix argument finds
2443 the nearest previous difference."
2445 ;; search for the point in the B buffer, using the markers
2446 ;; for the beginning and end of the differences in the B buffer
2453 ;; find first difference containing or after the current position
2461 emerge-number-of-differences))
2463 ;; whether the found difference contains the current position
2466 begin))
2467 location)))
2469 ;; numeric value of prefix argument
2473 ;; if the point is in a difference, select it
2475 ;; if the arg is nil and the point is not in a difference, error
2477 ;; if the arg is positive, select the following difference
2480 index
2482 ;; if the arg is negative, select the preceding difference
2489 "Display the current line numbers.
2490 This function displays the line numbers of the points in the A, B, and
2491 merge buffers."
2504 merge-line A-line B-line)))
2517 temp))
2520 "Set `emerge-combine-versions-template' to STRING.
2521 This value controls how `emerge-combine-versions' combines the two versions.
2522 With prefix argument, `emerge-combine-versions-template' is made local to this
2523 merge buffer. Localization is permanent for any particular merge buffer."
2530 "emerge-set-combine-versions-template set locally"
2534 "Copy region into `emerge-combine-versions-template'.
2535 This controls how `emerge-combine-versions' will combine the two versions.
2536 With prefix argument, `emerge-combine-versions-template' is made local to this
2537 merge buffer. Localization is permanent for any particular merge buffer."
2544 "emerge-set-combine-versions-template set locally."
2548 "Combine versions using the template in `emerge-combine-versions-template'.
2549 Refuses to function if this difference has been edited, i.e., if it is
2550 neither the A nor the B variant.
2551 An argument forces the variant to be selected even if the difference has
2552 been edited."
2557 "Combine the two versions using the template in register REG.
2558 See documentation of the variable `emerge-combine-versions-template'
2559 for how the template is interpreted.
2560 Refuses to function if this difference has been edited, i.e., if it is
2561 neither the A nor the B variant.
2562 An argument forces the variant to be selected even if the difference has
2563 been edited."
2574 A-begin A-end B-begin B-end)
2580 A-begin A-end B-begin B-end)
2582 emerge-merge-buffer
2610 "Set the major mode in a merge buffer.
2611 Overrides any change that the mode might make to the mode line or local
2612 keymap. Leaves merge in fast mode."
2627 ;;; Support routines
2629 ;; Select a difference by placing the visual flags around the appropriate
2630 ;; group of lines in the A, B, and merge buffers
2640 after-index)
2643 buffer
2649 ;; insert the flag before the difference
2651 before-index))
2652 here)
2654 ;; insert the flag itself
2657 ;; Put the marker(s) referring to this position 1 character before the
2658 ;; end of the flag, so it won't be damaged by the user.
2659 ;; This gets a bit tricky, as there could be a number of markers
2660 ;; that have to be moved.
2674 ;; insert the flag after the difference
2676 after-index))
2679 ;; insert the flag itself
2681 ;; Put the marker(s) referring to this position 1 character after the
2682 ;; beginning of the flag, so it won't be damaged by the user.
2683 ;; This gets a bit tricky, as there could be a number of markers
2684 ;; that have to be moved.
2699 ;; Unselect a difference by removing the visual flags in the buffers.
2712 buffer
2714 ;; remove the flags, if they're there
2718 ;; the flag isn't there
2724 ;; the flag isn't there
2728 ;; Select a difference, removing any flags that exist now.
2748 ;; Perform tests to see whether user should be allowed to select a version
2749 ;; of this difference:
2750 ;; a valid difference has been selected; and
2751 ;; the difference text in the merge buffer is:
2752 ;; the A version (execute a-version), or
2753 ;; the B version (execute b-version), or
2754 ;; empty (execute neither-version), or
2755 ;; argument FORCE is true (execute neither-version)
2756 ;; Otherwise, signal an error.
2769 emerge-merge-buffer merge-begin
2770 merge-end)
2773 emerge-merge-buffer merge-begin
2774 merge-end)
2780 ;; Read a file name, handling all of the various defaulting rules.
2783 A-file must-match)
2784 ;; `prompt' should not have trailing ": ", so that it can be modified
2785 ;; according to context.
2786 ;; If alternative-default-dir is non-nil, it should be used as the default
2787 ;; directory instead if default-directory, if emerge-default-last-directories
2788 ;; is set.
2789 ;; If default-file is set, it should be used as the default value.
2790 ;; If A-file is set, and its directory is different from
2791 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2792 ;; the default file should be the last part of A-file in the default
2793 ;; directory. (Overriding default-file.)
2795 ;; If this is not the A-file argument (shown by non-nil A-file), and
2796 ;; if emerge-default-last-directories is set, and
2797 ;; the default directory exists but is not the same as the directory of the
2798 ;; A-file,
2799 ;; then make the default file have the same name as the A-file, but in
2800 ;; the default directory.
2802 A-file
2803 alternative-default-dir
2808 alternative-default-dir
2812 ;; If there is a default file, use it.
2815 ;; If emerge-default-last-directories is set, use the
2816 ;; directory from the same argument of the last call of
2817 ;; Emerge as the default for this argument.
2819 alternative-default-dir)
2823 ;; If emerge-default-last-directories is set, use the
2824 ;; directory from the same argument of the last call of
2825 ;; Emerge as the default for this argument.
2827 alternative-default-dir)
2830 ;; Revise the mode line to display which difference we have selected
2836 emerge-number-of-differences
2838 (< emerge-current-difference
2839 emerge-number-of-differences))
2841 emerge-current-difference)
2851 ;; compare two regions in two buffers for containing the same text
2853 ;; first check that the two regions are the same length
2855 nil
2858 ;; bite off and compare no more than 1000 characters at a time
2861 buffer-x
2865 buffer-y
2872 t)))
2874 ;; Construct a unique buffer name.
2875 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2876 ;; prefix<3>suffix, etc.
2885 ;; Verify that we have a difference selected.
2891 ;;; Functions for saving and restoring a batch of variables
2893 ;; These functions save (get the values of) and restore (set the values of)
2894 ;; a list of variables. The argument is a list of symbols (the names of
2895 ;; the variables). A list element can also be a list of two functions,
2896 ;; the first of which (when called with no arguments) gets the value, and
2897 ;; the second (when called with a value as an argument) sets the value.
2898 ;; A "function" is anything that funcall can handle as an argument.
2904 vars))
2916 ;; Make a temporary file that only we have access to.
2917 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2920 ;; create the file
2923 f))
2925 ;;; Functions that query the user before he can write out the current buffer.
2928 "Ask the user whether to write out an incomplete merge.
2929 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2930 for details of the querying process."
2935 "Ask the user whether to save an incomplete merge.
2936 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2937 for details of the querying process."
2942 "Ask the user whether to save or write out the incomplete merge.
2943 If answer is yes, call COMMAND interactively. During the call, the flags
2944 around the current difference are removed."
2946 ;; He really wants to do it -- unselect the difference for the duration
2951 ;; call-interactively takes the value of current-prefix-arg as the
2952 ;; prefix argument value to be passed to the command. Thus, we have
2953 ;; to do nothing special to make sure the prefix argument is
2954 ;; transmitted to the command.
2961 ;; He's being smart and not doing it
2964 ;; Make sure the current buffer (for a file) has the same contents as the
2965 ;; file on disk, and attempt to remedy the situation if not.
2966 ;; Signal an error if we can't make them the same, or the user doesn't want
2967 ;; to do what is necessary to make them the same.
2969 ;; First check if the file has been modified since the buffer visited it.
2972 ;; If buffer is not obsolete and is modified, offer to save
2976 ;; If buffer is not obsolete and is not modified, do nothing
2977 nil)
2979 ;; If buffer is obsolete and is modified, give error
2981 ;; If buffer is obsolete and is not modified, offer to revert
2985 \f
2986 ;; Utilities that might have value outside of Emerge.
2988 ;; Set up the mode in the current buffer to duplicate the mode in another
2989 ;; buffer.
2991 ;; Set the major mode
2994 ;; Define a key, even if a prefix of it is defined
2996 "Like `define-key', but forcibly creates prefix characters as needed.
2997 If some prefix of KEY has a non-prefix definition, it is redefined."
2998 ;; Find out if a prefix of key is defined
3000 ;; If so, undefine it
3003 ;; Now define the key
3006 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
3007 ;;;;; as the major mode
3008 ;;(defun describe-mode (&optional minor)
3009 ;; "Display documentation of current major mode.
3010 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
3011 ;;display documentation of active minor modes as well.
3012 ;;For this to work correctly for a minor mode, the mode's indicator variable
3013 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
3014 ;;describes the minor mode."
3015 ;; (interactive)
3016 ;; (with-output-to-temp-buffer "*Help*"
3017 ;; (princ mode-name)
3018 ;; (princ " Mode:\n")
3019 ;; (princ (documentation major-mode))
3020 ;; (let ((minor-modes minor-mode-alist)
3021 ;; (locals (buffer-local-variables)))
3022 ;; (while minor-modes
3023 ;; (let* ((minor-mode (car (car minor-modes)))
3024 ;; (indicator (car (cdr (car minor-modes))))
3025 ;; (local-binding (assq minor-mode locals)))
3026 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
3027 ;; ;; bound locally in this buffer, non-nil, and has a function
3028 ;; ;; definition.
3029 ;; (if (and local-binding
3030 ;; (cdr local-binding)
3031 ;; (fboundp minor-mode))
3032 ;; (progn
3033 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
3034 ;; minor-mode indicator))
3035 ;; (princ (documentation minor-mode)))))
3036 ;; (setq minor-modes (cdr minor-modes))))
3037 ;; (save-excursion
3038 ;; (set-buffer standard-output)
3039 ;; (help-mode))
3040 ;; (print-help-return-message)))
3042 ;; This goes with the redefinition of describe-mode.
3043 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
3044 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
3046 ;; substitute-key-definition should work now.
3047 ;;;; Function to shadow a definition in a keymap with definitions in another.
3048 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3049 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3050 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3051 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3052 ;;including those whose definition is OLDDEF."
3053 ;; ;; loop through all keymaps accessible from keymap
3054 ;; (let ((maps (accessible-keymaps keymap)))
3055 ;; (while maps
3056 ;; (let ((prefix (car (car maps)))
3057 ;; (map (cdr (car maps))))
3058 ;; ;; examine a keymap
3059 ;; (if (arrayp map)
3060 ;; ;; array keymap
3061 ;; (let ((len (length map))
3062 ;; (i 0))
3063 ;; (while (< i len)
3064 ;; (if (eq (aref map i) olddef)
3065 ;; ;; set the shadowing definition
3066 ;; (let ((key (concat prefix (char-to-string i))))
3067 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3068 ;; (setq i (1+ i))))
3069 ;; ;; sparse keymap
3070 ;; (while map
3071 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3072 ;; ;; set the shadowing definition
3073 ;; (let ((key
3074 ;; (concat prefix (char-to-string (car (car map))))))
3075 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3076 ;; (setq map (cdr map)))))
3077 ;; (setq maps (cdr maps)))))
3079 ;; Define a key if it (or a prefix) is not already defined in the map.
3081 ;; look up the present definition of the key
3084 ;; if it is "too long", look up the valid prefix
3086 ;; if the prefix isn't defined, define it
3088 ;; if there is no present definition, define it
3092 ;; Ordinary substitute-key-definition should do this now.
3093 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3094 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3095 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3096 ;;\(`copy-keymap' will suffice.)"
3097 ;; ;; Loop through all keymaps accessible from keymap
3098 ;; (let ((maps (accessible-keymaps keymap)))
3099 ;; (while maps
3100 ;; ;; Substitute in this keymap
3101 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3102 ;; (setq maps (cdr maps)))))
3104 ;; Show the name of the file in the buffer.
3106 "Displays the name of the file loaded into the current buffer.
3107 If the name won't fit on one line, the minibuffer is expanded to hold it,
3108 and the command waits for a keystroke from the user. If the keystroke is
3109 SPC, it is ignored; if it is anything else, it is processed as a command."
3127 ;; Improved auto-save file names.
3128 ;; This function fixes many problems with the standard auto-save file names:
3129 ;; Auto-save files for non-file buffers get put in the default directory
3130 ;; for the buffer, whether that makes sense or not.
3131 ;; Auto-save files for file buffers get put in the directory of the file,
3132 ;; regardless of whether we can write into it or not.
3133 ;; Auto-save files for non-file buffers don't use the process id, so if a
3134 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3135 ;; each other.
3136 ;; To use this function, do:
3137 ;; (fset 'make-auto-save-file-name
3138 ;; (symbol-function 'emerge-make-auto-save-file-name))
3140 "Return file name to use for auto-saves of current buffer.
3141 Does not consider `auto-save-visited-file-name';
3142 that is checked before calling this function.
3143 You can redefine this for customization.
3144 See also `auto-save-file-name-p'."
3146 ;; if buffer has a file, try the format <file directory>/#<file name>#
3148 "#"
3152 ;; the file is writable, so use it
3153 f
3154 ;; the file isn't writable, so use the format
3155 ;; ~/#&<file name>&<hash of directory>#
3157 "/#&"
3159 "&"
3163 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3165 "/#%"
3166 ;; quote / into \! and \ into \\
3168 "%"
3172 ;; Hash a string into five characters more-or-less suitable for use in a file
3173 ;; name. (Allowed characters are ! through ~, except /.)
3189 ;; Quote any /s in a string by replacing them with \!.
3190 ;; Also, replace any \s by \\, to make it one-to-one.
3202 s)
3204 ;; Metacharacters that have to be protected from the shell when executing
3205 ;; a diff/diff3 command.
3208 More precisely, a [...] regexp to match any one such character."
3212 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3220 s)
3224 ;;; emerge.el ends here