| blob | d9468ed5cf64724b8e7ac9e333fbb9715a812593 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2012 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:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 When turned on, cursor motion in the compilation, grep, occur or diff
325 buffer causes automatic display of the corresponding source code
326 location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
355 ;; Special major modes to view specially formatted data rather than files.
369 map))
373 "Parent major mode from which special major modes should inherit."
376 ;; Major mode meant to be the parent of programming modes.
381 map)
385 "Indent the expression after point."
392 "Major mode for editing programming language source code."
395 ;; Any programming language is always written left to right.
398 ;; Making and deleting lines.
404 "Insert a newline, and move to left margin of the new line if it's blank.
405 If `use-hard-newlines' is non-nil, the newline is marked with the
406 text-property `hard'.
407 With ARG, insert that many newlines.
408 Call `auto-fill-function' if the current column number is greater
409 than the value of `fill-column' and ARG is nil."
412 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
413 ;; Set last-command-event to tell self-insert what to insert.
417 ;; Don't auto-fill if we have a numeric argument.
420 ;; Do the rest in post-self-insert-hook, because we want to do it
421 ;; *before* other functions on that hook.
423 ;; Mark the newline(s) `hard'.
427 ;; If the newline leaves the previous line blank, and we
428 ;; have a left margin, delete that from the blank line.
436 ;; Indent the line after the newline, except in one case:
437 ;; when we added the newline at the beginning of a line which
438 ;; starts a page.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
449 nil)
454 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
460 "Insert a newline and leave point before it.
461 If there is a fill prefix and/or a `left-margin', insert them
462 on the new line if the line would have been blank.
463 With arg N, insert N newlines."
468 ;; Don't expand an abbrev before point.
482 "Split current line, moving portion beyond point vertically down.
483 If the current line starts with `fill-prefix', insert it on the new
484 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
486 When called from Lisp code, ARG may be a prefix string to copy."
491 ;; What prefix should we check for (nil means don't).
495 ;; Does this line start with it?
506 "Join this line to previous and fix up whitespace at join.
507 If there is a fill prefix, delete it from the beginning of this line.
508 With argument, join this line to following line."
515 ;; If the second line started with the fill prefix,
516 ;; delete the prefix.
528 "On blank line, delete all surrounding blank lines, leaving just one.
529 On isolated blank line, delete that one.
530 On nonblank line, delete any immediately following blank lines."
536 ;; Set singleblank if there is just one blank line here.
543 ;; Delete preceding blank lines, and this one too if it's the only one.
552 ;; Delete following blank lines, unless the current line is blank
553 ;; and there are no following blank lines.
562 ;; Handle the special case where point is followed by newline and eob.
563 ;; Delete the line, leaving point at eob.
568 "Delete all the trailing whitespace across the current buffer.
569 All whitespace after the last non-whitespace character in a line is deleted.
571 A formfeed is not considered whitespace by this function.
572 If END is nil, also delete all trailing lines at the end of the buffer.
573 If the region is active, only delete whitespace within the region."
586 ;; Don't delete formfeeds, even if they are considered whitespace.
590 ;; Delete trailing empty lines.
593 ;; Really the end of buffer.
598 ;; Return nil for the benefit of `write-file-functions'.
599 nil)
602 "Insert a newline, then indent according to major mode.
603 Indentation is done using the value of `indent-line-function'.
604 In programming language modes, this is the same as TAB.
605 In some text modes, where TAB inserts a tab, this command indents to the
606 column specified by the function `current-left-margin'."
613 "Reindent current line, insert newline, then indent the new line.
614 Indentation of both lines is done according to the current major mode,
615 which means calling the current value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this indents to the
618 column specified by the function `current-left-margin'."
621 ;; Be careful to insert the newline before indenting the line.
622 ;; Otherwise, the indentation might be wrong.
626 ;; We are at EOL before the call to indent-according-to-mode, and
627 ;; after it we usually are as well, but not always. We tried to
628 ;; address it with `save-excursion' but that uses a normal marker
629 ;; whereas we need `move after insertion', so we do the save/restore
630 ;; by hand.
634 ;; Remove the trailing white-space after indentation because
635 ;; indentation may introduce the whitespace.
640 "Read next input character and insert it.
641 This is useful for inserting control characters.
642 With argument, insert ARG copies of the character.
644 If the first character you type after this command is an octal digit,
645 you should type a sequence of octal digits which specify a character code.
646 Any nondigit terminates the sequence. If the terminator is a RET,
647 it is discarded; any other terminator is used itself as input.
648 The variable `read-quoted-char-radix' specifies the radix for this feature;
649 set it to 10 or 16 to use decimal or hex instead of octal.
651 In overwrite mode, this function inserts the character anyway, and
652 does not handle octal digits specially. This means that if you use
653 overwrite as your normal editing mode, you can use this function to
654 insert characters when necessary.
656 In binary overwrite mode, this function does overwrite, and octal
657 digits are interpreted as a character code. This is intended to be
658 useful for editing binary files."
661 ;; Avoid "obsolete" warnings for translation-table-for-input.
668 ;; This used to assume character codes 0240 - 0377 stand for
669 ;; characters in some single-byte character set, and converted them
670 ;; to Emacs characters. But in 23.1 this feature is deprecated
671 ;; in favor of inserting the corresponding Unicode characters.
672 ;; (if (and enable-multibyte-characters
673 ;; (>= char ?\240)
674 ;; (<= char ?\377))
675 ;; (setq char (unibyte-char-to-multibyte char)))
684 "Move forward ARG lines and position at first nonblank character."
690 "Move backward ARG lines and position at first nonblank character."
696 "Move point to the first non-whitespace character on this line."
700 ;; Move back over chars that have whitespace syntax but have the p flag.
704 "Fixup white space between objects around point.
705 Leave one space or none, according to the context."
712 nil
716 "Delete all spaces and tabs around point.
717 If BACKWARD-ONLY is non-nil, only delete them before point."
722 orig-pos
731 "Delete all spaces and tabs around point, leaving one space (or N spaces).
732 If N is negative, delete newlines as well."
749 \f
751 "Move point to the beginning of the buffer.
752 With numeric arg N, put point N/10 of the way from the beginning.
753 If the buffer is narrowed, this command uses the beginning of the
754 accessible part of the buffer.
756 If Transient Mark mode is disabled, leave mark at previous
759 Don't use this command in Lisp programs!
760 \(goto-char (point-min)) is faster."
769 ;; Avoid overflow for large buffer sizes!
777 "Move point to the end of the buffer.
778 With numeric arg N, put point N/10 of the way from the end.
779 If the buffer is narrowed, this command uses the end of the
780 accessible part of the buffer.
782 If Transient Mark mode is disabled, leave mark at previous
785 Don't use this command in Lisp programs!
786 \(goto-char (point-max)) is faster."
793 ;; Avoid overflow for large buffer sizes!
798 ;; If we went to a place in the middle of the buffer,
799 ;; adjust it to the beginning of a line.
802 ;; If the end of the buffer is not already on the screen,
803 ;; then scroll specially to put it near, but not at, the bottom.
808 "Whether single-char deletion commands delete an active region.
809 This has an effect only if Transient Mark mode is enabled, and
810 affects `delete-forward-char' and `delete-backward-char', though
811 not `delete-char'.
813 If the value is the symbol `kill', the active region is killed
814 instead of deleted."
822 "Delete the previous N characters (following if N is negative).
823 If Transient Mark mode is enabled, the mark is active, and N is 1,
824 delete the text in the region and deactivate the mark instead.
825 To disable this, set `delete-active-region' to nil.
827 Optional second arg KILLFLAG, if non-nil, means to kill (save in
828 kill ring) instead of delete. Interactively, N is the prefix
829 arg, and KILLFLAG is set if N is explicitly specified.
831 In Overwrite mode, single character backward deletion may replace
832 tabs with spaces so as to back over columns, unless point is at
833 the end of the line."
838 delete-active-region
840 ;; If a region is active, kill or delete it.
844 ;; In Overwrite mode, maybe untabify while deleting
854 ;; Otherwise, do simple deletion.
858 "Delete the following N characters (previous if N is negative).
859 If Transient Mark mode is enabled, the mark is active, and N is 1,
860 delete the text in the region and deactivate the mark instead.
861 To disable this, set `delete-active-region' to nil.
863 Optional second arg KILLFLAG non-nil means to kill (save in kill
864 ring) instead of delete. Interactively, N is the prefix arg, and
865 KILLFLAG is set if N was explicitly specified."
870 delete-active-region
872 ;; If a region is active, kill or delete it.
876 ;; Otherwise, do simple deletion.
880 "Put point at beginning and mark at end of buffer.
881 If narrowing is in effect, only uses the accessible part of the buffer.
882 You probably should not use this function in Lisp programs;
883 it is usually a mistake for a Lisp function to use any subroutine
884 that uses or sets the mark."
889 \f
891 ;; Counting lines, one way or another.
894 "Goto LINE, counting from line 1 at beginning of buffer.
895 Normally, move point in the current buffer, and leave mark at the
897 move point in the most recently selected other buffer, and switch to it.
899 If there's a number in the buffer at point, it is the default for LINE.
901 This function is usually the wrong thing to use in a Lisp program.
902 What you probably want instead is something like:
903 (goto-char (point-min)) (forward-line (1- N))
904 If at all possible, an even better solution is to use char counts
905 rather than line counts."
909 ;; Look for a default, a number in the buffer at point.
919 ;; Decide if we're switching buffers.
927 ;; Read the argument, offering that number (if any) as default.
930 buffer-prompt
931 default)
932 default)
933 buffer))))
934 ;; Switch to the desired buffer, one way or another.
939 ;; Leave mark at previous position
941 ;; Move to the specified line number in that buffer.
950 "Return the number of words between START and END.
951 If called interactively, print a message reporting the number of
952 lines, words, and characters in the region."
964 words
966 words))
969 "Display the number of lines, words, and characters in the buffer.
970 In Transient Mark mode when the mark is active, display the
971 number of lines, words, and characters in the region."
984 str
992 "Print the current buffer line number and narrowed line number of point."
1005 "Return number of lines between START and END.
1006 This is usually the number of newlines between them,
1007 but can be one more if START is not equal to END
1008 and the greater of them is not at the start of a line."
1024 done)))
1028 "Return (narrowed) buffer line number at position POS.
1029 If POS is nil, use current buffer location.
1030 Counting starts at (point-min), so the value refers
1031 to the contents of the accessible portion of the buffer."
1041 "Print info on cursor position (on screen and within buffer).
1042 Also describe the character after point, and give its character code
1043 in octal, decimal and hex.
1045 For a non-ASCII multibyte character, also give its encoding in the
1046 buffer's selected coding system if the coding system encodes the
1047 character safely. If the character is encoded into one byte, that
1048 code is shown in hex. If the character is encoded into more than one
1051 In addition, with prefix argument, show details about that character
1052 in *Help* buffer. See also the command `describe-char'."
1057 ;; If the character is one of LRE, LRO, RLE, RLO, it
1058 ;; will start a directional embedding, which could
1059 ;; completely disrupt the rest of the line (e.g., RLO
1060 ;; will display the rest of the line right-to-left).
1061 ;; So we put an invisible PDF character after these
1062 ;; characters, to end the embedding, which eliminates
1063 ;; any effects on the rest of the line.
1065 ;; Strong right-to-left characters cause reordering of
1066 ;; the following numerical characters which show the
1067 ;; codepoint, so append LRM to countermand that.
1077 ;; Avoid overflow from multiplying by 100!
1081 ""
1087 pos total percent beg end col hscroll)
1089 pos total col hscroll))
1091 encoded encoding-msg display-prop under-display)
1098 ;; Check if the character is displayed with some `display'
1099 ;; text property. In that case, set under-display to the
1100 ;; buffer substring covered by that property.
1111 under-display)))
1117 char char char under-display)
1119 char char char under-display display-prop))
1122 char char char
1124 "..."
1128 ;; We show the detailed information about CHAR.
1135 bidi-fixer
1136 encoding-msg pos total percent beg end col hscroll)
1143 bidi-fixer encoding-msg pos total percent col hscroll))))))
1144 \f
1145 ;; Initialize read-expression-map. It is defined at C level.
1148 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1149 ;; too rarely useful.
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 When called interactively, read an Emacs Lisp expression and
1207 evaluate it.
1208 Value is also consed on to front of the variable `values'.
1209 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1210 with prefix argument) means insert the result into the current buffer
1211 instead of printing it in the echo area. Truncates long output
1212 according to the value of the variables `eval-expression-print-length'
1213 and `eval-expression-print-level'.
1215 If `eval-expression-debug-on-error' is non-nil, which is the default,
1216 this command arranges for all errors to enter the debugger."
1220 nil read-expression-map t
1222 current-prefix-arg))
1227 ;; Bind debug-on-error to something unique so that we can
1228 ;; detect when evalled code changes it.
1232 ;; If evalled code has changed the value of debug-on-error,
1233 ;; propagate that change to the global binding.
1249 "Prompting with PROMPT, let user edit COMMAND and eval result.
1250 COMMAND is a Lisp expression. Let user edit that expression in
1251 the minibuffer, then read and evaluate the result."
1258 read-expression-map t
1260 ;; If command was added to command-history as a string,
1261 ;; get rid of that. We want only evaluable expressions there.
1265 ;; If command to be redone does not match front of history,
1266 ;; add it to the history.
1272 "Edit and re-evaluate last complex command, or ARGth from last.
1273 A complex command is one which used the minibuffer.
1274 The command is placed in the minibuffer as a Lisp form for editing.
1275 The result is executed, repeating the command as changed.
1276 If the command has been changed or is not the most recent previous
1277 command it is added to the front of the command history.
1278 You can use the minibuffer history commands \
1280 to get different commands to edit and resubmit."
1283 newcmd)
1295 ;; If command was added to command-history as a
1296 ;; string, get rid of that. We want only
1297 ;; evaluable expressions there.
1301 ;; If command to be redone does not match front of history,
1302 ;; add it to the history.
1311 "Read command name to invoke in `execute-extended-command'."
1316 ;; Get a command name at point in the original buffer
1317 ;; to propose it after M-n.
1321 ;; Read a string, completing from and restricting to the set of
1322 ;; all defined commands. Don't provide any initial input.
1323 ;; Save the command read on the extended-command history list.
1334 ;; This isn't strictly correct if `execute-extended-command'
1335 ;; is bound to anything else (e.g. [menu]).
1336 ;; It could use (key-description (this-single-command-keys)),
1337 ;; but actually a prompt other than "M-x" would be confusing,
1338 ;; because "M-x" is a well-known prompt to read a command
1339 ;; and it serves as a shorthand for "Extended command: ".
1343 \f
1345 "Default minibuffer history list.
1346 This is used for all minibuffer input
1347 except when an alternate history list is specified.
1349 Maximum length of the history list is determined by the value
1352 "Control whether history list elements are expressions or strings.
1353 If the value of this variable equals current minibuffer depth,
1354 they are expressions; otherwise they are strings.
1355 \(That convention is designed to do the right thing for
1362 "Text that was in this minibuffer before any history commands.
1363 This is nil if there have not yet been any history commands
1372 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1376 "Minibuffer history variables for which matching should ignore case.
1377 If a history variable is a member of this list, then the
1379 commands ignore case when searching it, regardless of `case-fold-search'."
1384 "Find the previous history element that matches REGEXP.
1385 \(Previous history elements refer to earlier actions.)
1386 With prefix argument N, search for Nth previous match.
1387 If N is negative, find the next or Nth next match.
1388 Normally, history elements are matched case-insensitively if
1389 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1390 makes the search case-sensitive.
1391 See also `minibuffer-history-case-insensitive-variables'."
1395 nil
1396 minibuffer-local-map
1397 nil
1398 'minibuffer-history-search-history
1400 ;; Use the last regexp specified, by default, if input is empty.
1405 regexp)
1415 ;; On some systems, ignore case for file names.
1417 minibuffer-history-case-insensitive-variables)
1418 t
1419 ;; Respect the user's setting for case-fold-search:
1420 case-fold-search)
1421 nil))
1422 prevpos
1423 match-string
1424 match-offset
1431 "No later matching history item"
1452 next-matching-history-element))
1456 "Find the next history element that matches REGEXP.
1457 \(The next history element refers to a more recent action.)
1458 With prefix argument N, search for Nth next match.
1459 If N is negative, find the previous or Nth previous match.
1460 Normally, history elements are matched case-insensitively if
1461 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1462 makes the search case-sensitive."
1466 nil
1467 minibuffer-local-map
1468 nil
1469 'minibuffer-history-search-history
1471 ;; Use the last regexp specified, by default, if input is empty.
1476 regexp)
1483 "Function run by `goto-history-element' before consuming default values.
1484 This is useful to dynamically add more elements to the list of default values
1485 when `goto-history-element' reaches the end of this list.
1486 Before calling this function `goto-history-element' sets the variable
1487 `minibuffer-default-add-done' to t, so it will call this function only
1488 once. In special cases, when this function needs to be called more
1489 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1493 "When nil, add more elements to the end of the list of default values.
1494 The value nil causes `goto-history-element' to add more elements to
1495 the list of defaults when it reaches the end of this list. It does
1501 "Return a list of all completions without the default value.
1502 This function is used to add all elements of the completion table to
1503 the end of the list of defaults just after the default value."
1506 minibuffer-completion-table
1507 minibuffer-completion-predicate)))
1513 "Puts element of the minibuffer history in the minibuffer.
1514 The argument NABS specifies the absolute history position."
1528 elt minibuffer-returned-to-present)
1540 previous-history-element))
1552 minibuffer-default)))
1564 elt))
1568 "Puts next element of the minibuffer history in the minibuffer.
1569 With argument N, it uses the Nth following element."
1575 "Puts previous element of the minibuffer history in the minibuffer.
1576 With argument N, it uses the Nth previous element."
1582 "Get next history element which completes the minibuffer before the point.
1583 The contents of the minibuffer after the point are deleted, and replaced
1584 by the new completion."
1590 n)
1591 ;; next-matching-history-element always puts us at (point-min).
1592 ;; Move to the position we were at before changing the buffer contents.
1593 ;; This is still sensible, because the text before point has not changed.
1597 "\
1598 Get previous history element which completes the minibuffer before the point.
1599 The contents of the minibuffer after the point are deleted, and replaced
1600 by the new completion."
1604 ;; For compatibility with the old subr of the same name.
1606 "Return the display width of the minibuffer prompt.
1607 Return 0 if current buffer is not a minibuffer."
1608 ;; Return the width of everything before the field at the end of
1609 ;; the buffer; this should be 0 for normal buffers.
1611 \f
1612 ;; isearch minibuffer history
1619 "Set up a minibuffer for using isearch to search the minibuffer history.
1620 Intended to be added to `minibuffer-setup-hook'."
1632 "Clean up the minibuffer after terminating isearch in the minibuffer."
1637 "Return the proper search function, for isearch in minibuffer history."
1644 ;; Use standard functions to search within minibuffer text
1650 found)
1651 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1652 ;; searching forward. Lazy-highlight calls this lambda with the
1653 ;; bound arg, so skip the minibuffer prompt.
1657 ;; 1. First try searching in the initial minibuffer text
1660 noerror)
1661 ;; 2. If the above search fails, start putting next/prev history
1662 ;; elements in the minibuffer successively, and search the string
1663 ;; in them. Do this only when bound is nil (i.e. not while
1664 ;; lazy-highlighting search strings in the current minibuffer text).
1676 ;; After putting the next/prev history element, search
1677 ;; the string in them again, until next-history-element
1678 ;; or previous-history-element raises an error at the
1679 ;; beginning/end of history.
1682 ;; For backward search, don't search
1683 ;; in the minibuffer prompt
1685 noerror)))
1686 ;; Return point of the new search result
1688 ;; Return nil when next(prev)-history-element fails
1692 "Display the minibuffer history search prompt.
1693 If there are no search errors, this function displays an overlay with
1694 the isearch prompt which replaces the original minibuffer prompt.
1695 Otherwise, it displays the standard isearch message returned from
1696 `isearch-message'."
1698 ;; Use standard function `isearch-message' when not in the minibuffer,
1699 ;; or search fails, or has an error (like incomplete regexp).
1700 ;; This function overwrites minibuffer text with isearch message,
1701 ;; so it's possible to see what is wrong in the search string.
1703 ;; Otherwise, put the overlay with the standard isearch prompt over
1704 ;; the initial minibuffer prompt.
1713 ;; And clear any previous isearch message.
1717 "Wrap the minibuffer history search when search fails.
1718 Move point to the first history element for a forward search,
1719 or to the last history element for a backward search."
1721 ;; When `minibuffer-history-isearch-search' fails on reaching the
1722 ;; beginning/end of the history, wrap the search to the first/last
1723 ;; minibuffer history element.
1731 "Save a function restoring the state of minibuffer history search.
1732 Save `minibuffer-history-position' to the additional state parameter
1733 in the search status stack."
1738 "Restore the minibuffer history search state.
1739 Go to the history element by the absolute history position HIST-POS."
1742 \f
1743 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1747 "Table mapping redo records to the corresponding undo one.
1748 A redo record for undo-in-region maps to t.
1758 "Within a run of consecutive undo commands, list remaining to be undone.
1762 "Undo some previous changes.
1763 Repeat this command to undo more changes.
1764 A numeric ARG serves as a repeat count.
1766 In Transient Mark mode when the mark is active, only undo changes within
1768 as an argument limits undo to changes within the current region."
1770 ;; Make last-command indicate for the next command that this was an undo.
1771 ;; That way, another undo will undo more.
1772 ;; If we get to the end of the undo history and get an error,
1773 ;; another undo command will find the undo history empty
1774 ;; and will get another error. To begin undoing the undos,
1775 ;; you must type some other command.
1778 message)
1779 ;; If we get an error in undo-start,
1780 ;; the next command should not be a "consecutive undo".
1781 ;; So set `this-command' to something other than `undo'.
1786 ;; If something (a timer or filter?) changed the buffer
1787 ;; since the previous command, don't continue the undo seq.
1791 ;; If the last undo record made was made by undo
1792 ;; it shows nothing else happened in between.
1799 ;; get rid of initial undo boundary
1801 ;; If we got this far, the next command should be a consecutive undo.
1803 ;; Check to see whether we're hitting a redo record, and if
1804 ;; so, ask the user whether she wants to skip the redo/undo pair.
1811 ;; The equiv entry might point to another redo record if we have done
1812 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1820 ;; Record the fact that the just-generated undo records come from an
1821 ;; undo operation--that is, they are redo records.
1822 ;; In the ordinary case (not within a region), map the redo
1823 ;; record to the following undos.
1824 ;; I don't know how to do that in the undo-in-region case.
1826 ;; Strip any leading undo boundaries there might be, like we do
1827 ;; above when checking.
1831 undo-equiv-table))
1832 ;; Don't specify a position in the undo record for the undo command.
1833 ;; Instead, undoing this should move point to where the change is.
1852 ;; Record what the current undo list says,
1853 ;; so the next command can tell if the buffer was modified in between.
1856 ;; Display a message announcing success.
1861 "Make BUFFER stop keeping undo information.
1862 No argument or nil as argument means do this for the current buffer."
1868 "Undo some previous changes.
1869 Repeat this command to undo more changes.
1870 A numeric ARG serves as a repeat count.
1871 Contrary to `undo', this will not redo a previous undo."
1876 "Non-nil while performing an undo.
1880 "Undo back N undo-boundaries beyond what was already undone recently.
1881 Call `undo-start' to get ready to undo recent changes,
1882 then call `undo-more' one or more times to undo them."
1887 ;; Note: The following, while pulling elements off
1888 ;; `pending-undo-list' will call primitive change functions which
1889 ;; will push more elements onto `buffer-undo-list'.
1894 ;; Deep copy of a list
1896 "Make a copy of undo list LIST."
1902 elt))
1905 "Set `pending-undo-list' to the front of the undo list.
1906 The next call to `undo-more' will undo the most recently made change.
1907 If BEG and END are specified, then only undo elements
1908 that apply to text between BEG and END are used; other undo elements
1909 are ignored. If BEG and END are nil, all undo elements are used."
1915 buffer-undo-list)))
1920 "Return a list of undo elements for the region START to END.
1921 The elements come from `buffer-undo-list', but we keep only
1922 the elements inside this region, and discard those outside this region.
1923 If we find an element that crosses an edge of this region,
1924 we stop and ignore all further elements."
1927 undo-adjusted-markers
1928 some-rejected
1929 undo-elt temp-undo-list delta)
1934 ;; This is a "was unmodified" element.
1935 ;; Keep it if we have kept everything thus far.
1942 ;; Don't put two nils together in the list
1956 ;; Loop down the earlier events adjusting their buffer
1957 ;; positions to reflect the fact that a change to the buffer
1958 ;; isn't being undone. We only need to process those element
1959 ;; types which undo-elt-in-region will return as being in
1960 ;; the region since only those types can ever get into the
1961 ;; output
1970 ;; (TEXT . POSITION)
1977 ;; (BEGIN . END)
1982 ;; (nil PROPERTY VALUE BEG . END)
1992 "Determine whether UNDO-ELT falls inside the region START ... END.
1993 If it crosses the edge, we return nil."
1998 t)
2000 nil)
2002 ;; (TEXT . POSITION)
2006 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2007 ;; See if MARKER is inside the region.
2018 ;; (nil PROPERTY VALUE BEG . END)
2023 ;; (BEGIN . END)
2028 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2029 This assumes we have already decided that UNDO-ELT
2030 is not *inside* the region START...END."
2033 ;; (nil PROPERTY VALUE BEG . END)
2038 ;; (BEGIN . END)
2042 ;; Return the first affected buffer position and the delta for an undo element
2043 ;; delta is defined as the change in subsequent buffer positions if we *did*
2044 ;; the undo.
2048 ;; (TEXT . POSITION)
2051 ;; (BEGIN . END)
2058 "If non-nil ask about discarding undo info for the current command.
2059 Normally, Emacs discards the undo info for the current command if
2060 it exceeds `undo-outer-limit'. But if you set this option
2061 non-nil, it asks in the echo area whether to discard the info.
2062 If you answer no, there is a slight risk that Emacs might crash, so
2063 only do it if you really want to undo the command.
2065 This option is mainly intended for debugging. You have to be
2066 careful if you use it for other purposes. Garbage collection is
2067 inhibited while the question is asked, meaning that Emacs might
2068 leak memory. So you should make sure that you do not wait
2069 excessively long before answering the question."
2075 "If non-nil, an extra level of size that's ok in an undo item.
2076 We don't ask the user about truncating the undo list until the
2077 current item gets bigger than this amount.
2082 ;; When the first undo batch in an undo list is longer than
2083 ;; undo-outer-limit, this function gets called to warn the user that
2084 ;; the undo info for the current command was discarded. Garbage
2085 ;; collection is inhibited around the call, so it had better not do a
2086 ;; lot of consing.
2092 ;; Don't ask the question again unless it gets even bigger.
2093 ;; This applies, in particular, if the user quits from the question.
2094 ;; Such a quit quits out of GC, but something else will call GC
2095 ;; again momentarily. It will call this function again,
2096 ;; but we don't want to ask the question again.
2103 t)
2104 nil))
2109 "The undo info was discarded because it exceeded \
2110 `undo-outer-limit'.
2112 This is normal if you executed a command that made a huge change
2113 to the buffer. In that case, to prevent similar problems in the
2114 future, set `undo-outer-limit' to a value that is large enough to
2115 cover the maximum size of normal changes you expect a single
2116 command to make, but not so large that it might exceed the
2117 maximum memory allotted to Emacs.
2119 If you did not execute any such command, the situation is
2120 probably due to a bug and you should report it.
2122 You can disable the popping up of this buffer by adding the entry
2123 \(undo discard-info) to the user option `warning-suppress-types',
2127 t))
2128 \f
2130 "History list for some commands that read shell commands.
2132 Maximum length of the history list is determined by the value
2139 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2140 This buffer is used when `shell-command' or `shell-command-on-region'
2141 is run interactively. A value of nil means that output to stderr and
2148 "Return a list of all commands associated with the current file.
2149 This function is used to add all related commands retrieved by `mailcap'
2150 to the end of the list of defaults just after the default value."
2154 minibuffer-default))
2159 commands))
2170 map)
2174 "Read a shell command from the minibuffer.
2175 The arguments are the same as the ones of `read-from-minibuffer',
2176 except READ and KEYMAP are missing and HIST defaults
2177 to `shell-command-history'."
2185 minibuffer-local-shell-command-map
2186 nil
2188 args)))
2191 "Execute string COMMAND asynchronously in background.
2193 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2194 surrounded by whitespace and executes the command asynchronously.
2195 The output appears in the buffer `*Async Shell Command*'.
2197 In Elisp, you will often be better served by calling `start-process'
2198 directly, since it offers more control and does not impose the use of a
2199 shell (with its need to quote arguments)."
2205 current-prefix-arg
2206 shell-command-default-error-buffer))
2212 "Execute string COMMAND in inferior shell; display output, if any.
2213 With prefix argument, insert the COMMAND's output at point.
2215 If COMMAND ends in ampersand, execute it asynchronously.
2216 The output appears in the buffer `*Async Shell Command*'.
2217 That buffer is in shell mode.
2219 Otherwise, COMMAND is executed synchronously. The output appears in
2220 the buffer `*Shell Command Output*'. If the output is short enough to
2221 display in the echo area (which is determined by the variables
2222 `resize-mini-windows' and `max-mini-window-height'), it is shown
2223 there, but it is nonetheless available in buffer `*Shell Command
2224 Output*' even though that buffer is not automatically displayed.
2226 To specify a coding system for converting non-ASCII characters
2228 before this command.
2230 Noninteractive callers can specify coding systems by binding
2231 `coding-system-for-read' and `coding-system-for-write'.
2233 The optional second argument OUTPUT-BUFFER, if non-nil,
2234 says to put the output in some other buffer.
2235 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2236 If OUTPUT-BUFFER is not a buffer and not nil,
2237 insert output in current buffer. (This cannot be done asynchronously.)
2238 In either case, the buffer is first erased, and the output is
2239 inserted after point (leaving mark after it).
2241 If the command terminates without error, but generates output,
2243 the output can be displayed in the echo area or in its buffer.
2244 If the output is short enough to display in the echo area
2245 \(determined by the variable `max-mini-window-height' if
2246 `resize-mini-windows' is non-nil), it is shown there.
2247 Otherwise,the buffer containing the output is displayed.
2251 of the output.
2253 If there is no output, or if output is inserted in the current buffer,
2254 then `*Shell Command Output*' is deleted.
2256 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2257 or buffer name to which to direct the command's standard error output.
2258 If it is nil, error output is mingled with regular output.
2259 In an interactive call, the variable `shell-command-default-error-buffer'
2260 specifies the value of ERROR-BUFFER.
2262 In Elisp, you will often be better served by calling `call-process' or
2263 `start-process' directly, since it offers more control and does not impose
2264 the use of a shell (with its need to quote arguments)."
2275 current-prefix-arg
2276 shell-command-default-error-buffer))
2277 ;; Look for a handler in case default-directory is a remote file name.
2285 ;; Output goes in current buffer.
2291 temporary-file-directory)))
2292 nil)))
2295 ;; We do not use -f for csh; we will not support broken use of
2296 ;; .cshrcs. Even the BSD csh manual says to use
2297 ;; "if ($?prompt) exit" before things which are not useful
2298 ;; non-interactively. Besides, if someone wants their other
2299 ;; aliases for shell commands then they can still have them.
2303 t)
2304 nil shell-command-switch command)
2311 ;; Do no formatting while reading error file,
2312 ;; because that can run a shell command, and we
2313 ;; don't want that to cause an infinite recursion.
2315 ;; Put point after the inserted errors.
2319 ;; This is like exchange-point-and-mark, but doesn't
2320 ;; activate the mark. It is cleaner to avoid activation,
2321 ;; even though the command loop would deactivate the mark
2322 ;; because we inserted text.
2326 ;; Output goes in a separate buffer.
2327 ;; Preserve the match data in case called from a program.
2330 ;; Command ending with ampersand means asynchronous.
2334 proc)
2335 ;; Remove the ampersand.
2337 ;; If will kill a process, query first.
2345 ;; Setting buffer-read-only to nil doesn't suffice
2346 ;; if some text has a non-nil read-only property,
2347 ;; which comint sometimes adds for prompts.
2353 shell-command-switch command))
2357 ;; Use the comint filter for proper handling of carriage motion
2358 ;; (see `comint-inhibit-carriage-motion'),.
2360 ))
2361 ;; Otherwise, command is executed synchronously.
2363 output-buffer nil error-buffer)))))))
2367 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2368 MESSAGE may be either a string or a buffer.
2370 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2371 the maximum height of the echo area, as defined by `max-mini-window-height'
2372 if `resize-mini-windows' is non-nil.
2374 Returns either the string shown in the echo area, or when a pop-up
2375 buffer is used, the window used to display it.
2377 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2378 name of the buffer used to display it in the case where a pop-up buffer
2379 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2380 string and it is displayed in the echo area, it is not specified whether
2381 the contents are inserted into the buffer anyway.
2383 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2384 and only used if a buffer is displayed."
2386 ;; Trivial case where we can use the echo area
2390 ;; Trivial case where we can just remove single trailing newline
2393 ;; General case
2396 message
2405 0
2409 (<= lines
2413 max-mini-window-height))
2415 max-mini-window-height)
2419 ;; Don't use the echo area if the output buffer is
2420 ;; already displayed in the selected frame.
2422 ;; Echo area
2428 ;; Buffer
2431 not-this-window frame))))))))
2434 ;; We have a sentinel to prevent insertion of a termination message
2435 ;; in the buffer itself.
2443 &optional output-buffer replace
2444 error-buffer display-error-buffer)
2445 "Execute string COMMAND in inferior shell with region as input.
2446 Normally display output (if any) in temp buffer `*Shell Command Output*';
2447 Prefix arg means replace the region with it. Return the exit code of
2448 COMMAND.
2450 To specify a coding system for converting non-ASCII characters
2452 before this command. By default, the input (from the current buffer)
2453 is encoded in the same coding system that will be used to save the file,
2454 `buffer-file-coding-system'. If the output is going to replace the region,
2455 then it is decoded from that same coding system.
2457 The noninteractive arguments are START, END, COMMAND,
2458 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2459 Noninteractive callers can specify coding systems by binding
2460 `coding-system-for-read' and `coding-system-for-write'.
2462 If the command generates output, the output may be displayed
2463 in the echo area or in a buffer.
2464 If the output is short enough to display in the echo area
2465 \(determined by the variable `max-mini-window-height' if
2466 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2467 it is displayed in the buffer `*Shell Command Output*'. The output
2468 is available in that buffer in both cases.
2470 If there is output and an error, a message about the error
2471 appears at the end of the output.
2473 If there is no output, or if output is inserted in the current buffer,
2474 then `*Shell Command Output*' is deleted.
2476 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2477 that says to put the output in some other buffer.
2478 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2479 If OUTPUT-BUFFER is not a buffer and not nil,
2480 insert output in the current buffer.
2481 In either case, the output is inserted after point (leaving mark after it).
2483 If REPLACE, the optional fifth argument, is non-nil, that means insert
2484 the output in place of text from START to END, putting point and mark
2485 around it.
2487 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2488 or buffer name to which to direct the command's standard error output.
2489 If it is nil, error output is mingled with regular output.
2490 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2491 were any errors. (This is always t, interactively.)
2492 In an interactive call, the variable `shell-command-default-error-buffer'
2493 specifies the value of ERROR-BUFFER."
2497 ;; Do this before calling region-beginning
2498 ;; and region-end, in case subprocess output
2499 ;; relocates them while we are in the minibuffer.
2501 ;; call-interactively recognizes region-beginning and
2502 ;; region-end specially, leaving them in the history.
2504 string
2505 current-prefix-arg
2506 current-prefix-arg
2507 shell-command-default-error-buffer
2508 t)))
2514 temporary-file-directory)))
2515 nil))
2516 exit-status)
2520 ;; Replace specified region with output from command.
2522 ;; Don't muck with mark unless REPLACE says we should.
2529 t)
2530 nil shell-command-switch command))
2531 ;; It is rude to delete a buffer which the command is not using.
2532 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2533 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2534 ;; (kill-buffer shell-buffer)))
2535 ;; Don't muck with mark unless REPLACE says we should.
2537 ;; No prefix argument: put the output in a temp buffer,
2538 ;; replacing its entire contents.
2543 ;; If the input is the same buffer as the output,
2544 ;; delete everything but the specified region,
2545 ;; then replace that region with the output.
2551 shell-file-name t
2554 t)
2555 nil shell-command-switch
2556 command)))
2557 ;; Clear the output buffer, then run the command with
2558 ;; output there.
2569 buffer)
2570 nil shell-command-switch command)))
2571 ;; Report the output.
2581 ;; There's some output, display it
2583 ;; No output; error?
2590 shell-command-default-error-buffer)
2597 output))
2600 exit-status))
2603 exit-status output))))
2604 ;; Don't kill: there might be useful info in the undo-log.
2605 ;; (kill-buffer buffer)
2606 ))))
2614 ;; Do no formatting while reading error file,
2615 ;; because that can run a shell command, and we
2616 ;; don't want that to cause an infinite recursion.
2618 ;; Put point after the inserted errors.
2623 exit-status))
2626 "Execute shell command COMMAND and return its output as a string."
2629 standard-output
2633 "Process files synchronously in a separate process.
2634 Similar to `call-process', but may invoke a file handler based on
2635 `default-directory'. The current working directory of the
2636 subprocess is `default-directory'.
2638 File names in INFILE and BUFFER are handled normally, but file
2639 names in ARGS should be relative to `default-directory', as they
2640 are passed to the process verbatim. \(This is a difference to
2641 `call-process' which does not support file handlers for INFILE
2642 and BUFFER.\)
2644 Some file handlers might not support all variants, for example
2645 they might behave as if DISPLAY was nil, regardless of the actual
2646 value passed."
2648 lc stderr-file)
2658 display args)
2664 "Whether a call of `process-file' changes remote files.
2666 Per default, this variable is always set to `t', meaning that a
2667 call of `process-file' could potentially change any file on a
2668 remote host. When set to `nil', a file handler could optimize
2669 its behavior with respect to remote file attributes caching.
2671 This variable should never be changed by `setq'. Instead of, it
2675 "Start a program in a subprocess. Return the process object for it.
2677 Similar to `start-process', but may invoke a file handler based on
2678 `default-directory'. See Info node `(elisp)Magic File Names'.
2680 This handler ought to run PROGRAM, perhaps on the local host,
2681 perhaps on a remote host that corresponds to `default-directory'.
2682 In the latter case, the local part of `default-directory' becomes
2683 the working directory of the process.
2685 PROGRAM and PROGRAM-ARGS might be file names. They are not
2686 objects of file handler invocation. File handlers might not
2687 support pty association, if PROGRAM is nil."
2691 \f
2692 ;;;; Process menu
2704 "Major mode for listing the processes called by Emacs."
2716 "Recompute the list of processes for the Process List buffer."
2727 face link
2730 follow-link t
2731 process-buffer ,buf
2732 action process-menu-visit-buffer)
2741 "datagram"
2756 tabulated-list-entries)))))
2762 "Display a list of all processes.
2763 If optional argument QUERY-ONLY is non-nil, only processes with
2764 the query-on-exit flag set are listed.
2765 Any process listed as exited or signaled is actually eliminated
2766 after the listing is made.
2767 Optional argument BUFFER specifies a buffer to use, instead of
2769 The return value is always nil."
2781 nil)
2782 \f
2786 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2787 (define-key map [switch-frame] nil)
2788 (define-key map [?\C-u] 'universal-argument-more)
2789 (define-key map [?-] 'universal-argument-minus)
2790 (define-key map [?0] 'digit-argument)
2791 (define-key map [?1] 'digit-argument)
2792 (define-key map [?2] 'digit-argument)
2793 (define-key map [?3] 'digit-argument)
2794 (define-key map [?4] 'digit-argument)
2795 (define-key map [?5] 'digit-argument)
2796 (define-key map [?6] 'digit-argument)
2797 (define-key map [?7] 'digit-argument)
2798 (define-key map [?8] 'digit-argument)
2799 (define-key map [?9] 'digit-argument)
2800 (define-key map [kp-0] 'digit-argument)
2801 (define-key map [kp-1] 'digit-argument)
2802 (define-key map [kp-2] 'digit-argument)
2803 (define-key map [kp-3] 'digit-argument)
2804 (define-key map [kp-4] 'digit-argument)
2805 (define-key map [kp-5] 'digit-argument)
2806 (define-key map [kp-6] 'digit-argument)
2807 (define-key map [kp-7] 'digit-argument)
2808 (define-key map [kp-8] 'digit-argument)
2809 (define-key map [kp-9] 'digit-argument)
2810 (define-key map [kp-subtract] 'universal-argument-minus)
2811 map)
2814 (defvar universal-argument-num-events nil
2815 "Number of argument-specifying events read by `universal-argument'.
2816 `universal-argument-other-key' uses this to discard those events
2817 from (this-command-keys), and reread only the final command.")
2819 (defvar saved-overriding-map t
2820 "The saved value of `overriding-terminal-local-map'.
2824 (defun save&set-overriding-map (map)
2825 "Set `overriding-terminal-local-map' to MAP."
2826 (when (eq saved-overriding-map t)
2827 (setq saved-overriding-map overriding-terminal-local-map)
2828 (setq overriding-terminal-local-map map)))
2830 (defun restore-overriding-map ()
2831 "Restore `overriding-terminal-local-map' to its saved value."
2832 (setq overriding-terminal-local-map saved-overriding-map)
2833 (setq saved-overriding-map t))
2835 (defun universal-argument ()
2836 "Begin a numeric argument for the following command.
2841 multiplies the argument by 4 each time.
2843 which is different in effect from any particular numeric argument.
2845 (interactive)
2846 (setq prefix-arg (list 4))
2847 (setq universal-argument-num-events (length (this-command-keys)))
2848 (save&set-overriding-map universal-argument-map))
2850 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2851 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2852 (defun universal-argument-more (arg)
2853 (interactive "P")
2854 (if (consp arg)
2855 (setq prefix-arg (list (* 4 (car arg))))
2856 (if (eq arg '-)
2857 (setq prefix-arg (list -4))
2858 (setq prefix-arg arg)
2859 (restore-overriding-map)))
2860 (setq universal-argument-num-events (length (this-command-keys))))
2862 (defun negative-argument (arg)
2863 "Begin a negative numeric argument for the next command.
2865 (interactive "P")
2866 (cond ((integerp arg)
2867 (setq prefix-arg (- arg)))
2868 ((eq arg '-)
2869 (setq prefix-arg nil))
2870 (t
2871 (setq prefix-arg '-)))
2872 (setq universal-argument-num-events (length (this-command-keys)))
2873 (save&set-overriding-map universal-argument-map))
2875 (defun digit-argument (arg)
2876 "Part of the numeric argument for the next command.
2878 (interactive "P")
2879 (let* ((char (if (integerp last-command-event)
2880 last-command-event
2881 (get last-command-event 'ascii-character)))
2883 (cond ((integerp arg)
2884 (setq prefix-arg (+ (* arg 10)
2885 (if (< arg 0) (- digit) digit))))
2886 ((eq arg '-)
2887 ;; Treat -0 as just -, so that -01 will work.
2888 (setq prefix-arg (if (zerop digit) '- (- digit))))
2889 (t
2890 (setq prefix-arg digit))))
2891 (setq universal-argument-num-events (length (this-command-keys)))
2892 (save&set-overriding-map universal-argument-map))
2894 ;; For backward compatibility, minus with no modifiers is an ordinary
2895 ;; command if digits have already been entered.
2896 (defun universal-argument-minus (arg)
2897 (interactive "P")
2898 (if (integerp arg)
2899 (universal-argument-other-key arg)
2900 (negative-argument arg)))
2902 ;; Anything else terminates the argument and is left in the queue to be
2903 ;; executed as a command.
2904 (defun universal-argument-other-key (arg)
2905 (interactive "P")
2906 (setq prefix-arg arg)
2907 (let* ((key (this-command-keys))
2908 (keylist (listify-key-sequence key)))
2909 (setq unread-command-events
2910 (append (nthcdr universal-argument-num-events keylist)
2911 unread-command-events)))
2912 (reset-this-command-lengths)
2913 (restore-overriding-map))
2914 \f
2916 (defvar filter-buffer-substring-functions nil
2917 "Wrapper hook around `filter-buffer-substring'.
2918 The functions on this special hook are called with four arguments:
2919 NEXT-FUN BEG END DELETE
2920 NEXT-FUN is a function of three arguments (BEG END DELETE)
2921 that performs the default operation. The other three arguments
2922 are like the ones passed to `filter-buffer-substring'.")
2924 (defvar buffer-substring-filters nil
2925 "List of filter functions for `filter-buffer-substring'.
2926 Each function must accept a single argument, a string, and return
2927 a string. The buffer substring is passed to the first function
2928 in the list, and the return value of each function is passed to
2929 the next. The return value of the last function is used as the
2930 return value of `filter-buffer-substring'.
2932 If this variable is nil, no filtering is performed.")
2933 (make-obsolete-variable 'buffer-substring-filters
2934 'filter-buffer-substring-functions "24.1")
2936 (defun filter-buffer-substring (beg end &optional delete)
2937 "Return the buffer substring between BEG and END, after filtering.
2938 The filtering is performed by `filter-buffer-substring-functions'.
2940 If DELETE is non-nil, the text between BEG and END is deleted
2941 from the buffer.
2943 This function should be used instead of `buffer-substring',
2944 `buffer-substring-no-properties', or `delete-and-extract-region'
2945 when you want to allow filtering to take place. For example,
2946 major or minor modes can use `filter-buffer-substring-functions' to
2947 extract characters that are special to a buffer, and should not
2948 be copied into other buffers."
2949 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2950 (cond
2951 ((or delete buffer-substring-filters)
2952 (save-excursion
2953 (goto-char beg)
2954 (let ((string (if delete (delete-and-extract-region beg end)
2955 (buffer-substring beg end))))
2956 (dolist (filter buffer-substring-filters)
2957 (setq string (funcall filter string)))
2958 string)))
2959 (t
2960 (buffer-substring beg end)))))
2963 ;;;; Window system cut and paste hooks.
2965 (defvar interprogram-cut-function nil
2966 "Function to call to make a killed region available to other programs.
2968 Most window systems provide some sort of facility for cutting and
2969 pasting text between the windows of different programs.
2970 This variable holds a function that Emacs calls whenever text
2971 is put in the kill ring, to make the new kill available to other
2972 programs.
2974 The function takes one argument, TEXT, which is a string containing
2975 the text which should be made available.")
2977 (defvar interprogram-paste-function nil
2978 "Function to call to get text cut from other programs.
2980 Most window systems provide some sort of facility for cutting and
2981 pasting text between the windows of different programs.
2982 This variable holds a function that Emacs calls to obtain
2983 text that other programs have provided for pasting.
2985 The function should be called with no arguments. If the function
2986 returns nil, then no other program has provided such text, and the top
2987 of the Emacs kill ring should be used. If the function returns a
2988 string, then the caller of the function \(usually `current-kill')
2989 should put this string in the kill ring as the latest kill.
2991 This function may also return a list of strings if the window
2992 system supports multiple selections. The first string will be
2993 used as the pasted text, but the other will be placed in the
2994 kill ring for easy access via `yank-pop'.
2996 Note that the function should return a string only if a program other
2997 than Emacs has provided a string for pasting; if Emacs provided the
2998 most recent string, the function should return nil. If it is
2999 difficult to tell whether Emacs or some other program provided the
3000 current string, it is probably good enough to return nil if the string
3001 is equal (according to `string=') to the last text Emacs provided.")
3002 \f
3005 ;;;; The kill ring data structure.
3007 (defvar kill-ring nil
3008 "List of killed text sequences.
3009 Since the kill ring is supposed to interact nicely with cut-and-paste
3010 facilities offered by window systems, use of this variable should
3011 interact nicely with `interprogram-cut-function' and
3012 `interprogram-paste-function'. The functions `kill-new',
3013 `kill-append', and `current-kill' are supposed to implement this
3014 interaction; you may want to use them instead of manipulating the kill
3015 ring directly.")
3017 (defcustom kill-ring-max 60
3018 "Maximum length of kill ring before oldest elements are thrown away."
3019 :type 'integer
3020 :group 'killing)
3022 (defvar kill-ring-yank-pointer nil
3023 "The tail of the kill ring whose car is the last thing yanked.")
3025 (defcustom save-interprogram-paste-before-kill nil
3026 "Save clipboard strings into kill ring before replacing them.
3027 When one selects something in another program to paste it into Emacs,
3028 but kills something in Emacs before actually pasting it,
3029 this selection is gone unless this variable is non-nil,
3030 in which case the other program's selection is saved in the `kill-ring'
3032 :type 'boolean
3033 :group 'killing
3034 :version "23.2")
3036 (defcustom kill-do-not-save-duplicates nil
3037 "Do not add a new string to `kill-ring' when it is the same as the last one."
3038 :type 'boolean
3039 :group 'killing
3040 :version "23.2")
3042 (defun kill-new (string &optional replace yank-handler)
3043 "Make STRING the latest kill in the kill ring.
3044 Set `kill-ring-yank-pointer' to point to it.
3045 If `interprogram-cut-function' is non-nil, apply it to STRING.
3046 Optional second argument REPLACE non-nil means that STRING will replace
3047 the front of the kill ring, rather than being added to the list.
3049 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3050 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3051 STRING.
3053 When the yank handler has a non-nil PARAM element, the original STRING
3054 argument is not used by `insert-for-yank'. However, since Lisp code
3055 may access and use elements from the kill ring directly, the STRING
3057 (if (> (length string) 0)
3058 (if yank-handler
3059 (put-text-property 0 (length string)
3060 'yank-handler yank-handler string))
3061 (if yank-handler
3062 (signal 'args-out-of-range
3063 (list string "yank-handler specified for empty string"))))
3064 (unless (and kill-do-not-save-duplicates
3065 (equal string (car kill-ring)))
3066 (if (fboundp 'menu-bar-update-yank-menu)
3067 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3068 (when save-interprogram-paste-before-kill
3069 (let ((interprogram-paste (and interprogram-paste-function
3070 (funcall interprogram-paste-function))))
3071 (when interprogram-paste
3072 (dolist (s (if (listp interprogram-paste)
3073 (nreverse interprogram-paste)
3074 (list interprogram-paste)))
3075 (unless (and kill-do-not-save-duplicates
3076 (equal s (car kill-ring)))
3077 (push s kill-ring))))))
3078 (unless (and kill-do-not-save-duplicates
3079 (equal string (car kill-ring)))
3080 (if (and replace kill-ring)
3081 (setcar kill-ring string)
3082 (push string kill-ring)
3083 (if (> (length kill-ring) kill-ring-max)
3084 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3085 (setq kill-ring-yank-pointer kill-ring)
3086 (if interprogram-cut-function
3087 (funcall interprogram-cut-function string)))
3088 (set-advertised-calling-convention
3089 'kill-new '(string &optional replace) "23.3")
3091 (defun kill-append (string before-p &optional yank-handler)
3092 "Append STRING to the end of the latest kill in the kill ring.
3093 If BEFORE-P is non-nil, prepend STRING to the kill.
3094 If `interprogram-cut-function' is set, pass the resulting kill to it."
3095 (let* ((cur (car kill-ring)))
3096 (kill-new (if before-p (concat string cur) (concat cur string))
3097 (or (= (length cur) 0)
3098 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3099 yank-handler)))
3100 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3102 (defcustom yank-pop-change-selection nil
3103 "If non-nil, rotating the kill ring changes the window system selection."
3104 :type 'boolean
3105 :group 'killing
3106 :version "23.1")
3108 (defun current-kill (n &optional do-not-move)
3109 "Rotate the yanking point by N places, and then return that kill.
3110 If N is zero and `interprogram-paste-function' is set to a
3111 function that returns a string or a list of strings, and if that
3112 function doesn't return nil, then that string (or list) is added
3113 to the front of the kill ring and the string (or first string in
3114 the list) is returned as the latest kill.
3116 If N is not zero, and if `yank-pop-change-selection' is
3117 non-nil, use `interprogram-cut-function' to transfer the
3118 kill at the new yank point into the window system selection.
3120 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3121 move the yanking point; just return the Nth kill forward."
3123 (let ((interprogram-paste (and (= n 0)
3124 interprogram-paste-function
3125 (funcall interprogram-paste-function))))
3126 (if interprogram-paste
3127 (progn
3128 ;; Disable the interprogram cut function when we add the new
3129 ;; text to the kill ring, so Emacs doesn't try to own the
3130 ;; selection, with identical text.
3131 (let ((interprogram-cut-function nil))
3132 (if (listp interprogram-paste)
3133 (mapc 'kill-new (nreverse interprogram-paste))
3134 (kill-new interprogram-paste)))
3135 (car kill-ring))
3136 (or kill-ring (error "Kill ring is empty"))
3137 (let ((ARGth-kill-element
3138 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3139 (length kill-ring))
3140 kill-ring)))
3141 (unless do-not-move
3142 (setq kill-ring-yank-pointer ARGth-kill-element)
3143 (when (and yank-pop-change-selection
3144 (> n 0)
3145 interprogram-cut-function)
3146 (funcall interprogram-cut-function (car ARGth-kill-element))))
3147 (car ARGth-kill-element)))))
3151 ;;;; Commands for manipulating the kill ring.
3153 (defcustom kill-read-only-ok nil
3154 "Non-nil means don't signal an error for killing read-only text."
3155 :type 'boolean
3156 :group 'killing)
3158 (put 'text-read-only 'error-conditions
3159 '(text-read-only buffer-read-only error))
3160 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3162 (defun kill-region (beg end &optional yank-handler)
3164 This deletes the text from the buffer and saves it in the kill ring.
3168 If you want to append the killed region to the last killed text,
3171 If the buffer is read-only, Emacs will beep and refrain from deleting
3172 the text, but put the text in the kill ring anyway. This means that
3173 you can use the killing commands to copy text from a read-only buffer.
3175 Lisp programs should use this function for killing text.
3176 (To delete text, use `delete-region'.)
3177 Supply two arguments, character positions indicating the stretch of text
3178 to be killed.
3180 If the previous command was also a kill command,
3181 the text killed this time appends to the text killed last time
3182 to make one entry in the kill ring."
3183 ;; Pass point first, then mark, because the order matters
3184 ;; when calling kill-append.
3185 (interactive (list (point) (mark)))
3186 (unless (and beg end)
3187 (error "The mark is not set now, so there is no region"))
3188 (condition-case nil
3189 (let ((string (filter-buffer-substring beg end t)))
3190 (when string ;STRING is nil if BEG = END
3191 ;; Add that string to the kill ring, one way or another.
3192 (if (eq last-command 'kill-region)
3193 (kill-append string (< end beg) yank-handler)
3194 (kill-new string nil yank-handler)))
3195 (when (or string (eq last-command 'kill-region))
3196 (setq this-command 'kill-region))
3197 nil)
3198 ((buffer-read-only text-read-only)
3199 ;; The code above failed because the buffer, or some of the characters
3200 ;; in the region, are read-only.
3201 ;; We should beep, in case the user just isn't aware of this.
3202 ;; However, there's no harm in putting
3203 ;; the region's text in the kill ring, anyway.
3204 (copy-region-as-kill beg end)
3205 ;; Set this-command now, so it will be set even if we get an error.
3206 (setq this-command 'kill-region)
3207 ;; This should barf, if appropriate, and give us the correct error.
3208 (if kill-read-only-ok
3209 (progn (message "Read only text copied to kill ring") nil)
3210 ;; Signal an error if the buffer is read-only.
3211 (barf-if-buffer-read-only)
3212 ;; If the buffer isn't read-only, the text is.
3213 (signal 'text-read-only (list (current-buffer)))))))
3214 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3216 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3217 ;; to get two copies of the text when the user accidentally types M-w and
3218 ;; then corrects it with the intended C-w.
3219 (defun copy-region-as-kill (beg end)
3220 "Save the region as if killed, but don't kill it.
3221 In Transient Mark mode, deactivate the mark.
3222 If `interprogram-cut-function' is non-nil, also save the text for a window
3223 system cut and paste.
3225 This command's old key binding has been given to `kill-ring-save'."
3226 (interactive "r")
3227 (if (eq last-command 'kill-region)
3228 (kill-append (filter-buffer-substring beg end) (< end beg))
3229 (kill-new (filter-buffer-substring beg end)))
3230 (setq deactivate-mark t)
3231 nil)
3233 (defun kill-ring-save (beg end)
3234 "Save the region as if killed, but don't kill it.
3235 In Transient Mark mode, deactivate the mark.
3236 If `interprogram-cut-function' is non-nil, also save the text for a window
3237 system cut and paste.
3239 If you want to append the killed line to the last killed text,
3242 This command is similar to `copy-region-as-kill', except that it gives
3243 visual feedback indicating the extent of the region being copied."
3244 (interactive "r")
3245 (copy-region-as-kill beg end)
3246 ;; This use of called-interactively-p is correct
3247 ;; because the code it controls just gives the user visual feedback.
3248 (if (called-interactively-p 'interactive)
3249 (let ((other-end (if (= (point) beg) end beg))
3250 (opoint (point))
3251 ;; Inhibit quitting so we can make a quit here
3252 ;; look like a C-g typed as a command.
3253 (inhibit-quit t))
3254 (if (pos-visible-in-window-p other-end (selected-window))
3255 ;; Swap point-and-mark quickly so as to show the region that
3256 ;; was selected. Don't do it if the region is highlighted.
3257 (unless (and (region-active-p)
3258 (face-background 'region))
3259 ;; Swap point and mark.
3260 (set-marker (mark-marker) (point) (current-buffer))
3261 (goto-char other-end)
3262 (sit-for blink-matching-delay)
3263 ;; Swap back.
3264 (set-marker (mark-marker) other-end (current-buffer))
3265 (goto-char opoint)
3266 ;; If user quit, deactivate the mark
3267 ;; as C-g would as a command.
3268 (and quit-flag mark-active
3269 (deactivate-mark)))
3270 (let* ((killed-text (current-kill 0))
3271 (message-len (min (length killed-text) 40)))
3272 (if (= (point) beg)
3273 ;; Don't say "killed"; that is misleading.
3275 (substring killed-text (- message-len)))
3277 (substring killed-text 0 message-len))))))))
3279 (defun append-next-kill (&optional interactive)
3280 "Cause following command, if it kills, to append to previous kill.
3281 The argument is used for internal purposes; do not supply one."
3282 (interactive "p")
3283 ;; We don't use (interactive-p), since that breaks kbd macros.
3284 (if interactive
3285 (progn
3286 (setq this-command 'kill-region)
3287 (message "If the next command is a kill, it will append"))
3288 (setq last-command 'kill-region)))
3289 \f
3290 ;; Yanking.
3292 ;; This is actually used in subr.el but defcustom does not work there.
3293 (defcustom yank-excluded-properties
3294 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3295 yank-handler follow-link fontified)
3296 "Text properties to discard when yanking.
3297 The value should be a list of text properties to discard or t,
3298 which means to discard all text properties."
3299 :type '(choice (const :tag "All" t) (repeat symbol))
3300 :group 'killing
3301 :version "22.1")
3303 (defvar yank-window-start nil)
3304 (defvar yank-undo-function nil
3305 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3306 Function is called with two parameters, START and END corresponding to
3307 the value of the mark and point; it is guaranteed that START <= END.
3308 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3310 (defun yank-pop (&optional arg)
3311 "Replace just-yanked stretch of killed text with a different stretch.
3312 This command is allowed only immediately after a `yank' or a `yank-pop'.
3313 At such a time, the region contains a stretch of reinserted
3314 previously-killed text. `yank-pop' deletes that text and inserts in its
3315 place a different stretch of killed text.
3317 With no argument, the previous kill is inserted.
3318 With argument N, insert the Nth previous kill.
3319 If N is negative, this is a more recent kill.
3321 The sequence of kills wraps around, so that after the oldest one
3322 comes the newest one.
3324 When this command inserts killed text into the buffer, it honors
3325 `yank-excluded-properties' and `yank-handler' as described in the
3326 doc string for `insert-for-yank-1', which see."
3327 (interactive "*p")
3328 (if (not (eq last-command 'yank))
3329 (error "Previous command was not a yank"))
3330 (setq this-command 'yank)
3331 (unless arg (setq arg 1))
3332 (let ((inhibit-read-only t)
3333 (before (< (point) (mark t))))
3334 (if before
3335 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3336 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3337 (setq yank-undo-function nil)
3338 (set-marker (mark-marker) (point) (current-buffer))
3339 (insert-for-yank (current-kill arg))
3340 ;; Set the window start back where it was in the yank command,
3341 ;; if possible.
3342 (set-window-start (selected-window) yank-window-start t)
3343 (if before
3344 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3345 ;; It is cleaner to avoid activation, even though the command
3346 ;; loop would deactivate the mark because we inserted text.
3347 (goto-char (prog1 (mark t)
3348 (set-marker (mark-marker) (point) (current-buffer))))))
3349 nil)
3351 (defun yank (&optional arg)
3353 More precisely, reinsert the stretch of killed text most recently
3354 killed OR yanked. Put point at end, and set mark at beginning.
3355 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3356 With argument N, reinsert the Nth most recently killed stretch of killed
3357 text.
3359 When this command inserts killed text into the buffer, it honors
3360 `yank-excluded-properties' and `yank-handler' as described in the
3361 doc string for `insert-for-yank-1', which see.
3364 (interactive "*P")
3365 (setq yank-window-start (window-start))
3366 ;; If we don't get all the way thru, make last-command indicate that
3367 ;; for the following command.
3368 (setq this-command t)
3369 (push-mark (point))
3370 (insert-for-yank (current-kill (cond
3371 ((listp arg) 0)
3372 ((eq arg '-) -2)
3373 (t (1- arg)))))
3374 (if (consp arg)
3375 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3376 ;; It is cleaner to avoid activation, even though the command
3377 ;; loop would deactivate the mark because we inserted text.
3378 (goto-char (prog1 (mark t)
3379 (set-marker (mark-marker) (point) (current-buffer)))))
3380 ;; If we do get all the way thru, make this-command indicate that.
3381 (if (eq this-command t)
3382 (setq this-command 'yank))
3383 nil)
3385 (defun rotate-yank-pointer (arg)
3386 "Rotate the yanking point in the kill ring.
3387 With ARG, rotate that many kills forward (or backward, if negative)."
3388 (interactive "p")
3389 (current-kill arg))
3390 \f
3391 ;; Some kill commands.
3393 ;; Internal subroutine of delete-char
3394 (defun kill-forward-chars (arg)
3395 (if (listp arg) (setq arg (car arg)))
3396 (if (eq arg '-) (setq arg -1))
3397 (kill-region (point) (+ (point) arg)))
3399 ;; Internal subroutine of backward-delete-char
3400 (defun kill-backward-chars (arg)
3401 (if (listp arg) (setq arg (car arg)))
3402 (if (eq arg '-) (setq arg -1))
3403 (kill-region (point) (- (point) arg)))
3405 (defcustom backward-delete-char-untabify-method 'untabify
3406 "The method for untabifying when deleting backward.
3407 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3408 `hungry' -- delete all whitespace, both tabs and spaces;
3409 `all' -- delete all whitespace, including tabs, spaces and newlines;
3410 nil -- just delete one character."
3411 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3412 :version "20.3"
3413 :group 'killing)
3415 (defun backward-delete-char-untabify (arg &optional killp)
3416 "Delete characters backward, changing tabs into spaces.
3417 The exact behavior depends on `backward-delete-char-untabify-method'.
3418 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3419 Interactively, ARG is the prefix arg (default 1)
3420 and KILLP is t if a prefix arg was specified."
3422 (when (eq backward-delete-char-untabify-method 'untabify)
3423 (let ((count arg))
3424 (save-excursion
3425 (while (and (> count 0) (not (bobp)))
3427 (let ((col (current-column)))
3428 (forward-char -1)
3429 (setq col (- col (current-column)))
3430 (insert-char ?\s col)
3431 (delete-char 1)))
3432 (forward-char -1)
3433 (setq count (1- count))))))
3435 ((eq backward-delete-char-untabify-method 'all)
3437 (n (if skip
3438 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3439 (point)))))
3440 (+ arg (if (zerop wh) 0 (1- wh))))
3441 arg)))
3442 ;; Avoid warning about delete-backward-char
3443 (with-no-warnings (delete-backward-char n killp))))
3445 (defun zap-to-char (arg char)
3446 "Kill up to and including ARGth occurrence of CHAR.
3447 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3448 Goes backward if ARG is negative; error if CHAR not found."
3450 ;; Avoid "obsolete" warnings for translation-table-for-input.
3451 (with-no-warnings
3452 (if (char-table-p translation-table-for-input)
3453 (setq char (or (aref translation-table-for-input char) char))))
3454 (kill-region (point) (progn
3455 (search-forward (char-to-string char) nil nil arg)
3456 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3457 (point))))
3459 ;; kill-line and its subroutines.
3461 (defcustom kill-whole-line nil
3462 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3463 :type 'boolean
3464 :group 'killing)
3466 (defun kill-line (&optional arg)
3467 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3468 With prefix argument ARG, kill that many lines from point.
3469 Negative arguments kill lines backward.
3470 With zero argument, kills the text before point on the current line.
3473 a number counts as a prefix arg.
3475 To kill a whole line, when point is not at the beginning, type \
3478 If `show-trailing-whitespace' is non-nil, this command will just
3479 kill the rest of the current line, even if there are only
3480 nonblanks there.
3482 If `kill-whole-line' is non-nil, then this command kills the whole line
3483 including its terminating newline, when used at the beginning of a line
3484 with no argument. As a consequence, you can always kill a whole line
3487 If you want to append the killed line to the last killed text,
3490 If the buffer is read-only, Emacs will beep and refrain from deleting
3491 the line, but put the line in the kill ring anyway. This means that
3492 you can use this command to copy text from a read-only buffer.
3493 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3494 even beep.)"
3495 (interactive "P")
3496 (kill-region (point)
3497 ;; It is better to move point to the other end of the kill
3498 ;; before killing. That way, in a read-only buffer, point
3499 ;; moves across the text that is copied to the kill ring.
3500 ;; The choice has no effect on undo now that undo records
3501 ;; the value of point from before the command was run.
3502 (progn
3503 (if arg
3504 (forward-visible-line (prefix-numeric-value arg))
3505 (if (eobp)
3506 (signal 'end-of-buffer nil))
3507 (let ((end
3508 (save-excursion
3509 (end-of-visible-line) (point))))
3510 (if (or (save-excursion
3511 ;; If trailing whitespace is visible,
3512 ;; don't treat it as nothing.
3513 (unless show-trailing-whitespace
3515 (= (point) end))
3516 (and kill-whole-line (bolp)))
3517 (forward-visible-line 1)
3518 (goto-char end))))
3519 (point))))
3521 (defun kill-whole-line (&optional arg)
3522 "Kill current line.
3523 With prefix ARG, kill that many lines starting from the current line.
3524 If ARG is negative, kill backward. Also kill the preceding newline.
3526 If ARG is zero, kill current line but exclude the trailing newline."
3527 (interactive "p")
3528 (or arg (setq arg 1))
3529 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3530 (signal 'end-of-buffer nil))
3531 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3532 (signal 'beginning-of-buffer nil))
3533 (unless (eq last-command 'kill-region)
3534 (kill-new "")
3535 (setq last-command 'kill-region))
3536 (cond ((zerop arg)
3537 ;; We need to kill in two steps, because the previous command
3538 ;; could have been a kill command, in which case the text
3539 ;; before point needs to be prepended to the current kill
3540 ;; ring entry and the text after point appended. Also, we
3541 ;; need to use save-excursion to avoid copying the same text
3542 ;; twice to the kill ring in read-only buffers.
3543 (save-excursion
3544 (kill-region (point) (progn (forward-visible-line 0) (point))))
3545 (kill-region (point) (progn (end-of-visible-line) (point))))
3546 ((< arg 0)
3547 (save-excursion
3548 (kill-region (point) (progn (end-of-visible-line) (point))))
3549 (kill-region (point)
3550 (progn (forward-visible-line (1+ arg))
3551 (unless (bobp) (backward-char))
3552 (point))))
3553 (t
3554 (save-excursion
3555 (kill-region (point) (progn (forward-visible-line 0) (point))))
3556 (kill-region (point)
3557 (progn (forward-visible-line arg) (point))))))
3559 (defun forward-visible-line (arg)
3560 "Move forward by ARG lines, ignoring currently invisible newlines only.
3561 If ARG is negative, move backward -ARG lines.
3562 If ARG is zero, move to the beginning of the current line."
3563 (condition-case nil
3564 (if (> arg 0)
3565 (progn
3566 (while (> arg 0)
3567 (or (zerop (forward-line 1))
3568 (signal 'end-of-buffer nil))
3569 ;; If the newline we just skipped is invisible,
3570 ;; don't count it.
3571 (let ((prop
3572 (get-char-property (1- (point)) 'invisible)))
3573 (if (if (eq buffer-invisibility-spec t)
3574 prop
3575 (or (memq prop buffer-invisibility-spec)
3576 (assq prop buffer-invisibility-spec)))
3577 (setq arg (1+ arg))))
3578 (setq arg (1- arg)))
3579 ;; If invisible text follows, and it is a number of complete lines,
3580 ;; skip it.
3581 (let ((opoint (point)))
3582 (while (and (not (eobp))
3583 (let ((prop
3584 (get-char-property (point) 'invisible)))
3585 (if (eq buffer-invisibility-spec t)
3586 prop
3587 (or (memq prop buffer-invisibility-spec)
3588 (assq prop buffer-invisibility-spec)))))
3589 (goto-char
3590 (if (get-text-property (point) 'invisible)
3591 (or (next-single-property-change (point) 'invisible)
3592 (point-max))
3593 (next-overlay-change (point)))))
3594 (unless (bolp)
3595 (goto-char opoint))))
3596 (let ((first t))
3597 (while (or first (<= arg 0))
3598 (if first
3599 (beginning-of-line)
3600 (or (zerop (forward-line -1))
3601 (signal 'beginning-of-buffer nil)))
3602 ;; If the newline we just moved to is invisible,
3603 ;; don't count it.
3604 (unless (bobp)
3605 (let ((prop
3606 (get-char-property (1- (point)) 'invisible)))
3607 (unless (if (eq buffer-invisibility-spec t)
3608 prop
3609 (or (memq prop buffer-invisibility-spec)
3610 (assq prop buffer-invisibility-spec)))
3611 (setq arg (1+ arg)))))
3612 (setq first nil))
3613 ;; If invisible text follows, and it is a number of complete lines,
3614 ;; skip it.
3615 (let ((opoint (point)))
3616 (while (and (not (bobp))
3617 (let ((prop
3618 (get-char-property (1- (point)) 'invisible)))
3619 (if (eq buffer-invisibility-spec t)
3620 prop
3621 (or (memq prop buffer-invisibility-spec)
3622 (assq prop buffer-invisibility-spec)))))
3623 (goto-char
3624 (if (get-text-property (1- (point)) 'invisible)
3625 (or (previous-single-property-change (point) 'invisible)
3626 (point-min))
3627 (previous-overlay-change (point)))))
3628 (unless (bolp)
3629 (goto-char opoint)))))
3630 ((beginning-of-buffer end-of-buffer)
3631 nil)))
3633 (defun end-of-visible-line ()
3634 "Move to end of current visible line."
3635 (end-of-line)
3636 ;; If the following character is currently invisible,
3637 ;; skip all characters with that same `invisible' property value,
3638 ;; then find the next newline.
3639 (while (and (not (eobp))
3640 (save-excursion
3642 (let ((prop
3643 (get-char-property (point) 'invisible)))
3644 (if (eq buffer-invisibility-spec t)
3645 prop
3646 (or (memq prop buffer-invisibility-spec)
3647 (assq prop buffer-invisibility-spec))))))
3649 (if (get-text-property (point) 'invisible)
3650 (goto-char (next-single-property-change (point) 'invisible))
3651 (goto-char (next-overlay-change (point))))
3652 (end-of-line)))
3653 \f
3654 (defun insert-buffer (buffer)
3655 "Insert after point the contents of BUFFER.
3656 Puts mark after the inserted text.
3657 BUFFER may be a buffer or a buffer name.
3659 This function is meant for the user to run interactively.
3660 Don't call it from programs: use `insert-buffer-substring' instead!"
3661 (interactive
3662 (list
3663 (progn
3664 (barf-if-buffer-read-only)
3665 (read-buffer "Insert buffer: "
3666 (if (eq (selected-window) (next-window (selected-window)))
3667 (other-buffer (current-buffer))
3668 (window-buffer (next-window (selected-window))))
3669 t))))
3670 (push-mark
3671 (save-excursion
3672 (insert-buffer-substring (get-buffer buffer))
3673 (point)))
3674 nil)
3676 (defun append-to-buffer (buffer start end)
3677 "Append to specified buffer the text of the region.
3678 It is inserted into that buffer before its point.
3680 When calling from a program, give three arguments:
3681 BUFFER (or buffer name), START and END.
3682 START and END specify the portion of the current buffer to be copied."
3683 (interactive
3684 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3685 (region-beginning) (region-end)))
3686 (let* ((oldbuf (current-buffer))
3687 (append-to (get-buffer-create buffer))
3688 (windows (get-buffer-window-list append-to t t))
3689 point)
3690 (save-excursion
3691 (with-current-buffer append-to
3692 (setq point (point))
3693 (barf-if-buffer-read-only)
3694 (insert-buffer-substring oldbuf start end)
3695 (dolist (window windows)
3696 (when (= (window-point window) point)
3697 (set-window-point window (point))))))))
3699 (defun prepend-to-buffer (buffer start end)
3700 "Prepend to specified buffer the text of the region.
3701 It is inserted into that buffer after its point.
3703 When calling from a program, give three arguments:
3704 BUFFER (or buffer name), START and END.
3705 START and END specify the portion of the current buffer to be copied."
3707 (let ((oldbuf (current-buffer)))
3708 (with-current-buffer (get-buffer-create buffer)
3709 (barf-if-buffer-read-only)
3710 (save-excursion
3711 (insert-buffer-substring oldbuf start end)))))
3713 (defun copy-to-buffer (buffer start end)
3714 "Copy to specified buffer the text of the region.
3715 It is inserted into that buffer, replacing existing text there.
3717 When calling from a program, give three arguments:
3718 BUFFER (or buffer name), START and END.
3719 START and END specify the portion of the current buffer to be copied."
3721 (let ((oldbuf (current-buffer)))
3722 (with-current-buffer (get-buffer-create buffer)
3723 (barf-if-buffer-read-only)
3724 (erase-buffer)
3725 (save-excursion
3726 (insert-buffer-substring oldbuf start end)))))
3727 \f
3728 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3729 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3731 (defvar activate-mark-hook nil
3732 "Hook run when the mark becomes active.
3733 It is also run at the end of a command, if the mark is active and
3734 it is possible that the region may have changed.")
3736 (defvar deactivate-mark-hook nil
3737 "Hook run when the mark becomes inactive.")
3739 (defun mark (&optional force)
3740 "Return this buffer's mark value as integer, or nil if never set.
3742 In Transient Mark mode, this function signals an error if
3743 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3744 or the argument FORCE is non-nil, it disregards whether the mark
3745 is active, and returns an integer or nil in the usual way.
3747 If you are using this in an editing command, you are most likely making
3748 a mistake; see the documentation of `set-mark'."
3749 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3750 (marker-position (mark-marker))
3751 (signal 'mark-inactive nil)))
3753 (defsubst deactivate-mark (&optional force)
3754 "Deactivate the mark by setting `mark-active' to nil.
3755 Unless FORCE is non-nil, this function does nothing if Transient
3756 Mark mode is disabled.
3757 This function also runs `deactivate-mark-hook'."
3758 (when (or transient-mark-mode force)
3759 (when (and (if (eq select-active-regions 'only)
3760 (eq (car-safe transient-mark-mode) 'only)
3761 select-active-regions)
3762 (region-active-p)
3763 (display-selections-p))
3764 ;; The var `saved-region-selection', if non-nil, is the text in
3765 ;; the region prior to the last command modifying the buffer.
3766 ;; Set the selection to that, or to the current region.
3767 (cond (saved-region-selection
3768 (x-set-selection 'PRIMARY saved-region-selection)
3769 (setq saved-region-selection nil))
3770 ((/= (region-beginning) (region-end))
3771 (x-set-selection 'PRIMARY
3772 (buffer-substring-no-properties
3773 (region-beginning)
3774 (region-end))))))
3775 (if (and (null force)
3776 (or (eq transient-mark-mode 'lambda)
3777 (and (eq (car-safe transient-mark-mode) 'only)
3778 (null (cdr transient-mark-mode)))))
3779 ;; When deactivating a temporary region, don't change
3780 ;; `mark-active' or run `deactivate-mark-hook'.
3781 (setq transient-mark-mode nil)
3782 (if (eq (car-safe transient-mark-mode) 'only)
3783 (setq transient-mark-mode (cdr transient-mark-mode)))
3784 (setq mark-active nil)
3785 (run-hooks 'deactivate-mark-hook))))
3787 (defun activate-mark ()
3788 "Activate the mark."
3789 (when (mark t)
3790 (setq mark-active t)
3791 (unless transient-mark-mode
3792 (setq transient-mark-mode 'lambda))))
3794 (defun set-mark (pos)
3795 "Set this buffer's mark to POS. Don't use this function!
3796 That is to say, don't use this function unless you want
3797 the user to see that the mark has moved, and you want the previous
3798 mark position to be lost.
3800 Normally, when a new mark is set, the old one should go on the stack.
3801 This is why most applications should use `push-mark', not `set-mark'.
3803 Novice Emacs Lisp programmers often try to use the mark for the wrong
3804 purposes. The mark saves a location for the user's convenience.
3805 Most editing commands should not alter the mark.
3806 To remember a location for internal use in the Lisp program,
3807 store it in a Lisp variable. Example:
3809 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3811 (if pos
3812 (progn
3813 (setq mark-active t)
3814 (run-hooks 'activate-mark-hook)
3815 (set-marker (mark-marker) pos (current-buffer)))
3816 ;; Normally we never clear mark-active except in Transient Mark mode.
3817 ;; But when we actually clear out the mark value too, we must
3818 ;; clear mark-active in any mode.
3819 (deactivate-mark t)
3820 (set-marker (mark-marker) nil)))
3822 (defcustom use-empty-active-region nil
3824 If nil, region-aware commands treat empty regions as inactive.
3825 If non-nil, region-aware commands treat the region as active as
3826 long as the mark is active, even if the region is empty.
3828 Region-aware commands are those that act on the region if it is
3829 active and Transient Mark mode is enabled, and on the text near
3830 point otherwise."
3831 :type 'boolean
3832 :version "23.1"
3833 :group 'editing-basics)
3835 (defun use-region-p ()
3836 "Return t if the region is active and it is appropriate to act on it.
3837 This is used by commands that act specially on the region under
3838 Transient Mark mode.
3840 The return value is t if Transient Mark mode is enabled and the
3841 mark is active; furthermore, if `use-empty-active-region' is nil,
3842 the region must not be empty. Otherwise, the return value is nil.
3844 For some commands, it may be appropriate to ignore the value of
3845 `use-empty-active-region'; in that case, use `region-active-p'."
3846 (and (region-active-p)
3847 (or use-empty-active-region (> (region-end) (region-beginning)))))
3849 (defun region-active-p ()
3850 "Return t if Transient Mark mode is enabled and the mark is active.
3852 Some commands act specially on the region when Transient Mark
3853 mode is enabled. Usually, such commands should use
3854 `use-region-p' instead of this function, because `use-region-p'
3855 also checks the value of `use-empty-active-region'."
3856 (and transient-mark-mode mark-active))
3858 (defvar mark-ring nil
3859 "The list of former marks of the current buffer, most recent first.")
3860 (make-variable-buffer-local 'mark-ring)
3861 (put 'mark-ring 'permanent-local t)
3863 (defcustom mark-ring-max 16
3864 "Maximum size of mark ring. Start discarding off end if gets this big."
3865 :type 'integer
3866 :group 'editing-basics)
3868 (defvar global-mark-ring nil
3869 "The list of saved global marks, most recent first.")
3871 (defcustom global-mark-ring-max 16
3872 "Maximum size of global mark ring. \
3873 Start discarding off end if gets this big."
3874 :type 'integer
3875 :group 'editing-basics)
3877 (defun pop-to-mark-command ()
3878 "Jump to mark, and pop a new position for mark off the ring.
3879 \(Does not affect global mark ring\)."
3880 (interactive)
3881 (if (null (mark t))
3882 (error "No mark set in this buffer")
3883 (if (= (point) (mark t))
3884 (message "Mark popped"))
3885 (goto-char (mark t))
3886 (pop-mark)))
3888 (defun push-mark-command (arg &optional nomsg)
3889 "Set mark at where point is.
3890 If no prefix ARG and mark is already set there, just activate it.
3891 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3892 (interactive "P")
3893 (let ((mark (marker-position (mark-marker))))
3894 (if (or arg (null mark) (/= mark (point)))
3895 (push-mark nil nomsg t)
3896 (setq mark-active t)
3897 (run-hooks 'activate-mark-hook)
3898 (unless nomsg
3899 (message "Mark activated")))))
3901 (defcustom set-mark-command-repeat-pop nil
3904 will pop the mark twice, and
3906 will pop the mark three times.
3910 :type 'boolean
3911 :group 'editing-basics)
3913 (defcustom set-mark-default-inactive nil
3914 "If non-nil, setting the mark does not activate it.
3916 behave the same whether or not `transient-mark-mode' is enabled."
3917 :type 'boolean
3918 :group 'editing-basics
3919 :version "23.1")
3921 (defun set-mark-command (arg)
3922 "Set the mark where point is, or jump to the mark.
3923 Setting the mark also alters the region, which is the text
3924 between point and mark; this is the closest equivalent in
3927 With no prefix argument, set the mark at point, and push the
3928 old mark position on local mark ring. Also push the old mark on
3929 global mark ring, if the previous mark was set in another buffer.
3931 When Transient Mark Mode is off, immediately repeating this
3932 command activates `transient-mark-mode' temporarily.
3935 jump to the mark, and set the mark from
3936 position popped off the local mark ring \(this does not affect the global
3938 mark ring \(see `pop-global-mark'\).
3940 If `set-mark-command-repeat-pop' is non-nil, repeating
3942 off the local (or global) mark ring and jumps there.
3945 argument, unconditionally set mark where point is, even if
3946 `set-mark-command-repeat-pop' 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."
3950 (interactive "P")
3951 (cond ((eq transient-mark-mode 'lambda)
3952 (setq transient-mark-mode nil))
3953 ((eq (car-safe transient-mark-mode) 'only)
3954 (deactivate-mark)))
3955 (cond
3956 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3957 (push-mark-command nil))
3958 ((not (eq this-command 'set-mark-command))
3959 (if arg
3960 (pop-to-mark-command)
3961 (push-mark-command t)))
3962 ((and set-mark-command-repeat-pop
3963 (eq last-command 'pop-to-mark-command))
3964 (setq this-command 'pop-to-mark-command)
3965 (pop-to-mark-command))
3966 ((and set-mark-command-repeat-pop
3967 (eq last-command 'pop-global-mark)
3968 (not arg))
3969 (setq this-command 'pop-global-mark)
3970 (pop-global-mark))
3971 (arg
3972 (setq this-command 'pop-to-mark-command)
3973 (pop-to-mark-command))
3974 ((eq last-command 'set-mark-command)
3975 (if (region-active-p)
3976 (progn
3977 (deactivate-mark)
3978 (message "Mark deactivated"))
3979 (activate-mark)
3980 (message "Mark activated")))
3981 (t
3982 (push-mark-command nil)
3983 (if set-mark-default-inactive (deactivate-mark)))))
3985 (defun push-mark (&optional location nomsg activate)
3986 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3987 If the last global mark pushed was not in the current buffer,
3988 also push LOCATION on the global mark ring.
3989 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3991 Novice Emacs Lisp programmers often try to use the mark for the wrong
3992 purposes. See the documentation of `set-mark' for more information.
3994 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3995 (unless (null (mark t))
3996 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3997 (when (> (length mark-ring) mark-ring-max)
3998 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3999 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4000 (set-marker (mark-marker) (or location (point)) (current-buffer))
4001 ;; Now push the mark on the global mark ring.
4002 (if (and global-mark-ring
4003 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4004 ;; The last global mark pushed was in this same buffer.
4005 ;; Don't push another one.
4006 nil
4007 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4008 (when (> (length global-mark-ring) global-mark-ring-max)
4009 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4010 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4011 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4012 (message "Mark set"))
4013 (if (or activate (not transient-mark-mode))
4014 (set-mark (mark t)))
4015 nil)
4017 (defun pop-mark ()
4018 "Pop off mark ring into the buffer's actual mark.
4019 Does not set point. Does nothing if mark ring is empty."
4020 (when mark-ring
4021 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4022 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4023 (move-marker (car mark-ring) nil)
4024 (if (null (mark t)) (ding))
4025 (setq mark-ring (cdr mark-ring)))
4026 (deactivate-mark))
4028 (define-obsolete-function-alias
4029 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4030 (defun exchange-point-and-mark (&optional arg)
4031 "Put the mark where point is now, and point where the mark is now.
4032 This command works even when the mark is not active,
4033 and it reactivates the mark.
4035 If Transient Mark mode is on, a prefix ARG deactivates the mark
4036 if it is active, and otherwise avoids reactivating it. If
4037 Transient Mark mode is off, a prefix ARG enables Transient Mark
4038 mode temporarily."
4039 (interactive "P")
4040 (let ((omark (mark t))
4041 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4042 (if (null omark)
4043 (error "No mark set in this buffer"))
4044 (deactivate-mark)
4045 (set-mark (point))
4046 (goto-char omark)
4047 (if set-mark-default-inactive (deactivate-mark))
4048 (cond (temp-highlight
4049 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4050 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4051 (not (or arg (region-active-p))))
4052 (deactivate-mark))
4053 (t (activate-mark)))
4054 nil))
4056 (defcustom shift-select-mode t
4057 "When non-nil, shifted motion keys activate the mark momentarily.
4059 While the mark is activated in this way, any shift-translated point
4060 motion key extends the region, and if Transient Mark mode was off, it
4061 is temporarily turned on. Furthermore, the mark will be deactivated
4062 by any subsequent point motion key that was not shift-translated, or
4063 by any action that normally deactivates the mark in Transient Mark mode.
4065 See `this-command-keys-shift-translated' for the meaning of
4066 shift-translation."
4067 :type 'boolean
4068 :group 'editing-basics)
4070 (defun handle-shift-selection ()
4071 "Activate/deactivate mark depending on invocation thru shift translation.
4072 This function is called by `call-interactively' when a command
4073 with a `^' character in its `interactive' spec is invoked, before
4074 running the command itself.
4076 If `shift-select-mode' is enabled and the command was invoked
4077 through shift translation, set the mark and activate the region
4078 temporarily, unless it was already set in this way. See
4079 `this-command-keys-shift-translated' for the meaning of shift
4080 translation.
4082 Otherwise, if the region has been activated temporarily,
4083 deactivate it, and restore the variable `transient-mark-mode' to
4084 its earlier value."
4085 (cond ((and shift-select-mode this-command-keys-shift-translated)
4086 (unless (and mark-active
4087 (eq (car-safe transient-mark-mode) 'only))
4088 (setq transient-mark-mode
4089 (cons 'only
4090 (unless (eq transient-mark-mode 'lambda)
4091 transient-mark-mode)))
4092 (push-mark nil nil t)))
4093 ((eq (car-safe transient-mark-mode) 'only)
4094 (setq transient-mark-mode (cdr transient-mark-mode))
4095 (deactivate-mark))))
4097 (define-minor-mode transient-mark-mode
4098 "Toggle Transient Mark mode.
4099 With a prefix argument ARG, enable Transient Mark mode if ARG is
4100 positive, and disable it otherwise. If called from Lisp, enable
4101 Transient Mark mode if ARG is omitted or nil.
4103 Transient Mark mode is a global minor mode. When enabled, the
4104 region is highlighted whenever the mark is active. The mark is
4106 operations that set the mark but whose main purpose is something
4112 Many commands change their behavior when Transient Mark mode is in effect
4113 and the mark is active, by acting on the region instead of their usual
4114 default part of the buffer's text. Examples of such commands include
4119 commands which are sensitive to the Transient Mark mode."
4120 :global t
4121 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4122 :variable transient-mark-mode)
4124 (defvar widen-automatically t
4125 "Non-nil means it is ok for commands to call `widen' when they want to.
4126 Some commands will do this in order to go to positions outside
4127 the current accessible part of the buffer.
4129 If `widen-automatically' is nil, these commands will do something else
4130 as a fallback, and won't change the buffer bounds.")
4132 (defvar non-essential nil
4133 "Whether the currently executing code is performing an essential task.
4134 This variable should be non-nil only when running code which should not
4135 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4136 user for a password when we are simply scanning a set of files in the
4137 background or displaying possible completions before the user even asked
4138 for it.")
4140 (defun pop-global-mark ()
4141 "Pop off global mark ring and jump to the top location."
4142 (interactive)
4143 ;; Pop entries which refer to non-existent buffers.
4144 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4145 (setq global-mark-ring (cdr global-mark-ring)))
4146 (or global-mark-ring
4147 (error "No global mark set"))
4148 (let* ((marker (car global-mark-ring))
4149 (buffer (marker-buffer marker))
4150 (position (marker-position marker)))
4151 (setq global-mark-ring (nconc (cdr global-mark-ring)
4152 (list (car global-mark-ring))))
4153 (set-buffer buffer)
4154 (or (and (>= position (point-min))
4155 (<= position (point-max)))
4156 (if widen-automatically
4157 (widen)
4158 (error "Global mark position is outside accessible part of buffer")))
4159 (goto-char position)
4160 (switch-to-buffer buffer)))
4161 \f
4162 (defcustom next-line-add-newlines nil
4163 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4164 :type 'boolean
4165 :version "21.1"
4166 :group 'editing-basics)
4168 (defun next-line (&optional arg try-vscroll)
4169 "Move cursor vertically down ARG lines.
4170 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4171 If there is no character in the target line exactly under the current column,
4172 the cursor is positioned after the character in that line which spans this
4173 column, or at the end of the line if it is not long enough.
4174 If there is no line in the buffer after this one, behavior depends on the
4175 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4176 to create a line, and moves the cursor to that line. Otherwise it moves the
4177 cursor to the end of the buffer.
4179 If the variable `line-move-visual' is non-nil, this command moves
4180 by display lines. Otherwise, it moves by buffer lines, without
4181 taking variable-width characters or continued lines into account.
4184 a semipermanent goal column for this command.
4185 Then instead of trying to move exactly vertically (or as close as possible),
4186 this command moves to the specified goal column (or as close as possible).
4187 The goal column is stored in the variable `goal-column', which is nil
4188 when there is no goal column. Note that setting `goal-column'
4189 overrides `line-move-visual' and causes this command to move by buffer
4190 lines rather than by display lines.
4192 If you are thinking of using this in a Lisp program, consider
4193 using `forward-line' instead. It is usually easier to use
4194 and more reliable (no dependence on goal column, etc.)."
4196 (or arg (setq arg 1))
4197 (if (and next-line-add-newlines (= arg 1))
4198 (if (save-excursion (end-of-line) (eobp))
4199 ;; When adding a newline, don't expand an abbrev.
4200 (let ((abbrev-mode nil))
4201 (end-of-line)
4203 (line-move arg nil nil try-vscroll))
4204 (if (called-interactively-p 'interactive)
4205 (condition-case err
4206 (line-move arg nil nil try-vscroll)
4207 ((beginning-of-buffer end-of-buffer)
4208 (signal (car err) (cdr err))))
4209 (line-move arg nil nil try-vscroll)))
4210 nil)
4212 (defun previous-line (&optional arg try-vscroll)
4213 "Move cursor vertically up ARG lines.
4214 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4215 If there is no character in the target line exactly over the current column,
4216 the cursor is positioned after the character in that line which spans this
4217 column, or at the end of the line if it is not long enough.
4219 If the variable `line-move-visual' is non-nil, this command moves
4220 by display lines. Otherwise, it moves by buffer lines, without
4221 taking variable-width characters or continued lines into account.
4224 a semipermanent goal column for this command.
4225 Then instead of trying to move exactly vertically (or as close as possible),
4226 this command moves to the specified goal column (or as close as possible).
4227 The goal column is stored in the variable `goal-column', which is nil
4228 when there is no goal column. Note that setting `goal-column'
4229 overrides `line-move-visual' and causes this command to move by buffer
4230 lines rather than by display lines.
4232 If you are thinking of using this in a Lisp program, consider using
4233 `forward-line' with a negative argument instead. It is usually easier
4234 to use and more reliable (no dependence on goal column, etc.)."
4236 (or arg (setq arg 1))
4237 (if (called-interactively-p 'interactive)
4238 (condition-case err
4239 (line-move (- arg) nil nil try-vscroll)
4240 ((beginning-of-buffer end-of-buffer)
4241 (signal (car err) (cdr err))))
4242 (line-move (- arg) nil nil try-vscroll))
4243 nil)
4245 (defcustom track-eol nil
4246 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4247 This means moving to the end of each line moved onto.
4248 The beginning of a blank line does not count as the end of a line.
4249 This has no effect when `line-move-visual' is non-nil."
4250 :type 'boolean
4251 :group 'editing-basics)
4253 (defcustom goal-column nil
4255 A non-nil setting overrides `line-move-visual', which see."
4256 :type '(choice integer
4257 (const :tag "None" nil))
4258 :group 'editing-basics)
4259 (make-variable-buffer-local 'goal-column)
4261 (defvar temporary-goal-column 0
4262 "Current goal column for vertical motion.
4263 It is the column where point was at the start of the current run
4264 of vertical motion commands.
4266 When moving by visual lines via `line-move-visual', it is a cons
4267 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4268 divided by the default column width, and HSCROLL is the number of
4269 columns by which window is scrolled from left margin.
4271 When the `track-eol' feature is doing its job, the value is
4272 `most-positive-fixnum'.")
4274 (defcustom line-move-ignore-invisible t
4276 Outline mode sets this."
4277 :type 'boolean
4278 :group 'editing-basics)
4280 (defcustom line-move-visual t
4281 "When non-nil, `line-move' moves point by visual lines.
4282 This movement is based on where the cursor is displayed on the
4283 screen, instead of relying on buffer contents alone. It takes
4284 into account variable-width characters and line continuation.
4285 If nil, `line-move' moves point by logical lines.
4286 A non-nil setting of `goal-column' overrides the value of this variable
4287 and forces movement by logical lines.
4288 A window that is horizontally scrolled also forces movement by logical
4289 lines."
4290 :type 'boolean
4291 :group 'editing-basics
4292 :version "23.1")
4294 ;; Returns non-nil if partial move was done.
4295 (defun line-move-partial (arg noerror to-end)
4296 (if (< arg 0)
4297 ;; Move backward (up).
4298 ;; If already vscrolled, reduce vscroll
4299 (let ((vs (window-vscroll nil t)))
4300 (when (> vs (frame-char-height))
4301 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4303 ;; Move forward (down).
4304 (let* ((lh (window-line-height -1))
4305 (vpos (nth 1 lh))
4306 (ypos (nth 2 lh))
4307 (rbot (nth 3 lh))
4308 py vs)
4309 (when (or (null lh)
4310 (>= rbot (frame-char-height))
4311 (<= ypos (- (frame-char-height))))
4312 (unless lh
4313 (let ((wend (pos-visible-in-window-p t nil t)))
4314 (setq rbot (nth 3 wend)
4315 vpos (nth 5 wend))))
4316 (cond
4317 ;; If last line of window is fully visible, move forward.
4318 ((or (null rbot) (= rbot 0))
4319 nil)
4320 ;; If cursor is not in the bottom scroll margin, move forward.
4321 ((and (> vpos 0)
4322 (< (setq py
4323 (or (nth 1 (window-line-height))
4324 (let ((ppos (posn-at-point)))
4325 (cdr (or (posn-actual-col-row ppos)
4326 (posn-col-row ppos))))))
4327 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4328 nil)
4329 ;; When already vscrolled, we vscroll some more if we can,
4330 ;; or clear vscroll and move forward at end of tall image.
4331 ((> (setq vs (window-vscroll nil t)) 0)
4332 (when (> rbot 0)
4333 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4334 ;; If cursor just entered the bottom scroll margin, move forward,
4335 ;; but also vscroll one line so redisplay won't recenter.
4336 ((and (> vpos 0)
4337 (= py (min (- (window-text-height) scroll-margin 1)
4338 (1- vpos))))
4339 (set-window-vscroll nil (frame-char-height) t)
4340 (line-move-1 arg noerror to-end)
4341 t)
4342 ;; If there are lines above the last line, scroll-up one line.
4343 ((> vpos 0)
4344 (scroll-up 1)
4345 t)
4346 ;; Finally, start vscroll.
4347 (t
4348 (set-window-vscroll nil (frame-char-height) t)))))))
4351 ;; This is like line-move-1 except that it also performs
4352 ;; vertical scrolling of tall images if appropriate.
4353 ;; That is not really a clean thing to do, since it mixes
4354 ;; scrolling with cursor motion. But so far we don't have
4355 ;; a cleaner solution to the problem of making C-n do something
4356 ;; useful given a tall image.
4357 (defun line-move (arg &optional noerror to-end try-vscroll)
4358 (unless (and auto-window-vscroll try-vscroll
4359 ;; Only vscroll for single line moves
4360 (= (abs arg) 1)
4361 ;; But don't vscroll in a keyboard macro.
4362 (not defining-kbd-macro)
4363 (not executing-kbd-macro)
4364 (line-move-partial arg noerror to-end))
4365 (set-window-vscroll nil 0 t)
4366 (if (and line-move-visual
4367 ;; Display-based column are incompatible with goal-column.
4368 (not goal-column)
4369 ;; When the text in the window is scrolled to the left,
4370 ;; display-based motion doesn't make sense (because each
4371 ;; logical line occupies exactly one screen line).
4372 (not (> (window-hscroll) 0)))
4373 (line-move-visual arg noerror)
4374 (line-move-1 arg noerror to-end))))
4376 ;; Display-based alternative to line-move-1.
4377 ;; Arg says how many lines to move. The value is t if we can move the
4378 ;; specified number of lines.
4379 (defun line-move-visual (arg &optional noerror)
4380 (let ((opoint (point))
4381 (hscroll (window-hscroll))
4382 target-hscroll)
4383 ;; Check if the previous command was a line-motion command, or if
4384 ;; we were called from some other command.
4385 (if (and (consp temporary-goal-column)
4386 (memq last-command `(next-line previous-line ,this-command)))
4387 ;; If so, there's no need to reset `temporary-goal-column',
4388 ;; but we may need to hscroll.
4389 (if (or (/= (cdr temporary-goal-column) hscroll)
4390 (> (cdr temporary-goal-column) 0))
4391 (setq target-hscroll (cdr temporary-goal-column)))
4392 ;; Otherwise, we should reset `temporary-goal-column'.
4393 (let ((posn (posn-at-point)))
4394 (cond
4395 ;; Handle the `overflow-newline-into-fringe' case:
4396 ((eq (nth 1 posn) 'right-fringe)
4397 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4398 ((car (posn-x-y posn))
4399 (setq temporary-goal-column
4400 (cons (/ (float (car (posn-x-y posn)))
4401 (frame-char-width)) hscroll))))))
4402 (if target-hscroll
4403 (set-window-hscroll (selected-window) target-hscroll))
4404 (or (and (= (vertical-motion
4405 (cons (or goal-column
4406 (if (consp temporary-goal-column)
4407 (car temporary-goal-column)
4408 temporary-goal-column))
4409 arg))
4410 arg)
4411 (or (>= arg 0)
4412 (/= (point) opoint)
4413 ;; If the goal column lies on a display string,
4414 ;; `vertical-motion' advances the cursor to the end
4415 ;; of the string. For arg < 0, this can cause the
4416 ;; cursor to get stuck. (Bug#3020).
4417 (= (vertical-motion arg) arg)))
4418 (unless noerror
4419 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4420 nil)))))
4422 ;; This is the guts of next-line and previous-line.
4423 ;; Arg says how many lines to move.
4424 ;; The value is t if we can move the specified number of lines.
4425 (defun line-move-1 (arg &optional noerror _to-end)
4426 ;; Don't run any point-motion hooks, and disregard intangibility,
4427 ;; for intermediate positions.
4428 (let ((inhibit-point-motion-hooks t)
4429 (opoint (point))
4430 (orig-arg arg))
4431 (if (consp temporary-goal-column)
4432 (setq temporary-goal-column (+ (car temporary-goal-column)
4433 (cdr temporary-goal-column))))
4434 (unwind-protect
4435 (progn
4436 (if (not (memq last-command '(next-line previous-line)))
4437 (setq temporary-goal-column
4438 (if (and track-eol (eolp)
4439 ;; Don't count beg of empty line as end of line
4440 ;; unless we just did explicit end-of-line.
4441 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4442 most-positive-fixnum
4443 (current-column))))
4445 (if (not (or (integerp selective-display)
4446 line-move-ignore-invisible))
4447 ;; Use just newline characters.
4448 ;; Set ARG to 0 if we move as many lines as requested.
4449 (or (if (> arg 0)
4450 (progn (if (> arg 1) (forward-line (1- arg)))
4451 ;; This way of moving forward ARG lines
4452 ;; verifies that we have a newline after the last one.
4453 ;; It doesn't get confused by intangible text.
4454 (end-of-line)
4455 (if (zerop (forward-line 1))
4456 (setq arg 0)))
4457 (and (zerop (forward-line arg))
4458 (bolp)
4459 (setq arg 0)))
4460 (unless noerror
4461 (signal (if (< arg 0)
4462 'beginning-of-buffer
4463 'end-of-buffer)
4464 nil)))
4465 ;; Move by arg lines, but ignore invisible ones.
4466 (let (done)
4467 (while (and (> arg 0) (not done))
4468 ;; If the following character is currently invisible,
4469 ;; skip all characters with that same `invisible' property value.
4470 (while (and (not (eobp)) (invisible-p (point)))
4471 (goto-char (next-char-property-change (point))))
4472 ;; Move a line.
4473 ;; We don't use `end-of-line', since we want to escape
4474 ;; from field boundaries occurring exactly at point.
4475 (goto-char (constrain-to-field
4476 (let ((inhibit-field-text-motion t))
4477 (line-end-position))
4478 (point) t t
4479 'inhibit-line-move-field-capture))
4480 ;; If there's no invisibility here, move over the newline.
4481 (cond
4482 ((eobp)
4483 (if (not noerror)
4484 (signal 'end-of-buffer nil)
4485 (setq done t)))
4486 ((and (> arg 1) ;; Use vertical-motion for last move
4487 (not (integerp selective-display))
4488 (not (invisible-p (point))))
4489 ;; We avoid vertical-motion when possible
4490 ;; because that has to fontify.
4491 (forward-line 1))
4492 ;; Otherwise move a more sophisticated way.
4493 ((zerop (vertical-motion 1))
4494 (if (not noerror)
4495 (signal 'end-of-buffer nil)
4496 (setq done t))))
4497 (unless done
4498 (setq arg (1- arg))))
4499 ;; The logic of this is the same as the loop above,
4500 ;; it just goes in the other direction.
4501 (while (and (< arg 0) (not done))
4502 ;; For completely consistency with the forward-motion
4503 ;; case, we should call beginning-of-line here.
4504 ;; However, if point is inside a field and on a
4505 ;; continued line, the call to (vertical-motion -1)
4506 ;; below won't move us back far enough; then we return
4507 ;; to the same column in line-move-finish, and point
4508 ;; gets stuck -- cyd
4509 (forward-line 0)
4510 (cond
4511 ((bobp)
4512 (if (not noerror)
4513 (signal 'beginning-of-buffer nil)
4514 (setq done t)))
4515 ((and (< arg -1) ;; Use vertical-motion for last move
4516 (not (integerp selective-display))
4517 (not (invisible-p (1- (point)))))
4518 (forward-line -1))
4519 ((zerop (vertical-motion -1))
4520 (if (not noerror)
4521 (signal 'beginning-of-buffer nil)
4522 (setq done t))))
4523 (unless done
4524 (setq arg (1+ arg))
4525 (while (and ;; Don't move over previous invis lines
4526 ;; if our target is the middle of this line.
4527 (or (zerop (or goal-column temporary-goal-column))
4528 (< arg 0))
4529 (not (bobp)) (invisible-p (1- (point))))
4530 (goto-char (previous-char-property-change (point))))))))
4531 ;; This is the value the function returns.
4532 (= arg 0))
4534 (cond ((> arg 0)
4535 ;; If we did not move down as far as desired, at least go
4536 ;; to end of line. Be sure to call point-entered and
4537 ;; point-left-hooks.
4538 (let* ((npoint (prog1 (line-end-position)
4539 (goto-char opoint)))
4540 (inhibit-point-motion-hooks nil))
4541 (goto-char npoint)))
4542 ((< arg 0)
4543 ;; If we did not move up as far as desired,
4544 ;; at least go to beginning of line.
4545 (let* ((npoint (prog1 (line-beginning-position)
4546 (goto-char opoint)))
4547 (inhibit-point-motion-hooks nil))
4548 (goto-char npoint)))
4549 (t
4550 (line-move-finish (or goal-column temporary-goal-column)
4551 opoint (> orig-arg 0)))))))
4553 (defun line-move-finish (column opoint forward)
4554 (let ((repeat t))
4555 (while repeat
4556 ;; Set REPEAT to t to repeat the whole thing.
4557 (setq repeat nil)
4559 (let (new
4560 (old (point))
4561 (line-beg (line-beginning-position))
4562 (line-end
4563 ;; Compute the end of the line
4564 ;; ignoring effectively invisible newlines.
4565 (save-excursion
4566 ;; Like end-of-line but ignores fields.
4568 (while (and (not (eobp)) (invisible-p (point)))
4569 (goto-char (next-char-property-change (point)))
4571 (point))))
4573 ;; Move to the desired column.
4574 (line-move-to-column (truncate column))
4576 ;; Corner case: suppose we start out in a field boundary in
4577 ;; the middle of a continued line. When we get to
4578 ;; line-move-finish, point is at the start of a new *screen*
4579 ;; line but the same text line; then line-move-to-column would
4580 ;; move us backwards. Test using C-n with point on the "x" in
4581 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4582 (and forward
4583 (< (point) old)
4584 (goto-char old))
4586 (setq new (point))
4588 ;; Process intangibility within a line.
4589 ;; With inhibit-point-motion-hooks bound to nil, a call to
4590 ;; goto-char moves point past intangible text.
4592 ;; However, inhibit-point-motion-hooks controls both the
4593 ;; intangibility and the point-entered/point-left hooks. The
4594 ;; following hack avoids calling the point-* hooks
4595 ;; unnecessarily. Note that we move *forward* past intangible
4596 ;; text when the initial and final points are the same.
4597 (goto-char new)
4598 (let ((inhibit-point-motion-hooks nil))
4599 (goto-char new)
4601 ;; If intangibility moves us to a different (later) place
4602 ;; in the same line, use that as the destination.
4603 (if (<= (point) line-end)
4604 (setq new (point))
4605 ;; If that position is "too late",
4606 ;; try the previous allowable position.
4607 ;; See if it is ok.
4608 (backward-char)
4609 (if (if forward
4610 ;; If going forward, don't accept the previous
4611 ;; allowable position if it is before the target line.
4612 (< line-beg (point))
4613 ;; If going backward, don't accept the previous
4614 ;; allowable position if it is still after the target line.
4615 (<= (point) line-end))
4616 (setq new (point))
4617 ;; As a last resort, use the end of the line.
4618 (setq new line-end))))
4620 ;; Now move to the updated destination, processing fields
4621 ;; as well as intangibility.
4622 (goto-char opoint)
4623 (let ((inhibit-point-motion-hooks nil))
4624 (goto-char
4625 ;; Ignore field boundaries if the initial and final
4626 ;; positions have the same `field' property, even if the
4627 ;; fields are non-contiguous. This seems to be "nicer"
4628 ;; behavior in many situations.
4629 (if (eq (get-char-property new 'field)
4630 (get-char-property opoint 'field))
4631 new
4632 (constrain-to-field new opoint t t
4633 'inhibit-line-move-field-capture))))
4635 ;; If all this moved us to a different line,
4636 ;; retry everything within that new line.
4637 (when (or (< (point) line-beg) (> (point) line-end))
4638 ;; Repeat the intangibility and field processing.
4639 (setq repeat t))))))
4641 (defun line-move-to-column (col)
4642 "Try to find column COL, considering invisibility.
4643 This function works only in certain cases,
4644 because what we really need is for `move-to-column'
4645 and `current-column' to be able to ignore invisible text."
4646 (if (zerop col)
4647 (beginning-of-line)
4648 (move-to-column col))
4650 (when (and line-move-ignore-invisible
4651 (not (bolp)) (invisible-p (1- (point))))
4652 (let ((normal-location (point))
4653 (normal-column (current-column)))
4654 ;; If the following character is currently invisible,
4655 ;; skip all characters with that same `invisible' property value.
4656 (while (and (not (eobp))
4657 (invisible-p (point)))
4658 (goto-char (next-char-property-change (point))))
4659 ;; Have we advanced to a larger column position?
4660 (if (> (current-column) normal-column)
4661 ;; We have made some progress towards the desired column.
4662 ;; See if we can make any further progress.
4663 (line-move-to-column (+ (current-column) (- col normal-column)))
4664 ;; Otherwise, go to the place we originally found
4665 ;; and move back over invisible text.
4666 ;; that will get us to the same place on the screen
4667 ;; but with a more reasonable buffer position.
4668 (goto-char normal-location)
4669 (let ((line-beg (line-beginning-position)))
4670 (while (and (not (bolp)) (invisible-p (1- (point))))
4671 (goto-char (previous-char-property-change (point) line-beg))))))))
4673 (defun move-end-of-line (arg)
4674 "Move point to end of current line as displayed.
4675 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4676 If point reaches the beginning or end of buffer, it stops there.
4678 To ignore the effects of the `intangible' text or overlay
4679 property, bind `inhibit-point-motion-hooks' to t.
4680 If there is an image in the current line, this function
4681 disregards newlines that are part of the text on which the image
4682 rests."
4683 (interactive "^p")
4684 (or arg (setq arg 1))
4685 (let (done)
4686 (while (not done)
4687 (let ((newpos
4688 (save-excursion
4689 (let ((goal-column 0)
4690 (line-move-visual nil))
4691 (and (line-move arg t)
4692 ;; With bidi reordering, we may not be at bol,
4693 ;; so make sure we are.
4695 (not (bobp))
4696 (progn
4697 (while (and (not (bobp)) (invisible-p (1- (point))))
4698 (goto-char (previous-single-char-property-change
4699 (point) 'invisible)))
4700 (backward-char 1)))
4701 (point)))))
4702 (goto-char newpos)
4703 (if (and (> (point) newpos)
4705 (backward-char 1)
4706 (if (and (> (point) newpos) (not (eobp))
4708 ;; If we skipped something intangible and now we're not
4709 ;; really at eol, keep going.
4710 (setq arg 1)
4711 (setq done t)))))))
4713 (defun move-beginning-of-line (arg)
4714 "Move point to beginning of current line as displayed.
4715 \(If there's an image in the line, this disregards newlines
4716 which are part of the text that the image rests on.)
4718 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4719 If point reaches the beginning or end of buffer, it stops there.
4720 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4721 (interactive "^p")
4722 (or arg (setq arg 1))
4724 (let ((orig (point))
4725 first-vis first-vis-field-value)
4727 ;; Move by lines, if ARG is not 1 (the default).
4728 (if (/= arg 1)
4729 (let ((line-move-visual nil))
4730 (line-move (1- arg) t)))
4732 ;; Move to beginning-of-line, ignoring fields and invisible text.
4734 (while (and (not (bobp)) (invisible-p (1- (point))))
4735 (goto-char (previous-char-property-change (point)))
4738 ;; Now find first visible char in the line
4739 (while (and (not (eobp)) (invisible-p (point)))
4740 (goto-char (next-char-property-change (point))))
4741 (setq first-vis (point))
4743 ;; See if fields would stop us from reaching FIRST-VIS.
4744 (setq first-vis-field-value
4745 (constrain-to-field first-vis orig (/= arg 1) t nil))
4747 (goto-char (if (/= first-vis-field-value first-vis)
4748 ;; If yes, obey them.
4749 first-vis-field-value
4750 ;; Otherwise, move to START with attention to fields.
4751 ;; (It is possible that fields never matter in this case.)
4752 (constrain-to-field (point) orig
4753 (/= arg 1) t nil)))))
4756 ;; Many people have said they rarely use this feature, and often type
4757 ;; it by accident. Maybe it shouldn't even be on a key.
4758 (put 'set-goal-column 'disabled t)
4760 (defun set-goal-column (arg)
4762 Those commands will move to this position in the line moved to
4763 rather than trying to keep the same horizontal position.
4764 With a non-nil argument ARG, clears out the goal column
4766 The goal column is stored in the variable `goal-column'."
4767 (interactive "P")
4768 (if arg
4769 (progn
4770 (setq goal-column nil)
4771 (message "No goal column"))
4772 (setq goal-column (current-column))
4773 ;; The older method below can be erroneous if `set-goal-column' is bound
4774 ;; to a sequence containing %
4775 ;;(message (substitute-command-keys
4777 ;;goal-column)
4778 (message "%s"
4779 (concat
4780 (format "Goal column %d " goal-column)
4781 (substitute-command-keys
4784 )
4785 nil)
4786 \f
4787 ;;; Editing based on visual lines, as opposed to logical lines.
4789 (defun end-of-visual-line (&optional n)
4790 "Move point to end of current visual line.
4791 With argument N not nil or 1, move forward N - 1 visual lines first.
4792 If point reaches the beginning or end of buffer, it stops there.
4793 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4794 (interactive "^p")
4795 (or n (setq n 1))
4796 (if (/= n 1)
4797 (let ((line-move-visual t))
4798 (line-move (1- n) t)))
4799 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4800 ;; constrain to field boundaries, so we don't either.
4801 (vertical-motion (cons (window-width) 0)))
4803 (defun beginning-of-visual-line (&optional n)
4804 "Move point to beginning of current visual line.
4805 With argument N not nil or 1, move forward N - 1 visual lines first.
4806 If point reaches the beginning or end of buffer, it stops there.
4807 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4808 (interactive "^p")
4809 (or n (setq n 1))
4810 (let ((opoint (point)))
4811 (if (/= n 1)
4812 (let ((line-move-visual t))
4813 (line-move (1- n) t)))
4814 (vertical-motion 0)
4815 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4816 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4818 (defun kill-visual-line (&optional arg)
4819 "Kill the rest of the visual line.
4820 With prefix argument ARG, kill that many visual lines from point.
4821 If ARG is negative, kill visual lines backward.
4822 If ARG is zero, kill the text before point on the current visual
4823 line.
4825 If you want to append the killed line to the last killed text,
4828 If the buffer is read-only, Emacs will beep and refrain from deleting
4829 the line, but put the line in the kill ring anyway. This means that
4830 you can use this command to copy text from a read-only buffer.
4831 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4832 even beep.)"
4833 (interactive "P")
4834 ;; Like in `kill-line', it's better to move point to the other end
4835 ;; of the kill before killing.
4836 (let ((opoint (point))
4837 (kill-whole-line (and kill-whole-line (bolp))))
4838 (if arg
4839 (vertical-motion (prefix-numeric-value arg))
4840 (end-of-visual-line 1)
4841 (if (= (point) opoint)
4842 (vertical-motion 1)
4843 ;; Skip any trailing whitespace at the end of the visual line.
4844 ;; We used to do this only if `show-trailing-whitespace' is
4845 ;; nil, but that's wrong; the correct thing would be to check
4846 ;; whether the trailing whitespace is highlighted. But, it's
4847 ;; OK to just do this unconditionally.
4850 (1+ (point))
4851 (point)))))
4853 (defun next-logical-line (&optional arg try-vscroll)
4854 "Move cursor vertically down ARG lines.
4855 This is identical to `next-line', except that it always moves
4856 by logical lines instead of visual lines, ignoring the value of
4857 the variable `line-move-visual'."
4859 (let ((line-move-visual nil))
4860 (with-no-warnings
4861 (next-line arg try-vscroll))))
4863 (defun previous-logical-line (&optional arg try-vscroll)
4864 "Move cursor vertically up ARG lines.
4865 This is identical to `previous-line', except that it always moves
4866 by logical lines instead of visual lines, ignoring the value of
4867 the variable `line-move-visual'."
4869 (let ((line-move-visual nil))
4870 (with-no-warnings
4871 (previous-line arg try-vscroll))))
4873 (defgroup visual-line nil
4874 "Editing based on visual lines."
4875 :group 'convenience
4876 :version "23.1")
4878 (defvar visual-line-mode-map
4879 (let ((map (make-sparse-keymap)))
4880 (define-key map [remap kill-line] 'kill-visual-line)
4881 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4882 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4883 ;; These keybindings interfere with xterm function keys. Are
4884 ;; there any other suitable bindings?
4885 ;; (define-key map "\M-[" 'previous-logical-line)
4886 ;; (define-key map "\M-]" 'next-logical-line)
4887 map))
4889 (defcustom visual-line-fringe-indicators '(nil nil)
4890 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4891 The value should be a list of the form (LEFT RIGHT), where LEFT
4892 and RIGHT are symbols representing the bitmaps to display, to
4893 indicate wrapped lines, in the left and right fringes respectively.
4894 See also `fringe-indicator-alist'.
4895 The default is not to display fringe indicators for wrapped lines.
4896 This variable does not affect fringe indicators displayed for
4897 other purposes."
4898 :type '(list (choice (const :tag "Hide left indicator" nil)
4899 (const :tag "Left curly arrow" left-curly-arrow)
4900 (symbol :tag "Other bitmap"))
4901 (choice (const :tag "Hide right indicator" nil)
4902 (const :tag "Right curly arrow" right-curly-arrow)
4903 (symbol :tag "Other bitmap")))
4904 :set (lambda (symbol value)
4905 (dolist (buf (buffer-list))
4906 (with-current-buffer buf
4907 (when (and (boundp 'visual-line-mode)
4908 (symbol-value 'visual-line-mode))
4909 (setq fringe-indicator-alist
4910 (cons (cons 'continuation value)
4911 (assq-delete-all
4912 'continuation
4913 (copy-tree fringe-indicator-alist)))))))
4914 (set-default symbol value)))
4916 (defvar visual-line--saved-state nil)
4918 (define-minor-mode visual-line-mode
4919 "Toggle visual line based editing (Visual Line mode).
4920 With a prefix argument ARG, enable Visual Line mode if ARG is
4921 positive, and disable it otherwise. If called from Lisp, enable
4922 the mode if ARG is omitted or nil.
4924 When Visual Line mode is enabled, `word-wrap' is turned on in
4925 this buffer, and simple editing commands are redefined to act on
4926 visual lines, not logical lines. See Info node `Visual Line
4927 Mode' for details."
4928 :keymap visual-line-mode-map
4929 :group 'visual-line
4930 :lighter " Wrap"
4931 (if visual-line-mode
4932 (progn
4933 (set (make-local-variable 'visual-line--saved-state) nil)
4934 ;; Save the local values of some variables, to be restored if
4935 ;; visual-line-mode is turned off.
4936 (dolist (var '(line-move-visual truncate-lines
4937 truncate-partial-width-windows
4938 word-wrap fringe-indicator-alist))
4939 (if (local-variable-p var)
4940 (push (cons var (symbol-value var))
4941 visual-line--saved-state)))
4942 (set (make-local-variable 'line-move-visual) t)
4943 (set (make-local-variable 'truncate-partial-width-windows) nil)
4944 (setq truncate-lines nil
4945 word-wrap t
4946 fringe-indicator-alist
4947 (cons (cons 'continuation visual-line-fringe-indicators)
4948 fringe-indicator-alist)))
4949 (kill-local-variable 'line-move-visual)
4950 (kill-local-variable 'word-wrap)
4951 (kill-local-variable 'truncate-lines)
4952 (kill-local-variable 'truncate-partial-width-windows)
4953 (kill-local-variable 'fringe-indicator-alist)
4954 (dolist (saved visual-line--saved-state)
4955 (set (make-local-variable (car saved)) (cdr saved)))
4956 (kill-local-variable 'visual-line--saved-state)))
4958 (defun turn-on-visual-line-mode ()
4959 (visual-line-mode 1))
4961 (define-globalized-minor-mode global-visual-line-mode
4962 visual-line-mode turn-on-visual-line-mode
4963 :lighter " vl")
4965 \f
4966 (defun transpose-chars (arg)
4967 "Interchange characters around point, moving forward one character.
4968 With prefix arg ARG, effect is to take character before point
4969 and drag it forward past ARG other characters (backward if ARG negative).
4970 If no argument and at end of line, the previous two chars are exchanged."
4971 (interactive "*P")
4972 (and (null arg) (eolp) (forward-char -1))
4973 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4975 (defun transpose-words (arg)
4976 "Interchange words around point, leaving point at end of them.
4977 With prefix arg ARG, effect is to take word before or around point
4978 and drag it forward past ARG other words (backward if ARG negative).
4979 If ARG is zero, the words around or after point and around or after mark
4980 are interchanged."
4981 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4982 (interactive "*p")
4983 (transpose-subr 'forward-word arg))
4985 (defun transpose-sexps (arg)
4987 Does not work on a sexp that point is in the middle of
4988 if it is a list or string."
4989 (interactive "*p")
4990 (transpose-subr
4991 (lambda (arg)
4992 ;; Here we should try to simulate the behavior of
4993 ;; (cons (progn (forward-sexp x) (point))
4994 ;; (progn (forward-sexp (- x)) (point)))
4995 ;; Except that we don't want to rely on the second forward-sexp
4996 ;; putting us back to where we want to be, since forward-sexp-function
4997 ;; might do funny things like infix-precedence.
4998 (if (if (> arg 0)
5000 (and (not (bobp))
5002 ;; Jumping over a symbol. We might be inside it, mind you.
5003 (progn (funcall (if (> arg 0)
5004 'skip-syntax-backward 'skip-syntax-forward)
5005 "w_")
5006 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5007 ;; Otherwise, we're between sexps. Take a step back before jumping
5008 ;; to make sure we'll obey the same precedence no matter which direction
5009 ;; we're going.
5010 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5011 (cons (save-excursion (forward-sexp arg) (point))
5012 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5013 (not (zerop (funcall (if (> arg 0)
5014 'skip-syntax-forward
5015 'skip-syntax-backward)
5016 ".")))))
5017 (point)))))
5018 arg 'special))
5020 (defun transpose-lines (arg)
5021 "Exchange current line and previous line, leaving point after both.
5022 With argument ARG, takes previous line and moves it past ARG lines.
5023 With argument 0, interchanges line point is in with line mark is in."
5024 (interactive "*p")
5025 (transpose-subr (function
5026 (lambda (arg)
5027 (if (> arg 0)
5028 (progn
5029 ;; Move forward over ARG lines,
5030 ;; but create newlines if necessary.
5031 (setq arg (forward-line arg))
5033 (setq arg (1+ arg)))
5034 (if (> arg 0)
5035 (newline arg)))
5036 (forward-line arg))))
5037 arg))
5039 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5040 ;; which seems inconsistent with the ARG /= 0 case.
5041 ;; FIXME document SPECIAL.
5042 (defun transpose-subr (mover arg &optional special)
5043 "Subroutine to do the work of transposing objects.
5044 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5045 moves forward by units of the given object (e.g. forward-sentence,
5046 forward-paragraph). If ARG is zero, exchanges the current object
5047 with the one containing mark. If ARG is an integer, moves the
5048 current object past ARG following (if ARG is positive) or
5049 preceding (if ARG is negative) objects, leaving point after the
5050 current object."
5051 (let ((aux (if special mover
5052 (lambda (x)
5053 (cons (progn (funcall mover x) (point))
5054 (progn (funcall mover (- x)) (point))))))
5055 pos1 pos2)
5056 (cond
5057 ((= arg 0)
5058 (save-excursion
5059 (setq pos1 (funcall aux 1))
5060 (goto-char (or (mark) (error "No mark set in this buffer")))
5061 (setq pos2 (funcall aux 1))
5062 (transpose-subr-1 pos1 pos2))
5063 (exchange-point-and-mark))
5064 ((> arg 0)
5065 (setq pos1 (funcall aux -1))
5066 (setq pos2 (funcall aux arg))
5067 (transpose-subr-1 pos1 pos2)
5068 (goto-char (car pos2)))
5069 (t
5070 (setq pos1 (funcall aux -1))
5071 (goto-char (car pos1))
5072 (setq pos2 (funcall aux arg))
5073 (transpose-subr-1 pos1 pos2)))))
5075 (defun transpose-subr-1 (pos1 pos2)
5076 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5077 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5078 (when (> (car pos1) (car pos2))
5079 (let ((swap pos1))
5080 (setq pos1 pos2 pos2 swap)))
5081 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5082 (atomic-change-group
5083 (let (word2)
5084 ;; FIXME: We first delete the two pieces of text, so markers that
5085 ;; used to point to after the text end up pointing to before it :-(
5086 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5087 (goto-char (car pos2))
5088 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5089 (goto-char (car pos1))
5090 (insert word2))))
5091 \f
5092 (defun backward-word (&optional arg)
5093 "Move backward until encountering the beginning of a word.
5094 With argument ARG, do this that many times."
5095 (interactive "^p")
5096 (forward-word (- (or arg 1))))
5098 (defun mark-word (&optional arg allow-extend)
5099 "Set mark ARG words away from point.
5101 move to with the same argument.
5102 Interactively, if this command is repeated
5103 or (in Transient Mark mode) if the mark is active,
5104 it marks the next ARG words after the ones already marked."
5106 (cond ((and allow-extend
5107 (or (and (eq last-command this-command) (mark t))
5108 (region-active-p)))
5109 (setq arg (if arg (prefix-numeric-value arg)
5110 (if (< (mark) (point)) -1 1)))
5111 (set-mark
5112 (save-excursion
5113 (goto-char (mark))
5114 (forward-word arg)
5115 (point))))
5116 (t
5117 (push-mark
5118 (save-excursion
5119 (forward-word (prefix-numeric-value arg))
5120 (point))
5121 nil t))))
5123 (defun kill-word (arg)
5124 "Kill characters forward until encountering the end of a word.
5125 With argument ARG, do this that many times."
5126 (interactive "p")
5127 (kill-region (point) (progn (forward-word arg) (point))))
5129 (defun backward-kill-word (arg)
5130 "Kill characters backward until encountering the beginning of a word.
5131 With argument ARG, do this that many times."
5132 (interactive "p")
5133 (kill-word (- arg)))
5135 (defun current-word (&optional strict really-word)
5136 "Return the symbol or word that point is on (or a nearby one) as a string.
5137 The return value includes no text properties.
5138 If optional arg STRICT is non-nil, return nil unless point is within
5139 or adjacent to a symbol or word. In all cases the value can be nil
5140 if there is no word nearby.
5141 The function, belying its name, normally finds a symbol.
5142 If optional arg REALLY-WORD is non-nil, it finds just a word."
5143 (save-excursion
5144 (let* ((oldpoint (point)) (start (point)) (end (point))
5145 (syntaxes (if really-word "w" "w_"))
5146 (not-syntaxes (concat "^" syntaxes)))
5147 (skip-syntax-backward syntaxes) (setq start (point))
5148 (goto-char oldpoint)
5149 (skip-syntax-forward syntaxes) (setq end (point))
5150 (when (and (eq start oldpoint) (eq end oldpoint)
5151 ;; Point is neither within nor adjacent to a word.
5152 (not strict))
5153 ;; Look for preceding word in same line.
5154 (skip-syntax-backward not-syntaxes (line-beginning-position))
5155 (if (bolp)
5156 ;; No preceding word in same line.
5157 ;; Look for following word in same line.
5158 (progn
5159 (skip-syntax-forward not-syntaxes (line-end-position))
5160 (setq start (point))
5161 (skip-syntax-forward syntaxes)
5162 (setq end (point)))
5163 (setq end (point))
5164 (skip-syntax-backward syntaxes)
5165 (setq start (point))))
5166 ;; If we found something nonempty, return it as a string.
5167 (unless (= start end)
5168 (buffer-substring-no-properties start end)))))
5169 \f
5170 (defcustom fill-prefix nil
5171 "String for filling to insert at front of new line, or nil for none."
5172 :type '(choice (const :tag "None" nil)
5173 string)
5174 :group 'fill)
5175 (make-variable-buffer-local 'fill-prefix)
5176 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5178 (defcustom auto-fill-inhibit-regexp nil
5179 "Regexp to match lines which should not be auto-filled."
5180 :type '(choice (const :tag "None" nil)
5181 regexp)
5182 :group 'fill)
5184 (defun do-auto-fill ()
5185 "The default value for `normal-auto-fill-function'.
5186 This is the default auto-fill function, some major modes use a different one.
5187 Returns t if it really did any work."
5188 (let (fc justify give-up
5189 (fill-prefix fill-prefix))
5190 (if (or (not (setq justify (current-justification)))
5191 (null (setq fc (current-fill-column)))
5192 (and (eq justify 'left)
5193 (<= (current-column) fc))
5194 (and auto-fill-inhibit-regexp
5195 (save-excursion (beginning-of-line)
5196 (looking-at auto-fill-inhibit-regexp))))
5197 nil ;; Auto-filling not required
5198 (if (memq justify '(full center right))
5199 (save-excursion (unjustify-current-line)))
5201 ;; Choose a fill-prefix automatically.
5202 (when (and adaptive-fill-mode
5203 (or (null fill-prefix) (string= fill-prefix "")))
5204 (let ((prefix
5205 (fill-context-prefix
5206 (save-excursion (fill-forward-paragraph -1) (point))
5207 (save-excursion (fill-forward-paragraph 1) (point)))))
5208 (and prefix (not (equal prefix ""))
5209 ;; Use auto-indentation rather than a guessed empty prefix.
5210 (not (and fill-indent-according-to-mode
5212 (setq fill-prefix prefix))))
5214 (while (and (not give-up) (> (current-column) fc))
5215 ;; Determine where to split the line.
5216 (let* (after-prefix
5217 (fill-point
5218 (save-excursion
5219 (beginning-of-line)
5220 (setq after-prefix (point))
5221 (and fill-prefix
5222 (looking-at (regexp-quote fill-prefix))
5223 (setq after-prefix (match-end 0)))
5224 (move-to-column (1+ fc))
5225 (fill-move-to-break-point after-prefix)
5226 (point))))
5228 ;; See whether the place we found is any good.
5229 (if (save-excursion
5230 (goto-char fill-point)
5231 (or (bolp)
5232 ;; There is no use breaking at end of line.
5233 (save-excursion (skip-chars-forward " ") (eolp))
5234 ;; It is futile to split at the end of the prefix
5235 ;; since we would just insert the prefix again.
5236 (and after-prefix (<= (point) after-prefix))
5237 ;; Don't split right after a comment starter
5238 ;; since we would just make another comment starter.
5239 (and comment-start-skip
5240 (let ((limit (point)))
5241 (beginning-of-line)
5242 (and (re-search-forward comment-start-skip
5243 limit t)
5244 (eq (point) limit))))))
5245 ;; No good place to break => stop trying.
5246 (setq give-up t)
5247 ;; Ok, we have a useful place to break the line. Do it.
5248 (let ((prev-column (current-column)))
5249 ;; If point is at the fill-point, do not `save-excursion'.
5250 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5251 ;; point will end up before it rather than after it.
5252 (if (save-excursion
5254 (= (point) fill-point))
5255 (default-indent-new-line t)
5256 (save-excursion
5257 (goto-char fill-point)
5258 (default-indent-new-line t)))
5259 ;; Now do justification, if required
5260 (if (not (eq justify 'left))
5261 (save-excursion
5262 (end-of-line 0)
5263 (justify-current-line justify nil t)))
5264 ;; If making the new line didn't reduce the hpos of
5265 ;; the end of the line, then give up now;
5266 ;; trying again will not help.
5267 (if (>= (current-column) prev-column)
5268 (setq give-up t))))))
5269 ;; Justify last line.
5270 (justify-current-line justify t t)
5271 t)))
5273 (defvar comment-line-break-function 'comment-indent-new-line
5274 "*Mode-specific function which line breaks and continues a comment.
5275 This function is called during auto-filling when a comment syntax
5276 is defined.
5277 The function should take a single optional argument, which is a flag
5278 indicating whether it should use soft newlines.")
5280 (defun default-indent-new-line (&optional soft)
5281 "Break line at point and indent.
5282 If a comment syntax is defined, call `comment-indent-new-line'.
5284 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5285 unless optional argument SOFT is non-nil."
5286 (interactive)
5287 (if comment-start
5288 (funcall comment-line-break-function soft)
5289 ;; Insert the newline before removing empty space so that markers
5290 ;; get preserved better.
5292 (save-excursion (forward-char -1) (delete-horizontal-space))
5293 (delete-horizontal-space)
5295 (if (and fill-prefix (not adaptive-fill-mode))
5296 ;; Blindly trust a non-adaptive fill-prefix.
5297 (progn
5298 (indent-to-left-margin)
5299 (insert-before-markers-and-inherit fill-prefix))
5301 (cond
5302 ;; If there's an adaptive prefix, use it unless we're inside
5303 ;; a comment and the prefix is not a comment starter.
5304 (fill-prefix
5305 (indent-to-left-margin)
5306 (insert-and-inherit fill-prefix))
5307 ;; If we're not inside a comment, just try to indent.
5308 (t (indent-according-to-mode))))))
5310 (defvar normal-auto-fill-function 'do-auto-fill
5311 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5312 Some major modes set this.")
5314 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5315 ;; `functions' and `hooks' are usually unsafe to set, but setting
5316 ;; auto-fill-function to nil in a file-local setting is safe and
5317 ;; can be useful to prevent auto-filling.
5318 (put 'auto-fill-function 'safe-local-variable 'null)
5320 (define-minor-mode auto-fill-mode
5321 "Toggle automatic line breaking (Auto Fill mode).
5322 With a prefix argument ARG, enable Auto Fill mode if ARG is
5323 positive, and disable it otherwise. If called from Lisp, enable
5324 the mode if ARG is omitted or nil.
5326 When Auto Fill mode is enabled, inserting a space at a column
5327 beyond `current-fill-column' automatically breaks the line at a
5328 previous space.
5330 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5331 non-`nil'.
5333 The value of `normal-auto-fill-function' specifies the function to use
5334 for `auto-fill-function' when turning Auto Fill mode on."
5335 :variable (eq auto-fill-function normal-auto-fill-function))
5337 ;; This holds a document string used to document auto-fill-mode.
5338 (defun auto-fill-function ()
5339 "Automatically break line at a previous space, in insertion of text."
5340 nil)
5342 (defun turn-on-auto-fill ()
5343 "Unconditionally turn on Auto Fill mode."
5344 (auto-fill-mode 1))
5346 (defun turn-off-auto-fill ()
5347 "Unconditionally turn off Auto Fill mode."
5348 (auto-fill-mode -1))
5350 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5352 (defun set-fill-column (arg)
5353 "Set `fill-column' to specified argument.
5356 (interactive
5357 (list (or current-prefix-arg
5358 ;; We used to use current-column silently, but C-x f is too easily
5359 ;; typed as a typo for C-x C-f, so we turned it into an error and
5360 ;; now an interactive prompt.
5361 (read-number "Set fill-column to: " (current-column)))))
5362 (if (consp arg)
5363 (setq arg (current-column)))
5364 (if (not (integerp arg))
5365 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5366 (error "set-fill-column requires an explicit argument")
5367 (message "Fill column set to %d (was %d)" arg fill-column)
5368 (setq fill-column arg)))
5369 \f
5370 (defun set-selective-display (arg)
5371 "Set `selective-display' to ARG; clear it if no arg.
5372 When the value of `selective-display' is a number > 0,
5373 lines whose indentation is >= that value are not displayed.
5374 The variable `selective-display' has a separate value for each buffer."
5375 (interactive "P")
5376 (if (eq selective-display t)
5377 (error "selective-display already in use for marked lines"))
5378 (let ((current-vpos
5379 (save-restriction
5380 (narrow-to-region (point-min) (point))
5381 (goto-char (window-start))
5382 (vertical-motion (window-height)))))
5383 (setq selective-display
5384 (and arg (prefix-numeric-value arg)))
5385 (recenter current-vpos))
5386 (set-window-start (selected-window) (window-start (selected-window)))
5387 (princ "selective-display set to " t)
5388 (prin1 selective-display t)
5389 (princ "." t))
5391 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5393 (defun toggle-truncate-lines (&optional arg)
5394 "Toggle truncating of long lines for the current buffer.
5395 When truncating is off, long lines are folded.
5396 With prefix argument ARG, truncate long lines if ARG is positive,
5397 otherwise fold them. Note that in side-by-side windows, this
5398 command has no effect if `truncate-partial-width-windows' is
5399 non-nil."
5400 (interactive "P")
5401 (setq truncate-lines
5402 (if (null arg)
5403 (not truncate-lines)
5404 (> (prefix-numeric-value arg) 0)))
5405 (force-mode-line-update)
5406 (unless truncate-lines
5407 (let ((buffer (current-buffer)))
5408 (walk-windows (lambda (window)
5409 (if (eq buffer (window-buffer window))
5410 (set-window-hscroll window 0)))
5411 nil t)))
5412 (message "Truncate long lines %s"
5413 (if truncate-lines "enabled" "disabled")))
5415 (defun toggle-word-wrap (&optional arg)
5416 "Toggle whether to use word-wrapping for continuation lines.
5417 With prefix argument ARG, wrap continuation lines at word boundaries
5418 if ARG is positive, otherwise wrap them at the right screen edge.
5419 This command toggles the value of `word-wrap'. It has no effect
5420 if long lines are truncated."
5421 (interactive "P")
5422 (setq word-wrap
5423 (if (null arg)
5424 (not word-wrap)
5425 (> (prefix-numeric-value arg) 0)))
5426 (force-mode-line-update)
5427 (message "Word wrapping %s"
5428 (if word-wrap "enabled" "disabled")))
5430 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5431 "The string displayed in the mode line when in overwrite mode.")
5432 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5433 "The string displayed in the mode line when in binary overwrite mode.")
5435 (define-minor-mode overwrite-mode
5436 "Toggle Overwrite mode.
5437 With a prefix argument ARG, enable Overwrite mode if ARG is
5438 positive, and disable it otherwise. If called from Lisp, enable
5439 the mode if ARG is omitted or nil.
5441 When Overwrite mode is enabled, printing characters typed in
5442 replace existing text on a one-for-one basis, rather than pushing
5443 it to the right. At the end of a line, such characters extend
5444 the line. Before a tab, such characters insert until the tab is
5446 overwrite mode; this is supposed to make it easier to insert
5447 characters when necessary."
5448 :variable (eq overwrite-mode 'overwrite-mode-textual))
5450 (define-minor-mode binary-overwrite-mode
5451 "Toggle Binary Overwrite mode.
5452 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5453 is positive, and disable it otherwise. If called from Lisp,
5454 enable the mode if ARG is omitted or nil.
5456 When Binary Overwrite mode is enabled, printing characters typed
5457 in replace existing text. Newlines are not treated specially, so
5458 typing at the end of a line joins the line to the next, with the
5459 typed character between them. Typing before a tab character
5460 simply replaces the tab with the character typed.
5462 ordinary typing characters do.
5464 Note that Binary Overwrite mode is not its own minor mode; it is
5465 a specialization of overwrite mode, entered by setting the
5466 `overwrite-mode' variable to `overwrite-mode-binary'."
5467 :variable (eq overwrite-mode 'overwrite-mode-binary))
5469 (define-minor-mode line-number-mode
5470 "Toggle line number display in the mode line (Line Number mode).
5471 With a prefix argument ARG, enable Line Number mode if ARG is
5472 positive, and disable it otherwise. If called from Lisp, enable
5473 the mode if ARG is omitted or nil.
5475 Line numbers do not appear for very large buffers and buffers
5476 with very long lines; see variables `line-number-display-limit'
5477 and `line-number-display-limit-width'."
5478 :init-value t :global t :group 'mode-line)
5480 (define-minor-mode column-number-mode
5481 "Toggle column number display in the mode line (Column Number mode).
5482 With a prefix argument ARG, enable Column Number mode if ARG is
5483 positive, and disable it otherwise.
5485 If called from Lisp, enable the mode if ARG is omitted or nil."
5486 :global t :group 'mode-line)
5488 (define-minor-mode size-indication-mode
5489 "Toggle buffer size display in the mode line (Size Indication mode).
5490 With a prefix argument ARG, enable Size Indication mode if ARG is
5491 positive, and disable it otherwise.
5493 If called from Lisp, enable the mode if ARG is omitted or nil."
5494 :global t :group 'mode-line)
5496 (define-minor-mode auto-save-mode
5497 "Toggle auto-saving in the current buffer (Auto Save mode).
5498 With a prefix argument ARG, enable Auto Save mode if ARG is
5499 positive, and disable it otherwise.
5501 If called from Lisp, enable the mode if ARG is omitted or nil."
5502 :variable ((and buffer-auto-save-file-name
5503 ;; If auto-save is off because buffer has shrunk,
5504 ;; then toggling should turn it on.
5505 (>= buffer-saved-size 0))
5506 . (lambda (val)
5507 (setq buffer-auto-save-file-name
5508 (cond
5509 ((null val) nil)
5510 ((and buffer-file-name auto-save-visited-file-name
5511 (not buffer-read-only))
5512 buffer-file-name)
5513 (t (make-auto-save-file-name))))))
5514 ;; If -1 was stored here, to temporarily turn off saving,
5515 ;; turn it back on.
5516 (and (< buffer-saved-size 0)
5517 (setq buffer-saved-size 0)))
5518 \f
5519 (defgroup paren-blinking nil
5520 "Blinking matching of parens and expressions."
5521 :prefix "blink-matching-"
5522 :group 'paren-matching)
5524 (defcustom blink-matching-paren t
5525 "Non-nil means show matching open-paren when close-paren is inserted."
5526 :type 'boolean
5527 :group 'paren-blinking)
5529 (defcustom blink-matching-paren-on-screen t
5530 "Non-nil means show matching open-paren when it is on screen.
5531 If nil, don't show it (but the open-paren can still be shown
5532 when it is off screen).
5534 This variable has no effect if `blink-matching-paren' is nil.
5535 \(In that case, the open-paren is never shown.)
5536 It is also ignored if `show-paren-mode' is enabled."
5537 :type 'boolean
5538 :group 'paren-blinking)
5540 (defcustom blink-matching-paren-distance (* 100 1024)
5541 "If non-nil, maximum distance to search backwards for matching open-paren.
5542 If nil, search stops at the beginning of the accessible portion of the buffer."
5543 :version "23.2" ; 25->100k
5544 :type '(choice (const nil) integer)
5545 :group 'paren-blinking)
5547 (defcustom blink-matching-delay 1
5548 "Time in seconds to delay after showing a matching paren."
5549 :type 'number
5550 :group 'paren-blinking)
5552 (defcustom blink-matching-paren-dont-ignore-comments nil
5553 "If nil, `blink-matching-paren' ignores comments.
5554 More precisely, when looking for the matching parenthesis,
5555 it skips the contents of comments that end before point."
5556 :type 'boolean
5557 :group 'paren-blinking)
5559 (defun blink-matching-check-mismatch (start end)
5560 "Return whether or not START...END are matching parens.
5561 END is the current point and START is the blink position.
5562 START might be nil if no matching starter was found.
5563 Returns non-nil if we find there is a mismatch."
5564 (let* ((end-syntax (syntax-after (1- end)))
5565 (matching-paren (and (consp end-syntax)
5566 (eq (syntax-class end-syntax) 5)
5567 (cdr end-syntax))))
5568 ;; For self-matched chars like " and $, we can't know when they're
5569 ;; mismatched or unmatched, so we can only do it for parens.
5570 (when matching-paren
5571 (not (and start
5572 (or
5573 (eq (char-after start) matching-paren)
5574 ;; The cdr might hold a new paren-class info rather than
5575 ;; a matching-char info, in which case the two CDRs
5576 ;; should match.
5577 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5579 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5580 "Function to check parentheses mismatches.
5581 The function takes two arguments (START and END) where START is the
5582 position just before the opening token and END is the position right after.
5583 START can be nil, if it was not found.
5584 The function should return non-nil if the two tokens do not match.")
5586 (defun blink-matching-open ()
5587 "Move cursor momentarily to the beginning of the sexp before point."
5588 (interactive)
5589 (when (and (not (bobp))
5590 blink-matching-paren)
5591 (let* ((oldpos (point))
5592 (message-log-max nil) ; Don't log messages about paren matching.
5593 (blinkpos
5594 (save-excursion
5595 (save-restriction
5596 (if blink-matching-paren-distance
5597 (narrow-to-region
5598 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5599 (- (point) blink-matching-paren-distance))
5600 oldpos))
5601 (let ((parse-sexp-ignore-comments
5602 (and parse-sexp-ignore-comments
5603 (not blink-matching-paren-dont-ignore-comments))))
5604 (condition-case ()
5605 (progn
5606 (forward-sexp -1)
5607 ;; backward-sexp skips backward over prefix chars,
5608 ;; so move back to the matching paren.
5609 (while (and (< (point) (1- oldpos))
5610 (let ((code (syntax-after (point))))
5611 (or (eq (syntax-class code) 6)
5612 (eq (logand 1048576 (car code))
5613 1048576))))
5614 (forward-char 1))
5615 (point))
5616 (error nil))))))
5617 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5618 (cond
5619 (mismatch
5620 (if blinkpos
5621 (if (minibufferp)
5622 (minibuffer-message "Mismatched parentheses")
5623 (message "Mismatched parentheses"))
5624 (if (minibufferp)
5625 (minibuffer-message "No matching parenthesis found")
5626 (message "No matching parenthesis found"))))
5627 ((not blinkpos) nil)
5628 ((pos-visible-in-window-p blinkpos)
5629 ;; Matching open within window, temporarily move to blinkpos but only
5630 ;; if `blink-matching-paren-on-screen' is non-nil.
5631 (and blink-matching-paren-on-screen
5632 (not show-paren-mode)
5633 (save-excursion
5634 (goto-char blinkpos)
5635 (sit-for blink-matching-delay))))
5636 (t
5637 (save-excursion
5638 (goto-char blinkpos)
5639 (let ((open-paren-line-string
5640 ;; Show what precedes the open in its line, if anything.
5641 (cond
5643 (buffer-substring (line-beginning-position)
5644 (1+ blinkpos)))
5645 ;; Show what follows the open in its line, if anything.
5646 ((save-excursion
5647 (forward-char 1)
5649 (not (eolp)))
5650 (buffer-substring blinkpos
5651 (line-end-position)))
5652 ;; Otherwise show the previous nonblank line,
5653 ;; if there is one.
5655 (concat
5656 (buffer-substring (progn
5658 (line-beginning-position))
5659 (progn (end-of-line)
5661 (point)))
5662 ;; Replace the newline and other whitespace with `...'.
5663 "..."
5664 (buffer-substring blinkpos (1+ blinkpos))))
5665 ;; There is nothing to show except the char itself.
5666 (t (buffer-substring blinkpos (1+ blinkpos))))))
5667 (message "Matches %s"
5668 (substring-no-properties open-paren-line-string)))))))))
5670 (defvar blink-paren-function 'blink-matching-open
5671 "Function called, if non-nil, whenever a close parenthesis is inserted.
5672 More precisely, a char with closeparen syntax is self-inserted.")
5674 (defun blink-paren-post-self-insert-function ()
5675 (when (and (eq (char-before) last-command-event) ; Sanity check.
5676 (memq (char-syntax last-command-event) '(?\) ?\$))
5677 blink-paren-function
5678 (not executing-kbd-macro)
5679 (not noninteractive)
5680 ;; Verify an even number of quoting characters precede the close.
5681 (= 1 (logand 1 (- (point)
5682 (save-excursion
5683 (forward-char -1)
5685 (point))))))
5686 (funcall blink-paren-function)))
5688 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5689 ;; Most likely, this hook is nil, so this arg doesn't matter,
5690 ;; but I use it as a reminder that this function usually
5691 ;; likes to be run after others since it does `sit-for'.
5692 'append)
5693 \f
5694 ;; This executes C-g typed while Emacs is waiting for a command.
5695 ;; Quitting out of a program does not go through here;
5696 ;; that happens in the QUIT macro at the C code level.
5697 (defun keyboard-quit ()
5698 "Signal a `quit' condition.
5699 During execution of Lisp code, this character causes a quit directly.
5700 At top-level, as an editor command, this simply beeps."
5701 (interactive)
5702 ;; Avoid adding the region to the window selection.
5703 (setq saved-region-selection nil)
5704 (let (select-active-regions)
5705 (deactivate-mark))
5706 (if (fboundp 'kmacro-keyboard-quit)
5707 (kmacro-keyboard-quit))
5708 (setq defining-kbd-macro nil)
5709 (let ((debug-on-quit nil))
5710 (signal 'quit nil)))
5712 (defvar buffer-quit-function nil
5715 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5717 (defun keyboard-escape-quit ()
5719 This command can exit an interactive command such as `query-replace',
5720 can clear out a prefix argument or a region,
5721 can get out of the minibuffer or other recursive edit,
5722 cancel the use of the current buffer (for special-purpose buffers),
5723 or go back to just one window (by deleting all but the selected window)."
5724 (interactive)
5725 (cond ((eq last-command 'mode-exited) nil)
5726 ((region-active-p)
5727 (deactivate-mark))
5728 ((> (minibuffer-depth) 0)
5729 (abort-recursive-edit))
5730 (current-prefix-arg
5731 nil)
5732 ((> (recursion-depth) 0)
5733 (exit-recursive-edit))
5734 (buffer-quit-function
5735 (funcall buffer-quit-function))
5736 ((not (one-window-p t))
5737 (delete-other-windows))
5739 (bury-buffer))))
5741 (defun play-sound-file (file &optional volume device)
5742 "Play sound stored in FILE.
5743 VOLUME and DEVICE correspond to the keywords of the sound
5744 specification for `play-sound'."
5745 (interactive "fPlay sound file: ")
5746 (let ((sound (list :file file)))
5747 (if volume
5748 (plist-put sound :volume volume))
5749 (if device
5750 (plist-put sound :device device))
5751 (push 'sound sound)
5752 (play-sound sound)))
5754 \f
5755 (defcustom read-mail-command 'rmail
5756 "Your preference for a mail reading package.
5757 This is used by some keybindings which support reading mail.
5758 See also `mail-user-agent' concerning sending mail."
5761 (function-item :tag "Emacs interface to MH"
5763 (function :tag "Other"))
5764 :version "21.1"
5765 :group 'mail)
5767 (defcustom mail-user-agent 'message-user-agent
5768 "Your preference for a mail composition package.
5769 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5770 outgoing email message. This variable lets you specify which
5771 mail-sending package you prefer.
5773 Valid values include:
5775 `message-user-agent' -- use the Message package.
5776 See Info node `(message)'.
5777 `sendmail-user-agent' -- use the Mail package.
5778 See Info node `(emacs)Sending Mail'.
5779 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5780 See Info node `(mh-e)'.
5781 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5782 paraphernalia, particularly the Gcc: header for
5783 archiving.
5785 Additional valid symbols may be available; check with the author of
5786 your package for details. The function should return non-nil if it
5787 succeeds.
5789 See also `read-mail-command' concerning reading mail."
5790 :type '(radio (function-item :tag "Message package"
5792 message-user-agent)
5793 (function-item :tag "Mail package"
5795 sendmail-user-agent)
5796 (function-item :tag "Emacs interface to MH"
5798 mh-e-user-agent)
5799 (function-item :tag "Message with full Gnus features"
5801 gnus-user-agent)
5802 (function :tag "Other"))
5803 :version "23.2" ; sendmail->message
5804 :group 'mail)
5806 (defcustom compose-mail-user-agent-warnings t
5807 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5808 If the value of `mail-user-agent' is the default, and the user
5809 appears to have customizations applying to the old default,
5810 `compose-mail' issues a warning."
5811 :type 'boolean
5812 :version "23.2"
5813 :group 'mail)
5815 (defun rfc822-goto-eoh ()
5816 "If the buffer starts with a mail header, move point to the header's end.
5817 Otherwise, moves to `point-min'.
5818 The end of the header is the start of the next line, if there is one,
5819 else the end of the last line. This function obeys RFC822."
5820 (goto-char (point-min))
5821 (when (re-search-forward
5823 (goto-char (match-beginning 0))))
5825 ;; Used by Rmail (e.g., rmail-forward).
5826 (defvar mail-encode-mml nil
5827 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5828 the outgoing message before sending it.")
5830 (defun compose-mail (&optional to subject other-headers continue
5831 switch-function yank-action send-actions
5832 return-action)
5833 "Start composing a mail message to send.
5834 This uses the user's chosen mail composition package
5835 as selected with the variable `mail-user-agent'.
5836 The optional arguments TO and SUBJECT specify recipients
5837 and the initial Subject field, respectively.
5839 OTHER-HEADERS is an alist specifying additional
5840 header fields. Elements look like (HEADER . VALUE) where both
5841 HEADER and VALUE are strings.
5843 CONTINUE, if non-nil, says to continue editing a message already
5844 being composed. Interactively, CONTINUE is the prefix argument.
5846 SWITCH-FUNCTION, if non-nil, is a function to use to
5847 switch to and display the buffer used for mail composition.
5849 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5850 to insert the raw text of the message being replied to.
5851 It has the form (FUNCTION . ARGS). The user agent will apply
5852 FUNCTION to ARGS, to insert the raw text of the original message.
5853 \(The user agent will also run `mail-citation-hook', *after* the
5854 original text has been inserted in this way.)
5856 SEND-ACTIONS is a list of actions to call when the message is sent.
5857 Each action has the form (FUNCTION . ARGS).
5859 RETURN-ACTION, if non-nil, is an action for returning to the
5860 caller. It has the form (FUNCTION . ARGS). The function is
5861 called after the mail has been sent or put aside, and the mail
5862 buffer buried."
5863 (interactive
5864 (list nil nil nil current-prefix-arg))
5866 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5867 ;; from sendmail-user-agent to message-user-agent. Some users may
5868 ;; encounter incompatibilities. This hack tries to detect problems
5869 ;; and warn about them.
5870 (and compose-mail-user-agent-warnings
5871 (eq mail-user-agent 'message-user-agent)
5872 (let (warn-vars)
5873 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5874 mail-yank-hooks mail-archive-file-name
5875 mail-default-reply-to mail-mailing-lists
5876 mail-self-blind))
5877 (and (boundp var)
5878 (symbol-value var)
5879 (push var warn-vars)))
5880 (when warn-vars
5881 (display-warning 'mail
5882 (format "\
5883 The default mail mode is now Message mode.
5884 You have the following Mail mode variable%s customized:
5886 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5887 (if (> (length warn-vars) 1) "s" "")
5888 (mapconcat 'symbol-name
5889 warn-vars " "))))))
5891 (let ((function (get mail-user-agent 'composefunc)))
5892 (funcall function to subject other-headers continue switch-function
5893 yank-action send-actions return-action)))
5895 (defun compose-mail-other-window (&optional to subject other-headers continue
5896 yank-action send-actions
5897 return-action)
5899 (interactive (list nil nil nil current-prefix-arg))
5900 (compose-mail to subject other-headers continue
5901 'switch-to-buffer-other-window yank-action send-actions
5902 return-action))
5904 (defun compose-mail-other-frame (&optional to subject other-headers continue
5905 yank-action send-actions
5906 return-action)
5908 (interactive (list nil nil nil current-prefix-arg))
5909 (compose-mail to subject other-headers continue
5910 'switch-to-buffer-other-frame yank-action send-actions
5911 return-action))
5913 \f
5914 (defvar set-variable-value-history nil
5915 "History of values entered with `set-variable'.
5917 Maximum length of the history list is determined by the value
5918 of `history-length', which see.")
5920 (defun set-variable (variable value &optional make-local)
5921 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5922 VARIABLE should be a user option variable name, a Lisp variable
5923 meant to be customized by users. You should enter VALUE in Lisp syntax,
5924 so if you want VALUE to be a string, you must surround it with doublequotes.
5925 VALUE is used literally, not evaluated.
5927 If VARIABLE has a `variable-interactive' property, that is used as if
5928 it were the arg to `interactive' (which see) to interactively read VALUE.
5930 If VARIABLE has been defined with `defcustom', then the type information
5931 in the definition is used to check that VALUE is valid.
5933 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5934 (interactive
5935 (let* ((default-var (variable-at-point))
5936 (var (if (user-variable-p default-var)
5937 (read-variable (format "Set variable (default %s): " default-var)
5938 default-var)
5939 (read-variable "Set variable: ")))
5940 (minibuffer-help-form '(describe-variable var))
5941 (prop (get var 'variable-interactive))
5942 (obsolete (car (get var 'byte-obsolete-variable)))
5943 (prompt (format "Set %s %s to value: " var
5944 (cond ((local-variable-p var)
5945 "(buffer-local)")
5946 ((or current-prefix-arg
5947 (local-variable-if-set-p var))
5948 "buffer-locally")
5949 (t "globally"))))
5950 (val (progn
5951 (when obsolete
5952 (message (concat "`%S' is obsolete; "
5953 (if (symbolp obsolete) "use `%S' instead" "%s"))
5954 var obsolete)
5955 (sit-for 3))
5956 (if prop
5957 ;; Use VAR's `variable-interactive' property
5958 ;; as an interactive spec for prompting.
5959 (call-interactively `(lambda (arg)
5960 (interactive ,prop)
5961 arg))
5962 (read
5963 (read-string prompt nil
5964 'set-variable-value-history
5965 (format "%S" (symbol-value var))))))))
5966 (list var val current-prefix-arg)))
5968 (and (custom-variable-p variable)
5969 (not (get variable 'custom-type))
5970 (custom-load-symbol variable))
5971 (let ((type (get variable 'custom-type)))
5972 (when type
5973 ;; Match with custom type.
5974 (require 'cus-edit)
5975 (setq type (widget-convert type))
5976 (unless (widget-apply type :match value)
5977 (error "Value `%S' does not match type %S of %S"
5978 value (car type) variable))))
5980 (if make-local
5981 (make-local-variable variable))
5983 (set variable value)
5985 ;; Force a thorough redisplay for the case that the variable
5986 ;; has an effect on the display, like `tab-width' has.
5987 (force-mode-line-update))
5988 \f
5989 ;; Define the major mode for lists of completions.
5991 (defvar completion-list-mode-map
5992 (let ((map (make-sparse-keymap)))
5993 (define-key map [mouse-2] 'mouse-choose-completion)
5994 (define-key map [follow-link] 'mouse-face)
5995 (define-key map [down-mouse-2] nil)
5996 (define-key map "\C-m" 'choose-completion)
5997 (define-key map "\e\e\e" 'delete-completion-window)
5998 (define-key map [left] 'previous-completion)
5999 (define-key map [right] 'next-completion)
6000 (define-key map "q" 'quit-window)
6001 (define-key map "z" 'kill-this-buffer)
6002 map)
6003 "Local map for completion list buffers.")
6005 ;; Completion mode is suitable only for specially formatted data.
6006 (put 'completion-list-mode 'mode-class 'special)
6008 (defvar completion-reference-buffer nil
6009 "Record the buffer that was current when the completion list was requested.
6010 This is a local variable in the completion list buffer.
6011 Initial value is nil to avoid some compiler warnings.")
6013 (defvar completion-no-auto-exit nil
6014 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6015 This also applies to other functions such as `choose-completion'.")
6017 (defvar completion-base-position nil
6018 "Position of the base of the text corresponding to the shown completions.
6019 This variable is used in the *Completions* buffers.
6020 Its value is a list of the form (START END) where START is the place
6021 where the completion should be inserted and END (if non-nil) is the end
6022 of the text to replace. If END is nil, point is used instead.")
6024 (defvar completion-list-insert-choice-function #'completion--replace
6025 "Function to use to insert the text chosen in *Completions*.
6026 Called with three arguments (BEG END TEXT), it should replace the text
6027 between BEG and END with TEXT. Expected to be set buffer-locally
6028 in the *Completions* buffer.")
6030 (defvar completion-base-size nil
6031 "Number of chars before point not involved in completion.
6032 This is a local variable in the completion list buffer.
6033 It refers to the chars in the minibuffer if completing in the
6034 minibuffer, or in `completion-reference-buffer' otherwise.
6035 Only characters in the field at point are included.
6037 If nil, Emacs determines which part of the tail end of the
6038 buffer's text is involved in completion by comparing the text
6039 directly.")
6040 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6042 (defun delete-completion-window ()
6043 "Delete the completion list window.
6044 Go to the window from which completion was requested."
6045 (interactive)
6046 (let ((buf completion-reference-buffer))
6047 (if (one-window-p t)
6048 (if (window-dedicated-p (selected-window))
6049 (delete-frame (selected-frame)))
6050 (delete-window (selected-window))
6051 (if (get-buffer-window buf)
6052 (select-window (get-buffer-window buf))))))
6054 (defun previous-completion (n)
6055 "Move to the previous item in the completion list."
6056 (interactive "p")
6057 (next-completion (- n)))
6059 (defun next-completion (n)
6060 "Move to the next item in the completion list.
6061 With prefix argument N, move N items (negative N means move backward)."
6062 (interactive "p")
6063 (let ((beg (point-min)) (end (point-max)))
6064 (while (and (> n 0) (not (eobp)))
6065 ;; If in a completion, move to the end of it.
6066 (when (get-text-property (point) 'mouse-face)
6067 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6068 ;; Move to start of next one.
6069 (unless (get-text-property (point) 'mouse-face)
6070 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6071 (setq n (1- n)))
6072 (while (and (< n 0) (not (bobp)))
6073 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6074 ;; If in a completion, move to the start of it.
6075 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6076 (goto-char (previous-single-property-change
6077 (point) 'mouse-face nil beg)))
6078 ;; Move to end of the previous completion.
6079 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6080 (goto-char (previous-single-property-change
6081 (point) 'mouse-face nil beg)))
6082 ;; Move to the start of that one.
6083 (goto-char (previous-single-property-change
6084 (point) 'mouse-face nil beg))
6085 (setq n (1+ n))))))
6087 (defun choose-completion (&optional event)
6088 "Choose the completion at point."
6089 (interactive (list last-nonmenu-event))
6090 ;; In case this is run via the mouse, give temporary modes such as
6091 ;; isearch a chance to turn off.
6092 (run-hooks 'mouse-leave-buffer-hook)
6093 (with-current-buffer (window-buffer (posn-window (event-start event)))
6094 (let ((buffer completion-reference-buffer)
6095 (base-size completion-base-size)
6096 (base-position completion-base-position)
6097 (insert-function completion-list-insert-choice-function)
6098 (choice
6099 (save-excursion
6100 (goto-char (posn-point (event-start event)))
6101 (let (beg end)
6102 (cond
6103 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6104 (setq end (point) beg (1+ (point))))
6105 ((and (not (bobp))
6106 (get-text-property (1- (point)) 'mouse-face))
6107 (setq end (1- (point)) beg (point)))
6108 (t (error "No completion here")))
6109 (setq beg (previous-single-property-change beg 'mouse-face))
6110 (setq end (or (next-single-property-change end 'mouse-face)
6111 (point-max)))
6112 (buffer-substring-no-properties beg end))))
6113 (owindow (selected-window)))
6115 (unless (buffer-live-p buffer)
6116 (error "Destination buffer is dead"))
6117 (select-window (posn-window (event-start event)))
6118 (if (and (one-window-p t 'selected-frame)
6119 (window-dedicated-p (selected-window)))
6120 ;; This is a special buffer's frame
6121 (iconify-frame (selected-frame))
6122 (or (window-dedicated-p (selected-window))
6123 (bury-buffer)))
6124 (select-window
6125 (or (get-buffer-window buffer 0)
6126 owindow))
6128 (with-current-buffer buffer
6129 (choose-completion-string
6130 choice buffer
6131 (or base-position
6132 (when base-size
6133 ;; Someone's using old completion code that doesn't know
6134 ;; about base-position yet.
6135 (list (+ base-size (field-beginning))))
6136 ;; If all else fails, just guess.
6137 (list (choose-completion-guess-base-position choice)))
6138 insert-function)))))
6140 ;; Delete the longest partial match for STRING
6141 ;; that can be found before POINT.
6142 (defun choose-completion-guess-base-position (string)
6143 (save-excursion
6144 (let ((opoint (point))
6145 len)
6146 ;; Try moving back by the length of the string.
6147 (goto-char (max (- (point) (length string))
6148 (minibuffer-prompt-end)))
6149 ;; See how far back we were actually able to move. That is the
6150 ;; upper bound on how much we can match and delete.
6151 (setq len (- opoint (point)))
6152 (if completion-ignore-case
6153 (setq string (downcase string)))
6154 (while (and (> len 0)
6155 (let ((tail (buffer-substring (point) opoint)))
6156 (if completion-ignore-case
6157 (setq tail (downcase tail)))
6158 (not (string= tail (substring string 0 len)))))
6159 (setq len (1- len))
6160 (forward-char 1))
6161 (point))))
6163 (defun choose-completion-delete-max-match (string)
6164 (delete-region (choose-completion-guess-base-position string) (point)))
6165 (make-obsolete 'choose-completion-delete-max-match
6166 'choose-completion-guess-base-position "23.2")
6168 (defvar choose-completion-string-functions nil
6169 "Functions that may override the normal insertion of a completion choice.
6170 These functions are called in order with four arguments:
6171 CHOICE - the string to insert in the buffer,
6172 BUFFER - the buffer in which the choice should be inserted,
6173 MINI-P - non-nil if BUFFER is a minibuffer, and
6174 BASE-SIZE - the number of characters in BUFFER before
6175 the string being completed.
6177 If a function in the list returns non-nil, that function is supposed
6178 to have inserted the CHOICE in the BUFFER, and possibly exited
6179 the minibuffer; no further functions will be called.
6181 If all functions in the list return nil, that means to use
6182 the default method of inserting the completion in BUFFER.")
6184 (defun choose-completion-string (choice &optional
6185 buffer base-position insert-function)
6186 "Switch to BUFFER and insert the completion choice CHOICE.
6187 BASE-POSITION, says where to insert the completion."
6189 ;; If BUFFER is the minibuffer, exit the minibuffer
6190 ;; unless it is reading a file name and CHOICE is a directory,
6191 ;; or completion-no-auto-exit is non-nil.
6193 ;; Some older code may call us passing `base-size' instead of
6194 ;; `base-position'. It's difficult to make any use of `base-size',
6195 ;; so we just ignore it.
6196 (unless (consp base-position)
6197 (message "Obsolete `base-size' passed to choose-completion-string")
6198 (setq base-position nil))
6200 (let* ((buffer (or buffer completion-reference-buffer))
6201 (mini-p (minibufferp buffer)))
6202 ;; If BUFFER is a minibuffer, barf unless it's the currently
6203 ;; active minibuffer.
6204 (if (and mini-p
6205 (not (and (active-minibuffer-window)
6206 (equal buffer
6207 (window-buffer (active-minibuffer-window))))))
6208 (error "Minibuffer is not active for completion")
6209 ;; Set buffer so buffer-local choose-completion-string-functions works.
6210 (set-buffer buffer)
6211 (unless (run-hook-with-args-until-success
6212 'choose-completion-string-functions
6213 ;; The fourth arg used to be `mini-p' but was useless
6214 ;; (since minibufferp can be used on the `buffer' arg)
6215 ;; and indeed unused. The last used to be `base-size', so we
6216 ;; keep it to try and avoid breaking old code.
6217 choice buffer base-position nil)
6218 ;; This remove-text-properties should be unnecessary since `choice'
6219 ;; comes from buffer-substring-no-properties.
6220 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6221 ;; Insert the completion into the buffer where it was requested.
6222 (funcall (or insert-function completion-list-insert-choice-function)
6223 (or (car base-position) (point))
6224 (or (cadr base-position) (point))
6225 choice)
6226 ;; Update point in the window that BUFFER is showing in.
6227 (let ((window (get-buffer-window buffer t)))
6228 (set-window-point window (point)))
6229 ;; If completing for the minibuffer, exit it with this choice.
6230 (and (not completion-no-auto-exit)
6231 (minibufferp buffer)
6232 minibuffer-completion-table
6233 ;; If this is reading a file name, and the file name chosen
6234 ;; is a directory, don't exit the minibuffer.
6235 (let* ((result (buffer-substring (field-beginning) (point)))
6236 (bounds
6237 (completion-boundaries result minibuffer-completion-table
6238 minibuffer-completion-predicate
6239 "")))
6240 (if (eq (car bounds) (length result))
6241 ;; The completion chosen leads to a new set of completions
6242 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6243 (let ((mini (active-minibuffer-window)))
6244 (select-window mini)
6245 (when minibuffer-auto-raise
6246 (raise-frame (window-frame mini))))
6247 (exit-minibuffer))))))))
6249 (define-derived-mode completion-list-mode nil "Completion List"
6250 "Major mode for buffers showing lists of possible completions.
6252 to select the completion near point.
6254 with the mouse.
6257 (set (make-local-variable 'completion-base-size) nil))
6259 (defun completion-list-mode-finish ()
6260 "Finish setup of the completions buffer.
6261 Called from `temp-buffer-show-hook'."
6262 (when (eq major-mode 'completion-list-mode)
6263 (toggle-read-only 1)))
6265 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6268 ;; Variables and faces used in `completion-setup-function'.
6270 (defcustom completion-show-help t
6271 "Non-nil means show help message in *Completions* buffer."
6272 :type 'boolean
6273 :version "22.1"
6274 :group 'completion)
6276 ;; This function goes in completion-setup-hook, so that it is called
6277 ;; after the text of the completion list buffer is written.
6278 (defun completion-setup-function ()
6279 (let* ((mainbuf (current-buffer))
6280 (base-dir
6281 ;; When reading a file name in the minibuffer,
6282 ;; try and find the right default-directory to set in the
6283 ;; completion list buffer.
6284 ;; FIXME: Why do we do that, actually? --Stef
6285 (if minibuffer-completing-file-name
6286 (file-name-as-directory
6287 (expand-file-name
6288 (substring (minibuffer-completion-contents)
6289 0 (or completion-base-size 0)))))))
6290 (with-current-buffer standard-output
6291 (let ((base-size completion-base-size) ;Read before killing localvars.
6292 (base-position completion-base-position)
6293 (insert-fun completion-list-insert-choice-function))
6294 (completion-list-mode)
6295 (set (make-local-variable 'completion-base-size) base-size)
6296 (set (make-local-variable 'completion-base-position) base-position)
6297 (set (make-local-variable 'completion-list-insert-choice-function)
6298 insert-fun))
6299 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6300 (if base-dir (setq default-directory base-dir))
6301 ;; Maybe insert help string.
6302 (when completion-show-help
6303 (goto-char (point-min))
6304 (if (display-mouse-p)
6305 (insert (substitute-command-keys
6307 (insert (substitute-command-keys
6311 (add-hook 'completion-setup-hook 'completion-setup-function)
6313 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6314 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6316 (defun switch-to-completions ()
6317 "Select the completion list window."
6318 (interactive)
6319 (let ((window (or (get-buffer-window "*Completions*" 0)
6320 ;; Make sure we have a completions window.
6321 (progn (minibuffer-completion-help)
6322 (get-buffer-window "*Completions*" 0)))))
6323 (when window
6324 (select-window window)
6325 ;; In the new buffer, go to the first completion.
6326 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6327 (when (bobp)
6328 (next-completion 1)))))
6329 \f
6330 ;;; Support keyboard commands to turn on various modifiers.
6332 ;; These functions -- which are not commands -- each add one modifier
6333 ;; to the following event.
6335 (defun event-apply-alt-modifier (_ignore-prompt)
6338 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6339 (defun event-apply-super-modifier (_ignore-prompt)
6342 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6343 (defun event-apply-hyper-modifier (_ignore-prompt)
6346 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6347 (defun event-apply-shift-modifier (_ignore-prompt)
6350 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6351 (defun event-apply-control-modifier (_ignore-prompt)
6354 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6355 (defun event-apply-meta-modifier (_ignore-prompt)
6358 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6360 (defun event-apply-modifier (event symbol lshiftby prefix)
6361 "Apply a modifier flag to event EVENT.
6362 SYMBOL is the name of this modifier, as a symbol.
6363 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6364 PREFIX is the string that represents this modifier in an event type symbol."
6365 (if (numberp event)
6366 (cond ((eq symbol 'control)
6367 (if (and (<= (downcase event) ?z)
6368 (>= (downcase event) ?a))
6369 (- (downcase event) ?a -1)
6370 (if (and (<= (downcase event) ?Z)
6371 (>= (downcase event) ?A))
6372 (- (downcase event) ?A -1)
6373 (logior (lsh 1 lshiftby) event))))
6374 ((eq symbol 'shift)
6375 (if (and (<= (downcase event) ?z)
6376 (>= (downcase event) ?a))
6377 (upcase event)
6378 (logior (lsh 1 lshiftby) event)))
6379 (t
6380 (logior (lsh 1 lshiftby) event)))
6381 (if (memq symbol (event-modifiers event))
6382 event
6383 (let ((event-type (if (symbolp event) event (car event))))
6384 (setq event-type (intern (concat prefix (symbol-name event-type))))
6385 (if (symbolp event)
6386 event-type
6387 (cons event-type (cdr event)))))))
6389 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6390 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6391 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6392 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6393 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6394 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6395 \f
6396 ;;;; Keypad support.
6398 ;; Make the keypad keys act like ordinary typing keys. If people add
6399 ;; bindings for the function key symbols, then those bindings will
6400 ;; override these, so this shouldn't interfere with any existing
6401 ;; bindings.
6403 ;; Also tell read-char how to handle these keys.
6404 (mapc
6405 (lambda (keypad-normal)
6406 (let ((keypad (nth 0 keypad-normal))
6407 (normal (nth 1 keypad-normal)))
6408 (put keypad 'ascii-character normal)
6409 (define-key function-key-map (vector keypad) (vector normal))))
6410 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6411 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6412 (kp-space ?\s)
6415 (kp-multiply ?*)
6416 (kp-add ?+)
6417 (kp-separator ?,)
6418 (kp-subtract ?-)
6419 (kp-decimal ?.)
6420 (kp-divide ?/)
6421 (kp-equal ?=)
6422 ;; Do the same for various keys that are represented as symbols under
6423 ;; GUIs but naturally correspond to characters.
6424 (backspace 127)
6425 (delete 127)
6428 (clear ?\C-l)
6429 (return ?\C-m)
6430 (escape ?\e)
6431 ))
6432 \f
6433 ;;;;
6434 ;;;; forking a twin copy of a buffer.
6435 ;;;;
6437 (defvar clone-buffer-hook nil
6438 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6440 (defvar clone-indirect-buffer-hook nil
6441 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6443 (defun clone-process (process &optional newname)
6444 "Create a twin copy of PROCESS.
6445 If NEWNAME is nil, it defaults to PROCESS' name;
6446 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6447 If PROCESS is associated with a buffer, the new process will be associated
6448 with the current buffer instead.
6449 Returns nil if PROCESS has already terminated."
6450 (setq newname (or newname (process-name process)))
6452 (setq newname (substring newname 0 (match-beginning 0))))
6453 (when (memq (process-status process) '(run stop open))
6454 (let* ((process-connection-type (process-tty-name process))
6455 (new-process
6456 (if (memq (process-status process) '(open))
6457 (let ((args (process-contact process t)))
6458 (setq args (plist-put args :name newname))
6459 (setq args (plist-put args :buffer
6460 (if (process-buffer process)
6461 (current-buffer))))
6462 (apply 'make-network-process args))
6463 (apply 'start-process newname
6464 (if (process-buffer process) (current-buffer))
6465 (process-command process)))))
6466 (set-process-query-on-exit-flag
6467 new-process (process-query-on-exit-flag process))
6468 (set-process-inherit-coding-system-flag
6469 new-process (process-inherit-coding-system-flag process))
6470 (set-process-filter new-process (process-filter process))
6471 (set-process-sentinel new-process (process-sentinel process))
6472 (set-process-plist new-process (copy-sequence (process-plist process)))
6473 new-process)))
6475 ;; things to maybe add (currently partly covered by `funcall mode'):
6476 ;; - syntax-table
6477 ;; - overlays
6478 (defun clone-buffer (&optional newname display-flag)
6479 "Create and return a twin copy of the current buffer.
6480 Unlike an indirect buffer, the new buffer can be edited
6481 independently of the old one (if it is not read-only).
6482 NEWNAME is the name of the new buffer. It may be modified by
6483 adding or incrementing <N> at the end as necessary to create a
6484 unique buffer name. If nil, it defaults to the name of the
6485 current buffer, with the proper suffix. If DISPLAY-FLAG is
6486 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6487 clone a file-visiting buffer, or a buffer whose major mode symbol
6488 has a non-nil `no-clone' property, results in an error.
6490 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6491 current buffer with appropriate suffix. However, if a prefix
6492 argument is given, then the command prompts for NEWNAME in the
6493 minibuffer.
6495 This runs the normal hook `clone-buffer-hook' in the new buffer
6496 after it has been set up properly in other respects."
6497 (interactive
6498 (progn
6499 (if buffer-file-name
6500 (error "Cannot clone a file-visiting buffer"))
6501 (if (get major-mode 'no-clone)
6502 (error "Cannot clone a buffer in %s mode" mode-name))
6503 (list (if current-prefix-arg
6504 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6505 t)))
6506 (if buffer-file-name
6507 (error "Cannot clone a file-visiting buffer"))
6508 (if (get major-mode 'no-clone)
6509 (error "Cannot clone a buffer in %s mode" mode-name))
6510 (setq newname (or newname (buffer-name)))
6512 (setq newname (substring newname 0 (match-beginning 0))))
6513 (let ((buf (current-buffer))
6514 (ptmin (point-min))
6515 (ptmax (point-max))
6516 (pt (point))
6517 (mk (if mark-active (mark t)))
6518 (modified (buffer-modified-p))
6519 (mode major-mode)
6520 (lvars (buffer-local-variables))
6521 (process (get-buffer-process (current-buffer)))
6522 (new (generate-new-buffer (or newname (buffer-name)))))
6523 (save-restriction
6524 (widen)
6525 (with-current-buffer new
6526 (insert-buffer-substring buf)))
6527 (with-current-buffer new
6528 (narrow-to-region ptmin ptmax)
6529 (goto-char pt)
6530 (if mk (set-mark mk))
6531 (set-buffer-modified-p modified)
6533 ;; Clone the old buffer's process, if any.
6534 (when process (clone-process process))
6536 ;; Now set up the major mode.
6537 (funcall mode)
6539 ;; Set up other local variables.
6540 (mapc (lambda (v)
6541 (condition-case () ;in case var is read-only
6542 (if (symbolp v)
6543 (makunbound v)
6544 (set (make-local-variable (car v)) (cdr v)))
6545 (error nil)))
6546 lvars)
6548 ;; Run any hooks (typically set up by the major mode
6549 ;; for cloning to work properly).
6550 (run-hooks 'clone-buffer-hook))
6551 (if display-flag
6552 ;; Presumably the current buffer is shown in the selected frame, so
6553 ;; we want to display the clone elsewhere.
6554 (let ((same-window-regexps nil)
6555 (same-window-buffer-names))
6556 (pop-to-buffer new)))
6557 new))
6560 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6561 "Create an indirect buffer that is a twin copy of the current buffer.
6563 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6564 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6565 or if not called with a prefix arg, NEWNAME defaults to the current
6566 buffer's name. The name is modified by adding a `<N>' suffix to it
6567 or by incrementing the N in an existing suffix. Trying to clone a
6568 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6569 property results in an error.
6571 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6572 This is always done when called interactively.
6574 Optional third arg NORECORD non-nil means do not put this buffer at the
6575 front of the list of recently selected ones."
6576 (interactive
6577 (progn
6578 (if (get major-mode 'no-clone-indirect)
6579 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6580 (list (if current-prefix-arg
6581 (read-buffer "Name of indirect buffer: " (current-buffer)))
6582 t)))
6583 (if (get major-mode 'no-clone-indirect)
6584 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6585 (setq newname (or newname (buffer-name)))
6587 (setq newname (substring newname 0 (match-beginning 0))))
6588 (let* ((name (generate-new-buffer-name newname))
6589 (buffer (make-indirect-buffer (current-buffer) name t)))
6590 (with-current-buffer buffer
6591 (run-hooks 'clone-indirect-buffer-hook))
6592 (when display-flag
6593 (pop-to-buffer buffer norecord))
6594 buffer))
6597 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6598 "Like `clone-indirect-buffer' but display in another window."
6599 (interactive
6600 (progn
6601 (if (get major-mode 'no-clone-indirect)
6602 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6603 (list (if current-prefix-arg
6604 (read-buffer "Name of indirect buffer: " (current-buffer)))
6605 t)))
6606 (let ((pop-up-windows t))
6607 (clone-indirect-buffer newname display-flag norecord)))
6609 \f
6610 ;;; Handling of Backspace and Delete keys.
6612 (defcustom normal-erase-is-backspace 'maybe
6613 "Set the default behavior of the Delete and Backspace keys.
6615 If set to t, Delete key deletes forward and Backspace key deletes
6616 backward.
6618 If set to nil, both Delete and Backspace keys delete backward.
6620 If set to 'maybe (which is the default), Emacs automatically
6621 selects a behavior. On window systems, the behavior depends on
6622 the keyboard used. If the keyboard has both a Backspace key and
6623 a Delete key, and both are mapped to their usual meanings, the
6624 option's default value is set to t, so that Backspace can be used
6625 to delete backward, and Delete can be used to delete forward.
6627 If not running under a window system, customizing this option
6628 accomplishes a similar effect by mapping C-h, which is usually
6629 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6630 via `keyboard-translate'. The former functionality of C-h is
6631 available on the F1 key. You should probably not use this
6632 setting if you don't have both Backspace, Delete and F1 keys.
6634 Setting this variable with setq doesn't take effect. Programmatically,
6635 call `normal-erase-is-backspace-mode' (which see) instead."
6636 :type '(choice (const :tag "Off" nil)
6637 (const :tag "Maybe" maybe)
6638 (other :tag "On" t))
6639 :group 'editing-basics
6640 :version "21.1"
6641 :set (lambda (symbol value)
6642 ;; The fboundp is because of a problem with :set when
6643 ;; dumping Emacs. It doesn't really matter.
6644 (if (fboundp 'normal-erase-is-backspace-mode)
6645 (normal-erase-is-backspace-mode (or value 0))
6646 (set-default symbol value))))
6648 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6649 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6650 (unless frame (setq frame (selected-frame)))
6651 (with-selected-frame frame
6652 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6653 (normal-erase-is-backspace-mode
6654 (if (if (eq normal-erase-is-backspace 'maybe)
6655 (and (not noninteractive)
6656 (or (memq system-type '(ms-dos windows-nt))
6657 (memq window-system '(ns))
6658 (and (memq window-system '(x))
6659 (fboundp 'x-backspace-delete-keys-p)
6660 (x-backspace-delete-keys-p))
6661 ;; If the terminal Emacs is running on has erase char
6662 ;; set to ^H, use the Backspace key for deleting
6663 ;; backward, and the Delete key for deleting forward.
6664 (and (null window-system)
6665 (eq tty-erase-char ?\^H))))
6666 normal-erase-is-backspace)
6667 1 0)))))
6669 (define-minor-mode normal-erase-is-backspace-mode
6670 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6671 With a prefix argument ARG, enable this feature if ARG is
6672 positive, and disable it otherwise. If called from Lisp, enable
6673 the mode if ARG is omitted or nil.
6675 On window systems, when this mode is on, Delete is mapped to C-d
6676 and Backspace is mapped to DEL; when this mode is off, both
6677 Delete and Backspace are mapped to DEL. (The remapping goes via
6678 `local-function-key-map', so binding Delete or Backspace in the
6679 global or local keymap will override that.)
6681 In addition, on window systems, the bindings of C-Delete, M-Delete,
6682 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6683 the global keymap in accordance with the functionality of Delete and
6684 Backspace. For example, if Delete is remapped to C-d, which deletes
6685 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6686 to DEL, which deletes backward, C-Delete is bound to
6687 `backward-kill-word'.
6689 If not running on a window system, a similar effect is accomplished by
6690 remapping C-h (normally produced by the Backspace key) and DEL via
6691 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6692 to C-d; if it's off, the keys are not remapped.
6694 When not running on a window system, and this mode is turned on, the
6695 former functionality of C-h is available on the F1 key. You should
6696 probably not turn on this mode on a text-only terminal if you don't
6697 have both Backspace, Delete and F1 keys.
6699 See also `normal-erase-is-backspace'."
6700 :variable (eq (terminal-parameter
6701 nil 'normal-erase-is-backspace) 1)
6702 (let ((enabled (eq 1 (terminal-parameter
6703 nil 'normal-erase-is-backspace))))
6705 (cond ((or (memq window-system '(x w32 ns pc))
6706 (memq system-type '(ms-dos windows-nt)))
6707 (let ((bindings
6708 `(([M-delete] [M-backspace])
6709 ([C-M-delete] [C-M-backspace])
6710 ([?\e C-delete] [?\e C-backspace]))))
6712 (if enabled
6713 (progn
6714 (define-key local-function-key-map [delete] [deletechar])
6715 (define-key local-function-key-map [kp-delete] [?\C-d])
6716 (define-key local-function-key-map [backspace] [?\C-?])
6717 (dolist (b bindings)
6718 ;; Not sure if input-decode-map is really right, but
6719 ;; keyboard-translate-table (used below) only works
6720 ;; for integer events, and key-translation-table is
6721 ;; global (like the global-map, used earlier).
6722 (define-key input-decode-map (car b) nil)
6723 (define-key input-decode-map (cadr b) nil)))
6724 (define-key local-function-key-map [delete] [?\C-?])
6725 (define-key local-function-key-map [kp-delete] [?\C-?])
6726 (define-key local-function-key-map [backspace] [?\C-?])
6727 (dolist (b bindings)
6728 (define-key input-decode-map (car b) (cadr b))
6729 (define-key input-decode-map (cadr b) (car b))))))
6730 (t
6731 (if enabled
6732 (progn
6733 (keyboard-translate ?\C-h ?\C-?)
6734 (keyboard-translate ?\C-? ?\C-d))
6735 (keyboard-translate ?\C-h ?\C-h)
6736 (keyboard-translate ?\C-? ?\C-?))))
6738 (if (called-interactively-p 'interactive)
6739 (message "Delete key deletes %s"
6740 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6741 "forward" "backward")))))
6742 \f
6743 (defvar vis-mode-saved-buffer-invisibility-spec nil
6744 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6746 (define-minor-mode visible-mode
6747 "Toggle making all invisible text temporarily visible (Visible mode).
6748 With a prefix argument ARG, enable Visible mode if ARG is
6749 positive, and disable it otherwise. If called from Lisp, enable
6750 the mode if ARG is omitted or nil.
6752 This mode works by saving the value of `buffer-invisibility-spec'
6753 and setting it to nil."
6754 :lighter " Vis"
6755 :group 'editing-basics
6756 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6757 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6758 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6759 (when visible-mode
6760 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6761 buffer-invisibility-spec)
6762 (setq buffer-invisibility-spec nil)))
6763 \f
6764 ;; Minibuffer prompt stuff.
6766 ;;(defun minibuffer-prompt-modification (start end)
6767 ;; (error "You cannot modify the prompt"))
6768 ;;
6769 ;;
6770 ;;(defun minibuffer-prompt-insertion (start end)
6771 ;; (let ((inhibit-modification-hooks t))
6772 ;; (delete-region start end)
6773 ;; ;; Discard undo information for the text insertion itself
6774 ;; ;; and for the text deletion.above.
6775 ;; (when (consp buffer-undo-list)
6776 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6777 ;; (message "You cannot modify the prompt")))
6778 ;;
6779 ;;
6780 ;;(setq minibuffer-prompt-properties
6781 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6782 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6784 \f
6785 ;;;; Problematic external packages.
6787 ;; rms says this should be done by specifying symbols that define
6788 ;; versions together with bad values. This is therefore not as
6789 ;; flexible as it could be. See the thread:
6790 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6791 (defconst bad-packages-alist
6792 ;; Not sure exactly which semantic versions have problems.
6793 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6795 "The version of `semantic' loaded does not work in Emacs 22.
6796 It can cause constant high CPU load.
6797 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6798 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6799 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6800 ;; provided the `CUA-mode' feature. Since this is no longer true,
6801 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6802 (CUA-mode t nil
6803 "CUA-mode is now part of the standard GNU Emacs distribution,
6804 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6806 You have loaded an older version of CUA-mode which does not work
6807 correctly with this version of Emacs. You should remove the old
6808 version and use the one distributed with Emacs."))
6809 "Alist of packages known to cause problems in this version of Emacs.
6810 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6811 PACKAGE is either a regular expression to match file names, or a
6812 symbol (a feature name); see the documentation of
6813 `after-load-alist', to which this variable adds functions.
6814 SYMBOL is either the name of a string variable, or `t'. Upon
6815 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6816 warning using STRING as the message.")
6818 (defun bad-package-check (package)
6819 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6820 (condition-case nil
6821 (let* ((list (assoc package bad-packages-alist))
6822 (symbol (nth 1 list)))
6823 (and list
6824 (boundp symbol)
6825 (or (eq symbol t)
6826 (and (stringp (setq symbol (eval symbol)))
6827 (string-match-p (nth 2 list) symbol)))
6828 (display-warning package (nth 3 list) :warning)))
6829 (error nil)))
6831 (mapc (lambda (elem)
6832 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6833 bad-packages-alist)
6836 (provide 'simple)
6838 ;;; simple.el ends here