| blob | f842ce6f3ac658ca4893f58410c82cb17be48e5e |
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
116 ;; Commands that produce difference files
117 ;; All that can be configured is the name of the programs to execute
118 ;; (emerge-diff-program and emerge-diff3-program) and the options
119 ;; to be provided (emerge-diff-options). The order in which the file names
120 ;; are given is fixed.
121 ;; The file names are always expanded (see expand-file-name) before being
122 ;; passed to diff, thus they need not be invoked under a shell that
123 ;; understands `~'.
124 ;; The code which processes the diff/diff3 output depends on all the
125 ;; finicky details of their output, including the somewhat strange
126 ;; way they number lines of a file.
130 "*Name of the program which compares three files.
136 "*Pattern to match lines produced by diff that describe differences.
140 "*Regexp that matches normal output lines from `emerge-diff-program'.
144 "*Regexp that matches normal output lines from `emerge-diff3-program'.
153 "*Non-nil if Emerge should process local-variables lists in merge buffers.
154 \(You can explicitly request processing the local-variables
157 "*If non-nil: `emerge-execute-line' makes no output if an input was deleted.
158 It concludes that an input version has been deleted when an ancestor entry
159 is present, only one A or B entry is present, and an output entry is present.
160 If nil: In such circumstances, the A or B file that is present will be
164 "*Flag placed above the highlighted block of code. Must end with newline.
165 Must be set before Emerge is loaded, or emerge-new-flags must be run
168 "*Flag placed below the highlighted block of code. Must end with newline.
169 Must be set before Emerge is loaded, or emerge-new-flags must be run
172 ;; Hook variables
177 "*Hook to run after a difference has been selected.
180 "*Hook to run after a difference has been unselected.
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
220 ;; The flags used to mark differences in the buffers.
222 ;; These function definitions need to be up here, because they are used
223 ;; during loading.
225 "Function to be called after `emerge-{before,after}-flag'.
226 This is called after these functions are changed to compute values that
227 depend on the flags."
238 "Return the number of matches in STRING for REGEXP."
244 count))
246 ;; Calculate dependent variables
250 "*Number of lines that we want to show above and below the flags when we are
257 d)
259 env
264 "*Prefix to put on Emerge temporary file names.
272 "*Template for `emerge-combine-versions' to combine the two versions.
273 The template is inserted as a string, with the following interpolations:
274 %a the A version of the difference
275 %b the B version of the difference
276 %% the character `%'
277 Don't forget to end the template with a newline.
278 Note that this variable can be made local to a particular merge buffer by
281 ;; Build keymaps
284 "Keymap of Emerge commands.
285 Directly available in `fast' mode;
289 "Local keymap used in Emerge `fast' mode.
302 "*Command prefix for Emerge commands in `edit' mode.
305 ;; This function sets up the fixed keymaps. It is executed when the first
306 ;; Emerge is done to allow the user maximum time to set up the global keymap.
308 ;; Set up the basic keymap
311 ; - to negative-argument
352 ;; Allow emerge-basic-keymap to be referenced indirectly
354 ;; Set up the fast mode keymap
356 ;; Allow prefixed commands to work in fast mode
358 ;; Allow emerge-fast-keymap to be referenced indirectly
360 ;; Suppress write-file and save-buffer
442 ;; Variables which control each merge. They are local to the merge buffer.
444 ;; Mode variables
458 "The buffer in which the ancestor variant is stored,
463 buffer-read-only
464 buffer-auto-save-file-name)
465 "Variables and properties of a buffer which are saved, modified and restored
476 "Vector of differences between the variants, and markers in the buffers to
477 show where they are. Each difference is represented by a vector of seven
478 elements. The first two are markers to the beginning and end of the difference
479 section in the A buffer, the second two are markers for the B buffer, the third
481 that difference in the merge buffer.
482 A section of a buffer is described by two markers, one to the beginning of
483 the first line of the section, and one to the beginning of the first line
484 after the section. (If the section is empty, both markers point to the same
485 point.) If the section is part of the selected difference, then the markers
486 are moved into the flags, so the user can edit the section without disturbing
487 the markers.
489 A the merge buffer currently contains the A variant
490 B the merge buffer currently contains the B variant
491 default-A the merge buffer contains the A variant by default,
492 but this difference hasn't been selected yet, so
493 change-default commands can alter it
494 default-B the merge buffer contains the B variant by default,
495 but this difference hasn't been selected yet, so
496 change-default commands can alter it
497 prefer-A in a three-file merge, the A variant is the preferred
498 choice
499 prefer-B in a three-file merge, the B variant is the preferred
506 "The local keymap for the merge buffer, with the emerge commands defined in
507 it. Used to save the local keymap during fast mode, when the local keymap is
512 "*If non-nil, emerge-select-A and emerge-select-B automatically advance to
515 "*If non-nil, differences for which there is a preference are automatically
518 "Hooks to run in the merge buffer after the merge has been finished.
519 `emerge-prefix-argument' will hold the prefix argument of the `emerge-quit'
520 command.
525 ;;; Setup functions for two-file mode.
528 output-file)
535 ;; Record the directories of the files
540 ;; Make sure the entire files are seen, and they reflect what is on disk
542 buffer-A
547 startup-hooks
549 startup-hooks))
550 ;; Verify that the file matches the buffer
553 buffer-B
558 startup-hooks
560 startup-hooks))
561 ;; Verify that the file matches the buffer
564 output-file)))
566 ;; Start up Emerge on two files
568 output-file)
573 ;; create the merge buffer from buffer A, so it inherits buffer A's
574 ;; default directory, etc.
576 buffer-A
579 merge-buffer
605 ;; Generate the Emerge difference list between two files
609 emerge-diff-buffer
613 emerge-diff-program emerge-diff-options
616 t))
619 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
625 diff-buffer
634 a-begin)))
642 b-begin))))
643 ;; fix the beginning and end numbers, because diff is somewhat
644 ;; strange about how it numbers lines
655 ;; (string-equal diff-type "c")
660 b-begin b-end
662 list)))))
665 ;; Set up buffer of diff/diff3 error messages.
669 emerge-diff-error-buffer
674 ;;; Top-level and setup functions for three-file mode.
677 &optional startup-hooks quit-hooks
678 output-file)
688 ;; Record the directories of the files
694 ;; Make sure the entire files are seen, and they reflect what is on disk
696 buffer-A
701 startup-hooks
703 startup-hooks))
704 ;; Verify that the file matches the buffer
707 buffer-B
712 startup-hooks
714 startup-hooks))
715 ;; Verify that the file matches the buffer
718 buffer-ancestor
723 startup-hooks
725 startup-hooks))
726 ;; Verify that the file matches the buffer
729 buffer-ancestor file-ancestor
730 startup-hooks quit-hooks output-file)))
732 ;; Start up Emerge on two files with an ancestor
734 buffer-ancestor file-ancestor
735 &optional startup-hooks quit-hooks
736 output-file)
742 ;; create the merge buffer from buffer A, so it inherits buffer A's
743 ;; default directory, etc.
745 buffer-A
748 merge-buffer
776 ;; Generate the Emerge difference list between two files with an ancestor
780 emerge-diff-buffer
784 emerge-diff3-program emerge-diff-options
788 t))
791 emerge-A-buffer emerge-B-buffer emerge-merge-buffer
797 diff-buffer
799 ;; leave point after matched line
802 ;; if the A and B files are the same, ignore the difference
816 list))))))
820 ;; This save-excursion allows emerge-get-diff3-group to be called for the
821 ;; various groups of lines (1, 2, 3) in any order, and for the lines to
822 ;; appear in any order. The reason this is necessary is that Gnu diff3
823 ;; can produce the groups in the order 1, 2, 3 or 1, 3, 2.
828 ;; treatment depends on whether it is an "a" group or a "c" group
830 ;; it is a "c" group
832 ;; it has two numbers
837 ;; it has one number
841 ;; it is an "a" group
846 ;;; Functions to start Emerge on files
848 ;;;###autoload
850 quit-hooks)
851 "Run Emerge on two files."
856 nil nil t))
860 f f nil)))))
862 file-A file-B startup-hooks
865 quit-hooks)
866 quit-hooks)
867 file-out))
869 ;;;###autoload
872 "Run Emerge on two files, giving another file as the ancestor."
877 nil nil t))
880 nil f t)
883 f f nil)))))
885 file-A file-B file-ancestor startup-hooks
888 quit-hooks)
889 quit-hooks)
890 file-out))
892 ;; Write the merge buffer out in place of the file the A buffer is visiting.
894 ;; if merge was successful was given, save to disk
898 ;;; Functions to start Emerge on buffers
900 ;;;###autoload
902 "Run Emerge on two buffers."
907 buffer-A
910 buffer-B
917 startup-hooks)
918 quit-hooks
919 nil)))
921 ;;;###autoload
923 &optional startup-hooks
924 quit-hooks)
925 "Run Emerge on two buffers, giving another buffer as the ancestor."
932 buffer-A
935 buffer-B
938 buffer-ancestor
944 emerge-file-ancestor
950 startup-hooks)
951 quit-hooks
952 nil)))
954 ;;; Functions to start Emerge from the command line
956 ;;;###autoload
963 file-a file-b nil
966 ;;;###autoload
969 ;; check for a -a flag, for filemerge compatibility
971 ;; arguments are "-a ancestor file-a file-b file-out"
978 ;; arguments are "file-a file-b ancestor file-out"
985 file-a file-b file-anc nil
992 ;;; Functions to start Emerge via remote request
994 ;;;###autoload
998 file-a file-b nil
1000 file-out)
1003 ;;;###autoload
1007 file-a file-b file-anc nil
1009 file-out)
1017 ;;; Functions to start Emerge on RCS versions
1019 ;;;###autoload
1022 "Emerge two RCS revisions of a file."
1029 emerge-last-revision-B revision-B)
1031 file revision-A revision-B startup-hooks
1036 quit-hooks)
1037 quit-hooks)))
1039 ;;;###autoload
1041 revision-B ancestor
1042 &optional
1043 startup-hooks quit-hooks)
1044 "Emerge two RCS revisions of a file, with another revision as ancestor."
1052 emerge-last-revision-B revision-B
1053 emerge-last-revision-ancestor ancestor)
1055 file revision-A revision-B ancestor startup-hooks
1061 quit-hooks))
1062 quit-hooks)))
1065 startup-hooks quit-hooks output-file)
1070 ;; Get the revisions into buffers
1072 buffer-A
1076 t)
1080 buffer-B
1084 t)
1087 ;; Do the merge
1089 buffer-B emerge-file-B
1093 startup-hooks)
1095 quit-hooks)
1096 nil)))
1099 ancestor
1100 &optional startup-hooks
1101 quit-hooks output-file)
1108 ;; Get the revisions into buffers
1110 buffer-A
1114 revision-A file)
1115 t)
1119 buffer-B
1123 t)
1127 buffer-ancestor
1131 t)
1134 ;; Do the merge
1136 buffer-A emerge-file-A buffer-B emerge-file-B
1137 buffer-ancestor emerge-ancestor
1142 startup-hooks)
1144 quit-hooks)
1145 output-file)))
1147 ;;; Function to start Emerge based on a line in a file
1150 "Run Emerge using files named in current text line.
1151 Looks in that line for whitespace-separated entries of these forms:
1152 a=file1
1153 b=file2
1154 ancestor=file3
1155 output=file4
1156 to specify the files to use in Emerge.
1158 In addition, if only one of `a=file' or `b=file' is present, and `output=file'
1159 is present:
1160 If `emerge-execute-line-deletions' is non-nil and `ancestor=file' is present,
1161 it is assumed that the file in question has been deleted, and it is
1162 not copied to the output file.
1163 Otherwise, the A or B file present is copied to the output file."
1167 ;; Stop if at end of buffer (even though we might be in a line, if
1168 ;; the line does not end with newline)
1171 ;; Go to the beginning of the line
1173 ;; Skip any initial whitespace
1176 ;; Process the entire line
1178 ;; Get the next entry
1180 ;; Break apart the tab (before =) and the filename (after =)
1184 ;; Move point after the entry
1186 ;; Store the filename in the right variable
1206 ;; If the match on the entry pattern failed
1208 ;; Make sure that file-A and file-B are present
1213 ;; Go to the beginning of the next line, so next execution will use
1214 ;; next line in buffer.
1216 ;; Execute the correct command
1218 ;; Merge of two files with ancestor
1222 file-ancestor file-out
1223 nil
1224 ;; When done, return to this buffer.
1229 ;; Merge of two files without ancestor
1233 nil
1234 ;; When done, return to this buffer.
1239 ;; There is an output file (or there would have been an error above),
1240 ;; but only one input file.
1241 ;; The file appears to have been deleted in one version; do nothing.
1244 ;; The file should be copied from the version that contains it
1250 ;;; Sample function for creating information for emerge-execute-line
1255 ;;;###autoload
1263 ;; Check that we're not on a line
1266 ;; Turn null strings into nil to indicate directories not used.
1271 ;; Canonicalize the directory names
1288 ;; Set the mark to where we start
1290 ;; Find out what files are in the directories.
1298 emerge-merge-directories-filename-regexp)))
1303 ;; Remove duplicates from all-files.
1309 ;; Generate the control lines for the various files.
1330 ;;; Common setup routines
1332 ;; Set up the window configuration. If POS is given, set the points to
1333 ;; the beginnings of the buffers.
1335 ;; Make sure we are not in the minibuffer window when we try to delete
1336 ;; all other windows.
1354 ;; If diff/diff3 reports errors, display them rather than the merge buffer.
1362 ;; Set up the keymap in the merge buffer
1364 ;; Set up fixed keymaps if necessary
1367 ;; Save the old local map
1369 ;; Construct the edit keymap
1373 ;; Install the Emerge commands
1378 ;; Create the additional menu bar items.
1386 ;; Suppress write-file and save-buffer
1388 'emerge-query-write-file
1389 emerge-edit-keymap)
1391 'emerge-query-save-buffer
1392 emerge-edit-keymap)
1402 "Record certain properties of the buffers being merged.
1403 Must be called in the merge buffer. Remembers read-only, modified,
1404 auto-save, and saves them in buffer local variables. Sets the buffers
1405 read-only and turns off `auto-save-mode'.
1406 These characteristics are restored by `emerge-restore-buffer-characteristics'."
1407 ;; force auto-save, because we will turn off auto-saving in buffers for the
1408 ;; duration
1410 ;; remember and alter buffer characteristics
1413 emerge-A-buffer
1417 emerge-merging-values))))
1420 emerge-B-buffer
1424 emerge-merging-values)))))
1427 "Restores characteristics saved by `emerge-remember-buffer-characteristics'."
1432 A-values))
1435 B-values))))
1437 ;; Move to line DESIRED-LINE assuming we are at line CURRENT-LINE.
1438 ;; Return DESIRED-LINE.
1441 desired-line)
1444 B-buffer
1445 merge-buffer
1446 lineno-list)
1451 ;; Record current line number in each buffer
1452 ;; so we don't have to count from the beginning.
1459 a-begin-marker
1460 a-end-marker
1461 b-begin-marker
1462 b-end-marker
1463 merge-begin-marker
1464 merge-end-marker
1470 ;; place markers at the appropriate places in the buffers
1472 A-buffer
1478 B-buffer
1486 offset)
1487 merge-buffer))
1491 offset)
1492 merge-buffer))
1493 ;; record all the markers for this difference
1495 b-begin-marker b-end-marker
1496 merge-begin-marker merge-end-marker
1497 state)
1498 marker-list)))
1500 ;; convert the list of difference information into a vector for
1501 ;; fast access
1504 ;; If we have an ancestor, select all B variants that we prefer
1516 ;; Process the local-variables list at the end of the merged file, if
1517 ;; requested.
1525 ;;; Common exit routines
1528 ;; clear screen format
1530 ;; delete A, B, and ancestor buffers, if they haven't been changed
1538 ;; Write merge buffer to file
1542 ;;; Commands
1545 "Bring the highlighted region of all three merge buffers into view.
1546 This brings the buffers into view if they are in windows.
1547 With an argument, reestablish the default three-window display."
1549 ;; If there is an argument, rebuild the window structure
1552 emerge-merge-buffer))
1553 ;; Redisplay whatever buffers are showing, if there is a selected difference
1589 ;;; Window scrolling operations
1590 ;; These operations are designed to scroll all three windows the same amount,
1591 ;; so as to keep the text in them aligned.
1593 ;; Perform some operation on all three windows (if they are showing).
1594 ;; Catches all errors on the operation in the A and B windows, but not
1595 ;; in the merge window. Usually, errors come from scrolling off the
1596 ;; beginning or end of the buffer, and this gives a nice error message:
1597 ;; End of buffer is reported in the merge buffer, but if the scroll was
1598 ;; possible in the A or B windows, it is performed there before the error
1599 ;; is reported.
1622 "Scroll up all three merge buffers, if they are in windows.
1623 With argument N, scroll N lines; otherwise scroll by nearly
1624 the height of the merge window.
1625 `C-u -' alone as argument scrolls half the height of the merge window."
1628 'scroll-up
1629 ;; calculate argument to scroll-up
1630 ;; if there is an explicit argument
1632 ;; use it
1634 ;; if not, see if we can determine a default amount (the window height)
1637 ;; no window, use nil
1638 nil
1641 ;; the window was found
1643 ;; C-u as argument means half of default amount
1645 ;; no argument means default amount
1646 default-amount)))))))
1649 "Scroll down all three merge buffers, if they are in windows.
1650 With argument N, scroll N lines; otherwise scroll by nearly
1651 the height of the merge window.
1652 `C-u -' alone as argument scrolls half the height of the merge window."
1655 'scroll-down
1656 ;; calculate argument to scroll-down
1657 ;; if there is an explicit argument
1659 ;; use it
1661 ;; if not, see if we can determine a default amount (the window height)
1664 ;; no window, use nil
1665 nil
1668 ;; the window was found
1670 ;; C-u as argument means half of default amount
1672 ;; no argument means default amount
1673 default-amount)))))))
1676 "Scroll left all three merge buffers, if they are in windows.
1677 If an argument is given, that is how many columns are scrolled, else nearly
1678 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1679 width of the A and B windows."
1682 'scroll-left
1683 ;; calculate argument to scroll-left
1684 ;; if there is an explicit argument
1686 ;; use it
1688 ;; if not, see if we can determine a default amount
1689 ;; (half the window width)
1692 ;; no window, use nil
1693 nil
1696 ;; the window was found
1698 ;; C-u as argument means half of default amount
1700 ;; no argument means default amount
1701 default-amount)))))))
1704 "Scroll right all three merge buffers, if they are in windows.
1705 If an argument is given, that is how many columns are scrolled, else nearly
1706 the width of the A and B windows. `C-u -' alone as argument scrolls half the
1707 width of the A and B windows."
1710 'scroll-right
1711 ;; calculate argument to scroll-right
1712 ;; if there is an explicit argument
1714 ;; use it
1716 ;; if not, see if we can determine a default amount
1717 ;; (half the window width)
1720 ;; no window, use nil
1721 nil
1724 ;; the window was found
1726 ;; C-u as argument means half of default amount
1728 ;; no argument means default amount
1729 default-amount)))))))
1732 "Reset horizontal scrolling in Emerge.
1733 This resets the horizontal scrolling of all three merge buffers
1734 to the left margin, if they are in windows."
1738 nil))
1740 ;; Attempt to show the region nicely.
1741 ;; If there are min-lines lines above and below the region, then don't do
1742 ;; anything.
1743 ;; If not, recenter the region to make it so.
1744 ;; If that isn't possible, remove context lines balancedly from top and bottom
1745 ;; so the entire region shows.
1746 ;; If that isn't possible, show the top of the region.
1747 ;; BEG must be at the beginning of a line.
1749 ;; First test whether the entire region is visible with
1750 ;; emerge-min-visible-lines above and below it
1754 beg)
1759 ;; We failed that test, see if it fits at all
1760 ;; Meanwhile positioning it correctly in case it doesn't fit
1764 ;; Determine the number of lines that the region occupies
1770 ;; And position the beginning on the right line
1773 lines))
1778 "Advance to the next difference."
1792 "Go to the previous difference."
1806 "Go to the N-th difference."
1816 "Abort the Emerge session."
1821 "Finish the Emerge session and exit Emerge.
1822 Prefix argument means to abort rather than successfully finish.
1823 The difference depends on how the merge was started,
1824 but usually means to not write over one of the original files, or to signal
1825 to some process which invoked Emerge a failure code.
1827 Unselects the selected difference, if any, restores the read-only and modified
1828 flags of the merged file buffers, restores the local keymap of the merge
1829 buffer, and sets off various emerge flags. Using Emerge commands in this
1830 buffer after this will cause serious problems."
1835 "Do you really want to successfully finish this merge? "
1840 ;; Perform the quit operations.
1845 ;; null out the difference markers so they don't slow down future editing
1846 ;; operations
1854 emerge-difference-list)
1855 ;; allow them to be garbage collected
1857 ;; restore the local map
1859 ;; turn off all the emerge modes
1865 ;; restore mode line
1871 "Select the A variant of this difference.
1872 Refuses to function if this difference has been edited, i.e., if it
1873 is neither the A nor the B variant.
1874 A prefix argument forces the variant to be selected
1875 even if the difference has been edited."
1888 ;; Actually select the A variant
1891 emerge-merge-buffer
1900 "Select the B variant of this difference.
1901 Refuses to function if this difference has been edited, i.e., if it
1902 is neither the A nor the B variant.
1903 A prefix argument forces the variant to be selected
1904 even if the difference has been edited."
1917 ;; Actually select the B variant
1920 emerge-merge-buffer
1929 "Make the A variant the default from here down.
1930 This selects the A variant for all differences from here down in the buffer
1931 which are still defaulted, i.e., which the user has not selected and for
1932 which there is no preference."
1951 "Make the B variant the default from here down.
1952 This selects the B variant for all differences from here down in the buffer
1953 which are still defaulted, i.e., which the user has not selected and for
1954 which there is no preference."
1973 "Set fast mode, for Emerge.
1974 In this mode ordinary Emacs commands are disabled, and Emerge commands
1986 "Set edit mode, for Emerge.
1987 In this mode ordinary Emacs commands are available, and Emerge commands
1999 "Toggle Auto-Advance mode, for Emerge.
2000 This mode causes `emerge-select-A' and `emerge-select-B' to automatically
2001 advance to the next difference.
2002 With a positive argument, turn on Auto-Advance mode.
2003 With a negative argument, turn off Auto-Advance mode."
2009 "Auto-advance set"
2014 "Toggle Skip-Prefers mode, for Emerge.
2015 This mode causes `emerge-next-difference' and `emerge-previous-difference'
2016 to automatically skip over differences for which there is a preference.
2017 With a positive argument, turn on Skip-Prefers mode.
2018 With a negative argument, turn off Skip-Prefers mode."
2024 "Skip-prefers set"
2029 "Put the A variant of this difference in the kill ring."
2036 ;; so further kills don't append
2037 this-command)
2043 "Put the B variant of this difference in the kill ring."
2050 ;; so further kills don't append
2051 this-command)
2057 "Insert the A variant of this difference at the point.
2058 Leaves point after text, mark before.
2059 With prefix argument, puts point before, mark after."
2075 "Insert the B variant of this difference at the point.
2076 Leaves point after text, mark before.
2077 With prefix argument, puts point before, mark after."
2093 "Leaves the point before this difference and the mark after it.
2094 With prefix argument, puts mark before, point after."
2109 "Show the names of the buffers or files being operated on by Emerge.
2110 Use C-u l to reset the windows afterward."
2153 "Join the selected difference with the following one.
2154 With a prefix argument, join with the preceding one."
2157 ;; adjust n to be first difference to join
2160 ;; n and n+1 are the differences to join
2161 ;; check that they are both differences
2164 ;; remove the flags
2166 ;; decrement total number of differences
2168 ;; build new differences vector
2188 ps)
2195 ;; set the current difference correctly
2197 ;; fix the mode line
2199 ;; reinsert the flags
2204 "Split the current difference where the points are in the three windows."
2207 ;; check that this is a valid difference
2209 ;; get the point values and old difference
2216 ;; check location of the points, give error if they aren't in the
2217 ;; differences
2227 ;; remove the flags
2229 ;; increment total number of differences
2231 ;; build new differences vector
2243 A-point
2245 B-point
2247 merge-point
2259 ;; set the current difference correctly
2261 ;; fix the mode line
2263 ;; reinsert the flags
2268 "Trim lines off top and bottom of difference that are the same.
2269 If lines are the same in both the A and the B versions, strip them off.
2270 \(This can happen when the A and B versions have common lines that the
2271 ancestor version does not share.)"
2273 ;; make sure we are in a real difference
2275 ;; remove the flags
2284 size success sa sb sm)
2285 ;; move down the tops of the difference regions as much as possible
2286 ;; Try advancing comparing 1000 chars at a time.
2287 ;; When that fails, go 500 chars at a time, and so on.
2307 ;; move up the bottoms of the difference regions as much as possible
2308 ;; Try advancing comparing 1000 chars at a time.
2309 ;; When that fails, go 500 chars at a time, and so on.
2318 bottom-a)))
2321 bottom-b)))
2329 ;; {top,bottom}-{a,b,m} are now set at the new beginnings and ends
2330 ;; of the difference regions. Move them to the beginning of lines, as
2331 ;; appropriate.
2352 ;; put the flags back in, recenter the display
2357 "Find the difference containing the current position of the point.
2358 If there is no containing difference and the prefix argument is positive,
2359 it finds the nearest following difference. A negative prefix argument finds
2360 the nearest previous difference."
2369 "Find the difference containing point, in the merge buffer.
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."
2374 ;; search for the point in the merge buffer, using the markers
2375 ;; for the beginning and end of the differences in the merge buffer
2379 "Find the difference containing point, in the A buffer.
2380 This command must be executed in the merge buffer.
2381 If there is no containing difference and the prefix argument is positive,
2382 it finds the nearest following difference. A negative prefix argument finds
2383 the nearest previous difference."
2385 ;; search for the point in the A buffer, using the markers
2386 ;; for the beginning and end of the differences in the A buffer
2392 "Find the difference containing point, in the B buffer.
2393 This command must be executed in the merge buffer.
2394 If there is no containing difference and the prefix argument is positive,
2395 it finds the nearest following difference. A negative prefix argument finds
2396 the nearest previous difference."
2398 ;; search for the point in the B buffer, using the markers
2399 ;; for the beginning and end of the differences in the B buffer
2406 ;; find first difference containing or after the current position
2414 emerge-number-of-differences))
2416 ;; whether the found difference contains the current position
2419 begin))
2420 location)))
2422 ;; numeric value of prefix argument
2426 ;; if the point is in a difference, select it
2428 ;; if the arg is nil and the point is not in a difference, error
2430 ;; if the arg is positive, select the following difference
2433 index
2435 ;; if the arg is negative, select the preceding difference
2442 "Display the current line numbers.
2443 This function displays the line numbers of the points in the A, B, and
2444 merge buffers."
2457 merge-line A-line B-line)))
2470 temp))
2473 "Set `emerge-combine-versions-template' to STRING.
2474 This value controls how `emerge-combine-versions' combines the two versions.
2475 With prefix argument, `emerge-combine-versions-template' is made local to this
2476 merge buffer. Localization is permanent for any particular merge buffer."
2483 "emerge-set-combine-versions-template set locally"
2487 "Copy region into `emerge-combine-versions-template'.
2488 This controls how `emerge-combine-versions' will combine the two versions.
2489 With prefix argument, `emerge-combine-versions-template' is made local to this
2490 merge buffer. Localization is permanent for any particular merge buffer."
2497 "emerge-set-combine-versions-template set locally."
2501 "Combine versions using the template in `emerge-combine-versions-template'.
2502 Refuses to function if this difference has been edited, i.e., if it is
2503 neither the A nor the B variant.
2504 An argument forces the variant to be selected even if the difference has
2505 been edited."
2510 "Combine the two versions using the template in register REG.
2511 See documentation of the variable `emerge-combine-versions-template'
2512 for how the template is interpreted.
2513 Refuses to function if this difference has been edited, i.e., if it is
2514 neither the A nor the B variant.
2515 An argument forces the variant to be selected even if the difference has
2516 been edited."
2527 A-begin A-end B-begin B-end)
2533 A-begin A-end B-begin B-end)
2535 emerge-merge-buffer
2563 "Set the major mode in a merge buffer.
2564 Overrides any change that the mode might make to the mode line or local
2565 keymap. Leaves merge in fast mode."
2580 ;;; Support routines
2582 ;; Select a difference by placing the visual flags around the appropriate
2583 ;; group of lines in the A, B, and merge buffers
2593 after-index)
2596 buffer
2602 ;; insert the flag before the difference
2604 before-index))
2605 here)
2607 ;; insert the flag itself
2610 ;; Put the marker(s) referring to this position 1 character before the
2611 ;; end of the flag, so it won't be damaged by the user.
2612 ;; This gets a bit tricky, as there could be a number of markers
2613 ;; that have to be moved.
2627 ;; insert the flag after the difference
2629 after-index))
2632 ;; insert the flag itself
2634 ;; Put the marker(s) referring to this position 1 character after the
2635 ;; beginning of the flag, so it won't be damaged by the user.
2636 ;; This gets a bit tricky, as there could be a number of markers
2637 ;; that have to be moved.
2652 ;; Unselect a difference by removing the visual flags in the buffers.
2665 buffer
2667 ;; remove the flags, if they're there
2671 ;; the flag isn't there
2677 ;; the flag isn't there
2681 ;; Select a difference, removing any flags that exist now.
2701 ;; Perform tests to see whether user should be allowed to select a version
2702 ;; of this difference:
2703 ;; a valid difference has been selected; and
2704 ;; the difference text in the merge buffer is:
2705 ;; the A version (execute a-version), or
2706 ;; the B version (execute b-version), or
2707 ;; empty (execute neither-version), or
2708 ;; argument FORCE is true (execute neither-version)
2709 ;; Otherwise, signal an error.
2722 emerge-merge-buffer merge-begin
2723 merge-end)
2726 emerge-merge-buffer merge-begin
2727 merge-end)
2733 ;; Read a file name, handling all of the various defaulting rules.
2736 A-file must-match)
2737 ;; `prompt' should not have trailing ": ", so that it can be modified
2738 ;; according to context.
2739 ;; If alternative-default-dir is non-nil, it should be used as the default
2740 ;; directory instead if default-directory, if emerge-default-last-directories
2741 ;; is set.
2742 ;; If default-file is set, it should be used as the default value.
2743 ;; If A-file is set, and its directory is different from
2744 ;; alternative-default-dir, and if emerge-default-last-directories is set,
2745 ;; the default file should be the last part of A-file in the default
2746 ;; directory. (Overriding default-file.)
2748 ;; If this is not the A-file argument (shown by non-nil A-file), and
2749 ;; if emerge-default-last-directories is set, and
2750 ;; the default directory exists but is not the same as the directory of the
2751 ;; A-file,
2752 ;; then make the default file have the same name as the A-file, but in
2753 ;; the default directory.
2755 A-file
2756 alternative-default-dir
2761 alternative-default-dir
2765 ;; If there is a default file, use it.
2768 ;; If emerge-default-last-directories is set, use the
2769 ;; directory from the same argument of the last call of
2770 ;; Emerge as the default for this argument.
2772 alternative-default-dir)
2776 ;; If emerge-default-last-directories is set, use the
2777 ;; directory from the same argument of the last call of
2778 ;; Emerge as the default for this argument.
2780 alternative-default-dir)
2783 ;; Revise the mode line to display which difference we have selected
2789 emerge-number-of-differences
2791 (< emerge-current-difference
2792 emerge-number-of-differences))
2794 emerge-current-difference)
2804 ;; compare two regions in two buffers for containing the same text
2806 ;; first check that the two regions are the same length
2808 nil
2811 ;; bite off and compare no more than 1000 characters at a time
2814 buffer-x
2818 buffer-y
2825 t)))
2827 ;; Construct a unique buffer name.
2828 ;; The first one tried is prefixsuffix, then prefix<2>suffix,
2829 ;; prefix<3>suffix, etc.
2838 ;; Verify that we have a difference selected.
2844 ;;; Functions for saving and restoring a batch of variables
2846 ;; These functions save (get the values of) and restore (set the values of)
2847 ;; a list of variables. The argument is a list of symbols (the names of
2848 ;; the variables). A list element can also be a list of two functions,
2849 ;; the first of which (when called with no arguments) gets the value, and
2850 ;; the second (when called with a value as an argument) sets the value.
2851 ;; A "function" is anything that funcall can handle as an argument.
2857 vars))
2869 ;; Make a temporary file that only we have access to.
2870 ;; PREFIX is appended to emerge-temp-file-prefix to make the filename prefix.
2873 ;; create the file
2876 f))
2878 ;;; Functions that query the user before he can write out the current buffer.
2881 "Ask the user whether to write out an incomplete merge.
2882 If answer is yes, call `write-file' to do so. See `emerge-query-and-call'
2883 for details of the querying process."
2888 "Ask the user whether to save an incomplete merge.
2889 If answer is yes, call `save-buffer' to do so. See `emerge-query-and-call'
2890 for details of the querying process."
2895 "Ask the user whether to save or write out the incomplete merge.
2896 If answer is yes, call COMMAND interactively. During the call, the flags
2897 around the current difference are removed."
2899 ;; He really wants to do it -- unselect the difference for the duration
2904 ;; call-interactively takes the value of current-prefix-arg as the
2905 ;; prefix argument value to be passed to the command. Thus, we have
2906 ;; to do nothing special to make sure the prefix argument is
2907 ;; transmitted to the command.
2914 ;; He's being smart and not doing it
2917 ;; Make sure the current buffer (for a file) has the same contents as the
2918 ;; file on disk, and attempt to remedy the situation if not.
2919 ;; Signal an error if we can't make them the same, or the user doesn't want
2920 ;; to do what is necessary to make them the same.
2922 ;; First check if the file has been modified since the buffer visited it.
2925 ;; If buffer is not obsolete and is modified, offer to save
2929 ;; If buffer is not obsolete and is not modified, do nothing
2930 nil)
2932 ;; If buffer is obsolete and is modified, give error
2934 ;; If buffer is obsolete and is not modified, offer to revert
2938 \f
2939 ;; Utilities that might have value outside of Emerge.
2941 ;; Set up the mode in the current buffer to duplicate the mode in another
2942 ;; buffer.
2944 ;; Set the major mode
2947 ;; Define a key, even if a prefix of it is defined
2949 "Like `define-key', but forcibly creates prefix characters as needed.
2950 If some prefix of KEY has a non-prefix definition, it is redefined."
2951 ;; Find out if a prefix of key is defined
2953 ;; If so, undefine it
2956 ;; Now define the key
2959 ;;;;; Improvements to describe-mode, so that it describes minor modes as well
2960 ;;;;; as the major mode
2961 ;;(defun describe-mode (&optional minor)
2962 ;; "Display documentation of current major mode.
2963 ;;If optional arg MINOR is non-nil (or prefix argument is given if interactive),
2964 ;;display documentation of active minor modes as well.
2965 ;;For this to work correctly for a minor mode, the mode's indicator variable
2966 ;;\(listed in `minor-mode-alist') must also be a function whose documentation
2967 ;;describes the minor mode."
2968 ;; (interactive)
2969 ;; (with-output-to-temp-buffer "*Help*"
2970 ;; (princ mode-name)
2971 ;; (princ " Mode:\n")
2972 ;; (princ (documentation major-mode))
2973 ;; (let ((minor-modes minor-mode-alist)
2974 ;; (locals (buffer-local-variables)))
2975 ;; (while minor-modes
2976 ;; (let* ((minor-mode (car (car minor-modes)))
2977 ;; (indicator (car (cdr (car minor-modes))))
2978 ;; (local-binding (assq minor-mode locals)))
2979 ;; ;; Document a minor mode if it is listed in minor-mode-alist,
2980 ;; ;; bound locally in this buffer, non-nil, and has a function
2981 ;; ;; definition.
2982 ;; (if (and local-binding
2983 ;; (cdr local-binding)
2984 ;; (fboundp minor-mode))
2985 ;; (progn
2986 ;; (princ (format "\n\n\n%s minor mode (indicator%s):\n"
2987 ;; minor-mode indicator))
2988 ;; (princ (documentation minor-mode)))))
2989 ;; (setq minor-modes (cdr minor-modes))))
2990 ;; (save-excursion
2991 ;; (set-buffer standard-output)
2992 ;; (help-mode))
2993 ;; (print-help-return-message)))
2995 ;; This goes with the redefinition of describe-mode.
2996 ;;;; Adjust things so that keyboard macro definitions are documented correctly.
2997 ;;(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
2999 ;; substitute-key-definition should work now.
3000 ;;;; Function to shadow a definition in a keymap with definitions in another.
3001 ;;(defun emerge-shadow-key-definition (olddef newdef keymap shadowmap)
3002 ;; "Shadow OLDDEF with NEWDEF for any keys in KEYMAP with entries in SHADOWMAP.
3003 ;;In other words, SHADOWMAP will now shadow all definitions of OLDDEF in KEYMAP
3004 ;;with NEWDEF. Does not affect keys that are already defined in SHADOWMAP,
3005 ;;including those whose definition is OLDDEF."
3006 ;; ;; loop through all keymaps accessible from keymap
3007 ;; (let ((maps (accessible-keymaps keymap)))
3008 ;; (while maps
3009 ;; (let ((prefix (car (car maps)))
3010 ;; (map (cdr (car maps))))
3011 ;; ;; examine a keymap
3012 ;; (if (arrayp map)
3013 ;; ;; array keymap
3014 ;; (let ((len (length map))
3015 ;; (i 0))
3016 ;; (while (< i len)
3017 ;; (if (eq (aref map i) olddef)
3018 ;; ;; set the shadowing definition
3019 ;; (let ((key (concat prefix (char-to-string i))))
3020 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3021 ;; (setq i (1+ i))))
3022 ;; ;; sparse keymap
3023 ;; (while map
3024 ;; (if (eq (cdr-safe (car-safe map)) olddef)
3025 ;; ;; set the shadowing definition
3026 ;; (let ((key
3027 ;; (concat prefix (char-to-string (car (car map))))))
3028 ;; (emerge-define-key-if-possible shadowmap key newdef)))
3029 ;; (setq map (cdr map)))))
3030 ;; (setq maps (cdr maps)))))
3032 ;; Define a key if it (or a prefix) is not already defined in the map.
3034 ;; look up the present definition of the key
3037 ;; if it is "too long", look up the valid prefix
3039 ;; if the prefix isn't defined, define it
3041 ;; if there is no present definition, define it
3045 ;; Ordinary substitute-key-definition should do this now.
3046 ;;(defun emerge-recursively-substitute-key-definition (olddef newdef keymap)
3047 ;; "Like `substitute-key-definition', but act recursively on subkeymaps.
3048 ;;Make sure that subordinate keymaps aren't shared with other keymaps!
3049 ;;\(`copy-keymap' will suffice.)"
3050 ;; ;; Loop through all keymaps accessible from keymap
3051 ;; (let ((maps (accessible-keymaps keymap)))
3052 ;; (while maps
3053 ;; ;; Substitute in this keymap
3054 ;; (substitute-key-definition olddef newdef (cdr (car maps)))
3055 ;; (setq maps (cdr maps)))))
3057 ;; Show the name of the file in the buffer.
3059 "Displays the name of the file loaded into the current buffer.
3060 If the name won't fit on one line, the minibuffer is expanded to hold it,
3061 and the command waits for a keystroke from the user. If the keystroke is
3062 SPC, it is ignored; if it is anything else, it is processed as a command."
3080 ;; Improved auto-save file names.
3081 ;; This function fixes many problems with the standard auto-save file names:
3082 ;; Auto-save files for non-file buffers get put in the default directory
3083 ;; for the buffer, whether that makes sense or not.
3084 ;; Auto-save files for file buffers get put in the directory of the file,
3085 ;; regardless of whether we can write into it or not.
3086 ;; Auto-save files for non-file buffers don't use the process id, so if a
3087 ;; user runs more than on Emacs, they can make auto-save files that overwrite
3088 ;; each other.
3089 ;; To use this function, do:
3090 ;; (fset 'make-auto-save-file-name
3091 ;; (symbol-function 'emerge-make-auto-save-file-name))
3093 "Return file name to use for auto-saves of current buffer.
3094 Does not consider `auto-save-visited-file-name';
3095 that is checked before calling this function.
3096 You can redefine this for customization.
3097 See also `auto-save-file-name-p'."
3099 ;; if buffer has a file, try the format <file directory>/#<file name>#
3101 "#"
3105 ;; the file is writable, so use it
3106 f
3107 ;; the file isn't writable, so use the format
3108 ;; ~/#&<file name>&<hash of directory>#
3110 "/#&"
3112 "&"
3116 ;; if buffer has no file, use the format ~/#%<buffer name>%<process id>#
3118 "/#%"
3119 ;; quote / into \! and \ into \\
3121 "%"
3125 ;; Hash a string into five characters more-or-less suitable for use in a file
3126 ;; name. (Allowed characters are ! through ~, except /.)
3142 ;; Quote any /s in a string by replacing them with \!.
3143 ;; Also, replace any \s by \\, to make it one-to-one.
3155 s)
3157 ;; Metacharacters that have to be protected from the shell when executing
3158 ;; a diff/diff3 command.
3163 ;; Quote metacharacters (using \) when executing a diff/diff3 command.
3171 s)
3175 ;;; emerge.el ends here