| blob | bd7d5da257ea1b12f293ff0246d33bc7b1013844 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
31 ;; This is for lexical-let in apply-partially.
40 "Idle time delay before updating various things on the screen.
41 Various Emacs features that update auxiliary information when point moves
42 wait this many seconds after Emacs becomes idle before doing an update."
48 "Killing and yanking commands."
52 "Highlight (un)matching of parens and expressions."
56 "Search LIST for a valid buffer to display in FRAME.
57 Return nil when all buffers in LIST are undesirable for display,
58 otherwise return the first suitable buffer in LIST.
60 Buffers not visible in windows are preferred to visible buffers,
61 unless VISIBLE-OK is non-nil.
62 If the optional argument FRAME is nil, it defaults to the selected frame.
63 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
64 ;; This logic is more or less copied from other-buffer.
67 found buf)
80 "Return the last buffer in FRAME's buffer list.
81 If BUFFER is the last buffer, return the preceding buffer instead.
82 Buffers not visible in windows are preferred to visible buffers,
83 unless optional argument VISIBLE-OK is non-nil.
84 Optional third argument FRAME nil or omitted means use the
85 selected frame's buffer list.
86 If no such buffer exists, return the buffer `*scratch*', creating
87 it if necessary."
90 buffer visible-ok frame)
94 scratch)))
97 "Switch to the next buffer in cyclic order."
104 "Switch to the previous buffer in cyclic order."
108 \f
109 ;;; next-error support framework
112 "`next-error' support framework."
118 "Face used to highlight next error locus."
123 "Highlighting of locations in selected source buffers.
124 If a number, highlight the locus in `next-error' face for the given time
125 in seconds, or until the next command is executed.
126 If t, highlight the locus until the next command is executed, or until
127 some other locus replaces it.
128 If nil, don't highlight the locus in the source buffer.
129 If `fringe-arrow', indicate the locus by the fringe arrow."
138 "Highlighting of locations in `next-error-no-select'.
139 If number, highlight the locus in `next-error' face for given time in seconds.
140 If t, highlight the locus indefinitely until some other locus replaces it.
141 If nil, don't highlight the locus in the source buffer.
142 If `fringe-arrow', indicate the locus by the fringe arrow."
151 "Display the line in the visited source file recentered as specified.
152 If non-nil, the value is passed directly to `recenter'."
160 "List of hook functions run by `next-error' after visiting source file."
171 "The most recent `next-error' buffer.
172 A buffer becomes most recent when its compilation, grep, or
177 "Function to use to find the next error in the current buffer.
178 The function is called with 2 parameters:
179 ARG is an integer specifying by how many errors to move.
180 RESET is a boolean which, if non-nil, says to go back to the beginning
181 of the errors before moving.
182 Major modes providing compile-like functionality should set this variable
183 to indicate to `next-error' that this is a candidate buffer and how
188 "Function to use to move to an error locus.
189 It takes two arguments, a buffer position in the error buffer
190 and a buffer position in the error locus buffer.
191 The buffer for the error locus should already be current.
196 &optional avoid-current
197 extra-test-inclusive
198 extra-test-exclusive)
199 "Test if BUFFER is a `next-error' capable buffer.
201 If AVOID-CURRENT is non-nil, treat the current buffer
202 as an absolute last resort only.
204 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
205 that normally would not qualify. If it returns t, the buffer
206 in question is treated as usable.
208 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
209 that would normally be considered usable. If it returns nil,
210 that buffer is rejected."
215 ;; Optionally reject some buffers.
218 t)
219 ;; Optionally accept some other buffers.
224 extra-test-inclusive
225 extra-test-exclusive)
226 "Return a `next-error' capable buffer.
228 If AVOID-CURRENT is non-nil, treat the current buffer
229 as an absolute last resort only.
231 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
232 that normally would not qualify. If it returns t, the buffer
233 in question is treated as usable.
235 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
236 that would normally be considered usable. If it returns nil,
237 that buffer is rejected."
239 ;; 1. If one window on the selected frame displays such buffer, return it.
245 avoid-current
246 extra-test-inclusive extra-test-exclusive)
251 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
254 extra-test-inclusive extra-test-exclusive))
255 next-error-last-buffer)
256 ;; 3. If the current buffer is acceptable, choose it.
258 extra-test-inclusive extra-test-exclusive)
260 ;; 4. Look for any acceptable buffer.
265 extra-test-inclusive extra-test-exclusive)))
268 ;; 5. Use the current buffer as a last resort if it qualifies,
269 ;; even despite AVOID-CURRENT.
272 extra-test-inclusive extra-test-exclusive)
276 ;; 6. Give up.
280 "Visit next `next-error' message and corresponding source code.
282 If all the error messages parsed so far have been processed already,
283 the message buffer is checked for new ones.
285 A prefix ARG specifies how many error messages to move;
286 negative means move back to previous error messages.
288 and start at the first error.
290 The RESET argument specifies that we should restart from the beginning.
293 compilation, grep, or occur buffer. It can also operate on any
295 more generally, on any buffer in Compilation mode or with
296 Compilation Minor mode enabled, or any buffer in which
297 `next-error-function' is bound to an appropriate function.
298 To specify use of a particular buffer for error messages, type
300 in the current frame.
303 runs `next-error-hook' with `run-hooks', and stays with that buffer
304 until you use it in some other buffer which uses Compilation mode
305 or Compilation Minor mode.
307 To control which errors are matched, customize the variable
308 `compilation-error-regexp-alist'."
312 ;; we know here that next-error-function is a valid symbol we can funcall
320 "Visit the source code corresponding to the `next-error' message at point."
322 ;; we know here that next-error-function is a valid symbol we can funcall
333 "Visit previous `next-error' message and corresponding source code.
335 Prefix arg N says how many error messages to move backwards (or
336 forwards, if negative).
343 "Restart at the first error.
344 Visit corresponding source code.
345 With prefix arg N, visit the source code of the Nth error.
351 "Move point to the next error in the `next-error' buffer and highlight match.
352 Prefix arg N says how many error messages to move forwards (or
353 backwards, if negative).
355 select the source buffer."
362 "Move point to the previous error in the `next-error' buffer and highlight match.
363 Prefix arg N says how many error messages to move backwards (or
364 forwards, if negative).
366 select the source buffer."
370 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
374 "Minor mode for compilation, occur and diff modes.
375 When turned on, cursor motion in the compilation, grep, occur or diff
376 buffer causes automatic display of the corresponding source code
377 location."
384 ;; Used as a `post-command-hook' by `next-error-follow-mode'
385 ;; for the *Compilation* *grep* and *Occur* buffers.
395 \f
396 ;;;
399 "Major mode not specialized for anything in particular.
400 Other major modes are defined by comparison with this one."
405 ;; Special major modes to view specially formatted data rather than files.
419 map))
423 "Parent major mode from which special major modes should inherit."
426 ;; Major mode meant to be the parent of programming modes.
431 map)
435 "Indent the expression after point."
442 "Major mode for editing programming language source code."
445 ;; Any programming language is always written left to right.
448 ;; Making and deleting lines.
454 "Insert a newline, and move to left margin of the new line if it's blank.
455 If `use-hard-newlines' is non-nil, the newline is marked with the
456 text-property `hard'.
457 With ARG, insert that many newlines.
458 Call `auto-fill-function' if the current column number is greater
459 than the value of `fill-column' and ARG is nil."
462 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
463 ;; Set last-command-event to tell self-insert what to insert.
467 ;; Don't auto-fill if we have a numeric argument.
470 ;; Do the rest in post-self-insert-hook, because we want to do it
471 ;; *before* other functions on that hook.
473 ;; Mark the newline(s) `hard'.
477 ;; If the newline leaves the previous line blank, and we
478 ;; have a left margin, delete that from the blank line.
486 ;; Indent the line after the newline, except in one case:
487 ;; when we added the newline at the beginning of a line which
488 ;; starts a page.
495 ;; We first used let-binding to protect the hook, but that was naive
496 ;; since add-hook affects the symbol-default value of the variable,
497 ;; whereas the let-binding might only protect the buffer-local value.
499 nil)
504 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
510 "Insert a newline and leave point before it.
511 If there is a fill prefix and/or a `left-margin', insert them
512 on the new line if the line would have been blank.
513 With arg N, insert N newlines."
518 ;; Don't expand an abbrev before point.
532 "Split current line, moving portion beyond point vertically down.
533 If the current line starts with `fill-prefix', insert it on the new
534 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
536 When called from Lisp code, ARG may be a prefix string to copy."
541 ;; What prefix should we check for (nil means don't).
545 ;; Does this line start with it?
556 "Join this line to previous and fix up whitespace at join.
557 If there is a fill prefix, delete it from the beginning of this line.
558 With argument, join this line to following line."
565 ;; If the second line started with the fill prefix,
566 ;; delete the prefix.
578 "On blank line, delete all surrounding blank lines, leaving just one.
579 On isolated blank line, delete that one.
580 On nonblank line, delete any immediately following blank lines."
586 ;; Set singleblank if there is just one blank line here.
593 ;; Delete preceding blank lines, and this one too if it's the only one.
602 ;; Delete following blank lines, unless the current line is blank
603 ;; and there are no following blank lines.
612 ;; Handle the special case where point is followed by newline and eob.
613 ;; Delete the line, leaving point at eob.
618 "Delete all the trailing whitespace across the current buffer.
619 All whitespace after the last non-whitespace character in a line is deleted.
621 A formfeed is not considered whitespace by this function.
622 If the region is active, only delete whitespace within the region."
635 ;; Don't delete formfeeds, even if they are considered whitespace.
641 ;; Return nil for the benefit of `write-file-functions'.
642 nil)
645 "Insert a newline, then indent according to major mode.
646 Indentation is done using the value of `indent-line-function'.
647 In programming language modes, this is the same as TAB.
648 In some text modes, where TAB inserts a tab, this command indents to the
649 column specified by the function `current-left-margin'."
656 "Reindent current line, insert newline, then indent the new line.
657 Indentation of both lines is done according to the current major mode,
658 which means calling the current value of `indent-line-function'.
659 In programming language modes, this is the same as TAB.
660 In some text modes, where TAB inserts a tab, this indents to the
661 column specified by the function `current-left-margin'."
664 ;; Be careful to insert the newline before indenting the line.
665 ;; Otherwise, the indentation might be wrong.
669 ;; We are at EOL before the call to indent-according-to-mode, and
670 ;; after it we usually are as well, but not always. We tried to
671 ;; address it with `save-excursion' but that uses a normal marker
672 ;; whereas we need `move after insertion', so we do the save/restore
673 ;; by hand.
677 ;; Remove the trailing white-space after indentation because
678 ;; indentation may introduce the whitespace.
683 "Read next input character and insert it.
684 This is useful for inserting control characters.
685 With argument, insert ARG copies of the character.
687 If the first character you type after this command is an octal digit,
688 you should type a sequence of octal digits which specify a character code.
689 Any nondigit terminates the sequence. If the terminator is a RET,
690 it is discarded; any other terminator is used itself as input.
691 The variable `read-quoted-char-radix' specifies the radix for this feature;
692 set it to 10 or 16 to use decimal or hex instead of octal.
694 In overwrite mode, this function inserts the character anyway, and
695 does not handle octal digits specially. This means that if you use
696 overwrite as your normal editing mode, you can use this function to
697 insert characters when necessary.
699 In binary overwrite mode, this function does overwrite, and octal
700 digits are interpreted as a character code. This is intended to be
701 useful for editing binary files."
704 ;; Avoid "obsolete" warnings for translation-table-for-input.
711 ;; This used to assume character codes 0240 - 0377 stand for
712 ;; characters in some single-byte character set, and converted them
713 ;; to Emacs characters. But in 23.1 this feature is deprecated
714 ;; in favor of inserting the corresponding Unicode characters.
715 ;; (if (and enable-multibyte-characters
716 ;; (>= char ?\240)
717 ;; (<= char ?\377))
718 ;; (setq char (unibyte-char-to-multibyte char)))
727 "Move forward ARG lines and position at first nonblank character."
733 "Move backward ARG lines and position at first nonblank character."
739 "Move point to the first non-whitespace character on this line."
743 ;; Move back over chars that have whitespace syntax but have the p flag.
747 "Fixup white space between objects around point.
748 Leave one space or none, according to the context."
755 nil
759 "Delete all spaces and tabs around point.
760 If BACKWARD-ONLY is non-nil, only delete them before point."
765 orig-pos
774 "Delete all spaces and tabs around point, leaving one space (or N spaces).
775 If N is negative, delete newlines as well."
792 \f
794 "Move point to the beginning of the buffer.
795 With numeric arg N, put point N/10 of the way from the beginning.
796 If the buffer is narrowed, this command uses the beginning of the
797 accessible part of the buffer.
799 If Transient Mark mode is disabled, leave mark at previous
802 Don't use this command in Lisp programs!
803 \(goto-char (point-min)) is faster."
812 ;; Avoid overflow for large buffer sizes!
820 "Move point to the end of the buffer.
821 With numeric arg N, put point N/10 of the way from the end.
822 If the buffer is narrowed, this command uses the end of the
823 accessible part of the buffer.
825 If Transient Mark mode is disabled, leave mark at previous
828 Don't use this command in Lisp programs!
829 \(goto-char (point-max)) is faster."
836 ;; Avoid overflow for large buffer sizes!
841 ;; If we went to a place in the middle of the buffer,
842 ;; adjust it to the beginning of a line.
845 ;; If the end of the buffer is not already on the screen,
846 ;; then scroll specially to put it near, but not at, the bottom.
851 "Whether single-char deletion commands delete an active region.
852 This has an effect only if Transient Mark mode is enabled, and
853 affects `delete-forward-char' and `delete-backward-char', though
854 not `delete-char'.
856 If the value is the symbol `kill', the active region is killed
857 instead of deleted."
865 "Delete the previous N characters (following if N is negative).
866 If Transient Mark mode is enabled, the mark is active, and N is 1,
867 delete the text in the region and deactivate the mark instead.
868 To disable this, set `delete-active-region' to nil.
870 Optional second arg KILLFLAG, if non-nil, means to kill (save in
871 kill ring) instead of delete. Interactively, N is the prefix
872 arg, and KILLFLAG is set if N is explicitly specified.
874 In Overwrite mode, single character backward deletion may replace
875 tabs with spaces so as to back over columns, unless point is at
876 the end of the line."
881 delete-active-region
883 ;; If a region is active, kill or delete it.
887 ;; In Overwrite mode, maybe untabify while deleting
897 ;; Otherwise, do simple deletion.
901 "Delete the following N characters (previous if N is negative).
902 If Transient Mark mode is enabled, the mark is active, and N is 1,
903 delete the text in the region and deactivate the mark instead.
904 To disable this, set `delete-active-region' to nil.
906 Optional second arg KILLFLAG non-nil means to kill (save in kill
907 ring) instead of delete. Interactively, N is the prefix arg, and
908 KILLFLAG is set if N was explicitly specified."
913 delete-active-region
915 ;; If a region is active, kill or delete it.
919 ;; Otherwise, do simple deletion.
923 "Put point at beginning and mark at end of buffer.
924 You probably should not use this function in Lisp programs;
925 it is usually a mistake for a Lisp function to use any subroutine
926 that uses or sets the mark."
931 \f
933 ;; Counting lines, one way or another.
936 "Goto LINE, counting from line 1 at beginning of buffer.
937 Normally, move point in the current buffer, and leave mark at the
939 move point in the most recently selected other buffer, and switch to it.
941 If there's a number in the buffer at point, it is the default for LINE.
943 This function is usually the wrong thing to use in a Lisp program.
944 What you probably want instead is something like:
945 (goto-char (point-min)) (forward-line (1- N))
946 If at all possible, an even better solution is to use char counts
947 rather than line counts."
951 ;; Look for a default, a number in the buffer at point.
960 ;; Decide if we're switching buffers.
968 ;; Read the argument, offering that number (if any) as default.
971 buffer-prompt
972 default)
973 nil nil t
974 'minibuffer-history
975 default)
976 buffer))))
977 ;; Switch to the desired buffer, one way or another.
982 ;; Leave mark at previous position
984 ;; Move to the specified line number in that buffer.
993 "Print the number of words in the region.
994 When called interactively, the word count is printed in echo area."
1005 count))
1008 "Print number of lines and characters in the region."
1014 "Print the current buffer line number and narrowed line number of point."
1027 "Return number of lines between START and END.
1028 This is usually the number of newlines between them,
1029 but can be one more if START is not equal to END
1030 and the greater of them is not at the start of a line."
1046 done)))
1050 "Return (narrowed) buffer line number at position POS.
1051 If POS is nil, use current buffer location.
1052 Counting starts at (point-min), so the value refers
1053 to the contents of the accessible portion of the buffer."
1063 "Print info on cursor position (on screen and within buffer).
1064 Also describe the character after point, and give its character code
1065 in octal, decimal and hex.
1067 For a non-ASCII multibyte character, also give its encoding in the
1068 buffer's selected coding system if the coding system encodes the
1069 character safely. If the character is encoded into one byte, that
1070 code is shown in hex. If the character is encoded into more than one
1073 In addition, with prefix argument, show details about that character
1074 in *Help* buffer. See also the command `describe-char'."
1082 ;; Avoid overflow from multiplying by 100!
1086 ""
1092 pos total percent beg end col hscroll)
1094 pos total col hscroll))
1096 encoded encoding-msg display-prop under-display)
1103 ;; Check if the character is displayed with some `display'
1104 ;; text property. In that case, set under-display to the
1105 ;; buffer substring covered by that property.
1116 under-display)))
1122 char char char under-display)
1124 char char char under-display display-prop))
1127 char char char
1129 "..."
1133 ;; We show the detailed information about CHAR.
1140 encoding-msg pos total percent beg end col hscroll)
1147 encoding-msg pos total percent col hscroll))))))
1148 \f
1149 ;; Initialize read-expression-map. It is defined at C level.
1159 "The current default value or list of default values in the minibuffer.
1160 The functions `read-from-minibuffer' and `completing-read' bind
1164 "Value for `print-level' while printing value in `eval-expression'.
1165 A value of nil means no limit."
1171 "Value for `print-length' while printing value in `eval-expression'.
1172 A value of nil means no limit."
1178 "If non-nil set `debug-on-error' to t in `eval-expression'.
1179 If nil, don't change the value of `debug-on-error'."
1185 "Format VALUE as a result of evaluated expression.
1186 Return a formatted string which is displayed in the echo area
1187 in addition to the value printed by prin1 in functions which
1188 display the result of expression evaluation."
1201 ;; We define this, rather than making `eval' interactive,
1202 ;; for the sake of completion of names like eval-region, eval-buffer.
1205 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1206 Value is also consed on to front of the variable `values'.
1207 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1208 with prefix argument) means insert the result into the current buffer
1209 instead of printing it in the echo area. Truncates long output
1210 according to the value of the variables `eval-expression-print-length'
1211 and `eval-expression-print-level'.
1213 If `eval-expression-debug-on-error' is non-nil, which is the default,
1214 this command arranges for all errors to enter the debugger."
1218 nil read-expression-map t
1220 current-prefix-arg))
1225 ;; Bind debug-on-error to something unique so that we can
1226 ;; detect when evaled code changes it.
1230 ;; If evaled code has changed the value of debug-on-error,
1231 ;; propagate that change to the global binding.
1247 "Prompting with PROMPT, let user edit COMMAND and eval result.
1248 COMMAND is a Lisp expression. Let user edit that expression in
1249 the minibuffer, then read and evaluate the result."
1256 read-expression-map t
1258 ;; If command was added to command-history as a string,
1259 ;; get rid of that. We want only evaluable expressions there.
1263 ;; If command to be redone does not match front of history,
1264 ;; add it to the history.
1270 "Edit and re-evaluate last complex command, or ARGth from last.
1271 A complex command is one which used the minibuffer.
1272 The command is placed in the minibuffer as a Lisp form for editing.
1273 The result is executed, repeating the command as changed.
1274 If the command has been changed or is not the most recent previous
1275 command it is added to the front of the command history.
1276 You can use the minibuffer history commands \
1278 to get different commands to edit and resubmit."
1281 newcmd)
1293 ;; If command was added to command-history as a
1294 ;; string, get rid of that. We want only
1295 ;; evaluable expressions there.
1299 ;; If command to be redone does not match front of history,
1300 ;; add it to the history.
1309 "Read command name to invoke in `execute-extended-command'."
1314 ;; Get a command name at point in the original buffer
1315 ;; to propose it after M-n.
1319 ;; Read a string, completing from and restricting to the set of
1320 ;; all defined commands. Don't provide any initial input.
1321 ;; Save the command read on the extended-command history list.
1332 ;; This isn't strictly correct if `execute-extended-command'
1333 ;; is bound to anything else (e.g. [menu]).
1334 ;; It could use (key-description (this-single-command-keys)),
1335 ;; but actually a prompt other than "M-x" would be confusing,
1336 ;; because "M-x" is a well-known prompt to read a command
1337 ;; and it serves as a shorthand for "Extended command: ".
1341 \f
1343 "Default minibuffer history list.
1344 This is used for all minibuffer input
1345 except when an alternate history list is specified.
1347 Maximum length of the history list is determined by the value
1350 "Control whether history list elements are expressions or strings.
1351 If the value of this variable equals current minibuffer depth,
1352 they are expressions; otherwise they are strings.
1353 \(That convention is designed to do the right thing for
1360 "Text that was in this minibuffer before any history commands.
1361 This is nil if there have not yet been any history commands
1370 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1374 "Minibuffer history variables for which matching should ignore case.
1375 If a history variable is a member of this list, then the
1377 commands ignore case when searching it, regardless of `case-fold-search'."
1382 "Find the previous history element that matches REGEXP.
1383 \(Previous history elements refer to earlier actions.)
1384 With prefix argument N, search for Nth previous match.
1385 If N is negative, find the next or Nth next match.
1386 Normally, history elements are matched case-insensitively if
1387 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1388 makes the search case-sensitive.
1389 See also `minibuffer-history-case-insensitive-variables'."
1393 nil
1394 minibuffer-local-map
1395 nil
1396 'minibuffer-history-search-history
1398 ;; Use the last regexp specified, by default, if input is empty.
1403 regexp)
1413 ;; On some systems, ignore case for file names.
1415 minibuffer-history-case-insensitive-variables)
1416 t
1417 ;; Respect the user's setting for case-fold-search:
1418 case-fold-search)
1419 nil))
1420 prevpos
1421 match-string
1422 match-offset
1429 "No later matching history item"
1450 next-matching-history-element))
1454 "Find the next history element that matches REGEXP.
1455 \(The next history element refers to a more recent action.)
1456 With prefix argument N, search for Nth next match.
1457 If N is negative, find the previous or Nth previous match.
1458 Normally, history elements are matched case-insensitively if
1459 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1460 makes the search case-sensitive."
1464 nil
1465 minibuffer-local-map
1466 nil
1467 'minibuffer-history-search-history
1469 ;; Use the last regexp specified, by default, if input is empty.
1474 regexp)
1481 "Function run by `goto-history-element' before consuming default values.
1482 This is useful to dynamically add more elements to the list of default values
1483 when `goto-history-element' reaches the end of this list.
1484 Before calling this function `goto-history-element' sets the variable
1485 `minibuffer-default-add-done' to t, so it will call this function only
1486 once. In special cases, when this function needs to be called more
1487 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1491 "When nil, add more elements to the end of the list of default values.
1492 The value nil causes `goto-history-element' to add more elements to
1493 the list of defaults when it reaches the end of this list. It does
1499 "Return a list of all completions without the default value.
1500 This function is used to add all elements of the completion table to
1501 the end of the list of defaults just after the default value."
1504 minibuffer-completion-table
1505 minibuffer-completion-predicate)))
1511 "Puts element of the minibuffer history in the minibuffer.
1512 The argument NABS specifies the absolute history position."
1526 elt minibuffer-returned-to-present)
1538 previous-history-element))
1550 minibuffer-default)))
1562 elt))
1566 "Puts next element of the minibuffer history in the minibuffer.
1567 With argument N, it uses the Nth following element."
1573 "Puts previous element of the minibuffer history in the minibuffer.
1574 With argument N, it uses the Nth previous element."
1580 "Get next history element which completes the minibuffer before the point.
1581 The contents of the minibuffer after the point are deleted, and replaced
1582 by the new completion."
1588 n)
1589 ;; next-matching-history-element always puts us at (point-min).
1590 ;; Move to the position we were at before changing the buffer contents.
1591 ;; This is still sensical, because the text before point has not changed.
1595 "\
1596 Get previous history element which completes the minibuffer before the point.
1597 The contents of the minibuffer after the point are deleted, and replaced
1598 by the new completion."
1602 ;; For compatibility with the old subr of the same name.
1604 "Return the display width of the minibuffer prompt.
1605 Return 0 if current buffer is not a minibuffer."
1606 ;; Return the width of everything before the field at the end of
1607 ;; the buffer; this should be 0 for normal buffers.
1609 \f
1610 ;; isearch minibuffer history
1617 "Set up a minibuffer for using isearch to search the minibuffer history.
1618 Intended to be added to `minibuffer-setup-hook'."
1630 "Clean up the minibuffer after terminating isearch in the minibuffer."
1635 "Return the proper search function, for isearch in minibuffer history."
1642 ;; Use standard functions to search within minibuffer text
1648 found)
1649 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1650 ;; searching forward. Lazy-highlight calls this lambda with the
1651 ;; bound arg, so skip the minibuffer prompt.
1655 ;; 1. First try searching in the initial minibuffer text
1658 noerror)
1659 ;; 2. If the above search fails, start putting next/prev history
1660 ;; elements in the minibuffer successively, and search the string
1661 ;; in them. Do this only when bound is nil (i.e. not while
1662 ;; lazy-highlighting search strings in the current minibuffer text).
1674 ;; After putting the next/prev history element, search
1675 ;; the string in them again, until next-history-element
1676 ;; or previous-history-element raises an error at the
1677 ;; beginning/end of history.
1680 ;; For backward search, don't search
1681 ;; in the minibuffer prompt
1683 noerror)))
1684 ;; Return point of the new search result
1686 ;; Return nil when next(prev)-history-element fails
1690 "Display the minibuffer history search prompt.
1691 If there are no search errors, this function displays an overlay with
1692 the isearch prompt which replaces the original minibuffer prompt.
1693 Otherwise, it displays the standard isearch message returned from
1694 `isearch-message'."
1696 ;; Use standard function `isearch-message' when not in the minibuffer,
1697 ;; or search fails, or has an error (like incomplete regexp).
1698 ;; This function overwrites minibuffer text with isearch message,
1699 ;; so it's possible to see what is wrong in the search string.
1701 ;; Otherwise, put the overlay with the standard isearch prompt over
1702 ;; the initial minibuffer prompt.
1711 ;; And clear any previous isearch message.
1715 "Wrap the minibuffer history search when search fails.
1716 Move point to the first history element for a forward search,
1717 or to the last history element for a backward search."
1719 ;; When `minibuffer-history-isearch-search' fails on reaching the
1720 ;; beginning/end of the history, wrap the search to the first/last
1721 ;; minibuffer history element.
1729 "Save a function restoring the state of minibuffer history search.
1730 Save `minibuffer-history-position' to the additional state parameter
1731 in the search status stack."
1736 "Restore the minibuffer history search state.
1737 Go to the history element by the absolute history position HIST-POS."
1740 \f
1741 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1745 "Table mapping redo records to the corresponding undo one.
1746 A redo record for undo-in-region maps to t.
1756 "Within a run of consecutive undo commands, list remaining to be undone.
1760 "Undo some previous changes.
1761 Repeat this command to undo more changes.
1762 A numeric ARG serves as a repeat count.
1764 In Transient Mark mode when the mark is active, only undo changes within
1766 as an argument limits undo to changes within the current region."
1768 ;; Make last-command indicate for the next command that this was an undo.
1769 ;; That way, another undo will undo more.
1770 ;; If we get to the end of the undo history and get an error,
1771 ;; another undo command will find the undo history empty
1772 ;; and will get another error. To begin undoing the undos,
1773 ;; you must type some other command.
1776 message)
1777 ;; If we get an error in undo-start,
1778 ;; the next command should not be a "consecutive undo".
1779 ;; So set `this-command' to something other than `undo'.
1784 ;; If something (a timer or filter?) changed the buffer
1785 ;; since the previous command, don't continue the undo seq.
1789 ;; If the last undo record made was made by undo
1790 ;; it shows nothing else happened in between.
1797 ;; get rid of initial undo boundary
1799 ;; If we got this far, the next command should be a consecutive undo.
1801 ;; Check to see whether we're hitting a redo record, and if
1802 ;; so, ask the user whether she wants to skip the redo/undo pair.
1809 ;; The equiv entry might point to another redo record if we have done
1810 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1818 ;; Record the fact that the just-generated undo records come from an
1819 ;; undo operation--that is, they are redo records.
1820 ;; In the ordinary case (not within a region), map the redo
1821 ;; record to the following undos.
1822 ;; I don't know how to do that in the undo-in-region case.
1824 ;; Strip any leading undo boundaries there might be, like we do
1825 ;; above when checking.
1829 undo-equiv-table))
1830 ;; Don't specify a position in the undo record for the undo command.
1831 ;; Instead, undoing this should move point to where the change is.
1850 ;; Record what the current undo list says,
1851 ;; so the next command can tell if the buffer was modified in between.
1854 ;; Display a message announcing success.
1859 "Make BUFFER stop keeping undo information.
1860 No argument or nil as argument means do this for the current buffer."
1866 "Undo some previous changes.
1867 Repeat this command to undo more changes.
1868 A numeric ARG serves as a repeat count.
1869 Contrary to `undo', this will not redo a previous undo."
1874 "Non-nil while performing an undo.
1878 "Undo back N undo-boundaries beyond what was already undone recently.
1879 Call `undo-start' to get ready to undo recent changes,
1880 then call `undo-more' one or more times to undo them."
1885 ;; Note: The following, while pulling elements off
1886 ;; `pending-undo-list' will call primitive change functions which
1887 ;; will push more elements onto `buffer-undo-list'.
1892 ;; Deep copy of a list
1894 "Make a copy of undo list LIST."
1900 elt))
1903 "Set `pending-undo-list' to the front of the undo list.
1904 The next call to `undo-more' will undo the most recently made change.
1905 If BEG and END are specified, then only undo elements
1906 that apply to text between BEG and END are used; other undo elements
1907 are ignored. If BEG and END are nil, all undo elements are used."
1913 buffer-undo-list)))
1918 "Return a list of undo elements for the region START to END.
1919 The elements come from `buffer-undo-list', but we keep only
1920 the elements inside this region, and discard those outside this region.
1921 If we find an element that crosses an edge of this region,
1922 we stop and ignore all further elements."
1925 undo-adjusted-markers
1926 some-rejected
1927 undo-elt undo-elt temp-undo-list delta)
1932 ;; This is a "was unmodified" element.
1933 ;; Keep it if we have kept everything thus far.
1940 ;; Don't put two nils together in the list
1954 ;; Loop down the earlier events adjusting their buffer
1955 ;; positions to reflect the fact that a change to the buffer
1956 ;; isn't being undone. We only need to process those element
1957 ;; types which undo-elt-in-region will return as being in
1958 ;; the region since only those types can ever get into the
1959 ;; output
1968 ;; (TEXT . POSITION)
1975 ;; (BEGIN . END)
1980 ;; (nil PROPERTY VALUE BEG . END)
1990 "Determine whether UNDO-ELT falls inside the region START ... END.
1991 If it crosses the edge, we return nil."
1996 t)
1998 nil)
2000 ;; (TEXT . POSITION)
2004 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2005 ;; See if MARKER is inside the region.
2016 ;; (nil PROPERTY VALUE BEG . END)
2021 ;; (BEGIN . END)
2026 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2027 This assumes we have already decided that UNDO-ELT
2028 is not *inside* the region START...END."
2031 ;; (nil PROPERTY VALUE BEG . END)
2036 ;; (BEGIN . END)
2040 ;; Return the first affected buffer position and the delta for an undo element
2041 ;; delta is defined as the change in subsequent buffer positions if we *did*
2042 ;; the undo.
2046 ;; (TEXT . POSITION)
2049 ;; (BEGIN . END)
2056 "If non-nil ask about discarding undo info for the current command.
2057 Normally, Emacs discards the undo info for the current command if
2058 it exceeds `undo-outer-limit'. But if you set this option
2059 non-nil, it asks in the echo area whether to discard the info.
2060 If you answer no, there is a slight risk that Emacs might crash, so
2061 only do it if you really want to undo the command.
2063 This option is mainly intended for debugging. You have to be
2064 careful if you use it for other purposes. Garbage collection is
2065 inhibited while the question is asked, meaning that Emacs might
2066 leak memory. So you should make sure that you do not wait
2067 excessively long before answering the question."
2073 "If non-nil, an extra level of size that's ok in an undo item.
2074 We don't ask the user about truncating the undo list until the
2075 current item gets bigger than this amount.
2080 ;; When the first undo batch in an undo list is longer than
2081 ;; undo-outer-limit, this function gets called to warn the user that
2082 ;; the undo info for the current command was discarded. Garbage
2083 ;; collection is inhibited around the call, so it had better not do a
2084 ;; lot of consing.
2090 ;; Don't ask the question again unless it gets even bigger.
2091 ;; This applies, in particular, if the user quits from the question.
2092 ;; Such a quit quits out of GC, but something else will call GC
2093 ;; again momentarily. It will call this function again,
2094 ;; but we don't want to ask the question again.
2101 t)
2102 nil))
2107 "The undo info was discarded because it exceeded \
2108 `undo-outer-limit'.
2110 This is normal if you executed a command that made a huge change
2111 to the buffer. In that case, to prevent similar problems in the
2112 future, set `undo-outer-limit' to a value that is large enough to
2113 cover the maximum size of normal changes you expect a single
2114 command to make, but not so large that it might exceed the
2115 maximum memory allotted to Emacs.
2117 If you did not execute any such command, the situation is
2118 probably due to a bug and you should report it.
2120 You can disable the popping up of this buffer by adding the entry
2121 \(undo discard-info) to the user option `warning-suppress-types',
2125 t))
2126 \f
2128 "History list for some commands that read shell commands.
2130 Maximum length of the history list is determined by the value
2137 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2138 This buffer is used when `shell-command' or `shell-command-on-region'
2139 is run interactively. A value of nil means that output to stderr and
2146 "Return a list of all commands associated with the current file.
2147 This function is used to add all related commands retrieved by `mailcap'
2148 to the end of the list of defaults just after the default value."
2152 minibuffer-default))
2157 commands))
2167 "Dynamically complete shell command at point."
2179 map)
2183 "Read a shell command from the minibuffer.
2184 The arguments are the same as the ones of `read-from-minibuffer',
2185 except READ and KEYMAP are missing and HIST defaults
2186 to `shell-command-history'."
2192 minibuffer-local-shell-command-map
2193 nil
2195 args)))
2198 "Execute string COMMAND asynchronously in background.
2200 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2201 surrounded by whitespace and executes the command asynchronously.
2202 The output appears in the buffer `*Async Shell Command*'.
2204 In Elisp, you will often be better served by calling `start-process'
2205 directly, since it offers more control and does not impose the use of a
2206 shell (with its need to quote arguments)."
2212 current-prefix-arg
2213 shell-command-default-error-buffer))
2219 "Execute string COMMAND in inferior shell; display output, if any.
2220 With prefix argument, insert the COMMAND's output at point.
2222 If COMMAND ends in ampersand, execute it asynchronously.
2223 The output appears in the buffer `*Async Shell Command*'.
2224 That buffer is in shell mode.
2226 Otherwise, COMMAND is executed synchronously. The output appears in
2227 the buffer `*Shell Command Output*'. If the output is short enough to
2228 display in the echo area (which is determined by the variables
2229 `resize-mini-windows' and `max-mini-window-height'), it is shown
2230 there, but it is nonetheless available in buffer `*Shell Command
2231 Output*' even though that buffer is not automatically displayed.
2233 To specify a coding system for converting non-ASCII characters
2235 before this command.
2237 Noninteractive callers can specify coding systems by binding
2238 `coding-system-for-read' and `coding-system-for-write'.
2240 The optional second argument OUTPUT-BUFFER, if non-nil,
2241 says to put the output in some other buffer.
2242 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2243 If OUTPUT-BUFFER is not a buffer and not nil,
2244 insert output in current buffer. (This cannot be done asynchronously.)
2245 In either case, the buffer is first erased, and the output is
2246 inserted after point (leaving mark after it).
2248 If the command terminates without error, but generates output,
2250 the output can be displayed in the echo area or in its buffer.
2251 If the output is short enough to display in the echo area
2252 \(determined by the variable `max-mini-window-height' if
2253 `resize-mini-windows' is non-nil), it is shown there.
2254 Otherwise,the buffer containing the output is displayed.
2258 of the output.
2260 If there is no output, or if output is inserted in the current buffer,
2261 then `*Shell Command Output*' is deleted.
2263 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2264 or buffer name to which to direct the command's standard error output.
2265 If it is nil, error output is mingled with regular output.
2266 In an interactive call, the variable `shell-command-default-error-buffer'
2267 specifies the value of ERROR-BUFFER.
2269 In Elisp, you will often be better served by calling `call-process' or
2270 `start-process' directly, since it offers more control and does not impose
2271 the use of a shell (with its need to quote arguments)."
2282 current-prefix-arg
2283 shell-command-default-error-buffer))
2284 ;; Look for a handler in case default-directory is a remote file name.
2292 ;; Output goes in current buffer.
2298 temporary-file-directory)))
2299 nil)))
2302 ;; We do not use -f for csh; we will not support broken use of
2303 ;; .cshrcs. Even the BSD csh manual says to use
2304 ;; "if ($?prompt) exit" before things which are not useful
2305 ;; non-interactively. Besides, if someone wants their other
2306 ;; aliases for shell commands then they can still have them.
2310 t)
2311 nil shell-command-switch command)
2318 ;; Do no formatting while reading error file,
2319 ;; because that can run a shell command, and we
2320 ;; don't want that to cause an infinite recursion.
2322 ;; Put point after the inserted errors.
2326 ;; This is like exchange-point-and-mark, but doesn't
2327 ;; activate the mark. It is cleaner to avoid activation,
2328 ;; even though the command loop would deactivate the mark
2329 ;; because we inserted text.
2333 ;; Output goes in a separate buffer.
2334 ;; Preserve the match data in case called from a program.
2337 ;; Command ending with ampersand means asynchronous.
2341 proc)
2342 ;; Remove the ampersand.
2344 ;; If will kill a process, query first.
2352 ;; Setting buffer-read-only to nil doesn't suffice
2353 ;; if some text has a non-nil read-only property,
2354 ;; which comint sometimes adds for prompts.
2360 shell-command-switch command))
2364 ;; Use the comint filter for proper handling of carriage motion
2365 ;; (see `comint-inhibit-carriage-motion'),.
2367 ))
2368 ;; Otherwise, command is executed synchronously.
2370 output-buffer nil error-buffer)))))))
2374 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2375 MESSAGE may be either a string or a buffer.
2377 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2378 the maximum height of the echo area, as defined by `max-mini-window-height'
2379 if `resize-mini-windows' is non-nil.
2381 Returns either the string shown in the echo area, or when a pop-up
2382 buffer is used, the window used to display it.
2384 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2385 name of the buffer used to display it in the case where a pop-up buffer
2386 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2387 string and it is displayed in the echo area, it is not specified whether
2388 the contents are inserted into the buffer anyway.
2390 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2391 and only used if a buffer is displayed."
2393 ;; Trivial case where we can use the echo area
2397 ;; Trivial case where we can just remove single trailing newline
2400 ;; General case
2403 message
2412 0
2416 (<= lines
2420 max-mini-window-height))
2422 max-mini-window-height)
2426 ;; Don't use the echo area if the output buffer is
2427 ;; already dispayed in the selected frame.
2429 ;; Echo area
2435 ;; Buffer
2438 not-this-window frame))))))))
2441 ;; We have a sentinel to prevent insertion of a termination message
2442 ;; in the buffer itself.
2450 &optional output-buffer replace
2451 error-buffer display-error-buffer)
2452 "Execute string COMMAND in inferior shell with region as input.
2453 Normally display output (if any) in temp buffer `*Shell Command Output*';
2454 Prefix arg means replace the region with it. Return the exit code of
2455 COMMAND.
2457 To specify a coding system for converting non-ASCII characters
2459 before this command. By default, the input (from the current buffer)
2460 is encoded in the same coding system that will be used to save the file,
2461 `buffer-file-coding-system'. If the output is going to replace the region,
2462 then it is decoded from that same coding system.
2464 The noninteractive arguments are START, END, COMMAND,
2465 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2466 Noninteractive callers can specify coding systems by binding
2467 `coding-system-for-read' and `coding-system-for-write'.
2469 If the command generates output, the output may be displayed
2470 in the echo area or in a buffer.
2471 If the output is short enough to display in the echo area
2472 \(determined by the variable `max-mini-window-height' if
2473 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2474 it is displayed in the buffer `*Shell Command Output*'. The output
2475 is available in that buffer in both cases.
2477 If there is output and an error, a message about the error
2478 appears at the end of the output.
2480 If there is no output, or if output is inserted in the current buffer,
2481 then `*Shell Command Output*' is deleted.
2483 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2484 that says to put the output in some other buffer.
2485 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2486 If OUTPUT-BUFFER is not a buffer and not nil,
2487 insert output in the current buffer.
2488 In either case, the output is inserted after point (leaving mark after it).
2490 If REPLACE, the optional fifth argument, is non-nil, that means insert
2491 the output in place of text from START to END, putting point and mark
2492 around it.
2494 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2495 or buffer name to which to direct the command's standard error output.
2496 If it is nil, error output is mingled with regular output.
2497 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2498 were any errors. (This is always t, interactively.)
2499 In an interactive call, the variable `shell-command-default-error-buffer'
2500 specifies the value of ERROR-BUFFER."
2504 ;; Do this before calling region-beginning
2505 ;; and region-end, in case subprocess output
2506 ;; relocates them while we are in the minibuffer.
2508 ;; call-interactively recognizes region-beginning and
2509 ;; region-end specially, leaving them in the history.
2511 string
2512 current-prefix-arg
2513 current-prefix-arg
2514 shell-command-default-error-buffer
2515 t)))
2521 temporary-file-directory)))
2522 nil))
2523 exit-status)
2527 ;; Replace specified region with output from command.
2529 ;; Don't muck with mark unless REPLACE says we should.
2536 t)
2537 nil shell-command-switch command))
2538 ;; It is rude to delete a buffer which the command is not using.
2539 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2540 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2541 ;; (kill-buffer shell-buffer)))
2542 ;; Don't muck with mark unless REPLACE says we should.
2544 ;; No prefix argument: put the output in a temp buffer,
2545 ;; replacing its entire contents.
2550 ;; If the input is the same buffer as the output,
2551 ;; delete everything but the specified region,
2552 ;; then replace that region with the output.
2558 shell-file-name t
2561 t)
2562 nil shell-command-switch
2563 command)))
2564 ;; Clear the output buffer, then run the command with
2565 ;; output there.
2576 buffer)
2577 nil shell-command-switch command)))
2578 ;; Report the output.
2588 ;; There's some output, display it
2590 ;; No output; error?
2594 "some error output"
2600 output))
2603 exit-status))
2606 exit-status output))))
2607 ;; Don't kill: there might be useful info in the undo-log.
2608 ;; (kill-buffer buffer)
2609 ))))
2617 ;; Do no formatting while reading error file,
2618 ;; because that can run a shell command, and we
2619 ;; don't want that to cause an infinite recursion.
2621 ;; Put point after the inserted errors.
2626 exit-status))
2629 "Execute shell command COMMAND and return its output as a string."
2632 standard-output
2636 "Process files synchronously in a separate process.
2637 Similar to `call-process', but may invoke a file handler based on
2638 `default-directory'. The current working directory of the
2639 subprocess is `default-directory'.
2641 File names in INFILE and BUFFER are handled normally, but file
2642 names in ARGS should be relative to `default-directory', as they
2643 are passed to the process verbatim. \(This is a difference to
2644 `call-process' which does not support file handlers for INFILE
2645 and BUFFER.\)
2647 Some file handlers might not support all variants, for example
2648 they might behave as if DISPLAY was nil, regardless of the actual
2649 value passed."
2651 lc stderr-file)
2661 display args)
2667 "Whether a call of `process-file' changes remote files.
2669 Per default, this variable is always set to `t', meaning that a
2670 call of `process-file' could potentially change any file on a
2671 remote host. When set to `nil', a file handler could optimize
2672 its behaviour with respect to remote file attributes caching.
2674 This variable should never be changed by `setq'. Instead of, it
2678 "Start a program in a subprocess. Return the process object for it.
2680 Similar to `start-process', but may invoke a file handler based on
2681 `default-directory'. See Info node `(elisp)Magic File Names'.
2683 This handler ought to run PROGRAM, perhaps on the local host,
2684 perhaps on a remote host that corresponds to `default-directory'.
2685 In the latter case, the local part of `default-directory' becomes
2686 the working directory of the process.
2688 PROGRAM and PROGRAM-ARGS might be file names. They are not
2689 objects of file handler invocation. File handlers might not
2690 support pty association, if PROGRAM is nil."
2695 \f
2699 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2700 (define-key map [switch-frame] nil)
2701 (define-key map [?\C-u] 'universal-argument-more)
2702 (define-key map [?-] 'universal-argument-minus)
2703 (define-key map [?0] 'digit-argument)
2704 (define-key map [?1] 'digit-argument)
2705 (define-key map [?2] 'digit-argument)
2706 (define-key map [?3] 'digit-argument)
2707 (define-key map [?4] 'digit-argument)
2708 (define-key map [?5] 'digit-argument)
2709 (define-key map [?6] 'digit-argument)
2710 (define-key map [?7] 'digit-argument)
2711 (define-key map [?8] 'digit-argument)
2712 (define-key map [?9] 'digit-argument)
2713 (define-key map [kp-0] 'digit-argument)
2714 (define-key map [kp-1] 'digit-argument)
2715 (define-key map [kp-2] 'digit-argument)
2716 (define-key map [kp-3] 'digit-argument)
2717 (define-key map [kp-4] 'digit-argument)
2718 (define-key map [kp-5] 'digit-argument)
2719 (define-key map [kp-6] 'digit-argument)
2720 (define-key map [kp-7] 'digit-argument)
2721 (define-key map [kp-8] 'digit-argument)
2722 (define-key map [kp-9] 'digit-argument)
2723 (define-key map [kp-subtract] 'universal-argument-minus)
2724 map)
2727 (defvar universal-argument-num-events nil
2728 "Number of argument-specifying events read by `universal-argument'.
2729 `universal-argument-other-key' uses this to discard those events
2730 from (this-command-keys), and reread only the final command.")
2732 (defvar overriding-map-is-bound nil
2733 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2735 (defvar saved-overriding-map nil
2736 "The saved value of `overriding-terminal-local-map'.
2740 (defun ensure-overriding-map-is-bound ()
2741 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2742 (unless overriding-map-is-bound
2743 (setq saved-overriding-map overriding-terminal-local-map)
2744 (setq overriding-terminal-local-map universal-argument-map)
2745 (setq overriding-map-is-bound t)))
2747 (defun restore-overriding-map ()
2748 "Restore `overriding-terminal-local-map' to its saved value."
2749 (setq overriding-terminal-local-map saved-overriding-map)
2750 (setq overriding-map-is-bound nil))
2752 (defun universal-argument ()
2753 "Begin a numeric argument for the following command.
2758 multiplies the argument by 4 each time.
2760 which is different in effect from any particular numeric argument.
2762 (interactive)
2763 (setq prefix-arg (list 4))
2764 (setq universal-argument-num-events (length (this-command-keys)))
2765 (ensure-overriding-map-is-bound))
2767 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2768 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2769 (defun universal-argument-more (arg)
2770 (interactive "P")
2771 (if (consp arg)
2772 (setq prefix-arg (list (* 4 (car arg))))
2773 (if (eq arg '-)
2774 (setq prefix-arg (list -4))
2775 (setq prefix-arg arg)
2776 (restore-overriding-map)))
2777 (setq universal-argument-num-events (length (this-command-keys))))
2779 (defun negative-argument (arg)
2780 "Begin a negative numeric argument for the next command.
2782 (interactive "P")
2783 (cond ((integerp arg)
2784 (setq prefix-arg (- arg)))
2785 ((eq arg '-)
2786 (setq prefix-arg nil))
2787 (t
2788 (setq prefix-arg '-)))
2789 (setq universal-argument-num-events (length (this-command-keys)))
2790 (ensure-overriding-map-is-bound))
2792 (defun digit-argument (arg)
2793 "Part of the numeric argument for the next command.
2795 (interactive "P")
2796 (let* ((char (if (integerp last-command-event)
2797 last-command-event
2798 (get last-command-event 'ascii-character)))
2800 (cond ((integerp arg)
2801 (setq prefix-arg (+ (* arg 10)
2802 (if (< arg 0) (- digit) digit))))
2803 ((eq arg '-)
2804 ;; Treat -0 as just -, so that -01 will work.
2805 (setq prefix-arg (if (zerop digit) '- (- digit))))
2806 (t
2807 (setq prefix-arg digit))))
2808 (setq universal-argument-num-events (length (this-command-keys)))
2809 (ensure-overriding-map-is-bound))
2811 ;; For backward compatibility, minus with no modifiers is an ordinary
2812 ;; command if digits have already been entered.
2813 (defun universal-argument-minus (arg)
2814 (interactive "P")
2815 (if (integerp arg)
2816 (universal-argument-other-key arg)
2817 (negative-argument arg)))
2819 ;; Anything else terminates the argument and is left in the queue to be
2820 ;; executed as a command.
2821 (defun universal-argument-other-key (arg)
2822 (interactive "P")
2823 (setq prefix-arg arg)
2824 (let* ((key (this-command-keys))
2825 (keylist (listify-key-sequence key)))
2826 (setq unread-command-events
2827 (append (nthcdr universal-argument-num-events keylist)
2828 unread-command-events)))
2829 (reset-this-command-lengths)
2830 (restore-overriding-map))
2831 \f
2832 ;; This function is here rather than in subr.el because it uses CL.
2833 (defmacro with-wrapper-hook (var args &rest body)
2834 "Run BODY wrapped with the VAR hook.
2835 VAR is a special hook: its functions are called with a first argument
2837 the original function, or call it any number of times (including not calling
2838 it at all). This is similar to an `around' advice.
2839 VAR is normally a symbol (a variable) in which case it is treated like
2840 a hook, with a buffer-local and a global part. But it can also be an
2841 arbitrary expression.
2842 ARGS is a list of variables which will be passed as additional arguments
2843 to each function, after the initial argument, and which the first argument
2844 expects to receive when called."
2845 (declare (indent 2) (debug t))
2846 ;; We need those two gensyms because CL's lexical scoping is not available
2847 ;; for function arguments :-(
2848 (let ((funs (make-symbol "funs"))
2849 (global (make-symbol "global"))
2850 (argssym (make-symbol "args")))
2851 ;; Since the hook is a wrapper, the loop has to be done via
2852 ;; recursion: a given hook function will call its parameter in order to
2853 ;; continue looping.
2854 `(labels ((runrestofhook (,funs ,global ,argssym)
2855 ;; `funs' holds the functions left on the hook and `global'
2856 ;; holds the functions left on the global part of the hook
2857 ;; (in case the hook is local).
2858 (lexical-let ((funs ,funs)
2859 (global ,global))
2860 (if (consp funs)
2861 (if (eq t (car funs))
2862 (runrestofhook
2863 (append global (cdr funs)) nil ,argssym)
2864 (apply (car funs)
2865 (lambda (&rest ,argssym)
2866 (runrestofhook (cdr funs) global ,argssym))
2867 ,argssym))
2868 ;; Once there are no more functions on the hook, run
2869 ;; the original body.
2870 (apply (lambda ,args ,@body) ,argssym)))))
2871 (runrestofhook ,var
2872 ;; The global part of the hook, if any.
2873 ,(if (symbolp var)
2874 `(if (local-variable-p ',var)
2875 (default-value ',var)))
2876 (list ,@args)))))
2878 (defvar filter-buffer-substring-functions nil
2879 "Wrapper hook around `filter-buffer-substring'.
2880 The functions on this special hook are called with 4 arguments:
2881 NEXT-FUN BEG END DELETE
2882 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2883 that performs the default operation. The other 3 arguments are like
2884 the ones passed to `filter-buffer-substring'.")
2886 (defvar buffer-substring-filters nil
2887 "List of filter functions for `filter-buffer-substring'.
2888 Each function must accept a single argument, a string, and return
2889 a string. The buffer substring is passed to the first function
2890 in the list, and the return value of each function is passed to
2891 the next. The return value of the last function is used as the
2892 return value of `filter-buffer-substring'.
2894 If this variable is nil, no filtering is performed.")
2895 (make-obsolete-variable 'buffer-substring-filters
2896 'filter-buffer-substring-functions "24.1")
2898 (defun filter-buffer-substring (beg end &optional delete)
2899 "Return the buffer substring between BEG and END, after filtering.
2900 The filtering is performed by `filter-buffer-substring-functions'.
2902 If DELETE is non-nil, the text between BEG and END is deleted
2903 from the buffer.
2905 This function should be used instead of `buffer-substring',
2906 `buffer-substring-no-properties', or `delete-and-extract-region'
2907 when you want to allow filtering to take place. For example,
2908 major or minor modes can use `filter-buffer-substring-functions' to
2909 extract characters that are special to a buffer, and should not
2910 be copied into other buffers."
2911 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2912 (cond
2913 ((or delete buffer-substring-filters)
2914 (save-excursion
2915 (goto-char beg)
2916 (let ((string (if delete (delete-and-extract-region beg end)
2917 (buffer-substring beg end))))
2918 (dolist (filter buffer-substring-filters)
2919 (setq string (funcall filter string)))
2920 string)))
2921 (t
2922 (buffer-substring beg end)))))
2925 ;;;; Window system cut and paste hooks.
2927 (defvar interprogram-cut-function nil
2928 "Function to call to make a killed region available to other programs.
2930 Most window systems provide some sort of facility for cutting and
2931 pasting text between the windows of different programs.
2932 This variable holds a function that Emacs calls whenever text
2933 is put in the kill ring, to make the new kill available to other
2934 programs.
2936 The function takes one argument, TEXT, which is a string containing
2937 the text which should be made available.")
2939 (defvar interprogram-paste-function nil
2940 "Function to call to get text cut from other programs.
2942 Most window systems provide some sort of facility for cutting and
2943 pasting text between the windows of different programs.
2944 This variable holds a function that Emacs calls to obtain
2945 text that other programs have provided for pasting.
2947 The function should be called with no arguments. If the function
2948 returns nil, then no other program has provided such text, and the top
2949 of the Emacs kill ring should be used. If the function returns a
2950 string, then the caller of the function \(usually `current-kill')
2951 should put this string in the kill ring as the latest kill.
2953 This function may also return a list of strings if the window
2954 system supports multiple selections. The first string will be
2955 used as the pasted text, but the other will be placed in the
2956 kill ring for easy access via `yank-pop'.
2958 Note that the function should return a string only if a program other
2959 than Emacs has provided a string for pasting; if Emacs provided the
2960 most recent string, the function should return nil. If it is
2961 difficult to tell whether Emacs or some other program provided the
2962 current string, it is probably good enough to return nil if the string
2963 is equal (according to `string=') to the last text Emacs provided.")
2964 \f
2967 ;;;; The kill ring data structure.
2969 (defvar kill-ring nil
2970 "List of killed text sequences.
2971 Since the kill ring is supposed to interact nicely with cut-and-paste
2972 facilities offered by window systems, use of this variable should
2973 interact nicely with `interprogram-cut-function' and
2974 `interprogram-paste-function'. The functions `kill-new',
2975 `kill-append', and `current-kill' are supposed to implement this
2976 interaction; you may want to use them instead of manipulating the kill
2977 ring directly.")
2979 (defcustom kill-ring-max 60
2980 "Maximum length of kill ring before oldest elements are thrown away."
2981 :type 'integer
2982 :group 'killing)
2984 (defvar kill-ring-yank-pointer nil
2985 "The tail of the kill ring whose car is the last thing yanked.")
2987 (defcustom save-interprogram-paste-before-kill nil
2988 "Save clipboard strings into kill ring before replacing them.
2989 When one selects something in another program to paste it into Emacs,
2990 but kills something in Emacs before actually pasting it,
2991 this selection is gone unless this variable is non-nil,
2992 in which case the other program's selection is saved in the `kill-ring'
2994 :type 'boolean
2995 :group 'killing
2996 :version "23.2")
2998 (defcustom kill-do-not-save-duplicates nil
2999 "Do not add a new string to `kill-ring' when it is the same as the last one."
3000 :type 'boolean
3001 :group 'killing
3002 :version "23.2")
3004 (defun kill-new (string &optional replace yank-handler)
3005 "Make STRING the latest kill in the kill ring.
3006 Set `kill-ring-yank-pointer' to point to it.
3007 If `interprogram-cut-function' is non-nil, apply it to STRING.
3008 Optional second argument REPLACE non-nil means that STRING will replace
3009 the front of the kill ring, rather than being added to the list.
3011 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3012 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3013 STRING.
3015 When the yank handler has a non-nil PARAM element, the original STRING
3016 argument is not used by `insert-for-yank'. However, since Lisp code
3017 may access and use elements from the kill ring directly, the STRING
3019 (if (> (length string) 0)
3020 (if yank-handler
3021 (put-text-property 0 (length string)
3022 'yank-handler yank-handler string))
3023 (if yank-handler
3024 (signal 'args-out-of-range
3025 (list string "yank-handler specified for empty string"))))
3026 (unless (and kill-do-not-save-duplicates
3027 (equal string (car kill-ring)))
3028 (if (fboundp 'menu-bar-update-yank-menu)
3029 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3030 (when save-interprogram-paste-before-kill
3031 (let ((interprogram-paste (and interprogram-paste-function
3032 (funcall interprogram-paste-function))))
3033 (when interprogram-paste
3034 (dolist (s (if (listp interprogram-paste)
3035 (nreverse interprogram-paste)
3036 (list interprogram-paste)))
3037 (unless (and kill-do-not-save-duplicates
3038 (equal s (car kill-ring)))
3039 (push s kill-ring))))))
3040 (unless (and kill-do-not-save-duplicates
3041 (equal string (car kill-ring)))
3042 (if (and replace kill-ring)
3043 (setcar kill-ring string)
3044 (push string kill-ring)
3045 (if (> (length kill-ring) kill-ring-max)
3046 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3047 (setq kill-ring-yank-pointer kill-ring)
3048 (if interprogram-cut-function
3049 (funcall interprogram-cut-function string)))
3050 (set-advertised-calling-convention
3051 'kill-new '(string &optional replace) "23.3")
3053 (defun kill-append (string before-p &optional yank-handler)
3054 "Append STRING to the end of the latest kill in the kill ring.
3055 If BEFORE-P is non-nil, prepend STRING to the kill.
3056 If `interprogram-cut-function' is set, pass the resulting kill to it."
3057 (let* ((cur (car kill-ring)))
3058 (kill-new (if before-p (concat string cur) (concat cur string))
3059 (or (= (length cur) 0)
3060 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3061 yank-handler)))
3062 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3064 (defcustom yank-pop-change-selection nil
3065 "If non-nil, rotating the kill ring changes the window system selection."
3066 :type 'boolean
3067 :group 'killing
3068 :version "23.1")
3070 (defun current-kill (n &optional do-not-move)
3071 "Rotate the yanking point by N places, and then return that kill.
3072 If N is zero, `interprogram-paste-function' is set, and calling
3073 it returns a string or list of strings, then that string (or
3074 list) is added to the front of the kill ring and the string (or
3075 first string in the list) is returned as the latest kill.
3077 If N is not zero, and if `yank-pop-change-selection' is
3078 non-nil, use `interprogram-cut-function' to transfer the
3079 kill at the new yank point into the window system selection.
3081 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3082 move the yanking point; just return the Nth kill forward."
3084 (let ((interprogram-paste (and (= n 0)
3085 interprogram-paste-function
3086 (funcall interprogram-paste-function))))
3087 (if interprogram-paste
3088 (progn
3089 ;; Disable the interprogram cut function when we add the new
3090 ;; text to the kill ring, so Emacs doesn't try to own the
3091 ;; selection, with identical text.
3092 (let ((interprogram-cut-function nil))
3093 (if (listp interprogram-paste)
3094 (mapc 'kill-new (nreverse interprogram-paste))
3095 (kill-new interprogram-paste)))
3096 (car kill-ring))
3097 (or kill-ring (error "Kill ring is empty"))
3098 (let ((ARGth-kill-element
3099 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3100 (length kill-ring))
3101 kill-ring)))
3102 (unless do-not-move
3103 (setq kill-ring-yank-pointer ARGth-kill-element)
3104 (when (and yank-pop-change-selection
3105 (> n 0)
3106 interprogram-cut-function)
3107 (funcall interprogram-cut-function (car ARGth-kill-element))))
3108 (car ARGth-kill-element)))))
3112 ;;;; Commands for manipulating the kill ring.
3114 (defcustom kill-read-only-ok nil
3115 "Non-nil means don't signal an error for killing read-only text."
3116 :type 'boolean
3117 :group 'killing)
3119 (put 'text-read-only 'error-conditions
3120 '(text-read-only buffer-read-only error))
3121 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3123 (defun kill-region (beg end &optional yank-handler)
3125 This deletes the text from the buffer and saves it in the kill ring.
3129 If you want to append the killed region to the last killed text,
3132 If the buffer is read-only, Emacs will beep and refrain from deleting
3133 the text, but put the text in the kill ring anyway. This means that
3134 you can use the killing commands to copy text from a read-only buffer.
3136 Lisp programs should use this function for killing text.
3137 (To delete text, use `delete-region'.)
3138 Supply two arguments, character positions indicating the stretch of text
3139 to be killed.
3141 If the previous command was also a kill command,
3142 the text killed this time appends to the text killed last time
3143 to make one entry in the kill ring."
3144 ;; Pass point first, then mark, because the order matters
3145 ;; when calling kill-append.
3146 (interactive (list (point) (mark)))
3147 (unless (and beg end)
3148 (error "The mark is not set now, so there is no region"))
3149 (condition-case nil
3150 (let ((string (filter-buffer-substring beg end t)))
3151 (when string ;STRING is nil if BEG = END
3152 ;; Add that string to the kill ring, one way or another.
3153 (if (eq last-command 'kill-region)
3154 (kill-append string (< end beg) yank-handler)
3155 (kill-new string nil yank-handler)))
3156 (when (or string (eq last-command 'kill-region))
3157 (setq this-command 'kill-region))
3158 nil)
3159 ((buffer-read-only text-read-only)
3160 ;; The code above failed because the buffer, or some of the characters
3161 ;; in the region, are read-only.
3162 ;; We should beep, in case the user just isn't aware of this.
3163 ;; However, there's no harm in putting
3164 ;; the region's text in the kill ring, anyway.
3165 (copy-region-as-kill beg end)
3166 ;; Set this-command now, so it will be set even if we get an error.
3167 (setq this-command 'kill-region)
3168 ;; This should barf, if appropriate, and give us the correct error.
3169 (if kill-read-only-ok
3170 (progn (message "Read only text copied to kill ring") nil)
3171 ;; Signal an error if the buffer is read-only.
3172 (barf-if-buffer-read-only)
3173 ;; If the buffer isn't read-only, the text is.
3174 (signal 'text-read-only (list (current-buffer)))))))
3175 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3177 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3178 ;; to get two copies of the text when the user accidentally types M-w and
3179 ;; then corrects it with the intended C-w.
3180 (defun copy-region-as-kill (beg end)
3181 "Save the region as if killed, but don't kill it.
3182 In Transient Mark mode, deactivate the mark.
3183 If `interprogram-cut-function' is non-nil, also save the text for a window
3184 system cut and paste.
3186 This command's old key binding has been given to `kill-ring-save'."
3187 (interactive "r")
3188 (if (eq last-command 'kill-region)
3189 (kill-append (filter-buffer-substring beg end) (< end beg))
3190 (kill-new (filter-buffer-substring beg end)))
3191 (setq deactivate-mark t)
3192 nil)
3194 (defun kill-ring-save (beg end)
3195 "Save the region as if killed, but don't kill it.
3196 In Transient Mark mode, deactivate the mark.
3197 If `interprogram-cut-function' is non-nil, also save the text for a window
3198 system cut and paste.
3200 If you want to append the killed line to the last killed text,
3203 This command is similar to `copy-region-as-kill', except that it gives
3204 visual feedback indicating the extent of the region being copied."
3205 (interactive "r")
3206 (copy-region-as-kill beg end)
3207 ;; This use of called-interactively-p is correct
3208 ;; because the code it controls just gives the user visual feedback.
3209 (if (called-interactively-p 'interactive)
3210 (let ((other-end (if (= (point) beg) end beg))
3211 (opoint (point))
3212 ;; Inhibit quitting so we can make a quit here
3213 ;; look like a C-g typed as a command.
3214 (inhibit-quit t))
3215 (if (pos-visible-in-window-p other-end (selected-window))
3216 ;; Swap point-and-mark quickly so as to show the region that
3217 ;; was selected. Don't do it if the region is highlighted.
3218 (unless (and (region-active-p)
3219 (face-background 'region))
3220 ;; Swap point and mark.
3221 (set-marker (mark-marker) (point) (current-buffer))
3222 (goto-char other-end)
3223 (sit-for blink-matching-delay)
3224 ;; Swap back.
3225 (set-marker (mark-marker) other-end (current-buffer))
3226 (goto-char opoint)
3227 ;; If user quit, deactivate the mark
3228 ;; as C-g would as a command.
3229 (and quit-flag mark-active
3230 (deactivate-mark)))
3231 (let* ((killed-text (current-kill 0))
3232 (message-len (min (length killed-text) 40)))
3233 (if (= (point) beg)
3234 ;; Don't say "killed"; that is misleading.
3236 (substring killed-text (- message-len)))
3238 (substring killed-text 0 message-len))))))))
3240 (defun append-next-kill (&optional interactive)
3241 "Cause following command, if it kills, to append to previous kill.
3242 The argument is used for internal purposes; do not supply one."
3243 (interactive "p")
3244 ;; We don't use (interactive-p), since that breaks kbd macros.
3245 (if interactive
3246 (progn
3247 (setq this-command 'kill-region)
3248 (message "If the next command is a kill, it will append"))
3249 (setq last-command 'kill-region)))
3250 \f
3251 ;; Yanking.
3253 ;; This is actually used in subr.el but defcustom does not work there.
3254 (defcustom yank-excluded-properties
3255 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3256 yank-handler follow-link fontified)
3257 "Text properties to discard when yanking.
3258 The value should be a list of text properties to discard or t,
3259 which means to discard all text properties."
3260 :type '(choice (const :tag "All" t) (repeat symbol))
3261 :group 'killing
3262 :version "22.1")
3264 (defvar yank-window-start nil)
3265 (defvar yank-undo-function nil
3266 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3267 Function is called with two parameters, START and END corresponding to
3268 the value of the mark and point; it is guaranteed that START <= END.
3269 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3271 (defun yank-pop (&optional arg)
3272 "Replace just-yanked stretch of killed text with a different stretch.
3273 This command is allowed only immediately after a `yank' or a `yank-pop'.
3274 At such a time, the region contains a stretch of reinserted
3275 previously-killed text. `yank-pop' deletes that text and inserts in its
3276 place a different stretch of killed text.
3278 With no argument, the previous kill is inserted.
3279 With argument N, insert the Nth previous kill.
3280 If N is negative, this is a more recent kill.
3282 The sequence of kills wraps around, so that after the oldest one
3283 comes the newest one.
3285 When this command inserts killed text into the buffer, it honors
3286 `yank-excluded-properties' and `yank-handler' as described in the
3287 doc string for `insert-for-yank-1', which see."
3288 (interactive "*p")
3289 (if (not (eq last-command 'yank))
3290 (error "Previous command was not a yank"))
3291 (setq this-command 'yank)
3292 (unless arg (setq arg 1))
3293 (let ((inhibit-read-only t)
3294 (before (< (point) (mark t))))
3295 (if before
3296 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3297 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3298 (setq yank-undo-function nil)
3299 (set-marker (mark-marker) (point) (current-buffer))
3300 (insert-for-yank (current-kill arg))
3301 ;; Set the window start back where it was in the yank command,
3302 ;; if possible.
3303 (set-window-start (selected-window) yank-window-start t)
3304 (if before
3305 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3306 ;; It is cleaner to avoid activation, even though the command
3307 ;; loop would deactivate the mark because we inserted text.
3308 (goto-char (prog1 (mark t)
3309 (set-marker (mark-marker) (point) (current-buffer))))))
3310 nil)
3312 (defun yank (&optional arg)
3314 More precisely, reinsert the stretch of killed text most recently
3315 killed OR yanked. Put point at end, and set mark at beginning.
3316 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3317 With argument N, reinsert the Nth most recently killed stretch of killed
3318 text.
3320 When this command inserts killed text into the buffer, it honors
3321 `yank-excluded-properties' and `yank-handler' as described in the
3322 doc string for `insert-for-yank-1', which see.
3325 (interactive "*P")
3326 (setq yank-window-start (window-start))
3327 ;; If we don't get all the way thru, make last-command indicate that
3328 ;; for the following command.
3329 (setq this-command t)
3330 (push-mark (point))
3331 (insert-for-yank (current-kill (cond
3332 ((listp arg) 0)
3333 ((eq arg '-) -2)
3334 (t (1- arg)))))
3335 (if (consp arg)
3336 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3337 ;; It is cleaner to avoid activation, even though the command
3338 ;; loop would deactivate the mark because we inserted text.
3339 (goto-char (prog1 (mark t)
3340 (set-marker (mark-marker) (point) (current-buffer)))))
3341 ;; If we do get all the way thru, make this-command indicate that.
3342 (if (eq this-command t)
3343 (setq this-command 'yank))
3344 nil)
3346 (defun rotate-yank-pointer (arg)
3347 "Rotate the yanking point in the kill ring.
3348 With ARG, rotate that many kills forward (or backward, if negative)."
3349 (interactive "p")
3350 (current-kill arg))
3351 \f
3352 ;; Some kill commands.
3354 ;; Internal subroutine of delete-char
3355 (defun kill-forward-chars (arg)
3356 (if (listp arg) (setq arg (car arg)))
3357 (if (eq arg '-) (setq arg -1))
3358 (kill-region (point) (+ (point) arg)))
3360 ;; Internal subroutine of backward-delete-char
3361 (defun kill-backward-chars (arg)
3362 (if (listp arg) (setq arg (car arg)))
3363 (if (eq arg '-) (setq arg -1))
3364 (kill-region (point) (- (point) arg)))
3366 (defcustom backward-delete-char-untabify-method 'untabify
3367 "The method for untabifying when deleting backward.
3368 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3369 `hungry' -- delete all whitespace, both tabs and spaces;
3370 `all' -- delete all whitespace, including tabs, spaces and newlines;
3371 nil -- just delete one character."
3372 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3373 :version "20.3"
3374 :group 'killing)
3376 (defun backward-delete-char-untabify (arg &optional killp)
3377 "Delete characters backward, changing tabs into spaces.
3378 The exact behavior depends on `backward-delete-char-untabify-method'.
3379 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3380 Interactively, ARG is the prefix arg (default 1)
3381 and KILLP is t if a prefix arg was specified."
3383 (when (eq backward-delete-char-untabify-method 'untabify)
3384 (let ((count arg))
3385 (save-excursion
3386 (while (and (> count 0) (not (bobp)))
3388 (let ((col (current-column)))
3389 (forward-char -1)
3390 (setq col (- col (current-column)))
3391 (insert-char ?\s col)
3392 (delete-char 1)))
3393 (forward-char -1)
3394 (setq count (1- count))))))
3396 ((eq backward-delete-char-untabify-method 'all)
3398 (n (if skip
3399 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3400 (point)))))
3401 (+ arg (if (zerop wh) 0 (1- wh))))
3402 arg)))
3403 ;; Avoid warning about delete-backward-char
3404 (with-no-warnings (delete-backward-char n killp))))
3406 (defun zap-to-char (arg char)
3407 "Kill up to and including ARGth occurrence of CHAR.
3408 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3409 Goes backward if ARG is negative; error if CHAR not found."
3411 ;; Avoid "obsolete" warnings for translation-table-for-input.
3412 (with-no-warnings
3413 (if (char-table-p translation-table-for-input)
3414 (setq char (or (aref translation-table-for-input char) char))))
3415 (kill-region (point) (progn
3416 (search-forward (char-to-string char) nil nil arg)
3417 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3418 (point))))
3420 ;; kill-line and its subroutines.
3422 (defcustom kill-whole-line nil
3423 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3424 :type 'boolean
3425 :group 'killing)
3427 (defun kill-line (&optional arg)
3428 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3429 With prefix argument ARG, kill that many lines from point.
3430 Negative arguments kill lines backward.
3431 With zero argument, kills the text before point on the current line.
3434 a number counts as a prefix arg.
3436 To kill a whole line, when point is not at the beginning, type \
3439 If `kill-whole-line' is non-nil, then this command kills the whole line
3440 including its terminating newline, when used at the beginning of a line
3441 with no argument. As a consequence, you can always kill a whole line
3444 If you want to append the killed line to the last killed text,
3447 If the buffer is read-only, Emacs will beep and refrain from deleting
3448 the line, but put the line in the kill ring anyway. This means that
3449 you can use this command to copy text from a read-only buffer.
3450 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3451 even beep.)"
3452 (interactive "P")
3453 (kill-region (point)
3454 ;; It is better to move point to the other end of the kill
3455 ;; before killing. That way, in a read-only buffer, point
3456 ;; moves across the text that is copied to the kill ring.
3457 ;; The choice has no effect on undo now that undo records
3458 ;; the value of point from before the command was run.
3459 (progn
3460 (if arg
3461 (forward-visible-line (prefix-numeric-value arg))
3462 (if (eobp)
3463 (signal 'end-of-buffer nil))
3464 (let ((end
3465 (save-excursion
3466 (end-of-visible-line) (point))))
3467 (if (or (save-excursion
3468 ;; If trailing whitespace is visible,
3469 ;; don't treat it as nothing.
3470 (unless show-trailing-whitespace
3472 (= (point) end))
3473 (and kill-whole-line (bolp)))
3474 (forward-visible-line 1)
3475 (goto-char end))))
3476 (point))))
3478 (defun kill-whole-line (&optional arg)
3479 "Kill current line.
3480 With prefix ARG, kill that many lines starting from the current line.
3481 If ARG is negative, kill backward. Also kill the preceding newline.
3483 If ARG is zero, kill current line but exclude the trailing newline."
3484 (interactive "p")
3485 (or arg (setq arg 1))
3486 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3487 (signal 'end-of-buffer nil))
3488 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3489 (signal 'beginning-of-buffer nil))
3490 (unless (eq last-command 'kill-region)
3491 (kill-new "")
3492 (setq last-command 'kill-region))
3493 (cond ((zerop arg)
3494 ;; We need to kill in two steps, because the previous command
3495 ;; could have been a kill command, in which case the text
3496 ;; before point needs to be prepended to the current kill
3497 ;; ring entry and the text after point appended. Also, we
3498 ;; need to use save-excursion to avoid copying the same text
3499 ;; twice to the kill ring in read-only buffers.
3500 (save-excursion
3501 (kill-region (point) (progn (forward-visible-line 0) (point))))
3502 (kill-region (point) (progn (end-of-visible-line) (point))))
3503 ((< arg 0)
3504 (save-excursion
3505 (kill-region (point) (progn (end-of-visible-line) (point))))
3506 (kill-region (point)
3507 (progn (forward-visible-line (1+ arg))
3508 (unless (bobp) (backward-char))
3509 (point))))
3510 (t
3511 (save-excursion
3512 (kill-region (point) (progn (forward-visible-line 0) (point))))
3513 (kill-region (point)
3514 (progn (forward-visible-line arg) (point))))))
3516 (defun forward-visible-line (arg)
3517 "Move forward by ARG lines, ignoring currently invisible newlines only.
3518 If ARG is negative, move backward -ARG lines.
3519 If ARG is zero, move to the beginning of the current line."
3520 (condition-case nil
3521 (if (> arg 0)
3522 (progn
3523 (while (> arg 0)
3524 (or (zerop (forward-line 1))
3525 (signal 'end-of-buffer nil))
3526 ;; If the newline we just skipped is invisible,
3527 ;; don't count it.
3528 (let ((prop
3529 (get-char-property (1- (point)) 'invisible)))
3530 (if (if (eq buffer-invisibility-spec t)
3531 prop
3532 (or (memq prop buffer-invisibility-spec)
3533 (assq prop buffer-invisibility-spec)))
3534 (setq arg (1+ arg))))
3535 (setq arg (1- arg)))
3536 ;; If invisible text follows, and it is a number of complete lines,
3537 ;; skip it.
3538 (let ((opoint (point)))
3539 (while (and (not (eobp))
3540 (let ((prop
3541 (get-char-property (point) 'invisible)))
3542 (if (eq buffer-invisibility-spec t)
3543 prop
3544 (or (memq prop buffer-invisibility-spec)
3545 (assq prop buffer-invisibility-spec)))))
3546 (goto-char
3547 (if (get-text-property (point) 'invisible)
3548 (or (next-single-property-change (point) 'invisible)
3549 (point-max))
3550 (next-overlay-change (point)))))
3551 (unless (bolp)
3552 (goto-char opoint))))
3553 (let ((first t))
3554 (while (or first (<= arg 0))
3555 (if first
3556 (beginning-of-line)
3557 (or (zerop (forward-line -1))
3558 (signal 'beginning-of-buffer nil)))
3559 ;; If the newline we just moved to is invisible,
3560 ;; don't count it.
3561 (unless (bobp)
3562 (let ((prop
3563 (get-char-property (1- (point)) 'invisible)))
3564 (unless (if (eq buffer-invisibility-spec t)
3565 prop
3566 (or (memq prop buffer-invisibility-spec)
3567 (assq prop buffer-invisibility-spec)))
3568 (setq arg (1+ arg)))))
3569 (setq first nil))
3570 ;; If invisible text follows, and it is a number of complete lines,
3571 ;; skip it.
3572 (let ((opoint (point)))
3573 (while (and (not (bobp))
3574 (let ((prop
3575 (get-char-property (1- (point)) 'invisible)))
3576 (if (eq buffer-invisibility-spec t)
3577 prop
3578 (or (memq prop buffer-invisibility-spec)
3579 (assq prop buffer-invisibility-spec)))))
3580 (goto-char
3581 (if (get-text-property (1- (point)) 'invisible)
3582 (or (previous-single-property-change (point) 'invisible)
3583 (point-min))
3584 (previous-overlay-change (point)))))
3585 (unless (bolp)
3586 (goto-char opoint)))))
3587 ((beginning-of-buffer end-of-buffer)
3588 nil)))
3590 (defun end-of-visible-line ()
3591 "Move to end of current visible line."
3592 (end-of-line)
3593 ;; If the following character is currently invisible,
3594 ;; skip all characters with that same `invisible' property value,
3595 ;; then find the next newline.
3596 (while (and (not (eobp))
3597 (save-excursion
3599 (let ((prop
3600 (get-char-property (point) 'invisible)))
3601 (if (eq buffer-invisibility-spec t)
3602 prop
3603 (or (memq prop buffer-invisibility-spec)
3604 (assq prop buffer-invisibility-spec))))))
3606 (if (get-text-property (point) 'invisible)
3607 (goto-char (next-single-property-change (point) 'invisible))
3608 (goto-char (next-overlay-change (point))))
3609 (end-of-line)))
3610 \f
3611 (defun insert-buffer (buffer)
3612 "Insert after point the contents of BUFFER.
3613 Puts mark after the inserted text.
3614 BUFFER may be a buffer or a buffer name.
3616 This function is meant for the user to run interactively.
3617 Don't call it from programs: use `insert-buffer-substring' instead!"
3618 (interactive
3619 (list
3620 (progn
3621 (barf-if-buffer-read-only)
3622 (read-buffer "Insert buffer: "
3623 (if (eq (selected-window) (next-window (selected-window)))
3624 (other-buffer (current-buffer))
3625 (window-buffer (next-window (selected-window))))
3626 t))))
3627 (push-mark
3628 (save-excursion
3629 (insert-buffer-substring (get-buffer buffer))
3630 (point)))
3631 nil)
3633 (defun append-to-buffer (buffer start end)
3634 "Append to specified buffer the text of the region.
3635 It is inserted into that buffer before its point.
3637 When calling from a program, give three arguments:
3638 BUFFER (or buffer name), START and END.
3639 START and END specify the portion of the current buffer to be copied."
3640 (interactive
3641 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3642 (region-beginning) (region-end)))
3643 (let* ((oldbuf (current-buffer))
3644 (append-to (get-buffer-create buffer))
3645 (windows (get-buffer-window-list append-to t t))
3646 point)
3647 (save-excursion
3648 (with-current-buffer append-to
3649 (setq point (point))
3650 (barf-if-buffer-read-only)
3651 (insert-buffer-substring oldbuf start end)
3652 (dolist (window windows)
3653 (when (= (window-point window) point)
3654 (set-window-point window (point))))))))
3656 (defun prepend-to-buffer (buffer start end)
3657 "Prepend to specified buffer the text of the region.
3658 It is inserted into that buffer after its point.
3660 When calling from a program, give three arguments:
3661 BUFFER (or buffer name), START and END.
3662 START and END specify the portion of the current buffer to be copied."
3664 (let ((oldbuf (current-buffer)))
3665 (with-current-buffer (get-buffer-create buffer)
3666 (barf-if-buffer-read-only)
3667 (save-excursion
3668 (insert-buffer-substring oldbuf start end)))))
3670 (defun copy-to-buffer (buffer start end)
3671 "Copy to specified buffer the text of the region.
3672 It is inserted into that buffer, replacing existing text there.
3674 When calling from a program, give three arguments:
3675 BUFFER (or buffer name), START and END.
3676 START and END specify the portion of the current buffer to be copied."
3678 (let ((oldbuf (current-buffer)))
3679 (with-current-buffer (get-buffer-create buffer)
3680 (barf-if-buffer-read-only)
3681 (erase-buffer)
3682 (save-excursion
3683 (insert-buffer-substring oldbuf start end)))))
3684 \f
3685 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3686 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3688 (defvar activate-mark-hook nil
3689 "Hook run when the mark becomes active.
3690 It is also run at the end of a command, if the mark is active and
3691 it is possible that the region may have changed.")
3693 (defvar deactivate-mark-hook nil
3694 "Hook run when the mark becomes inactive.")
3696 (defun mark (&optional force)
3697 "Return this buffer's mark value as integer, or nil if never set.
3699 In Transient Mark mode, this function signals an error if
3700 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3701 or the argument FORCE is non-nil, it disregards whether the mark
3702 is active, and returns an integer or nil in the usual way.
3704 If you are using this in an editing command, you are most likely making
3705 a mistake; see the documentation of `set-mark'."
3706 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3707 (marker-position (mark-marker))
3708 (signal 'mark-inactive nil)))
3710 (defsubst deactivate-mark (&optional force)
3711 "Deactivate the mark by setting `mark-active' to nil.
3712 Unless FORCE is non-nil, this function does nothing if Transient
3713 Mark mode is disabled.
3714 This function also runs `deactivate-mark-hook'."
3715 (when (or transient-mark-mode force)
3716 (when (and (if (eq select-active-regions 'only)
3717 (eq (car-safe transient-mark-mode) 'only)
3718 select-active-regions)
3719 (region-active-p)
3720 (display-selections-p))
3721 ;; The var `saved-region-selection', if non-nil, is the text in
3722 ;; the region prior to the last command modifying the buffer.
3723 ;; Set the selection to that, or to the current region.
3724 (cond (saved-region-selection
3725 (x-set-selection 'PRIMARY saved-region-selection)
3726 (setq saved-region-selection nil))
3727 ((/= (region-beginning) (region-end))
3728 (x-set-selection 'PRIMARY
3729 (buffer-substring-no-properties
3730 (region-beginning)
3731 (region-end))))))
3732 (if (and (null force)
3733 (or (eq transient-mark-mode 'lambda)
3734 (and (eq (car-safe transient-mark-mode) 'only)
3735 (null (cdr transient-mark-mode)))))
3736 ;; When deactivating a temporary region, don't change
3737 ;; `mark-active' or run `deactivate-mark-hook'.
3738 (setq transient-mark-mode nil)
3739 (if (eq (car-safe transient-mark-mode) 'only)
3740 (setq transient-mark-mode (cdr transient-mark-mode)))
3741 (setq mark-active nil)
3742 (run-hooks 'deactivate-mark-hook))))
3744 (defun activate-mark ()
3745 "Activate the mark."
3746 (when (mark t)
3747 (setq mark-active t)
3748 (unless transient-mark-mode
3749 (setq transient-mark-mode 'lambda))))
3751 (defun set-mark (pos)
3752 "Set this buffer's mark to POS. Don't use this function!
3753 That is to say, don't use this function unless you want
3754 the user to see that the mark has moved, and you want the previous
3755 mark position to be lost.
3757 Normally, when a new mark is set, the old one should go on the stack.
3758 This is why most applications should use `push-mark', not `set-mark'.
3760 Novice Emacs Lisp programmers often try to use the mark for the wrong
3761 purposes. The mark saves a location for the user's convenience.
3762 Most editing commands should not alter the mark.
3763 To remember a location for internal use in the Lisp program,
3764 store it in a Lisp variable. Example:
3766 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3768 (if pos
3769 (progn
3770 (setq mark-active t)
3771 (run-hooks 'activate-mark-hook)
3772 (set-marker (mark-marker) pos (current-buffer)))
3773 ;; Normally we never clear mark-active except in Transient Mark mode.
3774 ;; But when we actually clear out the mark value too, we must
3775 ;; clear mark-active in any mode.
3776 (deactivate-mark t)
3777 (set-marker (mark-marker) nil)))
3779 (defcustom use-empty-active-region nil
3781 If nil, region-aware commands treat empty regions as inactive.
3782 If non-nil, region-aware commands treat the region as active as
3783 long as the mark is active, even if the region is empty.
3785 Region-aware commands are those that act on the region if it is
3786 active and Transient Mark mode is enabled, and on the text near
3787 point otherwise."
3788 :type 'boolean
3789 :version "23.1"
3790 :group 'editing-basics)
3792 (defun use-region-p ()
3793 "Return t if the region is active and it is appropriate to act on it.
3794 This is used by commands that act specially on the region under
3795 Transient Mark mode.
3797 The return value is t if Transient Mark mode is enabled and the
3798 mark is active; furthermore, if `use-empty-active-region' is nil,
3799 the region must not be empty. Otherwise, the return value is nil.
3801 For some commands, it may be appropriate to ignore the value of
3802 `use-empty-active-region'; in that case, use `region-active-p'."
3803 (and (region-active-p)
3804 (or use-empty-active-region (> (region-end) (region-beginning)))))
3806 (defun region-active-p ()
3807 "Return t if Transient Mark mode is enabled and the mark is active.
3809 Some commands act specially on the region when Transient Mark
3810 mode is enabled. Usually, such commands should use
3811 `use-region-p' instead of this function, because `use-region-p'
3812 also checks the value of `use-empty-active-region'."
3813 (and transient-mark-mode mark-active))
3815 (defvar mark-ring nil
3816 "The list of former marks of the current buffer, most recent first.")
3817 (make-variable-buffer-local 'mark-ring)
3818 (put 'mark-ring 'permanent-local t)
3820 (defcustom mark-ring-max 16
3821 "Maximum size of mark ring. Start discarding off end if gets this big."
3822 :type 'integer
3823 :group 'editing-basics)
3825 (defvar global-mark-ring nil
3826 "The list of saved global marks, most recent first.")
3828 (defcustom global-mark-ring-max 16
3829 "Maximum size of global mark ring. \
3830 Start discarding off end if gets this big."
3831 :type 'integer
3832 :group 'editing-basics)
3834 (defun pop-to-mark-command ()
3835 "Jump to mark, and pop a new position for mark off the ring.
3836 \(Does not affect global mark ring\)."
3837 (interactive)
3838 (if (null (mark t))
3839 (error "No mark set in this buffer")
3840 (if (= (point) (mark t))
3841 (message "Mark popped"))
3842 (goto-char (mark t))
3843 (pop-mark)))
3845 (defun push-mark-command (arg &optional nomsg)
3846 "Set mark at where point is.
3847 If no prefix ARG and mark is already set there, just activate it.
3848 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3849 (interactive "P")
3850 (let ((mark (marker-position (mark-marker))))
3851 (if (or arg (null mark) (/= mark (point)))
3852 (push-mark nil nomsg t)
3853 (setq mark-active t)
3854 (run-hooks 'activate-mark-hook)
3855 (unless nomsg
3856 (message "Mark activated")))))
3858 (defcustom set-mark-command-repeat-pop nil
3861 will pop the mark twice, and
3863 will pop the mark three times.
3867 :type 'boolean
3868 :group 'editing-basics)
3870 (defcustom set-mark-default-inactive nil
3871 "If non-nil, setting the mark does not activate it.
3873 behave the same whether or not `transient-mark-mode' is enabled."
3874 :type 'boolean
3875 :group 'editing-basics
3876 :version "23.1")
3878 (defun set-mark-command (arg)
3879 "Set the mark where point is, or jump to the mark.
3880 Setting the mark also alters the region, which is the text
3881 between point and mark; this is the closest equivalent in
3884 With no prefix argument, set the mark at point, and push the
3885 old mark position on local mark ring. Also push the old mark on
3886 global mark ring, if the previous mark was set in another buffer.
3888 When Transient Mark Mode is off, immediately repeating this
3889 command activates `transient-mark-mode' temporarily.
3892 jump to the mark, and set the mark from
3893 position popped off the local mark ring \(this does not affect the global
3895 mark ring \(see `pop-global-mark'\).
3897 If `set-mark-command-repeat-pop' is non-nil, repeating
3899 off the local (or global) mark ring and jumps there.
3902 argument, unconditionally set mark where point is, even if
3903 `set-mark-command-repeat-pop' is non-nil.
3905 Novice Emacs Lisp programmers often try to use the mark for the wrong
3906 purposes. See the documentation of `set-mark' for more information."
3907 (interactive "P")
3908 (cond ((eq transient-mark-mode 'lambda)
3909 (setq transient-mark-mode nil))
3910 ((eq (car-safe transient-mark-mode) 'only)
3911 (deactivate-mark)))
3912 (cond
3913 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3914 (push-mark-command nil))
3915 ((not (eq this-command 'set-mark-command))
3916 (if arg
3917 (pop-to-mark-command)
3918 (push-mark-command t)))
3919 ((and set-mark-command-repeat-pop
3920 (eq last-command 'pop-to-mark-command))
3921 (setq this-command 'pop-to-mark-command)
3922 (pop-to-mark-command))
3923 ((and set-mark-command-repeat-pop
3924 (eq last-command 'pop-global-mark)
3925 (not arg))
3926 (setq this-command 'pop-global-mark)
3927 (pop-global-mark))
3928 (arg
3929 (setq this-command 'pop-to-mark-command)
3930 (pop-to-mark-command))
3931 ((eq last-command 'set-mark-command)
3932 (if (region-active-p)
3933 (progn
3934 (deactivate-mark)
3935 (message "Mark deactivated"))
3936 (activate-mark)
3937 (message "Mark activated")))
3938 (t
3939 (push-mark-command nil)
3940 (if set-mark-default-inactive (deactivate-mark)))))
3942 (defun push-mark (&optional location nomsg activate)
3943 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3944 If the last global mark pushed was not in the current buffer,
3945 also push LOCATION on the global mark ring.
3946 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3948 Novice Emacs Lisp programmers often try to use the mark for the wrong
3949 purposes. See the documentation of `set-mark' for more information.
3951 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3952 (unless (null (mark t))
3953 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3954 (when (> (length mark-ring) mark-ring-max)
3955 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3956 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3957 (set-marker (mark-marker) (or location (point)) (current-buffer))
3958 ;; Now push the mark on the global mark ring.
3959 (if (and global-mark-ring
3960 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3961 ;; The last global mark pushed was in this same buffer.
3962 ;; Don't push another one.
3963 nil
3964 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3965 (when (> (length global-mark-ring) global-mark-ring-max)
3966 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3967 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3968 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3969 (message "Mark set"))
3970 (if (or activate (not transient-mark-mode))
3971 (set-mark (mark t)))
3972 nil)
3974 (defun pop-mark ()
3975 "Pop off mark ring into the buffer's actual mark.
3976 Does not set point. Does nothing if mark ring is empty."
3977 (when mark-ring
3978 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3979 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3980 (move-marker (car mark-ring) nil)
3981 (if (null (mark t)) (ding))
3982 (setq mark-ring (cdr mark-ring)))
3983 (deactivate-mark))
3985 (define-obsolete-function-alias
3986 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3987 (defun exchange-point-and-mark (&optional arg)
3988 "Put the mark where point is now, and point where the mark is now.
3989 This command works even when the mark is not active,
3990 and it reactivates the mark.
3992 If Transient Mark mode is on, a prefix ARG deactivates the mark
3993 if it is active, and otherwise avoids reactivating it. If
3994 Transient Mark mode is off, a prefix ARG enables Transient Mark
3995 mode temporarily."
3996 (interactive "P")
3997 (let ((omark (mark t))
3998 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3999 (if (null omark)
4000 (error "No mark set in this buffer"))
4001 (deactivate-mark)
4002 (set-mark (point))
4003 (goto-char omark)
4004 (if set-mark-default-inactive (deactivate-mark))
4005 (cond (temp-highlight
4006 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4007 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4008 (not (or arg (region-active-p))))
4009 (deactivate-mark))
4010 (t (activate-mark)))
4011 nil))
4013 (defcustom shift-select-mode t
4014 "When non-nil, shifted motion keys activate the mark momentarily.
4016 While the mark is activated in this way, any shift-translated point
4017 motion key extends the region, and if Transient Mark mode was off, it
4018 is temporarily turned on. Furthermore, the mark will be deactivated
4019 by any subsequent point motion key that was not shift-translated, or
4020 by any action that normally deactivates the mark in Transient Mark mode.
4022 See `this-command-keys-shift-translated' for the meaning of
4023 shift-translation."
4024 :type 'boolean
4025 :group 'editing-basics)
4027 (defun handle-shift-selection ()
4028 "Activate/deactivate mark depending on invocation thru shift translation.
4029 This function is called by `call-interactively' when a command
4030 with a `^' character in its `interactive' spec is invoked, before
4031 running the command itself.
4033 If `shift-select-mode' is enabled and the command was invoked
4034 through shift translation, set the mark and activate the region
4035 temporarily, unless it was already set in this way. See
4036 `this-command-keys-shift-translated' for the meaning of shift
4037 translation.
4039 Otherwise, if the region has been activated temporarily,
4040 deactivate it, and restore the variable `transient-mark-mode' to
4041 its earlier value."
4042 (cond ((and shift-select-mode this-command-keys-shift-translated)
4043 (unless (and mark-active
4044 (eq (car-safe transient-mark-mode) 'only))
4045 (setq transient-mark-mode
4046 (cons 'only
4047 (unless (eq transient-mark-mode 'lambda)
4048 transient-mark-mode)))
4049 (push-mark nil nil t)))
4050 ((eq (car-safe transient-mark-mode) 'only)
4051 (setq transient-mark-mode (cdr transient-mark-mode))
4052 (deactivate-mark))))
4054 (define-minor-mode transient-mark-mode
4055 "Toggle Transient Mark mode.
4056 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4058 In Transient Mark mode, when the mark is active, the region is highlighted.
4060 So do certain other operations that set the mark
4061 but whose main purpose is something else--for example,
4067 Many commands change their behavior when Transient Mark mode is in effect
4068 and the mark is active, by acting on the region instead of their usual
4069 default part of the buffer's text. Examples of such commands include
4074 commands which are sensitive to the Transient Mark mode."
4075 :global t
4076 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4077 :variable transient-mark-mode)
4079 (defvar widen-automatically t
4080 "Non-nil means it is ok for commands to call `widen' when they want to.
4081 Some commands will do this in order to go to positions outside
4082 the current accessible part of the buffer.
4084 If `widen-automatically' is nil, these commands will do something else
4085 as a fallback, and won't change the buffer bounds.")
4087 (defvar non-essential nil
4088 "Whether the currently executing code is performing an essential task.
4089 This variable should be non-nil only when running code which should not
4090 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4091 user for a password when we are simply scanning a set of files in the
4092 background or displaying possible completions before the user even asked
4093 for it.")
4095 (defun pop-global-mark ()
4096 "Pop off global mark ring and jump to the top location."
4097 (interactive)
4098 ;; Pop entries which refer to non-existent buffers.
4099 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4100 (setq global-mark-ring (cdr global-mark-ring)))
4101 (or global-mark-ring
4102 (error "No global mark set"))
4103 (let* ((marker (car global-mark-ring))
4104 (buffer (marker-buffer marker))
4105 (position (marker-position marker)))
4106 (setq global-mark-ring (nconc (cdr global-mark-ring)
4107 (list (car global-mark-ring))))
4108 (set-buffer buffer)
4109 (or (and (>= position (point-min))
4110 (<= position (point-max)))
4111 (if widen-automatically
4112 (widen)
4113 (error "Global mark position is outside accessible part of buffer")))
4114 (goto-char position)
4115 (switch-to-buffer buffer)))
4116 \f
4117 (defcustom next-line-add-newlines nil
4118 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4119 :type 'boolean
4120 :version "21.1"
4121 :group 'editing-basics)
4123 (defun next-line (&optional arg try-vscroll)
4124 "Move cursor vertically down ARG lines.
4125 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4126 If there is no character in the target line exactly under the current column,
4127 the cursor is positioned after the character in that line which spans this
4128 column, or at the end of the line if it is not long enough.
4129 If there is no line in the buffer after this one, behavior depends on the
4130 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4131 to create a line, and moves the cursor to that line. Otherwise it moves the
4132 cursor to the end of the buffer.
4134 If the variable `line-move-visual' is non-nil, this command moves
4135 by display lines. Otherwise, it moves by buffer lines, without
4136 taking variable-width characters or continued lines into account.
4139 a semipermanent goal column for this command.
4140 Then instead of trying to move exactly vertically (or as close as possible),
4141 this command moves to the specified goal column (or as close as possible).
4142 The goal column is stored in the variable `goal-column', which is nil
4143 when there is no goal column.
4145 If you are thinking of using this in a Lisp program, consider
4146 using `forward-line' instead. It is usually easier to use
4147 and more reliable (no dependence on goal column, etc.)."
4149 (or arg (setq arg 1))
4150 (if (and next-line-add-newlines (= arg 1))
4151 (if (save-excursion (end-of-line) (eobp))
4152 ;; When adding a newline, don't expand an abbrev.
4153 (let ((abbrev-mode nil))
4154 (end-of-line)
4156 (line-move arg nil nil try-vscroll))
4157 (if (called-interactively-p 'interactive)
4158 (condition-case err
4159 (line-move arg nil nil try-vscroll)
4160 ((beginning-of-buffer end-of-buffer)
4161 (signal (car err) (cdr err))))
4162 (line-move arg nil nil try-vscroll)))
4163 nil)
4165 (defun previous-line (&optional arg try-vscroll)
4166 "Move cursor vertically up ARG lines.
4167 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4168 If there is no character in the target line exactly over the current column,
4169 the cursor is positioned after the character in that line which spans this
4170 column, or at the end of the line if it is not long enough.
4172 If the variable `line-move-visual' is non-nil, this command moves
4173 by display lines. Otherwise, it moves by buffer lines, without
4174 taking variable-width characters or continued lines into account.
4177 a semipermanent goal column for this command.
4178 Then instead of trying to move exactly vertically (or as close as possible),
4179 this command moves to the specified goal column (or as close as possible).
4180 The goal column is stored in the variable `goal-column', which is nil
4181 when there is no goal column.
4183 If you are thinking of using this in a Lisp program, consider using
4184 `forward-line' with a negative argument instead. It is usually easier
4185 to use and more reliable (no dependence on goal column, etc.)."
4187 (or arg (setq arg 1))
4188 (if (called-interactively-p 'interactive)
4189 (condition-case err
4190 (line-move (- arg) nil nil try-vscroll)
4191 ((beginning-of-buffer end-of-buffer)
4192 (signal (car err) (cdr err))))
4193 (line-move (- arg) nil nil try-vscroll))
4194 nil)
4196 (defcustom track-eol nil
4197 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4198 This means moving to the end of each line moved onto.
4199 The beginning of a blank line does not count as the end of a line.
4200 This has no effect when `line-move-visual' is non-nil."
4201 :type 'boolean
4202 :group 'editing-basics)
4204 (defcustom goal-column nil
4206 :type '(choice integer
4207 (const :tag "None" nil))
4208 :group 'editing-basics)
4209 (make-variable-buffer-local 'goal-column)
4211 (defvar temporary-goal-column 0
4212 "Current goal column for vertical motion.
4213 It is the column where point was at the start of the current run
4214 of vertical motion commands.
4216 When moving by visual lines via `line-move-visual', it is a cons
4217 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4218 divided by the default column width, and HSCROLL is the number of
4219 columns by which window is scrolled from left margin.
4221 When the `track-eol' feature is doing its job, the value is
4222 `most-positive-fixnum'.")
4224 (defcustom line-move-ignore-invisible t
4226 Outline mode sets this."
4227 :type 'boolean
4228 :group 'editing-basics)
4230 (defcustom line-move-visual t
4231 "When non-nil, `line-move' moves point by visual lines.
4232 This movement is based on where the cursor is displayed on the
4233 screen, instead of relying on buffer contents alone. It takes
4234 into account variable-width characters and line continuation.
4235 If nil, `line-move' moves point by logical lines."
4236 :type 'boolean
4237 :group 'editing-basics
4238 :version "23.1")
4240 ;; Returns non-nil if partial move was done.
4241 (defun line-move-partial (arg noerror to-end)
4242 (if (< arg 0)
4243 ;; Move backward (up).
4244 ;; If already vscrolled, reduce vscroll
4245 (let ((vs (window-vscroll nil t)))
4246 (when (> vs (frame-char-height))
4247 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4249 ;; Move forward (down).
4250 (let* ((lh (window-line-height -1))
4251 (vpos (nth 1 lh))
4252 (ypos (nth 2 lh))
4253 (rbot (nth 3 lh))
4254 py vs)
4255 (when (or (null lh)
4256 (>= rbot (frame-char-height))
4257 (<= ypos (- (frame-char-height))))
4258 (unless lh
4259 (let ((wend (pos-visible-in-window-p t nil t)))
4260 (setq rbot (nth 3 wend)
4261 vpos (nth 5 wend))))
4262 (cond
4263 ;; If last line of window is fully visible, move forward.
4264 ((or (null rbot) (= rbot 0))
4265 nil)
4266 ;; If cursor is not in the bottom scroll margin, move forward.
4267 ((and (> vpos 0)
4268 (< (setq py
4269 (or (nth 1 (window-line-height))
4270 (let ((ppos (posn-at-point)))
4271 (cdr (or (posn-actual-col-row ppos)
4272 (posn-col-row ppos))))))
4273 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4274 nil)
4275 ;; When already vscrolled, we vscroll some more if we can,
4276 ;; or clear vscroll and move forward at end of tall image.
4277 ((> (setq vs (window-vscroll nil t)) 0)
4278 (when (> rbot 0)
4279 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4280 ;; If cursor just entered the bottom scroll margin, move forward,
4281 ;; but also vscroll one line so redisplay wont recenter.
4282 ((and (> vpos 0)
4283 (= py (min (- (window-text-height) scroll-margin 1)
4284 (1- vpos))))
4285 (set-window-vscroll nil (frame-char-height) t)
4286 (line-move-1 arg noerror to-end)
4287 t)
4288 ;; If there are lines above the last line, scroll-up one line.
4289 ((> vpos 0)
4290 (scroll-up 1)
4291 t)
4292 ;; Finally, start vscroll.
4293 (t
4294 (set-window-vscroll nil (frame-char-height) t)))))))
4297 ;; This is like line-move-1 except that it also performs
4298 ;; vertical scrolling of tall images if appropriate.
4299 ;; That is not really a clean thing to do, since it mixes
4300 ;; scrolling with cursor motion. But so far we don't have
4301 ;; a cleaner solution to the problem of making C-n do something
4302 ;; useful given a tall image.
4303 (defun line-move (arg &optional noerror to-end try-vscroll)
4304 (unless (and auto-window-vscroll try-vscroll
4305 ;; Only vscroll for single line moves
4306 (= (abs arg) 1)
4307 ;; But don't vscroll in a keyboard macro.
4308 (not defining-kbd-macro)
4309 (not executing-kbd-macro)
4310 (line-move-partial arg noerror to-end))
4311 (set-window-vscroll nil 0 t)
4312 (if line-move-visual
4313 (line-move-visual arg noerror)
4314 (line-move-1 arg noerror to-end))))
4316 ;; Display-based alternative to line-move-1.
4317 ;; Arg says how many lines to move. The value is t if we can move the
4318 ;; specified number of lines.
4319 (defun line-move-visual (arg &optional noerror)
4320 (let ((opoint (point))
4321 (hscroll (window-hscroll))
4322 target-hscroll)
4323 ;; Check if the previous command was a line-motion command, or if
4324 ;; we were called from some other command.
4325 (if (and (consp temporary-goal-column)
4326 (memq last-command `(next-line previous-line ,this-command)))
4327 ;; If so, there's no need to reset `temporary-goal-column',
4328 ;; but we may need to hscroll.
4329 (if (or (/= (cdr temporary-goal-column) hscroll)
4330 (> (cdr temporary-goal-column) 0))
4331 (setq target-hscroll (cdr temporary-goal-column)))
4332 ;; Otherwise, we should reset `temporary-goal-column'.
4333 (let ((posn (posn-at-point)))
4334 (cond
4335 ;; Handle the `overflow-newline-into-fringe' case:
4336 ((eq (nth 1 posn) 'right-fringe)
4337 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4338 ((car (posn-x-y posn))
4339 (setq temporary-goal-column
4340 (cons (/ (float (car (posn-x-y posn)))
4341 (frame-char-width)) hscroll))))))
4342 (if target-hscroll
4343 (set-window-hscroll (selected-window) target-hscroll))
4344 (or (and (= (vertical-motion
4345 (cons (or goal-column
4346 (if (consp temporary-goal-column)
4347 (car temporary-goal-column)
4348 temporary-goal-column))
4349 arg))
4350 arg)
4351 (or (>= arg 0)
4352 (/= (point) opoint)
4353 ;; If the goal column lies on a display string,
4354 ;; `vertical-motion' advances the cursor to the end
4355 ;; of the string. For arg < 0, this can cause the
4356 ;; cursor to get stuck. (Bug#3020).
4357 (= (vertical-motion arg) arg)))
4358 (unless noerror
4359 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4360 nil)))))
4362 ;; This is the guts of next-line and previous-line.
4363 ;; Arg says how many lines to move.
4364 ;; The value is t if we can move the specified number of lines.
4365 (defun line-move-1 (arg &optional noerror to-end)
4366 ;; Don't run any point-motion hooks, and disregard intangibility,
4367 ;; for intermediate positions.
4368 (let ((inhibit-point-motion-hooks t)
4369 (opoint (point))
4370 (orig-arg arg))
4371 (if (consp temporary-goal-column)
4372 (setq temporary-goal-column (+ (car temporary-goal-column)
4373 (cdr temporary-goal-column))))
4374 (unwind-protect
4375 (progn
4376 (if (not (memq last-command '(next-line previous-line)))
4377 (setq temporary-goal-column
4378 (if (and track-eol (eolp)
4379 ;; Don't count beg of empty line as end of line
4380 ;; unless we just did explicit end-of-line.
4381 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4382 most-positive-fixnum
4383 (current-column))))
4385 (if (not (or (integerp selective-display)
4386 line-move-ignore-invisible))
4387 ;; Use just newline characters.
4388 ;; Set ARG to 0 if we move as many lines as requested.
4389 (or (if (> arg 0)
4390 (progn (if (> arg 1) (forward-line (1- arg)))
4391 ;; This way of moving forward ARG lines
4392 ;; verifies that we have a newline after the last one.
4393 ;; It doesn't get confused by intangible text.
4394 (end-of-line)
4395 (if (zerop (forward-line 1))
4396 (setq arg 0)))
4397 (and (zerop (forward-line arg))
4398 (bolp)
4399 (setq arg 0)))
4400 (unless noerror
4401 (signal (if (< arg 0)
4402 'beginning-of-buffer
4403 'end-of-buffer)
4404 nil)))
4405 ;; Move by arg lines, but ignore invisible ones.
4406 (let (done)
4407 (while (and (> arg 0) (not done))
4408 ;; If the following character is currently invisible,
4409 ;; skip all characters with that same `invisible' property value.
4410 (while (and (not (eobp)) (invisible-p (point)))
4411 (goto-char (next-char-property-change (point))))
4412 ;; Move a line.
4413 ;; We don't use `end-of-line', since we want to escape
4414 ;; from field boundaries occurring exactly at point.
4415 (goto-char (constrain-to-field
4416 (let ((inhibit-field-text-motion t))
4417 (line-end-position))
4418 (point) t t
4419 'inhibit-line-move-field-capture))
4420 ;; If there's no invisibility here, move over the newline.
4421 (cond
4422 ((eobp)
4423 (if (not noerror)
4424 (signal 'end-of-buffer nil)
4425 (setq done t)))
4426 ((and (> arg 1) ;; Use vertical-motion for last move
4427 (not (integerp selective-display))
4428 (not (invisible-p (point))))
4429 ;; We avoid vertical-motion when possible
4430 ;; because that has to fontify.
4431 (forward-line 1))
4432 ;; Otherwise move a more sophisticated way.
4433 ((zerop (vertical-motion 1))
4434 (if (not noerror)
4435 (signal 'end-of-buffer nil)
4436 (setq done t))))
4437 (unless done
4438 (setq arg (1- arg))))
4439 ;; The logic of this is the same as the loop above,
4440 ;; it just goes in the other direction.
4441 (while (and (< arg 0) (not done))
4442 ;; For completely consistency with the forward-motion
4443 ;; case, we should call beginning-of-line here.
4444 ;; However, if point is inside a field and on a
4445 ;; continued line, the call to (vertical-motion -1)
4446 ;; below won't move us back far enough; then we return
4447 ;; to the same column in line-move-finish, and point
4448 ;; gets stuck -- cyd
4449 (forward-line 0)
4450 (cond
4451 ((bobp)
4452 (if (not noerror)
4453 (signal 'beginning-of-buffer nil)
4454 (setq done t)))
4455 ((and (< arg -1) ;; Use vertical-motion for last move
4456 (not (integerp selective-display))
4457 (not (invisible-p (1- (point)))))
4458 (forward-line -1))
4459 ((zerop (vertical-motion -1))
4460 (if (not noerror)
4461 (signal 'beginning-of-buffer nil)
4462 (setq done t))))
4463 (unless done
4464 (setq arg (1+ arg))
4465 (while (and ;; Don't move over previous invis lines
4466 ;; if our target is the middle of this line.
4467 (or (zerop (or goal-column temporary-goal-column))
4468 (< arg 0))
4469 (not (bobp)) (invisible-p (1- (point))))
4470 (goto-char (previous-char-property-change (point))))))))
4471 ;; This is the value the function returns.
4472 (= arg 0))
4474 (cond ((> arg 0)
4475 ;; If we did not move down as far as desired, at least go
4476 ;; to end of line. Be sure to call point-entered and
4477 ;; point-left-hooks.
4478 (let* ((npoint (prog1 (line-end-position)
4479 (goto-char opoint)))
4480 (inhibit-point-motion-hooks nil))
4481 (goto-char npoint)))
4482 ((< arg 0)
4483 ;; If we did not move up as far as desired,
4484 ;; at least go to beginning of line.
4485 (let* ((npoint (prog1 (line-beginning-position)
4486 (goto-char opoint)))
4487 (inhibit-point-motion-hooks nil))
4488 (goto-char npoint)))
4489 (t
4490 (line-move-finish (or goal-column temporary-goal-column)
4491 opoint (> orig-arg 0)))))))
4493 (defun line-move-finish (column opoint forward)
4494 (let ((repeat t))
4495 (while repeat
4496 ;; Set REPEAT to t to repeat the whole thing.
4497 (setq repeat nil)
4499 (let (new
4500 (old (point))
4501 (line-beg (line-beginning-position))
4502 (line-end
4503 ;; Compute the end of the line
4504 ;; ignoring effectively invisible newlines.
4505 (save-excursion
4506 ;; Like end-of-line but ignores fields.
4508 (while (and (not (eobp)) (invisible-p (point)))
4509 (goto-char (next-char-property-change (point)))
4511 (point))))
4513 ;; Move to the desired column.
4514 (line-move-to-column (truncate column))
4516 ;; Corner case: suppose we start out in a field boundary in
4517 ;; the middle of a continued line. When we get to
4518 ;; line-move-finish, point is at the start of a new *screen*
4519 ;; line but the same text line; then line-move-to-column would
4520 ;; move us backwards. Test using C-n with point on the "x" in
4521 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4522 (and forward
4523 (< (point) old)
4524 (goto-char old))
4526 (setq new (point))
4528 ;; Process intangibility within a line.
4529 ;; With inhibit-point-motion-hooks bound to nil, a call to
4530 ;; goto-char moves point past intangible text.
4532 ;; However, inhibit-point-motion-hooks controls both the
4533 ;; intangibility and the point-entered/point-left hooks. The
4534 ;; following hack avoids calling the point-* hooks
4535 ;; unnecessarily. Note that we move *forward* past intangible
4536 ;; text when the initial and final points are the same.
4537 (goto-char new)
4538 (let ((inhibit-point-motion-hooks nil))
4539 (goto-char new)
4541 ;; If intangibility moves us to a different (later) place
4542 ;; in the same line, use that as the destination.
4543 (if (<= (point) line-end)
4544 (setq new (point))
4545 ;; If that position is "too late",
4546 ;; try the previous allowable position.
4547 ;; See if it is ok.
4548 (backward-char)
4549 (if (if forward
4550 ;; If going forward, don't accept the previous
4551 ;; allowable position if it is before the target line.
4552 (< line-beg (point))
4553 ;; If going backward, don't accept the previous
4554 ;; allowable position if it is still after the target line.
4555 (<= (point) line-end))
4556 (setq new (point))
4557 ;; As a last resort, use the end of the line.
4558 (setq new line-end))))
4560 ;; Now move to the updated destination, processing fields
4561 ;; as well as intangibility.
4562 (goto-char opoint)
4563 (let ((inhibit-point-motion-hooks nil))
4564 (goto-char
4565 ;; Ignore field boundaries if the initial and final
4566 ;; positions have the same `field' property, even if the
4567 ;; fields are non-contiguous. This seems to be "nicer"
4568 ;; behavior in many situations.
4569 (if (eq (get-char-property new 'field)
4570 (get-char-property opoint 'field))
4571 new
4572 (constrain-to-field new opoint t t
4573 'inhibit-line-move-field-capture))))
4575 ;; If all this moved us to a different line,
4576 ;; retry everything within that new line.
4577 (when (or (< (point) line-beg) (> (point) line-end))
4578 ;; Repeat the intangibility and field processing.
4579 (setq repeat t))))))
4581 (defun line-move-to-column (col)
4582 "Try to find column COL, considering invisibility.
4583 This function works only in certain cases,
4584 because what we really need is for `move-to-column'
4585 and `current-column' to be able to ignore invisible text."
4586 (if (zerop col)
4587 (beginning-of-line)
4588 (move-to-column col))
4590 (when (and line-move-ignore-invisible
4591 (not (bolp)) (invisible-p (1- (point))))
4592 (let ((normal-location (point))
4593 (normal-column (current-column)))
4594 ;; If the following character is currently invisible,
4595 ;; skip all characters with that same `invisible' property value.
4596 (while (and (not (eobp))
4597 (invisible-p (point)))
4598 (goto-char (next-char-property-change (point))))
4599 ;; Have we advanced to a larger column position?
4600 (if (> (current-column) normal-column)
4601 ;; We have made some progress towards the desired column.
4602 ;; See if we can make any further progress.
4603 (line-move-to-column (+ (current-column) (- col normal-column)))
4604 ;; Otherwise, go to the place we originally found
4605 ;; and move back over invisible text.
4606 ;; that will get us to the same place on the screen
4607 ;; but with a more reasonable buffer position.
4608 (goto-char normal-location)
4609 (let ((line-beg (line-beginning-position)))
4610 (while (and (not (bolp)) (invisible-p (1- (point))))
4611 (goto-char (previous-char-property-change (point) line-beg))))))))
4613 (defun move-end-of-line (arg)
4614 "Move point to end of current line as displayed.
4615 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4616 If point reaches the beginning or end of buffer, it stops there.
4618 To ignore the effects of the `intangible' text or overlay
4619 property, bind `inhibit-point-motion-hooks' to t.
4620 If there is an image in the current line, this function
4621 disregards newlines that are part of the text on which the image
4622 rests."
4623 (interactive "^p")
4624 (or arg (setq arg 1))
4625 (let (done)
4626 (while (not done)
4627 (let ((newpos
4628 (save-excursion
4629 (let ((goal-column 0)
4630 (line-move-visual nil))
4631 (and (line-move arg t)
4632 ;; With bidi reordering, we may not be at bol,
4633 ;; so make sure we are.
4635 (not (bobp))
4636 (progn
4637 (while (and (not (bobp)) (invisible-p (1- (point))))
4638 (goto-char (previous-single-char-property-change
4639 (point) 'invisible)))
4640 (backward-char 1)))
4641 (point)))))
4642 (goto-char newpos)
4643 (if (and (> (point) newpos)
4645 (backward-char 1)
4646 (if (and (> (point) newpos) (not (eobp))
4648 ;; If we skipped something intangible and now we're not
4649 ;; really at eol, keep going.
4650 (setq arg 1)
4651 (setq done t)))))))
4653 (defun move-beginning-of-line (arg)
4654 "Move point to beginning of current line as displayed.
4655 \(If there's an image in the line, this disregards newlines
4656 which are part of the text that the image rests on.)
4658 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4659 If point reaches the beginning or end of buffer, it stops there.
4660 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4661 (interactive "^p")
4662 (or arg (setq arg 1))
4664 (let ((orig (point))
4665 first-vis first-vis-field-value)
4667 ;; Move by lines, if ARG is not 1 (the default).
4668 (if (/= arg 1)
4669 (let ((line-move-visual nil))
4670 (line-move (1- arg) t)))
4672 ;; Move to beginning-of-line, ignoring fields and invisibles.
4674 (while (and (not (bobp)) (invisible-p (1- (point))))
4675 (goto-char (previous-char-property-change (point)))
4678 ;; Now find first visible char in the line
4679 (while (and (not (eobp)) (invisible-p (point)))
4680 (goto-char (next-char-property-change (point))))
4681 (setq first-vis (point))
4683 ;; See if fields would stop us from reaching FIRST-VIS.
4684 (setq first-vis-field-value
4685 (constrain-to-field first-vis orig (/= arg 1) t nil))
4687 (goto-char (if (/= first-vis-field-value first-vis)
4688 ;; If yes, obey them.
4689 first-vis-field-value
4690 ;; Otherwise, move to START with attention to fields.
4691 ;; (It is possible that fields never matter in this case.)
4692 (constrain-to-field (point) orig
4693 (/= arg 1) t nil)))))
4696 ;; Many people have said they rarely use this feature, and often type
4697 ;; it by accident. Maybe it shouldn't even be on a key.
4698 (put 'set-goal-column 'disabled t)
4700 (defun set-goal-column (arg)
4702 Those commands will move to this position in the line moved to
4703 rather than trying to keep the same horizontal position.
4704 With a non-nil argument ARG, clears out the goal column
4706 The goal column is stored in the variable `goal-column'."
4707 (interactive "P")
4708 (if arg
4709 (progn
4710 (setq goal-column nil)
4711 (message "No goal column"))
4712 (setq goal-column (current-column))
4713 ;; The older method below can be erroneous if `set-goal-column' is bound
4714 ;; to a sequence containing %
4715 ;;(message (substitute-command-keys
4717 ;;goal-column)
4718 (message "%s"
4719 (concat
4720 (format "Goal column %d " goal-column)
4721 (substitute-command-keys
4724 )
4725 nil)
4726 \f
4727 ;;; Editing based on visual lines, as opposed to logical lines.
4729 (defun end-of-visual-line (&optional n)
4730 "Move point to end of current visual line.
4731 With argument N not nil or 1, move forward N - 1 visual lines first.
4732 If point reaches the beginning or end of buffer, it stops there.
4733 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4734 (interactive "^p")
4735 (or n (setq n 1))
4736 (if (/= n 1)
4737 (let ((line-move-visual t))
4738 (line-move (1- n) t)))
4739 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4740 ;; constrain to field boundaries, so we don't either.
4741 (vertical-motion (cons (window-width) 0)))
4743 (defun beginning-of-visual-line (&optional n)
4744 "Move point to beginning of current visual line.
4745 With argument N not nil or 1, move forward N - 1 visual lines first.
4746 If point reaches the beginning or end of buffer, it stops there.
4747 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4748 (interactive "^p")
4749 (or n (setq n 1))
4750 (let ((opoint (point)))
4751 (if (/= n 1)
4752 (let ((line-move-visual t))
4753 (line-move (1- n) t)))
4754 (vertical-motion 0)
4755 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4756 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4758 (defun kill-visual-line (&optional arg)
4759 "Kill the rest of the visual line.
4760 With prefix argument ARG, kill that many visual lines from point.
4761 If ARG is negative, kill visual lines backward.
4762 If ARG is zero, kill the text before point on the current visual
4763 line.
4765 If you want to append the killed line to the last killed text,
4768 If the buffer is read-only, Emacs will beep and refrain from deleting
4769 the line, but put the line in the kill ring anyway. This means that
4770 you can use this command to copy text from a read-only buffer.
4771 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4772 even beep.)"
4773 (interactive "P")
4774 ;; Like in `kill-line', it's better to move point to the other end
4775 ;; of the kill before killing.
4776 (let ((opoint (point))
4777 (kill-whole-line (and kill-whole-line (bolp))))
4778 (if arg
4779 (vertical-motion (prefix-numeric-value arg))
4780 (end-of-visual-line 1)
4781 (if (= (point) opoint)
4782 (vertical-motion 1)
4783 ;; Skip any trailing whitespace at the end of the visual line.
4784 ;; We used to do this only if `show-trailing-whitespace' is
4785 ;; nil, but that's wrong; the correct thing would be to check
4786 ;; whether the trailing whitespace is highlighted. But, it's
4787 ;; OK to just do this unconditionally.
4790 (1+ (point))
4791 (point)))))
4793 (defun next-logical-line (&optional arg try-vscroll)
4794 "Move cursor vertically down ARG lines.
4795 This is identical to `next-line', except that it always moves
4796 by logical lines instead of visual lines, ignoring the value of
4797 the variable `line-move-visual'."
4799 (let ((line-move-visual nil))
4800 (with-no-warnings
4801 (next-line arg try-vscroll))))
4803 (defun previous-logical-line (&optional arg try-vscroll)
4804 "Move cursor vertically up ARG lines.
4805 This is identical to `previous-line', except that it always moves
4806 by logical lines instead of visual lines, ignoring the value of
4807 the variable `line-move-visual'."
4809 (let ((line-move-visual nil))
4810 (with-no-warnings
4811 (previous-line arg try-vscroll))))
4813 (defgroup visual-line nil
4814 "Editing based on visual lines."
4815 :group 'convenience
4816 :version "23.1")
4818 (defvar visual-line-mode-map
4819 (let ((map (make-sparse-keymap)))
4820 (define-key map [remap kill-line] 'kill-visual-line)
4821 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4822 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4823 ;; These keybindings interfere with xterm function keys. Are
4824 ;; there any other suitable bindings?
4825 ;; (define-key map "\M-[" 'previous-logical-line)
4826 ;; (define-key map "\M-]" 'next-logical-line)
4827 map))
4829 (defcustom visual-line-fringe-indicators '(nil nil)
4830 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4831 The value should be a list of the form (LEFT RIGHT), where LEFT
4832 and RIGHT are symbols representing the bitmaps to display, to
4833 indicate wrapped lines, in the left and right fringes respectively.
4834 See also `fringe-indicator-alist'.
4835 The default is not to display fringe indicators for wrapped lines.
4836 This variable does not affect fringe indicators displayed for
4837 other purposes."
4838 :type '(list (choice (const :tag "Hide left indicator" nil)
4839 (const :tag "Left curly arrow" left-curly-arrow)
4840 (symbol :tag "Other bitmap"))
4841 (choice (const :tag "Hide right indicator" nil)
4842 (const :tag "Right curly arrow" right-curly-arrow)
4843 (symbol :tag "Other bitmap")))
4844 :set (lambda (symbol value)
4845 (dolist (buf (buffer-list))
4846 (with-current-buffer buf
4847 (when (and (boundp 'visual-line-mode)
4848 (symbol-value 'visual-line-mode))
4849 (setq fringe-indicator-alist
4850 (cons (cons 'continuation value)
4851 (assq-delete-all
4852 'continuation
4853 (copy-tree fringe-indicator-alist)))))))
4854 (set-default symbol value)))
4856 (defvar visual-line--saved-state nil)
4858 (define-minor-mode visual-line-mode
4859 "Redefine simple editing commands to act on visual lines, not logical lines.
4860 This also turns on `word-wrap' in the buffer."
4861 :keymap visual-line-mode-map
4862 :group 'visual-line
4863 :lighter " Wrap"
4864 (if visual-line-mode
4865 (progn
4866 (set (make-local-variable 'visual-line--saved-state) nil)
4867 ;; Save the local values of some variables, to be restored if
4868 ;; visual-line-mode is turned off.
4869 (dolist (var '(line-move-visual truncate-lines
4870 truncate-partial-width-windows
4871 word-wrap fringe-indicator-alist))
4872 (if (local-variable-p var)
4873 (push (cons var (symbol-value var))
4874 visual-line--saved-state)))
4875 (set (make-local-variable 'line-move-visual) t)
4876 (set (make-local-variable 'truncate-partial-width-windows) nil)
4877 (setq truncate-lines nil
4878 word-wrap t
4879 fringe-indicator-alist
4880 (cons (cons 'continuation visual-line-fringe-indicators)
4881 fringe-indicator-alist)))
4882 (kill-local-variable 'line-move-visual)
4883 (kill-local-variable 'word-wrap)
4884 (kill-local-variable 'truncate-lines)
4885 (kill-local-variable 'truncate-partial-width-windows)
4886 (kill-local-variable 'fringe-indicator-alist)
4887 (dolist (saved visual-line--saved-state)
4888 (set (make-local-variable (car saved)) (cdr saved)))
4889 (kill-local-variable 'visual-line--saved-state)))
4891 (defun turn-on-visual-line-mode ()
4892 (visual-line-mode 1))
4894 (define-globalized-minor-mode global-visual-line-mode
4895 visual-line-mode turn-on-visual-line-mode
4896 :lighter " vl")
4898 \f
4899 (defun transpose-chars (arg)
4900 "Interchange characters around point, moving forward one character.
4901 With prefix arg ARG, effect is to take character before point
4902 and drag it forward past ARG other characters (backward if ARG negative).
4903 If no argument and at end of line, the previous two chars are exchanged."
4904 (interactive "*P")
4905 (and (null arg) (eolp) (forward-char -1))
4906 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4908 (defun transpose-words (arg)
4909 "Interchange words around point, leaving point at end of them.
4910 With prefix arg ARG, effect is to take word before or around point
4911 and drag it forward past ARG other words (backward if ARG negative).
4912 If ARG is zero, the words around or after point and around or after mark
4913 are interchanged."
4914 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4915 (interactive "*p")
4916 (transpose-subr 'forward-word arg))
4918 (defun transpose-sexps (arg)
4920 Does not work on a sexp that point is in the middle of
4921 if it is a list or string."
4922 (interactive "*p")
4923 (transpose-subr
4924 (lambda (arg)
4925 ;; Here we should try to simulate the behavior of
4926 ;; (cons (progn (forward-sexp x) (point))
4927 ;; (progn (forward-sexp (- x)) (point)))
4928 ;; Except that we don't want to rely on the second forward-sexp
4929 ;; putting us back to where we want to be, since forward-sexp-function
4930 ;; might do funny things like infix-precedence.
4931 (if (if (> arg 0)
4933 (and (not (bobp))
4935 ;; Jumping over a symbol. We might be inside it, mind you.
4936 (progn (funcall (if (> arg 0)
4937 'skip-syntax-backward 'skip-syntax-forward)
4938 "w_")
4939 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4940 ;; Otherwise, we're between sexps. Take a step back before jumping
4941 ;; to make sure we'll obey the same precedence no matter which direction
4942 ;; we're going.
4943 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4944 (cons (save-excursion (forward-sexp arg) (point))
4945 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4946 (not (zerop (funcall (if (> arg 0)
4947 'skip-syntax-forward
4948 'skip-syntax-backward)
4949 ".")))))
4950 (point)))))
4951 arg 'special))
4953 (defun transpose-lines (arg)
4954 "Exchange current line and previous line, leaving point after both.
4955 With argument ARG, takes previous line and moves it past ARG lines.
4956 With argument 0, interchanges line point is in with line mark is in."
4957 (interactive "*p")
4958 (transpose-subr (function
4959 (lambda (arg)
4960 (if (> arg 0)
4961 (progn
4962 ;; Move forward over ARG lines,
4963 ;; but create newlines if necessary.
4964 (setq arg (forward-line arg))
4966 (setq arg (1+ arg)))
4967 (if (> arg 0)
4968 (newline arg)))
4969 (forward-line arg))))
4970 arg))
4972 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4973 ;; which seems inconsistent with the ARG /= 0 case.
4974 ;; FIXME document SPECIAL.
4975 (defun transpose-subr (mover arg &optional special)
4976 "Subroutine to do the work of transposing objects.
4977 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4978 moves forward by units of the given object (e.g. forward-sentence,
4979 forward-paragraph). If ARG is zero, exchanges the current object
4980 with the one containing mark. If ARG is an integer, moves the
4981 current object past ARG following (if ARG is positive) or
4982 preceding (if ARG is negative) objects, leaving point after the
4983 current object."
4984 (let ((aux (if special mover
4985 (lambda (x)
4986 (cons (progn (funcall mover x) (point))
4987 (progn (funcall mover (- x)) (point))))))
4988 pos1 pos2)
4989 (cond
4990 ((= arg 0)
4991 (save-excursion
4992 (setq pos1 (funcall aux 1))
4993 (goto-char (or (mark) (error "No mark set in this buffer")))
4994 (setq pos2 (funcall aux 1))
4995 (transpose-subr-1 pos1 pos2))
4996 (exchange-point-and-mark))
4997 ((> arg 0)
4998 (setq pos1 (funcall aux -1))
4999 (setq pos2 (funcall aux arg))
5000 (transpose-subr-1 pos1 pos2)
5001 (goto-char (car pos2)))
5002 (t
5003 (setq pos1 (funcall aux -1))
5004 (goto-char (car pos1))
5005 (setq pos2 (funcall aux arg))
5006 (transpose-subr-1 pos1 pos2)))))
5008 (defun transpose-subr-1 (pos1 pos2)
5009 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5010 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5011 (when (> (car pos1) (car pos2))
5012 (let ((swap pos1))
5013 (setq pos1 pos2 pos2 swap)))
5014 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5015 (atomic-change-group
5016 (let (word2)
5017 ;; FIXME: We first delete the two pieces of text, so markers that
5018 ;; used to point to after the text end up pointing to before it :-(
5019 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5020 (goto-char (car pos2))
5021 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5022 (goto-char (car pos1))
5023 (insert word2))))
5024 \f
5025 (defun backward-word (&optional arg)
5026 "Move backward until encountering the beginning of a word.
5027 With argument ARG, do this that many times."
5028 (interactive "^p")
5029 (forward-word (- (or arg 1))))
5031 (defun mark-word (&optional arg allow-extend)
5032 "Set mark ARG words away from point.
5034 move to with the same argument.
5035 Interactively, if this command is repeated
5036 or (in Transient Mark mode) if the mark is active,
5037 it marks the next ARG words after the ones already marked."
5039 (cond ((and allow-extend
5040 (or (and (eq last-command this-command) (mark t))
5041 (region-active-p)))
5042 (setq arg (if arg (prefix-numeric-value arg)
5043 (if (< (mark) (point)) -1 1)))
5044 (set-mark
5045 (save-excursion
5046 (goto-char (mark))
5047 (forward-word arg)
5048 (point))))
5049 (t
5050 (push-mark
5051 (save-excursion
5052 (forward-word (prefix-numeric-value arg))
5053 (point))
5054 nil t))))
5056 (defun kill-word (arg)
5057 "Kill characters forward until encountering the end of a word.
5058 With argument ARG, do this that many times."
5059 (interactive "p")
5060 (kill-region (point) (progn (forward-word arg) (point))))
5062 (defun backward-kill-word (arg)
5063 "Kill characters backward until encountering the beginning of a word.
5064 With argument ARG, do this that many times."
5065 (interactive "p")
5066 (kill-word (- arg)))
5068 (defun current-word (&optional strict really-word)
5069 "Return the symbol or word that point is on (or a nearby one) as a string.
5070 The return value includes no text properties.
5071 If optional arg STRICT is non-nil, return nil unless point is within
5072 or adjacent to a symbol or word. In all cases the value can be nil
5073 if there is no word nearby.
5074 The function, belying its name, normally finds a symbol.
5075 If optional arg REALLY-WORD is non-nil, it finds just a word."
5076 (save-excursion
5077 (let* ((oldpoint (point)) (start (point)) (end (point))
5078 (syntaxes (if really-word "w" "w_"))
5079 (not-syntaxes (concat "^" syntaxes)))
5080 (skip-syntax-backward syntaxes) (setq start (point))
5081 (goto-char oldpoint)
5082 (skip-syntax-forward syntaxes) (setq end (point))
5083 (when (and (eq start oldpoint) (eq end oldpoint)
5084 ;; Point is neither within nor adjacent to a word.
5085 (not strict))
5086 ;; Look for preceding word in same line.
5087 (skip-syntax-backward not-syntaxes (line-beginning-position))
5088 (if (bolp)
5089 ;; No preceding word in same line.
5090 ;; Look for following word in same line.
5091 (progn
5092 (skip-syntax-forward not-syntaxes (line-end-position))
5093 (setq start (point))
5094 (skip-syntax-forward syntaxes)
5095 (setq end (point)))
5096 (setq end (point))
5097 (skip-syntax-backward syntaxes)
5098 (setq start (point))))
5099 ;; If we found something nonempty, return it as a string.
5100 (unless (= start end)
5101 (buffer-substring-no-properties start end)))))
5102 \f
5103 (defcustom fill-prefix nil
5104 "String for filling to insert at front of new line, or nil for none."
5105 :type '(choice (const :tag "None" nil)
5106 string)
5107 :group 'fill)
5108 (make-variable-buffer-local 'fill-prefix)
5109 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5111 (defcustom auto-fill-inhibit-regexp nil
5112 "Regexp to match lines which should not be auto-filled."
5113 :type '(choice (const :tag "None" nil)
5114 regexp)
5115 :group 'fill)
5117 (defun do-auto-fill ()
5118 "The default value for `normal-auto-fill-function'.
5119 This is the default auto-fill function, some major modes use a different one.
5120 Returns t if it really did any work."
5121 (let (fc justify give-up
5122 (fill-prefix fill-prefix))
5123 (if (or (not (setq justify (current-justification)))
5124 (null (setq fc (current-fill-column)))
5125 (and (eq justify 'left)
5126 (<= (current-column) fc))
5127 (and auto-fill-inhibit-regexp
5128 (save-excursion (beginning-of-line)
5129 (looking-at auto-fill-inhibit-regexp))))
5130 nil ;; Auto-filling not required
5131 (if (memq justify '(full center right))
5132 (save-excursion (unjustify-current-line)))
5134 ;; Choose a fill-prefix automatically.
5135 (when (and adaptive-fill-mode
5136 (or (null fill-prefix) (string= fill-prefix "")))
5137 (let ((prefix
5138 (fill-context-prefix
5139 (save-excursion (backward-paragraph 1) (point))
5140 (save-excursion (forward-paragraph 1) (point)))))
5141 (and prefix (not (equal prefix ""))
5142 ;; Use auto-indentation rather than a guessed empty prefix.
5143 (not (and fill-indent-according-to-mode
5145 (setq fill-prefix prefix))))
5147 (while (and (not give-up) (> (current-column) fc))
5148 ;; Determine where to split the line.
5149 (let* (after-prefix
5150 (fill-point
5151 (save-excursion
5152 (beginning-of-line)
5153 (setq after-prefix (point))
5154 (and fill-prefix
5155 (looking-at (regexp-quote fill-prefix))
5156 (setq after-prefix (match-end 0)))
5157 (move-to-column (1+ fc))
5158 (fill-move-to-break-point after-prefix)
5159 (point))))
5161 ;; See whether the place we found is any good.
5162 (if (save-excursion
5163 (goto-char fill-point)
5164 (or (bolp)
5165 ;; There is no use breaking at end of line.
5166 (save-excursion (skip-chars-forward " ") (eolp))
5167 ;; It is futile to split at the end of the prefix
5168 ;; since we would just insert the prefix again.
5169 (and after-prefix (<= (point) after-prefix))
5170 ;; Don't split right after a comment starter
5171 ;; since we would just make another comment starter.
5172 (and comment-start-skip
5173 (let ((limit (point)))
5174 (beginning-of-line)
5175 (and (re-search-forward comment-start-skip
5176 limit t)
5177 (eq (point) limit))))))
5178 ;; No good place to break => stop trying.
5179 (setq give-up t)
5180 ;; Ok, we have a useful place to break the line. Do it.
5181 (let ((prev-column (current-column)))
5182 ;; If point is at the fill-point, do not `save-excursion'.
5183 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5184 ;; point will end up before it rather than after it.
5185 (if (save-excursion
5187 (= (point) fill-point))
5188 (default-indent-new-line t)
5189 (save-excursion
5190 (goto-char fill-point)
5191 (default-indent-new-line t)))
5192 ;; Now do justification, if required
5193 (if (not (eq justify 'left))
5194 (save-excursion
5195 (end-of-line 0)
5196 (justify-current-line justify nil t)))
5197 ;; If making the new line didn't reduce the hpos of
5198 ;; the end of the line, then give up now;
5199 ;; trying again will not help.
5200 (if (>= (current-column) prev-column)
5201 (setq give-up t))))))
5202 ;; Justify last line.
5203 (justify-current-line justify t t)
5204 t)))
5206 (defvar comment-line-break-function 'comment-indent-new-line
5207 "*Mode-specific function which line breaks and continues a comment.
5208 This function is called during auto-filling when a comment syntax
5209 is defined.
5210 The function should take a single optional argument, which is a flag
5211 indicating whether it should use soft newlines.")
5213 (defun default-indent-new-line (&optional soft)
5214 "Break line at point and indent.
5215 If a comment syntax is defined, call `comment-indent-new-line'.
5217 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5218 unless optional argument SOFT is non-nil."
5219 (interactive)
5220 (if comment-start
5221 (funcall comment-line-break-function soft)
5222 ;; Insert the newline before removing empty space so that markers
5223 ;; get preserved better.
5225 (save-excursion (forward-char -1) (delete-horizontal-space))
5226 (delete-horizontal-space)
5228 (if (and fill-prefix (not adaptive-fill-mode))
5229 ;; Blindly trust a non-adaptive fill-prefix.
5230 (progn
5231 (indent-to-left-margin)
5232 (insert-before-markers-and-inherit fill-prefix))
5234 (cond
5235 ;; If there's an adaptive prefix, use it unless we're inside
5236 ;; a comment and the prefix is not a comment starter.
5237 (fill-prefix
5238 (indent-to-left-margin)
5239 (insert-and-inherit fill-prefix))
5240 ;; If we're not inside a comment, just try to indent.
5241 (t (indent-according-to-mode))))))
5243 (defvar normal-auto-fill-function 'do-auto-fill
5244 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5245 Some major modes set this.")
5247 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5248 ;; `functions' and `hooks' are usually unsafe to set, but setting
5249 ;; auto-fill-function to nil in a file-local setting is safe and
5250 ;; can be useful to prevent auto-filling.
5251 (put 'auto-fill-function 'safe-local-variable 'null)
5252 ;; FIXME: turn into a proper minor mode.
5253 ;; Add a global minor mode version of it.
5254 (define-minor-mode auto-fill-mode
5255 "Toggle Auto Fill mode.
5256 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5257 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5258 automatically breaks the line at a previous space.
5260 The value of `normal-auto-fill-function' specifies the function to use
5261 for `auto-fill-function' when turning Auto Fill mode on."
5262 :variable (eq auto-fill-function normal-auto-fill-function))
5264 ;; This holds a document string used to document auto-fill-mode.
5265 (defun auto-fill-function ()
5266 "Automatically break line at a previous space, in insertion of text."
5267 nil)
5269 (defun turn-on-auto-fill ()
5270 "Unconditionally turn on Auto Fill mode."
5271 (auto-fill-mode 1))
5273 (defun turn-off-auto-fill ()
5274 "Unconditionally turn off Auto Fill mode."
5275 (auto-fill-mode -1))
5277 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5279 (defun set-fill-column (arg)
5280 "Set `fill-column' to specified argument.
5283 (interactive
5284 (list (or current-prefix-arg
5285 ;; We used to use current-column silently, but C-x f is too easily
5286 ;; typed as a typo for C-x C-f, so we turned it into an error and
5287 ;; now an interactive prompt.
5288 (read-number "Set fill-column to: " (current-column)))))
5289 (if (consp arg)
5290 (setq arg (current-column)))
5291 (if (not (integerp arg))
5292 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5293 (error "set-fill-column requires an explicit argument")
5294 (message "Fill column set to %d (was %d)" arg fill-column)
5295 (setq fill-column arg)))
5296 \f
5297 (defun set-selective-display (arg)
5298 "Set `selective-display' to ARG; clear it if no arg.
5299 When the value of `selective-display' is a number > 0,
5300 lines whose indentation is >= that value are not displayed.
5301 The variable `selective-display' has a separate value for each buffer."
5302 (interactive "P")
5303 (if (eq selective-display t)
5304 (error "selective-display already in use for marked lines"))
5305 (let ((current-vpos
5306 (save-restriction
5307 (narrow-to-region (point-min) (point))
5308 (goto-char (window-start))
5309 (vertical-motion (window-height)))))
5310 (setq selective-display
5311 (and arg (prefix-numeric-value arg)))
5312 (recenter current-vpos))
5313 (set-window-start (selected-window) (window-start (selected-window)))
5314 (princ "selective-display set to " t)
5315 (prin1 selective-display t)
5316 (princ "." t))
5318 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5320 (defun toggle-truncate-lines (&optional arg)
5321 "Toggle whether to fold or truncate long lines for the current buffer.
5322 With prefix argument ARG, truncate long lines if ARG is positive,
5323 otherwise don't truncate them. Note that in side-by-side windows,
5324 this command has no effect if `truncate-partial-width-windows'
5325 is non-nil."
5326 (interactive "P")
5327 (setq truncate-lines
5328 (if (null arg)
5329 (not truncate-lines)
5330 (> (prefix-numeric-value arg) 0)))
5331 (force-mode-line-update)
5332 (unless truncate-lines
5333 (let ((buffer (current-buffer)))
5334 (walk-windows (lambda (window)
5335 (if (eq buffer (window-buffer window))
5336 (set-window-hscroll window 0)))
5337 nil t)))
5338 (message "Truncate long lines %s"
5339 (if truncate-lines "enabled" "disabled")))
5341 (defun toggle-word-wrap (&optional arg)
5342 "Toggle whether to use word-wrapping for continuation lines.
5343 With prefix argument ARG, wrap continuation lines at word boundaries
5344 if ARG is positive, otherwise wrap them at the right screen edge.
5345 This command toggles the value of `word-wrap'. It has no effect
5346 if long lines are truncated."
5347 (interactive "P")
5348 (setq word-wrap
5349 (if (null arg)
5350 (not word-wrap)
5351 (> (prefix-numeric-value arg) 0)))
5352 (force-mode-line-update)
5353 (message "Word wrapping %s"
5354 (if word-wrap "enabled" "disabled")))
5356 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5357 "The string displayed in the mode line when in overwrite mode.")
5358 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5359 "The string displayed in the mode line when in binary overwrite mode.")
5361 (define-minor-mode overwrite-mode
5362 "Toggle overwrite mode.
5363 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5364 otherwise turn it off. In overwrite mode, printing characters typed
5365 in replace existing text on a one-for-one basis, rather than pushing
5366 it to the right. At the end of a line, such characters extend the line.
5367 Before a tab, such characters insert until the tab is filled in.
5369 is supposed to make it easier to insert characters when necessary."
5370 :variable (eq overwrite-mode 'overwrite-mode-textual))
5372 (define-minor-mode binary-overwrite-mode
5373 "Toggle binary overwrite mode.
5374 With prefix argument ARG, turn binary overwrite mode on if ARG is
5375 positive, otherwise turn it off. In binary overwrite mode, printing
5376 characters typed in replace existing text. Newlines are not treated
5377 specially, so typing at the end of a line joins the line to the next,
5378 with the typed character between them. Typing before a tab character
5380 replaces the text at the cursor, just as ordinary typing characters do.
5382 Note that binary overwrite mode is not its own minor mode; it is a
5383 specialization of overwrite mode, entered by setting the
5384 `overwrite-mode' variable to `overwrite-mode-binary'."
5385 :variable (eq overwrite-mode 'overwrite-mode-binary))
5387 (define-minor-mode line-number-mode
5388 "Toggle Line Number mode.
5389 With ARG, turn Line Number mode on if ARG is positive, otherwise
5390 turn it off. When Line Number mode is enabled, the line number
5391 appears in the mode line.
5393 Line numbers do not appear for very large buffers and buffers
5394 with very long lines; see variables `line-number-display-limit'
5395 and `line-number-display-limit-width'."
5396 :init-value t :global t :group 'mode-line)
5398 (define-minor-mode column-number-mode
5399 "Toggle Column Number mode.
5400 With ARG, turn Column Number mode on if ARG is positive,
5401 otherwise turn it off. When Column Number mode is enabled, the
5402 column number appears in the mode line."
5403 :global t :group 'mode-line)
5405 (define-minor-mode size-indication-mode
5406 "Toggle Size Indication mode.
5407 With ARG, turn Size Indication mode on if ARG is positive,
5408 otherwise turn it off. When Size Indication mode is enabled, the
5409 size of the accessible part of the buffer appears in the mode line."
5410 :global t :group 'mode-line)
5412 (define-minor-mode auto-save-mode
5413 "Toggle auto-saving of contents of current buffer.
5414 With prefix argument ARG, turn auto-saving on if positive, else off."
5415 :variable ((and buffer-auto-save-file-name
5416 ;; If auto-save is off because buffer has shrunk,
5417 ;; then toggling should turn it on.
5418 (>= buffer-saved-size 0))
5419 . (lambda (val)
5420 (setq buffer-auto-save-file-name
5421 (cond
5422 ((null val) nil)
5423 ((and buffer-file-name auto-save-visited-file-name
5424 (not buffer-read-only))
5425 buffer-file-name)
5426 (t (make-auto-save-file-name))))))
5427 ;; If -1 was stored here, to temporarily turn off saving,
5428 ;; turn it back on.
5429 (and (< buffer-saved-size 0)
5430 (setq buffer-saved-size 0)))
5431 \f
5432 (defgroup paren-blinking nil
5433 "Blinking matching of parens and expressions."
5434 :prefix "blink-matching-"
5435 :group 'paren-matching)
5437 (defcustom blink-matching-paren t
5438 "Non-nil means show matching open-paren when close-paren is inserted."
5439 :type 'boolean
5440 :group 'paren-blinking)
5442 (defcustom blink-matching-paren-on-screen t
5443 "Non-nil means show matching open-paren when it is on screen.
5444 If nil, don't show it (but the open-paren can still be shown
5445 when it is off screen).
5447 This variable has no effect if `blink-matching-paren' is nil.
5448 \(In that case, the open-paren is never shown.)
5449 It is also ignored if `show-paren-mode' is enabled."
5450 :type 'boolean
5451 :group 'paren-blinking)
5453 (defcustom blink-matching-paren-distance (* 100 1024)
5454 "If non-nil, maximum distance to search backwards for matching open-paren.
5455 If nil, search stops at the beginning of the accessible portion of the buffer."
5456 :version "23.2" ; 25->100k
5457 :type '(choice (const nil) integer)
5458 :group 'paren-blinking)
5460 (defcustom blink-matching-delay 1
5461 "Time in seconds to delay after showing a matching paren."
5462 :type 'number
5463 :group 'paren-blinking)
5465 (defcustom blink-matching-paren-dont-ignore-comments nil
5466 "If nil, `blink-matching-paren' ignores comments.
5467 More precisely, when looking for the matching parenthesis,
5468 it skips the contents of comments that end before point."
5469 :type 'boolean
5470 :group 'paren-blinking)
5472 (defun blink-matching-check-mismatch (start end)
5473 "Return whether or not START...END are matching parens.
5474 END is the current point and START is the blink position.
5475 START might be nil if no matching starter was found.
5476 Returns non-nil if we find there is a mismatch."
5477 (let* ((end-syntax (syntax-after (1- end)))
5478 (matching-paren (and (consp end-syntax)
5479 (eq (syntax-class end-syntax) 5)
5480 (cdr end-syntax))))
5481 ;; For self-matched chars like " and $, we can't know when they're
5482 ;; mismatched or unmatched, so we can only do it for parens.
5483 (when matching-paren
5484 (not (and start
5485 (or
5486 (eq (char-after start) matching-paren)
5487 ;; The cdr might hold a new paren-class info rather than
5488 ;; a matching-char info, in which case the two CDRs
5489 ;; should match.
5490 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5492 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5493 "Function to check parentheses mismatches.
5494 The function takes two arguments (START and END) where START is the
5495 position just before the opening token and END is the position right after.
5496 START can be nil, if it was not found.
5497 The function should return non-nil if the two tokens do not match.")
5499 (defun blink-matching-open ()
5500 "Move cursor momentarily to the beginning of the sexp before point."
5501 (interactive)
5502 (when (and (not (bobp))
5503 blink-matching-paren)
5504 (let* ((oldpos (point))
5505 (message-log-max nil) ; Don't log messages about paren matching.
5506 (blinkpos
5507 (save-excursion
5508 (save-restriction
5509 (if blink-matching-paren-distance
5510 (narrow-to-region
5511 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5512 (- (point) blink-matching-paren-distance))
5513 oldpos))
5514 (let ((parse-sexp-ignore-comments
5515 (and parse-sexp-ignore-comments
5516 (not blink-matching-paren-dont-ignore-comments))))
5517 (condition-case ()
5518 (progn
5519 (forward-sexp -1)
5520 ;; backward-sexp skips backward over prefix chars,
5521 ;; so move back to the matching paren.
5522 (while (and (< (point) (1- oldpos))
5523 (let ((code (syntax-after (point))))
5524 (or (eq (syntax-class code) 6)
5525 (eq (logand 1048576 (car code))
5526 1048576))))
5527 (forward-char 1))
5528 (point))
5529 (error nil))))))
5530 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5531 (cond
5532 (mismatch
5533 (if blinkpos
5534 (if (minibufferp)
5535 (minibuffer-message " [Mismatched parentheses]")
5536 (message "Mismatched parentheses"))
5537 (if (minibufferp)
5538 (minibuffer-message " [Unmatched parenthesis]")
5539 (message "Unmatched parenthesis"))))
5540 ((not blinkpos) nil)
5541 ((pos-visible-in-window-p blinkpos)
5542 ;; Matching open within window, temporarily move to blinkpos but only
5543 ;; if `blink-matching-paren-on-screen' is non-nil.
5544 (and blink-matching-paren-on-screen
5545 (not show-paren-mode)
5546 (save-excursion
5547 (goto-char blinkpos)
5548 (sit-for blink-matching-delay))))
5549 (t
5550 (save-excursion
5551 (goto-char blinkpos)
5552 (let ((open-paren-line-string
5553 ;; Show what precedes the open in its line, if anything.
5554 (cond
5556 (buffer-substring (line-beginning-position)
5557 (1+ blinkpos)))
5558 ;; Show what follows the open in its line, if anything.
5559 ((save-excursion
5560 (forward-char 1)
5562 (not (eolp)))
5563 (buffer-substring blinkpos
5564 (line-end-position)))
5565 ;; Otherwise show the previous nonblank line,
5566 ;; if there is one.
5568 (concat
5569 (buffer-substring (progn
5571 (line-beginning-position))
5572 (progn (end-of-line)
5574 (point)))
5575 ;; Replace the newline and other whitespace with `...'.
5576 "..."
5577 (buffer-substring blinkpos (1+ blinkpos))))
5578 ;; There is nothing to show except the char itself.
5579 (t (buffer-substring blinkpos (1+ blinkpos))))))
5580 (message "Matches %s"
5581 (substring-no-properties open-paren-line-string)))))))))
5583 (defvar blink-paren-function 'blink-matching-open
5584 "Function called, if non-nil, whenever a close parenthesis is inserted.
5585 More precisely, a char with closeparen syntax is self-inserted.")
5587 (defun blink-paren-post-self-insert-function ()
5588 (when (and (eq (char-before) last-command-event) ; Sanity check.
5589 (memq (char-syntax last-command-event) '(?\) ?\$))
5590 blink-paren-function
5591 (not executing-kbd-macro)
5592 (not noninteractive)
5593 ;; Verify an even number of quoting characters precede the close.
5594 (= 1 (logand 1 (- (point)
5595 (save-excursion
5596 (forward-char -1)
5598 (point))))))
5599 (funcall blink-paren-function)))
5601 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5602 ;; Most likely, this hook is nil, so this arg doesn't matter,
5603 ;; but I use it as a reminder that this function usually
5604 ;; likes to be run after others since it does `sit-for'.
5605 'append)
5606 \f
5607 ;; This executes C-g typed while Emacs is waiting for a command.
5608 ;; Quitting out of a program does not go through here;
5609 ;; that happens in the QUIT macro at the C code level.
5610 (defun keyboard-quit ()
5611 "Signal a `quit' condition.
5612 During execution of Lisp code, this character causes a quit directly.
5613 At top-level, as an editor command, this simply beeps."
5614 (interactive)
5615 ;; Avoid adding the region to the window selection.
5616 (setq saved-region-selection nil)
5617 (let (select-active-regions)
5618 (deactivate-mark))
5619 (if (fboundp 'kmacro-keyboard-quit)
5620 (kmacro-keyboard-quit))
5621 (setq defining-kbd-macro nil)
5622 (signal 'quit nil))
5624 (defvar buffer-quit-function nil
5627 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5629 (defun keyboard-escape-quit ()
5631 This command can exit an interactive command such as `query-replace',
5632 can clear out a prefix argument or a region,
5633 can get out of the minibuffer or other recursive edit,
5634 cancel the use of the current buffer (for special-purpose buffers),
5635 or go back to just one window (by deleting all but the selected window)."
5636 (interactive)
5637 (cond ((eq last-command 'mode-exited) nil)
5638 ((region-active-p)
5639 (deactivate-mark))
5640 ((> (minibuffer-depth) 0)
5641 (abort-recursive-edit))
5642 (current-prefix-arg
5643 nil)
5644 ((> (recursion-depth) 0)
5645 (exit-recursive-edit))
5646 (buffer-quit-function
5647 (funcall buffer-quit-function))
5648 ((not (one-window-p t))
5649 (delete-other-windows))
5651 (bury-buffer))))
5653 (defun play-sound-file (file &optional volume device)
5654 "Play sound stored in FILE.
5655 VOLUME and DEVICE correspond to the keywords of the sound
5656 specification for `play-sound'."
5657 (interactive "fPlay sound file: ")
5658 (let ((sound (list :file file)))
5659 (if volume
5660 (plist-put sound :volume volume))
5661 (if device
5662 (plist-put sound :device device))
5663 (push 'sound sound)
5664 (play-sound sound)))
5666 \f
5667 (defcustom read-mail-command 'rmail
5668 "Your preference for a mail reading package.
5669 This is used by some keybindings which support reading mail.
5670 See also `mail-user-agent' concerning sending mail."
5673 (function-item :tag "Emacs interface to MH"
5675 (function :tag "Other"))
5676 :version "21.1"
5677 :group 'mail)
5679 (defcustom mail-user-agent 'message-user-agent
5680 "Your preference for a mail composition package.
5681 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5682 outgoing email message. This variable lets you specify which
5683 mail-sending package you prefer.
5685 Valid values include:
5687 `message-user-agent' -- use the Message package.
5688 See Info node `(message)'.
5689 `sendmail-user-agent' -- use the Mail package.
5690 See Info node `(emacs)Sending Mail'.
5691 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5692 See Info node `(mh-e)'.
5693 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5694 paraphernalia, particularly the Gcc: header for
5695 archiving.
5697 Additional valid symbols may be available; check with the author of
5698 your package for details. The function should return non-nil if it
5699 succeeds.
5701 See also `read-mail-command' concerning reading mail."
5702 :type '(radio (function-item :tag "Message package"
5704 message-user-agent)
5705 (function-item :tag "Mail package"
5707 sendmail-user-agent)
5708 (function-item :tag "Emacs interface to MH"
5710 mh-e-user-agent)
5711 (function-item :tag "Message with full Gnus features"
5713 gnus-user-agent)
5714 (function :tag "Other"))
5715 :version "23.2" ; sendmail->message
5716 :group 'mail)
5718 (defcustom compose-mail-user-agent-warnings t
5719 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5720 If the value of `mail-user-agent' is the default, and the user
5721 appears to have customizations applying to the old default,
5722 `compose-mail' issues a warning."
5723 :type 'boolean
5724 :version "23.2"
5725 :group 'mail)
5727 (defun rfc822-goto-eoh ()
5728 "If the buffer starts with a mail header, move point to the header's end.
5729 Otherwise, moves to `point-min'.
5730 The end of the header is the start of the next line, if there is one,
5731 else the end of the last line. This function obeys RFC822."
5732 (goto-char (point-min))
5733 (when (re-search-forward
5735 (goto-char (match-beginning 0))))
5737 (defun compose-mail (&optional to subject other-headers continue
5738 switch-function yank-action send-actions
5739 return-action)
5740 "Start composing a mail message to send.
5741 This uses the user's chosen mail composition package
5742 as selected with the variable `mail-user-agent'.
5743 The optional arguments TO and SUBJECT specify recipients
5744 and the initial Subject field, respectively.
5746 OTHER-HEADERS is an alist specifying additional
5747 header fields. Elements look like (HEADER . VALUE) where both
5748 HEADER and VALUE are strings.
5750 CONTINUE, if non-nil, says to continue editing a message already
5751 being composed. Interactively, CONTINUE is the prefix argument.
5753 SWITCH-FUNCTION, if non-nil, is a function to use to
5754 switch to and display the buffer used for mail composition.
5756 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5757 to insert the raw text of the message being replied to.
5758 It has the form (FUNCTION . ARGS). The user agent will apply
5759 FUNCTION to ARGS, to insert the raw text of the original message.
5760 \(The user agent will also run `mail-citation-hook', *after* the
5761 original text has been inserted in this way.)
5763 SEND-ACTIONS is a list of actions to call when the message is sent.
5764 Each action has the form (FUNCTION . ARGS).
5766 RETURN-ACTION, if non-nil, is an action for returning to the
5767 caller. It has the form (FUNCTION . ARGS). The function is
5768 called after the mail has been sent or put aside, and the mail
5769 buffer buried."
5770 (interactive
5771 (list nil nil nil current-prefix-arg))
5773 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5774 ;; from sendmail-user-agent to message-user-agent. Some users may
5775 ;; encounter incompatibilities. This hack tries to detect problems
5776 ;; and warn about them.
5777 (and compose-mail-user-agent-warnings
5778 (eq mail-user-agent 'message-user-agent)
5779 (let (warn-vars)
5780 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5781 mail-yank-hooks mail-archive-file-name
5782 mail-default-reply-to mail-mailing-lists
5783 mail-self-blind))
5784 (and (boundp var)
5785 (symbol-value var)
5786 (push var warn-vars)))
5787 (when warn-vars
5788 (display-warning 'mail
5789 (format "\
5790 The default mail mode is now Message mode.
5791 You have the following Mail mode variable%s customized:
5793 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5794 (if (> (length warn-vars) 1) "s" "")
5795 (mapconcat 'symbol-name
5796 warn-vars " "))))))
5798 (let ((function (get mail-user-agent 'composefunc)))
5799 (funcall function to subject other-headers continue switch-function
5800 yank-action send-actions return-action)))
5802 (defun compose-mail-other-window (&optional to subject other-headers continue
5803 yank-action send-actions
5804 return-action)
5806 (interactive (list nil nil nil current-prefix-arg))
5807 (compose-mail to subject other-headers continue
5808 'switch-to-buffer-other-window yank-action send-actions
5809 return-action))
5811 (defun compose-mail-other-frame (&optional to subject other-headers continue
5812 yank-action send-actions
5813 return-action)
5815 (interactive (list nil nil nil current-prefix-arg))
5816 (compose-mail to subject other-headers continue
5817 'switch-to-buffer-other-frame yank-action send-actions
5818 return-action))
5820 \f
5821 (defvar set-variable-value-history nil
5822 "History of values entered with `set-variable'.
5824 Maximum length of the history list is determined by the value
5825 of `history-length', which see.")
5827 (defun set-variable (variable value &optional make-local)
5828 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5829 VARIABLE should be a user option variable name, a Lisp variable
5830 meant to be customized by users. You should enter VALUE in Lisp syntax,
5831 so if you want VALUE to be a string, you must surround it with doublequotes.
5832 VALUE is used literally, not evaluated.
5834 If VARIABLE has a `variable-interactive' property, that is used as if
5835 it were the arg to `interactive' (which see) to interactively read VALUE.
5837 If VARIABLE has been defined with `defcustom', then the type information
5838 in the definition is used to check that VALUE is valid.
5840 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5841 (interactive
5842 (let* ((default-var (variable-at-point))
5843 (var (if (user-variable-p default-var)
5844 (read-variable (format "Set variable (default %s): " default-var)
5845 default-var)
5846 (read-variable "Set variable: ")))
5847 (minibuffer-help-form '(describe-variable var))
5848 (prop (get var 'variable-interactive))
5849 (obsolete (car (get var 'byte-obsolete-variable)))
5850 (prompt (format "Set %s %s to value: " var
5851 (cond ((local-variable-p var)
5852 "(buffer-local)")
5853 ((or current-prefix-arg
5854 (local-variable-if-set-p var))
5855 "buffer-locally")
5856 (t "globally"))))
5857 (val (progn
5858 (when obsolete
5859 (message (concat "`%S' is obsolete; "
5860 (if (symbolp obsolete) "use `%S' instead" "%s"))
5861 var obsolete)
5862 (sit-for 3))
5863 (if prop
5864 ;; Use VAR's `variable-interactive' property
5865 ;; as an interactive spec for prompting.
5866 (call-interactively `(lambda (arg)
5867 (interactive ,prop)
5868 arg))
5869 (read
5870 (read-string prompt nil
5871 'set-variable-value-history
5872 (format "%S" (symbol-value var))))))))
5873 (list var val current-prefix-arg)))
5875 (and (custom-variable-p variable)
5876 (not (get variable 'custom-type))
5877 (custom-load-symbol variable))
5878 (let ((type (get variable 'custom-type)))
5879 (when type
5880 ;; Match with custom type.
5881 (require 'cus-edit)
5882 (setq type (widget-convert type))
5883 (unless (widget-apply type :match value)
5884 (error "Value `%S' does not match type %S of %S"
5885 value (car type) variable))))
5887 (if make-local
5888 (make-local-variable variable))
5890 (set variable value)
5892 ;; Force a thorough redisplay for the case that the variable
5893 ;; has an effect on the display, like `tab-width' has.
5894 (force-mode-line-update))
5895 \f
5896 ;; Define the major mode for lists of completions.
5898 (defvar completion-list-mode-map
5899 (let ((map (make-sparse-keymap)))
5900 (define-key map [mouse-2] 'mouse-choose-completion)
5901 (define-key map [follow-link] 'mouse-face)
5902 (define-key map [down-mouse-2] nil)
5903 (define-key map "\C-m" 'choose-completion)
5904 (define-key map "\e\e\e" 'delete-completion-window)
5905 (define-key map [left] 'previous-completion)
5906 (define-key map [right] 'next-completion)
5907 (define-key map "q" 'quit-window)
5908 (define-key map "z" 'kill-this-buffer)
5909 map)
5910 "Local map for completion list buffers.")
5912 ;; Completion mode is suitable only for specially formatted data.
5913 (put 'completion-list-mode 'mode-class 'special)
5915 (defvar completion-reference-buffer nil
5916 "Record the buffer that was current when the completion list was requested.
5917 This is a local variable in the completion list buffer.
5918 Initial value is nil to avoid some compiler warnings.")
5920 (defvar completion-no-auto-exit nil
5921 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5922 This also applies to other functions such as `choose-completion'.")
5924 (defvar completion-base-position nil
5925 "Position of the base of the text corresponding to the shown completions.
5926 This variable is used in the *Completions* buffers.
5927 Its value is a list of the form (START END) where START is the place
5928 where the completion should be inserted and END (if non-nil) is the end
5929 of the text to replace. If END is nil, point is used instead.")
5931 (defvar completion-base-size nil
5932 "Number of chars before point not involved in completion.
5933 This is a local variable in the completion list buffer.
5934 It refers to the chars in the minibuffer if completing in the
5935 minibuffer, or in `completion-reference-buffer' otherwise.
5936 Only characters in the field at point are included.
5938 If nil, Emacs determines which part of the tail end of the
5939 buffer's text is involved in completion by comparing the text
5940 directly.")
5941 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5943 (defun delete-completion-window ()
5944 "Delete the completion list window.
5945 Go to the window from which completion was requested."
5946 (interactive)
5947 (let ((buf completion-reference-buffer))
5948 (if (one-window-p t)
5949 (if (window-dedicated-p (selected-window))
5950 (delete-frame (selected-frame)))
5951 (delete-window (selected-window))
5952 (if (get-buffer-window buf)
5953 (select-window (get-buffer-window buf))))))
5955 (defun previous-completion (n)
5956 "Move to the previous item in the completion list."
5957 (interactive "p")
5958 (next-completion (- n)))
5960 (defun next-completion (n)
5961 "Move to the next item in the completion list.
5962 With prefix argument N, move N items (negative N means move backward)."
5963 (interactive "p")
5964 (let ((beg (point-min)) (end (point-max)))
5965 (while (and (> n 0) (not (eobp)))
5966 ;; If in a completion, move to the end of it.
5967 (when (get-text-property (point) 'mouse-face)
5968 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5969 ;; Move to start of next one.
5970 (unless (get-text-property (point) 'mouse-face)
5971 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5972 (setq n (1- n)))
5973 (while (and (< n 0) (not (bobp)))
5974 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5975 ;; If in a completion, move to the start of it.
5976 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5977 (goto-char (previous-single-property-change
5978 (point) 'mouse-face nil beg)))
5979 ;; Move to end of the previous completion.
5980 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5981 (goto-char (previous-single-property-change
5982 (point) 'mouse-face nil beg)))
5983 ;; Move to the start of that one.
5984 (goto-char (previous-single-property-change
5985 (point) 'mouse-face nil beg))
5986 (setq n (1+ n))))))
5988 (defun choose-completion (&optional event)
5989 "Choose the completion at point."
5990 (interactive (list last-nonmenu-event))
5991 ;; In case this is run via the mouse, give temporary modes such as
5992 ;; isearch a chance to turn off.
5993 (run-hooks 'mouse-leave-buffer-hook)
5994 (let (buffer base-size base-position choice)
5995 (with-current-buffer (window-buffer (posn-window (event-start event)))
5996 (setq buffer completion-reference-buffer)
5997 (setq base-size completion-base-size)
5998 (setq base-position completion-base-position)
5999 (save-excursion
6000 (goto-char (posn-point (event-start event)))
6001 (let (beg end)
6002 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6003 (setq end (point) beg (1+ (point))))
6004 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6005 (setq end (1- (point)) beg (point)))
6006 (if (null beg)
6007 (error "No completion here"))
6008 (setq beg (previous-single-property-change beg 'mouse-face))
6009 (setq end (or (next-single-property-change end 'mouse-face)
6010 (point-max)))
6011 (setq choice (buffer-substring-no-properties beg end)))))
6013 (let ((owindow (selected-window)))
6014 (select-window (posn-window (event-start event)))
6015 (if (and (one-window-p t 'selected-frame)
6016 (window-dedicated-p (selected-window)))
6017 ;; This is a special buffer's frame
6018 (iconify-frame (selected-frame))
6019 (or (window-dedicated-p (selected-window))
6020 (bury-buffer)))
6021 (select-window
6022 (or (and (buffer-live-p buffer)
6023 (get-buffer-window buffer 0))
6024 owindow)))
6026 (choose-completion-string
6027 choice buffer
6028 (or base-position
6029 (when base-size
6030 ;; Someone's using old completion code that doesn't know
6031 ;; about base-position yet.
6032 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
6033 ;; If all else fails, just guess.
6034 (with-current-buffer buffer
6035 (list (choose-completion-guess-base-position choice)))))))
6037 ;; Delete the longest partial match for STRING
6038 ;; that can be found before POINT.
6039 (defun choose-completion-guess-base-position (string)
6040 (save-excursion
6041 (let ((opoint (point))
6042 len)
6043 ;; Try moving back by the length of the string.
6044 (goto-char (max (- (point) (length string))
6045 (minibuffer-prompt-end)))
6046 ;; See how far back we were actually able to move. That is the
6047 ;; upper bound on how much we can match and delete.
6048 (setq len (- opoint (point)))
6049 (if completion-ignore-case
6050 (setq string (downcase string)))
6051 (while (and (> len 0)
6052 (let ((tail (buffer-substring (point) opoint)))
6053 (if completion-ignore-case
6054 (setq tail (downcase tail)))
6055 (not (string= tail (substring string 0 len)))))
6056 (setq len (1- len))
6057 (forward-char 1))
6058 (point))))
6060 (defun choose-completion-delete-max-match (string)
6061 (delete-region (choose-completion-guess-base-position string) (point)))
6062 (make-obsolete 'choose-completion-delete-max-match
6063 'choose-completion-guess-base-position "23.2")
6065 (defvar choose-completion-string-functions nil
6066 "Functions that may override the normal insertion of a completion choice.
6067 These functions are called in order with four arguments:
6068 CHOICE - the string to insert in the buffer,
6069 BUFFER - the buffer in which the choice should be inserted,
6070 MINI-P - non-nil if BUFFER is a minibuffer, and
6071 BASE-SIZE - the number of characters in BUFFER before
6072 the string being completed.
6074 If a function in the list returns non-nil, that function is supposed
6075 to have inserted the CHOICE in the BUFFER, and possibly exited
6076 the minibuffer; no further functions will be called.
6078 If all functions in the list return nil, that means to use
6079 the default method of inserting the completion in BUFFER.")
6081 (defun choose-completion-string (choice &optional buffer base-position)
6082 "Switch to BUFFER and insert the completion choice CHOICE.
6083 BASE-POSITION, says where to insert the completion."
6085 ;; If BUFFER is the minibuffer, exit the minibuffer
6086 ;; unless it is reading a file name and CHOICE is a directory,
6087 ;; or completion-no-auto-exit is non-nil.
6089 ;; Some older code may call us passing `base-size' instead of
6090 ;; `base-position'. It's difficult to make any use of `base-size',
6091 ;; so we just ignore it.
6092 (unless (consp base-position)
6093 (message "Obsolete `base-size' passed to choose-completion-string")
6094 (setq base-position nil))
6096 (let* ((buffer (or buffer completion-reference-buffer))
6097 (mini-p (minibufferp buffer)))
6098 ;; If BUFFER is a minibuffer, barf unless it's the currently
6099 ;; active minibuffer.
6100 (if (and mini-p
6101 (or (not (active-minibuffer-window))
6102 (not (equal buffer
6103 (window-buffer (active-minibuffer-window))))))
6104 (error "Minibuffer is not active for completion")
6105 ;; Set buffer so buffer-local choose-completion-string-functions works.
6106 (set-buffer buffer)
6107 (unless (run-hook-with-args-until-success
6108 'choose-completion-string-functions
6109 ;; The fourth arg used to be `mini-p' but was useless
6110 ;; (since minibufferp can be used on the `buffer' arg)
6111 ;; and indeed unused. The last used to be `base-size', so we
6112 ;; keep it to try and avoid breaking old code.
6113 choice buffer base-position nil)
6114 ;; Insert the completion into the buffer where it was requested.
6115 (delete-region (or (car base-position) (point))
6116 (or (cadr base-position) (point)))
6117 (insert choice)
6118 (remove-text-properties (- (point) (length choice)) (point)
6119 '(mouse-face nil))
6120 ;; Update point in the window that BUFFER is showing in.
6121 (let ((window (get-buffer-window buffer t)))
6122 (set-window-point window (point)))
6123 ;; If completing for the minibuffer, exit it with this choice.
6124 (and (not completion-no-auto-exit)
6125 (minibufferp buffer)
6126 minibuffer-completion-table
6127 ;; If this is reading a file name, and the file name chosen
6128 ;; is a directory, don't exit the minibuffer.
6129 (let* ((result (buffer-substring (field-beginning) (point)))
6130 (bounds
6131 (completion-boundaries result minibuffer-completion-table
6132 minibuffer-completion-predicate
6133 "")))
6134 (if (eq (car bounds) (length result))
6135 ;; The completion chosen leads to a new set of completions
6136 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6137 (let ((mini (active-minibuffer-window)))
6138 (select-window mini)
6139 (when minibuffer-auto-raise
6140 (raise-frame (window-frame mini))))
6141 (exit-minibuffer))))))))
6143 (define-derived-mode completion-list-mode nil "Completion List"
6144 "Major mode for buffers showing lists of possible completions.
6146 to select the completion near point.
6148 with the mouse.
6151 (set (make-local-variable 'completion-base-size) nil))
6153 (defun completion-list-mode-finish ()
6154 "Finish setup of the completions buffer.
6155 Called from `temp-buffer-show-hook'."
6156 (when (eq major-mode 'completion-list-mode)
6157 (toggle-read-only 1)))
6159 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6162 ;; Variables and faces used in `completion-setup-function'.
6164 (defcustom completion-show-help t
6165 "Non-nil means show help message in *Completions* buffer."
6166 :type 'boolean
6167 :version "22.1"
6168 :group 'completion)
6170 ;; This function goes in completion-setup-hook, so that it is called
6171 ;; after the text of the completion list buffer is written.
6172 (defun completion-setup-function ()
6173 (let* ((mainbuf (current-buffer))
6174 (base-dir
6175 ;; When reading a file name in the minibuffer,
6176 ;; try and find the right default-directory to set in the
6177 ;; completion list buffer.
6178 ;; FIXME: Why do we do that, actually? --Stef
6179 (if minibuffer-completing-file-name
6180 (file-name-as-directory
6181 (expand-file-name
6182 (substring (minibuffer-completion-contents)
6183 0 (or completion-base-size 0)))))))
6184 (with-current-buffer standard-output
6185 (let ((base-size completion-base-size) ;Read before killing localvars.
6186 (base-position completion-base-position))
6187 (completion-list-mode)
6188 (set (make-local-variable 'completion-base-size) base-size)
6189 (set (make-local-variable 'completion-base-position) base-position))
6190 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6191 (if base-dir (setq default-directory base-dir))
6192 ;; Maybe insert help string.
6193 (when completion-show-help
6194 (goto-char (point-min))
6195 (if (display-mouse-p)
6196 (insert (substitute-command-keys
6198 (insert (substitute-command-keys
6202 (add-hook 'completion-setup-hook 'completion-setup-function)
6204 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6205 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6207 (defun switch-to-completions ()
6208 "Select the completion list window."
6209 (interactive)
6210 (let ((window (or (get-buffer-window "*Completions*" 0)
6211 ;; Make sure we have a completions window.
6212 (progn (minibuffer-completion-help)
6213 (get-buffer-window "*Completions*" 0)))))
6214 (when window
6215 (select-window window)
6216 ;; In the new buffer, go to the first completion.
6217 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6218 (when (bobp)
6219 (next-completion 1)))))
6220 \f
6221 ;;; Support keyboard commands to turn on various modifiers.
6223 ;; These functions -- which are not commands -- each add one modifier
6224 ;; to the following event.
6226 (defun event-apply-alt-modifier (ignore-prompt)
6229 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6230 (defun event-apply-super-modifier (ignore-prompt)
6233 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6234 (defun event-apply-hyper-modifier (ignore-prompt)
6237 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6238 (defun event-apply-shift-modifier (ignore-prompt)
6241 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6242 (defun event-apply-control-modifier (ignore-prompt)
6245 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6246 (defun event-apply-meta-modifier (ignore-prompt)
6249 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6251 (defun event-apply-modifier (event symbol lshiftby prefix)
6252 "Apply a modifier flag to event EVENT.
6253 SYMBOL is the name of this modifier, as a symbol.
6254 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6255 PREFIX is the string that represents this modifier in an event type symbol."
6256 (if (numberp event)
6257 (cond ((eq symbol 'control)
6258 (if (and (<= (downcase event) ?z)
6259 (>= (downcase event) ?a))
6260 (- (downcase event) ?a -1)
6261 (if (and (<= (downcase event) ?Z)
6262 (>= (downcase event) ?A))
6263 (- (downcase event) ?A -1)
6264 (logior (lsh 1 lshiftby) event))))
6265 ((eq symbol 'shift)
6266 (if (and (<= (downcase event) ?z)
6267 (>= (downcase event) ?a))
6268 (upcase event)
6269 (logior (lsh 1 lshiftby) event)))
6270 (t
6271 (logior (lsh 1 lshiftby) event)))
6272 (if (memq symbol (event-modifiers event))
6273 event
6274 (let ((event-type (if (symbolp event) event (car event))))
6275 (setq event-type (intern (concat prefix (symbol-name event-type))))
6276 (if (symbolp event)
6277 event-type
6278 (cons event-type (cdr event)))))))
6280 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6281 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6282 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6283 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6284 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6285 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6286 \f
6287 ;;;; Keypad support.
6289 ;; Make the keypad keys act like ordinary typing keys. If people add
6290 ;; bindings for the function key symbols, then those bindings will
6291 ;; override these, so this shouldn't interfere with any existing
6292 ;; bindings.
6294 ;; Also tell read-char how to handle these keys.
6295 (mapc
6296 (lambda (keypad-normal)
6297 (let ((keypad (nth 0 keypad-normal))
6298 (normal (nth 1 keypad-normal)))
6299 (put keypad 'ascii-character normal)
6300 (define-key function-key-map (vector keypad) (vector normal))))
6301 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6302 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6303 (kp-space ?\s)
6306 (kp-multiply ?*)
6307 (kp-add ?+)
6308 (kp-separator ?,)
6309 (kp-subtract ?-)
6310 (kp-decimal ?.)
6311 (kp-divide ?/)
6312 (kp-equal ?=)
6313 ;; Do the same for various keys that are represented as symbols under
6314 ;; GUIs but naturally correspond to characters.
6315 (backspace 127)
6316 (delete 127)
6319 (clear ?\C-l)
6320 (return ?\C-m)
6321 (escape ?\e)
6322 ))
6323 \f
6324 ;;;;
6325 ;;;; forking a twin copy of a buffer.
6326 ;;;;
6328 (defvar clone-buffer-hook nil
6329 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6331 (defvar clone-indirect-buffer-hook nil
6332 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6334 (defun clone-process (process &optional newname)
6335 "Create a twin copy of PROCESS.
6336 If NEWNAME is nil, it defaults to PROCESS' name;
6337 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6338 If PROCESS is associated with a buffer, the new process will be associated
6339 with the current buffer instead.
6340 Returns nil if PROCESS has already terminated."
6341 (setq newname (or newname (process-name process)))
6343 (setq newname (substring newname 0 (match-beginning 0))))
6344 (when (memq (process-status process) '(run stop open))
6345 (let* ((process-connection-type (process-tty-name process))
6346 (new-process
6347 (if (memq (process-status process) '(open))
6348 (let ((args (process-contact process t)))
6349 (setq args (plist-put args :name newname))
6350 (setq args (plist-put args :buffer
6351 (if (process-buffer process)
6352 (current-buffer))))
6353 (apply 'make-network-process args))
6354 (apply 'start-process newname
6355 (if (process-buffer process) (current-buffer))
6356 (process-command process)))))
6357 (set-process-query-on-exit-flag
6358 new-process (process-query-on-exit-flag process))
6359 (set-process-inherit-coding-system-flag
6360 new-process (process-inherit-coding-system-flag process))
6361 (set-process-filter new-process (process-filter process))
6362 (set-process-sentinel new-process (process-sentinel process))
6363 (set-process-plist new-process (copy-sequence (process-plist process)))
6364 new-process)))
6366 ;; things to maybe add (currently partly covered by `funcall mode'):
6367 ;; - syntax-table
6368 ;; - overlays
6369 (defun clone-buffer (&optional newname display-flag)
6370 "Create and return a twin copy of the current buffer.
6371 Unlike an indirect buffer, the new buffer can be edited
6372 independently of the old one (if it is not read-only).
6373 NEWNAME is the name of the new buffer. It may be modified by
6374 adding or incrementing <N> at the end as necessary to create a
6375 unique buffer name. If nil, it defaults to the name of the
6376 current buffer, with the proper suffix. If DISPLAY-FLAG is
6377 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6378 clone a file-visiting buffer, or a buffer whose major mode symbol
6379 has a non-nil `no-clone' property, results in an error.
6381 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6382 current buffer with appropriate suffix. However, if a prefix
6383 argument is given, then the command prompts for NEWNAME in the
6384 minibuffer.
6386 This runs the normal hook `clone-buffer-hook' in the new buffer
6387 after it has been set up properly in other respects."
6388 (interactive
6389 (progn
6390 (if buffer-file-name
6391 (error "Cannot clone a file-visiting buffer"))
6392 (if (get major-mode 'no-clone)
6393 (error "Cannot clone a buffer in %s mode" mode-name))
6394 (list (if current-prefix-arg
6395 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6396 t)))
6397 (if buffer-file-name
6398 (error "Cannot clone a file-visiting buffer"))
6399 (if (get major-mode 'no-clone)
6400 (error "Cannot clone a buffer in %s mode" mode-name))
6401 (setq newname (or newname (buffer-name)))
6403 (setq newname (substring newname 0 (match-beginning 0))))
6404 (let ((buf (current-buffer))
6405 (ptmin (point-min))
6406 (ptmax (point-max))
6407 (pt (point))
6408 (mk (if mark-active (mark t)))
6409 (modified (buffer-modified-p))
6410 (mode major-mode)
6411 (lvars (buffer-local-variables))
6412 (process (get-buffer-process (current-buffer)))
6413 (new (generate-new-buffer (or newname (buffer-name)))))
6414 (save-restriction
6415 (widen)
6416 (with-current-buffer new
6417 (insert-buffer-substring buf)))
6418 (with-current-buffer new
6419 (narrow-to-region ptmin ptmax)
6420 (goto-char pt)
6421 (if mk (set-mark mk))
6422 (set-buffer-modified-p modified)
6424 ;; Clone the old buffer's process, if any.
6425 (when process (clone-process process))
6427 ;; Now set up the major mode.
6428 (funcall mode)
6430 ;; Set up other local variables.
6431 (mapc (lambda (v)
6432 (condition-case () ;in case var is read-only
6433 (if (symbolp v)
6434 (makunbound v)
6435 (set (make-local-variable (car v)) (cdr v)))
6436 (error nil)))
6437 lvars)
6439 ;; Run any hooks (typically set up by the major mode
6440 ;; for cloning to work properly).
6441 (run-hooks 'clone-buffer-hook))
6442 (if display-flag
6443 ;; Presumably the current buffer is shown in the selected frame, so
6444 ;; we want to display the clone elsewhere.
6445 (let ((same-window-regexps nil)
6446 (same-window-buffer-names))
6447 (pop-to-buffer new)))
6448 new))
6451 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6452 "Create an indirect buffer that is a twin copy of the current buffer.
6454 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6455 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6456 or if not called with a prefix arg, NEWNAME defaults to the current
6457 buffer's name. The name is modified by adding a `<N>' suffix to it
6458 or by incrementing the N in an existing suffix. Trying to clone a
6459 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6460 property results in an error.
6462 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6463 This is always done when called interactively.
6465 Optional third arg NORECORD non-nil means do not put this buffer at the
6466 front of the list of recently selected ones."
6467 (interactive
6468 (progn
6469 (if (get major-mode 'no-clone-indirect)
6470 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6471 (list (if current-prefix-arg
6472 (read-buffer "Name of indirect buffer: " (current-buffer)))
6473 t)))
6474 (if (get major-mode 'no-clone-indirect)
6475 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6476 (setq newname (or newname (buffer-name)))
6478 (setq newname (substring newname 0 (match-beginning 0))))
6479 (let* ((name (generate-new-buffer-name newname))
6480 (buffer (make-indirect-buffer (current-buffer) name t)))
6481 (with-current-buffer buffer
6482 (run-hooks 'clone-indirect-buffer-hook))
6483 (when display-flag
6484 (pop-to-buffer buffer norecord))
6485 buffer))
6488 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6489 "Like `clone-indirect-buffer' but display in another window."
6490 (interactive
6491 (progn
6492 (if (get major-mode 'no-clone-indirect)
6493 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6494 (list (if current-prefix-arg
6495 (read-buffer "Name of indirect buffer: " (current-buffer)))
6496 t)))
6497 (let ((pop-up-windows t))
6498 (clone-indirect-buffer newname display-flag norecord)))
6500 \f
6501 ;;; Handling of Backspace and Delete keys.
6503 (defcustom normal-erase-is-backspace 'maybe
6504 "Set the default behavior of the Delete and Backspace keys.
6506 If set to t, Delete key deletes forward and Backspace key deletes
6507 backward.
6509 If set to nil, both Delete and Backspace keys delete backward.
6511 If set to 'maybe (which is the default), Emacs automatically
6512 selects a behavior. On window systems, the behavior depends on
6513 the keyboard used. If the keyboard has both a Backspace key and
6514 a Delete key, and both are mapped to their usual meanings, the
6515 option's default value is set to t, so that Backspace can be used
6516 to delete backward, and Delete can be used to delete forward.
6518 If not running under a window system, customizing this option
6519 accomplishes a similar effect by mapping C-h, which is usually
6520 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6521 via `keyboard-translate'. The former functionality of C-h is
6522 available on the F1 key. You should probably not use this
6523 setting if you don't have both Backspace, Delete and F1 keys.
6525 Setting this variable with setq doesn't take effect. Programmatically,
6526 call `normal-erase-is-backspace-mode' (which see) instead."
6527 :type '(choice (const :tag "Off" nil)
6528 (const :tag "Maybe" maybe)
6529 (other :tag "On" t))
6530 :group 'editing-basics
6531 :version "21.1"
6532 :set (lambda (symbol value)
6533 ;; The fboundp is because of a problem with :set when
6534 ;; dumping Emacs. It doesn't really matter.
6535 (if (fboundp 'normal-erase-is-backspace-mode)
6536 (normal-erase-is-backspace-mode (or value 0))
6537 (set-default symbol value))))
6539 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6540 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6541 (unless frame (setq frame (selected-frame)))
6542 (with-selected-frame frame
6543 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6544 (normal-erase-is-backspace-mode
6545 (if (if (eq normal-erase-is-backspace 'maybe)
6546 (and (not noninteractive)
6547 (or (memq system-type '(ms-dos windows-nt))
6548 (memq window-system '(ns))
6549 (and (memq window-system '(x))
6550 (fboundp 'x-backspace-delete-keys-p)
6551 (x-backspace-delete-keys-p))
6552 ;; If the terminal Emacs is running on has erase char
6553 ;; set to ^H, use the Backspace key for deleting
6554 ;; backward, and the Delete key for deleting forward.
6555 (and (null window-system)
6556 (eq tty-erase-char ?\^H))))
6557 normal-erase-is-backspace)
6558 1 0)))))
6560 (define-minor-mode normal-erase-is-backspace-mode
6561 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6563 With numeric ARG, turn the mode on if and only if ARG is positive.
6565 On window systems, when this mode is on, Delete is mapped to C-d
6566 and Backspace is mapped to DEL; when this mode is off, both
6567 Delete and Backspace are mapped to DEL. (The remapping goes via
6568 `local-function-key-map', so binding Delete or Backspace in the
6569 global or local keymap will override that.)
6571 In addition, on window systems, the bindings of C-Delete, M-Delete,
6572 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6573 the global keymap in accordance with the functionality of Delete and
6574 Backspace. For example, if Delete is remapped to C-d, which deletes
6575 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6576 to DEL, which deletes backward, C-Delete is bound to
6577 `backward-kill-word'.
6579 If not running on a window system, a similar effect is accomplished by
6580 remapping C-h (normally produced by the Backspace key) and DEL via
6581 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6582 to C-d; if it's off, the keys are not remapped.
6584 When not running on a window system, and this mode is turned on, the
6585 former functionality of C-h is available on the F1 key. You should
6586 probably not turn on this mode on a text-only terminal if you don't
6587 have both Backspace, Delete and F1 keys.
6589 See also `normal-erase-is-backspace'."
6590 :variable (eq (terminal-parameter
6591 nil 'normal-erase-is-backspace) 1)
6592 (let ((enabled (eq 1 (terminal-parameter
6593 nil 'normal-erase-is-backspace))))
6595 (cond ((or (memq window-system '(x w32 ns pc))
6596 (memq system-type '(ms-dos windows-nt)))
6597 (let* ((bindings
6598 `(([M-delete] [M-backspace])
6599 ([C-M-delete] [C-M-backspace])
6600 ([?\e C-delete] [?\e C-backspace])))
6601 (old-state (lookup-key local-function-key-map [delete])))
6603 (if enabled
6604 (progn
6605 (define-key local-function-key-map [delete] [deletechar])
6606 (define-key local-function-key-map [kp-delete] [?\C-d])
6607 (define-key local-function-key-map [backspace] [?\C-?])
6608 (dolist (b bindings)
6609 ;; Not sure if input-decode-map is really right, but
6610 ;; keyboard-translate-table (used below) only works
6611 ;; for integer events, and key-translation-table is
6612 ;; global (like the global-map, used earlier).
6613 (define-key input-decode-map (car b) nil)
6614 (define-key input-decode-map (cadr b) nil)))
6615 (define-key local-function-key-map [delete] [?\C-?])
6616 (define-key local-function-key-map [kp-delete] [?\C-?])
6617 (define-key local-function-key-map [backspace] [?\C-?])
6618 (dolist (b bindings)
6619 (define-key input-decode-map (car b) (cadr b))
6620 (define-key input-decode-map (cadr b) (car b))))))
6621 (t
6622 (if enabled
6623 (progn
6624 (keyboard-translate ?\C-h ?\C-?)
6625 (keyboard-translate ?\C-? ?\C-d))
6626 (keyboard-translate ?\C-h ?\C-h)
6627 (keyboard-translate ?\C-? ?\C-?))))
6629 (if (called-interactively-p 'interactive)
6630 (message "Delete key deletes %s"
6631 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6632 "forward" "backward")))))
6633 \f
6634 (defvar vis-mode-saved-buffer-invisibility-spec nil
6635 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6637 (define-minor-mode visible-mode
6638 "Toggle Visible mode.
6639 With argument ARG turn Visible mode on if ARG is positive, otherwise
6640 turn it off.
6642 Enabling Visible mode makes all invisible text temporarily visible.
6643 Disabling Visible mode turns off that effect. Visible mode works by
6644 saving the value of `buffer-invisibility-spec' and setting it to nil."
6645 :lighter " Vis"
6646 :group 'editing-basics
6647 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6648 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6649 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6650 (when visible-mode
6651 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6652 buffer-invisibility-spec)
6653 (setq buffer-invisibility-spec nil)))
6654 \f
6655 ;; Partial application of functions (similar to "currying").
6656 ;; This function is here rather than in subr.el because it uses CL.
6657 (defun apply-partially (fun &rest args)
6658 "Return a function that is a partial application of FUN to ARGS.
6659 ARGS is a list of the first N arguments to pass to FUN.
6660 The result is a new function which does the same as FUN, except that
6661 the first N arguments are fixed at the values with which this function
6662 was called."
6663 (lexical-let ((fun fun) (args1 args))
6664 (lambda (&rest args2) (apply fun (append args1 args2)))))
6665 \f
6666 ;; Minibuffer prompt stuff.
6668 ;(defun minibuffer-prompt-modification (start end)
6669 ; (error "You cannot modify the prompt"))
6670 ;
6671 ;
6672 ;(defun minibuffer-prompt-insertion (start end)
6673 ; (let ((inhibit-modification-hooks t))
6674 ; (delete-region start end)
6675 ; ;; Discard undo information for the text insertion itself
6676 ; ;; and for the text deletion.above.
6677 ; (when (consp buffer-undo-list)
6678 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6679 ; (message "You cannot modify the prompt")))
6680 ;
6681 ;
6682 ;(setq minibuffer-prompt-properties
6683 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6684 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6685 ;
6687 \f
6688 ;;;; Problematic external packages.
6690 ;; rms says this should be done by specifying symbols that define
6691 ;; versions together with bad values. This is therefore not as
6692 ;; flexible as it could be. See the thread:
6693 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6694 (defconst bad-packages-alist
6695 ;; Not sure exactly which semantic versions have problems.
6696 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6698 "The version of `semantic' loaded does not work in Emacs 22.
6699 It can cause constant high CPU load.
6700 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6701 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6702 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6703 ;; provided the `CUA-mode' feature. Since this is no longer true,
6704 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6705 (CUA-mode t nil
6706 "CUA-mode is now part of the standard GNU Emacs distribution,
6707 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6709 You have loaded an older version of CUA-mode which does not work
6710 correctly with this version of Emacs. You should remove the old
6711 version and use the one distributed with Emacs."))
6712 "Alist of packages known to cause problems in this version of Emacs.
6713 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6714 PACKAGE is either a regular expression to match file names, or a
6715 symbol (a feature name); see the documentation of
6716 `after-load-alist', to which this variable adds functions.
6717 SYMBOL is either the name of a string variable, or `t'. Upon
6718 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6719 warning using STRING as the message.")
6721 (defun bad-package-check (package)
6722 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6723 (condition-case nil
6724 (let* ((list (assoc package bad-packages-alist))
6725 (symbol (nth 1 list)))
6726 (and list
6727 (boundp symbol)
6728 (or (eq symbol t)
6729 (and (stringp (setq symbol (eval symbol)))
6730 (string-match-p (nth 2 list) symbol)))
6731 (display-warning package (nth 3 list) :warning)))
6732 (error nil)))
6734 (mapc (lambda (elem)
6735 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6736 bad-packages-alist)
6739 (provide 'simple)
6741 ;;; simple.el ends here